Skip to contentSkip to conversation

trace: Clarify DTrace/SystemTap help message

PATCH Applied Philippe Mathieu-Daudé 2 participants 2 messages Aug 23, 2019 – Aug 27, 2019

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 trace: Clarify DTrace/SystemTap help message

Most tracing backends are implemented within QEMU, except the DTrace/SystemTap backends.

One side effect is when running 'qemu -trace help', an incomplete list of trace events is displayed when using the DTrace/SystemTap backends.

This is partly due to trace events registered as modules with trace_init(), and since the events are not used within QEMU, the linker optimize and remove the unused modules (which is OK in this particular case).
Currently only the events compiled in trace-root.o and in the last trace.o member of libqemuutil.a are linked, resulting in an incomplete list of events.

To avoid confusion, improve the help message, recommending to use the proper systemtap script to display the events list.

Before:

  $ lm32-softmmu/qemu-system-lm32 -trace help 2>&1 | wc -l
  70

After:

  $ lm32-softmmu/qemu-system-lm32 -trace help
  Run 'qemu-trace-stap list qemu-system-lm32' to print a list
  of names of trace points with the DTrace/SystemTap backends.
  $ qemu-trace-stap list qemu-system-lm32 | wc -l
  1136

---
v2: Consider when multiple trace backends are used (Stefan)

---
 trace/control.c | 6 ++++++
 1 file changed, 6 insertions(+)
trace/control.c +6 -0
index 43fb7868db..d9cafc161b 100644
@@ -165,6 +165,12 @@ void trace_list_events(void)
     while ((ev = trace_event_iter_next(&iter)) != NULL) {
         fprintf(stderr, "%s\n", trace_event_get_name(ev));
     }
+#ifdef CONFIG_TRACE_DTRACE
+    fprintf(stderr, "This list of names of trace points may be incomplete "
+                    "when using the DTrace/SystemTap backends.\n"
+                    "Run 'qemu-trace-stap list %s' to print the full list.\n",
+            error_get_progname());
+#endif
 }
 
 static void do_trace_enable_events(const char *line_buf)
Signature · 1 line
2.20.1
#1 lore raw
Quoted 32 lines · Philippe Mathieu-Daudé

Most tracing backends are implemented within QEMU, except the DTrace/SystemTap backends.

One side effect is when running 'qemu -trace help', an incomplete list of trace events is displayed when using the DTrace/SystemTap backends.

This is partly due to trace events registered as modules with trace_init(), and since the events are not used within QEMU, the linker optimize and remove the unused modules (which is OK in this particular case).
Currently only the events compiled in trace-root.o and in the last trace.o member of libqemuutil.a are linked, resulting in an incomplete list of events.

To avoid confusion, improve the help message, recommending to use the proper systemtap script to display the events list.

Before:

  $ lm32-softmmu/qemu-system-lm32 -trace help 2>&1 | wc -l
  70

After:

  $ lm32-softmmu/qemu-system-lm32 -trace help
  Run 'qemu-trace-stap list qemu-system-lm32' to print a list
  of names of trace points with the DTrace/SystemTap backends.
  $ qemu-trace-stap list qemu-system-lm32 | wc -l
  1136
Quoted 6 lines

---
v2: Consider when multiple trace backends are used (Stefan)

---
 trace/control.c | 6 ++++++
 1 file changed, 6 insertions(+)

Thanks, applied to my tracing tree:
https://github.com/stefanha/qemu/commits/tracing

Stefan