xref: /linux/Documentation/translations/zh_CN/core-api/printk-basics.rst (revision 06d07429858317ded2db7986113a9e0129cd599b)
17c0066d1SYanteng Si.. SPDX-License-Identifier: GPL-2.0
27c0066d1SYanteng Si.. include:: ../disclaimer-zh_CN.rst
37c0066d1SYanteng Si
47c0066d1SYanteng Si:Original: Documentation/core-api/printk-basics.rst
58137a49eSYanteng Si
68137a49eSYanteng Si:翻译:
78137a49eSYanteng Si
88137a49eSYanteng Si 司延腾 Yanteng Si <siyanteng@loongson.cn>
94faa99e3SBinbin Zhou 周彬彬 Binbin Zhou <zhoubinbin@loongson.cn>
107c0066d1SYanteng Si
117c0066d1SYanteng Si.. _cn_printk-basics.rst:
127c0066d1SYanteng Si
137c0066d1SYanteng Si==================
147c0066d1SYanteng Si使用printk记录消息
157c0066d1SYanteng Si==================
167c0066d1SYanteng Si
177c0066d1SYanteng Siprintk()是Linux内核中最广为人知的函数之一。它是我们打印消息的标准工具,通常也是追踪和调试
187c0066d1SYanteng Si的最基本方法。如果你熟悉printf(3),你就能够知道printk()是基于它的,尽管它在功能上有一些不
197c0066d1SYanteng Si同之处:
207c0066d1SYanteng Si
217c0066d1SYanteng Si  - printk() 消息可以指定日志级别。
227c0066d1SYanteng Si
237c0066d1SYanteng Si  - 格式字符串虽然与C99基本兼容,但并不遵循完全相同的规范。它有一些扩展和一些限制(没
247c0066d1SYanteng Si    有 ``%n`` 或浮点转换指定符)。参见:ref: `如何正确地获得printk格式指定符<printk-specifiers>` 。
257c0066d1SYanteng Si
267c0066d1SYanteng Si所有的printk()消息都会被打印到内核日志缓冲区,这是一个通过/dev/kmsg输出到用户空间的环
277c0066d1SYanteng Si形缓冲区。读取它的通常方法是使用 ``dmesg`` 。
287c0066d1SYanteng Si
297c0066d1SYanteng Siprintk()的用法通常是这样的::
307c0066d1SYanteng Si
317c0066d1SYanteng Si  printk(KERN_INFO "Message: %s\n", arg);
327c0066d1SYanteng Si
337c0066d1SYanteng Si其中 ``KERN_INFO`` 是日志级别(注意,它与格式字符串连在一起,日志级别不是一个单独的参数)。
347c0066d1SYanteng Si可用的日志级别是:
357c0066d1SYanteng Si
367c0066d1SYanteng Si
377c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
387c0066d1SYanteng Si| 名称           | 字符串 |  别名函数                                     |
397c0066d1SYanteng Si+================+========+===============================================+
407c0066d1SYanteng Si| KERN_EMERG     | "0"    | pr_emerg()                                    |
417c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
427c0066d1SYanteng Si| KERN_ALERT     | "1"    | pr_alert()                                    |
437c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
447c0066d1SYanteng Si| KERN_CRIT      | "2"    | pr_crit()                                     |
457c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
467c0066d1SYanteng Si| KERN_ERR       | "3"    | pr_err()                                      |
477c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
487c0066d1SYanteng Si| KERN_WARNING   | "4"    | pr_warn()                                     |
497c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
507c0066d1SYanteng Si| KERN_NOTICE    | "5"    | pr_notice()                                   |
517c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
527c0066d1SYanteng Si| KERN_INFO      | "6"    | pr_info()                                     |
537c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
547c0066d1SYanteng Si| KERN_DEBUG     | "7"    | pr_debug() and pr_devel()  若定义了DEBUG      |
557c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
567c0066d1SYanteng Si| KERN_DEFAULT   | ""     |                                               |
577c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
587c0066d1SYanteng Si| KERN_CONT      | "c"    | pr_cont()                                     |
597c0066d1SYanteng Si+----------------+--------+-----------------------------------------------+
607c0066d1SYanteng Si
617c0066d1SYanteng Si
627c0066d1SYanteng Si日志级别指定了一条消息的重要性。内核根据日志级别和当前 *console_loglevel* (一个内核变量)决
637c0066d1SYanteng Si定是否立即显示消息(将其打印到当前控制台)。如果消息的优先级比 *console_loglevel* 高(日志级
647c0066d1SYanteng Si别值较低),消息将被打印到控制台。
657c0066d1SYanteng Si
667c0066d1SYanteng Si如果省略了日志级别,则以 ``KERN_DEFAULT`` 级别打印消息。
677c0066d1SYanteng Si
687c0066d1SYanteng Si你可以用以下方法检查当前的 *console_loglevel* ::
697c0066d1SYanteng Si
707c0066d1SYanteng Si  $ cat /proc/sys/kernel/printk
717c0066d1SYanteng Si  4        4        1        7
727c0066d1SYanteng Si
737c0066d1SYanteng Si结果显示了 *current*, *default*, *minimum* 和 *boot-time-default* 日志级别
747c0066d1SYanteng Si
757c0066d1SYanteng Si要改变当前的 console_loglevel,只需在 ``/proc/sys/kernel/printk`` 中写入所需的
767c0066d1SYanteng Si级别。例如,要打印所有的消息到控制台上::
777c0066d1SYanteng Si
787c0066d1SYanteng Si  # echo 8 > /proc/sys/kernel/printk
797c0066d1SYanteng Si
807c0066d1SYanteng Si另一种方式,使用 ``dmesg``::
817c0066d1SYanteng Si
827c0066d1SYanteng Si  # dmesg -n 5
837c0066d1SYanteng Si
847c0066d1SYanteng Si设置 console_loglevel 打印 KERN_WARNING (4) 或更严重的消息到控制台。更多消息参
857c0066d1SYanteng Si见 ``dmesg(1)`` 。
867c0066d1SYanteng Si
877c0066d1SYanteng Si作为printk()的替代方案,你可以使用 ``pr_*()`` 别名来记录日志。这个系列的宏在宏名中
887c0066d1SYanteng Si嵌入了日志级别。例如::
897c0066d1SYanteng Si
907c0066d1SYanteng Si  pr_info("Info message no. %d\n", msg_num);
917c0066d1SYanteng Si
927c0066d1SYanteng Si打印 ``KERN_INFO`` 消息。
937c0066d1SYanteng Si
947c0066d1SYanteng Si除了比等效的printk()调用更简洁之外,它们还可以通过pr_fmt()宏为格式字符串使用一个通用
957c0066d1SYanteng Si的定义。例如,在源文件的顶部(在任何  ``#include`` 指令之前)定义这样的内容。::
967c0066d1SYanteng Si
977c0066d1SYanteng Si  #define pr_fmt(fmt) "%s:%s: " fmt, KBUILD_MODNAME, __func__
987c0066d1SYanteng Si
997c0066d1SYanteng Si会在该文件中的每一条 pr_*() 消息前加上发起该消息的模块和函数名称。
1007c0066d1SYanteng Si
1017c0066d1SYanteng Si为了调试,还有两个有条件编译的宏:
1027c0066d1SYanteng Sipr_debug()和pr_devel(),除非定义了 ``DEBUG`` (或者在pr_debug()的情况下定义了
103*0587e62bSJiaLong.Yang``CONFIG_DYNAMIC_DEBUG`` ),否则它们不会被编译。
1047c0066d1SYanteng Si
1057c0066d1SYanteng Si
1067c0066d1SYanteng Si函数接口
1077c0066d1SYanteng Si========
1087c0066d1SYanteng Si
1097c0066d1SYanteng Si该API在以下内核代码中:
1107c0066d1SYanteng Si
1117c0066d1SYanteng Siinclude/linux/printk.h
112