* [PATCH v5 1/8] checkpatch: cull trailing '*/' in SPDX check
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 2/8] tracetool: eliminate trailing whitespace in C format Daniel P. Berrangé
` (6 subsequent siblings)
7 siblings, 0 replies; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
Sometimes SPDX expressions appear inside C comments, and this
confuses checkpatch.pl. Drop the closing C comment characters
to avoid this.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
scripts/checkpatch.pl | 3 +++
1 file changed, 3 insertions(+)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 833f20f555..91616c974f 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1368,6 +1368,9 @@ sub checkspdx {
$expr =~ s/^\s*//g;
$expr =~ s/\s*$//g;
+ # Cull C comment end
+ $expr =~ s/\*\/.*//;
+
my @bits = split / +/, $expr;
my $prefer = "GPL-2.0-or-later";
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* [PATCH v5 2/8] tracetool: eliminate trailing whitespace in C format
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 1/8] checkpatch: cull trailing '*/' in SPDX check Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 3/8] tracetool: avoid space after "*" in arg types Daniel P. Berrangé
` (5 subsequent siblings)
7 siblings, 0 replies; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
scripts/tracetool/format/c.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/tracetool/format/c.py b/scripts/tracetool/format/c.py
index 69edf0d588..7aa51cd41a 100644
--- a/scripts/tracetool/format/c.py
+++ b/scripts/tracetool/format/c.py
@@ -36,7 +36,7 @@ def generate(events, backend, group):
' .id = 0,',
' .name = \"%(name)s\",',
' .sstate = %(sstate)s,',
- ' .dstate = &%(dstate)s ',
+ ' .dstate = &%(dstate)s',
'};',
event = e.api(e.QEMU_EVENT),
name = e.name,
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* [PATCH v5 3/8] tracetool: avoid space after "*" in arg types
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 1/8] checkpatch: cull trailing '*/' in SPDX check Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 2/8] tracetool: eliminate trailing whitespace in C format Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 4/8] tracetool: include SPDX-License-Identifier in generated files Daniel P. Berrangé
` (4 subsequent siblings)
7 siblings, 0 replies; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
QEMU code style is to have no whitespace between "*" and the
arg name. Since generated trace code will soon be added to
git, make it comply with code style.
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
scripts/tracetool/__init__.py | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/scripts/tracetool/__init__.py b/scripts/tracetool/__init__.py
index 2ae2e562d6..0f33758870 100644
--- a/scripts/tracetool/__init__.py
+++ b/scripts/tracetool/__init__.py
@@ -170,10 +170,16 @@ def __len__(self):
def __str__(self):
"""String suitable for declaring function arguments."""
+ def onearg(t, n):
+ if t[-1] == '*':
+ return "".join([t, n])
+ else:
+ return " ".join([t, n])
+
if len(self._args) == 0:
return "void"
else:
- return ", ".join([ " ".join([t, n]) for t,n in self._args ])
+ return ", ".join([ onearg(t, n) for t,n in self._args ])
def __repr__(self):
"""Evaluable string representation for this object."""
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* [PATCH v5 4/8] tracetool: include SPDX-License-Identifier in generated files
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
` (2 preceding siblings ...)
2025-09-16 8:16 ` [PATCH v5 3/8] tracetool: avoid space after "*" in arg types Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 5/8] tracetool: add test suite for tracetool with reference output Daniel P. Berrangé
` (3 subsequent siblings)
7 siblings, 0 replies; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
While these files are auto-generated, a later commit will add
reference output to git, so having SPDX-License-Identifier is
desirable.
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Acked-by: Thomas Huth <thuth@redhat.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
scripts/tracetool/format/c.py | 1 +
scripts/tracetool/format/d.py | 3 ++-
scripts/tracetool/format/h.py | 1 +
scripts/tracetool/format/log_stap.py | 1 +
scripts/tracetool/format/simpletrace_stap.py | 1 +
scripts/tracetool/format/stap.py | 1 +
scripts/tracetool/format/ust_events_c.py | 1 +
scripts/tracetool/format/ust_events_h.py | 1 +
8 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/scripts/tracetool/format/c.py b/scripts/tracetool/format/c.py
index 7aa51cd41a..e473fb6c6e 100644
--- a/scripts/tracetool/format/c.py
+++ b/scripts/tracetool/format/c.py
@@ -22,6 +22,7 @@ def generate(events, backend, group):
header = "trace-" + group + ".h"
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'',
'#include "qemu/osdep.h"',
'#include "qemu/module.h"',
diff --git a/scripts/tracetool/format/d.py b/scripts/tracetool/format/d.py
index ebfb714200..a5e096e214 100644
--- a/scripts/tracetool/format/d.py
+++ b/scripts/tracetool/format/d.py
@@ -39,7 +39,8 @@ def generate(events, backend, group):
if not events and platform != "darwin":
return
- out('/* This file is autogenerated by tracetool, do not edit. */'
+ out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'',
'provider qemu {')
diff --git a/scripts/tracetool/format/h.py b/scripts/tracetool/format/h.py
index ea126b07ea..a00ae475f7 100644
--- a/scripts/tracetool/format/h.py
+++ b/scripts/tracetool/format/h.py
@@ -19,6 +19,7 @@ def generate(events, backend, group):
header = "trace/control.h"
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'',
'#ifndef TRACE_%s_GENERATED_TRACERS_H' % group.upper(),
'#define TRACE_%s_GENERATED_TRACERS_H' % group.upper(),
diff --git a/scripts/tracetool/format/log_stap.py b/scripts/tracetool/format/log_stap.py
index b49afababd..710d62bffe 100644
--- a/scripts/tracetool/format/log_stap.py
+++ b/scripts/tracetool/format/log_stap.py
@@ -88,6 +88,7 @@ def c_fmt_to_stap(fmt):
def generate(events, backend, group):
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'')
for event_id, e in enumerate(events):
diff --git a/scripts/tracetool/format/simpletrace_stap.py b/scripts/tracetool/format/simpletrace_stap.py
index 4f4633b4e6..72971133bf 100644
--- a/scripts/tracetool/format/simpletrace_stap.py
+++ b/scripts/tracetool/format/simpletrace_stap.py
@@ -22,6 +22,7 @@ def global_var_name(name):
def generate(events, backend, group):
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'')
for event_id, e in enumerate(events):
diff --git a/scripts/tracetool/format/stap.py b/scripts/tracetool/format/stap.py
index a218b0445c..4d77fbc11a 100644
--- a/scripts/tracetool/format/stap.py
+++ b/scripts/tracetool/format/stap.py
@@ -38,6 +38,7 @@ def generate(events, backend, group):
if "disable" not in e.properties]
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'')
for e in events:
diff --git a/scripts/tracetool/format/ust_events_c.py b/scripts/tracetool/format/ust_events_c.py
index deced9533d..569754a304 100644
--- a/scripts/tracetool/format/ust_events_c.py
+++ b/scripts/tracetool/format/ust_events_c.py
@@ -20,6 +20,7 @@ def generate(events, backend, group):
if "disabled" not in e.properties]
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'',
'#include "qemu/osdep.h"',
'',
diff --git a/scripts/tracetool/format/ust_events_h.py b/scripts/tracetool/format/ust_events_h.py
index b99fe6896b..2a31fefeca 100644
--- a/scripts/tracetool/format/ust_events_h.py
+++ b/scripts/tracetool/format/ust_events_h.py
@@ -25,6 +25,7 @@ def generate(events, backend, group):
include = "trace-ust.h"
out('/* This file is autogenerated by tracetool, do not edit. */',
+ '/* SPDX-License-Identifier: GPL-2.0-or-later */',
'',
'#undef TRACEPOINT_PROVIDER',
'#define TRACEPOINT_PROVIDER qemu',
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* [PATCH v5 5/8] tracetool: add test suite for tracetool with reference output
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
` (3 preceding siblings ...)
2025-09-16 8:16 ` [PATCH v5 4/8] tracetool: include SPDX-License-Identifier in generated files Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 6/8] tracetool: drop the probe "__nocheck__" wrapping Daniel P. Berrangé
` (2 subsequent siblings)
7 siblings, 0 replies; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
When reviewing tracetool patches it is often very unclear what the
expected output will be for the generated backends. Compounding
this is that a default build will only enable the 'log' trace
backend, so developers won't see generated code for other backends
without making a special effort. Some backends are also platform
specific, so can't be enabled in QEMU builds, even though tracetool
could generate the code.
To address this, introduce a test suite for tracetool which is
conceptually similar to the qapi-schema test. It is a simple
python program that runs tracetool and compares the actual output
to historical reference output kept in git. The test directly
emits TAP format logs for ease of integration with meson.
This can be run with
make check-tracetool
to make it easier for developers changing generated output, the
sample expected content can be auto-recreated
QEMU_TEST_REGENERATE=1 make check-tracetool
and the changes reviewed and added to the commit. This will also
assist reviewers interpreting the change.
Developers are reminded of this in the test output on failure:
$ make check-tracetool
1/6 qemu:tracetool / dtrace OK 0.14s
2/6 qemu:tracetool / ftrace FAIL 0.06s exit status 1
――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
1..2
ok 1 - ftrace.c
#
not ok 1 - ftrace.h (set QEMU_TEST_REGENERATE=1 to recreate reference output if tracetool generator was intentionally changed)
――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
3/6 qemu:tracetool / log OK 0.06s
4/6 qemu:tracetool / simple OK 0.06s
5/6 qemu:tracetool / syslog OK 0.06s
6/6 qemu:tracetool / ust OK 0.11s
Summary of Failures:
2/6 qemu:tracetool / ftrace FAIL 0.06s exit status 1
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
MAINTAINERS | 1 +
docs/devel/testing/main.rst | 28 +++++++
tests/Makefile.include | 1 +
tests/meson.build | 1 +
tests/tracetool/dtrace.c | 32 ++++++++
tests/tracetool/dtrace.d | 10 +++
tests/tracetool/dtrace.h | 59 +++++++++++++
tests/tracetool/dtrace.log-stap | 15 ++++
tests/tracetool/dtrace.simpletrace-stap | 16 ++++
tests/tracetool/dtrace.stap | 14 ++++
tests/tracetool/ftrace.c | 32 ++++++++
tests/tracetool/ftrace.h | 73 ++++++++++++++++
tests/tracetool/log.c | 32 ++++++++
tests/tracetool/log.h | 57 +++++++++++++
tests/tracetool/meson.build | 28 +++++++
tests/tracetool/simple.c | 61 ++++++++++++++
tests/tracetool/simple.h | 54 ++++++++++++
tests/tracetool/syslog.c | 32 ++++++++
tests/tracetool/syslog.h | 57 +++++++++++++
tests/tracetool/trace-events | 5 ++
tests/tracetool/tracetool-test.py | 105 ++++++++++++++++++++++++
tests/tracetool/ust.c | 32 ++++++++
tests/tracetool/ust.h | 55 +++++++++++++
tests/tracetool/ust.ust-events-c | 14 ++++
tests/tracetool/ust.ust-events-h | 56 +++++++++++++
25 files changed, 870 insertions(+)
create mode 100644 tests/tracetool/dtrace.c
create mode 100644 tests/tracetool/dtrace.d
create mode 100644 tests/tracetool/dtrace.h
create mode 100644 tests/tracetool/dtrace.log-stap
create mode 100644 tests/tracetool/dtrace.simpletrace-stap
create mode 100644 tests/tracetool/dtrace.stap
create mode 100644 tests/tracetool/ftrace.c
create mode 100644 tests/tracetool/ftrace.h
create mode 100644 tests/tracetool/log.c
create mode 100644 tests/tracetool/log.h
create mode 100644 tests/tracetool/meson.build
create mode 100644 tests/tracetool/simple.c
create mode 100644 tests/tracetool/simple.h
create mode 100644 tests/tracetool/syslog.c
create mode 100644 tests/tracetool/syslog.h
create mode 100644 tests/tracetool/trace-events
create mode 100755 tests/tracetool/tracetool-test.py
create mode 100644 tests/tracetool/ust.c
create mode 100644 tests/tracetool/ust.h
create mode 100644 tests/tracetool/ust.ust-events-c
create mode 100644 tests/tracetool/ust.ust-events-h
diff --git a/MAINTAINERS b/MAINTAINERS
index fb045388b9..f8cd513d8b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3562,6 +3562,7 @@ F: scripts/tracetool/
F: scripts/qemu-trace-stap*
F: docs/tools/qemu-trace-stap.rst
F: docs/devel/tracing.rst
+F: tests/tracetool/
T: git https://github.com/stefanha/qemu.git tracing
Simpletrace
diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst
index 2b5cb0c148..11f05c0006 100644
--- a/docs/devel/testing/main.rst
+++ b/docs/devel/testing/main.rst
@@ -178,6 +178,34 @@ parser (either fixing a bug or extending/modifying the syntax). To do this:
``qapi-schema += foo.json``
+.. _tracetool-tests:
+
+Tracetool tests
+~~~~~~~~~~~~~~~
+
+The tracetool tests validate the generated source files used for defining
+probes for various tracing backends and source formats. The test operates
+by running the tracetool program against a sample trace-events file, and
+comparing the generated output against known good reference output. The
+tests can be run with:
+
+.. code::
+
+ make check-tracetool
+
+The reference output is stored in files under tests/tracetool, and when
+the tracetool backend/format output is intentionally changed, the reference
+files need to be updated. This can be automated by setting the
+QEMU_TEST_REGENERATE=1 environment variable:
+
+.. code::
+
+ QEMU_TEST_REGENERATE=1 make check-tracetool
+
+The resulting changes must be reviewed by the author to ensure they match
+the intended results, before adding the updated reference output to the
+same commit that alters the generator code.
+
check-block
~~~~~~~~~~~
diff --git a/tests/Makefile.include b/tests/Makefile.include
index 23fb722d42..3538c0c740 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -13,6 +13,7 @@ check-help:
@echo " $(MAKE) check-functional-TARGET Run functional tests for a given target"
@echo " $(MAKE) check-unit Run qobject tests"
@echo " $(MAKE) check-qapi-schema Run QAPI schema tests"
+ @echo " $(MAKE) check-tracetool Run tracetool generator tests"
@echo " $(MAKE) check-block Run block tests"
ifneq ($(filter $(all-check-targets), check-softfloat),)
@echo " $(MAKE) check-tcg Run TCG tests"
diff --git a/tests/meson.build b/tests/meson.build
index c59619220f..cbe7916241 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -88,3 +88,4 @@ subdir('qapi-schema')
subdir('qtest')
subdir('migration-stress')
subdir('functional')
+subdir('tracetool')
diff --git a/tests/tracetool/dtrace.c b/tests/tracetool/dtrace.c
new file mode 100644
index 0000000000..9f862fa14d
--- /dev/null
+++ b/tests/tracetool/dtrace.c
@@ -0,0 +1,32 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "trace-testsuite.h"
+
+uint16_t _TRACE_TEST_BLAH_DSTATE;
+uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+TraceEvent _TRACE_TEST_BLAH_EVENT = {
+ .id = 0,
+ .name = "test_blah",
+ .sstate = TRACE_TEST_BLAH_ENABLED,
+ .dstate = &_TRACE_TEST_BLAH_DSTATE
+};
+TraceEvent _TRACE_TEST_WIBBLE_EVENT = {
+ .id = 0,
+ .name = "test_wibble",
+ .sstate = TRACE_TEST_WIBBLE_ENABLED,
+ .dstate = &_TRACE_TEST_WIBBLE_DSTATE
+};
+TraceEvent *testsuite_trace_events[] = {
+ &_TRACE_TEST_BLAH_EVENT,
+ &_TRACE_TEST_WIBBLE_EVENT,
+ NULL,
+};
+
+static void trace_testsuite_register_events(void)
+{
+ trace_event_register_group(testsuite_trace_events);
+}
+trace_init(trace_testsuite_register_events)
diff --git a/tests/tracetool/dtrace.d b/tests/tracetool/dtrace.d
new file mode 100644
index 0000000000..5cc06f9f4f
--- /dev/null
+++ b/tests/tracetool/dtrace.d
@@ -0,0 +1,10 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+provider qemu {
+
+probe test_blah(void * context,const char * filename);
+
+probe test_wibble(void * context,int value);
+
+};
diff --git a/tests/tracetool/dtrace.h b/tests/tracetool/dtrace.h
new file mode 100644
index 0000000000..c2e5110672
--- /dev/null
+++ b/tests/tracetool/dtrace.h
@@ -0,0 +1,59 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef TRACE_TESTSUITE_GENERATED_TRACERS_H
+#define TRACE_TESTSUITE_GENERATED_TRACERS_H
+
+#include "trace/control.h"
+
+extern TraceEvent _TRACE_TEST_BLAH_EVENT;
+extern TraceEvent _TRACE_TEST_WIBBLE_EVENT;
+extern uint16_t _TRACE_TEST_BLAH_DSTATE;
+extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+#define TRACE_TEST_BLAH_ENABLED 1
+#define TRACE_TEST_WIBBLE_ENABLED 1
+#ifndef SDT_USE_VARIADIC
+#define SDT_USE_VARIADIC 1
+#endif
+#include "trace-dtrace-testsuite.h"
+
+#undef SDT_USE_VARIADIC
+#ifndef QEMU_TEST_BLAH_ENABLED
+#define QEMU_TEST_BLAH_ENABLED() true
+#endif
+#ifndef QEMU_TEST_WIBBLE_ENABLED
+#define QEMU_TEST_WIBBLE_ENABLED() true
+#endif
+
+#define TRACE_TEST_BLAH_BACKEND_DSTATE() ( \
+ QEMU_TEST_BLAH_ENABLED() || \
+ false)
+
+static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+{
+ QEMU_TEST_BLAH(context, filename);
+}
+
+static inline void trace_test_blah(void *context, const char *filename)
+{
+ if (true) {
+ _nocheck__trace_test_blah(context, filename);
+ }
+}
+
+#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
+ QEMU_TEST_WIBBLE_ENABLED() || \
+ false)
+
+static inline void _nocheck__trace_test_wibble(void *context, int value)
+{
+ QEMU_TEST_WIBBLE(context, value);
+}
+
+static inline void trace_test_wibble(void *context, int value)
+{
+ if (true) {
+ _nocheck__trace_test_wibble(context, value);
+ }
+}
+#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/dtrace.log-stap b/tests/tracetool/dtrace.log-stap
new file mode 100644
index 0000000000..092986e0b6
--- /dev/null
+++ b/tests/tracetool/dtrace.log-stap
@@ -0,0 +1,15 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+probe qemu.log.test_blah = qemu.test_blah ?
+{
+ try {
+ argfilename_str = filename ? user_string_n(filename, 512) : "<null>"
+ } catch {}
+ printf("%d@%d test_blah Blah context=%p filename=%s\n", pid(), gettimeofday_ns(), context, argfilename_str)
+}
+probe qemu.log.test_wibble = qemu.test_wibble ?
+{
+ printf("%d@%d test_wibble Wibble context=%p value=%d\n", pid(), gettimeofday_ns(), context, value)
+}
+
diff --git a/tests/tracetool/dtrace.simpletrace-stap b/tests/tracetool/dtrace.simpletrace-stap
new file mode 100644
index 0000000000..d064e3e286
--- /dev/null
+++ b/tests/tracetool/dtrace.simpletrace-stap
@@ -0,0 +1,16 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+probe qemu.simpletrace.test_blah = qemu.test_blah ?
+{
+ try {
+ argfilename_str = filename ? user_string_n(filename, 512) : "<null>"
+ } catch {}
+ argfilename_len = strlen(argfilename_str)
+ printf("%8b%8b%8b%4b%4b%8b%4b%.*s", 1, 0, gettimeofday_ns(), 24 + 8 + 4 + argfilename_len, pid(), context, argfilename_len, argfilename_len, argfilename_str)
+}
+probe qemu.simpletrace.test_wibble = qemu.test_wibble ?
+{
+ printf("%8b%8b%8b%4b%4b%8b%8b", 1, 1, gettimeofday_ns(), 24 + 8 + 8, pid(), context, value)
+}
+
diff --git a/tests/tracetool/dtrace.stap b/tests/tracetool/dtrace.stap
new file mode 100644
index 0000000000..9c5d8a527c
--- /dev/null
+++ b/tests/tracetool/dtrace.stap
@@ -0,0 +1,14 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+probe qemu.test_blah = process("qemu").mark("test_blah")
+{
+ context = $arg1;
+ filename = $arg2;
+}
+probe qemu.test_wibble = process("qemu").mark("test_wibble")
+{
+ context = $arg1;
+ value = $arg2;
+}
+
diff --git a/tests/tracetool/ftrace.c b/tests/tracetool/ftrace.c
new file mode 100644
index 0000000000..9f862fa14d
--- /dev/null
+++ b/tests/tracetool/ftrace.c
@@ -0,0 +1,32 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "trace-testsuite.h"
+
+uint16_t _TRACE_TEST_BLAH_DSTATE;
+uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+TraceEvent _TRACE_TEST_BLAH_EVENT = {
+ .id = 0,
+ .name = "test_blah",
+ .sstate = TRACE_TEST_BLAH_ENABLED,
+ .dstate = &_TRACE_TEST_BLAH_DSTATE
+};
+TraceEvent _TRACE_TEST_WIBBLE_EVENT = {
+ .id = 0,
+ .name = "test_wibble",
+ .sstate = TRACE_TEST_WIBBLE_ENABLED,
+ .dstate = &_TRACE_TEST_WIBBLE_DSTATE
+};
+TraceEvent *testsuite_trace_events[] = {
+ &_TRACE_TEST_BLAH_EVENT,
+ &_TRACE_TEST_WIBBLE_EVENT,
+ NULL,
+};
+
+static void trace_testsuite_register_events(void)
+{
+ trace_event_register_group(testsuite_trace_events);
+}
+trace_init(trace_testsuite_register_events)
diff --git a/tests/tracetool/ftrace.h b/tests/tracetool/ftrace.h
new file mode 100644
index 0000000000..f1ff3b0a62
--- /dev/null
+++ b/tests/tracetool/ftrace.h
@@ -0,0 +1,73 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef TRACE_TESTSUITE_GENERATED_TRACERS_H
+#define TRACE_TESTSUITE_GENERATED_TRACERS_H
+
+#include "trace/control.h"
+
+extern TraceEvent _TRACE_TEST_BLAH_EVENT;
+extern TraceEvent _TRACE_TEST_WIBBLE_EVENT;
+extern uint16_t _TRACE_TEST_BLAH_DSTATE;
+extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+#define TRACE_TEST_BLAH_ENABLED 1
+#define TRACE_TEST_WIBBLE_ENABLED 1
+#include "trace/ftrace.h"
+
+
+#define TRACE_TEST_BLAH_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
+ false)
+
+static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+{
+ {
+ char ftrace_buf[MAX_TRACE_STRLEN];
+ int unused __attribute__ ((unused));
+ int trlen;
+ if (trace_event_get_state(TRACE_TEST_BLAH)) {
+#line 4 "trace-events"
+ trlen = snprintf(ftrace_buf, MAX_TRACE_STRLEN,
+ "test_blah " "Blah context=%p filename=%s" "\n" , context, filename);
+#line 33 "ftrace.h"
+ trlen = MIN(trlen, MAX_TRACE_STRLEN - 1);
+ unused = write(trace_marker_fd, ftrace_buf, trlen);
+ }
+ }
+}
+
+static inline void trace_test_blah(void *context, const char *filename)
+{
+ if (true) {
+ _nocheck__trace_test_blah(context, filename);
+ }
+}
+
+#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
+ false)
+
+static inline void _nocheck__trace_test_wibble(void *context, int value)
+{
+ {
+ char ftrace_buf[MAX_TRACE_STRLEN];
+ int unused __attribute__ ((unused));
+ int trlen;
+ if (trace_event_get_state(TRACE_TEST_WIBBLE)) {
+#line 5 "trace-events"
+ trlen = snprintf(ftrace_buf, MAX_TRACE_STRLEN,
+ "test_wibble " "Wibble context=%p value=%d" "\n" , context, value);
+#line 61 "ftrace.h"
+ trlen = MIN(trlen, MAX_TRACE_STRLEN - 1);
+ unused = write(trace_marker_fd, ftrace_buf, trlen);
+ }
+ }
+}
+
+static inline void trace_test_wibble(void *context, int value)
+{
+ if (true) {
+ _nocheck__trace_test_wibble(context, value);
+ }
+}
+#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/log.c b/tests/tracetool/log.c
new file mode 100644
index 0000000000..9f862fa14d
--- /dev/null
+++ b/tests/tracetool/log.c
@@ -0,0 +1,32 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "trace-testsuite.h"
+
+uint16_t _TRACE_TEST_BLAH_DSTATE;
+uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+TraceEvent _TRACE_TEST_BLAH_EVENT = {
+ .id = 0,
+ .name = "test_blah",
+ .sstate = TRACE_TEST_BLAH_ENABLED,
+ .dstate = &_TRACE_TEST_BLAH_DSTATE
+};
+TraceEvent _TRACE_TEST_WIBBLE_EVENT = {
+ .id = 0,
+ .name = "test_wibble",
+ .sstate = TRACE_TEST_WIBBLE_ENABLED,
+ .dstate = &_TRACE_TEST_WIBBLE_DSTATE
+};
+TraceEvent *testsuite_trace_events[] = {
+ &_TRACE_TEST_BLAH_EVENT,
+ &_TRACE_TEST_WIBBLE_EVENT,
+ NULL,
+};
+
+static void trace_testsuite_register_events(void)
+{
+ trace_event_register_group(testsuite_trace_events);
+}
+trace_init(trace_testsuite_register_events)
diff --git a/tests/tracetool/log.h b/tests/tracetool/log.h
new file mode 100644
index 0000000000..4293f1010e
--- /dev/null
+++ b/tests/tracetool/log.h
@@ -0,0 +1,57 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef TRACE_TESTSUITE_GENERATED_TRACERS_H
+#define TRACE_TESTSUITE_GENERATED_TRACERS_H
+
+#include "trace/control.h"
+
+extern TraceEvent _TRACE_TEST_BLAH_EVENT;
+extern TraceEvent _TRACE_TEST_WIBBLE_EVENT;
+extern uint16_t _TRACE_TEST_BLAH_DSTATE;
+extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+#define TRACE_TEST_BLAH_ENABLED 1
+#define TRACE_TEST_WIBBLE_ENABLED 1
+#include "qemu/log-for-trace.h"
+
+
+#define TRACE_TEST_BLAH_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
+ false)
+
+static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+{
+ if (trace_event_get_state(TRACE_TEST_BLAH) && qemu_loglevel_mask(LOG_TRACE)) {
+#line 4 "trace-events"
+ qemu_log("test_blah " "Blah context=%p filename=%s" "\n", context, filename);
+#line 28 "log.h"
+ }
+}
+
+static inline void trace_test_blah(void *context, const char *filename)
+{
+ if (true) {
+ _nocheck__trace_test_blah(context, filename);
+ }
+}
+
+#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
+ false)
+
+static inline void _nocheck__trace_test_wibble(void *context, int value)
+{
+ if (trace_event_get_state(TRACE_TEST_WIBBLE) && qemu_loglevel_mask(LOG_TRACE)) {
+#line 5 "trace-events"
+ qemu_log("test_wibble " "Wibble context=%p value=%d" "\n", context, value);
+#line 48 "log.h"
+ }
+}
+
+static inline void trace_test_wibble(void *context, int value)
+{
+ if (true) {
+ _nocheck__trace_test_wibble(context, value);
+ }
+}
+#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/meson.build b/tests/tracetool/meson.build
new file mode 100644
index 0000000000..09bbaaa86b
--- /dev/null
+++ b/tests/tracetool/meson.build
@@ -0,0 +1,28 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+test_env = environment()
+test_env.set('PYTHONPATH', meson.project_source_root() / 'scripts')
+test_env.set('PYTHONIOENCODING', 'utf-8')
+
+backends = [
+ 'dtrace',
+ 'ftrace',
+ 'log',
+ 'simple',
+ 'syslog',
+ 'ust'
+]
+
+# The tracetool-test.py program has portability problems on Windows.
+if host_machine.system() != 'windows'
+ foreach backend: backends
+ test(backend,
+ python,
+ args: [meson.current_source_dir() / 'tracetool-test.py',
+ meson.project_source_root() / 'scripts' / 'tracetool.py',
+ backend,
+ meson.current_source_dir(),
+ meson.current_build_dir()],
+ suite: ['tracetool'])
+ endforeach
+endif
diff --git a/tests/tracetool/simple.c b/tests/tracetool/simple.c
new file mode 100644
index 0000000000..0484177481
--- /dev/null
+++ b/tests/tracetool/simple.c
@@ -0,0 +1,61 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "trace-testsuite.h"
+
+uint16_t _TRACE_TEST_BLAH_DSTATE;
+uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+TraceEvent _TRACE_TEST_BLAH_EVENT = {
+ .id = 0,
+ .name = "test_blah",
+ .sstate = TRACE_TEST_BLAH_ENABLED,
+ .dstate = &_TRACE_TEST_BLAH_DSTATE
+};
+TraceEvent _TRACE_TEST_WIBBLE_EVENT = {
+ .id = 0,
+ .name = "test_wibble",
+ .sstate = TRACE_TEST_WIBBLE_ENABLED,
+ .dstate = &_TRACE_TEST_WIBBLE_DSTATE
+};
+TraceEvent *testsuite_trace_events[] = {
+ &_TRACE_TEST_BLAH_EVENT,
+ &_TRACE_TEST_WIBBLE_EVENT,
+ NULL,
+};
+
+static void trace_testsuite_register_events(void)
+{
+ trace_event_register_group(testsuite_trace_events);
+}
+trace_init(trace_testsuite_register_events)
+#include "qemu/osdep.h"
+#include "trace/control.h"
+#include "trace/simple.h"
+
+void _simple_trace_test_blah(void *context, const char *filename)
+{
+ TraceBufferRecord rec;
+ size_t argfilename_len = filename ? MIN(strlen(filename), MAX_TRACE_STRLEN) : 0;
+
+ if (trace_record_start(&rec, _TRACE_TEST_BLAH_EVENT.id, 8 + 4 + argfilename_len)) {
+ return; /* Trace Buffer Full, Event Dropped ! */
+ }
+ trace_record_write_u64(&rec, (uintptr_t)(uint64_t *)context);
+ trace_record_write_str(&rec, filename, argfilename_len);
+ trace_record_finish(&rec);
+}
+
+void _simple_trace_test_wibble(void *context, int value)
+{
+ TraceBufferRecord rec;
+
+ if (trace_record_start(&rec, _TRACE_TEST_WIBBLE_EVENT.id, 8 + 8)) {
+ return; /* Trace Buffer Full, Event Dropped ! */
+ }
+ trace_record_write_u64(&rec, (uintptr_t)(uint64_t *)context);
+ trace_record_write_u64(&rec, (uint64_t)value);
+ trace_record_finish(&rec);
+}
+
diff --git a/tests/tracetool/simple.h b/tests/tracetool/simple.h
new file mode 100644
index 0000000000..3c9de68c43
--- /dev/null
+++ b/tests/tracetool/simple.h
@@ -0,0 +1,54 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef TRACE_TESTSUITE_GENERATED_TRACERS_H
+#define TRACE_TESTSUITE_GENERATED_TRACERS_H
+
+#include "trace/control.h"
+
+extern TraceEvent _TRACE_TEST_BLAH_EVENT;
+extern TraceEvent _TRACE_TEST_WIBBLE_EVENT;
+extern uint16_t _TRACE_TEST_BLAH_DSTATE;
+extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+#define TRACE_TEST_BLAH_ENABLED 1
+#define TRACE_TEST_WIBBLE_ENABLED 1
+void _simple_trace_test_blah(void *context, const char *filename);
+void _simple_trace_test_wibble(void *context, int value);
+
+
+#define TRACE_TEST_BLAH_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
+ false)
+
+static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+{
+ if (trace_event_get_state(TRACE_TEST_BLAH)) {
+ _simple_trace_test_blah(context, filename);
+ }
+}
+
+static inline void trace_test_blah(void *context, const char *filename)
+{
+ if (true) {
+ _nocheck__trace_test_blah(context, filename);
+ }
+}
+
+#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
+ false)
+
+static inline void _nocheck__trace_test_wibble(void *context, int value)
+{
+ if (trace_event_get_state(TRACE_TEST_WIBBLE)) {
+ _simple_trace_test_wibble(context, value);
+ }
+}
+
+static inline void trace_test_wibble(void *context, int value)
+{
+ if (true) {
+ _nocheck__trace_test_wibble(context, value);
+ }
+}
+#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/syslog.c b/tests/tracetool/syslog.c
new file mode 100644
index 0000000000..9f862fa14d
--- /dev/null
+++ b/tests/tracetool/syslog.c
@@ -0,0 +1,32 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "trace-testsuite.h"
+
+uint16_t _TRACE_TEST_BLAH_DSTATE;
+uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+TraceEvent _TRACE_TEST_BLAH_EVENT = {
+ .id = 0,
+ .name = "test_blah",
+ .sstate = TRACE_TEST_BLAH_ENABLED,
+ .dstate = &_TRACE_TEST_BLAH_DSTATE
+};
+TraceEvent _TRACE_TEST_WIBBLE_EVENT = {
+ .id = 0,
+ .name = "test_wibble",
+ .sstate = TRACE_TEST_WIBBLE_ENABLED,
+ .dstate = &_TRACE_TEST_WIBBLE_DSTATE
+};
+TraceEvent *testsuite_trace_events[] = {
+ &_TRACE_TEST_BLAH_EVENT,
+ &_TRACE_TEST_WIBBLE_EVENT,
+ NULL,
+};
+
+static void trace_testsuite_register_events(void)
+{
+ trace_event_register_group(testsuite_trace_events);
+}
+trace_init(trace_testsuite_register_events)
diff --git a/tests/tracetool/syslog.h b/tests/tracetool/syslog.h
new file mode 100644
index 0000000000..498bbfb99e
--- /dev/null
+++ b/tests/tracetool/syslog.h
@@ -0,0 +1,57 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef TRACE_TESTSUITE_GENERATED_TRACERS_H
+#define TRACE_TESTSUITE_GENERATED_TRACERS_H
+
+#include "trace/control.h"
+
+extern TraceEvent _TRACE_TEST_BLAH_EVENT;
+extern TraceEvent _TRACE_TEST_WIBBLE_EVENT;
+extern uint16_t _TRACE_TEST_BLAH_DSTATE;
+extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+#define TRACE_TEST_BLAH_ENABLED 1
+#define TRACE_TEST_WIBBLE_ENABLED 1
+#include <syslog.h>
+
+
+#define TRACE_TEST_BLAH_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
+ false)
+
+static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+{
+ if (trace_event_get_state(TRACE_TEST_BLAH)) {
+#line 4 "trace-events"
+ syslog(LOG_INFO, "test_blah " "Blah context=%p filename=%s" , context, filename);
+#line 28 "syslog.h"
+ }
+}
+
+static inline void trace_test_blah(void *context, const char *filename)
+{
+ if (true) {
+ _nocheck__trace_test_blah(context, filename);
+ }
+}
+
+#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
+ trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
+ false)
+
+static inline void _nocheck__trace_test_wibble(void *context, int value)
+{
+ if (trace_event_get_state(TRACE_TEST_WIBBLE)) {
+#line 5 "trace-events"
+ syslog(LOG_INFO, "test_wibble " "Wibble context=%p value=%d" , context, value);
+#line 48 "syslog.h"
+ }
+}
+
+static inline void trace_test_wibble(void *context, int value)
+{
+ if (true) {
+ _nocheck__trace_test_wibble(context, value);
+ }
+}
+#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/trace-events b/tests/tracetool/trace-events
new file mode 100644
index 0000000000..72cf4d6f70
--- /dev/null
+++ b/tests/tracetool/trace-events
@@ -0,0 +1,5 @@
+# See docs/devel/tracing.rst for syntax documentation.
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+test_blah(void *context, const char *filename) "Blah context=%p filename=%s"
+test_wibble(void *context, int value) "Wibble context=%p value=%d"
diff --git a/tests/tracetool/tracetool-test.py b/tests/tracetool/tracetool-test.py
new file mode 100755
index 0000000000..a420597fc4
--- /dev/null
+++ b/tests/tracetool/tracetool-test.py
@@ -0,0 +1,105 @@
+#!/usr/bin/python3
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import os
+from pathlib import Path
+from shutil import copyfile
+from subprocess import check_call
+import sys
+
+
+def get_formats(backend):
+ formats = [
+ "c",
+ "h",
+ ]
+ if backend == "dtrace":
+ formats += [
+ "d",
+ "log-stap",
+ "simpletrace-stap",
+ "stap",
+ ]
+ if backend == "ust":
+ formats += [
+ "ust-events-c",
+ "ust-events-h",
+ ]
+ return formats
+
+
+def test_tracetool_one(tracetool, backend, fmt, src_dir, build_dir):
+ rel_filename = backend + "." + fmt
+ actual_file = Path(build_dir, rel_filename)
+ expect_file = Path(src_dir, rel_filename)
+
+ args = [tracetool, f"--format={fmt}", f"--backends={backend}", "--group=testsuite"]
+
+ if fmt.find("stap") != -1:
+ args += ["--binary=qemu", "--probe-prefix=qemu"]
+
+ # Use relative files for both, as these filenames end
+ # up in '#line' statements in the output
+ args += ["trace-events", rel_filename]
+
+ try:
+ check_call(args, cwd=build_dir)
+ actual = actual_file.read_text()
+ finally:
+ actual_file.unlink()
+
+ if os.getenv("QEMU_TEST_REGENERATE", False):
+ print(f"# regenerate {expect_file}")
+ expect_file.write_text(actual)
+
+ expect = expect_file.read_text()
+
+ assert expect == actual
+
+
+def test_tracetool(tracetool, backend, source_dir, build_dir):
+ fail = False
+ scenarios = len(get_formats(backend))
+
+ print(f"1..{scenarios}")
+
+ src_events = Path(source_dir, "trace-events")
+ build_events = Path(build_dir, "trace-events")
+
+ try:
+ # We need a stable relative filename under build dir
+ # for the '#line' statements, so copy over the input
+ copyfile(src_events, build_events)
+
+ num = 1
+ for fmt in get_formats(backend):
+ status = "not ok"
+ hint = ""
+ try:
+ test_tracetool_one(tracetool, backend, fmt, source_dir, build_dir)
+ status = "ok"
+ except Exception as e:
+ print(f"# {e}")
+ fail = True
+ hint = (
+ " (set QEMU_TEST_REGENERATE=1 to recreate reference "
+ + "output if tracetool generator was intentionally changed)"
+ )
+ finally:
+ print(f"{status} {num} - {backend}.{fmt}{hint}")
+ finally:
+ build_events.unlink()
+
+ return fail
+
+
+if __name__ == "__main__":
+ if len(sys.argv) != 5:
+ argv0 = sys.argv[0]
+ print("syntax: {argv0} TRACE-TOOL BACKEND SRC-DIR BUILD-DIR", file=sys.stderr)
+ sys.exit(1)
+
+ fail = test_tracetool(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4])
+ if fail:
+ sys.exit(1)
+ sys.exit(0)
diff --git a/tests/tracetool/ust.c b/tests/tracetool/ust.c
new file mode 100644
index 0000000000..9f862fa14d
--- /dev/null
+++ b/tests/tracetool/ust.c
@@ -0,0 +1,32 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+#include "qemu/module.h"
+#include "trace-testsuite.h"
+
+uint16_t _TRACE_TEST_BLAH_DSTATE;
+uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+TraceEvent _TRACE_TEST_BLAH_EVENT = {
+ .id = 0,
+ .name = "test_blah",
+ .sstate = TRACE_TEST_BLAH_ENABLED,
+ .dstate = &_TRACE_TEST_BLAH_DSTATE
+};
+TraceEvent _TRACE_TEST_WIBBLE_EVENT = {
+ .id = 0,
+ .name = "test_wibble",
+ .sstate = TRACE_TEST_WIBBLE_ENABLED,
+ .dstate = &_TRACE_TEST_WIBBLE_DSTATE
+};
+TraceEvent *testsuite_trace_events[] = {
+ &_TRACE_TEST_BLAH_EVENT,
+ &_TRACE_TEST_WIBBLE_EVENT,
+ NULL,
+};
+
+static void trace_testsuite_register_events(void)
+{
+ trace_event_register_group(testsuite_trace_events);
+}
+trace_init(trace_testsuite_register_events)
diff --git a/tests/tracetool/ust.h b/tests/tracetool/ust.h
new file mode 100644
index 0000000000..1184ddd870
--- /dev/null
+++ b/tests/tracetool/ust.h
@@ -0,0 +1,55 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#ifndef TRACE_TESTSUITE_GENERATED_TRACERS_H
+#define TRACE_TESTSUITE_GENERATED_TRACERS_H
+
+#include "trace/control.h"
+
+extern TraceEvent _TRACE_TEST_BLAH_EVENT;
+extern TraceEvent _TRACE_TEST_WIBBLE_EVENT;
+extern uint16_t _TRACE_TEST_BLAH_DSTATE;
+extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
+#define TRACE_TEST_BLAH_ENABLED 1
+#define TRACE_TEST_WIBBLE_ENABLED 1
+#include <lttng/tracepoint.h>
+#include "trace-ust-testsuite.h"
+
+/* tracepoint_enabled() was introduced in LTTng UST 2.7 */
+#ifndef tracepoint_enabled
+#define tracepoint_enabled(a, b) true
+#endif
+
+
+#define TRACE_TEST_BLAH_BACKEND_DSTATE() ( \
+ tracepoint_enabled(qemu, test_blah) || \
+ false)
+
+static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+{
+ tracepoint(qemu, test_blah, context, filename);
+}
+
+static inline void trace_test_blah(void *context, const char *filename)
+{
+ if (true) {
+ _nocheck__trace_test_blah(context, filename);
+ }
+}
+
+#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
+ tracepoint_enabled(qemu, test_wibble) || \
+ false)
+
+static inline void _nocheck__trace_test_wibble(void *context, int value)
+{
+ tracepoint(qemu, test_wibble, context, value);
+}
+
+static inline void trace_test_wibble(void *context, int value)
+{
+ if (true) {
+ _nocheck__trace_test_wibble(context, value);
+ }
+}
+#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/ust.ust-events-c b/tests/tracetool/ust.ust-events-c
new file mode 100644
index 0000000000..db23224056
--- /dev/null
+++ b/tests/tracetool/ust.ust-events-c
@@ -0,0 +1,14 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include "qemu/osdep.h"
+
+#define TRACEPOINT_DEFINE
+#define TRACEPOINT_CREATE_PROBES
+
+/* If gcc version 4.7 or older is used, LTTng ust gives a warning when compiling with
+ -Wredundant-decls.
+ */
+#pragma GCC diagnostic ignored "-Wredundant-decls"
+
+#include "trace-ust-all.h"
diff --git a/tests/tracetool/ust.ust-events-h b/tests/tracetool/ust.ust-events-h
new file mode 100644
index 0000000000..4621a995fc
--- /dev/null
+++ b/tests/tracetool/ust.ust-events-h
@@ -0,0 +1,56 @@
+/* This file is autogenerated by tracetool, do not edit. */
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#undef TRACEPOINT_PROVIDER
+#define TRACEPOINT_PROVIDER qemu
+
+#undef TRACEPOINT_INCLUDE
+#define TRACEPOINT_INCLUDE "./trace-ust.h"
+
+#if !defined (TRACE_TESTSUITE_GENERATED_UST_H) || \
+ defined(TRACEPOINT_HEADER_MULTI_READ)
+#define TRACE_TESTSUITE_GENERATED_UST_H
+
+#include <lttng/tracepoint.h>
+
+/*
+ * LTTng ust 2.0 does not allow you to use TP_ARGS(void) for tracepoints
+ * requiring no arguments. We define these macros introduced in more recent * versions of LTTng ust as a workaround
+ */
+#ifndef _TP_EXPROTO1
+#define _TP_EXPROTO1(a) void
+#endif
+#ifndef _TP_EXDATA_PROTO1
+#define _TP_EXDATA_PROTO1(a) void *__tp_data
+#endif
+#ifndef _TP_EXDATA_VAR1
+#define _TP_EXDATA_VAR1(a) __tp_data
+#endif
+#ifndef _TP_EXVAR1
+#define _TP_EXVAR1(a)
+#endif
+
+TRACEPOINT_EVENT(
+ qemu,
+ test_blah,
+ TP_ARGS(void *, context, const char *, filename),
+ TP_FIELDS(
+ ctf_integer_hex(void *, context, context)
+ ctf_string(filename, filename)
+ )
+)
+
+TRACEPOINT_EVENT(
+ qemu,
+ test_wibble,
+ TP_ARGS(void *, context, int, value),
+ TP_FIELDS(
+ ctf_integer_hex(void *, context, context)
+ ctf_integer(int, value, value)
+ )
+)
+
+#endif /* TRACE_TESTSUITE_GENERATED_UST_H */
+
+/* This part must be outside ifdef protection */
+#include <lttng/tracepoint-event.h>
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* [PATCH v5 6/8] tracetool: drop the probe "__nocheck__" wrapping
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
` (4 preceding siblings ...)
2025-09-16 8:16 ` [PATCH v5 5/8] tracetool: add test suite for tracetool with reference output Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 7/8] qapi: switch to use QEMU_TEST_REGENERATE env var Daniel P. Berrangé
2025-09-16 8:16 ` [PATCH v5 8/8] tracetool-test: allow to run in parallel Daniel P. Berrangé
7 siblings, 0 replies; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
Every generated inline probe function is wrapped with a
trivial caller that has a hard-coded condition test:
static inline void _nocheck__trace_test_wibble(void * context, int value)
{
tracepoint(qemu, test_wibble, context, value);
}
static inline void trace_test_wibble(void * context, int value)
{
if (true) {
_nocheck__trace_test_wibble(context, value);
}
}
This was introduced for TCG probes back in
864a2178: trace: [tcg] Do not generate TCG code to trace dynamically-disabled events
but is obsolete since
126d4123 tracing: excise the tcg related from tracetool
This commit removes the wrapping such that we have
static inline void trace_test_wibble(void * context, int value)
{
tracepoint(qemu, test_wibble, context, value);
}
The default build of qemu-system-x86_64 on Fedora with the
'log' backend, has its size reduced by 1 MB
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
scripts/tracetool/__init__.py | 1 -
scripts/tracetool/format/h.py | 16 +---------------
tests/tracetool/dtrace.h | 18 ++----------------
tests/tracetool/ftrace.h | 20 +++-----------------
tests/tracetool/log.h | 20 +++-----------------
tests/tracetool/simple.h | 18 ++----------------
tests/tracetool/syslog.h | 20 +++-----------------
tests/tracetool/ust.h | 18 ++----------------
8 files changed, 16 insertions(+), 115 deletions(-)
diff --git a/scripts/tracetool/__init__.py b/scripts/tracetool/__init__.py
index 0f33758870..1d5238a084 100644
--- a/scripts/tracetool/__init__.py
+++ b/scripts/tracetool/__init__.py
@@ -338,7 +338,6 @@ def formats(self):
return self._FMT.findall(self.fmt)
QEMU_TRACE = "trace_%(name)s"
- QEMU_TRACE_NOCHECK = "_nocheck__" + QEMU_TRACE
QEMU_TRACE_TCG = QEMU_TRACE + "_tcg"
QEMU_DSTATE = "_TRACE_%(NAME)s_DSTATE"
QEMU_BACKEND_DSTATE = "TRACE_%(NAME)s_BACKEND_DSTATE"
diff --git a/scripts/tracetool/format/h.py b/scripts/tracetool/format/h.py
index a00ae475f7..b42a8268a8 100644
--- a/scripts/tracetool/format/h.py
+++ b/scripts/tracetool/format/h.py
@@ -64,7 +64,7 @@ def generate(events, backend, group):
out('',
'static inline void %(api)s(%(args)s)',
'{',
- api=e.api(e.QEMU_TRACE_NOCHECK),
+ api=e.api(),
args=e.args)
if "disable" not in e.properties:
@@ -72,20 +72,6 @@ def generate(events, backend, group):
out('}')
- cond = "true"
-
- out('',
- 'static inline void %(api)s(%(args)s)',
- '{',
- ' if (%(cond)s) {',
- ' %(api_nocheck)s(%(names)s);',
- ' }',
- '}',
- api=e.api(),
- api_nocheck=e.api(e.QEMU_TRACE_NOCHECK),
- args=e.args,
- names=", ".join(e.args.names()),
- cond=cond)
backend.generate_end(events, group)
diff --git a/tests/tracetool/dtrace.h b/tests/tracetool/dtrace.h
index c2e5110672..c8931a8d7b 100644
--- a/tests/tracetool/dtrace.h
+++ b/tests/tracetool/dtrace.h
@@ -29,31 +29,17 @@ extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
QEMU_TEST_BLAH_ENABLED() || \
false)
-static inline void _nocheck__trace_test_blah(void *context, const char *filename)
-{
- QEMU_TEST_BLAH(context, filename);
-}
-
static inline void trace_test_blah(void *context, const char *filename)
{
- if (true) {
- _nocheck__trace_test_blah(context, filename);
- }
+ QEMU_TEST_BLAH(context, filename);
}
#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
QEMU_TEST_WIBBLE_ENABLED() || \
false)
-static inline void _nocheck__trace_test_wibble(void *context, int value)
-{
- QEMU_TEST_WIBBLE(context, value);
-}
-
static inline void trace_test_wibble(void *context, int value)
{
- if (true) {
- _nocheck__trace_test_wibble(context, value);
- }
+ QEMU_TEST_WIBBLE(context, value);
}
#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/ftrace.h b/tests/tracetool/ftrace.h
index f1ff3b0a62..fe22ea0f09 100644
--- a/tests/tracetool/ftrace.h
+++ b/tests/tracetool/ftrace.h
@@ -19,7 +19,7 @@ extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
false)
-static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+static inline void trace_test_blah(void *context, const char *filename)
{
{
char ftrace_buf[MAX_TRACE_STRLEN];
@@ -36,18 +36,11 @@ static inline void _nocheck__trace_test_blah(void *context, const char *filename
}
}
-static inline void trace_test_blah(void *context, const char *filename)
-{
- if (true) {
- _nocheck__trace_test_blah(context, filename);
- }
-}
-
#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
false)
-static inline void _nocheck__trace_test_wibble(void *context, int value)
+static inline void trace_test_wibble(void *context, int value)
{
{
char ftrace_buf[MAX_TRACE_STRLEN];
@@ -57,17 +50,10 @@ static inline void _nocheck__trace_test_wibble(void *context, int value)
#line 5 "trace-events"
trlen = snprintf(ftrace_buf, MAX_TRACE_STRLEN,
"test_wibble " "Wibble context=%p value=%d" "\n" , context, value);
-#line 61 "ftrace.h"
+#line 54 "ftrace.h"
trlen = MIN(trlen, MAX_TRACE_STRLEN - 1);
unused = write(trace_marker_fd, ftrace_buf, trlen);
}
}
}
-
-static inline void trace_test_wibble(void *context, int value)
-{
- if (true) {
- _nocheck__trace_test_wibble(context, value);
- }
-}
#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/log.h b/tests/tracetool/log.h
index 4293f1010e..edcc7f9d47 100644
--- a/tests/tracetool/log.h
+++ b/tests/tracetool/log.h
@@ -19,7 +19,7 @@ extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
false)
-static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+static inline void trace_test_blah(void *context, const char *filename)
{
if (trace_event_get_state(TRACE_TEST_BLAH) && qemu_loglevel_mask(LOG_TRACE)) {
#line 4 "trace-events"
@@ -28,30 +28,16 @@ static inline void _nocheck__trace_test_blah(void *context, const char *filename
}
}
-static inline void trace_test_blah(void *context, const char *filename)
-{
- if (true) {
- _nocheck__trace_test_blah(context, filename);
- }
-}
-
#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
false)
-static inline void _nocheck__trace_test_wibble(void *context, int value)
+static inline void trace_test_wibble(void *context, int value)
{
if (trace_event_get_state(TRACE_TEST_WIBBLE) && qemu_loglevel_mask(LOG_TRACE)) {
#line 5 "trace-events"
qemu_log("test_wibble " "Wibble context=%p value=%d" "\n", context, value);
-#line 48 "log.h"
- }
-}
-
-static inline void trace_test_wibble(void *context, int value)
-{
- if (true) {
- _nocheck__trace_test_wibble(context, value);
+#line 41 "log.h"
}
}
#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/simple.h b/tests/tracetool/simple.h
index 3c9de68c43..ec6fcb22c3 100644
--- a/tests/tracetool/simple.h
+++ b/tests/tracetool/simple.h
@@ -20,35 +20,21 @@ void _simple_trace_test_wibble(void *context, int value);
trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
false)
-static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+static inline void trace_test_blah(void *context, const char *filename)
{
if (trace_event_get_state(TRACE_TEST_BLAH)) {
_simple_trace_test_blah(context, filename);
}
}
-static inline void trace_test_blah(void *context, const char *filename)
-{
- if (true) {
- _nocheck__trace_test_blah(context, filename);
- }
-}
-
#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
false)
-static inline void _nocheck__trace_test_wibble(void *context, int value)
+static inline void trace_test_wibble(void *context, int value)
{
if (trace_event_get_state(TRACE_TEST_WIBBLE)) {
_simple_trace_test_wibble(context, value);
}
}
-
-static inline void trace_test_wibble(void *context, int value)
-{
- if (true) {
- _nocheck__trace_test_wibble(context, value);
- }
-}
#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/syslog.h b/tests/tracetool/syslog.h
index 498bbfb99e..ed4305554c 100644
--- a/tests/tracetool/syslog.h
+++ b/tests/tracetool/syslog.h
@@ -19,7 +19,7 @@ extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
trace_event_get_state_dynamic_by_id(TRACE_TEST_BLAH) || \
false)
-static inline void _nocheck__trace_test_blah(void *context, const char *filename)
+static inline void trace_test_blah(void *context, const char *filename)
{
if (trace_event_get_state(TRACE_TEST_BLAH)) {
#line 4 "trace-events"
@@ -28,30 +28,16 @@ static inline void _nocheck__trace_test_blah(void *context, const char *filename
}
}
-static inline void trace_test_blah(void *context, const char *filename)
-{
- if (true) {
- _nocheck__trace_test_blah(context, filename);
- }
-}
-
#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
trace_event_get_state_dynamic_by_id(TRACE_TEST_WIBBLE) || \
false)
-static inline void _nocheck__trace_test_wibble(void *context, int value)
+static inline void trace_test_wibble(void *context, int value)
{
if (trace_event_get_state(TRACE_TEST_WIBBLE)) {
#line 5 "trace-events"
syslog(LOG_INFO, "test_wibble " "Wibble context=%p value=%d" , context, value);
-#line 48 "syslog.h"
- }
-}
-
-static inline void trace_test_wibble(void *context, int value)
-{
- if (true) {
- _nocheck__trace_test_wibble(context, value);
+#line 41 "syslog.h"
}
}
#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
diff --git a/tests/tracetool/ust.h b/tests/tracetool/ust.h
index 1184ddd870..b7acd0c39b 100644
--- a/tests/tracetool/ust.h
+++ b/tests/tracetool/ust.h
@@ -25,31 +25,17 @@ extern uint16_t _TRACE_TEST_WIBBLE_DSTATE;
tracepoint_enabled(qemu, test_blah) || \
false)
-static inline void _nocheck__trace_test_blah(void *context, const char *filename)
-{
- tracepoint(qemu, test_blah, context, filename);
-}
-
static inline void trace_test_blah(void *context, const char *filename)
{
- if (true) {
- _nocheck__trace_test_blah(context, filename);
- }
+ tracepoint(qemu, test_blah, context, filename);
}
#define TRACE_TEST_WIBBLE_BACKEND_DSTATE() ( \
tracepoint_enabled(qemu, test_wibble) || \
false)
-static inline void _nocheck__trace_test_wibble(void *context, int value)
-{
- tracepoint(qemu, test_wibble, context, value);
-}
-
static inline void trace_test_wibble(void *context, int value)
{
- if (true) {
- _nocheck__trace_test_wibble(context, value);
- }
+ tracepoint(qemu, test_wibble, context, value);
}
#endif /* TRACE_TESTSUITE_GENERATED_TRACERS_H */
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* [PATCH v5 7/8] qapi: switch to use QEMU_TEST_REGENERATE env var
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
` (5 preceding siblings ...)
2025-09-16 8:16 ` [PATCH v5 6/8] tracetool: drop the probe "__nocheck__" wrapping Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-16 13:30 ` Markus Armbruster
2025-09-16 8:16 ` [PATCH v5 8/8] tracetool-test: allow to run in parallel Daniel P. Berrangé
7 siblings, 1 reply; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé
The QAPI_TEST_UPDATE env var can be set when running the QAPI
schema tests to regenerate the reference output. For consistent
naming with the tracetool test, change the env var name to
QEMU_TEST_REGENERATE.
The test is modified to provide a hint about use of the new
env var and it is also added to the developer documentation.document its usage.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
docs/devel/testing/main.rst | 12 ++++++++++++
tests/qapi-schema/test-qapi.py | 7 +++++--
2 files changed, 17 insertions(+), 2 deletions(-)
diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst
index 11f05c0006..0662766b5c 100644
--- a/docs/devel/testing/main.rst
+++ b/docs/devel/testing/main.rst
@@ -178,6 +178,18 @@ parser (either fixing a bug or extending/modifying the syntax). To do this:
``qapi-schema += foo.json``
+The reference output can be automatically updated to match the latest QAPI
+code generator by running the tests with the QEMU_TEST_REGENERATE environment
+variable set.
+
+.. code::
+
+ QEMU_TEST_REGENERATE=1 make check-qapi-schema
+
+The resulting changes must be reviewed by the author to ensure they match
+the intended results before adding the updated reference output to the
+same commit that alters the generator code.
+
.. _tracetool-tests:
Tracetool tests
diff --git a/tests/qapi-schema/test-qapi.py b/tests/qapi-schema/test-qapi.py
index 4be930228c..cf7fb8a6df 100755
--- a/tests/qapi-schema/test-qapi.py
+++ b/tests/qapi-schema/test-qapi.py
@@ -165,7 +165,7 @@ def test_and_diff(test_name, dir_name, update):
if actual_out == expected_out and actual_err == expected_err:
return 0
- print("%s %s" % (test_name, 'UPDATE' if update else 'FAIL'),
+ print("%s: %s" % (test_name, 'UPDATE' if update else 'FAIL'),
file=sys.stderr)
out_diff = difflib.unified_diff(expected_out, actual_out, outfp.name)
err_diff = difflib.unified_diff(expected_err, actual_err, errfp.name)
@@ -173,6 +173,9 @@ def test_and_diff(test_name, dir_name, update):
sys.stdout.writelines(err_diff)
if not update:
+ print(("\n%s: set QEMU_TEST_REGENERATE=1 to recreate reference output" +
+ "if the QAPI schema generator was intentionally changed") % test_name,
+ file=sys.stderr)
return 1
try:
@@ -197,7 +200,7 @@ def main(argv):
parser.add_argument('-d', '--dir', action='store', default='',
help="directory containing tests")
parser.add_argument('-u', '--update', action='store_true',
- default='QAPI_TEST_UPDATE' in os.environ,
+ default='QEMU_TEST_REGENERATE' in os.environ,
help="update expected test results")
parser.add_argument('tests', nargs='*', metavar='TEST', action='store')
args = parser.parse_args()
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* Re: [PATCH v5 7/8] qapi: switch to use QEMU_TEST_REGENERATE env var
2025-09-16 8:16 ` [PATCH v5 7/8] qapi: switch to use QEMU_TEST_REGENERATE env var Daniel P. Berrangé
@ 2025-09-16 13:30 ` Markus Armbruster
0 siblings, 0 replies; 11+ messages in thread
From: Markus Armbruster @ 2025-09-16 13:30 UTC (permalink / raw)
To: Daniel P. Berrangé
Cc: qemu-devel, Thomas Huth, Michael Roth, Stefan Hajnoczi,
Paolo Bonzini, Mads Ynddal, Alex Bennée,
Philippe Mathieu-Daudé
Daniel P. Berrangé <berrange@redhat.com> writes:
> The QAPI_TEST_UPDATE env var can be set when running the QAPI
> schema tests to regenerate the reference output. For consistent
> naming with the tracetool test, change the env var name to
> QEMU_TEST_REGENERATE.
>
> The test is modified to provide a hint about use of the new
> env var and it is also added to the developer documentation.document its usage.
>
> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
> docs/devel/testing/main.rst | 12 ++++++++++++
> tests/qapi-schema/test-qapi.py | 7 +++++--
> 2 files changed, 17 insertions(+), 2 deletions(-)
>
> diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst
> index 11f05c0006..0662766b5c 100644
> --- a/docs/devel/testing/main.rst
> +++ b/docs/devel/testing/main.rst
> @@ -178,6 +178,18 @@ parser (either fixing a bug or extending/modifying the syntax). To do this:
>
> ``qapi-schema += foo.json``
>
> +The reference output can be automatically updated to match the latest QAPI
> +code generator by running the tests with the QEMU_TEST_REGENERATE environment
> +variable set.
> +
> +.. code::
> +
> + QEMU_TEST_REGENERATE=1 make check-qapi-schema
> +
> +The resulting changes must be reviewed by the author to ensure they match
> +the intended results before adding the updated reference output to the
> +same commit that alters the generator code.
> +
> .. _tracetool-tests:
>
> Tracetool tests
Appreciated, thanks!
> diff --git a/tests/qapi-schema/test-qapi.py b/tests/qapi-schema/test-qapi.py
> index 4be930228c..cf7fb8a6df 100755
> --- a/tests/qapi-schema/test-qapi.py
> +++ b/tests/qapi-schema/test-qapi.py
> @@ -165,7 +165,7 @@ def test_and_diff(test_name, dir_name, update):
> if actual_out == expected_out and actual_err == expected_err:
> return 0
>
> - print("%s %s" % (test_name, 'UPDATE' if update else 'FAIL'),
> + print("%s: %s" % (test_name, 'UPDATE' if update else 'FAIL'),
I would've left this out just to keep the patch focused. Definitely not
worth a respin now.
> file=sys.stderr)
> out_diff = difflib.unified_diff(expected_out, actual_out, outfp.name)
> err_diff = difflib.unified_diff(expected_err, actual_err, errfp.name)
> @@ -173,6 +173,9 @@ def test_and_diff(test_name, dir_name, update):
> sys.stdout.writelines(err_diff)
>
> if not update:
> + print(("\n%s: set QEMU_TEST_REGENERATE=1 to recreate reference output" +
> + "if the QAPI schema generator was intentionally changed") % test_name,
> + file=sys.stderr)
> return 1
>
> try:
> @@ -197,7 +200,7 @@ def main(argv):
> parser.add_argument('-d', '--dir', action='store', default='',
> help="directory containing tests")
> parser.add_argument('-u', '--update', action='store_true',
> - default='QAPI_TEST_UPDATE' in os.environ,
> + default='QEMU_TEST_REGENERATE' in os.environ,
> help="update expected test results")
> parser.add_argument('tests', nargs='*', metavar='TEST', action='store')
> args = parser.parse_args()
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 11+ messages in thread
* [PATCH v5 8/8] tracetool-test: allow to run in parallel
2025-09-16 8:16 [PATCH v5 0/8] tracetool: add test suite to improve reviewability Daniel P. Berrangé
` (6 preceding siblings ...)
2025-09-16 8:16 ` [PATCH v5 7/8] qapi: switch to use QEMU_TEST_REGENERATE env var Daniel P. Berrangé
@ 2025-09-16 8:16 ` Daniel P. Berrangé
2025-09-23 10:50 ` Philippe Mathieu-Daudé
7 siblings, 1 reply; 11+ messages in thread
From: Daniel P. Berrangé @ 2025-09-16 8:16 UTC (permalink / raw)
To: qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Philippe Mathieu-Daudé,
Markus Armbruster, Daniel P. Berrangé,
Marc-André Lureau
From: Marc-André Lureau <marcandre.lureau@redhat.com>
Create a temporary build subdirectory, to avoid conflicting with other
running tests. This fixes "meson test" with tracetool-test which is
parallel default.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-ID: <20250908114652.1880366-1-marcandre.lureau@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
tests/tracetool/tracetool-test.py | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/tests/tracetool/tracetool-test.py b/tests/tracetool/tracetool-test.py
index a420597fc4..65430fdedc 100755
--- a/tests/tracetool/tracetool-test.py
+++ b/tests/tracetool/tracetool-test.py
@@ -6,6 +6,7 @@
from shutil import copyfile
from subprocess import check_call
import sys
+import tempfile
def get_formats(backend):
@@ -99,7 +100,8 @@ def test_tracetool(tracetool, backend, source_dir, build_dir):
print("syntax: {argv0} TRACE-TOOL BACKEND SRC-DIR BUILD-DIR", file=sys.stderr)
sys.exit(1)
- fail = test_tracetool(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4])
- if fail:
- sys.exit(1)
+ with tempfile.TemporaryDirectory(prefix=sys.argv[4]) as tmpdir:
+ fail = test_tracetool(sys.argv[1], sys.argv[2], sys.argv[3], tmpdir)
+ if fail:
+ sys.exit(1)
sys.exit(0)
--
2.50.1
^ permalink raw reply related [flat|nested] 11+ messages in thread* Re: [PATCH v5 8/8] tracetool-test: allow to run in parallel
2025-09-16 8:16 ` [PATCH v5 8/8] tracetool-test: allow to run in parallel Daniel P. Berrangé
@ 2025-09-23 10:50 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 11+ messages in thread
From: Philippe Mathieu-Daudé @ 2025-09-23 10:50 UTC (permalink / raw)
To: Daniel P. Berrangé, qemu-devel
Cc: Thomas Huth, Michael Roth, Stefan Hajnoczi, Paolo Bonzini,
Mads Ynddal, Alex Bennée, Markus Armbruster,
Marc-André Lureau
On 16/9/25 10:16, Daniel P. Berrangé wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> Create a temporary build subdirectory, to avoid conflicting with other
> running tests. This fixes "meson test" with tracetool-test which is
> parallel default.
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> Message-ID: <20250908114652.1880366-1-marcandre.lureau@redhat.com>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
> tests/tracetool/tracetool-test.py | 8 +++++---
> 1 file changed, 5 insertions(+), 3 deletions(-)
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
^ permalink raw reply [flat|nested] 11+ messages in thread