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