7f1e7d0c94e501d42e45ff23cc1a8bd3c88fbf40
[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  * TODO: Note, that this is a minor pain in the ass, and worth thinking about
23  * before implementing.  To keep the constructor's state valid, we can't just
24  * overwrite things, so we need to add an extra 4-8 bytes per object for the
25  * pointer, and then pass over that data when we return the actual object's
26  * address.  This also might fuck with alignment.
27  */
28
29 #pragma once
30
31 #include <ros/common.h>
32 #include <arch/mmu.h>
33 #include <sys/queue.h>
34 #include <atomic.h>
35 #include <hash_helper.h>
36 #include <arena.h>
37
38 /* Back in the day, their cutoff for "large objects" was 512B, based on
39  * measurements and on not wanting more than 1/8 of internal fragmentation. */
40 #define NUM_BUF_PER_SLAB 8
41 #define SLAB_LARGE_CUTOFF (PGSIZE / NUM_BUF_PER_SLAB)
42
43 struct kmem_slab;
44
45 /* Control block for buffers for large-object slabs */
46 struct kmem_bufctl {
47         BSD_LIST_ENTRY(kmem_bufctl) link;
48         void *buf_addr;
49         struct kmem_slab *my_slab;
50 };
51 BSD_LIST_HEAD(kmem_bufctl_list, kmem_bufctl);
52
53 /* Slabs contain the objects.  Can be either full, partial, or empty,
54  * determined by checking the number of objects busy vs total.  For large
55  * slabs, the bufctl list is used to find a free buffer.  For small, the void*
56  * is used instead.*/
57 struct kmem_slab {
58         TAILQ_ENTRY(kmem_slab) link;
59         size_t obj_size;
60         size_t num_busy_obj;
61         size_t num_total_obj;
62         union {
63                 struct kmem_bufctl_list bufctl_freelist;
64                 void *free_small_obj;
65         };
66 };
67 TAILQ_HEAD(kmem_slab_list, kmem_slab);
68
69 /* Actual cache */
70 struct kmem_cache {
71         SLIST_ENTRY(kmem_cache) link;
72         spinlock_t cache_lock;
73         const char *name;
74         size_t obj_size;
75         int align;
76         int flags;
77         struct arena *source;
78         struct kmem_slab_list full_slab_list;
79         struct kmem_slab_list partial_slab_list;
80         struct kmem_slab_list empty_slab_list;
81         void (*ctor)(void *, size_t);
82         void (*dtor)(void *, size_t);
83         unsigned long nr_cur_alloc;
84         struct hash_helper hh;
85         struct kmem_bufctl_list *alloc_hash;
86         struct kmem_bufctl_list static_hash[HASH_INIT_SZ];
87 };
88
89 /* List of all kmem_caches, sorted in order of size */
90 SLIST_HEAD(kmem_cache_list, kmem_cache);
91 extern struct kmem_cache_list kmem_caches;
92
93 /* Cache management */
94 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
95                                      int align, int flags,
96                                      struct arena *source,
97                                      void (*ctor)(void *, size_t),
98                                      void (*dtor)(void *, size_t));
99 void kmem_cache_destroy(struct kmem_cache *cp);
100 /* Front end: clients of caches use these */
101 void *kmem_cache_alloc(struct kmem_cache *cp, int flags);
102 void kmem_cache_free(struct kmem_cache *cp, void *buf);
103 /* Back end: internal functions */
104 void kmem_cache_init(void);
105 void kmem_cache_reap(struct kmem_cache *cp);
106 /* Low-level interface for initializing a cache. */
107 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
108                          size_t obj_size, int align, int flags,
109                          struct arena *source,
110                          void (*ctor)(void *, size_t),
111                          void (*dtor)(void *, size_t));
112
113 /* Debug */
114 void print_kmem_cache(struct kmem_cache *kc);
115 void print_kmem_slab(struct kmem_slab *slab);