blob: 8f6edd5a01bfbc4a2f889891a6b53a4bcfc9ddfa [file] [log] [blame]
Jason Evans379f8472010-10-24 16:18:29 -07001Following are change highlights associated with official releases. Important
2bug fixes are all mentioned, but internal enhancements are omitted here for
3brevity (even though they are more fun to write about). Much more detail can be
4found in the git revision history:
5
6 http://www.canonware.com/cgi-bin/gitweb.cgi?p=jemalloc.git
7 git://canonware.com/jemalloc.git
8
Jason Evans9ef7f5d2012-04-16 18:16:48 -07009* 3.0.0 (XXX not yet released)
10
11 Although this version adds some major new features, the primary focus is on
12 internal code cleanup that facilitates maintainability and portability, most
13 of which is not reflected in the ChangeLog. This is the first release to
14 incorporate substantial contributions from numerous other developers, and the
15 result is a more broadly useful allocator (see the git revision history for
16 contribution details). Note that the license has been unified, thanks to
17 Facebook granting a license under the same terms as the other copyright
18 holders (see COPYING).
19
20 New features:
21 - Implement Valgrind support, redzones, and quarantine.
22 - Add support for additional operating systems:
23 + FreeBSD
24 + Mac OS X Lion
25 - Add support for additional architectures:
26 + MIPS
27 + SH4
28 + Tilera
29 - Add support for cross compiling.
30 - Add nallocm(), which rounds a request size up to the nearest size class
31 without actually allocating.
32 - Implement aligned_alloc() (blame C11).
33 - Add the --disable-munmap option, and make it the default on Linux.
34 - Add the --with-mangling option.
35 - Add the --disable-experimental option.
36 - Add the "thread.tcache.enabled" mallctl.
37
38 Incompatible changes:
39 - Enable stats by default.
40 - Enable fill by default.
41 - Disable lazy locking by default.
42 - Rename the "tcache.flush" mallctl to "thread.tcache.flush".
43 - Rename the "arenas.pagesize" mallctl to "arenas.page".
44
45 Removed features:
46 - Remove the swap feature, including the "config.swap", "swap.avail",
47 "swap.prezeroed", "swap.nfds", and "swap.fds" mallctls.
48 - Remove highruns statistics, including the
49 "stats.arenas.<i>.bins.<j>.highruns" and
50 "stats.arenas.<i>.lruns.<j>.highruns" mallctls.
51 - As part of small size class refactoring, remove the "opt.lg_[qc]space_max",
52 "arenas.cacheline", "arenas.subpage", "arenas.[tqcs]space_{min,max}", and
53 "arenas.[tqcs]bins" mallctls.
54 - Remove the "arenas.chunksize" mallctl.
55 - Remove the "opt.lg_prof_tcmax" option.
56 - Remove the "opt.lg_prof_bt_max" option.
57 - Remove the "opt.lg_tcache_gc_sweep" option.
58 - Remove the --disable-tiny option, including the "config.tiny" mallctl.
59 - Remove the --enable-dynamic-page-shift configure option.
60 - Remove the --enable-sysv configure option.
61
62 Bug fixes:
63 - Fix fork-related bugs that could cause deadlock in children between fork
64 and exec.
65 - Fix a statistics-related bug in the "thread.arena" mallctl that could cause
66 invalid statistics and crashes.
67 - Work around TLS dallocation via free() on Linux. This bug could cause
68 write-after-free memory corruption.
69 - Fix malloc_stats_print() to honor 'b' and 'l' in the opts parameter.
70 - Fix realloc(p, 0) to act like free(p).
71 - Do not enforce minimum alignment in memalign().
72 - Check for NULL pointer in malloc_usable_size().
73 - Fix bin->runcur management to fix a layout policy bug. This bug did not
74 affect correctness.
75 - Fix a bug in choose_arena_hard() that potentially caused more arenas to be
76 initialized than necessary.
77 - Add missing "opt.lg_tcache_max" mallctl implementation.
78 - Use glibc allocator hooks to make mixed allocator usage less likely.
79 - Fix build issues for --disable-tcache.
80
Jason Evansb3bd8852011-11-14 17:12:45 -080081* 2.2.5 (November 14, 2011)
82
83 Bug fixes:
84 - Fix huge_ralloc() race when using mremap(2). This is a serious bug that
85 could cause memory corruption and/or crashes.
86 - Fix huge_ralloc() to maintain chunk statistics.
87 - Fix malloc_stats_print(..., "a") output.
88
Jason Evansca9ee1a2011-11-05 21:46:23 -070089* 2.2.4 (November 5, 2011)
90
91 Bug fixes:
92 - Initialize arenas_tsd before using it. This bug existed for 2.2.[0-3], as
93 well as for --disable-tls builds in earlier releases.
94 - Do not assume a 4 KiB page size in test/rallocm.c.
95
Jason Evansc67e4fd2011-08-31 15:19:13 -070096* 2.2.3 (August 31, 2011)
97
98 This version fixes numerous bugs related to heap profiling.
99
100 Bug fixes:
101 - Fix a prof-related race condition. This bug could cause memory corruption,
102 but only occurred in non-default configurations (prof_accum:false).
103 - Fix off-by-one backtracing issues (make sure that prof_alloc_prep() is
104 excluded from backtraces).
105 - Fix a prof-related bug in realloc() (only triggered by OOM errors).
106 - Fix prof-related bugs in allocm() and rallocm().
107 - Fix prof_tdata_cleanup() for --disable-tls builds.
108 - Fix a relative include path, to fix objdir builds.
109
Jason Evans4c484812011-07-30 16:59:13 -0700110* 2.2.2 (July 30, 2011)
111
112 Bug fixes:
113 - Fix a build error for --disable-tcache.
114 - Fix assertions in arena_purge() (for real this time).
115 - Add the --with-private-namespace option. This is a workaround for symbol
116 conflicts that can inadvertently arise when using static libraries.
117
Jason Evans7d9ebea2011-03-30 15:01:08 -0700118* 2.2.1 (March 30, 2011)
119
120 Bug fixes:
121 - Implement atomic operations for x86/x64. This fixes compilation failures
122 for versions of gcc that are still in wide use.
123 - Fix an assertion in arena_purge().
124
Jason Evans4bcd9872011-03-22 15:30:22 -0700125* 2.2.0 (March 22, 2011)
126
127 This version incorporates several improvements to algorithms and data
128 structures that tend to reduce fragmentation and increase speed.
129
130 New features:
131 - Add the "stats.cactive" mallctl.
132 - Update pprof (from google-perftools 1.7).
133 - Improve backtracing-related configuration logic, and add the
134 --disable-prof-libgcc option.
135
136 Bug fixes:
137 - Change default symbol visibility from "internal", to "hidden", which
138 decreases the overhead of library-internal function calls.
139 - Fix symbol visibility so that it is also set on OS X.
140 - Fix a build dependency regression caused by the introduction of the .pic.o
141 suffix for PIC object files.
142 - Add missing checks for mutex initialization failures.
143 - Don't use libgcc-based backtracing except on x64, where it is known to work.
144 - Fix deadlocks on OS X that were due to memory allocation in
145 pthread_mutex_lock().
146 - Heap profiling-specific fixes:
147 + Fix memory corruption due to integer overflow in small region index
148 computation, when using a small enough sample interval that profiling
149 context pointers are stored in small run headers.
150 + Fix a bootstrap ordering bug that only occurred with TLS disabled.
151 + Fix a rallocm() rsize bug.
152 + Fix error detection bugs for aligned memory allocation.
153
Jason Evans0e4d0d12011-03-14 16:41:03 -0700154* 2.1.3 (March 14, 2011)
155
156 Bug fixes:
157 - Fix a cpp logic regression (due to the "thread.{de,}allocatedp" mallctl fix
158 for OS X in 2.1.2).
159 - Fix a "thread.arena" mallctl bug.
160 - Fix a thread cache stats merging bug.
161
je6e56e5e2011-03-02 11:23:41 -0800162* 2.1.2 (March 2, 2011)
163
164 Bug fixes:
165 - Fix "thread.{de,}allocatedp" mallctl for OS X.
166 - Add missing jemalloc.a to build system.
167
Jason Evans63692862011-02-07 22:48:35 -0800168* 2.1.1 (January 31, 2011)
Jason Evansada55b22011-01-31 20:08:56 -0800169
Jason Evans63692862011-02-07 22:48:35 -0800170 Bug fixes:
Jason Evansada55b22011-01-31 20:08:56 -0800171 - Fix aligned huge reallocation (affected allocm()).
172 - Fix the ALLOCM_LG_ALIGN macro definition.
173 - Fix a heap dumping deadlock.
174 - Fix a "thread.arena" mallctl bug.
175
Jason Evans63692862011-02-07 22:48:35 -0800176* 2.1.0 (December 3, 2010)
Jason Evans0e8d3d22010-12-03 17:02:16 -0800177
178 This version incorporates some optimizations that can't quite be considered
179 bug fixes.
180
181 New features:
182 - Use Linux's mremap(2) for huge object reallocation when possible.
183 - Avoid locking in mallctl*() when possible.
184 - Add the "thread.[de]allocatedp" mallctl's.
185 - Convert the manual page source from roff to DocBook, and generate both roff
186 and HTML manuals.
187
188 Bug fixes:
189 - Fix a crash due to incorrect bootstrap ordering. This only impacted
190 --enable-debug --enable-dss configurations.
191 - Fix a minor statistics bug for mallctl("swap.avail", ...).
192
Jason Evans63692862011-02-07 22:48:35 -0800193* 2.0.1 (October 29, 2010)
Jason Evans53806fe2010-10-29 20:16:39 -0700194
195 Bug fixes:
196 - Fix a race condition in heap profiling that could cause undefined behavior
Jason Evansada55b22011-01-31 20:08:56 -0800197 if "opt.prof_accum" were disabled.
Jason Evans53806fe2010-10-29 20:16:39 -0700198 - Add missing mutex unlocks for some OOM error paths in the heap profiling
199 code.
200 - Fix a compilation error for non-C99 builds.
201
Jason Evans63692862011-02-07 22:48:35 -0800202* 2.0.0 (October 24, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700203
204 This version focuses on the experimental *allocm() API, and on improved
205 run-time configuration/introspection. Nonetheless, numerous performance
206 improvements are also included.
207
208 New features:
Jason Evansb059a532010-10-24 16:54:40 -0700209 - Implement the experimental {,r,s,d}allocm() API, which provides a superset
210 of the functionality available via malloc(), calloc(), posix_memalign(),
211 realloc(), malloc_usable_size(), and free(). These functions can be used to
212 allocate/reallocate aligned zeroed memory, ask for optional extra memory
213 during reallocation, prevent object movement during reallocation, etc.
214 - Replace JEMALLOC_OPTIONS/JEMALLOC_PROF_PREFIX with MALLOC_CONF, which is
215 more human-readable, and more flexible. For example:
216 JEMALLOC_OPTIONS=AJP
217 is now:
218 MALLOC_CONF=abort:true,fill:true,stats_print:true
219 - Port to Apple OS X. Sponsored by Mozilla.
220 - Make it possible for the application to control thread-->arena mappings via
221 the "thread.arena" mallctl.
222 - Add compile-time support for all TLS-related functionality via pthreads TSD.
223 This is mainly of interest for OS X, which does not support TLS, but has a
224 TSD implementation with similar performance.
225 - Override memalign() and valloc() if they are provided by the system.
226 - Add the "arenas.purge" mallctl, which can be used to synchronously purge all
227 dirty unused pages.
228 - Make cumulative heap profiling data optional, so that it is possible to
229 limit the amount of memory consumed by heap profiling data structures.
230 - Add per thread allocation counters that can be accessed via the
231 "thread.allocated" and "thread.deallocated" mallctls.
Jason Evans379f8472010-10-24 16:18:29 -0700232
233 Incompatible changes:
Jason Evansb059a532010-10-24 16:54:40 -0700234 - Remove JEMALLOC_OPTIONS and malloc_options (see MALLOC_CONF above).
235 - Increase default backtrace depth from 4 to 128 for heap profiling.
236 - Disable interval-based profile dumps by default.
Jason Evans379f8472010-10-24 16:18:29 -0700237
238 Bug fixes:
239 - Remove bad assertions in fork handler functions. These assertions could
240 cause aborts for some combinations of configure settings.
241 - Fix strerror_r() usage to deal with non-standard semantics in GNU libc.
242 - Fix leak context reporting. This bug tended to cause the number of contexts
243 to be underreported (though the reported number of objects and bytes were
244 correct).
245 - Fix a realloc() bug for large in-place growing reallocation. This bug could
246 cause memory corruption, but it was hard to trigger.
247 - Fix an allocation bug for small allocations that could be triggered if
248 multiple threads raced to create a new run of backing pages.
249 - Enhance the heap profiler to trigger samples based on usable size, rather
250 than request size.
251 - Fix a heap profiling bug due to sometimes losing track of requested object
252 size for sampled objects.
253
Jason Evans63692862011-02-07 22:48:35 -0800254* 1.0.3 (August 12, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700255
256 Bug fixes:
257 - Fix the libunwind-based implementation of stack backtracing (used for heap
258 profiling). This bug could cause zero-length backtraces to be reported.
259 - Add a missing mutex unlock in library initialization code. If multiple
260 threads raced to initialize malloc, some of them could end up permanently
261 blocked.
262
Jason Evans63692862011-02-07 22:48:35 -0800263* 1.0.2 (May 11, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700264
265 Bug fixes:
266 - Fix junk filling of large objects, which could cause memory corruption.
267 - Add MAP_NORESERVE support for chunk mapping, because otherwise virtual
268 memory limits could cause swap file configuration to fail. Contributed by
269 Jordan DeLong.
270
Jason Evans63692862011-02-07 22:48:35 -0800271* 1.0.1 (April 14, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700272
273 Bug fixes:
274 - Fix compilation when --enable-fill is specified.
275 - Fix threads-related profiling bugs that affected accuracy and caused memory
276 to be leaked during thread exit.
277 - Fix dirty page purging race conditions that could cause crashes.
278 - Fix crash in tcache flushing code during thread destruction.
279
Jason Evans63692862011-02-07 22:48:35 -0800280* 1.0.0 (April 11, 2010)
Jason Evans379f8472010-10-24 16:18:29 -0700281
282 This release focuses on speed and run-time introspection. Numerous
283 algorithmic improvements make this release substantially faster than its
284 predecessors.
285
286 New features:
287 - Implement autoconf-based configuration system.
288 - Add mallctl*(), for the purposes of introspection and run-time
289 configuration.
290 - Make it possible for the application to manually flush a thread's cache, via
291 the "tcache.flush" mallctl.
292 - Base maximum dirty page count on proportion of active memory.
293 - Compute various addtional run-time statistics, including per size class
294 statistics for large objects.
295 - Expose malloc_stats_print(), which can be called repeatedly by the
296 application.
297 - Simplify the malloc_message() signature to only take one string argument,
298 and incorporate an opaque data pointer argument for use by the application
299 in combination with malloc_stats_print().
300 - Add support for allocation backed by one or more swap files, and allow the
301 application to disable over-commit if swap files are in use.
302 - Implement allocation profiling and leak checking.
303
304 Removed features:
305 - Remove the dynamic arena rebalancing code, since thread-specific caching
306 reduces its utility.
307
308 Bug fixes:
309 - Modify chunk allocation to work when address space layout randomization
310 (ASLR) is in use.
311 - Fix thread cleanup bugs related to TLS destruction.
312 - Handle 0-size allocation requests in posix_memalign().
313 - Fix a chunk leak. The leaked chunks were never touched, so this impacted
314 virtual memory usage, but not physical memory usage.
315
Jason Evans63692862011-02-07 22:48:35 -0800316* linux_2008082[78]a (August 27/28, 2008)
Jason Evans379f8472010-10-24 16:18:29 -0700317
318 These snapshot releases are the simple result of incorporating Linux-specific
319 support into the FreeBSD malloc sources.
320
321--------------------------------------------------------------------------------
322vim:filetype=text:textwidth=80