slab: Move ctors/dtors to the slab layer
[akaros.git] / kern / src / slab.c
1 /* Copyright (c) 2009 The Regents of the University of California
2  * Copyright (c) 2016 Google Inc
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * Kevin Klues <klueska@cs.berkeley.edu>
5  * See LICENSE for details.
6  *
7  * Slab allocator, based on the SunOS 5.4 allocator paper.
8  */
9
10 #include <slab.h>
11 #include <stdio.h>
12 #include <assert.h>
13 #include <pmap.h>
14 #include <kmalloc.h>
15 #include <hash.h>
16 #include <arena.h>
17
18 struct kmem_cache_list kmem_caches = SLIST_HEAD_INITIALIZER(kmem_caches);
19 spinlock_t kmem_caches_lock = SPINLOCK_INITIALIZER_IRQSAVE;
20
21 /* Backend/internal functions, defined later.  Grab the lock before calling
22  * these. */
23 static bool kmem_cache_grow(struct kmem_cache *cp);
24 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags);
25 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf);
26
27 /* Cache of the kmem_cache objects, needed for bootstrapping */
28 struct kmem_cache kmem_cache_cache[1];
29 struct kmem_cache kmem_slab_cache[1];
30 struct kmem_cache kmem_bufctl_cache[1];
31
32 static bool __use_bufctls(struct kmem_cache *cp)
33 {
34         return cp->flags & __KMC_USE_BUFCTL;
35 }
36
37 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
38                          size_t obj_size, int align, int flags,
39                          struct arena *source,
40                          void (*ctor)(void *, size_t),
41                          void (*dtor)(void *, size_t))
42 {
43         assert(kc);
44         assert(align);
45         spinlock_init_irqsave(&kc->cache_lock);
46         strlcpy(kc->name, name, KMC_NAME_SZ);
47         kc->obj_size = obj_size;
48         if (flags & KMC_QCACHE)
49                 kc->import_amt = ROUNDUPPWR2(3 * source->qcache_max);
50         else
51                 kc->import_amt = ROUNDUP(NUM_BUF_PER_SLAB * ROUNDUP(obj_size, align),
52                                          PGSIZE);
53         kc->align = align;
54         if (align > PGSIZE)
55                 panic("Cache %s object alignment is actually MIN(PGSIZE, align (%p))",
56                       name, align);
57         kc->flags = flags;
58         /* We might want some sort of per-call site NUMA-awareness in the future. */
59         kc->source = source ? source : kpages_arena;
60         TAILQ_INIT(&kc->full_slab_list);
61         TAILQ_INIT(&kc->partial_slab_list);
62         TAILQ_INIT(&kc->empty_slab_list);
63         kc->ctor = ctor;
64         kc->dtor = dtor;
65         kc->nr_cur_alloc = 0;
66         kc->alloc_hash = kc->static_hash;
67         hash_init_hh(&kc->hh);
68         for (int i = 0; i < kc->hh.nr_hash_lists; i++)
69                 BSD_LIST_INIT(&kc->static_hash[i]);
70         /* No touch must use bufctls, even for small objects, so that it does not
71          * use the object as memory.  Note that if we have an arbitrary source,
72          * small objects, and we're 'pro-touch', the small allocation path will
73          * assume we're importing from a PGSIZE-aligned source arena. */
74         if ((obj_size > SLAB_LARGE_CUTOFF) || (flags & KMC_NOTOUCH))
75                 kc->flags |= __KMC_USE_BUFCTL;
76         /* put in cache list based on it's size */
77         struct kmem_cache *i, *prev = NULL;
78         spin_lock_irqsave(&kmem_caches_lock);
79         /* find the kmem_cache before us in the list.  yes, this is O(n). */
80         SLIST_FOREACH(i, &kmem_caches, link) {
81                 if (i->obj_size < kc->obj_size)
82                         prev = i;
83                 else
84                         break;
85         }
86         if (prev)
87                 SLIST_INSERT_AFTER(prev, kc, link);
88         else
89                 SLIST_INSERT_HEAD(&kmem_caches, kc, link);
90         spin_unlock_irqsave(&kmem_caches_lock);
91 }
92
93 void kmem_cache_init(void)
94 {
95         __kmem_cache_create(kmem_cache_cache, "kmem_cache",
96                             sizeof(struct kmem_cache),
97                             __alignof__(struct kmem_cache), 0, base_arena,
98                             NULL, NULL);
99         __kmem_cache_create(kmem_slab_cache, "kmem_slab",
100                             sizeof(struct kmem_slab),
101                             __alignof__(struct kmem_slab), 0, base_arena,
102                             NULL, NULL);
103         __kmem_cache_create(kmem_bufctl_cache, "kmem_bufctl",
104                             sizeof(struct kmem_bufctl),
105                             __alignof__(struct kmem_bufctl), 0, base_arena,
106                             NULL, NULL);
107 }
108
109 /* Cache management */
110 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
111                                      int align, int flags,
112                                      struct arena *source,
113                                      void (*ctor)(void *, size_t),
114                                      void (*dtor)(void *, size_t))
115 {
116         struct kmem_cache *kc = kmem_cache_alloc(kmem_cache_cache, 0);
117         __kmem_cache_create(kc, name, obj_size, align, flags, source, ctor, dtor);
118         return kc;
119 }
120
121 static void kmem_slab_destroy(struct kmem_cache *cp, struct kmem_slab *a_slab)
122 {
123         if (!__use_bufctls(cp)) {
124                 arena_free(cp->source, ROUNDDOWN(a_slab, PGSIZE), PGSIZE);
125         } else {
126                 struct kmem_bufctl *i, *temp;
127                 void *buf_start = (void*)SIZE_MAX;
128
129                 BSD_LIST_FOREACH_SAFE(i, &a_slab->bufctl_freelist, link, temp) {
130                         // Track the lowest buffer address, which is the start of the buffer
131                         buf_start = MIN(buf_start, i->buf_addr);
132                         /* This is a little dangerous, but we can skip removing, since we
133                          * init the freelist when we reuse the slab. */
134                         kmem_cache_free(kmem_bufctl_cache, i);
135                 }
136                 arena_free(cp->source, buf_start, cp->import_amt);
137                 kmem_cache_free(kmem_slab_cache, a_slab);
138         }
139 }
140
141 /* Once you call destroy, never use this cache again... o/w there may be weird
142  * races, and other serious issues.  */
143 void kmem_cache_destroy(struct kmem_cache *cp)
144 {
145         struct kmem_slab *a_slab, *next;
146
147         spin_lock_irqsave(&cp->cache_lock);
148         assert(TAILQ_EMPTY(&cp->full_slab_list));
149         assert(TAILQ_EMPTY(&cp->partial_slab_list));
150         /* Clean out the empty list.  We can't use a regular FOREACH here, since the
151          * link element is stored in the slab struct, which is stored on the page
152          * that we are freeing. */
153         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
154         while (a_slab) {
155                 next = TAILQ_NEXT(a_slab, link);
156                 kmem_slab_destroy(cp, a_slab);
157                 a_slab = next;
158         }
159         spin_lock_irqsave(&kmem_caches_lock);
160         SLIST_REMOVE(&kmem_caches, cp, kmem_cache, link);
161         spin_unlock_irqsave(&kmem_caches_lock);
162         kmem_cache_free(kmem_cache_cache, cp);
163         spin_unlock_irqsave(&cp->cache_lock);
164 }
165
166 static void __try_hash_resize(struct kmem_cache *cp)
167 {
168         struct kmem_bufctl_list *new_tbl, *old_tbl;
169         struct kmem_bufctl *bc_i;
170         unsigned int new_tbl_nr_lists, old_tbl_nr_lists;
171         size_t new_tbl_sz, old_tbl_sz;
172         size_t hash_idx;
173
174         if (!hash_needs_more(&cp->hh))
175                 return;
176         new_tbl_nr_lists = hash_next_nr_lists(&cp->hh);
177         new_tbl_sz = new_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
178         /* TODO: we only need to pull from base if our arena is a base or we are
179          * inside a kpages arena (keep in mind there could be more than one of
180          * those, depending on how we do NUMA allocs).  This might help with
181          * fragmentation.  To know this, we'll need the caller to pass us a flag. */
182         new_tbl = base_zalloc(NULL, new_tbl_sz, ARENA_INSTANTFIT | MEM_ATOMIC);
183         if (!new_tbl)
184                 return;
185         old_tbl = cp->alloc_hash;
186         old_tbl_nr_lists = cp->hh.nr_hash_lists;
187         old_tbl_sz = old_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
188         cp->alloc_hash = new_tbl;
189         hash_incr_nr_lists(&cp->hh);
190         for (int i = 0; i < old_tbl_nr_lists; i++) {
191                 while ((bc_i = BSD_LIST_FIRST(&old_tbl[i]))) {
192                         BSD_LIST_REMOVE(bc_i, link);
193                         hash_idx = hash_ptr(bc_i->buf_addr, cp->hh.nr_hash_bits);
194                         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc_i, link);
195                 }
196         }
197         hash_reset_load_limit(&cp->hh);
198         if (old_tbl != cp->static_hash)
199                 base_free(NULL, old_tbl, old_tbl_sz);
200 }
201
202 /* Helper, tracks the allocation of @bc in the hash table */
203 static void __track_alloc(struct kmem_cache *cp, struct kmem_bufctl *bc)
204 {
205         size_t hash_idx;
206
207         hash_idx = hash_ptr(bc->buf_addr, cp->hh.nr_hash_bits);
208         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc, link);
209         cp->hh.nr_items++;
210         __try_hash_resize(cp);
211 }
212
213 /* Helper, looks up and removes the bufctl corresponding to buf. */
214 static struct kmem_bufctl *__yank_bufctl(struct kmem_cache *cp, void *buf)
215 {
216         struct kmem_bufctl *bc_i;
217         size_t hash_idx;
218
219         hash_idx = hash_ptr(buf, cp->hh.nr_hash_bits);
220         BSD_LIST_FOREACH(bc_i, &cp->alloc_hash[hash_idx], link) {
221                 if (bc_i->buf_addr == buf) {
222                         BSD_LIST_REMOVE(bc_i, link);
223                         break;
224                 }
225         }
226         if (!bc_i)
227                 panic("Could not find buf %p in cache %s!", buf, cp->name);
228         return bc_i;
229 }
230
231 /* Alloc, bypassing the magazines and depot */
232 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags)
233 {
234         void *retval = NULL;
235         spin_lock_irqsave(&cp->cache_lock);
236         // look at partial list
237         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
238         //      if none, go to empty list and get an empty and make it partial
239         if (!a_slab) {
240                 // TODO: think about non-sleeping flags
241                 if (TAILQ_EMPTY(&cp->empty_slab_list) &&
242                         !kmem_cache_grow(cp)) {
243                         spin_unlock_irqsave(&cp->cache_lock);
244                         if (flags & MEM_ERROR)
245                                 error(ENOMEM, ERROR_FIXME);
246                         else
247                                 panic("[German Accent]: OOM for a small slab growth!!!");
248                 }
249                 // move to partial list
250                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
251                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
252                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
253         }
254         // have a partial now (a_slab), get an item, return item
255         if (!__use_bufctls(cp)) {
256                 retval = a_slab->free_small_obj;
257                 /* adding the size of the cache_obj to get to the pointer at end of the
258                  * buffer pointing to the next free_small_obj */
259                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj +
260                                                         cp->obj_size);
261         } else {
262                 // rip the first bufctl out of the partial slab's buf list
263                 struct kmem_bufctl *a_bufctl = BSD_LIST_FIRST(&a_slab->bufctl_freelist);
264
265                 BSD_LIST_REMOVE(a_bufctl, link);
266                 __track_alloc(cp, a_bufctl);
267                 retval = a_bufctl->buf_addr;
268         }
269         a_slab->num_busy_obj++;
270         // Check if we are full, if so, move to the full list
271         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
272                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
273                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
274         }
275         cp->nr_cur_alloc++;
276         spin_unlock_irqsave(&cp->cache_lock);
277         if (cp->ctor)
278                 cp->ctor(retval, cp->obj_size);
279         return retval;
280 }
281
282 void *kmem_cache_alloc(struct kmem_cache *cp, int flags)
283 {
284         return __kmem_alloc_from_slab(cp, flags);
285 }
286
287 /* Returns an object to the slab layer.  Note that objects in the slabs are
288  * unconstructed. */
289 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf)
290 {
291         struct kmem_slab *a_slab;
292         struct kmem_bufctl *a_bufctl;
293
294         if (cp->dtor)
295                 cp->dtor(buf, cp->obj_size);
296         spin_lock_irqsave(&cp->cache_lock);
297         if (!__use_bufctls(cp)) {
298                 // find its slab
299                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
300                                              PGSIZE - sizeof(struct kmem_slab));
301                 /* write location of next free small obj to the space at the end of the
302                  * buffer, then list buf as the next free small obj */
303                 *(uintptr_t**)(buf + cp->obj_size) = a_slab->free_small_obj;
304                 a_slab->free_small_obj = buf;
305         } else {
306                 /* Give the bufctl back to the parent slab */
307                 a_bufctl = __yank_bufctl(cp, buf);
308                 a_slab = a_bufctl->my_slab;
309                 BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
310         }
311         a_slab->num_busy_obj--;
312         cp->nr_cur_alloc--;
313         // if it was full, move it to partial
314         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
315                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
316                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
317         } else if (!a_slab->num_busy_obj) {
318                 // if there are none, move to from partial to empty
319                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
320                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
321         }
322         spin_unlock_irqsave(&cp->cache_lock);
323 }
324
325 void kmem_cache_free(struct kmem_cache *cp, void *buf)
326 {
327         __kmem_free_to_slab(cp, buf);
328 }
329
330 /* Back end: internal functions */
331 /* When this returns, the cache has at least one slab in the empty list.  If
332  * page_alloc fails, there are some serious issues.  This only grows by one slab
333  * at a time.
334  *
335  * Grab the cache lock before calling this.
336  *
337  * TODO: think about page colouring issues with kernel memory allocation. */
338 static bool kmem_cache_grow(struct kmem_cache *cp)
339 {
340         struct kmem_slab *a_slab;
341         struct kmem_bufctl *a_bufctl;
342
343         if (!__use_bufctls(cp)) {
344                 void *a_page;
345
346                 /* Careful, this assumes our source is a PGSIZE-aligned allocator.  We
347                  * could use xalloc to enforce the alignment, but that'll bypass the
348                  * qcaches, which we don't want.  Caller beware. */
349                 a_page = arena_alloc(cp->source, PGSIZE, MEM_ATOMIC);
350                 if (!a_page)
351                         return FALSE;
352                 // the slab struct is stored at the end of the page
353                 a_slab = (struct kmem_slab*)(a_page + PGSIZE
354                                              - sizeof(struct kmem_slab));
355                 // Need to add room for the next free item pointer in the object buffer.
356                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
357                 a_slab->num_busy_obj = 0;
358                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
359                                         a_slab->obj_size;
360                 // TODO: consider staggering this IAW section 4.3
361                 a_slab->free_small_obj = a_page;
362                 /* Walk and create the free list, which is circular.  Each item stores
363                  * the location of the next one at the end of the block. */
364                 void *buf = a_slab->free_small_obj;
365                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
366                         *(uintptr_t**)(buf + cp->obj_size) = buf + a_slab->obj_size;
367                         buf += a_slab->obj_size;
368                 }
369                 *((uintptr_t**)(buf + cp->obj_size)) = NULL;
370         } else {
371                 void *buf;
372
373                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
374                 if (!a_slab)
375                         return FALSE;
376                 a_slab->obj_size = ROUNDUP(cp->obj_size, cp->align);
377                 buf = arena_alloc(cp->source, cp->import_amt, MEM_ATOMIC);
378                 if (!buf) {
379                         kmem_cache_free(kmem_slab_cache, a_slab);
380                         return FALSE;
381                 }
382                 a_slab->num_busy_obj = 0;
383                 a_slab->num_total_obj = cp->import_amt / a_slab->obj_size;
384                 BSD_LIST_INIT(&a_slab->bufctl_freelist);
385                 /* for each buffer, set up a bufctl and point to the buffer */
386                 for (int i = 0; i < a_slab->num_total_obj; i++) {
387                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);
388                         BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
389                         a_bufctl->buf_addr = buf;
390                         a_bufctl->my_slab = a_slab;
391                         buf += a_slab->obj_size;
392                 }
393         }
394         // add a_slab to the empty_list
395         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
396
397         return TRUE;
398 }
399
400 /* This deallocs every slab from the empty list.  TODO: think a bit more about
401  * this.  We can do things like not free all of the empty lists to prevent
402  * thrashing.  See 3.4 in the paper. */
403 void kmem_cache_reap(struct kmem_cache *cp)
404 {
405         struct kmem_slab *a_slab, *next;
406
407         // Destroy all empty slabs.  Refer to the notes about the while loop
408         spin_lock_irqsave(&cp->cache_lock);
409         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
410         while (a_slab) {
411                 next = TAILQ_NEXT(a_slab, link);
412                 kmem_slab_destroy(cp, a_slab);
413                 a_slab = next;
414         }
415         spin_unlock_irqsave(&cp->cache_lock);
416 }
417
418 void print_kmem_cache(struct kmem_cache *cp)
419 {
420         spin_lock_irqsave(&cp->cache_lock);
421         printk("\nPrinting kmem_cache:\n---------------------\n");
422         printk("Name: %s\n", cp->name);
423         printk("Objsize: %d\n", cp->obj_size);
424         printk("Align: %d\n", cp->align);
425         printk("Flags: 0x%08x\n", cp->flags);
426         printk("Constructor: %p\n", cp->ctor);
427         printk("Destructor: %p\n", cp->dtor);
428         printk("Slab Full: %p\n", cp->full_slab_list);
429         printk("Slab Partial: %p\n", cp->partial_slab_list);
430         printk("Slab Empty: %p\n", cp->empty_slab_list);
431         printk("Current Allocations: %d\n", cp->nr_cur_alloc);
432         spin_unlock_irqsave(&cp->cache_lock);
433 }
434
435 void print_kmem_slab(struct kmem_slab *slab)
436 {
437         printk("\nPrinting kmem_slab:\n---------------------\n");
438         printk("Objsize: %d (%p)\n", slab->obj_size, slab->obj_size);
439         printk("NumBusy: %d\n", slab->num_busy_obj);
440         printk("Num_total: %d\n", slab->num_total_obj);
441         /* This will break if we have a NOTOUCH small slab.  It's debugging code, so
442          * just be careful. */
443         if (slab->obj_size + sizeof(uintptr_t) < SLAB_LARGE_CUTOFF) {
444                 printk("Free Small obj: %p\n", slab->free_small_obj);
445                 void *buf = slab->free_small_obj;
446                 for (int i = 0; i < slab->num_total_obj; i++) {
447                         printk("Addr of buf: %p, Addr of next: %p\n", buf,
448                                *((uintptr_t**)buf));
449                         buf += slab->obj_size;
450                 }
451         } else {
452                 printk("This is a big slab!\n");
453         }
454 }
455