rtla/hist: Make -E the short version of --entries
authorDaniel Bristot de Oliveira <bristot@kernel.org>
Fri, 18 Feb 2022 17:57:07 +0000 (18:57 +0100)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Sat, 26 Feb 2022 02:05:30 +0000 (21:05 -0500)
Currently, --entries uses -e as the short version in the hist mode of
timerlat and osnoise tools. But as -e is already used to enable events
on trace sessions by other tools, thus let's keep it available for the
same usage for all rtla tools.

Make -E the short version of --entries for hist mode on all tools.

Note: rtla was merged in this merge window, so rtla was not released yet.

Link: https://lkml.kernel.org/r/5dbf0cbe7364d3a05e708926b41a097c59a02b1e.1645206561.git.bristot@kernel.org
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_hist_options.rst
Documentation/tools/rtla/rtla-osnoise-hist.rst
tools/tracing/rtla/src/osnoise_hist.c
tools/tracing/rtla/src/timerlat_hist.c

index 0266cd0..df53ff8 100644 (file)
@@ -2,7 +2,7 @@
 
         Set the histogram bucket size (default *1*).
 
-**-e**, **--entries** *N*
+**-E**, **--entries** *N*
 
         Set the number of entries of the histogram (default 256).
 
index 52298dd..f2e79d2 100644 (file)
@@ -36,7 +36,7 @@ default). The reason for reducing the runtime is to avoid starving the
 **rtla** tool. The tool is also set to run for *one minute*. The output
 histogram is set to group outputs in buckets of *10us* and *25* entries::
 
-  [root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -e 25
+  [root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -E 25
   # RTLA osnoise histogram
   # Time unit is microseconds (us)
   # Duration:   0 00:01:00
index 1f0b7fc..52c053c 100644 (file)
@@ -426,7 +426,7 @@ 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] \\",
+               "         [-c cpu-list] [-P priority] [-b N] [-E N] [--no-header] [--no-summary] \\",
                "         [--no-index] [--with-zeros]",
                "",
                "         -h/--help: print this menu",
@@ -439,7 +439,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]",
                "         -b/--bucket-size N: set the histogram bucket size (default 1)",
-               "         -e/--entries N: set the number of entries of the histogram (default 256)",
+               "         -E/--entries N: set the number of entries of the histogram (default 256)",
                "            --no-header: do not print header",
                "            --no-summary: do not print summary",
                "            --no-index: do not print index",
@@ -486,7 +486,7 @@ static struct osnoise_hist_params
        while (1) {
                static struct option long_options[] = {
                        {"bucket-size",         required_argument,      0, 'b'},
-                       {"entries",             required_argument,      0, 'e'},
+                       {"entries",             required_argument,      0, 'E'},
                        {"cpus",                required_argument,      0, 'c'},
                        {"debug",               no_argument,            0, 'D'},
                        {"duration",            required_argument,      0, 'd'},
@@ -507,7 +507,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::0123",
                                 long_options, &option_index);
 
                /* detect the end of the options. */
@@ -534,7 +534,7 @@ static struct osnoise_hist_params
                        if (!params->duration)
                                osnoise_hist_usage("Invalid -D duration\n");
                        break;
-               case 'e':
+               case 'E':
                        params->entries = get_llong_from_str(optarg);
                        if ((params->entries < 10) || (params->entries > 9999999))
                                osnoise_hist_usage("Entries must be > 10 and < 9999999\n");
index 436a799..237e173 100644 (file)
@@ -429,7 +429,7 @@ static void timerlat_hist_usage(char *usage)
        char *msg[] = {
                "",
                "  usage: [rtla] timerlat hist [-h] [-q] [-d s] [-D] [-n] [-p us] [-i us] [-T us] [-s us] [-t[=file]] \\",
-               "         [-c cpu-list] [-P priority] [-e N] [-b N]  [--no-irq] [--no-thread] [--no-header] [--no-summary] \\",
+               "         [-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",
@@ -443,7 +443,7 @@ static void timerlat_hist_usage(char *usage)
                "         -T/--trace[=file]: save the stopped trace to [file|timerlat_trace.txt]",
                "         -n/--nano: display data in nanoseconds",
                "         -b/--bucket-size N: set the histogram bucket size (default 1)",
-               "         -e/--entries N: set the number of entries of the histogram (default 256)",
+               "         -E/--entries N: set the number of entries of the histogram (default 256)",
                "            --no-irq: ignore IRQ latencies",
                "            --no-thread: ignore thread latencies",
                "            --no-header: do not print header",
@@ -494,7 +494,7 @@ static struct timerlat_hist_params
                        {"cpus",                required_argument,      0, 'c'},
                        {"bucket-size",         required_argument,      0, 'b'},
                        {"debug",               no_argument,            0, 'D'},
-                       {"entries",             required_argument,      0, 'e'},
+                       {"entries",             required_argument,      0, 'E'},
                        {"duration",            required_argument,      0, 'd'},
                        {"help",                no_argument,            0, 'h'},
                        {"irq",                 required_argument,      0, 'i'},
@@ -516,7 +516,7 @@ static struct timerlat_hist_params
                /* getopt_long stores the option index here. */
                int option_index = 0;
 
-               c = getopt_long(argc, argv, "c:b:d:e:Dhi:np:P:s:t::T:012345",
+               c = getopt_long(argc, argv, "c:b:d:E:Dhi:np:P:s:t::T:012345",
                                 long_options, &option_index);
 
                /* detect the end of the options. */
@@ -543,7 +543,7 @@ static struct timerlat_hist_params
                        if (!params->duration)
                                timerlat_hist_usage("Invalid -D duration\n");
                        break;
-               case 'e':
+               case 'E':
                        params->entries = get_llong_from_str(optarg);
                        if ((params->entries < 10) || (params->entries > 9999999))
                                        timerlat_hist_usage("Entries must be > 10 and < 9999999\n");