TRACE_EVENT 宏定义
TRACE_EVENT 组成
TRACE_EVENT 由六部分组成
TRACE_EVENT(name, proto, args, struct, assign, print)
- name 自定义跟踪点名称
- prototype 跟踪点的回调函数原型
- args 参数列表,与回调函数原型的参数一致
- struct 数据传送给跟踪点后,会继续赋值给 struct,跟踪器会使用这些数据,输出想要的调试信息(非必须)
- assign C 风格的赋值语句,用于将数据值赋予 struct
- print 以人类可读的形式输出调试信息
一个完整的 TRACE_EVENT 宏定义示例
TRACE_EVENT(sched_switch,
TP_PROTO(struct rq *rq, struct task_struct *prev,
struct task_struct *next),
TP_ARGS(rq, prev, next),
TP_STRUCT__entry(
__array( char, prev_comm, TASK_COMM_LEN )
__field( pid_t, prev_pid )
__field( int, prev_prio )
__field( long, prev_state )
__array( char, next_comm, TASK_COMM_LEN )
__field( pid_t, next_pid )
__field( int, next_prio )
),
TP_fast_assign(
memcpy(__entry->next_comm, next->comm, TASK_COMM_LEN);
__entry->prev_pid = prev->pid;
__entry->prev_prio = prev->prio;
__entry->prev_state = prev->state;
memcpy(__entry->prev_comm, prev->comm, TASK_COMM_LEN);
__entry->next_pid = next->pid;
__entry->next_prio = next->prio;
),
TP_printk("prev_comm=%s prev_pid=%d prev_prio=%d prev_state=%s ==> next_comm=%s next_pid=%d next_prio=%d",
__entry->prev_comm, __entry->prev_pid, __entry->prev_prio,
__entry->prev_state ?
__print_flags(__entry->prev_state, "|",
{ 1, "S"} , { 2, "D" }, { 4, "T" }, { 8, "t" },
{ 16, "Z" }, { 32, "X" }, { 64, "x" },
{ 128, "W" }) : "R",
__entry->next_comm, __entry->next_pid, __entry->next_prio)
);
TRACE_EVENT 除了第一部分 name 以外,所有参数都会被其它宏定义重新封装定义。
name
第一个参数是跟踪点名称:
TRACE_EVENT(sched_switch,
该参数通常用于内核调用跟踪点,实际上内核在调用跟踪点时使用的格式是 trace_<跟踪点名称> ,如: trace_sched_switch
prototype
第二个参数是跟踪点调用时的函数原型:
TP_PROTO(struct rq *rq, struct task_struct *prev, struct task_struct *next),
使用方式举例:
trace_sched_switch(struct rq *rq, struct task_struct *prev,
struct task_struct *next);
以上函数既是内核切入跟踪点的入口,也是跟踪点的回调函数入口。
Arguments
第三个参数是(跟踪点调用的)函数原型使用的参数
TP_ARGS(rq, prev, next),
第一眼看起来很奇怪,因为函数原型里已经定义了参数,这里又重新定义了一次,但实际上非但是语法的需要,还因为是底层宏定义的实现需要。当跟踪点函数启用时,会调用回调函数(一个跟踪点可以有多个回调函数),同时底层的宏定义需要同时访问函数原型和函数参数,所以就有这样的定义。
#define TRACE_POINT(name, proto, args) \
void trace_##name(proto) \
{ \
if (trace_##name##_active) \
callback(args); \
}
Structure
第 4 个参数略微复杂:
TP_STRUCT__entry(
__array( char, prev_comm, TASK_COMM_LEN )
__field( pid_t, prev_pid )
__field( int, prev_prio )
__field( long, prev_state )
__array( char, next_comm, TASK_COMM_LEN )
__field( pid_t, next_pid )
__field( int, next_prio )
),
以上内容的等效效果:
struct {
char prev_comm[TASK_COMM_LEN];
pid_t prev_pid;
int prev_prio;
long prev_state;
char next_comm[TASK_COMM_LEN];
pid_t next_pid;
int next_prio;
};
宏定义说明:
__field(type, name) 定义一个结构体内的元素,等同于 int var。类型为 int,变量为 var
__array(type, name, len) 定义一个结构体的数组元素,等效于 int name[len];类型为 int,数组名为 name,数组长度为 len.
数据结构说明:
以上结构的数据未来会写入 ring buffer,以便向用户展示内核的细节。数据结构中的每一个元素,都会用其它宏重新定义。注意每一行宏定义之间没有分隔符。
注意:
TP_STRUCT__entry 中定义的元素,其间距违反了 checkpatch.pl 所概述的规则。这是因为这些宏不是函数式的,而是用于定义结构。间距遵循结构间距而不是函数间距的规则,这样名称在结构声明中就会排成一行。
Assignment
第五个参数定义了将函数参数的值保存到环形缓冲区(ring buffer)的方式。
TP_fast_assign(
memcpy(__entry->next_comm, next->comm, TASK_COMM_LEN);
__entry->prev_pid = prev->pid;
__entry->prev_prio = prev->prio;
__entry->prev_state = prev->state;
memcpy(__entry->prev_comm, prev->comm, TASK_COMM_LEN);
__entry->next_pid = next->pid;
__entry->next_prio = next->prio;
),
TP_fast_assign 函数内部的代码是标准 C 代码。其中 _entry 代表了 TP_STRUCT__entry 定义的结构的指针。TP_fast_assign 目的就是给 TP_STRUCT__entry 结构中的元素赋值,用于赋值的元素,是 TP_PROTO 和 TP_ARGS 中定义的函数参数。
最后一个参数定义了如何使用 TP_STRUCT__entry 结构组织 printk()的输出信息。
TP_printk("prev_comm=%s prev_pid=%d prev_prio=%d prev_state=%s ==> " \
"next_comm=%s next_pid=%d next_prio=%d",
__entry->prev_comm, __entry->prev_pid, __entry->prev_prio,
__entry->prev_state ?
__print_flags(__entry->prev_state, "|",
{ 1, "S"} , { 2, "D" }, { 4, "T" }, { 8, "t" },
{ 16, "Z" }, { 32, "X" }, { 64, "x" },
{ 128, "W" }) : "R",
__entry->next_comm, __entry->next_pid, __entry->next_prio)
以上代码中 _entry 指代的是 TP_STRUCT__entry 结构体的指针,因为经由 TP_fast_assign 赋值,因此可以直接使用。TP_printk 的用法与普通 printf 一样。__print_flags 是 TRACE_EVENT() 自带的帮助函数。
Format 文件
sched_switch 跟踪点在debugfs 下存在 format 文件,位置:/sys/kernel/debug/tracing/events/sched/sched_switch/format
文件部分内容如下:
name: sched_switch
ID: 33
format:
field:unsigned short common_type; offset:0; size:2;
field:unsigned char common_flags; offset:2; size:1;
field:unsigned char common_preempt_count; offset:3; size:1;
field:int common_pid; offset:4; size:4;
field:int common_lock_depth; offset:8; size:4;
field:char prev_comm[TASK_COMM_LEN]; offset:12; size:16;
field:pid_t prev_pid; offset:28; size:4;
field:int prev_prio; offset:32; size:4;
field:long prev_state; offset:40; size:8;
field:char next_comm[TASK_COMM_LEN]; offset:48; size:16;
field:pid_t next_pid; offset:64; size:4;
field:int next_prio; offset:68; size:4;
print fmt: "task %s:%d [%d] (%s) ==> %s:%d [%d]", REC->prev_comm, REC->prev_pid,
REC->prev_prio, REC->prev_state ? __print_flags(REC->prev_state, "|", { 1, "S"} ,
{ 2, "D" }, { 4, "T" }, { 8, "t" }, { 16, "Z" }, { 32, "X" }, { 64, "x" }, { 128,
"W" }) : "R", REC->next_comm, REC->next_pid, REC->next_prio
tracepoint 使用方式
在使用 tracepoint 时必须先导入 trace header,同时必须定义 CREATE_TRACE_POINTS。
#define CREATE_TRACE_POINTS #include <trace/events/sched.h>
如果其它文件需要调用定义在 trace 文件中的跟踪点,只需要 include 该文件即可,不需要再次定义 CREATE_TRACE_POINTS,否则会导致内核报错,如:
#include <trace/events/sched.h>
跟踪点的使用方式就如函数调用,举例:
static inline void
context_switch(struct rq *rq, struct task_struct *prev,
struct task_struct *next)
{
struct mm_struct *mm, *oldmm;
prepare_task_switch(rq, prev, next);
trace_sched_switch(rq, prev, next);
mm = next->mm;
oldmm = prev->active_mm;
原文:
https://lwn.net/Articles/379903/

浙公网安备 33010602011771号