📚 课程目录第3章动态打印（Dynamic Debug）原理

3. 动态打印（Dynamic Debug）原理：dynamic_debug控制机制、pr_debug/dev_dbg宏、内核编译配置要求

动态打印（Dynamic Debug，简称 dyndbg）是 Linux 内核提供的一种强大的调试信息控制机制。它允许开发者在系统运行时，动态地启用或禁用内核代码中预先定义的调试打印语句，而无需重新编译内核或重启系统。这极大地提升了内核驱动开发和故障排查的效率。

3.1 核心控制机制：dynamic_debug

dynamic_debug 是内核中实现动态打印功能的核心基础设施。其工作原理是在编译时，将使用特定宏（如 pr_debug、dev_dbg）的调试语句的位置信息（文件名、函数名、行号）和格式字符串记录到内核映像的一个特殊段（__dyndbg）中。在运行时，通过 debugfs 文件系统提供的接口（通常挂载在 /sys/kernel/debug/dynamic_debug/control），用户可以查询和修改这些调试点的状态。

  关键概念： 每个动态打印点（prdb）都关联一个 控制标志位（_DPRINTK_FLAGS_PRINT）。当该标志位被置位时，对应的调试信息才会被输出到内核日志（printk 缓冲区）。dynamic_debug 机制的核心就是通过 debugfs 接口，高效地批量修改这些标志位。

3.2 pr_debug / dev_dbg 宏

这两个宏是驱动开发者最常用的动态打印接口。它们的行为取决于内核是否配置了 CONFIG_DYNAMIC_DEBUG。

pr_debug(fmt, ...)：用于非设备特定的调试信息。它不依赖 struct device。
dev_dbg(dev, fmt, ...)：用于设备特定的调试信息。它会在输出中包含设备名称，便于关联日志与具体设备。

最佳实践： 在驱动开发中，优先使用 dev_dbg() 而非 pr_debug()。因为 dev_dbg() 提供了设备上下文，使得在多设备、多实例的场景下，日志的可读性和可过滤性更强。

当 CONFIG_DYNAMIC_DEBUG 未启用时，这些宏会退化为 printk(KERN_DEBUG ...) 或直接定义为 do { } while (0)（取决于 DEBUG 宏是否定义）。当 CONFIG_DYNAMIC_DEBUG 启用时，它们会注册到 dynamic_debug 框架中。

宏行为对比

宏	依赖设备对象	输出格式	典型使用场景
`pr_debug()`	否	`[ timestamp] mydriver: my_function: message`	模块初始化、全局状态、算法调试
`dev_dbg()`	是 (`struct device *`)	`[ timestamp] mydriver mydevice: my_function: message`	设备操作（open/read/write/ioctl）、中断处理、DMA传输

3.3 内核编译配置要求

要使用动态打印功能，必须在编译内核时启用相应的配置选项。以下是关键的 Kconfig 选项：

配置选项	描述	推荐状态
`CONFIG_DYNAMIC_DEBUG`	启用动态打印核心功能。这是使用 `pr_debug`/`dev_dbg` 动态控制的基础。	必须启用 (y)
`CONFIG_DEBUG_FS`	启用 `debugfs` 文件系统。`dynamic_debug` 的控制接口 `/sys/kernel/debug/dynamic_debug/control` 依赖于它。	必须启用 (y)
`CONFIG_DYNAMIC_DEBUG_CORE`	在较新内核版本中，将核心支持与模块支持分离。通常在选择 `CONFIG_DYNAMIC_DEBUG` 时自动选中。	自动选择

常见陷阱： 即使内核启用了 CONFIG_DYNAMIC_DEBUG，如果 debugfs 未挂载，你仍然无法通过 /sys/kernel/debug/dynamic_debug/control 控制调试输出。请确保在系统启动时或手动执行 mount -t debugfs none /sys/kernel/debug。

配置验证步骤

检查内核配置文件（通常位于 /boot/config-$(uname -r) 或 /proc/config.gz）。

确认以下选项为 y 或 m：

CONFIG_DEBUG_FS=y
CONFIG_DYNAMIC_DEBUG=y

确认 debugfs 已挂载：

mount | grep debugfs
# 输出示例: debugfs on /sys/kernel/debug type debugfs (rw,nosuid,nodev,noexec,relatime)

查看动态打印控制文件是否存在：

ls -l /sys/kernel/debug/dynamic_debug/control
# 输出示例: -r--r--r-- 1 root root 0 [date] control

3.4 控制接口语法

动态打印的控制接口通过向 /sys/kernel/debug/dynamic_debug/control 文件写入命令来实现。命令格式如下：

echo 'command' > /sys/kernel/debug/dynamic_debug/control

其中 command 由 查询条件 和 操作动作 两部分组成。

查询条件

条件关键字	含义	示例
`module`	匹配模块名	`module mydriver`
`func`	匹配函数名	`func my_ioctl`
`file`	匹配源文件名	`file mydriver.c`
`line`	匹配行号或行号范围	`line 128` 或 `line 100-200`
`format`	匹配格式字符串	`format "error code:"`

操作动作

动作	含义	示例
`+p`	启用打印（使能该调试点）	`+p`
`-p`	禁用打印	`-p`
`+f`	在输出中添加函数名	`+f`
`+l`	在输出中添加行号	`+l`
`+m`	在输出中添加模块名	`+m`
`+t`	在输出中添加线程 ID	`+t`

常用命令示例

# 启用 mydriver 模块中所有调试输出
echo 'module mydriver +p' > /sys/kernel/debug/dynamic_debug/control

# 启用 mydriver.c 文件中 my_ioctl 函数的调试输出
echo 'file mydriver.c func my_ioctl +p' > /sys/kernel/debug/dynamic_debug/control

# 启用 mydriver.c 文件中第 128 行的调试输出，并显示函数名和行号
echo 'file mydriver.c line 128 +pfl' > /sys/kernel/debug/dynamic_debug/control

# 禁用 mydriver 模块中所有调试输出
echo 'module mydriver -p' > /sys/kernel/debug/dynamic_debug/control

# 查看当前所有已注册的动态调试点及其状态
cat /sys/kernel/debug/dynamic_debug/control

  效率提示： 使用 cat /sys/kernel/debug/dynamic_debug/control | grep mydriver 可以快速过滤出与特定模块相关的调试点，便于确认哪些点已被启用或禁用。