atomic_ptr.hpp 7.43 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
30 31
#ifndef __ZMQ_ATOMIC_PTR_HPP_INCLUDED__
#define __ZMQ_ATOMIC_PTR_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

Martin Sustrik's avatar
Martin Sustrik committed
33 34
#if defined ZMQ_FORCE_MUTEXES
#define ZMQ_ATOMIC_PTR_MUTEX
35 36
#elif defined ZMQ_HAVE_ATOMIC_INTRINSICS
#define ZMQ_ATOMIC_PTR_INTRINSIC
37
#elif (defined ZMQ_CXX11 && defined __cplusplus && __cplusplus >= 201103L)
38
#define ZMQ_ATOMIC_PTR_CXX11
Martin Sustrik's avatar
Martin Sustrik committed
39
#elif (defined __i386__ || defined __x86_64__) && defined __GNUC__
Martin Sustrik's avatar
Martin Sustrik committed
40
#define ZMQ_ATOMIC_PTR_X86
41 42
#elif defined __ARM_ARCH_7A__ && defined __GNUC__
#define ZMQ_ATOMIC_PTR_ARM
43 44
#elif defined __tile__
#define ZMQ_ATOMIC_PTR_TILE
Martin Sustrik's avatar
Martin Sustrik committed
45 46
#elif defined ZMQ_HAVE_WINDOWS
#define ZMQ_ATOMIC_PTR_WINDOWS
47
#elif (defined ZMQ_HAVE_SOLARIS || defined ZMQ_HAVE_NETBSD || defined ZMQ_HAVE_GNU)
48
#define ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
49
#else
Martin Sustrik's avatar
Martin Sustrik committed
50
#define ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
51 52
#endif

Martin Sustrik's avatar
Martin Sustrik committed
53
#if defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
54
#include "mutex.hpp"
55
#elif defined ZMQ_ATOMIC_PTR_CXX11
56
#include <atomic>
Martin Sustrik's avatar
Martin Sustrik committed
57
#elif defined ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
58
#include "windows.hpp"
59
#elif defined ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
60
#include <atomic.h>
61 62
#elif defined ZMQ_ATOMIC_PTR_TILE
#include <arch/atomic.h>
Martin Sustrik's avatar
Martin Sustrik committed
63 64
#endif

Martin Sustrik's avatar
Martin Sustrik committed
65
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
{

    //  This class encapsulates several atomic operations on pointers.

    template <typename T> class atomic_ptr_t
    {
    public:

        //  Initialise atomic pointer
        inline atomic_ptr_t ()
        {
            ptr = NULL;
        }

        //  Destroy atomic pointer
        inline ~atomic_ptr_t ()
        {
        }

        //  Set value of atomic pointer in a non-threadsafe way
        //  Use this function only when you are sure that at most one
        //  thread is accessing the pointer at the moment.
        inline void set (T *ptr_)
        {
            this->ptr = ptr_;
        }

        //  Perform atomic 'exchange pointers' operation. Pointer is set
        //  to the 'val' value. Old value is returned.
        inline T *xchg (T *val_)
        {
Martin Sustrik's avatar
Martin Sustrik committed
97
#if defined ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
98
            return (T*) InterlockedExchangePointer ((PVOID*) &ptr, val_);
99 100
#elif defined ZMQ_ATOMIC_PTR_INTRINSIC
            return (T*) __atomic_exchange_n (&ptr, val_, __ATOMIC_ACQ_REL);
101
#elif defined ZMQ_ATOMIC_PTR_CXX11
102
            return ptr.exchange(val_, std::memory_order_acq_rel);
103
#elif defined ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
104
            return (T*) atomic_swap_ptr (&ptr, val_);
105 106
#elif defined ZMQ_ATOMIC_PTR_TILE
            return (T*) arch_atomic_exchange (&ptr, val_);
Martin Sustrik's avatar
Martin Sustrik committed
107
#elif defined ZMQ_ATOMIC_PTR_X86
Martin Sustrik's avatar
Martin Sustrik committed
108 109 110 111 112 113
            T *old;
            __asm__ volatile (
                "lock; xchg %0, %2"
                : "=r" (old), "=m" (ptr)
                : "m" (ptr), "0" (val_));
            return old;
114 115 116 117 118 119 120 121 122 123 124 125 126 127
#elif defined ZMQ_ATOMIC_PTR_ARM
            T* old;
            unsigned int flag;
            __asm__ volatile (
                "       dmb     sy\n\t"
                "1:     ldrex   %1, [%3]\n\t"
                "       strex   %0, %4, [%3]\n\t"
                "       teq     %0, #0\n\t"
                "       bne     1b\n\t"
                "       dmb     sy\n\t"
                : "=&r"(flag), "=&r"(old), "+Qo"(ptr)
                : "r"(&ptr), "r"(val_)
                : "cc");
            return old;
Martin Sustrik's avatar
Martin Sustrik committed
128
#elif defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
129 130 131 132 133 134
            sync.lock ();
            T *old = (T*) ptr;
            ptr = val_;
            sync.unlock ();
            return old;
#else
135
#error atomic_ptr is not implemented for this platform
Martin Sustrik's avatar
Martin Sustrik committed
136 137 138 139 140 141 142 143 144
#endif
        }

        //  Perform atomic 'compare and swap' operation on the pointer.
        //  The pointer is compared to 'cmp' argument and if they are
        //  equal, its value is set to 'val'. Old value of the pointer
        //  is returned.
        inline T *cas (T *cmp_, T *val_)
        {
Martin Sustrik's avatar
Martin Sustrik committed
145
#if defined ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
146 147
            return (T*) InterlockedCompareExchangePointer (
                (volatile PVOID*) &ptr, val_, cmp_);
148 149
#elif defined ZMQ_ATOMIC_PTR_INTRINSIC
            T *old = cmp_;
150
            __atomic_compare_exchange_n (&ptr, (volatile T**) &old, val_, false,
151 152
                    __ATOMIC_RELEASE, __ATOMIC_ACQUIRE);
            return old;
153
#elif defined ZMQ_ATOMIC_PTR_CXX11
154
            ptr.compare_exchange_strong(cmp_, val_, std::memory_order_acq_rel);
155
            return cmp_;
156
#elif defined ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
157
            return (T*) atomic_cas_ptr (&ptr, cmp_, val_);
158 159
#elif defined ZMQ_ATOMIC_PTR_TILE
            return (T*) arch_atomic_val_compare_and_exchange (&ptr, cmp_, val_);
Martin Sustrik's avatar
Martin Sustrik committed
160
#elif defined ZMQ_ATOMIC_PTR_X86
Martin Sustrik's avatar
Martin Sustrik committed
161 162 163 164 165 166 167
            T *old;
            __asm__ volatile (
                "lock; cmpxchg %2, %3"
                : "=a" (old), "=m" (ptr)
                : "r" (val_), "m" (ptr), "0" (cmp_)
                : "cc");
            return old;
168 169 170 171 172 173 174 175
#elif defined ZMQ_ATOMIC_PTR_ARM
            T *old;
            unsigned int flag;
            __asm__ volatile (
                "       dmb     sy\n\t"
                "1:     ldrex   %1, [%3]\n\t"
                "       mov     %0, #0\n\t"
                "       teq     %1, %4\n\t"
176
                "       it      eq\n\t"
177 178 179 180 181 182 183 184
                "       strexeq %0, %5, [%3]\n\t"
                "       teq     %0, #0\n\t"
                "       bne     1b\n\t"
                "       dmb     sy\n\t"
                : "=&r"(flag), "=&r"(old), "+Qo"(ptr)
                : "r"(&ptr), "r"(cmp_), "r"(val_)
                : "cc");
            return old;
Martin Sustrik's avatar
Martin Sustrik committed
185
#elif defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
186 187 188 189 190 191 192
            sync.lock ();
            T *old = (T*) ptr;
            if (ptr == cmp_)
                ptr = val_;
            sync.unlock ();
            return old;
#else
193
#error atomic_ptr is not implemented for this platform
Martin Sustrik's avatar
Martin Sustrik committed
194 195 196 197 198
#endif
        }

    private:

199
#if defined ZMQ_ATOMIC_PTR_CXX11
200 201
        std::atomic<T*> ptr;
#else
Martin Sustrik's avatar
Martin Sustrik committed
202
        volatile T *ptr;
203 204
#endif

Martin Sustrik's avatar
Martin Sustrik committed
205
#if defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
206 207 208
        mutex_t sync;
#endif

209
#if ! defined ZMQ_ATOMIC_PTR_CXX11
Martin Sustrik's avatar
Martin Sustrik committed
210
        atomic_ptr_t (const atomic_ptr_t&);
211
        const atomic_ptr_t &operator = (const atomic_ptr_t&);
212
#endif
Martin Sustrik's avatar
Martin Sustrik committed
213 214 215 216 217
    };

}

//  Remove macros local to this file.
218 219
#undef ZMQ_ATOMIC_PTR_MUTEX
#undef ZMQ_ATOMIC_PTR_INTRINSIC
220
#undef ZMQ_ATOMIC_PTR_CXX11
Martin Sustrik's avatar
Martin Sustrik committed
221
#undef ZMQ_ATOMIC_PTR_X86
222
#undef ZMQ_ATOMIC_PTR_ARM
223 224 225
#undef ZMQ_ATOMIC_PTR_TILE
#undef ZMQ_ATOMIC_PTR_WINDOWS
#undef ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
226 227

#endif