arena: Use qcaches (slabs) in the arena
[akaros.git] / kern / src / kmalloc.c
1 /* Copyright (c) 2009 The Regents of the University of California.
2  * See the COPYRIGHT files at the top of this source tree for full
3  * license information.
4  *
5  * Barret Rhoden <brho@cs.berkeley.edu>
6  * Kevin Klues <klueska@cs.berkeley.edu>
7  */
8 #include <ros/common.h>
9 #include <error.h>
10 #include <pmap.h>
11 #include <kmalloc.h>
12 #include <stdio.h>
13 #include <slab.h>
14 #include <assert.h>
15
16 #define kmallocdebug(args...)  //printk(args)
17
18 //List of physical pages used by kmalloc
19 static spinlock_t pages_list_lock = SPINLOCK_INITIALIZER;
20 static page_list_t pages_list;
21
22 struct kmem_cache *kmalloc_caches[NUM_KMALLOC_CACHES];
23
24 static void __kfree_release(struct kref *kref);
25
26 void kmalloc_init(void)
27 {
28         /* we want at least a 16 byte alignment of the tag so that the bufs kmalloc
29          * returns are 16 byte aligned.  we used to check the actual size == 16,
30          * since we adjusted the KMALLOC_SMALLEST based on that. */
31         static_assert(ALIGNED(sizeof(struct kmalloc_tag), 16));
32         /* build caches of common sizes.  this size will later include the tag and
33          * the actual returned buffer. */
34         size_t ksize = KMALLOC_SMALLEST;
35         for (int i = 0; i < NUM_KMALLOC_CACHES; i++) {
36                 kmalloc_caches[i] = kmem_cache_create("kmalloc_cache", ksize,
37                                                       KMALLOC_ALIGNMENT, 0,
38                                                       NULL, 0, 0);
39                 ksize <<= 1;
40         }
41 }
42
43 void *kmalloc(size_t size, int flags)
44 {
45         // reserve space for bookkeeping and preserve alignment
46         size_t ksize = size + sizeof(struct kmalloc_tag);
47         void *buf;
48         int cache_id;
49         // determine cache to pull from
50         if (ksize <= KMALLOC_SMALLEST)
51                 cache_id = 0;
52         else
53                 cache_id = LOG2_UP(ksize) - LOG2_UP(KMALLOC_SMALLEST);
54         // if we don't have a cache to handle it, alloc cont pages
55         if (cache_id >= NUM_KMALLOC_CACHES) {
56                 size_t num_pgs = ROUNDUP(size + sizeof(struct kmalloc_tag), PGSIZE) /
57                                            PGSIZE;
58                 buf = get_cont_pages(LOG2_UP(num_pgs), flags);
59                 if (!buf)
60                         panic("Kmalloc failed!  Handle me!");
61                 // fill in the kmalloc tag
62                 struct kmalloc_tag *tag = buf;
63                 tag->flags = KMALLOC_TAG_PAGES;
64                 tag->num_pages = num_pgs;
65                 tag->canary = KMALLOC_CANARY;
66                 kref_init(&tag->kref, __kfree_release, 1);
67                 return buf + sizeof(struct kmalloc_tag);
68         }
69         // else, alloc from the appropriate cache
70         buf = kmem_cache_alloc(kmalloc_caches[cache_id], flags);
71         if (!buf)
72                 panic("Kmalloc failed!  Handle me!");
73         // store a pointer to the buffers kmem_cache in it's bookkeeping space
74         struct kmalloc_tag *tag = buf;
75         tag->flags = KMALLOC_TAG_CACHE;
76         tag->my_cache = kmalloc_caches[cache_id];
77         tag->canary = KMALLOC_CANARY;
78         kref_init(&tag->kref, __kfree_release, 1);
79         return buf + sizeof(struct kmalloc_tag);
80 }
81
82 void *kzmalloc(size_t size, int flags)
83 {
84         void *v = kmalloc(size, flags);
85         if (!v)
86                 return v;
87         memset(v, 0, size);
88         return v;
89 }
90
91 void *kmalloc_align(size_t size, int flags, size_t align)
92 {
93         void *addr, *retaddr;
94         int *tag_flags, offset;
95         /* alignment requests must be a multiple of long, even though we only need
96          * int in the current code. */
97         assert(ALIGNED(align, sizeof(long)));
98         /* must fit in the space reserved for the offset amount, which is at most
99          * 'align'. */
100         assert(align < (1 << (32 - KMALLOC_ALIGN_SHIFT)));
101         assert(IS_PWR2(align));
102         addr = kmalloc(size + align, flags);
103         if (!addr)
104                 return 0;
105         if (ALIGNED(addr, align))
106                 return addr;
107         retaddr = ROUNDUP(addr, align);
108         offset = retaddr - addr;
109         assert(offset < align);
110         /* we might not have room for a full tag.  we might have only 8 bytes.  but
111          * we'll at least have room for the flags part. */
112         tag_flags = (int*)(retaddr - sizeof(int));
113         *tag_flags = (offset << KMALLOC_ALIGN_SHIFT) | KMALLOC_TAG_UNALIGN;
114         return retaddr;
115 }
116
117 void *kzmalloc_align(size_t size, int flags, size_t align)
118 {
119         void *v = kmalloc_align(size, flags, align);
120         if (!v)
121                 return v;
122         memset(v, 0, size);
123         return v;
124 }
125
126 static struct kmalloc_tag *__get_km_tag(void *buf)
127 {
128         struct kmalloc_tag *tag = (struct kmalloc_tag*)(buf -
129                                                     sizeof(struct kmalloc_tag));
130         if (tag->canary != KMALLOC_CANARY){
131                 printk("__get_km_tag bad canary: %08lx@%p, buf %p, expected %08lx\n",
132                        tag->canary, &tag->canary, buf, KMALLOC_CANARY);
133                 hexdump((void *)(buf - sizeof(struct kmalloc_tag)), 256);
134                 panic("Bad canary");
135         }
136         return tag;
137 }
138
139 /* If we kmalloc_aligned, the buf we got back (and are now trying to perform
140  * some operation on) might not be the original, underlying, unaligned buf.
141  *
142  * This returns the underlying, unaligned buf, or 0 if the buf was not realigned
143  * in the first place. */
144 static void *__get_unaligned_orig_buf(void *buf)
145 {
146         int *tag_flags = (int*)(buf - sizeof(int));
147         if ((*tag_flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_UNALIGN)
148                 return (buf - (*tag_flags >> KMALLOC_ALIGN_SHIFT));
149         else
150                 return 0;
151 }
152
153 void *krealloc(void* buf, size_t size, int flags)
154 {
155         void *nbuf;
156         size_t osize = 0;
157         struct kmalloc_tag *tag;
158
159         if (buf){
160                 if (__get_unaligned_orig_buf(buf))
161                         panic("krealloc of a kmalloc_align not supported");
162                 tag = __get_km_tag(buf);
163                 /* whatever we got from either a slab or the page allocator is meant for
164                  * both the buf+size as well as the kmalloc tag */
165                 if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_CACHE) {
166                         osize = tag->my_cache->obj_size - sizeof(struct kmalloc_tag);
167                 } else if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_PAGES) {
168                         osize = LOG2_UP(tag->num_pages) * PGSIZE
169                                 - sizeof(struct kmalloc_tag);
170                 } else {
171                         panic("Probably a bad tag, flags %p\n", tag->flags);
172                 }
173                 if (osize >= size)
174                         return buf;
175         }
176
177         nbuf = kmalloc(size, flags);
178
179         /* would be more interesting to user error(...) here. */
180         /* but in any event, NEVER destroy buf! */
181         if (! nbuf)
182                 return NULL;
183
184         if (osize)
185                 memmove(nbuf, buf, osize);
186
187         if (buf)
188                 kfree(buf);
189
190         return nbuf;
191 }
192
193 /* Grabs a reference on a buffer.  Release with kfree().
194  *
195  * Note that a krealloc on a buffer with ref > 1 that needs a new, underlying
196  * buffer will result in two buffers existing.  In this case, the krealloc is a
197  * kmalloc and a kfree, but that kfree does not completely free since the
198  * original ref > 1. */
199 void kmalloc_incref(void *buf)
200 {
201         void *orig_buf = __get_unaligned_orig_buf(buf);
202         buf = orig_buf ? orig_buf : buf;
203         /* if we want a smaller tag, we can extract the code from kref and manually
204          * set the release method in kfree. */
205         kref_get(&__get_km_tag(buf)->kref, 1);
206 }
207
208 int kmalloc_refcnt(void *buf)
209 {
210         void *orig_buf = __get_unaligned_orig_buf(buf);
211         buf = orig_buf ? orig_buf : buf;
212         return kref_refcnt(&__get_km_tag(buf)->kref);
213 }
214
215 static void __kfree_release(struct kref *kref)
216 {
217         struct kmalloc_tag *tag = container_of(kref, struct kmalloc_tag, kref);
218         if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_CACHE)
219                 kmem_cache_free(tag->my_cache, tag);
220         else if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_PAGES)
221                 free_cont_pages(tag, LOG2_UP(tag->num_pages));
222         else
223                 panic("Bad flag 0x%x in %s", tag->flags, __FUNCTION__);
224 }
225
226 void kfree(void *buf)
227 {
228         void *orig_buf;
229         if (buf == NULL)
230                 return;
231         orig_buf = __get_unaligned_orig_buf(buf);
232         buf = orig_buf ? orig_buf : buf;
233         kref_put(&__get_km_tag(buf)->kref);
234 }
235
236 void kmalloc_canary_check(char *str)
237 {
238         if (!debug_canary)
239                 return;
240         struct kmalloc_tag *tag = (struct kmalloc_tag*)(debug_canary -
241                                                         sizeof(struct kmalloc_tag));
242         if (tag->canary != KMALLOC_CANARY)
243                 panic("\t\t KMALLOC CANARY CHECK FAILED %s\n", str);
244 }
245
246 struct sized_alloc *sized_kzmalloc(size_t size, int flags)
247 {
248         struct sized_alloc *sza;
249
250         sza = kzmalloc(sizeof(struct sized_alloc) + size, flags);
251         if (!sza)
252                 return NULL;
253         sza->buf = sza + 1;
254         sza->size = size;
255         return sza;
256 }