summaryrefslogtreecommitdiffstats
path: root/man/tapset::kprocess.3stap
diff options
context:
space:
mode:
authorWilliam Cohen <wcohen@redhat.com>2010-03-09 19:53:52 -0500
committerWilliam Cohen <wcohen@redhat.com>2010-03-09 20:14:19 -0500
commitc24a9d9a9795fac838c4074494006e6e7e1e8835 (patch)
treeee5f4ddc417ae69ea707ad5f92550f8c91544c4e /man/tapset::kprocess.3stap
parentc0f562688ae877000f46058f748a8b986679863e (diff)
downloadsystemtap-steved-c24a9d9a9795fac838c4074494006e6e7e1e8835.tar.gz
systemtap-steved-c24a9d9a9795fac838c4074494006e6e7e1e8835.tar.xz
systemtap-steved-c24a9d9a9795fac838c4074494006e6e7e1e8835.zip
PR 11210 move stapprobe.* man pages to tapset::*
Complete the renaming scheme with prefix of "tapset::" for the man pages related to over all description of groups of probes.
Diffstat (limited to 'man/tapset::kprocess.3stap')
-rw-r--r--man/tapset::kprocess.3stap106
1 files changed, 106 insertions, 0 deletions
diff --git a/man/tapset::kprocess.3stap b/man/tapset::kprocess.3stap
new file mode 100644
index 00000000..231cae36
--- /dev/null
+++ b/man/tapset::kprocess.3stap
@@ -0,0 +1,106 @@
+.\" -*- nroff -*-
+.TH TAPSET::KPROCESS 3stap "" "Intel, IBM"
+.SH NAME
+tapset::kprocess \- systemtap kernel process probe points
+
+.\" macros
+.de SAMPLE
+.br
+.RS
+.nf
+.nh
+..
+.de ESAMPLE
+.hy
+.fi
+.RE
+..
+
+.SH DESCRIPTION
+
+This family of probe points is used to probe the kernel's process activities.
+It contains the following probe points:
+
+.P
+.TP
+.B kprocess.create
+
+Fires whenever a new process is successfully created, either as a
+result of one of the fork syscall variants, or a new kernel thread.
+
+.B Arguments:
+
+.I task
+ a handle to the newly created process
+
+.I new_pid
+ pid of the newly created process
+
+.P
+.TP
+.B kprocess.start
+
+Fires immediately before a new process begins execution.
+
+.B Arguments:
+
+.I N/A
+
+.P
+.TP
+.B kprocess.exec
+
+Fires whenever a process attempts to exec to a new program
+
+.B Arguments:
+
+.I filename
+ the path to the new executable
+
+.P
+.TP
+.B kprocess.exec_complete
+
+Fires at the completion of an exec call
+
+.B Arguments:
+
+.I errno
+ the error number resulting from the exec
+
+.I success
+ a boolean indicating whether the exec was successful
+
+.P
+.TP
+.B kprocess.exit
+
+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.
+
+.B Arguments:
+
+.I code
+ the exit code of the process
+
+.P
+.TP
+.B kprocess.release
+
+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.
+
+.B Arguments:
+
+.I task
+ a task handle to the process being released
+
+.I pid
+ pid of the process being released
+
+.SH SEE ALSO
+.IR stap (1),
+.IR stapprobes (3stap)
+