Wacro

Wacro（WebAssembly Macros）是使用 WebAssembly 构建 Swift 宏提案的一个概念验证实现，该提案已提交给 GSoC 2024（提案链接）。

截至目前，Wacro 已经允许库作者使用 WebAssembly 构建宏，并且用户可以像使用其他 Swift 库一样使用它们：请参阅试用部分了解详情。 但是，目前存在一些性能缺陷，这些缺陷可以通过在编译器/SwiftPM 中实现来解决。

Wacro 不是 GSoC 提交项目：它的存在仅仅是为了表明这是可能的（甚至无需修改编译器或 SwiftPM！），因为 GSoC 提案进展缓慢。一个实际的实现应该集成到编译器和 SwiftPM 中，以提高可用性和性能。

🐇 目前的 Swift 宏在编译时速度非常慢。 这是因为大多数宏依赖于源代码形式的 swift-syntax（Swift 的语法解析库），而它是一个非常大的库，需要很长时间才能构建。

• swift-syntax 不是 API/ABI 稳定的，这意味着无法通过为构建主机预编译来解决这个问题。
• 除了 Darwin 之外，Swift 本身在任何平台上都不是 ABI 稳定的。 因此，即使 swift-syntax 具有稳定的 ABI（目前看来不太可能），它也只能解决 macOS 上的构建时间问题。
• ✅ 通过将宏作为 WebAssembly 二进制文件发布，可以将二进制文件构建为静态链接已编译的 swift-syntax 版本。 由于 WebAssembly 与主机平台无关，因此宏作者可以发布一个预编译的二进制文件，该二进制文件可以在任何主机上运行！

🤝 SwiftPM 当前只允许链接到软件包的单个版本。 因此，如果两个宏依赖于冲突的 swift-syntax 版本，SwiftPM 将拒绝构建。

• ✅ 借助 WebAssembly 的“共享无”模型，基于 WebAssembly 的宏可以链接到完全不同的 swift-syntax 版本，并且可以被客户端使用而不会发生冲突。

🔐 Swift 宏旨在“纯粹”，并且不能访问系统资源。 目前，这在 macOS 上通过系统沙箱实现。 但是，据我所知，宏在 Linux 上没有被沙盒化； 虽然可以使用 命名空间 在某种程度上弥补这一点，但这可能需要相当大的努力，而且命名空间被广泛认为不是安全边界。

• ✅ 同时，WebAssembly 默认情况下完全沙盒化，并且可以使用强大的基于能力的模型来提供对额外资源的访问。

Wacro 将宏分解为两个阶段

1. 原始宏：宏作者将宏源代码构建成 WASM 二进制文件，称为原始宏。 这就像一个常规宏，但 1）它是一个 .executableTarget 而不是 .macro，并且 2）它依赖于 WacroPluginRaw 而不是 SwiftCompilerPlugin。 该二进制文件被检入源代码控制（理想情况下，可以指向远程资源，但这可能需要 SwiftPM 的支持。）
2. 宿主宏：这是客户端使用的“真正”宏。 这是一个简单的 .macro 目标，其中宏实现了 WacroPluginHost。 此一致性的唯一要求是 providingLibrary: URL，它指向原始宏的文件路径。

当宿主宏被调用时，WacroPluginHost 启动一个 WebAssembly “运行器”，该运行器与原始宏通信以执行实际工作。

借助 Swift 6.0，对 WASM 和 WASI 的支持现在已经上游化。 这意味着给定 WASI SDK，一个普通的 Swift 6.0 工具链可以开箱即用地构建 WASI 二进制文件。

Wacro 目前提供两种执行 WebAssembly 二进制文件的方法

1. WebKit：这种方法依赖于 WKWebView 的 WebAssembly 支持来及时评估宏。

• 缺点：仅适用于 macOS
• 缺点：构建主机时需要 --disable-sandbox，因为 WKWebView 使用 XPC。
• 优点：性能相当好（请参阅性能部分）。
• 优点：不需要额外的依赖项，因为我们使用 macOS 附带的 WebKit 库。

2. WasmKit：这种方法使用第三方 WasmKit 库来解释 WebAssembly 宏。

• 缺点：代码是被解释执行的，而不是及时编译的，因此这种方法比使用 WebKit 具有更大的恒定开销。
• 缺点：将 WasmKit 作为依赖项添加到您的库中，以及它的传递依赖项。 这些仅在编译时使用，但会增加一些开销，即获取和编译额外的模块。 但是，此开销远小于 swift-syntax 的开销。
• 优点：应该可以在 SwiftPM 支持的任何平台上工作。
• 优点：不需要禁用沙箱或传递任何其他标志。

WasmKit 目前是默认的运行器，因为它是跨平台的并且可以在沙箱中运行。 切换到 WebKit 的说明在以下部分中。

理想的运行器可能是这两者的混合。 在 macOS 上，将 WebKit 运行器移动到 Swift Driver 中将允许它在不禁用宏沙箱的情况下使用。 同时，WasmKit 可以在系统不提供 WebKit 的其他平台上使用。

请参阅 WacroExample 存储库。 您可以克隆它并运行 ExampleClient，或者在任何项目中使用 ExampleLibrary 作为依赖项！ 请注意，现在可能会出现一些意想不到的性能问题，但如果它进入 Swift 编译器，这些问题将得到补救。 有关详细信息，请参阅以下部分

注意：本节是关于构建时间性能的。 运行时性能将与典型的宏相同。 WebAssembly 执行过程仅在构建时进行。

• 这些测试是在配备 48 GB 统一内存的 16 英寸 M3 Max MacBook Pro 上进行的，运行 macOS 14.1
• 使用 make clean 开始干净的构建。 wasm 二进制文件本身被保留下来，因为我们关注的是客户端而不是宏作者的性能。
• 然后使用 time make client [RELEASE=1] [WK=1] 执行 WasmKit/WebKit 构建。
• 通过修改 WacroExample/Package.swift 以将 ExampleClient 直接链接到 ExampleRaw 来执行 SwiftSyntax 构建。

所有值均以秒为单位。

是的，你没看错。 基于 WasmKit 的宏在发布模式下构建更快，因为 WasmKit 本身是用优化编译的，因此可以更快地解释 wasm 宏。 理想情况下，与 SwiftPM 的更深入集成将确保 WasmKit 本身始终在发布模式下构建。