create src/man/stapprobes.*.in for detailed stap probe points.

1 files changed, 11 insertions, 927 deletions

diff --git a/stapprobes.5.in b/stapprobes.5.in
index b40f21ae..1b892036 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -268,933 +268,6 @@ read_counter
 is a function that is passed the handle for the perfmon probe and returns
 the current count for the event.
 
-
-.SS IO SCHEDULER
-
-This family of probe points is used to probe the IO scheduler activities.
-It contains the following probe points:
-
-.P
-.TP 
-.B ioscheduler.elv_next_request
-Fires when a request is retrieved from request queue
-
-.B Arguments:
-
-.I elevator_name
-  The name of the elevator
-
-.I disk_major
-  The major number of the disk
-
-.I disk_minor
-  The minor number of the disk
-
-.P
-.TP 
-.B ioscheduler.elv_add_request
-Fires when a request is added to the request queue
-
-.B Arguments:
-
-.I elevator_name
-  The name of the elevator
-
-.I disk_major
-  The major number of the disk
-
-.I disk_minor
-  The minor number of the disk
-
-.P
-.TP 
-.B ioscheduler.elv_completed_request
-Fires when a request is completed
-
-.B Arguments:
-
-.I elevator_name
-  The name of the elevator
-
-.I disk_major
-  The major number of the disk
-
-.I disk_minor
-  The minor number of the disk
-
-.SS SCSI
-
-This family of probe points is used to probe the SCSI activities.
-It contains the following probe points:
-
-.P
-.TP 
-.B scsi.ioentry
-Fires when SCSI mid layer prepares a SCSI request
-
-.B Arguments:
-
-.I disk_major
-  The major number of the disk
-
-.I disk_minor
-  The minor number of the disk
-
-.I device_state
-  The current state of the device. The possible values could be:
-
-        SDEV_CREATED = 1,    /* device created but not added to sysfs
-                              * Only internal commands allowed (for inq) */
-        SDEV_RUNNING = 2,    /* device properly configured
-                              * All commands allowed */
-        SDEV_CANCEL = 3,     /* beginning to delete device
-                              * Only error handler commands allowed */
-        SDEV_DEL = 4,        /* device deleted
-                              * no commands allowed */
-        SDEV_QUIESCE = 5,    /* Device quiescent.  No block commands
-                              * will be accepted, only specials (which
-                              * originate in the mid-layer) */
-        SDEV_OFFLINE = 6,    /* Device offlined (by error handling or
-                              * user request */
-        SDEV_BLOCK = 7,      /* Device blocked by scsi lld.  No scsi
-                              * commands from user or midlayer should be issued
-                              * to the scsi lld. */
-
-.P
-.TP 
-.B scsi.iodispatching
-Fires when the SCSI mid layer dispatches a SCSI command to the low level driver
-
-.B Arguments:
-
-.I host_no
-  The host number
-
-.I channel
-  The channel number
-
-.I lun
-  The lun number
-
-.I dev_id
-  The scsi device id
-
-.I device_state
-  The current state of the device. 
-
-.I data_direction
-  The data_direction specifies whether this command is from/to the device.
-  The possible values could be:
-
-        DMA_BIDIRECTIONAL = 0,
-        DMA_TO_DEVICE = 1,
-        DMA_FROM_DEVICE = 2,
-        DMA_NONE = 3,
-
-.I request_buffer
-  The request buffer address
-
-.I req_bufflen
-  The request buffer length
-
-.P
-.TP 
-.B scsi.iodone
-Fires when a SCSI command is done by low level driver and enqueued into the done queue.
-
-.B Arguments:
-
-.I host_no
-  The host number
-
-.I channel
-  The channel number
-
-.I lun
-  The lun number
-
-.I dev_id
-  The scsi device id
-
-.I device_state
-  The current state of the device
-
-.I data_direction
-  The data_direction specifies whether this command is from/to the device.
-
-.P
-.TP 
-.B scsi.iocompleted
-Fires when SCSI mid layer runs the completion processing for 
-block device I/O requests
-
-.B Arguments:
-
-.I host_no
-  The host number
-
-.I channel
-  The channel number
-
-.I lun
-  The lun number
-
-.I dev_id
-  The scsi device id
-
-.I device_state
-  The current state of the device
-
-.I data_direction
-  The data_direction specifies whether this command is from/to the device.
-
-.I goodbytes
-  The bytes completed.
-
-
-.SS NETWORK DEVICE
-
-This family of probe points is used to probe the activities of network
-device. 
-It contains the following probe points:
-
-.P
-.TP 
-.B netdev.receive
-Fires when data arrives on network device
-
-.B Arguments:
-
-.I dev_name
-  The name of the device. e.g: eth0, ath1
-
-.I length
-  The length of the receiving buffer
-
-.I protocol
-  The possible values of protocol could be:
-     0800    IP
-     8100    802.1Q VLAN
-     0001    802.3
-     0002    AX.25
-     0004    802.2
-     8035    RARP
-     0005    SNAP
-     0805    X.25
-     0806    ARP
-     8137    IPX
-     0009    Localtalk
-     86DD    IPv6
-
-.I truesize
-  The size of the received data
-
-.P
-.TP 
-.B netdev.transmit
-Fires when the network device wants to transmit a buffer
-
-.B Arguments:
-
-.I dev_name
-  The name of the device. e.g: eth0, ath1
-
-.I length
-  The length of the transmit buffer
-
-.I protocol
-  The protocol of this packet.
-
-.I truesize
-  The size of the the data to be transmitted.
-
-.SS PAGE FAULT
-
-This family of probe points is used to probe page fault events.
-It contains the following probe points:
-
-.P
-.TP 
-.B vm.pagefault
-Fires when there is a pagefault
-
-.B Arguments:
-
-.I address
-  The address caused this page fault.
-
-.I write_access
-  1 means this is a write access and 0 means this is a read access
-
-.SS PROCESS
-
-This family of probe points is used to probe the process activities.
-It contains the following probe points:
-
-.P
-.TP 
-.B process.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 process.start
-
-Fires immediately before a new process begins execution.
-
-.B Arguments:
-
-.I N/A
-
-.P
-.TP
-.B process.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 process.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 process.exit
-
-Fires when a process terminates. This will always be followed by a
-process.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 process.release
-
-Fires when a process is released from the kernel. This always 
-follows a process.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
-
-.SS TCP
-
-This family of probe points is used to probe TCP layer activities.
-It contains the following probe points:
-
-.P
-.TP
-.B tcp.sendmsg
-
-Fires whenever sending a tcp message
-
-.B Arguments:
-
-.I sock
-  network socket
-
-.I size
-  number of bytes to send
-
-.P
-.TP
-.B tcp.sendmsg.return
-
-Fires whenever sending message is done
-
-.B Arguments:
-
-.I size
-  number of bytes sent
-
-.P
-.TP
-.B tcp.recvmsg
-
-Fires whenever a message is received
-
-.B Arguments:
-
-.I sock
-  network socket
-
-.I size
-  number of bytes to be received
-
-.P
-.TP
-.B tcp.recvmsg.return
-
-Fires whenever message receiving is done
-
-.B Arguments:
-
-.I size
-  number of bytes received
-
-.P
-.TP
-.B tcp.disconnect
-
-Fires whenever tcp is disconnected
-
-.B Arguments:
-
-.I sock
-  network socket
-
-.I flags
-  TCP flags (e.g. FIN, etc)
-
-.P
-.TP
-.B tcp.disconnect.return
-
-Fires when returning from tcp.disconnect
-
-.B Arguments:
-
-.I ret
-  error code (0: no error)
-
-
-.SS UDP
-
-This family of probe points is used to probe UDP layer activities.
-It contains the following probe points:
-
-.P
-.TP
-.B udp.sendmsg
-
-Fires whenever sending a udp message
-
-.B Arguments:
-
-.I sock
-  network socket
-
-.I size
-  number of bytes to send
-
-.P
-.TP
-.B udp.sendmsg.return
-
-Fires whenever sending message is done
-
-.B Arguments:
-
-.I size
-  number of bytes sent
-
-.P
-.TP
-.B udp.recvmsg
-
-Fires whenever a message is received
-
-.B Arguments:
-
-.I sock
-  network socket
-
-.I size
-  number of bytes to be received
-
-.P
-.TP
-.B udp.recvmsg.return
-
-Fires whenever message receiving is done
-
-.B Arguments:
-
-.I size
-  number of bytes received
-
-.P
-.TP
-.B udp.disconnect
-
-Fires whenever udp is disconnected
-
-.B Arguments:
-
-.I sock
-  network socket
-
-.I flags
-  flags (e.g. FIN, etc)
-
-.P
-.TP
-.B udp.disconnect.return
-
-Fires when returning from udp.disconnect
-
-.B Arguments:
-
-.I ret
-  error code (0: no error)
-
-.SS SIGNAL
-
-This family of probe points is used to probe signal activities.
-It contains the following probe points:
-
-.P
-.TP
-.B signal.send
-
-Fires when a signal is sent to a process
-
-.B Arguments:
-
-.I sig
-  signal number
-
-.I sig_name
-  a string representation of the signal
-
-.I sig_pid
-  pid of the signal recipient process
-
-.I pid_name
-  name of the signal recipient process
-
-.I si_code
-  indicates the signal type
-
-.I task
-  a task handle to the signal recipient
-
-.I sinfo
-  the address of siginfo struct
-
-.I shared
-  indicates whether this signal is shared by the thread group
-
-.I send2queue
-  indicates whether this signal is sent to an existing sigqueue
-
-.I name
-  name of the function used to send out this signal
-
-.P
-.TP
-.B signal.send.return
-
-Fires when return from sending a signal
-
-.B Arguments:
-
-.I retstr
-  the return value
-
-  Return values for "__group_send_sig_info" and "specific_send_sig_info"
-
-.RS
-.RS
-- return 0 if the signal is sucessfully sent to a process, 
-which means the following:
-
-<1> the signal is ignored by receiving process
-
-<2> this is a non-RT signal and we already have one queued
-
-<3> the signal is successfully added into the sigqueue of receiving process
-
-- return \-EAGAIN if the sigqueue is overflow the signal was RT and sent 
-by user using something other than kill()
-.RE
-
-  Return values for "send_group_sigqueue"
-
-.RS
-- return 0 if the signal is either sucessfully added into the
-sigqueue of receiving process or a SI_TIMER entry is already
-queued so just increment the overrun count
-
-- return 1 if this signal is ignored by receiving process
-.RE
-
-  Return values for "send_sigqueue"
-
-.RS
-- return 0 if the signal is either sucessfully added into the
-sigqueue of receiving process or a SI_TIMER entry is already
-queued so just increment the overrun count
-
-- return 1 if this signal is ignored by receiving process
-
-- return \-1 if the task is marked exiting, so posix_timer_event
-can redirect it to the group leader
-.RE
-
-.I shared
-  indicates whether this signal is shared by the thread group
-
-.I send2queue
-  indicates whether this signal is sent to an existing sigqueue
-
-.I name
-  name of the function used to send out this signal
-
-
-.RE
-.RE
-.P
-.TP
-.B signal.checkperm
-
-Fires when check permissions for sending the signal
-
-.B Arguments:
-
-.I sig
-  the number of the signal
-
-.I sig_name
-  a string representation of the signal
-
-.I sig_pid
-  pid of the signal recipient process
-
-.I pid_name
-  name of the signal recipient process
-
-.I si_code
-  indicates the signal type
-
-.I task
-  a task handle to the signal recipient
-
-.I sinfo
-  the address of siginfo struct
-
-.I name
-  name of the probe point, is set to "signal.checkperm"
-
-.P
-.TP
-.B signal.checkperm.return
-
-Fires when return from permissions check for sending a signal
-
-.B Arguments:
-
-.I retstr
-  the return value
-
-.I name
-  name of the probe point, is set to "signal.checkperm"
-
-.P
-.TP
-.B signal.wakeup
-
-Fires when wake up the process for new active signals
-
-.B Arguments:
-
-.I sig_pid
-  pid of the process to be woke up
-
-.I pid_name
-  name of the process to be woke up
-
-.I resume
-  indicate whether to wake up a task in STOPPED or TRACED state
-
-.I state_mask
-  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.
-
-.P
-.TP
-.B signal.check_ignored
-
-Fires when check whether the signal is ignored or not
-
-.B Arguments:
-
-.I sig_pid
-  pid of the signal recipient process
-
-.I pid_name
-  name of the signal recipient process
-
-.I sig
-  the signal to be checked
-
-.I sig_name
-  name of the signal
-
-.P
-.TP
-.B signal.check_ignored.return
-
-Fires when return from signal.check_ignored
-
-.B Arguments:
-
-.I retstr
-  return value. 0 indicate the current signal isn't ignored.
-
-.P
-.TP
-.B signal.force_segv
-
-Forces SIGSEGV when there are some issues while handling 
-signals for the process 
-
-.B Arguments:
-
-.I sig_pid
-  pid of the signal recipient process
-
-.I pid_name
-  name of the signal recipient process
-
-.I sig
-  the signal being handled
-
-.I sig_name
-  name of this signal
-
-.P
-.TP
-.B signal.force_segv.return
-
-Fires when return from signal.force_segv
-
-.B Arguments:
-
-.I retstr
-  return value. Always return 0
-
-.P
-.TP
-.B signal.send_sig_queue
-
-Fires when queue a signal to a process
-
-.B Arguments:
-
-.I sig
-  the signal to be queued
-
-.I sig_name
-  name of this signal
-
-.I sig_pid
-  pid of the process to which the signal is queued
-
-.I pid_name
-  name of the process  to which the signal is queued
-
-.I sigqueue_addr
-  address of the signal queue
-
-.P
-.TP
-.B signal.send_sig_queue.return
-
-Fires when return from signal.send_sig_queue
-
-.B Arguments:
-
-.I retstr
-  return value
-
-.P
-.TP
-.B signal.pending
-
-Fires when examine the set of signals that are 
-pending for delivery to the calling thread
-
-.B Arguments:
-
-.I sigset_add
-  address of user space sigset_t
-
-.I sigset_size
-  sigset size
-
-.P
-.TP
-.B signal.pending.return
-
-Fires when return from signal.pending
-
-.B Arguments:
-
-.I retstr
-  return value
-
-.P
-.TP
-.B signal.handle
-
-Fires when invoking the signal handler
-
-.B Arguments:
-
-.I sig
-  signal number
-
-.I sig_name
-  signal name
-
-.I sinfo
-  address of siginfo struct
-
-.I sig_code
-  the si_code of siginfo
-
-.I ka_addr
-  Address of the k_sigaction struct associated with the signal
-
-.I oldset_addr
-  Address of a bit mask array of blocked signals
-
-.I sig_mode
-  indicates whether the signal is a User Mode or Kernel mode Signal
-
-.P
-.TP
-.B signal.handle.return
-
-Fires when return from signal.handle
-
-.B Arguments:
-
-.I retstr
-  return value of handle_signal()
-
-.P
-.TP
-.B signal.do_action
-
-Fires by calling thread to examine and change a signal action
- 
-.B Arguments:
-
-.I sig
-  signal number
-
-.I sigact_addr
-  address of the new sigaction struct associated with the signal
-
-.I oldsigact_addr
-  address of a previous sigaction struct associated with the signal
-
-.I sa_handler
-  the new handler of the signal
-
-.I sa_mask
-  the new mask of the signal
-
-.P
-.TP
-.B signal.do_action.return
-
-Fires when return from signal.do_action
-
-.B Arguments:
-
-.I retstr
-  return value of do_sigaction()
-
-.P
-.TP
-.B signal.procmask
-
-Fires by calling thread to examine and change blocked signals
-
-.B Arguments:
-
-.I how
-  indicates how to change the blocked signals. 
-  Possible values are:
-    SIG_BLOCK=0 for blocking signals
-    SIG_UNBLOCK=1 for unblocking signals
-    SIG_SETMASK=2 for setting the signal mask
-
-.I sigset_addr
-  address of sigset_t to be set
-
-.I oldsigset_addr
-  address of the old sigset_t
-
-.I sigset
-  the actual sigset to be set
-
-.P
-.TP
-.B signal.procmask.return
-
-Fires when return from signal.procmask
-
-.B Arguments:
-
-.I retstr
-  return value of sigprocmask()
-
-.P
-.TP
-.B signal.flush
-
-Fires when flush all pending signals for a task
-
-.B Arguments:
-
-.I task
-  the task handler of the process
-
-.I sig_pid
-  pid of the task
-
-.I pid_name
-  name of the task
-
 .SH EXAMPLES
 .PP
 Here are some example probe points, defining the associated events.
@@ -1230,5 +303,16 @@ refers to the group of probe aliases with any name in the third position
 
 .SH SEE ALSO
 .IR stap (1),
+.IR stapprobes.iosched (5),
+.IR stapprobes.netdev (5),
+.IR stapprobes.nfs (5),
+.IR stapprobes.nfsd (5),
+.IR stapprobes.pagefault (5),
+.IR stapprobes.process (5),
+.IR stapprobes.rpc (5),
+.IR stapprobes.scsi (5),
+.IR stapprobes.signal (5),
+.IR stapprobes.tcp (5),
+.IR stapprobes.udp (5),
 .IR lket (5)