Go plan9obj.Symbols 怎样读取 Plan 9 文件的符号表

如果手里有一个需要分析的 Plan 9 a.out 文件，Go 标准库的 debug/plan9obj 可以直接读取它的符号表。核心调用是 File.Symbols()：成功时得到 []plan9obj.Sym，每个符号包含 Value、Type 和 Name；文件没有符号段时则返回 plan9obj.ErrNoSymbols。

官方文档：https://pkg.go.dev/debug/plan9obj#File.Symbols

本文只讨论读取自有的 Plan 9 a.out 文件，不涉及修改目标文件、绕过权限或处理不受信任的输入。文中的配图是静态说明图，不是运行截图。

先看懂 Symbols 返回什么

plan9obj.File 表示一个已打开的 Plan 9 a.out 文件。调用 Symbols() 后，返回值不是一个需要再次打开的 section，而是一个符号切片：

type Sym struct {
	Value uint64 // 符号对应的数值或地址字段
	Type  rune   // 符号类型标记
	Name  string // 符号名称
}

因此，读取逻辑通常是“打开文件—读取符号切片—遍历字段”。不要把 Symbols() 和 Section(".text") 混用：前者面向符号表，后者面向指定 section。

用 Open 和 Symbols 读取符号表

最小可用程序可以把目标文件路径作为命令行参数。plan9obj.Open 负责打开并解析 Plan 9 a.out 文件，读取完成后用 Close 释放由打开动作取得的资源。

package main

import (
	"fmt"     // 输出读取到的符号信息
	"os"      // 读取命令行参数

	"debug/plan9obj" // 解析 Plan 9 a.out 文件
)

func main() {
	if len(os.Args) != 2 {
		fmt.Fprintln(os.Stderr, "用法：read-symbols FILE") // 明确要求一个目标文件
		os.Exit(2)
	}

	f, err := plan9obj.Open(os.Args[1])
	if err != nil {
		fmt.Fprintf(os.Stderr, "打开 Plan 9 文件失败：%v\n", err) // 打开或基础解析失败在这里返回
		os.Exit(1)
	}
	defer f.Close() // Open 成功后确保文件资源最终关闭

	symbols, err := f.Symbols()
	if err != nil {
		fmt.Fprintf(os.Stderr, "读取符号表失败：%v\n", err) // 缺少符号段也会在这里被识别
		os.Exit(1)
	}

	for _, sym := range symbols {
		fmt.Printf("0x%x %c %s\n", sym.Value, sym.Type, sym.Name) // 按字段输出每个符号
	}
}

这个程序的边界很清楚：参数数量不对时不碰文件；打开失败时不调用 Symbols；打开成功后用 defer f.Close() 管理资源；只有符号表读取成功，才遍历返回切片。

怎样处理 Value、Type 和 Name

Value 是 uint64，打印地址或数值时可以使用十六进制；Type 是 rune，适合使用 %c 展示单个类型标记，也可以按数值进一步分类；Name 是普通字符串，可能为空，因此不要把空名称直接当成读取失败。

func printSymbols(symbols []plan9obj.Sym) {
	for index, sym := range symbols {
		name := sym.Name
		if name == "" {
			name = "" // 空名称只代表字段为空，不把它当成错误
		}
		fmt.Printf("[%d] value=0x%x type=%q name=%s\n", index, sym.Value, sym.Type, name) // 保留字段类型信息
	}
}

如果后续需要按名称查找，可以在遍历时建立 map[string]plan9obj.Sym；如果需要保留重复名称，则应继续使用原始切片。这里不额外推断符号是否可执行，判断只依据返回的字段。

ErrNoSymbols 和普通读取错误要分开

官方文档明确说明：当文件没有符号段时，File.Symbols 返回 ErrNoSymbols。这是一种可识别的输入状态，不应和文件打不开、格式解析失败或底层读取失败混为一谈。

func readSymbols(path string) ([]plan9obj.Sym, error) {
	f, err := plan9obj.Open(path)
	if err != nil {
		return nil, fmt.Errorf("打开 Plan 9 文件：%w", err) // 这类错误发生在 Symbols 之前
	}
	defer f.Close() // 无论后续返回哪种结果都关闭资源

	symbols, err := f.Symbols()
	if err != nil {
		if errors.Is(err, plan9obj.ErrNoSymbols) {
			return nil, fmt.Errorf("文件没有符号段：%w", err) // 给调用方保留可判断的原因
		}
		return nil, fmt.Errorf("读取符号表：%w", err) // 其它读取错误继续向上返回
	}
	return symbols, nil
}

调用方可以再次使用 errors.Is 判断是否为 plan9obj.ErrNoSymbols。如果要把“没有符号表”当作可接受的扫描结果，可以在这一层转成空切片；如果它意味着输入不符合业务要求，则应继续返回错误。

输入边界与资源处理

plan9obj.NewFile 还可以从实现 io.ReaderAt 的对象创建文件解析器，且底层 Plan 9 二进制应从 reader 的位置 0 开始。对于普通路径读取，Open 更直接；对于已经由程序管理的随机访问数据，才考虑 NewFile。

func readFromReaderAt(r io.ReaderAt) ([]plan9obj.Sym, error) {
	f, err := plan9obj.NewFile(r)
	if err != nil {
		return nil, fmt.Errorf("解析 ReaderAt 中的 Plan 9 文件：%w", err) // reader 必须从文件起点提供数据
	}
	// NewFile 没有接管外部 reader 的关闭责任，因此这里不调用 f.Close 来关闭外部对象。
	return f.Symbols()
}

还要注意官方文档对该包的安全提示：它只做基础校验，不适合直接把不受信任的异常输入当成安全数据处理。本文示例的“自有文件”边界，意味着调用方应先确定输入来源，再决定是否进入解析流程。

迁移清单：把读取逻辑固定下来

常见问题

Symbols 返回空切片就一定有错误吗？

不能只凭切片长度下结论。首先检查 error；没有符号段时应识别 ErrNoSymbols，只有 err == nil 时才把返回切片当作成功结果继续处理。

为什么不直接读取某个 section？

section 和符号表是不同层次的数据。标题任务是读取符号表时，优先调用 Symbols，避免自行按文件偏移解析符号记录。

NewFile 创建的 File 需要关闭吗？

官方文档说明，直接由 NewFile 创建的 File 调用 Close 不会产生效果；外部 reader 的生命周期仍由创建它的代码管理。

可以用 plan9obj 解析不受信任的文件吗？

应谨慎。官方文档提示该包只做基础校验，异常输入可能消耗较多资源或触发 panic。本文示例限定为自有文件，不把它当作通用安全沙箱。

归纳起来，Go 读取 Plan 9 文件符号表的稳定写法就是：先用 Open 建立 File，再调用 Symbols，按 Sym 字段消费结果，并用 ErrNoSymbols 单独处理“没有符号段”。