Documentation/translations/zh_CN/core-api/printk-basics.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2 .. include:: ../disclaimer-zh_CN.rst
   3
   4 :Original: Documentation/core-api/printk-basics.rst
   5
   6 :翻译:
   7
   8  司延腾 Yanteng Si <siyanteng@loongson.cn>
   9
  10 .. _cn_printk-basics.rst:
  11
  12 ==================
  13 使用printk记录消息
  14 ==================
  15
  16 printk()是Linux内核中最广为人知的函数之一。它是我们打印消息的标准工具，通常也是追踪和调试
  17 的最基本方法。如果你熟悉printf(3)，你就能够知道printk()是基于它的，尽管它在功能上有一些不
  18 同之处:
  19
  20   - printk() 消息可以指定日志级别。
  21
  22   - 格式字符串虽然与C99基本兼容，但并不遵循完全相同的规范。它有一些扩展和一些限制（没
  23     有 ``%n`` 或浮点转换指定符）。参见:ref: `如何正确地获得printk格式指定符<printk-specifiers>` 。
  24
  25 所有的printk()消息都会被打印到内核日志缓冲区，这是一个通过/dev/kmsg输出到用户空间的环
  26 形缓冲区。读取它的通常方法是使用 ``dmesg`` 。
  27
  28 printk()的用法通常是这样的::
  29
  30   printk(KERN_INFO "Message: %s\n", arg);
  31
  32 其中 ``KERN_INFO`` 是日志级别（注意，它与格式字符串连在一起，日志级别不是一个单独的参数）。
  33 可用的日志级别是：
  34
  35
  36 +----------------+--------+-----------------------------------------------+
  37 | 名称           | 字符串 |  别名函数                                     |
  38 +================+========+===============================================+
  39 | KERN_EMERG     | "0"    | pr_emerg()                                    |
  40 +----------------+--------+-----------------------------------------------+
  41 | KERN_ALERT     | "1"    | pr_alert()                                    |
  42 +----------------+--------+-----------------------------------------------+
  43 | KERN_CRIT      | "2"    | pr_crit()                                     |
  44 +----------------+--------+-----------------------------------------------+
  45 | KERN_ERR       | "3"    | pr_err()                                      |
  46 +----------------+--------+-----------------------------------------------+
  47 | KERN_WARNING   | "4"    | pr_warn()                                     |
  48 +----------------+--------+-----------------------------------------------+
  49 | KERN_NOTICE    | "5"    | pr_notice()                                   |
  50 +----------------+--------+-----------------------------------------------+
  51 | KERN_INFO      | "6"    | pr_info()                                     |
  52 +----------------+--------+-----------------------------------------------+
  53 | KERN_DEBUG     | "7"    | pr_debug() and pr_devel()  若定义了DEBUG      |
  54 +----------------+--------+-----------------------------------------------+
  55 | KERN_DEFAULT   | ""     |                                               |
  56 +----------------+--------+-----------------------------------------------+
  57 | KERN_CONT      | "c"    | pr_cont()                                     |
  58 +----------------+--------+-----------------------------------------------+
  59
  60
  61 日志级别指定了一条消息的重要性。内核根据日志级别和当前 *console_loglevel* （一个内核变量）决
  62 定是否立即显示消息（将其打印到当前控制台）。如果消息的优先级比 *console_loglevel* 高（日志级
  63 别值较低），消息将被打印到控制台。
  64
  65 如果省略了日志级别，则以 ``KERN_DEFAULT`` 级别打印消息。
  66
  67 你可以用以下方法检查当前的 *console_loglevel* ::
  68
  69   $ cat /proc/sys/kernel/printk
  70   4        4        1        7
  71
  72 结果显示了 *current*, *default*, *minimum* 和 *boot-time-default* 日志级别
  73
  74 要改变当前的 console_loglevel，只需在 ``/proc/sys/kernel/printk`` 中写入所需的
  75 级别。例如，要打印所有的消息到控制台上::
  76
  77   # echo 8 > /proc/sys/kernel/printk
  78
  79 另一种方式，使用 ``dmesg``::
  80
  81   # dmesg -n 5
  82
  83 设置 console_loglevel 打印 KERN_WARNING (4) 或更严重的消息到控制台。更多消息参
  84 见 ``dmesg(1)`` 。
  85
  86 作为printk()的替代方案，你可以使用 ``pr_*()`` 别名来记录日志。这个系列的宏在宏名中
  87 嵌入了日志级别。例如::
  88
  89   pr_info("Info message no. %d\n", msg_num);
  90
  91 打印 ``KERN_INFO`` 消息。
  92
  93 除了比等效的printk()调用更简洁之外，它们还可以通过pr_fmt()宏为格式字符串使用一个通用
  94 的定义。例如，在源文件的顶部（在任何  ``#include`` 指令之前）定义这样的内容。::
  95
  96   #define pr_fmt(fmt) "%s:%s: " fmt, KBUILD_MODNAME, __func__
  97
  98 会在该文件中的每一条 pr_*() 消息前加上发起该消息的模块和函数名称。
  99
 100 为了调试，还有两个有条件编译的宏：
 101 pr_debug()和pr_devel()，除非定义了 ``DEBUG`` (或者在pr_debug()的情况下定义了
 102 ``CONFIG_DYNAMIC_DEBUG`` )，否则它们会被编译。
 103
 104
 105 函数接口
 106 ========
 107
 108 该API在以下内核代码中:
 109
 110 kernel/printk/printk.c
 111
 112 include/linux/printk.h