1STAPREF(1) General Commands Manual STAPREF(1)
2
6 stapref - systemtap language reference
7
11 stapref
12
15 The reference for the systemtap scripting language.
16
19 Keywords
20 • break
21 • continue
22 • delete
23 • else
24 • exit
25 • foreach
26 • for
27 • function
28 • global
29 • private
30 • if
31 • in
32 • next
33 • probe
34 • return
35 • try/catch
36 • while
37 Data Types and Operators
40 Integers
41 • var1 = 5
42 • global var2 = 10
43 Strings
45 • var1 = "string1"
46 • global var2 = "string2"
47 Associative Arrays
49 • global array1[]
50 • global array2[SIZE]
51 • array[index] = 5
52 Context Variables
54 • $var
55 • $var$ (pretty printed string form)
56 Binary numeric operators
58 • * / % + - << >> >>> & ^ | && ||
59 Binary string operators
61 • . (string concatenation)
62 Numeric assignment operators
64 • = += -= *= /= %= >>= <<= &= ^= |=
65 String assignment operators
67 • = .=
68 Unary numeric operators
70 • + - ! ~ ++ --
71 Numeric & string comparison operators
73 • < > <= >= == !=
74 Regular expression matching operators
76 • =~ !~
77 Ternary operator
79 • cond ? exp1 : exp2
80 Grouping operator
82 • ( expression )
83 Array operators
85 • array[index] (array read/write)
86 • [index] in array
87 Aggregation operator
89 • var <<< value
90 Statements
93 Jump Statements
94 • continue
95 • break
96 • next (early return from a probe)
97 • return expression (from a function)
98 • try statement catch (message) statement
99 Selection Statements
101 • if (expression) statement
102 • else statement
103 Iteration Statements
105 • foreach (variable in array) statement
106 • foreach ([var1,var2,...] in array) statement
107 • for (expression; expression; expression) statement
108 • while (expression) statement
109 Declaration Statements
111 • function name (variable : type, ...) { statement }
112 • function name : type (variable : type, ...) { statement }
113 • function name : type (variable : type, ...) %{ c_statement %}
114 • probe probepoint { statement }
115 • probe label = probepoint { statement }
116 Lexical Structure
119 Comments
120 • # ... comment
121 • // ... comment
122 • /* ... comment ... */
123 Preprocessor
125 • %( expression %? true_tokens %: false_tokens %)
126 • @define label (variable, ...) %{ statement %}
127 Builtin Functions
130 Aggregation Builtin Functions
131 • @avg (variable)
132 • @count (variable)
133 • @hist_linear (variable, N, N, N)
134 • @hist_log (variable)
135 • @max (variable)
136 • @min (variable)
137 • @sum (variable)
138 Output Builtin Functions
140 • print (variable)
141 • printf (format:string, variable, ...)
142 where format is of the form: %[flags][width][.precision][length]specifier
143 • printd (delimiter:string, variable, ...)
144 • printdln (delimiter:string, variable, ...)
145 • println ()
146 • sprint:string (variable)
147 • sprintf:string (format:string, variable, ...)
148 Variable Access Builtin Functions
150 • @var ("varname[@src/FILE.c]"[, "module"]) (static or global)
151 • @cast (variable, "type_name"[, "module"])
152 • @defined (variable)
153 • @probewrite (variable)
154 Probepoints
157 Some of the more commonly used probepoints
158 • kernel.function(PATTERN) kernel.function(PATTERN).call
159 • kernel.function(PATTERN).return
160 • kernel.FUNCTION (PATTERN).return.maxactive(VALUE)
161 • kernel.FUNCTION (PATTERN).inline
162 • kernel.FUNCTION (PATTERN).label(LPATTERN)
163 • module(MPATTERN).FUNCTION (PATTERN)
164 • module(MPATTERN).FUNCTION (PATTERN).call
165 • module(MPATTERN).FUNCTION (PATTERN).return.maxactive(VALUE)
166 • module(MPATTERN).FUNCTION (PATTERN).inline
167 • kernel.statement(PATTERN)
168 • kernel.statement(ADDRESS).absolute
169 • module(MPATTERN).statement(PATTERN)
170 • kprobe.FUNCTION (FUNCTION)
171 • kprobe.FUNCTION (FUNCTION).return
172 • kprobe.module(NAME).FUNCTION (FUNCTION)
173 • kprobe.module(NAME).FUNCTION (FUNCTION).return
174 • kprobe.statement(ADDRESS).absolute
175 • process.begin process("PATH").begin
176 • process(PID).begin process.thread.begin
177 • process("PATH").thread.begin
178 • process(PID).thread.begin
179 • process.end
180 • process("PATH").end
181 • process(PID).end
182 • process.thread.end
183 • process("PATH").thread.end
184 • process(PID).thread.end
185 • process("PATH").syscall
186 • process(PID).syscall
187 • process.syscall.return
188 • process("PATH").syscall.return
189 • process(PID).syscall.return
190 • process("PATH").FUNCTION ("NAME")
191 • process("PATH").statement("*@FILE.c:123")
192 • process("PATH").FUNCTION ("*").return
193 • process("PATH").FUNCTION ("myfun").label("foo")
194 • process("PATH").mark("LABEL")
195 • java("PNAME").class("CLASSNAME").method("PATTERN")
196 • java("PNAME").class("CLASSNAME").method("PATTERN").return
197 • java(PID).class("CLASSNAME").method("PATTERN")
198 • java(PID).class("CLASSNAME").method("PATTERN").return
199 • python2.module("MODULENAME").function("PATTERN")
200 • python2.module("MODULENAME").function("PATTERN").return
201 • python3.module("MODULENAME").function("PATTERN")
202 • python3.module("MODULENAME").function("PATTERN").return
203 Tapset Functions
206 Some of the more commonly used tapset functions
207 • addr:long ()
208 • backtrace:string ()
209 • caller:string ()
210 • caller_addr:long ()
211 • cmdline_arg:string (N:long)
212 • cmdline_args:string (N:long,m:long,delim:string)
213 • cmdline_str:string ()
214 • env_var:string (name:string)
215 • execname:string ()
216 • int_arg:long (N:long)
217 • isinstr:long(s1:string,s2:string)
218 • long_arg:long (N:long)
219 • modname:string ()
220 • module_name:string ()
221 • pid:long ()
222 • pn:string ()
223 • pointer_arg:string (N:long)
224 • pp:string ()
225 • print_backtrace ()
226 • probefunc:string ()
227 • register:long(name:string)
228 • str_replace:string(prnt_str:string,srch_str:string,rplc_str:string)
229 • stringat:long(str:string,pos:long)
230 • strlen:long(str:string)
231 • strtol:long(str:string,base:long)
232 • substr:string(str:string,start:long,length:long)
233 • user_long:long(addr:long)
234 • user_string:string(addr:long)
235
239 stap(1)
240
243 Use the Bugzilla link of the project web page or our mailing list.
244 http://sourceware.org/systemtap/,<systemtap@sourceware.org>.
245 STAPREF(1)