osfmk/kern/zalloc.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   zalloc.h
  60  *      Author: Avadis Tevanian, Jr.
  61  *      Date:    1985
  62  *
  63  */
  64
  65 #ifdef  KERNEL_PRIVATE
  66
  67 #ifndef _KERN_ZALLOC_H_
  68 #define _KERN_ZALLOC_H_
  69
  70 #include <mach/machine/vm_types.h>
  71 #include <kern/kern_types.h>
  72 #include <sys/cdefs.h>
  73
  74 #ifdef  MACH_KERNEL_PRIVATE
  75
  76 #include <zone_debug.h>
  77 #include <mach_kdb.h>
  78 #include <kern/lock.h>
  79 #include <kern/locks.h>
  80 #include <kern/queue.h>
  81 #include <kern/call_entry.h>
  82
  83 /*
  84  *      A zone is a collection of fixed size blocks for which there
  85  *      is fast allocation/deallocation access.  Kernel routines can
  86  *      use zones to manage data structures dynamically, creating a zone
  87  *      for each type of data structure to be managed.
  88  *
  89  */
  90
  91 struct zone {
  92         int             count;          /* Number of elements used now */
  93         vm_offset_t     free_elements;
  94         decl_lck_mtx_data(,lock)        /* zone lock */
  95         lck_mtx_ext_t   lock_ext;       /* placeholder for indirect mutex */
  96         lck_attr_t      lock_attr;      /* zone lock attribute */
  97         lck_grp_t       lock_grp;       /* zone lock group */
  98         lck_grp_attr_t  lock_grp_attr;  /* zone lock group attribute */
  99         vm_size_t       cur_size;       /* current memory utilization */
 100         vm_size_t       max_size;       /* how large can this zone grow */
 101         vm_size_t       elem_size;      /* size of an element */
 102         vm_size_t       alloc_size;     /* size used for more memory */
 103         unsigned int
 104         /* boolean_t */ exhaustible :1, /* (F) merely return if empty? */
 105         /* boolean_t */ collectable :1, /* (F) garbage collect empty pages */
 106         /* boolean_t */ expandable :1,  /* (T) expand zone (with message)? */
 107         /* boolean_t */ allows_foreign :1,/* (F) allow non-zalloc space */
 108         /* boolean_t */ doing_alloc :1, /* is zone expanding now? */
 109         /* boolean_t */ waiting :1,     /* is thread waiting for expansion? */
 110         /* boolean_t */ async_pending :1,       /* asynchronous allocation pending? */
 111         /* boolean_t */ doing_gc :1,    /* garbage collect in progress? */
 112         /* boolean_t */ noencrypt :1;
 113         struct zone *   next_zone;      /* Link for all-zones list */
 114         call_entry_data_t       call_async_alloc;       /* callout for asynchronous alloc */
 115         const char      *zone_name;     /* a name for the zone */
 116 #if     ZONE_DEBUG
 117         queue_head_t    active_zones;   /* active elements */
 118 #endif  /* ZONE_DEBUG */
 119 };
 120
 121 extern void             zone_gc(void);
 122 extern void             consider_zone_gc(boolean_t);
 123
 124 /* Steal memory for zone module */
 125 extern void             zone_steal_memory(void);
 126
 127 /* Bootstrap zone module (create zone zone) */
 128 extern void             zone_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 129
 130 /* Init zone module */
 131 extern void             zone_init(
 132                                         vm_size_t       map_size) __attribute__((section("__TEXT, initcode")));
 133
 134 /* Stack use statistics */
 135 extern void             stack_fake_zone_info(
 136                                         int                     *count,
 137                                         vm_size_t       *cur_size,
 138                                         vm_size_t       *max_size,
 139                                         vm_size_t       *elem_size,
 140                                         vm_size_t       *alloc_size,
 141                                         int                     *collectable,
 142                                         int                     *exhaustable);
 143
 144 #if             ZONE_DEBUG
 145
 146 #if             MACH_KDB
 147
 148 extern void *   next_element(
 149                                 zone_t          z,
 150                                 void            *elt);
 151
 152 extern void *   first_element(
 153                                 zone_t          z);
 154
 155 #endif  /* MACH_KDB */
 156
 157 extern void             zone_debug_enable(
 158                                 zone_t          z);
 159
 160 extern void             zone_debug_disable(
 161                                 zone_t          z);
 162
 163 #endif  /* ZONE_DEBUG */
 164
 165 #endif  /* MACH_KERNEL_PRIVATE */
 166
 167 __BEGIN_DECLS
 168
 169 #ifdef  XNU_KERNEL_PRIVATE
 170
 171 /* Allocate from zone */
 172 extern void *   zalloc(
 173                                         zone_t          zone);
 174
 175 /* Free zone element */
 176 extern void             zfree(
 177                                         zone_t          zone,
 178                                         void            *elem);
 179
 180 /* Create zone */
 181 extern zone_t   zinit(
 182                                         vm_size_t       size,           /* the size of an element */
 183                                         vm_size_t       maxmem,         /* maximum memory to use */
 184                                         vm_size_t       alloc,          /* allocation size */
 185                                         const char      *name);         /* a name for the zone */
 186
 187
 188 /* Non-blocking version of zalloc */
 189 extern void *   zalloc_noblock(
 190                                         zone_t          zone);
 191
 192 /* direct (non-wrappered) interface */
 193 extern void *   zalloc_canblock(
 194                                         zone_t          zone,
 195                                         boolean_t       canblock);
 196
 197 /* Get from zone free list */
 198 extern void *   zget(
 199                                         zone_t          zone);
 200
 201 /* Fill zone with memory */
 202 extern void             zcram(
 203                                         zone_t          zone,
 204                                         void            *newmem,
 205                                         vm_size_t       size);
 206
 207 /* Initially fill zone with specified number of elements */
 208 extern int              zfill(
 209                                         zone_t          zone,
 210                                         int                     nelem);
 211
 212 /* Change zone parameters */
 213 extern void             zone_change(
 214                                         zone_t                  zone,
 215                                         unsigned int    item,
 216                                         boolean_t               value);
 217
 218 /* Item definitions */
 219 #define Z_EXHAUST       1       /* Make zone exhaustible        */
 220 #define Z_COLLECT       2       /* Make zone collectable        */
 221 #define Z_EXPAND        3       /* Make zone expandable         */
 222 #define Z_FOREIGN       4       /* Allow collectable zone to contain foreign elements */
 223 #define Z_NOENCRYPT     6       /* Don't encrypt zone during hibernation */
 224
 225 /* Preallocate space for zone from zone map */
 226 extern void             zprealloc(
 227                                         zone_t          zone,
 228                                         vm_size_t       size);
 229
 230 extern integer_t        zone_free_count(
 231                                                 zone_t          zone);
 232
 233 #endif  /* XNU_KERNEL_PRIVATE */
 234
 235 __END_DECLS
 236
 237 #endif  /* _KERN_ZALLOC_H_ */
 238
 239 #endif  /* KERNEL_PRIVATE */