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