blob: 3680c78311b88e48ca179fc857a21f01824e60ad [file] [log] [blame]
Elliott Hughes5f791332011-09-15 17:45:30 -07001/*
2 * Copyright (C) 2008 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
Elliott Hughes54e7df12011-09-16 11:47:04 -070017#include "monitor.h"
Elliott Hughes5f791332011-09-15 17:45:30 -070018
Elliott Hughes08fc03a2012-06-26 17:34:00 -070019#include <vector>
20
Mathieu Chartiere401d142015-04-22 13:56:20 -070021#include "art_method-inl.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080022#include "base/mutex.h"
Elliott Hughes1aa246d2012-12-13 09:29:36 -080023#include "base/stl_util.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080024#include "base/systrace.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010025#include "base/time_utils.h"
jeffhao33dc7712011-11-09 17:54:24 -080026#include "class_linker.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070027#include "dex_file-inl.h"
Sebastien Hertz0f7c9332015-11-05 15:57:30 +010028#include "dex_instruction-inl.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070029#include "lock_word-inl.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070030#include "mirror/class-inl.h"
Ian Rogers05f30572013-02-20 12:13:11 -080031#include "mirror/object-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080032#include "mirror/object_array-inl.h"
Ian Rogers00f7d0e2012-07-19 15:28:27 -070033#include "scoped_thread_state_change.h"
Elliott Hughes5f791332011-09-15 17:45:30 -070034#include "thread.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070035#include "thread_list.h"
Elliott Hughes08fc03a2012-06-26 17:34:00 -070036#include "verifier/method_verifier.h"
Elliott Hughes044288f2012-06-25 14:46:39 -070037#include "well_known_classes.h"
Elliott Hughes5f791332011-09-15 17:45:30 -070038
39namespace art {
40
Mathieu Chartierb9001ab2014-10-03 13:28:46 -070041static constexpr uint64_t kLongWaitMs = 100;
42
Elliott Hughes5f791332011-09-15 17:45:30 -070043/*
Ian Rogersd9c4fc92013-10-01 19:45:43 -070044 * Every Object has a monitor associated with it, but not every Object is actually locked. Even
45 * the ones that are locked do not need a full-fledged monitor until a) there is actual contention
46 * or b) wait() is called on the Object.
Elliott Hughes5f791332011-09-15 17:45:30 -070047 *
Ian Rogersd9c4fc92013-10-01 19:45:43 -070048 * For Android, we have implemented a scheme similar to the one described in Bacon et al.'s
49 * "Thin locks: featherweight synchronization for Java" (ACM 1998). Things are even easier for us,
50 * though, because we have a full 32 bits to work with.
Elliott Hughes5f791332011-09-15 17:45:30 -070051 *
Ian Rogersd9c4fc92013-10-01 19:45:43 -070052 * The two states of an Object's lock are referred to as "thin" and "fat". A lock may transition
53 * from the "thin" state to the "fat" state and this transition is referred to as inflation. Once
54 * a lock has been inflated it remains in the "fat" state indefinitely.
Elliott Hughes5f791332011-09-15 17:45:30 -070055 *
Ian Rogersd9c4fc92013-10-01 19:45:43 -070056 * The lock value itself is stored in mirror::Object::monitor_ and the representation is described
57 * in the LockWord value type.
Elliott Hughes54e7df12011-09-16 11:47:04 -070058 *
Elliott Hughes5f791332011-09-15 17:45:30 -070059 * Monitors provide:
60 * - mutually exclusive access to resources
61 * - a way for multiple threads to wait for notification
62 *
63 * In effect, they fill the role of both mutexes and condition variables.
64 *
Ian Rogersd9c4fc92013-10-01 19:45:43 -070065 * Only one thread can own the monitor at any time. There may be several threads waiting on it
66 * (the wait call unlocks it). One or more waiting threads may be getting interrupted or notified
67 * at any given time.
Elliott Hughes5f791332011-09-15 17:45:30 -070068 */
Elliott Hughes54e7df12011-09-16 11:47:04 -070069
Elliott Hughesfc861622011-10-17 17:57:47 -070070uint32_t Monitor::lock_profiling_threshold_ = 0;
Elliott Hughes32d6e1e2011-10-11 14:47:44 -070071
Calin Juravleb2771b42016-04-07 17:09:25 +010072void Monitor::Init(uint32_t lock_profiling_threshold) {
Elliott Hughesfc861622011-10-17 17:57:47 -070073 lock_profiling_threshold_ = lock_profiling_threshold;
Elliott Hughes32d6e1e2011-10-11 14:47:44 -070074}
75
Ian Rogersef7d42f2014-01-06 12:55:46 -080076Monitor::Monitor(Thread* self, Thread* owner, mirror::Object* obj, int32_t hash_code)
Ian Rogers00f7d0e2012-07-19 15:28:27 -070077 : monitor_lock_("a monitor lock", kMonitorLock),
Ian Rogersd9c4fc92013-10-01 19:45:43 -070078 monitor_contenders_("monitor contenders", monitor_lock_),
Mathieu Chartier46bc7782013-11-12 17:03:02 -080079 num_waiters_(0),
Ian Rogers00f7d0e2012-07-19 15:28:27 -070080 owner_(owner),
Elliott Hughes5f791332011-09-15 17:45:30 -070081 lock_count_(0),
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -070082 obj_(GcRoot<mirror::Object>(obj)),
Mathieu Chartier2cebb242015-04-21 16:50:40 -070083 wait_set_(nullptr),
Mathieu Chartierad2541a2013-10-25 10:05:23 -070084 hash_code_(hash_code),
Mathieu Chartier2cebb242015-04-21 16:50:40 -070085 locking_method_(nullptr),
Ian Rogersef7d42f2014-01-06 12:55:46 -080086 locking_dex_pc_(0),
Andreas Gampe74240812014-04-17 10:35:09 -070087 monitor_id_(MonitorPool::ComputeMonitorId(this, self)) {
88#ifdef __LP64__
89 DCHECK(false) << "Should not be reached in 64b";
90 next_free_ = nullptr;
91#endif
92 // We should only inflate a lock if the owner is ourselves or suspended. This avoids a race
93 // with the owner unlocking the thin-lock.
94 CHECK(owner == nullptr || owner == self || owner->IsSuspended());
95 // The identity hash code is set for the life time of the monitor.
96}
97
98Monitor::Monitor(Thread* self, Thread* owner, mirror::Object* obj, int32_t hash_code,
99 MonitorId id)
100 : monitor_lock_("a monitor lock", kMonitorLock),
101 monitor_contenders_("monitor contenders", monitor_lock_),
102 num_waiters_(0),
103 owner_(owner),
104 lock_count_(0),
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700105 obj_(GcRoot<mirror::Object>(obj)),
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700106 wait_set_(nullptr),
Andreas Gampe74240812014-04-17 10:35:09 -0700107 hash_code_(hash_code),
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700108 locking_method_(nullptr),
Andreas Gampe74240812014-04-17 10:35:09 -0700109 locking_dex_pc_(0),
110 monitor_id_(id) {
111#ifdef __LP64__
112 next_free_ = nullptr;
113#endif
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700114 // We should only inflate a lock if the owner is ourselves or suspended. This avoids a race
115 // with the owner unlocking the thin-lock.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800116 CHECK(owner == nullptr || owner == self || owner->IsSuspended());
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700117 // The identity hash code is set for the life time of the monitor.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700118}
119
Mathieu Chartier4e6a31e2013-10-31 10:35:05 -0700120int32_t Monitor::GetHashCode() {
121 while (!HasHashCode()) {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700122 if (hash_code_.CompareExchangeWeakRelaxed(0, mirror::Object::GenerateIdentityHashCode())) {
Mathieu Chartier4e6a31e2013-10-31 10:35:05 -0700123 break;
124 }
125 }
126 DCHECK(HasHashCode());
Ian Rogers3e5cf302014-05-20 16:40:37 -0700127 return hash_code_.LoadRelaxed();
Mathieu Chartier4e6a31e2013-10-31 10:35:05 -0700128}
129
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700130bool Monitor::Install(Thread* self) {
131 MutexLock mu(self, monitor_lock_); // Uncontended mutex acquisition as monitor isn't yet public.
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700132 CHECK(owner_ == nullptr || owner_ == self || owner_->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700133 // Propagate the lock state.
Hiroshi Yamauchi4cba0d92014-05-21 21:10:23 -0700134 LockWord lw(GetObject()->GetLockWord(false));
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700135 switch (lw.GetState()) {
136 case LockWord::kThinLocked: {
137 CHECK_EQ(owner_->GetThreadId(), lw.ThinLockOwner());
138 lock_count_ = lw.ThinLockCount();
139 break;
140 }
141 case LockWord::kHashCode: {
Ian Rogers3e5cf302014-05-20 16:40:37 -0700142 CHECK_EQ(hash_code_.LoadRelaxed(), static_cast<int32_t>(lw.GetHashCode()));
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700143 break;
144 }
145 case LockWord::kFatLocked: {
146 // The owner_ is suspended but another thread beat us to install a monitor.
147 return false;
148 }
149 case LockWord::kUnlocked: {
150 LOG(FATAL) << "Inflating unlocked lock word";
151 break;
152 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700153 default: {
154 LOG(FATAL) << "Invalid monitor state " << lw.GetState();
155 return false;
156 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700157 }
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800158 LockWord fat(this, lw.ReadBarrierState());
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700159 // Publish the updated lock word, which may race with other threads.
Ian Rogers228602f2014-07-10 02:07:54 -0700160 bool success = GetObject()->CasLockWordWeakSequentiallyConsistent(lw, fat);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700161 // Lock profiling.
Mathieu Chartier9728f912013-10-30 09:45:13 -0700162 if (success && owner_ != nullptr && lock_profiling_threshold_ != 0) {
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -0700163 // Do not abort on dex pc errors. This can easily happen when we want to dump a stack trace on
164 // abort.
165 locking_method_ = owner_->GetCurrentMethod(&locking_dex_pc_, false);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700166 }
167 return success;
Elliott Hughes5f791332011-09-15 17:45:30 -0700168}
169
170Monitor::~Monitor() {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700171 // Deflated monitors have a null object.
Elliott Hughes5f791332011-09-15 17:45:30 -0700172}
173
Elliott Hughes5f791332011-09-15 17:45:30 -0700174void Monitor::AppendToWaitSet(Thread* thread) {
175 DCHECK(owner_ == Thread::Current());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700176 DCHECK(thread != nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700177 DCHECK(thread->GetWaitNext() == nullptr) << thread->GetWaitNext();
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700178 if (wait_set_ == nullptr) {
Elliott Hughes5f791332011-09-15 17:45:30 -0700179 wait_set_ = thread;
180 return;
181 }
182
183 // push_back.
184 Thread* t = wait_set_;
Ian Rogersdd7624d2014-03-14 17:43:00 -0700185 while (t->GetWaitNext() != nullptr) {
186 t = t->GetWaitNext();
Elliott Hughes5f791332011-09-15 17:45:30 -0700187 }
Ian Rogersdd7624d2014-03-14 17:43:00 -0700188 t->SetWaitNext(thread);
Elliott Hughes5f791332011-09-15 17:45:30 -0700189}
190
Elliott Hughes5f791332011-09-15 17:45:30 -0700191void Monitor::RemoveFromWaitSet(Thread *thread) {
192 DCHECK(owner_ == Thread::Current());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700193 DCHECK(thread != nullptr);
194 if (wait_set_ == nullptr) {
Elliott Hughes5f791332011-09-15 17:45:30 -0700195 return;
196 }
197 if (wait_set_ == thread) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700198 wait_set_ = thread->GetWaitNext();
199 thread->SetWaitNext(nullptr);
Elliott Hughes5f791332011-09-15 17:45:30 -0700200 return;
201 }
202
203 Thread* t = wait_set_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700204 while (t->GetWaitNext() != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700205 if (t->GetWaitNext() == thread) {
206 t->SetWaitNext(thread->GetWaitNext());
207 thread->SetWaitNext(nullptr);
Elliott Hughes5f791332011-09-15 17:45:30 -0700208 return;
209 }
Ian Rogersdd7624d2014-03-14 17:43:00 -0700210 t = t->GetWaitNext();
Elliott Hughes5f791332011-09-15 17:45:30 -0700211 }
212}
213
Mathieu Chartier6aa3df92013-09-17 15:17:28 -0700214void Monitor::SetObject(mirror::Object* object) {
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700215 obj_ = GcRoot<mirror::Object>(object);
Mathieu Chartier6aa3df92013-09-17 15:17:28 -0700216}
217
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700218std::string Monitor::PrettyContentionInfo(const std::string& owner_name,
219 pid_t owner_tid,
Mathieu Chartier74b3c8f2016-04-15 19:11:45 -0700220 ArtMethod* owners_method,
221 uint32_t owners_dex_pc,
222 size_t num_waiters) {
Mathieu Chartier74b3c8f2016-04-15 19:11:45 -0700223 const char* owners_filename;
Goran Jakovljevic49c882b2016-04-19 10:27:21 +0200224 int32_t owners_line_number = 0;
Mathieu Chartier74b3c8f2016-04-15 19:11:45 -0700225 if (owners_method != nullptr) {
226 TranslateLocation(owners_method, owners_dex_pc, &owners_filename, &owners_line_number);
227 }
228 std::ostringstream oss;
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700229 oss << "monitor contention with owner " << owner_name << " (" << owner_tid << ")";
Mathieu Chartier74b3c8f2016-04-15 19:11:45 -0700230 if (owners_method != nullptr) {
231 oss << " owner method=" << PrettyMethod(owners_method);
232 oss << " from " << owners_filename << ":" << owners_line_number;
233 }
234 oss << " waiters=" << num_waiters;
235 return oss.str();
236}
237
Elliott Hughes5f791332011-09-15 17:45:30 -0700238void Monitor::Lock(Thread* self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700239 MutexLock mu(self, monitor_lock_);
240 while (true) {
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700241 if (owner_ == nullptr) { // Unowned.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700242 owner_ = self;
243 CHECK_EQ(lock_count_, 0);
244 // When debugging, save the current monitor holder for future
245 // acquisition failures to use in sampled logging.
246 if (lock_profiling_threshold_ != 0) {
247 locking_method_ = self->GetCurrentMethod(&locking_dex_pc_);
248 }
249 return;
250 } else if (owner_ == self) { // Recursive.
251 lock_count_++;
252 return;
253 }
254 // Contended.
255 const bool log_contention = (lock_profiling_threshold_ != 0);
Xin Guanb894a192014-08-22 11:55:37 -0500256 uint64_t wait_start_ms = log_contention ? MilliTime() : 0;
Mathieu Chartiere401d142015-04-22 13:56:20 -0700257 ArtMethod* owners_method = locking_method_;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700258 uint32_t owners_dex_pc = locking_dex_pc_;
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700259 // Do this before releasing the lock so that we don't get deflated.
Mathieu Chartierb9001ab2014-10-03 13:28:46 -0700260 size_t num_waiters = num_waiters_;
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700261 ++num_waiters_;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700262 monitor_lock_.Unlock(self); // Let go of locks in order.
Mathieu Chartiera6e7f082014-05-22 14:43:37 -0700263 self->SetMonitorEnterObject(GetObject());
Elliott Hughes5f791332011-09-15 17:45:30 -0700264 {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700265 uint32_t original_owner_thread_id = 0u;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700266 ScopedThreadStateChange tsc(self, kBlocked); // Change to blocked and give up mutator_lock_.
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700267 {
268 // Reacquire monitor_lock_ without mutator_lock_ for Wait.
269 MutexLock mu2(self, monitor_lock_);
270 if (owner_ != nullptr) { // Did the owner_ give the lock up?
271 original_owner_thread_id = owner_->GetThreadId();
272 if (ATRACE_ENABLED()) {
273 std::ostringstream oss;
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700274 std::string name;
275 owner_->GetThreadName(name);
276 oss << PrettyContentionInfo(name,
277 owner_->GetTid(),
278 owners_method,
279 owners_dex_pc,
280 num_waiters);
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700281 // Add info for contending thread.
282 uint32_t pc;
283 ArtMethod* m = self->GetCurrentMethod(&pc);
284 const char* filename;
285 int32_t line_number;
286 TranslateLocation(m, pc, &filename, &line_number);
287 oss << " blocking from " << (filename != nullptr ? filename : "null")
288 << ":" << line_number;
289 ATRACE_BEGIN(oss.str().c_str());
290 }
291 monitor_contenders_.Wait(self); // Still contended so wait.
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800292 }
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700293 }
294 if (original_owner_thread_id != 0u) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700295 // Woken from contention.
296 if (log_contention) {
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700297 uint32_t original_owner_tid = 0;
298 std::string original_owner_name;
299 {
300 MutexLock mu2(Thread::Current(), *Locks::thread_list_lock_);
301 // Re-find the owner in case the thread got killed.
302 Thread* original_owner = Runtime::Current()->GetThreadList()->FindThreadByThreadId(
303 original_owner_thread_id);
304 // Do not do any work that requires the mutator lock.
305 if (original_owner != nullptr) {
306 original_owner_tid = original_owner->GetTid();
307 original_owner->GetThreadName(original_owner_name);
308 }
309 }
310
311 if (original_owner_tid != 0u) {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700312 uint64_t wait_ms = MilliTime() - wait_start_ms;
313 uint32_t sample_percent;
314 if (wait_ms >= lock_profiling_threshold_) {
315 sample_percent = 100;
316 } else {
317 sample_percent = 100 * wait_ms / lock_profiling_threshold_;
Mathieu Chartier74b3c8f2016-04-15 19:11:45 -0700318 }
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700319 if (sample_percent != 0 && (static_cast<uint32_t>(rand() % 100) < sample_percent)) {
320 if (wait_ms > kLongWaitMs && owners_method != nullptr) {
321 // TODO: We should maybe check that original_owner is still a live thread.
322 LOG(WARNING) << "Long "
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700323 << PrettyContentionInfo(original_owner_name,
324 original_owner_tid,
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700325 owners_method,
326 owners_dex_pc,
327 num_waiters)
328 << " for " << PrettyDuration(MsToNs(wait_ms));
329 }
330 const char* owners_filename;
331 int32_t owners_line_number;
332 TranslateLocation(owners_method,
333 owners_dex_pc,
334 &owners_filename,
335 &owners_line_number);
336 LogContentionEvent(self,
337 wait_ms,
338 sample_percent,
339 owners_filename,
340 owners_line_number);
341 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700342 }
343 }
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800344 ATRACE_END();
Elliott Hughesfc861622011-10-17 17:57:47 -0700345 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700346 }
Mathieu Chartiera6e7f082014-05-22 14:43:37 -0700347 self->SetMonitorEnterObject(nullptr);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700348 monitor_lock_.Lock(self); // Reacquire locks in order.
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700349 --num_waiters_;
Elliott Hughesfc861622011-10-17 17:57:47 -0700350 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700351}
352
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800353static void ThrowIllegalMonitorStateExceptionF(const char* fmt, ...)
354 __attribute__((format(printf, 1, 2)));
355
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700356static void ThrowIllegalMonitorStateExceptionF(const char* fmt, ...)
Mathieu Chartier90443472015-07-16 20:32:27 -0700357 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800358 va_list args;
359 va_start(args, fmt);
Ian Rogers62d6c772013-02-27 08:32:07 -0800360 Thread* self = Thread::Current();
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +0000361 self->ThrowNewExceptionV("Ljava/lang/IllegalMonitorStateException;", fmt, args);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700362 if (!Runtime::Current()->IsStarted() || VLOG_IS_ON(monitor)) {
Brian Carlstrom64277f32012-03-26 23:53:34 -0700363 std::ostringstream ss;
Ian Rogers62d6c772013-02-27 08:32:07 -0800364 self->Dump(ss);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700365 LOG(Runtime::Current()->IsStarted() ? INFO : ERROR)
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000366 << self->GetException()->Dump() << "\n" << ss.str();
Brian Carlstrom64277f32012-03-26 23:53:34 -0700367 }
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800368 va_end(args);
369}
370
Elliott Hughesd4237412012-02-21 11:24:45 -0800371static std::string ThreadToString(Thread* thread) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700372 if (thread == nullptr) {
373 return "nullptr";
Elliott Hughesd4237412012-02-21 11:24:45 -0800374 }
375 std::ostringstream oss;
376 // TODO: alternatively, we could just return the thread's name.
377 oss << *thread;
378 return oss.str();
379}
380
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700381void Monitor::FailedUnlock(mirror::Object* o,
382 uint32_t expected_owner_thread_id,
383 uint32_t found_owner_thread_id,
Elliott Hughesffb465f2012-03-01 18:46:05 -0800384 Monitor* monitor) {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700385 // Acquire thread list lock so threads won't disappear from under us.
Elliott Hughesffb465f2012-03-01 18:46:05 -0800386 std::string current_owner_string;
387 std::string expected_owner_string;
388 std::string found_owner_string;
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700389 uint32_t current_owner_thread_id = 0u;
Elliott Hughesffb465f2012-03-01 18:46:05 -0800390 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700391 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700392 ThreadList* const thread_list = Runtime::Current()->GetThreadList();
393 Thread* expected_owner = thread_list->FindThreadByThreadId(expected_owner_thread_id);
394 Thread* found_owner = thread_list->FindThreadByThreadId(found_owner_thread_id);
395
Elliott Hughesffb465f2012-03-01 18:46:05 -0800396 // Re-read owner now that we hold lock.
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700397 Thread* current_owner = (monitor != nullptr) ? monitor->GetOwner() : nullptr;
398 if (current_owner != nullptr) {
399 current_owner_thread_id = current_owner->GetThreadId();
400 }
Elliott Hughesffb465f2012-03-01 18:46:05 -0800401 // Get short descriptions of the threads involved.
402 current_owner_string = ThreadToString(current_owner);
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700403 expected_owner_string = expected_owner != nullptr ? ThreadToString(expected_owner) : "unnamed";
404 found_owner_string = found_owner != nullptr ? ThreadToString(found_owner) : "unnamed";
Elliott Hughesffb465f2012-03-01 18:46:05 -0800405 }
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700406
407 if (current_owner_thread_id == 0u) {
408 if (found_owner_thread_id == 0u) {
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800409 ThrowIllegalMonitorStateExceptionF("unlock of unowned monitor on object of type '%s'"
410 " on thread '%s'",
Elliott Hughesffb465f2012-03-01 18:46:05 -0800411 PrettyTypeOf(o).c_str(),
412 expected_owner_string.c_str());
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800413 } else {
414 // Race: the original read found an owner but now there is none
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800415 ThrowIllegalMonitorStateExceptionF("unlock of monitor owned by '%s' on object of type '%s'"
416 " (where now the monitor appears unowned) on thread '%s'",
Elliott Hughesffb465f2012-03-01 18:46:05 -0800417 found_owner_string.c_str(),
418 PrettyTypeOf(o).c_str(),
419 expected_owner_string.c_str());
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800420 }
421 } else {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700422 if (found_owner_thread_id == 0u) {
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800423 // Race: originally there was no owner, there is now
424 ThrowIllegalMonitorStateExceptionF("unlock of monitor owned by '%s' on object of type '%s'"
425 " (originally believed to be unowned) on thread '%s'",
Elliott Hughesffb465f2012-03-01 18:46:05 -0800426 current_owner_string.c_str(),
427 PrettyTypeOf(o).c_str(),
428 expected_owner_string.c_str());
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800429 } else {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700430 if (found_owner_thread_id != current_owner_thread_id) {
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800431 // Race: originally found and current owner have changed
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800432 ThrowIllegalMonitorStateExceptionF("unlock of monitor originally owned by '%s' (now"
433 " owned by '%s') on object of type '%s' on thread '%s'",
Elliott Hughesffb465f2012-03-01 18:46:05 -0800434 found_owner_string.c_str(),
435 current_owner_string.c_str(),
436 PrettyTypeOf(o).c_str(),
437 expected_owner_string.c_str());
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800438 } else {
439 ThrowIllegalMonitorStateExceptionF("unlock of monitor owned by '%s' on object of type '%s'"
440 " on thread '%s",
Elliott Hughesffb465f2012-03-01 18:46:05 -0800441 current_owner_string.c_str(),
442 PrettyTypeOf(o).c_str(),
443 expected_owner_string.c_str());
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800444 }
445 }
446 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700447}
448
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700449bool Monitor::Unlock(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700450 DCHECK(self != nullptr);
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700451 uint32_t owner_thread_id = 0u;
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700452 {
453 MutexLock mu(self, monitor_lock_);
454 Thread* owner = owner_;
Mathieu Chartier0ffdc9c2016-04-19 13:46:03 -0700455 if (owner != nullptr) {
456 owner_thread_id = owner->GetThreadId();
457 }
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700458 if (owner == self) {
459 // We own the monitor, so nobody else can be in here.
460 if (lock_count_ == 0) {
461 owner_ = nullptr;
462 locking_method_ = nullptr;
463 locking_dex_pc_ = 0;
464 // Wake a contender.
465 monitor_contenders_.Signal(self);
466 } else {
467 --lock_count_;
468 }
469 return true;
Elliott Hughes5f791332011-09-15 17:45:30 -0700470 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700471 }
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700472 // We don't own this, so we're not allowed to unlock it.
473 // The JNI spec says that we should throw IllegalMonitorStateException in this case.
474 FailedUnlock(GetObject(), self->GetThreadId(), owner_thread_id, this);
475 return false;
Elliott Hughes5f791332011-09-15 17:45:30 -0700476}
477
Elliott Hughes4cd121e2013-01-07 17:35:41 -0800478void Monitor::Wait(Thread* self, int64_t ms, int32_t ns,
479 bool interruptShouldThrow, ThreadState why) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700480 DCHECK(self != nullptr);
Elliott Hughes4cd121e2013-01-07 17:35:41 -0800481 DCHECK(why == kTimedWaiting || why == kWaiting || why == kSleeping);
Elliott Hughes5f791332011-09-15 17:45:30 -0700482
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700483 monitor_lock_.Lock(self);
484
Elliott Hughes5f791332011-09-15 17:45:30 -0700485 // Make sure that we hold the lock.
486 if (owner_ != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700487 monitor_lock_.Unlock(self);
Elena Sayapina1af6a1f2014-06-20 16:58:37 +0700488 ThrowIllegalMonitorStateExceptionF("object not locked by thread before wait()");
Elliott Hughes5f791332011-09-15 17:45:30 -0700489 return;
490 }
Elliott Hughes4cd121e2013-01-07 17:35:41 -0800491
Elliott Hughesdf42c482013-01-09 12:49:02 -0800492 // We need to turn a zero-length timed wait into a regular wait because
493 // Object.wait(0, 0) is defined as Object.wait(0), which is defined as Object.wait().
494 if (why == kTimedWaiting && (ms == 0 && ns == 0)) {
495 why = kWaiting;
496 }
497
Elliott Hughes5f791332011-09-15 17:45:30 -0700498 // Enforce the timeout range.
499 if (ms < 0 || ns < 0 || ns > 999999) {
Elena Sayapina1af6a1f2014-06-20 16:58:37 +0700500 monitor_lock_.Unlock(self);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +0000501 self->ThrowNewExceptionF("Ljava/lang/IllegalArgumentException;",
Ian Rogersef7d42f2014-01-06 12:55:46 -0800502 "timeout arguments out of range: ms=%" PRId64 " ns=%d", ms, ns);
Elliott Hughes5f791332011-09-15 17:45:30 -0700503 return;
504 }
505
Elliott Hughes5f791332011-09-15 17:45:30 -0700506 /*
507 * Add ourselves to the set of threads waiting on this monitor, and
508 * release our hold. We need to let it go even if we're a few levels
509 * deep in a recursive lock, and we need to restore that later.
510 *
511 * We append to the wait set ahead of clearing the count and owner
512 * fields so the subroutine can check that the calling thread owns
513 * the monitor. Aside from that, the order of member updates is
514 * not order sensitive as we hold the pthread mutex.
515 */
516 AppendToWaitSet(self);
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700517 ++num_waiters_;
Ian Rogers0399dde2012-06-06 17:09:28 -0700518 int prev_lock_count = lock_count_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700519 lock_count_ = 0;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700520 owner_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -0700521 ArtMethod* saved_method = locking_method_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700522 locking_method_ = nullptr;
Ian Rogers0399dde2012-06-06 17:09:28 -0700523 uintptr_t saved_dex_pc = locking_dex_pc_;
524 locking_dex_pc_ = 0;
Elliott Hughes5f791332011-09-15 17:45:30 -0700525
Elliott Hughesb4e94fd2013-01-08 14:41:26 -0800526 bool was_interrupted = false;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700527 {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700528 // Update thread state. If the GC wakes up, it'll ignore us, knowing
529 // that we won't touch any references in this state, and we'll check
530 // our suspend mode before we transition out.
531 ScopedThreadSuspension sts(self, why);
532
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700533 // Pseudo-atomically wait on self's wait_cond_ and release the monitor lock.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700534 MutexLock mu(self, *self->GetWaitMutex());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700535
536 // Set wait_monitor_ to the monitor object we will be waiting on. When wait_monitor_ is
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700537 // non-null a notifying or interrupting thread must signal the thread's wait_cond_ to wake it
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700538 // up.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700539 DCHECK(self->GetWaitMonitor() == nullptr);
540 self->SetWaitMonitor(this);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700541
542 // Release the monitor lock.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700543 monitor_contenders_.Signal(self);
544 monitor_lock_.Unlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700545
Elliott Hughesb4e94fd2013-01-08 14:41:26 -0800546 // Handle the case where the thread was interrupted before we called wait().
Ian Rogersdd7624d2014-03-14 17:43:00 -0700547 if (self->IsInterruptedLocked()) {
Elliott Hughesb4e94fd2013-01-08 14:41:26 -0800548 was_interrupted = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700549 } else {
550 // Wait for a notification or a timeout to occur.
Elliott Hughes4cd121e2013-01-07 17:35:41 -0800551 if (why == kWaiting) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700552 self->GetWaitConditionVariable()->Wait(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700553 } else {
Elliott Hughes4cd121e2013-01-07 17:35:41 -0800554 DCHECK(why == kTimedWaiting || why == kSleeping) << why;
Ian Rogersdd7624d2014-03-14 17:43:00 -0700555 self->GetWaitConditionVariable()->TimedWait(self, ms, ns);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700556 }
Hans Boehm328c5dc2015-11-11 16:13:57 -0800557 was_interrupted = self->IsInterruptedLocked();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700558 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700559 }
560
Elliott Hughesb4e94fd2013-01-08 14:41:26 -0800561 {
562 // We reset the thread's wait_monitor_ field after transitioning back to runnable so
563 // that a thread in a waiting/sleeping state has a non-null wait_monitor_ for debugging
564 // and diagnostic purposes. (If you reset this earlier, stack dumps will claim that threads
565 // are waiting on "null".)
Ian Rogersdd7624d2014-03-14 17:43:00 -0700566 MutexLock mu(self, *self->GetWaitMutex());
567 DCHECK(self->GetWaitMonitor() != nullptr);
568 self->SetWaitMonitor(nullptr);
Elliott Hughesb4e94fd2013-01-08 14:41:26 -0800569 }
570
Mathieu Chartierdaed5d82016-03-10 10:49:35 -0800571 // Allocate the interrupted exception not holding the monitor lock since it may cause a GC.
572 // If the GC requires acquiring the monitor for enqueuing cleared references, this would
573 // cause a deadlock if the monitor is held.
574 if (was_interrupted && interruptShouldThrow) {
575 /*
576 * We were interrupted while waiting, or somebody interrupted an
577 * un-interruptible thread earlier and we're bailing out immediately.
578 *
579 * The doc sayeth: "The interrupted status of the current thread is
580 * cleared when this exception is thrown."
581 */
582 {
583 MutexLock mu(self, *self->GetWaitMutex());
584 self->SetInterruptedLocked(false);
585 }
586 self->ThrowNewException("Ljava/lang/InterruptedException;", nullptr);
587 }
588
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700589 // Re-acquire the monitor and lock.
Elliott Hughes5f791332011-09-15 17:45:30 -0700590 Lock(self);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700591 monitor_lock_.Lock(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700592 self->GetWaitMutex()->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700593
Elliott Hughes5f791332011-09-15 17:45:30 -0700594 /*
595 * We remove our thread from wait set after restoring the count
596 * and owner fields so the subroutine can check that the calling
597 * thread owns the monitor. Aside from that, the order of member
598 * updates is not order sensitive as we hold the pthread mutex.
599 */
600 owner_ = self;
Ian Rogers0399dde2012-06-06 17:09:28 -0700601 lock_count_ = prev_lock_count;
602 locking_method_ = saved_method;
603 locking_dex_pc_ = saved_dex_pc;
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700604 --num_waiters_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700605 RemoveFromWaitSet(self);
606
Elena Sayapina1af6a1f2014-06-20 16:58:37 +0700607 monitor_lock_.Unlock(self);
Elliott Hughes5f791332011-09-15 17:45:30 -0700608}
609
610void Monitor::Notify(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700611 DCHECK(self != nullptr);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700612 MutexLock mu(self, monitor_lock_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700613 // Make sure that we hold the lock.
614 if (owner_ != self) {
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800615 ThrowIllegalMonitorStateExceptionF("object not locked by thread before notify()");
Elliott Hughes5f791332011-09-15 17:45:30 -0700616 return;
617 }
618 // Signal the first waiting thread in the wait set.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700619 while (wait_set_ != nullptr) {
Elliott Hughes5f791332011-09-15 17:45:30 -0700620 Thread* thread = wait_set_;
Ian Rogersdd7624d2014-03-14 17:43:00 -0700621 wait_set_ = thread->GetWaitNext();
622 thread->SetWaitNext(nullptr);
Elliott Hughes5f791332011-09-15 17:45:30 -0700623
624 // Check to see if the thread is still waiting.
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800625 MutexLock wait_mu(self, *thread->GetWaitMutex());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700626 if (thread->GetWaitMonitor() != nullptr) {
627 thread->GetWaitConditionVariable()->Signal(self);
Elliott Hughes5f791332011-09-15 17:45:30 -0700628 return;
629 }
630 }
631}
632
633void Monitor::NotifyAll(Thread* self) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700634 DCHECK(self != nullptr);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700635 MutexLock mu(self, monitor_lock_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700636 // Make sure that we hold the lock.
637 if (owner_ != self) {
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800638 ThrowIllegalMonitorStateExceptionF("object not locked by thread before notifyAll()");
Elliott Hughes5f791332011-09-15 17:45:30 -0700639 return;
640 }
641 // Signal all threads in the wait set.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700642 while (wait_set_ != nullptr) {
Elliott Hughes5f791332011-09-15 17:45:30 -0700643 Thread* thread = wait_set_;
Ian Rogersdd7624d2014-03-14 17:43:00 -0700644 wait_set_ = thread->GetWaitNext();
645 thread->SetWaitNext(nullptr);
Elliott Hughes5f791332011-09-15 17:45:30 -0700646 thread->Notify();
647 }
648}
649
Mathieu Chartier590fee92013-09-13 13:46:47 -0700650bool Monitor::Deflate(Thread* self, mirror::Object* obj) {
651 DCHECK(obj != nullptr);
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700652 // Don't need volatile since we only deflate with mutators suspended.
653 LockWord lw(obj->GetLockWord(false));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700654 // If the lock isn't an inflated monitor, then we don't need to deflate anything.
655 if (lw.GetState() == LockWord::kFatLocked) {
656 Monitor* monitor = lw.FatLockMonitor();
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700657 DCHECK(monitor != nullptr);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700658 MutexLock mu(self, monitor->monitor_lock_);
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700659 // Can't deflate if we have anybody waiting on the CV.
660 if (monitor->num_waiters_ > 0) {
661 return false;
662 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700663 Thread* owner = monitor->owner_;
664 if (owner != nullptr) {
665 // Can't deflate if we are locked and have a hash code.
666 if (monitor->HasHashCode()) {
667 return false;
668 }
669 // Can't deflate if our lock count is too high.
670 if (monitor->lock_count_ > LockWord::kThinLockMaxCount) {
671 return false;
672 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700673 // Deflate to a thin lock.
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800674 LockWord new_lw = LockWord::FromThinLockId(owner->GetThreadId(), monitor->lock_count_,
675 lw.ReadBarrierState());
676 // Assume no concurrent read barrier state changes as mutators are suspended.
677 obj->SetLockWord(new_lw, false);
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700678 VLOG(monitor) << "Deflated " << obj << " to thin lock " << owner->GetTid() << " / "
679 << monitor->lock_count_;
Mathieu Chartier590fee92013-09-13 13:46:47 -0700680 } else if (monitor->HasHashCode()) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800681 LockWord new_lw = LockWord::FromHashCode(monitor->GetHashCode(), lw.ReadBarrierState());
682 // Assume no concurrent read barrier state changes as mutators are suspended.
683 obj->SetLockWord(new_lw, false);
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700684 VLOG(monitor) << "Deflated " << obj << " to hash monitor " << monitor->GetHashCode();
Mathieu Chartier590fee92013-09-13 13:46:47 -0700685 } else {
686 // No lock and no hash, just put an empty lock word inside the object.
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800687 LockWord new_lw = LockWord::FromDefault(lw.ReadBarrierState());
688 // Assume no concurrent read barrier state changes as mutators are suspended.
689 obj->SetLockWord(new_lw, false);
Mathieu Chartier440e4ce2014-03-31 16:36:35 -0700690 VLOG(monitor) << "Deflated" << obj << " to empty lock word";
Mathieu Chartier590fee92013-09-13 13:46:47 -0700691 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700692 // The monitor is deflated, mark the object as null so that we know to delete it during the
Mathieu Chartier590fee92013-09-13 13:46:47 -0700693 // next GC.
Hiroshi Yamauchi94f7b492014-07-22 18:08:23 -0700694 monitor->obj_ = GcRoot<mirror::Object>(nullptr);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700695 }
696 return true;
697}
698
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700699void Monitor::Inflate(Thread* self, Thread* owner, mirror::Object* obj, int32_t hash_code) {
Andreas Gampe74240812014-04-17 10:35:09 -0700700 DCHECK(self != nullptr);
701 DCHECK(obj != nullptr);
Elliott Hughes5f791332011-09-15 17:45:30 -0700702 // Allocate and acquire a new monitor.
Andreas Gampe74240812014-04-17 10:35:09 -0700703 Monitor* m = MonitorPool::CreateMonitor(self, owner, obj, hash_code);
704 DCHECK(m != nullptr);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700705 if (m->Install(self)) {
Haifeng Li86ab7912014-05-16 10:47:59 +0800706 if (owner != nullptr) {
707 VLOG(monitor) << "monitor: thread" << owner->GetThreadId()
Andreas Gampe74240812014-04-17 10:35:09 -0700708 << " created monitor " << m << " for object " << obj;
Haifeng Li86ab7912014-05-16 10:47:59 +0800709 } else {
710 VLOG(monitor) << "monitor: Inflate with hashcode " << hash_code
Andreas Gampe74240812014-04-17 10:35:09 -0700711 << " created monitor " << m << " for object " << obj;
Haifeng Li86ab7912014-05-16 10:47:59 +0800712 }
Andreas Gampe74240812014-04-17 10:35:09 -0700713 Runtime::Current()->GetMonitorList()->Add(m);
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700714 CHECK_EQ(obj->GetLockWord(true).GetState(), LockWord::kFatLocked);
Andreas Gampe74240812014-04-17 10:35:09 -0700715 } else {
716 MonitorPool::ReleaseMonitor(self, m);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700717 }
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700718}
719
Mathieu Chartier0cd81352014-05-22 16:48:55 -0700720void Monitor::InflateThinLocked(Thread* self, Handle<mirror::Object> obj, LockWord lock_word,
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700721 uint32_t hash_code) {
722 DCHECK_EQ(lock_word.GetState(), LockWord::kThinLocked);
723 uint32_t owner_thread_id = lock_word.ThinLockOwner();
724 if (owner_thread_id == self->GetThreadId()) {
725 // We own the monitor, we can easily inflate it.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700726 Inflate(self, self, obj.Get(), hash_code);
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700727 } else {
728 ThreadList* thread_list = Runtime::Current()->GetThreadList();
729 // Suspend the owner, inflate. First change to blocked and give up mutator_lock_.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700730 self->SetMonitorEnterObject(obj.Get());
Mathieu Chartiera1ee14f2014-05-14 16:51:03 -0700731 bool timed_out;
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700732 Thread* owner;
733 {
734 ScopedThreadSuspension sts(self, kBlocked);
735 owner = thread_list->SuspendThreadByThreadId(owner_thread_id, false, &timed_out);
736 }
Mathieu Chartiera1ee14f2014-05-14 16:51:03 -0700737 if (owner != nullptr) {
738 // We succeeded in suspending the thread, check the lock's status didn't change.
739 lock_word = obj->GetLockWord(true);
740 if (lock_word.GetState() == LockWord::kThinLocked &&
741 lock_word.ThinLockOwner() == owner_thread_id) {
742 // Go ahead and inflate the lock.
743 Inflate(self, owner, obj.Get(), hash_code);
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700744 }
Mathieu Chartiera1ee14f2014-05-14 16:51:03 -0700745 thread_list->Resume(owner, false);
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700746 }
Ian Rogersdd7624d2014-03-14 17:43:00 -0700747 self->SetMonitorEnterObject(nullptr);
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700748 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700749}
750
Ian Rogers719d1a32014-03-06 12:13:39 -0800751// Fool annotalysis into thinking that the lock on obj is acquired.
752static mirror::Object* FakeLock(mirror::Object* obj)
753 EXCLUSIVE_LOCK_FUNCTION(obj) NO_THREAD_SAFETY_ANALYSIS {
754 return obj;
755}
756
757// Fool annotalysis into thinking that the lock on obj is release.
758static mirror::Object* FakeUnlock(mirror::Object* obj)
759 UNLOCK_FUNCTION(obj) NO_THREAD_SAFETY_ANALYSIS {
760 return obj;
761}
762
Mathieu Chartiere7e8a5f2014-02-14 16:59:41 -0800763mirror::Object* Monitor::MonitorEnter(Thread* self, mirror::Object* obj) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700764 DCHECK(self != nullptr);
765 DCHECK(obj != nullptr);
Mathieu Chartier2d096c92015-10-12 16:18:20 -0700766 self->AssertThreadSuspensionIsAllowable();
Ian Rogers719d1a32014-03-06 12:13:39 -0800767 obj = FakeLock(obj);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700768 uint32_t thread_id = self->GetThreadId();
769 size_t contention_count = 0;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700770 StackHandleScope<1> hs(self);
771 Handle<mirror::Object> h_obj(hs.NewHandle(obj));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700772 while (true) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700773 LockWord lock_word = h_obj->GetLockWord(true);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700774 switch (lock_word.GetState()) {
775 case LockWord::kUnlocked: {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800776 LockWord thin_locked(LockWord::FromThinLockId(thread_id, 0, lock_word.ReadBarrierState()));
Ian Rogers228602f2014-07-10 02:07:54 -0700777 if (h_obj->CasLockWordWeakSequentiallyConsistent(lock_word, thin_locked)) {
Hans Boehm30359612014-05-21 17:46:23 -0700778 // CasLockWord enforces more than the acquire ordering we need here.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700779 return h_obj.Get(); // Success!
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700780 }
781 continue; // Go again.
Elliott Hughes5f791332011-09-15 17:45:30 -0700782 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700783 case LockWord::kThinLocked: {
784 uint32_t owner_thread_id = lock_word.ThinLockOwner();
785 if (owner_thread_id == thread_id) {
786 // We own the lock, increase the recursion count.
787 uint32_t new_count = lock_word.ThinLockCount() + 1;
788 if (LIKELY(new_count <= LockWord::kThinLockMaxCount)) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800789 LockWord thin_locked(LockWord::FromThinLockId(thread_id, new_count,
790 lock_word.ReadBarrierState()));
791 if (!kUseReadBarrier) {
792 h_obj->SetLockWord(thin_locked, true);
793 return h_obj.Get(); // Success!
794 } else {
795 // Use CAS to preserve the read barrier state.
796 if (h_obj->CasLockWordWeakSequentiallyConsistent(lock_word, thin_locked)) {
797 return h_obj.Get(); // Success!
798 }
799 }
800 continue; // Go again.
Elliott Hughes5f791332011-09-15 17:45:30 -0700801 } else {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700802 // We'd overflow the recursion count, so inflate the monitor.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700803 InflateThinLocked(self, h_obj, lock_word, 0);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700804 }
805 } else {
806 // Contention.
807 contention_count++;
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700808 Runtime* runtime = Runtime::Current();
809 if (contention_count <= runtime->GetMaxSpinsBeforeThinkLockInflation()) {
Mathieu Chartierb363f662014-07-16 13:28:58 -0700810 // TODO: Consider switching the thread state to kBlocked when we are yielding.
Mathieu Chartier251755c2014-07-15 18:10:25 -0700811 // Use sched_yield instead of NanoSleep since NanoSleep can wait much longer than the
812 // parameter you pass in. This can cause thread suspension to take excessively long
Mathieu Chartierb363f662014-07-16 13:28:58 -0700813 // and make long pauses. See b/16307460.
Mathieu Chartier251755c2014-07-15 18:10:25 -0700814 sched_yield();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700815 } else {
816 contention_count = 0;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700817 InflateThinLocked(self, h_obj, lock_word, 0);
Elliott Hughes5f791332011-09-15 17:45:30 -0700818 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700819 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700820 continue; // Start from the beginning.
Elliott Hughes5f791332011-09-15 17:45:30 -0700821 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700822 case LockWord::kFatLocked: {
823 Monitor* mon = lock_word.FatLockMonitor();
824 mon->Lock(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700825 return h_obj.Get(); // Success!
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700826 }
Ian Rogers719d1a32014-03-06 12:13:39 -0800827 case LockWord::kHashCode:
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700828 // Inflate with the existing hashcode.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700829 Inflate(self, nullptr, h_obj.Get(), lock_word.GetHashCode());
Ian Rogers719d1a32014-03-06 12:13:39 -0800830 continue; // Start from the beginning.
Mathieu Chartier590fee92013-09-13 13:46:47 -0700831 default: {
832 LOG(FATAL) << "Invalid monitor state " << lock_word.GetState();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700833 return h_obj.Get();
Mathieu Chartier590fee92013-09-13 13:46:47 -0700834 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700835 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700836 }
837}
838
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800839bool Monitor::MonitorExit(Thread* self, mirror::Object* obj) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700840 DCHECK(self != nullptr);
841 DCHECK(obj != nullptr);
Mathieu Chartier2d096c92015-10-12 16:18:20 -0700842 self->AssertThreadSuspensionIsAllowable();
Ian Rogers719d1a32014-03-06 12:13:39 -0800843 obj = FakeUnlock(obj);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700844 StackHandleScope<1> hs(self);
845 Handle<mirror::Object> h_obj(hs.NewHandle(obj));
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800846 while (true) {
847 LockWord lock_word = obj->GetLockWord(true);
848 switch (lock_word.GetState()) {
849 case LockWord::kHashCode:
850 // Fall-through.
851 case LockWord::kUnlocked:
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700852 FailedUnlock(h_obj.Get(), self->GetThreadId(), 0u, nullptr);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700853 return false; // Failure.
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800854 case LockWord::kThinLocked: {
855 uint32_t thread_id = self->GetThreadId();
856 uint32_t owner_thread_id = lock_word.ThinLockOwner();
857 if (owner_thread_id != thread_id) {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700858 FailedUnlock(h_obj.Get(), thread_id, owner_thread_id, nullptr);
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800859 return false; // Failure.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700860 } else {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800861 // We own the lock, decrease the recursion count.
862 LockWord new_lw = LockWord::Default();
863 if (lock_word.ThinLockCount() != 0) {
864 uint32_t new_count = lock_word.ThinLockCount() - 1;
865 new_lw = LockWord::FromThinLockId(thread_id, new_count, lock_word.ReadBarrierState());
866 } else {
867 new_lw = LockWord::FromDefault(lock_word.ReadBarrierState());
868 }
869 if (!kUseReadBarrier) {
870 DCHECK_EQ(new_lw.ReadBarrierState(), 0U);
871 h_obj->SetLockWord(new_lw, true);
872 // Success!
873 return true;
874 } else {
875 // Use CAS to preserve the read barrier state.
876 if (h_obj->CasLockWordWeakSequentiallyConsistent(lock_word, new_lw)) {
877 // Success!
878 return true;
879 }
880 }
881 continue; // Go again.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700882 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700883 }
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -0800884 case LockWord::kFatLocked: {
885 Monitor* mon = lock_word.FatLockMonitor();
886 return mon->Unlock(self);
887 }
888 default: {
889 LOG(FATAL) << "Invalid monitor state " << lock_word.GetState();
890 return false;
891 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700892 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700893 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700894}
895
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800896void Monitor::Wait(Thread* self, mirror::Object *obj, int64_t ms, int32_t ns,
Elliott Hughes4cd121e2013-01-07 17:35:41 -0800897 bool interruptShouldThrow, ThreadState why) {
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700898 DCHECK(self != nullptr);
899 DCHECK(obj != nullptr);
900 LockWord lock_word = obj->GetLockWord(true);
Ian Rogers43c69cc2014-08-15 11:09:28 -0700901 while (lock_word.GetState() != LockWord::kFatLocked) {
902 switch (lock_word.GetState()) {
903 case LockWord::kHashCode:
904 // Fall-through.
905 case LockWord::kUnlocked:
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700906 ThrowIllegalMonitorStateExceptionF("object not locked by thread before wait()");
907 return; // Failure.
Ian Rogers43c69cc2014-08-15 11:09:28 -0700908 case LockWord::kThinLocked: {
909 uint32_t thread_id = self->GetThreadId();
910 uint32_t owner_thread_id = lock_word.ThinLockOwner();
911 if (owner_thread_id != thread_id) {
912 ThrowIllegalMonitorStateExceptionF("object not locked by thread before wait()");
913 return; // Failure.
914 } else {
915 // We own the lock, inflate to enqueue ourself on the Monitor. May fail spuriously so
916 // re-load.
917 Inflate(self, self, obj, 0);
918 lock_word = obj->GetLockWord(true);
919 }
920 break;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700921 }
Ian Rogers43c69cc2014-08-15 11:09:28 -0700922 case LockWord::kFatLocked: // Unreachable given the loop condition above. Fall-through.
923 default: {
924 LOG(FATAL) << "Invalid monitor state " << lock_word.GetState();
925 return;
926 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700927 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700928 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700929 Monitor* mon = lock_word.FatLockMonitor();
930 mon->Wait(self, ms, ns, interruptShouldThrow, why);
Elliott Hughes5f791332011-09-15 17:45:30 -0700931}
932
Ian Rogers13c479e2013-10-11 07:59:01 -0700933void Monitor::DoNotify(Thread* self, mirror::Object* obj, bool notify_all) {
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700934 DCHECK(self != nullptr);
935 DCHECK(obj != nullptr);
936 LockWord lock_word = obj->GetLockWord(true);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700937 switch (lock_word.GetState()) {
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700938 case LockWord::kHashCode:
939 // Fall-through.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700940 case LockWord::kUnlocked:
Ian Rogers6d0b13e2012-02-07 09:25:29 -0800941 ThrowIllegalMonitorStateExceptionF("object not locked by thread before notify()");
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700942 return; // Failure.
943 case LockWord::kThinLocked: {
944 uint32_t thread_id = self->GetThreadId();
945 uint32_t owner_thread_id = lock_word.ThinLockOwner();
946 if (owner_thread_id != thread_id) {
947 ThrowIllegalMonitorStateExceptionF("object not locked by thread before notify()");
948 return; // Failure.
949 } else {
950 // We own the lock but there's no Monitor and therefore no waiters.
951 return; // Success.
952 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700953 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700954 case LockWord::kFatLocked: {
955 Monitor* mon = lock_word.FatLockMonitor();
956 if (notify_all) {
957 mon->NotifyAll(self);
958 } else {
959 mon->Notify(self);
960 }
961 return; // Success.
962 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700963 default: {
964 LOG(FATAL) << "Invalid monitor state " << lock_word.GetState();
965 return;
966 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700967 }
968}
969
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700970uint32_t Monitor::GetLockOwnerThreadId(mirror::Object* obj) {
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -0700971 DCHECK(obj != nullptr);
972 LockWord lock_word = obj->GetLockWord(true);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700973 switch (lock_word.GetState()) {
Mathieu Chartierad2541a2013-10-25 10:05:23 -0700974 case LockWord::kHashCode:
975 // Fall-through.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700976 case LockWord::kUnlocked:
977 return ThreadList::kInvalidThreadId;
978 case LockWord::kThinLocked:
979 return lock_word.ThinLockOwner();
980 case LockWord::kFatLocked: {
981 Monitor* mon = lock_word.FatLockMonitor();
982 return mon->GetOwnerThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -0700983 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700984 default: {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700985 LOG(FATAL) << "Unreachable";
Ian Rogers2c4257b2014-10-24 14:20:06 -0700986 UNREACHABLE();
Mathieu Chartier590fee92013-09-13 13:46:47 -0700987 }
Elliott Hughes5f791332011-09-15 17:45:30 -0700988 }
989}
990
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700991void Monitor::DescribeWait(std::ostream& os, const Thread* thread) {
Ian Rogersd803bc72014-04-01 15:33:03 -0700992 // Determine the wait message and object we're waiting or blocked upon.
993 mirror::Object* pretty_object = nullptr;
994 const char* wait_message = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700995 uint32_t lock_owner = ThreadList::kInvalidThreadId;
Ian Rogersd803bc72014-04-01 15:33:03 -0700996 ThreadState state = thread->GetState();
Elliott Hughesb4e94fd2013-01-08 14:41:26 -0800997 if (state == kWaiting || state == kTimedWaiting || state == kSleeping) {
Ian Rogersd803bc72014-04-01 15:33:03 -0700998 wait_message = (state == kSleeping) ? " - sleeping on " : " - waiting on ";
999 Thread* self = Thread::Current();
1000 MutexLock mu(self, *thread->GetWaitMutex());
1001 Monitor* monitor = thread->GetWaitMonitor();
1002 if (monitor != nullptr) {
Hiroshi Yamauchi4cba0d92014-05-21 21:10:23 -07001003 pretty_object = monitor->GetObject();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001004 }
Elliott Hughes34e06962012-04-09 13:55:55 -07001005 } else if (state == kBlocked) {
Ian Rogersd803bc72014-04-01 15:33:03 -07001006 wait_message = " - waiting to lock ";
1007 pretty_object = thread->GetMonitorEnterObject();
1008 if (pretty_object != nullptr) {
1009 lock_owner = pretty_object->GetLockOwnerThreadId();
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001010 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001011 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001012
Ian Rogersd803bc72014-04-01 15:33:03 -07001013 if (wait_message != nullptr) {
1014 if (pretty_object == nullptr) {
1015 os << wait_message << "an unknown object";
1016 } else {
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -07001017 if ((pretty_object->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07001018 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
1019 // Getting the identity hashcode here would result in lock inflation and suspension of the
1020 // current thread, which isn't safe if this is the only runnable thread.
1021 os << wait_message << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
1022 reinterpret_cast<intptr_t>(pretty_object),
1023 PrettyTypeOf(pretty_object).c_str());
1024 } else {
1025 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
Mathieu Chartier49361592015-01-22 16:36:10 -08001026 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
1027 // suspension and move pretty_object.
1028 const std::string pretty_type(PrettyTypeOf(pretty_object));
Ian Rogersd803bc72014-04-01 15:33:03 -07001029 os << wait_message << StringPrintf("<0x%08x> (a %s)", pretty_object->IdentityHashCode(),
Mathieu Chartier49361592015-01-22 16:36:10 -08001030 pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001031 }
1032 }
1033 // - waiting to lock <0x613f83d8> (a java.lang.Object) held by thread 5
1034 if (lock_owner != ThreadList::kInvalidThreadId) {
1035 os << " held by thread " << lock_owner;
1036 }
1037 os << "\n";
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001038 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001039}
1040
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001041mirror::Object* Monitor::GetContendedMonitor(Thread* thread) {
Elliott Hughesf9501702013-01-11 11:22:27 -08001042 // This is used to implement JDWP's ThreadReference.CurrentContendedMonitor, and has a bizarre
1043 // definition of contended that includes a monitor a thread is trying to enter...
Ian Rogersdd7624d2014-03-14 17:43:00 -07001044 mirror::Object* result = thread->GetMonitorEnterObject();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001045 if (result == nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001046 // ...but also a monitor that the thread is waiting on.
Ian Rogersdd7624d2014-03-14 17:43:00 -07001047 MutexLock mu(Thread::Current(), *thread->GetWaitMutex());
1048 Monitor* monitor = thread->GetWaitMonitor();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001049 if (monitor != nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001050 result = monitor->GetObject();
Elliott Hughesf9501702013-01-11 11:22:27 -08001051 }
1052 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001053 return result;
Elliott Hughesf9501702013-01-11 11:22:27 -08001054}
1055
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001056void Monitor::VisitLocks(StackVisitor* stack_visitor, void (*callback)(mirror::Object*, void*),
Andreas Gampe760172c2014-08-16 13:41:10 -07001057 void* callback_context, bool abort_on_failure) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001058 ArtMethod* m = stack_visitor->GetMethod();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001059 CHECK(m != nullptr);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001060
1061 // Native methods are an easy special case.
1062 // TODO: use the JNI implementation's table of explicit MonitorEnter calls and dump those too.
1063 if (m->IsNative()) {
1064 if (m->IsSynchronized()) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001065 mirror::Object* jni_this =
1066 stack_visitor->GetCurrentHandleScope(sizeof(void*))->GetReference(0);
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001067 callback(jni_this, callback_context);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001068 }
1069 return;
1070 }
1071
jeffhao61f916c2012-10-25 17:48:51 -07001072 // Proxy methods should not be synchronized.
1073 if (m->IsProxyMethod()) {
1074 CHECK(!m->IsSynchronized());
1075 return;
1076 }
1077
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001078 // Is there any reason to believe there's any synchronization in this method?
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001079 const DexFile::CodeItem* code_item = m->GetCodeItem();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001080 CHECK(code_item != nullptr) << PrettyMethod(m);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001081 if (code_item->tries_size_ == 0) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001082 return; // No "tries" implies no synchronization, so no held locks to report.
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001083 }
1084
Andreas Gampe760172c2014-08-16 13:41:10 -07001085 // Get the dex pc. If abort_on_failure is false, GetDexPc will not abort in the case it cannot
1086 // find the dex pc, and instead return kDexNoIndex. Then bail out, as it indicates we have an
1087 // inconsistent stack anyways.
1088 uint32_t dex_pc = stack_visitor->GetDexPc(abort_on_failure);
1089 if (!abort_on_failure && dex_pc == DexFile::kDexNoIndex) {
1090 LOG(ERROR) << "Could not find dex_pc for " << PrettyMethod(m);
1091 return;
1092 }
1093
Elliott Hughes80537bb2013-01-04 16:37:26 -08001094 // Ask the verifier for the dex pcs of all the monitor-enter instructions corresponding to
1095 // the locks held in this stack frame.
1096 std::vector<uint32_t> monitor_enter_dex_pcs;
Andreas Gampe760172c2014-08-16 13:41:10 -07001097 verifier::MethodVerifier::FindLocksAtDexPc(m, dex_pc, &monitor_enter_dex_pcs);
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001098 for (uint32_t monitor_dex_pc : monitor_enter_dex_pcs) {
Elliott Hughes80537bb2013-01-04 16:37:26 -08001099 // The verifier works in terms of the dex pcs of the monitor-enter instructions.
1100 // We want the registers used by those instructions (so we can read the values out of them).
Sebastien Hertz0f7c9332015-11-05 15:57:30 +01001101 const Instruction* monitor_enter_instruction =
1102 Instruction::At(&code_item->insns_[monitor_dex_pc]);
Elliott Hughes80537bb2013-01-04 16:37:26 -08001103
1104 // Quick sanity check.
Sebastien Hertz0f7c9332015-11-05 15:57:30 +01001105 CHECK_EQ(monitor_enter_instruction->Opcode(), Instruction::MONITOR_ENTER)
1106 << "expected monitor-enter @" << monitor_dex_pc << "; was "
1107 << reinterpret_cast<const void*>(monitor_enter_instruction);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001108
Sebastien Hertz0f7c9332015-11-05 15:57:30 +01001109 uint16_t monitor_register = monitor_enter_instruction->VRegA();
Nicolas Geoffray15b9d522015-03-12 15:05:13 +00001110 uint32_t value;
1111 bool success = stack_visitor->GetVReg(m, monitor_register, kReferenceVReg, &value);
1112 CHECK(success) << "Failed to read v" << monitor_register << " of kind "
1113 << kReferenceVReg << " in method " << PrettyMethod(m);
1114 mirror::Object* o = reinterpret_cast<mirror::Object*>(value);
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001115 callback(o, callback_context);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001116 }
1117}
1118
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001119bool Monitor::IsValidLockWord(LockWord lock_word) {
1120 switch (lock_word.GetState()) {
1121 case LockWord::kUnlocked:
1122 // Nothing to check.
1123 return true;
1124 case LockWord::kThinLocked:
1125 // Basic sanity check of owner.
1126 return lock_word.ThinLockOwner() != ThreadList::kInvalidThreadId;
1127 case LockWord::kFatLocked: {
1128 // Check the monitor appears in the monitor list.
1129 Monitor* mon = lock_word.FatLockMonitor();
1130 MonitorList* list = Runtime::Current()->GetMonitorList();
1131 MutexLock mu(Thread::Current(), list->monitor_list_lock_);
1132 for (Monitor* list_mon : list->list_) {
1133 if (mon == list_mon) {
1134 return true; // Found our monitor.
1135 }
Ian Rogers7dfb28c2013-08-22 08:18:36 -07001136 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001137 return false; // Fail - unowned monitor in an object.
Ian Rogers7dfb28c2013-08-22 08:18:36 -07001138 }
Mathieu Chartierad2541a2013-10-25 10:05:23 -07001139 case LockWord::kHashCode:
1140 return true;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001141 default:
1142 LOG(FATAL) << "Unreachable";
Ian Rogers2c4257b2014-10-24 14:20:06 -07001143 UNREACHABLE();
Ian Rogers7dfb28c2013-08-22 08:18:36 -07001144 }
1145}
1146
Mathieu Chartier90443472015-07-16 20:32:27 -07001147bool Monitor::IsLocked() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierad2541a2013-10-25 10:05:23 -07001148 MutexLock mu(Thread::Current(), monitor_lock_);
1149 return owner_ != nullptr;
1150}
1151
Mathieu Chartier74b3c8f2016-04-15 19:11:45 -07001152void Monitor::TranslateLocation(ArtMethod* method,
1153 uint32_t dex_pc,
1154 const char** source_file,
1155 int32_t* line_number) {
jeffhao33dc7712011-11-09 17:54:24 -08001156 // If method is null, location is unknown
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001157 if (method == nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001158 *source_file = "";
1159 *line_number = 0;
jeffhao33dc7712011-11-09 17:54:24 -08001160 return;
1161 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001162 *source_file = method->GetDeclaringClassSourceFile();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001163 if (*source_file == nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001164 *source_file = "";
Elliott Hughes12c51e32012-01-17 20:25:05 -08001165 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001166 *line_number = method->GetLineNumFromDexPC(dex_pc);
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001167}
1168
1169uint32_t Monitor::GetOwnerThreadId() {
1170 MutexLock mu(Thread::Current(), monitor_lock_);
1171 Thread* owner = owner_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001172 if (owner != nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001173 return owner->GetThreadId();
1174 } else {
1175 return ThreadList::kInvalidThreadId;
1176 }
jeffhao33dc7712011-11-09 17:54:24 -08001177}
1178
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001179MonitorList::MonitorList()
Mathieu Chartier440e4ce2014-03-31 16:36:35 -07001180 : allow_new_monitors_(true), monitor_list_lock_("MonitorList lock", kMonitorListLock),
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001181 monitor_add_condition_("MonitorList disallow condition", monitor_list_lock_) {
Elliott Hughesc33a32b2011-10-11 18:18:07 -07001182}
1183
1184MonitorList::~MonitorList() {
Andreas Gampe74240812014-04-17 10:35:09 -07001185 Thread* self = Thread::Current();
1186 MutexLock mu(self, monitor_list_lock_);
1187 // Release all monitors to the pool.
1188 // TODO: Is it an invariant that *all* open monitors are in the list? Then we could
1189 // clear faster in the pool.
1190 MonitorPool::ReleaseMonitors(self, &list_);
Elliott Hughesc33a32b2011-10-11 18:18:07 -07001191}
1192
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001193void MonitorList::DisallowNewMonitors() {
Hiroshi Yamauchifdbd13c2015-09-02 16:16:58 -07001194 CHECK(!kUseReadBarrier);
Ian Rogers50b35e22012-10-04 10:09:15 -07001195 MutexLock mu(Thread::Current(), monitor_list_lock_);
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001196 allow_new_monitors_ = false;
1197}
1198
1199void MonitorList::AllowNewMonitors() {
Hiroshi Yamauchifdbd13c2015-09-02 16:16:58 -07001200 CHECK(!kUseReadBarrier);
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001201 Thread* self = Thread::Current();
1202 MutexLock mu(self, monitor_list_lock_);
1203 allow_new_monitors_ = true;
1204 monitor_add_condition_.Broadcast(self);
1205}
1206
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001207void MonitorList::BroadcastForNewMonitors() {
1208 CHECK(kUseReadBarrier);
1209 Thread* self = Thread::Current();
1210 MutexLock mu(self, monitor_list_lock_);
1211 monitor_add_condition_.Broadcast(self);
1212}
1213
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001214void MonitorList::Add(Monitor* m) {
1215 Thread* self = Thread::Current();
1216 MutexLock mu(self, monitor_list_lock_);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001217 while (UNLIKELY((!kUseReadBarrier && !allow_new_monitors_) ||
1218 (kUseReadBarrier && !self->GetWeakRefAccessEnabled()))) {
Mathieu Chartierc11d9b82013-09-19 10:01:59 -07001219 monitor_add_condition_.WaitHoldingLocks(self);
1220 }
Elliott Hughesc33a32b2011-10-11 18:18:07 -07001221 list_.push_front(m);
1222}
1223
Mathieu Chartier97509952015-07-13 14:35:43 -07001224void MonitorList::SweepMonitorList(IsMarkedVisitor* visitor) {
Andreas Gampe74240812014-04-17 10:35:09 -07001225 Thread* self = Thread::Current();
1226 MutexLock mu(self, monitor_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001227 for (auto it = list_.begin(); it != list_.end(); ) {
Elliott Hughesc33a32b2011-10-11 18:18:07 -07001228 Monitor* m = *it;
Hiroshi Yamauchi4cba0d92014-05-21 21:10:23 -07001229 // Disable the read barrier in GetObject() as this is called by GC.
1230 mirror::Object* obj = m->GetObject<kWithoutReadBarrier>();
Mathieu Chartier590fee92013-09-13 13:46:47 -07001231 // The object of a monitor can be null if we have deflated it.
Mathieu Chartier97509952015-07-13 14:35:43 -07001232 mirror::Object* new_obj = obj != nullptr ? visitor->IsMarked(obj) : nullptr;
Mathieu Chartier6aa3df92013-09-17 15:17:28 -07001233 if (new_obj == nullptr) {
1234 VLOG(monitor) << "freeing monitor " << m << " belonging to unmarked object "
Hiroshi Yamauchi4cba0d92014-05-21 21:10:23 -07001235 << obj;
Andreas Gampe74240812014-04-17 10:35:09 -07001236 MonitorPool::ReleaseMonitor(self, m);
Elliott Hughesc33a32b2011-10-11 18:18:07 -07001237 it = list_.erase(it);
1238 } else {
Mathieu Chartier6aa3df92013-09-17 15:17:28 -07001239 m->SetObject(new_obj);
Elliott Hughesc33a32b2011-10-11 18:18:07 -07001240 ++it;
1241 }
1242 }
1243}
1244
Mathieu Chartier97509952015-07-13 14:35:43 -07001245class MonitorDeflateVisitor : public IsMarkedVisitor {
1246 public:
1247 MonitorDeflateVisitor() : self_(Thread::Current()), deflate_count_(0) {}
1248
1249 virtual mirror::Object* IsMarked(mirror::Object* object) OVERRIDE
Mathieu Chartier90443472015-07-16 20:32:27 -07001250 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartier97509952015-07-13 14:35:43 -07001251 if (Monitor::Deflate(self_, object)) {
1252 DCHECK_NE(object->GetLockWord(true).GetState(), LockWord::kFatLocked);
1253 ++deflate_count_;
1254 // If we deflated, return null so that the monitor gets removed from the array.
1255 return nullptr;
1256 }
1257 return object; // Monitor was not deflated.
1258 }
1259
1260 Thread* const self_;
1261 size_t deflate_count_;
Mathieu Chartier48ab6872014-06-24 11:21:59 -07001262};
1263
Mathieu Chartier48ab6872014-06-24 11:21:59 -07001264size_t MonitorList::DeflateMonitors() {
Mathieu Chartier97509952015-07-13 14:35:43 -07001265 MonitorDeflateVisitor visitor;
1266 Locks::mutator_lock_->AssertExclusiveHeld(visitor.self_);
1267 SweepMonitorList(&visitor);
1268 return visitor.deflate_count_;
Mathieu Chartier440e4ce2014-03-31 16:36:35 -07001269}
1270
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001271MonitorInfo::MonitorInfo(mirror::Object* obj) : owner_(nullptr), entry_count_(0) {
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -07001272 DCHECK(obj != nullptr);
1273 LockWord lock_word = obj->GetLockWord(true);
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001274 switch (lock_word.GetState()) {
1275 case LockWord::kUnlocked:
Mathieu Chartierad2541a2013-10-25 10:05:23 -07001276 // Fall-through.
Mathieu Chartier590fee92013-09-13 13:46:47 -07001277 case LockWord::kForwardingAddress:
1278 // Fall-through.
Mathieu Chartierad2541a2013-10-25 10:05:23 -07001279 case LockWord::kHashCode:
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001280 break;
1281 case LockWord::kThinLocked:
1282 owner_ = Runtime::Current()->GetThreadList()->FindThreadByThreadId(lock_word.ThinLockOwner());
1283 entry_count_ = 1 + lock_word.ThinLockCount();
1284 // Thin locks have no waiters.
1285 break;
1286 case LockWord::kFatLocked: {
1287 Monitor* mon = lock_word.FatLockMonitor();
1288 owner_ = mon->owner_;
1289 entry_count_ = 1 + mon->lock_count_;
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001290 for (Thread* waiter = mon->wait_set_; waiter != nullptr; waiter = waiter->GetWaitNext()) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001291 waiters_.push_back(waiter);
1292 }
1293 break;
Elliott Hughesf327e072013-01-09 16:01:26 -08001294 }
1295 }
1296}
1297
Elliott Hughes5f791332011-09-15 17:45:30 -07001298} // namespace art