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