X-Git-Url: http://plrg.eecs.uci.edu/git/?p=libcds.git;a=blobdiff_plain;f=readme.md;h=fa9237cfc4bd42d490434dae09deed1e9d739c4f;hp=85935d0ddb9450bb77300b0dcee909d1c88afc2e;hb=HEAD;hpb=479a1342e549c78cf66a669c3ff115e7b6394fb5

diff --git a/readme.md b/readme.md
index 85935d0d..fa9237cf 100644
--- a/readme.md
+++ b/readme.md
@@ -1,10 +1,9 @@
 CDS C++ library
 ===============
 [![GitHub version](https://badge.fury.io/gh/khizmax%2Flibcds.svg)](http://badge.fury.io/gh/khizmax%2Flibcds)
-<!---
-The build time for lib and hdr-test is exceed the limit of 50 minutes
+[![License](https://img.shields.io/:license-bsd-blue.svg?style=round-square)](https://github.com/khizmax/libcds/blob/master/LICENSE)
 [![Build Status](https://travis-ci.org/khizmax/libcds.svg?branch=dev)](https://travis-ci.org/khizmax/libcds)
--->
+
 <!---
 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
 [![Coverity Scan Build Status](https://scan.coverity.com/projects/4445/badge.svg)](https://scan.coverity.com/projects/4445)
@@ -13,7 +12,8 @@ The coverity dataset is about 4G of size and about 1G in compressed state so it
 The Concurrent Data Structures (CDS) library is a collection of concurrent containers
 that don't require external (manual) synchronization for shared access, and safe memory reclamation (SMR) 
 algorithms like [Hazard Pointer](http://en.wikipedia.org/wiki/Hazard_pointer) 
-and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update). 
+and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update) that is used as an epoch-based SMR.
+
 CDS is mostly header-only template library. Only SMR core implementation is segregated to .so/.dll file.
 
 The library contains the implementations of the following containers:
@@ -21,19 +21,38 @@ The library contains the implementations of the following containers:
   - several algo for lock-free queue, including classic Michael & Scott algorithm and its derivatives,
     the flat combining queue, the segmented queue.
   - several implementation of unordered set/map - lock-free and fine-grained lock-based
-  - [flat-combining] (http://mcg.cs.tau.ac.il/projects/projects/flat-combining) technique
+  - [flat-combining](http://mcg.cs.tau.ac.il/projects/projects/flat-combining) technique
   - lock-free [skip-list](http://en.wikipedia.org/wiki/Skip_list)
+  - lock-free FeldmanHashMap/Set [Multi-Level Array Hash](http://samos-conference.com/Resources_Samos_Websites/Proceedings_Repository_SAMOS/2013/Files/2013-IC-20.pdf)
+    with thread-safe bidirectional iterator support
+  - Bronson's et al algorithm for fine-grained lock-based AVL tree
   
 Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to 
-*cds::intrusive* and *cds::container* namespace respectively.
+*cds::intrusive* and *cds::container* namespace respectively. 
 
-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+, 
-and MS VC++ 12 (2013) Update 4.
+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+, 
+and MS VC++ 12 (2013) Update 4 and above
 
 Download the latest release from http://sourceforge.net/projects/libcds/files/
 
 See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html
 
+Evolution of libcds (Gource visualization by Landon Wilkins): https://www.youtube.com/watch?v=FHaJvVdmJ0w
+
+**How to build**
+   - *nix: [use CMake](build/cmake/readme.md)
+   - Windows: use MS Visual C++ 2015 project
+
+Some parts of libcds may depend on DCAS (double-width compare-and-swap) atomic primitive if
+the target architecture supports it. For x86, cmake build script enables `-mcx16` compiler flag that
+switches DCAS support on. You may manually disable DCAS support with the following command line flags
+in GCC/clang (for MS VC++ compiler DCAS is not supported):
+  - `-DCDS_DISABLE_128BIT_ATOMIC` - for 64bit build
+  - `-DCDS_DISABLE_64BIT_ATOMIC` - for 32bit build
+
+**All your projects AND libcds MUST be compiled with the same flags - either with DCAS support or without it.**
+   
+   
 **Pull request requirements**
 - Pull-request to *master* branch will be unconditionally rejected
 - *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master*
@@ -68,8 +87,6 @@ References
   - *SegmentedQueue*: [2010] Afek, Korland, Yanovsky "Quasi-Linearizability: relaxed consistency for improved concurrency"
         [pdf](http://mcg.cs.tau.ac.il/papers/opodis2010-quasi.pdf)
   - *FCQueue* - flat-combining wrapper for *std::queue*
-  - *TsigasCycleQueue*: [2000] Philippas Tsigas, Yi Zhang "A Simple, Fast and Scalable Non-Blocking Concurrent FIFO Queue for Shared Memory Multiprocessor Systems"
-        [pdf](http://www.cse.chalmers.se/~tsigas/papers/latest-spaa01.pdf)
   - *VyukovMPMCCycleQueue* Dmitry Vyukov (see http://www.1024cores.net)
 
 *Deque*
@@ -83,6 +100,9 @@ References
   - *StripedMap*, *StripedSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"
   - *CuckooMap*, *CuckooSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"
   - *SkipListMap*, *SkipListSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"
+  - *FeldmanHashMap*, *FeldmanHashSet*: [2013] Steven Feldman, Pierre LaBorde, Damian Dechev "Concurrent Multi-level Arrays:
+        Wait-free Extensible Hash Maps". Supports **thread-safe bidirectional iterators**
+        [pdf](http://samos-conference.com/Resources_Samos_Websites/Proceedings_Repository_SAMOS/2013/Files/2013-IC-20.pdf)
         
 *Ordered single-linked list*
   - *LazyList*: [2005] Steve Heller, Maurice Herlihy, Victor Luchangco, Mark Moir, William N. Scherer III, and Nir Shavit "A Lazy Concurrent List-Based Set Algorithm"
@@ -117,10 +137,6 @@ References
              Implementations of Read-Copy Update"
              [pdf](http://www.dorsal.polymtl.ca/sites/www.dorsal.polymtl.ca/files/publications/desnoyers-ieee-urcu-submitted.pdf)
 
-*Memory allocation*
-  - [2004] M.Michael "Scalable Lock-free Dynamic Memory Allocation"
-            [pdf](http://www.research.ibm.com/people/m/michael/pldi-2004.pdf)
-
 *Flat Combining* technique
   - [2010] Hendler, Incze, Shavit and Tzafrir "Flat Combining and the Synchronization-Parallelism Tradeoff"
             [pdf](http://www.cs.bgu.ac.il/~hendlerd/papers/flat-combining.pdf)