summaryrefslogtreecommitdiff
path: root/boost/thread/win32/basic_timed_mutex.hpp
blob: b332dab7520b9a5d269a80a68bfabc972cf8afe1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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
78
79
80
81
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
#ifndef BOOST_BASIC_TIMED_MUTEX_WIN32_HPP
#define BOOST_BASIC_TIMED_MUTEX_WIN32_HPP

//  basic_timed_mutex_win32.hpp
//
//  (C) Copyright 2006-8 Anthony Williams
//  (C) Copyright 2011-2012 Vicente J. Botet Escriba
//
//  Distributed under the Boost Software License, Version 1.0. (See
//  accompanying file LICENSE_1_0.txt or copy at
//  http://www.boost.org/LICENSE_1_0.txt)

#include <boost/assert.hpp>
#include <boost/thread/win32/thread_primitives.hpp>
#include <boost/thread/win32/interlocked_read.hpp>
#include <boost/thread/thread_time.hpp>
#if defined BOOST_THREAD_USES_DATETIME
#include <boost/thread/xtime.hpp>
#endif
#include <boost/detail/interlocked.hpp>
#ifdef BOOST_THREAD_USES_CHRONO
#include <boost/chrono/system_clocks.hpp>
#include <boost/chrono/ceil.hpp>
#endif
#include <boost/thread/detail/platform_time.hpp>

#include <boost/config/abi_prefix.hpp>

namespace boost
{
    namespace detail
    {
        struct basic_timed_mutex
        {
            BOOST_STATIC_CONSTANT(unsigned char,lock_flag_bit=31);
            BOOST_STATIC_CONSTANT(unsigned char,event_set_flag_bit=30);
            BOOST_STATIC_CONSTANT(long,lock_flag_value=1<<lock_flag_bit);
            BOOST_STATIC_CONSTANT(long,event_set_flag_value=1<<event_set_flag_bit);
            long active_count;
            void* event;

            void initialize()
            {
                active_count=0;
                event=0;
            }

            void destroy()
            {
#ifdef BOOST_MSVC
#pragma warning(push)
#pragma warning(disable:4312)
#endif
                void* const old_event=BOOST_INTERLOCKED_EXCHANGE_POINTER(&event,0);
#ifdef BOOST_MSVC
#pragma warning(pop)
#endif
                if(old_event)
                {
                    winapi::CloseHandle(old_event);
                }
            }

            // Take the lock flag if it's available
            bool try_lock() BOOST_NOEXCEPT
            {
                return !win32::interlocked_bit_test_and_set(&active_count,lock_flag_bit);
            }

            void lock()
            {
                if(try_lock())
                {
                    return;
                }
                long old_count=active_count;
                mark_waiting_and_try_lock(old_count);

                if(old_count&lock_flag_value)
                {
                    void* const sem=get_event();

                    do
                    {
                        if(winapi::WaitForSingleObjectEx(sem,::boost::detail::win32::infinite,0)==0)
                        {
                            clear_waiting_and_try_lock(old_count);
                        }
                    }
                    while(old_count&lock_flag_value);
                }
            }

            // Loop until the number of waiters has been incremented or we've taken the lock flag
            // The loop is necessary since this function may be called by multiple threads simultaneously
            void mark_waiting_and_try_lock(long& old_count)
            {
                for(;;)
                {
                    bool const was_locked=(old_count&lock_flag_value) ? true : false;
                    long const new_count=was_locked?(old_count+1):(old_count|lock_flag_value);
                    long const current=BOOST_INTERLOCKED_COMPARE_EXCHANGE(&active_count,new_count,old_count);
                    if(current==old_count)
                    {
                        if(was_locked)
                            old_count=new_count;
                        // else we've taken the lock flag
                            // don't update old_count so that the calling function can see that
                            // the old lock flag was 0 and know that we've taken the lock flag
                        break;
                    }
                    old_count=current;
                }
            }

            // Loop until someone else has taken the lock flag and cleared the event set flag or
            // until we've taken the lock flag and cleared the event set flag and decremented the
            // number of waiters
            // The loop is necessary since this function may be called by multiple threads simultaneously
            void clear_waiting_and_try_lock(long& old_count)
            {
                old_count&=~lock_flag_value;
                old_count|=event_set_flag_value;
                for(;;)
                {
                    long const new_count=((old_count&lock_flag_value)?old_count:((old_count-1)|lock_flag_value))&~event_set_flag_value;
                    long const current=BOOST_INTERLOCKED_COMPARE_EXCHANGE(&active_count,new_count,old_count);
                    if(current==old_count)
                    {
                        // if someone else has taken the lock flag
                            // no need to update old_count since old_count == new_count (ignoring
                            // event_set_flag_value which the calling function doesn't care about)
                        // else we've taken the lock flag
                            // don't update old_count so that the calling function can see that
                            // the old lock flag was 0 and know that we've taken the lock flag
                        break;
                    }
                    old_count=current;
                }
            }

        private:
            unsigned long getMs(detail::platform_duration const& d)
            {
                return static_cast<unsigned long>(d.getMs());
            }

            template <typename Duration>
            unsigned long getMs(Duration const& d)
            {
                return static_cast<unsigned long>(chrono::ceil<chrono::milliseconds>(d).count());
            }

            template <typename Clock, typename Timepoint, typename Duration>
            bool do_lock_until(Timepoint const& t, Duration const& max)
            {
                if(try_lock())
                {
                    return true;
                }

                long old_count=active_count;
                mark_waiting_and_try_lock(old_count);

                if(old_count&lock_flag_value)
                {
                    void* const sem=get_event();

                    // If the clock is the system clock, it may jump while this function
                    // is waiting. To compensate for this and time out near the correct
                    // time, we call WaitForSingleObjectEx() in a loop with a short
                    // timeout and recheck the time remaining each time through the loop.
                    do
                    {
                        Duration d(t - Clock::now());
                        if(d <= Duration::zero()) // timeout occurred
                        {
                            BOOST_INTERLOCKED_DECREMENT(&active_count);
                            return false;
                        }
                        if(max != Duration::zero())
                        {
                            d = (std::min)(d, max);
                        }
                        if(winapi::WaitForSingleObjectEx(sem,getMs(d),0)==0)
                        {
                            clear_waiting_and_try_lock(old_count);
                        }
                    }
                    while(old_count&lock_flag_value);
                }
                return true;
            }
        public:

#if defined BOOST_THREAD_USES_DATETIME
            bool timed_lock(::boost::system_time const& wait_until)
            {
                const detail::real_platform_timepoint t(wait_until);
                return do_lock_until<detail::real_platform_clock>(t, detail::platform_milliseconds(BOOST_THREAD_POLL_INTERVAL_MILLISECONDS));
            }

            template<typename Duration>
            bool timed_lock(Duration const& timeout)
            {
                const detail::mono_platform_timepoint t(detail::mono_platform_clock::now() + detail::platform_duration(timeout));
                // The reference clock is steady and so no need to poll periodically, thus 0 ms max (i.e. no max)
                return do_lock_until<detail::mono_platform_clock>(t, detail::platform_duration::zero());
            }

            bool timed_lock(boost::xtime const& timeout)
            {
                return timed_lock(boost::system_time(timeout));
            }
#endif
#ifdef BOOST_THREAD_USES_CHRONO
            template <class Rep, class Period>
            bool try_lock_for(const chrono::duration<Rep, Period>& rel_time)
            {
                const chrono::steady_clock::time_point t(chrono::steady_clock::now() + rel_time);
                typedef typename chrono::duration<Rep, Period> Duration;
                typedef typename common_type<Duration, typename chrono::steady_clock::duration>::type common_duration;
                // The reference clock is steady and so no need to poll periodically, thus 0 ms max (i.e. no max)
                return do_lock_until<chrono::steady_clock>(t, common_duration::zero());
            }
            template <class Duration>
            bool try_lock_until(const chrono::time_point<chrono::steady_clock, Duration>& t)
            {
                typedef typename common_type<Duration, typename chrono::steady_clock::duration>::type common_duration;
                // The reference clock is steady and so no need to poll periodically, thus 0 ms max (i.e. no max)
                return do_lock_until<chrono::steady_clock>(t, common_duration::zero());
            }
            template <class Clock, class Duration>
            bool try_lock_until(const chrono::time_point<Clock, Duration>& t)
            {
                typedef typename common_type<Duration, typename Clock::duration>::type common_duration;
                return do_lock_until<Clock>(t, common_duration(chrono::milliseconds(BOOST_THREAD_POLL_INTERVAL_MILLISECONDS)));
            }
#endif

            void unlock()
            {
                // Clear the lock flag using atomic addition (works since long is always 32 bits on Windows)
                long const old_count=BOOST_INTERLOCKED_EXCHANGE_ADD(&active_count,lock_flag_value);
                // If someone is waiting to take the lock, set the event set flag and, if
                // the event set flag hadn't already been set, send an event.
                if(!(old_count&event_set_flag_value) && (old_count>lock_flag_value))
                {
                    if(!win32::interlocked_bit_test_and_set(&active_count,event_set_flag_bit))
                    {
                        winapi::SetEvent(get_event());
                    }
                }
            }

        private:
            // Create an event in a thread-safe way
            // The first thread to create the event wins and all other thread will use that event
            void* get_event()
            {
                void* current_event=::boost::detail::interlocked_read_acquire(&event);

                if(!current_event)
                {
                    void* const new_event=win32::create_anonymous_event(win32::auto_reset_event,win32::event_initially_reset);
#ifdef BOOST_MSVC
#pragma warning(push)
#pragma warning(disable:4311)
#pragma warning(disable:4312)
#endif
                    void* const old_event=BOOST_INTERLOCKED_COMPARE_EXCHANGE_POINTER(&event,new_event,0);
#ifdef BOOST_MSVC
#pragma warning(pop)
#endif
                    if(old_event!=0)
                    {
                        winapi::CloseHandle(new_event);
                        return old_event;
                    }
                    else
                    {
                        return new_event;
                    }
                }
                return current_event;
            }

        };

    }
}

#define BOOST_BASIC_TIMED_MUTEX_INITIALIZER {0}

#include <boost/config/abi_suffix.hpp>

#endif