Subversion Repositories HelenOS

Rev

Rev 767 | Rev 776 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
759 palkovsky 1
/*
762 palkovsky 2
 * Copyright (C) 2006 Ondrej Palkovsky
759 palkovsky 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
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
15
 *   derived from this software without specific prior written permission.
16
 *
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
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
29
#ifndef __SLAB_H__
30
#define __SLAB_H__
31
 
32
#include <list.h>
33
#include <synch/spinlock.h>
764 palkovsky 34
#include <arch/atomic.h>
759 palkovsky 35
 
771 palkovsky 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
 
759 palkovsky 42
/** Initial Magazine size (TODO: dynamically growing magazines) */
43
#define SLAB_MAG_SIZE  4
44
 
45
/** If object size is less, store control structure inside SLAB */
766 palkovsky 46
#define SLAB_INSIDE_SIZE   (PAGE_SIZE >> 3)
759 palkovsky 47
 
762 palkovsky 48
/** Maximum wasted space we allow for cache */
771 palkovsky 49
#define SLAB_MAX_BADNESS(cache)   ((PAGE_SIZE << (cache)->order) >> 2)
759 palkovsky 50
 
51
/* slab_reclaim constants */
52
#define SLAB_RECLAIM_ALL  0x1 /**< Reclaim all possible memory, because
53
                   *   we are in memory stress */
54
 
55
/* cache_create flags */
56
#define SLAB_CACHE_NOMAGAZINE 0x1 /**< Do not use per-cpu cache */
57
#define SLAB_CACHE_SLINSIDE   0x2 /**< Have control structure inside SLAB */
58
 
59
typedef struct {
60
    link_t link;
762 palkovsky 61
    count_t busy;  /**< Count of full slots in magazine */
62
    count_t size;  /**< Number of slots in magazine */
63
    void *objs[0]; /**< Slots in magazine */
759 palkovsky 64
}slab_magazine_t;
65
 
66
typedef struct {
67
    char *name;
68
 
69
    SPINLOCK_DECLARE(lock);
70
    link_t link;
71
    /* Configuration */
762 palkovsky 72
    size_t size;      /**< Size of SLAB position - align_up(sizeof(obj)) */
759 palkovsky 73
    int (*constructor)(void *obj, int kmflag);
74
    void (*destructor)(void *obj);
762 palkovsky 75
    int flags;        /**< Flags changing behaviour of cache */
759 palkovsky 76
 
77
    /* Computed values */
762 palkovsky 78
    __u8 order;        /**< Order of frames to be allocated */
79
    int objects;      /**< Number of objects that fit in */
759 palkovsky 80
 
81
    /* Statistics */
764 palkovsky 82
    atomic_t allocated_slabs;
83
    atomic_t allocated_objs;
767 palkovsky 84
    atomic_t cached_objs;
759 palkovsky 85
 
86
    /* Slabs */
762 palkovsky 87
    link_t full_slabs;     /**< List of full slabs */
88
    link_t partial_slabs;  /**< List of partial slabs */
759 palkovsky 89
    /* Magazines  */
762 palkovsky 90
    link_t magazines;      /**< List o full magazines */
91
 
92
    /** CPU cache */
759 palkovsky 93
    struct {
94
        slab_magazine_t *current;
95
        slab_magazine_t *last;
96
        SPINLOCK_DECLARE(lock);
97
    }mag_cache[0];
98
}slab_cache_t;
99
 
762 palkovsky 100
extern slab_cache_t * slab_cache_create(char *name,
101
                    size_t size,
102
                    size_t align,
103
                    int (*constructor)(void *obj, int kmflag),
104
                    void (*destructor)(void *obj),
105
                    int flags);
106
extern void slab_cache_destroy(slab_cache_t *cache);
759 palkovsky 107
 
762 palkovsky 108
extern void * slab_alloc(slab_cache_t *cache, int flags);
109
extern void slab_free(slab_cache_t *cache, void *obj);
110
extern count_t slab_reclaim(int flags);
759 palkovsky 111
 
112
/** Initialize SLAB subsytem */
762 palkovsky 113
extern void slab_cache_init(void);
759 palkovsky 114
 
115
/* KConsole debug */
762 palkovsky 116
extern void slab_print_list(void);
759 palkovsky 117
 
771 palkovsky 118
/* Malloc support */
119
extern void * kalloc(unsigned int size, int flags);
120
extern void kfree(void *obj);
121
 
759 palkovsky 122
#endif