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