qio: implement pullupblock() for block extra data
[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_NOTRACE             0x0004  /* Do not trace allocations */
49 #define __KMC_USE_BUFCTL        0x1000  /* Internal use */
50 #define __KMC_TRACED            0x2000  /* Internal use */
51 #define __KMC_EVER_TRACED       0x3000  /* Internal use */
52
53 struct kmem_magazine {
54         SLIST_ENTRY(kmem_magazine)      link;
55         unsigned int                    nr_rounds;
56         void                            *rounds[KMC_MAG_MAX_SZ];
57 } __attribute__((aligned(ARCH_CL_SIZE)));
58 SLIST_HEAD(kmem_mag_slist, kmem_magazine);
59
60 struct kmem_pcpu_cache {
61         int8_t                          irq_state;
62         unsigned int                    magsize;
63         struct kmem_magazine            *loaded;
64         struct kmem_magazine            *prev;
65         size_t                          nr_allocs_ever;
66 } __attribute__((aligned(ARCH_CL_SIZE)));
67
68 struct kmem_depot {
69         spinlock_t                      lock;
70         struct kmem_mag_slist           not_empty;
71         struct kmem_mag_slist           empty;
72         unsigned int                    magsize;
73         unsigned int                    nr_empty;
74         unsigned int                    nr_not_empty;
75         unsigned int                    busy_count;
76         uint64_t                        busy_start;
77 };
78
79 struct kmem_slab;
80
81 /* Control block for buffers for large-object slabs */
82 struct kmem_bufctl {
83         BSD_LIST_ENTRY(kmem_bufctl) link;
84         void *buf_addr;
85         struct kmem_slab *my_slab;
86 };
87 BSD_LIST_HEAD(kmem_bufctl_list, kmem_bufctl);
88
89 /* Slabs contain the objects.  Can be either full, partial, or empty,
90  * determined by checking the number of objects busy vs total.  For large
91  * slabs, the bufctl list is used to find a free buffer.  For small, the void*
92  * is used instead.*/
93 struct kmem_slab {
94         TAILQ_ENTRY(kmem_slab) link;
95         size_t num_busy_obj;
96         size_t num_total_obj;
97         union {
98                 struct kmem_bufctl_list bufctl_freelist;
99                 void *free_small_obj;
100         };
101 };
102 TAILQ_HEAD(kmem_slab_list, kmem_slab);
103
104 struct kmem_trace {
105         void                            *obj;
106         struct hlist_node               hash;
107         size_t                          nr_pcs;
108         uintptr_t                       pcs[MAX_BT_DEPTH];
109         char                            str[60];
110 };
111
112 struct kmem_trace_ht {
113         spinlock_t                      lock;
114         struct hash_helper              hh;
115         struct hlist_head               *ht;
116         struct hlist_head               static_ht[HASH_INIT_SZ];
117 };
118
119 /* Actual cache */
120 struct kmem_cache {
121         TAILQ_ENTRY(kmem_cache) all_kmc_link;
122         struct kmem_pcpu_cache *pcpu_caches;
123         struct kmem_depot depot;
124         spinlock_t cache_lock;
125         size_t obj_size;
126         size_t import_amt;
127         int align;
128         int flags;
129         struct arena *source;
130         struct kmem_slab_list full_slab_list;
131         struct kmem_slab_list partial_slab_list;
132         struct kmem_slab_list empty_slab_list;
133         int (*ctor)(void *obj, void *priv, int flags);
134         void (*dtor)(void *obj, void *priv);
135         void *priv;
136         unsigned long nr_cur_alloc;
137         unsigned long nr_direct_allocs_ever;
138         struct hash_helper hh;
139         struct kmem_bufctl_list *alloc_hash;
140         struct kmem_bufctl_list static_hash[HASH_INIT_SZ];
141         char name[KMC_NAME_SZ];
142         TAILQ_ENTRY(kmem_cache) import_link;
143         struct kmem_trace_ht trace_ht;
144 };
145
146 extern struct kmem_cache_tailq all_kmem_caches;
147
148 /* Cache management */
149 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
150                                      int align, int flags,
151                                      struct arena *source,
152                                      int (*ctor)(void *, void *, int),
153                                      void (*dtor)(void *, void *),
154                                      void *priv);
155 void kmem_cache_destroy(struct kmem_cache *cp);
156 /* Front end: clients of caches use these */
157 void *kmem_cache_alloc(struct kmem_cache *cp, int flags);
158 void kmem_cache_free(struct kmem_cache *cp, void *buf);
159 /* Back end: internal functions */
160 void kmem_cache_init(void);
161 void kmem_cache_reap(struct kmem_cache *cp);
162 unsigned int kmc_nr_pcpu_caches(void);
163 /* Low-level interface for initializing a cache. */
164 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
165                          size_t obj_size, int align, int flags,
166                          struct arena *source,
167                          int (*ctor)(void *, void *, int),
168                          void (*dtor)(void *, void *), void *priv);
169
170 /* Tracing */
171 int kmem_trace_start(struct kmem_cache *kc);
172 void kmem_trace_stop(struct kmem_cache *kc);
173 struct sized_alloc *kmem_trace_print(struct kmem_cache *kc);
174 void kmem_trace_reset(struct kmem_cache *kc);