emsdk项目中关于saveSetjmp符号未定义问题的分析与解决

问题背景

在使用emsdk 3.1.72版本进行WebAssembly项目编译时，部分用户在持续集成环境（如GitHub Actions）中遇到了两个未定义符号的错误：

error: undefined symbol: saveSetjmp
error: undefined symbol: testSetjmp

这些错误在本地开发环境中并未出现，仅在CI环境中发生。错误提示建议可以通过设置-sERROR_ON_UNDEFINED_SYMBOLS=0来忽略未定义符号的错误，或者将相关符号添加到EXPORTED_FUNCTIONS中。

技术分析

符号来源

saveSetjmp和testSetjmp这两个符号实际上是LLVM编译器生成的内部符号。在LLVM项目的更新中（具体是在2024年3月的一个PR中），这些符号被重命名或移除。现代版本的LLVM不再生成这些符号。

问题根源

出现这种不一致现象的根本原因在于：

1. 版本不匹配：项目中可能存在使用不同版本LLVM编译的对象文件或库文件。某些文件可能是用旧版LLVM编译的，而链接时使用的是新版LLVM。

2. 构建缓存问题：特别是在CI环境中，如果没有正确清理构建缓存，可能会导致旧版本编译的中间产物被重复使用。

解决方案

1. 清理构建缓存

这是最直接有效的解决方案。在CI环境中，确保每次构建前都清理所有中间文件和缓存：

rm -rf build/*
# 或者
cmake --build . --target clean

2. 诊断问题来源

如果需要进一步诊断问题，可以使用以下链接器选项来追踪符号来源：

-Wl,--trace-symbol=saveSetjmp

这个选项会告诉链接器显示saveSetjmp符号的引用来源，帮助定位问题文件。

3. 完整重新构建

确保所有依赖项都使用相同版本的emsdk和LLVM重新构建。特别是对于第三方库，需要检查它们是否与当前使用的emsdk版本兼容。

预防措施

1. 版本一致性：确保开发环境和CI环境使用完全相同的工具链版本。

2. 缓存策略：在CI配置中，合理设置缓存策略，确保在工具链更新时自动失效旧缓存。

3. 依赖管理：对于第三方库，明确指定兼容的emsdk版本范围。

总结

这个问题的出现凸显了WebAssembly工具链快速演进过程中可能遇到的兼容性问题。开发者在使用emsdk等工具链时，应当注意：

• 保持开发环境和CI环境的一致性
• 定期清理构建缓存
• 关注工具链更新日志中的重大变更
• 对构建系统进行合理配置，确保完全重新构建的能力

通过理解这些底层机制，开发者可以更好地应对类似问题，提高WebAssembly项目的构建可靠性。