Linux驱动开发——pr_fmt的用法

作者：彭东林

邮箱：pengdonglin137@163.com

在阅读kernel代码的时候，总是看到有很多驱动都在第一行定义pr_fmt，闲来没事，分析了一下， 发现，确实挺方便的。下面记录分享一下。

我们知道，在驱动中可以使用dev_dbg来输出log，在输出的log中会有一些额外的信息，如所属的device的name。

而pr_fmt就可以实现这个目的，先看一个用法（drivers/i2c/i2c-core.c）：

#define pr_fmt(fmt) "i2c-core: " fmt
 
#include <dt-bindings/i2c/i2c.h>
#include <asm/uaccess.h>
#include <linux/acpi.h>
... ...

但是在这个文件中并没有看到pr_fmt被使用。然后，猜测应该是被哪个宏使用了，所以我在include下搜索pr_fmt发现：

include/linux/printk.h::    printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
include/linux/printk.h::    printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)

然后看一下printk.h：

 ... ...
 #ifndef pr_fmt
 #define pr_fmt(fmt) fmt
 #endif
 
 /*
  * These can be used to print at the various log levels.
  * All of these will print unconditionally, although note that pr_debug()
  * and other debug macros are compiled out unless either DEBUG is defined
  * or CONFIG_DYNAMIC_DEBUG is set.
  */
 #define pr_emerg(fmt, ...) \
     printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 #define pr_alert(fmt, ...) \
     printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 #define pr_crit(fmt, ...) \
     printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 #define pr_err(fmt, ...) \
     printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 #define pr_warning(fmt, ...) \
     printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 #define pr_warn pr_warning
 #define pr_notice(fmt, ...) \
     printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 #define pr_info(fmt, ...) \
     printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 
 #if defined(CONFIG_DYNAMIC_DEBUG)
 #include <linux/dynamic_debug.h>
 
 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
 #define pr_debug(fmt, ...) \
     dynamic_pr_debug(fmt, ##__VA_ARGS__)
 #elif defined(DEBUG)
 #define pr_debug(fmt, ...) \
     printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 #else
 #define pr_debug(fmt, ...) \
     no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 #endif
 ... ...

可以看到，如果驱动中没有定义pr_fmt（fmt），那么，pr_fmt(fmt)就是fmt。

使用pr_fmt的还不少， 这里有几个比较常用的函数： pr_err, pr_info,  如果没有定义CONFIG_DYNAMIC_DEBUG， 那么pr_debug也会使用pr_fmt。

从上面的代码已经看到pr_fmt的作用了吧，就是在用户要输出的log前面添加额外的固定的信息。下面结合gpio_demo.c驱动看一下pr_fmt的几种用法：

 #define pr_fmt(fmt) "gpio_demo: " fmt
 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 #define pr_fmt(fmt) KBUILD_MODNAME ":%s:%d: " fmt, __func__, __LINE__

在gpio_demo.c的第一行定义上面的一种， 然后， 在驱动中调用pr_info， 如：

 static int gpio_demo_probe(struct platform_device *pdev) {
     struct device *dev = &pdev->dev;
     int ret = ;
     int i = ;
     int gpio = -;
     gpio_demo_data_t *data = NULL;
     struct resource *res = NULL;
     u32 config, pud, drv;
 
     pr_info("%s enter.\n", __func__);
 ... ...

下面是 #define pr_fmt(fmt) "gpio_demo: " fmt 的输出：

[ 1022.623230] gpio_demo: gpio_demo_probe enter.

下面是 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 的输出（KBUILD_MODNAME是模块的名字，可以阅读这个驱动文件的Makefile文件获得）：

[ 1088.639631] gpio_demo: gpio_demo_probe enter.

下面是 #define pr_fmt(fmt) KBUILD_MODNAME ":%s:%d: " fmt, __func__, __LINE__ 的输出：

[ 1135.108534] gpio_demo:gpio_demo_probe:87: gpio_demo_probe enter.

这对输出log确实比较方便。

完。