使用FWeakObjectPtr安全判断UObject失效 | Blurred code

使用FWeakObjectPtr安全判断UObject失效

2024/06/29

LastMod:2024/07/06

Categories: UE

Engine Version: 5.3.2

最近碰到一个比较奇葩的问题,就是渲染线程里绑定材质Material Uniform的地方居然保存了UTexture*的裸指针。

具体可以见 Engine\Source\Runtime\Engine\Private\Materials\MaterialInstanceSupport.h

安全判断UObject失效-2024-06-29-13-06-05

然后在切换地图的时候,有可能因为切地图UE强杀Actor的原因导致Actor动态创建的UTexture*被回收,这里保存的指针就成了悬空指针。(具体的成因我还没想清楚,因为理论上来说Material那里也记录了Texture的引用,不过现象就是在切地图的时候有几率碰见崩溃)。

具体崩溃的堆栈在于void FUniformExpressionSet::FillUniformBuffer

仔细阅读这段代码,似乎Epic也发现这里可能会产生悬空指针,只是他们也没弄明白这块到底是怎么产生的...我翻了一下UDN,也有人碰见过类似的问题,不过他那个原因是因为他绑定的UTexture忘记了加UProperty,导致被GC回收了,和我这还不太一样...我这里UTexture明明放在蓝图的变量怎么都被回收了..

安全判断UObject失效-2024-06-29-13-09-38

IsValid / IsValidLowLevel 是否有效

IsValid在蓝图里被常常用来检查一个UObject是否有效。 安全判断UObject失效-2024-06-29-13-11-07

但是很遗憾,这个方法只能被用来检查

对于悬空指针的情况,无论是IsValid/IsValidLowLevel都无法进行安全的检查,甚至会立刻崩溃。 原因是IsValid / IsValidLowLevel会试图访问这个UObject内部的成员,但是如果是悬空指针,所处的内存读到的是垃圾数据

bool UObjectBase::IsValidLowLevel() const
{
	if( this == nullptr )
	{
		UE_LOG(LogUObjectBase, Warning, TEXT("NULL object") );
		return false;
	}
	if( !ClassPrivate )  // 试图访问成员变量,可能会访问到不可访问的内存,或者调用到不正确的方法
	{
		UE_LOG(LogUObjectBase, Warning, TEXT("Object is not registered") );
		return false;
	}
	return GUObjectArray.IsValid(this);
}

正确检查UObject是否是悬空指针

虚幻提供了一个FWeakObjectPtr用来正确检查悬空指针,其原理是一个胖指针,额外记录了一些UObject的信息用来判断是否失效。

void FWeakObjectPtr::operator=(const class UObject *Object)
{
	if (Object // && UObjectInitialized() we might need this at some point, but it is a speed hit we would prefer to avoid
		)
	{
		ObjectIndex = GUObjectArray.ObjectToIndex((UObjectBase*)Object);
		ObjectSerialNumber = GUObjectArray.AllocateSerialNumber(ObjectIndex);
		checkSlow(SerialNumbersMatch());
	}
	else
	{
		Reset();
	}
}

FWeakObjectPtr从一个UObject*初始化时,其成员变量会记录这个UObject的唯一索引。 再利用UObject都会被注册到GUObjectArray这个特性。 只要判断当前GUObjectArray里是否还有这个索引,就可以判断这个UObject是否有效。

具体可以看FORCEINLINE FUObjectItem* Internal_GetObjectItem() const方法的实现,其主要的探测方法即是判断当前GUObjectArray是否还有这个Uobject。

另外一个很好的性质就是FWeakObjectPtr可以在其他线程探测UObject是否有效( FWeakObjectPtr::IsValid函数有一个额外参数bThreadSafeTest),因为它内部只有对GUObjectArray的读操作,没有写操作。 而GUObjectArray,如果深入去看的话,它的实现类似于std::deque,有一个很好的性质是添加元素不会引起对元素的引用失效。

修复方案

回到最开始的问题,最后考虑了一下,把保存材质参数绑定的地方额外保存一个FWeakObjectPtr,并在其他一些设置材质参数的地方和获取材质参数的地方额外添加了若干行if constexpr(std::is_point_v(ValueType))

如果是UObject*类型的参数,就需要额外初始化这个FWeakObjectPtr,并且在获取参数并绑定到Uniform阶段,也需要额外检查FWeakObjectPtr的有效性。

安全判断UObject失效-2024-06-29-13-33-37