Documentation/vm/slub.txt

   1 Short users guide for SLUB
   2 --------------------------
   3
   4 The basic philosophy of SLUB is very different from SLAB. SLAB
   5 requires rebuilding the kernel to activate debug options for all
   6 slab caches. SLUB always includes full debugging but it is off by default.
   7 SLUB can enable debugging only for selected slabs in order to avoid
   8 an impact on overall system performance which may make a bug more
   9 difficult to find.
  10
  11 In order to switch debugging on one can add a option "slub_debug"
  12 to the kernel command line. That will enable full debugging for
  13 all slabs.
  14
  15 Typically one would then use the "slabinfo" command to get statistical
  16 data and perform operation on the slabs. By default slabinfo only lists
  17 slabs that have data in them. See "slabinfo -h" for more options when
  18 running the command. slabinfo can be compiled with
  19
  20 gcc -o slabinfo Documentation/vm/slabinfo.c
  21
  22 Some of the modes of operation of slabinfo require that slub debugging
  23 be enabled on the command line. F.e. no tracking information will be
  24 available without debugging on and validation can only partially
  25 be performed if debugging was not switched on.
  26
  27 Some more sophisticated uses of slub_debug:
  28 -------------------------------------------
  29
  30 Parameters may be given to slub_debug. If none is specified then full
  31 debugging is enabled. Format:
  32
  33 slub_debug=<Debug-Options>       Enable options for all slabs
  34 slub_debug=<Debug-Options>,<slab name>
  35                                 Enable options only for select slabs
  36
  37 Possible debug options are
  38         F               Sanity checks on (enables SLAB_DEBUG_FREE. Sorry
  39                         SLAB legacy issues)
  40         Z               Red zoning
  41         P               Poisoning (object and padding)
  42         U               User tracking (free and alloc)
  43         T               Trace (please only use on single slabs)
  44         -               Switch all debugging off (useful if the kernel is
  45                         configured with CONFIG_SLUB_DEBUG_ON)
  46
  47 F.e. in order to boot just with sanity checks and red zoning one would specify:
  48
  49         slub_debug=FZ
  50
  51 Trying to find an issue in the dentry cache? Try
  52
  53 <<<<<<< HEAD:Documentation/vm/slub.txt
  54         slub_debug=,dentry_cache
  55 =======
  56         slub_debug=,dentry
  57 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:Documentation/vm/slub.txt
  58
  59 to only enable debugging on the dentry cache.
  60
  61 Red zoning and tracking may realign the slab.  We can just apply sanity checks
  62 to the dentry cache with
  63
  64 <<<<<<< HEAD:Documentation/vm/slub.txt
  65         slub_debug=F,dentry_cache
  66 =======
  67         slub_debug=F,dentry
  68 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a:Documentation/vm/slub.txt
  69
  70 In case you forgot to enable debugging on the kernel command line: It is
  71 possible to enable debugging manually when the kernel is up. Look at the
  72 contents of:
  73
  74 /sys/kernel/slab/<slab name>/
  75
  76 Look at the writable files. Writing 1 to them will enable the
  77 corresponding debug option. All options can be set on a slab that does
  78 not contain objects. If the slab already contains objects then sanity checks
  79 and tracing may only be enabled. The other options may cause the realignment
  80 of objects.
  81
  82 Careful with tracing: It may spew out lots of information and never stop if
  83 used on the wrong slab.
  84
  85 Slab merging
  86 ------------
  87
  88 If no debug options are specified then SLUB may merge similar slabs together
  89 in order to reduce overhead and increase cache hotness of objects.
  90 slabinfo -a displays which slabs were merged together.
  91
  92 Slab validation
  93 ---------------
  94
  95 SLUB can validate all object if the kernel was booted with slub_debug. In
  96 order to do so you must have the slabinfo tool. Then you can do
  97
  98 slabinfo -v
  99
 100 which will test all objects. Output will be generated to the syslog.
 101
 102 This also works in a more limited way if boot was without slab debug.
 103 In that case slabinfo -v simply tests all reachable objects. Usually
 104 these are in the cpu slabs and the partial slabs. Full slabs are not
 105 tracked by SLUB in a non debug situation.
 106
 107 Getting more performance
 108 ------------------------
 109
 110 To some degree SLUB's performance is limited by the need to take the
 111 list_lock once in a while to deal with partial slabs. That overhead is
 112 governed by the order of the allocation for each slab. The allocations
 113 can be influenced by kernel parameters:
 114
 115 slub_min_objects=x              (default 4)
 116 slub_min_order=x                (default 0)
 117 slub_max_order=x                (default 1)
 118
 119 slub_min_objects allows to specify how many objects must at least fit
 120 into one slab in order for the allocation order to be acceptable.
 121 In general slub will be able to perform this number of allocations
 122 on a slab without consulting centralized resources (list_lock) where
 123 contention may occur.
 124
 125 slub_min_order specifies a minim order of slabs. A similar effect like
 126 slub_min_objects.
 127
 128 slub_max_order specified the order at which slub_min_objects should no
 129 longer be checked. This is useful to avoid SLUB trying to generate
 130 super large order pages to fit slub_min_objects of a slab cache with
 131 large object sizes into one high order page.
 132
 133 SLUB Debug output
 134 -----------------
 135
 136 Here is a sample of slub debug output:
 137
 138 ====================================================================
 139 BUG kmalloc-8: Redzone overwritten
 140 --------------------------------------------------------------------
 141
 142 INFO: 0xc90f6d28-0xc90f6d2b. First byte 0x00 instead of 0xcc
 143 INFO: Slab 0xc528c530 flags=0x400000c3 inuse=61 fp=0xc90f6d58
 144 INFO: Object 0xc90f6d20 @offset=3360 fp=0xc90f6d58
 145 INFO: Allocated in get_modalias+0x61/0xf5 age=53 cpu=1 pid=554
 146
 147 Bytes b4 0xc90f6d10:  00 00 00 00 00 00 00 00 5a 5a 5a 5a 5a 5a 5a 5a ........ZZZZZZZZ
 148   Object 0xc90f6d20:  31 30 31 39 2e 30 30 35                         1019.005
 149  Redzone 0xc90f6d28:  00 cc cc cc                                     .
 150  Padding 0xc90f6d50:  5a 5a 5a 5a 5a 5a 5a 5a                         ZZZZZZZZ
 151
 152   [<c010523d>] dump_trace+0x63/0x1eb
 153   [<c01053df>] show_trace_log_lvl+0x1a/0x2f
 154   [<c010601d>] show_trace+0x12/0x14
 155   [<c0106035>] dump_stack+0x16/0x18
 156   [<c017e0fa>] object_err+0x143/0x14b
 157   [<c017e2cc>] check_object+0x66/0x234
 158   [<c017eb43>] __slab_free+0x239/0x384
 159   [<c017f446>] kfree+0xa6/0xc6
 160   [<c02e2335>] get_modalias+0xb9/0xf5
 161   [<c02e23b7>] dmi_dev_uevent+0x27/0x3c
 162   [<c027866a>] dev_uevent+0x1ad/0x1da
 163   [<c0205024>] kobject_uevent_env+0x20a/0x45b
 164   [<c020527f>] kobject_uevent+0xa/0xf
 165   [<c02779f1>] store_uevent+0x4f/0x58
 166   [<c027758e>] dev_attr_store+0x29/0x2f
 167   [<c01bec4f>] sysfs_write_file+0x16e/0x19c
 168   [<c0183ba7>] vfs_write+0xd1/0x15a
 169   [<c01841d7>] sys_write+0x3d/0x72
 170   [<c0104112>] sysenter_past_esp+0x5f/0x99
 171   [<b7f7b410>] 0xb7f7b410
 172   =======================
 173
 174 FIX kmalloc-8: Restoring Redzone 0xc90f6d28-0xc90f6d2b=0xcc
 175
 176 If SLUB encounters a corrupted object (full detection requires the kernel
 177 to be booted with slub_debug) then the following output will be dumped
 178 into the syslog:
 179
 180 1. Description of the problem encountered
 181
 182 This will be a message in the system log starting with
 183
 184 ===============================================
 185 BUG <slab cache affected>: <What went wrong>
 186 -----------------------------------------------
 187
 188 INFO: <corruption start>-<corruption_end> <more info>
 189 INFO: Slab <address> <slab information>
 190 INFO: Object <address> <object information>
 191 INFO: Allocated in <kernel function> age=<jiffies since alloc> cpu=<allocated by
 192         cpu> pid=<pid of the process>
 193 INFO: Freed in <kernel function> age=<jiffies since free> cpu=<freed by cpu>
 194          pid=<pid of the process>
 195
 196 (Object allocation / free information is only available if SLAB_STORE_USER is
 197 set for the slab. slub_debug sets that option)
 198
 199 2. The object contents if an object was involved.
 200
 201 Various types of lines can follow the BUG SLUB line:
 202
 203 Bytes b4 <address> : <bytes>
 204         Shows a few bytes before the object where the problem was detected.
 205         Can be useful if the corruption does not stop with the start of the
 206         object.
 207
 208 Object <address> : <bytes>
 209         The bytes of the object. If the object is inactive then the bytes
 210         typically contain poison values. Any non-poison value shows a
 211         corruption by a write after free.
 212
 213 Redzone <address> : <bytes>
 214         The Redzone following the object. The Redzone is used to detect
 215         writes after the object. All bytes should always have the same
 216         value. If there is any deviation then it is due to a write after
 217         the object boundary.
 218
 219         (Redzone information is only available if SLAB_RED_ZONE is set.
 220         slub_debug sets that option)
 221
 222 Padding <address> : <bytes>
 223         Unused data to fill up the space in order to get the next object
 224         properly aligned. In the debug case we make sure that there are
 225         at least 4 bytes of padding. This allows the detection of writes
 226         before the object.
 227
 228 3. A stackdump
 229
 230 The stackdump describes the location where the error was detected. The cause
 231 of the corruption is may be more likely found by looking at the function that
 232 allocated or freed the object.
 233
 234 4. Report on how the problem was dealt with in order to ensure the continued
 235 operation of the system.
 236
 237 These are messages in the system log beginning with
 238
 239 FIX <slab cache affected>: <corrective action taken>
 240
 241 In the above sample SLUB found that the Redzone of an active object has
 242 been overwritten. Here a string of 8 characters was written into a slab that
 243 has the length of 8 characters. However, a 8 character string needs a
 244 terminating 0. That zero has overwritten the first byte of the Redzone field.
 245 After reporting the details of the issue encountered the FIX SLUB message
 246 tell us that SLUB has restored the Redzone to its proper value and then
 247 system operations continue.
 248
 249 Emergency operations:
 250 ---------------------
 251
 252 Minimal debugging (sanity checks alone) can be enabled by booting with
 253
 254         slub_debug=F
 255
 256 This will be generally be enough to enable the resiliency features of slub
 257 which will keep the system running even if a bad kernel component will
 258 keep corrupting objects. This may be important for production systems.
 259 Performance will be impacted by the sanity checks and there will be a
 260 continual stream of error messages to the syslog but no additional memory
 261 will be used (unlike full debugging).
 262
 263 No guarantees. The kernel component still needs to be fixed. Performance
 264 may be optimized further by locating the slab that experiences corruption
 265 and enabling debugging only for that cache
 266
 267 I.e.
 268
 269         slub_debug=F,dentry
 270
 271 If the corruption occurs by writing after the end of the object then it
 272 may be advisable to enable a Redzone to avoid corrupting the beginning
 273 of other objects.
 274
 275         slub_debug=FZ,dentry
 276
 277 Christoph Lameter, <clameter@sgi.com>, May 30, 2007