atomic_ptr.hpp 4.45 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2 3
    Copyright (c) 2007-2011 iMatix Corporation
    Copyright (c) 2007-2011 Other contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
4 5 6 7

    This file is part of 0MQ.

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

    0MQ 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
15
    GNU Lesser General Public License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
16

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

Martin Sustrik's avatar
Martin Sustrik committed
21 22
#ifndef __ZMQ_ATOMIC_PTR_HPP_INCLUDED__
#define __ZMQ_ATOMIC_PTR_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
23 24 25

#include "platform.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
26 27
#if defined ZMQ_FORCE_MUTEXES
#define ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
28
#elif (defined __i386__ || defined __x86_64__) && defined __GNUC__
Martin Sustrik's avatar
Martin Sustrik committed
29 30 31
#define ZMQ_ATOMIC_PTR_X86
#elif defined ZMQ_HAVE_WINDOWS
#define ZMQ_ATOMIC_PTR_WINDOWS
32
#elif (defined ZMQ_HAVE_SOLARIS || defined ZMQ_HAVE_NETBSD)
33
#define ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
34
#else
Martin Sustrik's avatar
Martin Sustrik committed
35
#define ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
36 37
#endif

Martin Sustrik's avatar
Martin Sustrik committed
38
#if defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
39
#include "mutex.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
40
#elif defined ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
41
#include "windows.hpp"
42
#elif defined ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
43 44 45
#include <atomic.h>
#endif

Martin Sustrik's avatar
Martin Sustrik committed
46
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
{

    //  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
78
#if defined ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
79
            return (T*) InterlockedExchangePointer ((PVOID*) &ptr, val_);
80
#elif defined ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
81
            return (T*) atomic_swap_ptr (&ptr, val_);
Martin Sustrik's avatar
Martin Sustrik committed
82
#elif defined ZMQ_ATOMIC_PTR_X86
Martin Sustrik's avatar
Martin Sustrik committed
83 84 85 86 87 88
            T *old;
            __asm__ volatile (
                "lock; xchg %0, %2"
                : "=r" (old), "=m" (ptr)
                : "m" (ptr), "0" (val_));
            return old;
Martin Sustrik's avatar
Martin Sustrik committed
89
#elif defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
90 91 92 93 94 95
            sync.lock ();
            T *old = (T*) ptr;
            ptr = val_;
            sync.unlock ();
            return old;
#else
96
#error atomic_ptr is not implemented for this platform
Martin Sustrik's avatar
Martin Sustrik committed
97 98 99 100 101 102 103 104 105
#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
106
#if defined ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
107 108
            return (T*) InterlockedCompareExchangePointer (
                (volatile PVOID*) &ptr, val_, cmp_);
109
#elif defined ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
110
            return (T*) atomic_cas_ptr (&ptr, cmp_, val_);
Martin Sustrik's avatar
Martin Sustrik committed
111
#elif defined ZMQ_ATOMIC_PTR_X86
Martin Sustrik's avatar
Martin Sustrik committed
112 113 114 115 116 117 118
            T *old;
            __asm__ volatile (
                "lock; cmpxchg %2, %3"
                : "=a" (old), "=m" (ptr)
                : "r" (val_), "m" (ptr), "0" (cmp_)
                : "cc");
            return old;
Martin Sustrik's avatar
Martin Sustrik committed
119
#elif defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
120 121 122 123 124 125 126
            sync.lock ();
            T *old = (T*) ptr;
            if (ptr == cmp_)
                ptr = val_;
            sync.unlock ();
            return old;
#else
127
#error atomic_ptr is not implemented for this platform
Martin Sustrik's avatar
Martin Sustrik committed
128 129 130 131 132 133
#endif
        }

    private:

        volatile T *ptr;
Martin Sustrik's avatar
Martin Sustrik committed
134
#if defined ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
135 136 137 138
        mutex_t sync;
#endif

        atomic_ptr_t (const atomic_ptr_t&);
139
        const atomic_ptr_t &operator = (const atomic_ptr_t&);
Martin Sustrik's avatar
Martin Sustrik committed
140 141 142 143 144
    };

}

//  Remove macros local to this file.
Martin Sustrik's avatar
Martin Sustrik committed
145 146
#if defined ZMQ_ATOMIC_PTR_WINDOWS
#undef ZMQ_ATOMIC_PTR_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
147
#endif
148 149
#if defined ZMQ_ATOMIC_PTR_ATOMIC_H
#undef ZMQ_ATOMIC_PTR_ATOMIC_H
Martin Sustrik's avatar
Martin Sustrik committed
150
#endif
Martin Sustrik's avatar
Martin Sustrik committed
151 152
#if defined ZMQ_ATOMIC_PTR_X86
#undef ZMQ_ATOMIC_PTR_X86
Martin Sustrik's avatar
Martin Sustrik committed
153
#endif
Martin Sustrik's avatar
Martin Sustrik committed
154 155
#if defined ZMQ_ATOMIC_PTR_MUTEX
#undef ZMQ_ATOMIC_PTR_MUTEX
Martin Sustrik's avatar
Martin Sustrik committed
156 157 158
#endif

#endif
159