Subversion Repositories HelenOS

Rev

Rev 1780 | Rev 1888 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2006 Ondrej 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.  /** @addtogroup genericmm
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef __SLAB_H__
  36. #define __SLAB_H__
  37.  
  38. #include <adt/list.h>
  39. #include <synch/spinlock.h>
  40. #include <atomic.h>
  41. #include <mm/frame.h>
  42.  
  43. /** Minimum size to be allocated by malloc */
  44. #define SLAB_MIN_MALLOC_W 4
  45.  
  46. /** Maximum size to be allocated by malloc */
  47. #define SLAB_MAX_MALLOC_W 18
  48.  
  49. /** Initial Magazine size (TODO: dynamically growing magazines) */
  50. #define SLAB_MAG_SIZE  4
  51.  
  52. /** If object size is less, store control structure inside SLAB */
  53. #define SLAB_INSIDE_SIZE   (PAGE_SIZE >> 3)
  54.  
  55. /** Maximum wasted space we allow for cache */
  56. #define SLAB_MAX_BADNESS(cache)   ((PAGE_SIZE << (cache)->order) >> 2)
  57.  
  58. /* slab_reclaim constants */
  59. #define SLAB_RECLAIM_ALL  0x1 /**< Reclaim all possible memory, because
  60.                    *   we are in memory stress */
  61.  
  62. /* cache_create flags */
  63. #define SLAB_CACHE_NOMAGAZINE 0x1 /**< Do not use per-cpu cache */
  64. #define SLAB_CACHE_SLINSIDE   0x2 /**< Have control structure inside SLAB */
  65. /** We add magazine cache later, if we have this flag */
  66. #define SLAB_CACHE_MAGDEFERRED (0x4 | SLAB_CACHE_NOMAGAZINE)
  67.  
  68. typedef struct {
  69.     link_t link;
  70.     count_t busy;  /**< Count of full slots in magazine */
  71.     count_t size;  /**< Number of slots in magazine */
  72.     void *objs[0]; /**< Slots in magazine */
  73. }slab_magazine_t;
  74.  
  75. typedef struct {
  76.     slab_magazine_t *current;
  77.     slab_magazine_t *last;
  78.     SPINLOCK_DECLARE(lock);
  79. }slab_mag_cache_t;
  80.  
  81.  
  82. typedef struct {
  83.     char *name;
  84.  
  85.     link_t link;
  86.     /* Configuration */
  87.     size_t size;      /**< Size of slab position - align_up(sizeof(obj)) */
  88.     int (*constructor)(void *obj, int kmflag);
  89.     int (*destructor)(void *obj);
  90.     int flags;        /**< Flags changing behaviour of cache */
  91.  
  92.     /* Computed values */
  93.     uint8_t order;        /**< Order of frames to be allocated */
  94.     int objects;      /**< Number of objects that fit in */
  95.  
  96.     /* Statistics */
  97.     atomic_t allocated_slabs;
  98.     atomic_t allocated_objs;
  99.     atomic_t cached_objs;
  100.     atomic_t magazine_counter; /**< How many magazines in magazines list */
  101.  
  102.     /* Slabs */
  103.     link_t full_slabs;     /**< List of full slabs */
  104.     link_t partial_slabs;  /**< List of partial slabs */
  105.     SPINLOCK_DECLARE(slablock);
  106.     /* Magazines  */
  107.     link_t magazines;      /**< List o full magazines */
  108.     SPINLOCK_DECLARE(maglock);
  109.  
  110.     /** CPU cache */
  111.     slab_mag_cache_t *mag_cache;
  112. }slab_cache_t;
  113.  
  114. extern slab_cache_t * slab_cache_create(char *name,
  115.                     size_t size,
  116.                     size_t align,
  117.                     int (*constructor)(void *obj, int kmflag),
  118.                     int (*destructor)(void *obj),
  119.                     int flags);
  120. extern void slab_cache_destroy(slab_cache_t *cache);
  121.  
  122. extern void * slab_alloc(slab_cache_t *cache, int flags);
  123. extern void slab_free(slab_cache_t *cache, void *obj);
  124. extern count_t slab_reclaim(int flags);
  125.  
  126. /** Initialize slab subsytem */
  127. extern void slab_cache_init(void);
  128. extern void slab_enable_cpucache(void);
  129.  
  130. /* kconsole debug */
  131. extern void slab_print_list(void);
  132.  
  133. /* malloc support */
  134. extern void * malloc(unsigned int size, int flags);
  135. extern void free(void *obj);
  136. #endif
  137.  
  138.  /** @}
  139.  */
  140.  
  141.