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