kmalloc_incref()
[akaros.git] / kern / src / kmalloc.c
index f4b6f70..b6910c4 100644 (file)
@@ -30,11 +30,17 @@ static spinlock_t pages_list_lock = SPINLOCK_INITIALIZER;
 static page_list_t LCKD(&pages_list_lock)pages_list;
 
 struct kmem_cache *kmalloc_caches[NUM_KMALLOC_CACHES];
 static page_list_t LCKD(&pages_list_lock)pages_list;
 
 struct kmem_cache *kmalloc_caches[NUM_KMALLOC_CACHES];
+
+static void __kfree_release(struct kref *kref);
+
 void kmalloc_init(void)
 {
 void kmalloc_init(void)
 {
-       // i want to know if we ever make the tag bigger (should be below 16 bytes)
-       static_assert(sizeof(struct kmalloc_tag) <= KMALLOC_ALIGNMENT);
-       // build caches of common sizes
+       /* we want at least a 16 byte alignment of the tag so that the bufs kmalloc
+        * returns are 16 byte aligned.  we used to check the actual size == 16,
+        * since we adjusted the KMALLOC_SMALLEST based on that. */
+       static_assert(ALIGNED(sizeof(struct kmalloc_tag), 16));
+       /* build caches of common sizes.  this size will later include the tag and
+        * the actual returned buffer. */
        size_t ksize = KMALLOC_SMALLEST;
        for (int i = 0; i < NUM_KMALLOC_CACHES; i++) {
                kmalloc_caches[i] = kmem_cache_create("kmalloc_cache", ksize,
        size_t ksize = KMALLOC_SMALLEST;
        for (int i = 0; i < NUM_KMALLOC_CACHES; i++) {
                kmalloc_caches[i] = kmem_cache_create("kmalloc_cache", ksize,
@@ -46,7 +52,7 @@ void kmalloc_init(void)
 void *kmalloc(size_t size, int flags) 
 {
        // reserve space for bookkeeping and preserve alignment
 void *kmalloc(size_t size, int flags) 
 {
        // reserve space for bookkeeping and preserve alignment
-       size_t ksize = size + KMALLOC_OFFSET;
+       size_t ksize = size + sizeof(struct kmalloc_tag);
        void *buf;
        int cache_id;
        // determine cache to pull from
        void *buf;
        int cache_id;
        // determine cache to pull from
@@ -66,7 +72,8 @@ void *kmalloc(size_t size, int flags)
                tag->flags = KMALLOC_TAG_PAGES;
                tag->num_pages = num_pgs;
                tag->canary = KMALLOC_CANARY;
                tag->flags = KMALLOC_TAG_PAGES;
                tag->num_pages = num_pgs;
                tag->canary = KMALLOC_CANARY;
-               return buf + KMALLOC_OFFSET;
+               kref_init(&tag->kref, __kfree_release, 1);
+               return buf + sizeof(struct kmalloc_tag);
        }
        // else, alloc from the appropriate cache
        buf = kmem_cache_alloc(kmalloc_caches[cache_id], flags);
        }
        // else, alloc from the appropriate cache
        buf = kmem_cache_alloc(kmalloc_caches[cache_id], flags);
@@ -77,28 +84,161 @@ void *kmalloc(size_t size, int flags)
        tag->flags = KMALLOC_TAG_CACHE;
        tag->my_cache = kmalloc_caches[cache_id];
        tag->canary = KMALLOC_CANARY;
        tag->flags = KMALLOC_TAG_CACHE;
        tag->my_cache = kmalloc_caches[cache_id];
        tag->canary = KMALLOC_CANARY;
-       return buf + KMALLOC_OFFSET;
+       kref_init(&tag->kref, __kfree_release, 1);
+       return buf + sizeof(struct kmalloc_tag);
+}
+
+void *kzmalloc(size_t size, int flags) 
+{
+       void *v = kmalloc(size, flags);
+       if (!v)
+               return v;
+       memset(v, 0, size);
+       return v;
 }
 
 }
 
-void *krealloc(void* buf, size_t size, int flags) {
-       struct kmalloc_tag *tag = (struct kmalloc_tag*)(buf - KMALLOC_OFFSET);
-       if (tag->my_cache->obj_size >= size)
-               return buf;
-       kfree(buf);
-       return kmalloc(size, flags);
+void *kmalloc_align(size_t size, int flags, size_t align)
+{
+       void *addr, *retaddr;
+       int *tag_flags, offset;
+       /* alignment requests must be a multiple of long, even though we only need
+        * int in the current code. */
+       assert(ALIGNED(align, sizeof(long)));
+       /* must fit in the space reserved for the offset amount, which is at most
+        * 'align'. */
+       assert(align < (1 << (32 - KMALLOC_ALIGN_SHIFT)));
+       addr = kmalloc(size + align, flags);
+       if (!addr)
+               return 0;
+       if (ALIGNED(addr, align))
+               return addr;
+       retaddr = ROUNDUP(addr, align);
+       offset = retaddr - addr;
+       assert(offset < align);
+       /* we might not have room for a full tag.  we might have only 8 bytes.  but
+        * we'll at least have room for the flags part. */
+       tag_flags = (int*)(retaddr - sizeof(int));
+       *tag_flags = (offset << KMALLOC_ALIGN_SHIFT) | KMALLOC_TAG_UNALIGN;
+       return retaddr;
 }
 
 }
 
-void kfree(void *addr)
+void *kzmalloc_align(size_t size, int flags, size_t align)
 {
 {
-       if(addr == NULL)
+       void *v = kmalloc_align(size, flags, align);
+       if (!v)
+               return v;
+       memset(v, 0, size);
+       return v;
+}
+
+static struct kmalloc_tag *__get_km_tag(void *buf)
+{
+       struct kmalloc_tag *tag = (struct kmalloc_tag*)(buf -
+                                                   sizeof(struct kmalloc_tag));
+       if (tag->canary != KMALLOC_CANARY){
+               printk("__get_km_tag bad canary: %08lx, expected %08lx\n", tag->canary,
+                      KMALLOC_CANARY);
+               hexdump((void *)(buf - sizeof(struct kmalloc_tag)), 256);
+       }
+       return tag;
+}
+
+/* If we kmalloc_aligned, the buf we got back (and are now trying to perform
+ * some operation on) might not be the original, underlying, unaligned buf.
+ *
+ * This returns the underlying, unaligned buf, or 0 if the buf was not realigned
+ * in the first place. */
+static void *__get_unaligned_orig_buf(void *buf)
+{
+       int *tag_flags = (int*)(buf - sizeof(int));
+       if ((*tag_flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_UNALIGN)
+               return (buf - (*tag_flags >> KMALLOC_ALIGN_SHIFT));
+       else
+               return 0;
+}
+
+void *krealloc(void* buf, size_t size, int flags)
+{
+       void *nbuf;
+       size_t osize = 0;
+       struct kmalloc_tag *tag;
+
+       if (buf){
+               if (__get_unaligned_orig_buf(buf))
+                       panic("krealloc of a kmalloc_align not supported");
+               tag = __get_km_tag(buf);
+               /* whatever we got from either a slab or the page allocator is meant for
+                * both the buf+size as well as the kmalloc tag */
+               if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_CACHE) {
+                       osize = tag->my_cache->obj_size - sizeof(struct kmalloc_tag);
+               } else if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_PAGES) {
+                       osize = LOG2_UP(tag->num_pages) * PGSIZE
+                               - sizeof(struct kmalloc_tag);
+               } else {
+                       panic("Probably a bad tag, flags %p\n", tag->flags);
+               }
+               if (osize >= size)
+                       return buf;
+       }
+
+       nbuf = kmalloc(size, flags);
+
+       /* would be more interesting to user error(...) here. */
+       /* but in any event, NEVER destroy buf! */
+       if (! nbuf)
+               return NULL;
+
+       if (osize)
+               memmove(nbuf, buf, osize);
+
+       if (buf)
+               kfree(buf);
+
+       return nbuf;
+}
+
+/* Grabs a reference on a buffer.  Release with kfree().
+ *
+ * Note that a krealloc on a buffer with ref > 1 that needs a new, underlying
+ * buffer will result in two buffers existing.  In this case, the krealloc is a
+ * kmalloc and a kfree, but that kfree does not completely free since the
+ * original ref > 1. */
+void kmalloc_incref(void *buf)
+{
+       void *orig_buf = __get_unaligned_orig_buf(buf);
+       buf = orig_buf ? orig_buf : buf;
+       /* if we want a smaller tag, we can extract the code from kref and manually
+        * set the release method in kfree. */
+       kref_get(&__get_km_tag(buf)->kref, 1);
+}
+
+static void __kfree_release(struct kref *kref)
+{
+       struct kmalloc_tag *tag = container_of(kref, struct kmalloc_tag, kref);
+       if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_CACHE)
+               kmem_cache_free(tag->my_cache, tag);
+       else if ((tag->flags & KMALLOC_FLAG_MASK) == KMALLOC_TAG_PAGES)
+               free_cont_pages(tag, LOG2_UP(tag->num_pages));
+       else
+               panic("Bad flag 0x%x in %s", tag->flags, __FUNCTION__);
+}
+
+void kfree(void *buf)
+{
+       void *orig_buf;
+       if (buf == NULL)
                return;
                return;
-       struct kmalloc_tag *tag = (struct kmalloc_tag*)(addr - KMALLOC_OFFSET);
-       assert(tag->canary == KMALLOC_CANARY);
-       if (tag->flags & KMALLOC_TAG_CACHE)
-               kmem_cache_free(tag->my_cache, addr - KMALLOC_OFFSET);
-       else if (tag->flags & KMALLOC_TAG_PAGES) {
-               free_cont_pages(addr - KMALLOC_OFFSET, LOG2_UP(tag->num_pages));
-       } else 
-               panic("[Italian Accent]: Che Cazzo! BO! Flag in kmalloc!!!");
+       orig_buf = __get_unaligned_orig_buf(buf);
+       buf = orig_buf ? orig_buf : buf;
+       kref_put(&__get_km_tag(buf)->kref);
 }
 
 }
 
+void kmalloc_canary_check(char *str)
+{
+       if (!debug_canary)
+               return;
+       struct kmalloc_tag *tag = (struct kmalloc_tag*)(debug_canary -
+                                                       sizeof(struct kmalloc_tag));
+       if (tag->canary != KMALLOC_CANARY)
+               panic("\t\t KMALLOC CANARY CHECK FAILED %s\n", str);
+}