stapbpf(8)

1STAPBPF(8)                  System Manager's Manual                 STAPBPF(8)
2
3
4

NAME

6       stapbpf - systemtap bpf runtime
7
8
9
10

SYNOPSIS

12       stapbpf [ OPTIONS ] MODULE
13
14

DESCRIPTION

16       The  stapbpf  program  is  the  BPF back-end of the Systemtap tool.  It
17       expects a bpf-elf file produced by the front-end stap  tool,  when  run
18       with --runtime=bpf.
19
20
21       Splitting  the  systemtap tool into a front-end and a back-end allows a
22       user to compile a systemtap script on a development  machine  that  has
23       the  debugging information (need to compile the script) and then trans‐
24       fer the resulting shared object to a production  machine  that  doesn't
25       have any development tools or debugging information installed.
26
27       Please  refer  to  stappaths  (7) for the version number, or run rpm -q
28       systemtap (fedora/red hat) apt-get -v systemtap (ubuntu)
29
30

OPTIONS

32       The stapbpf program supports the following options.  Any  other  option
33       prints a list of supported options.
34
35       -v     Verbose mode.
36
37       -V     Print version number and exit.
38
39       -w     Suppress warnings from the script.
40
41       -h     Print help message.
42
43       -o FILE
44              Send output to FILE.
45
46

ARGUMENTS

48       MODULE  is  the  path  of a bpf-elf file produced by the front-end stap
49       tool, when run with --runtime=bpf.
50
51

EXAMPLES

53       Here is a very basic example of how to use stapbpf.  First, use stap to
54       compile a script.  The stap program will report the name of the result‐
55       ing module in the current working directory.
56
57        $ stap --runtime=bpf -p4 -e 'probe begin {  printf("Hello  World!\n");
58       exit() }'
59        stap_28784.bo
60
61       Run stapbpf with the pathname to the module as an argument.
62
63        $ stapbpf ./stap_28784.bo
64        Hello World!
65
66

LIMITATIONS

68       This runtime is in an early stage of development and it currently lacks
69       support for a number of features available in the default runtime.  The
70       only probes currently supported are:
71
72
73              begin
74              end
75              kernel.*
76
77
78       for loops and while loops are usable only in begin and end probes.  try
79       and foreach statements are not  supported.  Except  for  printf  format
80       strings,  there  is no support for string variables or string literals.
81       Additionally, printf is limited to no more than 3 format specifiers and
82       the name of the bpf-elf file produced by the front-end stap tool should
83       not be changed.
84
85

SAFETY AND SECURITY

87       See the stap(1) manual page for additional information  on  safety  and
88       security.
89
90

BUGS

96       Use  the  Bugzilla  link  of  the project web page or our mailing list.
97       http://sourceware.org/systemtap/, <systemtap@sourceware.org>.
98
99
100
101                                                                    STAPBPF(8)