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