From 05b2ad202ea27c646086a86111ed03648cb395ea Mon Sep 17 00:00:00 2001 From: fche Date: Mon, 28 Sep 2009 19:58:03 +0000 Subject: [PATCH] regenerate man pages fight with man2html profit --- man/REGEN.sh | 19 +- man/addr_to_node.3stap.html | 72 ++ man/backtrace.3stap.html | 77 ++ man/caller.3stap.html | 85 ++ man/caller_addr.3stap.html | 77 ++ man/cpu.3stap.html | 68 ++ man/d_name.3stap.html | 81 ++ man/d_path.3stap.html | 81 ++ man/egid.3stap.html | 68 ++ man/error.3stap.html | 81 ++ man/euid.3stap.html | 68 ++ man/execname.3stap.html | 68 ++ man/exit.3stap.html | 77 ++ man/ftrace.3stap.html | 79 ++ man/get_cycles.3stap.html | 77 ++ man/gid.3stap.html | 68 ++ man/index.html | 174 +++ man/ioscheduler.elv_add_request.3stap.html | 100 ++ ...scheduler.elv_completed_request.3stap.html | 100 ++ man/ioscheduler.elv_next_request.3stap.html | 72 ++ ...heduler.elv_next_request.return.3stap.html | 93 ++ man/ip_ntop.3stap.html | 72 ++ man/is_myproc.3stap.html | 77 ++ man/is_return.3stap.html | 77 ++ man/kprocess.create.3stap.html | 86 ++ man/kprocess.exec.3stap.html | 86 ++ man/kprocess.exec_complete.3stap.html | 93 ++ man/kprocess.exit.3stap.html | 86 ++ man/kprocess.release.3stap.html | 93 ++ man/kprocess.start.3stap.html | 82 ++ man/log.3stap.html | 81 ++ man/modname.3stap.html | 82 ++ man/netdev.change_mac.3stap.html | 93 ++ man/netdev.change_mtu.3stap.html | 86 ++ man/netdev.change_rx_flag.3stap.html | 79 ++ man/netdev.close.3stap.html | 72 ++ man/netdev.get_stats.3stap.html | 72 ++ man/netdev.hard_transmit.3stap.html | 93 ++ man/netdev.ioctl.3stap.html | 79 ++ man/netdev.open.3stap.html | 72 ++ man/netdev.receive.3stap.html | 86 ++ man/netdev.register.3stap.html | 72 ++ man/netdev.rx.3stap.html | 79 ++ man/netdev.set_promiscuity.3stap.html | 93 ++ man/netdev.transmit.3stap.html | 93 ++ man/netdev.unregister.3stap.html | 72 ++ man/pexecname.3stap.html | 68 ++ man/pgrp.3stap.html | 68 ++ man/pid.3stap.html | 68 ++ man/pp.3stap.html | 82 ++ man/ppid.3stap.html | 68 ++ man/print_backtrace.3stap.html | 77 ++ man/print_regs.3stap.html | 68 ++ man/print_stack.3stap.html | 82 ++ man/print_ubacktrace.3stap.html | 77 ++ man/print_ustack.3stap.html | 82 ++ man/probefunc.3stap.html | 68 ++ man/probemod.3stap.html | 68 ++ man/randint.3stap.html | 72 ++ man/registers_valid.3stap.html | 81 ++ man/reverse_path_walk.3stap.html | 81 ++ man/scsi.iocompleted.3stap.html | 114 ++ man/scsi.iodispatching.3stap.html | 121 ++ man/scsi.iodone.3stap.html | 107 ++ man/scsi.ioentry.3stap.html | 86 ++ man/sid.3stap.html | 77 ++ man/signal.check_ignored.3stap.html | 93 ++ man/signal.check_ignored.return.3stap.html | 79 ++ man/signal.checkperm.3stap.html | 121 ++ man/signal.checkperm.return.3stap.html | 79 ++ man/signal.do_action.3stap.html | 100 ++ man/signal.do_action.return.3stap.html | 72 ++ man/signal.flush.3stap.html | 86 ++ man/signal.force_segv.3stap.html | 93 ++ man/signal.force_segv.return.3stap.html | 5 + man/signal.handle.3stap.html | 114 ++ man/signal.handle.return.3stap.html | 72 ++ man/signal.pending.3stap.html | 86 ++ man/signal.pending.return.3stap.html | 72 ++ man/signal.procmask.3stap.html | 93 ++ man/signal.send.3stap.html | 142 +++ man/signal.send.return.3stap.html | 125 ++ man/signal.send_sig_queue.3stap.html | 100 ++ man/signal.send_sig_queue.return.3stap.html | 72 ++ man/signal.sys_tgkill.3stap.html | 100 ++ man/signal.sys_tgkill.return.3stap.html | 5 + man/signal.sys_tkill.3stap.html | 93 ++ man/signal.syskill.3stap.html | 79 ++ man/signal.syskill.return.3stap.html | 68 ++ man/signal.systkill.return.3stap.html | 68 ++ man/signal.wakeup.3stap.html | 93 ++ man/sock_fam_num2str.3stap.html | 72 ++ man/sock_fam_str2num.3stap.html | 79 ++ man/sock_prot_num2str.3stap.html | 72 ++ man/sock_prot_str2num.3stap.html | 72 ++ man/sock_state_num2str.3stap.html | 72 ++ man/sock_state_str2num.3stap.html | 72 ++ man/socket.aio_read.3stap.html | 130 ++ man/socket.aio_read.return.3stap.html | 137 +++ man/socket.aio_write.3stap.html | 130 ++ man/socket.aio_write.return.3stap.html | 137 +++ man/socket.close.3stap.html | 121 ++ man/socket.close.return.3stap.html | 86 ++ man/socket.create.3stap.html | 114 ++ man/socket.create.return.3stap.html | 128 ++ man/socket.readv.3stap.html | 130 ++ man/socket.readv.return.3stap.html | 137 +++ man/socket.receive.3stap.html | 128 ++ man/socket.recvmsg.3stap.html | 130 ++ man/socket.recvmsg.return.3stap.html | 137 +++ man/socket.send.3stap.html | 128 ++ man/socket.sendmsg.3stap.html | 130 ++ man/socket.sendmsg.return.3stap.html | 137 +++ man/socket.writev.3stap.html | 130 ++ man/socket.writev.return.3stap.html | 137 +++ man/stack_size.3stap.html | 68 ++ man/stack_unused.3stap.html | 77 ++ man/stack_used.3stap.html | 77 ++ man/stap-server.8.html | 555 +++++++++ man/stap.1.html | 639 ++++++++-- man/{stapex.5.html => stapex.3stap.html} | 48 +- ...{stapfuncs.5.html => stapfuncs.3stap.html} | 334 ++++-- man/stapprobes.3stap.html | 1065 +++++++++++++++++ man/stapprobes.3stap~.html | 1065 +++++++++++++++++ man/stapprobes.5.html | 610 ---------- ...d.5.html => stapprobes.iosched.3stap.html} | 8 +- ....5.html => stapprobes.kprocess.3stap.html} | 32 +- ...ev.5.html => stapprobes.netdev.3stap.html} | 10 +- ...s.nfs.5.html => stapprobes.nfs.3stap.html} | 46 +- ...nfsd.5.html => stapprobes.nfsd.3stap.html} | 30 +- ...5.html => stapprobes.pagefault.3stap.html} | 8 +- ...s.rpc.5.html => stapprobes.rpc.3stap.html} | 16 +- ...scsi.5.html => stapprobes.scsi.3stap.html} | 8 +- ...al.5.html => stapprobes.signal.3stap.html} | 18 +- ...et.5.html => stapprobes.socket.3stap.html} | 12 +- ...s.tcp.5.html => stapprobes.tcp.3stap.html} | 8 +- ...s.udp.5.html => stapprobes.udp.3stap.html} | 8 +- man/staprun.8.html | 115 +- man/stapvars.3stap.html | 93 ++ man/symdata.3stap.html | 79 ++ man/symname.3stap.html | 79 ++ man/target.3stap.html | 68 ++ man/task_backtrace.3stap.html | 79 ++ man/tcp.disconnect.3stap.html | 121 ++ man/tcp.disconnect.return.3stap.html | 86 ++ man/tcp.receive.3stap.html | 135 +++ man/tcp.recvmsg.3stap.html | 121 ++ man/tcp.recvmsg.return.3stap.html | 114 ++ man/tcp.sendmsg.3stap.html | 93 ++ man/tcp.sendmsg.return.3stap.html | 86 ++ man/tcp.setsockopt.3stap.html | 115 ++ man/tcp.setsockopt.return.3stap.html | 86 ++ man/tid.3stap.html | 68 ++ man/uaddr.3stap.html | 78 ++ man/ubacktrace.3stap.html | 77 ++ man/udp.disconnect.3stap.html | 93 ++ man/udp.disconnect.return.3stap.html | 86 ++ man/udp.recvmsg.3stap.html | 93 ++ man/udp.recvmsg.return.3stap.html | 86 ++ man/udp.sendmsg.3stap.html | 93 ++ man/udp.sendmsg.return.3stap.html | 86 ++ man/uid.3stap.html | 68 ++ man/user_mode.3stap.html | 77 ++ man/usymdata.3stap.html | 79 ++ man/usymname.3stap.html | 79 ++ man/vm.brk.3stap.html | 86 ++ man/vm.mmap.3stap.html | 86 ++ man/vm.munmap.3stap.html | 86 ++ man/vm.oom_kill.3stap.html | 79 ++ man/vm.pagefault.3stap.html | 86 ++ man/vm.pagefault.return.3stap.html | 72 ++ man/vm.write_shared.3stap.html | 86 ++ man/vm.write_shared_copy.3stap.html | 93 ++ man/vm_fault_contains.3stap.html | 79 ++ man/warn.3stap.html | 80 ++ 175 files changed, 17366 insertions(+), 954 deletions(-) create mode 100644 man/addr_to_node.3stap.html create mode 100644 man/backtrace.3stap.html create mode 100644 man/caller.3stap.html create mode 100644 man/caller_addr.3stap.html create mode 100644 man/cpu.3stap.html create mode 100644 man/d_name.3stap.html create mode 100644 man/d_path.3stap.html create mode 100644 man/egid.3stap.html create mode 100644 man/error.3stap.html create mode 100644 man/euid.3stap.html create mode 100644 man/execname.3stap.html create mode 100644 man/exit.3stap.html create mode 100644 man/ftrace.3stap.html create mode 100644 man/get_cycles.3stap.html create mode 100644 man/gid.3stap.html create mode 100644 man/index.html create mode 100644 man/ioscheduler.elv_add_request.3stap.html create mode 100644 man/ioscheduler.elv_completed_request.3stap.html create mode 100644 man/ioscheduler.elv_next_request.3stap.html create mode 100644 man/ioscheduler.elv_next_request.return.3stap.html create mode 100644 man/ip_ntop.3stap.html create mode 100644 man/is_myproc.3stap.html create mode 100644 man/is_return.3stap.html create mode 100644 man/kprocess.create.3stap.html create mode 100644 man/kprocess.exec.3stap.html create mode 100644 man/kprocess.exec_complete.3stap.html create mode 100644 man/kprocess.exit.3stap.html create mode 100644 man/kprocess.release.3stap.html create mode 100644 man/kprocess.start.3stap.html create mode 100644 man/log.3stap.html create mode 100644 man/modname.3stap.html create mode 100644 man/netdev.change_mac.3stap.html create mode 100644 man/netdev.change_mtu.3stap.html create mode 100644 man/netdev.change_rx_flag.3stap.html create mode 100644 man/netdev.close.3stap.html create mode 100644 man/netdev.get_stats.3stap.html create mode 100644 man/netdev.hard_transmit.3stap.html create mode 100644 man/netdev.ioctl.3stap.html create mode 100644 man/netdev.open.3stap.html create mode 100644 man/netdev.receive.3stap.html create mode 100644 man/netdev.register.3stap.html create mode 100644 man/netdev.rx.3stap.html create mode 100644 man/netdev.set_promiscuity.3stap.html create mode 100644 man/netdev.transmit.3stap.html create mode 100644 man/netdev.unregister.3stap.html create mode 100644 man/pexecname.3stap.html create mode 100644 man/pgrp.3stap.html create mode 100644 man/pid.3stap.html create mode 100644 man/pp.3stap.html create mode 100644 man/ppid.3stap.html create mode 100644 man/print_backtrace.3stap.html create mode 100644 man/print_regs.3stap.html create mode 100644 man/print_stack.3stap.html create mode 100644 man/print_ubacktrace.3stap.html create mode 100644 man/print_ustack.3stap.html create mode 100644 man/probefunc.3stap.html create mode 100644 man/probemod.3stap.html create mode 100644 man/randint.3stap.html create mode 100644 man/registers_valid.3stap.html create mode 100644 man/reverse_path_walk.3stap.html create mode 100644 man/scsi.iocompleted.3stap.html create mode 100644 man/scsi.iodispatching.3stap.html create mode 100644 man/scsi.iodone.3stap.html create mode 100644 man/scsi.ioentry.3stap.html create mode 100644 man/sid.3stap.html create mode 100644 man/signal.check_ignored.3stap.html create mode 100644 man/signal.check_ignored.return.3stap.html create mode 100644 man/signal.checkperm.3stap.html create mode 100644 man/signal.checkperm.return.3stap.html create mode 100644 man/signal.do_action.3stap.html create mode 100644 man/signal.do_action.return.3stap.html create mode 100644 man/signal.flush.3stap.html create mode 100644 man/signal.force_segv.3stap.html create mode 100644 man/signal.force_segv.return.3stap.html create mode 100644 man/signal.handle.3stap.html create mode 100644 man/signal.handle.return.3stap.html create mode 100644 man/signal.pending.3stap.html create mode 100644 man/signal.pending.return.3stap.html create mode 100644 man/signal.procmask.3stap.html create mode 100644 man/signal.send.3stap.html create mode 100644 man/signal.send.return.3stap.html create mode 100644 man/signal.send_sig_queue.3stap.html create mode 100644 man/signal.send_sig_queue.return.3stap.html create mode 100644 man/signal.sys_tgkill.3stap.html create mode 100644 man/signal.sys_tgkill.return.3stap.html create mode 100644 man/signal.sys_tkill.3stap.html create mode 100644 man/signal.syskill.3stap.html create mode 100644 man/signal.syskill.return.3stap.html create mode 100644 man/signal.systkill.return.3stap.html create mode 100644 man/signal.wakeup.3stap.html create mode 100644 man/sock_fam_num2str.3stap.html create mode 100644 man/sock_fam_str2num.3stap.html create mode 100644 man/sock_prot_num2str.3stap.html create mode 100644 man/sock_prot_str2num.3stap.html create mode 100644 man/sock_state_num2str.3stap.html create mode 100644 man/sock_state_str2num.3stap.html create mode 100644 man/socket.aio_read.3stap.html create mode 100644 man/socket.aio_read.return.3stap.html create mode 100644 man/socket.aio_write.3stap.html create mode 100644 man/socket.aio_write.return.3stap.html create mode 100644 man/socket.close.3stap.html create mode 100644 man/socket.close.return.3stap.html create mode 100644 man/socket.create.3stap.html create mode 100644 man/socket.create.return.3stap.html create mode 100644 man/socket.readv.3stap.html create mode 100644 man/socket.readv.return.3stap.html create mode 100644 man/socket.receive.3stap.html create mode 100644 man/socket.recvmsg.3stap.html create mode 100644 man/socket.recvmsg.return.3stap.html create mode 100644 man/socket.send.3stap.html create mode 100644 man/socket.sendmsg.3stap.html create mode 100644 man/socket.sendmsg.return.3stap.html create mode 100644 man/socket.writev.3stap.html create mode 100644 man/socket.writev.return.3stap.html create mode 100644 man/stack_size.3stap.html create mode 100644 man/stack_unused.3stap.html create mode 100644 man/stack_used.3stap.html create mode 100644 man/stap-server.8.html rename man/{stapex.5.html => stapex.3stap.html} (65%) rename man/{stapfuncs.5.html => stapfuncs.3stap.html} (59%) create mode 100644 man/stapprobes.3stap.html create mode 100644 man/stapprobes.3stap~.html delete mode 100644 man/stapprobes.5.html rename man/{stapprobes.iosched.5.html => stapprobes.iosched.3stap.html} (90%) rename man/{stapprobes.process.5.html => stapprobes.kprocess.3stap.html} (73%) rename man/{stapprobes.netdev.5.html => stapprobes.netdev.3stap.html} (88%) rename man/{stapprobes.nfs.5.html => stapprobes.nfs.3stap.html} (95%) rename man/{stapprobes.nfsd.5.html => stapprobes.nfsd.3stap.html} (92%) rename man/{stapprobes.pagefault.5.html => stapprobes.pagefault.3stap.html} (82%) rename man/{stapprobes.rpc.5.html => stapprobes.rpc.3stap.html} (98%) rename man/{stapprobes.scsi.5.html => stapprobes.scsi.3stap.html} (96%) rename man/{stapprobes.signal.5.html => stapprobes.signal.3stap.html} (96%) rename man/{stapprobes.socket.5.html => stapprobes.socket.3stap.html} (97%) rename man/{stapprobes.tcp.5.html => stapprobes.tcp.3stap.html} (88%) rename man/{stapprobes.udp.5.html => stapprobes.udp.3stap.html} (88%) create mode 100644 man/stapvars.3stap.html create mode 100644 man/symdata.3stap.html create mode 100644 man/symname.3stap.html create mode 100644 man/target.3stap.html create mode 100644 man/task_backtrace.3stap.html create mode 100644 man/tcp.disconnect.3stap.html create mode 100644 man/tcp.disconnect.return.3stap.html create mode 100644 man/tcp.receive.3stap.html create mode 100644 man/tcp.recvmsg.3stap.html create mode 100644 man/tcp.recvmsg.return.3stap.html create mode 100644 man/tcp.sendmsg.3stap.html create mode 100644 man/tcp.sendmsg.return.3stap.html create mode 100644 man/tcp.setsockopt.3stap.html create mode 100644 man/tcp.setsockopt.return.3stap.html create mode 100644 man/tid.3stap.html create mode 100644 man/uaddr.3stap.html create mode 100644 man/ubacktrace.3stap.html create mode 100644 man/udp.disconnect.3stap.html create mode 100644 man/udp.disconnect.return.3stap.html create mode 100644 man/udp.recvmsg.3stap.html create mode 100644 man/udp.recvmsg.return.3stap.html create mode 100644 man/udp.sendmsg.3stap.html create mode 100644 man/udp.sendmsg.return.3stap.html create mode 100644 man/uid.3stap.html create mode 100644 man/user_mode.3stap.html create mode 100644 man/usymdata.3stap.html create mode 100644 man/usymname.3stap.html create mode 100644 man/vm.brk.3stap.html create mode 100644 man/vm.mmap.3stap.html create mode 100644 man/vm.munmap.3stap.html create mode 100644 man/vm.oom_kill.3stap.html create mode 100644 man/vm.pagefault.3stap.html create mode 100644 man/vm.pagefault.return.3stap.html create mode 100644 man/vm.write_shared.3stap.html create mode 100644 man/vm.write_shared_copy.3stap.html create mode 100644 man/vm_fault_contains.3stap.html create mode 100644 man/warn.3stap.html diff --git a/man/REGEN.sh b/man/REGEN.sh index 3ec9bca1..a97d4bd5 100755 --- a/man/REGEN.sh +++ b/man/REGEN.sh @@ -5,16 +5,27 @@ # at a relative directory ../../src. It performs only dummy # autoconf-type @VALUE@ substitutions. +INSTTREE=${1-/dev/null} date=`date +"%Y-%m-%d"` -for manpage in ../../src/*.[158].in ../../src/man/*.[158].in + +echo "systemtap man page index" >> index.html diff --git a/man/addr_to_node.3stap.html b/man/addr_to_node.3stap.html new file mode 100644 index 00000000..e0da00ce --- /dev/null +++ b/man/addr_to_node.3stap.html @@ -0,0 +1,72 @@ + +Manpage of ADDR_TO_NODE + +

ADDR_TO_NODE

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +addr_to_node - Returns which node a given address belongs to within a NUMA system. +  +

SYNOPSIS

+ +

+

+    addr_to_node:long(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+The address of the faulting memory access. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/backtrace.3stap.html b/man/backtrace.3stap.html new file mode 100644 index 00000000..ea8f0d1b --- /dev/null +++ b/man/backtrace.3stap.html @@ -0,0 +1,77 @@ + +Manpage of BACKTRACE + +

BACKTRACE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +backtrace - Hex backtrace of current stack +  +

SYNOPSIS

+ +

+

+    backtrace:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return a string of hex addresses that are a backtrace of the stack. Output may be truncated as per maximum string length. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/caller.3stap.html b/man/caller.3stap.html new file mode 100644 index 00000000..dcbf51a0 --- /dev/null +++ b/man/caller.3stap.html @@ -0,0 +1,85 @@ + +Manpage of CALLER + +

CALLER

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +caller - Return name and address of calling function +  +

SYNOPSIS

+ +

+

+    caller:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return the address and name of the calling function. +  +

THIS IS EQUIVALENT TO CALLING

+ +

+ +sprintf(lqs 0xxrq, symname(caller_addr, +caller_addr)) <emphasis>Works only for return probes at this time.</emphasis> +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
THIS IS EQUIVALENT TO CALLING
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/caller_addr.3stap.html b/man/caller_addr.3stap.html new file mode 100644 index 00000000..961feaf5 --- /dev/null +++ b/man/caller_addr.3stap.html @@ -0,0 +1,77 @@ + +Manpage of CALLER_ADDR + +

CALLER_ADDR

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +caller_addr - Return caller address +  +

SYNOPSIS

+ +

+

+    caller_addr:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return the address of the calling function. <emphasis> Works only for return probes at this time.</emphasis> +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/cpu.3stap.html b/man/cpu.3stap.html new file mode 100644 index 00000000..6e8ecada --- /dev/null +++ b/man/cpu.3stap.html @@ -0,0 +1,68 @@ + +Manpage of CPU + +

CPU

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +cpu - Returns the current cpu number. +  +

SYNOPSIS

+ +

+

+    cpu:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/d_name.3stap.html b/man/d_name.3stap.html new file mode 100644 index 00000000..a11de8bb --- /dev/null +++ b/man/d_name.3stap.html @@ -0,0 +1,81 @@ + +Manpage of D_NAME + +

D_NAME

+Section: Directory-entry (dentry) Tapse (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +d_name - get the dirent name +  +

SYNOPSIS

+ +

+

+    d_name:string(dentry:long)
+
+ +  +

ARGUMENTS

+ +

+ +dentry +

+Pointer to dentry. +
+ +  +

DESCRIPTION

+ +

+ +

+ +Returns the dirent name (path basename). +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/d_path.3stap.html b/man/d_path.3stap.html new file mode 100644 index 00000000..2d9d6380 --- /dev/null +++ b/man/d_path.3stap.html @@ -0,0 +1,81 @@ + +Manpage of D_PATH + +

D_PATH

+Section: Directory-entry (dentry) Tapse (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +d_path - get the full nameidata path +  +

SYNOPSIS

+ +

+

+    d_path:string(nd:long)
+
+ +  +

ARGUMENTS

+ +

+ +nd +

+Pointer to nameidata. +
+ +  +

DESCRIPTION

+ +

+ +

+ +Returns the full dirent name (full path to the root), like the kernel d_path function. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/egid.3stap.html b/man/egid.3stap.html new file mode 100644 index 00000000..ca3adfff --- /dev/null +++ b/man/egid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of EGID + +

EGID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +egid - Returns the effective gid of a target process. +  +

SYNOPSIS

+ +

+

+    egid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/error.3stap.html b/man/error.3stap.html new file mode 100644 index 00000000..3a5e4b42 --- /dev/null +++ b/man/error.3stap.html @@ -0,0 +1,81 @@ + +Manpage of ERROR + +

ERROR

+Section: Logging Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +error - Send an error message. +  +

SYNOPSIS

+ +

+

+    error(msg:string)
+
+ +  +

ARGUMENTS

+ +

+ +msg +

+The formatted message string. +
+ +  +

DESCRIPTION

+ +

+ +An implicit end-of-line is added. staprun prepends the string +lqERROR:rq. Sending an error message aborts the currently running probe. Depending on the MAXERRORS parameter, it may trigger an +exit. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/euid.3stap.html b/man/euid.3stap.html new file mode 100644 index 00000000..b1438606 --- /dev/null +++ b/man/euid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of EUID + +

EUID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +euid - Return the effective uid of a target process. +  +

SYNOPSIS

+ +

+

+    euid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/execname.3stap.html b/man/execname.3stap.html new file mode 100644 index 00000000..3d48a2d2 --- /dev/null +++ b/man/execname.3stap.html @@ -0,0 +1,68 @@ + +Manpage of EXECNAME + +

EXECNAME

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +execname - Returns the execname of a target process (or group of processes). +  +

SYNOPSIS

+ +

+

+    execname:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/exit.3stap.html b/man/exit.3stap.html new file mode 100644 index 00000000..40612ec3 --- /dev/null +++ b/man/exit.3stap.html @@ -0,0 +1,77 @@ + +Manpage of EXIT + +

EXIT

+Section: Logging Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +exit - Start shutting down probing script. +  +

SYNOPSIS

+ +

+

+    exit()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +This only enqueues a request to start shutting down the script. New probes will not fire (except +lqendrq +probes), but all currently running ones may complete their work. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/ftrace.3stap.html b/man/ftrace.3stap.html new file mode 100644 index 00000000..a7213f8a --- /dev/null +++ b/man/ftrace.3stap.html @@ -0,0 +1,79 @@ + +Manpage of FTRACE + +

FTRACE

+Section: Logging Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ftrace - Send a message to the ftrace ring-buffer (or else printk). +  +

SYNOPSIS

+ +

+

+    ftrace(msg:string)
+
+ +  +

ARGUMENTS

+ +

+ +msg +

+The formatted message string. +
+ +  +

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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/get_cycles.3stap.html b/man/get_cycles.3stap.html new file mode 100644 index 00000000..a0e8d8ba --- /dev/null +++ b/man/get_cycles.3stap.html @@ -0,0 +1,77 @@ + +Manpage of GET_CYCLES + +

GET_CYCLES

+Section: Timestamp Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +get_cycles - Processor cycle count. +  +

SYNOPSIS

+ +

+

+    get_cycles:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return the processor cycle counter value, or 0 if unavailable. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/gid.3stap.html b/man/gid.3stap.html new file mode 100644 index 00000000..4522b967 --- /dev/null +++ b/man/gid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of GID + +

GID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +gid - Returns the group ID of a target process. +  +

SYNOPSIS

+ +

+

+    gid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/index.html b/man/index.html new file mode 100644 index 00000000..c904fe09 --- /dev/null +++ b/man/index.html @@ -0,0 +1,174 @@ +systemtap man page index diff --git a/man/ioscheduler.elv_add_request.3stap.html b/man/ioscheduler.elv_add_request.3stap.html new file mode 100644 index 00000000..bbc1012b --- /dev/null +++ b/man/ioscheduler.elv_add_request.3stap.html @@ -0,0 +1,100 @@ + +Manpage of IOSCHEDULER\&.ELV_AD + +

IOSCHEDULER\&.ELV_AD

+Section: IO Scheduler Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ioscheduler.elv_add_request - A request was added to the request queue +  +

SYNOPSIS

+ +

+

+ioscheduler.elv_add_request 
+
+ +  +

VALUES

+ +

+ +req_flags +

+Request flags +
+ +

+ +req +

+Address of the request +
+ +

+ +disk_major +

+Disk major number of the request +
+ +

+ +elevator_name +

+The type of I/O elevator currently enabled +
+ +

+ +disk_minor +

+Disk minor number of the request +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/ioscheduler.elv_completed_request.3stap.html b/man/ioscheduler.elv_completed_request.3stap.html new file mode 100644 index 00000000..f5252ff5 --- /dev/null +++ b/man/ioscheduler.elv_completed_request.3stap.html @@ -0,0 +1,100 @@ + +Manpage of IOSCHEDULER\&.ELV_CO + +

IOSCHEDULER\&.ELV_CO

+Section: IO Scheduler Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ioscheduler.elv_completed_request - Fires when a request is completed +  +

SYNOPSIS

+ +

+

+ioscheduler.elv_completed_request 
+
+ +  +

VALUES

+ +

+ +req_flags +

+Request flags +
+ +

+ +req +

+Address of the request +
+ +

+ +disk_major +

+Disk major number of the request +
+ +

+ +elevator_name +

+The type of I/O elevator currently enabled +
+ +

+ +disk_minor +

+Disk minor number of the request +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/ioscheduler.elv_next_request.3stap.html b/man/ioscheduler.elv_next_request.3stap.html new file mode 100644 index 00000000..f521fdc8 --- /dev/null +++ b/man/ioscheduler.elv_next_request.3stap.html @@ -0,0 +1,72 @@ + +Manpage of IOSCHEDULER\&.ELV_NE + +

IOSCHEDULER\&.ELV_NE

+Section: IO Scheduler Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ioscheduler.elv_next_request - Fires when a request is retrieved from the request queue +  +

SYNOPSIS

+ +

+

+ioscheduler.elv_next_request 
+
+ +  +

VALUES

+ +

+ +elevator_name +

+The type of I/O elevator currently enabled +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/ioscheduler.elv_next_request.return.3stap.html b/man/ioscheduler.elv_next_request.return.3stap.html new file mode 100644 index 00000000..e4a2c0c7 --- /dev/null +++ b/man/ioscheduler.elv_next_request.return.3stap.html @@ -0,0 +1,93 @@ + +Manpage of IOSCHEDULER\&.ELV_NE + +

IOSCHEDULER\&.ELV_NE

+Section: IO Scheduler Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ioscheduler.elv_next_request.return - Fires when a request retrieval issues a return signal +  +

SYNOPSIS

+ +

+

+ioscheduler.elv_next_request.return 
+
+ +  +

VALUES

+ +

+ +req_flags +

+Request flags +
+ +

+ +req +

+Address of the request +
+ +

+ +disk_major +

+Disk major number of the request +
+ +

+ +disk_minor +

+Disk minor number of the request +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/ip_ntop.3stap.html b/man/ip_ntop.3stap.html new file mode 100644 index 00000000..3c6e7333 --- /dev/null +++ b/man/ip_ntop.3stap.html @@ -0,0 +1,72 @@ + +Manpage of IP_NTOP + +

IP_NTOP

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ip_ntop - returns a string representation from an integer IP number +  +

SYNOPSIS

+ +

+

+    ip_ntop:string(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+the ip represented as an integer +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/is_myproc.3stap.html b/man/is_myproc.3stap.html new file mode 100644 index 00000000..5b328793 --- /dev/null +++ b/man/is_myproc.3stap.html @@ -0,0 +1,77 @@ + +Manpage of IS_MYPROC + +

IS_MYPROC

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +is_myproc - Determines if the current probe point has occurred in the user's own process. +  +

SYNOPSIS

+ +

+

+    is_myproc:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return 1 if the current probe point has occurred in the user's own process. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/is_return.3stap.html b/man/is_return.3stap.html new file mode 100644 index 00000000..8ec0520a --- /dev/null +++ b/man/is_return.3stap.html @@ -0,0 +1,77 @@ + +Manpage of IS_RETURN + +

IS_RETURN

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +is_return - Determines if probe point is a return probe. +  +

SYNOPSIS

+ +

+

+    is_return:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return 1 if the probe point is a return probe. <emphasis>Deprecated.</emphasis> +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/kprocess.create.3stap.html b/man/kprocess.create.3stap.html new file mode 100644 index 00000000..975c5567 --- /dev/null +++ b/man/kprocess.create.3stap.html @@ -0,0 +1,86 @@ + +Manpage of KPROCESS\&.CREATE + +

KPROCESS\&.CREATE

+Section: Kernel Process Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +kprocess.create - Fires whenever a new process is successfully created +  +

SYNOPSIS

+ +

+

+kprocess.create 
+
+ +  +

VALUES

+ +

+ +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 <command>fork</command> (or one of its syscall variants), or a new kernel thread. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/kprocess.exec.3stap.html b/man/kprocess.exec.3stap.html new file mode 100644 index 00000000..95d6cf7c --- /dev/null +++ b/man/kprocess.exec.3stap.html @@ -0,0 +1,86 @@ + +Manpage of KPROCESS\&.EXEC + +

KPROCESS\&.EXEC

+Section: Kernel Process Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +kprocess.exec - Attempt to exec to a new program +  +

SYNOPSIS

+ +

+

+kprocess.exec 
+
+ +  +

VALUES

+ +

+ +filename +

+The path to the new executable +
+ +  +

CONTEXT

+ +

+ +The caller of exec. +  +

DESCRIPTION

+ +

+ +Fires whenever a process attempts to exec to a new program. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/kprocess.exec_complete.3stap.html b/man/kprocess.exec_complete.3stap.html new file mode 100644 index 00000000..4aaec547 --- /dev/null +++ b/man/kprocess.exec_complete.3stap.html @@ -0,0 +1,93 @@ + +Manpage of KPROCESS\&.EXEC_COMP + +

KPROCESS\&.EXEC_COMP

+Section: Kernel Process Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +kprocess.exec_complete - Return from exec to a new program +  +

SYNOPSIS

+ +

+

+kprocess.exec_complete 
+
+ +  +

VALUES

+ +

+ +success +

+A boolean indicating whether the exec was successful +
+ +

+ +errno +

+The error number resulting from the exec +
+ +  +

CONTEXT

+ +

+ +On success, the context of the new executable. On failure, remains in the context of the caller. +  +

DESCRIPTION

+ +

+ +Fires at the completion of an exec call. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/kprocess.exit.3stap.html b/man/kprocess.exit.3stap.html new file mode 100644 index 00000000..f813a180 --- /dev/null +++ b/man/kprocess.exit.3stap.html @@ -0,0 +1,86 @@ + +Manpage of KPROCESS\&.EXIT + +

KPROCESS\&.EXIT

+Section: Kernel Process Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +kprocess.exit - Exit from process +  +

SYNOPSIS

+ +

+

+kprocess.exit 
+
+ +  +

VALUES

+ +

+ +code +

+The exit code of the process +
+ +  +

CONTEXT

+ +

+ +The process which is terminating. +  +

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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/kprocess.release.3stap.html b/man/kprocess.release.3stap.html new file mode 100644 index 00000000..1ed1f2b2 --- /dev/null +++ b/man/kprocess.release.3stap.html @@ -0,0 +1,93 @@ + +Manpage of KPROCESS\&.RELEASE + +

KPROCESS\&.RELEASE

+Section: Kernel Process Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +kprocess.release - Process released +  +

SYNOPSIS

+ +

+

+kprocess.release 
+
+ +  +

VALUES

+ +

+ +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 kprocess.exit, though it may be delayed somewhat if the process waits in a zombie state. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/kprocess.start.3stap.html b/man/kprocess.start.3stap.html new file mode 100644 index 00000000..18e2f9e4 --- /dev/null +++ b/man/kprocess.start.3stap.html @@ -0,0 +1,82 @@ + +Manpage of KPROCESS\&.START + +

KPROCESS\&.START

+Section: Kernel Process Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +kprocess.start - Starting new process +  +

SYNOPSIS

+ +

+

+kprocess.start 
+
+ +  +

VALUES

+ +

+ +None +  +

CONTEXT

+ +

+ +Newly created process. +  +

DESCRIPTION

+ +

+ +Fires immediately before a new process begins execution. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/log.3stap.html b/man/log.3stap.html new file mode 100644 index 00000000..0a1e41bc --- /dev/null +++ b/man/log.3stap.html @@ -0,0 +1,81 @@ + +Manpage of LOG + +

LOG

+Section: Logging Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +log - Send a line to the common trace buffer. +  +

SYNOPSIS

+ +

+

+    log(msg:string)
+
+ +  +

ARGUMENTS

+ +

+ +msg +

+The formatted message string. +
+ +  +

DESCRIPTION

+ +

+ +An implicit end-of-line is added. Same as +println +with a single string argument. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/modname.3stap.html b/man/modname.3stap.html new file mode 100644 index 00000000..7d4c80cd --- /dev/null +++ b/man/modname.3stap.html @@ -0,0 +1,82 @@ + +Manpage of MODNAME + +

MODNAME

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +modname - Return the kernel module name loaded at the address. +  +

SYNOPSIS

+ +

+

+    modname:string(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+The address. +
+ +  +

DESCRIPTION

+ +

+ +Returns the module name associated with the given address if known. If not known it will return the string +lq<unknown>rq. If the address was not in a kernel module, but in the kernel itself, then the string +lqkernelrq +will be returned. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.change_mac.3stap.html b/man/netdev.change_mac.3stap.html new file mode 100644 index 00000000..5e699169 --- /dev/null +++ b/man/netdev.change_mac.3stap.html @@ -0,0 +1,93 @@ + +Manpage of NETDEV\&.CHANGE_MAC + +

NETDEV\&.CHANGE_MAC

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.change_mac - Called when the netdev_name has the MAC changed +  +

SYNOPSIS

+ +

+

+netdev.change_mac 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that will have the MTU changed +
+ +

+ +new_mac +

+The new MAC address +
+ +

+ +mac_len +

+The MAC length +
+ +

+ +old_mac +

+The current MAC address +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.change_mtu.3stap.html b/man/netdev.change_mtu.3stap.html new file mode 100644 index 00000000..e189986f --- /dev/null +++ b/man/netdev.change_mtu.3stap.html @@ -0,0 +1,86 @@ + +Manpage of NETDEV\&.CHANGE_MTU + +

NETDEV\&.CHANGE_MTU

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.change_mtu - Called when the netdev MTU is changed +  +

SYNOPSIS

+ +

+

+netdev.change_mtu 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that will have the MTU changed +
+ +

+ +new_mtu +

+The new MTU +
+ +

+ +old_mtu +

+The current MTU +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.change_rx_flag.3stap.html b/man/netdev.change_rx_flag.3stap.html new file mode 100644 index 00000000..ef4be66a --- /dev/null +++ b/man/netdev.change_rx_flag.3stap.html @@ -0,0 +1,79 @@ + +Manpage of NETDEV\&.CHANGE_RX_F + +

NETDEV\&.CHANGE_RX_F

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.change_rx_flag - Called when the device RX flag will be changed +  +

SYNOPSIS

+ +

+

+netdev.change_rx_flag 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that will be changed +
+ +

+ +flags +

+The new flags +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.close.3stap.html b/man/netdev.close.3stap.html new file mode 100644 index 00000000..110963e8 --- /dev/null +++ b/man/netdev.close.3stap.html @@ -0,0 +1,72 @@ + +Manpage of NETDEV\&.CLOSE + +

NETDEV\&.CLOSE

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.close - Called when the device is closed +  +

SYNOPSIS

+ +

+

+netdev.close 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that is going to be closed +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.get_stats.3stap.html b/man/netdev.get_stats.3stap.html new file mode 100644 index 00000000..509302a8 --- /dev/null +++ b/man/netdev.get_stats.3stap.html @@ -0,0 +1,72 @@ + +Manpage of NETDEV\&.GET_STATS + +

NETDEV\&.GET_STATS

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.get_stats - Called when someone asks the device statistics +  +

SYNOPSIS

+ +

+

+netdev.get_stats 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that is going to provide the statistics +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.hard_transmit.3stap.html b/man/netdev.hard_transmit.3stap.html new file mode 100644 index 00000000..48098492 --- /dev/null +++ b/man/netdev.hard_transmit.3stap.html @@ -0,0 +1,93 @@ + +Manpage of NETDEV\&.HARD_TRANSM + +

NETDEV\&.HARD_TRANSM

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.hard_transmit - Called when the devices is going to TX (hard) +  +

SYNOPSIS

+ +

+

+netdev.hard_transmit 
+
+ +  +

VALUES

+ +

+ +protocol +

+The protocol used in the transmission +
+ +

+ +dev_name +

+The device scheduled to transmit +
+ +

+ +length +

+The length of the transmit buffer. +
+ +

+ +truesize +

+The size of the data to be transmitted. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.ioctl.3stap.html b/man/netdev.ioctl.3stap.html new file mode 100644 index 00000000..e7bc5a2d --- /dev/null +++ b/man/netdev.ioctl.3stap.html @@ -0,0 +1,79 @@ + +Manpage of NETDEV\&.IOCTL + +

NETDEV\&.IOCTL

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.ioctl - Called when the device suffers an IOCTL +  +

SYNOPSIS

+ +

+

+netdev.ioctl 
+
+ +  +

VALUES

+ +

+ +cmd +

+The IOCTL request +
+ +

+ +arg +

+The IOCTL argument (usually the netdev interface) +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.open.3stap.html b/man/netdev.open.3stap.html new file mode 100644 index 00000000..534fbfc9 --- /dev/null +++ b/man/netdev.open.3stap.html @@ -0,0 +1,72 @@ + +Manpage of NETDEV\&.OPEN + +

NETDEV\&.OPEN

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.open - Called when the device is opened +  +

SYNOPSIS

+ +

+

+netdev.open 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that is going to be opened +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.receive.3stap.html b/man/netdev.receive.3stap.html new file mode 100644 index 00000000..493d0b52 --- /dev/null +++ b/man/netdev.receive.3stap.html @@ -0,0 +1,86 @@ + +Manpage of NETDEV\&.RECEIVE + +

NETDEV\&.RECEIVE

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.receive - Data received from network device. +  +

SYNOPSIS

+ +

+

+netdev.receive 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol of received packet. +
+ +

+ +dev_name +

+The name of the device. e.g: eth0, ath1. +
+ +

+ +length +

+The length of the receiving buffer. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.register.3stap.html b/man/netdev.register.3stap.html new file mode 100644 index 00000000..9afe100d --- /dev/null +++ b/man/netdev.register.3stap.html @@ -0,0 +1,72 @@ + +Manpage of NETDEV\&.REGISTER + +

NETDEV\&.REGISTER

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.register - Called when the device is registered +  +

SYNOPSIS

+ +

+

+netdev.register 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that is going to be registered +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.rx.3stap.html b/man/netdev.rx.3stap.html new file mode 100644 index 00000000..22397cad --- /dev/null +++ b/man/netdev.rx.3stap.html @@ -0,0 +1,79 @@ + +Manpage of NETDEV\&.RX + +

NETDEV\&.RX

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.rx - Called when the device is going to receive a packet +  +

SYNOPSIS

+ +

+

+netdev.rx 
+
+ +  +

VALUES

+ +

+ +protocol +

+The packet protocol +
+ +

+ +dev_name +

+The device received the packet +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.set_promiscuity.3stap.html b/man/netdev.set_promiscuity.3stap.html new file mode 100644 index 00000000..53b657f5 --- /dev/null +++ b/man/netdev.set_promiscuity.3stap.html @@ -0,0 +1,93 @@ + +Manpage of NETDEV\&.SET_PROMISC + +

NETDEV\&.SET_PROMISC

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.set_promiscuity - Called when the device enters/leaves promiscuity +  +

SYNOPSIS

+ +

+

+netdev.set_promiscuity 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that is entering/leaving promiscuity mode +
+ +

+ +enable +

+If the device is entering promiscuity mode +
+ +

+ +inc +

+Count the number of promiscuity openers +
+ +

+ +disable +

+If the device is leaving promiscuity mode +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.transmit.3stap.html b/man/netdev.transmit.3stap.html new file mode 100644 index 00000000..7e6c72df --- /dev/null +++ b/man/netdev.transmit.3stap.html @@ -0,0 +1,93 @@ + +Manpage of NETDEV\&.TRANSMIT + +

NETDEV\&.TRANSMIT

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.transmit - Network device transmitting buffer +  +

SYNOPSIS

+ +

+

+netdev.transmit 
+
+ +  +

VALUES

+ +

+ +protocol +

+The protocol of this packet. +
+ +

+ +dev_name +

+The name of the device. e.g: eth0, ath1. +
+ +

+ +length +

+The length of the transmit buffer. +
+ +

+ +truesize +

+The size of the data to be transmitted. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/netdev.unregister.3stap.html b/man/netdev.unregister.3stap.html new file mode 100644 index 00000000..94831fa1 --- /dev/null +++ b/man/netdev.unregister.3stap.html @@ -0,0 +1,72 @@ + +Manpage of NETDEV\&.UNREGISTER + +

NETDEV\&.UNREGISTER

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +netdev.unregister - Called when the device is being unregistered +  +

SYNOPSIS

+ +

+

+netdev.unregister 
+
+ +  +

VALUES

+ +

+ +dev_name +

+The device that is going to be unregistered +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/pexecname.3stap.html b/man/pexecname.3stap.html new file mode 100644 index 00000000..49fce95b --- /dev/null +++ b/man/pexecname.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PEXECNAME + +

PEXECNAME

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +pexecname - Returns the execname of a target process's parent process. +  +

SYNOPSIS

+ +

+

+    pexecname:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/pgrp.3stap.html b/man/pgrp.3stap.html new file mode 100644 index 00000000..6189d532 --- /dev/null +++ b/man/pgrp.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PGRP + +

PGRP

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +pgrp - Returns the process group ID of the current process. +  +

SYNOPSIS

+ +

+

+    pgrp:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/pid.3stap.html b/man/pid.3stap.html new file mode 100644 index 00000000..590ccef5 --- /dev/null +++ b/man/pid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PID + +

PID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +pid - Returns the ID of a target process. +  +

SYNOPSIS

+ +

+

+    pid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/pp.3stap.html b/man/pp.3stap.html new file mode 100644 index 00000000..778e85f4 --- /dev/null +++ b/man/pp.3stap.html @@ -0,0 +1,82 @@ + +Manpage of PP + +

PP

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +pp - Return the probe point associated with the currently running probe handler, +  +

SYNOPSIS

+ +

+

+    pp:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +including alias and wildcard expansion effects +  +

CONTEXT

+ +

+ +The current probe point. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/ppid.3stap.html b/man/ppid.3stap.html new file mode 100644 index 00000000..98ac792e --- /dev/null +++ b/man/ppid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PPID + +

PPID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ppid - Returns the process ID of a target process's parent process. +  +

SYNOPSIS

+ +

+

+    ppid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/print_backtrace.3stap.html b/man/print_backtrace.3stap.html new file mode 100644 index 00000000..a7ff6830 --- /dev/null +++ b/man/print_backtrace.3stap.html @@ -0,0 +1,77 @@ + +Manpage of PRINT_BACKTRACE + +

PRINT_BACKTRACE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +print_backtrace - Print stack back trace +  +

SYNOPSIS

+ +

+

+    print_backtrace()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Equivalent to <command>print_stack(backtrace)</command>, except that deeper stack nesting may be supported. Return nothing. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/print_regs.3stap.html b/man/print_regs.3stap.html new file mode 100644 index 00000000..92bc81a9 --- /dev/null +++ b/man/print_regs.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PRINT_REGS + +

PRINT_REGS

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +print_regs - Print a register dump. +  +

SYNOPSIS

+ +

+

+    print_regs()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/print_stack.3stap.html b/man/print_stack.3stap.html new file mode 100644 index 00000000..d7487e58 --- /dev/null +++ b/man/print_stack.3stap.html @@ -0,0 +1,82 @@ + +Manpage of PRINT_STACK + +

PRINT_STACK

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +print_stack - Print out stack from string. +  +

SYNOPSIS

+ +

+

+    print_stack(stk:string)
+
+ +  +

ARGUMENTS

+ +

+ +stk +

+String with list of hexadecimal addresses. +
+ +  +

DESCRIPTION

+ +

+ +Perform a symbolic lookup of the addresses in the given string, which is assumed to be the result of a prior call to <command>backtrace</command>. +

+ +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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/print_ubacktrace.3stap.html b/man/print_ubacktrace.3stap.html new file mode 100644 index 00000000..e1f189b2 --- /dev/null +++ b/man/print_ubacktrace.3stap.html @@ -0,0 +1,77 @@ + +Manpage of PRINT_UBACKTRACE + +

PRINT_UBACKTRACE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +print_ubacktrace - Print stack back trace for current task. EXPERIMENTAL! +  +

SYNOPSIS

+ +

+

+    print_ubacktrace()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Equivalent to <command>print_ustack(ubacktrace)</command>, except that deeper stack nesting may be supported. Return nothing. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/print_ustack.3stap.html b/man/print_ustack.3stap.html new file mode 100644 index 00000000..329d9fa9 --- /dev/null +++ b/man/print_ustack.3stap.html @@ -0,0 +1,82 @@ + +Manpage of PRINT_USTACK + +

PRINT_USTACK

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +print_ustack - Print out stack for the current task from string. EXPERIMENTAL! +  +

SYNOPSIS

+ +

+

+    print_ustack(stk:string)
+
+ +  +

ARGUMENTS

+ +

+ +stk +

+String with list of hexadecimal addresses for the current task. +
+ +  +

DESCRIPTION

+ +

+ +Perform a symbolic lookup of the addresses in the given string, which is assumed to be the result of a prior call to <command>ubacktrace</command> 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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/probefunc.3stap.html b/man/probefunc.3stap.html new file mode 100644 index 00000000..b705da36 --- /dev/null +++ b/man/probefunc.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PROBEFUNC + +

PROBEFUNC

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +probefunc - Return the probe point's function name, if known. +  +

SYNOPSIS

+ +

+

+    probefunc:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/probemod.3stap.html b/man/probemod.3stap.html new file mode 100644 index 00000000..9bd2ca0c --- /dev/null +++ b/man/probemod.3stap.html @@ -0,0 +1,68 @@ + +Manpage of PROBEMOD + +

PROBEMOD

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +probemod - Return the probe point's module name, if known. +  +

SYNOPSIS

+ +

+

+    probemod:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/randint.3stap.html b/man/randint.3stap.html new file mode 100644 index 00000000..d3141dd1 --- /dev/null +++ b/man/randint.3stap.html @@ -0,0 +1,72 @@ + +Manpage of RANDINT + +

RANDINT

+Section: Random functions Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +randint - Return a random number between [0,n) +  +

SYNOPSIS

+ +

+

+    randint:long(n:long)
+
+ +  +

ARGUMENTS

+ +

+ +n +

+Number past upper limit of range, not larger than 2**20. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/registers_valid.3stap.html b/man/registers_valid.3stap.html new file mode 100644 index 00000000..f705bb1f --- /dev/null +++ b/man/registers_valid.3stap.html @@ -0,0 +1,81 @@ + +Manpage of REGISTERS_VALID + +

REGISTERS_VALID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +registers_valid - Determines validity of <command>register</command> and <command>u_register</command> in current context. +  +

SYNOPSIS

+ +

+

+    registers_valid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return 1 if +register +and +u_register +can be used in the current context, or 0 otherwise. For example, <command>registers_valid</command> returns 0 when called from a begin or end probe. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/reverse_path_walk.3stap.html b/man/reverse_path_walk.3stap.html new file mode 100644 index 00000000..d2165d7c --- /dev/null +++ b/man/reverse_path_walk.3stap.html @@ -0,0 +1,81 @@ + +Manpage of REVERSE_PATH_WALK + +

REVERSE_PATH_WALK

+Section: Directory-entry (dentry) Tapse (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +reverse_path_walk - get the full dirent path +  +

SYNOPSIS

+ +

+

+    reverse_path_walk:string(dentry:long)
+
+ +  +

ARGUMENTS

+ +

+ +dentry +

+Pointer to dentry. +
+ +  +

DESCRIPTION

+ +

+ +

+ +Returns the path name (partial path to mount point). +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/scsi.iocompleted.3stap.html b/man/scsi.iocompleted.3stap.html new file mode 100644 index 00000000..24b473fa --- /dev/null +++ b/man/scsi.iocompleted.3stap.html @@ -0,0 +1,114 @@ + +Manpage of SCSI\&.IOCOMPLETED + +

SCSI\&.IOCOMPLETED

+Section: SCSI Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +scsi.iocompleted - SCSI mid-layer running the completion processing for block device I/O requests +  +

SYNOPSIS

+ +

+

+scsi.iocompleted 
+
+ +  +

VALUES

+ +

+ +lun +

+The lun number +
+ +

+ +host_no +

+The host number +
+ +

+ +device_state +

+The current state of the device +
+ +

+ +dev_id +

+The scsi device id +
+ +

+ +channel +

+The channel number +
+ +

+ +data_direction +

+The data_direction specifies whether this command is from/to the device +
+ +

+ +goodbytes +

+The bytes completed. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/scsi.iodispatching.3stap.html b/man/scsi.iodispatching.3stap.html new file mode 100644 index 00000000..32d5996c --- /dev/null +++ b/man/scsi.iodispatching.3stap.html @@ -0,0 +1,121 @@ + +Manpage of SCSI\&.IODISPATCHING + +

SCSI\&.IODISPATCHING

+Section: SCSI Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +scsi.iodispatching - SCSI mid-layer dispatched low-level SCSI command +  +

SYNOPSIS

+ +

+

+scsi.iodispatching 
+
+ +  +

VALUES

+ +

+ +lun +

+The lun number +
+ +

+ +req_bufflen +

+The request buffer length +
+ +

+ +host_no +

+The host number +
+ +

+ +device_state +

+The current state of the device. +
+ +

+ +dev_id +

+The scsi device id +
+ +

+ +channel +

+The channel number +
+ +

+ +data_direction +

+The data_direction specifies whether this command is from/to the device. 0 (DMA_BIDIRECTIONAL), 1 (DMA_TO_DEVICE), 2 (DMA_FROM_DEVICE), 3 (DMA_NONE) +
+ +

+ +request_buffer +

+The request buffer address +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/scsi.iodone.3stap.html b/man/scsi.iodone.3stap.html new file mode 100644 index 00000000..b929931a --- /dev/null +++ b/man/scsi.iodone.3stap.html @@ -0,0 +1,107 @@ + +Manpage of SCSI\&.IODONE + +

SCSI\&.IODONE

+Section: SCSI Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +scsi.iodone - SCSI command completed by low level driver and enqueued into the done queue. +  +

SYNOPSIS

+ +

+

+scsi.iodone 
+
+ +  +

VALUES

+ +

+ +lun +

+The lun number +
+ +

+ +host_no +

+The host number +
+ +

+ +device_state +

+The current state of the device +
+ +

+ +dev_id +

+The scsi device id +
+ +

+ +channel +

+The channel number +
+ +

+ +data_direction +

+The data_direction specifies whether this command is from/to the device. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/scsi.ioentry.3stap.html b/man/scsi.ioentry.3stap.html new file mode 100644 index 00000000..2879472e --- /dev/null +++ b/man/scsi.ioentry.3stap.html @@ -0,0 +1,86 @@ + +Manpage of SCSI\&.IOENTRY + +

SCSI\&.IOENTRY

+Section: SCSI Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +scsi.ioentry - Prepares a SCSI mid-layer request +  +

SYNOPSIS

+ +

+

+scsi.ioentry 
+
+ +  +

VALUES

+ +

+ +disk_major +

+The major number of the disk (-1 if no information) +
+ +

+ +device_state +

+The current state of the device. +
+ +

+ +disk_minor +

+The minor number of the disk (-1 if no information) +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/sid.3stap.html b/man/sid.3stap.html new file mode 100644 index 00000000..bad29911 --- /dev/null +++ b/man/sid.3stap.html @@ -0,0 +1,77 @@ + +Manpage of SID + +

SID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sid - Returns the session ID of the current process. +  +

SYNOPSIS

+ +

+

+    sid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.check_ignored.3stap.html b/man/signal.check_ignored.3stap.html new file mode 100644 index 00000000..51320b91 --- /dev/null +++ b/man/signal.check_ignored.3stap.html @@ -0,0 +1,93 @@ + +Manpage of SIGNAL\&.CHECK_IGNOR + +

SIGNAL\&.CHECK_IGNOR

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.check_ignored - Checking to see signal is ignored +  +

SYNOPSIS

+ +

+

+signal.check_ignored 
+
+ +  +

VALUES

+ +

+ +sig_name +

+A string representation of the signal +
+ +

+ +sig +

+The number of the signal +
+ +

+ +pid_name +

+Name of the process receiving the signal +
+ +

+ +sig_pid +

+The PID of the process receiving the signal +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.check_ignored.return.3stap.html b/man/signal.check_ignored.return.3stap.html new file mode 100644 index 00000000..b04e79a0 --- /dev/null +++ b/man/signal.check_ignored.return.3stap.html @@ -0,0 +1,79 @@ + +Manpage of SIGNAL\&.CHECK_IGNOR + +

SIGNAL\&.CHECK_IGNOR

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.check_ignored.return - Check to see signal is ignored completed +  +

SYNOPSIS

+ +

+

+signal.check_ignored.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+Return value as a string +
+ +

+ +name +

+Name of the probe point; default value is <command>signal.checkperm</command> +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.checkperm.3stap.html b/man/signal.checkperm.3stap.html new file mode 100644 index 00000000..f4c1a8a5 --- /dev/null +++ b/man/signal.checkperm.3stap.html @@ -0,0 +1,121 @@ + +Manpage of SIGNAL\&.CHECKPERM + +

SIGNAL\&.CHECKPERM

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.checkperm - Check being performed on a sent signal +  +

SYNOPSIS

+ +

+

+signal.checkperm 
+
+ +  +

VALUES

+ +

+ +name +

+Name of the probe point; default value is <command>signal.checkperm</command> +
+ +

+ +task +

+A task handle to the signal recipient +
+ +

+ +sinfo +

+The address of the <command>siginfo</command> structure +
+ +

+ +si_code +

+Indicates the signal type +
+ +

+ +sig_name +

+A string representation of the signal +
+ +

+ +sig +

+The number of the signal +
+ +

+ +pid_name +

+Name of the process receiving the signal +
+ +

+ +sig_pid +

+The PID of the process receiving the signal +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.checkperm.return.3stap.html b/man/signal.checkperm.return.3stap.html new file mode 100644 index 00000000..1c658231 --- /dev/null +++ b/man/signal.checkperm.return.3stap.html @@ -0,0 +1,79 @@ + +Manpage of SIGNAL\&.CHECKPERM\& + +

SIGNAL\&.CHECKPERM\&

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.checkperm.return - Check performed on a sent signal completed +  +

SYNOPSIS

+ +

+

+signal.checkperm.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+Return value as a string +
+ +

+ +name +

+Name of the probe point; default value is <command>signal.checkperm</command> +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.do_action.3stap.html b/man/signal.do_action.3stap.html new file mode 100644 index 00000000..9183ed4c --- /dev/null +++ b/man/signal.do_action.3stap.html @@ -0,0 +1,100 @@ + +Manpage of SIGNAL\&.DO_ACTION + +

SIGNAL\&.DO_ACTION

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.do_action - Examining or changing a signal action +  +

SYNOPSIS

+ +

+

+signal.do_action 
+
+ +  +

VALUES

+ +

+ +sa_mask +

+The new mask of the signal +
+ +

+ +oldsigact_addr +

+The address of the old <command>sigaction</command> struct associated with the signal +
+ +

+ +sig +

+The signal to be examined/changed +
+ +

+ +sa_handler +

+The new handler of the signal +
+ +

+ +sigact_addr +

+The address of the new <command>sigaction</command> struct associated with the signal +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.do_action.return.3stap.html b/man/signal.do_action.return.3stap.html new file mode 100644 index 00000000..4989e531 --- /dev/null +++ b/man/signal.do_action.return.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SIGNAL\&.DO_ACTION\& + +

SIGNAL\&.DO_ACTION\&

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.do_action.return - Examining or changing a signal action completed +  +

SYNOPSIS

+ +

+

+signal.do_action.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+Return value as a string +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.flush.3stap.html b/man/signal.flush.3stap.html new file mode 100644 index 00000000..c11e4a04 --- /dev/null +++ b/man/signal.flush.3stap.html @@ -0,0 +1,86 @@ + +Manpage of SIGNAL\&.FLUSH + +

SIGNAL\&.FLUSH

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.flush - Flushing all pending signals for a task +  +

SYNOPSIS

+ +

+

+signal.flush 
+
+ +  +

VALUES

+ +

+ +task +

+The task handler of the process performing the flush +
+ +

+ +pid_name +

+The name of the process associated with the task performing the flush +
+ +

+ +sig_pid +

+The PID of the process associated with the task performing the flush +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.force_segv.3stap.html b/man/signal.force_segv.3stap.html new file mode 100644 index 00000000..010b2d73 --- /dev/null +++ b/man/signal.force_segv.3stap.html @@ -0,0 +1,93 @@ + +Manpage of SIGNAL\&.FORCE_SEGV + +

SIGNAL\&.FORCE_SEGV

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.force_segv - Forcing send of <command>SIGSEGV</command> +  +

SYNOPSIS

+ +

+

+signal.force_segv 
+
+ +  +

VALUES

+ +

+ +sig_name +

+A string representation of the signal +
+ +

+ +sig +

+The number of the signal +
+ +

+ +pid_name +

+Name of the process receiving the signal +
+ +

+ +sig_pid +

+The PID of the process receiving the signal +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:12 GMT, September 28, 2009 + + diff --git a/man/signal.force_segv.return.3stap.html b/man/signal.force_segv.return.3stap.html new file mode 100644 index 00000000..3d6e0786 --- /dev/null +++ b/man/signal.force_segv.return.3stap.html @@ -0,0 +1,5 @@ + +Invalid Manpage + +

Invalid Manpage

+The requested file (stdin) is not a valid (unformatted) man page. diff --git a/man/signal.handle.3stap.html b/man/signal.handle.3stap.html new file mode 100644 index 00000000..c52a0885 --- /dev/null +++ b/man/signal.handle.3stap.html @@ -0,0 +1,114 @@ + +Manpage of SIGNAL\&.HANDLE + +

SIGNAL\&.HANDLE

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.handle - Signal handler being invoked +  +

SYNOPSIS

+ +

+

+signal.handle 
+
+ +  +

VALUES

+ +

+ +regs +

+The address of the kernel-mode stack area +
+ +

+ +sig_code +

+The <command>si_code</command> value of the <command>siginfo</command> signal +
+ +

+ +sig_mode +

+Indicates whether the signal was a user-mode or kernel-mode signal +
+ +

+ +sinfo +

+The address of the <command>siginfo</command> table +
+ +

+ +oldset_addr +

+The address of the bitmask array of blocked signals +
+ +

+ +sig +

+The signal number that invoked the signal handler +
+ +

+ +ka_addr +

+The address of the <command>k_sigaction</command> table associated with the signal +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.handle.return.3stap.html b/man/signal.handle.return.3stap.html new file mode 100644 index 00000000..c393f35f --- /dev/null +++ b/man/signal.handle.return.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SIGNAL\&.HANDLE\&.RE + +

SIGNAL\&.HANDLE\&.RE

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.handle.return - Signal handler invocation completed +  +

SYNOPSIS

+ +

+

+signal.handle.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+Return value as a string +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.pending.3stap.html b/man/signal.pending.3stap.html new file mode 100644 index 00000000..6c0a282d --- /dev/null +++ b/man/signal.pending.3stap.html @@ -0,0 +1,86 @@ + +Manpage of SIGNAL\&.PENDING + +

SIGNAL\&.PENDING

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.pending - Examining pending signal +  +

SYNOPSIS

+ +

+

+signal.pending 
+
+ +  +

VALUES

+ +

+ +sigset_size +

+The size of the user-space signal set +
+ +

+ +sigset_add +

+The address of the user-space signal set (<command>sigset_t</command>) +
+ +  +

DESCRIPTION

+ +

+ +This probe is used to examine a set of signals pending for delivery to a specific thread. This normally occurs when the <command>do_sigpending</command> kernel function is executed. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.pending.return.3stap.html b/man/signal.pending.return.3stap.html new file mode 100644 index 00000000..d9d2f4c4 --- /dev/null +++ b/man/signal.pending.return.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SIGNAL\&.PENDING\&.R + +

SIGNAL\&.PENDING\&.R

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.pending.return - Examination of pending signal completed +  +

SYNOPSIS

+ +

+

+signal.pending.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+Return value as a string +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.procmask.3stap.html b/man/signal.procmask.3stap.html new file mode 100644 index 00000000..c6e2c995 --- /dev/null +++ b/man/signal.procmask.3stap.html @@ -0,0 +1,93 @@ + +Manpage of SIGNAL\&.PROCMASK + +

SIGNAL\&.PROCMASK

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.procmask - Examining or changing blocked signals +  +

SYNOPSIS

+ +

+

+signal.procmask 
+
+ +  +

VALUES

+ +

+ +how +

+Indicates how to change the blocked signals; possible values are <command>SIG_BLOCK=0</command> (for blocking signals), <command>SIG_UNBLOCK=1</command> (for unblocking signals), and <command>SIG_SETMASK=2</command> for setting the signal mask. +
+ +

+ +oldsigset_addr +

+The old address of the signal set (<command>sigset_t</command>) +
+ +

+ +sigset +

+The actual value to be set for <command>sigset_t</command> <remark>(correct?)</remark> +
+ +

+ +sigset_addr +

+The address of the signal set (<command>sigset_t</command>) to be implemented +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.send.3stap.html b/man/signal.send.3stap.html new file mode 100644 index 00000000..beb8330f --- /dev/null +++ b/man/signal.send.3stap.html @@ -0,0 +1,142 @@ + +Manpage of SIGNAL\&.SEND + +

SIGNAL\&.SEND

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.send - Signal being sent to a process +  +

SYNOPSIS

+ +

+

+signal.send 
+
+ +  +

VALUES

+ +

+ +send2queue +

+Indicates whether the signal is sent to an existing <command>sigqueue</command> +
+ +

+ +name +

+The name of the function used to send out the signal +
+ +

+ +task +

+A task handle to the signal recipient +
+ +

+ +sinfo +

+The address of <command>siginfo</command> struct +
+ +

+ +si_code +

+Indicates the signal type +
+ +

+ +sig_name +

+A string representation of the signal +
+ +

+ +sig +

+The number of the signal +
+ +

+ +shared +

+Indicates whether the signal is shared by the thread group +
+ +

+ +sig_pid +

+The PID of the process receiving the signal +
+ +

+ +pid_name +

+The name of the signal recipient +
+ +  +

CONTEXT

+ +

+ +The signal's sender. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.send.return.3stap.html b/man/signal.send.return.3stap.html new file mode 100644 index 00000000..09ee48f5 --- /dev/null +++ b/man/signal.send.return.3stap.html @@ -0,0 +1,125 @@ + +Manpage of SIGNAL\&.SEND\&.RETU + +

SIGNAL\&.SEND\&.RETU

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.send.return - Signal being sent to a process completed +  +

SYNOPSIS

+ +

+

+signal.send.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+The return value to either <command>__group_send_sig_info</command>, <command>specific_send_sig_info</command>, or <command>send_sigqueue</command> +
+ +

+ +send2queue +

+Indicates whether the sent signal was sent to an existing <command>sigqueue</command> +
+ +

+ +name +

+The name of the function used to send out the signal +
+ +

+ +shared +

+Indicates whether the sent signal is shared by the thread group. +
+ +  +

CONTEXT

+ +

+ +The signal's sender. <remark>(correct?)</remark> +  +

DESCRIPTION

+ +

+ +Possible <command>__group_send_sig_info</command> and <command>specific_send_sig_info</command> return values are as follows; +

+ +<command>0</command> -- The signal is sucessfully 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 <3> the signal was successfully added to the <command>sigqueue</command> of the receiving process. +

+ +<command>-EAGAIN</command> -- The <command>sigqueue</command> of the receiving process is overflowing, the signal was RT, and the signal was sent by a user using something other than <command>kill</command>. +

+ +Possible <command>send_group_sigqueue</command> and <command>send_sigqueue</command> return values are as follows; +

+ +<command>0</command> -- The signal was either sucessfully added into the <command>sigqueue</command> of the receiving process, or a <command>SI_TIMER</command> entry is already queued (in which case, the overrun count will be simply incremented). +

+ +<command>1</command> -- The signal was ignored by the receiving process. +

+ +<command>-1</command> -- (<command>send_sigqueue</command> only) The task was marked <command>exiting</command>, allowing * <command>posix_timer_event</command> to redirect it to the group leader. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.send_sig_queue.3stap.html b/man/signal.send_sig_queue.3stap.html new file mode 100644 index 00000000..18366032 --- /dev/null +++ b/man/signal.send_sig_queue.3stap.html @@ -0,0 +1,100 @@ + +Manpage of SIGNAL\&.SEND_SIG_QU + +

SIGNAL\&.SEND_SIG_QU

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.send_sig_queue - Queuing a signal to a process +  +

SYNOPSIS

+ +

+

+signal.send_sig_queue 
+
+ +  +

VALUES

+ +

+ +sigqueue_addr +

+The address of the signal queue +
+ +

+ +sig_name +

+A string representation of the signal +
+ +

+ +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 +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.send_sig_queue.return.3stap.html b/man/signal.send_sig_queue.return.3stap.html new file mode 100644 index 00000000..e0e8e850 --- /dev/null +++ b/man/signal.send_sig_queue.return.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SIGNAL\&.SEND_SIG_QU + +

SIGNAL\&.SEND_SIG_QU

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.send_sig_queue.return - Queuing a signal to a process completed +  +

SYNOPSIS

+ +

+

+signal.send_sig_queue.return 
+
+ +  +

VALUES

+ +

+ +retstr +

+Return value as a string +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.sys_tgkill.3stap.html b/man/signal.sys_tgkill.3stap.html new file mode 100644 index 00000000..80fb6ade --- /dev/null +++ b/man/signal.sys_tgkill.3stap.html @@ -0,0 +1,100 @@ + +Manpage of SIGNAL\&.SYS_TGKILL + +

SIGNAL\&.SYS_TGKILL

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.sys_tgkill - Sending kill signal to a thread group +  +

SYNOPSIS

+ +

+

+signal.sys_tgkill 
+
+ +  +

VALUES

+ +

+ +sig_name +

+A string representation of the signal +
+ +

+ +sig +

+The specific kill signal sent to the process +
+ +

+ +pid +

+The PID of the thread receiving the kill signal +
+ +

+ +tgid +

+The thread group ID of the thread receiving the kill signal +
+ +  +

DESCRIPTION

+ +

+ +The <command>tgkill</command> call is similar to <command>tkill</command>, except that it also allows the caller to specify the thread group ID of the thread to be signalled. This protects against TID reuse. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.sys_tgkill.return.3stap.html b/man/signal.sys_tgkill.return.3stap.html new file mode 100644 index 00000000..3d6e0786 --- /dev/null +++ b/man/signal.sys_tgkill.return.3stap.html @@ -0,0 +1,5 @@ + +Invalid Manpage + +

Invalid Manpage

+The requested file (stdin) is not a valid (unformatted) man page. diff --git a/man/signal.sys_tkill.3stap.html b/man/signal.sys_tkill.3stap.html new file mode 100644 index 00000000..d3dde637 --- /dev/null +++ b/man/signal.sys_tkill.3stap.html @@ -0,0 +1,93 @@ + +Manpage of SIGNAL\&.SYS_TKILL + +

SIGNAL\&.SYS_TKILL

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.sys_tkill - Sending a kill signal to a thread +  +

SYNOPSIS

+ +

+

+signal.sys_tkill 
+
+ +  +

VALUES

+ +

+ +sig_name +

+The specific signal sent to the process +
+ +

+ +sig +

+The specific signal sent to the process +
+ +

+ +pid +

+The PID of the process receiving the kill signal +
+ +  +

DESCRIPTION

+ +

+ +The <command>tkill</command> call is analogous to <command>kill(2)</command>, 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). +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.syskill.3stap.html b/man/signal.syskill.3stap.html new file mode 100644 index 00000000..7bac9b06 --- /dev/null +++ b/man/signal.syskill.3stap.html @@ -0,0 +1,79 @@ + +Manpage of SIGNAL\&.SYSKILL + +

SIGNAL\&.SYSKILL

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.syskill - Sending kill signal to a process +  +

SYNOPSIS

+ +

+

+signal.syskill 
+
+ +  +

VALUES

+ +

+ +sig +

+The specific signal sent to the process +
+ +

+ +pid +

+The PID of the process receiving the signal +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.syskill.return.3stap.html b/man/signal.syskill.return.3stap.html new file mode 100644 index 00000000..d3103dae --- /dev/null +++ b/man/signal.syskill.return.3stap.html @@ -0,0 +1,68 @@ + +Manpage of SIGNAL\&.SYSKILL\&.R + +

SIGNAL\&.SYSKILL\&.R

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.syskill.return - Sending kill signal completed +  +

SYNOPSIS

+ +

+

+signal.syskill.return 
+
+ +  +

VALUES

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.systkill.return.3stap.html b/man/signal.systkill.return.3stap.html new file mode 100644 index 00000000..c5a7ebe2 --- /dev/null +++ b/man/signal.systkill.return.3stap.html @@ -0,0 +1,68 @@ + +Manpage of SIGNAL\&.SYSTKILL\&. + +

SIGNAL\&.SYSTKILL\&.

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.systkill.return - Sending kill signal to a thread completed +  +

SYNOPSIS

+ +

+

+signal.systkill.return 
+
+ +  +

VALUES

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/signal.wakeup.3stap.html b/man/signal.wakeup.3stap.html new file mode 100644 index 00000000..f4c5663e --- /dev/null +++ b/man/signal.wakeup.3stap.html @@ -0,0 +1,93 @@ + +Manpage of SIGNAL\&.WAKEUP + +

SIGNAL\&.WAKEUP

+Section: Signal Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +signal.wakeup - Sleeping process being wakened for signal +  +

SYNOPSIS

+ +

+

+signal.wakeup 
+
+ +  +

VALUES

+ +

+ +resume +

+Indicates whether to wake up a task in a <command>STOPPED</command> or <command>TRACED</command> state +
+ +

+ +state_mask +

+A string representation indicating the mask of task states to wake. Possible values are <command>TASK_INTERRUPTIBLE</command>, <command>TASK_STOPPED</command>, <command>TASK_TRACED</command>, and <command>TASK_INTERRUPTIBLE</command>. +
+ +

+ +pid_name +

+Name of the process to wake +
+ +

+ +sig_pid +

+The PID of the process to wake +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/sock_fam_num2str.3stap.html b/man/sock_fam_num2str.3stap.html new file mode 100644 index 00000000..ccd3e8de --- /dev/null +++ b/man/sock_fam_num2str.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SOCK_FAM_NUM2STR + +

SOCK_FAM_NUM2STR

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sock_fam_num2str - Given a protocol family number, return a string representation. +  +

SYNOPSIS

+ +

+

+    sock_fam_num2str:string(family:long)
+
+ +  +

ARGUMENTS

+ +

+ +family +

+The family number. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/sock_fam_str2num.3stap.html b/man/sock_fam_str2num.3stap.html new file mode 100644 index 00000000..e1c65fd9 --- /dev/null +++ b/man/sock_fam_str2num.3stap.html @@ -0,0 +1,79 @@ + +Manpage of SOCK_FAM_STR2NUM + +

SOCK_FAM_STR2NUM

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sock_fam_str2num - Given a protocol family name (string), return the corresponding +  +

SYNOPSIS

+ +

+

+    sock_fam_str2num:long(family:string)
+
+ +  +

ARGUMENTS

+ +

+ +family +

+The family name. +
+ +  +

DESCRIPTION

+ +

+ +protocol family number. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/sock_prot_num2str.3stap.html b/man/sock_prot_num2str.3stap.html new file mode 100644 index 00000000..4709a8af --- /dev/null +++ b/man/sock_prot_num2str.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SOCK_PROT_NUM2STR + +

SOCK_PROT_NUM2STR

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sock_prot_num2str - Given a protocol number, return a string representation. +  +

SYNOPSIS

+ +

+

+    sock_prot_num2str:string(proto:long)
+
+ +  +

ARGUMENTS

+ +

+ +proto +

+The protocol number. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/sock_prot_str2num.3stap.html b/man/sock_prot_str2num.3stap.html new file mode 100644 index 00000000..0ad0f6a4 --- /dev/null +++ b/man/sock_prot_str2num.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SOCK_PROT_STR2NUM + +

SOCK_PROT_STR2NUM

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sock_prot_str2num - Given a protocol name (string), return the corresponding protocol number. +  +

SYNOPSIS

+ +

+

+    sock_prot_str2num:long(proto:string)
+
+ +  +

ARGUMENTS

+ +

+ +proto +

+The protocol name. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/sock_state_num2str.3stap.html b/man/sock_state_num2str.3stap.html new file mode 100644 index 00000000..f8663f32 --- /dev/null +++ b/man/sock_state_num2str.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SOCK_STATE_NUM2STR + +

SOCK_STATE_NUM2STR

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sock_state_num2str - Given a socket state number, return a string representation. +  +

SYNOPSIS

+ +

+

+    sock_state_num2str:string(state:long)
+
+ +  +

ARGUMENTS

+ +

+ +state +

+The state number. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/sock_state_str2num.3stap.html b/man/sock_state_str2num.3stap.html new file mode 100644 index 00000000..06bbf8eb --- /dev/null +++ b/man/sock_state_str2num.3stap.html @@ -0,0 +1,72 @@ + +Manpage of SOCK_STATE_STR2NUM + +

SOCK_STATE_STR2NUM

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +sock_state_str2num - Given a socket state string, return the corresponding state number. +  +

SYNOPSIS

+ +

+

+    sock_state_str2num:long(state:string)
+
+ +  +

ARGUMENTS

+ +

+ +state +

+The state name. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.aio_read.3stap.html b/man/socket.aio_read.3stap.html new file mode 100644 index 00000000..ec2ea95d --- /dev/null +++ b/man/socket.aio_read.3stap.html @@ -0,0 +1,130 @@ + +Manpage of SOCKET\&.AIO_READ + +

SOCKET\&.AIO_READ

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.aio_read - Receiving message via sock_aio_read +  +

SYNOPSIS

+ +

+

+socket.aio_read 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Message size in bytes +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender +  +

DESCRIPTION

+ +

+ +Fires at the beginning of receiving a message on a socket via the +sock_aio_read +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.aio_read.return.3stap.html b/man/socket.aio_read.return.3stap.html new file mode 100644 index 00000000..808d341e --- /dev/null +++ b/man/socket.aio_read.return.3stap.html @@ -0,0 +1,137 @@ + +Manpage of SOCKET\&.AIO_READ\&. + +

SOCKET\&.AIO_READ\&.

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.aio_read.return - Conclusion of message received via sock_aio_read +  +

SYNOPSIS

+ +

+

+socket.aio_read.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was receive successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message received (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver. +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of receiving a message on a socket via the +sock_aio_read +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.aio_write.3stap.html b/man/socket.aio_write.3stap.html new file mode 100644 index 00000000..be3ad0fb --- /dev/null +++ b/man/socket.aio_write.3stap.html @@ -0,0 +1,130 @@ + +Manpage of SOCKET\&.AIO_WRITE + +

SOCKET\&.AIO_WRITE

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.aio_write - Message send via sock_aio_write +  +

SYNOPSIS

+ +

+

+socket.aio_write 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Message size in bytes +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender +  +

DESCRIPTION

+ +

+ +Fires at the beginning of sending a message on a socket via the +sock_aio_write +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.aio_write.return.3stap.html b/man/socket.aio_write.return.3stap.html new file mode 100644 index 00000000..1dcc66d0 --- /dev/null +++ b/man/socket.aio_write.return.3stap.html @@ -0,0 +1,137 @@ + +Manpage of SOCKET\&.AIO_WRITE\& + +

SOCKET\&.AIO_WRITE\&

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.aio_write.return - Conclusion of message send via sock_aio_write +  +

SYNOPSIS

+ +

+

+socket.aio_write.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was receive successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message received (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver. +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of sending a message on a socket via the +sock_aio_write +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.close.3stap.html b/man/socket.close.3stap.html new file mode 100644 index 00000000..afdd3827 --- /dev/null +++ b/man/socket.close.3stap.html @@ -0,0 +1,121 @@ + +Manpage of SOCKET\&.CLOSE + +

SOCKET\&.CLOSE

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.close - Close a socket +  +

SYNOPSIS

+ +

+

+socket.close 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The requester (user process or kernel) +  +

DESCRIPTION

+ +

+ +Fires at the beginning of closing a socket. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.close.return.3stap.html b/man/socket.close.return.3stap.html new file mode 100644 index 00000000..fdbfd337 --- /dev/null +++ b/man/socket.close.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of SOCKET\&.CLOSE\&.RET + +

SOCKET\&.CLOSE\&.RET

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.close.return - Return from closing a socket +  +

SYNOPSIS

+ +

+

+socket.close.return 
+
+ +  +

VALUES

+ +

+ +name +

+Name of this probe +
+ +  +

CONTEXT

+ +

+ +The requester (user process or kernel) +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of closing a socket. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.create.3stap.html b/man/socket.create.3stap.html new file mode 100644 index 00000000..6a942b68 --- /dev/null +++ b/man/socket.create.3stap.html @@ -0,0 +1,114 @@ + +Manpage of SOCKET\&.CREATE + +

SOCKET\&.CREATE

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.create - Creation of a socket +  +

SYNOPSIS

+ +

+

+socket.create 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +name +

+Name of this probe +
+ +

+ +requester +

+Requested by user process or the kernel (1 = kernel, 0 = user) +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The requester (see requester variable) +  +

DESCRIPTION

+ +

+ +Fires at the beginning of creating a socket. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.create.return.3stap.html b/man/socket.create.return.3stap.html new file mode 100644 index 00000000..e0e7de7e --- /dev/null +++ b/man/socket.create.return.3stap.html @@ -0,0 +1,128 @@ + +Manpage of SOCKET\&.CREATE\&.RE + +

SOCKET\&.CREATE\&.RE

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.create.return - Return from Creation of a socket +  +

SYNOPSIS

+ +

+

+socket.create.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was socket creation successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +err +

+Error code if success == 0 +
+ +

+ +name +

+Name of this probe +
+ +

+ +requester +

+Requested by user process or the kernel (1 = kernel, 0 = user) +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The requester (user process or kernel) +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of creating a socket. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.readv.3stap.html b/man/socket.readv.3stap.html new file mode 100644 index 00000000..54783e9b --- /dev/null +++ b/man/socket.readv.3stap.html @@ -0,0 +1,130 @@ + +Manpage of SOCKET\&.READV + +

SOCKET\&.READV

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.readv - Receiving a message via sock_readv +  +

SYNOPSIS

+ +

+

+socket.readv 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Message size in bytes +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender +  +

DESCRIPTION

+ +

+ +Fires at the beginning of receiving a message on a socket via the +sock_readv +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.readv.return.3stap.html b/man/socket.readv.return.3stap.html new file mode 100644 index 00000000..8a80cca7 --- /dev/null +++ b/man/socket.readv.return.3stap.html @@ -0,0 +1,137 @@ + +Manpage of SOCKET\&.READV\&.RET + +

SOCKET\&.READV\&.RET

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.readv.return - Conclusion of receiving a message via sock_readv +  +

SYNOPSIS

+ +

+

+socket.readv.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was receive successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message received (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver. +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of receiving a message on a socket via the +sock_readv +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.receive.3stap.html b/man/socket.receive.3stap.html new file mode 100644 index 00000000..5e5c0423 --- /dev/null +++ b/man/socket.receive.3stap.html @@ -0,0 +1,128 @@ + +Manpage of SOCKET\&.RECEIVE + +

SOCKET\&.RECEIVE

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.receive - Message received on a socket. +  +

SYNOPSIS

+ +

+

+socket.receive 
+
+ +  +

VALUES

+ +

+ +success +

+Was send successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message received (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.recvmsg.3stap.html b/man/socket.recvmsg.3stap.html new file mode 100644 index 00000000..6c0dd678 --- /dev/null +++ b/man/socket.recvmsg.3stap.html @@ -0,0 +1,130 @@ + +Manpage of SOCKET\&.RECVMSG + +

SOCKET\&.RECVMSG

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.recvmsg - Message being received on socket +  +

SYNOPSIS

+ +

+

+socket.recvmsg 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Message size in bytes +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver. +  +

DESCRIPTION

+ +

+ +Fires at the beginning of receiving a message on a socket via the +sock_recvmsg +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.recvmsg.return.3stap.html b/man/socket.recvmsg.return.3stap.html new file mode 100644 index 00000000..026d2d5a --- /dev/null +++ b/man/socket.recvmsg.return.3stap.html @@ -0,0 +1,137 @@ + +Manpage of SOCKET\&.RECVMSG\&.R + +

SOCKET\&.RECVMSG\&.R

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.recvmsg.return - Return from Message being received on socket +  +

SYNOPSIS

+ +

+

+socket.recvmsg.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was receive successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message received (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver. +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of receiving a message on a socket via the +sock_recvmsg +function. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.send.3stap.html b/man/socket.send.3stap.html new file mode 100644 index 00000000..5678a925 --- /dev/null +++ b/man/socket.send.3stap.html @@ -0,0 +1,128 @@ + +Manpage of SOCKET\&.SEND + +

SOCKET\&.SEND

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.send - Message sent on a socket. +  +

SYNOPSIS

+ +

+

+socket.send 
+
+ +  +

VALUES

+ +

+ +success +

+Was send successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message sent (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.sendmsg.3stap.html b/man/socket.sendmsg.3stap.html new file mode 100644 index 00000000..6675a3e6 --- /dev/null +++ b/man/socket.sendmsg.3stap.html @@ -0,0 +1,130 @@ + +Manpage of SOCKET\&.SENDMSG + +

SOCKET\&.SENDMSG

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.sendmsg - Message is currently being sent on a socket. +  +

SYNOPSIS

+ +

+

+socket.sendmsg 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Message size in bytes +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender +  +

DESCRIPTION

+ +

+ +Fires at the beginning of sending a message on a socket via the +sock_sendmsg +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.sendmsg.return.3stap.html b/man/socket.sendmsg.return.3stap.html new file mode 100644 index 00000000..9281fa5a --- /dev/null +++ b/man/socket.sendmsg.return.3stap.html @@ -0,0 +1,137 @@ + +Manpage of SOCKET\&.SENDMSG\&.R + +

SOCKET\&.SENDMSG\&.R

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.sendmsg.return - Return from <command>socket.sendmsg</command>. +  +

SYNOPSIS

+ +

+

+socket.sendmsg.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was send successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message sent (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender. +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of sending a message on a socket via the +sock_sendmsg +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.writev.3stap.html b/man/socket.writev.3stap.html new file mode 100644 index 00000000..6ddc136b --- /dev/null +++ b/man/socket.writev.3stap.html @@ -0,0 +1,130 @@ + +Manpage of SOCKET\&.WRITEV + +

SOCKET\&.WRITEV

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.writev - Message sent via socket_writev +  +

SYNOPSIS

+ +

+

+socket.writev 
+
+ +  +

VALUES

+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Message size in bytes +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message sender +  +

DESCRIPTION

+ +

+ +Fires at the beginning of sending a message on a socket via the +sock_writev +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/socket.writev.return.3stap.html b/man/socket.writev.return.3stap.html new file mode 100644 index 00000000..cae03c3e --- /dev/null +++ b/man/socket.writev.return.3stap.html @@ -0,0 +1,137 @@ + +Manpage of SOCKET\&.WRITEV\&.RE + +

SOCKET\&.WRITEV\&.RE

+Section: Socket Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +socket.writev.return - Conclusion of message sent via socket_writev +  +

SYNOPSIS

+ +

+

+socket.writev.return 
+
+ +  +

VALUES

+ +

+ +success +

+Was send successful? (1 = yes, 0 = no) +
+ +

+ +protocol +

+Protocol value +
+ +

+ +flags +

+Socket flags value +
+ +

+ +name +

+Name of this probe +
+ +

+ +state +

+Socket state value +
+ +

+ +size +

+Size of message sent (in bytes) or error code if success = 0 +
+ +

+ +type +

+Socket type value +
+ +

+ +family +

+Protocol family value +
+ +  +

CONTEXT

+ +

+ +The message receiver. +  +

DESCRIPTION

+ +

+ +Fires at the conclusion of sending a message on a socket via the +sock_writev +function +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stack_size.3stap.html b/man/stack_size.3stap.html new file mode 100644 index 00000000..921a0e46 --- /dev/null +++ b/man/stack_size.3stap.html @@ -0,0 +1,68 @@ + +Manpage of STACK_SIZE + +

STACK_SIZE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +stack_size - Return the size of the kernel stack. +  +

SYNOPSIS

+ +

+

+    stack_size:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stack_unused.3stap.html b/man/stack_unused.3stap.html new file mode 100644 index 00000000..736fb301 --- /dev/null +++ b/man/stack_unused.3stap.html @@ -0,0 +1,77 @@ + +Manpage of STACK_UNUSED + +

STACK_UNUSED

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +stack_unused - Returns the amount of kernel stack currently available. +  +

SYNOPSIS

+ +

+

+    stack_unused:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Determines how many bytes are currently available in the kernel stack. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stack_used.3stap.html b/man/stack_used.3stap.html new file mode 100644 index 00000000..38b6f15f --- /dev/null +++ b/man/stack_used.3stap.html @@ -0,0 +1,77 @@ + +Manpage of STACK_USED + +

STACK_USED

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +stack_used - Returns the amount of kernel stack used. +  +

SYNOPSIS

+ +

+

+    stack_used:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Determines how many bytes are currently used in the kernel stack. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stap-server.8.html b/man/stap-server.8.html new file mode 100644 index 00000000..262fe14b --- /dev/null +++ b/man/stap-server.8.html @@ -0,0 +1,555 @@ + +Manpage of STAP-SERVER + +

STAP-SERVER

+Section: Maintenance Commands (8)
Updated: 2009-09-28
Index +Return to Main Contents
+ +  +

NAME

+ +stap-server - systemtap server and related utilities +

+  +

SYNOPSIS

+ +

+
+ +stap-start-server + +
+ +stap-find-servers + +[ +--all + +] +
+ +stap-find-or-start-server + +
+ +stap-stop-server + +PID + +
+ +stap-authorize-server-cert CERTFILE [ DIRNAME ] + +
+ +stap-client + +[ +--server=HOSTNAME|IP_ADDRESS[:PORT] + +] +[ +--ssl=DIRNAME + +] +[ +ARGUMENTS + +] +

+  +

DESCRIPTION

+ +

+The systemtap server listens for connections from +stap-client + +on a secure SSL network port and accepts requests to run the +stap + +front end. +

+

+ +The +stap-start-server + +program attempts to start a systemtap server (stap-serverd) +on the local host. Upon +successful startup, the server listens for connections on a random port and +advertises its presence on the local network using the +avahi + +daemon. If the server is successfully started, its process id is +echoed to stdout and the exit code is 0. Otherwise, nothing is echoed and the +exit code is 1. +

+

+ +The +stap-find-servers + +program attempts to find systemtap servers running on the local network. +The details of any servers found are echoed to stdout. +If servers are found, then the exit code is 0, otherwise it is 1. +

+

+ +The +stap-find-or-start-server + +program attempts to find a compatible systemtap server running on the local network +using +stap-find-servers. + +If a compatible server is found, +stap-find-or-start-server + +echoes [aq]0[aq] to stdout. Otherwise +stap-find-or-start-server + +attempts to start a server on the local network using +stap-start-server. + +If successful, the process id of the new server is echoed to stdout. +If no server can be found or started, [aq]-1[aq] is echoed +to stdout. The exit code is 0 in all cases. +

+

+ +The +stap-stop-server + +program verifies that the given process id is that of a running systemtap server +on the local host and, if so, attempts to shut down the server by sending it the +SIGTERM signal. If a process id is provided and it is that of a running systemtap +server, the exit code is 0. Otherwise the exit code is 1. +stap-stop-server + +does not verify that the server actually shuts down. +

+

+ +The +stap-authorize-server-cert + +program adds the given server certificate to the given client-side +certificate database, making that server a trusted server for clients using that database. +

+

+ +The +stap-client + +program is analogous to the +stap + +front end except that it attempts to find a compatible systemtap server on the +local network and then attempts to use that server for actions related to +passes 1 through 4. Pass 5 actions, if requested, are performed on the local +host using +staprun. + +Upon successful completion, the exit code is 0. Otherwise the exit code +is 1. +

+  +

OPTIONS

+ +The +stap-find-servers + +program supports the following option. Any other option +is ignored. +
+
--all + +
+Instructs +stap-find-servers + +to report all systemtap servers on the local network regardless of compatibility. +The default behavior is to report only servers which are compatible with +systemtap on the local host. +

+

+

+ +In addition to the options accepted by the +stap + +front end, +stap-client + +accepts the following: +

+

+
--server=HOSTNAME|IP_ADDRESS[:PORT] + +
+This option instructs +stap-client + +to use the named server instead of looking for one automatically. The server may +be specified using a valid host name or ip address. If no port is specified, then +stap-client + +searches for the server among the servers advertising their presence on the +local network and uses the port which is being advertised. This is useful for +connecting to a specific server on the local network. If a port is specified, +then +stap-client + +will attempt to connect to the named host on the specified port. This is useful +for connecting to non-local servers. If +--server + +is specified, +stap-client + +will make no attempt to contact other servers. If more than one +--server + +option is specified, +stap-client + +will attempt to use the servers in the order specified. +

+

--ssl=DIRNAME + +
+stap-client + +uses certificate databases in default locations (see +SERVER MANAGEMENT + +below) in order to authenticate each server which is contacted. The +--ssl + +option is used to specify additional databases to search. Databases specified +using +--ssl + +are searched before the default databases. If more than one +--ssl + +option is specified, then the databases are searched in the order specified on +the command line followed by the default locations. +

+

+  +

ARGUMENTS

+ +The +stap-stop-server + +program requires a process id argument which identifies the server to be stopped. +

+

+ +The +stap-authorize-server-cert + +program accepts two arguments: +

+

+
CERTFILE + +
+This is the name of the file containing the certificate of the new trusted +server. This is the file named stap.cert which can be found in the +server[aq]s certificate database. +

+

DIRNAME + +
+This optional argument is the name of the directory containing the client-side +certificate database to which the certificate is to be added. If not specified, the +default, for non-root users, is +$HOME/.systemtap/ssl/server. + +For root users (EUID=0), the default is +$sysconfdir/systemtap/ssl/server. + +

+

+

+ +The +stap-client + +program accepts the same arguments as +stap. + +See stap(1) for details. +

+  +

SERVER MANAGEMENT

+ +The security of the SSL network connection between the client and server and +of the signing and verification of the server[aq]s response depend on the proper +management of server certificates and the public and private key pairs with which +they are signed and verified. +

+

+ +The trustworthiness of a given systemtap server can not be determined +automatically without a trusted certificate authority issuing systemtap server +certificates. This is +not practical in everyday use and so, clients must authenticate servers +against their own databases of trusted server certificates. In this context, +establishing a given server as trusted by a given client means adding +that server[aq]s certificate to the +client[aq]s database of trusted servers. +

+

+ +The implementation of the client and server have automated many of the tasks +required. In particular: +

+

+
*
+When a user starts a server for the first time, the server will generate its +own certificate and add it to a database local to that user. For non-root users, +this database will be created in +$HOME/.systemtap/ssl/server. + +For root users (EUID=0), it will be created in +$sysconfdir/systemtap/ssl/server. + +

+

*
+At this time, the +server will also create a local client-side certificate database and add the +server[aq]s certificate to it. For non-root users, +this database will be created in +$HOME/.systemtap/ssl/client. + +For root users (EUID=0), it will be created in +$sysconfdir/systemtap/ssl/client. + +

+In this way, a server started by a given user is automatically trusted by +clients run by that user. +

+

*
+The client-side certificate database created for root users is also +the global client-side database for all clients on the host. In this way, +a server started by root is automatically trusted by clients run by any +user on that host. +

+

+

+ +The trustworthiness of other servers may be asserted in one of two ways: +

+

+
*
+Other existing client-side certificate databases may be searched by using the +--ssl + +option one or more times when running the client (see +OPTIONS + +above). Servers whose certificates are contained in the additional databases +will be considered to be trusted for that invocation of the client. +

+

*
+A user may add the certificate of a new trusted server to his own local +client-side certificate database using +[aq]stap-authorize-server-cert CERTFILE[aq] +(see above), where CERTFILE is the server[aq]s certificate file +(stap.cert) from the server[aq]s certificate database directory and +DIRNAME is the +directory containing the user[aq]s client-side certificate database. +

+The server will trusted by clients run by that user from then on. +

+

+

+ +When a root (EUID=0) user adds a server[aq]s certificate to their client-side +certificate database, which is also the global database for all users on that +host, they assert the trustworthiness of that server for all users on that +host. +

+  +

EXAMPLES

+ +See the +stapex(3stap) + +manual page for a collection of sample scripts. +

+ +Here is a very basic example of how to use +stap-client. + +

+ +To find out if a compatible systemtap server is running on your local network +

+ + $ stap-find-servers + +

+ +If no servers are reported, you can start one using +

+ + $ stap-start-server + +

+ +You could also have accomplished both of the previous two steps using +

+ + $ stap-find-or-start-server + +

+ +To compile and execute a simple example using an automatically discovered +server on the local network +

+ + $ stap-client -e [aq]probe begin { printf(Hello World!\n); exit() }[aq] + +
+ + Hello World! +

+ +To compile and execute a simple example using a server on a specific host +on the local network +

+ + $ stap-client --server=HOSTNAME -e [aq]probe begin { printf(Hello World!\n); exit() }[aq] + +
+ + Hello World! +

+ +To compile and execute a simple example using a specific server +

+ + $ stap-client --server=HOSTNAME:PORT -e [aq]probe begin { printf(Hello World!\n); exit() }[aq] + +
+ + Hello World! +

+ +To search additional certificate databases in order to compile and execute a +simple example +

+ + $ stap-client --ssl=DIRNAME -e [aq]probe begin { printf(Hello World!\n); exit() }[aq] + +
+ + Hello World! +

+ +To permanently trust a given server for your own use +

+ + $ stap-authorize-server-cert CERTFILE + +

+ +As root, to permanently trust a given server for all users on your host +

+ + $ stap-authorize-server-cert CERTFILE + +

+ +If a process id was echoed by +stap-start-server + +or +stap-find-or-start-server + +then you can stop the server using +

+ + $ stap-stop-server PID + +

+ +where PID is the process id that was echoed. +

+  +

SAFETY AND SECURITY

+ +Systemtap is an administrative tool. It exposes kernel internal data +structures and potentially private user information. See the +stap(1) + +manual page for additional information on safety and security. +

+

+ +The systemtap server and its related utilities use the Secure Socket Layer +(SSL) as implemented by Network Security Services (NSS) +for network security. The NSS tool +certutil + +is used for the generation of certificates. The related +certificate databases must be protected in order to maintain the security of +the system. +Use of the utilities provided will help to ensure that the proper protection +is maintained. The systemtap client and server will both check for proper +access permissions before making use of any certificate database. +

+  +

SEE ALSO

+ +stap(1), + +staprun(8), + +stapprobes(3stap), + +stapfuncs(3stap), + +stapex(3stap), + +NSS, + +certutil + +

+  +

BUGS

+ +Use the Bugzilla link off of the project web page or our mailing list. + +http://sources.redhat.com/systemtap/, <systemtap@sources.redhat.com>. + + +

+

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
DESCRIPTION
+
OPTIONS
+
ARGUMENTS
+
SERVER MANAGEMENT
+
EXAMPLES
+
SAFETY AND SECURITY
+
SEE ALSO
+
BUGS
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stap.1.html b/man/stap.1.html index 07216502..b843cbd2 100644 --- a/man/stap.1.html +++ b/man/stap.1.html @@ -2,8 +2,8 @@ Manpage of STAP

STAP

-Section: User Commands (1)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: User Commands (1)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -59,6 +59,34 @@ stap - systemtap script translator/driver [ ARGUMENTS +] +
+ +stap + +[ +OPTIONS + +] +-l PROBE + +[ +ARGUMENTS + +] +
+ +stap + +[ +OPTIONS + +] +-L PROBE + +[ +ARGUMENTS + ]

  @@ -93,21 +121,14 @@ somewhat similar conceptually to "breakpoint command lists" in the debugger.

-This manual corresponds to version ?. +This manual corresponds to version 1.0.

 

OPTIONS

The systemtap translator supports the following options. Any other option prints a list of supported options. - -
-
-v - -
-Increase verbosity. Produce a larger volume of informative (?) output -each time option repeated.
-h
@@ -116,6 +137,25 @@ Show help message.
Show version message. +
-p NUM + +
+Stop after pass NUM. The passes are numbered 1-5: parse, elaborate, +translate, compile, run. See the +PROCESSING + +section for details. +
-v + +
+Increase verbosity for all passes. Produce a larger volume of +informative (?) output each time option repeated. +
--vp ABCDE + +
+Increase verbosity on a per-pass basis. For example, "--vp 002" +adds 2 units of verbosity to pass 3 only. The combination "-v --vp 00004" +adds 1 unit of verbosity for all passes, and 4 more for pass 5.
-k
@@ -131,7 +171,7 @@ embedded C.
Prologue-searching mode. Activate heuristics to work around incorrect -debbugging information for $target variables. +debugging information for $target variables.
-u
@@ -139,7 +179,7 @@ Unoptimized mode. Disable unused code elision during elaboration.
-w
-Suppressed warnings mode. Disable warning messages for elided code in user script. +Suppressed warnings mode. Disables all warning messages.
-b
@@ -154,14 +194,6 @@ and average amount of time spent in each probe.
Use NUM megabyte buffers for kernel-to-user data transfer. On a multiprocessor in bulk mode, this is a per-processor amount. -
-p NUM - -
-Stop after pass NUM. The passes are numbered 1-5: parse, elaborate, -translate, compile, run. See the -PROCESSING - -section for details.
-I DIR
@@ -170,27 +202,52 @@ description of pass 2 for details.
-D NAME=VALUE
-Add the given C preprocessor directive to the module Makefile. These can +Add the given C preprocessor directive to the module Makefile. These can be used to override limit parameters described below. +
-B NAME=VALUE + +
+Add the given make directive to the kernel module build's make invocation. +These can be used to add or override kconfig options.
-R DIR
Look for the systemtap runtime sources in the given directory. +
-r /DIR + +
+Build for kernel in given build tree. Can also be set with the +SYSTEMTAP_RELEASE + +environment variable.
-r RELEASE
-Build for given kernel release instead of currently running one. +Build for kernel in build tree +/lib/modules/RELEASE/build. + +Can also be set with the +SYSTEMTAP_RELEASE + +environment variable.
-m MODULE
Use the given name for the generated kernel object module, instead of a unique randomized name. The generated kernel object module is copied to the current directory. +
-d MODULE + +
+Add symbol/unwind information for the given module into the kernel object +module. This may enable symbolic tracebacks from those modules/programs, +even if they do not have an explicit probe placed into them.
-o FILE
Send standard output to named file. In bulk mode, percpu files will -start with FILE_ followed by the cpu number. +start with FILE_ (FILE_cpu with -F) followed by the cpu number. +This supports strftime(3) formats for FILE.
-c CMD
@@ -198,8 +255,83 @@ Start the probes, run CMD, and exit when CMD finishes.
-x PID
-Sets target() to PID. This allows scripts to be written that filter on +Sets target() to PID. This allows scripts to be written that filter on a specific process. +
-l PROBE + +
+Instead of running a probe script, just list all available probe +points matching the given pattern. The pattern may include wildcards +and aliases. +
-L PROBE + +
+Similar to "-l", but list probe points and script-level local variables. +
-F + +
+Without -o option, load module and start probes, then detach from the module +leaving the probes running. +With -o option, run staprun in background as a daemon and show its pid. +
-S size[,N] + +
+Sets the maximum size of output file and the maximum number of output files. +If the size of output file will exceed +size + +, systemtap switches output file to the next file. And if the number of +output files exceed +N + +, systemtap removes the oldest output file. You can omit the second argument. +
--kelf + +
+For names and addresses of functions to probe, +consult the symbol tables in the kernel and modules. +This can be useful if your kernel and/or modules were compiled +without debugging information, or the function you want to probe +is in an assembly-language file built without debugging information. +See the +MAKING DO WITH SYMBOL TABLES + +section for more information. +
--kmap[=FILE] + +
+For names and addresses of kernel functions to probe, +consult the symbol table in the indicated text file. +The default is /boot/System.map-VERSION. +The contents of this file should be in the form of the default output from +nm(1). + +Only symbols of type T or t are used. +If you specify /proc/kallsyms or some other file in that format, +where lines for module symbols contain a fourth column, +reading of the symbol table stops with the first module symbol +(which should be right after the last kernel symbol). +As with +--kelf, + +the symbol table in each module's .ko file will also be consulted. +See the +MAKING DO WITH SYMBOL TABLES + +section for more information. +
--ignore-vmlinux + +
+For testing, act as though neither the uncompressed kernel (vmlinux) +nor the kernel debugging information can be found. +
--ignore-dwarf + +
+For testing, act as though vmlinux and modules lack debugging information. +
--skip-badvars + +
+Ignore out of context variables and substitute with literal 0.

  @@ -213,7 +345,7 @@ parser for substitution. See below.

SCRIPT LANGUAGE

-The systemtap script language resembles +The systemtap script language resembles awk. There are two main outermost constructs: probes and functions. Within @@ -269,7 +401,7 @@ number beyond what was actually given is an error.

PREPROCESSING

A simple conditional preprocessing stage is run as a part of parsing. -The general form is similar to the +The general form is similar to the cond ? exp1 : exp2 ternary operator: @@ -288,7 +420,10 @@ ternary operator: The CONDITION is either an expression whose format is determined by its first keyword, or a string literals comparison or a numeric literals -comparison. +comparison. It can be also composed of many alternatives and conjunctions +of CONDITIONs (meant as in previous sentence) using || and && respectively. +However, parentheses are not supported yet, so remembering that conjunction +takes precedence over alternative is important.

If the first part is the identifier @@ -308,17 +443,31 @@ option) compares to the given version string. The comparison is performed by the glibc function strverscmp. +As a special case, if the operator is for simple equality +(==), + +or inequality +(!=), + +and the third part contains any wildcard characters +(* or ? or [), + +then the expression is treated as a wildcard (mis)match as evaluated +by +fnmatch. +

If, on the other hand, the first part is the identifier arch -to refer to the processor architecture, then the second part -then the second part is one of the two string comparison operators +to refer to the processor architecture (as named by the kernel +build system ARCH/SUBARCH), then the second part then the second +part is one of the two string comparison operators == or !=, and the third part is a string literal for matching it. This -comparison is simple string (in)equality. +comparison is a wildcard (mis)match.

Otherwise, the CONDITION is expected to be a comparison between two string @@ -349,14 +498,14 @@ The following code might adapt to hypothetical kernel version drift:

-probe kernel.function ( 
-  %( kernel_v <= "2.6.12" %? "__mm_do_fault" %: 
-     %( kernel_vr == "2.6.13-1.8273FC3smp" %? "do_page_fault" %:
+probe kernel.function (
+  %( kernel_v <= "2.6.12" %? "__mm_do_fault" %:
+     %( kernel_vr == "2.6.13*smp" %? "do_page_fault" %:
         UNSUPPORTED %) %)
 ) { /* ... */ }
 
 %( arch == "ia64" %?
-   probe syscall.vliw = kernel.function("vliw_widget") {} 
+   probe syscall.vliw = kernel.function("vliw_widget") {}
 %)
 
 
@@ -390,7 +539,7 @@ var1 = 5 var2 = "bar" array1 [pid()] = "name" # single numeric key array2 ["foo",4,i++] += 5 # vector of string/num/num keys -if (["hello",5,4] in array2) log ("yes") # membership test +if (["hello",5,4] in array2) println ("yes") # membership test @@ -410,7 +559,9 @@ Variables may be declared global, so that they are shared amongst all probes and live as long as the entire systemtap session. There is one namespace for all global variables, regardless of which script file they are found within. A global declaration may be written at the -outermost level anywhere, not within a block of code. The following +outermost level anywhere, not within a block of code. Global +variables which are written but never read will be displayed +automatically at session shutdown. The following declaration marks a few variables as global. The translator will infer for each its value type, and if it is used as an array, its key types. Optionally, scalar globals may be initialized with a string @@ -451,7 +602,7 @@ the value.
{ STMT1 STMT2 ... }
-Execute each statement in sequence in this block. Note that +Execute each statement in sequence in this block. Note that separators or terminators are generally not necessary between statements.
; @@ -478,7 +629,7 @@ STMT, then the iteration expression EXP3.
Loop over each element of the named global array, assigning current key to VAR. The array may not be modified within the statement. -By adding a single +By adding a single + or - operator after the VAR or the ARRAY identifier, the iteration will @@ -487,7 +638,7 @@ Using the optional limit keyword limits the number of loop iterations to EXP times. EXP is -evaluted once at the beginning of the loop. +evaluated once at the beginning of the loop.
foreach ([VAR1, VAR2, ...] in ARRAY [ limit EXP ]) STMT
@@ -549,7 +700,7 @@ detected and results in an error. = .=
unary numeric operators
-+ - ! ~ ++ -- ++ - ! ~ ++ --
binary numeric or string comparison operators
< > <= >= == != @@ -597,7 +748,7 @@ Events are specified in a special syntax called "probe points". There are several varieties of probe points defined by the translator, and tapset scripts may define further ones using aliases. These are listed in the -stapprobes(5) +stapprobes(3stap) manual pages.

@@ -607,7 +758,7 @@ event. For events associated with kernel code, this context may include variables -defined in the +defined in the source code at that spot. These "target variables" are presented to the script as @@ -620,16 +771,16 @@ with optimized code. Some other events have very little context. New probe points may be defined using "aliases". Probe point aliases look similar to probe definitions, but instead of activating a probe at the given point, it just defines a new probe point name as an alias -to an existing one. There are two types of alias, i.e. the prologue +to an existing one. There are two types of alias, i.e. the prologue style and the epilogue style which are identified by "=" and "+=" -respectively. +respectively.

For prologue style alias, the statement block that follows an alias definition is implicitly added as a prologue to any probe that refers to the alias. While for the epilogue style alias, the statement block that follows an alias definition is implicitly added as an epilogue to -any probe that refers to the alias. For example: +any probe that refers to the alias. For example:


@@ -638,6 +789,7 @@ any probe that refers to the alias. For example:

 probe syscall.read = kernel.function("sys_read") {
   fildes = $fd
+  if (execname == "init") next  # skip rest of probe
 }
 
 
@@ -655,14 +807,16 @@ which expands to kernel.function(sys_read), -with the given statement as a prologue. And +with the given statement as a prologue, which is useful to predefine +some variables for the alias user and/or to skip probe processing +entirely based on some conditions. And
 probe syscall.read += kernel.function("sys_read") {
-  fildes = $fd
+  if (tracethis) println ($fd)
 }
 
 
@@ -670,10 +824,11 @@ probe syscall.read += kernel.function("sys_read") {
-defines a new probe point with the given statement as an epilogue. +defines a new probe point with the given statement as an epilogue, which +is useful to take actions based upon variables set or left over by the +the alias user.

-Another probe definition -may use the alias like this: +An alias is used just like a built-in probe type.
@@ -681,6 +836,7 @@ may use the alias like this:

 probe syscall.read {
   printf("reading fd=%d, fildes)
+  if (fildes > 10) tracethis = 1
 }
 
 
@@ -739,10 +895,10 @@ a macro in the translated C code and is in the neighbourhood of 10. There are a set of function names that are specially treated by the translator. They format values for printing to the standard systemtap -log stream in a more convenient way. The +output stream in a more convenient way. The sprint* -variants return the formatted string instead of logging it. +variants return the formatted string instead of printing it.
print, sprint @@ -759,7 +915,8 @@ but also append a newline.
Take a string delimiter and two or more values of any type, and print the -values with the delimiter interposed. +values with the delimiter interposed. The delimiter must be a literal +string constant.
printdln, sprintdln
@@ -771,7 +928,7 @@ but also append a newline.
Take a formatting string and a number of values of corresponding types, -and print them all. +and print them all. The format must be a literal string constant.

@@ -779,28 +936,59 @@ The printf formatting directives similar to those of C, except that they are -fully type-checked by the translator. +fully type-checked by the translator: +

+
+
%b
+Writes a binary blob of the value given, instead of ASCII text. The width specifier determines the number of bytes to write; valid specifiers are %b %1b %2b %4b %8b. Default (%b) is 8 bytes. +
%c
+Character. +
%d,%i
+Signed decimal. +
%m
+Safely reads kernel memory at the given address, outputs its content. The precision specifier determines the number of bytes to read. Default is 1 byte. +
%M
+Same as %m, but outputs in hexadecimal. The minimal size of output is double the precision specifier. +
%o
+Unsigned octal. +
%p
+Unsigned pointer address. +
%s
+String. +
%u
+Unsigned decimal. +
%x
+Unsigned hex value, in all lower-case. +
%X
+Unsigned hex value, in all upper-case. +
%%
+Writes a %. +
+
+ +

+ +Examples:

-        x = sprintf("take %d steps forward, %d steps back\n", 3, 2)
-        printf("take %d steps forward, %d steps back\n", 3+1, 2*2)
-        bob = "bob"
-        alice = "alice"
-        print(bob)
+        a = "alice", b = "bob", p = 0x1234abcd, i = 123, j = -1, id[a] = 1234, id[b] = 4567
         print("hello")
-        print(10)
-        printf("%s phoned %s %.4x times\n", bob, alice . bob, 3456)
-        printf("%s except after %s\n", 
-                sprintf("%s before %s", 
-                        sprint(1), sprint(3)), 
-                sprint("C"))
-        id[bob] = 1234
-        id[alice] = 5678
-        foreach (name in id)
-                printdln("|", strlen(name), name, id[name])
+                Prints: hello
+        println(b)
+                Prints: bob\n
+        println(a . " is " . sprint(16))
+                Prints: alice is 16
+        foreach (name in id)  printdln("|", strlen(name), name, id[name])
+                Prints: 5|alice|1234\n3|bob|4567
+        printf("%c is %s; %x or %X or %p; %d or %u\n",97,a,p,p,p,j,j)
+                Prints: a is alice; 1234abcd or 1234ABCD or 0x1234abcd; -1 or 18446744073709551615\n
+        printf("2 bytes of kernel buffer at address %p: %2m", p, p)
+                Prints: 2 byte of kernel buffer at address 0x1234abcd: <binary data>
+        printf("%4b", p)
+                Prints (these values as binary data): 0x1234abcd
 
 
@@ -847,7 +1035,7 @@ distinct extraction function operating on a given identifier, the translator arranges to compute a set of statistics that satisfy it. The statistics system is thereby "on-demand". Each execution of an extraction function causes the aggregation to be computed for -that moment across all processors. +that moment across all processors.

Here is the set of extractor functions. The first argument of each is @@ -864,7 +1052,7 @@ Histograms are also available, but are more complicated because they have a vector rather than scalar value. @hist_linear(v,start,stop,interval) -represents a linear histogram from "start" to "stop" by increments +represents a linear histogram from "start" to "stop" by increments of "interval". The interval must be positive. Similarly, @hist_log(v) @@ -882,7 +1070,7 @@ family of functions renders a histogram object as a tabular probe foo { x <<< $value } -probe end { +probe end { printf ("avg %d = sum %d / count %d\n", @avg(x), @sum(x), @count(x)) print (@hist_log(v)) @@ -895,6 +1083,97 @@ probe end {

  +

TYPECASTING

+ +Once a pointer has been saved into a script integer variable, the +translator loses the type information necessary to access members from +that pointer. Using the +@cast() + +operator tells the translator how to read a pointer. + +
+ +
+
+@cast(p, "type_name"[, "module"])->member
+
+
+ +
+ + +

+ +This will interpret +p + +as a pointer to a struct/union named +type_name + +and dereference the +member + +value. The optional +module + +tells the translator where to look for information about that type. +Multiple modules may be specified as a list with +: + +separators. If the module is not specified, it will default either to +the probe module for dwarf probes, or to "kernel" for functions and all +other probes types. +

+ +The translator can create its own module with type information from a header +surrounded by angle brackets, in case normal debuginfo is not available. For +kernel headers, prefix it with "kernel" to use the appropriate build system. +All other headers are build with default GCC parameters into a user module. + +
+ +

+
+@cast(tv, "timeval", "<sys/time.h>")->tv_sec
+@cast(task, "task_struct", "kernel<linux/sched.h>")->tgid
+
+
+ +
+ + +

+ +When in guru mode, the translator will also allow scripts to assign new +values to members of typecasted pointers. +

+ +Typecasting is also useful in the case of +void* + +members whose type may be determinable at runtime. + +
+ +

+
+probe foo {
+  if ($var->type == 1) {
+    value = @cast($var->data, "type1")->bar
+  } else {
+    value = @cast($var->data, "type2")->baz
+  }
+  print(value)
+}
+
+
+ +
+ + +

+ 

EMBEDDED C

When in guru mode, the translator accepts embedded code in the @@ -910,7 +1189,7 @@ be useful to add #include instructions, and any auxiliary definitions for use by other embedded -code. +code.

The other place where embedded code is permitted is as a function body. @@ -953,21 +1232,21 @@ the translator from the call sites in order for this to work. The user should examine C code generated for ordinary script-language functions in order to write compatible embedded-C ones.

-  + 

BUILT-INS

A set of builtin functions and probe point aliases are provided by the scripts installed under the -@prefix@/share/systemtap/tapset +/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/tapset directory. These are described in the -stapfuncs(5) and stapprobes(5) +stapfuncs(3stap) and stapprobes(3stap) manual pages.

-  + 

PROCESSING

The translator begins pass 1 by parsing the given input script, @@ -998,7 +1277,7 @@ the following patterns would be searched, in sequence: and finally *.stp -Stopping the translator after pass 1 causes it to print the parse trees. +Stopping the translator after pass 1 causes it to print the parse trees.

@@ -1012,7 +1291,7 @@ until all symbols are resolved and a subset of tapset scripts is selected.

-Next, all probe point descriptions are validated +Next, all probe point descriptions are validated against the wide variety supported by the translator. Probe points that refer to code locations ("synchronous probe points") require the appropriate kernel debugging information to be installed. In the @@ -1032,7 +1311,7 @@ mismatches or invalid $target variables, it sometimes may be useful to disable the optimizations with the -u -option. +option.

Finally, all variable, function, parameter, array, and index types are @@ -1077,21 +1356,32 @@ kernel into temporary files, until the user sends an interrupt signal. Any run-time error encountered by the probe handlers, such as running out of memory, division by zero, exceeding nesting or runtime limits, results in a soft error indication. Soft errors in excess of -MAXERRORS block of all subsequent probes, and terminate the session. -Finally, +MAXERRORS block of all subsequent probes (except error-handling +probes), and terminate the session. Finally, staprun unloads the module, and cleans up.

-  +  +

ABNORMAL TERMINATION

+ +

+One should avoid killing the stap process forcibly, for example with +SIGKILL, because the stapio process (a child process of the stap +process) and the loaded module may be left running on the system. If +this happens, send SIGTERM or SIGINT to any remaining stapio +processes, then use rmmod to unload the systemtap module. +

+

+ 

EXAMPLES

-See the -stapex(5) +See the +stapex(3stap) manual page for a collection of samples.

-  + 

CACHING

The systemtap translator caches the pass 3 output (the generated C @@ -1102,9 +1392,16 @@ version, same systemtap version, etc.). Cached files are stored in the $SYSTEMTAP_DIR/cache -directory, which may be periodically cleaned/erased by the user. +directory. The cache can be limited by having the file +cache_mb_limit + +placed in the cache directory (shown above) containing only an ASCII +integer representing how many MiB the cache should not exceed. Note that +this is a 'soft' limit in that the cache will be cleaned after a new entry +is added, so the total cache size may temporarily exceed this limit. In the +absence of this file, a default will be created with the limit set to 64MiB.

-  + 

SAFETY AND SECURITY

Systemtap is an administrative tool. It exposes kernel internal data @@ -1143,12 +1440,12 @@ program are run by the program. The latter is a part of the Systemtap package, dedicated to module loading and unloading (but only in the white zone), and -kernel-to-user data transfer. Since +kernel-to-user data transfer. Since staprun does not perform any additional security checks on the kernel objects it is given, it would be unwise for a system administrator to add -untrusted users to the +untrusted users to the stapdev or @@ -1170,10 +1467,12 @@ The resource use limits are set by macros in the generated C code. These may be overridden with the -D -flag. A selection of these is as follows: +flag. A selection of these is as follows:
MAXNESTING
-Maximum number of recursive function call levels, default 10. +Maximum number of nested function calls. Default determined by +script analysis, with a bonus 10 slots added for recursive +scripts.
MAXSTRINGLEN
Maximum length of strings, default 128.
MAXTRYLOCK
@@ -1193,16 +1492,56 @@ Maximum number of rows in any single global array, default 2048. Maximum number of soft errors before an exit is triggered, default 0, which means that the first error will exit the script.
MAXSKIPPED
-Maximum number of skipped reentrant probes before an exit is triggered, default 100. +Maximum number of skipped probes before an exit is triggered, default 100. +Running systemtap with -t (timing) mode gives more details about skipped +probes. With the default -DINTERRUPTIBLE=1 setting, probes skipped due to +reentrancy are not accumulated against this limit.
MINSTACKSPACE
Minimum number of free kernel stack bytes required in order to run a probe handler, default 1024. This number should be large enough for the probe handler's own needs, plus a safety margin. +
MAXUPROBES
+Maximum number of concurrently armed user-space probes (uprobes), default +somewhat larger than the number of user-space probe points named in the script. +This pool needs to be potentialy large because individual uprobe objects (about +64 bytes each) are allocated for each process for each matching script-level probe.

-In case something goes wrong with +With scripts that contain probes on any interrupt path, it is possible that +those interrupts may occur in the middle of another probe handler. The probe +in the interrupt handler would be skipped in this case to avoid reentrance. +To work around this issue, execute stap with the option +-DINTERRUPTIBLE=0 + +to mask interrupts throughout the probe handler. This does add some extra +overhead to the probes, but it may prevent reentrance for common problem +cases. However, probes in NMI handlers and in the callpath of the stap +runtime may still be skipped due to reentrance. +

+

+ +Multiple scripts can write data into a relay buffer concurrently. A host +script provides an interface for accessing its relay buffer to guest scripts. +Then, the output of the guests are merged into the output of the host. +To run a script as a host, execute stap with +-DRELAYHOST[=name] + +option. The +name + +identifies your host script among several hosts. +While running the host, execute stap with +-DRELAYGUEST[=name] + +to add a guest script to the host. +Note that you must unload guests before unloading a host. If there are some +guests connected to the host, unloading the host will be failed. +

+

+ +In case something goes wrong with stap or staprun after a probe has already started running, one may safely kill both @@ -1224,7 +1563,61 @@ have overloaded the system and an exit is triggered. By default, overload processing is turned on for all modules. If you would like to disable overload processing, define STP_NO_OVERLOAD.

-  +  +

MAKING DO WITH SYMBOL TABLES

+ +Systemtap performs best when it has access to the debugging information +associated with your kernel and modules. +However, if this information is not available, +systemtap can still support probing of function entries and returns +using symbols read from vmlinux and/or the modules in /lib/modules. +Systemtap can also read the kernel symbol table from a text file +such as /boot/System.map or /proc/kallsyms. +See the +--kelf + +and +--kmap + +options. +

+ +If systemtap finds relevant debugging information, +it will use it even if you specify +--kelf + +or +--kmap. + +

+ +Without debugging information, systemtap cannot support the +following types of language constructs: +

+
*
+probe specifications that refer to source files or line numbers +
*
+probe specifications that refer to inline functions +
*
+statements that refer to $target variables +
*
+statements that refer to @cast() variables +
*
+tapset-defined variables defined using any of the above constructs. +In particular, at this writing, +the prologue blocks for certain aliases in the syscall tapset +(e.g., syscall.open) contain "if" statements that refer to $target variables. +If your script refers to any such aliases, +systemtap must have access to the kernel's debugging information. +
+

+ +Most T and t symbols correspond to function entry points, but some do not. +Based only on the symbol table, systemtap cannot tell the difference. +Placing return probes on symbols that aren't entry points +will most likely lead to kernel stack corruption. +

+ 

FILES

@@ -1238,44 +1631,53 @@ environment variable.
/tmp/stapXXXXXX
Temporary directory for systemtap files, including translated C code and kernel object. -
@prefix@/share/systemtap/tapset
+
/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/tapset
The automatic tapset search directory, unless overridden by the SYSTEMTAP_TAPSET environment variable. -
@prefix@/share/systemtap/runtime
+
/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/runtime
The runtime sources, unless overridden by the SYSTEMTAP_RUNTIME environment variable.
/lib/modules/VERSION/build
The location of kernel module building infrastructure. -
@prefix@/lib/debug/lib/modules/VERSION
+
/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/lib/debug/lib/modules/VERSION
The location of kernel debugging information when packaged into the kernel-debuginfo -RPM. -
@prefix@/bin/staprun
+RPM, unless overridden by the +SYSTEMTAP_DEBUGINFO_PATH + +environment variable. The default value for this variable is ++:.debug:/usr/lib/debug:build. + +Elfutils searches vmlinux in this path and it interprets the path as a base +directory of which various subdirectories will be searched for finding modules. +
/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/bin/staprun
The auxiliary program supervising module loading, interaction, and unloading.

-  + 

SEE ALSO

-stapprobes(5), +stapprobes(3stap), + +stapfuncs(3stap), -stapfuncs(5), +stapvars(3stap), -stapex(5), +stapex(3stap), awk(1), gdb(1)

-  + 

BUGS

Use the Bugzilla link off of the project web page or our mailing list. @@ -1304,21 +1706,26 @@ Use the Bugzilla link off of the project web page or our mailing list.
FUNCTIONS
PRINTING
STATISTICS
-
EMBEDDED C
-
BUILT-INS
+
TYPECASTING
+
EMBEDDED C
+
BUILT-INS
+
+
PROCESSING
+
+
ABNORMAL TERMINATION
-
PROCESSING
-
EXAMPLES
-
CACHING
-
SAFETY AND SECURITY
-
FILES
-
SEE ALSO
-
BUGS
+
EXAMPLES
+
CACHING
+
SAFETY AND SECURITY
+
MAKING DO WITH SYMBOL TABLES
+
FILES
+
SEE ALSO
+
BUGS

This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:12 GMT, September 28, 2009 diff --git a/man/stapex.5.html b/man/stapex.3stap.html similarity index 65% rename from man/stapex.5.html rename to man/stapex.3stap.html index 0949d831..d8d41ff4 100644 --- a/man/stapex.5.html +++ b/man/stapex.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPEX

STAPEX

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -141,8 +141,8 @@ To trace entry and exit from a function, use a pair of probes:
-probe kernel.function("sys_mkdir") { log ("enter") }
-probe kernel.function("sys_mkdir").return { log ("exit") }
+probe kernel.function("sys_mkdir") { println ("enter") }
+probe kernel.function("sys_mkdir").return { println ("exit") }
 
 
@@ -150,15 +150,27 @@ probe kernel.function("sys_mkdir").return { log ("exit") }

-To list the probeable functions in the kernel, use the last-pass -option to the translator. That output needs to be filtered because -each inlined function instance is listed separately. +To list the probeable functions in the kernel, use the listings mode.

-% stap -p2 -e [aq]probe kernel.function("*") {}[aq] | sort | uniq
+% stap -l [aq]kernel.function("*")[aq]
+
+
+ +
+ + +

+To list the probeable functions and local variables in the kernel, use another listings mode. + +
+ +

+
+% stap -L [aq]kernel.function("*")[aq]
 
 
@@ -167,15 +179,24 @@ each inlined function instance is listed separately.

  +

MORE EXAMPLES

+ +

+Larger examples, demos and samples can be found in +/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/doc/systemtap*/examples, each example comes with either a .txt +or .meta file explaining what the example, sample or demo does and how +it is ordinarily run. +

+ 

SEE ALSO

-@prefix@/doc/systemtap*/examples +/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/doc/systemtap*/examples stap(1) -stapprobes(5) +stapprobes(3stap) -stapfuncs(5) +stapfuncs(3stap)

@@ -186,12 +207,13 @@ each inlined function instance is listed separately.

NAME
LANGUAGE BASICS
PROBING
-
SEE ALSO
+
MORE EXAMPLES
+
SEE ALSO

This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapfuncs.5.html b/man/stapfuncs.3stap.html similarity index 59% rename from man/stapfuncs.5.html rename to man/stapfuncs.3stap.html index 22da8858..6d12cc6e 100644 --- a/man/stapfuncs.5.html +++ b/man/stapfuncs.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPFUNCS

STAPFUNCS

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -14,7 +14,7 @@ stapfuncs - systemtap functions

DESCRIPTION

The following sections enumerate the public functions provided by -standard tapsets installed under @prefix@/share/systemtap/tapset. Each +standard tapsets installed under /home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/tapset. Each function is described with a signature, and its behavior/restrictions. The signature line includes the name of the function, the type of its return value (if any), and the names and types of all parameters. @@ -32,52 +32,9 @@ Return some integer. In function "example2", do something. There is no explicit return value and take no parameters.

-

-  -

LOGGING

- -

-

-
log:unknown (msg:string)
-Log the given string to the common trace buffer. Append an implicit -end-of-line. -

-

print:unknown (...)
-Print the given integer, string, or statistics value to -the common trace buffer. -

-

printf:unknown (fmt:string, ...)
-Like the C printf, except valid types are limited to string ("%s") -and integer ("%d"). -

-

warn:unknown (msg:string)
-Log the given string to the warning stream. Append an implicit end-of-line. -staprun - -prepends the string "WARNING:". -

-

error:unknown (msg:string)
-An error has occurred. Log the given string to the error stream. -Append an implicit end-of-line. -staprun - -prepends the string "ERROR:". -Block any further execution of statements in this probe. If the number -of errors so far exceeds the MAXERRORS parameter, also trigger an -exit(). - -

-

exit:unknown ()
-Enqueue a request to shut down the systemtap session. This does -not - -unwind the current probe handler, nor block new probe handlers. -staprun - -will shortly respond to the request and initiate an orderly shutdown.

-  + 

CONVERSIONS

@@ -110,8 +67,49 @@ fault, return instead the err_msg value.

user_string_warn:string (addr:long)
Copy a string from user space at given address. If the access would fault, signal a warning and return "<unknown>". +
user_string_quoted:string (addr:long)
+Copy a string from user space at given address. Any ASCII characters +that are not printable are replaced by the corresponding escape +sequence in the returned string. +
user_string_n:string (addr:long, n:long)
+Copy a string of n bytes from user space at given address. If the access +would fault, return "<unknown>". +
user_string_n2:string (addr:long, n:long, err_msg:string)
+Copy a string of n bytes from user space at given address. If the access +would fault, return the err_msg value. +
user_string_n_warn:string (addr:long, n:long)
+Copy a string of n bytes from user space at given address. If the access +would fault, signal a warning and return "<unknown>". +
user_string_n_quoted:string (addr:long, n:long)
+Copy a string of n bytes from user space at given address. Any ASCII +characters that are not printable are replaced by the corresponding escape +sequence in the returned string. If the access would fault, return "<unknown>". +
user_short:long (addr:long)
+Copy a short from user space at given address. If the access would fault, +return 0. +
user_short_warn:long (addr:long)
+Copy a short from user space at given address. If the access would fault, +signal a warning and return 0. +
user_int:long (addr:long)
+Copy an int from user space at given address. If the access would fault, +return 0. +
user_int_warn:long (addr:long)
+Copy an int from user space at given address. If the access would fault, +signal a warning and return 0. +
user_long:long (addr:long)
+Copy a long from user space at given address. If the access would fault, +return 0. +
user_long_warn:long (addr:long)
+Copy a long from user space at given address. If the access would fault, +signal a warning and return 0. +
user_char:long (addr:long)
+Copy a char from user space at given address. If the access would fault, +return 0. +
user_char_warn:long (addr:long)
+Copy a char from user space at given address. If the access would fault, +signal a warning and return 0. -  + 

STRING

@@ -119,6 +117,8 @@ fault, signal a warning and return "<unknown>". Return the number of characters in str.
substr:string (str:string,start:long, stop:long)
Return the substring of str starting from character start and ending at character stop. +
stringat:string (str:string,pos:long)
+Return the character in given position of string.
isinstr:long (s1:string, s2:string)
Return 1 if string s1 contains string s2, returns 0 otherwise.
strtol:long (str:string, base:long)
@@ -126,15 +126,15 @@ Convert the string representation of a number to a long using the numbering syst specified by base. For example, strtol("1000", 16) returns 4096. Returns 0 if the string cannot be converted.
tokenize:string (str:string, delim:string)
-Return the next token in the given str string, where the tokens are delimited -by one of the characters in the delim string. If the str string is non-NULL, -it returns the first token. If the str string is NULL, it returns the next +Return the next non-empty token in the given str string, where the tokens are +delimited by characters in the delim string. If the str string is not blank, +it returns the first token. If the str string is blank, it returns the next token in the string passed in the previous call to tokenize. If no delimiter -is found, the entire remaining str string is returned. Returns NULL when +is found, the entire remaining str string is returned. Returns blank when no more tokens are left.

-  + 

TIMESTAMP

@@ -150,7 +150,7 @@ Return the number of milliseconds since the UNIX epoch. Return the number of seconds since the UNIX epoch.

-  + 

CONTEXT INFO

@@ -166,6 +166,10 @@ Return the id of the current thread. Return the id of the current process.
ppid:long ()
Return the id of the parent process. +
pgrp:long ()
+Return the pgrp of the current process. +
sid:long ()
+Return the sid of the current process.
uid:long ()
Return the uid of the current process.
euid:long ()
@@ -201,11 +205,13 @@ Return the probe point's function name, if known. Return the probe point's module name, if known.
target:long ()
Return the pid of the target process. +
user_mode:long ()
+Return 1 if the probe point occurred in user-mode.
is_return:long ()
Return 1 if the probe point is a return probe. Deprecated.

-  + 

TARGET_SET

@@ -216,7 +222,7 @@ it is a descendent of the top-level target() process. Print a report about the target set, and their ancestry.

-  + 

ERRNO

@@ -225,7 +231,7 @@ Return the symbolic string associated with the given error code, like "ENOENT" for the number 2, or "E#3333" for an out-of-range value like 3333.

-  + 

TASK

@@ -287,8 +293,125 @@ Return the number of open file handles for the given task.

task_max_file_handles:long(task:long)
Return the maximum number of file handles for the given task.

+

pid2task:long(pid:long)
+Return the task of the given process id. +

+

pid2execname:string(pid:long)
+Return the name of the given process id. +

+ +  +

CPU REGISTERS

+ +
+
registers_valid:long ()
+Return 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. +
register:long (name:string)
+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 +for the same register.) +eax/ax, ebp/bp, ebx/bx, ecx/cx, edi/di, edx/dx, eflags/flags, +eip/ip, esi/si, esp/sp, orig_eax/orig_ax, +xcs/cs, xds/ds, xes/es, xfs/fs, xss/ss. +

+For the x86_64 architecture, the following names are recognized: +64-bit registers: +r8, r9, r10, r11, r12, r13, r14, r15, +rax/ax, rbp/bp, rbx/bx, rcx/cx, rdi/di, rdx/dx, +rip/ip, rsi/si, rsp/sp; +32-bit registers: +eax, ebp, ebx, ecx, edx, edi, edx, eip, esi, esp, flags/eflags, orig_eax; +segment registers: xcs/cs, xss/ss. +

+For powerpc, the following names are recognized: +r0, r1, ... r31, nip, msr, orig_gpr3, ctr, link, xer, ccr, softe, trap, +dar, dsisr, result. +

+For s390x, the following names are recognized: +r0, r1, ... r15, args, psw.mask, psw.addr, orig_gpr2, ilc, trap. +

+

u_register:long (name:string)
+Same as register(name), except that +if the register is 32 bits, it is zero-extended to 64 bits. +

  +

NUMBERED FUNCTION ARGUMENTS

+ +The functions in this section provide the values of a probed function's +arguments. +They can be called when you have hit +a probe point at the entry to a function. +Arguments are referred to by number, starting at 1. +Ordinarily, you can access arguments by name as well, +but you may find these functions useful if the code you are probing +was built without debugging information. +

+On 32-bit architectures +--- and when probing 32-bit applications on 64-bit architectures --- +a 64-bit argument occupies two "arg slots." +For example, if you are probing the following function +

+
   void f(int a, long long b, char *c) +

+you would refer to a, b, and c as int_arg(1), longlong_arg(2), and +pointer_arg(3), respectively, on a 64-bit architecture; +but on a 32-bit architecture, you would refer to c as pointer_arg(4) +(since b occupies slots 2 and 3). +

+If the function you are probing doesn't follow the default rules +for argument passing, you need to call one of the following functions +(which see) in your handler before calling any *_arg function: +asmlinkage(), fastcall(), or regparm(). +(This isn't necessary when referring to arguments only by name.) +

+
int_arg:long (n:long)
+Return the value of argument n as a signed int +(i.e., a 32-bit integer sign-extended to 64 bits). +
uint_arg:long (n:long)
+Return the value of argument n as an unsigned int +(i.e., a 32-bit integer zero-extended to 64 bits). +
long_arg:long (n:long)
+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. +
ulong_arg:long (n:long)
+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. +
longlong_arg:long (n:long)
+Return the value of argument n as a 64-bit value. +
ulonglong_arg:long (n:long)
+Same as longlong_arg(n). +
pointer_arg:long (n:long)
+Same as ulong_arg(n). +Use with any type of pointer. +
s32_arg:long (n:long)
+Same as int_arg(n). +
u32_arg:long (n:long)
+Same as uint_arg(n). +
s64_arg:long (n:long)
+Same as longlong_arg(n). +
u64_arg:long (n:long)
+Same as [u]longlong_arg(n). +
asmlinkage:unknown ()
+The probed kernel function is declared asmlinkage in the source. +
fastcall:unknown ()
+The probed kernel function is declared fastcall in the source. +
regparm:unknown (n:long)
+The probed function was built 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.) +

+For some architectures, the *_arg functions may reject unusually high +values of n. +

+

+ 

QUEUE_STATS

@@ -340,7 +463,7 @@ Return the average time a request took from being enqueued to completed. Return the average rate of requests per scale units of time.

-  + 

INDENT

@@ -361,7 +484,7 @@ The default function uses

-  + 

SYSTEM

@@ -370,7 +493,7 @@ Runs a command on the system. The command will run in the background when the current probe completes.

-  + 

NUMA

@@ -378,7 +501,7 @@ when the current probe completes. Return which node the given address belongs to in a NUMA system.

-  + 

CTIME

@@ -389,7 +512,7 @@ of the given number of seconds since the epoch, as perhaps returned by

-  + 

PERFMON

@@ -399,13 +522,13 @@ handle. The body of the a perfmon probe should set record the handle being used for that event.

-  + 

SOCKETS

These functions convert arguments in the socket tapset back and forth between their numeric and string representations. See -stapprobes.socket(5) +stapprobes.socket(3stap) for details.

@@ -432,7 +555,7 @@ Returns the string representation of the given socket flags value. Returns the string representation of the given message flags bit map.

-  + 

INET

These functions convert between network (big-endian) and host byte order, like their @@ -451,17 +574,51 @@ Convert from host to network byte order, 32-bit.
htons:long (x:long)
Convert from host to network byte order, 16-bit.

+ +  +

SIGNAL

+ +
+
get_sa_flags:long (act:long)
+Returns the numeric value of sa_flags. +
get_sa_handler:long (act:long)
+Returns the numeric value of sa_handler. +
sigset_mask_str:string (mask:long)
+Returns the string representation of the sigset sa_mask. +
is_sig_blocked:long (task:long, sig:long)
+Returns 1 if the signal is currently blocked, or 0 if it is not. +
sa_flags_str:string (sa_flags:long)
+Returns the string representation of sa_flags. +
sa_handler_str(handler)
+Returns the string representation of sa_handler. If it is not SIG_DFL, SIG_IGN +or SIG_ERR, it will return the address of the handler. +
signal_str(num)
+Returns the string representation of the given signal number. +

+

+  +

DEVICE

+ +
+
MAJOR:long(dev:long)
+Extracts the major device number from a kernel device number (kdev_t). +
MINOR:long(dev:long)
+Extracts the minor device number from a kernel device number (kdev_t). +
MKDEV:long(major:long, minor:long)
+Creates a value that can be compared to a kernel device number (kdev_t). +
usrdev2kerndev:long(dev:long)
+Converts a user-space device number into the format used in the kernel.

-  + 

FILES

-@prefix@/share/systemtap/tapset +/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/tapset

-  + 

SEE ALSO

stap(1) @@ -474,30 +631,33 @@ Convert from host to network byte order, 16-bit.
NAME
DESCRIPTION
-
LOGGING
-
CONVERSIONS
-
STRING
-
TIMESTAMP
-
CONTEXT INFO
-
TARGET_SET
-
ERRNO
-
TASK
-
QUEUE_STATS
-
INDENT
-
SYSTEM
-
NUMA
-
CTIME
-
PERFMON
-
SOCKETS
-
INET
+
CONVERSIONS
+
STRING
+
TIMESTAMP
+
CONTEXT INFO
+
TARGET_SET
+
ERRNO
+
TASK
+
CPU REGISTERS
+
NUMBERED FUNCTION ARGUMENTS
+
QUEUE_STATS
+
INDENT
+
SYSTEM
+
NUMA
+
CTIME
+
PERFMON
+
SOCKETS
+
INET
+
SIGNAL
+
DEVICE
-
FILES
-
SEE ALSO
+
FILES
+
SEE ALSO

This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.3stap.html b/man/stapprobes.3stap.html new file mode 100644 index 00000000..b5e7849d --- /dev/null +++ b/man/stapprobes.3stap.html @@ -0,0 +1,1065 @@ + +Manpage of STAPPROBES + +

STAPPROBES

+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
+ +  +

NAME

+ +stapprobes - systemtap probe points +

+ + + +

+  +

DESCRIPTION

+ +The following sections enumerate the variety of probe points supported +by the systemtap translator, and additional aliases defined by +standard tapset scripts. +

+ +The general probe point syntax is a dotted-symbol sequence. This +allows a breakdown of the event namespace into parts, somewhat like +the Domain Name System does on the Internet. Each component +identifier may be parametrized by a string or number literal, with a +syntax like a function call. A component may include a "*" character, +to expand to a set of matching probe points. Probe aliases likewise +expand to other probe points. Each and every resulting probe point is +normally resolved to some low-level system instrumentation facility +(e.g., a kprobe address, marker, or a timer configuration), otherwise +the elaboration phase will fail. +

+ +However, a probe point may be followed by a "?" character, to indicate +that it is optional, and that no error should result if it fails to +resolve. Optionalness passes down through all levels of +alias/wildcard expansion. Alternately, a probe point may be followed +by a "!" character, to indicate that it is both optional and +sufficient. (Think vaguely of the Prolog cut operator.) If it does +resolve, then no further probe points in the same comma-separated list +will be resolved. Therefore, the "!" sufficiency mark only makes +sense in a list of probe point alternatives. +

+ +Additionally, a probe point may be followed by a "if (expr)" statement, in +order to enable/disable the probe point on-the-fly. With the "if" statement, +if the "expr" is false when the probe point is hit, the whole probe body +including alias's body is skipped. The condition is stacked up through +all levels of alias/wildcard expansion. So the final condition becomes +the logical-and of conditions of all expanded alias/wildcard. +

+These are all +syntactically + +valid probe points. (They are generally +semantically + +invalid, depending on the contents of the tapsets, and the versions of +kernel/user software installed.) +

+ +
+ +

+
+kernel.function("foo").return
+process("/bin/vi").statement(0x2222)
+end
+syscall.*
+kernel.function("no_such_function") ?
+module("awol").function("no_such_function") !
+signal.*? if (switch)
+kprobe.function("foo")
+
+
+ +
+ + +

+

+Probes may be broadly classified into "synchronous" and +"asynchronous". A "synchronous" event is deemed to occur when any +processor executes an instruction matched by the specification. This +gives these probes a reference point (instruction address) from which +more contextual data may be available. Other families of probe points +refer to "asynchronous" events such as timers/counters rolling over, +where there is no fixed reference point that is related. Each probe +point specification may match multiple locations (for example, using +wildcards or aliases), and all them are then probed. A probe +declaration may also contain several comma-separated specifications, +all of which are probed. +

+  +

BEGIN/END/ERROR

+ +

+The probe points +begin and end + +are defined by the translator to refer to the time of session startup +and shutdown. All "begin" probe handlers are run, in some sequence, +during the startup of the session. All global variables will have +been initialized prior to this point. All "end" probes are run, in +some sequence, during the +normal + +shutdown of a session, such as in the aftermath of an +exit () + +function call, or an interruption from the user. In the case of an +error-triggered shutdown, "end" probes are not run. There are no +target variables available in either context. +

+ +If the order of execution among "begin" or "end" probes is significant, +then an optional sequence number may be provided: +

+ +
+ +

+
+begin(N)
+end(N)
+
+
+ +
+ + +

+The number N may be positive or negative. The probe handlers are run in +increasing order, and the order between handlers with the same sequence +number is unspecified. When "begin" or "end" are given without a +sequence, they are effectively sequence zero. +

+The +error + +probe point is similar to the +end + +probe, except that each such probe handler run when the session ends +after errors have occurred. In such cases, "end" probes are skipped, +but each "error" probe is still attempted. This kind of probe can be +used to clean up or emit a "final gasp". It may also be numerically +parametrized to set a sequence. +

+  +

NEVER

+ +The probe point +never + +is specially defined by the translator to mean "never". Its probe +handler is never run, though its statements are analyzed for symbol / +type correctness as usual. This probe point may be useful in +conjunction with optional probes. +

+  +

SYSCALL

+ +

+The +syscall.* + +aliases define several hundred probes, too many to +summarize here. They are: +

+ +
+ +

+
+syscall.NAME
+
+syscall.NAME.return + +
+ +
+ + +

+Generally, two probes are defined for each normal system call as listed in the +syscalls(2) + +manual page, one for entry and one for return. Those system calls that never +return do not have a corresponding +.return + +probe. +

+ +Each probe alias defines a variety of variables. Looking at the tapset source +code is the most reliable way. Generally, each variable listed in the standard +manual page is made available as a script-level variable, so +syscall.open + +exposes +filename, flags, and mode. + +In addition, a standard suite of variables is available at most aliases: +

+
argstr + +
+A pretty-printed form of the entire argument list, without parentheses. +
name + +
+The name of the system call. +
retstr + +
+For return probes, a pretty-printed form of the system-call result. +
+

+ +Not all probe aliases obey all of these general guidelines. Please report +any bothersome ones you encounter as a bug. +

+

+  +

TIMERS

+ +

+Intervals defined by the standard kernel "jiffies" timer may be used +to trigger probe handlers asynchronously. Two probe point variants +are supported by the translator: +

+ +
+ +

+
+timer.jiffies(N)
+timer.jiffies(N).randomize(M)
+
+
+ +
+ + +

+The probe handler is run every N jiffies (a kernel-defined unit of +time, typically between 1 and 60 ms). If the "randomize" component is +given, a linearly distributed random value in the range [-M..+M] is +added to N every time the handler is run. N is restricted to a +reasonable range (1 to around a million), and M is restricted to be +smaller than N. There are no target variables provided in either +context. It is possible for such probes to be run concurrently on +a multi-processor computer. +

+ +Alternatively, intervals may be specified in units of time. +There are two probe point variants similar to the jiffies timer: +

+ +
+ +

+
+timer.ms(N)
+timer.ms(N).randomize(M)
+
+
+ +
+ + +

+Here, N and M are specified in milliseconds, but the full options for units +are seconds (s/sec), milliseconds (ms/msec), microseconds (us/usec), +nanoseconds (ns/nsec), and hertz (hz). Randomization is not supported for +hertz timers. +

+The actual resolution of the timers depends on the target kernel. For +kernels prior to 2.6.17, timers are limited to jiffies resolution, so +intervals are rounded up to the nearest jiffies interval. After 2.6.17, +the implementation uses hrtimers for tighter precision, though the actual +resolution will be arch-dependent. In either case, if the "randomize" +component is given, then the random value will be added to the interval +before any rounding occurs. +

+ +Profiling timers are also available to provide probes that execute on all +CPUs at the rate of the system tick (CONFIG_HZ). +This probe takes no parameters. +

+ +
+ +

+
+timer.profile
+
+
+ +
+ + +

+Full context information of the interrupted process is available, making +this probe suitable for a time-based sampling profiler. +

+  +

DWARF

+ +

+This family of probe points uses symbolic debugging information for +the target kernel/module/program, as may be found in unstripped +executables, or the separate +debuginfo + +packages. They allow placement of probes logically into the execution +path of the target program, by specifying a set of points in the +source or object code. When a matching statement executes on any +processor, the probe handler is run in that context. +

+ +Points in a kernel, which are identified by +module, source file, line number, function name, or some +combination of these. +

+ +Here is a list of probe point families currently supported. The +.function + +variant places a probe near the beginning of the named function, so that +parameters are available as context variables. The +.return + +variant places a probe at the moment +after + +the return from the named function, so the return value is available +as the "$return" context variable. The +.inline + +modifier for +.function + +filters the results to include only instances of inlined functions. +The +.call + +modifier selects the opposite subset. Inline functions do not have an +identifiable return point, so +.return + +is not supported on +.inline + +probes. The +.statement + +variant places a probe at the exact spot, exposing those local variables +that are visible there. +

+ +
+ +

+
+kernel.function(PATTERN)
+
+kernel.function(PATTERN).call +
+kernel.function(PATTERN).return +
+kernel.function(PATTERN).inline +
+kernel.function(PATTERN).label(LPATTERN) +
+module(MPATTERN).function(PATTERN) +
+module(MPATTERN).function(PATTERN).call +
+module(MPATTERN).function(PATTERN).return +
+module(MPATTERN).function(PATTERN).inline +
+
+kernel.statement(PATTERN) +
+kernel.statement(ADDRESS).absolute +
+module(MPATTERN).statement(PATTERN) + +
+ +
+ + +

+In the above list, MPATTERN stands for a string literal that aims to +identify the loaded kernel module of interest and LPATTERN stands for +a source program label. Both MPATTERN and LPATTERN may include the "*" +"[]", and "?" wildcards. +PATTERN stands for a string literal that +aims to identify a point in the program. It is made up of three +parts: +

+
*
+The first part is the name of a function, as would appear in the +nm + +program's output. This part may use the "*" and "?" wildcarding +operators to match multiple names. +
*
+The second part is optional and begins with the "@" character. +It is followed by the path to the source file containing the function, +which may include a wildcard pattern, such as mm/slab*. +If it does not match as is, an implicit "*/" is optionally added +before + +the pattern, so that a script need only name the last few components +of a possibly long source directory path. +
*
+Finally, the third part is optional if the file name part was given, +and identifies the line number in the source file preceded by a ":" +or a "+". The line number is assumed to be an +absolute line number if preceded by a ":", or relative to the entry of +the function if preceded by a "+". +All the lines in the function can be matched with ":*". +A range of lines x through y can be matched with ":x-y". +
+

+ +As an alternative, PATTERN may be a numeric constant, indicating an +address. Such an address may be found from symbol tables of the +appropriate kernel / module object file. It is verified against +known statement code boundaries, and will be relocated for use at +run time. +

+ +In guru mode only, absolute kernel-space addresses may be specified with +the ".absolute" suffix. Such an address is considered already relocated, +as if it came from +/proc/kallsyms, + +so it cannot be checked against statement/instruction boundaries. +

+ +Some of the source-level context variables, such as function parameters, +locals, globals visible in the compilation unit, may be visible to +probe handlers. They may refer to these variables by prefixing their +name with "$" within the scripts. In addition, a special syntax +allows limited traversal of structures, pointers, and arrays. +

+
$var
+refers to an in-scope variable "var". If it's an integer-like type, +it will be cast to a 64-bit int for systemtap script use. String-like +pointers (char *) may be copied to systemtap string values using the +kernel_string or user_string + +functions. +
$var->field
+traversal to a structure's field. The indirection operator +may be repeated to follow more levels of pointers. +
$return
+is available in return probes only for functions that are declared +with a return value. +
$var[N]
+
+indexes into an array. The index is given with a +literal number. +
$$vars
+expands to a character string that is equivalent to +sprintf("parm1=%x ... parmN=%x var1=%x ... varN=%x", parm1, ..., parmN, +var1, ..., varN) +
$$locals
+expands to a subset of $$vars for only local variables. +
$$parms
+expands to a subset of $$vars for only function parameters. +
$$return
+is available in return probes only. It expands to a string that +is equivalent to sprintf("return=%x", $return) +if the probed function has a return value, or else an empty string. +
+

+ +For ".return" probes, context variables other than the "$return" +value itself are only available for the function call parameters. +The expressions evaluate to the +entry-time + +values of those variables, since that is when a snapshot is taken. +Other local variables are not generally accessible, since by the time +a ".return" probe hits, the probed function will have already returned. +

+

+  +

DWARFLESS

+ +In absence of debugging information, entry & exit points of kernel & module +functions can be probed using the "kprobe" family of probes. +However, these do not permit looking up the arguments / local variables +of the function. +Following constructs are supported : + +
+ +
+
+kprobe.function(FUNCTION)
+kprobe.function(FUNCTION).return
+kprobe.module(NAME).function(FUNCTION)
+kprobe.module(NAME).function(FUNCTION).return
+kprobe.statement.(ADDRESS).absolute
+
+
+ +
+ + +

+ +Probes of type +function + +are recommended for kernel functions, whereas probes of type +module + +are recommended for probing functions of the specified module. +In case the absolute address of a kernel or module function is known, +statement + +probes can be utilized. +

+ +Note that +FUNCTION + +and +MODULE + +names +must not + +contain wildcards, or the probe will not be registered. +Also, statement probes must be run under guru-mode only. +

+

+  +

USER-SPACE

+ +Support for user-space probing is available for kernels +that are configured with the utrace extensions. See + +
+ +
+
+http://people.redhat.com/roland/utrace/
+
+
+ +
+ + +

+ +There are several forms. First, a non-symbolic probe point: + +
+ +

+
+process(PID).statement(ADDRESS).absolute
+
+
+ +
+ + +is analogous to +kernel.statement(ADDRESS).absolute + +in that both use raw (unverified) virtual addresses and provide +no $variables. The target PID parameter must identify a running +process, and ADDRESS should identify a valid instruction address. +All threads of that process will be probed. +

+ +Second, non-symbolic user-kernel interface events handled by +utrace may be probed: + +
+ +

+
+process(PID).begin
+process("PATH").begin
+process.begin
+process(PID).thread.begin
+process("PATH").thread.begin
+process.thread.begin
+process(PID).end
+process("PATH").end
+process.end
+process(PID).thread.end
+process("PATH").thread.end
+process.thread.end
+process(PID).syscall
+process("PATH").syscall
+process.syscall
+process(PID).syscall.return
+process("PATH").syscall.return
+process.syscall.return
+process(PID).insn
+process("PATH").insn
+process(PID).insn.block
+process("PATH").insn.block
+
+
+ +
+ + +

+ +A +.begin + +probe gets called when new process described by PID or PATH gets created. +A +.thread.begin + +probe gets called when a new thread described by PID or PATH gets created. +A +.end + +probe gets called when process described by PID or PATH dies. +A +.thread.end + +probe gets called when a thread described by PID or PATH dies. +A +.syscall + +probe gets called when a thread described by PID or PATH makes a +system call. The system call number is available in the +$syscall + +context variable, and the first 6 arguments of the system call +are available in the +$argN + +(ex. $arg1, $arg2, ...) context variable. +A +.syscall.return + +probe gets called when a thread described by PID or PATH returns from a +system call. The system call number is available in the +$syscall + +context variable, and the return value of the system call is available +in the +$return + +context variable. +A +.insn + +probe gets called for every single-stepped instruction of the process described by PID or PATH. +A +.insn.block + +probe gets called for every block-stepped instruction of the process described by PID or PATH. +

+

+ +Third, symbolic static instrumentation compiled into programs and +shared libraries may be +probed: + +
+ +

+
+process("PATH").mark("LABEL")
+
+
+ +
+ + +

+ +A +.mark + +probe gets called via a static probe which is defined in the +application by +STAP_PROBE1(handle,LABEL,arg1), which is defined in sdt.h. The handle is an application handle, +LABEL corresponds to the .mark argument, and arg1 is the argument. +STAP_PROBE1 is used for probes with 1 argument, STAP_PROBE2 is used +for probes with 2 arguments, and so on. +The arguments of the probe are available in the context variables +$arg1, $arg2, ... An alternative to using the STAP_PROBE macros is to +use the dtrace script to create custom macros. +

+

+ +Finally, full symbolic source-level probes in user-space programs +and shared libraries are supported. These are exactly analogous +to the symbolic DWARF-based kernel/module probes described above, +and expose similar contextual $-variables. + +
+ +

+
+process("PATH").function("NAME")
+process("PATH").statement("*@FILE.c:123")
+process("PATH").function("*").return
+process("PATH").function("myfun").label("foo")
+
+
+ +
+ + +

+

+ +Note that for all process probes, +PATH + +names refer to executables that are searched the same way shells do: relative +to the working directory if they contain a "/" character, otherwise in +$PATH. + +If a process probe is specified without a PID or PATH, all user +threads are probed. PATH may sometimes name a shared library +in which case all processes that map that shared library may be +probed. However, if systemtap was invoked with the +-c or -x + +options, then process probes are restricted to the process +hierarchy associated with the target process. +

+  +

PROCFS

+ +

+These probe points allow procfs "files" in +/proc/systemtap/MODNAME to be created, read and written +(MODNAME + +is the name of the systemtap module). The +proc + +filesystem is a pseudo-filesystem which is used an an interface to +kernel data structures. There are four probe point variants supported +by the translator: +

+ +
+ +

+
+procfs("PATH").read
+procfs("PATH").write
+procfs.read
+procfs.write
+
+
+ +
+ + +

+PATH + +is the file name (relative to /proc/systemtap/MODNAME) to be created. +If no +PATH + +is specified (as in the last two variants above), +PATH + +defaults to "command". +

+ +When a user reads /proc/systemtap/MODNAME/PATH, the corresponding +procfs +read + +probe is triggered. The string data to be read should be assigned to +a variable named +$value, + +like this: +

+ +
+ +

+
+procfs("PATH").read { $value = "100\n" }
+
+
+ +
+ + +

+ +When a user writes into /proc/systemtap/MODNAME/PATH, the +corresponding procfs +write + +probe is triggered. The data the user wrote is available in the +string variable named +$value, + +like this: +

+ +
+ +

+
+procfs("PATH").write { printf("user wrote: %s", $value) }
+
+
+ +
+ + +

+  +

MARKERS

+ +

+This family of probe points hooks up to static probing markers +inserted into the kernel or modules. These markers are special macro +calls inserted by kernel developers to make probing faster and more +reliable than with DWARF-based probes. Further, DWARF debugging +information is +not + +required to probe markers. +

+Marker probe points begin with +kernel. + +The next part names the marker itself: +mark(name). + +The marker name string, which may contain the usual wildcard characters, +is matched against the names given to the marker macros when the kernel +and/or module was compiled. Optionally, you can specify +format(format). + +Specifying the marker format string allows differentiation between two +markers with the same name but different marker format strings. +

+The handler associated with a marker-based probe may read the +optional parameters specified at the macro call site. These are +named +$arg1 through $argNN, + +where NN is the number of parameters supplied by the macro. Number +and string parameters are passed in a type-safe manner. +

+The marker format string associated with a marker is available in +$format. + +And also the marker name string is available in +$name. + +

+  +

TRACEPOINTS

+ +

+This family of probe points hooks up to static probing tracepoints +inserted into the kernel or modules. As with markers, these +tracepoints are special macro calls inserted by kernel developers to +make probing faster and more reliable than with DWARF-based probes, +and DWARF debugging information is not required to probe tracepoints. +Tracepoints have an extra advantage of more strongly-typed parameters +than markers. +

+Tracepoint probes begin with +kernel. + +The next part names the tracepoint itself: +trace(name). + +The tracepoint name string, which may contain the usual wildcard +characters, is matched against the names defined by the kernel +developers in the tracepoint header files. +

+The handler associated with a tracepoint-based probe may read the +optional parameters specified at the macro call site. These are +named according to the declaration by the tracepoint author. For +example, the tracepoint probe +kernel.trace(sched_switch) + +provides the parameters +$rq, $prev, and $next. + +If the parameter is a complex type, as in a struct pointer, then a +script can access fields with the same syntax as DWARF $target +variables. Also, tracepoint parameters cannot be modified, but in +guru-mode a script may modify fields of parameters. +

+The name of the tracepoint is available in +$$name, + +and a string of name=value pairs for all parameters of the tracepoint +is available in +$$vars or $$parms. + +

+  +

PERFORMANCE MONITORING HARDWARE

+ +

+The perfmon family of probe points is used to access the performance +monitoring hardware available in modern processors. This family of +probes points needs the perfmon2 support in the kernel to access the +performance monitoring hardware. +

+ +Performance monitor hardware points begin with a +perfmon. + +The next part of the names the event being counted +counter(event). + +The event names are processor implementation specific with the +exception of the generic +cycles and instructions + +events, which are available on all processors. This sets up a counter +on the processor to count the number of events occurring on the +processor. For more details on the performance monitoring events +available on a specific processor use the command perfmon2 command: +

+ +
+ +

+
+pfmon -l
+
+
+ +
+ + +
+
$counter
+is a handle used in the body of the probe for operations +involving the counter associated with the probe. +
read_counter
+is a function that is passed the handle for the perfmon probe and returns +the current count for the event. +

+

+  +

EXAMPLES

+ +

+ +Here are some example probe points, defining the associated events. +

+
begin, end, end
+refers to the startup and normal shutdown of the session. In this +case, the handler would run once during startup and twice during +shutdown. +
timer.jiffies(1000).randomize(200)
+refers to a periodic interrupt, every 1000 +/- 200 jiffies. +
kernel.function("*init*"), kernel.function("*exit*")
+refers to all kernel functions with "init" or "exit" in the name. +
kernel.function("*@kernel/sched.c:240")
+refers to any functions within the "kernel/sched.c" file that span +line 240. +
kernel.mark("getuid")
+refers to an STAP_MARK(getuid, ...) macro call in the kernel. +
module("usb*").function("*sync*").return
+refers to the moment of return from all functions with "sync" in the +name in any of the USB drivers. +
kernel.statement(0xc0044852)
+refers to the first byte of the statement whose compiled instructions +include the given address in the kernel. +
kernel.statement("*@kernel/sched.c:2917")
+refers to the statement of line 2917 within "kernel/sched.c". +
kernel.statement("bio_init@fs/bio.c+3")
+refers to the statement at line bio_init+3 within "fs/bio.c". +
syscall.*.return
+refers to the group of probe aliases with any name in the third position +

+

+  +

SEE ALSO

+ +stap(1), + +stapprobes.iosched(3stap), + +stapprobes.netdev(3stap), + +stapprobes.nfs(3stap), + +stapprobes.nfsd(3stap), + +stapprobes.pagefault(3stap), + +stapprobes.process(3stap), + +stapprobes.rpc(3stap), + +stapprobes.scsi(3stap), + +stapprobes.signal(3stap), + +stapprobes.socket(3stap), + +stapprobes.tcp(3stap), + +stapprobes.udp(3stap), + +proc(3stap) + +

+ +


+ 

Index

+
+
NAME
+
DESCRIPTION
+
+
BEGIN/END/ERROR
+
NEVER
+
SYSCALL
+
TIMERS
+
DWARF
+
DWARFLESS
+
USER-SPACE
+
PROCFS
+
MARKERS
+
TRACEPOINTS
+
PERFORMANCE MONITORING HARDWARE
+
+
EXAMPLES
+
SEE ALSO
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stapprobes.3stap~.html b/man/stapprobes.3stap~.html new file mode 100644 index 00000000..8b9792e6 --- /dev/null +++ b/man/stapprobes.3stap~.html @@ -0,0 +1,1065 @@ + +Manpage of STAPPROBES + +

STAPPROBES

+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
+ +  +

NAME

+ +stapprobes - systemtap probe points +

+ + + +

+  +

DESCRIPTION

+ +The following sections enumerate the variety of probe points supported +by the systemtap translator, and additional aliases defined by +standard tapset scripts. +

+ +The general probe point syntax is a dotted-symbol sequence. This +allows a breakdown of the event namespace into parts, somewhat like +the Domain Name System does on the Internet. Each component +identifier may be parametrized by a string or number literal, with a +syntax like a function call. A component may include a "*" character, +to expand to a set of matching probe points. Probe aliases likewise +expand to other probe points. Each and every resulting probe point is +normally resolved to some low-level system instrumentation facility +(e.g., a kprobe address, marker, or a timer configuration), otherwise +the elaboration phase will fail. +

+ +However, a probe point may be followed by a "?" character, to indicate +that it is optional, and that no error should result if it fails to +resolve. Optionalness passes down through all levels of +alias/wildcard expansion. Alternately, a probe point may be followed +by a "!" character, to indicate that it is both optional and +sufficient. (Think vaguely of the Prolog cut operator.) If it does +resolve, then no further probe points in the same comma-separated list +will be resolved. Therefore, the "!" sufficiency mark only makes +sense in a list of probe point alternatives. +

+ +Additionally, a probe point may be followed by a "if (expr)" statement, in +order to enable/disable the probe point on-the-fly. With the "if" statement, +if the "expr" is false when the probe point is hit, the whole probe body +including alias's body is skipped. The condition is stacked up through +all levels of alias/wildcard expansion. So the final condition becomes +the logical-and of conditions of all expanded alias/wildcard. +

+These are all +syntactically + +valid probe points. (They are generally +semantically + +invalid, depending on the contents of the tapsets, and the versions of +kernel/user software installed.) +

+ +
+ +

+
+kernel.function("foo").return
+process("/bin/vi").statement(0x2222)
+end
+syscall.*
+kernel.function("no_such_function") ?
+module("awol").function("no_such_function") !
+signal.*? if (switch)
+kprobe.function("foo")
+
+
+ +
+ + +

+

+Probes may be broadly classified into "synchronous" and +"asynchronous". A "synchronous" event is deemed to occur when any +processor executes an instruction matched by the specification. This +gives these probes a reference point (instruction address) from which +more contextual data may be available. Other families of probe points +refer to "asynchronous" events such as timers/counters rolling over, +where there is no fixed reference point that is related. Each probe +point specification may match multiple locations (for example, using +wildcards or aliases), and all them are then probed. A probe +declaration may also contain several comma-separated specifications, +all of which are probed. +

+  +

BEGIN/END/ERROR

+ +

+The probe points +begin and end + +are defined by the translator to refer to the time of session startup +and shutdown. All "begin" probe handlers are run, in some sequence, +during the startup of the session. All global variables will have +been initialized prior to this point. All "end" probes are run, in +some sequence, during the +normal + +shutdown of a session, such as in the aftermath of an +exit () + +function call, or an interruption from the user. In the case of an +error-triggered shutdown, "end" probes are not run. There are no +target variables available in either context. +

+ +If the order of execution among "begin" or "end" probes is significant, +then an optional sequence number may be provided: +

+ +
+ +

+
+begin(N)
+end(N)
+
+
+ +
+ + +

+The number N may be positive or negative. The probe handlers are run in +increasing order, and the order between handlers with the same sequence +number is unspecified. When "begin" or "end" are given without a +sequence, they are effectively sequence zero. +

+The +error + +probe point is similar to the +end + +probe, except that each such probe handler run when the session ends +after errors have occurred. In such cases, "end" probes are skipped, +but each "error" probe is still attempted. This kind of probe can be +used to clean up or emit a "final gasp". It may also be numerically +parametrized to set a sequence. +

+  +

NEVER

+ +The probe point +never + +is specially defined by the translator to mean "never". Its probe +handler is never run, though its statements are analyzed for symbol / +type correctness as usual. This probe point may be useful in +conjunction with optional probes. +

+  +

SYSCALL

+ +

+The +syscall.* + +aliases define several hundred probes, too many to +summarize here. They are: +

+ +
+ +

+
+syscall.NAME
+
+syscall.NAME.return + +
+ +
+ + +

+Generally, two probes are defined for each normal system call as listed in the +syscalls(2) + +manual page, one for entry and one for return. Those system calls that never +return do not have a corresponding +.return + +probe. +

+ +Each probe alias defines a variety of variables. Looking at the tapset source +code is the most reliable way. Generally, each variable listed in the standard +manual page is made available as a script-level variable, so +syscall.open + +exposes +filename, flags, and mode. + +In addition, a standard suite of variables is available at most aliases: +

+
argstr + +
+A pretty-printed form of the entire argument list, without parentheses. +
name + +
+The name of the system call. +
retstr + +
+For return probes, a pretty-printed form of the system-call result. +
+

+ +Not all probe aliases obey all of these general guidelines. Please report +any bothersome ones you encounter as a bug. +

+

+  +

TIMERS

+ +

+Intervals defined by the standard kernel "jiffies" timer may be used +to trigger probe handlers asynchronously. Two probe point variants +are supported by the translator: +

+ +
+ +

+
+timer.jiffies(N)
+timer.jiffies(N).randomize(M)
+
+
+ +
+ + +

+The probe handler is run every N jiffies (a kernel-defined unit of +time, typically between 1 and 60 ms). If the "randomize" component is +given, a linearly distributed random value in the range [-M..+M] is +added to N every time the handler is run. N is restricted to a +reasonable range (1 to around a million), and M is restricted to be +smaller than N. There are no target variables provided in either +context. It is possible for such probes to be run concurrently on +a multi-processor computer. +

+ +Alternatively, intervals may be specified in units of time. +There are two probe point variants similar to the jiffies timer: +

+ +
+ +

+
+timer.ms(N)
+timer.ms(N).randomize(M)
+
+
+ +
+ + +

+Here, N and M are specified in milliseconds, but the full options for units +are seconds (s/sec), milliseconds (ms/msec), microseconds (us/usec), +nanoseconds (ns/nsec), and hertz (hz). Randomization is not supported for +hertz timers. +

+The actual resolution of the timers depends on the target kernel. For +kernels prior to 2.6.17, timers are limited to jiffies resolution, so +intervals are rounded up to the nearest jiffies interval. After 2.6.17, +the implementation uses hrtimers for tighter precision, though the actual +resolution will be arch-dependent. In either case, if the "randomize" +component is given, then the random value will be added to the interval +before any rounding occurs. +

+ +Profiling timers are also available to provide probes that execute on all +CPUs at the rate of the system tick (CONFIG_HZ). +This probe takes no parameters. +

+ +
+ +

+
+timer.profile
+
+
+ +
+ + +

+Full context information of the interrupted process is available, making +this probe suitable for a time-based sampling profiler. +

+  +

DWARF

+ +

+This family of probe points uses symbolic debugging information for +the target kernel/module/program, as may be found in unstripped +executables, or the separate +debuginfo + +packages. They allow placement of probes logically into the execution +path of the target program, by specifying a set of points in the +source or object code. When a matching statement executes on any +processor, the probe handler is run in that context. +

+ +Points in a kernel, which are identified by +module, source file, line number, function name, or some +combination of these. +

+ +Here is a list of probe point families currently supported. The +.function + +variant places a probe near the beginning of the named function, so that +parameters are available as context variables. The +.return + +variant places a probe at the moment +after + +the return from the named function, so the return value is available +as the "$return" context variable. The +.inline + +modifier for +.function + +filters the results to include only instances of inlined functions. +The +.call + +modifier selects the opposite subset. Inline functions do not have an +identifiable return point, so +.return + +is not supported on +.inline + +probes. The +.statement + +variant places a probe at the exact spot, exposing those local variables +that are visible there. +

+ +
+ +

+
+kernel.function(PATTERN)
+
+kernel.function(PATTERN).call +
+kernel.function(PATTERN).return +
+kernel.function(PATTERN).inline +
+kernel.function(PATTERN).label(LPATTERN) +
+module(MPATTERN).function(PATTERN) +
+module(MPATTERN).function(PATTERN).call +
+module(MPATTERN).function(PATTERN).return +
+module(MPATTERN).function(PATTERN).inline +
+
+kernel.statement(PATTERN) +
+kernel.statement(ADDRESS).absolute +
+module(MPATTERN).statement(PATTERN) + +
+ +
+ + +

+In the above list, MPATTERN stands for a string literal that aims to +identify the loaded kernel module of interest and LPATTERN stands for +a source program label. Both MPATTERN and LPATTERN may include the "*" +"[]", and "?" wildcards. +PATTERN stands for a string literal that +aims to identify a point in the program. It is made up of three +parts: +

+
*
+The first part is the name of a function, as would appear in the +nm + +program's output. This part may use the "*" and "?" wildcarding +operators to match multiple names. +
*
+The second part is optional and begins with the "@" character. +It is followed by the path to the source file containing the function, +which may include a wildcard pattern, such as mm/slab*. +If it does not match as is, an implicit "*/" is optionally added +before + +the pattern, so that a script need only name the last few components +of a possibly long source directory path. +
*
+Finally, the third part is optional if the file name part was given, +and identifies the line number in the source file preceded by a ":" +or a "+". The line number is assumed to be an +absolute line number if preceded by a ":", or relative to the entry of +the function if preceded by a "+". +All the lines in the function can be matched with ":*". +A range of lines x through y can be matched with ":x-y". +
+

+ +As an alternative, PATTERN may be a numeric constant, indicating an +address. Such an address may be found from symbol tables of the +appropriate kernel / module object file. It is verified against +known statement code boundaries, and will be relocated for use at +run time. +

+ +In guru mode only, absolute kernel-space addresses may be specified with +the ".absolute" suffix. Such an address is considered already relocated, +as if it came from +/proc/kallsyms, + +so it cannot be checked against statement/instruction boundaries. +

+ +Some of the source-level context variables, such as function parameters, +locals, globals visible in the compilation unit, may be visible to +probe handlers. They may refer to these variables by prefixing their +name with "$" within the scripts. In addition, a special syntax +allows limited traversal of structures, pointers, and arrays. +

+
$var
+refers to an in-scope variable "var". If it's an integer-like type, +it will be cast to a 64-bit int for systemtap script use. String-like +pointers (char *) may be copied to systemtap string values using the +kernel_string or user_string + +functions. +
$var->field
+traversal to a structure's field. The indirection operator +may be repeated to follow more levels of pointers. +
$return
+is available in return probes only for functions that are declared +with a return value. +
$var[N]
+
+indexes into an array. The index is given with a +literal number. +
$$vars
+expands to a character string that is equivalent to +sprintf("parm1=%x ... parmN=%x var1=%x ... varN=%x", parm1, ..., parmN, +var1, ..., varN) +
$$locals
+expands to a subset of $$vars for only local variables. +
$$parms
+expands to a subset of $$vars for only function parameters. +
$$return
+is available in return probes only. It expands to a string that +is equivalent to sprintf("return=%x", $return) +if the probed function has a return value, or else an empty string. +
+

+ +For ".return" probes, context variables other than the "$return" +value itself are only available for the function call parameters. +The expressions evaluate to the +entry-time + +values of those variables, since that is when a snapshot is taken. +Other local variables are not generally accessible, since by the time +a ".return" probe hits, the probed function will have already returned. +

+

+  +

DWARFLESS

+ +In absence of debugging information, entry & exit points of kernel & module +functions can be probed using the "kprobe" family of probes. +However, these do not permit looking up the arguments / local variables +of the function. +Following constructs are supported : + +
+ +
+
+kprobe.function(FUNCTION)
+kprobe.function(FUNCTION).return
+kprobe.module(NAME).function(FUNCTION)
+kprobe.module(NAME).function(FUNCTION).return
+kprobe.statement.(ADDRESS).absolute
+
+
+ +
+ + +

+ +Probes of type +function + +are recommended for kernel functions, whereas probes of type +module + +are recommended for probing functions of the specified module. +In case the absolute address of a kernel or module function is known, +statement + +probes can be utilized. +

+ +Note that +FUNCTION + +and +MODULE + +names +must not + +contain wildcards, or the probe will not be registered. +Also, statement probes must be run under guru-mode only. +

+

+  +

USER-SPACE

+ +Support for user-space probing is available for kernels +that are configured with the utrace extensions. See + +
+ +
+
+http://people.redhat.com/roland/utrace/
+
+
+ +
+ + +

+ +There are several forms. First, a non-symbolic probe point: + +
+ +

+
+process(PID).statement(ADDRESS).absolute
+
+
+ +
+ + +is analogous to +kernel.statement(ADDRESS).absolute + +in that both use raw (unverified) virtual addresses and provide +no $variables. The target PID parameter must identify a running +process, and ADDRESS should identify a valid instruction address. +All threads of that process will be probed. +

+ +Second, non-symbolic user-kernel interface events handled by +utrace may be probed: + +
+ +

+
+process(PID).begin
+process("PATH").begin
+process.begin
+process(PID).thread.begin
+process("PATH").thread.begin
+process.thread.begin
+process(PID).end
+process("PATH").end
+process.end
+process(PID).thread.end
+process("PATH").thread.end
+process.thread.end
+process(PID).syscall
+process("PATH").syscall
+process.syscall
+process(PID).syscall.return
+process("PATH").syscall.return
+process.syscall.return
+process(PID).insn
+process("PATH").insn
+process(PID).insn.block
+process("PATH").insn.block
+
+
+ +
+ + +

+ +A +.begin + +probe gets called when new process described by PID or PATH gets created. +A +.thread.begin + +probe gets called when a new thread described by PID or PATH gets created. +A +.end + +probe gets called when process described by PID or PATH dies. +A +.thread.end + +probe gets called when a thread described by PID or PATH dies. +A +.syscall + +probe gets called when a thread described by PID or PATH makes a +system call. The system call number is available in the +$syscall + +context variable, and the first 6 arguments of the system call +are available in the +$argN + +(ex. $arg1, $arg2, ...) context variable. +A +.syscall.return + +probe gets called when a thread described by PID or PATH returns from a +system call. The system call number is available in the +$syscall + +context variable, and the return value of the system call is available +in the +$return + +context variable. +A +.insn + +probe gets called for every single-stepped instruction of the process described by PID or PATH. +A +.insn.block + +probe gets called for every block-stepped instruction of the process described by PID or PATH. +

+

+ +Third, symbolic static instrumentation compiled into programs and +shared libraries may be +probed: + +
+ +

+
+process("PATH").mark("LABEL")
+
+
+ +
+ + +

+ +A +.mark + +probe gets called via a static probe which is defined in the +application by +STAP_PROBE1(handle,LABEL,arg1), which is defined in sdt.h. The handle is an application handle, +LABEL corresponds to the .mark argument, and arg1 is the argument. +STAP_PROBE1 is used for probes with 1 argument, STAP_PROBE2 is used +for probes with 2 arguments, and so on. +The arguments of the probe are available in the context variables +$arg1, $arg2, ... An alternative to using the STAP_PROBE macros is to +use the dtrace script to create custom macros. +

+

+ +Finally, full symbolic source-level probes in user-space programs +and shared libraries are supported. These are exactly analogous +to the symbolic DWARF-based kernel/module probes described above, +and expose similar contextual $-variables. + +
+ +

+
+process("PATH").function("NAME")
+process("PATH").statement("*@FILE.c:123")
+process("PATH").function("*").return
+process("PATH").function("myfun").label("foo")
+
+
+ +
+ + +

+

+ +Note that for all process probes, +PATH + +names refer to executables that are searched the same way shells do: relative +to the working directory if they contain a "/" character, otherwise in +$PATH. + +If a process probe is specified without a PID or PATH, all user +threads are probed. PATH may sometimes name a shared library +in which case all processes that map that shared library may be +probed. However, if systemtap was invoked with the +-c or -x + +options, then process probes are restricted to the process +hierarchy associated with the target process. +

+  +

PROCFS

+ +

+These probe points allow procfs "files" in +/proc/systemtap/MODNAME to be created, read and written +(MODNAME + +is the name of the systemtap module). The +proc + +filesystem is a pseudo-filesystem which is used an an interface to +kernel data structures. There are four probe point variants supported +by the translator: +

+ +
+ +

+
+procfs("PATH").read
+procfs("PATH").write
+procfs.read
+procfs.write
+
+
+ +
+ + +

+PATH + +is the file name (relative to /proc/systemtap/MODNAME) to be created. +If no +PATH + +is specified (as in the last two variants above), +PATH + +defaults to "command". +

+ +When a user reads /proc/systemtap/MODNAME/PATH, the corresponding +procfs +read + +probe is triggered. The string data to be read should be assigned to +a variable named +$value, + +like this: +

+ +
+ +

+
+procfs("PATH").read { $value = "100\n" }
+
+
+ +
+ + +

+ +When a user writes into /proc/systemtap/MODNAME/PATH, the +corresponding procfs +write + +probe is triggered. The data the user wrote is available in the +string variable named +$value, + +like this: +

+ +
+ +

+
+procfs("PATH").write { printf("user wrote: %s", $value) }
+
+
+ +
+ + +

+  +

MARKERS

+ +

+This family of probe points hooks up to static probing markers +inserted into the kernel or modules. These markers are special macro +calls inserted by kernel developers to make probing faster and more +reliable than with DWARF-based probes. Further, DWARF debugging +information is +not + +required to probe markers. +

+Marker probe points begin with +kernel. + +The next part names the marker itself: +mark(name). + +The marker name string, which may contain the usual wildcard characters, +is matched against the names given to the marker macros when the kernel +and/or module was compiled. Optionally, you can specify +format(format). + +Specifying the marker format string allows differentiation between two +markers with the same name but different marker format strings. +

+The handler associated with a marker-based probe may read the +optional parameters specified at the macro call site. These are +named +$arg1 through $argNN, + +where NN is the number of parameters supplied by the macro. Number +and string parameters are passed in a type-safe manner. +

+The marker format string associated with a marker is available in +$format. + +And also the marker name string is available in +$name. + +

+  +

TRACEPOINTS

+ +

+This family of probe points hooks up to static probing tracepoints +inserted into the kernel or modules. As with markers, these +tracepoints are special macro calls inserted by kernel developers to +make probing faster and more reliable than with DWARF-based probes, +and DWARF debugging information is not required to probe tracepoints. +Tracepoints have an extra advantage of more strongly-typed parameters +than markers. +

+Tracepoint probes begin with +kernel. + +The next part names the tracepoint itself: +trace(name). + +The tracepoint name string, which may contain the usual wildcard +characters, is matched against the names defined by the kernel +developers in the tracepoint header files. +

+The handler associated with a tracepoint-based probe may read the +optional parameters specified at the macro call site. These are +named according to the declaration by the tracepoint author. For +example, the tracepoint probe +kernel.trace(sched_switch) + +provides the parameters +$rq, $prev, and $next. + +If the parameter is a complex type, as in a struct pointer, then a +script can access fields with the same syntax as DWARF $target +variables. Also, tracepoint parameters cannot be modified, but in +guru-mode a script may modify fields of parameters. +

+The name of the tracepoint is available in +$$name, + +and a string of name=value pairs for all parameters of the tracepoint +is available in +$$vars or $$parms. + +

+  +

PERFORMANCE MONITORING HARDWARE

+ +

+The perfmon family of probe points is used to access the performance +monitoring hardware available in modern processors. This family of +probes points needs the perfmon2 support in the kernel to access the +performance monitoring hardware. +

+ +Performance monitor hardware points begin with a +perfmon. + +The next part of the names the event being counted +counter(event). + +The event names are processor implementation specific with the +exception of the generic +cycles and instructions + +events, which are available on all processors. This sets up a counter +on the processor to count the number of events occurring on the +processor. For more details on the performance monitoring events +available on a specific processor use the command perfmon2 command: +

+ +
+ +

+
+pfmon -l
+
+
+ +
+ + +
+
$counter
+is a handle used in the body of the probe for operations +involving the counter associated with the probe. +
read_counter
+is a function that is passed the handle for the perfmon probe and returns +the current count for the event. +

+

+  +

EXAMPLES

+ +

+ +Here are some example probe points, defining the associated events. +

+
begin, end, end
+refers to the startup and normal shutdown of the session. In this +case, the handler would run once during startup and twice during +shutdown. +
timer.jiffies(1000).randomize(200)
+refers to a periodic interrupt, every 1000 +/- 200 jiffies. +
kernel.function("*init*"), kernel.function("*exit*")
+refers to all kernel functions with "init" or "exit" in the name. +
kernel.function("*@kernel/sched.c:240")
+refers to any functions within the "kernel/sched.c" file that span +line 240. +
kernel.mark("getuid")
+refers to an STAP_MARK(getuid, ...) macro call in the kernel. +
module("usb*").function("*sync*").return
+refers to the moment of return from all functions with "sync" in the +name in any of the USB drivers. +
kernel.statement(0xc0044852)
+refers to the first byte of the statement whose compiled instructions +include the given address in the kernel. +
kernel.statement("*@kernel/sched.c:2917")
+refers to the statement of line 2917 within "kernel/sched.c". +
kernel.statement("bio_init@fs/bio.c+3")
+refers to the statement at line bio_init+3 within "fs/bio.c". +
syscall.*.return
+refers to the group of probe aliases with any name in the third position +

+

+  +

SEE ALSO

+ +stap(1), + +stapprobes.iosched(3Xtap), + +stapprobes.netdev(3stap), + +stapprobes.nfs(3stap), + +stapprobes.nfsd(3stap), + +stapprobes.pagefault(3stap), + +stapprobes.process(3stap), + +stapprobes.rpc(3stap), + +stapprobes.scsi(3stap), + +stapprobes.signal(3stap), + +stapprobes.socket(3stap), + +stapprobes.tcp(3stap), + +stapprobes.udp(3stap), + +proc(3stap) + +

+ +


+ 

Index

+
+
NAME
+
DESCRIPTION
+
+
BEGIN/END/ERROR
+
NEVER
+
SYSCALL
+
TIMERS
+
DWARF
+
DWARFLESS
+
USER-SPACE
+
PROCFS
+
MARKERS
+
TRACEPOINTS
+
PERFORMANCE MONITORING HARDWARE
+
+
EXAMPLES
+
SEE ALSO
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/stapprobes.5.html b/man/stapprobes.5.html deleted file mode 100644 index bb146f98..00000000 --- a/man/stapprobes.5.html +++ /dev/null @@ -1,610 +0,0 @@ - -Manpage of STAPPROBES - -

STAPPROBES

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
- -  -

NAME

- -stapprobes - systemtap probe points -

- - - -

-  -

DESCRIPTION

- -The following sections enumerate the variety of probe points supported -by the systemtap translator, and additional aliases defined by -standard tapset scripts. -

- -The general probe point syntax is a dotted-symbol sequence. This -allows a breakdown of the event namespace into parts, somewhat like -the Domain Name System does on the Internet. Each component -identifier may be parametrized by a string or number literal, with a -syntax like a function call. A component may include a "*" -character, to expand to other matching probe points. A probe point -may be followed by a "?" character, to indicate that it is optional, -and that no error should result if it fails to expand. Optionalness -passes down through all levels of alias/wildcard expansion. -

-These are all syntactically valid probe points: -

- -
- -

-
-kernel.function("foo").return
-syscall(22)
-user.inode("/bin/vi").statement(0x2222)
-end
-syscall.*
-kernel.function("no_such_function") ?
-
-
- -
- - -

-Probes may be broadly classified into "synchronous" and -"asynchronous". A "synchronous" event is deemed to occur when any -processor executes an instruction matched by the specification. This -gives these probes a reference point (instruction address) from which -more contextual data may be available. Other families of probe points -refer to "asynchronous" events such as timers/counters rolling over, -where there is no fixed reference point that is related. Each probe -point specification may match multiple locations (for example, using -wildcards or aliases), and all them are then probed. A probe -declaration may also contain several comma-separated specifications, -all of which are probed. -

-  -

BEGIN/END/ERROR

- -

-The probe points -begin and end - -are defined by the translator to refer to the time of session startup -and shutdown. All "begin" probe handlers are run, in some sequence, -during the startup of the session. All global variables will have -been initialized prior to this point. All "end" probes are run, in -some sequence, during the -normal - -shutdown of a session, such as in the aftermath of an -exit () - -function call, or an interruption from the user. In the case of an -error-triggered shutdown, "end" probes are not run. There are no -target variables available in either context. -

- -If the order of execution among "begin" or "end" probes is significant, -then an optional sequence number may be provided: -

- -
- -

-
-begin(N)
-end(N)
-
-
- -
- - -

-The number N may be positive or negative. The probe handlers are run in -increasing order, and the order between handlers with the same sequence -number is unspecified. When "begin" or "end" are given without a -sequence, they are effectively sequence zero. -

-The -error - -probe point is similar to the -end - -probe, except that each such probe handler run when the session and -after errors having occurred. In such cases, "end" probes are -skipped, but each "error" prober is still attempted. This kind of -probe can be used to clean up or emit a final gasp message. It may -also be numerically parametrized to set a sequence. -

-  -

NEVER

- -The probe point -never - -is specially defined by the translator to mean "never". Its probe -handler is never run, though its statements are analyzed for symbol / -type correctness as usual. This probe point may be useful in -conjunction with optional probes. -

-  -

TIMERS

- -

-Intervals defined by the standard kernel "jiffies" timer may be used -to trigger probe handlers asynchronously. Two probe point variants -are supported by the translator: -

- -
- -

-
-timer.jiffies(N)
-timer.jiffies(N).randomize(M)
-
-
- -
- - -

-The probe handler is run every N jiffies (a kernel-defined unit of -time, typically between 1 and 60 ms). If the "randomize" component is -given, a linearly distributed random value in the range [-M..+M] is -added to N every time the handler is run. N is restricted to a -reasonable range (1 to around a million), and M is restricted to be -smaller than N. There are no target variables provided in either -context. It is possible for such probes to be run concurrently on -a multi-processor computer. -

- -Alternatively, intervals may be specified in units of time. -There are two probe point variants similar to the jiffies timer: -

- -
- -

-
-timer.ms(N)
-timer.ms(N).randomize(M)
-
-
- -
- - -

-Here, N and M are specified in milliseconds, but the full options for units -are seconds (s/sec), milliseconds (ms/msec), microseconds (us/usec), -nanoseconds (ns/nsec), and hertz (hz). Randomization is not supported for -hertz timers. -

-The actual resolution of the timers depends on the target kernel. For -kernels prior to 2.6.17, timers are limited to jiffies resolution, so -intervals are rounded up to the nearest jiffies interval. After 2.6.17, -the implementation uses hrtimers for tighter precision, though the actual -resolution will be arch-dependent. In either case, if the "randomize" -component is given, then the random value will be added to the interval -before any rounding occurs. -

- -Profiling timers are also available to provide probes that execute on all -CPUs at the rate of the system tick. This probe takes no parameters. -

- -
- -

-
-timer.profile
-
-
- -
- - -

-Full context information of the interrupted process is available, making -this probe suitable for a time-based sampling profiler. -

-  -

DWARF

- -

-This family of probe points uses symbolic debugging information for -the target kernel/module/program, as may be found in unstripped -executables, or the separate -debuginfo - -packages. They allow placement of probes logically into the execution -path of the target program, by specifying a set of points in the -source or object code. When a matching statement executes on any -processor, the probe handler is run in that context. -

- -Points in a kernel, which are identified by -module, source file, line number, function name, or some -combination of these. -

- -Here is a list of probe point families currently supported. The -.function - -variant places a probe near the beginning of the named function, so that -parameters are available as context variables. The -.return - -variant places a probe at the moment of return from the named function, so -the return value is available as the "$return" context variable. -The -.inline - -modifier for -.function - -filters the results to include only instances of inlined functions. -The -.call - -modifier selects the opposite subset. Inline functions do not have an -identifiable return point, so -.return - -is not supported on -.inline - -probes. The -.statement - -variant places a probe at the exact spot, exposing those local variables -that are visible there. -

- -
- -

-
-kernel.function(PATTERN)
-
-kernel.function(PATTERN).call -
-kernel.function(PATTERN).return -
-kernel.function(PATTERN).inline -
-module(MPATTERN).function(PATTERN) -
-module(MPATTERN).function(PATTERN).call -
-module(MPATTERN).function(PATTERN).return -
-module(MPATTERN).function(PATTERN).inline -
-
-kernel.statement(PATTERN) -
-kernel.statement(ADDRESS).absolute -
-module(MPATTERN).statement(PATTERN) - -
- -
- - -

-In the above list, MPATTERN stands for a string literal that aims to -identify the loaded kernel module of interest. It may include "*", "[]", -and "?" wildcards. PATTERN stands for a string literal that -aims to identify a point in the program. It is made up of three -parts: -

-
*
-The first part is the name of a function, as would appear in the -nm - -program's output. This part may use the "*" and "?" wildcarding -operators to match multiple names. -
*
-The second part is optional and begins with the "@" character. -It is followed by the path to the source file containing the function, -which may include a wildcard pattern, such as mm/slab*. -In most cases, the path should be relative to the top of the -linux source directory, although an absolute path may be necessary for some kernels. -If a relative pathname doesn't work, try absolute. -
*
-Finally, the third part is optional if the file name part was given, -and identifies the line number in the source file, preceded by a ":". -
-

- -As an alternative, PATTERN may be a numeric constant, indicating an -(module-relative or kernel-_stext-relative) address. In guru mode -only, absolute kernel addresses may be specified with the ".absolute" -suffix. -

- -Some of the source-level variables, such as function parameters, -locals, globals visible in the compilation unit, may be visible to -probe handlers. They may refer to these variables by prefixing their -name with "$" within the scripts. In addition, a special syntax -allows limited traversal of structures, pointers, and arrays. -

-
$var
-refers to an in-scope variable "var". If it's an integer-like type, -it will be cast to a 64-bit int for systemtap script use. String-like -pointers (char *) may be copied to systemtap string values using the -kernel_string or user_string - -functions. -
$var->field
-traversal to a structure's field. The indirection operator -may be repeated to follow more levels of pointers. -
$var[N]
-indexes into an array. The index is given with a -literal number. -

-

-  -

PROCFS

- -

-These probe points allow procfs "files" in -/proc/systemtap/MODNAME to be created, read and written -(MODNAME - -is the name of the systemtap module). The -proc - -filesystem is a pseudo-filesystem which is used an an interface to -kernel data structures. There are four probe point variants supported -by the translator: -

- -
- -

-
-procfs("PATH").read
-procfs("PATH").write
-procfs.read
-procfs.write
-
-
- -
- - -

-PATH - -is the file name (relative to /proc/systemtap/MODNAME) to be created. -If no -PATH - -is specified (as in the last two variants above), -PATH - -defaults to "command". -

- -When a user reads /proc/systemtap/MODNAME/PATH, the corresponding -procfs -read - -probe is triggered. The string data to be read should be assigned to -a variable named -$value, - -like this: -

- -
- -

-
-procfs("PATH").read { $value = "100\n" }
-
-
- -
- - -

- -When a user writes into /proc/systemtap/MODNAME/PATH, the -corresponding procfs -write - -probe is triggered. The data the user wrote is available in the -string variable named -$value, - -like this: -

- -
- -

-
-procfs("PATH").write { printf("user wrote: %s", $value) }
-
-
- -
- - -

-  -

MARKERS

- -

-This family of probe points hooks up to static probing markers -inserted into the kernel or modules. These markers are special macro -calls inserted by kernel developers to make probing faster and more -reliable than with DWARF-based probes. Further, DWARF debugging -information is -not - -required to probe markers. -

-Marker probe points begin with -kernel or module(name), - -just like DWARF probes. This identifies the source of symbol table -used for finding markers. The next part names the marker itself: -mark(name). - -The marker name string, which may contain the usual wildcard characters, -is matched against the names given to the marker macros when the kernel -or module was compiled. -

-The handler associated with a marker-based probe may read the -optional parameters specified at the macro call site. These are -named -$arg1 through $argNN, - -where NN is the number of parameters supplied by the macro. Number -and string parameters are passed in a type-safe manner. -

-  -

PERFORMANCE MONITORING HARDWARE

- -

-The perfmon family of probe points is used to access the performance -monitoring hardware available in modern processors. This family of -probes points needs the perfmon2 support in the kernel to access the -performance monitoring hardware. -

- -Performance monitor hardware points begin with a -perfmon. - -The next part of the names the event being counted -counter(event). - -The event names are processor implementation specific with the -execption of the generic -cycles and instructions - -events, which are available on all processors. This sets up a counter -on the processor to count the number of events occuring on the -processor. For more details on the performance monitoring events -available on a specific processor use the command perfmon2 command: -

- -
- -

-
-pfmon -l
-
-
- -
- - -
-
$counter
-is a handle used in the body of the probe for operations -involving the counter associated with the probe. -
read_counter
-is a function that is passed the handle for the perfmon probe and returns -the current count for the event. -

-

-  -

EXAMPLES

- -

- -Here are some example probe points, defining the associated events. -

-
begin, end, end
-refers to the startup and normal shutdown of the session. In this -case, the handler would run once during startup and twice during -shutdown. -
timer.jiffies(1000).randomize(200)
-refers to a periodic interrupt, every 1000 +/- 200 jiffies. -
kernel.function("*init*"), kernel.function("*exit*")
-refers to all kernel functions with "init" or "exit" in the name. -
kernel.function("*@kernel/sched.c:240")
-refers to any functions within the "kernel/sched.c" file that span -line 240. -
kernel.mark("getuid")
-refers to an STAP_MARK(getuid, ...) macro call in the kernel. -
module("usb*").function("*sync*").return
-refers to the moment of return from all functions with "sync" in the -name in any of the USB drivers. -
kernel.statement(0xc0044852)
-refers to the first byte of the statement whose compiled instructions -include the given address in the kernel. -
kernel.statement("*@kernel/sched.c:2917")
-refers to the statement of line 2917 within the "kernel/sched.c". -
syscall.*.return
-refers to the group of probe aliases with any name in the third position -

-

-  -

SEE ALSO

- -stap(1), - -stapprobes.iosched(5), - -stapprobes.netdev(5), - -stapprobes.nfs(5), - -stapprobes.nfsd(5), - -stapprobes.pagefault(5), - -stapprobes.process(5), - -stapprobes.rpc(5), - -stapprobes.scsi(5), - -stapprobes.signal(5), - -stapprobes.socket(5), - -stapprobes.tcp(5), - -stapprobes.udp(5), - -proc(5) - -

- -


- 

Index

-
-
NAME
-
DESCRIPTION
-
-
BEGIN/END/ERROR
-
NEVER
-
TIMERS
-
DWARF
-
PROCFS
-
MARKERS
-
PERFORMANCE MONITORING HARDWARE
-
-
EXAMPLES
-
SEE ALSO
-
-
-This document was created by -man2html, -using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 - - diff --git a/man/stapprobes.iosched.5.html b/man/stapprobes.iosched.3stap.html similarity index 90% rename from man/stapprobes.iosched.5.html rename to man/stapprobes.iosched.3stap.html index 538888d7..35f92d38 100644 --- a/man/stapprobes.iosched.5.html +++ b/man/stapprobes.iosched.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.IOSCHED

STAPPROBES.IOSCHED

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -124,7 +124,7 @@ Fires when a request is completed stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -140,6 +140,6 @@ Fires when a request is completed This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.process.5.html b/man/stapprobes.kprocess.3stap.html similarity index 73% rename from man/stapprobes.process.5.html rename to man/stapprobes.kprocess.3stap.html index 9dde5359..7742db80 100644 --- a/man/stapprobes.process.5.html +++ b/man/stapprobes.kprocess.3stap.html @@ -1,14 +1,14 @@ -Manpage of STAPPROBES.PROCESS +Manpage of STAPPROBES.KPROCESS -

STAPPROBES.PROCESS

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+

STAPPROBES.KPROCESS

+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

-stapprobes.process - systemtap process probe points +stapprobes.kprocess - systemtap kernel process probe points

@@ -18,12 +18,12 @@ stapprobes.process - systemtap process probe points

DESCRIPTION

-This family of probe points is used to probe the process activities. +This family of probe points is used to probe the kernel's process activities. It contains the following probe points:

-
process.create +
kprocess.create

@@ -42,7 +42,7 @@ result of one of the fork syscall variants, or a new kernel thread.
  pid of the newly created process

-

process.start +
kprocess.start

@@ -55,7 +55,7 @@ Fires immediately before a new process begins execution.

-

process.exec +
kprocess.exec

@@ -69,7 +69,7 @@ Fires whenever a process attempts to exec to a new program
  the path to the new executable

-

process.exec_complete +
kprocess.exec_complete

@@ -87,12 +87,12 @@ Fires at the completion of an exec call
  a boolean indicating whether the exec was successful

-

process.exit +
kprocess.exit

Fires when a process terminates. This will always be followed by a -process.release, though the latter may be delayed if the process +kprocess.release, though the latter may be delayed if the process waits in a zombie state.

Arguments: @@ -103,12 +103,12 @@ waits in a zombie state.
  the exit code of the process

-

process.release +
kprocess.release

Fires when a process is released from the kernel. This always -follows a process.exit, though it may be delayed somewhat if the +follows a kprocess.exit, though it may be delayed somewhat if the process waits in a zombie state.

Arguments: @@ -128,7 +128,7 @@ process waits in a zombie state. stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -144,6 +144,6 @@ process waits in a zombie state. This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.netdev.5.html b/man/stapprobes.netdev.3stap.html similarity index 88% rename from man/stapprobes.netdev.5.html rename to man/stapprobes.netdev.3stap.html index 51fc17e5..2208e9c4 100644 --- a/man/stapprobes.netdev.5.html +++ b/man/stapprobes.netdev.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.NETDEV

STAPPROBES.NETDEV

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -83,7 +83,7 @@ Fires when the network device wants to transmit a buffer

truesize -
  The size of the the data to be transmitted. +
  The size of the data to be transmitted.

  @@ -91,7 +91,7 @@ Fires when the network device wants to transmit a buffer stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -106,6 +106,6 @@ Fires when the network device wants to transmit a buffer This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.nfs.5.html b/man/stapprobes.nfs.3stap.html similarity index 95% rename from man/stapprobes.nfs.5.html rename to man/stapprobes.nfs.3stap.html index 25370ec3..f461af46 100644 --- a/man/stapprobes.nfs.5.html +++ b/man/stapprobes.nfs.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.NFS

STAPPROBES.NFS

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -705,7 +705,7 @@ Fires when a previous async read operation failed

-Fies when in readahead way,read several pages once +Fires when in readahead way, read several pages once

Arguments: @@ -739,7 +739,7 @@ Fies when in readahead way,read several pages once

-Fies whenever a nfs read pages operation is done +Fires whenever a nfs read pages operation is done

Arguments: @@ -753,7 +753,7 @@ Fies whenever a nfs read pages operation is done

-Fies whenever set page dirty on nfs client side +Fires whenever set page dirty on nfs client side

Arguments: @@ -771,7 +771,7 @@ Fies whenever set page dirty on nfs client side

-Fies whenever writing an mapped page to the server from nfs client side +Fires whenever writing an mapped page to the server from nfs client side

Arguments: @@ -826,7 +826,7 @@ Fies whenever writing an mapped page to the server from nfs client side

-Fies whenever writing several dirty pages to the server from nfs client sides +Fires whenever writing several dirty pages to the server from nfs client sides

Arguments: @@ -865,7 +865,7 @@ Fies whenever writing several dirty pages to the server from nfs client sides

-Fies whenever prepare a page for writting on nfs client sides +Fires whenever prepare a page for writing on nfs client sides

Arguments: @@ -903,7 +903,7 @@ Fies whenever prepare a page for writting on nfs client sides

-Fies often after prepare write operation +Fires often after prepare write operation

Arguments: @@ -994,7 +994,7 @@ Fies often after prepare write operation

filename -
  the name of  file which client opens/searchs on server +
  the name of  file which client opens/searches on server

name_len @@ -1097,7 +1097,7 @@ Fires when client synchronously writes file to server

-Fires when synchronously writting file from server is done +Fires when synchronously writing file from server is done

Arguments: @@ -1111,7 +1111,7 @@ Fires when synchronously writting file from server is done

-Fires when client writes the buffered data to disk,the buffered +Fires when client writes the buffered data to disk, the buffered data is asynchronously written by client before(not exist in NFSV2)

Arguments: @@ -1162,7 +1162,7 @@ Fires when committing operation is done

Fires when client asynchronously reads file from server, -this function is used to setup a read rpc task,not do +this function is used to setup a read rpc task, not do a real read operation.

Arguments: @@ -1221,7 +1221,7 @@ Fires when a read reply is received or some read error occur

timestamp -
  time stamp ,which is used for lease renewal (only  +
  time stamp, which is used for lease renewal (only 
  in nfs.proc4.read_done)

@@ -1230,7 +1230,7 @@ Fires when a read reply is received or some read error occur

Fires when client asynchronously write data to server, -this function is used to setup a write rpc task,not do +this function is used to setup a write rpc task, not do a write read operation.

Arguments: @@ -1258,7 +1258,7 @@ a write read operation.

how -
  used to set args.stable,The possible value could be: +
  used to set args.stable, The possible value could be:
          NFS_UNSTABLE,
          NFS_DATA_SYNC,
          NFS_FILE_SYNC @@ -1298,7 +1298,7 @@ Fires when a write reply is received or some write error occur

valid -
  fattr->valid ,indicates which fields are valid +
  fattr->valid, indicates which fields are valid

count @@ -1306,7 +1306,7 @@ Fires when a write reply is received or some write error occur

timestamp -
  time stamp ,which is used for lease renewal (only  +
  time stamp, which is used for lease renewal (only 
  in nfs.proc4.read_done)

@@ -1315,7 +1315,7 @@ Fires when a write reply is received or some write error occur

Fires when client asynchronously do a commit operation, -this function is used to setup a commit rpc task,not do +this function is used to setup a commit rpc task, not do a commit read operation.

Arguments: @@ -1375,7 +1375,7 @@ Fires when a commit reply is received or some commit error occur

valid -
  fattr->valid ,indicates which fields are valid +
  fattr->valid, indicates which fields are valid

count @@ -1383,7 +1383,7 @@ Fires when a commit reply is received or some commit error occur

timestamp -
  time stamp ,which is used for lease renewal (only  +
  time stamp, which is used for lease renewal (only 
  in nfs.proc4.read_done)

@@ -1591,7 +1591,7 @@ Fires whenever nfs client renames a file on server stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -1607,6 +1607,6 @@ Fires whenever nfs client renames a file on server This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.nfsd.5.html b/man/stapprobes.nfsd.3stap.html similarity index 92% rename from man/stapprobes.nfsd.5.html rename to man/stapprobes.nfsd.3stap.html index dab75715..d0baeadf 100644 --- a/man/stapprobes.nfsd.5.html +++ b/man/stapprobes.nfsd.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.NFSD

STAPPROBES.NFSD

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -31,7 +31,7 @@ It contains the following probe points:

-Fires whenever client opens/searchs file on server +Fires whenever client opens/searches file on server

Arguments: @@ -96,7 +96,7 @@ Fires whenever client reads file on server

vec -
  struct kvec ,includes buf address in kernel address +
  struct kvec, includes buf address in kernel address
  and the length of each buffer

vlen @@ -139,7 +139,7 @@ Fires whenever client writes data to file on server

vec -
  struct kvec ,includes buf address in kernel address +
  struct kvec, includes buf address in kernel address
  and the length of each buffer

vlen @@ -378,7 +378,7 @@ Fires whenever server reads file

vec -
  struct kvec ,includes buf address in kernel address +
  struct kvec, includes buf address in kernel address
  and the length of each buffer

vlen @@ -413,7 +413,7 @@ Fires whenever server writes file

vec -
  struct kvec ,includes buf address in kernel address +
  struct kvec, includes buf address in kernel address
  and the length of each buffer

vlen @@ -447,7 +447,7 @@ Fires when server commits all pending writes to stable storage

-Fires whenever client opens/searchs file on server +Fires whenever client opens/searches file on server

Arguments: @@ -506,7 +506,7 @@ Fires whenever client opens/searchs file on server

Fires when client creates a regular file or set file attributes -on server side,only called by nfsd3_proc_create and nfsd4_open +on server side, only called by nfsd3_proc_create and nfsd4_open (op_claim_type is NFS4_OPEN_CLAIM_NULL)

Arguments: @@ -534,16 +534,16 @@ on server side,only called by nfsd3_proc_create and nfsd4_open

createmode -
  create mode .The possible values could be: +
  create mode. The possible values could be:
    NFS3_CREATE_EXCLUSIVE,NFS3_CREATE_UNCHECKED,NFS3_CREATE_GUARDED

truncp -
  trunp arguments, indicates if the file shouldbe truncate +
  trunp arguments, indicates if the file should be truncated

verfier -
  file attributes (atime,mtime,mode).It's used to reset file +
  file attributes (atime,mtime,mode). It's used to reset file
  attributes for CREATE_EXCLUSIVE

@@ -624,7 +624,7 @@ Fires whenever server closes file

-Fires whenever server receives NFS operation from client +Fires whenever server receives NFS operation from client

Arguments: @@ -659,7 +659,7 @@ Fires whenever server receives NFS operation from client stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -675,6 +675,6 @@ Fires whenever server receives NFS operation from client This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.pagefault.5.html b/man/stapprobes.pagefault.3stap.html similarity index 82% rename from man/stapprobes.pagefault.5.html rename to man/stapprobes.pagefault.3stap.html index 96e182d5..1f4e984d 100644 --- a/man/stapprobes.pagefault.5.html +++ b/man/stapprobes.pagefault.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.PAGEFAULT

STAPPROBES.PAGEFAULT

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -45,7 +45,7 @@ Fires when there is a pagefault stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -61,6 +61,6 @@ Fires when there is a pagefault This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.rpc.5.html b/man/stapprobes.rpc.3stap.html similarity index 98% rename from man/stapprobes.rpc.5.html rename to man/stapprobes.rpc.3stap.html index 0d6a953d..8bb6650a 100644 --- a/man/stapprobes.rpc.5.html +++ b/man/stapprobes.rpc.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.RPC

STAPPROBES.RPC

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -490,7 +490,7 @@ Fires when an RPC client is to be processed

rq_prot -
  The IP protocol of the reqeust +
  The IP protocol of the request

sunrpc.svc.authorise @@ -527,7 +527,7 @@ Fires when an RPC client is to be authorised

rq_prot -
  The IP protocol of the reqeust +
  The IP protocol of the request

sunrpc.svc.recv @@ -589,7 +589,7 @@ Fires when want to return reply to client

rq_prot -
  The IP protocol of the reqeust +
  The IP protocol of the request

sunrpc.svc.drop @@ -626,7 +626,7 @@ Fires when a request is to be dropped

rq_prot -
  The IP protocol of the reqeust +
  The IP protocol of the request

sunrpc.sched.new_task @@ -762,7 +762,7 @@ Fires when a task is to be delayed stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -778,6 +778,6 @@ Fires when a task is to be delayed This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.scsi.5.html b/man/stapprobes.scsi.3stap.html similarity index 96% rename from man/stapprobes.scsi.5.html rename to man/stapprobes.scsi.3stap.html index 0238045c..be47f383 100644 --- a/man/stapprobes.scsi.5.html +++ b/man/stapprobes.scsi.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.SCSI

STAPPROBES.SCSI

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -184,7 +184,7 @@ block device I/O requests stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -200,6 +200,6 @@ block device I/O requests This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.signal.5.html b/man/stapprobes.signal.3stap.html similarity index 96% rename from man/stapprobes.signal.5.html rename to man/stapprobes.signal.3stap.html index 6559638e..6822184a 100644 --- a/man/stapprobes.signal.5.html +++ b/man/stapprobes.signal.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.SIGNAL

STAPPROBES.SIGNAL

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -90,7 +90,7 @@ Fires when return from sending a signal

-- return 0 if the signal is sucessfully sent to a process, +- return 0 if the signal is successfully sent to a process, which means the following:

<1> the signal is ignored by receiving process @@ -107,7 +107,7 @@ by user using something other than kill()
  Return values for "send_group_sigqueue"

-- return 0 if the signal is either sucessfully added into the +- return 0 if the signal is either successfully added into the sigqueue of receiving process or a SI_TIMER entry is already queued so just increment the overrun count

@@ -118,7 +118,7 @@ queued so just increment the overrun count
  Return values for "send_sigqueue"

-- return 0 if the signal is either sucessfully added into the +- return 0 if the signal is either successfully added into the sigqueue of receiving process or a SI_TIMER entry is already queued so just increment the overrun count

@@ -229,8 +229,8 @@ Fires when wake up the process for new active signals

state_mask -
  a string representation indicate the mask of task states  -that can be woken. Possible values are +
  a string representation indicate the mask of task states +that can be woken. Possible values are (TASK_INTERRUPTIBLE|TASK_STOPPED|TASK_TRACED) and TASK_INTERRUPTIBLE.

@@ -639,7 +639,7 @@ Fires when flush all pending signals for a task stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -655,6 +655,6 @@ Fires when flush all pending signals for a task This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.socket.5.html b/man/stapprobes.socket.3stap.html similarity index 97% rename from man/stapprobes.socket.5.html rename to man/stapprobes.socket.3stap.html index cf591d57..ab9a7e03 100644 --- a/man/stapprobes.socket.5.html +++ b/man/stapprobes.socket.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.SOCKET

STAPPROBES.SOCKET

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -62,7 +62,7 @@ The message sender.
    to convert to a string.


    Common values include: -
         0 - IP (Internet Procotol, local interprocess communications) +
         0 - IP (Internet Protocol, local interprocess communications)
         6 - TCP (Transmission Control Protocol)
        17 - UDP (User Datagram Protocol)
       132 - SCTP (Stream Control Transmission Protocol) @@ -604,9 +604,9 @@ The socket closer. stap(1), -stapprobes(5), +stapprobes(3stap), -stapfuncs(5) +stapfuncs(3stap)

@@ -621,6 +621,6 @@ The socket closer. This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.tcp.5.html b/man/stapprobes.tcp.3stap.html similarity index 88% rename from man/stapprobes.tcp.5.html rename to man/stapprobes.tcp.3stap.html index a9e555b3..36accf43 100644 --- a/man/stapprobes.tcp.5.html +++ b/man/stapprobes.tcp.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.TCP

STAPPROBES.TCP

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -124,7 +124,7 @@ Fires when returning from tcp.disconnect stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -140,6 +140,6 @@ Fires when returning from tcp.disconnect This document was created by man2html, using the manual pages.
-Time: 22:28:06 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapprobes.udp.5.html b/man/stapprobes.udp.3stap.html similarity index 88% rename from man/stapprobes.udp.5.html rename to man/stapprobes.udp.3stap.html index 7bfd5756..cba87414 100644 --- a/man/stapprobes.udp.5.html +++ b/man/stapprobes.udp.3stap.html @@ -2,8 +2,8 @@ Manpage of STAPPROBES.UDP

STAPPROBES.UDP

-Section: File Formats (5)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -124,7 +124,7 @@ Fires when returning from udp.disconnect stap(1), -stapprobes(5), +stapprobes(3stap)

@@ -140,6 +140,6 @@ Fires when returning from udp.disconnect This document was created by man2html, using the manual pages.
-Time: 22:28:06 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/staprun.8.html b/man/staprun.8.html index 64e65d3d..34ed84dc 100644 --- a/man/staprun.8.html +++ b/man/staprun.8.html @@ -2,8 +2,8 @@ Manpage of STAPRUN

STAPRUN

-Section: Maintenance Commands (8)
Updated: 2007-10-18
Index -Return to Main Contents
+Section: Maintenance Commands (8)
Updated: 2009-09-28
Index +Return to Main Contents
 

NAME

@@ -50,7 +50,7 @@ transfer the resulting kernel module to a production machine that doesn't have any development tools or kernel debugging information installed.

-This manual corresponds to version ?. +This manual corresponds to version 1.0.

 

OPTIONS

@@ -81,13 +81,15 @@ The '_stp_target' variable will be set to PID.
Send output to FILE. If the module uses bulk mode, the output will -be in percpu files FILE_x where 'x' is the cpu number. +be in percpu files FILE_x(FILE_cpux in background and bulk mode) +where 'x' is the cpu number. This supports strftime(3) formats +for FILE.
-b BUFFER_SIZE
The systemtap module will specify a buffer size. Setting one here will override that value. The value should be -an integer between 1 and 64 which be assumed to be the +an integer between 1 and 4095 which be assumed to be the buffer size in MB. That value will be per-cpu if bulk mode is used.
-L @@ -101,6 +103,28 @@ option.
Attach to loaded systemtap module. +
-d + +
+Delete a module. Only detached or unused modules +the user has permission to access will be deleted. Use "*" +(quoted) to delete all unused modules. +
-D + +
+Run staprun in background as a daemon and show it's pid. +
-S size[,N] + +
+Sets the maximum size of output file and the maximum number of output files. +If the size of output file will exceed +size + +, systemtap switches output file to the next file. And if the number of +output files exceed +N + +, systemtap removes the oldest output file. You can omit the second argument.

  @@ -125,7 +149,7 @@ module.

EXAMPLES

See the -stapex(5) +stapex(3stap) manual page for a collection of sample scripts.

@@ -142,8 +166,7 @@ to compile a script. The program will report the pathname to the resulting module.

- - $ stap -p4 -e 'probe begin { printf("Hello World!\n"); exit() }' + $ stap -p4 -e [aq]probe begin { printf("Hello World!\n"); exit() }[aq]
/home/user/.systemtap/cache/85/stap_8553d83f78c_265.ko @@ -155,7 +178,6 @@ Run with the pathname to the module as an argument.

- $ staprun /home/user/.systemtap/cache/85/stap_8553d83f78c_265.ko
@@ -181,7 +203,55 @@ To reattach to a kernel module, the -A option would be used. +

  +

FILE SWITCHING BY SIGNAL

+ +After the +staprun + +launched the +stapio + +, users can command it to switch output file to next file when it +outputs to file(s) (running staprun with +-o + +option) by sending a +SIGUSR2 + +signal to the +stapio + +process. When it receives SIGUSR2, it will switch output file to +new file with suffix +.N + +where N is the sequential number. +For example, +

+ + $ staprun -o foo ... +

+ +outputs trace logs to +foo + +and if it receives +SIGUSR2 + +signal, it switches output to +foo.1 + +file. And receiving +SIGUSR2 + +again, it switches to +foo.2 + +file. +

+ 

SAFETY AND SECURITY

Systemtap is an administrative tool. It exposes kernel internal data @@ -204,9 +274,9 @@ Members of the group can use staprun -to insert systemtap modules (or attach to existing systemtap modules) that +to insert or remove systemtap modules (or attach to existing systemtap modules) that are located in the /lib/modules/VERSION/systemtap directory. -  + 

FILES

@@ -219,24 +289,24 @@ group can only install modules located in this directory. This directory should be owned by the root user and not be world writable.
-  + 

SEE ALSO

stap(1), -stapprobes(5), +stapprobes(3stap), -stapfuncs(5), +stapfuncs(3stap), -stapex(5), +stapex(3stap),

-  + 

BUGS

Use the Bugzilla link off of the project web page or our mailing list. -http://sources.redhat.com/systemtap/,<systemtap@sources.redhat.com>. +http://sources.redhat.com/systemtap/, <systemtap@sources.redhat.com>.

@@ -252,15 +322,16 @@ Use the Bugzilla link off of the project web page or our mailing list.

ARGUMENTS
EXAMPLES
MODULE DETACHING AND ATTACHING
-
SAFETY AND SECURITY
-
FILES
-
SEE ALSO
-
BUGS
+
FILE SWITCHING BY SIGNAL
+
SAFETY AND SECURITY
+
FILES
+
SEE ALSO
+
BUGS

This document was created by man2html, using the manual pages.
-Time: 22:28:05 GMT, October 18, 2007 +Time: 19:56:13 GMT, September 28, 2009 diff --git a/man/stapvars.3stap.html b/man/stapvars.3stap.html new file mode 100644 index 00000000..8bc89f78 --- /dev/null +++ b/man/stapvars.3stap.html @@ -0,0 +1,93 @@ + +Manpage of STAPVARS + +

STAPVARS

+Section: Misc. Reference Manual Pages (3stap)
Updated: 2009-09-28
Index +Return to Main Contents
+ +  +

NAME

+ +stapvars - systemtap variables +

+  +

DESCRIPTION

+ +The following sections enumerate the public variables provided by +standard tapsets installed under /home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/tapset. Each +variable is described with a type, and its behavior/restrictions. +The syntax is the same as printed with the +stap option -p2. + +Examples: +

+

+
example1:long
+Variable "example1" contains an integer. +

+

example2:string [long]
+Variable "example2" is an array of strings, indexed by integers. +

+

+  +

ARGV

+ +

+

+
argc:long
+Contains the value of the +$# + +value: the number of command line arguments passed to the systemtap script. +It is initialized with an implicit begin(-1) probe. +

+

argv:string [long]
+Contains each command line argument as a string. argv[1] will equal @1 if +there was at least one command line argument. Arguments beyond #32 are not +transcribed, and produce a warning message within the begin(-1) probe that +initializes this array. +

+

+  +

NULL

+ +

+

+
NULL:long
+Simply defined as the number 0. +

+

+  +

FILES

+ + +/home/fche/Private/DEVEL/DEVEL-systemtap/git/BUILD3/../INST3/share/systemtap/tapset + + +

+  +

SEE ALSO

+ +stap(1) + +

+ +


+ 

Index

+
+
NAME
+
DESCRIPTION
+
+
ARGV
+
NULL
+
+
FILES
+
SEE ALSO
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/symdata.3stap.html b/man/symdata.3stap.html new file mode 100644 index 00000000..9c9339ef --- /dev/null +++ b/man/symdata.3stap.html @@ -0,0 +1,79 @@ + +Manpage of SYMDATA + +

SYMDATA

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +symdata - Return the symbol and module offset for the address. +  +

SYNOPSIS

+ +

+

+    symdata:string(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+The address to translate. +
+ +  +

DESCRIPTION

+ +

+ +Returns the (function) symbol name associated with the given address if known, plus the module name (between brackets) and the offset inside the module, plus the size of the symbol function. 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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/symname.3stap.html b/man/symname.3stap.html new file mode 100644 index 00000000..ff0ac005 --- /dev/null +++ b/man/symname.3stap.html @@ -0,0 +1,79 @@ + +Manpage of SYMNAME + +

SYMNAME

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +symname - Return the symbol associated with the given address. +  +

SYNOPSIS

+ +

+

+    symname:string(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+The address to translate. +
+ +  +

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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/target.3stap.html b/man/target.3stap.html new file mode 100644 index 00000000..30873679 --- /dev/null +++ b/man/target.3stap.html @@ -0,0 +1,68 @@ + +Manpage of TARGET + +

TARGET

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +target - Return the process ID of the target process. +  +

SYNOPSIS

+ +

+

+    target:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/task_backtrace.3stap.html b/man/task_backtrace.3stap.html new file mode 100644 index 00000000..2a30c7c7 --- /dev/null +++ b/man/task_backtrace.3stap.html @@ -0,0 +1,79 @@ + +Manpage of TASK_BACKTRACE + +

TASK_BACKTRACE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +task_backtrace - Hex backtrace of an arbitrary task +  +

SYNOPSIS

+ +

+

+    task_backtrace:string(task:long)
+
+ +  +

ARGUMENTS

+ +

+ +task +

+pointer to task_struct +
+ +  +

DESCRIPTION

+ +

+ +Return 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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.disconnect.3stap.html b/man/tcp.disconnect.3stap.html new file mode 100644 index 00000000..7b2fab40 --- /dev/null +++ b/man/tcp.disconnect.3stap.html @@ -0,0 +1,121 @@ + +Manpage of TCP\&.DISCONNECT + +

TCP\&.DISCONNECT

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.disconnect - TCP socket disconnection +  +

SYNOPSIS

+ +

+

+tcp.disconnect 
+
+ +  +

VALUES

+ +

+ +saddr +

+A string representing the source IP address +
+ +

+ +daddr +

+A string representing the destination IP address +
+ +

+ +flags +

+TCP flags (e.g. FIN, etc) +
+ +

+ +name +

+Name of this probe +
+ +

+ +sport +

+TCP source port +
+ +

+ +dport +

+TCP destination port +
+ +

+ +sock +

+Network socket +
+ +  +

CONTEXT

+ +

+ +The process which disconnects tcp +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.disconnect.return.3stap.html b/man/tcp.disconnect.return.3stap.html new file mode 100644 index 00000000..886e437a --- /dev/null +++ b/man/tcp.disconnect.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of TCP\&.DISCONNECT\&.R + +

TCP\&.DISCONNECT\&.R

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.disconnect.return - TCP socket disconnection complete +  +

SYNOPSIS

+ +

+

+tcp.disconnect.return 
+
+ +  +

VALUES

+ +

+ +ret +

+Error code (0: no error) +
+ +

+ +name +

+Name of this probe +
+ +  +

CONTEXT

+ +

+ +The process which disconnects tcp +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.receive.3stap.html b/man/tcp.receive.3stap.html new file mode 100644 index 00000000..14adacdd --- /dev/null +++ b/man/tcp.receive.3stap.html @@ -0,0 +1,135 @@ + +Manpage of TCP\&.RECEIVE + +

TCP\&.RECEIVE

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.receive - Called when a TCP packet is received +  +

SYNOPSIS

+ +

+

+tcp.receive 
+
+ +  +

VALUES

+ +

+ +urg +

+TCP URG flag +
+ +

+ +psh +

+TCP PSH flag +
+ +

+ +rst +

+TCP RST flag +
+ +

+ +dport +

+TCP destination port +
+ +

+ +saddr +

+A string representing the source IP address +
+ +

+ +daddr +

+A string representing the destination IP address +
+ +

+ +ack +

+TCP ACK flag +
+ +

+ +syn +

+TCP SYN flag +
+ +

+ +fin +

+TCP FIN flag +
+ +

+ +sport +

+TCP source port +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.recvmsg.3stap.html b/man/tcp.recvmsg.3stap.html new file mode 100644 index 00000000..03a83851 --- /dev/null +++ b/man/tcp.recvmsg.3stap.html @@ -0,0 +1,121 @@ + +Manpage of TCP\&.RECVMSG + +

TCP\&.RECVMSG

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.recvmsg - Receiving TCP message +  +

SYNOPSIS

+ +

+

+tcp.recvmsg 
+
+ +  +

VALUES

+ +

+ +saddr +

+A string representing the source IP address +
+ +

+ +daddr +

+A string representing the destination IP address +
+ +

+ +name +

+Name of this probe +
+ +

+ +sport +

+TCP source port +
+ +

+ +dport +

+TCP destination port +
+ +

+ +size +

+Number of bytes to be received +
+ +

+ +sock +

+Network socket +
+ +  +

CONTEXT

+ +

+ +The process which receives a tcp message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.recvmsg.return.3stap.html b/man/tcp.recvmsg.return.3stap.html new file mode 100644 index 00000000..686b4884 --- /dev/null +++ b/man/tcp.recvmsg.return.3stap.html @@ -0,0 +1,114 @@ + +Manpage of TCP\&.RECVMSG\&.RETU + +

TCP\&.RECVMSG\&.RETU

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.recvmsg.return - Receiving TCP message complete +  +

SYNOPSIS

+ +

+

+tcp.recvmsg.return 
+
+ +  +

VALUES

+ +

+ +saddr +

+A string representing the source IP address +
+ +

+ +daddr +

+A string representing the destination IP address +
+ +

+ +name +

+Name of this probe +
+ +

+ +sport +

+TCP source port +
+ +

+ +dport +

+TCP destination port +
+ +

+ +size +

+Number of bytes received or error code if an error occurred. +
+ +  +

CONTEXT

+ +

+ +The process which receives a tcp message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.sendmsg.3stap.html b/man/tcp.sendmsg.3stap.html new file mode 100644 index 00000000..2baa425b --- /dev/null +++ b/man/tcp.sendmsg.3stap.html @@ -0,0 +1,93 @@ + +Manpage of TCP\&.SENDMSG + +

TCP\&.SENDMSG

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.sendmsg - Sending a tcp message +  +

SYNOPSIS

+ +

+

+tcp.sendmsg 
+
+ +  +

VALUES

+ +

+ +name +

+Name of this probe +
+ +

+ +size +

+Number of bytes to send +
+ +

+ +sock +

+Network socket +
+ +  +

CONTEXT

+ +

+ +The process which sends a tcp message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.sendmsg.return.3stap.html b/man/tcp.sendmsg.return.3stap.html new file mode 100644 index 00000000..cedb14d4 --- /dev/null +++ b/man/tcp.sendmsg.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of TCP\&.SENDMSG\&.RETU + +

TCP\&.SENDMSG\&.RETU

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.sendmsg.return - Sending TCP message is done +  +

SYNOPSIS

+ +

+

+tcp.sendmsg.return 
+
+ +  +

VALUES

+ +

+ +name +

+Name of this probe +
+ +

+ +size +

+Number of bytes sent or error code if an error occurred. +
+ +  +

CONTEXT

+ +

+ +The process which sends a tcp message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.setsockopt.3stap.html b/man/tcp.setsockopt.3stap.html new file mode 100644 index 00000000..e19c165d --- /dev/null +++ b/man/tcp.setsockopt.3stap.html @@ -0,0 +1,115 @@ + +Manpage of TCP\&.SETSOCKOPT + +

TCP\&.SETSOCKOPT

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.setsockopt - Call to setsockopt +  +

SYNOPSIS

+ +

+

+tcp.setsockopt 
+
+ +  +

VALUES

+ +

+ +optstr +

+Resolves optname to a human-readable format +
+ +

+ +level +

+The level at which the socket options will be manipulated +
+ +

+ +optlen +

+Used to access values for +setsockopt +
+ +

+ +name +

+Name of this probe +
+ +

+ +optname +

+TCP socket options (e.g. TCP_NODELAY, TCP_MAXSEG, etc) +
+ +

+ +sock +

+Network socket +
+ +  +

CONTEXT

+ +

+ +The process which calls setsockopt +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tcp.setsockopt.return.3stap.html b/man/tcp.setsockopt.return.3stap.html new file mode 100644 index 00000000..4d0067c3 --- /dev/null +++ b/man/tcp.setsockopt.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of TCP\&.SETSOCKOPT\&.R + +

TCP\&.SETSOCKOPT\&.R

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tcp.setsockopt.return - Return from setsockopt +  +

SYNOPSIS

+ +

+

+tcp.setsockopt.return 
+
+ +  +

VALUES

+ +

+ +ret +

+Error code (0: no error) +
+ +

+ +name +

+Name of this probe +
+ +  +

CONTEXT

+ +

+ +The process which calls setsockopt +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/tid.3stap.html b/man/tid.3stap.html new file mode 100644 index 00000000..2dc91257 --- /dev/null +++ b/man/tid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of TID + +

TID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +tid - Returns the thread ID of a target process. +  +

SYNOPSIS

+ +

+

+    tid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/uaddr.3stap.html b/man/uaddr.3stap.html new file mode 100644 index 00000000..e710077b --- /dev/null +++ b/man/uaddr.3stap.html @@ -0,0 +1,78 @@ + +Manpage of UADDR + +

UADDR

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +uaddr - User space address of current running task. EXPERIMENTAL. +  +

SYNOPSIS

+ +

+

+    uaddr:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

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 +symdata. Often the task will be in the VDSO where it entered the kernel. FIXME - need VDSO tracking support #10080. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/ubacktrace.3stap.html b/man/ubacktrace.3stap.html new file mode 100644 index 00000000..40e75b59 --- /dev/null +++ b/man/ubacktrace.3stap.html @@ -0,0 +1,77 @@ + +Manpage of UBACKTRACE + +

UBACKTRACE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +ubacktrace - Hex backtrace of current task stack. EXPERIMENTAL! +  +

SYNOPSIS

+ +

+

+    ubacktrace:string()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/udp.disconnect.3stap.html b/man/udp.disconnect.3stap.html new file mode 100644 index 00000000..d5bc5e79 --- /dev/null +++ b/man/udp.disconnect.3stap.html @@ -0,0 +1,93 @@ + +Manpage of UDP\&.DISCONNECT + +

UDP\&.DISCONNECT

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +udp.disconnect - Fires when a process requests for a UDP disconnection +  +

SYNOPSIS

+ +

+

+udp.disconnect 
+
+ +  +

VALUES

+ +

+ +flags +

+Flags (e.g. FIN, etc) +
+ +

+ +name +

+The name of this probe +
+ +

+ +sock +

+Network socket used by the process +
+ +  +

CONTEXT

+ +

+ +The process which requests a UDP disconnection +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/udp.disconnect.return.3stap.html b/man/udp.disconnect.return.3stap.html new file mode 100644 index 00000000..994dd793 --- /dev/null +++ b/man/udp.disconnect.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of UDP\&.DISCONNECT\&.R + +

UDP\&.DISCONNECT\&.R

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +udp.disconnect.return - UDP has been disconnected successfully +  +

SYNOPSIS

+ +

+

+udp.disconnect.return 
+
+ +  +

VALUES

+ +

+ +ret +

+Error code (0: no error) +
+ +

+ +name +

+The name of this probe +
+ +  +

CONTEXT

+ +

+ +The process which requested a UDP disconnection +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/udp.recvmsg.3stap.html b/man/udp.recvmsg.3stap.html new file mode 100644 index 00000000..1bc7b7b6 --- /dev/null +++ b/man/udp.recvmsg.3stap.html @@ -0,0 +1,93 @@ + +Manpage of UDP\&.RECVMSG + +

UDP\&.RECVMSG

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +udp.recvmsg - Fires whenever a UDP message is received +  +

SYNOPSIS

+ +

+

+udp.recvmsg 
+
+ +  +

VALUES

+ +

+ +name +

+The name of this probe +
+ +

+ +size +

+Number of bytes received by the process +
+ +

+ +sock +

+Network socket used by the process +
+ +  +

CONTEXT

+ +

+ +The process which received a UDP message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/udp.recvmsg.return.3stap.html b/man/udp.recvmsg.return.3stap.html new file mode 100644 index 00000000..e5c9da6a --- /dev/null +++ b/man/udp.recvmsg.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of UDP\&.RECVMSG\&.RETU + +

UDP\&.RECVMSG\&.RETU

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +udp.recvmsg.return - Fires whenever an attempt to receive a UDP message received is completed +  +

SYNOPSIS

+ +

+

+udp.recvmsg.return 
+
+ +  +

VALUES

+ +

+ +name +

+The name of this probe +
+ +

+ +size +

+Number of bytes received by the process +
+ +  +

CONTEXT

+ +

+ +The process which received a UDP message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/udp.sendmsg.3stap.html b/man/udp.sendmsg.3stap.html new file mode 100644 index 00000000..2717e14d --- /dev/null +++ b/man/udp.sendmsg.3stap.html @@ -0,0 +1,93 @@ + +Manpage of UDP\&.SENDMSG + +

UDP\&.SENDMSG

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +udp.sendmsg - Fires whenever a process sends a UDP message +  +

SYNOPSIS

+ +

+

+udp.sendmsg 
+
+ +  +

VALUES

+ +

+ +name +

+The name of this probe +
+ +

+ +size +

+Number of bytes sent by the process +
+ +

+ +sock +

+Network socket used by the process +
+ +  +

CONTEXT

+ +

+ +The process which sent a UDP message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/udp.sendmsg.return.3stap.html b/man/udp.sendmsg.return.3stap.html new file mode 100644 index 00000000..59f4b0c9 --- /dev/null +++ b/man/udp.sendmsg.return.3stap.html @@ -0,0 +1,86 @@ + +Manpage of UDP\&.SENDMSG\&.RETU + +

UDP\&.SENDMSG\&.RETU

+Section: Networking Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +udp.sendmsg.return - Fires whenever an attempt to send a UDP message is completed +  +

SYNOPSIS

+ +

+

+udp.sendmsg.return 
+
+ +  +

VALUES

+ +

+ +name +

+The name of this probe +
+ +

+ +size +

+Number of bytes sent by the process +
+ +  +

CONTEXT

+ +

+ +The process which sent a UDP message +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/uid.3stap.html b/man/uid.3stap.html new file mode 100644 index 00000000..7bb25945 --- /dev/null +++ b/man/uid.3stap.html @@ -0,0 +1,68 @@ + +Manpage of UID + +

UID

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +uid - Returns the user ID of a target process. +  +

SYNOPSIS

+ +

+

+    uid:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/user_mode.3stap.html b/man/user_mode.3stap.html new file mode 100644 index 00000000..69e9ac8d --- /dev/null +++ b/man/user_mode.3stap.html @@ -0,0 +1,77 @@ + +Manpage of USER_MODE + +

USER_MODE

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +user_mode - Determines if probe point occurs in user-mode. +  +

SYNOPSIS

+ +

+

+    user_mode:long()
+
+ +  +

ARGUMENTS

+ +

+ +None +  +

DESCRIPTION

+ +

+ +

+ +Return 1 if the probe point occurred in user-mode. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/usymdata.3stap.html b/man/usymdata.3stap.html new file mode 100644 index 00000000..b6e2cde6 --- /dev/null +++ b/man/usymdata.3stap.html @@ -0,0 +1,79 @@ + +Manpage of USYMDATA + +

USYMDATA

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +usymdata - Return the symbol and module offset of an address. EXPERIMENTAL! +  +

SYNOPSIS

+ +

+

+    usymdata:string(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+The address to translate. +
+ +  +

DESCRIPTION

+ +

+ +Returns the (function) symbol name associated with the given address in the current task if known, plus the module name (between brackets) and the offset inside the module (shared library), plus the size of the symbol function. 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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/usymname.3stap.html b/man/usymname.3stap.html new file mode 100644 index 00000000..a3591c33 --- /dev/null +++ b/man/usymname.3stap.html @@ -0,0 +1,79 @@ + +Manpage of USYMNAME + +

USYMNAME

+Section: Context Functions (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +usymname - Return the symbol of an address in the current task. EXPERIMENTAL! +  +

SYNOPSIS

+ +

+

+    usymname:string(addr:long)
+
+ +  +

ARGUMENTS

+ +

+ +addr +

+The address to translate. +
+ +  +

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. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.brk.3stap.html b/man/vm.brk.3stap.html new file mode 100644 index 00000000..c4f19ee8 --- /dev/null +++ b/man/vm.brk.3stap.html @@ -0,0 +1,86 @@ + +Manpage of VM\&.BRK + +

VM\&.BRK

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.brk - Fires when a <command>brk</command> is requested (i.e. the heap will be resized). +  +

SYNOPSIS

+ +

+

+vm.brk 
+
+ +  +

VALUES

+ +

+ +length +

+The length of the memory segment +
+ +

+ +address +

+The requested address +
+ +  +

CONTEXT

+ +

+ +The process calling <command>brk</command>. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.mmap.3stap.html b/man/vm.mmap.3stap.html new file mode 100644 index 00000000..bbc49a72 --- /dev/null +++ b/man/vm.mmap.3stap.html @@ -0,0 +1,86 @@ + +Manpage of VM\&.MMAP + +

VM\&.MMAP

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.mmap - Fires when an <command>mmap</command> is requested. +  +

SYNOPSIS

+ +

+

+vm.mmap 
+
+ +  +

VALUES

+ +

+ +length +

+The length of the memory segment +
+ +

+ +address +

+The requested address +
+ +  +

CONTEXT

+ +

+ +The process calling <command>mmap</command>. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.munmap.3stap.html b/man/vm.munmap.3stap.html new file mode 100644 index 00000000..400f1653 --- /dev/null +++ b/man/vm.munmap.3stap.html @@ -0,0 +1,86 @@ + +Manpage of VM\&.MUNMAP + +

VM\&.MUNMAP

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.munmap - Fires when an <command>munmap</command> is requested. +  +

SYNOPSIS

+ +

+

+vm.munmap 
+
+ +  +

VALUES

+ +

+ +length +

+The length of the memory segment +
+ +

+ +address +

+The requested address +
+ +  +

CONTEXT

+ +

+ +The process calling <command>munmap</command>. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.oom_kill.3stap.html b/man/vm.oom_kill.3stap.html new file mode 100644 index 00000000..b2d7a140 --- /dev/null +++ b/man/vm.oom_kill.3stap.html @@ -0,0 +1,79 @@ + +Manpage of VM\&.OOM_KILL + +

VM\&.OOM_KILL

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.oom_kill - Fires when a thread is selected for termination by the OOM killer. +  +

SYNOPSIS

+ +

+

+vm.oom_kill 
+
+ +  +

VALUES

+ +

+ +task +

+The task being killed +
+ +  +

CONTEXT

+ +

+ +The process that tried to consume excessive memory, and thus triggered the OOM. <remark>(is this correct?)</remark> +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.pagefault.3stap.html b/man/vm.pagefault.3stap.html new file mode 100644 index 00000000..ffd43cb4 --- /dev/null +++ b/man/vm.pagefault.3stap.html @@ -0,0 +1,86 @@ + +Manpage of VM\&.PAGEFAULT + +

VM\&.PAGEFAULT

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.pagefault - Records that a page fault occurred. +  +

SYNOPSIS

+ +

+

+vm.pagefault 
+
+ +  +

VALUES

+ +

+ +write_access +

+Indicates whether this was a write or read access; <command>1</command> indicates a write, while <command>0</command> indicates a read. +
+ +

+ +address +

+The address of the faulting memory access; i.e. the address that caused the page fault. +
+ +  +

CONTEXT

+ +

+ +The process which triggered the fault +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.pagefault.return.3stap.html b/man/vm.pagefault.return.3stap.html new file mode 100644 index 00000000..e6e30f10 --- /dev/null +++ b/man/vm.pagefault.return.3stap.html @@ -0,0 +1,72 @@ + +Manpage of VM\&.PAGEFAULT\&.RET + +

VM\&.PAGEFAULT\&.RET

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.pagefault.return - Indicates what type of fault occurred. +  +

SYNOPSIS

+ +

+

+vm.pagefault.return 
+
+ +  +

VALUES

+ +

+ +fault_type +

+Returns either <command>0</command> (VM_FAULT_OOM) for out of memory faults, <command>2</command> (VM_FAULT_MINOR) for minor faults, <command>3</command> (VM_FAULT_MAJOR) for major faults, or <command>1</command> (VM_FAULT_SIGBUS) if the fault was neither OOM, minor fault, nor major fault. +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.write_shared.3stap.html b/man/vm.write_shared.3stap.html new file mode 100644 index 00000000..cf5172ed --- /dev/null +++ b/man/vm.write_shared.3stap.html @@ -0,0 +1,86 @@ + +Manpage of VM\&.WRITE_SHARED + +

VM\&.WRITE_SHARED

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.write_shared - Attempts at writing to a shared page. +  +

SYNOPSIS

+ +

+

+vm.write_shared 
+
+ +  +

VALUES

+ +

+ +address +

+The address of the shared write. +
+ +  +

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 <command>vm.write_shared_copy</command>. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm.write_shared_copy.3stap.html b/man/vm.write_shared_copy.3stap.html new file mode 100644 index 00000000..65f62954 --- /dev/null +++ b/man/vm.write_shared_copy.3stap.html @@ -0,0 +1,93 @@ + +Manpage of VM\&.WRITE_SHARED_CO + +

VM\&.WRITE_SHARED_CO

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm.write_shared_copy - Page copy for shared page write. +  +

SYNOPSIS

+ +

+

+vm.write_shared_copy 
+
+ +  +

VALUES

+ +

+ +zero +

+Boolean indicating whether it is a zero page (can do a clear instead of a copy). +
+ +

+ +address +

+The address of the shared write. +
+ +  +

CONTEXT

+ +

+ +The process attempting the write. +  +

DESCRIPTION

+ +

+ +Fires when a write to a shared page requires a page copy. This is always preceded by a <command>vm.shared_write</command>. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
VALUES
+
CONTEXT
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/vm_fault_contains.3stap.html b/man/vm_fault_contains.3stap.html new file mode 100644 index 00000000..4de292fc --- /dev/null +++ b/man/vm_fault_contains.3stap.html @@ -0,0 +1,79 @@ + +Manpage of VM_FAULT_CONTAINS + +

VM_FAULT_CONTAINS

+Section: Memory Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +vm_fault_contains - Test return value for page fault reason +  +

SYNOPSIS

+ +

+

+    vm_fault_contains:long(value:long,test:long)
+
+ +  +

ARGUMENTS

+ +

+ +value +

+The fault_type returned by vm.page_fault.return +
+ +

+ +test +

+The type of fault to test for (VM_FAULT_OOM or similar) +
+ +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + diff --git a/man/warn.3stap.html b/man/warn.3stap.html new file mode 100644 index 00000000..b7c29a86 --- /dev/null +++ b/man/warn.3stap.html @@ -0,0 +1,80 @@ + +Manpage of WARN + +

WARN

+Section: Logging Tapset (3stap)
Updated: September 2009
Index +Return to Main Contents
+ + + + + + + + + + + +  +

NAME

+ +warn - Send a line to the warning stream. +  +

SYNOPSIS

+ +

+

+    warn(msg:string)
+
+ +  +

ARGUMENTS

+ +

+ +msg +

+The formatted message string. +
+ +  +

DESCRIPTION

+ +

+ +An implicit end-of-line is added. staprun prepends the string +lqWARNING:rq. +  +

AUTHOR

+ +

+ +SystemTap +

+Hackers +
+ +  +

COPYRIGHT

+ +
+ +

+ +


+ 

Index

+
+
NAME
+
SYNOPSIS
+
ARGUMENTS
+
DESCRIPTION
+
AUTHOR
+
COPYRIGHT
+
+
+This document was created by +man2html, +using the manual pages.
+Time: 19:56:13 GMT, September 28, 2009 + + -- 2.43.5