blob: 49faa13577edd5e213cb591ac44cb4d55a12ba49 [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 Evans54673fd2015-02-23 22:28:43 -08007* 4.0.0 (XXX) See https://github.com/jemalloc/jemalloc/milestones/4.0.0 for
8 remaining work.
9
10 This version contains many speed and space optimizations, both minor and
11 major. The major themes are generalization, unification, and simplification.
12 Although many of these optimizations cause no visible behavior change, their
13 cumulative effect is substantial.
14
15 New features:
16 - Normalize size class spacing to be consistent across the complete size
17 range. By default there are four size classes per size doubling, but this
18 is now configurable via the --with-lg-size-class-group option. Also add the
19 --with-lg-page, --with-lg-page-sizes, --with-lg-quantum, and
20 --with-lg-tiny-min options, which can be used to tweak page and size class
21 settings. Impacts:
22 + Worst case performance for incrementally growing/shrinking reallocation
23 is improved because there are far fewer size classes, and therefore
24 copying happens less often.
25 + Internal fragmentation is limited to 20% for all but the smallest size
26 classes (those less than four times the quantum). (1B + 4 KiB)
27 and (1B + 4 MiB) previously suffered nearly 50% internal fragmentation.
28 + Chunk fragmentation tends to be lower because there are fewer distinct run
29 sizes to pack.
30 - Add support for explicit tcaches. The "tcache.create", "tcache.flush", and
31 "tcache.destroy" mallctls control tcache lifetime and flushing, and the
32 MALLOCX_TCACHE(tc) and MALLOCX_TCACHE_NONE flags to the *allocx() API
33 control which tcache is used for each operation.
34 - Implement per thread heap profiling, as well as the ability to
35 enable/disable heap profiling on a per thread basis. Add the "prof.reset",
36 "prof.lg_sample", "thread.prof.name", "thread.prof.active",
37 "opt.prof_thread_active_init", "prof.thread_active_init", and
38 "thread.prof.active" mallctls.
39 - Add support for per arena application-specified chunk allocators, configured
Jason Evans562d2662015-03-24 16:36:12 -070040 via the "arena<i>.chunk.alloc", "arena<i>.chunk.dalloc", and
41 "arena.<i>.chunk.purge" mallctls.
Jason Evans54673fd2015-02-23 22:28:43 -080042 - Refactor huge allocation to be managed by arenas, so that arenas now
43 function as general purpose independent allocators. This is important in
44 the context of user-specified chunk allocators, aside from the scalability
45 benefits. Related new statistics:
46 + The "stats.arenas.<i>.huge.allocated", "stats.arenas.<i>.huge.nmalloc",
47 "stats.arenas.<i>.huge.ndalloc", and "stats.arenas.<i>.huge.nrequests"
48 mallctls provide high level per arena huge allocation statistics.
Qinfan Wu89750352015-04-21 16:57:42 -070049 + The "arenas.nhchunks", "arenas.hchunk.<i>.size",
Jason Evans54673fd2015-02-23 22:28:43 -080050 "stats.arenas.<i>.hchunks.<j>.nmalloc",
51 "stats.arenas.<i>.hchunks.<j>.ndalloc",
52 "stats.arenas.<i>.hchunks.<j>.nrequests", and
53 "stats.arenas.<i>.hchunks.<j>.curhchunks" mallctls provide per size class
54 statistics.
55 - Add the 'util' column to malloc_stats_print() output, which reports the
56 proportion of available regions that are currently in use for each small
57 size class.
58 - Add "alloc" and "free" modes for for junk filling (see the "opt.junk"
59 mallctl), so that it is possible to separately enable junk filling for
60 allocation versus deallocation.
61 - Add the jemalloc-config script, which provides information about how
62 jemalloc was configured, and how to integrate it into application builds.
63 - Add metadata statistics, which are accessible via the "stats.metadata",
64 "stats.arenas.<i>.metadata.mapped", and
65 "stats.arenas.<i>.metadata.allocated" mallctls.
Jason Evans4acd75a2015-03-23 17:25:57 -070066 - Add the "stats.resident" mallctl, which reports the upper limit of
67 physically resident memory mapped by the allocator.
Jason Evans562d2662015-03-24 16:36:12 -070068 - Add per arena control over unused dirty page purging, via the
69 "arenas.lg_dirty_mult", "arena.<i>.lg_dirty_mult", and
70 "stats.arenas.<i>.lg_dirty_mult" mallctls.
Jason Evans54673fd2015-02-23 22:28:43 -080071 - Add the "prof.gdump" mallctl, which makes it possible to toggle the gdump
72 feature on/off during program execution.
73 - Add sdallocx(), which implements sized deallocation. The primary
74 optimization over dallocx() is the removal of a metadata read, which often
75 suffers an L1 cache miss.
76 - Add missing header includes in jemalloc/jemalloc.h, so that applications
77 only have to #include <jemalloc/jemalloc.h>.
78 - Add support for additional platforms:
79 + Bitrig
80 + Cygwin
81 + DragonFlyBSD
82 + iOS
83 + OpenBSD
84 + OpenRISC/or1k
85
86 Optimizations:
87 - Switch run and chunk allocation from first-best-fit (among best-fit
88 candidates, choose the lowest in memory) to first-fit (among all candidates,
89 choose the lowest in memory). This tends to reduce chunk and virtual memory
90 fragmentation, respectively.
91 - Maintain dirty runs in per arena LRUs rather than in per arena trees of
92 dirty-run-containing chunks. In practice this change significantly reduces
93 dirty page purging volume.
94 - Integrate whole chunks into the unused dirty page purging machinery. This
95 reduces the cost of repeated huge allocation/deallocation, because it
96 effectively introduces a cache of chunks.
97 - Split the arena chunk map into two separate arrays, in order to increase
98 cache locality for the frequently accessed bits.
99 - Move small run metadata out of runs, into arena chunk headers. This reduces
100 run fragmentation, smaller runs reduce external fragmentation for small size
101 classes, and packed (less uniformly aligned) metadata layout improves CPU
102 cache set distribution.
Jason Evans8a03cf02015-05-04 09:58:36 -0700103 - Randomly distribute large allocation base pointer alignment relative to page
104 boundaries in order to more uniformly utilize CPU cache sets. This can be
105 disabled via the --disable-cache-oblivious configure option.
Jason Evans54673fd2015-02-23 22:28:43 -0800106 - Micro-optimize the fast paths for the public API functions.
107 - Refactor thread-specific data to reside in a single structure. This assures
108 that only a single TLS read is necessary per call into the public API.
109 - Implement in-place huge allocation growing and shrinking.
110 - Refactor rtree (radix tree for chunk lookups) to be lock-free, and make
111 additional optimizations that reduce maximum lookup depth to one or two
112 levels. This resolves what was a concurrency bottleneck for per arena huge
113 allocation, because a global data structure is critical for determining
114 which arenas own which huge allocations.
115
116 Incompatible changes:
117 - Replace --enable-cc-silence with --disable-cc-silence to suppress spurious
118 warnings by default.
119 - Assure that the constness of malloc_usable_size()'s return type matches that
120 of the system implementation.
121 - Change the heap profile dump format to support per thread heap profiling,
Jason Evans70417202015-05-01 12:31:12 -0700122 rename pprof to jeprof, and enhance it with the --thread=<n> option. As a
123 result, the bundled jeprof must now be used rather than the upstream
124 (gperftools) pprof.
Jason Evans54673fd2015-02-23 22:28:43 -0800125 - Disable "opt.prof_final" by default, in order to avoid atexit(3), which can
126 internally deadlock on some platforms.
127 - Change the "arenas.nlruns" mallctl type from size_t to unsigned.
128 - Replace the "stats.arenas.<i>.bins.<j>.allocated" mallctl with
129 "stats.arenas.<i>.bins.<j>.curregs".
130 - Ignore MALLOC_CONF in set{uid,gid,cap} binaries.
131 - Ignore MALLOCX_ARENA(a) in dallocx(), in favor of using the
132 MALLOCX_TCACHE(tc) and MALLOCX_TCACHE_NONE flags to control tcache usage.
133
134 Removed features:
135 - Remove the *allocm() API, which is superseded by the *allocx() API.
136 - Remove the --enable-dss options, and make dss non-optional on all platforms
137 which support sbrk(2).
138 - Remove the "arenas.purge" mallctl, which was obsoleted by the
139 "arena.<i>.purge" mallctl in 3.1.0.
140 - Remove the unnecessary "opt.valgrind" mallctl; jemalloc automatically
141 detects whether it is running inside Valgrind.
142 - Remove the "stats.huge.allocated", "stats.huge.nmalloc", and
143 "stats.huge.ndalloc" mallctls.
144 - Remove the --enable-mremap option.
Jason Evans54673fd2015-02-23 22:28:43 -0800145 - Remove the "stats.chunks.current", "stats.chunks.total", and
146 "stats.chunks.high" mallctls.
147
148 Bug fixes:
149 - Fix the cactive statistic to decrease (rather than increase) when active
150 memory decreases. This regression was first released in 3.5.0.
151 - Fix OOM handling in memalign() and valloc(). A variant of this bug existed
152 in all releases since 2.0.0, which introduced these functions.
Jason Evans241abc62015-06-23 18:47:07 -0700153 - Fix size class overflow handling for malloc(), posix_memalign(), memalign(),
154 calloc(), and realloc() when profiling is enabled.
Jason Evans54673fd2015-02-23 22:28:43 -0800155 - Fix the "arena.<i>.dss" mallctl to return an error if "primary" or
156 "secondary" precedence is specified, but sbrk(2) is not supported.
157 - Fix fallback lg_floor() implementations to handle extremely large inputs.
158 - Ensure the default purgeable zone is after the default zone on OS X.
159 - Fix latent bugs in atomic_*().
160 - Fix the "arena.<i>.dss" mallctl to handle read-only calls.
161 - Fix tls_model configuration to enable the initial-exec model when possible.
162 - Mark malloc_conf as a weak symbol so that the application can override it.
163 - Correctly detect glibc's adaptive pthread mutexes.
164 - Fix the --without-export configure option.
165
Jason Evansff536312014-03-31 09:23:10 -0700166* 3.6.0 (March 31, 2014)
167
168 This version contains a critical bug fix for a regression present in 3.5.0 and
169 3.5.1.
170
171 Bug fixes:
172 - Fix a regression in arena_chunk_alloc() that caused crashes during
173 small/large allocation if chunk allocation failed. In the absence of this
174 bug, chunk allocation failure would result in allocation failure, e.g. NULL
175 return from malloc(). This regression was introduced in 3.5.0.
176 - Fix backtracing for gcc intrinsics-based backtracing by specifying
177 -fno-omit-frame-pointer to gcc. Note that the application (and all the
178 libraries it links to) must also be compiled with this option for
179 backtracing to be reliable.
180 - Use dss allocation precedence for huge allocations as well as small/large
181 allocations.
Jason Evans54673fd2015-02-23 22:28:43 -0800182 - Fix test assertion failure message formatting. This bug did not manifest on
Jason Evansff536312014-03-31 09:23:10 -0700183 x86_64 systems because of implementation subtleties in va_list.
184 - Fix inconsequential test failures for hash and SFMT code.
185
186 New features:
187 - Support heap profiling on FreeBSD. This feature depends on the proc
188 filesystem being mounted during heap profile dumping.
189
Jason Evansb9ec5c92014-02-25 16:43:51 -0800190* 3.5.1 (February 25, 2014)
191
192 This version primarily addresses minor bugs in test code.
193
194 Bug fixes:
195 - Configure Solaris/Illumos to use MADV_FREE.
196 - Fix junk filling for mremap(2)-based huge reallocation. This is only
197 relevant if configuring with the --enable-mremap option specified.
198 - Avoid compilation failure if 'restrict' C99 keyword is not supported by the
199 compiler.
200 - Add a configure test for SSE2 rather than assuming it is usable on i686
201 systems. This fixes test compilation errors, especially on 32-bit Linux
202 systems.
203 - Fix mallctl argument size mismatches (size_t vs. uint64_t) in the stats unit
204 test.
205 - Fix/remove flawed alignment-related overflow tests.
206 - Prevent compiler optimizations that could change backtraces in the
207 prof_accum unit test.
Jason Evans379f8472010-10-24 16:18:29 -0700208
Jason Evans798a4812014-01-22 11:09:50 -0800209* 3.5.0 (January 22, 2014)
Jason Evans86abd0d2013-11-30 15:25:42 -0800210
Jason Evans264dfd32014-01-17 17:01:23 -0800211 This version focuses on refactoring and automated testing, though it also
212 includes some non-trivial heap profiling optimizations not mentioned below.
213
214 New features:
215 - Add the *allocx() API, which is a successor to the experimental *allocm()
216 API. The *allocx() functions are slightly simpler to use because they have
217 fewer parameters, they directly return the results of primary interest, and
218 mallocx()/rallocx() avoid the strict aliasing pitfall that
Jason Evans9c8baec2014-01-22 13:08:47 -0800219 allocm()/rallocm() share with posix_memalign(). Note that *allocm() is
Jason Evans264dfd32014-01-17 17:01:23 -0800220 slated for removal in the next non-bugfix release.
221 - Add support for LinuxThreads.
222
Jason Evans86abd0d2013-11-30 15:25:42 -0800223 Bug fixes:
Jason Evansd37d5ad2013-12-05 23:01:50 -0800224 - Unless heap profiling is enabled, disable floating point code and don't link
225 with libm. This, in combination with e.g. EXTRA_CFLAGS=-mno-sse on x64
226 systems, makes it possible to completely disable floating point register
227 use. Some versions of glibc neglect to save/restore caller-saved floating
228 point registers during dynamic lazy symbol loading, and the symbol loading
229 code uses whatever malloc the application happens to have linked/loaded
230 with, the result being potential floating point register corruption.
Jason Evans264dfd32014-01-17 17:01:23 -0800231 - Report ENOMEM rather than EINVAL if an OOM occurs during heap profiling
232 backtrace creation in imemalign(). This bug impacted posix_memalign() and
233 aligned_alloc().
234 - Fix a file descriptor leak in a prof_dump_maps() error path.
235 - Fix prof_dump() to close the dump file descriptor for all relevant error
236 paths.
237 - Fix rallocm() to use the arena specified by the ALLOCM_ARENA(s) flag for
238 allocation, not just deallocation.
239 - Fix a data race for large allocation stats counters.
240 - Fix a potential infinite loop during thread exit. This bug occurred on
241 Solaris, and could affect other platforms with similar pthreads TSD
242 implementations.
243 - Don't junk-fill reallocations unless usable size changes. This fixes a
244 violation of the *allocx()/*allocm() semantics.
245 - Fix growing large reallocation to junk fill new space.
246 - Fix huge deallocation to junk fill when munmap is disabled.
Jason Evans86abd0d2013-11-30 15:25:42 -0800247 - Change the default private namespace prefix from empty to je_, and change
248 --with-private-namespace-prefix so that it prepends an additional prefix
249 rather than replacing je_. This reduces the likelihood of applications
250 which statically link jemalloc experiencing symbol name collisions.
Jason Evans264dfd32014-01-17 17:01:23 -0800251 - Add missing private namespace mangling (relevant when
252 --with-private-namespace is specified).
253 - Add and use JEMALLOC_INLINE_C so that static inline functions are marked as
254 static even for debug builds.
255 - Add a missing mutex unlock in a malloc_init_hard() error path. In practice
256 this error path is never executed.
257 - Fix numerous bugs in malloc_strotumax() error handling/reporting. These
258 bugs had no impact except for malformed inputs.
259 - Fix numerous bugs in malloc_snprintf(). These bugs were not exercised by
260 existing calls, so they had no impact.
Jason Evans86abd0d2013-11-30 15:25:42 -0800261
Jason Evans0f7ba3f2013-10-20 19:40:09 -0700262* 3.4.1 (October 20, 2013)
Jason Evansff08ef72013-10-19 21:41:10 -0700263
264 Bug fixes:
Jason Evans7b651802013-10-20 14:09:54 -0700265 - Fix a race in the "arenas.extend" mallctl that could cause memory corruption
266 of internal data structures and subsequent crashes.
Jason Evansdda90f52013-10-19 23:48:40 -0700267 - Fix Valgrind integration flaws that caused Valgrind warnings about reads of
268 uninitialized memory in:
269 + arena chunk headers
270 + internal zero-initialized data structures (relevant to tcache and prof
271 code)
Jason Evansff08ef72013-10-19 21:41:10 -0700272 - Preserve errno during the first allocation. A readlink(2) call during
273 initialization fails unless /etc/malloc.conf exists, so errno was typically
274 set during the first allocation prior to this fix.
275 - Fix compilation warnings reported by gcc 4.8.1.
276
Jason Evans765cc2b2013-06-02 20:58:00 -0700277* 3.4.0 (June 2, 2013)
278
279 This version is essentially a small bugfix release, but the addition of
280 aarch64 support requires that the minor version be incremented.
281
282 Bug fixes:
283 - Fix race-triggered deadlocks in chunk_record(). These deadlocks were
284 typically triggered by multiple threads concurrently deallocating huge
285 objects.
286
287 New features:
288 - Add support for the aarch64 architecture.
289
Jason Evans22988352013-03-06 11:11:17 -0800290* 3.3.1 (March 6, 2013)
291
292 This version fixes bugs that are typically encountered only when utilizing
293 custom run-time options.
Jason Evansbbe29d32013-01-30 15:03:11 -0800294
295 Bug fixes:
Jason Evans88c222c2013-02-06 11:59:30 -0800296 - Fix a locking order bug that could cause deadlock during fork if heap
297 profiling were enabled.
Jason Evansa7a28c32013-01-31 16:53:58 -0800298 - Fix a chunk recycling bug that could cause the allocator to lose track of
Jason Evans765cc2b2013-06-02 20:58:00 -0700299 whether a chunk was zeroed. On FreeBSD, NetBSD, and OS X, it could cause
Jason Evansa7a28c32013-01-31 16:53:58 -0800300 corruption if allocating via sbrk(2) (unlikely unless running with the
301 "dss:primary" option specified). This was completely harmless on Linux
302 unless using mlockall(2) (and unlikely even then, unless the
303 --disable-munmap configure option or the "dss:primary" option was
304 specified). This regression was introduced in 3.1.0 by the
305 mlockall(2)/madvise(2) interaction fix.
Jason Evansbbe29d32013-01-30 15:03:11 -0800306 - Fix TLS-related memory corruption that could occur during thread exit if the
307 thread never allocated memory. Only the quarantine and prof facilities were
308 susceptible.
Jason Evansd0e942e2013-01-31 14:42:41 -0800309 - Fix two quarantine bugs:
310 + Internal reallocation of the quarantined object array leaked the old
311 array.
312 + Reallocation failure for internal reallocation of the quarantined object
313 array (very unlikely) resulted in memory corruption.
Jason Evans06912752013-01-31 17:02:53 -0800314 - Fix Valgrind integration to annotate all internally allocated memory in a
315 way that keeps Valgrind happy about internal data structure access.
Jason Evans22988352013-03-06 11:11:17 -0800316 - Fix building for s390 systems.
Jason Evansbbe29d32013-01-30 15:03:11 -0800317
Jason Evansb5681fb2013-01-22 22:45:09 -0800318* 3.3.0 (January 23, 2013)
319
320 This version includes a few minor performance improvements in addition to the
321 listed new features and bug fixes.
322
323 New features:
324 - Add clipping support to lg_chunk option processing.
325 - Add the --enable-ivsalloc option.
326 - Add the --without-export option.
327 - Add the --disable-zone-allocator option.
Jason Evans6eb84fb2012-11-29 22:13:04 -0800328
329 Bug fixes:
330 - Fix "arenas.extend" mallctl to output the number of arenas.
Jason Evansa33488d2013-10-03 14:38:39 -0700331 - Fix chunk_recycle() to unconditionally inform Valgrind that returned memory
Jason Evans12711852012-12-12 10:12:18 -0800332 is undefined.
Jason Evansb5681fb2013-01-22 22:45:09 -0800333 - Fix build break on FreeBSD related to alloca.h.
Jason Evans6eb84fb2012-11-29 22:13:04 -0800334
Jason Evans556ddc72012-11-07 15:16:29 -0800335* 3.2.0 (November 9, 2012)
336
337 In addition to a couple of bug fixes, this version modifies page run
338 allocation and dirty page purging algorithms in order to better control
339 page-level virtual memory fragmentation.
Jason Evans12efefb2012-10-16 22:06:56 -0700340
Jason Evanse3d13062012-10-30 15:42:37 -0700341 Incompatible changes:
Jason Evans556ddc72012-11-07 15:16:29 -0800342 - Change the "opt.lg_dirty_mult" default from 5 to 3 (32:1 to 8:1).
Jason Evanse3d13062012-10-30 15:42:37 -0700343
Jason Evans12efefb2012-10-16 22:06:56 -0700344 Bug fixes:
345 - Fix dss/mmap allocation precedence code to use recyclable mmap memory only
346 after primary dss allocation fails.
Jason Evanse3d13062012-10-30 15:42:37 -0700347 - Fix deadlock in the "arenas.purge" mallctl. This regression was introduced
348 in 3.1.0 by the addition of the "arena.<i>.purge" mallctl.
Jason Evans12efefb2012-10-16 22:06:56 -0700349
Jason Evans2b592b02012-10-16 10:12:40 -0700350* 3.1.0 (October 16, 2012)
Jason Evans3860eac2012-05-15 13:53:21 -0700351
Jason Evans781fe752012-05-15 14:48:14 -0700352 New features:
353 - Auto-detect whether running inside Valgrind, thus removing the need to
354 manually specify MALLOC_CONF=valgrind:true.
Jason Evans2b592b02012-10-16 10:12:40 -0700355 - Add the "arenas.extend" mallctl, which allows applications to create
356 manually managed arenas.
357 - Add the ALLOCM_ARENA() flag for {,r,d}allocm().
358 - Add the "opt.dss", "arena.<i>.dss", and "stats.arenas.<i>.dss" mallctls,
359 which provide control over dss/mmap precedence.
360 - Add the "arena.<i>.purge" mallctl, which obsoletes "arenas.purge".
361 - Define LG_QUANTUM for hppa.
Jason Evans781fe752012-05-15 14:48:14 -0700362
Jason Evans174b70e2012-05-15 23:31:53 -0700363 Incompatible changes:
364 - Disable tcache by default if running inside Valgrind, in order to avoid
365 making unallocated objects appear reachable to Valgrind.
Jason Evans2b592b02012-10-16 10:12:40 -0700366 - Drop const from malloc_usable_size() argument on Linux.
Jason Evans174b70e2012-05-15 23:31:53 -0700367
Jason Evans3860eac2012-05-15 13:53:21 -0700368 Bug fixes:
369 - Fix heap profiling crash if sampled object is freed via realloc(p, 0).
Jason Evans5c710ce2012-05-23 16:09:22 -0700370 - Remove const from __*_hook variable declarations, so that glibc can modify
371 them during process forking.
Jason Evans2b592b02012-10-16 10:12:40 -0700372 - Fix mlockall(2)/madvise(2) interaction.
373 - Fix fork(2)-related deadlocks.
374 - Fix error return value for "thread.tcache.enabled" mallctl.
Jason Evans3860eac2012-05-15 13:53:21 -0700375
Jason Evanscbb71ca2012-05-11 17:00:20 -0700376* 3.0.0 (May 11, 2012)
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700377
378 Although this version adds some major new features, the primary focus is on
379 internal code cleanup that facilitates maintainability and portability, most
380 of which is not reflected in the ChangeLog. This is the first release to
381 incorporate substantial contributions from numerous other developers, and the
382 result is a more broadly useful allocator (see the git revision history for
383 contribution details). Note that the license has been unified, thanks to
384 Facebook granting a license under the same terms as the other copyright
385 holders (see COPYING).
386
387 New features:
388 - Implement Valgrind support, redzones, and quarantine.
Jason Evans079687b2012-04-23 12:49:23 -0700389 - Add support for additional platforms:
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700390 + FreeBSD
391 + Mac OS X Lion
Jason Evans40f514f2012-04-22 16:21:06 -0700392 + MinGW
Jason Evanscbb71ca2012-05-11 17:00:20 -0700393 + Windows (no support yet for replacing the system malloc)
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700394 - Add support for additional architectures:
395 + MIPS
396 + SH4
397 + Tilera
398 - Add support for cross compiling.
399 - Add nallocm(), which rounds a request size up to the nearest size class
400 without actually allocating.
401 - Implement aligned_alloc() (blame C11).
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700402 - Add the "thread.tcache.enabled" mallctl.
Jason Evans0b25fe72012-04-17 16:39:33 -0700403 - Add the "opt.prof_final" mallctl.
Jason Evans25a000e2012-04-17 15:49:30 -0700404 - Update pprof (from gperftools 2.0).
Jason Evanscbb71ca2012-05-11 17:00:20 -0700405 - Add the --with-mangling option.
406 - Add the --disable-experimental option.
407 - Add the --disable-munmap option, and make it the default on Linux.
408 - Add the --enable-mremap option, which disables use of mremap(2) by default.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700409
410 Incompatible changes:
411 - Enable stats by default.
412 - Enable fill by default.
413 - Disable lazy locking by default.
414 - Rename the "tcache.flush" mallctl to "thread.tcache.flush".
415 - Rename the "arenas.pagesize" mallctl to "arenas.page".
Jason Evans0b25fe72012-04-17 16:39:33 -0700416 - Change the "opt.lg_prof_sample" default from 0 to 19 (1 B to 512 KiB).
417 - Change the "opt.prof_accum" default from true to false.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700418
419 Removed features:
420 - Remove the swap feature, including the "config.swap", "swap.avail",
421 "swap.prezeroed", "swap.nfds", and "swap.fds" mallctls.
422 - Remove highruns statistics, including the
423 "stats.arenas.<i>.bins.<j>.highruns" and
424 "stats.arenas.<i>.lruns.<j>.highruns" mallctls.
425 - As part of small size class refactoring, remove the "opt.lg_[qc]space_max",
426 "arenas.cacheline", "arenas.subpage", "arenas.[tqcs]space_{min,max}", and
427 "arenas.[tqcs]bins" mallctls.
428 - Remove the "arenas.chunksize" mallctl.
429 - Remove the "opt.lg_prof_tcmax" option.
430 - Remove the "opt.lg_prof_bt_max" option.
431 - Remove the "opt.lg_tcache_gc_sweep" option.
432 - Remove the --disable-tiny option, including the "config.tiny" mallctl.
433 - Remove the --enable-dynamic-page-shift configure option.
434 - Remove the --enable-sysv configure option.
435
436 Bug fixes:
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700437 - Fix a statistics-related bug in the "thread.arena" mallctl that could cause
438 invalid statistics and crashes.
Jason Evans079687b2012-04-23 12:49:23 -0700439 - Work around TLS deallocation via free() on Linux. This bug could cause
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700440 write-after-free memory corruption.
Jason Evans52386b22012-04-22 16:00:11 -0700441 - Fix a potential deadlock that could occur during interval- and
442 growth-triggered heap profile dumps.
Jason Evansd8ceef62012-05-10 20:59:39 -0700443 - Fix large calloc() zeroing bugs due to dropping chunk map unzeroed flags.
Jason Evans8f0e0eb2012-04-21 13:33:48 -0700444 - Fix chunk_alloc_dss() to stop claiming memory is zeroed. This bug could
445 cause memory corruption and crashes with --enable-dss specified.
Jason Evans52386b22012-04-22 16:00:11 -0700446 - Fix fork-related bugs that could cause deadlock in children between fork
447 and exec.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700448 - Fix malloc_stats_print() to honor 'b' and 'l' in the opts parameter.
449 - Fix realloc(p, 0) to act like free(p).
450 - Do not enforce minimum alignment in memalign().
451 - Check for NULL pointer in malloc_usable_size().
Jason Evans52386b22012-04-22 16:00:11 -0700452 - Fix an off-by-one heap profile statistics bug that could be observed in
453 interval- and growth-triggered heap profiles.
Jason Evans6b9ed672012-04-25 13:12:46 -0700454 - Fix the "epoch" mallctl to update cached stats even if the passed in epoch
455 is 0.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700456 - Fix bin->runcur management to fix a layout policy bug. This bug did not
457 affect correctness.
458 - Fix a bug in choose_arena_hard() that potentially caused more arenas to be
459 initialized than necessary.
460 - Add missing "opt.lg_tcache_max" mallctl implementation.
461 - Use glibc allocator hooks to make mixed allocator usage less likely.
462 - Fix build issues for --disable-tcache.
Jason Evans918d6e22012-04-20 13:42:21 -0700463 - Don't mangle pthread_create() when --with-private-namespace is specified.
Jason Evans9ef7f5d2012-04-16 18:16:48 -0700464
Jason Evansb3bd8852011-11-14 17:12:45 -0800465* 2.2.5 (November 14, 2011)
466
467 Bug fixes:
468 - Fix huge_ralloc() race when using mremap(2). This is a serious bug that
469 could cause memory corruption and/or crashes.
470 - Fix huge_ralloc() to maintain chunk statistics.
471 - Fix malloc_stats_print(..., "a") output.
472
Jason Evansca9ee1a2011-11-05 21:46:23 -0700473* 2.2.4 (November 5, 2011)
474
475 Bug fixes:
476 - Initialize arenas_tsd before using it. This bug existed for 2.2.[0-3], as
477 well as for --disable-tls builds in earlier releases.
478 - Do not assume a 4 KiB page size in test/rallocm.c.
479
Jason Evansc67e4fd2011-08-31 15:19:13 -0700480* 2.2.3 (August 31, 2011)
481
482 This version fixes numerous bugs related to heap profiling.
483
484 Bug fixes:
485 - Fix a prof-related race condition. This bug could cause memory corruption,
486 but only occurred in non-default configurations (prof_accum:false).
487 - Fix off-by-one backtracing issues (make sure that prof_alloc_prep() is
488 excluded from backtraces).
489 - Fix a prof-related bug in realloc() (only triggered by OOM errors).
490 - Fix prof-related bugs in allocm() and rallocm().
491 - Fix prof_tdata_cleanup() for --disable-tls builds.
492 - Fix a relative include path, to fix objdir builds.
493
Jason Evans4c484812011-07-30 16:59:13 -0700494* 2.2.2 (July 30, 2011)
495
496 Bug fixes:
497 - Fix a build error for --disable-tcache.
498 - Fix assertions in arena_purge() (for real this time).
499 - Add the --with-private-namespace option. This is a workaround for symbol
500 conflicts that can inadvertently arise when using static libraries.
501
Jason Evans7d9ebea2011-03-30 15:01:08 -0700502* 2.2.1 (March 30, 2011)
503
504 Bug fixes:
505 - Implement atomic operations for x86/x64. This fixes compilation failures
506 for versions of gcc that are still in wide use.
507 - Fix an assertion in arena_purge().
508
Jason Evans4bcd9872011-03-22 15:30:22 -0700509* 2.2.0 (March 22, 2011)
510
511 This version incorporates several improvements to algorithms and data
512 structures that tend to reduce fragmentation and increase speed.
513
514 New features:
515 - Add the "stats.cactive" mallctl.
516 - Update pprof (from google-perftools 1.7).
517 - Improve backtracing-related configuration logic, and add the
518 --disable-prof-libgcc option.
519
520 Bug fixes:
521 - Change default symbol visibility from "internal", to "hidden", which
522 decreases the overhead of library-internal function calls.
523 - Fix symbol visibility so that it is also set on OS X.
524 - Fix a build dependency regression caused by the introduction of the .pic.o
525 suffix for PIC object files.
526 - Add missing checks for mutex initialization failures.
527 - Don't use libgcc-based backtracing except on x64, where it is known to work.
528 - Fix deadlocks on OS X that were due to memory allocation in
529 pthread_mutex_lock().
530 - Heap profiling-specific fixes:
531 + Fix memory corruption due to integer overflow in small region index
532 computation, when using a small enough sample interval that profiling
533 context pointers are stored in small run headers.
534 + Fix a bootstrap ordering bug that only occurred with TLS disabled.
535 + Fix a rallocm() rsize bug.
536 + Fix error detection bugs for aligned memory allocation.
537
Jason Evans0e4d0d12011-03-14 16:41:03 -0700538* 2.1.3 (March 14, 2011)
539
540 Bug fixes:
541 - Fix a cpp logic regression (due to the "thread.{de,}allocatedp" mallctl fix
542 for OS X in 2.1.2).
543 - Fix a "thread.arena" mallctl bug.
544 - Fix a thread cache stats merging bug.
545
je6e56e5e2011-03-02 11:23:41 -0800546* 2.1.2 (March 2, 2011)
547
548 Bug fixes:
549 - Fix "thread.{de,}allocatedp" mallctl for OS X.
550 - Add missing jemalloc.a to build system.
551
Jason Evans63692862011-02-07 22:48:35 -0800552* 2.1.1 (January 31, 2011)
Jason Evansada55b22011-01-31 20:08:56 -0800553
Jason Evans63692862011-02-07 22:48:35 -0800554 Bug fixes:
Jason Evansada55b22011-01-31 20:08:56 -0800555 - Fix aligned huge reallocation (affected allocm()).
556 - Fix the ALLOCM_LG_ALIGN macro definition.
557 - Fix a heap dumping deadlock.
558 - Fix a "thread.arena" mallctl bug.
559
Jason Evans63692862011-02-07 22:48:35 -0800560* 2.1.0 (December 3, 2010)
Jason Evans0e8d3d22010-12-03 17:02:16 -0800561
562 This version incorporates some optimizations that can't quite be considered
563 bug fixes.
564
565 New features:
566 - Use Linux's mremap(2) for huge object reallocation when possible.
567 - Avoid locking in mallctl*() when possible.
568 - Add the "thread.[de]allocatedp" mallctl's.
569 - Convert the manual page source from roff to DocBook, and generate both roff
570 and HTML manuals.
571
572 Bug fixes:
573 - Fix a crash due to incorrect bootstrap ordering. This only impacted
574 --enable-debug --enable-dss configurations.
575 - Fix a minor statistics bug for mallctl("swap.avail", ...).
576
Jason Evans63692862011-02-07 22:48:35 -0800577* 2.0.1 (October 29, 2010)
Jason Evans53806fe2010-10-29 20:16:39 -0700578
579 Bug fixes:
580 - Fix a race condition in heap profiling that could cause undefined behavior
Jason Evansada55b22011-01-31 20:08:56 -0800581 if "opt.prof_accum" were disabled.
Jason Evans53806fe2010-10-29 20:16:39 -0700582 - Add missing mutex unlocks for some OOM error paths in the heap profiling
583 code.
584 - Fix a compilation error for non-C99 builds.
585
Jason Evans63692862011-02-07 22:48:35 -0800586* 2.0.0 (October 24, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700587
588 This version focuses on the experimental *allocm() API, and on improved
589 run-time configuration/introspection. Nonetheless, numerous performance
590 improvements are also included.
591
592 New features:
Jason Evansb059a532010-10-24 16:54:40 -0700593 - Implement the experimental {,r,s,d}allocm() API, which provides a superset
594 of the functionality available via malloc(), calloc(), posix_memalign(),
595 realloc(), malloc_usable_size(), and free(). These functions can be used to
596 allocate/reallocate aligned zeroed memory, ask for optional extra memory
597 during reallocation, prevent object movement during reallocation, etc.
598 - Replace JEMALLOC_OPTIONS/JEMALLOC_PROF_PREFIX with MALLOC_CONF, which is
599 more human-readable, and more flexible. For example:
600 JEMALLOC_OPTIONS=AJP
601 is now:
602 MALLOC_CONF=abort:true,fill:true,stats_print:true
603 - Port to Apple OS X. Sponsored by Mozilla.
604 - Make it possible for the application to control thread-->arena mappings via
605 the "thread.arena" mallctl.
606 - Add compile-time support for all TLS-related functionality via pthreads TSD.
607 This is mainly of interest for OS X, which does not support TLS, but has a
608 TSD implementation with similar performance.
609 - Override memalign() and valloc() if they are provided by the system.
610 - Add the "arenas.purge" mallctl, which can be used to synchronously purge all
611 dirty unused pages.
612 - Make cumulative heap profiling data optional, so that it is possible to
613 limit the amount of memory consumed by heap profiling data structures.
614 - Add per thread allocation counters that can be accessed via the
615 "thread.allocated" and "thread.deallocated" mallctls.
Jason Evans379f8472010-10-24 16:18:29 -0700616
617 Incompatible changes:
Jason Evansb059a532010-10-24 16:54:40 -0700618 - Remove JEMALLOC_OPTIONS and malloc_options (see MALLOC_CONF above).
619 - Increase default backtrace depth from 4 to 128 for heap profiling.
620 - Disable interval-based profile dumps by default.
Jason Evans379f8472010-10-24 16:18:29 -0700621
622 Bug fixes:
623 - Remove bad assertions in fork handler functions. These assertions could
624 cause aborts for some combinations of configure settings.
625 - Fix strerror_r() usage to deal with non-standard semantics in GNU libc.
626 - Fix leak context reporting. This bug tended to cause the number of contexts
627 to be underreported (though the reported number of objects and bytes were
628 correct).
629 - Fix a realloc() bug for large in-place growing reallocation. This bug could
630 cause memory corruption, but it was hard to trigger.
631 - Fix an allocation bug for small allocations that could be triggered if
632 multiple threads raced to create a new run of backing pages.
633 - Enhance the heap profiler to trigger samples based on usable size, rather
634 than request size.
635 - Fix a heap profiling bug due to sometimes losing track of requested object
636 size for sampled objects.
637
Jason Evans63692862011-02-07 22:48:35 -0800638* 1.0.3 (August 12, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700639
640 Bug fixes:
641 - Fix the libunwind-based implementation of stack backtracing (used for heap
642 profiling). This bug could cause zero-length backtraces to be reported.
643 - Add a missing mutex unlock in library initialization code. If multiple
644 threads raced to initialize malloc, some of them could end up permanently
645 blocked.
646
Jason Evans63692862011-02-07 22:48:35 -0800647* 1.0.2 (May 11, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700648
649 Bug fixes:
650 - Fix junk filling of large objects, which could cause memory corruption.
651 - Add MAP_NORESERVE support for chunk mapping, because otherwise virtual
652 memory limits could cause swap file configuration to fail. Contributed by
653 Jordan DeLong.
654
Jason Evans63692862011-02-07 22:48:35 -0800655* 1.0.1 (April 14, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700656
657 Bug fixes:
658 - Fix compilation when --enable-fill is specified.
659 - Fix threads-related profiling bugs that affected accuracy and caused memory
660 to be leaked during thread exit.
661 - Fix dirty page purging race conditions that could cause crashes.
662 - Fix crash in tcache flushing code during thread destruction.
663
Jason Evans63692862011-02-07 22:48:35 -0800664* 1.0.0 (April 11, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700665
666 This release focuses on speed and run-time introspection. Numerous
667 algorithmic improvements make this release substantially faster than its
668 predecessors.
669
670 New features:
671 - Implement autoconf-based configuration system.
672 - Add mallctl*(), for the purposes of introspection and run-time
673 configuration.
674 - Make it possible for the application to manually flush a thread's cache, via
675 the "tcache.flush" mallctl.
676 - Base maximum dirty page count on proportion of active memory.
charsyamad6800f2015-07-04 01:06:06 +0900677 - Compute various additional run-time statistics, including per size class
Jason Evans379f8472010-10-24 16:18:29 -0700678 statistics for large objects.
679 - Expose malloc_stats_print(), which can be called repeatedly by the
680 application.
681 - Simplify the malloc_message() signature to only take one string argument,
682 and incorporate an opaque data pointer argument for use by the application
683 in combination with malloc_stats_print().
684 - Add support for allocation backed by one or more swap files, and allow the
685 application to disable over-commit if swap files are in use.
686 - Implement allocation profiling and leak checking.
687
688 Removed features:
689 - Remove the dynamic arena rebalancing code, since thread-specific caching
690 reduces its utility.
691
692 Bug fixes:
693 - Modify chunk allocation to work when address space layout randomization
694 (ASLR) is in use.
695 - Fix thread cleanup bugs related to TLS destruction.
696 - Handle 0-size allocation requests in posix_memalign().
697 - Fix a chunk leak. The leaked chunks were never touched, so this impacted
698 virtual memory usage, but not physical memory usage.
699
Jason Evans63692862011-02-07 22:48:35 -0800700* linux_2008082[78]a (August 27/28, 2008)
Jason Evans379f8472010-10-24 16:18:29 -0700701
702 These snapshot releases are the simple result of incorporating Linux-specific
703 support into the FreeBSD malloc sources.
704
705--------------------------------------------------------------------------------
706vim:filetype=text:textwidth=80