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