Shaderc C API 编译问题解析：解决 INTCONSTANT 错误

在使用 Shaderc 的 C API 进行 GLSL 着色器编译时，开发者可能会遇到一个奇怪的错误："syntax error, unexpected INTCONSTANT"。这个问题在使用命令行工具 glslc 时不会出现，但在使用 C API 时却会发生。本文将深入分析这个问题的原因，并提供解决方案。

问题现象

开发者在使用 Shaderc C API 编译包含 include 指令的 GLSL 着色器时，遇到了以下错误：

Result code 2
error: TV:1: error: '' :  syntax error, unexpected INTCONSTANT

值得注意的是，错误信息中的 "TV" 部分在每次运行时都会变化。而同样的着色器代码使用 glslc 命令行工具却能成功编译。

问题分析

经过深入调查，发现问题出在 include 回调函数的实现上。在原始代码中，include 回调函数 resolve_include 返回了局部变量的指针：

shaderc_include_result* resolve_include(void* user_data,
  const char* requested_source, int type,
  const char* requesting_source, size_t include_depth)
{
  const char source_name[] = "add.frag";  // 局部变量
  const char content[] = "float add(...)"; // 局部变量
  
  shaderc_include_result* result = new shaderc_include_result;
  result->source_name = source_name;      // 存储局部变量地址
  result->content = content;             // 存储局部变量地址
  
  return result;
}

这里的关键问题是：source_name 和 content 是函数内的局部变量，当函数返回后，这些变量的内存会被释放。然而，Shaderc 会在后续处理中继续使用这些指针，导致访问了无效的内存，从而产生随机错误。

解决方案

正确的做法是确保返回的字符串指针在编译过程中保持有效。有以下几种解决方案：

1. 使用静态存储：将字符串声明为静态变量

shaderc_include_result* resolve_include(...) {
  static const char source_name[] = "add.frag";
  static const char content[] = "float add(...)";
  // ...
}

2. 动态分配内存：在堆上分配字符串

shaderc_include_result* resolve_include(...) {
  char* source_name = strdup("add.frag");
  char* content = strdup("float add(...)");
  // ...
}

3. 使用用户数据：通过 user_data 传递持久化存储

最佳实践

在实现 Shaderc 的 include 回调时，应遵循以下原则：

1. 确保返回的所有字符串指针在编译完成前保持有效
2. 在 release_include 回调中释放所有分配的资源
3. 考虑使用 RAII 模式管理资源生命周期
4. 对于复杂项目，可以考虑使用内存池管理字符串资源

总结

这个问题的根本原因是 C/C++ 中常见的"悬挂指针"问题。在 Shaderc 的 include 机制中，回调函数返回的字符串需要在编译过程中保持有效，而局部变量显然不能满足这一要求。通过将字符串存储在静态区或堆内存中，可以确保指针的有效性，从而解决编译错误。

理解这一点不仅对 Shaderc 的使用很重要，也是所有涉及回调函数和资源生命周期的编程场景中需要特别注意的关键点。