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         uint64_t        sum_count;      /* count of allocs (life of zone) */
 104         unsigned int
 105         /* boolean_t */ exhaustible :1, /* (F) merely return if empty? */
 106         /* boolean_t */ collectable :1, /* (F) garbage collect empty pages */
 107         /* boolean_t */ expandable :1,  /* (T) expand zone (with message)? */
 108         /* boolean_t */ allows_foreign :1,/* (F) allow non-zalloc space */
 109         /* boolean_t */ doing_alloc :1, /* is zone expanding now? */
 110         /* boolean_t */ waiting :1,     /* is thread waiting for expansion? */
 111         /* boolean_t */ async_pending :1,       /* asynchronous allocation pending? */
 112 #if CONFIG_ZLEAKS
 113         /* boolean_t */ zleak_on :1,    /* Are we collecting allocation information? */
 114 #endif  /* ZONE_DEBUG */
 115         /* boolean_t */ caller_acct: 1, /* do we account allocation/free to the caller? */
 116         /* boolean_t */ doing_gc :1,    /* garbage collect in progress? */
 117         /* boolean_t */ noencrypt :1;
 118         int             index;          /* index into zone_info arrays for this zone */
 119         struct zone *   next_zone;      /* Link for all-zones list */
 120         call_entry_data_t       call_async_alloc;       /* callout for asynchronous alloc */
 121         const char      *zone_name;     /* a name for the zone */
 122 #if     ZONE_DEBUG
 123         queue_head_t    active_zones;   /* active elements */
 124 #endif  /* ZONE_DEBUG */
 125
 126 #if CONFIG_ZLEAKS
 127         uint32_t num_allocs;    /* alloc stats for zleak benchmarks */
 128         uint32_t num_frees;             /* free stats for zleak benchmarks */
 129         uint32_t zleak_capture; /* per-zone counter for capturing every N allocations */
 130 #endif /* CONFIG_ZLEAKS */
 131 };
 132
 133 /*
 134  *      structure for tracking zone usage
 135  *      Used either one per task/thread for all zones or <per-task,per-zone>.
 136  */
 137 typedef struct zinfo_usage_store_t {
 138         /* These fields may be updated atomically, and so must be 8 byte aligned */
 139         uint64_t        alloc __attribute__((aligned(8)));              /* allocation counter */
 140         uint64_t        free __attribute__((aligned(8)));               /* free counter */
 141 } zinfo_usage_store_t;
 142 typedef zinfo_usage_store_t *zinfo_usage_t;
 143
 144 extern void             zone_gc(void);
 145 extern void             consider_zone_gc(boolean_t);
 146
 147 /* Steal memory for zone module */
 148 extern void             zone_steal_memory(void);
 149
 150 /* Bootstrap zone module (create zone zone) */
 151 extern void             zone_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 152
 153 /* Init zone module */
 154 extern void             zone_init(
 155                                         vm_size_t       map_size) __attribute__((section("__TEXT, initcode")));
 156
 157 /* Handle per-task zone info */
 158 extern void             zinfo_task_init(task_t task);
 159 extern void             zinfo_task_free(task_t task);
 160
 161
 162 /* Stack use statistics */
 163 extern void             stack_fake_zone_init(int zone_index);
 164 extern void             stack_fake_zone_info(
 165                                         int                     *count,
 166                                         vm_size_t       *cur_size,
 167                                         vm_size_t       *max_size,
 168                                         vm_size_t       *elem_size,
 169                                         vm_size_t       *alloc_size,
 170                                         uint64_t        *sum_size,
 171                                         int                     *collectable,
 172                                         int                     *exhaustable,
 173                                         int             *caller_acct);
 174
 175 #if             ZONE_DEBUG
 176
 177 #if             MACH_KDB
 178
 179 extern void *   next_element(
 180                                 zone_t          z,
 181                                 void            *elt);
 182
 183 extern void *   first_element(
 184                                 zone_t          z);
 185
 186 #endif  /* MACH_KDB */
 187
 188 extern void             zone_debug_enable(
 189                                 zone_t          z);
 190
 191 extern void             zone_debug_disable(
 192                                 zone_t          z);
 193
 194 #endif  /* ZONE_DEBUG */
 195
 196 #endif  /* MACH_KERNEL_PRIVATE */
 197
 198 __BEGIN_DECLS
 199
 200 #ifdef  XNU_KERNEL_PRIVATE
 201
 202 /* Allocate from zone */
 203 extern void *   zalloc(
 204                                         zone_t          zone);
 205
 206 /* Free zone element */
 207 extern void             zfree(
 208                                         zone_t          zone,
 209                                         void            *elem);
 210
 211 /* Create zone */
 212 extern zone_t   zinit(
 213                                         vm_size_t       size,           /* the size of an element */
 214                                         vm_size_t       maxmem,         /* maximum memory to use */
 215                                         vm_size_t       alloc,          /* allocation size */
 216                                         const char      *name);         /* a name for the zone */
 217
 218
 219 /* Non-blocking version of zalloc */
 220 extern void *   zalloc_noblock(
 221                                         zone_t          zone);
 222
 223 /* direct (non-wrappered) interface */
 224 extern void *   zalloc_canblock(
 225                                         zone_t          zone,
 226                                         boolean_t       canblock);
 227
 228 /* Get from zone free list */
 229 extern void *   zget(
 230                                         zone_t          zone);
 231
 232 /* Fill zone with memory */
 233 extern void             zcram(
 234                                         zone_t          zone,
 235                                         void            *newmem,
 236                                         vm_size_t       size);
 237
 238 /* Initially fill zone with specified number of elements */
 239 extern int              zfill(
 240                                         zone_t          zone,
 241                                         int                     nelem);
 242
 243 /* Change zone parameters */
 244 extern void             zone_change(
 245                                         zone_t                  zone,
 246                                         unsigned int    item,
 247                                         boolean_t               value);
 248
 249 /* Item definitions */
 250 #define Z_EXHAUST       1       /* Make zone exhaustible        */
 251 #define Z_COLLECT       2       /* Make zone collectable        */
 252 #define Z_EXPAND        3       /* Make zone expandable         */
 253 #define Z_FOREIGN       4       /* Allow collectable zone to contain foreign elements */
 254 #define Z_CALLERACCT    5       /* Account alloc/free against the caller */
 255 #define Z_NOENCRYPT     6       /* Don't encrypt zone during hibernation */
 256
 257 /* Preallocate space for zone from zone map */
 258 extern void             zprealloc(
 259                                         zone_t          zone,
 260                                         vm_size_t       size);
 261
 262 extern integer_t        zone_free_count(
 263                                                 zone_t          zone);
 264
 265 /*
 266  * MAX_ZTRACE_DEPTH configures how deep of a stack trace is taken on each zalloc in the zone of interest.  15
 267  * levels is usually enough to get past all the layers of code in kalloc and IOKit and see who the actual
 268  * caller is up above these lower levels.
 269  *
 270  * This is used both for the zone leak detector and the zone corruption log.
 271  */
 272
 273 #define MAX_ZTRACE_DEPTH        15
 274
 275 /*
 276  *  Structure for keeping track of a backtrace, used for leak detection.
 277  *  This is in the .h file because it is used during panic, see kern/debug.c
 278  *  A non-zero size indicates that the trace is in use.
 279  */
 280 struct ztrace {
 281         vm_size_t               zt_size;                        /* How much memory are all the allocations referring to this trace taking up? */
 282         uint32_t                zt_depth;                       /* depth of stack (0 to MAX_ZTRACE_DEPTH) */
 283         void*                   zt_stack[MAX_ZTRACE_DEPTH];     /* series of return addresses from OSBacktrace */
 284         uint32_t                zt_collisions;                  /* How many times did a different stack land here while it was occupied? */
 285         uint32_t                zt_hit_count;                   /* for determining effectiveness of hash function */
 286 };
 287
 288 #if CONFIG_ZLEAKS
 289
 290 /* support for the kern.zleak.* sysctls */
 291
 292 extern kern_return_t zleak_activate(void);
 293 extern vm_size_t zleak_max_zonemap_size;
 294 extern vm_size_t zleak_global_tracking_threshold;
 295 extern vm_size_t zleak_per_zone_tracking_threshold;
 296
 297 extern int get_zleak_state(void);
 298
 299 #endif  /* CONFIG_ZLEAKS */
 300
 301 /* These functions used for leak detection both in zalloc.c and mbuf.c */
 302 extern uint32_t fastbacktrace(uintptr_t* bt, uint32_t max_frames);
 303 extern uintptr_t hash_mix(uintptr_t x);
 304 extern uint32_t hashbacktrace(uintptr_t* bt, uint32_t depth, uint32_t max_size);
 305 extern uint32_t hashaddr(uintptr_t pt, uint32_t max_size);
 306
 307 #endif  /* XNU_KERNEL_PRIVATE */
 308
 309 __END_DECLS
 310
 311 #endif  /* _KERN_ZALLOC_H_ */
 312
 313 #endif  /* KERNEL_PRIVATE */