osfmk/kern/zalloc.h

   1 /*
   2  * Copyright (c) 2000-2014 Apple 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 <kern/locks.h>
  78 #include <kern/queue.h>
  79 #include <kern/thread_call.h>
  80 #include <kern/btlog.h>
  81
  82 #if     CONFIG_GZALLOC
  83 typedef struct gzalloc_data {
  84         uint32_t        gzfc_index;
  85         vm_offset_t     *gzfc;
  86 } gzalloc_data_t;
  87 #endif
  88
  89 /*
  90  *      A zone is a collection of fixed size blocks for which there
  91  *      is fast allocation/deallocation access.  Kernel routines can
  92  *      use zones to manage data structures dynamically, creating a zone
  93  *      for each type of data structure to be managed.
  94  *
  95  */
  96
  97 struct zone_free_element;
  98 struct zone_page_metadata;
  99
 100 struct zone {
 101         struct zone_free_element *free_elements;        /* free elements directly linked */
 102         struct {
 103                 queue_head_t                    any_free_foreign;       /* foreign pages crammed into zone */
 104                 queue_head_t                    all_free;
 105                 queue_head_t                    intermediate;
 106                 queue_head_t                    all_used;
 107         } pages;                /* list of zone_page_metadata structs, which maintain per-page free element lists */
 108         int             count;          /* Number of elements used now */
 109         int             countfree;      /* Number of free elements */
 110         int     count_all_free_pages;  /* Number of pages collectable by GC */
 111         lck_attr_t      lock_attr;      /* zone lock attribute */
 112         decl_lck_mtx_data(,lock)        /* zone lock */
 113         lck_mtx_ext_t   lock_ext;       /* placeholder for indirect mutex */
 114         vm_size_t       cur_size;       /* current memory utilization */
 115         vm_size_t       max_size;       /* how large can this zone grow */
 116         vm_size_t       elem_size;      /* size of an element */
 117         vm_size_t       alloc_size;     /* size used for more memory */
 118         uint64_t        page_count __attribute__((aligned(8)));   /* number of pages used by this zone */
 119         uint64_t        sum_count;      /* count of allocs (life of zone) */
 120         uint32_t
 121         /* boolean_t */ exhaustible        :1,  /* (F) merely return if empty? */
 122         /* boolean_t */ collectable        :1,  /* (F) garbage collect empty pages */
 123         /* boolean_t */ expandable         :1,  /* (T) expand zone (with message)? */
 124         /* boolean_t */ allows_foreign     :1,  /* (F) allow non-zalloc space */
 125         /* boolean_t */ doing_alloc_without_vm_priv:1,  /* is zone expanding now via a non-vm_privileged thread? */
 126         /* boolean_t */ doing_alloc_with_vm_priv:1, /* is zone expanding now via a vm_privileged thread? */
 127         /* boolean_t */ waiting            :1,  /* is thread waiting for expansion? */
 128         /* boolean_t */ async_pending      :1,  /* asynchronous allocation pending? */
 129         /* boolean_t */ zleak_on           :1,  /* Are we collecting allocation information? */
 130         /* boolean_t */ caller_acct        :1,  /* do we account allocation/free to the caller? */
 131         /* boolean_t */ noencrypt          :1,
 132         /* boolean_t */ no_callout         :1,
 133         /* boolean_t */ async_prio_refill  :1,
 134         /* boolean_t */ gzalloc_exempt     :1,
 135         /* boolean_t */ alignment_required :1,
 136         /* boolean_t */ zone_logging       :1,  /* Enable zone logging for this zone. */
 137         /* boolean_t */ zone_replenishing  :1,
 138         /* future    */ _reserved          :15;
 139
 140         int             index;          /* index into zone_info arrays for this zone */
 141         const char      *zone_name;     /* a name for the zone */
 142
 143 #if CONFIG_ZLEAKS
 144         uint32_t zleak_capture;         /* per-zone counter for capturing every N allocations */
 145 #endif /* CONFIG_ZLEAKS */
 146         uint32_t zp_count;              /* counter for poisoning every N frees */
 147         vm_size_t       prio_refill_watermark;
 148         thread_t        zone_replenish_thread;
 149 #if     CONFIG_GZALLOC
 150         gzalloc_data_t  gz;
 151 #endif /* CONFIG_GZALLOC */
 152
 153         btlog_t         *zlog_btlog;            /* zone logging structure to hold stacks and element references to those stacks. */
 154 };
 155
 156 /*
 157  *      structure for tracking zone usage
 158  *      Used either one per task/thread for all zones or <per-task,per-zone>.
 159  */
 160 typedef struct zinfo_usage_store_t {
 161         /* These fields may be updated atomically, and so must be 8 byte aligned */
 162         uint64_t        alloc __attribute__((aligned(8)));              /* allocation counter */
 163         uint64_t        free __attribute__((aligned(8)));               /* free counter */
 164 } zinfo_usage_store_t;
 165
 166 extern void             zone_gc(void);
 167 extern void             consider_zone_gc(void);
 168
 169 /* Bootstrap zone module (create zone zone) */
 170 extern void             zone_bootstrap(void);
 171
 172 /* Init zone module */
 173 extern void             zone_init(
 174                                         vm_size_t       map_size);
 175
 176 /* Stack use statistics */
 177 extern void             stack_fake_zone_init(int zone_index);
 178 extern void             stack_fake_zone_info(
 179                                         int                     *count,
 180                                         vm_size_t       *cur_size,
 181                                         vm_size_t       *max_size,
 182                                         vm_size_t       *elem_size,
 183                                         vm_size_t       *alloc_size,
 184                                         uint64_t        *sum_size,
 185                                         int                     *collectable,
 186                                         int                     *exhaustable,
 187                                         int             *caller_acct);
 188
 189 #if             ZONE_DEBUG
 190
 191 extern void             zone_debug_enable(
 192                                 zone_t          z);
 193
 194 extern void             zone_debug_disable(
 195                                 zone_t          z);
 196
 197 #define zone_debug_enabled(z) z->active_zones.next
 198 #define ROUNDUP(x,y)            ((((x)+(y)-1)/(y))*(y))
 199 #define ZONE_DEBUG_OFFSET       ROUNDUP(sizeof(queue_chain_t),16)
 200 #endif  /* ZONE_DEBUG */
 201
 202 extern unsigned int            num_zones;
 203 extern struct zone             zone_array[];
 204
 205 #endif  /* MACH_KERNEL_PRIVATE */
 206
 207 __BEGIN_DECLS
 208
 209 #ifdef  XNU_KERNEL_PRIVATE
 210
 211 extern vm_offset_t     zone_map_min_address;
 212 extern vm_offset_t     zone_map_max_address;
 213
 214
 215 /* Allocate from zone */
 216 extern void *   zalloc(
 217                                         zone_t          zone);
 218
 219 /* Free zone element */
 220 extern void             zfree(
 221                                         zone_t          zone,
 222                                         void            *elem);
 223
 224 /* Create zone */
 225 extern zone_t   zinit(
 226                                         vm_size_t       size,           /* the size of an element */
 227                                         vm_size_t       maxmem,         /* maximum memory to use */
 228                                         vm_size_t       alloc,          /* allocation size */
 229                                         const char      *name);         /* a name for the zone */
 230
 231
 232 /* Non-waiting for memory version of zalloc */
 233 extern void *   zalloc_nopagewait(
 234                                         zone_t          zone);
 235
 236 /* Non-blocking version of zalloc */
 237 extern void *   zalloc_noblock(
 238                                         zone_t          zone);
 239
 240 /* selective version of zalloc */
 241 extern void *   zalloc_canblock(
 242                                         zone_t          zone,
 243                                         boolean_t       canblock);
 244
 245 /* Get from zone free list */
 246 extern void *   zget(
 247                                         zone_t          zone);
 248
 249 /* Fill zone with memory */
 250 extern void             zcram(
 251                                         zone_t          zone,
 252                                         vm_offset_t     newmem,
 253                                         vm_size_t       size);
 254
 255 /* Initially fill zone with specified number of elements */
 256 extern int              zfill(
 257                                         zone_t          zone,
 258                                         int                     nelem);
 259
 260 /* Change zone parameters */
 261 extern void             zone_change(
 262                                         zone_t                  zone,
 263                                         unsigned int    item,
 264                                         boolean_t               value);
 265 extern void             zone_prio_refill_configure(zone_t, vm_size_t);
 266 /* Item definitions */
 267 #define Z_EXHAUST       1       /* Make zone exhaustible        */
 268 #define Z_COLLECT       2       /* Make zone collectable        */
 269 #define Z_EXPAND        3       /* Make zone expandable         */
 270 #define Z_FOREIGN       4       /* Allow collectable zone to contain foreign elements */
 271 #define Z_CALLERACCT    5       /* Account alloc/free against the caller */
 272 #define Z_NOENCRYPT     6       /* Don't encrypt zone during hibernation */
 273 #define Z_NOCALLOUT     7       /* Don't asynchronously replenish the zone via
 274                                  * callouts
 275                                  */
 276 #define Z_ALIGNMENT_REQUIRED 8
 277 #define Z_GZALLOC_EXEMPT 9      /* Not tracked in guard allocation mode */
 278
 279 /* Preallocate space for zone from zone map */
 280 extern void             zprealloc(
 281                                         zone_t          zone,
 282                                         vm_size_t       size);
 283
 284 extern integer_t        zone_free_count(
 285                                                 zone_t          zone);
 286
 287 extern vm_size_t        zone_element_size(
 288                                                 void            *addr,
 289                                                 zone_t          *z);
 290
 291 /*
 292  * MAX_ZTRACE_DEPTH configures how deep of a stack trace is taken on each zalloc in the zone of interest.  15
 293  * levels is usually enough to get past all the layers of code in kalloc and IOKit and see who the actual
 294  * caller is up above these lower levels.
 295  *
 296  * This is used both for the zone leak detector and the zone corruption log.
 297  */
 298
 299 #define MAX_ZTRACE_DEPTH        15
 300
 301 /*
 302  *  Structure for keeping track of a backtrace, used for leak detection.
 303  *  This is in the .h file because it is used during panic, see kern/debug.c
 304  *  A non-zero size indicates that the trace is in use.
 305  */
 306 struct ztrace {
 307         vm_size_t               zt_size;                        /* How much memory are all the allocations referring to this trace taking up? */
 308         uint32_t                zt_depth;                       /* depth of stack (0 to MAX_ZTRACE_DEPTH) */
 309         void*                   zt_stack[MAX_ZTRACE_DEPTH];     /* series of return addresses from OSBacktrace */
 310         uint32_t                zt_collisions;                  /* How many times did a different stack land here while it was occupied? */
 311         uint32_t                zt_hit_count;                   /* for determining effectiveness of hash function */
 312 };
 313
 314 #if CONFIG_ZLEAKS
 315
 316 /* support for the kern.zleak.* sysctls */
 317
 318 extern kern_return_t zleak_activate(void);
 319 extern vm_size_t zleak_max_zonemap_size;
 320 extern vm_size_t zleak_global_tracking_threshold;
 321 extern vm_size_t zleak_per_zone_tracking_threshold;
 322
 323 extern int get_zleak_state(void);
 324
 325 #endif  /* CONFIG_ZLEAKS */
 326
 327 /* These functions used for leak detection both in zalloc.c and mbuf.c */
 328 extern uintptr_t hash_mix(uintptr_t);
 329 extern uint32_t hashbacktrace(uintptr_t *, uint32_t, uint32_t);
 330 extern uint32_t hashaddr(uintptr_t, uint32_t);
 331
 332 #define lock_zone(zone)                                 \
 333 MACRO_BEGIN                                             \
 334         lck_mtx_lock_spin(&(zone)->lock);               \
 335 MACRO_END
 336
 337 #define unlock_zone(zone)                               \
 338 MACRO_BEGIN                                             \
 339         lck_mtx_unlock(&(zone)->lock);                  \
 340 MACRO_END
 341
 342 #if     CONFIG_GZALLOC
 343 void gzalloc_init(vm_size_t);
 344 void gzalloc_zone_init(zone_t);
 345 void gzalloc_configure(void);
 346 void gzalloc_reconfigure(zone_t);
 347 boolean_t gzalloc_enabled(void);
 348
 349 vm_offset_t gzalloc_alloc(zone_t, boolean_t);
 350 boolean_t gzalloc_free(zone_t, void *);
 351 boolean_t gzalloc_element_size(void *, zone_t *, vm_size_t *);
 352 #endif /* CONFIG_GZALLOC */
 353
 354 /* Callbacks for btlog lock/unlock */
 355 void zlog_btlog_lock(__unused void *);
 356 void zlog_btlog_unlock(__unused void *);
 357
 358 #endif  /* XNU_KERNEL_PRIVATE */
 359
 360 __END_DECLS
 361
 362 #endif  /* _KERN_ZALLOC_H_ */
 363
 364 #endif  /* KERNEL_PRIVATE */