slab: Support 'no-touch' caches
[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 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         kc->name = name;
45         kc->obj_size = obj_size;
46         kc->align = align;
47         kc->flags = flags;
48         kc->source = source;
49         TAILQ_INIT(&kc->full_slab_list);
50         TAILQ_INIT(&kc->partial_slab_list);
51         TAILQ_INIT(&kc->empty_slab_list);
52         kc->ctor = ctor;
53         kc->dtor = dtor;
54         kc->nr_cur_alloc = 0;
55         kc->alloc_hash = kc->static_hash;
56         hash_init_hh(&kc->hh);
57         for (int i = 0; i < kc->hh.nr_hash_lists; i++)
58                 BSD_LIST_INIT(&kc->static_hash[i]);
59         /* No touch must use bufctls, even for small objects, so that it does not
60          * use the object as memory.  Note that if we have an arbitrary source,
61          * small objects, and we're 'pro-touch', the small allocation path will
62          * assume we're importing from a PGSIZE-aligned source arena. */
63         if ((obj_size > SLAB_LARGE_CUTOFF) || (flags & KMC_NOTOUCH))
64                 kc->flags |= __KMC_USE_BUFCTL;
65         /* put in cache list based on it's size */
66         struct kmem_cache *i, *prev = NULL;
67         spin_lock_irqsave(&kmem_caches_lock);
68         /* find the kmem_cache before us in the list.  yes, this is O(n). */
69         SLIST_FOREACH(i, &kmem_caches, link) {
70                 if (i->obj_size < kc->obj_size)
71                         prev = i;
72                 else
73                         break;
74         }
75         if (prev)
76                 SLIST_INSERT_AFTER(prev, kc, link);
77         else
78                 SLIST_INSERT_HEAD(&kmem_caches, kc, link);
79         spin_unlock_irqsave(&kmem_caches_lock);
80 }
81
82 void kmem_cache_init(void)
83 {
84         spinlock_init_irqsave(&kmem_caches_lock);
85         SLIST_INIT(&kmem_caches);
86         __kmem_cache_create(kmem_cache_cache, "kmem_cache",
87                             sizeof(struct kmem_cache),
88                             __alignof__(struct kmem_cache), 0, base_arena,
89                             NULL, NULL);
90         __kmem_cache_create(kmem_slab_cache, "kmem_slab",
91                             sizeof(struct kmem_slab),
92                             __alignof__(struct kmem_slab), 0, base_arena,
93                             NULL, NULL);
94         __kmem_cache_create(kmem_bufctl_cache, "kmem_bufctl",
95                             sizeof(struct kmem_bufctl),
96                             __alignof__(struct kmem_bufctl), 0, base_arena,
97                             NULL, NULL);
98 }
99
100 /* Cache management */
101 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
102                                      int align, int flags,
103                                      struct arena *source,
104                                      void (*ctor)(void *, size_t),
105                                      void (*dtor)(void *, size_t))
106 {
107         struct kmem_cache *kc = kmem_cache_alloc(kmem_cache_cache, 0);
108         __kmem_cache_create(kc, name, obj_size, align, flags, source, ctor, dtor);
109         return kc;
110 }
111
112 static void kmem_slab_destroy(struct kmem_cache *cp, struct kmem_slab *a_slab)
113 {
114         if (!__use_bufctls(cp)) {
115                 /* Deconstruct all the objects, if necessary */
116                 if (cp->dtor) {
117                         void *buf = a_slab->free_small_obj;
118                         for (int i = 0; i < a_slab->num_total_obj; i++) {
119                                 cp->dtor(buf, cp->obj_size);
120                                 buf += a_slab->obj_size;
121                         }
122                 }
123                 page_decref(kva2page((void*)ROUNDDOWN((uintptr_t)a_slab, PGSIZE)));
124         } else {
125                 struct kmem_bufctl *i, *temp;
126                 void *page_start = (void*)-1;
127                 /* Figure out how much memory we asked for earlier.  We needed at least
128                  * min_pgs.  We asked for the next highest order (power of 2) number of
129                  * pages */
130                 size_t min_pgs = ROUNDUP(NUM_BUF_PER_SLAB * a_slab->obj_size, PGSIZE) /
131                                          PGSIZE;
132                 size_t order_pg_alloc = LOG2_UP(min_pgs);
133                 BSD_LIST_FOREACH_SAFE(i, &a_slab->bufctl_freelist, link, temp) {
134                         // Track the lowest buffer address, which is the start of the buffer
135                         page_start = MIN(page_start, i->buf_addr);
136                         /* Deconstruct all the objects, if necessary */
137                         if (cp->dtor)
138                                 cp->dtor(i->buf_addr, cp->obj_size);
139                         /* This is a little dangerous, but we can skip removing, since we
140                          * init the freelist when we reuse the slab. */
141                         kmem_cache_free(kmem_bufctl_cache, i);
142                 }
143                 // free the pages for the slab's buffer
144                 free_cont_pages(page_start, order_pg_alloc);
145                 // free the slab object
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                 // Just get a single page for small slabs
338                 page_t *a_page;
339
340                 if (kpage_alloc(&a_page))
341                         return FALSE;
342                 // the slab struct is stored at the end of the page
343                 a_slab = (struct kmem_slab*)(page2kva(a_page) + PGSIZE -
344                                              sizeof(struct kmem_slab));
345                 // Need to add room for the next free item pointer in the object buffer.
346                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
347                 a_slab->num_busy_obj = 0;
348                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
349                                         a_slab->obj_size;
350                 // TODO: consider staggering this IAW section 4.3
351                 a_slab->free_small_obj = page2kva(a_page);
352                 /* Walk and create the free list, which is circular.  Each item stores
353                  * the location of the next one at the end of the block. */
354                 void *buf = a_slab->free_small_obj;
355                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
356                         // Initialize the object, if necessary
357                         if (cp->ctor)
358                                 cp->ctor(buf, cp->obj_size);
359                         *(uintptr_t**)(buf + cp->obj_size) = buf + a_slab->obj_size;
360                         buf += a_slab->obj_size;
361                 }
362                 *((uintptr_t**)(buf + cp->obj_size)) = NULL;
363         } else {
364                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
365                 if (!a_slab)
366                         return FALSE;
367                 a_slab->obj_size = ROUNDUP(cp->obj_size, cp->align);
368                 /* Figure out how much memory we want.  We need at least min_pgs.  We'll
369                  * ask for the next highest order (power of 2) number of pages */
370                 size_t min_pgs = ROUNDUP(NUM_BUF_PER_SLAB * a_slab->obj_size, PGSIZE) /
371                                          PGSIZE;
372                 size_t order_pg_alloc = LOG2_UP(min_pgs);
373                 void *buf = get_cont_pages(order_pg_alloc, 0);
374
375                 if (!buf) {
376                         kmem_cache_free(kmem_slab_cache, a_slab);
377                         return FALSE;
378                 }
379                 a_slab->num_busy_obj = 0;
380                 /* The number of objects is based on the rounded up amt requested. */
381                 a_slab->num_total_obj = ((1 << order_pg_alloc) * PGSIZE) /
382                                         a_slab->obj_size;
383                 BSD_LIST_INIT(&a_slab->bufctl_freelist);
384                 /* for each buffer, set up a bufctl and point to the buffer */
385                 for (int i = 0; i < a_slab->num_total_obj; i++) {
386                         // Initialize the object, if necessary
387                         if (cp->ctor)
388                                 cp->ctor(buf, cp->obj_size);
389                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);
390                         BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
391                         a_bufctl->buf_addr = buf;
392                         a_bufctl->my_slab = a_slab;
393                         buf += a_slab->obj_size;
394                 }
395         }
396         // add a_slab to the empty_list
397         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
398
399         return TRUE;
400 }
401
402 /* This deallocs every slab from the empty list.  TODO: think a bit more about
403  * this.  We can do things like not free all of the empty lists to prevent
404  * thrashing.  See 3.4 in the paper. */
405 void kmem_cache_reap(struct kmem_cache *cp)
406 {
407         struct kmem_slab *a_slab, *next;
408
409         // Destroy all empty slabs.  Refer to the notes about the while loop
410         spin_lock_irqsave(&cp->cache_lock);
411         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
412         while (a_slab) {
413                 next = TAILQ_NEXT(a_slab, link);
414                 kmem_slab_destroy(cp, a_slab);
415                 a_slab = next;
416         }
417         spin_unlock_irqsave(&cp->cache_lock);
418 }
419
420 void print_kmem_cache(struct kmem_cache *cp)
421 {
422         spin_lock_irqsave(&cp->cache_lock);
423         printk("\nPrinting kmem_cache:\n---------------------\n");
424         printk("Name: %s\n", cp->name);
425         printk("Objsize: %d\n", cp->obj_size);
426         printk("Align: %d\n", cp->align);
427         printk("Flags: 0x%08x\n", cp->flags);
428         printk("Constructor: %p\n", cp->ctor);
429         printk("Destructor: %p\n", cp->dtor);
430         printk("Slab Full: %p\n", cp->full_slab_list);
431         printk("Slab Partial: %p\n", cp->partial_slab_list);
432         printk("Slab Empty: %p\n", cp->empty_slab_list);
433         printk("Current Allocations: %d\n", cp->nr_cur_alloc);
434         spin_unlock_irqsave(&cp->cache_lock);
435 }
436
437 void print_kmem_slab(struct kmem_slab *slab)
438 {
439         printk("\nPrinting kmem_slab:\n---------------------\n");
440         printk("Objsize: %d (%p)\n", slab->obj_size, slab->obj_size);
441         printk("NumBusy: %d\n", slab->num_busy_obj);
442         printk("Num_total: %d\n", slab->num_total_obj);
443         /* This will break if we have a NOTOUCH small slab.  It's debugging code, so
444          * just be careful. */
445         if (slab->obj_size + sizeof(uintptr_t) < SLAB_LARGE_CUTOFF) {
446                 printk("Free Small obj: %p\n", slab->free_small_obj);
447                 void *buf = slab->free_small_obj;
448                 for (int i = 0; i < slab->num_total_obj; i++) {
449                         printk("Addr of buf: %p, Addr of next: %p\n", buf,
450                                *((uintptr_t**)buf));
451                         buf += slab->obj_size;
452                 }
453         } else {
454                 printk("This is a big slab!\n");
455         }
456 }
457