add the description of tapset/scsi.stp, tapset/ioscheduler.stp into stapprobes(5)

1 files changed, 182 insertions, 0 deletions

diff --git a/stapprobes.5.in b/stapprobes.5.in
index 90f746aa..85ebc0e3 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -230,6 +230,188 @@ named
 where NN is the number of parameters supplied by the macro.  Number
 and string parameters are passed in a type-safe manner.
 
+.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.
+
 .SH EXAMPLES
 .PP
 Here are some example probe points, defining the associated events.