section 3stap · Library functions 📚

F

• function::abort(3stap)Immediately shutting down probing script.✨
• function::addr(3stap)Address of the current probe point.✨
• function::addr_to_node(3stap)Returns which node a given address belongs to within a NUMA system✨
• function::ansi_clear_screen(3stap)Move cursor to top left and clear screen.✨
• function::ansi_cursor_hide(3stap)Hides the cursor.✨
• function::ansi_cursor_move(3stap)Move cursor to new coordinates.✨
• function::ansi_cursor_restore(3stap)Restores a previously saved cursor position.✨
• function::ansi_cursor_save(3stap)Saves the cursor position.✨
• function::ansi_cursor_show(3stap)Shows the cursor.✨
• function::ansi_new_line(3stap)Move cursor to new line.✨
• function::ansi_reset_color(3stap)Resets Select Graphic Rendition mode.✨
• function::ansi_set_color(3stap)Set the ansi Select Graphic Rendition mode.✨
• function::asmlinkage(3stap)Mark function as declared asmlinkage✨
• function::assert(3stap)evaluate assertion✨
• function::atomic_long_read(3stap)Retrieves an atomic long variable from kernel memory✨
• function::atomic_read(3stap)Retrieves an atomic variable from kernel memory✨
• function::backtrace(3stap)Hex backtrace of current kernel stack✨
• function::bytes_to_string(3stap)Human readable string for given bytes✨
• function::caller(3stap)Return name and address of calling function✨
• function::caller_addr(3stap)Return caller address✨
• function::callers(3stap)Return first n elements of kernel stack backtrace✨
• function::cmdline_arg(3stap)Fetch a command line argument✨
• function::cmdline_args(3stap)Fetch command line arguments from current process✨
• function::cmdline_str(3stap)Fetch all command line arguments from current process✨
• function::commit(3stap)Write out all output related to a speculation buffer✨
• function::cpu(3stap)Returns the current cpu number✨
• function::cpu_clock_ms(3stap)Number of milliseconds on the given cpu's clock✨
• function::cpu_clock_ns(3stap)Number of nanoseconds on the given cpu's clock✨
• function::cpu_clock_s(3stap)Number of seconds on the given cpu's clock✨
• function::cpu_clock_us(3stap)Number of microseconds on the given cpu's clock✨
• function::cpuid(3stap)Returns the current cpu number✨
• function::cputime_to_msecs(3stap)Translates the given cputime into milliseconds✨
• function::cputime_to_string(3stap)Human readable string for given cputime✨
• function::cputime_to_usecs(3stap)Translates the given cputime into microseconds✨
• function::ctime(3stap)Convert seconds since epoch into human readable date/time string✨
• function::current_exe_file(3stap)get the file struct pointer for the current task's executable file✨
• function::cve_count_metric(3stap)Increment the count of key✨
• function::cve_record_metric(3stap)Set the value of key✨
• function::cve_tmpdisable(3stap)Disable the cve livepatch✨
• function::d_name(3stap)get the dirent name✨
• function::d_path(3stap)get the full nameidata path✨
• function::delete_stopwatch(3stap)Remove an existing stopwatch✨
• function::discard(3stap)Discard all output related to a speculation buffer✨
• function::dump_stack(3stap)Send the kernel backtrace to the kernel trace buffer✨
• function::egid(3stap)Returns the effective gid of a target process✨
• function::env_var(3stap)Fetch environment variable from current process✨
• function::errno_str(3stap)Symbolic string associated with error code✨
• function::error(3stap)Send an error message✨
• function::euid(3stap)Return the effective uid of a target process✨
• function::execname(3stap)Returns the execname of a target process (or group of processes)✨
• function::exit(3stap)Start shutting down probing script.✨
• function::fastcall(3stap)Mark function as declared fastcall✨
• function::format_ipaddr(3stap)Returns a string representation for an IP address✨
• function::fp32_to_fp64(3stap)Convert fp32 to 64 bit floating point✨
• function::fp_add(3stap)Addition between floating points✨
• function::fp_eq(3stap)fp comparison function equal✨
• function::fp_le(3stap)Check if first fp is less than or equal to✨
• function::fp_lt(3stap)fp comparison function less than✨
• function::fp_mul(3stap)Multiplication between floating points✨
• function::fp_rem(3stap)Floating point division✨
• function::fp_sqrt(3stap)Floating point square root✨
• function::fp_sub(3stap)Subtraction between floating points✨
• function::fp_to_long(3stap)Convert fp to int64✨
• function::fp_to_string(3stap)Convert 64 bit floating point to string✨
• function::ftrace(3stap)Send a message to the ftrace ring-buffer✨
• function::fullpath_struct_file(3stap)get the full path✨
• function::fullpath_struct_nameidata(3stap)get the full nameidata path✨
• function::fullpath_struct_path(3stap)get the full path✨
• function::get_cycles(3stap)Processor cycle count✨
• function::get_loadavg_index(3stap)Get the load average for a specified interval✨
• function::get_sa_flags(3stap)Returns the numeric value of sa_flags✨
• function::get_sa_handler(3stap)Returns the numeric value of sa_handler✨
• function::gettimeofday_ms(3stap)Number of milliseconds since UNIX epoch✨
• function::gettimeofday_ns(3stap)Number of nanoseconds since UNIX epoch✨
• function::gettimeofday_s(3stap)Number of seconds since UNIX epoch✨
• function::gettimeofday_us(3stap)Number of microseconds since UNIX epoch✨
• function::gid(3stap)Returns the group ID of a target process✨
• function::htonl(3stap)Convert 32-bit long from host to network order✨
• function::htonll(3stap)Convert 64-bit long long from host to network order✨
• function::htons(3stap)Convert 16-bit short from host to network order✨
• function::HZ(3stap)Kernel HZ✨
• function::indent(3stap)returns an amount of space to indent✨
• function::indent_depth(3stap)returns the global nested-depth✨
• function::inet_get_dest_port(3stap)Provide remote port number for a kernel socket✨
• function::inet_get_ip_dest(3stap)Provide IP destination address string for a kernel socket✨
• function::inet_get_ip_source(3stap)Provide IP source address string for a kernel socket✨
• function::inet_get_local_port(3stap)Provide local port number for a kernel socket✨
• function::inode_name(3stap)get the inode name✨
• function::inode_path(3stap)get the path to an inode✨
• function::int_arg(3stap)Return function argument as signed int✨
• function::ip_ntop(3stap)Returns a string representation for an IPv4 address✨
• function::ipmib_filter_key(3stap)Default filter function for ipmib.* probes✨
• function::ipmib_get_proto(3stap)Get the protocol value✨
• function::ipmib_local_addr(3stap)Get the local ip address✨
• function::ipmib_remote_addr(3stap)Get the remote ip address✨
• function::ipmib_tcp_local_port(3stap)Get the local tcp port✨
• function::ipmib_tcp_remote_port(3stap)Get the remote tcp port✨
• function::is_myproc(3stap)Determines if the current probe point has occurred in the user's own process✨
• function::is_return(3stap)Whether the current probe context is a return probe✨
• function::is_sig_blocked(3stap)Returns 1 if the signal is currently blocked, or 0 if it is not✨
• function::isdigit(3stap)Checks for a digit✨
• function::isinstr(3stap)Returns whether a string is a substring of another string✨
• function::jiffies(3stap)Kernel jiffies count✨
• function::json_add_array(3stap)Add an array✨
• function::json_add_array_numeric_metric(3stap)Add a numeric metric to an array✨
• function::json_add_array_string_metric(3stap)Add a string metric to an array✨
• function::json_add_numeric_metric(3stap)Add a numeric metric✨
• function::json_add_string_metric(3stap)Add a string metric✨
• function::json_set_prefix(3stap)Set the metric prefix.✨
• function::kernel_buffer_quoted(3stap)Retrieves and quotes buffer from kernel space✨
• function::kernel_buffer_quoted_error(3stap)Retrieves and quotes buffer from kernel space✨
• function::kernel_char(3stap)Retrieves a char value stored in kernel memory✨
• function::kernel_int(3stap)Retrieves an int value stored in kernel memory✨
• function::kernel_long(3stap)Retrieves a long value stored in kernel memory✨
• function::kernel_or_user_string_quoted(3stap)Retrieves and quotes string from kernel or user memory✨
• function::kernel_or_user_string_quoted_utf16(3stap)Retrieves and quotes UTF-16 string from kernel or user memory✨
• function::kernel_or_user_string_quoted_utf32(3stap)Retrieves and quotes UTF-32 string from kernel or user memory✨
• function::kernel_pointer(3stap)Retrieves a pointer value stored in kernel memory✨
• function::kernel_short(3stap)Retrieves a short value stored in kernel memory✨
• function::kernel_string(3stap)Retrieves string from kernel memory✨
• function::kernel_string_n(3stap)Retrieves string of given length from kernel memory✨
• function::kernel_string_quoted(3stap)Retrieves and quotes string from kernel memory✨
• function::kernel_string_quoted_utf16(3stap)Quote given kernel UTF-16 string.✨
• function::kernel_string_quoted_utf32(3stap)Quote given UTF-32 kernel string.✨
• function::kernel_string_utf16(3stap)Retrieves UTF-16 string from kernel memory✨
• function::kernel_string_utf32(3stap)Retrieves UTF-32 string from kernel memory✨
• function::ktime_get_ns(3stap)Number of nanoseconds since boot✨
• function::linuxmib_filter_key(3stap)Default filter function for linuxmib.* probes✨
• function::local_clock_ms(3stap)Number of milliseconds on the local cpu's clock✨
• function::local_clock_ns(3stap)Number of nanoseconds on the local cpu's clock✨
• function::local_clock_s(3stap)Number of seconds on the local cpu's clock✨
• function::local_clock_us(3stap)Number of microseconds on the local cpu's clock✨
• function::log(3stap)Send a line to the common trace buffer✨
• function::long_arg(3stap)Return function argument as signed long✨
• function::long_to_fp(3stap)Convert long int to 64 bit floating point✨
• function::longlong_arg(3stap)Return function argument as 64-bit value✨
• function::MAJOR(3stap)Extract major device number from a kernel device number (kdev_t)✨
• function::matched(3stap)Return a given matched subexpression.✨
• function::matched_str(3stap)Return the last matched string.✨
• function::mdelay(3stap)millisecond delay✨
• function::mem_page_size(3stap)Number of bytes in a page for this architecture✨
• function::MINOR(3stap)Extract minor device number from a kernel device number (kdev_t)✨
• function::MKDEV(3stap)Creates a value that can be compared to a kernel device number (kdev_t)✨
• function::modname(3stap)Return the kernel module name loaded at the address✨
• function::module_name(3stap)The module name of the current script✨
• function::module_size(3stap)The module size of the current script✨
• function::msecs_to_string(3stap)Human readable string for given milliseconds✨
• function::nfsderror(3stap)Convert nfsd error number into string✨
• function::ngroups(3stap)Number of subexpressions in the last match.✨
• function::ns_egid(3stap)Returns the effective gid of a target process as seen in a user namespace✨
• function::ns_euid(3stap)Returns the effective user ID of a target process as seen in a user namespace✨
• function::ns_gid(3stap)Returns the group ID of a target process as seen in a user namespace✨
• function::ns_pgrp(3stap)Returns the process group ID of the current process as seen in a pid namespace✨
• function::ns_pid(3stap)Returns the ID of a target process as seen in a pid namespace✨
• function::ns_ppid(3stap)Returns the process ID of a target process's parent process as seen in a pid namespace✨
• function::ns_sid(3stap)Returns the session ID of the current process as seen in a pid namespace✨
• function::ns_tid(3stap)Returns the thread ID of a target process as seen in a pid namespace✨
• function::ns_uid(3stap)Returns the user ID of a target process as seen in a user namespace✨
• function::nsecs_to_string(3stap)Human readable string for given nanoseconds✨
• function::ntohl(3stap)Convert 32-bit long from network to host order✨
• function::ntohll(3stap)Convert 64-bit long long from network to host order✨
• function::ntohs(3stap)Convert 16-bit short from network to host order✨
• function::pages_to_string(3stap)Turns pages into a human readable string✨
• function::panic(3stap)trigger a panic✨
• function::pexecname(3stap)Returns the execname of a target process's parent process✨
• function::pgrp(3stap)Returns the process group ID of the current process✨
• function::pid(3stap)Returns the ID of a target process✨
• function::pid2execname(3stap)The name of the given process identifier✨
• function::pid2task(3stap)The task_struct of the given process identifier✨
• function::pn(3stap)Returns the active probe name✨
• function::pnlabel(3stap)Returns the label name parsed from the probe name✨
• function::pointer_arg(3stap)Return function argument as pointer value✨
• function::pp(3stap)Returns the active probe point✨
• function::ppfunc(3stap)Returns the function name parsed from pp✨
• function::ppid(3stap)Returns the process ID of a target process's parent process✨
• function::print_backtrace(3stap)Print kernel stack back trace✨
• function::print_backtrace_fileline(3stap)Print kernel stack back trace✨
• function::print_regs(3stap)Print a register dump✨
• function::print_stack(3stap)Print out kernel stack from string✨
• function::print_syms(3stap)Print out kernel stack from string✨
• function::print_ubacktrace(3stap)Print stack back trace for current user-space task.✨
• function::print_ubacktrace_brief(3stap)Print stack back trace for current user-space task.✨
• function::print_ubacktrace_fileline(3stap)Print stack back trace for current user-space task.✨
• function::print_ustack(3stap)Print out stack for the current task from string.✨
• function::print_usyms(3stap)Print out user stack from string✨
• function::printk(3stap)Send a message to the kernel trace buffer✨
• function::probe_type(3stap)The low level probe handler type of the current probe.✨
• function::probefunc(3stap)Return the probe point's function name, if known✨
• function::probemod(3stap)Return the probe point's kernel module name✨
• function::proc_mem_data(3stap)Program data size (data + stack) in pages✨
• function::proc_mem_rss(3stap)Program resident set size in pages✨
• function::proc_mem_shr(3stap)Program shared pages (from shared mappings)✨
• function::proc_mem_size(3stap)Total program virtual memory size in pages✨
• function::proc_mem_string(3stap)Human readable string of process memory usage✨
• function::proc_mem_txt(3stap)Program text (code) size in pages✨
• function::pstrace(3stap)Chain of processes and pids back to init(1)✨
• function::qs_done(3stap)Function to record finishing request✨
• function::qs_run(3stap)Function to record being moved from wait queue to being serviced✨
• function::qs_wait(3stap)Function to record enqueue requests✨
• function::qsq_blocked(3stap)Returns the time reqest was on the wait queue✨