slab: Move the name into the kmem_cache
[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  * Be careful with source arenas and NOTOUCH.  If a cache's source arena is not
29  * page-aligned memory, you need to set NOTOUCH.  Otherwise, for small objects,
30  * a slab will be constructed that uses the source for a page of objects.
31  */
32
33 #pragma once
34
35 #include <ros/common.h>
36 #include <arch/mmu.h>
37 #include <sys/queue.h>
38 #include <atomic.h>
39 #include <hash_helper.h>
40 #include <arena.h>
41
42 /* Back in the day, their cutoff for "large objects" was 512B, based on
43  * measurements and on not wanting more than 1/8 of internal fragmentation. */
44 #define NUM_BUF_PER_SLAB 8
45 #define SLAB_LARGE_CUTOFF (PGSIZE / NUM_BUF_PER_SLAB)
46
47 #define KMC_NAME_SZ                             32
48
49 /* Cache creation flags: */
50 #define KMC_NOTOUCH                             0x0001  /* Can't use source/object's memory */
51 #define __KMC_USE_BUFCTL                0x1000  /* Internal use */
52
53 struct kmem_slab;
54
55 /* Control block for buffers for large-object slabs */
56 struct kmem_bufctl {
57         BSD_LIST_ENTRY(kmem_bufctl) link;
58         void *buf_addr;
59         struct kmem_slab *my_slab;
60 };
61 BSD_LIST_HEAD(kmem_bufctl_list, kmem_bufctl);
62
63 /* Slabs contain the objects.  Can be either full, partial, or empty,
64  * determined by checking the number of objects busy vs total.  For large
65  * slabs, the bufctl list is used to find a free buffer.  For small, the void*
66  * is used instead.*/
67 struct kmem_slab {
68         TAILQ_ENTRY(kmem_slab) link;
69         size_t obj_size;
70         size_t num_busy_obj;
71         size_t num_total_obj;
72         union {
73                 struct kmem_bufctl_list bufctl_freelist;
74                 void *free_small_obj;
75         };
76 };
77 TAILQ_HEAD(kmem_slab_list, kmem_slab);
78
79 /* Actual cache */
80 struct kmem_cache {
81         SLIST_ENTRY(kmem_cache) link;
82         spinlock_t cache_lock;
83         size_t obj_size;
84         size_t import_amt;
85         int align;
86         int flags;
87         struct arena *source;
88         struct kmem_slab_list full_slab_list;
89         struct kmem_slab_list partial_slab_list;
90         struct kmem_slab_list empty_slab_list;
91         void (*ctor)(void *, size_t);
92         void (*dtor)(void *, size_t);
93         unsigned long nr_cur_alloc;
94         struct hash_helper hh;
95         struct kmem_bufctl_list *alloc_hash;
96         struct kmem_bufctl_list static_hash[HASH_INIT_SZ];
97         char name[KMC_NAME_SZ];
98 };
99
100 /* List of all kmem_caches, sorted in order of size */
101 SLIST_HEAD(kmem_cache_list, kmem_cache);
102 extern struct kmem_cache_list kmem_caches;
103
104 /* Cache management */
105 struct kmem_cache *kmem_cache_create(const char *name, size_t obj_size,
106                                      int align, int flags,
107                                      struct arena *source,
108                                      void (*ctor)(void *, size_t),
109                                      void (*dtor)(void *, size_t));
110 void kmem_cache_destroy(struct kmem_cache *cp);
111 /* Front end: clients of caches use these */
112 void *kmem_cache_alloc(struct kmem_cache *cp, int flags);
113 void kmem_cache_free(struct kmem_cache *cp, void *buf);
114 /* Back end: internal functions */
115 void kmem_cache_init(void);
116 void kmem_cache_reap(struct kmem_cache *cp);
117 /* Low-level interface for initializing a cache. */
118 void __kmem_cache_create(struct kmem_cache *kc, const char *name,
119                          size_t obj_size, int align, int flags,
120                          struct arena *source,
121                          void (*ctor)(void *, size_t),
122                          void (*dtor)(void *, size_t));
123
124 /* Debug */
125 void print_kmem_cache(struct kmem_cache *kc);
126 void print_kmem_slab(struct kmem_slab *slab);