rtla: Add --filter support
authorDaniel Bristot de Oliveira <bristot@kernel.org>
Wed, 2 Mar 2022 19:01:35 +0000 (20:01 +0100)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Tue, 15 Mar 2022 18:36:50 +0000 (14:36 -0400)
Add --filter option. This option enables a trace event filtering of the
previous -e sys:event argument.

This option is available for all current tools.

Link: https://lkml.kernel.org/r/509d70b6348d3e5bcbf1f07ab725ce08d063149a.1646247211.git.bristot@kernel.org
Cc: Daniel Bristot de Oliveira <bristot@kernel.org>
Cc: Clark Williams <williams@redhat.com>
Cc: Juri Lelli <juri.lelli@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Documentation/tools/rtla/common_options.rst
tools/tracing/rtla/src/osnoise_hist.c
tools/tracing/rtla/src/osnoise_top.c
tools/tracing/rtla/src/timerlat_hist.c
tools/tracing/rtla/src/timerlat_top.c

index e5870b9..afd45ba 100644 (file)
 
         Enable an event in the trace (**-t**) session. The argument can be a specific event, e.g., **-e** *sched:sched_switch*, or all events of a system group, e.g., **-e** *sched*. Multiple **-e** are allowed. It is only active when **-t** or **-a** are set.
 
+**--filter** *<filter>*
+
+        Filter the previous **-e** *sys:event* event with *<filter>*. For further information about event filtering see https://www.kernel.org/doc/html/latest/trace/events.html#event-filtering.
+
 **--trigger** *<trigger>*
         Enable a trace event trigger to the previous **-e** *sys:event*. For further information about event trigger see https://www.kernel.org/doc/html/latest/trace/events.html#event-triggers.
 
index 3e8f89b..f86b5fb 100644 (file)
@@ -428,8 +428,9 @@ static void osnoise_hist_usage(char *usage)
        static const char * const msg[] = {
                "",
                "  usage: rtla osnoise hist [-h] [-D] [-d s] [-a us] [-p us] [-r us] [-s us] [-S us] \\",
-               "         [-T us] [-t[=file]] [-e sys[:event]] [--trigger <trigger>] [-c cpu-list] [-P priority] \\",
-               "         [-b N] [-E N] [--no-header] [--no-summary] [--no-index] [--with-zeros]",
+               "         [-T us] [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] \\",
+               "         [-c cpu-list] [-P priority] [-b N] [-E N] [--no-header] [--no-summary] [--no-index] \\",
+               "         [--with-zeros]",
                "",
                "         -h/--help: print this menu",
                "         -a/--auto: set automatic trace mode, stopping the session if argument in us sample is hit",
@@ -443,6 +444,7 @@ static void osnoise_hist_usage(char *usage)
                "         -D/--debug: print debug info",
                "         -t/--trace[=file]: save the stopped trace to [file|osnoise_trace.txt]",
                "         -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
+               "            --filter <filter>: enable a trace event filter to the previous -e event",
                "            --trigger <trigger>: enable a trace event trigger to the previous -e event",
                "         -b/--bucket-size N: set the histogram bucket size (default 1)",
                "         -E/--entries N: set the number of entries of the histogram (default 256)",
@@ -512,13 +514,14 @@ static struct osnoise_hist_params
                        {"no-index",            no_argument,            0, '2'},
                        {"with-zeros",          no_argument,            0, '3'},
                        {"trigger",             required_argument,      0, '4'},
+                       {"filter",              required_argument,      0, '5'},
                        {0, 0, 0, 0}
                };
 
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "a:c:b:d:e:E:Dhp:P:r:s:S:t::T:01234:",
+               c = getopt_long(argc, argv, "a:c:b:d:e:E:Dhp:P:r:s:S:t::T:01234:5:",
                                 long_options, &option_index);
 
                /* detect the end of the options. */
@@ -632,6 +635,17 @@ static struct osnoise_hist_params
                                osnoise_hist_usage("--trigger requires a previous -e\n");
                        }
                        break;
+               case '5': /* filter */
+                       if (params->events) {
+                               retval = trace_event_add_filter(params->events, optarg);
+                               if (retval) {
+                                       err_msg("Error adding filter %s\n", optarg);
+                                       exit(EXIT_FAILURE);
+                               }
+                       } else {
+                               osnoise_hist_usage("--filter requires a previous -e\n");
+                       }
+                       break;
                default:
                        osnoise_hist_usage("Invalid option");
                }
index d16c7ce..c3d75ee 100644 (file)
@@ -247,7 +247,8 @@ void osnoise_top_usage(char *usage)
 
        static const char * const msg[] = {
                "  usage: rtla osnoise [top] [-h] [-q] [-D] [-d s] [-a us] [-p us] [-r us] [-s us] [-S us] \\",
-               "         [-T us] [-t[=file]] [-e sys[:event]] [--trigger <trigger>] [-c cpu-list] [-P priority]",
+               "         [-T us] [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] \\",
+               "         [-c cpu-list] [-P priority]",
                "",
                "         -h/--help: print this menu",
                "         -a/--auto: set automatic trace mode, stopping the session if argument in us sample is hit",
@@ -261,6 +262,7 @@ void osnoise_top_usage(char *usage)
                "         -D/--debug: print debug info",
                "         -t/--trace[=file]: save the stopped trace to [file|osnoise_trace.txt]",
                "         -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
+               "            --filter <filter>: enable a trace event filter to the previous -e event",
                "            --trigger <trigger>: enable a trace event trigger to the previous -e event",
                "         -q/--quiet print only a summary at the end",
                "         -P/--priority o:prio|r:prio|f:prio|d:runtime:period : set scheduling parameters",
@@ -314,13 +316,14 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv)
                        {"threshold",           required_argument,      0, 'T'},
                        {"trace",               optional_argument,      0, 't'},
                        {"trigger",             required_argument,      0, '0'},
+                       {"filter",              required_argument,      0, '1'},
                        {0, 0, 0, 0}
                };
 
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "a:c:d:De:hp:P:qr:s:S:t::T:0:",
+               c = getopt_long(argc, argv, "a:c:d:De:hp:P:qr:s:S:t::T:0:1:",
                                 long_options, &option_index);
 
                /* Detect the end of the options. */
@@ -415,6 +418,17 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv)
                                osnoise_top_usage("--trigger requires a previous -e\n");
                        }
                        break;
+               case '1': /* filter */
+                       if (params->events) {
+                               retval = trace_event_add_filter(params->events, optarg);
+                               if (retval) {
+                                       err_msg("Error adding filter %s\n", optarg);
+                                       exit(EXIT_FAILURE);
+                               }
+                       } else {
+                               osnoise_top_usage("--filter requires a previous -e\n");
+                       }
+                       break;
                default:
                        osnoise_top_usage("Invalid option");
                }
index 765b5a3..8341f38 100644 (file)
@@ -430,8 +430,9 @@ static void timerlat_hist_usage(char *usage)
        char *msg[] = {
                "",
                "  usage: [rtla] timerlat hist [-h] [-q] [-d s] [-D] [-n] [-a us] [-p us] [-i us] [-T us] [-s us] \\",
-               "         [-t[=file]] [-e sys[:event]] [--trigger <trigger>] [-c cpu-list] [-P priority] [-E N] \\",
-               "         [-b N] [--no-irq] [--no-thread] [--no-header] [--no-summary] [--no-index] [--with-zeros]",
+               "         [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] \\",
+               "         [-P priority] [-E N] [-b N] [--no-irq] [--no-thread] [--no-header] [--no-summary] \\",
+               "         [--no-index] [--with-zeros]",
                "",
                "         -h/--help: print this menu",
                "         -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit",
@@ -444,6 +445,7 @@ static void timerlat_hist_usage(char *usage)
                "         -D/--debug: print debug info",
                "         -t/--trace[=file]: save the stopped trace to [file|timerlat_trace.txt]",
                "         -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
+               "            --filter <filter>: enable a trace event filter to the previous -e event",
                "            --trigger <trigger>: enable a trace event trigger to the previous -e event",
                "         -n/--nano: display data in nanoseconds",
                "         -b/--bucket-size N: set the histogram bucket size (default 1)",
@@ -519,13 +521,14 @@ static struct timerlat_hist_params
                        {"no-index",            no_argument,            0, '4'},
                        {"with-zeros",          no_argument,            0, '5'},
                        {"trigger",             required_argument,      0, '6'},
+                       {"filter",              required_argument,      0, '7'},
                        {0, 0, 0, 0}
                };
 
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "a:c:b:d:e:E:Dhi:np:P:s:t::T:0123456:",
+               c = getopt_long(argc, argv, "a:c:b:d:e:E:Dhi:np:P:s:t::T:0123456:7:",
                                 long_options, &option_index);
 
                /* detect the end of the options. */
@@ -645,6 +648,17 @@ static struct timerlat_hist_params
                                timerlat_hist_usage("--trigger requires a previous -e\n");
                        }
                        break;
+               case '7': /* filter */
+                       if (params->events) {
+                               retval = trace_event_add_filter(params->events, optarg);
+                               if (retval) {
+                                       err_msg("Error adding filter %s\n", optarg);
+                                       exit(EXIT_FAILURE);
+                               }
+                       } else {
+                               timerlat_hist_usage("--filter requires a previous -e\n");
+                       }
+                       break;
                default:
                        timerlat_hist_usage("Invalid option");
                }
index 76927d4..9ce5a09 100644 (file)
@@ -268,7 +268,8 @@ static void timerlat_top_usage(char *usage)
        static const char *const msg[] = {
                "",
                "  usage: rtla timerlat [top] [-h] [-q] [-a us] [-d s] [-D] [-n] [-p us] [-i us] [-T us] [-s us] \\",
-               "         [[-t[=file]] [-e sys[:event]] [--trigger <trigger>] [-c cpu-list] [-P priority]",
+               "         [[-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] \\",
+               "         [-P priority]",
                "",
                "         -h/--help: print this menu",
                "         -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit",
@@ -281,6 +282,7 @@ static void timerlat_top_usage(char *usage)
                "         -D/--debug: print debug info",
                "         -t/--trace[=file]: save the stopped trace to [file|timerlat_trace.txt]",
                "         -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
+               "            --filter <command>: enable a trace event filter to the previous -e event",
                "            --trigger <command>: enable a trace event trigger to the previous -e event",
                "         -n/--nano: display data in nanoseconds",
                "         -q/--quiet print only a summary at the end",
@@ -340,13 +342,14 @@ static struct timerlat_top_params
                        {"thread",              required_argument,      0, 'T'},
                        {"trace",               optional_argument,      0, 't'},
                        {"trigger",             required_argument,      0, '0'},
+                       {"filter",              required_argument,      0, '1'},
                        {0, 0, 0, 0}
                };
 
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "a:c:d:De:hi:np:P:qs:t::T:0:",
+               c = getopt_long(argc, argv, "a:c:d:De:hi:np:P:qs:t::T:0:1:",
                                 long_options, &option_index);
 
                /* detect the end of the options. */
@@ -440,6 +443,17 @@ static struct timerlat_top_params
                                timerlat_top_usage("--trigger requires a previous -e\n");
                        }
                        break;
+               case '1': /* filter */
+                       if (params->events) {
+                               retval = trace_event_add_filter(params->events, optarg);
+                               if (retval) {
+                                       err_msg("Error adding filter %s\n", optarg);
+                                       exit(EXIT_FAILURE);
+                               }
+                       } else {
+                               timerlat_top_usage("--filter requires a previous -e\n");
+                       }
+                       break;
                default:
                        timerlat_top_usage("Invalid option");
                }