blob: 419ecec6968c5103aa8c4a006e279c165f1be2bf [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"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070038#include "native_stack_dump.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070039#include "scoped_thread_state_change.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080040#include "thread.h"
Jeff Haoe094b872014-10-14 13:12:01 -070041#include "trace.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070042#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070043
Yu Lieac44242015-06-29 10:50:03 +080044#if ART_USE_FUTEXES
45#include "linux/futex.h"
46#include "sys/syscall.h"
47#ifndef SYS_futex
48#define SYS_futex __NR_futex
49#endif
50#endif // ART_USE_FUTEXES
51
Elliott Hughes8daa0922011-09-11 13:46:25 -070052namespace art {
53
Mathieu Chartier251755c2014-07-15 18:10:25 -070054static constexpr uint64_t kLongThreadSuspendThreshold = MsToNs(5);
Mathieu Chartier99143862015-02-03 14:26:46 -080055static constexpr uint64_t kThreadSuspendTimeoutMs = 30 * 1000; // 30s.
56// Use 0 since we want to yield to prevent blocking for an unpredictable amount of time.
57static constexpr useconds_t kThreadSuspendInitialSleepUs = 0;
58static constexpr useconds_t kThreadSuspendMaxYieldUs = 3000;
59static constexpr useconds_t kThreadSuspendMaxSleepUs = 5000;
Mathieu Chartier251755c2014-07-15 18:10:25 -070060
Andreas Gampe8d1594d2016-03-01 14:38:37 -080061// Whether we should try to dump the native stack of unattached threads. See commit ed8b723 for
62// some history.
63static constexpr bool kDumpUnattachedThreadNativeStack = true;
64
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080065ThreadList::ThreadList()
Mathieu Chartierb56200b2015-10-29 10:41:51 -070066 : suspend_all_count_(0),
67 debug_suspend_all_count_(0),
68 unregistering_count_(0),
69 suspend_all_historam_("suspend all histogram", 16, 64),
70 long_suspend_(false) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -080071 CHECK(Monitor::IsValidLockWord(LockWord::FromThinLockId(kMaxThreadId, 1, 0U)));
Elliott Hughes8daa0922011-09-11 13:46:25 -070072}
73
74ThreadList::~ThreadList() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080075 ScopedTrace trace(__PRETTY_FUNCTION__);
Elliott Hughese52e49b2012-04-02 16:05:44 -070076 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070077 // We need to detach the current thread here in case there's another thread waiting to join with
78 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070079 bool contains = false;
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080080 Thread* self = Thread::Current();
Mathieu Chartierfec72f42014-10-09 12:57:58 -070081 {
Mathieu Chartierfec72f42014-10-09 12:57:58 -070082 MutexLock mu(self, *Locks::thread_list_lock_);
83 contains = Contains(self);
84 }
85 if (contains) {
Elliott Hughes8daa0922011-09-11 13:46:25 -070086 Runtime::Current()->DetachCurrentThread();
87 }
Elliott Hughes6a144332012-04-03 13:07:11 -070088 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartier51168372015-08-12 16:40:32 -070089 // Disable GC and wait for GC to complete in case there are still daemon threads doing
90 // allocations.
91 gc::Heap* const heap = Runtime::Current()->GetHeap();
92 heap->DisableGCForShutdown();
93 // In case a GC is in progress, wait for it to finish.
94 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
Ian Rogers00f7d0e2012-07-19 15:28:27 -070095 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
96 // Thread::Init.
Mathieu Chartier4d87df62016-01-07 15:14:19 -080097 SuspendAllDaemonThreadsForShutdown();
Elliott Hughes8daa0922011-09-11 13:46:25 -070098}
99
100bool ThreadList::Contains(Thread* thread) {
101 return find(list_.begin(), list_.end(), thread) != list_.end();
102}
103
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700104bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -0700105 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700106 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700107 return true;
108 }
109 }
110 return false;
111}
112
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700113pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700114 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700115}
116
Mathieu Chartier590fee92013-09-13 13:46:47 -0700117void ThreadList::DumpNativeStacks(std::ostream& os) {
118 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800119 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700120 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700121 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800122 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700123 os << "\n";
124 }
125}
126
Elliott Hughesc967f782012-04-16 10:23:15 -0700127void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800128 {
129 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800130 // Only print if we have samples.
131 if (suspend_all_historam_.SampleSize() > 0) {
132 Histogram<uint64_t>::CumulativeData data;
133 suspend_all_historam_.CreateHistogram(&data);
134 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
135 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800136 }
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000137 bool dump_native_stack = Runtime::Current()->GetDumpNativeStackOnSigQuit();
138 Dump(os, dump_native_stack);
139 DumpUnattachedThreads(os, dump_native_stack);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700140}
141
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000142static void DumpUnattachedThread(std::ostream& os, pid_t tid, bool dump_native_stack)
143 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700144 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800145 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700146 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700147 DumpKernelStack(os, tid, " kernel: ", false);
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000148 if (dump_native_stack && kDumpUnattachedThreadNativeStack) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800149 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700150 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700151 os << "\n";
152}
153
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000154void ThreadList::DumpUnattachedThreads(std::ostream& os, bool dump_native_stack) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700155 DIR* d = opendir("/proc/self/task");
156 if (!d) {
157 return;
158 }
159
Ian Rogers50b35e22012-10-04 10:09:15 -0700160 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700161 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700162 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700163 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700164 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700165 if (!*end) {
166 bool contains;
167 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700168 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700169 contains = Contains(tid);
170 }
171 if (!contains) {
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000172 DumpUnattachedThread(os, tid, dump_native_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700173 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700174 }
175 }
176 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800177}
178
Mathieu Chartier47c19592016-03-07 11:59:01 -0800179// Dump checkpoint timeout in milliseconds. Larger amount on the target, since the device could be
180// overloaded with ANR dumps.
181static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 100000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800182
Ian Rogers7b078e82014-09-10 14:44:24 -0700183// A closure used by Thread::Dump.
184class DumpCheckpoint FINAL : public Closure {
185 public:
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000186 DumpCheckpoint(std::ostream* os, bool dump_native_stack)
187 : os_(os),
188 barrier_(0),
189 backtrace_map_(dump_native_stack ? BacktraceMap::Create(getpid()) : nullptr),
190 dump_native_stack_(dump_native_stack) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700191
192 void Run(Thread* thread) OVERRIDE {
193 // Note thread and self may not be equal if thread was already suspended at the point of the
194 // request.
195 Thread* self = Thread::Current();
196 std::ostringstream local_os;
197 {
198 ScopedObjectAccess soa(self);
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000199 thread->Dump(local_os, dump_native_stack_, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700200 }
201 local_os << "\n";
202 {
203 // Use the logging lock to ensure serialization when writing to the common ostream.
204 MutexLock mu(self, *Locks::logging_lock_);
205 *os_ << local_os.str();
206 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700207 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700208 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700209
210 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
211 Thread* self = Thread::Current();
212 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800213 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700214 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000215 // Avoid a recursive abort.
216 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
217 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700218 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700219 }
220
221 private:
222 // The common stream that will accumulate all the dumps.
223 std::ostream* const os_;
224 // The barrier to be passed through and for the requestor to wait upon.
225 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800226 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
227 std::unique_ptr<BacktraceMap> backtrace_map_;
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000228 // Whether we should dump the native stack.
229 const bool dump_native_stack_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700230};
231
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000232void ThreadList::Dump(std::ostream& os, bool dump_native_stack) {
Ian Rogers7b078e82014-09-10 14:44:24 -0700233 {
234 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
235 os << "DALVIK THREADS (" << list_.size() << "):\n";
236 }
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000237 DumpCheckpoint checkpoint(&os, dump_native_stack);
Mathieu Chartiere99f5322016-06-10 17:04:20 -0700238 size_t threads_running_checkpoint;
239 {
240 // Use SOA to prevent deadlocks if multiple threads are calling Dump() at the same time.
241 ScopedObjectAccess soa(Thread::Current());
242 threads_running_checkpoint = RunCheckpoint(&checkpoint);
243 }
Lei Lidd9943d2015-02-02 14:24:44 +0800244 if (threads_running_checkpoint != 0) {
245 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
246 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700247}
248
Ian Rogers50b35e22012-10-04 10:09:15 -0700249void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
250 MutexLock mu(self, *Locks::thread_list_lock_);
251 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700252 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800253 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700254 CHECK(thread->IsSuspended())
255 << "\nUnsuspended thread: <<" << *thread << "\n"
256 << "self: <<" << *Thread::Current();
257 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700258 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700259}
260
Ian Rogers66aee5c2012-08-15 17:17:47 -0700261#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700262// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800263NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700264 Runtime* runtime = Runtime::Current();
265 std::ostringstream ss;
266 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700267 Locks::mutator_lock_->Dump(ss);
268 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700269 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700270 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800271 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700272}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700273#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700274
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800275// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800276// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
277// we use sched_yield instead of calling usleep.
278static void ThreadSuspendSleep(useconds_t delay_us) {
279 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800280 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800281 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800282 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800283 }
284}
285
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700286size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700287 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800288 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
289 Locks::thread_list_lock_->AssertNotHeld(self);
290 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700291
292 std::vector<Thread*> suspended_count_modified_threads;
293 size_t count = 0;
294 {
295 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
296 // manually called.
297 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700298 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700299 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700300 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700301 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700302 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700303 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800304 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700305 break;
306 } else {
307 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700308 // The thread switched back to runnable.
309 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700310 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700311 continue;
312 }
Yu Lieac44242015-06-29 10:50:03 +0800313 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700314 suspended_count_modified_threads.push_back(thread);
315 break;
316 }
317 }
318 }
319 }
320 }
321
322 // Run the checkpoint on ourself while we wait for threads to suspend.
323 checkpoint_function->Run(self);
324
325 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700326 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700327 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800328 if (ATRACE_ENABLED()) {
329 std::ostringstream oss;
330 thread->ShortDump(oss);
331 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
332 }
333 // Busy wait until the thread is suspended.
334 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700335 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800336 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700337 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800338 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800339 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800340 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
341 ATRACE_END();
342 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
343 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
344 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700345 }
346 }
347 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700348 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700349 {
350 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800351 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700352 }
353 }
354
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800355 {
356 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
357 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
358 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
359 Thread::resume_cond_->Broadcast(self);
360 }
361
Lei Lidd9943d2015-02-02 14:24:44 +0800362 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700363}
364
Dave Allison39c3bfb2014-01-28 18:33:52 -0800365// Request that a checkpoint function be run on all active (non-suspended)
366// threads. Returns the number of successful requests.
367size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
368 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700369 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
370 Locks::thread_list_lock_->AssertNotHeld(self);
371 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
372 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800373
374 size_t count = 0;
375 {
376 // Call a checkpoint function for each non-suspended thread.
377 MutexLock mu(self, *Locks::thread_list_lock_);
378 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
379 for (const auto& thread : list_) {
380 if (thread != self) {
381 if (thread->RequestCheckpoint(checkpoint_function)) {
382 // This thread will run its checkpoint some time in the near future.
383 count++;
384 }
385 }
386 }
387 }
388
389 // Return the number of threads that will run the checkpoint function.
390 return count;
391}
392
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800393// A checkpoint/suspend-all hybrid to switch thread roots from
394// from-space to to-space refs. Used to synchronize threads at a point
395// to mark the initiation of marking while maintaining the to-space
396// invariant.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700397size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor,
398 Closure* flip_callback,
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800399 gc::collector::GarbageCollector* collector) {
400 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
401 const uint64_t start_time = NanoTime();
402 Thread* self = Thread::Current();
403 Locks::mutator_lock_->AssertNotHeld(self);
404 Locks::thread_list_lock_->AssertNotHeld(self);
405 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
406 CHECK_NE(self->GetState(), kRunnable);
407
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700408 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800409
410 // Run the flip callback for the collector.
411 Locks::mutator_lock_->ExclusiveLock(self);
412 flip_callback->Run(self);
413 Locks::mutator_lock_->ExclusiveUnlock(self);
414 collector->RegisterPause(NanoTime() - start_time);
415
416 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700417 std::vector<Thread*> runnable_threads;
418 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800419 {
420 MutexLock mu(self, *Locks::thread_list_lock_);
421 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
422 --suspend_all_count_;
423 for (const auto& thread : list_) {
424 if (thread == self) {
425 continue;
426 }
427 // Set the flip function for both runnable and suspended threads
428 // because Thread::DumpState/DumpJavaStack() (invoked by a
429 // checkpoint) may cause the flip function to be run for a
430 // runnable/suspended thread before a runnable threads runs it
431 // for itself or we run it for a suspended thread below.
432 thread->SetFlipFunction(thread_flip_visitor);
433 if (thread->IsSuspendedAtSuspendCheck()) {
434 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800435 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800436 runnable_threads.push_back(thread);
437 } else {
438 other_threads.push_back(thread);
439 }
440 }
441 Thread::resume_cond_->Broadcast(self);
442 }
443
444 // Run the closure on the other threads and let them resume.
445 {
446 ReaderMutexLock mu(self, *Locks::mutator_lock_);
447 for (const auto& thread : other_threads) {
448 Closure* flip_func = thread->GetFlipFunction();
449 if (flip_func != nullptr) {
450 flip_func->Run(thread);
451 }
452 }
453 // Run it for self.
454 thread_flip_visitor->Run(self);
455 }
456
457 // Resume other threads.
458 {
459 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
460 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800461 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800462 }
463 Thread::resume_cond_->Broadcast(self);
464 }
465
466 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
467}
468
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700469void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700470 Thread* self = Thread::Current();
471
Jeff Haoc5d824a2014-07-28 18:35:38 -0700472 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700473 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700474 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700475 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700476 }
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800477 {
478 ScopedTrace trace("Suspending mutator threads");
479 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700480
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800481 SuspendAllInternal(self, self);
482 // All threads are known to have suspended (but a thread may still own the mutator lock)
483 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700484#if HAVE_TIMED_RWLOCK
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800485 while (true) {
486 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
487 break;
488 } else if (!long_suspend_) {
489 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
490 // could result in a thread suspend timeout.
491 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
492 UnsafeLogFatalForThreadSuspendAllTimeout();
493 }
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700494 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700495#else
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800496 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700497#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700498
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800499 long_suspend_ = long_suspend;
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700500
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800501 const uint64_t end_time = NanoTime();
502 const uint64_t suspend_time = end_time - start_time;
503 suspend_all_historam_.AdjustAndAddValue(suspend_time);
504 if (suspend_time > kLongThreadSuspendThreshold) {
505 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
506 }
507
508 if (kDebugLocking) {
509 // Debug check that all threads are suspended.
510 AssertThreadsAreSuspended(self, self);
511 }
Mathieu Chartier251755c2014-07-15 18:10:25 -0700512 }
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700513 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700514
Jeff Haoc5d824a2014-07-28 18:35:38 -0700515 if (self != nullptr) {
516 VLOG(threads) << *self << " SuspendAll complete";
517 } else {
518 VLOG(threads) << "Thread[null] SuspendAll complete";
519 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700520}
521
Yu Lieac44242015-06-29 10:50:03 +0800522// Ensures all threads running Java suspend and that those not running Java don't start.
523// Debugger thread might be set to kRunnable for a short period of time after the
524// SuspendAllInternal. This is safe because it will be set back to suspended state before
525// the SuspendAll returns.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700526void ThreadList::SuspendAllInternal(Thread* self,
527 Thread* ignore1,
528 Thread* ignore2,
Yu Lieac44242015-06-29 10:50:03 +0800529 bool debug_suspend) {
530 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
531 Locks::thread_list_lock_->AssertNotHeld(self);
532 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
533 if (kDebugLocking && self != nullptr) {
534 CHECK_NE(self->GetState(), kRunnable);
535 }
536
537 // First request that all threads suspend, then wait for them to suspend before
538 // returning. This suspension scheme also relies on other behaviour:
539 // 1. Threads cannot be deleted while they are suspended or have a suspend-
540 // request flag set - (see Unregister() below).
541 // 2. When threads are created, they are created in a suspended state (actually
542 // kNative) and will never begin executing Java code without first checking
543 // the suspend-request flag.
544
545 // The atomic counter for number of threads that need to pass the barrier.
546 AtomicInteger pending_threads;
547 uint32_t num_ignored = 0;
548 if (ignore1 != nullptr) {
549 ++num_ignored;
550 }
551 if (ignore2 != nullptr && ignore1 != ignore2) {
552 ++num_ignored;
553 }
554 {
555 MutexLock mu(self, *Locks::thread_list_lock_);
556 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
557 // Update global suspend all state for attaching threads.
558 ++suspend_all_count_;
559 if (debug_suspend)
560 ++debug_suspend_all_count_;
561 pending_threads.StoreRelaxed(list_.size() - num_ignored);
562 // Increment everybody's suspend count (except those that should be ignored).
563 for (const auto& thread : list_) {
564 if (thread == ignore1 || thread == ignore2) {
565 continue;
566 }
567 VLOG(threads) << "requesting thread suspend: " << *thread;
568 while (true) {
569 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
570 break;
571 } else {
572 // Failure means the list of active_suspend_barriers is full, we should release the
573 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
574 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
575 // the thread to change to a suspended state, because it might need to run checkpoint
576 // function before the state change, which also needs thread_suspend_count_lock_.
577
578 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
579 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
580 // in the mean time.
581 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
582 NanoSleep(100000);
583 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
584 }
585 }
586
587 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
588 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
589 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
590 if (thread->IsSuspended()) {
591 // Only clear the counter for the current thread.
592 thread->ClearSuspendBarrier(&pending_threads);
593 pending_threads.FetchAndSubSequentiallyConsistent(1);
594 }
595 }
596 }
597
598 // Wait for the barrier to be passed by all runnable threads. This wait
599 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700600#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800601 timespec wait_timeout;
602 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700603#endif
Yu Lieac44242015-06-29 10:50:03 +0800604 while (true) {
605 int32_t cur_val = pending_threads.LoadRelaxed();
606 if (LIKELY(cur_val > 0)) {
607#if ART_USE_FUTEXES
608 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
609 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
610 if ((errno != EAGAIN) && (errno != EINTR)) {
611 if (errno == ETIMEDOUT) {
612 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
613 } else {
614 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
615 }
616 }
Vladimir Markod778cd62016-07-05 17:29:55 +0100617 } // else re-check pending_threads in the next iteration (this may be a spurious wake-up).
Yu Lieac44242015-06-29 10:50:03 +0800618#else
619 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
620#endif
621 } else {
622 CHECK_EQ(cur_val, 0);
623 break;
624 }
625 }
626}
627
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700628void ThreadList::ResumeAll() {
629 Thread* self = Thread::Current();
630
Jeff Haoc5d824a2014-07-28 18:35:38 -0700631 if (self != nullptr) {
632 VLOG(threads) << *self << " ResumeAll starting";
633 } else {
634 VLOG(threads) << "Thread[null] ResumeAll starting";
635 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700636
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700637 ATRACE_END();
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800638
639 ScopedTrace trace("Resuming mutator threads");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700640
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800641 if (kDebugLocking) {
642 // Debug check that all threads are suspended.
643 AssertThreadsAreSuspended(self, self);
644 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700645
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700646 long_suspend_ = false;
647
Ian Rogers81d425b2012-09-27 16:03:43 -0700648 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700649 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700650 MutexLock mu(self, *Locks::thread_list_lock_);
651 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700652 // Update global suspend all state for attaching threads.
653 --suspend_all_count_;
654 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700655 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700656 if (thread == self) {
657 continue;
658 }
Yu Lieac44242015-06-29 10:50:03 +0800659 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700660 }
661
662 // Broadcast a notification to all suspended threads, some or all of
663 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700664 if (self != nullptr) {
665 VLOG(threads) << *self << " ResumeAll waking others";
666 } else {
667 VLOG(threads) << "Thread[null] ResumeAll waking others";
668 }
Ian Rogersc604d732012-10-14 16:09:54 -0700669 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700670 }
Jeff Haoc5d824a2014-07-28 18:35:38 -0700671
672 if (self != nullptr) {
673 VLOG(threads) << *self << " ResumeAll complete";
674 } else {
675 VLOG(threads) << "Thread[null] ResumeAll complete";
676 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700677}
678
679void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800680 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
681 ATRACE_END();
682
Ian Rogers81d425b2012-09-27 16:03:43 -0700683 Thread* self = Thread::Current();
684 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700685 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
686 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700687
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700688 {
689 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700690 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700691 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700692 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
693 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700694 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700695 // We only expect threads within the thread-list to have been suspended otherwise we can't
696 // stop such threads from delete-ing themselves.
697 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
698 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700699 return;
700 }
Yu Lieac44242015-06-29 10:50:03 +0800701 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700702 }
703
704 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700705 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700706 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700707 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700708 }
709
Brian Carlstromba32de42014-08-27 23:43:46 -0700710 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700711}
Elliott Hughes01158d72011-09-19 19:47:10 -0700712
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700713static void ThreadSuspendByPeerWarning(Thread* self,
714 LogSeverity severity,
715 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700716 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700717 JNIEnvExt* env = self->GetJniEnv();
718 ScopedLocalRef<jstring>
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700719 scoped_name_string(env, static_cast<jstring>(env->GetObjectField(
720 peer, WellKnownClasses::java_lang_Thread_name)));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700721 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700722 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700723 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700724 env->ExceptionClear();
725 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700726 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700727 }
728}
729
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700730Thread* ThreadList::SuspendThreadByPeer(jobject peer,
731 bool request_suspension,
732 bool debug_suspension,
733 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800734 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800735 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700736 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800737 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800738 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700739 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700740 while (true) {
741 Thread* thread;
742 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700743 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
744 // is requesting another suspend, to avoid deadlock, by requiring this function be called
745 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
746 // than request thread suspension, to avoid potential cycles in threads requesting each other
747 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700748 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800749 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700750 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700751 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800752 if (suspended_thread != nullptr) {
753 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
754 // If we incremented the suspend count but the thread reset its peer, we need to
755 // re-decrement it since it is shutting down and may deadlock the runtime in
756 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800757 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800758 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700759 ThreadSuspendByPeerWarning(self, WARNING, "No such thread for suspend", peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700760 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700761 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700762 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800763 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700764 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
765 << reinterpret_cast<void*>(thread);
766 return nullptr;
767 }
768 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700769 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800770 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700771 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800772 if (self->GetSuspendCount() > 0) {
773 // We hold the suspend count lock but another thread is trying to suspend us. Its not
774 // safe to try to suspend another thread in case we get a cycle. Start the loop again
775 // which will allow this thread to be suspended.
776 continue;
777 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800778 CHECK(suspended_thread == nullptr);
779 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800780 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700781 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700782 } else {
783 // If the caller isn't requesting suspension, a suspension should have already occurred.
784 CHECK_GT(thread->GetSuspendCount(), 0);
785 }
786 // IsSuspended on the current thread will fail as the current thread is changed into
787 // Runnable above. As the suspend count is now raised if this is the current thread
788 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
789 // to just explicitly handle the current thread in the callers to this code.
790 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
791 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
792 // count, or else we've waited and it has self suspended) or is the current thread, we're
793 // done.
794 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700795 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800796 if (ATRACE_ENABLED()) {
797 std::string name;
798 thread->GetThreadName(name);
799 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
800 peer).c_str());
801 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700802 return thread;
803 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800804 const uint64_t total_delay = NanoTime() - start_time;
805 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700806 ThreadSuspendByPeerWarning(self, FATAL, "Thread suspension timed out", peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800807 if (suspended_thread != nullptr) {
808 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800809 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700810 }
811 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700812 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800813 } else if (sleep_us == 0 &&
814 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
815 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
816 // excessive CPU usage.
817 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700818 }
819 }
820 // Release locks and come out of runnable state.
821 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800822 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
823 ThreadSuspendSleep(sleep_us);
824 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
825 // all if possible. This shouldn't be an issue since time to suspend should always be small.
826 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700827 }
828}
829
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700830static void ThreadSuspendByThreadIdWarning(LogSeverity severity,
831 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700832 uint32_t thread_id) {
833 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700834}
835
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700836Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id,
837 bool debug_suspension,
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700838 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800839 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800840 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700841 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800842 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800843 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700844 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700845 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700846 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700847 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700848 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
849 // is requesting another suspend, to avoid deadlock, by requiring this function be called
850 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
851 // than request thread suspension, to avoid potential cycles in threads requesting each other
852 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700853 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800854 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700855 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700856 for (const auto& it : list_) {
857 if (it->GetThreadId() == thread_id) {
858 thread = it;
859 break;
860 }
861 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800862 if (thread == nullptr) {
863 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
864 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700865 // There's a race in inflating a lock and the owner giving up ownership and then dying.
866 ThreadSuspendByThreadIdWarning(WARNING, "No such thread id for suspend", thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700867 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700868 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700869 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
870 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700871 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800872 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800873 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800874 if (self->GetSuspendCount() > 0) {
875 // We hold the suspend count lock but another thread is trying to suspend us. Its not
876 // safe to try to suspend another thread in case we get a cycle. Start the loop again
877 // which will allow this thread to be suspended.
878 continue;
879 }
Yu Lieac44242015-06-29 10:50:03 +0800880 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800881 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700882 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800883 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700884 // If the caller isn't requesting suspension, a suspension should have already occurred.
885 CHECK_GT(thread->GetSuspendCount(), 0);
886 }
887 // IsSuspended on the current thread will fail as the current thread is changed into
888 // Runnable above. As the suspend count is now raised if this is the current thread
889 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
890 // to just explicitly handle the current thread in the callers to this code.
891 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
892 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
893 // count, or else we've waited and it has self suspended) or is the current thread, we're
894 // done.
895 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800896 if (ATRACE_ENABLED()) {
897 std::string name;
898 thread->GetThreadName(name);
899 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
900 name.c_str(), thread_id).c_str());
901 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700902 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700903 return thread;
904 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800905 const uint64_t total_delay = NanoTime() - start_time;
906 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700907 ThreadSuspendByThreadIdWarning(WARNING, "Thread suspension timed out", thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800908 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800909 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700910 }
911 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700912 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800913 } else if (sleep_us == 0 &&
914 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
915 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
916 // excessive CPU usage.
917 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700918 }
919 }
920 // Release locks and come out of runnable state.
921 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800922 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
923 ThreadSuspendSleep(sleep_us);
924 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700925 }
926}
927
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700928Thread* ThreadList::FindThreadByThreadId(uint32_t thread_id) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700929 for (const auto& thread : list_) {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700930 if (thread->GetThreadId() == thread_id) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700931 return thread;
932 }
933 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700934 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700935}
936
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700937void ThreadList::SuspendAllForDebugger() {
938 Thread* self = Thread::Current();
939 Thread* debug_thread = Dbg::GetDebugThread();
940
941 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
942
Yu Lieac44242015-06-29 10:50:03 +0800943 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700944 // Block on the mutator lock until all Runnable threads release their share of access then
945 // immediately unlock again.
946#if HAVE_TIMED_RWLOCK
947 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700948 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100949 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700950 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700951 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700952 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700953#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700954 Locks::mutator_lock_->ExclusiveLock(self);
955 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700956#endif
Mathieu Chartier9450c6c2015-11-07 11:55:23 -0800957 // Disabled for the following race condition:
958 // Thread 1 calls SuspendAllForDebugger, gets preempted after pulsing the mutator lock.
959 // Thread 2 calls SuspendAll and SetStateUnsafe (perhaps from Dbg::Disconnected).
960 // Thread 1 fails assertion that all threads are suspended due to thread 2 being in a runnable
961 // state (from SetStateUnsafe).
962 // AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700963
Sebastien Hertzed2be172014-08-19 15:33:43 +0200964 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700965}
966
Elliott Hughes475fc232011-10-25 15:00:35 -0700967void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100968 Thread* const self = Thread::Current();
969 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700970
Elliott Hughes475fc232011-10-25 15:00:35 -0700971 // The debugger thread must not suspend itself due to debugger activity!
972 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700973 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800974 CHECK_NE(self->GetState(), kRunnable);
975 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700976
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200977 // The debugger may have detached while we were executing an invoke request. In that case, we
978 // must not suspend ourself.
979 DebugInvokeReq* pReq = self->GetInvokeReq();
980 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
981 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800982 // Collisions with other suspends aren't really interesting. We want
983 // to ensure that we're the only one fiddling with the suspend count
984 // though.
985 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800986 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700987 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200988
989 VLOG(threads) << *self << " self-suspending (debugger)";
990 } else {
991 // We must no longer be subject to debugger suspension.
992 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
993 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
994
995 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800996 }
Elliott Hughes475fc232011-10-25 15:00:35 -0700997
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200998 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +0100999 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001000 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +01001001 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001002 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +01001003 }
1004
Elliott Hughes475fc232011-10-25 15:00:35 -07001005 // Tell JDWP that we've completed suspension. The JDWP thread can't
1006 // tell us to resume before we're fully asleep because we hold the
1007 // suspend count lock.
1008 Dbg::ClearWaitForEventThread();
1009
jeffhaoa77f0f62012-12-05 17:19:31 -08001010 {
1011 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001012 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001013 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001014 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001015 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +02001016 // can happen when we suspend then resume all threads to
1017 // update instrumentation or compute monitor info. This can
1018 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001019 // dump event is pending (assuming SignalCatcher was resumed for
1020 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001021 VLOG(jdwp) << *self << " still suspended after undo "
1022 << "(suspend count=" << self->GetSuspendCount() << ", "
1023 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001024 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001025 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001026 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001027 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001028
Sebastien Hertz1558b572015-02-25 15:05:59 +01001029 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001030 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001031}
1032
Sebastien Hertz253fa552014-10-14 17:27:15 +02001033void ThreadList::ResumeAllForDebugger() {
1034 Thread* self = Thread::Current();
1035 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001036
1037 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1038
1039 // Threads can't resume if we exclusively hold the mutator lock.
1040 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1041
1042 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001043 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001044 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001045 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001046 // Update global suspend all state for attaching threads.
1047 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001048 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001049 --suspend_all_count_;
1050 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001051 } else {
1052 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001053 // suspend them all before. That may happen if a debugger tries
1054 // to resume some suspended threads (with suspend count == 1)
1055 // at once with a VirtualMachine.Resume command. Let's print a
1056 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001057 LOG(WARNING) << "Debugger attempted to resume all threads without "
1058 << "having suspended them all before.";
1059 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001060 // Decrement everybody's suspend count (except our own).
1061 for (const auto& thread : list_) {
1062 if (thread == self || thread == debug_thread) {
1063 continue;
1064 }
1065 if (thread->GetDebugSuspendCount() == 0) {
1066 // This thread may have been individually resumed with ThreadReference.Resume.
1067 continue;
1068 }
1069 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001070 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001071 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001072 }
1073 }
1074
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001075 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001076 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1077 Thread::resume_cond_->Broadcast(self);
1078 }
1079
1080 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1081}
1082
Elliott Hughes234ab152011-10-26 14:02:26 -07001083void ThreadList::UndoDebuggerSuspensions() {
1084 Thread* self = Thread::Current();
1085
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001086 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001087
1088 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001089 MutexLock mu(self, *Locks::thread_list_lock_);
1090 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001091 // Update global suspend all state for attaching threads.
1092 suspend_all_count_ -= debug_suspend_all_count_;
1093 debug_suspend_all_count_ = 0;
1094 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001095 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001096 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001097 continue;
1098 }
Yu Lieac44242015-06-29 10:50:03 +08001099 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001100 }
1101 }
1102
1103 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001104 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001105 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001106 }
1107
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001108 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001109}
1110
Elliott Hughese52e49b2012-04-02 16:05:44 -07001111void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001112 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001113 Thread* self = Thread::Current();
1114 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001115 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001116 {
1117 // No more threads can be born after we start to shutdown.
1118 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001119 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001120 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1121 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001122 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001123 // Also wait for any threads that are unregistering to finish. This is required so that no
1124 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1125 // threads since they could unregister at the wrong time.
1126 bool done = unregistering_count_ == 0;
1127 if (done) {
1128 for (const auto& thread : list_) {
1129 if (thread != self && !thread->IsDaemon()) {
1130 done = false;
1131 break;
1132 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001133 }
1134 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001135 if (done) {
1136 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001137 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001138 // Wait for another thread to exit before re-checking.
1139 Locks::thread_exit_cond_->Wait(self);
1140 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001141}
1142
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001143void ThreadList::SuspendAllDaemonThreadsForShutdown() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001144 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001145 Thread* self = Thread::Current();
Mathieu Chartier62597d12016-01-11 10:19:06 -08001146 size_t daemons_left = 0;
Nicolas Geoffrayaa45daa2016-06-20 15:58:32 +01001147 {
1148 // Tell all the daemons it's time to suspend.
1149 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers81d425b2012-09-27 16:03:43 -07001150 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001151 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001152 // This is only run after all non-daemon threads have exited, so the remainder should all be
1153 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001154 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001155 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001156 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier62597d12016-01-11 10:19:06 -08001157 ++daemons_left;
Elliott Hughese52e49b2012-04-02 16:05:44 -07001158 }
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001159 // We are shutting down the runtime, set the JNI functions of all the JNIEnvs to be
1160 // the sleep forever one.
1161 thread->GetJniEnv()->SetFunctionsToRuntimeShutdownFunctions();
Elliott Hughes038a8062011-09-18 14:12:41 -07001162 }
1163 }
Mathieu Chartier62597d12016-01-11 10:19:06 -08001164 // If we have any daemons left, wait 200ms to ensure they are not stuck in a place where they
1165 // are about to access runtime state and are not in a runnable state. Examples: Monitor code
1166 // or waking up from a condition variable. TODO: Try and see if there is a better way to wait
1167 // for daemon threads to be in a blocked state.
1168 if (daemons_left > 0) {
1169 static constexpr size_t kDaemonSleepTime = 200 * 1000;
1170 usleep(kDaemonSleepTime);
1171 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001172 // Give the threads a chance to suspend, complaining if they're slow.
1173 bool have_complained = false;
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001174 static constexpr size_t kTimeoutMicroseconds = 2000 * 1000;
1175 static constexpr size_t kSleepMicroseconds = 1000;
1176 for (size_t i = 0; i < kTimeoutMicroseconds / kSleepMicroseconds; ++i) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001177 bool all_suspended = true;
Nicolas Geoffrayaa45daa2016-06-20 15:58:32 +01001178 {
1179 MutexLock mu(self, *Locks::thread_list_lock_);
1180 for (const auto& thread : list_) {
1181 if (thread != self && thread->GetState() == kRunnable) {
1182 if (!have_complained) {
1183 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1184 have_complained = true;
1185 }
1186 all_suspended = false;
Elliott Hughes038a8062011-09-18 14:12:41 -07001187 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001188 }
1189 }
1190 if (all_suspended) {
1191 return;
1192 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001193 usleep(kSleepMicroseconds);
Elliott Hughes038a8062011-09-18 14:12:41 -07001194 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001195 LOG(WARNING) << "timed out suspending all daemon threads";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001196}
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001197
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001198void ThreadList::Register(Thread* self) {
1199 DCHECK_EQ(self, Thread::Current());
1200
1201 if (VLOG_IS_ON(threads)) {
1202 std::ostringstream oss;
1203 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001204 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001205 }
1206
1207 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1208 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001209 MutexLock mu(self, *Locks::thread_list_lock_);
1210 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001211 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001212 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1213 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1214 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001215 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001216 }
Ian Rogers2966e132014-04-02 08:34:36 -07001217 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001218 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001219 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001220 CHECK(!Contains(self));
1221 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001222 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001223 // Initialize according to the state of the CC collector.
1224 bool is_gc_marking =
1225 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1226 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001227 bool weak_ref_access_enabled =
1228 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1229 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1230 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001231}
1232
1233void ThreadList::Unregister(Thread* self) {
1234 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001235 CHECK_NE(self->GetState(), kRunnable);
1236 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001237
1238 VLOG(threads) << "ThreadList::Unregister() " << *self;
1239
Mathieu Chartier91e56692015-03-03 13:51:04 -08001240 {
1241 MutexLock mu(self, *Locks::thread_list_lock_);
1242 ++unregistering_count_;
1243 }
1244
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001245 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001246 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1247 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1248 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1249 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001250 self->Destroy();
1251
Jeff Haoe094b872014-10-14 13:12:01 -07001252 // If tracing, remember thread id and name before thread exits.
1253 Trace::StoreExitingThreadInfo(self);
1254
Ian Rogersdd7624d2014-03-14 17:43:00 -07001255 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001256 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001257 // Remove and delete the Thread* while holding the thread_list_lock_ and
1258 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001259 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001260 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001261 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001262 std::string thread_name;
1263 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001264 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001265 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001266 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001267 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001268 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001269 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001270 if (!self->IsSuspended()) {
1271 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001272 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001273 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001274 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001275 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001276 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001277 delete self;
1278
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001279 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1280 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1281 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1282 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001283
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001284 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1285 // (It may wish to reattach later.)
Bilyan Borisovbb661c02016-04-04 16:27:32 +01001286#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001287 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1288#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001289 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001290#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001291
1292 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001293 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1294 --unregistering_count_;
1295 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001296}
1297
1298void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001299 for (const auto& thread : list_) {
1300 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001301 }
1302}
1303
Mathieu Chartierf8a86b92016-06-14 17:08:47 -07001304void ThreadList::VisitRootsForSuspendedThreads(RootVisitor* visitor) {
1305 Thread* const self = Thread::Current();
1306 std::vector<Thread*> threads_to_visit;
1307
1308 // Tell threads to suspend and copy them into list.
1309 {
1310 MutexLock mu(self, *Locks::thread_list_lock_);
1311 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1312 for (Thread* thread : list_) {
1313 thread->ModifySuspendCount(self, +1, nullptr, false);
1314 if (thread == self || thread->IsSuspended()) {
1315 threads_to_visit.push_back(thread);
1316 } else {
1317 thread->ModifySuspendCount(self, -1, nullptr, false);
1318 }
1319 }
1320 }
1321
1322 // Visit roots without holding thread_list_lock_ and thread_suspend_count_lock_ to prevent lock
1323 // order violations.
1324 for (Thread* thread : threads_to_visit) {
1325 thread->VisitRoots(visitor);
1326 }
1327
1328 // Restore suspend counts.
1329 {
1330 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1331 for (Thread* thread : threads_to_visit) {
1332 thread->ModifySuspendCount(self, -1, nullptr, false);
1333 }
1334 }
1335}
1336
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001337void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001338 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001339 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001340 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001341 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001342}
1343
Ian Rogerscfaa4552012-11-26 21:00:08 -08001344uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001345 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001346 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1347 if (!allocated_ids_[i]) {
1348 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001349 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001350 }
1351 }
1352 LOG(FATAL) << "Out of internal thread ids";
1353 return 0;
1354}
1355
Ian Rogerscfaa4552012-11-26 21:00:08 -08001356void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001357 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001358 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001359 DCHECK(allocated_ids_[id]) << id;
1360 allocated_ids_.reset(id);
1361}
1362
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001363ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1364 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1365}
1366
1367ScopedSuspendAll::~ScopedSuspendAll() {
1368 Runtime::Current()->GetThreadList()->ResumeAll();
1369}
1370
Elliott Hughes8daa0922011-09-11 13:46:25 -07001371} // namespace art