.NET 中的 Native AOT

07/12/2022 15:36:39 | China Standard Time

本机 AOT 的主要优点是启动时间、内存使用率、访问受限平台（不允许 JIT）以及磁盘上较小的大小。应用程序在操作系统页面中分页到内存时开始运行。数据结构针对运行 AOT 生成的代码进行了优化，而不是针对在运行时编译新代码进行了优化。本机 AOT 最适合于启动时间最重要的环境。

# 本机 AOT 部署

## 什么是AOT

将应用发布为 本机 AOT 会生成一个 独立 应用，并且该应用已提前 (AOT) 编译为本机代码。 本机 AOT 应用具有`更快的启动速度`，`更小的程序体积`，`更少的内存占用`。 应用程序的用户可以在未安装 .NET 运行时的计算机上运行该应用程序。

> 无反射模式下，完全独立的 "Hello world" 应用在 x64 上可编译为 1 MB 的文件 （最小 400 kB）

本机 AOT 的优势对于具有大量已部署实例（例如云基础结构和超大规模服务）的工作负荷而言最为重要。 目前还不支持 ASP.NET Core（计划支持 WebAPI）。

## AOT vs JIT 编译

JIT 在最终用户/服务器计算机上执行，并且在 Roslyn 编译后，AOT 通常（例如 ngen.exe是一个例外）在开发人员计算机上运行。

本机 AOT 部署模型使用 IL 到本机编译器。 本机 AOT 应用在应用程序运行时不使用实时 (JIT) 编译器。 本机 AOT 应用可以在不允许 JIT 的受限环境中运行。 本机 AOT 应用程序面向特定的运行时环境，例如 Linux x64 或 Windows x64，就像发布 [独立应用](https://docs.microsoft.com/zh-cn/dotnet/core/deploying/#publish-self-contained) 一样。

![aotvsjit](https://corehome.oss-accelerate.aliyuncs.com/blogs/8d8e27df-77a3-468f-8d26-7605128965f3.jpg "aotvsjit")

> .NET 7 支持本机 AOT，但只有有限数量的库与 .NET 7 中的本机 AOT 完全兼容。

# 本机 AOT 部署的限制

本机 AOT 应用程序附带一些基本限制和兼容性问题。 关键限制包括：

- 无动态负载（例如Assembly.LoadFile)

- 无需生成运行时代码（例如System.Reflection.Emit)

- 没有C++/CLI，没有内置的 COM 和 WinRT 互操作支持

- 不支持 [无约束的反射](https://github.com/dotnet/runtime/blob/main/src/coreclr/nativeaot/docs/reflection-in-aot-mode.md)

发布过程将分析整个项目及其依赖项，并在运行时可能会受到已发布应用程序的限制时生成警告。

.NET 7 中本机 AOT 的第一个版本具有额外的限制。 其中包括：

- 应面向控制台类型应用程序， (不支持 ASP.NET Core) 。

- 并非所有运行时库都完全注释为本机 AOT 兼容的 (，即运行时库中的某些警告不能由最终开发人员) 操作。

- 有限的诊断支持 (调试和分析) 。

# 平台/体系结构限制

下表显示了面向 .NET 7 时支持的编译目标。

|     平台     |  支持的体系结构  |
| ------------ | -------------- |
|    Windows   |   x64、Arm64   |
|     Linux    |   x64、Arm64   |
|     MacOS    |   x64、Arm64   |


# .NET 7 中的 Native AOT

在 .NET 7 preview.2 中，微软宣布将 NativeAOT 项目从实验状态转移到 .NET 7 的主线开发中。从实验性的 [dotnet/runtimelab](https://github.com/dotnet/runtimelab) 存储库中移出，并进入 [dotnet/runtime](https://github.com/dotnet/runtime) 存储库。在 .NET 7 中为控制台应用和本机库方案启用 NativeAOT。任何没有修剪/AOT 警告的库都应与这些外形规格兼容。

![nativeaotgithub](https://corehome.oss-accelerate.aliyuncs.com/blogs/7d8c7ec1-3534-4969-9839-e705f6f7f714.jpg "nativeaotgithub")

详情可见 [NativeAOT in .NET 7](https://github.com/dotnet/runtime/issues/61231#issuecomment-1180083147)

完整计划如下：

- 将 NativeAOT 项目移出和移入dotnet/runtimelabdotnet/runtime
	- 构建
	- 集成测试
	- 打包
- 切换到运行时构建的本机 AOT 包
- 使用 NativeAOT 载入第一方 dotnet 控制台应用程序
	使用 NativeAOT 构建 Crossgen 并修剪
	支持 dotnet-trace
- 性能：
	至少与JSON和Plaintext TechEmpower一样快
	- YARP
		- YARP 启动时间 小于50ms
	- 开始跟踪构建时间
- 诊断
	- 引入 AOT 兼容性注释
		- 添加需求动态代码属性
	- 事件管道
	- 探索 SOS 扩展子集
- 可重复且可验证的 NativeAOT 构建
	- 断续器
	- CET（阴影堆栈）
- 开发工具包支持
	- 用于启用 AOT 编译的 MSBuild 属性
- 测试
	- 测试与链接器的诊断兼容性
	- 类库单元测试
- 文档
	- 构建应用
	- 构建库

.NET 7 中不包含的计划，尤其是在不适合修整的应用程序中：

- 复杂的反射依赖框架，如 ASP.NET MVC 和 WPF
- 具有动态加载程序集的插件模型的应用，如 MSBuild
- 移动，WASM（已经由Mono提供）

# 使用 Native AOT

## 编译

在 .NET 7 正式发布时 Native AOT 将会被集成在 .NET SDK 中，你可以直接使用 `dotnet publish` 命令发布本机 AOT 应用程序。

### 确保发布本机 AOT 应用程序所需的先决条件位于计算机中。

- 在Windows上安装 Visual Studio 2022，包括使用 C++ 工作负载进行桌面开发。

- 在 Linux 上，为 .NET 运行时所依赖的库安装 clang 和开发人员包。

Ubuntu (18.04+)

```bash
sudo apt-get install clang zlib1g-dev
```

Alpine (3.15+)

```bash
sudo apk add clang gcc lld musl-dev build-base zlib-dev
```

> 如果你使用 .NET 6 你需要在发布前通过 Nuget 安装 [`Microsoft.DotNet.ILCompiler`](https://www.nuget.org/packages/Microsoft.DotNet.ILCompiler/7.0.0-preview.6.22324.4)

### 将 AOT 标识添加到项目文件。

这将生成本机 AOT 应用，并在生成期间显示 PublishAot 兼容性警告。

```xml
<PropertyGroup>
	<PublishAot>true</PublishAot>
</PropertyGroup>
```

### 使用 dotnet publish 为特定的运行时发布应用.

以下示例将Windows的应用发布为计算机上安装所需的先决条件的本机 AOT 应用程序。

```bash
dotnet publish -r win-x64 -c Release
```

以下示例将适用于 Linux 的应用发布为本机 AOT 应用程序。 在 Linux 计算机上生成的本机 AOT 二进制文件仅适用于相同或更新的 Linux 版本。 例如，在 Ubuntu 20.04 上生成的本机 AOT 二进制文件将在 Ubuntu 20.04 及更高版本上运行，但它不会在 Ubuntu 18.04 上运行。

```bash
dotnet publish -r linux-arm64 -c Release
```

该应用将在发布目录中可用，并包含在发布目录中运行所需的所有代码，包括 coreclr 运行时的剥离版本。

### 使用每日构建

若要使用每日生成，需要确保项目的文件在元素下包含以下包源：

```xml
<add key="dotnet7" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet7/nuget/v3/index.json" />
<add key="nuget" value="https://api.nuget.org/v3/index.json" />
```

如果您的项目没有文件，则可以通过以下命令创建 `nuget.config`

```bash
dotnet new nugetconfig
```

从项目的根目录。如果决定保留元素，则必须在元素之后添加新的包源。`<clear />`

添加包源后，通过运行

```bash
dotnet add package Microsoft.DotNet.ILCompiler -v 7.0.0-*
```

或通过将以下元素添加到项目文件中：

```xml
<ItemGroup>
	<PackageReference Include="Microsoft.DotNet.ILCompiler" Version="7.0.0-*" />
</ItemGroup>
```

### 跨架构编译

原生AOT工具链允许在x64主机上定位ARM64，反之亦然。不支持跨操作系统编译，例如在 Windows 主机上定位 Linux。若要在 Windows x64 主机上面向 win-arm64，除了程序包引用之外，还要添加程序包引用以获取 x64 托管的编译器：`Microsoft.DotNet.ILCompiler` `runtime.win-x64.Microsoft.DotNet.ILCompiler`

```xml
<PackageReference Include="Microsoft.DotNet.ILCompiler; runtime.win-x64.Microsoft.DotNet.ILCompiler" Version="7.0.0-preview.2.22103.2" />
```

请注意，对两个包使用相同的版本非常重要，以避免潜在的难以调试的问题（使用dotnet7中的最新版本）。添加包引用后，您可以像往常一样发布 win-arm64：

```bash
dotnet publish -r win-arm64 -c Release
```

同样，要在 Linux x64 主机上面向 linux-arm64，除了包引用之外，还要添加包引用以获取 x64 托管的编译器：`Microsoft.DotNet.ILCompiler` `runtime.linux-x64.Microsoft.DotNet.ILCompiler`

```xml
<PackageReference Include="Microsoft.DotNet.ILCompiler; runtime.linux-x64.Microsoft.DotNet.ILCompiler" Version="7.0.0-preview.2.22103.2" />
```

您还需要使用该属性为 Clang 指定 sysroot 目录。例如，假设您正在使用此存储库用于交叉编译的面向 ARM64 的 [Docker 映像](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/coreclr/linux-instructions.md#Docker-Images) 之一，则可以使用以下命令针对 linux-arm64 进行发布：`SysRoot`

```bash
> dotnet publish -r linux-arm64 -c Release -p:CppCompilerAndLinker=clang-9 -p:SysRoot=/crossrootfs/arm64
```

## 调试

NativeAOT提前编译器生成完全原生的可执行文件，这些文件可以由您选择的平台上的本机调试器进行调试（例如，Windows上的WinDbg或Visual Studio，类Unix系统上的gdb或lldb）。

NativeAOT 编译器生成有关行号、类型、局部变量和参数的信息。本机调试器将允许您检查堆栈跟踪和变量、单步执行/单步执行源代码行或设置行断点。

若要调试托管异常，请在方法上设置断点 - 每当引发托管异常时，都会调用此方法。`RhThrowEx`

## 无反射模式

无反射模式是 NativeAOT 编译器和运行时的一种模式，它大大降低了反射 API 的功能，并因此带来了一些有趣的好处。此模式的优点是：

- 大大减小了独立部署的大小 - 完全独立的“Hello world”应用可编译为 1 MB 文件（在 x64 上），没有依赖项。

- 减少工作集和更好的代码局部性 - 程序的各个部分更紧密地打包在一起。

- 人们进行逆向工程的元数据更少 - 在无反射模式下编译的应用程序与以C++编写的应用程序一样难以进行反向工程。

当然，好处也有一个缺点：并非所有 .NET 代码都可以在这样的环境中工作，请谨慎使用此模式。

若要在已使用 NativeAOT 的项目中启用无反射模式，请将以下属性添加到项目文件中的 中：`PropertyGroup`

```xml
<PropertyGroup>
	<IlcDisableReflection>true</IlcDisableReflection>
</PropertyGroup>
```

### 禁用反射时编译时有何不同

禁用反射后，AOT 编译器将停止发出在运行时使反射工作所需的数据结构，并停止强制实施使代码更易于反射的策略。

- 方法、类型、参数的名称不再生成到可执行文件中。
- 不再生成其他元数据，如方法参数类型列表。
- 编译器不再生成适合反射调用的独立方法体。
- 不再生成将方法名称映射到本机代码的映射表。
- 不再编译反射的实现。

### 在无反射模式下工作的反射 API

无反射模式支持一组有限的反射 API，这些 API 保留其预期的语义。

- `typeof(SomeType)` 可与其他表达式的结果或调用的结果进行比较。泛型代码性能优化中常用的模式将正常工作。`System.Type` `typeof` `Object.GetType()` `typeof(T) == typeof(byte)` `obj.GetType() == typeof(SomeType)`

- 以下 API 工作：`System.Type` `TypeHandle` `UnderlyingSystemType` `BaseType` `IsByRefLike` `IsValueType` `GetTypeCode` `GetHashCode` `GetElementType` `GetInterfaces` `HasElementType` `IsArray` `IsByRef` `IsPointer` `IsPrimitive` `IsAssignableFrom` `IsAssignableTo` `IsInstanceOfType`
- `Activator.CreateInstance<T>()`将工作。编译器在编译时对其进行静态分析并将其扩展为高效代码。运行时不涉及反射。
- `Assembly.GetExecutingAssembly()` 将返回可与其他运行时实例进行比较的 。这主要是为了使 `System.Reflection.Assembly` `Assembly` `NativeLibrary.SetDllImportResolver` 可用。

详情可见[此处](https://github.com/dotnet/runtime/blob/main/src/coreclr/nativeaot/docs/reflection-free-mode.md)

## AOT 模式下的反射

提前编译 .NET 代码时，编译器提前面临的一个典型问题是决定要编译哪些代码以及要生成的数据结构。

对于静态语言（如 C 或 C++），决定在最终可执行文件中包含哪些内容的问题非常简单：首先要包含并建立其他方法和数据结构引用的内容。然后包括这些引用，引用的引用等等，直到没有引用可以包含为止。这个概念很容易理解，非常适合C或C++等语言。这种方法的不错副作用是生成的程序很小。如果代码不调用函数，则不会在最终的可执行文件中生成该函数。

这种方法的问题开始出现在允许不受约束的反思的平台上。反射是 .NET 提供的一种机制，它允许开发人员在运行时检查程序的结构并访问/调用类型及其成员。通过不受约束的反思，“程序”的定义包括“在编译程序时可以访问的所有内容”。

案例：

```csharp
class Program
{
	public static void Main()
	{
		Console.Write("Name of type: ");
		string typeName = Console.ReadLine();

		// Allow to exit the program peacefully
		if (String.IsNullOrEmpty(typeName))
			return;

		Console.Write("Name of method: ");
		string methodName = Console.ReadLine();

		Type.GetType(typeName).GetMethod(methodName).Invoke(null, null);
	}

	public static void SayHello()
	{
		Console.WriteLine("Hello!");
	}
}
```

虽然上面的示例程序在现实中并不实用，但类似的模式存在于例如基于反射的序列化和反序列化库中，这些库根据成员的名称访问成员，这些名称可以从互联网上下载。反射的动态特性不会仅对完全 AOT .NET 运行时造成问题。当使用 IL 链接器等工具删除不必要的代码时，这也是一个问题。

### 在外部向编译器提供提示

如果编译器无法检测应用程序使用的类型，则可以对 rd.xml 文件进行补充，以帮助 ILCompiler 找到应分析的类型。为此，应创建文件并将以下行添加到项目文件中 `rd.xml`

```xml
<ItemGroup>
	<RdXmlFile Include="rd.xml" />
</ItemGroup>
```

你可以在[此处](https://github.com/dotnet/runtime/blob/main/src/coreclr/nativeaot/docs/rd-xml-format.md)找到此文件的配置说明。