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