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