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