mutex.hpp 4.77 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_MUTEX_HPP_INCLUDED__
#define __ZMQ_MUTEX_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32 33 34 35 36

#include "err.hpp"

//  Mutex class encapsulates OS mutex in a platform-independent way.

Martin Sustrik's avatar
Martin Sustrik committed
37
#ifdef ZMQ_HAVE_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
38 39 40

#include "windows.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
41
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
{

    class mutex_t
    {
    public:
        inline mutex_t ()
        {
            InitializeCriticalSection (&cs);
        }

        inline ~mutex_t ()
        {
            DeleteCriticalSection (&cs);
        }

        inline void lock ()
        {
            EnterCriticalSection (&cs);
        }

danielkr's avatar
danielkr committed
62 63
        inline bool try_lock ()
        {
64
            return (TryEnterCriticalSection (&cs)) ? true : false;
danielkr's avatar
danielkr committed
65 66
        }

Martin Sustrik's avatar
Martin Sustrik committed
67 68 69 70 71
        inline void unlock ()
        {
            LeaveCriticalSection (&cs);
        }

somdoron's avatar
somdoron committed
72 73 74 75 76
        inline CRITICAL_SECTION* get_cs()
        {
            return &cs;
        }

Martin Sustrik's avatar
Martin Sustrik committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
    private:

        CRITICAL_SECTION cs;

        //  Disable copy construction and assignment.
        mutex_t (const mutex_t&);
        void operator = (const mutex_t&);
    };

}

#else

#include <pthread.h>

Martin Sustrik's avatar
Martin Sustrik committed
92
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
93
{
94

Martin Sustrik's avatar
Martin Sustrik committed
95 96 97 98 99
    class mutex_t
    {
    public:
        inline mutex_t ()
        {
100 101 102 103 104 105 106
            int rc = pthread_mutexattr_init(&attr);
            posix_assert (rc);

            rc = pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
            posix_assert (rc);

            rc = pthread_mutex_init (&mutex, &attr);
107
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
108
        }
109

Martin Sustrik's avatar
Martin Sustrik committed
110 111 112
        inline ~mutex_t ()
        {
            int rc = pthread_mutex_destroy (&mutex);
113
            posix_assert (rc);
114 115 116

            rc = pthread_mutexattr_destroy (&attr);
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
117
        }
118

Martin Sustrik's avatar
Martin Sustrik committed
119 120 121
        inline void lock ()
        {
            int rc = pthread_mutex_lock (&mutex);
122
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
123
        }
124

danielkr's avatar
danielkr committed
125 126 127 128 129 130 131 132 133 134
        inline bool try_lock ()
        {
            int rc = pthread_mutex_trylock (&mutex);
            if (rc == EBUSY)
                return false;

            posix_assert (rc);
            return true;
        }

Martin Sustrik's avatar
Martin Sustrik committed
135 136 137
        inline void unlock ()
        {
            int rc = pthread_mutex_unlock (&mutex);
138
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
139
        }
140

somdoron's avatar
somdoron committed
141 142 143 144 145
        inline pthread_mutex_t* get_mutex()
        {
            return &mutex;
        }

Martin Sustrik's avatar
Martin Sustrik committed
146
    private:
147

Martin Sustrik's avatar
Martin Sustrik committed
148
        pthread_mutex_t mutex;
149
        pthread_mutexattr_t attr;
150

151
        // Disable copy construction and assignment.
Martin Sustrik's avatar
Martin Sustrik committed
152
        mutex_t (const mutex_t&);
153
        const mutex_t &operator = (const mutex_t&);
Martin Sustrik's avatar
Martin Sustrik committed
154
    };
155

Martin Sustrik's avatar
Martin Sustrik committed
156 157 158 159
}

#endif

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

namespace zmq
{
    struct scoped_lock_t
    {
        scoped_lock_t (mutex_t& mutex_)
            : mutex (mutex_)
        {
            mutex.lock ();
        }

        ~scoped_lock_t ()
        {
            mutex.unlock ();
        }

    private:

        mutex_t& mutex;

        // Disable copy construction and assignment.
        scoped_lock_t (const scoped_lock_t&);
        const scoped_lock_t &operator = (const scoped_lock_t&);
    };
184 185 186 187 188 189 190


    struct scoped_optional_lock_t
    {
        scoped_optional_lock_t (mutex_t* mutex_)
            : mutex (mutex_)
        {
191
            if(mutex != NULL)
192 193 194 195 196
                mutex->lock ();
        }

        ~scoped_optional_lock_t ()
        {
197
            if(mutex != NULL)
198 199 200 201 202 203 204 205 206 207 208 209 210
                mutex->unlock ();
        }

    private:

        mutex_t* mutex;

        // Disable copy construction and assignment.
        scoped_optional_lock_t (const scoped_lock_t&);
        const scoped_optional_lock_t &operator = (const scoped_lock_t&);
    };


211 212
}

Martin Sustrik's avatar
Martin Sustrik committed
213
#endif