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