blob: 16ef0fff22fd22e025fd804e00cfc1b21f4603e7 [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 "thread_list.h"
18
Christopher Ferris6cff48f2014-01-26 21:36:13 -080019#include <backtrace/BacktraceMap.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070020#include <dirent.h>
Ian Rogersd9c4fc92013-10-01 19:45:43 -070021#include <ScopedLocalRef.h>
22#include <ScopedUtfChars.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070023#include <sys/types.h>
Elliott Hughes038a8062011-09-18 14:12:41 -070024#include <unistd.h>
25
Ian Rogersc7dd2952014-10-21 23:31:19 -070026#include <sstream>
27
Mathieu Chartier70a596d2014-12-17 14:56:47 -080028#include "base/histogram-inl.h"
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -070029#include "base/mutex-inl.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080030#include "base/systrace.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010031#include "base/time_utils.h"
Sameer Abu Asala8439542013-02-14 16:06:42 -080032#include "base/timing_logger.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070033#include "debugger.h"
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -070034#include "gc/collector/concurrent_copying.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070035#include "jni_internal.h"
36#include "lock_word.h"
37#include "monitor.h"
38#include "scoped_thread_state_change.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080039#include "thread.h"
Jeff Haoe094b872014-10-14 13:12:01 -070040#include "trace.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070041#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070042
Yu Lieac44242015-06-29 10:50:03 +080043#if ART_USE_FUTEXES
44#include "linux/futex.h"
45#include "sys/syscall.h"
46#ifndef SYS_futex
47#define SYS_futex __NR_futex
48#endif
49#endif // ART_USE_FUTEXES
50
Elliott Hughes8daa0922011-09-11 13:46:25 -070051namespace art {
52
Mathieu Chartier251755c2014-07-15 18:10:25 -070053static constexpr uint64_t kLongThreadSuspendThreshold = MsToNs(5);
Mathieu Chartier99143862015-02-03 14:26:46 -080054static constexpr uint64_t kThreadSuspendTimeoutMs = 30 * 1000; // 30s.
55// Use 0 since we want to yield to prevent blocking for an unpredictable amount of time.
56static constexpr useconds_t kThreadSuspendInitialSleepUs = 0;
57static constexpr useconds_t kThreadSuspendMaxYieldUs = 3000;
58static constexpr useconds_t kThreadSuspendMaxSleepUs = 5000;
Mathieu Chartier251755c2014-07-15 18:10:25 -070059
Andreas Gampe8d1594d2016-03-01 14:38:37 -080060// Whether we should try to dump the native stack of unattached threads. See commit ed8b723 for
61// some history.
62static constexpr bool kDumpUnattachedThreadNativeStack = true;
63
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080064ThreadList::ThreadList()
Mathieu Chartierb56200b2015-10-29 10:41:51 -070065 : suspend_all_count_(0),
66 debug_suspend_all_count_(0),
67 unregistering_count_(0),
68 suspend_all_historam_("suspend all histogram", 16, 64),
69 long_suspend_(false) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -080070 CHECK(Monitor::IsValidLockWord(LockWord::FromThinLockId(kMaxThreadId, 1, 0U)));
Elliott Hughes8daa0922011-09-11 13:46:25 -070071}
72
73ThreadList::~ThreadList() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080074 ScopedTrace trace(__PRETTY_FUNCTION__);
Elliott Hughese52e49b2012-04-02 16:05:44 -070075 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070076 // We need to detach the current thread here in case there's another thread waiting to join with
77 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070078 bool contains = false;
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080079 Thread* self = Thread::Current();
Mathieu Chartierfec72f42014-10-09 12:57:58 -070080 {
Mathieu Chartierfec72f42014-10-09 12:57:58 -070081 MutexLock mu(self, *Locks::thread_list_lock_);
82 contains = Contains(self);
83 }
84 if (contains) {
Elliott Hughes8daa0922011-09-11 13:46:25 -070085 Runtime::Current()->DetachCurrentThread();
86 }
Elliott Hughes6a144332012-04-03 13:07:11 -070087 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartier51168372015-08-12 16:40:32 -070088 // Disable GC and wait for GC to complete in case there are still daemon threads doing
89 // allocations.
90 gc::Heap* const heap = Runtime::Current()->GetHeap();
91 heap->DisableGCForShutdown();
92 // In case a GC is in progress, wait for it to finish.
93 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
Ian Rogers00f7d0e2012-07-19 15:28:27 -070094 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
95 // Thread::Init.
Mathieu Chartier4d87df62016-01-07 15:14:19 -080096 SuspendAllDaemonThreadsForShutdown();
Elliott Hughes8daa0922011-09-11 13:46:25 -070097}
98
99bool ThreadList::Contains(Thread* thread) {
100 return find(list_.begin(), list_.end(), thread) != list_.end();
101}
102
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700103bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -0700104 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700105 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700106 return true;
107 }
108 }
109 return false;
110}
111
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700112pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700113 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700114}
115
Mathieu Chartier590fee92013-09-13 13:46:47 -0700116void ThreadList::DumpNativeStacks(std::ostream& os) {
117 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800118 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700119 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700120 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800121 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700122 os << "\n";
123 }
124}
125
Elliott Hughesc967f782012-04-16 10:23:15 -0700126void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800127 {
128 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800129 // Only print if we have samples.
130 if (suspend_all_historam_.SampleSize() > 0) {
131 Histogram<uint64_t>::CumulativeData data;
132 suspend_all_historam_.CreateHistogram(&data);
133 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
134 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800135 }
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000136 bool dump_native_stack = Runtime::Current()->GetDumpNativeStackOnSigQuit();
137 Dump(os, dump_native_stack);
138 DumpUnattachedThreads(os, dump_native_stack);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700139}
140
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000141static void DumpUnattachedThread(std::ostream& os, pid_t tid, bool dump_native_stack)
142 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700143 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800144 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700145 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700146 DumpKernelStack(os, tid, " kernel: ", false);
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000147 if (dump_native_stack && kDumpUnattachedThreadNativeStack) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800148 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700149 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700150 os << "\n";
151}
152
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000153void ThreadList::DumpUnattachedThreads(std::ostream& os, bool dump_native_stack) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700154 DIR* d = opendir("/proc/self/task");
155 if (!d) {
156 return;
157 }
158
Ian Rogers50b35e22012-10-04 10:09:15 -0700159 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700160 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700161 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700162 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700163 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700164 if (!*end) {
165 bool contains;
166 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700167 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700168 contains = Contains(tid);
169 }
170 if (!contains) {
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000171 DumpUnattachedThread(os, tid, dump_native_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700172 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700173 }
174 }
175 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800176}
177
Mathieu Chartier47c19592016-03-07 11:59:01 -0800178// Dump checkpoint timeout in milliseconds. Larger amount on the target, since the device could be
179// overloaded with ANR dumps.
180static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 100000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800181
Ian Rogers7b078e82014-09-10 14:44:24 -0700182// A closure used by Thread::Dump.
183class DumpCheckpoint FINAL : public Closure {
184 public:
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000185 DumpCheckpoint(std::ostream* os, bool dump_native_stack)
186 : os_(os),
187 barrier_(0),
188 backtrace_map_(dump_native_stack ? BacktraceMap::Create(getpid()) : nullptr),
189 dump_native_stack_(dump_native_stack) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700190
191 void Run(Thread* thread) OVERRIDE {
192 // Note thread and self may not be equal if thread was already suspended at the point of the
193 // request.
194 Thread* self = Thread::Current();
195 std::ostringstream local_os;
196 {
197 ScopedObjectAccess soa(self);
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000198 thread->Dump(local_os, dump_native_stack_, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700199 }
200 local_os << "\n";
201 {
202 // Use the logging lock to ensure serialization when writing to the common ostream.
203 MutexLock mu(self, *Locks::logging_lock_);
204 *os_ << local_os.str();
205 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700206 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700207 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700208
209 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
210 Thread* self = Thread::Current();
211 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800212 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700213 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000214 // Avoid a recursive abort.
215 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
216 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700217 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700218 }
219
220 private:
221 // The common stream that will accumulate all the dumps.
222 std::ostream* const os_;
223 // The barrier to be passed through and for the requestor to wait upon.
224 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800225 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
226 std::unique_ptr<BacktraceMap> backtrace_map_;
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000227 // Whether we should dump the native stack.
228 const bool dump_native_stack_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700229};
230
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000231void ThreadList::Dump(std::ostream& os, bool dump_native_stack) {
Ian Rogers7b078e82014-09-10 14:44:24 -0700232 {
233 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
234 os << "DALVIK THREADS (" << list_.size() << "):\n";
235 }
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000236 DumpCheckpoint checkpoint(&os, dump_native_stack);
Mathieu Chartiere99f5322016-06-10 17:04:20 -0700237 size_t threads_running_checkpoint;
238 {
239 // Use SOA to prevent deadlocks if multiple threads are calling Dump() at the same time.
240 ScopedObjectAccess soa(Thread::Current());
241 threads_running_checkpoint = RunCheckpoint(&checkpoint);
242 }
Lei Lidd9943d2015-02-02 14:24:44 +0800243 if (threads_running_checkpoint != 0) {
244 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
245 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700246}
247
Ian Rogers50b35e22012-10-04 10:09:15 -0700248void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
249 MutexLock mu(self, *Locks::thread_list_lock_);
250 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700251 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800252 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700253 CHECK(thread->IsSuspended())
254 << "\nUnsuspended thread: <<" << *thread << "\n"
255 << "self: <<" << *Thread::Current();
256 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700257 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700258}
259
Ian Rogers66aee5c2012-08-15 17:17:47 -0700260#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700261// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800262NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700263 Runtime* runtime = Runtime::Current();
264 std::ostringstream ss;
265 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700266 Locks::mutator_lock_->Dump(ss);
267 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700268 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700269 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800270 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700271}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700272#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700273
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800274// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800275// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
276// we use sched_yield instead of calling usleep.
277static void ThreadSuspendSleep(useconds_t delay_us) {
278 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800279 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800280 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800281 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800282 }
283}
284
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700285size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700286 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800287 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
288 Locks::thread_list_lock_->AssertNotHeld(self);
289 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700290
291 std::vector<Thread*> suspended_count_modified_threads;
292 size_t count = 0;
293 {
294 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
295 // manually called.
296 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700297 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700298 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700299 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700300 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700301 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700302 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800303 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700304 break;
305 } else {
306 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700307 // The thread switched back to runnable.
308 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700309 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700310 continue;
311 }
Yu Lieac44242015-06-29 10:50:03 +0800312 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700313 suspended_count_modified_threads.push_back(thread);
314 break;
315 }
316 }
317 }
318 }
319 }
320
321 // Run the checkpoint on ourself while we wait for threads to suspend.
322 checkpoint_function->Run(self);
323
324 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700325 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700326 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800327 if (ATRACE_ENABLED()) {
328 std::ostringstream oss;
329 thread->ShortDump(oss);
330 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
331 }
332 // Busy wait until the thread is suspended.
333 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700334 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800335 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700336 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800337 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800338 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800339 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
340 ATRACE_END();
341 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
342 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
343 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700344 }
345 }
346 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700347 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700348 {
349 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800350 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700351 }
352 }
353
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800354 {
355 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
356 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
357 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
358 Thread::resume_cond_->Broadcast(self);
359 }
360
Lei Lidd9943d2015-02-02 14:24:44 +0800361 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700362}
363
Dave Allison39c3bfb2014-01-28 18:33:52 -0800364// Request that a checkpoint function be run on all active (non-suspended)
365// threads. Returns the number of successful requests.
366size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
367 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700368 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
369 Locks::thread_list_lock_->AssertNotHeld(self);
370 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
371 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800372
373 size_t count = 0;
374 {
375 // Call a checkpoint function for each non-suspended thread.
376 MutexLock mu(self, *Locks::thread_list_lock_);
377 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
378 for (const auto& thread : list_) {
379 if (thread != self) {
380 if (thread->RequestCheckpoint(checkpoint_function)) {
381 // This thread will run its checkpoint some time in the near future.
382 count++;
383 }
384 }
385 }
386 }
387
388 // Return the number of threads that will run the checkpoint function.
389 return count;
390}
391
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800392// A checkpoint/suspend-all hybrid to switch thread roots from
393// from-space to to-space refs. Used to synchronize threads at a point
394// to mark the initiation of marking while maintaining the to-space
395// invariant.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700396size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor,
397 Closure* flip_callback,
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800398 gc::collector::GarbageCollector* collector) {
399 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
400 const uint64_t start_time = NanoTime();
401 Thread* self = Thread::Current();
402 Locks::mutator_lock_->AssertNotHeld(self);
403 Locks::thread_list_lock_->AssertNotHeld(self);
404 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
405 CHECK_NE(self->GetState(), kRunnable);
406
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700407 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800408
409 // Run the flip callback for the collector.
410 Locks::mutator_lock_->ExclusiveLock(self);
411 flip_callback->Run(self);
412 Locks::mutator_lock_->ExclusiveUnlock(self);
413 collector->RegisterPause(NanoTime() - start_time);
414
415 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700416 std::vector<Thread*> runnable_threads;
417 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800418 {
419 MutexLock mu(self, *Locks::thread_list_lock_);
420 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
421 --suspend_all_count_;
422 for (const auto& thread : list_) {
423 if (thread == self) {
424 continue;
425 }
426 // Set the flip function for both runnable and suspended threads
427 // because Thread::DumpState/DumpJavaStack() (invoked by a
428 // checkpoint) may cause the flip function to be run for a
429 // runnable/suspended thread before a runnable threads runs it
430 // for itself or we run it for a suspended thread below.
431 thread->SetFlipFunction(thread_flip_visitor);
432 if (thread->IsSuspendedAtSuspendCheck()) {
433 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800434 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800435 runnable_threads.push_back(thread);
436 } else {
437 other_threads.push_back(thread);
438 }
439 }
440 Thread::resume_cond_->Broadcast(self);
441 }
442
443 // Run the closure on the other threads and let them resume.
444 {
445 ReaderMutexLock mu(self, *Locks::mutator_lock_);
446 for (const auto& thread : other_threads) {
447 Closure* flip_func = thread->GetFlipFunction();
448 if (flip_func != nullptr) {
449 flip_func->Run(thread);
450 }
451 }
452 // Run it for self.
453 thread_flip_visitor->Run(self);
454 }
455
456 // Resume other threads.
457 {
458 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
459 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800460 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800461 }
462 Thread::resume_cond_->Broadcast(self);
463 }
464
465 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
466}
467
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700468void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700469 Thread* self = Thread::Current();
470
Jeff Haoc5d824a2014-07-28 18:35:38 -0700471 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700472 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700473 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700474 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700475 }
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800476 {
477 ScopedTrace trace("Suspending mutator threads");
478 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700479
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800480 SuspendAllInternal(self, self);
481 // All threads are known to have suspended (but a thread may still own the mutator lock)
482 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700483#if HAVE_TIMED_RWLOCK
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800484 while (true) {
485 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
486 break;
487 } else if (!long_suspend_) {
488 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
489 // could result in a thread suspend timeout.
490 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
491 UnsafeLogFatalForThreadSuspendAllTimeout();
492 }
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700493 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700494#else
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800495 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700496#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700497
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800498 long_suspend_ = long_suspend;
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700499
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800500 const uint64_t end_time = NanoTime();
501 const uint64_t suspend_time = end_time - start_time;
502 suspend_all_historam_.AdjustAndAddValue(suspend_time);
503 if (suspend_time > kLongThreadSuspendThreshold) {
504 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
505 }
506
507 if (kDebugLocking) {
508 // Debug check that all threads are suspended.
509 AssertThreadsAreSuspended(self, self);
510 }
Mathieu Chartier251755c2014-07-15 18:10:25 -0700511 }
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700512 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700513
Jeff Haoc5d824a2014-07-28 18:35:38 -0700514 if (self != nullptr) {
515 VLOG(threads) << *self << " SuspendAll complete";
516 } else {
517 VLOG(threads) << "Thread[null] SuspendAll complete";
518 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700519}
520
Yu Lieac44242015-06-29 10:50:03 +0800521// Ensures all threads running Java suspend and that those not running Java don't start.
522// Debugger thread might be set to kRunnable for a short period of time after the
523// SuspendAllInternal. This is safe because it will be set back to suspended state before
524// the SuspendAll returns.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700525void ThreadList::SuspendAllInternal(Thread* self,
526 Thread* ignore1,
527 Thread* ignore2,
Yu Lieac44242015-06-29 10:50:03 +0800528 bool debug_suspend) {
529 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
530 Locks::thread_list_lock_->AssertNotHeld(self);
531 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
532 if (kDebugLocking && self != nullptr) {
533 CHECK_NE(self->GetState(), kRunnable);
534 }
535
536 // First request that all threads suspend, then wait for them to suspend before
537 // returning. This suspension scheme also relies on other behaviour:
538 // 1. Threads cannot be deleted while they are suspended or have a suspend-
539 // request flag set - (see Unregister() below).
540 // 2. When threads are created, they are created in a suspended state (actually
541 // kNative) and will never begin executing Java code without first checking
542 // the suspend-request flag.
543
544 // The atomic counter for number of threads that need to pass the barrier.
545 AtomicInteger pending_threads;
546 uint32_t num_ignored = 0;
547 if (ignore1 != nullptr) {
548 ++num_ignored;
549 }
550 if (ignore2 != nullptr && ignore1 != ignore2) {
551 ++num_ignored;
552 }
553 {
554 MutexLock mu(self, *Locks::thread_list_lock_);
555 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
556 // Update global suspend all state for attaching threads.
557 ++suspend_all_count_;
558 if (debug_suspend)
559 ++debug_suspend_all_count_;
560 pending_threads.StoreRelaxed(list_.size() - num_ignored);
561 // Increment everybody's suspend count (except those that should be ignored).
562 for (const auto& thread : list_) {
563 if (thread == ignore1 || thread == ignore2) {
564 continue;
565 }
566 VLOG(threads) << "requesting thread suspend: " << *thread;
567 while (true) {
568 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
569 break;
570 } else {
571 // Failure means the list of active_suspend_barriers is full, we should release the
572 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
573 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
574 // the thread to change to a suspended state, because it might need to run checkpoint
575 // function before the state change, which also needs thread_suspend_count_lock_.
576
577 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
578 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
579 // in the mean time.
580 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
581 NanoSleep(100000);
582 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
583 }
584 }
585
586 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
587 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
588 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
589 if (thread->IsSuspended()) {
590 // Only clear the counter for the current thread.
591 thread->ClearSuspendBarrier(&pending_threads);
592 pending_threads.FetchAndSubSequentiallyConsistent(1);
593 }
594 }
595 }
596
597 // Wait for the barrier to be passed by all runnable threads. This wait
598 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700599#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800600 timespec wait_timeout;
601 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700602#endif
Yu Lieac44242015-06-29 10:50:03 +0800603 while (true) {
604 int32_t cur_val = pending_threads.LoadRelaxed();
605 if (LIKELY(cur_val > 0)) {
606#if ART_USE_FUTEXES
607 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
608 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
609 if ((errno != EAGAIN) && (errno != EINTR)) {
610 if (errno == ETIMEDOUT) {
611 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
612 } else {
613 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
614 }
615 }
Vladimir Markod778cd62016-07-05 17:29:55 +0100616 } // else re-check pending_threads in the next iteration (this may be a spurious wake-up).
Yu Lieac44242015-06-29 10:50:03 +0800617#else
618 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
619#endif
620 } else {
621 CHECK_EQ(cur_val, 0);
622 break;
623 }
624 }
625}
626
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700627void ThreadList::ResumeAll() {
628 Thread* self = Thread::Current();
629
Jeff Haoc5d824a2014-07-28 18:35:38 -0700630 if (self != nullptr) {
631 VLOG(threads) << *self << " ResumeAll starting";
632 } else {
633 VLOG(threads) << "Thread[null] ResumeAll starting";
634 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700635
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700636 ATRACE_END();
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800637
638 ScopedTrace trace("Resuming mutator threads");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700639
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800640 if (kDebugLocking) {
641 // Debug check that all threads are suspended.
642 AssertThreadsAreSuspended(self, self);
643 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700644
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700645 long_suspend_ = false;
646
Ian Rogers81d425b2012-09-27 16:03:43 -0700647 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700648 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700649 MutexLock mu(self, *Locks::thread_list_lock_);
650 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700651 // Update global suspend all state for attaching threads.
652 --suspend_all_count_;
653 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700654 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700655 if (thread == self) {
656 continue;
657 }
Yu Lieac44242015-06-29 10:50:03 +0800658 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700659 }
660
661 // Broadcast a notification to all suspended threads, some or all of
662 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700663 if (self != nullptr) {
664 VLOG(threads) << *self << " ResumeAll waking others";
665 } else {
666 VLOG(threads) << "Thread[null] ResumeAll waking others";
667 }
Ian Rogersc604d732012-10-14 16:09:54 -0700668 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700669 }
Jeff Haoc5d824a2014-07-28 18:35:38 -0700670
671 if (self != nullptr) {
672 VLOG(threads) << *self << " ResumeAll complete";
673 } else {
674 VLOG(threads) << "Thread[null] ResumeAll complete";
675 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700676}
677
678void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800679 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
680 ATRACE_END();
681
Ian Rogers81d425b2012-09-27 16:03:43 -0700682 Thread* self = Thread::Current();
683 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700684 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
685 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700686
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700687 {
688 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700689 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700690 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700691 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
692 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700693 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700694 // We only expect threads within the thread-list to have been suspended otherwise we can't
695 // stop such threads from delete-ing themselves.
696 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
697 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700698 return;
699 }
Yu Lieac44242015-06-29 10:50:03 +0800700 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700701 }
702
703 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700704 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700705 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700706 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700707 }
708
Brian Carlstromba32de42014-08-27 23:43:46 -0700709 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700710}
Elliott Hughes01158d72011-09-19 19:47:10 -0700711
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700712static void ThreadSuspendByPeerWarning(Thread* self,
713 LogSeverity severity,
714 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700715 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700716 JNIEnvExt* env = self->GetJniEnv();
717 ScopedLocalRef<jstring>
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700718 scoped_name_string(env, static_cast<jstring>(env->GetObjectField(
719 peer, WellKnownClasses::java_lang_Thread_name)));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700720 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700721 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700722 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700723 env->ExceptionClear();
724 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700725 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700726 }
727}
728
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700729Thread* ThreadList::SuspendThreadByPeer(jobject peer,
730 bool request_suspension,
731 bool debug_suspension,
732 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800733 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800734 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700735 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800736 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800737 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700738 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700739 while (true) {
740 Thread* thread;
741 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700742 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
743 // is requesting another suspend, to avoid deadlock, by requiring this function be called
744 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
745 // than request thread suspension, to avoid potential cycles in threads requesting each other
746 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700747 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800748 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700749 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700750 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800751 if (suspended_thread != nullptr) {
752 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
753 // If we incremented the suspend count but the thread reset its peer, we need to
754 // re-decrement it since it is shutting down and may deadlock the runtime in
755 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800756 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800757 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700758 ThreadSuspendByPeerWarning(self, WARNING, "No such thread for suspend", peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700759 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700760 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700761 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800762 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700763 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
764 << reinterpret_cast<void*>(thread);
765 return nullptr;
766 }
767 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700768 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800769 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700770 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800771 if (self->GetSuspendCount() > 0) {
772 // We hold the suspend count lock but another thread is trying to suspend us. Its not
773 // safe to try to suspend another thread in case we get a cycle. Start the loop again
774 // which will allow this thread to be suspended.
775 continue;
776 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800777 CHECK(suspended_thread == nullptr);
778 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800779 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700780 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700781 } else {
782 // If the caller isn't requesting suspension, a suspension should have already occurred.
783 CHECK_GT(thread->GetSuspendCount(), 0);
784 }
785 // IsSuspended on the current thread will fail as the current thread is changed into
786 // Runnable above. As the suspend count is now raised if this is the current thread
787 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
788 // to just explicitly handle the current thread in the callers to this code.
789 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
790 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
791 // count, or else we've waited and it has self suspended) or is the current thread, we're
792 // done.
793 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700794 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800795 if (ATRACE_ENABLED()) {
796 std::string name;
797 thread->GetThreadName(name);
798 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
799 peer).c_str());
800 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700801 return thread;
802 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800803 const uint64_t total_delay = NanoTime() - start_time;
804 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700805 ThreadSuspendByPeerWarning(self, FATAL, "Thread suspension timed out", peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800806 if (suspended_thread != nullptr) {
807 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800808 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700809 }
810 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700811 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800812 } else if (sleep_us == 0 &&
813 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
814 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
815 // excessive CPU usage.
816 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700817 }
818 }
819 // Release locks and come out of runnable state.
820 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800821 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
822 ThreadSuspendSleep(sleep_us);
823 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
824 // all if possible. This shouldn't be an issue since time to suspend should always be small.
825 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700826 }
827}
828
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700829static void ThreadSuspendByThreadIdWarning(LogSeverity severity,
830 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700831 uint32_t thread_id) {
832 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700833}
834
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700835Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id,
836 bool debug_suspension,
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700837 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800838 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800839 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700840 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800841 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800842 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700843 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700844 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700845 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700846 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700847 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
848 // is requesting another suspend, to avoid deadlock, by requiring this function be called
849 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
850 // than request thread suspension, to avoid potential cycles in threads requesting each other
851 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700852 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800853 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700854 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700855 for (const auto& it : list_) {
856 if (it->GetThreadId() == thread_id) {
857 thread = it;
858 break;
859 }
860 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800861 if (thread == nullptr) {
862 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
863 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700864 // There's a race in inflating a lock and the owner giving up ownership and then dying.
865 ThreadSuspendByThreadIdWarning(WARNING, "No such thread id for suspend", thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700866 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700867 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700868 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
869 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700870 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800871 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800872 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800873 if (self->GetSuspendCount() > 0) {
874 // We hold the suspend count lock but another thread is trying to suspend us. Its not
875 // safe to try to suspend another thread in case we get a cycle. Start the loop again
876 // which will allow this thread to be suspended.
877 continue;
878 }
Yu Lieac44242015-06-29 10:50:03 +0800879 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800880 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700881 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800882 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700883 // If the caller isn't requesting suspension, a suspension should have already occurred.
884 CHECK_GT(thread->GetSuspendCount(), 0);
885 }
886 // IsSuspended on the current thread will fail as the current thread is changed into
887 // Runnable above. As the suspend count is now raised if this is the current thread
888 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
889 // to just explicitly handle the current thread in the callers to this code.
890 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
891 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
892 // count, or else we've waited and it has self suspended) or is the current thread, we're
893 // done.
894 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800895 if (ATRACE_ENABLED()) {
896 std::string name;
897 thread->GetThreadName(name);
898 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
899 name.c_str(), thread_id).c_str());
900 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700901 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700902 return thread;
903 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800904 const uint64_t total_delay = NanoTime() - start_time;
905 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700906 ThreadSuspendByThreadIdWarning(WARNING, "Thread suspension timed out", thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800907 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800908 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700909 }
910 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700911 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800912 } else if (sleep_us == 0 &&
913 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
914 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
915 // excessive CPU usage.
916 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700917 }
918 }
919 // Release locks and come out of runnable state.
920 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800921 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
922 ThreadSuspendSleep(sleep_us);
923 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700924 }
925}
926
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700927Thread* ThreadList::FindThreadByThreadId(uint32_t thread_id) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700928 for (const auto& thread : list_) {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700929 if (thread->GetThreadId() == thread_id) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700930 return thread;
931 }
932 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700933 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700934}
935
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700936void ThreadList::SuspendAllForDebugger() {
937 Thread* self = Thread::Current();
938 Thread* debug_thread = Dbg::GetDebugThread();
939
940 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
941
Yu Lieac44242015-06-29 10:50:03 +0800942 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700943 // Block on the mutator lock until all Runnable threads release their share of access then
944 // immediately unlock again.
945#if HAVE_TIMED_RWLOCK
946 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700947 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100948 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700949 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700950 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700951 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700952#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700953 Locks::mutator_lock_->ExclusiveLock(self);
954 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700955#endif
Mathieu Chartier9450c6c2015-11-07 11:55:23 -0800956 // Disabled for the following race condition:
957 // Thread 1 calls SuspendAllForDebugger, gets preempted after pulsing the mutator lock.
958 // Thread 2 calls SuspendAll and SetStateUnsafe (perhaps from Dbg::Disconnected).
959 // Thread 1 fails assertion that all threads are suspended due to thread 2 being in a runnable
960 // state (from SetStateUnsafe).
961 // AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700962
Sebastien Hertzed2be172014-08-19 15:33:43 +0200963 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700964}
965
Elliott Hughes475fc232011-10-25 15:00:35 -0700966void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100967 Thread* const self = Thread::Current();
968 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700969
Elliott Hughes475fc232011-10-25 15:00:35 -0700970 // The debugger thread must not suspend itself due to debugger activity!
971 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700972 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800973 CHECK_NE(self->GetState(), kRunnable);
974 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700975
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200976 // The debugger may have detached while we were executing an invoke request. In that case, we
977 // must not suspend ourself.
978 DebugInvokeReq* pReq = self->GetInvokeReq();
979 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
980 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800981 // Collisions with other suspends aren't really interesting. We want
982 // to ensure that we're the only one fiddling with the suspend count
983 // though.
984 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800985 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700986 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200987
988 VLOG(threads) << *self << " self-suspending (debugger)";
989 } else {
990 // We must no longer be subject to debugger suspension.
991 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
992 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
993
994 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800995 }
Elliott Hughes475fc232011-10-25 15:00:35 -0700996
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200997 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +0100998 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200999 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +01001000 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001001 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +01001002 }
1003
Elliott Hughes475fc232011-10-25 15:00:35 -07001004 // Tell JDWP that we've completed suspension. The JDWP thread can't
1005 // tell us to resume before we're fully asleep because we hold the
1006 // suspend count lock.
1007 Dbg::ClearWaitForEventThread();
1008
jeffhaoa77f0f62012-12-05 17:19:31 -08001009 {
1010 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001011 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001012 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001013 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001014 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +02001015 // can happen when we suspend then resume all threads to
1016 // update instrumentation or compute monitor info. This can
1017 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001018 // dump event is pending (assuming SignalCatcher was resumed for
1019 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001020 VLOG(jdwp) << *self << " still suspended after undo "
1021 << "(suspend count=" << self->GetSuspendCount() << ", "
1022 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001023 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001024 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001025 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001026 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001027
Sebastien Hertz1558b572015-02-25 15:05:59 +01001028 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001029 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001030}
1031
Sebastien Hertz253fa552014-10-14 17:27:15 +02001032void ThreadList::ResumeAllForDebugger() {
1033 Thread* self = Thread::Current();
1034 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001035
1036 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1037
1038 // Threads can't resume if we exclusively hold the mutator lock.
1039 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1040
1041 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001042 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001043 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001044 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001045 // Update global suspend all state for attaching threads.
1046 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001047 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001048 --suspend_all_count_;
1049 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001050 } else {
1051 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001052 // suspend them all before. That may happen if a debugger tries
1053 // to resume some suspended threads (with suspend count == 1)
1054 // at once with a VirtualMachine.Resume command. Let's print a
1055 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001056 LOG(WARNING) << "Debugger attempted to resume all threads without "
1057 << "having suspended them all before.";
1058 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001059 // Decrement everybody's suspend count (except our own).
1060 for (const auto& thread : list_) {
1061 if (thread == self || thread == debug_thread) {
1062 continue;
1063 }
1064 if (thread->GetDebugSuspendCount() == 0) {
1065 // This thread may have been individually resumed with ThreadReference.Resume.
1066 continue;
1067 }
1068 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001069 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001070 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001071 }
1072 }
1073
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001074 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001075 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1076 Thread::resume_cond_->Broadcast(self);
1077 }
1078
1079 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1080}
1081
Elliott Hughes234ab152011-10-26 14:02:26 -07001082void ThreadList::UndoDebuggerSuspensions() {
1083 Thread* self = Thread::Current();
1084
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001085 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001086
1087 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001088 MutexLock mu(self, *Locks::thread_list_lock_);
1089 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001090 // Update global suspend all state for attaching threads.
1091 suspend_all_count_ -= debug_suspend_all_count_;
1092 debug_suspend_all_count_ = 0;
1093 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001094 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001095 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001096 continue;
1097 }
Yu Lieac44242015-06-29 10:50:03 +08001098 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001099 }
1100 }
1101
1102 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001103 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001104 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001105 }
1106
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001107 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001108}
1109
Elliott Hughese52e49b2012-04-02 16:05:44 -07001110void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001111 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001112 Thread* self = Thread::Current();
1113 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001114 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001115 {
1116 // No more threads can be born after we start to shutdown.
1117 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001118 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001119 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1120 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001121 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001122 // Also wait for any threads that are unregistering to finish. This is required so that no
1123 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1124 // threads since they could unregister at the wrong time.
1125 bool done = unregistering_count_ == 0;
1126 if (done) {
1127 for (const auto& thread : list_) {
1128 if (thread != self && !thread->IsDaemon()) {
1129 done = false;
1130 break;
1131 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001132 }
1133 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001134 if (done) {
1135 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001136 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001137 // Wait for another thread to exit before re-checking.
1138 Locks::thread_exit_cond_->Wait(self);
1139 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001140}
1141
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001142void ThreadList::SuspendAllDaemonThreadsForShutdown() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001143 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001144 Thread* self = Thread::Current();
Mathieu Chartier62597d12016-01-11 10:19:06 -08001145 size_t daemons_left = 0;
Nicolas Geoffrayaa45daa2016-06-20 15:58:32 +01001146 {
1147 // Tell all the daemons it's time to suspend.
1148 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers81d425b2012-09-27 16:03:43 -07001149 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001150 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001151 // This is only run after all non-daemon threads have exited, so the remainder should all be
1152 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001153 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001154 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001155 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier62597d12016-01-11 10:19:06 -08001156 ++daemons_left;
Elliott Hughese52e49b2012-04-02 16:05:44 -07001157 }
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001158 // We are shutting down the runtime, set the JNI functions of all the JNIEnvs to be
1159 // the sleep forever one.
1160 thread->GetJniEnv()->SetFunctionsToRuntimeShutdownFunctions();
Elliott Hughes038a8062011-09-18 14:12:41 -07001161 }
1162 }
Mathieu Chartier62597d12016-01-11 10:19:06 -08001163 // If we have any daemons left, wait 200ms to ensure they are not stuck in a place where they
1164 // are about to access runtime state and are not in a runnable state. Examples: Monitor code
1165 // or waking up from a condition variable. TODO: Try and see if there is a better way to wait
1166 // for daemon threads to be in a blocked state.
1167 if (daemons_left > 0) {
1168 static constexpr size_t kDaemonSleepTime = 200 * 1000;
1169 usleep(kDaemonSleepTime);
1170 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001171 // Give the threads a chance to suspend, complaining if they're slow.
1172 bool have_complained = false;
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001173 static constexpr size_t kTimeoutMicroseconds = 2000 * 1000;
1174 static constexpr size_t kSleepMicroseconds = 1000;
1175 for (size_t i = 0; i < kTimeoutMicroseconds / kSleepMicroseconds; ++i) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001176 bool all_suspended = true;
Nicolas Geoffrayaa45daa2016-06-20 15:58:32 +01001177 {
1178 MutexLock mu(self, *Locks::thread_list_lock_);
1179 for (const auto& thread : list_) {
1180 if (thread != self && thread->GetState() == kRunnable) {
1181 if (!have_complained) {
1182 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1183 have_complained = true;
1184 }
1185 all_suspended = false;
Elliott Hughes038a8062011-09-18 14:12:41 -07001186 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001187 }
1188 }
1189 if (all_suspended) {
1190 return;
1191 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001192 usleep(kSleepMicroseconds);
Elliott Hughes038a8062011-09-18 14:12:41 -07001193 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001194 LOG(WARNING) << "timed out suspending all daemon threads";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001195}
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001196
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001197void ThreadList::Register(Thread* self) {
1198 DCHECK_EQ(self, Thread::Current());
1199
1200 if (VLOG_IS_ON(threads)) {
1201 std::ostringstream oss;
1202 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001203 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001204 }
1205
1206 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1207 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001208 MutexLock mu(self, *Locks::thread_list_lock_);
1209 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001210 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001211 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1212 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1213 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001214 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001215 }
Ian Rogers2966e132014-04-02 08:34:36 -07001216 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001217 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001218 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001219 CHECK(!Contains(self));
1220 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001221 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001222 // Initialize according to the state of the CC collector.
1223 bool is_gc_marking =
1224 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1225 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001226 bool weak_ref_access_enabled =
1227 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1228 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1229 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001230}
1231
1232void ThreadList::Unregister(Thread* self) {
1233 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001234 CHECK_NE(self->GetState(), kRunnable);
1235 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001236
1237 VLOG(threads) << "ThreadList::Unregister() " << *self;
1238
Mathieu Chartier91e56692015-03-03 13:51:04 -08001239 {
1240 MutexLock mu(self, *Locks::thread_list_lock_);
1241 ++unregistering_count_;
1242 }
1243
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001244 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001245 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1246 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1247 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1248 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001249 self->Destroy();
1250
Jeff Haoe094b872014-10-14 13:12:01 -07001251 // If tracing, remember thread id and name before thread exits.
1252 Trace::StoreExitingThreadInfo(self);
1253
Ian Rogersdd7624d2014-03-14 17:43:00 -07001254 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001255 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001256 // Remove and delete the Thread* while holding the thread_list_lock_ and
1257 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001258 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001259 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001260 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001261 std::string thread_name;
1262 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001263 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001264 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001265 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001266 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001267 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001268 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001269 if (!self->IsSuspended()) {
1270 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001271 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001272 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001273 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001274 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001275 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001276 delete self;
1277
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001278 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1279 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1280 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1281 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001282
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001283 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1284 // (It may wish to reattach later.)
Bilyan Borisovbb661c02016-04-04 16:27:32 +01001285#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001286 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1287#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001288 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001289#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001290
1291 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001292 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1293 --unregistering_count_;
1294 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001295}
1296
1297void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001298 for (const auto& thread : list_) {
1299 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001300 }
1301}
1302
Mathieu Chartierf8a86b92016-06-14 17:08:47 -07001303void ThreadList::VisitRootsForSuspendedThreads(RootVisitor* visitor) {
1304 Thread* const self = Thread::Current();
1305 std::vector<Thread*> threads_to_visit;
1306
1307 // Tell threads to suspend and copy them into list.
1308 {
1309 MutexLock mu(self, *Locks::thread_list_lock_);
1310 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1311 for (Thread* thread : list_) {
1312 thread->ModifySuspendCount(self, +1, nullptr, false);
1313 if (thread == self || thread->IsSuspended()) {
1314 threads_to_visit.push_back(thread);
1315 } else {
1316 thread->ModifySuspendCount(self, -1, nullptr, false);
1317 }
1318 }
1319 }
1320
1321 // Visit roots without holding thread_list_lock_ and thread_suspend_count_lock_ to prevent lock
1322 // order violations.
1323 for (Thread* thread : threads_to_visit) {
1324 thread->VisitRoots(visitor);
1325 }
1326
1327 // Restore suspend counts.
1328 {
1329 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1330 for (Thread* thread : threads_to_visit) {
1331 thread->ModifySuspendCount(self, -1, nullptr, false);
1332 }
1333 }
1334}
1335
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001336void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001337 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001338 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001339 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001340 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001341}
1342
Ian Rogerscfaa4552012-11-26 21:00:08 -08001343uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001344 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001345 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1346 if (!allocated_ids_[i]) {
1347 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001348 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001349 }
1350 }
1351 LOG(FATAL) << "Out of internal thread ids";
1352 return 0;
1353}
1354
Ian Rogerscfaa4552012-11-26 21:00:08 -08001355void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001356 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001357 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001358 DCHECK(allocated_ids_[id]) << id;
1359 allocated_ids_.reset(id);
1360}
1361
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001362ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1363 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1364}
1365
1366ScopedSuspendAll::~ScopedSuspendAll() {
1367 Runtime::Current()->GetThreadList()->ResumeAll();
1368}
1369
Elliott Hughes8daa0922011-09-11 13:46:25 -07001370} // namespace art