tracing: Add triggers to trace_marker writes
Subsystems (4)
Steven Rostedt
maintainerv2 cover tracing: Add triggers to trace_marker writes
A few people have asked for this in the past, and I finally got around to implementing it. What this does is to allow writes into trace_marker to initiate a trigger.
The trace_marker event is described in:
tracefs/events/ftrace/print
Thus the trigger file is added there:
tracefs/events/ftrace/print/trigger
As there's already a "hist" file there, everything appears to work just like any other trigger to an event. See the last patch for documentation on how to use the triggers to a trace_marker write.
By the way, the patch:
tracing: Prevent further users of zero size static arrays in trace events
May prevent your kernel from building if you include Xen. You will need to add this patch to make it work.
http://lkml.kernel.org/r/[email protected]
git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace.git
ftrace/core
Head SHA1: a3762cfaa4e4b141aa53d3053f38a9cdd47ea49b
Steven Rostedt (VMware) (14):
tracing: Do not reference event data in post call triggers
tracing: Add __find_event_file() to find event files without restrictions
tracing: Have event_trace_init() called by trace_init_tracefs()
tracing: Add brackets in ftrace event dynamic arrays
tracing: Do not show filter file for ftrace internal events
tracing: Add trigger file for trace_markers tracefs/ftrace/print
tracing: Have zero size length in filter logic be full string
tracing: Prevent further users of zero size static arrays in trace events
tracing: Allow histogram triggers to access ftrace internal events
tracing: Document trace_marker triggers
ftrace/selftest: Have the reset_trigger code be a bit more careful ftrace/selftest: Fix reset_trigger() to handle triggers with filters tracing/selftest: Add selftests to test trace_marker histogram triggers tracing/selftest: Add test to test hist trigger between kernel event and trace_marker
----
Changes since v1:
- Fixed comment about length (Masami Hiramatsu)
- Added note about ->reg() requiremet (Namhyung Kim)
- Added fix for r->len (Yann Ylavic)
- Added fixes for reset_trigger in ftrace self test
- Added self tests to test the trace_marker triggers
Documentation/trace/events.rst | 6 +- Documentation/trace/ftrace.rst | 5 + Documentation/trace/histogram.txt | 546 ++++++++++++++++++++- include/linux/trace_events.h | 3 +- include/trace/trace_events.h | 1 + kernel/trace/trace.c | 19 + kernel/trace/trace.h | 9 +- kernel/trace/trace_entries.h | 6 +- kernel/trace/trace_events.c | 36 +- kernel/trace/trace_events_filter.c | 23 +- kernel/trace/trace_events_hist.c | 2 +- kernel/trace/trace_events_trigger.c | 6 +- kernel/trace/trace_export.c | 9 +- tools/testing/selftests/ftrace/test.d/functions | 23 +- .../trigger/trigger-trace-marker-synthetic.tc | 88 ++++ .../ftrace/test.d/trigger/trigger-trace-marker.tc | 49 ++ 16 files changed, 790 insertions(+), 41 deletions(-) create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc
Steven Rostedt
maintainerPATCH v2 1/14 tracing: Do not reference event data in post call triggers
From: "Steven Rostedt (VMware)" <[email protected]>
Trace event triggers can be called before or after the event has been committed. If it has been called after the commit, there's a possibility that the event no longer exists. Currently, the two post callers is the trigger to disable tracing (traceoff) and the one that will record a stack dump (stacktrace). Neither of them reference the trace event entry record, as that would lead to a race condition that could pass in corrupted data.
To prevent any other users of the post data triggers from using the trace event record, pass in NULL to the post call trigger functions for the event record, as they should never need to use them in the first place.
This does not fix any bug, but prevents bugs from happening by new post call trigger users.
--- include/linux/trace_events.h | 3 +-- kernel/trace/trace.h | 4 ++-- kernel/trace/trace_events_trigger.c | 6 ++---- 3 files changed, 5 insertions(+), 8 deletions(-)
include/linux/trace_events.h +1 -2
@@ -435,8 +435,7 @@ event_triggers_call(struct trace_event_file *file, void *rec, struct ring_buffer_event *event);extern void event_triggers_post_call (struct trace_event_file *file, -enum event_trigger_type tt, -void *rec,struct ring_buffer_event *event); +enum event_trigger_type tt);bool trace_event_ignore_this_pid (struct trace_event_file *trace_file);
kernel/trace/trace.h +2 -2
@@ -1334,7 +1334,7 @@ event_trigger_unlock_commit(struct trace_event_file *file,trace_buffer_unlock_commit (file->tr, buffer, event, irq_flags, pc);if (tt) -event_triggers_post_call (file, tt, entry, event); +event_triggers_post_call (file, tt); }/**
@@ -1367,7 +1367,7 @@ event_trigger_unlock_commit_regs(struct trace_event_file *file, irq_flags, pc, regs);if (tt) -event_triggers_post_call (file, tt, entry, event); +event_triggers_post_call (file, tt); }#define FILTER_PRED_INVALID ((unsigned short)-1)
kernel/trace/trace_events_trigger.c +2 -4
@@ -97,7 +97,6 @@ EXPORT_SYMBOL_GPL(event_triggers_call);* event_triggers_post_call - Call 'post_triggers' for a trace event * @file: The trace_event_file associated with the event * @tt: enum event_trigger_type containing a set bit for each trigger to invoke -* @rec: The trace entry for the event * * For each trigger associated with an event, invoke the trigger * function registered with the associated trigger command, if the
@@ -108,8 +107,7 @@ EXPORT_SYMBOL_GPL(event_triggers_call);*/ void event_triggers_post_call (struct trace_event_file *file, -enum event_trigger_type tt, -void *rec,struct ring_buffer_event *event) +enum event_trigger_type tt) {struct event_trigger_data *data;
@@ -117,7 +115,7 @@ event_triggers_post_call(struct trace_event_file *file,if (data->paused)continue ;if (data->cmd_ops->trigger_type & tt) - data->ops->func (data, rec, event); + data->ops->func (data,NULL ,NULL ); } }EXPORT_SYMBOL_GPL (event_triggers_post_call);
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 2/14 tracing: Add __find_event_file() to find event files without restrictions
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
By adding the function __find_event_file() that can search for files without restrictions, such as if the event associated with the file has a reg function, or if it has the "ignore" flag set, the files that are associated to ftrace internal events (like trace_marker and function events) can be found and used.
find_event_file() still returns a "filtered" file, as most callers need a valid trace event file. One created by the trace_events.h macros and not one created for parsing ftrace specific events.
--- kernel/trace/trace.h | 3 +++ kernel/trace/trace_events.c | 22 +++++++++++++++++----- 2 files changed, 20 insertions(+), 5 deletions(-)
kernel/trace/trace.h +3 -0
@@ -1454,6 +1454,9 @@ extern void trace_event_enable_tgid_record(bool enable);extern int event_trace_add_tracer (struct dentry *parent,struct trace_array *tr);extern int event_trace_del_tracer (struct trace_array *tr); +extern struct trace_event_file *__find_event_file (struct trace_array *tr, +const char *system, +const char *event);extern struct trace_event_file *find_event_file (struct trace_array *tr,const char *system,const char *event);
kernel/trace/trace_events.c +17 -5
@@ -2473,8 +2473,9 @@ __trace_add_event_dirs(struct trace_array *tr) } } +/* Returns any file that matches the system and event */ struct trace_event_file * -find_event_file (struct trace_array *tr,const char *system,const char *event) +__find_event_file (struct trace_array *tr,const char *system,const char *event) {struct trace_event_file *file;struct trace_event_call *call;
@@ -2485,10 +2486,7 @@ find_event_file(struct trace_array *tr, const char *system, const char *event) call = file->event_call; name =trace_event_name (call); -if (!name || !call->class || !call->class->reg) -continue ; - -if (call->flags &TRACE_EVENT_FL_IGNORE_ENABLE ) +if (!name || !call->class)continue ; if (strcmp(event, name) == 0 &&
@@ -2498,6 +2496,20 @@ find_event_file(struct trace_array *tr, const char *system, const char *event)return NULL ; } +/* Returns valid trace event files that match system and event */ +struct trace_event_file * +find_event_file (struct trace_array *tr,const char *system,const char *event) +{ +struct trace_event_file *file; + + file =__find_event_file (tr, system, event); +if (!file || !file->event_call->class->reg || + file->event_call->flags &TRACE_EVENT_FL_IGNORE_ENABLE ) +return NULL ; + +return file; +} +#ifdef CONFIG_DYNAMIC_FTRACE /* Avoid typos */
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 3/14 tracing: Have event_trace_init() called by trace_init_tracefs()
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
Instead of having both trace_init_tracefs() and event_trace_init() be called by fs_initcall() routines, have event_trace_init() called directly by trace_init_tracefs(). This will guarantee order of how the events are created with respect to the rest of the ftrace infrastructure. This is needed to be able to assoctiate event files with ftrace internal events, such as the trace_marker.
--- kernel/trace/trace.c | 2 ++ kernel/trace/trace.h | 1 + kernel/trace/trace_events.c | 4 +--- 3 files changed, 4 insertions(+), 3 deletions(-)
kernel/trace/trace.c +2 -0
@@ -8111,6 +8111,8 @@ static __init int tracer_init_tracefs(void)if (IS_ERR (d_tracer))return 0 ; +event_trace_init (); +init_tracer_tracefs (&global_trace, d_tracer);ftrace_init_tracefs_toplevel (&global_trace, d_tracer);
kernel/trace/trace.h +1 -0
@@ -1451,6 +1451,7 @@ trace_find_event_field(struct trace_event_call *call, char *name);extern void trace_event_enable_cmd_record (bool enable);extern void trace_event_enable_tgid_record (bool enable); +extern int event_trace_init (void );extern int event_trace_add_tracer (struct dentry *parent,struct trace_array *tr);extern int event_trace_del_tracer (struct trace_array *tr);
kernel/trace/trace_events.c +1 -3
@@ -3144,7 +3144,7 @@ static __init int event_trace_enable_again(void)early_initcall (event_trace_enable_again); -static __init int event_trace_init (void ) +__init int event_trace_init (void ) {struct trace_array *tr;struct dentry *d_tracer;
@@ -3189,8 +3189,6 @@ void __init trace_event_init(void)event_trace_enable (); } -fs_initcall (event_trace_init); -#ifdef CONFIG_FTRACE_STARTUP_TEST static DEFINE_SPINLOCK (test_spinlock);
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 4/14 tracing: Add brackets in ftrace event dynamic arrays
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
The dynamic arrays defined for ftrace internal events, such as the buf field for trace_marker (ftrace/print) did not have brackets which makes the filter code not accept it as a string. This is not currently an issues because the filter code doesn't do anything for these events, but they will in the future, and this needs to be fixed for when it does.
--- kernel/trace/trace_export.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/trace/trace_export.c +1 -1
@@ -117,7 +117,7 @@ static void __always_unused ____ftrace_check_##name(void) \#undef __dynamic_array#define __dynamic_array (type, item) \ - ret = trace_define_field(event_call, #type, #item, \ + ret = trace_define_field(event_call, #type "[]", #item, \ offsetof(typeof(field), item), \ 0, is_signed_type(type), filter_type);\ if (ret) \
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 5/14 tracing: Do not show filter file for ftrace internal events
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
The filter file in the ftrace internal events, like in /sys/kernel/tracing/events/ftrace/function/filter is not attached to any functionality. Do not create them as they are meaningless.
In the future, if an ftrace internal event gets filter functionality, then it will need to create it directly.
--- kernel/trace/trace_events.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
kernel/trace/trace_events.c +6 -4
@@ -2007,16 +2007,18 @@ event_create_dir(struct dentry *parent, struct trace_event_file *file)return -1 ; } } -trace_create_file ("filter" ,0644 , file->dir, file, - &ftrace_event_filter_fops);/* * Only event directories that can be enabled should have -* triggers. +* triggers or filters. */ -if (!(call->flags &TRACE_EVENT_FL_IGNORE_ENABLE )) +if (!(call->flags &TRACE_EVENT_FL_IGNORE_ENABLE )) { +trace_create_file ("filter" ,0644 , file->dir, file, + &ftrace_event_filter_fops); +trace_create_file ("trigger" ,0644 , file->dir, file, &event_trigger_fops); + }#ifdef CONFIG_HIST_TRIGGERS trace_create_file("hist", 0444, file->dir, file,
Signature · 1 line
2.17.0
Re: [PATCH v2 05/14] tracing: Do not show filter file for ftrace internal events
Quoted 31 lines · Steven Rostedt
From: "Steven Rostedt (VMware)" <[email protected]>
The filter file in the ftrace internal events, like in
/sys/kernel/tracing/events/ftrace/function/filteris not attached to any functionality. Do not create them as they are meaningless.In the future, if an ftrace internal event gets filter functionality, then it will need to create it directly.
Signed-off-by Steven Rostedt (VMware) <[email protected]>--- kernel/trace/trace_events.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)kernel/trace/trace_events.c +1
-4@@ -2007,16 +2007,18 @@ event_create_dir(struct dentry *parent, struct trace_event_file *file)return -1 ; } } -trace_create_file ("filter" ,0644 , file->dir, file, - &ftrace_event_filter_fops);/* * Only event directories that can be enabled should have -* triggers. +* triggers or filters. */ -if (!(call->flags &TRACE_EVENT_FL_IGNORE_ENABLE ))
kernel/trace/trace_events.c event_create_dir(struct dentry *parent, struct trace_event_file *file) · line 2024
Quoted 10 lines
kernel/trace/trace_events.c +5
-0+if (!(call->flags &TRACE_EVENT_FL_IGNORE_ENABLE )) { +trace_create_file ("filter" ,0644 , file->dir, file, + &ftrace_event_filter_fops); +trace_create_file ("trigger" ,0644 , file->dir, file, &event_trigger_fops); + }#ifdef CONFIG_HIST_TRIGGERS trace_create_file("hist", 0444, file->dir, file,
What about moving the "hist" file as well since it's meaningless without the trigger.
Thanks,
Namhyung
Steven Rostedt
maintainerRe: [PATCH v2 05/14] tracing: Do not show filter file for ftrace internal events
Quoted 14 lines · On Wed, 16 May 2018 18:10:25 +0900 Namhyung Kim <[email protected]> wrote:
Quoted 14 lines
kernel/trace/trace_events.c +6
-2/* * Only event directories that can be enabled should have -* triggers. +* triggers or filters. */ -if (!(call->flags &TRACE_EVENT_FL_IGNORE_ENABLE )) +if (!(call->flags &TRACE_EVENT_FL_IGNORE_ENABLE )) { +trace_create_file ("filter" ,0644 , file->dir, file, + &ftrace_event_filter_fops); +trace_create_file ("trigger" ,0644 , file->dir, file, &event_trigger_fops); + }
Quoted 5 lines
Quoted 2 lines
#ifdef
CONFIG_HIST_TRIGGERS
trace_create_file("hist", 0444,file->dir, file,What about moving the "hist" file as well since it's meaningless without the trigger.
I thought about doing this too. But when I had to manually create the trigger file, I'll have to also manually create the hist file. As the hist file is read only and rather harmless, I figured I'd just leave it as is. The filter file is a command file and this patch wants to remove the confusion of writing into the file and having no effect.
-- Steve
Steven Rostedt
maintainerPATCH v2 6/14 tracing: Add trigger file for trace_markers tracefs/ftrace/print
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
Allow writing to the trace_markers file initiate triggers defined in tracefs/ftrace/print/trigger file. This will allow of user space to trigger the same type of triggers (including histograms) that the trace events use.
Had to create a ftrace_event_register() function that will become the trace_marker print event's reg() function. This is required because of how triggers are enabled:
event_trigger_write() {
event_trigger_regex_write() {
trigger_process_regex() {
for p in trigger_commands {
p->func(); /* trigger_snapshot_cmd->func */
event_trigger_callback() {
cmd_ops->reg() /* register_trigger() */ {
trace_event_trigger_enable_disable() {
trace_event_enable_disable() {
call->class->reg();Without the reg() function, the trigger code will call a NULL pointer and crash the system.
--- kernel/trace/trace.c | 17 +++++++++++++++++ kernel/trace/trace.h | 1 + kernel/trace/trace_entries.h | 6 ++++-- kernel/trace/trace_export.c | 7 +++++++ 4 files changed, 29 insertions(+), 2 deletions(-)
kernel/trace/trace.c +17 -0
@@ -6074,6 +6074,7 @@ tracing_mark_write(struct file *filp, const char __user *ubuf, {struct trace_array *tr = filp->private_data;struct ring_buffer_event *event; +enum event_trigger_type tt =ETT_NONE ;struct ring_buffer *buffer;struct print_entry *entry;unsigned long irq_flags;
@@ -6122,6 +6123,12 @@ tracing_mark_write(struct file *filp, const char __user *ubuf, written = cnt; len = cnt; +if (tr->trace_marker_file && !list_empty (&tr->trace_marker_file->triggers)) { +/* do not add \n before testing triggers, but add \0 */ + entry->buf[cnt] ='\0' ; + tt =event_triggers_call (tr->trace_marker_file, entry, event); + } +if (entry->buf[cnt -1 ] !='\n' ) { entry->buf[cnt] ='\n' ; entry->buf[cnt +1 ] ='\0' ;
@@ -6130,6 +6137,9 @@ tracing_mark_write(struct file *filp, const char __user *ubuf,__buffer_unlock_commit (buffer, event); +if (tt) +event_triggers_post_call (tr->trace_marker_file, tt); +if (written >0 ) *fpos += written;
@@ -7896,6 +7906,7 @@ static __init void create_trace_instances(struct dentry *d_tracer)static void init_tracer_tracefs (struct trace_array *tr,struct dentry *d_tracer) { +struct trace_event_file *file;int cpu; trace_create_file("available_tracers", 0444, d_tracer,
@@ -7928,6 +7939,12 @@ init_tracer_tracefs(struct trace_array *tr, struct dentry *d_tracer)trace_create_file ("trace_marker" ,0220 , d_tracer, tr, &tracing_mark_fops); + file =__find_event_file (tr,"ftrace" ,"print" ); +if (file && file->dir) +trace_create_file ("trigger" ,0644 , file->dir, file, + &event_trigger_fops); + tr->trace_marker_file = file; +trace_create_file ("trace_marker_raw" ,0220 , d_tracer, tr, &tracing_mark_raw_fops);
kernel/trace/trace.h +1 -0
@@ -259,6 +259,7 @@ struct trace_array {struct trace_options *topts;struct list_head systems;struct list_head events; +struct trace_event_file *trace_marker_file;cpumask_var_t tracing_cpumask;/* only trace on set CPUs */ int ref;#ifdef CONFIG_FUNCTION_TRACER
kernel/trace/trace_entries.h +4 -2
@@ -230,7 +230,7 @@ FTRACE_ENTRY(bprint, bprint_entry,FILTER_OTHER ); -FTRACE_ENTRY(print, print_entry, +FTRACE_ENTRY_REG(print, print_entry, TRACE_PRINT,
@@ -242,7 +242,9 @@ FTRACE_ENTRY(print, print_entry,F_printk ("%ps: %s" , (void *)__entry->ip, __entry->buf), -FILTER_OTHER +FILTER_OTHER , + + ftrace_event_register ); FTRACE_ENTRY(raw_data, raw_data_entry,
kernel/trace/trace_export.c +7 -0
@@ -14,6 +14,13 @@#include "trace_output.h" +/* Stub function for events with triggers */ +static int ftrace_event_register (struct trace_event_call *call, +enum trace_reg type,void *data) +{ +return 0 ; +} +#undef TRACE_SYSTEM#define TRACE_SYSTEM ftrace
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 7/14 tracing: Have zero size length in filter logic be full string
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
As strings in trace events may not have a nul terminating character, the filter string compares use the defined string length for the field for the compares.
The trace_marker records data slightly different than do normal events. It's size is zero, meaning that the string is the rest of the array, and that the string also ends with '\0'.
If the size is zero, assume that the string is nul terminated and read the string in question as is.
--- kernel/trace/trace_events_filter.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
kernel/trace/trace_events_filter.c +12 -11
@@ -750,31 +750,32 @@ static int filter_pred_none(struct filter_pred *pred, void *event)* * Note: * - @str might not be NULL-terminated if it's of type DYN_STRING -* or STATIC_STRING +* or STATIC_STRING, unless @len is zero. */ static int regex_match_full (char *str,struct regex *r,int len) { -if (strncmp (str, r->pattern, len) ==0 ) -return 1 ; -return 0 ; +/* len of zero means str is dynamic and ends with '\0' */ +if (!len) +return strcmp (str, r->pattern) ==0 ; + +return strncmp (str, r->pattern, len) ==0 ; }static int regex_match_front (char *str,struct regex *r,int len) { -if (len < r->len) +if (len && len < r->len)return 0 ; -if (strncmp (str, r->pattern, r->len) ==0 ) -return 1 ; -return 0 ; +return strncmp (str, r->pattern, r->len) ==0 ; }static int regex_match_middle (char *str,struct regex *r,int len) { -if (strnstr (str, r->pattern, len)) -return 1 ; -return 0 ; +if (!len) +return strstr (str, r->pattern) !=NULL ; + +return strnstr (str, r->pattern, len) !=NULL ; }static int regex_match_end (char *str,struct regex *r,int len)
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 8/14 tracing: Prevent further users of zero size static arrays in trace events
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
A zero size static array has special meaning in the ftrace infrastructure. Trace events are for recording data in the trace buffers that is normally difficult to obtain via probes or function tracing. There is no reason for any trace event to declare a zero size static array.
If one does, BUILD_BUG_ON() will trigger and prevent the kernel from compiling.
--- include/trace/trace_events.h | 1 + 1 file changed, 1 insertion(+)
include/trace/trace_events.h +1 -0
@@ -422,6 +422,7 @@ static struct trace_event_functions trace_event_type_funcs_##call = { \ do { \ char *type_str = #type"["__stringify(len)"]"; \ BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \ + BUILD_BUG_ON(len <= 0); \ ret = trace_define_field(event_call, type_str, #item, \ offsetof(typeof(field), item), \ sizeof(field.item), \
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 9/14 tracing: Allow histogram triggers to access ftrace internal events
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
Now that trace_marker can have triggers, including a histogram triggers, the onmatch() and onmax() access the trace event. To do so, the search routine to find the event file needs to use the raw __find_event_file() that does not filter out ftrace events.
--- kernel/trace/trace_events_hist.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/trace/trace_events_hist.c +1 -1
@@ -2865,7 +2865,7 @@ static struct trace_event_file *event_file(struct trace_array *tr, {struct trace_event_file *file; - file =find_event_file (tr, system, event_name); + file =__find_event_file (tr, system, event_name);if (!file)return ERR_PTR (-EINVAL );
Signature · 1 line
2.17.0
Steven Rostedt
maintainerPATCH v2 10/14 tracing: Document trace_marker triggers
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
Add documentation and an example on how to use trace_marker triggers.
--- Documentation/trace/events.rst | 6 +- Documentation/trace/ftrace.rst | 5 + Documentation/trace/histogram.txt | 546 +++++++++++++++++++++++++++++- 3 files changed, 555 insertions(+), 2 deletions(-)
Documentation/trace/events.rst +5 -1
@@ -338,10 +338,14 @@ used for conditionally invoking triggers. The syntax for event triggers is roughly based on the syntax for set_ftrace_filter 'ftrace filter commands' (see the 'Filter commands' -section of Documentation/trace/ftrace.txt), but there are major +section of Documentation/trace/ftrace.rst), but there are major differences and the implementation isn't currently tied to it in any way, so beware about making generalizations between the two. +Note: Writing into trace_marker (See Documentation/trace/ftrace.rst) + can also enable triggers that are written into + /sys/kernel/tracing/events/ftrace/print/trigger + 6.1 Expression syntax ---------------------
Documentation/trace/ftrace.rst +5 -0
@@ -507,6 +507,11 @@ of ftrace. Here is a list of some of the key files: trace_fd = open("trace_marker", WR_ONLY); + Note: Writing into the trace_marker file can also initiate triggers + that are written into /sys/kernel/tracing/events/ftrace/print/trigger + See "Event triggers" in Documentation/trace/events.rst and an + example in Documentation/trace/histogram.rst (Section 3.) + trace_marker_raw: This is similar to trace_marker above, but is meant for for binary data
Documentation/trace/histogram.txt +545 -1
555 lines not on this page · raw message
Signature · 1 line
2.17.0
Re: [PATCH v2 10/14] tracing: Document trace_marker triggers
Hi Steve,
This is a nice new event feature - thanks for doing it! Some minor typo comments below..
Quoted 68 lines · Steven Rostedt
From: "Steven Rostedt (VMware)" <[email protected]>
Add documentation and an example on how to use
trace_markertriggers.Signed-off-by Steven Rostedt (VMware) <[email protected]>--- Documentation/trace/events.rst | 6 +- Documentation/trace/ftrace.rst | 5 + Documentation/trace/histogram.txt | 546 +++++++++++++++++++++++++++++- 3 files changed, 555 insertions(+), 2 deletions(-)Documentation/trace/events.rst +5
-1@@ -338,10 +338,14 @@ used for conditionally invoking triggers. The syntax for event triggers is roughly based on the syntax for set_ftrace_filter 'ftrace filter commands' (see the 'Filter commands' -section of Documentation/trace/ftrace.txt), but there are major +section of Documentation/trace/ftrace.rst), but there are major differences and the implementation isn't currently tied to it in any way, so beware about making generalizations between the two. +Note: Writing into trace_marker (See Documentation/trace/ftrace.rst) + can also enable triggers that are written into + /sys/kernel/tracing/events/ftrace/print/trigger + 6.1 Expression syntax ---------------------Documentation/trace/ftrace.rst +5
-0@@ -507,6 +507,11 @@ of ftrace. Here is a list of some of the key files: trace_fd = open("trace_marker", WR_ONLY); + Note: Writing into the trace_marker file can also initiate triggers + that are written into /sys/kernel/tracing/events/ftrace/print/trigger + See "Event triggers" in Documentation/trace/events.rst and an + example in Documentation/trace/histogram.rst (Section 3.) + trace_marker_raw: This is similar to trace_marker above, but is meant for for binary dataDocumentation/trace/histogram.txt +4
-1@@ -1604,7 +1604,6 @@ Entries: 7 Dropped: 0 - 2.2 Inter-event hist triggers -----------------------------@@ -1993,3 +1992,548 @@ hist trigger specification. Hits: 12970 Entries: 2 Dropped: 0 + +3. User space creating a trigger +-------------------------------- +
Documentation/trace/histogram.txt hist trigger specification. · line 2008
Quoted 10 lines
Documentation/trace/histogram.txt +10
-0+Writing into /sys/kernel/tracing/trace_marker writes into the ftrace +ring buffer. This can also act like an event, by writing into the trigger +file located in /sys/kernel/tracing/events/ftrace/print/ + +Modifying cyclictest to write into the trace_marker file before it sleeps +and after it wakes up, something like this: + +static void traceputs(char *str) +{ + /* tracemark_fd is the trace_marker file descripto */
Should be 'descriptor'?
Quoted 35 lines
Documentation/trace/histogram.txt +34
-0+ if (tracemark_fd < 0) + return; + /* write the tracemark message */ + write(tracemark_fd, str, strlen(str)); +} + +And later add something like: + + traceputs("start"); + clock_nanosleep(...); + traceputs("end"); + +We can make a histogram from this: + + # cd /sys/kernel/tracing + # echo 'latency u64 lat' > synthetic_events + # echo 'hist:keys=common_pid:ts0=common_timestamp.usecs if buf == "start"' > events/ftrace/print/trigger + # echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(ftrace.print).latency($lat) if buf == "end"' >> events/ftrace/print/trigger + # echo 'hist:keys=lat,common_pid:sort=lat' > events/synthetic/latency/trigger + +The above created a synthetic event called "latency" and two histograms +against the trace_marker, one gets triggered when "start" is written into the +trace_marker file and the other when "end" is written. If the pids match, then +it will call the "latency" synthetic event with the calculated latency as its +parameter. Finally, a histogram is added to the latency synthetic event to +record the calculated latency along with the pid. + +Now running cyclictest with: + + # ./cyclictest -p80 -d0 -i250 -n -a -t --tracemark -b 1000 + + -p80 : run threads at priority 80 + -d0 : have all threads run at the same interval + -i250 : start the interval at 250 microseconds (all threads will do this)
Documentation/trace/histogram.txt hist trigger specification. · line 2052
Quoted 10 lines
Documentation/trace/histogram.txt +10
-0+ -n : sleep with nanosleep + -a : affine all threads to a separate CPU + -t : one thread per available CPU + --tracemark : enable trace mark writing + -b 1000 : stop if any latency is greater than 1000 microseconds + +Note, the -b 1000 is used just to make --tracemark available. + +The we can see the histogram created by this with: +
'Then we can..
Quoted 9 lines
Documentation/trace/histogram.txt +7
-0+ # cat events/synthetic/latency/hist +# event histogram +# +# trigger info: hist:keys=lat,common_pid:vals=hitcount:sort=lat:size=2048 [active] +# + +{ lat: 107, common_pid: 2039 } hitcount: 1
snip
Quoted 15 lines
Documentation/trace/histogram.txt +14
-0+{ lat: 289, common_pid: 2039 } hitcount: 1 +{ lat: 300, common_pid: 2039 } hitcount: 1 +{ lat: 384, common_pid: 2039 } hitcount: 1 + +Totals: + Hits: 67625 + Entries: 278 + Dropped: 0 + +Note, the writes are around the sleep, so ideally they will all be of 250 +microseconds. If you are wondering how there are several that are under +250 microseconds, that is because the way cyclictest works, is if one +iteration comes in late, the next one will set the timer to wake up less that +250. That is, if an iteration came in 50 microseconds late, the next wake up
Documentation/trace/histogram.txt hist trigger specification. · line 2357
Quoted 10 lines
Documentation/trace/histogram.txt +10
-0+will be at 200 microseconds. + +But this could easily be done in userspace. To make this even more +interesting, we can mix the histogram between events that happened in the +kernel with trace_marker. + + # cd /sys/kernel/tracing + # echo 'latency u64 lat' > synthetic_events + # echo 'hist:keys=pid:ts0=common_timestamp.usecs' > events/sched/sched_waking/trigger + # echo '!hist:keys=common_pid:vals=hitcount:lat=common_timestamp.usecs-$ts0:sort=hitcount:size=2048:clock=global:onmatch(sched.sched_switch).latency($lat) if buf == "end"' > events/ftrace/print/trigger
This seems out of place here - disabling an onmatch(sched.sched_switch) trigger that you haven't mentioned before.
Documentation/trace/histogram.txt hist trigger specification. · line 2363
Quoted 9 lines
# echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(sched.sched_waking).latency($lat) if buf == "end"' > events/ftrace/print/trigger + # echo 'hist:keys=lat,common_pid:sort=lat' > events/synthetic/latency/triggerDocumentation/trace/histogram.txt +4
-0+ +The difference this time is that instead of using the trace_marker to start +the latency, the sched_waking event is used, matching the common_pid for the +trace_marker write with the pid that is being worken by sched_waking.
s/worken/woken ?
Quoted 12 lines
Documentation/trace/histogram.txt +10
-0+ +After running cyclictest again with the same parameters, we now have: + + # cat events/synthetic/latency/hist +# event histogram +# +# trigger info: hist:keys=lat,common_pid:vals=hitcount:sort=lat:size=2048 [active] +# + +{ lat: 7, common_pid: 2302 } hitcount: 640
snip
Documentation/trace/histogram.txt hist trigger specification. · line 2539
Quoted 13 lines
Documentation/trace/histogram.txt +11
-0+{ lat: 61, common_pid: 2302 } hitcount: 1 +{ lat: 110, common_pid: 2302 } hitcount: 1 + +Totals: + Hits: 89565 + Entries: 158 + Dropped: 0 + +This doesn't tell us any information about how late cyclictest may have +worken up, but it does show us a nice histogram of how long it took from +the time that cyclictest was worken to the time it made it into user space.
A couple more that don't seem to be 'worken' ;-)
Tom
Steven Rostedt
maintainerRe: [PATCH v2 10/14] tracing: Document trace_marker triggers
Quoted 4 lines · On Mon, 14 May 2018 16:47:07 -0500 Tom Zanussi <[email protected]>…
Hi Steve,
This is a nice new event feature - thanks for doing it! Some minor typo comments below..
Can I get an Acked-by from you?
Quoted 8 lines
Quoted 8 lines
+3. User space creating a trigger
+--------------------------------Documentation/trace/histogram.txt +6
-0+ +Writing into /sys/kernel/tracing/trace_marker writes into the ftrace +ring buffer. This can also act like an event, by writing into the trigger +file located in /sys/kernel/tracing/events/ftrace/print/ + +Modifying cyclictest to write into the trace_marker file before it sleeps
Quoted 8 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2008
Quoted 6 lines
Documentation/trace/histogram.txt +5
-0+and after it wakes up, something like this: + +static void traceputs(char *str) +{ + /* tracemark_fd is the trace_marker file descripto */Should be 'descriptor'?
Fixed.
Quoted 9 lines
Quoted 9 lines
+ # ./cyclictest -p80 -d0 -i250 -n -a -t --tracemark -b 1000
+
+ -p80 : run threads at priority 80
+ -d0 : have all threads run at the same interval
+ -i250 : start the interval at 250 microseconds (all threads will do this)+ -n : sleep with nanosleep + -a : affine all threads to a separate CPU + -t : one thread per available CPU+ --tracemark : enable trace mark writing
Quoted 8 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2052
Quoted 6 lines
+ -b 1000 : stop if any latency is greater than 1000 microseconds
Documentation/trace/histogram.txt +5
-0+ +Note, the -b 1000 is used just to make --tracemark available. + +The we can see the histogram created by this with: +'Then we can..
Fixed
Quoted 6 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2363
Quoted 4 lines
Documentation/trace/histogram.txt +3
-0+The difference this time is that instead of using the trace_marker to start +the latency, the sched_waking event is used, matching the common_pid for the +trace_marker write with the pid that is being worken by sched_waking.s/worken/woken ?
Fixed. (It's kind of like Borken)
Quoted 17 lines
Quoted 13 lines
Documentation/trace/histogram.txt +10
-0+ +After running cyclictest again with the same parameters, we now have: + + # cat events/synthetic/latency/hist +# event histogram +# +# trigger info: hist:keys=lat,common_pid:vals=hitcount:sort=lat:size=2048 [active] +# + +{ lat: 7, common_pid: 2302 } hitcount: 640snip
Quoted 1 line
Quoted 14 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2539
Quoted 12 lines
Documentation/trace/histogram.txt +11
-0+{ lat: 61, common_pid: 2302 } hitcount: 1 +{ lat: 110, common_pid: 2302 } hitcount: 1 + +Totals: + Hits: 89565 + Entries: 158 + Dropped: 0 + +This doesn't tell us any information about how late cyclictest may have +worken up, but it does show us a nice histogram of how long it took from +the time that cyclictest was worken to the time it made it into user space.A couple more that don't seem to be 'worken' ;-)
I have an itchy 'r' finger.
Thanks for the review, I just updated this.
Oh, I guess I think I prefer a "Reviewed-by" tag instead of Ack (gives a stronger meaning).
-- Steve
Tom Zanussi
Reviewed-byRe: [PATCH v2 10/14] tracing: Document trace_marker triggers
Hi Steve,
Quoted 54 lines · Steven Rostedt
Quoted 4 lines · On Mon, 14 May 2018 16:47:07 -0500 Tom Zanussi <[email protected]>…
Hi Steve,
This is a nice new event feature - thanks for doing it! Some minor typo comments below..
Can I get an Acked-by from you?
Quoted 8 lines
Quoted 8 lines
+3. User space creating a trigger
+--------------------------------Documentation/trace/histogram.txt +6
-0+ +Writing into /sys/kernel/tracing/trace_marker writes into the ftrace +ring buffer. This can also act like an event, by writing into the trigger +file located in /sys/kernel/tracing/events/ftrace/print/ + +Modifying cyclictest to write into the trace_marker file before it sleepsQuoted 8 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2008
Quoted 6 lines
Documentation/trace/histogram.txt +5
-0+and after it wakes up, something like this: + +static void traceputs(char *str) +{ + /* tracemark_fd is the trace_marker file descripto */Should be 'descriptor'?
Fixed.
Quoted 9 lines
Quoted 9 lines
+ # ./cyclictest -p80 -d0 -i250 -n -a -t --tracemark -b 1000
+
+ -p80 : run threads at priority 80
+ -d0 : have all threads run at the same interval
+ -i250 : start the interval at 250 microseconds (all threads will do this)+ -n : sleep with nanosleep + -a : affine all threads to a separate CPU + -t : one thread per available CPU+ --tracemark : enable trace mark writing
Quoted 8 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2052
Quoted 6 lines
+ -b 1000 : stop if any latency is greater than 1000 microseconds
Documentation/trace/histogram.txt +5
-0+ +Note, the -b 1000 is used just to make --tracemark available. + +The we can see the histogram created by this with: +'Then we can..
Fixed
Quoted 8 lines
Quoted 6 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2363
Quoted 4 lines
Documentation/trace/histogram.txt +3
-0+The difference this time is that instead of using the trace_marker to start +the latency, the sched_waking event is used, matching the common_pid for the +trace_marker write with the pid that is being worken by sched_waking.s/worken/woken ?
Fixed. (It's kind of like Borken)
:-)
Quoted 33 lines
Quoted 18 lines
Quoted 14 lines
Documentation/trace/histogram.txt +10
-0+ +After running cyclictest again with the same parameters, we now have: + + # cat events/synthetic/latency/hist +# event histogram +# +# trigger info: hist:keys=lat,common_pid:vals=hitcount:sort=lat:size=2048 [active] +# + +{ lat: 7, common_pid: 2302 } hitcount: 640snip
Quoted 1 line
Quoted 14 lines
Documentation/trace/histogram.txt hist trigger specification. · line 2539
Quoted 12 lines
Documentation/trace/histogram.txt +11
-0+{ lat: 61, common_pid: 2302 } hitcount: 1 +{ lat: 110, common_pid: 2302 } hitcount: 1 + +Totals: + Hits: 89565 + Entries: 158 + Dropped: 0 + +This doesn't tell us any information about how late cyclictest may have +worken up, but it does show us a nice histogram of how long it took from +the time that cyclictest was worken to the time it made it into user space.A couple more that don't seem to be 'worken' ;-)
Quoted 6 lines
I have an itchy 'r' finger.
Thanks for the review, I just updated this.
Oh, I guess I think I prefer a "Reviewed-by" tag instead of Ack (gives a stronger meaning).
Sure, but noticed in the new version you just posted, that this line is still in there for your second example:
+ # echo '!hist:keys=common_pid:vals=hitcount:lat=common_timestamp.usecs-$ts0:sort=hitcount:size=2048:clock=global:onmatch(sched.sched_switch).latency($lat) if buf == "end"' > events/ftrace/print/trigger
Did you intend that, or am I missing something?
Anyway, you have my
Thanks,
Tom
Steven Rostedt
maintainerRe: [PATCH v2 10/14] tracing: Document trace_marker triggers
Quoted 6 lines · On Wed, 16 May 2018 10:22:27 -0500 Tom Zanussi <[email protected]>…
Sure, but noticed in the new version you just posted, that this line is still in there for your second example:
+ # echo '!hist:keys=common_pid:vals=hitcount:lat=common_timestamp.usecs-$ts0:sort=hitcount:size=2048:clock=global:onmatch(sched.sched_switch).latency($lat) if buf == "end"' > events/ftrace/print/trigger
Did you intend that, or am I missing something?
No, I am. From my reply, you can see I skipped it. I totally missed that comment. I'll update that too.
Quoted 4 lines
Anyway, you have my
Reviewed-by Tom Zanussi <[email protected]>
Thanks!
-- Steve
Steven Rostedt
maintainerPATCH v2 11/14 ftrace/selftest: Have the reset_trigger code be a bit more careful
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
The trigger code is picky in how it can be disabled as there may be dependencies between different events and synthetic events. Change the order on how triggers are reset.
1) Reset triggers of all synthetic events first
2) Remove triggers with actions attached to them
3) Remove all other triggers
If this order isn't followed, then some triggers will not be reset, and an error may happen because a trigger is busy.
--- .../testing/selftests/ftrace/test.d/functions | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-)
tools/testing/selftests/ftrace/test.d/functions +18 -3
@@ -15,14 +15,29 @@ reset_tracer() { # reset the current tracer echo nop > current_tracer } -reset_trigger() { # reset all current setting triggers - grep -v ^# events/*/*/trigger | +reset_trigger_file() { + # remove action triggers first + grep -H ':on[^:]*(' $@ | + while read line; do + cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" >> $file + done + grep -Hv ^# $@ | while read line; do cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` - echo "!$cmd" > `echo $line | cut -f1 -d:` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" > $file done } +reset_trigger() { # reset all current setting triggers + if [ -d events/synthetic ]; then + reset_trigger_file events/synthetic/*/trigger + fi + reset_trigger_file events/*/*/trigger +} + reset_events_filter() { # reset all current setting filters grep -v ^none events/*/*/filter | while read line; do
Signature · 1 line
2.17.0
Re: [PATCH v2 11/14] ftrace/selftest: Have the reset_trigger code be a bit more careful
Quoted 6 lines · On Mon, 14 May 2018 16:58:56 -0400 Steven Rostedt <[email protected]> wrote:
From: "Steven Rostedt (VMware)" <[email protected]>
The trigger code is picky in how it can be disabled as there may be dependencies between different events and synthetic events. Change the order on how triggers are reset.
Quoted 6 lines
1) Reset triggers of all synthetic events first
2) Remove triggers with actions attached to them
3) Remove all other triggersIf this order isn't followed, then some triggers will not be reset, and an error may happen because a trigger is busy.
Ah, right!
I think this should go into stable tree too.
Thank you!
Quoted 47 lines
Signed-off-by Steven Rostedt (VMware) <[email protected]>--- .../testing/selftests/ftrace/test.d/functions | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-)tools/testing/selftests/ftrace/test.d/functions +18
-3@@ -15,14 +15,29 @@ reset_tracer() { # reset the current tracer echo nop > current_tracer } -reset_trigger() { # reset all current setting triggers - grep -v ^# events/*/*/trigger | +reset_trigger_file() { + # remove action triggers first + grep -H ':on[^:]*(' $@ | + while read line; do + cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" >> $file + done + grep -Hv ^# $@ | while read line; do cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` - echo "!$cmd" > `echo $line | cut -f1 -d:` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" > $file done } +reset_trigger() { # reset all current setting triggers + if [ -d events/synthetic ]; then + reset_trigger_file events/synthetic/*/trigger + fi + reset_trigger_file events/*/*/trigger +} + reset_events_filter() { # reset all current setting filters grep -v ^none events/*/*/filter | while read line; doSignature · 1 line
2.17.0
Signature · 1 line
Masami Hiramatsu <[email protected]>
Steven Rostedt
maintainerRe: [PATCH v2 11/14] ftrace/selftest: Have the reset_trigger code be a bit more careful
Quoted 13 lines · On Wed, 16 May 2018 21:53:50 +0900 Masami Hiramatsu <[email protected]> wrote:
Quoted 10 lines · On Mon, 14 May 2018 16:58:56 -0400 Steven Rostedt <[email protected]> wrote:
From: "Steven Rostedt (VMware)" <[email protected]>
The trigger code is picky in how it can be disabled as there may be dependencies between different events and synthetic events. Change the order on how triggers are reset.
1) Reset triggers of all synthetic events first
2) Remove triggers with actions attached to them
3) Remove all other triggers
Quoted 6 lines
Quoted 2 lines
If this order isn't followed, then some triggers will not be reset, and an error may happen because a trigger is busy.
Ah, right!
Acked-by Masami Hiramatsu <[email protected]>
Thanks!
Quoted 2 lines
I think this should go into stable tree too.
I wonder if I should break this into two patches then.
One for the actions before attached, and one for synthetic events?
Hmm, maybe not. As it can handle not having synthetic events, it should be OK to let the update go to a time when they were not there.
Thoughts?
-- Steve
Quoted 52 lines
Thank you!
Quoted 47 lines
Signed-off-by Steven Rostedt (VMware) <[email protected]>--- .../testing/selftests/ftrace/test.d/functions | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-)tools/testing/selftests/ftrace/test.d/functions +18
-3@@ -15,14 +15,29 @@ reset_tracer() { # reset the current tracer echo nop > current_tracer } -reset_trigger() { # reset all current setting triggers - grep -v ^# events/*/*/trigger | +reset_trigger_file() { + # remove action triggers first + grep -H ':on[^:]*(' $@ | + while read line; do + cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" >> $file + done + grep -Hv ^# $@ | while read line; do cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` - echo "!$cmd" > `echo $line | cut -f1 -d:` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" > $file done } +reset_trigger() { # reset all current setting triggers + if [ -d events/synthetic ]; then + reset_trigger_file events/synthetic/*/trigger + fi + reset_trigger_file events/*/*/trigger +} + reset_events_filter() { # reset all current setting filters grep -v ^none events/*/*/filter | while read line; doSignature · 1 line
2.17.0
Masami Hiramatsu
maintainerRe: [PATCH v2 11/14] ftrace/selftest: Have the reset_trigger code be a bit more careful
Quoted 28 lines · On Wed, 16 May 2018 10:00:04 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 13 lines · On Wed, 16 May 2018 21:53:50 +0900 Masami Hiramatsu <[email protected]> wrote:
Quoted 10 lines · On Mon, 14 May 2018 16:58:56 -0400 Steven Rostedt <[email protected]> wrote:
From: "Steven Rostedt (VMware)" <[email protected]>
The trigger code is picky in how it can be disabled as there may be dependencies between different events and synthetic events. Change the order on how triggers are reset.
1) Reset triggers of all synthetic events first
2) Remove triggers with actions attached to them
3) Remove all other triggersQuoted 6 lines
Quoted 2 lines
If this order isn't followed, then some triggers will not be reset, and an error may happen because a trigger is busy.
Ah, right!
Acked-by Masami Hiramatsu <[email protected]>Thanks!
Quoted 2 lines
I think this should go into stable tree too.
Quoted 8 lines
I wonder if I should break this into two patches then.
One for the actions before attached, and one for synthetic events?
Hmm, maybe not. As it can handle not having synthetic events, it should be OK to let the update go to a time when they were not there.
Thoughts?
I think the latest test-set can be run on the any stable kernel, and this correctly checks existence of the knob, so you don't need to split it.
Thank you,
Quoted 56 lines
-- Steve
Quoted 52 lines
Thank you!
Quoted 47 lines
Signed-off-by Steven Rostedt (VMware) <[email protected]>--- .../testing/selftests/ftrace/test.d/functions | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-)tools/testing/selftests/ftrace/test.d/functions +18
-3@@ -15,14 +15,29 @@ reset_tracer() { # reset the current tracer echo nop > current_tracer } -reset_trigger() { # reset all current setting triggers - grep -v ^# events/*/*/trigger | +reset_trigger_file() { + # remove action triggers first + grep -H ':on[^:]*(' $@ | + while read line; do + cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" >> $file + done + grep -Hv ^# $@ | while read line; do cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` - echo "!$cmd" > `echo $line | cut -f1 -d:` + file=`echo $line | cut -f1 -d:` + echo "!$cmd" > $file done } +reset_trigger() { # reset all current setting triggers + if [ -d events/synthetic ]; then + reset_trigger_file events/synthetic/*/trigger + fi + reset_trigger_file events/*/*/trigger +} + reset_events_filter() { # reset all current setting filters grep -v ^none events/*/*/filter | while read line; doSignature · 1 line
2.17.0
Signature · 1 line
Masami Hiramatsu <[email protected]>
Steven Rostedt
maintainerPATCH v2 12/14 ftrace/selftest: Fix reset_trigger() to handle triggers with filters
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
The reset_trigger() function breaks up the command by a space ' '. This is useful to ignore the '[active]' word for triggers when removing them. But if the trigger has a filter (ie. "if prio < 10") then the filter needs to be attached to the line that is written into the trigger file to remove it. But the truncation removes the filter and the triggers are not cleared properly.
Before, reset_trigger() did this:
# echo 'hist:keys=common_pid if prev_prio < 10' > events/sched/sched_switch/trigger # echo 'hist:keys=common_pid if next_prio < 10' >> events/sched/sched_switch/trigger # cat events/sched/sched_switch/trigger hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if prev_prio < 10 [active] hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if next_prio < 10 [active]
reset_trigger() {
echo '!hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048' >> events/sched/sched_switch/trigger
}
# cat events/sched/sched_switch/trigger hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if prev_prio < 10 [active] hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if next_prio < 10 [active]
After, where it includes the filter:
reset_trigger() {
echo '!hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if prev_prio < 10' >> events/sched/sched_switch/trigger
}
# cat events/sched/sched_switch/trigger hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if next_prio < 10 [active]
--- tools/testing/selftests/ftrace/test.d/functions | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/ftrace/test.d/functions +2 -2
@@ -19,13 +19,13 @@ reset_trigger_file() { # remove action triggers first grep -H ':on[^:]*(' $@ | while read line; do - cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + cmd=`echo $line | cut -f2- -d: | cut -f1 -d"["` file=`echo $line | cut -f1 -d:` echo "!$cmd" >> $file done grep -Hv ^# $@ | while read line; do - cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + cmd=`echo $line | cut -f2- -d: | cut -f1 -d"["` file=`echo $line | cut -f1 -d:` echo "!$cmd" > $file done
Signature · 1 line
2.17.0
Re: [PATCH v2 12/14] ftrace/selftest: Fix reset_trigger() to handle triggers with filters
Quoted 24 lines · On Mon, 14 May 2018 16:58:57 -0400 Steven Rostedt <[email protected]> wrote:
From: "Steven Rostedt (VMware)" <[email protected]>
The
reset_trigger()function breaks up the command by a space ' '. This is useful to ignore the '[active]' word for triggers when removing them. But if the trigger has a filter (ie. "if prio < 10") then the filter needs to be attached to the line that is written into the trigger file to remove it. But the truncation removes the filter and the triggers are not cleared properly.Before,
reset_trigger()did this:# echo 'hist:keys=common_pid if prev_prio < 10' > events/sched/sched_switch/trigger # echo 'hist:keys=common_pid if next_prio < 10' >> events/sched/sched_switch/trigger # cat events/sched/sched_switch/trigger hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if prev_prio < 10 [active] hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if next_prio < 10 [active]
reset_trigger(){
echo '!hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048' >> events/sched/sched_switch/trigger
}# cat events/sched/sched_switch/trigger hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if prev_prio < 10 [active] hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if next_prio < 10 [active]
Quoted 9 lines
After, where it includes the filter:
reset_trigger(){
echo '!hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 ifprev_prio< 10' >> events/sched/sched_switch/trigger
}# cat events/sched/sched_switch/trigger hist:keys=common_pid:vals=hitcount:sort=hitcount:size=2048 if next_prio < 10 [active]
This also looks good to me and needs to go into stable.
Thank you,
Quoted 29 lines
Signed-off-by Steven Rostedt (VMware) <[email protected]>--- tools/testing/selftests/ftrace/test.d/functions | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)tools/testing/selftests/ftrace/test.d/functions +2
-2@@ -19,13 +19,13 @@ reset_trigger_file() { # remove action triggers first grep -H ':on[^:]*(' $@ | while read line; do - cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + cmd=`echo $line | cut -f2- -d: | cut -f1 -d"["` file=`echo $line | cut -f1 -d:` echo "!$cmd" >> $file done grep -Hv ^# $@ | while read line; do - cmd=`echo $line | cut -f2- -d: | cut -f1 -d" "` + cmd=`echo $line | cut -f2- -d: | cut -f1 -d"["` file=`echo $line | cut -f1 -d:` echo "!$cmd" > $file doneSignature · 1 line
2.17.0
Signature · 1 line
Masami Hiramatsu <[email protected]>
Steven Rostedt
maintainerRe: [PATCH v2 12/14] ftrace/selftest: Fix reset_trigger() to handle triggers with filters
Quoted 3 lines · On Wed, 16 May 2018 21:56:12 +0900 Masami Hiramatsu <[email protected]> wrote:
This also looks good to me and needs to go into stable.
Acked-by Masami Hiramatsu <[email protected]>
Thanks Masami!
-- Steve
Steven Rostedt
maintainerPATCH v2 13/14 tracing/selftest: Add selftests to test trace_marker histogram triggers
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
Add a couple of tests that test the trace_marker histogram triggers. One does a straight histogram test, the other will create a synthetic event and test the latency between two different writes (using filters to differentiate between them).
--- .../trigger/trigger-trace-marker-synthetic.tc | 66 +++++++++++++++++++ .../test.d/trigger/trigger-trace-marker.tc | 49 ++++++++++++++ 2 files changed, 115 insertions(+) create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc new file +66 -0
@@ -0,0 +1,66 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 +# description: event trigger - test histogram with synthetic event +# flags: + +do_reset() { + reset_trigger + echo > set_event + echo > synthetic_events + clear_trace +} + +fail() { #msg + do_reset + echo $1 + exit_fail +} + +if [ ! -f set_event ]; then + echo "event tracing is not supported" + exit_unsupported +fi + +if [ ! -f synthetic_events ]; then + echo "synthetic events not supported" + exit_unsupported +fi + +if [ ! -d events/ftrace/print ]; then + echo "event trace_marker is not supported" + exit_unsupported +fi + +if [ ! -f events/ftrace/print/trigger ]; then + echo "event trigger is not supported" + exit_unsupported +fi + +if [ ! -f events/ftrace/print/hist ]; then + echo "hist trigger is not supported" + exit_unsupported +fi + +do_reset + +echo "Test histogram trace_marker to trace_marker latency histogram trigger" + +echo 'latency u64 lat' > synthetic_events +echo 'hist:keys=common_pid:ts0=common_timestamp.usecs if buf == "start"' > events/ftrace/print/trigger +echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(ftrace.print).latency($lat) if buf == "end"' >> events/ftrace/print/trigger +echo 'hist:keys=common_pid,lat:sort=lat' > events/synthetic/latency/trigger +echo -n "start" > trace_marker +echo -n "end" > trace_marker + +cnt=`grep 'hitcount: *1$' events/ftrace/print/hist | wc -l` + +if [ $cnt -ne 2 ]; then + fail "hist trace_marker trigger did not trigger correctly" +fi + +grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ + fail "hist trigger did not trigger " + +do_reset + +exit 0
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc new file +49 -0
49 lines not on this page · raw message
Signature · 1 line
2.17.0
Masami Hiramatsu
maintainerRe: [PATCH v2 13/14] tracing/selftest: Add selftests to test trace_marker histogram triggers
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc
Quoted 20 lines · On Mon, 14 May 2018 16:58:58 -0400 Steven Rostedt <[email protected]> wrote:
From: "Steven Rostedt (VMware)" <[email protected]>
Add a couple of tests that test the
trace_markerhistogram triggers. One does a straight histogram test, the other will create a synthetic event and test the latency between two different writes (using filters to differentiate between them).Signed-off-by Steven Rostedt (VMware) <[email protected]>--- .../trigger/trigger-trace-marker-synthetic.tc | 66 +++++++++++++++++++ .../test.d/trigger/trigger-trace-marker.tc | 49 ++++++++++++++ 2 files changed, 115 insertions(+) create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tctools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc new file +0
-0
OK, since the synthetic event may need histogram support, so this testname is OK.
Quoted 44 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc new file +43
-0@@ -0,0 +1,66 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 +# description: event trigger - test histogram with synthetic event +# flags: + +do_reset() { + reset_trigger + echo > set_event + echo > synthetic_events + clear_trace +} + +fail() { #msg + do_reset + echo $1 + exit_fail +} + +if [ ! -f set_event ]; then + echo "event tracing is not supported" + exit_unsupported +fi + +if [ ! -f synthetic_events ]; then + echo "synthetic events not supported" + exit_unsupported +fi + +if [ ! -d events/ftrace/print ]; then + echo "event trace_marker is not supported" + exit_unsupported +fi + +if [ ! -f events/ftrace/print/trigger ]; then + echo "event trigger is not supported" + exit_unsupported +fi + +if [ ! -f events/ftrace/print/hist ]; then + echo "hist trigger is not supported" + exit_unsupported +fi +
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc line 53
Quoted 10 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc new file +10
-0+do_reset + +echo "Test histogram trace_marker to trace_marker latency histogram trigger" + +echo 'latency u64 lat' > synthetic_events +echo 'hist:keys=common_pid:ts0=common_timestamp.usecs if buf == "start"' > events/ftrace/print/trigger +echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(ftrace.print).latency($lat) if buf == "end"' >> events/ftrace/print/trigger +echo 'hist:keys=common_pid,lat:sort=lat' > events/synthetic/latency/trigger +echo -n "start" > trace_marker +echo -n "end" > trace_marker
Ah, this is a great example how we can use this combination :D
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc
Quoted 18 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc new file +13
-0+ +cnt=`grep 'hitcount: *1$' events/ftrace/print/hist | wc -l` + +if [ $cnt -ne 2 ]; then + fail "hist trace_marker trigger did not trigger correctly" +fi + +grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ + fail "hist trigger did not trigger " + +do_reset + +exit 0tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc new file +0
-0
But this test actually kicks histogram, maybe trigger-trace-marker-hist.tc will be better, since we may need to add a simpler testcase just for checking whether trace-marker works with some actions (e.g. enable/disable other events).
Thank you,
Quoted 54 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc new file +49
-0@@ -0,0 +1,49 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 +# description: event trigger - test histogram trigger +# flags: instance + +do_reset() { + reset_trigger + echo > set_event + clear_trace +} + +fail() { #msg + do_reset + echo $1 + exit_fail +} + +if [ ! -f set_event ]; then + echo "event tracing is not supported" + exit_unsupported +fi + +if [ ! -d events/ftrace/print ]; then + echo "event trace_marker is not supported" + exit_unsupported +fi + +if [ ! -f events/ftrace/print/trigger ]; then + echo "event trigger is not supported" + exit_unsupported +fi + +if [ ! -f events/ftrace/print/hist ]; then + echo "hist trigger is not supported" + exit_unsupported +fi + +do_reset + +echo "Test histogram trace_marker tigger" + +echo 'hist:keys=common_pid' > events/ftrace/print/trigger +for i in `seq 1 10` ; do echo "hello" > trace_marker; done +grep 'hitcount: *10$' events/ftrace/print/hist > /dev/null || \ + fail "hist trigger did not trigger correct times on trace_marker" + +do_reset + +exit 0Signature · 1 line
2.17.0
Signature · 1 line
Masami Hiramatsu <[email protected]>
Steven Rostedt
maintainerRe: [PATCH v2 13/14] tracing/selftest: Add selftests to test trace_marker histogram triggers
Quoted 7 lines · On Wed, 16 May 2018 22:07:16 +0900 Masami Hiramatsu <[email protected]> wrote:
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc
Quoted 2 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker.tc new file +0
-0But this test actually kicks histogram, maybe trigger-trace-marker-hist.tc will be better, since we may need to add a simpler testcase just for checking whether trace-marker works with some actions (e.g. enable/disable other events).
OK, will update that file. Thanks for reviewing.
-- Steve
Steven Rostedt
maintainerPATCH v2 14/14 tracing/selftest: Add test to test hist trigger between kernel event and trace_marker
In reply to Steven RostedtFrom: "Steven Rostedt (VMware)" <[email protected]>
Add a test that tests a trigger that is initiated by a kernel event (sched_waking) and compared to a write to the trace_marker.
--- .../trigger/trigger-trace-marker-synthetic.tc | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+)
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc +22 -0
@@ -31,6 +31,11 @@ if [ ! -d events/ftrace/print ]; then exit_unsupported fi +if [ ! -d events/sched/sched_waking ]; then + echo "event sched_waking is not supported" + exit_unsupported +fi + if [ ! -f events/ftrace/print/trigger ]; then echo "event trigger is not supported" exit_unsupported
@@ -63,4 +68,21 @@ grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ do_reset +echo "Test histogram kernel event to trace_marker latency histogram trigger" + +echo 'latency u64 lat' > synthetic_events +echo 'hist:keys=pid:ts0=common_timestamp.usecs' > events/sched/sched_waking/trigger +echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(ftrace.print).latency($lat)' > events/ftrace/print/trigger +echo 'hist:keys=common_pid,lat:sort=lat' > events/synthetic/latency/trigger +sleep 1 +echo "hello" > trace_marker + +grep 'hitcount: *1$' events/ftrace/print/hist > /dev/null || \ + fail "hist trigger did not trigger correct times on trace_marker" + +grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ + fail "hist trigger did not trigger " + +do_reset + exit 0
Signature · 1 line
2.17.0
Re: [PATCH v2 14/14] tracing/selftest: Add test to test hist trigger between kernel event and trace_marker
Quoted 27 lines · Steven Rostedt
From: "Steven Rostedt (VMware)" <[email protected]>
Add a test that tests a trigger that is initiated by a kernel event (
sched_waking) and compared to a write to thetrace_marker.Signed-off-by Steven Rostedt (VMware) <[email protected]>--- .../trigger/trigger-trace-marker-synthetic.tc | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+)tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc +5
-0@@ -31,6 +31,11 @@ if [ ! -d events/ftrace/print ]; then exit_unsupported fi +if [ ! -d events/sched/sched_waking ]; then + echo "event sched_waking is not supported" + exit_unsupported +fi + if [ ! -f events/ftrace/print/trigger ]; then echo "event trigger is not supported" exit_unsupported
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ · line 75
Quoted 8 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc +5
-0@@ -63,4 +68,21 @@ grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ do_reset +echo "Test histogram kernel event to trace_marker latency histogram trigger" + +echo 'latency u64 lat' > synthetic_events +echo 'hist:keys=pid:ts0=common_timestamp.usecs' > events/sched/sched_waking/trigger +echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(ftrace.print).latency($lat)' > events/ftrace/print/trigger
Shouldn't it be "onmatch(sched.sched_waking)" ?
Thanks,
Namhyung
Quoted 17 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc +12
-0+echo 'hist:keys=common_pid,lat:sort=lat' > events/synthetic/latency/trigger +sleep 1 +echo "hello" > trace_marker + +grep 'hitcount: *1$' events/ftrace/print/hist > /dev/null || \ + fail "hist trigger did not trigger correct times on trace_marker" + +grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ + fail "hist trigger did not trigger " + +do_reset + exit 0Signature · 1 line
2.17.0
Steven Rostedt
maintainerRe: [PATCH v2 14/14] tracing/selftest: Add test to test hist trigger between kernel event and trace_marker
Quoted 7 lines · On Wed, 16 May 2018 18:11:53 +0900 Namhyung Kim <[email protected]> wrote:
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc grep 'hitcount: *1$' events/synthetic/latency/hist > /dev/null || \ · line 75
Quoted 5 lines
tools/testing/selftests/ftrace/test.d/trigger/trigger-trace-marker-synthetic.tc +5
-0+echo "Test histogram kernel event to trace_marker latency histogram trigger" + +echo 'latency u64 lat' > synthetic_events +echo 'hist:keys=pid:ts0=common_timestamp.usecs' > events/sched/sched_waking/trigger +echo 'hist:keys=common_pid:lat=common_timestamp.usecs-$ts0:onmatch(ftrace.print).latency($lat)' > events/ftrace/print/triggerShouldn't it be "
onmatch(sched.sched_waking)" ?
Ug, yes! Cut-and-paste fail :-p
I tested this my hand and did it correctly, but instead of cut-and-pasting the command line, I cut and pasted the other test and updated it.
Thanks for reviewing Namhyung!
-- Steve