Merge branch 'master' of /home/git/concurrency-benchmarks
[c11concurrency-benchmarks.git] / gdax-orderbook-hpp / demo / dependencies / libcds-2.3.2 / change.log
1 2.3.2 31.12.2017
2     Maintenance release
3     - Added: apply( Func f ) method to containers based on flat combining.
4       This method allows to execute any function over underlying container
5       in exclusive mode.
6     - Removed: -fno-strict-aliasing requirement
7     - Fixed: a serious bug in WeakRingBuffer::front()
8     - Fixed: memcpy bug in CuckooHash with store_hash feature
9
10 2.3.1 01.09.2017
11     Maintenance release
12     - issue #81: bug in gc::DHP when extending thread's retired array,
13       thanks to gtroxler (https://github.com/gtroxler)
14     - Improved CMake scripts for simplifying libcds intergration with
15       other projects:
16         find_package(LibCDS)
17         add_library(mylib INTERFACE)
18         target_link_libraries(mylib INTERFACE LibCDS::cds)
19       Thansk to Louis Dionne (https://github.com/ldionne)
20
21 2.3.0 31.07.2017
22     General release
23     - Changed: cds::gc::HP is totally refactored:
24         - simplified internal structures;
25         - added ability to specify an external allocator for internal data;
26         - external API for gc::HP is slightly changed: now scan type
27           cannot be changed on the fly; it can be specified only in
28           construction time.
29     - Changed: cds::gc::DHP is totally refactored to overcome some internal
30       limitations. Now gc::DHP is fully adaptive variant of Hazard Pointer 
31       SMR, any dependencies on count of thread are removed, count of retired
32       data and hazard pointers per thread are increased automaticaly by perforce.
33       External API of gc::DHP class is changed: now only initial count 
34       of hazard pointers can be specified in the constructor. Like new gc::HP,
35       the new gc::DHP supports an external allocator.
36     - Changed: exception handling. Now, exceptions raise by invoking new 
37       cds::throw_exception() function. If you compile your code with exception disabled,
38       the function prints an exception message to stdout and calls abort()
39       instead of throwing.
40     - Flat Combining: fixed memory-order bug that can lead to crash on weak ordered
41       architecture like PowerPC or ARM
42     - Added: erase_at( iterator ) function to MichaelHashSet/Map and SplitListSet/Map
43       based on IterableList
44     - Fixed a bug in BronsonAVLTreeMap::extract_min()/extract_max()/clear().
45     - Removed: signal-handled threaded uRCU (cds::urcu::signal_threaded) due
46       bad performance
47     - Added more flat-combining queue tests, thanks to Marsel Galimullin.
48     - Changed cmake scripts to support MacOS and ARMv7/ARMv8 (64 bit),
49       thanks to Michail Komarov (https://github.com/Nemo1369)
50     - Stress tests: removed command line parameter --detail-level and
51       envvar CDSTEST_DETAIL_LEVEL for reducing compile time and executable size.
52       To make full testset compile libcds with -DCDS_STRESS_TEST_LEVEL=N where
53       N is 1 or 2.
54     - Changed: refactoring cds::backoff::exponential and cds::backoff::delay
55       back-off strategies to avoid static data members in template classes. 
56     - The library is extensively tested on x86-64, PowerPC and AArch64,
57       thanks to GCC Compile Farm project
58  
59 2.2.0 04.01.2017
60     General release
61     - Changed: CMake is used for build libcds. Ancient build.sh has been removed
62     - Changed: unit and stress tests are migrated to googletest framework
63     - Added: IterableList - an implementation of ordered list with 
64       thread-safe iterator. MichaelSet/Map and SplitListSet/Map support 
65       this type of ordered list and thread-safe iterable too.
66     - Added: wait strategies for flat combining technique. Based on
67       research by Marsel Galimullin and Nikolai Rapotkin.
68     - Fixed: SkipList erase() and find() bugs that cause to infinite loop 
69       or to program crash in rare case.
70     - Fixed: serious bug in MichaelSet::emplace() function
71       New node was created twice from the arguments by move semantics. 
72       However, move semantics may change internal state of the argument
73       that can lead to an incorrect element and even an incorrect key
74       that breaks the set logic.
75     - Fixed: bug in FeldmanHashSet::erase_at( iterator ): due an error
76       in precondition checking the function may incorrectly return false.
77     - Fixed: possible double-free case in flat combining algorithm. 
78       Thanks to Amila Jayasekara who pointed me to this problem
79     - Changed: cds::opt::buffer option is divided to initialized
80       (cds::opt::v::initialized_dynamic_buffer, cds::opt::v::initialized_static_buffer)
81       and uninitialized (cds::opt::v::uninitialized_dynamic_buffer, cds::opt::v::uninitialized_static_buffer)
82       ones. The old cds::opt::v::dynamic_buffer and cds::opt::v::static_buffer classes
83       are removed.
84     - Removed: TsigasCysleQueue (due undecidable ABA-problem)
85     - Removed: Michael's allocator cds/memory/michael/allocator.h
86     - Fixed: use-after-free bug in VyukovMPMCCycleQueue internal buffer.
87       To prevent this bug the queue uses an uninitialized buffer now.
88     - Fixed: rare priority inversion bug in MSPriorityQueue
89     - Added: for minimizing runtime of stress test the detail level for some test is added.
90       Command line argument --detail-level=N specifies what test should be ran: each
91       test with level not greater than N will be ran. Instead of command line arg
92       the enviromnent variable CDSTEST_DETAIL_LEVEL=N may be used.
93       By default, the detail level is 0 that means only limited set of the test will be ran.
94
95 2.1.0 06.01.2016
96     General release
97     - Added: FeldmanHashSet/Map - an interesting hash map algorithm
98       based on multi-level array, requires perfect hashing or fixed-sized keys.
99       Supports thread-safe bidirectional iterators.
100     - Added: BronsonAVLTreeMap - Bronson's et al AVL tree implementation
101     - Added: CMake build script, thanks to Eugeny Kalishenko
102     - Changed: SplitList performance improving, thanks to Mike Krinkin
103     - Changed: semantic of member functions extract(), get() and its
104       variants for MichaelList RCU-based specialization: extract() does not
105       require RCU locking, get() now returns special wrapper object of type raw_ptr,
106       see doc.
107       Thus, semantics of extract()/get() of all RCU-based set and maps based on 
108       MichaelList (MichaelSet/Map, SplitListSet/Map) has been changed too.
109     - Changed: SplitListSet/Map functions get() and get_with() return special wrapper
110       object of type raw_ptr, see doc.
111     - Removed: SplitListSet/Map force_dispose() function.
112     - cds::lock namespace is renamed to cds::sync. All classes defined in cds::lock namespace 
113       are moved to cds::sync with new names (for example, cds::lock::SpinLock is renamed to
114       cds::sync::spin_lock). cds::lock namespace and its contents is deprecated, it is kept 
115       for backward compatibility.
116     - The library has been checked by ThreadSanitizer, a lot of bugs has been fixed
117     - Added support for clang 3.7 with libc++
118
119 2.0.0 30.12.2014
120     General release
121     - the library has been rewritten to support at least C++11. Compilers: GCC 4.8+, clang 3.3+, 
122       MS Visual C++ 12 (2013) Update 4 an above.
123     - Removed: MichaelDeque, reason: the implementation is heavy-weighted, inefficient,
124       and, seems, unstable.
125     - Removed: cds::gc::HRC garbage collector, reason: the implementation is inefficient 
126       and unstable.
127     - Changed: all container's declaration except StripedSet has been unified to the
128       following traits-based form: 
129            class Container< GC, T, Traits >
130     - Added: new member function pop_with(Func) to cds::container::TreiberStack
131     - Added: new member functions enqueue_with(Func), dequeue_with(Func) to 
132              cds::container::MSQueue
133              cds::container::MoirQueue
134              cds::container::BasketQueue
135              cds::container::OptimisticQueue
136              cds::container::RWQueue
137              cds::container::SegmentedQueue
138              cds::container::TsigasCycleQueue
139              cds::container::VyukovMPMCCycleQueue
140     - Added: new member functions push_with(Func) and pop_with(Func) to cds::container::MSPriorityQueue
141     - SegmentedQueue: add padding into segmented_queue::traits to eliminate false sharing.
142     - Changed: guarded_ptr and exempt_ptr have move semantics now. The container's extract() and get()
143       member functions return the objects of that type.
144     - Changed: improved cds::gc::HP and cds::gc::DHP internal implementation
145     - Changed: map member function insert_key() has been renamed to insert_with()
146     - Changed: cds/cxx11_atomic.h has been renamed to cds/algo/atomic.h
147     - Removed: cds/refcounter.h
148
149 1.6.0 23.09.2014
150     General release
151     - Add flat combining (FC) technique and FC-based containers: FCStack, FCQueue, 
152       FCDeque, FCPriorityQueue
153     - Add elimination back-off feature to TreiberStack class
154     - Add SegmentedQueue - an unfair queue implementation
155     - New member functions for sets and maps:
156       Functions get() and get_with() search a key and return the pointer to item found 
157       in safe manner.
158       Function extract() searches a key, unlinks the item found from the container 
159       and returns pointer to item in safe manner.
160       The functions get, get_with, extract, extract_with extract_min, extract_max 
161       has been added to the following container:
162         SkipListSet, SkipListMap
163         EllenBinTree, EllenBinTreeSet, EllenBinTreeMap
164       The functions get, get_with, extract, extract_with has been added 
165       to the following container:
166         MichaelList, LazyList
167         MichaelHashSet, MichaelHashMap
168         SplitListSet, SplitListMap
169     - Fix a serious bug in cds::gc::HRC
170     - Changed MSPriorityQueue to simplify interface and to fix possible pop() deadlock
171     - Fix a bug in BasketQueue
172     - Fix EllenBinTree crash under high contention
173     - Changed: the thread manager detach order to prevent crashing of signal-handled RCU
174       in some case.
175     - Changed: cds::gc::HP calls Scan() when a thread is detached.
176       This prevents accumulating retired data.
177     - Changed: minimal boost version is 1.51
178     - Removed: file cds/lock/rwlock.h
179
180 1.5.0 29.12.2013
181     General release
182     1. Added: EllenBinTree - an implementation of unbalanced binary search
183       tree based on paper [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel 
184       "Non-blocking Binary Search Tree".
185     2. Added: MSPriorityQueue - an array-based lock-based priority queue heap, 
186       see [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient 
187       algorithm for concurrent priority queue heaps"
188     3. Added support for boost.atomic for boost 1.54 and above. 
189       Now, libcds supports processor architecture like ARM, PowerPC and any other
190       that are supported by boost.atomic or by C++11 compiler. Any feedbacks are appreciated.
191       To use boost.atomic you should specify -DCDS_USE_BOOST_ATOMIC in compiler's command line.
192     4. Added: a new CDS_USE_LIBCDS_ATOMIC preprocessor flag has been added to direct
193       the compiler to use libcds atomic unconditionally.
194     5. build.sh has been modified to relax processor architecture and OS requirements. 
195       This allows to use libcds with native compiler atomic support (or boost.atomic) 
196       for a processor architecture that has not been tested by libcds's developers.
197     6. Added support for CLang 3.3
198     7. Added support for MS VC++ 2013
199     8. Added support for Mac OS X, see build/sample/build-osx-clang-libc++.sh, 
200       build/sample/build-osx-gcc.sh for example.
201     9. Fixed: SkipListSet::erase_with does not take into account "less" predicate parameter.
202     10.Fixed: some bugs in SkipListSet leading to deadloop
203     11.Fixed: MichaelMap bug: computing hash value for type Q different from key type.
204
205 1.4.0 20.05.2013
206     General release
207     1. Added: user-space RCU garbage collector (5 different implementations), 
208        see cds::urcu namespace
209     2. Added: RCU-related set/map container specializations
210     3. Added: Skip-list specialization for cds::gc::nogc (undeletable skip-list)
211     4. For set/map classes: find_with and erase_with member functions have been added.
212        These functions allow to use different predicates for searching.
213     5. Added: threading model based on Ñ++11 thread_local keyword (CDS_THREADING_CXX11).
214        At present, only gcc 4.8 supports such model.
215     6. Fixed: bug #11 "ABA bug in libcds 1.3.1 cds/intrusive/msqueue.h"
216        Thanks to Jelle van den Hooff.
217     7. Added support for GCC 4.8
218
219 1.3.1 27.01.2013
220     Bugfix release
221     - Bug fixed: building libcds with boost versions before 1.48
222       Thanks Lucas Larsch who points me to this problem.
223   
224 1.3.0 29.12.2012
225     General release
226     1. Added: StripedSet, StripedMap - hash set and hash map 
227         implementation based on fine-grained lock-striping technique
228     2. Added: CuckooSet, CuckooMap - implementation of cuckoo hashing algorithm
229         based on fine-grained lock-striping technique
230     3. Added: SkipListSet, SkipListMap - implementation of lock-free skip list
231     4. Added: template <typename... Args> emplace(Args&&... args) member function 
232         for all containers in cds::container namespace. This function is available 
233         only if the compiler supports new C++11 features - variadic
234         templates and move semantics.
235     5. Changed: lambda functions are used internally instead of wrapping functors.
236         If the compiler does not support C++11 lambdas the old-style wrapping functors are used.
237     6. Changed: test projects has been splitted for optimizing compile time.
238     7. Breaking change: class cds::lock::Auto has been renamed to cds::lock::scoped_lock,
239         class cds::lock::AutoUnlock has been removed
240     8. Added: support for MinGW (tested with TDM-GCC 64bit, gcc 4.7)
241     
242 1.2.0 20.08.2012 (beta)
243     General release
244     1. Added: MichaelDeque - deque lock-free algo discovered by Maged Michael
245     2. Added: BasketQueue - Michael's queue modification discovered by Nir Shavit et al.
246     3. Added: support of Clang 3.0, 3.1 compiler (tested on Linux with boost 1.49)
247     4. Fixed: solving problem of 8-byte atomic data alignment on 32-bit platforms
248     5. Fixed bug 3536393: OptimisticQueue core dump 
249
250 1.1.0 17.04.2012 (beta)
251     General release
252     1. Added: C++11 atomic operations support. The library has been rewritten
253         for using std::atomic class and operations proposed in C++11 Standard.
254         If the compiler does not support the standard <atomic> library, 
255         own partial implementation declared in cds/cxx11_atomic.h is used. 
256         cxx11_atomic.h contains implementation for lock-free part of C++11 
257         <atomic> header needed for libcds.
258     2. Added: support for C++11 feature (if applicable):
259        - inline namespace (for GCC 4.4+)
260        - function =default and =delete specifiers (for GCC 4.4+)
261     3. Changed: the main reclamation cycle ("liberate" function) of cds::gc::PTB 
262        memory reclamation schema has been optimized. Previous implementation
263        could lead to unbounded memory consumption under high contention.
264     4. Changed: the internal structure of cds::intrusive::OptimisticQueue is greatly simplified. 
265        The interface of the class is slightly changed.
266     5. Fixed: some problem with cds::gc::HRC memory reclamation schema that
267        could be the cause of occasional program crash.
268     6. Fixed: an error in node reclamation algo in queue implementation (MSQueue, MoirQueue, 
269        OptimisticQueue). As an result of the error, some items could be lost with memory leaks.
270     7. Changed: cds::concept namespace and its content has been removed
271     8. Added support for Microsoft Visual C++ 11 Beta
272     9. Added support for GCC 4.7
273     
274 1.0.0  31.12.2011 (beta)
275     This version is completely rewritten to support intrusive version of lock-free containers
276     and more lightweight garbage collectors interface.
277     The class hierarchy and interfaces have been completely reimplemented from scratch.
278
279     1. Added: intrusive containers. Many lock-free containers in libcds have the intrusive
280        counterparts. The library is fully refactored to support intrusive containers.
281        Class hierarchy is changed: almost all non-intrusive container classes are based 
282        on their intrusive versions.
283        Two new namespace is added:
284         cds::intrusive - for intrusive containers
285         cds::container - for non-intrusive containers
286        Namespaces by container type (cds::queue, cds::map and so on) have been removed.
287     2. Added: New option-based approach is used for class declaration instead
288        old traits-based one. This approach allows to declare template arguments
289        in position-independent manner that is very useful for complex template declarations.
290        Option-based declarations use C++0x variadic templates if compiler supports it (GCC),
291        otherwise (MS VC) an emulation is used.
292     3. Changed: garbage collectors interface is generalized. cds::gc::GC (where GC is
293        one of HP, HRC, PTB) classes has been added.
294     4. Removed: tagged pointer GC. This GC
295        - unsafe for complex data structure
296        - x86-specific since it requires double-width CAS primitive
297        - memory-consuming since it requires separate free-list for each type stored in the containers
298     5. Default threading model is changed (see doc for cds::threading namespace):
299        - for Windows and MSVC++, CDS_THREADING_WIN_TLS is the default now
300        - for *nix and GCC, CDS_THREADING_PTHREAD is the default now
301     6. Added GCC 4.6 support (constexpr)
302     7. Added Microsoft Visual Studio 2010 (vc10) solution
303
304 0.8.0  28.03.2011 (beta)
305     1. Added: cds::Initialize and cds::Terminate functions that initializes and frees library's
306        internal structures.
307     2. Added: cds::memory::michael::Heap - Michael's lock-free allocator
308     3. Added: Exponential back-off strategy for spinning
309     4. Added: cds::queue::vyukov_mpmc_bounded - bounded queue
310        developed by Dmitry Vyukov (http://www.1024cores.net)
311     5. Added: support for FreeBSD amd64, x86
312
313 0.7.2  27.02.2011 (beta)
314     1. [Bug 3157201] Added implementation of threading manager based on Windows TLS API, see
315        cds::threading::wintls::Manager. Added CDS_THREADING_WIN_TLS macro. See docs for
316        cds::threading namespace for details.
317     2. Fixed bug in cds::threading::pthread::Manager: ptb_gc has not been initialized properly.
318     3. New function
319             template <typename T, typename FUNC>
320             bool erase( const key_type& key, T& dest, FUNC func ) ;
321        has been added to all map classes.
322     4. New function
323             template <typename T, typename FUNC>
324             bool insert( const key_type& key, T& val, FUNC func ) ;
325        has been added to all map classes.
326     5. Added new argument "bNew" to functor "func" of map's "ensure" member function:
327             void func( VALUE& itemValue, const VALUE& val, bool bNew ) ;
328         bNew = true if new item has been added
329         bNew = false if key is found
330     6. Fixed bug in cds::map::SplitOrderedList: LSB of dummy node's hash should be zero
331     7. Changed: thread liveliness checking on *nix has been changed to pthread_kill(id, 0).
332     8. Fixed: in map template member functions the functor may be passed by value
333        or by reference; use boost::ref( yourFunctor ) to pass your functor by reference
334     9. Fixed: cds::gc::tagged GC and all classes based on this GC has been rewritten
335        to solve stability problems.
336
337 0.7.1  30.12.2010 (beta)
338     1. [Bug 3130852] cds::queue::TZCyclicQueue::empty() has been corrected
339     2. [Bug 3128161] It seems, GCC 4.4 has a bug in __thread on x86 and x86_64. New "threading model"
340        CDS_THREADING_AUTODETECT has been added. See docs of cds::threading namespace for details
341     3. Fixed errors in the "Pass-the-Buck" garbage collector (namespace cds::gc::ptb)
342     4. [Bug 3128148] The code is aligned with the C++ standard (minor violations has been removed)
343     5. [Bug 3141654] missing break statement for atomic store - fixed
344     6. Added in-place scan strategy to cds::gc::hzp::GarbageCollector that does not allocate any memory.
345     7. Fixed bugs in HRC and tagged GC
346
347 0.7.0 05.12.2010 (beta)
348     1. Preliminary support for "Pass The Buck" memory manager is added. See cds::gc::ptb namespace.
349     2. Many part of library is rewritten to generalize the usage of various GCs
350     3. The new class cds::details::aligned_allocator has been added for allocating aligned memory
351        blocks. It is useful for Tagged Pointer memory reclamation schema (cds::gc::tagged_gc).
352     4. [Break change] New argument has been added to the member functions "ensure" and "find"
353        for ordered list and map classes
354     5. New member function "emplace" has been added to ordered list and map classes. This member function
355        allows change the value (or a part of it) of list/map item.
356     6. The internal structure of class cds::map::MichaelHashMap is completely refactored to support
357        cds::gc::no_gc correctly
358     7. The classes RecursiveSpinT, RecursiveSpin32, RecursiveSpin64, and RecursiveSpin from cds::lock
359        namespace have been renamed to ReentrantSpinT, ReentrantSpin32, ReentrantSpin64, and ReentrantSpin
360        respectively
361     8. Compiler support: GCC version below 4.3.0 is not supported
362     9. Fixed memory leak in cds::map::SplitOrderedList
363    10. Added compiler barrier to spin-lock release primitive for x86 and amd64
364    11. Makefile script is changed to resolve the problem when an user calls 'make clean' directly.
365        Thanks to Tamas Lengyel to point me to this bug.
366    12. The file dictionary.txt is excluded from distributive. This file is used for testing purposes only.
367        You may create dictionary.txt in this way:
368         cd ./tests/data
369         perl -X split.pl
370
371 0.6.0 26.03.2010 (beta)
372     1. The library is rewritten using atomic primitives with explicit memory ordering (based on C++
373        memory model proposal). The implementation of atomic primitives for supported architectures
374        is developed from scratch.
375     2. Total refactoring
376
377 0.5.0 31.12.2009  (beta)
378     First release