slab: don't assume allocations succeed
[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("Creatgin KMC %s, 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
183          * contended acquisitions in Y nsec, then we'll grow the magazines.
184          * This might not be that great of an approach - every thread gets one
185          * count, regardless of how long they take.
186          *
187          * We read the time before locking so that we don't artificially grow
188          * the window too much.  Say the lock is heavily contended and we take a
189          * long time to get it.  Perhaps X threads try to lock it immediately,
190          * but it takes over Y seconds for the Xth thread to actually get the
191          * lock.  We 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
195          * not because the magazines aren't big enough, but because there aren't
196          * enough 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
208                  * their 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,
281                                                        MEM_WAIT);
282                 pcc[i].prev = __kmem_alloc_from_slab(kmem_magazine_cache,
283                                                      MEM_WAIT);
284                 pcc[i].nr_allocs_ever = 0;
285         }
286         return pcc;
287 }
288
289 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
290                          size_t obj_size, int align, int flags,
291                          struct arena *source,
292                          int (*ctor)(void *, void *, int),
293                          void (*dtor)(void *, void *), void *priv)
294 {
295         assert(kc);
296         /* Our alignment is independent of our source's quantum.  We pull from
297          * our source, which gives us quantum-multiple/aligned chunks, but our
298          * alignment and object size is our own business.  Mostly.
299          *
300          * There is one guarantee we must make:
301          * - If aligned-obj_size (ALIGN(obj_size, align)) is a multiple of our
302          *   source's quantum, then all objects we return are
303          *   quantum-multiple-aligned (addresses are multiples of quantum).
304          *
305          * The main restriction for us is that when we get a slab from our
306          * source, we need to hand out objects at the beginning of the slab
307          * (where we are source quantum-aligned).
308          *
309          * As an example, if our source quantum is 15, and we give out 45 byte
310          * objects, we must give out e.g. [15,60), but not [10,55).  This really
311          * only comes up for qcaches for arenas that aren't memory, since all
312          * memory users will be going with power-of-two alignment.  And
313          * typically the slabs will have their own alignment.  e.g.
314          * alignof(struct foo), with a PGSIZE-quantum source.
315          *
316          * Our objects are always aligned to 'align', regardless of our source's
317          * alignment/quantum.  Similarly, if our source's quantum is a multiple
318          * of aligned-obj_size, then all objects we return are
319          * obj_size-multiple-aligned. */
320         assert(IS_PWR2(align));
321         /* Every allocation is aligned, and every allocation is the same
322          * size, so we might as well align-up obj_size. */
323         obj_size = ALIGN(obj_size, align);
324         spinlock_init_irqsave(&kc->cache_lock);
325         strlcpy(kc->name, name, KMC_NAME_SZ);
326         /* We might want some sort of per-call site NUMA-awareness in the
327          * future. */
328         source = source ?: kpages_arena;
329         kc->source = source;
330         kc->obj_size = obj_size;
331         kc->align = align;
332         kc->flags = flags;
333         /* No touch must use bufctls, even for small objects, so that it does
334          * not use the object as memory.  RAM objects need enough space for a
335          * pointer to form the linked list of objects. */
336         if (obj_size < sizeof(void*) || obj_size > SLAB_LARGE_CUTOFF
337             || flags & KMC_NOTOUCH) {
338                 kc->flags |= __KMC_USE_BUFCTL;
339         } else {
340                 /* pro-touch (non-bufctl) slabs must get a page-aligned slab
341                  * from the source.  quantum < PGSIZE won't guarantee that.
342                  * quantum > PGSIZE is a waste and a programmer error. */
343                 if (kc->source->quantum != PGSIZE) {
344                         warn("KC %s is 'pro-touch', but source arena %s has non-PGSIZE quantum %d",
345                              kc->name, source->name, source->quantum);
346                         kc->flags |= __KMC_USE_BUFCTL;
347                 }
348         }
349         /* Note that import_amt is only used for bufctls.  The alternative puts
350          * the slab at the end of a PGSIZE chunk, and fills the page with
351          * objects.  The reliance on PGSIZE is used when finding a slab for a
352          * given buffer.
353          *
354          * Also note that import_amt can be ignored for qcaches too.  If the
355          * object is small and pro-touch, we'll still try and get a page from
356          * the source, even if that is very large.  Consider a source with
357          * qcache_max = 5, quantum = 1.  It's actually fine - we may waste a
358          * little (unused allocations), but we save on not having bufctls. */
359         if (flags & KMC_QCACHE)
360                 kc->import_amt = ROUNDUPPWR2(3 * source->qcache_max);
361         else
362                 kc->import_amt = ROUNDUP(NUM_BUF_PER_SLAB * obj_size,
363                                          ROUNDUP(PGSIZE, source->quantum));
364         TAILQ_INIT(&kc->full_slab_list);
365         TAILQ_INIT(&kc->partial_slab_list);
366         TAILQ_INIT(&kc->empty_slab_list);
367         kc->ctor = ctor;
368         kc->dtor = dtor;
369         kc->priv = priv;
370         kc->nr_cur_alloc = 0;
371         kc->nr_direct_allocs_ever = 0;
372         kc->alloc_hash = kc->static_hash;
373         hash_init_hh(&kc->hh);
374         for (int i = 0; i < kc->hh.nr_hash_lists; i++)
375                 BSD_LIST_INIT(&kc->static_hash[i]);
376         depot_init(&kc->depot);
377         kmem_trace_ht_init(&kc->trace_ht);
378         /* We do this last, since this will all into the magazine cache - which
379          * we could be creating on this call! */
380         kc->pcpu_caches = build_pcpu_caches();
381         add_importing_slab(kc->source, kc);
382         kmc_track(kc);
383 }
384
385 static int __mag_ctor(void *obj, void *priv, int flags)
386 {
387         struct kmem_magazine *mag = (struct kmem_magazine*)obj;
388
389         mag->nr_rounds = 0;
390         return 0;
391 }
392
393 void kmem_cache_init(void)
394 {
395         /* magazine must be first - all caches, including mags, will do a slab
396          * alloc from the mag cache. */
397         static_assert(sizeof(struct kmem_magazine) <= SLAB_LARGE_CUTOFF);
398         __kmem_cache_create(kmem_magazine_cache, "kmem_magazine",
399                             sizeof(struct kmem_magazine),
400                             __alignof__(struct kmem_magazine), KMC_NOTRACE,
401                             base_arena, __mag_ctor, NULL, NULL);
402         __kmem_cache_create(kmem_cache_cache, "kmem_cache",
403                             sizeof(struct kmem_cache),
404                             __alignof__(struct kmem_cache), 0, base_arena,
405                             NULL, NULL, NULL);
406         __kmem_cache_create(kmem_slab_cache, "kmem_slab",
407                             sizeof(struct kmem_slab),
408                             __alignof__(struct kmem_slab), KMC_NOTRACE,
409                             base_arena, NULL, NULL, NULL);
410         __kmem_cache_create(kmem_bufctl_cache, "kmem_bufctl",
411                             sizeof(struct kmem_bufctl),
412                             __alignof__(struct kmem_bufctl), KMC_NOTRACE,
413                             base_arena, NULL, NULL, NULL);
414         __kmem_cache_create(kmem_trace_cache, "kmem_trace",
415                             sizeof(struct kmem_trace),
416                             __alignof__(struct kmem_trace), KMC_NOTRACE,
417                             base_arena, NULL, NULL, NULL);
418 }
419
420 /* Cache management */
421 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
422                                      int align, int flags,
423                                      struct arena *source,
424                                      int (*ctor)(void *, void *, int),
425                                      void (*dtor)(void *, void *),
426                                      void *priv)
427 {
428         struct kmem_cache *kc = kmem_cache_alloc(kmem_cache_cache, MEM_WAIT);
429
430         __kmem_cache_create(kc, name, obj_size, align, flags, source, ctor,
431                             dtor, priv);
432         return kc;
433 }
434
435 /* Helper during destruction.  No one should be touching the allocator anymore.
436  * We just need to hand objects back to the depot, which will hand them to the
437  * slab.  Locking is just a formality here. */
438 static void drain_pcpu_caches(struct kmem_cache *kc)
439 {
440         struct kmem_pcpu_cache *pcc;
441
442         for (int i = 0; i < kmc_nr_pcpu_caches(); i++) {
443                 pcc = &kc->pcpu_caches[i];
444                 lock_pcu_cache(pcc);
445                 lock_depot(&kc->depot);
446                 __return_to_depot(kc, pcc->loaded);
447                 __return_to_depot(kc, pcc->prev);
448                 unlock_depot(&kc->depot);
449                 pcc->loaded = SLAB_POISON;
450                 pcc->prev = SLAB_POISON;
451                 unlock_pcu_cache(pcc);
452         }
453 }
454
455 static void depot_destroy(struct kmem_cache *kc)
456 {
457         struct kmem_magazine *mag_i;
458         struct kmem_depot *depot = &kc->depot;
459
460         lock_depot(depot);
461         while ((mag_i = SLIST_FIRST(&depot->not_empty))) {
462                 SLIST_REMOVE_HEAD(&depot->not_empty, link);
463                 drain_mag(kc, mag_i);
464                 kmem_cache_free(kmem_magazine_cache, mag_i);
465         }
466         while ((mag_i = SLIST_FIRST(&depot->empty))) {
467                 SLIST_REMOVE_HEAD(&depot->empty, link);
468                 assert(mag_i->nr_rounds == 0);
469                 kmem_cache_free(kmem_magazine_cache, mag_i);
470         }
471         unlock_depot(depot);
472 }
473
474 static void kmem_slab_destroy(struct kmem_cache *cp, struct kmem_slab *a_slab)
475 {
476         if (!__use_bufctls(cp)) {
477                 arena_free(cp->source, a_slab->source_obj, PGSIZE);
478         } else {
479                 struct kmem_bufctl *i, *temp;
480
481                 BSD_LIST_FOREACH_SAFE(i, &a_slab->bufctl_freelist, link, temp) {
482                         /* This is a little dangerous, but we can skip removing,
483                          * since we init the freelist when we reuse the slab. */
484                         kmem_cache_free(kmem_bufctl_cache, i);
485                 }
486                 arena_free(cp->source, a_slab->source_obj, cp->import_amt);
487                 kmem_cache_free(kmem_slab_cache, a_slab);
488         }
489 }
490
491 /* Once you call destroy, never use this cache again... o/w there may be weird
492  * races, and other serious issues.  */
493 void kmem_cache_destroy(struct kmem_cache *cp)
494 {
495         struct kmem_slab *a_slab, *next;
496
497         kmc_untrack(cp);
498         del_importing_slab(cp->source, cp);
499         drain_pcpu_caches(cp);
500         depot_destroy(cp);
501         spin_lock_irqsave(&cp->cache_lock);
502         /* This is a little debatable.  We leak the cache and whatnot, but even
503          * worse, someone has the object still, and they might free it, after
504          * we've already torn down the depot.  At best this is a marginal way to
505          * continue.  See similar code in arena.c. */
506         if (!TAILQ_EMPTY(&cp->full_slab_list) ||
507             !TAILQ_EMPTY(&cp->partial_slab_list)) {
508                 warn("KMC %s has unfreed items!  Will not destroy.", cp->name);
509                 spin_unlock_irqsave(&cp->cache_lock);
510                 return;
511         }
512         /* Clean out the empty list.  We can't use a regular FOREACH here, since
513          * the link element is stored in the slab struct, which is stored on the
514          * page that we are freeing. */
515         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
516         while (a_slab) {
517                 next = TAILQ_NEXT(a_slab, link);
518                 kmem_slab_destroy(cp, a_slab);
519                 a_slab = next;
520         }
521         spin_unlock_irqsave(&cp->cache_lock);
522         kmem_trace_warn_notempty(cp);
523         kmem_cache_free(kmem_cache_cache, cp);
524 }
525
526 static void __try_hash_resize(struct kmem_cache *cp)
527 {
528         struct kmem_bufctl_list *new_tbl, *old_tbl;
529         struct kmem_bufctl *bc_i;
530         unsigned int new_tbl_nr_lists, old_tbl_nr_lists;
531         size_t new_tbl_sz, old_tbl_sz;
532         size_t hash_idx;
533
534         if (!hash_needs_more(&cp->hh))
535                 return;
536         new_tbl_nr_lists = hash_next_nr_lists(&cp->hh);
537         new_tbl_sz = new_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
538         /* TODO: we only need to pull from base if our arena is a base or we are
539          * inside a kpages arena (keep in mind there could be more than one of
540          * those, depending on how we do NUMA allocs).  This might help with
541          * fragmentation.  To know this, we'll need the caller to pass us a
542          * flag. */
543         new_tbl = base_zalloc(NULL, new_tbl_sz, ARENA_INSTANTFIT | MEM_ATOMIC);
544         if (!new_tbl)
545                 return;
546         old_tbl = cp->alloc_hash;
547         old_tbl_nr_lists = cp->hh.nr_hash_lists;
548         old_tbl_sz = old_tbl_nr_lists * sizeof(struct kmem_bufctl_list);
549         cp->alloc_hash = new_tbl;
550         hash_incr_nr_lists(&cp->hh);
551         for (int i = 0; i < old_tbl_nr_lists; i++) {
552                 while ((bc_i = BSD_LIST_FIRST(&old_tbl[i]))) {
553                         BSD_LIST_REMOVE(bc_i, link);
554                         hash_idx = hash_ptr(bc_i->buf_addr,
555                                             cp->hh.nr_hash_bits);
556                         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc_i,
557                                              link);
558                 }
559         }
560         hash_reset_load_limit(&cp->hh);
561         if (old_tbl != cp->static_hash)
562                 base_free(NULL, old_tbl, old_tbl_sz);
563 }
564
565 /* Helper, tracks the allocation of @bc in the hash table */
566 static void __track_alloc(struct kmem_cache *cp, struct kmem_bufctl *bc)
567 {
568         size_t hash_idx;
569
570         hash_idx = hash_ptr(bc->buf_addr, cp->hh.nr_hash_bits);
571         BSD_LIST_INSERT_HEAD(&cp->alloc_hash[hash_idx], bc, link);
572         cp->hh.nr_items++;
573         __try_hash_resize(cp);
574 }
575
576 /* Helper, looks up and removes the bufctl corresponding to buf. */
577 static struct kmem_bufctl *__yank_bufctl(struct kmem_cache *cp, void *buf)
578 {
579         struct kmem_bufctl *bc_i;
580         size_t hash_idx;
581
582         hash_idx = hash_ptr(buf, cp->hh.nr_hash_bits);
583         BSD_LIST_FOREACH(bc_i, &cp->alloc_hash[hash_idx], link) {
584                 if (bc_i->buf_addr == buf) {
585                         BSD_LIST_REMOVE(bc_i, link);
586                         break;
587                 }
588         }
589         if (!bc_i)
590                 panic("Could not find buf %p in cache %s!", buf, cp->name);
591         return bc_i;
592 }
593
594 /* Alloc, bypassing the magazines and depot */
595 static void *__kmem_alloc_from_slab(struct kmem_cache *cp, int flags)
596 {
597         void *retval = NULL;
598
599         spin_lock_irqsave(&cp->cache_lock);
600         // look at partial list
601         struct kmem_slab *a_slab = TAILQ_FIRST(&cp->partial_slab_list);
602         //  if none, go to empty list and get an empty and make it partial
603         if (!a_slab) {
604                 // TODO: think about non-sleeping flags
605                 if (TAILQ_EMPTY(&cp->empty_slab_list) &&
606                         !kmem_cache_grow(cp)) {
607                         spin_unlock_irqsave(&cp->cache_lock);
608                         if (flags & MEM_ERROR)
609                                 error(ENOMEM, ERROR_FIXME);
610                         else
611                                 panic("[German Accent]: OOM for a small slab growth!!!");
612                 }
613                 // move to partial list
614                 a_slab = TAILQ_FIRST(&cp->empty_slab_list);
615                 TAILQ_REMOVE(&cp->empty_slab_list, a_slab, link);
616                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
617         }
618         // have a partial now (a_slab), get an item, return item
619         if (!__use_bufctls(cp)) {
620                 retval = a_slab->free_small_obj;
621                 /* the next free_small_obj address is stored at the beginning of
622                  * the current free_small_obj. */
623                 a_slab->free_small_obj = *(uintptr_t**)(a_slab->free_small_obj);
624         } else {
625                 // rip the first bufctl out of the partial slab's buf list
626                 struct kmem_bufctl *a_bufctl =
627                         BSD_LIST_FIRST(&a_slab->bufctl_freelist);
628
629                 BSD_LIST_REMOVE(a_bufctl, link);
630                 __track_alloc(cp, a_bufctl);
631                 retval = a_bufctl->buf_addr;
632         }
633         a_slab->num_busy_obj++;
634         // Check if we are full, if so, move to the full list
635         if (a_slab->num_busy_obj == a_slab->num_total_obj) {
636                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
637                 TAILQ_INSERT_HEAD(&cp->full_slab_list, a_slab, link);
638         }
639         cp->nr_cur_alloc++;
640         cp->nr_direct_allocs_ever++;
641         spin_unlock_irqsave(&cp->cache_lock);
642         if (cp->ctor) {
643                 if (cp->ctor(retval, cp->priv, flags)) {
644                         warn("Ctor %p failed, probably a bug!");
645                         __kmem_free_to_slab(cp, retval);
646                         return NULL;
647                 }
648         }
649         return retval;
650 }
651
652 void *kmem_cache_alloc(struct kmem_cache *kc, int flags)
653 {
654         struct kmem_pcpu_cache *pcc = get_my_pcpu_cache(kc);
655         struct kmem_depot *depot = &kc->depot;
656         struct kmem_magazine *mag;
657         void *ret;
658
659         lock_pcu_cache(pcc);
660 try_alloc:
661         if (pcc->loaded->nr_rounds) {
662                 ret = pcc->loaded->rounds[pcc->loaded->nr_rounds - 1];
663                 pcc->loaded->nr_rounds--;
664                 pcc->nr_allocs_ever++;
665                 unlock_pcu_cache(pcc);
666                 kmem_trace_alloc(kc, ret);
667                 return ret;
668         }
669         if (!mag_is_empty(pcc->prev)) {
670                 __swap_mags(pcc);
671                 goto try_alloc;
672         }
673         /* Note the lock ordering: pcc -> depot */
674         lock_depot(depot);
675         mag = SLIST_FIRST(&depot->not_empty);
676         if (mag) {
677                 SLIST_REMOVE_HEAD(&depot->not_empty, link);
678                 depot->nr_not_empty--;
679                 __return_to_depot(kc, pcc->prev);
680                 unlock_depot(depot);
681                 pcc->prev = pcc->loaded;
682                 pcc->loaded = mag;
683                 goto try_alloc;
684         }
685         unlock_depot(depot);
686         unlock_pcu_cache(pcc);
687         ret = __kmem_alloc_from_slab(kc, flags);
688         kmem_trace_alloc(kc, ret);
689         return ret;
690 }
691
692 void *kmem_cache_zalloc(struct kmem_cache *kc, int flags)
693 {
694         void *obj = kmem_cache_alloc(kc, flags);
695
696         if (!obj)
697                 return NULL;
698         memset(obj, 0, kc->obj_size);
699         return obj;
700 }
701
702 /* Returns an object to the slab layer.  Caller must deconstruct the objects.
703  * Note that objects in the slabs are unconstructed. */
704 static void __kmem_free_to_slab(struct kmem_cache *cp, void *buf)
705 {
706         struct kmem_slab *a_slab;
707         struct kmem_bufctl *a_bufctl;
708
709         spin_lock_irqsave(&cp->cache_lock);
710         if (!__use_bufctls(cp)) {
711                 // find its slab
712                 a_slab = (struct kmem_slab*)(ROUNDDOWN((uintptr_t)buf, PGSIZE) +
713                                              PGSIZE - sizeof(struct kmem_slab));
714                 /* write location of next free small obj to the space at the
715                  * beginning of the buffer, then list buf as the next free small
716                  * obj */
717                 *(uintptr_t**)buf = a_slab->free_small_obj;
718                 a_slab->free_small_obj = buf;
719         } else {
720                 /* Give the bufctl back to the parent slab */
721                 a_bufctl = __yank_bufctl(cp, buf);
722                 a_slab = a_bufctl->my_slab;
723                 BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl, link);
724         }
725         a_slab->num_busy_obj--;
726         cp->nr_cur_alloc--;
727         // if it was full, move it to partial
728         if (a_slab->num_busy_obj + 1 == a_slab->num_total_obj) {
729                 TAILQ_REMOVE(&cp->full_slab_list, a_slab, link);
730                 TAILQ_INSERT_HEAD(&cp->partial_slab_list, a_slab, link);
731         } else if (!a_slab->num_busy_obj) {
732                 // if there are none, move to from partial to empty
733                 TAILQ_REMOVE(&cp->partial_slab_list, a_slab, link);
734                 TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
735         }
736         spin_unlock_irqsave(&cp->cache_lock);
737 }
738
739 void kmem_cache_free(struct kmem_cache *kc, void *buf)
740 {
741         struct kmem_pcpu_cache *pcc = get_my_pcpu_cache(kc);
742         struct kmem_depot *depot = &kc->depot;
743         struct kmem_magazine *mag;
744
745         assert(buf);    /* catch bugs */
746         kmem_trace_free(kc, buf);
747         lock_pcu_cache(pcc);
748 try_free:
749         if (pcc->loaded->nr_rounds < pcc->magsize) {
750                 pcc->loaded->rounds[pcc->loaded->nr_rounds] = buf;
751                 pcc->loaded->nr_rounds++;
752                 unlock_pcu_cache(pcc);
753                 return;
754         }
755         /* The paper checks 'is empty' here.  But we actually just care if it
756          * has room left, not that prev is completely empty.  This could be the
757          * case due to magazine resize. */
758         if (pcc->prev->nr_rounds < pcc->magsize) {
759                 __swap_mags(pcc);
760                 goto try_free;
761         }
762         lock_depot(depot);
763         /* Here's where the resize magic happens.  We'll start using it for the
764          * next magazine. */
765         pcc->magsize = depot->magsize;
766         mag = SLIST_FIRST(&depot->empty);
767         if (mag) {
768                 SLIST_REMOVE_HEAD(&depot->empty, link);
769                 depot->nr_empty--;
770                 __return_to_depot(kc, pcc->prev);
771                 unlock_depot(depot);
772                 pcc->prev = pcc->loaded;
773                 pcc->loaded = mag;
774                 goto try_free;
775         }
776         unlock_depot(depot);
777         /* Need to unlock, in case we end up calling back into ourselves. */
778         unlock_pcu_cache(pcc);
779         /* don't want to wait on a free.  if this fails, we can still just give
780          * it to the slab layer. */
781         mag = kmem_cache_alloc(kmem_magazine_cache, MEM_ATOMIC);
782         if (mag) {
783                 assert(mag->nr_rounds == 0);
784                 lock_depot(depot);
785                 SLIST_INSERT_HEAD(&depot->empty, mag, link);
786                 depot->nr_empty++;
787                 unlock_depot(depot);
788                 lock_pcu_cache(pcc);
789                 goto try_free;
790         }
791         if (kc->dtor)
792                 kc->dtor(buf, kc->priv);
793         __kmem_free_to_slab(kc, buf);
794 }
795
796 /* Back end: internal functions */
797 /* When this returns, the cache has at least one slab in the empty list.  If
798  * page_alloc fails, there are some serious issues.  This only grows by one slab
799  * at a time.
800  *
801  * Grab the cache lock before calling this.
802  *
803  * TODO: think about page colouring issues with kernel memory allocation. */
804 static bool kmem_cache_grow(struct kmem_cache *cp)
805 {
806         struct kmem_slab *a_slab;
807         struct kmem_bufctl *a_bufctl;
808
809         if (!__use_bufctls(cp)) {
810                 void *a_page;
811
812                 a_page = arena_alloc(cp->source, PGSIZE, MEM_ATOMIC);
813                 if (!a_page)
814                         return FALSE;
815                 /* The slab struct is stored at the end of the page.  Keep it
816                  * there, so that our first object is page aligned, and thus
817                  * aligned to all smaller alignments.  If align > PGSIZE,
818                  * obj_size > PGSIZE, and we'd use bufctls. */
819                 a_slab = (struct kmem_slab*)(a_page + PGSIZE
820                                              - sizeof(struct kmem_slab));
821                 a_slab->source_obj = a_page;
822                 a_slab->num_busy_obj = 0;
823                 a_slab->num_total_obj = (PGSIZE - sizeof(struct kmem_slab)) /
824                                         cp->obj_size;
825                 a_slab->free_small_obj = a_page;
826                 /* Walk and create the free list, which is circular.  Each item
827                  * stores the location of the next one at the beginning of the
828                  * block. */
829                 void *buf = a_slab->free_small_obj;
830
831                 for (int i = 0; i < a_slab->num_total_obj - 1; i++) {
832                         *(uintptr_t**)buf = buf + cp->obj_size;
833                         buf += cp->obj_size;
834                 }
835                 *((uintptr_t**)buf) = NULL;
836         } else {
837                 void *buf;
838                 uintptr_t delta;
839
840                 a_slab = kmem_cache_alloc(kmem_slab_cache, MEM_ATOMIC);
841                 if (!a_slab)
842                         return FALSE;
843                 buf = arena_alloc(cp->source, cp->import_amt, MEM_ATOMIC);
844                 if (!buf)
845                         goto err_slab;
846                 a_slab->source_obj = buf;
847                 buf = ALIGN(buf, cp->align);
848                 delta = buf - a_slab->source_obj;
849                 if (delta >= cp->import_amt) {
850                         /* Shouldn't happen - the import_amt should always be
851                          * enough for at least two objects, with obj_size >=
852                          * align.  Maybe if a qcache had an alignment (which
853                          * they don't). */
854                         warn("Delta %p >= import_amt %p! (buf %p align %p)",
855                              delta, cp->import_amt, a_slab->source_obj,
856                              cp->align);
857                         goto err_source_obj;
858                 }
859                 a_slab->num_busy_obj = 0;
860                 a_slab->num_total_obj = (cp->import_amt - delta) / cp->obj_size;
861                 BSD_LIST_INIT(&a_slab->bufctl_freelist);
862                 /* for each buffer, set up a bufctl and point to the buffer */
863                 for (int i = 0; i < a_slab->num_total_obj; i++) {
864                         a_bufctl = kmem_cache_alloc(kmem_bufctl_cache,
865                                                     MEM_ATOMIC);
866                         if (!a_bufctl) {
867                                 struct kmem_bufctl *i, *temp;
868
869                                 BSD_LIST_FOREACH_SAFE(i,
870                                                       &a_slab->bufctl_freelist,
871                                                       link, temp) {
872                                         kmem_cache_free(kmem_bufctl_cache, i);
873                                 }
874                                 goto err_source_obj;
875                         }
876                         BSD_LIST_INSERT_HEAD(&a_slab->bufctl_freelist, a_bufctl,
877                                              link);
878                         a_bufctl->buf_addr = buf;
879                         a_bufctl->my_slab = a_slab;
880                         buf += cp->obj_size;
881                 }
882         }
883         // add a_slab to the empty_list
884         TAILQ_INSERT_HEAD(&cp->empty_slab_list, a_slab, link);
885
886         return TRUE;
887
888 err_source_obj:
889         arena_free(cp->source, a_slab->source_obj, cp->import_amt);
890 err_slab:
891         kmem_cache_free(kmem_slab_cache, a_slab);
892         return FALSE;
893 }
894
895 /* This deallocs every slab from the empty list.  TODO: think a bit more about
896  * this.  We can do things like not free all of the empty lists to prevent
897  * thrashing.  See 3.4 in the paper. */
898 void kmem_cache_reap(struct kmem_cache *cp)
899 {
900         struct kmem_slab *a_slab, *next;
901
902         // Destroy all empty slabs.  Refer to the notes about the while loop
903         spin_lock_irqsave(&cp->cache_lock);
904         a_slab = TAILQ_FIRST(&cp->empty_slab_list);
905         while (a_slab) {
906                 next = TAILQ_NEXT(a_slab, link);
907                 kmem_slab_destroy(cp, a_slab);
908                 a_slab = next;
909         }
910         spin_unlock_irqsave(&cp->cache_lock);
911 }
912
913
914 /* Tracing */
915
916 static void kmem_trace_ht_foreach(struct kmem_trace_ht *ht,
917                                   void (*f)(struct kmem_trace *, void *),
918                                   void *arg)
919 {
920         struct kmem_trace *tr;
921         struct hlist_node *temp;
922
923         spin_lock_irqsave(&ht->lock);
924         for (int i = 0; i < ht->hh.nr_hash_lists; i++)
925                 hlist_for_each_entry_safe(tr, temp, &ht->ht[i], hash)
926                         f(tr, arg);
927         spin_unlock_irqsave(&ht->lock);
928 }
929
930 static void __kmem_trace_print(struct kmem_trace *tr, void *arg)
931 {
932         struct sized_alloc *sza = arg;
933
934         sza_printf(sza, "Obj %p, from %s:\n----\n", tr->obj, tr->str);
935         sza_print_backtrace_list(sza, tr->pcs, tr->nr_pcs);
936         sza_printf(sza, "\n");
937 }
938
939 static void __kmem_trace_bytes_needed(struct kmem_trace *tr, void *arg)
940 {
941         size_t *x = arg;
942
943         /* Just a guess of how much room we'll need, plus fudge. */
944         *x += tr->nr_pcs * 80 + 100;
945 }
946
947 struct sized_alloc *kmem_trace_print(struct kmem_cache *kc)
948 {
949         struct sized_alloc *sza;
950         size_t amt = 100;
951
952         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_bytes_needed, &amt);
953         sza = sized_kzmalloc(amt, MEM_WAIT);
954         sza_printf(sza, "Dumping outstanding allocs from %s\n", kc->name);
955         sza_printf(sza, "-------------------------\n");
956         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_print, sza);
957         return sza;
958 }
959
960 static void __kmem_trace_drop(struct kmem_trace *tr, void *arg)
961 {
962         hlist_del(&tr->hash);
963         kmem_cache_free(kmem_trace_cache, tr);
964 }
965
966 void kmem_trace_reset(struct kmem_cache *kc)
967 {
968         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_drop, NULL);
969 }
970
971 /* It's a bug to ever have a left-over trace when we delete a KMC, and probably
972  * will never happen.  If it does, we can expand the debugging info. */
973 static void __kmem_trace_warn_and_drop(struct kmem_trace *tr, void *arg)
974 {
975         warn("KMC had an object! (%p)", tr->obj);
976         __kmem_trace_drop(tr, NULL);
977 }
978
979 static void kmem_trace_warn_notempty(struct kmem_cache *kc)
980 {
981         kmem_trace_ht_foreach(&kc->trace_ht, __kmem_trace_warn_and_drop, NULL);
982 }
983
984 int kmem_trace_start(struct kmem_cache *kc)
985 {
986         spin_lock_irqsave(&kc->cache_lock);
987         if (kc->flags & KMC_NOTRACE) {
988                 spin_unlock_irqsave(&kc->cache_lock);
989                 return -1;
990         }
991         WRITE_ONCE(kc->flags, kc->flags | __KMC_TRACED | __KMC_EVER_TRACED);
992         spin_unlock_irqsave(&kc->cache_lock);
993         return 0;
994 }
995
996 /* Note that the tracers locklessly-peek at the flags, and we may have an
997  * allocation complete its trace after we stop.  You could conceivably stop,
998  * reset/remove all traces, and then have a trace appear still. */
999 void kmem_trace_stop(struct kmem_cache *kc)
1000 {
1001         spin_lock_irqsave(&kc->cache_lock);
1002         WRITE_ONCE(kc->flags, kc->flags & ~__KMC_TRACED);
1003         spin_unlock_irqsave(&kc->cache_lock);
1004 }
1005
1006 static void kmem_trace_ht_init(struct kmem_trace_ht *ht)
1007 {
1008         spinlock_init(&ht->lock);
1009         ht->ht = ht->static_ht;
1010         hash_init_hh(&ht->hh);
1011         for (int i = 0; i < ht->hh.nr_hash_lists; i++)
1012                 INIT_HLIST_HEAD(&ht->ht[i]);
1013 }
1014
1015 static void kmem_trace_ht_insert(struct kmem_trace_ht *ht,
1016                                  struct kmem_trace *tr)
1017 {
1018         unsigned long hash_val = __generic_hash(tr->obj);
1019         struct hlist_head *bucket;
1020
1021         spin_lock_irqsave(&ht->lock);
1022         bucket = &ht->ht[hash_val % ht->hh.nr_hash_bits];
1023         hlist_add_head(&tr->hash, bucket);
1024         spin_unlock_irqsave(&ht->lock);
1025 }
1026
1027 static struct kmem_trace *kmem_trace_ht_remove(struct kmem_trace_ht *ht,
1028                                                void *obj)
1029 {
1030         struct kmem_trace *tr;
1031         unsigned long hash_val = __generic_hash(obj);
1032         struct hlist_head *bucket;
1033
1034         spin_lock_irqsave(&ht->lock);
1035         bucket = &ht->ht[hash_val % ht->hh.nr_hash_bits];
1036         hlist_for_each_entry(tr, bucket, hash) {
1037                 if (tr->obj == obj) {
1038                         hlist_del(&tr->hash);
1039                         break;
1040                 }
1041         }
1042         spin_unlock_irqsave(&ht->lock);
1043         return tr;
1044 }
1045
1046 static void kmem_trace_free(struct kmem_cache *kc, void *obj)
1047 {
1048         struct kmem_trace *tr;
1049
1050         /* Even if we turn off tracing, we still want to free traces that we may
1051          * have collected earlier.  Otherwise, those objects will never get
1052          * removed from the trace, and could lead to confusion if they are
1053          * reallocated and traced again.  Still, we don't want to pay the cost
1054          * on every free for untraced KCs. */
1055         if (!(READ_ONCE(kc->flags) & __KMC_EVER_TRACED))
1056                 return;
1057         tr = kmem_trace_ht_remove(&kc->trace_ht, obj);
1058         if (tr)
1059                 kmem_cache_free(kmem_trace_cache, tr);
1060 }
1061
1062 static void trace_context(struct kmem_trace *tr)
1063 {
1064         if (is_ktask(current_kthread)) {
1065                 snprintf(tr->str, sizeof(tr->str), "ktask %s",
1066                          current_kthread->name);
1067         } else if (current) {
1068                 /* When we're handling a page fault, knowing the user PC helps
1069                  * determine the source.  A backtrace is nice, but harder to do.
1070                  * Since we're deep in MM code and holding locks, we can't use
1071                  * copy_from_user, which uses the page-fault fixups.  If you
1072                  * need to get the BT, stash it in the genbuf in
1073                  * handle_page_fault(). */
1074                 snprintf(tr->str, sizeof(tr->str), "PID %d %s: %s, %p",
1075                          current->pid, current->progname,
1076                          current_kthread->name,
1077                          current_ctx ? get_user_ctx_pc(current_ctx) : 0);
1078         } else {
1079                 snprintf(tr->str, sizeof(tr->str), "(none)");
1080         }
1081         tr->str[sizeof(tr->str) - 1] = 0;
1082 }
1083
1084 static void kmem_trace_alloc(struct kmem_cache *kc, void *obj)
1085 {
1086         struct kmem_trace *tr;
1087
1088         if (!(READ_ONCE(kc->flags) & __KMC_TRACED))
1089                 return;
1090         tr = kmem_cache_alloc(kmem_trace_cache, MEM_ATOMIC);
1091         if (!tr)
1092                 return;
1093         tr->obj = obj;
1094         tr->nr_pcs = backtrace_list(get_caller_pc(), get_caller_fp(), tr->pcs,
1095                                     ARRAY_SIZE(tr->pcs));
1096         trace_context(tr);
1097         kmem_trace_ht_insert(&kc->trace_ht, tr);
1098 }