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