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