xnu-3248.30.4.tar.gz

[apple/xnu.git] / osfmk / kern / zalloc.h

diff --git a/osfmk/kern/zalloc.h b/osfmk/kern/zalloc.h
index b21f71253df6938e383449dae1576a92f85d4dc3..5446890558b3bc59a3c7607cbbdb3ee662240373 100644 (file)
--- a/osfmk/kern/zalloc.h
+++ b/osfmk/kern/zalloc.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2014 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -74,11 +74,16 @@
 #ifdef MACH_KERNEL_PRIVATE
 
 #include <zone_debug.h>
 #ifdef MACH_KERNEL_PRIVATE
 
 #include <zone_debug.h>

-#include <mach_kdb.h>
-#include <kern/lock.h>

 #include <kern/locks.h>
 #include <kern/queue.h>
 #include <kern/locks.h>
 #include <kern/queue.h>

-#include <kern/call_entry.h>
+#include <kern/thread_call.h>
+
+#if    CONFIG_GZALLOC
+typedef struct gzalloc_data {
+       uint32_t        gzfc_index;
+       vm_offset_t     *gzfc;
+} gzalloc_data_t;
+#endif

 
 /*
  *     A zone is a collection of fixed size blocks for which there
 
 /*
  *     A zone is a collection of fixed size blocks for which there


@@ -88,77 +93,119 @@
  *
  */
 
  *
  */
 

+struct zone_free_element;
+struct zone_page_metadata;
+

 struct zone {
 struct zone {

+       struct zone_free_element *free_elements;        /* free elements directly linked */
+       struct {
+               queue_head_t                    any_free_foreign;       /* foreign pages crammed into zone */
+               queue_head_t                    all_free;
+               queue_head_t                    intermediate;
+               queue_head_t                    all_used;
+       } pages;                /* list of zone_page_metadata structs, which maintain per-page free element lists */

        int             count;          /* Number of elements used now */
        int             count;          /* Number of elements used now */

-       vm_offset_t     free_elements;
+       int             countfree;      /* Number of free elements */
+       lck_attr_t      lock_attr;      /* zone lock attribute */

        decl_lck_mtx_data(,lock)        /* zone lock */
        lck_mtx_ext_t   lock_ext;       /* placeholder for indirect mutex */
        decl_lck_mtx_data(,lock)        /* zone lock */
        lck_mtx_ext_t   lock_ext;       /* placeholder for indirect mutex */

-       lck_attr_t      lock_attr;      /* zone lock attribute */
-       lck_grp_t       lock_grp;       /* zone lock group */
-       lck_grp_attr_t  lock_grp_attr;  /* zone lock group attribute */

        vm_size_t       cur_size;       /* current memory utilization */
        vm_size_t       max_size;       /* how large can this zone grow */
        vm_size_t       elem_size;      /* size of an element */
        vm_size_t       alloc_size;     /* size used for more memory */
        vm_size_t       cur_size;       /* current memory utilization */
        vm_size_t       max_size;       /* how large can this zone grow */
        vm_size_t       elem_size;      /* size of an element */
        vm_size_t       alloc_size;     /* size used for more memory */

-       unsigned int
-       /* boolean_t */ exhaustible :1, /* (F) merely return if empty? */
-       /* boolean_t */ collectable :1, /* (F) garbage collect empty pages */
-       /* boolean_t */ expandable :1,  /* (T) expand zone (with message)? */
-       /* boolean_t */ allows_foreign :1,/* (F) allow non-zalloc space */
-       /* boolean_t */ doing_alloc :1, /* is zone expanding now? */
-       /* boolean_t */ waiting :1,     /* is thread waiting for expansion? */
-       /* boolean_t */ async_pending :1,       /* asynchronous allocation pending? */
-       /* boolean_t */ doing_gc :1;    /* garbage collect in progress? */
-       struct zone *   next_zone;      /* Link for all-zones list */
-       call_entry_data_t       call_async_alloc;       /* callout for asynchronous alloc */
+       uint64_t        page_count __attribute__((aligned(8)));   /* number of pages used by this zone */
+       uint64_t        sum_count;      /* count of allocs (life of zone) */
+       uint32_t
+       /* boolean_t */ exhaustible        :1,  /* (F) merely return if empty? */
+       /* boolean_t */ collectable        :1,  /* (F) garbage collect empty pages */
+       /* boolean_t */ expandable         :1,  /* (T) expand zone (with message)? */
+       /* boolean_t */ allows_foreign     :1,  /* (F) allow non-zalloc space */
+       /* boolean_t */ doing_alloc_without_vm_priv:1,  /* is zone expanding now via a non-vm_privileged thread? */
+       /* boolean_t */ doing_alloc_with_vm_priv:1, /* is zone expanding now via a vm_privileged thread? */
+       /* boolean_t */ waiting            :1,  /* is thread waiting for expansion? */
+       /* boolean_t */ async_pending      :1,  /* asynchronous allocation pending? */
+       /* boolean_t */ zleak_on           :1,  /* Are we collecting allocation information? */
+       /* boolean_t */ caller_acct        :1,  /* do we account allocation/free to the caller? */  
+       /* boolean_t */ doing_gc           :1,  /* garbage collect in progress? */
+       /* boolean_t */ noencrypt          :1,
+       /* boolean_t */ no_callout         :1,
+       /* boolean_t */ async_prio_refill  :1,
+       /* boolean_t */ gzalloc_exempt     :1,
+       /* boolean_t */ alignment_required :1,
+       /* boolean_t */ use_page_list      :1,
+       /* future    */ _reserved          :15;
+
+       int             index;          /* index into zone_info arrays for this zone */
+       struct zone     *next_zone;     /* Link for all-zones list */

        const char      *zone_name;     /* a name for the zone */
 #if    ZONE_DEBUG
        queue_head_t    active_zones;   /* active elements */
 #endif /* ZONE_DEBUG */
        const char      *zone_name;     /* a name for the zone */
 #if    ZONE_DEBUG
        queue_head_t    active_zones;   /* active elements */
 #endif /* ZONE_DEBUG */

+
+#if CONFIG_ZLEAKS
+       uint32_t zleak_capture;         /* per-zone counter for capturing every N allocations */
+#endif /* CONFIG_ZLEAKS */
+       uint32_t zp_count;              /* counter for poisoning every N frees */
+       vm_size_t       prio_refill_watermark;
+       thread_t        zone_replenish_thread;
+#if    CONFIG_GZALLOC
+       gzalloc_data_t  gz;
+#endif /* CONFIG_GZALLOC */

 };
 
 };
 

-extern void            zone_gc(void);
+/*
+ *     structure for tracking zone usage
+ *     Used either one per task/thread for all zones or <per-task,per-zone>.
+ */
+typedef struct zinfo_usage_store_t {
+       /* These fields may be updated atomically, and so must be 8 byte aligned */
+       uint64_t        alloc __attribute__((aligned(8)));              /* allocation counter */
+       uint64_t        free __attribute__((aligned(8)));               /* free counter */
+} zinfo_usage_store_t;
+typedef zinfo_usage_store_t *zinfo_usage_t;
+
+extern void            zone_gc(boolean_t);

 extern void            consider_zone_gc(boolean_t);
 
 /* Steal memory for zone module */
 extern void            zone_steal_memory(void);
 
 /* Bootstrap zone module (create zone zone) */
 extern void            consider_zone_gc(boolean_t);
 
 /* Steal memory for zone module */
 extern void            zone_steal_memory(void);
 
 /* Bootstrap zone module (create zone zone) */

-extern void            zone_bootstrap(void) __attribute__((section("__TEXT, initcode")));
+extern void            zone_bootstrap(void);

 
 /* Init zone module */
 extern void            zone_init(
 
 /* Init zone module */
 extern void            zone_init(

-                                       vm_size_t       map_size) __attribute__((section("__TEXT, initcode")));
+                                       vm_size_t       map_size);
+
+/* Handle per-task zone info */
+extern void            zinfo_task_init(task_t task);
+extern void            zinfo_task_free(task_t task);
+

 
 /* Stack use statistics */
 
 /* Stack use statistics */

+extern void            stack_fake_zone_init(int zone_index);

 extern void            stack_fake_zone_info(
                                        int                     *count, 
                                        vm_size_t       *cur_size, 
                                        vm_size_t       *max_size,
                                        vm_size_t       *elem_size,
                                        vm_size_t       *alloc_size, 
 extern void            stack_fake_zone_info(
                                        int                     *count, 
                                        vm_size_t       *cur_size, 
                                        vm_size_t       *max_size,
                                        vm_size_t       *elem_size,
                                        vm_size_t       *alloc_size, 

+                                       uint64_t        *sum_size,

                                        int                     *collectable, 
                                        int                     *collectable, 

-                                       int                     *exhaustable);
+                                       int                     *exhaustable,
+                                       int             *caller_acct);

 
 #if            ZONE_DEBUG
 
 
 #if            ZONE_DEBUG
 

-#if            MACH_KDB
-
-extern void *  next_element(
-                               zone_t          z,
-                               void            *elt);
-
-extern void *  first_element(
-                               zone_t          z);
-
-#endif /* MACH_KDB */
-

 extern void            zone_debug_enable(
                                zone_t          z);
 
 extern void            zone_debug_disable(
                                zone_t          z);
 
 extern void            zone_debug_enable(
                                zone_t          z);
 
 extern void            zone_debug_disable(
                                zone_t          z);
 

+#define zone_debug_enabled(z) z->active_zones.next
+#define        ROUNDUP(x,y)            ((((x)+(y)-1)/(y))*(y))
+#define ZONE_DEBUG_OFFSET      ROUNDUP(sizeof(queue_chain_t),16)

 #endif /* ZONE_DEBUG */
 
 #endif /* MACH_KERNEL_PRIVATE */
 #endif /* ZONE_DEBUG */
 
 #endif /* MACH_KERNEL_PRIVATE */


@@ -167,6 +214,10 @@ __BEGIN_DECLS
 
 #ifdef XNU_KERNEL_PRIVATE
 
 
 #ifdef XNU_KERNEL_PRIVATE
 

+extern vm_offset_t     zone_map_min_address;
+extern vm_offset_t     zone_map_max_address;
+
+

 /* Allocate from zone */
 extern void *  zalloc(
                                        zone_t          zone);
 /* Allocate from zone */
 extern void *  zalloc(
                                        zone_t          zone);


@@ -184,11 +235,15 @@ extern zone_t     zinit(
                                        const char      *name);         /* a name for the zone */
 
 
                                        const char      *name);         /* a name for the zone */
 
 

+/* Non-waiting for memory version of zalloc */
+extern void *  zalloc_nopagewait(
+                                       zone_t          zone);
+

 /* Non-blocking version of zalloc */
 extern void *  zalloc_noblock(
                                        zone_t          zone);
 
 /* Non-blocking version of zalloc */
 extern void *  zalloc_noblock(
                                        zone_t          zone);
 

-/* direct (non-wrappered) interface */
+/* selective version of zalloc */

 extern void *  zalloc_canblock(
                                        zone_t          zone,
                                        boolean_t       canblock);
 extern void *  zalloc_canblock(
                                        zone_t          zone,
                                        boolean_t       canblock);


@@ -200,7 +255,7 @@ extern void *       zget(
 /* Fill zone with memory */
 extern void            zcram(
                                        zone_t          zone,
 /* Fill zone with memory */
 extern void            zcram(
                                        zone_t          zone,

-                                       void            *newmem,
+                                       vm_offset_t     newmem,

                                        vm_size_t       size);
 
 /* Initially fill zone with specified number of elements */
                                        vm_size_t       size);
 
 /* Initially fill zone with specified number of elements */


@@ -213,12 +268,19 @@ extern void               zone_change(
                                        zone_t                  zone,
                                        unsigned int    item,
                                        boolean_t               value);
                                        zone_t                  zone,
                                        unsigned int    item,
                                        boolean_t               value);

-
+extern void            zone_prio_refill_configure(zone_t, vm_size_t);

 /* Item definitions */
 #define Z_EXHAUST      1       /* Make zone exhaustible        */
 #define Z_COLLECT      2       /* Make zone collectable        */
 #define Z_EXPAND       3       /* Make zone expandable         */
 #define        Z_FOREIGN       4       /* Allow collectable zone to contain foreign elements */
 /* Item definitions */
 #define Z_EXHAUST      1       /* Make zone exhaustible        */
 #define Z_COLLECT      2       /* Make zone collectable        */
 #define Z_EXPAND       3       /* Make zone expandable         */
 #define        Z_FOREIGN       4       /* Allow collectable zone to contain foreign elements */

+#define Z_CALLERACCT   5       /* Account alloc/free against the caller */
+#define Z_NOENCRYPT    6       /* Don't encrypt zone during hibernation */
+#define Z_NOCALLOUT    7       /* Don't asynchronously replenish the zone via
+                                * callouts
+                                */
+#define Z_ALIGNMENT_REQUIRED 8
+#define Z_GZALLOC_EXEMPT 9     /* Not tracked in guard allocation mode */

 
 /* Preallocate space for zone from zone map */
 extern void            zprealloc(
 
 /* Preallocate space for zone from zone map */
 extern void            zprealloc(


@@ -228,6 +290,69 @@ extern void                zprealloc(
 extern integer_t       zone_free_count(
                                                zone_t          zone);
 
 extern integer_t       zone_free_count(
                                                zone_t          zone);
 

+/*
+ * MAX_ZTRACE_DEPTH configures how deep of a stack trace is taken on each zalloc in the zone of interest.  15
+ * levels is usually enough to get past all the layers of code in kalloc and IOKit and see who the actual
+ * caller is up above these lower levels.
+ *
+ * This is used both for the zone leak detector and the zone corruption log.
+ */
+
+#define MAX_ZTRACE_DEPTH       15
+
+/* 
+ *  Structure for keeping track of a backtrace, used for leak detection.
+ *  This is in the .h file because it is used during panic, see kern/debug.c
+ *  A non-zero size indicates that the trace is in use.
+ */
+struct ztrace {
+       vm_size_t               zt_size;                        /* How much memory are all the allocations referring to this trace taking up? */
+       uint32_t                zt_depth;                       /* depth of stack (0 to MAX_ZTRACE_DEPTH) */
+       void*                   zt_stack[MAX_ZTRACE_DEPTH];     /* series of return addresses from OSBacktrace */
+       uint32_t                zt_collisions;                  /* How many times did a different stack land here while it was occupied? */
+       uint32_t                zt_hit_count;                   /* for determining effectiveness of hash function */
+};
+
+#if CONFIG_ZLEAKS
+
+/* support for the kern.zleak.* sysctls */
+
+extern kern_return_t zleak_activate(void);
+extern vm_size_t zleak_max_zonemap_size;
+extern vm_size_t zleak_global_tracking_threshold;
+extern vm_size_t zleak_per_zone_tracking_threshold;
+
+extern int get_zleak_state(void);
+
+#endif /* CONFIG_ZLEAKS */
+
+/* These functions used for leak detection both in zalloc.c and mbuf.c */
+extern uint32_t fastbacktrace(uintptr_t* bt, uint32_t max_frames) __attribute__((noinline));
+extern uintptr_t hash_mix(uintptr_t);
+extern uint32_t hashbacktrace(uintptr_t *, uint32_t, uint32_t);
+extern uint32_t hashaddr(uintptr_t, uint32_t);
+
+#define lock_zone(zone)                                        \
+MACRO_BEGIN                                            \
+       lck_mtx_lock_spin(&(zone)->lock);               \
+MACRO_END
+
+#define unlock_zone(zone)                              \
+MACRO_BEGIN                                            \
+       lck_mtx_unlock(&(zone)->lock);                  \
+MACRO_END
+
+#if    CONFIG_GZALLOC
+void gzalloc_init(vm_size_t);
+void gzalloc_zone_init(zone_t);
+void gzalloc_configure(void);
+void gzalloc_reconfigure(zone_t);
+boolean_t gzalloc_enabled(void);
+
+vm_offset_t gzalloc_alloc(zone_t, boolean_t);
+boolean_t gzalloc_free(zone_t, void *);
+#endif /* CONFIG_GZALLOC */
+

 #endif /* XNU_KERNEL_PRIVATE */
 
 __END_DECLS
 #endif /* XNU_KERNEL_PRIVATE */
 
 __END_DECLS