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