Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_BASE_MUTEX_H_ |
| 18 | #define ART_RUNTIME_BASE_MUTEX_H_ |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 19 | |
| 20 | #include <pthread.h> |
Brian Carlstrom | cd74c4b | 2012-01-23 13:21:00 -0800 | [diff] [blame] | 21 | #include <stdint.h> |
Elliott Hughes | ffb465f | 2012-03-01 18:46:05 -0800 | [diff] [blame] | 22 | |
| 23 | #include <iosfwd> |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 24 | #include <string> |
| 25 | |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 26 | #include "atomic.h" |
Elliott Hughes | 07ed66b | 2012-12-12 18:34:25 -0800 | [diff] [blame] | 27 | #include "base/logging.h" |
Elliott Hughes | 7616005 | 2012-12-12 16:31:20 -0800 | [diff] [blame] | 28 | #include "base/macros.h" |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 29 | #include "globals.h" |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 30 | |
Ian Rogers | ab47016 | 2012-09-29 23:06:53 -0700 | [diff] [blame] | 31 | #if defined(__APPLE__) |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 32 | #define ART_USE_FUTEXES 0 |
Ian Rogers | ab47016 | 2012-09-29 23:06:53 -0700 | [diff] [blame] | 33 | #else |
Chris Dearman | c014178 | 2013-11-14 17:29:21 -0800 | [diff] [blame] | 34 | #define ART_USE_FUTEXES 1 |
Ian Rogers | ab47016 | 2012-09-29 23:06:53 -0700 | [diff] [blame] | 35 | #endif |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 36 | |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 37 | // Currently Darwin doesn't support locks with timeouts. |
| 38 | #if !defined(__APPLE__) |
| 39 | #define HAVE_TIMED_RWLOCK 1 |
| 40 | #else |
| 41 | #define HAVE_TIMED_RWLOCK 0 |
| 42 | #endif |
| 43 | |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 44 | namespace art { |
| 45 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 46 | class LOCKABLE ReaderWriterMutex; |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 47 | class ScopedContentionRecorder; |
Ian Rogers | 50b35e2 | 2012-10-04 10:09:15 -0700 | [diff] [blame] | 48 | class Thread; |
| 49 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 50 | // LockLevel is used to impose a lock hierarchy [1] where acquisition of a Mutex at a higher or |
| 51 | // equal level to a lock a thread holds is invalid. The lock hierarchy achieves a cycle free |
| 52 | // partial ordering and thereby cause deadlock situations to fail checks. |
| 53 | // |
| 54 | // [1] http://www.drdobbs.com/parallel/use-lock-hierarchies-to-avoid-deadlock/204801163 |
| 55 | enum LockLevel { |
| 56 | kLoggingLock = 0, |
Hiroshi Yamauchi | 3eed93d | 2014-06-04 11:43:59 -0700 | [diff] [blame] | 57 | kMemMapsLock, |
Raghu Gandham | 7de77dd | 2014-06-13 15:16:31 -0700 | [diff] [blame] | 58 | kSwapMutexesLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 59 | kUnexpectedSignalLock, |
| 60 | kThreadSuspendCountLock, |
| 61 | kAbortLock, |
| 62 | kJdwpSocketLock, |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 63 | kRegionSpaceRegionLock, |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 64 | kReferenceQueueSoftReferencesLock, |
| 65 | kReferenceQueuePhantomReferencesLock, |
| 66 | kReferenceQueueFinalizerReferencesLock, |
| 67 | kReferenceQueueWeakReferencesLock, |
| 68 | kReferenceQueueClearedReferencesLock, |
| 69 | kReferenceProcessorLock, |
Mathieu Chartier | e5f13e5 | 2015-02-24 09:37:21 -0800 | [diff] [blame] | 70 | kJitCodeCacheLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 71 | kRosAllocGlobalLock, |
| 72 | kRosAllocBracketLock, |
| 73 | kRosAllocBulkFreeLock, |
| 74 | kAllocSpaceLock, |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 75 | kBumpPointerSpaceBlockLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 76 | kDexFileMethodInlinerLock, |
| 77 | kDexFileToMethodInlinerMapLock, |
| 78 | kMarkSweepMarkStackLock, |
| 79 | kTransactionLogLock, |
| 80 | kInternTableLock, |
Vladimir Marko | 3f5838d | 2014-08-07 18:07:18 +0100 | [diff] [blame] | 81 | kOatFileSecondaryLookupLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 82 | kDefaultMutexLevel, |
| 83 | kMarkSweepLargeObjectLock, |
| 84 | kPinTableLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 85 | kJdwpObjectRegistryLock, |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 86 | kModifyLdtLock, |
| 87 | kAllocatedThreadIdsLock, |
Andreas Gampe | 7424081 | 2014-04-17 10:35:09 -0700 | [diff] [blame] | 88 | kMonitorPoolLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 89 | kClassLinkerClassesLock, |
| 90 | kBreakpointLock, |
| 91 | kMonitorLock, |
Mathieu Chartier | 440e4ce | 2014-03-31 16:36:35 -0700 | [diff] [blame] | 92 | kMonitorListLock, |
Ian Rogers | 68d8b42 | 2014-07-17 11:09:10 -0700 | [diff] [blame] | 93 | kJniLoadLibraryLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 94 | kThreadListLock, |
| 95 | kBreakpointInvokeLock, |
Brian Carlstrom | 306db81 | 2014-09-05 13:01:41 -0700 | [diff] [blame] | 96 | kAllocTrackerLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 97 | kDeoptimizationLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 98 | kProfilerLock, |
| 99 | kJdwpEventListLock, |
| 100 | kJdwpAttachLock, |
| 101 | kJdwpStartLock, |
| 102 | kRuntimeShutdownLock, |
Jeff Hao | 69dbec6 | 2014-09-15 18:03:41 -0700 | [diff] [blame] | 103 | kTraceLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 104 | kHeapBitmapLock, |
| 105 | kMutatorLock, |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 106 | kInstrumentEntrypointsLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 107 | kZygoteCreationLock, |
| 108 | |
| 109 | kLockLevelCount // Must come last. |
| 110 | }; |
| 111 | std::ostream& operator<<(std::ostream& os, const LockLevel& rhs); |
| 112 | |
Brian Carlstrom | 2e250c8 | 2013-08-14 18:08:52 -0700 | [diff] [blame] | 113 | const bool kDebugLocking = kIsDebugBuild; |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 114 | |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 115 | // Record Log contention information, dumpable via SIGQUIT. |
| 116 | #ifdef ART_USE_FUTEXES |
Jeff Hao | 08f2e7b | 2013-09-09 16:44:02 -0700 | [diff] [blame] | 117 | // To enable lock contention logging, set this to true. |
| 118 | const bool kLogLockContentions = false; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 119 | #else |
| 120 | // Keep this false as lock contention logging is supported only with |
| 121 | // futex. |
| 122 | const bool kLogLockContentions = false; |
| 123 | #endif |
Ian Rogers | d9c4fc9 | 2013-10-01 19:45:43 -0700 | [diff] [blame] | 124 | const size_t kContentionLogSize = 4; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 125 | const size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; |
| 126 | const size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; |
| 127 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 128 | // Base class for all Mutex implementations |
| 129 | class BaseMutex { |
| 130 | public: |
Ian Rogers | bab7496 | 2013-04-19 10:04:10 -0700 | [diff] [blame] | 131 | const char* GetName() const { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 132 | return name_; |
| 133 | } |
| 134 | |
| 135 | virtual bool IsMutex() const { return false; } |
| 136 | virtual bool IsReaderWriterMutex() const { return false; } |
| 137 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 138 | virtual void Dump(std::ostream& os) const = 0; |
| 139 | |
| 140 | static void DumpAll(std::ostream& os); |
| 141 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 142 | protected: |
| 143 | friend class ConditionVariable; |
| 144 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 145 | BaseMutex(const char* name, LockLevel level); |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 146 | virtual ~BaseMutex(); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 147 | void RegisterAsLocked(Thread* self); |
| 148 | void RegisterAsUnlocked(Thread* self); |
| 149 | void CheckSafeToWait(Thread* self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 150 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 151 | friend class ScopedContentionRecorder; |
| 152 | |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 153 | void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked); |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 154 | void DumpContention(std::ostream& os) const; |
| 155 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 156 | const LockLevel level_; // Support for lock hierarchy. |
Ian Rogers | bab7496 | 2013-04-19 10:04:10 -0700 | [diff] [blame] | 157 | const char* const name_; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 158 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 159 | // A log entry that records contention but makes no guarantee that either tid will be held live. |
| 160 | struct ContentionLogEntry { |
| 161 | ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} |
| 162 | uint64_t blocked_tid; |
| 163 | uint64_t owner_tid; |
| 164 | AtomicInteger count; |
| 165 | }; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 166 | struct ContentionLogData { |
| 167 | ContentionLogEntry contention_log[kContentionLogSize]; |
| 168 | // The next entry in the contention log to be updated. Value ranges from 0 to |
| 169 | // kContentionLogSize - 1. |
| 170 | AtomicInteger cur_content_log_entry; |
| 171 | // Number of times the Mutex has been contended. |
| 172 | AtomicInteger contention_count; |
| 173 | // Sum of time waited by all contenders in ns. |
Ian Rogers | 37f3c96 | 2014-07-17 11:25:30 -0700 | [diff] [blame] | 174 | Atomic<uint64_t> wait_time; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 175 | void AddToWaitTime(uint64_t value); |
| 176 | ContentionLogData() : wait_time(0) {} |
| 177 | }; |
Ian Rogers | 3e5cf30 | 2014-05-20 16:40:37 -0700 | [diff] [blame] | 178 | ContentionLogData contention_log_data_[kContentionLogDataSize]; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 179 | |
| 180 | public: |
| 181 | bool HasEverContended() const { |
| 182 | if (kLogLockContentions) { |
Ian Rogers | 3e5cf30 | 2014-05-20 16:40:37 -0700 | [diff] [blame] | 183 | return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 184 | } |
| 185 | return false; |
| 186 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 187 | }; |
| 188 | |
| 189 | // A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain |
| 190 | // exclusive access to what it guards. A Mutex can be in one of two states: |
| 191 | // - Free - not owned by any thread, |
| 192 | // - Exclusive - owned by a single thread. |
| 193 | // |
| 194 | // The effect of locking and unlocking operations on the state is: |
| 195 | // State | ExclusiveLock | ExclusiveUnlock |
| 196 | // ------------------------------------------- |
| 197 | // Free | Exclusive | error |
| 198 | // Exclusive | Block* | Free |
| 199 | // * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in |
| 200 | // an error. Being non-reentrant simplifies Waiting on ConditionVariables. |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 201 | std::ostream& operator<<(std::ostream& os, const Mutex& mu); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 202 | class LOCKABLE Mutex : public BaseMutex { |
| 203 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 204 | explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 205 | ~Mutex(); |
| 206 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 207 | virtual bool IsMutex() const { return true; } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 208 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 209 | // Block until mutex is free then acquire exclusive access. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 210 | void ExclusiveLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION(); |
| 211 | void Lock(Thread* self) EXCLUSIVE_LOCK_FUNCTION() { ExclusiveLock(self); } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 212 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 213 | // Returns true if acquires exclusive access, false otherwise. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 214 | bool ExclusiveTryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true); |
| 215 | bool TryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true) { return ExclusiveTryLock(self); } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 216 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 217 | // Release exclusive access. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 218 | void ExclusiveUnlock(Thread* self) UNLOCK_FUNCTION(); |
| 219 | void Unlock(Thread* self) UNLOCK_FUNCTION() { ExclusiveUnlock(self); } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 220 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 221 | // Is the current thread the exclusive holder of the Mutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 222 | bool IsExclusiveHeld(const Thread* self) const; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 223 | |
| 224 | // Assert that the Mutex is exclusively held by the current thread. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 225 | void AssertExclusiveHeld(const Thread* self) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 226 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 227 | CHECK(IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 228 | } |
| 229 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 230 | void AssertHeld(const Thread* self) { AssertExclusiveHeld(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 231 | |
| 232 | // Assert that the Mutex is not held by the current thread. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 233 | void AssertNotHeldExclusive(const Thread* self) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 234 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 235 | CHECK(!IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 236 | } |
| 237 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 238 | void AssertNotHeld(const Thread* self) { AssertNotHeldExclusive(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 239 | |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 240 | // Id associated with exclusive owner. No memory ordering semantics if called from a thread other |
| 241 | // than the owner. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 242 | uint64_t GetExclusiveOwnerTid() const; |
| 243 | |
| 244 | // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. |
| 245 | unsigned int GetDepth() const { |
| 246 | return recursion_count_; |
| 247 | } |
Elliott Hughes | accd83d | 2011-10-17 14:25:58 -0700 | [diff] [blame] | 248 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 249 | virtual void Dump(std::ostream& os) const; |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 250 | |
Elliott Hughes | accd83d | 2011-10-17 14:25:58 -0700 | [diff] [blame] | 251 | private: |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 252 | #if ART_USE_FUTEXES |
| 253 | // 0 is unheld, 1 is held. |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 254 | AtomicInteger state_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 255 | // Exclusive owner. |
| 256 | volatile uint64_t exclusive_owner_; |
| 257 | // Number of waiting contenders. |
Ian Rogers | b122a4b | 2013-11-19 18:00:50 -0800 | [diff] [blame] | 258 | AtomicInteger num_contenders_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 259 | #else |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 260 | pthread_mutex_t mutex_; |
Ian Rogers | c5f1773 | 2014-06-05 20:48:42 -0700 | [diff] [blame] | 261 | volatile uint64_t exclusive_owner_; // Guarded by mutex_. |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 262 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 263 | const bool recursive_; // Can the lock be recursively held? |
| 264 | unsigned int recursion_count_; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 265 | friend class ConditionVariable; |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 266 | DISALLOW_COPY_AND_ASSIGN(Mutex); |
| 267 | }; |
| 268 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 269 | // A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. |
| 270 | // Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) |
| 271 | // access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a |
| 272 | // condition variable. A ReaderWriterMutex can be in one of three states: |
| 273 | // - Free - not owned by any thread, |
| 274 | // - Exclusive - owned by a single thread, |
| 275 | // - Shared(n) - shared amongst n threads. |
| 276 | // |
| 277 | // The effect of locking and unlocking operations on the state is: |
| 278 | // |
| 279 | // State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock |
| 280 | // ---------------------------------------------------------------------------- |
| 281 | // Free | Exclusive | error | SharedLock(1) | error |
| 282 | // Exclusive | Block | Free | Block | error |
| 283 | // Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free |
| 284 | // * for large values of n the SharedLock may block. |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 285 | std::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 286 | class LOCKABLE ReaderWriterMutex : public BaseMutex { |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 287 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 288 | explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 289 | ~ReaderWriterMutex(); |
| 290 | |
| 291 | virtual bool IsReaderWriterMutex() const { return true; } |
| 292 | |
| 293 | // Block until ReaderWriterMutex is free then acquire exclusive access. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 294 | void ExclusiveLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION(); |
| 295 | void WriterLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION() { ExclusiveLock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 296 | |
| 297 | // Release exclusive access. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 298 | void ExclusiveUnlock(Thread* self) UNLOCK_FUNCTION(); |
| 299 | void WriterUnlock(Thread* self) UNLOCK_FUNCTION() { ExclusiveUnlock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 300 | |
| 301 | // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success |
| 302 | // or false if timeout is reached. |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 303 | #if HAVE_TIMED_RWLOCK |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 304 | bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 305 | EXCLUSIVE_TRYLOCK_FUNCTION(true); |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 306 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 307 | |
| 308 | // Block until ReaderWriterMutex is shared or free then acquire a share on the access. |
Ian Rogers | 1ffa32f | 2013-02-05 18:29:08 -0800 | [diff] [blame] | 309 | void SharedLock(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 310 | void ReaderLock(Thread* self) SHARED_LOCK_FUNCTION() { SharedLock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 311 | |
| 312 | // Try to acquire share of ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 313 | bool SharedTryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 314 | |
| 315 | // Release a share of the access. |
Ian Rogers | 1ffa32f | 2013-02-05 18:29:08 -0800 | [diff] [blame] | 316 | void SharedUnlock(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 317 | void ReaderUnlock(Thread* self) UNLOCK_FUNCTION() { SharedUnlock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 318 | |
| 319 | // Is the current thread the exclusive holder of the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 320 | bool IsExclusiveHeld(const Thread* self) const; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 321 | |
| 322 | // Assert the current thread has exclusive access to the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 323 | void AssertExclusiveHeld(const Thread* self) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 324 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 325 | CHECK(IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 326 | } |
| 327 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 328 | void AssertWriterHeld(const Thread* self) { AssertExclusiveHeld(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 329 | |
| 330 | // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 331 | void AssertNotExclusiveHeld(const Thread* self) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 332 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | e3359f7 | 2013-06-11 15:14:11 -0700 | [diff] [blame] | 333 | CHECK(!IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 334 | } |
| 335 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 336 | void AssertNotWriterHeld(const Thread* self) { AssertNotExclusiveHeld(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 337 | |
| 338 | // Is the current thread a shared holder of the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 339 | bool IsSharedHeld(const Thread* self) const; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 340 | |
| 341 | // Assert the current thread has shared access to the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 342 | void AssertSharedHeld(const Thread* self) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 343 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 23055dc | 2013-04-18 16:29:16 -0700 | [diff] [blame] | 344 | // TODO: we can only assert this well when self != NULL. |
| 345 | CHECK(IsSharedHeld(self) || self == NULL) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 346 | } |
| 347 | } |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 348 | void AssertReaderHeld(const Thread* self) { AssertSharedHeld(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 349 | |
| 350 | // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive |
| 351 | // mode. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 352 | void AssertNotHeld(const Thread* self) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 353 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 354 | CHECK(!IsSharedHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 355 | } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 356 | } |
| 357 | |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 358 | // Id associated with exclusive owner. No memory ordering semantics if called from a thread other |
| 359 | // than the owner. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 360 | uint64_t GetExclusiveOwnerTid() const; |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 361 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 362 | virtual void Dump(std::ostream& os) const; |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 363 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 364 | private: |
Ian Rogers | 51d212e | 2014-10-23 17:48:20 -0700 | [diff] [blame] | 365 | #if ART_USE_FUTEXES |
Ian Rogers | cf7f191 | 2014-10-22 22:06:39 -0700 | [diff] [blame] | 366 | // Out-of-inline path for handling contention for a SharedLock. |
| 367 | void HandleSharedLockContention(Thread* self, int32_t cur_state); |
| 368 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 369 | // -1 implies held exclusive, +ve shared held by state_ many owners. |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 370 | AtomicInteger state_; |
| 371 | // Exclusive owner. Modification guarded by this mutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 372 | volatile uint64_t exclusive_owner_; |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 373 | // Number of contenders waiting for a reader share. |
| 374 | AtomicInteger num_pending_readers_; |
| 375 | // Number of contenders waiting to be the writer. |
Ian Rogers | b122a4b | 2013-11-19 18:00:50 -0800 | [diff] [blame] | 376 | AtomicInteger num_pending_writers_; |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 377 | #else |
| 378 | pthread_rwlock_t rwlock_; |
Ian Rogers | c5f1773 | 2014-06-05 20:48:42 -0700 | [diff] [blame] | 379 | volatile uint64_t exclusive_owner_; // Guarded by rwlock_. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 380 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 381 | DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); |
| 382 | }; |
| 383 | |
| 384 | // ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually |
| 385 | // (Signal) or all at once (Broadcast). |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 386 | class ConditionVariable { |
| 387 | public: |
Ian Rogers | 23055dc | 2013-04-18 16:29:16 -0700 | [diff] [blame] | 388 | explicit ConditionVariable(const char* name, Mutex& mutex); |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 389 | ~ConditionVariable(); |
| 390 | |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 391 | void Broadcast(Thread* self); |
| 392 | void Signal(Thread* self); |
| 393 | // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their |
| 394 | // pointer copy, thereby defeating annotalysis. |
| 395 | void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; |
Ian Rogers | 7b078e8 | 2014-09-10 14:44:24 -0700 | [diff] [blame] | 396 | bool TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS; |
Ian Rogers | 1d54e73 | 2013-05-02 21:10:01 -0700 | [diff] [blame] | 397 | // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held |
| 398 | // when waiting. |
| 399 | // TODO: remove this. |
| 400 | void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 401 | |
| 402 | private: |
Ian Rogers | 23055dc | 2013-04-18 16:29:16 -0700 | [diff] [blame] | 403 | const char* const name_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 404 | // The Mutex being used by waiters. It is an error to mix condition variables between different |
| 405 | // Mutexes. |
| 406 | Mutex& guard_; |
| 407 | #if ART_USE_FUTEXES |
| 408 | // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up |
Ian Rogers | d45f201 | 2012-11-28 11:46:23 -0800 | [diff] [blame] | 409 | // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ |
| 410 | // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait |
| 411 | // without guard_ held. |
Ian Rogers | b122a4b | 2013-11-19 18:00:50 -0800 | [diff] [blame] | 412 | AtomicInteger sequence_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 413 | // Number of threads that have come into to wait, not the length of the waiters on the futex as |
Ian Rogers | 5bd97c4 | 2012-11-27 02:38:26 -0800 | [diff] [blame] | 414 | // waiters may have been requeued onto guard_. Guarded by guard_. |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 415 | volatile int32_t num_waiters_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 416 | #else |
| 417 | pthread_cond_t cond_; |
| 418 | #endif |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 419 | DISALLOW_COPY_AND_ASSIGN(ConditionVariable); |
| 420 | }; |
| 421 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 422 | // Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it |
| 423 | // upon destruction. |
| 424 | class SCOPED_LOCKABLE MutexLock { |
| 425 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 426 | explicit MutexLock(Thread* self, Mutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : self_(self), mu_(mu) { |
| 427 | mu_.ExclusiveLock(self_); |
| 428 | } |
| 429 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 430 | ~MutexLock() UNLOCK_FUNCTION() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 431 | mu_.ExclusiveUnlock(self_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 432 | } |
| 433 | |
| 434 | private: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 435 | Thread* const self_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 436 | Mutex& mu_; |
| 437 | DISALLOW_COPY_AND_ASSIGN(MutexLock); |
| 438 | }; |
| 439 | // Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)". |
Andreas Gampe | 575e78c | 2014-11-03 23:41:03 -0800 | [diff] [blame] | 440 | #define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 441 | |
| 442 | // Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon |
| 443 | // construction and releases it upon destruction. |
| 444 | class SCOPED_LOCKABLE ReaderMutexLock { |
| 445 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 446 | explicit ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : |
| 447 | self_(self), mu_(mu) { |
| 448 | mu_.SharedLock(self_); |
| 449 | } |
| 450 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 451 | ~ReaderMutexLock() UNLOCK_FUNCTION() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 452 | mu_.SharedUnlock(self_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 453 | } |
| 454 | |
| 455 | private: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 456 | Thread* const self_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 457 | ReaderWriterMutex& mu_; |
| 458 | DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); |
| 459 | }; |
| 460 | // Catch bug where variable name is omitted. "ReaderMutexLock (lock);" instead of |
| 461 | // "ReaderMutexLock mu(lock)". |
Andreas Gampe | 575e78c | 2014-11-03 23:41:03 -0800 | [diff] [blame] | 462 | #define ReaderMutexLock(x) static_assert(0, "ReaderMutexLock declaration missing variable name") |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 463 | |
| 464 | // Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon |
| 465 | // construction and releases it upon destruction. |
| 466 | class SCOPED_LOCKABLE WriterMutexLock { |
| 467 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 468 | explicit WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : |
| 469 | self_(self), mu_(mu) { |
| 470 | mu_.ExclusiveLock(self_); |
| 471 | } |
| 472 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 473 | ~WriterMutexLock() UNLOCK_FUNCTION() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 474 | mu_.ExclusiveUnlock(self_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 475 | } |
| 476 | |
| 477 | private: |
Ian Rogers | 50b35e2 | 2012-10-04 10:09:15 -0700 | [diff] [blame] | 478 | Thread* const self_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 479 | ReaderWriterMutex& mu_; |
| 480 | DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); |
| 481 | }; |
| 482 | // Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of |
| 483 | // "WriterMutexLock mu(lock)". |
Andreas Gampe | 575e78c | 2014-11-03 23:41:03 -0800 | [diff] [blame] | 484 | #define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 485 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 486 | // Global mutexes corresponding to the levels above. |
| 487 | class Locks { |
| 488 | public: |
| 489 | static void Init(); |
Mathieu Chartier | 91e5669 | 2015-03-03 13:51:04 -0800 | [diff] [blame^] | 490 | static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 491 | // Guards allocation entrypoint instrumenting. |
Ian Rogers | 4ad5cd3 | 2014-11-11 23:08:07 -0800 | [diff] [blame] | 492 | static Mutex* instrument_entrypoints_lock_; |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 493 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 494 | // The mutator_lock_ is used to allow mutators to execute in a shared (reader) mode or to block |
| 495 | // mutators by having an exclusive (writer) owner. In normal execution each mutator thread holds |
| 496 | // a share on the mutator_lock_. The garbage collector may also execute with shared access but |
| 497 | // at times requires exclusive access to the heap (not to be confused with the heap meta-data |
| 498 | // guarded by the heap_lock_ below). When the garbage collector requires exclusive access it asks |
| 499 | // the mutators to suspend themselves which also involves usage of the thread_suspend_count_lock_ |
| 500 | // to cover weaknesses in using ReaderWriterMutexes with ConditionVariables. We use a condition |
| 501 | // variable to wait upon in the suspension logic as releasing and then re-acquiring a share on |
| 502 | // the mutator lock doesn't necessarily allow the exclusive user (e.g the garbage collector) |
| 503 | // chance to acquire the lock. |
| 504 | // |
| 505 | // Thread suspension: |
| 506 | // Shared users | Exclusive user |
| 507 | // (holding mutator lock and in kRunnable state) | .. running .. |
| 508 | // .. running .. | Request thread suspension by: |
| 509 | // .. running .. | - acquiring thread_suspend_count_lock_ |
| 510 | // .. running .. | - incrementing Thread::suspend_count_ on |
| 511 | // .. running .. | all mutator threads |
| 512 | // .. running .. | - releasing thread_suspend_count_lock_ |
| 513 | // .. running .. | Block trying to acquire exclusive mutator lock |
| 514 | // Poll Thread::suspend_count_ and enter full | .. blocked .. |
| 515 | // suspend code. | .. blocked .. |
| 516 | // Change state to kSuspended | .. blocked .. |
| 517 | // x: Release share on mutator_lock_ | Carry out exclusive access |
| 518 | // Acquire thread_suspend_count_lock_ | .. exclusive .. |
| 519 | // while Thread::suspend_count_ > 0 | .. exclusive .. |
| 520 | // - wait on Thread::resume_cond_ | .. exclusive .. |
| 521 | // (releases thread_suspend_count_lock_) | .. exclusive .. |
| 522 | // .. waiting .. | Release mutator_lock_ |
| 523 | // .. waiting .. | Request thread resumption by: |
| 524 | // .. waiting .. | - acquiring thread_suspend_count_lock_ |
| 525 | // .. waiting .. | - decrementing Thread::suspend_count_ on |
| 526 | // .. waiting .. | all mutator threads |
| 527 | // .. waiting .. | - notifying on Thread::resume_cond_ |
| 528 | // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ |
| 529 | // Release thread_suspend_count_lock_ | .. running .. |
| 530 | // Acquire share on mutator_lock_ | .. running .. |
| 531 | // - This could block but the thread still | .. running .. |
| 532 | // has a state of kSuspended and so this | .. running .. |
| 533 | // isn't an issue. | .. running .. |
| 534 | // Acquire thread_suspend_count_lock_ | .. running .. |
| 535 | // - we poll here as we're transitioning into | .. running .. |
| 536 | // kRunnable and an individual thread suspend | .. running .. |
| 537 | // request (e.g for debugging) won't try | .. running .. |
| 538 | // to acquire the mutator lock (which would | .. running .. |
| 539 | // block as we hold the mutator lock). This | .. running .. |
| 540 | // poll ensures that if the suspender thought | .. running .. |
| 541 | // we were suspended by incrementing our | .. running .. |
| 542 | // Thread::suspend_count_ and then reading | .. running .. |
| 543 | // our state we go back to waiting on | .. running .. |
| 544 | // Thread::resume_cond_. | .. running .. |
| 545 | // can_go_runnable = Thread::suspend_count_ == 0 | .. running .. |
| 546 | // Release thread_suspend_count_lock_ | .. running .. |
| 547 | // if can_go_runnable | .. running .. |
| 548 | // Change state to kRunnable | .. running .. |
| 549 | // else | .. running .. |
| 550 | // Goto x | .. running .. |
| 551 | // .. running .. | .. running .. |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 552 | static ReaderWriterMutex* mutator_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 553 | |
| 554 | // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. |
| 555 | static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); |
| 556 | |
| 557 | // Guards shutdown of the runtime. |
| 558 | static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); |
| 559 | |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 560 | // Guards background profiler global state. |
| 561 | static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); |
| 562 | |
| 563 | // Guards trace (ie traceview) requests. |
| 564 | static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); |
| 565 | |
Brian Carlstrom | 306db81 | 2014-09-05 13:01:41 -0700 | [diff] [blame] | 566 | // Guards debugger recent allocation records. |
| 567 | static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); |
| 568 | |
| 569 | // Guards updates to instrumentation to ensure mutual exclusion of |
| 570 | // events like deoptimization requests. |
| 571 | // TODO: improve name, perhaps instrumentation_update_lock_. |
| 572 | static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); |
| 573 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 574 | // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads |
| 575 | // attaching and detaching. |
Brian Carlstrom | 306db81 | 2014-09-05 13:01:41 -0700 | [diff] [blame] | 576 | static Mutex* thread_list_lock_ ACQUIRED_AFTER(deoptimization_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 577 | |
Mathieu Chartier | 91e5669 | 2015-03-03 13:51:04 -0800 | [diff] [blame^] | 578 | // Signaled when threads terminate. Used to determine when all non-daemons have terminated. |
| 579 | static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); |
| 580 | |
Ian Rogers | 68d8b42 | 2014-07-17 11:09:10 -0700 | [diff] [blame] | 581 | // Guards maintaining loading library data structures. |
| 582 | static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); |
| 583 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 584 | // Guards breakpoints. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame] | 585 | static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 586 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 587 | // Guards lists of classes within the class linker. |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 588 | static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 589 | |
| 590 | // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code |
| 591 | // doesn't try to hold a higher level Mutex. |
| 592 | #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_) |
| 593 | |
Andreas Gampe | 7424081 | 2014-04-17 10:35:09 -0700 | [diff] [blame] | 594 | static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); |
| 595 | |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 596 | // Guard the allocation/deallocation of thread ids. |
Andreas Gampe | 7424081 | 2014-04-17 10:35:09 -0700 | [diff] [blame] | 597 | static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_); |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 598 | |
| 599 | // Guards modification of the LDT on x86. |
| 600 | static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); |
| 601 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 602 | // Guards intern table. |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 603 | static Mutex* intern_table_lock_ ACQUIRED_AFTER(modify_ldt_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 604 | |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 605 | // Guards reference processor. |
| 606 | static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); |
| 607 | |
| 608 | // Guards cleared references queue. |
| 609 | static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); |
| 610 | |
| 611 | // Guards weak references queue. |
| 612 | static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); |
| 613 | |
| 614 | // Guards finalizer references queue. |
| 615 | static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); |
| 616 | |
| 617 | // Guards phantom references queue. |
| 618 | static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); |
| 619 | |
| 620 | // Guards soft references queue. |
| 621 | static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); |
| 622 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 623 | // Have an exclusive aborting thread. |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 624 | static Mutex* abort_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 625 | |
| 626 | // Allow mutual exclusion when manipulating Thread::suspend_count_. |
| 627 | // TODO: Does the trade-off of a per-thread lock make sense? |
| 628 | static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); |
| 629 | |
| 630 | // One unexpected signal at a time lock. |
| 631 | static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); |
| 632 | |
Hiroshi Yamauchi | 3eed93d | 2014-06-04 11:43:59 -0700 | [diff] [blame] | 633 | // Guards the maps in mem_map. |
| 634 | static Mutex* mem_maps_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); |
| 635 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 636 | // Have an exclusive logging thread. |
| 637 | static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); |
| 638 | }; |
| 639 | |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 640 | } // namespace art |
| 641 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 642 | #endif // ART_RUNTIME_BASE_MUTEX_H_ |