Substrate 入门(9) - Runtime的wasm与native

金晓
更新于 2020-01-23 23:14
阅读 4108

本篇文章就来具体介绍 Runtime 编译成 wasm 所需要的条件

Substrate 入门专题，目前有以下几篇文章：

* [环境配置与编译](https://learnblockchain.cn/article/273)
* [运行与调试](https://learnblockchain.cn/2019/12/21/substrate-run-debug/)
* [具备状态的链](https://learnblockchain.cn/2019/12/22/substrate-state/)
* [项目结构](https://learnblockchain.cn/2019/12/23/substrate-struct/)
* [区块头](https://learnblockchain.cn/2019/12/30/substrate-header/)
* [交易体](https://learnblockchain.cn/article/330)
* [Substrate 的模型设计](https://learnblockchain.cn/article/331)
* [Runtime 概要](https://learnblockchain.cn/article/348)
* [Runtime 的 wasm 与 native](https://learnblockchain.cn/article/382)
* [Runtime的构成](https://learnblockchain.cn/article/709)
* [学习Runtime必备的技能](https://learnblockchain.cn/article/714)

[上一篇文章](https://learnblockchain.cn/article/348)已经介绍了 Substrate Runtime 的设计概要，结合之前的文章，在此设计的基础上我们必须明白以下几点：

1. Runtime 是一个隔离的环境，其通过 API 与外界通信，通信时需要加载上指定块高以对应加载的状态
2. Substrate 的 Runtime 是同一份代码编译出两种执行文件，rust 的 native 与能在 wasm 虚拟机下运行的 wasm，通过启动节点时制定的参与及硬编码进入执行文件中的 Runtime 版本信息觉得执行哪一份文件

因此本篇文章就来具体介绍 Runtime 编译成 wasm 所需要的条件。

**本篇只会介绍创建或引入一个包进入 Runtime 的 wasm 体系所需要注意的点，至于其需要这么做的原理暂不在本篇中介绍。**

**ps: 注意！本文的内容并非十分严格（特别对于第三方库引入部分），因为要做到真正正确得从 rust 的 wasm 编译及 Substrate Runtime 的条件编译入手，本文只属于入门，并非介绍其原理，因此对于初学者而言，若不明白原理，那么现阶段照本文执行即可，在有一定积累后，再深入了解原理并做出改进**

## Runtime 的 WASM

这里首先就放出结论：

**Substrate 的 Runtime 的 WASM 并非标准 WASM，而是是一个有条件限制的 wasm，并非所有代码都可以编译成 Runtime 的 WASM**

而这个“有条件”即是本篇文章需要指明的内容。

因此很多使用 Substrate 写 Runtime 部分的程序员，经常遇到的一个问题就是：

“为什么我把一个库引入 Runtime 后就编译不过了”

所以到这里，开发者应该明白 Substrate 的 Runtime WASM 是要受到条件制约的，因为对于链而言，并不是什么东西都可以放在 Runtime 环境中的，例如在之前的文章中提到，**由于共识的限制，需要每个节点执行相同代码得到相同的结果**，因此在 Runtime 中能够执行的应该是“没有副作用”逻辑，如：

1. 系统调用（操作系统函数）
2. 网络、磁盘访问（因此被限制了 io）
3. **全局单例变量**（由于在执行每个块的每个交易中 wasm 环境都是重新创建的，因此在 Substrate 中都是存到某个存储中，在 finalize 的时候删除）
4. ... 等等其他

因此在 Substrate 的 Runtime 以上的依赖中，需要严格区分 `std` 与 `no_std` ，也就是对应着 native 与 Runtime wasm（后文简称 wasm）。而且这里的 `no_std` 是 Rust 能编译成 wasm 的库中的一个**子集**（当前剔除了一些类型，详情见： `primitives/std/without_std.rs` 中提供的类型）

## Runtime 的依赖

例如当前对于 node 节点项目而言，依赖的简化版本如上。这里列出这个依赖只是想说明如下：

**对于 Runtime 而言，node-runtime 作为整个依赖树末端的叶，以其为根基往上的所有依赖都要满足上一节提到的“条件”，直到依赖的根**

因此只要编写了会进入 `node-runtime` 依赖树的 crate，那么即便其可能被在非 Runtime 的部分中被引用到，那么其也必须满足这一些条件。否则**如果这个库不满足这条件，那么只能以`optional` 的形式引入，使其只能在 native 下编译，不能在 wasm 下编译**

## 能编译成 WASM 的条件

以下内容若不清楚原理，那么**直接照抄**即可。若希望自己探究原理，请记住在 Substrate Runtime 设计中，区分 WASM 和 Native 编译过程中引入什么库是通过**“条件编译”**控制的。今后写 Substrate 进阶或深入文章的时候笔者再来自己剖析其中原理。

### 1. Runtime 依赖树中的 crate 的 Cargo.toml 的编写

一个能在 Runtime 里面被引用的库，其 `Cargo.toml` 必须按照如下方式编写：

1. 在 `dependencies` 一栏中，一个库的引入要么指定了 `default-features = false` ，要不指定为 `optional = true` 。1. 若指定为 `default-features = false` ，那么进入这个被依赖的包，其 `Cargo.toml` 在 `features` 这一栏中必须指定过 `default = ["std"]` 。（非严禁说法，若不知道为什么，照做，若知道，根据自己需求变更）
   2. 若指定为 `optional = true` ，那么这个被依赖包只可以被 native 编译，不可以被 wasm 编译，在当前包中引用它时，需要加上 `#[cfg(feature = "std")]` 的条件编译
2. 在 `[features]` 一栏中，一定要按照如下方式写
3.  `default = ["std"]` ，将当前的 default feature **指定为`std` ，一定不能少**
4.  `std = ["serde", "codec/std", ... ]` ，在 `dependencies` 中出现过的库名，一定要出现在 `std` feature 对应的**列表**中，其中在 `dependencies` 中（以下两点皆为非严禁说法，若不知道为什么，照做，若知道，根据自己需求变更）：
5. 以 `default-features = false` 出现的，一定要指定为 `xxx/std`
6. 以 `optional = true` 出现的，一定指代为当前包名

需要注意的点：

**由于 cargo.toml 对编写出错没有显著提示**，因此若出现不明原因错误，检查 cargo.toml 时一定要注意以下几点：

1.  `default-features` 的 `feature` 是带 `s` 的
2. 若填写的 `default-features=false` ，那么在 `std` 指定的列表里必须要留意有没有也添加了 `/std` ，一定不能忘记在 `std` 中也出现对应的包，否则如果遗漏，编译到 wasm 时，可能会有奇怪的错误。
3.  `[dev-dependencies]` 是用于 test 的，因此直接正常引入即可

总体来说一定要保证 `dependencies` 和 `features` 没有编写出错

### 2. Runtime 依赖树中的 crate 项目内容的编写

对于这个 crate 项目，需要注意的有以下几点：

1. lib.rs 文件中的第一行**必须有** `#![cfg_attr(not(feature = "std"), no_std)]`
2. 引入标准库的类型，如 `Vec` , `Result` ， `BTreeMap` 等等，必须通过 `sp-std` 这个库引入。
3. 在 Runtime 的依赖库中，不能出现没有在 `sp-std` 导入的原本 std 拥有的标准库类型及宏，例如 `String` ，宏 `println!` ，若一定要出现，那么需要通过条件编译 `#[cfg(feature = "std")]` 包起来，那么被条件编译包起来的部分，显然在编译 wasm 的时候不会被编译进去，**那么就必须得保证即使 wasm 没有编译这部分逻辑，那么 native 与 wasm 的执行结果也必须保持一致** （例如只有 println 在里面的话，只会产生的在 native 下打印的效果，不会影响执行的结果。但是若是有操作逻辑改变了变量状态在条件编译中，那么是一定要禁止的，否则就会导致节点运行过程中产生不同的结果）

举例：

我们来观察 Substrate 的 frame 提供的包 `frame/assets` ，我们修改 assets 下的内容，然后**在 substrate 根目录下执行`cargo build` 进行编译**

```rust
#![cfg_attr(not(feature = "std"), no_std)]  // 第一行即出现这个条件编译控制语句
// 接下来若编写
// use std::vec::Vec;  // 在wasm下编译不通过
use sp_std::vec::Vec; // 编译通过
// use std::string::String; // 在wasm下编译不通过

decl_module! {
    pub struct Module<T: Trait> for enum Call where origin: T::Origin {
        type Error = Error<T>;
        fn issue(origin, #[compact] total: T::Balance) {
            let origin = ensure_signed(origin)?;
            // println("test"); // wasm下编译不通过
            #[cfg(feature = "std")] {
                println("test"); // 能编译通过，但是在wasm执行中不会打印出来，只有在native执行中才会打印
            }
            //...
        }
    }
}
```

其他情况下例如需要出现能支持 serde 序列化的结构体，这里列举一个例子 `substrate/frame/evm/src/lib.rs:L36` ：

```rust
#[derive(Clone, Eq, PartialEq, Encode, Decode, Default)]
#[cfg_attr(feature = "std", derive(Debug, Serialize, Deserialize))]  // 请注意这里支持serde序列化的部分是在 `std` 条件编译下的
/// External input from the transaction.
pub struct Vicinity {
    /// Current transaction gas price.
    pub gas_price: U256,
    /// Origin of the transaction.
    pub origin: H160,
}
```

对于结构体，尤其需要留意 `Debug` 的 trait，这里在 `#[derive()]` 自动推导的地方，只能使用 `RuntimeDebug` 而不能使用 std 下的 `Debug` ，例如 balances 模块下的例子 `frame/balances/src/lib.rs:L310` ：

```rust
/// Struct to encode the vesting schedule of an individual account.
#[derive(Encode, Decode, Copy, Clone, PartialEq, Eq, RuntimeDebug)]
pub struct VestingSchedule<Balance, BlockNumber> {
    /// Locked amount at genesis.
    pub locked: Balance,
    /// Amount that gets unlocked every block after `starting_block`.
    pub per_block: Balance,
    /// Starting block for unlocking(vesting).
    pub starting_block: BlockNumber,
}
```

### 3. 引入一个第三方库兼容 Runtime wasm 的编译环境

对于以上自己编写 Runtime 引用到的 crate 时，若不明白原理，还可以直接照抄即可。但是要引入第三方库的时候就比较麻烦了，需要比较深入了解后可能才知道怎么引入编译。

由于上文提到的关于 wasm 的标准库的导入问题，因此**可能会出现一个第三方包虽然在自己描述中介绍了支持 Rust wasm 编译，但是不一定支持 Runtime wasm 的编译。**

那么这里先说明一个原则：

**请分清引入这个库的作用，确保这份代码的执行必须在 Runtime 内部，若确定只能在 Runtime 内部，那么只能尝试将其改成能满足前面说的条件的情况，并且其一系列依赖也要满足条件，若不确定只在 Runtime 内部运行，那么只把定义抽离出来，将实现通过`runtime_interface` 导出到 native 执行**

若这个库只需要在 native 下执行（如 serde），那么使用 Optional 引入，只在 std 下编译。

因此若一个第三方库一定要引入 Runtime 的编译依赖中，**请再三思量是否是必须要引入**的，因为这并非一件简单的事情。一方面引入新的库，编译会造成 wasm 文件庞大（因为会引入很多依赖一同编译），一方面将一个库改造成能在 Runtime wasm 下编译需要很多工作量。

因此例如：

1. 若只是需要一些小的工具函数，那么直接拷贝进入 runtime 为妙。
2. 若是**需要一些密码库**，那么请参考 Substrate 实现 ed25519，escda 等密码学函数的方法，抽离定义，将实现通过 `runtime_interface` 放在 native 下实现。这块内容在进阶部分笔者再进行讲解

## 总结

本文简要介绍了 Substrate 的 Runtime wasm 的实现要点，指明 Runtime 的 wasm 实际上是 rust wasm 的一个子集，其使用过程中受到 Runtime WASM 的限制。因此在编写自己的 crate 进入 Runtime 依赖树中时，请按照本文指明的方式进行编写。若采用第三方库引入时，请再三权衡，并根据情况做出判定。**否则可能会在解决如何编译的过程中花费大量时间。**

*本文首发于知乎专栏[《链块与分散的数据》](https://zhuanlan.zhihu.com/c_74315572)，版权属于*[@金晓](https://learnblockchain.cn/people/86)。*如需转载，需取得同意并标明出处，并涵盖版权信息！*

Substrate 入门专题，目前有以下几篇文章：

上一篇文章已经介绍了 Substrate Runtime 的设计概要，结合之前的文章，在此设计的基础上我们必须明白以下几点：

Runtime 是一个隔离的环境，其通过 API 与外界通信，通信时需要加载上指定块高以对应加载的状态
Substrate 的 Runtime 是同一份代码编译出两种执行文件，rust 的 native 与能在 wasm 虚拟机下运行的 wasm，通过启动节点时制定的参与及硬编码进入执行文件中的 Runtime 版本信息觉得执行哪一份文件

因此本篇文章就来具体介绍 Runtime 编译成 wasm 所需要的条件。

本篇只会介绍创建或引入一个包进入 Runtime 的 wasm 体系所需要注意的点，至于其需要这么做的原理暂不在本篇中介绍。

ps: 注意！本文的内容并非十分严格（特别对于第三方库引入部分），因为要做到真正正确得从 rust 的 wasm 编译及 Substrate Runtime 的条件编译入手，本文只属于入门，并非介绍其原理，因此对于初学者而言，若不明白原理，那么现阶段照本文执行即可，在有一定积累后，再深入了解原理并做出改进

Runtime 的 WASM

这里首先就放出结论：

Substrate 的 Runtime 的 WASM 并非标准 WASM，而是是一个有条件限制的 wasm，并非所有代码都可以编译成 Runtime 的 WASM

而这个“有条件”即是本篇文章需要指明的内容。

因此很多使用 Substrate 写 Runtime 部分的程序员，经常遇到的一个问题就是：

“为什么我把一个库引入 Runtime 后就编译不过了”

所以到这里，开发者应该明白 Substrate 的 Runtime WASM 是要受到条件制约的，因为对于链而言，并不是什么东西都可以放在 Runtime 环境中的，例如在之前的文章中提到，由于共识的限制，需要每个节点执行相同代码得到相同的结果，因此在 Runtime 中能够执行的应该是“没有副作用”逻辑，如：

系统调用（操作系统函数）
网络、磁盘访问（因此被限制了 io）
全局单例变量（由于在执行每个块的每个交易中 wasm 环境都是重新创建的，因此在 Substrate 中都是存到某个存储中，在 finalize 的时候删除）
... 等等其他

因此在 Substrate 的 Runtime 以上的依赖中，需要严格区分 std 与 no_std ，也就是对应着 native 与 Runtime wasm（后文简称 wasm）。而且这里的 no_std 是 Rust 能编译成 wasm 的库中的一个子集（当前剔除了一些类型，详情见： primitives/std/without_std.rs 中提供的类型）

Runtime 的依赖

sp-std sp-io | | | frame-support frame-system | / frame-assets frame-balances ... | / node-runtime

例如当前对于 node 节点项目而言，依赖的简化版本如上。这里列出这个依赖只是想说明如下：

对于 Runtime 而言，node-runtime 作为整个依赖树末端的叶，以其为根基往上的所有依赖都要满足上一节提到的“条件”，直到依赖的根

因此只要编写了会进入 node-runtime 依赖树的 crate，那么即便其可能被在非 Runtime 的部分中被引用到，那么其也必须满足这一些条件。否则如果这个库不满足这条件，那么只能以optional 的形式引入，使其只能在 native 下编译，不能在 wasm 下编译

能编译成 WASM 的条件

以下内容若不清楚原理，那么直接照抄即可。若希望自己探究原理，请记住在 Substrate Runtime 设计中，区分 WASM 和 Native 编译过程中引入什么库是通过“条件编译”控制的。今后写 Substrate 进阶或深入文章的时候笔者再来自己剖析其中原理。

1. Runtime 依赖树中的 crate 的 Cargo.toml 的编写

一个能在 Runtime 里面被引用的库，其 Cargo.toml 必须按照如下方式编写：

在 dependencies 一栏中，一个库的引入要么指定了 default-features = false ，要不指定为 optional = true 。1. 若指定为 default-features = false ，那么进入这个被依赖的包，其 Cargo.toml 在 features 这一栏中必须指定过 default = ["std"] 。（非严禁说法，若不知道为什么，照做，若知道，根据自己需求变更）
1. 若指定为 optional = true ，那么这个被依赖包只可以被 native 编译，不可以被 wasm 编译，在当前包中引用它时，需要加上 #[cfg(feature = "std")] 的条件编译
在 [features] 一栏中，一定要按照如下方式写
default = ["std"] ，将当前的 default feature 指定为std ，一定不能少
std = ["serde", "codec/std", ... ] ，在 dependencies 中出现过的库名，一定要出现在 std feature 对应的列表中，其中在 dependencies 中（以下两点皆为非严禁说法，若不知道为什么，照做，若知道，根据自己需求变更）：
以 default-features = false 出现的，一定要指定为 xxx/std
以 optional = true 出现的，一定指代为当前包名

需要注意的点：

由于 cargo.toml 对编写出错没有显著提示，因此若出现不明原因错误，检查 cargo.toml 时一定要注意以下几点：

default-features 的 feature 是带 s 的
若填写的 default-features=false ，那么在 std 指定的列表里必须要留意有没有也添加了 /std ，一定不能忘记在 std 中也出现对应的包，否则如果遗漏，编译到 wasm 时，可能会有奇怪的错误。
[dev-dependencies] 是用于 test 的，因此直接正常引入即可

总体来说一定要保证 dependencies 和 features 没有编写出错

2. Runtime 依赖树中的 crate 项目内容的编写

对于这个 crate 项目，需要注意的有以下几点：

lib.rs 文件中的第一行必须有 #![cfg_attr(not(feature = "std"), no_std)]
引入标准库的类型，如 Vec , Result ， BTreeMap 等等，必须通过 sp-std 这个库引入。
在 Runtime 的依赖库中，不能出现没有在 sp-std 导入的原本 std 拥有的标准库类型及宏，例如 String ，宏 println! ，若一定要出现，那么需要通过条件编译 #[cfg(feature = "std")] 包起来，那么被条件编译包起来的部分，显然在编译 wasm 的时候不会被编译进去，那么就必须得保证即使 wasm 没有编译这部分逻辑，那么 native 与 wasm 的执行结果也必须保持一致 （例如只有 println 在里面的话，只会产生的在 native 下打印的效果，不会影响执行的结果。但是若是有操作逻辑改变了变量状态在条件编译中，那么是一定要禁止的，否则就会导致节点运行过程中产生不同的结果）

举例：

我们来观察 Substrate 的 frame 提供的包 frame/assets ，我们修改 assets 下的内容，然后在 substrate 根目录下执行cargo build 进行编译

#![cfg_attr(not(feature = "std"), no_std)]  // 第一行即出现这个条件编译控制语句
// 接下来若编写
// use std::vec::Vec;  // 在wasm下编译不通过
use sp_std::vec::Vec; // 编译通过
// use std::string::String; // 在wasm下编译不通过

decl_module! {
    pub struct Module&lt;T: Trait> for enum Call where origin: T::Origin {
        type Error = Error&lt;T>;
        fn issue(origin, #[compact] total: T::Balance) {
            let origin = ensure_signed(origin)?;
            // println("test"); // wasm下编译不通过
            #[cfg(feature = "std")] {
                println("test"); // 能编译通过，但是在wasm执行中不会打印出来，只有在native执行中才会打印
            }
            //...
        }
    }
}

其他情况下例如需要出现能支持 serde 序列化的结构体，这里列举一个例子 substrate/frame/evm/src/lib.rs:L36 ：

#[derive(Clone, Eq, PartialEq, Encode, Decode, Default)]
#[cfg_attr(feature = "std", derive(Debug, Serialize, Deserialize))]  // 请注意这里支持serde序列化的部分是在 `std` 条件编译下的
/// External input from the transaction.
pub struct Vicinity {
    /// Current transaction gas price.
    pub gas_price: U256,
    /// Origin of the transaction.
    pub origin: H160,
}

对于结构体，尤其需要留意 Debug 的 trait，这里在 #[derive()] 自动推导的地方，只能使用 RuntimeDebug 而不能使用 std 下的 Debug ，例如 balances 模块下的例子 frame/balances/src/lib.rs:L310 ：

/// Struct to encode the vesting schedule of an individual account.
#[derive(Encode, Decode, Copy, Clone, PartialEq, Eq, RuntimeDebug)]
pub struct VestingSchedule&lt;Balance, BlockNumber> {
    /// Locked amount at genesis.
    pub locked: Balance,
    /// Amount that gets unlocked every block after `starting_block`.
    pub per_block: Balance,
    /// Starting block for unlocking(vesting).
    pub starting_block: BlockNumber,
}

3. 引入一个第三方库兼容 Runtime wasm 的编译环境

由于上文提到的关于 wasm 的标准库的导入问题，因此可能会出现一个第三方包虽然在自己描述中介绍了支持 Rust wasm 编译，但是不一定支持 Runtime wasm 的编译。

那么这里先说明一个原则：

请分清引入这个库的作用，确保这份代码的执行必须在 Runtime 内部，若确定只能在 Runtime 内部，那么只能尝试将其改成能满足前面说的条件的情况，并且其一系列依赖也要满足条件，若不确定只在 Runtime 内部运行，那么只把定义抽离出来，将实现通过runtime_interface 导出到 native 执行

若这个库只需要在 native 下执行（如 serde），那么使用 Optional 引入，只在 std 下编译。

因此若一个第三方库一定要引入 Runtime 的编译依赖中，请再三思量是否是必须要引入的，因为这并非一件简单的事情。一方面引入新的库，编译会造成 wasm 文件庞大（因为会引入很多依赖一同编译），一方面将一个库改造成能在 Runtime wasm 下编译需要很多工作量。

因此例如：

若只是需要一些小的工具函数，那么直接拷贝进入 runtime 为妙。
若是需要一些密码库，那么请参考 Substrate 实现 ed25519，escda 等密码学函数的方法，抽离定义，将实现通过 runtime_interface 放在 native 下实现。这块内容在进阶部分笔者再进行讲解

总结

本文简要介绍了 Substrate 的 Runtime wasm 的实现要点，指明 Runtime 的 wasm 实际上是 rust wasm 的一个子集，其使用过程中受到 Runtime WASM 的限制。因此在编写自己的 crate 进入 Runtime 依赖树中时，请按照本文指明的方式进行编写。若采用第三方库引入时，请再三权衡，并根据情况做出判定。否则可能会在解决如何编译的过程中花费大量时间。

本文首发于知乎专栏《链块与分散的数据》，版权属于@金晓。如需转载，需取得同意并标明出处，并涵盖版权信息！

学分: 13
分类: Polkadot
标签:

本文参与登链社区写作激励计划，好文好收益，欢迎正在阅读的你也加入。