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