]>
Commit | Line | Data |
---|---|---|
9fcf867f | 1 | * What's new in version 3.0 |
191ede01 DS |
2 | |
3 | - The new "interactive" mode, specified by "stap -i" drops you into a | |
4 | command-line prompt where you can build up a script, run it, edit | |
5 | it, run it again, etc. Type "help" for a list of commands. | |
6 | ||
36fa6eb3 FCE |
7 | - Add macros @prints to print a scalar aggregate variable, @prints[1-9] |
8 | to print an array aggregate (of given index-arity), formatted similarly | |
9 | to the automatic printing of written-only global variables. | |
10 | ||
11 | global a, b | |
12 | probe oneshot { a <<< 1; b[tid()] <<< 2 } | |
13 | probe end { @prints(a); @prints1(b) } | |
14 | ||
7b5b30a8 FL |
15 | - Functions may now be overloaded during module runtime using the "next" |
16 | statement in script functions and STAP_NEXT macro for embedded-C functions. | |
17 | They may also be overloaded by number of parameters during compile time. | |
18 | For example, | |
19 | ||
20 | Runtime overloading: | |
21 | function f() { if (condition) next; print("first function") } | |
22 | function f() %{ STAP_NEXT; print("second function") %} | |
23 | function f() { print("third function") } | |
24 | ||
25 | In the example above, the third function will be executed if condition | |
26 | evaluates to true. | |
27 | ||
28 | Parameter overloading: | |
29 | function f() { print("first function") } | |
30 | function f(x) { print("second function") } | |
31 | ||
32 | Note that runtime overloading is not possible in the above example as the | |
33 | number of parameters differ. The function candidates are selected at compile | |
34 | time and is determined by the number of arguments provided for the functioncall. | |
35 | ||
24ef0e88 | 36 | - Add Czech version of manual pages. |
9fcf867f | 37 | |
40ae3a75 AJ |
38 | - The stap compile server will log the stap client's options that are passed |
39 | to the server. The options that get logged on the server will include the | |
40 | script name or the -e script, depending on which is used by the client. | |
41 | ||
0af18f5a FL |
42 | - Embedded-C functions and blocks may now access script level global variables |
43 | using the STAP_GLOBAL_GET_* and STAP_GLOBAL_SET_* macros. | |
44 | ||
45 | To read or write the script global var, the /* pragma:read:var */ or | |
46 | /* pragma:write:var */ marker must be placed in the embedded-C function or block. | |
47 | The written type must match the type inferred at script level. | |
48 | ||
49 | Scalars: | |
50 | STAP_GLOBAL_SET_var(STAP_GLOBAL_GET_var()+1) -> increments script global var by 1 | |
51 | STAP_GLOBAL_SET_var("hello") | |
52 | ||
53 | Associative arrays: | |
54 | STAP_GLOBAL_GET_var(index-1, ..., index-n) | |
55 | STAP_GLOBAL_SET_var(index-1, ..., index-n, new value) | |
56 | ||
380d759b FL |
57 | - Probe point brace expansion is now supported to improve brevity in |
58 | specifying probe points. For example, | |
59 | ||
60 | process.{function("a"), function("b").{call,return}} | |
61 | => process.function("a"), process.function("b").call, process.function("b").return | |
62 | ||
63 | process.{function("*").callees,plt}? | |
64 | => process.function("*").callees?, process.plt? | |
65 | ||
66 | {kernel,module("nfs")}.function("nfs*")! | |
67 | => kernel.function("nfs*")!, module("nfs").function("nfs*")! | |
68 | ||
b113d360 FL |
69 | - Profiling timers at arbitrary frequencies are now provided and perf probes |
70 | now support a frequency field as an alternative to sampling counts. | |
07c818a0 FL |
71 | |
72 | probe timer.profile.freq.hz(N) | |
b113d360 | 73 | probe perf.type(N).config(M).hz(X) |
07c818a0 FL |
74 | |
75 | The specified frequency is only accurate up to around 100hz. You may | |
76 | need to provide a higher value to achieve the desired rate. | |
77 | ||
98f01ffe FL |
78 | - New --monitor[=INTERVAL] option similar to unix "top". This allows users to |
79 | see statistics about the running module(uptime, module name, invoker uid, | |
80 | memory sizes, global variables, and the current probe list along with | |
81 | their statistics). | |
82 | ||
83 | An interface is also provided to allow control over the running | |
84 | module(resetting global variables, sorting the list of probes, deactivating | |
85 | and reactivating probes). | |
86 | ||
38bf68a8 MC |
87 | - Added support for private global variables and private functions. The scope |
88 | of these is limited to the tapset file they are defined in (PR19136). | |
89 | ||
9fcf867f FCE |
90 | - New tapset function string_quoted() to quote and \-escape general strings. |
91 | String $context variables that are pretty-printed are now processed with | |
92 | such a quotation engine, falling back to a 0x%x (hex pointer) on errors. | |
1254cb0c | 93 | |
c88409ef MC |
94 | - Functions get_mmap_args() and get_32mmap_args() got deprecated. |
95 | ||
7009f2f7 | 96 | * What's new in version 2.9, 2015-10-08 |
f59f4f63 | 97 | |
7b65c066 FL |
98 | - SystemTap now uses symbols from /proc/kallsyms when kernel debuginfo is not |
99 | available. | |
100 | ||
30833b32 MC |
101 | - New --prologue-searching[=WHEN] option has been added to stap with '-P' being |
102 | its short counterpart. Using --prologue-searching=never turns prologue | |
103 | searching deliberately off working around issue of int_arg() returning wrong | |
104 | value when a 32-bit userspace binary having debug info is being probed with | |
105 | active prologue searching (PR18649). | |
106 | ||
eb73b74a MC |
107 | - The powerpc variant of nd_syscall.compat_sysctl got deprecated on favor of |
108 | nd_syscall.sysctl32. This aligns the nd_syscall to its respective syscall and | |
109 | to ia64/s390/x86_64 variants too. | |
110 | ||
247e2766 FL |
111 | - New tapset function assert(expression, msg) has been added. |
112 | ||
69e6920d FL |
113 | - Embedded-C functions may now use the new STAP_PRINTF(fmt, ...) |
114 | macro for output. | |
115 | ||
a11f34b0 FCE |
116 | - New tapset functions fullname_struct_path and fullname_struct_nameidata |
117 | resolve full path names from internal kernel struct pointers. | |
118 | ||
93f70a9a FL |
119 | - New tapset functions arch_bytes() and uarch_bytes() to obtain address size |
120 | for kernel and user space respectively. | |
121 | ||
7cb93423 FL |
122 | - New tapset function switch_file() allows control over rotation |
123 | of output files. | |
124 | ||
0ca3688f MC |
125 | - The [nd_]syscall tapset got autodocumented. Related paragraph got added to PDF |
126 | and HTML tapset reference. Also a new tapset::syscall 3stap man page got added. | |
b2074863 | 127 | |
b2ee3eeb FCE |
128 | - Embedded-C functions with parameter arity-0 can now be marked with |
129 | the /* stable */ /* pure */ pragmas, if (roughly speaking) the | |
130 | function is side-effect-free and idempotent. The translator may | |
131 | execute these speculatively and have their results memoized. This | |
132 | lets probes with multiple calls to such functions run faster. | |
a51cbbf0 | 133 | |
b2ee3eeb FCE |
134 | Context variable ($foo) getter functions (in non-guru mode), and |
135 | numerous tapset functions are now marked as /* stable */ /* pure */. | |
136 | Several example scripts have been modified to eschew explicit | |
137 | memoization. | |
a51cbbf0 | 138 | |
f0e06c0d FL |
139 | - Callee probe points now support '.return' and '.call' suffix. |
140 | For example, | |
141 | ||
142 | process("proc").function("foo").callee("bar").return | |
143 | ||
144 | will fire upon returning from bar when called by foo. | |
145 | ||
146 | process("proc").function("foo").callee("bar").call | |
147 | ||
148 | will only fire for non-inlined callees. | |
149 | ||
ed891cf3 MC |
150 | - The following tapset variables and functions are deprecated in |
151 | version 2.9: | |
152 | - The '__int32_compat' library macro got deprecated in favor of | |
153 | new '__compat_long' library macro. | |
a7396f63 MC |
154 | - The 'uargs' convenience variable of the 'seccomp' syscall probe |
155 | got deprecated in favor of new 'uargs_uaddr' variable. | |
ed891cf3 | 156 | |
faa053ee | 157 | - SystemTap has reduced its memory consumption by using interned_strings (a |
7a922f72 AJ |
158 | wrapper for boost::string_ref) in place of std::string instances. The change |
159 | is to reduce the number of duplicate strings created by replacing them with | |
160 | interned_strings which act like pointers to existing strings. | |
161 | ||
162 | For the implementation of interned_string, see stringtable.h | |
163 | ||
08dc7182 | 164 | * What's new in version 2.8, 2015-06-17 |
9a399080 | 165 | |
b976611a AJ |
166 | - SystemTap has improved support for probing golang programs. Work has been |
167 | done to be able to handle DWARF information, reporting file names, line | |
168 | numbers, and column numbers, and tolerance of odd characters in symbol names. | |
169 | ||
170 | - The function::*, probe::* and new macro::* man pages cross-references the | |
171 | enclosing tapset::* man page. For example: | |
172 | ||
173 | function::pn(3stap) mentions tapset::pn(3stap) in the SEE ALSO section | |
174 | ||
175 | - New stapref(1) man page provides a reference for the scripting language. The | |
176 | stapref page contains an overview of the features available in the language, | |
177 | such as keywords, data types, operators and more. | |
178 | ||
179 | - The @task macro performs the very common @cast to a task_struct. | |
180 | ||
181 | The embedded-C bodies of task_current() and pid2task() are now wrapped | |
182 | by @task, which gives them a debuginfo type on the return value. With | |
183 | autocast type propagation, this removes the need for any explicit @cast | |
184 | in many places. | |
185 | ||
186 | Other places which take untyped task pointers as parameters, for | |
187 | instance, now use @task as well to simplify their code. | |
188 | ||
2be83613 AJ |
189 | - New namespace-aware tapset functions [task_]ns_*() and ia new option |
190 | --target-namespaces=PID to denote a target set of namespaces corresponding to | |
191 | the PID's namespaces. The namespace-aware tapsets will return values | |
192 | relative to the target namespaces if specified, or the stap process' namespaces. | |
193 | ||
8d025d70 FCE |
194 | - Netfilter probes now attempt to decode Spanning Tree Protocol packets |
195 | into local variables: probe netfilter.bridge.*, br_* variables, | |
196 | stp_dump.stp sample script. | |
76bde0fb | 197 | |
c7ec299c FCE |
198 | - Colorization of error string tokens is made more robust, especially |
199 | in presence of $N/@N substitution. | |
200 | ||
97fca116 MC |
201 | - The following tapset variables and functions are deprecated in |
202 | version 2.8: | |
bf952a76 DS |
203 | - The 'hostname_uaddr' variable in the syscall.setdomainname and |
204 | nd_syscall.setdomainname probe aliases have been deprecated in | |
205 | favor of the new 'domainname_uaddr' variable. | |
206 | - The 'fd' and 'fd_str' variables in the syscall.execveat and | |
207 | nd_syscall.execveat probe aliases have been deprecated in favor of | |
208 | the new 'dirfd' and 'dirfd_str' variables. | |
97fca116 | 209 | |
c86582b2 | 210 | * What's new in version 2.7, 2015-02-18 |
e4542435 | 211 | |
bf38b31c FCE |
212 | - Some systemtap sample scripts are now identified with the "_best" keyword, |
213 | because they are generally useful or educational. They are now promoted | |
214 | within the generated index files. | |
215 | ||
89538c0b FCE |
216 | - Passing strings to and from functions has become faster due to optimization |
217 | (passing some strings by reference instead of by value/copy). It may | |
218 | be disabled by using the unoptimize flag (-u). | |
219 | ||
220 | To make embedded-C functions eligible for the same optimization, use the pragma | |
221 | /* unmodified-fnargs */ to indicate that the function body will not modify | |
222 | the function arguments. Remember to use MAXSTRINGLEN for string length, | |
223 | rather than sizeof(string_arg) (which might now be a pointer). | |
b5f388f2 | 224 | |
562e0475 JL |
225 | - SystemTap now allows .function probes to be specified by their full function |
226 | name, file, and declaration line number. Use the .statement probe to probe a | |
227 | specific line number. | |
228 | ||
a7a4e25a JL |
229 | - Tracepoint probes can now also be specified by the target subsystem. For |
230 | example, the following are all supported: | |
231 | ||
232 | probe kernel.trace("sched:sched_switch") --> probe sched_switch found in the | |
233 | sched subsystem | |
234 | probe kernel.trace("sched:*") --> probe all tracepoints in sched subsystem | |
235 | ||
236 | As a result, tapset functions such as pn() will now return a different string | |
237 | than before. To retain the previous behaviour, use '--compatible=2.6'. | |
238 | ||
3e257ca3 DS |
239 | - The following functions are deprecated in release 2.7: |
240 | - _adjtx_mode_str(), _statfs_f_type_str(), _waitid_opt_str(), | |
241 | _internal_wait_opt_str(), and _epoll_events_str(). | |
242 | ||
26a113c4 AJ |
243 | - New tapset functions [u]symfileline(), [u]symfile() and [u]symline() will |
244 | return a string containing the specified portion of the filename:linenumber | |
245 | match from a given address. | |
246 | ||
247 | Using these functions may result in large generated modules from stored | |
248 | address->file:line information. | |
249 | ||
547f446e | 250 | * What's new in version 2.6, 2014-09-05 |
bbcb49f1 | 251 | |
28bcb1f5 JL |
252 | - SystemTap now supports on-the-fly arming/disarming of certain probe types: |
253 | kprobes, uprobes, and timer.*s(NUM) probes. For example, this probe | |
254 | ||
255 | probe kernel.function("vfs_read") if (i > 4) { ... } | |
256 | ||
257 | will automatically register/unregister the associated kprobe on vfs_read | |
94fe8dd0 FCE |
258 | whenever the value of the condition changes (as some probe handler |
259 | modifies 'i'). This allows us to avoid probe overhead when we're not | |
260 | interested. If the arming capability is not relevant/useful, nest the | |
261 | condition in the normal probe handler: | |
28bcb1f5 | 262 | |
94fe8dd0 | 263 | probe kernel.function("vfs_read") { if (i > 4) { ... } } |
28bcb1f5 | 264 | |
5e758862 FCE |
265 | - statement("*@file:NNN").nearest probes now available to let systemtap |
266 | translate probe to nearest probe-able line to one given if necessary | |
267 | ||
2e96714f SC |
268 | - process("PATH").library("PATH").plt("NAME").return probes are now supported. |
269 | ||
019b136a JL |
270 | - SystemTap now supports SDT probes with operands that refer to symbols. |
271 | ||
9d38cfdf JL |
272 | - While in listing mode (-l/-L), probes printed are now more consistent |
273 | and precise. | |
274 | ||
9d4e206f JL |
275 | - Statement probes now support enumerated linenos to probe discontiguous |
276 | linenos using the form: | |
277 | ||
278 | process.statement("foo@file.c:3,5-7,9") | |
279 | ||
05e1f80d AJ |
280 | - Statement counting is now suppressed in the generated c code for probes that |
281 | are non-recursive and loop-free. Statement counting can be turned back on in | |
282 | unoptimize mode (-u). | |
283 | ||
f0062f0a | 284 | - SystemTap now asserts that the PID provided for a process probe corresponds |
e4542435 | 285 | to a running process. |
f0062f0a AJ |
286 | |
287 | - DWARF process probes can be bound to a specific process using the form: | |
288 | ||
289 | process(PID).function("*") | |
290 | ||
37c610c5 AJ |
291 | - SystemTap now accepts additional scripts through the new -E SCRIPT option. |
292 | There still needs to be a main script specified through -e or file in order | |
293 | to provide an additional script. This makes it feasible to have scripts in | |
e6e7c331 | 294 | the $HOME/.systemtap/rc file. For example: |
37c610c5 AJ |
295 | |
296 | -E 'probe begin, end, error { log("systemtap script " . pn()) }' | |
e6e7c331 | 297 | -E 'probe timer.s(30) { error ("timeout") } |
37c610c5 | 298 | |
e6e7c331 | 299 | The -E SCRIPT option can also be used in listing mode (-l/-L), such that |
37c610c5 AJ |
300 | probe points for the additional scripts will not listed, but other parts of |
301 | the script are still available, such as macros or aliases. | |
302 | ||
27702aa7 AJ |
303 | - SystemTap now supports array slicing within foreach loop conditions, delete |
304 | statements and membership tests. Wildcards are represented by "*". Examples | |
305 | of the expressions are: | |
306 | ||
307 | foreach ([a,b,c] in val[*,2,*]) | |
308 | delete val[*, 2, *] | |
309 | [*, 2, *] in val | |
310 | ||
d34535b6 JS |
311 | - Integer expressions which are derived from DWARF values, like context $vars, |
312 | @cast, and @var, will now carry that type information into subsequent reads. | |
313 | Such expressions can now use "->" and "[]" operators, as can local variables | |
314 | which were assigned such values. | |
315 | ||
316 | foo = $param->foo; printf("x:%d y:%d\n", foo->x, foo->y) | |
317 | printf("my value is %d\n", ($type == 42 ? $foo : $bar)->value) | |
318 | printf("my parent pid is %d\n", task_parent(task_current())->tgid) | |
319 | ||
bbcb49f1 | 320 | * What's new in version 2.5, 2014-04-30 |
69bd8cc1 | 321 | |
de607e9a LB |
322 | - Systemtap now supports backtracing through its own, invoking module. |
323 | ||
324 | - Java probes now support backtracing using the print_java_backtrace() | |
325 | and sprint_java_backtrace() functions. | |
326 | ||
7b51754b JL |
327 | - Statement probes (e.g. process.statement) are now faster to resolve, |
328 | more precise, and work better with inlined functions. | |
329 | ||
bf8a9682 JL |
330 | - New switches have been added to help inspect the contents of installed |
331 | library files: | |
332 | ||
93a05601 | 333 | stap --dump-functions --> list all library functions and their args |
bf8a9682 JL |
334 | stap --dump-probe-aliases --> list all library probe aliases |
335 | ||
2dd920e3 FCE |
336 | - The heuristic algorithms used to search for function-prologue |
337 | endings were improved, to cover more optimization (or | |
338 | lack-of-optimization, or incorrect-debuginfo) cases. These | |
339 | heuristics are necessary to find $context parameters for some | |
340 | function-call/entry probes. We recommend programs be built with | |
341 | CFLAGS+=-grecord-gcc-switches to feed information to the heuristics. | |
342 | ||
3598d11a FCE |
343 | - The stap --use-server option now more correctly supports address:port |
344 | type parametrization, for manual use in the absence of avahi. | |
345 | ||
2dd920e3 FCE |
346 | - A new probe alias "oneshot" allows a single quick script fragment to run, |
347 | then exit. | |
817c5088 FCE |
348 | |
349 | - The argv tapset now merges translate-time and run-time positional | |
350 | arguments, so all of these work: | |
351 | ||
352 | stap -e 'probe oneshot {println(argv[1]," ",argv[2])}' hello world | |
2dd920e3 FCE |
353 | |
354 | stap -e 'probe oneshot {println(argv[1]," ",argv[2])}' \ | |
355 | -G argv_1=hello -G argv_2=world | |
356 | ||
817c5088 FCE |
357 | staprun hello.ko argv_1=hello argv_2=world |
358 | ||
1fd9dd40 LB |
359 | - SystemTap now falls back on the symbol table for probing |
360 | functions in processes if the debuginfo is not available. | |
361 | ||
ad13deea FCE |
362 | - SystemTap now supports a %( guru_mode == 0 /* or 1 */ %) |
363 | conditional for making dual-use scripts. | |
364 | ||
ac19c040 FCE |
365 | - SystemTap now supports UEFI/SecureBoot systems, via |
366 | machine-owner-keys maintained by a trusted stap-server on the | |
367 | network. (Key enrollment requires a one-time reboot and BIOS | |
368 | conversation.) | |
d7765ae8 | 369 | https://sourceware.org/systemtap/wiki/SecureBoot |
ac19c040 | 370 | |
3644d75b JL |
371 | - SystemTap now reports more accurate and succinct errors on type |
372 | mismatches. | |
373 | ||
be59b114 FCE |
374 | - Embedded-C functions may use STAP_RETURN(value) instead of the |
375 | more wordy STAP_RETVALUE assignment followed by a "goto out". | |
376 | The macro supports numeric or string values as appropriate. | |
aa9bec70 | 377 | STAP_ERROR(...) is available to return with a (catchable) error. |
be59b114 | 378 | |
ecd711df FCE |
379 | - Some struct-sockaddr fields are now individually decoded for |
380 | socket-related syscalls: | |
381 | probe syscall.connect { println (uaddr_af, ":", uaddr_ip) } | |
382 | ||
30711698 JL |
383 | - The documentation for the SystemTap initscript service and the |
384 | SystemTap compile-server service have been completely converted from | |
385 | README files to man pages (see systemtap(8) and stap-server(8)). | |
8f97c4c3 | 386 | |
f6def2d7 | 387 | - SystemTap is now capable of inserting modules early during the boot |
8f97c4c3 JL |
388 | process on dracut-based systems. See the 'onboot' command in |
389 | systemtap(8) for more information. | |
f6def2d7 | 390 | |
587ba6fd JL |
391 | - DWARF probes can now use the '.callee[s]' variants, which allow more |
392 | precise function probing. For example, the probe point | |
393 | ||
394 | process("myproc").function("foo").callee("bar") | |
395 | ||
396 | will fire upon entering bar() from foo(). A '.callees' probe will | |
074c54b6 JL |
397 | instead place probes on all callees of foo(). |
398 | Note that this also means that probe point wildcards should be used | |
399 | with more care. For example, use signal.*.return rather than | |
400 | signal.*.*, which would also match '.callees'. See stapprobes(3stap) | |
401 | for more info. This feature requires at least GCC 4.7. | |
587ba6fd | 402 | |
bb4a77c1 JL |
403 | - A few new functions in the task_time tapsets, as well as a new tapset |
404 | function task_ancestry(), which prints out the parentage of a process. | |
405 | ||
406 | - The kprocess.exec probe has been updated to use syscall.execve, which | |
f1753911 JL |
407 | allows access to the new process' arguments (through the new 'argstr' |
408 | or 'args' variables) as well as giving better support across kernel | |
409 | versions. Note also that the 'filename' variable now holds the | |
410 | filename (quoted), or the address (unquoted) if it couldn't be | |
411 | retrieved. | |
bb4a77c1 | 412 | |
3ca300df JL |
413 | - The [s]println() function can now be called without any arguments to |
414 | simply print a newline. | |
415 | ||
e90006d7 JL |
416 | - Suggestions are now provided when markers could not be resolved. For |
417 | example, process("stap").mark("benchmart") will suggest 'benchmark'. | |
418 | ||
6667be37 JL |
419 | - SystemTap colors can now be turned off by simply setting |
420 | SYSTEMTAP_COLORS to be empty, rather than having to make it invalid. | |
421 | ||
2aee1644 | 422 | - There is a new context tapset function, pnlabel(), which returns the |
887d4fe1 JL |
423 | name of the label which fired. |
424 | ||
46259973 DS |
425 | - The following tapset variables and functions are deprecated in |
426 | release 2.5: | |
61846467 DS |
427 | - The 'clone_flags', 'stack_start', 'stack_size', |
428 | 'parent_tid_uaddr', and 'child_tid_uaddr' variables in the | |
429 | 'syscall.fork' and 'nd_syscall.fork' probe aliases. | |
46259973 DS |
430 | - The '_sendflags_str()' and '_recvflags_str()' functions have been |
431 | deprecated in favor of the new '_msg_flags_str()' function. | |
3fafd4b1 DS |
432 | - The 'flags' and 'flags_str' variables in the 'syscall.accept' and |
433 | 'nd_syscall.accept' probe alias. | |
ed85f25a DS |
434 | - The 'first', 'second', and 'uptr_uaddr' variables in the |
435 | 'syscall.compat_sys_shmctl', and 'nd_syscall.compat_sys_shmctl' | |
436 | probe aliases have been deprecated in favor of the new 'shmid', | |
437 | 'cmd', and 'buf_uaddr' variables. | |
61846467 | 438 | |
69bd8cc1 | 439 | * What's new in version 2.4, 2013-11-06 |
5033017a | 440 | |
0dc15c72 JL |
441 | - Better suggestions are given in many of the semantic errors in which |
442 | alternatives are provided. Additionally, suggestions are now provided | |
443 | when plt and trace probes could not be resolved. For example, | |
444 | kernel.trace("sched_siwtch") will suggest 'sched_switch'. | |
445 | ||
268cb671 JL |
446 | - SystemTap is now smarter about error reporting. Errors from the same |
447 | source are considered duplicates and suppressed. A message is | |
448 | displayed on exit if any errors/warnings were suppressed. | |
449 | ||
c1cb76c5 FCE |
450 | - Statistics aggregate typed objects are now implemented locklessly, |
451 | if the translator finds that they are only ever read (using the | |
452 | foreach / @count / etc. constructs) in a probe-begin/end/error. | |
453 | ||
fe14f21a JL |
454 | - SystemTap now supports probing inside virtual machines using the |
455 | libvirt and unix schemes, e.g. | |
456 | ||
457 | stap -ve 'probe timer.s(1) { printf("hello!\n") }' \ | |
458 | --remote=libvirt://MyVirtualMachine | |
459 | ||
460 | Virtual machines managed by libvirt can be prepared using stapvirt. | |
461 | See stapvirt(1) and the --remote option in stap(1) for more details. | |
fe14f21a | 462 | |
c5810d31 LB |
463 | - Systemtap now checks for and uses (when available) the .gnu_debugdata |
464 | section which contains a subset of debuginfo, useful for backtraces | |
465 | and function probing | |
466 | ||
f1b60d36 DS |
467 | - SystemTap map variables are now allocated with vmalloc() instead of |
468 | with kmalloc(), which should cause memory to be less fragmented. | |
469 | ||
94eb87d1 DS |
470 | - Although SystemTap itself requires elfutils 0.148+, staprun only |
471 | requires elfutils 0.142+, which could be useful with the | |
472 | '--disable-translator' configure switch. | |
5033017a | 473 | |
710f5084 FCE |
474 | - Under FIPS mode (/proc/sys/crypto/fips_enabled=1), staprun will |
475 | refuse to load systemtap modules (since these are not normally | |
476 | signed with the kernel's build-time keys). This protection may | |
477 | be suppressed with the $STAP_FIPS_OVERRIDE environment variable. | |
478 | ||
bbd7c635 FCE |
479 | - The stap-server client & server code now enable all SSL/TLS |
480 | ciphers rather than just the "export" subset. | |
481 | ||
f9ae3416 DS |
482 | - For systems with in-kernel utrace, 'process.end' and 'thread.end' |
483 | probes will hit before the target's parent process is notified of | |
484 | the target's death. This matches the behavior of newer kernels | |
485 | without in-kernel utrace. | |
486 | ||
5033017a | 487 | * What's new in version 2.3, 2013-07-25 |
9b1480fe | 488 | |
0ba56fe9 FCE |
489 | - More context-accessing functions throw systemtap exceptions upon a |
490 | failure, whereas in previous versions they might return non-error | |
491 | sentinel values like "" or "<unknown>". Use try { } / catch { } | |
492 | around these, or new wrapper functions such as user_string_{n_}quoted() | |
493 | that internally absorb exceptions. | |
494 | ||
269cd0ae LB |
495 | - java("org.my.MyApp") probes are now restricted to pre-existing jvm pid's with |
496 | a listing in jps -l output to avoid recursive calls | |
497 | ||
2f80feee FCE |
498 | - The tapset [nd_]syscall.semop parameter tsops_uaddr is renamed sops_uaddr for |
499 | consistency with [nd_]syscall.semtimedop. | |
9b1480fe | 500 | |
0db12495 FCE |
501 | - The udp.stp tapset adds some ip-address/port variables. |
502 | ||
f2087e43 FCE |
503 | - A new guru-mode-only tapset function raise() is available to send signals |
504 | to the current task. | |
505 | ||
05890217 SM |
506 | - Support for the standard Posix ERE named character classes has been |
507 | added to the regexp engine, e.g. [:digit:], [:alpha:], ... | |
508 | ||
509 | - A substantial internal overhaul of the regexp engine has resulted in | |
510 | correct behaviour on further obscure edge cases. The regexp engine | |
511 | now implements the ERE standard and correctly passes the testsuite | |
512 | for the glibc regexp engine (minus portions corresponding to | |
513 | unimplemented features -- i.e. subexpression capture and reuse). | |
514 | ||
8d609ccd JL |
515 | - Alternative functions are now suggested when function probes could not be |
516 | resolved. For example, kernel.function("vfs_reads") will suggest vfs_read. | |
517 | Other probes for which suggestions are made are module.function, | |
518 | process.function, and process.library.function. | |
519 | ||
520 | - Has life been a bit bland lately? Want to spice things up? Why not write a | |
521 | few faulty probes and feast your eyes upon the myriad of colours adorning | |
522 | your terminal as SystemTap softly whispers in your ear... 'parse error'. | |
523 | Search for '--color' in 'man stap' for more info. | |
524 | ||
1022de3a | 525 | - The following tapset functions are deprecated in release 2.3: |
b53b2931 DS |
526 | 'stap_NFS_CLIENT', '__getfh_inode', '_success_check', |
527 | '_sock_prot_num', '_sock_fam_num', '_sock_state_num', | |
528 | '_sock_type_num', and '_sock_flags_num'. | |
1022de3a | 529 | |
e4bf97f8 | 530 | * What's new in version 2.2.1, 2013-05-16 |
3745457b | 531 | * What's new in version 2.2, 2013-05-14 |
762e53a4 | 532 | |
030772fa FCE |
533 | - Experimental support has been added for probing Java methods using |
534 | Byteman 2.0 as a backend. Java method probes can target method entries, | |
535 | returns, or specific statements in the method as specified by line number. | |
f313c59e | 536 | |
296dbeb1 FCE |
537 | probe java("org.my.MyApp").class("^java.lang.Object").method("foo(int)") |
538 | { println($$parms) } | |
f313c59e SM |
539 | |
540 | See java/README for information on how to set up Java/Byteman | |
296dbeb1 | 541 | functionality. Set env STAPBM_VERBOSE=yes for more tracing. |
f313c59e | 542 | |
e4bf97f8 FCE |
543 | - The stap -l output and pn() tapset function's return value may be slightly |
544 | different for complicated web of wildcarded/aliased probes. | |
d885563b | 545 | |
3d0dc3b0 | 546 | - The dyninst backend has improved in several aspects: |
030772fa | 547 | |
3d0dc3b0 SM |
548 | - Setting custom values for global variables is now supported, both |
549 | with -G when compiling a script, and from the stapdyn command line | |
550 | when loading a precompiled module. | |
551 | ||
030772fa FCE |
552 | - A high-performance shared-memory-based transport is used for |
553 | trace data. | |
554 | ||
6086ea14 SM |
555 | - A systemd service file and tmpfile have been added to allow |
556 | systemtap-server to be managed natively by systemd. | |
557 | ||
40abf3c7 SM |
558 | - Due to the removal of register_timer_hook in recent kernels, the |
559 | behaviour of timer.profile has been changed slightly. This probe is | |
560 | now an alias which uses the old mechanism where possible, but falls | |
030772fa FCE |
561 | back to perf.sw.cpu_clock or another mechanism when the kernel timer |
562 | hook is not available. | |
40abf3c7 SM |
563 | |
564 | To require the kernel timer hook mechanism in your script, use | |
565 | timer.profile.tick instead of timer.profile. | |
566 | ||
030772fa | 567 | - The following tapset variables are deprecated in release 2.2: |
3131aa44 DS |
568 | - The 'origin' variables in the 'generic.fop.llseek', |
569 | 'generic.fop.llseek.return', and 'nfs.fop.llseek' probes. The | |
a2785cec DS |
570 | 'origin' variable has been replaced by the 'whence' variable. |
571 | - The 'page_index' variable in the 'vfs.block_sync_page' and | |
572 | 'vfs.buffer_migrate_page' probe aliases. | |
573 | - The 'write_from' and 'write_upto' variables in the | |
574 | '_vfs.block_prepare_write' and '_vfs.block_prepare_write.return' | |
575 | probe aliases. | |
2ab1a2ff DS |
576 | - The 'regs' variable in the 'syscall.sigaltstack', |
577 | 'nd_syscall.sigaltstack', 'syscall.fork', and 'nd_syscall.fork' | |
578 | probe aliases. | |
40fbf66a DS |
579 | - The 'first', 'second', 'third', and 'uptr_uaddr' variables in the |
580 | 'syscall.compat_sys_shmat' and 'nd_syscall.compat_sys_shmat' probe | |
581 | aliases. | |
a2785cec | 582 | |
2f80feee | 583 | - The following tapset functions are deprecated in release 2.2: |
a2785cec | 584 | 'ppos_pos', '_dev_minor', and '_dev_major' |
3131aa44 | 585 | |
19c127dd DS |
586 | - The folowing tapset functions used to return error strings instead |
587 | of raising an error. The original behavior is deprecated in release | |
588 | 2.2. | |
589 | ||
590 | 'ctime', 'probemod', 'modname' | |
591 | ||
addec813 | 592 | * What's new in version 2.1, 2013-02-13 |
03f593dc | 593 | |
edcf7e40 FCE |
594 | - EMACS and VIM editor modes for systemtap source files are included / updated. |
595 | ||
c901d0d8 FCE |
596 | - The translator now eliminates duplicate tapset files between its |
597 | preferred directory (as configured during the build with --prefix=/ | |
598 | or specified with the -I /path option), and files it may find under | |
599 | $XDG_DATA_DIRS. This should eliminate a class of conflicts between | |
600 | parallel system- and hand-built systemtap installations. | |
601 | ||
011d4404 FCE |
602 | - The translator accepts a --suppress-time-limits option, which defeats |
603 | time-related constraints, to allows probe handlers to run for indefinite | |
604 | periods. It requires the guru mode (-g) flag to work. Add the earlier | |
605 | --suppress-handler-errors flag for a gung-ho "just-keep-going" attitude. | |
606 | ||
3689db05 SC |
607 | - Perf event probes may now be read on demand. The counter probe is |
608 | defined using the counter-name part: | |
609 | probe perf.type(0).config(0).counter("NAME"). The counter is | |
610 | read in a user space probe using @perf("NAME"), e.g. | |
611 | process("PROCESS").statement("func@file") {stat <<< @perf("NAME")} | |
612 | ||
6a8fe809 SC |
613 | - Perf event probes may now be bound to a specific task using the |
614 | process-name part: probe perf.type(0).config(0).process("NAME") { } | |
615 | If the probed process name is not specified, then it is inferred | |
616 | from the -c CMD argument. | |
617 | ||
c1a136b7 SM |
618 | - Some error messages and warnings now refer to additional information |
619 | that is found in man pages. These are generally named | |
473c67cd FCE |
620 | error::FOO or warning::BAR (in the 7stap man page section) |
621 | and may be read via | |
622 | % man error::FOO | |
a3309329 | 623 | % man warning::BAR |
a55a284c | 624 | |
9717d7c6 JS |
625 | - The dyninst backend has improved in several aspects: |
626 | - The runtime now allows much more concurrency when probing multithreaded | |
627 | processes, and will also follow probes across forks. | |
628 | - Several new probe types are now supported, including timers, function | |
629 | return, and process.begin/end and process.thread.begin/end. | |
630 | - Semaphores for SDT probes are now set properly. | |
631 | - Attaching to existing processes with -x PID now works. | |
a55a284c | 632 | |
64ed3e15 | 633 | - The foreach looping construct can now sort aggregate arrays by the user's |
2712766d | 634 | choice of aggregating function. Previously, @count was implied. e.g.: |
a3309329 | 635 | foreach ([x,y] in array @sum +) { println(@sum(array[x,y])) } |
2712766d | 636 | |
84dca268 SM |
637 | - Proof of concept support for regular expression matching has been added: |
638 | if ("aqqqqqb" =~ "q*b") { ... } | |
639 | if ("abc" !~ "q*b") { ... } | |
640 | ||
641 | The eventual aim is to support roughly the same functionality as | |
642 | the POSIX Extended Regular Expressions implemented by glibc. | |
643 | Currently missing features include extraction of the matched string | |
644 | and subexpressions, and named character classes ([:alpha:], [:digit:], &c). | |
645 | ||
9511bd7c SM |
646 | Special thanks go to the re2c project, whose public domain code this |
647 | functionality has been based on. For more info on re2c, see: | |
648 | http://sourceforge.net/projects/re2c/ | |
649 | ||
99076643 DS |
650 | - The folowing tapset variables are deprecated in release 2.1 and will |
651 | be removed in release 2.2: | |
652 | - The 'send2queue' variable in the 'signal.send' probe. | |
653 | - The 'oldset_addr' and 'regs' variables in the 'signal.handle' probe. | |
654 | ||
655 | - The following tapset probes are deprecated in release 2.1 and will | |
656 | be removed in release 2.2: | |
657 | - signal.send.return | |
658 | - signal.handle.return | |
659 | ||
a63381cc | 660 | * What's new in version 2.0, 2012-10-09 |
4c4adc41 | 661 | |
45f98a0e JS |
662 | - Systemtap includes a new prototype backend, which uses Dyninst to instrument |
663 | a user's own processes at runtime. This backend does not use kernel modules, | |
664 | and does not require root privileges, but is restricted with respect to the | |
665 | kinds of probes and other constructs that a script may use. | |
666 | ||
8ff439fa | 667 | Users from source should configure --with-dyninst and install a |
1f631bc0 FCE |
668 | fresh dyninst snapshot such as that in Fedora rawhide. It may be |
669 | necessary to disable conflicting selinux checks; systemtap will advise. | |
8ff439fa | 670 | |
5dc0297f SM |
671 | Select this new backend with the new stap option --runtime=dyninst |
672 | and a -c target process, along with normal options. (-x target | |
673 | processes are not supported in this prototype version.) For example: | |
45f98a0e | 674 | |
712b1054 | 675 | stap --runtime=dyninst -c 'stap -l begin' \ |
45f98a0e JS |
676 | -e 'probe process.function("main") { println("hi from dyninst!") }' |
677 | ||
2df0c56c SM |
678 | - To aid diagnosis, when a kernel panic occurs systemtap now uses |
679 | the panic_notifier_list facility to dump a summary of its trace | |
680 | buffers to the serial console. | |
681 | ||
48ac1e74 SM |
682 | - The systemtap preprocessor now has a simple macro facility as follows: |
683 | ||
684 | @define add(a,b) %( ((@a)+(@b)) %) | |
685 | @define probegin(x) %( | |
686 | probe begin { | |
687 | @x | |
688 | } | |
689 | %) | |
690 | ||
691 | @probegin( foo = @add(40, 2); print(foo) ) | |
692 | ||
693 | Macros defined in the user script and regular tapset .stp files are | |
694 | local to the file. To get around this, the tapset library can define | |
695 | globally visible 'library macros' inside .stpm files. (A .stpm file | |
696 | must contain a series of @define directives and nothing else.) | |
697 | ||
698 | The status of the feature is experimental; semantics of macroexpansion | |
699 | may change (unlikely) or expand in the future. | |
700 | ||
b96d48c7 SM |
701 | - Systemtap probe aliases may be used with additional suffixes |
702 | attached. The suffixes are passed on to the underlying probe | |
703 | point(s) as shown below: | |
704 | ||
705 | probe foo = bar, baz { } | |
706 | probe foo.subfoo.option("gronk") { } | |
707 | // expands to: bar.subfoo.option("gronk"), baz.subfoo.option("gronk") | |
708 | ||
709 | In practical terms, this allows us to specify additional options to | |
710 | certain tapset probe aliases, by writing e.g. | |
711 | probe syscall.open.return.maxactive(5) { ... } | |
712 | ||
5dc0297f SM |
713 | - To support the possibility of separate kernel and dyninst backends, |
714 | the tapsets have been reorganized into separate folders according to | |
715 | backend. Thus kernel-specific tapsets are located under linux/, the | |
716 | dyninst-specific ones under dyninst/ | |
717 | ||
136b6516 SM |
718 | - The backtrace/unwind tapsets have been expanded to allow random |
719 | access to individual elements of the backtrace. (A caching mechanism | |
720 | ensures that the backtrace computation run at most once for each | |
721 | time a probe fires, regardless of how many times or what order the | |
722 | query functions are called in.) New tapset functions are: | |
723 | stack/ustack - return n'th element of backtrace | |
724 | callers/ucallers - return first n elements of backtrace | |
725 | print_syms/print_usyms - print full information on a list of symbols | |
726 | sprint_syms/sprint_usyms - as above, but return info as a string | |
136b6516 | 727 | |
0588d227 SM |
728 | The following existing functions have been superseded by print_syms() |
729 | et al.; new scripts are recommended to avoid using them: | |
730 | print_stack() | |
731 | print_ustack() | |
732 | sprint_stack() | |
733 | sprint_ustack() | |
734 | ||
7334c68f SM |
735 | - The probefunc() tapset function is now myproc-unprivileged, and can |
736 | now be used in unprivileged scripts for such things as profiling in | |
737 | userspace programs. For instance, try running | |
738 | systemtap.examples/general/para-callgraph.stp in unprivileged mode | |
1c02dc11 FCE |
739 | with a stapusr-permitted probe. The previous implementation of |
740 | probefunc() is available with "stap --compatible=1.8". | |
7334c68f | 741 | |
56b2a82b | 742 | - Preprocessor conditional to vary code based on script privilege level: |
068f404a SM |
743 | unprivileged -- %( systemtap_privilege == "stapusr" %? ... %) |
744 | privileged -- %( systemtap_privilege != "stapusr" %? ... %) | |
745 | or, alternately %( systemtap_privilege == "stapsys" | |
746 | || systemtap_privilege == "stapdev" %? ... %) | |
a95196ce | 747 | |
e104b317 SM |
748 | - To ease migration to the embedded-C locals syntax introduced in 1.8 |
749 | (namely, STAP_ARG_* and STAP_RETVALUE), the old syntax can now be | |
750 | re-enabled on a per-function basis using the /* unmangled */ pragma: | |
751 | ||
752 | function add_foo:long(a:long, b:long) %{ /* unmangled */ | |
753 | THIS->__retvalue = THIS->a + STAP_ARG_b; | |
754 | %} | |
755 | ||
756 | Note that both the old and the new syntax may be used in an | |
757 | /* unmangled */ function. Functions not marked /* unmangled */ | |
758 | can only use the new syntax. | |
759 | ||
59826bda SM |
760 | - Adjacent string literals are now glued together irrespective of |
761 | intervening whitespace or comments: | |
762 | "foo " "bar" --> "foo bar" | |
763 | "foo " /* comment */ "bar" --> "foo bar" | |
764 | Previously, the first pair of literals would be glued correctly, | |
765 | while the second would cause a syntax error. | |
4c4adc41 FCE |
766 | |
767 | * What's new in version 1.8, 2012-06-17 | |
d92a4cfe | 768 | |
09a4c96a FCE |
769 | - staprun accepts a -T timeout option to allow less frequent wake-ups |
770 | to poll for low-throughput output from scripts. | |
771 | ||
e8474d2a FCE |
772 | - When invoked by systemtap, the kbuild $PATH environment is sanitized |
773 | (prefixed with /usr/bin:/bin:) in an attempt to exclude compilers | |
774 | other than the one the kernel was presumed built with. | |
775 | ||
5650ca76 JS |
776 | - Printf formats can now use "%#c" to escape non-printing characters. |
777 | ||
bee54239 FCE |
778 | - Pretty-printed bitfields use integers and chars use escaped formatting |
779 | for printing. | |
780 | ||
0ec2c5bf DB |
781 | - The systemtap compile-server and client now support IPv6 networks. |
782 | - IPv6 addresses may now be specified on the --use-server option and will | |
783 | be displayed by --list-servers, if the avahi-daemon service is running and | |
784 | has IPv6 enabled. | |
785 | - Automatic server selection will automatically choose IPv4 or IPv6 servers | |
786 | according to the normal server selection criteria when avahi-daemon is | |
787 | running. One is not preferred over the other. | |
788 | - The compile-server will automatically listen on IPv6 addresses, if | |
789 | available. | |
790 | - To enable IPv6 in avahi-daemon, ensure that /etc/avahi/avahi-daemon.conf | |
791 | contains an active "use-ipv6=yes" line. After adding this line run | |
792 | "service avahi-daemon restart" to activate IPv6 support. | |
793 | - See man stap(1) for details on how to use IPv6 addresses with the | |
794 | --use-server option. | |
795 | ||
2a885a4a | 796 | - Support for DWARF4 .debug_types sections (for executables and shared |
bb5eb709 FCE |
797 | libraries compiled with recent GCC's -gdwarf-4 / -fdebug-types-section). |
798 | PR12997. SystemTap now requires elfutils 0.148+, full .debug_types support | |
2a885a4a MW |
799 | depends on elfutils 0.154+. |
800 | ||
051ca2a8 FCE |
801 | - Systemtap modules are somewhat smaller & faster to compile. Their |
802 | debuginfo is now suppressed by default; use -B CONFIG_DEBUG_INFO=y to | |
803 | re-enable. | |
804 | ||
179a00c3 MW |
805 | - @var now an alternative language syntax for accessing DWARF variables |
806 | in uprobe and kprobe handlers (process, kernel, module). @var("somevar") | |
807 | can be used where $somevar can be used. The @var syntax also makes it | |
808 | possible to access non-local, global compile unit (CU) variables by | |
809 | specifying the CU source file as follows @var("somevar@some/src/file.c"). | |
810 | This will provide the target variable value of global "somevar" as defined | |
811 | in the source file "some/src/file.c". The @var syntax combines with all | |
812 | normal features of DWARF target variables like @defined(), @entry(), | |
813 | [N] array indexing, field access through ->, taking the address with | |
bee54239 | 814 | the & prefix and shallow or deep pretty printing with a $ or $$ suffix. |
179a00c3 | 815 | |
3a850315 CM |
816 | - Stap now has resource limit options: |
817 | --rlimit-as=NUM | |
818 | --rlimit-cpu=NUM | |
819 | --rlimit-nproc=NUM | |
820 | --rlimit-stack=NUM | |
821 | --rlimit-fsize=NUM | |
822 | All resource limiting has been moved from the compile server to stap | |
823 | itself. When running the server as "stap-server", default resource | |
824 | limit values are specified in ~stap-server/.systemtap/rc. | |
825 | ||
39c3481b FCE |
826 | - Bug CVE-2012-0875 (kernel panic when processing malformed DWARF unwind data) |
827 | is fixed. | |
828 | ||
0ec2c5bf | 829 | - The systemtap compile-server now supports multiple concurrent connections. |
e57c26ea | 830 | Specify the desired maximum number of concurrent connections with |
288d19f2 FCE |
831 | the new stap-server/stap-serverd --max-threads option. Specify a |
832 | value of '0' to tell the server not to spawn any new threads (handle | |
833 | all connections serially in the main thread). The default value is | |
834 | the number of processor cores on the host. | |
d92a4cfe | 835 | |
96f244c0 DS |
836 | - The following tapset functions are deprecated in release 1.8 and will be |
837 | removed in release 1.9: | |
838 | daddr_to_string() | |
839 | ||
021b3251 SM |
840 | - SystemTap now mangles local variables to avoid collisions with C |
841 | headers included by tapsets. This required a change in how | |
842 | embedded-C functions access local parameters and the return value slot. | |
843 | ||
844 | Instead of THIS->foo in an embedded-C function, please use the newly | |
845 | defined macro STAP_ARG_foo (substitute the actual name of the | |
846 | argument for 'foo'); instead of THIS->__retvalue, use the newly | |
847 | defined STAP_RETVALUE. All of the tapsets and test cases have been | |
848 | adapted to use this new notation. | |
849 | ||
850 | If you need to run code which uses the old THIS-> notation, run stap | |
851 | with the --compatible=1.7 option. | |
852 | ||
2f295355 FCE |
853 | - There is updated support for user-space probing against kernels >= |
854 | 3.5, which have no utrace but do have the newer inode-uprobes work | |
855 | by Srikar Dronamraju and colleagues. For kernels < 3.5, the | |
856 | following 3 sets of kernel patches would need to be backported to | |
857 | your kernel to use this preliminary user-space probing support: | |
858 | ||
859 | - inode-uprobes patches: | |
860 | - 2b144498350860b6ee9dc57ff27a93ad488de5dc | |
861 | - 7b2d81d48a2d8e37efb6ce7b4d5ef58822b30d89 | |
862 | - a5f4374a9610fd7286c2164d4e680436727eff71 | |
863 | - 04a3d984d32e47983770d314cdb4e4d8f38fccb7 | |
864 | - 96379f60075c75b261328aa7830ef8aa158247ac | |
865 | - 3ff54efdfaace9e9b2b7c1959a865be6b91de96c | |
866 | - 35aa621b5ab9d08767f7bc8d209b696df281d715 | |
867 | - 900771a483ef28915a48066d7895d8252315607a | |
868 | - e3343e6a2819ff5d0dfc4bb5c9fb7f9a4d04da73 | |
869 | - exec tracepoint kernel patch: | |
870 | - 4ff16c25e2cc48cbe6956e356c38a25ac063a64d | |
871 | - task_work_add kernel patches: | |
872 | - e73f8959af0439d114847eab5a8a5ce48f1217c4 | |
873 | - 4d1d61a6b203d957777d73fcebf19d90b038b5b2 | |
874 | - 413cd3d9abeaef590e5ce00564f7a443165db238 | |
875 | - dea649b8ac1861107c5d91e1a71121434fc64193 | |
876 | - f23ca335462e3c84f13270b9e65f83936068ec2c | |
877 | ||
83bd2699 | 878 | * What's new in version 1.7, 2012-02-01 |
94d406fc | 879 | |
7cd37b1a CM |
880 | - Map inserting and deleting is now significantly faster due to |
881 | improved hashing and larger hash tables. The hashes are also | |
882 | now randomized to provide better protection against deliberate | |
883 | collision attacks. | |
884 | ||
83bd2699 FCE |
885 | - Formatted printing is faster by compiling the formatting directives |
886 | to C code rather than interpreting at run time. | |
887 | ||
222e16ed | 888 | - Systemtap loads extra command line options from $SYSTEMTAP_DIR/rc |
83bd2699 FCE |
889 | ($HOME/.systemtap/rc by default) before the normal argc/argv. This |
890 | may be useful to activate site options such as --use-server or | |
891 | --download-debuginfo or --modinfo. | |
892 | ||
893 | - The stap-server has seen many improvements, and is no longer considered | |
894 | experimental. | |
222e16ed | 895 | |
071de8a6 DB |
896 | - The stap-server service (initscript) now supports four new options: |
897 | -D MACRO[=VALUE] | |
e7148436 DB |
898 | --log LOGFILE |
899 | --port PORT-NUMBER | |
900 | --SSL CERT-DATABASE | |
071de8a6 DB |
901 | These allow the specification of macro definitions to be passed to stap |
902 | by the server, the location of the log file, network port number and | |
e7148436 DB |
903 | NSS certificate database location respectively. These options are also |
904 | supported within individual server configuration files. See stap-server | |
83bd2699 FCE |
905 | and initscript/README.stap-server for details. The stap-server is no |
906 | longer activated by default. | |
e7148436 | 907 | |
4bda987e SC |
908 | - process("PATH").[library("PATH")].function("NAME").exported probes are now |
909 | supported to filter function() to only exported instances. | |
910 | ||
f026be3f FCE |
911 | - The translator supports a new --suppress-handler-errors option, which |
912 | causes most runtime errors to be turned into quiet skipped probes. This | |
913 | also disables the MAXERRORS and MAXSKIPPED limits. | |
914 | ||
83bd2699 FCE |
915 | - Translator warnings have been standardized and controlled by the -w / -W |
916 | flags. | |
917 | ||
633e5ca7 FCE |
918 | - The translator supports a new --modinfo NAME=VALUE option to emit additional |
919 | MODULE_INFO(n,v) macros into the generated code. | |
920 | ||
c2537ee6 MW |
921 | - There is no more fixed maximum number of VMA pages that will be tracked |
922 | at runtime. This reduces memory use for those scripts that don't need any, | |
923 | or only limited target process VMA tracking and allows easier system | |
924 | wide probes inspecting shared library variables and/or user backtraces. | |
925 | stap will now silently ignore -DTASK_FINDER_VMA_ENTRY_ITEMS. | |
926 | ||
9c910acd FCE |
927 | - The tapset functions remote_id() and remote_uri() identify the member of a |
928 | swarm of "stap --remote FOO --remote BAR baz.stp" concurrent executions. | |
929 | ||
494582b7 DB |
930 | - Systemtap now supports a new privilege level and group, "stapsys", which |
931 | is equivalent to the privilege afforded by membership in the group "stapdev", | |
932 | except that guru mode (-g) functionality may not be used. To support this, a | |
933 | new option, --privilege=[stapusr|stapsys|stapdev] has been added. | |
934 | --privilege=stapusr is equivalent to specifying the existing --unprivileged | |
935 | option. --privilege=stapdev is the default. See man stap(1) for details. | |
936 | ||
01a7cf86 FCE |
937 | - Scripts that use kernel.trace("...") probes compile much faster. |
938 | ||
83bd2699 FCE |
939 | - The systemtap module cache is cleaned less frequently, governed by the |
940 | number of seconds in the $SYSTEMTAP_DIR/cache/cache_clean_interval_s file. | |
941 | ||
88e39987 JS |
942 | - SDT can now define up to 12 arguments in a probe point. |
943 | ||
f1ca50cd FCE |
944 | - Parse errors no longer generate a cascade of false errors. Instead, a |
945 | parse error skips the rest of the current probe or function, and resumes | |
946 | at the next one. This should generate fewer and better messages. | |
947 | ||
b4520557 CM |
948 | - Global array wrapping is now supported for both associative and statistics typed |
949 | arrays using the '%' character to signify a wrapped array. For example, | |
950 | 'global foo%[100]' would allow the array 'foo' to be wrapped if more than 100 | |
951 | elements are inserted. | |
952 | ||
4bda987e SC |
953 | - process("PATH").library("PATH").plt("NAME") probes are now supported. |
954 | Wildcards are supported in the plt-name part, to refer to any function in the | |
955 | program linkage table which matches the glob pattern and the rest of the | |
956 | probe point. | |
4d0fcb93 | 957 | |
b82d77b4 DB |
958 | - A new option, --dump-probe-types, will dump a list of supported probe types. |
959 | If --unprivileged is also specified, the list will be limited to probe types | |
960 | which are available to unprivileged users. | |
961 | ||
d70b339b CM |
962 | - Systemtap can now automatically download the required debuginfo |
963 | using abrt. The --download-debuginfo[=OPTION] can be used to | |
964 | control this feature. Possible values are: 'yes', 'no', 'ask', | |
965 | and a positive number representing the timeout desired. The | |
966 | default behavior is to not automatically download the debuginfo. | |
967 | ||
83bd2699 FCE |
968 | - The translator has better support for probing C++ applications by |
969 | better undertanding of compilation units, nested types, templates, | |
970 | as used in probe point and @cast constructs. | |
971 | ||
70e85f76 FCE |
972 | - On 2.6.29+ kernels, systemtap can now probe kernel modules that |
973 | arrive and/or depart during the run-time of a session. This allows | |
83bd2699 | 974 | probing of device driver initialization functions, which had formerly been |
70e85f76 FCE |
975 | blacklisted. |
976 | ||
83bd2699 FCE |
977 | - New tapset functions for cpu_clock and local_clock access were added. |
978 | ||
979 | - There is some limited preliminary support for user-space probing | |
2f295355 | 980 | against kernels such as linux-next, which have no utrace but do have |
83bd2699 FCE |
981 | the newer inode-uprobes work by Srikar Dronamraju and colleagues. |
982 | ||
6dd0e124 FCE |
983 | - The following probe types are deprecated in release 1.7 and will be |
984 | removed in release 1.8: | |
440d9b00 DB |
985 | kernel.function(number).inline |
986 | module(string).function(number).inline | |
987 | process.function(number).inline | |
988 | process.library(string).function(number).inline | |
989 | process(string).function(number).inline | |
990 | process(string).library(string).function(number).inline | |
991 | ||
6dd0e124 FCE |
992 | - The systemtap-grapher is deprecated in release 1.7 and will be removed in |
993 | release 1.8. | |
994 | ||
af3e4f87 MW |
995 | - The task_backtrace() tapset function was deprecated in 1.6 and has been |
996 | removed in 1.7. | |
997 | ||
998 | - MAXBACKTRACE did work in earlier releases, but has now been documented | |
999 | in the stap 1 manual page. | |
1000 | ||
1001 | - New tapset function probe_type(). Returns a short string describing | |
1002 | the low level probe handler type for the current probe point. | |
1003 | ||
1004 | - Both unwind and symbol data is now only collected and emitted for | |
1005 | scripts actually using backtracing or function/data symbols. | |
1006 | Tapset functions are marked with /* pragma:symbols */ or | |
1007 | /* pragma:unwind */ to indicate they need the specific data. | |
1008 | ||
1009 | - Kernel backtraces can now be generated for non-pt_regs probe context | |
1010 | if the kernel support dump_trace(). This enables backtraces from | |
1011 | certain timer probes and tracepoints. | |
1012 | ||
1013 | - ubacktrace() should now also work for some kernel probes on x86 which can | |
1014 | use the dwarf unwinder to recover the user registers to provide | |
1015 | more accurate user backtraces. | |
1016 | ||
1017 | - For s390x the systemtap runtime now properly splits kernel and user | |
1018 | addresses (which are in separate address spaces on that architecture) | |
1019 | which enable user space introspection. | |
1020 | ||
1021 | - ppc and s390x now supports user backtraces through the DWARF unwinder. | |
1022 | ||
1023 | - ppc now handles function descriptors as symbol names correctly. | |
1024 | ||
1025 | - arm support kernel backtraces through the DWARF unwinder. | |
1026 | ||
1027 | - arm now have a uprobes port which enables user probes. This still | |
1028 | requires some kernel patches (user_regsets and tracehook support for | |
1029 | arm). | |
1030 | ||
9369982e DS |
1031 | - Starting in release 1.7, these old variables will be deprecated: |
1032 | - The 'pid' variable in the 'kprocess.release' probe has been | |
1033 | deprecated in favor of the new 'released_pid' variable. | |
1034 | - The 'args' variable in the | |
1035 | '_sunrpc.clnt.create_client.rpc_new_client_inline' probe has been | |
1036 | deprecated in favor of the new internal-only '__args' variable. | |
2cf25147 | 1037 | |
567f504d DS |
1038 | - Experimental support for recent kernels without utrace has been |
1039 | added for the following probe types: | |
1040 | ||
1041 | process(PID).begin | |
1042 | process("PATH").begin | |
1043 | process.begin | |
1044 | process(PID).thread.begin | |
1045 | process("PATH").thread.begin | |
1046 | process.thread.begin | |
1047 | process(PID).end | |
1048 | process("PATH").end | |
1049 | process.end | |
1050 | process(PID).thread.end | |
1051 | process("PATH").thread.end | |
1052 | process.thread.end | |
1053 | process(PID).syscall | |
1054 | process("PATH").syscall | |
1055 | process.syscall | |
1056 | process(PID).syscall.return | |
1057 | process("PATH").syscall.return | |
1058 | process.syscall.return | |
1059 | ||
83bd2699 FCE |
1060 | - staprun disables kprobe-optimizations in recent kernels, as problems |
1061 | were found. (PR13193) | |
1062 | ||
a7ebbe13 | 1063 | * What's new in version 1.6, 2011-07-25 |
358771db | 1064 | |
304d73b1 FCE |
1065 | - Security fixes for CVE-2011-2503: read instead of mmap to load modules, |
1066 | CVE-2011-2502: Don't allow path-based auth for uprobes | |
1067 | ||
5b314cd0 DB |
1068 | - The systemtap compile-server no longer uses the -k option when calling the |
1069 | translator (stap). As a result, the server will now take advantage of the | |
1070 | module cache when compiling the same script more than once. You may observe | |
1071 | an improvement in the performance of the server in this situation. | |
1072 | ||
1073 | - The systemtap compile-server and client now each check the version of the | |
1074 | other, allowing both to adapt when communicating with a down-level | |
1075 | counterpart. As a result, all version of the client can communicate | |
1076 | with all versions of the server and vice-versa. Client will prefer newer | |
1077 | servers when selecting a server automatically. | |
1078 | ||
fb12b1e0 WC |
1079 | - SystemTap has improved support for the ARM architecture. The |
1080 | kread() and kwrite() operations for ARM were corrected allowing many | |
1081 | of the tapsets probes and function to work properly on the ARM | |
1082 | architecture. | |
1083 | ||
0497872a CM |
1084 | - Staprun can now rename the module to a unique name with the '-R' option before |
1085 | inserting it. Systemtap itself will also call staprun with '-R' by default. | |
1086 | This allows the same module to be inserted more than once, without conflicting | |
1087 | duplicate names. | |
1088 | ||
abc330b6 LB |
1089 | - Systemtap error messages now provide feedback when staprun or any other |
1090 | process fails to launch. This also specifically covers when the user | |
1091 | doesn't have the proper permissions to launch staprun. | |
1092 | ||
c523a015 LB |
1093 | - Systemtap will now map - to _ in module names. Previously, |
1094 | stap -L 'module("i2c-core").function("*")' would be empty. It now returns | |
1095 | a list had stap -L 'module("i2c_core").function("*") been specified. | |
1096 | ||
ee3fbc52 FCE |
1097 | - Systemtap now fills in missing process names to probe points, to |
1098 | avoid having to name them twice twice: | |
1099 | % stap -e 'probe process("a.out").function("*") {}' -c 'a.out ...' | |
1100 | Now the probed process name is inferred from the -c CMD argument. | |
1101 | % stap -e 'probe process.function("*") {}' -c 'a.out ...' | |
6d5d594e | 1102 | |
5a195cd5 LB |
1103 | - stap -L 'process("PATH").syscall' will now list context variables |
1104 | ||
e050d62f MW |
1105 | - Depends on elfutils 0.142+. |
1106 | ||
20ab10df MW |
1107 | - Deprecated task_backtrace:string (task:long). This function will go |
1108 | away after 1.6. Please run your scripts with stap --check-version. | |
1109 | ||
a64d8b13 | 1110 | * What's new in version 1.5, 2011-05-23 |
5dbcdbd6 | 1111 | |
304d73b1 FCE |
1112 | - Security fixes for CVE-2011-1781, CVE-2011-1769: correct DW_OP_{mod,div} |
1113 | division-by-zero bug | |
1114 | ||
5dbcdbd6 DB |
1115 | - The compile server and its related tools (stap-gen-ert, stap-authorize-cert, |
1116 | stap-sign-module) have been re-implemented in C++. Previously, these | |
1117 | components were a mix of bash scripts and C code. These changes should be | |
1118 | transparent to the end user with the exception of NSS certificate database | |
1119 | password prompting (see below). The old implementation would prompt more | |
1120 | than once for the same password in some situations. | |
1121 | ||
eb521ae6 LB |
1122 | - eventcount.stp now allows for event counting in the format of |
1123 | 'stap eventcount.stp process.end syscall.* ...', and also reports | |
1124 | corresponding event tid's. | |
6e0c15da | 1125 | |
d1d13a8b SC |
1126 | - Systemtap checks that the build-id of the module being probed matches the |
1127 | build-id saved in the systemtap module. Invoking systemtap with | |
1128 | -DSTP_NO_BUILDID_CHECK will bypass this build-id runtime verification. See | |
1129 | man ld(1) for info on --build-id. | |
1130 | ||
276c6712 LB |
1131 | - stapio will now report if a child process has an abnormal exit along with |
1132 | the associated status or signal. | |
1133 | ||
710a2a45 SC |
1134 | - Compiler optimization may sometimes result in systemtap not being able to |
1135 | access a user-space probe argument. Compiling the application with | |
1136 | -DSTAP_SDT_ARG_CONSTRAINT=nr will force the argument to be an immediate or | |
1137 | register value which should enable systemtap to access the argument. | |
1138 | ||
2a990836 LB |
1139 | - GNU Gettext has now been intergrated with systemtap. Our translation |
1140 | page can be found at http://www.transifex.net/projects/p/systemtap/ . | |
1141 | "make update-po" will generate the necessary files to use translated | |
1142 | messages. Please refer to the po/README file for more info and | |
1143 | please consider contributing to this I18N effort! | |
1144 | ||
bf8e91d0 JS |
1145 | - The new addr() function returns the probe's instruction pointer. |
1146 | ||
b73a1293 SC |
1147 | - process("...").library("...") probes are now supported. Wildcards |
1148 | are supported in the library-name part, to refer to any shared | |
1149 | library that is required by process-name, which matches the glob | |
1150 | pattern and the rest of the probe point. | |
1151 | ||
b9d64db6 JS |
1152 | - The "--remote USER@HOST" functionality can now be specified multiple times |
1153 | to fan out on multiple targets. If the targets have distinct kernel and | |
1154 | architecture configurations, stap will automatically build the script | |
1155 | appropriately for each one. This option is also no longer considered | |
1156 | experimental. | |
1157 | ||
e96e9380 DB |
1158 | - The NSS certificate database generated for use by the compile server is now |
1159 | generated with no password. Previously, a random password was generated and | |
1160 | used to access the database. This change should be transparent to most users. | |
1161 | However, if you are prompted for a password when using systemtap, then | |
1162 | running $libexecdir/stap-gen-cert should correct the problem. | |
1163 | ||
798cba32 FCE |
1164 | - The timestamp tapset includes jiffies() and HZ() for lightweight approximate |
1165 | timekeeping. | |
1166 | ||
4ce43c59 FCE |
1167 | - A powerful new command line option --version has been added. |
1168 | ||
c2807b0b SC |
1169 | - process.mark now supports $$parms for reading probe parameters. |
1170 | ||
cc28ec4f FCE |
1171 | - A new command line option, --use-server-on-error[=yes|no] is available |
1172 | for stap. It instructs stap to retry compilation of a script using a | |
1173 | compile server if it fails on the local host. The default setting | |
1174 | is 'no'. | |
ce286ff0 | 1175 | |
1114c4f2 DB |
1176 | - The following deprecated tools have been removed: |
1177 | stap-client | |
1178 | stap-authorize-server-cert | |
1179 | stap-authorize-signing-cert | |
1180 | stap-find-or-start-server | |
1181 | stap-find-servers | |
1182 | Use the --use-server, --trust-server and --list-servers options of stap | |
cc28ec4f | 1183 | instead. |
6e0c15da | 1184 | |
c36cb86a | 1185 | * What's new in version 1.4, 2011-01-17 |
051bc1a0 | 1186 | |
304d73b1 FCE |
1187 | - Security fixes for CVE-2010-4170, CVE-2010-4171: staprun module |
1188 | loading/unloading | |
1189 | ||
02f44009 DB |
1190 | - A new /* myproc-unprivileged */ marker is now available for embedded C |
1191 | code and and expressions. Like the /* unprivileged */ marker, it makes | |
1192 | the code or expression available for use in unprivileged mode (see | |
1193 | --unprivileged). However, it also automatically adds a call to | |
1194 | assert_is_myproc() to the code or expression, thus, making it available | |
1195 | to the unprivileged user only if the target of the current probe is within | |
1196 | the user's own process. | |
1197 | ||
e37d61db FCE |
1198 | - The experimental "--remote USER@HOST" option will run pass 5 on a given |
1199 | ssh host, after building locally (or with --use-server) for that target. | |
6eb5c1a1 | 1200 | |
8358a79c FCE |
1201 | - Warning messages from the script may now be suppressed with the stap |
1202 | and/or staprun -w option. By default, duplicate warning messages are | |
1203 | suppressed (up to a certain limit). With stap --vp 00002 and above, | |
1204 | the duplicate elimination is defeated. | |
1205 | ||
35f71b69 FCE |
1206 | - The print_ubacktrace and usym* functions attempt to print the full |
1207 | path of the user-space binaries' paths, instead of just the basename. | |
1208 | The maximum saved path length is set by -DTASK_FINDER_VMA_ENTRY_PATHLEN, | |
121d2e8f FCE |
1209 | default 64. Warning messages are produced if unwinding fails due to |
1210 | a missing 'stap -d MODULE' option, providing preloaded unwind data. | |
35f71b69 | 1211 | |
d62c7736 FCE |
1212 | - The new tz_ctime() tapset function prints times in the local time zone. |
1213 | ||
685087ea FCE |
1214 | - More kernel tracepoints are accessible to the kernel.trace("...") mechanism, |
1215 | if kernel source trees or debuginfo are available. These formerly "hidden" | |
1216 | tracepoints are those that are declared somewhere other than the usual | |
1217 | include/linux/trace/ headers, such as xfs and kvm. | |
1218 | ||
c480f651 FCE |
1219 | - debuginfo-based process("...").function/.statement/.mark probes support |
1220 | wildcards in the process-name part, to refer to any executable files that | |
1221 | match the glob pattern and the rest of the probe point. | |
c3c5e2eb | 1222 | |
a1e3433a LB |
1223 | - The -t option now displays information per probe-point rather than a summary |
1224 | for each probe. It also now shows the derivation chain for each probe-point. | |
d1eef011 | 1225 | |
6a46f4fb FCE |
1226 | - A rewrite of the sys/sdt.h header file provides zero-cost startup (few or |
1227 | no ELF relocations) for the debuginfo-less near-zero-cost runtime probes. | |
1228 | Binaries compiled with earlier sdt.h versions remain supported. The | |
1229 | stap -L (listing) option now lists parameters for sys/sdt.h markers. | |
1230 | ||
0dd4c6e7 DB |
1231 | - The implementation of the integrated compile-server client has been |
1232 | extended. | |
0dd4c6e7 DB |
1233 | o --use-server now accepts an argument representing a particular server and |
1234 | may be specified more than once. | |
1235 | o --list-servers now accepts an expanded range of arguments. | |
c3c5e2eb FCE |
1236 | o a new --trust-servers option has been added to stap to replace several |
1237 | old certificate-management scripts. | |
219868f8 DB |
1238 | o The following tools are now deprecated and will be removed in release 1.5: |
1239 | stap-client | |
1240 | stap-authorize-server-cert | |
1241 | stap-authorize-signing-cert | |
1242 | stap-find-or-start-server | |
1243 | stap-find-servers | |
1244 | See man stap(1) for complete details. | |
1245 | ||
1246 | - The compile-server now returns the uprobes.ko to the client when it is | |
1247 | required by the script being compiled. The integrated compile-server client | |
1248 | now makes it available to be loaded by staprun. The old (deprecated) | |
1249 | stap-client does not do this. | |
0dd4c6e7 | 1250 | |
d1bcbe71 RH |
1251 | - process probes with scripts as the target are recognized by stap and the |
1252 | interpreter would be selected for probing. | |
1253 | ||
8dc503b6 FCE |
1254 | - Starting in release 1.5, these old variables/functions will be deprecated |
1255 | and will only be available when the '--compatible=1.4' flag is used: | |
1256 | ||
d1eef011 DS |
1257 | - In the 'syscall.add_key' probe, the 'description_auddr' variable |
1258 | has been deprecated in favor of the new 'description_uaddr' | |
1259 | variable. | |
1260 | - In the 'syscall.fgetxattr', 'syscall.fsetxattr', | |
1261 | 'syscall.getxattr', 'syscall.lgetxattr', and | |
1262 | 'syscall.lremovexattr' probes, the 'name2' variable has been | |
1263 | deprecated in favor of the new 'name_str' variable. | |
89e2abb1 DS |
1264 | - In the 'nd_syscall.accept' probe the 'flag_str' variable |
1265 | has been deprecated in favor of the new 'flags_str' variable. | |
1266 | - In the 'nd_syscall.dup' probe the 'old_fd' variable has been | |
1267 | deprecated in favor of the new 'oldfd' variable. | |
1268 | - In the 'nd_syscall.fgetxattr', 'nd_syscall.fremovexattr', | |
1269 | 'nd_syscall.fsetxattr', 'nd_syscall.getxattr', and | |
1270 | 'nd_syscall.lremovexattr' probes, the 'name2' variable has been | |
1271 | deprecated in favor of the new 'name_str' variable. | |
8dc503b6 FCE |
1272 | - The tapset alias 'nd_syscall.compat_pselect7a' was misnamed. It should |
1273 | have been 'nd_syscall.compat_pselect7' (without the trailing 'a'). | |
1274 | - The tapset function 'cpuid' is deprecated in favor of the better known | |
1275 | 'cpu'. | |
b149489c DS |
1276 | - In the i386 'syscall.sigaltstack' probe, the 'ussp' variable has |
1277 | been deprecated in favor of the new 'uss_uaddr' variable. | |
1278 | - In the ia64 'syscall.sigaltstack' probe, the 'ss_uaddr' and | |
1279 | 'oss_uaddr' variables have been deprecated in favor of the new | |
1280 | 'uss_uaddr' and 'uoss_uaddr' variables. | |
1281 | - The powerpc tapset alias 'syscall.compat_sysctl' was deprecated | |
1282 | and renamed 'syscall.sysctl32'. | |
1283 | - In the x86_64 'syscall.sigaltstack' probe, the 'regs_uaddr' | |
1284 | variable has been deprecated in favor of the new 'regs' variable. | |
89e2abb1 | 1285 | |
4432f146 | 1286 | * What's new in version 1.3, 2010-07-21 |
649260f3 | 1287 | |
c9b524b2 JS |
1288 | - The uprobes kernel module now has about half the overhead when probing |
1289 | NOPs, which is particularly relevant for sdt.h markers. | |
1290 | ||
866b7fea FCE |
1291 | - New stap option -G VAR=VALUE allows overriding global variables |
1292 | by passing the settings to staprun as module options. | |
bb25d08f | 1293 | |
b352f4b0 DS |
1294 | - The tapset alias 'syscall.compat_pselect7a' was misnamed. It should |
1295 | have been 'syscall.compat_pselect7' (without the trailing 'a'). | |
70032df1 DS |
1296 | Starting in release 1.4, the old name will be deprecated and |
1297 | will only be available when the '--compatible=1.3' flag is used. | |
b352f4b0 | 1298 | |
279aece5 FCE |
1299 | - A new procfs parameter .umask(UMASK) which provides modification of |
1300 | file permissions using the proper umask value. Default file | |
1301 | permissions for a read probe are 0400, 0200 for a write probe, and | |
1302 | 0600 for a file with a read and write probe. | |
1303 | ||
49db4869 MW |
1304 | - It is now possible in some situations to use print_ubacktrace() to |
1305 | get a user space stack trace from a kernel probe point. e.g. for | |
1306 | user backtraces when there is a pagefault: | |
1307 | $ stap -d /bin/sort --ldd -e 'probe vm.pagefault { | |
1308 | if (pid() == target()) { | |
1309 | printf("pagefault @0x%x\n", address); print_ubacktrace(); | |
1310 | } }' -c /bin/sort | |
1311 | [...] | |
1312 | pagefault @0x7fea0595fa70 | |
1313 | 0x000000384f07f958 : __GI_strcmp+0x12b8/0x1440 [libc-2.12.so] | |
1314 | 0x000000384f02824e : __gconv_lookup_cache+0xee/0x5a0 [libc-2.12.so] | |
1315 | 0x000000384f021092 : __gconv_find_transform+0x92/0x2cf [libc-2.12.so] | |
1316 | 0x000000384f094896 : __wcsmbs_load_conv+0x106/0x2b0 [libc-2.12.so] | |
1317 | 0x000000384f08bd90 : mbrtowc+0x1b0/0x1c0 [libc-2.12.so] | |
1318 | 0x0000000000404199 : ismbblank+0x39/0x90 [sort] | |
1319 | 0x0000000000404a4f : inittables_mb+0xef/0x290 [sort] | |
1320 | 0x0000000000406934 : main+0x174/0x2510 [sort] | |
1321 | 0x000000384f01ec5d : __libc_start_main+0xfd/0x1d0 [libc-2.12.so] | |
1322 | 0x0000000000402509 : _start+0x29/0x2c [sort] | |
1323 | [...] | |
1324 | ||
1325 | - New tapset functions to get a string representation of a stack trace: | |
1326 | sprint_[u]backtrace() and sprint_[u]stack(). | |
1327 | ||
1328 | - New tapset function to get the module (shared library) name for a | |
1329 | user space address umodname:string(long). The module name will now | |
1330 | also be in the output of usymdata() and in backtrace addresses even | |
1331 | when they were not given with -d at the command line. | |
1332 | ||
1333 | - Kernel backtraces are now much faster (replaced a linear search | |
1334 | with a binary search). | |
1335 | ||
eb3a0eee | 1336 | - A new integrated compile-server client is now available as part of stap. |
1e7630bf | 1337 | |
eb3a0eee DB |
1338 | o 'stap --use-server ...' is equivalent to 'stap-client ...' |
1339 | o 'stap --list-servers' is equivalent to 'stap-find-servers' | |
1340 | o 'stap --list-servers=online' is equivalent to 'stap-find-servers --all' | |
1e7630bf DB |
1341 | o stap-client and its related tools will soon be deprecated. |
1342 | o the nss-devel and avahi-devel packages are required for building stap with | |
1343 | the integrated client (checked during configuration). | |
1344 | o nss and avahi are required to run the integrated client. | |
1345 | ||
8cc799a5 JS |
1346 | - A new operator @entry is available for automatically saving an expression |
1347 | at entry time for use in a .return probe. | |
1348 | probe foo.return { println(get_cycles() - @entry(get_cycles())) } | |
1349 | ||
34af38db JS |
1350 | - Probe $target variables and @cast() can now use a suffix to print complex |
1351 | data types as strings. Use a single '$' for a shallow view, or '$$' for a | |
1352 | deeper view that includes nested types. For example, with fs_struct: | |
1353 | $fs$ : "{.users=%i, .lock={...}, .umask=%i, | |
1354 | .in_exec=%i, .root={...}, .pwd={...}}" | |
1355 | $fs$$ : "{.users=%i, .lock={.raw_lock={.lock=%u}}, .umask=%i, .in_exec=%i, | |
1356 | .root={.mnt=%p, .dentry=%p}, .pwd={.mnt=%p, .dentry=%p}}" | |
1357 | ||
a794dbeb FCE |
1358 | - The <sys/sdt.h> user-space markers no longer default to an implicit |
1359 | MARKER_NAME_ENABLED() semaphore check for each marker. To check for | |
1360 | enabled markers use a .d declaration file, then: | |
1361 | if (MARKER_NAME_ENABLED()) MARKER_NAME() | |
954b1d89 | 1362 | |
ef428667 FCE |
1363 | - Hyphenated <sys/sdt.h> marker names such as process(...).mark("foo-bar") |
1364 | are now accepted in scripts. They are mapped to the double-underscore | |
1365 | form ("foo__bar"). | |
1366 | ||
279aece5 FCE |
1367 | - More robust <sys/sdt.h> user-space markers support is included. For |
1368 | some platforms (x86*, ppc*), this can let systemtap probe the markers | |
1369 | without debuginfo. This implementation also supports preserving | |
a794dbeb FCE |
1370 | the "provider" name associated with a marker: |
1371 | probe process("foo").provider("bar").mark("baz") to match | |
1372 | STAP_PROBE<n>(bar, baz <...>) | |
279aece5 FCE |
1373 | (Compile with -DSTAP_SDT_V1 to revert to the previous implementation. |
1374 | Systemtap supports pre-existing or new binaries using them.) | |
f83336a5 | 1375 | |
7d902887 FCE |
1376 | - Embedded-C may be used within expressions as values, when in guru mode: |
1377 | num = %{ LINUX_VERSION_CODE %} // int64_t | |
1378 | name = %{ /* string */ THIS_MODULE->name %} // const char* | |
1379 | printf ("%s %x\n", name, num) | |
1380 | The usual /* pure */, /* unprivileged */, and /* guru */ markers may be used | |
1381 | as with embedded-C functions. | |
1382 | ||
38105915 | 1383 | - By default the systemtap-runtime RPM builds now include a shared |
114fbea7 | 1384 | library, staplog.so, that allows crash to extract systemtap data from |
38105915 WC |
1385 | a vmcore image. |
1386 | ||
9747ca47 JS |
1387 | - Iterating with "foreach" can now explicitly save the value for the loop. |
1388 | foreach(v = [i,j] in array) | |
1389 | printf("array[%d,%s] = %d\n", i, j, v /* array[i,j] */) | |
1390 | ||
ef06c938 FCE |
1391 | - The new "--ldd" option automatically adds any additional shared |
1392 | libraries needed by probed or -d-listed userspace binaries to the -d | |
e19ae9a8 FCE |
1393 | list, to enable symbolic backtracing through them. Similarly, the |
1394 | new "--all-modules" option automatically adds any currently loaded | |
1395 | kernel modules (listed in /proc/modules) to the -d list. | |
ef06c938 | 1396 | |
b2c904c0 JS |
1397 | - A new family of set_kernel_* functions make it easier for gurus to write |
1398 | new values at arbitrary memory addresses. | |
1399 | ||
649260f3 JS |
1400 | - Probe wildcards can now use '**' to cross the '.' separator. |
1401 | $ stap -l 'sys**open' | |
1402 | syscall.mq_open | |
1403 | syscall.open | |
1404 | ||
13c4a0b0 FCE |
1405 | - Backward compatibility flags (--compatible=VERSION, and matching |
1406 | script preprocessing predicate %( systemtap_v CMP "version" %) | |
1407 | and a deprecation policy are being introduced, in case future | |
1408 | tapset/language changes break valid scripts. | |
1409 | ||
4432f146 | 1410 | * What's new in version 1.2, 2010-03-22 |
489e3d51 | 1411 | |
f33e9151 FCE |
1412 | - Prototype support for "perf events", where the kernel supports the |
1413 | 2.6.33 in-kernel API. Probe points may refer to low-level | |
1414 | perf_event_attr type/config numbers, or to a number of aliases | |
1415 | defined in the new perf.stp tapset: | |
1416 | probe perf.sw.cpu_clock, perf.type(0).config(4) { } | |
1417 | ||
da9e11bd JS |
1418 | - Type-casting can now use multiple headers to resolve codependencies. |
1419 | @cast(task, "task_struct", | |
1420 | "kernel<linux/sched.h><linux/fs_struct.h>")->fs->umask | |
1421 | ||
9039b639 FCE |
1422 | - Tapset-related man pages have been renamed. 'man -k 3stap' should show |
1423 | the installed list, which due to prefixing should no longer collide over | |
1424 | ordinary system functions. | |
1425 | ||
985adad3 | 1426 | - User space marker arguments no longer use volatile if the version of gcc, |
03a74626 | 1427 | which must be at least 4.5.0, supports richer DWARF debuginfo. Use cflags |
87d85b96 FCE |
1428 | -DSTAP_SDT_VOLATILE=volatile or -DSTAP_SDT_VOLATILE= when building |
1429 | the sys/sdt.h application to override this one way or another. | |
103c7c8d | 1430 | |
f4fe2e93 FCE |
1431 | - A new construct for error handling is available. It is similar to c++ |
1432 | exception catching, using try and catch as new keywords. Within a handler | |
1433 | or function, the following is valid and may be nested: | |
1434 | try { /* arbitrary statements */ } | |
1435 | catch (er) { /* e.g. println("caught error ", er) */ } | |
1436 | ||
57a56e00 FCE |
1437 | - A new command line flag '-W' forces systemtap to abort translation of |
1438 | a script if any warnings are produced. It is similar to gcc's -Werror. | |
1439 | (If '-w' is also supplied to suppress warnings, it wins.) | |
1440 | ||
30263a73 FCE |
1441 | - A new predicate @defined is available for testing whether a |
1442 | particular $variable/expression is resolvable at translate time: | |
1443 | probe foo { if (@defined($bar)) log ("$bar is available here") } | |
1444 | ||
489e3d51 FCE |
1445 | - Adjacent string literals are glued together, making this |
1446 | construct valid: | |
1447 | probe process("/usr" @1 "/bin").function("*") { ... } | |
1448 | ||
15b2e969 FCE |
1449 | - In order to limit potential impact from future security problems, |
1450 | the stap-server process does not permit its being launched as root. | |
1451 | ||
489e3d51 FCE |
1452 | - On recent kernels, for some architectures/configurations, hardware |
1453 | breakpoint probes are supported. The probe point syntax is: | |
1454 | ||
1455 | probe kernel.data(ADDRESS).write | |
1456 | probe kernel.data(ADDRESS).length(LEN).write | |
1457 | probe kernel.data("SYMBOL_NAME").write | |
dd225250 | 1458 | |
4432f146 | 1459 | * What's new in version 1.1, 2010-01-15 |
450718c9 | 1460 | |
d5d6f6f1 RD |
1461 | - New tracepoint based tapset for memory subsystem. |
1462 | ||
bcdf36b1 FCE |
1463 | - The loading of signed modules by staprun is no longer allowed for |
1464 | ordinary, unprivileged users. This means that only root, members of | |
de23650e | 1465 | the group 'stapdev' and members of the group 'stapusr' can load |
bcdf36b1 FCE |
1466 | systemtap modules using staprun, stap or stap-client. The minimum |
1467 | privilege required to run arbitrary --unprivileged scripts is now | |
de23650e | 1468 | 'stapusr' membership. |
bcdf36b1 FCE |
1469 | |
1470 | - The stap-server initscript is available. This initscript allows you | |
1471 | to start systemtap compile servers as a system service and to manage | |
1472 | these servers as a group or individually. The stap-server initscript | |
1473 | is installed by the systemtap-server rpm. The build directory for | |
1474 | the uprobes module (/usr/share/systemtap/runtime/uprobes) is made | |
1475 | writable by the 'stap-server' group. All of the files generated when | |
1476 | building the uprobes module, including the digital signature, are | |
1477 | also writable by members of stap-server. | |
d2c9f522 | 1478 | |
5807ac64 DB |
1479 | See initscript/README.stap-server for details. |
1480 | ||
b515db67 WH |
1481 | - Some of the compile server client, server and certificate management |
1482 | tools have been moved from $bindir to $libexecdir/systemtap. | |
0f4e0b6f DB |
1483 | You should use the new stap-server script or the stap-server initscript |
1484 | for server management where possible. The stap-server script provides the same | |
1485 | functionality as the stap-server initscript except that the servers are | |
1486 | run by the invoking user by default as opposed to servers started by the | |
1487 | stap-server initscript which are run by the user stap-server | |
1488 | by default. See stap-server(8) for more information. | |
1489 | ||
1490 | You may continue to use these tools by adding $libexecdir/systemtap to | |
1491 | your path. You would need to do this, for example, if you are not root, | |
1492 | you want to start a compile server and you are not running systemtap from a | |
1493 | private installation. In this case you still need to use stap-start-server. | |
1494 | ||
0710d850 DS |
1495 | - Any diagnostic output line that starts with "ERROR", as in |
1496 | error("foo"), will promote a "Pass 5: run failed", and the return | |
1497 | code is 1. | |
b49f69f3 | 1498 | |
2e526dab FCE |
1499 | - Systemtap now warns about global variables being referenced from other |
1500 | script files. This aims to protect against unintended local-vs-global | |
1501 | namespace collisions such as: | |
1502 | ||
1503 | % cat some_tapset.stp | |
1504 | probe baz.one = bar { foo = $foo; bar = $bar } | |
1505 | % cat end_user_script.stp | |
1506 | global foo # intended to be private variable | |
1507 | probe timer.s(1) { foo ++ } | |
1508 | probe baz.* { println(foo, pp()) } | |
1509 | % stap end_user_script.stp | |
1510 | WARNING: cross-file global variable reference to foo from some_tapset.stp | |
1511 | ||
561079c8 FCE |
1512 | - Preprocessor conditional for kernel configuration testing: |
1513 | %( CONFIG_foo == "y" %? ... %) | |
1514 | ||
450718c9 FCE |
1515 | - ftrace(msg:string) tapset function to send strings to the system-wide |
1516 | ftrace ring-buffer (if any). | |
1517 | ||
6e2d1162 MW |
1518 | - Better support for richer DWARF debuginfo output from GCC 4.5 |
1519 | (variable tracking assignments). Kernel modules are now always resolved | |
1520 | against all their dependencies to find any info referring to missing | |
1521 | symbols. DW_AT_const_value is now supported when no DW_AT_location | |
1522 | is available. | |
1523 | ||
4432f146 | 1524 | * What's new in verson 1.0, 2009-09-22 |
f07c3b68 | 1525 | |
23c0a2b3 JS |
1526 | - process().mark() probes now use an enabling semaphore to reduce the |
1527 | computation overhead of dormant probes. | |
1528 | ||
bb2b3e3b JS |
1529 | - The function spec for dwarf probes now supports C++ scopes, so you can |
1530 | limit the probes to specific namespaces or classes. Multiple scopes | |
1531 | can be specified, and they will be matched progressively outward. | |
1532 | probe process("foo").function("std::vector<*>::*") { } | |
1533 | probe process("foo").function("::global_function") { } | |
1534 | ||
4b2cdd06 JS |
1535 | - It is now possible to cross-compile systemtap scripts for foreign |
1536 | architectures, using the new '-a ARCH' and '-B OPT=VALUE' flags. | |
1537 | For example, put arm-linux-gcc etc. into your $PATH, and point | |
1538 | systemtap at the target kernel build tree with: | |
1539 | stap -a arm -B CROSS_COMPILE=arm-linux- -r /build/tree [...] | |
1540 | The -B option is passed to kbuild make. -r identifies the already | |
1541 | configured/built kernel tree and -a its architecture (kbuild ARCH=...). | |
1542 | Systemtap will infer -p4. | |
1543 | ||
ba01c24c | 1544 | - Cross compilation using the systemtap client and server |
742b8971 JS |
1545 | - stap-start-server now accepts the -r, -R, -I, -B and -a options in |
1546 | order to start a cross compiling server. The server will correctly | |
1547 | advertise itself with respect to the kernel release and architecture | |
1548 | that it compiles for. | |
1549 | - When specified on stap-client, the -r and -a options will be | |
1550 | considered when searching for a suitable server. | |
ba01c24c | 1551 | |
742b8971 | 1552 | - When using the systemtap client and server udp port 5353 must be open |
de23650e | 1553 | in your firewall in order for the client to find servers using |
742b8971 JS |
1554 | avahi-browse. Also the systemtap server will choose a random port in |
1555 | the range 1024-63999 for accepting ssl connections. | |
902d0d67 | 1556 | |
500bc85c | 1557 | - Support for unprivileged users: |
f6efd18a MW |
1558 | *********************************************************************** |
1559 | * WARNING!!!!!!!!!! * | |
1560 | * This feature is EXPERIMENTAL at this time and should be used with * | |
1561 | * care. This feature allows systemtap kernel modules to be loaded by * | |
1562 | * unprivileged users. The user interface and restrictions will change * | |
1563 | * as this feature evolves. * | |
1564 | *********************************************************************** | |
742b8971 JS |
1565 | - Systemtap modules generated from scripts which use a restricted |
1566 | subset of the features available may be loaded by staprun for | |
1567 | unprivileged users. Previously, staprun would load modules only for | |
1568 | root or for members of the groups stapdev and stapusr. | |
f6efd18a MW |
1569 | - Using the --unprivileged option on stap enables translation-time |
1570 | checking for use by unprivileged users (see restrictions below). | |
1571 | - All modules deemed suitable for use by unprivileged users will be | |
ba01c24c | 1572 | signed by the systemtap server when --unprivileged is specified on |
742b8971 JS |
1573 | stap-client. See module signing in release 0.9.8 and stap-server in |
1574 | release 0.9 below. | |
f6efd18a MW |
1575 | - Modules signed by trusted signers (servers) and verified by staprun |
1576 | will be loaded by staprun regardless of the user's privilege level. | |
1577 | - The system administrator asserts the trustworthiness of a signer | |
1578 | (server) by running stap-authorize-signing-cert <cert-file> as root, | |
ba01c24c | 1579 | where the <cert-file> can be found in |
742b8971 JS |
1580 | ~<user>/.systemtap/ssl/server/stap.cert for servers started by |
1581 | ordinary users and in $sysconfdir/systemtap/ssl/server/stap.cert for | |
1582 | servers started by root. | |
1583 | - Restrictions are intentionally strict at this time and may be | |
1584 | relaxed in the future: | |
500bc85c | 1585 | - probe points are restricted to: |
20ab90b5 DB |
1586 | begin, begin(n), end, end(n), error, error(n), never, |
1587 | timer.{jiffies,s,sec,ms,msec,us,usec,ns,nsec}(n)*, timer.hz(n), | |
742b8971 | 1588 | process.* (for processes owned by the user). |
b232fab3 | 1589 | - use of embedded C code is not allowed. |
ba01c24c DB |
1590 | - use of tapset functions is restricted. |
1591 | - some tapset functions may not be used at all. A message will be | |
1592 | generated at module compilation time. | |
742b8971 JS |
1593 | - some actions by allowed tapset functions may only be performed |
1594 | in the context of the user's own process. A runtime fault will | |
1595 | occur in these situations, for example, direct memory access. | |
1596 | - The is_myproc() tapset function has been provided so that | |
1597 | tapset writers for unprivileged users can check that the | |
1598 | context is of the users own process before attempting these | |
1599 | actions. | |
500bc85c | 1600 | - accessing the kernel memory space is not allowed. |
ba01c24c DB |
1601 | - The following command line options may not be used by stap-client |
1602 | -g, -I, -D, -R, -B | |
1603 | - The following environment variables are ignored by stap-client: | |
500bc85c DB |
1604 | SYSTEMTAP_RUNTIME, SYSTEMTAP_TAPSET, SYSTEMTAP_DEBUGINFO_PATH |
1605 | - nss and nss-tools are required to use this feature. | |
1606 | ||
bc7cd435 MH |
1607 | - Support output file switching by SIGUSR2. Users can command running |
1608 | stapio to switch output file by sending SIGUSR2. | |
1609 | ||
8faf4a73 DB |
1610 | - Memory consumption for scripts involving many uprobes has been |
1611 | dramatically reduced. | |
1612 | ||
1613 | - The preprocessor now supports || and && in the conditions. | |
f6efd18a | 1614 | e.g. %( arch == "x86_64" || arch == "ia64" %: ... %) |
8faf4a73 | 1615 | |
8faf4a73 DB |
1616 | - The systemtap notion of "architecture" now matches the kernel's, rather |
1617 | than that of "uname -m". This means that 32-bit i386 family are all | |
1618 | known as "i386" rather than "i386" or "i686"; "ppc64" as "powerpc"; | |
1619 | "s390x" as "s390", and so on. This is consistent between the new | |
1620 | "-a ARCH" flag and the script-level %( arch ... %) conditional. | |
1621 | ||
1622 | - It is now possible to define multiple probe aliases with the same name. | |
1623 | A probe will expand to all matching aliases. | |
742b8971 JS |
1624 | probe foo = bar { } |
1625 | probe foo = baz { } | |
1626 | probe foo { } # expands twice, once to bar and once to baz | |
8faf4a73 | 1627 | |
96fb769c DS |
1628 | - A new experimental transport mechanism, using ftrace's ring_buffer, |
1629 | has been added. This may become the default transport mechanism in | |
1630 | future versions of systemtap. To test this new transport mechanism, | |
1631 | define 'STP_USE_RING_BUFFER'. | |
1632 | ||
f6efd18a MW |
1633 | - Support for recognizing DW_OP_{stack,implicit}_value DWARF expressions |
1634 | as emitted by GCC 4.5. | |
c61807d2 | 1635 | |
4432f146 | 1636 | * What's new in version 0.9.9, 2009-08-04 |
f07c3b68 FCE |
1637 | |
1638 | - Systemwide kernel .function.return (kretprobe) maxactive defaults may | |
1639 | be overridden with the -DKRETACTIVE=nnn parameter. | |
1640 | ||
76ff718a FCE |
1641 | - Translation pass 2 is significantly faster by avoiding unnecessary |
1642 | searching through a kernel build/module directory tree. | |
1643 | ||
230a1203 MW |
1644 | - When compiled against elfutils 0.142 systemtap now handles the new |
1645 | DW_OP_call_frame_CFA generated by by GCC. | |
1646 | ||
1647 | - uprobes and ustack() are more robust when used on applications that | |
1648 | depend on prelinked/separate debuginfo shared libraries. | |
1649 | ||
1650 | - User space PROBE marks are not always found with or without separate | |
1651 | debuginfo. The .probes section itself is now always put in the main | |
de23650e WH |
1652 | elf file and marked as allocated. When building pic code the section |
1653 | is marked writable. The selinux memory check problems seen with | |
1654 | programs using STAP_PROBES is fixed. | |
230a1203 MW |
1655 | |
1656 | - statement() probes can now override "address not at start of statement" | |
1657 | errors in guru mode. They also provide alternative addresses to use | |
1658 | in non-guru mode. | |
1659 | ||
da01fcc6 JS |
1660 | - The stapgraph application can generate graphs of data and events |
1661 | emitted by systemtap scripts in real time. Run "stapgraph | |
79bd71a1 TM |
1662 | testsuite/systemtap.examples/general/grapher.stp" for an example of |
1663 | graphing the system load average and keyboard events. | |
1664 | ||
da01fcc6 JS |
1665 | - Dwarf probes now show parameters and local variables in the verbose |
1666 | listing mode (-L). | |
1667 | ||
1668 | - Symbol aliases are now resolved to their canonical dwarf names. For | |
1669 | example, probing "malloc" in libc resolves to "__libc_malloc". | |
1670 | ||
1671 | - The syntax for dereferencing $target variables and @cast() gained new | |
1672 | capabilities: | |
1673 | - Array indexes can now be arbitrary numeric expressions. | |
1674 | - Array subscripts are now supported on pointer types. | |
1675 | - An '&' operator before a @cast or $target returns the address of the | |
1676 | final component, especially useful for nested structures. | |
1677 | ||
1678 | - For reading all probe variables, kernel.mark now supports $$vars and | |
1679 | $$parms, and process.syscall now supports $$vars. | |
1680 | ||
1681 | - The SNMP tapset provides probes and functions for many network | |
1682 | statistics. See stapprobes.snmp(3stap) for more details. | |
1683 | ||
1684 | - The dentry tapset provides functions to map kernel VFS directory entries | |
1685 | to file or full path names: d_path(), d_name() and reverse_path_walk(). | |
1686 | ||
1687 | - SystemTap now has userspace markers in its own binaries, and the stap | |
1688 | tapset provides the available probepoints and local variables. | |
1689 | ||
1690 | - Miscellaneous new tapset functions: | |
1691 | - pgrp() returns the process group ID of the current process | |
1692 | - str_replace() performs string replacement | |
1693 | ||
4432f146 | 1694 | * What's new in version 0.9.8, 2009-06-11 |
c3e80cab | 1695 | |
849d6546 JS |
1696 | - Miscellaneous new tapset functions: |
1697 | - sid() returns the session ID of the current process | |
1698 | - stringat() indexes a single character from a string. | |
1699 | ||
1700 | - Using %M in print formats for hex dumps can now print entire buffers, | |
1701 | instead of just small numbers. | |
1702 | ||
6766808e JS |
1703 | - Dwarfless syscalls: The nd_syscalls tapset is now available to probe |
1704 | system calls without requiring kernel debugging information. All of | |
1705 | the same probepoints in the normal syscalls tapset are available with | |
1706 | an "nd_" prefix, e.g. syscall.open becomes nd_syscall.open. Most | |
1707 | syscall arguments are also available by name in nd_syscalls. | |
1708 | ||
87c589a9 | 1709 | - Module signing: If the appropriate nss libraries are available on your |
b232fab3 | 1710 | system, stap-server will sign each compiled module using a self-generated |
87c589a9 JS |
1711 | certificate. This is the first step toward extending authority to |
1712 | load certain modules to unprivileged users. For now, if the system | |
1713 | administrator adds a certificate to a database of trusted signers | |
1714 | (stap-authorize-signing-cert), modules signed using that certificate | |
1715 | will be verified by staprun against tampering. Otherwise, you should | |
1716 | notice no difference in the operation of stap or staprun. | |
c3e80cab | 1717 | |
4432f146 | 1718 | * What's new in version 0.9.7, 2009-04-23 |
dcfd7fed | 1719 | |
cff7feda JS |
1720 | - @cast can now determine its type information using an explicit header |
1721 | specification. For example: | |
1722 | @cast(tv, "timeval", "<sys/time.h>")->tv_sec | |
1723 | @cast(task, "task_struct", "kernel<linux/sched.h>")->tgid | |
1724 | ||
1f65cc4f JS |
1725 | - The overlapping process.* tapsets are now separated. Those probe points |
1726 | documented in stapprobes(3stap) remain the same. Those that were formerly | |
1727 | in stapprobes.process(3stap) have been renamed to kprocess, to reflect | |
1728 | their kernel perspective on processes. | |
1729 | ||
dcfd7fed FCE |
1730 | - The --skip-badvars option now also suppresses run-time error |
1731 | messages that would otherwise result from erroneous memory accesses. | |
1732 | Such accesses can originate from $context expressions fueled by | |
1733 | erroneous debug data, or by kernel_{long,string,...}() tapset calls. | |
1734 | ||
94c3c803 AM |
1735 | - New probes kprobe.function(FUNCTION) and kprobe.function(FUNCTION).return |
1736 | for dwarfless probing. These postpone function address resolution to | |
1737 | run-time and use the kprobe symbol-resolution mechanism. | |
1738 | Probing of absolute statements can be done using the | |
1739 | kprobe.statement(ADDRESS).absolute construct. | |
1740 | ||
819ec23d MW |
1741 | - EXPERIMENTAL support for user process unwinding. A new collection of |
1742 | tapset functions have been added to handle user space backtraces from | |
1743 | probe points that support them (currently process and timer probes - | |
1744 | for timer probes test whether or not in user space first with the | |
1745 | already existing user_mode() function). The new tapset functions are: | |
1746 | uaddr - User space address of current running task. | |
1747 | usymname - Return the symbol of an address in the current task. | |
1748 | usymdata - Return the symbol and module offset of an address. | |
1749 | print_ustack - Print out stack for the current task from string. | |
1750 | print_ubacktrace - Print stack back trace for current task. | |
1751 | ubacktrace - Hex backtrace of current task stack. | |
1752 | Please read http://sourceware.org/ml/systemtap/2009-q2/msg00364.html | |
1753 | on the current restrictions and possible changes in the future and | |
1754 | give feedback if you want to influence future developments. | |
1755 | ||
4432f146 | 1756 | * What's new in version 0.9.5, 2009-03-27 |
944e2486 | 1757 | |
891e4fb2 JS |
1758 | - New probes process().insn and process().insn.block that allows |
1759 | inspection of the process after each instruction or block of | |
1760 | instructions executed. So to count the total number of instructions | |
1761 | a process executes during a run do something like: | |
1762 | $ stap -e 'global steps; probe process("/bin/ls").insn {steps++} | |
1763 | probe end {printf("Total instructions: %d\n", steps);}' \ | |
1764 | -c /bin/ls | |
1765 | This feature can slow down execution of a process somewhat. | |
83dd1a8e | 1766 | |
891e4fb2 JS |
1767 | - Systemtap probes and function man pages extracted from the tapsets |
1768 | are now available under 3stap. To show the page for probe vm.pagefault | |
1769 | or the stap function pexecname do: | |
1770 | $ man 3stap vm.pagefault | |
1771 | $ man 3stap pexecname | |
8e9d6257 | 1772 | |
b1a4288c JS |
1773 | - Kernel tracepoints are now supported for probing predefined kernel |
1774 | events without any debuginfo. Tracepoints incur less overhead than | |
1775 | kprobes, and context parameters are available with full type | |
1776 | information. Any kernel 2.6.28 and later should have defined | |
1777 | tracepoints. Try the following to see what's available: | |
1778 | $ stap -L 'kernel.trace("*")' | |
1779 | ||
ccd65d4a JS |
1780 | - Typecasting with @cast now supports modules search paths, which is |
1781 | useful in case there are multiple places where the type definition | |
1782 | may be found. For example: | |
1783 | @cast(sdev, "scsi_device", "kernel:scsi_mod")->sdev_state | |
1784 | ||
701c41be MH |
1785 | - On-file flight recorder is supported. It allows stap to record huge |
1786 | trace log on the disk and to run in background. | |
1787 | Passing -F option with -o option runs stap in background mode. In this | |
1788 | mode, staprun is detached from console, and stap itself shows staprun's | |
1789 | pid and exits. | |
1790 | Specifying the max size and the max number of log files are also available | |
1791 | by passing -S option. This option has one or two arguments seperated by | |
1792 | a comma. The first argument is the max size of a log file in MB. If the | |
1793 | size of a log file exceeds it, stap switches to the next log file | |
1794 | automatically. The second is how many files are kept on the disk. If the | |
1795 | number of log files exceeds it, the oldest log file is removed | |
1796 | automatically. The second argument can be omitted. | |
1797 | ||
1798 | For example, this will record output on log files each of them is smaller | |
1799 | than 1024MB and keep last 3 logs, in background. | |
1800 | % stap -F -o /tmp/staplog -S 1024,3 script.stp | |
1801 | ||
e2ae0696 LR |
1802 | - In guru mode (-g), the kernel probing blacklist is disabled, leaving |
1803 | only a subset - the kernel's own internal kprobe blacklist - to attempt | |
1804 | to filter out areas unsafe to probe. The differences may be enough to | |
1805 | probe more interrupt handlers. | |
1806 | ||
3bd0d4df | 1807 | - Variables unavailable in current context may be skipped by setting a |
947d86f9 FCE |
1808 | session level flag with command line option --skip-badvars now available. |
1809 | This replaces any dwarf $variable expressions that could not be resolved | |
1810 | with literal numeric zeros, along with a warning message. | |
3bd0d4df | 1811 | |
59fde7cc MW |
1812 | - Both kernel markers and kernel tracepoint support argument listing |
1813 | through stap -L 'kernel.mark("*")' or stap -L 'kernel.trace("*")' | |
1814 | ||
1815 | - Users can use -DINTERRUPTIBLE=0 to prevent interrupt reentrancy in | |
1816 | their script, at the cost of a bit more overhead to toggle the | |
1817 | interrupt mask. | |
1818 | ||
1819 | - Added reentrancy debugging. If stap is run with the arguments | |
1820 | "-t -DDEBUG_REENTRANCY", additional warnings will be printed for | |
1821 | every reentrancy event, including the probe points of the | |
1822 | resident and interloper probes. | |
1823 | ||
387a7a57 MW |
1824 | - Default to --disable-pie for configure. |
1825 | Use --enable-pie to turn it back on. | |
1826 | ||
1827 | - Improved sdt.h compatibility and test suite for static dtrace | |
1828 | compatible user space markers. | |
1829 | ||
1830 | - Some architectures now use syscall wrappers (HAVE_SYSCALL_WRAPPERS). | |
1831 | The syscall tapset has been enhanced to take care of the syscall | |
1832 | wrappers in this release. | |
1833 | ||
1834 | - Security fix for CVE-2009-0784: stapusr module-path checking race. | |
1835 | ||
4432f146 | 1836 | * What's new in version 0.9, 2009-02-19 |
6b2ad26c | 1837 | |
60ea9291 JS |
1838 | - Typecasting is now supported using the @cast operator. A script can |
1839 | define a pointer type for a "long" value, and then access type members | |
1840 | using the same syntax as with $target variables. For example, this will | |
1841 | retrieve the parent pid from a kernel task_struct: | |
1842 | @cast(pointer, "task_struct", "kernel")->parent->pid | |
1843 | ||
76d146ad MW |
1844 | - process().mark() probes are now possible to trace static user space |
1845 | markers put in programs with the STAP_PROBE macro using the new | |
1846 | sys/sdt.h include file. This also provides dtrace compatible markers | |
1847 | through DTRACE_PROBE and an associated python 'dtrace' script that | |
1848 | can be used in builds based on dtrace that need dtrace -h or -G | |
1849 | functionality. | |
1850 | ||
62c977f5 MW |
1851 | - For those that really want to run stap from the build tree there is |
1852 | now the 'run-stap' script in the top-level build directory that sets | |
1853 | up the SYSTEMTAP_TAPSET, SYSTEMTAP_RUNTIME, SYSTEMTAP_STAPRUN, and | |
1854 | SYSTEMTAP_STAPIO environment variables (installing systemtap, in a | |
1855 | local prefix, is still recommended for common use). | |
1856 | ||
1857 | - Systemtap now comes with a new Beginners Guide that walks the user | |
1858 | through their first steps setting up stap, understanding how it all | |
2a321362 MW |
1859 | works, introduces some useful scripts and describes some common |
1860 | pitfalls. It isn't created by default since it needs a Publican | |
1861 | setup, but full build instructions can be found in the wiki: | |
1862 | http://sourceware.org/systemtap/wiki/PublicanQuikHowto | |
1863 | An online version can be found at: | |
1864 | http://sourceware.org/systemtap/SystemTap_Beginners_Guide.pdf | |
1865 | ||
3ad1e1ee MW |
1866 | - Standard tapsets included with Systemtap were modified to include |
1867 | extractable documentation information based on the kernel-doc | |
1868 | infrastructure. When configured --enabled-docs a HTML and PDF | |
1869 | version of the Tapset Reference Manual is produced explaining probes | |
1870 | defined in each tapset. | |
1871 | ||
9e494cbb DB |
1872 | - The systemtap client and compile server are now available. |
1873 | These allow you to compile a systemtap module on a host other than | |
1874 | the one which it will be run, providing the client and server | |
1875 | are compatible. Other than using a server for passes 1 through | |
1876 | 4, the client behaves like the 'stap' front end itself. This | |
1877 | means, among other things, that the client will automatically | |
1878 | load the resulting module on the local host unless -p[1234] | |
c8bf931d | 1879 | was specified. See stap-server(8) for more details. |
9e494cbb | 1880 | The client/server now use SSL for network connection security and |
6288515e DB |
1881 | for signing. |
1882 | ||
1883 | The systemtap client and server are prototypes only. Interfaces, options | |
1884 | and usage may change at any time. | |
9e494cbb | 1885 | |
592470cd SC |
1886 | - function("func").label("label") probes are now supported to allow matching |
1887 | the label of a function. | |
1888 | ||
9a8d8be3 MH |
1889 | - Systemtap initscript is available. This initscript allows you to run |
1890 | systemtap scripts as system services (in flight recorder mode) and | |
1891 | control those scripts individually. | |
e2a741be | 1892 | See README.systemtap for details. |
9a8d8be3 | 1893 | |
b5e66ada FCE |
1894 | - The stap "-r DIR" option may be used to identify a hand-made kernel |
1895 | build directory. The tool determines the appropriate release string | |
1896 | automatically from the directory. | |
7471ea1f | 1897 | |
453edad1 | 1898 | - Serious problems associated with user-space probing in shared libraries |
592470cd | 1899 | were corrected, making it now possible to experiment with probe shared |
7d091090 FCE |
1900 | libraries. Assuming dwarf debugging information is installed, use this |
1901 | twist on the normal syntax: | |
1902 | ||
1903 | probe process("/lib64/libc-2.8.so").function("....") { ... } | |
1904 | ||
1905 | This would probe all threads that call into that library. Running | |
1906 | "stap -c CMD" or "stap -x PID" naturally restricts this to the target | |
453edad1 | 1907 | command+descendants only. $$vars etc. may be used. |
7d091090 FCE |
1908 | |
1909 | - For scripts that sometimes terminate with excessive "skipped" probes, | |
1910 | rerunning the script with "-t" (timing) will print more details about | |
1911 | the skippage reasons. | |
1912 | ||
fd2aeae9 FCE |
1913 | - Symbol tables and unwind (backtracing) data support were formerly |
1914 | compiled in for all probed modules as identified by the script | |
1915 | (kernel; module("name"); process("file")) plus those listed by the | |
1916 | stap "-d BINARY" option. Now, this data is included only if the systemtap | |
1917 | script uses tapset functions like probefunc() or backtrace() that require | |
1918 | such information. This shrinks the probe modules considerably for the rest. | |
1919 | ||
e0b4e89d | 1920 | - Per-pass verbosity control is available with the new "--vp {N}+" option. |
fd2aeae9 FCE |
1921 | "stap --vp 040" adds 4 units of -v verbosity only to pass 2. This is useful |
1922 | for diagnosing errors from one pass without excessive verbosity from others. | |
e0b4e89d | 1923 | |
5c4dcbfb FCE |
1924 | - Most probe handlers now run with interrupts enabled, for improved |
1925 | system responsiveness and less probing overhead. This may result | |
1926 | in more skipped probes, for example if a reentrant probe handler | |
fd2aeae9 FCE |
1927 | is attempted from within an interrupt handler. It may also make the |
1928 | systemtap overload detection facility more likely to be triggered, as | |
1929 | interrupt handlers' run time would be included in the self-assessed | |
1930 | overhead of running probe handlers. | |
6b2ad26c | 1931 | |
4432f146 | 1932 | * What's new in version 0.8, 2008-11-13 |
cfaa068c | 1933 | |
2f9f9366 FCE |
1934 | - Cache limiting is now available. If the compiled module cache size is |
1935 | over a limit specified in the $SYSTEMTAP_DIR/cache/cache_mb_limit file, | |
1936 | some old cache entries will be unlinked. See man stap(1) for more. | |
1937 | ||
57b2fd2b RA |
1938 | - Error and warning messages are now followed by source context displaying |
1939 | the erroneous line/s and a handy '^' in the following line pointing to the | |
1940 | appropriate column. | |
1941 | ||
23433b34 EB |
1942 | - A bug reporting tool "stap-report" is now available which will quickly |
1943 | retrieve much of the information requested here: | |
1944 | http://sourceware.org/systemtap/wiki/HowToReportBugs | |
1945 | ||
25a63204 FCE |
1946 | - The translator can resolve members of anonymous structs / unions: |
1947 | given struct { int foo; struct { int bar; }; } *p; | |
1948 | this now works: $p->bar | |
1949 | ||
2fa2a091 NT |
1950 | - The stap "-F" flag activates "flight recorder" mode, which consists of |
1951 | translating the given script as usual, but implicitly launching it into | |
1952 | the background with staprun's existing "-L" (launch) option. A user | |
1953 | can later reattach to the module with "staprun -A MODULENAME". | |
1954 | ||
6270adc1 MH |
1955 | - Additional context variables are available on user-space syscall probes. |
1956 | - $argN ($arg1, $arg2, ... $arg6) in process(PATH_OR_PID).syscall | |
1957 | gives you the argument of the system call. | |
5d67b47c MH |
1958 | - $return in process(PATH_OR_PID).syscall.return gives you the return |
1959 | value of the system call. | |
6270adc1 | 1960 | |
cec7293b | 1961 | - Target process mode (stap -c CMD or -x PID) now implicitly restricts all |
094b05c7 | 1962 | "process.*" probes to the given child process. (It does not affect |
34f2e0b9 FCE |
1963 | kernel.* or other probe types.) The CMD string is normally run directly, |
1964 | rather than via a /bin/sh -c subshell, since then utrace/uprobe probes | |
1965 | receive a fairly "clean" event stream. If metacharacters like | |
1966 | redirection operators were present in CMD, then "sh -c CMD" is still | |
1967 | used, and utrace/uprobe probes will receive events from the shell. | |
cec7293b FCE |
1968 | |
1969 | % stap -e 'probe process.syscall, process.end { | |
1970 | printf("%s %d %s\n", execname(), pid(), pp())}'\ | |
1971 | -c ls | |
1972 | ls 2323 process.syscall | |
1973 | ls 2323 process.syscall | |
1974 | ls 2323 process.end | |
1975 | ||
1044139f FCE |
1976 | - Probe listing mode is improved: "-L" lists available script-level variables |
1977 | ||
1978 | % stap -L 'syscall.*open*' | |
1979 | syscall.mq_open name:string name_uaddr:long filename:string mode:long u_attr_uaddr:long oflag:long argstr:string | |
1980 | syscall.open name:string filename:string flags:long mode:long argstr:string | |
1981 | syscall.openat name:string filename:string flags:long mode:long argstr:string | |
1982 | ||
e070cc9c FCE |
1983 | - All user-space-related probes support $PATH-resolved executable |
1984 | names, so | |
1985 | ||
1986 | probe process("ls").syscall {} | |
1987 | probe process("./a.out").syscall {} | |
1988 | ||
1989 | work now, instead of just | |
1990 | ||
1991 | probe process("/bin/ls").syscall {} | |
1992 | probe process("/my/directory/a.out").syscall {} | |
1993 | ||
1994 | - Prototype symbolic user-space probing support: | |
1995 | ||
1996 | # stap -e 'probe process("ls").function("*").call { | |
1997 | log (probefunc()." ".$$parms) | |
1998 | }' \ | |
1999 | -c 'ls -l' | |
2000 | ||
2001 | This requires: | |
2002 | - debugging information for the named program | |
2003 | - a version of utrace in the kernel that is compatible with the "uprobes" | |
2004 | kernel module prototype. This includes RHEL5 and older Fedora, but not | |
2005 | yet current lkml-track utrace; a "pass 4a"-time build failure means | |
2006 | your system cannot use this yet. | |
2007 | ||
cd221ed4 | 2008 | - Global variables which are written to but never read are now |
e070cc9c | 2009 | automatically displayed when the session does a shutdown. For example: |
5d954165 | 2010 | |
e070cc9c FCE |
2011 | global running_tasks |
2012 | probe timer.profile {running_tasks[pid(),tid()] = execname()} | |
5d954165 | 2013 | probe timer.ms(8000) {exit()} |
cd221ed4 | 2014 | |
a93f0b31 SC |
2015 | - A formatted string representation of the variables, parameters, or local |
2016 | variables at a probe point is now supported via the special $$vars, | |
a43ba433 FCE |
2017 | $$parms, and $$locals context variables, which expand to a string |
2018 | containing a list "var1=0xdead var2=0xbeef var3=?". (Here, var3 exists | |
2019 | but is for some reason unavailable.) In return probes only, $$return | |
fd574705 | 2020 | expands to an empty string for a void function, or "return=0xf00". |
a93f0b31 | 2021 | |
e10599ff | 2022 | |
4432f146 | 2023 | * What's new in version 0.7, 2008-07-15 |
c2af6f02 | 2024 | |
99a5f9cf SC |
2025 | - .statement("func@file:*") and .statement("func@file:M-N") probes are now |
2026 | supported to allow matching a range of lines in a function. This allows | |
2027 | tracing the execution of a function. | |
2028 | ||
14a75801 FCE |
2029 | - Scripts relying on probe point wildcards like "syscall.*" that expand |
2030 | to distinct kprobes are processed significantly faster than before. | |
2031 | ||
d57671d3 FCE |
2032 | - The vector of script command line arguments is available in a |
2033 | tapset-provided global array argv[]. It is indexed 1 ... argc, | |
2034 | another global. This can substitute for of preprocessor | |
2035 | directives @NNN that fail at parse time if there are not | |
2036 | enough arguments. | |
2037 | ||
2038 | printf("argv: %s %s %s", argv[1], argv[2], argv[3]) | |
2039 | ||
1bd128a3 SC |
2040 | - .statement("func@file+line") probes are now supported to allow a |
2041 | match relative to the entry of the function incremented by line | |
2042 | number. This allows using the same systemtap script if the rest | |
2043 | of the file.c source only changes slightly. | |
2044 | ||
16442b90 FCE |
2045 | - A probe listing mode is available. |
2046 | % stap -l vm.* | |
2047 | vm.brk | |
2048 | vm.mmap | |
2049 | vm.munmap | |
2050 | vm.oom_kill | |
2051 | vm.pagefault | |
2052 | vm.write_shared | |
2053 | ||
159cb109 DS |
2054 | - More user-space probe types are added: |
2055 | ||
dd078c96 DS |
2056 | probe process(PID).begin { } |
2057 | probe process("PATH").begin { } | |
2058 | probe process(PID).thread.begin { } | |
2059 | probe process("PATH").thread.begin { } | |
2060 | probe process(PID).end { } | |
2061 | probe process("PATH").end { } | |
2062 | probe process(PID).thread.end { } | |
2063 | probe process("PATH").thread.end { } | |
159cb109 DS |
2064 | probe process(PID).syscall { } |
2065 | probe process("PATH").syscall { } | |
2066 | probe process(PID).syscall.return { } | |
2067 | probe process("PATH").syscall.return { } | |
16442b90 | 2068 | |
c3799d72 AM |
2069 | - Globals now accept ; terminators |
2070 | ||
2071 | global odds, evens; | |
2072 | global little[10], big[5]; | |
2073 | ||
4432f146 | 2074 | * What's new in version 0.6, 2007-12-15 |
62802575 FCE |
2075 | |
2076 | - A copy of the systemtap tutorial and language reference guide | |
2077 | are now included. | |
683b62c0 | 2078 | |
34201621 DB |
2079 | - There is a new format specifier, %m, for the printf family of |
2080 | functions. It functions like %s, except that it does not stop when | |
2081 | a nul ('\0') byte is encountered. The number of bytes output is | |
2082 | determined by the precision specifier. The default precision is 1. | |
2083 | For example: | |
2084 | ||
2085 | printf ("%m", "My String") // prints one character: M | |
2086 | printf ("%.5", myString) // prints 5 bytes beginning at the start | |
2087 | // of myString | |
2088 | ||
2089 | - The %b format specifier for the printf family of functions has been enhanced | |
2090 | as follows: | |
2091 | ||
2092 | 1) When the width and precision are both unspecified, the default is %8.8b. | |
2093 | 2) When only one of the width or precision is specified, the other defaults | |
2094 | to the same value. For example, %4b == %.4b == %4.4b | |
2095 | 3) Nul ('\0') bytes are used for field width padding. For example, | |
2096 | ||
2097 | printf ("%b", 0x1111deadbeef2222) // prints all eight bytes | |
2098 | printf ("%4.2b", 0xdeadbeef) // prints \0\0\xbe\xef | |
2099 | ||
2100 | - Dynamic width and precision are now supported for all printf family format | |
2101 | specifiers. For example: | |
2102 | ||
2103 | four = 4 | |
2104 | two = 2 | |
2105 | printf ("%*.*b", four, two, 0xdeadbbeef) // prints \0\0\xbe\xef | |
2106 | printf ("%*d", four, two) // prints <space><space><space>2 | |
2107 | ||
7a468d68 | 2108 | - Preprocessor conditional expressions can now include wildcard style |
e070cc9c | 2109 | matches on kernel versions. |
7a468d68 FCE |
2110 | %( kernel_vr != "*xen" %? foo %: bar %) |
2111 | ||
1ada6f08 FCE |
2112 | - Prototype support for user-space probing is showing some progress. |
2113 | No symbolic notations are supported yet (so no probing by function names, | |
2114 | file names, process names, and no access to $context variables), but at | |
2115 | least it's something: | |
2116 | ||
2117 | probe process(PID).statement(ADDRESS).absolute { } | |
2118 | ||
2119 | This will set a uprobe on the given process-id and given virtual address. | |
2120 | The proble handler runs in kernel-space as usual, and can generally use | |
2121 | existing tapset functions. | |
2122 | ||
149eaccd MH |
2123 | - Crash utility can retrieve systemtap's relay buffer from a kernel dump |
2124 | image by using staplog which is a crash extension module. To use this | |
2125 | feature, type commands as below from crash(8)'s command line: | |
2126 | ||
2127 | crash> extend staplog.so | |
2128 | crash> help systemtaplog | |
2129 | ||
2130 | Then, you can see more precise help message. | |
2131 | ||
2132 | - You can share a relay buffer amoung several scripts and merge outputs from | |
2133 | several scripts by using "-DRELAY_HOST" and "-DRELAY_GUEST" options. | |
2134 | For example: | |
2135 | ||
2136 | # run a host script | |
2137 | % stap -ve 'probe begin{}' -o merged.out -DRELAY_HOST & | |
2138 | # wait until starting the host. | |
2139 | % stap -ve 'probe begin{print("hello ");exit()}' -DRELAY_GUEST | |
2140 | % stap -ve 'probe begin{print("world\n");exit()}' -DRELAY_GUEST | |
2141 | ||
2142 | Then, you'll see "hello world" in merged.out. | |
2143 | ||
dfd11cc3 MH |
2144 | - You can add a conditional statement for each probe point or aliase, which |
2145 | is evaluated when the probe point is hit. If the condition is false, the | |
2146 | whole probe body(including aliases) is skipped. For example: | |
2147 | ||
2148 | global switch = 0; | |
2149 | probe syscall.* if (switch) { ... } | |
2150 | probe procfs.write {switch = strtol($value,10)} /* enable/disable ctrl */ | |
2151 | ||
a9e8f7e0 FCE |
2152 | - Systemtap will warn you if your script contains unused variables or |
2153 | functions. This is helpful in case of misspelled variables. If it | |
2154 | doth protest too much, turn it off with "stap -w ...". | |
2155 | ||
683b62c0 FCE |
2156 | - You can add error-handling probes to a script, which are run if a |
2157 | script was stopped due to errors. In such a case, "end" probes are | |
2158 | not run, but "error" ones are. | |
2159 | ||
2160 | probe error { println ("oops, errors encountered; here's a report anyway") | |
2161 | foreach (coin in mint) { println (coin) } } | |
98aab489 | 2162 | |
d898100a FCE |
2163 | - In a related twist, one may list probe points in order of preference, |
2164 | and mark any of them as "sufficient" beyond just "optional". Probe | |
2165 | point sequence expansion stops if a sufficient-marked probe point has a hit. | |
2166 | This is useful for probes on functions that may be in a module (CONFIG_FOO=m) | |
2167 | or may have been compiled into the kernel (CONFIG_FOO=y), but we don't know | |
2168 | which. Instead of | |
2169 | ||
2170 | probe module("sd").function("sd_init_command") ? , | |
2171 | kernel.function("sd_init_command") ? { ... } | |
2172 | ||
2173 | which might match neither, now one can write this: | |
2174 | ||
2175 | probe module("sd").function("sd_init_command") ! , /* <-- note excl. mark */ | |
2176 | kernel.function("sd_init_command") { ... } | |
2177 | ||
98aab489 | 2178 | - New security model. To install a systemtap kernel module, a user |
fedd4090 FCE |
2179 | must be one of the following: the root user; a member of the |
2180 | 'stapdev' group; or a member of the 'stapusr' group. Members of the | |
2181 | stapusr group can only use modules located in the | |
2182 | /lib/modules/VERSION/systemtap directory (where VERSION is the | |
2183 | output of "uname -r"). | |
2184 | ||
2185 | - .statement("...@file:line") probes now apply heuristics to allow an | |
2186 | approximate match for the line number. This works similarly to gdb, | |
2187 | where a breakpoint placed on an empty source line is automatically | |
2188 | moved to the next statement. A silly bug that made many $target | |
2189 | variables inaccessible to .statement() probes was also fixed. | |
98aab489 | 2190 | |
6d4a0530 FCE |
2191 | - LKET has been retired. Please let us know on <systemtap@sourceware.org> |
2192 | if you have been a user of the tapset/tools, so we can help you find | |
2193 | another way. | |
2194 | ||
4fcb4393 FCE |
2195 | - New families of printing functions println() and printd() have been added. |
2196 | println() is like print() but adds a newline at the end; | |
2197 | printd() is like a sequence of print()s, with a specified field delimiter. | |
2198 | ||
4432f146 | 2199 | * What's new since version 0.5.14?, 2007-07-03 |
db6f191e | 2200 | |
3f99432c FCE |
2201 | - The way in which command line arguments for scripts are substituted has |
2202 | changed. Previously, $1 etc. would interpret the corresponding command | |
2203 | line argument as an numeric literal, and @1 as a string literal. Now, | |
2204 | the command line arguments are pasted uninterpreted wherever $1 etc. | |
2205 | appears at the beginning of a token. @1 is similar, but is quoted as | |
2206 | a string. This change does not modify old scripts, but has the effect | |
2207 | of permitting substitution of arbitrary token sequences. | |
2208 | ||
2209 | # This worked before, and still does: | |
2210 | % stap -e 'probe timer.s($1) {}' 5 | |
2211 | # Now this also works: | |
2212 | % stap -e 'probe syscall.$1 {log(@1)}' open | |
2213 | # This won't crash, just signal a recursion error: | |
2214 | % stap -e '$1' '$1' | |
2215 | # As before, $1... is recognized only at the beginning of a token | |
2216 | % stap -e 'probe begin {foo$1=5}' | |
db6f191e | 2217 | |
4432f146 | 2218 | * What's new since version 0.5.13?, 2007-03-26 |
8438f752 | 2219 | |
b8da0ad1 FCE |
2220 | - The way in which systemtap resolves function/inline probes has changed: |
2221 | .function(...) - now refers to all functions, inlined or not | |
2222 | .inline(...) - is deprecated, use instead: | |
2223 | .function(...).inline - filters function() to only inlined instances | |
2224 | .function(...).call - filters function() to only non-inlined instances | |
2225 | .function(...).return - as before, but now pairs best with .function().call | |
2226 | .statement() is unchanged. | |
8438f752 | 2227 | |
4432f146 | 2228 | * What's new since version 0.5.12?, 2007-01-01 |
9abec538 FCE |
2229 | |
2230 | - When running in -p4 (compile-only) mode, the compiled .ko file name | |
2231 | is printed on standard output. | |
2232 | ||
dcc4fec4 FCE |
2233 | - An array element with a null value such as zero or an empty string |
2234 | is now preserved, and will show up in a "foreach" loop or "in" test. | |
2235 | To delete such an element, the scripts needs to use an explicit | |
2236 | "delete array[idx]" statement rather than something like "array[idx]=0". | |
2237 | ||
44f75386 FCE |
2238 | - The new "-P" option controls whether prologue searching heuristics |
2239 | will be activated for function probes. This was needed to get correct | |
2240 | debugging information (dwarf location list) data for $target variables. | |
2241 | Modern compilers (gcc 4.1+) tend not to need this heuristic, so it is | |
2242 | no longer default. A new configure flag (--enable-prologues) restores | |
2243 | it as a default setting, and is appropriate for older compilers (gcc 3.*). | |
9abec538 | 2244 | |
74525094 FCE |
2245 | - Each systemtap module prints a one-line message to the kernel informational |
2246 | log when it starts. This line identifies the translator version, base | |
2247 | address of the probe module, a broken-down memory consumption estimate, and | |
2248 | the total number of probes. This is meant as a debugging / auditing aid. | |
2249 | ||
29fdb4e4 DS |
2250 | - Begin/end probes are run with interrupts enabled (but with |
2251 | preemption disabled). This will allow begin/end probes to be | |
2252 | longer, to support generating longer reports. | |
74525094 | 2253 | |
37ebca01 FCE |
2254 | - The numeric forms of kernel.statement() and kernel.function() probe points |
2255 | are now interpreted as relocatable values - treated as relative to the | |
2256 | _stext symbol in that kernel binary. Since some modern kernel images | |
2257 | are relocated to a different virtual address at startup, such addresses | |
2258 | may shift up or down when actually inserted into a running kernel. | |
2259 | ||
2260 | kernel.statement(0xdeadbeef): validated, interpreted relative to _stext, | |
2261 | may map to 0xceadbeef at run time. | |
2262 | ||
2263 | In order to specify unrelocated addresses, use the new ".absolute" | |
2264 | probe point suffix for such numeric addresses. These are only | |
2265 | allowed in guru mode, and provide access to no $target variables. | |
2266 | They don't use debugging information at all, actually. | |
2267 | ||
2268 | kernel.statement(0xfeedface).absolute: raw, unvalidated, guru mode only | |
2269 | ||
4432f146 | 2270 | * What's new since version 0.5.10?, 2006-10-19 |
7ad9d4f5 FCE |
2271 | |
2272 | - Offline processing of debugging information, enabling general | |
2273 | cross-compilation of probe scripts to remote hosts, without | |
2274 | requiring identical module/memory layout. This slows down | |
2275 | compilation/translation somewhat. | |
2276 | ||
2277 | - Kernel symbol table data is loaded by staprun at startup time | |
2278 | rather than compiled into the module. | |
2279 | ||
2280 | - Support the "limit" keyword for foreach iterations: | |
2281 | foreach ([x,y] in ary limit 5) { ... } | |
2282 | This implicitly exits after the fifth iteration. It also enables | |
2283 | more efficient key/value sorting. | |
2284 | ||
2285 | - Support the "maxactive" keyword for return probes: | |
2286 | probe kernel.function("sdfsdf").maxactive(848) { ... } | |
2287 | This allows up to 848 concurrently outstanding entries to | |
2288 | the sdfsdf function before one returns. The default maxactive | |
2289 | number is smaller, and can result in missed return probes. | |
2290 | ||
2291 | - Support accessing of saved function arguments from within | |
2292 | return probes. These values are saved by a synthesized | |
2293 | function-entry probe. | |
2294 | ||
2295 | - Add substantial version/architecture checking in compiled probes to | |
2296 | assert correct installation of debugging information and correct | |
2297 | execution on a compatible kernel. | |
2298 | ||
2299 | - Add probe-time checking for sufficient free stack space when probe | |
2300 | handlers are invoked, as a safety improvement. | |
2301 | ||
2302 | - Add an optional numeric parameter for begin/end probe specifications, | |
e070cc9c | 2303 | to order their execution. |
7ad9d4f5 FCE |
2304 | probe begin(10) { } /* comes after */ probe begin(-10) {} |
2305 | ||
2306 | - Add an optional array size declaration, which is handy for very small | |
2307 | or very large ones. | |
e070cc9c | 2308 | global little[5], big[20000] |
7ad9d4f5 FCE |
2309 | |
2310 | - Include some example scripts along with the documentation. | |
2311 | ||
2312 | - Change the start-time allocation of probe memory to avoid causing OOM | |
2313 | situations, and to abort cleanly if free kernel memory is short. | |
2314 | ||
2315 | - Automatically use the kernel DWARF unwinder, if present, for stack | |
2316 | tracebacks. | |
2317 | ||
2318 | - Many minor bug fixes, performance, tapset, and error message | |
2319 | improvements. |