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