2 * SLOB Allocator: Simple List Of Blocks
4 * Matt Mackall <mpm@selenic.com> 12/30/03
6 * NUMA support by Paul Mundt, 2007.
10 * The core of SLOB is a traditional K&R style heap allocator, with
11 * support for returning aligned objects. The granularity of this
12 * allocator is as little as 2 bytes, however typically most architectures
13 * will require 4 bytes on 32-bit and 8 bytes on 64-bit.
15 * The slob heap is a set of linked list of pages from alloc_pages(),
16 * and within each page, there is a singly-linked list of free blocks
17 * (slob_t). The heap is grown on demand. To reduce fragmentation,
18 * heap pages are segregated into three lists, with objects less than
19 * 256 bytes, objects less than 1024 bytes, and all other objects.
21 * Allocation from heap involves first searching for a page with
22 * sufficient free blocks (using a next-fit-like approach) followed by
23 * a first-fit scan of the page. Deallocation inserts objects back
24 * into the free list in address order, so this is effectively an
25 * address-ordered first fit.
27 * Above this is an implementation of kmalloc/kfree. Blocks returned
28 * from kmalloc are prepended with a 4-byte header with the kmalloc size.
29 * If kmalloc is asked for objects of PAGE_SIZE or larger, it calls
30 * alloc_pages() directly, allocating compound pages so the page order
31 * does not have to be separately tracked, and also stores the exact
32 * allocation size in page->private so that it can be used to accurately
33 * provide ksize(). These objects are detected in kfree() because slob_page()
36 * SLAB is emulated on top of SLOB by simply calling constructors and
37 * destructors for every SLAB allocation. Objects are returned with the
38 * 4-byte alignment unless the SLAB_HWCACHE_ALIGN flag is set, in which
39 * case the low-level allocator will fragment blocks to create the proper
40 * alignment. Again, objects of page-size or greater are allocated by
41 * calling alloc_pages(). As SLAB objects know their size, no separate
42 * size bookkeeping is necessary and there is essentially no allocation
43 * space overhead, and compound pages aren't needed for multi-page
46 * NUMA support in SLOB is fairly simplistic, pushing most of the real
47 * logic down to the page allocator, and simply doing the node accounting
48 * on the upper levels. In the event that a node id is explicitly
49 * provided, alloc_pages_node() with the specified node id is used
50 * instead. The common case (or when the node id isn't explicitly provided)
51 * will default to the current node, as per numa_node_id().
53 * Node aware pages are still inserted in to the global freelist, and
54 * these are scanned for by matching against the node id encoded in the
55 * page flags. As a result, block allocations that can be satisfied from
56 * the freelist will only be done so on pages residing on the same node,
57 * in order to prevent random node placement.
60 #include <linux/kernel.h>
61 #include <linux/slab.h>
63 #include <linux/cache.h>
64 #include <linux/init.h>
65 #include <linux/module.h>
66 #include <linux/rcupdate.h>
67 #include <linux/list.h>
68 #include <asm/atomic.h>
71 * slob_block has a field 'units', which indicates size of block if +ve,
72 * or offset of next block if -ve (in SLOB_UNITs).
74 * Free blocks of size 1 unit simply contain the offset of the next block.
75 * Those with larger size contain their size in the first SLOB_UNIT of
76 * memory, and the offset of the next free block in the second SLOB_UNIT.
78 #if PAGE_SIZE <= (32767 * 2)
79 typedef s16 slobidx_t;
81 typedef s32 slobidx_t;
87 typedef struct slob_block slob_t;
90 * We use struct page fields to manage some slob allocation aspects,
91 * however to avoid the horrible mess in include/linux/mm_types.h, we'll
92 * just define our own struct page type variant here.
97 unsigned long flags; /* mandatory */
98 atomic_t _count; /* mandatory */
99 slobidx_t units; /* free units left in page */
100 unsigned long pad[2];
101 slob_t *free; /* first free slob_t in page */
102 struct list_head list; /* linked list of free pages */
107 static inline void struct_slob_page_wrong_size(void)
108 { BUILD_BUG_ON(sizeof(struct slob_page) != sizeof(struct page)); }
111 * free_slob_page: call before a slob_page is returned to the page allocator.
113 static inline void free_slob_page(struct slob_page *sp)
115 reset_page_mapcount(&sp->page);
116 sp->page.mapping = NULL;
120 * All partially free slob pages go on these lists.
122 #define SLOB_BREAK1 256
123 #define SLOB_BREAK2 1024
124 static LIST_HEAD(free_slob_small);
125 static LIST_HEAD(free_slob_medium);
126 static LIST_HEAD(free_slob_large);
129 * slob_page: True for all slob pages (false for bigblock pages)
131 static inline int slob_page(struct slob_page *sp)
133 return test_bit(PG_active, &sp->flags);
136 static inline void set_slob_page(struct slob_page *sp)
138 __set_bit(PG_active, &sp->flags);
141 static inline void clear_slob_page(struct slob_page *sp)
143 __clear_bit(PG_active, &sp->flags);
147 * slob_page_free: true for pages on free_slob_pages list.
149 static inline int slob_page_free(struct slob_page *sp)
151 return test_bit(PG_private, &sp->flags);
154 static void set_slob_page_free(struct slob_page *sp, struct list_head *list)
156 list_add(&sp->list, list);
157 __set_bit(PG_private, &sp->flags);
160 static inline void clear_slob_page_free(struct slob_page *sp)
163 __clear_bit(PG_private, &sp->flags);
166 #define SLOB_UNIT sizeof(slob_t)
167 #define SLOB_UNITS(size) (((size) + SLOB_UNIT - 1)/SLOB_UNIT)
168 #define SLOB_ALIGN L1_CACHE_BYTES
171 * struct slob_rcu is inserted at the tail of allocated slob blocks, which
172 * were created with a SLAB_DESTROY_BY_RCU slab. slob_rcu is used to free
173 * the block using call_rcu.
176 struct rcu_head head;
181 * slob_lock protects all slob allocator structures.
183 static DEFINE_SPINLOCK(slob_lock);
186 * Encode the given size and next info into a free slob block s.
188 static void set_slob(slob_t *s, slobidx_t size, slob_t *next)
190 slob_t *base = (slob_t *)((unsigned long)s & PAGE_MASK);
191 slobidx_t offset = next - base;
197 s[0].units = -offset;
201 * Return the size of a slob block.
203 static slobidx_t slob_units(slob_t *s)
211 * Return the next free slob block pointer after this one.
213 static slob_t *slob_next(slob_t *s)
215 slob_t *base = (slob_t *)((unsigned long)s & PAGE_MASK);
226 * Returns true if s is the last free block in its page.
228 static int slob_last(slob_t *s)
230 return !((unsigned long)slob_next(s) & ~PAGE_MASK);
233 static void *slob_new_page(gfp_t gfp, int order, int node)
239 page = alloc_pages_node(node, gfp, order);
242 page = alloc_pages(gfp, order);
247 return page_address(page);
251 * Allocate a slob block within a given slob_page sp.
253 static void *slob_page_alloc(struct slob_page *sp, size_t size, int align)
255 slob_t *prev, *cur, *aligned = 0;
256 int delta = 0, units = SLOB_UNITS(size);
258 for (prev = NULL, cur = sp->free; ; prev = cur, cur = slob_next(cur)) {
259 slobidx_t avail = slob_units(cur);
262 aligned = (slob_t *)ALIGN((unsigned long)cur, align);
263 delta = aligned - cur;
265 if (avail >= units + delta) { /* room enough? */
268 if (delta) { /* need to fragment head to align? */
269 next = slob_next(cur);
270 set_slob(aligned, avail - delta, next);
271 set_slob(cur, delta, aligned);
274 avail = slob_units(cur);
277 next = slob_next(cur);
278 if (avail == units) { /* exact fit? unlink. */
280 set_slob(prev, slob_units(prev), next);
283 } else { /* fragment */
285 set_slob(prev, slob_units(prev), cur + units);
287 sp->free = cur + units;
288 set_slob(cur + units, avail - units, next);
293 clear_slob_page_free(sp);
302 * slob_alloc: entry point into the slob allocator.
304 static void *slob_alloc(size_t size, gfp_t gfp, int align, int node)
306 struct slob_page *sp;
307 struct list_head *prev;
308 struct list_head *slob_list;
312 if (size < SLOB_BREAK1)
313 slob_list = &free_slob_small;
314 else if (size < SLOB_BREAK2)
315 slob_list = &free_slob_medium;
317 slob_list = &free_slob_large;
319 spin_lock_irqsave(&slob_lock, flags);
320 /* Iterate through each partially free page, try to find room */
321 list_for_each_entry(sp, slob_list, list) {
324 * If there's a node specification, search for a partial
325 * page with a matching node id in the freelist.
327 if (node != -1 && page_to_nid(&sp->page) != node)
330 /* Enough room on this page? */
331 if (sp->units < SLOB_UNITS(size))
334 /* Attempt to alloc */
335 prev = sp->list.prev;
336 b = slob_page_alloc(sp, size, align);
340 /* Improve fragment distribution and reduce our average
341 * search time by starting our next search here. (see
342 * Knuth vol 1, sec 2.5, pg 449) */
343 if (prev != slob_list->prev &&
344 slob_list->next != prev->next)
345 list_move_tail(slob_list, prev->next);
348 spin_unlock_irqrestore(&slob_lock, flags);
350 /* Not enough space: must allocate a new page */
352 b = slob_new_page(gfp & ~__GFP_ZERO, 0, node);
355 sp = (struct slob_page *)virt_to_page(b);
358 spin_lock_irqsave(&slob_lock, flags);
359 sp->units = SLOB_UNITS(PAGE_SIZE);
361 INIT_LIST_HEAD(&sp->list);
362 set_slob(b, SLOB_UNITS(PAGE_SIZE), b + SLOB_UNITS(PAGE_SIZE));
363 set_slob_page_free(sp, slob_list);
364 b = slob_page_alloc(sp, size, align);
366 spin_unlock_irqrestore(&slob_lock, flags);
368 if (unlikely((gfp & __GFP_ZERO) && b))
374 * slob_free: entry point into the slob allocator.
376 static void slob_free(void *block, int size)
378 struct slob_page *sp;
379 slob_t *prev, *next, *b = (slob_t *)block;
383 if (unlikely(ZERO_OR_NULL_PTR(block)))
387 sp = (struct slob_page *)virt_to_page(block);
388 units = SLOB_UNITS(size);
390 spin_lock_irqsave(&slob_lock, flags);
392 if (sp->units + units == SLOB_UNITS(PAGE_SIZE)) {
393 /* Go directly to page allocator. Do not pass slob allocator */
394 if (slob_page_free(sp))
395 clear_slob_page_free(sp);
398 free_page((unsigned long)b);
402 if (!slob_page_free(sp)) {
403 /* This slob page is about to become partially free. Easy! */
407 (void *)((unsigned long)(b +
408 SLOB_UNITS(PAGE_SIZE)) & PAGE_MASK));
409 set_slob_page_free(sp, &free_slob_small);
414 * Otherwise the page is already partially free, so find reinsertion
420 if (b + units == sp->free) {
421 units += slob_units(sp->free);
422 sp->free = slob_next(sp->free);
424 set_slob(b, units, sp->free);
428 next = slob_next(prev);
431 next = slob_next(prev);
434 if (!slob_last(prev) && b + units == next) {
435 units += slob_units(next);
436 set_slob(b, units, slob_next(next));
438 set_slob(b, units, next);
440 if (prev + slob_units(prev) == b) {
441 units = slob_units(b) + slob_units(prev);
442 set_slob(prev, units, slob_next(b));
444 set_slob(prev, slob_units(prev), b);
447 spin_unlock_irqrestore(&slob_lock, flags);
451 * End of slob allocator proper. Begin kmem_cache_alloc and kmalloc frontend.
454 #ifndef ARCH_KMALLOC_MINALIGN
455 #define ARCH_KMALLOC_MINALIGN __alignof__(unsigned long)
458 #ifndef ARCH_SLAB_MINALIGN
459 #define ARCH_SLAB_MINALIGN __alignof__(unsigned long)
462 void *__kmalloc_node(size_t size, gfp_t gfp, int node)
465 int align = max(ARCH_KMALLOC_MINALIGN, ARCH_SLAB_MINALIGN);
467 if (size < PAGE_SIZE - align) {
469 return ZERO_SIZE_PTR;
471 m = slob_alloc(size + align, gfp, align, node);
474 return (void *)m + align;
478 ret = slob_new_page(gfp | __GFP_COMP, get_order(size), node);
481 page = virt_to_page(ret);
482 page->private = size;
487 EXPORT_SYMBOL(__kmalloc_node);
489 void kfree(const void *block)
491 struct slob_page *sp;
493 if (unlikely(ZERO_OR_NULL_PTR(block)))
496 sp = (struct slob_page *)virt_to_page(block);
498 int align = max(ARCH_KMALLOC_MINALIGN, ARCH_SLAB_MINALIGN);
499 unsigned int *m = (unsigned int *)(block - align);
500 slob_free(m, *m + align);
504 EXPORT_SYMBOL(kfree);
506 /* can't use ksize for kmem_cache_alloc memory, only kmalloc */
507 size_t ksize(const void *block)
509 struct slob_page *sp;
512 if (unlikely(block == ZERO_SIZE_PTR))
515 sp = (struct slob_page *)virt_to_page(block);
517 return ((slob_t *)block - 1)->units + SLOB_UNIT;
519 return sp->page.private;
521 EXPORT_SYMBOL(ksize);
524 unsigned int size, align;
527 void (*ctor)(struct kmem_cache *, void *);
530 struct kmem_cache *kmem_cache_create(const char *name, size_t size,
531 size_t align, unsigned long flags,
532 void (*ctor)(struct kmem_cache *, void *))
534 struct kmem_cache *c;
536 c = slob_alloc(sizeof(struct kmem_cache),
537 flags, ARCH_KMALLOC_MINALIGN, -1);
542 if (flags & SLAB_DESTROY_BY_RCU) {
543 /* leave room for rcu footer at the end of object */
544 c->size += sizeof(struct slob_rcu);
548 /* ignore alignment unless it's forced */
549 c->align = (flags & SLAB_HWCACHE_ALIGN) ? SLOB_ALIGN : 0;
550 if (c->align < ARCH_SLAB_MINALIGN)
551 c->align = ARCH_SLAB_MINALIGN;
552 if (c->align < align)
554 } else if (flags & SLAB_PANIC)
555 panic("Cannot create slab cache %s\n", name);
559 EXPORT_SYMBOL(kmem_cache_create);
561 void kmem_cache_destroy(struct kmem_cache *c)
563 slob_free(c, sizeof(struct kmem_cache));
565 EXPORT_SYMBOL(kmem_cache_destroy);
567 void *kmem_cache_alloc_node(struct kmem_cache *c, gfp_t flags, int node)
571 if (c->size < PAGE_SIZE)
572 b = slob_alloc(c->size, flags, c->align, node);
574 b = slob_new_page(flags, get_order(c->size), node);
581 EXPORT_SYMBOL(kmem_cache_alloc_node);
583 static void __kmem_cache_free(void *b, int size)
585 if (size < PAGE_SIZE)
588 free_pages((unsigned long)b, get_order(size));
591 static void kmem_rcu_free(struct rcu_head *head)
593 struct slob_rcu *slob_rcu = (struct slob_rcu *)head;
594 void *b = (void *)slob_rcu - (slob_rcu->size - sizeof(struct slob_rcu));
596 __kmem_cache_free(b, slob_rcu->size);
599 void kmem_cache_free(struct kmem_cache *c, void *b)
601 if (unlikely(c->flags & SLAB_DESTROY_BY_RCU)) {
602 struct slob_rcu *slob_rcu;
603 slob_rcu = b + (c->size - sizeof(struct slob_rcu));
604 INIT_RCU_HEAD(&slob_rcu->head);
605 slob_rcu->size = c->size;
606 call_rcu(&slob_rcu->head, kmem_rcu_free);
608 __kmem_cache_free(b, c->size);
611 EXPORT_SYMBOL(kmem_cache_free);
613 unsigned int kmem_cache_size(struct kmem_cache *c)
617 EXPORT_SYMBOL(kmem_cache_size);
619 const char *kmem_cache_name(struct kmem_cache *c)
623 EXPORT_SYMBOL(kmem_cache_name);
625 int kmem_cache_shrink(struct kmem_cache *d)
629 EXPORT_SYMBOL(kmem_cache_shrink);
631 int kmem_ptr_validate(struct kmem_cache *a, const void *b)
636 static unsigned int slob_ready __read_mostly;
638 int slab_is_available(void)
643 void __init kmem_cache_init(void)