WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/include/mm/slab.h


/*
 * Copyright (C) 2006 Ondrej Palkovsky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __SLAB_H__
#define __SLAB_H__
 
#include <adt/list.h>
#include <synch/spinlock.h>
#include <arch/atomic.h>
#include <mm/frame.h>
 
/** Minimum size to be allocated by malloc */
#define SLAB_MIN_MALLOC_W 4
 
/** Maximum size to be allocated by malloc */
#define SLAB_MAX_MALLOC_W 17
 
/** Initial Magazine size (TODO: dynamically growing magazines) */
#define SLAB_MAG_SIZE  4
 
/** If object size is less, store control structure inside SLAB */
#define SLAB_INSIDE_SIZE   (PAGE_SIZE >> 3)
 
/** Maximum wasted space we allow for cache */
#define SLAB_MAX_BADNESS(cache)   ((PAGE_SIZE << (cache)->order) >> 2)
 
/* slab_reclaim constants */
#define SLAB_RECLAIM_ALL  0x1 /**< Reclaim all possible memory, because
                   *   we are in memory stress */
 
/* cache_create flags */
#define SLAB_CACHE_NOMAGAZINE 0x1 /**< Do not use per-cpu cache */
#define SLAB_CACHE_SLINSIDE   0x2 /**< Have control structure inside SLAB */
/** We add magazine cache later, if we have this flag */
#define SLAB_CACHE_MAGDEFERRED (0x4 | SLAB_CACHE_NOMAGAZINE)
 
typedef struct {
    link_t link;
    count_t busy;  /**< Count of full slots in magazine */
    count_t size;  /**< Number of slots in magazine */
    void *objs[0]; /**< Slots in magazine */
}slab_magazine_t;
 
typedef struct {
    slab_magazine_t *current;
    slab_magazine_t *last;
    SPINLOCK_DECLARE(lock);
}slab_mag_cache_t;
 
 
typedef struct {
    char *name;
 
    link_t link;
    /* Configuration */
    size_t size;      /**< Size of SLAB position - align_up(sizeof(obj)) */
    int (*constructor)(void *obj, int kmflag);
    int (*destructor)(void *obj);
    int flags;        /**< Flags changing behaviour of cache */
 
    /* Computed values */
    __u8 order;        /**< Order of frames to be allocated */
    int objects;      /**< Number of objects that fit in */
 
    /* Statistics */
    atomic_t allocated_slabs;
    atomic_t allocated_objs;
    atomic_t cached_objs;
    atomic_t magazine_counter; /*<< How many magazines in magazines list */
 
    /* Slabs */
    link_t full_slabs;     /**< List of full slabs */
    link_t partial_slabs;  /**< List of partial slabs */
    SPINLOCK_DECLARE(slablock);
    /* Magazines  */
    link_t magazines;      /**< List o full magazines */
    SPINLOCK_DECLARE(maglock);
 
    /** CPU cache */
    slab_mag_cache_t *mag_cache;
}slab_cache_t;
 
extern slab_cache_t * slab_cache_create(char *name,
                    size_t size,
                    size_t align,
                    int (*constructor)(void *obj, int kmflag),
                    int (*destructor)(void *obj),
                    int flags);
extern void slab_cache_destroy(slab_cache_t *cache);
 
extern void * slab_alloc(slab_cache_t *cache, int flags);
extern void slab_free(slab_cache_t *cache, void *obj);
extern count_t slab_reclaim(int flags);
 
/** Initialize SLAB subsytem */
extern void slab_cache_init(void);
extern void slab_enable_cpucache(void);
 
/* KConsole debug */
extern void slab_print_list(void);
 
/* Malloc support */
extern void * kalloc(unsigned int size, int flags);
extern void kfree(void *obj);
#define malloc(x)  kalloc(x, FRAME_ATOMIC)
#define free(x)    kfree(x)
#endif
 

Rev 791	Rev 814
1	/*	1	/*
2	* Copyright (C) 2006 Ondrej Palkovsky	2	* Copyright (C) 2006 Ondrej Palkovsky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	#ifndef __SLAB_H__	29	#ifndef __SLAB_H__
30	#define __SLAB_H__	30	#define __SLAB_H__
31		31
32	#include <adt/list.h>	32	#include <adt/list.h>
33	#include <synch/spinlock.h>	33	#include <synch/spinlock.h>
34	#include <arch/atomic.h>	34	#include <arch/atomic.h>
-		35	#include <mm/frame.h>
35		36
36	/** Minimum size to be allocated by malloc */	37	/** Minimum size to be allocated by malloc */
37	#define SLAB_MIN_MALLOC_W 4	38	#define SLAB_MIN_MALLOC_W 4
38		39
39	/** Maximum size to be allocated by malloc */	40	/** Maximum size to be allocated by malloc */
40	#define SLAB_MAX_MALLOC_W 17	41	#define SLAB_MAX_MALLOC_W 17
41		42
42	/** Initial Magazine size (TODO: dynamically growing magazines) */	43	/** Initial Magazine size (TODO: dynamically growing magazines) */
43	#define SLAB_MAG_SIZE 4	44	#define SLAB_MAG_SIZE 4
44		45
45	/** If object size is less, store control structure inside SLAB */	46	/** If object size is less, store control structure inside SLAB */
46	#define SLAB_INSIDE_SIZE (PAGE_SIZE >> 3)	47	#define SLAB_INSIDE_SIZE (PAGE_SIZE >> 3)
47		48
48	/** Maximum wasted space we allow for cache */	49	/** Maximum wasted space we allow for cache */
49	#define SLAB_MAX_BADNESS(cache) ((PAGE_SIZE << (cache)->order) >> 2)	50	#define SLAB_MAX_BADNESS(cache) ((PAGE_SIZE << (cache)->order) >> 2)
50		51
51	/* slab_reclaim constants */	52	/* slab_reclaim constants */
52	#define SLAB_RECLAIM_ALL 0x1 /**< Reclaim all possible memory, because	53	#define SLAB_RECLAIM_ALL 0x1 /**< Reclaim all possible memory, because
53	* we are in memory stress */	54	* we are in memory stress */
54		55
55	/* cache_create flags */	56	/* cache_create flags */
56	#define SLAB_CACHE_NOMAGAZINE 0x1 /*< Do not use per-cpu cache /	57	#define SLAB_CACHE_NOMAGAZINE 0x1 /*< Do not use per-cpu cache /
57	#define SLAB_CACHE_SLINSIDE 0x2 /*< Have control structure inside SLAB /	58	#define SLAB_CACHE_SLINSIDE 0x2 /*< Have control structure inside SLAB /
58	/** We add magazine cache later, if we have this flag */	59	/** We add magazine cache later, if we have this flag */
59	#define SLAB_CACHE_MAGDEFERRED (0x4 \| SLAB_CACHE_NOMAGAZINE)	60	#define SLAB_CACHE_MAGDEFERRED (0x4 \| SLAB_CACHE_NOMAGAZINE)
60		61
61	typedef struct {	62	typedef struct {
62	link_t link;	63	link_t link;
63	count_t busy; /*< Count of full slots in magazine /	64	count_t busy; /*< Count of full slots in magazine /
64	count_t size; /*< Number of slots in magazine /	65	count_t size; /*< Number of slots in magazine /
65	void objs[0]; /< Slots in magazine /	66	void objs[0]; /< Slots in magazine /
66	}slab_magazine_t;	67	}slab_magazine_t;
67		68
68	typedef struct {	69	typedef struct {
69	slab_magazine_t *current;	70	slab_magazine_t *current;
70	slab_magazine_t *last;	71	slab_magazine_t *last;
71	SPINLOCK_DECLARE(lock);	72	SPINLOCK_DECLARE(lock);
72	}slab_mag_cache_t;	73	}slab_mag_cache_t;
73		74
74		75
75	typedef struct {	76	typedef struct {
76	char *name;	77	char *name;
77		78
78	link_t link;	79	link_t link;
79	/* Configuration */	80	/* Configuration */
80	size_t size; /*< Size of SLAB position - align_up(sizeof(obj)) /	81	size_t size; /*< Size of SLAB position - align_up(sizeof(obj)) /
81	int (constructor)(void obj, int kmflag);	82	int (constructor)(void obj, int kmflag);
82	int (destructor)(void obj);	83	int (destructor)(void obj);
83	int flags; /*< Flags changing behaviour of cache /	84	int flags; /*< Flags changing behaviour of cache /
84		85
85	/* Computed values */	86	/* Computed values */
86	__u8 order; /*< Order of frames to be allocated /	87	__u8 order; /*< Order of frames to be allocated /
87	int objects; /*< Number of objects that fit in /	88	int objects; /*< Number of objects that fit in /
88		89
89	/* Statistics */	90	/* Statistics */
90	atomic_t allocated_slabs;	91	atomic_t allocated_slabs;
91	atomic_t allocated_objs;	92	atomic_t allocated_objs;
92	atomic_t cached_objs;	93	atomic_t cached_objs;
93	atomic_t magazine_counter; /<< How many magazines in magazines list /	94	atomic_t magazine_counter; /<< How many magazines in magazines list /
94		95
95	/* Slabs */	96	/* Slabs */
96	link_t full_slabs; /*< List of full slabs /	97	link_t full_slabs; /*< List of full slabs /
97	link_t partial_slabs; /*< List of partial slabs /	98	link_t partial_slabs; /*< List of partial slabs /
98	SPINLOCK_DECLARE(slablock);	99	SPINLOCK_DECLARE(slablock);
99	/* Magazines */	100	/* Magazines */
100	link_t magazines; /*< List o full magazines /	101	link_t magazines; /*< List o full magazines /
101	SPINLOCK_DECLARE(maglock);	102	SPINLOCK_DECLARE(maglock);
102		103
103	/** CPU cache */	104	/** CPU cache */
104	slab_mag_cache_t *mag_cache;	105	slab_mag_cache_t *mag_cache;
105	}slab_cache_t;	106	}slab_cache_t;
106		107
107	extern slab_cache_t * slab_cache_create(char *name,	108	extern slab_cache_t * slab_cache_create(char *name,
108	size_t size,	109	size_t size,
109	size_t align,	110	size_t align,
110	int (constructor)(void obj, int kmflag),	111	int (constructor)(void obj, int kmflag),
111	int (destructor)(void obj),	112	int (destructor)(void obj),
112	int flags);	113	int flags);
113	extern void slab_cache_destroy(slab_cache_t *cache);	114	extern void slab_cache_destroy(slab_cache_t *cache);
114		115
115	extern void * slab_alloc(slab_cache_t *cache, int flags);	116	extern void * slab_alloc(slab_cache_t *cache, int flags);
116	extern void slab_free(slab_cache_t cache, void obj);	117	extern void slab_free(slab_cache_t cache, void obj);
117	extern count_t slab_reclaim(int flags);	118	extern count_t slab_reclaim(int flags);
118		119
119	/** Initialize SLAB subsytem */	120	/** Initialize SLAB subsytem */
120	extern void slab_cache_init(void);	121	extern void slab_cache_init(void);
121	extern void slab_enable_cpucache(void);	122	extern void slab_enable_cpucache(void);
122		123
123	/* KConsole debug */	124	/* KConsole debug */
124	extern void slab_print_list(void);	125	extern void slab_print_list(void);
125		126
126	/* Malloc support */	127	/* Malloc support */
127	extern void * kalloc(unsigned int size, int flags);	128	extern void * kalloc(unsigned int size, int flags);
128	extern void kfree(void *obj);	129	extern void kfree(void *obj);
-		130	#define malloc(x) kalloc(x, FRAME_ATOMIC)
-		131	#define free(x) kfree(x)
129	#endif	132	#endif
130		133

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/mm/slab.h – Rev 791 → 814