IL2CPP Internals: Generic sharing implementation

在上一篇文章中，我们研究了如何在为IL2CPP脚本后端生成的c++代码中调用方法。在这篇文章中，我们将探讨它们是如何实现的。具体来说，我们将尝试更好地理解使用IL2CPP生成的代码的最重要特性之一——泛型共享(generic sharing)。泛型共享允许许多泛型方法共享一个公共实现。这将导致IL2CPP脚本后端可执行文件大小的显著减小。

请注意，泛型共享并不是一个新想法，Mono和. net runtime也使用泛型共享。最初，IL2CPP没有执行泛型共享。最近的改进使它更加强大和有益。因为il2cpp.exe生成c++代码，所以我们可以看到共享方法是在哪个地方实现的。

我们将探讨这些泛型方法对于引用类型和值类型如何共享(或不共享)是如何实现的。我们还将研究泛型参数约束是如何影响泛型共享的

What is generic sharing?

假设您正在用c#编写List<T>类的实现。这个实现是否取决于类型T ?你能对List<string>和List<object>使用相同的Add方法实现吗?List< DateTime >又如何呢？

事实上，泛型的强大之处在于这些c#实现可以共享，泛型类List<T>将适用于任何T。但是当List从c#被翻译成可执行的东西，比如汇编代码(Mono)或c++代码(IL2CPP)时会发生什么呢?我们还能共享Add方法的实现吗?

是的，大多数时候我们可以一起分享。正如我们在这篇文章中所发现的，泛型方法是否能共享几乎完全取决于类型T的大小。如果T是任何引用类型(比如字符串或对象)，那么它总是指针的大小。如果T是一个值类型(比如int或DateTime)，那么它的大小可能会有所不同，事情会变得更加复杂。可以共享的方法实现越多，得到的可执行代码就越小。

实现了泛型共享的Mono的开发人员Mark Probst发表了一系列关于Mono如何执行泛型共享的优秀文章。我们不会在这里深入讨论泛型共享。相反，我们将看到IL2CPP如何以及何时执行泛型共享。希望这些信息将帮助您更好地分析和理解项目的可执行大小。

What is shared by IL2CPP?

当前，IL2CPP共享一个泛型类型SomeGenericType<T>的泛型方法实现，当T为:

• 任何引用类型(例如字符串、对象或任何用户定义的类)
   
• 任何整数或枚举类型

当T是值类型时，IL2CPP不共享泛型方法实现，因为每个值类型的大小将不同(根据其字段的大小)。

实际上，这意味着添加一些generictype <T>的新用法(其中T是引用类型)将对可执行文件的大小产生最小的影响。但是，如果T是值类型，则可执行文件的大小将受到影响。Mono和IL2CPP脚本后端的这种行为是相同的

The setup

我将在Windows上使用Unity 5.0.2p1，并为WebGL平台构建。我在构建设置中启用了“Development Player”选项，而“Enable Exceptions”选项的值设置为“None”。这篇文章的脚本代码从一个Start程序方法开始，用来创建我们将要研究的泛型类型的实例:

public void DemonstrateGenericSharing() {
var usesAString = new GenericType<string>();
var usesAClass = new GenericType<AnyClass>();
var usesAValueType = new GenericType<DateTime>();
var interfaceConstrainedType = new InterfaceConstrainedGenericType<ExperimentWithInterface>();
}

接下来，我们定义这个方法中使用的类型:

	
class GenericType<T> {
public T UsesGenericParameter(T value) {
return value;
}
 
public void DoesNotUseGenericParameter() {}
 
public U UsesDifferentGenericParameter<U>(U value) {
return value;
}
}
 
class AnyClass {}
 
interface AnswerFinderInterface {
int ComputeAnswer();
}
 
class ExperimentWithInterface : AnswerFinderInterface {
public int ComputeAnswer() {
return 42;
}
}
 
class InterfaceConstrainedGenericType<T> where T : AnswerFinderInterface {
public int FindTheAnswer(T experiment) {
return experiment.ComputeAnswer();
}
}

所有的代码都嵌套在一个名为HelloWorld的类中，这个类继承自MonoBehaviour。

如果您查看il2cpp的命令行。请注意，它不包含——enable-generic-sharing选项，如本系列第一篇文章所述。然而，通用共享仍然在发生。它不再是可选的，现在在所有情况下都会发生。

Generic sharing for reference types

我们将从最常见的泛型共享案例开始:引用类型。因为托管代码中的所有引用类型都派生自System.Object，生成的c++代码中的所有引用类型都派生自Object_t类型。然后，可以使用类型Object_t*作为占位符在c++代码中表示所有引用类型

让我们搜索生成的DemonstrateGenericSharing方法版本。在我的项目中，它被命名为HelloWorld_DemonstrateGenericSharing_m4。我们查找到GenericType类中的四个方法的定义。使用Ctags，我们可以跳转到GenericType<string>构造函数，即：generictype_1_ctor_m8的方法声明。注意，这个方法声明实际上是一个#define语句，它将该方法映射到另一个方法GenericType_1__ctor_m10447_gshared.

如果我们跳转到generictype_1_ctor_m10447_gshared的定义，我们可以从方法定义上的代码注释中看到，该方法对应于托管方法名HelloWorld/GenericType ' 1<System.Object>::.ctor()。这是GenericType<object>类型的构造函数。此类型称为完全共享类型，这意味着给定类型GenericType<T>，对于任何引用类型的T，所有方法的实现都将使用此版本，其中T是object。

看看下面生成的代码的构造函数，你应该看到c++代码的UsesGenericParameter方法:

extern "C" Object_t * GenericType_1_UsesGenericParameter_m10449_gshared (GenericType_1_t2159 * __this, Object_t * ___value, MethodInfo* method)
{
{
Object_t * L_0 = ___value;
return L_0;
}
}

在使用泛型参数T的两个地方(返回类型和单个托管参数的类型)，生成的代码都是使用的Object_t*类型。因为所有引用类型都可以在生成的代码中由Object_t*表示，所以我们可以为任何引用类型的T调用这个单一方法实现。

在本系列的第二篇博客文章(关于生成的代码)中，我们提到所有的方法定义都是c++中的自由函数。il2cpp.exe不会使用c++继承来生成c#中override的方法。但是，il2cpp.exe确实对类型使用了c++继承。如果我们在生成的代码中搜索字符串“AnyClass_t”，我们可以找到c#类型AnyClass的c++表示:

因为AnyClass_t1是从Object_t派生的，所以我们可以毫无问题地将AnyClass_t1的指针作为GenericType_1_UsesGenericParameter_m10449_gshared函数的参数传递

那么返回值呢?我们不能返回一个基类的指针而需要一个派生类的指针，对吗?看一看的声明

GenericType < AnyClass >:: UsesGenericParameter方法:

#define GenericType_1_UsesGenericParameter_m10452(__this, ___value, method) (( AnyClass_t1 * (*) (GenericType_1_t6 *, AnyClass_t1 *, MethodInfo*))GenericType_1_UsesGenericParameter_m10449_gshared)(__this, ___value, method)

生成的代码实际上是将返回值(类型Object_t*)转换为派生类型AnyClass_t1*。所以在这里IL2CPP对c++编译器撒谎，以避免使用c++类型系统。由于c#编译器已经强制使用genericparameter的任何代码都不会对类型T做任何不合理的事情，那么IL2CPP在这里可以安全地欺骗c++编译器。

Generic sharing with constraints

如果我们想调用类型为T的对象上的一些方法，那么使用Object_t*就不能防止这种情况吗?因为我们在System.Object上没有很多方法，是的，它会阻止。但是我们首先需要在c#中使用泛型约束

再次查看这篇文章的脚本代码，类型为InterfaceConstrainedGenericType。这个泛型类型使用where子句要求它的类型T派生自给定的接口AnswerFinderInterface。这允许调用ComputeAnswer方法。回想一下上一篇关于方法调用的博客文章，调用接口方法需要在虚函数表结构中进行查找。由于FindTheAnswer方法将直接对类型T的受约束实例进行函数调用，那么c++代码仍然可以使用完全共享的方法实现，类型T由Object_t*表示。

如果我们从HelloWorld_DemonstrateGenericSharing_m4的实现功能,然后跳到InterfaceConstrainedGenericType_1__ctor_m11函数的定义,我们可以看到,该方法使用#define定义,使用InterfaceConstrainedGenericType_1__ctor_m10456_gshared函数的映射。如果我们查看该函数下面的InterfaceConstrainedGenericType_1_FindTheAnswer_m10458_gshared函数的实现，我们可以看到，这确实是该函数的完全共享版本，使用Object_t*参数，

它调用InterfaceFuncInvoker0::Invoke函数来实际调用托管的ComputeAnswer方法

extern "C" int32_t InterfaceConstrainedGenericType_1_FindTheAnswer_m10458_gshared (InterfaceConstrainedGenericType_1_t2160 * __this, Object_t * ___experiment, MethodInfo* method)
{
static bool s_Il2CppMethodIntialized;
if (!s_Il2CppMethodIntialized)
{
AnswerFinderInterface_t11_il2cpp_TypeInfo_var = il2cpp_codegen_class_from_type(&AnswerFinderInterface_t11_0_0_0);
s_Il2CppMethodIntialized = true;
}
{
int32_t L_0 = (int32_t)InterfaceFuncInvoker0<int32_t>::Invoke(0 /* System.Int32 HelloWorld/AnswerFinderInterface::ComputeAnswer() */, AnswerFinderInterface_t11_il2cpp_TypeInfo_var, (Object_t *)(*(&amp;amp;___experiment)));
return L_0;
}
}

这些都在生成的c++代码中绑定在一起，因为IL2CPP将所有托管接口都像System.Object一样处理。这是一个非常有用的经验法则，可以帮助您在其他情况下理解il2cpp.exe生成的代码。

Constraints with a base class

除了接口约束之外，c#允许将约束作为基类。IL2CPP并不像对待System.Object那样对待所有基类。那么泛型共享如何为基类约束工作呢?

因为基类总是引用类型，所以IL2CPP为这些类型使用泛型方法的完全共享版本。任何需要使用字段或调用受约束类型中的方法的代码都将在c++中对适当的类型进行强制转换。同样，在这里我们依靠c#编译器来正确地强制通用约束，而在类型方面我们对c++编译器撒谎。

Generic sharing with value types

现在让我们回到HelloWorld_DemonstrateGenericSharing_m4函数，看看GenericType<DateTime>的实现。DateTime类型是值类型，因此不共享GenericType<DateTime>。我们可以跳转到该类型的构造函数声明，generictype_1_ctor_m10。在这里，我们看到了#define，就像在其他情况下一样，但是#define映射到generictype_1_ctor_m10_gshared函数，该函数特定于GenericType<DateTime>类，其他任何类都不会使用它。

Thinking about generic sharing conceptually

• 泛型类型上的每个方法实现都是共享的，比如add,remove
• 一些泛型类型只与自己共享方法的实现，比如上面的参数为值类型的泛型方法
• 带有引用类型泛型参数的泛型类型是完全共享的—它们总是使用System.Object实现所有类型的参数
• 如果泛型方法有多个参数，且至少有一个是引用类型，则可以部分共享

il2cpp.exe总是为任何泛型类型 生成 完全共享的方法实现。对于不是泛型的方法，只有在用到的时候才生成它们

Sharing of generic methods

正如泛型类型上的方法实现可以共享一样，泛型方法的方法实现也可以共享。在原始脚本代码中，请注意，UsesDifferentGenericParameter方法使用了与GenericType类不同的类型参数。当我们查看GenericType类的共享方法实现时，我们没有看到UsesDifferentGenericParameter方法。如果我搜索生成的代码“UsesDifferentGenericParameter”，我看到这个方法的实现是在genericmethods .cpp文件:

2 3 4 5 6 7

extern "C" Object_t * GenericType_1_UsesDifferentGenericParameter_TisObject_t_m15243_gshared (GenericType_1_t2159 * __this, Object_t * ___value, MethodInfo* method) { { Object_t * L_0 = ___value; return L_0; } }

意，这是方法实现的完全共享版本，接受类型Object_t*。尽管此方法属于泛型类型，但对于非泛型类型中的泛型方法，其行为也是相同的。实际上，il2cpp.exe总是试图为涉及泛型参数的方法实现生成尽可能少的代码。

Conclusion

泛型共享一直是其最重要的改进之一。它允许生成的c++代码尽可能的小，在下一篇文章中，我们将探讨如何生成p/invoke包装器，以及如何将类型从托管代码封送到本机代码。我们将能够看到封送处理各种类型的成本，以及封送处理代码的调试问题