usr.sbin/pstat/pstat.8

   1 .\" Copyright (c) 1980, 1991, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)pstat.8     8.5 (Berkeley) 5/13/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd May 13, 1994
  36 .Dt PSTAT 8
  37 .Os
  38 .Sh NAME
  39 .Nm pstat ,
  40 .Nm swapinfo
  41 .Nd display system data structures
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl Tfiknstv
  45 .Op Fl M Ar core
  46 .Op Fl N Ar system
  47 .Pp
  48 .Nm swapinfo
  49 .Op Fl k
  50 .Op Fl M Ar core
  51 .Op Fl N Ar system
  52 .Sh DESCRIPTION
  53 .Nm Pstat
  54 displays open file entry, swap space utilization,
  55 terminal state, and vnode data structures.
  56 .Pp
  57 If invoked as
  58 .Nm swapinfo
  59 the
  60 .Fl s
  61 option is implied, and only the
  62 .Fl k
  63 option is legal.
  64 .Pp
  65 The following options are available:
  66 .Bl -tag -width indent
  67 .It Fl n
  68 Print devices out by major/minor instead of name.
  69 .It Fl k
  70 Print sizes in kilobytes, regardless of the setting of the
  71 .Ev BLOCKSIZE
  72 environment variable.
  73 .It Fl T
  74 Print the number of used and free slots in several system tables.
  75 This is useful for checking to see how large system tables have become
  76 if the system is under heavy load.
  77 .It Fl f
  78 Print the open file table with these headings:
  79 .Bl -tag -width indent
  80 .It LOC
  81 The core location of this table entry.
  82 .It TYPE
  83 The type of object the file table entry points to.
  84 .It FLG
  85 Miscellaneous state variables encoded thus:
  86 .Pp
  87 .Bl -tag -width indent -compact
  88 .It R
  89 open for reading
  90 .It W
  91 open for writing
  92 .It A
  93 open for appending
  94 .It I
  95 signal pgrp when data ready
  96 .El
  97 .It CNT
  98 Number of processes that know this open file.
  99 .It MSG
 100 Number of messages outstanding for this file.
 101 .It DATA
 102 The location of the vnode table entry or socket structure for this file.
 103 .It OFFSET
 104 The file offset (see
 105 .Xr lseek 2 ) .
 106 .El
 107 .It Fl s
 108 Print information about swap space usage on all the
 109 swap areas compiled into the kernel.
 110 The first column is the device name of the partition.  The next column is
 111 the total space available in the partition.  The
 112 .Ar Used
 113 column indicates the total blocks used so far;  the
 114 .Ar Available
 115 column indicates how much space is remaining on each partition.
 116 The
 117 .Ar Capacity
 118 reports the percentage of space used.
 119 .Pp
 120 If more than one partition is configured into the system, totals for all
 121 of the statistics will be reported in the final line of the report.
 122 .Pp
 123 If you supply the option again, as in
 124 .Fl ss ,
 125 the system will display a breakdown of the swap bitmap/radix-tree.
 126 .It Fl t
 127 Print table for terminals
 128 with these headings:
 129 .Bl -tag -width indent
 130 .It RAW
 131 Number of characters in raw input queue.
 132 .It CAN
 133 Number of characters in canonicalized input queue.
 134 .It OUT
 135 Number of characters in output queue.
 136 .It MODE
 137 See
 138 .Xr tty 4 .
 139 .It ADDR
 140 Physical device address.
 141 .It DEL
 142 Number of delimiters (newlines) in canonicalized input queue.
 143 .It COL
 144 Calculated column position of terminal.
 145 .It STATE
 146 Miscellaneous state variables encoded thus:
 147 .Pp
 148 .Bl -tag -width indent -compact
 149 .It T
 150 delay timeout in progress
 151 .It W
 152 waiting for open to complete
 153 .It O
 154 open
 155 .It F
 156 outq has been flushed during DMA
 157 .It C
 158 carrier is on
 159 .It c
 160 connection open
 161 .It B
 162 busy doing output
 163 .It A
 164 process is waiting for space in output queue
 165 .It a
 166 process is waiting for output to complete
 167 .It X
 168 open for exclusive use
 169 .It S
 170 output stopped (ixon flow control)
 171 .It m
 172 output stopped (carrier flow control)
 173 .It o
 174 output stopped (CTS flow control)
 175 .It d
 176 output stopped (DSR flow control)
 177 .It K
 178 input stopped
 179 .It Y
 180 send SIGIO for input events
 181 .It D
 182 state for lowercase
 183 .Ql \e
 184 work
 185 .It E
 186 within a
 187 .Ql \e.../
 188 for PRTRUB
 189 .It L
 190 next character is literal
 191 .It P
 192 retyping suspended input (PENDIN)
 193 .It N
 194 counting tab width, ignore FLUSHO
 195 .It l
 196 block mode input routine in use
 197 .It s
 198 i/o being snooped
 199 .It Z
 200 connection lost
 201 .El
 202 .It SESS
 203 Kernel address of the session structure.
 204 .It PGID
 205 Process group for which this is controlling terminal.
 206 .It DISC
 207 Line discipline;
 208 .Ql term
 209 for
 210 TTYDISC
 211 or
 212 .Ql ntty
 213 for
 214 NTTYDISC
 215 or
 216 .Ql tab
 217 for
 218 TABLDISC
 219 or
 220 .Ql slip
 221 for
 222 SLIPDISC
 223 or
 224 .Ql ppp
 225 for
 226 PPPDISC.
 227 .El
 228 .It Fl v
 229 (This option is no longer supported.)
 230 .Pp
 231 Print the active vnodes.  Each group of vnodes corresponding
 232 to a particular filesystem is preceded by a two line header.  The
 233 first line consists of the following:
 234 .Bd -ragged -offset indent
 235 .No *** MOUNT Em fstype from
 236 on
 237 .Em on fsflags
 238 .Ed
 239 .Pp
 240 where
 241 .Em fstype
 242 is one of
 243 .Em ufs , nfs , or pc ;
 244 .Em from
 245 is the filesystem is mounted from;
 246 .Em on
 247 is the directory
 248 the filesystem is mounted on; and
 249 .Em fsflags
 250 is a list
 251 of optional flags applied to the mount (see
 252 .Xr mount 8 ) .
 253 The second line is a header for the individual fields,
 254 the first part of which are fixed, and the second part are filesystem
 255 type specific.  The headers common to all vnodes are:
 256 .Bl -tag -width indent
 257 .It ADDR
 258 Location of this vnode.
 259 .It TYP
 260 File type.
 261 .It VFLAG
 262 A list of letters representing vnode flags:
 263 .Pp
 264 .Bl -tag -width indent -compact
 265 .It R
 266 .Dv VROOT
 267 .It T
 268 .Dv VTEXT
 269 .It S
 270 .Dv VSYSTEM
 271 .It t
 272 .Dv VISTTY
 273 .It L
 274 .Dv VXLOCK
 275 .It W
 276 .Dv VXWANT
 277 .It B
 278 .Dv VBWAIT
 279 .It V
 280 .Dv VOBJBUF
 281 .It C
 282 .Dv VCOPYONWRITE
 283 .It a
 284 .Dv VAGE
 285 .It l
 286 .Dv VOLOCK
 287 .It w
 288 .Dv VOWANT
 289 .It D
 290 .Dv VDOOMED
 291 .It F
 292 .Dv VFREE
 293 .It O
 294 .Dv VONWORKLST
 295 .It M
 296 .Dv VMOUNT
 297 .El
 298 .It USE
 299 The number of references to this vnode.
 300 .It HOLD
 301 The number of I/O buffers held by this vnode.
 302 .It FILEID
 303 The vnode fileid.
 304 In the case of
 305 .Em ufs
 306 this is the inode number.
 307 .It IFLAG
 308 Miscellaneous filesystem specific state variables encoded thus:
 309 .Bl -tag -width indent
 310 .It "For ufs:"
 311 .Pp
 312 .Bl -tag -width indent -compact
 313 .It L
 314 locked
 315 .It U
 316 update time
 317 .Pq Xr fs 5
 318 must be corrected
 319 .It A
 320 access time must be corrected
 321 .It C
 322 changed time must be corrected
 323 .It U
 324 modification time most be corrected
 325 .It M
 326 contains modifications
 327 .It R
 328 has a rename in progress
 329 .It H
 330 inode is on hash list
 331 .It L
 332 modified, but don't write key
 333 .El
 334 .It "For nfs:"
 335 .Bl -tag -width indent -compact
 336 .Pp
 337 .It W
 338 waiting for I/O buffer flush to complete
 339 .It P
 340 I/O buffers being flushed
 341 .It M
 342 locally modified data exists
 343 .It E
 344 an earlier write failed
 345 .It A
 346 special file accessed
 347 .It U
 348 special file updated
 349 .It C
 350 special file times changed
 351 .It L
 352 node is locked
 353 .It w
 354 someone wants to lock
 355 .El
 356 .El
 357 .It SIZ/RDEV
 358 Number of bytes in an ordinary file, or
 359 major and minor device of special file.
 360 .El
 361 .It Fl i
 362 Same as
 363 .Fl v ,
 364 present for backwards-compatibility.
 365 .It Fl M
 366 Extract values associated with the name list from the specified core
 367 instead of the default
 368 .Pa /dev/kmem .
 369 .It Fl N
 370 Extract the name list from the specified system instead of the default
 371 .Pa /kernel .
 372 .El
 373 .Sh FILES
 374 .Bl -tag -width /dev/memxxx -compact
 375 .It Pa /kernel
 376 namelist
 377 .It Pa /dev/mem
 378 default source of tables
 379 .El
 380 .Sh SEE ALSO
 381 .Xr ps 1 ,
 382 .Xr systat 1 ,
 383 .Xr stat 2 ,
 384 .Xr fs 5 ,
 385 .Xr iostat 8 ,
 386 .Xr vmstat 8
 387 .Rs
 388 .%T UNIX Implementation
 389 .%A K. Thompson
 390 .Re
 391 .Sh BUGS
 392 Does not understand
 393 .Tn NFS
 394 swap servers.
 395 .Sh HISTORY
 396 The
 397 .Nm
 398 command appeared in
 399 .Bx 4.0 .