blob: 21ecb150e8062da5b6778dce45aa40418797b15e [file] [log] [blame]
Elliott Hughes8daa0922011-09-11 13:46:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "thread_list.h"
18
Christopher Ferris6cff48f2014-01-26 21:36:13 -080019#include <backtrace/BacktraceMap.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070020#include <dirent.h>
Ian Rogersd9c4fc92013-10-01 19:45:43 -070021#include <ScopedLocalRef.h>
22#include <ScopedUtfChars.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070023#include <sys/types.h>
Elliott Hughes038a8062011-09-18 14:12:41 -070024#include <unistd.h>
25
Ian Rogersc7dd2952014-10-21 23:31:19 -070026#include <sstream>
27
Mathieu Chartier70a596d2014-12-17 14:56:47 -080028#include "base/histogram-inl.h"
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -070029#include "base/mutex-inl.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080030#include "base/systrace.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010031#include "base/time_utils.h"
Sameer Abu Asala8439542013-02-14 16:06:42 -080032#include "base/timing_logger.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070033#include "debugger.h"
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -070034#include "gc/collector/concurrent_copying.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070035#include "jni_internal.h"
36#include "lock_word.h"
37#include "monitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070038#include "native_stack_dump.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070039#include "scoped_thread_state_change.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080040#include "thread.h"
Jeff Haoe094b872014-10-14 13:12:01 -070041#include "trace.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070042#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070043
Yu Lieac44242015-06-29 10:50:03 +080044#if ART_USE_FUTEXES
45#include "linux/futex.h"
46#include "sys/syscall.h"
47#ifndef SYS_futex
48#define SYS_futex __NR_futex
49#endif
50#endif // ART_USE_FUTEXES
51
Elliott Hughes8daa0922011-09-11 13:46:25 -070052namespace art {
53
Mathieu Chartier251755c2014-07-15 18:10:25 -070054static constexpr uint64_t kLongThreadSuspendThreshold = MsToNs(5);
Mathieu Chartier99143862015-02-03 14:26:46 -080055static constexpr uint64_t kThreadSuspendTimeoutMs = 30 * 1000; // 30s.
56// Use 0 since we want to yield to prevent blocking for an unpredictable amount of time.
57static constexpr useconds_t kThreadSuspendInitialSleepUs = 0;
58static constexpr useconds_t kThreadSuspendMaxYieldUs = 3000;
59static constexpr useconds_t kThreadSuspendMaxSleepUs = 5000;
Mathieu Chartier251755c2014-07-15 18:10:25 -070060
Andreas Gampe8d1594d2016-03-01 14:38:37 -080061// Whether we should try to dump the native stack of unattached threads. See commit ed8b723 for
62// some history.
Andreas Gampea3e8fc32016-06-13 16:15:33 -070063// Turned off again. b/29248079
64static constexpr bool kDumpUnattachedThreadNativeStack = false;
Andreas Gampe8d1594d2016-03-01 14:38:37 -080065
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080066ThreadList::ThreadList()
Mathieu Chartierb56200b2015-10-29 10:41:51 -070067 : suspend_all_count_(0),
68 debug_suspend_all_count_(0),
69 unregistering_count_(0),
70 suspend_all_historam_("suspend all histogram", 16, 64),
71 long_suspend_(false) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -080072 CHECK(Monitor::IsValidLockWord(LockWord::FromThinLockId(kMaxThreadId, 1, 0U)));
Elliott Hughes8daa0922011-09-11 13:46:25 -070073}
74
75ThreadList::~ThreadList() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080076 ScopedTrace trace(__PRETTY_FUNCTION__);
Elliott Hughese52e49b2012-04-02 16:05:44 -070077 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070078 // We need to detach the current thread here in case there's another thread waiting to join with
79 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070080 bool contains = false;
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080081 Thread* self = Thread::Current();
Mathieu Chartierfec72f42014-10-09 12:57:58 -070082 {
Mathieu Chartierfec72f42014-10-09 12:57:58 -070083 MutexLock mu(self, *Locks::thread_list_lock_);
84 contains = Contains(self);
85 }
86 if (contains) {
Elliott Hughes8daa0922011-09-11 13:46:25 -070087 Runtime::Current()->DetachCurrentThread();
88 }
Elliott Hughes6a144332012-04-03 13:07:11 -070089 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartier51168372015-08-12 16:40:32 -070090 // Disable GC and wait for GC to complete in case there are still daemon threads doing
91 // allocations.
92 gc::Heap* const heap = Runtime::Current()->GetHeap();
93 heap->DisableGCForShutdown();
94 // In case a GC is in progress, wait for it to finish.
95 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
Ian Rogers00f7d0e2012-07-19 15:28:27 -070096 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
97 // Thread::Init.
Mathieu Chartier4d87df62016-01-07 15:14:19 -080098 SuspendAllDaemonThreadsForShutdown();
Elliott Hughes8daa0922011-09-11 13:46:25 -070099}
100
101bool ThreadList::Contains(Thread* thread) {
102 return find(list_.begin(), list_.end(), thread) != list_.end();
103}
104
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700105bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -0700106 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700107 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700108 return true;
109 }
110 }
111 return false;
112}
113
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700114pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700115 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700116}
117
Mathieu Chartier590fee92013-09-13 13:46:47 -0700118void ThreadList::DumpNativeStacks(std::ostream& os) {
119 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800120 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700121 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700122 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800123 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700124 os << "\n";
125 }
126}
127
Elliott Hughesc967f782012-04-16 10:23:15 -0700128void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800129 {
130 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800131 // Only print if we have samples.
132 if (suspend_all_historam_.SampleSize() > 0) {
133 Histogram<uint64_t>::CumulativeData data;
134 suspend_all_historam_.CreateHistogram(&data);
135 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
136 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800137 }
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000138 bool dump_native_stack = Runtime::Current()->GetDumpNativeStackOnSigQuit();
139 Dump(os, dump_native_stack);
140 DumpUnattachedThreads(os, dump_native_stack);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700141}
142
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000143static void DumpUnattachedThread(std::ostream& os, pid_t tid, bool dump_native_stack)
144 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700145 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800146 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700147 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700148 DumpKernelStack(os, tid, " kernel: ", false);
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000149 if (dump_native_stack && kDumpUnattachedThreadNativeStack) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800150 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700151 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700152 os << "\n";
153}
154
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000155void ThreadList::DumpUnattachedThreads(std::ostream& os, bool dump_native_stack) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700156 DIR* d = opendir("/proc/self/task");
157 if (!d) {
158 return;
159 }
160
Ian Rogers50b35e22012-10-04 10:09:15 -0700161 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700162 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700163 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700164 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700165 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700166 if (!*end) {
167 bool contains;
168 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700169 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700170 contains = Contains(tid);
171 }
172 if (!contains) {
Nicolas Geoffrayd3c59652016-03-17 09:35:04 +0000173 DumpUnattachedThread(os, tid, dump_native_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700174 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700175 }
176 }
177 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800178}
179
Mathieu Chartier47c19592016-03-07 11:59:01 -0800180// Dump checkpoint timeout in milliseconds. Larger amount on the target, since the device could be
181// overloaded with ANR dumps.
182static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 100000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800183
Ian Rogers7b078e82014-09-10 14:44:24 -0700184// A closure used by Thread::Dump.
185class DumpCheckpoint FINAL : public Closure {
186 public:
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000187 DumpCheckpoint(std::ostream* os, bool dump_native_stack)
188 : os_(os),
189 barrier_(0),
190 backtrace_map_(dump_native_stack ? BacktraceMap::Create(getpid()) : nullptr),
191 dump_native_stack_(dump_native_stack) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700192
193 void Run(Thread* thread) OVERRIDE {
194 // Note thread and self may not be equal if thread was already suspended at the point of the
195 // request.
196 Thread* self = Thread::Current();
197 std::ostringstream local_os;
198 {
199 ScopedObjectAccess soa(self);
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000200 thread->Dump(local_os, dump_native_stack_, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700201 }
202 local_os << "\n";
203 {
204 // Use the logging lock to ensure serialization when writing to the common ostream.
205 MutexLock mu(self, *Locks::logging_lock_);
206 *os_ << local_os.str();
207 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700208 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700209 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700210
211 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
212 Thread* self = Thread::Current();
213 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800214 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700215 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000216 // Avoid a recursive abort.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700217 LOG((kIsDebugBuild && (gAborting == 0)) ? ::android::base::FATAL : ::android::base::ERROR)
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000218 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700219 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700220 }
221
222 private:
223 // The common stream that will accumulate all the dumps.
224 std::ostream* const os_;
225 // The barrier to be passed through and for the requestor to wait upon.
226 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800227 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
228 std::unique_ptr<BacktraceMap> backtrace_map_;
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000229 // Whether we should dump the native stack.
230 const bool dump_native_stack_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700231};
232
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000233void ThreadList::Dump(std::ostream& os, bool dump_native_stack) {
Ian Rogers7b078e82014-09-10 14:44:24 -0700234 {
235 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
236 os << "DALVIK THREADS (" << list_.size() << "):\n";
237 }
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000238 DumpCheckpoint checkpoint(&os, dump_native_stack);
Mathieu Chartiere99f5322016-06-10 17:04:20 -0700239 size_t threads_running_checkpoint;
240 {
241 // Use SOA to prevent deadlocks if multiple threads are calling Dump() at the same time.
242 ScopedObjectAccess soa(Thread::Current());
243 threads_running_checkpoint = RunCheckpoint(&checkpoint);
244 }
Lei Lidd9943d2015-02-02 14:24:44 +0800245 if (threads_running_checkpoint != 0) {
246 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
247 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700248}
249
Ian Rogers50b35e22012-10-04 10:09:15 -0700250void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
251 MutexLock mu(self, *Locks::thread_list_lock_);
252 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700253 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800254 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700255 CHECK(thread->IsSuspended())
256 << "\nUnsuspended thread: <<" << *thread << "\n"
257 << "self: <<" << *Thread::Current();
258 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700259 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700260}
261
Ian Rogers66aee5c2012-08-15 17:17:47 -0700262#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700263// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800264NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700265 Runtime* runtime = Runtime::Current();
266 std::ostringstream ss;
267 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700268 Locks::mutator_lock_->Dump(ss);
269 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700270 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700271 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800272 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700273}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700274#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700275
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800276// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800277// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
278// we use sched_yield instead of calling usleep.
279static void ThreadSuspendSleep(useconds_t delay_us) {
280 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800281 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800282 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800283 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800284 }
285}
286
Hiroshi Yamauchifebd0cf2016-09-14 19:31:25 -0700287size_t ThreadList::RunCheckpoint(Closure* checkpoint_function, Closure* callback) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700288 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800289 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
290 Locks::thread_list_lock_->AssertNotHeld(self);
291 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700292
293 std::vector<Thread*> suspended_count_modified_threads;
294 size_t count = 0;
295 {
296 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
297 // manually called.
298 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700299 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700300 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700301 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700302 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700303 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700304 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800305 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700306 break;
307 } else {
308 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700309 // The thread switched back to runnable.
310 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700311 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700312 continue;
313 }
Yu Lieac44242015-06-29 10:50:03 +0800314 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700315 suspended_count_modified_threads.push_back(thread);
316 break;
317 }
318 }
319 }
320 }
Hiroshi Yamauchifebd0cf2016-09-14 19:31:25 -0700321 // Run the callback to be called inside this critical section.
322 if (callback != nullptr) {
323 callback->Run(self);
324 }
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700325 }
326
327 // Run the checkpoint on ourself while we wait for threads to suspend.
328 checkpoint_function->Run(self);
329
330 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700331 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700332 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800333 if (ATRACE_ENABLED()) {
334 std::ostringstream oss;
335 thread->ShortDump(oss);
336 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
337 }
338 // Busy wait until the thread is suspended.
339 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700340 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800341 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700342 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800343 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800344 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800345 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
346 ATRACE_END();
347 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
348 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
349 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700350 }
351 }
352 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700353 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700354 {
355 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800356 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700357 }
358 }
359
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800360 {
361 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
362 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
363 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
364 Thread::resume_cond_->Broadcast(self);
365 }
366
Lei Lidd9943d2015-02-02 14:24:44 +0800367 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700368}
369
Dave Allison39c3bfb2014-01-28 18:33:52 -0800370// Request that a checkpoint function be run on all active (non-suspended)
371// threads. Returns the number of successful requests.
372size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
373 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700374 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
375 Locks::thread_list_lock_->AssertNotHeld(self);
376 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
377 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800378
379 size_t count = 0;
380 {
381 // Call a checkpoint function for each non-suspended thread.
382 MutexLock mu(self, *Locks::thread_list_lock_);
383 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
384 for (const auto& thread : list_) {
385 if (thread != self) {
386 if (thread->RequestCheckpoint(checkpoint_function)) {
387 // This thread will run its checkpoint some time in the near future.
388 count++;
389 }
390 }
391 }
392 }
393
394 // Return the number of threads that will run the checkpoint function.
395 return count;
396}
397
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800398// A checkpoint/suspend-all hybrid to switch thread roots from
399// from-space to to-space refs. Used to synchronize threads at a point
400// to mark the initiation of marking while maintaining the to-space
401// invariant.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700402size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor,
403 Closure* flip_callback,
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800404 gc::collector::GarbageCollector* collector) {
405 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
406 const uint64_t start_time = NanoTime();
407 Thread* self = Thread::Current();
408 Locks::mutator_lock_->AssertNotHeld(self);
409 Locks::thread_list_lock_->AssertNotHeld(self);
410 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
411 CHECK_NE(self->GetState(), kRunnable);
412
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700413 collector->GetHeap()->ThreadFlipBegin(self); // Sync with JNI critical calls.
414
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700415 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800416
417 // Run the flip callback for the collector.
418 Locks::mutator_lock_->ExclusiveLock(self);
419 flip_callback->Run(self);
420 Locks::mutator_lock_->ExclusiveUnlock(self);
421 collector->RegisterPause(NanoTime() - start_time);
422
423 // Resume runnable threads.
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700424 size_t runnable_thread_count = 0;
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700425 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800426 {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700427 TimingLogger::ScopedTiming split2("ResumeRunnableThreads", collector->GetTimings());
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800428 MutexLock mu(self, *Locks::thread_list_lock_);
429 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
430 --suspend_all_count_;
431 for (const auto& thread : list_) {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700432 // Set the flip function for all threads because Thread::DumpState/DumpJavaStack() (invoked by
433 // a checkpoint) may cause the flip function to be run for a runnable/suspended thread before
434 // a runnable thread runs it for itself or we run it for a suspended thread below.
435 thread->SetFlipFunction(thread_flip_visitor);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800436 if (thread == self) {
437 continue;
438 }
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700439 // Resume early the threads that were runnable but are suspended just for this thread flip or
440 // about to transition from non-runnable (eg. kNative at the SOA entry in a JNI function) to
441 // runnable (both cases waiting inside Thread::TransitionFromSuspendedToRunnable), or waiting
442 // for the thread flip to end at the JNI critical section entry (kWaitingForGcThreadFlip),
443 ThreadState state = thread->GetState();
Hiroshi Yamauchi15af34c2016-09-26 16:56:24 -0700444 if ((state == kWaitingForGcThreadFlip || thread->IsTransitioningToRunnable()) &&
445 thread->GetSuspendCount() == 1) {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800446 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800447 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700448 ++runnable_thread_count;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800449 } else {
450 other_threads.push_back(thread);
451 }
452 }
453 Thread::resume_cond_->Broadcast(self);
454 }
455
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700456 collector->GetHeap()->ThreadFlipEnd(self);
457
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800458 // Run the closure on the other threads and let them resume.
459 {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700460 TimingLogger::ScopedTiming split3("FlipOtherThreads", collector->GetTimings());
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800461 ReaderMutexLock mu(self, *Locks::mutator_lock_);
462 for (const auto& thread : other_threads) {
463 Closure* flip_func = thread->GetFlipFunction();
464 if (flip_func != nullptr) {
465 flip_func->Run(thread);
466 }
467 }
468 // Run it for self.
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700469 Closure* flip_func = self->GetFlipFunction();
470 if (flip_func != nullptr) {
471 flip_func->Run(self);
472 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800473 }
474
475 // Resume other threads.
476 {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700477 TimingLogger::ScopedTiming split4("ResumeOtherThreads", collector->GetTimings());
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800478 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
479 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800480 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800481 }
482 Thread::resume_cond_->Broadcast(self);
483 }
484
Hiroshi Yamauchiee235822016-08-19 17:03:27 -0700485 return runnable_thread_count + other_threads.size() + 1; // +1 for self.
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800486}
487
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700488void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700489 Thread* self = Thread::Current();
490
Jeff Haoc5d824a2014-07-28 18:35:38 -0700491 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700492 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700493 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700494 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700495 }
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800496 {
497 ScopedTrace trace("Suspending mutator threads");
498 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700499
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800500 SuspendAllInternal(self, self);
501 // All threads are known to have suspended (but a thread may still own the mutator lock)
502 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700503#if HAVE_TIMED_RWLOCK
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800504 while (true) {
505 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
506 break;
507 } else if (!long_suspend_) {
508 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
509 // could result in a thread suspend timeout.
510 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
511 UnsafeLogFatalForThreadSuspendAllTimeout();
512 }
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700513 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700514#else
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800515 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700516#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700517
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800518 long_suspend_ = long_suspend;
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700519
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800520 const uint64_t end_time = NanoTime();
521 const uint64_t suspend_time = end_time - start_time;
522 suspend_all_historam_.AdjustAndAddValue(suspend_time);
523 if (suspend_time > kLongThreadSuspendThreshold) {
524 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
525 }
526
527 if (kDebugLocking) {
528 // Debug check that all threads are suspended.
529 AssertThreadsAreSuspended(self, self);
530 }
Mathieu Chartier251755c2014-07-15 18:10:25 -0700531 }
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700532 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700533
Jeff Haoc5d824a2014-07-28 18:35:38 -0700534 if (self != nullptr) {
535 VLOG(threads) << *self << " SuspendAll complete";
536 } else {
537 VLOG(threads) << "Thread[null] SuspendAll complete";
538 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700539}
540
Yu Lieac44242015-06-29 10:50:03 +0800541// Ensures all threads running Java suspend and that those not running Java don't start.
542// Debugger thread might be set to kRunnable for a short period of time after the
543// SuspendAllInternal. This is safe because it will be set back to suspended state before
544// the SuspendAll returns.
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700545void ThreadList::SuspendAllInternal(Thread* self,
546 Thread* ignore1,
547 Thread* ignore2,
Yu Lieac44242015-06-29 10:50:03 +0800548 bool debug_suspend) {
549 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
550 Locks::thread_list_lock_->AssertNotHeld(self);
551 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
552 if (kDebugLocking && self != nullptr) {
553 CHECK_NE(self->GetState(), kRunnable);
554 }
555
556 // First request that all threads suspend, then wait for them to suspend before
557 // returning. This suspension scheme also relies on other behaviour:
558 // 1. Threads cannot be deleted while they are suspended or have a suspend-
559 // request flag set - (see Unregister() below).
560 // 2. When threads are created, they are created in a suspended state (actually
561 // kNative) and will never begin executing Java code without first checking
562 // the suspend-request flag.
563
564 // The atomic counter for number of threads that need to pass the barrier.
565 AtomicInteger pending_threads;
566 uint32_t num_ignored = 0;
567 if (ignore1 != nullptr) {
568 ++num_ignored;
569 }
570 if (ignore2 != nullptr && ignore1 != ignore2) {
571 ++num_ignored;
572 }
573 {
574 MutexLock mu(self, *Locks::thread_list_lock_);
575 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
576 // Update global suspend all state for attaching threads.
577 ++suspend_all_count_;
578 if (debug_suspend)
579 ++debug_suspend_all_count_;
580 pending_threads.StoreRelaxed(list_.size() - num_ignored);
581 // Increment everybody's suspend count (except those that should be ignored).
582 for (const auto& thread : list_) {
583 if (thread == ignore1 || thread == ignore2) {
584 continue;
585 }
586 VLOG(threads) << "requesting thread suspend: " << *thread;
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -0700587 thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend);
Yu Lieac44242015-06-29 10:50:03 +0800588
589 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
590 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
591 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
592 if (thread->IsSuspended()) {
593 // Only clear the counter for the current thread.
594 thread->ClearSuspendBarrier(&pending_threads);
595 pending_threads.FetchAndSubSequentiallyConsistent(1);
596 }
597 }
598 }
599
600 // Wait for the barrier to be passed by all runnable threads. This wait
601 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700602#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800603 timespec wait_timeout;
604 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700605#endif
Yu Lieac44242015-06-29 10:50:03 +0800606 while (true) {
607 int32_t cur_val = pending_threads.LoadRelaxed();
608 if (LIKELY(cur_val > 0)) {
609#if ART_USE_FUTEXES
610 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
611 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
612 if ((errno != EAGAIN) && (errno != EINTR)) {
613 if (errno == ETIMEDOUT) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700614 LOG(kIsDebugBuild ? ::android::base::FATAL : ::android::base::ERROR)
615 << "Unexpected time out during suspend all.";
Yu Lieac44242015-06-29 10:50:03 +0800616 } else {
617 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
618 }
619 }
Vladimir Markod778cd62016-07-05 17:29:55 +0100620 } // else re-check pending_threads in the next iteration (this may be a spurious wake-up).
Yu Lieac44242015-06-29 10:50:03 +0800621#else
622 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
623#endif
624 } else {
625 CHECK_EQ(cur_val, 0);
626 break;
627 }
628 }
629}
630
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700631void ThreadList::ResumeAll() {
632 Thread* self = Thread::Current();
633
Jeff Haoc5d824a2014-07-28 18:35:38 -0700634 if (self != nullptr) {
635 VLOG(threads) << *self << " ResumeAll starting";
636 } else {
637 VLOG(threads) << "Thread[null] ResumeAll starting";
638 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700639
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700640 ATRACE_END();
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -0800641
642 ScopedTrace trace("Resuming mutator threads");
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700643
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800644 if (kDebugLocking) {
645 // Debug check that all threads are suspended.
646 AssertThreadsAreSuspended(self, self);
647 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700648
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700649 long_suspend_ = false;
650
Ian Rogers81d425b2012-09-27 16:03:43 -0700651 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700652 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700653 MutexLock mu(self, *Locks::thread_list_lock_);
654 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700655 // Update global suspend all state for attaching threads.
656 --suspend_all_count_;
657 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700658 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700659 if (thread == self) {
660 continue;
661 }
Yu Lieac44242015-06-29 10:50:03 +0800662 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700663 }
664
665 // Broadcast a notification to all suspended threads, some or all of
666 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700667 if (self != nullptr) {
668 VLOG(threads) << *self << " ResumeAll waking others";
669 } else {
670 VLOG(threads) << "Thread[null] ResumeAll waking others";
671 }
Ian Rogersc604d732012-10-14 16:09:54 -0700672 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700673 }
Jeff Haoc5d824a2014-07-28 18:35:38 -0700674
675 if (self != nullptr) {
676 VLOG(threads) << *self << " ResumeAll complete";
677 } else {
678 VLOG(threads) << "Thread[null] ResumeAll complete";
679 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700680}
681
682void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800683 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
684 ATRACE_END();
685
Ian Rogers81d425b2012-09-27 16:03:43 -0700686 Thread* self = Thread::Current();
687 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700688 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
689 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700690
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700691 {
692 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700693 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700694 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700695 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
696 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700697 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700698 // We only expect threads within the thread-list to have been suspended otherwise we can't
699 // stop such threads from delete-ing themselves.
700 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
701 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700702 return;
703 }
Yu Lieac44242015-06-29 10:50:03 +0800704 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700705 }
706
707 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700708 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700709 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700710 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700711 }
712
Brian Carlstromba32de42014-08-27 23:43:46 -0700713 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700714}
Elliott Hughes01158d72011-09-19 19:47:10 -0700715
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700716static void ThreadSuspendByPeerWarning(Thread* self,
717 LogSeverity severity,
718 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700719 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700720 JNIEnvExt* env = self->GetJniEnv();
721 ScopedLocalRef<jstring>
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700722 scoped_name_string(env, static_cast<jstring>(env->GetObjectField(
723 peer, WellKnownClasses::java_lang_Thread_name)));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700724 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700725 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700726 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700727 env->ExceptionClear();
728 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700729 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700730 }
731}
732
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700733Thread* ThreadList::SuspendThreadByPeer(jobject peer,
734 bool request_suspension,
735 bool debug_suspension,
736 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800737 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800738 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700739 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800740 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800741 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700742 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700743 while (true) {
744 Thread* thread;
745 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700746 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
747 // is requesting another suspend, to avoid deadlock, by requiring this function be called
748 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
749 // than request thread suspension, to avoid potential cycles in threads requesting each other
750 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700751 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800752 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700753 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700754 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800755 if (suspended_thread != nullptr) {
756 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
757 // If we incremented the suspend count but the thread reset its peer, we need to
758 // re-decrement it since it is shutting down and may deadlock the runtime in
759 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800760 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800761 }
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700762 ThreadSuspendByPeerWarning(self,
763 ::android::base::WARNING,
764 "No such thread for suspend",
765 peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700766 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700767 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700768 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800769 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700770 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
771 << reinterpret_cast<void*>(thread);
772 return nullptr;
773 }
774 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700775 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800776 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700777 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800778 if (self->GetSuspendCount() > 0) {
779 // We hold the suspend count lock but another thread is trying to suspend us. Its not
780 // safe to try to suspend another thread in case we get a cycle. Start the loop again
781 // which will allow this thread to be suspended.
782 continue;
783 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800784 CHECK(suspended_thread == nullptr);
785 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800786 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700787 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700788 } else {
789 // If the caller isn't requesting suspension, a suspension should have already occurred.
790 CHECK_GT(thread->GetSuspendCount(), 0);
791 }
792 // IsSuspended on the current thread will fail as the current thread is changed into
793 // Runnable above. As the suspend count is now raised if this is the current thread
794 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
795 // to just explicitly handle the current thread in the callers to this code.
796 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
797 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
798 // count, or else we've waited and it has self suspended) or is the current thread, we're
799 // done.
800 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700801 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800802 if (ATRACE_ENABLED()) {
803 std::string name;
804 thread->GetThreadName(name);
805 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
806 peer).c_str());
807 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700808 return thread;
809 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800810 const uint64_t total_delay = NanoTime() - start_time;
811 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700812 ThreadSuspendByPeerWarning(self,
813 ::android::base::FATAL,
Andreas Gamped6e54bb2016-09-26 14:07:57 -0700814 "Thread suspension timed out",
815 peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800816 if (suspended_thread != nullptr) {
817 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800818 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700819 }
820 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700821 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800822 } else if (sleep_us == 0 &&
823 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
824 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
825 // excessive CPU usage.
826 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700827 }
828 }
829 // Release locks and come out of runnable state.
830 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800831 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
832 ThreadSuspendSleep(sleep_us);
833 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
834 // all if possible. This shouldn't be an issue since time to suspend should always be small.
835 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700836 }
837}
838
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700839static void ThreadSuspendByThreadIdWarning(LogSeverity severity,
840 const char* message,
Ian Rogersc7dd2952014-10-21 23:31:19 -0700841 uint32_t thread_id) {
842 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700843}
844
Mathieu Chartierb56200b2015-10-29 10:41:51 -0700845Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id,
846 bool debug_suspension,
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700847 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800848 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800849 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700850 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800851 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800852 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700853 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700854 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700855 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700856 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700857 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
858 // is requesting another suspend, to avoid deadlock, by requiring this function be called
859 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
860 // than request thread suspension, to avoid potential cycles in threads requesting each other
861 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700862 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800863 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700864 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700865 for (const auto& it : list_) {
866 if (it->GetThreadId() == thread_id) {
867 thread = it;
868 break;
869 }
870 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800871 if (thread == nullptr) {
872 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
873 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700874 // There's a race in inflating a lock and the owner giving up ownership and then dying.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700875 ThreadSuspendByThreadIdWarning(::android::base::WARNING,
876 "No such thread id for suspend",
877 thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700878 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700879 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700880 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
881 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700882 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800883 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800884 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800885 if (self->GetSuspendCount() > 0) {
886 // We hold the suspend count lock but another thread is trying to suspend us. Its not
887 // safe to try to suspend another thread in case we get a cycle. Start the loop again
888 // which will allow this thread to be suspended.
889 continue;
890 }
Yu Lieac44242015-06-29 10:50:03 +0800891 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800892 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700893 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800894 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700895 // If the caller isn't requesting suspension, a suspension should have already occurred.
896 CHECK_GT(thread->GetSuspendCount(), 0);
897 }
898 // IsSuspended on the current thread will fail as the current thread is changed into
899 // Runnable above. As the suspend count is now raised if this is the current thread
900 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
901 // to just explicitly handle the current thread in the callers to this code.
902 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
903 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
904 // count, or else we've waited and it has self suspended) or is the current thread, we're
905 // done.
906 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800907 if (ATRACE_ENABLED()) {
908 std::string name;
909 thread->GetThreadName(name);
910 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
911 name.c_str(), thread_id).c_str());
912 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700913 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700914 return thread;
915 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800916 const uint64_t total_delay = NanoTime() - start_time;
917 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700918 ThreadSuspendByThreadIdWarning(::android::base::WARNING,
919 "Thread suspension timed out",
920 thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800921 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800922 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700923 }
924 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700925 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800926 } else if (sleep_us == 0 &&
927 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
928 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
929 // excessive CPU usage.
930 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700931 }
932 }
933 // Release locks and come out of runnable state.
934 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800935 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
936 ThreadSuspendSleep(sleep_us);
937 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700938 }
939}
940
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700941Thread* ThreadList::FindThreadByThreadId(uint32_t thread_id) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700942 for (const auto& thread : list_) {
Mathieu Chartier61b3cd42016-04-18 11:43:29 -0700943 if (thread->GetThreadId() == thread_id) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700944 return thread;
945 }
946 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700947 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700948}
949
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700950void ThreadList::SuspendAllForDebugger() {
951 Thread* self = Thread::Current();
952 Thread* debug_thread = Dbg::GetDebugThread();
953
954 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
955
Yu Lieac44242015-06-29 10:50:03 +0800956 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700957 // Block on the mutator lock until all Runnable threads release their share of access then
958 // immediately unlock again.
959#if HAVE_TIMED_RWLOCK
960 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700961 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100962 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700963 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700964 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700965 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700966#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700967 Locks::mutator_lock_->ExclusiveLock(self);
968 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700969#endif
Mathieu Chartier9450c6c2015-11-07 11:55:23 -0800970 // Disabled for the following race condition:
971 // Thread 1 calls SuspendAllForDebugger, gets preempted after pulsing the mutator lock.
972 // Thread 2 calls SuspendAll and SetStateUnsafe (perhaps from Dbg::Disconnected).
973 // Thread 1 fails assertion that all threads are suspended due to thread 2 being in a runnable
974 // state (from SetStateUnsafe).
975 // AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700976
Sebastien Hertzed2be172014-08-19 15:33:43 +0200977 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700978}
979
Elliott Hughes475fc232011-10-25 15:00:35 -0700980void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100981 Thread* const self = Thread::Current();
982 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700983
Elliott Hughes475fc232011-10-25 15:00:35 -0700984 // The debugger thread must not suspend itself due to debugger activity!
985 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700986 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800987 CHECK_NE(self->GetState(), kRunnable);
988 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700989
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200990 // The debugger may have detached while we were executing an invoke request. In that case, we
991 // must not suspend ourself.
992 DebugInvokeReq* pReq = self->GetInvokeReq();
993 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
994 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800995 // Collisions with other suspends aren't really interesting. We want
996 // to ensure that we're the only one fiddling with the suspend count
997 // though.
998 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800999 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001000 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001001
1002 VLOG(threads) << *self << " self-suspending (debugger)";
1003 } else {
1004 // We must no longer be subject to debugger suspension.
1005 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1006 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
1007
1008 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -08001009 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001010
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001011 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +01001012 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001013 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +01001014 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02001015 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +01001016 }
1017
Elliott Hughes475fc232011-10-25 15:00:35 -07001018 // Tell JDWP that we've completed suspension. The JDWP thread can't
1019 // tell us to resume before we're fully asleep because we hold the
1020 // suspend count lock.
1021 Dbg::ClearWaitForEventThread();
1022
jeffhaoa77f0f62012-12-05 17:19:31 -08001023 {
1024 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001025 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001026 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001027 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001028 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +02001029 // can happen when we suspend then resume all threads to
1030 // update instrumentation or compute monitor info. This can
1031 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001032 // dump event is pending (assuming SignalCatcher was resumed for
1033 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001034 VLOG(jdwp) << *self << " still suspended after undo "
1035 << "(suspend count=" << self->GetSuspendCount() << ", "
1036 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001037 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001038 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001039 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001040 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001041
Sebastien Hertz1558b572015-02-25 15:05:59 +01001042 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001043 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001044}
1045
Sebastien Hertz253fa552014-10-14 17:27:15 +02001046void ThreadList::ResumeAllForDebugger() {
1047 Thread* self = Thread::Current();
1048 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001049
1050 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1051
1052 // Threads can't resume if we exclusively hold the mutator lock.
1053 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1054
1055 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001056 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001057 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001058 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001059 // Update global suspend all state for attaching threads.
1060 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001061 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001062 --suspend_all_count_;
1063 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001064 } else {
1065 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001066 // suspend them all before. That may happen if a debugger tries
1067 // to resume some suspended threads (with suspend count == 1)
1068 // at once with a VirtualMachine.Resume command. Let's print a
1069 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001070 LOG(WARNING) << "Debugger attempted to resume all threads without "
1071 << "having suspended them all before.";
1072 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001073 // Decrement everybody's suspend count (except our own).
1074 for (const auto& thread : list_) {
1075 if (thread == self || thread == debug_thread) {
1076 continue;
1077 }
1078 if (thread->GetDebugSuspendCount() == 0) {
1079 // This thread may have been individually resumed with ThreadReference.Resume.
1080 continue;
1081 }
1082 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001083 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001084 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001085 }
1086 }
1087
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001088 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001089 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1090 Thread::resume_cond_->Broadcast(self);
1091 }
1092
1093 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1094}
1095
Elliott Hughes234ab152011-10-26 14:02:26 -07001096void ThreadList::UndoDebuggerSuspensions() {
1097 Thread* self = Thread::Current();
1098
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001099 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001100
1101 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001102 MutexLock mu(self, *Locks::thread_list_lock_);
1103 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001104 // Update global suspend all state for attaching threads.
1105 suspend_all_count_ -= debug_suspend_all_count_;
1106 debug_suspend_all_count_ = 0;
1107 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001108 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001109 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001110 continue;
1111 }
Yu Lieac44242015-06-29 10:50:03 +08001112 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001113 }
1114 }
1115
1116 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001117 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001118 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001119 }
1120
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001121 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001122}
1123
Elliott Hughese52e49b2012-04-02 16:05:44 -07001124void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001125 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001126 Thread* self = Thread::Current();
1127 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001128 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001129 {
1130 // No more threads can be born after we start to shutdown.
1131 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001132 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001133 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1134 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001135 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001136 // Also wait for any threads that are unregistering to finish. This is required so that no
1137 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1138 // threads since they could unregister at the wrong time.
1139 bool done = unregistering_count_ == 0;
1140 if (done) {
1141 for (const auto& thread : list_) {
1142 if (thread != self && !thread->IsDaemon()) {
1143 done = false;
1144 break;
1145 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001146 }
1147 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001148 if (done) {
1149 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001150 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001151 // Wait for another thread to exit before re-checking.
1152 Locks::thread_exit_cond_->Wait(self);
1153 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001154}
1155
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001156void ThreadList::SuspendAllDaemonThreadsForShutdown() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001157 ScopedTrace trace(__PRETTY_FUNCTION__);
Ian Rogers81d425b2012-09-27 16:03:43 -07001158 Thread* self = Thread::Current();
Mathieu Chartier62597d12016-01-11 10:19:06 -08001159 size_t daemons_left = 0;
Nicolas Geoffrayaa45daa2016-06-20 15:58:32 +01001160 {
1161 // Tell all the daemons it's time to suspend.
1162 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers81d425b2012-09-27 16:03:43 -07001163 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001164 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001165 // This is only run after all non-daemon threads have exited, so the remainder should all be
1166 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001167 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001168 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001169 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier62597d12016-01-11 10:19:06 -08001170 ++daemons_left;
Elliott Hughese52e49b2012-04-02 16:05:44 -07001171 }
Mathieu Chartier4d87df62016-01-07 15:14:19 -08001172 // We are shutting down the runtime, set the JNI functions of all the JNIEnvs to be
1173 // the sleep forever one.
1174 thread->GetJniEnv()->SetFunctionsToRuntimeShutdownFunctions();
Elliott Hughes038a8062011-09-18 14:12:41 -07001175 }
1176 }
Mathieu Chartier62597d12016-01-11 10:19:06 -08001177 // If we have any daemons left, wait 200ms to ensure they are not stuck in a place where they
1178 // are about to access runtime state and are not in a runnable state. Examples: Monitor code
1179 // or waking up from a condition variable. TODO: Try and see if there is a better way to wait
1180 // for daemon threads to be in a blocked state.
1181 if (daemons_left > 0) {
1182 static constexpr size_t kDaemonSleepTime = 200 * 1000;
1183 usleep(kDaemonSleepTime);
1184 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001185 // Give the threads a chance to suspend, complaining if they're slow.
1186 bool have_complained = false;
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001187 static constexpr size_t kTimeoutMicroseconds = 2000 * 1000;
1188 static constexpr size_t kSleepMicroseconds = 1000;
1189 for (size_t i = 0; i < kTimeoutMicroseconds / kSleepMicroseconds; ++i) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001190 bool all_suspended = true;
Nicolas Geoffrayaa45daa2016-06-20 15:58:32 +01001191 {
1192 MutexLock mu(self, *Locks::thread_list_lock_);
1193 for (const auto& thread : list_) {
1194 if (thread != self && thread->GetState() == kRunnable) {
1195 if (!have_complained) {
1196 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1197 have_complained = true;
1198 }
1199 all_suspended = false;
Elliott Hughes038a8062011-09-18 14:12:41 -07001200 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001201 }
1202 }
1203 if (all_suspended) {
1204 return;
1205 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001206 usleep(kSleepMicroseconds);
Elliott Hughes038a8062011-09-18 14:12:41 -07001207 }
Mathieu Chartierba098ba2016-01-07 09:31:33 -08001208 LOG(WARNING) << "timed out suspending all daemon threads";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001209}
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001210
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001211void ThreadList::Register(Thread* self) {
1212 DCHECK_EQ(self, Thread::Current());
1213
1214 if (VLOG_IS_ON(threads)) {
1215 std::ostringstream oss;
1216 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001217 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001218 }
1219
1220 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1221 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001222 MutexLock mu(self, *Locks::thread_list_lock_);
1223 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001224 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001225 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1226 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1227 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001228 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001229 }
Ian Rogers2966e132014-04-02 08:34:36 -07001230 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001231 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001232 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001233 CHECK(!Contains(self));
1234 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001235 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001236 // Initialize according to the state of the CC collector.
1237 bool is_gc_marking =
1238 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1239 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001240 bool weak_ref_access_enabled =
1241 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1242 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1243 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001244}
1245
1246void ThreadList::Unregister(Thread* self) {
1247 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001248 CHECK_NE(self->GetState(), kRunnable);
1249 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001250
1251 VLOG(threads) << "ThreadList::Unregister() " << *self;
1252
Mathieu Chartier91e56692015-03-03 13:51:04 -08001253 {
1254 MutexLock mu(self, *Locks::thread_list_lock_);
1255 ++unregistering_count_;
1256 }
1257
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001258 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001259 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1260 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1261 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1262 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001263 self->Destroy();
1264
Jeff Haoe094b872014-10-14 13:12:01 -07001265 // If tracing, remember thread id and name before thread exits.
1266 Trace::StoreExitingThreadInfo(self);
1267
Ian Rogersdd7624d2014-03-14 17:43:00 -07001268 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001269 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001270 // Remove and delete the Thread* while holding the thread_list_lock_ and
1271 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001272 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001273 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001274 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001275 std::string thread_name;
1276 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001277 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001278 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001279 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001280 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001281 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001282 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001283 if (!self->IsSuspended()) {
1284 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001285 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001286 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001287 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001288 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001289 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001290 delete self;
1291
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001292 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1293 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1294 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1295 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001296
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001297 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1298 // (It may wish to reattach later.)
Bilyan Borisovbb661c02016-04-04 16:27:32 +01001299#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001300 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1301#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001302 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001303#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001304
1305 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001306 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1307 --unregistering_count_;
1308 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001309}
1310
1311void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001312 for (const auto& thread : list_) {
1313 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001314 }
1315}
1316
Mathieu Chartierf8a86b92016-06-14 17:08:47 -07001317void ThreadList::VisitRootsForSuspendedThreads(RootVisitor* visitor) {
1318 Thread* const self = Thread::Current();
1319 std::vector<Thread*> threads_to_visit;
1320
1321 // Tell threads to suspend and copy them into list.
1322 {
1323 MutexLock mu(self, *Locks::thread_list_lock_);
1324 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1325 for (Thread* thread : list_) {
1326 thread->ModifySuspendCount(self, +1, nullptr, false);
1327 if (thread == self || thread->IsSuspended()) {
1328 threads_to_visit.push_back(thread);
1329 } else {
1330 thread->ModifySuspendCount(self, -1, nullptr, false);
1331 }
1332 }
1333 }
1334
1335 // Visit roots without holding thread_list_lock_ and thread_suspend_count_lock_ to prevent lock
1336 // order violations.
1337 for (Thread* thread : threads_to_visit) {
1338 thread->VisitRoots(visitor);
1339 }
1340
1341 // Restore suspend counts.
1342 {
1343 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1344 for (Thread* thread : threads_to_visit) {
1345 thread->ModifySuspendCount(self, -1, nullptr, false);
1346 }
1347 }
1348}
1349
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001350void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001351 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001352 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001353 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001354 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001355}
1356
Ian Rogerscfaa4552012-11-26 21:00:08 -08001357uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001358 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001359 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1360 if (!allocated_ids_[i]) {
1361 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001362 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001363 }
1364 }
1365 LOG(FATAL) << "Out of internal thread ids";
1366 return 0;
1367}
1368
Ian Rogerscfaa4552012-11-26 21:00:08 -08001369void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001370 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001371 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001372 DCHECK(allocated_ids_[id]) << id;
1373 allocated_ids_.reset(id);
1374}
1375
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001376ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1377 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1378}
1379
1380ScopedSuspendAll::~ScopedSuspendAll() {
1381 Runtime::Current()->GetThreadList()->ResumeAll();
1382}
1383
Elliott Hughes8daa0922011-09-11 13:46:25 -07001384} // namespace art