Rename KMALLOC_* -> MEM_* [2/2]
[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;
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                 TAILQ_FOREACH(i, &a_slab->bufctl_freelist, link) {
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                         kmem_cache_free(kmem_bufctl_cache, i);
123                 }
124                 // free the pages for the slab's buffer
125                 free_cont_pages(page_start, order_pg_alloc);
126                 // free the slab object
127                 kmem_cache_free(kmem_slab_cache, a_slab);
128         }
129 }
130
131 /* Once you call destroy, never use this cache again... o/w there may be weird
132  * races, and other serious issues.  */
133 void kmem_cache_destroy(struct kmem_cache *cp)
134 {
135         struct kmem_slab *a_slab, *next;
136
137         spin_lock_irqsave(&cp->cache_lock);
138         assert(TAILQ_EMPTY(&cp->full_slab_list));
139         assert(TAILQ_EMPTY(&cp->partial_slab_list));
140         /* Clean out the empty list.  We can't use a regular FOREACH here, since the
141          * link element is stored in the slab struct, which is stored on the page
142          * that we are freeing. */
143         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
144         while (a_slab) {
145                 next = TAILQ_NEXT(a_slab, link);
146                 kmem_slab_destroy(cp, a_slab);
147                 a_slab = next;
148         }
149         spin_lock_irqsave(&kmem_caches_lock);
150         SLIST_REMOVE(&kmem_caches, cp, kmem_cache, link);
151         spin_unlock_irqsave(&kmem_caches_lock);
152         kmem_cache_free(&kmem_cache_cache, cp); 
153         spin_unlock_irqsave(&cp->cache_lock);
154 }
155
156 /* Front end: clients of caches use these */
157 void *kmem_cache_alloc(struct kmem_cache *cp, int flags)
158 {
159         void *retval = NULL;
160         spin_lock_irqsave(&cp->cache_lock);
161         // look at partial list
162         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
163         //      if none, go to empty list and get an empty and make it partial
164         if (!a_slab) {
165                 // TODO: think about non-sleeping flags
166                 if (TAILQ_EMPTY(&cp->empty_slab_list) &&
167                         !kmem_cache_grow(cp)) {
168                         spin_unlock_irqsave(&cp->cache_lock);
169                         if (flags & MEM_ERROR)
170                                 error(ENOMEM, ERROR_FIXME);
171                         else
172                                 panic("[German Accent]: OOM for a small slab growth!!!");
173                 }
174                 // move to partial list
175                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
176                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
177                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
178         } 
179         // have a partial now (a_slab), get an item, return item
180         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
181                 retval = a_slab->free_small_obj;
182                 /* adding the size of the cache_obj to get to the pointer at end of the
183                  * buffer pointing to the next free_small_obj */
184                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj +
185                                                         cp->obj_size);
186         } else {
187                 // rip the first bufctl out of the partial slab's buf list
188                 struct kmem_bufctl *a_bufctl = TAILQ_FIRST(&a_slab->bufctl_freelist);
189                 TAILQ_REMOVE(&a_slab->bufctl_freelist, a_bufctl, link);
190                 retval = a_bufctl->buf_addr;
191         }
192         a_slab->num_busy_obj++;
193         // Check if we are full, if so, move to the full list
194         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
195                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
196                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
197         }
198         cp->nr_cur_alloc++;
199         spin_unlock_irqsave(&cp->cache_lock);
200         return retval;
201 }
202
203 static inline struct kmem_bufctl *buf2bufctl(void *buf, size_t offset)
204 {
205         // TODO: hash table for back reference (BUF)
206         return *((struct kmem_bufctl**)(buf + offset));
207 }
208
209 void kmem_cache_free(struct kmem_cache *cp, void *buf)
210 {
211         struct kmem_slab *a_slab;
212         struct kmem_bufctl *a_bufctl;
213
214         spin_lock_irqsave(&cp->cache_lock);
215         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
216                 // find its slab
217                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
218                                              PGSIZE - sizeof(struct kmem_slab));
219                 /* write location of next free small obj to the space at the end of the
220                  * buffer, then list buf as the next free small obj */
221                 *(uintptr_t**)(buf + cp->obj_size) = a_slab->free_small_obj;
222                 a_slab->free_small_obj = buf;
223         } else {
224                 /* Give the bufctl back to the parent slab */
225                 // TODO: (BUF) change the interface to not take an offset
226                 a_bufctl = buf2bufctl(buf, cp->obj_size);
227                 a_slab = a_bufctl->my_slab;
228                 TAILQ_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
229         }
230         a_slab->num_busy_obj--;
231         cp->nr_cur_alloc--;
232         // if it was full, move it to partial
233         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
234                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
235                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
236         } else if (!a_slab->num_busy_obj) {
237                 // if there are none, move to from partial to empty
238                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
239                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
240         }
241         spin_unlock_irqsave(&cp->cache_lock);
242 }
243
244 /* Back end: internal functions */
245 /* When this returns, the cache has at least one slab in the empty list.  If
246  * page_alloc fails, there are some serious issues.  This only grows by one slab
247  * at a time.
248  *
249  * Grab the cache lock before calling this.
250  *
251  * TODO: think about page colouring issues with kernel memory allocation. */
252 static bool kmem_cache_grow(struct kmem_cache *cp)
253 {
254         struct kmem_slab *a_slab;
255         struct kmem_bufctl *a_bufctl;
256         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
257                 // Just get a single page for small slabs
258                 page_t *a_page;
259
260                 if (kpage_alloc(&a_page))
261                         return FALSE;
262                 // the slab struct is stored at the end of the page
263                 a_slab = (struct kmem_slab*)(page2kva(a_page) + PGSIZE -
264                                              sizeof(struct kmem_slab));
265                 // Need to add room for the next free item pointer in the object buffer.
266                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
267                 a_slab->num_busy_obj = 0;
268                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
269                                         a_slab->obj_size;
270                 // TODO: consider staggering this IAW section 4.3
271                 a_slab->free_small_obj = page2kva(a_page);
272                 /* Walk and create the free list, which is circular.  Each item stores
273                  * the location of the next one at the end of the block. */
274                 void *buf = a_slab->free_small_obj;
275                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
276                         // Initialize the object, if necessary
277                         if (cp->ctor)
278                                 cp->ctor(buf, cp->obj_size);
279                         *(uintptr_t**)(buf + cp->obj_size) = buf + a_slab->obj_size;
280                         buf += a_slab->obj_size;
281                 }
282                 *((uintptr_t**)(buf + cp->obj_size)) = NULL;
283         } else {
284                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
285                 if (!a_slab)
286                         return FALSE;
287                 // TODO: hash table for back reference (BUF)
288                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
289                 /* Figure out how much memory we want.  We need at least min_pgs.  We'll
290                  * ask for the next highest order (power of 2) number of pages */
291                 size_t min_pgs = ROUNDUP(NUM_BUF_PER_SLAB * a_slab->obj_size, PGSIZE) /
292                                          PGSIZE;
293                 size_t order_pg_alloc = LOG2_UP(min_pgs);
294                 void *buf = get_cont_pages(order_pg_alloc, 0);
295
296                 if (!buf) {
297                         kmem_cache_free(kmem_slab_cache, a_slab);
298                         return FALSE;
299                 }
300                 a_slab->num_busy_obj = 0;
301                 /* The number of objects is based on the rounded up amt requested. */
302                 a_slab->num_total_obj = ((1 << order_pg_alloc) * PGSIZE) /
303                                         a_slab->obj_size;
304                 TAILQ_INIT(&a_slab->bufctl_freelist);
305                 /* for each buffer, set up a bufctl and point to the buffer */
306                 for (int i = 0; i < a_slab->num_total_obj; i++) {
307                         // Initialize the object, if necessary
308                         if (cp->ctor)
309                                 cp->ctor(buf, cp->obj_size);
310                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);      
311                         TAILQ_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
312                         a_bufctl->buf_addr = buf;
313                         a_bufctl->my_slab = a_slab;
314                         // TODO: (BUF) write the bufctl reference at the bottom of the buffer.
315                         *(struct kmem_bufctl**)(buf + cp->obj_size) = a_bufctl;
316                         buf += a_slab->obj_size;
317                 }
318         }
319         // add a_slab to the empty_list
320         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
321
322         return TRUE;
323 }
324
325 /* This deallocs every slab from the empty list.  TODO: think a bit more about
326  * this.  We can do things like not free all of the empty lists to prevent
327  * thrashing.  See 3.4 in the paper. */
328 void kmem_cache_reap(struct kmem_cache *cp)
329 {
330         struct kmem_slab *a_slab, *next;
331         
332         // Destroy all empty slabs.  Refer to the notes about the while loop
333         spin_lock_irqsave(&cp->cache_lock);
334         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
335         while (a_slab) {
336                 next = TAILQ_NEXT(a_slab, link);
337                 kmem_slab_destroy(cp, a_slab);
338                 a_slab = next;
339         }
340         spin_unlock_irqsave(&cp->cache_lock);
341 }
342
343 void print_kmem_cache(struct kmem_cache *cp)
344 {
345         spin_lock_irqsave(&cp->cache_lock);
346         printk("\nPrinting kmem_cache:\n---------------------\n");
347         printk("Name: %s\n", cp->name);
348         printk("Objsize: %d\n", cp->obj_size);
349         printk("Align: %d\n", cp->align);
350         printk("Flags: 0x%08x\n", cp->flags);
351         printk("Constructor: %p\n", cp->ctor);
352         printk("Destructor: %p\n", cp->dtor);
353         printk("Slab Full: %p\n", cp->full_slab_list);
354         printk("Slab Partial: %p\n", cp->partial_slab_list);
355         printk("Slab Empty: %p\n", cp->empty_slab_list);
356         printk("Current Allocations: %d\n", cp->nr_cur_alloc);
357         spin_unlock_irqsave(&cp->cache_lock);
358 }
359
360 void print_kmem_slab(struct kmem_slab *slab)
361 {
362         printk("\nPrinting kmem_slab:\n---------------------\n");
363         printk("Objsize: %d (%p)\n", slab->obj_size, slab->obj_size);
364         printk("NumBusy: %d\n", slab->num_busy_obj);
365         printk("Num_total: %d\n", slab->num_total_obj);
366         if (slab->obj_size + sizeof(uintptr_t) < SLAB_LARGE_CUTOFF) {
367                 printk("Free Small obj: %p\n", slab->free_small_obj);
368                 void *buf = slab->free_small_obj;
369                 for (int i = 0; i < slab->num_total_obj; i++) {
370                         printk("Addr of buf: %p, Addr of next: %p\n", buf,
371                                *((uintptr_t**)buf));
372                         buf += slab->obj_size;
373                 }
374         } else {
375                 printk("This is a big slab!\n");
376         }
377 }
378