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