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