X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=readme.md;h=57a211a151edd30d5cb78d464f6530f92d88f6f2;hb=83904aeb6442d3f60c99dd627ac704feeb1b5a82;hp=19c5c484a454409d7a29fb79bf2846451e094bf3;hpb=5a8fe6a7fac97dfbd471e4fee0f07db8c50065f2;p=libcds.git diff --git a/readme.md b/readme.md index 19c5c484..57a211a1 100644 --- a/readme.md +++ b/readme.md @@ -24,7 +24,7 @@ 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 @@ -33,17 +33,29 @@ The library contains the implementations of the following containers: Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to *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* @@ -78,8 +90,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* @@ -130,10 +140,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)