Emscripten项目中处理__FILE__宏的确定性构建问题

概述

在Emscripten项目中，C++的__FILE__宏会展开为文件路径，但展开结果可能是相对路径或绝对路径，这取决于编译器的输入参数。这一特性在代码大小测试中引发了构建结果不一致的问题，特别是在持续集成(CI)环境中。

问题背景

__FILE__宏的行为差异源于不同的构建方式：

1. 相对路径构建：当使用clang++ ../../test.cpp这样的命令时，__FILE__会展开为相对路径../../test.cpp
2. 绝对路径构建：当使用clang++ ~/test.cpp这样的命令时，__FILE__会展开为绝对路径/whatever/absolute/path/test.cpp

在Emscripten的system_lib.py中，构建方式的选择取决于：

• 是否使用Ninja构建系统
• 是否启用批量输入(batch_inputs)
• 是否设置deterministic_paths参数

影响范围

这个问题特别影响了Emscripten的代码大小测试，因为：

1. 不同CI测试使用不同的构建方式
2. LLVM 19的libc++abi增加了__FILE__的使用
3. 多个库中都使用了__FILE__宏，包括：
   • 编译器运行时库
   • C标准库(musl)
   • C++标准库
   • 内存分配器(mimalloc)
   • 文件系统支持

解决方案探讨

项目成员讨论了多种解决方案：

1. 编译时定义空字符串：在发布模式下通过-D__FILE__=""将宏定义为空字符串

   • 优点：简单直接
   • 缺点：不能从根本上解决问题

2. CI环境特殊处理：当检测到CI环境时定义空字符串

   • 优点：针对性强
   • 缺点：本地重新基准测试时需要模拟CI环境

3. 统一路径处理：改进deterministic_paths机制，使其在所有构建方式下都产生相同结果

   • 使用-ffile-prefix-map和-fmacro-prefix-map标志
   • 确保相对路径和绝对路径映射到相同的虚拟路径

4. 禁用批量构建：完全移除或设为可选功能

   • 优点：简化构建逻辑
   • 缺点：可能影响构建性能

技术实现细节

深入分析后，最佳实践应该是：

1. 统一使用绝对路径：无论是否批量构建，都使用绝对路径
2. 路径映射标准化：通过编译器标志将路径映射到虚拟路径
3. 调试信息处理：允许开发者在需要调试时配置路径映射规则

结论

Emscripten项目最终选择了改进路径映射机制的方案，通过编译器标志确保__FILE__宏在所有构建方式下展开一致。这种方法既保持了构建的确定性，又不影响开发者的调试体验，是平衡各种需求的合理选择。

对于开发者而言，理解这一机制有助于更好地处理跨平台构建和测试中的一致性问题，特别是在涉及代码大小优化的场景中。