3. printk 高级用法：格式化输出、动态调试、限速与设备标识

printk 是内核中最基础的日志输出接口，但其能力远不止简单的字符串打印。掌握格式化输出的控制、动态调试的开关、限速机制以及设备标识符的规范使用，是高效定位驱动问题的关键。本节将深入这些高级用法，帮助你在实际调试中精准、高效地获取信息。

3.1 格式化输出：控制日志的粒度与可读性

printk 的格式化输出与用户空间的 printf 类似，但增加了内核特有的日志级别（loglevel）控制。日志级别决定了消息是否显示在控制台以及写入系统日志（dmesg）的优先级。

3.1.1 日志级别与宏定义

内核通过 <level> 前缀控制每条 printk 消息的优先级。常用的宏定义如下：

宏定义 数值 含义 典型场景
KERN_EMERG 0 紧急事件，系统不可用 致命硬件错误
KERN_ALERT 1 必须立即处理 严重软件故障
KERN_CRIT 2 临界条件 驱动初始化失败
KERN_ERR 3 错误条件 I/O 操作失败
KERN_WARNING 4 警告条件 资源不足
KERN_NOTICE 5 正常但重要 模块加载/卸载
KERN_INFO 6 信息性消息 设备探测信息
KERN_DEBUG 7 调试消息 函数入口/出口
实践建议： 在驱动开发阶段，将关键路径的日志设为 KERN_INFO 或 KERN_DEBUG，生产环境中通过 echo "8 4 1 7" > /proc/sys/kernel/printk 调整控制台日志级别，避免调试信息干扰正常输出。

3.1.2 格式化占位符与内核特有扩展

除了标准的 %d、%x、%s 等，内核还提供了针对驱动调试的专用占位符：

  • %p：打印指针地址，默认显示为十六进制。
  • %pI4、%pI6：打印 IPv4/IPv6 地址，自动格式化。
  • %pM：打印 MAC 地址，格式为 xx:xx:xx:xx:xx:xx。
  • %pV：打印 struct va_format 结构体，用于自定义格式化。
  • %px：打印完整指针（不进行哈希混淆），仅在调试配置下可用。
// 示例：打印网络设备信息
struct net_device *dev = ...;
printk(KERN_INFO "Device %s, MAC %pM, IP %pI4\n",
       dev->name, dev->dev_addr, &dev->ip_ptr->u.ip4->ifa_list->ifa_address);
关键点： 使用 %p 系列占位符可以避免手动拼接字符串，提高代码可读性和安全性。内核 5.0+ 默认对 %p 进行哈希处理，如需原始地址请使用 %px 并确保 CONFIG_DEBUG_KERNEL 已启用。

3.2 动态调试（Dynamic Debug）：按需开启/关闭日志

动态调试（dyndbg）允许你在不重新编译内核或模块的情况下，动态控制特定文件、函数或行的 printk 输出。这对于生产环境下的问题定位极为有用。

3.2.1 启用与配置

内核需要开启 CONFIG_DYNAMIC_DEBUG 和 CONFIG_DEBUG_FS。挂载 debugfs 后，通过 /sys/kernel/debug/dynamic_debug/control 文件进行控制。

# 挂载 debugfs
mount -t debugfs none /sys/kernel/debug

# 查看当前所有动态调试点
cat /sys/kernel/debug/dynamic_debug/control

# 启用 drivers/net/ethernet/intel/e1000/e1000_main.c 中所有调试信息
echo "file e1000_main.c +p" > /sys/kernel/debug/dynamic_debug/control

# 启用 e1000_probe 函数中的调试信息
echo "func e1000_probe +p" > /sys/kernel/debug/dynamic_debug/control

# 禁用所有调试信息
echo "module e1000 -p" > /sys/kernel/debug/dynamic_debug/control

3.2.2 匹配模式与操作符

匹配模式 语法示例 说明
按文件名 file drivers/usb/core/* +p 支持通配符，匹配路径中的文件
按函数名 func usb_submit_urb +p 精确匹配函数名
按行号 file usb.c line 123 +p 精确匹配某一行
按模块名 module ehci_hcd +p 匹配整个模块
格式化字符串 format "urb status" +p 匹配 printk 格式化字符串内容
注意： 动态调试仅对使用 pr_debug()、dev_dbg() 等宏的代码生效。直接使用 printk(KERN_DEBUG ...) 不受 dyndbg 控制。建议驱动代码统一使用 dev_dbg() 或 pr_debug()。

3.3 限速（Rate-Limiting）：防止日志风暴

在中断上下文或高频循环中，不加限制的 printk 会导致日志风暴，瞬间填满内核日志缓冲区，甚至引发系统挂死。内核提供了两种限速机制：

3.3.1 printk_ratelimit() 与 printk_ratelimited()

printk_ratelimit() 是一个全局限速函数，默认允许每秒最多 10 条消息，突发上限为 5 条。可通过 /proc/sys/kernel/printk_ratelimit 和 printk_ratelimit_burst 调整。

// 传统用法：手动检查
if (printk_ratelimit()) {
    printk(KERN_WARNING "High-frequency interrupt detected!\n");
}

// 推荐用法：使用宏自动包裹
printk_ratelimited(KERN_INFO "DMA transfer completed, status: %d\n", status);

3.3.2 net_ratelimit() 与 netdev_ratelimit()

网络子系统专用的限速函数，与全局限速独立，避免网络驱动日志被其他子系统淹没。

// 网络驱动中的典型用法
if (net_ratelimit()) {
    netdev_err(dev, "TX timeout, resetting hardware\n");
}

3.3.3 自定义限速：DEFINE_RATELIMIT_STATE

对于需要精细控制的场景，可以定义自己的限速状态变量：

#include <linux/ratelimit.h>

// 定义限速状态：每秒 5 条，突发 2 条
static DEFINE_RATELIMIT_STATE(my_drv_ratelimit, 5 * HZ, 2);

void my_drv_handle_error(void) {
    if (__ratelimit(&my_drv_ratelimit)) {
        printk(KERN_ERR "MyDriver: critical error occurred\n");
    }
}
调试技巧： 在开发初期，可以临时调高 printk_ratelimit 的值（例如设为 0 表示不限速），以便捕获所有日志。生产部署前务必恢复默认值或使用自定义限速。

3.4 设备标识符打印：让日志归属清晰

在多设备系统中，每条日志必须明确标识其来源设备。内核提供了 dev_*() 系列宏，自动在日志前添加设备名称（如 eth0、sda）和驱动名称。

3.4.1 dev_*() 宏家族

宏 日志级别 输出示例
dev_emerg(dev, fmt, ...) KERN_EMERG e1000e 0000:00:19.0 eth0: Link is down
dev_alert(dev, fmt, ...) KERN_ALERT ata1.00: exception Emask 0x0 SAct 0x0 SErr 0x0 action 0x6 frozen
dev_crit(dev, fmt, ...) KERN_CRIT mmc0: Critical hardware error
dev_err(dev, fmt, ...) KERN_ERR usb 1-1: reset high-speed USB device number 2 using ehci_hcd
dev_warn(dev, fmt, ...) KERN_WARNING i2c i2c-0: adapter may have been powered off
dev_notice(dev, fmt, ...) KERN_NOTICE sd 0:0:0:0: Attached SCSI disk
dev_info(dev, fmt, ...) KERN_INFO libphy: Fixed MDIO Bus: probed
dev_dbg(dev, fmt, ...) KERN_DEBUG dwc_otg_hcd_urb_enqueue: urb type 2 
// 驱动 probe 函数中的典型用法
static int my_driver_probe(struct platform_device *pdev) {
    struct device *dev = &pdev->dev;
    struct my_private *priv;

    priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
    if (!priv)
        return -ENOMEM;

    dev_info(dev, "MyDriver initialized successfully\n");
    dev_dbg(dev, "Hardware revision: %d\n", priv->hw_rev);

    return 0;
}

3.4.2 自定义设备标识

对于非标准设备（如虚拟设备、自定义总线设备），可以使用 dev_set_name() 设置设备名称，或直接使用 pr_*() 宏配合模块名：

// 使用 dev_set_name 自定义名称
struct device *my_dev = ...;
dev_set_name(my_dev, "my_virt_dev%d", instance_id);

// 或使用 pr_fmt 宏统一添加模块前缀
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
pr_info("Loading firmware version %d\n", fw_ver);
最佳实践： 始终优先使用 dev_*() 宏而非裸 printk。这不仅能自动添加设备标识，还能与动态调试、sysfs 等内核基础设施无缝集成。在设备驱动中，dev_dbg() 是调试日志的首选。

3.5 综合示例：驱动调试日志框架

以下是一个融合了本节所有高级用法的驱动调试代码片段：

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
#include <linux/module.h>
#include <linux/ratelimit.h>

static DEFINE_RATELIMIT_STATE(my_irq_ratelimit, 5 * HZ, 1);

static irqreturn_t my_irq_handler(int irq, void *dev_id) {
    struct my_device *mydev = dev_id;

    // 使用 dev_dbg 配合动态调试
    dev_dbg(&mydev->pdev->dev, "IRQ received, status=0x%x\n",
            readl(mydev->regs + STATUS_REG));

    // 限速打印错误信息
    if (readl(mydev->regs + STATUS_REG) & ERROR_FLAG) {
        if (__ratelimit(&my_irq_ratelimit)) {
            dev_err_ratelimited(&mydev->pdev->dev,
                               "Hardware error detected, resetting\n");
        }
        // 执行错误恢复
        mydev_reset_hw(mydev);
    }

    return IRQ_HANDLED;
}
调试流程建议：
  1. 开发阶段：使用 dev_dbg() 输出所有关键路径日志，通过 echo "module mydriver +p" > control 动态启用。
  2. 集成测试：保留 dev_info() 和 dev_err()，对高频路径使用 dev_err_ratelimited()。
  3. 生产部署：关闭所有 dev_dbg()，仅保留 dev_err() 和 dev_warn()，并确保限速参数合理。

3.6 本章小结

← 上一章 📖 返回目录 下一章 →