Skip to contentSkip to conversation

tracetool: strip %l and %ll from systemtap format strings

PATCH Superseded Daniel P. Berrangé 3 participants 3 messages Jan 6, 2021

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tracetool: strip %l and %ll from systemtap format strings

All variables are 64-bit and so %l / %ll are not required, and the latter is actually invalid:

  $ sudo stap -e 'probe begin{printf ("BEGIN")}'  -I .
  parse error: invalid or missing conversion specifier
          saw: operator ',' at ./qemu-system-x86_64-log.stp:15118:101
       source:     printf("%d@%d vhost_vdpa_set_log_base dev: %p base: 0x%x size: %llu
refcnt: %d fd: %d log: %p\n", pid(), gettimeofday_ns(), dev, base, size, refcnt, fd, log)
                       ^
---
 scripts/tracetool/format/log_stap.py | 6 ++++++
 1 file changed, 6 insertions(+)

This is an alternative approach to

https://lists.gnu.org/archive/html/qemu-devel/2021-01/msg00550.html

scripts/tracetool/format/log_stap.py +6 -0
index b486beb672..7bac10784b 100644
@@ -49,6 +49,12 @@ def c_fmt_to_stap(fmt):
         elif fmt[i] == '"' and not escape:
             if state == STATE_LITERAL:
                 state = STATE_SKIP
+                # All variables in systemtap are 64-bit in size
+                # The "%l" integer size qualifiers is thus redundant
+                # and "%ll" is not valid at all. Simply strip all
+                # size qualifiers for sanity
+                literal = literal.replace("%ll", "%")
+                literal = literal.replace("%l", "%")
                 bits.append(literal)
                 literal = ""
             else:
Signature · 1 line
2.29.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 11 lines · Daniel P. Berrangé

All variables are 64-bit and so %l / %ll are not required, and the latter is actually invalid:

  $ sudo stap -e 'probe begin{printf ("BEGIN")}'  -I .
  parse error: invalid or missing conversion specifier
          saw: operator ',' at ./qemu-system-x86_64-log.stp:15118:101
       source:     printf("%d@%d vhost_vdpa_set_log_base dev: %p base: 0x%x size: %llu
refcnt: %d fd: %d log: %p\n", pid(), gettimeofday_ns(), dev, base, size, refcnt, fd, log)
                       ^
Quoted 8 lines
---
 scripts/tracetool/format/log_stap.py | 6 ++++++
 1 file changed, 6 insertions(+)

This is an alternative approach to

https://lists.gnu.org/archive/html/qemu-devel/2021-01/msg00550.html

Indeed more future-proof.

Quoted 19 lines
scripts/tracetool/format/log_stap.py +6 -0
index b486beb672..7bac10784b 100644
@@ -49,6 +49,12 @@ def c_fmt_to_stap(fmt):
         elif fmt[i] == '"' and not escape:
             if state == STATE_LITERAL:
                 state = STATE_SKIP
+                # All variables in systemtap are 64-bit in size
+                # The "%l" integer size qualifiers is thus redundant
+                # and "%ll" is not valid at all. Simply strip all
+                # size qualifiers for sanity
+                literal = literal.replace("%ll", "%")
+                literal = literal.replace("%l", "%")
                 bits.append(literal)
                 literal = ""
             else:
#2 lore raw
In reply to Daniel P. Berrangé
Quoted 11 lines · Daniel P. Berrangé

All variables are 64-bit and so %l / %ll are not required, and the latter is actually invalid:

  $ sudo stap -e 'probe begin{printf ("BEGIN")}'  -I .
  parse error: invalid or missing conversion specifier
          saw: operator ',' at ./qemu-system-x86_64-log.stp:15118:101
       source:     printf("%d@%d vhost_vdpa_set_log_base dev: %p base: 0x%x size: %llu
refcnt: %d fd: %d log: %p\n", pid(), gettimeofday_ns(), dev, base, size, refcnt, fd, log)
                       ^
Quoted 8 lines
---
 scripts/tracetool/format/log_stap.py | 6 ++++++
 1 file changed, 6 insertions(+)

This is an alternative approach to

https://lists.gnu.org/archive/html/qemu-devel/2021-01/msg00550.html

Your patch is indeed a better solution.

Quoted 9 lines
scripts/tracetool/format/log_stap.py +0 -0
index b486beb672..7bac10784b 100644
@@ -49,6 +49,12 @@ def c_fmt_to_stap(fmt):
         elif fmt[i] == '"' and not escape:
             if state == STATE_LITERAL:

scripts/tracetool/format/log_stap.py def c_fmt_to_stap(fmt): · line 60

Quoted 10 lines
scripts/tracetool/format/log_stap.py +6 -0
                 state = STATE_SKIP
+                # All variables in systemtap are 64-bit in size
+                # The "%l" integer size qualifiers is thus redundant
+                # and "%ll" is not valid at all. Simply strip all
+                # size qualifiers for sanity
+                literal = literal.replace("%ll", "%")
+                literal = literal.replace("%l", "%")
                 bits.append(literal)
                 literal = ""
             else:

There is a 'sub("%(\d*)z(x|u|d)", "%\\1\\2",..)' later in the code, can we have here the '\d*" case or the 'z' case?

I'm wondering if it can be handled in a more generic way by something like:

scripts/tracetool/format/log_stap.py +1 -0
@@ -78,6 +78,7 @@ def c_fmt_to_stap(fmt):
         bits.append(literal)
 
     fmt = re.sub("%(\d*)z(x|u|d)", "%\\1\\2", "".join(bits))
+    fmt = re.sub("%(\d*)l*(x|u|d)", "%\\1\\2", fmt)
     return fmt
 
 def generate(events, backend, group):

Thanks,
Laurent