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