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