slabtop.1

   1 .\" slabtop.1 - manpage for the slabtop(1) utility, part of procps
   2 .\"
   3 .\" Copyright (C) 2003 Chris Rivera
   4 .\" Licensed under the terms of the GNU Library General Public License, v2
   5 .TH SLABTOP 1 "13 Sep 2003" "Linux" "Linux User's Manual"
   6 .SH NAME
   7 slabtop \- display kernel slab cache information in real time
   8
   9 .SH SYNOPSIS
  10 .BI "slabtop [ " options " ] "
  11
  12 .SH DESCRIPTION
  13 .BR slabtop (1)
  14 displays detailed kernel slab cache information in real time.  It displays a
  15 listing of the top caches sorted by one of the listed sort criteria.  It also
  16 displays a statistics header filled with slab layer information.
  17
  18 .SH OPTIONS
  19 Normal invocation of
  20 .BR slabtop (1)
  21 does not require any options.  The behavior, however, can be fine-tuned by
  22 specifying one or more of the following flags:
  23 .TP
  24 .B \-\^\-delay=n, \-d n
  25 Refresh the display every n seconds.  By default,
  26 .BR slabtop (1)
  27 refreshes the display every three seconds.  To exit the program, hit
  28 .BR q.
  29 .TP
  30 .B \-\^\-sort=S, \-s S
  31 Sort by S, where S is one of the sort criteria.
  32 .TP
  33 .B \-\^\-once, \-o
  34 Display the output once and then exit.
  35 .TP
  36 .B \-\^\-version, \-V
  37 Display version information and exit.
  38 .TP
  39 .B \-\^\-help
  40 Display usage information and exit.
  41
  42 .SH SORT CRITERIA
  43 The following are valid sort criteria used to sort the individual slab caches
  44 and thereby determine what are the "top" slab caches to display.  The default
  45 sort criteria is to sort by the number of objects ("o").
  46
  47 The sort criteria can also be changed while slabtop is running by pressing
  48 the associated character.
  49 .TP
  50 .BR a:
  51 sort by number of active objects
  52 .TP
  53 .BR b:
  54 sort by objects per slab
  55 .TP
  56 .BR c:
  57 sort by cache size
  58 .TP
  59 .BR l:
  60 sort by number of slabs
  61 .TP
  62 .BR v
  63 sort by number of active slabs
  64 .TP
  65 .BR n:
  66 sort by name
  67 .TP
  68 .BR o:
  69 sort by number of objects
  70 .TP
  71 .BR p:
  72 sort by pages per slab
  73 .TP
  74 .BR s:
  75 sort by object size
  76 .TP
  77 .BR u:
  78 sort by cache utilization
  79
  80 .SH COMMANDS
  81 .BR slabtop (1)
  82 accepts keyboard commands from the user during use.  The following are
  83 supported.  In the case of letters, both cases are accepted.
  84
  85 Each of the valid sort characters are also accepted, to change the sort
  86 routine. See the section
  87 .IR "SORT CRITERIA" .
  88
  89 .TP
  90 .BR <SPACEBAR>
  91 Refresh the screen.
  92 .TP
  93 .BR Q
  94 Quit the program.
  95
  96 .SH FILES
  97 .IR /proc/slabinfo " \-\- slab information"
  98
  99 .SH "SEE ALSO"
 100 .BR free (1),
 101 .BR ps (1),
 102 .BR top (1),
 103 .BR vmstat (8)
 104
 105 .SH NOTES
 106 Currently,
 107 .BR slabtop (1)
 108 requires a 2.4 or later kernel (specifically, a version 1.1 or later
 109 .IR /proc/slabinfo ).
 110 Kernel 2.2 should be supported in the future.
 111
 112 The slabtop statistic header is tracking how many bytes of slabs are being used
 113 and it not a measure of physical memory. The 'Slab' field in the /proc/meminfo
 114 file is tracking information about used slab physical memory.
 115
 116 .SH AUTHORS
 117 Written by Chris Rivera and Robert Love.
 118
 119 .BR slabtop (1)
 120 was inspired by Martin Bligh's perl script,
 121 .BR vmtop .
 122 The procps package is maintained by Albert Cahalan <albert@users.sf.net>.
 123
 124 Please send bug reports to <procps-feedback@lists.sf.net>.