언리얼 엔진 메모리 관리

c++ 언어 메모리 관리의 문제점

• C++ 은 저수준으로 메모리 주소에 직접 접근하는 포인터를 사용해 오브젝트를 관리한다
• 그러다보니 프로그래머가 직접 할당 (new) 와 해지 (delete) 짝 맞추기를 해야 한다
• 이를 잘 지키지 못하는 경우 다양한 문제가 발생할 수 있다.
• 잘못된 포인터 사용 예시
  • 메모리 누수(Leak) : new 를 했는데 delete 짝을 맞추지 못한경우, HEAP 에 메모리가 그대로 남아있다.
  • 허상 (Dangling) 포인터 : (다른곳에서) 이미 해제해 무효화된 오브젝트의 주소를 가리키는 포인터
  • 와일드 (Wild) 포인터 : 값이 초기화되지 않아 엉뚱한 주소를 가리키는 포인터
• 잘못된 포인터 값은 다양한 문제를 일으키며, 한번의 실수는 프로그램을 종료 시킨다.
• 게임 규모가 커지고 구조가 복잡해질수록 프로그래머가 실수할 확률은 크게 증가한다.

C++ 이후에 나온 언어 JAVA / C# 은 이런 고질적인 문제를 해결하기 위해 포인터를 버리고
가비지 컬렉션 시스템을 도입했다.

가비지 컬렉션 시스템

언리얼 엔진의 가비지 컬렉션 시스템

언리얼 오브젝트가 대상이다. 일반 c++ 를 논하는 시스템이 아니다. 언리얼 오브젝트의 메모리를 관리하고, 일반 C++ 안에 선언된 언리얼 오브젝트의 관리를 하는 방법이다.

가지비 컬렉션을 위한 객체 저장소

• 관리되는 모든 언리얼 오브젝트의 정보를 저장하는 전역 변수 : GUObjectArray
  언리얼 엔진이 활성화 된 순간에 누구나 GUObjectArray 에 접근할 수 있다.
• GUObjectArray 의 각 요소에는 플레그(Flag) 가 설정되어 있다.
• 가비지 컬렉터가 참고하는 주요 플래그
  • Garbage 플래그 : 다른 언리얼 오브젝트로부터의 참조가 없어 회수 예정인 오브젝트
  • RootSet 플래그 : 다른 언리얼 오브젝트로부터 참조가 없어도 회수하지 않는 특별한 오브젝트.

가비지 컬렉터는 GUObjectArray 에 있는 플래그를 확인해 빠르게 회수해야할 오브젝트를 파악하고 메모리에서 제거한다

가비지 컬렉터를 사용해서 얻는 장점

언리얼 오브젝트를 통한 포인터 문제의 해결

• 메모리 누수 문제
  • 언리얼 오브젝트는 가비지 컬렉터를 통해 자동으로 해결
  • C++ 오브젝트는 직접 신경 써야 한다. (스마트 포인터 라이브러리의 활용)
• 댕글링 포인터 (이미 해지된 참조) 문제
  • 언리얼 오브젝트는 이를 탐지하기 위해 함수를 제공한다 ::IsValid()
  • C++ 오브젝트는 직접 신경 써야 한다. (스마트 포인터 라이브러리의 활용)
• 와일드 포인터 (잘못된 참조) 문제
  • 언리얼 오브젝트에 UPROPERTY 속성을 지정하면 자동으로 nullptr 로 초기화를 해준다.
  • C++ 오브젝트는 직접 nullptr 로 초기화 해야 한다. (스마트 포인터 라이브러리의 활용)

언리얼 오브젝트의 유효성을 판단하는 방법

UObject* UObject 의 유효성을 판단하는 방법

nullptr 만 보고 유효하다고 판단해서는 안된다

1. nullptr != UObject
   • 널포인터 인지 확인하기, 하지만 Dangling 문제까지 잡아 낼 순 없다.
2. UObject->IsValid()
   • GC 에 의한 Pending Kill 상태까지 잡아낼 수 있다고 한다
3. UObject->IsValidLowLevel()
   • 좀더 깊숙하게 검사하여 유효성을 판단하는 함수

가비지 컬렉터의 메모리 회수

• 가비지 컬렉터는 지정된 시간에 다라 주기적으로 메모리를 회수한다. (기본값 : 60초). 너무 길다면 ProjectSetting 에서 변경할 수 있다.
• Garbage 플래그로 설정된 오브젝트를 파악하고 메모리를 안전하게 회수한다.
• Garbage 플래그는 수동으로 설정하는 것이 아닌, 시스템이 알아서 설정한다.

한번 생성된 언리얼 오브젝트는 바로 삭제가 불가능하다

삭제하려고 delete 를 호출해서 삭제 시키려고 하면 안된다. 가비지 컬렉터를 기다려야 한다. ( 참조를 끊어 내는 방식을 활용해야 한다. )

가비지 컬렉터의 메모리 회수에서 제외하는법

가비지 컬렉터는 UPROPERTY 를 붙이지 않아 참조되지 않거나, 루트셋으로 지정되지 않거나, AddReferencedObjects 함수로 호출로 참조를 설정하지 않은 모든 언리얼 오브젝트를 회수합니다. 가비지 컬렉터가 참고하는 참조 등록의 기준 은 가비지 컬렉터에게 알렸는가 이다. (가비지 컬렉터가 참고하는 주요 플래그를 통해서 , Garbage 플래그, RootSet 플래그) 내가 포인터로서 참조하고 있는가는 상관하지 않는다. 그래서, UPROPERTY() 붙여주거나, AddReferencedObjects 함수호출해주거나, 루트셋을 지정하는등으로 가비지 컬렉터에게 알리는것이 중요하다

오브젝트 선언의 기본 원칙

오브젝트 포인터는 가급적 UPROPERTY 로 선언하고 메모리는 가비지 컬렉터가 자동으로 관리하도록 위임한다.

• 언리얼 엔진 방식으로 참조를 설정한 언리얼 오브젝트는 회수를 당하지 않는다.
  • UPROPERTY 로 참조된 언리얼 오브젝트 는 회수 당하지 않는다 (대부분의 케이스)
    • 반대로, 언리얼 오브젝트인데 UPROPERTY 를 붙이지 않은 참조의 경우, Dangling 문제가 발생 한다.
      해당 변수는 nullptr 은 아니지만 UObject* UnrelOjbect ->IsValidLowLevel() 함수로 좀더 깊게 유효성 여부를 판단한다면, 유효하지 않다고 나온다.
      결국 실제는 nullptr 은 아니지만. 유효하지 않은 언리얼 오브젝트가 된다.
    • 그러니 꼭 언리얼 오브젝트를 참조하는 변수는 UPROPERTY 를 붙여주자
  • UPROPERTY 를 사용할 수 없는 상황이라면, AddReferencedObjects 함수를 통해 참조를 설정한 언리얼 오브젝트
• 루트셋 으로 지정된 언리얼 오브젝트

루트셋(RootSet) 플래그의 설정

굉장히 중요해서 시스템이 시작해서 계속해서 살아있어야 하는 경우. 이러한 경우 Root Set 으로 설정해야 한다.

• AddToRoot 함수를 호출해 루트셋 플래그를 설정하면 최초 탐색 목록으로 설정된다.
• 루트셋으로 설정된 언리얼 오브젝트는 메모리 회수로부터 보호받는다.
• RemoveFromRoot 함수를 호출해 루트셋 플래그를 제거할 수 있다.

콘텐츠 관련 오브젝트에 루트셋을 설정하는 방법은 권장되지 않는다.

일반 클래스에서 언리얼 오브젝트를 관리하는 경우

• UPROPERTY 를 사용하지 못하는 일반 C++ 클래스가 언리얼 오브젝트를 관리해야 하는 경우
• FGCObject 클래스를 상속받은 후 AddReferencedObjects 함수를 구현한다
• 함수 구현부에서 관리할 언리얼 오브젝트를 추가해 준다

                    
                        #pragma onece
                        #include "CoreMinimal.h"

                        /** 언리얼 오브젝트를 관리하는  비언리얼 클래스 */
                        class UNREALPROJECT_API FMyClass : public FGCObject
                        {
                        public:
                            FMyClass();

                            ~FMyClass();

                            TObjectPtr<UObject> UObject; // 언리얼 오브젝트
                        public:

                            // 언리얼 오브젝트 관리를 위해 구현해주어야할 함수 1
                            virtual void AddReferencedObjects(FReferenceCollector& Collector) override;

                            // 언리얼 오브젝트 관리를 위해 구현해주어야할 함수 2
                            virtual FString GetReferencerName() const override
                            {
                                return TEXT("FMyClass"); // 그냥 식별할수 있는 클래스이름을 적어주면된다.
                            }
                        }
                    
                

.cpp

                    
                        #include "MyClass.h"
                        
                        FMyClass::FMyClass()
                        {
                            UObject = NewObject<UObject>();
                        }

                        void FMyClass::AddReferencedObjects(FReferenceCollector& Collector)
                        {
                            if(UObject->IsValidLowLevel())
                            {
                                Collector.AddReferenceObject(UObject);
                            }
                        }
                    
                

언리얼 오브젝트의 관리 원칙

• 생성된 언리얼 오브젝트를 유지하기 위해 레퍼런스 참조 방법을 설계할 것
  • 언리얼 오브젝트 내의 언리얼 오브젝트 : UPROPERTY 사용
  • 일반 C++ 오브젝트 내의 언리얼 오브젝트 : FGCObject 상속 후 구현
• 생성된 언리얼 오브젝트는 강제로 지우려 하지 말 것
  • 참조를 끊는다는 생각으로 설계할 것
  • 가비지 컬렉터에게 회수를 재촉할 수 있다. (ForceGarbageCollection 함수)
  • 콘텐츠 제작에서 AActor 클래스 Destroy 함수를 사용할 수 있으나, 이것은 플래그를 설정해주고 나중에 가비지 컬렉터가 회수하는 과정을 거치며. 결국 내부동작은 동일하다. (가비지 컬렉터에 위임)