Skip to content

generic_limit

Jump to bottom
walon edited this page May 29, 2022 · 6 revisions

泛型

clr中有两类泛型特性：泛型类型和泛型函数。泛型是c#中使用极其广泛的特性。即使一个没有明显包含泛型的用法，可能隐含了泛型相关的定义或者操作。例如 int[]隐含就实现 IEnemrable<int> 之类的接口。又如 为async生成状态机代码时，也会隐含生成一些对System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1<!T>::AwaitUnsafeOnCompleted<!!T1,!!T2> 之类的泛型代码。

AOT泛型引发的问题

huatuo实现了相当完整的clr特性，纯解释器部分的泛型无任何使用限制，但对于AOT泛型类则存在一些问题。

例如，你在热更新脚本里定义了个值类型

struct MyVector2
{
    public int x;
    public int y;
}

想在脚本中创建List<MyVector2> 这样的类型，通常来说是不可能的，因为List<T>的函数实现跟T直接相关，不同的T相应的代码不同，而List是AOT泛型类，它已经提前编译为native代码，已经无法根据T运行时得到正确的处理代码。故即使huatuo是个功能完整的的运行时，对这种AOT泛型也无法处理。

本质上，因为AOT翻译导致原始IL指令元数据的缺失，进而无法创建出AOT泛型函数的实例。如果原先在AOT中已经生成对应泛型函数的代码，例如假设你在AOT中用过List<int>.Count，则在huatuo可以使用。

泛型类，尤其是泛型容器List,Dictionary之类在代码中使用如此广泛，如果因为AOT限制，导致List<HotUpdateType>都不能运行，那游戏热更新的代码受限就太大了。幸运的是，il2cpp有泛型共享机制，对于一大部分类，只要它的共享泛型实例在AOT里存在，那它在热更新里也可以正常使用。

以List<T> 举例：

  • 可以使用AOT中使用过的任何List的实例化类型。例如你在AOT里用过List<vector3>,则热更新里也可以用
  • 可以使用任意List<HotUpdateEnum>。 只需要你在AOT里实例化某一个List<相同size的枚举类型>。
  • 可以使用任意引用类型的泛型参数List<HotUpdateClass>。 只需要你在AOT里实例化过 List<object>(或任意一个引用泛型参数如List<string>)

注意！！！不能 使用List<热更新值类型>。 因为值类型无法泛型共享，而热更新值类型不可能提前在AOT里泛型实例化。这个限制在接下来的AOT泛型版本会彻底去掉。不过即使后面去掉这个限制，对于AOT值类型，能提前泛型实例化，可以大幅提升性能（毕竟不用解释执行了）。所以后续会有工具帮助自动收集热更新模块中的泛型实例，尽量让它提前AOT实例化。

Generic Sharing

il2cpp为此引入一个概念叫泛型代码共享 Generic Sharing,此技术更早则源于mono。CLR中也有同样的概念，CLR认为所有引用类型实参都一样，所以可以代码共享，例如，为List<String>方法编译的代码可以直接用于List<Stream>方法，这是因为所有引用类型实参/变量只是指向托管堆的一个8字节指针（这里假设64位系统），但是对于值类型，则必须每种类型都进行代码生成，因为值类型大小不定

il2cpp为了避免泛型代码膨胀，节约内存，在保证代码逻辑正确性的情况下对于一些能够共享代码(什么情况下能够共享?：因为值类型内存大小不定，所以无法共享)，只生成一份代码。

其中一个最常见的情况，对引用类型和int以及enum类型，生成共享代码。

同样以List<T>为例。 List<object>和List<string>的 Count 函数，生成一份代码是完全合理正确的。

那il2cpp会泛型类型，生成哪些共享代码呢。这里引入一个概念叫共享归结类型(sharing reduce type)(不要google了，这词是我发明的)。

Sharing Reduce Type

计算规则如下

非枚举的值类型

reduce type为自身。如int的reduce type为int

枚举类型

reduce type为 underlying type与它相同的枚举。例如

enum MyEnum 
{
    A = 1,
}

enum MyEnum2 : byte
{
    A = 10,
}

由于enum的默认underlying type是int，因此MyEnum的reduce type为 Int32Enum,MyEnum2的reduce type为 ByteEnum。

class引用类型

reduce type为 object

泛型类型

GenericType<T1,T2,...> 如果是class类型则reduce type为object，否则reduce type为 GenericType<ReduceType<T1>, ReduceType<T2>...>。

例如

  • Dictionary<int, string>的reduce type为object。
  • YourValueType<int, string>的reduce type为YourValueType<int,object>

Reduce Type的函数共享

对泛型类型的所有泛型实例化参数进行Sharing Reduce Type计算后，得到最终的泛型共享类型(final sharing generic type) GenericType<ReduceType<T1>, ReduceType<T2>...>。

粗略来说（实际规则远比这个复杂，尤其是泛型函数共享），il2cpp会为泛型生成它的共享类型的共享函数。所有相同reduce type的类的可共享(不是所有函数都可共享)这些函数。

举例 List<object>, List<string>, List<GameObject>的Count 函数，都对应同一份代码，这几个类的的运行时元数据中的Count函数的函数指针都指向相同的c++函数。

至此真相大白，这就是为什么huatuo允许你在热更新代码中随意使用List<YourClassType>的原因。

泛型函数

对于普通的非虚成员或者静态泛型函数，如示例中 void Fire<T>(T obj)，它有跟泛型类成员函数相似的代码共享规则。这意味着对于 go.AddComponent<YourHotUpdateMonoBehaviour>() 这样的泛型函数，尽管你从未在AOT中使用过它，你仍然能在huatuo中写出这样的代码并且正确运行的原因。

但泛型函数的共享规则远比泛型类的普通函数更复杂，因为clr支持神奇的泛型虚函数，如下例子

interface IFoo
{
    void Show<T>();
}

class FooImpl : IFoo
{
    
    public void Show<T>()
    {
        UnityEngine.Debug.Log(typeof(t));
    }
    
    public virtual void Run<T>()
    {
        UnityEngine.Debug.Log(default(T));
    }
    
    public void Fire<T>(T obj)
    {
        UnityEngine.Debug.Log(obj);
    }
}

例子中 Show<T> 是泛型接口函数。 Run<T>是普通泛型虚函数。

这些虚泛型函数又引发一个新的概念 RGCTX，机制复杂，这里不再展开讲述。但泛型虚函数，也是遵循相同的代码共享规则。

泛型函数的共享泛型函数 计算示例

泛型类型信息本身只是元数据，内存中可以构造出任意的AOT泛型类型信息，本质上缺失的是AOT泛型类的函数。

对于 Class<C1, C2, ...>.Method<M1, M2, ...>(A1, A2, ...) 的AOT泛型函数为 Class<reduce(C1), reduce(C2), ...>.Method<reduce(M1), reduce(M2), ...>(reduce(A1), reduce(A2), ...)

  • List<string>.ctor 对应共享函数为 List<object>.ctor
  • List<int>.Add(int) 对应共享函数为 List<int>.Add(int)
  • YourGenericClass<string, int, List<int>>.Show<string, List<int>, int>(ValueTuple<int, string>, string, int) 的共享函数为 YourGenericClass<object, int, object>.Show<object, object, int>(ValueTuple<int, object>, object, int)

一个很有用的小技巧，RefTypes.cs 中添加对应AOT泛型函数的调用时，对于函数参数，通过 default(T) 来指定这个参数。

代码裁剪

由于unity默认的代码裁剪规则，如果你未在代码中使用过，它是不会为你生成这些reduce type的共享函数的。故为了让 List<YourHotUpdateClass> 能够正确运行。你要确保 List<object> （其实List<string>也行）必须在AOT中有正确的实例。

为了避免在脚本中不能使用List<int>或者List<string>，你得事先在AOT中使用或者引用过这些类型。感谢Generic Sharing，这些引用类不多。

为了方便大家使用，我们会提供一个默认的 RefTypes.cs 代码，它已经包含了对常见泛型类型的实例化。 你也可以自己填写或者扩充它。

Clone this wiki locally