blob: 619c522b124b3bcc755983f0c174533ee1ba96f7 [file] [log] [blame]
Jason Evans379f8472010-10-24 16:18:29 -07001Following are change highlights associated with official releases. Important
Jason Evansbe09b812015-07-07 09:33:22 -07002bug fixes are all mentioned, but some internal enhancements are omitted here for
3brevity. Much more detail can be found in the git revision history:
Jason Evans379f8472010-10-24 16:18:29 -07004
Jason Evansb9ec5c92014-02-25 16:43:51 -08005 https://github.com/jemalloc/jemalloc
6
Jason Evans38e2c8f2015-09-17 10:05:56 -07007* 4.0.2 (XXX)
8
9 Bug fixes:
10 - Fix ixallocx_prof_sample() to never modify nor create sampled small
11 allocations. xallocx() is in general incapable of moving small allocations,
12 so this fix removes buggy code without loss of generality.
13
Jason Evans1d7540c2015-09-15 15:26:23 -070014* 4.0.1 (September 15, 2015)
15
16 This is a bugfix release that is somewhat high risk due to the amount of
17 refactoring required to address deep xallocx() problems. As a side effect of
18 these fixes, xallocx() now tries harder to partially fulfill requests for
19 optional extra space. Note that a couple of minor heap profiling
20 optimizations are included, but these are better thought of as performance
21 fixes that were integral to disovering most of the other bugs.
22
23 Optimizations:
24 - Avoid a chunk metadata read in arena_prof_tctx_set(), since it is in the
25 fast path when heap profiling is enabled. Additionally, split a special
26 case out into arena_prof_tctx_reset(), which also avoids chunk metadata
27 reads.
28 - Optimize irallocx_prof() to optimistically update the sampler state. The
29 prior implementation appears to have been a holdover from when
30 rallocx()/xallocx() functionality was combined as rallocm().
Jason Evans5ef33a92015-08-19 14:12:05 -070031
32 Bug fixes:
Jason Evans1d7540c2015-09-15 15:26:23 -070033 - Fix TLS configuration such that it is enabled by default for platforms on
34 which it works correctly.
Jason Evans30949da2015-08-25 16:13:59 -070035 - Fix arenas_cache_cleanup() and arena_get_hard() to handle
36 allocation/deallocation within the application's thread-specific data
37 cleanup functions even after arenas_cache is torn down.
Jason Evans1d7540c2015-09-15 15:26:23 -070038 - Fix xallocx() bugs related to size+extra exceeding HUGE_MAXCLASS.
Mike Hommey6d8075f2015-08-27 20:30:15 -070039 - Fix chunk purge hook calls for in-place huge shrinking reallocation to
40 specify the old chunk size rather than the new chunk size. This bug caused
41 no correctness issues for the default chunk purge function, but was
42 visible to custom functions set via the "arena.<i>.chunk_hooks" mallctl.
Jason Evans1d7540c2015-09-15 15:26:23 -070043 - Fix heap profiling bugs:
44 + Fix heap profiling to distinguish among otherwise identical sample sites
45 with interposed resets (triggered via the "prof.reset" mallctl). This bug
46 could cause data structure corruption that would most likely result in a
47 segfault.
48 + Fix irealloc_prof() to prof_alloc_rollback() on OOM.
49 + Make one call to prof_active_get_unlocked() per allocation event, and use
50 the result throughout the relevant functions that handle an allocation
51 event. Also add a missing check in prof_realloc(). These fixes protect
52 allocation events against concurrent prof_active changes.
53 + Fix ixallocx_prof() to pass usize_max and zero to ixallocx_prof_sample()
54 in the correct order.
55 + Fix prof_realloc() to call prof_free_sampled_object() after calling
56 prof_malloc_sample_object(). Prior to this fix, if tctx and old_tctx were
57 the same, the tctx could have been prematurely destroyed.
58 - Fix portability bugs:
59 + Don't bitshift by negative amounts when encoding/decoding run sizes in
60 chunk header maps. This affected systems with page sizes greater than 8
61 KiB.
62 + Rename index_t to szind_t to avoid an existing type on Solaris.
63 + Add JEMALLOC_CXX_THROW to the memalign() function prototype, in order to
64 match glibc and avoid compilation errors when including both
65 jemalloc/jemalloc.h and malloc.h in C++ code.
66 + Don't assume that /bin/sh is appropriate when running size_classes.sh
67 during configuration.
68 + Consider __sparcv9 a synonym for __sparc64__ when defining LG_QUANTUM.
69 + Link tests to librt if it contains clock_gettime(2).
Jason Evans5ef33a92015-08-19 14:12:05 -070070
Jason Evans9b68f672015-08-17 13:21:08 -070071* 4.0.0 (August 17, 2015)
Jason Evans54673fd2015-02-23 22:28:43 -080072
73 This version contains many speed and space optimizations, both minor and
74 major. The major themes are generalization, unification, and simplification.
75 Although many of these optimizations cause no visible behavior change, their
76 cumulative effect is substantial.
77
78 New features:
79 - Normalize size class spacing to be consistent across the complete size
80 range. By default there are four size classes per size doubling, but this
81 is now configurable via the --with-lg-size-class-group option. Also add the
82 --with-lg-page, --with-lg-page-sizes, --with-lg-quantum, and
83 --with-lg-tiny-min options, which can be used to tweak page and size class
84 settings. Impacts:
85 + Worst case performance for incrementally growing/shrinking reallocation
86 is improved because there are far fewer size classes, and therefore
87 copying happens less often.
88 + Internal fragmentation is limited to 20% for all but the smallest size
89 classes (those less than four times the quantum). (1B + 4 KiB)
90 and (1B + 4 MiB) previously suffered nearly 50% internal fragmentation.
91 + Chunk fragmentation tends to be lower because there are fewer distinct run
92 sizes to pack.
93 - Add support for explicit tcaches. The "tcache.create", "tcache.flush", and
94 "tcache.destroy" mallctls control tcache lifetime and flushing, and the
95 MALLOCX_TCACHE(tc) and MALLOCX_TCACHE_NONE flags to the *allocx() API
96 control which tcache is used for each operation.
97 - Implement per thread heap profiling, as well as the ability to
98 enable/disable heap profiling on a per thread basis. Add the "prof.reset",
99 "prof.lg_sample", "thread.prof.name", "thread.prof.active",
100 "opt.prof_thread_active_init", "prof.thread_active_init", and
101 "thread.prof.active" mallctls.
102 - Add support for per arena application-specified chunk allocators, configured
Jason Evansb49a3342015-07-28 11:28:19 -0400103 via the "arena.<i>.chunk_hooks" mallctl.
Jason Evans54673fd2015-02-23 22:28:43 -0800104 - Refactor huge allocation to be managed by arenas, so that arenas now
105 function as general purpose independent allocators. This is important in
106 the context of user-specified chunk allocators, aside from the scalability
107 benefits. Related new statistics:
108 + The "stats.arenas.<i>.huge.allocated", "stats.arenas.<i>.huge.nmalloc",
109 "stats.arenas.<i>.huge.ndalloc", and "stats.arenas.<i>.huge.nrequests"
110 mallctls provide high level per arena huge allocation statistics.
Qinfan Wu89750352015-04-21 16:57:42 -0700111 + The "arenas.nhchunks", "arenas.hchunk.<i>.size",
Jason Evans54673fd2015-02-23 22:28:43 -0800112 "stats.arenas.<i>.hchunks.<j>.nmalloc",
113 "stats.arenas.<i>.hchunks.<j>.ndalloc",
114 "stats.arenas.<i>.hchunks.<j>.nrequests", and
115 "stats.arenas.<i>.hchunks.<j>.curhchunks" mallctls provide per size class
116 statistics.
117 - Add the 'util' column to malloc_stats_print() output, which reports the
118 proportion of available regions that are currently in use for each small
119 size class.
120 - Add "alloc" and "free" modes for for junk filling (see the "opt.junk"
121 mallctl), so that it is possible to separately enable junk filling for
122 allocation versus deallocation.
123 - Add the jemalloc-config script, which provides information about how
124 jemalloc was configured, and how to integrate it into application builds.
125 - Add metadata statistics, which are accessible via the "stats.metadata",
126 "stats.arenas.<i>.metadata.mapped", and
127 "stats.arenas.<i>.metadata.allocated" mallctls.
Jason Evans4acd75a2015-03-23 17:25:57 -0700128 - Add the "stats.resident" mallctl, which reports the upper limit of
129 physically resident memory mapped by the allocator.
Jason Evans562d2662015-03-24 16:36:12 -0700130 - Add per arena control over unused dirty page purging, via the
131 "arenas.lg_dirty_mult", "arena.<i>.lg_dirty_mult", and
132 "stats.arenas.<i>.lg_dirty_mult" mallctls.
Jason Evans54673fd2015-02-23 22:28:43 -0800133 - Add the "prof.gdump" mallctl, which makes it possible to toggle the gdump
134 feature on/off during program execution.
135 - Add sdallocx(), which implements sized deallocation. The primary
136 optimization over dallocx() is the removal of a metadata read, which often
137 suffers an L1 cache miss.
138 - Add missing header includes in jemalloc/jemalloc.h, so that applications
139 only have to #include <jemalloc/jemalloc.h>.
140 - Add support for additional platforms:
141 + Bitrig
142 + Cygwin
143 + DragonFlyBSD
144 + iOS
145 + OpenBSD
146 + OpenRISC/or1k
147
148 Optimizations:
Jason Evans54673fd2015-02-23 22:28:43 -0800149 - Maintain dirty runs in per arena LRUs rather than in per arena trees of
150 dirty-run-containing chunks. In practice this change significantly reduces
151 dirty page purging volume.
152 - Integrate whole chunks into the unused dirty page purging machinery. This
153 reduces the cost of repeated huge allocation/deallocation, because it
154 effectively introduces a cache of chunks.
155 - Split the arena chunk map into two separate arrays, in order to increase
156 cache locality for the frequently accessed bits.
157 - Move small run metadata out of runs, into arena chunk headers. This reduces
158 run fragmentation, smaller runs reduce external fragmentation for small size
159 classes, and packed (less uniformly aligned) metadata layout improves CPU
160 cache set distribution.
Jason Evans8a03cf02015-05-04 09:58:36 -0700161 - Randomly distribute large allocation base pointer alignment relative to page
162 boundaries in order to more uniformly utilize CPU cache sets. This can be
Jason Evansf2bc8522015-07-17 16:38:25 -0700163 disabled via the --disable-cache-oblivious configure option, and queried via
164 the "config.cache_oblivious" mallctl.
Jason Evans54673fd2015-02-23 22:28:43 -0800165 - Micro-optimize the fast paths for the public API functions.
166 - Refactor thread-specific data to reside in a single structure. This assures
167 that only a single TLS read is necessary per call into the public API.
168 - Implement in-place huge allocation growing and shrinking.
169 - Refactor rtree (radix tree for chunk lookups) to be lock-free, and make
170 additional optimizations that reduce maximum lookup depth to one or two
171 levels. This resolves what was a concurrency bottleneck for per arena huge
172 allocation, because a global data structure is critical for determining
173 which arenas own which huge allocations.
174
175 Incompatible changes:
176 - Replace --enable-cc-silence with --disable-cc-silence to suppress spurious
177 warnings by default.
178 - Assure that the constness of malloc_usable_size()'s return type matches that
179 of the system implementation.
180 - Change the heap profile dump format to support per thread heap profiling,
Jason Evans70417202015-05-01 12:31:12 -0700181 rename pprof to jeprof, and enhance it with the --thread=<n> option. As a
182 result, the bundled jeprof must now be used rather than the upstream
183 (gperftools) pprof.
Jason Evans54673fd2015-02-23 22:28:43 -0800184 - Disable "opt.prof_final" by default, in order to avoid atexit(3), which can
185 internally deadlock on some platforms.
186 - Change the "arenas.nlruns" mallctl type from size_t to unsigned.
187 - Replace the "stats.arenas.<i>.bins.<j>.allocated" mallctl with
188 "stats.arenas.<i>.bins.<j>.curregs".
189 - Ignore MALLOC_CONF in set{uid,gid,cap} binaries.
190 - Ignore MALLOCX_ARENA(a) in dallocx(), in favor of using the
191 MALLOCX_TCACHE(tc) and MALLOCX_TCACHE_NONE flags to control tcache usage.
192
193 Removed features:
194 - Remove the *allocm() API, which is superseded by the *allocx() API.
195 - Remove the --enable-dss options, and make dss non-optional on all platforms
196 which support sbrk(2).
197 - Remove the "arenas.purge" mallctl, which was obsoleted by the
198 "arena.<i>.purge" mallctl in 3.1.0.
199 - Remove the unnecessary "opt.valgrind" mallctl; jemalloc automatically
200 detects whether it is running inside Valgrind.
201 - Remove the "stats.huge.allocated", "stats.huge.nmalloc", and
202 "stats.huge.ndalloc" mallctls.
203 - Remove the --enable-mremap option.
Jason Evans54673fd2015-02-23 22:28:43 -0800204 - Remove the "stats.chunks.current", "stats.chunks.total", and
205 "stats.chunks.high" mallctls.
206
207 Bug fixes:
208 - Fix the cactive statistic to decrease (rather than increase) when active
209 memory decreases. This regression was first released in 3.5.0.
210 - Fix OOM handling in memalign() and valloc(). A variant of this bug existed
211 in all releases since 2.0.0, which introduced these functions.
Jason Evans32dca112015-07-09 11:34:13 -0700212 - Fix an OOM-related regression in arena_tcache_fill_small(), which could
213 cause cache corruption on OOM. This regression was present in all releases
214 from 2.2.0 through 3.6.0.
Jason Evans241abc62015-06-23 18:47:07 -0700215 - Fix size class overflow handling for malloc(), posix_memalign(), memalign(),
216 calloc(), and realloc() when profiling is enabled.
Jason Evans54673fd2015-02-23 22:28:43 -0800217 - Fix the "arena.<i>.dss" mallctl to return an error if "primary" or
218 "secondary" precedence is specified, but sbrk(2) is not supported.
219 - Fix fallback lg_floor() implementations to handle extremely large inputs.
220 - Ensure the default purgeable zone is after the default zone on OS X.
221 - Fix latent bugs in atomic_*().
222 - Fix the "arena.<i>.dss" mallctl to handle read-only calls.
223 - Fix tls_model configuration to enable the initial-exec model when possible.
224 - Mark malloc_conf as a weak symbol so that the application can override it.
225 - Correctly detect glibc's adaptive pthread mutexes.
226 - Fix the --without-export configure option.
227
Jason Evansff536312014-03-31 09:23:10 -0700228* 3.6.0 (March 31, 2014)
229
230 This version contains a critical bug fix for a regression present in 3.5.0 and
231 3.5.1.
232
233 Bug fixes:
234 - Fix a regression in arena_chunk_alloc() that caused crashes during
235 small/large allocation if chunk allocation failed. In the absence of this
236 bug, chunk allocation failure would result in allocation failure, e.g. NULL
237 return from malloc(). This regression was introduced in 3.5.0.
238 - Fix backtracing for gcc intrinsics-based backtracing by specifying
239 -fno-omit-frame-pointer to gcc. Note that the application (and all the
240 libraries it links to) must also be compiled with this option for
241 backtracing to be reliable.
242 - Use dss allocation precedence for huge allocations as well as small/large
243 allocations.
Jason Evans54673fd2015-02-23 22:28:43 -0800244 - Fix test assertion failure message formatting. This bug did not manifest on
Jason Evansff536312014-03-31 09:23:10 -0700245 x86_64 systems because of implementation subtleties in va_list.
246 - Fix inconsequential test failures for hash and SFMT code.
247
248 New features:
249 - Support heap profiling on FreeBSD. This feature depends on the proc
250 filesystem being mounted during heap profile dumping.
251
Jason Evansb9ec5c92014-02-25 16:43:51 -0800252* 3.5.1 (February 25, 2014)
253
254 This version primarily addresses minor bugs in test code.
255
256 Bug fixes:
257 - Configure Solaris/Illumos to use MADV_FREE.
258 - Fix junk filling for mremap(2)-based huge reallocation. This is only
259 relevant if configuring with the --enable-mremap option specified.
260 - Avoid compilation failure if 'restrict' C99 keyword is not supported by the
261 compiler.
262 - Add a configure test for SSE2 rather than assuming it is usable on i686
263 systems. This fixes test compilation errors, especially on 32-bit Linux
264 systems.
265 - Fix mallctl argument size mismatches (size_t vs. uint64_t) in the stats unit
266 test.
267 - Fix/remove flawed alignment-related overflow tests.
268 - Prevent compiler optimizations that could change backtraces in the
269 prof_accum unit test.
Jason Evans379f8472010-10-24 16:18:29 -0700270
Jason Evans798a4812014-01-22 11:09:50 -0800271* 3.5.0 (January 22, 2014)
Jason Evans86abd0d2013-11-30 15:25:42 -0800272
Jason Evans264dfd32014-01-17 17:01:23 -0800273 This version focuses on refactoring and automated testing, though it also
274 includes some non-trivial heap profiling optimizations not mentioned below.
275
276 New features:
277 - Add the *allocx() API, which is a successor to the experimental *allocm()
278 API. The *allocx() functions are slightly simpler to use because they have
279 fewer parameters, they directly return the results of primary interest, and
280 mallocx()/rallocx() avoid the strict aliasing pitfall that
Jason Evans9c8baec2014-01-22 13:08:47 -0800281 allocm()/rallocm() share with posix_memalign(). Note that *allocm() is
Jason Evans264dfd32014-01-17 17:01:23 -0800282 slated for removal in the next non-bugfix release.
283 - Add support for LinuxThreads.
284
Jason Evans86abd0d2013-11-30 15:25:42 -0800285 Bug fixes:
Jason Evansd37d5ad2013-12-05 23:01:50 -0800286 - Unless heap profiling is enabled, disable floating point code and don't link
287 with libm. This, in combination with e.g. EXTRA_CFLAGS=-mno-sse on x64
288 systems, makes it possible to completely disable floating point register
289 use. Some versions of glibc neglect to save/restore caller-saved floating
290 point registers during dynamic lazy symbol loading, and the symbol loading
291 code uses whatever malloc the application happens to have linked/loaded
292 with, the result being potential floating point register corruption.
Jason Evans264dfd32014-01-17 17:01:23 -0800293 - Report ENOMEM rather than EINVAL if an OOM occurs during heap profiling
294 backtrace creation in imemalign(). This bug impacted posix_memalign() and
295 aligned_alloc().
296 - Fix a file descriptor leak in a prof_dump_maps() error path.
297 - Fix prof_dump() to close the dump file descriptor for all relevant error
298 paths.
299 - Fix rallocm() to use the arena specified by the ALLOCM_ARENA(s) flag for
300 allocation, not just deallocation.
301 - Fix a data race for large allocation stats counters.
302 - Fix a potential infinite loop during thread exit. This bug occurred on
303 Solaris, and could affect other platforms with similar pthreads TSD
304 implementations.
305 - Don't junk-fill reallocations unless usable size changes. This fixes a
306 violation of the *allocx()/*allocm() semantics.
307 - Fix growing large reallocation to junk fill new space.
308 - Fix huge deallocation to junk fill when munmap is disabled.
Jason Evans86abd0d2013-11-30 15:25:42 -0800309 - Change the default private namespace prefix from empty to je_, and change
310 --with-private-namespace-prefix so that it prepends an additional prefix
311 rather than replacing je_. This reduces the likelihood of applications
312 which statically link jemalloc experiencing symbol name collisions.
Jason Evans264dfd32014-01-17 17:01:23 -0800313 - Add missing private namespace mangling (relevant when
314 --with-private-namespace is specified).
315 - Add and use JEMALLOC_INLINE_C so that static inline functions are marked as
316 static even for debug builds.
317 - Add a missing mutex unlock in a malloc_init_hard() error path. In practice
318 this error path is never executed.
319 - Fix numerous bugs in malloc_strotumax() error handling/reporting. These
320 bugs had no impact except for malformed inputs.
321 - Fix numerous bugs in malloc_snprintf(). These bugs were not exercised by
322 existing calls, so they had no impact.
Jason Evans86abd0d2013-11-30 15:25:42 -0800323
Jason Evans0f7ba3f2013-10-20 19:40:09 -0700324* 3.4.1 (October 20, 2013)
Jason Evansff08ef72013-10-19 21:41:10 -0700325
326 Bug fixes:
Jason Evans7b651802013-10-20 14:09:54 -0700327 - Fix a race in the "arenas.extend" mallctl that could cause memory corruption
328 of internal data structures and subsequent crashes.
Jason Evansdda90f52013-10-19 23:48:40 -0700329 - Fix Valgrind integration flaws that caused Valgrind warnings about reads of
330 uninitialized memory in:
331 + arena chunk headers
332 + internal zero-initialized data structures (relevant to tcache and prof
333 code)
Jason Evansff08ef72013-10-19 21:41:10 -0700334 - Preserve errno during the first allocation. A readlink(2) call during
335 initialization fails unless /etc/malloc.conf exists, so errno was typically
336 set during the first allocation prior to this fix.
337 - Fix compilation warnings reported by gcc 4.8.1.
338
Jason Evans765cc2b2013-06-02 20:58:00 -0700339* 3.4.0 (June 2, 2013)
340
341 This version is essentially a small bugfix release, but the addition of
342 aarch64 support requires that the minor version be incremented.
343
344 Bug fixes:
345 - Fix race-triggered deadlocks in chunk_record(). These deadlocks were
346 typically triggered by multiple threads concurrently deallocating huge
347 objects.
348
349 New features:
350 - Add support for the aarch64 architecture.
351
Jason Evans22988352013-03-06 11:11:17 -0800352* 3.3.1 (March 6, 2013)
353
354 This version fixes bugs that are typically encountered only when utilizing
355 custom run-time options.
Jason Evansbbe29d32013-01-30 15:03:11 -0800356
357 Bug fixes:
Jason Evans88c222c2013-02-06 11:59:30 -0800358 - Fix a locking order bug that could cause deadlock during fork if heap
359 profiling were enabled.
Jason Evansa7a28c32013-01-31 16:53:58 -0800360 - Fix a chunk recycling bug that could cause the allocator to lose track of
Jason Evans765cc2b2013-06-02 20:58:00 -0700361 whether a chunk was zeroed. On FreeBSD, NetBSD, and OS X, it could cause
Jason Evansa7a28c32013-01-31 16:53:58 -0800362 corruption if allocating via sbrk(2) (unlikely unless running with the
363 "dss:primary" option specified). This was completely harmless on Linux
364 unless using mlockall(2) (and unlikely even then, unless the
365 --disable-munmap configure option or the "dss:primary" option was
366 specified). This regression was introduced in 3.1.0 by the
367 mlockall(2)/madvise(2) interaction fix.
Jason Evansbbe29d32013-01-30 15:03:11 -0800368 - Fix TLS-related memory corruption that could occur during thread exit if the
369 thread never allocated memory. Only the quarantine and prof facilities were
370 susceptible.
Jason Evansd0e942e2013-01-31 14:42:41 -0800371 - Fix two quarantine bugs:
372 + Internal reallocation of the quarantined object array leaked the old
373 array.
374 + Reallocation failure for internal reallocation of the quarantined object
375 array (very unlikely) resulted in memory corruption.
Jason Evans06912752013-01-31 17:02:53 -0800376 - Fix Valgrind integration to annotate all internally allocated memory in a
377 way that keeps Valgrind happy about internal data structure access.
Jason Evans22988352013-03-06 11:11:17 -0800378 - Fix building for s390 systems.
Jason Evansbbe29d32013-01-30 15:03:11 -0800379
Jason Evansb5681fb2013-01-22 22:45:09 -0800380* 3.3.0 (January 23, 2013)
381
382 This version includes a few minor performance improvements in addition to the
383 listed new features and bug fixes.
384
385 New features:
386 - Add clipping support to lg_chunk option processing.
387 - Add the --enable-ivsalloc option.
388 - Add the --without-export option.
389 - Add the --disable-zone-allocator option.
Jason Evans6eb84fb2012-11-29 22:13:04 -0800390
391 Bug fixes:
392 - Fix "arenas.extend" mallctl to output the number of arenas.
Jason Evansa33488d2013-10-03 14:38:39 -0700393 - Fix chunk_recycle() to unconditionally inform Valgrind that returned memory
Jason Evans12711852012-12-12 10:12:18 -0800394 is undefined.
Jason Evansb5681fb2013-01-22 22:45:09 -0800395 - Fix build break on FreeBSD related to alloca.h.
Jason Evans6eb84fb2012-11-29 22:13:04 -0800396
Jason Evans556ddc72012-11-07 15:16:29 -0800397* 3.2.0 (November 9, 2012)
398
399 In addition to a couple of bug fixes, this version modifies page run
400 allocation and dirty page purging algorithms in order to better control
401 page-level virtual memory fragmentation.
Jason Evans12efefb2012-10-16 22:06:56 -0700402
Jason Evanse3d13062012-10-30 15:42:37 -0700403 Incompatible changes:
Jason Evans556ddc72012-11-07 15:16:29 -0800404 - Change the "opt.lg_dirty_mult" default from 5 to 3 (32:1 to 8:1).
Jason Evanse3d13062012-10-30 15:42:37 -0700405
Jason Evans12efefb2012-10-16 22:06:56 -0700406 Bug fixes:
407 - Fix dss/mmap allocation precedence code to use recyclable mmap memory only
408 after primary dss allocation fails.
Jason Evanse3d13062012-10-30 15:42:37 -0700409 - Fix deadlock in the "arenas.purge" mallctl. This regression was introduced
410 in 3.1.0 by the addition of the "arena.<i>.purge" mallctl.
Jason Evans12efefb2012-10-16 22:06:56 -0700411
Jason Evans2b592b02012-10-16 10:12:40 -0700412* 3.1.0 (October 16, 2012)
Jason Evans3860eac2012-05-15 13:53:21 -0700413
Jason Evans781fe752012-05-15 14:48:14 -0700414 New features:
415 - Auto-detect whether running inside Valgrind, thus removing the need to
416 manually specify MALLOC_CONF=valgrind:true.
Jason Evans2b592b02012-10-16 10:12:40 -0700417 - Add the "arenas.extend" mallctl, which allows applications to create
418 manually managed arenas.
419 - Add the ALLOCM_ARENA() flag for {,r,d}allocm().
420 - Add the "opt.dss", "arena.<i>.dss", and "stats.arenas.<i>.dss" mallctls,
421 which provide control over dss/mmap precedence.
422 - Add the "arena.<i>.purge" mallctl, which obsoletes "arenas.purge".
423 - Define LG_QUANTUM for hppa.
Jason Evans781fe752012-05-15 14:48:14 -0700424
Jason Evans174b70e2012-05-15 23:31:53 -0700425 Incompatible changes:
426 - Disable tcache by default if running inside Valgrind, in order to avoid
427 making unallocated objects appear reachable to Valgrind.
Jason Evans2b592b02012-10-16 10:12:40 -0700428 - Drop const from malloc_usable_size() argument on Linux.
Jason Evans174b70e2012-05-15 23:31:53 -0700429
Jason Evans3860eac2012-05-15 13:53:21 -0700430 Bug fixes:
431 - Fix heap profiling crash if sampled object is freed via realloc(p, 0).
Jason Evans5c710ce2012-05-23 16:09:22 -0700432 - Remove const from __*_hook variable declarations, so that glibc can modify
433 them during process forking.
Jason Evans2b592b02012-10-16 10:12:40 -0700434 - Fix mlockall(2)/madvise(2) interaction.
435 - Fix fork(2)-related deadlocks.
436 - Fix error return value for "thread.tcache.enabled" mallctl.
Jason Evans3860eac2012-05-15 13:53:21 -0700437
Jason Evanscbb71ca2012-05-11 17:00:20 -0700438* 3.0.0 (May 11, 2012)
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700439
440 Although this version adds some major new features, the primary focus is on
441 internal code cleanup that facilitates maintainability and portability, most
442 of which is not reflected in the ChangeLog. This is the first release to
443 incorporate substantial contributions from numerous other developers, and the
444 result is a more broadly useful allocator (see the git revision history for
445 contribution details). Note that the license has been unified, thanks to
446 Facebook granting a license under the same terms as the other copyright
447 holders (see COPYING).
448
449 New features:
450 - Implement Valgrind support, redzones, and quarantine.
Jason Evans079687b2012-04-23 12:49:23 -0700451 - Add support for additional platforms:
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700452 + FreeBSD
453 + Mac OS X Lion
Jason Evans40f514f2012-04-22 16:21:06 -0700454 + MinGW
Jason Evanscbb71ca2012-05-11 17:00:20 -0700455 + Windows (no support yet for replacing the system malloc)
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700456 - Add support for additional architectures:
457 + MIPS
458 + SH4
459 + Tilera
460 - Add support for cross compiling.
461 - Add nallocm(), which rounds a request size up to the nearest size class
462 without actually allocating.
463 - Implement aligned_alloc() (blame C11).
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700464 - Add the "thread.tcache.enabled" mallctl.
Jason Evans0b25fe72012-04-17 16:39:33 -0700465 - Add the "opt.prof_final" mallctl.
Jason Evans25a000e2012-04-17 15:49:30 -0700466 - Update pprof (from gperftools 2.0).
Jason Evanscbb71ca2012-05-11 17:00:20 -0700467 - Add the --with-mangling option.
468 - Add the --disable-experimental option.
469 - Add the --disable-munmap option, and make it the default on Linux.
470 - Add the --enable-mremap option, which disables use of mremap(2) by default.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700471
472 Incompatible changes:
473 - Enable stats by default.
474 - Enable fill by default.
475 - Disable lazy locking by default.
476 - Rename the "tcache.flush" mallctl to "thread.tcache.flush".
477 - Rename the "arenas.pagesize" mallctl to "arenas.page".
Jason Evans0b25fe72012-04-17 16:39:33 -0700478 - Change the "opt.lg_prof_sample" default from 0 to 19 (1 B to 512 KiB).
479 - Change the "opt.prof_accum" default from true to false.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700480
481 Removed features:
482 - Remove the swap feature, including the "config.swap", "swap.avail",
483 "swap.prezeroed", "swap.nfds", and "swap.fds" mallctls.
484 - Remove highruns statistics, including the
485 "stats.arenas.<i>.bins.<j>.highruns" and
486 "stats.arenas.<i>.lruns.<j>.highruns" mallctls.
487 - As part of small size class refactoring, remove the "opt.lg_[qc]space_max",
488 "arenas.cacheline", "arenas.subpage", "arenas.[tqcs]space_{min,max}", and
489 "arenas.[tqcs]bins" mallctls.
490 - Remove the "arenas.chunksize" mallctl.
491 - Remove the "opt.lg_prof_tcmax" option.
492 - Remove the "opt.lg_prof_bt_max" option.
493 - Remove the "opt.lg_tcache_gc_sweep" option.
494 - Remove the --disable-tiny option, including the "config.tiny" mallctl.
495 - Remove the --enable-dynamic-page-shift configure option.
496 - Remove the --enable-sysv configure option.
497
498 Bug fixes:
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700499 - Fix a statistics-related bug in the "thread.arena" mallctl that could cause
500 invalid statistics and crashes.
Jason Evans079687b2012-04-23 12:49:23 -0700501 - Work around TLS deallocation via free() on Linux. This bug could cause
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700502 write-after-free memory corruption.
Jason Evans52386b22012-04-22 16:00:11 -0700503 - Fix a potential deadlock that could occur during interval- and
504 growth-triggered heap profile dumps.
Jason Evansd8ceef62012-05-10 20:59:39 -0700505 - Fix large calloc() zeroing bugs due to dropping chunk map unzeroed flags.
Jason Evans8f0e0eb2012-04-21 13:33:48 -0700506 - Fix chunk_alloc_dss() to stop claiming memory is zeroed. This bug could
507 cause memory corruption and crashes with --enable-dss specified.
Jason Evans52386b22012-04-22 16:00:11 -0700508 - Fix fork-related bugs that could cause deadlock in children between fork
509 and exec.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700510 - Fix malloc_stats_print() to honor 'b' and 'l' in the opts parameter.
511 - Fix realloc(p, 0) to act like free(p).
512 - Do not enforce minimum alignment in memalign().
513 - Check for NULL pointer in malloc_usable_size().
Jason Evans52386b22012-04-22 16:00:11 -0700514 - Fix an off-by-one heap profile statistics bug that could be observed in
515 interval- and growth-triggered heap profiles.
Jason Evans6b9ed672012-04-25 13:12:46 -0700516 - Fix the "epoch" mallctl to update cached stats even if the passed in epoch
517 is 0.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700518 - Fix bin->runcur management to fix a layout policy bug. This bug did not
519 affect correctness.
520 - Fix a bug in choose_arena_hard() that potentially caused more arenas to be
521 initialized than necessary.
522 - Add missing "opt.lg_tcache_max" mallctl implementation.
523 - Use glibc allocator hooks to make mixed allocator usage less likely.
524 - Fix build issues for --disable-tcache.
Jason Evans918d6e22012-04-20 13:42:21 -0700525 - Don't mangle pthread_create() when --with-private-namespace is specified.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700526
Jason Evansb3bd8852011-11-14 17:12:45 -0800527* 2.2.5 (November 14, 2011)
528
529 Bug fixes:
530 - Fix huge_ralloc() race when using mremap(2). This is a serious bug that
531 could cause memory corruption and/or crashes.
532 - Fix huge_ralloc() to maintain chunk statistics.
533 - Fix malloc_stats_print(..., "a") output.
534
Jason Evansca9ee1a2011-11-05 21:46:23 -0700535* 2.2.4 (November 5, 2011)
536
537 Bug fixes:
538 - Initialize arenas_tsd before using it. This bug existed for 2.2.[0-3], as
539 well as for --disable-tls builds in earlier releases.
540 - Do not assume a 4 KiB page size in test/rallocm.c.
541
Jason Evansc67e4fd2011-08-31 15:19:13 -0700542* 2.2.3 (August 31, 2011)
543
544 This version fixes numerous bugs related to heap profiling.
545
546 Bug fixes:
547 - Fix a prof-related race condition. This bug could cause memory corruption,
548 but only occurred in non-default configurations (prof_accum:false).
549 - Fix off-by-one backtracing issues (make sure that prof_alloc_prep() is
550 excluded from backtraces).
551 - Fix a prof-related bug in realloc() (only triggered by OOM errors).
552 - Fix prof-related bugs in allocm() and rallocm().
553 - Fix prof_tdata_cleanup() for --disable-tls builds.
554 - Fix a relative include path, to fix objdir builds.
555
Jason Evans4c484812011-07-30 16:59:13 -0700556* 2.2.2 (July 30, 2011)
557
558 Bug fixes:
559 - Fix a build error for --disable-tcache.
560 - Fix assertions in arena_purge() (for real this time).
561 - Add the --with-private-namespace option. This is a workaround for symbol
562 conflicts that can inadvertently arise when using static libraries.
563
Jason Evans7d9ebea2011-03-30 15:01:08 -0700564* 2.2.1 (March 30, 2011)
565
566 Bug fixes:
567 - Implement atomic operations for x86/x64. This fixes compilation failures
568 for versions of gcc that are still in wide use.
569 - Fix an assertion in arena_purge().
570
Jason Evans4bcd9872011-03-22 15:30:22 -0700571* 2.2.0 (March 22, 2011)
572
573 This version incorporates several improvements to algorithms and data
574 structures that tend to reduce fragmentation and increase speed.
575
576 New features:
577 - Add the "stats.cactive" mallctl.
578 - Update pprof (from google-perftools 1.7).
579 - Improve backtracing-related configuration logic, and add the
580 --disable-prof-libgcc option.
581
582 Bug fixes:
583 - Change default symbol visibility from "internal", to "hidden", which
584 decreases the overhead of library-internal function calls.
585 - Fix symbol visibility so that it is also set on OS X.
586 - Fix a build dependency regression caused by the introduction of the .pic.o
587 suffix for PIC object files.
588 - Add missing checks for mutex initialization failures.
589 - Don't use libgcc-based backtracing except on x64, where it is known to work.
590 - Fix deadlocks on OS X that were due to memory allocation in
591 pthread_mutex_lock().
592 - Heap profiling-specific fixes:
593 + Fix memory corruption due to integer overflow in small region index
594 computation, when using a small enough sample interval that profiling
595 context pointers are stored in small run headers.
596 + Fix a bootstrap ordering bug that only occurred with TLS disabled.
597 + Fix a rallocm() rsize bug.
598 + Fix error detection bugs for aligned memory allocation.
599
Jason Evans0e4d0d12011-03-14 16:41:03 -0700600* 2.1.3 (March 14, 2011)
601
602 Bug fixes:
603 - Fix a cpp logic regression (due to the "thread.{de,}allocatedp" mallctl fix
604 for OS X in 2.1.2).
605 - Fix a "thread.arena" mallctl bug.
606 - Fix a thread cache stats merging bug.
607
je6e56e5e2011-03-02 11:23:41 -0800608* 2.1.2 (March 2, 2011)
609
610 Bug fixes:
611 - Fix "thread.{de,}allocatedp" mallctl for OS X.
612 - Add missing jemalloc.a to build system.
613
Jason Evans63692862011-02-07 22:48:35 -0800614* 2.1.1 (January 31, 2011)
Jason Evansada55b22011-01-31 20:08:56 -0800615
Jason Evans63692862011-02-07 22:48:35 -0800616 Bug fixes:
Jason Evansada55b22011-01-31 20:08:56 -0800617 - Fix aligned huge reallocation (affected allocm()).
618 - Fix the ALLOCM_LG_ALIGN macro definition.
619 - Fix a heap dumping deadlock.
620 - Fix a "thread.arena" mallctl bug.
621
Jason Evans63692862011-02-07 22:48:35 -0800622* 2.1.0 (December 3, 2010)
Jason Evans0e8d3d22010-12-03 17:02:16 -0800623
624 This version incorporates some optimizations that can't quite be considered
625 bug fixes.
626
627 New features:
628 - Use Linux's mremap(2) for huge object reallocation when possible.
629 - Avoid locking in mallctl*() when possible.
630 - Add the "thread.[de]allocatedp" mallctl's.
631 - Convert the manual page source from roff to DocBook, and generate both roff
632 and HTML manuals.
633
634 Bug fixes:
635 - Fix a crash due to incorrect bootstrap ordering. This only impacted
636 --enable-debug --enable-dss configurations.
637 - Fix a minor statistics bug for mallctl("swap.avail", ...).
638
Jason Evans63692862011-02-07 22:48:35 -0800639* 2.0.1 (October 29, 2010)
Jason Evans53806fe2010-10-29 20:16:39 -0700640
641 Bug fixes:
642 - Fix a race condition in heap profiling that could cause undefined behavior
Jason Evansada55b22011-01-31 20:08:56 -0800643 if "opt.prof_accum" were disabled.
Jason Evans53806fe2010-10-29 20:16:39 -0700644 - Add missing mutex unlocks for some OOM error paths in the heap profiling
645 code.
646 - Fix a compilation error for non-C99 builds.
647
Jason Evans63692862011-02-07 22:48:35 -0800648* 2.0.0 (October 24, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700649
650 This version focuses on the experimental *allocm() API, and on improved
651 run-time configuration/introspection. Nonetheless, numerous performance
652 improvements are also included.
653
654 New features:
Jason Evansb059a532010-10-24 16:54:40 -0700655 - Implement the experimental {,r,s,d}allocm() API, which provides a superset
656 of the functionality available via malloc(), calloc(), posix_memalign(),
657 realloc(), malloc_usable_size(), and free(). These functions can be used to
658 allocate/reallocate aligned zeroed memory, ask for optional extra memory
659 during reallocation, prevent object movement during reallocation, etc.
660 - Replace JEMALLOC_OPTIONS/JEMALLOC_PROF_PREFIX with MALLOC_CONF, which is
661 more human-readable, and more flexible. For example:
662 JEMALLOC_OPTIONS=AJP
663 is now:
664 MALLOC_CONF=abort:true,fill:true,stats_print:true
665 - Port to Apple OS X. Sponsored by Mozilla.
666 - Make it possible for the application to control thread-->arena mappings via
667 the "thread.arena" mallctl.
668 - Add compile-time support for all TLS-related functionality via pthreads TSD.
669 This is mainly of interest for OS X, which does not support TLS, but has a
670 TSD implementation with similar performance.
671 - Override memalign() and valloc() if they are provided by the system.
672 - Add the "arenas.purge" mallctl, which can be used to synchronously purge all
673 dirty unused pages.
674 - Make cumulative heap profiling data optional, so that it is possible to
675 limit the amount of memory consumed by heap profiling data structures.
676 - Add per thread allocation counters that can be accessed via the
677 "thread.allocated" and "thread.deallocated" mallctls.
Jason Evans379f8472010-10-24 16:18:29 -0700678
679 Incompatible changes:
Jason Evansb059a532010-10-24 16:54:40 -0700680 - Remove JEMALLOC_OPTIONS and malloc_options (see MALLOC_CONF above).
681 - Increase default backtrace depth from 4 to 128 for heap profiling.
682 - Disable interval-based profile dumps by default.
Jason Evans379f8472010-10-24 16:18:29 -0700683
684 Bug fixes:
685 - Remove bad assertions in fork handler functions. These assertions could
686 cause aborts for some combinations of configure settings.
687 - Fix strerror_r() usage to deal with non-standard semantics in GNU libc.
688 - Fix leak context reporting. This bug tended to cause the number of contexts
689 to be underreported (though the reported number of objects and bytes were
690 correct).
691 - Fix a realloc() bug for large in-place growing reallocation. This bug could
692 cause memory corruption, but it was hard to trigger.
693 - Fix an allocation bug for small allocations that could be triggered if
694 multiple threads raced to create a new run of backing pages.
695 - Enhance the heap profiler to trigger samples based on usable size, rather
696 than request size.
697 - Fix a heap profiling bug due to sometimes losing track of requested object
698 size for sampled objects.
699
Jason Evans63692862011-02-07 22:48:35 -0800700* 1.0.3 (August 12, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700701
702 Bug fixes:
703 - Fix the libunwind-based implementation of stack backtracing (used for heap
704 profiling). This bug could cause zero-length backtraces to be reported.
705 - Add a missing mutex unlock in library initialization code. If multiple
706 threads raced to initialize malloc, some of them could end up permanently
707 blocked.
708
Jason Evans63692862011-02-07 22:48:35 -0800709* 1.0.2 (May 11, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700710
711 Bug fixes:
712 - Fix junk filling of large objects, which could cause memory corruption.
713 - Add MAP_NORESERVE support for chunk mapping, because otherwise virtual
714 memory limits could cause swap file configuration to fail. Contributed by
715 Jordan DeLong.
716
Jason Evans63692862011-02-07 22:48:35 -0800717* 1.0.1 (April 14, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700718
719 Bug fixes:
720 - Fix compilation when --enable-fill is specified.
721 - Fix threads-related profiling bugs that affected accuracy and caused memory
722 to be leaked during thread exit.
723 - Fix dirty page purging race conditions that could cause crashes.
724 - Fix crash in tcache flushing code during thread destruction.
725
Jason Evans63692862011-02-07 22:48:35 -0800726* 1.0.0 (April 11, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700727
728 This release focuses on speed and run-time introspection. Numerous
729 algorithmic improvements make this release substantially faster than its
730 predecessors.
731
732 New features:
733 - Implement autoconf-based configuration system.
734 - Add mallctl*(), for the purposes of introspection and run-time
735 configuration.
736 - Make it possible for the application to manually flush a thread's cache, via
737 the "tcache.flush" mallctl.
738 - Base maximum dirty page count on proportion of active memory.
charsyamad6800f2015-07-04 01:06:06 +0900739 - Compute various additional run-time statistics, including per size class
Jason Evans379f8472010-10-24 16:18:29 -0700740 statistics for large objects.
741 - Expose malloc_stats_print(), which can be called repeatedly by the
742 application.
743 - Simplify the malloc_message() signature to only take one string argument,
744 and incorporate an opaque data pointer argument for use by the application
745 in combination with malloc_stats_print().
746 - Add support for allocation backed by one or more swap files, and allow the
747 application to disable over-commit if swap files are in use.
748 - Implement allocation profiling and leak checking.
749
750 Removed features:
751 - Remove the dynamic arena rebalancing code, since thread-specific caching
752 reduces its utility.
753
754 Bug fixes:
755 - Modify chunk allocation to work when address space layout randomization
756 (ASLR) is in use.
757 - Fix thread cleanup bugs related to TLS destruction.
758 - Handle 0-size allocation requests in posix_memalign().
759 - Fix a chunk leak. The leaked chunks were never touched, so this impacted
760 virtual memory usage, but not physical memory usage.
761
Jason Evans63692862011-02-07 22:48:35 -0800762* linux_2008082[78]a (August 27/28, 2008)
Jason Evans379f8472010-10-24 16:18:29 -0700763
764 These snapshot releases are the simple result of incorporating Linux-specific
765 support into the FreeBSD malloc sources.
766
767--------------------------------------------------------------------------------
768vim:filetype=text:textwidth=80