blob: ed859cfbb029fd3eb03d9c9350599331c5e94193 [file] [log] [blame]
Elliott Hughes8daa0922011-09-11 13:46:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "thread_list.h"
18
Mathieu Chartier6f365cc2014-04-23 12:42:27 -070019#define ATRACE_TAG ATRACE_TAG_DALVIK
20
Christopher Ferris6cff48f2014-01-26 21:36:13 -080021#include <backtrace/BacktraceMap.h>
Mathieu Chartier6f365cc2014-04-23 12:42:27 -070022#include <cutils/trace.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070023#include <dirent.h>
Ian Rogersd9c4fc92013-10-01 19:45:43 -070024#include <ScopedLocalRef.h>
25#include <ScopedUtfChars.h>
Elliott Hughesabbe07d2012-06-05 17:42:23 -070026#include <sys/types.h>
Elliott Hughes038a8062011-09-18 14:12:41 -070027#include <unistd.h>
28
Ian Rogersc7dd2952014-10-21 23:31:19 -070029#include <sstream>
30
Mathieu Chartier70a596d2014-12-17 14:56:47 -080031#include "base/histogram-inl.h"
Hiroshi Yamauchi967a0ad2013-09-10 16:24:21 -070032#include "base/mutex-inl.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010033#include "base/time_utils.h"
Sameer Abu Asala8439542013-02-14 16:06:42 -080034#include "base/timing_logger.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070035#include "debugger.h"
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -070036#include "gc/collector/concurrent_copying.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070037#include "jni_internal.h"
38#include "lock_word.h"
39#include "monitor.h"
40#include "scoped_thread_state_change.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080041#include "thread.h"
Jeff Haoe094b872014-10-14 13:12:01 -070042#include "trace.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070043#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070044
Yu Lieac44242015-06-29 10:50:03 +080045#if ART_USE_FUTEXES
46#include "linux/futex.h"
47#include "sys/syscall.h"
48#ifndef SYS_futex
49#define SYS_futex __NR_futex
50#endif
51#endif // ART_USE_FUTEXES
52
Elliott Hughes8daa0922011-09-11 13:46:25 -070053namespace art {
54
Mathieu Chartier251755c2014-07-15 18:10:25 -070055static constexpr uint64_t kLongThreadSuspendThreshold = MsToNs(5);
Mathieu Chartier99143862015-02-03 14:26:46 -080056static constexpr uint64_t kThreadSuspendTimeoutMs = 30 * 1000; // 30s.
57// Use 0 since we want to yield to prevent blocking for an unpredictable amount of time.
58static constexpr useconds_t kThreadSuspendInitialSleepUs = 0;
59static constexpr useconds_t kThreadSuspendMaxYieldUs = 3000;
60static constexpr useconds_t kThreadSuspendMaxSleepUs = 5000;
Mathieu Chartier251755c2014-07-15 18:10:25 -070061
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -080062ThreadList::ThreadList()
Mathieu Chartier91e56692015-03-03 13:51:04 -080063 : suspend_all_count_(0), debug_suspend_all_count_(0), unregistering_count_(0),
Mathieu Chartierbf44d422015-06-02 11:42:18 -070064 suspend_all_historam_("suspend all histogram", 16, 64), long_suspend_(false) {
Hiroshi Yamauchie15ea082015-02-09 17:11:42 -080065 CHECK(Monitor::IsValidLockWord(LockWord::FromThinLockId(kMaxThreadId, 1, 0U)));
Elliott Hughes8daa0922011-09-11 13:46:25 -070066}
67
68ThreadList::~ThreadList() {
Elliott Hughese52e49b2012-04-02 16:05:44 -070069 // Detach the current thread if necessary. If we failed to start, there might not be any threads.
Elliott Hughes6a144332012-04-03 13:07:11 -070070 // We need to detach the current thread here in case there's another thread waiting to join with
71 // us.
Mathieu Chartierfec72f42014-10-09 12:57:58 -070072 bool contains = false;
73 {
74 Thread* self = Thread::Current();
75 MutexLock mu(self, *Locks::thread_list_lock_);
76 contains = Contains(self);
77 }
78 if (contains) {
Elliott Hughes8daa0922011-09-11 13:46:25 -070079 Runtime::Current()->DetachCurrentThread();
80 }
Elliott Hughes6a144332012-04-03 13:07:11 -070081 WaitForOtherNonDaemonThreadsToExit();
Mathieu Chartier51168372015-08-12 16:40:32 -070082 // Disable GC and wait for GC to complete in case there are still daemon threads doing
83 // allocations.
84 gc::Heap* const heap = Runtime::Current()->GetHeap();
85 heap->DisableGCForShutdown();
86 // In case a GC is in progress, wait for it to finish.
87 heap->WaitForGcToComplete(gc::kGcCauseBackground, Thread::Current());
88
Ian Rogers00f7d0e2012-07-19 15:28:27 -070089 // TODO: there's an unaddressed race here where a thread may attach during shutdown, see
90 // Thread::Init.
Elliott Hughes6a144332012-04-03 13:07:11 -070091 SuspendAllDaemonThreads();
Elliott Hughes8daa0922011-09-11 13:46:25 -070092}
93
94bool ThreadList::Contains(Thread* thread) {
95 return find(list_.begin(), list_.end(), thread) != list_.end();
96}
97
Elliott Hughesabbe07d2012-06-05 17:42:23 -070098bool ThreadList::Contains(pid_t tid) {
Mathieu Chartier02e25112013-08-14 16:14:24 -070099 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700100 if (thread->GetTid() == tid) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700101 return true;
102 }
103 }
104 return false;
105}
106
Brian Carlstrom24a3c2e2011-10-17 18:07:52 -0700107pid_t ThreadList::GetLockOwner() {
Ian Rogersb726dcb2012-09-05 08:57:23 -0700108 return Locks::thread_list_lock_->GetExclusiveOwnerTid();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700109}
110
Mathieu Chartier590fee92013-09-13 13:46:47 -0700111void ThreadList::DumpNativeStacks(std::ostream& os) {
112 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800113 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid()));
Mathieu Chartier590fee92013-09-13 13:46:47 -0700114 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700115 os << "DUMPING THREAD " << thread->GetTid() << "\n";
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800116 DumpNativeStack(os, thread->GetTid(), map.get(), "\t");
Mathieu Chartier590fee92013-09-13 13:46:47 -0700117 os << "\n";
118 }
119}
120
Elliott Hughesc967f782012-04-16 10:23:15 -0700121void ThreadList::DumpForSigQuit(std::ostream& os) {
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800122 {
123 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier23f6e692014-12-18 18:24:39 -0800124 // Only print if we have samples.
125 if (suspend_all_historam_.SampleSize() > 0) {
126 Histogram<uint64_t>::CumulativeData data;
127 suspend_all_historam_.CreateHistogram(&data);
128 suspend_all_historam_.PrintConfidenceIntervals(os, 0.99, data); // Dump time to suspend.
129 }
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800130 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700131 Dump(os);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700132 DumpUnattachedThreads(os);
133}
134
Ian Rogerscfaa4552012-11-26 21:00:08 -0800135static void DumpUnattachedThread(std::ostream& os, pid_t tid) NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700136 // TODO: No thread safety analysis as DumpState with a null thread won't access fields, should
Ian Rogerscfaa4552012-11-26 21:00:08 -0800137 // refactor DumpState to avoid skipping analysis.
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700138 Thread::DumpState(os, nullptr, tid);
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700139 DumpKernelStack(os, tid, " kernel: ", false);
Brian Carlstromed8b7232012-06-27 17:54:47 -0700140 // TODO: Reenable this when the native code in system_server can handle it.
141 // Currently "adb shell kill -3 `pid system_server`" will cause it to exit.
142 if (false) {
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800143 DumpNativeStack(os, tid, nullptr, " native: ");
Brian Carlstromed8b7232012-06-27 17:54:47 -0700144 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700145 os << "\n";
146}
147
148void ThreadList::DumpUnattachedThreads(std::ostream& os) {
149 DIR* d = opendir("/proc/self/task");
150 if (!d) {
151 return;
152 }
153
Ian Rogers50b35e22012-10-04 10:09:15 -0700154 Thread* self = Thread::Current();
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700155 dirent* e;
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700156 while ((e = readdir(d)) != nullptr) {
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700157 char* end;
Elliott Hughes4696b5b2012-10-30 10:35:10 -0700158 pid_t tid = strtol(e->d_name, &end, 10);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700159 if (!*end) {
160 bool contains;
161 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700162 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700163 contains = Contains(tid);
164 }
165 if (!contains) {
166 DumpUnattachedThread(os, tid);
167 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -0700168 }
169 }
170 closedir(d);
Elliott Hughesff738062012-02-03 15:00:42 -0800171}
172
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800173// Dump checkpoint timeout in milliseconds. Larger amount on the host, as dumping will invoke
174// addr2line when available.
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800175static constexpr uint32_t kDumpWaitTimeout = kIsTargetBuild ? 10000 : 20000;
Andreas Gampe4a3d19b2015-01-09 17:54:51 -0800176
Ian Rogers7b078e82014-09-10 14:44:24 -0700177// A closure used by Thread::Dump.
178class DumpCheckpoint FINAL : public Closure {
179 public:
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800180 explicit DumpCheckpoint(std::ostream* os)
181 : os_(os), barrier_(0), backtrace_map_(BacktraceMap::Create(GetTid())) {}
Ian Rogers7b078e82014-09-10 14:44:24 -0700182
183 void Run(Thread* thread) OVERRIDE {
184 // Note thread and self may not be equal if thread was already suspended at the point of the
185 // request.
186 Thread* self = Thread::Current();
187 std::ostringstream local_os;
188 {
189 ScopedObjectAccess soa(self);
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800190 thread->Dump(local_os, backtrace_map_.get());
Ian Rogers7b078e82014-09-10 14:44:24 -0700191 }
192 local_os << "\n";
193 {
194 // Use the logging lock to ensure serialization when writing to the common ostream.
195 MutexLock mu(self, *Locks::logging_lock_);
196 *os_ << local_os.str();
197 }
Mathieu Chartier10d25082015-10-28 18:36:09 -0700198 barrier_.Pass(self);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700199 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700200
201 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
202 Thread* self = Thread::Current();
203 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800204 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700205 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000206 // Avoid a recursive abort.
207 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
208 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700209 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700210 }
211
212 private:
213 // The common stream that will accumulate all the dumps.
214 std::ostream* const os_;
215 // The barrier to be passed through and for the requestor to wait upon.
216 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800217 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
218 std::unique_ptr<BacktraceMap> backtrace_map_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700219};
220
221void ThreadList::Dump(std::ostream& os) {
222 {
223 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
224 os << "DALVIK THREADS (" << list_.size() << "):\n";
225 }
226 DumpCheckpoint checkpoint(&os);
227 size_t threads_running_checkpoint = RunCheckpoint(&checkpoint);
Lei Lidd9943d2015-02-02 14:24:44 +0800228 if (threads_running_checkpoint != 0) {
229 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
230 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700231}
232
Ian Rogers50b35e22012-10-04 10:09:15 -0700233void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
234 MutexLock mu(self, *Locks::thread_list_lock_);
235 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700236 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800237 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700238 CHECK(thread->IsSuspended())
239 << "\nUnsuspended thread: <<" << *thread << "\n"
240 << "self: <<" << *Thread::Current();
241 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700242 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700243}
244
Ian Rogers66aee5c2012-08-15 17:17:47 -0700245#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700246// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800247NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700248 Runtime* runtime = Runtime::Current();
249 std::ostringstream ss;
250 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700251 Locks::mutator_lock_->Dump(ss);
252 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700253 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700254 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800255 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700256}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700257#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700258
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800259// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800260// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
261// we use sched_yield instead of calling usleep.
262static void ThreadSuspendSleep(useconds_t delay_us) {
263 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800264 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800265 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800266 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800267 }
268}
269
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700270size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700271 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800272 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
273 Locks::thread_list_lock_->AssertNotHeld(self);
274 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000275 if (kDebugLocking && gAborting == 0) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700276 CHECK_NE(self->GetState(), kRunnable);
277 }
278
279 std::vector<Thread*> suspended_count_modified_threads;
280 size_t count = 0;
281 {
282 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
283 // manually called.
284 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700285 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier10d25082015-10-28 18:36:09 -0700286 count = list_.size();
Mathieu Chartier02e25112013-08-14 16:14:24 -0700287 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700288 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700289 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700290 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800291 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700292 break;
293 } else {
294 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700295 // The thread switched back to runnable.
296 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700297 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700298 continue;
299 }
Yu Lieac44242015-06-29 10:50:03 +0800300 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700301 suspended_count_modified_threads.push_back(thread);
302 break;
303 }
304 }
305 }
306 }
307 }
308
309 // Run the checkpoint on ourself while we wait for threads to suspend.
310 checkpoint_function->Run(self);
311
312 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700313 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700314 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800315 if (ATRACE_ENABLED()) {
316 std::ostringstream oss;
317 thread->ShortDump(oss);
318 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
319 }
320 // Busy wait until the thread is suspended.
321 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700322 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800323 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700324 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800325 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800326 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800327 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
328 ATRACE_END();
329 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
330 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
331 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700332 }
333 }
334 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700335 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700336 {
337 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800338 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700339 }
340 }
341
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800342 {
343 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
344 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
345 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
346 Thread::resume_cond_->Broadcast(self);
347 }
348
Lei Lidd9943d2015-02-02 14:24:44 +0800349 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700350}
351
Dave Allison39c3bfb2014-01-28 18:33:52 -0800352// Request that a checkpoint function be run on all active (non-suspended)
353// threads. Returns the number of successful requests.
354size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
355 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700356 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
357 Locks::thread_list_lock_->AssertNotHeld(self);
358 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
359 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800360
361 size_t count = 0;
362 {
363 // Call a checkpoint function for each non-suspended thread.
364 MutexLock mu(self, *Locks::thread_list_lock_);
365 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
366 for (const auto& thread : list_) {
367 if (thread != self) {
368 if (thread->RequestCheckpoint(checkpoint_function)) {
369 // This thread will run its checkpoint some time in the near future.
370 count++;
371 }
372 }
373 }
374 }
375
376 // Return the number of threads that will run the checkpoint function.
377 return count;
378}
379
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800380// A checkpoint/suspend-all hybrid to switch thread roots from
381// from-space to to-space refs. Used to synchronize threads at a point
382// to mark the initiation of marking while maintaining the to-space
383// invariant.
384size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor, Closure* flip_callback,
385 gc::collector::GarbageCollector* collector) {
386 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
387 const uint64_t start_time = NanoTime();
388 Thread* self = Thread::Current();
389 Locks::mutator_lock_->AssertNotHeld(self);
390 Locks::thread_list_lock_->AssertNotHeld(self);
391 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
392 CHECK_NE(self->GetState(), kRunnable);
393
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700394 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800395
396 // Run the flip callback for the collector.
397 Locks::mutator_lock_->ExclusiveLock(self);
398 flip_callback->Run(self);
399 Locks::mutator_lock_->ExclusiveUnlock(self);
400 collector->RegisterPause(NanoTime() - start_time);
401
402 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700403 std::vector<Thread*> runnable_threads;
404 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800405 {
406 MutexLock mu(self, *Locks::thread_list_lock_);
407 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
408 --suspend_all_count_;
409 for (const auto& thread : list_) {
410 if (thread == self) {
411 continue;
412 }
413 // Set the flip function for both runnable and suspended threads
414 // because Thread::DumpState/DumpJavaStack() (invoked by a
415 // checkpoint) may cause the flip function to be run for a
416 // runnable/suspended thread before a runnable threads runs it
417 // for itself or we run it for a suspended thread below.
418 thread->SetFlipFunction(thread_flip_visitor);
419 if (thread->IsSuspendedAtSuspendCheck()) {
420 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800421 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800422 runnable_threads.push_back(thread);
423 } else {
424 other_threads.push_back(thread);
425 }
426 }
427 Thread::resume_cond_->Broadcast(self);
428 }
429
430 // Run the closure on the other threads and let them resume.
431 {
432 ReaderMutexLock mu(self, *Locks::mutator_lock_);
433 for (const auto& thread : other_threads) {
434 Closure* flip_func = thread->GetFlipFunction();
435 if (flip_func != nullptr) {
436 flip_func->Run(thread);
437 }
438 }
439 // Run it for self.
440 thread_flip_visitor->Run(self);
441 }
442
443 // Resume other threads.
444 {
445 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
446 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800447 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800448 }
449 Thread::resume_cond_->Broadcast(self);
450 }
451
452 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
453}
454
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700455void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700456 Thread* self = Thread::Current();
457
Jeff Haoc5d824a2014-07-28 18:35:38 -0700458 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700459 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700460 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700461 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700462 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700463 ATRACE_BEGIN("Suspending mutator threads");
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800464 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700465
Yu Lieac44242015-06-29 10:50:03 +0800466 SuspendAllInternal(self, self);
467 // All threads are known to have suspended (but a thread may still own the mutator lock)
468 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700469#if HAVE_TIMED_RWLOCK
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700470 while (true) {
471 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
472 break;
473 } else if (!long_suspend_) {
474 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
475 // could result in a thread suspend timeout.
476 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
477 UnsafeLogFatalForThreadSuspendAllTimeout();
478 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700479 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700480#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700481 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700482#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700483
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700484 long_suspend_ = long_suspend;
485
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800486 const uint64_t end_time = NanoTime();
487 const uint64_t suspend_time = end_time - start_time;
488 suspend_all_historam_.AdjustAndAddValue(suspend_time);
489 if (suspend_time > kLongThreadSuspendThreshold) {
490 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
Mathieu Chartier251755c2014-07-15 18:10:25 -0700491 }
492
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800493 if (kDebugLocking) {
494 // Debug check that all threads are suspended.
495 AssertThreadsAreSuspended(self, self);
496 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700497
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700498 ATRACE_END();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700499 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700500
Jeff Haoc5d824a2014-07-28 18:35:38 -0700501 if (self != nullptr) {
502 VLOG(threads) << *self << " SuspendAll complete";
503 } else {
504 VLOG(threads) << "Thread[null] SuspendAll complete";
505 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700506}
507
Yu Lieac44242015-06-29 10:50:03 +0800508// Ensures all threads running Java suspend and that those not running Java don't start.
509// Debugger thread might be set to kRunnable for a short period of time after the
510// SuspendAllInternal. This is safe because it will be set back to suspended state before
511// the SuspendAll returns.
512void ThreadList::SuspendAllInternal(Thread* self, Thread* ignore1, Thread* ignore2,
513 bool debug_suspend) {
514 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
515 Locks::thread_list_lock_->AssertNotHeld(self);
516 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
517 if (kDebugLocking && self != nullptr) {
518 CHECK_NE(self->GetState(), kRunnable);
519 }
520
521 // First request that all threads suspend, then wait for them to suspend before
522 // returning. This suspension scheme also relies on other behaviour:
523 // 1. Threads cannot be deleted while they are suspended or have a suspend-
524 // request flag set - (see Unregister() below).
525 // 2. When threads are created, they are created in a suspended state (actually
526 // kNative) and will never begin executing Java code without first checking
527 // the suspend-request flag.
528
529 // The atomic counter for number of threads that need to pass the barrier.
530 AtomicInteger pending_threads;
531 uint32_t num_ignored = 0;
532 if (ignore1 != nullptr) {
533 ++num_ignored;
534 }
535 if (ignore2 != nullptr && ignore1 != ignore2) {
536 ++num_ignored;
537 }
538 {
539 MutexLock mu(self, *Locks::thread_list_lock_);
540 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
541 // Update global suspend all state for attaching threads.
542 ++suspend_all_count_;
543 if (debug_suspend)
544 ++debug_suspend_all_count_;
545 pending_threads.StoreRelaxed(list_.size() - num_ignored);
546 // Increment everybody's suspend count (except those that should be ignored).
547 for (const auto& thread : list_) {
548 if (thread == ignore1 || thread == ignore2) {
549 continue;
550 }
551 VLOG(threads) << "requesting thread suspend: " << *thread;
552 while (true) {
553 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
554 break;
555 } else {
556 // Failure means the list of active_suspend_barriers is full, we should release the
557 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
558 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
559 // the thread to change to a suspended state, because it might need to run checkpoint
560 // function before the state change, which also needs thread_suspend_count_lock_.
561
562 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
563 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
564 // in the mean time.
565 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
566 NanoSleep(100000);
567 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
568 }
569 }
570
571 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
572 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
573 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
574 if (thread->IsSuspended()) {
575 // Only clear the counter for the current thread.
576 thread->ClearSuspendBarrier(&pending_threads);
577 pending_threads.FetchAndSubSequentiallyConsistent(1);
578 }
579 }
580 }
581
582 // Wait for the barrier to be passed by all runnable threads. This wait
583 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700584#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800585 timespec wait_timeout;
586 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700587#endif
Yu Lieac44242015-06-29 10:50:03 +0800588 while (true) {
589 int32_t cur_val = pending_threads.LoadRelaxed();
590 if (LIKELY(cur_val > 0)) {
591#if ART_USE_FUTEXES
592 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
593 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
594 if ((errno != EAGAIN) && (errno != EINTR)) {
595 if (errno == ETIMEDOUT) {
596 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
597 } else {
598 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
599 }
600 }
601 } else {
602 cur_val = pending_threads.LoadRelaxed();
603 CHECK_EQ(cur_val, 0);
604 break;
605 }
606#else
607 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
608#endif
609 } else {
610 CHECK_EQ(cur_val, 0);
611 break;
612 }
613 }
614}
615
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700616void ThreadList::ResumeAll() {
617 Thread* self = Thread::Current();
618
Jeff Haoc5d824a2014-07-28 18:35:38 -0700619 if (self != nullptr) {
620 VLOG(threads) << *self << " ResumeAll starting";
621 } else {
622 VLOG(threads) << "Thread[null] ResumeAll starting";
623 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700624
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700625 ATRACE_END();
626 ATRACE_BEGIN("Resuming mutator threads");
627
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800628 if (kDebugLocking) {
629 // Debug check that all threads are suspended.
630 AssertThreadsAreSuspended(self, self);
631 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700632
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700633 long_suspend_ = false;
634
Ian Rogers81d425b2012-09-27 16:03:43 -0700635 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700636 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700637 MutexLock mu(self, *Locks::thread_list_lock_);
638 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700639 // Update global suspend all state for attaching threads.
640 --suspend_all_count_;
641 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700642 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700643 if (thread == self) {
644 continue;
645 }
Yu Lieac44242015-06-29 10:50:03 +0800646 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700647 }
648
649 // Broadcast a notification to all suspended threads, some or all of
650 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700651 if (self != nullptr) {
652 VLOG(threads) << *self << " ResumeAll waking others";
653 } else {
654 VLOG(threads) << "Thread[null] ResumeAll waking others";
655 }
Ian Rogersc604d732012-10-14 16:09:54 -0700656 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700657 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700658 ATRACE_END();
Jeff Haoc5d824a2014-07-28 18:35:38 -0700659
660 if (self != nullptr) {
661 VLOG(threads) << *self << " ResumeAll complete";
662 } else {
663 VLOG(threads) << "Thread[null] ResumeAll complete";
664 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700665}
666
667void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800668 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
669 ATRACE_END();
670
Ian Rogers81d425b2012-09-27 16:03:43 -0700671 Thread* self = Thread::Current();
672 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700673 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
674 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700675
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700676 {
677 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700678 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700679 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700680 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
681 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700682 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700683 // We only expect threads within the thread-list to have been suspended otherwise we can't
684 // stop such threads from delete-ing themselves.
685 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
686 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700687 return;
688 }
Yu Lieac44242015-06-29 10:50:03 +0800689 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700690 }
691
692 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700693 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700694 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700695 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700696 }
697
Brian Carlstromba32de42014-08-27 23:43:46 -0700698 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700699}
Elliott Hughes01158d72011-09-19 19:47:10 -0700700
Ian Rogersc7dd2952014-10-21 23:31:19 -0700701static void ThreadSuspendByPeerWarning(Thread* self, LogSeverity severity, const char* message,
702 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700703 JNIEnvExt* env = self->GetJniEnv();
704 ScopedLocalRef<jstring>
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700705 scoped_name_string(env, (jstring)env->GetObjectField(
706 peer, WellKnownClasses::java_lang_Thread_name));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700707 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700708 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700709 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700710 env->ExceptionClear();
711 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700712 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700713 }
714}
715
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700716Thread* ThreadList::SuspendThreadByPeer(jobject peer, bool request_suspension,
717 bool debug_suspension, bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800718 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800719 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700720 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800721 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800722 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700723 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700724 while (true) {
725 Thread* thread;
726 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700727 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
728 // is requesting another suspend, to avoid deadlock, by requiring this function be called
729 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
730 // than request thread suspension, to avoid potential cycles in threads requesting each other
731 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700732 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800733 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700734 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700735 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800736 if (suspended_thread != nullptr) {
737 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
738 // If we incremented the suspend count but the thread reset its peer, we need to
739 // re-decrement it since it is shutting down and may deadlock the runtime in
740 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800741 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800742 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700743 ThreadSuspendByPeerWarning(self, WARNING, "No such thread for suspend", peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700744 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700745 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700746 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800747 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700748 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
749 << reinterpret_cast<void*>(thread);
750 return nullptr;
751 }
752 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700753 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800754 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700755 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800756 if (self->GetSuspendCount() > 0) {
757 // We hold the suspend count lock but another thread is trying to suspend us. Its not
758 // safe to try to suspend another thread in case we get a cycle. Start the loop again
759 // which will allow this thread to be suspended.
760 continue;
761 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800762 CHECK(suspended_thread == nullptr);
763 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800764 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700765 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700766 } else {
767 // If the caller isn't requesting suspension, a suspension should have already occurred.
768 CHECK_GT(thread->GetSuspendCount(), 0);
769 }
770 // IsSuspended on the current thread will fail as the current thread is changed into
771 // Runnable above. As the suspend count is now raised if this is the current thread
772 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
773 // to just explicitly handle the current thread in the callers to this code.
774 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
775 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
776 // count, or else we've waited and it has self suspended) or is the current thread, we're
777 // done.
778 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700779 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800780 if (ATRACE_ENABLED()) {
781 std::string name;
782 thread->GetThreadName(name);
783 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
784 peer).c_str());
785 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700786 return thread;
787 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800788 const uint64_t total_delay = NanoTime() - start_time;
789 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700790 ThreadSuspendByPeerWarning(self, FATAL, "Thread suspension timed out", peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800791 if (suspended_thread != nullptr) {
792 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800793 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700794 }
795 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700796 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800797 } else if (sleep_us == 0 &&
798 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
799 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
800 // excessive CPU usage.
801 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700802 }
803 }
804 // Release locks and come out of runnable state.
805 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800806 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
807 ThreadSuspendSleep(sleep_us);
808 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
809 // all if possible. This shouldn't be an issue since time to suspend should always be small.
810 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700811 }
812}
813
Ian Rogersc7dd2952014-10-21 23:31:19 -0700814static void ThreadSuspendByThreadIdWarning(LogSeverity severity, const char* message,
815 uint32_t thread_id) {
816 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700817}
818
819Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id, bool debug_suspension,
820 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800821 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800822 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700823 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800824 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800825 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700826 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700827 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700828 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700829 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700830 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
831 // is requesting another suspend, to avoid deadlock, by requiring this function be called
832 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
833 // than request thread suspension, to avoid potential cycles in threads requesting each other
834 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700835 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800836 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700837 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700838 for (const auto& it : list_) {
839 if (it->GetThreadId() == thread_id) {
840 thread = it;
841 break;
842 }
843 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800844 if (thread == nullptr) {
845 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
846 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700847 // There's a race in inflating a lock and the owner giving up ownership and then dying.
848 ThreadSuspendByThreadIdWarning(WARNING, "No such thread id for suspend", thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700849 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700850 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700851 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
852 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700853 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800854 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800855 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800856 if (self->GetSuspendCount() > 0) {
857 // We hold the suspend count lock but another thread is trying to suspend us. Its not
858 // safe to try to suspend another thread in case we get a cycle. Start the loop again
859 // which will allow this thread to be suspended.
860 continue;
861 }
Yu Lieac44242015-06-29 10:50:03 +0800862 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800863 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700864 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800865 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700866 // If the caller isn't requesting suspension, a suspension should have already occurred.
867 CHECK_GT(thread->GetSuspendCount(), 0);
868 }
869 // IsSuspended on the current thread will fail as the current thread is changed into
870 // Runnable above. As the suspend count is now raised if this is the current thread
871 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
872 // to just explicitly handle the current thread in the callers to this code.
873 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
874 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
875 // count, or else we've waited and it has self suspended) or is the current thread, we're
876 // done.
877 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800878 if (ATRACE_ENABLED()) {
879 std::string name;
880 thread->GetThreadName(name);
881 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
882 name.c_str(), thread_id).c_str());
883 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700884 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700885 return thread;
886 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800887 const uint64_t total_delay = NanoTime() - start_time;
888 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700889 ThreadSuspendByThreadIdWarning(WARNING, "Thread suspension timed out", thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800890 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800891 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700892 }
893 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700894 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800895 } else if (sleep_us == 0 &&
896 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
897 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
898 // excessive CPU usage.
899 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700900 }
901 }
902 // Release locks and come out of runnable state.
903 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800904 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
905 ThreadSuspendSleep(sleep_us);
906 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700907 }
908}
909
910Thread* ThreadList::FindThreadByThreadId(uint32_t thin_lock_id) {
911 Thread* self = Thread::Current();
912 MutexLock mu(self, *Locks::thread_list_lock_);
913 for (const auto& thread : list_) {
914 if (thread->GetThreadId() == thin_lock_id) {
915 CHECK(thread == self || thread->IsSuspended());
916 return thread;
917 }
918 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700919 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700920}
921
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700922void ThreadList::SuspendAllForDebugger() {
923 Thread* self = Thread::Current();
924 Thread* debug_thread = Dbg::GetDebugThread();
925
926 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
927
Yu Lieac44242015-06-29 10:50:03 +0800928 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700929 // Block on the mutator lock until all Runnable threads release their share of access then
930 // immediately unlock again.
931#if HAVE_TIMED_RWLOCK
932 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700933 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100934 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700935 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700936 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700937 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700938#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700939 Locks::mutator_lock_->ExclusiveLock(self);
940 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700941#endif
Ian Rogers50b35e22012-10-04 10:09:15 -0700942 AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700943
Sebastien Hertzed2be172014-08-19 15:33:43 +0200944 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700945}
946
Elliott Hughes475fc232011-10-25 15:00:35 -0700947void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100948 Thread* const self = Thread::Current();
949 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700950
Elliott Hughes475fc232011-10-25 15:00:35 -0700951 // The debugger thread must not suspend itself due to debugger activity!
952 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700953 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800954 CHECK_NE(self->GetState(), kRunnable);
955 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700956
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200957 // The debugger may have detached while we were executing an invoke request. In that case, we
958 // must not suspend ourself.
959 DebugInvokeReq* pReq = self->GetInvokeReq();
960 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
961 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800962 // Collisions with other suspends aren't really interesting. We want
963 // to ensure that we're the only one fiddling with the suspend count
964 // though.
965 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800966 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700967 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200968
969 VLOG(threads) << *self << " self-suspending (debugger)";
970 } else {
971 // We must no longer be subject to debugger suspension.
972 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
973 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
974
975 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800976 }
Elliott Hughes475fc232011-10-25 15:00:35 -0700977
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200978 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +0100979 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200980 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +0100981 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200982 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +0100983 }
984
Elliott Hughes475fc232011-10-25 15:00:35 -0700985 // Tell JDWP that we've completed suspension. The JDWP thread can't
986 // tell us to resume before we're fully asleep because we hold the
987 // suspend count lock.
988 Dbg::ClearWaitForEventThread();
989
jeffhaoa77f0f62012-12-05 17:19:31 -0800990 {
991 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700992 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800993 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700994 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800995 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +0200996 // can happen when we suspend then resume all threads to
997 // update instrumentation or compute monitor info. This can
998 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -0800999 // dump event is pending (assuming SignalCatcher was resumed for
1000 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001001 VLOG(jdwp) << *self << " still suspended after undo "
1002 << "(suspend count=" << self->GetSuspendCount() << ", "
1003 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001004 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001005 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001006 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001007 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001008
Sebastien Hertz1558b572015-02-25 15:05:59 +01001009 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001010 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001011}
1012
Sebastien Hertz253fa552014-10-14 17:27:15 +02001013void ThreadList::ResumeAllForDebugger() {
1014 Thread* self = Thread::Current();
1015 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001016
1017 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1018
1019 // Threads can't resume if we exclusively hold the mutator lock.
1020 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1021
1022 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001023 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001024 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001025 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001026 // Update global suspend all state for attaching threads.
1027 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001028 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001029 --suspend_all_count_;
1030 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001031 } else {
1032 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001033 // suspend them all before. That may happen if a debugger tries
1034 // to resume some suspended threads (with suspend count == 1)
1035 // at once with a VirtualMachine.Resume command. Let's print a
1036 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001037 LOG(WARNING) << "Debugger attempted to resume all threads without "
1038 << "having suspended them all before.";
1039 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001040 // Decrement everybody's suspend count (except our own).
1041 for (const auto& thread : list_) {
1042 if (thread == self || thread == debug_thread) {
1043 continue;
1044 }
1045 if (thread->GetDebugSuspendCount() == 0) {
1046 // This thread may have been individually resumed with ThreadReference.Resume.
1047 continue;
1048 }
1049 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001050 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001051 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001052 }
1053 }
1054
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001055 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001056 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1057 Thread::resume_cond_->Broadcast(self);
1058 }
1059
1060 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1061}
1062
Elliott Hughes234ab152011-10-26 14:02:26 -07001063void ThreadList::UndoDebuggerSuspensions() {
1064 Thread* self = Thread::Current();
1065
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001066 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001067
1068 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001069 MutexLock mu(self, *Locks::thread_list_lock_);
1070 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001071 // Update global suspend all state for attaching threads.
1072 suspend_all_count_ -= debug_suspend_all_count_;
1073 debug_suspend_all_count_ = 0;
1074 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001075 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001076 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001077 continue;
1078 }
Yu Lieac44242015-06-29 10:50:03 +08001079 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001080 }
1081 }
1082
1083 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001084 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001085 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001086 }
1087
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001088 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001089}
1090
Elliott Hughese52e49b2012-04-02 16:05:44 -07001091void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001092 Thread* self = Thread::Current();
1093 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001094 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001095 {
1096 // No more threads can be born after we start to shutdown.
1097 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001098 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001099 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1100 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001101 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001102 // Also wait for any threads that are unregistering to finish. This is required so that no
1103 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1104 // threads since they could unregister at the wrong time.
1105 bool done = unregistering_count_ == 0;
1106 if (done) {
1107 for (const auto& thread : list_) {
1108 if (thread != self && !thread->IsDaemon()) {
1109 done = false;
1110 break;
1111 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001112 }
1113 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001114 if (done) {
1115 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001116 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001117 // Wait for another thread to exit before re-checking.
1118 Locks::thread_exit_cond_->Wait(self);
1119 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001120}
1121
1122void ThreadList::SuspendAllDaemonThreads() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001123 Thread* self = Thread::Current();
1124 MutexLock mu(self, *Locks::thread_list_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001125 { // Tell all the daemons it's time to suspend.
Ian Rogers81d425b2012-09-27 16:03:43 -07001126 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001127 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001128 // This is only run after all non-daemon threads have exited, so the remainder should all be
1129 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001130 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001131 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001132 thread->ModifySuspendCount(self, +1, nullptr, false);
Elliott Hughese52e49b2012-04-02 16:05:44 -07001133 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001134 }
1135 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001136 // Give the threads a chance to suspend, complaining if they're slow.
1137 bool have_complained = false;
1138 for (int i = 0; i < 10; ++i) {
1139 usleep(200 * 1000);
1140 bool all_suspended = true;
Mathieu Chartier02e25112013-08-14 16:14:24 -07001141 for (const auto& thread : list_) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001142 if (thread != self && thread->GetState() == kRunnable) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001143 if (!have_complained) {
1144 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1145 have_complained = true;
1146 }
1147 all_suspended = false;
1148 }
1149 }
1150 if (all_suspended) {
1151 return;
1152 }
1153 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001154 LOG(ERROR) << "suspend all daemons failed";
1155}
1156void ThreadList::Register(Thread* self) {
1157 DCHECK_EQ(self, Thread::Current());
1158
1159 if (VLOG_IS_ON(threads)) {
1160 std::ostringstream oss;
1161 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001162 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001163 }
1164
1165 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1166 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001167 MutexLock mu(self, *Locks::thread_list_lock_);
1168 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001169 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001170 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1171 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1172 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001173 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001174 }
Ian Rogers2966e132014-04-02 08:34:36 -07001175 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001176 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001177 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001178 CHECK(!Contains(self));
1179 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001180 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001181 // Initialize according to the state of the CC collector.
1182 bool is_gc_marking =
1183 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1184 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001185 bool weak_ref_access_enabled =
1186 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1187 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1188 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001189}
1190
1191void ThreadList::Unregister(Thread* self) {
1192 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001193 CHECK_NE(self->GetState(), kRunnable);
1194 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001195
1196 VLOG(threads) << "ThreadList::Unregister() " << *self;
1197
Mathieu Chartier91e56692015-03-03 13:51:04 -08001198 {
1199 MutexLock mu(self, *Locks::thread_list_lock_);
1200 ++unregistering_count_;
1201 }
1202
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001203 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001204 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1205 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1206 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1207 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001208 self->Destroy();
1209
Jeff Haoe094b872014-10-14 13:12:01 -07001210 // If tracing, remember thread id and name before thread exits.
1211 Trace::StoreExitingThreadInfo(self);
1212
Ian Rogersdd7624d2014-03-14 17:43:00 -07001213 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001214 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001215 // Remove and delete the Thread* while holding the thread_list_lock_ and
1216 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001217 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001218 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001219 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001220 std::string thread_name;
1221 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001222 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001223 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001224 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001225 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001226 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001227 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001228 if (!self->IsSuspended()) {
1229 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001230 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001231 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001232 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001233 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001234 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001235 delete self;
1236
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001237 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1238 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1239 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1240 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001241
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001242 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1243 // (It may wish to reattach later.)
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001244#ifdef __ANDROID__
1245 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1246#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001247 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001248#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001249
1250 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001251 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1252 --unregistering_count_;
1253 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001254}
1255
1256void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001257 for (const auto& thread : list_) {
1258 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001259 }
1260}
1261
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001262void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001263 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001264 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001265 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001266 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001267}
1268
Ian Rogerscfaa4552012-11-26 21:00:08 -08001269uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001270 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001271 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1272 if (!allocated_ids_[i]) {
1273 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001274 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001275 }
1276 }
1277 LOG(FATAL) << "Out of internal thread ids";
1278 return 0;
1279}
1280
Ian Rogerscfaa4552012-11-26 21:00:08 -08001281void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001282 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001283 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001284 DCHECK(allocated_ids_[id]) << id;
1285 allocated_ids_.reset(id);
1286}
1287
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001288ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1289 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1290}
1291
1292ScopedSuspendAll::~ScopedSuspendAll() {
1293 Runtime::Current()->GetThreadList()->ResumeAll();
1294}
1295
Elliott Hughes8daa0922011-09-11 13:46:25 -07001296} // namespace art