Skip to contentSkip to conversation

trace: fix ability to use systemtap with qemu tools

PATCH Applied Daniel P. Berrangé 4 participants 10 messages Jan 8, 2024 – Mar 12, 2024 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

cover trace: fix ability to use systemtap with qemu tools

Currently we're only generating .stp definitions for the system and user emulators forgetting all about the tools which support tracing too.

Daniel P. Berrangé (2):
tracetool: remove redundant --target-type / --target-name args
meson: generate .stp files for tools too

 docs/devel/tracing.rst |  3 +-
 meson.build            | 63 +++++++++++++++++++++++++++---------------
 scripts/tracetool.py   | 24 ++++------------
 3 files changed, 46 insertions(+), 44 deletions(-)
Signature · 1 line
2.43.0
#1 lore raw

PATCH 1/2 tracetool: remove redundant --target-type / --target-name args

The --target-type and --target-name args are used to construct the default probe prefix if '--probe-prefix' is not given. The meson.build will always pass '--probe-prefix', so the other args are effectively redundant.

---
 docs/devel/tracing.rst |  3 +--
 meson.build            |  2 --
 scripts/tracetool.py   | 24 +++++-------------------
 3 files changed, 6 insertions(+), 23 deletions(-)
docs/devel/tracing.rst +1 -2
index d288480db1..043bed7fd0 100644
@@ -357,8 +357,7 @@ probes::
 
     scripts/tracetool.py --backends=dtrace --format=stap \
                          --binary path/to/qemu-binary \
-                         --target-type system \
-                         --target-name x86_64 \
+                         --probe-prefix qemu.system.x86_64 \
                          --group=all \
                          trace-events-all \
                          qemu.stp
meson.build +0 -2
index 6c77d9687d..535f15da69 100644
@@ -3934,8 +3934,6 @@ foreach target : target_dirs
                       command: [
                         tracetool, '--group=all', '--format=' + stp['fmt'],
                         '--binary=' + stp['bin'],
-                        '--target-name=' + target_name,
-                        '--target-type=' + target_type,
                         '--probe-prefix=qemu.' + target_type + '.' + target_name,
                         '@INPUT@', '@OUTPUT@'
                       ],
scripts/tracetool.py +5 -19
index ab7653a5ce..5de9ce96d3 100755
@@ -44,12 +44,9 @@ def error_opt(msg = None):
     --help                   This help message.
     --list-backends          Print list of available backends.
     --check-backends         Check if the given backend is valid.
-    --binary <path>          Full path to QEMU binary.
-    --target-type <type>     QEMU emulator target type ('system' or 'user').
-    --target-name <name>     QEMU emulator target name.
-    --group <name>           Name of the event group
-    --probe-prefix <prefix>  Prefix for dtrace probe names
-                             (default: qemu-<target-type>-<target-name>).\
+    --binary <path>          Full path to QEMU binary (required for 'stap' backend).
+    --group <name>           Name of the event group.
+    --probe-prefix <prefix>  Prefix for dtrace probe names (required for 'stap' backend).
 """ % {
             "script" : _SCRIPT,
             "backends" : backend_descr,
@@ -67,7 +64,7 @@ def main(args):
 
     long_opts = ["backends=", "format=", "help", "list-backends",
                  "check-backends", "group="]
-    long_opts += ["binary=", "target-type=", "target-name=", "probe-prefix="]
+    long_opts += ["binary=", "probe-prefix="]
 
     try:
         opts, args = getopt.getopt(args[1:], "", long_opts)
@@ -79,8 +76,6 @@ def main(args):
     arg_format = ""
     arg_group = None
     binary = None
-    target_type = None
-    target_name = None
     probe_prefix = None
     for opt, arg in opts:
         if opt == "--help":
@@ -102,10 +97,6 @@ def main(args):
 
         elif opt == "--binary":
             binary = arg
-        elif opt == '--target-type':
-            target_type = arg
-        elif opt == '--target-name':
-            target_name = arg
         elif opt == '--probe-prefix':
             probe_prefix = arg
 
@@ -127,13 +118,8 @@ def main(args):
     if arg_format == "stap":
         if binary is None:
             error_opt("--binary is required for SystemTAP tapset generator")
-        if probe_prefix is None and target_type is None:
-            error_opt("--target-type is required for SystemTAP tapset generator")
-        if probe_prefix is None and target_name is None:
-            error_opt("--target-name is required for SystemTAP tapset generator")
-
         if probe_prefix is None:
-            probe_prefix = ".".join(["qemu", target_type, target_name])
+            error_opt("--probe-prefix is required for SystemTAP tapset generator")
 
     if len(args) < 2:
         error_opt("missing trace-events and output filepaths")
Signature · 1 line
2.43.0
Reviewed-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] tracetool: remove redundant --target-type / --target-name args

Quoted 7 lines · Daniel P. Berrangé

The --target-type and --target-name args are used to construct the default probe prefix if '--probe-prefix' is not given. The meson.build will always pass '--probe-prefix', so the other args are effectively redundant.

Fine by me, provided there's no reason anyone is calling tracetool manually for some reason I haven't thought about. I assume we'll hear about it if so...

Python looks fine, of course.

(Happy New Year!)

Quoted 100 lines
---
 docs/devel/tracing.rst |  3 +--
 meson.build            |  2 --
 scripts/tracetool.py   | 24 +++++-------------------
 3 files changed, 6 insertions(+), 23 deletions(-)
docs/devel/tracing.rst +1 -2
index d288480db1..043bed7fd0 100644
@@ -357,8 +357,7 @@ probes::
 
     scripts/tracetool.py --backends=dtrace --format=stap \
                          --binary path/to/qemu-binary \
-                         --target-type system \
-                         --target-name x86_64 \
+                         --probe-prefix qemu.system.x86_64 \
                          --group=all \
                          trace-events-all \
                          qemu.stp
meson.build +0 -2
index 6c77d9687d..535f15da69 100644
@@ -3934,8 +3934,6 @@ foreach target : target_dirs
                       command: [
                         tracetool, '--group=all', '--format=' + stp['fmt'],
                         '--binary=' + stp['bin'],
-                        '--target-name=' + target_name,
-                        '--target-type=' + target_type,
                         '--probe-prefix=qemu.' + target_type + '.' + target_name,
                         '@INPUT@', '@OUTPUT@'
                       ],
scripts/tracetool.py +5 -20
index ab7653a5ce..5de9ce96d3 100755
@@ -44,12 +44,9 @@ def error_opt(msg = None):
     --help                   This help message.
     --list-backends          Print list of available backends.
     --check-backends         Check if the given backend is valid.
-    --binary <path>          Full path to QEMU binary.
-    --target-type <type>     QEMU emulator target type ('system' or 'user').
-    --target-name <name>     QEMU emulator target name.
-    --group <name>           Name of the event group
-    --probe-prefix <prefix>  Prefix for dtrace probe names
-                             (default: qemu-<target-type>-<target-name>).\
+    --binary <path>          Full path to QEMU binary (required for 'stap' backend).
+    --group <name>           Name of the event group.
+    --probe-prefix <prefix>  Prefix for dtrace probe names (required for 'stap' backend).
 """ % {
             "script" : _SCRIPT,
             "backends" : backend_descr,
@@ -67,7 +64,7 @@ def main(args):
 
     long_opts = ["backends=", "format=", "help", "list-backends",
                  "check-backends", "group="]
-    long_opts += ["binary=", "target-type=", "target-name=", "probe-prefix="]
+    long_opts += ["binary=", "probe-prefix="]
 
     try:
         opts, args = getopt.getopt(args[1:], "", long_opts)
@@ -79,8 +76,6 @@ def main(args):
     arg_format = ""
     arg_group = None
     binary = None
-    target_type = None
-    target_name = None
     probe_prefix = None
     for opt, arg in opts:
         if opt == "--help":
@@ -102,10 +97,6 @@ def main(args):
 
         elif opt == "--binary":
             binary = arg
-        elif opt == '--target-type':
-            target_type = arg
-        elif opt == '--target-name':
-            target_name = arg
         elif opt == '--probe-prefix':
             probe_prefix = arg
 
@@ -127,13 +118,8 @@ def main(args):
     if arg_format == "stap":
         if binary is None:
             error_opt("--binary is required for SystemTAP tapset generator")
-        if probe_prefix is None and target_type is None:
-            error_opt("--target-type is required for SystemTAP tapset generator")
-        if probe_prefix is None and target_name is None:
-            error_opt("--target-name is required for SystemTAP tapset generator")
-
         if probe_prefix is None:
-            probe_prefix = ".".join(["qemu", target_type, target_name])
+            error_opt("--probe-prefix is required for SystemTAP tapset generator")
 
     if len(args) < 2:
         error_opt("missing trace-events and output filepaths")
--

2.43.0

#3 lore raw

Re: [PATCH 1/2] tracetool: remove redundant --target-type / --target-name args

Quoted 7 lines · John Snow
Quoted 6 lines · Daniel P. Berrangé

The --target-type and --target-name args are used to construct the default probe prefix if '--probe-prefix' is not given. The meson.build will always pass '--probe-prefix', so the other args are effectively redundant.

Quoted 5 lines
Quoted 1 line

Fine by me, provided there's no reason anyone is calling tracetool manually for some reason I haven't thought about. I assume we'll hear about it if so...

That's okay. tracetool.py is internal to QEMU so we're free to change the command-line options.

Stefan

#4 lore raw

PATCH 2/2 meson: generate .stp files for tools too

In reply to Daniel P. Berrangé

The qemu-img, qemu-io, qemu-nbd, qemu-storage-daemon tools all have support for systemtap tracing built-in, so should be given corresponding .stp files to define their probes.

---
 meson.build | 61 +++++++++++++++++++++++++++++++++++------------------
 1 file changed, 40 insertions(+), 21 deletions(-)
meson.build +40 -21
index 535f15da69..4db6907a20 100644
@@ -3752,6 +3752,7 @@ if targetos == 'darwin'
   entitlement = find_program('scripts/entitlement.sh')
 endif
 
+traceable = []
 emulators = {}
 foreach target : target_dirs
   config_target = config_target_mak[target]
@@ -3919,27 +3920,11 @@ foreach target : target_dirs
       emulators += {exe['name']: emulator}
     endif
 
-    if stap.found()
-      foreach stp: [
-        {'ext': '.stp-build', 'fmt': 'stap', 'bin': meson.current_build_dir() / exe['name'], 'install': false},
-        {'ext': '.stp', 'fmt': 'stap', 'bin': get_option('prefix') / get_option('bindir') / exe['name'], 'install': true},
-        {'ext': '-simpletrace.stp', 'fmt': 'simpletrace-stap', 'bin': '', 'install': true},
-        {'ext': '-log.stp', 'fmt': 'log-stap', 'bin': '', 'install': true},
-      ]
-        custom_target(exe['name'] + stp['ext'],
-                      input: trace_events_all,
-                      output: exe['name'] + stp['ext'],
-                      install: stp['install'],
-                      install_dir: get_option('datadir') / 'systemtap/tapset',
-                      command: [
-                        tracetool, '--group=all', '--format=' + stp['fmt'],
-                        '--binary=' + stp['bin'],
-                        '--probe-prefix=qemu.' + target_type + '.' + target_name,
-                        '@INPUT@', '@OUTPUT@'
-                      ],
-                      depend_files: tracetool_depends)
-      endforeach
-    endif
+    traceable += [{
+      'exe': exe['name'],
+      'probe-prefix': 'qemu.' + target_type + '.' + target_name,
+    }]
+
   endforeach
 endforeach
 
@@ -3974,6 +3959,14 @@ if have_tools
                install: true)
 
   subdir('storage-daemon')
+
+  foreach exe: [ 'qemu-img', 'qemu-io', 'qemu-nbd', 'qemu-storage-daemon']
+    traceable += [{
+      'exe': exe,
+      'probe-prefix': 'qemu.' + exe.substring(5).replace('-', '_')
+    }]
+  endforeach
+
   subdir('contrib/rdmacm-mux')
   subdir('contrib/elf2dmp')
 
@@ -4006,6 +3999,32 @@ if have_tools
   endif
 endif
 
+if stap.found()
+  foreach t: traceable
+    foreach stp: [
+      {'ext': '.stp-build', 'fmt': 'stap', 'bin': meson.current_build_dir() / t['exe'], 'install': false},
+      {'ext': '.stp', 'fmt': 'stap', 'bin': get_option('prefix') / get_option('bindir') / t['exe'], 'install': true},
+      {'ext': '-simpletrace.stp', 'fmt': 'simpletrace-stap', 'bin': '', 'install': true},
+      {'ext': '-log.stp', 'fmt': 'log-stap', 'bin': '', 'install': true},
+    ]
+      cmd = [
+        tracetool, '--group=all', '--format=' + stp['fmt'],
+        '--binary=' + stp['bin'],
+        '--probe-prefix=' + t['probe-prefix'],
+        '@INPUT@', '@OUTPUT@'
+      ]
+
+      custom_target(t['exe'] + stp['ext'],
+                    input: trace_events_all,
+                    output: t['exe'] + stp['ext'],
+                    install: stp['install'],
+                    install_dir: get_option('datadir') / 'systemtap/tapset',
+                    command: cmd,
+                    depend_files: tracetool_depends)
+    endforeach
+  endforeach
+endif
+
 subdir('scripts')
 subdir('tools')
 subdir('pc-bios')
Signature · 1 line
2.43.0
Reviewed-by on v1 2/2
#5 lore raw

Re: [PATCH 2/2] meson: generate .stp files for tools too

Quoted 8 lines · Daniel P. Berrangé

The qemu-img, qemu-io, qemu-nbd, qemu-storage-daemon tools all have support for systemtap tracing built-in, so should be given corresponding .stp files to define their probes.

---
 meson.build | 61 +++++++++++++++++++++++++++++++++++------------------
 1 file changed, 40 insertions(+), 21 deletions(-)

I'm less familiar with writing meson rules, but I can follow how you refactored the stap.found() logic to be shared among two different groups of traceable binaries, with the obvious difference being the generation of command:[] in a way that uses the correct prefixes per tracable item.

And since I hit the problem of not being able to see trace output via qemu-trace-stap on qemu-io, this makes sense.

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.
Virtualization:  qemu.org | libguestfs.org
#6 lore raw
In reply to Daniel P. Berrangé

Ping: Stefan, are you OK with picking up these trace patches for merge ?

Quoted 4 lines · Daniel P. Berrangé

Currently we're only generating .stp definitions for the system and user emulators forgetting all about the tools which support tracing too.

Quoted 14 lines

Daniel P. Berrangé (2):
tracetool: remove redundant --target-type / --target-name args
meson: generate .stp files for tools too

 docs/devel/tracing.rst |  3 +-
 meson.build            | 63 +++++++++++++++++++++++++++---------------
 scripts/tracetool.py   | 24 ++++------------
 3 files changed, 46 insertions(+), 44 deletions(-)
Signature · 1 line
2.43.0

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#7 lore raw

Ping again for these patches to get into this release.

Quoted 16 lines · Daniel P. Berrangé

Ping: Stefan, are you OK with picking up these trace patches for merge ?

Quoted 12 lines · Daniel P. Berrangé

Currently we're only generating .stp definitions for the system and user emulators forgetting all about the tools which support tracing too.

Daniel P. Berrangé (2):
tracetool: remove redundant --target-type / --target-name args
meson: generate .stp files for tools too

 docs/devel/tracing.rst |  3 +-
 meson.build            | 63 +++++++++++++++++++++++++++---------------
 scripts/tracetool.py   | 24 ++++------------
 3 files changed, 46 insertions(+), 44 deletions(-)

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#8 lore raw
Quoted 5 lines · Daniel P. Berrangé

Ping again for these patches to get into this release.

Quoted 2 lines · Daniel P. Berrangé

Ping: Stefan, are you OK with picking up these trace patches for merge ?

Sorry, I missed them.

Stefan

#9 lore raw
In reply to Daniel P. Berrangé
Quoted 4 lines · Daniel P. Berrangé

Currently we're only generating .stp definitions for the system and user emulators forgetting all about the tools which support tracing too.

Quoted 12 lines

Daniel P. Berrangé (2):
tracetool: remove redundant --target-type / --target-name args
meson: generate .stp files for tools too

 docs/devel/tracing.rst |  3 +-
 meson.build            | 63 +++++++++++++++++++++++++++---------------
 scripts/tracetool.py   | 24 ++++------------
 3 files changed, 46 insertions(+), 44 deletions(-)
Signature · 1 line
2.43.0

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

Stefan