blob: e05a85a116058055985ecc29bb7c8a1c46e05f70 [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
17#include "mutex.h"
18
19#include <errno.h>
Ian Rogersc604d732012-10-14 16:09:54 -070020#include <sys/time.h>
Elliott Hughes8daa0922011-09-11 13:46:25 -070021
Andreas Gampe46ee31b2016-12-14 10:11:49 -080022#include "android-base/stringprintf.h"
23
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -070024#include "atomic.h"
Elliott Hughes07ed66b2012-12-12 18:34:25 -080025#include "base/logging.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010026#include "base/time_utils.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080027#include "base/systrace.h"
Ian Rogerscf7f1912014-10-22 22:06:39 -070028#include "base/value_object.h"
Ian Rogers693ff612013-02-01 10:56:12 -080029#include "mutex-inl.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070030#include "scoped_thread_state_change-inl.h"
Ian Rogers04d7aa92013-03-16 14:29:17 -070031#include "thread-inl.h"
Elliott Hughes8daa0922011-09-11 13:46:25 -070032
33namespace art {
34
Andreas Gampe46ee31b2016-12-14 10:11:49 -080035using android::base::StringPrintf;
36
David Sehrf42eb2c2016-10-19 13:20:45 -070037static Atomic<Locks::ClientCallback*> safe_to_call_abort_callback(nullptr);
38
Ian Rogers719d1a32014-03-06 12:13:39 -080039Mutex* Locks::abort_lock_ = nullptr;
Brian Carlstrom306db812014-09-05 13:01:41 -070040Mutex* Locks::alloc_tracker_lock_ = nullptr;
Andreas Gampe74240812014-04-17 10:35:09 -070041Mutex* Locks::allocated_monitor_ids_lock_ = nullptr;
Chao-ying Fu9e369312014-05-21 11:20:52 -070042Mutex* Locks::allocated_thread_ids_lock_ = nullptr;
Sebastien Hertzed2be172014-08-19 15:33:43 +020043ReaderWriterMutex* Locks::breakpoint_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080044ReaderWriterMutex* Locks::classlinker_classes_lock_ = nullptr;
Brian Carlstrom306db812014-09-05 13:01:41 -070045Mutex* Locks::deoptimization_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080046ReaderWriterMutex* Locks::heap_bitmap_lock_ = nullptr;
Mathieu Chartier9ef78b52014-09-25 17:03:12 -070047Mutex* Locks::instrument_entrypoints_lock_ = nullptr;
Mathieu Chartiera5a53ef2014-09-12 12:58:05 -070048Mutex* Locks::intern_table_lock_ = nullptr;
Andreas Gampec8089542017-01-16 12:41:12 -080049Mutex* Locks::jni_function_table_lock_ = nullptr;
Ian Rogers68d8b422014-07-17 11:09:10 -070050Mutex* Locks::jni_libraries_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080051Mutex* Locks::logging_lock_ = nullptr;
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -070052Mutex* Locks::mem_maps_lock_ = nullptr;
Chao-ying Fu9e369312014-05-21 11:20:52 -070053Mutex* Locks::modify_ldt_lock_ = nullptr;
Yu Lieac44242015-06-29 10:50:03 +080054MutatorMutex* Locks::mutator_lock_ = nullptr;
Brian Carlstrom306db812014-09-05 13:01:41 -070055Mutex* Locks::profiler_lock_ = nullptr;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +000056ReaderWriterMutex* Locks::verifier_deps_lock_ = nullptr;
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070057ReaderWriterMutex* Locks::oat_file_manager_lock_ = nullptr;
Richard Uhlera206c742016-05-24 15:04:22 -070058Mutex* Locks::host_dlopen_handles_lock_ = nullptr;
Mathieu Chartiera5a53ef2014-09-12 12:58:05 -070059Mutex* Locks::reference_processor_lock_ = nullptr;
60Mutex* Locks::reference_queue_cleared_references_lock_ = nullptr;
61Mutex* Locks::reference_queue_finalizer_references_lock_ = nullptr;
62Mutex* Locks::reference_queue_phantom_references_lock_ = nullptr;
63Mutex* Locks::reference_queue_soft_references_lock_ = nullptr;
64Mutex* Locks::reference_queue_weak_references_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080065Mutex* Locks::runtime_shutdown_lock_ = nullptr;
Mingyao Yang063fc772016-08-02 11:02:54 -070066Mutex* Locks::cha_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080067Mutex* Locks::thread_list_lock_ = nullptr;
Mathieu Chartier91e56692015-03-03 13:51:04 -080068ConditionVariable* Locks::thread_exit_cond_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080069Mutex* Locks::thread_suspend_count_lock_ = nullptr;
70Mutex* Locks::trace_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080071Mutex* Locks::unexpected_signal_lock_ = nullptr;
Andreas Gampe5bdb6552015-07-22 23:44:55 -070072Uninterruptible Roles::uninterruptible_;
Andreas Gampe05a364c2016-10-14 13:27:12 -070073ReaderWriterMutex* Locks::jni_globals_lock_ = nullptr;
74Mutex* Locks::jni_weak_globals_lock_ = nullptr;
Andreas Gampecc1b5352016-12-01 16:58:38 -080075ReaderWriterMutex* Locks::dex_lock_ = nullptr;
Ian Rogers719d1a32014-03-06 12:13:39 -080076
77struct AllMutexData {
78 // A guard for all_mutexes_ that's not a mutex (Mutexes must CAS to acquire and busy wait).
79 Atomic<const BaseMutex*> all_mutexes_guard;
80 // All created mutexes guarded by all_mutexes_guard_.
81 std::set<BaseMutex*>* all_mutexes;
Mathieu Chartier2cebb242015-04-21 16:50:40 -070082 AllMutexData() : all_mutexes(nullptr) {}
Ian Rogers719d1a32014-03-06 12:13:39 -080083};
84static struct AllMutexData gAllMutexData[kAllMutexDataSize];
85
Ian Rogersc604d732012-10-14 16:09:54 -070086#if ART_USE_FUTEXES
87static bool ComputeRelativeTimeSpec(timespec* result_ts, const timespec& lhs, const timespec& rhs) {
Brian Carlstromfb6996f2013-07-18 18:21:14 -070088 const int32_t one_sec = 1000 * 1000 * 1000; // one second in nanoseconds.
Ian Rogersc604d732012-10-14 16:09:54 -070089 result_ts->tv_sec = lhs.tv_sec - rhs.tv_sec;
90 result_ts->tv_nsec = lhs.tv_nsec - rhs.tv_nsec;
91 if (result_ts->tv_nsec < 0) {
92 result_ts->tv_sec--;
93 result_ts->tv_nsec += one_sec;
94 } else if (result_ts->tv_nsec > one_sec) {
95 result_ts->tv_sec++;
96 result_ts->tv_nsec -= one_sec;
97 }
98 return result_ts->tv_sec < 0;
99}
100#endif
101
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700102class ScopedAllMutexesLock FINAL {
Ian Rogers56edc432013-01-18 16:51:51 -0800103 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -0700104 explicit ScopedAllMutexesLock(const BaseMutex* mutex) : mutex_(mutex) {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700105 while (!gAllMutexData->all_mutexes_guard.CompareExchangeWeakAcquire(0, mutex)) {
Ian Rogers56edc432013-01-18 16:51:51 -0800106 NanoSleep(100);
107 }
108 }
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700109
Ian Rogers56edc432013-01-18 16:51:51 -0800110 ~ScopedAllMutexesLock() {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700111 while (!gAllMutexData->all_mutexes_guard.CompareExchangeWeakRelease(mutex_, 0)) {
Ian Rogers56edc432013-01-18 16:51:51 -0800112 NanoSleep(100);
113 }
114 }
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700115
Ian Rogers56edc432013-01-18 16:51:51 -0800116 private:
117 const BaseMutex* const mutex_;
118};
Ian Rogers56edc432013-01-18 16:51:51 -0800119
Ian Rogerscf7f1912014-10-22 22:06:39 -0700120// Scoped class that generates events at the beginning and end of lock contention.
121class ScopedContentionRecorder FINAL : public ValueObject {
122 public:
123 ScopedContentionRecorder(BaseMutex* mutex, uint64_t blocked_tid, uint64_t owner_tid)
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700124 : mutex_(kLogLockContentions ? mutex : nullptr),
Ian Rogerscf7f1912014-10-22 22:06:39 -0700125 blocked_tid_(kLogLockContentions ? blocked_tid : 0),
126 owner_tid_(kLogLockContentions ? owner_tid : 0),
127 start_nano_time_(kLogLockContentions ? NanoTime() : 0) {
128 if (ATRACE_ENABLED()) {
129 std::string msg = StringPrintf("Lock contention on %s (owner tid: %" PRIu64 ")",
130 mutex->GetName(), owner_tid);
131 ATRACE_BEGIN(msg.c_str());
132 }
133 }
134
135 ~ScopedContentionRecorder() {
136 ATRACE_END();
137 if (kLogLockContentions) {
138 uint64_t end_nano_time = NanoTime();
139 mutex_->RecordContention(blocked_tid_, owner_tid_, end_nano_time - start_nano_time_);
140 }
141 }
142
143 private:
144 BaseMutex* const mutex_;
145 const uint64_t blocked_tid_;
146 const uint64_t owner_tid_;
147 const uint64_t start_nano_time_;
148};
149
Ian Rogers56edc432013-01-18 16:51:51 -0800150BaseMutex::BaseMutex(const char* name, LockLevel level) : level_(level), name_(name) {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700151 if (kLogLockContentions) {
152 ScopedAllMutexesLock mu(this);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700153 std::set<BaseMutex*>** all_mutexes_ptr = &gAllMutexData->all_mutexes;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700154 if (*all_mutexes_ptr == nullptr) {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700155 // We leak the global set of all mutexes to avoid ordering issues in global variable
156 // construction/destruction.
157 *all_mutexes_ptr = new std::set<BaseMutex*>();
158 }
159 (*all_mutexes_ptr)->insert(this);
Ian Rogers56edc432013-01-18 16:51:51 -0800160 }
Ian Rogers56edc432013-01-18 16:51:51 -0800161}
162
163BaseMutex::~BaseMutex() {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700164 if (kLogLockContentions) {
165 ScopedAllMutexesLock mu(this);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700166 gAllMutexData->all_mutexes->erase(this);
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700167 }
Ian Rogers56edc432013-01-18 16:51:51 -0800168}
169
170void BaseMutex::DumpAll(std::ostream& os) {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700171 if (kLogLockContentions) {
172 os << "Mutex logging:\n";
173 ScopedAllMutexesLock mu(reinterpret_cast<const BaseMutex*>(-1));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700174 std::set<BaseMutex*>* all_mutexes = gAllMutexData->all_mutexes;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700175 if (all_mutexes == nullptr) {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700176 // No mutexes have been created yet during at startup.
177 return;
178 }
179 typedef std::set<BaseMutex*>::const_iterator It;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700180 os << "(Contended)\n";
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700181 for (It it = all_mutexes->begin(); it != all_mutexes->end(); ++it) {
182 BaseMutex* mutex = *it;
183 if (mutex->HasEverContended()) {
184 mutex->Dump(os);
185 os << "\n";
186 }
187 }
188 os << "(Never contented)\n";
189 for (It it = all_mutexes->begin(); it != all_mutexes->end(); ++it) {
190 BaseMutex* mutex = *it;
191 if (!mutex->HasEverContended()) {
192 mutex->Dump(os);
193 os << "\n";
194 }
195 }
Ian Rogers56edc432013-01-18 16:51:51 -0800196 }
Ian Rogers56edc432013-01-18 16:51:51 -0800197}
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700198
Ian Rogers81d425b2012-09-27 16:03:43 -0700199void BaseMutex::CheckSafeToWait(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700200 if (self == nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700201 CheckUnattachedThread(level_);
202 return;
203 }
Ian Rogers25fd14b2012-09-05 10:56:38 -0700204 if (kDebugLocking) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700205 CHECK(self->GetHeldMutex(level_) == this || level_ == kMonitorLock)
206 << "Waiting on unacquired mutex: " << name_;
Ian Rogers25fd14b2012-09-05 10:56:38 -0700207 bool bad_mutexes_held = false;
Elliott Hughes0f827162013-02-26 12:12:58 -0800208 for (int i = kLockLevelCount - 1; i >= 0; --i) {
Ian Rogers25fd14b2012-09-05 10:56:38 -0700209 if (i != level_) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700210 BaseMutex* held_mutex = self->GetHeldMutex(static_cast<LockLevel>(i));
Ian Rogersf3d874c2014-07-17 18:52:42 -0700211 // We expect waits to happen while holding the thread list suspend thread lock.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700212 if (held_mutex != nullptr) {
Elliott Hughes0f827162013-02-26 12:12:58 -0800213 LOG(ERROR) << "Holding \"" << held_mutex->name_ << "\" "
214 << "(level " << LockLevel(i) << ") while performing wait on "
215 << "\"" << name_ << "\" (level " << level_ << ")";
Ian Rogers25fd14b2012-09-05 10:56:38 -0700216 bad_mutexes_held = true;
217 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700218 }
219 }
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000220 if (gAborting == 0) { // Avoid recursive aborts.
221 CHECK(!bad_mutexes_held);
222 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700223 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700224}
225
Ian Rogers37f3c962014-07-17 11:25:30 -0700226void BaseMutex::ContentionLogData::AddToWaitTime(uint64_t value) {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700227 if (kLogLockContentions) {
228 // Atomically add value to wait_time.
Ian Rogers37f3c962014-07-17 11:25:30 -0700229 wait_time.FetchAndAddSequentiallyConsistent(value);
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700230 }
231}
232
Brian Carlstrom0de79852013-07-25 22:29:58 -0700233void BaseMutex::RecordContention(uint64_t blocked_tid,
234 uint64_t owner_tid,
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700235 uint64_t nano_time_blocked) {
236 if (kLogLockContentions) {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700237 ContentionLogData* data = contention_log_data_;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700238 ++(data->contention_count);
239 data->AddToWaitTime(nano_time_blocked);
240 ContentionLogEntry* log = data->contention_log;
241 // This code is intentionally racy as it is only used for diagnostics.
Ian Rogers3e5cf302014-05-20 16:40:37 -0700242 uint32_t slot = data->cur_content_log_entry.LoadRelaxed();
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700243 if (log[slot].blocked_tid == blocked_tid &&
244 log[slot].owner_tid == blocked_tid) {
245 ++log[slot].count;
246 } else {
247 uint32_t new_slot;
248 do {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700249 slot = data->cur_content_log_entry.LoadRelaxed();
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700250 new_slot = (slot + 1) % kContentionLogSize;
Ian Rogers3e5cf302014-05-20 16:40:37 -0700251 } while (!data->cur_content_log_entry.CompareExchangeWeakRelaxed(slot, new_slot));
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700252 log[new_slot].blocked_tid = blocked_tid;
253 log[new_slot].owner_tid = owner_tid;
Ian Rogers3e5cf302014-05-20 16:40:37 -0700254 log[new_slot].count.StoreRelaxed(1);
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700255 }
Ian Rogers56edc432013-01-18 16:51:51 -0800256 }
Ian Rogers56edc432013-01-18 16:51:51 -0800257}
258
Ian Rogers56edc432013-01-18 16:51:51 -0800259void BaseMutex::DumpContention(std::ostream& os) const {
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700260 if (kLogLockContentions) {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700261 const ContentionLogData* data = contention_log_data_;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700262 const ContentionLogEntry* log = data->contention_log;
Ian Rogers37f3c962014-07-17 11:25:30 -0700263 uint64_t wait_time = data->wait_time.LoadRelaxed();
Ian Rogers3e5cf302014-05-20 16:40:37 -0700264 uint32_t contention_count = data->contention_count.LoadRelaxed();
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700265 if (contention_count == 0) {
266 os << "never contended";
267 } else {
268 os << "contended " << contention_count
Mathieu Chartier73d1e172014-04-11 17:53:48 -0700269 << " total wait of contender " << PrettyDuration(wait_time)
270 << " average " << PrettyDuration(wait_time / contention_count);
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700271 SafeMap<uint64_t, size_t> most_common_blocker;
272 SafeMap<uint64_t, size_t> most_common_blocked;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700273 for (size_t i = 0; i < kContentionLogSize; ++i) {
274 uint64_t blocked_tid = log[i].blocked_tid;
275 uint64_t owner_tid = log[i].owner_tid;
Ian Rogers3e5cf302014-05-20 16:40:37 -0700276 uint32_t count = log[i].count.LoadRelaxed();
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700277 if (count > 0) {
Mathieu Chartier73d1e172014-04-11 17:53:48 -0700278 auto it = most_common_blocked.find(blocked_tid);
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700279 if (it != most_common_blocked.end()) {
280 most_common_blocked.Overwrite(blocked_tid, it->second + count);
281 } else {
282 most_common_blocked.Put(blocked_tid, count);
283 }
284 it = most_common_blocker.find(owner_tid);
285 if (it != most_common_blocker.end()) {
286 most_common_blocker.Overwrite(owner_tid, it->second + count);
287 } else {
288 most_common_blocker.Put(owner_tid, count);
289 }
Ian Rogers56edc432013-01-18 16:51:51 -0800290 }
291 }
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700292 uint64_t max_tid = 0;
293 size_t max_tid_count = 0;
Mathieu Chartier73d1e172014-04-11 17:53:48 -0700294 for (const auto& pair : most_common_blocked) {
295 if (pair.second > max_tid_count) {
296 max_tid = pair.first;
297 max_tid_count = pair.second;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700298 }
Ian Rogers56edc432013-01-18 16:51:51 -0800299 }
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700300 if (max_tid != 0) {
301 os << " sample shows most blocked tid=" << max_tid;
Ian Rogers56edc432013-01-18 16:51:51 -0800302 }
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700303 max_tid = 0;
304 max_tid_count = 0;
Mathieu Chartier73d1e172014-04-11 17:53:48 -0700305 for (const auto& pair : most_common_blocker) {
306 if (pair.second > max_tid_count) {
307 max_tid = pair.first;
308 max_tid_count = pair.second;
Hiroshi Yamauchi1afde132013-08-06 17:09:30 -0700309 }
310 }
311 if (max_tid != 0) {
312 os << " sample shows tid=" << max_tid << " owning during this time";
313 }
Ian Rogers56edc432013-01-18 16:51:51 -0800314 }
315 }
Ian Rogers56edc432013-01-18 16:51:51 -0800316}
317
318
Ian Rogers81d425b2012-09-27 16:03:43 -0700319Mutex::Mutex(const char* name, LockLevel level, bool recursive)
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700320 : BaseMutex(name, level), recursive_(recursive), recursion_count_(0) {
Ian Rogersc604d732012-10-14 16:09:54 -0700321#if ART_USE_FUTEXES
Ian Rogersc7190692014-07-08 23:50:26 -0700322 DCHECK_EQ(0, state_.LoadRelaxed());
Ian Rogers3e5cf302014-05-20 16:40:37 -0700323 DCHECK_EQ(0, num_contenders_.LoadRelaxed());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700324#else
Ian Rogersc5f17732014-06-05 20:48:42 -0700325 CHECK_MUTEX_CALL(pthread_mutex_init, (&mutex_, nullptr));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700326#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700327 exclusive_owner_ = 0;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700328}
329
David Sehrf42eb2c2016-10-19 13:20:45 -0700330// Helper to allow checking shutdown while locking for thread safety.
331static bool IsSafeToCallAbortSafe() {
332 MutexLock mu(Thread::Current(), *Locks::runtime_shutdown_lock_);
333 return Locks::IsSafeToCallAbortRacy();
Andreas Gampe8f1fa102015-01-22 19:48:51 -0800334}
335
Elliott Hughes8daa0922011-09-11 13:46:25 -0700336Mutex::~Mutex() {
David Sehrf42eb2c2016-10-19 13:20:45 -0700337 bool safe_to_call_abort = Locks::IsSafeToCallAbortRacy();
Ian Rogersc604d732012-10-14 16:09:54 -0700338#if ART_USE_FUTEXES
Ian Rogersc7190692014-07-08 23:50:26 -0700339 if (state_.LoadRelaxed() != 0) {
David Sehrf42eb2c2016-10-19 13:20:45 -0700340 LOG(safe_to_call_abort ? FATAL : WARNING)
341 << "destroying mutex with owner: " << exclusive_owner_;
Ian Rogersc604d732012-10-14 16:09:54 -0700342 } else {
Andreas Gampe8f1fa102015-01-22 19:48:51 -0800343 if (exclusive_owner_ != 0) {
David Sehrf42eb2c2016-10-19 13:20:45 -0700344 LOG(safe_to_call_abort ? FATAL : WARNING)
345 << "unexpectedly found an owner on unlocked mutex " << name_;
Andreas Gampe8f1fa102015-01-22 19:48:51 -0800346 }
347 if (num_contenders_.LoadSequentiallyConsistent() != 0) {
David Sehrf42eb2c2016-10-19 13:20:45 -0700348 LOG(safe_to_call_abort ? FATAL : WARNING)
349 << "unexpectedly found a contender on mutex " << name_;
Mathieu Chartiercef50f02014-12-09 17:38:52 -0800350 }
Ian Rogersc604d732012-10-14 16:09:54 -0700351 }
352#else
Elliott Hughese62934d2012-04-09 11:24:29 -0700353 // We can't use CHECK_MUTEX_CALL here because on shutdown a suspended daemon thread
354 // may still be using locks.
Elliott Hughes6b355752012-01-13 16:49:08 -0800355 int rc = pthread_mutex_destroy(&mutex_);
356 if (rc != 0) {
357 errno = rc;
David Sehrf42eb2c2016-10-19 13:20:45 -0700358 PLOG(safe_to_call_abort ? FATAL : WARNING)
359 << "pthread_mutex_destroy failed for " << name_;
Elliott Hughes6b355752012-01-13 16:49:08 -0800360 }
Ian Rogersc604d732012-10-14 16:09:54 -0700361#endif
Elliott Hughes8daa0922011-09-11 13:46:25 -0700362}
363
Ian Rogers81d425b2012-09-27 16:03:43 -0700364void Mutex::ExclusiveLock(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700365 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers25fd14b2012-09-05 10:56:38 -0700366 if (kDebugLocking && !recursive_) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700367 AssertNotHeld(self);
Ian Rogers25fd14b2012-09-05 10:56:38 -0700368 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700369 if (!recursive_ || !IsExclusiveHeld(self)) {
Ian Rogersc604d732012-10-14 16:09:54 -0700370#if ART_USE_FUTEXES
371 bool done = false;
372 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700373 int32_t cur_state = state_.LoadRelaxed();
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -0700374 if (LIKELY(cur_state == 0)) {
Ian Rogersc7190692014-07-08 23:50:26 -0700375 // Change state from 0 to 1 and impose load/store ordering appropriate for lock acquisition.
376 done = state_.CompareExchangeWeakAcquire(0 /* cur_state */, 1 /* new state */);
Ian Rogersc604d732012-10-14 16:09:54 -0700377 } else {
378 // Failed to acquire, hang up.
Hiroshi Yamauchib3733082013-08-12 17:28:49 -0700379 ScopedContentionRecorder scr(this, SafeGetTid(self), GetExclusiveOwnerTid());
Ian Rogersb122a4b2013-11-19 18:00:50 -0800380 num_contenders_++;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700381 if (futex(state_.Address(), FUTEX_WAIT, 1, nullptr, nullptr, 0) != 0) {
Brian Carlstrom0de79852013-07-25 22:29:58 -0700382 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
383 // We don't use TEMP_FAILURE_RETRY so we can intentionally retry to acquire the lock.
384 if ((errno != EAGAIN) && (errno != EINTR)) {
Ian Rogersc604d732012-10-14 16:09:54 -0700385 PLOG(FATAL) << "futex wait failed for " << name_;
386 }
387 }
Ian Rogersb122a4b2013-11-19 18:00:50 -0800388 num_contenders_--;
Ian Rogersc604d732012-10-14 16:09:54 -0700389 }
Brian Carlstromdf629502013-07-17 22:39:56 -0700390 } while (!done);
Ian Rogersc7190692014-07-08 23:50:26 -0700391 DCHECK_EQ(state_.LoadRelaxed(), 1);
Ian Rogersc604d732012-10-14 16:09:54 -0700392#else
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700393 CHECK_MUTEX_CALL(pthread_mutex_lock, (&mutex_));
Ian Rogersc604d732012-10-14 16:09:54 -0700394#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700395 DCHECK_EQ(exclusive_owner_, 0U);
396 exclusive_owner_ = SafeGetTid(self);
Ian Rogers81d425b2012-09-27 16:03:43 -0700397 RegisterAsLocked(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700398 }
399 recursion_count_++;
Ian Rogers25fd14b2012-09-05 10:56:38 -0700400 if (kDebugLocking) {
401 CHECK(recursion_count_ == 1 || recursive_) << "Unexpected recursion count on mutex: "
402 << name_ << " " << recursion_count_;
Ian Rogers81d425b2012-09-27 16:03:43 -0700403 AssertHeld(self);
Ian Rogers25fd14b2012-09-05 10:56:38 -0700404 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700405}
406
Ian Rogers81d425b2012-09-27 16:03:43 -0700407bool Mutex::ExclusiveTryLock(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700408 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers25fd14b2012-09-05 10:56:38 -0700409 if (kDebugLocking && !recursive_) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700410 AssertNotHeld(self);
Ian Rogers25fd14b2012-09-05 10:56:38 -0700411 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700412 if (!recursive_ || !IsExclusiveHeld(self)) {
Ian Rogersc604d732012-10-14 16:09:54 -0700413#if ART_USE_FUTEXES
414 bool done = false;
415 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700416 int32_t cur_state = state_.LoadRelaxed();
Ian Rogersc604d732012-10-14 16:09:54 -0700417 if (cur_state == 0) {
Ian Rogersc7190692014-07-08 23:50:26 -0700418 // Change state from 0 to 1 and impose load/store ordering appropriate for lock acquisition.
419 done = state_.CompareExchangeWeakAcquire(0 /* cur_state */, 1 /* new state */);
Ian Rogersc604d732012-10-14 16:09:54 -0700420 } else {
421 return false;
422 }
Brian Carlstromdf629502013-07-17 22:39:56 -0700423 } while (!done);
Ian Rogersc7190692014-07-08 23:50:26 -0700424 DCHECK_EQ(state_.LoadRelaxed(), 1);
Ian Rogersc604d732012-10-14 16:09:54 -0700425#else
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700426 int result = pthread_mutex_trylock(&mutex_);
427 if (result == EBUSY) {
428 return false;
429 }
430 if (result != 0) {
431 errno = result;
432 PLOG(FATAL) << "pthread_mutex_trylock failed for " << name_;
433 }
Ian Rogersc604d732012-10-14 16:09:54 -0700434#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700435 DCHECK_EQ(exclusive_owner_, 0U);
436 exclusive_owner_ = SafeGetTid(self);
Ian Rogers81d425b2012-09-27 16:03:43 -0700437 RegisterAsLocked(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700438 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700439 recursion_count_++;
Ian Rogers25fd14b2012-09-05 10:56:38 -0700440 if (kDebugLocking) {
441 CHECK(recursion_count_ == 1 || recursive_) << "Unexpected recursion count on mutex: "
442 << name_ << " " << recursion_count_;
Ian Rogers81d425b2012-09-27 16:03:43 -0700443 AssertHeld(self);
Ian Rogers25fd14b2012-09-05 10:56:38 -0700444 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700445 return true;
446}
447
Ian Rogers81d425b2012-09-27 16:03:43 -0700448void Mutex::ExclusiveUnlock(Thread* self) {
Mathieu Chartiereb0a1792014-12-15 17:23:45 -0800449 if (kIsDebugBuild && self != nullptr && self != Thread::Current()) {
450 std::string name1 = "<null>";
451 std::string name2 = "<null>";
452 if (self != nullptr) {
453 self->GetThreadName(name1);
454 }
455 if (Thread::Current() != nullptr) {
456 Thread::Current()->GetThreadName(name2);
457 }
Mathieu Chartier4c101102015-01-27 17:14:16 -0800458 LOG(FATAL) << GetName() << " level=" << level_ << " self=" << name1
459 << " Thread::Current()=" << name2;
Mathieu Chartiereb0a1792014-12-15 17:23:45 -0800460 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700461 AssertHeld(self);
Ian Rogersc5f17732014-06-05 20:48:42 -0700462 DCHECK_NE(exclusive_owner_, 0U);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700463 recursion_count_--;
464 if (!recursive_ || recursion_count_ == 0) {
Ian Rogers25fd14b2012-09-05 10:56:38 -0700465 if (kDebugLocking) {
466 CHECK(recursion_count_ == 0 || recursive_) << "Unexpected recursion count on mutex: "
467 << name_ << " " << recursion_count_;
468 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700469 RegisterAsUnlocked(self);
Ian Rogersc604d732012-10-14 16:09:54 -0700470#if ART_USE_FUTEXES
Ian Rogersc5f17732014-06-05 20:48:42 -0700471 bool done = false;
472 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700473 int32_t cur_state = state_.LoadRelaxed();
Ian Rogersc5f17732014-06-05 20:48:42 -0700474 if (LIKELY(cur_state == 1)) {
Ian Rogersc5f17732014-06-05 20:48:42 -0700475 // We're no longer the owner.
476 exclusive_owner_ = 0;
Ian Rogersc7190692014-07-08 23:50:26 -0700477 // Change state to 0 and impose load/store ordering appropriate for lock release.
478 // Note, the relaxed loads below musn't reorder before the CompareExchange.
479 // TODO: the ordering here is non-trivial as state is split across 3 fields, fix by placing
480 // a status bit into the state on contention.
481 done = state_.CompareExchangeWeakSequentiallyConsistent(cur_state, 0 /* new state */);
Ian Rogersc5f17732014-06-05 20:48:42 -0700482 if (LIKELY(done)) { // Spurious fail?
Ian Rogersc7190692014-07-08 23:50:26 -0700483 // Wake a contender.
Ian Rogersc5f17732014-06-05 20:48:42 -0700484 if (UNLIKELY(num_contenders_.LoadRelaxed() > 0)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700485 futex(state_.Address(), FUTEX_WAKE, 1, nullptr, nullptr, 0);
Ian Rogersc5f17732014-06-05 20:48:42 -0700486 }
487 }
488 } else {
489 // Logging acquires the logging lock, avoid infinite recursion in that case.
490 if (this != Locks::logging_lock_) {
491 LOG(FATAL) << "Unexpected state_ in unlock " << cur_state << " for " << name_;
492 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700493 LogHelper::LogLineLowStack(__FILE__,
494 __LINE__,
495 ::android::base::FATAL_WITHOUT_ABORT,
496 StringPrintf("Unexpected state_ %d in unlock for %s",
497 cur_state, name_).c_str());
Ian Rogersc5f17732014-06-05 20:48:42 -0700498 _exit(1);
Ian Rogersc604d732012-10-14 16:09:54 -0700499 }
500 }
Ian Rogersc5f17732014-06-05 20:48:42 -0700501 } while (!done);
Ian Rogersc604d732012-10-14 16:09:54 -0700502#else
Ian Rogersc5f17732014-06-05 20:48:42 -0700503 exclusive_owner_ = 0;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700504 CHECK_MUTEX_CALL(pthread_mutex_unlock, (&mutex_));
Ian Rogersc604d732012-10-14 16:09:54 -0700505#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700506 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700507}
508
Ian Rogers56edc432013-01-18 16:51:51 -0800509void Mutex::Dump(std::ostream& os) const {
510 os << (recursive_ ? "recursive " : "non-recursive ")
511 << name_
512 << " level=" << static_cast<int>(level_)
513 << " rec=" << recursion_count_
514 << " owner=" << GetExclusiveOwnerTid() << " ";
515 DumpContention(os);
Ian Rogers01ae5802012-09-28 16:14:01 -0700516}
517
518std::ostream& operator<<(std::ostream& os, const Mutex& mu) {
Ian Rogers56edc432013-01-18 16:51:51 -0800519 mu.Dump(os);
520 return os;
Ian Rogers01ae5802012-09-28 16:14:01 -0700521}
522
Brian Carlstrom02c8cc62013-07-18 15:54:44 -0700523ReaderWriterMutex::ReaderWriterMutex(const char* name, LockLevel level)
524 : BaseMutex(name, level)
Ian Rogers81d425b2012-09-27 16:03:43 -0700525#if ART_USE_FUTEXES
Ian Rogersc5f17732014-06-05 20:48:42 -0700526 , state_(0), num_pending_readers_(0), num_pending_writers_(0)
Ian Rogers81d425b2012-09-27 16:03:43 -0700527#endif
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700528{ // NOLINT(whitespace/braces)
Ian Rogers81d425b2012-09-27 16:03:43 -0700529#if !ART_USE_FUTEXES
Ian Rogersc5f17732014-06-05 20:48:42 -0700530 CHECK_MUTEX_CALL(pthread_rwlock_init, (&rwlock_, nullptr));
Ian Rogers81d425b2012-09-27 16:03:43 -0700531#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700532 exclusive_owner_ = 0;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700533}
534
535ReaderWriterMutex::~ReaderWriterMutex() {
Ian Rogers81d425b2012-09-27 16:03:43 -0700536#if ART_USE_FUTEXES
Ian Rogersc7190692014-07-08 23:50:26 -0700537 CHECK_EQ(state_.LoadRelaxed(), 0);
Ian Rogers81d425b2012-09-27 16:03:43 -0700538 CHECK_EQ(exclusive_owner_, 0U);
Ian Rogersc7190692014-07-08 23:50:26 -0700539 CHECK_EQ(num_pending_readers_.LoadRelaxed(), 0);
Ian Rogers3e5cf302014-05-20 16:40:37 -0700540 CHECK_EQ(num_pending_writers_.LoadRelaxed(), 0);
Ian Rogers81d425b2012-09-27 16:03:43 -0700541#else
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700542 // We can't use CHECK_MUTEX_CALL here because on shutdown a suspended daemon thread
543 // may still be using locks.
544 int rc = pthread_rwlock_destroy(&rwlock_);
545 if (rc != 0) {
546 errno = rc;
David Sehrf42eb2c2016-10-19 13:20:45 -0700547 bool is_safe_to_call_abort = IsSafeToCallAbortSafe();
548 PLOG(is_safe_to_call_abort ? FATAL : WARNING) << "pthread_rwlock_destroy failed for " << name_;
Brian Carlstromcd74c4b2012-01-23 13:21:00 -0800549 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700550#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700551}
552
Ian Rogers81d425b2012-09-27 16:03:43 -0700553void ReaderWriterMutex::ExclusiveLock(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700554 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers81d425b2012-09-27 16:03:43 -0700555 AssertNotExclusiveHeld(self);
556#if ART_USE_FUTEXES
557 bool done = false;
558 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700559 int32_t cur_state = state_.LoadRelaxed();
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -0700560 if (LIKELY(cur_state == 0)) {
Ian Rogersc7190692014-07-08 23:50:26 -0700561 // Change state from 0 to -1 and impose load/store ordering appropriate for lock acquisition.
562 done = state_.CompareExchangeWeakAcquire(0 /* cur_state*/, -1 /* new state */);
Ian Rogers81d425b2012-09-27 16:03:43 -0700563 } else {
564 // Failed to acquire, hang up.
Hiroshi Yamauchib3733082013-08-12 17:28:49 -0700565 ScopedContentionRecorder scr(this, SafeGetTid(self), GetExclusiveOwnerTid());
Ian Rogersc7190692014-07-08 23:50:26 -0700566 ++num_pending_writers_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700567 if (futex(state_.Address(), FUTEX_WAIT, cur_state, nullptr, nullptr, 0) != 0) {
Brian Carlstrom0de79852013-07-25 22:29:58 -0700568 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
569 // We don't use TEMP_FAILURE_RETRY so we can intentionally retry to acquire the lock.
570 if ((errno != EAGAIN) && (errno != EINTR)) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700571 PLOG(FATAL) << "futex wait failed for " << name_;
572 }
573 }
Ian Rogersc7190692014-07-08 23:50:26 -0700574 --num_pending_writers_;
Ian Rogers81d425b2012-09-27 16:03:43 -0700575 }
Brian Carlstromdf629502013-07-17 22:39:56 -0700576 } while (!done);
Ian Rogersc7190692014-07-08 23:50:26 -0700577 DCHECK_EQ(state_.LoadRelaxed(), -1);
Ian Rogers81d425b2012-09-27 16:03:43 -0700578#else
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700579 CHECK_MUTEX_CALL(pthread_rwlock_wrlock, (&rwlock_));
Ian Rogers81d425b2012-09-27 16:03:43 -0700580#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700581 DCHECK_EQ(exclusive_owner_, 0U);
582 exclusive_owner_ = SafeGetTid(self);
Ian Rogers81d425b2012-09-27 16:03:43 -0700583 RegisterAsLocked(self);
584 AssertExclusiveHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700585}
586
Ian Rogers81d425b2012-09-27 16:03:43 -0700587void ReaderWriterMutex::ExclusiveUnlock(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700588 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers81d425b2012-09-27 16:03:43 -0700589 AssertExclusiveHeld(self);
590 RegisterAsUnlocked(self);
Ian Rogersc5f17732014-06-05 20:48:42 -0700591 DCHECK_NE(exclusive_owner_, 0U);
Ian Rogers81d425b2012-09-27 16:03:43 -0700592#if ART_USE_FUTEXES
593 bool done = false;
594 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700595 int32_t cur_state = state_.LoadRelaxed();
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -0700596 if (LIKELY(cur_state == -1)) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700597 // We're no longer the owner.
598 exclusive_owner_ = 0;
Ian Rogersc7190692014-07-08 23:50:26 -0700599 // Change state from -1 to 0 and impose load/store ordering appropriate for lock release.
600 // Note, the relaxed loads below musn't reorder before the CompareExchange.
601 // TODO: the ordering here is non-trivial as state is split across 3 fields, fix by placing
602 // a status bit into the state on contention.
603 done = state_.CompareExchangeWeakSequentiallyConsistent(-1 /* cur_state*/, 0 /* new state */);
604 if (LIKELY(done)) { // Weak CAS may fail spuriously.
Ian Rogers81d425b2012-09-27 16:03:43 -0700605 // Wake any waiters.
Ian Rogersc7190692014-07-08 23:50:26 -0700606 if (UNLIKELY(num_pending_readers_.LoadRelaxed() > 0 ||
607 num_pending_writers_.LoadRelaxed() > 0)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700608 futex(state_.Address(), FUTEX_WAKE, -1, nullptr, nullptr, 0);
Ian Rogers81d425b2012-09-27 16:03:43 -0700609 }
610 }
611 } else {
612 LOG(FATAL) << "Unexpected state_:" << cur_state << " for " << name_;
613 }
Brian Carlstromdf629502013-07-17 22:39:56 -0700614 } while (!done);
Ian Rogers81d425b2012-09-27 16:03:43 -0700615#else
Ian Rogersc5f17732014-06-05 20:48:42 -0700616 exclusive_owner_ = 0;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700617 CHECK_MUTEX_CALL(pthread_rwlock_unlock, (&rwlock_));
Ian Rogers81d425b2012-09-27 16:03:43 -0700618#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700619}
620
Ian Rogers66aee5c2012-08-15 17:17:47 -0700621#if HAVE_TIMED_RWLOCK
Ian Rogersc604d732012-10-14 16:09:54 -0700622bool ReaderWriterMutex::ExclusiveLockWithTimeout(Thread* self, int64_t ms, int32_t ns) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700623 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers81d425b2012-09-27 16:03:43 -0700624#if ART_USE_FUTEXES
625 bool done = false;
Ian Rogersc604d732012-10-14 16:09:54 -0700626 timespec end_abs_ts;
tony.ys_liu071e48e2015-01-14 18:28:03 +0800627 InitTimeSpec(true, CLOCK_MONOTONIC, ms, ns, &end_abs_ts);
Ian Rogers81d425b2012-09-27 16:03:43 -0700628 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700629 int32_t cur_state = state_.LoadRelaxed();
Ian Rogers81d425b2012-09-27 16:03:43 -0700630 if (cur_state == 0) {
Ian Rogersc7190692014-07-08 23:50:26 -0700631 // Change state from 0 to -1 and impose load/store ordering appropriate for lock acquisition.
632 done = state_.CompareExchangeWeakAcquire(0 /* cur_state */, -1 /* new state */);
Ian Rogers81d425b2012-09-27 16:03:43 -0700633 } else {
634 // Failed to acquire, hang up.
Ian Rogersc604d732012-10-14 16:09:54 -0700635 timespec now_abs_ts;
tony.ys_liu071e48e2015-01-14 18:28:03 +0800636 InitTimeSpec(true, CLOCK_MONOTONIC, 0, 0, &now_abs_ts);
Ian Rogersc604d732012-10-14 16:09:54 -0700637 timespec rel_ts;
638 if (ComputeRelativeTimeSpec(&rel_ts, end_abs_ts, now_abs_ts)) {
639 return false; // Timed out.
640 }
Hiroshi Yamauchib3733082013-08-12 17:28:49 -0700641 ScopedContentionRecorder scr(this, SafeGetTid(self), GetExclusiveOwnerTid());
Ian Rogersc7190692014-07-08 23:50:26 -0700642 ++num_pending_writers_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700643 if (futex(state_.Address(), FUTEX_WAIT, cur_state, &rel_ts, nullptr, 0) != 0) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700644 if (errno == ETIMEDOUT) {
Ian Rogersc7190692014-07-08 23:50:26 -0700645 --num_pending_writers_;
Ian Rogersc604d732012-10-14 16:09:54 -0700646 return false; // Timed out.
Brian Carlstrom0de79852013-07-25 22:29:58 -0700647 } else if ((errno != EAGAIN) && (errno != EINTR)) {
648 // EAGAIN and EINTR both indicate a spurious failure,
649 // recompute the relative time out from now and try again.
650 // We don't use TEMP_FAILURE_RETRY so we can recompute rel_ts;
Ian Rogers81d425b2012-09-27 16:03:43 -0700651 PLOG(FATAL) << "timed futex wait failed for " << name_;
652 }
653 }
Ian Rogersc7190692014-07-08 23:50:26 -0700654 --num_pending_writers_;
Ian Rogers81d425b2012-09-27 16:03:43 -0700655 }
Brian Carlstromdf629502013-07-17 22:39:56 -0700656 } while (!done);
Ian Rogers81d425b2012-09-27 16:03:43 -0700657#else
Ian Rogersc604d732012-10-14 16:09:54 -0700658 timespec ts;
Brian Carlstrombcc29262012-11-02 11:36:03 -0700659 InitTimeSpec(true, CLOCK_REALTIME, ms, ns, &ts);
Ian Rogersc604d732012-10-14 16:09:54 -0700660 int result = pthread_rwlock_timedwrlock(&rwlock_, &ts);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700661 if (result == ETIMEDOUT) {
662 return false;
663 }
664 if (result != 0) {
665 errno = result;
Ian Rogersa5acfd32012-08-15 11:50:10 -0700666 PLOG(FATAL) << "pthread_rwlock_timedwrlock failed for " << name_;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700667 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700668#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700669 exclusive_owner_ = SafeGetTid(self);
Ian Rogers81d425b2012-09-27 16:03:43 -0700670 RegisterAsLocked(self);
671 AssertSharedHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700672 return true;
673}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700674#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700675
Ian Rogers51d212e2014-10-23 17:48:20 -0700676#if ART_USE_FUTEXES
Ian Rogerscf7f1912014-10-22 22:06:39 -0700677void ReaderWriterMutex::HandleSharedLockContention(Thread* self, int32_t cur_state) {
678 // Owner holds it exclusively, hang up.
679 ScopedContentionRecorder scr(this, GetExclusiveOwnerTid(), SafeGetTid(self));
680 ++num_pending_readers_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700681 if (futex(state_.Address(), FUTEX_WAIT, cur_state, nullptr, nullptr, 0) != 0) {
Daniel Colascione6f4d1022016-11-21 14:35:42 -0800682 if (errno != EAGAIN && errno != EINTR) {
Ian Rogerscf7f1912014-10-22 22:06:39 -0700683 PLOG(FATAL) << "futex wait failed for " << name_;
684 }
685 }
686 --num_pending_readers_;
687}
Ian Rogers51d212e2014-10-23 17:48:20 -0700688#endif
Ian Rogerscf7f1912014-10-22 22:06:39 -0700689
Ian Rogers81d425b2012-09-27 16:03:43 -0700690bool ReaderWriterMutex::SharedTryLock(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700691 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers81d425b2012-09-27 16:03:43 -0700692#if ART_USE_FUTEXES
693 bool done = false;
694 do {
Ian Rogersc7190692014-07-08 23:50:26 -0700695 int32_t cur_state = state_.LoadRelaxed();
Ian Rogers81d425b2012-09-27 16:03:43 -0700696 if (cur_state >= 0) {
Ian Rogersc7190692014-07-08 23:50:26 -0700697 // Add as an extra reader and impose load/store ordering appropriate for lock acquisition.
698 done = state_.CompareExchangeWeakAcquire(cur_state, cur_state + 1);
Ian Rogers81d425b2012-09-27 16:03:43 -0700699 } else {
700 // Owner holds it exclusively.
701 return false;
702 }
Brian Carlstromdf629502013-07-17 22:39:56 -0700703 } while (!done);
Ian Rogers81d425b2012-09-27 16:03:43 -0700704#else
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700705 int result = pthread_rwlock_tryrdlock(&rwlock_);
706 if (result == EBUSY) {
707 return false;
708 }
709 if (result != 0) {
710 errno = result;
711 PLOG(FATAL) << "pthread_mutex_trylock failed for " << name_;
712 }
Ian Rogers81d425b2012-09-27 16:03:43 -0700713#endif
714 RegisterAsLocked(self);
715 AssertSharedHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700716 return true;
717}
718
Ian Rogers81d425b2012-09-27 16:03:43 -0700719bool ReaderWriterMutex::IsSharedHeld(const Thread* self) const {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700720 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700721 bool result;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700722 if (UNLIKELY(self == nullptr)) { // Handle unattached threads.
Ian Rogers01ae5802012-09-28 16:14:01 -0700723 result = IsExclusiveHeld(self); // TODO: a better best effort here.
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700724 } else {
725 result = (self->GetHeldMutex(level_) == this);
726 }
727 return result;
728}
729
Ian Rogers56edc432013-01-18 16:51:51 -0800730void ReaderWriterMutex::Dump(std::ostream& os) const {
731 os << name_
732 << " level=" << static_cast<int>(level_)
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700733 << " owner=" << GetExclusiveOwnerTid()
734#if ART_USE_FUTEXES
735 << " state=" << state_.LoadSequentiallyConsistent()
736 << " num_pending_writers=" << num_pending_writers_.LoadSequentiallyConsistent()
737 << " num_pending_readers=" << num_pending_readers_.LoadSequentiallyConsistent()
738#endif
739 << " ";
Ian Rogers56edc432013-01-18 16:51:51 -0800740 DumpContention(os);
Ian Rogers01ae5802012-09-28 16:14:01 -0700741}
742
743std::ostream& operator<<(std::ostream& os, const ReaderWriterMutex& mu) {
Ian Rogers56edc432013-01-18 16:51:51 -0800744 mu.Dump(os);
745 return os;
Ian Rogers01ae5802012-09-28 16:14:01 -0700746}
747
Yu Lieac44242015-06-29 10:50:03 +0800748std::ostream& operator<<(std::ostream& os, const MutatorMutex& mu) {
749 mu.Dump(os);
750 return os;
751}
752
Ian Rogers23055dc2013-04-18 16:29:16 -0700753ConditionVariable::ConditionVariable(const char* name, Mutex& guard)
Ian Rogersc604d732012-10-14 16:09:54 -0700754 : name_(name), guard_(guard) {
755#if ART_USE_FUTEXES
Ian Rogers3e5cf302014-05-20 16:40:37 -0700756 DCHECK_EQ(0, sequence_.LoadRelaxed());
Ian Rogersc604d732012-10-14 16:09:54 -0700757 num_waiters_ = 0;
Ian Rogersc604d732012-10-14 16:09:54 -0700758#else
Narayan Kamath51b71022014-03-04 11:57:09 +0000759 pthread_condattr_t cond_attrs;
Ian Rogersc5f17732014-06-05 20:48:42 -0700760 CHECK_MUTEX_CALL(pthread_condattr_init, (&cond_attrs));
Narayan Kamath51b71022014-03-04 11:57:09 +0000761#if !defined(__APPLE__)
762 // Apple doesn't have CLOCK_MONOTONIC or pthread_condattr_setclock.
Ian Rogers51d212e2014-10-23 17:48:20 -0700763 CHECK_MUTEX_CALL(pthread_condattr_setclock, (&cond_attrs, CLOCK_MONOTONIC));
Narayan Kamath51b71022014-03-04 11:57:09 +0000764#endif
765 CHECK_MUTEX_CALL(pthread_cond_init, (&cond_, &cond_attrs));
Ian Rogersc604d732012-10-14 16:09:54 -0700766#endif
Elliott Hughes5f791332011-09-15 17:45:30 -0700767}
768
769ConditionVariable::~ConditionVariable() {
Ian Rogers5bd97c42012-11-27 02:38:26 -0800770#if ART_USE_FUTEXES
771 if (num_waiters_!= 0) {
David Sehrf42eb2c2016-10-19 13:20:45 -0700772 bool is_safe_to_call_abort = IsSafeToCallAbortSafe();
773 LOG(is_safe_to_call_abort ? FATAL : WARNING)
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700774 << "ConditionVariable::~ConditionVariable for " << name_
Ian Rogersd45f2012012-11-28 11:46:23 -0800775 << " called with " << num_waiters_ << " waiters.";
Ian Rogers5bd97c42012-11-27 02:38:26 -0800776 }
777#else
Elliott Hughese62934d2012-04-09 11:24:29 -0700778 // We can't use CHECK_MUTEX_CALL here because on shutdown a suspended daemon thread
779 // may still be using condition variables.
780 int rc = pthread_cond_destroy(&cond_);
781 if (rc != 0) {
782 errno = rc;
David Sehrf42eb2c2016-10-19 13:20:45 -0700783 bool is_safe_to_call_abort = IsSafeToCallAbortSafe();
784 PLOG(is_safe_to_call_abort ? FATAL : WARNING) << "pthread_cond_destroy failed for " << name_;
Elliott Hughese62934d2012-04-09 11:24:29 -0700785 }
Ian Rogersc604d732012-10-14 16:09:54 -0700786#endif
Elliott Hughes5f791332011-09-15 17:45:30 -0700787}
788
Ian Rogersc604d732012-10-14 16:09:54 -0700789void ConditionVariable::Broadcast(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700790 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogersc604d732012-10-14 16:09:54 -0700791 // TODO: enable below, there's a race in thread creation that causes false failures currently.
792 // guard_.AssertExclusiveHeld(self);
Mathieu Chartiere46cd752012-10-31 16:56:18 -0700793 DCHECK_EQ(guard_.GetExclusiveOwnerTid(), SafeGetTid(self));
Ian Rogersc604d732012-10-14 16:09:54 -0700794#if ART_USE_FUTEXES
Ian Rogersd45f2012012-11-28 11:46:23 -0800795 if (num_waiters_ > 0) {
Ian Rogersb122a4b2013-11-19 18:00:50 -0800796 sequence_++; // Indicate the broadcast occurred.
Ian Rogersc604d732012-10-14 16:09:54 -0700797 bool done = false;
798 do {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700799 int32_t cur_sequence = sequence_.LoadRelaxed();
Ian Rogersd45f2012012-11-28 11:46:23 -0800800 // Requeue waiters onto mutex. The waiter holds the contender count on the mutex high ensuring
801 // mutex unlocks will awaken the requeued waiter thread.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800802 done = futex(sequence_.Address(), FUTEX_CMP_REQUEUE, 0,
Ian Rogers5bd97c42012-11-27 02:38:26 -0800803 reinterpret_cast<const timespec*>(std::numeric_limits<int32_t>::max()),
Ian Rogersc7190692014-07-08 23:50:26 -0700804 guard_.state_.Address(), cur_sequence) != -1;
Ian Rogers5bd97c42012-11-27 02:38:26 -0800805 if (!done) {
Daniel Colascione6f4d1022016-11-21 14:35:42 -0800806 if (errno != EAGAIN && errno != EINTR) {
Ian Rogers5bd97c42012-11-27 02:38:26 -0800807 PLOG(FATAL) << "futex cmp requeue failed for " << name_;
808 }
Ian Rogers5bd97c42012-11-27 02:38:26 -0800809 }
Ian Rogersc604d732012-10-14 16:09:54 -0700810 } while (!done);
811 }
812#else
Elliott Hughes5f791332011-09-15 17:45:30 -0700813 CHECK_MUTEX_CALL(pthread_cond_broadcast, (&cond_));
Ian Rogersc604d732012-10-14 16:09:54 -0700814#endif
Elliott Hughes5f791332011-09-15 17:45:30 -0700815}
816
Ian Rogersc604d732012-10-14 16:09:54 -0700817void ConditionVariable::Signal(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700818 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogersc604d732012-10-14 16:09:54 -0700819 guard_.AssertExclusiveHeld(self);
820#if ART_USE_FUTEXES
Ian Rogersd45f2012012-11-28 11:46:23 -0800821 if (num_waiters_ > 0) {
Ian Rogersb122a4b2013-11-19 18:00:50 -0800822 sequence_++; // Indicate a signal occurred.
Ian Rogersc604d732012-10-14 16:09:54 -0700823 // Futex wake 1 waiter who will then come and in contend on mutex. It'd be nice to requeue them
824 // to avoid this, however, requeueing can only move all waiters.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700825 int num_woken = futex(sequence_.Address(), FUTEX_WAKE, 1, nullptr, nullptr, 0);
Ian Rogersd45f2012012-11-28 11:46:23 -0800826 // Check something was woken or else we changed sequence_ before they had chance to wait.
Ian Rogers5bd97c42012-11-27 02:38:26 -0800827 CHECK((num_woken == 0) || (num_woken == 1));
Ian Rogersc604d732012-10-14 16:09:54 -0700828 }
829#else
Elliott Hughes5f791332011-09-15 17:45:30 -0700830 CHECK_MUTEX_CALL(pthread_cond_signal, (&cond_));
Ian Rogersc604d732012-10-14 16:09:54 -0700831#endif
Elliott Hughes5f791332011-09-15 17:45:30 -0700832}
833
Ian Rogersc604d732012-10-14 16:09:54 -0700834void ConditionVariable::Wait(Thread* self) {
Ian Rogers1d54e732013-05-02 21:10:01 -0700835 guard_.CheckSafeToWait(self);
836 WaitHoldingLocks(self);
837}
838
839void ConditionVariable::WaitHoldingLocks(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700840 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogersc604d732012-10-14 16:09:54 -0700841 guard_.AssertExclusiveHeld(self);
Ian Rogersc604d732012-10-14 16:09:54 -0700842 unsigned int old_recursion_count = guard_.recursion_count_;
843#if ART_USE_FUTEXES
Ian Rogersc604d732012-10-14 16:09:54 -0700844 num_waiters_++;
Ian Rogersd45f2012012-11-28 11:46:23 -0800845 // Ensure the Mutex is contended so that requeued threads are awoken.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800846 guard_.num_contenders_++;
Ian Rogersc604d732012-10-14 16:09:54 -0700847 guard_.recursion_count_ = 1;
Ian Rogers3e5cf302014-05-20 16:40:37 -0700848 int32_t cur_sequence = sequence_.LoadRelaxed();
Ian Rogersc604d732012-10-14 16:09:54 -0700849 guard_.ExclusiveUnlock(self);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700850 if (futex(sequence_.Address(), FUTEX_WAIT, cur_sequence, nullptr, nullptr, 0) != 0) {
Ian Rogersd45f2012012-11-28 11:46:23 -0800851 // Futex failed, check it is an expected error.
852 // EAGAIN == EWOULDBLK, so we let the caller try again.
853 // EINTR implies a signal was sent to this thread.
854 if ((errno != EINTR) && (errno != EAGAIN)) {
Ian Rogersc604d732012-10-14 16:09:54 -0700855 PLOG(FATAL) << "futex wait failed for " << name_;
856 }
857 }
Mathieu Chartier4d87df62016-01-07 15:14:19 -0800858 if (self != nullptr) {
859 JNIEnvExt* const env = self->GetJniEnv();
860 if (UNLIKELY(env != nullptr && env->runtime_deleted)) {
861 CHECK(self->IsDaemon());
862 // If the runtime has been deleted, then we cannot proceed. Just sleep forever. This may
863 // occur for user daemon threads that get a spurious wakeup. This occurs for test 132 with
864 // --host and --gdb.
865 // After we wake up, the runtime may have been shutdown, which means that this condition may
866 // have been deleted. It is not safe to retry the wait.
867 SleepForever();
868 }
869 }
Ian Rogersc604d732012-10-14 16:09:54 -0700870 guard_.ExclusiveLock(self);
Ian Rogersd45f2012012-11-28 11:46:23 -0800871 CHECK_GE(num_waiters_, 0);
Ian Rogersc604d732012-10-14 16:09:54 -0700872 num_waiters_--;
Ian Rogersd45f2012012-11-28 11:46:23 -0800873 // We awoke and so no longer require awakes from the guard_'s unlock.
Ian Rogers3e5cf302014-05-20 16:40:37 -0700874 CHECK_GE(guard_.num_contenders_.LoadRelaxed(), 0);
Ian Rogersb122a4b2013-11-19 18:00:50 -0800875 guard_.num_contenders_--;
Ian Rogersc604d732012-10-14 16:09:54 -0700876#else
Ian Rogersc5f17732014-06-05 20:48:42 -0700877 uint64_t old_owner = guard_.exclusive_owner_;
878 guard_.exclusive_owner_ = 0;
Ian Rogersc604d732012-10-14 16:09:54 -0700879 guard_.recursion_count_ = 0;
880 CHECK_MUTEX_CALL(pthread_cond_wait, (&cond_, &guard_.mutex_));
Ian Rogersc5f17732014-06-05 20:48:42 -0700881 guard_.exclusive_owner_ = old_owner;
Ian Rogersc604d732012-10-14 16:09:54 -0700882#endif
883 guard_.recursion_count_ = old_recursion_count;
Elliott Hughes5f791332011-09-15 17:45:30 -0700884}
885
Ian Rogers7b078e82014-09-10 14:44:24 -0700886bool ConditionVariable::TimedWait(Thread* self, int64_t ms, int32_t ns) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700887 DCHECK(self == nullptr || self == Thread::Current());
Ian Rogers7b078e82014-09-10 14:44:24 -0700888 bool timed_out = false;
Ian Rogersc604d732012-10-14 16:09:54 -0700889 guard_.AssertExclusiveHeld(self);
Ian Rogers1d54e732013-05-02 21:10:01 -0700890 guard_.CheckSafeToWait(self);
Ian Rogersc604d732012-10-14 16:09:54 -0700891 unsigned int old_recursion_count = guard_.recursion_count_;
892#if ART_USE_FUTEXES
Ian Rogersc604d732012-10-14 16:09:54 -0700893 timespec rel_ts;
Ian Rogers5bd97c42012-11-27 02:38:26 -0800894 InitTimeSpec(false, CLOCK_REALTIME, ms, ns, &rel_ts);
Ian Rogersc604d732012-10-14 16:09:54 -0700895 num_waiters_++;
Ian Rogersd45f2012012-11-28 11:46:23 -0800896 // Ensure the Mutex is contended so that requeued threads are awoken.
Ian Rogersb122a4b2013-11-19 18:00:50 -0800897 guard_.num_contenders_++;
Ian Rogersc604d732012-10-14 16:09:54 -0700898 guard_.recursion_count_ = 1;
Ian Rogers3e5cf302014-05-20 16:40:37 -0700899 int32_t cur_sequence = sequence_.LoadRelaxed();
Ian Rogersc604d732012-10-14 16:09:54 -0700900 guard_.ExclusiveUnlock(self);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700901 if (futex(sequence_.Address(), FUTEX_WAIT, cur_sequence, &rel_ts, nullptr, 0) != 0) {
Ian Rogersc604d732012-10-14 16:09:54 -0700902 if (errno == ETIMEDOUT) {
Ian Rogersd45f2012012-11-28 11:46:23 -0800903 // Timed out we're done.
Ian Rogers7b078e82014-09-10 14:44:24 -0700904 timed_out = true;
Brian Carlstrom0de79852013-07-25 22:29:58 -0700905 } else if ((errno == EAGAIN) || (errno == EINTR)) {
Ian Rogersd45f2012012-11-28 11:46:23 -0800906 // A signal or ConditionVariable::Signal/Broadcast has come in.
Ian Rogersc604d732012-10-14 16:09:54 -0700907 } else {
908 PLOG(FATAL) << "timed futex wait failed for " << name_;
909 }
910 }
911 guard_.ExclusiveLock(self);
Ian Rogersd45f2012012-11-28 11:46:23 -0800912 CHECK_GE(num_waiters_, 0);
Ian Rogersc604d732012-10-14 16:09:54 -0700913 num_waiters_--;
Ian Rogersd45f2012012-11-28 11:46:23 -0800914 // We awoke and so no longer require awakes from the guard_'s unlock.
Ian Rogers3e5cf302014-05-20 16:40:37 -0700915 CHECK_GE(guard_.num_contenders_.LoadRelaxed(), 0);
Ian Rogersb122a4b2013-11-19 18:00:50 -0800916 guard_.num_contenders_--;
Ian Rogersc604d732012-10-14 16:09:54 -0700917#else
Narayan Kamath51b71022014-03-04 11:57:09 +0000918#if !defined(__APPLE__)
Ian Rogersc604d732012-10-14 16:09:54 -0700919 int clock = CLOCK_MONOTONIC;
Elliott Hughes5f791332011-09-15 17:45:30 -0700920#else
Ian Rogersc604d732012-10-14 16:09:54 -0700921 int clock = CLOCK_REALTIME;
Elliott Hughes5f791332011-09-15 17:45:30 -0700922#endif
Ian Rogersc5f17732014-06-05 20:48:42 -0700923 uint64_t old_owner = guard_.exclusive_owner_;
924 guard_.exclusive_owner_ = 0;
Ian Rogersc604d732012-10-14 16:09:54 -0700925 guard_.recursion_count_ = 0;
926 timespec ts;
Brian Carlstrombcc29262012-11-02 11:36:03 -0700927 InitTimeSpec(true, clock, ms, ns, &ts);
Narayan Kamath51b71022014-03-04 11:57:09 +0000928 int rc = TEMP_FAILURE_RETRY(pthread_cond_timedwait(&cond_, &guard_.mutex_, &ts));
Ian Rogers7b078e82014-09-10 14:44:24 -0700929 if (rc == ETIMEDOUT) {
930 timed_out = true;
931 } else if (rc != 0) {
Elliott Hughes5f791332011-09-15 17:45:30 -0700932 errno = rc;
933 PLOG(FATAL) << "TimedWait failed for " << name_;
934 }
Ian Rogersc5f17732014-06-05 20:48:42 -0700935 guard_.exclusive_owner_ = old_owner;
Ian Rogersc604d732012-10-14 16:09:54 -0700936#endif
937 guard_.recursion_count_ = old_recursion_count;
Ian Rogers7b078e82014-09-10 14:44:24 -0700938 return timed_out;
Elliott Hughes5f791332011-09-15 17:45:30 -0700939}
940
Ian Rogers719d1a32014-03-06 12:13:39 -0800941void Locks::Init() {
942 if (logging_lock_ != nullptr) {
943 // Already initialized.
Nicolas Geoffray7f0a6d62014-05-26 14:01:46 +0100944 if (kRuntimeISA == kX86 || kRuntimeISA == kX86_64) {
Chao-ying Fu9e369312014-05-21 11:20:52 -0700945 DCHECK(modify_ldt_lock_ != nullptr);
946 } else {
947 DCHECK(modify_ldt_lock_ == nullptr);
948 }
Ian Rogers719d1a32014-03-06 12:13:39 -0800949 DCHECK(abort_lock_ != nullptr);
Brian Carlstrom306db812014-09-05 13:01:41 -0700950 DCHECK(alloc_tracker_lock_ != nullptr);
Andreas Gampe74240812014-04-17 10:35:09 -0700951 DCHECK(allocated_monitor_ids_lock_ != nullptr);
Chao-ying Fu9e369312014-05-21 11:20:52 -0700952 DCHECK(allocated_thread_ids_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800953 DCHECK(breakpoint_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800954 DCHECK(classlinker_classes_lock_ != nullptr);
Brian Carlstrom306db812014-09-05 13:01:41 -0700955 DCHECK(deoptimization_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800956 DCHECK(heap_bitmap_lock_ != nullptr);
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -0700957 DCHECK(oat_file_manager_lock_ != nullptr);
David Brazdilca3c8c32016-09-06 14:04:48 +0100958 DCHECK(verifier_deps_lock_ != nullptr);
Richard Uhlera206c742016-05-24 15:04:22 -0700959 DCHECK(host_dlopen_handles_lock_ != nullptr);
Brian Carlstrom306db812014-09-05 13:01:41 -0700960 DCHECK(intern_table_lock_ != nullptr);
Andreas Gampec8089542017-01-16 12:41:12 -0800961 DCHECK(jni_function_table_lock_ != nullptr);
Ian Rogers68d8b422014-07-17 11:09:10 -0700962 DCHECK(jni_libraries_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800963 DCHECK(logging_lock_ != nullptr);
964 DCHECK(mutator_lock_ != nullptr);
Brian Carlstrom306db812014-09-05 13:01:41 -0700965 DCHECK(profiler_lock_ != nullptr);
Mingyao Yang063fc772016-08-02 11:02:54 -0700966 DCHECK(cha_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800967 DCHECK(thread_list_lock_ != nullptr);
968 DCHECK(thread_suspend_count_lock_ != nullptr);
969 DCHECK(trace_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800970 DCHECK(unexpected_signal_lock_ != nullptr);
Andreas Gampecc1b5352016-12-01 16:58:38 -0800971 DCHECK(dex_lock_ != nullptr);
Ian Rogers719d1a32014-03-06 12:13:39 -0800972 } else {
Chao-ying Fu9e369312014-05-21 11:20:52 -0700973 // Create global locks in level order from highest lock level to lowest.
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800974 LockLevel current_lock_level = kInstrumentEntrypointsLock;
975 DCHECK(instrument_entrypoints_lock_ == nullptr);
976 instrument_entrypoints_lock_ = new Mutex("instrument entrypoint lock", current_lock_level);
Ian Rogers719d1a32014-03-06 12:13:39 -0800977
Chao-ying Fu9e369312014-05-21 11:20:52 -0700978 #define UPDATE_CURRENT_LOCK_LEVEL(new_level) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -0700979 if ((new_level) >= current_lock_level) { \
Brian Carlstrom306db812014-09-05 13:01:41 -0700980 /* Do not use CHECKs or FATAL here, abort_lock_ is not setup yet. */ \
981 fprintf(stderr, "New local level %d is not less than current level %d\n", \
982 new_level, current_lock_level); \
983 exit(1); \
984 } \
Ian Rogersf3d874c2014-07-17 18:52:42 -0700985 current_lock_level = new_level;
986
987 UPDATE_CURRENT_LOCK_LEVEL(kMutatorLock);
988 DCHECK(mutator_lock_ == nullptr);
Yu Lieac44242015-06-29 10:50:03 +0800989 mutator_lock_ = new MutatorMutex("mutator lock", current_lock_level);
Chao-ying Fu9e369312014-05-21 11:20:52 -0700990
991 UPDATE_CURRENT_LOCK_LEVEL(kHeapBitmapLock);
992 DCHECK(heap_bitmap_lock_ == nullptr);
993 heap_bitmap_lock_ = new ReaderWriterMutex("heap bitmap lock", current_lock_level);
994
Jeff Hao69dbec62014-09-15 18:03:41 -0700995 UPDATE_CURRENT_LOCK_LEVEL(kTraceLock);
996 DCHECK(trace_lock_ == nullptr);
997 trace_lock_ = new Mutex("trace lock", current_lock_level);
998
Chao-ying Fu9e369312014-05-21 11:20:52 -0700999 UPDATE_CURRENT_LOCK_LEVEL(kRuntimeShutdownLock);
1000 DCHECK(runtime_shutdown_lock_ == nullptr);
1001 runtime_shutdown_lock_ = new Mutex("runtime shutdown lock", current_lock_level);
1002
1003 UPDATE_CURRENT_LOCK_LEVEL(kProfilerLock);
1004 DCHECK(profiler_lock_ == nullptr);
1005 profiler_lock_ = new Mutex("profiler lock", current_lock_level);
1006
Brian Carlstrom306db812014-09-05 13:01:41 -07001007 UPDATE_CURRENT_LOCK_LEVEL(kDeoptimizationLock);
1008 DCHECK(deoptimization_lock_ == nullptr);
1009 deoptimization_lock_ = new Mutex("Deoptimization lock", current_lock_level);
1010
1011 UPDATE_CURRENT_LOCK_LEVEL(kAllocTrackerLock);
1012 DCHECK(alloc_tracker_lock_ == nullptr);
1013 alloc_tracker_lock_ = new Mutex("AllocTracker lock", current_lock_level);
1014
Chao-ying Fu9e369312014-05-21 11:20:52 -07001015 UPDATE_CURRENT_LOCK_LEVEL(kThreadListLock);
1016 DCHECK(thread_list_lock_ == nullptr);
1017 thread_list_lock_ = new Mutex("thread list lock", current_lock_level);
1018
Ian Rogers68d8b422014-07-17 11:09:10 -07001019 UPDATE_CURRENT_LOCK_LEVEL(kJniLoadLibraryLock);
1020 DCHECK(jni_libraries_lock_ == nullptr);
1021 jni_libraries_lock_ = new Mutex("JNI shared libraries map lock", current_lock_level);
1022
Chao-ying Fu9e369312014-05-21 11:20:52 -07001023 UPDATE_CURRENT_LOCK_LEVEL(kBreakpointLock);
Ian Rogers719d1a32014-03-06 12:13:39 -08001024 DCHECK(breakpoint_lock_ == nullptr);
Sebastien Hertzed2be172014-08-19 15:33:43 +02001025 breakpoint_lock_ = new ReaderWriterMutex("breakpoint lock", current_lock_level);
Chao-ying Fu9e369312014-05-21 11:20:52 -07001026
Mingyao Yang063fc772016-08-02 11:02:54 -07001027 UPDATE_CURRENT_LOCK_LEVEL(kCHALock);
1028 DCHECK(cha_lock_ == nullptr);
1029 cha_lock_ = new Mutex("CHA lock", current_lock_level);
1030
Chao-ying Fu9e369312014-05-21 11:20:52 -07001031 UPDATE_CURRENT_LOCK_LEVEL(kClassLinkerClassesLock);
Ian Rogers719d1a32014-03-06 12:13:39 -08001032 DCHECK(classlinker_classes_lock_ == nullptr);
1033 classlinker_classes_lock_ = new ReaderWriterMutex("ClassLinker classes lock",
Chao-ying Fu9e369312014-05-21 11:20:52 -07001034 current_lock_level);
1035
Andreas Gampe74240812014-04-17 10:35:09 -07001036 UPDATE_CURRENT_LOCK_LEVEL(kMonitorPoolLock);
1037 DCHECK(allocated_monitor_ids_lock_ == nullptr);
1038 allocated_monitor_ids_lock_ = new Mutex("allocated monitor ids lock", current_lock_level);
1039
Chao-ying Fu9e369312014-05-21 11:20:52 -07001040 UPDATE_CURRENT_LOCK_LEVEL(kAllocatedThreadIdsLock);
1041 DCHECK(allocated_thread_ids_lock_ == nullptr);
1042 allocated_thread_ids_lock_ = new Mutex("allocated thread ids lock", current_lock_level);
1043
Nicolas Geoffray7f0a6d62014-05-26 14:01:46 +01001044 if (kRuntimeISA == kX86 || kRuntimeISA == kX86_64) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001045 UPDATE_CURRENT_LOCK_LEVEL(kModifyLdtLock);
1046 DCHECK(modify_ldt_lock_ == nullptr);
1047 modify_ldt_lock_ = new Mutex("modify_ldt lock", current_lock_level);
1048 }
1049
Andreas Gampecc1b5352016-12-01 16:58:38 -08001050 UPDATE_CURRENT_LOCK_LEVEL(kDexLock);
1051 DCHECK(dex_lock_ == nullptr);
1052 dex_lock_ = new ReaderWriterMutex("ClassLinker dex lock", current_lock_level);
1053
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -07001054 UPDATE_CURRENT_LOCK_LEVEL(kOatFileManagerLock);
1055 DCHECK(oat_file_manager_lock_ == nullptr);
1056 oat_file_manager_lock_ = new ReaderWriterMutex("OatFile manager lock", current_lock_level);
1057
David Brazdilca3c8c32016-09-06 14:04:48 +01001058 UPDATE_CURRENT_LOCK_LEVEL(kVerifierDepsLock);
1059 DCHECK(verifier_deps_lock_ == nullptr);
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00001060 verifier_deps_lock_ = new ReaderWriterMutex("verifier deps lock", current_lock_level);
David Brazdilca3c8c32016-09-06 14:04:48 +01001061
Richard Uhlera206c742016-05-24 15:04:22 -07001062 UPDATE_CURRENT_LOCK_LEVEL(kHostDlOpenHandlesLock);
1063 DCHECK(host_dlopen_handles_lock_ == nullptr);
1064 host_dlopen_handles_lock_ = new Mutex("host dlopen handles lock", current_lock_level);
Mathieu Chartiere58991b2015-10-13 07:59:34 -07001065
Chao-ying Fu9e369312014-05-21 11:20:52 -07001066 UPDATE_CURRENT_LOCK_LEVEL(kInternTableLock);
Ian Rogers719d1a32014-03-06 12:13:39 -08001067 DCHECK(intern_table_lock_ == nullptr);
Chao-ying Fu9e369312014-05-21 11:20:52 -07001068 intern_table_lock_ = new Mutex("InternTable lock", current_lock_level);
1069
Mathieu Chartiera5a53ef2014-09-12 12:58:05 -07001070 UPDATE_CURRENT_LOCK_LEVEL(kReferenceProcessorLock);
1071 DCHECK(reference_processor_lock_ == nullptr);
1072 reference_processor_lock_ = new Mutex("ReferenceProcessor lock", current_lock_level);
1073
1074 UPDATE_CURRENT_LOCK_LEVEL(kReferenceQueueClearedReferencesLock);
1075 DCHECK(reference_queue_cleared_references_lock_ == nullptr);
1076 reference_queue_cleared_references_lock_ = new Mutex("ReferenceQueue cleared references lock", current_lock_level);
1077
1078 UPDATE_CURRENT_LOCK_LEVEL(kReferenceQueueWeakReferencesLock);
1079 DCHECK(reference_queue_weak_references_lock_ == nullptr);
1080 reference_queue_weak_references_lock_ = new Mutex("ReferenceQueue cleared references lock", current_lock_level);
1081
1082 UPDATE_CURRENT_LOCK_LEVEL(kReferenceQueueFinalizerReferencesLock);
1083 DCHECK(reference_queue_finalizer_references_lock_ == nullptr);
1084 reference_queue_finalizer_references_lock_ = new Mutex("ReferenceQueue finalizer references lock", current_lock_level);
1085
1086 UPDATE_CURRENT_LOCK_LEVEL(kReferenceQueuePhantomReferencesLock);
1087 DCHECK(reference_queue_phantom_references_lock_ == nullptr);
1088 reference_queue_phantom_references_lock_ = new Mutex("ReferenceQueue phantom references lock", current_lock_level);
1089
1090 UPDATE_CURRENT_LOCK_LEVEL(kReferenceQueueSoftReferencesLock);
1091 DCHECK(reference_queue_soft_references_lock_ == nullptr);
1092 reference_queue_soft_references_lock_ = new Mutex("ReferenceQueue soft references lock", current_lock_level);
1093
Andreas Gampe05a364c2016-10-14 13:27:12 -07001094 UPDATE_CURRENT_LOCK_LEVEL(kJniGlobalsLock);
1095 DCHECK(jni_globals_lock_ == nullptr);
1096 jni_globals_lock_ =
1097 new ReaderWriterMutex("JNI global reference table lock", current_lock_level);
1098
1099 UPDATE_CURRENT_LOCK_LEVEL(kJniWeakGlobalsLock);
1100 DCHECK(jni_weak_globals_lock_ == nullptr);
1101 jni_weak_globals_lock_ = new Mutex("JNI weak global reference table lock", current_lock_level);
1102
Andreas Gampec8089542017-01-16 12:41:12 -08001103 UPDATE_CURRENT_LOCK_LEVEL(kJniFunctionTableLock);
1104 DCHECK(jni_function_table_lock_ == nullptr);
1105 jni_function_table_lock_ = new Mutex("JNI function table lock", current_lock_level);
1106
Chao-ying Fu9e369312014-05-21 11:20:52 -07001107 UPDATE_CURRENT_LOCK_LEVEL(kAbortLock);
1108 DCHECK(abort_lock_ == nullptr);
1109 abort_lock_ = new Mutex("abort lock", current_lock_level, true);
1110
1111 UPDATE_CURRENT_LOCK_LEVEL(kThreadSuspendCountLock);
1112 DCHECK(thread_suspend_count_lock_ == nullptr);
1113 thread_suspend_count_lock_ = new Mutex("thread suspend count lock", current_lock_level);
1114
1115 UPDATE_CURRENT_LOCK_LEVEL(kUnexpectedSignalLock);
1116 DCHECK(unexpected_signal_lock_ == nullptr);
1117 unexpected_signal_lock_ = new Mutex("unexpected signal lock", current_lock_level, true);
1118
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -07001119 UPDATE_CURRENT_LOCK_LEVEL(kMemMapsLock);
1120 DCHECK(mem_maps_lock_ == nullptr);
1121 mem_maps_lock_ = new Mutex("mem maps lock", current_lock_level);
1122
Chao-ying Fu9e369312014-05-21 11:20:52 -07001123 UPDATE_CURRENT_LOCK_LEVEL(kLoggingLock);
1124 DCHECK(logging_lock_ == nullptr);
1125 logging_lock_ = new Mutex("logging lock", current_lock_level, true);
1126
1127 #undef UPDATE_CURRENT_LOCK_LEVEL
Mathieu Chartier91e56692015-03-03 13:51:04 -08001128
1129 InitConditions();
Ian Rogers719d1a32014-03-06 12:13:39 -08001130 }
1131}
1132
Mathieu Chartier91e56692015-03-03 13:51:04 -08001133void Locks::InitConditions() {
1134 thread_exit_cond_ = new ConditionVariable("thread exit condition variable", *thread_list_lock_);
1135}
Ian Rogers719d1a32014-03-06 12:13:39 -08001136
David Sehrf42eb2c2016-10-19 13:20:45 -07001137void Locks::SetClientCallback(ClientCallback* safe_to_call_abort_cb) {
1138 safe_to_call_abort_callback.StoreRelease(safe_to_call_abort_cb);
1139}
1140
1141// Helper to allow checking shutdown while ignoring locking requirements.
1142bool Locks::IsSafeToCallAbortRacy() {
1143 Locks::ClientCallback* safe_to_call_abort_cb = safe_to_call_abort_callback.LoadAcquire();
1144 return safe_to_call_abort_cb != nullptr && safe_to_call_abort_cb();
1145}
1146
Elliott Hughese62934d2012-04-09 11:24:29 -07001147} // namespace art