]> granicus.if.org Git - procps-ng/blob - slabtop.1
top: refined memory graphs two abreast summary display <=== port of newlib 5c5bff39
[procps-ng] / 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
47 .B slabtop
48 is running by pressing the associated character.
49 .TS
50 l l l.
51 \fBcharacter    description     header\fR
52 a       number of active objects        ACTIVE
53 b       objects per slab        OBJ/SLAB
54 c       cache size      CACHE SIZE
55 l       number of slabs SLABS
56 v       number of active slabs  N/A
57 n       name    NAME\:
58 o       number of objects       OBJS
59 p       pages per slab  N/A
60 s       object size     OBJ SIZE
61 u       cache utilization       USE
62 .TE
63 .SH COMMANDS
64 .B slabtop
65 accepts keyboard commands from the user during use.  The following are
66 supported.  In the case of letters, both cases are accepted.
67 .PP
68 Each of the valid sort characters are also accepted, to change the sort
69 routine. See the section
70 .BR "SORT CRITERIA" .
71 .TP
72 .BR <SPACEBAR>
73 Refresh the screen.
74 .TP
75 .BR Q
76 Quit the program.
77 .SH FILES
78 .TP
79 .I /proc/slabinfo
80 slab information
81 .SH "SEE ALSO"
82 .BR free (1),
83 .BR ps (1),
84 .BR top (1),
85 .BR vmstat (8)
86 .SH NOTES
87 Currently,
88 .B slabtop
89 requires a 2.4 or later kernel (specifically, a version 1.1 or later
90 .IR /proc/slabinfo ).
91 Kernel 2.2 should be supported in the future.
92 .PP
93 The
94 .B slabtop
95 statistic header is tracking how many bytes of slabs are being
96 used and is not a measure of physical memory.  The 'Slab' field in the
97 /proc/meminfo file is tracking information about used slab physical memory.
98 .SH AUTHORS
99 Written by Chris Rivera and Robert Love.
100 .PP
101 .B slabtop
102 was inspired by Martin Bligh's perl script,
103 .BR vmtop .
104 .SH "REPORTING BUGS"
105 Please send bug reports to
106 .UR procps@freelists.org
107 .UE