slabtop.1

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