blob: bdd5d1099c5cc15a254adba7927f7deaf14f9760 [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 }
Lei Lidd9943d2015-02-02 14:24:44 +0800198 if (thread->GetState() == kRunnable) {
199 barrier_.Pass(self);
200 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700201 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700202
203 void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
204 Thread* self = Thread::Current();
205 ScopedThreadStateChange tsc(self, kWaitingForCheckPointsToRun);
Andreas Gampe1e4b0ca2015-01-14 09:06:32 -0800206 bool timed_out = barrier_.Increment(self, threads_running_checkpoint, kDumpWaitTimeout);
Ian Rogers2156ff12014-09-13 19:20:54 -0700207 if (timed_out) {
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000208 // Avoid a recursive abort.
209 LOG((kIsDebugBuild && (gAborting == 0)) ? FATAL : ERROR)
210 << "Unexpected time out during dump checkpoint.";
Ian Rogers2156ff12014-09-13 19:20:54 -0700211 }
Ian Rogers7b078e82014-09-10 14:44:24 -0700212 }
213
214 private:
215 // The common stream that will accumulate all the dumps.
216 std::ostream* const os_;
217 // The barrier to be passed through and for the requestor to wait upon.
218 Barrier barrier_;
Christopher Ferris6cff48f2014-01-26 21:36:13 -0800219 // A backtrace map, so that all threads use a shared info and don't reacquire/parse separately.
220 std::unique_ptr<BacktraceMap> backtrace_map_;
Ian Rogers7b078e82014-09-10 14:44:24 -0700221};
222
223void ThreadList::Dump(std::ostream& os) {
224 {
225 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
226 os << "DALVIK THREADS (" << list_.size() << "):\n";
227 }
228 DumpCheckpoint checkpoint(&os);
229 size_t threads_running_checkpoint = RunCheckpoint(&checkpoint);
Lei Lidd9943d2015-02-02 14:24:44 +0800230 if (threads_running_checkpoint != 0) {
231 checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
232 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700233}
234
Ian Rogers50b35e22012-10-04 10:09:15 -0700235void ThreadList::AssertThreadsAreSuspended(Thread* self, Thread* ignore1, Thread* ignore2) {
236 MutexLock mu(self, *Locks::thread_list_lock_);
237 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700238 for (const auto& thread : list_) {
jeffhao725a9572012-11-13 18:20:12 -0800239 if (thread != ignore1 && thread != ignore2) {
Ian Rogers01ae5802012-09-28 16:14:01 -0700240 CHECK(thread->IsSuspended())
241 << "\nUnsuspended thread: <<" << *thread << "\n"
242 << "self: <<" << *Thread::Current();
243 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700244 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700245}
246
Ian Rogers66aee5c2012-08-15 17:17:47 -0700247#if HAVE_TIMED_RWLOCK
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700248// Attempt to rectify locks so that we dump thread list with required locks before exiting.
Andreas Gampe794ad762015-02-23 08:12:24 -0800249NO_RETURN static void UnsafeLogFatalForThreadSuspendAllTimeout() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700250 Runtime* runtime = Runtime::Current();
251 std::ostringstream ss;
252 ss << "Thread suspend timeout\n";
Mathieu Chartier5869a2c2014-10-08 14:26:23 -0700253 Locks::mutator_lock_->Dump(ss);
254 ss << "\n";
Ian Rogers7b078e82014-09-10 14:44:24 -0700255 runtime->GetThreadList()->Dump(ss);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700256 LOG(FATAL) << ss.str();
Ian Rogers719d1a32014-03-06 12:13:39 -0800257 exit(0);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700258}
Ian Rogers66aee5c2012-08-15 17:17:47 -0700259#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700260
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800261// Unlike suspending all threads where we can wait to acquire the mutator_lock_, suspending an
Mathieu Chartier99143862015-02-03 14:26:46 -0800262// individual thread requires polling. delay_us is the requested sleep wait. If delay_us is 0 then
263// we use sched_yield instead of calling usleep.
264static void ThreadSuspendSleep(useconds_t delay_us) {
265 if (delay_us == 0) {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800266 sched_yield();
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800267 } else {
Mathieu Chartier99143862015-02-03 14:26:46 -0800268 usleep(delay_us);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800269 }
270}
271
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700272size_t ThreadList::RunCheckpoint(Closure* checkpoint_function) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700273 Thread* self = Thread::Current();
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800274 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
275 Locks::thread_list_lock_->AssertNotHeld(self);
276 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
Nicolas Geoffraydb978712014-12-09 13:33:38 +0000277 if (kDebugLocking && gAborting == 0) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700278 CHECK_NE(self->GetState(), kRunnable);
279 }
280
281 std::vector<Thread*> suspended_count_modified_threads;
282 size_t count = 0;
283 {
284 // Call a checkpoint function for each thread, threads which are suspend get their checkpoint
285 // manually called.
286 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700287 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -0700288 for (const auto& thread : list_) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700289 if (thread != self) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700290 while (true) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700291 if (thread->RequestCheckpoint(checkpoint_function)) {
Dave Allison0aded082013-11-07 13:15:11 -0800292 // This thread will run its checkpoint some time in the near future.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700293 count++;
294 break;
295 } else {
296 // We are probably suspended, try to make sure that we stay suspended.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700297 // The thread switched back to runnable.
298 if (thread->GetState() == kRunnable) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700299 // Spurious fail, try again.
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700300 continue;
301 }
Yu Lieac44242015-06-29 10:50:03 +0800302 thread->ModifySuspendCount(self, +1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700303 suspended_count_modified_threads.push_back(thread);
304 break;
305 }
306 }
307 }
308 }
309 }
310
311 // Run the checkpoint on ourself while we wait for threads to suspend.
312 checkpoint_function->Run(self);
313
314 // Run the checkpoint on the suspended threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700315 for (const auto& thread : suspended_count_modified_threads) {
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700316 if (!thread->IsSuspended()) {
Mathieu Chartier99143862015-02-03 14:26:46 -0800317 if (ATRACE_ENABLED()) {
318 std::ostringstream oss;
319 thread->ShortDump(oss);
320 ATRACE_BEGIN((std::string("Waiting for suspension of thread ") + oss.str()).c_str());
321 }
322 // Busy wait until the thread is suspended.
323 const uint64_t start_time = NanoTime();
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700324 do {
Mathieu Chartier99143862015-02-03 14:26:46 -0800325 ThreadSuspendSleep(kThreadSuspendInitialSleepUs);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700326 } while (!thread->IsSuspended());
Mathieu Chartier99143862015-02-03 14:26:46 -0800327 const uint64_t total_delay = NanoTime() - start_time;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800328 // Shouldn't need to wait for longer than 1000 microseconds.
Mathieu Chartier99143862015-02-03 14:26:46 -0800329 constexpr uint64_t kLongWaitThreshold = MsToNs(1);
330 ATRACE_END();
331 if (UNLIKELY(total_delay > kLongWaitThreshold)) {
332 LOG(WARNING) << "Long wait of " << PrettyDuration(total_delay) << " for "
333 << *thread << " suspension!";
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700334 }
335 }
336 // We know for sure that the thread is suspended at this point.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700337 checkpoint_function->Run(thread);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700338 {
339 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800340 thread->ModifySuspendCount(self, -1, nullptr, false);
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700341 }
342 }
343
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800344 {
345 // Imitate ResumeAll, threads may be waiting on Thread::resume_cond_ since we raised their
346 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
347 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
348 Thread::resume_cond_->Broadcast(self);
349 }
350
Lei Lidd9943d2015-02-02 14:24:44 +0800351 return count;
Mathieu Chartier858f1c52012-10-17 17:45:55 -0700352}
353
Dave Allison39c3bfb2014-01-28 18:33:52 -0800354// Request that a checkpoint function be run on all active (non-suspended)
355// threads. Returns the number of successful requests.
356size_t ThreadList::RunCheckpointOnRunnableThreads(Closure* checkpoint_function) {
357 Thread* self = Thread::Current();
Ian Rogers7b078e82014-09-10 14:44:24 -0700358 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
359 Locks::thread_list_lock_->AssertNotHeld(self);
360 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
361 CHECK_NE(self->GetState(), kRunnable);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800362
363 size_t count = 0;
364 {
365 // Call a checkpoint function for each non-suspended thread.
366 MutexLock mu(self, *Locks::thread_list_lock_);
367 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
368 for (const auto& thread : list_) {
369 if (thread != self) {
370 if (thread->RequestCheckpoint(checkpoint_function)) {
371 // This thread will run its checkpoint some time in the near future.
372 count++;
373 }
374 }
375 }
376 }
377
378 // Return the number of threads that will run the checkpoint function.
379 return count;
380}
381
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800382// A checkpoint/suspend-all hybrid to switch thread roots from
383// from-space to to-space refs. Used to synchronize threads at a point
384// to mark the initiation of marking while maintaining the to-space
385// invariant.
386size_t ThreadList::FlipThreadRoots(Closure* thread_flip_visitor, Closure* flip_callback,
387 gc::collector::GarbageCollector* collector) {
388 TimingLogger::ScopedTiming split("ThreadListFlip", collector->GetTimings());
389 const uint64_t start_time = NanoTime();
390 Thread* self = Thread::Current();
391 Locks::mutator_lock_->AssertNotHeld(self);
392 Locks::thread_list_lock_->AssertNotHeld(self);
393 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
394 CHECK_NE(self->GetState(), kRunnable);
395
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700396 SuspendAllInternal(self, self, nullptr);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800397
398 // Run the flip callback for the collector.
399 Locks::mutator_lock_->ExclusiveLock(self);
400 flip_callback->Run(self);
401 Locks::mutator_lock_->ExclusiveUnlock(self);
402 collector->RegisterPause(NanoTime() - start_time);
403
404 // Resume runnable threads.
Mathieu Chartierb19ccb12015-07-15 10:24:16 -0700405 std::vector<Thread*> runnable_threads;
406 std::vector<Thread*> other_threads;
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800407 {
408 MutexLock mu(self, *Locks::thread_list_lock_);
409 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
410 --suspend_all_count_;
411 for (const auto& thread : list_) {
412 if (thread == self) {
413 continue;
414 }
415 // Set the flip function for both runnable and suspended threads
416 // because Thread::DumpState/DumpJavaStack() (invoked by a
417 // checkpoint) may cause the flip function to be run for a
418 // runnable/suspended thread before a runnable threads runs it
419 // for itself or we run it for a suspended thread below.
420 thread->SetFlipFunction(thread_flip_visitor);
421 if (thread->IsSuspendedAtSuspendCheck()) {
422 // The thread will resume right after the broadcast.
Yu Lieac44242015-06-29 10:50:03 +0800423 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800424 runnable_threads.push_back(thread);
425 } else {
426 other_threads.push_back(thread);
427 }
428 }
429 Thread::resume_cond_->Broadcast(self);
430 }
431
432 // Run the closure on the other threads and let them resume.
433 {
434 ReaderMutexLock mu(self, *Locks::mutator_lock_);
435 for (const auto& thread : other_threads) {
436 Closure* flip_func = thread->GetFlipFunction();
437 if (flip_func != nullptr) {
438 flip_func->Run(thread);
439 }
440 }
441 // Run it for self.
442 thread_flip_visitor->Run(self);
443 }
444
445 // Resume other threads.
446 {
447 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
448 for (const auto& thread : other_threads) {
Yu Lieac44242015-06-29 10:50:03 +0800449 thread->ModifySuspendCount(self, -1, nullptr, false);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800450 }
451 Thread::resume_cond_->Broadcast(self);
452 }
453
454 return runnable_threads.size() + other_threads.size() + 1; // +1 for self.
455}
456
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700457void ThreadList::SuspendAll(const char* cause, bool long_suspend) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700458 Thread* self = Thread::Current();
459
Jeff Haoc5d824a2014-07-28 18:35:38 -0700460 if (self != nullptr) {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700461 VLOG(threads) << *self << " SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700462 } else {
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700463 VLOG(threads) << "Thread[null] SuspendAll for " << cause << " starting...";
Jeff Haoc5d824a2014-07-28 18:35:38 -0700464 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700465 ATRACE_BEGIN("Suspending mutator threads");
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800466 const uint64_t start_time = NanoTime();
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700467
Yu Lieac44242015-06-29 10:50:03 +0800468 SuspendAllInternal(self, self);
469 // All threads are known to have suspended (but a thread may still own the mutator lock)
470 // Make sure this thread grabs exclusive access to the mutator lock and its protected data.
Ian Rogers66aee5c2012-08-15 17:17:47 -0700471#if HAVE_TIMED_RWLOCK
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700472 while (true) {
473 if (Locks::mutator_lock_->ExclusiveLockWithTimeout(self, kThreadSuspendTimeoutMs, 0)) {
474 break;
475 } else if (!long_suspend_) {
476 // Reading long_suspend without the mutator lock is slightly racy, in some rare cases, this
477 // could result in a thread suspend timeout.
478 // Timeout if we wait more than kThreadSuspendTimeoutMs seconds.
479 UnsafeLogFatalForThreadSuspendAllTimeout();
480 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700481 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700482#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700483 Locks::mutator_lock_->ExclusiveLock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700484#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700485
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700486 long_suspend_ = long_suspend;
487
Mathieu Chartier70a596d2014-12-17 14:56:47 -0800488 const uint64_t end_time = NanoTime();
489 const uint64_t suspend_time = end_time - start_time;
490 suspend_all_historam_.AdjustAndAddValue(suspend_time);
491 if (suspend_time > kLongThreadSuspendThreshold) {
492 LOG(WARNING) << "Suspending all threads took: " << PrettyDuration(suspend_time);
Mathieu Chartier251755c2014-07-15 18:10:25 -0700493 }
494
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800495 if (kDebugLocking) {
496 // Debug check that all threads are suspended.
497 AssertThreadsAreSuspended(self, self);
498 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700499
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700500 ATRACE_END();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700501 ATRACE_BEGIN((std::string("Mutator threads suspended for ") + cause).c_str());
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700502
Jeff Haoc5d824a2014-07-28 18:35:38 -0700503 if (self != nullptr) {
504 VLOG(threads) << *self << " SuspendAll complete";
505 } else {
506 VLOG(threads) << "Thread[null] SuspendAll complete";
507 }
Elliott Hughes8d768a92011-09-14 16:35:25 -0700508}
509
Yu Lieac44242015-06-29 10:50:03 +0800510// Ensures all threads running Java suspend and that those not running Java don't start.
511// Debugger thread might be set to kRunnable for a short period of time after the
512// SuspendAllInternal. This is safe because it will be set back to suspended state before
513// the SuspendAll returns.
514void ThreadList::SuspendAllInternal(Thread* self, Thread* ignore1, Thread* ignore2,
515 bool debug_suspend) {
516 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
517 Locks::thread_list_lock_->AssertNotHeld(self);
518 Locks::thread_suspend_count_lock_->AssertNotHeld(self);
519 if (kDebugLocking && self != nullptr) {
520 CHECK_NE(self->GetState(), kRunnable);
521 }
522
523 // First request that all threads suspend, then wait for them to suspend before
524 // returning. This suspension scheme also relies on other behaviour:
525 // 1. Threads cannot be deleted while they are suspended or have a suspend-
526 // request flag set - (see Unregister() below).
527 // 2. When threads are created, they are created in a suspended state (actually
528 // kNative) and will never begin executing Java code without first checking
529 // the suspend-request flag.
530
531 // The atomic counter for number of threads that need to pass the barrier.
532 AtomicInteger pending_threads;
533 uint32_t num_ignored = 0;
534 if (ignore1 != nullptr) {
535 ++num_ignored;
536 }
537 if (ignore2 != nullptr && ignore1 != ignore2) {
538 ++num_ignored;
539 }
540 {
541 MutexLock mu(self, *Locks::thread_list_lock_);
542 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
543 // Update global suspend all state for attaching threads.
544 ++suspend_all_count_;
545 if (debug_suspend)
546 ++debug_suspend_all_count_;
547 pending_threads.StoreRelaxed(list_.size() - num_ignored);
548 // Increment everybody's suspend count (except those that should be ignored).
549 for (const auto& thread : list_) {
550 if (thread == ignore1 || thread == ignore2) {
551 continue;
552 }
553 VLOG(threads) << "requesting thread suspend: " << *thread;
554 while (true) {
555 if (LIKELY(thread->ModifySuspendCount(self, +1, &pending_threads, debug_suspend))) {
556 break;
557 } else {
558 // Failure means the list of active_suspend_barriers is full, we should release the
559 // thread_suspend_count_lock_ (to avoid deadlock) and wait till the target thread has
560 // executed Thread::PassActiveSuspendBarriers(). Note that we could not simply wait for
561 // the thread to change to a suspended state, because it might need to run checkpoint
562 // function before the state change, which also needs thread_suspend_count_lock_.
563
564 // This is very unlikely to happen since more than kMaxSuspendBarriers threads need to
565 // execute SuspendAllInternal() simultaneously, and target thread stays in kRunnable
566 // in the mean time.
567 Locks::thread_suspend_count_lock_->ExclusiveUnlock(self);
568 NanoSleep(100000);
569 Locks::thread_suspend_count_lock_->ExclusiveLock(self);
570 }
571 }
572
573 // Must install the pending_threads counter first, then check thread->IsSuspend() and clear
574 // the counter. Otherwise there's a race with Thread::TransitionFromRunnableToSuspended()
575 // that can lead a thread to miss a call to PassActiveSuspendBarriers().
576 if (thread->IsSuspended()) {
577 // Only clear the counter for the current thread.
578 thread->ClearSuspendBarrier(&pending_threads);
579 pending_threads.FetchAndSubSequentiallyConsistent(1);
580 }
581 }
582 }
583
584 // Wait for the barrier to be passed by all runnable threads. This wait
585 // is done with a timeout so that we can detect problems.
Mathieu Chartier19af1172015-07-14 10:05:45 -0700586#if ART_USE_FUTEXES
Yu Lieac44242015-06-29 10:50:03 +0800587 timespec wait_timeout;
588 InitTimeSpec(true, CLOCK_MONOTONIC, 10000, 0, &wait_timeout);
Mathieu Chartier19af1172015-07-14 10:05:45 -0700589#endif
Yu Lieac44242015-06-29 10:50:03 +0800590 while (true) {
591 int32_t cur_val = pending_threads.LoadRelaxed();
592 if (LIKELY(cur_val > 0)) {
593#if ART_USE_FUTEXES
594 if (futex(pending_threads.Address(), FUTEX_WAIT, cur_val, &wait_timeout, nullptr, 0) != 0) {
595 // EAGAIN and EINTR both indicate a spurious failure, try again from the beginning.
596 if ((errno != EAGAIN) && (errno != EINTR)) {
597 if (errno == ETIMEDOUT) {
598 LOG(kIsDebugBuild ? FATAL : ERROR) << "Unexpected time out during suspend all.";
599 } else {
600 PLOG(FATAL) << "futex wait failed for SuspendAllInternal()";
601 }
602 }
603 } else {
604 cur_val = pending_threads.LoadRelaxed();
605 CHECK_EQ(cur_val, 0);
606 break;
607 }
608#else
609 // Spin wait. This is likely to be slow, but on most architecture ART_USE_FUTEXES is set.
610#endif
611 } else {
612 CHECK_EQ(cur_val, 0);
613 break;
614 }
615 }
616}
617
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700618void ThreadList::ResumeAll() {
619 Thread* self = Thread::Current();
620
Jeff Haoc5d824a2014-07-28 18:35:38 -0700621 if (self != nullptr) {
622 VLOG(threads) << *self << " ResumeAll starting";
623 } else {
624 VLOG(threads) << "Thread[null] ResumeAll starting";
625 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700626
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700627 ATRACE_END();
628 ATRACE_BEGIN("Resuming mutator threads");
629
Mathieu Chartier6dda8982014-03-06 11:11:48 -0800630 if (kDebugLocking) {
631 // Debug check that all threads are suspended.
632 AssertThreadsAreSuspended(self, self);
633 }
Ian Rogers01ae5802012-09-28 16:14:01 -0700634
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700635 long_suspend_ = false;
636
Ian Rogers81d425b2012-09-27 16:03:43 -0700637 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700638 {
Ian Rogers81d425b2012-09-27 16:03:43 -0700639 MutexLock mu(self, *Locks::thread_list_lock_);
640 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700641 // Update global suspend all state for attaching threads.
642 --suspend_all_count_;
643 // Decrement the suspend counts for all threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -0700644 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700645 if (thread == self) {
646 continue;
647 }
Yu Lieac44242015-06-29 10:50:03 +0800648 thread->ModifySuspendCount(self, -1, nullptr, false);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700649 }
650
651 // Broadcast a notification to all suspended threads, some or all of
652 // which may choose to wake up. No need to wait for them.
Jeff Haoc5d824a2014-07-28 18:35:38 -0700653 if (self != nullptr) {
654 VLOG(threads) << *self << " ResumeAll waking others";
655 } else {
656 VLOG(threads) << "Thread[null] ResumeAll waking others";
657 }
Ian Rogersc604d732012-10-14 16:09:54 -0700658 Thread::resume_cond_->Broadcast(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700659 }
Mathieu Chartier6f365cc2014-04-23 12:42:27 -0700660 ATRACE_END();
Jeff Haoc5d824a2014-07-28 18:35:38 -0700661
662 if (self != nullptr) {
663 VLOG(threads) << *self << " ResumeAll complete";
664 } else {
665 VLOG(threads) << "Thread[null] ResumeAll complete";
666 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700667}
668
669void ThreadList::Resume(Thread* thread, bool for_debugger) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800670 // This assumes there was an ATRACE_BEGIN when we suspended the thread.
671 ATRACE_END();
672
Ian Rogers81d425b2012-09-27 16:03:43 -0700673 Thread* self = Thread::Current();
674 DCHECK_NE(thread, self);
Brian Carlstromba32de42014-08-27 23:43:46 -0700675 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") starting..."
676 << (for_debugger ? " (debugger)" : "");
Elliott Hughes01158d72011-09-19 19:47:10 -0700677
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700678 {
679 // To check Contains.
Ian Rogers81d425b2012-09-27 16:03:43 -0700680 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700681 // To check IsSuspended.
Ian Rogers81d425b2012-09-27 16:03:43 -0700682 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
683 DCHECK(thread->IsSuspended());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700684 if (!Contains(thread)) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700685 // We only expect threads within the thread-list to have been suspended otherwise we can't
686 // stop such threads from delete-ing themselves.
687 LOG(ERROR) << "Resume(" << reinterpret_cast<void*>(thread)
688 << ") thread not within thread list";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700689 return;
690 }
Yu Lieac44242015-06-29 10:50:03 +0800691 thread->ModifySuspendCount(self, -1, nullptr, for_debugger);
Elliott Hughes01158d72011-09-19 19:47:10 -0700692 }
693
694 {
Brian Carlstromba32de42014-08-27 23:43:46 -0700695 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") waking others";
Ian Rogers81d425b2012-09-27 16:03:43 -0700696 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -0700697 Thread::resume_cond_->Broadcast(self);
Elliott Hughes01158d72011-09-19 19:47:10 -0700698 }
699
Brian Carlstromba32de42014-08-27 23:43:46 -0700700 VLOG(threads) << "Resume(" << reinterpret_cast<void*>(thread) << ") complete";
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700701}
Elliott Hughes01158d72011-09-19 19:47:10 -0700702
Ian Rogersc7dd2952014-10-21 23:31:19 -0700703static void ThreadSuspendByPeerWarning(Thread* self, LogSeverity severity, const char* message,
704 jobject peer) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700705 JNIEnvExt* env = self->GetJniEnv();
706 ScopedLocalRef<jstring>
Mathieu Chartierbf44d422015-06-02 11:42:18 -0700707 scoped_name_string(env, (jstring)env->GetObjectField(
708 peer, WellKnownClasses::java_lang_Thread_name));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700709 ScopedUtfChars scoped_name_chars(env, scoped_name_string.get());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700710 if (scoped_name_chars.c_str() == nullptr) {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700711 LOG(severity) << message << ": " << peer;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700712 env->ExceptionClear();
713 } else {
Ian Rogersc7dd2952014-10-21 23:31:19 -0700714 LOG(severity) << message << ": " << peer << ":" << scoped_name_chars.c_str();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700715 }
716}
717
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700718Thread* ThreadList::SuspendThreadByPeer(jobject peer, bool request_suspension,
719 bool debug_suspension, bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800720 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800721 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700722 *timed_out = false;
Mathieu Chartier99143862015-02-03 14:26:46 -0800723 Thread* const self = Thread::Current();
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800724 Thread* suspended_thread = nullptr;
Brian Carlstromba32de42014-08-27 23:43:46 -0700725 VLOG(threads) << "SuspendThreadByPeer starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700726 while (true) {
727 Thread* thread;
728 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700729 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
730 // is requesting another suspend, to avoid deadlock, by requiring this function be called
731 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
732 // than request thread suspension, to avoid potential cycles in threads requesting each other
733 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700734 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800735 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700736 thread = Thread::FromManagedThread(soa, peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700737 if (thread == nullptr) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800738 if (suspended_thread != nullptr) {
739 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
740 // If we incremented the suspend count but the thread reset its peer, we need to
741 // re-decrement it since it is shutting down and may deadlock the runtime in
742 // ThreadList::WaitForOtherNonDaemonThreadsToExit.
Yu Lieac44242015-06-29 10:50:03 +0800743 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800744 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700745 ThreadSuspendByPeerWarning(self, WARNING, "No such thread for suspend", peer);
Brian Carlstromba32de42014-08-27 23:43:46 -0700746 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700747 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700748 if (!Contains(thread)) {
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800749 CHECK(suspended_thread == nullptr);
Brian Carlstromba32de42014-08-27 23:43:46 -0700750 VLOG(threads) << "SuspendThreadByPeer failed for unattached thread: "
751 << reinterpret_cast<void*>(thread);
752 return nullptr;
753 }
754 VLOG(threads) << "SuspendThreadByPeer found thread: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700755 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800756 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700757 if (request_suspension) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800758 if (self->GetSuspendCount() > 0) {
759 // We hold the suspend count lock but another thread is trying to suspend us. Its not
760 // safe to try to suspend another thread in case we get a cycle. Start the loop again
761 // which will allow this thread to be suspended.
762 continue;
763 }
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800764 CHECK(suspended_thread == nullptr);
765 suspended_thread = thread;
Yu Lieac44242015-06-29 10:50:03 +0800766 suspended_thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700767 request_suspension = false;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700768 } else {
769 // If the caller isn't requesting suspension, a suspension should have already occurred.
770 CHECK_GT(thread->GetSuspendCount(), 0);
771 }
772 // IsSuspended on the current thread will fail as the current thread is changed into
773 // Runnable above. As the suspend count is now raised if this is the current thread
774 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
775 // to just explicitly handle the current thread in the callers to this code.
776 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
777 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
778 // count, or else we've waited and it has self suspended) or is the current thread, we're
779 // done.
780 if (thread->IsSuspended()) {
Brian Carlstromba32de42014-08-27 23:43:46 -0700781 VLOG(threads) << "SuspendThreadByPeer thread suspended: " << *thread;
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800782 if (ATRACE_ENABLED()) {
783 std::string name;
784 thread->GetThreadName(name);
785 ATRACE_BEGIN(StringPrintf("SuspendThreadByPeer suspended %s for peer=%p", name.c_str(),
786 peer).c_str());
787 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700788 return thread;
789 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800790 const uint64_t total_delay = NanoTime() - start_time;
791 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700792 ThreadSuspendByPeerWarning(self, FATAL, "Thread suspension timed out", peer);
Mathieu Chartier82a800d2014-12-15 15:59:49 -0800793 if (suspended_thread != nullptr) {
794 CHECK_EQ(suspended_thread, thread);
Yu Lieac44242015-06-29 10:50:03 +0800795 suspended_thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700796 }
797 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700798 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800799 } else if (sleep_us == 0 &&
800 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
801 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
802 // excessive CPU usage.
803 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700804 }
805 }
806 // Release locks and come out of runnable state.
807 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800808 VLOG(threads) << "SuspendThreadByPeer waiting to allow thread chance to suspend";
809 ThreadSuspendSleep(sleep_us);
810 // This may stay at 0 if sleep_us == 0, but this is WAI since we want to avoid using usleep at
811 // all if possible. This shouldn't be an issue since time to suspend should always be small.
812 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700813 }
814}
815
Ian Rogersc7dd2952014-10-21 23:31:19 -0700816static void ThreadSuspendByThreadIdWarning(LogSeverity severity, const char* message,
817 uint32_t thread_id) {
818 LOG(severity) << StringPrintf("%s: %d", message, thread_id);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700819}
820
821Thread* ThreadList::SuspendThreadByThreadId(uint32_t thread_id, bool debug_suspension,
822 bool* timed_out) {
Mathieu Chartier3a958aa2015-02-04 12:52:34 -0800823 const uint64_t start_time = NanoTime();
Mathieu Chartier99143862015-02-03 14:26:46 -0800824 useconds_t sleep_us = kThreadSuspendInitialSleepUs;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700825 *timed_out = false;
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800826 Thread* suspended_thread = nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800827 Thread* const self = Thread::Current();
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700828 CHECK_NE(thread_id, kInvalidThreadId);
Brian Carlstromba32de42014-08-27 23:43:46 -0700829 VLOG(threads) << "SuspendThreadByThreadId starting";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700830 while (true) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700831 {
Ian Rogersf3d874c2014-07-17 18:52:42 -0700832 // Note: this will transition to runnable and potentially suspend. We ensure only one thread
833 // is requesting another suspend, to avoid deadlock, by requiring this function be called
834 // holding Locks::thread_list_suspend_thread_lock_. Its important this thread suspend rather
835 // than request thread suspension, to avoid potential cycles in threads requesting each other
836 // suspend.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700837 ScopedObjectAccess soa(self);
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800838 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Ian Rogersf3d874c2014-07-17 18:52:42 -0700839 Thread* thread = nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700840 for (const auto& it : list_) {
841 if (it->GetThreadId() == thread_id) {
842 thread = it;
843 break;
844 }
845 }
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800846 if (thread == nullptr) {
847 CHECK(suspended_thread == nullptr) << "Suspended thread " << suspended_thread
848 << " no longer in thread list";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700849 // There's a race in inflating a lock and the owner giving up ownership and then dying.
850 ThreadSuspendByThreadIdWarning(WARNING, "No such thread id for suspend", thread_id);
Brian Carlstromba32de42014-08-27 23:43:46 -0700851 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700852 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700853 VLOG(threads) << "SuspendThreadByThreadId found thread: " << *thread;
854 DCHECK(Contains(thread));
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700855 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800856 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800857 if (suspended_thread == nullptr) {
Ian Rogers4ad5cd32014-11-11 23:08:07 -0800858 if (self->GetSuspendCount() > 0) {
859 // We hold the suspend count lock but another thread is trying to suspend us. Its not
860 // safe to try to suspend another thread in case we get a cycle. Start the loop again
861 // which will allow this thread to be suspended.
862 continue;
863 }
Yu Lieac44242015-06-29 10:50:03 +0800864 thread->ModifySuspendCount(self, +1, nullptr, debug_suspension);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800865 suspended_thread = thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700866 } else {
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800867 CHECK_EQ(suspended_thread, thread);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700868 // If the caller isn't requesting suspension, a suspension should have already occurred.
869 CHECK_GT(thread->GetSuspendCount(), 0);
870 }
871 // IsSuspended on the current thread will fail as the current thread is changed into
872 // Runnable above. As the suspend count is now raised if this is the current thread
873 // it will self suspend on transition to Runnable, making it hard to work with. It's simpler
874 // to just explicitly handle the current thread in the callers to this code.
875 CHECK_NE(thread, self) << "Attempt to suspend the current thread for the debugger";
876 // If thread is suspended (perhaps it was already not Runnable but didn't have a suspend
877 // count, or else we've waited and it has self suspended) or is the current thread, we're
878 // done.
879 if (thread->IsSuspended()) {
Mathieu Chartierf0dc8b52014-12-17 10:13:30 -0800880 if (ATRACE_ENABLED()) {
881 std::string name;
882 thread->GetThreadName(name);
883 ATRACE_BEGIN(StringPrintf("SuspendThreadByThreadId suspended %s id=%d",
884 name.c_str(), thread_id).c_str());
885 }
Brian Carlstromba32de42014-08-27 23:43:46 -0700886 VLOG(threads) << "SuspendThreadByThreadId thread suspended: " << *thread;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700887 return thread;
888 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800889 const uint64_t total_delay = NanoTime() - start_time;
890 if (total_delay >= MsToNs(kThreadSuspendTimeoutMs)) {
Mathieu Chartier590fee92013-09-13 13:46:47 -0700891 ThreadSuspendByThreadIdWarning(WARNING, "Thread suspension timed out", thread_id);
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -0800892 if (suspended_thread != nullptr) {
Yu Lieac44242015-06-29 10:50:03 +0800893 thread->ModifySuspendCount(soa.Self(), -1, nullptr, debug_suspension);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700894 }
895 *timed_out = true;
Brian Carlstromba32de42014-08-27 23:43:46 -0700896 return nullptr;
Mathieu Chartier99143862015-02-03 14:26:46 -0800897 } else if (sleep_us == 0 &&
898 total_delay > static_cast<uint64_t>(kThreadSuspendMaxYieldUs) * 1000) {
899 // We have spun for kThreadSuspendMaxYieldUs time, switch to sleeps to prevent
900 // excessive CPU usage.
901 sleep_us = kThreadSuspendMaxYieldUs / 2;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700902 }
903 }
904 // Release locks and come out of runnable state.
905 }
Mathieu Chartier99143862015-02-03 14:26:46 -0800906 VLOG(threads) << "SuspendThreadByThreadId waiting to allow thread chance to suspend";
907 ThreadSuspendSleep(sleep_us);
908 sleep_us = std::min(sleep_us * 2, kThreadSuspendMaxSleepUs);
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700909 }
910}
911
912Thread* ThreadList::FindThreadByThreadId(uint32_t thin_lock_id) {
913 Thread* self = Thread::Current();
914 MutexLock mu(self, *Locks::thread_list_lock_);
915 for (const auto& thread : list_) {
916 if (thread->GetThreadId() == thin_lock_id) {
917 CHECK(thread == self || thread->IsSuspended());
918 return thread;
919 }
920 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700921 return nullptr;
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700922}
923
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700924void ThreadList::SuspendAllForDebugger() {
925 Thread* self = Thread::Current();
926 Thread* debug_thread = Dbg::GetDebugThread();
927
928 VLOG(threads) << *self << " SuspendAllForDebugger starting...";
929
Yu Lieac44242015-06-29 10:50:03 +0800930 SuspendAllInternal(self, self, debug_thread, true);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700931 // Block on the mutator lock until all Runnable threads release their share of access then
932 // immediately unlock again.
933#if HAVE_TIMED_RWLOCK
934 // Timeout if we wait more than 30 seconds.
Ian Rogersc604d732012-10-14 16:09:54 -0700935 if (!Locks::mutator_lock_->ExclusiveLockWithTimeout(self, 30 * 1000, 0)) {
Sebastien Hertzbae182c2013-12-17 10:42:03 +0100936 UnsafeLogFatalForThreadSuspendAllTimeout();
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700937 } else {
Ian Rogers81d425b2012-09-27 16:03:43 -0700938 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700939 }
Ian Rogers66aee5c2012-08-15 17:17:47 -0700940#else
Ian Rogers81d425b2012-09-27 16:03:43 -0700941 Locks::mutator_lock_->ExclusiveLock(self);
942 Locks::mutator_lock_->ExclusiveUnlock(self);
Ian Rogers66aee5c2012-08-15 17:17:47 -0700943#endif
Ian Rogers50b35e22012-10-04 10:09:15 -0700944 AssertThreadsAreSuspended(self, self, debug_thread);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700945
Sebastien Hertzed2be172014-08-19 15:33:43 +0200946 VLOG(threads) << *self << " SuspendAllForDebugger complete";
Elliott Hughes01158d72011-09-19 19:47:10 -0700947}
948
Elliott Hughes475fc232011-10-25 15:00:35 -0700949void ThreadList::SuspendSelfForDebugger() {
Sebastien Hertz1558b572015-02-25 15:05:59 +0100950 Thread* const self = Thread::Current();
951 self->SetReadyForDebugInvoke(true);
Elliott Hughes01158d72011-09-19 19:47:10 -0700952
Elliott Hughes475fc232011-10-25 15:00:35 -0700953 // The debugger thread must not suspend itself due to debugger activity!
954 Thread* debug_thread = Dbg::GetDebugThread();
Elliott Hughes475fc232011-10-25 15:00:35 -0700955 CHECK(self != debug_thread);
jeffhaoa77f0f62012-12-05 17:19:31 -0800956 CHECK_NE(self->GetState(), kRunnable);
957 Locks::mutator_lock_->AssertNotHeld(self);
Elliott Hughes475fc232011-10-25 15:00:35 -0700958
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200959 // The debugger may have detached while we were executing an invoke request. In that case, we
960 // must not suspend ourself.
961 DebugInvokeReq* pReq = self->GetInvokeReq();
962 const bool skip_thread_suspension = (pReq != nullptr && !Dbg::IsDebuggerActive());
963 if (!skip_thread_suspension) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800964 // Collisions with other suspends aren't really interesting. We want
965 // to ensure that we're the only one fiddling with the suspend count
966 // though.
967 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Yu Lieac44242015-06-29 10:50:03 +0800968 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700969 CHECK_GT(self->GetSuspendCount(), 0);
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200970
971 VLOG(threads) << *self << " self-suspending (debugger)";
972 } else {
973 // We must no longer be subject to debugger suspension.
974 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
975 CHECK_EQ(self->GetDebugSuspendCount(), 0) << "Debugger detached without resuming us";
976
977 VLOG(threads) << *self << " not self-suspending because debugger detached during invoke";
jeffhaoa77f0f62012-12-05 17:19:31 -0800978 }
Elliott Hughes475fc232011-10-25 15:00:35 -0700979
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200980 // If the debugger requested an invoke, we need to send the reply and clear the request.
Sebastien Hertz1558b572015-02-25 15:05:59 +0100981 if (pReq != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200982 Dbg::FinishInvokeMethod(pReq);
Sebastien Hertz1558b572015-02-25 15:05:59 +0100983 self->ClearDebugInvokeReq();
Sebastien Hertzcbc50642015-06-01 17:33:12 +0200984 pReq = nullptr; // object has been deleted, clear it for safety.
Sebastien Hertz21e729c2014-02-18 14:16:00 +0100985 }
986
Elliott Hughes475fc232011-10-25 15:00:35 -0700987 // Tell JDWP that we've completed suspension. The JDWP thread can't
988 // tell us to resume before we're fully asleep because we hold the
989 // suspend count lock.
990 Dbg::ClearWaitForEventThread();
991
jeffhaoa77f0f62012-12-05 17:19:31 -0800992 {
993 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700994 while (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800995 Thread::resume_cond_->Wait(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700996 if (self->GetSuspendCount() != 0) {
jeffhaoa77f0f62012-12-05 17:19:31 -0800997 // The condition was signaled but we're still suspended. This
Sebastien Hertzf272af42014-09-18 10:20:42 +0200998 // can happen when we suspend then resume all threads to
999 // update instrumentation or compute monitor info. This can
1000 // also happen if the debugger lets go while a SIGQUIT thread
jeffhaoa77f0f62012-12-05 17:19:31 -08001001 // dump event is pending (assuming SignalCatcher was resumed for
1002 // just long enough to try to grab the thread-suspend lock).
Sebastien Hertzf272af42014-09-18 10:20:42 +02001003 VLOG(jdwp) << *self << " still suspended after undo "
1004 << "(suspend count=" << self->GetSuspendCount() << ", "
1005 << "debug suspend count=" << self->GetDebugSuspendCount() << ")";
jeffhaoa77f0f62012-12-05 17:19:31 -08001006 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001007 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001008 CHECK_EQ(self->GetSuspendCount(), 0);
Elliott Hughes475fc232011-10-25 15:00:35 -07001009 }
jeffhaoa77f0f62012-12-05 17:19:31 -08001010
Sebastien Hertz1558b572015-02-25 15:05:59 +01001011 self->SetReadyForDebugInvoke(false);
Elliott Hughes1f729aa2012-03-02 13:55:41 -08001012 VLOG(threads) << *self << " self-reviving (debugger)";
Elliott Hughes475fc232011-10-25 15:00:35 -07001013}
1014
Sebastien Hertz253fa552014-10-14 17:27:15 +02001015void ThreadList::ResumeAllForDebugger() {
1016 Thread* self = Thread::Current();
1017 Thread* debug_thread = Dbg::GetDebugThread();
Sebastien Hertz253fa552014-10-14 17:27:15 +02001018
1019 VLOG(threads) << *self << " ResumeAllForDebugger starting...";
1020
1021 // Threads can't resume if we exclusively hold the mutator lock.
1022 Locks::mutator_lock_->AssertNotExclusiveHeld(self);
1023
1024 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001025 MutexLock thread_list_mu(self, *Locks::thread_list_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001026 {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001027 MutexLock suspend_count_mu(self, *Locks::thread_suspend_count_lock_);
Sebastien Hertz253fa552014-10-14 17:27:15 +02001028 // Update global suspend all state for attaching threads.
1029 DCHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001030 if (debug_suspend_all_count_ > 0) {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001031 --suspend_all_count_;
1032 --debug_suspend_all_count_;
Sebastien Hertz253fa552014-10-14 17:27:15 +02001033 } else {
1034 // We've been asked to resume all threads without being asked to
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001035 // suspend them all before. That may happen if a debugger tries
1036 // to resume some suspended threads (with suspend count == 1)
1037 // at once with a VirtualMachine.Resume command. Let's print a
1038 // warning.
Sebastien Hertz253fa552014-10-14 17:27:15 +02001039 LOG(WARNING) << "Debugger attempted to resume all threads without "
1040 << "having suspended them all before.";
1041 }
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001042 // Decrement everybody's suspend count (except our own).
1043 for (const auto& thread : list_) {
1044 if (thread == self || thread == debug_thread) {
1045 continue;
1046 }
1047 if (thread->GetDebugSuspendCount() == 0) {
1048 // This thread may have been individually resumed with ThreadReference.Resume.
1049 continue;
1050 }
1051 VLOG(threads) << "requesting thread resume: " << *thread;
Yu Lieac44242015-06-29 10:50:03 +08001052 thread->ModifySuspendCount(self, -1, nullptr, true);
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001053 }
Sebastien Hertz253fa552014-10-14 17:27:15 +02001054 }
1055 }
1056
Sebastien Hertzf9d233d2015-01-09 14:51:41 +01001057 {
Sebastien Hertz253fa552014-10-14 17:27:15 +02001058 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1059 Thread::resume_cond_->Broadcast(self);
1060 }
1061
1062 VLOG(threads) << *self << " ResumeAllForDebugger complete";
1063}
1064
Elliott Hughes234ab152011-10-26 14:02:26 -07001065void ThreadList::UndoDebuggerSuspensions() {
1066 Thread* self = Thread::Current();
1067
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001068 VLOG(threads) << *self << " UndoDebuggerSuspensions starting";
Elliott Hughes234ab152011-10-26 14:02:26 -07001069
1070 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001071 MutexLock mu(self, *Locks::thread_list_lock_);
1072 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001073 // Update global suspend all state for attaching threads.
1074 suspend_all_count_ -= debug_suspend_all_count_;
1075 debug_suspend_all_count_ = 0;
1076 // Update running threads.
Mathieu Chartier02e25112013-08-14 16:14:24 -07001077 for (const auto& thread : list_) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001078 if (thread == self || thread->GetDebugSuspendCount() == 0) {
Elliott Hughes234ab152011-10-26 14:02:26 -07001079 continue;
1080 }
Yu Lieac44242015-06-29 10:50:03 +08001081 thread->ModifySuspendCount(self, -thread->GetDebugSuspendCount(), nullptr, true);
Elliott Hughes234ab152011-10-26 14:02:26 -07001082 }
1083 }
1084
1085 {
Ian Rogers81d425b2012-09-27 16:03:43 -07001086 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001087 Thread::resume_cond_->Broadcast(self);
Elliott Hughes234ab152011-10-26 14:02:26 -07001088 }
1089
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08001090 VLOG(threads) << "UndoDebuggerSuspensions(" << *self << ") complete";
Elliott Hughes234ab152011-10-26 14:02:26 -07001091}
1092
Elliott Hughese52e49b2012-04-02 16:05:44 -07001093void ThreadList::WaitForOtherNonDaemonThreadsToExit() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001094 Thread* self = Thread::Current();
1095 Locks::mutator_lock_->AssertNotHeld(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001096 while (true) {
Ian Rogers120f1c72012-09-28 17:17:10 -07001097 {
1098 // No more threads can be born after we start to shutdown.
1099 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -07001100 CHECK(Runtime::Current()->IsShuttingDownLocked());
Ian Rogers120f1c72012-09-28 17:17:10 -07001101 CHECK_EQ(Runtime::Current()->NumberOfThreadsBeingBorn(), 0U);
1102 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001103 MutexLock mu(self, *Locks::thread_list_lock_);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001104 // Also wait for any threads that are unregistering to finish. This is required so that no
1105 // threads access the thread list after it is deleted. TODO: This may not work for user daemon
1106 // threads since they could unregister at the wrong time.
1107 bool done = unregistering_count_ == 0;
1108 if (done) {
1109 for (const auto& thread : list_) {
1110 if (thread != self && !thread->IsDaemon()) {
1111 done = false;
1112 break;
1113 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001114 }
1115 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001116 if (done) {
1117 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001118 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001119 // Wait for another thread to exit before re-checking.
1120 Locks::thread_exit_cond_->Wait(self);
1121 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001122}
1123
1124void ThreadList::SuspendAllDaemonThreads() {
Ian Rogers81d425b2012-09-27 16:03:43 -07001125 Thread* self = Thread::Current();
1126 MutexLock mu(self, *Locks::thread_list_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001127 { // Tell all the daemons it's time to suspend.
Ian Rogers81d425b2012-09-27 16:03:43 -07001128 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001129 for (const auto& thread : list_) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001130 // This is only run after all non-daemon threads have exited, so the remainder should all be
1131 // daemons.
Ian Rogers7e762862012-10-22 15:45:08 -07001132 CHECK(thread->IsDaemon()) << *thread;
Ian Rogers81d425b2012-09-27 16:03:43 -07001133 if (thread != self) {
Yu Lieac44242015-06-29 10:50:03 +08001134 thread->ModifySuspendCount(self, +1, nullptr, false);
Elliott Hughese52e49b2012-04-02 16:05:44 -07001135 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001136 }
1137 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001138 // Give the threads a chance to suspend, complaining if they're slow.
1139 bool have_complained = false;
1140 for (int i = 0; i < 10; ++i) {
1141 usleep(200 * 1000);
1142 bool all_suspended = true;
Mathieu Chartier02e25112013-08-14 16:14:24 -07001143 for (const auto& thread : list_) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001144 if (thread != self && thread->GetState() == kRunnable) {
Elliott Hughes038a8062011-09-18 14:12:41 -07001145 if (!have_complained) {
1146 LOG(WARNING) << "daemon thread not yet suspended: " << *thread;
1147 have_complained = true;
1148 }
1149 all_suspended = false;
1150 }
1151 }
1152 if (all_suspended) {
1153 return;
1154 }
1155 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001156 LOG(ERROR) << "suspend all daemons failed";
1157}
1158void ThreadList::Register(Thread* self) {
1159 DCHECK_EQ(self, Thread::Current());
1160
1161 if (VLOG_IS_ON(threads)) {
1162 std::ostringstream oss;
1163 self->ShortDump(oss); // We don't hold the mutator_lock_ yet and so cannot call Dump.
Ian Rogers5a9ba012014-05-19 13:28:52 -07001164 LOG(INFO) << "ThreadList::Register() " << *self << "\n" << oss.str();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001165 }
1166
1167 // Atomically add self to the thread list and make its thread_suspend_count_ reflect ongoing
1168 // SuspendAll requests.
Ian Rogers81d425b2012-09-27 16:03:43 -07001169 MutexLock mu(self, *Locks::thread_list_lock_);
1170 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001171 CHECK_GE(suspend_all_count_, debug_suspend_all_count_);
Ian Rogers2966e132014-04-02 08:34:36 -07001172 // Modify suspend count in increments of 1 to maintain invariants in ModifySuspendCount. While
1173 // this isn't particularly efficient the suspend counts are most commonly 0 or 1.
1174 for (int delta = debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001175 self->ModifySuspendCount(self, +1, nullptr, true);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001176 }
Ian Rogers2966e132014-04-02 08:34:36 -07001177 for (int delta = suspend_all_count_ - debug_suspend_all_count_; delta > 0; delta--) {
Yu Lieac44242015-06-29 10:50:03 +08001178 self->ModifySuspendCount(self, +1, nullptr, false);
Ian Rogers01ae5802012-09-28 16:14:01 -07001179 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001180 CHECK(!Contains(self));
1181 list_.push_back(self);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001182 if (kUseReadBarrier) {
Hiroshi Yamauchi00370822015-08-18 14:47:25 -07001183 // Initialize according to the state of the CC collector.
1184 bool is_gc_marking =
1185 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsMarking();
1186 self->SetIsGcMarking(is_gc_marking);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001187 bool weak_ref_access_enabled =
1188 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->IsWeakRefAccessEnabled();
1189 self->SetWeakRefAccessEnabled(weak_ref_access_enabled);
1190 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001191}
1192
1193void ThreadList::Unregister(Thread* self) {
1194 DCHECK_EQ(self, Thread::Current());
Ian Rogers68d8b422014-07-17 11:09:10 -07001195 CHECK_NE(self->GetState(), kRunnable);
1196 Locks::mutator_lock_->AssertNotHeld(self);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001197
1198 VLOG(threads) << "ThreadList::Unregister() " << *self;
1199
Mathieu Chartier91e56692015-03-03 13:51:04 -08001200 {
1201 MutexLock mu(self, *Locks::thread_list_lock_);
1202 ++unregistering_count_;
1203 }
1204
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001205 // Any time-consuming destruction, plus anything that can call back into managed code or
Mathieu Chartier91e56692015-03-03 13:51:04 -08001206 // suspend and so on, must happen at this point, and not in ~Thread. The self->Destroy is what
1207 // causes the threads to join. It is important to do this after incrementing unregistering_count_
1208 // since we want the runtime to wait for the daemon threads to exit before deleting the thread
1209 // list.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001210 self->Destroy();
1211
Jeff Haoe094b872014-10-14 13:12:01 -07001212 // If tracing, remember thread id and name before thread exits.
1213 Trace::StoreExitingThreadInfo(self);
1214
Ian Rogersdd7624d2014-03-14 17:43:00 -07001215 uint32_t thin_lock_id = self->GetThreadId();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001216 while (true) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001217 // Remove and delete the Thread* while holding the thread_list_lock_ and
1218 // thread_suspend_count_lock_ so that the unregistering thread cannot be suspended.
Ian Rogers0878d652013-04-18 17:38:35 -07001219 // Note: deliberately not using MutexLock that could hold a stale self pointer.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001220 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001221 if (!Contains(self)) {
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001222 std::string thread_name;
1223 self->GetThreadName(thread_name);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001224 std::ostringstream os;
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001225 DumpNativeStack(os, GetTid(), nullptr, " native: ", nullptr);
Mathieu Chartier9db831a2015-02-24 17:20:30 -08001226 LOG(ERROR) << "Request to unregister unattached thread " << thread_name << "\n" << os.str();
Mathieu Chartier91e56692015-03-03 13:51:04 -08001227 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001228 } else {
Mathieu Chartier91e56692015-03-03 13:51:04 -08001229 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
Ian Rogersa2af5c72014-09-15 15:17:07 -07001230 if (!self->IsSuspended()) {
1231 list_.remove(self);
Mathieu Chartier91e56692015-03-03 13:51:04 -08001232 break;
Ian Rogersa2af5c72014-09-15 15:17:07 -07001233 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001234 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001235 // We failed to remove the thread due to a suspend request, loop and try again.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001236 }
Mathieu Chartier91e56692015-03-03 13:51:04 -08001237 delete self;
1238
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001239 // Release the thread ID after the thread is finished and deleted to avoid cases where we can
1240 // temporarily have multiple threads with the same thread id. When this occurs, it causes
1241 // problems in FindThreadByThreadId / SuspendThreadByThreadId.
1242 ReleaseThreadId(nullptr, thin_lock_id);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001243
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001244 // Clear the TLS data, so that the underlying native thread is recognizably detached.
1245 // (It may wish to reattach later.)
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001246#ifdef __ANDROID__
1247 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = nullptr;
1248#else
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001249 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, nullptr), "detach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001250#endif
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001251
1252 // Signal that a thread just detached.
Mathieu Chartier91e56692015-03-03 13:51:04 -08001253 MutexLock mu(nullptr, *Locks::thread_list_lock_);
1254 --unregistering_count_;
1255 Locks::thread_exit_cond_->Broadcast(nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001256}
1257
1258void ThreadList::ForEach(void (*callback)(Thread*, void*), void* context) {
Mathieu Chartier02e25112013-08-14 16:14:24 -07001259 for (const auto& thread : list_) {
1260 callback(thread, context);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001261 }
1262}
1263
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001264void ThreadList::VisitRoots(RootVisitor* visitor) const {
Ian Rogers81d425b2012-09-27 16:03:43 -07001265 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001266 for (const auto& thread : list_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001267 thread->VisitRoots(visitor);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001268 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001269}
1270
Ian Rogerscfaa4552012-11-26 21:00:08 -08001271uint32_t ThreadList::AllocThreadId(Thread* self) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001272 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Elliott Hughes8daa0922011-09-11 13:46:25 -07001273 for (size_t i = 0; i < allocated_ids_.size(); ++i) {
1274 if (!allocated_ids_[i]) {
1275 allocated_ids_.set(i);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001276 return i + 1; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001277 }
1278 }
1279 LOG(FATAL) << "Out of internal thread ids";
1280 return 0;
1281}
1282
Ian Rogerscfaa4552012-11-26 21:00:08 -08001283void ThreadList::ReleaseThreadId(Thread* self, uint32_t id) {
Chao-ying Fu9e369312014-05-21 11:20:52 -07001284 MutexLock mu(self, *Locks::allocated_thread_ids_lock_);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001285 --id; // Zero is reserved to mean "invalid".
Elliott Hughes8daa0922011-09-11 13:46:25 -07001286 DCHECK(allocated_ids_[id]) << id;
1287 allocated_ids_.reset(id);
1288}
1289
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001290ScopedSuspendAll::ScopedSuspendAll(const char* cause, bool long_suspend) {
1291 Runtime::Current()->GetThreadList()->SuspendAll(cause, long_suspend);
1292}
1293
1294ScopedSuspendAll::~ScopedSuspendAll() {
1295 Runtime::Current()->GetThreadList()->ResumeAll();
1296}
1297
Elliott Hughes8daa0922011-09-11 13:46:25 -07001298} // namespace art