Rename RCU CB context to 'cannot block' context
[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 #include <hashtable.h>
90
91 #define SLAB_POISON ((void*)0xdead1111)
92
93 /* Tunables.  I don't know which numbers to pick yet.  Maybe we play with it at
94  * runtime.  Though once a mag increases, it'll never decrease. */
95 uint64_t resize_timeout_ns = 1000000000;
96 unsigned int resize_threshold = 1;
97
98 /* Protected by the arenas_and_slabs_lock. */
99 struct kmem_cache_tailq all_kmem_caches =
100                 TAILQ_HEAD_INITIALIZER(all_kmem_caches);
101
102 static void kmc_track(struct kmem_cache *kc)
103 {
104         struct kmem_cache *kc_i;
105
106         qlock(&arenas_and_slabs_lock);
107         TAILQ_FOREACH(kc_i, &all_kmem_caches, all_kmc_link) {
108                 if (!strcmp(kc->name, kc_i->name))
109                         warn("New KMC %s created, but one with that name exists!",
110                              kc->name);
111         }
112         TAILQ_INSERT_TAIL(&all_kmem_caches, kc, all_kmc_link);
113         qunlock(&arenas_and_slabs_lock);
114 }
115
116 static void kmc_untrack(struct kmem_cache *kc)
117 {
118         qlock(&arenas_and_slabs_lock);
119         TAILQ_REMOVE(&all_kmem_caches, kc, all_kmc_link);
120         qunlock(&arenas_and_slabs_lock);
121 }
122
123 /* Backend/internal functions, defined later.  Grab the lock before calling
124  * these. */
125 static bool kmem_cache_grow(struct kmem_cache *cp);
126 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags);
127 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf);
128
129 /* Forward declarations for trace hooks */
130 static void kmem_trace_ht_init(struct kmem_trace_ht *ht);
131 static void kmem_trace_free(struct kmem_cache *kc, void *obj);
132 static void kmem_trace_alloc(struct kmem_cache *kc, void *obj);
133 static void kmem_trace_warn_notempty(struct kmem_cache *kc);
134
135 /* Cache of the kmem_cache objects, needed for bootstrapping */
136 struct kmem_cache kmem_cache_cache[1];
137 struct kmem_cache kmem_slab_cache[1];
138 struct kmem_cache kmem_bufctl_cache[1];
139 struct kmem_cache kmem_magazine_cache[1];
140 struct kmem_cache kmem_trace_cache[1];
141
142 static bool __use_bufctls(struct kmem_cache *cp)
143 {
144         return cp->flags & __KMC_USE_BUFCTL;
145 }
146
147 /* Using a layer of indirection for the pcpu caches, in case we want to use
148  * clustered objects, only per-NUMA-domain caches, or something like that. */
149 unsigned int kmc_nr_pcpu_caches(void)
150 {
151         return num_cores;
152 }
153
154 static struct kmem_pcpu_cache *get_my_pcpu_cache(struct kmem_cache *kc)
155 {
156         return &kc->pcpu_caches[core_id()];
157 }
158
159 /* In our current model, there is one pcc per core.  If we had multiple cores
160  * that could use the pcc, such as with per-NUMA caches, then we'd need a
161  * spinlock.  Since we do allocations from IRQ context, we still need to disable
162  * IRQs. */
163 static void lock_pcu_cache(struct kmem_pcpu_cache *pcc)
164 {
165         disable_irqsave(&pcc->irq_state);
166 }
167
168 static void unlock_pcu_cache(struct kmem_pcpu_cache *pcc)
169 {
170         enable_irqsave(&pcc->irq_state);
171 }
172
173 static void lock_depot(struct kmem_depot *depot)
174 {
175         uint64_t time;
176
177         if (spin_trylock_irqsave(&depot->lock))
178                 return;
179         /* The lock is contended.  When we finally get the lock, we'll up the
180          * contention count and see if we've had too many contentions over time.
181          *
182          * The idea is that if there are bursts of contention worse than X contended
183          * acquisitions in Y nsec, then we'll grow the magazines.  This might not be
184          * that great of an approach - every thread gets one count, regardless of
185          * how long they take.
186          *
187          * We read the time before locking so that we don't artificially grow the
188          * window too much.  Say the lock is heavily contended and we take a long
189          * time to get it.  Perhaps X threads try to lock it immediately, but it
190          * takes over Y seconds for the Xth thread to actually get the lock.  We
191          * might then think the burst wasn't big enough. */
192         time = nsec();
193         spin_lock_irqsave(&depot->lock);
194         /* If there are no not-empty mags, we're probably fighting for the lock not
195          * because the magazines aren't big enough, but because there aren't enough
196          * mags in the system yet. */
197         if (!depot->nr_not_empty)
198                 return;
199         if (time - depot->busy_start > resize_timeout_ns) {
200                 depot->busy_count = 0;
201                 depot->busy_start = time;
202         }
203         depot->busy_count++;
204         if (depot->busy_count > resize_threshold) {
205                 depot->busy_count = 0;
206                 depot->magsize = MIN(KMC_MAG_MAX_SZ, depot->magsize + 1);
207                 /* That's all we do - the pccs will eventually notice and up their
208                  * magazine sizes. */
209         }
210 }
211
212 static void unlock_depot(struct kmem_depot *depot)
213 {
214         spin_unlock_irqsave(&depot->lock);
215 }
216
217 static void depot_init(struct kmem_depot *depot)
218 {
219         spinlock_init_irqsave(&depot->lock);
220         SLIST_INIT(&depot->not_empty);
221         SLIST_INIT(&depot->empty);
222         depot->magsize = KMC_MAG_MIN_SZ;
223         depot->nr_not_empty = 0;
224         depot->nr_empty = 0;
225         depot->busy_count = 0;
226         depot->busy_start = 0;
227 }
228
229 static bool mag_is_empty(struct kmem_magazine *mag)
230 {
231         return mag->nr_rounds == 0;
232 }
233
234 /* Helper, swaps the loaded and previous mags.  Hold the pcc lock. */
235 static void __swap_mags(struct kmem_pcpu_cache *pcc)
236 {
237         struct kmem_magazine *temp;
238
239         temp = pcc->prev;
240         pcc->prev = pcc->loaded;
241         pcc->loaded = temp;
242 }
243
244 /* Helper, returns a magazine to the depot.  Hold the depot lock. */
245 static void __return_to_depot(struct kmem_cache *kc, struct kmem_magazine *mag)
246 {
247         struct kmem_depot *depot = &kc->depot;
248
249         if (mag_is_empty(mag)) {
250                 SLIST_INSERT_HEAD(&depot->empty, mag, link);
251                 depot->nr_empty++;
252         } else {
253                 SLIST_INSERT_HEAD(&depot->not_empty, mag, link);
254                 depot->nr_not_empty++;
255         }
256 }
257
258 /* Helper, removes the contents of the magazine, giving them back to the slab
259  * layer. */
260 static void drain_mag(struct kmem_cache *kc, struct kmem_magazine *mag)
261 {
262         for (int i = 0; i < mag->nr_rounds; i++) {
263                 if (kc->dtor)
264                         kc->dtor(mag->rounds[i], kc->priv);
265                 __kmem_free_to_slab(kc, mag->rounds[i]);
266         }
267         mag->nr_rounds = 0;
268 }
269
270 static struct kmem_pcpu_cache *build_pcpu_caches(void)
271 {
272         struct kmem_pcpu_cache *pcc;
273
274         pcc = base_alloc(NULL,
275                          sizeof(struct kmem_pcpu_cache) * kmc_nr_pcpu_caches(),
276                          MEM_WAIT);
277         for (int i = 0; i < kmc_nr_pcpu_caches(); i++) {
278                 pcc[i].irq_state = 0;
279                 pcc[i].magsize = KMC_MAG_MIN_SZ;
280                 pcc[i].loaded = __kmem_alloc_from_slab(kmem_magazine_cache, MEM_WAIT);
281                 pcc[i].prev = __kmem_alloc_from_slab(kmem_magazine_cache, MEM_WAIT);
282                 pcc[i].nr_allocs_ever = 0;
283         }
284         return pcc;
285 }
286
287 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
288                          size_t obj_size, int align, int flags,
289                          struct arena *source,
290                          int (*ctor)(void *, void *, int),
291                          void (*dtor)(void *, void *), void *priv)
292 {
293         assert(kc);
294         assert(align);
295         spinlock_init_irqsave(&kc->cache_lock);
296         strlcpy(kc->name, name, KMC_NAME_SZ);
297         kc->obj_size = ROUNDUP(obj_size, align);
298         if (flags & KMC_QCACHE)
299                 kc->import_amt = ROUNDUPPWR2(3 * source->qcache_max);
300         else
301                 kc->import_amt = ROUNDUP(NUM_BUF_PER_SLAB * obj_size, PGSIZE);
302         kc->align = align;
303         if (align > PGSIZE)
304                 panic("Cache %s object alignment is actually MIN(PGSIZE, align (%p))",
305                       name, align);
306         kc->flags = flags;
307         /* We might want some sort of per-call site NUMA-awareness in the future. */
308         kc->source = source ? source : kpages_arena;
309         TAILQ_INIT(&kc->full_slab_list);
310         TAILQ_INIT(&kc->partial_slab_list);
311         TAILQ_INIT(&kc->empty_slab_list);
312         kc->ctor = ctor;
313         kc->dtor = dtor;
314         kc->priv = priv;
315         kc->nr_cur_alloc = 0;
316         kc->nr_direct_allocs_ever = 0;
317         kc->alloc_hash = kc->static_hash;
318         hash_init_hh(&kc->hh);
319         for (int i = 0; i < kc->hh.nr_hash_lists; i++)
320                 BSD_LIST_INIT(&kc->static_hash[i]);
321         /* No touch must use bufctls, even for small objects, so that it does not
322          * use the object as memory.  Note that if we have an arbitrary source,
323          * small objects, and we're 'pro-touch', the small allocation path will
324          * assume we're importing from a PGSIZE-aligned source arena. */
325         if ((obj_size > SLAB_LARGE_CUTOFF) || (flags & KMC_NOTOUCH))
326                 kc->flags |= __KMC_USE_BUFCTL;
327         depot_init(&kc->depot);
328         kmem_trace_ht_init(&kc->trace_ht);
329         /* We do this last, since this will all into the magazine cache - which we
330          * could be creating on this call! */
331         kc->pcpu_caches = build_pcpu_caches();
332         add_importing_slab(kc->source, kc);
333         kmc_track(kc);
334 }
335
336 static int __mag_ctor(void *obj, void *priv, int flags)
337 {
338         struct kmem_magazine *mag = (struct kmem_magazine*)obj;
339
340         mag->nr_rounds = 0;
341         return 0;
342 }
343
344 void kmem_cache_init(void)
345 {
346         /* magazine must be first - all caches, including mags, will do a slab alloc
347          * from the mag cache. */
348         static_assert(sizeof(struct kmem_magazine) <= SLAB_LARGE_CUTOFF);
349         __kmem_cache_create(kmem_magazine_cache, "kmem_magazine",
350                             sizeof(struct kmem_magazine),
351                             __alignof__(struct kmem_magazine), KMC_NOTRACE,
352                             base_arena, __mag_ctor, NULL, NULL);
353         __kmem_cache_create(kmem_cache_cache, "kmem_cache",
354                             sizeof(struct kmem_cache),
355                             __alignof__(struct kmem_cache), 0, base_arena,
356                             NULL, NULL, NULL);
357         __kmem_cache_create(kmem_slab_cache, "kmem_slab",
358                             sizeof(struct kmem_slab),
359                             __alignof__(struct kmem_slab), KMC_NOTRACE,
360                             base_arena, NULL, NULL, NULL);
361         __kmem_cache_create(kmem_bufctl_cache, "kmem_bufctl",
362                             sizeof(struct kmem_bufctl),
363                             __alignof__(struct kmem_bufctl), KMC_NOTRACE,
364                             base_arena, NULL, NULL, NULL);
365         __kmem_cache_create(kmem_trace_cache, "kmem_trace",
366                             sizeof(struct kmem_trace),
367                             __alignof__(struct kmem_trace), KMC_NOTRACE,
368                             base_arena, NULL, NULL, NULL);
369 }
370
371 /* Cache management */
372 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
373                                      int align, int flags,
374                                      struct arena *source,
375                                      int (*ctor)(void *, void *, int),
376                                      void (*dtor)(void *, void *),
377                                      void *priv)
378 {
379         struct kmem_cache *kc = kmem_cache_alloc(kmem_cache_cache, 0);
380
381         __kmem_cache_create(kc, name, obj_size, align, flags, source, ctor, dtor,
382                             priv);
383         return kc;
384 }
385
386 /* Helper during destruction.  No one should be touching the allocator anymore.
387  * We just need to hand objects back to the depot, which will hand them to the
388  * slab.  Locking is just a formality here. */
389 static void drain_pcpu_caches(struct kmem_cache *kc)
390 {
391         struct kmem_pcpu_cache *pcc;
392
393         for (int i = 0; i < kmc_nr_pcpu_caches(); i++) {
394                 pcc = &kc->pcpu_caches[i];
395                 lock_pcu_cache(pcc);
396                 lock_depot(&kc->depot);
397                 __return_to_depot(kc, pcc->loaded);
398                 __return_to_depot(kc, pcc->prev);
399                 unlock_depot(&kc->depot);
400                 pcc->loaded = SLAB_POISON;
401                 pcc->prev = SLAB_POISON;
402                 unlock_pcu_cache(pcc);
403         }
404 }
405
406 static void depot_destroy(struct kmem_cache *kc)
407 {
408         struct kmem_magazine *mag_i;
409         struct kmem_depot *depot = &kc->depot;
410
411         lock_depot(depot);
412         while ((mag_i = SLIST_FIRST(&depot->not_empty))) {
413                 drain_mag(kc, mag_i);
414                 kmem_cache_free(kmem_magazine_cache, mag_i);
415         }
416         while ((mag_i = SLIST_FIRST(&depot->empty)))
417                 kmem_cache_free(kmem_magazine_cache, mag_i);
418         unlock_depot(depot);
419 }
420
421 static void kmem_slab_destroy(struct kmem_cache *cp, struct kmem_slab *a_slab)
422 {
423         if (!__use_bufctls(cp)) {
424                 arena_free(cp->source, ROUNDDOWN(a_slab, PGSIZE), PGSIZE);
425         } else {
426                 struct kmem_bufctl *i, *temp;
427                 void *buf_start = (void*)SIZE_MAX;
428
429                 BSD_LIST_FOREACH_SAFE(i, &a_slab->bufctl_freelist, link, temp) {
430                         // Track the lowest buffer address, which is the start of the buffer
431                         buf_start = MIN(buf_start, i->buf_addr);
432                         /* This is a little dangerous, but we can skip removing, since we
433                          * init the freelist when we reuse the slab. */
434                         kmem_cache_free(kmem_bufctl_cache, i);
435                 }
436                 arena_free(cp->source, buf_start, cp->import_amt);
437                 kmem_cache_free(kmem_slab_cache, a_slab);
438         }
439 }
440
441 /* Once you call destroy, never use this cache again... o/w there may be weird
442  * races, and other serious issues.  */
443 void kmem_cache_destroy(struct kmem_cache *cp)
444 {
445         struct kmem_slab *a_slab, *next;
446
447         kmc_untrack(cp);
448         del_importing_slab(cp->source, cp);
449         drain_pcpu_caches(cp);
450         depot_destroy(cp);
451         spin_lock_irqsave(&cp->cache_lock);
452         assert(TAILQ_EMPTY(&cp->full_slab_list));
453         assert(TAILQ_EMPTY(&cp->partial_slab_list));
454         /* Clean out the empty list.  We can't use a regular FOREACH here, since the
455          * link element is stored in the slab struct, which is stored on the page
456          * that we are freeing. */
457         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
458         while (a_slab) {
459                 next = TAILQ_NEXT(a_slab, link);
460                 kmem_slab_destroy(cp, a_slab);
461                 a_slab = next;
462         }
463         spin_unlock_irqsave(&cp->cache_lock);
464         kmem_trace_warn_notempty(cp);
465         kmem_cache_free(kmem_cache_cache, cp);
466 }
467
468 static void __try_hash_resize(struct kmem_cache *cp)
469 {
470         struct kmem_bufctl_list *new_tbl, *old_tbl;
471         struct kmem_bufctl *bc_i;
472         unsigned int new_tbl_nr_lists, old_tbl_nr_lists;
473         size_t new_tbl_sz, old_tbl_sz;
474         size_t hash_idx;
475
476         if (!hash_needs_more(&cp->hh))
477                 return;
478         new_tbl_nr_lists = hash_next_nr_lists(&cp->hh);
479         new_tbl_sz = new_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
480         /* TODO: we only need to pull from base if our arena is a base or we are
481          * inside a kpages arena (keep in mind there could be more than one of
482          * those, depending on how we do NUMA allocs).  This might help with
483          * fragmentation.  To know this, we'll need the caller to pass us a flag. */
484         new_tbl = base_zalloc(NULL, new_tbl_sz, ARENA_INSTANTFIT | MEM_ATOMIC);
485         if (!new_tbl)
486                 return;
487         old_tbl = cp->alloc_hash;
488         old_tbl_nr_lists = cp->hh.nr_hash_lists;
489         old_tbl_sz = old_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
490         cp->alloc_hash = new_tbl;
491         hash_incr_nr_lists(&cp->hh);
492         for (int i = 0; i < old_tbl_nr_lists; i++) {
493                 while ((bc_i = BSD_LIST_FIRST(&old_tbl[i]))) {
494                         BSD_LIST_REMOVE(bc_i, link);
495                         hash_idx = hash_ptr(bc_i->buf_addr, cp->hh.nr_hash_bits);
496                         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc_i, link);
497                 }
498         }
499         hash_reset_load_limit(&cp->hh);
500         if (old_tbl != cp->static_hash)
501                 base_free(NULL, old_tbl, old_tbl_sz);
502 }
503
504 /* Helper, tracks the allocation of @bc in the hash table */
505 static void __track_alloc(struct kmem_cache *cp, struct kmem_bufctl *bc)
506 {
507         size_t hash_idx;
508
509         hash_idx = hash_ptr(bc->buf_addr, cp->hh.nr_hash_bits);
510         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc, link);
511         cp->hh.nr_items++;
512         __try_hash_resize(cp);
513 }
514
515 /* Helper, looks up and removes the bufctl corresponding to buf. */
516 static struct kmem_bufctl *__yank_bufctl(struct kmem_cache *cp, void *buf)
517 {
518         struct kmem_bufctl *bc_i;
519         size_t hash_idx;
520
521         hash_idx = hash_ptr(buf, cp->hh.nr_hash_bits);
522         BSD_LIST_FOREACH(bc_i, &cp->alloc_hash[hash_idx], link) {
523                 if (bc_i->buf_addr == buf) {
524                         BSD_LIST_REMOVE(bc_i, link);
525                         break;
526                 }
527         }
528         if (!bc_i)
529                 panic("Could not find buf %p in cache %s!", buf, cp->name);
530         return bc_i;
531 }
532
533 /* Alloc, bypassing the magazines and depot */
534 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags)
535 {
536         void *retval = NULL;
537         spin_lock_irqsave(&cp->cache_lock);
538         // look at partial list
539         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
540         //      if none, go to empty list and get an empty and make it partial
541         if (!a_slab) {
542                 // TODO: think about non-sleeping flags
543                 if (TAILQ_EMPTY(&cp->empty_slab_list) &&
544                         !kmem_cache_grow(cp)) {
545                         spin_unlock_irqsave(&cp->cache_lock);
546                         if (flags & MEM_ERROR)
547                                 error(ENOMEM, ERROR_FIXME);
548                         else
549                                 panic("[German Accent]: OOM for a small slab growth!!!");
550                 }
551                 // move to partial list
552                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
553                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
554                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
555         }
556         // have a partial now (a_slab), get an item, return item
557         if (!__use_bufctls(cp)) {
558                 retval = a_slab->free_small_obj;
559                 /* the next free_small_obj address is stored at the beginning of the
560                  * current free_small_obj. */
561                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj);
562         } else {
563                 // rip the first bufctl out of the partial slab's buf list
564                 struct kmem_bufctl *a_bufctl = BSD_LIST_FIRST(&a_slab->bufctl_freelist);
565
566                 BSD_LIST_REMOVE(a_bufctl, link);
567                 __track_alloc(cp, a_bufctl);
568                 retval = a_bufctl->buf_addr;
569         }
570         a_slab->num_busy_obj++;
571         // Check if we are full, if so, move to the full list
572         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
573                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
574                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
575         }
576         cp->nr_cur_alloc++;
577         cp->nr_direct_allocs_ever++;
578         spin_unlock_irqsave(&cp->cache_lock);
579         if (cp->ctor) {
580                 if (cp->ctor(retval, cp->priv, flags)) {
581                         warn("Ctor %p failed, probably a bug!");
582                         __kmem_free_to_slab(cp, retval);
583                         return NULL;
584                 }
585         }
586         return retval;
587 }
588
589 void *kmem_cache_alloc(struct kmem_cache *kc, int flags)
590 {
591         struct kmem_pcpu_cache *pcc = get_my_pcpu_cache(kc);
592         struct kmem_depot *depot = &kc->depot;
593         struct kmem_magazine *mag;
594         void *ret;
595
596         lock_pcu_cache(pcc);
597 try_alloc:
598         if (pcc->loaded->nr_rounds) {
599                 ret = pcc->loaded->rounds[pcc->loaded->nr_rounds - 1];
600                 pcc->loaded->nr_rounds--;
601                 pcc->nr_allocs_ever++;
602                 unlock_pcu_cache(pcc);
603                 kmem_trace_alloc(kc, ret);
604                 return ret;
605         }
606         if (!mag_is_empty(pcc->prev)) {
607                 __swap_mags(pcc);
608                 goto try_alloc;
609         }
610         /* Note the lock ordering: pcc -> depot */
611         lock_depot(depot);
612         mag = SLIST_FIRST(&depot->not_empty);
613         if (mag) {
614                 SLIST_REMOVE_HEAD(&depot->not_empty, link);
615                 depot->nr_not_empty--;
616                 __return_to_depot(kc, pcc->prev);
617                 unlock_depot(depot);
618                 pcc->prev = pcc->loaded;
619                 pcc->loaded = mag;
620                 goto try_alloc;
621         }
622         unlock_depot(depot);
623         unlock_pcu_cache(pcc);
624         ret = __kmem_alloc_from_slab(kc, flags);
625         kmem_trace_alloc(kc, ret);
626         return ret;
627 }
628
629 /* Returns an object to the slab layer.  Caller must deconstruct the objects.
630  * Note that objects in the slabs are unconstructed. */
631 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf)
632 {
633         struct kmem_slab *a_slab;
634         struct kmem_bufctl *a_bufctl;
635
636         spin_lock_irqsave(&cp->cache_lock);
637         if (!__use_bufctls(cp)) {
638                 // find its slab
639                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
640                                              PGSIZE - sizeof(struct kmem_slab));
641                 /* write location of next free small obj to the space at the beginning
642                  * of the buffer, then list buf as the next free small obj */
643                 *(uintptr_t**)buf = a_slab->free_small_obj;
644                 a_slab->free_small_obj = buf;
645         } else {
646                 /* Give the bufctl back to the parent slab */
647                 a_bufctl = __yank_bufctl(cp, buf);
648                 a_slab = a_bufctl->my_slab;
649                 BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
650         }
651         a_slab->num_busy_obj--;
652         cp->nr_cur_alloc--;
653         // if it was full, move it to partial
654         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
655                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
656                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
657         } else if (!a_slab->num_busy_obj) {
658                 // if there are none, move to from partial to empty
659                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
660                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
661         }
662         spin_unlock_irqsave(&cp->cache_lock);
663 }
664
665 void kmem_cache_free(struct kmem_cache *kc, void *buf)
666 {
667         struct kmem_pcpu_cache *pcc = get_my_pcpu_cache(kc);
668         struct kmem_depot *depot = &kc->depot;
669         struct kmem_magazine *mag;
670
671         assert(buf);    /* catch bugs */
672         kmem_trace_free(kc, buf);
673         lock_pcu_cache(pcc);
674 try_free:
675         if (pcc->loaded->nr_rounds < pcc->magsize) {
676                 pcc->loaded->rounds[pcc->loaded->nr_rounds] = buf;
677                 pcc->loaded->nr_rounds++;
678                 unlock_pcu_cache(pcc);
679                 return;
680         }
681         /* The paper checks 'is empty' here.  But we actually just care if it has
682          * room left, not that prev is completely empty.  This could be the case due
683          * to magazine resize. */
684         if (pcc->prev->nr_rounds < pcc->magsize) {
685                 __swap_mags(pcc);
686                 goto try_free;
687         }
688         lock_depot(depot);
689         /* Here's where the resize magic happens.  We'll start using it for the next
690          * magazine. */
691         pcc->magsize = depot->magsize;
692         mag = SLIST_FIRST(&depot->empty);
693         if (mag) {
694                 SLIST_REMOVE_HEAD(&depot->empty, link);
695                 depot->nr_empty--;
696                 __return_to_depot(kc, pcc->prev);
697                 unlock_depot(depot);
698                 pcc->prev = pcc->loaded;
699                 pcc->loaded = mag;
700                 goto try_free;
701         }
702         unlock_depot(depot);
703         /* Need to unlock, in case we end up calling back into ourselves. */
704         unlock_pcu_cache(pcc);
705         /* don't want to wait on a free.  if this fails, we can still just give it
706          * to the slab layer. */
707         mag = kmem_cache_alloc(kmem_magazine_cache, MEM_ATOMIC);
708         if (mag) {
709                 assert(mag->nr_rounds == 0);    /* paranoia, can probably remove */
710                 lock_depot(depot);
711                 SLIST_INSERT_HEAD(&depot->empty, mag, link);
712                 depot->nr_empty++;
713                 unlock_depot(depot);
714                 lock_pcu_cache(pcc);
715                 goto try_free;
716         }
717         if (kc->dtor)
718                 kc->dtor(buf, kc->priv);
719         __kmem_free_to_slab(kc, buf);
720 }
721
722 /* Back end: internal functions */
723 /* When this returns, the cache has at least one slab in the empty list.  If
724  * page_alloc fails, there are some serious issues.  This only grows by one slab
725  * at a time.
726  *
727  * Grab the cache lock before calling this.
728  *
729  * TODO: think about page colouring issues with kernel memory allocation. */
730 static bool kmem_cache_grow(struct kmem_cache *cp)
731 {
732         struct kmem_slab *a_slab;
733         struct kmem_bufctl *a_bufctl;
734
735         if (!__use_bufctls(cp)) {
736                 void *a_page;
737
738                 /* Careful, this assumes our source is a PGSIZE-aligned allocator.  We
739                  * could use xalloc to enforce the alignment, but that'll bypass the
740                  * qcaches, which we don't want.  Caller beware. */
741                 a_page = arena_alloc(cp->source, PGSIZE, MEM_ATOMIC);
742                 if (!a_page)
743                         return FALSE;
744                 // the slab struct is stored at the end of the page
745                 a_slab = (struct kmem_slab*)(a_page + PGSIZE
746                                              - sizeof(struct kmem_slab));
747                 a_slab->num_busy_obj = 0;
748                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
749                                         cp->obj_size;
750                 // TODO: consider staggering this IAW section 4.3
751                 a_slab->free_small_obj = a_page;
752                 /* Walk and create the free list, which is circular.  Each item stores
753                  * the location of the next one at the beginning of the block. */
754                 void *buf = a_slab->free_small_obj;
755                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
756                         *(uintptr_t**)buf = buf + cp->obj_size;
757                         buf += cp->obj_size;
758                 }
759                 *((uintptr_t**)buf) = NULL;
760         } else {
761                 void *buf;
762
763                 a_slab = kmem_cache_alloc(kmem_slab_cache, 0);
764                 if (!a_slab)
765                         return FALSE;
766                 buf = arena_alloc(cp->source, cp->import_amt, MEM_ATOMIC);
767                 if (!buf) {
768                         kmem_cache_free(kmem_slab_cache, a_slab);
769                         return FALSE;
770                 }
771                 a_slab->num_busy_obj = 0;
772                 a_slab->num_total_obj = cp->import_amt / cp->obj_size;
773                 BSD_LIST_INIT(&a_slab->bufctl_freelist);
774                 /* for each buffer, set up a bufctl and point to the buffer */
775                 for (int i = 0; i < a_slab->num_total_obj; i++) {
776                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache, 0);
777                         BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
778                         a_bufctl->buf_addr = buf;
779                         a_bufctl->my_slab = a_slab;
780                         buf += cp->obj_size;
781                 }
782         }
783         // add a_slab to the empty_list
784         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
785
786         return TRUE;
787 }
788
789 /* This deallocs every slab from the empty list.  TODO: think a bit more about
790  * this.  We can do things like not free all of the empty lists to prevent
791  * thrashing.  See 3.4 in the paper. */
792 void kmem_cache_reap(struct kmem_cache *cp)
793 {
794         struct kmem_slab *a_slab, *next;
795
796         // Destroy all empty slabs.  Refer to the notes about the while loop
797         spin_lock_irqsave(&cp->cache_lock);
798         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
799         while (a_slab) {
800                 next = TAILQ_NEXT(a_slab, link);
801                 kmem_slab_destroy(cp, a_slab);
802                 a_slab = next;
803         }
804         spin_unlock_irqsave(&cp->cache_lock);
805 }
806
807
808 /* Tracing */
809
810 static void kmem_trace_ht_foreach(struct kmem_trace_ht *ht,
811                                   void (*f)(struct kmem_trace *, void *),
812                                   void *arg)
813 {
814         struct kmem_trace *tr;
815         struct hlist_node *temp;
816
817         spin_lock_irqsave(&ht->lock);
818         for (int i = 0; i < ht->hh.nr_hash_lists; i++)
819                 hlist_for_each_entry_safe(tr, temp, &ht->ht[i], hash)
820                         f(tr, arg);
821         spin_unlock_irqsave(&ht->lock);
822 }
823
824 static void __kmem_trace_print(struct kmem_trace *tr, void *arg)
825 {
826         struct sized_alloc *sza = arg;
827
828         sza_printf(sza, "Obj %p, from %s:\n----\n", tr->obj, tr->str);
829         sza_print_backtrace_list(sza, tr->pcs, tr->nr_pcs);
830         sza_printf(sza, "\n");
831 }
832
833 static void __kmem_trace_bytes_needed(struct kmem_trace *tr, void *arg)
834 {
835         size_t *x = arg;
836
837         /* Just a guess of how much room we'll need, plus fudge. */
838         *x += tr->nr_pcs * 80 + 100;
839 }
840
841 struct sized_alloc *kmem_trace_print(struct kmem_cache *kc)
842 {
843         struct sized_alloc *sza;
844         size_t amt = 100;
845
846         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_bytes_needed, &amt);
847         sza = sized_kzmalloc(amt, MEM_WAIT);
848         sza_printf(sza, "Dumping outstanding allocs from %s\n", kc->name);
849         sza_printf(sza, "-------------------------\n");
850         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_print, sza);
851         return sza;
852 }
853
854 static void __kmem_trace_drop(struct kmem_trace *tr, void *arg)
855 {
856         hlist_del(&tr->hash);
857         kmem_cache_free(kmem_trace_cache, tr);
858 }
859
860 void kmem_trace_reset(struct kmem_cache *kc)
861 {
862         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_drop, NULL);
863 }
864
865 /* It's a bug to ever have a left-over trace when we delete a KMC, and probably
866  * will never happen.  If it does, we can expand the debugging info. */
867 static void __kmem_trace_warn_and_drop(struct kmem_trace *tr, void *arg)
868 {
869         warn("KMC had an object! (%p)", tr->obj);
870         __kmem_trace_drop(tr, NULL);
871 }
872
873 static void kmem_trace_warn_notempty(struct kmem_cache *kc)
874 {
875         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_warn_and_drop, NULL);
876 }
877
878 int kmem_trace_start(struct kmem_cache *kc)
879 {
880         spin_lock_irqsave(&kc->cache_lock);
881         if (kc->flags & KMC_NOTRACE) {
882                 spin_unlock_irqsave(&kc->cache_lock);
883                 return -1;
884         }
885         WRITE_ONCE(kc->flags, kc->flags | __KMC_TRACED | __KMC_EVER_TRACED);
886         spin_unlock_irqsave(&kc->cache_lock);
887         return 0;
888 }
889
890 /* Note that the tracers locklessly-peek at the flags, and we may have an
891  * allocation complete its trace after we stop.  You could conceivably stop,
892  * reset/remove all traces, and then have a trace appear still. */
893 void kmem_trace_stop(struct kmem_cache *kc)
894 {
895         spin_lock_irqsave(&kc->cache_lock);
896         WRITE_ONCE(kc->flags, kc->flags & ~__KMC_TRACED);
897         spin_unlock_irqsave(&kc->cache_lock);
898 }
899
900 static void kmem_trace_ht_init(struct kmem_trace_ht *ht)
901 {
902         spinlock_init(&ht->lock);
903         ht->ht = ht->static_ht;
904         hash_init_hh(&ht->hh);
905         for (int i = 0; i < ht->hh.nr_hash_lists; i++)
906                 INIT_HLIST_HEAD(&ht->ht[i]);
907 }
908
909 static void kmem_trace_ht_insert(struct kmem_trace_ht *ht,
910                                  struct kmem_trace *tr)
911 {
912         unsigned long hash_val = __generic_hash(tr->obj);
913         struct hlist_head *bucket;
914
915         spin_lock_irqsave(&ht->lock);
916         bucket = &ht->ht[hash_val % ht->hh.nr_hash_bits];
917         hlist_add_head(&tr->hash, bucket);
918         spin_unlock_irqsave(&ht->lock);
919 }
920
921 static struct kmem_trace *kmem_trace_ht_remove(struct kmem_trace_ht *ht,
922                                                void *obj)
923 {
924         struct kmem_trace *tr;
925         unsigned long hash_val = __generic_hash(obj);
926         struct hlist_head *bucket;
927
928         spin_lock_irqsave(&ht->lock);
929         bucket = &ht->ht[hash_val % ht->hh.nr_hash_bits];
930         hlist_for_each_entry(tr, bucket, hash) {
931                 if (tr->obj == obj) {
932                         hlist_del(&tr->hash);
933                         break;
934                 }
935         }
936         spin_unlock_irqsave(&ht->lock);
937         return tr;
938 }
939
940 static void kmem_trace_free(struct kmem_cache *kc, void *obj)
941 {
942         struct kmem_trace *tr;
943
944         /* Even if we turn off tracing, we still want to free traces that we may
945          * have collected earlier.  Otherwise, those objects will never get
946          * removed from the trace, and could lead to confusion if they are
947          * reallocated and traced again.  Still, we don't want to pay the cost
948          * on every free for untraced KCs. */
949         if (!(READ_ONCE(kc->flags) & __KMC_EVER_TRACED))
950                 return;
951         tr = kmem_trace_ht_remove(&kc->trace_ht, obj);
952         if (tr)
953                 kmem_cache_free(kmem_trace_cache, tr);
954 }
955
956 static void trace_context(struct kmem_trace *tr)
957 {
958         if (is_ktask(current_kthread)) {
959                 snprintf(tr->str, sizeof(tr->str), "ktask %s",
960                          current_kthread->name);
961         } else if (current) {
962                 /* When we're handling a page fault, knowing the user PC helps
963                  * determine the source.  A backtrace is nice, but harder to do.
964                  * Since we're deep in MM code and holding locks, we can't use
965                  * copy_from_user, which uses the page-fault fixups.  If you
966                  * need to get the BT, stash it in the genbuf in
967                  * handle_page_fault(). */
968                 snprintf(tr->str, sizeof(tr->str), "PID %d %s: %s, %p",
969                          current->pid, current->progname,
970                          current_kthread->name,
971                          current_ctx ? get_user_ctx_pc(current_ctx) : 0);
972         } else {
973                 snprintf(tr->str, sizeof(tr->str), "(none)");
974         }
975         tr->str[sizeof(tr->str) - 1] = 0;
976 }
977
978 static void kmem_trace_alloc(struct kmem_cache *kc, void *obj)
979 {
980         struct kmem_trace *tr;
981
982         if (!(READ_ONCE(kc->flags) & __KMC_TRACED))
983                 return;
984         tr = kmem_cache_alloc(kmem_trace_cache, MEM_ATOMIC);
985         if (!tr)
986                 return;
987         tr->obj = obj;
988         tr->nr_pcs = backtrace_list(get_caller_pc(), get_caller_fp(), tr->pcs,
989                                     ARRAY_SIZE(tr->pcs));
990         trace_context(tr);
991         kmem_trace_ht_insert(&kc->trace_ht, tr);
992 }