blob: a390908635a93f46becdc1d9dc8d0d5d5d53a6d6 [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() {
Elliott Hughese52e49b2012-04-02 16:05:44 -070072 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070073 // We need to detach the current thread here in case there's another thread waiting to join with
74 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070075 bool contains = false;
76 {
77 Thread* self = Thread::Current();
78 MutexLock mu(self, *Locks::thread_list_lock_);
79 contains = Contains(self);
80 }
81 if (contains) {
Elliott Hughes8daa0922011-09-11 13:46:25 -070082 Runtime::Current()->DetachCurrentThread();
83 }
Elliott Hughes6a144332012-04-03 13:07:11 -070084 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartier51168372015-08-12 16:40:32 -070085 // Disable GC and wait for GC to complete in case there are still daemon threads doing
86 // allocations.
87 gc::Heap* const heap = Runtime::Current()->GetHeap();
88 heap->DisableGCForShutdown();
89 // In case a GC is in progress, wait for it to finish.
90 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
91
Ian Rogers00f7d0e2012-07-19 15:28:27 -070092 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
93 // Thread::Init.
Elliott Hughes6a144332012-04-03 13:07:11 -070094 SuspendAllDaemonThreads();
Elliott Hughes8daa0922011-09-11 13:46:25 -070095}
96
97bool ThreadList::Contains(Thread* thread) {
98 return find(list_.begin(), list_.end(), thread) != list_.end();
99}
100
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700101bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -0700102 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700103 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700104 return true;
105 }
106 }
107 return false;
108}
109
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700110pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700111 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700112}
113
Mathieu Chartier590fee92013-09-13 13:46:47 -0700114void ThreadList::DumpNativeStacks(std::ostream& os) {
115 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800116 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700117 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700118 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800119 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700120 os << "\n";
121 }
122}
123
Elliott Hughesc967f782012-04-16 10:23:15 -0700124void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800125 {
126 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800127 // Only print if we have samples.
128 if (suspend_all_historam_.SampleSize() > 0) {
129 Histogram<uint64_t>::CumulativeData data;
130 suspend_all_historam_.CreateHistogram(&data);
131 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
132 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800133 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700134 Dump(os);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700135 DumpUnattachedThreads(os);
136}
137
Ian Rogerscfaa4552012-11-26 21:00:08 -0800138static void DumpUnattachedThread(std::ostream& os, pid_t tid) NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700139 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800140 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700141 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700142 DumpKernelStack(os, tid, " kernel: ", false);
Brian Carlstromed8b7232012-06-27 17:54:47 -0700143 // TODO: Reenable this when the native code in system_server can handle it.
144 // Currently "adb shell kill -3 `pid system_server`" will cause it to exit.
145 if (false) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800146 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700147 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700148 os << "\n";
149}
150
151void ThreadList::DumpUnattachedThreads(std::ostream& os) {
152 DIR* d = opendir("/proc/self/task");
153 if (!d) {
154 return;
155 }
156
Ian Rogers50b35e22012-10-04 10:09:15 -0700157 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700158 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700159 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700160 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700161 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700162 if (!*end) {
163 bool contains;
164 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700165 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700166 contains = Contains(tid);
167 }
168 if (!contains) {
169 DumpUnattachedThread(os, tid);
170 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700171 }
172 }
173 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800174}
175
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800176// Dump checkpoint timeout in milliseconds. Larger amount on the host, as dumping will invoke
177// addr2line when available.
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800178static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 10000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800179
Ian Rogers7b078e82014-09-10 14:44:24 -0700180// A closure used by Thread::Dump.
181class DumpCheckpoint FINAL : public Closure {
182 public:
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800183 explicit DumpCheckpoint(std::ostream* os)
184 : os_(os), barrier_(0), backtrace_map_(BacktraceMap::Create(GetTid())) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700185
186 void Run(Thread* thread) OVERRIDE {
187 // Note thread and self may not be equal if thread was already suspended at the point of the
188 // request.
189 Thread* self = Thread::Current();
190 std::ostringstream local_os;
191 {
192 ScopedObjectAccess soa(self);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800193 thread->Dump(local_os, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700194 }
195 local_os << "\n";
196 {
197 // Use the logging lock to ensure serialization when writing to the common ostream.
198 MutexLock mu(self, *Locks::logging_lock_);
199 *os_ << local_os.str();
200 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700201 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700202 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700203
204 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
205 Thread* self = Thread::Current();
206 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800207 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700208 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000209 // Avoid a recursive abort.
210 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
211 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700212 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700213 }
214
215 private:
216 // The common stream that will accumulate all the dumps.
217 std::ostream* const os_;
218 // The barrier to be passed through and for the requestor to wait upon.
219 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800220 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
221 std::unique_ptr<BacktraceMap> backtrace_map_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700222};
223
224void ThreadList::Dump(std::ostream& os) {
225 {
226 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
227 os << "DALVIK THREADS (" << list_.size() << "):\n";
228 }
229 DumpCheckpoint checkpoint(&os);
230 size_t threads_running_checkpoint = RunCheckpoint(&checkpoint);
Lei Lidd9943d2015-02-02 14:24:44 +0800231 if (threads_running_checkpoint != 0) {
232 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
233 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700234}
235
Ian Rogers50b35e22012-10-04 10:09:15 -0700236void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
237 MutexLock mu(self, *Locks::thread_list_lock_);
238 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700239 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800240 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700241 CHECK(thread->IsSuspended())
242 << "\nUnsuspended thread: <<" << *thread << "\n"
243 << "self: <<" << *Thread::Current();
244 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700245 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700246}
247
Ian Rogers66aee5c2012-08-15 17:17:47 -0700248#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700249// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800250NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700251 Runtime* runtime = Runtime::Current();
252 std::ostringstream ss;
253 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700254 Locks::mutator_lock_->Dump(ss);
255 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700256 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700257 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800258 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700259}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700260#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700261
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800262// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800263// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
264// we use sched_yield instead of calling usleep.
265static void ThreadSuspendSleep(useconds_t delay_us) {
266 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800267 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800268 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800269 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800270 }
271}
272
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700273size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700274 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800275 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
276 Locks::thread_list_lock_->AssertNotHeld(self);
277 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700278
279 std::vector<Thread*> suspended_count_modified_threads;
280 size_t count = 0;
281 {
282 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
283 // manually called.
284 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700285 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700286 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700287 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700288 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700289 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700290 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800291 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700292 break;
293 } else {
294 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700295 // The thread switched back to runnable.
296 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700297 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700298 continue;
299 }
Yu Lieac44242015-06-29 10:50:03 +0800300 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700301 suspended_count_modified_threads.push_back(thread);
302 break;
303 }
304 }
305 }
306 }
307 }
308
309 // Run the checkpoint on ourself while we wait for threads to suspend.
310 checkpoint_function->Run(self);
311
312 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700313 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700314 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800315 if (ATRACE_ENABLED()) {
316 std::ostringstream oss;
317 thread->ShortDump(oss);
318 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
319 }
320 // Busy wait until the thread is suspended.
321 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700322 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800323 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700324 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800325 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800326 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800327 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
328 ATRACE_END();
329 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
330 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
331 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700332 }
333 }
334 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700335 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700336 {
337 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800338 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700339 }
340 }
341
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800342 {
343 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
344 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
345 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
346 Thread::resume_cond_->Broadcast(self);
347 }
348
Lei Lidd9943d2015-02-02 14:24:44 +0800349 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700350}
351
Dave Allison39c3bfb2014-01-28 18:33:52 -0800352// Request that a checkpoint function be run on all active (non-suspended)
353// threads. Returns the number of successful requests.
354size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
355 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700356 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
357 Locks::thread_list_lock_->AssertNotHeld(self);
358 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
359 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800360
361 size_t count = 0;
362 {
363 // Call a checkpoint function for each non-suspended thread.
364 MutexLock mu(self, *Locks::thread_list_lock_);
365 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
366 for (const auto& thread : list_) {
367 if (thread != self) {
368 if (thread->RequestCheckpoint(checkpoint_function)) {
369 // This thread will run its checkpoint some time in the near future.
370 count++;
371 }
372 }
373 }
374 }
375
376 // Return the number of threads that will run the checkpoint function.
377 return count;
378}
379
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800380// A checkpoint/suspend-all hybrid to switch thread roots from
381// from-space to to-space refs. Used to synchronize threads at a point
382// to mark the initiation of marking while maintaining the to-space
383// invariant.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700384size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor,
385 Closure* flip_callback,
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800386 gc::collector::GarbageCollector* collector) {
387 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
388 const uint64_t start_time = NanoTime();
389 Thread* self = Thread::Current();
390 Locks::mutator_lock_->AssertNotHeld(self);
391 Locks::thread_list_lock_->AssertNotHeld(self);
392 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
393 CHECK_NE(self->GetState(), kRunnable);
394
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700395 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800396
397 // Run the flip callback for the collector.
398 Locks::mutator_lock_->ExclusiveLock(self);
399 flip_callback->Run(self);
400 Locks::mutator_lock_->ExclusiveUnlock(self);
401 collector->RegisterPause(NanoTime() - start_time);
402
403 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700404 std::vector<Thread*> runnable_threads;
405 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800406 {
407 MutexLock mu(self, *Locks::thread_list_lock_);
408 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
409 --suspend_all_count_;
410 for (const auto& thread : list_) {
411 if (thread == self) {
412 continue;
413 }
414 // Set the flip function for both runnable and suspended threads
415 // because Thread::DumpState/DumpJavaStack() (invoked by a
416 // checkpoint) may cause the flip function to be run for a
417 // runnable/suspended thread before a runnable threads runs it
418 // for itself or we run it for a suspended thread below.
419 thread->SetFlipFunction(thread_flip_visitor);
420 if (thread->IsSuspendedAtSuspendCheck()) {
421 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800422 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800423 runnable_threads.push_back(thread);
424 } else {
425 other_threads.push_back(thread);
426 }
427 }
428 Thread::resume_cond_->Broadcast(self);
429 }
430
431 // Run the closure on the other threads and let them resume.
432 {
433 ReaderMutexLock mu(self, *Locks::mutator_lock_);
434 for (const auto& thread : other_threads) {
435 Closure* flip_func = thread->GetFlipFunction();
436 if (flip_func != nullptr) {
437 flip_func->Run(thread);
438 }
439 }
440 // Run it for self.
441 thread_flip_visitor->Run(self);
442 }
443
444 // Resume other threads.
445 {
446 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
447 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800448 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800449 }
450 Thread::resume_cond_->Broadcast(self);
451 }
452
453 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
454}
455
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700456void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700457 Thread* self = Thread::Current();
458
Jeff Haoc5d824a2014-07-28 18:35:38 -0700459 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700460 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700461 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700462 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700463 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700464 ATRACE_BEGIN("Suspending mutator threads");
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800465 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700466
Yu Lieac44242015-06-29 10:50:03 +0800467 SuspendAllInternal(self, self);
468 // All threads are known to have suspended (but a thread may still own the mutator lock)
469 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700470#if HAVE_TIMED_RWLOCK
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700471 while (true) {
472 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
473 break;
474 } else if (!long_suspend_) {
475 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
476 // could result in a thread suspend timeout.
477 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
478 UnsafeLogFatalForThreadSuspendAllTimeout();
479 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700480 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700481#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700482 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700483#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700484
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700485 long_suspend_ = long_suspend;
486
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800487 const uint64_t end_time = NanoTime();
488 const uint64_t suspend_time = end_time - start_time;
489 suspend_all_historam_.AdjustAndAddValue(suspend_time);
490 if (suspend_time > kLongThreadSuspendThreshold) {
491 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
Mathieu Chartier251755c2014-07-15 18:10:25 -0700492 }
493
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800494 if (kDebugLocking) {
495 // Debug check that all threads are suspended.
496 AssertThreadsAreSuspended(self, self);
497 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700498
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700499 ATRACE_END();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700500 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700501
Jeff Haoc5d824a2014-07-28 18:35:38 -0700502 if (self != nullptr) {
503 VLOG(threads) << *self << " SuspendAll complete";
504 } else {
505 VLOG(threads) << "Thread[null] SuspendAll complete";
506 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700507}
508
Yu Lieac44242015-06-29 10:50:03 +0800509// Ensures all threads running Java suspend and that those not running Java don't start.
510// Debugger thread might be set to kRunnable for a short period of time after the
511// SuspendAllInternal. This is safe because it will be set back to suspended state before
512// the SuspendAll returns.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700513void ThreadList::SuspendAllInternal(Thread* self,
514 Thread* ignore1,
515 Thread* ignore2,
Yu Lieac44242015-06-29 10:50:03 +0800516 bool debug_suspend) {
517 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
518 Locks::thread_list_lock_->AssertNotHeld(self);
519 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
520 if (kDebugLocking && self != nullptr) {
521 CHECK_NE(self->GetState(), kRunnable);
522 }
523
524 // First request that all threads suspend, then wait for them to suspend before
525 // returning. This suspension scheme also relies on other behaviour:
526 // 1. Threads cannot be deleted while they are suspended or have a suspend-
527 // request flag set - (see Unregister() below).
528 // 2. When threads are created, they are created in a suspended state (actually
529 // kNative) and will never begin executing Java code without first checking
530 // the suspend-request flag.
531
532 // The atomic counter for number of threads that need to pass the barrier.
533 AtomicInteger pending_threads;
534 uint32_t num_ignored = 0;
535 if (ignore1 != nullptr) {
536 ++num_ignored;
537 }
538 if (ignore2 != nullptr && ignore1 != ignore2) {
539 ++num_ignored;
540 }
541 {
542 MutexLock mu(self, *Locks::thread_list_lock_);
543 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
544 // Update global suspend all state for attaching threads.
545 ++suspend_all_count_;
546 if (debug_suspend)
547 ++debug_suspend_all_count_;
548 pending_threads.StoreRelaxed(list_.size() - num_ignored);
549 // Increment everybody's suspend count (except those that should be ignored).
550 for (const auto& thread : list_) {
551 if (thread == ignore1 || thread == ignore2) {
552 continue;
553 }
554 VLOG(threads) << "requesting thread suspend: " << *thread;
555 while (true) {
556 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
557 break;
558 } else {
559 // Failure means the list of active_suspend_barriers is full, we should release the
560 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
561 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
562 // the thread to change to a suspended state, because it might need to run checkpoint
563 // function before the state change, which also needs thread_suspend_count_lock_.
564
565 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
566 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
567 // in the mean time.
568 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
569 NanoSleep(100000);
570 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
571 }
572 }
573
574 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
575 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
576 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
577 if (thread->IsSuspended()) {
578 // Only clear the counter for the current thread.
579 thread->ClearSuspendBarrier(&pending_threads);
580 pending_threads.FetchAndSubSequentiallyConsistent(1);
581 }
582 }
583 }
584
585 // Wait for the barrier to be passed by all runnable threads. This wait
586 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700587#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800588 timespec wait_timeout;
589 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700590#endif
Yu Lieac44242015-06-29 10:50:03 +0800591 while (true) {
592 int32_t cur_val = pending_threads.LoadRelaxed();
593 if (LIKELY(cur_val > 0)) {
594#if ART_USE_FUTEXES
595 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
596 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
597 if ((errno != EAGAIN) && (errno != EINTR)) {
598 if (errno == ETIMEDOUT) {
599 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
600 } else {
601 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
602 }
603 }
604 } else {
605 cur_val = pending_threads.LoadRelaxed();
606 CHECK_EQ(cur_val, 0);
607 break;
608 }
609#else
610 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
611#endif
612 } else {
613 CHECK_EQ(cur_val, 0);
614 break;
615 }
616 }
617}
618
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700619void ThreadList::ResumeAll() {
620 Thread* self = Thread::Current();
621
Jeff Haoc5d824a2014-07-28 18:35:38 -0700622 if (self != nullptr) {
623 VLOG(threads) << *self << " ResumeAll starting";
624 } else {
625 VLOG(threads) << "Thread[null] ResumeAll starting";
626 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700627
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700628 ATRACE_END();
629 ATRACE_BEGIN("Resuming mutator threads");
630
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800631 if (kDebugLocking) {
632 // Debug check that all threads are suspended.
633 AssertThreadsAreSuspended(self, self);
634 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700635
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700636 long_suspend_ = false;
637
Ian Rogers81d425b2012-09-27 16:03:43 -0700638 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700639 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700640 MutexLock mu(self, *Locks::thread_list_lock_);
641 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700642 // Update global suspend all state for attaching threads.
643 --suspend_all_count_;
644 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700645 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700646 if (thread == self) {
647 continue;
648 }
Yu Lieac44242015-06-29 10:50:03 +0800649 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700650 }
651
652 // Broadcast a notification to all suspended threads, some or all of
653 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700654 if (self != nullptr) {
655 VLOG(threads) << *self << " ResumeAll waking others";
656 } else {
657 VLOG(threads) << "Thread[null] ResumeAll waking others";
658 }
Ian Rogersc604d732012-10-14 16:09:54 -0700659 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700660 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700661 ATRACE_END();
Jeff Haoc5d824a2014-07-28 18:35:38 -0700662
663 if (self != nullptr) {
664 VLOG(threads) << *self << " ResumeAll complete";
665 } else {
666 VLOG(threads) << "Thread[null] ResumeAll complete";
667 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700668}
669
670void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800671 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
672 ATRACE_END();
673
Ian Rogers81d425b2012-09-27 16:03:43 -0700674 Thread* self = Thread::Current();
675 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700676 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
677 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700678
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700679 {
680 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700681 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700682 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700683 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
684 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700685 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700686 // We only expect threads within the thread-list to have been suspended otherwise we can't
687 // stop such threads from delete-ing themselves.
688 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
689 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700690 return;
691 }
Yu Lieac44242015-06-29 10:50:03 +0800692 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700693 }
694
695 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700696 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700697 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700698 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700699 }
700
Brian Carlstromba32de42014-08-27 23:43:46 -0700701 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700702}
Elliott Hughes01158d72011-09-19 19:47:10 -0700703
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700704static void ThreadSuspendByPeerWarning(Thread* self,
705 LogSeverity severity,
706 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700707 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700708 JNIEnvExt* env = self->GetJniEnv();
709 ScopedLocalRef<jstring>
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700710 scoped_name_string(env, static_cast<jstring>(env->GetObjectField(
711 peer, WellKnownClasses::java_lang_Thread_name)));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700712 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700713 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700714 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700715 env->ExceptionClear();
716 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700717 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700718 }
719}
720
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700721Thread* ThreadList::SuspendThreadByPeer(jobject peer,
722 bool request_suspension,
723 bool debug_suspension,
724 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800725 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800726 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700727 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800728 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800729 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700730 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700731 while (true) {
732 Thread* thread;
733 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700734 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
735 // is requesting another suspend, to avoid deadlock, by requiring this function be called
736 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
737 // than request thread suspension, to avoid potential cycles in threads requesting each other
738 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700739 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800740 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700741 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700742 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800743 if (suspended_thread != nullptr) {
744 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
745 // If we incremented the suspend count but the thread reset its peer, we need to
746 // re-decrement it since it is shutting down and may deadlock the runtime in
747 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800748 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800749 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700750 ThreadSuspendByPeerWarning(self, WARNING, "No such thread for suspend", peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700751 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700752 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700753 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800754 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700755 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
756 << reinterpret_cast<void*>(thread);
757 return nullptr;
758 }
759 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700760 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800761 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700762 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800763 if (self->GetSuspendCount() > 0) {
764 // We hold the suspend count lock but another thread is trying to suspend us. Its not
765 // safe to try to suspend another thread in case we get a cycle. Start the loop again
766 // which will allow this thread to be suspended.
767 continue;
768 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800769 CHECK(suspended_thread == nullptr);
770 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800771 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700772 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700773 } else {
774 // If the caller isn't requesting suspension, a suspension should have already occurred.
775 CHECK_GT(thread->GetSuspendCount(), 0);
776 }
777 // IsSuspended on the current thread will fail as the current thread is changed into
778 // Runnable above. As the suspend count is now raised if this is the current thread
779 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
780 // to just explicitly handle the current thread in the callers to this code.
781 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
782 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
783 // count, or else we've waited and it has self suspended) or is the current thread, we're
784 // done.
785 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700786 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800787 if (ATRACE_ENABLED()) {
788 std::string name;
789 thread->GetThreadName(name);
790 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
791 peer).c_str());
792 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700793 return thread;
794 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800795 const uint64_t total_delay = NanoTime() - start_time;
796 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700797 ThreadSuspendByPeerWarning(self, FATAL, "Thread suspension timed out", peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800798 if (suspended_thread != nullptr) {
799 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800800 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700801 }
802 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700803 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800804 } else if (sleep_us == 0 &&
805 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
806 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
807 // excessive CPU usage.
808 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700809 }
810 }
811 // Release locks and come out of runnable state.
812 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800813 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
814 ThreadSuspendSleep(sleep_us);
815 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
816 // all if possible. This shouldn't be an issue since time to suspend should always be small.
817 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700818 }
819}
820
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700821static void ThreadSuspendByThreadIdWarning(LogSeverity severity,
822 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700823 uint32_t thread_id) {
824 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700825}
826
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700827Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id,
828 bool debug_suspension,
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700829 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800830 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800831 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700832 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800833 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800834 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700835 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700836 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700837 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700838 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700839 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
840 // is requesting another suspend, to avoid deadlock, by requiring this function be called
841 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
842 // than request thread suspension, to avoid potential cycles in threads requesting each other
843 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700844 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800845 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700846 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700847 for (const auto& it : list_) {
848 if (it->GetThreadId() == thread_id) {
849 thread = it;
850 break;
851 }
852 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800853 if (thread == nullptr) {
854 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
855 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700856 // There's a race in inflating a lock and the owner giving up ownership and then dying.
857 ThreadSuspendByThreadIdWarning(WARNING, "No such thread id for suspend", thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700858 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700859 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700860 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
861 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700862 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800863 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800864 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800865 if (self->GetSuspendCount() > 0) {
866 // We hold the suspend count lock but another thread is trying to suspend us. Its not
867 // safe to try to suspend another thread in case we get a cycle. Start the loop again
868 // which will allow this thread to be suspended.
869 continue;
870 }
Yu Lieac44242015-06-29 10:50:03 +0800871 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800872 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700873 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800874 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700875 // If the caller isn't requesting suspension, a suspension should have already occurred.
876 CHECK_GT(thread->GetSuspendCount(), 0);
877 }
878 // IsSuspended on the current thread will fail as the current thread is changed into
879 // Runnable above. As the suspend count is now raised if this is the current thread
880 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
881 // to just explicitly handle the current thread in the callers to this code.
882 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
883 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
884 // count, or else we've waited and it has self suspended) or is the current thread, we're
885 // done.
886 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800887 if (ATRACE_ENABLED()) {
888 std::string name;
889 thread->GetThreadName(name);
890 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
891 name.c_str(), thread_id).c_str());
892 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700893 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700894 return thread;
895 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800896 const uint64_t total_delay = NanoTime() - start_time;
897 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700898 ThreadSuspendByThreadIdWarning(WARNING, "Thread suspension timed out", thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800899 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800900 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700901 }
902 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700903 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800904 } else if (sleep_us == 0 &&
905 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
906 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
907 // excessive CPU usage.
908 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700909 }
910 }
911 // Release locks and come out of runnable state.
912 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800913 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
914 ThreadSuspendSleep(sleep_us);
915 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700916 }
917}
918
919Thread* ThreadList::FindThreadByThreadId(uint32_t thin_lock_id) {
920 Thread* self = Thread::Current();
921 MutexLock mu(self, *Locks::thread_list_lock_);
922 for (const auto& thread : list_) {
923 if (thread->GetThreadId() == thin_lock_id) {
924 CHECK(thread == self || thread->IsSuspended());
925 return thread;
926 }
927 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700928 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700929}
930
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700931void ThreadList::SuspendAllForDebugger() {
932 Thread* self = Thread::Current();
933 Thread* debug_thread = Dbg::GetDebugThread();
934
935 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
936
Yu Lieac44242015-06-29 10:50:03 +0800937 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700938 // Block on the mutator lock until all Runnable threads release their share of access then
939 // immediately unlock again.
940#if HAVE_TIMED_RWLOCK
941 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700942 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100943 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700944 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700945 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700946 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700947#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700948 Locks::mutator_lock_->ExclusiveLock(self);
949 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700950#endif
Mathieu Chartier9450c6c2015-11-07 11:55:23 -0800951 // Disabled for the following race condition:
952 // Thread 1 calls SuspendAllForDebugger, gets preempted after pulsing the mutator lock.
953 // Thread 2 calls SuspendAll and SetStateUnsafe (perhaps from Dbg::Disconnected).
954 // Thread 1 fails assertion that all threads are suspended due to thread 2 being in a runnable
955 // state (from SetStateUnsafe).
956 // AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700957
Sebastien Hertzed2be172014-08-19 15:33:43 +0200958 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700959}
960
Elliott Hughes475fc232011-10-25 15:00:35 -0700961void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100962 Thread* const self = Thread::Current();
963 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700964
Elliott Hughes475fc232011-10-25 15:00:35 -0700965 // The debugger thread must not suspend itself due to debugger activity!
966 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700967 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800968 CHECK_NE(self->GetState(), kRunnable);
969 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700970
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200971 // The debugger may have detached while we were executing an invoke request. In that case, we
972 // must not suspend ourself.
973 DebugInvokeReq* pReq = self->GetInvokeReq();
974 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
975 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800976 // Collisions with other suspends aren't really interesting. We want
977 // to ensure that we're the only one fiddling with the suspend count
978 // though.
979 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800980 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700981 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200982
983 VLOG(threads) << *self << " self-suspending (debugger)";
984 } else {
985 // We must no longer be subject to debugger suspension.
986 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
987 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
988
989 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800990 }
Elliott Hughes475fc232011-10-25 15:00:35 -0700991
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200992 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +0100993 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200994 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +0100995 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200996 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +0100997 }
998
Elliott Hughes475fc232011-10-25 15:00:35 -0700999 // Tell JDWP that we've completed suspension. The JDWP thread can't
1000 // tell us to resume before we're fully asleep because we hold the
1001 // suspend count lock.
1002 Dbg::ClearWaitForEventThread();
1003
jeffhaoa77f0f62012-12-05 17:19:31 -08001004 {
1005 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001006 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001007 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001008 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001009 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +02001010 // can happen when we suspend then resume all threads to
1011 // update instrumentation or compute monitor info. This can
1012 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001013 // dump event is pending (assuming SignalCatcher was resumed for
1014 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001015 VLOG(jdwp) << *self << " still suspended after undo "
1016 << "(suspend count=" << self->GetSuspendCount() << ", "
1017 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001018 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001019 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001020 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001021 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001022
Sebastien Hertz1558b572015-02-25 15:05:59 +01001023 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001024 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001025}
1026
Sebastien Hertz253fa552014-10-14 17:27:15 +02001027void ThreadList::ResumeAllForDebugger() {
1028 Thread* self = Thread::Current();
1029 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001030
1031 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1032
1033 // Threads can't resume if we exclusively hold the mutator lock.
1034 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1035
1036 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001037 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001038 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001039 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001040 // Update global suspend all state for attaching threads.
1041 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001042 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001043 --suspend_all_count_;
1044 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001045 } else {
1046 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001047 // suspend them all before. That may happen if a debugger tries
1048 // to resume some suspended threads (with suspend count == 1)
1049 // at once with a VirtualMachine.Resume command. Let's print a
1050 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001051 LOG(WARNING) << "Debugger attempted to resume all threads without "
1052 << "having suspended them all before.";
1053 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001054 // Decrement everybody's suspend count (except our own).
1055 for (const auto& thread : list_) {
1056 if (thread == self || thread == debug_thread) {
1057 continue;
1058 }
1059 if (thread->GetDebugSuspendCount() == 0) {
1060 // This thread may have been individually resumed with ThreadReference.Resume.
1061 continue;
1062 }
1063 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001064 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001065 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001066 }
1067 }
1068
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001069 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001070 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1071 Thread::resume_cond_->Broadcast(self);
1072 }
1073
1074 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1075}
1076
Elliott Hughes234ab152011-10-26 14:02:26 -07001077void ThreadList::UndoDebuggerSuspensions() {
1078 Thread* self = Thread::Current();
1079
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001080 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001081
1082 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001083 MutexLock mu(self, *Locks::thread_list_lock_);
1084 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001085 // Update global suspend all state for attaching threads.
1086 suspend_all_count_ -= debug_suspend_all_count_;
1087 debug_suspend_all_count_ = 0;
1088 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001089 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001090 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001091 continue;
1092 }
Yu Lieac44242015-06-29 10:50:03 +08001093 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001094 }
1095 }
1096
1097 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001098 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001099 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001100 }
1101
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001102 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001103}
1104
Elliott Hughese52e49b2012-04-02 16:05:44 -07001105void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001106 Thread* self = Thread::Current();
1107 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001108 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001109 {
1110 // No more threads can be born after we start to shutdown.
1111 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001112 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001113 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1114 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001115 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001116 // Also wait for any threads that are unregistering to finish. This is required so that no
1117 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1118 // threads since they could unregister at the wrong time.
1119 bool done = unregistering_count_ == 0;
1120 if (done) {
1121 for (const auto& thread : list_) {
1122 if (thread != self && !thread->IsDaemon()) {
1123 done = false;
1124 break;
1125 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001126 }
1127 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001128 if (done) {
1129 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001130 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001131 // Wait for another thread to exit before re-checking.
1132 Locks::thread_exit_cond_->Wait(self);
1133 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001134}
1135
1136void ThreadList::SuspendAllDaemonThreads() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001137 Thread* self = Thread::Current();
1138 MutexLock mu(self, *Locks::thread_list_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001139 { // Tell all the daemons it's time to suspend.
Ian Rogers81d425b2012-09-27 16:03:43 -07001140 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001141 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001142 // This is only run after all non-daemon threads have exited, so the remainder should all be
1143 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001144 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001145 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001146 thread->ModifySuspendCount(self, +1, nullptr, false);
Elliott Hughese52e49b2012-04-02 16:05:44 -07001147 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001148 }
1149 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001150 // Give the threads a chance to suspend, complaining if they're slow.
1151 bool have_complained = false;
1152 for (int i = 0; i < 10; ++i) {
1153 usleep(200 * 1000);
1154 bool all_suspended = true;
Mathieu Chartier02e25112013-08-14 16:14:24 -07001155 for (const auto& thread : list_) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001156 if (thread != self && thread->GetState() == kRunnable) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001157 if (!have_complained) {
1158 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1159 have_complained = true;
1160 }
1161 all_suspended = false;
1162 }
1163 }
1164 if (all_suspended) {
1165 return;
1166 }
1167 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001168 LOG(ERROR) << "suspend all daemons failed";
1169}
1170void ThreadList::Register(Thread* self) {
1171 DCHECK_EQ(self, Thread::Current());
1172
1173 if (VLOG_IS_ON(threads)) {
1174 std::ostringstream oss;
1175 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001176 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001177 }
1178
1179 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1180 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001181 MutexLock mu(self, *Locks::thread_list_lock_);
1182 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001183 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001184 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1185 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1186 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001187 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001188 }
Ian Rogers2966e132014-04-02 08:34:36 -07001189 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001190 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001191 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001192 CHECK(!Contains(self));
1193 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001194 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001195 // Initialize according to the state of the CC collector.
1196 bool is_gc_marking =
1197 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1198 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001199 bool weak_ref_access_enabled =
1200 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1201 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1202 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001203}
1204
1205void ThreadList::Unregister(Thread* self) {
1206 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001207 CHECK_NE(self->GetState(), kRunnable);
1208 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001209
1210 VLOG(threads) << "ThreadList::Unregister() " << *self;
1211
Mathieu Chartier91e56692015-03-03 13:51:04 -08001212 {
1213 MutexLock mu(self, *Locks::thread_list_lock_);
1214 ++unregistering_count_;
1215 }
1216
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001217 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001218 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1219 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1220 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1221 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001222 self->Destroy();
1223
Jeff Haoe094b872014-10-14 13:12:01 -07001224 // If tracing, remember thread id and name before thread exits.
1225 Trace::StoreExitingThreadInfo(self);
1226
Ian Rogersdd7624d2014-03-14 17:43:00 -07001227 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001228 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001229 // Remove and delete the Thread* while holding the thread_list_lock_ and
1230 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001231 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001232 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001233 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001234 std::string thread_name;
1235 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001236 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001237 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001238 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001239 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001240 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001241 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001242 if (!self->IsSuspended()) {
1243 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001244 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001245 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001246 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001247 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001248 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001249 delete self;
1250
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001251 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1252 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1253 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1254 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001255
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001256 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1257 // (It may wish to reattach later.)
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001258#ifdef __ANDROID__
1259 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1260#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001261 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001262#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001263
1264 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001265 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1266 --unregistering_count_;
1267 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001268}
1269
1270void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001271 for (const auto& thread : list_) {
1272 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001273 }
1274}
1275
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001276void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001277 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001278 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001279 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001280 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001281}
1282
Ian Rogerscfaa4552012-11-26 21:00:08 -08001283uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001284 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001285 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1286 if (!allocated_ids_[i]) {
1287 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001288 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001289 }
1290 }
1291 LOG(FATAL) << "Out of internal thread ids";
1292 return 0;
1293}
1294
Ian Rogerscfaa4552012-11-26 21:00:08 -08001295void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001296 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001297 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001298 DCHECK(allocated_ids_[id]) << id;
1299 allocated_ids_.reset(id);
1300}
1301
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001302ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1303 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1304}
1305
1306ScopedSuspendAll::~ScopedSuspendAll() {
1307 Runtime::Current()->GetThreadList()->ResumeAll();
1308}
1309
Elliott Hughes8daa0922011-09-11 13:46:25 -07001310} // namespace art