fs_usage.tproj/fs_usage.1

   1 .\" Copyright (c) 2000, Apple Computer, Inc.  All rights reserved.
   2 .\"
   3 .Dd November 7, 2002
   4 .Dt FS_USAGE 1
   5 .Os "Mac OS X"
   6 .Sh NAME
   7 .Nm fs_usage
   8 .Nd report system calls and page faults related to filesystem activity in
   9 real-time
  10 .Sh SYNOPSIS
  11 .Nm fs_usage [-e] [-w] [-f mode] [ pid|cmd [pid|cmd] ...]
  12 .Sh DESCRIPTION
  13 The
  14 .Nm fs_usage
  15 utility presents an ongoing display of system call usage information
  16 pertaining to filesystem activity.
  17 It requires root privileges due to the kernel tracing facility it uses to
  18 operate.
  19 By default the activity monitored includes all system processes except the
  20 running
  21 .Nm fs_usage
  22 process, Terminal, telnetd, sshd, rlogind, tcsh, csh and sh.
  23 These defaults can be overridden such that output is limited to include or
  24 exclude a list of processes specified by the user.
  25 .Pp
  26 The output presented by
  27 .Nm fs_usage
  28 is formatted according to the size of your window.
  29 A narrow window will display fewer columns of data.
  30 Use a wide window for maximum data display.
  31 You may override the window formatting restrictions by forcing a wide display
  32 with the
  33 .Fl w
  34 option.
  35 In this case, the data displayed will wrap when the window is not wide enough.
  36 .Pp
  37 The options are as follows:
  38 .Bl -tag -width Ds
  39 .It Fl e
  40 Specifying the
  41 .Fl e
  42 option generates output that excludes sampling
  43 of the running fs_usage tool.
  44 If a list of process ids or commands is also given, then those processes are
  45 also excluded from the sampled output.
  46 .It Fl w
  47 Specifying the
  48 .Fl w
  49 option forces a wider, more detailed output, regardless of the window size.
  50 .It Fl f
  51 Specifying the
  52 .Fl f
  53 option turns on output filtering based on the
  54 .Pa mode
  55 provided.
  56 By default no filtering occurs.
  57 The supported modes are:
  58 .Pp
  59 .Pa  network
  60 Only network related output is displayed.
  61 .Pp
  62 .Pa filesys
  63 Only file system related output is displayed.
  64 .It  pid | cmd
  65 The sampled data can be limited to a list of process ids or commands.
  66 When a command name is given, all processes with that name will be sampled.
  67 Using the
  68 .Fl e
  69 option has the opposite effect, excluding sampled data relating to the given
  70 list of process ids or commands.
  71 .El
  72 .Pp
  73 If you set the DYLD_IMAGE_SUFFIX environment variable to
  74 .Dq Li _debug ,
  75 then an application will use the debug version of all libraries including the
  76 Carbon FileManager.
  77 See
  78 .Xr dyld 1 .
  79 When
  80 .Nm fs_usage
  81 is run against a Carbon Application launched in this environment, then the
  82 high level Carbon FileManager calls will be displayed bracketing the system
  83 calls that they are built on.
  84 .Pp
  85 The data columns displayed are as follows:
  86 .Bl -tag -width Ds
  87 .Pp
  88 .It TIMESTAMP
  89 TOD when call occurred.
  90 Wide mode will have millisecond granularity.
  91 .It CALL
  92 The name of the network or filesystem related call, page-in, page-out or physical disk access.
  93 .It FILE DESCRIPTOR
  94 Of the form F=x, x is a file descriptor.
  95 Depending on the type of system call, this will be either an input value or a
  96 return value.
  97 .It BYTE COUNT
  98 Of the form B=x, x is the number of bytes requested by the call.
  99 .It [ERRNO]
 100 On error, the errno is displayed in brackets.
 101 .It PATHNAME
 102 Pathname of the file accessed (up to the last 28 bytes).
 103 .It FAULT ADDRESS
 104 Of the form A=0xnnnnnnnn, where 0xnnnnnnnn is the address being faulted.
 105 .It DISK BLOCK NUMBER
 106 Of the form D=0xnnnnnnnn, where 0xnnnnnnnn is the block number of the physical
 107 disk block being read or written.
 108 .It OFFSET
 109 Of the form O=0xnnnnnnnn, where 0xnnnnnnnn is a file offset.
 110 .It SELECT RETURN
 111 Of the form S=x, x is the number of ready descriptors returned by the select()
 112 system call.
 113 If S=0, the time limit expired.
 114 .It TIME INTERVAL(W)
 115 The elapsed time spent in the system call.
 116 A
 117 .Sq Li W
 118 after the elapsed time indicates the process was scheduled out during this file
 119 activity.
 120 In this case, the elapsed time includes the wait time.
 121 .It PROCESS NAME
 122 The process that made the system call.
 123 .El
 124 .Pp
 125 .Sh SAMPLE USAGE
 126 .Pp
 127 fs_usage -w -f filesys Mail
 128 .Pp
 129 .Nm fs_usage
 130 will display file system related data for all instances of processes named Mail.
 131 Maximum data output will be displayed in the window.
 132 .Sh SEE ALSO
 133 .Xr top 1 ,
 134 .Xr sc_usage 1 ,
 135 .Xr latency 1 ,
 136 .Xr dyld 1