tracing/boot: Add histogram syntax support in boot-time tracing
Subsystems (4)
Masami Hiramatsu
maintainerv4 cover tracing/boot: Add histogram syntax support in boot-time tracing
Hi,
Here is the 4th version of boot-time tracing to add histogram syntax extension with a bugfix related hist-trigger.
The last version is here (NOTE: the subject version was wrong)
https://lore.kernel.org/lkml/162852406891.143877.12110677006587392853.stgit@devnote2/
This version fixes build warnings and some issues;
Changes from v3:
[2/10] - Add 'const' qualifier for @str parameter of append_str_nospace(). [5/10] - Fix to add braces for if block.
[8/10] - Fix to remove spaces in the expression for the variables.
Changes from v2:
[1/10] - Use IS_ENABLED() instead of #ifdef and show an error. [2/10] - Allow var expression includes spaces. [4/10] - Fixes a build error when CONFIG_HIST_TRIGGERS=n. [10/10] - Newly added.
'Histogram' options
-------------------
Currently, the boot-time tracing only supports per-event actions for setting trigger actions. This is enough for short actions like 'traceon', 'traceoff', 'snapshot' etc. However, it is not good for the 'hist' trigger action because it is usually too long to write it in a single string especially if it has an 'onmatch' action.
Here is the new syntax.
ftrace[.instance.INSTANCE].event.GROUP.EVENT.hist[.N] {
keys = <KEY>[,...]
values = <VAL>[,...]
sort = <SORT-KEY>[,...]
size = <ENTRIES>
name = <HISTNAME>
var { <VAR> = <EXPR> ... }
pause|continue|clear
onmax|onchange[.M] { var = <VAR>, <ACTION> [= <PARAM>] }
onmatch[.M] { event = <EVENT>, <ACTION> [= <PARAM>] }
filter = <FILTER>
}Where <ACTION> is one of below;
trace = <EVENT>, <ARG1>[, ...]
save = <ARG1>[, ...]
snapshotAnd "N" and "M" are digit started strings for multiple histograms and actions.
For example,
initcall.initcall_finish.actions = "hist:keys=func:lat=common_timestamp.usecs-$ts0:onmatch(initcall.initcall_start).trace(initcall_latency,func,$lat)"
This can be written as below;
initcall.initcall_finish.hist {
keys = func
var.lat = common_timestamp.usecs-$ts0
onmatch {
event = initcall.initcall_start
trace = initcall_latency, func, $lat
}
}
Also, you can add comments for each options.
Thank you,
---
Masami Hiramatsu (10):
tracing/boot: Fix a hist trigger dependency for boot time tracing tracing/boot: Add per-event histogram action options tracing/boot: Support multiple handlers for per-event histogram tracing/boot: Support multiple histograms for each event tracing/boot: Show correct histogram error command
Documentation: tracing: Add histogram syntax to boot-time tracing tools/bootconfig: Support per-group/all event enabling option tools/bootconfig: Add histogram syntax support to bconf2ftrace.sh tools/bootconfig: Use per-group/all enable option in ftrace2bconf script bootconfig/tracing/ktest: Update ktest example for boot-time tracing
Documentation/trace/boottime-trace.rst | 85 +++++- kernel/trace/trace_boot.c | 302 ++++++++++++++++++++ tools/bootconfig/scripts/bconf2ftrace.sh | 101 +++++++ tools/bootconfig/scripts/ftrace2bconf.sh | 24 +- tools/bootconfig/scripts/xbc.sh | 4 .../ktest/examples/bootconfigs/boottrace.bconf | 20 + .../ktest/examples/bootconfigs/verify-boottrace.sh | 2 7 files changed, 513 insertions(+), 25 deletions(-)
Signature · 1 line
Masami Hiramatsu (Linaro) <[email protected]>
Masami Hiramatsu
maintainerPATCH v4 1/10 tracing/boot: Fix a hist trigger dependency for boot time tracing
Fixes a build error when CONFIG_HIST_TRIGGERS=n with boot-time tracing. Since the trigger_process_regex() is defined only when CONFIG_HIST_TRIGGERS=y, if it is disabled, the 'actions' event option also must be disabled.
---
Changes in v3:
- Use IS_ENABLED() instead of #ifdef and show an error if CONFIG_HIST_TRIGGERS is not set but per-event actions specified.
--- kernel/trace/trace_boot.c | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-)
kernel/trace/trace_boot.c +9 -6
@@ -205,12 +205,15 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,pr_err ("Failed to apply filter: %s\n" , buf); } -xbc_node_for_each_array_value (enode,"actions" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) -pr_err ("action string is too long: %s\n" , p); -else if (trigger_process_regex (file, buf) <0 ) -pr_err ("Failed to apply an action: %s\n" , buf); - } +if (IS_ENABLED (CONFIG_HIST_TRIGGERS )) { +xbc_node_for_each_array_value (enode,"actions" , anode, p) { +if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +pr_err ("action string is too long: %s\n" , p); +else if (trigger_process_regex (file, buf) <0 ) +pr_err ("Failed to apply an action: %s\n" , buf); + } + }else if (xbc_node_find_value (enode,"actions" ,NULL )) +pr_err ("Failed to apply event actions because CONFIG_HIST_TRIGGERS is not set.\n" );if (xbc_node_find_value (enode,"enable" ,NULL )) {if (trace_event_enable_disable (file,1 ,0 ) <0 )
Masami Hiramatsu
maintainerPATCH v4 2/10 tracing/boot: Add per-event histogram action options
In reply to Masami HiramatsuAdd a hist-trigger action syntax support to boot-time tracing. Currently, boot-time tracing supports per-event actions as option strings. However, for the histogram action, it has a special syntax and usually needs a long action definition.
To make it readable and fit to the bootconfig syntax, this introduces a new options for histogram.
Here are the histogram action options for boot-time tracing.
ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist {
keys = <KEY>[,...]
values = <VAL>[,...]
sort = <SORT-KEY>[,...]
size = <ENTRIES>
name = <HISTNAME>
var { <VAR> = <EXPR> ... }
pause|continue|clear
onmax|onchange { var = <VAR>; <ACTION> [= <PARAM>] }
onmatch { event = <EVENT>; <ACTION> [= <PARAM>] }
filter = <FILTER>
}Where <ACTION> is one of below;
trace = <EVENT>, <ARG1>[, ...]
save = <ARG1>[, ...]
snapshot---
Changes in v4:
- Add 'const' qualifier for @str parameter of append_str_nospace().
Changes in v3:
- Allow var expression includes spaces, since it is natural that user write an expression with space in bootconfig. (e.g. "var.lat = common_timestamp.usecs - $ts0")
Changes in v2:
- Cleanup code to add ':' as a prefix for each element instead of fixup the last ':'.
- Fix syntax typo for handler actions.
- Make pause|continue|clear mutual exclusive.
- Add __printf() attribute to the append_printf().
--- kernel/trace/trace_boot.c | 231 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 231 insertions(+)
kernel/trace/trace_boot.c +231 -0
@@ -171,6 +171,231 @@ trace_boot_add_synth_event(struct xbc_node *node, const char *event) }#endif +#ifdef CONFIG_HIST_TRIGGERS +static int __init __printf(3, 4) +append_printf(char **bufp, char *end, const char *fmt, ...) +{ + va_list args; +int ret; + + if (*bufp == end) + return -ENOSPC; + + va_start(args, fmt); + ret =vsnprintf (*bufp, end - *bufp, fmt, args); + if (ret < end - *bufp) { + *bufp += ret; + } else { + *bufp = end; + ret = -ERANGE ; + } +va_end (args); + +return ret; +} + +static int __init +append_str_nospace (char **bufp,char *end,const char *str) +{ +char *p = *bufp; +int len; + +while (p < end -1 && *str !='\0' ) { +if (!isspace (*str)) + *(p++) = *str; + str++; + } + *p ='\0' ; +if (p == end -1 ) { + *bufp = end; +return -ENOSPC ; + } + len = p - *bufp; + *bufp = p; +return (int )len; +} + +static int __init +trace_boot_hist_add_array (struct xbc_node *hnode,char **bufp, +char *end,const char *key) +{ +struct xbc_node *knode, *anode; +const char *p; +char sep; + + knode =xbc_node_find_child (hnode, key); +if (knode) { + anode =xbc_node_get_child (knode); +if (!anode) { +pr_err ("hist.%s requires value(s).\n" , key); +return -EINVAL ; + } + +append_printf (bufp, end,":%s" , key); + sep ='=' ; +xbc_array_for_each_value (anode, p) { +append_printf (bufp, end,"%c%s" , sep, p); +if (sep =='=' ) + sep =',' ; + } + }else +return -ENOENT ; + +return 0 ; +} + +static int __init +trace_boot_hist_add_handler (struct xbc_node *hnode,char **bufp, +char *end,const char *param) +{ +struct xbc_node *knode, *anode; +const char *p; +char sep; + +/* Compose 'handler' parameter */ + p =xbc_node_find_value (hnode, param,NULL ); +if (!p) { +pr_err ("hist.%s requires '%s' option.\n" , +xbc_node_get_data (hnode), param); +return -EINVAL ; + } +append_printf (bufp, end,":%s(%s)" ,xbc_node_get_data (hnode), p); + +/* Compose 'action' parameter */ + knode =xbc_node_find_child (hnode,"trace" ); +if (!knode) + knode =xbc_node_find_child (hnode,"save" ); + +if (knode) { + anode =xbc_node_get_child (knode); +if (!anode || !xbc_node_is_value (anode)) { +pr_err ("hist.%s.%s requires value(s).\n" , +xbc_node_get_data (hnode), +xbc_node_get_data (knode)); +return -EINVAL ; + } + +append_printf (bufp, end,".%s" ,xbc_node_get_data (knode)); + sep ='(' ; +xbc_array_for_each_value (anode, p) { +append_printf (bufp, end,"%c%s" , sep, p); +if (sep =='(' ) + sep =',' ; + } +append_printf (bufp, end,")" ); + }else if (xbc_node_find_child (hnode,"snapshot" )) { +append_printf (bufp, end,".snapshot()" ); + }else { +pr_err ("hist.%s requires an action.\n" , +xbc_node_get_data (hnode)); +return -EINVAL ; + } + +return 0 ; +} + +/* +* Histogram boottime tracing syntax. +* +* ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist { +* keys = <KEY>[,...] +* values = <VAL>[,...] +* sort = <SORT-KEY>[,...] +* size = <ENTRIES> +* name = <HISTNAME> +* var { <VAR> = <EXPR> ... } +* pause|continue|clear +* onmax|onchange { var = <VAR>; <ACTION> [= <PARAM>] } +* onmatch { event = <EVENT>; <ACTION> [= <PARAM>] } +* filter = <FILTER> +* } +* +* Where <ACTION> are; +* +* trace = <EVENT>, <ARG1>[, ...] +* save = <ARG1>[, ...] +* snapshot +*/ +static int __init +trace_boot_compose_hist_cmd (struct xbc_node *hnode,char *buf,size_t size) +{ +struct xbc_node *node, *knode; +char *end = buf + size; +const char *p; +int ret =0 ; + +append_printf (&buf, end,"hist" ); + + ret =trace_boot_hist_add_array (hnode, &buf, end,"keys" ); +if (ret <0 ) { +if (ret == -ENOENT ) +pr_err ("hist requires keys.\n" ); +return -EINVAL ; + } + + ret =trace_boot_hist_add_array (hnode, &buf, end,"values" ); +if (ret == -EINVAL ) +return ret; + ret =trace_boot_hist_add_array (hnode, &buf, end,"sort" ); +if (ret == -EINVAL ) +return ret; + + p =xbc_node_find_value (hnode,"size" ,NULL ); +if (p) +append_printf (&buf, end,":size=%s" , p); + + p =xbc_node_find_value (hnode,"name" ,NULL ); +if (p) +append_printf (&buf, end,":name=%s" , p); + + node =xbc_node_find_child (hnode,"var" ); +if (node) { +xbc_node_for_each_key_value (node, knode, p) { +/* Expression must not include spaces. */ +append_printf (&buf, end,":%s=" , +xbc_node_get_data (knode)); +append_str_nospace (&buf, end, p); + } + } + +/* Histogram control attributes (mutual exclusive) */ +if (xbc_node_find_child (hnode,"pause" )) +append_printf (&buf, end,":pause" ); +else if (xbc_node_find_child (hnode,"continue" )) +append_printf (&buf, end,":continue" ); +else if (xbc_node_find_child (hnode,"clear" )) +append_printf (&buf, end,":clear" ); + +/* Histogram handler and actions */ + node =xbc_node_find_child (hnode,"onmax" ); +if (node &&trace_boot_hist_add_handler (node, &buf, end,"var" ) <0 ) +return -EINVAL ; + node =xbc_node_find_child (hnode,"onchange" ); +if (node &&trace_boot_hist_add_handler (node, &buf, end,"var" ) <0 ) +return -EINVAL ; + node =xbc_node_find_child (hnode,"onmatch" ); +if (node &&trace_boot_hist_add_handler (node, &buf, end,"event" ) <0 ) +return -EINVAL ; + + p =xbc_node_find_value (hnode,"filter" ,NULL ); +if (p) +append_printf (&buf, end," if %s" , p); + +if (buf == end) { +pr_err ("hist exceeds the max command length.\n" ); +return -E2BIG ; + } + +return 0 ; +} +#else +static int __init +trace_boot_compose_hist_cmd (struct xbc_node *hnode,char *buf,size_t size) +{ +return -EOPNOTSUPP ; +} +#endif +static void __init trace_boot_init_one_event (struct trace_array *tr,struct xbc_node *gnode,struct xbc_node *enode)
@@ -212,6 +437,12 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,else if (trigger_process_regex (file, buf) <0 )pr_err ("Failed to apply an action: %s\n" , buf); } + anode =xbc_node_find_child (enode,"hist" ); +if (anode && +trace_boot_compose_hist_cmd (anode, buf,ARRAY_SIZE (buf)) ==0 ) { +if (trigger_process_regex (file, buf) <0 ) +pr_err ("Failed to apply hist trigger: %s\n" , buf); + } }else if (xbc_node_find_value (enode,"actions" ,NULL ))pr_err ("Failed to apply event actions because CONFIG_HIST_TRIGGERS is not set.\n" );
Masami Hiramatsu
maintainerPATCH v4 3/10 tracing/boot: Support multiple handlers for per-event histogram
In reply to Masami HiramatsuSupport multiple handlers for per-event histogram in boot-time tracing. Since the histogram can register multiple same handler-actions with different parameters, this expands the syntax to support such cases.
With this update, the 'onmax', 'onchange' and 'onmatch' handler subkeys under per-event histogram option will take a number subkeys optionally as below. (see [.N])
ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist {
onmax|onchange[.N] { var = <VAR>; <ACTION> [= <PARAM>] }
onmatch[.N] { event = <EVENT>; <ACTION> [= <PARAM>] }
}The 'N' must be a digit (or digit started word).
Thus user can add several handler-actions to the histogram, for example,
ftrace.event.SOMEGROUP.SOMEEVENT.hist {
keys = SOME_ID; lat = common_timestamp.usecs-$ts0 onmatch.1 {
event = GROUP1.STARTEVENT1
trace = latency_event, SOME_ID, $lat
}
onmatch.2 {
event = GROUP2.STARTEVENT2
trace = latency_event, SOME_ID, $lat
}
}
Then, it can trace the elapsed time from GROUP1.STARTEVENT1 to SOMEGROUP.SOMEEVENT, and from GROUP2.STARTEVENT2 to SOMEGROUP.SOMEEVENT with SOME_ID key.
--- kernel/trace/trace_boot.c | 43 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 8 deletions(-)
kernel/trace/trace_boot.c +35 -8
@@ -245,8 +245,9 @@ trace_boot_hist_add_array(struct xbc_node *hnode, char **bufp, }static int __init -trace_boot_hist_add_handler (struct xbc_node *hnode,char **bufp, -char *end,const char *param) +trace_boot_hist_add_one_handler (struct xbc_node *hnode,char **bufp, +char *end,const char *handler, +const char *param) {struct xbc_node *knode, *anode;const char *p;
@@ -259,7 +260,7 @@ trace_boot_hist_add_handler(struct xbc_node *hnode, char **bufp, xbc_node_get_data(hnode), param);return -EINVAL ; } -append_printf (bufp, end,":%s(%s)" ,xbc_node_get_data (hnode), p); +append_printf (bufp, end,":%s(%s)" , handler, p);/* Compose 'action' parameter */ knode =xbc_node_find_child (hnode,"trace" );
@@ -294,6 +295,32 @@ trace_boot_hist_add_handler(struct xbc_node *hnode, char **bufp,return 0 ; } +static int __init +trace_boot_hist_add_handlers (struct xbc_node *hnode,char **bufp, +char *end,const char *param) +{ +struct xbc_node *node; +const char *p, *handler; +int ret; + + handler =xbc_node_get_data (hnode); + +xbc_node_for_each_subkey (hnode, node) { + p =xbc_node_get_data (node); +if (!isdigit (p[0 ])) +continue ; +/* All digit started node should be instances. */ + ret =trace_boot_hist_add_one_handler (node, bufp, end, handler, param); +if (ret <0 ) +break ; + } + +if (xbc_node_find_child (hnode, param)) + ret =trace_boot_hist_add_one_handler (hnode, bufp, end, handler, param); + +return ret; +} +/* * Histogram boottime tracing syntax. *
@@ -305,8 +332,8 @@ trace_boot_hist_add_handler(struct xbc_node *hnode, char **bufp,* name = <HISTNAME> * var { <VAR> = <EXPR> ... } * pause|continue|clear -* onmax|onchange { var = <VAR>; <ACTION> [= <PARAM>] } -* onmatch { event = <EVENT>; <ACTION> [= <PARAM>] } +* onmax|onchange[.N] { var = <VAR>; <ACTION> [= <PARAM>] } +* onmatch[.N] { event = <EVENT>; <ACTION> [= <PARAM>] } * filter = <FILTER> * } *
@@ -368,13 +395,13 @@ trace_boot_compose_hist_cmd(struct xbc_node *hnode, char *buf, size_t size)/* Histogram handler and actions */ node =xbc_node_find_child (hnode,"onmax" ); -if (node &&trace_boot_hist_add_handler (node, &buf, end,"var" ) <0 ) +if (node &&trace_boot_hist_add_handlers (node, &buf, end,"var" ) <0 )return -EINVAL ; node =xbc_node_find_child (hnode,"onchange" ); -if (node &&trace_boot_hist_add_handler (node, &buf, end,"var" ) <0 ) +if (node &&trace_boot_hist_add_handlers (node, &buf, end,"var" ) <0 )return -EINVAL ; node =xbc_node_find_child (hnode,"onmatch" ); -if (node &&trace_boot_hist_add_handler (node, &buf, end,"event" ) <0 ) +if (node &&trace_boot_hist_add_handlers (node, &buf, end,"event" ) <0 )return -EINVAL ; p =xbc_node_find_value (hnode,"filter" ,NULL );
Masami Hiramatsu
maintainerPATCH v4 4/10 tracing/boot: Support multiple histograms for each event
In reply to Masami HiramatsuAdd multiple histograms support for each event. This allows user to set multiple histograms to an event.
ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist[.N] {
...
}
The 'N' is a digit started string and it can be omitted for the default histogram.
For example, multiple hist triggers example in the Documentation/trace/histogram.rst can be written as below;
ftrace.event.net.netif_receive_skb.hist {
1 {
keys = skbaddr.hex
values = len
filter = len < 0
}
2 {
keys = skbaddr.hex
values = len
filter = len > 4096
}
3 {
keys = skbaddr.hex
values = len
filter = len == 256
}
4 {
keys = skbaddr.hex
values = len
}
5 {
keys = len
values = common_preempt_count
}
}---
Changes in v3:
- Fixes a build error when CONFIG_HIST_TRIGGERS=n.
--- kernel/trace/trace_boot.c | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-)
kernel/trace/trace_boot.c +32 -9
@@ -324,7 +324,7 @@ trace_boot_hist_add_handlers(struct xbc_node *hnode, char **bufp,/* * Histogram boottime tracing syntax. * -* ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist { +* ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist[.N] { * keys = <KEY>[,...] * values = <VAL>[,...] * sort = <SORT-KEY>[,...]
@@ -415,11 +415,37 @@ trace_boot_compose_hist_cmd(struct xbc_node *hnode, char *buf, size_t size)return 0 ; } + +static void __init +trace_boot_init_histograms (struct trace_event_file *file, +struct xbc_node *hnode,char *buf,size_t size) +{ +struct xbc_node *node; +const char *p; + +xbc_node_for_each_subkey (hnode, node) { + p =xbc_node_get_data (node); +if (!isdigit (p[0 ])) +continue ; +/* All digit started node should be instances. */ +if (trace_boot_compose_hist_cmd (node, buf, size) ==0 ) { +if (trigger_process_regex (file, buf) <0 ) +pr_err ("Failed to apply hist trigger: %s\n" , buf); + } + } + +if (xbc_node_find_child (hnode,"keys" )) { +if (trace_boot_compose_hist_cmd (hnode, buf, size) ==0 ) +if (trigger_process_regex (file, buf) <0 ) +pr_err ("Failed to apply hist trigger: %s\n" , buf); + } +}#else -static int __init -trace_boot_compose_hist_cmd (struct xbc_node *hnode,char *buf,size_t size) +static void __init +trace_boot_init_histograms (struct trace_event_file *file, +struct xbc_node *hnode,char *buf,size_t size) { -return -EOPNOTSUPP ; +/* do nothing */ }#endif
@@ -465,11 +491,8 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,pr_err ("Failed to apply an action: %s\n" , buf); } anode =xbc_node_find_child (enode,"hist" ); -if (anode && -trace_boot_compose_hist_cmd (anode, buf,ARRAY_SIZE (buf)) ==0 ) { -if (trigger_process_regex (file, buf) <0 ) -pr_err ("Failed to apply hist trigger: %s\n" , buf); - } +if (anode) +trace_boot_init_histograms (file, anode, buf,ARRAY_SIZE (buf)); }else if (xbc_node_find_value (enode,"actions" ,NULL ))pr_err ("Failed to apply event actions because CONFIG_HIST_TRIGGERS is not set.\n" );
Masami Hiramatsu
maintainerPATCH v4 5/10 tracing/boot: Show correct histogram error command
In reply to Masami HiramatsuSince trigger_process_regex() modifies given trigger actions while parsing, the error message couldn't show what command was passed to the trigger_process_regex() when it returns an error.
To fix that, show the backed up trigger action command instead of parsed buffer.
---
Changes in v4:
- Fix to add braces for if block.
--- kernel/trace/trace_boot.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
kernel/trace/trace_boot.c +10 -4
@@ -422,6 +422,7 @@ trace_boot_init_histograms(struct trace_event_file *file, {struct xbc_node *node;const char *p; +char *tmp;xbc_node_for_each_subkey (hnode, node) { p =xbc_node_get_data (node);
@@ -429,15 +430,20 @@ trace_boot_init_histograms(struct trace_event_file *file,continue ;/* All digit started node should be instances. */ if (trace_boot_compose_hist_cmd (node, buf, size) ==0 ) { + tmp =kstrdup (buf,GFP_KERNEL );if (trigger_process_regex (file, buf) <0 ) -pr_err ("Failed to apply hist trigger: %s\n" , buf); +pr_err ("Failed to apply hist trigger: %s\n" , tmp); +kfree (tmp); } }if (xbc_node_find_child (hnode,"keys" )) { -if (trace_boot_compose_hist_cmd (hnode, buf, size) ==0 ) +if (trace_boot_compose_hist_cmd (hnode, buf, size) ==0 ) { + tmp =kstrdup (buf,GFP_KERNEL );if (trigger_process_regex (file, buf) <0 ) -pr_err ("Failed to apply hist trigger: %s\n" , buf); +pr_err ("Failed to apply hist trigger: %s\n" , tmp); +kfree (tmp); + } } }#else
@@ -488,7 +494,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf))pr_err ("action string is too long: %s\n" , p);else if (trigger_process_regex (file, buf) <0 ) -pr_err ("Failed to apply an action: %s\n" , buf); +pr_err ("Failed to apply an action: %s\n" , p); } anode =xbc_node_find_child (enode,"hist" );if (anode)
Masami Hiramatsu
maintainerPATCH v4 6/10 Documentation: tracing: Add histogram syntax to boot-time tracing
In reply to Masami HiramatsuAdd the documentation about histogram syntax in boot-time tracing. This will allow user to write the histogram setting in a structured parameters.
---
Changes in v2:
- Update for the multiple histogram and the multiple handler.
--- Documentation/trace/boottime-trace.rst | 85 ++++++++++++++++++++++++++++++-- 1 file changed, 80 insertions(+), 5 deletions(-)
Documentation/trace/boottime-trace.rst +80 -5
@@ -125,6 +125,71 @@ Note that kprobe and synthetic event definitions can be written under instance node, but those are also visible from other instances. So please take care for event name conflict. +Ftrace Histogram Options +------------------------ + +Since it is too long to write a histogram action as a string for per-event +action option, there are tree-style options under per-event 'hist' subkey +for the histogram actions. For the detail of the each parameter, +please read the event histogram document [3]_. + +.. [3] See :ref:`Documentation/trace/histogram.rst <histogram>` + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]keys = KEY1[, KEY2[...]] + Set histogram key parameters. (Mandatory) + The 'N' is a digit string for the multiple histogram. You can omit it + if there is one histogram on the event. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]values = VAL1[, VAL2[...]] + Set histogram value parameters. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]sort = SORT1[, SORT2[...]] + Set histogram sort parameter options. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]size = NR_ENTRIES + Set histogram size (number of entries). + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]name = NAME + Set histogram name. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]var.VARIABLE = EXPR + Define a new VARIABLE by EXPR expression. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]<pause|continue|clear> + Set histogram control parameter. You can set one of them. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]onmatch.[M.]event = GROUP.EVENT + Set histogram 'onmatch' handler matching event parameter. + The 'M' is a digit string for the multiple 'onmatch' handler. You can omit it + if there is one 'onmatch' handler on this histogram. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]onmatch.[M.]trace = EVENT[, ARG1[...]] + Set histogram 'trace' action for 'onmatch'. + EVENT must be a synthetic event name, and ARG1... are parameters + for that event. Mandatory if 'onmatch.event' option is set. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]onmax.[M.]var = VAR + Set histogram 'onmax' handler variable parameter. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]onchange.[M.]var = VAR + Set histogram 'onchange' handler variable parameter. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]<onmax|onchange>.[M.]save = ARG1[, ARG2[...]] + Set histogram 'save' action parameters for 'onmax' or 'onchange' handler. + This option or below 'snapshot' option is mandatory if 'onmax.var' or + 'onchange.var' option is set. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]<onmax|onchange>.[M.]snapshot + Set histogram 'snapshot' action for 'onmax' or 'onchange' handler. + This option or above 'save' option is mandatory if 'onmax.var' or + 'onchange.var' option is set. + +ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.filter = FILTER_EXPR + Set histogram filter expression. You don't need 'if' in the FILTER_EXPR. + +Note that this 'hist' option can conflict with the per-event 'actions' +option if the 'actions' option has a histogram action. + When to Start =============
@@ -159,13 +224,23 @@ below:: } synthetic.initcall_latency { fields = "unsigned long func", "u64 lat" - actions = "hist:keys=func.sym,lat:vals=lat:sort=lat" + hist { + keys = func.sym, lat + values = lat + sort = lat + } } - initcall.initcall_start { - actions = "hist:keys=func:ts0=common_timestamp.usecs" + initcall.initcall_start.hist { + keys = func + var.ts0 = common_timestamp.usecs } - initcall.initcall_finish { - actions = "hist:keys=func:lat=common_timestamp.usecs-$ts0:onmatch(initcall.initcall_start).initcall_latency(func,$lat)" + initcall.initcall_finish.hist { + keys = func + var.lat = common_timestamp.usecs - $ts0 + onmatch { + event = initcall.initcall_start + trace = initcall_latency, func, $lat + } } }
Masami Hiramatsu
maintainerPATCH v4 7/10 tools/bootconfig: Support per-group/all event enabling option
In reply to Masami Hiramatsu--- tools/bootconfig/scripts/bconf2ftrace.sh | 13 +++++++++++++ 1 file changed, 13 insertions(+)
tools/bootconfig/scripts/bconf2ftrace.sh +13 -0
@@ -101,6 +101,12 @@ setup_event() { # prefix group event [instance] else eventdir="$TRACEFS/events/$2/$3" fi + # group enable + if [ "$3" = "enable" ]; then + run_cmd "echo 1 > ${eventdir}" + return + fi + case $2 in kprobes) xbc_get_val ${branch}.probes | while read line; do
@@ -127,6 +133,13 @@ setup_events() { # prefix("ftrace" or "ftrace.instance.INSTANCE") [instance] setup_event $prefix ${grpev%.*} ${grpev#*.} $2 done fi + if xbc_has_branch ${1}.event.enable; then + if [ "$2" ]; then + run_cmd "echo 1 > $TRACEFS/instances/$2/events/enable" + else + run_cmd "echo 1 > $TRACEFS/events/enable" + fi + fi } size2kb() { # size[KB|MB]
Masami Hiramatsu
maintainerRe: [PATCH v4 07/10] tools/bootconfig: Support per-group/all event enabling option
Quoted 1 line · On Tue, 10 Aug 2021 11:07:58 +0900 Masami Hiramatsu <[email protected]> wrote:
Signed-off-by Masami Hiramatsu <[email protected]>
Oops, I missed the changelog for this patch.
-----
Add group or all event enabling syntax support to bconf2ftrace.sh. User can pass a bootconfig file which includes
ftrace[.instance.INSTANCE].event.enable
and
ftrace[.instance.INSTANCE].event.GROUP.enable
correctly.
-----
Steve, should I update the patch and resend the series?
Thank you,
Quoted 36 lines
--- tools/bootconfig/scripts/bconf2ftrace.sh | 13 +++++++++++++ 1 file changed, 13 insertions(+)tools/bootconfig/scripts/bconf2ftrace.sh +13
-0@@ -101,6 +101,12 @@ setup_event() { # prefix group event [instance] else eventdir="$TRACEFS/events/$2/$3" fi + # group enable + if [ "$3" = "enable" ]; then + run_cmd "echo 1 > ${eventdir}" + return + fi + case $2 in kprobes) xbc_get_val ${branch}.probes | while read line; do@@ -127,6 +133,13 @@ setup_events() { # prefix("ftrace" or "ftrace.instance.INSTANCE") [instance] setup_event $prefix ${grpev%.*} ${grpev#*.} $2 done fi + if xbc_has_branch ${1}.event.enable; then + if [ "$2" ]; then + run_cmd "echo 1 > $TRACEFS/instances/$2/events/enable" + else + run_cmd "echo 1 > $TRACEFS/events/enable" + fi + fi } size2kb() { # size[KB|MB]
Signature · 1 line
Masami Hiramatsu <[email protected]>
Steven Rostedt
maintainerRe: [PATCH v4 07/10] tools/bootconfig: Support per-group/all event enabling option
Quoted 13 lines · On Sat, 14 Aug 2021 12:31:32 +0900 Masami Hiramatsu <[email protected]> wrote:
Quoted 1 line · On Tue, 10 Aug 2021 11:07:58 +0900 Masami Hiramatsu <[email protected]> wrote:
Signed-off-by Masami Hiramatsu <[email protected]>Oops, I missed the changelog for this patch.
-----
Add group or all event enabling syntax support tobconf2ftrace.sh. User can pass a bootconfig file which includesftrace[.instance.INSTANCE].event.enable
Quoted 9 lines
and
ftrace[.instance.INSTANCE].event.GROUP.enable
correctly.
-----Steve, should I update the patch and resend the series?
No need. I updated it.
Thanks!
-- Steve
Masami Hiramatsu
maintainerPATCH v4 8/10 tools/bootconfig: Add histogram syntax support to bconf2ftrace.sh
In reply to Masami HiramatsuAdd histogram syntax support to bconf2ftrace.sh script.
---
Changes in v4:
- Fix to remove spaces in the expression for the variables.
--- tools/bootconfig/scripts/bconf2ftrace.sh | 88 ++++++++++++++++++++++++++++++ tools/bootconfig/scripts/xbc.sh | 4 + 2 files changed, 90 insertions(+), 2 deletions(-)
tools/bootconfig/scripts/bconf2ftrace.sh +88 -0
@@ -94,6 +94,92 @@ compose_synth() { # event_name branch xbc_get_val $2 | while read field; do echo -n "$field; "; done } +print_hist_array() { # prefix key + __sep="=" + if xbc_has_key ${1}.${2}; then + echo -n ":$2" + xbc_get_val ${1}.${2} | while read field; do + echo -n "$__sep$field"; __sep="," + done + fi +} + +print_hist_action_array() { # prefix key + __sep="(" + echo -n ".$2" + xbc_get_val ${1}.${2} | while read field; do + echo -n "$__sep$field"; __sep="," + done + echo -n ")" +} + +print_hist_one_action() { # prefix handler param + echo -n ":${2}("`xbc_get_val ${1}.${3}`")" + if xbc_has_key "${1}.trace"; then + print_hist_action_array ${1} "trace" + elif xbc_has_key "${1}.save"; then + print_hist_action_array ${1} "save" + elif xbc_has_key "${1}.snapshot"; then + echo -n ".snapshot()" + fi +} + +print_hist_actions() { # prefix handler param + for __hdr in `xbc_subkeys ${1}.${2} 1 ".[0-9]"`; do + print_hist_one_action ${1}.${2}.$__hdr ${2} ${3} + done + if xbc_has_key ${1}.${2}.${3} ; then + print_hist_one_action ${1}.${2} ${2} ${3} + fi +} + +print_hist_var() { # prefix varname + echo -n ":${2}="`xbc_get_val ${1}.var.${2} | tr -d [:space:]` +} + +print_one_histogram() { # prefix + echo -n "hist" + print_hist_array $1 "keys" + print_hist_array $1 "values" + print_hist_array $1 "sort" + if xbc_has_key "${1}.size"; then + echo -n ":size="`xbc_get_val ${1}.size` + fi + if xbc_has_key "${1}.name"; then + echo -n ":name="`xbc_get_val ${1}.name` + fi + for __var in `xbc_subkeys "${1}.var" 1`; do + print_hist_var ${1} ${__var} + done + if xbc_has_key "${1}.pause"; then + echo -n ":pause" + elif xbc_has_key "${1}.continue"; then + echo -n ":continue" + elif xbc_has_key "${1}.clear"; then + echo -n ":clear" + fi + print_hist_actions ${1} "onmax" "var" + print_hist_actions ${1} "onchange" "var" + print_hist_actions ${1} "onmatch" "event" + + if xbc_has_key "${1}.filter"; then + echo -n " if "`xbc_get_val ${1}.filter` + fi +} + +setup_one_histogram() { # prefix trigger-file + run_cmd "echo '`print_one_histogram ${1}`' >> ${2}" +} + +setup_histograms() { # prefix trigger-file + for __hist in `xbc_subkeys ${1} 1 ".[0-9]"`; do + setup_one_histogram ${1}.$__hist ${2} + done + if xbc_has_key ${1}.keys; then + setup_one_histogram ${1} ${2} + fi +} + setup_event() { # prefix group event [instance] branch=$1.$2.$3 if [ "$4" ]; then
@@ -121,6 +207,8 @@ setup_event() { # prefix group event [instance] set_value_of ${branch}.filter ${eventdir}/filter set_array_of ${branch}.actions ${eventdir}/trigger + setup_histograms ${branch}.hist ${eventdir}/trigger + if xbc_has_key ${branch}.enable; then run_cmd "echo 1 > ${eventdir}/enable" fi
tools/bootconfig/scripts/xbc.sh +2 -2
@@ -49,8 +49,8 @@ xbc_has_branch() { # prefix-key grep -q "^$1" $XBC_TMPFILE } -xbc_subkeys() { # prefix-key depth +xbc_subkeys() { # prefix-key depth [subkey-pattern] __keys=`echo $1 | sed "s/\./ /g"` __s=`nr_args $__keys` - grep "^$1" $XBC_TMPFILE | cut -d= -f1| cut -d. -f$((__s + 1))-$((__s + $2)) | uniq + grep "^$1$3" $XBC_TMPFILE | cut -d= -f1| cut -d. -f$((__s + 1))-$((__s + $2)) | uniq }
Masami Hiramatsu
maintainerPATCH v4 9/10 tools/bootconfig: Use per-group/all enable option in ftrace2bconf script
In reply to Masami HiramatsuUse per-group/all enable option instead of ftrace.events option. This will make the bootconfig file more readable.
--- tools/bootconfig/scripts/ftrace2bconf.sh | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-)
tools/bootconfig/scripts/ftrace2bconf.sh +18 -6
@@ -92,6 +92,10 @@ referred_vars() { grep "^hist" $1/trigger | grep -o '$[a-zA-Z0-9]*' } +event_is_enabled() { # enable-file + test -f $1 & grep -q "1" $1 +} + per_event_options() { # event-dir evdir=$1 # Check the special event which has no filter and no trigger
@@ -113,7 +117,9 @@ per_event_options() { # event-dir emit_kv $PREFIX.event.$group.$event.actions += \'$action\' done - # enable is not checked; this is done by set_event in the instance. + if [ $GROUP_ENABLED -eq 0 ] && event_is_enabled $evdir/enable; then + emit_kv $PREFIX.event.$group.$event.enable + fi val=`cat $evdir/filter` if [ "$val" != "none" ]; then emit_kv $PREFIX.event.$group.$event.filter = "$val"
@@ -137,8 +143,19 @@ event_options() { kprobe_event_options synth_event_options fi + ALL_ENABLED=0 + if event_is_enabled $INSTANCE/events/enable; then + emit_kv $PREFIX.event.enable + ALL_ENABLED=1 + fi for group in `ls $INSTANCE/events/` ; do [ ! -d $INSTANCE/events/$group ] && continue + GROUP_ENABLED=$ALL_ENABLED + if [ $ALL_ENABLED -eq 0 ] && \ + event_is_enabled $INSTANCE/events/$group/enable ;then + emit_kv $PREFIX.event.$group.enable + GROUP_ENABLED=1 + fi for event in `ls $INSTANCE/events/$group/` ;do [ ! -d $INSTANCE/events/$group/$event ] && continue per_event_options $INSTANCE/events/$group/$event
@@ -226,11 +243,6 @@ instance_options() { # [instance-name] emit_kv $PREFIX.tracing_on = $val fi - val= - for i in `cat $INSTANCE/set_event`; do - val="$val, $i" - done - [ "$val" ] && emit_kv $PREFIX.events = "${val#,}" val=`cat $INSTANCE/current_tracer` [ $val != nop ] && emit_kv $PREFIX.tracer = $val if grep -qv "^#" $INSTANCE/set_ftrace_filter $INSTANCE/set_ftrace_notrace; then
Masami Hiramatsu
maintainerPATCH v4 10/10 bootconfig/tracing/ktest: Update ktest example for boot-time tracing
In reply to Masami HiramatsuUpdate ktest example for the boot-time tracing with histogram options. Note that since the histogram option uses "trace()" action instead of "EVENT()", this updates the matching pattern too.
--- .../ktest/examples/bootconfigs/boottrace.bconf | 20 +++++++++++++++----- .../ktest/examples/bootconfigs/verify-boottrace.sh | 2 +- 2 files changed, 16 insertions(+), 6 deletions(-)
tools/testing/ktest/examples/bootconfigs/boottrace.bconf +15 -5
@@ -10,13 +10,23 @@ ftrace.event { } synthetic.initcall_latency { fields = "unsigned long func", "u64 lat" - actions = "hist:keys=func.sym,lat:vals=lat:sort=lat" + hist { + keys = func.sym,lat + values = lat + sort = lat + } } - initcall.initcall_start { - actions = "hist:keys=func:ts0=common_timestamp.usecs" + initcall.initcall_start.hist { + keys = func; + var.ts0 = common_timestamp.usecs } - initcall.initcall_finish { - actions = "hist:keys=func:lat=common_timestamp.usecs-$ts0:onmatch(initcall.initcall_start).initcall_latency(func,$lat)" + initcall.initcall_finish.hist { + keys = func + var.lat = common_timestamp.usecs - $ts0 + onmatch { + event = initcall.initcall_start + trace = initcall_latency, func, $lat + } } }
tools/testing/ktest/examples/bootconfigs/verify-boottrace.sh +1 -1
@@ -58,7 +58,7 @@ compare_file_partial "events/synthetic/initcall_latency/enable" "0" compare_file_partial "events/initcall/initcall_start/trigger" "hist:keys=func:vals=hitcount:ts0=common_timestamp.usecs" compare_file_partial "events/initcall/initcall_start/enable" "1" -compare_file_partial "events/initcall/initcall_finish/trigger" 'hist:keys=func:vals=hitcount:lat=common_timestamp.usecs-\$ts0:sort=hitcount:size=2048:clock=global:onmatch(initcall.initcall_start).initcall_latency(func,\$lat)' +compare_file_partial "events/initcall/initcall_finish/trigger" 'hist:keys=func:vals=hitcount:lat=common_timestamp.usecs-\$ts0:sort=hitcount:size=2048:clock=global:onmatch(initcall.initcall_start).trace(initcall_latency,func,\$lat)' compare_file_partial "events/initcall/initcall_finish/enable" "1" compare_file "instances/foo/current_tracer" "function"