HybridCLRCrashWorkarounds

用于规避HybridCLR引发的Unity崩溃问题，详见文章

简单来说，使用HybridCLR导致Unity无法在启动时创建热更dll中的MonoScript（MonoBehaviour和ScriptableObject）的缓存。在这种情况下，运行时可能多线程对这部分数据进行修改，从而导致崩溃

比如：

1. 异步加载预制体时，主线程调用GameObject.AddComponent（预制体包含热更dll中的MonoBehaviour、AddComponent的类型是热更dll中的MonoBehaviour）
2. 异步加载预制体时，主线程调用Object.Destroy销毁从另一个预制体实例化出来的对象（预制体包含热更dll中的MonoBehaviour）

HybridCLRCrashWorkarounds利用Unity的一个内部方法，主动提前创建MonoScript的缓存，从而避免后续出现多线程修改的情况

支持平台:

• Android
• iOS

已验证版本（理论上兼容HybridCLR支持的所有Unity版本）:

• 2022.3.60f1
• 2022.3.57f1

目录

• 崩溃调用栈例子
• 集成
  • 说明
  • 兼容旧包
  • 性能

崩溃调用栈例子

1. 该调用栈是本地复现工程在Android设备上出现的（Unity 2022.3.60f1）

#00 pc 0000000001337f3c (std::__ndk1::__shared_weak_count::__release_weak() at /buildbot/src/android/ndk-release-r23\toolchain/llvm-project/libcxx/src/memory.cpp:0) 
#01 pc 00000000008dbc70 (FindOrCreateMonoScriptCache(ScriptingClassPtr, InitScriptingCacheType, Object*, int, core::basic_string<char, core::StringStorageDefault<char> >) at ??:0)
#02 pc 00000000008dbb44 (MonoScript::Renew(ScriptingClassPtr) at ??:0)
#03 pc 0000000000921cac (PersistentManager::PostReadActivationQueue(int, TypeTree const*, bool, PersistentManager::LockFlags) at ??:0)
#04 pc 000000000092240c (PersistentManager::ReadAndActivateObjectThreaded(int, SerializedObjectIdentifier const&, SerializedFile*, bool, bool, PersistentManager::LockFlags) at ??:0)
#05 pc 0000000000922618 (PersistentManager::LoadObjectsThreaded(int const*, int, LoadProgress&, bool, PersistentManager::LockFlags, bool) at ??:0)
#06 pc 00000000007d63b8 (LoadOperation::Perform() at ??:0)
#07 pc 0000000000adcf94 (AssetBundleLoadAssetOperation::Perform() at ??:0)
#08 pc 00000000007d8838 (PreloadManager::ProcessSingleOperation() at ??:0)
#09 pc 00000000007d85c0 (PreloadManager::Run() at ??:0)
#10 pc 00000000007d8518 (PreloadManager::Run(void*) at ??:0)
#11 pc 000000000087bfb8 (Thread::RunThreadWrapper(void*) at ??:0)

2. 该调用栈是项目线上在iOS设备上出现的（Unity 2022.3.60f1）

0 0x00000001089755a8 core::hash_set<core::pair<long const, std::__1::weak_ptr<MonoScriptCache>, false>, core::hash_pair<core::hash<long>, long, std::__1::weak_ptr<MonoScriptCache>>, core::equal_pair<std::__1::equal_to<... + 52 (hash_set.h:948)
1 0x0000000108973028 find + 12 (hash_map.h:210)
2 0x0000000108973028 ScriptingManager::GetMonoScriptCache(long) + 44 (ScriptingManager.cpp:270)
3 0x0000000108985378 FindMonoScriptCache + 16 (MonoScriptCache.cpp:625)
4 0x0000000108985378 FindOrCreateMonoScriptCache(ScriptingClassPtr, InitScriptingCacheType, Object*, int, core::basic_string<char, core::StringStorageDefault<char>>) + 72 (MonoScriptCache.cpp:630)
5 0x00000001089c42f8 SerializableManagedRef::SetupScriptingCache(Object*, ScriptingClassPtr, MonoScript*) + 144 (SerializableManagedRef.cpp:190)
6 0x00000001089c4674 SerializableManagedRef::RebuildMonoInstance(Object*, ScriptingClassPtr, ScriptingObjectPtr, MonoScript*) + 92 (SerializableManagedRef.cpp:222)
7 0x00000001089c4c94 SerializableManagedRef::RebuildMonoInstanceFromScriptChange(Object*, ScriptingClassPtr, ScriptingObjectPtr) + 164 (SerializableManagedRef.cpp:282)
8 0x0000000108981c70 ManagedMonoBehaviourRef::RebuildMonoInstanceFromScriptChange(Object*, ScriptingClassPtr, ScriptingObjectPtr) + 76 (ManagedMonoBehaviourRef.cpp:306)
9 0x00000001089c52c0 SerializableManagedRef::SetScript(Object*, PPtr<MonoScript>, ScriptingObjectPtr) + 284 (SerializableManagedRef.cpp:418)
10 0x00000001087a0a68 ProduceClone(Object&) + 260 (CloneObject.cpp:62)
11 0x000000010879e60c CollectAndProduceGameObject + 140 (CloneObject.cpp:89)
12 0x000000010879e60c CollectAndProduceGameObjectHierarchy(Transform&, Transform*, vector_map<int, int, std::__1::less<int>, stl_allocator<std::__1::pair<int, int>, (MemLabelIdentifier)1, 16>>&) + 812 (CloneObject.cpp:142)
13 0x000000010879e294 CollectAndProduceClonedIsland(Object&, Transform*, vector_map<int, int, std::__1::less<int>, stl_allocator<std::__1::pair<int, int>, (MemLabelIdentifier)1, 16>>&) + 160 (CloneObject.cpp:235)
14 0x000000010879f5e0 CloneObjectImpl(Object*, Transform*, vector_map<int, int, std::__1::less<int>, stl_allocator<std::__1::pair<int, int>, (MemLabelIdentifier)1, 16>>&) + 44 (CloneObject.cpp:308)
15 0x000000010879f3f4 CloneObject(Object&) + 76 (CloneObject.cpp:495)
16 0x000000010869f270 Object_CUSTOM_Internal_CloneSingle(ScriptingBackendNativeObjectPtrOpaque*) + 88 (CoreBindings.gen.cpp:62279)
...

集成

1. 引用包com.modx.hybridclr-crash-workarounds，参考格式: https://github.com/AlanLiu90/HybridCLRCrashWorkarounds.git?path=/src/HybridCLRCrashWorkarounds/Packages/com.modx.hybridclr-crash-workarounds#v1.0.0
2. 打包时将热更dll中的MonoScript的信息写入一个文件，可参考 demo\HybridCLRTrial\Assets\Editor\MyMonoScriptWriter.cs
3. 打包时记录符号的偏移，可参考 demo\HybridCLRTrial\Assets\Editor\SymbolOffsetsWriter.cs
4. 运行时加载记录MonoScript的信息的文件和记录符号的偏移的文件，调用接口HybridCLRCrashWorkarounds.CreateMonoScripts创建MonoScript，可参考 demo\HybridCLRTrial\Assets\HotUpdate\Test.cs

说明

1. 只有Android需要记录符号的偏移，如果只对iOS使用，可以跳过第三步
2. 第二步生成的文件的内容是对应热更dll的，需要热更
3. 第三步生成的文件的内容是对应包体的，不需要热更
4. 调用接口创建MonoScript，需要在HybridCLR加载热更dll之后
5. 提供了2种方式收集MonoScript：反射和使用dnlib解析。两者的区别:
   • 反射: 需要自己过滤掉编辑器内的MonoBehaviour和ScriptableObject(比如定义了UNITY_EDITOR才启用的类型)。优点是对执行时机没有要求
   • dnlib解析: 由于是从打包编译的dll中收集MonoScript，所以不会有编辑器内的MonoBehaviour和ScriptableObject。这种方法用到了最新版本的AOT dll，需要有合适的时机执行，比如在HybridCLR/Generate/All之后执行

兼容旧包

对于线上已有包体的情况，可以在热更dll中这样实现：

private void CreateMonoScripts()
{
	if (/* 判断是新包 */)
		CreateMonoScriptsInternal();
}

private void CreateMonoScriptsInternal()
{
	byte[] bytes = /* 加载 MonoScripts.bytes */;
	HybridCLRCrashWorkarounds.CreateMonoScripts(bytes);
}

性能

对于3757个MonoScript的情况，使用Unity 2022.3.60f1测试HybridCLRCrashWorkarounds.CreateMonoScripts的耗时：

• Redmi 8A: 约750ms
• Xiaomi Mi 10: 约180ms
• iPad 9th generation: 约90ms