Subversion Repositories HelenOS

Rev

Rev 2052 | Rev 2123 | 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.  
  33. /**
  34.  * @file
  35.  * @brief   Slab allocator.
  36.  *
  37.  * The slab allocator is closely modelled after OpenSolaris slab allocator.
  38.  * @see http://www.usenix.org/events/usenix01/full_papers/bonwick/bonwick_html/
  39.  *
  40.  * with the following exceptions:
  41.  * @li empty slabs are deallocated immediately
  42.  *     (in Linux they are kept in linked list, in Solaris ???)
  43.  * @li empty magazines are deallocated when not needed
  44.  *     (in Solaris they are held in linked list in slab cache)
  45.  *
  46.  * Following features are not currently supported but would be easy to do:
  47.  * @li cache coloring
  48.  * @li dynamic magazine growing (different magazine sizes are already
  49.  *     supported, but we would need to adjust allocation strategy)
  50.  *
  51.  * The slab allocator supports per-CPU caches ('magazines') to facilitate
  52.  * good SMP scaling.
  53.  *
  54.  * When a new object is being allocated, it is first checked, if it is
  55.  * available in a CPU-bound magazine. If it is not found there, it is
  56.  * allocated from a CPU-shared slab - if a partially full one is found,
  57.  * it is used, otherwise a new one is allocated.
  58.  *
  59.  * When an object is being deallocated, it is put to a CPU-bound magazine.
  60.  * If there is no such magazine, a new one is allocated (if this fails,
  61.  * the object is deallocated into slab). If the magazine is full, it is
  62.  * put into cpu-shared list of magazines and a new one is allocated.
  63.  *
  64.  * The CPU-bound magazine is actually a pair of magazines in order to avoid
  65.  * thrashing when somebody is allocating/deallocating 1 item at the magazine
  66.  * size boundary. LIFO order is enforced, which should avoid fragmentation
  67.  * as much as possible.
  68.  *  
  69.  * Every cache contains list of full slabs and list of partially full slabs.
  70.  * Empty slabs are immediately freed (thrashing will be avoided because
  71.  * of magazines).
  72.  *
  73.  * The slab information structure is kept inside the data area, if possible.
  74.  * The cache can be marked that it should not use magazines. This is used
  75.  * only for slab related caches to avoid deadlocks and infinite recursion
  76.  * (the slab allocator uses itself for allocating all it's control structures).
  77.  *
  78.  * The slab allocator allocates a lot of space and does not free it. When
  79.  * the frame allocator fails to allocate a frame, it calls slab_reclaim().
  80.  * It tries 'light reclaim' first, then brutal reclaim. The light reclaim
  81.  * releases slabs from cpu-shared magazine-list, until at least 1 slab
  82.  * is deallocated in each cache (this algorithm should probably change).
  83.  * The brutal reclaim removes all cached objects, even from CPU-bound
  84.  * magazines.
  85.  *
  86.  * @todo
  87.  * For better CPU-scaling the magazine allocation strategy should
  88.  * be extended. Currently, if the cache does not have magazine, it asks
  89.  * for non-cpu cached magazine cache to provide one. It might be feasible
  90.  * to add cpu-cached magazine cache (which would allocate it's magazines
  91.  * from non-cpu-cached mag. cache). This would provide a nice per-cpu
  92.  * buffer. The other possibility is to use the per-cache
  93.  * 'empty-magazine-list', which decreases competing for 1 per-system
  94.  * magazine cache.
  95.  *
  96.  * @todo
  97.  * it might be good to add granularity of locks even to slab level,
  98.  * we could then try_spinlock over all partial slabs and thus improve
  99.  * scalability even on slab level
  100.  */
  101.  
  102. #include <synch/spinlock.h>
  103. #include <mm/slab.h>
  104. #include <adt/list.h>
  105. #include <memstr.h>
  106. #include <align.h>
  107. #include <mm/frame.h>
  108. #include <config.h>
  109. #include <print.h>
  110. #include <arch.h>
  111. #include <panic.h>
  112. #include <debug.h>
  113. #include <bitops.h>
  114.  
  115. SPINLOCK_INITIALIZE(slab_cache_lock);
  116. static LIST_INITIALIZE(slab_cache_list);
  117.  
  118. /** Magazine cache */
  119. static slab_cache_t mag_cache;
  120. /** Cache for cache descriptors */
  121. static slab_cache_t slab_cache_cache;
  122. /** Cache for external slab descriptors
  123.  * This time we want per-cpu cache, so do not make it static
  124.  * - using slab for internal slab structures will not deadlock,
  125.  *   as all slab structures are 'small' - control structures of
  126.  *   their caches do not require further allocation
  127.  */
  128. static slab_cache_t *slab_extern_cache;
  129. /** Caches for malloc */
  130. static slab_cache_t *malloc_caches[SLAB_MAX_MALLOC_W-SLAB_MIN_MALLOC_W+1];
  131. char *malloc_names[] =  {
  132.     "malloc-16","malloc-32","malloc-64","malloc-128",
  133.     "malloc-256","malloc-512","malloc-1K","malloc-2K",
  134.     "malloc-4K","malloc-8K","malloc-16K","malloc-32K",
  135.     "malloc-64K","malloc-128K","malloc-256K"
  136. };
  137.  
  138. /** Slab descriptor */
  139. typedef struct {
  140.     slab_cache_t *cache;    /**< Pointer to parent cache. */
  141.     link_t link;        /**< List of full/partial slabs. */
  142.     void *start;        /**< Start address of first available item. */
  143.     count_t available;  /**< Count of available items in this slab. */
  144.     index_t nextavail;  /**< The index of next available item. */
  145. }slab_t;
  146.  
  147. #ifdef CONFIG_DEBUG
  148. static int _slab_initialized = 0;
  149. #endif
  150.  
  151. /**************************************/
  152. /* Slab allocation functions          */
  153.  
  154. /**
  155.  * Allocate frames for slab space and initialize
  156.  *
  157.  */
  158. static slab_t * slab_space_alloc(slab_cache_t *cache, int flags)
  159. {
  160.     void *data;
  161.     slab_t *slab;
  162.     size_t fsize;
  163.     int i;
  164.     int zone=0;
  165.    
  166.     data = frame_alloc_generic(cache->order, FRAME_KA | flags, &zone);
  167.     if (!data) {
  168.         return NULL;
  169.     }
  170.     if (! (cache->flags & SLAB_CACHE_SLINSIDE)) {
  171.         slab = slab_alloc(slab_extern_cache, flags);
  172.         if (!slab) {
  173.             frame_free(KA2PA(data));
  174.             return NULL;
  175.         }
  176.     } else {
  177.         fsize = (PAGE_SIZE << cache->order);
  178.         slab = data + fsize - sizeof(*slab);
  179.     }
  180.    
  181.     /* Fill in slab structures */
  182.     for (i=0; i < (1 << cache->order); i++)
  183.         frame_set_parent(ADDR2PFN(KA2PA(data))+i, slab, zone);
  184.  
  185.     slab->start = data;
  186.     slab->available = cache->objects;
  187.     slab->nextavail = 0;
  188.     slab->cache = cache;
  189.  
  190.     for (i=0; i<cache->objects;i++)
  191.         *((int *) (slab->start + i*cache->size)) = i+1;
  192.  
  193.     atomic_inc(&cache->allocated_slabs);
  194.     return slab;
  195. }
  196.  
  197. /**
  198.  * Deallocate space associated with slab
  199.  *
  200.  * @return number of freed frames
  201.  */
  202. static count_t slab_space_free(slab_cache_t *cache, slab_t *slab)
  203. {
  204.     frame_free(KA2PA(slab->start));
  205.     if (! (cache->flags & SLAB_CACHE_SLINSIDE))
  206.         slab_free(slab_extern_cache, slab);
  207.  
  208.     atomic_dec(&cache->allocated_slabs);
  209.    
  210.     return 1 << cache->order;
  211. }
  212.  
  213. /** Map object to slab structure */
  214. static slab_t * obj2slab(void *obj)
  215. {
  216.     return (slab_t *)frame_get_parent(ADDR2PFN(KA2PA(obj)), 0);
  217. }
  218.  
  219. /**************************************/
  220. /* Slab functions */
  221.  
  222.  
  223. /**
  224.  * Return object to slab and call a destructor
  225.  *
  226.  * @param slab If the caller knows directly slab of the object, otherwise NULL
  227.  *
  228.  * @return Number of freed pages
  229.  */
  230. static count_t slab_obj_destroy(slab_cache_t *cache, void *obj,
  231.                 slab_t *slab)
  232. {
  233.     int freed = 0;
  234.  
  235.     if (!slab)
  236.         slab = obj2slab(obj);
  237.  
  238.     ASSERT(slab->cache == cache);
  239.  
  240.     if (cache->destructor)
  241.         freed = cache->destructor(obj);
  242.    
  243.     spinlock_lock(&cache->slablock);
  244.     ASSERT(slab->available < cache->objects);
  245.  
  246.     *((int *)obj) = slab->nextavail;
  247.     slab->nextavail = (obj - slab->start)/cache->size;
  248.     slab->available++;
  249.  
  250.     /* Move it to correct list */
  251.     if (slab->available == cache->objects) {
  252.         /* Free associated memory */
  253.         list_remove(&slab->link);
  254.         spinlock_unlock(&cache->slablock);
  255.  
  256.         return freed + slab_space_free(cache, slab);
  257.  
  258.     } else if (slab->available == 1) {
  259.         /* It was in full, move to partial */
  260.         list_remove(&slab->link);
  261.         list_prepend(&slab->link, &cache->partial_slabs);
  262.     }
  263.     spinlock_unlock(&cache->slablock);
  264.     return freed;
  265. }
  266.  
  267. /**
  268.  * Take new object from slab or create new if needed
  269.  *
  270.  * @return Object address or null
  271.  */
  272. static void * slab_obj_create(slab_cache_t *cache, int flags)
  273. {
  274.     slab_t *slab;
  275.     void *obj;
  276.  
  277.     spinlock_lock(&cache->slablock);
  278.  
  279.     if (list_empty(&cache->partial_slabs)) {
  280.         /* Allow recursion and reclaiming
  281.          * - this should work, as the slab control structures
  282.          *   are small and do not need to allocate with anything
  283.          *   other than frame_alloc when they are allocating,
  284.          *   that's why we should get recursion at most 1-level deep
  285.          */
  286.         spinlock_unlock(&cache->slablock);
  287.         slab = slab_space_alloc(cache, flags);
  288.         if (!slab)
  289.             return NULL;
  290.         spinlock_lock(&cache->slablock);
  291.     } else {
  292.         slab = list_get_instance(cache->partial_slabs.next, slab_t, link);
  293.         list_remove(&slab->link);
  294.     }
  295.     obj = slab->start + slab->nextavail * cache->size;
  296.     slab->nextavail = *((int *)obj);
  297.     slab->available--;
  298.  
  299.     if (!slab->available)
  300.         list_prepend(&slab->link, &cache->full_slabs);
  301.     else
  302.         list_prepend(&slab->link, &cache->partial_slabs);
  303.  
  304.     spinlock_unlock(&cache->slablock);
  305.  
  306.     if (cache->constructor && cache->constructor(obj, flags)) {
  307.         /* Bad, bad, construction failed */
  308.         slab_obj_destroy(cache, obj, slab);
  309.         return NULL;
  310.     }
  311.     return obj;
  312. }
  313.  
  314. /**************************************/
  315. /* CPU-Cache slab functions */
  316.  
  317. /**
  318.  * Finds a full magazine in cache, takes it from list
  319.  * and returns it
  320.  *
  321.  * @param first If true, return first, else last mag
  322.  */
  323. static slab_magazine_t * get_mag_from_cache(slab_cache_t *cache,
  324.                         int first)
  325. {
  326.     slab_magazine_t *mag = NULL;
  327.     link_t *cur;
  328.  
  329.     spinlock_lock(&cache->maglock);
  330.     if (!list_empty(&cache->magazines)) {
  331.         if (first)
  332.             cur = cache->magazines.next;
  333.         else
  334.             cur = cache->magazines.prev;
  335.         mag = list_get_instance(cur, slab_magazine_t, link);
  336.         list_remove(&mag->link);
  337.         atomic_dec(&cache->magazine_counter);
  338.     }
  339.     spinlock_unlock(&cache->maglock);
  340.     return mag;
  341. }
  342.  
  343. /** Prepend magazine to magazine list in cache */
  344. static void put_mag_to_cache(slab_cache_t *cache, slab_magazine_t *mag)
  345. {
  346.     spinlock_lock(&cache->maglock);
  347.  
  348.     list_prepend(&mag->link, &cache->magazines);
  349.     atomic_inc(&cache->magazine_counter);
  350.    
  351.     spinlock_unlock(&cache->maglock);
  352. }
  353.  
  354. /**
  355.  * Free all objects in magazine and free memory associated with magazine
  356.  *
  357.  * @return Number of freed pages
  358.  */
  359. static count_t magazine_destroy(slab_cache_t *cache,
  360.                 slab_magazine_t *mag)
  361. {
  362.     int i;
  363.     count_t frames = 0;
  364.  
  365.     for (i=0;i < mag->busy; i++) {
  366.         frames += slab_obj_destroy(cache, mag->objs[i], NULL);
  367.         atomic_dec(&cache->cached_objs);
  368.     }
  369.    
  370.     slab_free(&mag_cache, mag);
  371.  
  372.     return frames;
  373. }
  374.  
  375. /**
  376.  * Find full magazine, set it as current and return it
  377.  *
  378.  * Assume cpu_magazine lock is held
  379.  */
  380. static slab_magazine_t * get_full_current_mag(slab_cache_t *cache)
  381. {
  382.     slab_magazine_t *cmag, *lastmag, *newmag;
  383.  
  384.     cmag = cache->mag_cache[CPU->id].current;
  385.     lastmag = cache->mag_cache[CPU->id].last;
  386.     if (cmag) { /* First try local CPU magazines */
  387.         if (cmag->busy)
  388.             return cmag;
  389.  
  390.         if (lastmag && lastmag->busy) {
  391.             cache->mag_cache[CPU->id].current = lastmag;
  392.             cache->mag_cache[CPU->id].last = cmag;
  393.             return lastmag;
  394.         }
  395.     }
  396.     /* Local magazines are empty, import one from magazine list */
  397.     newmag = get_mag_from_cache(cache, 1);
  398.     if (!newmag)
  399.         return NULL;
  400.  
  401.     if (lastmag)
  402.         magazine_destroy(cache, lastmag);
  403.  
  404.     cache->mag_cache[CPU->id].last = cmag;
  405.     cache->mag_cache[CPU->id].current = newmag;
  406.     return newmag;
  407. }
  408.  
  409. /**
  410.  * Try to find object in CPU-cache magazines
  411.  *
  412.  * @return Pointer to object or NULL if not available
  413.  */
  414. static void * magazine_obj_get(slab_cache_t *cache)
  415. {
  416.     slab_magazine_t *mag;
  417.     void *obj;
  418.  
  419.     if (!CPU)
  420.         return NULL;
  421.  
  422.     spinlock_lock(&cache->mag_cache[CPU->id].lock);
  423.  
  424.     mag = get_full_current_mag(cache);
  425.     if (!mag) {
  426.         spinlock_unlock(&cache->mag_cache[CPU->id].lock);
  427.         return NULL;
  428.     }
  429.     obj = mag->objs[--mag->busy];
  430.     spinlock_unlock(&cache->mag_cache[CPU->id].lock);
  431.     atomic_dec(&cache->cached_objs);
  432.    
  433.     return obj;
  434. }
  435.  
  436. /**
  437.  * Assure that the current magazine is empty, return pointer to it, or NULL if
  438.  * no empty magazine is available and cannot be allocated
  439.  *
  440.  * Assume mag_cache[CPU->id].lock is held
  441.  *
  442.  * We have 2 magazines bound to processor.
  443.  * First try the current.
  444.  *  If full, try the last.
  445.  *   If full, put to magazines list.
  446.  *   allocate new, exchange last & current
  447.  *
  448.  */
  449. static slab_magazine_t * make_empty_current_mag(slab_cache_t *cache)
  450. {
  451.     slab_magazine_t *cmag,*lastmag,*newmag;
  452.  
  453.     cmag = cache->mag_cache[CPU->id].current;
  454.     lastmag = cache->mag_cache[CPU->id].last;
  455.  
  456.     if (cmag) {
  457.         if (cmag->busy < cmag->size)
  458.             return cmag;
  459.         if (lastmag && lastmag->busy < lastmag->size) {
  460.             cache->mag_cache[CPU->id].last = cmag;
  461.             cache->mag_cache[CPU->id].current = lastmag;
  462.             return lastmag;
  463.         }
  464.     }
  465.     /* current | last are full | nonexistent, allocate new */
  466.     /* We do not want to sleep just because of caching */
  467.     /* Especially we do not want reclaiming to start, as
  468.      * this would deadlock */
  469.     newmag = slab_alloc(&mag_cache, FRAME_ATOMIC | FRAME_NO_RECLAIM);
  470.     if (!newmag)
  471.         return NULL;
  472.     newmag->size = SLAB_MAG_SIZE;
  473.     newmag->busy = 0;
  474.  
  475.     /* Flush last to magazine list */
  476.     if (lastmag)
  477.         put_mag_to_cache(cache, lastmag);
  478.  
  479.     /* Move current as last, save new as current */
  480.     cache->mag_cache[CPU->id].last = cmag; 
  481.     cache->mag_cache[CPU->id].current = newmag;
  482.  
  483.     return newmag;
  484. }
  485.  
  486. /**
  487.  * Put object into CPU-cache magazine
  488.  *
  489.  * @return 0 - success, -1 - could not get memory
  490.  */
  491. static int magazine_obj_put(slab_cache_t *cache, void *obj)
  492. {
  493.     slab_magazine_t *mag;
  494.  
  495.     if (!CPU)
  496.         return -1;
  497.  
  498.     spinlock_lock(&cache->mag_cache[CPU->id].lock);
  499.  
  500.     mag = make_empty_current_mag(cache);
  501.     if (!mag) {
  502.         spinlock_unlock(&cache->mag_cache[CPU->id].lock);
  503.         return -1;
  504.     }
  505.    
  506.     mag->objs[mag->busy++] = obj;
  507.  
  508.     spinlock_unlock(&cache->mag_cache[CPU->id].lock);
  509.     atomic_inc(&cache->cached_objs);
  510.     return 0;
  511. }
  512.  
  513.  
  514. /**************************************/
  515. /* Slab cache functions */
  516.  
  517. /** Return number of objects that fit in certain cache size */
  518. static int comp_objects(slab_cache_t *cache)
  519. {
  520.     if (cache->flags & SLAB_CACHE_SLINSIDE)
  521.         return ((PAGE_SIZE << cache->order) - sizeof(slab_t)) / cache->size;
  522.     else
  523.         return (PAGE_SIZE << cache->order) / cache->size;
  524. }
  525.  
  526. /** Return wasted space in slab */
  527. static int badness(slab_cache_t *cache)
  528. {
  529.     int objects;
  530.     int ssize;
  531.  
  532.     objects = comp_objects(cache);
  533.     ssize = PAGE_SIZE << cache->order;
  534.     if (cache->flags & SLAB_CACHE_SLINSIDE)
  535.         ssize -= sizeof(slab_t);
  536.     return ssize - objects*cache->size;
  537. }
  538.  
  539. /**
  540.  * Initialize mag_cache structure in slab cache
  541.  */
  542. static void make_magcache(slab_cache_t *cache)
  543. {
  544.     int i;
  545.    
  546.     ASSERT(_slab_initialized >= 2);
  547.  
  548.     cache->mag_cache = malloc(sizeof(slab_mag_cache_t)*config.cpu_count,0);
  549.     for (i=0; i < config.cpu_count; i++) {
  550.         memsetb((uintptr_t)&cache->mag_cache[i],
  551.             sizeof(cache->mag_cache[i]), 0);
  552.         spinlock_initialize(&cache->mag_cache[i].lock,
  553.                     "slab_maglock_cpu");
  554.     }
  555. }
  556.  
  557. /** Initialize allocated memory as a slab cache */
  558. static void
  559. _slab_cache_create(slab_cache_t *cache,
  560.            char *name,
  561.            size_t size,
  562.            size_t align,
  563.            int (*constructor)(void *obj, int kmflag),
  564.            int (*destructor)(void *obj),
  565.            int flags)
  566. {
  567.     int pages;
  568.     ipl_t ipl;
  569.  
  570.     memsetb((uintptr_t)cache, sizeof(*cache), 0);
  571.     cache->name = name;
  572.  
  573.     if (align < sizeof(unative_t))
  574.         align = sizeof(unative_t);
  575.     size = ALIGN_UP(size, align);
  576.        
  577.     cache->size = size;
  578.  
  579.     cache->constructor = constructor;
  580.     cache->destructor = destructor;
  581.     cache->flags = flags;
  582.  
  583.     list_initialize(&cache->full_slabs);
  584.     list_initialize(&cache->partial_slabs);
  585.     list_initialize(&cache->magazines);
  586.     spinlock_initialize(&cache->slablock, "slab_lock");
  587.     spinlock_initialize(&cache->maglock, "slab_maglock");
  588.     if (! (cache->flags & SLAB_CACHE_NOMAGAZINE))
  589.         make_magcache(cache);
  590.  
  591.     /* Compute slab sizes, object counts in slabs etc. */
  592.     if (cache->size < SLAB_INSIDE_SIZE)
  593.         cache->flags |= SLAB_CACHE_SLINSIDE;
  594.  
  595.     /* Minimum slab order */
  596.     pages = SIZE2FRAMES(cache->size);
  597.     /* We need the 2^order >= pages */
  598.     if (pages == 1)
  599.         cache->order = 0;
  600.     else
  601.         cache->order = fnzb(pages-1)+1;
  602.  
  603.     while (badness(cache) > SLAB_MAX_BADNESS(cache)) {
  604.         cache->order += 1;
  605.     }
  606.     cache->objects = comp_objects(cache);
  607.     /* If info fits in, put it inside */
  608.     if (badness(cache) > sizeof(slab_t))
  609.         cache->flags |= SLAB_CACHE_SLINSIDE;
  610.  
  611.     /* Add cache to cache list */
  612.     ipl = interrupts_disable();
  613.     spinlock_lock(&slab_cache_lock);
  614.  
  615.     list_append(&cache->link, &slab_cache_list);
  616.  
  617.     spinlock_unlock(&slab_cache_lock);
  618.     interrupts_restore(ipl);
  619. }
  620.  
  621. /** Create slab cache  */
  622. slab_cache_t * slab_cache_create(char *name,
  623.                  size_t size,
  624.                  size_t align,
  625.                  int (*constructor)(void *obj, int kmflag),
  626.                  int (*destructor)(void *obj),
  627.                  int flags)
  628. {
  629.     slab_cache_t *cache;
  630.  
  631.     cache = slab_alloc(&slab_cache_cache, 0);
  632.     _slab_cache_create(cache, name, size, align, constructor, destructor,
  633.                flags);
  634.     return cache;
  635. }
  636.  
  637. /**
  638.  * Reclaim space occupied by objects that are already free
  639.  *
  640.  * @param flags If contains SLAB_RECLAIM_ALL, do aggressive freeing
  641.  * @return Number of freed pages
  642.  */
  643. static count_t _slab_reclaim(slab_cache_t *cache, int flags)
  644. {
  645.     int i;
  646.     slab_magazine_t *mag;
  647.     count_t frames = 0;
  648.     int magcount;
  649.    
  650.     if (cache->flags & SLAB_CACHE_NOMAGAZINE)
  651.         return 0; /* Nothing to do */
  652.  
  653.     /* We count up to original magazine count to avoid
  654.      * endless loop
  655.      */
  656.     magcount = atomic_get(&cache->magazine_counter);
  657.     while (magcount-- && (mag=get_mag_from_cache(cache,0))) {
  658.         frames += magazine_destroy(cache,mag);
  659.         if (!(flags & SLAB_RECLAIM_ALL) && frames)
  660.             break;
  661.     }
  662.    
  663.     if (flags & SLAB_RECLAIM_ALL) {
  664.         /* Free cpu-bound magazines */
  665.         /* Destroy CPU magazines */
  666.         for (i=0; i<config.cpu_count; i++) {
  667.             spinlock_lock(&cache->mag_cache[i].lock);
  668.  
  669.             mag = cache->mag_cache[i].current;
  670.             if (mag)
  671.                 frames += magazine_destroy(cache, mag);
  672.             cache->mag_cache[i].current = NULL;
  673.            
  674.             mag = cache->mag_cache[i].last;
  675.             if (mag)
  676.                 frames += magazine_destroy(cache, mag);
  677.             cache->mag_cache[i].last = NULL;
  678.  
  679.             spinlock_unlock(&cache->mag_cache[i].lock);
  680.         }
  681.     }
  682.  
  683.     return frames;
  684. }
  685.  
  686. /** Check that there are no slabs and remove cache from system  */
  687. void slab_cache_destroy(slab_cache_t *cache)
  688. {
  689.     ipl_t ipl;
  690.  
  691.     /* First remove cache from link, so that we don't need
  692.      * to disable interrupts later
  693.      */
  694.  
  695.     ipl = interrupts_disable();
  696.     spinlock_lock(&slab_cache_lock);
  697.  
  698.     list_remove(&cache->link);
  699.  
  700.     spinlock_unlock(&slab_cache_lock);
  701.     interrupts_restore(ipl);
  702.  
  703.     /* Do not lock anything, we assume the software is correct and
  704.      * does not touch the cache when it decides to destroy it */
  705.    
  706.     /* Destroy all magazines */
  707.     _slab_reclaim(cache, SLAB_RECLAIM_ALL);
  708.  
  709.     /* All slabs must be empty */
  710.     if (!list_empty(&cache->full_slabs) \
  711.         || !list_empty(&cache->partial_slabs))
  712.         panic("Destroying cache that is not empty.");
  713.  
  714.     if (!(cache->flags & SLAB_CACHE_NOMAGAZINE))
  715.         free(cache->mag_cache);
  716.     slab_free(&slab_cache_cache, cache);
  717. }
  718.  
  719. /** Allocate new object from cache - if no flags given, always returns
  720.     memory */
  721. void * slab_alloc(slab_cache_t *cache, int flags)
  722. {
  723.     ipl_t ipl;
  724.     void *result = NULL;
  725.    
  726.     /* Disable interrupts to avoid deadlocks with interrupt handlers */
  727.     ipl = interrupts_disable();
  728.  
  729.     if (!(cache->flags & SLAB_CACHE_NOMAGAZINE)) {
  730.         result = magazine_obj_get(cache);
  731.     }
  732.     if (!result)
  733.         result = slab_obj_create(cache, flags);
  734.  
  735.     interrupts_restore(ipl);
  736.  
  737.     if (result)
  738.         atomic_inc(&cache->allocated_objs);
  739.  
  740.     return result;
  741. }
  742.  
  743. /** Return object to cache, use slab if known  */
  744. static void _slab_free(slab_cache_t *cache, void *obj, slab_t *slab)
  745. {
  746.     ipl_t ipl;
  747.  
  748.     ipl = interrupts_disable();
  749.  
  750.     if ((cache->flags & SLAB_CACHE_NOMAGAZINE) \
  751.         || magazine_obj_put(cache, obj)) {
  752.  
  753.         slab_obj_destroy(cache, obj, slab);
  754.  
  755.     }
  756.     interrupts_restore(ipl);
  757.     atomic_dec(&cache->allocated_objs);
  758. }
  759.  
  760. /** Return slab object to cache */
  761. void slab_free(slab_cache_t *cache, void *obj)
  762. {
  763.     _slab_free(cache,obj,NULL);
  764. }
  765.  
  766. /* Go through all caches and reclaim what is possible */
  767. count_t slab_reclaim(int flags)
  768. {
  769.     slab_cache_t *cache;
  770.     link_t *cur;
  771.     count_t frames = 0;
  772.  
  773.     spinlock_lock(&slab_cache_lock);
  774.  
  775.     /* TODO: Add assert, that interrupts are disabled, otherwise
  776.      * memory allocation from interrupts can deadlock.
  777.      */
  778.  
  779.     for (cur = slab_cache_list.next;cur!=&slab_cache_list; cur=cur->next) {
  780.         cache = list_get_instance(cur, slab_cache_t, link);
  781.         frames += _slab_reclaim(cache, flags);
  782.     }
  783.  
  784.     spinlock_unlock(&slab_cache_lock);
  785.  
  786.     return frames;
  787. }
  788.  
  789.  
  790. /* Print list of slabs */
  791. void slab_print_list(void)
  792. {
  793.     slab_cache_t *cache;
  794.     link_t *cur;
  795.     ipl_t ipl;
  796.    
  797.     ipl = interrupts_disable();
  798.     spinlock_lock(&slab_cache_lock);
  799.     printf("slab name        size     pages  obj/pg slabs  cached allocated ctl\n");
  800.     printf("---------------- -------- ------ ------ ------ ------ --------- ---\n");
  801.    
  802.     for (cur = slab_cache_list.next; cur != &slab_cache_list; cur = cur->next) {
  803.         cache = list_get_instance(cur, slab_cache_t, link);
  804.        
  805.         printf("%-16s %8zd %6zd %6zd %6zd %6zd %9zd %-3s\n", cache->name, cache->size, (1 << cache->order), cache->objects, atomic_get(&cache->allocated_slabs), atomic_get(&cache->cached_objs), atomic_get(&cache->allocated_objs), cache->flags & SLAB_CACHE_SLINSIDE ? "in" : "out");
  806.     }
  807.     spinlock_unlock(&slab_cache_lock);
  808.     interrupts_restore(ipl);
  809. }
  810.  
  811. void slab_cache_init(void)
  812. {
  813.     int i, size;
  814.  
  815.     /* Initialize magazine cache */
  816.     _slab_cache_create(&mag_cache,
  817.                "slab_magazine",
  818.                sizeof(slab_magazine_t)+SLAB_MAG_SIZE*sizeof(void*),
  819.                sizeof(uintptr_t),
  820.                NULL, NULL,
  821.                SLAB_CACHE_NOMAGAZINE | SLAB_CACHE_SLINSIDE);
  822.     /* Initialize slab_cache cache */
  823.     _slab_cache_create(&slab_cache_cache,
  824.                "slab_cache",
  825.                sizeof(slab_cache_cache),
  826.                sizeof(uintptr_t),
  827.                NULL, NULL,
  828.                SLAB_CACHE_NOMAGAZINE | SLAB_CACHE_SLINSIDE);
  829.     /* Initialize external slab cache */
  830.     slab_extern_cache = slab_cache_create("slab_extern",
  831.                           sizeof(slab_t),
  832.                           0, NULL, NULL,
  833.                           SLAB_CACHE_SLINSIDE | SLAB_CACHE_MAGDEFERRED);
  834.  
  835.     /* Initialize structures for malloc */
  836.     for (i=0, size=(1<<SLAB_MIN_MALLOC_W);
  837.          i < (SLAB_MAX_MALLOC_W-SLAB_MIN_MALLOC_W+1);
  838.          i++, size <<= 1) {
  839.         malloc_caches[i] = slab_cache_create(malloc_names[i],
  840.                              size, 0,
  841.                              NULL,NULL, SLAB_CACHE_MAGDEFERRED);
  842.     }
  843. #ifdef CONFIG_DEBUG      
  844.     _slab_initialized = 1;
  845. #endif
  846. }
  847.  
  848. /** Enable cpu_cache
  849.  *
  850.  * Kernel calls this function, when it knows the real number of
  851.  * processors.
  852.  * Allocate slab for cpucache and enable it on all existing
  853.  * slabs that are SLAB_CACHE_MAGDEFERRED
  854.  */
  855. void slab_enable_cpucache(void)
  856. {
  857.     link_t *cur;
  858.     slab_cache_t *s;
  859.  
  860. #ifdef CONFIG_DEBUG
  861.     _slab_initialized = 2;
  862. #endif
  863.  
  864.     spinlock_lock(&slab_cache_lock);
  865.    
  866.     for (cur=slab_cache_list.next; cur != &slab_cache_list;cur=cur->next){
  867.         s = list_get_instance(cur, slab_cache_t, link);
  868.         if ((s->flags & SLAB_CACHE_MAGDEFERRED) != SLAB_CACHE_MAGDEFERRED)
  869.             continue;
  870.         make_magcache(s);
  871.         s->flags &= ~SLAB_CACHE_MAGDEFERRED;
  872.     }
  873.  
  874.     spinlock_unlock(&slab_cache_lock);
  875. }
  876.  
  877. /**************************************/
  878. /* kalloc/kfree functions             */
  879. void * malloc(unsigned int size, int flags)
  880. {
  881.     int idx;
  882.  
  883.     ASSERT(_slab_initialized);
  884.     ASSERT(size && size <= (1 << SLAB_MAX_MALLOC_W));
  885.    
  886.     if (size < (1 << SLAB_MIN_MALLOC_W))
  887.         size = (1 << SLAB_MIN_MALLOC_W);
  888.  
  889.     idx = fnzb(size-1) - SLAB_MIN_MALLOC_W + 1;
  890.  
  891.     return slab_alloc(malloc_caches[idx], flags);
  892. }
  893.  
  894. void free(void *obj)
  895. {
  896.     slab_t *slab;
  897.  
  898.     if (!obj)
  899.         return;
  900.  
  901.     slab = obj2slab(obj);
  902.     _slab_free(slab->cache, obj, slab);
  903. }
  904.  
  905. /** @}
  906.  */
  907.