Golang 二进制文件 Symbol 符合分离和 GDB 调试

golang 二进制分离符号文件和 GDB 调试总结

核心需求

用户的核心需求分为两部分：

1. 分离符号文件：在编译 Go 程序后，希望将包含调试信息（如函数名、文件名、行号、变量信息等）的符号表从最终的可执行文件中剥离出来，形成一个独立的符号文件。这样做的主要目的是：

   • 减小发布体积：剥离了符号信息的可执行文件会小很多，便于网络分发和部署。
   • 保护源码信息：发布的二进制文件中不直接包含源码路径、变量名等敏感信息。
   • 保留调试能力：在需要时（例如分析生产环境的 core dump 文件或远程调试），可以结合符号文件对程序进行完整的符号级调试。

2. 使用 GDB 调试：利用分离出来的符号文件，对那个已经被瘦身的、不含符号信息的可执行文件进行调试。这意味着需要告诉 GDB 如何找到并加载这个独立的符号文件。

为了实现这个流程，需要借助 Go 编译器和 GNU Binutils 工具集中的 objcopy 命令。

操作流程与代码示例

下面我们将通过一个具体的例子，从编写代码到最终用 GDB 调试，完整地走一遍流程。

第 1 步：准备一个 Go 示例程序

创建一个名为 main.go 的文件。这个程序包含一个全局变量、一个主函数和一个被调用的函数，方便我们在稍后的 GDB 调试中设置断点和查看变量。

main.go

package main

import (
	"fmt"
	"time"
)

var (
	// 全局变量，用于演示查看全局变量
	globalMessage = "Hello from a global variable!"
)

// aSimpleFunction 是一个简单的函数，用于演示函数调用和局部变量
func aSimpleFunction(n int) int {
	// 局部变量
	result := n * n
	fmt.Printf("Inside aSimpleFunction: calculated result is %d\n", result)
	return result
}

func main() {
	fmt.Println("Program starting...")

	// 局部变量
	loopCounter := 5
	for i := 0; i < loopCounter; i++ {
		fmt.Printf("Main loop, iteration %d\n", i)
		// 调用函数
		square := aSimpleFunction(i)
		fmt.Printf("The square of %d is %d\n", i, square)
		time.Sleep(1 * time.Second)
	}

	fmt.Println(globalMessage)
	fmt.Println("Program finished.")
}

第 2 步：编译 Go 程序（保留调试信息）

为了让 GDB 能够很好地工作，我们在编译时需要添加特定的 gcflags 来禁用编译器优化和内联。否则，GDB 可能会在单步执行或查看变量时表现得不符合预期。

打开你的终端，执行以下命令：

# -o my-app 指定输出文件名为 my-app
# -gcflags="all=-N -l" 是关键
#   -N: 禁止编译器优化
#   -l: 禁止内联
go build -gcflags="all=-N -l" -o my-app main.go

执行完毕后，你会得到一个名为 my-app 的可执行文件。这个文件包含了完整的调试信息。我们可以用 ls -lh 查看它的大小。

ls -lh my-app
# 输出可能如下，大小取决于你的 Go 版本和操作系统
# -rwxr-xr-x 1 user user 2.1M Aug 10 17:30 my-app

第 3 步：分离符号文件

这是整个流程的核心步骤。我们将使用 objcopy 工具来完成分离。

objcopy 通常包含在 binutils 包中，在大多数 Linux 发行版中已预装。

操作分为两步：

1. 从原始文件中抽取出调试信息，保存为符号文件（例如 my-app.sym）。
2. 从原始文件中删除调试信息，生成一个精简的、用于发布的文件（例如 my-app.stripped），并嵌入一个指向符号文件的链接。

推荐使用 objcopy 的 --add-gnu-debuglink 标志，它可以一步完成剥离和链接的操作，非常方便。

# 1. 首先，只把调试信息提取出来，保存为 my-app.sym
# --only-keep-debug: 只保留调试相关的 section
objcopy --only-keep-debug my-app my-app.sym

# 2. 接着，剥离原文件中的调试信息，并添加一个指向 my-app.sym 的链接
# --strip-debug: 移除调试相关的 section
# --add-gnu-debuglink: 添加一个 .gnu_debuglink section，记录符号文件的名字和 CRC 校验和
objcopy --strip-debug --add-gnu-debuglink=my-app.sym my-app my-app.stripped

现在，我们来查看一下生成的文件：

ls -lh my-app*

你会看到类似这样的输出：

-rwxr-xr-x 1 user user 2.1M Aug 10 17:30 my-app          # 原始文件 (最大)
-rw-r--r-- 1 user user 650K Aug 10 17:31 my-app.sym        # 符号文件 (只包含调试信息)
-rwxr-xr-x 1 user user 1.5M Aug 10 17:31 my-app.stripped # 精简后的可执行文件 (最小)

可以看到，my-app.stripped 的体积明显小于原始的 my-app，而调试信息被完整地保存在了 my-app.sym 中。此时，my-app.stripped 和 my-app.sym 就是你需要交付的两个文件（当然，my-app.sym 只在需要调试时才提供）。

第 4 步：使用 GDB 和符号文件进行调试

现在，我们将演示如何使用 GDB 来调试那个被剥离过的 my-app.stripped 文件。

方法一 (推荐): 利用 .gnu_debuglink 自动加载

由于我们在上一步使用了 --add-gnu-debuglink，GDB 足够智能，可以自动查找并加载符号文件。前提是 my-app.sym 文件与 my-app.stripped 文件在同一个目录下。

1. 启动 GDB 并加载被剥离的程序：

   gdb ./my-app.stripped
   

2. GDB 启动时，会自动读取 .gnu_debuglink 段，找到并加载 my-app.sym。你会看到类似 “Reading symbols from ./my-app.sym…” 的提示。

3. 现在，你可以像调试普通程序一样进行操作了。

GDB 调试会话示例：

$ gdb ./my-app.stripped
GNU gdb (GDB) 12.1
...
Reading symbols from ./my-app.stripped...
Reading symbols from ./my-app.sym... # <--- 看这里，GDB 自动加载了符号文件
(gdb)

# 在 aSimpleFunction 函数入口处设置一个断点
(gdb) b main.aSimpleFunction
Breakpoint 1 at 0x48d2b0: file /path/to/your/project/main.go, line 15.

# 运行程序
(gdb) run
Starting program: /path/to/your/project/my-app.stripped
Program starting...
Main loop, iteration 0
Inside aSimpleFunction: calculated result is 0
The square of 0 is 0

Breakpoint 1, main.aSimpleFunction (n=1) at /path/to/your/project/main.go:15
15	func aSimpleFunction(n int) int {

# 查看传入的参数 n
(gdb) p n
$1 = 1

# 单步执行到下一行
(gdb) next
17		result := n * n

# 查看局部变量 result 的值
(gdb) p result
$2 = 1

# 查看全局变量
(gdb) p main.globalMessage
$3 = "Hello from a global variable!"

# 继续执行
(gdb) continue
Continuing.
Inside aSimpleFunction: calculated result is 1
The square of 1 is 1

Breakpoint 1, main.aSimpleFunction (n=2) at /path/to/your/project/main.go:15
15	func aSimpleFunction(n int) int {

# 退出 GDB
(gdb) quit
A debugging session is active.

	Inferior 1 [process 12345] will be killed.

Quit anyway? (y or n) y

方法二: 手动加载符号文件

如果你没有使用 --add-gnu-debuglink，或者符号文件不在约定的查找路径中（例如，你把 my-app.sym 放在了 /tmp/symbols/ 目录下），GDB 就无法自动找到它。这时你需要手动加载。

1. 启动 GDB：

   gdb ./my-app.stripped
   

   此时 GDB 会提示找不到符号。

2. 使用 symbol-file 命令手动加载符号文件：

   (gdb) symbol-file /path/to/your/symbols/my-app.sym
   Reading symbols from /path/to/your/symbols/my-app.sym...
   (gdb)
   

3. 加载成功后，后续的调试步骤与方法一完全相同。

总结

注意事项

• GDB 对 Go 的支持：虽然 GDB 支持 Go，但有时在处理 Goroutine、channel 等并发原语时会比较复杂。对于复杂的 Go 程序调试，更推荐使用专门为 Go 设计的调试器 Delve (dlv)，它的体验通常更佳。
• 版本兼容性：确保你的 GDB 版本较新，对 Go 语言的支持会更好。
• 文件路径：编译时嵌入的源文件路径是绝对路径。如果要在另一台机器上调试，而源码不在相同路径下，GDB 可能找不到源文件。可以使用 GDB 的 dir 或 set substitute-path 命令来解决。