UE4

[UE4] 스마트 포인터 (Smart Pointer)

Honey Badger 2023. 2. 24. 17:24

  

   언리얼 스마트 포인터 라이브러리는 메모리 할당과 추적의 부담을 해소해주도록 설계된 C++11 스마트 포인터들의 커스텀 구현입니다. 이 구현에는 업계 표준인 Shared Pointers(공유포인터), Weak Pointers(약 포인터), Unique Pointers(유니크 포인터)가 포함되어 있습니다. 또한 null이 불가능한 Non-Nullable Shared Pointer와 같은 역할을 하는 Shared References 도 추가되었습니다. 단, 언리얼 오브젝트는 게임 코드에 더 최적화된 별도의 메모리 추적 시스템을 사용하기 때문에 이러한 클래스들은 "UObject"시스템에는 사용할 수 없습니다. 

 

 

SmartPointer Type

 

  스마트 포인터들은 갖고 있거나 참조하는 오브젝트의 생명 주기에 영향을 줄 수 있으며, 각각의 스마트 포인터마다 오브젝트에 주는 제한사항과 효과도 달라집니다. 각 스마트 포인터 타입을 사용하기 적합한 경우를 알아보도록 하겠습니다.

 

1. Shared Pointers (TSharedPtr)

   쉐어드 포인터는 참조하는 오브젝트를 소유하며, 무기한으로 오브젝트의 소멸을 방지하고, 참조하는 쉐어드 포인터또는 쉐어드 레퍼런스가 없을 경우에는 궁극적으로 오브젝트를 소멸시킵니다. 쉐어드 포인터는 어느 오브젝트도 참조하지 않는 빈 상태일 수 있습니다. 다만 모든 null이 불가능한 쉐어드 포인터는 참조하는 오브젝트에 쉐어드 레퍼런스를 생성할 수 있습니다. 

 

 

 

2. Shared Regerences (TSharedRef)

   쉐어드 레퍼런스는 참조하는 오브젝트를 소유한다는 측면에서 쉐어드 포인터와 같은 역할을 합니다. 단, Null 오브젝트와 관련해서는 차이점이 있습니다. 쉐어드 레퍼런스는 항상 null이 불가능한 오브젝트를 참조해야 합니다. 반면에 쉐어드 포인터들은 그런 제약이 없기 때문에 쉐어드 레퍼런스는 언제나 쉐어드 포인터로 변환될 수 있으며, 변환된 쉐어드 포인터는 유효한 오브젝트를 참조한다는 점이 보장됩니다. 참조한 오브젝트가 null이 불가능한 오브젝트라는 것을 보장하길 원하거나 공유된 오브젝트의 소유권을 보여주길 원할 때에는 쉐어드 레퍼런스를 사용하세요. 

 

 

 

3. Weak Pointers (TWeakPtr)

   약 포인터는 쉐어드 포인터와 비슷하지만 참조하는 오브젝트를 소유하지 않기 때문에 생명 주기에 영향을 주지 않습니다. 이러한 속성은 참조 주기에 영향을 주지 않기 때문에 매우 유용할 수 있지만, 다시 말해 위크 포인터는 언제든지 사전 경고없이 null이 될 수 있다는 뜻이기도 합니다. 따라서, 위크 포인터는 참조하는 오브젝트에 쉐어드 포인터를 생성할 수 있고, 프로그래머들에게 일시적으로 오브젝트에 대한 안전한 접근을 보장합니다. 

 

 

 

 

4. Unique Pointers (TUniquePtr) 

   유니크 포인터는 참조하는 오브젝트를 유일하고 명시적으로 소유합니다. 특정 자원에 대해서는 하나의 유니크 포인터만 있을 수 있기 때문에, 유니크 포인터는 소유권을 이전할 수 있지만 공유는 할 수 없습니다. 유니크 포인터를 복사하려 하면 컴파일 오류가 발생합니다. 또한, 유니크 포인터가 스코프를 벗어나게 되면, 참조하는 오브젝트가 자동 소멸됩니다. 

 

WARNING!!

  유니크 포인터가 참조하는 오브젝트에 쉐어드 포인터나 쉐어드 레퍼런스를 생성하면 위험합니다. 다른 스마트 포인터들이 오브젝트를 여전히 참조하고 있음에도 불구하고, 유니크 포인터가 소멸되면 해당 오브젝트도 함께 소멸시키는 것을 막을 수 없습니다. 마찬가지로, 쉐어드 포인터 또는 쉐어드 레퍼런스가 가리키는 오브젝트에 유니크 포인터를 생성하지 않는 것을 권장합니다. 

 

 

 

 

스마트 포인터의 장점

 

 

1. 메모리 누수 방지 : 스마트 포인터들은 약 포인터를 제외하고 더 이상 공유된 레퍼런스가 없으면 오브젝트가 자동 소멸됩니다. 

 

2. 위크 레퍼런싱 : 위크 포인터는 참조 주기에 영향을 주지 않고, 삭제된 오브젝트를 참조하는 Dangling Pointer를 방지합니다. 

 

3. 선택적인 스레드 안전 : 언리얼 스마트 포인터 라이브러리에는 멀티스레드에 걸쳐 참조 카운팅을 관리하는 코드인 스레드 세이프 코드가 포함되어 있습니다. 스레드 안정성이 필요하지 않다면 그 대신에 향상된 퍼포먼스를 구현할 수 있습니다. 

 

4. 런타임 안정성 : 쉐어드 레퍼런스는 절대 null일 수 없으며 언제든지 참조 해제될 수 있습니다. 

 

5. 명확한 의도 : 관찰자 중에서 오브젝트의 소유자를 쉽게 분별할 수 있습니다. 

 

6. 메모리 : 64비트의 컴퓨터를 기준으로 스마트 포인터의 크기는 C++포인터 크기의 두배밖에 되지 않습니다. (공유된 16바이트 레퍼런스 컨트롤러도 포함). 단, 예외로 유니크 포인터만 C++ 포인터의 크기와 같습니다. 

 

 

 

 

헬퍼 클래스와 함수

 

  언리얼 스마트 포인터 라이브러리는 스마트 포인터를 보다 쉽고 직관적으로 사용할 수 있도록 다양한 헬퍼 클래스와 함수를 제공합니다. 

 

헬퍼 클래스

- TSharedFromThis : TSharedFromThis 에서 클래스를 파생시키면 AsShared 나 SharedThis 함수가 추가됩니다. 이러한 함수들을 통해 오브젝트에 대한 TSharedRef를 구할 수 있습니다. 

 

헬퍼 함수

- MakeShared, MakeShareable : 일반 C++포인터로 쉐어드 포인터를 생성합니다. MakeShared는 새 오브젝트 인스턴스와 레퍼런스 컨트롤러를 한 메모리 블록에 할당하지만, 오브젝트가 public 생성자를 제공해야만 합니다. MakeShareable은 덜 효율적이지만 오브젝트의 생성자가 private 이더라도 접근 가능하여 직접 생성하지 않은 오브젝트에 대한 소유권을 가질 수 있고, 오브젝트를 소멸시킬 경우에는 커스텀 비헤이비어가 지원됩니다. 

 

- StaticCastSharedRef, StaticCastSharedPtr : Static 형변환 유틸리티 함수로, 주로 파생된 타입으로 내림변환(DownCast)하는데에 사용됩니다. 

 

- ConstCastSharedRef, ConstCastSharedPtr : Const 스마트 레퍼런스 또는 스마트 포인터를 mutable 스마트 레퍼런스 또는 스마트 포인터로 각각 변환합니다. 

 

 

 

 

스마트 포인터 구현 세부사항

 

  언리얼 스마트 포인터 라이브러리의 모든 스마트 포인터는 기능성 및 효율성 측면에서 일반적인 특징을 공유합니다. 

 

속도

  스마트 포인터를 사용할지 고려할 때는 항상 퍼포먼스에 대해서 먼저 생각해봐야 합니다. 스마트 포인터는 특정 하이 레벨 시스템이나 자원 관리 또는 툴 프로그램에 매우 적합하지만 일부 스마트 포인터 타입은 기존 C++포인터보다 더 느리며, 이런 오버헤드로 인해 렌더링과 같은 로우 레벨 엔진 코드에는 덜 유용합니다. 

 

스마트 포인터의 일반적인 퍼포먼스 이점 :

 

1. 모든 연산이 고정비(Constant-time) 입니다. 

2. 빌드를 출시할 때, 대부분의 스마트 포인터들을 참조 해제하는 속도가 C++ 기본 포인터만큼 빠릅니다.

3. 스마트 포인터들을 복사해도 절대 메모리가 할당되지 않습니다. 

4. 스레드 세이프(Thread-safe) 스마트 포인터는 잠금 없는 (lockless) 구조입니다. 

 

스마트 포인터의 퍼포먼스 문제점 : 

 

1. 스마트 포인터의 생성 및 복사는 C++ 기본 포인터의 생성 및 복사보다 더 많은 오버헤드가 발생합니다. 

2. 참조 카운트를 유지하면 기본 연산에 주기가 추가됩니다. 

3. 일부 스마트 포인터는 C++ 기본 포인터보다 메모리 사용량이 더 높습니다. 

4. 레퍼런스 컨트롤러에는 두 번의 힙 할당량이 있습니다. MakeShareable 대신에 "MakeShared"를 사용하면 두 번째 할당을 피할 수 있으며, 퍼포먼스를 개선할 수 있습니다. 

 

 

 

 

침범형 접근자 (Intrusive Accessors)

 

  쉐어드 포인터는 비침범형(non-intrusive)로, 오브젝트가 스마트 포인터의 소유 하에 있는지 알 수 없다는 뜻입니다. 이런 속성은 일반적으론 문제가 없지만, 오브젝트를 쉐어드 레퍼런스나 쉐어드 포인터로서 접근하려는 경우 문제가 생길 수 있습니다. 이러한 경우에는, 오브젝트의 클래스를 템플릿 매개변수로 사용하여 TSharedFromThis에서 오브젝트의 클래스를 파생시켜야 합니다.

  TSharedFromThis 클래스는 두 가지 함수 AsShared, SharedThis를 제공하며, 두 함수로 오브젝트를 쉐어드 레퍼런스로 변환하고, 쉐어드 레퍼런스를 또 쉐어드 포인터로 변환할 수 있습니다. 이는 항상 쉐어드 레퍼런스를 반환하는 클래스 팩토리나 쉐어드 레퍼런스 또는 쉐어드 포인터를 요구하는 시스템에 오브젝트를 넣을 때 특히나 유용합니다. AsShared함수는 호출되는 오브젝트의 Parent 타입일 수 있는 TSharedFromThis 클래스에 템플릿 아규먼트로서 전달된 본래 타입의 클래스를 반환하는 동시에, ShareThis 함수는 this에서 타입을 직접 파생시키고 해당 타입의 오브젝트를 참조하는 스마트 포인터를 반환합니다. 다음은 두 함수의 사용 방법을 보여주는 예제 코드입니다. 

 

class FRegistryObject;
class FMyBaseClass: public TSharedFromThis<FMyBaseClass>
{
    virtual void RegisterAsBaseClass(FRegistryObject* RegistryObject)
    {
        // 'this'의 쉐어드 레퍼런스에 접근합니다.
        // <TSharedFromThis>로부터 직접 상속되어 AsShared()와 SharedThis(this)는 동일한 타입을 반환합니다.
        TSharedRef<FMyBaseClass> ThisAsSharedRef = AsShared();
        // RegistryObject는 TSharedRef<FMyBaseClass> 또는 TSharedPtr<FMyBaseClass>를 요구합니다. TsharedRef는 묵시적으로 TsharedPtr로 변환될 수 있습니다.
        RegistryObject->Register(ThisAsSharedRef);
    }
};
class FMyDerivedClass : public FMyBaseClass
{
    virtual void Register(FRegistryObject* RegistryObject) override
    {
        // TSharedFromThis<>로부터 직접 상속되지 않아서 AsShared()와 SharedThis(this)는 각기 다른 타입을 반환합니다.
        // AsShared()는 해당 예제 내 TSharedFromThis<> - TSharedRef<FMyBaseClass>에서 정의된 본래 타입을 반환하게 됩니다.
        // SharedThis(this)는 해당 예제 내 'this' - TSharedRef<FMyDerivedClass>의 타입과 함께 TsharedRef를 반환하게 됩니다.
        // SharedThis() 함수는 ‘this' 포인터와 동일한 범위 내에서만 가능합니다.
        TSharedRef<FMyDerivedClass> AsSharedRef = SharedThis(this);
        // FmyDerivedClass는 FmyBaseClass 타입의 일종이기 때문에 RegistryObject가 TSharedRef<FMyDerivedClass>를 허용합니다.
        RegistryObject->Register(ThisAsSharedRef);
    }
};
class FRegistryObject
{
    // 이 함수는 FmyBaseClass나 그 자녀 클래스에 TsharedRef나 TsharedPtr를 허용합니다.
    void Register(TSharedRef<FMyBaseClass>);
};

AsShared나 SharedThis를 생성자로 호출하지 마세요. 쉐어드 레퍼런스가 선언되지 않은 상태이기 때문에 충돌이나 어서트가 발생하게 됩니다. 

 

 

 

형변환

 

  쉐어드 포인터, 쉐어드 레퍼런스는 언리얼 스마트 포인터 라이브러리에 포함되어 있는 여러 가지 지원 함수를 통해 형변환할 수 있습니다. 올림변환(Up-Casting)은 C++ 포인터와 마찬가지로 묵시적입니다. ConstCastSharePtr 함수로 const cast 연산자를 사용할 수 있으며, StaticCastSharedPtr로 Static cast(주로 파생된 클래스 포인터로 내림변환(Down Cast)하기 위해) 연산자를 사용할 수 있습니다. 런타임 타입 정보(RTTI, run-type type information)가 없기 때문에 동적 형변환은 지원되지 않습니다. 그 대신에 다음 코드와 같이 정적 형변환을 사용할 것을 권장합니다.

 

// FdragDropOperation가 FAssetDragDropOp이라는 점을 다른 수단을 통해 유효성이 확인되었다고 가정하고 있습니다.
TSharedPtr<FDragDropOperation> Operation = DragDropEvent.GetOperation();
// 이제 StaticCastSharedPtr로 형변환할 수 있습니다.
TSharedPtr<FAssetDragDropOp> DragDropOp = StaticCastSharedPtr<FAssetDragDropOp>(Operation);

 

 

 

스레드 안정성

 

  기본적으로 스마트 포인터는 싱글 스레드가 접근하는 것이 안전합니다. 멀티 스레드가 접근해야 한다면 스마트 포인터 클래스의 스레드 세이프 버전을 사용하세요.

  • TSharedPtr<T, ESPMode::ThreadSafe>
  • TSharedRef<T, ESPMode::ThreadSafe>
  • TWeakPtr<T, ESPMode::ThreadSafe>
  • TSharedFromThis<T, ESPMode::ThreadSafe>

이러한 스레드 버전은 원자적(Atomic) 참조 카운팅으로 인해 디폴트보다 다소 느리지만 그 비헤이비어는 일반 C++ 포인터와 같습니다:

 

- 읽기와 복사본은 항상 스레드 세이프입니다.

- 안정성을 위해 쓰기와 초기화는 반드시 동기화되어야 합니다. 

# 하나 이상의 스레드가 포인터에 접근하지 않는다는 것이 확실하다면, 스레드 세이프 버전을 사용하지 않음으로써 퍼포먼스를 향상시킬 수 있습니다.  

 

 

 

 

팁 및 제한사항

 

- 가급적이면 함수에 데이터를 TSharedRef나 TSharedPtr매개변수로 넣지 않는 것을 권장합니다. 이러한 데이터의 해제와 참조 카운팅으로 인해 오버헤드가 발생하게 됩니다. 그 대안으로, 레퍼런스된 오브젝트를 "Const &"로 넣으세요. 

 

- 쉐어드 포인터를 불완전한 타입/형식으로 미리 선언할 수 있습니다. 

 

- 쉐어드 포인터는 언리얼 오브젝트( UObject와 이에서 파생된 클래스)와 호환되지 않습니다. 언리얼 엔진은 "UObject" 관리를 위한 별도의 메모리 관리 시스템이 있으며 두 시스템은 완전히 다른 시스템입니다. 

'UE4' 카테고리의 다른 글

[UE4] 아키타입(Archetype)  (0) 2023.03.02
[UE4] 인터페이스 (Interface)  (0) 2023.02.25
[UE4] 언리얼 ui 최적화 기법  (4) 2023.02.21
[UE4] Projectile Movement Component  (0) 2023.02.14
[UE4] 게임플레이 프레임워크  (0) 2023.01.18