5 - issue #81: bug in gc::DHP when extending thread's retired array,
6 thanks to gtroxler (https://github.com/gtroxler)
7 - Improved CMake scripts for simplifying libcds intergration with
10 add_library(mylib INTERFACE)
11 target_link_libraries(mylib INTERFACE LibCDS::cds)
12 Thansk to Louis Dionne (https://github.com/ldionne)
16 - Changed: cds::gc::HP is totally refactored:
17 - simplified internal structures;
18 - added ability to specify an external allocator for internal data;
19 - external API for gc::HP is slightly changed: now scan type
20 cannot be changed on the fly; it can be specified only in
22 - Changed: cds::gc::DHP is totally refactored to overcome some internal
23 limitations. Now gc::DHP is fully adaptive variant of Hazard Pointer
24 SMR, any dependencies on count of thread are removed, count of retired
25 data and hazard pointers per thread are increased automaticaly by perforce.
26 External API of gc::DHP class is changed: now only initial count
27 of hazard pointers can be specified in the constructor. Like new gc::HP,
28 the new gc::DHP supports an external allocator.
29 - Changed: exception handling. Now, exceptions raise by invoking new
30 cds::throw_exception() function. If you compile your code with exception disabled,
31 the function prints an exception message to stdout and calls abort()
33 - Flat Combining: fixed memory-order bug that can lead to crash on weak ordered
34 architecture like PowerPC or ARM
35 - Added: erase_at( iterator ) function to MichaelHashSet/Map and SplitListSet/Map
37 - Fixed a bug in BronsonAVLTreeMap::extract_min()/extract_max()/clear().
38 - Removed: signal-handled threaded uRCU (cds::urcu::signal_threaded) due
40 - Added more flat-combining queue tests, thanks to Marsel Galimullin.
41 - Changed cmake scripts to support MacOS and ARMv7/ARMv8 (64 bit),
42 thanks to Michail Komarov (https://github.com/Nemo1369)
43 - Stress tests: removed command line parameter --detail-level and
44 envvar CDSTEST_DETAIL_LEVEL for reducing compile time and executable size.
45 To make full testset compile libcds with -DCDS_STRESS_TEST_LEVEL=N where
47 - Changed: refactoring cds::backoff::exponential and cds::backoff::delay
48 back-off strategies to avoid static data members in template classes.
49 - The library is extensively tested on x86-64, PowerPC and AArch64,
50 thanks to GCC Compile Farm project
54 - Changed: CMake is used for build libcds. Ancient build.sh has been removed
55 - Changed: unit and stress tests are migrated to googletest framework
56 - Added: IterableList - an implementation of ordered list with
57 thread-safe iterator. MichaelSet/Map and SplitListSet/Map support
58 this type of ordered list and thread-safe iterable too.
59 - Added: wait strategies for flat combining technique. Based on
60 research by Marsel Galimullin and Nikolai Rapotkin.
61 - Fixed: SkipList erase() and find() bugs that cause to infinite loop
62 or to program crash in rare case.
63 - Fixed: serious bug in MichaelSet::emplace() function
64 New node was created twice from the arguments by move semantics.
65 However, move semantics may change internal state of the argument
66 that can lead to an incorrect element and even an incorrect key
67 that breaks the set logic.
68 - Fixed: bug in FeldmanHashSet::erase_at( iterator ): due an error
69 in precondition checking the function may incorrectly return false.
70 - Fixed: possible double-free case in flat combining algorithm.
71 Thanks to Amila Jayasekara who pointed me to this problem
72 - Changed: cds::opt::buffer option is divided to initialized
73 (cds::opt::v::initialized_dynamic_buffer, cds::opt::v::initialized_static_buffer)
74 and uninitialized (cds::opt::v::uninitialized_dynamic_buffer, cds::opt::v::uninitialized_static_buffer)
75 ones. The old cds::opt::v::dynamic_buffer and cds::opt::v::static_buffer classes
77 - Removed: TsigasCysleQueue (due undecidable ABA-problem)
78 - Removed: Michael's allocator cds/memory/michael/allocator.h
79 - Fixed: use-after-free bug in VyukovMPMCCycleQueue internal buffer.
80 To prevent this bug the queue uses an uninitialized buffer now.
81 - Fixed: rare priority inversion bug in MSPriorityQueue
82 - Added: for minimizing runtime of stress test the detail level for some test is added.
83 Command line argument --detail-level=N specifies what test should be ran: each
84 test with level not greater than N will be ran. Instead of command line arg
85 the enviromnent variable CDSTEST_DETAIL_LEVEL=N may be used.
86 By default, the detail level is 0 that means only limited set of the test will be ran.
90 - Added: FeldmanHashSet/Map - an interesting hash map algorithm
91 based on multi-level array, requires perfect hashing or fixed-sized keys.
92 Supports thread-safe bidirectional iterators.
93 - Added: BronsonAVLTreeMap - Bronson's et al AVL tree implementation
94 - Added: CMake build script, thanks to Eugeny Kalishenko
95 - Changed: SplitList performance improving, thanks to Mike Krinkin
96 - Changed: semantic of member functions extract(), get() and its
97 variants for MichaelList RCU-based specialization: extract() does not
98 require RCU locking, get() now returns special wrapper object of type raw_ptr,
100 Thus, semantics of extract()/get() of all RCU-based set and maps based on
101 MichaelList (MichaelSet/Map, SplitListSet/Map) has been changed too.
102 - Changed: SplitListSet/Map functions get() and get_with() return special wrapper
103 object of type raw_ptr, see doc.
104 - Removed: SplitListSet/Map force_dispose() function.
105 - cds::lock namespace is renamed to cds::sync. All classes defined in cds::lock namespace
106 are moved to cds::sync with new names (for example, cds::lock::SpinLock is renamed to
107 cds::sync::spin_lock). cds::lock namespace and its contents is deprecated, it is kept
108 for backward compatibility.
109 - The library has been checked by ThreadSanitizer, a lot of bugs has been fixed
110 - Added support for clang 3.7 with libc++
114 - the library has been rewritten to support at least C++11. Compilers: GCC 4.8+, clang 3.3+,
115 MS Visual C++ 12 (2013) Update 4 an above.
116 - Removed: MichaelDeque, reason: the implementation is heavy-weighted, inefficient,
117 and, seems, unstable.
118 - Removed: cds::gc::HRC garbage collector, reason: the implementation is inefficient
120 - Changed: all container's declaration except StripedSet has been unified to the
121 following traits-based form:
122 class Container< GC, T, Traits >
123 - Added: new member function pop_with(Func) to cds::container::TreiberStack
124 - Added: new member functions enqueue_with(Func), dequeue_with(Func) to
125 cds::container::MSQueue
126 cds::container::MoirQueue
127 cds::container::BasketQueue
128 cds::container::OptimisticQueue
129 cds::container::RWQueue
130 cds::container::SegmentedQueue
131 cds::container::TsigasCycleQueue
132 cds::container::VyukovMPMCCycleQueue
133 - Added: new member functions push_with(Func) and pop_with(Func) to cds::container::MSPriorityQueue
134 - SegmentedQueue: add padding into segmented_queue::traits to eliminate false sharing.
135 - Changed: guarded_ptr and exempt_ptr have move semantics now. The container's extract() and get()
136 member functions return the objects of that type.
137 - Changed: improved cds::gc::HP and cds::gc::DHP internal implementation
138 - Changed: map member function insert_key() has been renamed to insert_with()
139 - Changed: cds/cxx11_atomic.h has been renamed to cds/algo/atomic.h
140 - Removed: cds/refcounter.h
144 - Add flat combining (FC) technique and FC-based containers: FCStack, FCQueue,
145 FCDeque, FCPriorityQueue
146 - Add elimination back-off feature to TreiberStack class
147 - Add SegmentedQueue - an unfair queue implementation
148 - New member functions for sets and maps:
149 Functions get() and get_with() search a key and return the pointer to item found
151 Function extract() searches a key, unlinks the item found from the container
152 and returns pointer to item in safe manner.
153 The functions get, get_with, extract, extract_with extract_min, extract_max
154 has been added to the following container:
155 SkipListSet, SkipListMap
156 EllenBinTree, EllenBinTreeSet, EllenBinTreeMap
157 The functions get, get_with, extract, extract_with has been added
158 to the following container:
159 MichaelList, LazyList
160 MichaelHashSet, MichaelHashMap
161 SplitListSet, SplitListMap
162 - Fix a serious bug in cds::gc::HRC
163 - Changed MSPriorityQueue to simplify interface and to fix possible pop() deadlock
164 - Fix a bug in BasketQueue
165 - Fix EllenBinTree crash under high contention
166 - Changed: the thread manager detach order to prevent crashing of signal-handled RCU
168 - Changed: cds::gc::HP calls Scan() when a thread is detached.
169 This prevents accumulating retired data.
170 - Changed: minimal boost version is 1.51
171 - Removed: file cds/lock/rwlock.h
175 1. Added: EllenBinTree - an implementation of unbalanced binary search
176 tree based on paper [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel
177 "Non-blocking Binary Search Tree".
178 2. Added: MSPriorityQueue - an array-based lock-based priority queue heap,
179 see [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient
180 algorithm for concurrent priority queue heaps"
181 3. Added support for boost.atomic for boost 1.54 and above.
182 Now, libcds supports processor architecture like ARM, PowerPC and any other
183 that are supported by boost.atomic or by C++11 compiler. Any feedbacks are appreciated.
184 To use boost.atomic you should specify -DCDS_USE_BOOST_ATOMIC in compiler's command line.
185 4. Added: a new CDS_USE_LIBCDS_ATOMIC preprocessor flag has been added to direct
186 the compiler to use libcds atomic unconditionally.
187 5. build.sh has been modified to relax processor architecture and OS requirements.
188 This allows to use libcds with native compiler atomic support (or boost.atomic)
189 for a processor architecture that has not been tested by libcds's developers.
190 6. Added support for CLang 3.3
191 7. Added support for MS VC++ 2013
192 8. Added support for Mac OS X, see build/sample/build-osx-clang-libc++.sh,
193 build/sample/build-osx-gcc.sh for example.
194 9. Fixed: SkipListSet::erase_with does not take into account "less" predicate parameter.
195 10.Fixed: some bugs in SkipListSet leading to deadloop
196 11.Fixed: MichaelMap bug: computing hash value for type Q different from key type.
200 1. Added: user-space RCU garbage collector (5 different implementations),
201 see cds::urcu namespace
202 2. Added: RCU-related set/map container specializations
203 3. Added: Skip-list specialization for cds::gc::nogc (undeletable skip-list)
204 4. For set/map classes: find_with and erase_with member functions have been added.
205 These functions allow to use different predicates for searching.
206 5. Added: threading model based on Ñ++11 thread_local keyword (CDS_THREADING_CXX11).
207 At present, only gcc 4.8 supports such model.
208 6. Fixed: bug #11 "ABA bug in libcds 1.3.1 cds/intrusive/msqueue.h"
209 Thanks to Jelle van den Hooff.
210 7. Added support for GCC 4.8
214 - Bug fixed: building libcds with boost versions before 1.48
215 Thanks Lucas Larsch who points me to this problem.
219 1. Added: StripedSet, StripedMap - hash set and hash map
220 implementation based on fine-grained lock-striping technique
221 2. Added: CuckooSet, CuckooMap - implementation of cuckoo hashing algorithm
222 based on fine-grained lock-striping technique
223 3. Added: SkipListSet, SkipListMap - implementation of lock-free skip list
224 4. Added: template <typename... Args> emplace(Args&&... args) member function
225 for all containers in cds::container namespace. This function is available
226 only if the compiler supports new C++11 features - variadic
227 templates and move semantics.
228 5. Changed: lambda functions are used internally instead of wrapping functors.
229 If the compiler does not support C++11 lambdas the old-style wrapping functors are used.
230 6. Changed: test projects has been splitted for optimizing compile time.
231 7. Breaking change: class cds::lock::Auto has been renamed to cds::lock::scoped_lock,
232 class cds::lock::AutoUnlock has been removed
233 8. Added: support for MinGW (tested with TDM-GCC 64bit, gcc 4.7)
235 1.2.0 20.08.2012 (beta)
237 1. Added: MichaelDeque - deque lock-free algo discovered by Maged Michael
238 2. Added: BasketQueue - Michael's queue modification discovered by Nir Shavit et al.
239 3. Added: support of Clang 3.0, 3.1 compiler (tested on Linux with boost 1.49)
240 4. Fixed: solving problem of 8-byte atomic data alignment on 32-bit platforms
241 5. Fixed bug 3536393: OptimisticQueue core dump
243 1.1.0 17.04.2012 (beta)
245 1. Added: C++11 atomic operations support. The library has been rewritten
246 for using std::atomic class and operations proposed in C++11 Standard.
247 If the compiler does not support the standard <atomic> library,
248 own partial implementation declared in cds/cxx11_atomic.h is used.
249 cxx11_atomic.h contains implementation for lock-free part of C++11
250 <atomic> header needed for libcds.
251 2. Added: support for C++11 feature (if applicable):
252 - inline namespace (for GCC 4.4+)
253 - function =default and =delete specifiers (for GCC 4.4+)
254 3. Changed: the main reclamation cycle ("liberate" function) of cds::gc::PTB
255 memory reclamation schema has been optimized. Previous implementation
256 could lead to unbounded memory consumption under high contention.
257 4. Changed: the internal structure of cds::intrusive::OptimisticQueue is greatly simplified.
258 The interface of the class is slightly changed.
259 5. Fixed: some problem with cds::gc::HRC memory reclamation schema that
260 could be the cause of occasional program crash.
261 6. Fixed: an error in node reclamation algo in queue implementation (MSQueue, MoirQueue,
262 OptimisticQueue). As an result of the error, some items could be lost with memory leaks.
263 7. Changed: cds::concept namespace and its content has been removed
264 8. Added support for Microsoft Visual C++ 11 Beta
265 9. Added support for GCC 4.7
267 1.0.0 31.12.2011 (beta)
268 This version is completely rewritten to support intrusive version of lock-free containers
269 and more lightweight garbage collectors interface.
270 The class hierarchy and interfaces have been completely reimplemented from scratch.
272 1. Added: intrusive containers. Many lock-free containers in libcds have the intrusive
273 counterparts. The library is fully refactored to support intrusive containers.
274 Class hierarchy is changed: almost all non-intrusive container classes are based
275 on their intrusive versions.
276 Two new namespace is added:
277 cds::intrusive - for intrusive containers
278 cds::container - for non-intrusive containers
279 Namespaces by container type (cds::queue, cds::map and so on) have been removed.
280 2. Added: New option-based approach is used for class declaration instead
281 old traits-based one. This approach allows to declare template arguments
282 in position-independent manner that is very useful for complex template declarations.
283 Option-based declarations use C++0x variadic templates if compiler supports it (GCC),
284 otherwise (MS VC) an emulation is used.
285 3. Changed: garbage collectors interface is generalized. cds::gc::GC (where GC is
286 one of HP, HRC, PTB) classes has been added.
287 4. Removed: tagged pointer GC. This GC
288 - unsafe for complex data structure
289 - x86-specific since it requires double-width CAS primitive
290 - memory-consuming since it requires separate free-list for each type stored in the containers
291 5. Default threading model is changed (see doc for cds::threading namespace):
292 - for Windows and MSVC++, CDS_THREADING_WIN_TLS is the default now
293 - for *nix and GCC, CDS_THREADING_PTHREAD is the default now
294 6. Added GCC 4.6 support (constexpr)
295 7. Added Microsoft Visual Studio 2010 (vc10) solution
297 0.8.0 28.03.2011 (beta)
298 1. Added: cds::Initialize and cds::Terminate functions that initializes and frees library's
300 2. Added: cds::memory::michael::Heap - Michael's lock-free allocator
301 3. Added: Exponential back-off strategy for spinning
302 4. Added: cds::queue::vyukov_mpmc_bounded - bounded queue
303 developed by Dmitry Vyukov (http://www.1024cores.net)
304 5. Added: support for FreeBSD amd64, x86
306 0.7.2 27.02.2011 (beta)
307 1. [Bug 3157201] Added implementation of threading manager based on Windows TLS API, see
308 cds::threading::wintls::Manager. Added CDS_THREADING_WIN_TLS macro. See docs for
309 cds::threading namespace for details.
310 2. Fixed bug in cds::threading::pthread::Manager: ptb_gc has not been initialized properly.
312 template <typename T, typename FUNC>
313 bool erase( const key_type& key, T& dest, FUNC func ) ;
314 has been added to all map classes.
316 template <typename T, typename FUNC>
317 bool insert( const key_type& key, T& val, FUNC func ) ;
318 has been added to all map classes.
319 5. Added new argument "bNew" to functor "func" of map's "ensure" member function:
320 void func( VALUE& itemValue, const VALUE& val, bool bNew ) ;
321 bNew = true if new item has been added
322 bNew = false if key is found
323 6. Fixed bug in cds::map::SplitOrderedList: LSB of dummy node's hash should be zero
324 7. Changed: thread liveliness checking on *nix has been changed to pthread_kill(id, 0).
325 8. Fixed: in map template member functions the functor may be passed by value
326 or by reference; use boost::ref( yourFunctor ) to pass your functor by reference
327 9. Fixed: cds::gc::tagged GC and all classes based on this GC has been rewritten
328 to solve stability problems.
330 0.7.1 30.12.2010 (beta)
331 1. [Bug 3130852] cds::queue::TZCyclicQueue::empty() has been corrected
332 2. [Bug 3128161] It seems, GCC 4.4 has a bug in __thread on x86 and x86_64. New "threading model"
333 CDS_THREADING_AUTODETECT has been added. See docs of cds::threading namespace for details
334 3. Fixed errors in the "Pass-the-Buck" garbage collector (namespace cds::gc::ptb)
335 4. [Bug 3128148] The code is aligned with the C++ standard (minor violations has been removed)
336 5. [Bug 3141654] missing break statement for atomic store - fixed
337 6. Added in-place scan strategy to cds::gc::hzp::GarbageCollector that does not allocate any memory.
338 7. Fixed bugs in HRC and tagged GC
340 0.7.0 05.12.2010 (beta)
341 1. Preliminary support for "Pass The Buck" memory manager is added. See cds::gc::ptb namespace.
342 2. Many part of library is rewritten to generalize the usage of various GCs
343 3. The new class cds::details::aligned_allocator has been added for allocating aligned memory
344 blocks. It is useful for Tagged Pointer memory reclamation schema (cds::gc::tagged_gc).
345 4. [Break change] New argument has been added to the member functions "ensure" and "find"
346 for ordered list and map classes
347 5. New member function "emplace" has been added to ordered list and map classes. This member function
348 allows change the value (or a part of it) of list/map item.
349 6. The internal structure of class cds::map::MichaelHashMap is completely refactored to support
350 cds::gc::no_gc correctly
351 7. The classes RecursiveSpinT, RecursiveSpin32, RecursiveSpin64, and RecursiveSpin from cds::lock
352 namespace have been renamed to ReentrantSpinT, ReentrantSpin32, ReentrantSpin64, and ReentrantSpin
354 8. Compiler support: GCC version below 4.3.0 is not supported
355 9. Fixed memory leak in cds::map::SplitOrderedList
356 10. Added compiler barrier to spin-lock release primitive for x86 and amd64
357 11. Makefile script is changed to resolve the problem when an user calls 'make clean' directly.
358 Thanks to Tamas Lengyel to point me to this bug.
359 12. The file dictionary.txt is excluded from distributive. This file is used for testing purposes only.
360 You may create dictionary.txt in this way:
364 0.6.0 26.03.2010 (beta)
365 1. The library is rewritten using atomic primitives with explicit memory ordering (based on C++
366 memory model proposal). The implementation of atomic primitives for supported architectures
367 is developed from scratch.
370 0.5.0 31.12.2009 (beta)