CDS C++ library\r
===============\r
+[](http://badge.fury.io/gh/khizmax%2Flibcds)\r
+[](https://github.com/khizmax/libcds/blob/master/LICENSE)\r
+[](https://travis-ci.org/khizmax/libcds)\r
+\r
+<!---\r
+The coverity dataset is about 4G of size and about 1G in compressed state so it is a problem to upload it to the coverity server\r
+[](https://scan.coverity.com/projects/4445)\r
+-->\r
\r
The Concurrent Data Structures (CDS) library is a collection of concurrent containers\r
that don't require external (manual) synchronization for shared access, and safe memory reclamation (SMR) \r
algorithms like [Hazard Pointer](http://en.wikipedia.org/wiki/Hazard_pointer) \r
-and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update). \r
+and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update) that is used as an epoch-based SMR.\r
+\r
CDS is mostly header-only template library. Only SMR core implementation is segregated to .so/.dll file.\r
\r
The library contains the implementations of the following containers:\r
- [lock-free](http://en.wikipedia.org/wiki/Non-blocking_algorithm) stack with optional elimination support\r
- - several algo for lock-free queue, including classic Michael & Scott algorithm and it's derivatives,\r
- flat combining queue, segmented queue.\r
+ - several algo for lock-free queue, including classic Michael & Scott algorithm and its derivatives,\r
+ the flat combining queue, the segmented queue.\r
- several implementation of unordered set/map - lock-free and fine-grained lock-based\r
+ - [flat-combining](http://mcg.cs.tau.ac.il/projects/projects/flat-combining) technique\r
- lock-free [skip-list](http://en.wikipedia.org/wiki/Skip_list)\r
+ - lock-free FeldmanHashMap/Set [Multi-Level Array Hash](http://samos-conference.com/Resources_Samos_Websites/Proceedings_Repository_SAMOS/2013/Files/2013-IC-20.pdf)\r
+ with thread-safe bidirectional iterator support\r
+ - Bronson's et al algorithm for fine-grained lock-based AVL tree\r
\r
Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to \r
-*cds::intrusive* and *cds::container* namespace respectively.\r
+*cds::intrusive* and *cds::container* namespace respectively. \r
\r
-Version 2.x of the library is written on C++11 and can be compiled by GCC 4.8+, clang 3.3+, Intel C++ 15+, \r
-and MS VC++ 12 (2013) Update 4.\r
+Version 2.x of the library is written on C++11 and can be compiled by GCC 4.8+, clang 3.6+, Intel C++ 15+, \r
+and MS VC++ 12 (2013) Update 4 and above\r
\r
Download the latest release from http://sourceforge.net/projects/libcds/files/\r
\r
+See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html\r
+\r
+Evolution of libcds (Gource visualization by Landon Wilkins): https://www.youtube.com/watch?v=FHaJvVdmJ0w\r
+\r
+**How to build**\r
+ - *nix: [use CMake](build/cmake/readme.md)\r
+ - Windows: use MS Visual C++ 2015 project\r
+\r
+Some parts of libcds may depend on DCAS (double-width compare-and-swap) atomic primitive if\r
+the target architecture supports it. For x86, cmake build script enables `-mcx16` compiler flag that\r
+switches DCAS support on. You may manually disable DCAS support with the following command line flags\r
+in GCC/clang (for MS VC++ compiler DCAS is not supported):\r
+ - `-DCDS_DISABLE_128BIT_ATOMIC` - for 64bit build\r
+ - `-DCDS_DISABLE_64BIT_ATOMIC` - for 32bit build\r
+\r
+**All your projects AND libcds MUST be compiled with the same flags - either with DCAS support or without it.**\r
+ \r
+ \r
+**Pull request requirements**\r
+- Pull-request to *master* branch will be unconditionally rejected\r
+- *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master*\r
+- *dev* branch is intended for main developing. Usually, it contains unstable code\r
+\r
+[](https://www.openhub.net/p/khizmax-libcds)\r
+\r
References\r
----------\r
*Stack*\r
- - TreiberStack: [1986] R. K. Treiber. Systems programming: Coping with parallelism. Technical Report RJ 5118, IBM Almaden Research Center, April 1986.\r
+ - *TreiberStack*: [1986] R. K. Treiber. Systems programming: Coping with parallelism. Technical Report RJ 5118, IBM Almaden Research Center, April 1986.\r
- Elimination back-off implementation is based on idea from [2004] Danny Hendler, Nir Shavit, Lena Yerushalmi "A Scalable Lock-free Stack Algorithm"\r
+ [pdf](http://people.csail.mit.edu/shanir/publications/Lock_Free.pdf)\r
+ - *FCStack* - flat-combining wrapper for *std::stack*\r
\r
*Queue*\r
- - BasketQueue: [2007] Moshe Hoffman, Ori Shalev, Nir Shavit "The Baskets Queue"\r
- - MSQueue:\r
+ - *BasketQueue*: [2007] Moshe Hoffman, Ori Shalev, Nir Shavit "The Baskets Queue"\r
+ [pdf](http://people.csail.mit.edu/shanir/publications/Baskets%20Queue.pdf)\r
+ - *MSQueue*:\r
* [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
+ [pdf](http://www.cs.rochester.edu/~scott/papers/1996_PODC_queues.pdf)\r
* [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-free objects using atomic reads and writes"\r
+ [pdf](http://www.research.ibm.com/people/m/michael/podc-2002.pdf)\r
* [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
- - RWQueue: [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
- - MoirQueue: [2000] Simon Doherty, Lindsay Groves, Victor Luchangco, Mark Moir "Formal Verification of a practical lock-free queue algorithm"\r
- - OptimisticQueue: [2008] Edya Ladan-Mozes, Nir Shavit "An Optimistic Approach to Lock-Free FIFO Queues"\r
- - SegmentedQueue: [2010] Afek, Korland, Yanovsky "Quasi-Linearizability: relaxed consistency for improved concurrency"\r
- - TsigasCycleQueue: [2000] Philippas Tsigas, Yi Zhang "A Simple, Fast and Scalable Non-Blocking Concurrent FIFO Queue for Shared Memory Multiprocessor Systems"\r
- - VyukovMPMCCycleQueue Dmitry Vyukov (see http://www.1024cores.net)\r
+ [pdf](http://www.research.ibm.com/people/m/michael/ieeetpds-2004.pdf)\r
+ - *RWQueue*: [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
+ [pdf](http://www.cs.rochester.edu/~scott/papers/1996_PODC_queues.pdf)\r
+ - *MoirQueue*: [2000] Simon Doherty, Lindsay Groves, Victor Luchangco, Mark Moir "Formal Verification of a practical lock-free queue algorithm"\r
+ [pdf](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.87.9954&rep=rep1&type=pdf)\r
+ - *OptimisticQueue*: [2008] Edya Ladan-Mozes, Nir Shavit "An Optimistic Approach to Lock-Free FIFO Queues"\r
+ [pdf](https://people.csail.mit.edu/edya/publications/OptimisticFIFOQueue-journal.pdf)\r
+ - *SegmentedQueue*: [2010] Afek, Korland, Yanovsky "Quasi-Linearizability: relaxed consistency for improved concurrency"\r
+ [pdf](http://mcg.cs.tau.ac.il/papers/opodis2010-quasi.pdf)\r
+ - *FCQueue* - flat-combining wrapper for *std::queue*\r
+ - *VyukovMPMCCycleQueue* Dmitry Vyukov (see http://www.1024cores.net)\r
\r
*Deque*\r
- - MichaelDeque: [2003] Maged Michael "CAS-based Lock-free Algorithm for Shared Deque"\r
+ - flat-combining deque based on *stl::deque*\r
\r
*Map, set*\r
- - MichaelHashMap: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
- - SplitOrderedList: [2003] Ori Shalev, Nir Shavit "Split-Ordered Lists - Lock-free Resizable Hash Tables"\r
- - StripedMap, StripedSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
- - CuckooMap, CuckooSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
- - SkipListMap, SkipListSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+ - *MichaelHashMap*: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
+ [pdf](http://www.research.ibm.com/people/m/michael/spaa-2002.pdf)\r
+ - *SplitOrderedList*: [2003] Ori Shalev, Nir Shavit "Split-Ordered Lists - Lock-free Resizable Hash Tables"\r
+ [pdf](http://people.csail.mit.edu/shanir/publications/Split-Ordered_Lists.pdf)\r
+ - *StripedMap*, *StripedSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+ - *CuckooMap*, *CuckooSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+ - *SkipListMap*, *SkipListSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+ - *FeldmanHashMap*, *FeldmanHashSet*: [2013] Steven Feldman, Pierre LaBorde, Damian Dechev "Concurrent Multi-level Arrays:\r
+ Wait-free Extensible Hash Maps". Supports **thread-safe bidirectional iterators**\r
+ [pdf](http://samos-conference.com/Resources_Samos_Websites/Proceedings_Repository_SAMOS/2013/Files/2013-IC-20.pdf)\r
\r
*Ordered single-linked list*\r
- - LazyList: [2005] Steve Heller, Maurice Herlihy, Victor Luchangco, Mark Moir, William N. Scherer III, and Nir Shavit "A Lazy Concurrent List-Based Set Algorithm"\r
- - MichaelList: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
+ - *LazyList*: [2005] Steve Heller, Maurice Herlihy, Victor Luchangco, Mark Moir, William N. Scherer III, and Nir Shavit "A Lazy Concurrent List-Based Set Algorithm"\r
+ [pdf](http://people.csail.mit.edu/shanir/publications/Lazy_Concurrent.pdf)\r
+ - *MichaelList*: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
+ [pdf](http://www.research.ibm.com/people/m/michael/spaa-2002.pdf)\r
\r
*Priority queue*\r
- - MSPriorityQueue: [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient algorithm for concurrent priority queue heaps"\r
+ - *MSPriorityQueue*: [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient algorithm for concurrent priority queue heaps"\r
+ [pdf](http://web.cse.ohio-state.edu/dmrl/papers/heap96.pdf)\r
\r
*Tree*\r
- - EllenBinTree: [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"\r
+ - *EllenBinTree*: [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"\r
+ [pdf](http://www.cs.vu.nl/~tcs/cm/faith.pdf)\r
+ - *BronsonAVLTreeMap* - lock-based fine-grained AVL-tree implementation: \r
+ [2010] Nathan Bronson, Jared Casper, Hassan Chafi, Kunle Olukotun "A Practical Concurrent Binary Search Tree"\r
+ [pdf](https://ppl.stanford.edu/papers/ppopp207-bronson.pdf)\r
\r
*SMR*\r
- Hazard Pointers\r
- * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-freeobjects using atomic reads and writes"\r
- * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
- * [2004] Andrei Alexandrescy, Maged Michael "Lock-free Data Structures with Hazard Pointers"\r
+ * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-free objects using atomic reads and writes" \r
+ [pdf](http://www.research.ibm.com/people/m/michael/podc-2002.pdf)\r
+ * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects" \r
+ [pdf](http://www.research.ibm.com/people/m/michael/ieeetpds-2004.pdf)\r
+ * [2004] Andrei Alexandrescy, Maged Michael "Lock-free Data Structures with Hazard Pointers" \r
+ [pdf](http://www.researchgate.net/profile/Andrei_Alexandrescu/publication/252573326_Lock-Free_Data_Structures_with_Hazard_Pointers/links/0deec529e7804288fe000000.pdf)\r
- User-space RCU\r
* [2009] M.Desnoyers "Low-Impact Operating System Tracing" PhD Thesis,\r
Chapter 6 "User-Level Implementations of Read-Copy Update"\r
+ [pdf](http://www.lttng.org/files/thesis/desnoyers-dissertation-2009-12-v27.pdf)\r
* [2011] M.Desnoyers, P.McKenney, A.Stern, M.Dagenias, J.Walpole "User-Level\r
Implementations of Read-Copy Update"\r
-\r
-*Memory allocation*\r
- - [2004] M.Michael "Scalable Lock-free Dynamic Memory Allocation"\r
+ [pdf](http://www.dorsal.polymtl.ca/sites/www.dorsal.polymtl.ca/files/publications/desnoyers-ieee-urcu-submitted.pdf)\r
\r
*Flat Combining* technique\r
- [2010] Hendler, Incze, Shavit and Tzafrir "Flat Combining and the Synchronization-Parallelism Tradeoff"\r
+ [pdf](http://www.cs.bgu.ac.il/~hendlerd/papers/flat-combining.pdf)\r
projects / libcds.git / blobdiff