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