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