blob: ae18819e90c468579c9bb35a8b963fda01caf46c [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
Mathieu Chartier6f365cc2014-04-23 12:42:27 -070019#define ATRACE_TAG ATRACE_TAG_DALVIK
20
Christopher Ferris6cff48f2014-01-26 21:36:13 -080021#include <backtrace/BacktraceMap.h>
Mathieu Chartier6f365cc2014-04-23 12:42:27 -070022#include <cutils/trace.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070023#include <dirent.h>
Ian Rogersd9c4fc92013-10-01 19:45:43 -070024#include <ScopedLocalRef.h>
25#include <ScopedUtfChars.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070026#include <sys/types.h>
Elliott Hughes038a8062011-09-18 14:12:41 -070027#include <unistd.h>
28
Ian Rogersc7dd2952014-10-21 23:31:19 -070029#include <sstream>
30
Mathieu Chartier70a596d2014-12-17 14:56:47 -080031#include "base/histogram-inl.h"
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -070032#include "base/mutex-inl.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010033#include "base/time_utils.h"
Sameer Abu Asala8439542013-02-14 16:06:42 -080034#include "base/timing_logger.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070035#include "debugger.h"
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -070036#include "gc/collector/concurrent_copying.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070037#include "jni_internal.h"
38#include "lock_word.h"
39#include "monitor.h"
40#include "scoped_thread_state_change.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080041#include "thread.h"
Jeff Haoe094b872014-10-14 13:12:01 -070042#include "trace.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070043#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070044
Yu Lieac44242015-06-29 10:50:03 +080045#if ART_USE_FUTEXES
46#include "linux/futex.h"
47#include "sys/syscall.h"
48#ifndef SYS_futex
49#define SYS_futex __NR_futex
50#endif
51#endif // ART_USE_FUTEXES
52
Elliott Hughes8daa0922011-09-11 13:46:25 -070053namespace art {
54
Mathieu Chartier251755c2014-07-15 18:10:25 -070055static constexpr uint64_t kLongThreadSuspendThreshold = MsToNs(5);
Mathieu Chartier99143862015-02-03 14:26:46 -080056static constexpr uint64_t kThreadSuspendTimeoutMs = 30 * 1000; // 30s.
57// Use 0 since we want to yield to prevent blocking for an unpredictable amount of time.
58static constexpr useconds_t kThreadSuspendInitialSleepUs = 0;
59static constexpr useconds_t kThreadSuspendMaxYieldUs = 3000;
60static constexpr useconds_t kThreadSuspendMaxSleepUs = 5000;
Mathieu Chartier251755c2014-07-15 18:10:25 -070061
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080062ThreadList::ThreadList()
Mathieu Chartierb56200b2015-10-29 10:41:51 -070063 : suspend_all_count_(0),
64 debug_suspend_all_count_(0),
65 unregistering_count_(0),
66 suspend_all_historam_("suspend all histogram", 16, 64),
67 long_suspend_(false) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -080068 CHECK(Monitor::IsValidLockWord(LockWord::FromThinLockId(kMaxThreadId, 1, 0U)));
Elliott Hughes8daa0922011-09-11 13:46:25 -070069}
70
71ThreadList::~ThreadList() {
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080072 ATRACE_BEGIN(__FUNCTION__);
Elliott Hughese52e49b2012-04-02 16:05:44 -070073 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070074 // We need to detach the current thread here in case there's another thread waiting to join with
75 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070076 bool contains = false;
77 {
78 Thread* self = Thread::Current();
79 MutexLock mu(self, *Locks::thread_list_lock_);
80 contains = Contains(self);
81 }
82 if (contains) {
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080083 ATRACE_BEGIN("DetachCurrentThread");
Elliott Hughes8daa0922011-09-11 13:46:25 -070084 Runtime::Current()->DetachCurrentThread();
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080085 ATRACE_END();
Elliott Hughes8daa0922011-09-11 13:46:25 -070086 }
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080087 ATRACE_BEGIN("WaitForOtherNonDaemonThreadsToExit");
Elliott Hughes6a144332012-04-03 13:07:11 -070088 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080089 ATRACE_END();
Mathieu Chartier51168372015-08-12 16:40:32 -070090 // Disable GC and wait for GC to complete in case there are still daemon threads doing
91 // allocations.
92 gc::Heap* const heap = Runtime::Current()->GetHeap();
93 heap->DisableGCForShutdown();
94 // In case a GC is in progress, wait for it to finish.
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080095 ATRACE_BEGIN("WaitForGcToComplete");
Mathieu Chartier51168372015-08-12 16:40:32 -070096 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -080097 ATRACE_END();
Ian Rogers00f7d0e2012-07-19 15:28:27 -070098 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
99 // Thread::Init.
Mathieu Chartier4d87df62016-01-07 15:14:19 -0800100 ATRACE_BEGIN("SuspendAllDaemonThreadsForShutdown");
101 SuspendAllDaemonThreadsForShutdown();
Mathieu Chartierfb6db4c2016-01-06 17:23:25 -0800102 ATRACE_END();
103 ATRACE_END();
Elliott Hughes8daa0922011-09-11 13:46:25 -0700104}
105
106bool ThreadList::Contains(Thread* thread) {
107 return find(list_.begin(), list_.end(), thread) != list_.end();
108}
109
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700110bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -0700111 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700112 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700113 return true;
114 }
115 }
116 return false;
117}
118
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700119pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700120 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700121}
122
Mathieu Chartier590fee92013-09-13 13:46:47 -0700123void ThreadList::DumpNativeStacks(std::ostream& os) {
124 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800125 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700126 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700127 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800128 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700129 os << "\n";
130 }
131}
132
Elliott Hughesc967f782012-04-16 10:23:15 -0700133void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800134 {
135 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800136 // Only print if we have samples.
137 if (suspend_all_historam_.SampleSize() > 0) {
138 Histogram<uint64_t>::CumulativeData data;
139 suspend_all_historam_.CreateHistogram(&data);
140 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
141 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800142 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700143 Dump(os);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700144 DumpUnattachedThreads(os);
145}
146
Ian Rogerscfaa4552012-11-26 21:00:08 -0800147static void DumpUnattachedThread(std::ostream& os, pid_t tid) NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700148 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800149 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700150 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700151 DumpKernelStack(os, tid, " kernel: ", false);
Brian Carlstromed8b7232012-06-27 17:54:47 -0700152 // TODO: Reenable this when the native code in system_server can handle it.
153 // Currently "adb shell kill -3 `pid system_server`" will cause it to exit.
154 if (false) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800155 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700156 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700157 os << "\n";
158}
159
160void ThreadList::DumpUnattachedThreads(std::ostream& os) {
161 DIR* d = opendir("/proc/self/task");
162 if (!d) {
163 return;
164 }
165
Ian Rogers50b35e22012-10-04 10:09:15 -0700166 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700167 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700168 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700169 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700170 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700171 if (!*end) {
172 bool contains;
173 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700174 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700175 contains = Contains(tid);
176 }
177 if (!contains) {
178 DumpUnattachedThread(os, tid);
179 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700180 }
181 }
182 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800183}
184
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800185// Dump checkpoint timeout in milliseconds. Larger amount on the host, as dumping will invoke
186// addr2line when available.
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800187static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 10000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800188
Ian Rogers7b078e82014-09-10 14:44:24 -0700189// A closure used by Thread::Dump.
190class DumpCheckpoint FINAL : public Closure {
191 public:
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800192 explicit DumpCheckpoint(std::ostream* os)
193 : os_(os), barrier_(0), backtrace_map_(BacktraceMap::Create(GetTid())) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700194
195 void Run(Thread* thread) OVERRIDE {
196 // Note thread and self may not be equal if thread was already suspended at the point of the
197 // request.
198 Thread* self = Thread::Current();
199 std::ostringstream local_os;
200 {
201 ScopedObjectAccess soa(self);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800202 thread->Dump(local_os, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700203 }
204 local_os << "\n";
205 {
206 // Use the logging lock to ensure serialization when writing to the common ostream.
207 MutexLock mu(self, *Locks::logging_lock_);
208 *os_ << local_os.str();
209 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700210 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700211 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700212
213 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
214 Thread* self = Thread::Current();
215 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800216 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700217 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000218 // Avoid a recursive abort.
219 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
220 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700221 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700222 }
223
224 private:
225 // The common stream that will accumulate all the dumps.
226 std::ostream* const os_;
227 // The barrier to be passed through and for the requestor to wait upon.
228 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800229 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
230 std::unique_ptr<BacktraceMap> backtrace_map_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700231};
232
233void ThreadList::Dump(std::ostream& os) {
234 {
235 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
236 os << "DALVIK THREADS (" << list_.size() << "):\n";
237 }
238 DumpCheckpoint checkpoint(&os);
239 size_t threads_running_checkpoint = RunCheckpoint(&checkpoint);
Lei Lidd9943d2015-02-02 14:24:44 +0800240 if (threads_running_checkpoint != 0) {
241 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
242 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700243}
244
Ian Rogers50b35e22012-10-04 10:09:15 -0700245void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
246 MutexLock mu(self, *Locks::thread_list_lock_);
247 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700248 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800249 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700250 CHECK(thread->IsSuspended())
251 << "\nUnsuspended thread: <<" << *thread << "\n"
252 << "self: <<" << *Thread::Current();
253 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700254 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700255}
256
Ian Rogers66aee5c2012-08-15 17:17:47 -0700257#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700258// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800259NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700260 Runtime* runtime = Runtime::Current();
261 std::ostringstream ss;
262 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700263 Locks::mutator_lock_->Dump(ss);
264 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700265 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700266 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800267 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700268}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700269#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700270
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800271// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800272// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
273// we use sched_yield instead of calling usleep.
274static void ThreadSuspendSleep(useconds_t delay_us) {
275 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800276 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800277 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800278 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800279 }
280}
281
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700282size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700283 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800284 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
285 Locks::thread_list_lock_->AssertNotHeld(self);
286 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700287
288 std::vector<Thread*> suspended_count_modified_threads;
289 size_t count = 0;
290 {
291 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
292 // manually called.
293 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700294 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700295 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700296 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700297 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700298 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700299 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800300 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700301 break;
302 } else {
303 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700304 // The thread switched back to runnable.
305 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700306 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700307 continue;
308 }
Yu Lieac44242015-06-29 10:50:03 +0800309 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700310 suspended_count_modified_threads.push_back(thread);
311 break;
312 }
313 }
314 }
315 }
316 }
317
318 // Run the checkpoint on ourself while we wait for threads to suspend.
319 checkpoint_function->Run(self);
320
321 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700322 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700323 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800324 if (ATRACE_ENABLED()) {
325 std::ostringstream oss;
326 thread->ShortDump(oss);
327 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
328 }
329 // Busy wait until the thread is suspended.
330 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700331 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800332 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700333 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800334 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800335 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800336 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
337 ATRACE_END();
338 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
339 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
340 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700341 }
342 }
343 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700344 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700345 {
346 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800347 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700348 }
349 }
350
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800351 {
352 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
353 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
354 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
355 Thread::resume_cond_->Broadcast(self);
356 }
357
Lei Lidd9943d2015-02-02 14:24:44 +0800358 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700359}
360
Dave Allison39c3bfb2014-01-28 18:33:52 -0800361// Request that a checkpoint function be run on all active (non-suspended)
362// threads. Returns the number of successful requests.
363size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
364 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700365 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
366 Locks::thread_list_lock_->AssertNotHeld(self);
367 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
368 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800369
370 size_t count = 0;
371 {
372 // Call a checkpoint function for each non-suspended thread.
373 MutexLock mu(self, *Locks::thread_list_lock_);
374 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
375 for (const auto& thread : list_) {
376 if (thread != self) {
377 if (thread->RequestCheckpoint(checkpoint_function)) {
378 // This thread will run its checkpoint some time in the near future.
379 count++;
380 }
381 }
382 }
383 }
384
385 // Return the number of threads that will run the checkpoint function.
386 return count;
387}
388
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800389// A checkpoint/suspend-all hybrid to switch thread roots from
390// from-space to to-space refs. Used to synchronize threads at a point
391// to mark the initiation of marking while maintaining the to-space
392// invariant.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700393size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor,
394 Closure* flip_callback,
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800395 gc::collector::GarbageCollector* collector) {
396 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
397 const uint64_t start_time = NanoTime();
398 Thread* self = Thread::Current();
399 Locks::mutator_lock_->AssertNotHeld(self);
400 Locks::thread_list_lock_->AssertNotHeld(self);
401 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
402 CHECK_NE(self->GetState(), kRunnable);
403
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700404 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800405
406 // Run the flip callback for the collector.
407 Locks::mutator_lock_->ExclusiveLock(self);
408 flip_callback->Run(self);
409 Locks::mutator_lock_->ExclusiveUnlock(self);
410 collector->RegisterPause(NanoTime() - start_time);
411
412 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700413 std::vector<Thread*> runnable_threads;
414 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800415 {
416 MutexLock mu(self, *Locks::thread_list_lock_);
417 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
418 --suspend_all_count_;
419 for (const auto& thread : list_) {
420 if (thread == self) {
421 continue;
422 }
423 // Set the flip function for both runnable and suspended threads
424 // because Thread::DumpState/DumpJavaStack() (invoked by a
425 // checkpoint) may cause the flip function to be run for a
426 // runnable/suspended thread before a runnable threads runs it
427 // for itself or we run it for a suspended thread below.
428 thread->SetFlipFunction(thread_flip_visitor);
429 if (thread->IsSuspendedAtSuspendCheck()) {
430 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800431 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800432 runnable_threads.push_back(thread);
433 } else {
434 other_threads.push_back(thread);
435 }
436 }
437 Thread::resume_cond_->Broadcast(self);
438 }
439
440 // Run the closure on the other threads and let them resume.
441 {
442 ReaderMutexLock mu(self, *Locks::mutator_lock_);
443 for (const auto& thread : other_threads) {
444 Closure* flip_func = thread->GetFlipFunction();
445 if (flip_func != nullptr) {
446 flip_func->Run(thread);
447 }
448 }
449 // Run it for self.
450 thread_flip_visitor->Run(self);
451 }
452
453 // Resume other threads.
454 {
455 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
456 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800457 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800458 }
459 Thread::resume_cond_->Broadcast(self);
460 }
461
462 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
463}
464
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700465void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700466 Thread* self = Thread::Current();
467
Jeff Haoc5d824a2014-07-28 18:35:38 -0700468 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700469 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700470 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700471 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700472 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700473 ATRACE_BEGIN("Suspending mutator threads");
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800474 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700475
Yu Lieac44242015-06-29 10:50:03 +0800476 SuspendAllInternal(self, self);
477 // All threads are known to have suspended (but a thread may still own the mutator lock)
478 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700479#if HAVE_TIMED_RWLOCK
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700480 while (true) {
481 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
482 break;
483 } else if (!long_suspend_) {
484 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
485 // could result in a thread suspend timeout.
486 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
487 UnsafeLogFatalForThreadSuspendAllTimeout();
488 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700489 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700490#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700491 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700492#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700493
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700494 long_suspend_ = long_suspend;
495
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800496 const uint64_t end_time = NanoTime();
497 const uint64_t suspend_time = end_time - start_time;
498 suspend_all_historam_.AdjustAndAddValue(suspend_time);
499 if (suspend_time > kLongThreadSuspendThreshold) {
500 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
Mathieu Chartier251755c2014-07-15 18:10:25 -0700501 }
502
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800503 if (kDebugLocking) {
504 // Debug check that all threads are suspended.
505 AssertThreadsAreSuspended(self, self);
506 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700507
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700508 ATRACE_END();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700509 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700510
Jeff Haoc5d824a2014-07-28 18:35:38 -0700511 if (self != nullptr) {
512 VLOG(threads) << *self << " SuspendAll complete";
513 } else {
514 VLOG(threads) << "Thread[null] SuspendAll complete";
515 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700516}
517
Yu Lieac44242015-06-29 10:50:03 +0800518// Ensures all threads running Java suspend and that those not running Java don't start.
519// Debugger thread might be set to kRunnable for a short period of time after the
520// SuspendAllInternal. This is safe because it will be set back to suspended state before
521// the SuspendAll returns.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700522void ThreadList::SuspendAllInternal(Thread* self,
523 Thread* ignore1,
524 Thread* ignore2,
Yu Lieac44242015-06-29 10:50:03 +0800525 bool debug_suspend) {
526 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
527 Locks::thread_list_lock_->AssertNotHeld(self);
528 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
529 if (kDebugLocking && self != nullptr) {
530 CHECK_NE(self->GetState(), kRunnable);
531 }
532
533 // First request that all threads suspend, then wait for them to suspend before
534 // returning. This suspension scheme also relies on other behaviour:
535 // 1. Threads cannot be deleted while they are suspended or have a suspend-
536 // request flag set - (see Unregister() below).
537 // 2. When threads are created, they are created in a suspended state (actually
538 // kNative) and will never begin executing Java code without first checking
539 // the suspend-request flag.
540
541 // The atomic counter for number of threads that need to pass the barrier.
542 AtomicInteger pending_threads;
543 uint32_t num_ignored = 0;
544 if (ignore1 != nullptr) {
545 ++num_ignored;
546 }
547 if (ignore2 != nullptr && ignore1 != ignore2) {
548 ++num_ignored;
549 }
550 {
551 MutexLock mu(self, *Locks::thread_list_lock_);
552 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
553 // Update global suspend all state for attaching threads.
554 ++suspend_all_count_;
555 if (debug_suspend)
556 ++debug_suspend_all_count_;
557 pending_threads.StoreRelaxed(list_.size() - num_ignored);
558 // Increment everybody's suspend count (except those that should be ignored).
559 for (const auto& thread : list_) {
560 if (thread == ignore1 || thread == ignore2) {
561 continue;
562 }
563 VLOG(threads) << "requesting thread suspend: " << *thread;
564 while (true) {
565 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
566 break;
567 } else {
568 // Failure means the list of active_suspend_barriers is full, we should release the
569 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
570 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
571 // the thread to change to a suspended state, because it might need to run checkpoint
572 // function before the state change, which also needs thread_suspend_count_lock_.
573
574 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
575 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
576 // in the mean time.
577 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
578 NanoSleep(100000);
579 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
580 }
581 }
582
583 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
584 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
585 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
586 if (thread->IsSuspended()) {
587 // Only clear the counter for the current thread.
588 thread->ClearSuspendBarrier(&pending_threads);
589 pending_threads.FetchAndSubSequentiallyConsistent(1);
590 }
591 }
592 }
593
594 // Wait for the barrier to be passed by all runnable threads. This wait
595 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700596#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800597 timespec wait_timeout;
598 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700599#endif
Yu Lieac44242015-06-29 10:50:03 +0800600 while (true) {
601 int32_t cur_val = pending_threads.LoadRelaxed();
602 if (LIKELY(cur_val > 0)) {
603#if ART_USE_FUTEXES
604 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
605 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
606 if ((errno != EAGAIN) && (errno != EINTR)) {
607 if (errno == ETIMEDOUT) {
608 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
609 } else {
610 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
611 }
612 }
613 } else {
614 cur_val = pending_threads.LoadRelaxed();
615 CHECK_EQ(cur_val, 0);
616 break;
617 }
618#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();
638 ATRACE_BEGIN("Resuming mutator threads");
639
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 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700670 ATRACE_END();
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
928Thread* ThreadList::FindThreadByThreadId(uint32_t thin_lock_id) {
929 Thread* self = Thread::Current();
930 MutexLock mu(self, *Locks::thread_list_lock_);
931 for (const auto& thread : list_) {
932 if (thread->GetThreadId() == thin_lock_id) {
933 CHECK(thread == self || thread->IsSuspended());
934 return thread;
935 }
936 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700937 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700938}
939
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700940void ThreadList::SuspendAllForDebugger() {
941 Thread* self = Thread::Current();
942 Thread* debug_thread = Dbg::GetDebugThread();
943
944 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
945
Yu Lieac44242015-06-29 10:50:03 +0800946 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700947 // Block on the mutator lock until all Runnable threads release their share of access then
948 // immediately unlock again.
949#if HAVE_TIMED_RWLOCK
950 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700951 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100952 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700953 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700954 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700955 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700956#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700957 Locks::mutator_lock_->ExclusiveLock(self);
958 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700959#endif
Mathieu Chartier9450c6c2015-11-07 11:55:23 -0800960 // Disabled for the following race condition:
961 // Thread 1 calls SuspendAllForDebugger, gets preempted after pulsing the mutator lock.
962 // Thread 2 calls SuspendAll and SetStateUnsafe (perhaps from Dbg::Disconnected).
963 // Thread 1 fails assertion that all threads are suspended due to thread 2 being in a runnable
964 // state (from SetStateUnsafe).
965 // AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700966
Sebastien Hertzed2be172014-08-19 15:33:43 +0200967 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700968}
969
Elliott Hughes475fc232011-10-25 15:00:35 -0700970void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100971 Thread* const self = Thread::Current();
972 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700973
Elliott Hughes475fc232011-10-25 15:00:35 -0700974 // The debugger thread must not suspend itself due to debugger activity!
975 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700976 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800977 CHECK_NE(self->GetState(), kRunnable);
978 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700979
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200980 // The debugger may have detached while we were executing an invoke request. In that case, we
981 // must not suspend ourself.
982 DebugInvokeReq* pReq = self->GetInvokeReq();
983 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
984 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800985 // Collisions with other suspends aren't really interesting. We want
986 // to ensure that we're the only one fiddling with the suspend count
987 // though.
988 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800989 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700990 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200991
992 VLOG(threads) << *self << " self-suspending (debugger)";
993 } else {
994 // We must no longer be subject to debugger suspension.
995 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
996 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
997
998 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800999 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001000
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001001 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +01001002 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001003 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +01001004 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001005 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +01001006 }
1007
Elliott Hughes475fc232011-10-25 15:00:35 -07001008 // Tell JDWP that we've completed suspension. The JDWP thread can't
1009 // tell us to resume before we're fully asleep because we hold the
1010 // suspend count lock.
1011 Dbg::ClearWaitForEventThread();
1012
jeffhaoa77f0f62012-12-05 17:19:31 -08001013 {
1014 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001015 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001016 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001017 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001018 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +02001019 // can happen when we suspend then resume all threads to
1020 // update instrumentation or compute monitor info. This can
1021 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001022 // dump event is pending (assuming SignalCatcher was resumed for
1023 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001024 VLOG(jdwp) << *self << " still suspended after undo "
1025 << "(suspend count=" << self->GetSuspendCount() << ", "
1026 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001027 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001028 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001029 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001030 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001031
Sebastien Hertz1558b572015-02-25 15:05:59 +01001032 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001033 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001034}
1035
Sebastien Hertz253fa552014-10-14 17:27:15 +02001036void ThreadList::ResumeAllForDebugger() {
1037 Thread* self = Thread::Current();
1038 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001039
1040 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1041
1042 // Threads can't resume if we exclusively hold the mutator lock.
1043 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1044
1045 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001046 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001047 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001048 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001049 // Update global suspend all state for attaching threads.
1050 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001051 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001052 --suspend_all_count_;
1053 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001054 } else {
1055 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001056 // suspend them all before. That may happen if a debugger tries
1057 // to resume some suspended threads (with suspend count == 1)
1058 // at once with a VirtualMachine.Resume command. Let's print a
1059 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001060 LOG(WARNING) << "Debugger attempted to resume all threads without "
1061 << "having suspended them all before.";
1062 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001063 // Decrement everybody's suspend count (except our own).
1064 for (const auto& thread : list_) {
1065 if (thread == self || thread == debug_thread) {
1066 continue;
1067 }
1068 if (thread->GetDebugSuspendCount() == 0) {
1069 // This thread may have been individually resumed with ThreadReference.Resume.
1070 continue;
1071 }
1072 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001073 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001074 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001075 }
1076 }
1077
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001078 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001079 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1080 Thread::resume_cond_->Broadcast(self);
1081 }
1082
1083 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1084}
1085
Elliott Hughes234ab152011-10-26 14:02:26 -07001086void ThreadList::UndoDebuggerSuspensions() {
1087 Thread* self = Thread::Current();
1088
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001089 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001090
1091 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001092 MutexLock mu(self, *Locks::thread_list_lock_);
1093 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001094 // Update global suspend all state for attaching threads.
1095 suspend_all_count_ -= debug_suspend_all_count_;
1096 debug_suspend_all_count_ = 0;
1097 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001098 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001099 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001100 continue;
1101 }
Yu Lieac44242015-06-29 10:50:03 +08001102 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001103 }
1104 }
1105
1106 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001107 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001108 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001109 }
1110
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001111 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001112}
1113
Elliott Hughese52e49b2012-04-02 16:05:44 -07001114void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001115 Thread* self = Thread::Current();
1116 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001117 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001118 {
1119 // No more threads can be born after we start to shutdown.
1120 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001121 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001122 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1123 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001124 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001125 // Also wait for any threads that are unregistering to finish. This is required so that no
1126 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1127 // threads since they could unregister at the wrong time.
1128 bool done = unregistering_count_ == 0;
1129 if (done) {
1130 for (const auto& thread : list_) {
1131 if (thread != self && !thread->IsDaemon()) {
1132 done = false;
1133 break;
1134 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001135 }
1136 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001137 if (done) {
1138 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001139 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001140 // Wait for another thread to exit before re-checking.
1141 Locks::thread_exit_cond_->Wait(self);
1142 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001143}
1144
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001145void ThreadList::SuspendAllDaemonThreadsForShutdown() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001146 Thread* self = Thread::Current();
1147 MutexLock mu(self, *Locks::thread_list_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001148 { // Tell all the daemons it's time to suspend.
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);
Elliott Hughese52e49b2012-04-02 16:05:44 -07001156 }
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001157 // We are shutting down the runtime, set the JNI functions of all the JNIEnvs to be
1158 // the sleep forever one.
1159 thread->GetJniEnv()->SetFunctionsToRuntimeShutdownFunctions();
Elliott Hughes038a8062011-09-18 14:12:41 -07001160 }
1161 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001162 // Give the threads a chance to suspend, complaining if they're slow.
1163 bool have_complained = false;
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001164 static constexpr size_t kTimeoutMicroseconds = 2000 * 1000;
1165 static constexpr size_t kSleepMicroseconds = 1000;
1166 for (size_t i = 0; i < kTimeoutMicroseconds / kSleepMicroseconds; ++i) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001167 bool all_suspended = true;
Mathieu Chartier02e25112013-08-14 16:14:24 -07001168 for (const auto& thread : list_) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001169 if (thread != self && thread->GetState() == kRunnable) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001170 if (!have_complained) {
1171 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1172 have_complained = true;
1173 }
1174 all_suspended = false;
1175 }
1176 }
1177 if (all_suspended) {
1178 return;
1179 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001180 usleep(kSleepMicroseconds);
Elliott Hughes038a8062011-09-18 14:12:41 -07001181 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001182 LOG(WARNING) << "timed out suspending all daemon threads";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001183}
1184void ThreadList::Register(Thread* self) {
1185 DCHECK_EQ(self, Thread::Current());
1186
1187 if (VLOG_IS_ON(threads)) {
1188 std::ostringstream oss;
1189 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001190 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001191 }
1192
1193 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1194 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001195 MutexLock mu(self, *Locks::thread_list_lock_);
1196 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001197 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001198 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1199 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1200 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001201 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001202 }
Ian Rogers2966e132014-04-02 08:34:36 -07001203 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001204 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001205 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001206 CHECK(!Contains(self));
1207 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001208 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001209 // Initialize according to the state of the CC collector.
1210 bool is_gc_marking =
1211 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1212 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001213 bool weak_ref_access_enabled =
1214 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1215 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1216 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001217}
1218
1219void ThreadList::Unregister(Thread* self) {
1220 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001221 CHECK_NE(self->GetState(), kRunnable);
1222 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001223
1224 VLOG(threads) << "ThreadList::Unregister() " << *self;
1225
Mathieu Chartier91e56692015-03-03 13:51:04 -08001226 {
1227 MutexLock mu(self, *Locks::thread_list_lock_);
1228 ++unregistering_count_;
1229 }
1230
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001231 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001232 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1233 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1234 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1235 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001236 self->Destroy();
1237
Jeff Haoe094b872014-10-14 13:12:01 -07001238 // If tracing, remember thread id and name before thread exits.
1239 Trace::StoreExitingThreadInfo(self);
1240
Ian Rogersdd7624d2014-03-14 17:43:00 -07001241 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001242 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001243 // Remove and delete the Thread* while holding the thread_list_lock_ and
1244 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001245 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001246 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001247 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001248 std::string thread_name;
1249 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001250 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001251 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001252 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001253 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001254 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001255 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001256 if (!self->IsSuspended()) {
1257 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001258 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001259 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001260 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001261 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001262 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001263 delete self;
1264
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001265 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1266 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1267 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1268 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001269
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001270 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1271 // (It may wish to reattach later.)
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001272#ifdef __ANDROID__
1273 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1274#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001275 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001276#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001277
1278 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001279 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1280 --unregistering_count_;
1281 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001282}
1283
1284void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001285 for (const auto& thread : list_) {
1286 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001287 }
1288}
1289
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001290void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001291 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001292 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001293 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001294 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001295}
1296
Ian Rogerscfaa4552012-11-26 21:00:08 -08001297uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001298 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001299 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1300 if (!allocated_ids_[i]) {
1301 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001302 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001303 }
1304 }
1305 LOG(FATAL) << "Out of internal thread ids";
1306 return 0;
1307}
1308
Ian Rogerscfaa4552012-11-26 21:00:08 -08001309void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001310 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001311 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001312 DCHECK(allocated_ids_[id]) << id;
1313 allocated_ids_.reset(id);
1314}
1315
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001316ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1317 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1318}
1319
1320ScopedSuspendAll::~ScopedSuspendAll() {
1321 Runtime::Current()->GetThreadList()->ResumeAll();
1322}
1323
Elliott Hughes8daa0922011-09-11 13:46:25 -07001324} // namespace art