linux-rt-users.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [RFC v3 00/19] Generate machine-readable output
@ 2021-01-15 19:09 Daniel Wagner
  2021-01-15 19:09 ` [RFC v3 01/19] pip_stress: De-constify prio_min Daniel Wagner
                   ` (18 more replies)
  0 siblings, 19 replies; 26+ messages in thread
From: Daniel Wagner @ 2021-01-15 19:09 UTC (permalink / raw)
  To: Clark Williams, John Kacur; +Cc: linux-rt-users, Daniel Wagner

changes 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

changes 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

[1] https://github.com/igaw/jitterdebugger/blob/master/jitterplot
[2] https://www.monom.org/data/jitterdebug/jitterplot-hist.png
[3] https://www.monom.org/data/jitterdebug/jitterplot-samples.png

Daniel Wagner (19):
  pip_stress: De-constify prio_min
  ptsematest: Return correct exit code when showing help
  rt-tests: Rename error.h to rt-error.h
  cyclictest: Move thread data to struct thread_param
  cyclictest: Remove libnuma API version 1 support
  signaltest: Move thread data to struct thread_param
  cyclicdeadline: Add missing step command line argument
  cyclicdeadline: Remove unused struct thread_param
  cyclicdeadline: Remove unused members in struct thread_stat
  rt-utils: Add JSON common header output helper
  cyclictest: Add JSON output feature
  signaltest: Add JSON output feature
  cyclicdeadline: Add JSON output feature
  pmqtest: Add JSON output feature
  ptsematest: Add JSON output feature
  sigwaittest: Add JSON output feature
  svsematest: Add JSON output feature
  oslat: Add JSON output feature
  rt-migrate-test: Add JSON output feature

 src/cyclictest/cyclictest.c           |  87 +++++++++++----
 src/include/pip_stress.h              |   5 +-
 src/include/{error.h => rt-error.h}   |   0
 src/include/rt-utils.h                |   4 +
 src/lib/error.c                       |   2 +-
 src/lib/rt-numa.c                     |   2 +-
 src/lib/rt-utils.c                    |  73 +++++++++++-
 src/oslat/oslat.c                     |  99 +++++++++++++---
 src/pi_tests/pi_stress.c              |   3 +-
 src/pi_tests/pip_stress.c             |   2 +-
 src/pmqtest/pmqtest.c                 | 143 +++++++++++++++++++-----
 src/ptsematest/ptsematest.c           | 128 +++++++++++++++++----
 src/rt-migrate-test/rt-migrate-test.c | 118 ++++++++++++++++----
 src/sched_deadline/cyclicdeadline.c   | 102 ++++++++++-------
 src/signaltest/signaltest.c           | 155 ++++++++++++++++++--------
 src/sigwaittest/sigwaittest.c         | 119 ++++++++++++++++----
 src/svsematest/svsematest.c           | 127 +++++++++++++++++----
 17 files changed, 927 insertions(+), 242 deletions(-)
 rename src/include/{error.h => rt-error.h} (100%)

-- 
2.29.2


^ permalink raw reply	[flat|nested] 26+ messages in thread

end of thread, other threads:[~2021-01-26 18:46 UTC | newest]

Thread overview: 26+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-15 19:09 [RFC v3 00/19] Generate machine-readable output Daniel Wagner
2021-01-15 19:09 ` [RFC v3 01/19] pip_stress: De-constify prio_min Daniel Wagner
2021-01-26  6:06   ` John Kacur
2021-01-15 19:09 ` [RFC v3 02/19] ptsematest: Return correct exit code when showing help Daniel Wagner
2021-01-26  6:09   ` John Kacur
2021-01-15 19:09 ` [RFC v3 03/19] rt-tests: Rename error.h to rt-error.h Daniel Wagner
2021-01-26  6:12   ` John Kacur
2021-01-15 19:09 ` [RFC v3 04/19] cyclictest: Move thread data to struct thread_param Daniel Wagner
2021-01-15 19:09 ` [RFC v3 05/19] cyclictest: Remove libnuma API version 1 support Daniel Wagner
2021-01-26  6:15   ` John Kacur
2021-01-15 19:09 ` [RFC v3 06/19] signaltest: Move thread data to struct thread_param Daniel Wagner
2021-01-15 19:09 ` [RFC v3 07/19] cyclicdeadline: Add missing step command line argument Daniel Wagner
2021-01-26  6:19   ` John Kacur
2021-01-15 19:09 ` [RFC v3 08/19] cyclicdeadline: Remove unused struct thread_param Daniel Wagner
2021-01-26  6:22   ` John Kacur
2021-01-15 19:09 ` [RFC v3 09/19] cyclicdeadline: Remove unused members in struct thread_stat Daniel Wagner
2021-01-15 19:09 ` [RFC v3 10/19] rt-utils: Add JSON common header output helper Daniel Wagner
2021-01-15 19:09 ` [RFC v3 11/19] cyclictest: Add JSON output feature Daniel Wagner
2021-01-15 19:09 ` [RFC v3 12/19] signaltest: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 13/19] cyclicdeadline: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 14/19] pmqtest: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 15/19] ptsematest: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 16/19] sigwaittest: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 17/19] svsematest: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 18/19] oslat: " Daniel Wagner
2021-01-15 19:09 ` [RFC v3 19/19] rt-migrate-test: " Daniel Wagner

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).