readme.md

   1 CDS C++ library\r
   2 ===============\r
   3 \r
   4 The Concurrent Data Structures (CDS) library is a collection of concurrent containers\r
   5 that don't require external (manual) synchronization for shared access, and safe memory reclamation (SMR) \r
   6 algorithms like [Hazard Pointer](http://en.wikipedia.org/wiki/Hazard_pointer) \r
   7 and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update). \r
   8 CDS is mostly header-only template library. Only SMR core implementation is segregated to .so/.dll file.\r
   9 \r
  10 The library contains the implementations of the following containers:\r
  11   - [lock-free](http://en.wikipedia.org/wiki/Non-blocking_algorithm) stack with optional elimination support\r
  12   - several algo for lock-free queue, including classic Michael & Scott algorithm and it's derivatives,\r
  13     flat combining queue, segmented queue.\r
  14   - several implementation of unordered set/map - lock-free and fine-grained lock-based\r
  15   - lock-free [skip-list](http://en.wikipedia.org/wiki/Skip_list)\r
  16   \r
  17 Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to \r
  18 *cds::intrusive* and *cds::container* namespace respectively.\r
  19 \r
  20 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
  21 and MS VC++ 12 (2013) Update 4.\r
  22 \r
  23 Download the latest release from http://sourceforge.net/projects/libcds/files/\r
  24 \r
  25 References\r
  26 ----------\r
  27 *Stack*\r
  28   - TreiberStack: [1986] R. K. Treiber. Systems programming: Coping with parallelism. Technical Report RJ 5118, IBM Almaden Research Center, April 1986.\r
  29   - Elimination back-off implementation is based on idea from [2004] Danny Hendler, Nir Shavit, Lena Yerushalmi "A Scalable Lock-free Stack Algorithm"\r
  30         \r
  31 *Queue*\r
  32   - BasketQueue: [2007] Moshe Hoffman, Ori Shalev, Nir Shavit "The Baskets Queue"\r
  33   - MSQueue:\r
  34     * [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
  35     * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-free objects using atomic reads and writes"\r
  36     * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
  37   - RWQueue: [1998] Maged Michael, Michael Scott "Simple, fast, and practical non-blocking and blocking concurrent queue algorithms"\r
  38   - MoirQueue: [2000] Simon Doherty, Lindsay Groves, Victor Luchangco, Mark Moir "Formal Verification of a practical lock-free queue algorithm"\r
  39   - OptimisticQueue: [2008] Edya Ladan-Mozes, Nir Shavit "An Optimistic Approach to Lock-Free FIFO Queues"\r
  40   - SegmentedQueue: [2010] Afek, Korland, Yanovsky "Quasi-Linearizability: relaxed consistency for improved concurrency"\r
  41   - TsigasCycleQueue: [2000] Philippas Tsigas, Yi Zhang "A Simple, Fast and Scalable Non-Blocking Concurrent FIFO Queue for Shared Memory Multiprocessor Systems"\r
  42   - VyukovMPMCCycleQueue Dmitry Vyukov (see http://www.1024cores.net)\r
  43 \r
  44 *Deque*\r
  45   - MichaelDeque: [2003] Maged Michael "CAS-based Lock-free Algorithm for Shared Deque"\r
  46 \r
  47 *Map, set*\r
  48   - MichaelHashMap: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
  49   - SplitOrderedList: [2003] Ori Shalev, Nir Shavit "Split-Ordered Lists - Lock-free Resizable Hash Tables"\r
  50   - StripedMap, StripedSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
  51   - CuckooMap, CuckooSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
  52   - SkipListMap, SkipListSet: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
  53         \r
  54 *Ordered single-linked list*\r
  55   - 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
  56   - MichaelList: [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"\r
  57 \r
  58 *Priority queue*\r
  59   - MSPriorityQueue: [1996] G.Hunt, M.Michael, S. Parthasarathy, M.Scott "An efficient algorithm for concurrent priority queue heaps"\r
  60 \r
  61 *Tree*\r
  62   - EllenBinTree: [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"\r
  63 \r
  64 *SMR*\r
  65   - Hazard Pointers\r
  66     * [2002] Maged M.Michael "Safe memory reclamation for dynamic lock-freeobjects using atomic reads and writes"\r
  67     * [2003] Maged M.Michael "Hazard Pointers: Safe memory reclamation for lock-free objects"\r
  68     * [2004] Andrei Alexandrescy, Maged Michael "Lock-free Data Structures with Hazard Pointers"\r
  69   - User-space RCU\r
  70     * [2009] M.Desnoyers "Low-Impact Operating System Tracing" PhD Thesis,\r
  71              Chapter 6 "User-Level Implementations of Read-Copy Update"\r
  72     * [2011] M.Desnoyers, P.McKenney, A.Stern, M.Dagenias, J.Walpole "User-Level\r
  73              Implementations of Read-Copy Update"\r
  74 \r
  75 *Memory allocation*\r
  76   - [2004] M.Michael "Scalable Lock-free Dynamic Memory Allocation"\r
  77 \r
  78 *Flat Combining* technique\r
  79   - [2010] Hendler, Incze, Shavit and Tzafrir "Flat Combining and the Synchronization-Parallelism Tradeoff"\r