直接使用匯編編寫 .NET Standard 庫

前言

Common Language Runtime（CLR）是一個很強大的運行時，它接收 Common Intermediate Language（CIL） 的輸入並最終產生機器代碼並執行。CIL 在 CLR 上相當於 ASM 匯編代碼的存在。

CLR 之上的語言 C#、F#、VB.NET 等語言的類型系統固然設計得不錯，但是有的時候我們需要一些操作繞過類型系統的檢查，或者有的時候語言本身並不能滿足我們的需求。

需要使用 CIL 的常見場景：

1. 我們需要繞過類型系統，在類型系統上面 “開洞”。
2. 我們需要優化程序的性能，直接使用 CIL 編程可以如同使用匯編一樣完全的控制程序的邏輯，對程序進行人肉優化。
3. 直接利用 C#、F# 等語言編譯成的 CIL 有其獨特的模式，容易被反編譯軟件從 CIL 還原為源代碼，而如果直接采用 CIL 編程則很容易避開編譯器生成代碼的固有模式，使得代碼無需進行任何混淆即可讓所有反編譯器失效。

需要注意：CLR 的 JIT 部分優化依賴於 CIL 的特定模式，直接采用 CIL 進行編程而不利用 C# 等語言的編譯器生成特定模式的 CIL 可能導致優化失效，如向量化、模式匹配緩存和常數時間優化等，因此在直接使用 CIL 進行編程時最好對 CLR 的 JIT 有一定了解，以規避潛在的性能問題，JIT 的源代碼在 https://github.com/dotnet/runtime/tree/master/src/coreclr/src/jit。

准備工作

首先我們創建一個 .NET Standard 項目：

mkdir MyILProject
cd MyILProject
dotnet new classlib

然后創建 global.json 和 nuget.config 文件用於配置 SDK：

dotnet new global
dotnet new nuget

將 global.json 的內容修改為如下，添加 IL SDK 來源：

{
  "msbuild-sdks": {
    "Microsoft.NET.Sdk.IL": "3.0.0-preview-27318-01"
  }
}

然后打開 nuget.config，將內容修改如下，添加 .net core myget 源：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="dotnet-core" value="https://dotnet.myget.org/F/dotnet-core/api/v3/index.json" />
  </packageSources>
</configuration>

之前創建的為 C# 類庫項目，但是我們此時需要的是 IL 類庫項目，因此將 MyILProject.csproj 文件重命名為 MyILProject.ilproj。

打開 MyILProject.ilproj 文件，引入 IL SDK，並添加一系列的屬性（如：輸出類型、優化選項、工具鏈等）：

<Project Sdk="Microsoft.NET.Sdk.IL">

  <PropertyGroup>
    <OutputType>Library</OutputType>
    <TargetFramework>netstandard2.1</TargetFramework>
    <DebugOptimization>IMPL</DebugOptimization>
    <DebugOptimization Condition="'$(Configuration)' == 'Release'">OPT</DebugOptimization>
    <MicrosoftNetCoreIlasmPackageVersion>3.0.0-preview-27318-01</MicrosoftNetCoreIlasmPackageVersion>
  </PropertyGroup>
  
</Project>

至此，萬事俱備

第一個文件

我們刪除掉原有的 C# 代碼文件 Class1.cs，創建代碼文件 Class1.il，並添加以下 CIL 代碼並保存：

.assembly MyILProject
{
    .ver 1:0:0:0
}

.module MyILProject.dll

.class public auto ansi sealed MyILProject.Class1
  extends [System]System.Object
{
  .method public hidebysig static int32 Hello(int32) cil managed
  {
    .maxstack 4
    
    ldstr "Hello World!"
    call void [System.Console]System.Console::WriteLine(string)

    ldarg.0
    ret
  }
}

以上代碼中，.assembly 標識了程序集名稱，.module 標識了模塊名稱，一般來說這兩個名字和項目名稱保持一致。

然后我們創建了一個 class Class1，位於 MyILProject 這個 namespace 下，該 class 為 public sealed 的，且繼承自 System.Object。

最后我們添加了一個靜態方法 int Hello(int)，該方法調用 System.Console.WriteLine 輸出字符串 Hello world!，然后加載參數的值后返回該值。

測試代碼

我們在上級目錄創建一個測試項目試試：

cd ..
mkdir Test
cd Test
dotnet new console
dotnet add reference ../MyILProject

然后修改 Program.cs：

using System;
using MyILProject;

namespace Test
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine(Class1.Hello(25));
        }
    }
}

運行

dotnet run

可以看到輸出為：

Hello world!
25

與我們所期望的一致。

然后我們試一下實例化 Class1：

var x = new Class1();

卻發現報錯：

Program.cs(10,28): error CS1729: 'Class1' does not contain a constructor that takes 0 arguments [...\Test.csproj]

這是因為，我們沒有為這個類創建構造方法，那么很簡單，我們只需要加一個構造方法即可，要注意構造方法特有的方法名為 .ctor：

.method public hidebysig specialname rtspecialname instance void .ctor () cil managed 
{
  .maxstack 8
    
  ldarg.0
  call instance void [System.Private.CoreLib]System.Object::.ctor()
  nop
  ret
}

然后就可以成功調用了！

添加引用

你會發現一個問題，上述代碼雖然能正常運行，但是編譯的時候卻存在警告：

Class.il(9): warning : Reference to undeclared extern assembly 'mscorlib'. Attempting autodetect [...\MyILProject.ilproj]      
Class.il(15): warning : Reference to undeclared extern assembly 'System.Console'. Attempting autodetect [...\MyILProject.ilproj]
Class.il(26): warning : Reference to undeclared extern assembly 'System.Private.CoreLib'. Attempting autodetect [...\MyILProject.ilproj]

這是因為我們並沒有聲明我們引入的庫 mscorlib，System.Console 和 System.Provate.CoreLib，所幸的是，因為這些是 .NET Core SDK 中自帶的庫因此編譯器可以自動查找並補上引用，所以沒有報錯，否則運行的時候會拋出異常： System.IO.FileNotFoundException: Could not load file or assembly xxxxx

如果想消除這些警告，我們可以創建一個頭文件引用這些庫，然后在 CIL 代碼文件的頭部 #include 頭文件，示例如下：

在 MyILProject 中新建 include 文件夾，創建一個 include.h：

.assembly extern System.Runtime
{
  .publickeytoken = ( B0 3F 5F 7F 11 D5 0A 3A )
  .ver 4:0:0:0
}

.assembly extern System.Console
{
  .publickeytoken = ( B0 3F 5F 7F 11 D5 0A 3A )
  .ver 4:0:0:0
}

.assembly extern System.Private.CoreLib
{
  .publickeytoken = ( B0 3F 5F 7F 11 D5 0A 3A )
  .ver 4:0:0:0
}

然后在 Class1.il 頭部加一行 #include "include.h" 包含該文件。

最后修改 MyILProject.ilproj，將 include 文件夾加入 INCLUDE 查找目錄（-INCLUDE=...）：

<Project Sdk="Microsoft.NET.Sdk.IL">

  <PropertyGroup>
    <OutputType>Library</OutputType>
    <TargetFramework>netstandard2.1</TargetFramework>
    <DebugOptimization>IMPL</DebugOptimization>
    <DebugOptimization Condition="'$(Configuration)' == 'Release'">OPT</DebugOptimization>
    <MicrosoftNetCoreIlasmPackageVersion>3.0.0-preview-27318-01</MicrosoftNetCoreIlasmPackageVersion>
    <IlasmFlags>$(IlasmFlags) -INCLUDE=include</IlasmFlags>
  </PropertyGroup>
  
</Project>

這次我們再次嘗試編譯，就不會報錯了。

CLI

上面的內容只簡單的使用了一些 CIL 語法，然而 CIL 也是非常強大的，包含有很多內容，具體可以參考 Common Language Infrastructure（CLI），這部分的內容包含在標准 ECMA-355 中，截至本文發布，最新的 CLI 標准版本是 2012 年發布的第六版。

ECMA-355：https://www.ecma-international.org/publications/standards/Ecma-335.htm ，歡迎各位讀者前去閱讀。

應用案例

.NET BCL 中提供了一個特殊的庫：System.Runtime.CompilerServices.Unsafe，這個庫允許你無視 C# 的類型系統進行各種類型轉換等的騷操作，這是你用 C# 無論如何都不可能寫出來的，官方也知道這一點，因此該庫完全是直接使用 CIL 編寫的，源代碼可參考：https://github.com/dotnet/runtime/blob/master/src/libraries/System.Runtime.CompilerServices.Unsafe/src/System.Runtime.CompilerServices.Unsafe.il