cddl/contrib/dtracetoolkit/Man/man1m/pfilestat.1m

   1 .TH pfilestat 1m  "$Date:: 2007-08-05 #$" "USER COMMANDS"
   2 .SH NAME
   3 pfilestat \- show I/O latency break down by FD. Uses DTrace.
   4 .SH SYNOPSIS
   5 .B pfilestat [\-r|\-w] pid
   6 .SH DESCRIPTION
   7 This prints I/O statistics for each file descriptor within a process.
   8 In particular, the time break down during read() and write() events is
   9 measured.
  10
  11 Since this uses DTrace, only the root user or users with the
  12 dtrace_kernel privilege can run this command.
  13 .SH OS
  14 Solaris
  15 .SH STABILITY
  16 unstable - this script uses fbt provider probes which may change for
  17 future updates of the OS, invalidating this script. Please read
  18 Docs/Notes/ALLfbt_notes.txt for further details about these fbt scripts.
  19 .SH OPTIONS
  20 .TP
  21 \-r
  22 reads only
  23 .TP
  24 \-w
  25 writes only
  26 .TP
  27 pid
  28 process ID to examine
  29 .PP
  30 .SH EXAMPLES
  31 .TP
  32 Sample both read and write activity for PID 81,
  33 #
  34 .B pfilestat 81
  35 .TP
  36 Sample reads only for PID 81,
  37 #
  38 .B pfilestat
  39 \-r 81
  40 .PP
  41 .SH FIELDS
  42 .TP
  43 STATE
  44 microstate. see STATES below.
  45 .TP
  46 FDUM
  47 file Descriptor ID
  48 .TP
  49 Time
  50 percentage of wallclock time in each STATE
  51 .TP
  52 File
  53 Name of file, if known
  54 .PP
  55 .SH STATES
  56 .TP
  57 read
  58 Time spent during the execution of the read() syscall.
  59 .TP
  60 write
  61 Time spent during the execution of the write() syscall.
  62 .TP
  63 waitcpu
  64 Latency spent waiting to be scheduled after becoming runnable.
  65 .TP
  66 running
  67 Process running user-mode code.
  68 .TP
  69 sleep-r
  70 Process sleeping on reads.
  71 .TP
  72 sleep-w
  73 Process sleeping on writes.
  74 .PP
  75 .SH DOCUMENTATION
  76 pfilestat is discussed and demonstrated in Solaris Internals 2nd edition,
  77 volume 2.
  78
  79 See the DTraceToolkit for further documentation under the
  80 Docs directory. The DTraceToolkit docs may include full worked
  81 examples with verbose descriptions explaining the output.
  82 .SH EXIT
  83 pfilestat will sample until Ctrl\-C is hit.
  84 .SH AUTHOR
  85 Richard McDougall
  86 .SH SEE ALSO
  87 dtrace(1M)