深入解析Google Sanitizers项目中MSan构建OpenJDK的符号问题

背景介绍

在软件开发过程中，内存错误是最常见也最难调试的问题之一。Google Sanitizers项目提供了一系列强大的动态分析工具，其中MemorySanitizer（MSan）专门用于检测未初始化的内存访问问题。本文将详细分析在使用MSan构建OpenJDK时遇到的一个典型问题——__msan_va_arg_overflow_size_tls符号未定义问题。

问题现象

开发者在尝试使用MSan构建OpenJDK时，遇到了以下错误信息：

/home/yansendao/git/jdk-asan-clang/build/linux-x86_64-server-release/jdk/bin/javac: symbol lookup error: /home/yansendao/git/jdk-asan-clang/build/linux-x86_64-server-release/jdk/bin/../lib/libjli.so: undefined symbol: __msan_va_arg_overflow_size_tls

这个错误表明，在运行时动态链接器无法找到__msan_va_arg_overflow_size_tls这个符号，导致程序无法正常执行。

技术分析

1. MSan的工作原理

MemorySanitizer是一种检测未初始化内存读取的工具，它通过在编译时插入额外的检查代码来工作。当启用MSan时，编译器会为程序添加大量的运行时检查逻辑，这些逻辑需要访问MSan运行时库提供的各种功能。

2. TLS符号的特殊性

__msan_va_arg_overflow_size_tls是一个线程局部存储(TLS)变量，它属于MSan运行时系统的一部分。这类符号通常需要由主可执行文件提供，然后被动态库引用。这与常规的符号解析机制有所不同。

3. 链接器选项的影响

在OpenJDK的构建系统中，默认使用了-Wl,--exclude-libs,ALL链接器选项。这个选项的作用是防止静态库中的符号被导出到动态符号表中。虽然这个选项在正常情况下可以减小二进制体积并提高安全性，但它会阻止MSan运行时符号的导出，从而导致动态库无法访问这些关键符号。

解决方案

1. 修改构建配置

最直接的解决方案是修改OpenJDK的构建配置，在启用MSan时移除-Wl,--exclude-libs,ALL选项。这可以通过修改make/autoconf/flags-ldflags.m4文件实现：

if test "x$OPENJDK_TARGET_OS" = xlinux; then
  # 移除--exclude-libs选项
  BASIC_LDFLAGS="-fuse-ld=lld"
  if test "x$CXX_IS_USER_SUPPLIED" = xfalse && test "x$CC_IS_USER_SUPPLIED" = xfalse; then
    UTIL_REQUIRE_PROGS(LLD, lld, $TOOLCHAIN_PATH:$PATH)
  fi

2. 替代方案

如果必须保留--exclude-libs选项，可以考虑以下替代方案：

1. 显式导出MSan符号：使用-Wl,--export-dynamic-symbol=__msan_va_arg_overflow_size_tls选项
2. 强制解析符号：添加-Wl,--undefined=__msan_va_arg_overflow_size_tls链接选项

不过，这些方法可能不如直接移除--exclude-libs选项来得简单可靠。

深入理解

1. 动态链接与符号解析

在Linux系统中，动态链接器负责在程序运行时解析符号引用。当动态库需要引用一个符号时，链接器会按照以下顺序查找：

1. 动态库自身的符号表
2. 主可执行文件的符号表
3. 其他已加载库的符号表

--exclude-libs选项影响了第二步，使得主可执行文件中的某些符号（包括MSan运行时符号）无法被动态库访问。

2. MSan的实现机制

MSan通过在编译时插入额外的代码来跟踪内存的初始化状态。这些插入的代码需要访问MSan运行时提供的各种功能，包括：

• 内存状态跟踪
• 错误报告
• TLS变量管理

__msan_va_arg_overflow_size_tls就是用于处理可变参数函数中参数大小检查的线程局部变量。

实践建议

1. 构建环境配置：确保使用足够新的LLVM/Clang版本（建议17.0.2或更高）
2. 构建参数：正确设置sanitizer标志，包括-fsanitize=memory和相关选项
3. 错误处理：准备好处理MSan可能报告的其他构建时错误，特别是与未初始化内存相关的问题
4. 测试验证：构建完成后，使用简单的Java程序验证MSan是否正常工作

总结

在使用MemorySanitizer构建大型复杂项目如OpenJDK时，理解sanitizer运行时与构建系统的交互至关重要。__msan_va_arg_overflow_size_tls未定义问题揭示了链接器选项对sanitizer工作的影响。通过合理调整构建配置，开发者可以成功地将MSan集成到OpenJDK的构建过程中，从而获得强大的内存错误检测能力。

对于希望使用类似技术构建其他大型项目的开发者，本文的分析和解决方案也提供了有价值的参考。记住，在使用高级调试工具时，理解工具的工作原理和与构建系统的交互方式，是解决问题的关键。