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