Add Linux's math64.h
[akaros.git] / kern / src / slab.c
1 /* Copyright (c) 2009 The Regents of the University of California
2  * See LICENSE for details.
3  *
4  * Slab allocator, based on the SunOS 5.4 allocator paper.
5  *
6  * Barret Rhoden <brho@cs.berkeley.edu>
7  * Kevin Klues <klueska@cs.berkeley.edu>
8  *
9  * Copyright (c) 2016 Google Inc
10  *
11  * Upgraded and extended to support magazines, based on Bonwick and Adams's
12  * "Magazines and Vmem" paper.
13  *
14  * Barret Rhoden <brho@cs.berkeley.edu>
15  *
16  * FAQ:
17  * - What sort of allocator do we need for the kmem_pcpu_caches?  In general,
18  *   the base allocator.  All slabs/caches depend on the pcpu_caches for any
19  *   allocation, so we need something that does not rely on slabs.  We could use
20  *   generic kpages, if we knew that we weren't: qcaches for a kpages_arena, the
21  *   slab kcache, or the bufctl kcache.  This is the same set of restrictions
22  *   for the hash table allocations.
23  * - Why doesn't the magazine cache deadlock on itself?  Because magazines are
24  *   only allocated during the free path of another cache.  There are no
25  *   magazine allocations during a cache's allocation.
26  * - Does the magazine cache need to be statically allocated?  Maybe not, but it
27  *   doesn't hurt.  We need to set it up at some point.  We can use other caches
28  *   for allocations before the mag cache is initialized, but we can't free.
29  * - Does the magazine cache need to pull from the base arena?  Similar to the
30  *   static allocation question - by default, maybe not, but it is safer.  And
31  *   yes, due to other design choices.  We could initialize it after kpages is
32  *   allocated and use a kpages_arena, but that would require us to not free a
33  *   page before or during kpages_arena_init().  A related note is where the
34  *   first magazines in a pcpu_cache come from.  I'm currently going with "raw
35  *   slab alloc from the magazine cache", which means magazines need to work
36  *   when we're setting up the qcache's for kpages_arena.  That creates a
37  *   dependency, which means kpages depends on mags, which means mags can only
38  *   depend on base.  If we ever use slabs for non-base arena btags, we'll also
39  *   have this dependency between kpages and mags.
40  * - The paper talks about full and empty magazines.  Why does our code talk
41  *   about not_empty and empty?  The way we'll do our magazine resizing is to
42  *   just() increment the pcpu_cache's magsize.  Then we'll eventually start
43  *   filling the magazines to their new capacity (during frees, btw).  During
44  *   this time, a mag that was previously full will technically be not-empty,
45  *   but not full.  The correctness of the magazine code is still OK, I think,
46  *   since when they say 'full', they require 'not empty' in most cases.  In
47  *   short, 'not empty' is more accurate, though it makes sense to say 'full'
48  *   when explaining the basic idea for their paper.
49  * - Due to a resize, what happens when the depot gives a pcpu cache a magazine
50  *   with *more* rounds than ppc->magsize?  The allocation path doesn't care
51  *   about magsize - it just looks at nr_rounds.  So that's fine.  On the free
52  *   path, we might mistakenly think that a mag has no more room.  In that case,
53  *   we'll just hand it to the depot and it'll be a 'not-empty' mag.  Eventually
54  *   it'll get filled up, or it just won't matter.  'magsize' is basically an
55  *   instruction to the pcpu_cache: "fill to X, please."
56  * - Why is nr_rounds tracked in the magazine and not the pcpu cache?  The paper
57  *   uses the pcpu cache, but doesn't say whether or not the mag tracks it too.
58  *   We track it in the mag since not all mags have the same size (e.g.  during
59  *   a resize operation).  For performance (avoid an occasional cache miss), we
60  *   could consider tracking it in the pcpu_cache.  Might save a miss now and
61  *   then.
62  * - Why do we just disable IRQs for the pcpu_cache?  The paper explicitly talks
63  *   about using locks instead of disabling IRQs, since disabling IRQs can be
64  *   expensive.  First off, we only just disable IRQs when there's 1:1 core to
65  *   pcc.  If we were to use a spinlock, we'd be disabling IRQs anyway, since we
66  *   do allocations from IRQ context.  The other reason to lock is when changing
67  *   the pcpu state during a magazine resize.  I have two ways to do this: just
68  *   racily write and set pcc->magsize, or have the pcc's poll when they check
69  *   the depot during free.  Either approach doesn't require someone else to
70  *   grab a pcc lock.
71  *
72  * TODO:
73  * - Add reclaim function.
74  * - When resizing, do we want to go through the depot and consolidate
75  *   magazines?  (probably not a big deal.  maybe we'd deal with it when we
76  *   clean up our excess mags.)
77  * - Could do some working set tracking.  Like max/min over an interval, with
78  *   resetting (in the depot, used for reclaim and maybe aggressive freeing).
79  * - Debugging info
80  */
81
82 #include <slab.h>
83 #include <stdio.h>
84 #include <assert.h>
85 #include <pmap.h>
86 #include <kmalloc.h>
87 #include <hash.h>
88 #include <arena.h>
89
90 #define SLAB_POISON ((void*)0xdead1111)
91
92 /* Tunables.  I don't know which numbers to pick yet.  Maybe we play with it at
93  * runtime.  Though once a mag increases, it'll never decrease. */
94 uint64_t resize_timeout_ns = 1000000000;
95 unsigned int resize_threshold = 1;
96
97 /* Protected by the arenas_and_slabs_lock. */
98 struct kmem_cache_tailq all_kmem_caches =
99                 TAILQ_HEAD_INITIALIZER(all_kmem_caches);
100
101 /* Backend/internal functions, defined later.  Grab the lock before calling
102  * these. */
103 static bool kmem_cache_grow(struct kmem_cache *cp);
104 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags);
105 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf);
106
107 /* Cache of the kmem_cache objects, needed for bootstrapping */
108 struct kmem_cache kmem_cache_cache[1];
109 struct kmem_cache kmem_slab_cache[1];
110 struct kmem_cache kmem_bufctl_cache[1];
111 struct kmem_cache kmem_magazine_cache[1];
112
113 static bool __use_bufctls(struct kmem_cache *cp)
114 {
115         return cp->flags & __KMC_USE_BUFCTL;
116 }
117
118 /* Using a layer of indirection for the pcpu caches, in case we want to use
119  * clustered objects, only per-NUMA-domain caches, or something like that. */
120 unsigned int kmc_nr_pcpu_caches(void)
121 {
122         return num_cores;
123 }
124
125 static struct kmem_pcpu_cache *get_my_pcpu_cache(struct kmem_cache *kc)
126 {
127         return &kc->pcpu_caches[core_id()];
128 }
129
130 /* In our current model, there is one pcc per core.  If we had multiple cores
131  * that could use the pcc, such as with per-NUMA caches, then we'd need a
132  * spinlock.  Since we do allocations from IRQ context, we still need to disable
133  * IRQs. */
134 static void lock_pcu_cache(struct kmem_pcpu_cache *pcc)
135 {
136         disable_irqsave(&pcc->irq_state);
137 }
138
139 static void unlock_pcu_cache(struct kmem_pcpu_cache *pcc)
140 {
141         enable_irqsave(&pcc->irq_state);
142 }
143
144 static void lock_depot(struct kmem_depot *depot)
145 {
146         uint64_t time;
147
148         if (spin_trylock_irqsave(&depot->lock))
149                 return;
150         /* The lock is contended.  When we finally get the lock, we'll up the
151          * contention count and see if we've had too many contentions over time.
152          *
153          * The idea is that if there are bursts of contention worse than X contended
154          * acquisitions in Y nsec, then we'll grow the magazines.  This might not be
155          * that great of an approach - every thread gets one count, regardless of
156          * how long they take.
157          *
158          * We read the time before locking so that we don't artificially grow the
159          * window too much.  Say the lock is heavily contended and we take a long
160          * time to get it.  Perhaps X threads try to lock it immediately, but it
161          * takes over Y seconds for the Xth thread to actually get the lock.  We
162          * might then think the burst wasn't big enough. */
163         time = nsec();
164         spin_lock_irqsave(&depot->lock);
165         /* If there are no not-empty mags, we're probably fighting for the lock not
166          * because the magazines aren't big enough, but because there aren't enough
167          * mags in the system yet. */
168         if (!depot->nr_not_empty)
169                 return;
170         if (time - depot->busy_start > resize_timeout_ns) {
171                 depot->busy_count = 0;
172                 depot->busy_start = time;
173         }
174         depot->busy_count++;
175         if (depot->busy_count > resize_threshold) {
176                 depot->busy_count = 0;
177                 depot->magsize = MIN(KMC_MAG_MAX_SZ, depot->magsize + 1);
178                 /* That's all we do - the pccs will eventually notice and up their
179                  * magazine sizes. */
180         }
181 }
182
183 static void unlock_depot(struct kmem_depot *depot)
184 {
185         spin_unlock_irqsave(&depot->lock);
186 }
187
188 static void depot_init(struct kmem_depot *depot)
189 {
190         spinlock_init_irqsave(&depot->lock);
191         SLIST_INIT(&depot->not_empty);
192         SLIST_INIT(&depot->empty);
193         depot->magsize = KMC_MAG_MIN_SZ;
194         depot->nr_not_empty = 0;
195         depot->nr_empty = 0;
196         depot->busy_count = 0;
197         depot->busy_start = 0;
198 }
199
200 static bool mag_is_empty(struct kmem_magazine *mag)
201 {
202         return mag->nr_rounds == 0;
203 }
204
205 /* Helper, swaps the loaded and previous mags.  Hold the pcc lock. */
206 static void __swap_mags(struct kmem_pcpu_cache *pcc)
207 {
208         struct kmem_magazine *temp;
209
210         temp = pcc->prev;
211         pcc->prev = pcc->loaded;
212         pcc->loaded = temp;
213 }
214
215 /* Helper, returns a magazine to the depot.  Hold the depot lock. */
216 static void __return_to_depot(struct kmem_cache *kc, struct kmem_magazine *mag)
217 {
218         struct kmem_depot *depot = &kc->depot;
219
220         if (mag_is_empty(mag)) {
221                 SLIST_INSERT_HEAD(&depot->empty, mag, link);
222                 depot->nr_empty++;
223         } else {
224                 SLIST_INSERT_HEAD(&depot->not_empty, mag, link);
225                 depot->nr_not_empty++;
226         }
227 }
228
229 /* Helper, removes the contents of the magazine, giving them back to the slab
230  * layer. */
231 static void drain_mag(struct kmem_cache *kc, struct kmem_magazine *mag)
232 {
233         for (int i = 0; i < mag->nr_rounds; i++) {
234                 if (kc->dtor)
235                         kc->dtor(mag->rounds[i], kc->priv);
236                 __kmem_free_to_slab(kc, mag->rounds[i]);
237         }
238         mag->nr_rounds = 0;
239 }
240
241 static struct kmem_pcpu_cache *build_pcpu_caches(void)
242 {
243         struct kmem_pcpu_cache *pcc;
244
245         pcc = base_alloc(NULL,
246                          sizeof(struct kmem_pcpu_cache) * kmc_nr_pcpu_caches(),
247                          MEM_WAIT);
248         for (int i = 0; i < kmc_nr_pcpu_caches(); i++) {
249                 pcc[i].irq_state = 0;
250                 pcc[i].magsize = KMC_MAG_MIN_SZ;
251                 pcc[i].loaded = __kmem_alloc_from_slab(kmem_magazine_cache, MEM_WAIT);
252                 pcc[i].prev = __kmem_alloc_from_slab(kmem_magazine_cache, MEM_WAIT);
253                 pcc[i].nr_allocs_ever = 0;
254         }
255         return pcc;
256 }
257
258 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
259                          size_t obj_size, int align, int flags,
260                          struct arena *source,
261                          int (*ctor)(void *, void *, int),
262                          void (*dtor)(void *, void *), void *priv)
263 {
264         assert(kc);
265         assert(align);
266         spinlock_init_irqsave(&kc->cache_lock);
267         strlcpy(kc->name, name, KMC_NAME_SZ);
268         kc->obj_size = ROUNDUP(obj_size, align);
269         if (flags & KMC_QCACHE)
270                 kc->import_amt = ROUNDUPPWR2(3 * source->qcache_max);
271         else
272                 kc->import_amt = ROUNDUP(NUM_BUF_PER_SLAB * obj_size, PGSIZE);
273         kc->align = align;
274         if (align > PGSIZE)
275                 panic("Cache %s object alignment is actually MIN(PGSIZE, align (%p))",
276                       name, align);
277         kc->flags = flags;
278         /* We might want some sort of per-call site NUMA-awareness in the future. */
279         kc->source = source ? source : kpages_arena;
280         TAILQ_INIT(&kc->full_slab_list);
281         TAILQ_INIT(&kc->partial_slab_list);
282         TAILQ_INIT(&kc->empty_slab_list);
283         kc->ctor = ctor;
284         kc->dtor = dtor;
285         kc->priv = priv;
286         kc->nr_cur_alloc = 0;
287         kc->nr_direct_allocs_ever = 0;
288         kc->alloc_hash = kc->static_hash;
289         hash_init_hh(&kc->hh);
290         for (int i = 0; i < kc->hh.nr_hash_lists; i++)
291                 BSD_LIST_INIT(&kc->static_hash[i]);
292         /* No touch must use bufctls, even for small objects, so that it does not
293          * use the object as memory.  Note that if we have an arbitrary source,
294          * small objects, and we're 'pro-touch', the small allocation path will
295          * assume we're importing from a PGSIZE-aligned source arena. */
296         if ((obj_size > SLAB_LARGE_CUTOFF) || (flags & KMC_NOTOUCH))
297                 kc->flags |= __KMC_USE_BUFCTL;
298         depot_init(&kc->depot);
299         /* We do this last, since this will all into the magazine cache - which we
300          * could be creating on this call! */
301         kc->pcpu_caches = build_pcpu_caches();
302         add_importing_slab(kc->source, kc);
303         qlock(&arenas_and_slabs_lock);
304         TAILQ_INSERT_TAIL(&all_kmem_caches, kc, all_kmc_link);
305         qunlock(&arenas_and_slabs_lock);
306 }
307
308 static int __mag_ctor(void *obj, void *priv, int flags)
309 {
310         struct kmem_magazine *mag = (struct kmem_magazine*)obj;
311
312         mag->nr_rounds = 0;
313         return 0;
314 }
315
316 void kmem_cache_init(void)
317 {
318         /* magazine must be first - all caches, including mags, will do a slab alloc
319          * from the mag cache. */
320         static_assert(sizeof(struct kmem_magazine) <= SLAB_LARGE_CUTOFF);
321         __kmem_cache_create(kmem_magazine_cache, "kmem_magazine",
322                             sizeof(struct kmem_magazine),
323                             __alignof__(struct kmem_magazine), 0, base_arena,
324                             __mag_ctor, NULL, NULL);
325         __kmem_cache_create(kmem_cache_cache, "kmem_cache",
326                             sizeof(struct kmem_cache),
327                             __alignof__(struct kmem_cache), 0, base_arena,
328                             NULL, NULL, NULL);
329         __kmem_cache_create(kmem_slab_cache, "kmem_slab",
330                             sizeof(struct kmem_slab),
331                             __alignof__(struct kmem_slab), 0, base_arena,
332                             NULL, NULL, NULL);
333         __kmem_cache_create(kmem_bufctl_cache, "kmem_bufctl",
334                             sizeof(struct kmem_bufctl),
335                             __alignof__(struct kmem_bufctl), 0, base_arena,
336                             NULL, NULL, NULL);
337 }
338
339 /* Cache management */
340 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
341                                      int align, int flags,
342                                      struct arena *source,
343                                      int (*ctor)(void *, void *, int),
344                                      void (*dtor)(void *, void *),
345                                      void *priv)
346 {
347         struct kmem_cache *kc = kmem_cache_alloc(kmem_cache_cache, 0);
348
349         __kmem_cache_create(kc, name, obj_size, align, flags, source, ctor, dtor,
350                             priv);
351         return kc;
352 }
353
354 /* Helper during destruction.  No one should be touching the allocator anymore.
355  * We just need to hand objects back to the depot, which will hand them to the
356  * slab.  Locking is just a formality here. */
357 static void drain_pcpu_caches(struct kmem_cache *kc)
358 {
359         struct kmem_pcpu_cache *pcc;
360
361         for (int i = 0; i < kmc_nr_pcpu_caches(); i++) {
362                 pcc = &kc->pcpu_caches[i];
363                 lock_pcu_cache(pcc);
364                 lock_depot(&kc->depot);
365                 __return_to_depot(kc, pcc->loaded);
366                 __return_to_depot(kc, pcc->prev);
367                 unlock_depot(&kc->depot);
368                 pcc->loaded = SLAB_POISON;
369                 pcc->prev = SLAB_POISON;
370                 unlock_pcu_cache(pcc);
371         }
372 }
373
374 static void depot_destroy(struct kmem_cache *kc)
375 {
376         struct kmem_magazine *mag_i;
377         struct kmem_depot *depot = &kc->depot;
378
379         lock_depot(depot);
380         while ((mag_i = SLIST_FIRST(&depot->not_empty))) {
381                 drain_mag(kc, mag_i);
382                 kmem_cache_free(kmem_magazine_cache, mag_i);
383         }
384         while ((mag_i = SLIST_FIRST(&depot->empty)))
385                 kmem_cache_free(kmem_magazine_cache, mag_i);
386         unlock_depot(depot);
387 }
388
389 static void kmem_slab_destroy(struct kmem_cache *cp, struct kmem_slab *a_slab)
390 {
391         if (!__use_bufctls(cp)) {
392                 arena_free(cp->source, ROUNDDOWN(a_slab, PGSIZE), PGSIZE);
393         } else {
394                 struct kmem_bufctl *i, *temp;
395                 void *buf_start = (void*)SIZE_MAX;
396
397                 BSD_LIST_FOREACH_SAFE(i, &a_slab->bufctl_freelist, link, temp) {
398                         // Track the lowest buffer address, which is the start of the buffer
399                         buf_start = MIN(buf_start, i->buf_addr);
400                         /* This is a little dangerous, but we can skip removing, since we
401                          * init the freelist when we reuse the slab. */
402                         kmem_cache_free(kmem_bufctl_cache, i);
403                 }
404                 arena_free(cp->source, buf_start, cp->import_amt);
405                 kmem_cache_free(kmem_slab_cache, a_slab);
406         }
407 }
408
409 /* Once you call destroy, never use this cache again... o/w there may be weird
410  * races, and other serious issues.  */
411 void kmem_cache_destroy(struct kmem_cache *cp)
412 {
413         struct kmem_slab *a_slab, *next;
414
415         qlock(&arenas_and_slabs_lock);
416         TAILQ_REMOVE(&all_kmem_caches, cp, all_kmc_link);
417         qunlock(&arenas_and_slabs_lock);
418         del_importing_slab(cp->source, cp);
419         drain_pcpu_caches(cp);
420         depot_destroy(cp);
421         spin_lock_irqsave(&cp->cache_lock);
422         assert(TAILQ_EMPTY(&cp->full_slab_list));
423         assert(TAILQ_EMPTY(&cp->partial_slab_list));
424         /* Clean out the empty list.  We can't use a regular FOREACH here, since the
425          * link element is stored in the slab struct, which is stored on the page
426          * that we are freeing. */
427         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
428         while (a_slab) {
429                 next = TAILQ_NEXT(a_slab, link);
430                 kmem_slab_destroy(cp, a_slab);
431                 a_slab = next;
432         }
433         spin_unlock_irqsave(&cp->cache_lock);
434         kmem_cache_free(kmem_cache_cache, cp);
435 }
436
437 static void __try_hash_resize(struct kmem_cache *cp)
438 {
439         struct kmem_bufctl_list *new_tbl, *old_tbl;
440         struct kmem_bufctl *bc_i;
441         unsigned int new_tbl_nr_lists, old_tbl_nr_lists;
442         size_t new_tbl_sz, old_tbl_sz;
443         size_t hash_idx;
444
445         if (!hash_needs_more(&cp->hh))
446                 return;
447         new_tbl_nr_lists = hash_next_nr_lists(&cp->hh);
448         new_tbl_sz = new_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
449         /* TODO: we only need to pull from base if our arena is a base or we are
450          * inside a kpages arena (keep in mind there could be more than one of
451          * those, depending on how we do NUMA allocs).  This might help with
452          * fragmentation.  To know this, we'll need the caller to pass us a flag. */
453         new_tbl = base_zalloc(NULL, new_tbl_sz, ARENA_INSTANTFIT | MEM_ATOMIC);
454         if (!new_tbl)
455                 return;
456         old_tbl = cp->alloc_hash;
457         old_tbl_nr_lists = cp->hh.nr_hash_lists;
458         old_tbl_sz = old_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
459         cp->alloc_hash = new_tbl;
460         hash_incr_nr_lists(&cp->hh);
461         for (int i = 0; i < old_tbl_nr_lists; i++) {
462                 while ((bc_i = BSD_LIST_FIRST(&old_tbl[i]))) {
463                         BSD_LIST_REMOVE(bc_i, link);
464                         hash_idx = hash_ptr(bc_i->buf_addr, cp->hh.nr_hash_bits);
465                         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc_i, link);
466                 }
467         }
468         hash_reset_load_limit(&cp->hh);
469         if (old_tbl != cp->static_hash)
470                 base_free(NULL, old_tbl, old_tbl_sz);
471 }
472
473 /* Helper, tracks the allocation of @bc in the hash table */
474 static void __track_alloc(struct kmem_cache *cp, struct kmem_bufctl *bc)
475 {
476         size_t hash_idx;
477
478         hash_idx = hash_ptr(bc->buf_addr, cp->hh.nr_hash_bits);
479         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc, link);
480         cp->hh.nr_items++;
481         __try_hash_resize(cp);
482 }
483
484 /* Helper, looks up and removes the bufctl corresponding to buf. */
485 static struct kmem_bufctl *__yank_bufctl(struct kmem_cache *cp, void *buf)
486 {
487         struct kmem_bufctl *bc_i;
488         size_t hash_idx;
489
490         hash_idx = hash_ptr(buf, cp->hh.nr_hash_bits);
491         BSD_LIST_FOREACH(bc_i, &cp->alloc_hash[hash_idx], link) {
492                 if (bc_i->buf_addr == buf) {
493                         BSD_LIST_REMOVE(bc_i, link);
494                         break;
495                 }
496         }
497         if (!bc_i)
498                 panic("Could not find buf %p in cache %s!", buf, cp->name);
499         return bc_i;
500 }
501
502 /* Alloc, bypassing the magazines and depot */
503 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags)
504 {
505         void *retval = NULL;
506         spin_lock_irqsave(&cp->cache_lock);
507         // look at partial list
508         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
509         //      if none, go to empty list and get an empty and make it partial
510         if (!a_slab) {
511                 // TODO: think about non-sleeping flags
512                 if (TAILQ_EMPTY(&cp->empty_slab_list) &&
513                         !kmem_cache_grow(cp)) {
514                         spin_unlock_irqsave(&cp->cache_lock);
515                         if (flags & MEM_ERROR)
516                                 error(ENOMEM, ERROR_FIXME);
517                         else
518                                 panic("[German Accent]: OOM for a small slab growth!!!");
519                 }
520                 // move to partial list
521                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
522                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
523                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
524         }
525         // have a partial now (a_slab), get an item, return item
526         if (!__use_bufctls(cp)) {
527                 retval = a_slab->free_small_obj;
528                 /* the next free_small_obj address is stored at the beginning of the
529                  * current free_small_obj. */
530                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj);
531         } else {
532                 // rip the first bufctl out of the partial slab's buf list
533                 struct kmem_bufctl *a_bufctl = BSD_LIST_FIRST(&a_slab->bufctl_freelist);
534
535                 BSD_LIST_REMOVE(a_bufctl, link);
536                 __track_alloc(cp, a_bufctl);
537                 retval = a_bufctl->buf_addr;
538         }
539         a_slab->num_busy_obj++;
540         // Check if we are full, if so, move to the full list
541         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
542                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
543                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
544         }
545         cp->nr_cur_alloc++;
546         cp->nr_direct_allocs_ever++;
547         spin_unlock_irqsave(&cp->cache_lock);
548         if (cp->ctor) {
549                 if (cp->ctor(retval, cp->priv, flags)) {
550                         warn("Ctor %p failed, probably a bug!");
551                         __kmem_free_to_slab(cp, retval);
552                         return NULL;
553                 }
554         }
555         return retval;
556 }
557
558 void *kmem_cache_alloc(struct kmem_cache *kc, int flags)
559 {
560         struct kmem_pcpu_cache *pcc = get_my_pcpu_cache(kc);
561         struct kmem_depot *depot = &kc->depot;
562         struct kmem_magazine *mag;
563         void *ret;
564
565         lock_pcu_cache(pcc);
566 try_alloc:
567         if (pcc->loaded->nr_rounds) {
568                 ret = pcc->loaded->rounds[pcc->loaded->nr_rounds - 1];
569                 pcc->loaded->nr_rounds--;
570                 pcc->nr_allocs_ever++;
571                 unlock_pcu_cache(pcc);
572                 return ret;
573         }
574         if (!mag_is_empty(pcc->prev)) {
575                 __swap_mags(pcc);
576                 goto try_alloc;
577         }
578         /* Note the lock ordering: pcc -> depot */
579         lock_depot(depot);
580         mag = SLIST_FIRST(&depot->not_empty);
581         if (mag) {
582                 SLIST_REMOVE_HEAD(&depot->not_empty, link);
583                 depot->nr_not_empty--;
584                 __return_to_depot(kc, pcc->prev);
585                 unlock_depot(depot);
586                 pcc->prev = pcc->loaded;
587                 pcc->loaded = mag;
588                 goto try_alloc;
589         }
590         unlock_depot(depot);
591         unlock_pcu_cache(pcc);
592         return __kmem_alloc_from_slab(kc, flags);
593 }
594
595 /* Returns an object to the slab layer.  Caller must deconstruct the objects.
596  * Note that objects in the slabs are unconstructed. */
597 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf)
598 {
599         struct kmem_slab *a_slab;
600         struct kmem_bufctl *a_bufctl;
601
602         spin_lock_irqsave(&cp->cache_lock);
603         if (!__use_bufctls(cp)) {
604                 // find its slab
605                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
606                                              PGSIZE - sizeof(struct kmem_slab));
607                 /* write location of next free small obj to the space at the beginning
608                  * of the buffer, then list buf as the next free small obj */
609                 *(uintptr_t**)buf = a_slab->free_small_obj;
610                 a_slab->free_small_obj = buf;
611         } else {
612                 /* Give the bufctl back to the parent slab */
613                 a_bufctl = __yank_bufctl(cp, buf);
614                 a_slab = a_bufctl->my_slab;
615                 BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
616         }
617         a_slab->num_busy_obj--;
618         cp->nr_cur_alloc--;
619         // if it was full, move it to partial
620         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
621                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
622                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
623         } else if (!a_slab->num_busy_obj) {
624                 // if there are none, move to from partial to empty
625                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
626                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
627         }
628         spin_unlock_irqsave(&cp->cache_lock);
629 }
630
631 void kmem_cache_free(struct kmem_cache *kc, void *buf)
632 {
633         struct kmem_pcpu_cache *pcc = get_my_pcpu_cache(kc);
634         struct kmem_depot *depot = &kc->depot;
635         struct kmem_magazine *mag;
636
637         lock_pcu_cache(pcc);
638 try_free:
639         if (pcc->loaded->nr_rounds < pcc->magsize) {
640                 pcc->loaded->rounds[pcc->loaded->nr_rounds] = buf;
641                 pcc->loaded->nr_rounds++;
642                 unlock_pcu_cache(pcc);
643                 return;
644         }
645         /* The paper checks 'is empty' here.  But we actually just care if it has
646          * room left, not that prev is completely empty.  This could be the case due
647          * to magazine resize. */
648         if (pcc->prev->nr_rounds < pcc->magsize) {
649                 __swap_mags(pcc);
650                 goto try_free;
651         }
652         lock_depot(depot);
653         /* Here's where the resize magic happens.  We'll start using it for the next
654          * magazine. */
655         pcc->magsize = depot->magsize;
656         mag = SLIST_FIRST(&depot->empty);
657         if (mag) {
658                 SLIST_REMOVE_HEAD(&depot->empty, link);
659                 depot->nr_empty--;
660                 __return_to_depot(kc, pcc->prev);
661                 unlock_depot(depot);
662                 pcc->prev = pcc->loaded;
663                 pcc->loaded = mag;
664                 goto try_free;
665         }
666         unlock_depot(depot);
667         /* Need to unlock, in case we end up calling back into ourselves. */
668         unlock_pcu_cache(pcc);
669         /* don't want to wait on a free.  if this fails, we can still just give it
670          * to the slab layer. */
671         mag = kmem_cache_alloc(kmem_magazine_cache, MEM_ATOMIC);
672         if (mag) {
673                 assert(mag->nr_rounds == 0);    /* paranoia, can probably remove */
674                 lock_depot(depot);
675                 SLIST_INSERT_HEAD(&depot->empty, mag, link);
676                 depot->nr_empty++;
677                 unlock_depot(depot);
678                 lock_pcu_cache(pcc);
679                 goto try_free;
680         }
681         if (kc->dtor)
682                 kc->dtor(buf, kc->priv);
683         __kmem_free_to_slab(kc, buf);
684 }
685
686 /* Back end: internal functions */
687 /* When this returns, the cache has at least one slab in the empty list.  If
688  * page_alloc fails, there are some serious issues.  This only grows by one slab
689  * at a time.
690  *
691  * Grab the cache lock before calling this.
692  *
693  * TODO: think about page colouring issues with kernel memory allocation. */
694 static bool kmem_cache_grow(struct kmem_cache *cp)
695 {
696         struct kmem_slab *a_slab;
697         struct kmem_bufctl *a_bufctl;
698
699         if (!__use_bufctls(cp)) {
700                 void *a_page;
701
702                 /* Careful, this assumes our source is a PGSIZE-aligned allocator.  We
703                  * could use xalloc to enforce the alignment, but that'll bypass the
704                  * qcaches, which we don't want.  Caller beware. */
705                 a_page = arena_alloc(cp->source, PGSIZE, MEM_ATOMIC);
706                 if (!a_page)
707                         return FALSE;
708                 // the slab struct is stored at the end of the page
709                 a_slab = (struct kmem_slab*)(a_page + PGSIZE
710                                              - sizeof(struct kmem_slab));
711                 a_slab->num_busy_obj = 0;
712                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
713                                         cp->obj_size;
714                 // TODO: consider staggering this IAW section 4.3
715                 a_slab->free_small_obj = a_page;
716                 /* Walk and create the free list, which is circular.  Each item stores
717                  * the location of the next one at the beginning of the block. */
718                 void *buf = a_slab->free_small_obj;
719                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
720                         *(uintptr_t**)buf = buf + cp->obj_size;
721                         buf += cp->obj_size;
722                 }
723                 *((uintptr_t**)buf) = NULL;
724         } else {
725                 void *buf;
726
727                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
728                 if (!a_slab)
729                         return FALSE;
730                 buf = arena_alloc(cp->source, cp->import_amt, MEM_ATOMIC);
731                 if (!buf) {
732                         kmem_cache_free(kmem_slab_cache, a_slab);
733                         return FALSE;
734                 }
735                 a_slab->num_busy_obj = 0;
736                 a_slab->num_total_obj = cp->import_amt / cp->obj_size;
737                 BSD_LIST_INIT(&a_slab->bufctl_freelist);
738                 /* for each buffer, set up a bufctl and point to the buffer */
739                 for (int i = 0; i < a_slab->num_total_obj; i++) {
740                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);
741                         BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
742                         a_bufctl->buf_addr = buf;
743                         a_bufctl->my_slab = a_slab;
744                         buf += cp->obj_size;
745                 }
746         }
747         // add a_slab to the empty_list
748         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
749
750         return TRUE;
751 }
752
753 /* This deallocs every slab from the empty list.  TODO: think a bit more about
754  * this.  We can do things like not free all of the empty lists to prevent
755  * thrashing.  See 3.4 in the paper. */
756 void kmem_cache_reap(struct kmem_cache *cp)
757 {
758         struct kmem_slab *a_slab, *next;
759
760         // Destroy all empty slabs.  Refer to the notes about the while loop
761         spin_lock_irqsave(&cp->cache_lock);
762         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
763         while (a_slab) {
764                 next = TAILQ_NEXT(a_slab, link);
765                 kmem_slab_destroy(cp, a_slab);
766                 a_slab = next;
767         }
768         spin_unlock_irqsave(&cp->cache_lock);
769 }