rtla/osnoise: Add an option to set the threshold
authorDaniel Bristot de Oliveira <bristot@kernel.org>
Wed, 2 Mar 2022 19:01:27 +0000 (20:01 +0100)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Tue, 15 Mar 2022 18:36:49 +0000 (14:36 -0400)
Add the -T/--threshold option to set the minimum threshold to be
considered a noise to osnoise top and hist commands. Also update
the man pages.

Link: https://lkml.kernel.org/r/031861200ffdb24a1df4aa72c458706889a20d5d.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_osnoise_options.rst
tools/tracing/rtla/src/osnoise_hist.c
tools/tracing/rtla/src/osnoise_top.c

index d556883e4e2637c031f5ca4729f46b75239a80e7..27f1493f7bc0b6c7b2743677f0a914bc46141ff7 100644 (file)
@@ -15,3 +15,8 @@
 
         Stop the trace if the total sample is higher than the argument in microseconds.
         If **-T** is set, it will also save the trace to the output.
+
+**-T**, **--threshold** *us*
+
+        Specify the minimum delta between two time reads to be considered noise.
+        The default threshold is *5 us*.
index 52c053cc1789d915ac2d8bbcb822e27f179e8025..ab02219de5287b8a68b7c27ead6330dab2328a4a 100644 (file)
@@ -21,6 +21,7 @@ struct osnoise_hist_params {
        char                    *trace_output;
        unsigned long long      runtime;
        unsigned long long      period;
+       long long               threshold;
        long long               stop_us;
        long long               stop_total_us;
        int                     sleep_time;
@@ -425,15 +426,16 @@ static void osnoise_hist_usage(char *usage)
 
        static const char * const msg[] = {
                "",
-               "  usage: rtla osnoise hist [-h] [-D] [-d s] [-p us] [-r us] [-s us] [-S us] [-t[=file]] \\",
-               "         [-c cpu-list] [-P priority] [-b N] [-E N] [--no-header] [--no-summary] \\",
-               "         [--no-index] [--with-zeros]",
+               "  usage: rtla osnoise hist [-h] [-D] [-d s] [-p us] [-r us] [-s us] [-S us] [-T us] \\",
+               "         [-t[=file]] [-c cpu-list] [-P priority] [-b N] [-E N] [--no-header] \\",
+               "         [--no-summary] [--no-index] [--with-zeros]",
                "",
                "         -h/--help: print this menu",
                "         -p/--period us: osnoise period in us",
                "         -r/--runtime us: osnoise runtime in us",
                "         -s/--stop us: stop trace if a single sample is higher than the argument in us",
                "         -S/--stop-total us: stop trace if the total sample is higher than the argument in us",
+               "         -T/--threshold us: the minimum delta to be considered a noise",
                "         -c/--cpus cpu-list: list of cpus to run osnoise threads",
                "         -d/--duration time[s|m|h|d]: duration of the session",
                "         -D/--debug: print debug info",
@@ -497,6 +499,7 @@ static struct osnoise_hist_params
                        {"stop",                required_argument,      0, 's'},
                        {"stop-total",          required_argument,      0, 'S'},
                        {"trace",               optional_argument,      0, 't'},
+                       {"threshold",           required_argument,      0, 'T'},
                        {"no-header",           no_argument,            0, '0'},
                        {"no-summary",          no_argument,            0, '1'},
                        {"no-index",            no_argument,            0, '2'},
@@ -507,7 +510,7 @@ static struct osnoise_hist_params
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "c:b:d:E:Dhp:P:r:s:S:t::0123",
+               c = getopt_long(argc, argv, "c:b:d:E:Dhp:P:r:s:S:t::T:0123",
                                 long_options, &option_index);
 
                /* detect the end of the options. */
@@ -565,6 +568,9 @@ static struct osnoise_hist_params
                case 'S':
                        params->stop_total_us = get_llong_from_str(optarg);
                        break;
+               case 'T':
+                       params->threshold = get_llong_from_str(optarg);
+                       break;
                case 't':
                        if (optarg)
                                /* skip = */
@@ -645,6 +651,14 @@ osnoise_hist_apply_config(struct osnoise_tool *tool, struct osnoise_hist_params
                }
        }
 
+       if (params->threshold) {
+               retval = osnoise_set_tracing_thresh(tool->context, params->threshold);
+               if (retval) {
+                       err_msg("Failed to set tracing_thresh\n");
+                       goto out_err;
+               }
+       }
+
        return 0;
 
 out_err:
index 7af769b9c0dee1a532b9eb1b1fdefd77fd5d8c96..07fb1b8314d361610327dc2ca8eff13dcdd0f5a1 100644 (file)
@@ -23,6 +23,7 @@ struct osnoise_top_params {
        char                    *trace_output;
        unsigned long long      runtime;
        unsigned long long      period;
+       long long               threshold;
        long long               stop_us;
        long long               stop_total_us;
        int                     sleep_time;
@@ -244,14 +245,15 @@ void osnoise_top_usage(char *usage)
        int i;
 
        static const char * const msg[] = {
-               "  usage: rtla osnoise [top] [-h] [-q] [-D] [-d s] [-p us] [-r us] [-s us] [-S us] [-t[=file]] \\",
-               "         [-c cpu-list] [-P priority]",
+               "  usage: rtla osnoise [top] [-h] [-q] [-D] [-d s] [-p us] [-r us] [-s us] [-S us] [-T us] \\",
+               "         [-t[=file]] [-c cpu-list] [-P priority]",
                "",
                "         -h/--help: print this menu",
                "         -p/--period us: osnoise period in us",
                "         -r/--runtime us: osnoise runtime in us",
                "         -s/--stop us: stop trace if a single sample is higher than the argument in us",
                "         -S/--stop-total us: stop trace if the total sample is higher than the argument in us",
+               "         -T/--threshold us: the minimum delta to be considered a noise",
                "         -c/--cpus cpu-list: list of cpus to run osnoise threads",
                "         -d/--duration time[s|m|h|d]: duration of the session",
                "         -D/--debug: print debug info",
@@ -302,6 +304,7 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv)
                        {"runtime",             required_argument,      0, 'r'},
                        {"stop",                required_argument,      0, 's'},
                        {"stop-total",          required_argument,      0, 'S'},
+                       {"threshold",           required_argument,      0, 'T'},
                        {"trace",               optional_argument,      0, 't'},
                        {0, 0, 0, 0}
                };
@@ -309,7 +312,7 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv)
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "c:d:Dhp:P:qr:s:S:t::",
+               c = getopt_long(argc, argv, "c:d:Dhp:P:qr:s:S:t::T:",
                                 long_options, &option_index);
 
                /* Detect the end of the options. */
@@ -367,6 +370,9 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv)
                        else
                                params->trace_output = "osnoise_trace.txt";
                        break;
+               case 'T':
+                       params->threshold = get_llong_from_str(optarg);
+                       break;
                default:
                        osnoise_top_usage("Invalid option");
                }
@@ -425,6 +431,14 @@ osnoise_top_apply_config(struct osnoise_tool *tool, struct osnoise_top_params *p
                }
        }
 
+       if (params->threshold) {
+               retval = osnoise_set_tracing_thresh(tool->context, params->threshold);
+               if (retval) {
+                       err_msg("Failed to set tracing_thresh\n");
+                       goto out_err;
+               }
+       }
+
        return 0;
 
 out_err: