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