function::HZ
PrevÂ	ChapterÂ 3.Â Timestamp Functions	Â Next

function::addr_to_node
PrevÂ	ChapterÂ 6.Â Memory Tapset	Â Next

function::addr
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::ansi_clear_screen
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_cursor_hide
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_cursor_move
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_cursor_restore
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_cursor_save
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_cursor_show
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_new_line
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_reset_color
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_set_color
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_set_color2
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::ansi_set_color3
PrevÂ	ChapterÂ 26.Â Utility functions for using ansi control chars in logs	Â Next

function::backtrace
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::bytes_to_string
PrevÂ	ChapterÂ 6.Â Memory Tapset	Â Next

function::caller_addr
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::caller
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::cmdline_arg
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::cmdline_args
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::cmdline_str
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::cpu
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::cpuid
PrevÂ	ChapterÂ 2.Â Context Functions	Â Next

function::cputime_to_msecs
PrevÂ	ChapterÂ 7.Â Task Time Tapset	Â Next

function::cputime_to_string
PrevÂ	ChapterÂ 7.Â Task Time Tapset	Â Next

SystemTap Tapset Reference Manual

SystemTap

HackersÂ

- This documentation is free software; you can redistribute - it and/or modify it under the terms of the GNU General Public - License version 2 as published by the Free Software Foundation. -

- This program is distributed in the hope that it will be - useful, but WITHOUT ANY WARRANTY; without even the implied - warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the GNU General Public License for more details. -

- You should have received a copy of the GNU General Public - License along with this program; if not, write to the Free - Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301 USA. -

- For more details see the file COPYING in the source - distribution of Linux. -

Table of Contents

1. Introduction

Tapset Name Format

2. Context Functions

function::print_regs â - Print a register dump -
function::execname â - Returns the execname of a target process (or group of processes) -
function::pid â - Returns the ID of a target process -
function::tid â - Returns the thread ID of a target process -
function::ppid â - Returns the process ID of a target process's parent process -
function::pgrp â - Returns the process group ID of the current process -
function::sid â - Returns the session ID of the current process -
function::pexecname â - Returns the execname of a target process's parent process -
function::gid â - Returns the group ID of a target process -
function::egid â - Returns the effective gid of a target process -
function::uid â - Returns the user ID of a target process -
function::euid â - Return the effective uid of a target process -
function::is_myproc â - Determines if the current probe point has occurred in the user's own process -
function::cpuid â - Returns the current cpu number -
function::cpu â - Returns the current cpu number -
function::pp â - Returns the active probe point -
function::registers_valid â - Determines validity of register and u_register in current context -
function::user_mode â - Determines if probe point occurs in user-mode -
function::is_return â - Whether the current probe context is a return probe -
function::target â - Return the process ID of the target process -
function::module_name â - The module name of the current script -
function::stp_pid â - The process id of the stapio process -
function::stack_size â - Return the size of the kernel stack -
function::stack_used â - Returns the amount of kernel stack used -
function::stack_unused â - Returns the amount of kernel stack currently available -
function::addr â - Address of the current probe point. -
function::uaddr â - User space address of current running task (EXPERIMENTAL) -
function::cmdline_args â - Fetch command line arguments from current process -
function::cmdline_arg â - Fetch a command line argument -
function::cmdline_str â - Fetch all command line arguments from current process -
function::env_var â - Fetch environment variable from current process -
function::print_stack â - Print out kernel stack from string -
function::sprint_stack â - Return stack for kernel addresses from string (EXPERIMENTAL) -
function::probefunc â - Return the probe point's function name, if known -
function::probemod â - Return the probe point's kernel module name -
function::modname â - Return the kernel module name loaded at the address -
function::symname â - Return the kernel symbol associated with the given address -
function::symdata â - Return the kernel symbol and module offset for the address -
function::umodname â - Returns the (short) name of the user module. EXPERIMENTAL! -
function::usymname â - Return the symbol of an address in the current task. EXPERIMENTAL! -
function::usymdata â - Return the symbol and module offset of an address. EXPERIMENTAL! -
function::print_ustack â - Print out stack for the current task from string. EXPERIMENTAL! -
function::sprint_ustack â - Return stack for the current task from string. EXPERIMENTAL! -
function::print_backtrace â - Print stack back trace -
function::sprint_backtrace â - Return stack back trace as string (EXPERIMENTAL) -
function::backtrace â - Hex backtrace of current stack -
function::task_backtrace â - Hex backtrace of an arbitrary task -
function::caller â - Return name and address of calling function -
function::caller_addr â - Return caller address -
function::print_ubacktrace â - Print stack back trace for current task. EXPERIMENTAL! -
function::sprint_ubacktrace â - Return stack back trace for current task as string. EXPERIMENTAL! -
function::print_ubacktrace_brief â - Print stack back trace for current task. EXPERIMENTAL! -
function::ubacktrace â - Hex backtrace of current task stack. EXPERIMENTAL! -
function::task_current â - The current task_struct of the current task -
function::task_parent â - The task_struct of the parent task -
function::task_state â - The state of the task -
function::task_execname â - The name of the task -
function::task_pid â - The process identifier of the task -
function::pid2task â - The task_struct of the given process identifier -
function::pid2execname â - The name of the given process identifier -
function::task_tid â - The thread identifier of the task -
function::task_gid â - The group identifier of the task -
function::task_egid â - The effective group identifier of the task -
function::task_uid â - The user identifier of the task -
function::task_euid â - The effective user identifier of the task -
function::task_prio â - The priority value of the task -
function::task_nice â - The nice value of the task -
function::task_cpu â - The scheduled cpu of the task -
function::task_open_file_handles â - The number of open files of the task -
function::task_max_file_handles â - The max number of open files for the task -
function::pn â - Returns the active probe name -

3. Timestamp Functions

function::get_cycles â - Processor cycle count -
function::jiffies â - Kernel jiffies count -
function::HZ â - Kernel HZ -
function::gettimeofday_ns â - Number of nanoseconds since UNIX epoch -
function::gettimeofday_us â - Number of microseconds since UNIX epoch -
function::gettimeofday_ms â - Number of milliseconds since UNIX epoch -
function::gettimeofday_s â - Number of seconds since UNIX epoch -

4. Time utility functions

function::ctime â - Convert seconds since epoch into human readable date/time string -
function::tz_gmtoff â - Return local time zone offset -
function::tz_name â - Return local time zone name -
function::tz_ctime â - Convert seconds since epoch into human readable date/time string, with local time zone -

5. Time utility functions

function::system â - Issue a command to the system -

6. Memory Tapset

function::vm_fault_contains â - Test return value for page fault reason -
probe::vm.pagefault â - Records that a page fault occurred -
probe::vm.pagefault.return â - Indicates what type of fault occurred -
function::addr_to_node â - Returns which node a given address belongs to within a NUMA system -
probe::vm.write_shared â - Attempts at writing to a shared page -
probe::vm.write_shared_copy â - Page copy for shared page write -
probe::vm.mmap â - Fires when an mmap is requested -
probe::vm.munmap â - Fires when an munmap is requested -
probe::vm.brk â - Fires when a brk is requested (i.e. the heap will be resized) -
probe::vm.oom_kill â - Fires when a thread is selected for termination by the OOM killer -
probe::vm.kmalloc â - Fires when kmalloc is requested -
probe::vm.kmem_cache_alloc â - Fires when kmem_cache_alloc is requested -
probe::vm.kmalloc_node â - Fires when kmalloc_node is requested -
probe::vm.kmem_cache_alloc_node â - Fires when kmem_cache_alloc_node is requested -
probe::vm.kfree â - Fires when kfree is requested -
probe::vm.kmem_cache_free â - Fires when kmem_cache_free is requested -
function::proc_mem_size â - Total program virtual memory size in pages -
function::proc_mem_size_pid â - Total program virtual memory size in pages -
function::proc_mem_rss â - Program resident set size in pages -
function::proc_mem_rss_pid â - Program resident set size in pages -
function::proc_mem_shr â - Program shared pages (from shared mappings) -
function::proc_mem_shr_pid â - Program shared pages (from shared mappings) -
function::proc_mem_txt â - Program text (code) size in pages -
function::proc_mem_txt_pid â - Program text (code) size in pages -
function::proc_mem_data â - Program data size (data + stack) in pages -
function::proc_mem_data_pid â - Program data size (data + stack) in pages -
function::mem_page_size â - Number of bytes in a page for this architecture -
function::bytes_to_string â - Human readable string for given bytes -
function::pages_to_string â - Turns pages into a human readable string -
function::proc_mem_string â - Human readable string of current proc memory usage -
function::proc_mem_string_pid â - Human readable string of process memory usage -

7. Task Time Tapset

function::task_utime â - User time of the current task -
function::task_utime_tid â - User time of the given task -
function::task_stime â - System time of the current task -
function::task_stime_tid â - System time of the given task -
function::cputime_to_msecs â - Translates the given cputime into milliseconds -
function::msecs_to_string â - Human readable string for given milliseconds -
function::cputime_to_string â - Human readable string for given cputime -
function::task_time_string â - Human readable string of task time usage -
function::task_time_string_tid â - Human readable string of task time usage -

8. Scheduler Tapset

probe::scheduler.ctxswitch â - A context switch is occuring. -
probe::scheduler.kthread_stop â - A thread created by kthread_create is being stopped -
probe::scheduler.kthread_stop.return â - A kthread is stopped and gets the return value -
probe::scheduler.wait_task â - Waiting on a task to unschedule (become inactive) -
probe::scheduler.wakeup â - Task is woken up -
probe::scheduler.wakeup_new â - Newly created task is woken up for the first time -
probe::scheduler.migrate â - Task migrating across cpus -
probe::scheduler.process_free â - Scheduler freeing a data structure for a process -
probe::scheduler.process_exit â - Process exiting -
probe::scheduler.process_wait â - Scheduler starting to wait on a process -
probe::scheduler.process_fork â - Process forked -
probe::scheduler.signal_send â - Sending a signal -

9. IO Scheduler and block IO Tapset

probe::ioscheduler.elv_next_request â - Fires when a request is retrieved from the request queue -
probe::ioscheduler.elv_next_request.return â - Fires when a request retrieval issues a return signal -
probe::ioscheduler.elv_completed_request â - Fires when a request is completed -
probe::ioscheduler.elv_add_request.kp â - kprobe based probe to indicate that a request was added to the request queue -
probe::ioscheduler.elv_add_request.tp â - tracepoint based probe to indicate a request is added to the request queue. -
probe::ioscheduler.elv_add_request â - probe to indicate request is added to the request queue. -
probe::ioscheduler_trace.elv_completed_request â - Fires when a request is -
probe::ioscheduler_trace.elv_issue_request â - Fires when a request is -
probe::ioscheduler_trace.elv_requeue_request â - Fires when a request is -
probe::ioscheduler_trace.elv_abort_request â - Fires when a request is aborted. -
probe::ioscheduler_trace.plug â - Fires when a request queue is plugged; -
probe::ioscheduler_trace.unplug_io â - Fires when a request queue is unplugged; -
probe::ioscheduler_trace.unplug_timer â - Fires when unplug timer associated -
probe::ioblock.request â - Fires whenever making a generic block I/O request. -
probe::ioblock.end â - Fires whenever a block I/O transfer is complete. -
probe::ioblock_trace.bounce â - Fires whenever a buffer bounce is needed for at least one page of a block IO request. -
probe::ioblock_trace.request â - Fires just as a generic block I/O request is created for a bio. -
probe::ioblock_trace.end â - Fires whenever a block I/O transfer is complete. -

10. SCSI Tapset

probe::scsi.ioentry â - Prepares a SCSI mid-layer request -
probe::scsi.iodispatching â - SCSI mid-layer dispatched low-level SCSI command -
probe::scsi.iodone â - SCSI command completed by low level driver and enqueued into the done queue. -
probe::scsi.iocompleted â - SCSI mid-layer running the completion processing for block device I/O requests -
probe::scsi.ioexecute â - Create mid-layer SCSI request and wait for the result -
probe::scsi.set_state â - Order SCSI device state change -

11. TTY Tapset

probe::tty.open â - Called when a tty is opened -
probe::tty.release â - Called when the tty is closed -
probe::tty.resize â - Called when a terminal resize happens -
probe::tty.ioctl â - called when a ioctl is request to the tty -
probe::tty.init â - Called when a tty is being initalized -
probe::tty.register â - Called when a tty device is registred -
probe::tty.unregister â - Called when a tty device is being unregistered -
probe::tty.poll â - Called when a tty device is being polled -
probe::tty.receive â - called when a tty receives a message -
probe::tty.write â - write to the tty line -
probe::tty.read â - called when a tty line will be read -

12. Interrupt Request (IRQ) Tapset

probe::workqueue.create â - Creating a new workqueue -
probe::workqueue.insert â - Queuing work on a workqueue -
probe::workqueue.execute â - Executing deferred work -
probe::workqueue.destroy â - Destroying workqueue -
probe::irq_handler.entry â - Execution of interrupt handler starting -
probe::irq_handler.exit â - Execution of interrupt handler completed -
probe::softirq.entry â - Execution of handler for a pending softirq starting -
probe::softirq.exit â - Execution of handler for a pending softirq completed -

13. Networking Tapset

probe::netdev.receive â - Data received from network device. -
probe::netdev.transmit â - Network device transmitting buffer -
probe::netdev.change_mtu â - Called when the netdev MTU is changed -
probe::netdev.open â - Called when the device is opened -
probe::netdev.close â - Called when the device is closed -
probe::netdev.hard_transmit â - Called when the devices is going to TX (hard) -
probe::netdev.rx â - Called when the device is going to receive a packet -
probe::netdev.change_rx_flag â - Called when the device RX flag will be changed -
probe::netdev.set_promiscuity â - Called when the device enters/leaves promiscuity -
probe::netdev.ioctl â - Called when the device suffers an IOCTL -
probe::netdev.register â - Called when the device is registered -
probe::netdev.unregister â - Called when the device is being unregistered -
probe::netdev.get_stats â - Called when someone asks the device statistics -
probe::netdev.change_mac â - Called when the netdev_name has the MAC changed -
probe::tcp.sendmsg â - Sending a tcp message -
probe::tcp.sendmsg.return â - Sending TCP message is done -
probe::tcp.recvmsg â - Receiving TCP message -
probe::tcp.recvmsg.return â - Receiving TCP message complete -
probe::tcp.disconnect â - TCP socket disconnection -
probe::tcp.disconnect.return â - TCP socket disconnection complete -
probe::tcp.setsockopt â - Call to setsockopt -
probe::tcp.setsockopt.return â - Return from setsockopt -
probe::tcp.receive â - Called when a TCP packet is received -
probe::udp.sendmsg â - Fires whenever a process sends a UDP message -
probe::udp.sendmsg.return â - Fires whenever an attempt to send a UDP message is completed -
probe::udp.recvmsg â - Fires whenever a UDP message is received -
probe::udp.recvmsg.return â - Fires whenever an attempt to receive a UDP message received is completed -
probe::udp.disconnect â - Fires when a process requests for a UDP disconnection -
probe::udp.disconnect.return â - UDP has been disconnected successfully -
function::ip_ntop â - returns a string representation from an integer IP number -

14. Socket Tapset

probe::socket.send â - Message sent on a socket. -
probe::socket.receive â - Message received on a socket. -
probe::socket.sendmsg â - Message is currently being sent on a socket. -
probe::socket.sendmsg.return â - Return from socket.sendmsg. -
probe::socket.recvmsg â - Message being received on socket -
probe::socket.recvmsg.return â - Return from Message being received on socket -
probe::socket.aio_write â - Message send via sock_aio_write -
probe::socket.aio_write.return â - Conclusion of message send via sock_aio_write -
probe::socket.aio_read â - Receiving message via sock_aio_read -
probe::socket.aio_read.return â - Conclusion of message received via sock_aio_read -
probe::socket.writev â - Message sent via socket_writev -
probe::socket.writev.return â - Conclusion of message sent via socket_writev -
probe::socket.readv â - Receiving a message via sock_readv -
probe::socket.readv.return â - Conclusion of receiving a message via sock_readv -
probe::socket.create â - Creation of a socket -
probe::socket.create.return â - Return from Creation of a socket -
probe::socket.close â - Close a socket -
probe::socket.close.return â - Return from closing a socket -
function::sock_prot_num2str â - Given a protocol number, return a string representation. -
function::sock_prot_str2num â - Given a protocol name (string), return the corresponding protocol number. -
function::sock_fam_num2str â - Given a protocol family number, return a string representation. -
function::sock_fam_str2num â - Given a protocol family name (string), return the corresponding -
function::sock_state_num2str â - Given a socket state number, return a string representation. -
function::sock_state_str2num â - Given a socket state string, return the corresponding state number. -

15. SNMP Information Tapset

function::ipmib_remote_addr â - Get the remote ip address -
function::ipmib_local_addr â - Get the local ip address -
function::ipmib_tcp_remote_port â - Get the remote tcp port -
function::ipmib_tcp_local_port â - Get the local tcp port -
function::ipmib_get_proto â - Get the protocol value -
probe::ipmib.InReceives â - Count an arriving packet -
probe::ipmib.InNoRoutes â - Count an arriving packet with no matching socket -
probe::ipmib.InAddrErrors â - Count arriving packets with an incorrect address -
probe::ipmib.InUnknownProtos â - Count arriving packets with an unbound proto -
probe::ipmib.InDiscards â - Count discarded inbound packets -
probe::ipmib.ForwDatagrams â - Count forwarded packet -
probe::ipmib.OutRequests â - Count a request to send a packet -
probe::ipmib.ReasmTimeout â - Count Reassembly Timeouts -
probe::ipmib.ReasmReqds â - Count number of packet fragments reassembly requests -
probe::ipmib.FragOKs â - Count datagram fragmented successfully -
probe::ipmib.FragFails â - Count datagram fragmented unsuccessfully -
function::tcpmib_get_state â - Get a socket's state -
function::tcpmib_local_addr â - Get the source address -
function::tcpmib_remote_addr â - Get the remote address -
function::tcpmib_local_port â - Get the local port -
function::tcpmib_remote_port â - Get the remote port -
probe::tcpmib.ActiveOpens â - Count an active opening of a socket -
probe::tcpmib.AttemptFails â - Count a failed attempt to open a socket -
probe::tcpmib.CurrEstab â - Update the count of open sockets -
probe::tcpmib.EstabResets â - Count the reset of a socket -
probe::tcpmib.InSegs â - Count an incomming tcp segment -
probe::tcpmib.OutRsts â - Count the sending of a reset packet -
probe::tcpmib.OutSegs â - Count the sending of a TCP segment -
probe::tcpmib.PassiveOpens â - Count the passive creation of a socket -
probe::tcpmib.RetransSegs â - Count the retransmission of a TCP segment -
probe::linuxmib.DelayedACKs â - Count of delayed acks -
probe::linuxmib.ListenOverflows â - Count of times a listen queue overflowed -
probe::linuxmib.ListenDrops â - Count of times conn request that were dropped -
probe::linuxmib.TCPMemoryPressures â - Count of times memory pressure was used -

16. Kernel Process Tapset

probe::kprocess.create â - Fires whenever a new process or thread is successfully created -
probe::kprocess.start â - Starting new process -
probe::kprocess.exec â - Attempt to exec to a new program -
probe::kprocess.exec_complete â - Return from exec to a new program -
probe::kprocess.exit â - Exit from process -
probe::kprocess.release â - Process released -

17. Signal Tapset

probe::signal.send â - Signal being sent to a process -
probe::signal.send.return â - Signal being sent to a process completed -
probe::signal.checkperm â - Check being performed on a sent signal -
probe::signal.checkperm.return â - Check performed on a sent signal completed -
probe::signal.wakeup â - Sleeping process being wakened for signal -
probe::signal.check_ignored â - Checking to see signal is ignored -
probe::signal.check_ignored.return â - Check to see signal is ignored completed -
probe::signal.force_segv â - Forcing send of SIGSEGV -
probe::signal.force_segv.return â - Forcing send of SIGSEGV complete -
probe::signal.syskill â - Sending kill signal to a process -
probe::signal.syskill.return â - Sending kill signal completed -
probe::signal.sys_tkill â - Sending a kill signal to a thread -
probe::signal.systkill.return â - Sending kill signal to a thread completed -
probe::signal.sys_tgkill â - Sending kill signal to a thread group -
probe::signal.sys_tgkill.return â - Sending kill signal to a thread group completed -
probe::signal.send_sig_queue â - Queuing a signal to a process -
probe::signal.send_sig_queue.return â - Queuing a signal to a process completed -
probe::signal.pending â - Examining pending signal -
probe::signal.pending.return â - Examination of pending signal completed -
probe::signal.handle â - Signal handler being invoked -
probe::signal.handle.return â - Signal handler invocation completed -
probe::signal.do_action â - Examining or changing a signal action -
probe::signal.do_action.return â - Examining or changing a signal action completed -
probe::signal.procmask â - Examining or changing blocked signals -
probe::signal.procmask.return â - Examining or changing blocked signals completed -
probe::signal.flush â - Flushing all pending signals for a task -

18. Errno Tapset

function::errno_str â - Symbolic string associated with error code -
function::returnstr â - Formats the return value as a string -
function::return_str â - Formats the return value as a string -

19. Directory-entry (dentry) Tapset

function::d_name â - get the dirent name -
function::inode_name â - get the inode name -
function::reverse_path_walk â - get the full dirent path -
function::task_dentry_path â - get the full dentry path -
function::d_path â - get the full nameidata path -

20. Logging Tapset

function::log â - Send a line to the common trace buffer -
function::warn â - Send a line to the warning stream -
function::exit â - Start shutting down probing script. -
function::error â - Send an error message -
function::ftrace â - Send a message to the ftrace ring-buffer -

21. Queue Statistics Tapset

function::qs_wait â - Function to record enqueue requests -
function::qs_run â - Function to record being moved from wait queue to being serviced -
function::qs_done â - Function to record finishing request -
function::qsq_start â - Function to reset the stats for a queue -
function::qsq_utilization â - Fraction of time that any request was being serviced -
function::qsq_blocked â - Returns the time reqest was on the wait queue -
function::qsq_wait_queue_length â - length of wait queue -
function::qsq_service_time â - Amount of time per request service -
function::qsq_wait_time â - Amount of time in queue + service per request -
function::qsq_throughput â - Number of requests served per unit time -
function::qsq_print â - Returns a line of statistics for the given queue -

22. Random functions Tapset

function::randint â - Return a random number between [0,n) -

23. String and data retrieving functions Tapset

function::kernel_string â - Retrieves string from kernel memory -
function::kernel_string2 â - Retrieves string from kernel memory with alternative error string -
function::kernel_string_n â - Retrieves string of given length from kernel memory -
function::kernel_long â - Retrieves a long value stored in kernel memory -
function::kernel_int â - Retrieves an int value stored in kernel memory -
function::kernel_short â - Retrieves a short value stored in kernel memory -
function::kernel_char â - Retrieves a char value stored in kernel memory -
function::kernel_pointer â - Retrieves a pointer value stored in kernel memory -
function::user_string â - Retrieves string from user space -
function::user_string2 â - Retrieves string from user space with alternative error string -
function::user_string_warn â - Retrieves string from user space -
function::user_string_quoted â - Retrieves and quotes string from user space -
function::user_string_n â - Retrieves string of given length from user space -
function::user_string_n2 â - Retrieves string of given length from user space -
function::user_string_n_warn â - Retrieves string from user space -
function::user_string_n_quoted â - Retrieves and quotes string from user space -
function::user_char â - Retrieves a char value stored in user space -
function::user_char_warn â - Retrieves a char value stored in user space -
function::user_short â - Retrieves a short value stored in user space -
function::user_short_warn â - Retrieves a short value stored in user space -
function::user_ushort â - Retrieves an unsigned short value stored in user space -
function::user_ushort_warn â - Retrieves an unsigned short value stored in user space -
function::user_int â - Retrieves an int value stored in user space -
function::user_int_warn â - Retrieves an int value stored in user space -
function::user_long â - Retrieves a long value stored in user space -
function::user_long_warn â - Retrieves a long value stored in user space -
function::user_int8 â - Retrieves a 8-bit integer value stored in user space -
function::user_uint8 â - Retrieves an unsigned 8-bit integer value stored in user space -
function::user_int16 â - Retrieves a 16-bit integer value stored in user space -
function::user_uint16 â - Retrieves an unsigned 16-bit integer value stored in user space -
function::user_int32 â - Retrieves a 32-bit integer value stored in user space -
function::user_uint32 â - Retrieves an unsigned 32-bit integer value stored in user space -
function::user_int64 â - Retrieves a 64-bit integer value stored in user space -
function::user_uint64 â - Retrieves an unsigned 64-bit integer value stored in user space -

24. String and data writing functions Tapset

function::set_kernel_string â - Writes a string to kernel memory -
function::set_kernel_string_n â - Writes a string of given length to kernel memory -
function::set_kernel_long â - Writes a long value to kernel memory -
function::set_kernel_int â - Writes an int value to kernel memory -
function::set_kernel_short â - Writes a short value to kernel memory -
function::set_kernel_char â - Writes a char value to kernel memory -
function::set_kernel_pointer â - Writes a pointer value to kernel memory. -

25. A collection of standard string functions

function::strlen â - Returns the length of a string -
function::substr â - Returns a substring -
function::stringat â - Returns the char at a given position in the string -
function::isinstr â - Returns whether a string is a substring of another string -
function::text_str â - Escape any non-printable chars in a string -
function::text_strn â - Escape any non-printable chars in a string -
function::str_replace â - str_replace Replaces all instances of a substring with another -
function::strtol â - strtol - Convert a string to a long -
function::isdigit â - Checks for a digit -
function::tokenize â - Return the next non-empty token in a string -

26. Utility functions for using ansi control chars in logs

function::ansi_clear_screen â - Move cursor to top left and clear screen. -
function::ansi_set_color â - Set the ansi Select Graphic Rendition mode. -
function::ansi_set_color2 â - Set the ansi Select Graphic Rendition mode. -
function::ansi_set_color3 â - Set the ansi Select Graphic Rendition mode. -
function::ansi_reset_color â - Resets Select Graphic Rendition mode. -
function::ansi_new_line â - Move cursor to new line. -
function::ansi_cursor_move â - Move cursor to new coordinates. -
function::ansi_cursor_hide â - Hides the cursor. -
function::ansi_cursor_save â - Saves the cursor position. -
function::ansi_cursor_restore â - Restores a previously saved cursor position. -
function::ansi_cursor_show â - Shows the cursor. -
function::thread_indent â - returns an amount of space with the current task information -
function::indent â - returns an amount of space to indent -

27. SystemTap Translator Tapset

probe::stap.pass0 â - Starting stap pass0 (parsing command line arguments) -
probe::stap.pass0.end â - Finished stap pass0 (parsing command line arguments) -
probe::stap.pass1a â - Starting stap pass1 (parsing user script) -
probe::stap.pass1b â - Starting stap pass1 (parsing library scripts) -
probe::stap.pass1.end â - Finished stap pass1 (parsing scripts) -
probe::stap.pass2 â - Starting stap pass2 (elaboration) -
probe::stap.pass2.end â - Finished stap pass2 (elaboration) -
probe::stap.pass3 â - Starting stap pass3 (translation to C) -
probe::stap.pass3.end â - Finished stap pass3 (translation to C) -
probe::stap.pass4 â - Starting stap pass4 (compile C code into kernel module) -
probe::stap.pass4.end â - Finished stap pass4 (compile C code into kernel module) -
probe::stap.pass5 â - Starting stap pass5 (running the instrumentation) -
probe::stap.pass5.end â - Finished stap pass5 (running the instrumentation) -
probe::stap.pass6 â - Starting stap pass6 (cleanup) -
probe::stap.pass6.end â - Finished stap pass6 (cleanup) -
probe::stap.cache_clean â - Removing file from stap cache -
probe::stap.cache_add_mod â - Adding kernel instrumentation module to cache -
probe::stap.cache_add_src â - Adding C code translation to cache -
probe::stap.cache_add_nss â - Add NSS (Network Security Services) information to cache -
probe::stap.cache_get â - Found item in stap cache -
probe::stap.system â - Starting a command from stap -
probe::stap.system.spawn â - stap spawned new process -
probe::stap.system.return â - Finished a command from stap -
probe::staprun.insert_module â - Inserting SystemTap instrumentation module -
probe::staprun.remove_module â - Removing SystemTap instrumentation module -
probe::staprun.send_control_message â - Sending a control message -
probe::stapio.receive_control_message â - Recieved a control message -

PrevÂ	Up	Â Next
function::jiffiesÂ	Home	Â function::gettimeofday_ns

PrevÂ	Up	Â Next
probe::vm.pagefault.returnÂ	Home	Â probe::vm.write_shared

PrevÂ	Up	Â Next
function::stack_unusedÂ	Home	Â function::uaddr

PrevÂ	Up	Â Next
function::ansi_cursor_moveÂ	Home	Â function::ansi_cursor_save

PrevÂ	Up	Â Next
function::ansi_new_lineÂ	Home	Â function::ansi_cursor_hide

PrevÂ	Up	Â Next
function::ansi_cursor_saveÂ	Home	Â function::ansi_cursor_show

PrevÂ	Up	Â Next
function::ansi_cursor_hideÂ	Home	Â function::ansi_cursor_restore

PrevÂ	Up	Â Next
function::ansi_cursor_restoreÂ	Home	Â function::thread_indent

PrevÂ	Up	Â Next
function::ansi_reset_colorÂ	Home	Â function::ansi_cursor_move

PrevÂ	Up	Â Next
function::ansi_set_color3Â	Home	Â function::ansi_new_line

PrevÂ	Up	Â Next
function::ansi_clear_screenÂ	Home	Â function::ansi_set_color2

PrevÂ	Up	Â Next
function::ansi_set_colorÂ	Home	Â function::ansi_set_color3

PrevÂ	Up	Â Next
function::ansi_set_color2Â	Home	Â function::ansi_reset_color

PrevÂ	Up	Â Next
function::sprint_backtraceÂ	Home	Â function::task_backtrace

PrevÂ	Up	Â Next
function::mem_page_sizeÂ	Home	Â function::pages_to_string

PrevÂ	Up	Â Next
function::callerÂ	Home	Â function::print_ubacktrace

PrevÂ	Up	Â Next
function::task_backtraceÂ	Home	Â function::caller_addr

PrevÂ	Up	Â Next
function::cmdline_argsÂ	Home	Â function::cmdline_str

PrevÂ	Up	Â Next
function::uaddrÂ	Home	Â function::cmdline_arg

PrevÂ	Up	Â Next
function::cmdline_argÂ	Home	Â function::env_var

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

Name

Synopsis

Arguments

Description

PrevÂ	Up	Â Next
function::task_stime_tidÂ	Home	Â function::msecs_to_string

PrevÂ	Up	Â Next
function::msecs_to_stringÂ	Home	Â function::task_time_string

PrevÂ	Up	Â Next
ChapterÂ 4.Â Time utility functionsÂ	Home	Â function::tz_gmtoff

PrevÂ	Up	Â Next
ChapterÂ 19.Â Directory-entry (dentry) TapsetÂ	Home	Â function::inode_name

PrevÂ	Up	Â Next
function::task_dentry_pathÂ	Home	Â ChapterÂ 20.Â Logging Tapset

PrevÂ	Up	Â Next
function::cmdline_strÂ	Home	Â function::print_stack

PrevÂ	Up	Â Next
ChapterÂ 18.Â Errno TapsetÂ	Home	Â function::returnstr

PrevÂ	Up	Â Next
function::errorÂ	Home	Â ChapterÂ 21.Â Queue Statistics Tapset

PrevÂ	Up	Â Next
ChapterÂ 3.Â Timestamp FunctionsÂ	Home	Â function::jiffies

PrevÂ	Up	Â Next
function::gettimeofday_usÂ	Home	Â function::gettimeofday_s