cds/lock/spinlock.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-2017
   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_LOCK_SPINLOCK_H
  32 #define CDSLIB_LOCK_SPINLOCK_H
  33
  34 #if CDS_COMPILER == CDS_COMPILER_MSVC
  35 #   pragma message("cds/lock/spinlock.h is deprecated, use cds/sync/spinlock.h instead")
  36 #else
  37 #   warning "cds/lock/spinlock.h is deprecated, use cds/sync/spinlock.h instead"
  38 #endif
  39
  40 #include <cds/sync/spinlock.h>
  41
  42 //@cond
  43 namespace cds {
  44     /// Synchronization primitives (deprecated namespace, use \p cds::sync namespace instead)
  45     namespace lock {
  46
  47         /// Alias for \p cds::sync::spin_lock for backward compatibility
  48         template <typename Backoff>
  49         using Spinlock = cds::sync::spin_lock< Backoff >;
  50
  51         /// Spin-lock implementation default for the current platform
  52         typedef cds::sync::spin_lock< backoff::LockDefault> Spin;
  53
  54         /// Alias for \p cds::sync::reentrant_spin_lock for backward compatibility
  55         template <typename Integral, class Backoff>
  56         using ReentrantSpinT = cds::sync::reentrant_spin_lock< Integral, Backoff >;
  57
  58         /// Recursive 32bit spin-lock
  59         typedef cds::sync::reentrant_spin32 ReentrantSpin32;
  60
  61         /// Recursive 64bit spin-lock
  62         typedef cds::sync::reentrant_spin64 ReentrantSpin64;
  63
  64         /// Default recursive spin-lock type
  65         typedef ReentrantSpin32 ReentrantSpin;
  66
  67     }    // namespace lock
  68
  69     /// Standard (best for the current platform) spin-lock implementation
  70     typedef lock::Spin              SpinLock;
  71
  72     /// Standard (best for the current platform) recursive spin-lock implementation
  73     typedef lock::ReentrantSpin     RecursiveSpinLock;
  74
  75     /// 32bit recursive spin-lock shortcut
  76     typedef lock::ReentrantSpin32   RecursiveSpinLock32;
  77
  78     /// 64bit recursive spin-lock shortcut
  79     typedef lock::ReentrantSpin64   RecursiveSpinLock64;
  80
  81 } // namespace cds
  82 //@endcond
  83
  84 #endif  // #ifndef CDSLIB_LOCK_SPINLOCK_H