| Message ID | 20210217085610.10874-1-dwagner@suse.de |
|---|---|
| Headers | show |
| Series | Generate machine-readable output | expand |
On Wed, 17 Feb 2021, Daniel Wagner wrote: > Write the test results as JSON output to a file. This allows to > simplifies any parsing later on. > > Signed-off-by: Daniel Wagner <dwagner@suse.de> > --- > src/signaltest/signaltest.c | 106 +++++++++++++++++++++++++++++------- > 1 file changed, 86 insertions(+), 20 deletions(-) > > diff --git a/src/signaltest/signaltest.c b/src/signaltest/signaltest.c > index d2b90d93ceca..1d1b070cf12b 100644 > --- a/src/signaltest/signaltest.c > +++ b/src/signaltest/signaltest.c > @@ -22,6 +22,7 @@ > #include <unistd.h> > #include <errno.h> > #include <sched.h> > +#include <inttypes.h> > > #include <linux/unistd.h> > > @@ -207,6 +208,14 @@ static int lockall; > static struct bitmask *affinity_mask = NULL; > static int smp = 0; > static int setaffinity = AFFINITY_UNSPECIFIED; > +static char outfile[MAX_PATH]; > + > +enum option_values { > + OPT_AFFINITY=1, OPT_BREAKTRACE, > + OPT_DURATION, OPT_HELP, OPT_LOOPS, > + OPT_MLOCKALL, OPT_OUTPUT, OPT_PRIORITY, > + OPT_QUIET, OPT_SMP, OPT_THREADS, OPT_VERBOSE > +}; > > /* Process commandline options */ > static void process_options(int argc, char *argv[], unsigned int max_cpus) > @@ -219,17 +228,18 @@ static void process_options(int argc, char *argv[], unsigned int max_cpus) > int option_index = 0; > /** Options for getopt */ > static struct option long_options[] = { > - {"affinity", optional_argument, NULL, 'a'}, > - {"breaktrace", required_argument, NULL, 'b'}, > - {"duration", required_argument, NULL, 'D'}, > - {"help", no_argument, NULL, 'h'}, > - {"loops", required_argument, NULL, 'l'}, > - {"mlockall", no_argument, NULL, 'm'}, > - {"priority", required_argument, NULL, 'p'}, > - {"quiet", no_argument, NULL, 'q'}, > - {"smp", no_argument, NULL, 'S'}, > - {"threads", required_argument, NULL, 't'}, > - {"verbose", no_argument, NULL, 'v'}, > + {"affinity", optional_argument, NULL, OPT_AFFINITY}, > + {"breaktrace", required_argument, NULL, OPT_BREAKTRACE}, > + {"duration", required_argument, NULL, OPT_DURATION}, > + {"help", no_argument, NULL, OPT_HELP}, > + {"loops", required_argument, NULL, OPT_LOOPS}, > + {"mlockall", no_argument, NULL, OPT_MLOCKALL}, > + {"output", required_argument, NULL, OPT_OUTPUT}, > + {"priority", required_argument, NULL, OPT_PRIORITY}, > + {"quiet", no_argument, NULL, OPT_QUIET}, > + {"smp", no_argument, NULL, OPT_SMP}, > + {"threads", required_argument, NULL, OPT_THREADS}, > + {"verbose", no_argument, NULL, OPT_VERBOSE}, > {NULL, 0, NULL, 0} > }; > int c = getopt_long(argc, argv, "a::b:D:hl:mp:qSt:v", > @@ -237,6 +247,7 @@ static void process_options(int argc, char *argv[], unsigned int max_cpus) > if (c == -1) > break; > switch (c) { > + case OPT_AFFINITY: > case 'a': > option_affinity = 1; > /* smp sets AFFINITY_USEALL in OPT_SMP */ > @@ -262,14 +273,39 @@ static void process_options(int argc, char *argv[], unsigned int max_cpus) > printf("Using %u cpus.\n", > numa_bitmask_weight(affinity_mask)); > break; > - case 'b': tracelimit = atoi(optarg); break; > - case 'D': duration = parse_time_string(optarg); break; > + case OPT_BREAKTRACE: > + case 'b': > + tracelimit = atoi(optarg); > + break; > + case OPT_DURATION: > + case 'D': > + duration = parse_time_string(optarg); > + break; > + case OPT_HELP: > case '?': > - case 'h': display_help(0); break; > - case 'l': max_cycles = atoi(optarg); break; > - case 'm': lockall = 1; break; > - case 'p': priority = atoi(optarg); break; > - case 'q': quiet = 1; break; > + case 'h': > + display_help(0); > + break; > + case OPT_LOOPS: > + case 'l': > + max_cycles = atoi(optarg); > + break; > + case OPT_MLOCKALL: > + case 'm': > + lockall = 1; > + break; > + case OPT_OUTPUT: > + strncpy(outfile, optarg, strnlen(optarg, MAX_PATH-1)); > + break; > + case OPT_PRIORITY: > + case 'p': > + priority = atoi(optarg); > + break; > + case OPT_QUIET: > + case 'q': > + quiet = 1; > + break; > + case OPT_SMP: > case 'S': > if (numa) > fatal("numa and smp options are mutually exclusive\n"); > @@ -277,8 +313,13 @@ static void process_options(int argc, char *argv[], unsigned int max_cpus) > num_threads = -1; /* update after parsing */ > setaffinity = AFFINITY_USEALL; > break; > - case 't': num_threads = atoi(optarg); break; > - case 'v': verbose = 1; break; > + case OPT_THREADS: > + case 't': > + num_threads = atoi(optarg); > + break; > + case OPT_VERBOSE: > + case 'v': verbose = 1; > + break; > } > } > > @@ -339,6 +380,28 @@ static void print_stat(struct thread_param *par, int index, int verbose) > } > } > > +static void write_stats(FILE *f, void *data) > +{ > + struct thread_param *par = data; > + struct thread_stat *s; > + unsigned int i; > + > + fprintf(f, " \"num_threads\": %d,\n", num_threads); > + fprintf(f, " \"thread\": {\n"); > + for (i = 0; i < num_threads; i++) { > + fprintf(f, " \"%u\": {\n", i); > + s = &par->stats[i]; > + fprintf(f, " \"cycles\": %" PRIu64 ",\n", s->cycles); > + fprintf(f, " \"min\": %" PRIu64 ",\n", s->min); > + fprintf(f, " \"max\": %" PRIu64 ",\n", s->max); > + fprintf(f, " \"avg\": %.2f,\n", s->avg/s->cycles); > + fprintf(f, " \"cpu\": %d\n", par->cpu); > + fprintf(f, " }%s\n", i == num_threads - 1 ? "" : ","); > + > + } > + fprintf(f, " }\n"); > +} > + > int main(int argc, char **argv) > { > sigset_t sigset; > @@ -494,6 +557,9 @@ int main(int argc, char **argv) > if (stat[i].values) > free(stat[i].values); > } > + if (strlen(outfile) != 0) > + rt_write_json(outfile, argc, argv, write_stats, par); > + > free(stat); > outpar: > free(par); > -- > 2.30.0 > > Signed-off-by: John Kacur <jkacur@redhat.com>
v6: - signaltest rebased - sigwaittest rebases v5: - add 'realtime' to common header - add timestamp to common header - oslat add quiet option - oslat fix JSON formatting - rt-migrate fix JSON formatting v4: - rebased on top of '[rt-tests v3 00/16] rt-numa.h cleanups' series - dropped applied patches - dropped RFC label v3: - A number of bug fixes added at the beginning of the series. - Add --output option to all tests which have a numeric results, not just failed/passed v2: - Moved the common JSON parts into rt-util.[ch] - Add --output option to signaltest The current output of cyclictest is optimized for humans to read. This is all good when working directly with the tools. But for CI integration it's a bit of pain. Furthermore, not all rt-tests use the same output format. By using some easy to parse existing machine-readable format we can use standard libraries to parse the data. For example in jitterdebug there is a short Python program[1] to visualize either the histogram[2] or all samples[3]. The implementation for JSON output for this is very simple. The last patch adds a version of jitterdebugs's JSON output, which looks like { "file_version": 1, "version:": "cyclictest V 1.90", "num_threads": 2, "resolution_in_ns": 0, "cmdline:": "./cyclictest --affinity=1-2 --duration=1s --output=dump.json -h 1000 -p 80", "sysinfo": { "sysname": "Linux", "nodename": "beryllium", "release": "5.9.14-1-default", "version": "#1 SMP Sat Dec 12 06:57:32 UTC 2020 (c648a46)", "machine": "x86_64" }, "thread": { "0": { "histogram": { "0": 16, "1": 853, "2": 80, "3": 50, "4": 1 }, "cycles": 1000, "min": 0, "max": 4, "avg": 1.17, "cpu": 1, "node": 0 }, "1": { "histogram": { "0": 14, "1": 833, "2": 93, "3": 56, "4": 4 }, "cycles": 1000, "min": 0, "max": 4, "avg": 1.20, "cpu": 2, "node": 0 } } } It's just a rough version. I didn't try to make it generic for the other rt-tests or make it as plugin as John was suggesting. I'd think we could make this feature as compile option, if you want to keep the program small. Obviously, we could also make the terminal output a compile option, to keep it small. Anyway, what do you think about it? Thanks, Daniel Daniel Wagner (2): signaltest: Add JSON output feature sigwaittest: Add JSON output feature src/signaltest/signaltest.c | 106 ++++++++++++++++++++++++------ src/sigwaittest/sigwaittest.c | 117 ++++++++++++++++++++++++++++------ 2 files changed, 185 insertions(+), 38 deletions(-)