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 | |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 46 | class SHARED_LOCKABLE ReaderWriterMutex; |
| 47 | class SHARED_LOCKABLE MutatorMutex; |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 48 | class ScopedContentionRecorder; |
Ian Rogers | 50b35e2 | 2012-10-04 10:09:15 -0700 | [diff] [blame] | 49 | class Thread; |
| 50 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 51 | // LockLevel is used to impose a lock hierarchy [1] where acquisition of a Mutex at a higher or |
| 52 | // equal level to a lock a thread holds is invalid. The lock hierarchy achieves a cycle free |
| 53 | // partial ordering and thereby cause deadlock situations to fail checks. |
| 54 | // |
| 55 | // [1] http://www.drdobbs.com/parallel/use-lock-hierarchies-to-avoid-deadlock/204801163 |
| 56 | enum LockLevel { |
| 57 | kLoggingLock = 0, |
Hiroshi Yamauchi | 3eed93d | 2014-06-04 11:43:59 -0700 | [diff] [blame] | 58 | kMemMapsLock, |
Raghu Gandham | 7de77dd | 2014-06-13 15:16:31 -0700 | [diff] [blame] | 59 | kSwapMutexesLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 60 | kUnexpectedSignalLock, |
| 61 | kThreadSuspendCountLock, |
| 62 | kAbortLock, |
Igor Murashkin | e2facc5 | 2015-07-10 13:49:08 -0700 | [diff] [blame] | 63 | kLambdaTableLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 64 | kJdwpSocketLock, |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 65 | kRegionSpaceRegionLock, |
Mathieu Chartier | 2994605 | 2015-12-21 13:02:14 -0800 | [diff] [blame] | 66 | kRosAllocGlobalLock, |
| 67 | kRosAllocBracketLock, |
| 68 | kRosAllocBulkFreeLock, |
Mathieu Chartier | 673ed3d | 2015-08-28 14:56:43 -0700 | [diff] [blame] | 69 | kMarkSweepMarkStackLock, |
Andreas Gampe | bc4d218 | 2016-02-22 10:03:12 -0800 | [diff] [blame] | 70 | kTransactionLogLock, |
Mathieu Chartier | 673ed3d | 2015-08-28 14:56:43 -0700 | [diff] [blame] | 71 | kJniWeakGlobalsLock, |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 72 | kReferenceQueueSoftReferencesLock, |
| 73 | kReferenceQueuePhantomReferencesLock, |
| 74 | kReferenceQueueFinalizerReferencesLock, |
| 75 | kReferenceQueueWeakReferencesLock, |
| 76 | kReferenceQueueClearedReferencesLock, |
| 77 | kReferenceProcessorLock, |
David Srbecky | 5cc349f | 2015-12-18 15:04:48 +0000 | [diff] [blame] | 78 | kJitDebugInterfaceLock, |
Mathieu Chartier | e5f13e5 | 2015-02-24 09:37:21 -0800 | [diff] [blame] | 79 | kJitCodeCacheLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 80 | kAllocSpaceLock, |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 81 | kBumpPointerSpaceBlockLock, |
Mathieu Chartier | c785344 | 2015-03-27 14:35:38 -0700 | [diff] [blame] | 82 | kArenaPoolLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 83 | kDexFileMethodInlinerLock, |
| 84 | kDexFileToMethodInlinerMapLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 85 | kInternTableLock, |
Vladimir Marko | 3f5838d | 2014-08-07 18:07:18 +0100 | [diff] [blame] | 86 | kOatFileSecondaryLookupLock, |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 87 | kOatFileCountLock, |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 88 | kOatFileManagerLock, |
Andreas Gampe | 7526d78 | 2015-06-22 22:53:45 -0700 | [diff] [blame] | 89 | kTracingUniqueMethodsLock, |
| 90 | kTracingStreamingLock, |
Mathieu Chartier | b8aa1e4 | 2016-04-05 14:36:57 -0700 | [diff] [blame^] | 91 | kDeoptimizedMethodsLock, |
| 92 | kClassLoaderClassesLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 93 | kDefaultMutexLevel, |
| 94 | kMarkSweepLargeObjectLock, |
| 95 | kPinTableLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 96 | kJdwpObjectRegistryLock, |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 97 | kModifyLdtLock, |
| 98 | kAllocatedThreadIdsLock, |
Andreas Gampe | 7424081 | 2014-04-17 10:35:09 -0700 | [diff] [blame] | 99 | kMonitorPoolLock, |
bowen_lai | 2435a43 | 2015-03-13 14:34:40 +0800 | [diff] [blame] | 100 | kMethodVerifiersLock, |
Mathieu Chartier | b8aa1e4 | 2016-04-05 14:36:57 -0700 | [diff] [blame^] | 101 | kClassLinkerClassesLock, // TODO rename. |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 102 | kBreakpointLock, |
| 103 | kMonitorLock, |
Mathieu Chartier | 440e4ce | 2014-03-31 16:36:35 -0700 | [diff] [blame] | 104 | kMonitorListLock, |
Ian Rogers | 68d8b42 | 2014-07-17 11:09:10 -0700 | [diff] [blame] | 105 | kJniLoadLibraryLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 106 | kThreadListLock, |
Brian Carlstrom | 306db81 | 2014-09-05 13:01:41 -0700 | [diff] [blame] | 107 | kAllocTrackerLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 108 | kDeoptimizationLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 109 | kProfilerLock, |
Sebastien Hertz | 4e5b208 | 2015-03-24 19:03:40 +0100 | [diff] [blame] | 110 | kJdwpShutdownLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 111 | kJdwpEventListLock, |
| 112 | kJdwpAttachLock, |
| 113 | kJdwpStartLock, |
| 114 | kRuntimeShutdownLock, |
Jeff Hao | 69dbec6 | 2014-09-15 18:03:41 -0700 | [diff] [blame] | 115 | kTraceLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 116 | kHeapBitmapLock, |
| 117 | kMutatorLock, |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 118 | kInstrumentEntrypointsLock, |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 119 | kZygoteCreationLock, |
| 120 | |
| 121 | kLockLevelCount // Must come last. |
| 122 | }; |
| 123 | std::ostream& operator<<(std::ostream& os, const LockLevel& rhs); |
| 124 | |
Brian Carlstrom | 2e250c8 | 2013-08-14 18:08:52 -0700 | [diff] [blame] | 125 | const bool kDebugLocking = kIsDebugBuild; |
Ian Rogers | 25fd14b | 2012-09-05 10:56:38 -0700 | [diff] [blame] | 126 | |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 127 | // Record Log contention information, dumpable via SIGQUIT. |
| 128 | #ifdef ART_USE_FUTEXES |
Jeff Hao | 08f2e7b | 2013-09-09 16:44:02 -0700 | [diff] [blame] | 129 | // To enable lock contention logging, set this to true. |
| 130 | const bool kLogLockContentions = false; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 131 | #else |
| 132 | // Keep this false as lock contention logging is supported only with |
| 133 | // futex. |
| 134 | const bool kLogLockContentions = false; |
| 135 | #endif |
Ian Rogers | d9c4fc9 | 2013-10-01 19:45:43 -0700 | [diff] [blame] | 136 | const size_t kContentionLogSize = 4; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 137 | const size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0; |
| 138 | const size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0; |
| 139 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 140 | // Base class for all Mutex implementations |
| 141 | class BaseMutex { |
| 142 | public: |
Ian Rogers | bab7496 | 2013-04-19 10:04:10 -0700 | [diff] [blame] | 143 | const char* GetName() const { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 144 | return name_; |
| 145 | } |
| 146 | |
| 147 | virtual bool IsMutex() const { return false; } |
| 148 | virtual bool IsReaderWriterMutex() const { return false; } |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 149 | virtual bool IsMutatorMutex() const { return false; } |
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 | virtual void Dump(std::ostream& os) const = 0; |
| 152 | |
| 153 | static void DumpAll(std::ostream& os); |
| 154 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 155 | protected: |
| 156 | friend class ConditionVariable; |
| 157 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 158 | BaseMutex(const char* name, LockLevel level); |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 159 | virtual ~BaseMutex(); |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 160 | void RegisterAsLocked(Thread* self); |
| 161 | void RegisterAsUnlocked(Thread* self); |
| 162 | void CheckSafeToWait(Thread* self); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 163 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 164 | friend class ScopedContentionRecorder; |
| 165 | |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 166 | 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] | 167 | void DumpContention(std::ostream& os) const; |
| 168 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 169 | const LockLevel level_; // Support for lock hierarchy. |
Ian Rogers | bab7496 | 2013-04-19 10:04:10 -0700 | [diff] [blame] | 170 | const char* const name_; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 171 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 172 | // A log entry that records contention but makes no guarantee that either tid will be held live. |
| 173 | struct ContentionLogEntry { |
| 174 | ContentionLogEntry() : blocked_tid(0), owner_tid(0) {} |
| 175 | uint64_t blocked_tid; |
| 176 | uint64_t owner_tid; |
| 177 | AtomicInteger count; |
| 178 | }; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 179 | struct ContentionLogData { |
| 180 | ContentionLogEntry contention_log[kContentionLogSize]; |
| 181 | // The next entry in the contention log to be updated. Value ranges from 0 to |
| 182 | // kContentionLogSize - 1. |
| 183 | AtomicInteger cur_content_log_entry; |
| 184 | // Number of times the Mutex has been contended. |
| 185 | AtomicInteger contention_count; |
| 186 | // Sum of time waited by all contenders in ns. |
Ian Rogers | 37f3c96 | 2014-07-17 11:25:30 -0700 | [diff] [blame] | 187 | Atomic<uint64_t> wait_time; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 188 | void AddToWaitTime(uint64_t value); |
| 189 | ContentionLogData() : wait_time(0) {} |
| 190 | }; |
Ian Rogers | 3e5cf30 | 2014-05-20 16:40:37 -0700 | [diff] [blame] | 191 | ContentionLogData contention_log_data_[kContentionLogDataSize]; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 192 | |
| 193 | public: |
| 194 | bool HasEverContended() const { |
| 195 | if (kLogLockContentions) { |
Ian Rogers | 3e5cf30 | 2014-05-20 16:40:37 -0700 | [diff] [blame] | 196 | return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0; |
Hiroshi Yamauchi | 1afde13 | 2013-08-06 17:09:30 -0700 | [diff] [blame] | 197 | } |
| 198 | return false; |
| 199 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 200 | }; |
| 201 | |
| 202 | // A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain |
| 203 | // exclusive access to what it guards. A Mutex can be in one of two states: |
| 204 | // - Free - not owned by any thread, |
| 205 | // - Exclusive - owned by a single thread. |
| 206 | // |
| 207 | // The effect of locking and unlocking operations on the state is: |
| 208 | // State | ExclusiveLock | ExclusiveUnlock |
| 209 | // ------------------------------------------- |
| 210 | // Free | Exclusive | error |
| 211 | // Exclusive | Block* | Free |
| 212 | // * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in |
| 213 | // an error. Being non-reentrant simplifies Waiting on ConditionVariables. |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 214 | std::ostream& operator<<(std::ostream& os, const Mutex& mu); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 215 | class LOCKABLE Mutex : public BaseMutex { |
| 216 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 217 | explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false); |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 218 | ~Mutex(); |
| 219 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 220 | virtual bool IsMutex() const { return true; } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 221 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 222 | // Block until mutex is free then acquire exclusive access. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 223 | void ExclusiveLock(Thread* self) ACQUIRE(); |
| 224 | void Lock(Thread* self) ACQUIRE() { ExclusiveLock(self); } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 225 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 226 | // Returns true if acquires exclusive access, false otherwise. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 227 | bool ExclusiveTryLock(Thread* self) TRY_ACQUIRE(true); |
| 228 | bool TryLock(Thread* self) TRY_ACQUIRE(true) { return ExclusiveTryLock(self); } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 229 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 230 | // Release exclusive access. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 231 | void ExclusiveUnlock(Thread* self) RELEASE(); |
| 232 | void Unlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 233 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 234 | // Is the current thread the exclusive holder of the Mutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 235 | bool IsExclusiveHeld(const Thread* self) const; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 236 | |
| 237 | // Assert that the Mutex is exclusively held by the current thread. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 238 | void AssertExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(this) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 239 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 240 | CHECK(IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 241 | } |
| 242 | } |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 243 | void AssertHeld(const Thread* self) ASSERT_CAPABILITY(this) { AssertExclusiveHeld(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 244 | |
| 245 | // Assert that the Mutex is not held by the current thread. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 246 | void AssertNotHeldExclusive(const Thread* self) ASSERT_CAPABILITY(!*this) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 247 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 248 | CHECK(!IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 249 | } |
| 250 | } |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 251 | void AssertNotHeld(const Thread* self) ASSERT_CAPABILITY(!*this) { |
| 252 | AssertNotHeldExclusive(self); |
| 253 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 254 | |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 255 | // Id associated with exclusive owner. No memory ordering semantics if called from a thread other |
| 256 | // than the owner. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 257 | uint64_t GetExclusiveOwnerTid() const; |
| 258 | |
| 259 | // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld. |
| 260 | unsigned int GetDepth() const { |
| 261 | return recursion_count_; |
| 262 | } |
Elliott Hughes | accd83d | 2011-10-17 14:25:58 -0700 | [diff] [blame] | 263 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 264 | virtual void Dump(std::ostream& os) const; |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 265 | |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 266 | // For negative capabilities in clang annotations. |
| 267 | const Mutex& operator!() const { return *this; } |
| 268 | |
Elliott Hughes | accd83d | 2011-10-17 14:25:58 -0700 | [diff] [blame] | 269 | private: |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 270 | #if ART_USE_FUTEXES |
| 271 | // 0 is unheld, 1 is held. |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 272 | AtomicInteger state_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 273 | // Exclusive owner. |
| 274 | volatile uint64_t exclusive_owner_; |
| 275 | // Number of waiting contenders. |
Ian Rogers | b122a4b | 2013-11-19 18:00:50 -0800 | [diff] [blame] | 276 | AtomicInteger num_contenders_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 277 | #else |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 278 | pthread_mutex_t mutex_; |
Ian Rogers | c5f1773 | 2014-06-05 20:48:42 -0700 | [diff] [blame] | 279 | volatile uint64_t exclusive_owner_; // Guarded by mutex_. |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 280 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 281 | const bool recursive_; // Can the lock be recursively held? |
| 282 | unsigned int recursion_count_; |
Elliott Hughes | f149843 | 2012-03-28 19:34:27 -0700 | [diff] [blame] | 283 | friend class ConditionVariable; |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 284 | DISALLOW_COPY_AND_ASSIGN(Mutex); |
| 285 | }; |
| 286 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 287 | // A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex. |
| 288 | // Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader) |
| 289 | // access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a |
| 290 | // condition variable. A ReaderWriterMutex can be in one of three states: |
| 291 | // - Free - not owned by any thread, |
| 292 | // - Exclusive - owned by a single thread, |
| 293 | // - Shared(n) - shared amongst n threads. |
| 294 | // |
| 295 | // The effect of locking and unlocking operations on the state is: |
| 296 | // |
| 297 | // State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock |
| 298 | // ---------------------------------------------------------------------------- |
| 299 | // Free | Exclusive | error | SharedLock(1) | error |
| 300 | // Exclusive | Block | Free | Block | error |
| 301 | // Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free |
| 302 | // * for large values of n the SharedLock may block. |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 303 | std::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu); |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 304 | class SHARED_LOCKABLE ReaderWriterMutex : public BaseMutex { |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 305 | public: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 306 | explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 307 | ~ReaderWriterMutex(); |
| 308 | |
| 309 | virtual bool IsReaderWriterMutex() const { return true; } |
| 310 | |
| 311 | // Block until ReaderWriterMutex is free then acquire exclusive access. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 312 | void ExclusiveLock(Thread* self) ACQUIRE(); |
| 313 | void WriterLock(Thread* self) ACQUIRE() { ExclusiveLock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 314 | |
| 315 | // Release exclusive access. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 316 | void ExclusiveUnlock(Thread* self) RELEASE(); |
| 317 | void WriterUnlock(Thread* self) RELEASE() { ExclusiveUnlock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 318 | |
| 319 | // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success |
| 320 | // or false if timeout is reached. |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 321 | #if HAVE_TIMED_RWLOCK |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 322 | bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 323 | EXCLUSIVE_TRYLOCK_FUNCTION(true); |
Ian Rogers | 66aee5c | 2012-08-15 17:17:47 -0700 | [diff] [blame] | 324 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 325 | |
| 326 | // Block until ReaderWriterMutex is shared or free then acquire a share on the access. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 327 | void SharedLock(Thread* self) ACQUIRE_SHARED() ALWAYS_INLINE; |
| 328 | void ReaderLock(Thread* self) ACQUIRE_SHARED() { SharedLock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 329 | |
| 330 | // Try to acquire share of ReaderWriterMutex. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 331 | bool SharedTryLock(Thread* self) SHARED_TRYLOCK_FUNCTION(true); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 332 | |
| 333 | // Release a share of the access. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 334 | void SharedUnlock(Thread* self) RELEASE_SHARED() ALWAYS_INLINE; |
| 335 | void ReaderUnlock(Thread* self) RELEASE_SHARED() { SharedUnlock(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 336 | |
| 337 | // Is the current thread the exclusive holder of the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 338 | bool IsExclusiveHeld(const Thread* self) const; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 339 | |
| 340 | // Assert the current thread has exclusive access to the ReaderWriterMutex. |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 341 | void AssertExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(this) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 342 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 343 | CHECK(IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 344 | } |
| 345 | } |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 346 | void AssertWriterHeld(const Thread* self) ASSERT_CAPABILITY(this) { AssertExclusiveHeld(self); } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 347 | |
| 348 | // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex. |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 349 | void AssertNotExclusiveHeld(const Thread* self) ASSERT_CAPABILITY(!this) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 350 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | e3359f7 | 2013-06-11 15:14:11 -0700 | [diff] [blame] | 351 | CHECK(!IsExclusiveHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 352 | } |
| 353 | } |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 354 | void AssertNotWriterHeld(const Thread* self) ASSERT_CAPABILITY(!this) { |
| 355 | AssertNotExclusiveHeld(self); |
| 356 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 357 | |
| 358 | // Is the current thread a shared holder of the ReaderWriterMutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 359 | bool IsSharedHeld(const Thread* self) const; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 360 | |
| 361 | // Assert the current thread has shared access to the ReaderWriterMutex. |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 362 | void AssertSharedHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 363 | if (kDebugLocking && (gAborting == 0)) { |
Mathieu Chartier | 2cebb24 | 2015-04-21 16:50:40 -0700 | [diff] [blame] | 364 | // TODO: we can only assert this well when self != null. |
| 365 | CHECK(IsSharedHeld(self) || self == nullptr) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 366 | } |
| 367 | } |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 368 | void AssertReaderHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(this) { |
| 369 | AssertSharedHeld(self); |
| 370 | } |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 371 | |
| 372 | // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive |
| 373 | // mode. |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 374 | void AssertNotHeld(const Thread* self) ASSERT_SHARED_CAPABILITY(!this) { |
Nicolas Geoffray | db97871 | 2014-12-09 13:33:38 +0000 | [diff] [blame] | 375 | if (kDebugLocking && (gAborting == 0)) { |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 376 | CHECK(!IsSharedHeld(self)) << *this; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 377 | } |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 378 | } |
| 379 | |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 380 | // Id associated with exclusive owner. No memory ordering semantics if called from a thread other |
| 381 | // than the owner. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 382 | uint64_t GetExclusiveOwnerTid() const; |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 383 | |
Ian Rogers | 56edc43 | 2013-01-18 16:51:51 -0800 | [diff] [blame] | 384 | virtual void Dump(std::ostream& os) const; |
Ian Rogers | 01ae580 | 2012-09-28 16:14:01 -0700 | [diff] [blame] | 385 | |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 386 | // For negative capabilities in clang annotations. |
| 387 | const ReaderWriterMutex& operator!() const { return *this; } |
| 388 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 389 | private: |
Ian Rogers | 51d212e | 2014-10-23 17:48:20 -0700 | [diff] [blame] | 390 | #if ART_USE_FUTEXES |
Ian Rogers | cf7f191 | 2014-10-22 22:06:39 -0700 | [diff] [blame] | 391 | // Out-of-inline path for handling contention for a SharedLock. |
| 392 | void HandleSharedLockContention(Thread* self, int32_t cur_state); |
| 393 | |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 394 | // -1 implies held exclusive, +ve shared held by state_ many owners. |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 395 | AtomicInteger state_; |
| 396 | // Exclusive owner. Modification guarded by this mutex. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 397 | volatile uint64_t exclusive_owner_; |
Ian Rogers | c719069 | 2014-07-08 23:50:26 -0700 | [diff] [blame] | 398 | // Number of contenders waiting for a reader share. |
| 399 | AtomicInteger num_pending_readers_; |
| 400 | // Number of contenders waiting to be the writer. |
Ian Rogers | b122a4b | 2013-11-19 18:00:50 -0800 | [diff] [blame] | 401 | AtomicInteger num_pending_writers_; |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 402 | #else |
| 403 | pthread_rwlock_t rwlock_; |
Ian Rogers | c5f1773 | 2014-06-05 20:48:42 -0700 | [diff] [blame] | 404 | volatile uint64_t exclusive_owner_; // Guarded by rwlock_. |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 405 | #endif |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 406 | DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex); |
| 407 | }; |
| 408 | |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 409 | // MutatorMutex is a special kind of ReaderWriterMutex created specifically for the |
| 410 | // Locks::mutator_lock_ mutex. The behaviour is identical to the ReaderWriterMutex except that |
| 411 | // thread state changes also play a part in lock ownership. The mutator_lock_ will not be truly |
| 412 | // held by any mutator threads. However, a thread in the kRunnable state is considered to have |
| 413 | // shared ownership of the mutator lock and therefore transitions in and out of the kRunnable |
| 414 | // state have associated implications on lock ownership. Extra methods to handle the state |
| 415 | // transitions have been added to the interface but are only accessible to the methods dealing |
| 416 | // with state transitions. The thread state and flags attributes are used to ensure thread state |
| 417 | // transitions are consistent with the permitted behaviour of the mutex. |
| 418 | // |
| 419 | // *) The most important consequence of this behaviour is that all threads must be in one of the |
| 420 | // suspended states before exclusive ownership of the mutator mutex is sought. |
| 421 | // |
| 422 | std::ostream& operator<<(std::ostream& os, const MutatorMutex& mu); |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 423 | class SHARED_LOCKABLE MutatorMutex : public ReaderWriterMutex { |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 424 | public: |
| 425 | explicit MutatorMutex(const char* name, LockLevel level = kDefaultMutexLevel) |
| 426 | : ReaderWriterMutex(name, level) {} |
| 427 | ~MutatorMutex() {} |
| 428 | |
| 429 | virtual bool IsMutatorMutex() const { return true; } |
| 430 | |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 431 | // For negative capabilities in clang annotations. |
| 432 | const MutatorMutex& operator!() const { return *this; } |
| 433 | |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 434 | private: |
| 435 | friend class Thread; |
| 436 | void TransitionFromRunnableToSuspended(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE; |
| 437 | void TransitionFromSuspendedToRunnable(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE; |
| 438 | |
| 439 | DISALLOW_COPY_AND_ASSIGN(MutatorMutex); |
| 440 | }; |
| 441 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 442 | // ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually |
| 443 | // (Signal) or all at once (Broadcast). |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 444 | class ConditionVariable { |
| 445 | public: |
Roland Levillain | 3887c46 | 2015-08-12 18:15:42 +0100 | [diff] [blame] | 446 | ConditionVariable(const char* name, Mutex& mutex); |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 447 | ~ConditionVariable(); |
| 448 | |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 449 | void Broadcast(Thread* self); |
| 450 | void Signal(Thread* self); |
| 451 | // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their |
| 452 | // pointer copy, thereby defeating annotalysis. |
| 453 | void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS; |
Ian Rogers | 7b078e8 | 2014-09-10 14:44:24 -0700 | [diff] [blame] | 454 | 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] | 455 | // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held |
| 456 | // when waiting. |
| 457 | // TODO: remove this. |
| 458 | void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS; |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 459 | |
| 460 | private: |
Ian Rogers | 23055dc | 2013-04-18 16:29:16 -0700 | [diff] [blame] | 461 | const char* const name_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 462 | // The Mutex being used by waiters. It is an error to mix condition variables between different |
| 463 | // Mutexes. |
| 464 | Mutex& guard_; |
| 465 | #if ART_USE_FUTEXES |
| 466 | // 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] | 467 | // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_ |
| 468 | // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait |
| 469 | // without guard_ held. |
Ian Rogers | b122a4b | 2013-11-19 18:00:50 -0800 | [diff] [blame] | 470 | AtomicInteger sequence_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 471 | // 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] | 472 | // waiters may have been requeued onto guard_. Guarded by guard_. |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 473 | volatile int32_t num_waiters_; |
Ian Rogers | c604d73 | 2012-10-14 16:09:54 -0700 | [diff] [blame] | 474 | #else |
| 475 | pthread_cond_t cond_; |
| 476 | #endif |
Elliott Hughes | 5f79133 | 2011-09-15 17:45:30 -0700 | [diff] [blame] | 477 | DISALLOW_COPY_AND_ASSIGN(ConditionVariable); |
| 478 | }; |
| 479 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 480 | // Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it |
| 481 | // upon destruction. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 482 | class SCOPED_CAPABILITY MutexLock { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 483 | public: |
Roland Levillain | 3887c46 | 2015-08-12 18:15:42 +0100 | [diff] [blame] | 484 | MutexLock(Thread* self, Mutex& mu) ACQUIRE(mu) : self_(self), mu_(mu) { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 485 | mu_.ExclusiveLock(self_); |
| 486 | } |
| 487 | |
Mathieu Chartier | 4e2cb09 | 2015-07-22 16:17:51 -0700 | [diff] [blame] | 488 | ~MutexLock() RELEASE() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 489 | mu_.ExclusiveUnlock(self_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 490 | } |
| 491 | |
| 492 | private: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 493 | Thread* const self_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 494 | Mutex& mu_; |
| 495 | DISALLOW_COPY_AND_ASSIGN(MutexLock); |
| 496 | }; |
| 497 | // 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] | 498 | #define MutexLock(x) static_assert(0, "MutexLock declaration missing variable name") |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 499 | |
| 500 | // Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon |
| 501 | // construction and releases it upon destruction. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 502 | class SCOPED_CAPABILITY ReaderMutexLock { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 503 | public: |
Roland Levillain | 3887c46 | 2015-08-12 18:15:42 +0100 | [diff] [blame] | 504 | ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) ACQUIRE(mu) : |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 505 | self_(self), mu_(mu) { |
| 506 | mu_.SharedLock(self_); |
| 507 | } |
| 508 | |
Mathieu Chartier | 4e2cb09 | 2015-07-22 16:17:51 -0700 | [diff] [blame] | 509 | ~ReaderMutexLock() RELEASE() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 510 | mu_.SharedUnlock(self_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 511 | } |
| 512 | |
| 513 | private: |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 514 | Thread* const self_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 515 | ReaderWriterMutex& mu_; |
| 516 | DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock); |
| 517 | }; |
| 518 | // Catch bug where variable name is omitted. "ReaderMutexLock (lock);" instead of |
| 519 | // "ReaderMutexLock mu(lock)". |
Andreas Gampe | 575e78c | 2014-11-03 23:41:03 -0800 | [diff] [blame] | 520 | #define ReaderMutexLock(x) static_assert(0, "ReaderMutexLock declaration missing variable name") |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 521 | |
| 522 | // Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon |
| 523 | // construction and releases it upon destruction. |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 524 | class SCOPED_CAPABILITY WriterMutexLock { |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 525 | public: |
Roland Levillain | 3887c46 | 2015-08-12 18:15:42 +0100 | [diff] [blame] | 526 | WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 527 | self_(self), mu_(mu) { |
| 528 | mu_.ExclusiveLock(self_); |
| 529 | } |
| 530 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 531 | ~WriterMutexLock() UNLOCK_FUNCTION() { |
Ian Rogers | 81d425b | 2012-09-27 16:03:43 -0700 | [diff] [blame] | 532 | mu_.ExclusiveUnlock(self_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 533 | } |
| 534 | |
| 535 | private: |
Ian Rogers | 50b35e2 | 2012-10-04 10:09:15 -0700 | [diff] [blame] | 536 | Thread* const self_; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 537 | ReaderWriterMutex& mu_; |
| 538 | DISALLOW_COPY_AND_ASSIGN(WriterMutexLock); |
| 539 | }; |
| 540 | // Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of |
| 541 | // "WriterMutexLock mu(lock)". |
Andreas Gampe | 575e78c | 2014-11-03 23:41:03 -0800 | [diff] [blame] | 542 | #define WriterMutexLock(x) static_assert(0, "WriterMutexLock declaration missing variable name") |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 543 | |
Mathieu Chartier | 4e2cb09 | 2015-07-22 16:17:51 -0700 | [diff] [blame] | 544 | // For StartNoThreadSuspension and EndNoThreadSuspension. |
| 545 | class CAPABILITY("role") Role { |
| 546 | public: |
| 547 | void Acquire() ACQUIRE() {} |
| 548 | void Release() RELEASE() {} |
| 549 | const Role& operator!() const { return *this; } |
| 550 | }; |
| 551 | |
| 552 | class Uninterruptible : public Role { |
| 553 | }; |
| 554 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 555 | // Global mutexes corresponding to the levels above. |
| 556 | class Locks { |
| 557 | public: |
| 558 | static void Init(); |
Mathieu Chartier | 91e5669 | 2015-03-03 13:51:04 -0800 | [diff] [blame] | 559 | static void InitConditions() NO_THREAD_SAFETY_ANALYSIS; // Condition variables. |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 560 | // Guards allocation entrypoint instrumenting. |
Ian Rogers | 4ad5cd3 | 2014-11-11 23:08:07 -0800 | [diff] [blame] | 561 | static Mutex* instrument_entrypoints_lock_; |
Mathieu Chartier | 9ef78b5 | 2014-09-25 17:03:12 -0700 | [diff] [blame] | 562 | |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 563 | // A barrier is used to synchronize the GC/Debugger thread with mutator threads. When GC/Debugger |
| 564 | // thread wants to suspend all mutator threads, it needs to wait for all mutator threads to pass |
| 565 | // a barrier. Threads that are already suspended will get their barrier passed by the GC/Debugger |
| 566 | // thread; threads in the runnable state will pass the barrier when they transit to the suspended |
| 567 | // state. GC/Debugger thread will be woken up when all mutator threads are suspended. |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 568 | // |
| 569 | // Thread suspension: |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 570 | // mutator thread | GC/Debugger |
| 571 | // .. running .. | .. running .. |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 572 | // .. running .. | Request thread suspension by: |
| 573 | // .. running .. | - acquiring thread_suspend_count_lock_ |
| 574 | // .. running .. | - incrementing Thread::suspend_count_ on |
| 575 | // .. running .. | all mutator threads |
| 576 | // .. running .. | - releasing thread_suspend_count_lock_ |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 577 | // .. running .. | Block wait for all threads to pass a barrier |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 578 | // Poll Thread::suspend_count_ and enter full | .. blocked .. |
| 579 | // suspend code. | .. blocked .. |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 580 | // Change state to kSuspended (pass the barrier) | Wake up when all threads pass the barrier |
| 581 | // x: Acquire thread_suspend_count_lock_ | .. running .. |
| 582 | // while Thread::suspend_count_ > 0 | .. running .. |
| 583 | // - wait on Thread::resume_cond_ | .. running .. |
| 584 | // (releases thread_suspend_count_lock_) | .. running .. |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 585 | // .. waiting .. | Request thread resumption by: |
| 586 | // .. waiting .. | - acquiring thread_suspend_count_lock_ |
| 587 | // .. waiting .. | - decrementing Thread::suspend_count_ on |
| 588 | // .. waiting .. | all mutator threads |
| 589 | // .. waiting .. | - notifying on Thread::resume_cond_ |
| 590 | // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_ |
| 591 | // Release thread_suspend_count_lock_ | .. running .. |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 592 | // Change to kRunnable | .. running .. |
| 593 | // - this uses a CAS operation to ensure the | .. running .. |
| 594 | // suspend request flag isn't raised as the | .. running .. |
| 595 | // state is changed | .. running .. |
| 596 | // - if the CAS operation fails then goto x | .. running .. |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 597 | // .. running .. | .. running .. |
Yu Li | eac4424 | 2015-06-29 10:50:03 +0800 | [diff] [blame] | 598 | static MutatorMutex* mutator_lock_ ACQUIRED_AFTER(instrument_entrypoints_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 599 | |
| 600 | // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap. |
| 601 | static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_); |
| 602 | |
| 603 | // Guards shutdown of the runtime. |
| 604 | static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_); |
| 605 | |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 606 | // Guards background profiler global state. |
| 607 | static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_); |
| 608 | |
| 609 | // Guards trace (ie traceview) requests. |
| 610 | static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_); |
| 611 | |
Brian Carlstrom | 306db81 | 2014-09-05 13:01:41 -0700 | [diff] [blame] | 612 | // Guards debugger recent allocation records. |
| 613 | static Mutex* alloc_tracker_lock_ ACQUIRED_AFTER(trace_lock_); |
| 614 | |
| 615 | // Guards updates to instrumentation to ensure mutual exclusion of |
| 616 | // events like deoptimization requests. |
| 617 | // TODO: improve name, perhaps instrumentation_update_lock_. |
| 618 | static Mutex* deoptimization_lock_ ACQUIRED_AFTER(alloc_tracker_lock_); |
| 619 | |
Jeff Hao | a2c3864 | 2015-09-17 17:29:01 -0700 | [diff] [blame] | 620 | // Guards String initializer register map in interpreter. |
| 621 | static Mutex* interpreter_string_init_map_lock_ ACQUIRED_AFTER(deoptimization_lock_); |
| 622 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 623 | // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads |
| 624 | // attaching and detaching. |
Jeff Hao | a2c3864 | 2015-09-17 17:29:01 -0700 | [diff] [blame] | 625 | static Mutex* thread_list_lock_ ACQUIRED_AFTER(interpreter_string_init_map_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 626 | |
Mathieu Chartier | 91e5669 | 2015-03-03 13:51:04 -0800 | [diff] [blame] | 627 | // Signaled when threads terminate. Used to determine when all non-daemons have terminated. |
| 628 | static ConditionVariable* thread_exit_cond_ GUARDED_BY(Locks::thread_list_lock_); |
| 629 | |
Ian Rogers | 68d8b42 | 2014-07-17 11:09:10 -0700 | [diff] [blame] | 630 | // Guards maintaining loading library data structures. |
| 631 | static Mutex* jni_libraries_lock_ ACQUIRED_AFTER(thread_list_lock_); |
| 632 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 633 | // Guards breakpoints. |
Sebastien Hertz | ed2be17 | 2014-08-19 15:33:43 +0200 | [diff] [blame] | 634 | static ReaderWriterMutex* breakpoint_lock_ ACQUIRED_AFTER(jni_libraries_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 635 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 636 | // Guards lists of classes within the class linker. |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 637 | static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 638 | |
| 639 | // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code |
| 640 | // doesn't try to hold a higher level Mutex. |
Mathieu Chartier | 12d625f | 2015-03-13 11:33:37 -0700 | [diff] [blame] | 641 | #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_) |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 642 | |
Andreas Gampe | 7424081 | 2014-04-17 10:35:09 -0700 | [diff] [blame] | 643 | static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_); |
| 644 | |
Chao-ying Fu | 9e36931 | 2014-05-21 11:20:52 -0700 | [diff] [blame] | 645 | // Guard the allocation/deallocation of thread ids. |
Andreas Gampe | 7424081 | 2014-04-17 10:35:09 -0700 | [diff] [blame] | 646 | 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] | 647 | |
| 648 | // Guards modification of the LDT on x86. |
| 649 | static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_); |
| 650 | |
Mathieu Chartier | f9c6fc6 | 2015-10-07 11:44:05 -0700 | [diff] [blame] | 651 | // Guards opened oat files in OatFileManager. |
| 652 | static ReaderWriterMutex* oat_file_manager_lock_ ACQUIRED_AFTER(modify_ldt_lock_); |
| 653 | |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 654 | // Guards opened oat files in OatFileManager. |
| 655 | static ReaderWriterMutex* oat_file_count_lock_ ACQUIRED_AFTER(oat_file_manager_lock_); |
| 656 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 657 | // Guards intern table. |
Mathieu Chartier | e58991b | 2015-10-13 07:59:34 -0700 | [diff] [blame] | 658 | static Mutex* intern_table_lock_ ACQUIRED_AFTER(oat_file_count_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 659 | |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 660 | // Guards reference processor. |
| 661 | static Mutex* reference_processor_lock_ ACQUIRED_AFTER(intern_table_lock_); |
| 662 | |
| 663 | // Guards cleared references queue. |
| 664 | static Mutex* reference_queue_cleared_references_lock_ ACQUIRED_AFTER(reference_processor_lock_); |
| 665 | |
| 666 | // Guards weak references queue. |
| 667 | static Mutex* reference_queue_weak_references_lock_ ACQUIRED_AFTER(reference_queue_cleared_references_lock_); |
| 668 | |
| 669 | // Guards finalizer references queue. |
| 670 | static Mutex* reference_queue_finalizer_references_lock_ ACQUIRED_AFTER(reference_queue_weak_references_lock_); |
| 671 | |
| 672 | // Guards phantom references queue. |
| 673 | static Mutex* reference_queue_phantom_references_lock_ ACQUIRED_AFTER(reference_queue_finalizer_references_lock_); |
| 674 | |
| 675 | // Guards soft references queue. |
| 676 | static Mutex* reference_queue_soft_references_lock_ ACQUIRED_AFTER(reference_queue_phantom_references_lock_); |
| 677 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 678 | // Have an exclusive aborting thread. |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 679 | static Mutex* abort_lock_ ACQUIRED_AFTER(reference_queue_soft_references_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 680 | |
| 681 | // Allow mutual exclusion when manipulating Thread::suspend_count_. |
| 682 | // TODO: Does the trade-off of a per-thread lock make sense? |
| 683 | static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_); |
| 684 | |
| 685 | // One unexpected signal at a time lock. |
| 686 | static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_); |
| 687 | |
Hiroshi Yamauchi | 3eed93d | 2014-06-04 11:43:59 -0700 | [diff] [blame] | 688 | // Guards the maps in mem_map. |
| 689 | static Mutex* mem_maps_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); |
| 690 | |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 691 | // Have an exclusive logging thread. |
| 692 | static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_); |
Igor Murashkin | e2facc5 | 2015-07-10 13:49:08 -0700 | [diff] [blame] | 693 | |
| 694 | // Allow reader-writer mutual exclusion on the boxed table of lambda objects. |
| 695 | // TODO: this should be a RW mutex lock, except that ConditionVariables don't work with it. |
| 696 | static Mutex* lambda_table_lock_ ACQUIRED_AFTER(mutator_lock_); |
Ian Rogers | 719d1a3 | 2014-03-06 12:13:39 -0800 | [diff] [blame] | 697 | }; |
| 698 | |
Mathieu Chartier | 4e2cb09 | 2015-07-22 16:17:51 -0700 | [diff] [blame] | 699 | class Roles { |
| 700 | public: |
Mathieu Chartier | 90ef3db | 2015-08-04 15:19:41 -0700 | [diff] [blame] | 701 | // Uninterruptible means that the thread may not become suspended. |
Mathieu Chartier | 4e2cb09 | 2015-07-22 16:17:51 -0700 | [diff] [blame] | 702 | static Uninterruptible uninterruptible_; |
| 703 | }; |
| 704 | |
Elliott Hughes | 8daa092 | 2011-09-11 13:46:25 -0700 | [diff] [blame] | 705 | } // namespace art |
| 706 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 707 | #endif // ART_RUNTIME_BASE_MUTEX_H_ |