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