blob: 66e852a216e40c4224a3f0bfc30eab306d80cde3 [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35: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 */
Carl Shapirob5573532011-07-12 18:22:59 -070016
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "thread.h"
Carl Shapirob5573532011-07-12 18:22:59 -070018
Brian Carlstrom640a1042017-03-20 15:03:42 -070019#if !defined(__APPLE__)
20#include <sched.h>
21#endif
22
Ian Rogersb033c752011-07-20 12:22:35 -070023#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070024#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080025#include <sys/resource.h>
26#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070027
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -070028#if __has_feature(hwaddress_sanitizer)
29#include <sanitizer/hwasan_interface.h>
30#else
31#define __hwasan_tag_pointer(p, t) (p)
32#endif
33
Carl Shapirob5573532011-07-12 18:22:59 -070034#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070035#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070036#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070037#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070038#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070039#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070040
Andreas Gampe46ee31b2016-12-14 10:11:49 -080041#include "android-base/stringprintf.h"
42
Mathieu Chartiera62b4532017-04-26 13:16:25 -070043#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070044#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070045#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070046#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000047#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010048#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010049#include "base/casts.h"
David Sehr891a50e2017-10-27 17:01:07 -070050#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070051#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080052#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070053#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070054#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080055#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070056#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080057#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010059#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070060#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080061#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080062#include "dex/dex_file-inl.h"
63#include "dex/dex_file_annotations.h"
64#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070065#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080066#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070067#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000068#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070069#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070070#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070071#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070072#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070073#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070074#include "indirect_reference_table-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070075#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010076#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010077#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070078#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010079#include "jni/java_vm_ext.h"
80#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070081#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070082#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070083#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080084#include "mirror/object_array-inl.h"
85#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070086#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080087#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070088#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070089#include "nativehelper/scoped_local_ref.h"
90#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070091#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010092#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070093#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070094#include "object_lock.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010095#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070096#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080097#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050098#include "reflection.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010099#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700100#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800101#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700102#include "scoped_thread_state_change-inl.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700103#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100104#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700105#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700106#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700107#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800108#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700109#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700110
Yu Lieac44242015-06-29 10:50:03 +0800111#if ART_USE_FUTEXES
112#include "linux/futex.h"
113#include "sys/syscall.h"
114#ifndef SYS_futex
115#define SYS_futex __NR_futex
116#endif
117#endif // ART_USE_FUTEXES
118
Carl Shapirob5573532011-07-12 18:22:59 -0700119namespace art {
120
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800121using android::base::StringAppendV;
122using android::base::StringPrintf;
123
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700124extern "C" NO_RETURN void artDeoptimize(Thread* self);
125
Ian Rogers0878d652013-04-18 17:38:35 -0700126bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700127pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800128ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700129const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100130bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100131Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100132
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700133static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700134
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700135// For implicit overflow checks we reserve an extra piece of memory at the bottom
136// of the stack (lowest memory). The higher portion of the memory
137// is protected against reads and the lower is available for use while
138// throwing the StackOverflow exception.
139constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
140
Elliott Hughes7dc51662012-05-16 14:48:43 -0700141static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
142
Ian Rogers5d76c432011-10-31 21:42:49 -0700143void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700144 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700145}
146
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700147static void UnimplementedEntryPoint() {
148 UNIMPLEMENTED(FATAL);
149}
150
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700151void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700152void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800153
154void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
155 CHECK(kUseReadBarrier);
156 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700157 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800158 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800159}
Ian Rogers7655f292013-07-29 11:07:13 -0700160
Ian Rogers848871b2013-08-05 10:56:33 -0700161void Thread::InitTlsEntryPoints() {
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700162 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700163 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800164 uintptr_t* end = reinterpret_cast<uintptr_t*>(
165 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700166 for (uintptr_t* it = begin; it != end; ++it) {
167 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
168 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700169 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700170}
171
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800172void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000173 if (kUseReadBarrier && kRuntimeISA != InstructionSet::kX86_64) {
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800174 // Allocation entrypoint switching is currently only implemented for X86_64.
175 is_marking = true;
176 }
177 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700178}
179
Sebastien Hertz07474662015-08-25 15:12:33 +0000180class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200181 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100182 DeoptimizationContextRecord(const JValue& ret_val,
183 bool is_reference,
184 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800185 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700186 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000187 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100188 : ret_val_(ret_val),
189 is_reference_(is_reference),
190 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800191 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700192 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000193 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200194
195 JValue GetReturnValue() const { return ret_val_; }
196 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100197 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800198 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000199 DeoptimizationContextRecord* GetLink() const { return link_; }
200 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200201 DCHECK(is_reference_);
202 return ret_val_.GetGCRoot();
203 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000204 mirror::Object** GetPendingExceptionAsGCRoot() {
205 return reinterpret_cast<mirror::Object**>(&pending_exception_);
206 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700207 DeoptimizationMethodType GetDeoptimizationMethodType() const {
208 return deopt_method_type_;
209 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200210
211 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000212 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200213 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200214
Sebastien Hertz07474662015-08-25 15:12:33 +0000215 // Indicates whether the returned value is a reference. If so, the GC will visit it.
216 const bool is_reference_;
217
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100218 // Whether the context was created from an explicit deoptimization in the code.
219 const bool from_code_;
220
Sebastien Hertz07474662015-08-25 15:12:33 +0000221 // The exception that was pending before deoptimization (or null if there was no pending
222 // exception).
223 mirror::Throwable* pending_exception_;
224
Mingyao Yang2ee17902017-08-30 11:37:08 -0700225 // Whether the context was created for an (idempotent) runtime method.
226 const DeoptimizationMethodType deopt_method_type_;
227
Sebastien Hertz07474662015-08-25 15:12:33 +0000228 // A link to the previous DeoptimizationContextRecord.
229 DeoptimizationContextRecord* const link_;
230
231 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200232};
233
234class StackedShadowFrameRecord {
235 public:
236 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
237 StackedShadowFrameType type,
238 StackedShadowFrameRecord* link)
239 : shadow_frame_(shadow_frame),
240 type_(type),
241 link_(link) {}
242
243 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
244 StackedShadowFrameType GetType() const { return type_; }
245 StackedShadowFrameRecord* GetLink() const { return link_; }
246
247 private:
248 ShadowFrame* const shadow_frame_;
249 const StackedShadowFrameType type_;
250 StackedShadowFrameRecord* const link_;
251
252 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
253};
254
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100255void Thread::PushDeoptimizationContext(const JValue& return_value,
256 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700257 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100258 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700259 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000260 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
261 return_value,
262 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100263 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000264 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700265 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000266 tlsPtr_.deoptimization_context_stack);
267 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700268}
269
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100270void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800271 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700272 bool* from_code,
273 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000274 AssertHasDeoptimizationContext();
275 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
276 tlsPtr_.deoptimization_context_stack = record->GetLink();
277 result->SetJ(record->GetReturnValue().GetJ());
278 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100279 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700280 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700281 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000282}
283
284void Thread::AssertHasDeoptimizationContext() {
285 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
286 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800287}
288
Charles Mungeraa31f492018-11-01 18:57:38 +0000289enum {
290 kPermitAvailable = 0, // Incrementing consumes the permit
291 kNoPermit = 1, // Incrementing marks as waiter waiting
292 kNoPermitWaiterWaiting = 2
293};
294
295void Thread::Park(bool is_absolute, int64_t time) {
296 DCHECK(this == Thread::Current());
297#if ART_USE_FUTEXES
298 // Consume the permit, or mark as waiting. This cannot cause park_state to go
299 // outside of its valid range (0, 1, 2), because in all cases where 2 is
300 // assigned it is set back to 1 before returning, and this method cannot run
301 // concurrently with itself since it operates on the current thread.
302 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
303 if (old_state == kNoPermit) {
304 // no permit was available. block thread until later.
305 // TODO: Call to signal jvmti here
306 int result = 0;
307 if (!is_absolute && time == 0) {
308 // Thread.getState() is documented to return waiting for untimed parks.
309 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
310 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
311 result = futex(tls32_.park_state_.Address(),
312 FUTEX_WAIT_PRIVATE,
313 /* sleep if val = */ kNoPermitWaiterWaiting,
314 /* timeout */ nullptr,
315 nullptr,
316 0);
317 } else if (time > 0) {
318 // Only actually suspend and futex_wait if we're going to wait for some
319 // positive amount of time - the kernel will reject negative times with
320 // EINVAL, and a zero time will just noop.
321
322 // Thread.getState() is documented to return timed wait for timed parks.
323 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
324 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
325 timespec timespec;
326 if (is_absolute) {
327 // Time is millis when scheduled for an absolute time
328 timespec.tv_nsec = (time % 1000) * 1000000;
329 timespec.tv_sec = time / 1000;
330 // This odd looking pattern is recommended by futex documentation to
331 // wait until an absolute deadline, with otherwise identical behavior to
332 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
333 // correct time when the system clock changes.
334 result = futex(tls32_.park_state_.Address(),
335 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
336 /* sleep if val = */ kNoPermitWaiterWaiting,
337 &timespec,
338 nullptr,
339 FUTEX_BITSET_MATCH_ANY);
340 } else {
341 // Time is nanos when scheduled for a relative time
342 timespec.tv_sec = time / 1000000000;
343 timespec.tv_nsec = time % 1000000000;
344 result = futex(tls32_.park_state_.Address(),
345 FUTEX_WAIT_PRIVATE,
346 /* sleep if val = */ kNoPermitWaiterWaiting,
347 &timespec,
348 nullptr,
349 0);
350 }
351 }
352 if (result == -1) {
353 switch (errno) {
354 case EAGAIN:
355 case ETIMEDOUT:
356 case EINTR: break; // park() is allowed to spuriously return
357 default: PLOG(FATAL) << "Failed to park";
358 }
359 }
360 // Mark as no longer waiting, and consume permit if there is one.
361 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
362 // TODO: Call to signal jvmti here
363 } else {
364 // the fetch_add has consumed the permit. immediately return.
365 DCHECK_EQ(old_state, kPermitAvailable);
366 }
367#else
368 #pragma clang diagnostic push
369 #pragma clang diagnostic warning "-W#warnings"
370 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
371 #pragma clang diagnostic pop
372 UNUSED(is_absolute, time);
373 UNIMPLEMENTED(WARNING);
374 sched_yield();
375#endif
376}
377
378void Thread::Unpark() {
379#if ART_USE_FUTEXES
380 // Set permit available; will be consumed either by fetch_add (when the thread
381 // tries to park) or store (when the parked thread is woken up)
382 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
383 == kNoPermitWaiterWaiting) {
384 int result = futex(tls32_.park_state_.Address(),
385 FUTEX_WAKE_PRIVATE,
386 /* number of waiters = */ 1,
387 nullptr,
388 nullptr,
389 0);
390 if (result == -1) {
391 PLOG(FATAL) << "Failed to unpark";
392 }
393 }
394#else
395 UNIMPLEMENTED(WARNING);
396#endif
397}
398
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700399void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
400 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
401 sf, type, tlsPtr_.stacked_shadow_frame_record);
402 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800403}
404
Andreas Gampe639bdd12015-06-03 11:22:45 -0700405ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700406 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700407 if (must_be_present) {
408 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700409 } else {
410 if (record == nullptr || record->GetType() != type) {
411 return nullptr;
412 }
413 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700414 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
415 ShadowFrame* shadow_frame = record->GetShadowFrame();
416 delete record;
417 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700418}
419
Mingyao Yang99170c62015-07-06 11:10:37 -0700420class FrameIdToShadowFrame {
421 public:
422 static FrameIdToShadowFrame* Create(size_t frame_id,
423 ShadowFrame* shadow_frame,
424 FrameIdToShadowFrame* next,
425 size_t num_vregs) {
426 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
427 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
428 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
429 }
430
431 static void Delete(FrameIdToShadowFrame* f) {
432 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
433 delete[] memory;
434 }
435
436 size_t GetFrameId() const { return frame_id_; }
437 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
438 FrameIdToShadowFrame* GetNext() const { return next_; }
439 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
440 bool* GetUpdatedVRegFlags() {
441 return updated_vreg_flags_;
442 }
443
444 private:
445 FrameIdToShadowFrame(size_t frame_id,
446 ShadowFrame* shadow_frame,
447 FrameIdToShadowFrame* next)
448 : frame_id_(frame_id),
449 shadow_frame_(shadow_frame),
450 next_(next) {}
451
452 const size_t frame_id_;
453 ShadowFrame* const shadow_frame_;
454 FrameIdToShadowFrame* next_;
455 bool updated_vreg_flags_[0];
456
457 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
458};
459
460static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
461 size_t frame_id) {
462 FrameIdToShadowFrame* found = nullptr;
463 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
464 if (record->GetFrameId() == frame_id) {
465 if (kIsDebugBuild) {
466 // Sanity check we have at most one record for this frame.
467 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
468 found = record;
469 } else {
470 return record;
471 }
472 }
473 }
474 return found;
475}
476
477ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
478 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
479 tlsPtr_.frame_id_to_shadow_frame, frame_id);
480 if (record != nullptr) {
481 return record->GetShadowFrame();
482 }
483 return nullptr;
484}
485
486// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
487bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
488 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
489 tlsPtr_.frame_id_to_shadow_frame, frame_id);
490 CHECK(record != nullptr);
491 return record->GetUpdatedVRegFlags();
492}
493
494ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
495 uint32_t num_vregs,
496 ArtMethod* method,
497 uint32_t dex_pc) {
498 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
499 if (shadow_frame != nullptr) {
500 return shadow_frame;
501 }
David Sehr709b0702016-10-13 09:12:37 -0700502 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700503 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
504 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
505 shadow_frame,
506 tlsPtr_.frame_id_to_shadow_frame,
507 num_vregs);
508 for (uint32_t i = 0; i < num_vregs; i++) {
509 // Do this to clear all references for root visitors.
510 shadow_frame->SetVRegReference(i, nullptr);
511 // This flag will be changed to true if the debugger modifies the value.
512 record->GetUpdatedVRegFlags()[i] = false;
513 }
514 tlsPtr_.frame_id_to_shadow_frame = record;
515 return shadow_frame;
516}
517
Alex Light184f0752018-07-13 11:18:22 -0700518TLSData* Thread::GetCustomTLS(const char* key) {
519 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
520 auto it = custom_tls_.find(key);
521 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
522}
523
524void Thread::SetCustomTLS(const char* key, TLSData* data) {
525 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
526 // custom_tls_lock_.
527 std::unique_ptr<TLSData> old_data(data);
528 {
529 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
530 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
531 }
532}
533
Mingyao Yang99170c62015-07-06 11:10:37 -0700534void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
535 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
536 if (head->GetFrameId() == frame_id) {
537 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
538 FrameIdToShadowFrame::Delete(head);
539 return;
540 }
541 FrameIdToShadowFrame* prev = head;
542 for (FrameIdToShadowFrame* record = head->GetNext();
543 record != nullptr;
544 prev = record, record = record->GetNext()) {
545 if (record->GetFrameId() == frame_id) {
546 prev->SetNext(record->GetNext());
547 FrameIdToShadowFrame::Delete(record);
548 return;
549 }
550 }
551 LOG(FATAL) << "No shadow frame for frame " << frame_id;
552 UNREACHABLE();
553}
554
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700555void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700556 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700557}
558
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700559void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700560 // One thread (us) survived the fork, but we have a new tid so we need to
561 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700562 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700563}
564
Brian Carlstrom78128a62011-09-15 17:21:19 -0700565void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700566 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700567 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800568 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700569 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800570 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700571 }
572 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700573 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
574 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800575 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700576 // Check that if we got here we cannot be shutting down (as shutdown should never have started
577 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700578 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700579 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
580 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
581 // the runtime in such a case. In case this ever changes, we need to make sure here to
582 // delete the tmp_jni_env, as we own it at this point.
583 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
584 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700585 Runtime::Current()->EndThreadBirth();
586 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700587 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700588 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800589 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800590
591 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700592 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700593 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700594 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
595 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800596 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100597
Andreas Gampe08883de2016-11-08 13:20:52 -0800598 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100599 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000600
Andreas Gampeac30fa22017-01-18 21:02:36 -0800601 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700602
Charles Mungeraa31f492018-11-01 18:57:38 +0000603 // Unpark ourselves if the java peer was unparked before it started (see
604 // b/28845097#comment49 for more information)
605
606 ArtField* unparkedField = jni::DecodeArtField(
607 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
608 bool should_unpark = false;
609 {
610 // Hold the lock here, so that if another thread calls unpark before the thread starts
611 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
612 // which could cause a lost unpark.
613 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
614 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
615 }
616 if (should_unpark) {
617 self->Unpark();
618 }
Ian Rogers365c1022012-06-22 15:05:28 -0700619 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800620 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700621 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700622 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
623 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700624 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700625 // Detach and delete self.
626 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700627
Dave Allison0aded082013-11-07 13:15:11 -0800628 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700629}
630
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700631Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800632 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800633 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100634 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700635 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
636 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700637 if (kIsDebugBuild) {
638 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800639 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700640 Locks::thread_list_lock_->AssertHeld(soa.Self());
641 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700642 }
643 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800644}
645
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700646Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
647 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100648 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700649}
650
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700651static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700652 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700653 if (stack_size == 0) {
654 stack_size = Runtime::Current()->GetDefaultStackSize();
655 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700656
Brian Carlstrom6414a972012-04-14 14:20:04 -0700657 // Dalvik used the bionic pthread default stack size for native threads,
658 // so include that here to support apps that expect large native stacks.
659 stack_size += 1 * MB;
660
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700661 // Under sanitization, frames of the interpreter may become bigger, both for C code as
662 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
663 // of all core classes cannot be done in all test circumstances.
664 if (kMemoryToolIsAvailable) {
665 stack_size = std::max(2 * MB, stack_size);
666 }
667
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700668 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
669 if (stack_size < PTHREAD_STACK_MIN) {
670 stack_size = PTHREAD_STACK_MIN;
671 }
672
Dave Allisonf9439142014-03-27 15:10:22 -0700673 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
674 // It's likely that callers are trying to ensure they have at least a certain amount of
675 // stack space, so we should add our reserved space on top of what they requested, rather
676 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700677 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700678 } else {
679 // If we are going to use implicit stack checks, allocate space for the protected
680 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000681 stack_size += Thread::kStackOverflowImplicitCheckSize +
682 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700683 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700684
685 // Some systems require the stack size to be a multiple of the system page size, so round up.
686 stack_size = RoundUp(stack_size, kPageSize);
687
688 return stack_size;
689}
690
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700691// Return the nearest page-aligned address below the current stack top.
692NO_INLINE
693static uint8_t* FindStackTop() {
694 return reinterpret_cast<uint8_t*>(
695 AlignDown(__builtin_frame_address(0), kPageSize));
696}
697
Dave Allisonf9439142014-03-27 15:10:22 -0700698// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700699// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700700ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700701void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700702 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700703 // Page containing current top of stack.
704 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700705
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700706 // Try to directly protect the stack.
707 VLOG(threads) << "installing stack protected region at " << std::hex <<
708 static_cast<void*>(pregion) << " to " <<
709 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700710 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700711 // Tell the kernel that we won't be needing these pages any more.
712 // NB. madvise will probably write zeroes into the memory (on linux it does).
713 uint32_t unwanted_size = stack_top - pregion - kPageSize;
714 madvise(pregion, unwanted_size, MADV_DONTNEED);
715 return;
716 }
717
718 // There is a little complexity here that deserves a special mention. On some
719 // architectures, the stack is created using a VM_GROWSDOWN flag
720 // to prevent memory being allocated when it's not needed. This flag makes the
721 // kernel only allocate memory for the stack by growing down in memory. Because we
722 // want to put an mprotected region far away from that at the stack top, we need
723 // to make sure the pages for the stack are mapped in before we call mprotect.
724 //
725 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
726 // with a non-mapped stack (usually only the main thread).
727 //
728 // We map in the stack by reading every page from the stack bottom (highest address)
729 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700730 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700731 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700732 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
733 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
734 // thus have to move the stack pointer. We do this portably by using a recursive function with a
735 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700736
Andreas Gampe6c63f862017-06-28 17:20:15 -0700737 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700738 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700739 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000740
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700741 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
742 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000743
Andreas Gampe6c63f862017-06-28 17:20:15 -0700744 struct RecurseDownStack {
745 // This function has an intentionally large stack size.
746#pragma GCC diagnostic push
747#pragma GCC diagnostic ignored "-Wframe-larger-than="
748 NO_INLINE
749 static void Touch(uintptr_t target) {
750 volatile size_t zero = 0;
751 // Use a large local volatile array to ensure a large frame size. Do not use anything close
752 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
753 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700754 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
755 constexpr size_t kAsanMultiplier =
756#ifdef ADDRESS_SANITIZER
757 2u;
758#else
759 1u;
760#endif
761 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700762 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700763 // Remove tag from the pointer. Nop in non-hwasan builds.
764 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
765 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700766 Touch(target);
767 }
768 zero *= 2; // Try to avoid tail recursion.
769 }
770#pragma GCC diagnostic pop
771 };
772 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000773
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700774 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700775 static_cast<void*>(pregion) << " to " <<
776 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
777
Dave Allison648d7112014-07-25 16:15:27 -0700778 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700779 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700780
781 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000782 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700783 uint32_t unwanted_size = stack_top - pregion - kPageSize;
784 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700785}
786
Ian Rogers120f1c72012-09-28 17:17:10 -0700787void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800788 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800789 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700790
791 if (VLOG_IS_ON(threads)) {
792 ScopedObjectAccess soa(env);
793
Andreas Gampe08883de2016-11-08 13:20:52 -0800794 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700795 ObjPtr<mirror::String> java_name =
796 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700797 std::string thread_name;
798 if (java_name != nullptr) {
799 thread_name = java_name->ToModifiedUtf8();
800 } else {
801 thread_name = "(Unnamed)";
802 }
803
804 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700805 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700806 }
807
Ian Rogers120f1c72012-09-28 17:17:10 -0700808 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700809
Ian Rogers120f1c72012-09-28 17:17:10 -0700810 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
811 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700812 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700813 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700814 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700815 thread_start_during_shutdown = true;
816 } else {
817 runtime->StartThreadBirth();
818 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700819 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700820 if (thread_start_during_shutdown) {
821 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
822 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
823 return;
824 }
825
826 Thread* child_thread = new Thread(is_daemon);
827 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700828 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700829 stack_size = FixStackSize(stack_size);
830
Roland Levillain2ae376f2018-01-30 11:35:11 +0000831 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
832 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800833 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
834 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700835
Andreas Gampe449357d2015-06-01 22:29:51 -0700836 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
837 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100838 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700839 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100840 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700841
Andreas Gampe449357d2015-06-01 22:29:51 -0700842 int pthread_create_result = 0;
843 if (child_jni_env_ext.get() != nullptr) {
844 pthread_t new_pthread;
845 pthread_attr_t attr;
846 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
847 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
848 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
849 "PTHREAD_CREATE_DETACHED");
850 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
851 pthread_create_result = pthread_create(&new_pthread,
852 &attr,
853 Thread::CreateCallback,
854 child_thread);
855 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
856
857 if (pthread_create_result == 0) {
858 // pthread_create started the new thread. The child is now responsible for managing the
859 // JNIEnvExt we created.
860 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
861 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700862 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700863 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700864 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700865 }
866
867 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
868 {
869 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
870 runtime->EndThreadBirth();
871 }
872 // Manually delete the global reference since Thread::Init will not have been run.
873 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
874 child_thread->tlsPtr_.jpeer = nullptr;
875 delete child_thread;
876 child_thread = nullptr;
877 // TODO: remove from thread group?
878 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
879 {
880 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100881 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700882 StringPrintf("pthread_create (%s stack) failed: %s",
883 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
884 ScopedObjectAccess soa(env);
885 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700886 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700887}
888
Andreas Gampe449357d2015-06-01 22:29:51 -0700889bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700890 // This function does all the initialization that must be run by the native thread it applies to.
891 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
892 // we can handshake with the corresponding native thread when it's ready.) Check this native
893 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800894 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800895
896 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
897 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
898 tlsPtr_.pthread_self = pthread_self();
899 CHECK(is_started_);
900
Elliott Hughesd8af1592012-04-16 20:40:15 -0700901 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800902 if (!InitStackHwm()) {
903 return false;
904 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700905 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700906 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800907 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700908 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700909 InitTid();
buzbee1452bee2015-03-06 14:43:04 -0800910 interpreter::InitInterpreterTls(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800911
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100912#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000913 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
914#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700915 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000916#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700917 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700918
Ian Rogersdd7624d2014-03-14 17:43:00 -0700919 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700920
Andreas Gampe449357d2015-06-01 22:29:51 -0700921 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800922 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
923 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700924 tlsPtr_.jni_env = jni_env_ext;
925 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100926 std::string error_msg;
927 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700928 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100929 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700930 return false;
931 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700932 }
933
Ian Rogers120f1c72012-09-28 17:17:10 -0700934 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800935 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700936}
937
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800938template <typename PeerAction>
939Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700940 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800941 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900942 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
943 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800944 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700945 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800946 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700947 {
Dave Allison0aded082013-11-07 13:15:11 -0800948 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700949 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900950 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
951 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800952 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700953 } else {
954 Runtime::Current()->StartThreadBirth();
955 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800956 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700957 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800958 if (!init_success) {
959 delete self;
960 return nullptr;
961 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700962 }
963 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700964
Jeff Hao848f70a2014-01-15 13:49:50 -0800965 self->InitStringEntryPoints();
966
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700967 CHECK_NE(self->GetState(), kRunnable);
968 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700969
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800970 // Run the action that is acting on the peer.
971 if (!peer_action(self)) {
972 runtime->GetThreadList()->Unregister(self);
973 // Unregister deletes self, no need to do this here.
974 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700975 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700976
Andreas Gampe56623832015-07-09 21:53:15 -0700977 if (VLOG_IS_ON(threads)) {
978 if (thread_name != nullptr) {
979 VLOG(threads) << "Attaching thread " << thread_name;
980 } else {
981 VLOG(threads) << "Attaching unnamed thread.";
982 }
983 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700984 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700985 }
986
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200987 {
988 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -0800989 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200990 }
991
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700992 return self;
993}
994
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800995Thread* Thread::Attach(const char* thread_name,
996 bool as_daemon,
997 jobject thread_group,
998 bool create_peer) {
999 auto create_peer_action = [&](Thread* self) {
1000 // If we're the main thread, ClassLinker won't be created until after we're attached,
1001 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1002 // In the compiler, all threads need this hack, because no-one's going to be getting
1003 // a native peer!
1004 if (create_peer) {
1005 self->CreatePeer(thread_name, as_daemon, thread_group);
1006 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001007 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1008 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001009 {
1010 ScopedObjectAccess soa(self);
1011 LOG(ERROR) << "Exception creating thread peer:";
1012 LOG(ERROR) << self->GetException()->Dump();
1013 self->ClearException();
1014 }
1015 return false;
1016 }
1017 } else {
1018 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1019 if (thread_name != nullptr) {
1020 self->tlsPtr_.name->assign(thread_name);
1021 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001022 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001023 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1024 }
1025 }
1026 return true;
1027 };
1028 return Attach(thread_name, as_daemon, create_peer_action);
1029}
1030
1031Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1032 auto set_peer_action = [&](Thread* self) {
1033 // Install the given peer.
1034 {
1035 DCHECK(self == Thread::Current());
1036 ScopedObjectAccess soa(self);
1037 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1038 }
1039 self->GetJniEnv()->SetLongField(thread_peer,
1040 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001041 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001042 return true;
1043 };
1044 return Attach(thread_name, as_daemon, set_peer_action);
1045}
1046
Ian Rogers365c1022012-06-22 15:05:28 -07001047void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1048 Runtime* runtime = Runtime::Current();
1049 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001050 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001051
Dave Allison0aded082013-11-07 13:15:11 -08001052 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001053 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001054 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001055 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001056 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001057 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001058 CHECK(IsExceptionPending());
1059 return;
1060 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001061 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001062 jboolean thread_is_daemon = as_daemon;
1063
Elliott Hugheseac76672012-05-24 21:56:51 -07001064 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001065 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001066 CHECK(IsExceptionPending());
1067 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001068 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001069 {
1070 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001071 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001072 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001073 env->CallNonvirtualVoidMethod(peer.get(),
1074 WellKnownClasses::java_lang_Thread,
1075 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001076 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001077 if (IsExceptionPending()) {
1078 return;
1079 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001080
Ian Rogers120f1c72012-09-28 17:17:10 -07001081 Thread* self = this;
1082 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001083 env->SetLongField(peer.get(),
1084 WellKnownClasses::java_lang_Thread_nativePeer,
1085 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001086
1087 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001088 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001089 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001090 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001091 // The Thread constructor should have set the Thread.name to a
1092 // non-null value. However, because we can run without code
1093 // available (in the compiler, in tests), we manually assign the
1094 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001095 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001096 InitPeer<true>(soa,
1097 tlsPtr_.opeer,
1098 thread_is_daemon,
1099 thread_group,
1100 thread_name.get(),
1101 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001102 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001103 InitPeer<false>(soa,
1104 tlsPtr_.opeer,
1105 thread_is_daemon,
1106 thread_group,
1107 thread_name.get(),
1108 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001109 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001110 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001111 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001112 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001113 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001114 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001115 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001116}
1117
Andreas Gampebad529d2017-02-13 18:52:10 -08001118jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1119 const char* name,
1120 bool as_daemon,
1121 jobject thread_group) {
1122 Runtime* runtime = Runtime::Current();
1123 CHECK(!runtime->IsStarted());
1124
1125 if (thread_group == nullptr) {
1126 thread_group = runtime->GetMainThreadGroup();
1127 }
1128 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1129 // Add missing null check in case of OOM b/18297817
1130 if (name != nullptr && thread_name.get() == nullptr) {
1131 CHECK(Thread::Current()->IsExceptionPending());
1132 return nullptr;
1133 }
1134 jint thread_priority = GetNativePriority();
1135 jboolean thread_is_daemon = as_daemon;
1136
1137 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1138 if (peer.get() == nullptr) {
1139 CHECK(Thread::Current()->IsExceptionPending());
1140 return nullptr;
1141 }
1142
1143 // We cannot call Thread.init, as it will recursively ask for currentThread.
1144
1145 // The Thread constructor should have set the Thread.name to a
1146 // non-null value. However, because we can run without code
1147 // available (in the compiler, in tests), we manually assign the
1148 // fields the constructor should have set.
1149 ScopedObjectAccessUnchecked soa(Thread::Current());
1150 if (runtime->IsActiveTransaction()) {
1151 InitPeer<true>(soa,
1152 soa.Decode<mirror::Object>(peer.get()),
1153 thread_is_daemon,
1154 thread_group,
1155 thread_name.get(),
1156 thread_priority);
1157 } else {
1158 InitPeer<false>(soa,
1159 soa.Decode<mirror::Object>(peer.get()),
1160 thread_is_daemon,
1161 thread_group,
1162 thread_name.get(),
1163 thread_priority);
1164 }
1165
1166 return peer.release();
1167}
1168
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001169template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001170void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1171 ObjPtr<mirror::Object> peer,
1172 jboolean thread_is_daemon,
1173 jobject thread_group,
1174 jobject thread_name,
1175 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001176 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001177 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001178 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001179 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001180 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001181 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001182 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001183 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001184}
1185
Elliott Hughes899e7892012-01-24 14:57:32 -08001186void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001187 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001188 ::art::SetThreadName(name);
1189 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1190}
1191
Andreas Gampe9186ced2016-12-12 14:28:21 -08001192static void GetThreadStack(pthread_t thread,
1193 void** stack_base,
1194 size_t* stack_size,
1195 size_t* guard_size) {
1196#if defined(__APPLE__)
1197 *stack_size = pthread_get_stacksize_np(thread);
1198 void* stack_addr = pthread_get_stackaddr_np(thread);
1199
1200 // Check whether stack_addr is the base or end of the stack.
1201 // (On Mac OS 10.7, it's the end.)
1202 int stack_variable;
1203 if (stack_addr > &stack_variable) {
1204 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1205 } else {
1206 *stack_base = stack_addr;
1207 }
1208
1209 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1210 pthread_attr_t attributes;
1211 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1212 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1213 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1214#else
1215 pthread_attr_t attributes;
1216 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1217 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1218 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1219 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1220
1221#if defined(__GLIBC__)
1222 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1223 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1224 // will be broken because we'll die long before we get close to 2GB.
1225 bool is_main_thread = (::art::GetTid() == getpid());
1226 if (is_main_thread) {
1227 rlimit stack_limit;
1228 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1229 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1230 }
1231 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1232 size_t old_stack_size = *stack_size;
1233
1234 // Use the kernel default limit as our size, and adjust the base to match.
1235 *stack_size = 8 * MB;
1236 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1237
1238 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1239 << " to " << PrettySize(*stack_size)
1240 << " with base " << *stack_base;
1241 }
1242 }
1243#endif
1244
1245#endif
1246}
1247
Ian Rogersf4d4da12014-11-11 16:10:33 -08001248bool Thread::InitStackHwm() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001249 void* read_stack_base;
1250 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001251 size_t read_guard_size;
1252 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001253
Ian Rogers13735952014-10-08 12:43:28 -07001254 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001255 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001256
Dave Allison648d7112014-07-25 16:15:27 -07001257 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1258 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1259 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1260 // between 8K and 12K.
1261 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1262 + 4 * KB;
1263 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001264 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001265 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1266 __LINE__,
1267 ::android::base::ERROR,
1268 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001269 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001270 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001271
Vladimir Markob8f2f632015-01-02 14:23:26 +00001272 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1273 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1274 read_stack_base,
1275 PrettySize(read_stack_size).c_str(),
1276 PrettySize(read_guard_size).c_str());
1277
Ian Rogers932746a2011-09-22 18:57:50 -07001278 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001279
1280 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001281 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001282
Dave Allisonb090a182014-08-14 17:02:48 +00001283 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001284
1285 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001286 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001287 // The thread might have protected region at the bottom. We need
1288 // to install our own region so we need to move the limits
1289 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001290
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001291 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1292 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1293 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001294
1295 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001296 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001297
1298 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001299 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001300
1301 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001302}
1303
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001304void Thread::ShortDump(std::ostream& os) const {
1305 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001306 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001307 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001308 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001309 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001310 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001311 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001312 << ",Thread*=" << this
1313 << ",peer=" << tlsPtr_.opeer
1314 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1315 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001316}
1317
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001318void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1319 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001320 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001321 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001322}
1323
Andreas Gampe08883de2016-11-08 13:20:52 -08001324mirror::String* Thread::GetThreadName() const {
1325 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001326 if (tlsPtr_.opeer == nullptr) {
1327 return nullptr;
1328 }
1329 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1330 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001331}
1332
Elliott Hughesffb465f2012-03-01 18:46:05 -08001333void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001334 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001335}
1336
Jeff Hao57dac6e2013-08-15 16:36:24 -07001337uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001338#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001339 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001340 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001341 timespec now;
1342 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001343 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001344#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001345 UNIMPLEMENTED(WARNING);
1346 return -1;
1347#endif
1348}
1349
Ian Rogers01ae5802012-09-28 16:14:01 -07001350// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1351static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001352 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001353 Locks::thread_suspend_count_lock_->Unlock(self);
1354 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1355 Locks::mutator_lock_->SharedTryLock(self);
1356 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1357 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1358 }
1359 }
1360 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1361 Locks::thread_list_lock_->TryLock(self);
1362 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1363 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1364 }
1365 }
1366 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001367 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001368 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001369}
1370
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001371bool Thread::ModifySuspendCountInternal(Thread* self,
1372 int delta,
1373 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001374 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001375 if (kIsDebugBuild) {
1376 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001377 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001378 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1379 Locks::thread_suspend_count_lock_->AssertHeld(self);
1380 if (this != self && !IsSuspended()) {
1381 Locks::thread_list_lock_->AssertHeld(self);
1382 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001383 }
Alex Light88fd7202017-06-30 08:31:59 -07001384 // User code suspensions need to be checked more closely since they originate from code outside of
1385 // the runtime's control.
1386 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1387 Locks::user_code_suspension_lock_->AssertHeld(self);
1388 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1389 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1390 return false;
1391 }
1392 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001393 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001394 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001395 return false;
1396 }
1397
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001398 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1399 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1400 // deadlock. b/31683379.
1401 return false;
1402 }
1403
Yu Lieac44242015-06-29 10:50:03 +08001404 uint16_t flags = kSuspendRequest;
1405 if (delta > 0 && suspend_barrier != nullptr) {
1406 uint32_t available_barrier = kMaxSuspendBarriers;
1407 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1408 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1409 available_barrier = i;
1410 break;
1411 }
1412 }
1413 if (available_barrier == kMaxSuspendBarriers) {
1414 // No barrier spaces available, we can't add another.
1415 return false;
1416 }
1417 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1418 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001419 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001420
Ian Rogersdd7624d2014-03-14 17:43:00 -07001421 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001422 switch (reason) {
1423 case SuspendReason::kForDebugger:
1424 tls32_.debug_suspend_count += delta;
1425 break;
Alex Light88fd7202017-06-30 08:31:59 -07001426 case SuspendReason::kForUserCode:
1427 tls32_.user_code_suspend_count += delta;
1428 break;
Alex Light46f93402017-06-29 11:59:50 -07001429 case SuspendReason::kInternal:
1430 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001431 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001432
Ian Rogersdd7624d2014-03-14 17:43:00 -07001433 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001434 AtomicClearFlag(kSuspendRequest);
1435 } else {
Yu Lieac44242015-06-29 10:50:03 +08001436 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001437 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001438 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001439 }
Yu Lieac44242015-06-29 10:50:03 +08001440 return true;
1441}
1442
1443bool Thread::PassActiveSuspendBarriers(Thread* self) {
1444 // Grab the suspend_count lock and copy the current set of
1445 // barriers. Then clear the list and the flag. The ModifySuspendCount
1446 // function requires the lock so we prevent a race between setting
1447 // the kActiveSuspendBarrier flag and clearing it.
1448 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1449 {
1450 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1451 if (!ReadFlag(kActiveSuspendBarrier)) {
1452 // quick exit test: the barriers have already been claimed - this is
1453 // possible as there may be a race to claim and it doesn't matter
1454 // who wins.
1455 // All of the callers of this function (except the SuspendAllInternal)
1456 // will first test the kActiveSuspendBarrier flag without lock. Here
1457 // double-check whether the barrier has been passed with the
1458 // suspend_count lock.
1459 return false;
1460 }
1461
1462 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1463 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1464 tlsPtr_.active_suspend_barriers[i] = nullptr;
1465 }
1466 AtomicClearFlag(kActiveSuspendBarrier);
1467 }
1468
1469 uint32_t barrier_count = 0;
1470 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1471 AtomicInteger* pending_threads = pass_barriers[i];
1472 if (pending_threads != nullptr) {
1473 bool done = false;
1474 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001475 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001476 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1477 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001478 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001479#if ART_USE_FUTEXES
1480 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Charles Munger7530bae2018-10-29 20:03:51 -07001481 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, -1, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001482 }
1483#endif
1484 } while (!done);
1485 ++barrier_count;
1486 }
1487 }
1488 CHECK_GT(barrier_count, 0U);
1489 return true;
1490}
1491
1492void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1493 CHECK(ReadFlag(kActiveSuspendBarrier));
1494 bool clear_flag = true;
1495 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1496 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1497 if (ptr == target) {
1498 tlsPtr_.active_suspend_barriers[i] = nullptr;
1499 } else if (ptr != nullptr) {
1500 clear_flag = false;
1501 }
1502 }
1503 if (LIKELY(clear_flag)) {
1504 AtomicClearFlag(kActiveSuspendBarrier);
1505 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001506}
1507
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001508void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001509 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1510 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1511 Closure* checkpoint;
1512 {
1513 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1514 checkpoint = tlsPtr_.checkpoint_function;
1515 if (!checkpoint_overflow_.empty()) {
1516 // Overflow list not empty, copy the first one out and continue.
1517 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1518 checkpoint_overflow_.pop_front();
1519 } else {
1520 // No overflow checkpoints. Clear the kCheckpointRequest flag
1521 tlsPtr_.checkpoint_function = nullptr;
1522 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001523 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001524 }
1525 // Outside the lock, run the checkpoint function.
1526 ScopedTrace trace("Run checkpoint function");
1527 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1528 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001529}
1530
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001531void Thread::RunEmptyCheckpoint() {
1532 DCHECK_EQ(Thread::Current(), this);
1533 AtomicClearFlag(kEmptyCheckpointRequest);
1534 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1535}
1536
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001537bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001538 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001539 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001540 if (old_state_and_flags.as_struct.state != kRunnable) {
1541 return false; // Fail, thread is suspended and so can't run a checkpoint.
1542 }
Dave Allison0aded082013-11-07 13:15:11 -08001543
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001544 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001545 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001546 union StateAndFlags new_state_and_flags;
1547 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001548 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001549 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001550 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001551 if (success) {
1552 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1553 if (tlsPtr_.checkpoint_function == nullptr) {
1554 tlsPtr_.checkpoint_function = function;
1555 } else {
1556 checkpoint_overflow_.push_back(function);
1557 }
Dave Allison0aded082013-11-07 13:15:11 -08001558 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001559 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001560 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001561 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001562}
1563
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001564bool Thread::RequestEmptyCheckpoint() {
1565 union StateAndFlags old_state_and_flags;
1566 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1567 if (old_state_and_flags.as_struct.state != kRunnable) {
1568 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1569 // heap access (eg. the read barrier).
1570 return false;
1571 }
1572
1573 // We must be runnable to request a checkpoint.
1574 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1575 union StateAndFlags new_state_and_flags;
1576 new_state_and_flags.as_int = old_state_and_flags.as_int;
1577 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001578 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001579 old_state_and_flags.as_int, new_state_and_flags.as_int);
1580 if (success) {
1581 TriggerSuspend();
1582 }
1583 return success;
1584}
1585
Andreas Gampee9f67122016-10-27 19:21:23 -07001586class BarrierClosure : public Closure {
1587 public:
1588 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1589
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001590 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001591 wrapped_->Run(self);
1592 barrier_.Pass(self);
1593 }
1594
Alex Light318afe62018-03-22 16:50:10 -07001595 void Wait(Thread* self, ThreadState suspend_state) {
1596 if (suspend_state != ThreadState::kRunnable) {
1597 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1598 } else {
1599 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1600 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001601 }
1602
1603 private:
1604 Closure* wrapped_;
1605 Barrier barrier_;
1606};
1607
Alex Lightb1e31a82017-10-04 16:57:36 -07001608// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001609bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001610 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001611 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001612 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1613 // Unlock the tll before running so that the state is the same regardless of thread.
1614 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001615 // Asked to run on this thread. Just run.
1616 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001617 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001618 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001619
1620 // The current thread is not this thread.
1621
Andreas Gampe28c4a232017-06-21 21:21:31 -07001622 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001623 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001624 return false;
1625 }
1626
Andreas Gampe28c4a232017-06-21 21:21:31 -07001627 struct ScopedThreadListLockUnlock {
1628 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1629 : self_thread(self_in) {
1630 Locks::thread_list_lock_->AssertHeld(self_thread);
1631 Locks::thread_list_lock_->Unlock(self_thread);
1632 }
1633
1634 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1635 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1636 Locks::thread_list_lock_->Lock(self_thread);
1637 }
1638
1639 Thread* self_thread;
1640 };
1641
Andreas Gampee9f67122016-10-27 19:21:23 -07001642 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001643 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001644 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1645 // suspend-count lock for too long.
1646 if (GetState() == ThreadState::kRunnable) {
1647 BarrierClosure barrier_closure(function);
1648 bool installed = false;
1649 {
1650 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1651 installed = RequestCheckpoint(&barrier_closure);
1652 }
1653 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001654 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1655 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1656 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001657 ScopedThreadStateChange sts(self, suspend_state);
1658 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001659 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001660 }
1661 // Fall-through.
1662 }
1663
1664 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1665 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1666 // certain situations.
1667 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001668 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1669
Alex Light46f93402017-06-29 11:59:50 -07001670 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001671 // Just retry the loop.
1672 sched_yield();
1673 continue;
1674 }
1675 }
1676
Andreas Gampe28c4a232017-06-21 21:21:31 -07001677 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001678 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1679 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001680 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001681 {
Alex Light318afe62018-03-22 16:50:10 -07001682 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001683 while (GetState() == ThreadState::kRunnable) {
1684 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1685 // moves us to suspended.
1686 sched_yield();
1687 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001688 }
1689
1690 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001691 }
1692
Andreas Gampee9f67122016-10-27 19:21:23 -07001693 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001694 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1695
1696 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001697 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001698 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001699 }
1700
Andreas Gampe117f9b32017-06-23 13:33:50 -07001701 {
1702 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1703 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1704 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1705 Thread::resume_cond_->Broadcast(self);
1706 }
1707
Alex Lightb1e31a82017-10-04 16:57:36 -07001708 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1709 Locks::thread_list_lock_->ExclusiveUnlock(self);
1710
Andreas Gampe28c4a232017-06-21 21:21:31 -07001711 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001712 }
1713}
1714
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001715Closure* Thread::GetFlipFunction() {
1716 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1717 Closure* func;
1718 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001719 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001720 if (func == nullptr) {
1721 return nullptr;
1722 }
Orion Hodson4557b382018-01-03 11:47:54 +00001723 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001724 DCHECK(func != nullptr);
1725 return func;
1726}
1727
1728void Thread::SetFlipFunction(Closure* function) {
1729 CHECK(function != nullptr);
1730 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001731 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001732}
1733
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001734void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001735 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001736 VLOG(threads) << this << " self-suspending";
1737 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001738 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001739 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001740 VLOG(threads) << this << " self-reviving";
1741}
1742
Andreas Gampe9186ced2016-12-12 14:28:21 -08001743static std::string GetSchedulerGroupName(pid_t tid) {
1744 // /proc/<pid>/cgroup looks like this:
1745 // 2:devices:/
1746 // 1:cpuacct,cpu:/
1747 // We want the third field from the line whose second field contains the "cpu" token.
1748 std::string cgroup_file;
1749 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1750 return "";
1751 }
1752 std::vector<std::string> cgroup_lines;
1753 Split(cgroup_file, '\n', &cgroup_lines);
1754 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1755 std::vector<std::string> cgroup_fields;
1756 Split(cgroup_lines[i], ':', &cgroup_fields);
1757 std::vector<std::string> cgroups;
1758 Split(cgroup_fields[1], ',', &cgroups);
1759 for (size_t j = 0; j < cgroups.size(); ++j) {
1760 if (cgroups[j] == "cpu") {
1761 return cgroup_fields[2].substr(1); // Skip the leading slash.
1762 }
1763 }
1764 }
1765 return "";
1766}
1767
1768
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001769void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001770 std::string group_name;
1771 int priority;
1772 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001773 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001774
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001775 // If flip_function is not null, it means we have run a checkpoint
1776 // before the thread wakes up to execute the flip function and the
1777 // thread roots haven't been forwarded. So the following access to
1778 // the roots (opeer or methods in the frames) would be bad. Run it
1779 // here. TODO: clean up.
1780 if (thread != nullptr) {
1781 ScopedObjectAccessUnchecked soa(self);
1782 Thread* this_thread = const_cast<Thread*>(thread);
1783 Closure* flip_func = this_thread->GetFlipFunction();
1784 if (flip_func != nullptr) {
1785 flip_func->Run(this_thread);
1786 }
1787 }
1788
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001789 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1790 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001791 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001792 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001793 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001794 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001795 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001796 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001797
Mathieu Chartier3398c782016-09-30 10:27:43 -07001798 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001799 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1800 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001801
Dave Allison0aded082013-11-07 13:15:11 -08001802 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001803 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001804 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001805 ObjPtr<mirror::String> group_name_string =
1806 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001807 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001808 }
1809 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001810 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001811 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001812
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001813 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001814 if (scheduler_group_name.empty()) {
1815 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001816 }
1817
Dave Allison0aded082013-11-07 13:15:11 -08001818 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001819 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001820 if (is_daemon) {
1821 os << " daemon";
1822 }
1823 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001824 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001825 << " " << thread->GetState();
1826 if (thread->IsStillStarting()) {
1827 os << " (still starting up)";
1828 }
1829 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001830 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001831 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001832 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001833 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001834 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001835
Dave Allison0aded082013-11-07 13:15:11 -08001836 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001837 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001838 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001839 << " sCount=" << thread->tls32_.suspend_count
1840 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001841 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001842 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001843 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1844 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001845
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001846 os << " | sysTid=" << tid
1847 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001848 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001849 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001850 int policy;
1851 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001852#if !defined(__APPLE__)
1853 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1854 policy = sched_getscheduler(tid);
1855 if (policy == -1) {
1856 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1857 }
1858 int sched_getparam_result = sched_getparam(tid, &sp);
1859 if (sched_getparam_result == -1) {
1860 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1861 sp.sched_priority = -1;
1862 }
1863#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001864 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1865 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001866#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001867 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001868 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001869 }
1870 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001871
1872 // Grab the scheduler stats for this thread.
1873 std::string scheduler_stats;
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001874 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001875 scheduler_stats.resize(scheduler_stats.size() - 1); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001876 } else {
1877 scheduler_stats = "0 0 0";
1878 }
1879
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001880 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001881 int utime = 0;
1882 int stime = 0;
1883 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001884 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001885
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001886 os << " | state=" << native_thread_state
1887 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001888 << " utm=" << utime
1889 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001890 << " core=" << task_cpu
1891 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001892 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001893 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1894 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1895 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001896 // Dump the held mutexes.
1897 os << " | held mutexes=";
1898 for (size_t i = 0; i < kLockLevelCount; ++i) {
1899 if (i != kMonitorLock) {
1900 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1901 if (mutex != nullptr) {
1902 os << " \"" << mutex->GetName() << "\"";
1903 if (mutex->IsReaderWriterMutex()) {
1904 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001905 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001906 os << "(exclusive held)";
1907 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001908 os << "(shared held)";
1909 }
1910 }
1911 }
1912 }
1913 }
1914 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001915 }
1916}
1917
1918void Thread::DumpState(std::ostream& os) const {
1919 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001920}
1921
Andreas Gampe93104952017-12-13 17:13:15 -08001922struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001923 StackDumpVisitor(std::ostream& os_in,
1924 Thread* thread_in,
1925 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001926 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001927 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001928 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001929 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001930 : MonitorObjectsStackVisitor(thread_in,
1931 context,
1932 check_suspended,
1933 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001934 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001935 last_method(nullptr),
1936 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001937 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001938
Ian Rogersbdb03912011-09-14 00:55:44 -07001939 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001940 if (frame_count == 0) {
1941 os << " (no managed stack frames)\n";
1942 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001943 }
1944
Andreas Gampe93104952017-12-13 17:13:15 -08001945 static constexpr size_t kMaxRepetition = 3u;
1946
1947 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001948 override
Andreas Gampe93104952017-12-13 17:13:15 -08001949 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001950 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08001951 ObjPtr<mirror::Class> c = m->GetDeclaringClass();
1952 ObjPtr<mirror::DexCache> dex_cache = c->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001953 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001954 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001955 const DexFile* dex_file = dex_cache->GetDexFile();
1956 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001957 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001958 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001959 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001960 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001961 if (repetition_count >= kMaxRepetition) {
1962 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1963 }
1964 repetition_count = 0;
1965 last_line_number = line_number;
1966 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001967 }
Andreas Gampe93104952017-12-13 17:13:15 -08001968
1969 if (repetition_count >= kMaxRepetition) {
1970 // Skip visiting=printing anything.
1971 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001972 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001973
Andreas Gampe93104952017-12-13 17:13:15 -08001974 os << " at " << m->PrettyMethod(false);
1975 if (m->IsNative()) {
1976 os << "(Native method)";
1977 } else {
1978 const char* source_file(m->GetDeclaringClassSourceFile());
1979 os << "(" << (source_file != nullptr ? source_file : "unavailable")
1980 << ":" << line_number << ")";
1981 }
1982 os << "\n";
1983 // Go and visit locks.
1984 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001985 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001986
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001987 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08001988 return VisitMethodResult::kContinueMethod;
1989 }
1990
1991 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001992 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001993 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08001994 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
1995 }
1996 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001997 override
Andreas Gampe93104952017-12-13 17:13:15 -08001998 REQUIRES_SHARED(Locks::mutator_lock_) {
1999 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2000 }
2001 void VisitBlockedOnObject(mirror::Object* obj,
2002 ThreadState state,
2003 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002004 override
Andreas Gampe93104952017-12-13 17:13:15 -08002005 REQUIRES_SHARED(Locks::mutator_lock_) {
2006 const char* msg;
2007 switch (state) {
2008 case kBlocked:
2009 msg = " - waiting to lock ";
2010 break;
2011
2012 case kWaitingForLockInflation:
2013 msg = " - waiting for lock inflation of ";
2014 break;
2015
2016 default:
2017 LOG(FATAL) << "Unreachable";
2018 UNREACHABLE();
2019 }
2020 PrintObject(obj, msg, owner_tid);
2021 }
2022 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002023 override
Andreas Gampe93104952017-12-13 17:13:15 -08002024 REQUIRES_SHARED(Locks::mutator_lock_) {
2025 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2026 }
2027
2028 void PrintObject(mirror::Object* obj,
2029 const char* msg,
2030 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2031 if (obj == nullptr) {
2032 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002033 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002034 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002035 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2036 // Getting the identity hashcode here would result in lock inflation and suspension of the
2037 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002038 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
2039 reinterpret_cast<intptr_t>(obj),
2040 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002041 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002042 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2043 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2044 // suspension and move pretty_object.
2045 const std::string pretty_type(obj->PrettyTypeOf());
2046 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002047 }
2048 }
Andreas Gampe93104952017-12-13 17:13:15 -08002049 if (owner_tid != ThreadList::kInvalidThreadId) {
2050 os << " held by thread " << owner_tid;
2051 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002052 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002053 }
2054
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002055 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002056 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002057 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002058 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002059};
2060
Ian Rogers33e95662013-05-20 20:29:14 -07002061static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002062 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002063 ThreadState state = thread->GetState();
2064
2065 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2066 if (state > kWaiting && state < kStarting) {
2067 return true;
2068 }
2069
2070 // In an Object.wait variant or Thread.sleep? That's not interesting.
2071 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2072 return false;
2073 }
2074
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002075 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002076 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002077 return true;
2078 }
2079
Elliott Hughesaef701d2013-04-05 18:15:40 -07002080 // In some other native method? That's interesting.
2081 // We don't just check kNative because native methods will be in state kSuspended if they're
2082 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2083 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002084 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002085 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002086}
2087
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002088void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002089 // If flip_function is not null, it means we have run a checkpoint
2090 // before the thread wakes up to execute the flip function and the
2091 // thread roots haven't been forwarded. So the following access to
2092 // the roots (locks or methods in the frames) would be bad. Run it
2093 // here. TODO: clean up.
2094 {
2095 Thread* this_thread = const_cast<Thread*>(this);
2096 Closure* flip_func = this_thread->GetFlipFunction();
2097 if (flip_func != nullptr) {
2098 flip_func->Run(this_thread);
2099 }
2100 }
2101
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002102 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2103 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002104 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2105 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002106 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002107 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002108 bool have_exception = false;
2109 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002110 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002111 const_cast<Thread*>(this)->ClearException();
2112 have_exception = true;
2113 }
2114
Ian Rogers700a4022014-05-19 16:49:03 -07002115 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002116 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002117 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002118 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002119
2120 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002121 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002122 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002123}
2124
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002125void Thread::DumpStack(std::ostream& os,
2126 bool dump_native_stack,
2127 BacktraceMap* backtrace_map,
2128 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002129 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2130 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2131 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002132 bool dump_for_abort = (gAborting > 0);
2133 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2134 if (!kIsDebugBuild) {
2135 // We always want to dump the stack for an abort, however, there is no point dumping another
2136 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2137 safe_to_dump = (safe_to_dump || dump_for_abort);
2138 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002139 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002140 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002141 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002142 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002143 ArtMethod* method =
2144 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002145 /*check_suspended=*/ !force_dump_stack,
2146 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002147 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002148 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002149 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002150 /*check_suspended=*/ !force_dump_stack,
2151 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002152 } else {
2153 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002154 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002155}
2156
Elliott Hughesbe759c62011-09-08 19:38:21 -07002157void Thread::ThreadExitCallback(void* arg) {
2158 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002159 if (self->tls32_.thread_exit_check_count == 0) {
2160 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2161 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002162 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002163#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002164 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2165#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002166 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002167#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002168 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002169 } else {
2170 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2171 }
Carl Shapirob5573532011-07-12 18:22:59 -07002172}
2173
Elliott Hughesbe759c62011-09-08 19:38:21 -07002174void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002175 CHECK(!is_started_);
2176 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002177 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002178 // MutexLock to keep annotalysis happy.
2179 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002180 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002181 // return garbage since (is_started_ == true) and
2182 // Thread::pthread_key_self_ is not yet initialized.
2183 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002184 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002185 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2186 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002187 }
2188
Carl Shapirob5573532011-07-12 18:22:59 -07002189 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002190 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2191 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002192
2193 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002194 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2195 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002196 }
Elliott Hughes038a8062011-09-18 14:12:41 -07002197}
Carl Shapirob5573532011-07-12 18:22:59 -07002198
Elliott Hughes038a8062011-09-18 14:12:41 -07002199void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002200 Runtime* runtime = Runtime::Current();
2201 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002202
Elliott Hughes01158d72011-09-19 19:47:10 -07002203 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002204 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002205 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2206 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002207
Vladimir Markodcfcce42018-06-27 10:00:28 +00002208 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002209
2210 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2211 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002212 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2213 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002214}
2215
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002216void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002217 CHECK(is_started_);
2218 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002219 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002220 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002221 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002222 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002223 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002224 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002225}
2226
Andreas Gampe56776012018-01-26 17:40:55 -08002227void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2228 ScopedLocalRef<jobject> thread_jobject(
2229 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2230 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2231 soa.Env(), nullptr);
2232 jobject thread_group_jobject = thread_group;
2233 if (thread_group == nullptr || kIsDebugBuild) {
2234 // There is always a group set. Retrieve it.
2235 thread_group_jobject_scoped.reset(
2236 soa.Env()->GetObjectField(thread_jobject.get(),
2237 WellKnownClasses::java_lang_Thread_group));
2238 thread_group_jobject = thread_group_jobject_scoped.get();
2239 if (kIsDebugBuild && thread_group != nullptr) {
2240 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2241 }
2242 }
2243 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2244 WellKnownClasses::java_lang_ThreadGroup,
2245 WellKnownClasses::java_lang_ThreadGroup_add,
2246 thread_jobject.get());
2247}
2248
Calin Juravleccd56952016-12-15 17:57:38 +00002249Thread::Thread(bool daemon)
2250 : tls32_(daemon),
2251 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002252 is_runtime_thread_(false) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002253 wait_mutex_ = new Mutex("a thread wait mutex");
2254 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002255 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2256 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2257
Roland Levillain33d69032015-06-18 18:20:59 +01002258 static_assert((sizeof(Thread) % 4) == 0U,
2259 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002260 tls32_.state_and_flags.as_struct.flags = 0;
2261 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002262 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002263 // Initialize with no permit; if the java Thread was unparked before being
2264 // started, it will unpark itself before calling into java code.
2265 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002266 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002267 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002268 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002269 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002270 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002271 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2272 tlsPtr_.active_suspend_barriers[i] = nullptr;
2273 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002274 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002275 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002276 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002277 tls32_.use_mterp = false;
2278}
2279
2280void Thread::NotifyInTheadList() {
2281 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002282}
2283
Alex Lighte9f61032018-09-24 16:04:51 -07002284bool Thread::CanLoadClasses() const {
2285 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2286}
2287
Elliott Hughes7dc51662012-05-16 14:48:43 -07002288bool Thread::IsStillStarting() const {
2289 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002290 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002291 // You might think you can check whether the peer is null, but the peer is actually created and
Elliott Hughes7dc51662012-05-16 14:48:43 -07002292 // assigned fairly early on, and needs to be.
2293 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2294 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002295 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2296 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002297}
2298
Andreas Gamped9efea62014-07-21 22:56:08 -07002299void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002300 CHECK(IsExceptionPending()) << "Pending exception expected.";
2301}
2302
2303void Thread::AssertPendingOOMException() const {
2304 AssertPendingException();
2305 auto* e = GetException();
2306 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2307 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002308}
2309
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002310void Thread::AssertNoPendingException() const {
2311 if (UNLIKELY(IsExceptionPending())) {
2312 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002313 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002314 }
2315}
2316
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002317void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2318 if (UNLIKELY(IsExceptionPending())) {
2319 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002320 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002321 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002322 }
2323}
2324
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002325class MonitorExitVisitor : public SingleRootVisitor {
2326 public:
2327 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2328
2329 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2330 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002331 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002332 if (self_->HoldsLock(entered_monitor)) {
2333 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002334 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002335 << " left locked by native thread "
2336 << *Thread::Current() << " which is detaching";
2337 entered_monitor->MonitorExit(self_);
2338 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002339 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002340
2341 private:
2342 Thread* const self_;
2343};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002344
Elliott Hughesc0f09332012-03-26 13:27:06 -07002345void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002346 Thread* self = this;
2347 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002348
Ian Rogers68d8b422014-07-17 11:09:10 -07002349 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002350 {
2351 ScopedObjectAccess soa(self);
2352 MonitorExitVisitor visitor(self);
2353 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002354 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002355 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002356 // Release locally held global references which releasing may require the mutator lock.
2357 if (tlsPtr_.jpeer != nullptr) {
2358 // If pthread_create fails we don't have a jni env here.
2359 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2360 tlsPtr_.jpeer = nullptr;
2361 }
2362 if (tlsPtr_.class_loader_override != nullptr) {
2363 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2364 tlsPtr_.class_loader_override = nullptr;
2365 }
2366 }
2367
Ian Rogersdd7624d2014-03-14 17:43:00 -07002368 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002369 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002370 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002371 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002372 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002373 Runtime* runtime = Runtime::Current();
2374 if (runtime != nullptr) {
2375 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2376 }
Elliott Hughes534da072012-03-27 15:17:42 -07002377
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002378 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002379 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002380 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002381 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002382 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002383 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002384 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002385 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002386
Ian Rogerscfaa4552012-11-26 21:00:08 -08002387 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2388 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002389 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002390 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002391 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002392 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002393 StackHandleScope<1> hs(self);
2394 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002395 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002396 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002397 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002398 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002399 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002400
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002401 {
2402 ScopedObjectAccess soa(self);
2403 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002404 if (kUseReadBarrier) {
2405 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2406 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002407 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002408}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002409
Elliott Hughesc0f09332012-03-26 13:27:06 -07002410Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002411 CHECK(tlsPtr_.class_loader_override == nullptr);
2412 CHECK(tlsPtr_.jpeer == nullptr);
2413 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002414 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002415 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002416 delete tlsPtr_.jni_env;
2417 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002418 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002419 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002420 CHECK(!ReadFlag(kCheckpointRequest));
2421 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002422 CHECK(tlsPtr_.checkpoint_function == nullptr);
2423 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002424 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002425 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002426
Sebastien Hertz07474662015-08-25 15:12:33 +00002427 // Make sure we processed all deoptimization requests.
2428 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002429 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2430 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002431
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002432 // We may be deleting a still born thread.
2433 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002434
2435 delete wait_cond_;
2436 delete wait_mutex_;
2437
Ian Rogersdd7624d2014-03-14 17:43:00 -07002438 if (tlsPtr_.long_jump_context != nullptr) {
2439 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002440 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002441
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002442 if (initialized) {
2443 CleanupCpu();
2444 }
2445
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002446 if (tlsPtr_.single_step_control != nullptr) {
2447 delete tlsPtr_.single_step_control;
2448 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002449 delete tlsPtr_.instrumentation_stack;
2450 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002451 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002452
Ian Rogers68d8b422014-07-17 11:09:10 -07002453 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002454
Elliott Hughesd8af1592012-04-16 20:40:15 -07002455 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002456}
2457
Andreas Gampe513061a2017-06-01 09:17:34 -07002458void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002459 if (!IsExceptionPending()) {
2460 return;
2461 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002462 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002463 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002464
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002465 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002466 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2467 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002468
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002469 // Call the Thread instance's dispatchUncaughtException(Throwable)
2470 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2471 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2472 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002473
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002474 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002475 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002476}
2477
Andreas Gampe513061a2017-06-01 09:17:34 -07002478void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002479 // this.group.removeThread(this);
2480 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002481 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002482 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002483 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002484 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002485 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002486 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002487 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2488 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2489 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002490 }
2491}
2492
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002493bool Thread::HandleScopeContains(jobject obj) const {
2494 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002495 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002496 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002497 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002498 return true;
2499 }
2500 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002501 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2502 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002503}
2504
Hans Boehm0882af22017-08-31 15:21:57 -07002505void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002506 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2507 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002508 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2509 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002510 }
2511}
2512
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002513ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002514 if (obj == nullptr) {
2515 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002516 }
2517 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002518 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002519 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002520 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002521 // The "kinds" below are sorted by the frequency we expect to encounter them.
2522 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002523 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002524 // Local references do not need a read barrier.
2525 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002526 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002527 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002528 // Check if this is a local reference in the handle scope.
2529 if (LIKELY(HandleScopeContains(obj))) {
2530 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002531 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002532 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002533 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002534 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002535 expect_null = true;
2536 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002537 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002538 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002539 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002540 } else {
2541 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002542 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002543 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002544 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002545 expect_null = true;
2546 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002547 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002548 }
2549
Ian Rogersc0542af2014-09-03 16:16:56 -07002550 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002551 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002552 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002553 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002554 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002555}
2556
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002557bool Thread::IsJWeakCleared(jweak obj) const {
2558 CHECK(obj != nullptr);
2559 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002560 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002561 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002562 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002563}
2564
Ian Rogers81d425b2012-09-27 16:03:43 -07002565// Implements java.lang.Thread.interrupted.
2566bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002567 DCHECK_EQ(Thread::Current(), this);
2568 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002569 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002570 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002571 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002572 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002573 return interrupted;
2574}
2575
2576// Implements java.lang.Thread.isInterrupted.
2577bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002578 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002579}
2580
Ian Rogersdd7624d2014-03-14 17:43:00 -07002581void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002582 {
2583 MutexLock mu(self, *wait_mutex_);
2584 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2585 return;
2586 }
2587 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2588 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002589 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002590 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002591}
2592
2593void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002594 Thread* self = Thread::Current();
2595 MutexLock mu(self, *wait_mutex_);
2596 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002597}
2598
Ian Rogersc604d732012-10-14 16:09:54 -07002599void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002600 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002601 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002602 }
2603}
2604
Ian Rogers68d8b422014-07-17 11:09:10 -07002605void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2606 if (tlsPtr_.class_loader_override != nullptr) {
2607 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2608 }
2609 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2610}
2611
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002612using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2613
2614// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2615class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002616 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002617 explicit FetchStackTraceVisitor(Thread* thread,
2618 ArtMethodDexPcPair* saved_frames = nullptr,
2619 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002620 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002621 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002622 saved_frames_(saved_frames),
2623 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002624
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002625 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002626 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002627 // Note we also skip the frame if it doesn't have a method (namely the callee
2628 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002629 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002630 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002631 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002632 skipping_ = false;
2633 }
2634 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002635 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002636 if (depth_ < max_saved_frames_) {
2637 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002638 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002639 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002640 ++depth_;
2641 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002642 } else {
2643 ++skip_depth_;
2644 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002645 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002646 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002647
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002648 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002649 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002650 }
2651
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002652 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002653 return skip_depth_;
2654 }
2655
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002656 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002657 uint32_t depth_ = 0;
2658 uint32_t skip_depth_ = 0;
2659 bool skipping_ = true;
2660 ArtMethodDexPcPair* saved_frames_;
2661 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002662
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002663 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002664};
2665
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002666template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002667class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002668 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002669 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002670 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2671 self_(self),
2672 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002673 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002674
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002675 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002676 // Allocate method trace as an object array where the first element is a pointer array that
2677 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2678 // class of the ArtMethod pointers.
2679 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2680 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002681 ObjPtr<mirror::Class> array_class =
2682 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002683 // The first element is the methods and dex pc array, the other elements are declaring classes
2684 // for the methods to ensure classes in the stack trace don't get unloaded.
2685 Handle<mirror::ObjectArray<mirror::Object>> trace(
2686 hs.NewHandle(
2687 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002688 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002689 // Acquire uninterruptible_ in all paths.
2690 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002691 self_->AssertPendingOOMException();
2692 return false;
2693 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002694 ObjPtr<mirror::PointerArray> methods_and_pcs =
2695 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002696 const char* last_no_suspend_cause =
2697 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2698 if (methods_and_pcs == nullptr) {
2699 self_->AssertPendingOOMException();
2700 return false;
2701 }
2702 trace->Set(0, methods_and_pcs);
2703 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002704 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002705 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002706 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002707 }
2708
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002709 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2710 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002711 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002712
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002713 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002714 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002715 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002716 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002717 if (skip_depth_ > 0) {
2718 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002719 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002720 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002721 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002722 if (m->IsRuntimeMethod()) {
2723 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002724 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002725 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002726 return true;
2727 }
2728
2729 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002730 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002731 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002732 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2733 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002734 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002735 pointer_size_);
2736 // Save the declaring class of the method to ensure that the declaring classes of the methods
2737 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002738 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002739 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002740 }
2741
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002742 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
2743 return ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(trace_->Get(0)));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002744 }
2745
2746 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002747 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002748 }
2749
2750 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002751 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002752 // How many more frames to skip.
2753 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002754 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002755 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002756 // An object array where the first element is a pointer array that contains the ArtMethod
2757 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2758 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2759 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002760 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002761 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002762 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002763
2764 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002765};
2766
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002767template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002768jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002769 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2770 constexpr size_t kMaxSavedFrames = 256;
2771 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2772 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2773 &saved_frames[0],
2774 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002775 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002776 const uint32_t depth = count_visitor.GetDepth();
2777 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002778
Ian Rogers1f539342012-10-03 21:09:42 -07002779 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002780 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2781 const_cast<Thread*>(this),
2782 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002783 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002784 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002785 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002786 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2787 // than doing the stack walk twice.
2788 if (depth < kMaxSavedFrames) {
2789 for (size_t i = 0; i < depth; ++i) {
2790 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2791 }
2792 } else {
2793 build_trace_visitor.WalkStack();
2794 }
2795
Mathieu Chartier910e8272015-09-30 09:24:22 -07002796 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002797 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002798 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002799 // Second half of trace_methods is dex PCs.
2800 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2801 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002802 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2803 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002804 }
2805 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002806 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002807}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002808template jobject Thread::CreateInternalStackTrace<false>(
2809 const ScopedObjectAccessAlreadyRunnable& soa) const;
2810template jobject Thread::CreateInternalStackTrace<true>(
2811 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002812
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002813bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002814 // Only count the depth since we do not pass a stack frame array as an argument.
2815 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002816 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002817 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002818}
2819
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002820static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2821 const ScopedObjectAccessAlreadyRunnable& soa,
2822 ArtMethod* method,
2823 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2824 int32_t line_number;
2825 StackHandleScope<3> hs(soa.Self());
2826 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2827 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2828 if (method->IsProxyMethod()) {
2829 line_number = -1;
2830 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2831 // source_name_object intentionally left null for proxy methods
2832 } else {
2833 line_number = method->GetLineNumFromDexPC(dex_pc);
2834 // Allocate element, potentially triggering GC
2835 // TODO: reuse class_name_object via Class::name_?
2836 const char* descriptor = method->GetDeclaringClassDescriptor();
2837 CHECK(descriptor != nullptr);
2838 std::string class_name(PrettyDescriptor(descriptor));
2839 class_name_object.Assign(
2840 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2841 if (class_name_object == nullptr) {
2842 soa.Self()->AssertPendingOOMException();
2843 return nullptr;
2844 }
2845 const char* source_file = method->GetDeclaringClassSourceFile();
2846 if (line_number == -1) {
2847 // Make the line_number field of StackTraceElement hold the dex pc.
2848 // source_name_object is intentionally left null if we failed to map the dex pc to
2849 // a line number (most probably because there is no debug info). See b/30183883.
2850 line_number = dex_pc;
2851 } else {
2852 if (source_file != nullptr) {
2853 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2854 if (source_name_object == nullptr) {
2855 soa.Self()->AssertPendingOOMException();
2856 return nullptr;
2857 }
2858 }
2859 }
2860 }
2861 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2862 CHECK(method_name != nullptr);
2863 Handle<mirror::String> method_name_object(
2864 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2865 if (method_name_object == nullptr) {
2866 return nullptr;
2867 }
2868 return mirror::StackTraceElement::Alloc(soa.Self(),
2869 class_name_object,
2870 method_name_object,
2871 source_name_object,
2872 line_number);
2873}
2874
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002875jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002876 const ScopedObjectAccessAlreadyRunnable& soa,
2877 jobject internal,
2878 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002879 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002880 // Decode the internal stack trace into the depth, method trace and PC trace.
2881 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002882 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002883 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002884
Mathieu Chartier910e8272015-09-30 09:24:22 -07002885 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002886
Elliott Hughes01158d72011-09-19 19:47:10 -07002887 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002888
Dave Allison0aded082013-11-07 13:15:11 -08002889 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002890 // Reuse the array we were given.
2891 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002892 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002893 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002894 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002895 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002896 } else {
2897 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002898 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002899 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002900 if (java_traces == nullptr) {
2901 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002902 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002903 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002904 }
2905
Dave Allison0aded082013-11-07 13:15:11 -08002906 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002907 *stack_depth = depth;
2908 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002909
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002910 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002911 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002912 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002913 // Methods and dex PC trace is element 0.
2914 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002915 ObjPtr<mirror::PointerArray> const method_trace =
2916 ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(decoded_traces->Get(0)));
Ian Rogersaaa20802011-09-11 21:47:37 -07002917 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002918 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002919 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002920 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002921 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002922 if (obj == nullptr) {
2923 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002924 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002925 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002926 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002927 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002928 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002929}
2930
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002931jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2932 // This code allocates. Do not allow it to operate with a pending exception.
2933 if (IsExceptionPending()) {
2934 return nullptr;
2935 }
2936
2937 // If flip_function is not null, it means we have run a checkpoint
2938 // before the thread wakes up to execute the flip function and the
2939 // thread roots haven't been forwarded. So the following access to
2940 // the roots (locks or methods in the frames) would be bad. Run it
2941 // here. TODO: clean up.
2942 // Note: copied from DumpJavaStack.
2943 {
2944 Thread* this_thread = const_cast<Thread*>(this);
2945 Closure* flip_func = this_thread->GetFlipFunction();
2946 if (flip_func != nullptr) {
2947 flip_func->Run(this_thread);
2948 }
2949 }
2950
2951 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2952 public:
2953 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2954 Thread* self,
2955 Context* context)
2956 : MonitorObjectsStackVisitor(self, context),
2957 wait_jobject_(soaa_in.Env(), nullptr),
2958 block_jobject_(soaa_in.Env(), nullptr),
2959 soaa_(soaa_in) {}
2960
2961 protected:
2962 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002963 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002964 REQUIRES_SHARED(Locks::mutator_lock_) {
2965 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
2966 soaa_, m, GetDexPc(/* abort on error */ false));
2967 if (obj == nullptr) {
2968 return VisitMethodResult::kEndStackWalk;
2969 }
2970 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
2971 return VisitMethodResult::kContinueMethod;
2972 }
2973
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002974 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002975 lock_objects_.push_back({});
2976 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
2977
2978 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
2979
2980 return VisitMethodResult::kContinueMethod;
2981 }
2982
2983 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002984 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002985 REQUIRES_SHARED(Locks::mutator_lock_) {
2986 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2987 }
2988 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002989 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002990 REQUIRES_SHARED(Locks::mutator_lock_) {
2991 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2992 }
2993 void VisitBlockedOnObject(mirror::Object* obj,
2994 ThreadState state ATTRIBUTE_UNUSED,
2995 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002996 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002997 REQUIRES_SHARED(Locks::mutator_lock_) {
2998 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2999 }
3000 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003001 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003002 REQUIRES_SHARED(Locks::mutator_lock_) {
3003 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3004 }
3005
3006 public:
3007 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3008 ScopedLocalRef<jobject> wait_jobject_;
3009 ScopedLocalRef<jobject> block_jobject_;
3010 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3011
3012 private:
3013 const ScopedObjectAccessAlreadyRunnable& soaa_;
3014
3015 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3016 };
3017
3018 std::unique_ptr<Context> context(Context::Create());
3019 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3020 dumper.WalkStack();
3021
3022 // There should not be a pending exception. Otherwise, return with it pending.
3023 if (IsExceptionPending()) {
3024 return nullptr;
3025 }
3026
3027 // Now go and create Java arrays.
3028
3029 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3030
3031 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003032 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003033 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003034 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3035 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003036 return nullptr;
3037 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003038 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003039
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003040 Handle<mirror::Class> h_o_array_class =
3041 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3042 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003043
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003044
3045 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3046 class_linker->EnsureInitialized(soa.Self(),
3047 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003048 /* can_init_fields= */ true,
3049 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003050 if (soa.Self()->IsExceptionPending()) {
3051 // This should not fail in a healthy runtime.
3052 return nullptr;
3053 }
3054
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003055 ArtField* stack_trace_element_field = h_aste_class->FindField(
3056 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3057 DCHECK(stack_trace_element_field != nullptr);
3058 ArtField* held_locks_field = h_aste_class->FindField(
3059 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3060 DCHECK(held_locks_field != nullptr);
3061 ArtField* blocked_on_field = h_aste_class->FindField(
3062 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3063 DCHECK(blocked_on_field != nullptr);
3064
3065 size_t length = dumper.stack_trace_elements_.size();
3066 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003067 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003068 if (array == nullptr) {
3069 soa.Self()->AssertPendingOOMException();
3070 return nullptr;
3071 }
3072
3073 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3074
3075 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3076 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3077 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3078 for (size_t i = 0; i != length; ++i) {
3079 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3080 if (handle == nullptr) {
3081 soa.Self()->AssertPendingOOMException();
3082 return nullptr;
3083 }
3084
3085 // Set stack trace element.
3086 stack_trace_element_field->SetObject<false>(
3087 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3088
3089 // Create locked-on array.
3090 if (!dumper.lock_objects_[i].empty()) {
3091 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3092 h_o_array_class.Get(),
3093 dumper.lock_objects_[i].size()));
3094 if (handle2 == nullptr) {
3095 soa.Self()->AssertPendingOOMException();
3096 return nullptr;
3097 }
3098 int32_t j = 0;
3099 for (auto& scoped_local : dumper.lock_objects_[i]) {
3100 if (scoped_local == nullptr) {
3101 continue;
3102 }
3103 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3104 DCHECK(!soa.Self()->IsExceptionPending());
3105 j++;
3106 }
3107 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3108 }
3109
3110 // Set blocked-on object.
3111 if (i == 0) {
3112 if (dumper.block_jobject_ != nullptr) {
3113 blocked_on_field->SetObject<false>(
3114 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3115 }
3116 }
3117
3118 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3119 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3120 DCHECK(!soa.Self()->IsExceptionPending());
3121 }
3122
3123 return result.release();
3124}
3125
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003126void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003127 va_list args;
3128 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003129 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003130 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003131}
3132
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003133void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003134 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003135 std::string msg;
3136 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003137 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003138}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003139
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003140void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003141 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003142 // Callers should either clear or call ThrowNewWrappedException.
3143 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003144 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003145}
3146
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003147static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003148 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003149 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003150 return method != nullptr
3151 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003152 : nullptr;
3153}
3154
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003155void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003156 const char* msg) {
3157 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003158 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003159 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003160 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003161 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003162 ClearException();
3163 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003164 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003165 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003166 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003167 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003168 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003169 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003170 return;
3171 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003172
Ian Rogers7b078e82014-09-10 14:44:24 -07003173 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3174 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003175 DCHECK(IsExceptionPending());
3176 return;
3177 }
3178 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003179 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003180 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003181
Mathieu Chartier590fee92013-09-13 13:46:47 -07003182 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003183 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003184 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3185 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003186 return;
3187 }
3188
Ian Rogers62d6c772013-02-27 08:32:07 -08003189 // Choose an appropriate constructor and set up the arguments.
3190 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003191 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003192 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003193 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003194 msg_string.reset(
3195 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003196 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003197 CHECK(IsExceptionPending()); // OOME.
3198 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003199 }
Dave Allison0aded082013-11-07 13:15:11 -08003200 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003201 signature = "(Ljava/lang/String;)V";
3202 } else {
3203 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3204 }
3205 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003206 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003207 signature = "()V";
3208 } else {
3209 signature = "(Ljava/lang/Throwable;)V";
3210 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003211 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003212 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003213 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003214
Dave Allison0aded082013-11-07 13:15:11 -08003215 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003216 << PrettyDescriptor(exception_class_descriptor);
3217
3218 if (UNLIKELY(!runtime->IsStarted())) {
3219 // Something is trying to throw an exception without a started runtime, which is the common
3220 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3221 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003222 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003223 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003224 }
Dave Allison0aded082013-11-07 13:15:11 -08003225 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003226 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003227 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003228 ScopedLocalRef<jobject> trace(GetJniEnv(),
3229 Runtime::Current()->IsActiveTransaction()
3230 ? CreateInternalStackTrace<true>(soa)
3231 : CreateInternalStackTrace<false>(soa));
3232 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003233 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003234 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003235 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003236 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003237 jvalue jv_args[2];
3238 size_t i = 0;
3239
Dave Allison0aded082013-11-07 13:15:11 -08003240 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003241 jv_args[i].l = msg_string.get();
3242 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003243 }
Dave Allison0aded082013-11-07 13:15:11 -08003244 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003245 jv_args[i].l = cause.get();
3246 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003247 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003248 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08003249 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003250 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003251 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003252 }
Elliott Hughes30646832011-10-13 16:59:46 -07003253 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003254}
3255
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003256void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003257 LOG(WARNING) << "Throwing OutOfMemoryError "
3258 << '"' << msg << '"'
3259 << " (VmSize " << GetProcessStatus("VmSize")
3260 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003261 if (!tls32_.throwing_OutOfMemoryError) {
3262 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003263 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003264 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003265 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003266 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003267 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003268 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003269}
3270
Elliott Hughes498508c2011-10-17 14:58:22 -07003271Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003272 return Thread::Current();
3273}
3274
3275void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003276 std::ostringstream ss;
3277 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003278 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003279 // log to stderr for debugging command line processes
3280 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003281#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003282 // log to logcat for debugging frameworks processes
3283 LOG(INFO) << str;
3284#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003285}
3286
Ian Rogersdd7624d2014-03-14 17:43:00 -07003287// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003288template
3289void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3290template
3291void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003292
Andreas Gampe542451c2016-07-26 09:02:02 -07003293template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003294void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3295#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003296 if (offset == (x).Uint32Value()) { \
3297 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003298 return; \
3299 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003300 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3301 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3302 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3303 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3304 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3305 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3306 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3307 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003308 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003309 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003310 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003311 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003312 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003313#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003314
Ian Rogersdd7624d2014-03-14 17:43:00 -07003315#define JNI_ENTRY_POINT_INFO(x) \
3316 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3317 os << #x; \
3318 return; \
3319 }
3320 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3321#undef JNI_ENTRY_POINT_INFO
3322
Ian Rogersdd7624d2014-03-14 17:43:00 -07003323#define QUICK_ENTRY_POINT_INFO(x) \
3324 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3325 os << #x; \
3326 return; \
3327 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003328 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003329 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3330 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3331 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3332 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003333 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3334 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003335 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003336 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003337 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3338 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3339 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003340 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003341 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003342 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003343 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3344 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003345 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003346 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3347 QUICK_ENTRY_POINT_INFO(pSet8Static)
3348 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3349 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003350 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3351 QUICK_ENTRY_POINT_INFO(pSet32Static)
3352 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3353 QUICK_ENTRY_POINT_INFO(pSet64Static)
3354 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3355 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003356 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3357 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3358 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3359 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3360 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3361 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3362 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3363 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003364 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3365 QUICK_ENTRY_POINT_INFO(pGet32Static)
3366 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3367 QUICK_ENTRY_POINT_INFO(pGet64Static)
3368 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3369 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003370 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003371 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3372 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3373 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3374 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3375 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3376 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3377 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3378 QUICK_ENTRY_POINT_INFO(pLockObject)
3379 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3380 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3381 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3382 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3383 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003384 QUICK_ENTRY_POINT_INFO(pCos)
3385 QUICK_ENTRY_POINT_INFO(pSin)
3386 QUICK_ENTRY_POINT_INFO(pAcos)
3387 QUICK_ENTRY_POINT_INFO(pAsin)
3388 QUICK_ENTRY_POINT_INFO(pAtan)
3389 QUICK_ENTRY_POINT_INFO(pAtan2)
3390 QUICK_ENTRY_POINT_INFO(pCbrt)
3391 QUICK_ENTRY_POINT_INFO(pCosh)
3392 QUICK_ENTRY_POINT_INFO(pExp)
3393 QUICK_ENTRY_POINT_INFO(pExpm1)
3394 QUICK_ENTRY_POINT_INFO(pHypot)
3395 QUICK_ENTRY_POINT_INFO(pLog)
3396 QUICK_ENTRY_POINT_INFO(pLog10)
3397 QUICK_ENTRY_POINT_INFO(pNextAfter)
3398 QUICK_ENTRY_POINT_INFO(pSinh)
3399 QUICK_ENTRY_POINT_INFO(pTan)
3400 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003401 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003402 QUICK_ENTRY_POINT_INFO(pL2d)
3403 QUICK_ENTRY_POINT_INFO(pFmodf)
3404 QUICK_ENTRY_POINT_INFO(pL2f)
3405 QUICK_ENTRY_POINT_INFO(pD2iz)
3406 QUICK_ENTRY_POINT_INFO(pF2iz)
3407 QUICK_ENTRY_POINT_INFO(pIdivmod)
3408 QUICK_ENTRY_POINT_INFO(pD2l)
3409 QUICK_ENTRY_POINT_INFO(pF2l)
3410 QUICK_ENTRY_POINT_INFO(pLdiv)
3411 QUICK_ENTRY_POINT_INFO(pLmod)
3412 QUICK_ENTRY_POINT_INFO(pLmul)
3413 QUICK_ENTRY_POINT_INFO(pShlLong)
3414 QUICK_ENTRY_POINT_INFO(pShrLong)
3415 QUICK_ENTRY_POINT_INFO(pUshrLong)
3416 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003417 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3418 QUICK_ENTRY_POINT_INFO(pMemcpy)
3419 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3420 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3421 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3422 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3423 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3424 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3425 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3426 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003427 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003428 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3429 QUICK_ENTRY_POINT_INFO(pDeliverException)
3430 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3431 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003432 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3433 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003434 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003435 QUICK_ENTRY_POINT_INFO(pA64Load)
3436 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003437 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3438 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3439 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3440 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3441 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3442 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3443 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3444 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3445 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3446 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3447 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3448 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3449 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3450 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3451 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3452 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003453 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003454 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3455 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3456 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3457 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3458 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3459 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3460 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3461 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3462 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3463 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3464 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3465 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3466 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3467 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3468 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3469 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3470 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3471 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3472 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3473 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3474 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3475 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3476 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3477 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3478 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3479 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3480 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3481 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3482 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3483 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003484 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003485 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003486
3487 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3488 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003489#undef QUICK_ENTRY_POINT_INFO
3490
Elliott Hughes98e20172012-04-24 15:38:13 -07003491 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003492}
3493
jeffhao94d6df42012-11-26 16:02:12 -08003494void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003495 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003496 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003497 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003498 if (exception == GetDeoptimizationException()) {
3499 artDeoptimize(this);
3500 UNREACHABLE();
3501 }
3502
Roland Levillaina78f5b62017-09-29 13:50:44 +01003503 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003504
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003505 // This is a real exception: let the instrumentation know about it.
3506 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003507 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003508 IsExceptionThrownByCurrentMethod(exception)) {
3509 // Instrumentation may cause GC so keep the exception object safe.
3510 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003511 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Alex Light6e1607e2017-08-23 10:06:18 -07003512 instrumentation->ExceptionThrownEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003513 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003514 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3515 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3516 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3517 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003518 //
3519 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3520 // expected to happen fairly regularly but the second can only happen if we are using
3521 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3522 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003523 ShadowFrame* cf;
Alex Lightbe1f8d02018-10-15 11:44:42 -07003524 bool force_deopt;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003525 {
3526 NthCallerVisitor visitor(this, 0, false);
3527 visitor.WalkStack();
3528 cf = visitor.GetCurrentShadowFrame();
3529 if (cf == nullptr) {
3530 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3531 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003532 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3533 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003534 if (kIsDebugBuild && force_frame_pop) {
3535 NthCallerVisitor penultimate_visitor(this, 1, false);
3536 penultimate_visitor.WalkStack();
3537 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3538 if (penultimate_frame == nullptr) {
3539 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3540 }
3541 DCHECK(penultimate_frame != nullptr &&
3542 penultimate_frame->GetForceRetryInstruction())
3543 << "Force pop frame without retry instruction found. penultimate frame is null: "
3544 << (penultimate_frame == nullptr ? "true" : "false");
3545 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003546 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003547 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003548 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003549 NthCallerVisitor visitor(this, 0, false);
3550 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003551 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003552 // method_type shouldn't matter due to exception handling.
3553 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003554 // Save the exception into the deoptimization context so it can be restored
3555 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003556 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003557 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3558 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3559 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003560 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3561 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003562 ClearException();
3563 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003564 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003565 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003566 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003567 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003568 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003569 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003570 artDeoptimize(this);
3571 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003572 } else {
3573 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3574 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003575 }
3576 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003577
Ian Rogers28ad40d2011-10-27 15:19:26 -07003578 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003579 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003580 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003581 QuickExceptionHandler exception_handler(this, false);
3582 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003583 if (exception_handler.GetClearException()) {
3584 // Exception was cleared as part of delivery.
3585 DCHECK(!IsExceptionPending());
3586 } else {
3587 // Exception was put back with a throw location.
3588 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003589 // Check the to-space invariant on the re-installed exception (if applicable).
3590 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003591 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003592 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003593}
3594
Ian Rogersbdb03912011-09-14 00:55:44 -07003595Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003596 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003597 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003598 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003599 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003600 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003601 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003602 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003603 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003604}
3605
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003606ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc,
3607 bool check_suspended,
3608 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003609 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3610 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3611 // stack.
3612 struct CurrentMethodVisitor final : public StackVisitor {
3613 CurrentMethodVisitor(Thread* thread, bool check_suspended, bool abort_on_error)
3614 REQUIRES_SHARED(Locks::mutator_lock_)
3615 : StackVisitor(thread,
3616 /* context= */nullptr,
3617 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3618 check_suspended),
3619 method_(nullptr),
3620 dex_pc_(0),
3621 abort_on_error_(abort_on_error) {}
3622 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
3623 ArtMethod* m = GetMethod();
3624 if (m->IsRuntimeMethod()) {
3625 // Continue if this is a runtime method.
3626 return true;
3627 }
3628 method_ = m;
3629 dex_pc_ = GetDexPc(abort_on_error_);
3630 return false;
3631 }
3632 ArtMethod* method_;
3633 uint32_t dex_pc_;
3634 const bool abort_on_error_;
3635 };
3636 CurrentMethodVisitor visitor(const_cast<Thread*>(this), check_suspended, abort_on_error);
Ian Rogers0399dde2012-06-06 17:09:28 -07003637 visitor.WalkStack(false);
Dave Allison0aded082013-11-07 13:15:11 -08003638 if (dex_pc != nullptr) {
Ian Rogers0399dde2012-06-06 17:09:28 -07003639 *dex_pc = visitor.dex_pc_;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003640 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003641 return visitor.method_;
jeffhao33dc7712011-11-09 17:54:24 -08003642}
3643
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003644bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3645 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003646}
3647
Roland Levillainad0777d2018-02-12 20:00:18 +00003648extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003649 REQUIRES_SHARED(Locks::mutator_lock_);
3650
Ian Rogers40e3bac2012-11-20 00:09:14 -08003651// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003652template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003653class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003654 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003655 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003656 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003657 // We are visiting the references in compiled frames, so we do not need
3658 // to know the inlined frames.
3659 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3660 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003661
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003662 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003663 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003664 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003665 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003666 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003667 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003668 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003669 VisitShadowFrame(shadow_frame);
3670 } else {
3671 VisitQuickFrame();
3672 }
3673 return true;
3674 }
3675
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003676 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003677 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003678 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003679 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003680 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003681 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
3682 // handle scope for JNI or References for interpreter.
3683 for (size_t reg = 0; reg < num_regs; ++reg) {
3684 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3685 if (ref != nullptr) {
3686 mirror::Object* new_ref = ref;
3687 visitor_(&new_ref, reg, this);
3688 if (new_ref != ref) {
3689 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003690 }
3691 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003692 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003693 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003694 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003695 }
3696
3697 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003698 // Visiting the declaring class is necessary so that we don't unload the class of a method that
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003699 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3700 // the threads do not all hold the heap bitmap lock for parallel GC.
3701 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003702 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003703 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003704 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003705 // klass can be null for runtime methods.
3706 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003707 if (kVerifyImageObjectsMarked) {
3708 gc::Heap* const heap = Runtime::Current()->GetHeap();
3709 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003710 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003711 if (space != nullptr && space->IsImageSpace()) {
3712 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003713 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003714 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003715 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003716 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003717 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003718 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003719 }
3720 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003721 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3722 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3723 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003724 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003725 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003726 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3727 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003728 }
3729 }
3730 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003731 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003732 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003733 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003734 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003735 }
3736 }
3737 }
3738
Andreas Gampe585da952016-12-02 14:52:29 -08003739 template <typename T>
3740 ALWAYS_INLINE
3741 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003742 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003743 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003744 ArtMethod* m = *cur_quick_frame;
3745 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003746
Sebastien Hertz714f1752014-04-28 15:03:08 +02003747 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003748 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003749 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003750 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003751 StackReference<mirror::Object>* vreg_base =
3752 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003753 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbeckya2d29a32018-08-03 11:06:38 +01003754 CodeInfo code_info(method_header, kPrecise
David Srbecky42deda82018-08-10 11:23:27 +01003755 ? CodeInfo::DecodeFlags::AllTables // We will need dex register maps.
David Srbeckya2d29a32018-08-03 11:06:38 +01003756 : CodeInfo::DecodeFlags::GcMasksOnly);
David Srbecky052f8ca2018-04-26 15:42:54 +01003757 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003758 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003759
David Srbecky052f8ca2018-04-26 15:42:54 +01003760 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003761
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003762 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003763 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003764 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003765 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003766 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003767 mirror::Object* ref = ref_addr->AsMirrorPtr();
3768 if (ref != nullptr) {
3769 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003770 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003771 if (ref != new_ref) {
3772 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003773 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003774 }
3775 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003776 }
3777 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003778 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003779 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3780 if (register_mask & (1 << i)) {
3781 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003782 if (kIsDebugBuild && ref_addr == nullptr) {
3783 std::string thread_name;
3784 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003785 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003786 DescribeStack(GetThread());
3787 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3788 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3789 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003790 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003791 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003792 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003793 }
3794 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003795 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3796 // If this is a proxy method, visit its reference arguments.
3797 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003798 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003799 std::vector<StackReference<mirror::Object>*> ref_addrs =
3800 GetProxyReferenceArguments(cur_quick_frame);
3801 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3802 mirror::Object* ref = ref_addr->AsMirrorPtr();
3803 if (ref != nullptr) {
3804 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003805 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003806 if (ref != new_ref) {
3807 ref_addr->Assign(new_ref);
3808 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003809 }
3810 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003811 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003812 }
3813
Andreas Gampe585da952016-12-02 14:52:29 -08003814 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3815 if (kPrecise) {
3816 VisitQuickFramePrecise();
3817 } else {
3818 VisitQuickFrameNonPrecise();
3819 }
3820 }
3821
3822 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3823 struct UndefinedVRegInfo {
3824 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3825 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003826 const StackMap& map ATTRIBUTE_UNUSED,
3827 RootVisitor& _visitor)
3828 : visitor(_visitor) {
3829 }
3830
3831 ALWAYS_INLINE
3832 void VisitStack(mirror::Object** ref,
3833 size_t stack_index ATTRIBUTE_UNUSED,
3834 const StackVisitor* stack_visitor)
3835 REQUIRES_SHARED(Locks::mutator_lock_) {
3836 visitor(ref, -1, stack_visitor);
3837 }
3838
3839 ALWAYS_INLINE
3840 void VisitRegister(mirror::Object** ref,
3841 size_t register_index ATTRIBUTE_UNUSED,
3842 const StackVisitor* stack_visitor)
3843 REQUIRES_SHARED(Locks::mutator_lock_) {
3844 visitor(ref, -1, stack_visitor);
3845 }
3846
3847 RootVisitor& visitor;
3848 };
3849 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3850 }
3851
3852 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3853 struct StackMapVRegInfo {
3854 StackMapVRegInfo(ArtMethod* method,
3855 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003856 const StackMap& map,
3857 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003858 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003859 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003860 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003861 visitor(_visitor) {
3862 }
3863
3864 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3865 // lookups for each location.
3866 void FindWithType(const size_t index,
3867 const DexRegisterLocation::Kind kind,
3868 mirror::Object** ref,
3869 const StackVisitor* stack_visitor)
3870 REQUIRES_SHARED(Locks::mutator_lock_) {
3871 bool found = false;
3872 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003873 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003874 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3875 visitor(ref, dex_reg, stack_visitor);
3876 found = true;
3877 }
3878 }
3879
3880 if (!found) {
3881 // If nothing found, report with -1.
3882 visitor(ref, -1, stack_visitor);
3883 }
3884 }
3885
3886 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3887 REQUIRES_SHARED(Locks::mutator_lock_) {
3888 const size_t stack_offset = stack_index * kFrameSlotSize;
3889 FindWithType(stack_offset,
3890 DexRegisterLocation::Kind::kInStack,
3891 ref,
3892 stack_visitor);
3893 }
3894
3895 void VisitRegister(mirror::Object** ref,
3896 size_t register_index,
3897 const StackVisitor* stack_visitor)
3898 REQUIRES_SHARED(Locks::mutator_lock_) {
3899 FindWithType(register_index,
3900 DexRegisterLocation::Kind::kInRegister,
3901 ref,
3902 stack_visitor);
3903 }
3904
3905 size_t number_of_dex_registers;
3906 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003907 DexRegisterMap dex_register_map;
3908 RootVisitor& visitor;
3909 };
3910 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3911 }
3912
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003913 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003914 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003915};
3916
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003917class RootCallbackVisitor {
3918 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003919 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003920
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003921 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003922 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003923 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003924 }
3925
3926 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003927 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003928 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003929};
3930
Andreas Gampe585da952016-12-02 14:52:29 -08003931template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003932void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003933 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003934 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003935 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003936 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003937 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003938 }
Alex Light848574c2017-09-25 16:59:39 -07003939 if (tlsPtr_.async_exception != nullptr) {
3940 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3941 RootInfo(kRootNativeStack, thread_id));
3942 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003943 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003944 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3945 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003946 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003947 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003948 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003949 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003950 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003951 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003952 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003953 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003954 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3955 record != nullptr;
3956 record = record->GetLink()) {
3957 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3958 shadow_frame != nullptr;
3959 shadow_frame = shadow_frame->GetLink()) {
3960 mapper.VisitShadowFrame(shadow_frame);
3961 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003962 }
3963 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003964 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3965 record != nullptr;
3966 record = record->GetLink()) {
3967 if (record->IsReference()) {
3968 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003969 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003970 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003971 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3972 RootInfo(kRootThreadObject, thread_id));
3973 }
3974 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3975 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003976 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003977 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3978 record != nullptr;
3979 record = record->GetNext()) {
3980 mapper.VisitShadowFrame(record->GetShadowFrame());
3981 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003982 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003983 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3984 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003985 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003986 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003987 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003988 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003989 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08003990 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07003991 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003992 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08003993 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07003994}
3995
Andreas Gampe585da952016-12-02 14:52:29 -08003996void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
3997 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003998 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003999 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004000 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004001 }
4002}
4003
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004004class VerifyRootVisitor : public SingleRootVisitor {
4005 public:
4006 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004007 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004008 VerifyObject(root);
4009 }
4010};
jeffhao25045522012-03-13 19:34:37 -07004011
Ian Rogers04d7aa92013-03-16 14:29:17 -07004012void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004013 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4014 VerifyRootVisitor visitor;
4015 std::unique_ptr<Context> context(Context::Create());
4016 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4017 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4018 mapper.WalkStack();
4019 }
jeffhao25045522012-03-13 19:34:37 -07004020}
jeffhao25045522012-03-13 19:34:37 -07004021
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004022// Set the stack end to that to be used during a stack overflow
4023void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004024 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004025 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004026 // However, we seem to have already extended to use the full stack.
4027 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004028 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004029 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004030 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004031 }
4032
Ian Rogersdd7624d2014-03-14 17:43:00 -07004033 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004034
4035 // Remove the stack overflow protection if is it set up.
4036 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4037 if (implicit_stack_check) {
4038 if (!UnprotectStack()) {
4039 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4040 }
4041 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004042}
4043
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004044void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004045 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004046 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004047 tlsPtr_.thread_local_start = start;
4048 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4049 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004050 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004051 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004052}
4053
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004054bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004055 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004056 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004057 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004058 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004059 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004060 }
4061 return has_tlab;
4062}
4063
Elliott Hughes330304d2011-08-12 14:28:05 -07004064std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004065 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004066 return os;
4067}
4068
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004069bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004070 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4071 VLOG(threads) << "Protecting stack at " << pregion;
4072 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004073 if (fatal_on_error) {
4074 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4075 "Reason: "
4076 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4077 }
4078 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004079 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004080 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004081}
4082
4083bool Thread::UnprotectStack() {
4084 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4085 VLOG(threads) << "Unprotecting stack at " << pregion;
4086 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4087}
4088
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004089void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4090 CHECK(Dbg::IsDebuggerActive());
4091 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4092 CHECK(ssc != nullptr);
4093 tlsPtr_.single_step_control = ssc;
4094}
4095
4096void Thread::DeactivateSingleStepControl() {
4097 CHECK(Dbg::IsDebuggerActive());
4098 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4099 SingleStepControl* ssc = GetSingleStepControl();
4100 tlsPtr_.single_step_control = nullptr;
4101 delete ssc;
4102}
Dave Allison648d7112014-07-25 16:15:27 -07004103
Sebastien Hertz1558b572015-02-25 15:05:59 +01004104void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4105 CHECK(Dbg::IsDebuggerActive());
4106 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4107 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4108 CHECK(req != nullptr);
4109 tlsPtr_.debug_invoke_req = req;
4110}
4111
4112void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004113 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4114 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004115 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004116 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004117 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004118}
4119
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004120void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4121 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004122 tlsPtr_.method_verifier = verifier;
4123}
4124
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004125void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004126 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004127 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004128}
4129
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004130size_t Thread::NumberOfHeldMutexes() const {
4131 size_t count = 0;
4132 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004133 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004134 }
4135 return count;
4136}
4137
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004138void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4139 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4140 ClearException();
4141 ShadowFrame* shadow_frame =
4142 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004143 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004144 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004145 DeoptimizationMethodType method_type;
4146 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004147 SetTopOfStack(nullptr);
4148 SetTopOfShadowStack(shadow_frame);
4149
4150 // Restore the exception that was pending before deoptimization then interpret the
4151 // deoptimized frames.
4152 if (pending_exception != nullptr) {
4153 SetException(pending_exception);
4154 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004155 interpreter::EnterInterpreterFromDeoptimize(this,
4156 shadow_frame,
4157 result,
4158 from_code,
4159 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004160}
4161
Alex Light848574c2017-09-25 16:59:39 -07004162void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4163 CHECK(new_exception != nullptr);
Alex Light7919db92017-11-29 09:00:55 -08004164 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004165 if (kIsDebugBuild) {
4166 // Make sure we are in a checkpoint.
4167 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4168 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4169 << "It doesn't look like this was called in a checkpoint! this: "
4170 << this << " count: " << GetSuspendCount();
4171 }
4172 tlsPtr_.async_exception = new_exception.Ptr();
4173}
4174
4175bool Thread::ObserveAsyncException() {
4176 DCHECK(this == Thread::Current());
4177 if (tlsPtr_.async_exception != nullptr) {
4178 if (tlsPtr_.exception != nullptr) {
4179 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4180 << tlsPtr_.exception->Dump();
4181 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4182 }
4183 tlsPtr_.exception = tlsPtr_.async_exception;
4184 tlsPtr_.async_exception = nullptr;
4185 return true;
4186 } else {
4187 return IsExceptionPending();
4188 }
4189}
4190
Mathieu Chartier0795f232016-09-27 18:43:30 -07004191void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004192 CHECK(new_exception != nullptr);
4193 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004194 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004195}
4196
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004197bool Thread::IsAotCompiler() {
4198 return Runtime::Current()->IsAotCompiler();
4199}
4200
Andreas Gampe202f85a2017-02-06 10:23:26 -08004201mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004202 DCHECK(tlsPtr_.jpeer == nullptr);
4203 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004204 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4205 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4206 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4207 // mark/forward it here.
4208 peer = art::ReadBarrier::Mark(peer);
4209 }
4210 return peer;
4211}
4212
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004213void Thread::SetReadBarrierEntrypoints() {
4214 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004215 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004216}
4217
David Srbecky912f36c2018-09-08 12:22:58 +01004218void Thread::ClearAllInterpreterCaches() {
4219 static struct ClearInterpreterCacheClosure : Closure {
4220 virtual void Run(Thread* thread) {
4221 thread->GetInterpreterCache()->Clear(thread);
4222 }
4223 } closure;
4224 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4225}
4226
Elliott Hughes8daa0922011-09-11 13:46:25 -07004227} // namespace art