slub.c 130 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>
21
#include <linux/notifier.h>
Christoph Lameter's avatar
Christoph Lameter committed
22
#include <linux/seq_file.h>
23
#include <linux/kasan.h>
Vegard Nossum's avatar
Vegard Nossum committed
24
#include <linux/kmemcheck.h>
Christoph Lameter's avatar
Christoph Lameter committed
25
26
27
28
#include <linux/cpu.h>
#include <linux/cpuset.h>
#include <linux/mempolicy.h>
#include <linux/ctype.h>
29
#include <linux/debugobjects.h>
Christoph Lameter's avatar
Christoph Lameter committed
30
#include <linux/kallsyms.h>
31
#include <linux/memory.h>
Roman Zippel's avatar
Roman Zippel committed
32
#include <linux/math64.h>
Akinobu Mita's avatar
Akinobu Mita committed
33
#include <linux/fault-inject.h>
34
#include <linux/stacktrace.h>
35
#include <linux/prefetch.h>
36
#include <linux/memcontrol.h>
Christoph Lameter's avatar
Christoph Lameter committed
37

38
39
#include <trace/events/kmem.h>

40
41
#include "internal.h"

Christoph Lameter's avatar
Christoph Lameter committed
42
43
/*
 * Lock order:
44
 *   1. slab_mutex (Global Mutex)
45
46
 *   2. node->list_lock
 *   3. slab_lock(page) (Only on some arches and for debugging)
Christoph Lameter's avatar
Christoph Lameter committed
47
 *
48
 *   slab_mutex
49
 *
50
 *   The role of the slab_mutex is to protect the list of all the slabs
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 *   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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 *
 *   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
85
86
 * 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
87
 * freed then the slab will show up again on the partial lists.
Christoph Lameter's avatar
Christoph Lameter committed
88
89
 * We track full slabs for debugging purposes though because otherwise we
 * cannot scan all objects.
Christoph Lameter's avatar
Christoph Lameter committed
90
91
92
93
94
95
96
 *
 * 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.
 *
97
98
99
100
101
102
103
104
105
106
107
108
 * 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
109
 * 			freelist that allows lockless access to
110
111
 * 			free objects in addition to the regular freelist
 * 			that requires the slab lock.
Christoph Lameter's avatar
Christoph Lameter committed
112
113
114
 *
 * PageError		Slab requires special handling due to debug
 * 			options set. This moves	slab handling out of
115
 * 			the fast path and disables lockless freelists.
Christoph Lameter's avatar
Christoph Lameter committed
116
117
 */

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

127
128
129
130
131
132
133
134
135
static inline bool kmem_cache_has_cpu_partial(struct kmem_cache *s)
{
#ifdef CONFIG_SLUB_CPU_PARTIAL
	return !kmem_cache_debug(s);
#else
	return false;
#endif
}

Christoph Lameter's avatar
Christoph Lameter committed
136
137
138
139
140
141
142
143
144
145
146
/*
 * 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

147
148
149
/* Enable to log cmpxchg failures */
#undef SLUB_DEBUG_CMPXCHG

150
151
152
153
/*
 * Mininum number of partial slabs. These will be left on the partial
 * lists even if they are empty. kmem_cache_shrink may reclaim them.
 */
154
#define MIN_PARTIAL 5
Christoph Lameter's avatar
Christoph Lameter committed
155

156
157
158
/*
 * Maximum number of desirable partial slabs.
 * The existence of more partial slabs makes kmem_cache_shrink
159
 * sort the partial list by the number of objects in use.
160
161
162
 */
#define MAX_PARTIAL 10

Christoph Lameter's avatar
Christoph Lameter committed
163
164
#define DEBUG_DEFAULT_FLAGS (SLAB_DEBUG_FREE | SLAB_RED_ZONE | \
				SLAB_POISON | SLAB_STORE_USER)
Christoph Lameter's avatar
Christoph Lameter committed
165

166
/*
167
168
169
 * 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.
170
 */
171
#define DEBUG_METADATA_FLAGS (SLAB_RED_ZONE | SLAB_POISON | SLAB_STORE_USER)
172

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

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

#ifdef CONFIG_SMP
static struct notifier_block slab_notifier;
#endif

185
186
187
/*
 * Tracking user of a slab.
 */
188
#define TRACK_ADDRS_COUNT 16
189
struct track {
190
	unsigned long addr;	/* Called from address */
191
192
193
#ifdef CONFIG_STACKTRACE
	unsigned long addrs[TRACK_ADDRS_COUNT];	/* Called from address */
#endif
194
195
196
197
198
199
200
	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 };

201
#ifdef CONFIG_SYSFS
Christoph Lameter's avatar
Christoph Lameter committed
202
203
static int sysfs_slab_add(struct kmem_cache *);
static int sysfs_slab_alias(struct kmem_cache *, const char *);
204
static void memcg_propagate_slab_attrs(struct kmem_cache *s);
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 memcg_propagate_slab_attrs(struct kmem_cache *s) { }
Christoph Lameter's avatar
Christoph Lameter committed
210
211
#endif

212
static inline void stat(const struct kmem_cache *s, enum stat_item si)
213
214
{
#ifdef CONFIG_SLUB_STATS
215
216
217
218
219
	/*
	 * The rmw is racy on a preemptible kernel but this is acceptable, so
	 * avoid this_cpu_add()'s irq-disable overhead.
	 */
	raw_cpu_inc(s->cpu_slab->stat[si]);
220
221
222
#endif
}

Christoph Lameter's avatar
Christoph Lameter committed
223
224
225
226
/********************************************************************
 * 			Core slab cache functions
 *******************************************************************/

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

233
	if (!object)
234
235
		return 1;

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

	return 1;
}

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

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

255
256
257
258
259
260
261
262
263
264
265
266
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;
}

267
268
269
270
271
272
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 */
273
274
#define for_each_object(__p, __s, __addr, __objects) \
	for (__p = (__addr); __p < (__addr) + (__objects) * (__s)->size;\
275
276
			__p += (__s)->size)

277
278
279
280
#define for_each_object_idx(__p, __idx, __s, __addr, __objects) \
	for (__p = (__addr), __idx = 1; __idx <= __objects;\
			__p += (__s)->size, __idx++)

281
282
283
284
285
286
/* 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;
}

287
288
289
290
291
292
293
294
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))
295
		return s->object_size;
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310

#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;
}

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

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

	return x;
}

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

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

336
337
338
339
340
341
342
343
344
345
346
347
348
/*
 * 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);
}

349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
static inline void set_page_slub_counters(struct page *page, unsigned long counters_new)
{
	struct page tmp;
	tmp.counters = counters_new;
	/*
	 * page->counters can cover frozen/inuse/objects as well
	 * as page->_count.  If we assign to ->counters directly
	 * we run the risk of losing updates to page->_count, so
	 * be careful and only assign to the fields we need.
	 */
	page->frozen  = tmp.frozen;
	page->inuse   = tmp.inuse;
	page->objects = tmp.objects;
}

364
365
366
367
368
369
370
/* 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());
371
372
#if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
    defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
373
	if (s->flags & __CMPXCHG_DOUBLE) {
374
		if (cmpxchg_double(&page->freelist, &page->counters,
375
376
				   freelist_old, counters_old,
				   freelist_new, counters_new))
377
			return true;
378
379
380
381
	} else
#endif
	{
		slab_lock(page);
382
383
		if (page->freelist == freelist_old &&
					page->counters == counters_old) {
384
			page->freelist = freelist_new;
385
			set_page_slub_counters(page, counters_new);
386
			slab_unlock(page);
387
			return true;
388
389
390
391
392
393
394
395
		}
		slab_unlock(page);
	}

	cpu_relax();
	stat(s, CMPXCHG_DOUBLE_FAIL);

#ifdef SLUB_DEBUG_CMPXCHG
396
	pr_info("%s %s: cmpxchg double redo ", n, s->name);
397
398
#endif

399
	return false;
400
401
}

402
403
404
405
406
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)
{
407
408
#if defined(CONFIG_HAVE_CMPXCHG_DOUBLE) && \
    defined(CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
409
	if (s->flags & __CMPXCHG_DOUBLE) {
410
		if (cmpxchg_double(&page->freelist, &page->counters,
411
412
				   freelist_old, counters_old,
				   freelist_new, counters_new))
413
			return true;
414
415
416
	} else
#endif
	{
417
418
419
		unsigned long flags;

		local_irq_save(flags);
420
		slab_lock(page);
421
422
		if (page->freelist == freelist_old &&
					page->counters == counters_old) {
423
			page->freelist = freelist_new;
424
			set_page_slub_counters(page, counters_new);
425
			slab_unlock(page);
426
			local_irq_restore(flags);
427
			return true;
428
		}
429
		slab_unlock(page);
430
		local_irq_restore(flags);
431
432
433
434
435
436
	}

	cpu_relax();
	stat(s, CMPXCHG_DOUBLE_FAIL);

#ifdef SLUB_DEBUG_CMPXCHG
437
	pr_info("%s %s: cmpxchg double redo ", n, s->name);
438
439
#endif

440
	return false;
441
442
}

443
#ifdef CONFIG_SLUB_DEBUG
444
445
446
/*
 * Determine a map of object in use on a page.
 *
447
 * Node listlock must be held to guarantee that the page does
448
449
450
451
452
453
454
455
456
457
458
 * 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);
}

459
460
461
/*
 * Debug settings:
 */
462
463
464
#ifdef CONFIG_SLUB_DEBUG_ON
static int slub_debug = DEBUG_DEFAULT_FLAGS;
#else
465
static int slub_debug;
466
#endif
467
468

static char *slub_debug_slabs;
469
static int disable_higher_order_debug;
470

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
/*
 * slub is about to manipulate internal object metadata.  This memory lies
 * outside the range of the allocated object, so accessing it would normally
 * be reported by kasan as a bounds error.  metadata_access_enable() is used
 * to tell kasan that these accesses are OK.
 */
static inline void metadata_access_enable(void)
{
	kasan_disable_current();
}

static inline void metadata_access_disable(void)
{
	kasan_enable_current();
}

Christoph Lameter's avatar
Christoph Lameter committed
487
488
489
490
491
/*
 * Object debugging
 */
static void print_section(char *text, u8 *addr, unsigned int length)
{
492
	metadata_access_enable();
493
494
	print_hex_dump(KERN_ERR, text, DUMP_PREFIX_ADDRESS, 16, 1, addr,
			length, 1);
495
	metadata_access_disable();
Christoph Lameter's avatar
Christoph Lameter committed
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
}

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,
512
			enum track_item alloc, unsigned long addr)
Christoph Lameter's avatar
Christoph Lameter committed
513
{
Akinobu Mita's avatar
Akinobu Mita committed
514
	struct track *p = get_track(s, object, alloc);
Christoph Lameter's avatar
Christoph Lameter committed
515
516

	if (addr) {
517
518
519
520
521
522
523
524
#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;
525
		metadata_access_enable();
526
		save_stack_trace(&trace);
527
		metadata_access_disable();
528
529
530
531
532
533
534
535
536

		/* 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
537
538
		p->addr = addr;
		p->cpu = smp_processor_id();
539
		p->pid = current->pid;
Christoph Lameter's avatar
Christoph Lameter committed
540
541
542
543
544
545
546
		p->when = jiffies;
	} else
		memset(p, 0, sizeof(struct track));
}

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

550
551
	set_track(s, object, TRACK_FREE, 0UL);
	set_track(s, object, TRACK_ALLOC, 0UL);
Christoph Lameter's avatar
Christoph Lameter committed
552
553
554
555
556
557
558
}

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

559
560
	pr_err("INFO: %s in %pS age=%lu cpu=%u pid=%d\n",
	       s, (void *)t->addr, jiffies - t->when, t->cpu, t->pid);
561
562
563
564
565
#ifdef CONFIG_STACKTRACE
	{
		int i;
		for (i = 0; i < TRACK_ADDRS_COUNT; i++)
			if (t->addrs[i])
566
				pr_err("\t%pS\n", (void *)t->addrs[i]);
567
568
569
570
			else
				break;
	}
#endif
571
572
573
574
575
576
577
578
579
580
581
582
583
}

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)
{
584
	pr_err("INFO: Slab 0x%p objects=%u used=%u fp=0x%p flags=0x%04lx\n",
585
	       page, page->objects, page->inuse, page->freelist, page->flags);
586
587
588
589
590

}

static void slab_bug(struct kmem_cache *s, char *fmt, ...)
{
591
	struct va_format vaf;
592
593
594
	va_list args;

	va_start(args, fmt);
595
596
	vaf.fmt = fmt;
	vaf.va = &args;
597
	pr_err("=============================================================================\n");
598
	pr_err("BUG %s (%s): %pV\n", s->name, print_tainted(), &vaf);
599
	pr_err("-----------------------------------------------------------------------------\n\n");
600

601
	add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
602
	va_end(args);
Christoph Lameter's avatar
Christoph Lameter committed
603
604
}

605
606
static void slab_fix(struct kmem_cache *s, char *fmt, ...)
{
607
	struct va_format vaf;
608
609
610
	va_list args;

	va_start(args, fmt);
611
612
613
	vaf.fmt = fmt;
	vaf.va = &args;
	pr_err("FIX %s: %pV\n", s->name, &vaf);
614
615
616
617
	va_end(args);
}

static void print_trailer(struct kmem_cache *s, struct page *page, u8 *p)
Christoph Lameter's avatar
Christoph Lameter committed
618
619
{
	unsigned int off;	/* Offset of last byte */
620
	u8 *addr = page_address(page);
621
622
623
624
625

	print_tracking(s, p);

	print_page_info(page);

626
627
	pr_err("INFO: Object 0x%p @offset=%tu fp=0x%p\n\n",
	       p, p - addr, get_freepointer(s, p));
628
629

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

632
	print_section("Object ", p, min_t(unsigned long, s->object_size,
633
				PAGE_SIZE));
Christoph Lameter's avatar
Christoph Lameter committed
634
	if (s->flags & SLAB_RED_ZONE)
635
636
		print_section("Redzone ", p + s->object_size,
			s->inuse - s->object_size);
Christoph Lameter's avatar
Christoph Lameter committed
637
638
639
640
641
642

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

643
	if (s->flags & SLAB_STORE_USER)
Christoph Lameter's avatar
Christoph Lameter committed
644
645
646
647
		off += 2 * sizeof(struct track);

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

	dump_stack();
Christoph Lameter's avatar
Christoph Lameter committed
651
652
}

653
void object_err(struct kmem_cache *s, struct page *page,
Christoph Lameter's avatar
Christoph Lameter committed
654
655
			u8 *object, char *reason)
{
656
	slab_bug(s, "%s", reason);
657
	print_trailer(s, page, object);
Christoph Lameter's avatar
Christoph Lameter committed
658
659
}

660
661
static void slab_err(struct kmem_cache *s, struct page *page,
			const char *fmt, ...)
Christoph Lameter's avatar
Christoph Lameter committed
662
663
664
665
{
	va_list args;
	char buf[100];

666
667
	va_start(args, fmt);
	vsnprintf(buf, sizeof(buf), fmt, args);
Christoph Lameter's avatar
Christoph Lameter committed
668
	va_end(args);
669
	slab_bug(s, "%s", buf);
670
	print_page_info(page);
Christoph Lameter's avatar
Christoph Lameter committed
671
672
673
	dump_stack();
}

674
static void init_object(struct kmem_cache *s, void *object, u8 val)
Christoph Lameter's avatar
Christoph Lameter committed
675
676
677
678
{
	u8 *p = object;

	if (s->flags & __OBJECT_POISON) {
679
680
		memset(p, POISON_FREE, s->object_size - 1);
		p[s->object_size - 1] = POISON_END;
Christoph Lameter's avatar
Christoph Lameter committed
681
682
683
	}

	if (s->flags & SLAB_RED_ZONE)
684
		memset(p + s->object_size, val, s->inuse - s->object_size);
Christoph Lameter's avatar
Christoph Lameter committed
685
686
}

687
688
689
690
691
692
693
694
695
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,
696
			u8 *start, unsigned int value, unsigned int bytes)
697
698
699
700
{
	u8 *fault;
	u8 *end;

701
	metadata_access_enable();
702
	fault = memchr_inv(start, value, bytes);
703
	metadata_access_disable();
704
705
706
707
708
709
710
711
	if (!fault)
		return 1;

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

	slab_bug(s, "%s overwritten", what);
712
	pr_err("INFO: 0x%p-0x%p. First byte 0x%x instead of 0x%x\n",
713
714
715
716
717
					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
718
719
720
721
722
723
724
725
726
}

/*
 * 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
727
 *
Christoph Lameter's avatar
Christoph Lameter committed
728
729
730
 * 	Poisoning uses 0x6b (POISON_FREE) and the last byte is
 * 	0xa5 (POISON_END)
 *
731
 * object + s->object_size
Christoph Lameter's avatar
Christoph Lameter committed
732
 * 	Padding to reach word boundary. This is also used for Redzoning.
Christoph Lameter's avatar
Christoph Lameter committed
733
 * 	Padding is extended by another word if Redzoning is enabled and
734
 * 	object_size == inuse.
Christoph Lameter's avatar
Christoph Lameter committed
735
 *
Christoph Lameter's avatar
Christoph Lameter committed
736
737
738
739
 * 	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
740
741
 * 	Meta data starts here.
 *
Christoph Lameter's avatar
Christoph Lameter committed
742
743
 * 	A. Free pointer (if we cannot overwrite object on free)
 * 	B. Tracking data for SLAB_STORE_USER
Christoph Lameter's avatar
Christoph Lameter committed
744
 * 	C. Padding to reach required alignment boundary or at mininum
Christoph Lameter's avatar
Christoph Lameter committed
745
 * 		one word if debugging is on to be able to detect writes
Christoph Lameter's avatar
Christoph Lameter committed
746
747
748
 * 		before the word boundary.
 *
 *	Padding is done using 0x5a (POISON_INUSE)
Christoph Lameter's avatar
Christoph Lameter committed
749
750
 *
 * object + s->size
Christoph Lameter's avatar
Christoph Lameter committed
751
 * 	Nothing is used beyond s->size.
Christoph Lameter's avatar
Christoph Lameter committed
752
 *
753
 * If slabcaches are merged then the object_size and inuse boundaries are mostly
Christoph Lameter's avatar
Christoph Lameter committed
754
 * ignored. And therefore no slab options that rely on these boundaries
Christoph Lameter's avatar
Christoph Lameter committed
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 * 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;

773
774
	return check_bytes_and_report(s, page, p, "Object padding",
				p + off, POISON_INUSE, s->size - off);
Christoph Lameter's avatar
Christoph Lameter committed
775
776
}

777
/* Check the pad bytes at the end of a slab page */
Christoph Lameter's avatar
Christoph Lameter committed
778
779
static int slab_pad_check(struct kmem_cache *s, struct page *page)
{
780
781
782
783
784
	u8 *start;
	u8 *fault;
	u8 *end;
	int length;
	int remainder;
Christoph Lameter's avatar
Christoph Lameter committed
785
786
787
788

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

789
	start = page_address(page);
790
	length = (PAGE_SIZE << compound_order(page)) - s->reserved;
791
792
	end = start + length;
	remainder = length % s->size;
Christoph Lameter's avatar
Christoph Lameter committed
793
794
795
	if (!remainder)
		return 1;

796
	metadata_access_enable();
797
	fault = memchr_inv(end - remainder, POISON_INUSE, remainder);
798
	metadata_access_disable();
799
800
801
802
803
804
	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);
805
	print_section("Padding ", end - remainder, remainder);
806

Eric Dumazet's avatar
Eric Dumazet committed
807
	restore_bytes(s, "slab padding", POISON_INUSE, end - remainder, end);
808
	return 0;
Christoph Lameter's avatar
Christoph Lameter committed
809
810
811
}

static int check_object(struct kmem_cache *s, struct page *page,
812
					void *object, u8 val)
Christoph Lameter's avatar
Christoph Lameter committed
813
814
{
	u8 *p = object;
815
	u8 *endobject = object + s->object_size;
Christoph Lameter's avatar
Christoph Lameter committed
816
817

	if (s->flags & SLAB_RED_ZONE) {
818
		if (!check_bytes_and_report(s, page, object, "Redzone",
819
			endobject, val, s->inuse - s->object_size))
Christoph Lameter's avatar
Christoph Lameter committed
820
821
			return 0;
	} else {
822
		if ((s->flags & SLAB_POISON) && s->object_size < s->inuse) {
Ingo Molnar's avatar
Ingo Molnar committed
823
			check_bytes_and_report(s, page, p, "Alignment padding",
824
825
				endobject, POISON_INUSE,
				s->inuse - s->object_size);
Ingo Molnar's avatar
Ingo Molnar committed
826
		}
Christoph Lameter's avatar
Christoph Lameter committed
827
828
829
	}

	if (s->flags & SLAB_POISON) {
830
		if (val != SLUB_RED_ACTIVE && (s->flags & __OBJECT_POISON) &&
831
			(!check_bytes_and_report(s, page, p, "Poison", p,
832
					POISON_FREE, s->object_size - 1) ||
833
			 !check_bytes_and_report(s, page, p, "Poison",
834
				p + s->object_size - 1, POISON_END, 1)))
Christoph Lameter's avatar
Christoph Lameter committed
835
836
837
838
839
840
841
			return 0;
		/*
		 * check_pad_bytes cleans up on its own.
		 */
		check_pad_bytes(s, page, p);
	}

842
	if (!s->offset && val == SLUB_RED_ACTIVE)
Christoph Lameter's avatar
Christoph Lameter committed
843
844
845
846
847
848
849
850
851
852
		/*
		 * 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
853
		 * No choice but to zap it and thus lose the remainder
Christoph Lameter's avatar
Christoph Lameter committed
854
		 * of the free objects in this slab. May cause
Christoph Lameter's avatar
Christoph Lameter committed
855
		 * another error because the object count is now wrong.
Christoph Lameter's avatar
Christoph Lameter committed
856
		 */
857
		set_freepointer(s, p, NULL);
Christoph Lameter's avatar
Christoph Lameter committed
858
859
860
861
862
863
864
		return 0;
	}
	return 1;
}

static int check_slab(struct kmem_cache *s, struct page *page)
{
865
866
	int maxobj;

Christoph Lameter's avatar
Christoph Lameter committed
867
868
869
	VM_BUG_ON(!irqs_disabled());

	if (!PageSlab(page)) {
870
		slab_err(s, page, "Not a valid slab page");
Christoph Lameter's avatar
Christoph Lameter committed
871
872
		return 0;
	}
873

874
	maxobj = order_objects(compound_order(page), s->size, s->reserved);
875
876
	if (page->objects > maxobj) {
		slab_err(s, page, "objects %u > max %u",
877
			page->objects, maxobj);
878
879
880
		return 0;
	}
	if (page->inuse > page->objects) {
881
		slab_err(s, page, "inuse %u > max %u",
882
			page->inuse, page->objects);
Christoph Lameter's avatar
Christoph Lameter committed
883
884
885
886
887
888
889
890
		return 0;
	}
	/* Slab_pad_check fixes things up after itself */
	slab_pad_check(s, page);
	return 1;
}

/*
Christoph Lameter's avatar
Christoph Lameter committed
891
892
 * 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
893
894
895
896
 */
static int on_freelist(struct kmem_cache *s, struct page *page, void *search)
{
	int nr = 0;
897
	void *fp;
Christoph Lameter's avatar
Christoph Lameter committed
898
	void *object = NULL;
899
	int max_objects;
Christoph Lameter's avatar
Christoph Lameter committed
900

901
	fp = page->freelist;
902
	while (fp && nr <= page->objects) {
Christoph Lameter's avatar
Christoph Lameter committed
903
904
905
906
907
908
		if (fp == search)
			return 1;
		if (!check_valid_pointer(s, page, fp)) {
			if (object) {
				object_err(s, page, object,
					"Freechain corrupt");
909
				set_freepointer(s, object, NULL);
Christoph Lameter's avatar
Christoph Lameter committed
910
			} else {
911
				slab_err(s, page, "Freepointer corrupt");
912
				page->freelist = NULL;
913
				page->inuse = page->objects;
914
				slab_fix(s, "Freelist cleared");
Christoph Lameter's avatar
Christoph Lameter committed
915
916
917
918
919
920
921
922
923
				return 0;
			}
			break;
		}
		object = fp;
		fp = get_freepointer(s, object);
		nr++;
	}

924
	max_objects = order_objects(compound_order(page), s->size, s->reserved);
925
926
	if (max_objects > MAX_OBJS_PER_PAGE)
		max_objects = MAX_OBJS_PER_PAGE;
927
928
929
930
931
932
933

	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.");
	}
934
	if (page->inuse != page->objects - nr) {
935
		slab_err(s, page, "Wrong object count. Counter is %d but "
936
937
			"counted were %d", page->inuse, page->objects - nr);
		page->inuse = page->objects - nr;
938
		slab_fix(s, "Object count adjusted.");
Christoph Lameter's avatar
Christoph Lameter committed
939
940
941
942
	}
	return search == NULL;
}

943
944
static void trace(struct kmem_cache *s, struct page *page, void *object,
								int alloc)
Christoph Lameter's avatar
Christoph Lameter committed
945
946
{
	if (s->flags & SLAB_TRACE) {
947
		pr_info("TRACE %s %s 0x%p inuse=%d fp=0x%p\n",
Christoph Lameter's avatar
Christoph Lameter committed
948
949
950
951
952
953
			s->name,
			alloc ? "alloc" : "free",
			object, page->inuse,
			page->freelist);

		if (!alloc)
954
955
			print_section("Object ", (void *)object,
					s->object_size);
Christoph Lameter's avatar
Christoph Lameter committed
956
957
958
959
960

		dump_stack();
	}
}

961
/*
Christoph Lameter's avatar
Christoph Lameter committed
962
 * Tracking of fully allocated slabs for debugging purposes.
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
	lockdep_assert_held(&n->list_lock);
971
972
973
	list_add(&page->lru, &n->full);
}

Peter Zijlstra's avatar
Peter Zijlstra committed
974
static void remove_full(struct kmem_cache *s, struct kmem_cache_node *n, struct page *page)
975
976
977
978
{
	if (!(s->flags & SLAB_STORE_USER))
		return;

979
	lockdep_assert_held(&n->list_lock);
980
981
982
	list_del(&page->lru);
}

983
984
985
986
987
988
989
990
/* 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);
}

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

996
static inline void inc_slabs_node(struct kmem_cache *s, int node, int objects)
997
998
999
1000
1001
1002
1003
1004
1005
{
	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).
	 */
1006
	if (likely(n)) {
1007
		atomic_long_inc(&n->nr_slabs);
1008
1009
		atomic_long_add(objects, &n->total_objects);
	}
1010
}
1011
static inline void dec_slabs_node(struct kmem_cache *s, int node, int objects)
1012
1013
1014
1015
{
	struct kmem_cache_node *n = get_node(s, node);

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

/* Object debug checks for alloc/free paths */
Christoph Lameter's avatar
Christoph Lameter committed
1020
1021
1022
1023
1024
1025
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;

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

1030
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) {
1096
1097
			pr_err("SLUB <none>: no slab for object 0x%p.\n",
			       object);
1098
			dump_stack();
Pekka Enberg's avatar