blob: 1ba61800769f661084f027f95f5916434d315c60 [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,
Ian Rogers719d1a32014-03-06 12:13:39 -080058 kUnexpectedSignalLock,
59 kThreadSuspendCountLock,
60 kAbortLock,
61 kJdwpSocketLock,
62 kRosAllocGlobalLock,
63 kRosAllocBracketLock,
64 kRosAllocBulkFreeLock,
65 kAllocSpaceLock,
Mathieu Chartier2d1ab0a2014-05-08 15:27:31 -070066 kReferenceProcessorLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080067 kDexFileMethodInlinerLock,
68 kDexFileToMethodInlinerMapLock,
69 kMarkSweepMarkStackLock,
70 kTransactionLogLock,
71 kInternTableLock,
72 kMonitorPoolLock,
73 kDefaultMutexLevel,
74 kMarkSweepLargeObjectLock,
75 kPinTableLock,
76 kLoadLibraryLock,
77 kJdwpObjectRegistryLock,
Chao-ying Fu9e369312014-05-21 11:20:52 -070078 kModifyLdtLock,
79 kAllocatedThreadIdsLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080080 kClassLinkerClassesLock,
81 kBreakpointLock,
82 kMonitorLock,
Mathieu Chartier440e4ce2014-03-31 16:36:35 -070083 kMonitorListLock,
Ian Rogers719d1a32014-03-06 12:13:39 -080084 kThreadListLock,
85 kBreakpointInvokeLock,
86 kDeoptimizationLock,
87 kTraceLock,
88 kProfilerLock,
89 kJdwpEventListLock,
90 kJdwpAttachLock,
91 kJdwpStartLock,
92 kRuntimeShutdownLock,
93 kHeapBitmapLock,
94 kMutatorLock,
95 kZygoteCreationLock,
96
97 kLockLevelCount // Must come last.
98};
99std::ostream& operator<<(std::ostream& os, const LockLevel& rhs);
100
Brian Carlstrom2e250c82013-08-14 18:08:52 -0700101const bool kDebugLocking = kIsDebugBuild;
Ian Rogers25fd14b2012-09-05 10:56:38 -0700102
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700103// Record Log contention information, dumpable via SIGQUIT.
104#ifdef ART_USE_FUTEXES
Jeff Hao08f2e7b2013-09-09 16:44:02 -0700105// To enable lock contention logging, set this to true.
106const bool kLogLockContentions = false;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700107#else
108// Keep this false as lock contention logging is supported only with
109// futex.
110const bool kLogLockContentions = false;
111#endif
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700112const size_t kContentionLogSize = 4;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700113const size_t kContentionLogDataSize = kLogLockContentions ? 1 : 0;
114const size_t kAllMutexDataSize = kLogLockContentions ? 1 : 0;
115
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700116// Base class for all Mutex implementations
117class BaseMutex {
118 public:
Ian Rogersbab74962013-04-19 10:04:10 -0700119 const char* GetName() const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700120 return name_;
121 }
122
123 virtual bool IsMutex() const { return false; }
124 virtual bool IsReaderWriterMutex() const { return false; }
125
Ian Rogers56edc432013-01-18 16:51:51 -0800126 virtual void Dump(std::ostream& os) const = 0;
127
128 static void DumpAll(std::ostream& os);
129
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700130 protected:
131 friend class ConditionVariable;
132
Ian Rogers81d425b2012-09-27 16:03:43 -0700133 BaseMutex(const char* name, LockLevel level);
Ian Rogers56edc432013-01-18 16:51:51 -0800134 virtual ~BaseMutex();
Ian Rogers81d425b2012-09-27 16:03:43 -0700135 void RegisterAsLocked(Thread* self);
136 void RegisterAsUnlocked(Thread* self);
137 void CheckSafeToWait(Thread* self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700138
Ian Rogers56edc432013-01-18 16:51:51 -0800139 friend class ScopedContentionRecorder;
140
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700141 void RecordContention(uint64_t blocked_tid, uint64_t owner_tid, uint64_t nano_time_blocked);
Ian Rogers56edc432013-01-18 16:51:51 -0800142 void DumpContention(std::ostream& os) const;
143
Ian Rogers81d425b2012-09-27 16:03:43 -0700144 const LockLevel level_; // Support for lock hierarchy.
Ian Rogersbab74962013-04-19 10:04:10 -0700145 const char* const name_;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700146
Ian Rogers56edc432013-01-18 16:51:51 -0800147 // A log entry that records contention but makes no guarantee that either tid will be held live.
148 struct ContentionLogEntry {
149 ContentionLogEntry() : blocked_tid(0), owner_tid(0) {}
150 uint64_t blocked_tid;
151 uint64_t owner_tid;
152 AtomicInteger count;
153 };
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700154 struct ContentionLogData {
155 ContentionLogEntry contention_log[kContentionLogSize];
156 // The next entry in the contention log to be updated. Value ranges from 0 to
157 // kContentionLogSize - 1.
158 AtomicInteger cur_content_log_entry;
159 // Number of times the Mutex has been contended.
160 AtomicInteger contention_count;
161 // Sum of time waited by all contenders in ns.
162 volatile uint64_t wait_time;
163 void AddToWaitTime(uint64_t value);
164 ContentionLogData() : wait_time(0) {}
165 };
Ian Rogers3e5cf302014-05-20 16:40:37 -0700166 ContentionLogData contention_log_data_[kContentionLogDataSize];
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700167
168 public:
169 bool HasEverContended() const {
170 if (kLogLockContentions) {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700171 return contention_log_data_->contention_count.LoadSequentiallyConsistent() > 0;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700172 }
173 return false;
174 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700175};
176
177// A Mutex is used to achieve mutual exclusion between threads. A Mutex can be used to gain
178// exclusive access to what it guards. A Mutex can be in one of two states:
179// - Free - not owned by any thread,
180// - Exclusive - owned by a single thread.
181//
182// The effect of locking and unlocking operations on the state is:
183// State | ExclusiveLock | ExclusiveUnlock
184// -------------------------------------------
185// Free | Exclusive | error
186// Exclusive | Block* | Free
187// * Mutex is not reentrant and so an attempt to ExclusiveLock on the same thread will result in
188// an error. Being non-reentrant simplifies Waiting on ConditionVariables.
Ian Rogers01ae5802012-09-28 16:14:01 -0700189std::ostream& operator<<(std::ostream& os, const Mutex& mu);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700190class LOCKABLE Mutex : public BaseMutex {
191 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700192 explicit Mutex(const char* name, LockLevel level = kDefaultMutexLevel, bool recursive = false);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700193 ~Mutex();
194
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700195 virtual bool IsMutex() const { return true; }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700196
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700197 // Block until mutex is free then acquire exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700198 void ExclusiveLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION();
199 void Lock(Thread* self) EXCLUSIVE_LOCK_FUNCTION() { ExclusiveLock(self); }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700200
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700201 // Returns true if acquires exclusive access, false otherwise.
Ian Rogers81d425b2012-09-27 16:03:43 -0700202 bool ExclusiveTryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true);
203 bool TryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true) { return ExclusiveTryLock(self); }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700204
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700205 // Release exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700206 void ExclusiveUnlock(Thread* self) UNLOCK_FUNCTION();
207 void Unlock(Thread* self) UNLOCK_FUNCTION() { ExclusiveUnlock(self); }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700208
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700209 // Is the current thread the exclusive holder of the Mutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700210 bool IsExclusiveHeld(const Thread* self) const;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700211
212 // Assert that the Mutex is exclusively held by the current thread.
Ian Rogers81d425b2012-09-27 16:03:43 -0700213 void AssertExclusiveHeld(const Thread* self) {
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -0700214 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700215 CHECK(IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700216 }
217 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700218 void AssertHeld(const Thread* self) { AssertExclusiveHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700219
220 // Assert that the Mutex is not held by the current thread.
Ian Rogers81d425b2012-09-27 16:03:43 -0700221 void AssertNotHeldExclusive(const Thread* self) {
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -0700222 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700223 CHECK(!IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700224 }
225 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700226 void AssertNotHeld(const Thread* self) { AssertNotHeldExclusive(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700227
228 // Id associated with exclusive owner.
229 uint64_t GetExclusiveOwnerTid() const;
230
231 // Returns how many times this Mutex has been locked, it is better to use AssertHeld/NotHeld.
232 unsigned int GetDepth() const {
233 return recursion_count_;
234 }
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700235
Ian Rogers56edc432013-01-18 16:51:51 -0800236 virtual void Dump(std::ostream& os) const;
Ian Rogers01ae5802012-09-28 16:14:01 -0700237
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700238 private:
Ian Rogersc604d732012-10-14 16:09:54 -0700239#if ART_USE_FUTEXES
240 // 0 is unheld, 1 is held.
241 volatile int32_t state_;
242 // Exclusive owner.
243 volatile uint64_t exclusive_owner_;
244 // Number of waiting contenders.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800245 AtomicInteger num_contenders_;
Ian Rogersc604d732012-10-14 16:09:54 -0700246#else
Elliott Hughes8daa0922011-09-11 13:46:25 -0700247 pthread_mutex_t mutex_;
Ian Rogersc5f17732014-06-05 20:48:42 -0700248 volatile uint64_t exclusive_owner_; // Guarded by mutex_.
Ian Rogersc604d732012-10-14 16:09:54 -0700249#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700250 const bool recursive_; // Can the lock be recursively held?
251 unsigned int recursion_count_;
Elliott Hughesf1498432012-03-28 19:34:27 -0700252 friend class ConditionVariable;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700253 DISALLOW_COPY_AND_ASSIGN(Mutex);
254};
255
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700256// A ReaderWriterMutex is used to achieve mutual exclusion between threads, similar to a Mutex.
257// Unlike a Mutex a ReaderWriterMutex can be used to gain exclusive (writer) or shared (reader)
258// access to what it guards. A flaw in relation to a Mutex is that it cannot be used with a
259// condition variable. A ReaderWriterMutex can be in one of three states:
260// - Free - not owned by any thread,
261// - Exclusive - owned by a single thread,
262// - Shared(n) - shared amongst n threads.
263//
264// The effect of locking and unlocking operations on the state is:
265//
266// State | ExclusiveLock | ExclusiveUnlock | SharedLock | SharedUnlock
267// ----------------------------------------------------------------------------
268// Free | Exclusive | error | SharedLock(1) | error
269// Exclusive | Block | Free | Block | error
270// Shared(n) | Block | error | SharedLock(n+1)* | Shared(n-1) or Free
271// * for large values of n the SharedLock may block.
Ian Rogers01ae5802012-09-28 16:14:01 -0700272std::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700273class LOCKABLE ReaderWriterMutex : public BaseMutex {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700274 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700275 explicit ReaderWriterMutex(const char* name, LockLevel level = kDefaultMutexLevel);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700276 ~ReaderWriterMutex();
277
278 virtual bool IsReaderWriterMutex() const { return true; }
279
280 // Block until ReaderWriterMutex is free then acquire exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700281 void ExclusiveLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION();
282 void WriterLock(Thread* self) EXCLUSIVE_LOCK_FUNCTION() { ExclusiveLock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700283
284 // Release exclusive access.
Ian Rogers81d425b2012-09-27 16:03:43 -0700285 void ExclusiveUnlock(Thread* self) UNLOCK_FUNCTION();
286 void WriterUnlock(Thread* self) UNLOCK_FUNCTION() { ExclusiveUnlock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700287
288 // Block until ReaderWriterMutex is free and acquire exclusive access. Returns true on success
289 // or false if timeout is reached.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700290#if HAVE_TIMED_RWLOCK
Ian Rogersc604d732012-10-14 16:09:54 -0700291 bool ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns)
Ian Rogers81d425b2012-09-27 16:03:43 -0700292 EXCLUSIVE_TRYLOCK_FUNCTION(true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700293#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700294
295 // Block until ReaderWriterMutex is shared or free then acquire a share on the access.
Ian Rogers1ffa32f2013-02-05 18:29:08 -0800296 void SharedLock(Thread* self) SHARED_LOCK_FUNCTION() ALWAYS_INLINE;
Ian Rogers81d425b2012-09-27 16:03:43 -0700297 void ReaderLock(Thread* self) SHARED_LOCK_FUNCTION() { SharedLock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700298
299 // Try to acquire share of ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700300 bool SharedTryLock(Thread* self) EXCLUSIVE_TRYLOCK_FUNCTION(true);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700301
302 // Release a share of the access.
Ian Rogers1ffa32f2013-02-05 18:29:08 -0800303 void SharedUnlock(Thread* self) UNLOCK_FUNCTION() ALWAYS_INLINE;
Ian Rogers81d425b2012-09-27 16:03:43 -0700304 void ReaderUnlock(Thread* self) UNLOCK_FUNCTION() { SharedUnlock(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700305
306 // Is the current thread the exclusive holder of the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700307 bool IsExclusiveHeld(const Thread* self) const;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700308
309 // Assert the current thread has exclusive access to the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700310 void AssertExclusiveHeld(const Thread* self) {
Sebastien Hertz702a85b2013-08-05 16:37:51 +0200311 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700312 CHECK(IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700313 }
314 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700315 void AssertWriterHeld(const Thread* self) { AssertExclusiveHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700316
317 // Assert the current thread doesn't have exclusive access to the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700318 void AssertNotExclusiveHeld(const Thread* self) {
Sebastien Hertz702a85b2013-08-05 16:37:51 +0200319 if (kDebugLocking && (gAborting == 0)) {
Ian Rogerse3359f72013-06-11 15:14:11 -0700320 CHECK(!IsExclusiveHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700321 }
322 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700323 void AssertNotWriterHeld(const Thread* self) { AssertNotExclusiveHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700324
325 // Is the current thread a shared holder of the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700326 bool IsSharedHeld(const Thread* self) const;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700327
328 // Assert the current thread has shared access to the ReaderWriterMutex.
Ian Rogers81d425b2012-09-27 16:03:43 -0700329 void AssertSharedHeld(const Thread* self) {
Sebastien Hertz702a85b2013-08-05 16:37:51 +0200330 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers23055dc2013-04-18 16:29:16 -0700331 // TODO: we can only assert this well when self != NULL.
332 CHECK(IsSharedHeld(self) || self == NULL) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700333 }
334 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700335 void AssertReaderHeld(const Thread* self) { AssertSharedHeld(self); }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700336
337 // Assert the current thread doesn't hold this ReaderWriterMutex either in shared or exclusive
338 // mode.
Ian Rogers81d425b2012-09-27 16:03:43 -0700339 void AssertNotHeld(const Thread* self) {
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -0700340 if (kDebugLocking && (gAborting == 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700341 CHECK(!IsSharedHeld(self)) << *this;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700342 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700343 }
344
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700345 // Id associated with exclusive owner.
346 uint64_t GetExclusiveOwnerTid() const;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700347
Ian Rogers56edc432013-01-18 16:51:51 -0800348 virtual void Dump(std::ostream& os) const;
Ian Rogers01ae5802012-09-28 16:14:01 -0700349
Ian Rogers81d425b2012-09-27 16:03:43 -0700350 private:
351#if ART_USE_FUTEXES
352 // -1 implies held exclusive, +ve shared held by state_ many owners.
353 volatile int32_t state_;
354 // Exclusive owner.
355 volatile uint64_t exclusive_owner_;
356 // Pending readers.
357 volatile int32_t num_pending_readers_;
358 // Pending writers.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800359 AtomicInteger num_pending_writers_;
Ian Rogers81d425b2012-09-27 16:03:43 -0700360#else
361 pthread_rwlock_t rwlock_;
Ian Rogersc5f17732014-06-05 20:48:42 -0700362 volatile uint64_t exclusive_owner_; // Guarded by rwlock_.
Ian Rogers81d425b2012-09-27 16:03:43 -0700363#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700364 DISALLOW_COPY_AND_ASSIGN(ReaderWriterMutex);
365};
366
367// ConditionVariables allow threads to queue and sleep. Threads may then be resumed individually
368// (Signal) or all at once (Broadcast).
Elliott Hughes5f791332011-09-15 17:45:30 -0700369class ConditionVariable {
370 public:
Ian Rogers23055dc2013-04-18 16:29:16 -0700371 explicit ConditionVariable(const char* name, Mutex& mutex);
Elliott Hughes5f791332011-09-15 17:45:30 -0700372 ~ConditionVariable();
373
Ian Rogersc604d732012-10-14 16:09:54 -0700374 void Broadcast(Thread* self);
375 void Signal(Thread* self);
376 // TODO: No thread safety analysis on Wait and TimedWait as they call mutex operations via their
377 // pointer copy, thereby defeating annotalysis.
378 void Wait(Thread* self) NO_THREAD_SAFETY_ANALYSIS;
379 void TimedWait(Thread* self, int64_t ms, int32_t ns) NO_THREAD_SAFETY_ANALYSIS;
Ian Rogers1d54e732013-05-02 21:10:01 -0700380 // Variant of Wait that should be used with caution. Doesn't validate that no mutexes are held
381 // when waiting.
382 // TODO: remove this.
383 void WaitHoldingLocks(Thread* self) NO_THREAD_SAFETY_ANALYSIS;
Elliott Hughes5f791332011-09-15 17:45:30 -0700384
385 private:
Ian Rogers23055dc2013-04-18 16:29:16 -0700386 const char* const name_;
Ian Rogersc604d732012-10-14 16:09:54 -0700387 // The Mutex being used by waiters. It is an error to mix condition variables between different
388 // Mutexes.
389 Mutex& guard_;
390#if ART_USE_FUTEXES
391 // A counter that is modified by signals and broadcasts. This ensures that when a waiter gives up
Ian Rogersd45f2012012-11-28 11:46:23 -0800392 // their Mutex and another thread takes it and signals, the waiting thread observes that sequence_
393 // changed and doesn't enter the wait. Modified while holding guard_, but is read by futex wait
394 // without guard_ held.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800395 AtomicInteger sequence_;
Ian Rogersc604d732012-10-14 16:09:54 -0700396 // 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 -0800397 // waiters may have been requeued onto guard_. Guarded by guard_.
Ian Rogersc604d732012-10-14 16:09:54 -0700398 volatile int32_t num_waiters_;
Ian Rogersc604d732012-10-14 16:09:54 -0700399#else
400 pthread_cond_t cond_;
401#endif
Elliott Hughes5f791332011-09-15 17:45:30 -0700402 DISALLOW_COPY_AND_ASSIGN(ConditionVariable);
403};
404
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700405// Scoped locker/unlocker for a regular Mutex that acquires mu upon construction and releases it
406// upon destruction.
407class SCOPED_LOCKABLE MutexLock {
408 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700409 explicit MutexLock(Thread* self, Mutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) : self_(self), mu_(mu) {
410 mu_.ExclusiveLock(self_);
411 }
412
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700413 ~MutexLock() UNLOCK_FUNCTION() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700414 mu_.ExclusiveUnlock(self_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700415 }
416
417 private:
Ian Rogers81d425b2012-09-27 16:03:43 -0700418 Thread* const self_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700419 Mutex& mu_;
420 DISALLOW_COPY_AND_ASSIGN(MutexLock);
421};
422// Catch bug where variable name is omitted. "MutexLock (lock);" instead of "MutexLock mu(lock)".
423#define MutexLock(x) COMPILE_ASSERT(0, mutex_lock_declaration_missing_variable_name)
424
425// Scoped locker/unlocker for a ReaderWriterMutex that acquires read access to mu upon
426// construction and releases it upon destruction.
427class SCOPED_LOCKABLE ReaderMutexLock {
428 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700429 explicit ReaderMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) :
430 self_(self), mu_(mu) {
431 mu_.SharedLock(self_);
432 }
433
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700434 ~ReaderMutexLock() UNLOCK_FUNCTION() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700435 mu_.SharedUnlock(self_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700436 }
437
438 private:
Ian Rogers81d425b2012-09-27 16:03:43 -0700439 Thread* const self_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700440 ReaderWriterMutex& mu_;
441 DISALLOW_COPY_AND_ASSIGN(ReaderMutexLock);
442};
443// Catch bug where variable name is omitted. "ReaderMutexLock (lock);" instead of
444// "ReaderMutexLock mu(lock)".
445#define ReaderMutexLock(x) COMPILE_ASSERT(0, reader_mutex_lock_declaration_missing_variable_name)
446
447// Scoped locker/unlocker for a ReaderWriterMutex that acquires write access to mu upon
448// construction and releases it upon destruction.
449class SCOPED_LOCKABLE WriterMutexLock {
450 public:
Ian Rogers81d425b2012-09-27 16:03:43 -0700451 explicit WriterMutexLock(Thread* self, ReaderWriterMutex& mu) EXCLUSIVE_LOCK_FUNCTION(mu) :
452 self_(self), mu_(mu) {
453 mu_.ExclusiveLock(self_);
454 }
455
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700456 ~WriterMutexLock() UNLOCK_FUNCTION() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700457 mu_.ExclusiveUnlock(self_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700458 }
459
460 private:
Ian Rogers50b35e22012-10-04 10:09:15 -0700461 Thread* const self_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700462 ReaderWriterMutex& mu_;
463 DISALLOW_COPY_AND_ASSIGN(WriterMutexLock);
464};
465// Catch bug where variable name is omitted. "WriterMutexLock (lock);" instead of
466// "WriterMutexLock mu(lock)".
467#define WriterMutexLock(x) COMPILE_ASSERT(0, writer_mutex_lock_declaration_missing_variable_name)
468
Ian Rogers719d1a32014-03-06 12:13:39 -0800469// Global mutexes corresponding to the levels above.
470class Locks {
471 public:
472 static void Init();
473
474 // The mutator_lock_ is used to allow mutators to execute in a shared (reader) mode or to block
475 // mutators by having an exclusive (writer) owner. In normal execution each mutator thread holds
476 // a share on the mutator_lock_. The garbage collector may also execute with shared access but
477 // at times requires exclusive access to the heap (not to be confused with the heap meta-data
478 // guarded by the heap_lock_ below). When the garbage collector requires exclusive access it asks
479 // the mutators to suspend themselves which also involves usage of the thread_suspend_count_lock_
480 // to cover weaknesses in using ReaderWriterMutexes with ConditionVariables. We use a condition
481 // variable to wait upon in the suspension logic as releasing and then re-acquiring a share on
482 // the mutator lock doesn't necessarily allow the exclusive user (e.g the garbage collector)
483 // chance to acquire the lock.
484 //
485 // Thread suspension:
486 // Shared users | Exclusive user
487 // (holding mutator lock and in kRunnable state) | .. running ..
488 // .. running .. | Request thread suspension by:
489 // .. running .. | - acquiring thread_suspend_count_lock_
490 // .. running .. | - incrementing Thread::suspend_count_ on
491 // .. running .. | all mutator threads
492 // .. running .. | - releasing thread_suspend_count_lock_
493 // .. running .. | Block trying to acquire exclusive mutator lock
494 // Poll Thread::suspend_count_ and enter full | .. blocked ..
495 // suspend code. | .. blocked ..
496 // Change state to kSuspended | .. blocked ..
497 // x: Release share on mutator_lock_ | Carry out exclusive access
498 // Acquire thread_suspend_count_lock_ | .. exclusive ..
499 // while Thread::suspend_count_ > 0 | .. exclusive ..
500 // - wait on Thread::resume_cond_ | .. exclusive ..
501 // (releases thread_suspend_count_lock_) | .. exclusive ..
502 // .. waiting .. | Release mutator_lock_
503 // .. waiting .. | Request thread resumption by:
504 // .. waiting .. | - acquiring thread_suspend_count_lock_
505 // .. waiting .. | - decrementing Thread::suspend_count_ on
506 // .. waiting .. | all mutator threads
507 // .. waiting .. | - notifying on Thread::resume_cond_
508 // - re-acquire thread_suspend_count_lock_ | - releasing thread_suspend_count_lock_
509 // Release thread_suspend_count_lock_ | .. running ..
510 // Acquire share on mutator_lock_ | .. running ..
511 // - This could block but the thread still | .. running ..
512 // has a state of kSuspended and so this | .. running ..
513 // isn't an issue. | .. running ..
514 // Acquire thread_suspend_count_lock_ | .. running ..
515 // - we poll here as we're transitioning into | .. running ..
516 // kRunnable and an individual thread suspend | .. running ..
517 // request (e.g for debugging) won't try | .. running ..
518 // to acquire the mutator lock (which would | .. running ..
519 // block as we hold the mutator lock). This | .. running ..
520 // poll ensures that if the suspender thought | .. running ..
521 // we were suspended by incrementing our | .. running ..
522 // Thread::suspend_count_ and then reading | .. running ..
523 // our state we go back to waiting on | .. running ..
524 // Thread::resume_cond_. | .. running ..
525 // can_go_runnable = Thread::suspend_count_ == 0 | .. running ..
526 // Release thread_suspend_count_lock_ | .. running ..
527 // if can_go_runnable | .. running ..
528 // Change state to kRunnable | .. running ..
529 // else | .. running ..
530 // Goto x | .. running ..
531 // .. running .. | .. running ..
532 static ReaderWriterMutex* mutator_lock_;
533
534 // Allow reader-writer mutual exclusion on the mark and live bitmaps of the heap.
535 static ReaderWriterMutex* heap_bitmap_lock_ ACQUIRED_AFTER(mutator_lock_);
536
537 // Guards shutdown of the runtime.
538 static Mutex* runtime_shutdown_lock_ ACQUIRED_AFTER(heap_bitmap_lock_);
539
Chao-ying Fu9e369312014-05-21 11:20:52 -0700540 // Guards background profiler global state.
541 static Mutex* profiler_lock_ ACQUIRED_AFTER(runtime_shutdown_lock_);
542
543 // Guards trace (ie traceview) requests.
544 static Mutex* trace_lock_ ACQUIRED_AFTER(profiler_lock_);
545
Ian Rogers719d1a32014-03-06 12:13:39 -0800546 // The thread_list_lock_ guards ThreadList::list_. It is also commonly held to stop threads
547 // attaching and detaching.
Chao-ying Fu9e369312014-05-21 11:20:52 -0700548 static Mutex* thread_list_lock_ ACQUIRED_AFTER(trace_lock_);
Ian Rogers719d1a32014-03-06 12:13:39 -0800549
550 // Guards breakpoints.
551 static Mutex* breakpoint_lock_ ACQUIRED_AFTER(thread_list_lock_);
552
Ian Rogers719d1a32014-03-06 12:13:39 -0800553 // Guards lists of classes within the class linker.
Chao-ying Fu9e369312014-05-21 11:20:52 -0700554 static ReaderWriterMutex* classlinker_classes_lock_ ACQUIRED_AFTER(breakpoint_lock_);
Ian Rogers719d1a32014-03-06 12:13:39 -0800555
556 // When declaring any Mutex add DEFAULT_MUTEX_ACQUIRED_AFTER to use annotalysis to check the code
557 // doesn't try to hold a higher level Mutex.
558 #define DEFAULT_MUTEX_ACQUIRED_AFTER ACQUIRED_AFTER(Locks::classlinker_classes_lock_)
559
Chao-ying Fu9e369312014-05-21 11:20:52 -0700560 // Guard the allocation/deallocation of thread ids.
561 static Mutex* allocated_thread_ids_lock_ ACQUIRED_AFTER(classlinker_classes_lock_);
562
563 // Guards modification of the LDT on x86.
564 static Mutex* modify_ldt_lock_ ACQUIRED_AFTER(allocated_thread_ids_lock_);
565
Ian Rogers719d1a32014-03-06 12:13:39 -0800566 // Guards intern table.
Chao-ying Fu9e369312014-05-21 11:20:52 -0700567 static Mutex* intern_table_lock_ ACQUIRED_AFTER(modify_ldt_lock_);
Ian Rogers719d1a32014-03-06 12:13:39 -0800568
569 // Have an exclusive aborting thread.
570 static Mutex* abort_lock_ ACQUIRED_AFTER(classlinker_classes_lock_);
571
572 // Allow mutual exclusion when manipulating Thread::suspend_count_.
573 // TODO: Does the trade-off of a per-thread lock make sense?
574 static Mutex* thread_suspend_count_lock_ ACQUIRED_AFTER(abort_lock_);
575
576 // One unexpected signal at a time lock.
577 static Mutex* unexpected_signal_lock_ ACQUIRED_AFTER(thread_suspend_count_lock_);
578
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700579 // Guards the maps in mem_map.
580 static Mutex* mem_maps_lock_ ACQUIRED_AFTER(unexpected_signal_lock_);
581
Ian Rogers719d1a32014-03-06 12:13:39 -0800582 // Have an exclusive logging thread.
583 static Mutex* logging_lock_ ACQUIRED_AFTER(unexpected_signal_lock_);
584};
585
Elliott Hughes8daa0922011-09-11 13:46:25 -0700586} // namespace art
587
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700588#endif // ART_RUNTIME_BASE_MUTEX_H_