Rust基准测试与宏的使用

### Rust 基准测试与宏的使用 #### 1. I/O 开销测量 在编写基准测试时，很容易意外地测量到错误的内容。例如，为了实时了解基准测试的进度，我们可能会编写如下代码来测量 `my_function` 的运行速度： ```rust let start = std::time::Instant::now(); for i in 0..1_000_000 { println!("iteration {}", i); my_function(); } println!("took {:?}", start.elapsed()); ``` 这段代码看似能达成目标，但实际上它并没有真正测量 `my_function` 的运行速度，而是大概率测量了打印一百万次数字所花费的时间。`println!` 宏在幕后做了很多工作，包括将二进制整数转换为十进制数字、锁定标准输出、使用至少一个系统调用写入 UTF - 8 代码点序列，然后释放标准输出锁。而且，如果终端打印输入内容的速度较慢，系统调用可能会阻塞。相比之下，调用 `my_function` 所花费的时间可能就微不足道了。 同样的问题也会出现在基准测试使用随机数的情况中。如果在循环中运行 `my_function(rand::random())`，很可能大部分时间都花在了生成一百万个随机数上。获取当前时间、读取配置文件或启动新线程等操作也是如此，这些操作相对来说都比较耗时，可能会掩盖你实际想要测量的时间。 幸运的是，一旦意识到这个问题，通常很容易解决。要确保基准测试循环体中几乎只包含你想要测量的特定代码。其他所有代码要么在基准测试开始前运行，要么在基准测试的测量部分之外运行。如果你使用的是 `criterion`，可以查看它提供的不同计时循环，它们都是为满足不同测量策略的基准测试用例而设计的。 #### 2. 宏的基础概念 宏本质上是一种让编译器为你编写代码的工具。你给编译器一个根据输入参数生成代码的公式，编译器会将宏的每次调用替换为运行该公式的结果。可以把宏看作是自动代码替换，你可以定义替换规则。 Rust 的宏有多种不同的形式和用途，主要分为声明式宏和过程式宏。与基于 C 语言的宏不同，Rust 的宏遵循（大部分）定义明确的规则，并且相对不容易被滥用。 #### 3. 声明式宏 声明式宏使用 `macro_rules!` 语法定义，它可以让你方便地定义类似函数的宏，而无需像过程式宏那样编写专门的 crate。定义好声明式宏后，可以通过宏名后跟感叹号来调用它。可以将这种宏看作是一种编译器辅助的搜索和替换工具，它适用于许多常规、结构良好的代码转换任务，以及消除重复的样板代码。 不过，并非所有类似函数的宏都是声明式宏，例如 `macro_rules!` 本身和 `format_args!` 就不是。感叹号后缀只是向编译器表明该宏调用在编译时将被替换为不同的源代码。 需要注意的是，由于 Rust 的解析器专门识别和解析带有 `!` 注释的宏调用，因此只能在解析器允许的地方使用它们。它们在大多数预期的位置都能正常工作，如表达式位置或 `impl` 块中，但并非在所有地方都能使用。例如，在编写本文时，不能在需要标识符或匹配分支的地方调用类似函数的宏。 ##### 3.1 何时使用声明式宏 声明式宏主要适用于你发现自己反复编写相同代码的情况，你可以使用宏来避免这种重复。它们最适合进行较为机械的替换，如果要进行复杂的代码转换或大量的代码生成，过程式宏可能是更好的选择。 在测试和 trait 实现中，声明式宏非常有用。例如在测试中，我们可能需要多次运行相同的测试，但配置略有不同。原本的代码可能像这样： ```rust fn test_inner<T>(init: T, frobnify: bool) { ... } #[test] fn test_1u8_frobnified() { test_inner(1u8, true); } // ... #[test] fn test_1i128_not_frobnified() { test_inner(1i128, false); } ``` 这种方式过于冗长、重复，而且容易出现人为错误。使用宏可以改进代码，如下所示： ```rust macro_rules! test_battery { ($($t:ty as $name:ident),*) => { $( mod $name { #[test] fn frobnified() { test_inner::<$t>(1, true) } #[test] fn unfrobnified() { test_inner::<$t>(1, false) } } )* } } test_battery! { u8 as u8_tests, // ... i128 as i128_tests }; ``` 这个宏将每个用逗号分隔的指令扩展为一个单独的模块，每个模块包含两个测试，一个使用 `true` 调用 `test_inner`，另一个使用 `false` 调用。虽然宏的定义并不简单，但它使添加更多测试变得容易。每种类型在 `test_battery!` 调用中只需一行，宏会负责为 `true` 和 `false` 参数生成测试。我们还可以让它为 `init` 的不同值生成测试，这样大大降低了忘记测试特定配置的可能性。 在 trait 实现方面，情况类似。如果你定义了自己的 trait，通常希望为标准库中的许多类型实现该 trait，即使这些实现很简单。例如，假设你发明了 `Clone` trait，并想为标准库中的所有 `Copy` 类型实现它。可以使用如下宏： ```rust macro_rules! clone_from_copy { ($($t:ty),*) => { $(impl Clone for $t { fn clone(&self) -> Self { *self } })* } } clone_from_copy![bool, f32, f64, u8, i8, /* ... */]; ``` 这里为每个提供的类型生成 `Clone` trait 的实现，其主体只是使用 `*` 从 `&self` 中复制。你可能会想为什么不添加一个泛型实现 `impl<T: Copy> Clone for T`，原因是这样会强制其他 crate 中的类型也使用相同的 `Clone` 实现。虽然有一个名为 `specialization` 的实验性编译器特性可以提供解决方法，但在编写本文时，该特性的稳定化还需要一段时间。因此，目前最好还是具体列举这些类型。这种模式不仅适用于简单的转发实现，例如，你可以轻松修改上述代码，为所有整数类型实现 `AddOne