-//$$CDS-header$$
+/*
+ This file is a part of libcds - Concurrent Data Structures library
+
+ (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
+
+ Source code repo: http://github.com/khizmax/libcds/
+ Download: http://sourceforge.net/projects/libcds/files/
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
#ifndef CDSLIB_DEFS_H
#define CDSLIB_DEFS_H
The main namespace for the library is \ref cds.
To see the full list of container's class go to <a href="modules.html">modules</a> tab.
-
+
Supported processor architectures and operating systems (OS) are:
- x86 [32bit] Linux, Windows, FreeBSD, MinGW
- amd64 (x86-64) [64bit] Linux, Windows, FreeBSD, MinGW
Supported compilers:
- GCC 4.8+
- - Clang 3.3+
+ - Clang 3.3+
- MS Visual C++ 2013 Update 4 and above
- Intel C++ Compiler 15
schema used. However, any implementation supports common interface for the type of data structure.
To use any lock-free data structure, the following are needed:
- - atomic operation library conforming with C++11 memory model.
- The <b>libcds</b> can be built with \p std::atomic, \p boost::atomic or its own
+ - atomic operation library conforming with C++11 memory model.
+ The <b>libcds</b> can be built with \p std::atomic, \p boost::atomic or its own
@ref cds_cxx11_atomic "atomic implementation"
- - safe memory reclamation (SMR) or garbage collecting (GC) algorithm.
-
+ - safe memory reclamation (SMR) or garbage collecting (GC) algorithm.
+
SMR is the main part of lock-free data structs. The SMR solves the problem of safe
memory reclamation that is one of the main problem for lock-free programming.
The library contains the implementations of several light-weight \ref cds_garbage_collector "memory reclamation schemes":
int plugin_entry_point()
{
// Attach the thread if it is not attached yet
- if ( !cds::threading::Manager::isThreadAttached() )
+ if ( !cds::threading::Manager::isThreadAttached())
cds::threading::Manager::attachThread();
// Do some work with HP-related containers
}
\endcode
-
+
\par How to build
The <b>cds</b> is mostly header-only library. Only small part of library related to GC core functionality
- should be compiled.
-
- The test projects depends on the following static library from \p boost:
- - \p boost.thread
- - \p boost.date_time
+ should be compiled.
+
+ External dependenies: the tests depends on:
+ - \p boost.thread (thread-loal storage support), boost.system
+ - \p google-test
\par Windows build
- <a href="http://www.boost.org/">boost library</a> 1.51 and above. You should create environment variable
\p BOOST_PATH containing full path to \p boost root directory (for example, <tt>C:\\libs\\boost_1_57_0</tt>).
- Open solution file <tt>cds\projects\vcX\cds.sln</tt> where \p vcX is the version of
- Microsoft Visual C++ you use: vc12 for MS VC 2013 Update 4, vc14 for MS VC 2015. The solution
- contains \p cds project and a lot of test projects. Just build the library using solution.
+ Open solution file <tt>cds\projects\vc14\cds.sln</tt> with Microsoft VisualStudio 2015.
+ The solution contains \p cds project and a lot of test projects. Just build the library using solution.
<b>Warning</b>: the solution depends on \p BOOST_PATH environment variable that specifies full path
to \p boost library root directory. The test projects search \p boost libraries in:
- for 32bit: <tt>\$(BOOST_PATH)/stage/lib</tt>, <tt>\$(BOOST_PATH)/stage32/lib</tt>, and <tt>\$(BOOST_PATH)/bin</tt>.
- for 64bit: <tt>\$(BOOST_PATH)/stage64/lib</tt> and <tt>\$(BOOST_PATH)/bin</tt>.
+
+ All tests are based on googletest framework. The following environment variables specify
+ where to find gtest include and library directories:
+ - \p GTEST_ROOT - gtest root directory. <tt>\$(GTEST_ROOT)/include</tt> specifies full path to
+ gtest include files;
+ - \p GTEST_LIB64 - the path to 64bit gtest library dir;
+ - \p GTEST_LIB32 - the path to 32bit gtest library dir.
\par *NIX build
For Unix-like systems GCC and Clang compilers are supported.
- Use GCC 4.8+ compiler or Clang 3.3+ to build <b>cds</b> library. The distributive contains
- makefile and <tt>build.sh</tt> script in <tt>build</tt> directory.
- The <tt>build/sample</tt> directory contains sample scripts for different operating systems and
- processor architectures.
- The <tt>build.sh</tt> script supports the following options:
- - <tt>-c toolset</tt> - Toolset name, possible values: <tt>gcc</tt> (default), <tt>clang</tt>, <tt>icc</tt>
- - <tt>-x compiler</tt> - C++ compiler name (e.g. g++, g++-4.5 and so on)
- - <tt>-p arch</tt> - processor architecture; possible values for arch are: x86, amd64 (x86_64), sparc, ia64, ppc64
- - <tt>-o OStype</tt> - OS family; possible values for OStype are: linux, sunos (solaris), hpux, mingw
- - <tt>-D define</tt> additional defines
- - <tt>-b bits</tt> - bits to build, accepts 64, 32
- - <tt>-l "options"</tt> - extra linker options (in quotes)
- - <tt>-z "options"</tt> - extra compiler options (in quotes)
- - <tt>--with-boost path</tt> - path to boost include
- - <tt>--debug-cxx-options "options"</tt> - extra compiler options for debug target
- - <tt>--debug-ld-options "options"</tt> - extra linker options for debug target
- - <tt>--release-cxx-options "options"</tt> - extra compiler options for release target
- - <tt>--release-ld-options "optons"</tt> - extra linker options for release target
- - <tt>--clean</tt> - clean all before building
- - <tt>--debug-test</tt> - make unit test in debug mode; by defalt release unit test generated
- - <tt>--amd64-use-128bit</tt> - compile with supporting 128bit (16byte) CAS on amd64 (for am64 only)
+ Use GCC 4.8+ compiler or Clang 3.3+ to build <b>cds</b> library with CMake.
+ See accompanying file <tt>/build/cmake/readme.md</tt> for more info.
@note Important for GCC compiler: all your projects that use \p libcds must be compiled with <b>-fno-strict-aliasing</b>
compiler flag.
#if defined(_MSC_VER)
# if defined(__ICL) || defined(__INTEL_COMPILER)
# define CDS_COMPILER CDS_COMPILER_INTEL
+# elif defined(__clang__)
+# define CDS_COMPILER CDS_COMPILER_CLANG
# else
# define CDS_COMPILER CDS_COMPILER_MSVC
# endif
projects / libcds.git / blobdiff