blob: 91b47ca4195d186d2c248cb1ed504d4ac197c2b4 [file] [log] [blame]
Elliott Hughes8daa0922011-09-11 13:46:25 -07001/*
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 Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_BASE_MUTEX_H_
18#define ART_RUNTIME_BASE_MUTEX_H_
Elliott Hughes8daa0922011-09-11 13:46:25 -070019
20#include <pthread.h>
Brian Carlstromcd74c4b2012-01-23 13:21:00 -080021#include <stdint.h>
Elliott Hughesffb465f2012-03-01 18:46:05 -080022
23#include <iosfwd>
Elliott Hughes8daa0922011-09-11 13:46:25 -070024#include <string>
25
Ian Rogersef7d42f2014-01-06 12:55:46 -080026#include "atomic.h"
Elliott Hughes07ed66b2012-12-12 18:34:25 -080027#include "base/logging.h"
Elliott Hughes76160052012-12-12 16:31:20 -080028#include "base/macros.h"
Ian Rogers00f7d0e2012-07-19 15:28:27 -070029#include "globals.h"
Ian Rogers81d425b2012-09-27 16:03:43 -070030
Ian Rogersab470162012-09-29 23:06:53 -070031#if defined(__APPLE__)
Ian Rogers81d425b2012-09-27 16:03:43 -070032#define ART_USE_FUTEXES 0
Ian Rogersab470162012-09-29 23:06:53 -070033#else
Chris Dearmanc0141782013-11-14 17:29:21 -080034#define ART_USE_FUTEXES 1
Ian Rogersab470162012-09-29 23:06:53 -070035#endif
Elliott Hughes8daa0922011-09-11 13:46:25 -070036
Ian Rogers66aee5c2012-08-15 17:17:47 -070037// 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 Hughes8daa0922011-09-11 13:46:25 -070044namespace art {
45
Ian Rogers719d1a32014-03-06 12:13:39 -080046class LOCKABLE ReaderWriterMutex;
Ian Rogers56edc432013-01-18 16:51:51 -080047class ScopedContentionRecorder;
Ian Rogers50b35e22012-10-04 10:09:15 -070048class Thread;
49
Ian Rogers719d1a32014-03-06 12:13:39 -080050// LockLevel is used to impose a lock hierarchy [1] where acquisition of a Mutex at a higher or
51// equal level to a lock a thread holds is invalid. The lock hierarchy achieves a cycle free
52// partial ordering and thereby cause deadlock situations to fail checks.
53//
54// [1] http://www.drdobbs.com/parallel/use-lock-hierarchies-to-avoid-deadlock/204801163
55enum LockLevel {
56 kLoggingLock = 0,
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -070057 kMemMapsLock,
Raghu Gandham7de77dd2014-06-13 15:16:31 -070058 kSwapMutexesLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080059 kUnexpectedSignalLock,
60 kThreadSuspendCountLock,
61 kAbortLock,
62 kJdwpSocketLock,
63 kRosAllocGlobalLock,
64 kRosAllocBracketLock,
65 kRosAllocBulkFreeLock,
66 kAllocSpaceLock,
Mathieu Chartier2d1ab0a2014-05-08 15:27:31 -070067 kReferenceProcessorLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080068 kDexFileMethodInlinerLock,
69 kDexFileToMethodInlinerMapLock,
70 kMarkSweepMarkStackLock,
71 kTransactionLogLock,
72 kInternTableLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080073 kDefaultMutexLevel,
74 kMarkSweepLargeObjectLock,
75 kPinTableLock,
76 kLoadLibraryLock,
77 kJdwpObjectRegistryLock,
Chao-ying Fu9e369312014-05-21 11:20:52 -070078 kModifyLdtLock,
79 kAllocatedThreadIdsLock,
Andreas Gampe74240812014-04-17 10:35:09 -070080 kMonitorPoolLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080081 kClassLinkerClassesLock,
82 kBreakpointLock,
83 kMonitorLock,
Mathieu Chartier440e4ce2014-03-31 16:36:35 -070084 kMonitorListLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080085 kThreadListLock,
86 kBreakpointInvokeLock,
87 kDeoptimizationLock,
88 kTraceLock,
89 kProfilerLock,
90 kJdwpEventListLock,
91 kJdwpAttachLock,
92 kJdwpStartLock,
93 kRuntimeShutdownLock,
94 kHeapBitmapLock,
95 kMutatorLock,
96 kZygoteCreationLock,
97
98 kLockLevelCount // Must come last.
99};
100std::ostream& operator<<(std::ostream& os, const LockLevel& rhs);
101
Brian Carlstrom2e250c82013-08-14 18:08:52 -0700102const bool kDebugLocking = kIsDebugBuild;
Ian Rogers25fd14b2012-09-05 10:56:38 -0700103
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700104// Record Log contention information, dumpable via SIGQUIT.
105#ifdef ART_USE_FUTEXES
Jeff Hao08f2e7b2013-09-09 16:44:02 -0700106// To enable lock contention logging, set this to true.
107const bool kLogLockContentions = false;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700108#else
109// Keep this false as lock contention logging is supported only with
110// futex.
111const bool kLogLockContentions = false;
112#endif
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700113const size_t kContentionLogSize = 4;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700114const size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0;
115const size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0;
116
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700117// Base class for all Mutex implementations
118class BaseMutex {
119 public:
Ian Rogersbab74962013-04-19 10:04:10 -0700120 const char* GetName() const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700121 return name_;
122 }
123
124 virtual bool IsMutex() const { return false; }
125 virtual bool IsReaderWriterMutex() const { return false; }
126
Ian Rogers56edc432013-01-18 16:51:51 -0800127 virtual void Dump(std::ostream& os) const = 0;
128
129 static void DumpAll(std::ostream& os);
130
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700131 protected:
132 friend class ConditionVariable;
133
Ian Rogers81d425b2012-09-27 16:03:43 -0700134 BaseMutex(const char* name, LockLevel level);
Ian Rogers56edc432013-01-18 16:51:51 -0800135 virtual ~BaseMutex();
Ian Rogers81d425b2012-09-27 16:03:43 -0700136 void RegisterAsLocked(Thread* self);
137 void RegisterAsUnlocked(Thread* self);
138 void CheckSafeToWait(Thread* self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700139
Ian Rogers56edc432013-01-18 16:51:51 -0800140 friend class ScopedContentionRecorder;
141
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700142 void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked);
Ian Rogers56edc432013-01-18 16:51:51 -0800143 void DumpContention(std::ostream& os) const;
144
Ian Rogers81d425b2012-09-27 16:03:43 -0700145 const LockLevel level_; // Support for lock hierarchy.
Ian Rogersbab74962013-04-19 10:04:10 -0700146 const char* const name_;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700147
Ian Rogers56edc432013-01-18 16:51:51 -0800148 // A log entry that records contention but makes no guarantee that either tid will be held live.
149 struct ContentionLogEntry {
150 ContentionLogEntry() : blocked_tid(0), owner_tid(0) {}
151 uint64_t blocked_tid;
152 uint64_t owner_tid;
153 AtomicInteger count;
154 };
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700155 struct ContentionLogData {
156 ContentionLogEntry contention_log[kContentionLogSize];
157 // The next entry in the contention log to be updated. Value ranges from 0 to
158 // kContentionLogSize - 1.
159 AtomicInteger cur_content_log_entry;
160 // Number of times the Mutex has been contended.
161 AtomicInteger contention_count;
162 // Sum of time waited by all contenders in ns.
163 volatile uint64_t wait_time;
164 void AddToWaitTime(uint64_t value);
165 ContentionLogData() : wait_time(0) {}
166 };
Ian Rogers3e5cf302014-05-20 16:40:37 -0700167 ContentionLogData contention_log_data_[kContentionLogDataSize];
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700168
169 public:
170 bool HasEverContended() const {
171 if (kLogLockContentions) {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700172 return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700173 }
174 return false;
175 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700176};
177
178// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain
179// exclusive access to what it guards. A Mutex can be in one of two states:
180// - Free - not owned by any thread,
181// - Exclusive - owned by a single thread.
182//
183// The effect of locking and unlocking operations on the state is:
184// State | ExclusiveLock | ExclusiveUnlock
185// -------------------------------------------
186// Free | Exclusive | error
187// Exclusive | Block* | Free
188// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in
189// an error. Being non-reentrant simplifies Waiting on ConditionVariables.
Ian Rogers01ae5802012-09-28 16:14:01 -0700190std::ostream& operator<<(std::ostream& os, const Mutex& mu);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700191class LOCKABLE Mutex : public BaseMutex {
192 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700193 explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700194 ~Mutex();
195
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700196 virtual bool IsMutex() const { return true; }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700197
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700198 // Block until mutex is free then acquire exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700199 void ExclusiveLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION();
200 void Lock(Thread* self) EXCLUSIVE_LOCK_FUNCTION() { ExclusiveLock(self); }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700201
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700202 // Returns true if acquires exclusive access, false otherwise.
Ian Rogers81d425b2012-09-27 16:03:43 -0700203 bool ExclusiveTryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true);
204 bool TryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true) { return ExclusiveTryLock(self); }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700205
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700206 // Release exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700207 void ExclusiveUnlock(Thread* self) UNLOCK_FUNCTION();
208 void Unlock(Thread* self) UNLOCK_FUNCTION() { ExclusiveUnlock(self); }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700209
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700210 // Is the current thread the exclusive holder of the Mutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700211 bool IsExclusiveHeld(const Thread* self) const;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700212
213 // Assert that the Mutex is exclusively held by the current thread.
Ian Rogers81d425b2012-09-27 16:03:43 -0700214 void AssertExclusiveHeld(const Thread* self) {
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -0700215 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700216 CHECK(IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700217 }
218 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700219 void AssertHeld(const Thread* self) { AssertExclusiveHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700220
221 // Assert that the Mutex is not held by the current thread.
Ian Rogers81d425b2012-09-27 16:03:43 -0700222 void AssertNotHeldExclusive(const Thread* self) {
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -0700223 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700224 CHECK(!IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700225 }
226 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700227 void AssertNotHeld(const Thread* self) { AssertNotHeldExclusive(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700228
229 // Id associated with exclusive owner.
230 uint64_t GetExclusiveOwnerTid() const;
231
232 // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld.
233 unsigned int GetDepth() const {
234 return recursion_count_;
235 }
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700236
Ian Rogers56edc432013-01-18 16:51:51 -0800237 virtual void Dump(std::ostream& os) const;
Ian Rogers01ae5802012-09-28 16:14:01 -0700238
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700239 private:
Ian Rogersc604d732012-10-14 16:09:54 -0700240#if ART_USE_FUTEXES
241 // 0 is unheld, 1 is held.
242 volatile int32_t state_;
243 // Exclusive owner.
244 volatile uint64_t exclusive_owner_;
245 // Number of waiting contenders.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800246 AtomicInteger num_contenders_;
Ian Rogersc604d732012-10-14 16:09:54 -0700247#else
Elliott Hughes8daa0922011-09-11 13:46:25 -0700248 pthread_mutex_t mutex_;
Ian Rogersc5f17732014-06-05 20:48:42 -0700249 volatile uint64_t exclusive_owner_; // Guarded by mutex_.
Ian Rogersc604d732012-10-14 16:09:54 -0700250#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700251 const bool recursive_; // Can the lock be recursively held?
252 unsigned int recursion_count_;
Elliott Hughesf1498432012-03-28 19:34:27 -0700253 friend class ConditionVariable;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700254 DISALLOW_COPY_AND_ASSIGN(Mutex);
255};
256
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700257// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex.
258// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader)
259// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a
260// condition variable. A ReaderWriterMutex can be in one of three states:
261// - Free - not owned by any thread,
262// - Exclusive - owned by a single thread,
263// - Shared(n) - shared amongst n threads.
264//
265// The effect of locking and unlocking operations on the state is:
266//
267// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock
268// ----------------------------------------------------------------------------
269// Free | Exclusive | error | SharedLock(1) | error
270// Exclusive | Block | Free | Block | error
271// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free
272// * for large values of n the SharedLock may block.
Ian Rogers01ae5802012-09-28 16:14:01 -0700273std::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700274class LOCKABLE ReaderWriterMutex : public BaseMutex {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700275 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700276 explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700277 ~ReaderWriterMutex();
278
279 virtual bool IsReaderWriterMutex() const { return true; }
280
281 // Block until ReaderWriterMutex is free then acquire exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700282 void ExclusiveLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION();
283 void WriterLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION() { ExclusiveLock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700284
285 // Release exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700286 void ExclusiveUnlock(Thread* self) UNLOCK_FUNCTION();
287 void WriterUnlock(Thread* self) UNLOCK_FUNCTION() { ExclusiveUnlock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700288
289 // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success
290 // or false if timeout is reached.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700291#if HAVE_TIMED_RWLOCK
Ian Rogersc604d732012-10-14 16:09:54 -0700292 bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns)
Ian Rogers81d425b2012-09-27 16:03:43 -0700293 EXCLUSIVE_TRYLOCK_FUNCTION(true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700294#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700295
296 // Block until ReaderWriterMutex is shared or free then acquire a share on the access.
Ian Rogers1ffa32f2013-02-05 18:29:08 -0800297 void SharedLock(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE;
Ian Rogers81d425b2012-09-27 16:03:43 -0700298 void ReaderLock(Thread* self) SHARED_LOCK_FUNCTION() { SharedLock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700299
300 // Try to acquire share of ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700301 bool SharedTryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700302
303 // Release a share of the access.
Ian Rogers1ffa32f2013-02-05 18:29:08 -0800304 void SharedUnlock(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE;
Ian Rogers81d425b2012-09-27 16:03:43 -0700305 void ReaderUnlock(Thread* self) UNLOCK_FUNCTION() { SharedUnlock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700306
307 // Is the current thread the exclusive holder of the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700308 bool IsExclusiveHeld(const Thread* self) const;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700309
310 // Assert the current thread has exclusive access to the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700311 void AssertExclusiveHeld(const Thread* self) {
Sebastien Hertz702a85b2013-08-05 16:37:51 +0200312 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700313 CHECK(IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700314 }
315 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700316 void AssertWriterHeld(const Thread* self) { AssertExclusiveHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700317
318 // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700319 void AssertNotExclusiveHeld(const Thread* self) {
Sebastien Hertz702a85b2013-08-05 16:37:51 +0200320 if (kDebugLocking && (gAborting == 0)) {
Ian Rogerse3359f72013-06-11 15:14:11 -0700321 CHECK(!IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700322 }
323 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700324 void AssertNotWriterHeld(const Thread* self) { AssertNotExclusiveHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700325
326 // Is the current thread a shared holder of the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700327 bool IsSharedHeld(const Thread* self) const;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700328
329 // Assert the current thread has shared access to the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700330 void AssertSharedHeld(const Thread* self) {
Sebastien Hertz702a85b2013-08-05 16:37:51 +0200331 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers23055dc2013-04-18 16:29:16 -0700332 // TODO: we can only assert this well when self != NULL.
333 CHECK(IsSharedHeld(self) || self == NULL) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700334 }
335 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700336 void AssertReaderHeld(const Thread* self) { AssertSharedHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700337
338 // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive
339 // mode.
Ian Rogers81d425b2012-09-27 16:03:43 -0700340 void AssertNotHeld(const Thread* self) {
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -0700341 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700342 CHECK(!IsSharedHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700343 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700344 }
345
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700346 // Id associated with exclusive owner.
347 uint64_t GetExclusiveOwnerTid() const;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700348
Ian Rogers56edc432013-01-18 16:51:51 -0800349 virtual void Dump(std::ostream& os) const;
Ian Rogers01ae5802012-09-28 16:14:01 -0700350
Ian Rogers81d425b2012-09-27 16:03:43 -0700351 private:
352#if ART_USE_FUTEXES
353 // -1 implies held exclusive, +ve shared held by state_ many owners.
354 volatile int32_t state_;
355 // Exclusive owner.
356 volatile uint64_t exclusive_owner_;
357 // Pending readers.
358 volatile int32_t num_pending_readers_;
359 // Pending writers.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800360 AtomicInteger num_pending_writers_;
Ian Rogers81d425b2012-09-27 16:03:43 -0700361#else
362 pthread_rwlock_t rwlock_;
Ian Rogersc5f17732014-06-05 20:48:42 -0700363 volatile uint64_t exclusive_owner_; // Guarded by rwlock_.
Ian Rogers81d425b2012-09-27 16:03:43 -0700364#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700365 DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex);
366};
367
368// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually
369// (Signal) or all at once (Broadcast).
Elliott Hughes5f791332011-09-15 17:45:30 -0700370class ConditionVariable {
371 public:
Ian Rogers23055dc2013-04-18 16:29:16 -0700372 explicit ConditionVariable(const char* name, Mutex& mutex);
Elliott Hughes5f791332011-09-15 17:45:30 -0700373 ~ConditionVariable();
374
Ian Rogersc604d732012-10-14 16:09:54 -0700375 void Broadcast(Thread* self);
376 void Signal(Thread* self);
377 // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their
378 // pointer copy, thereby defeating annotalysis.
379 void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS;
380 void TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS;
Ian Rogers1d54e732013-05-02 21:10:01 -0700381 // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held
382 // when waiting.
383 // TODO: remove this.
384 void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS;
Elliott Hughes5f791332011-09-15 17:45:30 -0700385
386 private:
Ian Rogers23055dc2013-04-18 16:29:16 -0700387 const char* const name_;
Ian Rogersc604d732012-10-14 16:09:54 -0700388 // The Mutex being used by waiters. It is an error to mix condition variables between different
389 // Mutexes.
390 Mutex& guard_;
391#if ART_USE_FUTEXES
392 // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up
Ian Rogersd45f2012012-11-28 11:46:23 -0800393 // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_
394 // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait
395 // without guard_ held.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800396 AtomicInteger sequence_;
Ian Rogersc604d732012-10-14 16:09:54 -0700397 // Number of threads that have come into to wait, not the length of the waiters on the futex as
Ian Rogers5bd97c42012-11-27 02:38:26 -0800398 // waiters may have been requeued onto guard_. Guarded by guard_.
Ian Rogersc604d732012-10-14 16:09:54 -0700399 volatile int32_t num_waiters_;
Ian Rogersc604d732012-10-14 16:09:54 -0700400#else
401 pthread_cond_t cond_;
402#endif
Elliott Hughes5f791332011-09-15 17:45:30 -0700403 DISALLOW_COPY_AND_ASSIGN(ConditionVariable);
404};
405
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700406// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it
407// upon destruction.
408class SCOPED_LOCKABLE MutexLock {
409 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700410 explicit MutexLock(Thread* self, Mutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : self_(self), mu_(mu) {
411 mu_.ExclusiveLock(self_);
412 }
413
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700414 ~MutexLock() UNLOCK_FUNCTION() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700415 mu_.ExclusiveUnlock(self_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700416 }
417
418 private:
Ian Rogers81d425b2012-09-27 16:03:43 -0700419 Thread* const self_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700420 Mutex& mu_;
421 DISALLOW_COPY_AND_ASSIGN(MutexLock);
422};
423// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)".
424#define MutexLock(x) COMPILE_ASSERT(0, mutex_lock_declaration_missing_variable_name)
425
426// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon
427// construction and releases it upon destruction.
428class SCOPED_LOCKABLE ReaderMutexLock {
429 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700430 explicit ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) :
431 self_(self), mu_(mu) {
432 mu_.SharedLock(self_);
433 }
434
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700435 ~ReaderMutexLock() UNLOCK_FUNCTION() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700436 mu_.SharedUnlock(self_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700437 }
438
439 private:
Ian Rogers81d425b2012-09-27 16:03:43 -0700440 Thread* const self_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700441 ReaderWriterMutex& mu_;
442 DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock);
443};
444// Catch bug where variable name is omitted. "ReaderMutexLock (lock);" instead of
445// "ReaderMutexLock mu(lock)".
446#define ReaderMutexLock(x) COMPILE_ASSERT(0, reader_mutex_lock_declaration_missing_variable_name)
447
448// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon
449// construction and releases it upon destruction.
450class SCOPED_LOCKABLE WriterMutexLock {
451 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700452 explicit WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) :
453 self_(self), mu_(mu) {
454 mu_.ExclusiveLock(self_);
455 }
456
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700457 ~WriterMutexLock() UNLOCK_FUNCTION() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700458 mu_.ExclusiveUnlock(self_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700459 }
460
461 private:
Ian Rogers50b35e22012-10-04 10:09:15 -0700462 Thread* const self_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700463 ReaderWriterMutex& mu_;
464 DISALLOW_COPY_AND_ASSIGN(WriterMutexLock);
465};
466// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of
467// "WriterMutexLock mu(lock)".
468#define WriterMutexLock(x) COMPILE_ASSERT(0, writer_mutex_lock_declaration_missing_variable_name)
469
Ian Rogers719d1a32014-03-06 12:13:39 -0800470// Global mutexes corresponding to the levels above.
471class Locks {
472 public:
473 static void Init();
474
475 // The mutator_lock_ is used to allow mutators to execute in a shared (reader) mode or to block
476 // mutators by having an exclusive (writer) owner. In normal execution each mutator thread holds
477 // a share on the mutator_lock_. The garbage collector may also execute with shared access but
478 // at times requires exclusive access to the heap (not to be confused with the heap meta-data
479 // guarded by the heap_lock_ below). When the garbage collector requires exclusive access it asks
480 // the mutators to suspend themselves which also involves usage of the thread_suspend_count_lock_
481 // to cover weaknesses in using ReaderWriterMutexes with ConditionVariables. We use a condition
482 // variable to wait upon in the suspension logic as releasing and then re-acquiring a share on
483 // the mutator lock doesn't necessarily allow the exclusive user (e.g the garbage collector)
484 // chance to acquire the lock.
485 //
486 // Thread suspension:
487 // Shared users | Exclusive user
488 // (holding mutator lock and in kRunnable state) | .. running ..
489 // .. running .. | Request thread suspension by:
490 // .. running .. | - acquiring thread_suspend_count_lock_
491 // .. running .. | - incrementing Thread::suspend_count_ on
492 // .. running .. | all mutator threads
493 // .. running .. | - releasing thread_suspend_count_lock_
494 // .. running .. | Block trying to acquire exclusive mutator lock
495 // Poll Thread::suspend_count_ and enter full | .. blocked ..
496 // suspend code. | .. blocked ..
497 // Change state to kSuspended | .. blocked ..
498 // x: Release share on mutator_lock_ | Carry out exclusive access
499 // Acquire thread_suspend_count_lock_ | .. exclusive ..
500 // while Thread::suspend_count_ > 0 | .. exclusive ..
501 // - wait on Thread::resume_cond_ | .. exclusive ..
502 // (releases thread_suspend_count_lock_) | .. exclusive ..
503 // .. waiting .. | Release mutator_lock_
504 // .. waiting .. | Request thread resumption by:
505 // .. waiting .. | - acquiring thread_suspend_count_lock_
506 // .. waiting .. | - decrementing Thread::suspend_count_ on
507 // .. waiting .. | all mutator threads
508 // .. waiting .. | - notifying on Thread::resume_cond_
509 // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_
510 // Release thread_suspend_count_lock_ | .. running ..
511 // Acquire share on mutator_lock_ | .. running ..
512 // - This could block but the thread still | .. running ..
513 // has a state of kSuspended and so this | .. running ..
514 // isn't an issue. | .. running ..
515 // Acquire thread_suspend_count_lock_ | .. running ..
516 // - we poll here as we're transitioning into | .. running ..
517 // kRunnable and an individual thread suspend | .. running ..
518 // request (e.g for debugging) won't try | .. running ..
519 // to acquire the mutator lock (which would | .. running ..
520 // block as we hold the mutator lock). This | .. running ..
521 // poll ensures that if the suspender thought | .. running ..
522 // we were suspended by incrementing our | .. running ..
523 // Thread::suspend_count_ and then reading | .. running ..
524 // our state we go back to waiting on | .. running ..
525 // Thread::resume_cond_. | .. running ..
526 // can_go_runnable = Thread::suspend_count_ == 0 | .. running ..
527 // Release thread_suspend_count_lock_ | .. running ..
528 // if can_go_runnable | .. running ..
529 // Change state to kRunnable | .. running ..
530 // else | .. running ..
531 // Goto x | .. running ..
532 // .. running .. | .. running ..
533 static ReaderWriterMutex* mutator_lock_;
534
535 // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap.
536 static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_);
537
538 // Guards shutdown of the runtime.
539 static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_);
540
Chao-ying Fu9e369312014-05-21 11:20:52 -0700541 // Guards background profiler global state.
542 static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_);
543
544 // Guards trace (ie traceview) requests.
545 static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_);
546
Ian Rogers719d1a32014-03-06 12:13:39 -0800547 // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads
548 // attaching and detaching.
Chao-ying Fu9e369312014-05-21 11:20:52 -0700549 static Mutex* thread_list_lock_ ACQUIRED_AFTER(trace_lock_);
Ian Rogers719d1a32014-03-06 12:13:39 -0800550
551 // Guards breakpoints.
552 static Mutex* breakpoint_lock_ ACQUIRED_AFTER(thread_list_lock_);
553
Ian Rogers719d1a32014-03-06 12:13:39 -0800554 // Guards lists of classes within the class linker.
Chao-ying Fu9e369312014-05-21 11:20:52 -0700555 static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_);
Ian Rogers719d1a32014-03-06 12:13:39 -0800556
557 // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code
558 // doesn't try to hold a higher level Mutex.
559 #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_)
560
Andreas Gampe74240812014-04-17 10:35:09 -0700561 static Mutex* allocated_monitor_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_);
562
Chao-ying Fu9e369312014-05-21 11:20:52 -0700563 // Guard the allocation/deallocation of thread ids.
Andreas Gampe74240812014-04-17 10:35:09 -0700564 static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(allocated_monitor_ids_lock_);
Chao-ying Fu9e369312014-05-21 11:20:52 -0700565
566 // Guards modification of the LDT on x86.
567 static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_);
568
Ian Rogers719d1a32014-03-06 12:13:39 -0800569 // Guards intern table.
Chao-ying Fu9e369312014-05-21 11:20:52 -0700570 static Mutex* intern_table_lock_ ACQUIRED_AFTER(modify_ldt_lock_);
Ian Rogers719d1a32014-03-06 12:13:39 -0800571
572 // Have an exclusive aborting thread.
573 static Mutex* abort_lock_ ACQUIRED_AFTER(classlinker_classes_lock_);
574
575 // Allow mutual exclusion when manipulating Thread::suspend_count_.
576 // TODO: Does the trade-off of a per-thread lock make sense?
577 static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_);
578
579 // One unexpected signal at a time lock.
580 static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_);
581
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700582 // Guards the maps in mem_map.
583 static Mutex* mem_maps_lock_ ACQUIRED_AFTER(unexpected_signal_lock_);
584
Ian Rogers719d1a32014-03-06 12:13:39 -0800585 // Have an exclusive logging thread.
586 static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_);
587};
588
Elliott Hughes8daa0922011-09-11 13:46:25 -0700589} // namespace art
590
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700591#endif // ART_RUNTIME_BASE_MUTEX_H_