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