trace event updates for tip
Steven Rostedt
maintainerIngo,
Please pull the latest tip/tracing/ftrace tree, which can be found at:
git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-2.6-trace.git
tip/tracing/ftrace
Steven Rostedt (7):
tracing: add TRACE_FIELD_SPECIAL to record complex entries
tracing: add protection around modify trace event fields
tracing: make trace_seq_reset global and rename to trace_seq_init
tracing: add format file to describe event struct fields
tracing: add ftrace headers to event format files
tracing: add trace name and id to event formats
tracing: add print format to event trace format files
----
include/trace/sched_event_types.h | 7 ++- kernel/trace/trace.c | 17 ++----- kernel/trace/trace.h | 9 +++ kernel/trace/trace_events.c | 94 ++++++++++++++++++++++++++++++++++- kernel/trace/trace_events_stage_1.h | 2 + kernel/trace/trace_events_stage_2.h | 58 +++++++++++++++++++++ kernel/trace/trace_events_stage_3.h | 16 ++++++ 7 files changed, 188 insertions(+), 15 deletions(-)
Steven Rostedt
maintainerPATCH 1/7 tracing: add TRACE_FIELD_SPECIAL to record complex entries
From: Steven Rostedt <[email protected]>
Tom Zanussi pointed out that the simple TRACE_FIELD was not enough to record trace data that required memcpy. This patch addresses this issue by adding a TRACE_FIELD_SPECIAL. The format is similar to TRACE_FIELD but looks like so:
TRACE_FIELD_SPECIAL(type_item, item, cmd)
What TRACE_FIELD gave was:
TRACE_FIELD(type, item, assign)
The TRACE_FIELD would be used in declaring a structure:
struct {
type item;};
And later assign it via:
entry->item = assign;
What TRACE_FIELD_SPECIAL gives us is:
In the declaration of the structure:
struct {
type_item;};
And the assignment:
cmd;
This change log will explain the one example used in the patch:
TRACE_EVENT_FORMAT(sched_switch,
TPPROTO(struct rq *rq, struct task_struct *prev,
struct task_struct *next),
TPARGS(rq, prev, next),
TPFMT("task %s:%d ==> %s:%d",
prev->comm, prev->pid, next->comm, next->pid),
TRACE_STRUCT(
TRACE_FIELD(pid_t, prev_pid, prev->pid)
TRACE_FIELD(int, prev_prio, prev->prio)
TRACE_FIELD_SPECIAL(char next_comm[TASK_COMM_LEN],
next_comm,
TPCMD(memcpy(TRACE_ENTRY->next_comm,
next->comm,
TASK_COMM_LEN)))
TRACE_FIELD(pid_t, next_pid, next->pid)
TRACE_FIELD(int, next_prio, next->prio)
),
TPRAWFMT("prev %d:%d ==> next %s:%d:%d")
);The struct will be create as:
struct {
pid_t prev_pid;
int prev_prio;
char next_comm[TASK_COMM_LEN];
pid_t next_pid;
int next_prio;};
Note the TRACE_ENTRY in the cmd part of TRACE_SPECIAL. TRACE_ENTRY will be set by the tracer to point to the structure inside the trace buffer.
entry->prev_pid = prev->pid; entry->prev_prio = prev->prio; memcpy(entry->next_comm, next->comm, TASK_COMM_LEN); entry->next_pid = next->pid; entry->next_prio = next->prio
--- include/trace/sched_event_types.h | 7 ++++++- kernel/trace/trace_events_stage_1.h | 2 ++ kernel/trace/trace_events_stage_2.h | 4 ++++ kernel/trace/trace_events_stage_3.h | 14 ++++++++++++++ 4 files changed, 26 insertions(+), 1 deletions(-)
include/trace/sched_event_types.h +6 -1
@@ -71,10 +71,15 @@ TRACE_EVENT_FORMAT(sched_switch,TRACE_STRUCT ( TRACE_FIELD(pid_t, prev_pid, prev->pid) TRACE_FIELD(int, prev_prio, prev->prio) + TRACE_FIELD_SPECIAL(char next_comm[TASK_COMM_LEN], + next_comm, + TPCMD(memcpy(TRACE_ENTRY->next_comm, + next->comm, + TASK_COMM_LEN))) TRACE_FIELD(pid_t, next_pid, next->pid)TRACE_FIELD (int, next_prio, next->prio) ), -TPRAWFMT ("prev %d:%d ==> next %d:%d" ) +TPRAWFMT ("prev %d:%d ==> next %s:%d:%d" ) ); TRACE_EVENT_FORMAT(sched_migrate_task,
kernel/trace/trace_events_stage_1.h +2 -0
@@ -30,5 +30,7 @@#define TRACE_FIELD (type, item, assign) \ type item; +#define TRACE_FIELD_SPECIAL (type_item, item, cmd) \ + type_item;#include <trace/trace_event_types.h>
kernel/trace/trace_events_stage_2.h +4 -0
@@ -39,6 +39,10 @@#define TRACE_FIELD (type, item, assign) \ field->item, +#undef TRACE_FIELD_SPECIAL +#define TRACE_FIELD_SPECIAL (type_item, item, cmd) \ + field->item, +#undef TPRAWFMT #define TPRAWFMT(args...) args
kernel/trace/trace_events_stage_3.h +14 -0
@@ -147,6 +147,20 @@ __attribute__((section("_ftrace_events"))) event_##call = { \#define TRACE_FIELD (type, item, assign)\ entry->item = assign; +#undef TRACE_FIELD +#define TRACE_FIELD (type, item, assign)\ + entry->item = assign; + +#undef TPCMD +#define TPCMD(cmd...) cmd + +#undef TRACE_ENTRY +#define TRACE_ENTRY entry + +#undef TRACE_FIELD_SPECIAL +#define TRACE_FIELD_SPECIAL (type_item, item, cmd) \ + cmd; +#undef TRACE_EVENT_FORMAT#define TRACE_EVENT_FORMAT (call, proto, args, fmt, tstruct, tpfmt) \ _TRACE_FORMAT(call, PARAMS(proto), PARAMS(args), PARAMS(fmt)) \
Signature · 3 lines
1.5.6.5 --
Steven Rostedt
maintainerPATCH 2/7 tracing: add protection around modify trace event fields
In reply to Steven RostedtFrom: Steven Rostedt <[email protected]>
The trace event objects are currently not proctected against reentrancy. This patch adds a mutex around the modifications of the trace event fields.
--- kernel/trace/trace_events.c | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-)
kernel/trace/trace_events.c +7 -0
@@ -14,6 +14,8 @@#define TRACE_SYSTEM "TRACE_SYSTEM" +static DEFINE_MUTEX (event_mutex); +#define events_for_each (event) \ for (event = __start_ftrace_events; \ (unsigned long)event < (unsigned long)__stop_ftrace_events; \
@@ -104,6 +106,7 @@ static int ftrace_set_clr_event(char *buf, int set) event =NULL ; } +mutex_lock (&event_mutex);events_for_each (call) {if (!call->name)
@@ -124,6 +127,8 @@ static int ftrace_set_clr_event(char *buf, int set) ret =0 ; } +mutex_unlock (&event_mutex); +return ret; }
@@ -324,7 +329,9 @@ event_enable_write(struct file *filp, const char __user *ubuf, size_t cnt,switch (val) {case 0 :case 1 : +mutex_lock (&event_mutex);ftrace_event_enable_disable (call, val); +mutex_unlock (&event_mutex);break ;default :
Signature · 3 lines
1.5.6.5 --
Steven Rostedt
maintainerPATCH 3/7 tracing: make trace_seq_reset global and rename to trace_seq_init
In reply to Steven RostedtFrom: Steven Rostedt <[email protected]>
Impact: clean up
The trace_seq functions may be used separately outside of the ftrace iterator. The trace_seq_reset is needed for these operations.
This patch also renames trace_seq_reset to the more appropriate trace_seq_init.
--- kernel/trace/trace.c | 17 +++++------------ kernel/trace/trace.h | 8 ++++++++ 2 files changed, 13 insertions(+), 12 deletions(-)
kernel/trace/trace.c +5 -12
@@ -342,13 +342,6 @@ __update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu)tracing_record_cmdline (tsk); } -static void -trace_seq_reset (struct trace_seq *s) -{ - s->len =0 ; - s->readpos =0 ; -} -ssize_t trace_seq_to_user (struct trace_seq *s,char __user *ubuf,size_t cnt) {int len;
@@ -395,7 +388,7 @@ trace_print_seq(struct seq_file *m, struct trace_seq *s) s->buffer[len] =0 ;seq_puts (m, s->buffer); -trace_seq_reset (s); +trace_seq_init (s); }/**
@@ -2620,7 +2613,7 @@ tracing_read_pipe(struct file *filp, char __user *ubuf,if (sret != -EBUSY )return sret; -trace_seq_reset (&iter->seq); +trace_seq_init (&iter->seq);/* copy the tracer to avoid using a global lock all around */ mutex_lock (&trace_types_lock);
@@ -2682,7 +2675,7 @@ waitagain:/* Now copy what we have to the user */ sret =trace_seq_to_user (&iter->seq, ubuf, cnt);if (iter->seq.readpos >= iter->seq.len) -trace_seq_reset (&iter->seq); +trace_seq_init (&iter->seq);/* * If there was nothing to send to user, inspite of consuming trace
@@ -2819,7 +2812,7 @@ static ssize_t tracing_splice_read_pipe(struct file *filp, partial[i].offset =0 ; partial[i].len = iter->seq.len; -trace_seq_reset (&iter->seq); +trace_seq_init (&iter->seq); }mutex_unlock (&iter->mutex);
@@ -3631,7 +3624,7 @@ trace_printk_seq(struct trace_seq *s)printk (KERN_TRACE "%s" , s->buffer); -trace_seq_reset (s); +trace_seq_init (s); }void ftrace_dump (void )
kernel/trace/trace.h +8 -0
@@ -395,6 +395,14 @@ struct trace_seq {unsigned int readpos; }; +static inline void +trace_seq_init (struct trace_seq *s) +{ + s->len =0 ; + s->readpos =0 ; +} + +#define TRACE_PIPE_ALL_CPU -1/*
Signature · 3 lines
1.5.6.5 --
Steven Rostedt
maintainerPATCH 4/7 tracing: add format file to describe event struct fields
In reply to Steven RostedtFrom: Steven Rostedt <[email protected]>
This patch adds the "format" file to the trace point event directory. This is based off of work by Tom Zanussi, in which a file is exported to be tread from user land such that a user space app may read the binary record stored in the ring buffer.
# cat /debug/tracing/events/sched/sched_switch/format
field:pid_t prev_pid; offset:12; size:4;
field:int prev_prio; offset:16; size:4;
field special:char next_comm[TASK_COMM_LEN]; offset:20; size:16;
field:pid_t next_pid; offset:36; size:4;
field:int next_prio; offset:40; size:4;Idea-from: Tom Zanussi <[email protected]>
--- kernel/trace/trace.h | 1 + kernel/trace/trace_events.c | 56 ++++++++++++++++++++++++++++++++++- kernel/trace/trace_events_stage_2.h | 52 ++++++++++++++++++++++++++++++++ kernel/trace/trace_events_stage_3.h | 2 + 4 files changed, 110 insertions(+), 1 deletions(-)
kernel/trace/trace.h +1 -0
@@ -754,6 +754,7 @@ struct ftrace_event_call {int (*raw_init)(void );int (*raw_reg)(void );void (*raw_unreg)(void ); +int (*show_format)(struct trace_seq *s); };void event_trace_printk (unsigned long ip,const char *fmt, ...);
kernel/trace/trace_events.c +55 -1
80 lines not on this page · raw message
kernel/trace/trace_events_stage_2.h +52 -0
55 lines not on this page · raw message
kernel/trace/trace_events_stage_3.h +2 -0
@@ -101,6 +101,7 @@* .raw_init = ftrace_raw_init_event_<call>, * .raw_reg = ftrace_raw_reg_event_<call>, * .raw_unreg = ftrace_raw_unreg_event_<call>, +* .show_format = ftrace_format_<call>, * } * */
@@ -230,4 +231,5 @@ __attribute__((section("_ftrace_events"))) event_##call = { \ .raw_init = ftrace_raw_init_event_##call, \ .raw_reg = ftrace_raw_reg_event_##call, \ .raw_unreg = ftrace_raw_unreg_event_##call, \ + .show_format = ftrace_format_##call, \ }
Signature · 3 lines
1.5.6.5 --
Re: [PATCH 4/7] tracing: add format file to describe event struct fields
Quoted 5 lines · On Mon, 02 Mar 2009 15:29:29 -0500 Steven Rostedt <[email protected]> wrote:
From: Steven Rostedt <[email protected]>
This patch adds the "format" file to the trace point event directory. This is based off of work by Tom Zanussi, in which a file is exported to be tread from user land such that a user space app may read the
s/tread/read/
kernel/trace/trace_events.c line 7
Quoted 12 lines
binary record stored in the ring buffer.
...
kernel/trace/trace_events.c +2
-0@@ -3,6 +3,9 @@* * Copyright (C) 2008 Red Hat Inc, Steven Rostedt <[email protected]> * +* - Added format output of fields of the trace point. +* This was based off of work by Tom Zanussi <[email protected]>.
ick. "based on"
Quoted 15 lines
kernel/trace/trace_events.c +8
-0+* */ #include <linux/debugfs.h> @@ -444,6 +447,42 @@ event_available_types_read(struct file *filp, char __user *ubuf, size_t cnt,return simple_read_from_buffer (ubuf, cnt, ppos, buf, r); } +static ssize_t +event_format_read (struct file *filp,char __user *ubuf,size_t cnt, +loff_t *ppos) +{ +struct ftrace_event_call *call = filp->private_data; +struct trace_seq *s; +char *buf;
kernel/trace/trace_events.c event_available_types_read(struct file *filp, char __user *ubuf, size_t cnt, · line 466
Quoted 10 lines
kernel/trace/trace_events.c +10
-0+int r; + + s =kmalloc (sizeof (*s),GFP_KERNEL ); +if (!s) +return -ENOMEM ; + +trace_seq_init (s); + +if (*ppos) +return 0 ;
Someone get this man a bucket!
Quoted 17 lines
kernel/trace/trace_events.c +17
-0+ r = call->show_format (s); +if (!r) { +/* +* ug! The format output is bigger than a PAGE!! +*/ + buf ="FORMAT TOO BIG\n" ; + r =simple_read_from_buffer (ubuf, cnt, ppos, + buf,strlen (buf)); + goto out; + } + + r =simple_read_from_buffer (ubuf, cnt, ppos, + s->buffer, s->len); + out: +kfree (s); +return r; +}
Steven Rostedt
maintainerPATCH 5/7 tracing: add ftrace headers to event format files
In reply to Steven RostedtFrom: Steven Rostedt <[email protected]>
This patch includes the ftrace header to the event formats files:
# cat /debug/tracing/events/sched/sched_switch/format
field:unsigned char type; offset:0; size:1;
field:unsigned char flags; offset:1; size:1;
field:unsigned char preempt_count; offset:2; size:1;
field:int pid; offset:4; size:4;
field:int tgid; offset:8; size:4; field:pid_t prev_pid; offset:12; size:4;
field:int prev_prio; offset:16; size:4;
field special:char next_comm[TASK_COMM_LEN]; offset:20; size:16;
field:pid_t next_pid; offset:36; size:4;
field:int next_prio; offset:40; size:4;A blank line is used as a deliminator between the ftrace header and the trace point fields.
--- kernel/trace/trace_events.c | 27 ++++++++++++++++++++++++++- 1 files changed, 26 insertions(+), 1 deletions(-)
kernel/trace/trace_events.c +26 -1
@@ -13,7 +13,7 @@#include <linux/module.h> #include <linux/ctype.h> -#include "trace.h" +#include "trace_output.h" #define TRACE_SYSTEM "TRACE_SYSTEM"
@@ -447,6 +447,28 @@ event_available_types_read(struct file *filp, char __user *ubuf, size_t cnt,return simple_read_from_buffer (ubuf, cnt, ppos, buf, r); } +#undef FIELD +#define FIELD (type, name) \ + #type, #name, offsetof(typeof(field), name), sizeof(field.name) + +static int trace_write_header (struct trace_seq *s) +{ +struct trace_entry field; + +/* struct trace_entry */ +return trace_seq_printf (s, +"\tfield:%s %s;\toffset:%lu;\tsize:%lu;\n" +"\tfield:%s %s;\toffset:%lu;\tsize:%lu;\n" +"\tfield:%s %s;\toffset:%lu;\tsize:%lu;\n" +"\tfield:%s %s;\toffset:%lu;\tsize:%lu;\n" +"\tfield:%s %s;\toffset:%lu;\tsize:%lu;\n" +"\n" , + FIELD(unsigned char, type), + FIELD(unsigned char, flags), + FIELD(unsigned char, preempt_count), +FIELD (int, pid), +FIELD (int, tgid)); +}static ssize_t event_format_read (struct file *filp,char __user *ubuf,size_t cnt,loff_t *ppos)
@@ -465,6 +487,9 @@ event_format_read(struct file *filp, char __user *ubuf, size_t cnt,if (*ppos)return 0 ; +/* If this fails, so will the show_format. */ +trace_write_header (s); + r = call->show_format (s);if (!r) {/*
Signature · 3 lines
1.5.6.5 --
Steven Rostedt
maintainerPATCH 6/7 tracing: add trace name and id to event formats
In reply to Steven RostedtFrom: Steven Rostedt <[email protected]>
To be able to identify the trace in the binary format output, the id of the trace event (which is dynamically assigned) must also be listed.
This patch adds the name of the trace point as well as the id assigned.
--- kernel/trace/trace_events.c | 6 +++++- 1 files changed, 5 insertions(+), 1 deletions(-)
kernel/trace/trace_events.c +5 -1
@@ -487,7 +487,11 @@ event_format_read(struct file *filp, char __user *ubuf, size_t cnt,if (*ppos)return 0 ; -/* If this fails, so will the show_format. */ +/* If any of the first writes fail, so will the show_format. */ + +trace_seq_printf (s,"name: %s\n" , call->name); +trace_seq_printf (s,"ID: %d\n" , call->id); +trace_seq_printf (s,"format:\n" );trace_write_header (s); r = call->show_format (s);
Signature · 3 lines
1.5.6.5 --
Steven Rostedt
maintainerPATCH 7/7 tracing: add print format to event trace format files
In reply to Steven RostedtFrom: Steven Rostedt <[email protected]>
This patch adds the internal print format used to print the raw events to the event trace point format file.
# cat /debug/tracing/events/sched/sched_switch/format
name: sched_switch
ID: 29
format:
field:unsigned char type; offset:0; size:1;
field:unsigned char flags; offset:1; size:1;
field:unsigned char preempt_count; offset:2; size:1;
field:int pid; offset:4; size:4;
field:int tgid; offset:8; size:4; field:pid_t prev_pid; offset:12; size:4;
field:int prev_prio; offset:16; size:4;
field special:char next_comm[TASK_COMM_LEN]; offset:20; size:16;
field:pid_t next_pid; offset:36; size:4;
field:int next_prio; offset:40; size:4;print fmt: "prev %d:%d ==> next %s:%d:%d"
--- kernel/trace/trace_events_stage_2.h | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)
kernel/trace/trace_events_stage_2.h +2 -0
@@ -122,6 +122,8 @@ ftrace_format_##call(struct trace_seq *s) \ \ tstruct; \ \ +trace_seq_printf (s,"\nprint fmt: \"%s\"\n" , tpfmt); \ + \return ret; \ }
Signature · 3 lines
1.5.6.5 --