C++怎么在崩溃日志中打印出当前代码的Git分支和版本信息

大涛大大_6161

大涛大大_6161

2026-10-06

858人浏览

原创

应在编译时将 git 分支与版本固化为带 __attribute__((used)) 的 c++ 全局字符串常量,崩溃信号处理器中用 write() 安全输出,避免运行时调用 git 命令。

c++怎么在崩溃日志中打印出当前代码的git分支和版本信息

崩溃时如何获取编译时嵌入的 Git 分支与版本

直接在崩溃日志里打印 Git 信息,不能靠运行时调用 git 命令——进程已崩溃,shell 调用不可靠,且可能被沙箱/容器限制。正确做法是:在编译阶段把 Git 状态固化为 C++ 字符串常量,链接进二进制。崩溃堆栈捕获逻辑(如 signal handler)直接读取这些只读全局变量即可输出。

__attribute__((used)) 防止链接器丢弃 Git 全局变量

用 git describe --always --dirty 和 git rev-parse --abbrev-ref HEAD 生成字符串,写入头文件或 .cpp 文件后,必须加 __attribute__((used))(GCC/Clang)或 __declspec(selectany)(MSVC),否则 LTO 或 strip 会把未显式引用的全局变量优化掉——崩溃日志里就只剩空字符串。

示例(CMake 中生成):

# 在 CMakeLists.txt 中
execute_process(COMMAND git describe --always --dirty RESULT_VARIABLE GIT_DESCRIBE_RESULT OUTPUT_VARIABLE GIT_DESCRIBE)
if(GIT_DESCRIBE_RESULT EQUAL 0)
  string(STRIP "${GIT_DESCRIBE}" GIT_DESCRIBE)
else()
  set(GIT_DESCRIBE "unknown")
endif()
<p>execute_process(COMMAND git rev-parse --abbrev-ref HEAD RESULT_VARIABLE GIT_BRANCH_RESULT OUTPUT_VARIABLE GIT_BRANCH)
if(GIT_BRANCH_RESULT EQUAL 0)
string(STRIP "${GIT_BRANCH}" GIT_BRANCH)
else()
set(GIT_BRANCH "unknown")
endif()</p><p>configure_file("${CMAKE_SOURCE_DIR}/build_info.h.in" "${CMAKE_BINARY_DIR}/build_info.h")</p>

对应 build_info.h.in:

#pragma once
extern const char kGitBranch[] __attribute__((used));
extern const char kGitDescribe[] __attribute__((used));

再在 .cpp 中定义:

GitHub Repo Guide PDF
GitHub Repo Guide PDF

分析 GitHub 仓库 URL 或 OWNER/REPO,生成中文用户指南,聚焦于项目的使用方法而非实现细节,构建 Markdown 文档。

下载
#include "build_info.h"
const char kGitBranch[] __attribute__((used)) = "@GIT_BRANCH@";
const char kGitDescribe[] __attribute__((used)) = "@GIT_DESCRIBE@";

signal handler 中安全打印 Git 信息的限制

Linux/macOS 的 signal(SIGSEGV, ...) handler 是异步信号安全上下文,只能调用 async-signal-safe 函数(write() 可以,printf()/std::cout 不行)。所以崩溃日志中输出 Git 信息必须用 write(STDERR_FILENO, ...) 直接写原始字节。

关键点:

  • kGitBranch 和 kGitDescribe 必须是全局、静态存储期、字面量初始化的字符串(不能是 std::string)
  • 不要在 handler 里做任何内存分配、锁操作、虚函数调用
  • 建议把 Git 信息拼接到预分配的固定大小 buffer 中(如 char buf[512]),再用 write() 一次性输出

CMake + Git hook 避免本地修改导致版本信息失效

仅靠 CMake configure 阶段执行 git 命令,容易漏掉后续工作区修改(比如改了代码但没 git add)。更健壮的做法:

  • 在 pre-build 步骤重新生成 build_info.h,确保每次构建都反映最新状态
  • 添加 .git/hooks/pre-commit 检查是否误提交了硬编码的 “unknown” 字符串
  • CI 构建时设置 CI=true 环境变量,强制走 clean checkout + git fetch --tags,避免 shallow clone 导致 git describe 失败

如果项目用了 git worktree 或 submodule,git rev-parse --abbrev-ref HEAD 可能返回 HEAD 而非分支名——此时应 fallback 到 git symbolic-ref --short HEAD 2>/dev/null || echo "detached"。

Git 信息不是万能的,它只告诉你“编译那一刻”的状态;若想定位到具体哪次 CI 构建、哪个流水线任务,还得配合构建编号和时间戳一起写入。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

全能打印神器
全能打印神器

全能打印神器是一款非常好用的打印软件,可以在电脑、手机、平板电脑等设备上使用。支持无线打印和云打印,操作非常简单,使用起来也非常方便,有需要的小伙伴快来保存下载体验吧!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.14

2208

9

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

999

6

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

407

5

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

307

5

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

386

5

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

580

5

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.21

1389

9

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

2024.03.22

1197

7

c++和c语言学习顺序推荐
c++和c语言学习顺序推荐

对于初学者,建议先学习C语言,掌握编程基础后再转入C++,便于理解面向对象编程概念。有编程经验者可直接学习C++,快速接触高级编程技术。想了解更多c++和c语言的相关内容,可以阅读本专题下面的文章。

2024.03.25

1325

9

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.9万人学习