simple_semaphore.hpp 4.7 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
    Copyright (c) 2007-2009 FastMQ Inc.

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
    the terms of the Lesser GNU General Public License as published by
    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
    Lesser GNU General Public License for more details.

    You should have received a copy of the Lesser GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

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

#include "platform.hpp"
#include "err.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
26
#if defined ZMQ_HAVE_LINUX || defined ZMQ_HAVE_OSX || defined ZMQ_HAVE_OPENVMS
Martin Sustrik's avatar
Martin Sustrik committed
27
#include <pthread.h>
Martin Sustrik's avatar
Martin Sustrik committed
28
#elif defined ZMQ_HAVE_WINDOWS
Martin Sustrik's avatar
Martin Sustrik committed
29 30 31 32 33
#include "windows.hpp"
#else
#include <semaphore.h>
#endif

Martin Sustrik's avatar
Martin Sustrik committed
34
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
35 36 37 38 39 40 41
{

    //  Simple semaphore. Only single thread may be waiting at any given time.
    //  Also, the semaphore may not be posted before the previous post
    //  was matched by corresponding wait and the waiting thread was
    //  released.

Martin Sustrik's avatar
Martin Sustrik committed
42
#if defined ZMQ_HAVE_LINUX || defined ZMQ_HAVE_OSX || defined ZMQ_HAVE_OPENVMS
Martin Sustrik's avatar
Martin Sustrik committed
43 44 45 46 47 48 49 50 51 52 53 54 55

    //  On platforms that allow for double locking of a mutex from the same
    //  thread, simple semaphore is implemented using mutex, as it is more
    //  efficient than full-blown semaphore.

    class simple_semaphore_t
    { 
    public:

        //  Initialise the semaphore.
        inline simple_semaphore_t ()
        {
            int rc = pthread_mutex_init (&mutex, NULL);
56
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
57
            rc = pthread_mutex_lock (&mutex);
58
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
59 60 61 62 63 64
        }

        //  Destroy the semaphore.
        inline ~simple_semaphore_t ()
        {
            int rc = pthread_mutex_unlock (&mutex);
65
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
66
            rc = pthread_mutex_destroy (&mutex);
67
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
68 69 70 71 72 73
        }

        //  Wait for the semaphore.
        inline void wait ()
        {
             int rc = pthread_mutex_lock (&mutex);
74
             posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
75 76 77 78 79 80
        }

        //  Post the semaphore.
        inline void post ()
        {
            int rc = pthread_mutex_unlock (&mutex);
81
            posix_assert (rc);
Martin Sustrik's avatar
Martin Sustrik committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
        }

    private:

        pthread_mutex_t mutex;

        //  Disable copying of the object.
        simple_semaphore_t (const simple_semaphore_t&);
        void operator = (const simple_semaphore_t&);
    };

#elif defined ZMQ_HAVE_WINDOWS

    //  On Windows platform simple semaphore is implemeted using event object.

    class simple_semaphore_t
    { 
    public:

        //  Initialise the semaphore.
        inline simple_semaphore_t ()
        {
            ev = CreateEvent (NULL, FALSE, FALSE, NULL);
            win_assert (ev != NULL);
        }

        //  Destroy the semaphore.
        inline ~simple_semaphore_t ()
        {
            int rc = CloseHandle (ev);
            win_assert (rc != 0);    
        }

        //  Wait for the semaphore.
        inline void wait ()
        {
            DWORD rc = WaitForSingleObject (ev, INFINITE);
            win_assert (rc != WAIT_FAILED);
        }

        //  Post the semaphore.
        inline void post ()
        {
            int rc = SetEvent (ev);
            win_assert (rc != 0);
        }

    private:

        HANDLE ev;

        //  Disable copying of the object.
        simple_semaphore_t (const simple_semaphore_t&);
        void operator = (const simple_semaphore_t&);
    };

#else

    //  Default implementation maps simple semaphore to standard semaphore.

    class simple_semaphore_t
    { 
    public:

        //  Initialise the semaphore.
        inline simple_semaphore_t ()
        {
             int rc = sem_init (&sem, 0, 0);
             errno_assert (rc != -1);
        }

        //  Destroy the semaphore.
        inline ~simple_semaphore_t ()
        {
             int rc = sem_destroy (&sem);
             errno_assert (rc != -1);
        }

        //  Wait for the semaphore.
        inline void wait ()
        {
             int rc = sem_wait (&sem);
             errno_assert (rc != -1);
        }

        //  Post the semaphore.
        inline void post ()
        {
            int rc = sem_post (&sem);
            errno_assert (rc != -1);
        }

    private:

        //  Underlying system semaphore object.
        sem_t sem;

        //  Disable copying of the object.
        simple_semaphore_t (const simple_semaphore_t&);
        void operator = (const simple_semaphore_t&);
    };

#endif

}

#endif