slub.c 126 KB
Newer Older
Christoph Lameter's avatar
Christoph Lameter committed
1
2
3
4
/*
 * SLUB: A slab allocator that limits cache line use instead of queuing
 * objects in per cpu and per node lists.
 *
5
6
 * The allocator synchronizes using per slab locks or atomic operatios
 * and only uses a centralized lock to manage a pool of partial slabs.
Christoph Lameter's avatar
Christoph Lameter committed
7
 *
Christoph Lameter's avatar
Christoph Lameter committed
8
 * (C) 2007 SGI, Christoph Lameter
9
 * (C) 2011 Linux Foundation, Christoph Lameter
Christoph Lameter's avatar
Christoph Lameter committed
10
11
12
 */

#include <linux/mm.h>
Nick Piggin's avatar
Nick Piggin committed
13
#include <linux/swap.h> /* struct reclaim_state */
Christoph Lameter's avatar
Christoph Lameter committed
14
15
16
17
18
#include <linux/module.h>
#include <linux/bit_spinlock.h>
#include <linux/interrupt.h>
#include <linux/bitops.h>
#include <linux/slab.h>
19
#include "slab.h"
20
#include <linux/proc_fs.h>
Christoph Lameter's avatar
Christoph Lameter committed
21
#include <linux/seq_file.h>
Vegard Nossum's avatar
Vegard Nossum committed
22
#include <linux/kmemcheck.h>
Christoph Lameter's avatar
Christoph Lameter committed
23
24
25
26
#include <linux/cpu.h>
#include <linux/cpuset.h>
#include <linux/mempolicy.h>
#include <linux/ctype.h>
27
#include <linux/debugobjects.h>
Christoph Lameter's avatar
Christoph Lameter committed
28
#include <linux/kallsyms.h>
29
#include <linux/memory.h>
Roman Zippel's avatar
Roman Zippel committed
30
#include <linux/math64.h>
Akinobu Mita's avatar
Akinobu Mita committed
31
#include <linux/fault-inject.h>
32
#include <linux/stacktrace.h>
33
#include <linux/prefetch.h>
34
#include <linux/memcontrol.h>
Christoph Lameter's avatar
Christoph Lameter committed
35

36
37
#include <trace/events/kmem.h>

38
39
#include "internal.h"

Christoph Lameter's avatar
Christoph Lameter committed
40
41
/*
 * Lock order:
42
 *   1. slab_mutex (Global Mutex)
43
44
 *   2. node->list_lock
 *   3. slab_lock(page) (Only on some arches and for debugging)
Christoph Lameter's avatar
Christoph Lameter committed
45
 *
46
 *   slab_mutex
47
 *
48
 *   The role of the slab_mutex is to protect the list of all the slabs
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 *   and to synchronize major metadata changes to slab cache structures.
 *
 *   The slab_lock is only used for debugging and on arches that do not
 *   have the ability to do a cmpxchg_double. It only protects the second
 *   double word in the page struct. Meaning
 *	A. page->freelist	-> List of object free in a page
 *	B. page->counters	-> Counters of objects
 *	C. page->frozen		-> frozen state
 *
 *   If a slab is frozen then it is exempt from list management. It is not
 *   on any list. The processor that froze the slab is the one who can
 *   perform list operations on the page. Other processors may put objects
 *   onto the freelist but the processor that froze the slab is the only
 *   one that can retrieve the objects from the page's freelist.
Christoph Lameter's avatar
Christoph Lameter committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 *
 *   The list_lock protects the partial and full list on each node and
 *   the partial slab counter. If taken then no new slabs may be added or
 *   removed from the lists nor make the number of partial slabs be modified.
 *   (Note that the total number of slabs is an atomic value that may be
 *   modified without taking the list lock).
 *
 *   The list_lock is a centralized lock and thus we avoid taking it as
 *   much as possible. As long as SLUB does not have to handle partial
 *   slabs, operations can continue without any centralized lock. F.e.
 *   allocating a long series of objects that fill up slabs does not require
 *   the list lock.
 *   Interrupts are disabled during allocation and deallocation in order to
 *   make the slab allocator safe to use in the context of an irq. In addition
 *   interrupts are disabled to ensure that the processor does not change
 *   while handling per_cpu slabs, due to kernel preemption.
 *
 * SLUB assigns one slab for allocation to each processor.
 * Allocations only occur from these slabs called cpu slabs.
 *
Christoph Lameter's avatar
Christoph Lameter committed
83
84
 * Slabs with free elements are kept on a partial list and during regular
 * operations no list for full slabs is used. If an object in a full slab is
Christoph Lameter's avatar
Christoph Lameter committed
85
 * freed then the slab will show up again on the partial lists.
Christoph Lameter's avatar
Christoph Lameter committed
86
87
 * We track full slabs for debugging purposes though because otherwise we
 * cannot scan all objects.
Christoph Lameter's avatar
Christoph Lameter committed
88
89
90
91
92
93
94
 *
 * Slabs are freed when they become empty. Teardown and setup is
 * minimal so we rely on the page allocators per cpu caches for
 * fast frees and allocs.
 *
 * Overloading of page flags that are otherwise used for LRU management.
 *
95
96
97
98
99
100
101
102
103
104
105
106
 * PageActive 		The slab is frozen and exempt from list processing.
 * 			This means that the slab is dedicated to a purpose
 * 			such as satisfying allocations for a specific
 * 			processor. Objects may be freed in the slab while
 * 			it is frozen but slab_free will then skip the usual
 * 			list operations. It is up to the processor holding
 * 			the slab to integrate the slab into the slab lists
 * 			when the slab is no longer needed.
 *
 * 			One use of this flag is to mark slabs that are
 * 			used for allocations. Then such a slab becomes a cpu
 * 			slab. The cpu slab may be equipped with an additional
107
 * 			freelist that allows lockless access to
108
109
 * 			free objects in addition to the regular freelist
 * 			that requires the slab lock.
Christoph Lameter's avatar
Christoph Lameter committed
110
111
112
 *
 * PageError		Slab requires special handling due to debug
 * 			options set. This moves	slab handling out of
113
 * 			the fast path and disables lockless freelists.
Christoph Lameter's avatar
Christoph Lameter committed
114
115
 */

116
117
static inline int kmem_cache_debug(struct kmem_cache *s)
{
118
#ifdef CONFIG_SLUB_DEBUG
119
	return unlikely(s->flags & SLAB_DEBUG_FLAGS);
120
#else
121
	return 0;
122
#endif
123
}
124

Christoph Lameter's avatar
Christoph Lameter committed
125
126
127
128
129
130
131
132
133
134
135
/*
 * Issues still to be resolved:
 *
 * - Support PAGE_ALLOC_DEBUG. Should be easy to do.
 *
 * - Variable sizing of the per node arrays
 */

/* Enable to test recovery from slab corruption on boot */
#undef SLUB_RESILIENCY_TEST

136
137
138
/* Enable to log cmpxchg failures */
#undef SLUB_DEBUG_CMPXCHG

139
140
141
142
/*
 * Mininum number of partial slabs. These will be left on the partial
 * lists even if they are empty. kmem_cache_shrink may reclaim them.
 */
143
#define MIN_PARTIAL 5
Christoph Lameter's avatar
Christoph Lameter committed
144

145
146
147
148
149
150
151
/*
 * Maximum number of desirable partial slabs.
 * The existence of more partial slabs makes kmem_cache_shrink
 * sort the partial list by the number of objects in the.
 */
#define MAX_PARTIAL 10

Christoph Lameter's avatar
Christoph Lameter committed
152
153
#define DEBUG_DEFAULT_FLAGS (SLAB_DEBUG_FREE | SLAB_RED_ZONE | \
				SLAB_POISON | SLAB_STORE_USER)
Christoph Lameter's avatar
Christoph Lameter committed
154

155
/*
156
157
158
 * Debugging flags that require metadata to be stored in the slab.  These get
 * disabled when slub_debug=O is used and a cache's min order increases with
 * metadata.
159
 */
160
#define DEBUG_METADATA_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
161

Christoph Lameter's avatar
Christoph Lameter committed
162
163
164
165
/*
 * Set of flags that will prevent slab merging
 */
#define SLUB_NEVER_MERGE (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER | \
166
167
		SLAB_TRACE | SLAB_DESTROY_BY_RCU | SLAB_NOLEAKTRACE | \
		SLAB_FAILSLAB)
Christoph Lameter's avatar
Christoph Lameter committed
168
169

#define SLUB_MERGE_SAME (SLAB_DEBUG_FREE | SLAB_RECLAIM_ACCOUNT | \
Vegard Nossum's avatar
Vegard Nossum committed
170
		SLAB_CACHE_DMA | SLAB_NOTRACK)
Christoph Lameter's avatar
Christoph Lameter committed
171

172
173
#define OO_SHIFT	16
#define OO_MASK		((1 << OO_SHIFT) - 1)
174
#define MAX_OBJS_PER_PAGE	32767 /* since page.objects is u15 */
175

Christoph Lameter's avatar
Christoph Lameter committed
176
/* Internal SLUB flags */
Christoph Lameter's avatar
Christoph Lameter committed
177
#define __OBJECT_POISON		0x80000000UL /* Poison object */
178
#define __CMPXCHG_DOUBLE	0x40000000UL /* Use cmpxchg_double */
Christoph Lameter's avatar
Christoph Lameter committed
179
180
181
182
183

#ifdef CONFIG_SMP
static struct notifier_block slab_notifier;
#endif

184
185
186
/*
 * Tracking user of a slab.
 */
187
#define TRACK_ADDRS_COUNT 16
188
struct track {
189
	unsigned long addr;	/* Called from address */
190
191
192
#ifdef CONFIG_STACKTRACE
	unsigned long addrs[TRACK_ADDRS_COUNT];	/* Called from address */
#endif
193
194
195
196
197
198
199
	int cpu;		/* Was running on cpu */
	int pid;		/* Pid context */
	unsigned long when;	/* When did the operation occur */
};

enum track_item { TRACK_ALLOC, TRACK_FREE };

200
#ifdef CONFIG_SYSFS
Christoph Lameter's avatar
Christoph Lameter committed
201
202
203
static int sysfs_slab_add(struct kmem_cache *);
static int sysfs_slab_alias(struct kmem_cache *, const char *);
static void sysfs_slab_remove(struct kmem_cache *);
204

Christoph Lameter's avatar
Christoph Lameter committed
205
#else
206
207
208
static inline int sysfs_slab_add(struct kmem_cache *s) { return 0; }
static inline int sysfs_slab_alias(struct kmem_cache *s, const char *p)
							{ return 0; }
209
static inline void sysfs_slab_remove(struct kmem_cache *s) { }
210

Christoph Lameter's avatar
Christoph Lameter committed
211
212
#endif

213
static inline void stat(const struct kmem_cache *s, enum stat_item si)
214
215
{
#ifdef CONFIG_SLUB_STATS
216
	__this_cpu_inc(s->cpu_slab->stat[si]);
217
218
219
#endif
}

Christoph Lameter's avatar
Christoph Lameter committed
220
221
222
223
224
225
226
227
228
/********************************************************************
 * 			Core slab cache functions
 *******************************************************************/

static inline struct kmem_cache_node *get_node(struct kmem_cache *s, int node)
{
	return s->node[node];
}

Christoph Lameter's avatar
Christoph Lameter committed
229
/* Verify that a pointer has an address that is valid within a slab page */
230
231
232
233
234
static inline int check_valid_pointer(struct kmem_cache *s,
				struct page *page, const void *object)
{
	void *base;

235
	if (!object)
236
237
		return 1;

238
	base = page_address(page);
239
	if (object < base || object >= base + page->objects * s->size ||
240
241
242
243
244
245
246
		(object - base) % s->size) {
		return 0;
	}

	return 1;
}

247
248
249
250
251
static inline void *get_freepointer(struct kmem_cache *s, void *object)
{
	return *(void **)(object + s->offset);
}

252
253
254
255
256
static void prefetch_freepointer(const struct kmem_cache *s, void *object)
{
	prefetch(object + s->offset);
}

257
258
259
260
261
262
263
264
265
266
267
268
static inline void *get_freepointer_safe(struct kmem_cache *s, void *object)
{
	void *p;

#ifdef CONFIG_DEBUG_PAGEALLOC
	probe_kernel_read(&p, (void **)(object + s->offset), sizeof(p));
#else
	p = get_freepointer(s, object);
#endif
	return p;
}

269
270
271
272
273
274
static inline void set_freepointer(struct kmem_cache *s, void *object, void *fp)
{
	*(void **)(object + s->offset) = fp;
}

/* Loop over all objects in a slab */
275
276
#define for_each_object(__p, __s, __addr, __objects) \
	for (__p = (__addr); __p < (__addr) + (__objects) * (__s)->size;\
277
278
279
280
281
282
283
284
			__p += (__s)->size)

/* Determine object index from a given position */
static inline int slab_index(void *p, struct kmem_cache *s, void *addr)
{
	return (p - addr) / s->size;
}

285
286
287
288
289
290
291
292
static inline size_t slab_ksize(const struct kmem_cache *s)
{
#ifdef CONFIG_SLUB_DEBUG
	/*
	 * Debugging requires use of the padding between object
	 * and whatever may come after it.
	 */
	if (s->flags & (SLAB_RED_ZONE | SLAB_POISON))
293
		return s->object_size;
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308

#endif
	/*
	 * If we have the need to store the freelist pointer
	 * back there or track user information then we can
	 * only use the space before that information.
	 */
	if (s->flags & (SLAB_DESTROY_BY_RCU | SLAB_STORE_USER))
		return s->inuse;
	/*
	 * Else we can use all the padding etc for the allocation
	 */
	return s->size;
}

309
310
311
312
313
static inline int order_objects(int order, unsigned long size, int reserved)
{
	return ((PAGE_SIZE << order) - reserved) / size;
}

314
static inline struct kmem_cache_order_objects oo_make(int order,
315
		unsigned long size, int reserved)
316
317
{
	struct kmem_cache_order_objects x = {
318
		(order << OO_SHIFT) + order_objects(order, size, reserved)
319
320
321
322
323
324
325
	};

	return x;
}

static inline int oo_order(struct kmem_cache_order_objects x)
{
326
	return x.x >> OO_SHIFT;
327
328
329
330
}

static inline int oo_objects(struct kmem_cache_order_objects x)
{
331
	return x.x & OO_MASK;
332
333
}

334
335
336
337
338
339
340
341
342
343
344
345
346
/*
 * Per slab locking using the pagelock
 */
static __always_inline void slab_lock(struct page *page)
{
	bit_spin_lock(PG_locked, &page->flags);
}

static __always_inline void slab_unlock(struct page *page)
{
	__bit_spin_unlock(PG_locked, &page->flags);
}

347
348
349
350
351
352
353
/* Interrupts must be disabled (for the fallback code to work right) */
static inline bool __cmpxchg_double_slab(struct kmem_cache *s, struct page *page,
		void *freelist_old, unsigned long counters_old,
		void *freelist_new, unsigned long counters_new,
		const char *n)
{
	VM_BUG_ON(!irqs_disabled());
354
355
#if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
    defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
356
	if (s->flags & __CMPXCHG_DOUBLE) {
357
		if (cmpxchg_double(&page->freelist, &page->counters,
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
			freelist_old, counters_old,
			freelist_new, counters_new))
		return 1;
	} else
#endif
	{
		slab_lock(page);
		if (page->freelist == freelist_old && page->counters == counters_old) {
			page->freelist = freelist_new;
			page->counters = counters_new;
			slab_unlock(page);
			return 1;
		}
		slab_unlock(page);
	}

	cpu_relax();
	stat(s, CMPXCHG_DOUBLE_FAIL);

#ifdef SLUB_DEBUG_CMPXCHG
	printk(KERN_INFO "%s %s: cmpxchg double redo ", n, s->name);
#endif

	return 0;
}

384
385
386
387
388
static inline bool cmpxchg_double_slab(struct kmem_cache *s, struct page *page,
		void *freelist_old, unsigned long counters_old,
		void *freelist_new, unsigned long counters_new,
		const char *n)
{
389
390
#if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
    defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
391
	if (s->flags & __CMPXCHG_DOUBLE) {
392
		if (cmpxchg_double(&page->freelist, &page->counters,
393
394
395
396
397
398
			freelist_old, counters_old,
			freelist_new, counters_new))
		return 1;
	} else
#endif
	{
399
400
401
		unsigned long flags;

		local_irq_save(flags);
402
		slab_lock(page);
403
404
405
		if (page->freelist == freelist_old && page->counters == counters_old) {
			page->freelist = freelist_new;
			page->counters = counters_new;
406
			slab_unlock(page);
407
			local_irq_restore(flags);
408
409
			return 1;
		}
410
		slab_unlock(page);
411
		local_irq_restore(flags);
412
413
414
415
416
417
418
419
420
421
422
423
	}

	cpu_relax();
	stat(s, CMPXCHG_DOUBLE_FAIL);

#ifdef SLUB_DEBUG_CMPXCHG
	printk(KERN_INFO "%s %s: cmpxchg double redo ", n, s->name);
#endif

	return 0;
}

424
#ifdef CONFIG_SLUB_DEBUG
425
426
427
/*
 * Determine a map of object in use on a page.
 *
428
 * Node listlock must be held to guarantee that the page does
429
430
431
432
433
434
435
436
437
438
439
 * not vanish from under us.
 */
static void get_map(struct kmem_cache *s, struct page *page, unsigned long *map)
{
	void *p;
	void *addr = page_address(page);

	for (p = page->freelist; p; p = get_freepointer(s, p))
		set_bit(slab_index(p, s, addr), map);
}

440
441
442
/*
 * Debug settings:
 */
443
444
445
#ifdef CONFIG_SLUB_DEBUG_ON
static int slub_debug = DEBUG_DEFAULT_FLAGS;
#else
446
static int slub_debug;
447
#endif
448
449

static char *slub_debug_slabs;
450
static int disable_higher_order_debug;
451

Christoph Lameter's avatar
Christoph Lameter committed
452
453
454
455
456
/*
 * Object debugging
 */
static void print_section(char *text, u8 *addr, unsigned int length)
{
457
458
	print_hex_dump(KERN_ERR, text, DUMP_PREFIX_ADDRESS, 16, 1, addr,
			length, 1);
Christoph Lameter's avatar
Christoph Lameter committed
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
}

static struct track *get_track(struct kmem_cache *s, void *object,
	enum track_item alloc)
{
	struct track *p;

	if (s->offset)
		p = object + s->offset + sizeof(void *);
	else
		p = object + s->inuse;

	return p + alloc;
}

static void set_track(struct kmem_cache *s, void *object,
475
			enum track_item alloc, unsigned long addr)
Christoph Lameter's avatar
Christoph Lameter committed
476
{
Akinobu Mita's avatar
Akinobu Mita committed
477
	struct track *p = get_track(s, object, alloc);
Christoph Lameter's avatar
Christoph Lameter committed
478
479

	if (addr) {
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
#ifdef CONFIG_STACKTRACE
		struct stack_trace trace;
		int i;

		trace.nr_entries = 0;
		trace.max_entries = TRACK_ADDRS_COUNT;
		trace.entries = p->addrs;
		trace.skip = 3;
		save_stack_trace(&trace);

		/* See rant in lockdep.c */
		if (trace.nr_entries != 0 &&
		    trace.entries[trace.nr_entries - 1] == ULONG_MAX)
			trace.nr_entries--;

		for (i = trace.nr_entries; i < TRACK_ADDRS_COUNT; i++)
			p->addrs[i] = 0;
#endif
Christoph Lameter's avatar
Christoph Lameter committed
498
499
		p->addr = addr;
		p->cpu = smp_processor_id();
500
		p->pid = current->pid;
Christoph Lameter's avatar
Christoph Lameter committed
501
502
503
504
505
506
507
		p->when = jiffies;
	} else
		memset(p, 0, sizeof(struct track));
}

static void init_tracking(struct kmem_cache *s, void *object)
{
508
509
510
	if (!(s->flags & SLAB_STORE_USER))
		return;

511
512
	set_track(s, object, TRACK_FREE, 0UL);
	set_track(s, object, TRACK_ALLOC, 0UL);
Christoph Lameter's avatar
Christoph Lameter committed
513
514
515
516
517
518
519
}

static void print_track(const char *s, struct track *t)
{
	if (!t->addr)
		return;

520
	printk(KERN_ERR "INFO: %s in %pS age=%lu cpu=%u pid=%d\n",
521
		s, (void *)t->addr, jiffies - t->when, t->cpu, t->pid);
522
523
524
525
526
527
528
529
530
531
#ifdef CONFIG_STACKTRACE
	{
		int i;
		for (i = 0; i < TRACK_ADDRS_COUNT; i++)
			if (t->addrs[i])
				printk(KERN_ERR "\t%pS\n", (void *)t->addrs[i]);
			else
				break;
	}
#endif
532
533
534
535
536
537
538
539
540
541
542
543
544
}

static void print_tracking(struct kmem_cache *s, void *object)
{
	if (!(s->flags & SLAB_STORE_USER))
		return;

	print_track("Allocated", get_track(s, object, TRACK_ALLOC));
	print_track("Freed", get_track(s, object, TRACK_FREE));
}

static void print_page_info(struct page *page)
{
545
546
	printk(KERN_ERR "INFO: Slab 0x%p objects=%u used=%u fp=0x%p flags=0x%04lx\n",
		page, page->objects, page->inuse, page->freelist, page->flags);
547
548
549
550
551
552
553
554
555
556
557
558
559

}

static void slab_bug(struct kmem_cache *s, char *fmt, ...)
{
	va_list args;
	char buf[100];

	va_start(args, fmt);
	vsnprintf(buf, sizeof(buf), fmt, args);
	va_end(args);
	printk(KERN_ERR "========================================"
			"=====================================\n");
560
	printk(KERN_ERR "BUG %s (%s): %s\n", s->name, print_tainted(), buf);
561
562
	printk(KERN_ERR "----------------------------------------"
			"-------------------------------------\n\n");
563
564

	add_taint(TAINT_BAD_PAGE);
Christoph Lameter's avatar
Christoph Lameter committed
565
566
}

567
568
569
570
571
572
573
574
575
576
577
578
static void slab_fix(struct kmem_cache *s, char *fmt, ...)
{
	va_list args;
	char buf[100];

	va_start(args, fmt);
	vsnprintf(buf, sizeof(buf), fmt, args);
	va_end(args);
	printk(KERN_ERR "FIX %s: %s\n", s->name, buf);
}

static void print_trailer(struct kmem_cache *s, struct page *page, u8 *p)
Christoph Lameter's avatar
Christoph Lameter committed
579
580
{
	unsigned int off;	/* Offset of last byte */
581
	u8 *addr = page_address(page);
582
583
584
585
586
587
588
589
590

	print_tracking(s, p);

	print_page_info(page);

	printk(KERN_ERR "INFO: Object 0x%p @offset=%tu fp=0x%p\n\n",
			p, p - addr, get_freepointer(s, p));

	if (p > addr + 16)
591
		print_section("Bytes b4 ", p - 16, 16);
Christoph Lameter's avatar
Christoph Lameter committed
592

593
	print_section("Object ", p, min_t(unsigned long, s->object_size,
594
				PAGE_SIZE));
Christoph Lameter's avatar
Christoph Lameter committed
595
	if (s->flags & SLAB_RED_ZONE)
596
597
		print_section("Redzone ", p + s->object_size,
			s->inuse - s->object_size);
Christoph Lameter's avatar
Christoph Lameter committed
598
599
600
601
602
603

	if (s->offset)
		off = s->offset + sizeof(void *);
	else
		off = s->inuse;

604
	if (s->flags & SLAB_STORE_USER)
Christoph Lameter's avatar
Christoph Lameter committed
605
606
607
608
		off += 2 * sizeof(struct track);

	if (off != s->size)
		/* Beginning of the filler is the free pointer */
609
		print_section("Padding ", p + off, s->size - off);
610
611

	dump_stack();
Christoph Lameter's avatar
Christoph Lameter committed
612
613
614
615
616
}

static void object_err(struct kmem_cache *s, struct page *page,
			u8 *object, char *reason)
{
617
	slab_bug(s, "%s", reason);
618
	print_trailer(s, page, object);
Christoph Lameter's avatar
Christoph Lameter committed
619
620
}

621
static void slab_err(struct kmem_cache *s, struct page *page, const char *fmt, ...)
Christoph Lameter's avatar
Christoph Lameter committed
622
623
624
625
{
	va_list args;
	char buf[100];

626
627
	va_start(args, fmt);
	vsnprintf(buf, sizeof(buf), fmt, args);
Christoph Lameter's avatar
Christoph Lameter committed
628
	va_end(args);
629
	slab_bug(s, "%s", buf);
630
	print_page_info(page);
Christoph Lameter's avatar
Christoph Lameter committed
631
632
633
	dump_stack();
}

634
static void init_object(struct kmem_cache *s, void *object, u8 val)
Christoph Lameter's avatar
Christoph Lameter committed
635
636
637
638
{
	u8 *p = object;

	if (s->flags & __OBJECT_POISON) {
639
640
		memset(p, POISON_FREE, s->object_size - 1);
		p[s->object_size - 1] = POISON_END;
Christoph Lameter's avatar
Christoph Lameter committed
641
642
643
	}

	if (s->flags & SLAB_RED_ZONE)
644
		memset(p + s->object_size, val, s->inuse - s->object_size);
Christoph Lameter's avatar
Christoph Lameter committed
645
646
}

647
648
649
650
651
652
653
654
655
static void restore_bytes(struct kmem_cache *s, char *message, u8 data,
						void *from, void *to)
{
	slab_fix(s, "Restoring 0x%p-0x%p=0x%x\n", from, to - 1, data);
	memset(from, data, to - from);
}

static int check_bytes_and_report(struct kmem_cache *s, struct page *page,
			u8 *object, char *what,
656
			u8 *start, unsigned int value, unsigned int bytes)
657
658
659
660
{
	u8 *fault;
	u8 *end;

661
	fault = memchr_inv(start, value, bytes);
662
663
664
665
666
667
668
669
670
671
672
673
674
675
	if (!fault)
		return 1;

	end = start + bytes;
	while (end > fault && end[-1] == value)
		end--;

	slab_bug(s, "%s overwritten", what);
	printk(KERN_ERR "INFO: 0x%p-0x%p. First byte 0x%x instead of 0x%x\n",
					fault, end - 1, fault[0], value);
	print_trailer(s, page, object);

	restore_bytes(s, what, value, fault, end);
	return 0;
Christoph Lameter's avatar
Christoph Lameter committed
676
677
678
679
680
681
682
683
684
}

/*
 * Object layout:
 *
 * object address
 * 	Bytes of the object to be managed.
 * 	If the freepointer may overlay the object then the free
 * 	pointer is the first word of the object.
Christoph Lameter's avatar
Christoph Lameter committed
685
 *
Christoph Lameter's avatar
Christoph Lameter committed
686
687
688
 * 	Poisoning uses 0x6b (POISON_FREE) and the last byte is
 * 	0xa5 (POISON_END)
 *
689
 * object + s->object_size
Christoph Lameter's avatar
Christoph Lameter committed
690
 * 	Padding to reach word boundary. This is also used for Redzoning.
Christoph Lameter's avatar
Christoph Lameter committed
691
 * 	Padding is extended by another word if Redzoning is enabled and
692
 * 	object_size == inuse.
Christoph Lameter's avatar
Christoph Lameter committed
693
 *
Christoph Lameter's avatar
Christoph Lameter committed
694
695
696
697
 * 	We fill with 0xbb (RED_INACTIVE) for inactive objects and with
 * 	0xcc (RED_ACTIVE) for objects in use.
 *
 * object + s->inuse
Christoph Lameter's avatar
Christoph Lameter committed
698
699
 * 	Meta data starts here.
 *
Christoph Lameter's avatar
Christoph Lameter committed
700
701
 * 	A. Free pointer (if we cannot overwrite object on free)
 * 	B. Tracking data for SLAB_STORE_USER
Christoph Lameter's avatar
Christoph Lameter committed
702
 * 	C. Padding to reach required alignment boundary or at mininum
Christoph Lameter's avatar
Christoph Lameter committed
703
 * 		one word if debugging is on to be able to detect writes
Christoph Lameter's avatar
Christoph Lameter committed
704
705
706
 * 		before the word boundary.
 *
 *	Padding is done using 0x5a (POISON_INUSE)
Christoph Lameter's avatar
Christoph Lameter committed
707
708
 *
 * object + s->size
Christoph Lameter's avatar
Christoph Lameter committed
709
 * 	Nothing is used beyond s->size.
Christoph Lameter's avatar
Christoph Lameter committed
710
 *
711
 * If slabcaches are merged then the object_size and inuse boundaries are mostly
Christoph Lameter's avatar
Christoph Lameter committed
712
 * ignored. And therefore no slab options that rely on these boundaries
Christoph Lameter's avatar
Christoph Lameter committed
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 * may be used with merged slabcaches.
 */

static int check_pad_bytes(struct kmem_cache *s, struct page *page, u8 *p)
{
	unsigned long off = s->inuse;	/* The end of info */

	if (s->offset)
		/* Freepointer is placed after the object. */
		off += sizeof(void *);

	if (s->flags & SLAB_STORE_USER)
		/* We also have user information there */
		off += 2 * sizeof(struct track);

	if (s->size == off)
		return 1;

731
732
	return check_bytes_and_report(s, page, p, "Object padding",
				p + off, POISON_INUSE, s->size - off);
Christoph Lameter's avatar
Christoph Lameter committed
733
734
}

735
/* Check the pad bytes at the end of a slab page */
Christoph Lameter's avatar
Christoph Lameter committed
736
737
static int slab_pad_check(struct kmem_cache *s, struct page *page)
{
738
739
740
741
742
	u8 *start;
	u8 *fault;
	u8 *end;
	int length;
	int remainder;
Christoph Lameter's avatar
Christoph Lameter committed
743
744
745
746

	if (!(s->flags & SLAB_POISON))
		return 1;

747
	start = page_address(page);
748
	length = (PAGE_SIZE << compound_order(page)) - s->reserved;
749
750
	end = start + length;
	remainder = length % s->size;
Christoph Lameter's avatar
Christoph Lameter committed
751
752
753
	if (!remainder)
		return 1;

754
	fault = memchr_inv(end - remainder, POISON_INUSE, remainder);
755
756
757
758
759
760
	if (!fault)
		return 1;
	while (end > fault && end[-1] == POISON_INUSE)
		end--;

	slab_err(s, page, "Padding overwritten. 0x%p-0x%p", fault, end - 1);
761
	print_section("Padding ", end - remainder, remainder);
762

Eric Dumazet's avatar
Eric Dumazet committed
763
	restore_bytes(s, "slab padding", POISON_INUSE, end - remainder, end);
764
	return 0;
Christoph Lameter's avatar
Christoph Lameter committed
765
766
767
}

static int check_object(struct kmem_cache *s, struct page *page,
768
					void *object, u8 val)
Christoph Lameter's avatar
Christoph Lameter committed
769
770
{
	u8 *p = object;
771
	u8 *endobject = object + s->object_size;
Christoph Lameter's avatar
Christoph Lameter committed
772
773

	if (s->flags & SLAB_RED_ZONE) {
774
		if (!check_bytes_and_report(s, page, object, "Redzone",
775
			endobject, val, s->inuse - s->object_size))
Christoph Lameter's avatar
Christoph Lameter committed
776
777
			return 0;
	} else {
778
		if ((s->flags & SLAB_POISON) && s->object_size < s->inuse) {
Ingo Molnar's avatar
Ingo Molnar committed
779
			check_bytes_and_report(s, page, p, "Alignment padding",
780
				endobject, POISON_INUSE, s->inuse - s->object_size);
Ingo Molnar's avatar
Ingo Molnar committed
781
		}
Christoph Lameter's avatar
Christoph Lameter committed
782
783
784
	}

	if (s->flags & SLAB_POISON) {
785
		if (val != SLUB_RED_ACTIVE && (s->flags & __OBJECT_POISON) &&
786
			(!check_bytes_and_report(s, page, p, "Poison", p,
787
					POISON_FREE, s->object_size - 1) ||
788
			 !check_bytes_and_report(s, page, p, "Poison",
789
				p + s->object_size - 1, POISON_END, 1)))
Christoph Lameter's avatar
Christoph Lameter committed
790
791
792
793
794
795
796
			return 0;
		/*
		 * check_pad_bytes cleans up on its own.
		 */
		check_pad_bytes(s, page, p);
	}

797
	if (!s->offset && val == SLUB_RED_ACTIVE)
Christoph Lameter's avatar
Christoph Lameter committed
798
799
800
801
802
803
804
805
806
807
		/*
		 * Object and freepointer overlap. Cannot check
		 * freepointer while object is allocated.
		 */
		return 1;

	/* Check free pointer validity */
	if (!check_valid_pointer(s, page, get_freepointer(s, p))) {
		object_err(s, page, p, "Freepointer corrupt");
		/*
Nick Andrew's avatar
Nick Andrew committed
808
		 * No choice but to zap it and thus lose the remainder
Christoph Lameter's avatar
Christoph Lameter committed
809
		 * of the free objects in this slab. May cause
Christoph Lameter's avatar
Christoph Lameter committed
810
		 * another error because the object count is now wrong.
Christoph Lameter's avatar
Christoph Lameter committed
811
		 */
812
		set_freepointer(s, p, NULL);
Christoph Lameter's avatar
Christoph Lameter committed
813
814
815
816
817
818
819
		return 0;
	}
	return 1;
}

static int check_slab(struct kmem_cache *s, struct page *page)
{
820
821
	int maxobj;

Christoph Lameter's avatar
Christoph Lameter committed
822
823
824
	VM_BUG_ON(!irqs_disabled());

	if (!PageSlab(page)) {
825
		slab_err(s, page, "Not a valid slab page");
Christoph Lameter's avatar
Christoph Lameter committed
826
827
		return 0;
	}
828

829
	maxobj = order_objects(compound_order(page), s->size, s->reserved);
830
831
832
833
834
835
	if (page->objects > maxobj) {
		slab_err(s, page, "objects %u > max %u",
			s->name, page->objects, maxobj);
		return 0;
	}
	if (page->inuse > page->objects) {
836
		slab_err(s, page, "inuse %u > max %u",
837
			s->name, page->inuse, page->objects);
Christoph Lameter's avatar
Christoph Lameter committed
838
839
840
841
842
843
844
845
		return 0;
	}
	/* Slab_pad_check fixes things up after itself */
	slab_pad_check(s, page);
	return 1;
}

/*
Christoph Lameter's avatar
Christoph Lameter committed
846
847
 * Determine if a certain object on a page is on the freelist. Must hold the
 * slab lock to guarantee that the chains are in a consistent state.
Christoph Lameter's avatar
Christoph Lameter committed
848
849
850
851
 */
static int on_freelist(struct kmem_cache *s, struct page *page, void *search)
{
	int nr = 0;
852
	void *fp;
Christoph Lameter's avatar
Christoph Lameter committed
853
	void *object = NULL;
854
	unsigned long max_objects;
Christoph Lameter's avatar
Christoph Lameter committed
855

856
	fp = page->freelist;
857
	while (fp && nr <= page->objects) {
Christoph Lameter's avatar
Christoph Lameter committed
858
859
860
861
862
863
		if (fp == search)
			return 1;
		if (!check_valid_pointer(s, page, fp)) {
			if (object) {
				object_err(s, page, object,
					"Freechain corrupt");
864
				set_freepointer(s, object, NULL);
Christoph Lameter's avatar
Christoph Lameter committed
865
866
				break;
			} else {
867
				slab_err(s, page, "Freepointer corrupt");
868
				page->freelist = NULL;
869
				page->inuse = page->objects;
870
				slab_fix(s, "Freelist cleared");
Christoph Lameter's avatar
Christoph Lameter committed
871
872
873
874
875
876
877
878
879
				return 0;
			}
			break;
		}
		object = fp;
		fp = get_freepointer(s, object);
		nr++;
	}

880
	max_objects = order_objects(compound_order(page), s->size, s->reserved);
881
882
	if (max_objects > MAX_OBJS_PER_PAGE)
		max_objects = MAX_OBJS_PER_PAGE;
883
884
885
886
887
888
889

	if (page->objects != max_objects) {
		slab_err(s, page, "Wrong number of objects. Found %d but "
			"should be %d", page->objects, max_objects);
		page->objects = max_objects;
		slab_fix(s, "Number of objects adjusted.");
	}
890
	if (page->inuse != page->objects - nr) {
891
		slab_err(s, page, "Wrong object count. Counter is %d but "
892
893
			"counted were %d", page->inuse, page->objects - nr);
		page->inuse = page->objects - nr;
894
		slab_fix(s, "Object count adjusted.");
Christoph Lameter's avatar
Christoph Lameter committed
895
896
897
898
	}
	return search == NULL;
}

899
900
static void trace(struct kmem_cache *s, struct page *page, void *object,
								int alloc)
Christoph Lameter's avatar
Christoph Lameter committed
901
902
903
904
905
906
907
908
909
{
	if (s->flags & SLAB_TRACE) {
		printk(KERN_INFO "TRACE %s %s 0x%p inuse=%d fp=0x%p\n",
			s->name,
			alloc ? "alloc" : "free",
			object, page->inuse,
			page->freelist);

		if (!alloc)
910
			print_section("Object ", (void *)object, s->object_size);
Christoph Lameter's avatar
Christoph Lameter committed
911
912
913
914
915

		dump_stack();
	}
}

916
917
918
919
920
921
/*
 * Hooks for other subsystems that check memory allocations. In a typical
 * production configuration these hooks all should produce no code at all.
 */
static inline int slab_pre_alloc_hook(struct kmem_cache *s, gfp_t flags)
{
922
	flags &= gfp_allowed_mask;
923
924
925
	lockdep_trace_alloc(flags);
	might_sleep_if(flags & __GFP_WAIT);

926
	return should_failslab(s->object_size, flags, s->flags);
927
928
929
930
}

static inline void slab_post_alloc_hook(struct kmem_cache *s, gfp_t flags, void *object)
{
931
	flags &= gfp_allowed_mask;
932
	kmemcheck_slab_alloc(s, flags, object, slab_ksize(s));
933
	kmemleak_alloc_recursive(object, s->object_size, 1, s->flags, flags);
934
935
936
937
938
939
}

static inline void slab_free_hook(struct kmem_cache *s, void *x)
{
	kmemleak_free_recursive(x, s->flags);

940
941
942
943
944
945
946
947
948
949
	/*
	 * Trouble is that we may no longer disable interupts in the fast path
	 * So in order to make the debug calls that expect irqs to be
	 * disabled we need to disable interrupts temporarily.
	 */
#if defined(CONFIG_KMEMCHECK) || defined(CONFIG_LOCKDEP)
	{
		unsigned long flags;

		local_irq_save(flags);
950
951
		kmemcheck_slab_free(s, x, s->object_size);
		debug_check_no_locks_freed(x, s->object_size);
952
953
954
		local_irq_restore(flags);
	}
#endif
955
	if (!(s->flags & SLAB_DEBUG_OBJECTS))
956
		debug_check_no_obj_freed(x, s->object_size);
957
958
}

959
/*
Christoph Lameter's avatar
Christoph Lameter committed
960
 * Tracking of fully allocated slabs for debugging purposes.
961
962
 *
 * list_lock must be held.
963
 */
964
965
static void add_full(struct kmem_cache *s,
	struct kmem_cache_node *n, struct page *page)
966
{
967
968
969
	if (!(s->flags & SLAB_STORE_USER))
		return;

970
971
972
	list_add(&page->lru, &n->full);
}

973
974
975
/*
 * list_lock must be held.
 */
976
977
978
979
980
981
982
983
static void remove_full(struct kmem_cache *s, struct page *page)
{
	if (!(s->flags & SLAB_STORE_USER))
		return;

	list_del(&page->lru);
}

984
985
986
987
988
989
990
991
/* Tracking of the number of slabs for debugging purposes */
static inline unsigned long slabs_node(struct kmem_cache *s, int node)
{
	struct kmem_cache_node *n = get_node(s, node);

	return atomic_long_read(&n->nr_slabs);
}

992
993
994
995
996
static inline unsigned long node_nr_slabs(struct kmem_cache_node *n)
{
	return atomic_long_read(&n->nr_slabs);
}

997
static inline void inc_slabs_node(struct kmem_cache *s, int node, int objects)
998
999
1000
1001
1002
1003
1004
1005
1006
{
	struct kmem_cache_node *n = get_node(s, node);

	/*
	 * May be called early in order to allocate a slab for the
	 * kmem_cache_node structure. Solve the chicken-egg
	 * dilemma by deferring the increment of the count during
	 * bootstrap (see early_kmem_cache_node_alloc).
	 */
1007
	if (n) {
1008
		atomic_long_inc(&n->nr_slabs);
1009
1010
		atomic_long_add(objects, &n->total_objects);
	}
1011
}
1012
static inline void dec_slabs_node(struct kmem_cache *s, int node, int objects)
1013
1014
1015
1016
{
	struct kmem_cache_node *n = get_node(s, node);

	atomic_long_dec(&n->nr_slabs);
1017
	atomic_long_sub(objects, &n->total_objects);
1018
1019
1020
}

/* Object debug checks for alloc/free paths */
Christoph Lameter's avatar
Christoph Lameter committed
1021
1022
1023
1024
1025
1026
static void setup_object_debug(struct kmem_cache *s, struct page *page,
								void *object)
{
	if (!(s->flags & (SLAB_STORE_USER|SLAB_RED_ZONE|__OBJECT_POISON)))
		return;

1027
	init_object(s, object, SLUB_RED_INACTIVE);
Christoph Lameter's avatar
Christoph Lameter committed
1028
1029
1030
	init_tracking(s, object);
}

1031
static noinline int alloc_debug_processing(struct kmem_cache *s, struct page *page,
1032
					void *object, unsigned long addr)
Christoph Lameter's avatar
Christoph Lameter committed
1033
1034
1035
1036
1037
1038
{
	if (!check_slab(s, page))
		goto bad;

	if (!check_valid_pointer(s, page, object)) {
		object_err(s, page, object, "Freelist Pointer check fails");
1039
		goto bad;
Christoph Lameter's avatar
Christoph Lameter committed
1040
1041
	}

1042
	if (!check_object(s, page, object, SLUB_RED_INACTIVE))
Christoph Lameter's avatar
Christoph Lameter committed
1043
1044
		goto bad;

Christoph Lameter's avatar
Christoph Lameter committed
1045
1046
1047
1048
	/* Success perform special debug activities for allocs */
	if (s->flags & SLAB_STORE_USER)
		set_track(s, object, TRACK_ALLOC, addr);
	trace(s, page, object, 1);
1049
	init_object(s, object, SLUB_RED_ACTIVE);
Christoph Lameter's avatar
Christoph Lameter committed
1050
	return 1;
Christoph Lameter's avatar
Christoph Lameter committed
1051

Christoph Lameter's avatar
Christoph Lameter committed
1052
1053
1054
1055
1056
bad:
	if (PageSlab(page)) {
		/*
		 * If this is a slab page then lets do the best we can
		 * to avoid issues in the future. Marking all objects
Christoph Lameter's avatar
Christoph Lameter committed
1057
		 * as used avoids touching the remaining objects.
Christoph Lameter's avatar
Christoph Lameter committed
1058
		 */
1059
		slab_fix(s, "Marking all objects used");
1060
		page->inuse = page->objects;
1061
		page->freelist = NULL;
Christoph Lameter's avatar
Christoph Lameter committed
1062
1063
1064
1065
	}
	return 0;
}

1066
1067
1068
static noinline struct kmem_cache_node *free_debug_processing(
	struct kmem_cache *s, struct page *page, void *object,
	unsigned long addr, unsigned long *flags)
Christoph Lameter's avatar
Christoph Lameter committed
1069
{
1070
	struct kmem_cache_node *n = get_node(s, page_to_nid(page));
1071

1072
	spin_lock_irqsave(&n->list_lock, *flags);
1073
1074
	slab_lock(page);

Christoph Lameter's avatar
Christoph Lameter committed
1075
1076
1077
1078
	if (!check_slab(s, page))
		goto fail;

	if (!check_valid_pointer(s, page, object)) {
1079
		slab_err(s, page, "Invalid object pointer 0x%p", object);
Christoph Lameter's avatar
Christoph Lameter committed
1080
1081
1082
1083
		goto fail;
	}

	if (on_freelist(s, page, object)) {
1084
		object_err(s, page, object, "Object already free");
Christoph Lameter's avatar
Christoph Lameter committed
1085
1086
1087
		goto fail;
	}

1088
	if (!check_object(s, page, object, SLUB_RED_ACTIVE))
1089
		goto out;
Christoph Lameter's avatar
Christoph Lameter committed
1090

1091
	if (unlikely(s != page->slab_cache)) {
Ingo Molnar's avatar
Ingo Molnar committed
1092
		if (!PageSlab(page)) {
1093
1094
			slab_err(s, page, "Attempt to free object(0x%p) "
				"outside of slab", object);
1095
		} else if (!page->slab_cache) {
Christoph Lameter's avatar
Christoph Lameter committed
1096
			printk(KERN_ERR
1097
				"SLUB <none>: no slab for object 0x%p.\n",
Christoph Lameter's avatar
Christoph Lameter committed
1098
						object);
1099
			dump_stack();
1100
		} else
1101
1102
			object_err(s, page, object,
					"page slab pointer corrupt.");
Christoph Lameter's avatar
Christoph Lameter committed
1103
1104
		goto fail;
	}
Christoph Lameter's avatar
Christoph Lameter committed
1105
1106
1107
1108

	if (s->flags & SLAB_STORE_USER)
		set_track(s, object, TRACK_FREE, addr);
	trace(s, page, object, 0);
1109
	init_object(s, object, SLUB_RED_INACTIVE);
1110
out:
1111
	slab_unlock(page);
1112
1113
1114
1115
1116
	/*
	 * Keep node_lock to preserve integrity
	 * until the object is actually freed
	 */
	return n;
Christoph Lameter's avatar
Christoph Lameter committed
1117

Christoph Lameter's avatar
Christoph Lameter committed
1118
fail:
1119
1120
	slab_unlock(page);
	spin_unlock_irqrestore(&n->list_lock, *flags);
1121
	slab_fix(s, "Object at 0x%p not freed", object);
1122
	return NULL;
Christoph Lameter's avatar
Christoph Lameter committed
1123
1124
}

1125
1126
static int __init setup_slub_debug(char *str)
{
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
	slub_debug = DEBUG_DEFAULT_FLAGS;
	if (*str++ != '=' || !*str)
		/*
		 * No options specified. Switch on full debugging.
		 */
		goto out;

	if (*str == ',')
		/*
		 * No options but restriction on slabs. This means full
		 * debugging for slabs matching a pattern.
		 */
		goto check_slabs;

1141
1142
1143
1144
1145
1146
1147
1148
1149
	if (tolower(*str) == 'o') {
		/*
		 * Avoid enabling debugging on caches if its minimum order
		 * would increase as a result.
		 */
		disable_higher_order_debug = 1;
		goto out;
	}

1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
	slub_debug = 0;
	if (*str == '-')
		/*
		 * Switch off all debugging measures.
		 */
		goto out;

	/*
	 * Determine which debug features should be switched on
	 */
1160
	for (; *str && *str != ','; str++) {
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
		switch (tolower(*str)) {
		case 'f':
			slub_debug |= SLAB_DEBUG_FREE;
			break;
		case 'z':
			slub_debug |= SLAB_RED_ZONE;
			break;
		case 'p':
			slub_debug |= SLAB_POISON;
			break;
		case 'u':
			slub_debug |= SLAB_STORE_USER;
			break;
		case 't':
			slub_debug |= SLAB_TRACE;
			break;
1177
1178
1179
		case 'a':
			slub_debug |= SLAB_FAILSLAB;
			break;
1180
1181
		default:
			printk(KERN_ERR "slub_debug option '%c' "
1182
				"unknown. skipped\n", *str);
1183
		}
1184
1185