Add a DTrace tracing backend targetted for SystemTAP compatability (v3)
PATCH 1/1 Add a DTrace tracing backend targetted for SystemTAP compatability (v3)
This introduces a new tracing backend that targets the SystemTAP implementation of DTrace userspace tracing. The core functionality should be applicable and standard across any DTrace implementation on Solaris, OS-X, *BSD, but the Makefile rules will likely need some small additional changes to cope with OS specific build requirements.
This backend builds a little differently from the other tracing backends. Specifically there is no 'trace.c' file, because the 'dtrace' command line tool generates a '.o' file directly from the dtrace probe definition file. The probe definition is usually named with a '.d' extension but QEMU uses '.d' files for its external makefile dependancy tracking, so this uses '.dtrace' as the extension for the probe definition file.
The 'tracetool' program gains the ability to generate a trace.h file for DTrace, and also to generate the trace.d file containing the dtrace probe definition, and finally a qemu.stp file which is a wrapper around the probe definition providing more convenient access from SystemTAP scripts.
eg, instead of
probe process("qemu").mark("qemu_malloc") {
printf("Malloc %d %p\n", $arg1, $arg2);
}The addition of qemu.stp to /usr/share/systemtap/tapset/ lets users write
probe qemu.qemu_malloc {
printf("Malloc %d %p\n", size, ptr);
}In v2:
- Add check for 'dtrace' command in configure
- Comply with coding standards in generated code
- Misc fixes to tracetool
- Add more generated files to make clean target
- Mention 'dtrace' backend in configure help
In v3:
- Make sure dtrace check in configure only runs
when dtrace backend is selected
Still todo in v4:
- Change process("qemu") statement so that it applies to all 'qemu-system-XXX' binaries not just 'qemu'
* .gitignore: Ignore trace-dtrace.*
* Makefile: Extra rules for generating DTrace files
* Makefile.obj: Don't build trace.o for DTrace, use trace-dtrace.o generated by 'dtrace' instead
* tracetool: Support for generating DTrace/SystemTAP data files
--- .gitignore | 3 + Makefile | 32 +++++++++++ Makefile.objs | 4 ++ configure | 14 +++++- tracetool | 169 +++++++++++++++++++++++++++++++++++++++++++++++++++++---- 5 files changed, 211 insertions(+), 11 deletions(-)
.gitignore +3 -0
@@ -4,6 +4,9 @@ config-host.* config-target.* trace.h trace.c +trace-dtrace.h +trace-dtrace.dtrace +qemu.stp *-timestamp *-softmmu *-darwin-user
Makefile +32 -0
@@ -1,6 +1,9 @@ # Makefile for QEMU. GENERATED_HEADERS = config-host.h trace.h +ifeq ($(TRACE_BACKEND),dtrace) +GENERATED_HEADERS += trace-dtrace.h +endif ifneq ($(wildcard config-host.mak),) # Put the all: rule here so that config-host.mak can contain dependencies.
@@ -106,7 +109,11 @@ ui/vnc.o: QEMU_CFLAGS += $(VNC_TLS_CFLAGS) bt-host.o: QEMU_CFLAGS += $(BLUEZ_CFLAGS) +ifeq ($(TRACE_BACKEND),dtrace) +trace.h: trace.h-timestamp trace-dtrace.h +else trace.h: trace.h-timestamp +endif trace.h-timestamp: $(SRC_PATH)/trace-events config-host.mak $(call quiet-command,sh $(SRC_PATH)/tracetool --$(TRACE_BACKEND) -h < $< > $@," GEN trace.h") @cmp -s $@ trace.h || cp $@ trace.h
@@ -118,6 +125,23 @@ trace.c-timestamp: $(SRC_PATH)/trace-events config-host.mak trace.o: trace.c $(GENERATED_HEADERS) +trace-dtrace.h: trace-dtrace.dtrace + $(call quiet-command,dtrace -o $@ -h -s $<, " GEN trace-dtrace.h") + +# Normal practice is to name DTrace probe file with a '.d' extension +# but that gets picked up by QEMU's Makefile as an external dependancy +# rule file. So we use '.dtrace' instead +trace-dtrace.dtrace: trace-dtrace.dtrace-timestamp +trace-dtrace.dtrace-timestamp: $(SRC_PATH)/trace-events config-host.mak + $(call quiet-command,sh $(SRC_PATH)/tracetool --$(TRACE_BACKEND) -d < $< > $@," GEN trace-dtrace.dtrace") + @cmp -s $@ trace-dtrace.dtrace || cp $@ trace-dtrace.dtrace +ifdef CONFIG_LINUX + $(call quiet-command,sh $(SRC_PATH)/tracetool --$(TRACE_BACKEND) -s < $< > qemu.stp," GEN qemu.stp") +endif + +trace-dtrace.o: trace-dtrace.dtrace $(GENERATED_HEADERS) + $(call quiet-command,dtrace -o $@ -G -s $<, " GEN trace-dtrace.o") + simpletrace.o: simpletrace.c $(GENERATED_HEADERS) version.o: $(SRC_PATH)/version.rc config-host.mak
@@ -154,6 +178,8 @@ clean: rm -f slirp/*.o slirp/*.d audio/*.o audio/*.d block/*.o block/*.d net/*.o net/*.d fsdev/*.o fsdev/*.d ui/*.o ui/*.d rm -f qemu-img-cmds.h rm -f trace.c trace.h trace.c-timestamp trace.h-timestamp + rm -f trace-dtrace.dtrace trace-dtrace.dtrace-timestamp + rm -f trace-dtrace.h trace-dtrace.h-timestamp qemu.stp $(MAKE) -C tests clean for d in $(ALL_SUBDIRS) libhw32 libhw64 libuser libdis libdis-user; do \ if test -d $$d; then $(MAKE) -C $$d $@ || exit 1; fi; \
@@ -214,6 +240,12 @@ ifneq ($(BLOBS),) $(INSTALL_DATA) $(SRC_PATH)/pc-bios/$$x "$(DESTDIR)$(datadir)"; \ done endif +ifeq ($(TRACE_BACKEND),dtrace) +ifdef CONFIG_LINUX + $(INSTALL_DIR) "$(DESTDIR)$(datadir)/../systemtap/tapset" + $(INSTALL_DATA) qemu.stp "$(DESTDIR)$(datadir)/../systemtap/tapset" +endif +endif $(INSTALL_DIR) "$(DESTDIR)$(datadir)/keymaps" set -e; for x in $(KEYMAPS); do \ $(INSTALL_DATA) $(SRC_PATH)/pc-bios/keymaps/$$x "$(DESTDIR)$(datadir)/keymaps"; \
Makefile.objs +4 -0
@@ -273,10 +273,14 @@ libdis-$(CONFIG_SPARC_DIS) += sparc-dis.o ###################################################################### # trace +ifeq ($(TRACE_BACKEND),dtrace) +trace-obj-y = trace-dtrace.o +else trace-obj-y = trace.o ifeq ($(TRACE_BACKEND),simple) trace-obj-y += simpletrace.o endif +endif vl.o: QEMU_CFLAGS+=$(GPROF_CFLAGS)
configure +13 -1
@@ -926,7 +926,7 @@ echo " --enable-docs enable documentation build" echo " --disable-docs disable documentation build" echo " --disable-vhost-net disable vhost-net acceleration support" echo " --enable-vhost-net enable vhost-net acceleration support" -echo " --trace-backend=B Trace backend nop simple ust" +echo " --trace-backend=B Trace backend nop simple ust dtrace" echo " --trace-file=NAME Full PATH,NAME of file to store traces" echo " Default:trace-<pid>" echo " --disable-spice disable spice"
@@ -2175,6 +2175,18 @@ EOF exit 1 fi fi + +########################################## +# For 'dtrace' backend, test if 'dtrace' command is present +if test "$trace_backend" = "dtrace"; then + if ! has 'dtrace' ; then + echo + echo "Error: dtrace command is not found in PATH $PATH" + echo + exit 1 + fi +fi + ########################################## # End of CC checks # After here, no more $cc or $ld runs
tracetool +159 -10
242 lines not on this page · raw message
Signature · 1 line
1.7.2.3
Quoted 59 lines · Daniel P. Berrange
This introduces a new tracing backend that targets the SystemTAP implementation of DTrace userspace tracing. The core functionality should be applicable and standard across any DTrace implementation on Solaris, OS-X, *BSD, but the
Makefilerules will likely need some small additional changes to cope with OS specific build requirements.This backend builds a little differently from the other tracing backends. Specifically there is no '
trace.c' file, because the 'dtrace' command line tool generates a '.o' file directly from the dtrace probe definition file. The probe definition is usually named with a '.d' extension but QEMU uses '.d' files for its external makefile dependancy tracking, so this uses '.dtrace' as the extension for the probe definition file.The 'tracetool' program gains the ability to generate a
trace.hfile for DTrace, and also to generate the trace.d file containing the dtrace probe definition, and finally a qemu.stp file which is a wrapper around the probe definition providing more convenient access from SystemTAP scripts.eg, instead of
probe process("qemu").mark("qemu_malloc") {
printf("Malloc %d %p\n", $arg1, $arg2);
}The addition of qemu.stp to
/usr/share/systemtap/tapset/lets users writeprobe qemu.qemu_malloc {
printf("Malloc %d %p\n", size, ptr);
}In v2:
- Add check for 'dtrace' command in configure
- Comply with coding standards in generated code
- Misc fixes to tracetool
- Add more generated files to make clean target
- Mention 'dtrace' backend in configure helpIn v3:
- Make sure dtrace check in configure only runs
when dtrace backend is selectedStill todo in v4:
- Change
process("qemu")statement so that it applies to all 'qemu-system-XXX' binaries not just 'qemu'* .gitignore: Ignore trace-dtrace.*
*Makefile: Extra rules for generating DTrace files
* Makefile.obj: Don't build trace.o for DTrace, use trace-dtrace.o generated by 'dtrace' instead
* tracetool: Support for generating DTrace/SystemTAP data files
Quoted 8 lines
Signed-off-by Daniel P. Berrange <[email protected]>---
.gitignore | 3 +
Makefile | 32 +++++++++++
Makefile.objs | 4 ++
configure | 14 +++++-
tracetool | 169 +++++++++++++++++++++++++++++++++++++++++++++++++++++----5 files changed, 211 insertions(+), 11 deletions(-)
Tested successfully both for launching QEMU and attaching to a running process.
This looks promising but it's too bad that utrace isn't upstream. On my Debian testing development machine I need to rebuild the kernel to make use of userspace probes with SystemTap.
Stefan