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