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