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