readme.md

   1 CDS C++ library\r
   2 ===============\r
   3 [![GitHub version](https://badge.fury.io/gh/khizmax%2Flibcds.svg)](http://badge.fury.io/gh/khizmax%2Flibcds)\r
   4 <!---\r
   5 The build time for lib and hdr-test is exceed the limit of 50 minutes\r
   6 [![Build Status](https://travis-ci.org/khizmax/libcds.svg?branch=dev)](https://travis-ci.org/khizmax/libcds)\r
   7 -->\r
   8 <!---\r
   9 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
  10 [![Coverity Scan Build Status](https://scan.coverity.com/projects/4445/badge.svg)](https://scan.coverity.com/projects/4445)\r
  11 -->\r
  12 \r
  13 The Concurrent Data Structures (CDS) library is a collection of concurrent containers\r
  14 that don't require external (manual) synchronization for shared access, and safe memory reclamation (SMR) \r
  15 algorithms like [Hazard Pointer](http://en.wikipedia.org/wiki/Hazard_pointer) \r
  16 and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update). \r
  17 CDS is mostly header-only template library. Only SMR core implementation is segregated to .so/.dll file.\r
  18 \r
  19 The library contains the implementations of the following containers:\r
  20   - [lock-free](http://en.wikipedia.org/wiki/Non-blocking_algorithm) stack with optional elimination support\r
  21   - several algo for lock-free queue, including classic Michael & Scott algorithm and its derivatives,\r
  22     the flat combining queue, the segmented queue.\r
  23   - several implementation of unordered set/map - lock-free and fine-grained lock-based\r
  24   - [flat-combining] (http://mcg.cs.tau.ac.il/projects/projects/flat-combining) technique\r
  25   - lock-free [skip-list](http://en.wikipedia.org/wiki/Skip_list)\r
  26   \r
  27 Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to \r
  28 *cds::intrusive* and *cds::container* namespace respectively.\r
  29 \r
  30 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
  31 and MS VC++ 12 (2013) Update 4.\r
  32 \r
  33 Download the latest release from http://sourceforge.net/projects/libcds/files/\r
  34 \r
  35 See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html\r
  36 \r
  37 **Pull request requirements**\r
  38 - Pull-request to *master* branch will be unconditionally rejected\r
  39 - *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master*\r
  40 - *dev* branch is intended for main developing. Usually, it contains unstable code\r
  41 \r
  42 [![Project stats](https://www.openhub.net/p/khizmax-libcds/widgets/project_thin_badge.gif)](https://www.openhub.net/p/khizmax-libcds)\r
  43 \r
  44 References\r
  45 ----------\r
  46 *Stack*\r
  47   - *TreiberStack*: [1986] R. K. Treiber. Systems programming: Coping with parallelism. Technical Report RJ 5118, IBM Almaden Research Center, April 1986.\r
  48   - Elimination back-off implementation is based on idea from [2004] Danny Hendler, Nir Shavit, Lena Yerushalmi "A Scalable Lock-free Stack Algorithm"\r
  49         [pdf](http://people.csail.mit.edu/shanir/publications/Lock_Free.pdf)\r
  50   - *FCStack* - flat-combining wrapper for *std::stack*\r
  51         \r
  52 *Queue*\r
  53   - *BasketQueue*: [2007] Moshe Hoffman, Ori Shalev, Nir Shavit "The Baskets Queue"\r
  54         [pdf](http://people.csail.mit.edu/shanir/publications/Baskets%20Queue.pdf)\r
  55   - *MSQueue*:\r
  56     * [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
  57         [pdf](http://www.cs.rochester.edu/~scott/papers/1996_PODC_queues.pdf)\r
  58     * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-free objects using atomic reads and writes"\r
  59         [pdf](http://www.research.ibm.com/people/m/michael/podc-2002.pdf)\r
  60     * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
  61         [pdf](http://www.research.ibm.com/people/m/michael/ieeetpds-2004.pdf)\r
  62   - *RWQueue*: [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
  63         [pdf](http://www.cs.rochester.edu/~scott/papers/1996_PODC_queues.pdf)\r
  64   - *MoirQueue*: [2000] Simon Doherty, Lindsay Groves, Victor Luchangco, Mark Moir "Formal Verification of a practical lock-free queue algorithm"\r
  65         [pdf](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.87.9954&rep=rep1&type=pdf)\r
  66   - *OptimisticQueue*: [2008] Edya Ladan-Mozes, Nir Shavit "An Optimistic Approach to Lock-Free FIFO Queues"\r
  67         [pdf](https://people.csail.mit.edu/edya/publications/OptimisticFIFOQueue-journal.pdf)\r
  68   - *SegmentedQueue*: [2010] Afek, Korland, Yanovsky "Quasi-Linearizability: relaxed consistency for improved concurrency"\r
  69         [pdf](http://mcg.cs.tau.ac.il/papers/opodis2010-quasi.pdf)\r
  70   - *FCQueue* - flat-combining wrapper for *std::queue*\r
  71   - *TsigasCycleQueue*: [2000] Philippas Tsigas, Yi Zhang "A Simple, Fast and Scalable Non-Blocking Concurrent FIFO Queue for Shared Memory Multiprocessor Systems"\r
  72         [pdf](http://www.cse.chalmers.se/~tsigas/papers/latest-spaa01.pdf)\r
  73   - *VyukovMPMCCycleQueue* Dmitry Vyukov (see http://www.1024cores.net)\r
  74 \r
  75 *Deque*\r
  76   - flat-combining deque based on *stl::deque*\r
  77 \r
  78 *Map, set*\r
  79   - *MichaelHashMap*: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
  80         [pdf](http://www.research.ibm.com/people/m/michael/spaa-2002.pdf)\r
  81   - *SplitOrderedList*: [2003] Ori Shalev, Nir Shavit "Split-Ordered Lists - Lock-free Resizable Hash Tables"\r
  82         [pdf](http://people.csail.mit.edu/shanir/publications/Split-Ordered_Lists.pdf)\r
  83   - *StripedMap*, *StripedSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
  84   - *CuckooMap*, *CuckooSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
  85   - *SkipListMap*, *SkipListSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
  86         \r
  87 *Ordered single-linked list*\r
  88   - *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
  89         [pdf](http://people.csail.mit.edu/shanir/publications/Lazy_Concurrent.pdf)\r
  90   - *MichaelList*: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
  91         [pdf](http://www.research.ibm.com/people/m/michael/spaa-2002.pdf)\r
  92 \r
  93 *Priority queue*\r
  94   - *MSPriorityQueue*: [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient algorithm for concurrent priority queue heaps"\r
  95         [pdf](http://web.cse.ohio-state.edu/dmrl/papers/heap96.pdf)\r
  96 \r
  97 *Tree*\r
  98   - *EllenBinTree*: [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"\r
  99         [pdf](http://www.cs.vu.nl/~tcs/cm/faith.pdf)\r
 100   - *BronsonAVLTreeMap* - lock-based fine-grained AVL-tree implementation: \r
 101         [2010] Nathan Bronson, Jared Casper, Hassan Chafi, Kunle Olukotun "A Practical Concurrent Binary Search Tree"\r
 102         [pdf](https://ppl.stanford.edu/papers/ppopp207-bronson.pdf)\r
 103 \r
 104 *SMR*\r
 105   - Hazard Pointers\r
 106     * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-free objects using atomic reads and writes" \r
 107              [pdf](http://www.research.ibm.com/people/m/michael/podc-2002.pdf)\r
 108     * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects" \r
 109              [pdf](http://www.research.ibm.com/people/m/michael/ieeetpds-2004.pdf)\r
 110     * [2004] Andrei Alexandrescy, Maged Michael "Lock-free Data Structures with Hazard Pointers" \r
 111              [pdf](http://www.researchgate.net/profile/Andrei_Alexandrescu/publication/252573326_Lock-Free_Data_Structures_with_Hazard_Pointers/links/0deec529e7804288fe000000.pdf)\r
 112   - User-space RCU\r
 113     * [2009] M.Desnoyers "Low-Impact Operating System Tracing" PhD Thesis,\r
 114              Chapter 6 "User-Level Implementations of Read-Copy Update"\r
 115              [pdf](http://www.lttng.org/files/thesis/desnoyers-dissertation-2009-12-v27.pdf)\r
 116     * [2011] M.Desnoyers, P.McKenney, A.Stern, M.Dagenias, J.Walpole "User-Level\r
 117              Implementations of Read-Copy Update"\r
 118              [pdf](http://www.dorsal.polymtl.ca/sites/www.dorsal.polymtl.ca/files/publications/desnoyers-ieee-urcu-submitted.pdf)\r
 119 \r
 120 *Memory allocation*\r
 121   - [2004] M.Michael "Scalable Lock-free Dynamic Memory Allocation"\r
 122             [pdf](http://www.research.ibm.com/people/m/michael/pldi-2004.pdf)\r
 123 \r
 124 *Flat Combining* technique\r
 125   - [2010] Hendler, Incze, Shavit and Tzafrir "Flat Combining and the Synchronization-Parallelism Tradeoff"\r
 126             [pdf](http://www.cs.bgu.ac.il/~hendlerd/papers/flat-combining.pdf)\r