ChangeLog 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788
  1. Following are change highlights associated with official releases. Important
  2. bug fixes are all mentioned, but some internal enhancements are omitted here for
  3. brevity. Much more detail can be found in the git revision history:
  4. https://github.com/jemalloc/jemalloc
  5. * 4.0.3 (September 24, 2015)
  6. This bugfix release continues the trend of xallocx() and heap profiling fixes.
  7. Bug fixes:
  8. - Fix xallocx(..., MALLOCX_ZERO) to zero all trailing bytes of large
  9. allocations when --enable-cache-oblivious configure option is enabled.
  10. - Fix xallocx(..., MALLOCX_ZERO) to zero trailing bytes of huge allocations
  11. when resizing from/to a size class that is not a multiple of the chunk size.
  12. - Fix prof_tctx_dump_iter() to filter out nodes that were created after heap
  13. profile dumping started.
  14. - Work around a potentially bad thread-specific data initialization
  15. interaction with NPTL (glibc's pthreads implementation).
  16. * 4.0.2 (September 21, 2015)
  17. This bugfix release addresses a few bugs specific to heap profiling.
  18. Bug fixes:
  19. - Fix ixallocx_prof_sample() to never modify nor create sampled small
  20. allocations. xallocx() is in general incapable of moving small allocations,
  21. so this fix removes buggy code without loss of generality.
  22. - Fix irallocx_prof_sample() to always allocate large regions, even when
  23. alignment is non-zero.
  24. - Fix prof_alloc_rollback() to read tdata from thread-specific data rather
  25. than dereferencing a potentially invalid tctx.
  26. * 4.0.1 (September 15, 2015)
  27. This is a bugfix release that is somewhat high risk due to the amount of
  28. refactoring required to address deep xallocx() problems. As a side effect of
  29. these fixes, xallocx() now tries harder to partially fulfill requests for
  30. optional extra space. Note that a couple of minor heap profiling
  31. optimizations are included, but these are better thought of as performance
  32. fixes that were integral to disovering most of the other bugs.
  33. Optimizations:
  34. - Avoid a chunk metadata read in arena_prof_tctx_set(), since it is in the
  35. fast path when heap profiling is enabled. Additionally, split a special
  36. case out into arena_prof_tctx_reset(), which also avoids chunk metadata
  37. reads.
  38. - Optimize irallocx_prof() to optimistically update the sampler state. The
  39. prior implementation appears to have been a holdover from when
  40. rallocx()/xallocx() functionality was combined as rallocm().
  41. Bug fixes:
  42. - Fix TLS configuration such that it is enabled by default for platforms on
  43. which it works correctly.
  44. - Fix arenas_cache_cleanup() and arena_get_hard() to handle
  45. allocation/deallocation within the application's thread-specific data
  46. cleanup functions even after arenas_cache is torn down.
  47. - Fix xallocx() bugs related to size+extra exceeding HUGE_MAXCLASS.
  48. - Fix chunk purge hook calls for in-place huge shrinking reallocation to
  49. specify the old chunk size rather than the new chunk size. This bug caused
  50. no correctness issues for the default chunk purge function, but was
  51. visible to custom functions set via the "arena.<i>.chunk_hooks" mallctl.
  52. - Fix heap profiling bugs:
  53. + Fix heap profiling to distinguish among otherwise identical sample sites
  54. with interposed resets (triggered via the "prof.reset" mallctl). This bug
  55. could cause data structure corruption that would most likely result in a
  56. segfault.
  57. + Fix irealloc_prof() to prof_alloc_rollback() on OOM.
  58. + Make one call to prof_active_get_unlocked() per allocation event, and use
  59. the result throughout the relevant functions that handle an allocation
  60. event. Also add a missing check in prof_realloc(). These fixes protect
  61. allocation events against concurrent prof_active changes.
  62. + Fix ixallocx_prof() to pass usize_max and zero to ixallocx_prof_sample()
  63. in the correct order.
  64. + Fix prof_realloc() to call prof_free_sampled_object() after calling
  65. prof_malloc_sample_object(). Prior to this fix, if tctx and old_tctx were
  66. the same, the tctx could have been prematurely destroyed.
  67. - Fix portability bugs:
  68. + Don't bitshift by negative amounts when encoding/decoding run sizes in
  69. chunk header maps. This affected systems with page sizes greater than 8
  70. KiB.
  71. + Rename index_t to szind_t to avoid an existing type on Solaris.
  72. + Add JEMALLOC_CXX_THROW to the memalign() function prototype, in order to
  73. match glibc and avoid compilation errors when including both
  74. jemalloc/jemalloc.h and malloc.h in C++ code.
  75. + Don't assume that /bin/sh is appropriate when running size_classes.sh
  76. during configuration.
  77. + Consider __sparcv9 a synonym for __sparc64__ when defining LG_QUANTUM.
  78. + Link tests to librt if it contains clock_gettime(2).
  79. * 4.0.0 (August 17, 2015)
  80. This version contains many speed and space optimizations, both minor and
  81. major. The major themes are generalization, unification, and simplification.
  82. Although many of these optimizations cause no visible behavior change, their
  83. cumulative effect is substantial.
  84. New features:
  85. - Normalize size class spacing to be consistent across the complete size
  86. range. By default there are four size classes per size doubling, but this
  87. is now configurable via the --with-lg-size-class-group option. Also add the
  88. --with-lg-page, --with-lg-page-sizes, --with-lg-quantum, and
  89. --with-lg-tiny-min options, which can be used to tweak page and size class
  90. settings. Impacts:
  91. + Worst case performance for incrementally growing/shrinking reallocation
  92. is improved because there are far fewer size classes, and therefore
  93. copying happens less often.
  94. + Internal fragmentation is limited to 20% for all but the smallest size
  95. classes (those less than four times the quantum). (1B + 4 KiB)
  96. and (1B + 4 MiB) previously suffered nearly 50% internal fragmentation.
  97. + Chunk fragmentation tends to be lower because there are fewer distinct run
  98. sizes to pack.
  99. - Add support for explicit tcaches. The "tcache.create", "tcache.flush", and
  100. "tcache.destroy" mallctls control tcache lifetime and flushing, and the
  101. MALLOCX_TCACHE(tc) and MALLOCX_TCACHE_NONE flags to the *allocx() API
  102. control which tcache is used for each operation.
  103. - Implement per thread heap profiling, as well as the ability to
  104. enable/disable heap profiling on a per thread basis. Add the "prof.reset",
  105. "prof.lg_sample", "thread.prof.name", "thread.prof.active",
  106. "opt.prof_thread_active_init", "prof.thread_active_init", and
  107. "thread.prof.active" mallctls.
  108. - Add support for per arena application-specified chunk allocators, configured
  109. via the "arena.<i>.chunk_hooks" mallctl.
  110. - Refactor huge allocation to be managed by arenas, so that arenas now
  111. function as general purpose independent allocators. This is important in
  112. the context of user-specified chunk allocators, aside from the scalability
  113. benefits. Related new statistics:
  114. + The "stats.arenas.<i>.huge.allocated", "stats.arenas.<i>.huge.nmalloc",
  115. "stats.arenas.<i>.huge.ndalloc", and "stats.arenas.<i>.huge.nrequests"
  116. mallctls provide high level per arena huge allocation statistics.
  117. + The "arenas.nhchunks", "arenas.hchunk.<i>.size",
  118. "stats.arenas.<i>.hchunks.<j>.nmalloc",
  119. "stats.arenas.<i>.hchunks.<j>.ndalloc",
  120. "stats.arenas.<i>.hchunks.<j>.nrequests", and
  121. "stats.arenas.<i>.hchunks.<j>.curhchunks" mallctls provide per size class
  122. statistics.
  123. - Add the 'util' column to malloc_stats_print() output, which reports the
  124. proportion of available regions that are currently in use for each small
  125. size class.
  126. - Add "alloc" and "free" modes for for junk filling (see the "opt.junk"
  127. mallctl), so that it is possible to separately enable junk filling for
  128. allocation versus deallocation.
  129. - Add the jemalloc-config script, which provides information about how
  130. jemalloc was configured, and how to integrate it into application builds.
  131. - Add metadata statistics, which are accessible via the "stats.metadata",
  132. "stats.arenas.<i>.metadata.mapped", and
  133. "stats.arenas.<i>.metadata.allocated" mallctls.
  134. - Add the "stats.resident" mallctl, which reports the upper limit of
  135. physically resident memory mapped by the allocator.
  136. - Add per arena control over unused dirty page purging, via the
  137. "arenas.lg_dirty_mult", "arena.<i>.lg_dirty_mult", and
  138. "stats.arenas.<i>.lg_dirty_mult" mallctls.
  139. - Add the "prof.gdump" mallctl, which makes it possible to toggle the gdump
  140. feature on/off during program execution.
  141. - Add sdallocx(), which implements sized deallocation. The primary
  142. optimization over dallocx() is the removal of a metadata read, which often
  143. suffers an L1 cache miss.
  144. - Add missing header includes in jemalloc/jemalloc.h, so that applications
  145. only have to #include <jemalloc/jemalloc.h>.
  146. - Add support for additional platforms:
  147. + Bitrig
  148. + Cygwin
  149. + DragonFlyBSD
  150. + iOS
  151. + OpenBSD
  152. + OpenRISC/or1k
  153. Optimizations:
  154. - Maintain dirty runs in per arena LRUs rather than in per arena trees of
  155. dirty-run-containing chunks. In practice this change significantly reduces
  156. dirty page purging volume.
  157. - Integrate whole chunks into the unused dirty page purging machinery. This
  158. reduces the cost of repeated huge allocation/deallocation, because it
  159. effectively introduces a cache of chunks.
  160. - Split the arena chunk map into two separate arrays, in order to increase
  161. cache locality for the frequently accessed bits.
  162. - Move small run metadata out of runs, into arena chunk headers. This reduces
  163. run fragmentation, smaller runs reduce external fragmentation for small size
  164. classes, and packed (less uniformly aligned) metadata layout improves CPU
  165. cache set distribution.
  166. - Randomly distribute large allocation base pointer alignment relative to page
  167. boundaries in order to more uniformly utilize CPU cache sets. This can be
  168. disabled via the --disable-cache-oblivious configure option, and queried via
  169. the "config.cache_oblivious" mallctl.
  170. - Micro-optimize the fast paths for the public API functions.
  171. - Refactor thread-specific data to reside in a single structure. This assures
  172. that only a single TLS read is necessary per call into the public API.
  173. - Implement in-place huge allocation growing and shrinking.
  174. - Refactor rtree (radix tree for chunk lookups) to be lock-free, and make
  175. additional optimizations that reduce maximum lookup depth to one or two
  176. levels. This resolves what was a concurrency bottleneck for per arena huge
  177. allocation, because a global data structure is critical for determining
  178. which arenas own which huge allocations.
  179. Incompatible changes:
  180. - Replace --enable-cc-silence with --disable-cc-silence to suppress spurious
  181. warnings by default.
  182. - Assure that the constness of malloc_usable_size()'s return type matches that
  183. of the system implementation.
  184. - Change the heap profile dump format to support per thread heap profiling,
  185. rename pprof to jeprof, and enhance it with the --thread=<n> option. As a
  186. result, the bundled jeprof must now be used rather than the upstream
  187. (gperftools) pprof.
  188. - Disable "opt.prof_final" by default, in order to avoid atexit(3), which can
  189. internally deadlock on some platforms.
  190. - Change the "arenas.nlruns" mallctl type from size_t to unsigned.
  191. - Replace the "stats.arenas.<i>.bins.<j>.allocated" mallctl with
  192. "stats.arenas.<i>.bins.<j>.curregs".
  193. - Ignore MALLOC_CONF in set{uid,gid,cap} binaries.
  194. - Ignore MALLOCX_ARENA(a) in dallocx(), in favor of using the
  195. MALLOCX_TCACHE(tc) and MALLOCX_TCACHE_NONE flags to control tcache usage.
  196. Removed features:
  197. - Remove the *allocm() API, which is superseded by the *allocx() API.
  198. - Remove the --enable-dss options, and make dss non-optional on all platforms
  199. which support sbrk(2).
  200. - Remove the "arenas.purge" mallctl, which was obsoleted by the
  201. "arena.<i>.purge" mallctl in 3.1.0.
  202. - Remove the unnecessary "opt.valgrind" mallctl; jemalloc automatically
  203. detects whether it is running inside Valgrind.
  204. - Remove the "stats.huge.allocated", "stats.huge.nmalloc", and
  205. "stats.huge.ndalloc" mallctls.
  206. - Remove the --enable-mremap option.
  207. - Remove the "stats.chunks.current", "stats.chunks.total", and
  208. "stats.chunks.high" mallctls.
  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.
  214. - 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.
  217. - Fix size class overflow handling for malloc(), posix_memalign(), memalign(),
  218. calloc(), and realloc() when profiling is enabled.
  219. - 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. * 3.6.0 (March 31, 2014)
  230. This version contains a critical bug fix for a regression present in 3.5.0 and
  231. 3.5.1.
  232. Bug fixes:
  233. - Fix a regression in arena_chunk_alloc() that caused crashes during
  234. small/large allocation if chunk allocation failed. In the absence of this
  235. bug, chunk allocation failure would result in allocation failure, e.g. NULL
  236. return from malloc(). This regression was introduced in 3.5.0.
  237. - Fix backtracing for gcc intrinsics-based backtracing by specifying
  238. -fno-omit-frame-pointer to gcc. Note that the application (and all the
  239. libraries it links to) must also be compiled with this option for
  240. backtracing to be reliable.
  241. - Use dss allocation precedence for huge allocations as well as small/large
  242. allocations.
  243. - Fix test assertion failure message formatting. This bug did not manifest on
  244. x86_64 systems because of implementation subtleties in va_list.
  245. - Fix inconsequential test failures for hash and SFMT code.
  246. New features:
  247. - Support heap profiling on FreeBSD. This feature depends on the proc
  248. filesystem being mounted during heap profile dumping.
  249. * 3.5.1 (February 25, 2014)
  250. This version primarily addresses minor bugs in test code.
  251. Bug fixes:
  252. - Configure Solaris/Illumos to use MADV_FREE.
  253. - Fix junk filling for mremap(2)-based huge reallocation. This is only
  254. relevant if configuring with the --enable-mremap option specified.
  255. - Avoid compilation failure if 'restrict' C99 keyword is not supported by the
  256. compiler.
  257. - Add a configure test for SSE2 rather than assuming it is usable on i686
  258. systems. This fixes test compilation errors, especially on 32-bit Linux
  259. systems.
  260. - Fix mallctl argument size mismatches (size_t vs. uint64_t) in the stats unit
  261. test.
  262. - Fix/remove flawed alignment-related overflow tests.
  263. - Prevent compiler optimizations that could change backtraces in the
  264. prof_accum unit test.
  265. * 3.5.0 (January 22, 2014)
  266. This version focuses on refactoring and automated testing, though it also
  267. includes some non-trivial heap profiling optimizations not mentioned below.
  268. New features:
  269. - Add the *allocx() API, which is a successor to the experimental *allocm()
  270. API. The *allocx() functions are slightly simpler to use because they have
  271. fewer parameters, they directly return the results of primary interest, and
  272. mallocx()/rallocx() avoid the strict aliasing pitfall that
  273. allocm()/rallocm() share with posix_memalign(). Note that *allocm() is
  274. slated for removal in the next non-bugfix release.
  275. - Add support for LinuxThreads.
  276. Bug fixes:
  277. - Unless heap profiling is enabled, disable floating point code and don't link
  278. with libm. This, in combination with e.g. EXTRA_CFLAGS=-mno-sse on x64
  279. systems, makes it possible to completely disable floating point register
  280. use. Some versions of glibc neglect to save/restore caller-saved floating
  281. point registers during dynamic lazy symbol loading, and the symbol loading
  282. code uses whatever malloc the application happens to have linked/loaded
  283. with, the result being potential floating point register corruption.
  284. - Report ENOMEM rather than EINVAL if an OOM occurs during heap profiling
  285. backtrace creation in imemalign(). This bug impacted posix_memalign() and
  286. aligned_alloc().
  287. - Fix a file descriptor leak in a prof_dump_maps() error path.
  288. - Fix prof_dump() to close the dump file descriptor for all relevant error
  289. paths.
  290. - Fix rallocm() to use the arena specified by the ALLOCM_ARENA(s) flag for
  291. allocation, not just deallocation.
  292. - Fix a data race for large allocation stats counters.
  293. - Fix a potential infinite loop during thread exit. This bug occurred on
  294. Solaris, and could affect other platforms with similar pthreads TSD
  295. implementations.
  296. - Don't junk-fill reallocations unless usable size changes. This fixes a
  297. violation of the *allocx()/*allocm() semantics.
  298. - Fix growing large reallocation to junk fill new space.
  299. - Fix huge deallocation to junk fill when munmap is disabled.
  300. - Change the default private namespace prefix from empty to je_, and change
  301. --with-private-namespace-prefix so that it prepends an additional prefix
  302. rather than replacing je_. This reduces the likelihood of applications
  303. which statically link jemalloc experiencing symbol name collisions.
  304. - Add missing private namespace mangling (relevant when
  305. --with-private-namespace is specified).
  306. - Add and use JEMALLOC_INLINE_C so that static inline functions are marked as
  307. static even for debug builds.
  308. - Add a missing mutex unlock in a malloc_init_hard() error path. In practice
  309. this error path is never executed.
  310. - Fix numerous bugs in malloc_strotumax() error handling/reporting. These
  311. bugs had no impact except for malformed inputs.
  312. - Fix numerous bugs in malloc_snprintf(). These bugs were not exercised by
  313. existing calls, so they had no impact.
  314. * 3.4.1 (October 20, 2013)
  315. Bug fixes:
  316. - Fix a race in the "arenas.extend" mallctl that could cause memory corruption
  317. of internal data structures and subsequent crashes.
  318. - Fix Valgrind integration flaws that caused Valgrind warnings about reads of
  319. uninitialized memory in:
  320. + arena chunk headers
  321. + internal zero-initialized data structures (relevant to tcache and prof
  322. code)
  323. - Preserve errno during the first allocation. A readlink(2) call during
  324. initialization fails unless /etc/malloc.conf exists, so errno was typically
  325. set during the first allocation prior to this fix.
  326. - Fix compilation warnings reported by gcc 4.8.1.
  327. * 3.4.0 (June 2, 2013)
  328. This version is essentially a small bugfix release, but the addition of
  329. aarch64 support requires that the minor version be incremented.
  330. Bug fixes:
  331. - Fix race-triggered deadlocks in chunk_record(). These deadlocks were
  332. typically triggered by multiple threads concurrently deallocating huge
  333. objects.
  334. New features:
  335. - Add support for the aarch64 architecture.
  336. * 3.3.1 (March 6, 2013)
  337. This version fixes bugs that are typically encountered only when utilizing
  338. custom run-time options.
  339. Bug fixes:
  340. - Fix a locking order bug that could cause deadlock during fork if heap
  341. profiling were enabled.
  342. - Fix a chunk recycling bug that could cause the allocator to lose track of
  343. whether a chunk was zeroed. On FreeBSD, NetBSD, and OS X, it could cause
  344. corruption if allocating via sbrk(2) (unlikely unless running with the
  345. "dss:primary" option specified). This was completely harmless on Linux
  346. unless using mlockall(2) (and unlikely even then, unless the
  347. --disable-munmap configure option or the "dss:primary" option was
  348. specified). This regression was introduced in 3.1.0 by the
  349. mlockall(2)/madvise(2) interaction fix.
  350. - Fix TLS-related memory corruption that could occur during thread exit if the
  351. thread never allocated memory. Only the quarantine and prof facilities were
  352. susceptible.
  353. - Fix two quarantine bugs:
  354. + Internal reallocation of the quarantined object array leaked the old
  355. array.
  356. + Reallocation failure for internal reallocation of the quarantined object
  357. array (very unlikely) resulted in memory corruption.
  358. - Fix Valgrind integration to annotate all internally allocated memory in a
  359. way that keeps Valgrind happy about internal data structure access.
  360. - Fix building for s390 systems.
  361. * 3.3.0 (January 23, 2013)
  362. This version includes a few minor performance improvements in addition to the
  363. listed new features and bug fixes.
  364. New features:
  365. - Add clipping support to lg_chunk option processing.
  366. - Add the --enable-ivsalloc option.
  367. - Add the --without-export option.
  368. - Add the --disable-zone-allocator option.
  369. Bug fixes:
  370. - Fix "arenas.extend" mallctl to output the number of arenas.
  371. - Fix chunk_recycle() to unconditionally inform Valgrind that returned memory
  372. is undefined.
  373. - Fix build break on FreeBSD related to alloca.h.
  374. * 3.2.0 (November 9, 2012)
  375. In addition to a couple of bug fixes, this version modifies page run
  376. allocation and dirty page purging algorithms in order to better control
  377. page-level virtual memory fragmentation.
  378. Incompatible changes:
  379. - Change the "opt.lg_dirty_mult" default from 5 to 3 (32:1 to 8:1).
  380. Bug fixes:
  381. - Fix dss/mmap allocation precedence code to use recyclable mmap memory only
  382. after primary dss allocation fails.
  383. - Fix deadlock in the "arenas.purge" mallctl. This regression was introduced
  384. in 3.1.0 by the addition of the "arena.<i>.purge" mallctl.
  385. * 3.1.0 (October 16, 2012)
  386. New features:
  387. - Auto-detect whether running inside Valgrind, thus removing the need to
  388. manually specify MALLOC_CONF=valgrind:true.
  389. - Add the "arenas.extend" mallctl, which allows applications to create
  390. manually managed arenas.
  391. - Add the ALLOCM_ARENA() flag for {,r,d}allocm().
  392. - Add the "opt.dss", "arena.<i>.dss", and "stats.arenas.<i>.dss" mallctls,
  393. which provide control over dss/mmap precedence.
  394. - Add the "arena.<i>.purge" mallctl, which obsoletes "arenas.purge".
  395. - Define LG_QUANTUM for hppa.
  396. Incompatible changes:
  397. - Disable tcache by default if running inside Valgrind, in order to avoid
  398. making unallocated objects appear reachable to Valgrind.
  399. - Drop const from malloc_usable_size() argument on Linux.
  400. Bug fixes:
  401. - Fix heap profiling crash if sampled object is freed via realloc(p, 0).
  402. - Remove const from __*_hook variable declarations, so that glibc can modify
  403. them during process forking.
  404. - Fix mlockall(2)/madvise(2) interaction.
  405. - Fix fork(2)-related deadlocks.
  406. - Fix error return value for "thread.tcache.enabled" mallctl.
  407. * 3.0.0 (May 11, 2012)
  408. Although this version adds some major new features, the primary focus is on
  409. internal code cleanup that facilitates maintainability and portability, most
  410. of which is not reflected in the ChangeLog. This is the first release to
  411. incorporate substantial contributions from numerous other developers, and the
  412. result is a more broadly useful allocator (see the git revision history for
  413. contribution details). Note that the license has been unified, thanks to
  414. Facebook granting a license under the same terms as the other copyright
  415. holders (see COPYING).
  416. New features:
  417. - Implement Valgrind support, redzones, and quarantine.
  418. - Add support for additional platforms:
  419. + FreeBSD
  420. + Mac OS X Lion
  421. + MinGW
  422. + Windows (no support yet for replacing the system malloc)
  423. - Add support for additional architectures:
  424. + MIPS
  425. + SH4
  426. + Tilera
  427. - Add support for cross compiling.
  428. - Add nallocm(), which rounds a request size up to the nearest size class
  429. without actually allocating.
  430. - Implement aligned_alloc() (blame C11).
  431. - Add the "thread.tcache.enabled" mallctl.
  432. - Add the "opt.prof_final" mallctl.
  433. - Update pprof (from gperftools 2.0).
  434. - Add the --with-mangling option.
  435. - Add the --disable-experimental option.
  436. - Add the --disable-munmap option, and make it the default on Linux.
  437. - Add the --enable-mremap option, which disables use of mremap(2) by default.
  438. Incompatible changes:
  439. - Enable stats by default.
  440. - Enable fill by default.
  441. - Disable lazy locking by default.
  442. - Rename the "tcache.flush" mallctl to "thread.tcache.flush".
  443. - Rename the "arenas.pagesize" mallctl to "arenas.page".
  444. - Change the "opt.lg_prof_sample" default from 0 to 19 (1 B to 512 KiB).
  445. - Change the "opt.prof_accum" default from true to false.
  446. Removed features:
  447. - Remove the swap feature, including the "config.swap", "swap.avail",
  448. "swap.prezeroed", "swap.nfds", and "swap.fds" mallctls.
  449. - Remove highruns statistics, including the
  450. "stats.arenas.<i>.bins.<j>.highruns" and
  451. "stats.arenas.<i>.lruns.<j>.highruns" mallctls.
  452. - As part of small size class refactoring, remove the "opt.lg_[qc]space_max",
  453. "arenas.cacheline", "arenas.subpage", "arenas.[tqcs]space_{min,max}", and
  454. "arenas.[tqcs]bins" mallctls.
  455. - Remove the "arenas.chunksize" mallctl.
  456. - Remove the "opt.lg_prof_tcmax" option.
  457. - Remove the "opt.lg_prof_bt_max" option.
  458. - Remove the "opt.lg_tcache_gc_sweep" option.
  459. - Remove the --disable-tiny option, including the "config.tiny" mallctl.
  460. - Remove the --enable-dynamic-page-shift configure option.
  461. - Remove the --enable-sysv configure option.
  462. Bug fixes:
  463. - Fix a statistics-related bug in the "thread.arena" mallctl that could cause
  464. invalid statistics and crashes.
  465. - Work around TLS deallocation via free() on Linux. This bug could cause
  466. write-after-free memory corruption.
  467. - Fix a potential deadlock that could occur during interval- and
  468. growth-triggered heap profile dumps.
  469. - Fix large calloc() zeroing bugs due to dropping chunk map unzeroed flags.
  470. - Fix chunk_alloc_dss() to stop claiming memory is zeroed. This bug could
  471. cause memory corruption and crashes with --enable-dss specified.
  472. - Fix fork-related bugs that could cause deadlock in children between fork
  473. and exec.
  474. - Fix malloc_stats_print() to honor 'b' and 'l' in the opts parameter.
  475. - Fix realloc(p, 0) to act like free(p).
  476. - Do not enforce minimum alignment in memalign().
  477. - Check for NULL pointer in malloc_usable_size().
  478. - Fix an off-by-one heap profile statistics bug that could be observed in
  479. interval- and growth-triggered heap profiles.
  480. - Fix the "epoch" mallctl to update cached stats even if the passed in epoch
  481. is 0.
  482. - Fix bin->runcur management to fix a layout policy bug. This bug did not
  483. affect correctness.
  484. - Fix a bug in choose_arena_hard() that potentially caused more arenas to be
  485. initialized than necessary.
  486. - Add missing "opt.lg_tcache_max" mallctl implementation.
  487. - Use glibc allocator hooks to make mixed allocator usage less likely.
  488. - Fix build issues for --disable-tcache.
  489. - Don't mangle pthread_create() when --with-private-namespace is specified.
  490. * 2.2.5 (November 14, 2011)
  491. Bug fixes:
  492. - Fix huge_ralloc() race when using mremap(2). This is a serious bug that
  493. could cause memory corruption and/or crashes.
  494. - Fix huge_ralloc() to maintain chunk statistics.
  495. - Fix malloc_stats_print(..., "a") output.
  496. * 2.2.4 (November 5, 2011)
  497. Bug fixes:
  498. - Initialize arenas_tsd before using it. This bug existed for 2.2.[0-3], as
  499. well as for --disable-tls builds in earlier releases.
  500. - Do not assume a 4 KiB page size in test/rallocm.c.
  501. * 2.2.3 (August 31, 2011)
  502. This version fixes numerous bugs related to heap profiling.
  503. Bug fixes:
  504. - Fix a prof-related race condition. This bug could cause memory corruption,
  505. but only occurred in non-default configurations (prof_accum:false).
  506. - Fix off-by-one backtracing issues (make sure that prof_alloc_prep() is
  507. excluded from backtraces).
  508. - Fix a prof-related bug in realloc() (only triggered by OOM errors).
  509. - Fix prof-related bugs in allocm() and rallocm().
  510. - Fix prof_tdata_cleanup() for --disable-tls builds.
  511. - Fix a relative include path, to fix objdir builds.
  512. * 2.2.2 (July 30, 2011)
  513. Bug fixes:
  514. - Fix a build error for --disable-tcache.
  515. - Fix assertions in arena_purge() (for real this time).
  516. - Add the --with-private-namespace option. This is a workaround for symbol
  517. conflicts that can inadvertently arise when using static libraries.
  518. * 2.2.1 (March 30, 2011)
  519. Bug fixes:
  520. - Implement atomic operations for x86/x64. This fixes compilation failures
  521. for versions of gcc that are still in wide use.
  522. - Fix an assertion in arena_purge().
  523. * 2.2.0 (March 22, 2011)
  524. This version incorporates several improvements to algorithms and data
  525. structures that tend to reduce fragmentation and increase speed.
  526. New features:
  527. - Add the "stats.cactive" mallctl.
  528. - Update pprof (from google-perftools 1.7).
  529. - Improve backtracing-related configuration logic, and add the
  530. --disable-prof-libgcc option.
  531. Bug fixes:
  532. - Change default symbol visibility from "internal", to "hidden", which
  533. decreases the overhead of library-internal function calls.
  534. - Fix symbol visibility so that it is also set on OS X.
  535. - Fix a build dependency regression caused by the introduction of the .pic.o
  536. suffix for PIC object files.
  537. - Add missing checks for mutex initialization failures.
  538. - Don't use libgcc-based backtracing except on x64, where it is known to work.
  539. - Fix deadlocks on OS X that were due to memory allocation in
  540. pthread_mutex_lock().
  541. - Heap profiling-specific fixes:
  542. + Fix memory corruption due to integer overflow in small region index
  543. computation, when using a small enough sample interval that profiling
  544. context pointers are stored in small run headers.
  545. + Fix a bootstrap ordering bug that only occurred with TLS disabled.
  546. + Fix a rallocm() rsize bug.
  547. + Fix error detection bugs for aligned memory allocation.
  548. * 2.1.3 (March 14, 2011)
  549. Bug fixes:
  550. - Fix a cpp logic regression (due to the "thread.{de,}allocatedp" mallctl fix
  551. for OS X in 2.1.2).
  552. - Fix a "thread.arena" mallctl bug.
  553. - Fix a thread cache stats merging bug.
  554. * 2.1.2 (March 2, 2011)
  555. Bug fixes:
  556. - Fix "thread.{de,}allocatedp" mallctl for OS X.
  557. - Add missing jemalloc.a to build system.
  558. * 2.1.1 (January 31, 2011)
  559. Bug fixes:
  560. - Fix aligned huge reallocation (affected allocm()).
  561. - Fix the ALLOCM_LG_ALIGN macro definition.
  562. - Fix a heap dumping deadlock.
  563. - Fix a "thread.arena" mallctl bug.
  564. * 2.1.0 (December 3, 2010)
  565. This version incorporates some optimizations that can't quite be considered
  566. bug fixes.
  567. New features:
  568. - Use Linux's mremap(2) for huge object reallocation when possible.
  569. - Avoid locking in mallctl*() when possible.
  570. - Add the "thread.[de]allocatedp" mallctl's.
  571. - Convert the manual page source from roff to DocBook, and generate both roff
  572. and HTML manuals.
  573. Bug fixes:
  574. - Fix a crash due to incorrect bootstrap ordering. This only impacted
  575. --enable-debug --enable-dss configurations.
  576. - Fix a minor statistics bug for mallctl("swap.avail", ...).
  577. * 2.0.1 (October 29, 2010)
  578. Bug fixes:
  579. - Fix a race condition in heap profiling that could cause undefined behavior
  580. if "opt.prof_accum" were disabled.
  581. - Add missing mutex unlocks for some OOM error paths in the heap profiling
  582. code.
  583. - Fix a compilation error for non-C99 builds.
  584. * 2.0.0 (October 24, 2010)
  585. This version focuses on the experimental *allocm() API, and on improved
  586. run-time configuration/introspection. Nonetheless, numerous performance
  587. improvements are also included.
  588. New features:
  589. - Implement the experimental {,r,s,d}allocm() API, which provides a superset
  590. of the functionality available via malloc(), calloc(), posix_memalign(),
  591. realloc(), malloc_usable_size(), and free(). These functions can be used to
  592. allocate/reallocate aligned zeroed memory, ask for optional extra memory
  593. during reallocation, prevent object movement during reallocation, etc.
  594. - Replace JEMALLOC_OPTIONS/JEMALLOC_PROF_PREFIX with MALLOC_CONF, which is
  595. more human-readable, and more flexible. For example:
  596. JEMALLOC_OPTIONS=AJP
  597. is now:
  598. MALLOC_CONF=abort:true,fill:true,stats_print:true
  599. - Port to Apple OS X. Sponsored by Mozilla.
  600. - Make it possible for the application to control thread-->arena mappings via
  601. the "thread.arena" mallctl.
  602. - Add compile-time support for all TLS-related functionality via pthreads TSD.
  603. This is mainly of interest for OS X, which does not support TLS, but has a
  604. TSD implementation with similar performance.
  605. - Override memalign() and valloc() if they are provided by the system.
  606. - Add the "arenas.purge" mallctl, which can be used to synchronously purge all
  607. dirty unused pages.
  608. - Make cumulative heap profiling data optional, so that it is possible to
  609. limit the amount of memory consumed by heap profiling data structures.
  610. - Add per thread allocation counters that can be accessed via the
  611. "thread.allocated" and "thread.deallocated" mallctls.
  612. Incompatible changes:
  613. - Remove JEMALLOC_OPTIONS and malloc_options (see MALLOC_CONF above).
  614. - Increase default backtrace depth from 4 to 128 for heap profiling.
  615. - Disable interval-based profile dumps by default.
  616. Bug fixes:
  617. - Remove bad assertions in fork handler functions. These assertions could
  618. cause aborts for some combinations of configure settings.
  619. - Fix strerror_r() usage to deal with non-standard semantics in GNU libc.
  620. - Fix leak context reporting. This bug tended to cause the number of contexts
  621. to be underreported (though the reported number of objects and bytes were
  622. correct).
  623. - Fix a realloc() bug for large in-place growing reallocation. This bug could
  624. cause memory corruption, but it was hard to trigger.
  625. - Fix an allocation bug for small allocations that could be triggered if
  626. multiple threads raced to create a new run of backing pages.
  627. - Enhance the heap profiler to trigger samples based on usable size, rather
  628. than request size.
  629. - Fix a heap profiling bug due to sometimes losing track of requested object
  630. size for sampled objects.
  631. * 1.0.3 (August 12, 2010)
  632. Bug fixes:
  633. - Fix the libunwind-based implementation of stack backtracing (used for heap
  634. profiling). This bug could cause zero-length backtraces to be reported.
  635. - Add a missing mutex unlock in library initialization code. If multiple
  636. threads raced to initialize malloc, some of them could end up permanently
  637. blocked.
  638. * 1.0.2 (May 11, 2010)
  639. Bug fixes:
  640. - Fix junk filling of large objects, which could cause memory corruption.
  641. - Add MAP_NORESERVE support for chunk mapping, because otherwise virtual
  642. memory limits could cause swap file configuration to fail. Contributed by
  643. Jordan DeLong.
  644. * 1.0.1 (April 14, 2010)
  645. Bug fixes:
  646. - Fix compilation when --enable-fill is specified.
  647. - Fix threads-related profiling bugs that affected accuracy and caused memory
  648. to be leaked during thread exit.
  649. - Fix dirty page purging race conditions that could cause crashes.
  650. - Fix crash in tcache flushing code during thread destruction.
  651. * 1.0.0 (April 11, 2010)
  652. This release focuses on speed and run-time introspection. Numerous
  653. algorithmic improvements make this release substantially faster than its
  654. predecessors.
  655. New features:
  656. - Implement autoconf-based configuration system.
  657. - Add mallctl*(), for the purposes of introspection and run-time
  658. configuration.
  659. - Make it possible for the application to manually flush a thread's cache, via
  660. the "tcache.flush" mallctl.
  661. - Base maximum dirty page count on proportion of active memory.
  662. - Compute various additional run-time statistics, including per size class
  663. statistics for large objects.
  664. - Expose malloc_stats_print(), which can be called repeatedly by the
  665. application.
  666. - Simplify the malloc_message() signature to only take one string argument,
  667. and incorporate an opaque data pointer argument for use by the application
  668. in combination with malloc_stats_print().
  669. - Add support for allocation backed by one or more swap files, and allow the
  670. application to disable over-commit if swap files are in use.
  671. - Implement allocation profiling and leak checking.
  672. Removed features:
  673. - Remove the dynamic arena rebalancing code, since thread-specific caching
  674. reduces its utility.
  675. Bug fixes:
  676. - Modify chunk allocation to work when address space layout randomization
  677. (ASLR) is in use.
  678. - Fix thread cleanup bugs related to TLS destruction.
  679. - Handle 0-size allocation requests in posix_memalign().
  680. - Fix a chunk leak. The leaked chunks were never touched, so this impacted
  681. virtual memory usage, but not physical memory usage.
  682. * linux_2008082[78]a (August 27/28, 2008)
  683. These snapshot releases are the simple result of incorporating Linux-specific
  684. support into the FreeBSD malloc sources.
  685. --------------------------------------------------------------------------------
  686. vim:filetype=text:textwidth=80