cds/user_setup/cache_line.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_USER_SETUP_CACHE_LINE_H
  32 #define CDSLIB_USER_SETUP_CACHE_LINE_H
  33
  34 /** \file
  35     \brief Cache-line size definition
  36
  37     This file defines cache-line size constant. The constant is used many \p libcds algorithm
  38     to solve false-sharing problem.
  39
  40     The value of cache-line size must be power of two.
  41     You may define your cache-line size by defining macro -DCDS_CACHE_LINE_SIZE=xx
  42     (where \p xx is 2**N: 32, 64, 128,...) at compile-time or you may define your constant
  43     value just editing \p cds/user_setup/cache_line.h file.
  44
  45     The default value is 64.
  46 */
  47
  48 //@cond
  49 namespace cds {
  50 #ifndef CDS_CACHE_LINE_SIZE
  51     static const size_t c_nCacheLineSize = 64;
  52 #else
  53     static const size_t c_nCacheLineSize = CDS_CACHE_LINE_SIZE;
  54 #endif
  55 }   // namespace cds
  56 //@endcond
  57
  58 #endif // #ifndef CDSLIB_USER_SETUP_CACHE_LINE_H