blob: cf515b60cb085380c682d532294b8b94b37f90cd [file] [log] [blame]
Elliott Hughes8daa0922011-09-11 13:46:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "thread_list.h"
18
Christopher Ferris6cff48f2014-01-26 21:36:13 -080019#include <backtrace/BacktraceMap.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070020#include <dirent.h>
Ian Rogersd9c4fc92013-10-01 19:45:43 -070021#include <ScopedLocalRef.h>
22#include <ScopedUtfChars.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070023#include <sys/types.h>
Elliott Hughes038a8062011-09-18 14:12:41 -070024#include <unistd.h>
25
Ian Rogersc7dd2952014-10-21 23:31:19 -070026#include <sstream>
27
Mathieu Chartier70a596d2014-12-17 14:56:47 -080028#include "base/histogram-inl.h"
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -070029#include "base/mutex-inl.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080030#include "base/systrace.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010031#include "base/time_utils.h"
Sameer Abu Asala8439542013-02-14 16:06:42 -080032#include "base/timing_logger.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070033#include "debugger.h"
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -070034#include "gc/collector/concurrent_copying.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070035#include "jni_internal.h"
36#include "lock_word.h"
37#include "monitor.h"
38#include "scoped_thread_state_change.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080039#include "thread.h"
Jeff Haoe094b872014-10-14 13:12:01 -070040#include "trace.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070041#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070042
Yu Lieac44242015-06-29 10:50:03 +080043#if ART_USE_FUTEXES
44#include "linux/futex.h"
45#include "sys/syscall.h"
46#ifndef SYS_futex
47#define SYS_futex __NR_futex
48#endif
49#endif // ART_USE_FUTEXES
50
Elliott Hughes8daa0922011-09-11 13:46:25 -070051namespace art {
52
Mathieu Chartier251755c2014-07-15 18:10:25 -070053static constexpr uint64_t kLongThreadSuspendThreshold = MsToNs(5);
Mathieu Chartier99143862015-02-03 14:26:46 -080054static constexpr uint64_t kThreadSuspendTimeoutMs = 30 * 1000; // 30s.
55// Use 0 since we want to yield to prevent blocking for an unpredictable amount of time.
56static constexpr useconds_t kThreadSuspendInitialSleepUs = 0;
57static constexpr useconds_t kThreadSuspendMaxYieldUs = 3000;
58static constexpr useconds_t kThreadSuspendMaxSleepUs = 5000;
Mathieu Chartier251755c2014-07-15 18:10:25 -070059
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080060ThreadList::ThreadList()
Mathieu Chartierb56200b2015-10-29 10:41:51 -070061 : suspend_all_count_(0),
62 debug_suspend_all_count_(0),
63 unregistering_count_(0),
64 suspend_all_historam_("suspend all histogram", 16, 64),
65 long_suspend_(false) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -080066 CHECK(Monitor::IsValidLockWord(LockWord::FromThinLockId(kMaxThreadId, 1, 0U)));
Elliott Hughes8daa0922011-09-11 13:46:25 -070067}
68
69ThreadList::~ThreadList() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080070 ScopedTrace trace(__PRETTY_FUNCTION__);
Elliott Hughese52e49b2012-04-02 16:05:44 -070071 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070072 // We need to detach the current thread here in case there's another thread waiting to join with
73 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070074 bool contains = false;
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080075 Thread* self = Thread::Current();
Mathieu Chartierfec72f42014-10-09 12:57:58 -070076 {
Mathieu Chartierfec72f42014-10-09 12:57:58 -070077 MutexLock mu(self, *Locks::thread_list_lock_);
78 contains = Contains(self);
79 }
80 if (contains) {
Elliott Hughes8daa0922011-09-11 13:46:25 -070081 Runtime::Current()->DetachCurrentThread();
82 }
Elliott Hughes6a144332012-04-03 13:07:11 -070083 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartier51168372015-08-12 16:40:32 -070084 // Disable GC and wait for GC to complete in case there are still daemon threads doing
85 // allocations.
86 gc::Heap* const heap = Runtime::Current()->GetHeap();
87 heap->DisableGCForShutdown();
88 // In case a GC is in progress, wait for it to finish.
89 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
Ian Rogers00f7d0e2012-07-19 15:28:27 -070090 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
91 // Thread::Init.
Mathieu Chartier4d87df62016-01-07 15:14:19 -080092 SuspendAllDaemonThreadsForShutdown();
Elliott Hughes8daa0922011-09-11 13:46:25 -070093}
94
95bool ThreadList::Contains(Thread* thread) {
96 return find(list_.begin(), list_.end(), thread) != list_.end();
97}
98
Elliott Hughesabbe07d2012-06-05 17:42:23 -070099bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -0700100 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700101 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700102 return true;
103 }
104 }
105 return false;
106}
107
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700108pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700109 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700110}
111
Mathieu Chartier590fee92013-09-13 13:46:47 -0700112void ThreadList::DumpNativeStacks(std::ostream& os) {
113 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800114 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700115 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700116 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800117 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700118 os << "\n";
119 }
120}
121
Elliott Hughesc967f782012-04-16 10:23:15 -0700122void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800123 {
124 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800125 // Only print if we have samples.
126 if (suspend_all_historam_.SampleSize() > 0) {
127 Histogram<uint64_t>::CumulativeData data;
128 suspend_all_historam_.CreateHistogram(&data);
129 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
130 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800131 }
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000132 Dump(os, Runtime::Current()->GetDumpNativeStackOnSigQuit());
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700133 DumpUnattachedThreads(os);
134}
135
Ian Rogerscfaa4552012-11-26 21:00:08 -0800136static void DumpUnattachedThread(std::ostream& os, pid_t tid) NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700137 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800138 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700139 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700140 DumpKernelStack(os, tid, " kernel: ", false);
Nicolas Geoffray0c659392016-03-02 10:27:01 +0000141 // TODO: Reenable this when the native code in system_server can handle it.
142 // Currently "adb shell kill -3 `pid system_server`" will cause it to exit.
143 if (false) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800144 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700145 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700146 os << "\n";
147}
148
149void ThreadList::DumpUnattachedThreads(std::ostream& os) {
150 DIR* d = opendir("/proc/self/task");
151 if (!d) {
152 return;
153 }
154
Ian Rogers50b35e22012-10-04 10:09:15 -0700155 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700156 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700157 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700158 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700159 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700160 if (!*end) {
161 bool contains;
162 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700163 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700164 contains = Contains(tid);
165 }
166 if (!contains) {
167 DumpUnattachedThread(os, tid);
168 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700169 }
170 }
171 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800172}
173
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800174// Dump checkpoint timeout in milliseconds. Larger amount on the host, as dumping will invoke
175// addr2line when available.
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800176static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 10000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800177
Ian Rogers7b078e82014-09-10 14:44:24 -0700178// A closure used by Thread::Dump.
179class DumpCheckpoint FINAL : public Closure {
180 public:
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000181 DumpCheckpoint(std::ostream* os, bool dump_native_stack)
182 : os_(os),
183 barrier_(0),
184 backtrace_map_(dump_native_stack ? BacktraceMap::Create(getpid()) : nullptr),
185 dump_native_stack_(dump_native_stack) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700186
187 void Run(Thread* thread) OVERRIDE {
188 // Note thread and self may not be equal if thread was already suspended at the point of the
189 // request.
190 Thread* self = Thread::Current();
191 std::ostringstream local_os;
192 {
193 ScopedObjectAccess soa(self);
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000194 thread->Dump(local_os, dump_native_stack_, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700195 }
196 local_os << "\n";
197 {
198 // Use the logging lock to ensure serialization when writing to the common ostream.
199 MutexLock mu(self, *Locks::logging_lock_);
200 *os_ << local_os.str();
201 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700202 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700203 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700204
205 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
206 Thread* self = Thread::Current();
207 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800208 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700209 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000210 // Avoid a recursive abort.
211 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
212 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700213 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700214 }
215
216 private:
217 // The common stream that will accumulate all the dumps.
218 std::ostream* const os_;
219 // The barrier to be passed through and for the requestor to wait upon.
220 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800221 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
222 std::unique_ptr<BacktraceMap> backtrace_map_;
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000223 // Whether we should dump the native stack.
224 const bool dump_native_stack_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700225};
226
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000227void ThreadList::Dump(std::ostream& os, bool dump_native_stack) {
Ian Rogers7b078e82014-09-10 14:44:24 -0700228 {
229 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
230 os << "DALVIK THREADS (" << list_.size() << "):\n";
231 }
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000232 DumpCheckpoint checkpoint(&os, dump_native_stack);
Ian Rogers7b078e82014-09-10 14:44:24 -0700233 size_t threads_running_checkpoint = RunCheckpoint(&checkpoint);
Lei Lidd9943d2015-02-02 14:24:44 +0800234 if (threads_running_checkpoint != 0) {
235 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
236 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700237}
238
Ian Rogers50b35e22012-10-04 10:09:15 -0700239void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
240 MutexLock mu(self, *Locks::thread_list_lock_);
241 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700242 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800243 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700244 CHECK(thread->IsSuspended())
245 << "\nUnsuspended thread: <<" << *thread << "\n"
246 << "self: <<" << *Thread::Current();
247 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700248 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700249}
250
Ian Rogers66aee5c2012-08-15 17:17:47 -0700251#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700252// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800253NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700254 Runtime* runtime = Runtime::Current();
255 std::ostringstream ss;
256 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700257 Locks::mutator_lock_->Dump(ss);
258 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700259 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700260 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800261 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700262}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700263#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700264
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800265// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800266// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
267// we use sched_yield instead of calling usleep.
268static void ThreadSuspendSleep(useconds_t delay_us) {
269 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800270 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800271 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800272 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800273 }
274}
275
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700276size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700277 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800278 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
279 Locks::thread_list_lock_->AssertNotHeld(self);
280 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700281
282 std::vector<Thread*> suspended_count_modified_threads;
283 size_t count = 0;
284 {
285 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
286 // manually called.
287 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700288 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700289 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700290 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700291 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700292 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700293 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800294 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700295 break;
296 } else {
297 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700298 // The thread switched back to runnable.
299 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700300 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700301 continue;
302 }
Yu Lieac44242015-06-29 10:50:03 +0800303 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700304 suspended_count_modified_threads.push_back(thread);
305 break;
306 }
307 }
308 }
309 }
310 }
311
312 // Run the checkpoint on ourself while we wait for threads to suspend.
313 checkpoint_function->Run(self);
314
315 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700316 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700317 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800318 if (ATRACE_ENABLED()) {
319 std::ostringstream oss;
320 thread->ShortDump(oss);
321 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
322 }
323 // Busy wait until the thread is suspended.
324 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700325 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800326 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700327 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800328 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800329 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800330 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
331 ATRACE_END();
332 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
333 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
334 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700335 }
336 }
337 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700338 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700339 {
340 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800341 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700342 }
343 }
344
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800345 {
346 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
347 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
348 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
349 Thread::resume_cond_->Broadcast(self);
350 }
351
Lei Lidd9943d2015-02-02 14:24:44 +0800352 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700353}
354
Dave Allison39c3bfb2014-01-28 18:33:52 -0800355// Request that a checkpoint function be run on all active (non-suspended)
356// threads. Returns the number of successful requests.
357size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
358 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700359 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
360 Locks::thread_list_lock_->AssertNotHeld(self);
361 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
362 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800363
364 size_t count = 0;
365 {
366 // Call a checkpoint function for each non-suspended thread.
367 MutexLock mu(self, *Locks::thread_list_lock_);
368 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
369 for (const auto& thread : list_) {
370 if (thread != self) {
371 if (thread->RequestCheckpoint(checkpoint_function)) {
372 // This thread will run its checkpoint some time in the near future.
373 count++;
374 }
375 }
376 }
377 }
378
379 // Return the number of threads that will run the checkpoint function.
380 return count;
381}
382
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800383// A checkpoint/suspend-all hybrid to switch thread roots from
384// from-space to to-space refs. Used to synchronize threads at a point
385// to mark the initiation of marking while maintaining the to-space
386// invariant.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700387size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor,
388 Closure* flip_callback,
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800389 gc::collector::GarbageCollector* collector) {
390 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
391 const uint64_t start_time = NanoTime();
392 Thread* self = Thread::Current();
393 Locks::mutator_lock_->AssertNotHeld(self);
394 Locks::thread_list_lock_->AssertNotHeld(self);
395 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
396 CHECK_NE(self->GetState(), kRunnable);
397
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700398 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800399
400 // Run the flip callback for the collector.
401 Locks::mutator_lock_->ExclusiveLock(self);
402 flip_callback->Run(self);
403 Locks::mutator_lock_->ExclusiveUnlock(self);
404 collector->RegisterPause(NanoTime() - start_time);
405
406 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700407 std::vector<Thread*> runnable_threads;
408 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800409 {
410 MutexLock mu(self, *Locks::thread_list_lock_);
411 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
412 --suspend_all_count_;
413 for (const auto& thread : list_) {
414 if (thread == self) {
415 continue;
416 }
417 // Set the flip function for both runnable and suspended threads
418 // because Thread::DumpState/DumpJavaStack() (invoked by a
419 // checkpoint) may cause the flip function to be run for a
420 // runnable/suspended thread before a runnable threads runs it
421 // for itself or we run it for a suspended thread below.
422 thread->SetFlipFunction(thread_flip_visitor);
423 if (thread->IsSuspendedAtSuspendCheck()) {
424 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800425 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800426 runnable_threads.push_back(thread);
427 } else {
428 other_threads.push_back(thread);
429 }
430 }
431 Thread::resume_cond_->Broadcast(self);
432 }
433
434 // Run the closure on the other threads and let them resume.
435 {
436 ReaderMutexLock mu(self, *Locks::mutator_lock_);
437 for (const auto& thread : other_threads) {
438 Closure* flip_func = thread->GetFlipFunction();
439 if (flip_func != nullptr) {
440 flip_func->Run(thread);
441 }
442 }
443 // Run it for self.
444 thread_flip_visitor->Run(self);
445 }
446
447 // Resume other threads.
448 {
449 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
450 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800451 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800452 }
453 Thread::resume_cond_->Broadcast(self);
454 }
455
456 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
457}
458
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700459void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700460 Thread* self = Thread::Current();
461
Jeff Haoc5d824a2014-07-28 18:35:38 -0700462 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700463 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700464 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700465 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700466 }
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800467 {
468 ScopedTrace trace("Suspending mutator threads");
469 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700470
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800471 SuspendAllInternal(self, self);
472 // All threads are known to have suspended (but a thread may still own the mutator lock)
473 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700474#if HAVE_TIMED_RWLOCK
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800475 while (true) {
476 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
477 break;
478 } else if (!long_suspend_) {
479 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
480 // could result in a thread suspend timeout.
481 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
482 UnsafeLogFatalForThreadSuspendAllTimeout();
483 }
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700484 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700485#else
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800486 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700487#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700488
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800489 long_suspend_ = long_suspend;
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700490
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800491 const uint64_t end_time = NanoTime();
492 const uint64_t suspend_time = end_time - start_time;
493 suspend_all_historam_.AdjustAndAddValue(suspend_time);
494 if (suspend_time > kLongThreadSuspendThreshold) {
495 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
496 }
497
498 if (kDebugLocking) {
499 // Debug check that all threads are suspended.
500 AssertThreadsAreSuspended(self, self);
501 }
Mathieu Chartier251755c2014-07-15 18:10:25 -0700502 }
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700503 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700504
Jeff Haoc5d824a2014-07-28 18:35:38 -0700505 if (self != nullptr) {
506 VLOG(threads) << *self << " SuspendAll complete";
507 } else {
508 VLOG(threads) << "Thread[null] SuspendAll complete";
509 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700510}
511
Yu Lieac44242015-06-29 10:50:03 +0800512// Ensures all threads running Java suspend and that those not running Java don't start.
513// Debugger thread might be set to kRunnable for a short period of time after the
514// SuspendAllInternal. This is safe because it will be set back to suspended state before
515// the SuspendAll returns.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700516void ThreadList::SuspendAllInternal(Thread* self,
517 Thread* ignore1,
518 Thread* ignore2,
Yu Lieac44242015-06-29 10:50:03 +0800519 bool debug_suspend) {
520 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
521 Locks::thread_list_lock_->AssertNotHeld(self);
522 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
523 if (kDebugLocking && self != nullptr) {
524 CHECK_NE(self->GetState(), kRunnable);
525 }
526
527 // First request that all threads suspend, then wait for them to suspend before
528 // returning. This suspension scheme also relies on other behaviour:
529 // 1. Threads cannot be deleted while they are suspended or have a suspend-
530 // request flag set - (see Unregister() below).
531 // 2. When threads are created, they are created in a suspended state (actually
532 // kNative) and will never begin executing Java code without first checking
533 // the suspend-request flag.
534
535 // The atomic counter for number of threads that need to pass the barrier.
536 AtomicInteger pending_threads;
537 uint32_t num_ignored = 0;
538 if (ignore1 != nullptr) {
539 ++num_ignored;
540 }
541 if (ignore2 != nullptr && ignore1 != ignore2) {
542 ++num_ignored;
543 }
544 {
545 MutexLock mu(self, *Locks::thread_list_lock_);
546 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
547 // Update global suspend all state for attaching threads.
548 ++suspend_all_count_;
549 if (debug_suspend)
550 ++debug_suspend_all_count_;
551 pending_threads.StoreRelaxed(list_.size() - num_ignored);
552 // Increment everybody's suspend count (except those that should be ignored).
553 for (const auto& thread : list_) {
554 if (thread == ignore1 || thread == ignore2) {
555 continue;
556 }
557 VLOG(threads) << "requesting thread suspend: " << *thread;
558 while (true) {
559 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
560 break;
561 } else {
562 // Failure means the list of active_suspend_barriers is full, we should release the
563 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
564 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
565 // the thread to change to a suspended state, because it might need to run checkpoint
566 // function before the state change, which also needs thread_suspend_count_lock_.
567
568 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
569 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
570 // in the mean time.
571 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
572 NanoSleep(100000);
573 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
574 }
575 }
576
577 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
578 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
579 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
580 if (thread->IsSuspended()) {
581 // Only clear the counter for the current thread.
582 thread->ClearSuspendBarrier(&pending_threads);
583 pending_threads.FetchAndSubSequentiallyConsistent(1);
584 }
585 }
586 }
587
588 // Wait for the barrier to be passed by all runnable threads. This wait
589 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700590#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800591 timespec wait_timeout;
592 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700593#endif
Yu Lieac44242015-06-29 10:50:03 +0800594 while (true) {
595 int32_t cur_val = pending_threads.LoadRelaxed();
596 if (LIKELY(cur_val > 0)) {
597#if ART_USE_FUTEXES
598 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
599 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
600 if ((errno != EAGAIN) && (errno != EINTR)) {
601 if (errno == ETIMEDOUT) {
602 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
603 } else {
604 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
605 }
606 }
607 } else {
608 cur_val = pending_threads.LoadRelaxed();
609 CHECK_EQ(cur_val, 0);
610 break;
611 }
612#else
613 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
614#endif
615 } else {
616 CHECK_EQ(cur_val, 0);
617 break;
618 }
619 }
620}
621
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700622void ThreadList::ResumeAll() {
623 Thread* self = Thread::Current();
624
Jeff Haoc5d824a2014-07-28 18:35:38 -0700625 if (self != nullptr) {
626 VLOG(threads) << *self << " ResumeAll starting";
627 } else {
628 VLOG(threads) << "Thread[null] ResumeAll starting";
629 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700630
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700631 ATRACE_END();
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800632
633 ScopedTrace trace("Resuming mutator threads");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700634
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800635 if (kDebugLocking) {
636 // Debug check that all threads are suspended.
637 AssertThreadsAreSuspended(self, self);
638 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700639
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700640 long_suspend_ = false;
641
Ian Rogers81d425b2012-09-27 16:03:43 -0700642 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700643 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700644 MutexLock mu(self, *Locks::thread_list_lock_);
645 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700646 // Update global suspend all state for attaching threads.
647 --suspend_all_count_;
648 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700649 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700650 if (thread == self) {
651 continue;
652 }
Yu Lieac44242015-06-29 10:50:03 +0800653 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700654 }
655
656 // Broadcast a notification to all suspended threads, some or all of
657 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700658 if (self != nullptr) {
659 VLOG(threads) << *self << " ResumeAll waking others";
660 } else {
661 VLOG(threads) << "Thread[null] ResumeAll waking others";
662 }
Ian Rogersc604d732012-10-14 16:09:54 -0700663 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700664 }
Jeff Haoc5d824a2014-07-28 18:35:38 -0700665
666 if (self != nullptr) {
667 VLOG(threads) << *self << " ResumeAll complete";
668 } else {
669 VLOG(threads) << "Thread[null] ResumeAll complete";
670 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700671}
672
673void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800674 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
675 ATRACE_END();
676
Ian Rogers81d425b2012-09-27 16:03:43 -0700677 Thread* self = Thread::Current();
678 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700679 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
680 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700681
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700682 {
683 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700684 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700685 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700686 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
687 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700688 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700689 // We only expect threads within the thread-list to have been suspended otherwise we can't
690 // stop such threads from delete-ing themselves.
691 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
692 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700693 return;
694 }
Yu Lieac44242015-06-29 10:50:03 +0800695 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700696 }
697
698 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700699 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700700 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700701 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700702 }
703
Brian Carlstromba32de42014-08-27 23:43:46 -0700704 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700705}
Elliott Hughes01158d72011-09-19 19:47:10 -0700706
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700707static void ThreadSuspendByPeerWarning(Thread* self,
708 LogSeverity severity,
709 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700710 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700711 JNIEnvExt* env = self->GetJniEnv();
712 ScopedLocalRef<jstring>
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700713 scoped_name_string(env, static_cast<jstring>(env->GetObjectField(
714 peer, WellKnownClasses::java_lang_Thread_name)));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700715 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700716 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700717 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700718 env->ExceptionClear();
719 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700720 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700721 }
722}
723
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700724Thread* ThreadList::SuspendThreadByPeer(jobject peer,
725 bool request_suspension,
726 bool debug_suspension,
727 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800728 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800729 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700730 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800731 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800732 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700733 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700734 while (true) {
735 Thread* thread;
736 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700737 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
738 // is requesting another suspend, to avoid deadlock, by requiring this function be called
739 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
740 // than request thread suspension, to avoid potential cycles in threads requesting each other
741 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700742 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800743 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700744 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700745 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800746 if (suspended_thread != nullptr) {
747 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
748 // If we incremented the suspend count but the thread reset its peer, we need to
749 // re-decrement it since it is shutting down and may deadlock the runtime in
750 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800751 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800752 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700753 ThreadSuspendByPeerWarning(self, WARNING, "No such thread for suspend", peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700754 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700755 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700756 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800757 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700758 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
759 << reinterpret_cast<void*>(thread);
760 return nullptr;
761 }
762 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700763 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800764 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700765 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800766 if (self->GetSuspendCount() > 0) {
767 // We hold the suspend count lock but another thread is trying to suspend us. Its not
768 // safe to try to suspend another thread in case we get a cycle. Start the loop again
769 // which will allow this thread to be suspended.
770 continue;
771 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800772 CHECK(suspended_thread == nullptr);
773 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800774 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700775 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700776 } else {
777 // If the caller isn't requesting suspension, a suspension should have already occurred.
778 CHECK_GT(thread->GetSuspendCount(), 0);
779 }
780 // IsSuspended on the current thread will fail as the current thread is changed into
781 // Runnable above. As the suspend count is now raised if this is the current thread
782 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
783 // to just explicitly handle the current thread in the callers to this code.
784 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
785 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
786 // count, or else we've waited and it has self suspended) or is the current thread, we're
787 // done.
788 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700789 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800790 if (ATRACE_ENABLED()) {
791 std::string name;
792 thread->GetThreadName(name);
793 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
794 peer).c_str());
795 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700796 return thread;
797 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800798 const uint64_t total_delay = NanoTime() - start_time;
799 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700800 ThreadSuspendByPeerWarning(self, FATAL, "Thread suspension timed out", peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800801 if (suspended_thread != nullptr) {
802 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800803 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700804 }
805 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700806 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800807 } else if (sleep_us == 0 &&
808 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
809 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
810 // excessive CPU usage.
811 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700812 }
813 }
814 // Release locks and come out of runnable state.
815 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800816 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
817 ThreadSuspendSleep(sleep_us);
818 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
819 // all if possible. This shouldn't be an issue since time to suspend should always be small.
820 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700821 }
822}
823
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700824static void ThreadSuspendByThreadIdWarning(LogSeverity severity,
825 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700826 uint32_t thread_id) {
827 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700828}
829
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700830Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id,
831 bool debug_suspension,
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700832 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800833 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800834 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700835 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800836 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800837 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700838 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700839 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700840 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700841 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700842 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
843 // is requesting another suspend, to avoid deadlock, by requiring this function be called
844 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
845 // than request thread suspension, to avoid potential cycles in threads requesting each other
846 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700847 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800848 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700849 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700850 for (const auto& it : list_) {
851 if (it->GetThreadId() == thread_id) {
852 thread = it;
853 break;
854 }
855 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800856 if (thread == nullptr) {
857 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
858 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700859 // There's a race in inflating a lock and the owner giving up ownership and then dying.
860 ThreadSuspendByThreadIdWarning(WARNING, "No such thread id for suspend", thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700861 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700862 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700863 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
864 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700865 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800866 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800867 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800868 if (self->GetSuspendCount() > 0) {
869 // We hold the suspend count lock but another thread is trying to suspend us. Its not
870 // safe to try to suspend another thread in case we get a cycle. Start the loop again
871 // which will allow this thread to be suspended.
872 continue;
873 }
Yu Lieac44242015-06-29 10:50:03 +0800874 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800875 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700876 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800877 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700878 // If the caller isn't requesting suspension, a suspension should have already occurred.
879 CHECK_GT(thread->GetSuspendCount(), 0);
880 }
881 // IsSuspended on the current thread will fail as the current thread is changed into
882 // Runnable above. As the suspend count is now raised if this is the current thread
883 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
884 // to just explicitly handle the current thread in the callers to this code.
885 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
886 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
887 // count, or else we've waited and it has self suspended) or is the current thread, we're
888 // done.
889 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800890 if (ATRACE_ENABLED()) {
891 std::string name;
892 thread->GetThreadName(name);
893 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
894 name.c_str(), thread_id).c_str());
895 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700896 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700897 return thread;
898 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800899 const uint64_t total_delay = NanoTime() - start_time;
900 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700901 ThreadSuspendByThreadIdWarning(WARNING, "Thread suspension timed out", thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800902 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800903 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700904 }
905 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700906 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800907 } else if (sleep_us == 0 &&
908 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
909 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
910 // excessive CPU usage.
911 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700912 }
913 }
914 // Release locks and come out of runnable state.
915 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800916 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
917 ThreadSuspendSleep(sleep_us);
918 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700919 }
920}
921
922Thread* ThreadList::FindThreadByThreadId(uint32_t thin_lock_id) {
923 Thread* self = Thread::Current();
924 MutexLock mu(self, *Locks::thread_list_lock_);
925 for (const auto& thread : list_) {
926 if (thread->GetThreadId() == thin_lock_id) {
927 CHECK(thread == self || thread->IsSuspended());
928 return thread;
929 }
930 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700931 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700932}
933
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700934void ThreadList::SuspendAllForDebugger() {
935 Thread* self = Thread::Current();
936 Thread* debug_thread = Dbg::GetDebugThread();
937
938 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
939
Yu Lieac44242015-06-29 10:50:03 +0800940 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700941 // Block on the mutator lock until all Runnable threads release their share of access then
942 // immediately unlock again.
943#if HAVE_TIMED_RWLOCK
944 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700945 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100946 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700947 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700948 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700949 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700950#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700951 Locks::mutator_lock_->ExclusiveLock(self);
952 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700953#endif
Mathieu Chartier9450c6c2015-11-07 11:55:23 -0800954 // Disabled for the following race condition:
955 // Thread 1 calls SuspendAllForDebugger, gets preempted after pulsing the mutator lock.
956 // Thread 2 calls SuspendAll and SetStateUnsafe (perhaps from Dbg::Disconnected).
957 // Thread 1 fails assertion that all threads are suspended due to thread 2 being in a runnable
958 // state (from SetStateUnsafe).
959 // AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700960
Sebastien Hertzed2be172014-08-19 15:33:43 +0200961 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700962}
963
Elliott Hughes475fc232011-10-25 15:00:35 -0700964void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100965 Thread* const self = Thread::Current();
966 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700967
Elliott Hughes475fc232011-10-25 15:00:35 -0700968 // The debugger thread must not suspend itself due to debugger activity!
969 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700970 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800971 CHECK_NE(self->GetState(), kRunnable);
972 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700973
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200974 // The debugger may have detached while we were executing an invoke request. In that case, we
975 // must not suspend ourself.
976 DebugInvokeReq* pReq = self->GetInvokeReq();
977 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
978 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800979 // Collisions with other suspends aren't really interesting. We want
980 // to ensure that we're the only one fiddling with the suspend count
981 // though.
982 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800983 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700984 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200985
986 VLOG(threads) << *self << " self-suspending (debugger)";
987 } else {
988 // We must no longer be subject to debugger suspension.
989 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
990 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
991
992 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800993 }
Elliott Hughes475fc232011-10-25 15:00:35 -0700994
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200995 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +0100996 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200997 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +0100998 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200999 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +01001000 }
1001
Elliott Hughes475fc232011-10-25 15:00:35 -07001002 // Tell JDWP that we've completed suspension. The JDWP thread can't
1003 // tell us to resume before we're fully asleep because we hold the
1004 // suspend count lock.
1005 Dbg::ClearWaitForEventThread();
1006
jeffhaoa77f0f62012-12-05 17:19:31 -08001007 {
1008 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001009 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001010 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001011 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001012 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +02001013 // can happen when we suspend then resume all threads to
1014 // update instrumentation or compute monitor info. This can
1015 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001016 // dump event is pending (assuming SignalCatcher was resumed for
1017 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001018 VLOG(jdwp) << *self << " still suspended after undo "
1019 << "(suspend count=" << self->GetSuspendCount() << ", "
1020 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001021 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001022 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001023 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001024 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001025
Sebastien Hertz1558b572015-02-25 15:05:59 +01001026 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001027 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001028}
1029
Sebastien Hertz253fa552014-10-14 17:27:15 +02001030void ThreadList::ResumeAllForDebugger() {
1031 Thread* self = Thread::Current();
1032 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001033
1034 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1035
1036 // Threads can't resume if we exclusively hold the mutator lock.
1037 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1038
1039 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001040 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001041 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001042 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001043 // Update global suspend all state for attaching threads.
1044 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001045 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001046 --suspend_all_count_;
1047 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001048 } else {
1049 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001050 // suspend them all before. That may happen if a debugger tries
1051 // to resume some suspended threads (with suspend count == 1)
1052 // at once with a VirtualMachine.Resume command. Let's print a
1053 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001054 LOG(WARNING) << "Debugger attempted to resume all threads without "
1055 << "having suspended them all before.";
1056 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001057 // Decrement everybody's suspend count (except our own).
1058 for (const auto& thread : list_) {
1059 if (thread == self || thread == debug_thread) {
1060 continue;
1061 }
1062 if (thread->GetDebugSuspendCount() == 0) {
1063 // This thread may have been individually resumed with ThreadReference.Resume.
1064 continue;
1065 }
1066 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001067 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001068 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001069 }
1070 }
1071
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001072 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001073 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1074 Thread::resume_cond_->Broadcast(self);
1075 }
1076
1077 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1078}
1079
Elliott Hughes234ab152011-10-26 14:02:26 -07001080void ThreadList::UndoDebuggerSuspensions() {
1081 Thread* self = Thread::Current();
1082
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001083 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001084
1085 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001086 MutexLock mu(self, *Locks::thread_list_lock_);
1087 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001088 // Update global suspend all state for attaching threads.
1089 suspend_all_count_ -= debug_suspend_all_count_;
1090 debug_suspend_all_count_ = 0;
1091 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001092 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001093 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001094 continue;
1095 }
Yu Lieac44242015-06-29 10:50:03 +08001096 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001097 }
1098 }
1099
1100 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001101 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001102 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001103 }
1104
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001105 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001106}
1107
Elliott Hughese52e49b2012-04-02 16:05:44 -07001108void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001109 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001110 Thread* self = Thread::Current();
1111 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001112 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001113 {
1114 // No more threads can be born after we start to shutdown.
1115 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001116 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001117 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1118 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001119 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001120 // Also wait for any threads that are unregistering to finish. This is required so that no
1121 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1122 // threads since they could unregister at the wrong time.
1123 bool done = unregistering_count_ == 0;
1124 if (done) {
1125 for (const auto& thread : list_) {
1126 if (thread != self && !thread->IsDaemon()) {
1127 done = false;
1128 break;
1129 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001130 }
1131 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001132 if (done) {
1133 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001134 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001135 // Wait for another thread to exit before re-checking.
1136 Locks::thread_exit_cond_->Wait(self);
1137 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001138}
1139
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001140void ThreadList::SuspendAllDaemonThreadsForShutdown() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001141 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001142 Thread* self = Thread::Current();
1143 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier62597d12016-01-11 10:19:06 -08001144 size_t daemons_left = 0;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001145 { // Tell all the daemons it's time to suspend.
Ian Rogers81d425b2012-09-27 16:03:43 -07001146 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001147 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001148 // This is only run after all non-daemon threads have exited, so the remainder should all be
1149 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001150 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001151 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001152 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier62597d12016-01-11 10:19:06 -08001153 ++daemons_left;
Elliott Hughese52e49b2012-04-02 16:05:44 -07001154 }
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001155 // We are shutting down the runtime, set the JNI functions of all the JNIEnvs to be
1156 // the sleep forever one.
1157 thread->GetJniEnv()->SetFunctionsToRuntimeShutdownFunctions();
Elliott Hughes038a8062011-09-18 14:12:41 -07001158 }
1159 }
Mathieu Chartier62597d12016-01-11 10:19:06 -08001160 // If we have any daemons left, wait 200ms to ensure they are not stuck in a place where they
1161 // are about to access runtime state and are not in a runnable state. Examples: Monitor code
1162 // or waking up from a condition variable. TODO: Try and see if there is a better way to wait
1163 // for daemon threads to be in a blocked state.
1164 if (daemons_left > 0) {
1165 static constexpr size_t kDaemonSleepTime = 200 * 1000;
1166 usleep(kDaemonSleepTime);
1167 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001168 // Give the threads a chance to suspend, complaining if they're slow.
1169 bool have_complained = false;
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001170 static constexpr size_t kTimeoutMicroseconds = 2000 * 1000;
1171 static constexpr size_t kSleepMicroseconds = 1000;
1172 for (size_t i = 0; i < kTimeoutMicroseconds / kSleepMicroseconds; ++i) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001173 bool all_suspended = true;
Mathieu Chartier02e25112013-08-14 16:14:24 -07001174 for (const auto& thread : list_) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001175 if (thread != self && thread->GetState() == kRunnable) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001176 if (!have_complained) {
1177 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1178 have_complained = true;
1179 }
1180 all_suspended = false;
1181 }
1182 }
1183 if (all_suspended) {
1184 return;
1185 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001186 usleep(kSleepMicroseconds);
Elliott Hughes038a8062011-09-18 14:12:41 -07001187 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001188 LOG(WARNING) << "timed out suspending all daemon threads";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001189}
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001190
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001191void ThreadList::Register(Thread* self) {
1192 DCHECK_EQ(self, Thread::Current());
1193
1194 if (VLOG_IS_ON(threads)) {
1195 std::ostringstream oss;
1196 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001197 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001198 }
1199
1200 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1201 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001202 MutexLock mu(self, *Locks::thread_list_lock_);
1203 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001204 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001205 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1206 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1207 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001208 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001209 }
Ian Rogers2966e132014-04-02 08:34:36 -07001210 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001211 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001212 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001213 CHECK(!Contains(self));
1214 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001215 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001216 // Initialize according to the state of the CC collector.
1217 bool is_gc_marking =
1218 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1219 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001220 bool weak_ref_access_enabled =
1221 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1222 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1223 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001224}
1225
1226void ThreadList::Unregister(Thread* self) {
1227 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001228 CHECK_NE(self->GetState(), kRunnable);
1229 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001230
1231 VLOG(threads) << "ThreadList::Unregister() " << *self;
1232
Mathieu Chartier91e56692015-03-03 13:51:04 -08001233 {
1234 MutexLock mu(self, *Locks::thread_list_lock_);
1235 ++unregistering_count_;
1236 }
1237
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001238 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001239 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1240 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1241 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1242 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001243 self->Destroy();
1244
Jeff Haoe094b872014-10-14 13:12:01 -07001245 // If tracing, remember thread id and name before thread exits.
1246 Trace::StoreExitingThreadInfo(self);
1247
Ian Rogersdd7624d2014-03-14 17:43:00 -07001248 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001249 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001250 // Remove and delete the Thread* while holding the thread_list_lock_ and
1251 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001252 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001253 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001254 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001255 std::string thread_name;
1256 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001257 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001258 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001259 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001260 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001261 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001262 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001263 if (!self->IsSuspended()) {
1264 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001265 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001266 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001267 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001268 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001269 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001270 delete self;
1271
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001272 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1273 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1274 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1275 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001276
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001277 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1278 // (It may wish to reattach later.)
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001279#ifdef __ANDROID__
1280 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1281#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001282 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001283#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001284
1285 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001286 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1287 --unregistering_count_;
1288 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001289}
1290
1291void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001292 for (const auto& thread : list_) {
1293 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001294 }
1295}
1296
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001297void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001298 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001299 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001300 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001301 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001302}
1303
Ian Rogerscfaa4552012-11-26 21:00:08 -08001304uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001305 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001306 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1307 if (!allocated_ids_[i]) {
1308 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001309 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001310 }
1311 }
1312 LOG(FATAL) << "Out of internal thread ids";
1313 return 0;
1314}
1315
Ian Rogerscfaa4552012-11-26 21:00:08 -08001316void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001317 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001318 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001319 DCHECK(allocated_ids_[id]) << id;
1320 allocated_ids_.reset(id);
1321}
1322
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001323ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1324 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1325}
1326
1327ScopedSuspendAll::~ScopedSuspendAll() {
1328 Runtime::Current()->GetThreadList()->ResumeAll();
1329}
1330
Elliott Hughes8daa0922011-09-11 13:46:25 -07001331} // namespace art