ktest: Add minor fixes for kernel tests
[akaros.git] / kern / include / slab.h
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * Kevin Klues <klueska@cs.berkeley.edu>
5  * See LICENSE for details.
6  *
7  * Slab allocator, based on the SunOS 5.4 allocator paper.
8  *
9  * There is a list of kmem_cache, which are the caches of objects of a given
10  * size.  This list is sorted in order of size.  Each kmem_cache has three
11  * lists of slabs: full, partial, and empty.
12  *
13  * For large objects, the kmem_slabs point to bufctls, which have the address
14  * of their large buffers.  These slabs can consist of more than one contiguous
15  * page.
16  *
17  * For small objects, the slabs do not use the bufctls.  Instead, they point to
18  * the next free object in the slab.  The free objects themselves hold the
19  * address of the next free item.  The slab structure is stored at the end of
20  * the page.  There is only one page per slab.
21  *
22  * Be careful with source arenas and NOTOUCH.  If a cache's source arena is not
23  * page-aligned memory, you need to set NOTOUCH.  Otherwise, for small objects,
24  * a slab will be constructed that uses the source for a page of objects.
25  */
26
27 #pragma once
28
29 #include <ros/common.h>
30 #include <arch/mmu.h>
31 #include <sys/queue.h>
32 #include <atomic.h>
33 #include <hash_helper.h>
34 #include <arena.h>
35
36 /* Back in the day, their cutoff for "large objects" was 512B, based on
37  * measurements and on not wanting more than 1/8 of internal fragmentation. */
38 #define NUM_BUF_PER_SLAB 8
39 #define SLAB_LARGE_CUTOFF (PGSIZE / NUM_BUF_PER_SLAB)
40
41 #define KMC_NAME_SZ                             32
42 #define KMC_MAG_MIN_SZ                  8
43 #define KMC_MAG_MAX_SZ                  62              /* chosen for mag size and caching */
44
45 /* Cache creation flags: */
46 #define KMC_NOTOUCH                             0x0001  /* Can't use source/object's memory */
47 #define KMC_QCACHE                              0x0002  /* Cache is an arena's qcache */
48 #define __KMC_USE_BUFCTL                0x1000  /* Internal use */
49
50 struct kmem_magazine {
51         SLIST_ENTRY(kmem_magazine)      link;
52         unsigned int                            nr_rounds;
53         void                                            *rounds[KMC_MAG_MAX_SZ];
54 } __attribute__((aligned(ARCH_CL_SIZE)));
55 SLIST_HEAD(kmem_mag_slist, kmem_magazine);
56
57 struct kmem_pcpu_cache {
58         int8_t                                          irq_state;
59         unsigned int                            magsize;
60         struct kmem_magazine            *loaded;
61         struct kmem_magazine            *prev;
62         size_t                                          nr_allocs_ever;
63 } __attribute__((aligned(ARCH_CL_SIZE)));
64
65 struct kmem_depot {
66         spinlock_t                                      lock;
67         struct kmem_mag_slist           not_empty;
68         struct kmem_mag_slist           empty;
69         unsigned int                            magsize;
70         unsigned int                            nr_empty;
71         unsigned int                            nr_not_empty;
72         unsigned int                            busy_count;
73         uint64_t                                        busy_start;
74 };
75
76 struct kmem_slab;
77
78 /* Control block for buffers for large-object slabs */
79 struct kmem_bufctl {
80         BSD_LIST_ENTRY(kmem_bufctl) link;
81         void *buf_addr;
82         struct kmem_slab *my_slab;
83 };
84 BSD_LIST_HEAD(kmem_bufctl_list, kmem_bufctl);
85
86 /* Slabs contain the objects.  Can be either full, partial, or empty,
87  * determined by checking the number of objects busy vs total.  For large
88  * slabs, the bufctl list is used to find a free buffer.  For small, the void*
89  * is used instead.*/
90 struct kmem_slab {
91         TAILQ_ENTRY(kmem_slab) link;
92         size_t num_busy_obj;
93         size_t num_total_obj;
94         union {
95                 struct kmem_bufctl_list bufctl_freelist;
96                 void *free_small_obj;
97         };
98 };
99 TAILQ_HEAD(kmem_slab_list, kmem_slab);
100
101 /* Actual cache */
102 struct kmem_cache {
103         TAILQ_ENTRY(kmem_cache) all_kmc_link;
104         struct kmem_pcpu_cache *pcpu_caches;
105         struct kmem_depot depot;
106         spinlock_t cache_lock;
107         size_t obj_size;
108         size_t import_amt;
109         int align;
110         int flags;
111         struct arena *source;
112         struct kmem_slab_list full_slab_list;
113         struct kmem_slab_list partial_slab_list;
114         struct kmem_slab_list empty_slab_list;
115         int (*ctor)(void *obj, void *priv, int flags);
116         void (*dtor)(void *obj, void *priv);
117         void *priv;
118         unsigned long nr_cur_alloc;
119         unsigned long nr_direct_allocs_ever;
120         struct hash_helper hh;
121         struct kmem_bufctl_list *alloc_hash;
122         struct kmem_bufctl_list static_hash[HASH_INIT_SZ];
123         char name[KMC_NAME_SZ];
124         TAILQ_ENTRY(kmem_cache) import_link;
125 };
126
127 extern struct kmem_cache_tailq all_kmem_caches;
128
129 /* Cache management */
130 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
131                                      int align, int flags,
132                                      struct arena *source,
133                                      int (*ctor)(void *, void *, int),
134                                      void (*dtor)(void *, void *),
135                                      void *priv);
136 void kmem_cache_destroy(struct kmem_cache *cp);
137 /* Front end: clients of caches use these */
138 void *kmem_cache_alloc(struct kmem_cache *cp, int flags);
139 void kmem_cache_free(struct kmem_cache *cp, void *buf);
140 /* Back end: internal functions */
141 void kmem_cache_init(void);
142 void kmem_cache_reap(struct kmem_cache *cp);
143 unsigned int kmc_nr_pcpu_caches(void);
144 /* Low-level interface for initializing a cache. */
145 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
146                          size_t obj_size, int align, int flags,
147                          struct arena *source,
148                          int (*ctor)(void *, void *, int),
149                          void (*dtor)(void *, void *), void *priv);