qemu-cr16/tests/tracetool/ust.ust-events-h
Daniel P. Berrangé da949d495d tracetool: add test suite for tracetool with reference output
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>
Message-id: 20250916081638.764020-6-berrange@redhat.com
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
2025-09-16 13:31:40 -04:00

56 lines
1.4 KiB
Text

/* 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>