怎么在C++二进制文件中注入git信息详解

下面是在C++二进制文件中注入git信息的完整攻略。

介绍

在C++开发中，我们经常需要借助版本控制工具Git来管理我们的项目代码，并且会在代码的开头注释中增加一些Git信息，如版本号、提交时间等。但是，这些Git信息只存在于代码中，如果我们需要将代码编译成二进制文件，如可执行文件或库文件，那么这些Git信息就无法被保留下来了。本教程将介绍如何在C++二进制文件中注入Git信息，方便以后查看二进制文件的版本信息。

步骤

以下是注入Git信息的完整步骤：

1. 确认Git信息

在开始注入Git信息之前，我们需要先确认源代码中的Git信息，包括版本号、提交时间等。这些信息通常被注释在源代码文件的开头，例如：

/*
 * @file: main.cpp
 * @brief: This is the main function
 * @version: 1.0.0
 * @git_info:
 *      commit: abc123
 *      date: 2021-01-01
 */

需要注意的是，这里我们注释了一个git_info的标识字段，后面将会用到。

2. 设置Git Hook

接下来我们需要设置Git的Hooks来在每次提交代码时自动更新Git信息。在项目的根目录下创建一个名为pre-commit的文件，并写入以下脚本：

#!/bin/sh
#
# Pre-commit hook to update git_info
#

# Get current commit hash
hash=$(git rev-parse HEAD)

# Get current commit time
commit_time=$(git log -1 --format=%cd --date=iso)

# Get current branch name
current_branch=$(git branch --show-current)

# Replace git_info in main.cpp with current information
sed -i.bak "s/.*@git_info.*/\/\/ @git_info: commit: $hash, date: $commit_time, branch: $current_branch/" main.cpp

# Remove backup file
rm main.cpp.bak

该脚本会在每次提交代码之前自动更新main.cpp文件中的git_info字段，将其替换为当前的提交信息。需要注意的是，这里我们假设main.cpp文件即为我们的代码文件，实际项目中需要根据自己的情况来进行修改。

3. 构建Binary File

在开发过程中，使用常规的编译命令来生成二进制文件即可，例如：

g++ main.cpp -o myapp

4. 注入Git信息

最后一步就是将Git信息注入到二进制文件中。我们可以借助GNU binutils工具集中的一个叫做objcopy的工具来完成注入，具体操作如下：

4.1 导出Object File

首先，我们需要将编译生成的Binary File导出为Object File，例如：

objcopy -I binary -O elf64-x86-64 -B i386 myapp myapp.o

这里的myapp即为需要注入Git信息的Binary File。

4.2 注入Git信息

接下来，我们可以在Object File中添加一个新的section，将Git信息保存在其中。例如：

objcopy --add-section ".git_info=$(git rev-parse HEAD) $(git log -1 --format=%cd --date=iso) $(git branch --show-current)" myapp.o myapp.o

注意这里的section名字必须以.开头，根据个人习惯可以以git_info或其他类似的名称为section名。

4.3 导出Binary File

注入完成之后，我们需要将Object File导出为Binary File。例如：

objcopy -O binary myapp.o myapp

5. 验证Git信息

最后，我们可以通过以下命令来验证Git信息是否已经注入到Binary File中：

strings myapp | grep git_info

如果输出信息中可以看到我们添加的Git信息，那么就说明注入成功了。

示例

以下是两个示例，分别展示了在MacOS和Linux平台上如何注入Git信息。

示例1: MacOS

在MacOS上，我们可以直接使用binutils工具集中的objcopy命令来注入Git信息。以下是注入Git信息的完整命令：

#!/bin/bash

# Get current commit hash
hash=$(git rev-parse HEAD)

# Get current commit time
commit_time=$(git log -1 --format=%cd --date=iso)

# Get current branch name
current_branch=$(git branch --show-current)

# Compile main.cpp to executable 'myapp'
g++ main.cpp -o myapp

# Convert 'myapp' binary to object file 'myapp.o'
objcopy -I binary -O mach-o-x86-64 myapp myapp.o

# Add new section to 'myapp.o', containing git info
objcopy --add-section .git_info=$(echo $hash $commit_time $current_branch | tr -d '\n') myapp.o myapp.o

# Convert 'myapp.o' object file to binary file 'myapp_with_git_info'
objcopy -O binary myapp.o myapp_with_git_info

# Verify that git info was added to binary file
strings myapp_with_git_info | grep git_info

其中最后一行会输出注入的Git信息。

示例2: Linux

在Linux上，objcopy命令可能会缺失--add-section选项，因此我们需要手动添加一个新的section来保存Git信息。以下是注入Git信息的完整命令：

#!/bin/bash

# Get current commit hash
hash=$(git rev-parse HEAD)

# Get current commit time
commit_time=$(git log -1 --format=%cd --date=iso)

# Get current branch name
current_branch=$(git branch --show-current)

# Compile main.cpp to executable 'myapp'
g++ main.cpp -o myapp

# Convert 'myapp' binary to object file 'myapp.o'
objcopy -I binary -O elf64-x86-64 -B i386 myapp myapp.o

# Create new section file containing git info
echo $hash $commit_time $current_branch | tr -d '\n' > git_info.txt

# Add git_info section to 'myapp.o', containing git info
objcopy --add-section .git_info=git_info.txt myapp.o

# Convert 'myapp.o' object file to binary file 'myapp_with_git_info'
objcopy -O binary myapp.o myapp_with_git_info

# Verify that git info was added to binary file
strings myapp_with_git_info | grep git_info

# cleanup
rm git_info.txt