slab: Use BSD_LISTs for the bufctls
[akaros.git] / kern / src / slab.c
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
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  * Note that we don't have a hash table for buf to bufctl for the large buffer
10  * objects, so we use the same style for small objects: store the pointer to the
11  * controlling bufctl at the top of the slab object.  Fix this with TODO (BUF).
12  */
13
14 #include <slab.h>
15 #include <stdio.h>
16 #include <assert.h>
17 #include <pmap.h>
18 #include <kmalloc.h>
19
20 struct kmem_cache_list kmem_caches;
21 spinlock_t kmem_caches_lock;
22
23 /* Backend/internal functions, defined later.  Grab the lock before calling
24  * these. */
25 static bool kmem_cache_grow(struct kmem_cache *cp);
26
27 /* Cache of the kmem_cache objects, needed for bootstrapping */
28 struct kmem_cache kmem_cache_cache;
29 struct kmem_cache *kmem_slab_cache, *kmem_bufctl_cache;
30
31 static void __kmem_cache_create(struct kmem_cache *kc, const char *name,
32                                 size_t obj_size, int align, int flags,
33                                 void (*ctor)(void *, size_t),
34                                 void (*dtor)(void *, size_t))
35 {
36         assert(kc);
37         assert(align);
38         spinlock_init_irqsave(&kc->cache_lock);
39         kc->name = name;
40         kc->obj_size = obj_size;
41         kc->align = align;
42         kc->flags = flags;
43         TAILQ_INIT(&kc->full_slab_list);
44         TAILQ_INIT(&kc->partial_slab_list);
45         TAILQ_INIT(&kc->empty_slab_list);
46         kc->ctor = ctor;
47         kc->dtor = dtor;
48         kc->nr_cur_alloc = 0;
49
50         /* put in cache list based on it's size */
51         struct kmem_cache *i, *prev = NULL;
52         spin_lock_irqsave(&kmem_caches_lock);
53         /* find the kmem_cache before us in the list.  yes, this is O(n). */
54         SLIST_FOREACH(i, &kmem_caches, link) {
55                 if (i->obj_size < kc->obj_size)
56                         prev = i;
57                 else
58                         break;
59         }
60         if (prev)
61                 SLIST_INSERT_AFTER(prev, kc, link);
62         else
63                 SLIST_INSERT_HEAD(&kmem_caches, kc, link);
64         spin_unlock_irqsave(&kmem_caches_lock);
65 }
66
67 void kmem_cache_init(void)
68 {
69         spinlock_init_irqsave(&kmem_caches_lock);
70         SLIST_INIT(&kmem_caches);
71         /* We need to call the __ version directly to bootstrap the global
72          * kmem_cache_cache. */
73         __kmem_cache_create(&kmem_cache_cache, "kmem_cache",
74                             sizeof(struct kmem_cache),
75                             __alignof__(struct kmem_cache), 0, NULL, NULL);
76         /* Build the slab and bufctl caches */
77         kmem_slab_cache = kmem_cache_create("kmem_slab", sizeof(struct kmem_slab),
78                                __alignof__(struct kmem_slab), 0, NULL, NULL);
79         kmem_bufctl_cache = kmem_cache_create("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) // TODO: (BUF)
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 /* Front end: clients of caches use these */
159 void *kmem_cache_alloc(struct kmem_cache *cp, int flags)
160 {
161         void *retval = NULL;
162         spin_lock_irqsave(&cp->cache_lock);
163         // look at partial list
164         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
165         //      if none, go to empty list and get an empty and make it partial
166         if (!a_slab) {
167                 // TODO: think about non-sleeping flags
168                 if (TAILQ_EMPTY(&cp->empty_slab_list) &&
169                         !kmem_cache_grow(cp)) {
170                         spin_unlock_irqsave(&cp->cache_lock);
171                         if (flags & MEM_ERROR)
172                                 error(ENOMEM, ERROR_FIXME);
173                         else
174                                 panic("[German Accent]: OOM for a small slab growth!!!");
175                 }
176                 // move to partial list
177                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
178                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
179                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
180         }
181         // have a partial now (a_slab), get an item, return item
182         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
183                 retval = a_slab->free_small_obj;
184                 /* adding the size of the cache_obj to get to the pointer at end of the
185                  * buffer pointing to the next free_small_obj */
186                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj +
187                                                         cp->obj_size);
188         } else {
189                 // rip the first bufctl out of the partial slab's buf list
190                 struct kmem_bufctl *a_bufctl = BSD_LIST_FIRST(&a_slab->bufctl_freelist);
191
192                 BSD_LIST_REMOVE(a_bufctl, link);
193                 retval = a_bufctl->buf_addr;
194         }
195         a_slab->num_busy_obj++;
196         // Check if we are full, if so, move to the full list
197         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
198                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
199                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
200         }
201         cp->nr_cur_alloc++;
202         spin_unlock_irqsave(&cp->cache_lock);
203         return retval;
204 }
205
206 static inline struct kmem_bufctl *buf2bufctl(void *buf, size_t offset)
207 {
208         // TODO: hash table for back reference (BUF)
209         return *((struct kmem_bufctl**)(buf + offset));
210 }
211
212 void kmem_cache_free(struct kmem_cache *cp, void *buf)
213 {
214         struct kmem_slab *a_slab;
215         struct kmem_bufctl *a_bufctl;
216
217         spin_lock_irqsave(&cp->cache_lock);
218         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
219                 // find its slab
220                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
221                                              PGSIZE - sizeof(struct kmem_slab));
222                 /* write location of next free small obj to the space at the end of the
223                  * buffer, then list buf as the next free small obj */
224                 *(uintptr_t**)(buf + cp->obj_size) = a_slab->free_small_obj;
225                 a_slab->free_small_obj = buf;
226         } else {
227                 /* Give the bufctl back to the parent slab */
228                 // TODO: (BUF) change the interface to not take an offset
229                 a_bufctl = buf2bufctl(buf, cp->obj_size);
230                 a_slab = a_bufctl->my_slab;
231                 BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
232         }
233         a_slab->num_busy_obj--;
234         cp->nr_cur_alloc--;
235         // if it was full, move it to partial
236         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
237                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
238                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
239         } else if (!a_slab->num_busy_obj) {
240                 // if there are none, move to from partial to empty
241                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
242                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
243         }
244         spin_unlock_irqsave(&cp->cache_lock);
245 }
246
247 /* Back end: internal functions */
248 /* When this returns, the cache has at least one slab in the empty list.  If
249  * page_alloc fails, there are some serious issues.  This only grows by one slab
250  * at a time.
251  *
252  * Grab the cache lock before calling this.
253  *
254  * TODO: think about page colouring issues with kernel memory allocation. */
255 static bool kmem_cache_grow(struct kmem_cache *cp)
256 {
257         struct kmem_slab *a_slab;
258         struct kmem_bufctl *a_bufctl;
259         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
260                 // Just get a single page for small slabs
261                 page_t *a_page;
262
263                 if (kpage_alloc(&a_page))
264                         return FALSE;
265                 // the slab struct is stored at the end of the page
266                 a_slab = (struct kmem_slab*)(page2kva(a_page) + PGSIZE -
267                                              sizeof(struct kmem_slab));
268                 // Need to add room for the next free item pointer in the object buffer.
269                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
270                 a_slab->num_busy_obj = 0;
271                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
272                                         a_slab->obj_size;
273                 // TODO: consider staggering this IAW section 4.3
274                 a_slab->free_small_obj = page2kva(a_page);
275                 /* Walk and create the free list, which is circular.  Each item stores
276                  * the location of the next one at the end of the block. */
277                 void *buf = a_slab->free_small_obj;
278                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
279                         // Initialize the object, if necessary
280                         if (cp->ctor)
281                                 cp->ctor(buf, cp->obj_size);
282                         *(uintptr_t**)(buf + cp->obj_size) = buf + a_slab->obj_size;
283                         buf += a_slab->obj_size;
284                 }
285                 *((uintptr_t**)(buf + cp->obj_size)) = NULL;
286         } else {
287                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
288                 if (!a_slab)
289                         return FALSE;
290                 // TODO: hash table for back reference (BUF)
291                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
292                 /* Figure out how much memory we want.  We need at least min_pgs.  We'll
293                  * ask for the next highest order (power of 2) number of pages */
294                 size_t min_pgs = ROUNDUP(NUM_BUF_PER_SLAB * a_slab->obj_size, PGSIZE) /
295                                          PGSIZE;
296                 size_t order_pg_alloc = LOG2_UP(min_pgs);
297                 void *buf = get_cont_pages(order_pg_alloc, 0);
298
299                 if (!buf) {
300                         kmem_cache_free(kmem_slab_cache, a_slab);
301                         return FALSE;
302                 }
303                 a_slab->num_busy_obj = 0;
304                 /* The number of objects is based on the rounded up amt requested. */
305                 a_slab->num_total_obj = ((1 << order_pg_alloc) * PGSIZE) /
306                                         a_slab->obj_size;
307                 BSD_LIST_INIT(&a_slab->bufctl_freelist);
308                 /* for each buffer, set up a bufctl and point to the buffer */
309                 for (int i = 0; i < a_slab->num_total_obj; i++) {
310                         // Initialize the object, if necessary
311                         if (cp->ctor)
312                                 cp->ctor(buf, cp->obj_size);
313                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);
314                         BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
315                         a_bufctl->buf_addr = buf;
316                         a_bufctl->my_slab = a_slab;
317                         // TODO: (BUF) write the bufctl reference at the bottom of the buffer.
318                         *(struct kmem_bufctl**)(buf + cp->obj_size) = a_bufctl;
319                         buf += a_slab->obj_size;
320                 }
321         }
322         // add a_slab to the empty_list
323         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
324
325         return TRUE;
326 }
327
328 /* This deallocs every slab from the empty list.  TODO: think a bit more about
329  * this.  We can do things like not free all of the empty lists to prevent
330  * thrashing.  See 3.4 in the paper. */
331 void kmem_cache_reap(struct kmem_cache *cp)
332 {
333         struct kmem_slab *a_slab, *next;
334
335         // Destroy all empty slabs.  Refer to the notes about the while loop
336         spin_lock_irqsave(&cp->cache_lock);
337         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
338         while (a_slab) {
339                 next = TAILQ_NEXT(a_slab, link);
340                 kmem_slab_destroy(cp, a_slab);
341                 a_slab = next;
342         }
343         spin_unlock_irqsave(&cp->cache_lock);
344 }
345
346 void print_kmem_cache(struct kmem_cache *cp)
347 {
348         spin_lock_irqsave(&cp->cache_lock);
349         printk("\nPrinting kmem_cache:\n---------------------\n");
350         printk("Name: %s\n", cp->name);
351         printk("Objsize: %d\n", cp->obj_size);
352         printk("Align: %d\n", cp->align);
353         printk("Flags: 0x%08x\n", cp->flags);
354         printk("Constructor: %p\n", cp->ctor);
355         printk("Destructor: %p\n", cp->dtor);
356         printk("Slab Full: %p\n", cp->full_slab_list);
357         printk("Slab Partial: %p\n", cp->partial_slab_list);
358         printk("Slab Empty: %p\n", cp->empty_slab_list);
359         printk("Current Allocations: %d\n", cp->nr_cur_alloc);
360         spin_unlock_irqsave(&cp->cache_lock);
361 }
362
363 void print_kmem_slab(struct kmem_slab *slab)
364 {
365         printk("\nPrinting kmem_slab:\n---------------------\n");
366         printk("Objsize: %d (%p)\n", slab->obj_size, slab->obj_size);
367         printk("NumBusy: %d\n", slab->num_busy_obj);
368         printk("Num_total: %d\n", slab->num_total_obj);
369         if (slab->obj_size + sizeof(uintptr_t) < SLAB_LARGE_CUTOFF) {
370                 printk("Free Small obj: %p\n", slab->free_small_obj);
371                 void *buf = slab->free_small_obj;
372                 for (int i = 0; i < slab->num_total_obj; i++) {
373                         printk("Addr of buf: %p, Addr of next: %p\n", buf,
374                                *((uintptr_t**)buf));
375                         buf += slab->obj_size;
376                 }
377         } else {
378                 printk("This is a big slab!\n");
379         }
380 }
381