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