使用 ftrace 调试 Linux 内核，第 1 部分

简介： ftrace 是 Linux 内核中提供的一种调试工具。使用 ftrace 能够对内核中发生的事情进行跟踪，这在调试 bug 或者分析内核时很是有用。本系列文章对 ftrace 进行了介绍，分为三部分。本文是第一部分，介绍了内核相关的编译选项、用户态访问 ftrace 的接口、ftrace 的数据文件，并对 ftrace 提供的跟踪器的用途进行了介绍，以使读者更好的了解和使用该工具。

发布日期： 2010 年 6 月 10 日 
级别： 初级 
访问状况 ： 6335 次浏览 
评论： 0 (查看 | 添加评论 - 登陆)

 平均分 (17个评分)
为本文评分

内容

• 让内核支持 ftrace
• 经过 debugfs 访问 ftrace
• ftrace 的数据文件
• ftrace 跟踪器
• 小结
• 参考资料
• 做者简介
• 建议

ftrace 是内建于 Linux 内核的跟踪工具，从 2.6.27 开始加入主流内核。使用 ftrace 能够调试或者分析内核中发生的事情。ftrace 提供了不一样的跟踪器，以用于不一样的场合，好比跟踪内核函数调用、对上下文切换进行跟踪、查看中断被关闭的时长、跟踪内核态中的延迟以及性能问题等。系统开发人员可使用 ftrace 对内核进行跟踪调试，以找到内核中出现的问题的根源，方便对其进行修复。另外，对内核感兴趣的读者还能够经过 ftrace 来观察内核中发生的活动，了解内核的工做机制。

让内核支持 ftrace

使用 ftrace ，首先要将其编译进内核。内核源码目录下的 kernel/trace/Makefile 文件给出了 ftrace 相关的编译选项。

清单 1. ftrace 相关的配置选项列表

CONFIG_FUNCTION_TRACER CONFIG_FUNCTION_GRAPH_TRACER CONFIG_CONTEXT_SWITCH_TRACER CONFIG_NOP_TRACER CONFIG_SCHED_TRACER ...

ftrace 相关的配置选项比较多，针对不一样的跟踪器有各自对应的配置选项。不一样的选项有不一样的依赖关系，内核源码目录下的 kernel/trace/Kconfig 文件描述了这些依赖关系。读者能够参考 Makefile 文件和 Konfig 文件，而后选中本身所须要的跟踪器。

一般在配置内核时，使用 make menuconfig 会更直观一些。以 2.6.33.1 版本的内核为例，要将 ftrace 编译进内核，能够选中 Kernel hacking （图 1 ）下的 Tracers 菜单项（图 2 ）。

图 1. Kernel hacking
 

图 2. Tracers
 

进入 Tracers 菜单下，能够看到内核支持的跟踪器列表。如图 3 所示，这里选中了全部的跟踪器，读者能够根据本身的须要选中特定的跟踪器。

图 3. 内核支持的跟踪器列表
 

这里要注意，若是是在 32 位 x86 机器上，编译时不要选中 General setup 菜单项（图 4 ）下的 Optimize for size 选项（图 5 ），不然就没法看到图 3 中的 Kernel Function Graph Tracer 选项。这是由于在 Konfig 文件中，针对 32 位 x86 机器，表项 FUNCTION_GRAPH_TRACER 有一个特殊的依赖条件：

depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE

图 4. General setup
 

图 5. Optimize for size
 

ftrace 经过 debugfs 向用户态提供了访问接口，因此还须要将 debugfs 编译进内核。激活对 debugfs 的支持，能够直接编辑内核配置文件 .config ，设置 CONFIG_DEBUG_FS=y ；或者在 make menuconfig 时到 Kernel hacking 菜单下选中对 debugfs 文件系统的支持，如图 6 所示。

图 6. debugfs 编译选项
 

配置完成后，编译安装新内核，而后启动到新内核。 注意，激活 ftrace 支持后，编译内核时会使用编译器的 -pg 选项，这是在 kernel/trace/Makefile 文件中定义的，如清单 2 所示。

清单 2. 激活编译选项 -pg

ifdef CONFIG_FUNCTION_TRACER ORIG_CFLAGS := $(KBUILD_CFLAGS) KBUILD_CFLAGS = $(subst -pg,,$(ORIG_CFLAGS)) ... endif ...

使用 -pg 选项会在编译获得的内核映像中加入大量的调试信息。通常状况下，只是在开发测试阶段激活 ftrace 支持，以调试内核，修复 bug 。最终用于发行版的内核则会关闭 -pg 选项，也就没法使用 ftrace。

回页首

经过 debugfs 访问 ftrace

ftrace 经过 debugfs 向用户态提供访问接口。配置内核时激活 debugfs 后会建立目录 /sys/kernel/debug ，debugfs 文件系统就是挂载到该目录。要挂载该目录，须要将以下内容添加到 /etc/fstab 文件：

debugfs /sys/kernel/debug debugfs defaults 0 0

或者能够在运行时挂载：

mount -t debugfs nodev /sys/kernel/debug

激活内核对 ftrace 的支持后会在 debugfs 下建立一个 tracing 目录 /sys/kernel/debug/tracing 。该目录下包含了 ftrace 的控制和输出文件，如图 7 所示。根据编译内核时针对 ftrace 的设定不一样，该目录下实际显示的文件和目录与这里也会不一样。

图 7. tracing 目录下的文件
 

回页首

ftrace 的数据文件

/sys/kernel/debug/trace 目录下文件和目录比较多，有些是各类跟踪器共享使用的，有些是特定于某个跟踪器使用的。在操做这些数据文件时，一般使用 echo 命令来修改其值，也能够在程序中经过文件读写相关的函数来操做这些文件的值。下面只对部分文件进行描述，读者能够参考内核源码包中 Documentation/trace 目录下的文档以及 kernel/trace 下的源文件以了解其他文件的用途。

• README文件提供了一个简短的使用说明，展现了 ftrace 的操做命令序列。能够经过 cat 命令查看该文件以了解概要的操做流程。
• current_tracer用于设置或显示当前使用的跟踪器；使用 echo 将跟踪器名字写入该文件能够切换到不一样的跟踪器。系统启动后，其缺省值为 nop ，即不作任何跟踪操做。在执行完一段跟踪任务后，能够经过向该文件写入 nop 来重置跟踪器。
• available_tracers记录了当前编译进内核的跟踪器的列表，能够经过 cat 查看其内容；其包含的跟踪器与图 3 中所激活的选项是对应的。写 current_tracer 文件时用到的跟踪器名字必须在该文件列出的跟踪器名字列表中。
• trace文件提供了查看获取到的跟踪信息的接口。能够经过 cat 等命令查看该文件以查看跟踪到的内核活动记录，也能够将其内容保存为记录文件以备后续查看。
• tracing_enabled用于控制 current_tracer 中的跟踪器是否能够跟踪内核函数的调用状况。写入 0 会关闭跟踪活动，写入 1 则激活跟踪功能；其缺省值为 1 。
• set_graph_function设置要清晰显示调用关系的函数，显示的信息结构相似于 C 语言代码，这样在分析内核运做流程时会更加直观一些。在使用 function_graph 跟踪器时使用；缺省为对全部函数都生成调用关系序列，能够经过写该文件来指定须要特别关注的函数。
• buffer_size_kb用于设置单个 CPU 所使用的跟踪缓存的大小。跟踪器会将跟踪到的信息写入缓存，每一个 CPU 的跟踪缓存是同样大的。跟踪缓存实现为环形缓冲区的形式，若是跟踪到的信息太多，则旧的信息会被新的跟踪信息覆盖掉。注意，要更改该文件的值须要先将 current_tracer 设置为 nop 才能够。
• tracing_on用于控制跟踪的暂停。有时候在观察到某些事件时想暂时关闭跟踪，能够将 0 写入该文件以中止跟踪，这样跟踪缓冲区中比较新的部分是与所关注的事件相关的；写入 1 能够继续跟踪。
• available_filter_functions记录了当前能够跟踪的内核函数。对于不在该文件中列出的函数，没法跟踪其活动。
• set_ftrace_filter和 set_ftrace_notrace在编译内核时配置了动态 ftrace （选中 CONFIG_DYNAMIC_FTRACE 选项）后使用。前者用于显示指定要跟踪的函数，后者则做用相反，用于指定不跟踪的函数。若是一个函数名同时出如今这两个文件中，则这个函数的执行情况不会被跟踪。这些文件还支持简单形式的含有通配符的表达式，这样能够用一个表达式一次指定多个目标函数；具体使用在后续文章中会有描述。注意，要写入这两个文件的函数名必须能够在文件 available_filter_functions 中看到。缺省为能够跟踪全部内核函数，文件 set_ftrace_notrace 的值则为空。

回页首

ftrace 跟踪器

ftrace 当前包含多个跟踪器，用于跟踪不一样类型的信息，好比进程调度、中断关闭等。能够查看文件 available_tracers 获取内核当前支持的跟踪器列表。在编译内核时，也能够看到内核支持的跟踪器对应的选项，如以前图 3 所示。

• nop跟踪器不会跟踪任何内核活动，将 nop 写入 current_tracer 文件能够删除以前所使用的跟踪器，并清空以前收集到的跟踪信息，即刷新 trace 文件。
• function跟踪器能够跟踪内核函数的执行状况；能够经过文件 set_ftrace_filter 显示指定要跟踪的函数。
• function_graph跟踪器能够显示相似 C 源码的函数调用关系图，这样查看起来比较直观一些；能够经过文件 set_grapch_function 显示指定要生成调用流程图的函数。
• sched_switch跟踪器能够对内核中的进程调度活动进行跟踪。
• irqsoff跟踪器和 preemptoff跟踪器分别跟踪关闭中断的代码和禁止进程抢占的代码，并记录关闭的最大时长，preemptirqsoff跟踪器则能够看作它们的组合。

ftrace 还支持其它一些跟踪器，好比 initcall、ksym_tracer、mmiotrace、sysprof 等。ftrace 框架支持扩展添加新的跟踪器。读者能够参考内核源码包中 Documentation/trace 目录下的文档以及 kernel/trace 下的源文件，以了解其它跟踪器的用途和如何添加新的跟踪器。

回页首

小结

本系列文章对 ftrace 的配置和使用进行了介绍。本文是其中的第一部分，介绍了 ftrace 的编译配置、用户态访问 ftrace 的接口和 ftrace 的数据文件，并对 ftrace 所提供的部分跟踪器的用途进行了描述。因为篇幅的限制，本文没有对 ftrace 的具体使用和如何在代码中与 ftrace 进行交互进行描述，这些内容将分别在本系列文章的后续篇章中给出。

参考资料

• 查看内核文档 Documentation/trace/ftrace.txt了解 ftrace。
  
  
• LWN上 ftrace 相关的文章。
  
  
• 查看内核文档 README了解如何编译内核。
  
  
• 查看内核文档目录 Documentation/kbuild/下的文档了解 Kconfig 和 kbuild。
  
  
• 查看内核目录 kernel/trace下的 Makefile文件和 Kconfig文件了解 ftrace 相关编译选项。
  
  
• 在 developerWorks Linux 专区 寻找为 Linux 开发人员（包括 Linux 新手入门）准备的更多参考资料，查阅咱们 最受欢迎的文章和教程。 
  
  
• 在 developerWorks 上查阅全部 Linux 技巧 和 Linux 教程。 
  
  

做者简介

王生辉，软件工程师。目前在 IBM 系统技术实验室从事 Linux for Power 方面的测试工做。

李骅宸，实习生。目前在 IBM 系统技术实验室从事 Linux for Power 方面的测试工做。