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