bmalloc: Miscellaneous cleanup
[WebKit-https.git] / Source / bmalloc / bmalloc / StaticMutex.h
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef StaticMutex_h
27 #define StaticMutex_h
28
29 #include "BAssert.h"
30 #include <atomic>
31 #include <mutex>
32 #include <thread>
33
34 // A fast replacement for std::mutex, for use in static storage.
35
36 // Use StaticMutex in static storage, where global constructors and exit-time
37 // destructors are prohibited, but all memory is zero-initialized automatically.
38
39 namespace bmalloc {
40
41 class StaticMutex {
42 protected:
43     // Subclasses that support non-static storage must use explicit initialization.
44     void init();
45
46 public:
47     void lock();
48     bool try_lock();
49     void unlock();
50
51 private:
52     void lockSlowCase();
53
54     std::atomic_flag m_flag;
55 };
56
57 static inline void sleep(
58     std::unique_lock<StaticMutex>& lock, std::chrono::milliseconds duration)
59 {
60     if (duration == std::chrono::milliseconds(0))
61         return;
62     
63     lock.unlock();
64     std::this_thread::sleep_for(duration);
65     lock.lock();
66 }
67
68 static inline void waitUntilFalse(
69     std::unique_lock<StaticMutex>& lock, std::chrono::milliseconds sleepDuration,
70     bool& condition)
71 {
72     while (condition) {
73         condition = false;
74         sleep(lock, sleepDuration);
75     }
76 }
77
78 inline void StaticMutex::init()
79 {
80     m_flag.clear();
81 }
82
83 inline bool StaticMutex::try_lock()
84 {
85     return !m_flag.test_and_set(std::memory_order_acquire);
86 }
87
88 inline void StaticMutex::lock()
89 {
90     if (!try_lock())
91         lockSlowCase();
92 }
93
94 inline void StaticMutex::unlock()
95 {
96     m_flag.clear(std::memory_order_release);
97 }
98
99 } // namespace bmalloc
100
101 #endif // StaticMutex_h