sys/cam/ctl/ctl_mem_pool.h

   1 /*-
   2  * Copyright (c) 2003, 2004 Silicon Graphics International Corp.
   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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    substantially similar to the "NO WARRANTY" disclaimer below
  13  *    ("Disclaimer") and any redistribution must be conditioned upon
  14  *    including a substantially similar Disclaimer requirement for further
  15  *    binary redistribution.
  16  *
  17  * NO WARRANTY
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  27  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGES.
  29  *
  30  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_mem_pool.h#1 $
  31  * $FreeBSD$
  32  */
  33 /*
  34  * CAM Target Layer memory pool code.
  35  *
  36  * Author: Ken Merry <ken@FreeBSD.org>
  37  */
  38
  39 #ifndef _CTL_MEMPOOL_H_
  40 #define _CTL_MEMPOOL_H_
  41
  42 typedef enum {
  43         CTL_MEM_POOL_NONE,
  44         CTL_MEM_POOL_PERM_GROW
  45 } ctl_mem_pool_flags;
  46
  47 struct ctl_mem_pool {
  48         ctl_mem_pool_flags flags;
  49         int chunk_size;
  50         int grow_inc;
  51         struct mtx lock;
  52         struct cv wait_mem;
  53         STAILQ_HEAD(, ctl_mem_element) free_mem_list;
  54 };
  55
  56 typedef enum {
  57         CTL_MEM_ELEMENT_NONE,
  58         CTL_MEM_ELEMENT_PREALLOC
  59 } ctl_mem_element_flags;
  60
  61 struct ctl_mem_element {
  62         ctl_mem_element_flags flags;
  63         struct ctl_mem_pool *pool;
  64         uint8_t *bytes;
  65         STAILQ_ENTRY(ctl_mem_element) links;
  66 };
  67
  68 #ifdef  _KERNEL
  69
  70 MALLOC_DECLARE(M_CTL_POOL);
  71
  72 int ctl_init_mem_pool(struct ctl_mem_pool *pool, int chunk_size,
  73                       ctl_mem_pool_flags flags, int grow_inc,
  74                       int initial_pool_size);
  75 struct ctl_mem_element *ctl_alloc_mem_element(struct ctl_mem_pool *pool,
  76                                               int can_wait);
  77 void ctl_free_mem_element(struct ctl_mem_element *mem);
  78 int ctl_grow_mem_pool(struct ctl_mem_pool *pool, int count,
  79                       int can_wait);
  80 int ctl_shrink_mem_pool(struct ctl_mem_pool *pool);
  81 #endif  /* _KERNEL */
  82
  83 #endif  /* _CTL_MEMPOOL_H_ */