user_namespaces.7: ffix

[thirdparty/man-pages.git] / man5 / slabinfo.5

diff --git a/man5/slabinfo.5 b/man5/slabinfo.5
index 07b8fceac94c9b0a99b2b29ca8290480f909f9c4..1dcf9fae1df012cf7d92dea24abc474b96320f76 100644 (file)
--- a/man5/slabinfo.5
+++ b/man5/slabinfo.5
@@ -1,5 +1,6 @@
 .\" Copyright (c) 2001 Andreas Dilger (adilger@turbolinux.com)
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -19,20 +20,32 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
-.TH SLABINFO 5 2001-06-19 "" "Linux manual"
+.\" FIXME Over time, the slabinfo format has gone through
+.\" version changes. These should be documented:
+.\"
+.\"     slabinfo 1.0 - Linux 2.2 (precisely: 2.1.23)
+.\"     slabinfo 1.1 - Linux 2.4 (precisely: 2.4.0-test3)
+.\"     slabinfo 1.2 - Linux 2.5.45
+.\"     slabinfo 2.0 - Linux 2.6 (precisely: 2.5.71)
+.\"     slabinfo 2.1 - Linux 2.6.10
+.\"
+.TH SLABINFO 5 2007-09-30 "" "Linux Programmer's Manual"
 .SH NAME
-/proc/slabinfo \- Kernel slab allocator statistics
+slabinfo \- kernel slab allocator statistics
 .SH SYNOPSIS
 .B cat /proc/slabinfo
 .SH DESCRIPTION
 Frequently used objects in the Linux kernel
 (buffer heads, inodes, dentries, etc.)
-have their own cache. The file
+have their own cache.
+The file
 .I /proc/slabinfo
-gives statistics. For example:
+gives statistics.
+For example:
 .LP
-.RS
+.in +4n
 .nf
 % cat /proc/slabinfo
 slabinfo \- version: 1.1
@@ -49,7 +62,7 @@ size-8192              1     17   8192    1   17    2
 size-4096             41     73   4096   41   73    1
 \&...
 .fi
-.RE
+.in
 .LP
 For each slab cache, the cache name, the number of currently
 active objects, the total number of available objects, the
@@ -58,8 +71,8 @@ least one active object, the total number of allocated pages,
 and the number of pages per slab are given.
 
 Note that because of object alignment and slab cache overhead,
-objects are not normally packed tightly into pages.  Pages with
-even one in-use object are considered in-use and cannot be
+objects are not normally packed tightly into pages.
+Pages with even one in-use object are considered in-use and cannot be
 freed.
 
 Kernels compiled with slab cache statistics will also have
@@ -70,16 +83,18 @@ the number of times the cache has grown (new pages added
 to this cache); the number of times the cache has been
 reaped (unused pages removed from this cache); and the
 number of times there was an error allocating new pages
-to this cache.  If slab cache statistics are not enabled
+to this cache.
+If slab cache statistics are not enabled
 for this kernel, these columns will not be shown.
 
 SMP systems will also have "(SMP)" in the first line of
 output, and will have two additional columns for each slab,
 reporting the slab allocation policy for the CPU-local
 cache (to reduce the need for inter-CPU synchronization
-when allocating objects from the cache).  The first column
-is the per-CPU limit: the maximum number of objects that
-will be cached for each CPU.  The second column is the
+when allocating objects from the cache).
+The first column is the per-CPU limit: the maximum number of objects that
+will be cached for each CPU.
+The second column is the
 batchcount: the maximum number of free objects in the
 global cache that will be transferred to the per-CPU cache
 if it is empty, or the number of objects to be returned
@@ -87,10 +102,12 @@ to the global cache if the per-CPU cache is full.
 
 If both slab cache statistics and SMP are defined, there
 will be four additional columns, reporting the per-CPU
-cache statistics.  The first two are the per-CPU cache
+cache statistics.
+The first two are the per-CPU cache
 allocation hit and miss counts: the number of times an
 object was or was not available in the per-CPU cache
-for allocation.  The next two are the per-CPU cache free
+for allocation.
+The next two are the per-CPU cache free
 hit and miss counts: the number of times a freed object
 could or could not fit within the per-CPU cache limit,
 before flushing objects to the global cache.
@@ -98,14 +115,20 @@ before flushing objects to the global cache.
 It is possible to tune the SMP per-CPU slab cache limit
 and batchcount via:
 
+.in +4n
 .nf
 echo "\fIcache_name limit batchcount\fP" > /proc/slabinfo
 .fi
-
-.SH AVAILABILITY
+.in
+.SH FILES
+.I <linux/slab.h>
+.SH VERSIONS
 .I /proc/slabinfo
 exists since Linux 2.1.23.
 SMP per-CPU caches exist since Linux 2.4.0-test3.
-
-.SH FILES
-.I <linux/slab.h>
+.SH NOTES
+Since Linux 2.6.16 the file
+.I /proc/slabinfo
+is present only if the
+.B CONFIG_SLAB
+kernel configuration option is enabled.