Removes Ivy annotations (XCC)
[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
19 struct kmem_cache_list kmem_caches;
20 spinlock_t kmem_caches_lock;
21
22 /* Backend/internal functions, defined later.  Grab the lock before calling
23  * these. */
24 static void kmem_cache_grow(struct kmem_cache *cp);
25
26 /* Cache of the kmem_cache objects, needed for bootstrapping */
27 struct kmem_cache kmem_cache_cache;
28 struct kmem_cache *kmem_slab_cache, *kmem_bufctl_cache;
29
30 static 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         
49         /* put in cache list based on it's size */
50         struct kmem_cache *i, *prev = NULL;
51         spin_lock_irqsave(&kmem_caches_lock);
52         /* find the kmem_cache before us in the list.  yes, this is O(n). */
53         SLIST_FOREACH(i, &kmem_caches, link) {
54                 if (i->obj_size < kc->obj_size)
55                         prev = i;
56                 else
57                         break;
58         }
59         if (prev)
60                 SLIST_INSERT_AFTER(prev, kc, link);
61         else
62                 SLIST_INSERT_HEAD(&kmem_caches, kc, link);
63         spin_unlock_irqsave(&kmem_caches_lock);
64 }
65
66 void kmem_cache_init(void)
67 {
68         spinlock_init_irqsave(&kmem_caches_lock);
69         SLIST_INIT(&kmem_caches);
70         /* We need to call the __ version directly to bootstrap the global
71          * kmem_cache_cache. */
72         __kmem_cache_create(&kmem_cache_cache, "kmem_cache",
73                             sizeof(struct kmem_cache),
74                             __alignof__(struct kmem_cache), 0, NULL, NULL);
75         /* Build the slab and bufctl caches */
76         kmem_slab_cache = kmem_cache_create("kmem_slab", sizeof(struct kmem_slab),
77                                __alignof__(struct kmem_slab), 0, NULL, NULL); 
78         kmem_bufctl_cache = kmem_cache_create("kmem_bufctl",
79                                  sizeof(struct kmem_bufctl),
80                                  __alignof__(struct kmem_bufctl), 0, NULL, NULL); 
81 }
82
83 /* Cache management */
84 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
85                                      int align, int flags,
86                                      void (*ctor)(void *, size_t),
87                                      void (*dtor)(void *, size_t))
88 {
89         struct kmem_cache *kc = kmem_cache_alloc(&kmem_cache_cache, 0);
90         __kmem_cache_create(kc, name, obj_size, align, flags, ctor, dtor);
91         return kc;
92 }
93
94 static void kmem_slab_destroy(struct kmem_cache *cp, struct kmem_slab *a_slab)
95 {
96         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
97                 /* Deconstruct all the objects, if necessary */
98                 if (cp->dtor) {
99                         void *buf = a_slab->free_small_obj;
100                         for (int i = 0; i < a_slab->num_total_obj; i++) {
101                                 cp->dtor(buf, cp->obj_size);
102                                 buf += a_slab->obj_size;
103                         }
104                 }
105                 page_decref(kva2page((void*)ROUNDDOWN((uintptr_t)a_slab, PGSIZE)));
106         } else {
107                 struct kmem_bufctl *i;
108                 void *page_start = (void*)-1;
109                 /* Figure out how much memory we asked for earlier.  We needed at least
110                  * min_pgs.  We asked for the next highest order (power of 2) number of
111                  * pages */
112                 size_t min_pgs = ROUNDUP(NUM_BUF_PER_SLAB * a_slab->obj_size, PGSIZE) /
113                                          PGSIZE;
114                 size_t order_pg_alloc = LOG2_UP(min_pgs);
115                 TAILQ_FOREACH(i, &a_slab->bufctl_freelist, link) {
116                         // Track the lowest buffer address, which is the start of the buffer
117                         page_start = MIN(page_start, i->buf_addr);
118                         /* Deconstruct all the objects, if necessary */
119                         if (cp->dtor) // TODO: (BUF)
120                                 cp->dtor(i->buf_addr, cp->obj_size);
121                         kmem_cache_free(kmem_bufctl_cache, i);
122                 }
123                 // free the pages for the slab's buffer
124                 free_cont_pages(page_start, order_pg_alloc);
125                 // free the slab object
126                 kmem_cache_free(kmem_slab_cache, a_slab);
127         }
128 }
129
130 /* Once you call destroy, never use this cache again... o/w there may be weird
131  * races, and other serious issues.  */
132 void kmem_cache_destroy(struct kmem_cache *cp)
133 {
134         struct kmem_slab *a_slab, *next;
135
136         spin_lock_irqsave(&cp->cache_lock);
137         assert(TAILQ_EMPTY(&cp->full_slab_list));
138         assert(TAILQ_EMPTY(&cp->partial_slab_list));
139         /* Clean out the empty list.  We can't use a regular FOREACH here, since the
140          * link element is stored in the slab struct, which is stored on the page
141          * that we are freeing. */
142         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
143         while (a_slab) {
144                 next = TAILQ_NEXT(a_slab, link);
145                 kmem_slab_destroy(cp, a_slab);
146                 a_slab = next;
147         }
148         spin_lock_irqsave(&kmem_caches_lock);
149         SLIST_REMOVE(&kmem_caches, cp, kmem_cache, link);
150         spin_unlock_irqsave(&kmem_caches_lock);
151         kmem_cache_free(&kmem_cache_cache, cp); 
152         spin_unlock_irqsave(&cp->cache_lock);
153 }
154
155 /* Front end: clients of caches use these */
156 void *kmem_cache_alloc(struct kmem_cache *cp, int flags)
157 {
158         void *retval = NULL;
159         spin_lock_irqsave(&cp->cache_lock);
160         // look at partial list
161         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
162         //      if none, go to empty list and get an empty and make it partial
163         if (!a_slab) {
164                 if (TAILQ_EMPTY(&cp->empty_slab_list))
165                         // TODO: think about non-sleeping flags
166                         kmem_cache_grow(cp);
167                 // move to partial list
168                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
169                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
170                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
171         } 
172         // have a partial now (a_slab), get an item, return item
173         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
174                 retval = a_slab->free_small_obj;
175                 /* adding the size of the cache_obj to get to the pointer at end of the
176                  * buffer pointing to the next free_small_obj */
177                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj +
178                                                         cp->obj_size);
179         } else {
180                 // rip the first bufctl out of the partial slab's buf list
181                 struct kmem_bufctl *a_bufctl = TAILQ_FIRST(&a_slab->bufctl_freelist);
182                 TAILQ_REMOVE(&a_slab->bufctl_freelist, a_bufctl, link);
183                 retval = a_bufctl->buf_addr;
184         }
185         a_slab->num_busy_obj++;
186         // Check if we are full, if so, move to the full list
187         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
188                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
189                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
190         }
191         cp->nr_cur_alloc++;
192         spin_unlock_irqsave(&cp->cache_lock);
193         return retval;
194 }
195
196 static inline struct kmem_bufctl *buf2bufctl(void *buf, size_t offset)
197 {
198         // TODO: hash table for back reference (BUF)
199         return *((struct kmem_bufctl**)(buf + offset));
200 }
201
202 void kmem_cache_free(struct kmem_cache *cp, void *buf)
203 {
204         struct kmem_slab *a_slab;
205         struct kmem_bufctl *a_bufctl;
206
207         spin_lock_irqsave(&cp->cache_lock);
208         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
209                 // find its slab
210                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
211                                              PGSIZE - sizeof(struct kmem_slab));
212                 /* write location of next free small obj to the space at the end of the
213                  * buffer, then list buf as the next free small obj */
214                 *(uintptr_t**)(buf + cp->obj_size) = a_slab->free_small_obj;
215                 a_slab->free_small_obj = buf;
216         } else {
217                 /* Give the bufctl back to the parent slab */
218                 // TODO: (BUF) change the interface to not take an offset
219                 a_bufctl = buf2bufctl(buf, cp->obj_size);
220                 a_slab = a_bufctl->my_slab;
221                 TAILQ_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
222         }
223         a_slab->num_busy_obj--;
224         cp->nr_cur_alloc--;
225         // if it was full, move it to partial
226         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
227                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
228                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
229         } else if (!a_slab->num_busy_obj) {
230                 // if there are none, move to from partial to empty
231                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
232                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
233         }
234         spin_unlock_irqsave(&cp->cache_lock);
235 }
236
237 /* Back end: internal functions */
238 /* When this returns, the cache has at least one slab in the empty list.  If
239  * page_alloc fails, there are some serious issues.  This only grows by one slab
240  * at a time.
241  *
242  * Grab the cache lock before calling this.
243  *
244  * TODO: think about page colouring issues with kernel memory allocation. */
245 static void kmem_cache_grow(struct kmem_cache *cp)
246 {
247         struct kmem_slab *a_slab;
248         struct kmem_bufctl *a_bufctl;
249         if (cp->obj_size <= SLAB_LARGE_CUTOFF) {
250                 // Just get a single page for small slabs
251                 page_t *a_page;
252                 if (kpage_alloc(&a_page))
253                         panic("[German Accent]: OOM for a small slab growth!!!");
254                 // the slab struct is stored at the end of the page
255                 a_slab = (struct kmem_slab*)(page2kva(a_page) + PGSIZE -
256                                              sizeof(struct kmem_slab));
257                 // Need to add room for the next free item pointer in the object buffer.
258                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
259                 a_slab->num_busy_obj = 0;
260                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
261                                         a_slab->obj_size;
262                 // TODO: consider staggering this IAW section 4.3
263                 a_slab->free_small_obj = page2kva(a_page);
264                 /* Walk and create the free list, which is circular.  Each item stores
265                  * the location of the next one at the end of the block. */
266                 void *buf = a_slab->free_small_obj;
267                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
268                         // Initialize the object, if necessary
269                         if (cp->ctor)
270                                 cp->ctor(buf, cp->obj_size);
271                         *(uintptr_t**)(buf + cp->obj_size) = buf + a_slab->obj_size;
272                         buf += a_slab->obj_size;
273                 }
274                 *((uintptr_t**)(buf + cp->obj_size)) = NULL;
275         } else {
276                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
277                 // TODO: hash table for back reference (BUF)
278                 a_slab->obj_size = ROUNDUP(cp->obj_size + sizeof(uintptr_t), cp->align);
279                 /* Figure out how much memory we want.  We need at least min_pgs.  We'll
280                  * ask for the next highest order (power of 2) number of pages */
281                 size_t min_pgs = ROUNDUP(NUM_BUF_PER_SLAB * a_slab->obj_size, PGSIZE) /
282                                          PGSIZE;
283                 size_t order_pg_alloc = LOG2_UP(min_pgs);
284                 void *buf = get_cont_pages(order_pg_alloc, 0);
285                 if (!buf)
286                         panic("[German Accent]: OOM for a large slab growth!!!");
287                 a_slab->num_busy_obj = 0;
288                 /* The number of objects is based on the rounded up amt requested. */
289                 a_slab->num_total_obj = ((1 << order_pg_alloc) * PGSIZE) /
290                                         a_slab->obj_size;
291                 TAILQ_INIT(&a_slab->bufctl_freelist);
292                 /* for each buffer, set up a bufctl and point to the buffer */
293                 for (int i = 0; i < a_slab->num_total_obj; i++) {
294                         // Initialize the object, if necessary
295                         if (cp->ctor)
296                                 cp->ctor(buf, cp->obj_size);
297                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);      
298                         TAILQ_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
299                         a_bufctl->buf_addr = buf;
300                         a_bufctl->my_slab = a_slab;
301                         // TODO: (BUF) write the bufctl reference at the bottom of the buffer.
302                         *(struct kmem_bufctl**)(buf + cp->obj_size) = a_bufctl;
303                         buf += a_slab->obj_size;
304                 }
305         }
306         // add a_slab to the empty_list
307         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
308 }
309
310 /* This deallocs every slab from the empty list.  TODO: think a bit more about
311  * this.  We can do things like not free all of the empty lists to prevent
312  * thrashing.  See 3.4 in the paper. */
313 void kmem_cache_reap(struct kmem_cache *cp)
314 {
315         struct kmem_slab *a_slab, *next;
316         
317         // Destroy all empty slabs.  Refer to the notes about the while loop
318         spin_lock_irqsave(&cp->cache_lock);
319         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
320         while (a_slab) {
321                 next = TAILQ_NEXT(a_slab, link);
322                 kmem_slab_destroy(cp, a_slab);
323                 a_slab = next;
324         }
325         spin_unlock_irqsave(&cp->cache_lock);
326 }
327
328 void print_kmem_cache(struct kmem_cache *cp)
329 {
330         spin_lock_irqsave(&cp->cache_lock);
331         printk("\nPrinting kmem_cache:\n---------------------\n");
332         printk("Name: %s\n", cp->name);
333         printk("Objsize: %d\n", cp->obj_size);
334         printk("Align: %d\n", cp->align);
335         printk("Flags: 0x%08x\n", cp->flags);
336         printk("Constructor: %p\n", cp->ctor);
337         printk("Destructor: %p\n", cp->dtor);
338         printk("Slab Full: %p\n", cp->full_slab_list);
339         printk("Slab Partial: %p\n", cp->partial_slab_list);
340         printk("Slab Empty: %p\n", cp->empty_slab_list);
341         printk("Current Allocations: %d\n", cp->nr_cur_alloc);
342         spin_unlock_irqsave(&cp->cache_lock);
343 }
344
345 void print_kmem_slab(struct kmem_slab *slab)
346 {
347         printk("\nPrinting kmem_slab:\n---------------------\n");
348         printk("Objsize: %d (%p)\n", slab->obj_size, slab->obj_size);
349         printk("NumBusy: %d\n", slab->num_busy_obj);
350         printk("Num_total: %d\n", slab->num_total_obj);
351         if (slab->obj_size + sizeof(uintptr_t) < SLAB_LARGE_CUTOFF) {
352                 printk("Free Small obj: %p\n", slab->free_small_obj);
353                 void *buf = slab->free_small_obj;
354                 for (int i = 0; i < slab->num_total_obj; i++) {
355                         printk("Addr of buf: %p, Addr of next: %p\n", buf,
356                                *((uintptr_t**)buf));
357                         buf += slab->obj_size;
358                 }
359         } else {
360                 printk("This is a big slab!\n");
361         }
362 }
363