Home | History | Annotate | Download | only in src
      1 #include "jemalloc/internal/jemalloc_internal.h"
      2 #ifndef JEMALLOC_ZONE
      3 #  error "This source file is for zones on Darwin (OS X)."
      4 #endif
      5 
      6 /*
      7  * The malloc_default_purgeable_zone() function is only available on >= 10.6.
      8  * We need to check whether it is present at runtime, thus the weak_import.
      9  */
     10 extern malloc_zone_t *malloc_default_purgeable_zone(void)
     11 JEMALLOC_ATTR(weak_import);
     12 
     13 /******************************************************************************/
     14 /* Data. */
     15 
     16 static malloc_zone_t *default_zone, *purgeable_zone;
     17 static malloc_zone_t jemalloc_zone;
     18 static struct malloc_introspection_t jemalloc_zone_introspect;
     19 
     20 /******************************************************************************/
     21 /* Function prototypes for non-inline static functions. */
     22 
     23 static size_t	zone_size(malloc_zone_t *zone, void *ptr);
     24 static void	*zone_malloc(malloc_zone_t *zone, size_t size);
     25 static void	*zone_calloc(malloc_zone_t *zone, size_t num, size_t size);
     26 static void	*zone_valloc(malloc_zone_t *zone, size_t size);
     27 static void	zone_free(malloc_zone_t *zone, void *ptr);
     28 static void	*zone_realloc(malloc_zone_t *zone, void *ptr, size_t size);
     29 #if (JEMALLOC_ZONE_VERSION >= 5)
     30 static void	*zone_memalign(malloc_zone_t *zone, size_t alignment,
     31 #endif
     32 #if (JEMALLOC_ZONE_VERSION >= 6)
     33     size_t size);
     34 static void	zone_free_definite_size(malloc_zone_t *zone, void *ptr,
     35     size_t size);
     36 #endif
     37 static void	*zone_destroy(malloc_zone_t *zone);
     38 static size_t	zone_good_size(malloc_zone_t *zone, size_t size);
     39 static void	zone_force_lock(malloc_zone_t *zone);
     40 static void	zone_force_unlock(malloc_zone_t *zone);
     41 
     42 /******************************************************************************/
     43 /*
     44  * Functions.
     45  */
     46 
     47 static size_t
     48 zone_size(malloc_zone_t *zone, void *ptr)
     49 {
     50 
     51 	/*
     52 	 * There appear to be places within Darwin (such as setenv(3)) that
     53 	 * cause calls to this function with pointers that *no* zone owns.  If
     54 	 * we knew that all pointers were owned by *some* zone, we could split
     55 	 * our zone into two parts, and use one as the default allocator and
     56 	 * the other as the default deallocator/reallocator.  Since that will
     57 	 * not work in practice, we must check all pointers to assure that they
     58 	 * reside within a mapped chunk before determining size.
     59 	 */
     60 	return (ivsalloc(tsdn_fetch(), ptr, config_prof));
     61 }
     62 
     63 static void *
     64 zone_malloc(malloc_zone_t *zone, size_t size)
     65 {
     66 
     67 	return (je_malloc(size));
     68 }
     69 
     70 static void *
     71 zone_calloc(malloc_zone_t *zone, size_t num, size_t size)
     72 {
     73 
     74 	return (je_calloc(num, size));
     75 }
     76 
     77 static void *
     78 zone_valloc(malloc_zone_t *zone, size_t size)
     79 {
     80 	void *ret = NULL; /* Assignment avoids useless compiler warning. */
     81 
     82 	je_posix_memalign(&ret, PAGE, size);
     83 
     84 	return (ret);
     85 }
     86 
     87 static void
     88 zone_free(malloc_zone_t *zone, void *ptr)
     89 {
     90 
     91 	if (ivsalloc(tsdn_fetch(), ptr, config_prof) != 0) {
     92 		je_free(ptr);
     93 		return;
     94 	}
     95 
     96 	free(ptr);
     97 }
     98 
     99 static void *
    100 zone_realloc(malloc_zone_t *zone, void *ptr, size_t size)
    101 {
    102 
    103 	if (ivsalloc(tsdn_fetch(), ptr, config_prof) != 0)
    104 		return (je_realloc(ptr, size));
    105 
    106 	return (realloc(ptr, size));
    107 }
    108 
    109 #if (JEMALLOC_ZONE_VERSION >= 5)
    110 static void *
    111 zone_memalign(malloc_zone_t *zone, size_t alignment, size_t size)
    112 {
    113 	void *ret = NULL; /* Assignment avoids useless compiler warning. */
    114 
    115 	je_posix_memalign(&ret, alignment, size);
    116 
    117 	return (ret);
    118 }
    119 #endif
    120 
    121 #if (JEMALLOC_ZONE_VERSION >= 6)
    122 static void
    123 zone_free_definite_size(malloc_zone_t *zone, void *ptr, size_t size)
    124 {
    125 	size_t alloc_size;
    126 
    127 	alloc_size = ivsalloc(tsdn_fetch(), ptr, config_prof);
    128 	if (alloc_size != 0) {
    129 		assert(alloc_size == size);
    130 		je_free(ptr);
    131 		return;
    132 	}
    133 
    134 	free(ptr);
    135 }
    136 #endif
    137 
    138 static void *
    139 zone_destroy(malloc_zone_t *zone)
    140 {
    141 
    142 	/* This function should never be called. */
    143 	not_reached();
    144 	return (NULL);
    145 }
    146 
    147 static size_t
    148 zone_good_size(malloc_zone_t *zone, size_t size)
    149 {
    150 
    151 	if (size == 0)
    152 		size = 1;
    153 	return (s2u(size));
    154 }
    155 
    156 static void
    157 zone_force_lock(malloc_zone_t *zone)
    158 {
    159 
    160 	if (isthreaded)
    161 		jemalloc_prefork();
    162 }
    163 
    164 static void
    165 zone_force_unlock(malloc_zone_t *zone)
    166 {
    167 
    168 	/*
    169 	 * Call jemalloc_postfork_child() rather than
    170 	 * jemalloc_postfork_parent(), because this function is executed by both
    171 	 * parent and child.  The parent can tolerate having state
    172 	 * reinitialized, but the child cannot unlock mutexes that were locked
    173 	 * by the parent.
    174 	 */
    175 	if (isthreaded)
    176 		jemalloc_postfork_child();
    177 }
    178 
    179 static void
    180 zone_init(void)
    181 {
    182 
    183 	jemalloc_zone.size = (void *)zone_size;
    184 	jemalloc_zone.malloc = (void *)zone_malloc;
    185 	jemalloc_zone.calloc = (void *)zone_calloc;
    186 	jemalloc_zone.valloc = (void *)zone_valloc;
    187 	jemalloc_zone.free = (void *)zone_free;
    188 	jemalloc_zone.realloc = (void *)zone_realloc;
    189 	jemalloc_zone.destroy = (void *)zone_destroy;
    190 	jemalloc_zone.zone_name = "jemalloc_zone";
    191 	jemalloc_zone.batch_malloc = NULL;
    192 	jemalloc_zone.batch_free = NULL;
    193 	jemalloc_zone.introspect = &jemalloc_zone_introspect;
    194 	jemalloc_zone.version = JEMALLOC_ZONE_VERSION;
    195 #if (JEMALLOC_ZONE_VERSION >= 5)
    196 	jemalloc_zone.memalign = zone_memalign;
    197 #endif
    198 #if (JEMALLOC_ZONE_VERSION >= 6)
    199 	jemalloc_zone.free_definite_size = zone_free_definite_size;
    200 #endif
    201 #if (JEMALLOC_ZONE_VERSION >= 8)
    202 	jemalloc_zone.pressure_relief = NULL;
    203 #endif
    204 
    205 	jemalloc_zone_introspect.enumerator = NULL;
    206 	jemalloc_zone_introspect.good_size = (void *)zone_good_size;
    207 	jemalloc_zone_introspect.check = NULL;
    208 	jemalloc_zone_introspect.print = NULL;
    209 	jemalloc_zone_introspect.log = NULL;
    210 	jemalloc_zone_introspect.force_lock = (void *)zone_force_lock;
    211 	jemalloc_zone_introspect.force_unlock = (void *)zone_force_unlock;
    212 	jemalloc_zone_introspect.statistics = NULL;
    213 #if (JEMALLOC_ZONE_VERSION >= 6)
    214 	jemalloc_zone_introspect.zone_locked = NULL;
    215 #endif
    216 #if (JEMALLOC_ZONE_VERSION >= 7)
    217 	jemalloc_zone_introspect.enable_discharge_checking = NULL;
    218 	jemalloc_zone_introspect.disable_discharge_checking = NULL;
    219 	jemalloc_zone_introspect.discharge = NULL;
    220 #  ifdef __BLOCKS__
    221 	jemalloc_zone_introspect.enumerate_discharged_pointers = NULL;
    222 #  else
    223 	jemalloc_zone_introspect.enumerate_unavailable_without_blocks = NULL;
    224 #  endif
    225 #endif
    226 }
    227 
    228 static malloc_zone_t *
    229 zone_default_get(void)
    230 {
    231 	malloc_zone_t **zones = NULL;
    232 	unsigned int num_zones = 0;
    233 
    234 	/*
    235 	 * On OSX 10.12, malloc_default_zone returns a special zone that is not
    236 	 * present in the list of registered zones. That zone uses a "lite zone"
    237 	 * if one is present (apparently enabled when malloc stack logging is
    238 	 * enabled), or the first registered zone otherwise. In practice this
    239 	 * means unless malloc stack logging is enabled, the first registered
    240 	 * zone is the default.  So get the list of zones to get the first one,
    241 	 * instead of relying on malloc_default_zone.
    242 	 */
    243 	if (KERN_SUCCESS != malloc_get_all_zones(0, NULL,
    244 	    (vm_address_t**)&zones, &num_zones)) {
    245 		/*
    246 		 * Reset the value in case the failure happened after it was
    247 		 * set.
    248 		 */
    249 		num_zones = 0;
    250 	}
    251 
    252 	if (num_zones)
    253 		return (zones[0]);
    254 
    255 	return (malloc_default_zone());
    256 }
    257 
    258 /* As written, this function can only promote jemalloc_zone. */
    259 static void
    260 zone_promote(void)
    261 {
    262 	malloc_zone_t *zone;
    263 
    264 	do {
    265 		/*
    266 		 * Unregister and reregister the default zone.  On OSX >= 10.6,
    267 		 * unregistering takes the last registered zone and places it
    268 		 * at the location of the specified zone.  Unregistering the
    269 		 * default zone thus makes the last registered one the default.
    270 		 * On OSX < 10.6, unregistering shifts all registered zones.
    271 		 * The first registered zone then becomes the default.
    272 		 */
    273 		malloc_zone_unregister(default_zone);
    274 		malloc_zone_register(default_zone);
    275 
    276 		/*
    277 		 * On OSX 10.6, having the default purgeable zone appear before
    278 		 * the default zone makes some things crash because it thinks it
    279 		 * owns the default zone allocated pointers.  We thus
    280 		 * unregister/re-register it in order to ensure it's always
    281 		 * after the default zone.  On OSX < 10.6, there is no purgeable
    282 		 * zone, so this does nothing.  On OSX >= 10.6, unregistering
    283 		 * replaces the purgeable zone with the last registered zone
    284 		 * above, i.e. the default zone.  Registering it again then puts
    285 		 * it at the end, obviously after the default zone.
    286 		 */
    287 		if (purgeable_zone != NULL) {
    288 			malloc_zone_unregister(purgeable_zone);
    289 			malloc_zone_register(purgeable_zone);
    290 		}
    291 
    292 		zone = zone_default_get();
    293 	} while (zone != &jemalloc_zone);
    294 }
    295 
    296 JEMALLOC_ATTR(constructor)
    297 void
    298 zone_register(void)
    299 {
    300 
    301 	/*
    302 	 * If something else replaced the system default zone allocator, don't
    303 	 * register jemalloc's.
    304 	 */
    305 	default_zone = zone_default_get();
    306 	if (!default_zone->zone_name || strcmp(default_zone->zone_name,
    307 	    "DefaultMallocZone") != 0)
    308 		return;
    309 
    310 	/*
    311 	 * The default purgeable zone is created lazily by OSX's libc.  It uses
    312 	 * the default zone when it is created for "small" allocations
    313 	 * (< 15 KiB), but assumes the default zone is a scalable_zone.  This
    314 	 * obviously fails when the default zone is the jemalloc zone, so
    315 	 * malloc_default_purgeable_zone() is called beforehand so that the
    316 	 * default purgeable zone is created when the default zone is still
    317 	 * a scalable_zone.  As purgeable zones only exist on >= 10.6, we need
    318 	 * to check for the existence of malloc_default_purgeable_zone() at
    319 	 * run time.
    320 	 */
    321 	purgeable_zone = (malloc_default_purgeable_zone == NULL) ? NULL :
    322 	    malloc_default_purgeable_zone();
    323 
    324 	/* Register the custom zone.  At this point it won't be the default. */
    325 	zone_init();
    326 	malloc_zone_register(&jemalloc_zone);
    327 
    328 	/* Promote the custom zone to be default. */
    329 	zone_promote();
    330 }
    331