│ │ │ │ This is similar to exit but immediately aborts
│ │ │ │ the current probe handler instead of waiting for its
│ │ │ │ completion. Probe handlers already running on *other* CPU cores,
│ │ │ │ however, will still continue to their completion. Unlike error,
│ │ │ │ this function call cannot be caught by 'try ... catch'.
│ │ │ │
function::ansi_clear_screen —
│ │ │ │ Move cursor to top left and clear screen.
│ │ │ │
Synopsis
│ │ │ │ ansi_clear_screen()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Sends ansi code for moving cursor to top left and then the
│ │ │ │ ansi code for clearing the screen from the cursor position to the end.
│ │ │ │
function::ansi_set_color —
│ │ │ │ Set the ansi Select Graphic Rendition mode.
│ │ │ │ -
Synopsis
1) ansi_set_color(fg:long)
2) ansi_set_color(fg:long,bg:long)
3) ansi_set_color(fg:long,bg:long,attr:long)
Arguments
fg
│ │ │ │ +
Synopsis
1) ansi_set_color(fg:long)
2) ansi_set_color(fg:long,bg:long)
3) ansi_set_color(fg:long,bg:long,attr:long)
Arguments
fg
│ │ │ │ Foreground color to set.
│ │ │ │
bg
│ │ │ │ Background color to set.
│ │ │ │
attr
│ │ │ │ Color attribute to set.
│ │ │ │ -
Description
1) Sends ansi code for Select Graphic Rendition mode for the
│ │ │ │ +
Description
1) Sends ansi code for Select Graphic Rendition mode for the
│ │ │ │ given forground color. Black (30), Blue (34), Green (32), Cyan (36),
│ │ │ │ Red (31), Purple (35), Brown (33), Light Gray (37).
2) Sends ansi code for Select Graphic Rendition mode for the
│ │ │ │ given forground color, Black (30), Blue (34), Green (32), Cyan (36),
│ │ │ │ Red (31), Purple (35), Brown (33), Light Gray (37) and the given
│ │ │ │ background color, Black (40), Red (41), Green (42), Yellow (43),
│ │ │ │ Blue (44), Magenta (45), Cyan (46), White (47).
3) Sends ansi code for Select Graphic Rendition mode for the
│ │ │ │ given forground color, Black (30), Blue (34), Green (32), Cyan (36),
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-assert.html
│ │ │ │ @@ -1,14 +1,14 @@
│ │ │ │
1) This function checks the expression and aborts the
│ │ │ │ +
Description
1) This function checks the expression and aborts the
│ │ │ │ current running probe if expression evaluates to zero. Useserror
│ │ │ │ and may be caught by try{} catch{}. A default message will be
│ │ │ │ displayed.
│ │ │ │
2) This function checks the expression and aborts the
│ │ │ │ current running probe if expression evaluates to zero. Useserror
│ │ │ │ and may be caught by try{} catch{}. The specified message will be
│ │ │ │ displayed.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-atomic-long-read.html
│ │ │ │ @@ -1,10 +1,10 @@
│ │ │ │
│ │ │ │ Safely perform the read of an atomic long variable. This will be a
│ │ │ │ NOP on kernels that do not have ATOMIC_LONG_INIT set on the kernel config.
│ │ │ │
│ │ │ │ Returns a string representing the number of bytes (up
│ │ │ │ to 1024 bytes), the number of kilobytes (when less than 1024K)
│ │ │ │ postfixed by 'K', the number of megabytes (when less than 1024M)
│ │ │ │ postfixed by 'M' or the number of gigabytes postfixed by 'G'. If
│ │ │ │ representing K, M or G, and the number is amount is less than 100,
│ │ │ │ it includes a '.' plus the remainer. The returned string will be 5
│ │ │ │ characters wide (padding with whitespace at the front) unless
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-caller-addr.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │
│ │ │ │ This function returns the address and name of the
│ │ │ │ calling function. This is equivalent to calling:
│ │ │ │ - sprintf(“s 0xx”, symname(caller_addr), caller_addr)
│ │ │ │ + sprintf("s 0xx", symname(caller_addr), caller_addr)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -5,11 +5,11 @@
│ │ │ │ │ function::caller — Return name and address of calling function
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ caller:string()
│ │ │ │ │ ***** Arguments *****
│ │ │ │ │ None
│ │ │ │ │ ***** Description *****
│ │ │ │ │ This function returns the address and name of the calling function. This is
│ │ │ │ │ -equivalent to calling: sprintf(“s 0xx”, symname(caller_addr), caller_addr)
│ │ │ │ │ +equivalent to calling: sprintf("s 0xx", symname(caller_addr), caller_addr)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ function::backtrace Home function::caller_addr
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-callers.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ function::callers
function::callers —
│ │ │ │ Return first n elements of kernel stack backtrace
│ │ │ │
Synopsis
│ │ │ │ callers:string(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ number of levels to descend in the stack (not counting the top
│ │ │ │ level). If n is -1, print the entire stack.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a string of the first n hex
│ │ │ │ addresses from the backtrace of the kernel stack. Output may be
│ │ │ │ truncated as per maximum string length (MAXSTRINGLEN).
│ │ │ │
function::cmdline_arg —
│ │ │ │ Fetch a command line argument
│ │ │ │
Synopsis
│ │ │ │ cmdline_arg:string(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ Argument to get (zero is the program itself)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns argument the requested argument from the
│ │ │ │ current process or the empty string when there are not that many
│ │ │ │ arguments or there is a problem retrieving the argument. Argument
│ │ │ │ zero is traditionally the command itself.
│ │ │ │
│ │ │ │ First argument to get (zero is normally the program itself)
│ │ │ │
m
│ │ │ │ Last argument to get (or minus one for all arguments after n)
│ │ │ │
delim
│ │ │ │ String to use to separate arguments when more than one.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns arguments from the current process starting
│ │ │ │ with argument number n, up to argument m. If there are less than n
│ │ │ │ arguments, or the arguments cannot be retrieved from the current
│ │ │ │ process, the empty string is returned. If m is smaller than n then
│ │ │ │ all arguments starting from argument n are returned. Argument zero
│ │ │ │ is traditionally the command itself.
│ │ │ │
function::cmdline_str —
│ │ │ │ Fetch all command line arguments from current process
│ │ │ │
Synopsis
│ │ │ │ cmdline_str:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns all arguments from the current process
│ │ │ │ delimited by spaces. Returns the empty string when the arguments
│ │ │ │ cannot be retrieved.
│ │ │ │
function::cpu_clock_ms —
│ │ │ │ Number of milliseconds on the given cpu's clock
│ │ │ │
Synopsis
│ │ │ │ cpu_clock_ms:long(cpu:long)
│ │ │ │ -
Arguments
cpu
│ │ │ │ +
Arguments
cpu
│ │ │ │ Which processor's clock to read
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of milliseconds on the given
│ │ │ │ cpu's clock. This is always monotonic comparing on the same cpu, but may
│ │ │ │ have some drift between cpus (within about a jiffy).
│ │ │ │
function::cpu_clock_ns —
│ │ │ │ Number of nanoseconds on the given cpu's clock
│ │ │ │
Synopsis
│ │ │ │ cpu_clock_ns:long(cpu:long)
│ │ │ │ -
Arguments
cpu
│ │ │ │ +
Arguments
cpu
│ │ │ │ Which processor's clock to read
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of nanoseconds on the given
│ │ │ │ cpu's clock. This is always monotonic comparing on the same cpu, but may
│ │ │ │ have some drift between cpus (within about a jiffy).
│ │ │ │
function::cpu_clock_s —
│ │ │ │ Number of seconds on the given cpu's clock
│ │ │ │
Synopsis
│ │ │ │ cpu_clock_s:long(cpu:long)
│ │ │ │ -
Arguments
cpu
│ │ │ │ +
Arguments
cpu
│ │ │ │ Which processor's clock to read
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of seconds on the given cpu's
│ │ │ │ clock. This is always monotonic comparing on the same cpu, but may have
│ │ │ │ some drift between cpus (within about a jiffy).
│ │ │ │
function::cpu_clock_us —
│ │ │ │ Number of microseconds on the given cpu's clock
│ │ │ │
Synopsis
│ │ │ │ cpu_clock_us:long(cpu:long)
│ │ │ │ -
Arguments
cpu
│ │ │ │ +
Arguments
cpu
│ │ │ │ Which processor's clock to read
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of microseconds on the given
│ │ │ │ cpu's clock. This is always monotonic comparing on the same cpu, but may
│ │ │ │ have some drift between cpus (within about a jiffy).
│ │ │ │
function::ctime —
│ │ │ │ Convert seconds since epoch into human readable date/time string
│ │ │ │ -
Synopsis
1) ctime:string(epochsecs:long)
2) ctime:string()
Arguments
epochsecs
│ │ │ │ +
Synopsis
1) ctime:string(epochsecs:long)
2) ctime:string()
Arguments
epochsecs
│ │ │ │ Number of seconds since epoch (as returned by gettimeofday_s)
│ │ │ │ -
Description
1) Takes an argument of seconds since the epoch as returned bygettimeofday_s. Returns a string of the form
│ │ │ │ +
Description
1) Takes an argument of seconds since the epoch as returned bygettimeofday_s. Returns a string of the form
│ │ │ │
2) “Wed Jun 30 21:49:08 1993”
│ │ │ │
│ │ │ │
│ │ │ │ The string will always be exactly 24 characters. If the time would
│ │ │ │ be unreasonable far in the past (before what can be represented
│ │ │ │ with a 32 bit offset in seconds from the epoch) an error will occur
│ │ │ │ (which can be avoided with try/catch). If the time would be
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-current-exe-file.html
│ │ │ │ @@ -1,13 +1,13 @@
│ │ │ │
function::current_exe_file —
│ │ │ │ get the file struct pointer for the current task's executable file
│ │ │ │
Synopsis
│ │ │ │ current_exe_file:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the file struct pointer for the
│ │ │ │ current task's executable file. Note that the file struct pointer
│ │ │ │ isn't locked on return. The return value of this function can be
│ │ │ │ passed to fullpath_struct_file to get the path from the file
│ │ │ │ struct.
│ │ │ │
function::dump_stack —
│ │ │ │ Send the kernel backtrace to the kernel trace buffer
│ │ │ │
Synopsis
│ │ │ │ dump_stack()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Print the current kernel backtrace to the kernel trace buffer.
│ │ │ │ not be safely called from all kernel probe contexts, so
│ │ │ │ is restricted to guru mode only. Under the hood, it calls the kernel C API
│ │ │ │ function dump_stack directly.
│ │ │ │
function::env_var —
│ │ │ │ Fetch environment variable from current process
│ │ │ │
Synopsis
│ │ │ │ env_var:string(name:string)
│ │ │ │ -
Arguments
name
│ │ │ │ +
Arguments
name
│ │ │ │ Name of the environment variable to fetch
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the contents of the specified environment value
│ │ │ │ for the current process. If the variable isn't set an empty string
│ │ │ │ is returned.
│ │ │ │
│ │ │ │ This function returns the symbolic string associated
│ │ │ │ with the giver error code, such as ENOENT for the number 2, or
│ │ │ │ E#3333 for an out-of-range value such as 3333.
│ │ │ │
│ │ │ │ An implicit end-of-line is added. staprun prepends
│ │ │ │ the string “ERROR:”. Sending an error message aborts the currently
│ │ │ │ running probe. Depending on the MAXERRORS parameter, it may
│ │ │ │ trigger an exit.
│ │ │ │
│ │ │ │ This only enqueues a request to start
│ │ │ │ shutting down the script. New probes will not fire
│ │ │ │ (except “end” probes), but all currently
│ │ │ │ running ones may complete their work.
│ │ │ │
function::fastcall —
│ │ │ │ Mark function as declared fastcall
│ │ │ │
Synopsis
│ │ │ │ fastcall()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Call this function before accessing arguments
│ │ │ │ using the *_arg functions
│ │ │ │ if the probed kernel function was declared fastcall in the source.
│ │ │ │
│ │ │ │ the 64 bit floating point stored in long
│ │ │ │
roundingMode
│ │ │ │ through 0-6, which are round to nearest even, minMag,
│ │ │ │ min, max, near maxMag and round to odd
│ │ │ │
exact
│ │ │ │ the boolean value, if exact is 1 than raising inexact
│ │ │ │ exception, otherwise ignore the exception.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Given a 64 bit floating point, which is stored in long,
│ │ │ │ use the long value to initiate self-defined float64_t type, then
│ │ │ │ apply the f64_to_i64 function to get the string representation.
│ │ │ │
│ │ │ │ the 64 bit floating point stored in long
│ │ │ │
precision
│ │ │ │ number of digits after decimal point
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Given a 64 bit floating point, which is stored in long,
│ │ │ │ use the long value to initiate self-defined float64_t type, then
│ │ │ │ apply the f64_to_i64 function to get the string representation.
│ │ │ │
function::ftrace —
│ │ │ │ Send a message to the ftrace ring-buffer
│ │ │ │
Synopsis
│ │ │ │ ftrace(msg:string)
│ │ │ │ -
Arguments
msg
│ │ │ │ +
Arguments
msg
│ │ │ │ The formatted message string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ If the ftrace ring-buffer is configured & available,
│ │ │ │ see /debugfs/tracing/trace for the message. Otherwise, the
│ │ │ │ message may be quietly dropped. An implicit end-of-line is added.
│ │ │ │
function::fullpath_struct_nameidata —
│ │ │ │ get the full nameidata path
│ │ │ │
Synopsis
│ │ │ │ fullpath_struct_nameidata(nd:)
│ │ │ │ -
Arguments
nd
│ │ │ │ +
Arguments
nd
│ │ │ │ Pointer to “struct nameidata”.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │
│ │ │ │
│ │ │ │ Returns the full dirent name (full path to the root), like
│ │ │ │ the kernel (and systemtap-tapset) d_path function, with a “/”.
│ │ │ │
│ │ │ │ This function returns the processor cycle counter value
│ │ │ │ if available, else it returns zero. The cycle counter is free running
│ │ │ │ and unsynchronized on each processor. Thus, the order of events cannot
│ │ │ │ determined by comparing the results of the get_cycles function on
│ │ │ │ different processors.
│ │ │ │
│ │ │ │ The load average interval to capture.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the load average at a specified interval.
│ │ │ │ The three load average values 1, 5 and 15 minute average corresponds to
│ │ │ │ indexes 0, 1 and 2 of the avenrun array - see linux/sched.h.
│ │ │ │ Please note that the truncated-integer portion of the load average is returned.
│ │ │ │ If the specified index is out-of-bounds, then an error message and exception is
│ │ │ │ thrown.
│ │ │ │
function::indent_depth —
│ │ │ │ returns the global nested-depth
│ │ │ │
Synopsis
│ │ │ │ indent_depth:long(delta:long)
│ │ │ │ -
Arguments
delta
│ │ │ │ +
Arguments
delta
│ │ │ │ the amount of depth added/removed for each call
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a number for appropriate indentation,
│ │ │ │ similar to indent. Call it with a small positive or matching negative
│ │ │ │ delta. Unlike the thread_indent_depth function, the indent does not track
│ │ │ │ individual indent values on a per thread basis.
│ │ │ │
function::indent —
│ │ │ │ returns an amount of space to indent
│ │ │ │
Synopsis
│ │ │ │ indent:string(delta:long)
│ │ │ │ -
Arguments
delta
│ │ │ │ +
Arguments
delta
│ │ │ │ the amount of space added/removed for each call
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a string with appropriate
│ │ │ │ indentation. Call it with a small positive or matching negative
│ │ │ │ delta. Unlike the thread_indent function, the indent does not
│ │ │ │ track individual indent values on a per thread basis.
│ │ │ │
probe::ioblock_trace.bounce —
│ │ │ │ Fires whenever a buffer bounce is needed for at least one page of a block IO request.
│ │ │ │ -
Synopsis
ioblock_trace.bounce
Values
sector
│ │ │ │ - beginning sector for the entire bio
│ │ │ │ +
Synopsis
ioblock_trace.bounce
Values
q
│ │ │ │ + request queue on which this bio was queued.
│ │ │ │ +
ino
│ │ │ │ + i-node number of the mapped file
│ │ │ │
p_start_sect
│ │ │ │ points to the start sector of the partition structure of the device
│ │ │ │
idx
│ │ │ │ offset into the bio vector array
│ │ │ │ phys_segments - number of segments in this bio after physical address coalescing is performed.
│ │ │ │ +
bytes_done
│ │ │ │ + number of bytes transferred
│ │ │ │ +
sector
│ │ │ │ + beginning sector for the entire bio
│ │ │ │ +
vcnt
│ │ │ │ + bio vector count which represents number of array element (page, offset, length) which makes up this I/O request
│ │ │ │ +
probe::ioblock_trace.end —
│ │ │ │ Fires whenever a block I/O transfer is complete.
│ │ │ │ -
Synopsis
ioblock_trace.end
Values
devname
│ │ │ │ - block device name
│ │ │ │ -
vcnt
│ │ │ │ - bio vector count which represents number of array element (page, offset, length) which makes up this I/O request
│ │ │ │ -
ino
│ │ │ │ - i-node number of the mapped file
│ │ │ │ -
bdev
│ │ │ │ +
Synopsis
ioblock_trace.end
Values
bdev
│ │ │ │ target block device
│ │ │ │ -
size
│ │ │ │ - total size in bytes
│ │ │ │ -
name
│ │ │ │ - name of the probe point
│ │ │ │ -
opf
│ │ │ │ - operations and flags
│ │ │ │ -
q
│ │ │ │ - request queue on which this bio was queued.
│ │ │ │ -
bytes_done
│ │ │ │ - number of bytes transferred
│ │ │ │
flags
│ │ │ │ see below
│ │ │ │ BIO_UPTODATE 0 ok after I/O completion
│ │ │ │ BIO_RW_BLOCK 1 RW_AHEAD set, and read/write would block
│ │ │ │ BIO_EOF 2 out-out-bounds error
│ │ │ │ BIO_SEG_VALID 3 nr_hw_seg valid
│ │ │ │ BIO_CLONED 4 doesn't own data
│ │ │ │ BIO_BOUNCED 5 bio is a bounce bio
│ │ │ │ BIO_USER_MAPPED 6 contains user pages
│ │ │ │ BIO_EOPNOTSUPP 7 not supported
│ │ │ │ +
name
│ │ │ │ + name of the probe point
│ │ │ │ +
size
│ │ │ │ + total size in bytes
│ │ │ │ +
ino
│ │ │ │ + i-node number of the mapped file
│ │ │ │ +
q
│ │ │ │ + request queue on which this bio was queued.
│ │ │ │ +
idx
│ │ │ │ + offset into the bio vector array
│ │ │ │ + phys_segments - number of segments in this bio after physical address coalescing is performed.
│ │ │ │ +
p_start_sect
│ │ │ │ + points to the start sector of the partition structure of the device
│ │ │ │ +
sector
│ │ │ │ + beginning sector for the entire bio
│ │ │ │ +
bytes_done
│ │ │ │ + number of bytes transferred
│ │ │ │
bdev_contains
│ │ │ │ points to the device object which contains the partition (when bio structure represents a partition)
│ │ │ │ +
│ │ │ │ - beginning sector for the entire bio
│ │ │ │ -
p_start_sect
│ │ │ │ - points to the start sector of the partition structure of the device
│ │ │ │ -
idx
│ │ │ │ - offset into the bio vector array
│ │ │ │ - phys_segments - number of segments in this bio after physical address coalescing is performed.
│ │ │ │ -
Context
│ │ │ │ +
vcnt
│ │ │ │ + bio vector count which represents number of array element (page, offset, length) which makes up this I/O request
│ │ │ │ +
Context
│ │ │ │ The process signals the transfer is done.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,49 +2,49 @@
│ │ │ │ │ Prev Chapter 9. IO Scheduler and block IO Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ioblock_trace.end — Fires whenever a block I/O transfer is complete.
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ioblock_trace.end
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - devname
│ │ │ │ │ - block device name
│ │ │ │ │ - vcnt
│ │ │ │ │ - bio vector count which represents number of array element (page, offset,
│ │ │ │ │ - length) which makes up this I/O request
│ │ │ │ │ - ino
│ │ │ │ │ - i-node number of the mapped file
│ │ │ │ │ bdev
│ │ │ │ │ target block device
│ │ │ │ │ - size
│ │ │ │ │ - total size in bytes
│ │ │ │ │ - name
│ │ │ │ │ - name of the probe point
│ │ │ │ │ - opf
│ │ │ │ │ - operations and flags
│ │ │ │ │ - q
│ │ │ │ │ - request queue on which this bio was queued.
│ │ │ │ │ - bytes_done
│ │ │ │ │ - number of bytes transferred
│ │ │ │ │ flags
│ │ │ │ │ see below BIO_UPTODATE 0 ok after I/O completion BIO_RW_BLOCK 1 RW_AHEAD
│ │ │ │ │ set, and read/write would block BIO_EOF 2 out-out-bounds error
│ │ │ │ │ BIO_SEG_VALID 3 nr_hw_seg valid BIO_CLONED 4 doesn't own data BIO_BOUNCED
│ │ │ │ │ 5 bio is a bounce bio BIO_USER_MAPPED 6 contains user pages
│ │ │ │ │ BIO_EOPNOTSUPP 7 not supported
│ │ │ │ │ + name
│ │ │ │ │ + name of the probe point
│ │ │ │ │ + size
│ │ │ │ │ + total size in bytes
│ │ │ │ │ + ino
│ │ │ │ │ + i-node number of the mapped file
│ │ │ │ │ + q
│ │ │ │ │ + request queue on which this bio was queued.
│ │ │ │ │ + idx
│ │ │ │ │ + offset into the bio vector array phys_segments - number of segments in
│ │ │ │ │ + this bio after physical address coalescing is performed.
│ │ │ │ │ + p_start_sect
│ │ │ │ │ + points to the start sector of the partition structure of the device
│ │ │ │ │ + sector
│ │ │ │ │ + beginning sector for the entire bio
│ │ │ │ │ + bytes_done
│ │ │ │ │ + number of bytes transferred
│ │ │ │ │ bdev_contains
│ │ │ │ │ points to the device object which contains the partition (when bio
│ │ │ │ │ structure represents a partition)
│ │ │ │ │ + devname
│ │ │ │ │ + block device name
│ │ │ │ │ + opf
│ │ │ │ │ + operations and flags
│ │ │ │ │ rw
│ │ │ │ │ binary trace for read/write request
│ │ │ │ │ - sector
│ │ │ │ │ - beginning sector for the entire bio
│ │ │ │ │ - p_start_sect
│ │ │ │ │ - points to the start sector of the partition structure of the device
│ │ │ │ │ - idx
│ │ │ │ │ - offset into the bio vector array phys_segments - number of segments in
│ │ │ │ │ - this bio after physical address coalescing is performed.
│ │ │ │ │ + vcnt
│ │ │ │ │ + bio vector count which represents number of array element (page, offset,
│ │ │ │ │ + length) which makes up this I/O request
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The process signals the transfer is done.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ioblock_trace.bounce Home probe::ioblock_trace.request
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ioblock-trace-request.html
│ │ │ │ @@ -1,44 +1,44 @@
│ │ │ │ probe::ioblock_trace.request
│ │ │ │ bio vector count which represents number of array element (page, offset, length) which make up this I/O request
│ │ │ │ +
sector
│ │ │ │ + beginning sector for the entire bio
│ │ │ │ +
bytes_done
│ │ │ │ + number of bytes transferred
│ │ │ │ +
idx
│ │ │ │ + offset into the bio vector array
│ │ │ │ + phys_segments - number of segments in this bio after physical address coalescing is performed.
│ │ │ │ +
p_start_sect
│ │ │ │ + points to the start sector of the partition structure of the device
│ │ │ │
ino
│ │ │ │ i-node number of the mapped file
│ │ │ │ -
│ │ │ │ - points to the device object which contains the partition (when bio structure represents a partition)
│ │ │ │ +
q
│ │ │ │ + request queue on which this bio was queued.
│ │ │ │ +
size
│ │ │ │ + total size in bytes
│ │ │ │
flags
│ │ │ │ see below
│ │ │ │ BIO_UPTODATE 0 ok after I/O completion
│ │ │ │ BIO_RW_BLOCK 1 RW_AHEAD set, and read/write would block
│ │ │ │ BIO_EOF 2 out-out-bounds error
│ │ │ │ BIO_SEG_VALID 3 nr_hw_seg valid
│ │ │ │ BIO_CLONED 4 doesn't own data
│ │ │ │ BIO_BOUNCED 5 bio is a bounce bio
│ │ │ │ BIO_USER_MAPPED 6 contains user pages
│ │ │ │ BIO_EOPNOTSUPP 7 not supported
│ │ │ │ -
bytes_done
│ │ │ │ - number of bytes transferred
│ │ │ │ -
q
│ │ │ │ - request queue on which this bio was queued.
│ │ │ │ -
sector
│ │ │ │ - beginning sector for the entire bio
│ │ │ │ -
idx
│ │ │ │ - offset into the bio vector array
│ │ │ │ - phys_segments - number of segments in this bio after physical address coalescing is performed.
│ │ │ │ -
p_start_sect
│ │ │ │ - points to the start sector of the partition structure of the device
│ │ │ │ -
Context
│ │ │ │ +
name
│ │ │ │ + name of the probe point
│ │ │ │ +
bdev
│ │ │ │ + target block device
│ │ │ │ +
Context
│ │ │ │ The process makes block I/O request
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -3,49 +3,49 @@
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ioblock_trace.request — Fires just as a generic block I/O request is
│ │ │ │ │ created for a bio.
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ioblock_trace.request
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - name
│ │ │ │ │ - name of the probe point
│ │ │ │ │ - bdev
│ │ │ │ │ - target block device
│ │ │ │ │ - size
│ │ │ │ │ - total size in bytes
│ │ │ │ │ + bdev_contains
│ │ │ │ │ + points to the device object which contains the partition (when bio
│ │ │ │ │ + structure represents a partition)
│ │ │ │ │ opf
│ │ │ │ │ operations and flags
│ │ │ │ │ + rw
│ │ │ │ │ + binary trace for read/write request
│ │ │ │ │ + devname
│ │ │ │ │ + block device name
│ │ │ │ │ vcnt
│ │ │ │ │ bio vector count which represents number of array element (page, offset,
│ │ │ │ │ length) which make up this I/O request
│ │ │ │ │ + sector
│ │ │ │ │ + beginning sector for the entire bio
│ │ │ │ │ + bytes_done
│ │ │ │ │ + number of bytes transferred
│ │ │ │ │ + idx
│ │ │ │ │ + offset into the bio vector array phys_segments - number of segments in
│ │ │ │ │ + this bio after physical address coalescing is performed.
│ │ │ │ │ + p_start_sect
│ │ │ │ │ + points to the start sector of the partition structure of the device
│ │ │ │ │ ino
│ │ │ │ │ i-node number of the mapped file
│ │ │ │ │ - devname
│ │ │ │ │ - block device name
│ │ │ │ │ - rw
│ │ │ │ │ - binary trace for read/write request
│ │ │ │ │ - bdev_contains
│ │ │ │ │ - points to the device object which contains the partition (when bio
│ │ │ │ │ - structure represents a partition)
│ │ │ │ │ + q
│ │ │ │ │ + request queue on which this bio was queued.
│ │ │ │ │ + size
│ │ │ │ │ + total size in bytes
│ │ │ │ │ flags
│ │ │ │ │ see below BIO_UPTODATE 0 ok after I/O completion BIO_RW_BLOCK 1 RW_AHEAD
│ │ │ │ │ set, and read/write would block BIO_EOF 2 out-out-bounds error
│ │ │ │ │ BIO_SEG_VALID 3 nr_hw_seg valid BIO_CLONED 4 doesn't own data BIO_BOUNCED
│ │ │ │ │ 5 bio is a bounce bio BIO_USER_MAPPED 6 contains user pages
│ │ │ │ │ BIO_EOPNOTSUPP 7 not supported
│ │ │ │ │ - bytes_done
│ │ │ │ │ - number of bytes transferred
│ │ │ │ │ - q
│ │ │ │ │ - request queue on which this bio was queued.
│ │ │ │ │ - sector
│ │ │ │ │ - beginning sector for the entire bio
│ │ │ │ │ - idx
│ │ │ │ │ - offset into the bio vector array phys_segments - number of segments in
│ │ │ │ │ - this bio after physical address coalescing is performed.
│ │ │ │ │ - p_start_sect
│ │ │ │ │ - points to the start sector of the partition structure of the device
│ │ │ │ │ + name
│ │ │ │ │ + name of the probe point
│ │ │ │ │ + bdev
│ │ │ │ │ + target block device
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The process makes block I/O request
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ioblock_trace.end Home probe::ioscheduler.elv_add_request
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ioscheduler-elv-add-request-kp.html
│ │ │ │ @@ -1,17 +1,17 @@
│ │ │ │ probe::ioscheduler.elv_add_request.kp
probe::ioscheduler_trace.unplug_io —
│ │ │ │ Fires when a request queue is unplugged;
│ │ │ │ -
Synopsis
ioscheduler_trace.unplug_io
Values
rq_queue
│ │ │ │ +
Synopsis
ioscheduler_trace.unplug_io
Values
rq_queue
│ │ │ │ request queue
│ │ │ │
name
│ │ │ │ Name of the probe point
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Either, when number of pending requests in the queue exceeds threshold
│ │ │ │ or, upon expiration of timer that was activated when queue was plugged.
│ │ │ │
│ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
ipmib.ForwDatagrams
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
skb
│ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global ForwDatagrams (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_OUTFORWDATAGRAMS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.ForwDatagrams — Count forwarded packet
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.ForwDatagrams
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - skb
│ │ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + skb
│ │ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global ForwDatagrams
│ │ │ │ │ (equivalent to SNMP's MIB IPSTATS_MIB_OUTFORWDATAGRAMS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ function::tcpmib_remote_port Home probe::ipmib.FragFails
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-FragFails.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.FragFails
│ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
ipmib.FragFails
Values
op
│ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
skb
│ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global FragFails (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_FRAGFAILS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.FragFails — Count datagram fragmented unsuccessfully
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.FragFails
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - skb
│ │ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ │ op
│ │ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ │ + skb
│ │ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global FragFails (equivalent
│ │ │ │ │ to SNMP's MIB IPSTATS_MIB_FRAGFAILS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.ForwDatagrams Home probe::ipmib.FragOKs
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-FragOKs.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.FragOKs
│ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ -
skb
│ │ │ │ +
Synopsis
ipmib.FragOKs
Values
skb
│ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ -
Description
│ │ │ │ +
op
│ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global FragOKs (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_FRAGOKS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.FragOKs — Count datagram fragmented successfully
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.FragOKs
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - op
│ │ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ │ skb
│ │ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ │ + op
│ │ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global FragOKs (equivalent to
│ │ │ │ │ SNMP's MIB IPSTATS_MIB_FRAGOKS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.FragFails Home probe::ipmib.InAddrErrors
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-InAddrErrors.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.InAddrErrors
probe::ipmib.InAddrErrors —
│ │ │ │ Count arriving packets with an incorrect address
│ │ │ │ -
Synopsis
ipmib.InAddrErrors
Values
skb
│ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
ipmib.InAddrErrors
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
skb
│ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global InAddrErrors (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_INADDRERRORS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.InAddrErrors — Count arriving packets with an incorrect address
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.InAddrErrors
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - skb
│ │ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + skb
│ │ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global InAddrErrors
│ │ │ │ │ (equivalent to SNMP's MIB IPSTATS_MIB_INADDRERRORS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.FragOKs Home probe::ipmib.InDiscards
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-InDiscards.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.InDiscards
│ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
ipmib.InDiscards
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
skb
│ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global InDiscards (equivalent to SNMP's MIB
│ │ │ │ STATS_MIB_INDISCARDS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.InDiscards — Count discarded inbound packets
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.InDiscards
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - skb
│ │ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + skb
│ │ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global InDiscards (equivalent
│ │ │ │ │ to SNMP's MIB STATS_MIB_INDISCARDS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.InAddrErrors Home probe::ipmib.InNoRoutes
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-InNoRoutes.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.InNoRoutes
probe::ipmib.InNoRoutes —
│ │ │ │ Count an arriving packet with no matching socket
│ │ │ │ -
Synopsis
ipmib.InNoRoutes
Values
skb
│ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
ipmib.InNoRoutes
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
skb
│ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global InNoRoutes (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_INNOROUTES)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.InNoRoutes — Count an arriving packet with no matching socket
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.InNoRoutes
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - skb
│ │ │ │ │ - pointer to the struct sk_buff being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + skb
│ │ │ │ │ + pointer to the struct sk_buff being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global InNoRoutes (equivalent
│ │ │ │ │ to SNMP's MIB IPSTATS_MIB_INNOROUTES)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.InDiscards Home probe::ipmib.InReceives
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-InReceives.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.InReceives
│ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global InReceives (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_INRECEIVES)
│ │ │ │
probe::ipmib.InUnknownProtos —
│ │ │ │ Count arriving packets with an unbound proto
│ │ │ │ -
Synopsis
ipmib.InUnknownProtos
Values
op
│ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ -
skb
│ │ │ │ +
Synopsis
ipmib.InUnknownProtos
Values
skb
│ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ -
Description
│ │ │ │ +
op
│ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global InUnknownProtos (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_INUNKNOWNPROTOS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.InUnknownProtos — Count arriving packets with an unbound proto
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.InUnknownProtos
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - op
│ │ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ │ skb
│ │ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ │ + op
│ │ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global InUnknownProtos
│ │ │ │ │ (equivalent to SNMP's MIB IPSTATS_MIB_INUNKNOWNPROTOS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.InReceives Home probe::ipmib.OutRequests
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-OutRequests.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.OutRequests
probe::ipmib.OutRequests —
│ │ │ │ Count a request to send a packet
│ │ │ │ -
Synopsis
ipmib.OutRequests
Values
op
│ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ -
skb
│ │ │ │ +
Synopsis
ipmib.OutRequests
Values
skb
│ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ -
Description
│ │ │ │ +
op
│ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global OutRequests (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_OUTREQUESTS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.OutRequests — Count a request to send a packet
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.OutRequests
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - op
│ │ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ │ skb
│ │ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ │ + op
│ │ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global OutRequests
│ │ │ │ │ (equivalent to SNMP's MIB IPSTATS_MIB_OUTREQUESTS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.InUnknownProtos Home probe::ipmib.ReasmReqds
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-ReasmReqds.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.ReasmReqds
probe::ipmib.ReasmReqds —
│ │ │ │ Count number of packet fragments reassembly requests
│ │ │ │ -
Synopsis
ipmib.ReasmReqds
Values
op
│ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ -
skb
│ │ │ │ +
Synopsis
ipmib.ReasmReqds
Values
skb
│ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ -
Description
│ │ │ │ +
op
│ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global ReasmReqds (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_REASMREQDS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::ipmib.ReasmReqds — Count number of packet fragments reassembly requests
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ ipmib.ReasmReqds
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - op
│ │ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ │ skb
│ │ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ │ + op
│ │ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function ipmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global ReasmReqds (equivalent
│ │ │ │ │ to SNMP's MIB IPSTATS_MIB_REASMREQDS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::ipmib.OutRequests Home probe::ipmib.ReasmTimeout
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ipmib-ReasmTimeout.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::ipmib.ReasmTimeout
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │
skb
│ │ │ │ pointer to the struct sk_buff being acted on
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ ipmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global ReasmTimeout (equivalent to SNMP's MIB
│ │ │ │ IPSTATS_MIB_REASMTIMEOUT)
│ │ │ │
│ │ │ │ value to be counted if skb passes the filter
│ │ │ │
SourceIsLocal
│ │ │ │ 1 is local operation and 0 is non-local operation
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function is a default filter function.
│ │ │ │ The user can replace this function with their own.
│ │ │ │ The user-supplied filter function returns an index key based on the values
│ │ │ │ in skb.
│ │ │ │ A return value of 0 means this particular skb should be not be counted.
│ │ │ │
│ │ │ │ This function returns the value of the kernel jiffies
│ │ │ │ variable. This value is incremented periodically by timer interrupts,
│ │ │ │ and may wrap around a 32-bit or 64-bit boundary. See HZ.
│ │ │ │
│ │ │ │ Array description. An empty string can be used.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function adds a array, setting up everything
│ │ │ │ needed. Arrays contain other metrics, added with
│ │ │ │ json_add_array_numeric_metric or json_add_array_string_metric.
│ │ │ │
probe::json_data —
│ │ │ │ Fires whenever JSON data is wanted by a reader.
│ │ │ │ -
Synopsis
json_data
Values
│ │ │ │ +
Synopsis
json_data
Values
│ │ │ │ None
│ │ │ │ -
Context
│ │ │ │ +
Context
│ │ │ │ This probe fires when the JSON data is about to be read. This
│ │ │ │ probe must gather up data and then call the following macros to
│ │ │ │ - output the data in JSON format. First, json_output_data_start()
│ │ │ │ + output the data in JSON format. First, @json_output_data_start
│ │ │ │ must be called. That call is followed by one or more of the
│ │ │ │ following (one call for each data item):
│ │ │ │ - json_output_string_value(), json_output_numeric_value(),
│ │ │ │ - json_output_array_string_value(), and
│ │ │ │ - json_output_array_numeric_value(). Finally json_output_data_end()
│ │ │ │ + @json_output_string_value, @json_output_numeric_value,
│ │ │ │ + @json_output_array_string_value, and
│ │ │ │ + @json_output_array_numeric_value. Finally @json_output_data_end
│ │ │ │ must be called.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -6,15 +6,14 @@
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ json_data
│ │ │ │ │ ***** Values *****
│ │ │ │ │ None
│ │ │ │ │ ***** Context *****
│ │ │ │ │ This probe fires when the JSON data is about to be read. This probe must gather
│ │ │ │ │ up data and then call the following macros to output the data in JSON format.
│ │ │ │ │ -First, json_output_data_start() must be called. That call is followed by one or
│ │ │ │ │ -more of the following (one call for each data item): json_output_string_value
│ │ │ │ │ -(), json_output_numeric_value(), json_output_array_string_value(), and
│ │ │ │ │ -json_output_array_numeric_value(). Finally json_output_data_end() must be
│ │ │ │ │ -called.
│ │ │ │ │ +First, @json_output_data_start must be called. That call is followed by one or
│ │ │ │ │ +more of the following (one call for each data item): @json_output_string_value,
│ │ │ │ │ +@json_output_numeric_value, @json_output_array_string_value, and
│ │ │ │ │ +@json_output_array_numeric_value. Finally @json_output_data_end must be called.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ macro::json_output_string_value Home Chapter 34. Output file switching Tapset
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-json-output-array-numeric-value.html
│ │ │ │ @@ -1,18 +1,18 @@
│ │ │ │ macro::json_output_array_numeric_value
│ │ │ │ The array index (as a string) indicating where to store the numeric value.
│ │ │ │
metric_name
│ │ │ │ The name of the numeric metric.
│ │ │ │
value
│ │ │ │ The numeric value to output.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The json_output_array_numeric_value macro is designed
│ │ │ │ to be called from the 'json_data' probe in the user's script to
│ │ │ │ output a metric's numeric value that is in an array. This metric
│ │ │ │ should have been added with json_add_array_numeric_metric.
│ │ │ │
│ │ │ │ The array index (as a string) indicating where to store the string value.
│ │ │ │
metric_name
│ │ │ │ The name of the string metric.
│ │ │ │
value
│ │ │ │ The string value to output.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The json_output_array_string_value macro is designed
│ │ │ │ to be called from the 'json_data' probe in the user's script to
│ │ │ │ output a metric's string value that is in an array. This metric
│ │ │ │ should have been added with json_add_array_string_metric.
│ │ │ │
macro::json_output_data_end —
│ │ │ │ End the json output.
│ │ │ │
Synopsis
│ │ │ │ @json_output_data_end()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The json_output_data_end macro is designed to be
│ │ │ │ called from the 'json_data' probe from the user's script. It marks
│ │ │ │ the end of the JSON output.
│ │ │ │
│ │ │ │ The json_output_data_start macro is designed to be
│ │ │ │ called from the 'json_data' probe from the user's script. It marks
│ │ │ │ the start of the JSON output.
│ │ │ │
│ │ │ │ The json_output_numeric_value macro is designed to be
│ │ │ │ called from the 'json_data' probe in the user's script to output a
│ │ │ │ metric's numeric value. This metric should have been added with
│ │ │ │ json_add_numeric_metric.
│ │ │ │
│ │ │ │ The json_output_string_value macro is designed to be
│ │ │ │ called from the 'json_data' probe in the user's script to output a
│ │ │ │ metric's string value. This metric should have been added with
│ │ │ │ json_add_string_metric.
│ │ │ │
│ │ │ │ This function sets the “prefix”, which is the name
│ │ │ │ of the base of the metric hierarchy. Calling this function is
│ │ │ │ optional, by default the name of the systemtap module is used.
│ │ │ │
│ │ │ │ the kernel space address to retrieve the buffer from
│ │ │ │
inlen
│ │ │ │ the exact length of the buffer to read
│ │ │ │
outlen
│ │ │ │ the maximum length of the output string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Reads inlen characters of a buffer from the given kernel space
│ │ │ │ memory address, and returns up to outlen characters, where any ASCII
│ │ │ │ characters that are not printable are replaced by the corresponding escape
│ │ │ │ sequence in the returned string. Note that the string will be surrounded by
│ │ │ │ double quotes. On the rare cases when kernel space data is not accessible at
│ │ │ │ the given address, an error is thrown.
│ │ │ │
│ │ │ │ the kernel space address to retrieve the buffer from
│ │ │ │
inlen
│ │ │ │ the exact length of the buffer to read
│ │ │ │
outlen
│ │ │ │ the maximum length of the output string
│ │ │ │ -
Description
1) Reads inlen characters of a buffer from the given kernel space
│ │ │ │ +
Description
1) Reads inlen characters of a buffer from the given kernel space
│ │ │ │ memory address, and returns up to MAXSTRINGLEN characters, where any ASCII
│ │ │ │ characters that are not printable are replaced by the corresponding escape
│ │ │ │ sequence in the returned string. Note that the string will be surrounded by
│ │ │ │ double quotes. On the rare cases when kernel space data is not accessible at
│ │ │ │ the given address, the address itself is returned as a string, without
│ │ │ │ double quotes.
2) Reads inlen characters of a buffer from the given kernel space
│ │ │ │ memory address, and returns up to outlen characters, where any ASCII
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-kernel-char.html
│ │ │ │ @@ -1,10 +1,10 @@
│ │ │ │
function::kernel_pointer —
│ │ │ │ Retrieves a pointer value stored in kernel memory
│ │ │ │
Synopsis
│ │ │ │ kernel_pointer:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The kernel address to retrieve the pointer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the pointer value from a given kernel memory
│ │ │ │ address. Reports an error when reading from the given address
│ │ │ │ fails.
│ │ │ │
│ │ │ │ the kernel memory address to retrieve the string from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the null terminated C string from a given kernel
│ │ │ │ memory address where any ASCII characters that are not printable are
│ │ │ │ replaced by the corresponding escape sequence in the returned string. Note
│ │ │ │ that the string will be surrounded by double quotes. If the kernel memory
│ │ │ │ data is not accessible at the given address, the address itself is returned
│ │ │ │ as a string, without double quotes.
│ │ │ │
│ │ │ │ The kernel address to retrieve the string from
│ │ │ │
err_msg
│ │ │ │ The error message to return when data isn't available
│ │ │ │ -
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ +
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-16 string at a given kernel memory address. Reports an error on
│ │ │ │ string copy fault or conversion error.
2) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-16 string at a given kernel memory address. Reports the given
│ │ │ │ error message on string copy fault or conversion error.
│ │ │ │ The kernel address to retrieve the string from
│ │ │ │
err_msg
│ │ │ │ The error message to return when data isn't available
│ │ │ │ -
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ +
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-32 string at a given kernel memory address. Reports an error on
│ │ │ │ string copy fault or conversion error.
2) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-32 string at a given kernel memory address. Reports the given
│ │ │ │ error message on string copy fault or conversion error.
│ │ │ │ The kernel address to retrieve the string from
│ │ │ │
err_msg
│ │ │ │ The error message to return when data isn't available
│ │ │ │ -
Description
1) This function returns the null terminated C string
│ │ │ │ +
Description
1) This function returns the null terminated C string
│ │ │ │ from a given kernel memory address. Reports an error on string
│ │ │ │ copy fault.
2) This function returns the null terminated C string
│ │ │ │ from a given kernel memory address. Reports the given error message
│ │ │ │ on string copy fault.
probe::kprocess.create —
│ │ │ │ Fires whenever a new process or thread is successfully created
│ │ │ │ -
Synopsis
kprocess.create
Values
new_pid
│ │ │ │ - The PID of the newly created process
│ │ │ │ -
new_tid
│ │ │ │ +
Synopsis
kprocess.create
Values
new_tid
│ │ │ │ The TID of the newly created task
│ │ │ │ -
Context
│ │ │ │ +
new_pid
│ │ │ │ + The PID of the newly created process
│ │ │ │ +
Context
│ │ │ │ Parent of the created process.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Fires whenever a new process is successfully created, either as a result of
│ │ │ │ fork (or one of its syscall variants), or a new kernel thread.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -3,18 +3,18 @@
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::kprocess.create — Fires whenever a new process or thread is successfully
│ │ │ │ │ created
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ kprocess.create
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - new_pid
│ │ │ │ │ - The PID of the newly created process
│ │ │ │ │ new_tid
│ │ │ │ │ The TID of the newly created task
│ │ │ │ │ + new_pid
│ │ │ │ │ + The PID of the newly created process
│ │ │ │ │ ***** Context *****
│ │ │ │ │ Parent of the created process.
│ │ │ │ │ ***** Description *****
│ │ │ │ │ Fires whenever a new process is successfully created, either as a result of
│ │ │ │ │ fork (or one of its syscall variants), or a new kernel thread.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-kprocess-exec-complete.html
│ │ │ │ @@ -1,17 +1,17 @@
│ │ │ │ probe::kprocess.exec_complete
probe::kprocess.exit —
│ │ │ │ Exit from process
│ │ │ │ -
Synopsis
kprocess.exit
Values
code
│ │ │ │ +
Synopsis
kprocess.exit
Values
code
│ │ │ │ The exit code of the process
│ │ │ │ -
Context
│ │ │ │ +
Context
│ │ │ │ The process which is terminating.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Fires when a process terminates. This will always be followed by a
│ │ │ │ kprocess.release, though the latter may be delayed if the process waits in a
│ │ │ │ zombie state.
│ │ │ │
probe::kprocess.release —
│ │ │ │ Process released
│ │ │ │ -
Synopsis
kprocess.release
Values
released_pid
│ │ │ │ - PID of the process being released
│ │ │ │ +
Synopsis
kprocess.release
Values
released_tid
│ │ │ │ + TID of the task being released
│ │ │ │
pid
│ │ │ │ Same as released_pid for compatibility (deprecated)
│ │ │ │ -
released_tid
│ │ │ │ - TID of the task being released
│ │ │ │ +
released_pid
│ │ │ │ + PID of the process being released
│ │ │ │
task
│ │ │ │ A task handle to the process being released
│ │ │ │ -
Context
│ │ │ │ +
Context
│ │ │ │ The context of the parent, if it wanted notification of this process'
│ │ │ │ termination, else the context of the process itself.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Fires when a process is released from the kernel. This always follows a
│ │ │ │ kprocess.exit, though it may be delayed somewhat if the process waits in a
│ │ │ │ zombie state.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,20 +2,20 @@
│ │ │ │ │ Prev Chapter 16. Kernel Process Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::kprocess.release — Process released
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ kprocess.release
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - released_pid
│ │ │ │ │ - PID of the process being released
│ │ │ │ │ - pid
│ │ │ │ │ - Same as released_pid for compatibility (deprecated)
│ │ │ │ │ released_tid
│ │ │ │ │ TID of the task being released
│ │ │ │ │ + pid
│ │ │ │ │ + Same as released_pid for compatibility (deprecated)
│ │ │ │ │ + released_pid
│ │ │ │ │ + PID of the process being released
│ │ │ │ │ task
│ │ │ │ │ A task handle to the process being released
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The context of the parent, if it wanted notification of this process'
│ │ │ │ │ termination, else the context of the process itself.
│ │ │ │ │ ***** Description *****
│ │ │ │ │ Fires when a process is released from the kernel. This always follows a
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-kprocess-start.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │ probe::kprocess.start
│ │ │ │ Pointer to the struct sock being acted on
│ │ │ │
op
│ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ linuxmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global DelayedACKs (equivalent to SNMP's MIB
│ │ │ │ LINUX_MIB_DELAYEDACKS)
│ │ │ │
probe::linuxmib.ListenDrops —
│ │ │ │ Count of times conn request that were dropped
│ │ │ │ -
Synopsis
linuxmib.ListenDrops
Values
sk
│ │ │ │ - Pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
linuxmib.ListenDrops
Values
op
│ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + Pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ linuxmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global ListenDrops (equivalent to SNMP's MIB
│ │ │ │ LINUX_MIB_LISTENDROPS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::linuxmib.ListenDrops — Count of times conn request that were dropped
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ linuxmib.ListenDrops
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - Pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + Pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function linuxmib_filter_key.
│ │ │ │ │ If the packet passes the filter is is counted in the global ListenDrops
│ │ │ │ │ (equivalent to SNMP's MIB LINUX_MIB_LISTENDROPS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::linuxmib.DelayedACKs Home probe::linuxmib.ListenOverflows
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-linuxmib-ListenOverflows.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::linuxmib.ListenOverflows
probe::linuxmib.ListenOverflows —
│ │ │ │ Count of times a listen queue overflowed
│ │ │ │ -
Synopsis
linuxmib.ListenOverflows
Values
sk
│ │ │ │ +
Synopsis
linuxmib.ListenOverflows
Values
sk
│ │ │ │ Pointer to the struct sock being acted on
│ │ │ │
op
│ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ linuxmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global ListenOverflows (equivalent to SNMP's MIB
│ │ │ │ LINUX_MIB_LISTENOVERFLOWS)
│ │ │ │
probe::linuxmib.TCPMemoryPressures —
│ │ │ │ Count of times memory pressure was used
│ │ │ │ -
Synopsis
linuxmib.TCPMemoryPressures
Values
sk
│ │ │ │ - Pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
linuxmib.TCPMemoryPressures
Values
op
│ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + Pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ linuxmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global TCPMemoryPressures (equivalent to SNMP's MIB
│ │ │ │ LINUX_MIB_TCPMEMORYPRESSURES)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::linuxmib.TCPMemoryPressures — Count of times memory pressure was used
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ linuxmib.TCPMemoryPressures
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - Pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ Value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + Pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function linuxmib_filter_key.
│ │ │ │ │ If the packet passes the filter is is counted in the global TCPMemoryPressures
│ │ │ │ │ (equivalent to SNMP's MIB LINUX_MIB_TCPMEMORYPRESSURES)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::linuxmib.ListenOverflows Home probe::tcpmib.ActiveOpens
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-linuxmib-filter-key.html
│ │ │ │ @@ -1,15 +1,15 @@
│ │ │ │ function::linuxmib_filter_key
│ │ │ │ value to be counted if sk passes the filter
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function is a default filter function.
│ │ │ │ The user can replace this function with their own.
│ │ │ │ The user-supplied filter function returns an index key based on the values
│ │ │ │ in sk.
│ │ │ │ A return value of 0 means this particular sk should be not be counted.
│ │ │ │
function::local_clock_ms —
│ │ │ │ Number of milliseconds on the local cpu's clock
│ │ │ │
Synopsis
│ │ │ │ local_clock_ms:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of milliseconds on the local
│ │ │ │ cpu's clock. This is always monotonic comparing on the same cpu, but may
│ │ │ │ have some drift between cpus (within about a jiffy).
│ │ │ │
function::local_clock_ns —
│ │ │ │ Number of nanoseconds on the local cpu's clock
│ │ │ │
Synopsis
│ │ │ │ local_clock_ns:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of nanoseconds on the local
│ │ │ │ cpu's clock. This is always monotonic comparing on the same cpu, but may
│ │ │ │ have some drift between cpus (within about a jiffy).
│ │ │ │
function::local_clock_s —
│ │ │ │ Number of seconds on the local cpu's clock
│ │ │ │
Synopsis
│ │ │ │ local_clock_s:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of seconds on the local cpu's
│ │ │ │ clock. This is always monotonic comparing on the same cpu, but may have
│ │ │ │ some drift between cpus (within about a jiffy).
│ │ │ │
function::local_clock_us —
│ │ │ │ Number of microseconds on the local cpu's clock
│ │ │ │
Synopsis
│ │ │ │ local_clock_us:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number of microseconds on the local
│ │ │ │ cpu's clock. This is always monotonic comparing on the same cpu, but may
│ │ │ │ have some drift between cpus (within about a jiffy).
│ │ │ │
function::log —
│ │ │ │ Send a line to the common trace buffer
│ │ │ │
Synopsis
│ │ │ │ log(msg:string)
│ │ │ │ -
Arguments
msg
│ │ │ │ +
Arguments
msg
│ │ │ │ The formatted message string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function logs data. log sends the
│ │ │ │ message immediately to staprun and to the bulk transport
│ │ │ │ (relayfs) if it is being used. If the last character given
│ │ │ │ is not a newline, then one is added. This function is not
│ │ │ │ as efficient as printf and should be used only for urgent
│ │ │ │ messages.
│ │ │ │
function::long_arg —
│ │ │ │ Return function argument as signed long
│ │ │ │
Synopsis
│ │ │ │ long_arg:long(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ index of argument to return
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Return the value of argument n as a signed long.
│ │ │ │ On architectures where a long is 32 bits, the value is sign-extended
│ │ │ │ to 64 bits.
│ │ │ │
function::matched_str —
│ │ │ │ Return the last matched string.
│ │ │ │
Synopsis
│ │ │ │ matched_str:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ returns the string matched by the last successful
│ │ │ │ use of the =~ regexp matching operator. Returns an error if the
│ │ │ │ last use of =~ led to a failed match.
│ │ │ │
function::matched —
│ │ │ │ Return a given matched subexpression.
│ │ │ │
Synopsis
│ │ │ │ matched:string(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ index to the subexpression to return. 0 corresponds to the
│ │ │ │ entire regular expression.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ returns the content of the n'th subexpression of the
│ │ │ │ last successful use of the =~ regex matching operator. Returns an
│ │ │ │ empty string if the n'th subexpression was not matched (e.g. due to
│ │ │ │ alternation). Throws an error if the last use of =~ was a failed
│ │ │ │ match, or if fewer than n subexpressions are present in the
│ │ │ │ original regexp.
│ │ │ │
function::modname —
│ │ │ │ Return the kernel module name loaded at the address
│ │ │ │
Synopsis
│ │ │ │ modname:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to map to a kernel module name
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the module name associated with the given
│ │ │ │ address if known. If not known it will raise an error. If the
│ │ │ │ address was not in a kernel module, but in the kernel itself, then
│ │ │ │ the string “kernel” will be returned.
│ │ │ │
function::module_name —
│ │ │ │ The module name of the current script
│ │ │ │
Synopsis
│ │ │ │ module_name:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the name of the stap module.
│ │ │ │ Either generated randomly (stap_[0-9a-f]+_[0-9a-f]+)
│ │ │ │ or set by stap -m <module_name>.
│ │ │ │
│ │ │ │ Number of milliseconds to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns a string representing the number of
│ │ │ │ milliseconds as a human readable string consisting of “XmY.ZZZs”,
│ │ │ │ where X is the number of minutes, Y is the number of seconds and
│ │ │ │ ZZZ is the number of milliseconds.
│ │ │ │
│ │ │ │ This probe attaches to the generic __set_page_dirty_nobuffers function.
│ │ │ │ Thus, this probe is going to fire on many other file systems in
│ │ │ │ addition to the NFS client.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.aop.set_page_dirty — NFS client marking page as dirty
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.aop.set_page_dirty
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - __page
│ │ │ │ │ - the address of page
│ │ │ │ │ page_flag
│ │ │ │ │ page flags
│ │ │ │ │ + __page
│ │ │ │ │ + the address of page
│ │ │ │ │ ***** Description *****
│ │ │ │ │ This probe attaches to the generic __set_page_dirty_nobuffers function. Thus,
│ │ │ │ │ this probe is going to fire on many other file systems in addition to the NFS
│ │ │ │ │ client.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.aop.release_page Home probe::nfs.aop.write_begin
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-aop-write-begin.html
│ │ │ │ @@ -1,25 +1,25 @@
│ │ │ │ probe::nfs.aop.write_begin
probe::nfs.aop.write_begin —
│ │ │ │ NFS client begin to write data
│ │ │ │ -
Synopsis
nfs.aop.write_begin
Values
__page
│ │ │ │ - the address of page
│ │ │ │ -
to
│ │ │ │ - end address of this write operation
│ │ │ │ +
Synopsis
nfs.aop.write_begin
Values
ino
│ │ │ │ + inode number
│ │ │ │ +
dev
│ │ │ │ + device identifier
│ │ │ │
size
│ │ │ │ write bytes
│ │ │ │
offset
│ │ │ │ start address of this write operation
│ │ │ │ +
to
│ │ │ │ + end address of this write operation
│ │ │ │
page_index
│ │ │ │ offset within mapping, can used a page identifier
│ │ │ │ and position identifier in the page frame
│ │ │ │ -
dev
│ │ │ │ - device identifier
│ │ │ │ -
ino
│ │ │ │ - inode number
│ │ │ │ -
Description
│ │ │ │ +
__page
│ │ │ │ + the address of page
│ │ │ │ +
Description
│ │ │ │ Occurs when write operation occurs on nfs. It prepare a page for writing,
│ │ │ │ look for a request corresponding to the page. If there
│ │ │ │ is one, and it belongs to another file, it flush it out
│ │ │ │ before it tries to copy anything into the page.
│ │ │ │ Also do the same if it finds a request from an existing
│ │ │ │ dropped page
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,29 +2,29 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.aop.write_begin — NFS client begin to write data
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.aop.write_begin
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - __page
│ │ │ │ │ - the address of page
│ │ │ │ │ - to
│ │ │ │ │ - end address of this write operation
│ │ │ │ │ + ino
│ │ │ │ │ + inode number
│ │ │ │ │ + dev
│ │ │ │ │ + device identifier
│ │ │ │ │ size
│ │ │ │ │ write bytes
│ │ │ │ │ offset
│ │ │ │ │ start address of this write operation
│ │ │ │ │ + to
│ │ │ │ │ + end address of this write operation
│ │ │ │ │ page_index
│ │ │ │ │ offset within mapping, can used a page identifier and position identifier
│ │ │ │ │ in the page frame
│ │ │ │ │ - dev
│ │ │ │ │ - device identifier
│ │ │ │ │ - ino
│ │ │ │ │ - inode number
│ │ │ │ │ + __page
│ │ │ │ │ + the address of page
│ │ │ │ │ ***** Description *****
│ │ │ │ │ Occurs when write operation occurs on nfs. It prepare a page for writing, look
│ │ │ │ │ for a request corresponding to the page. If there is one, and it belongs to
│ │ │ │ │ another file, it flush it out before it tries to copy anything into the page.
│ │ │ │ │ Also do the same if it finds a request from an existing dropped page
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-aop-write-end.html
│ │ │ │ @@ -1,29 +1,29 @@
│ │ │ │ probe::nfs.aop.write_end
│ │ │ │ - when we started read-caching this inode
│ │ │ │ -
ino
│ │ │ │ +
Synopsis
nfs.fop.aio_read
Values
ino
│ │ │ │ inode number
│ │ │ │
dev
│ │ │ │ device identifier
│ │ │ │ -
pos
│ │ │ │ - current position of file
│ │ │ │ -
buf
│ │ │ │ - the address of buf in user space
│ │ │ │ -
count
│ │ │ │ - read bytes
│ │ │ │ -
cache_valid
│ │ │ │ - cache related bit mask flag
│ │ │ │ -
file_name
│ │ │ │ - file name
│ │ │ │ +
cache_time
│ │ │ │ + when we started read-caching this inode
│ │ │ │
attrtimeo
│ │ │ │ how long the cached information is assumed to be valid.
│ │ │ │ We need to revalidate the cached attrs for this inode
│ │ │ │ if jiffies - read_cache_jiffies > attrtimeo.
│ │ │ │
parent_name
│ │ │ │ parent dir name
│ │ │ │ +
file_name
│ │ │ │ + file name
│ │ │ │ +
buf
│ │ │ │ + the address of buf in user space
│ │ │ │ +
count
│ │ │ │ + read bytes
│ │ │ │ +
pos
│ │ │ │ + current position of file
│ │ │ │ +
cache_valid
│ │ │ │ + cache related bit mask flag
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,32 +2,32 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.fop.aio_read — NFS client aio_read file operation
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.fop.aio_read
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - cache_time
│ │ │ │ │ - when we started read-caching this inode
│ │ │ │ │ ino
│ │ │ │ │ inode number
│ │ │ │ │ dev
│ │ │ │ │ device identifier
│ │ │ │ │ - pos
│ │ │ │ │ - current position of file
│ │ │ │ │ - buf
│ │ │ │ │ - the address of buf in user space
│ │ │ │ │ - count
│ │ │ │ │ - read bytes
│ │ │ │ │ - cache_valid
│ │ │ │ │ - cache related bit mask flag
│ │ │ │ │ - file_name
│ │ │ │ │ - file name
│ │ │ │ │ + cache_time
│ │ │ │ │ + when we started read-caching this inode
│ │ │ │ │ attrtimeo
│ │ │ │ │ how long the cached information is assumed to be valid. We need to
│ │ │ │ │ revalidate the cached attrs for this inode if jiffies -
│ │ │ │ │ read_cache_jiffies > attrtimeo.
│ │ │ │ │ parent_name
│ │ │ │ │ parent dir name
│ │ │ │ │ + file_name
│ │ │ │ │ + file name
│ │ │ │ │ + buf
│ │ │ │ │ + the address of buf in user space
│ │ │ │ │ + count
│ │ │ │ │ + read bytes
│ │ │ │ │ + pos
│ │ │ │ │ + current position of file
│ │ │ │ │ + cache_valid
│ │ │ │ │ + cache related bit mask flag
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.aop.writepages Home probe::nfs.fop.aio_write
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-fop-aio-write.html
│ │ │ │ @@ -1,17 +1,17 @@
│ │ │ │ probe::nfs.fop.aio_write
│ │ │ │ - when we started read-caching this inode
│ │ │ │ +
Synopsis
nfs.fop.mmap
Values
vm_start
│ │ │ │ + start address within vm_mm
│ │ │ │
cache_valid
│ │ │ │ cache related bit mask flag
│ │ │ │ -
ino
│ │ │ │ - inode number
│ │ │ │ -
dev
│ │ │ │ - device identifier
│ │ │ │ -
parent_name
│ │ │ │ - parent dir name
│ │ │ │
attrtimeo
│ │ │ │ how long the cached information is assumed to be valid.
│ │ │ │ We need to revalidate the cached attrs for this inode
│ │ │ │ if jiffies - read_cache_jiffies > attrtimeo.
│ │ │ │ +
dev
│ │ │ │ + device identifier
│ │ │ │
vm_end
│ │ │ │ the first byte after end address within vm_mm
│ │ │ │ -
vm_start
│ │ │ │ - start address within vm_mm
│ │ │ │ -
file_name
│ │ │ │ - file name
│ │ │ │ +
ino
│ │ │ │ + inode number
│ │ │ │ +
vm_flag
│ │ │ │ + vm flags
│ │ │ │ +
cache_time
│ │ │ │ + when we started read-caching this inode
│ │ │ │ +
parent_name
│ │ │ │ + parent dir name
│ │ │ │
buf
│ │ │ │ the address of buf in user space
│ │ │ │ +
file_name
│ │ │ │ + file name
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,34 +2,34 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.fop.mmap — NFS client mmap operation
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.fop.mmap
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - vm_flag
│ │ │ │ │ - vm flags
│ │ │ │ │ - cache_time
│ │ │ │ │ - when we started read-caching this inode
│ │ │ │ │ + vm_start
│ │ │ │ │ + start address within vm_mm
│ │ │ │ │ cache_valid
│ │ │ │ │ cache related bit mask flag
│ │ │ │ │ - ino
│ │ │ │ │ - inode number
│ │ │ │ │ - dev
│ │ │ │ │ - device identifier
│ │ │ │ │ - parent_name
│ │ │ │ │ - parent dir name
│ │ │ │ │ attrtimeo
│ │ │ │ │ how long the cached information is assumed to be valid. We need to
│ │ │ │ │ revalidate the cached attrs for this inode if jiffies -
│ │ │ │ │ read_cache_jiffies > attrtimeo.
│ │ │ │ │ + dev
│ │ │ │ │ + device identifier
│ │ │ │ │ vm_end
│ │ │ │ │ the first byte after end address within vm_mm
│ │ │ │ │ - vm_start
│ │ │ │ │ - start address within vm_mm
│ │ │ │ │ - file_name
│ │ │ │ │ - file name
│ │ │ │ │ + ino
│ │ │ │ │ + inode number
│ │ │ │ │ + vm_flag
│ │ │ │ │ + vm flags
│ │ │ │ │ + cache_time
│ │ │ │ │ + when we started read-caching this inode
│ │ │ │ │ + parent_name
│ │ │ │ │ + parent dir name
│ │ │ │ │ buf
│ │ │ │ │ the address of buf in user space
│ │ │ │ │ + file_name
│ │ │ │ │ + file name
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.fop.lock Home probe::nfs.fop.open
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-fop-open.html
│ │ │ │ @@ -1,13 +1,13 @@
│ │ │ │ probe::nfs.fop.open
│ │ │ │ + when we started read-caching this inode
│ │ │ │
attrtimeo
│ │ │ │ how long the cached information is assumed to be valid.
│ │ │ │ We need to revalidate the cached attrs for this inode
│ │ │ │ if jiffies - read_cache_jiffies > attrtimeo.
│ │ │ │ -
pos
│ │ │ │ - current position of file
│ │ │ │ +
parent_name
│ │ │ │ + parent dir name
│ │ │ │
ino
│ │ │ │ inode number
│ │ │ │ -
dev
│ │ │ │ - device identifier
│ │ │ │ -
count
│ │ │ │ - read bytes
│ │ │ │ -
file_name
│ │ │ │ - file name
│ │ │ │ +
pos
│ │ │ │ + current position of file
│ │ │ │
cache_valid
│ │ │ │ cache related bit mask flag
│ │ │ │ -
cache_time
│ │ │ │ - when we started read-caching this inode
│ │ │ │ +
count
│ │ │ │ + read bytes
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,30 +2,30 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.fop.read_iter — NFS client read_iter file operation
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.fop.read_iter
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - parent_name
│ │ │ │ │ - parent dir name
│ │ │ │ │ + file_name
│ │ │ │ │ + file name
│ │ │ │ │ + dev
│ │ │ │ │ + device identifier
│ │ │ │ │ + cache_time
│ │ │ │ │ + when we started read-caching this inode
│ │ │ │ │ attrtimeo
│ │ │ │ │ how long the cached information is assumed to be valid. We need to
│ │ │ │ │ revalidate the cached attrs for this inode if jiffies -
│ │ │ │ │ read_cache_jiffies > attrtimeo.
│ │ │ │ │ - pos
│ │ │ │ │ - current position of file
│ │ │ │ │ + parent_name
│ │ │ │ │ + parent dir name
│ │ │ │ │ ino
│ │ │ │ │ inode number
│ │ │ │ │ - dev
│ │ │ │ │ - device identifier
│ │ │ │ │ - count
│ │ │ │ │ - read bytes
│ │ │ │ │ - file_name
│ │ │ │ │ - file name
│ │ │ │ │ + pos
│ │ │ │ │ + current position of file
│ │ │ │ │ cache_valid
│ │ │ │ │ cache related bit mask flag
│ │ │ │ │ - cache_time
│ │ │ │ │ - when we started read-caching this inode
│ │ │ │ │ + count
│ │ │ │ │ + read bytes
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.fop.read Home probe::nfs.fop.release
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-fop-read.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │ probe::nfs.fop.read
│ │ │ │ SystemTap uses the vfs.do_sync_read probe to implement this probe
│ │ │ │ and as a result will get operations other than the NFS client read
│ │ │ │ operations.
│ │ │ │
│ │ │ │ + when we started read-caching this inode
│ │ │ │ +
cache_valid
│ │ │ │ + cache related bit mask flag
│ │ │ │ +
ino
│ │ │ │ + inode number
│ │ │ │ +
attrtimeo
│ │ │ │ how long the cached information is assumed to be valid.
│ │ │ │ We need to revalidate the cached attrs for this inode
│ │ │ │ if jiffies - read_cache_jiffies > attrtimeo.
│ │ │ │ -
ppos
│ │ │ │ - current position of file
│ │ │ │ -
ino
│ │ │ │ - inode number
│ │ │ │
dev
│ │ │ │ device identifier
│ │ │ │ -
cache_valid
│ │ │ │ - cache related bit mask flag
│ │ │ │ -
count
│ │ │ │ - read bytes
│ │ │ │ -
cache_time
│ │ │ │ - when we started read-caching this inode
│ │ │ │ +
ppos
│ │ │ │ + current position of file
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,26 +2,26 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.fop.sendfile — NFS client send file operation
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.fop.sendfile
│ │ │ │ │ ***** Values *****
│ │ │ │ │ + count
│ │ │ │ │ + read bytes
│ │ │ │ │ + cache_time
│ │ │ │ │ + when we started read-caching this inode
│ │ │ │ │ + cache_valid
│ │ │ │ │ + cache related bit mask flag
│ │ │ │ │ + ino
│ │ │ │ │ + inode number
│ │ │ │ │ attrtimeo
│ │ │ │ │ how long the cached information is assumed to be valid. We need to
│ │ │ │ │ revalidate the cached attrs for this inode if jiffies -
│ │ │ │ │ read_cache_jiffies > attrtimeo.
│ │ │ │ │ - ppos
│ │ │ │ │ - current position of file
│ │ │ │ │ - ino
│ │ │ │ │ - inode number
│ │ │ │ │ dev
│ │ │ │ │ device identifier
│ │ │ │ │ - cache_valid
│ │ │ │ │ - cache related bit mask flag
│ │ │ │ │ - count
│ │ │ │ │ - read bytes
│ │ │ │ │ - cache_time
│ │ │ │ │ - when we started read-caching this inode
│ │ │ │ │ + ppos
│ │ │ │ │ + current position of file
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.fop.release Home probe::nfs.fop.write
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-fop-write-iter.html
│ │ │ │ @@ -1,15 +1,15 @@
│ │ │ │ probe::nfs.fop.write_iter
│ │ │ │ SystemTap uses the vfs.do_sync_write probe to implement this probe
│ │ │ │ and as a result will get operations other than the NFS client write
│ │ │ │ operations.
│ │ │ │
probe::nfs.proc.commit_setup —
│ │ │ │ NFS client setting up a commit RPC task
│ │ │ │ -
Synopsis
nfs.proc.commit_setup
Values
count
│ │ │ │ +
Synopsis
nfs.proc.commit_setup
Values
version
│ │ │ │ + NFS version
│ │ │ │ +
size
│ │ │ │ bytes in this commit
│ │ │ │
bitmask1
│ │ │ │ V4 bitmask representing the set of attributes supported
│ │ │ │ on this filesystem
│ │ │ │
server_ip
│ │ │ │ IP address of server
│ │ │ │ -
version
│ │ │ │ - NFS version
│ │ │ │ -
bitmask0
│ │ │ │ - V4 bitmask representing the set of attributes supported
│ │ │ │ - on this filesystem
│ │ │ │ -
size
│ │ │ │ - bytes in this commit
│ │ │ │
offset
│ │ │ │ the file offset
│ │ │ │ +
count
│ │ │ │ + bytes in this commit
│ │ │ │
prot
│ │ │ │ transfer protocol
│ │ │ │ -
Description
│ │ │ │ +
bitmask0
│ │ │ │ + V4 bitmask representing the set of attributes supported
│ │ │ │ + on this filesystem
│ │ │ │ +
Description
│ │ │ │ The commit_setup function is used to setup a commit RPC task.
│ │ │ │ Is is not doing the actual commit operation.
│ │ │ │ It does not exist in NFSv2.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,31 +2,31 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.proc.commit_setup — NFS client setting up a commit RPC task
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.proc.commit_setup
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - count
│ │ │ │ │ + version
│ │ │ │ │ + NFS version
│ │ │ │ │ + size
│ │ │ │ │ bytes in this commit
│ │ │ │ │ bitmask1
│ │ │ │ │ V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ filesystem
│ │ │ │ │ server_ip
│ │ │ │ │ IP address of server
│ │ │ │ │ - version
│ │ │ │ │ - NFS version
│ │ │ │ │ - bitmask0
│ │ │ │ │ - V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ - filesystem
│ │ │ │ │ - size
│ │ │ │ │ - bytes in this commit
│ │ │ │ │ offset
│ │ │ │ │ the file offset
│ │ │ │ │ + count
│ │ │ │ │ + bytes in this commit
│ │ │ │ │ prot
│ │ │ │ │ transfer protocol
│ │ │ │ │ + bitmask0
│ │ │ │ │ + V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ + filesystem
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The commit_setup function is used to setup a commit RPC task. Is is not doing
│ │ │ │ │ the actual commit operation. It does not exist in NFSv2.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.proc.commit_done Home probe::nfs.proc.create
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-proc-commit.html
│ │ │ │ @@ -1,26 +1,26 @@
│ │ │ │ probe::nfs.proc.commit
probe::nfs.proc.commit —
│ │ │ │ NFS client committing data on server
│ │ │ │ -
Synopsis
nfs.proc.commit
Values
offset
│ │ │ │ - the file offset
│ │ │ │ -
size
│ │ │ │ - read bytes in this execution
│ │ │ │ -
prot
│ │ │ │ +
Synopsis
nfs.proc.commit
Values
prot
│ │ │ │ transfer protocol
│ │ │ │ -
server_ip
│ │ │ │ - IP address of server
│ │ │ │ +
bitmask0
│ │ │ │ + V4 bitmask representing the set of attributes supported
│ │ │ │ + on this filesystem
│ │ │ │
bitmask1
│ │ │ │ V4 bitmask representing the set of attributes supported
│ │ │ │ on this filesystem
│ │ │ │ +
server_ip
│ │ │ │ + IP address of server
│ │ │ │ +
offset
│ │ │ │ + the file offset
│ │ │ │ +
size
│ │ │ │ + read bytes in this execution
│ │ │ │
version
│ │ │ │ NFS version
│ │ │ │ -
bitmask0
│ │ │ │ - V4 bitmask representing the set of attributes supported
│ │ │ │ - on this filesystem
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ All the nfs.proc.commit kernel functions were removed in kernel
│ │ │ │ commit 200baa in December 2006, so these probes do not exist on Linux
│ │ │ │ 2.6.21 and newer kernels.
│ │ │ │
│ │ │ │
│ │ │ │ Fires when client writes the buffered data to disk.
│ │ │ │ The buffered data is asynchronously written by client earlier.
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,30 +2,30 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.proc.commit — NFS client committing data on server
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.proc.commit
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - offset
│ │ │ │ │ - the file offset
│ │ │ │ │ - size
│ │ │ │ │ - read bytes in this execution
│ │ │ │ │ prot
│ │ │ │ │ transfer protocol
│ │ │ │ │ - server_ip
│ │ │ │ │ - IP address of server
│ │ │ │ │ + bitmask0
│ │ │ │ │ + V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ + filesystem
│ │ │ │ │ bitmask1
│ │ │ │ │ V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ filesystem
│ │ │ │ │ + server_ip
│ │ │ │ │ + IP address of server
│ │ │ │ │ + offset
│ │ │ │ │ + the file offset
│ │ │ │ │ + size
│ │ │ │ │ + read bytes in this execution
│ │ │ │ │ version
│ │ │ │ │ NFS version
│ │ │ │ │ - bitmask0
│ │ │ │ │ - V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ - filesystem
│ │ │ │ │ ***** Description *****
│ │ │ │ │ All the nfs.proc.commit kernel functions were removed in kernel commit 200baa
│ │ │ │ │ in December 2006, so these probes do not exist on Linux 2.6.21 and newer
│ │ │ │ │ kernels.
│ │ │ │ │ Fires when client writes the buffered data to disk. The buffered data is
│ │ │ │ │ asynchronously written by client earlier. The commit function works in sync
│ │ │ │ │ way. This probe point does not exist in NFSv2.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-proc-create.html
│ │ │ │ @@ -1,17 +1,17 @@
│ │ │ │
probe::nfs.proc.read —
│ │ │ │ NFS client synchronously reads file from server
│ │ │ │ -
Synopsis
nfs.proc.read
Values
version
│ │ │ │ - NFS version
│ │ │ │ -
count
│ │ │ │ - read bytes in this execution
│ │ │ │ +
Synopsis
nfs.proc.read
Values
prot
│ │ │ │ + transfer protocol
│ │ │ │
flags
│ │ │ │ used to set task->tk_flags in rpc_init_task function
│ │ │ │ -
server_ip
│ │ │ │ - IP address of server
│ │ │ │ -
prot
│ │ │ │ - transfer protocol
│ │ │ │ +
count
│ │ │ │ + read bytes in this execution
│ │ │ │
offset
│ │ │ │ the file offset
│ │ │ │ -
Description
│ │ │ │ +
server_ip
│ │ │ │ + IP address of server
│ │ │ │ +
version
│ │ │ │ + NFS version
│ │ │ │ +
Description
│ │ │ │ All the nfs.proc.read kernel functions were removed in kernel commit
│ │ │ │ 8e0969 in December 2006, so these probes do not exist on Linux
│ │ │ │ 2.6.21 and newer kernels.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,25 +2,25 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.proc.read — NFS client synchronously reads file from server
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.proc.read
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - version
│ │ │ │ │ - NFS version
│ │ │ │ │ - count
│ │ │ │ │ - read bytes in this execution
│ │ │ │ │ - flags
│ │ │ │ │ - used to set task->tk_flags in rpc_init_task function
│ │ │ │ │ - server_ip
│ │ │ │ │ - IP address of server
│ │ │ │ │ prot
│ │ │ │ │ transfer protocol
│ │ │ │ │ + flags
│ │ │ │ │ + used to set task->tk_flags in rpc_init_task function
│ │ │ │ │ + count
│ │ │ │ │ + read bytes in this execution
│ │ │ │ │ offset
│ │ │ │ │ the file offset
│ │ │ │ │ + server_ip
│ │ │ │ │ + IP address of server
│ │ │ │ │ + version
│ │ │ │ │ + NFS version
│ │ │ │ │ ***** Description *****
│ │ │ │ │ All the nfs.proc.read kernel functions were removed in kernel commit 8e0969 in
│ │ │ │ │ December 2006, so these probes do not exist on Linux 2.6.21 and newer kernels.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.proc.open Home probe::nfs.proc.read_done
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-proc-release.html
│ │ │ │ @@ -1,17 +1,17 @@
│ │ │ │ probe::nfs.proc.release
probe::nfs.proc.write_setup —
│ │ │ │ NFS client setting up a write RPC task
│ │ │ │ -
Synopsis
nfs.proc.write_setup
Values
version
│ │ │ │ - NFS version
│ │ │ │ -
bitmask0
│ │ │ │ - V4 bitmask representing the set of attributes supported
│ │ │ │ - on this filesystem
│ │ │ │ -
count
│ │ │ │ +
Synopsis
nfs.proc.write_setup
Values
count
│ │ │ │ bytes written in this execution
│ │ │ │ -
bitmask1
│ │ │ │ - V4 bitmask representing the set of attributes supported
│ │ │ │ - on this filesystem
│ │ │ │ -
server_ip
│ │ │ │ - IP address of server
│ │ │ │
prot
│ │ │ │ transfer protocol
│ │ │ │ +
bitmask0
│ │ │ │ + V4 bitmask representing the set of attributes supported
│ │ │ │ + on this filesystem
│ │ │ │
how
│ │ │ │ used to set args.stable. The stable value could be:
│ │ │ │ NFS_UNSTABLE,NFS_DATA_SYNC,NFS_FILE_SYNC
│ │ │ │ (in nfs.proc3.write_setup and nfs.proc4.write_setup)
│ │ │ │ +
version
│ │ │ │ + NFS version
│ │ │ │
size
│ │ │ │ bytes written in this execution
│ │ │ │ +
bitmask1
│ │ │ │ + V4 bitmask representing the set of attributes supported
│ │ │ │ + on this filesystem
│ │ │ │ +
server_ip
│ │ │ │ + IP address of server
│ │ │ │
offset
│ │ │ │ the file offset
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The write_setup function is used to setup a write RPC task.
│ │ │ │ It is not doing the actual write operation.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,34 +2,34 @@
│ │ │ │ │ Prev Chapter 31. Network File Storage Tapset Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.proc.write_setup — NFS client setting up a write RPC task
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.proc.write_setup
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - version
│ │ │ │ │ - NFS version
│ │ │ │ │ - bitmask0
│ │ │ │ │ - V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ - filesystem
│ │ │ │ │ count
│ │ │ │ │ bytes written in this execution
│ │ │ │ │ - bitmask1
│ │ │ │ │ - V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ - filesystem
│ │ │ │ │ - server_ip
│ │ │ │ │ - IP address of server
│ │ │ │ │ prot
│ │ │ │ │ transfer protocol
│ │ │ │ │ + bitmask0
│ │ │ │ │ + V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ + filesystem
│ │ │ │ │ how
│ │ │ │ │ used to set args.stable. The stable value could be:
│ │ │ │ │ NFS_UNSTABLE,NFS_DATA_SYNC,NFS_FILE_SYNC (in nfs.proc3.write_setup and
│ │ │ │ │ nfs.proc4.write_setup)
│ │ │ │ │ + version
│ │ │ │ │ + NFS version
│ │ │ │ │ size
│ │ │ │ │ bytes written in this execution
│ │ │ │ │ + bitmask1
│ │ │ │ │ + V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ + filesystem
│ │ │ │ │ + server_ip
│ │ │ │ │ + IP address of server
│ │ │ │ │ offset
│ │ │ │ │ the file offset
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The write_setup function is used to setup a write RPC task. It is not doing the
│ │ │ │ │ actual write operation.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfs-proc-write.html
│ │ │ │ @@ -1,25 +1,25 @@
│ │ │ │ probe::nfs.proc.write
probe::nfs.proc.write —
│ │ │ │ NFS client synchronously writes file to server
│ │ │ │ -
Synopsis
nfs.proc.write
Values
size
│ │ │ │ +
Synopsis
nfs.proc.write
Values
size
│ │ │ │ read bytes in this execution
│ │ │ │ -
offset
│ │ │ │ - the file offset
│ │ │ │ -
prot
│ │ │ │ - transfer protocol
│ │ │ │ +
version
│ │ │ │ + NFS version
│ │ │ │ +
server_ip
│ │ │ │ + IP address of server
│ │ │ │
bitmask1
│ │ │ │ V4 bitmask representing the set of attributes supported
│ │ │ │ on this filesystem
│ │ │ │ -
server_ip
│ │ │ │ - IP address of server
│ │ │ │ -
flags
│ │ │ │ - used to set task->tk_flags in rpc_init_task function
│ │ │ │ +
offset
│ │ │ │ + the file offset
│ │ │ │
bitmask0
│ │ │ │ V4 bitmask representing the set of attributes supported
│ │ │ │ on this filesystem
│ │ │ │ -
version
│ │ │ │ - NFS version
│ │ │ │ -
Description
│ │ │ │ +
prot
│ │ │ │ + transfer protocol
│ │ │ │ +
flags
│ │ │ │ + used to set task->tk_flags in rpc_init_task function
│ │ │ │ +
Description
│ │ │ │ All the nfs.proc.write kernel functions were removed in kernel commit
│ │ │ │ 200baa in December 2006, so these probes do not exist on Linux
│ │ │ │ 2.6.21 and newer kernels.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -4,29 +4,29 @@
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::nfs.proc.write — NFS client synchronously writes file to server
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ nfs.proc.write
│ │ │ │ │ ***** Values *****
│ │ │ │ │ size
│ │ │ │ │ read bytes in this execution
│ │ │ │ │ - offset
│ │ │ │ │ - the file offset
│ │ │ │ │ - prot
│ │ │ │ │ - transfer protocol
│ │ │ │ │ + version
│ │ │ │ │ + NFS version
│ │ │ │ │ + server_ip
│ │ │ │ │ + IP address of server
│ │ │ │ │ bitmask1
│ │ │ │ │ V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ filesystem
│ │ │ │ │ - server_ip
│ │ │ │ │ - IP address of server
│ │ │ │ │ - flags
│ │ │ │ │ - used to set task->tk_flags in rpc_init_task function
│ │ │ │ │ + offset
│ │ │ │ │ + the file offset
│ │ │ │ │ bitmask0
│ │ │ │ │ V4 bitmask representing the set of attributes supported on this
│ │ │ │ │ filesystem
│ │ │ │ │ - version
│ │ │ │ │ - NFS version
│ │ │ │ │ + prot
│ │ │ │ │ + transfer protocol
│ │ │ │ │ + flags
│ │ │ │ │ + used to set task->tk_flags in rpc_init_task function
│ │ │ │ │ ***** Description *****
│ │ │ │ │ All the nfs.proc.write kernel functions were removed in kernel commit 200baa in
│ │ │ │ │ December 2006, so these probes do not exist on Linux 2.6.21 and newer kernels.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::nfs.proc.rename_setup Home probe::nfs.proc.write_done
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-nfsd-close.html
│ │ │ │ @@ -1,7 +1,7 @@
│ │ │ │ probe::nfsd.close
function::ngroups —
│ │ │ │ Number of subexpressions in the last match.
│ │ │ │
Synopsis
│ │ │ │ ngroups:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ returns the number of subexpressions from the
│ │ │ │ last successful use of the =~ regex matching operator.
│ │ │ │
│ │ │ │
│ │ │ │ Note that this number includes subexpressions which are present in
│ │ │ │ the regex but did not match any string; for example, given the
│ │ │ │ regex “a|(b)”, the subexpressions will count the group for (b)
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-ns-egid.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │
function::ns_egid —
│ │ │ │ Returns the effective gid of a target process as seen in a user namespace
│ │ │ │
Synopsis
│ │ │ │ ns_egid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the effective gid of a target process as seen in the target user namespace if provided, or the stap process namespace
│ │ │ │
function::ns_euid —
│ │ │ │ Returns the effective user ID of a target process as seen in a user namespace
│ │ │ │
Synopsis
│ │ │ │ ns_euid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the effective user ID of the target process as seen in the target user namespace if provided, or the stap process namespace.
│ │ │ │
function::ns_gid —
│ │ │ │ Returns the group ID of a target process as seen in a user namespace
│ │ │ │
Synopsis
│ │ │ │ ns_gid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the group ID of a target process as seen in the target user namespace if provided, or the stap process namespace.
│ │ │ │
function::ns_pgrp —
│ │ │ │ Returns the process group ID of the current process as seen in a pid namespace
│ │ │ │
Synopsis
│ │ │ │ ns_pgrp:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the process group ID of the
│ │ │ │ current process as seen in the target pid namespace if provided, or the stap process namespace.
│ │ │ │
function::ns_ppid —
│ │ │ │ Returns the process ID of a target process's parent process as seen in a pid namespace
│ │ │ │
Synopsis
│ │ │ │ ns_ppid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function return the process ID of the target proccess's parent process as seen in the target pid namespace if provided, or the stap process namespace.
│ │ │ │
function::ns_sid —
│ │ │ │ Returns the session ID of the current process as seen in a pid namespace
│ │ │ │
Synopsis
│ │ │ │ ns_sid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The namespace-aware session ID of a process is the process group ID
│ │ │ │ of the session leader as seen in the target pid namespace if provided, or the stap process namespace. Session ID is stored in the signal_struct
│ │ │ │ since Kernel 2.6.0.
│ │ │ │
function::ns_tid —
│ │ │ │ Returns the thread ID of a target process as seen in a pid namespace
│ │ │ │
Synopsis
│ │ │ │ ns_tid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the thread ID of a target process as seen
│ │ │ │ in the target pid namespace if provided, or the stap process namespace.
│ │ │ │
function::ns_uid —
│ │ │ │ Returns the user ID of a target process as seen in a user namespace
│ │ │ │
Synopsis
│ │ │ │ ns_uid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the user ID of the target process as seen in the target user namespace if provided, or the stap process namespace.
│ │ │ │
│ │ │ │ Number of nanoseconds to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns a string representing the number of
│ │ │ │ nanoseconds as a human readable string consisting of “XmY.ZZZZZZs”,
│ │ │ │ where X is the number of minutes, Y is the number of seconds and
│ │ │ │ ZZZZZZZZZ is the number of nanoseconds.
│ │ │ │
│ │ │ │ message to pass to kernel's panic function
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function triggers an immediate panic of the running
│ │ │ │ kernel with a user-specified panic message.
│ │ │ │ It requires guru mode.
│ │ │ │
function::pn —
│ │ │ │ Returns the active probe name
│ │ │ │
Synopsis
│ │ │ │ pn:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the script-level probe point
│ │ │ │ associated with a currently running probe handler, including
│ │ │ │ wild-card expansion effects. Context: The current probe point.
│ │ │ │
function::pnlabel —
│ │ │ │ Returns the label name parsed from the probe name
│ │ │ │
Synopsis
│ │ │ │ pnlabel:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This returns the label name as parsed from the
│ │ │ │ script-level probe point. This function will only work if called
│ │ │ │ directly from the body of a '.label' probe point (i.e. no aliases).
│ │ │ │ -
function::pp —
│ │ │ │ Returns the active probe point
│ │ │ │
Synopsis
│ │ │ │ pp:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the fully-resolved probe point
│ │ │ │ associated with a currently running probe handler, including alias
│ │ │ │ and wild-card expansion effects. Context: The current probe point.
│ │ │ │
│ │ │ │ This function is equivalent to print_backtrace, but output
│ │ │ │ for each symbol is longer including file names and line numbers.
│ │ │ │ The function does not return a value.
│ │ │ │
│ │ │ │ This function is equivalent to print_stack(backtrace),
│ │ │ │ except that deeper stack nesting may be supported. See print_ubacktrace
│ │ │ │ for user-space backtrace.
│ │ │ │ The function does not return a value.
│ │ │ │
function::print_stack —
│ │ │ │ Print out kernel stack from string
│ │ │ │
Synopsis
│ │ │ │ print_stack(stk:string)
│ │ │ │ -
Arguments
stk
│ │ │ │ +
Arguments
stk
│ │ │ │ String with list of hexadecimal addresses
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function performs a symbolic lookup of the addresses
│ │ │ │ in the given string,
│ │ │ │ which is assumed to be the result of a prior call to
│ │ │ │ backtrace.
│ │ │ │
│ │ │ │
│ │ │ │ Print one line per address, including the address, the
│ │ │ │ name of the function containing the address, and an estimate of
│ │ │ │ its position within that function. Return nothing.
│ │ │ │ -
NOTE
│ │ │ │ +
NOTE
│ │ │ │ it is recommended to use print_syms instead of this function.
│ │ │ │
function::print_syms —
│ │ │ │ Print out kernel stack from string
│ │ │ │
Synopsis
│ │ │ │ print_syms(callers:string)
│ │ │ │ -
Arguments
callers
│ │ │ │ +
Arguments
callers
│ │ │ │ String with list of hexadecimal (kernel) addresses
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function performs a symbolic lookup of the addresses
│ │ │ │ in the given string,
│ │ │ │ which are assumed to be the result of prior calls to stack,
│ │ │ │ callers, and similar functions.
│ │ │ │
│ │ │ │
│ │ │ │ Prints one line per address, including the address, the
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-print-ubacktrace-brief.html
│ │ │ │ @@ -1,17 +1,17 @@
│ │ │ │
function::print_ubacktrace_brief —
│ │ │ │ Print stack back trace for current user-space task.
│ │ │ │
Synopsis
│ │ │ │ print_ubacktrace_brief()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │
│ │ │ │
│ │ │ │ Equivalent to print_ubacktrace, but output for each symbol is
│ │ │ │ shorter (just name and offset, or just the hex address of no symbol
│ │ │ │ could be found).
│ │ │ │ -
Note
│ │ │ │ +
Note
│ │ │ │ To get (full) backtraces for user space applications and shared
│ │ │ │ shared libraries not mentioned in the current script run stap with
│ │ │ │ -d /path/to/exe-or-so and/or add --ldd to load all needed unwind data.
│ │ │ │
2) Equivalent toprint_ubacktrace, but output for each symbol is
│ │ │ │ +
Description
1)
2) Equivalent toprint_ubacktrace, but output for each symbol is
│ │ │ │ longer including file names and line numbers.
│ │ │ │
│ │ │ │ Equivalent to print_ubacktrace_fileline, but it performs the backtrace
│ │ │ │ using the pc, sp, and fp passed in.
│ │ │ │ -
Note
│ │ │ │ +
Note
│ │ │ │ To get (full) backtraces for user space applications and shared
│ │ │ │ shared libraries not mentioned in the current script run stap with
│ │ │ │ -d /path/to/exe-or-so and/or add --ldd to load all needed unwind data.
│ │ │ │
function::print_ubacktrace —
│ │ │ │ Print stack back trace for current user-space task.
│ │ │ │ -
Synopsis
1) print_ubacktrace()
2) print_ubacktrace(pc:long,sp:long,fp:long)
Arguments
pc
│ │ │ │ +
Synopsis
1) print_ubacktrace()
2) print_ubacktrace(pc:long,sp:long,fp:long)
Arguments
pc
│ │ │ │ override PC
│ │ │ │
sp
│ │ │ │ override SP
│ │ │ │
fp
│ │ │ │ override FP
│ │ │ │ -
Description
1)
2) Equivalent to print_ustack(ubacktrace), except that deeper stack
│ │ │ │ +
Description
1)
2) Equivalent to print_ustack(ubacktrace), except that deeper stack
│ │ │ │ nesting may be supported. Returns nothing. See print_backtrace
│ │ │ │ for kernel backtrace.
│ │ │ │
│ │ │ │ Equivalent to print_ubacktrace, but it performs the backtrace
│ │ │ │ using the pc, sp, and fp provided. Useful
│ │ │ │ -
Note
│ │ │ │ +
Note
│ │ │ │ To get (full) backtraces for user space applications and shared
│ │ │ │ shared libraries not mentioned in the current script run stap with
│ │ │ │ -d /path/to/exe-or-so and/or add --ldd to load all needed unwind data.
│ │ │ │
function::print_ustack —
│ │ │ │ Print out stack for the current task from string.
│ │ │ │
Synopsis
│ │ │ │ print_ustack(stk:string)
│ │ │ │ -
Arguments
stk
│ │ │ │ +
Arguments
stk
│ │ │ │ String with list of hexadecimal addresses for the current task.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Perform a symbolic lookup of the addresses in the given string,
│ │ │ │ which is assumed to be the result of a prior call to
│ │ │ │ ubacktrace for the current task.
│ │ │ │
│ │ │ │
│ │ │ │ Print one line per address, including the address, the
│ │ │ │ name of the function containing the address, and an estimate of
│ │ │ │ its position within that function. Return nothing.
│ │ │ │ -
NOTE
│ │ │ │ +
NOTE
│ │ │ │ it is recommended to use print_usyms instead of this function.
│ │ │ │
function::print_usyms —
│ │ │ │ Print out user stack from string
│ │ │ │
Synopsis
│ │ │ │ print_usyms(callers:string)
│ │ │ │ -
Arguments
callers
│ │ │ │ +
Arguments
callers
│ │ │ │ String with list of hexadecimal (user) addresses
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function performs a symbolic lookup of the addresses
│ │ │ │ in the given string,
│ │ │ │ which are assumed to be the result of prior calls to ustack,
│ │ │ │ ucallers, and similar functions.
│ │ │ │
│ │ │ │
│ │ │ │ Prints one line per address, including the address, the
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-printk.html
│ │ │ │ @@ -1,14 +1,14 @@
│ │ │ │
function::printk —
│ │ │ │ Send a message to the kernel trace buffer
│ │ │ │
Synopsis
│ │ │ │ printk(level:long,msg:string)
│ │ │ │ -
Arguments
level
│ │ │ │ +
Arguments
level
│ │ │ │ an integer for the severity level (0=KERN_EMERG ... 7=KERN_DEBUG)
│ │ │ │
msg
│ │ │ │ The formatted message string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Print a line of text to the kernel dmesg/console with the
│ │ │ │ given severity. An implicit end-of-line is added. This function may
│ │ │ │ not be safely called from all kernel probe contexts, so is restricted
│ │ │ │ to guru mode only.
│ │ │ │
function::probe_type —
│ │ │ │ The low level probe handler type of the current probe.
│ │ │ │
Synopsis
│ │ │ │ probe_type:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns a short string describing the low level probe handler
│ │ │ │ type for the current probe point. This is for informational purposes only.
│ │ │ │ Depending on the low level probe handler different context functions can
│ │ │ │ or cannot provide information about the current event (for example some
│ │ │ │ probe handlers only trigger in user space and have no associated kernel
│ │ │ │ context). High-level probes might map to the same or different low-level
│ │ │ │ probes (depending on systemtap version and/or kernel used).
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-probefunc.html
│ │ │ │ @@ -1,19 +1,19 @@
│ │ │ │
function::probefunc —
│ │ │ │ Return the probe point's function name, if known
│ │ │ │
Synopsis
│ │ │ │ probefunc:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the name of the function being probed
│ │ │ │ based on the current address, as computed by symname(addr) or
│ │ │ │ usymname(uaddr) depending on probe context (whether the probe is
│ │ │ │ a user probe or a kernel probe).
│ │ │ │ -
Please note
│ │ │ │ +
Please note
│ │ │ │ this function's behaviour differs between SystemTap 2.0
│ │ │ │ and earlier versions. Prior to 2.0, probefunc obtained the function
│ │ │ │ name from the probe point string as returned by pp, and used the
│ │ │ │ current address as a fallback.
│ │ │ │
function::proc_mem_data —
│ │ │ │ Program data size (data + stack) in pages
│ │ │ │ -
Synopsis
1) proc_mem_data:long()
2) proc_mem_data:long(pid:long)
Arguments
pid
│ │ │ │ +
Synopsis
1) proc_mem_data:long()
2) proc_mem_data:long(pid:long)
Arguments
pid
│ │ │ │ The pid of process to examine
│ │ │ │ -
Description
1) Returns the current process data size (data + stack)
│ │ │ │ +
Description
1) Returns the current process data size (data + stack)
│ │ │ │ in pages, or zero when there is no current process or the number of
│ │ │ │ pages couldn't be retrieved.
2) Returns the given process data size (data + stack)
│ │ │ │ in pages, or zero when the process doesn't exist or the number of
│ │ │ │ pages couldn't be retrieved.
function::proc_mem_rss —
│ │ │ │ Program resident set size in pages
│ │ │ │ -
Synopsis
1) proc_mem_rss:long()
2) proc_mem_rss:long(pid:long)
Arguments
pid
│ │ │ │ +
Synopsis
1) proc_mem_rss:long()
2) proc_mem_rss:long(pid:long)
Arguments
pid
│ │ │ │ The pid of process to examine
│ │ │ │ -
Description
1) Returns the resident set size in pages of the current
│ │ │ │ +
Description
1) Returns the resident set size in pages of the current
│ │ │ │ process, or zero when there is no current process or the number of
│ │ │ │ pages couldn't be retrieved.
2) Returns the resident set size in pages of the given
│ │ │ │ process, or zero when the process doesn't exist or the number of
│ │ │ │ pages couldn't be retrieved.
1) Returns the shared pages (from shared mappings) of the
│ │ │ │ +
Description
1) Returns the shared pages (from shared mappings) of the
│ │ │ │ current process, or zero when there is no current process or the
│ │ │ │ number of pages couldn't be retrieved.
2) Returns the shared pages (from shared mappings) of the
│ │ │ │ given process, or zero when the process doesn't exist or the
│ │ │ │ number of pages couldn't be retrieved.
function::proc_mem_size —
│ │ │ │ Total program virtual memory size in pages
│ │ │ │ -
Synopsis
1) proc_mem_size:long()
2) proc_mem_size:long(pid:long)
Arguments
pid
│ │ │ │ +
Synopsis
1) proc_mem_size:long()
2) proc_mem_size:long(pid:long)
Arguments
pid
│ │ │ │ The pid of process to examine
│ │ │ │ -
Description
1) Returns the total virtual memory size in pages of the
│ │ │ │ +
Description
1) Returns the total virtual memory size in pages of the
│ │ │ │ current process, or zero when there is no current process or the
│ │ │ │ number of pages couldn't be retrieved.
2) Returns the total virtual memory size in pages of the
│ │ │ │ given process, or zero when that process doesn't exist or the
│ │ │ │ number of pages couldn't be retrieved.
function::proc_mem_string —
│ │ │ │ Human readable string of process memory usage
│ │ │ │ -
Synopsis
1) proc_mem_string:string()
2) proc_mem_string:string(pid:long)
Arguments
pid
│ │ │ │ +
Synopsis
1) proc_mem_string:string()
2) proc_mem_string:string(pid:long)
Arguments
pid
│ │ │ │ The pid of process to examine
│ │ │ │ -
Description
1) Returns a human readable string showing the size, rss,
│ │ │ │ +
Description
1) Returns a human readable string showing the size, rss,
│ │ │ │ shr, txt and data of the memory used by the current process.
│ │ │ │ For example“size: 301m, rss: 11m, shr: 8m, txt: 52k, data: 2248k”.
│ │ │ │
2) Returns a human readable string showing the size, rss,
│ │ │ │ shr, txt and data of the memory used by the given process.
│ │ │ │ For example“size: 301m, rss: 11m, shr: 8m, txt: 52k, data: 2248k”.
│ │ │ │
function::proc_mem_txt —
│ │ │ │ Program text (code) size in pages
│ │ │ │ -
Synopsis
1) proc_mem_txt:long()
2) proc_mem_txt:long(pid:long)
Arguments
pid
│ │ │ │ +
Synopsis
1) proc_mem_txt:long()
2) proc_mem_txt:long(pid:long)
Arguments
pid
│ │ │ │ The pid of process to examine
│ │ │ │ -
Description
1) Returns the current process text (code) size in pages,
│ │ │ │ +
Description
1) Returns the current process text (code) size in pages,
│ │ │ │ or zero when there is no current process or the number of pages
│ │ │ │ couldn't be retrieved.
2) Returns the given process text (code) size in pages,
│ │ │ │ or zero when the process doesn't exist or the number of pages
│ │ │ │ couldn't be retrieved.
function::pstrace —
│ │ │ │ Chain of processes and pids back to init(1)
│ │ │ │
Synopsis
│ │ │ │ pstrace:string(task:long)
│ │ │ │ -
Arguments
task
│ │ │ │ +
Arguments
task
│ │ │ │ Pointer to task struct of process
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a string listing execname and pid for each
│ │ │ │ process starting from task back to the process ancestor
│ │ │ │ that init(1) spawned.
│ │ │ │
function::qs_run —
│ │ │ │ Function to record being moved from wait queue to being serviced
│ │ │ │
Synopsis
│ │ │ │ qs_run(qname:string)
│ │ │ │ -
Arguments
qname
│ │ │ │ +
Arguments
qname
│ │ │ │ the name of the service being moved and started
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function records that the previous enqueued
│ │ │ │ request was removed from the given wait queue and is now
│ │ │ │ being serviced.
│ │ │ │
function::qsq_print —
│ │ │ │ Prints a line of statistics for the given queue
│ │ │ │
Synopsis
│ │ │ │ qsq_print(qname:string)
│ │ │ │ -
Arguments
qname
│ │ │ │ +
Arguments
qname
│ │ │ │ queue name
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function prints a line containing the following
│ │ │ │ -
statistics for the given queue
│ │ │ │ +
statistics for the given queue
│ │ │ │ the queue name,
│ │ │ │ the average rate of requests per second,
│ │ │ │ the average wait queue length,
│ │ │ │ the average time on the wait queue,
│ │ │ │ the average time to service a request,
│ │ │ │ the percentage of time the wait queue was used,
│ │ │ │ and the percentage of time request was being serviced.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-qsq-service-time.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │
function::qsq_start —
│ │ │ │ Function to reset the stats for a queue
│ │ │ │
Synopsis
│ │ │ │ qsq_start(qname:string)
│ │ │ │ -
Arguments
qname
│ │ │ │ +
Arguments
qname
│ │ │ │ the name of the service that finished
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function resets the statistics counters for the given
│ │ │ │ queue, and restarts tracking from the moment the function was called.
│ │ │ │ This function is also used to create intialize a queue.
│ │ │ │
function::raise —
│ │ │ │ raise a signal in the current thread
│ │ │ │
Synopsis
│ │ │ │ raise(signo:long)
│ │ │ │ -
Arguments
signo
│ │ │ │ +
Arguments
signo
│ │ │ │ signal number
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function calls the kernel send_sig routine on
│ │ │ │ the current thread, with the given raw unchecked signal number.
│ │ │ │ It may raise an error if send_sig failed.
│ │ │ │ It requires guru mode.
│ │ │ │
function::register —
│ │ │ │ Return the signed value of the named CPU register
│ │ │ │
Synopsis
│ │ │ │ register:long(name:string)
│ │ │ │ -
Arguments
name
│ │ │ │ +
Arguments
name
│ │ │ │ Name of the register to return
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Return the value of the named CPU register,
│ │ │ │ as it was saved when the current probe point was hit.
│ │ │ │ If the register is 32 bits, it is sign-extended to 64 bits.
│ │ │ │
│ │ │ │
│ │ │ │ For the i386 architecture, the following names are recognized.
│ │ │ │ (name1/name2 indicates that name1 and name2 are alternative names
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-registers-valid.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │
function::registers_valid —
│ │ │ │ Determines validity of register and u_register in current context
│ │ │ │
Synopsis
│ │ │ │ registers_valid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns 1 if register and u_register
│ │ │ │ can be used in the current context, or 0 otherwise.
│ │ │ │ For example, registers_valid returns 0
│ │ │ │ when called from a begin or end probe.
│ │ │ │
function::regparm —
│ │ │ │ Specify regparm value used to compile function
│ │ │ │
Synopsis
│ │ │ │ regparm(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ original regparm value
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Call this function with argument n before accessing function
│ │ │ │ arguments using the *_arg function is the function was build with the
│ │ │ │ gcc -mregparm=n option.
│ │ │ │
│ │ │ │
│ │ │ │ (The i386 kernel is built with \-mregparm=3, so systemtap considers
│ │ │ │ regparm(3) the default for kernel functions on that architecture.)
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-remote-id.html
│ │ │ │ @@ -1,14 +1,14 @@
│ │ │ │
function::remote_id —
│ │ │ │ The index of this instance in a remote execution.
│ │ │ │
Synopsis
│ │ │ │ remote_id:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a number 0..N, which is the unique
│ │ │ │ index of this particular script execution from a swarm of
│ │ │ │ “stap --remote A --remote B ...” runs, and is the same number
│ │ │ │ “stap --remote-prefix” would print. The function returns -1 if the
│ │ │ │ script was not launched with “stap --remote”, or if the remote
│ │ │ │ staprun/stapsh are older than version 1.7.
│ │ │ │
function::remote_uri —
│ │ │ │ The name of this instance in a remote execution.
│ │ │ │
Synopsis
│ │ │ │ remote_uri:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the remote host used to invoke
│ │ │ │ this particular script execution from a swarm of “stap --remote” runs.
│ │ │ │ It may not be unique among the swarm.
│ │ │ │ The function returns an empty string if the script was not launched with
│ │ │ │ “stap --remote”.
│ │ │ │
│ │ │ │ This function is used by the syscall tapset, and
│ │ │ │ returns a string. Set format equal to 1 for a decimal,
│ │ │ │ 2 for hex, 3 for octal.
│ │ │ │
│ │ │ │
│ │ │ │ Note that this function is preferred over returnstr.
│ │ │ │
function::returnstr —
│ │ │ │ Formats the return value as a string
│ │ │ │
Synopsis
│ │ │ │ returnstr:string(format:long)
│ │ │ │ -
Arguments
format
│ │ │ │ +
Arguments
format
│ │ │ │ Variable to determine return type base value
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function is used by the nd_syscall tapset, and
│ │ │ │ returns a string. Set format equal to 1 for a decimal,
│ │ │ │ 2 for hex, 3 for octal.
│ │ │ │
│ │ │ │
│ │ │ │ Note that this function should only be used in dwarfless probes
│ │ │ │ (i.e. 'kprobe.function(“foo”)'). Other probes should use
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-returnval.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │
function::returnval —
│ │ │ │ Possible return value of probed function
│ │ │ │
Synopsis
│ │ │ │ returnval:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Return the value of the register in which function values
│ │ │ │ are typically returned. Can be used in probes where $return isn't
│ │ │ │ available. This is only a guess of the actual return value and can be
│ │ │ │ totally wrong. Normally only used in dwarfless probes.
│ │ │ │
│ │ │ │ The string representation of limit
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the number associated
│ │ │ │ with the given string, such as 0 for the string RLIMIT_CPU, or
│ │ │ │ -1 for an out-of-range value.
│ │ │ │
function::sa_handler_str —
│ │ │ │ Returns the string representation of an sa_handler
│ │ │ │
Synopsis
│ │ │ │ sa_handler_str(handler:)
│ │ │ │ -
Arguments
handler
│ │ │ │ +
Arguments
handler
│ │ │ │ the sa_handler to convert to string.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the string representation of an sa_handler.
│ │ │ │ If it is not SIG_DFL, SIG_IGN or SIG_ERR, it will return the address
│ │ │ │ of the handler.
│ │ │ │
probe::scheduler.ctxswitch —
│ │ │ │ A context switch is occuring.
│ │ │ │ -
Synopsis
scheduler.ctxswitch
Values
next_tid
│ │ │ │ - The TID of the process to be switched in
│ │ │ │ -
next_task_name
│ │ │ │ - The name of the process to be switched in
│ │ │ │ -
prev_pid
│ │ │ │ - The PID of the process to be switched out
│ │ │ │ -
prev_priority
│ │ │ │ - The priority of the process to be switched out
│ │ │ │ +
Synopsis
scheduler.ctxswitch
Values
prev_tid
│ │ │ │ + The TID of the process to be switched out
│ │ │ │
nexttsk_state
│ │ │ │ the state of the process to be switched in
│ │ │ │ +
prev_priority
│ │ │ │ + The priority of the process to be switched out
│ │ │ │
prevtsk_state
│ │ │ │ the state of the process to be switched out
│ │ │ │ +
next_priority
│ │ │ │ + The priority of the process to be switched in
│ │ │ │ +
next_tid
│ │ │ │ + The TID of the process to be switched in
│ │ │ │ +
prev_pid
│ │ │ │ + The PID of the process to be switched out
│ │ │ │
name
│ │ │ │ name of the probe point
│ │ │ │
next_pid
│ │ │ │ The PID of the process to be switched in
│ │ │ │ -
next_priority
│ │ │ │ - The priority of the process to be switched in
│ │ │ │
prev_task_name
│ │ │ │ The name of the process to be switched out
│ │ │ │ -
prev_tid
│ │ │ │ - The TID of the process to be switched out
│ │ │ │ +
next_task_name
│ │ │ │ + The name of the process to be switched in
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,32 +2,32 @@
│ │ │ │ │ Prev Chapter 8. Scheduler Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::scheduler.ctxswitch — A context switch is occuring.
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ scheduler.ctxswitch
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - next_tid
│ │ │ │ │ - The TID of the process to be switched in
│ │ │ │ │ - next_task_name
│ │ │ │ │ - The name of the process to be switched in
│ │ │ │ │ - prev_pid
│ │ │ │ │ - The PID of the process to be switched out
│ │ │ │ │ - prev_priority
│ │ │ │ │ - The priority of the process to be switched out
│ │ │ │ │ + prev_tid
│ │ │ │ │ + The TID of the process to be switched out
│ │ │ │ │ nexttsk_state
│ │ │ │ │ the state of the process to be switched in
│ │ │ │ │ + prev_priority
│ │ │ │ │ + The priority of the process to be switched out
│ │ │ │ │ prevtsk_state
│ │ │ │ │ the state of the process to be switched out
│ │ │ │ │ + next_priority
│ │ │ │ │ + The priority of the process to be switched in
│ │ │ │ │ + next_tid
│ │ │ │ │ + The TID of the process to be switched in
│ │ │ │ │ + prev_pid
│ │ │ │ │ + The PID of the process to be switched out
│ │ │ │ │ name
│ │ │ │ │ name of the probe point
│ │ │ │ │ next_pid
│ │ │ │ │ The PID of the process to be switched in
│ │ │ │ │ - next_priority
│ │ │ │ │ - The priority of the process to be switched in
│ │ │ │ │ prev_task_name
│ │ │ │ │ The name of the process to be switched out
│ │ │ │ │ - prev_tid
│ │ │ │ │ - The TID of the process to be switched out
│ │ │ │ │ + next_task_name
│ │ │ │ │ + The name of the process to be switched in
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::scheduler.cpu_on Home probe::scheduler.kthread_stop
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-scheduler-kthread-stop-return.html
│ │ │ │ @@ -1,7 +1,7 @@
│ │ │ │ probe::scheduler.kthread_stop.return
│ │ │ │ The kernel address to write the char to
│ │ │ │
val
│ │ │ │ The char which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the char value to a given kernel memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The kernel address to write the int to
│ │ │ │
val
│ │ │ │ The int which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the int value to a given kernel memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The kernel address to write the long to
│ │ │ │
val
│ │ │ │ The long which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the long value to a given kernel memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The kernel address to write the pointer to
│ │ │ │
val
│ │ │ │ The pointer which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the pointer value to a given kernel memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The kernel address to write the short to
│ │ │ │
val
│ │ │ │ The short which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the short value to a given kernel memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The kernel address to write the string to
│ │ │ │
n
│ │ │ │ The maximum length of the string
│ │ │ │
val
│ │ │ │ The string which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the given string up to a maximum given length to a
│ │ │ │ given kernel memory address. Reports an error on string copy fault.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The kernel address to write the string to
│ │ │ │
val
│ │ │ │ The string which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the given string to a given kernel
│ │ │ │ memory address. Reports an error on string copy fault.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
function::set_long_arg —
│ │ │ │ Set argument as signed long
│ │ │ │
Synopsis
│ │ │ │ set_long_arg(n:long,v:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ index of argument to set
│ │ │ │
v
│ │ │ │ value to set
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Set the value of argument n as a signed long.
│ │ │ │ On architectures where a long is 32 bits, the value is sign-extended
│ │ │ │ to 64 bits.
│ │ │ │
function::set_ulong_arg —
│ │ │ │ Set function argument as unsigned long
│ │ │ │
Synopsis
│ │ │ │ set_ulong_arg(n:long,v:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ index of argument to return
│ │ │ │
v
│ │ │ │ value to set
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Set the value of argument n as an unsigned long.
│ │ │ │ On architectures where a long is 32 bits, the value is zero-extended
│ │ │ │ to 64 bits.
│ │ │ │
│ │ │ │ The user address to write the char to
│ │ │ │
val
│ │ │ │ The char which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the char value to a given user memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the int to
│ │ │ │
val
│ │ │ │ The int which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the int value to a given user memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the long to
│ │ │ │
val
│ │ │ │ The long which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the long value to a given user memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the pointer to
│ │ │ │
val
│ │ │ │ The pointer which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the pointer value to a given user memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the short to
│ │ │ │
val
│ │ │ │ The short which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the short value to a given user memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the string to
│ │ │ │
val
│ │ │ │ The string which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the given string to a given user memory address.
│ │ │ │ Reports a warning on string copy fault.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the string to
│ │ │ │
n
│ │ │ │ The maximum length of the string
│ │ │ │
val
│ │ │ │ The string which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the given string up to a maximum given length to a given
│ │ │ │ user memory address. Reports an error on string copy fault.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
│ │ │ │ The user address to write the string to
│ │ │ │
val
│ │ │ │ The string which is to be written
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Writes the given string to a given user memory address.
│ │ │ │ Reports an error when writing to the given address fails.
│ │ │ │ Requires the use of guru mode (-g).
│ │ │ │
function::sid —
│ │ │ │ Returns the session ID of the current process
│ │ │ │
Synopsis
│ │ │ │ sid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The session ID of a process is the process group ID
│ │ │ │ of the session leader. Session ID is stored in the signal_struct
│ │ │ │ since Kernel 2.6.0.
│ │ │ │
probe::signal.do_action —
│ │ │ │ Examining or changing a signal action
│ │ │ │ -
Synopsis
signal.do_action
Values
sig
│ │ │ │ +
Synopsis
signal.do_action
Values
sig_name
│ │ │ │ + A string representation of the signal
│ │ │ │ +
sa_handler
│ │ │ │ + The new handler of the signal
│ │ │ │ +
sig
│ │ │ │ The signal to be examined/changed
│ │ │ │ +
sigact_addr
│ │ │ │ + The address of the new sigaction
│ │ │ │ + struct associated with the signal
│ │ │ │
name
│ │ │ │ Name of the probe point
│ │ │ │ -
sa_handler
│ │ │ │ - The new handler of the signal
│ │ │ │
sa_mask
│ │ │ │ The new mask of the signal
│ │ │ │ -
sig_name
│ │ │ │ - A string representation of the signal
│ │ │ │
oldsigact_addr
│ │ │ │ The address of the old sigaction
│ │ │ │ struct associated with the signal
│ │ │ │ -
sigact_addr
│ │ │ │ - The address of the new sigaction
│ │ │ │ - struct associated with the signal
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,24 +2,24 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.do_action — Examining or changing a signal action
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.do_action
│ │ │ │ │ ***** Values *****
│ │ │ │ │ + sig_name
│ │ │ │ │ + A string representation of the signal
│ │ │ │ │ + sa_handler
│ │ │ │ │ + The new handler of the signal
│ │ │ │ │ sig
│ │ │ │ │ The signal to be examined/changed
│ │ │ │ │ + sigact_addr
│ │ │ │ │ + The address of the new sigaction struct associated with the signal
│ │ │ │ │ name
│ │ │ │ │ Name of the probe point
│ │ │ │ │ - sa_handler
│ │ │ │ │ - The new handler of the signal
│ │ │ │ │ sa_mask
│ │ │ │ │ The new mask of the signal
│ │ │ │ │ - sig_name
│ │ │ │ │ - A string representation of the signal
│ │ │ │ │ oldsigact_addr
│ │ │ │ │ The address of the old sigaction struct associated with the signal
│ │ │ │ │ - sigact_addr
│ │ │ │ │ - The address of the new sigaction struct associated with the signal
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.checkperm.return Home probe::signal.do_action.return
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-flush.html
│ │ │ │ @@ -1,13 +1,13 @@
│ │ │ │ probe::signal.flush
│ │ │ │ The size of the user-space signal set
│ │ │ │
sigset_add
│ │ │ │ The address of the user-space signal set
│ │ │ │ (sigset_t)
│ │ │ │
name
│ │ │ │ Name of the probe point
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This probe is used to examine a set of signals pending for delivery
│ │ │ │ to a specific thread. This normally occurs when the
│ │ │ │ do_sigpending kernel function is executed.
│ │ │ │
│ │ │ │ - The old address of the signal set
│ │ │ │ - (sigset_t)
│ │ │ │ -
sigset
│ │ │ │ +
Synopsis
signal.procmask
Values
sigset
│ │ │ │ The actual value to be set for sigset_t
│ │ │ │ (correct?)
│ │ │ │
how
│ │ │ │ Indicates how to change the blocked signals; possible values are
│ │ │ │ SIG_BLOCK=0 (for blocking signals),
│ │ │ │ SIG_UNBLOCK=1 (for unblocking signals), and
│ │ │ │ SIG_SETMASK=2 for setting the signal mask.
│ │ │ │
sigset_addr
│ │ │ │ The address of the signal set (sigset_t)
│ │ │ │ to be implemented
│ │ │ │ +
oldsigset_addr
│ │ │ │ + The old address of the signal set
│ │ │ │ + (sigset_t)
│ │ │ │
name
│ │ │ │ Name of the probe point
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,22 +2,22 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.procmask — Examining or changing blocked signals
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.procmask
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - oldsigset_addr
│ │ │ │ │ - The old address of the signal set (sigset_t)
│ │ │ │ │ sigset
│ │ │ │ │ The actual value to be set for sigset_t (correct?)
│ │ │ │ │ how
│ │ │ │ │ Indicates how to change the blocked signals; possible values are
│ │ │ │ │ SIG_BLOCK=0 (for blocking signals), SIG_UNBLOCK=1 (for unblocking
│ │ │ │ │ signals), and SIG_SETMASK=2 for setting the signal mask.
│ │ │ │ │ sigset_addr
│ │ │ │ │ The address of the signal set (sigset_t) to be implemented
│ │ │ │ │ + oldsigset_addr
│ │ │ │ │ + The old address of the signal set (sigset_t)
│ │ │ │ │ name
│ │ │ │ │ Name of the probe point
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.pending.return Home probe::signal.procmask.return
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-send-return.html
│ │ │ │ @@ -1,20 +1,20 @@
│ │ │ │ probe::signal.send.return
probe::signal.send.return —
│ │ │ │ Signal being sent to a process completed (deprecated in SystemTap 2.1)
│ │ │ │ -
Synopsis
signal.send.return
Values
retstr
│ │ │ │ +
Synopsis
signal.send.return
Values
shared
│ │ │ │ + Indicates whether the sent signal is shared by the thread group.
│ │ │ │ +
retstr
│ │ │ │ The return value to either __group_send_sig_info, specific_send_sig_info, or send_sigqueue
│ │ │ │
name
│ │ │ │ The name of the function used to send out the signal
│ │ │ │ -
shared
│ │ │ │ - Indicates whether the sent signal is shared by the thread group.
│ │ │ │
send2queue
│ │ │ │ Indicates whether the sent signal was sent to an existing sigqueue
│ │ │ │ -
Context
│ │ │ │ +
Context
│ │ │ │ The signal's sender. (correct?)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Possible __group_send_sig_info and
│ │ │ │ specific_send_sig_info return values are as follows;
│ │ │ │
│ │ │ │
│ │ │ │ 0 -- The signal is successfully sent to a process,
│ │ │ │ which means that, (1) the signal was ignored by the receiving process,
│ │ │ │ (2) this is a non-RT signal and the system already has one queued, and
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -3,21 +3,21 @@
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.send.return — Signal being sent to a process completed
│ │ │ │ │ (deprecated in SystemTap 2.1)
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.send.return
│ │ │ │ │ ***** Values *****
│ │ │ │ │ + shared
│ │ │ │ │ + Indicates whether the sent signal is shared by the thread group.
│ │ │ │ │ retstr
│ │ │ │ │ The return value to either __group_send_sig_info, specific_send_sig_info,
│ │ │ │ │ or send_sigqueue
│ │ │ │ │ name
│ │ │ │ │ The name of the function used to send out the signal
│ │ │ │ │ - shared
│ │ │ │ │ - Indicates whether the sent signal is shared by the thread group.
│ │ │ │ │ send2queue
│ │ │ │ │ Indicates whether the sent signal was sent to an existing sigqueue
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The signal's sender. (correct?)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ Possible __group_send_sig_info and specific_send_sig_info return values are as
│ │ │ │ │ follows;
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-send-sig-queue-return.html
│ │ │ │ @@ -1,7 +1,7 @@
│ │ │ │
probe::signal.send_sig_queue —
│ │ │ │ Queuing a signal to a process
│ │ │ │ -
Synopsis
signal.send_sig_queue
Values
sig
│ │ │ │ - The queued signal
│ │ │ │ -
pid_name
│ │ │ │ +
Synopsis
signal.send_sig_queue
Values
pid_name
│ │ │ │ Name of the process to which the signal is queued
│ │ │ │ -
sig_pid
│ │ │ │ - The PID of the process to which the signal is queued
│ │ │ │ -
name
│ │ │ │ - Name of the probe point
│ │ │ │
sig_name
│ │ │ │ A string representation of the signal
│ │ │ │ +
sig_pid
│ │ │ │ + The PID of the process to which the signal is queued
│ │ │ │ +
sig
│ │ │ │ + The queued signal
│ │ │ │
sigqueue_addr
│ │ │ │ The address of the signal queue
│ │ │ │ +
name
│ │ │ │ + Name of the probe point
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,22 +2,22 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.send_sig_queue — Queuing a signal to a process
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.send_sig_queue
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sig
│ │ │ │ │ - The queued signal
│ │ │ │ │ pid_name
│ │ │ │ │ Name of the process to which the signal is queued
│ │ │ │ │ - sig_pid
│ │ │ │ │ - The PID of the process to which the signal is queued
│ │ │ │ │ - name
│ │ │ │ │ - Name of the probe point
│ │ │ │ │ sig_name
│ │ │ │ │ A string representation of the signal
│ │ │ │ │ + sig_pid
│ │ │ │ │ + The PID of the process to which the signal is queued
│ │ │ │ │ + sig
│ │ │ │ │ + The queued signal
│ │ │ │ │ sigqueue_addr
│ │ │ │ │ The address of the signal queue
│ │ │ │ │ + name
│ │ │ │ │ + Name of the probe point
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.send.return Home probe::signal.send_sig_queue.return
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-send.html
│ │ │ │ @@ -1,26 +1,26 @@
│ │ │ │ probe::signal.send
probe::signal.send —
│ │ │ │ Signal being sent to a process
│ │ │ │ -
Synopsis
signal.send
Values
pid_name
│ │ │ │ - The name of the signal recipient
│ │ │ │ -
sig
│ │ │ │ - The number of the signal
│ │ │ │ -
task
│ │ │ │ - A task handle to the signal recipient
│ │ │ │ -
si_code
│ │ │ │ - Indicates the signal type
│ │ │ │ -
sig_name
│ │ │ │ - A string representation of the signal
│ │ │ │ -
name
│ │ │ │ - The name of the function used to send out the signal
│ │ │ │ -
sig_pid
│ │ │ │ - The PID of the process receiving the signal
│ │ │ │ -
send2queue
│ │ │ │ +
Synopsis
signal.send
Values
send2queue
│ │ │ │ Indicates whether the signal is sent to an existing
│ │ │ │ sigqueue (deprecated in SystemTap 2.1)
│ │ │ │ +
name
│ │ │ │ + The name of the function used to send out the signal
│ │ │ │ +
si_code
│ │ │ │ + Indicates the signal type
│ │ │ │
shared
│ │ │ │ Indicates whether the signal is shared by the thread group
│ │ │ │ +
task
│ │ │ │ + A task handle to the signal recipient
│ │ │ │ +
sig
│ │ │ │ + The number of the signal
│ │ │ │
sinfo
│ │ │ │ The address of siginfo struct
│ │ │ │ -
Context
│ │ │ │ +
sig_pid
│ │ │ │ + The PID of the process receiving the signal
│ │ │ │ +
sig_name
│ │ │ │ + A string representation of the signal
│ │ │ │ +
pid_name
│ │ │ │ + The name of the signal recipient
│ │ │ │ +
Context
│ │ │ │ The signal's sender.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,33 +2,33 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.send — Signal being sent to a process
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.send
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - pid_name
│ │ │ │ │ - The name of the signal recipient
│ │ │ │ │ - sig
│ │ │ │ │ - The number of the signal
│ │ │ │ │ - task
│ │ │ │ │ - A task handle to the signal recipient
│ │ │ │ │ - si_code
│ │ │ │ │ - Indicates the signal type
│ │ │ │ │ - sig_name
│ │ │ │ │ - A string representation of the signal
│ │ │ │ │ - name
│ │ │ │ │ - The name of the function used to send out the signal
│ │ │ │ │ - sig_pid
│ │ │ │ │ - The PID of the process receiving the signal
│ │ │ │ │ send2queue
│ │ │ │ │ Indicates whether the signal is sent to an existing sigqueue (deprecated
│ │ │ │ │ in SystemTap 2.1)
│ │ │ │ │ + name
│ │ │ │ │ + The name of the function used to send out the signal
│ │ │ │ │ + si_code
│ │ │ │ │ + Indicates the signal type
│ │ │ │ │ shared
│ │ │ │ │ Indicates whether the signal is shared by the thread group
│ │ │ │ │ + task
│ │ │ │ │ + A task handle to the signal recipient
│ │ │ │ │ + sig
│ │ │ │ │ + The number of the signal
│ │ │ │ │ sinfo
│ │ │ │ │ The address of siginfo struct
│ │ │ │ │ + sig_pid
│ │ │ │ │ + The PID of the process receiving the signal
│ │ │ │ │ + sig_name
│ │ │ │ │ + A string representation of the signal
│ │ │ │ │ + pid_name
│ │ │ │ │ + The name of the signal recipient
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The signal's sender.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.procmask.return Home probe::signal.send.return
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-str.html
│ │ │ │ @@ -1,7 +1,7 @@
│ │ │ │ function::signal_str
probe::signal.sys_tgkill —
│ │ │ │ Sending kill signal to a thread group
│ │ │ │ -
Synopsis
signal.sys_tgkill
Values
tgid
│ │ │ │ - The thread group ID of the thread receiving the kill signal
│ │ │ │ +
Synopsis
signal.sys_tgkill
Values
sig
│ │ │ │ + The specific kill signal sent to the process
│ │ │ │ +
sig_pid
│ │ │ │ + The PID of the thread receiving the kill signal
│ │ │ │
pid_name
│ │ │ │ The name of the signal recipient
│ │ │ │ -
sig
│ │ │ │ - The specific kill signal sent to the process
│ │ │ │ -
task
│ │ │ │ - A task handle to the signal recipient
│ │ │ │
sig_name
│ │ │ │ A string representation of the signal
│ │ │ │
name
│ │ │ │ Name of the probe point
│ │ │ │ -
sig_pid
│ │ │ │ - The PID of the thread receiving the kill signal
│ │ │ │ -
Description
│ │ │ │ +
task
│ │ │ │ + A task handle to the signal recipient
│ │ │ │ +
tgid
│ │ │ │ + The thread group ID of the thread receiving the kill signal
│ │ │ │ +
Description
│ │ │ │ The tgkill call is similar to tkill,
│ │ │ │ except that it also allows the caller to specify the thread group ID of
│ │ │ │ the thread to be signalled. This protects against TID reuse.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,28 +2,28 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.sys_tgkill — Sending kill signal to a thread group
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.sys_tgkill
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - tgid
│ │ │ │ │ - The thread group ID of the thread receiving the kill signal
│ │ │ │ │ - pid_name
│ │ │ │ │ - The name of the signal recipient
│ │ │ │ │ sig
│ │ │ │ │ The specific kill signal sent to the process
│ │ │ │ │ - task
│ │ │ │ │ - A task handle to the signal recipient
│ │ │ │ │ + sig_pid
│ │ │ │ │ + The PID of the thread receiving the kill signal
│ │ │ │ │ + pid_name
│ │ │ │ │ + The name of the signal recipient
│ │ │ │ │ sig_name
│ │ │ │ │ A string representation of the signal
│ │ │ │ │ name
│ │ │ │ │ Name of the probe point
│ │ │ │ │ - sig_pid
│ │ │ │ │ - The PID of the thread receiving the kill signal
│ │ │ │ │ + task
│ │ │ │ │ + A task handle to the signal recipient
│ │ │ │ │ + tgid
│ │ │ │ │ + The thread group ID of the thread receiving the kill signal
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The tgkill call is similar to tkill, except that it also allows the caller to
│ │ │ │ │ specify the thread group ID of the thread to be signalled. This protects
│ │ │ │ │ against TID reuse.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.send_sig_queue.return Home probe::signal.sys_tgkill.return
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-sys-tkill.html
│ │ │ │ @@ -1,20 +1,20 @@
│ │ │ │ probe::signal.sys_tkill
probe::signal.sys_tkill —
│ │ │ │ Sending a kill signal to a thread
│ │ │ │ -
Synopsis
signal.sys_tkill
Values
pid_name
│ │ │ │ - The name of the signal recipient
│ │ │ │ +
Synopsis
signal.sys_tkill
Values
name
│ │ │ │ + Name of the probe point
│ │ │ │
task
│ │ │ │ A task handle to the signal recipient
│ │ │ │
sig
│ │ │ │ The specific signal sent to the process
│ │ │ │
sig_name
│ │ │ │ A string representation of the signal
│ │ │ │ +
pid_name
│ │ │ │ + The name of the signal recipient
│ │ │ │
sig_pid
│ │ │ │ The PID of the process receiving the kill signal
│ │ │ │ -
name
│ │ │ │ - Name of the probe point
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The tkill call is analogous to kill(2),
│ │ │ │ except that it also allows a process within a specific thread group to
│ │ │ │ be targeted. Such processes are targeted through their unique
│ │ │ │ thread IDs (TID).
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,26 +2,26 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.sys_tkill — Sending a kill signal to a thread
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.sys_tkill
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - pid_name
│ │ │ │ │ - The name of the signal recipient
│ │ │ │ │ + name
│ │ │ │ │ + Name of the probe point
│ │ │ │ │ task
│ │ │ │ │ A task handle to the signal recipient
│ │ │ │ │ sig
│ │ │ │ │ The specific signal sent to the process
│ │ │ │ │ sig_name
│ │ │ │ │ A string representation of the signal
│ │ │ │ │ + pid_name
│ │ │ │ │ + The name of the signal recipient
│ │ │ │ │ sig_pid
│ │ │ │ │ The PID of the process receiving the kill signal
│ │ │ │ │ - name
│ │ │ │ │ - Name of the probe point
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The tkill call is analogous to kill(2), except that it also allows a process
│ │ │ │ │ within a specific thread group to be targeted. Such processes are targeted
│ │ │ │ │ through their unique thread IDs (TID).
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.sys_tgkill.return Home probe::signal.syskill
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-signal-syskill-return.html
│ │ │ │ @@ -1,5 +1,5 @@
│ │ │ │ probe::signal.syskill.return
probe::signal.wakeup —
│ │ │ │ Sleeping process being wakened for signal
│ │ │ │ -
Synopsis
signal.wakeup
Values
state_mask
│ │ │ │ - A string representation indicating the mask
│ │ │ │ - of task states to wake. Possible values are
│ │ │ │ - TASK_INTERRUPTIBLE, TASK_STOPPED,
│ │ │ │ - TASK_TRACED, TASK_WAKEKILL, and TASK_INTERRUPTIBLE.
│ │ │ │ -
resume
│ │ │ │ +
Synopsis
signal.wakeup
Values
resume
│ │ │ │ Indicates whether to wake up a task in a
│ │ │ │ STOPPED or TRACED state
│ │ │ │ -
pid_name
│ │ │ │ - Name of the process to wake
│ │ │ │
sig_pid
│ │ │ │ The PID of the process to wake
│ │ │ │ +
pid_name
│ │ │ │ + Name of the process to wake
│ │ │ │ +
state_mask
│ │ │ │ + A string representation indicating the mask
│ │ │ │ + of task states to wake. Possible values are
│ │ │ │ + TASK_INTERRUPTIBLE, TASK_STOPPED,
│ │ │ │ + TASK_TRACED, TASK_WAKEKILL, and TASK_INTERRUPTIBLE.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,20 +2,20 @@
│ │ │ │ │ Prev Chapter 17. Signal Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::signal.wakeup — Sleeping process being wakened for signal
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ signal.wakeup
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - state_mask
│ │ │ │ │ - A string representation indicating the mask of task states to wake.
│ │ │ │ │ - Possible values are TASK_INTERRUPTIBLE, TASK_STOPPED, TASK_TRACED,
│ │ │ │ │ - TASK_WAKEKILL, and TASK_INTERRUPTIBLE.
│ │ │ │ │ resume
│ │ │ │ │ Indicates whether to wake up a task in a STOPPED or TRACED state
│ │ │ │ │ - pid_name
│ │ │ │ │ - Name of the process to wake
│ │ │ │ │ sig_pid
│ │ │ │ │ The PID of the process to wake
│ │ │ │ │ + pid_name
│ │ │ │ │ + Name of the process to wake
│ │ │ │ │ + state_mask
│ │ │ │ │ + A string representation indicating the mask of task states to wake.
│ │ │ │ │ + Possible values are TASK_INTERRUPTIBLE, TASK_STOPPED, TASK_TRACED,
│ │ │ │ │ + TASK_WAKEKILL, and TASK_INTERRUPTIBLE.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::signal.systkill.return Home Chapter 18. Errno Tapset
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-sigset-mask-str.html
│ │ │ │ @@ -1,7 +1,7 @@
│ │ │ │ function::sigset_mask_str
function::speculation —
│ │ │ │ Allocate a new id for speculative output
│ │ │ │
Synopsis
│ │ │ │ speculation:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │
│ │ │ │
│ │ │ │ The speculation function is called when a new speculation buffer is needed.
│ │ │ │ It returns an id for the speculative output.
│ │ │ │ There can be multiple threads being speculated on concurrently.
│ │ │ │ This id is used by other speculation functions to keep the threads
│ │ │ │ separate.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-sprint-backtrace.html
│ │ │ │ @@ -1,14 +1,14 @@
│ │ │ │
function::sprint_backtrace —
│ │ │ │ Return stack back trace as string
│ │ │ │
Synopsis
│ │ │ │ sprint_backtrace:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │
│ │ │ │
│ │ │ │ Returns a simple (kernel) backtrace. One line per address.
│ │ │ │ Includes the symbol name (or hex address if symbol
│ │ │ │ couldn't be resolved) and module name (if found). Includes the
│ │ │ │ offset from the start of the function if found, otherwise the
│ │ │ │ offset will be added to the module (if found, between
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-sprint-loadavg.html
│ │ │ │ @@ -1,10 +1,10 @@
│ │ │ │
function::sprint_stack —
│ │ │ │ Return stack for kernel addresses from string
│ │ │ │
Synopsis
│ │ │ │ sprint_stack:string(stk:string)
│ │ │ │ -
Arguments
stk
│ │ │ │ +
Arguments
stk
│ │ │ │ String with list of hexadecimal (kernel) addresses
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Perform a symbolic lookup of the addresses in the given string,
│ │ │ │ which is assumed to be the result of a prior call to backtrace.
│ │ │ │
│ │ │ │
│ │ │ │ Returns a simple backtrace from the given hex string. One line per
│ │ │ │ address. Includes the symbol name (or hex address if symbol
│ │ │ │ couldn't be resolved) and module name (if found). Includes the
│ │ │ │ offset from the start of the function if found, otherwise the
│ │ │ │ offset will be added to the module (if found, between
│ │ │ │ brackets). Returns the backtrace as string (each line terminated by
│ │ │ │ a newline character). Note that the returned stack will be
│ │ │ │ truncated to MAXSTRINGLEN, to print fuller and richer stacks use
│ │ │ │ print_stack.
│ │ │ │ -
NOTE
│ │ │ │ +
NOTE
│ │ │ │ it is recommended to use sprint_syms instead of this function.
│ │ │ │
function::sprint_syms —
│ │ │ │ Return stack for kernel addresses from string
│ │ │ │
Synopsis
│ │ │ │ sprint_syms(callers:string)
│ │ │ │ -
Arguments
callers
│ │ │ │ +
Arguments
callers
│ │ │ │ String with list of hexadecimal (kernel) addresses
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Perform a symbolic lookup of the addresses in the given string,
│ │ │ │ which are assumed to be the result of a prior calls to stack,
│ │ │ │ callers, and similar functions.
│ │ │ │
│ │ │ │
│ │ │ │ Returns a simple backtrace from the given hex string. One line per
│ │ │ │ address. Includes the symbol name (or hex address if symbol
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-sprint-ubacktrace.html
│ │ │ │ @@ -1,25 +1,25 @@
│ │ │ │
function::sprint_ubacktrace —
│ │ │ │ Return stack back trace for current user-space task as string.
│ │ │ │
Synopsis
│ │ │ │ sprint_ubacktrace:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │
│ │ │ │
│ │ │ │ Returns a simple backtrace for the current task. One line per
│ │ │ │ address. Includes the symbol name (or hex address if symbol
│ │ │ │ couldn't be resolved) and module name (if found). Includes the
│ │ │ │ offset from the start of the function if found, otherwise the
│ │ │ │ offset will be added to the module (if found, between
│ │ │ │ brackets). Returns the backtrace as string (each line terminated by
│ │ │ │ a newline character). Note that the returned stack will be
│ │ │ │ truncated to MAXSTRINGLEN, to print fuller and richer stacks use
│ │ │ │ print_ubacktrace. Equivalent to sprint_ustack(ubacktrace),
│ │ │ │ but more efficient (no need to translate between hex strings and
│ │ │ │ final backtrace string).
│ │ │ │ -
Note
│ │ │ │ +
Note
│ │ │ │ To get (full) backtraces for user space applications and shared
│ │ │ │ shared libraries not mentioned in the current script run stap with
│ │ │ │ -d /path/to/exe-or-so and/or add --ldd to load all needed unwind data.
│ │ │ │
│ │ │ │ String with list of hexadecimal addresses for the current task.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Perform a symbolic lookup of the addresses in the given string,
│ │ │ │ which is assumed to be the result of a prior call to
│ │ │ │ ubacktrace for the current task.
│ │ │ │
│ │ │ │
│ │ │ │ Returns a simple backtrace from the given hex string. One line per
│ │ │ │ address. Includes the symbol name (or hex address if symbol
│ │ │ │ couldn't be resolved) and module name (if found). Includes the
│ │ │ │ offset from the start of the function if found, otherwise the
│ │ │ │ offset will be added to the module (if found, between
│ │ │ │ brackets). Returns the backtrace as string (each line terminated by
│ │ │ │ a newline character). Note that the returned stack will be
│ │ │ │ truncated to MAXSTRINGLEN, to print fuller and richer stacks use
│ │ │ │ print_ustack.
│ │ │ │ -
NOTE
│ │ │ │ +
NOTE
│ │ │ │ it is recommended to use sprint_usyms instead of this function.
│ │ │ │
function::sprint_usyms —
│ │ │ │ Return stack for user addresses from string
│ │ │ │
Synopsis
│ │ │ │ sprint_usyms(callers:string)
│ │ │ │ -
Arguments
callers
│ │ │ │ +
Arguments
callers
│ │ │ │ String with list of hexadecimal (user) addresses
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Perform a symbolic lookup of the addresses in the given string,
│ │ │ │ which are assumed to be the result of a prior calls to ustack,
│ │ │ │ ucallers, and similar functions.
│ │ │ │
│ │ │ │
│ │ │ │ Returns a simple backtrace from the given hex string. One line per
│ │ │ │ address. Includes the symbol name (or hex address if symbol
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-stack-size.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │
function::stack —
│ │ │ │ Return address at given depth of kernel stack backtrace
│ │ │ │
Synopsis
│ │ │ │ stack:long(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ number of levels to descend in the stack.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Performs a simple (kernel) backtrace, and returns the
│ │ │ │ element at the specified position. The results of the backtrace itself
│ │ │ │ are cached, so that the backtrace computation is performed at most once
│ │ │ │ no matter how many times stack is called, or in what order.
│ │ │ │
probe::stap.cache_add_nss —
│ │ │ │ Add NSS (Network Security Services) information to cache
│ │ │ │ -
Synopsis
stap.cache_add_nss
Values
source_path
│ │ │ │ +
Synopsis
stap.cache_add_nss
Values
source_path
│ │ │ │ the path the .sgn file is coming from (incl filename)
│ │ │ │
dest_path
│ │ │ │ the path the .sgn file is coming from (incl filename)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Fires just before the file is actually moved. Note: stap must compiled
│ │ │ │ with NSS support; if moving the kernel module fails, this probe will
│ │ │ │ not fire.
│ │ │ │
function::stp_pid —
│ │ │ │ The process id of the stapio process
│ │ │ │
Synopsis
│ │ │ │ stp_pid:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the process id of the
│ │ │ │ stapio process that launched this script. There could be
│ │ │ │ other SystemTap scripts and stapio processes running on
│ │ │ │ the system.
│ │ │ │
│ │ │ │ The kernel address to retrieve the string from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the quoted string version of the given string,
│ │ │ │ with characters where any ASCII characters that are not printable
│ │ │ │ are replaced by the corresponding escape sequence in the returned
│ │ │ │ string. Note that the string will be surrounded by double quotes.
│ │ │ │
│ │ │ │ the string to fetch the character from
│ │ │ │
pos
│ │ │ │ the position to get the character from (first character is 0)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the character at a given position in
│ │ │ │ the string or zero if the string doesn't have as many characters. Reports
│ │ │ │ an error if pos is out of bounds.
│ │ │ │
│ │ │ │ This function returns location of the first occurence of string
│ │ │ │ s2 within s1, namely the return value is 0 in case s2 is a prefix of s1.
│ │ │ │ If s2 is not a substring of s1, then the return value is -1.
│ │ │ │
│ │ │ │ This function converts the string representation of a number to an integer.
│ │ │ │ The base parameter indicates the number base to assume for the string (eg. 16 for hex, 8 for octal, 2 for binary).
│ │ │ │
│ │ │ │ the string to take a substring from
│ │ │ │
start
│ │ │ │ starting position of the extracted string (first character is 0)
│ │ │ │
length
│ │ │ │ length of string to return
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the substring of the given string at the given
│ │ │ │ start position with the given length (or smaller if the length of the
│ │ │ │ original string is less than start + length, or length is bigger than
│ │ │ │ MAXSTRINGLEN).
│ │ │ │
probe::sunrpc.clnt.bind_new_program —
│ │ │ │ Bind a new RPC program to an existing client
│ │ │ │ -
Synopsis
sunrpc.clnt.bind_new_program
Values
prog
│ │ │ │ - the number of new RPC program
│ │ │ │ -
progname
│ │ │ │ +
Synopsis
sunrpc.clnt.bind_new_program
Values
progname
│ │ │ │ the name of new RPC program
│ │ │ │ -
old_progname
│ │ │ │ - the name of old RPC program
│ │ │ │ -
vers
│ │ │ │ - the version of new RPC program
│ │ │ │ -
old_prog
│ │ │ │ - the number of old RPC program
│ │ │ │ +
prog
│ │ │ │ + the number of new RPC program
│ │ │ │
servername
│ │ │ │ the server machine name
│ │ │ │
old_vers
│ │ │ │ the version of old RPC program
│ │ │ │ +
old_prog
│ │ │ │ + the number of old RPC program
│ │ │ │ +
vers
│ │ │ │ + the version of new RPC program
│ │ │ │ +
old_progname
│ │ │ │ + the name of old RPC program
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -3,24 +3,24 @@
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::sunrpc.clnt.bind_new_program — Bind a new RPC program to an existing
│ │ │ │ │ client
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ sunrpc.clnt.bind_new_program
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - prog
│ │ │ │ │ - the number of new RPC program
│ │ │ │ │ progname
│ │ │ │ │ the name of new RPC program
│ │ │ │ │ - old_progname
│ │ │ │ │ - the name of old RPC program
│ │ │ │ │ - vers
│ │ │ │ │ - the version of new RPC program
│ │ │ │ │ - old_prog
│ │ │ │ │ - the number of old RPC program
│ │ │ │ │ + prog
│ │ │ │ │ + the number of new RPC program
│ │ │ │ │ servername
│ │ │ │ │ the server machine name
│ │ │ │ │ old_vers
│ │ │ │ │ the version of old RPC program
│ │ │ │ │ + old_prog
│ │ │ │ │ + the number of old RPC program
│ │ │ │ │ + vers
│ │ │ │ │ + the version of new RPC program
│ │ │ │ │ + old_progname
│ │ │ │ │ + the name of old RPC program
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::netfilter.ip.pre_routing Home probe::sunrpc.clnt.call_async
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-sunrpc-clnt-call-async.html
│ │ │ │ @@ -1,25 +1,25 @@
│ │ │ │ probe::sunrpc.clnt.call_async
probe::sunrpc.sched.release_task —
│ │ │ │ Release all resources associated with a task
│ │ │ │ -
Synopsis
sunrpc.sched.release_task
Values
vers
│ │ │ │ - the program version in the RPC call
│ │ │ │ -
prot
│ │ │ │ +
Synopsis
sunrpc.sched.release_task
Values
prot
│ │ │ │ the IP protocol in the RPC call
│ │ │ │ -
tk_flags
│ │ │ │ - the flags of the task
│ │ │ │
xid
│ │ │ │ the transmission id in the RPC call
│ │ │ │
prog
│ │ │ │ the program number in the RPC call
│ │ │ │ -
Description
│ │ │ │ +
tk_flags
│ │ │ │ + the flags of the task
│ │ │ │ +
vers
│ │ │ │ + the program version in the RPC call
│ │ │ │ +
Description
│ │ │ │ rpc_release_task function might not be found for a particular kernel.
│ │ │ │ So, if we can't find it, just return '-1' for everything.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,23 +2,23 @@
│ │ │ │ │ Prev Chapter 13. Networking Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::sunrpc.sched.release_task — Release all resources associated with a task
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ sunrpc.sched.release_task
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - vers
│ │ │ │ │ - the program version in the RPC call
│ │ │ │ │ prot
│ │ │ │ │ the IP protocol in the RPC call
│ │ │ │ │ - tk_flags
│ │ │ │ │ - the flags of the task
│ │ │ │ │ xid
│ │ │ │ │ the transmission id in the RPC call
│ │ │ │ │ prog
│ │ │ │ │ the program number in the RPC call
│ │ │ │ │ + tk_flags
│ │ │ │ │ + the flags of the task
│ │ │ │ │ + vers
│ │ │ │ │ + the program version in the RPC call
│ │ │ │ │ ***** Description *****
│ │ │ │ │ rpc_release_task function might not be found for a particular kernel. So, if we
│ │ │ │ │ can't find it, just return '-1' for everything.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::sunrpc.sched.new_task Home probe::sunrpc.svc.create
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-sunrpc-svc-create.html
│ │ │ │ @@ -1,11 +1,11 @@
│ │ │ │ probe::sunrpc.svc.create
function::switch_file —
│ │ │ │ switch to the next output file
│ │ │ │
Synopsis
│ │ │ │ switch_file()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function sends a signal to the stapio process,
│ │ │ │ commanding it to rotate to the next output file when output is
│ │ │ │ sent to file(s).
│ │ │ │
function::symdata —
│ │ │ │ Return the kernel symbol and module offset for the address
│ │ │ │
Synopsis
│ │ │ │ symdata:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the (function) symbol name associated with the
│ │ │ │ given address if known, the offset from the start and size of the
│ │ │ │ symbol, plus module name (between brackets). If symbol is unknown,
│ │ │ │ but module is known, the offset inside the module, plus the size of
│ │ │ │ the module is added. If any element is not known it will be
│ │ │ │ omitted and if the symbol name is unknown it will return the hex
│ │ │ │ string for the given address.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-symfile.html
│ │ │ │ @@ -1,11 +1,11 @@
│ │ │ │
function::symfile —
│ │ │ │ Return the file name of a given address.
│ │ │ │
Synopsis
│ │ │ │ symfile:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the file name of the given address, if known. If the
│ │ │ │ file name cannot be found, the hex string representation of the address
│ │ │ │ will be returned.
│ │ │ │
function::symfileline —
│ │ │ │ Return the file name and line number of an address.
│ │ │ │
Synopsis
│ │ │ │ symfileline:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the file name and the (approximate) line number of the
│ │ │ │ given address, if known. If the file name or the line number cannot be
│ │ │ │ found, the hex string representation of the address will be returned.
│ │ │ │
function::symline —
│ │ │ │ Return the line number of an address.
│ │ │ │
Synopsis
│ │ │ │ symline:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the (approximate) line number of the given address, if
│ │ │ │ known. If the line number cannot be found, the hex string representation of
│ │ │ │ the address will be returned.
│ │ │ │
function::symname —
│ │ │ │ Return the kernel symbol associated with the given address
│ │ │ │
Synopsis
│ │ │ │ symname:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the (function) symbol name associated with the
│ │ │ │ given address if known. If not known it will return the hex string
│ │ │ │ representation of addr.
│ │ │ │
probe::syscall_any.return —
│ │ │ │ Record exit from a syscall
│ │ │ │ -
Synopsis
syscall_any.return
Values
retval
│ │ │ │ +
Synopsis
syscall_any.return
Values
syscall_nr
│ │ │ │ + number of the syscall
│ │ │ │ +
retval
│ │ │ │ return value of the syscall
│ │ │ │
name
│ │ │ │ name of the syscall
│ │ │ │ -
syscall_nr
│ │ │ │ - number of the syscall
│ │ │ │ -
Context
│ │ │ │ +
Context
│ │ │ │ The process performing the syscall
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The syscall_any.return probe point is designed to be a low overhead
│ │ │ │ that monitors all the syscalls returns via a kernel tracepoint.
│ │ │ │ Because of the breadth of syscalls it monitors it provides
│ │ │ │ no information about the syscall arguments, argstr string
│ │ │ │ representation of those arguments, or a string interpretation
│ │ │ │ of the return value (retval).
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,20 +2,20 @@
│ │ │ │ │ Prev Chapter 36. Syscall Any Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::syscall_any.return — Record exit from a syscall
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ syscall_any.return
│ │ │ │ │ ***** Values *****
│ │ │ │ │ + syscall_nr
│ │ │ │ │ + number of the syscall
│ │ │ │ │ retval
│ │ │ │ │ return value of the syscall
│ │ │ │ │ name
│ │ │ │ │ name of the syscall
│ │ │ │ │ - syscall_nr
│ │ │ │ │ - number of the syscall
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The process performing the syscall
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The syscall_any.return probe point is designed to be a low overhead that
│ │ │ │ │ monitors all the syscalls returns via a kernel tracepoint. Because of the
│ │ │ │ │ breadth of syscalls it monitors it provides no information about the syscall
│ │ │ │ │ arguments, argstr string representation of those arguments, or a string
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-syscall-any.html
│ │ │ │ @@ -1,16 +1,16 @@
│ │ │ │
probe::syscall_any —
│ │ │ │ Record entry into a syscall
│ │ │ │ -
Synopsis
syscall_any
Values
syscall_nr
│ │ │ │ +
Synopsis
syscall_any
Values
syscall_nr
│ │ │ │ number of the syscall
│ │ │ │
name
│ │ │ │ name of the syscall
│ │ │ │ -
Context
│ │ │ │ +
Context
│ │ │ │ The process performing the syscall
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The syscall_any probe point is designed to be a low overhead
│ │ │ │ that monitors all the syscalls entered via a kernel tracepoint.
│ │ │ │ Because of the breadth of syscalls it monitors it provides
│ │ │ │ no information about the syscall arguments or argstr string
│ │ │ │ representation of those arguments.
│ │ │ │
function::system —
│ │ │ │ Issue a command to the system
│ │ │ │
Synopsis
│ │ │ │ system(cmd:string)
│ │ │ │ -
Arguments
cmd
│ │ │ │ +
Arguments
cmd
│ │ │ │ the command to issue to the system
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function runs a command on the system. The
│ │ │ │ command is started in the background some time after the current
│ │ │ │ probe completes. The command is run with the same UID as the user
│ │ │ │ running the stap or staprun command. The runtime may impose a
│ │ │ │ relatively short length limit on the command string. Exceeding it
│ │ │ │ may print a warning.
│ │ │ │
function::target_set_pid —
│ │ │ │ Does pid descend from target process?
│ │ │ │
Synopsis
│ │ │ │ target_set_pid(pid:)
│ │ │ │ -
Arguments
pid
│ │ │ │ +
Arguments
pid
│ │ │ │ The pid of the process to query
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns whether the given process-id is
│ │ │ │ within the “target set”, that is whether it is a descendant of the
│ │ │ │ top-level target process.
│ │ │ │
function::target —
│ │ │ │ Return the process ID of the target process
│ │ │ │
Synopsis
│ │ │ │ target:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the process ID of the target
│ │ │ │ process. This is useful in conjunction with the -x PID or
│ │ │ │ -c CMD command-line options to stap. An example of its use is
│ │ │ │ to create scripts that filter on a specific process.
│ │ │ │
│ │ │ │ This function returns a string of hex addresses
│ │ │ │ that are a backtrace of the stack of a particular task
│ │ │ │ Output may be truncated as per maximum string length.
│ │ │ │ Deprecated in SystemTap 1.6.
│ │ │ │
function::task_current —
│ │ │ │ The current task_struct of the current task
│ │ │ │
Synopsis
│ │ │ │ task_current:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the task_struct representing the current process.
│ │ │ │ This address can be passed to the various task_*() functions to extract
│ │ │ │ more task-specific data.
│ │ │ │
function::task_parent —
│ │ │ │ The task_struct of the parent task
│ │ │ │
Synopsis
│ │ │ │ task_parent:long(task:long)
│ │ │ │ -
Arguments
task
│ │ │ │ +
Arguments
task
│ │ │ │ task_struct pointer
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns the parent task_struct of
│ │ │ │ the given task. This address can be passed to the various
│ │ │ │ task_*() functions to extract more task-specific data.
│ │ │ │
function::task_stime —
│ │ │ │ System time of the task
│ │ │ │ -
Synopsis
1) task_stime:long()
2) task_stime:long(tid:long)
Arguments
tid
│ │ │ │ +
Synopsis
1) task_stime:long()
2) task_stime:long(tid:long)
Arguments
tid
│ │ │ │ Thread id of the given task
│ │ │ │ -
Description
1) Returns the system time of the current task in cputime.
│ │ │ │ +
Description
1) Returns the system time of the current task in cputime.
│ │ │ │ Does not include any time used by other tasks in this process, nor
│ │ │ │ does it include any time of the children of this task.
2) Returns the system time of the given task in cputime,
│ │ │ │ or zero if the task doesn't exist.
│ │ │ │ Does not include any time used by other tasks in this process, nor
│ │ │ │ does it include any time of the children of this task.
│ │ │ │ Returns a human readable string showing the user and
│ │ │ │ system time the given task has used up to now. For example
│ │ │ │ “usr: 0m12.908s, sys: 1m6.851s”.
│ │ │ │
function::task_time_string —
│ │ │ │ Human readable string of task time usage
│ │ │ │
Synopsis
│ │ │ │ task_time_string:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns a human readable string showing the user and
│ │ │ │ system time the current task has used up to now. For example
│ │ │ │ “usr: 0m12.908s, sys: 1m6.851s”.
│ │ │ │
function::task_utime —
│ │ │ │ User time of the task
│ │ │ │ -
Synopsis
1) task_utime:long()
2) task_utime:long(tid:long)
Arguments
tid
│ │ │ │ +
Synopsis
1) task_utime:long()
2) task_utime:long(tid:long)
Arguments
tid
│ │ │ │ Thread id of the given task
│ │ │ │ -
Description
1) Returns the user time of the current task in cputime.
│ │ │ │ +
Description
1) Returns the user time of the current task in cputime.
│ │ │ │ Does not include any time used by other tasks in this process, nor
│ │ │ │ does it include any time of the children of this task.
2) Returns the user time of the given task in cputime,
│ │ │ │ or zero if the task doesn't exist.
│ │ │ │ Does not include any time used by other tasks in this process, nor
│ │ │ │ does it include any time of the children of this task.
probe::tcpmib.ActiveOpens —
│ │ │ │ Count an active opening of a socket
│ │ │ │ -
Synopsis
tcpmib.ActiveOpens
Values
sk
│ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
tcpmib.ActiveOpens
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global ActiveOpens (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_ACTIVEOPENS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.ActiveOpens — Count an active opening of a socket
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.ActiveOpens
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global ActiveOpens
│ │ │ │ │ (equivalent to SNMP's MIB TCP_MIB_ACTIVEOPENS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::linuxmib.TCPMemoryPressures Home probe::tcpmib.AttemptFails
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-AttemptFails.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::tcpmib.AttemptFails
probe::tcpmib.AttemptFails —
│ │ │ │ Count a failed attempt to open a socket
│ │ │ │ -
Synopsis
tcpmib.AttemptFails
Values
op
│ │ │ │ +
Synopsis
tcpmib.AttemptFails
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │
sk
│ │ │ │ pointer to the struct sock being acted on
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global AttemptFails (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_ATTEMPTFAILS)
│ │ │ │
probe::tcpmib.CurrEstab —
│ │ │ │ Update the count of open sockets
│ │ │ │ -
Synopsis
tcpmib.CurrEstab
Values
sk
│ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
tcpmib.CurrEstab
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global CurrEstab (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_CURRESTAB)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.CurrEstab — Update the count of open sockets
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.CurrEstab
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global CurrEstab (equivalent
│ │ │ │ │ to SNMP's MIB TCP_MIB_CURRESTAB)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::tcpmib.AttemptFails Home probe::tcpmib.EstabResets
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-EstabResets.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::tcpmib.EstabResets
probe::tcpmib.EstabResets —
│ │ │ │ Count the reset of a socket
│ │ │ │ -
Synopsis
tcpmib.EstabResets
Values
sk
│ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
tcpmib.EstabResets
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global EstabResets (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_ESTABRESETS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.EstabResets — Count the reset of a socket
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.EstabResets
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global EstabResets
│ │ │ │ │ (equivalent to SNMP's MIB TCP_MIB_ESTABRESETS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::tcpmib.CurrEstab Home probe::tcpmib.InSegs
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-InSegs.html
│ │ │ │ @@ -1,13 +1,13 @@
│ │ │ │ probe::tcpmib.InSegs
│ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ -
sk
│ │ │ │ +
Synopsis
tcpmib.InSegs
Values
sk
│ │ │ │ pointer to the struct sock being acted on
│ │ │ │ -
Description
│ │ │ │ +
op
│ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key (or ipmib_filter_key for tcp v4).
│ │ │ │ If the packet passes the filter is is
│ │ │ │ counted in the global InSegs (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_INSEGS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.InSegs — Count an incoming tcp segment
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.InSegs
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - op
│ │ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ │ sk
│ │ │ │ │ pointer to the struct sock being acted on
│ │ │ │ │ + op
│ │ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key (or
│ │ │ │ │ ipmib_filter_key for tcp v4). If the packet passes the filter is is counted in
│ │ │ │ │ the global InSegs (equivalent to SNMP's MIB TCP_MIB_INSEGS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::tcpmib.EstabResets Home probe::tcpmib.OutRsts
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-OutRsts.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::tcpmib.OutRsts
probe::tcpmib.OutRsts —
│ │ │ │ Count the sending of a reset packet
│ │ │ │ -
Synopsis
tcpmib.OutRsts
Values
sk
│ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
tcpmib.OutRsts
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global OutRsts (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_OUTRSTS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.OutRsts — Count the sending of a reset packet
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.OutRsts
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global OutRsts (equivalent to
│ │ │ │ │ SNMP's MIB TCP_MIB_OUTRSTS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::tcpmib.InSegs Home probe::tcpmib.OutSegs
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-OutSegs.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::tcpmib.OutSegs
probe::tcpmib.OutSegs —
│ │ │ │ Count the sending of a TCP segment
│ │ │ │ -
Synopsis
tcpmib.OutSegs
Values
op
│ │ │ │ +
Synopsis
tcpmib.OutSegs
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │
sk
│ │ │ │ pointer to the struct sock being acted on
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global OutSegs (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_OUTSEGS)
│ │ │ │
probe::tcpmib.PassiveOpens —
│ │ │ │ Count the passive creation of a socket
│ │ │ │ -
Synopsis
tcpmib.PassiveOpens
Values
sk
│ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ -
op
│ │ │ │ +
Synopsis
tcpmib.PassiveOpens
Values
op
│ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ -
Description
│ │ │ │ +
sk
│ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global PassiveOpens (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_PASSIVEOPENS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.PassiveOpens — Count the passive creation of a socket
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.PassiveOpens
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - sk
│ │ │ │ │ - pointer to the struct sock being acted on
│ │ │ │ │ op
│ │ │ │ │ value to be added to the counter (default value of 1)
│ │ │ │ │ + sk
│ │ │ │ │ + pointer to the struct sock being acted on
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global PassiveOpens
│ │ │ │ │ (equivalent to SNMP's MIB TCP_MIB_PASSIVEOPENS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::tcpmib.OutSegs Home probe::tcpmib.RetransSegs
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-RetransSegs.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::tcpmib.RetransSegs
probe::tcpmib.RetransSegs —
│ │ │ │ Count the retransmission of a TCP segment
│ │ │ │ -
Synopsis
tcpmib.RetransSegs
Values
op
│ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ -
sk
│ │ │ │ +
Synopsis
tcpmib.RetransSegs
Values
sk
│ │ │ │ pointer to the struct sock being acted on
│ │ │ │ -
Description
│ │ │ │ +
op
│ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ +
Description
│ │ │ │ The packet pointed to by skb is filtered by the function
│ │ │ │ tcpmib_filter_key. If the packet passes the filter is is
│ │ │ │ counted in the global RetransSegs (equivalent to SNMP's MIB
│ │ │ │ TCP_MIB_RETRANSSEGS)
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 15. SNMP Information Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::tcpmib.RetransSegs — Count the retransmission of a TCP segment
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ tcpmib.RetransSegs
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - op
│ │ │ │ │ - value to be added to the counter (default value of 1)
│ │ │ │ │ sk
│ │ │ │ │ pointer to the struct sock being acted on
│ │ │ │ │ + op
│ │ │ │ │ + value to be added to the counter (default value of 1)
│ │ │ │ │ ***** Description *****
│ │ │ │ │ The packet pointed to by skb is filtered by the function tcpmib_filter_key. If
│ │ │ │ │ the packet passes the filter is is counted in the global RetransSegs
│ │ │ │ │ (equivalent to SNMP's MIB TCP_MIB_RETRANSSEGS)
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::tcpmib.PassiveOpens Home Chapter 16. Kernel Process Tapset
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tcpmib-filter-key.html
│ │ │ │ @@ -1,15 +1,15 @@
│ │ │ │ function::tcpmib_filter_key
│ │ │ │ pointer to the struct sock being acted on
│ │ │ │
op
│ │ │ │ value to be counted if sk passes the filter
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function is a default filter function.
│ │ │ │ The user can replace this function with their own.
│ │ │ │ The user-supplied filter function returns an index key based on the values
│ │ │ │ in sk.
│ │ │ │ A return value of 0 means this particular sk should be not be counted.
│ │ │ │
function::text_str —
│ │ │ │ Escape any non-printable chars in a string
│ │ │ │
Synopsis
│ │ │ │ text_str:string(input:string)
│ │ │ │ -
Arguments
input
│ │ │ │ +
Arguments
input
│ │ │ │ the string to escape
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function accepts a string argument,
│ │ │ │ and any ASCII characters that are not
│ │ │ │ printable are replaced by the corresponding escape sequence in the
│ │ │ │ returned string.
│ │ │ │
│ │ │ │ maximum length of string to return (0 implies MAXSTRINGLEN)
│ │ │ │
quoted
│ │ │ │ put double quotes around the string. If input string is
│ │ │ │ truncated it will have “...” after the second quote
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function accepts a string of designated length,
│ │ │ │ and any ASCII characters that are not
│ │ │ │ printable are replaced by the corresponding escape sequence in the
│ │ │ │ returned string.
│ │ │ │
│ │ │ │ the amount of depth added/removed for each call
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns an integer equal to the nested
│ │ │ │ function-call depth starting from the outermost initial level. This function
│ │ │ │ is useful for saving space (consumed by whitespace) in traces with long
│ │ │ │ nested function calls. Use this function in a similar fashion to
│ │ │ │ thread_indent, i.e., in call-probe, use thread_indent_depth(1) and in
│ │ │ │ return-probe, use thread_indent_depth(-1)
│ │ │ │
│ │ │ │ the amount of space added/removed for each call
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a string with appropriate
│ │ │ │ indentation for a thread. Call it with a small positive or
│ │ │ │ matching negative delta. If this is the real outermost,
│ │ │ │ initial level of indentation, then the function resets the
│ │ │ │ relative timestamp base to zero. The timestamp is as per
│ │ │ │ provided by the __indent_timestamp function, which by default
│ │ │ │ measures microseconds.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tid.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │
function::tokenize —
│ │ │ │ Return the next non-empty token in a string
│ │ │ │ -
Synopsis
1) tokenize:string(delim:string)
2) tokenize:string(input:string,delim:string)
Arguments
delim
│ │ │ │ +
Synopsis
1) tokenize:string(delim:string)
2) tokenize:string(input:string,delim:string)
Arguments
delim
│ │ │ │ set of characters that delimit the tokens
│ │ │ │
input
│ │ │ │ string to tokenize. If empty, returns the next non-empty token
│ │ │ │ in the string passed in the previous call to tokenize.
│ │ │ │ -
Description
1) This function returns the next token in the string
│ │ │ │ +
Description
1) This function returns the next token in the string
│ │ │ │ passed in the previous call to tokenize. If no delimiter is found,
│ │ │ │ the entire remaining input string is * returned. It returns empty
│ │ │ │ when no more tokens are available.
2) This function returns the next non-empty token in the
│ │ │ │ given input string, where the tokens are delimited by characters in
│ │ │ │ the delim string. If the input string is non-empty, it returns the
│ │ │ │ first token. If the input string is empty, it returns the next
│ │ │ │ token in the string passed in the previous call to tokenize.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-tty-init.html
│ │ │ │ @@ -1,9 +1,9 @@
│ │ │ │
function::tz_ctime —
│ │ │ │ Convert seconds since epoch into human readable date/time string, with local time zone
│ │ │ │
Synopsis
│ │ │ │ tz_ctime(epochsecs:)
│ │ │ │ -
Arguments
epochsecs
│ │ │ │ +
Arguments
epochsecs
│ │ │ │ number of seconds since epoch (as returned by gettimeofday_s)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Takes an argument of seconds since the epoch as returned by
│ │ │ │ gettimeofday_s. Returns a string of the same form as ctime, but
│ │ │ │ offsets the epoch time for the local time zone, and appends the name of the
│ │ │ │ local time zone. The string length may vary. The time zone information is
│ │ │ │ passed by staprun at script startup only.
│ │ │ │
function::uaddr —
│ │ │ │ User space address of current running task
│ │ │ │
Synopsis
│ │ │ │ uaddr:long()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the address in userspace that the current
│ │ │ │ task was at when the probe occurred. When the current running task
│ │ │ │ isn't a user space thread, or the address cannot be found, zero
│ │ │ │ is returned. Can be used to see where the current task is combined
│ │ │ │ with usymname or usymdata. Often the task will be in the VDSO
│ │ │ │ where it entered the kernel.
│ │ │ │
function::ubacktrace —
│ │ │ │ Hex backtrace of current user-space task stack.
│ │ │ │
Synopsis
│ │ │ │ ubacktrace:string()
│ │ │ │ -
Arguments
│ │ │ │ +
Arguments
│ │ │ │ None
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │
│ │ │ │
│ │ │ │ Return a string of hex addresses that are a backtrace of the
│ │ │ │ stack of the current task. Output may be truncated as per maximum
│ │ │ │ string length. Returns empty string when current probe point cannot
│ │ │ │ determine user backtrace. See backtrace for kernel traceback.
│ │ │ │ -
Note
│ │ │ │ +
Note
│ │ │ │ To get (full) backtraces for user space applications and shared
│ │ │ │ shared libraries not mentioned in the current script run stap with
│ │ │ │ -d /path/to/exe-or-so and/or add --ldd to load all needed unwind data.
│ │ │ │
function::ucallers —
│ │ │ │ Return first n elements of user stack backtrace
│ │ │ │
Synopsis
│ │ │ │ ucallers:string(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ number of levels to descend in the stack (not counting the top
│ │ │ │ level). If n is -1, print the entire stack.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function returns a string of the first n hex
│ │ │ │ addresses from the backtrace of the user stack. Output may be
│ │ │ │ truncated as per maximum string length (MAXSTRINGLEN).
│ │ │ │ -
Note
│ │ │ │ +
Note
│ │ │ │ To get (full) backtraces for user space applications and shared
│ │ │ │ shared libraries not mentioned in the current script run stap with
│ │ │ │ -d /path/to/exe-or-so and/or add --ldd to load all needed unwind data.
│ │ │ │
function::ulong_arg —
│ │ │ │ Return function argument as unsigned long
│ │ │ │
Synopsis
│ │ │ │ ulong_arg:long(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ index of argument to return
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Return the value of argument n as an unsigned long.
│ │ │ │ On architectures where a long is 32 bits, the value is zero-extended
│ │ │ │ to 64 bits.
│ │ │ │
function::umodname —
│ │ │ │ Returns the (short) name of the user module.
│ │ │ │
Synopsis
│ │ │ │ umodname:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ User-space address
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the short name of the user space module for the current task that
│ │ │ │ that the given address is part of. Reports an error when the address
│ │ │ │ isn't in a (mapped in) module, or the module cannot be found for some reason.
│ │ │ │
│ │ │ │ Number of microseconds to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns a string representing the number of
│ │ │ │ microseconds as a human readable string consisting of “XmY.ZZZZZZs”,
│ │ │ │ where X is the number of minutes, Y is the number of seconds and
│ │ │ │ ZZZZZZ is the number of microseconds.
│ │ │ │
│ │ │ │ the user space address to retrieve the buffer from
│ │ │ │
inlen
│ │ │ │ the exact length of the buffer to read
│ │ │ │
outlen
│ │ │ │ the maximum length of the output string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Reads inlen characters of a buffer from the given user space
│ │ │ │ memory address, and returns up to outlen characters, where any ASCII
│ │ │ │ characters that are not printable are replaced by the corresponding escape
│ │ │ │ sequence in the returned string. Note that the string will be surrounded by
│ │ │ │ double quotes. On the rare cases when user space data is not accessible at
│ │ │ │ the given address, an error is thrown.
│ │ │ │
│ │ │ │ the user space address to retrieve the buffer from
│ │ │ │
inlen
│ │ │ │ the exact length of the buffer to read
│ │ │ │
outlen
│ │ │ │ the maximum length of the output string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Reads inlen characters of a buffer from the given user space
│ │ │ │ memory address, and returns up to outlen characters, where any ASCII
│ │ │ │ characters that are not printable are replaced by the corresponding escape
│ │ │ │ sequence in the returned string. Note that the string will be surrounded by
│ │ │ │ double quotes. On the rare cases when user space data is not accessible at
│ │ │ │ the given address, the address itself is returned as a string, without
│ │ │ │ double quotes.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-user-char-error.html
│ │ │ │ @@ -1,10 +1,10 @@
│ │ │ │
function::user_char_warn —
│ │ │ │ Retrieves a char value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_char_warn:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the char from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the char value from a given user space
│ │ │ │ address. Returns zero when user space data is not accessible and
│ │ │ │ warns about the failure (but does not error).
│ │ │ │
function::user_int_warn —
│ │ │ │ Retrieves an int value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_int_warn:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the int from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the int value from a given user space address.
│ │ │ │ Returns zero when user space data is not accessible and warns about
│ │ │ │ the failure (but does not error).
│ │ │ │
│ │ │ │ the user space address to retrieve the 16-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the 16-bit integer value from a given user
│ │ │ │ space address. If the user space data is not accessible, an error
│ │ │ │ will occur.
│ │ │ │
│ │ │ │ the user space address to retrieve the 32-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the 32-bit integer value from a given user
│ │ │ │ space address. If the user space data is not accessible, an error
│ │ │ │ will occur.
│ │ │ │
│ │ │ │ the user space address to retrieve the 64-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the 64-bit integer value from a given user
│ │ │ │ space address. If the user space data is not accessible, an error
│ │ │ │ will occur.
│ │ │ │
function::user_int8_error —
│ │ │ │ Retrieves a 8-bit integer value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_int8_error:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the 8-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the 8-bit integer value from a given user
│ │ │ │ space address. If the user space data is not accessible, an error
│ │ │ │ will occur.
│ │ │ │
function::user_long_error —
│ │ │ │ Retrieves a long value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_long_error:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the long from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the long value from a given user space
│ │ │ │ address. If the user space data is not accessible, an error will
│ │ │ │ occur. Note that the size of the long depends on the architecture
│ │ │ │ of the current user space task (for those architectures that
│ │ │ │ support both 64/32 bit compat tasks).
│ │ │ │
function::user_long_warn —
│ │ │ │ Retrieves a long value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_long_warn:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the long from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the long value from a given user space
│ │ │ │ address. Returns zero when user space data is not accessible and
│ │ │ │ warns about the failure (but does not error). Note that the size
│ │ │ │ of the long depends on the architecture of the current user space
│ │ │ │ task (for those architectures that support both 64/32 bit compat
│ │ │ │ tasks).
│ │ │ │
function::user_long —
│ │ │ │ Retrieves a long value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_long:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the long from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the long value from a given user space address.
│ │ │ │ Returns zero when user space data is not accessible. Note that the
│ │ │ │ size of the long depends on the architecture of the current user space
│ │ │ │ task (for those architectures that support both 64/32 bit compat tasks).
│ │ │ │
function::user_short_warn —
│ │ │ │ Retrieves a short value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_short_warn:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the short from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the short value from a given user space
│ │ │ │ address. Returns zero when user space data is not accessible and
│ │ │ │ warns about the failure (but does not error).
│ │ │ │
│ │ │ │ the user space address to retrieve the string from
│ │ │ │
n
│ │ │ │ the maximum length of the string (if not null terminated)
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the C string of a maximum given length from a
│ │ │ │ given user space address. Returns the empty string when userspace
│ │ │ │ data is not accessible at the given address.
│ │ │ │
│ │ │ │ the user space address to retrieve the string from
│ │ │ │
n
│ │ │ │ the maximum length of the string (if not null terminated)
│ │ │ │
inlen
│ │ │ │ the maximum length of the string to read (if not null terminated)
│ │ │ │
outlen
│ │ │ │ the maximum length of the output string
│ │ │ │ -
Description
1) Returns up to n characters of a C string from the given
│ │ │ │ +
Description
1) Returns up to n characters of a C string from the given
│ │ │ │ user space memory address where any ASCII characters that are not
│ │ │ │ printable are replaced by the corresponding escape sequence in the
│ │ │ │ returned string. Note that the string will be surrounded by double quotes.
│ │ │ │ On the rare cases when userspace data is not accessible at the given address,
│ │ │ │ the address itself is returned as a string, without double quotes.
2) Reads up to inlen characters of a C string from the given user
│ │ │ │ space memory address, and returns up to outlen characters, where any ASCII
│ │ │ │ characters that are not printable are replaced by the corresponding escape
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-user-string-n-warn.html
│ │ │ │ @@ -1,16 +1,16 @@
│ │ │ │
│ │ │ │ the user space address to retrieve the string from
│ │ │ │
n
│ │ │ │ the maximum length of the string (if not null terminated)
│ │ │ │
warn_msg
│ │ │ │ the warning message to return when data isn't available
│ │ │ │ -
Description
1) Returns up to n characters of a C string from a given
│ │ │ │ +
Description
1) Returns up to n characters of a C string from a given
│ │ │ │ user space memory address. Reports“<unknown>” on the rare cases
│ │ │ │ when userspace data is not accessible and warns (but does not abort)
│ │ │ │ about the failure.
│ │ │ │
2) Returns up to n characters of a C string from a given
│ │ │ │ user space memory address. Reports the given warning message on the
│ │ │ │ rare cases when userspace data is not accessible and warns (but does
│ │ │ │ not abort) about the failure.
│ │ │ │ the user space address to retrieve the string from
│ │ │ │
n
│ │ │ │ the maximum length of the string (if not null terminated)
│ │ │ │
err_msg
│ │ │ │ the error message to return when data isn't available
│ │ │ │ -
Description
1) Returns the C string of a maximum given length from a
│ │ │ │ +
Description
1) Returns the C string of a maximum given length from a
│ │ │ │ given user space address. Reports an error on the rare cases
│ │ │ │ when userspace data is not accessible at the given address.
2) Returns the C string of a maximum given length from a
│ │ │ │ given user space address. Returns the given error message string on
│ │ │ │ the rare cases when userspace data is not accessible at the given
│ │ │ │ address.
│ │ │ │ the user space address to retrieve the string from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the null terminated C string from a given user space
│ │ │ │ memory address. Returns the empty string if userspace data is not accessible.
│ │ │ │
│ │ │ │ the user space address to retrieve the string from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the null terminated C string from a given user space
│ │ │ │ memory address where any ASCII characters that are not printable are
│ │ │ │ replaced by the corresponding escape sequence in the returned string. Note
│ │ │ │ that the string will be surrounded by double quotes. On the rare cases when
│ │ │ │ userspace data is not accessible at the given address, the address itself is
│ │ │ │ returned as a string, without double quotes.
│ │ │ │
│ │ │ │ The user address to retrieve the string from
│ │ │ │
err_msg
│ │ │ │ The error message to return when data isn't available
│ │ │ │ -
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ +
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-16 string at a given user memory address. Reports an error on
│ │ │ │ string copy fault or conversion error.
2) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-16 string at a given user memory address. Reports the given
│ │ │ │ error message on string copy fault or conversion error.
│ │ │ │ The user address to retrieve the string from
│ │ │ │
err_msg
│ │ │ │ The error message to return when data isn't available
│ │ │ │ -
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ +
Description
1) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-32 string at a given user memory address. Reports an error on
│ │ │ │ string copy fault or conversion error.
2) This function returns a null terminated UTF-8 string converted
│ │ │ │ from the UTF-32 string at a given user memory address. Reports the given
│ │ │ │ error message on string copy fault or conversion error.
│ │ │ │ the user space address to retrieve the string from
│ │ │ │
warn_msg
│ │ │ │ the warning message to return when data isn't available
│ │ │ │ -
Description
1) Returns the null terminated C string from a given user space
│ │ │ │ +
Description
1) Returns the null terminated C string from a given user space
│ │ │ │ memory address. Reports "" on the rare cases when userspace data is
│ │ │ │ not accessible and warns (but does not abort) about the failure.
2) Returns the null terminated C string from a given user space
│ │ │ │ memory address. Reports the given warning message on the rare cases
│ │ │ │ when userspace data is not accessible and warns (but does not abort)
│ │ │ │ about the failure.
function::user_string —
│ │ │ │ Retrieves string from user space
│ │ │ │ -
Synopsis
1) user_string:string(addr:long)
2) user_string:string(addr:long,err_msg:string)
Arguments
addr
│ │ │ │ +
Synopsis
1) user_string:string(addr:long)
2) user_string:string(addr:long,err_msg:string)
Arguments
addr
│ │ │ │ the user space address to retrieve the string from
│ │ │ │
err_msg
│ │ │ │ the error message to return when data isn't available
│ │ │ │ -
Description
1) Returns the null terminated C string from a given user space
│ │ │ │ +
Description
1) Returns the null terminated C string from a given user space
│ │ │ │ memory address. Reports an error on the rare cases when userspace
│ │ │ │ data is not accessible.
2) Returns the null terminated C string from a given user space
│ │ │ │ memory address. Reports the given error message on the rare cases when
│ │ │ │ userspace data is not accessible.
│ │ │ │ the user space address to retrieve the unsigned 16-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 16-bit integer value from a given user
│ │ │ │ space address. If the user space data is not accessible, an error
│ │ │ │ will occur.
│ │ │ │
function::user_uint16 —
│ │ │ │ Retrieves an unsigned 16-bit integer value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_uint16:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the unsigned 16-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 16-bit integer value from a given user
│ │ │ │ space address. Returns zero when user space data is not accessible.
│ │ │ │
│ │ │ │ the user space address to retrieve the unsigned 32-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 32-bit integer value from a given
│ │ │ │ user space address. If the user space data is not accessible, an
│ │ │ │ error will occur.
│ │ │ │
function::user_uint32 —
│ │ │ │ Retrieves an unsigned 32-bit integer value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_uint32:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the unsigned 32-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 32-bit integer value from a given user
│ │ │ │ space address. Returns zero when user space data is not accessible.
│ │ │ │
│ │ │ │ the user space address to retrieve the unsigned 64-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 64-bit integer value from a given
│ │ │ │ user space address. If the user space data is not accessible, an
│ │ │ │ error will occur.
│ │ │ │
function::user_uint64 —
│ │ │ │ Retrieves an unsigned 64-bit integer value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_uint64:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the unsigned 64-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 64-bit integer value from a given user
│ │ │ │ space address. Returns zero when user space data is not accessible.
│ │ │ │
│ │ │ │ the user space address to retrieve the unsigned 8-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 8-bit integer value from a given
│ │ │ │ user space address. If the user space data is not accessible, an
│ │ │ │ error will occur.
│ │ │ │
function::user_uint8 —
│ │ │ │ Retrieves a unsigned 8-bit integer value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_uint8:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the unsigned 8-bit integer from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned 8-bit integer value from a given
│ │ │ │ user space address. Returns zero when user space data is not
│ │ │ │ accessible.
│ │ │ │
│ │ │ │ the user space address to retrieve the unsigned long from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned long value from a given user space
│ │ │ │ address. If the user space data is not accessible, an error will
│ │ │ │ occur. Note that the size of the unsigned long depends on the architecture
│ │ │ │ of the current user space task (for those architectures that
│ │ │ │ support both 64/32 bit compat tasks).
│ │ │ │
function::user_ulong_warn —
│ │ │ │ Retrieves an unsigned long value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_ulong_warn:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the unsigned long from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned long value from a given user
│ │ │ │ space address. Returns zero when user space data is not accessible
│ │ │ │ and warns about the failure (but does not error). Note that the
│ │ │ │ size of the unsigned long depends on the architecture of the
│ │ │ │ current user space task (for those architectures that support both
│ │ │ │ 64/32 bit compat tasks).
│ │ │ │
function::user_ulong —
│ │ │ │ Retrieves an unsigned long value stored in user space
│ │ │ │
Synopsis
│ │ │ │ user_ulong:long(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ the user space address to retrieve the unsigned long from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned long value from a given user
│ │ │ │ space address. Returns zero when user space data is not
│ │ │ │ accessible. Note that the size of the unsigned long depends on the
│ │ │ │ architecture of the current user space task (for those
│ │ │ │ architectures that support both 64/32 bit compat tasks).
│ │ │ │
│ │ │ │ the user space address to retrieve the unsigned short from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned short value from a given user
│ │ │ │ space address. If the user space data is not accessible, an error
│ │ │ │ will occur.
│ │ │ │
│ │ │ │ the user space address to retrieve the unsigned short from
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the unsigned short value from a given user
│ │ │ │ space address. Returns zero when user space data is not accessible
│ │ │ │ and warns about the failure (but does not error).
│ │ │ │
function::ustack —
│ │ │ │ Return address at given depth of user stack backtrace
│ │ │ │
Synopsis
│ │ │ │ ustack:long(n:long)
│ │ │ │ -
Arguments
n
│ │ │ │ +
Arguments
n
│ │ │ │ number of levels to descend in the stack.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Performs a simple (user space) backtrace, and returns the
│ │ │ │ element at the specified position. The results of the backtrace itself
│ │ │ │ are cached, so that the backtrace computation is performed at most once
│ │ │ │ no matter how many times ustack is called, or in what order.
│ │ │ │
function::usymdata —
│ │ │ │ Return the symbol and module offset of an address.
│ │ │ │
Synopsis
│ │ │ │ usymdata:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the (function) symbol name associated with the
│ │ │ │ given address in the current task if known, the offset from the
│ │ │ │ start and the size of the symbol, plus the module name (between
│ │ │ │ brackets). If symbol is unknown, but module is known, the offset
│ │ │ │ inside the module, plus the size of the module is added. If any
│ │ │ │ element is not known it will be omitted and if the symbol name is
│ │ │ │ unknown it will return the hex string for the given address.
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-usymfile.html
│ │ │ │ @@ -1,11 +1,11 @@
│ │ │ │
function::usymfile —
│ │ │ │ Return the file name of a given address.
│ │ │ │
Synopsis
│ │ │ │ usymfile:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the file name of the given address, if known. If the
│ │ │ │ file name cannot be found, the hex string representation of the address
│ │ │ │ will be returned.
│ │ │ │
function::usymfileline —
│ │ │ │ Return the file name and line number of an address.
│ │ │ │
Synopsis
│ │ │ │ usymfileline:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the file name and the (approximate) line number of the
│ │ │ │ given address, if known. If the file name or the line number cannot be
│ │ │ │ found, the hex string representation of the address will be returned.
│ │ │ │
function::usymline —
│ │ │ │ Return the line number of an address.
│ │ │ │
Synopsis
│ │ │ │ usymline:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the (approximate) line number of the given address, if
│ │ │ │ known. If the line number cannot be found, the hex string representation of
│ │ │ │ the address will be returned.
│ │ │ │
function::usymname —
│ │ │ │ Return the symbol of an address in the current task.
│ │ │ │
Synopsis
│ │ │ │ usymname:string(addr:long)
│ │ │ │ -
Arguments
addr
│ │ │ │ +
Arguments
addr
│ │ │ │ The address to translate.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Returns the (function) symbol name associated with the
│ │ │ │ given address if known. If not known it will return the hex string
│ │ │ │ representation of addr.
│ │ │ │
probe::vm.pagefault.return —
│ │ │ │ Indicates what type of fault occurred
│ │ │ │ -
Synopsis
vm.pagefault.return
Values
name
│ │ │ │ - name of the probe point
│ │ │ │ -
fault_type
│ │ │ │ +
Synopsis
vm.pagefault.return
Values
fault_type
│ │ │ │ returns either
│ │ │ │ 0 (VM_FAULT_OOM) for out of memory faults,
│ │ │ │ 2 (VM_FAULT_MINOR) for minor faults, 3 (VM_FAULT_MAJOR) for
│ │ │ │ major faults, or 1 (VM_FAULT_SIGBUS) if the fault was neither OOM, minor fault,
│ │ │ │ nor major fault.
│ │ │ │ +
name
│ │ │ │ + name of the probe point
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,17 +2,17 @@
│ │ │ │ │ Prev Chapter 6. Memory Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::vm.pagefault.return — Indicates what type of fault occurred
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ vm.pagefault.return
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - name
│ │ │ │ │ - name of the probe point
│ │ │ │ │ fault_type
│ │ │ │ │ returns either 0 (VM_FAULT_OOM) for out of memory faults, 2
│ │ │ │ │ (VM_FAULT_MINOR) for minor faults, 3 (VM_FAULT_MAJOR) for major faults,
│ │ │ │ │ or 1 (VM_FAULT_SIGBUS) if the fault was neither OOM, minor fault, nor
│ │ │ │ │ major fault.
│ │ │ │ │ + name
│ │ │ │ │ + name of the probe point
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ │ │ probe::vm.pagefault Home probe::vm.write_shared
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-vm-pagefault.html
│ │ │ │ @@ -1,12 +1,12 @@
│ │ │ │ probe::vm.pagefault
probe::vm.write_shared —
│ │ │ │ Attempts at writing to a shared page
│ │ │ │ -
Synopsis
vm.write_shared
Values
name
│ │ │ │ - name of the probe point
│ │ │ │ -
address
│ │ │ │ +
Synopsis
vm.write_shared
Values
address
│ │ │ │ the address of the shared write
│ │ │ │ -
Context
│ │ │ │ +
name
│ │ │ │ + name of the probe point
│ │ │ │ +
Context
│ │ │ │ The context is the process attempting the write.
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ Fires when a process attempts to write to a shared page.
│ │ │ │ If a copy is necessary, this will be followed by a
│ │ │ │ vm.write_shared_copy.
│ │ │ │
│ │ │ │ ├── html2text {}
│ │ │ │ │ @@ -2,18 +2,18 @@
│ │ │ │ │ Prev Chapter 6. Memory Tapse Next
│ │ │ │ │ ===============================================================================
│ │ │ │ │ ***** Name *****
│ │ │ │ │ probe::vm.write_shared — Attempts at writing to a shared page
│ │ │ │ │ ***** Synopsis *****
│ │ │ │ │ vm.write_shared
│ │ │ │ │ ***** Values *****
│ │ │ │ │ - name
│ │ │ │ │ - name of the probe point
│ │ │ │ │ address
│ │ │ │ │ the address of the shared write
│ │ │ │ │ + name
│ │ │ │ │ + name of the probe point
│ │ │ │ │ ***** Context *****
│ │ │ │ │ The context is the process attempting the write.
│ │ │ │ │ ***** Description *****
│ │ │ │ │ Fires when a process attempts to write to a shared page. If a copy is
│ │ │ │ │ necessary, this will be followed by a vm.write_shared_copy.
│ │ │ │ │ ===============================================================================
│ │ │ │ │ Prev Up Next
│ │ │ ├── ./usr/share/doc/systemtap-doc/tapsets/API-warn.html
│ │ │ │ @@ -1,11 +1,11 @@
│ │ │ │ function::warn
function::warn —
│ │ │ │ Send a line to the warning stream
│ │ │ │
Synopsis
│ │ │ │ warn(msg:string)
│ │ │ │ -
Arguments
msg
│ │ │ │ +
Arguments
msg
│ │ │ │ The formatted message string
│ │ │ │ -
Description
│ │ │ │ +
Description
│ │ │ │ This function sends a warning message immediately to
│ │ │ │ staprun. It is also sent over the bulk transport (relayfs) if it is
│ │ │ │ being used. If the last characater is not a newline, the one is added.
│ │ │ │
│ │ │ │ Following is an overview of available syscall probes and
│ │ │ │ convenience variables they offer. By default, each syscall probe has name and
│ │ │ │ argstr convenience variables, which are not included in the overview in order
│ │ │ │ to keep it short. Non dwarf-based nd_syscall probes are supposed to have the
│ │ │ │ same convenience variables.
│ │ │ │