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