1QEMU-TRACE-STAP(1)                   QEMU                   QEMU-TRACE-STAP(1)
2
3
4

NAME

6       qemu-trace-stap - QEMU SystemTap trace tool
7

SYNOPSIS

9       qemu-trace-stap [GLOBAL-OPTIONS] COMMAND [COMMAND-OPTIONS] ARGS...
10

DESCRIPTION

12       The  qemu-trace-stap  program  facilitates  tracing of the execution of
13       QEMU emulators using SystemTap.
14
15       It is required to have the SystemTap runtime environment  installed  to
16       use  this  program,  since it is a wrapper around execution of the stap
17       program.
18

OPTIONS

20       The following global options may be used regardless of which command is
21       executed:
22
23       --verbose, -v
24              Display verbose information about command execution.
25
26       The following commands are valid:
27
28       list BINARY PATTERN...
29              List all the probe names provided by BINARY that match PATTERN.
30
31              If BINARY is not an absolute path, it will be located by search‐
32              ing the directories listed in the $PATH environment variable.
33
34              PATTERN is a plain string that is used to filter the results  of
35              this  command. It may optionally contain a * wildcard to facili‐
36              tate matching multiple probes without listing each  one  explic‐
37              itly.  Multiple  PATTERN arguments may be given, causing listing
38              of probes that match any of the listed names. If no  PATTERN  is
39              given, the all possible probes will be listed.
40
41              For  example,  to  list  all  probes  available in the qemu-sys‐
42              tem-x86_64 binary:
43
44                 $ qemu-trace-stap list qemu-system-x86_64
45
46              To filter the list to only cover probes related to QEMU's  cryp‐
47              tographic subsystem, in a binary outside $PATH
48
49                 $ qemu-trace-stap list /opt/qemu/8.1.3/bin/qemu-system-x86_64 'qcrypto*'
50
51       run OPTIONS BINARY PATTERN...
52              Run  a  trace  session,  printing  formatted  output  any time a
53              process that is executing BINARY triggers a probe matching  PAT‐
54              TERN.
55
56              If BINARY is not an absolute path, it will be located by search‐
57              ing the directories listed in the $PATH environment variable.
58
59              PATTERN is a plain string that matches a probe name shown by the
60              LIST  command. It may optionally contain a * wildcard to facili‐
61              tate matching multiple probes without listing each  one  explic‐
62              itly.   Multiple  PATTERN  arguments  may  be given, causing all
63              matching probes to be monitored. At least  one  PATTERN  is  re‐
64              quired,  since  stap  is  not  capable of tracing all known QEMU
65              probes concurrently without overflowing its trace buffer.
66
67              Invocation of this command does not need to be synchronized with
68              invocation  of the QEMU process(es). It will match probes on all
69              existing running processes and all  future  launched  processes,
70              unless told to only monitor a specific process.
71
72              Valid command specific options are:
73
74              --pid=PID, -p PID
75                     Restrict the tracing session so that it only triggers for
76                     the process identified by PID.
77
78              For  example,  to  monitor  all  processes  executing  qemu-sys‐
79              tem-x86_64 as found on $PATH, displaying all I/O related probes:
80
81                 $ qemu-trace-stap run qemu-system-x86_64 'qio*'
82
83              To monitor only the QEMU process with PID 1732
84
85                 $ qemu-trace-stap run --pid=1732 qemu-system-x86_64 'qio*'
86
87              To  monitor QEMU processes running an alternative binary outside
88              of $PATH, displaying verbose  information  about  setup  of  the
89              tracing environment:
90
91                 $ qemu-trace-stap -v run /opt/qemu/8.1.3/bin/qemu-system-x86_64 'qio*'
92

SEE ALSO

94       qemu(1), stap(1)
95

97       2023, The QEMU Project Developers
98
99
100
101
1028.1.3                            Nov 28, 2023               QEMU-TRACE-STAP(1)
Impressum