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 <list.h>
#include <synch/spinlock.h>
#include <arch/atomic.h>
 
/** Minimum size to be allocated by malloc */
#define SLAB_MIN_MALLOC_W 3
 
/** 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 */
 
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 {
    char *name;
 
    SPINLOCK_DECLARE(lock);
    link_t link;
    /* Configuration */
    size_t size;      /**< Size of SLAB position - align_up(sizeof(obj)) */
    int (*constructor)(void *obj, int kmflag);
    void (*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;
 
    /* Slabs */
    link_t full_slabs;     /**< List of full slabs */
    link_t partial_slabs;  /**< List of partial slabs */
    /* Magazines  */
    link_t magazines;      /**< List o full magazines */
 
    /** CPU cache */
    struct {
        slab_magazine_t *current;
        slab_magazine_t *last;
        SPINLOCK_DECLARE(lock);
    }mag_cache[0];
}slab_cache_t;
 
extern slab_cache_t * slab_cache_create(char *name,
                    size_t size,
                    size_t align,
                    int (*constructor)(void *obj, int kmflag),
                    void (*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);
 
/* KConsole debug */
extern void slab_print_list(void);
 
/* Malloc support */
extern void * kalloc(unsigned int size, int flags);
extern void kfree(void *obj);
 
#endif
 

Rev 767	Rev 771
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 <list.h>	32	#include <list.h>
33	#include <synch/spinlock.h>	33	#include <synch/spinlock.h>
34	#include <arch/atomic.h>	34	#include <arch/atomic.h>
35		35
-		36	/** Minimum size to be allocated by malloc */
-		37	#define SLAB_MIN_MALLOC_W 3
-		38
-		39	/** Maximum size to be allocated by malloc */
-		40	#define SLAB_MAX_MALLOC_W 17
-		41
36	/** Initial Magazine size (TODO: dynamically growing magazines) */	42	/** Initial Magazine size (TODO: dynamically growing magazines) */
37	#define SLAB_MAG_SIZE 4	43	#define SLAB_MAG_SIZE 4
38		44
39	/** If object size is less, store control structure inside SLAB */	45	/** If object size is less, store control structure inside SLAB */
40	#define SLAB_INSIDE_SIZE (PAGE_SIZE >> 3)	46	#define SLAB_INSIDE_SIZE (PAGE_SIZE >> 3)
41		47
42	/** Maximum wasted space we allow for cache */	48	/** Maximum wasted space we allow for cache */
43	#define SLAB_MAX_BADNESS(cache) ((PAGE_SIZE << (cache)->order >> 2))	49	#define SLAB_MAX_BADNESS(cache) ((PAGE_SIZE << (cache)->order) >> 2)
44		50
45	/* slab_reclaim constants */	51	/* slab_reclaim constants */
46	#define SLAB_RECLAIM_ALL 0x1 /**< Reclaim all possible memory, because	52	#define SLAB_RECLAIM_ALL 0x1 /**< Reclaim all possible memory, because
47	* we are in memory stress */	53	* we are in memory stress */
48		54
49	/* cache_create flags */	55	/* cache_create flags */
50	#define SLAB_CACHE_NOMAGAZINE 0x1 /*< Do not use per-cpu cache /	56	#define SLAB_CACHE_NOMAGAZINE 0x1 /*< Do not use per-cpu cache /
51	#define SLAB_CACHE_SLINSIDE 0x2 /*< Have control structure inside SLAB /	57	#define SLAB_CACHE_SLINSIDE 0x2 /*< Have control structure inside SLAB /
52		58
53	typedef struct {	59	typedef struct {
54	link_t link;	60	link_t link;
55	count_t busy; /*< Count of full slots in magazine /	61	count_t busy; /*< Count of full slots in magazine /
56	count_t size; /*< Number of slots in magazine /	62	count_t size; /*< Number of slots in magazine /
57	void objs[0]; /< Slots in magazine /	63	void objs[0]; /< Slots in magazine /
58	}slab_magazine_t;	64	}slab_magazine_t;
59		65
60	typedef struct {	66	typedef struct {
61	char *name;	67	char *name;
62		68
63	SPINLOCK_DECLARE(lock);	69	SPINLOCK_DECLARE(lock);
64	link_t link;	70	link_t link;
65	/* Configuration */	71	/* Configuration */
66	size_t size; /*< Size of SLAB position - align_up(sizeof(obj)) /	72	size_t size; /*< Size of SLAB position - align_up(sizeof(obj)) /
67	int (constructor)(void obj, int kmflag);	73	int (constructor)(void obj, int kmflag);
68	void (destructor)(void obj);	74	void (destructor)(void obj);
69	int flags; /*< Flags changing behaviour of cache /	75	int flags; /*< Flags changing behaviour of cache /
70		76
71	/* Computed values */	77	/* Computed values */
72	__u8 order; /*< Order of frames to be allocated /	78	__u8 order; /*< Order of frames to be allocated /
73	int objects; /*< Number of objects that fit in /	79	int objects; /*< Number of objects that fit in /
74		80
75	/* Statistics */	81	/* Statistics */
76	atomic_t allocated_slabs;	82	atomic_t allocated_slabs;
77	atomic_t allocated_objs;	83	atomic_t allocated_objs;
78	atomic_t cached_objs;	84	atomic_t cached_objs;
79		85
80	/* Slabs */	86	/* Slabs */
81	link_t full_slabs; /*< List of full slabs /	87	link_t full_slabs; /*< List of full slabs /
82	link_t partial_slabs; /*< List of partial slabs /	88	link_t partial_slabs; /*< List of partial slabs /
83	/* Magazines */	89	/* Magazines */
84	link_t magazines; /*< List o full magazines /	90	link_t magazines; /*< List o full magazines /
85		91
86	/** CPU cache */	92	/** CPU cache */
87	struct {	93	struct {
88	slab_magazine_t *current;	94	slab_magazine_t *current;
89	slab_magazine_t *last;	95	slab_magazine_t *last;
90	SPINLOCK_DECLARE(lock);	96	SPINLOCK_DECLARE(lock);
91	}mag_cache[0];	97	}mag_cache[0];
92	}slab_cache_t;	98	}slab_cache_t;
93		99
94	extern slab_cache_t * slab_cache_create(char *name,	100	extern slab_cache_t * slab_cache_create(char *name,
95	size_t size,	101	size_t size,
96	size_t align,	102	size_t align,
97	int (constructor)(void obj, int kmflag),	103	int (constructor)(void obj, int kmflag),
98	void (destructor)(void obj),	104	void (destructor)(void obj),
99	int flags);	105	int flags);
100	extern void slab_cache_destroy(slab_cache_t *cache);	106	extern void slab_cache_destroy(slab_cache_t *cache);
101		107
102	extern void * slab_alloc(slab_cache_t *cache, int flags);	108	extern void * slab_alloc(slab_cache_t *cache, int flags);
103	extern void slab_free(slab_cache_t cache, void obj);	109	extern void slab_free(slab_cache_t cache, void obj);
104	extern count_t slab_reclaim(int flags);	110	extern count_t slab_reclaim(int flags);
105		111
106	/** Initialize SLAB subsytem */	112	/** Initialize SLAB subsytem */
107	extern void slab_cache_init(void);	113	extern void slab_cache_init(void);
108		114
109	/* KConsole debug */	115	/* KConsole debug */
110	extern void slab_print_list(void);	116	extern void slab_print_list(void);
111		117
-		118	/* Malloc support */
-		119	extern void * kalloc(unsigned int size, int flags);
-		120	extern void kfree(void *obj);
-		121
112	#endif	122	#endif
113		123

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/mm/slab.h – Rev 767 → 771