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