blob: 7c050a4e4d81c128b8be46d7893bafbd4dda8805 [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"
Evan Chengd57c51e2018-01-26 15:43:08 +080042#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080043
Mathieu Chartiera62b4532017-04-26 13:16:25 -070044#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070045#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070046#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070047#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000048#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010049#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010050#include "base/casts.h"
David Sehr891a50e2017-10-27 17:01:07 -070051#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070052#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080053#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070054#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070055#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080056#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070057#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080058#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080059#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010060#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070061#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080062#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080063#include "dex/dex_file-inl.h"
64#include "dex/dex_file_annotations.h"
65#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070066#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080067#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070068#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000069#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070070#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070071#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070072#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070073#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070074#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070075#include "indirect_reference_table-inl.h"
Andreas Gamped77abd92019-01-02 16:10:20 -080076#include "instrumentation.h"
Steven Morelande431e272017-07-18 16:53:49 -070077#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010078#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010079#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070080#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010081#include "jni/java_vm_ext.h"
82#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070083#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070084#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070085#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080086#include "mirror/object_array-inl.h"
87#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070088#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080089#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070090#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070091#include "nativehelper/scoped_local_ref.h"
92#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070093#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010094#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070095#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070096#include "object_lock.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010097#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070098#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080099#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -0500100#include "reflection.h"
David Srbecky28f6cff2018-10-16 15:07:28 +0100101#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700102#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800103#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700104#include "scoped_thread_state_change-inl.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700105#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100106#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700107#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700108#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700109#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800110#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700111#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700112
Yu Lieac44242015-06-29 10:50:03 +0800113#if ART_USE_FUTEXES
114#include "linux/futex.h"
115#include "sys/syscall.h"
116#ifndef SYS_futex
117#define SYS_futex __NR_futex
118#endif
119#endif // ART_USE_FUTEXES
120
Carl Shapirob5573532011-07-12 18:22:59 -0700121namespace art {
122
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800123using android::base::StringAppendV;
124using android::base::StringPrintf;
125
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700126extern "C" NO_RETURN void artDeoptimize(Thread* self);
127
Ian Rogers0878d652013-04-18 17:38:35 -0700128bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700129pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800130ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700131const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100132bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100133Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100134
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700135static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700136
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700137// For implicit overflow checks we reserve an extra piece of memory at the bottom
138// of the stack (lowest memory). The higher portion of the memory
139// is protected against reads and the lower is available for use while
140// throwing the StackOverflow exception.
141constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
142
Elliott Hughes7dc51662012-05-16 14:48:43 -0700143static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
144
Ian Rogers5d76c432011-10-31 21:42:49 -0700145void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700146 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700147}
148
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700149static void UnimplementedEntryPoint() {
150 UNIMPLEMENTED(FATAL);
151}
152
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700153void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700154void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800155
156void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
157 CHECK(kUseReadBarrier);
158 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700159 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800160 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800161}
Ian Rogers7655f292013-07-29 11:07:13 -0700162
Ian Rogers848871b2013-08-05 10:56:33 -0700163void Thread::InitTlsEntryPoints() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800164 ScopedTrace trace("InitTlsEntryPoints");
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700165 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700166 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800167 uintptr_t* end = reinterpret_cast<uintptr_t*>(
168 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700169 for (uintptr_t* it = begin; it != end; ++it) {
170 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
171 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700172 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700173}
174
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800175void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000176 if (kUseReadBarrier && kRuntimeISA != InstructionSet::kX86_64) {
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800177 // Allocation entrypoint switching is currently only implemented for X86_64.
178 is_marking = true;
179 }
180 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700181}
182
Sebastien Hertz07474662015-08-25 15:12:33 +0000183class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200184 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100185 DeoptimizationContextRecord(const JValue& ret_val,
186 bool is_reference,
187 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800188 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700189 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000190 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100191 : ret_val_(ret_val),
192 is_reference_(is_reference),
193 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800194 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700195 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000196 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200197
198 JValue GetReturnValue() const { return ret_val_; }
199 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100200 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800201 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000202 DeoptimizationContextRecord* GetLink() const { return link_; }
203 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200204 DCHECK(is_reference_);
205 return ret_val_.GetGCRoot();
206 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000207 mirror::Object** GetPendingExceptionAsGCRoot() {
208 return reinterpret_cast<mirror::Object**>(&pending_exception_);
209 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700210 DeoptimizationMethodType GetDeoptimizationMethodType() const {
211 return deopt_method_type_;
212 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200213
214 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000215 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200216 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200217
Sebastien Hertz07474662015-08-25 15:12:33 +0000218 // Indicates whether the returned value is a reference. If so, the GC will visit it.
219 const bool is_reference_;
220
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100221 // Whether the context was created from an explicit deoptimization in the code.
222 const bool from_code_;
223
Sebastien Hertz07474662015-08-25 15:12:33 +0000224 // The exception that was pending before deoptimization (or null if there was no pending
225 // exception).
226 mirror::Throwable* pending_exception_;
227
Mingyao Yang2ee17902017-08-30 11:37:08 -0700228 // Whether the context was created for an (idempotent) runtime method.
229 const DeoptimizationMethodType deopt_method_type_;
230
Sebastien Hertz07474662015-08-25 15:12:33 +0000231 // A link to the previous DeoptimizationContextRecord.
232 DeoptimizationContextRecord* const link_;
233
234 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200235};
236
237class StackedShadowFrameRecord {
238 public:
239 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
240 StackedShadowFrameType type,
241 StackedShadowFrameRecord* link)
242 : shadow_frame_(shadow_frame),
243 type_(type),
244 link_(link) {}
245
246 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
247 StackedShadowFrameType GetType() const { return type_; }
248 StackedShadowFrameRecord* GetLink() const { return link_; }
249
250 private:
251 ShadowFrame* const shadow_frame_;
252 const StackedShadowFrameType type_;
253 StackedShadowFrameRecord* const link_;
254
255 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
256};
257
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100258void Thread::PushDeoptimizationContext(const JValue& return_value,
259 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700260 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100261 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700262 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000263 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
264 return_value,
265 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100266 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000267 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700268 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000269 tlsPtr_.deoptimization_context_stack);
270 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700271}
272
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100273void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800274 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700275 bool* from_code,
276 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000277 AssertHasDeoptimizationContext();
278 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
279 tlsPtr_.deoptimization_context_stack = record->GetLink();
280 result->SetJ(record->GetReturnValue().GetJ());
281 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100282 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700283 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700284 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000285}
286
287void Thread::AssertHasDeoptimizationContext() {
288 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
289 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800290}
291
Charles Mungeraa31f492018-11-01 18:57:38 +0000292enum {
293 kPermitAvailable = 0, // Incrementing consumes the permit
294 kNoPermit = 1, // Incrementing marks as waiter waiting
295 kNoPermitWaiterWaiting = 2
296};
297
298void Thread::Park(bool is_absolute, int64_t time) {
299 DCHECK(this == Thread::Current());
300#if ART_USE_FUTEXES
301 // Consume the permit, or mark as waiting. This cannot cause park_state to go
302 // outside of its valid range (0, 1, 2), because in all cases where 2 is
303 // assigned it is set back to 1 before returning, and this method cannot run
304 // concurrently with itself since it operates on the current thread.
305 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
306 if (old_state == kNoPermit) {
307 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800308 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Mungeraa31f492018-11-01 18:57:38 +0000309 int result = 0;
Charles Munger5cc0e752018-11-09 12:30:46 -0800310 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000311 if (!is_absolute && time == 0) {
312 // Thread.getState() is documented to return waiting for untimed parks.
313 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
314 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
315 result = futex(tls32_.park_state_.Address(),
316 FUTEX_WAIT_PRIVATE,
317 /* sleep if val = */ kNoPermitWaiterWaiting,
318 /* timeout */ nullptr,
319 nullptr,
320 0);
321 } else if (time > 0) {
322 // Only actually suspend and futex_wait if we're going to wait for some
323 // positive amount of time - the kernel will reject negative times with
324 // EINVAL, and a zero time will just noop.
325
326 // Thread.getState() is documented to return timed wait for timed parks.
327 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
328 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
329 timespec timespec;
330 if (is_absolute) {
331 // Time is millis when scheduled for an absolute time
332 timespec.tv_nsec = (time % 1000) * 1000000;
333 timespec.tv_sec = time / 1000;
334 // This odd looking pattern is recommended by futex documentation to
335 // wait until an absolute deadline, with otherwise identical behavior to
336 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
337 // correct time when the system clock changes.
338 result = futex(tls32_.park_state_.Address(),
339 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
340 /* sleep if val = */ kNoPermitWaiterWaiting,
341 &timespec,
342 nullptr,
343 FUTEX_BITSET_MATCH_ANY);
344 } else {
345 // Time is nanos when scheduled for a relative time
346 timespec.tv_sec = time / 1000000000;
347 timespec.tv_nsec = time % 1000000000;
348 result = futex(tls32_.park_state_.Address(),
349 FUTEX_WAIT_PRIVATE,
350 /* sleep if val = */ kNoPermitWaiterWaiting,
351 &timespec,
352 nullptr,
353 0);
354 }
355 }
356 if (result == -1) {
357 switch (errno) {
Charles Mungeraa31f492018-11-01 18:57:38 +0000358 case ETIMEDOUT:
Charles Munger5cc0e752018-11-09 12:30:46 -0800359 timed_out = true;
360 FALLTHROUGH_INTENDED;
361 case EAGAIN:
Charles Mungeraa31f492018-11-01 18:57:38 +0000362 case EINTR: break; // park() is allowed to spuriously return
363 default: PLOG(FATAL) << "Failed to park";
364 }
365 }
366 // Mark as no longer waiting, and consume permit if there is one.
367 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
368 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800369 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000370 } else {
371 // the fetch_add has consumed the permit. immediately return.
372 DCHECK_EQ(old_state, kPermitAvailable);
373 }
374#else
375 #pragma clang diagnostic push
376 #pragma clang diagnostic warning "-W#warnings"
377 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
378 #pragma clang diagnostic pop
379 UNUSED(is_absolute, time);
380 UNIMPLEMENTED(WARNING);
381 sched_yield();
382#endif
383}
384
385void Thread::Unpark() {
386#if ART_USE_FUTEXES
387 // Set permit available; will be consumed either by fetch_add (when the thread
388 // tries to park) or store (when the parked thread is woken up)
389 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
390 == kNoPermitWaiterWaiting) {
391 int result = futex(tls32_.park_state_.Address(),
392 FUTEX_WAKE_PRIVATE,
393 /* number of waiters = */ 1,
394 nullptr,
395 nullptr,
396 0);
397 if (result == -1) {
398 PLOG(FATAL) << "Failed to unpark";
399 }
400 }
401#else
402 UNIMPLEMENTED(WARNING);
403#endif
404}
405
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700406void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
407 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
408 sf, type, tlsPtr_.stacked_shadow_frame_record);
409 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800410}
411
Andreas Gampe639bdd12015-06-03 11:22:45 -0700412ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700413 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700414 if (must_be_present) {
415 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700416 } else {
417 if (record == nullptr || record->GetType() != type) {
418 return nullptr;
419 }
420 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700421 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
422 ShadowFrame* shadow_frame = record->GetShadowFrame();
423 delete record;
424 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700425}
426
Mingyao Yang99170c62015-07-06 11:10:37 -0700427class FrameIdToShadowFrame {
428 public:
429 static FrameIdToShadowFrame* Create(size_t frame_id,
430 ShadowFrame* shadow_frame,
431 FrameIdToShadowFrame* next,
432 size_t num_vregs) {
433 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
434 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
435 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
436 }
437
438 static void Delete(FrameIdToShadowFrame* f) {
439 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
440 delete[] memory;
441 }
442
443 size_t GetFrameId() const { return frame_id_; }
444 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
445 FrameIdToShadowFrame* GetNext() const { return next_; }
446 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
447 bool* GetUpdatedVRegFlags() {
448 return updated_vreg_flags_;
449 }
450
451 private:
452 FrameIdToShadowFrame(size_t frame_id,
453 ShadowFrame* shadow_frame,
454 FrameIdToShadowFrame* next)
455 : frame_id_(frame_id),
456 shadow_frame_(shadow_frame),
457 next_(next) {}
458
459 const size_t frame_id_;
460 ShadowFrame* const shadow_frame_;
461 FrameIdToShadowFrame* next_;
462 bool updated_vreg_flags_[0];
463
464 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
465};
466
467static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
468 size_t frame_id) {
469 FrameIdToShadowFrame* found = nullptr;
470 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
471 if (record->GetFrameId() == frame_id) {
472 if (kIsDebugBuild) {
473 // Sanity check we have at most one record for this frame.
474 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
475 found = record;
476 } else {
477 return record;
478 }
479 }
480 }
481 return found;
482}
483
484ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
485 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
486 tlsPtr_.frame_id_to_shadow_frame, frame_id);
487 if (record != nullptr) {
488 return record->GetShadowFrame();
489 }
490 return nullptr;
491}
492
493// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
494bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
495 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
496 tlsPtr_.frame_id_to_shadow_frame, frame_id);
497 CHECK(record != nullptr);
498 return record->GetUpdatedVRegFlags();
499}
500
501ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
502 uint32_t num_vregs,
503 ArtMethod* method,
504 uint32_t dex_pc) {
505 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
506 if (shadow_frame != nullptr) {
507 return shadow_frame;
508 }
David Sehr709b0702016-10-13 09:12:37 -0700509 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700510 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
511 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
512 shadow_frame,
513 tlsPtr_.frame_id_to_shadow_frame,
514 num_vregs);
515 for (uint32_t i = 0; i < num_vregs; i++) {
516 // Do this to clear all references for root visitors.
517 shadow_frame->SetVRegReference(i, nullptr);
518 // This flag will be changed to true if the debugger modifies the value.
519 record->GetUpdatedVRegFlags()[i] = false;
520 }
521 tlsPtr_.frame_id_to_shadow_frame = record;
522 return shadow_frame;
523}
524
Alex Light184f0752018-07-13 11:18:22 -0700525TLSData* Thread::GetCustomTLS(const char* key) {
526 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
527 auto it = custom_tls_.find(key);
528 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
529}
530
531void Thread::SetCustomTLS(const char* key, TLSData* data) {
532 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
533 // custom_tls_lock_.
534 std::unique_ptr<TLSData> old_data(data);
535 {
536 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
537 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
538 }
539}
540
Mingyao Yang99170c62015-07-06 11:10:37 -0700541void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
542 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
543 if (head->GetFrameId() == frame_id) {
544 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
545 FrameIdToShadowFrame::Delete(head);
546 return;
547 }
548 FrameIdToShadowFrame* prev = head;
549 for (FrameIdToShadowFrame* record = head->GetNext();
550 record != nullptr;
551 prev = record, record = record->GetNext()) {
552 if (record->GetFrameId() == frame_id) {
553 prev->SetNext(record->GetNext());
554 FrameIdToShadowFrame::Delete(record);
555 return;
556 }
557 }
558 LOG(FATAL) << "No shadow frame for frame " << frame_id;
559 UNREACHABLE();
560}
561
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700562void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700563 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700564}
565
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700566void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700567 // One thread (us) survived the fork, but we have a new tid so we need to
568 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700569 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700570}
571
Brian Carlstrom78128a62011-09-15 17:21:19 -0700572void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700573 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700574 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800575 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700576 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800577 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700578 }
579 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700580 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
581 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800582 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700583 // Check that if we got here we cannot be shutting down (as shutdown should never have started
584 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700585 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700586 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
587 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
588 // the runtime in such a case. In case this ever changes, we need to make sure here to
589 // delete the tmp_jni_env, as we own it at this point.
590 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
591 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700592 Runtime::Current()->EndThreadBirth();
593 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700594 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700595 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800596 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800597
598 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700599 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700600 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700601 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
602 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800603 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100604
Andreas Gampe08883de2016-11-08 13:20:52 -0800605 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100606 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000607
Andreas Gampeac30fa22017-01-18 21:02:36 -0800608 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700609
Charles Mungeraa31f492018-11-01 18:57:38 +0000610 // Unpark ourselves if the java peer was unparked before it started (see
611 // b/28845097#comment49 for more information)
612
613 ArtField* unparkedField = jni::DecodeArtField(
614 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
615 bool should_unpark = false;
616 {
617 // Hold the lock here, so that if another thread calls unpark before the thread starts
618 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
619 // which could cause a lost unpark.
620 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
621 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
622 }
623 if (should_unpark) {
624 self->Unpark();
625 }
Ian Rogers365c1022012-06-22 15:05:28 -0700626 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800627 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700628 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700629 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
630 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700631 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700632 // Detach and delete self.
633 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700634
Dave Allison0aded082013-11-07 13:15:11 -0800635 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700636}
637
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700638Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800639 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800640 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100641 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700642 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
643 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700644 if (kIsDebugBuild) {
645 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800646 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700647 Locks::thread_list_lock_->AssertHeld(soa.Self());
648 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700649 }
650 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800651}
652
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700653Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
654 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100655 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700656}
657
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700658static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700659 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700660 if (stack_size == 0) {
661 stack_size = Runtime::Current()->GetDefaultStackSize();
662 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700663
Brian Carlstrom6414a972012-04-14 14:20:04 -0700664 // Dalvik used the bionic pthread default stack size for native threads,
665 // so include that here to support apps that expect large native stacks.
666 stack_size += 1 * MB;
667
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700668 // Under sanitization, frames of the interpreter may become bigger, both for C code as
669 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
670 // of all core classes cannot be done in all test circumstances.
671 if (kMemoryToolIsAvailable) {
672 stack_size = std::max(2 * MB, stack_size);
673 }
674
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700675 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
676 if (stack_size < PTHREAD_STACK_MIN) {
677 stack_size = PTHREAD_STACK_MIN;
678 }
679
Dave Allisonf9439142014-03-27 15:10:22 -0700680 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
681 // It's likely that callers are trying to ensure they have at least a certain amount of
682 // stack space, so we should add our reserved space on top of what they requested, rather
683 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700684 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700685 } else {
686 // If we are going to use implicit stack checks, allocate space for the protected
687 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000688 stack_size += Thread::kStackOverflowImplicitCheckSize +
689 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700690 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700691
692 // Some systems require the stack size to be a multiple of the system page size, so round up.
693 stack_size = RoundUp(stack_size, kPageSize);
694
695 return stack_size;
696}
697
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700698// Return the nearest page-aligned address below the current stack top.
699NO_INLINE
700static uint8_t* FindStackTop() {
701 return reinterpret_cast<uint8_t*>(
702 AlignDown(__builtin_frame_address(0), kPageSize));
703}
704
Dave Allisonf9439142014-03-27 15:10:22 -0700705// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700706// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700707ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700708void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700709 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700710 // Page containing current top of stack.
711 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700712
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700713 // Try to directly protect the stack.
714 VLOG(threads) << "installing stack protected region at " << std::hex <<
715 static_cast<void*>(pregion) << " to " <<
716 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700717 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700718 // Tell the kernel that we won't be needing these pages any more.
719 // NB. madvise will probably write zeroes into the memory (on linux it does).
720 uint32_t unwanted_size = stack_top - pregion - kPageSize;
721 madvise(pregion, unwanted_size, MADV_DONTNEED);
722 return;
723 }
724
725 // There is a little complexity here that deserves a special mention. On some
726 // architectures, the stack is created using a VM_GROWSDOWN flag
727 // to prevent memory being allocated when it's not needed. This flag makes the
728 // kernel only allocate memory for the stack by growing down in memory. Because we
729 // want to put an mprotected region far away from that at the stack top, we need
730 // to make sure the pages for the stack are mapped in before we call mprotect.
731 //
732 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
733 // with a non-mapped stack (usually only the main thread).
734 //
735 // We map in the stack by reading every page from the stack bottom (highest address)
736 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700737 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700738 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700739 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
740 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
741 // thus have to move the stack pointer. We do this portably by using a recursive function with a
742 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700743
Andreas Gampe6c63f862017-06-28 17:20:15 -0700744 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700745 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700746 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000747
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700748 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
749 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000750
Andreas Gampe6c63f862017-06-28 17:20:15 -0700751 struct RecurseDownStack {
752 // This function has an intentionally large stack size.
753#pragma GCC diagnostic push
754#pragma GCC diagnostic ignored "-Wframe-larger-than="
755 NO_INLINE
756 static void Touch(uintptr_t target) {
757 volatile size_t zero = 0;
758 // Use a large local volatile array to ensure a large frame size. Do not use anything close
759 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
760 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700761 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
762 constexpr size_t kAsanMultiplier =
763#ifdef ADDRESS_SANITIZER
764 2u;
765#else
766 1u;
767#endif
768 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700769 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700770 // Remove tag from the pointer. Nop in non-hwasan builds.
771 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
772 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700773 Touch(target);
774 }
775 zero *= 2; // Try to avoid tail recursion.
776 }
777#pragma GCC diagnostic pop
778 };
779 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000780
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700781 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700782 static_cast<void*>(pregion) << " to " <<
783 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
784
Dave Allison648d7112014-07-25 16:15:27 -0700785 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700786 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700787
788 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000789 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700790 uint32_t unwanted_size = stack_top - pregion - kPageSize;
791 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700792}
793
Ian Rogers120f1c72012-09-28 17:17:10 -0700794void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800795 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800796 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700797
798 if (VLOG_IS_ON(threads)) {
799 ScopedObjectAccess soa(env);
800
Andreas Gampe08883de2016-11-08 13:20:52 -0800801 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700802 ObjPtr<mirror::String> java_name =
803 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700804 std::string thread_name;
805 if (java_name != nullptr) {
806 thread_name = java_name->ToModifiedUtf8();
807 } else {
808 thread_name = "(Unnamed)";
809 }
810
811 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700812 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700813 }
814
Ian Rogers120f1c72012-09-28 17:17:10 -0700815 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700816
Ian Rogers120f1c72012-09-28 17:17:10 -0700817 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
818 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700819 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700820 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700821 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700822 thread_start_during_shutdown = true;
823 } else {
824 runtime->StartThreadBirth();
825 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700826 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700827 if (thread_start_during_shutdown) {
828 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
829 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
830 return;
831 }
832
833 Thread* child_thread = new Thread(is_daemon);
834 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700835 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700836 stack_size = FixStackSize(stack_size);
837
Roland Levillain2ae376f2018-01-30 11:35:11 +0000838 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
839 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800840 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
841 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700842
Andreas Gampe449357d2015-06-01 22:29:51 -0700843 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
844 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100845 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700846 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100847 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700848
Andreas Gampe449357d2015-06-01 22:29:51 -0700849 int pthread_create_result = 0;
850 if (child_jni_env_ext.get() != nullptr) {
851 pthread_t new_pthread;
852 pthread_attr_t attr;
853 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
854 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
855 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
856 "PTHREAD_CREATE_DETACHED");
857 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
858 pthread_create_result = pthread_create(&new_pthread,
859 &attr,
860 Thread::CreateCallback,
861 child_thread);
862 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
863
864 if (pthread_create_result == 0) {
865 // pthread_create started the new thread. The child is now responsible for managing the
866 // JNIEnvExt we created.
867 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
868 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700869 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700870 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700871 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700872 }
873
874 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
875 {
876 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
877 runtime->EndThreadBirth();
878 }
879 // Manually delete the global reference since Thread::Init will not have been run.
880 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
881 child_thread->tlsPtr_.jpeer = nullptr;
882 delete child_thread;
883 child_thread = nullptr;
884 // TODO: remove from thread group?
885 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
886 {
887 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100888 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700889 StringPrintf("pthread_create (%s stack) failed: %s",
890 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
891 ScopedObjectAccess soa(env);
892 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700893 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700894}
895
Andreas Gampe449357d2015-06-01 22:29:51 -0700896bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700897 // This function does all the initialization that must be run by the native thread it applies to.
898 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
899 // we can handshake with the corresponding native thread when it's ready.) Check this native
900 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800901 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800902
903 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
904 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
905 tlsPtr_.pthread_self = pthread_self();
906 CHECK(is_started_);
907
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800908 ScopedTrace trace("Thread::Init");
909
Elliott Hughesd8af1592012-04-16 20:40:15 -0700910 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800911 if (!InitStackHwm()) {
912 return false;
913 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700914 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700915 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800916 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700917 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700918 InitTid();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800919 {
920 ScopedTrace trace2("InitInterpreterTls");
921 interpreter::InitInterpreterTls(this);
922 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800923
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100924#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000925 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
926#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700927 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000928#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700929 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700930
Ian Rogersdd7624d2014-03-14 17:43:00 -0700931 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700932
Andreas Gampe449357d2015-06-01 22:29:51 -0700933 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800934 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
935 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700936 tlsPtr_.jni_env = jni_env_ext;
937 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100938 std::string error_msg;
939 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700940 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100941 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700942 return false;
943 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700944 }
945
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800946 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700947 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800948 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700949}
950
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800951template <typename PeerAction>
952Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700953 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800954 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800955 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900956 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
957 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800958 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700959 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800960 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700961 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800962 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800963 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700964 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900965 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
966 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800967 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700968 } else {
969 Runtime::Current()->StartThreadBirth();
970 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800971 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700972 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800973 if (!init_success) {
974 delete self;
975 return nullptr;
976 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700977 }
978 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700979
Jeff Hao848f70a2014-01-15 13:49:50 -0800980 self->InitStringEntryPoints();
981
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700982 CHECK_NE(self->GetState(), kRunnable);
983 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700984
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800985 // Run the action that is acting on the peer.
986 if (!peer_action(self)) {
987 runtime->GetThreadList()->Unregister(self);
988 // Unregister deletes self, no need to do this here.
989 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700990 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700991
Andreas Gampe56623832015-07-09 21:53:15 -0700992 if (VLOG_IS_ON(threads)) {
993 if (thread_name != nullptr) {
994 VLOG(threads) << "Attaching thread " << thread_name;
995 } else {
996 VLOG(threads) << "Attaching unnamed thread.";
997 }
998 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700999 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001000 }
1001
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001002 {
1003 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001004 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001005 }
1006
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001007 return self;
1008}
1009
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001010Thread* Thread::Attach(const char* thread_name,
1011 bool as_daemon,
1012 jobject thread_group,
1013 bool create_peer) {
1014 auto create_peer_action = [&](Thread* self) {
1015 // If we're the main thread, ClassLinker won't be created until after we're attached,
1016 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1017 // In the compiler, all threads need this hack, because no-one's going to be getting
1018 // a native peer!
1019 if (create_peer) {
1020 self->CreatePeer(thread_name, as_daemon, thread_group);
1021 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001022 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1023 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001024 {
1025 ScopedObjectAccess soa(self);
1026 LOG(ERROR) << "Exception creating thread peer:";
1027 LOG(ERROR) << self->GetException()->Dump();
1028 self->ClearException();
1029 }
1030 return false;
1031 }
1032 } else {
1033 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1034 if (thread_name != nullptr) {
1035 self->tlsPtr_.name->assign(thread_name);
1036 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001037 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001038 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1039 }
1040 }
1041 return true;
1042 };
1043 return Attach(thread_name, as_daemon, create_peer_action);
1044}
1045
1046Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1047 auto set_peer_action = [&](Thread* self) {
1048 // Install the given peer.
1049 {
1050 DCHECK(self == Thread::Current());
1051 ScopedObjectAccess soa(self);
1052 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1053 }
1054 self->GetJniEnv()->SetLongField(thread_peer,
1055 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001056 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001057 return true;
1058 };
1059 return Attach(thread_name, as_daemon, set_peer_action);
1060}
1061
Ian Rogers365c1022012-06-22 15:05:28 -07001062void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1063 Runtime* runtime = Runtime::Current();
1064 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001065 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001066
Dave Allison0aded082013-11-07 13:15:11 -08001067 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001068 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001069 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001070 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001071 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001072 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001073 CHECK(IsExceptionPending());
1074 return;
1075 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001076 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001077 jboolean thread_is_daemon = as_daemon;
1078
Elliott Hugheseac76672012-05-24 21:56:51 -07001079 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001080 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001081 CHECK(IsExceptionPending());
1082 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001083 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001084 {
1085 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001086 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001087 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001088 env->CallNonvirtualVoidMethod(peer.get(),
1089 WellKnownClasses::java_lang_Thread,
1090 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001091 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001092 if (IsExceptionPending()) {
1093 return;
1094 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001095
Ian Rogers120f1c72012-09-28 17:17:10 -07001096 Thread* self = this;
1097 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001098 env->SetLongField(peer.get(),
1099 WellKnownClasses::java_lang_Thread_nativePeer,
1100 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001101
1102 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001103 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001104 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001105 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001106 // The Thread constructor should have set the Thread.name to a
1107 // non-null value. However, because we can run without code
1108 // available (in the compiler, in tests), we manually assign the
1109 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001110 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001111 InitPeer<true>(soa,
1112 tlsPtr_.opeer,
1113 thread_is_daemon,
1114 thread_group,
1115 thread_name.get(),
1116 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001117 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001118 InitPeer<false>(soa,
1119 tlsPtr_.opeer,
1120 thread_is_daemon,
1121 thread_group,
1122 thread_name.get(),
1123 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001124 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001125 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001126 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001127 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001128 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001129 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001130 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001131}
1132
Andreas Gampebad529d2017-02-13 18:52:10 -08001133jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1134 const char* name,
1135 bool as_daemon,
1136 jobject thread_group) {
1137 Runtime* runtime = Runtime::Current();
1138 CHECK(!runtime->IsStarted());
1139
1140 if (thread_group == nullptr) {
1141 thread_group = runtime->GetMainThreadGroup();
1142 }
1143 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1144 // Add missing null check in case of OOM b/18297817
1145 if (name != nullptr && thread_name.get() == nullptr) {
1146 CHECK(Thread::Current()->IsExceptionPending());
1147 return nullptr;
1148 }
1149 jint thread_priority = GetNativePriority();
1150 jboolean thread_is_daemon = as_daemon;
1151
1152 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1153 if (peer.get() == nullptr) {
1154 CHECK(Thread::Current()->IsExceptionPending());
1155 return nullptr;
1156 }
1157
1158 // We cannot call Thread.init, as it will recursively ask for currentThread.
1159
1160 // The Thread constructor should have set the Thread.name to a
1161 // non-null value. However, because we can run without code
1162 // available (in the compiler, in tests), we manually assign the
1163 // fields the constructor should have set.
1164 ScopedObjectAccessUnchecked soa(Thread::Current());
1165 if (runtime->IsActiveTransaction()) {
1166 InitPeer<true>(soa,
1167 soa.Decode<mirror::Object>(peer.get()),
1168 thread_is_daemon,
1169 thread_group,
1170 thread_name.get(),
1171 thread_priority);
1172 } else {
1173 InitPeer<false>(soa,
1174 soa.Decode<mirror::Object>(peer.get()),
1175 thread_is_daemon,
1176 thread_group,
1177 thread_name.get(),
1178 thread_priority);
1179 }
1180
1181 return peer.release();
1182}
1183
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001184template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001185void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1186 ObjPtr<mirror::Object> peer,
1187 jboolean thread_is_daemon,
1188 jobject thread_group,
1189 jobject thread_name,
1190 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001191 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001192 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001193 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001194 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001195 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001196 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001197 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001198 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001199}
1200
Elliott Hughes899e7892012-01-24 14:57:32 -08001201void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001202 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001203 ::art::SetThreadName(name);
1204 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1205}
1206
Andreas Gampe9186ced2016-12-12 14:28:21 -08001207static void GetThreadStack(pthread_t thread,
1208 void** stack_base,
1209 size_t* stack_size,
1210 size_t* guard_size) {
1211#if defined(__APPLE__)
1212 *stack_size = pthread_get_stacksize_np(thread);
1213 void* stack_addr = pthread_get_stackaddr_np(thread);
1214
1215 // Check whether stack_addr is the base or end of the stack.
1216 // (On Mac OS 10.7, it's the end.)
1217 int stack_variable;
1218 if (stack_addr > &stack_variable) {
1219 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1220 } else {
1221 *stack_base = stack_addr;
1222 }
1223
1224 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1225 pthread_attr_t attributes;
1226 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1227 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1228 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1229#else
1230 pthread_attr_t attributes;
1231 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1232 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1233 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1234 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1235
1236#if defined(__GLIBC__)
1237 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1238 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1239 // will be broken because we'll die long before we get close to 2GB.
1240 bool is_main_thread = (::art::GetTid() == getpid());
1241 if (is_main_thread) {
1242 rlimit stack_limit;
1243 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1244 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1245 }
1246 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1247 size_t old_stack_size = *stack_size;
1248
1249 // Use the kernel default limit as our size, and adjust the base to match.
1250 *stack_size = 8 * MB;
1251 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1252
1253 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1254 << " to " << PrettySize(*stack_size)
1255 << " with base " << *stack_base;
1256 }
1257 }
1258#endif
1259
1260#endif
1261}
1262
Ian Rogersf4d4da12014-11-11 16:10:33 -08001263bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001264 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001265 void* read_stack_base;
1266 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001267 size_t read_guard_size;
1268 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001269
Ian Rogers13735952014-10-08 12:43:28 -07001270 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001271 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001272
Dave Allison648d7112014-07-25 16:15:27 -07001273 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1274 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1275 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1276 // between 8K and 12K.
1277 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1278 + 4 * KB;
1279 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001280 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001281 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1282 __LINE__,
1283 ::android::base::ERROR,
1284 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001285 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001286 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001287
Vladimir Markob8f2f632015-01-02 14:23:26 +00001288 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1289 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1290 read_stack_base,
1291 PrettySize(read_stack_size).c_str(),
1292 PrettySize(read_guard_size).c_str());
1293
Ian Rogers932746a2011-09-22 18:57:50 -07001294 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001295
1296 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001297 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001298
Dave Allisonb090a182014-08-14 17:02:48 +00001299 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001300
1301 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001302 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001303 // The thread might have protected region at the bottom. We need
1304 // to install our own region so we need to move the limits
1305 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001306
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001307 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1308 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1309 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001310
1311 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001312 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001313
1314 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001315 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001316
1317 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001318}
1319
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001320void Thread::ShortDump(std::ostream& os) const {
1321 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001322 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001323 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001324 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001325 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001326 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001327 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001328 << ",Thread*=" << this
1329 << ",peer=" << tlsPtr_.opeer
1330 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1331 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001332}
1333
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001334void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1335 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001336 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001337 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001338}
1339
Andreas Gampe08883de2016-11-08 13:20:52 -08001340mirror::String* Thread::GetThreadName() const {
1341 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001342 if (tlsPtr_.opeer == nullptr) {
1343 return nullptr;
1344 }
1345 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1346 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001347}
1348
Elliott Hughesffb465f2012-03-01 18:46:05 -08001349void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001350 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001351}
1352
Jeff Hao57dac6e2013-08-15 16:36:24 -07001353uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001354#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001355 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001356 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001357 timespec now;
1358 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001359 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001360#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001361 UNIMPLEMENTED(WARNING);
1362 return -1;
1363#endif
1364}
1365
Ian Rogers01ae5802012-09-28 16:14:01 -07001366// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1367static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001368 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001369 Locks::thread_suspend_count_lock_->Unlock(self);
1370 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1371 Locks::mutator_lock_->SharedTryLock(self);
1372 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1373 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1374 }
1375 }
1376 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1377 Locks::thread_list_lock_->TryLock(self);
1378 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1379 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1380 }
1381 }
1382 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001383 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001384 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001385}
1386
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001387bool Thread::ModifySuspendCountInternal(Thread* self,
1388 int delta,
1389 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001390 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001391 if (kIsDebugBuild) {
1392 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001393 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001394 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1395 Locks::thread_suspend_count_lock_->AssertHeld(self);
1396 if (this != self && !IsSuspended()) {
1397 Locks::thread_list_lock_->AssertHeld(self);
1398 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001399 }
Alex Light88fd7202017-06-30 08:31:59 -07001400 // User code suspensions need to be checked more closely since they originate from code outside of
1401 // the runtime's control.
1402 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1403 Locks::user_code_suspension_lock_->AssertHeld(self);
1404 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1405 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1406 return false;
1407 }
1408 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001409 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001410 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001411 return false;
1412 }
1413
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001414 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1415 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1416 // deadlock. b/31683379.
1417 return false;
1418 }
1419
Yu Lieac44242015-06-29 10:50:03 +08001420 uint16_t flags = kSuspendRequest;
1421 if (delta > 0 && suspend_barrier != nullptr) {
1422 uint32_t available_barrier = kMaxSuspendBarriers;
1423 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1424 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1425 available_barrier = i;
1426 break;
1427 }
1428 }
1429 if (available_barrier == kMaxSuspendBarriers) {
1430 // No barrier spaces available, we can't add another.
1431 return false;
1432 }
1433 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1434 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001435 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001436
Ian Rogersdd7624d2014-03-14 17:43:00 -07001437 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001438 switch (reason) {
1439 case SuspendReason::kForDebugger:
1440 tls32_.debug_suspend_count += delta;
1441 break;
Alex Light88fd7202017-06-30 08:31:59 -07001442 case SuspendReason::kForUserCode:
1443 tls32_.user_code_suspend_count += delta;
1444 break;
Alex Light46f93402017-06-29 11:59:50 -07001445 case SuspendReason::kInternal:
1446 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001447 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001448
Ian Rogersdd7624d2014-03-14 17:43:00 -07001449 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001450 AtomicClearFlag(kSuspendRequest);
1451 } else {
Yu Lieac44242015-06-29 10:50:03 +08001452 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001453 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001454 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001455 }
Yu Lieac44242015-06-29 10:50:03 +08001456 return true;
1457}
1458
1459bool Thread::PassActiveSuspendBarriers(Thread* self) {
1460 // Grab the suspend_count lock and copy the current set of
1461 // barriers. Then clear the list and the flag. The ModifySuspendCount
1462 // function requires the lock so we prevent a race between setting
1463 // the kActiveSuspendBarrier flag and clearing it.
1464 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1465 {
1466 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1467 if (!ReadFlag(kActiveSuspendBarrier)) {
1468 // quick exit test: the barriers have already been claimed - this is
1469 // possible as there may be a race to claim and it doesn't matter
1470 // who wins.
1471 // All of the callers of this function (except the SuspendAllInternal)
1472 // will first test the kActiveSuspendBarrier flag without lock. Here
1473 // double-check whether the barrier has been passed with the
1474 // suspend_count lock.
1475 return false;
1476 }
1477
1478 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1479 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1480 tlsPtr_.active_suspend_barriers[i] = nullptr;
1481 }
1482 AtomicClearFlag(kActiveSuspendBarrier);
1483 }
1484
1485 uint32_t barrier_count = 0;
1486 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1487 AtomicInteger* pending_threads = pass_barriers[i];
1488 if (pending_threads != nullptr) {
1489 bool done = false;
1490 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001491 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001492 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1493 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001494 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001495#if ART_USE_FUTEXES
1496 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Charles Munger7530bae2018-10-29 20:03:51 -07001497 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, -1, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001498 }
1499#endif
1500 } while (!done);
1501 ++barrier_count;
1502 }
1503 }
1504 CHECK_GT(barrier_count, 0U);
1505 return true;
1506}
1507
1508void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1509 CHECK(ReadFlag(kActiveSuspendBarrier));
1510 bool clear_flag = true;
1511 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1512 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1513 if (ptr == target) {
1514 tlsPtr_.active_suspend_barriers[i] = nullptr;
1515 } else if (ptr != nullptr) {
1516 clear_flag = false;
1517 }
1518 }
1519 if (LIKELY(clear_flag)) {
1520 AtomicClearFlag(kActiveSuspendBarrier);
1521 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001522}
1523
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001524void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001525 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1526 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1527 Closure* checkpoint;
1528 {
1529 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1530 checkpoint = tlsPtr_.checkpoint_function;
1531 if (!checkpoint_overflow_.empty()) {
1532 // Overflow list not empty, copy the first one out and continue.
1533 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1534 checkpoint_overflow_.pop_front();
1535 } else {
1536 // No overflow checkpoints. Clear the kCheckpointRequest flag
1537 tlsPtr_.checkpoint_function = nullptr;
1538 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001539 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001540 }
1541 // Outside the lock, run the checkpoint function.
1542 ScopedTrace trace("Run checkpoint function");
1543 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1544 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001545}
1546
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001547void Thread::RunEmptyCheckpoint() {
1548 DCHECK_EQ(Thread::Current(), this);
1549 AtomicClearFlag(kEmptyCheckpointRequest);
1550 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1551}
1552
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001553bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001554 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001555 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001556 if (old_state_and_flags.as_struct.state != kRunnable) {
1557 return false; // Fail, thread is suspended and so can't run a checkpoint.
1558 }
Dave Allison0aded082013-11-07 13:15:11 -08001559
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001560 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001561 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001562 union StateAndFlags new_state_and_flags;
1563 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001564 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001565 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001566 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001567 if (success) {
1568 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1569 if (tlsPtr_.checkpoint_function == nullptr) {
1570 tlsPtr_.checkpoint_function = function;
1571 } else {
1572 checkpoint_overflow_.push_back(function);
1573 }
Dave Allison0aded082013-11-07 13:15:11 -08001574 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001575 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001576 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001577 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001578}
1579
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001580bool Thread::RequestEmptyCheckpoint() {
1581 union StateAndFlags old_state_and_flags;
1582 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1583 if (old_state_and_flags.as_struct.state != kRunnable) {
1584 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1585 // heap access (eg. the read barrier).
1586 return false;
1587 }
1588
1589 // We must be runnable to request a checkpoint.
1590 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1591 union StateAndFlags new_state_and_flags;
1592 new_state_and_flags.as_int = old_state_and_flags.as_int;
1593 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001594 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001595 old_state_and_flags.as_int, new_state_and_flags.as_int);
1596 if (success) {
1597 TriggerSuspend();
1598 }
1599 return success;
1600}
1601
Andreas Gampee9f67122016-10-27 19:21:23 -07001602class BarrierClosure : public Closure {
1603 public:
1604 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1605
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001606 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001607 wrapped_->Run(self);
1608 barrier_.Pass(self);
1609 }
1610
Alex Light318afe62018-03-22 16:50:10 -07001611 void Wait(Thread* self, ThreadState suspend_state) {
1612 if (suspend_state != ThreadState::kRunnable) {
1613 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1614 } else {
1615 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1616 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001617 }
1618
1619 private:
1620 Closure* wrapped_;
1621 Barrier barrier_;
1622};
1623
Alex Lightb1e31a82017-10-04 16:57:36 -07001624// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001625bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001626 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001627 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001628 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1629 // Unlock the tll before running so that the state is the same regardless of thread.
1630 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001631 // Asked to run on this thread. Just run.
1632 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001633 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001634 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001635
1636 // The current thread is not this thread.
1637
Andreas Gampe28c4a232017-06-21 21:21:31 -07001638 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001639 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001640 return false;
1641 }
1642
Andreas Gampe28c4a232017-06-21 21:21:31 -07001643 struct ScopedThreadListLockUnlock {
1644 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1645 : self_thread(self_in) {
1646 Locks::thread_list_lock_->AssertHeld(self_thread);
1647 Locks::thread_list_lock_->Unlock(self_thread);
1648 }
1649
1650 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1651 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1652 Locks::thread_list_lock_->Lock(self_thread);
1653 }
1654
1655 Thread* self_thread;
1656 };
1657
Andreas Gampee9f67122016-10-27 19:21:23 -07001658 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001659 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001660 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1661 // suspend-count lock for too long.
1662 if (GetState() == ThreadState::kRunnable) {
1663 BarrierClosure barrier_closure(function);
1664 bool installed = false;
1665 {
1666 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1667 installed = RequestCheckpoint(&barrier_closure);
1668 }
1669 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001670 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1671 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1672 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001673 ScopedThreadStateChange sts(self, suspend_state);
1674 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001675 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001676 }
1677 // Fall-through.
1678 }
1679
1680 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1681 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1682 // certain situations.
1683 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001684 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1685
Alex Light46f93402017-06-29 11:59:50 -07001686 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001687 // Just retry the loop.
1688 sched_yield();
1689 continue;
1690 }
1691 }
1692
Andreas Gampe28c4a232017-06-21 21:21:31 -07001693 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001694 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1695 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001696 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001697 {
Alex Light318afe62018-03-22 16:50:10 -07001698 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001699 while (GetState() == ThreadState::kRunnable) {
1700 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1701 // moves us to suspended.
1702 sched_yield();
1703 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001704 }
1705
1706 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001707 }
1708
Andreas Gampee9f67122016-10-27 19:21:23 -07001709 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001710 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1711
1712 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001713 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001714 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001715 }
1716
Andreas Gampe117f9b32017-06-23 13:33:50 -07001717 {
1718 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1719 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1720 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1721 Thread::resume_cond_->Broadcast(self);
1722 }
1723
Alex Lightb1e31a82017-10-04 16:57:36 -07001724 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1725 Locks::thread_list_lock_->ExclusiveUnlock(self);
1726
Andreas Gampe28c4a232017-06-21 21:21:31 -07001727 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001728 }
1729}
1730
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001731Closure* Thread::GetFlipFunction() {
1732 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1733 Closure* func;
1734 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001735 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001736 if (func == nullptr) {
1737 return nullptr;
1738 }
Orion Hodson4557b382018-01-03 11:47:54 +00001739 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001740 DCHECK(func != nullptr);
1741 return func;
1742}
1743
1744void Thread::SetFlipFunction(Closure* function) {
1745 CHECK(function != nullptr);
1746 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001747 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001748}
1749
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001750void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001751 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001752 VLOG(threads) << this << " self-suspending";
1753 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001754 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001755 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001756 VLOG(threads) << this << " self-reviving";
1757}
1758
Andreas Gampe9186ced2016-12-12 14:28:21 -08001759static std::string GetSchedulerGroupName(pid_t tid) {
1760 // /proc/<pid>/cgroup looks like this:
1761 // 2:devices:/
1762 // 1:cpuacct,cpu:/
1763 // We want the third field from the line whose second field contains the "cpu" token.
1764 std::string cgroup_file;
1765 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1766 return "";
1767 }
1768 std::vector<std::string> cgroup_lines;
1769 Split(cgroup_file, '\n', &cgroup_lines);
1770 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1771 std::vector<std::string> cgroup_fields;
1772 Split(cgroup_lines[i], ':', &cgroup_fields);
1773 std::vector<std::string> cgroups;
1774 Split(cgroup_fields[1], ',', &cgroups);
1775 for (size_t j = 0; j < cgroups.size(); ++j) {
1776 if (cgroups[j] == "cpu") {
1777 return cgroup_fields[2].substr(1); // Skip the leading slash.
1778 }
1779 }
1780 }
1781 return "";
1782}
1783
1784
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001785void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001786 std::string group_name;
1787 int priority;
1788 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001789 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001790
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001791 // If flip_function is not null, it means we have run a checkpoint
1792 // before the thread wakes up to execute the flip function and the
1793 // thread roots haven't been forwarded. So the following access to
1794 // the roots (opeer or methods in the frames) would be bad. Run it
1795 // here. TODO: clean up.
1796 if (thread != nullptr) {
1797 ScopedObjectAccessUnchecked soa(self);
1798 Thread* this_thread = const_cast<Thread*>(thread);
1799 Closure* flip_func = this_thread->GetFlipFunction();
1800 if (flip_func != nullptr) {
1801 flip_func->Run(this_thread);
1802 }
1803 }
1804
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001805 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1806 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001807 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001808 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001809 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001810 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001811 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001812 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001813
Mathieu Chartier3398c782016-09-30 10:27:43 -07001814 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001815 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1816 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001817
Dave Allison0aded082013-11-07 13:15:11 -08001818 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001819 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001820 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001821 ObjPtr<mirror::String> group_name_string =
1822 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001823 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001824 }
1825 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001826 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001827 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001828
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001829 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001830 if (scheduler_group_name.empty()) {
1831 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001832 }
1833
Dave Allison0aded082013-11-07 13:15:11 -08001834 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001835 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001836 if (is_daemon) {
1837 os << " daemon";
1838 }
1839 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001840 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001841 << " " << thread->GetState();
1842 if (thread->IsStillStarting()) {
1843 os << " (still starting up)";
1844 }
1845 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001846 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001847 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001848 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001849 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001850 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001851
Dave Allison0aded082013-11-07 13:15:11 -08001852 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001853 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001854 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001855 << " sCount=" << thread->tls32_.suspend_count
1856 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001857 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001858 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001859 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1860 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001861
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001862 os << " | sysTid=" << tid
1863 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001864 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001865 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001866 int policy;
1867 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001868#if !defined(__APPLE__)
1869 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1870 policy = sched_getscheduler(tid);
1871 if (policy == -1) {
1872 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1873 }
1874 int sched_getparam_result = sched_getparam(tid, &sp);
1875 if (sched_getparam_result == -1) {
1876 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1877 sp.sched_priority = -1;
1878 }
1879#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001880 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1881 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001882#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001883 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001884 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001885 }
1886 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001887
1888 // Grab the scheduler stats for this thread.
1889 std::string scheduler_stats;
Evan Chengd57c51e2018-01-26 15:43:08 +08001890 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)
1891 && !scheduler_stats.empty()) {
1892 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001893 } else {
1894 scheduler_stats = "0 0 0";
1895 }
1896
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001897 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001898 int utime = 0;
1899 int stime = 0;
1900 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001901 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001902
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001903 os << " | state=" << native_thread_state
1904 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001905 << " utm=" << utime
1906 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001907 << " core=" << task_cpu
1908 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001909 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001910 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1911 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1912 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001913 // Dump the held mutexes.
1914 os << " | held mutexes=";
1915 for (size_t i = 0; i < kLockLevelCount; ++i) {
1916 if (i != kMonitorLock) {
1917 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1918 if (mutex != nullptr) {
1919 os << " \"" << mutex->GetName() << "\"";
1920 if (mutex->IsReaderWriterMutex()) {
1921 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001922 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001923 os << "(exclusive held)";
1924 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001925 os << "(shared held)";
1926 }
1927 }
1928 }
1929 }
1930 }
1931 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001932 }
1933}
1934
1935void Thread::DumpState(std::ostream& os) const {
1936 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001937}
1938
Andreas Gampe93104952017-12-13 17:13:15 -08001939struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001940 StackDumpVisitor(std::ostream& os_in,
1941 Thread* thread_in,
1942 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001943 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001944 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001945 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001946 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001947 : MonitorObjectsStackVisitor(thread_in,
1948 context,
1949 check_suspended,
1950 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001951 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001952 last_method(nullptr),
1953 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001954 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001955
Ian Rogersbdb03912011-09-14 00:55:44 -07001956 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001957 if (frame_count == 0) {
1958 os << " (no managed stack frames)\n";
1959 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001960 }
1961
Andreas Gampe93104952017-12-13 17:13:15 -08001962 static constexpr size_t kMaxRepetition = 3u;
1963
1964 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001965 override
Andreas Gampe93104952017-12-13 17:13:15 -08001966 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001967 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001968 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001969 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001970 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001971 const DexFile* dex_file = dex_cache->GetDexFile();
1972 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001973 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001974 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001975 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001976 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001977 if (repetition_count >= kMaxRepetition) {
1978 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1979 }
1980 repetition_count = 0;
1981 last_line_number = line_number;
1982 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001983 }
Andreas Gampe93104952017-12-13 17:13:15 -08001984
1985 if (repetition_count >= kMaxRepetition) {
1986 // Skip visiting=printing anything.
1987 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001988 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001989
Andreas Gampe93104952017-12-13 17:13:15 -08001990 os << " at " << m->PrettyMethod(false);
1991 if (m->IsNative()) {
1992 os << "(Native method)";
1993 } else {
1994 const char* source_file(m->GetDeclaringClassSourceFile());
1995 os << "(" << (source_file != nullptr ? source_file : "unavailable")
1996 << ":" << line_number << ")";
1997 }
1998 os << "\n";
1999 // Go and visit locks.
2000 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002001 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002002
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002003 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002004 return VisitMethodResult::kContinueMethod;
2005 }
2006
2007 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002008 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002009 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002010 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2011 }
2012 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002013 override
Andreas Gampe93104952017-12-13 17:13:15 -08002014 REQUIRES_SHARED(Locks::mutator_lock_) {
2015 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2016 }
2017 void VisitBlockedOnObject(mirror::Object* obj,
2018 ThreadState state,
2019 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002020 override
Andreas Gampe93104952017-12-13 17:13:15 -08002021 REQUIRES_SHARED(Locks::mutator_lock_) {
2022 const char* msg;
2023 switch (state) {
2024 case kBlocked:
2025 msg = " - waiting to lock ";
2026 break;
2027
2028 case kWaitingForLockInflation:
2029 msg = " - waiting for lock inflation of ";
2030 break;
2031
2032 default:
2033 LOG(FATAL) << "Unreachable";
2034 UNREACHABLE();
2035 }
2036 PrintObject(obj, msg, owner_tid);
2037 }
2038 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002039 override
Andreas Gampe93104952017-12-13 17:13:15 -08002040 REQUIRES_SHARED(Locks::mutator_lock_) {
2041 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2042 }
2043
2044 void PrintObject(mirror::Object* obj,
2045 const char* msg,
2046 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2047 if (obj == nullptr) {
2048 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002049 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002050 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002051 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2052 // Getting the identity hashcode here would result in lock inflation and suspension of the
2053 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002054 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
2055 reinterpret_cast<intptr_t>(obj),
2056 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002057 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002058 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2059 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2060 // suspension and move pretty_object.
2061 const std::string pretty_type(obj->PrettyTypeOf());
2062 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002063 }
2064 }
Andreas Gampe93104952017-12-13 17:13:15 -08002065 if (owner_tid != ThreadList::kInvalidThreadId) {
2066 os << " held by thread " << owner_tid;
2067 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002068 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002069 }
2070
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002071 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002072 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002073 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002074 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002075};
2076
Ian Rogers33e95662013-05-20 20:29:14 -07002077static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002078 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002079 ThreadState state = thread->GetState();
2080
2081 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2082 if (state > kWaiting && state < kStarting) {
2083 return true;
2084 }
2085
2086 // In an Object.wait variant or Thread.sleep? That's not interesting.
2087 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2088 return false;
2089 }
2090
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002091 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002092 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002093 return true;
2094 }
2095
Elliott Hughesaef701d2013-04-05 18:15:40 -07002096 // In some other native method? That's interesting.
2097 // We don't just check kNative because native methods will be in state kSuspended if they're
2098 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2099 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002100 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002101 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002102}
2103
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002104void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002105 // If flip_function is not null, it means we have run a checkpoint
2106 // before the thread wakes up to execute the flip function and the
2107 // thread roots haven't been forwarded. So the following access to
2108 // the roots (locks or methods in the frames) would be bad. Run it
2109 // here. TODO: clean up.
2110 {
2111 Thread* this_thread = const_cast<Thread*>(this);
2112 Closure* flip_func = this_thread->GetFlipFunction();
2113 if (flip_func != nullptr) {
2114 flip_func->Run(this_thread);
2115 }
2116 }
2117
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002118 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2119 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002120 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2121 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002122 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002123 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002124 bool have_exception = false;
2125 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002126 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002127 const_cast<Thread*>(this)->ClearException();
2128 have_exception = true;
2129 }
2130
Ian Rogers700a4022014-05-19 16:49:03 -07002131 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002132 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002133 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002134 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002135
2136 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002137 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002138 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002139}
2140
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002141void Thread::DumpStack(std::ostream& os,
2142 bool dump_native_stack,
2143 BacktraceMap* backtrace_map,
2144 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002145 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2146 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2147 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002148 bool dump_for_abort = (gAborting > 0);
2149 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2150 if (!kIsDebugBuild) {
2151 // We always want to dump the stack for an abort, however, there is no point dumping another
2152 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2153 safe_to_dump = (safe_to_dump || dump_for_abort);
2154 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002155 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002156 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002157 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002158 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002159 ArtMethod* method =
2160 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002161 /*check_suspended=*/ !force_dump_stack,
2162 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002163 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002164 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002165 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002166 /*check_suspended=*/ !force_dump_stack,
2167 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002168 } else {
2169 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002170 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002171}
2172
Elliott Hughesbe759c62011-09-08 19:38:21 -07002173void Thread::ThreadExitCallback(void* arg) {
2174 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002175 if (self->tls32_.thread_exit_check_count == 0) {
2176 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2177 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002178 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002179#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002180 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2181#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002182 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002183#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002184 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002185 } else {
2186 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2187 }
Carl Shapirob5573532011-07-12 18:22:59 -07002188}
2189
Elliott Hughesbe759c62011-09-08 19:38:21 -07002190void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002191 CHECK(!is_started_);
2192 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002193 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002194 // MutexLock to keep annotalysis happy.
2195 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002196 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002197 // return garbage since (is_started_ == true) and
2198 // Thread::pthread_key_self_ is not yet initialized.
2199 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002200 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002201 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2202 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002203 }
2204
Carl Shapirob5573532011-07-12 18:22:59 -07002205 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002206 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2207 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002208
2209 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002210 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2211 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002212 }
Elliott Hughes038a8062011-09-18 14:12:41 -07002213}
Carl Shapirob5573532011-07-12 18:22:59 -07002214
Elliott Hughes038a8062011-09-18 14:12:41 -07002215void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002216 Runtime* runtime = Runtime::Current();
2217 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002218
Elliott Hughes01158d72011-09-19 19:47:10 -07002219 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002220 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002221 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2222 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002223
Vladimir Markodcfcce42018-06-27 10:00:28 +00002224 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002225
2226 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2227 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002228 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2229 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002230}
2231
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002232void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002233 CHECK(is_started_);
2234 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002235 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002236 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002237 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002238 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002239 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002240 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002241}
2242
Andreas Gampe56776012018-01-26 17:40:55 -08002243void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2244 ScopedLocalRef<jobject> thread_jobject(
2245 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2246 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2247 soa.Env(), nullptr);
2248 jobject thread_group_jobject = thread_group;
2249 if (thread_group == nullptr || kIsDebugBuild) {
2250 // There is always a group set. Retrieve it.
2251 thread_group_jobject_scoped.reset(
2252 soa.Env()->GetObjectField(thread_jobject.get(),
2253 WellKnownClasses::java_lang_Thread_group));
2254 thread_group_jobject = thread_group_jobject_scoped.get();
2255 if (kIsDebugBuild && thread_group != nullptr) {
2256 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2257 }
2258 }
2259 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2260 WellKnownClasses::java_lang_ThreadGroup,
2261 WellKnownClasses::java_lang_ThreadGroup_add,
2262 thread_jobject.get());
2263}
2264
Calin Juravleccd56952016-12-15 17:57:38 +00002265Thread::Thread(bool daemon)
2266 : tls32_(daemon),
2267 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002268 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002269 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002270 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002271 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2272 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2273
Roland Levillain33d69032015-06-18 18:20:59 +01002274 static_assert((sizeof(Thread) % 4) == 0U,
2275 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002276 tls32_.state_and_flags.as_struct.flags = 0;
2277 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002278 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002279 // Initialize with no permit; if the java Thread was unparked before being
2280 // started, it will unpark itself before calling into java code.
2281 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002282 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002283 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002284 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002285 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002286 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002287 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2288 tlsPtr_.active_suspend_barriers[i] = nullptr;
2289 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002290 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002291 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002292 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002293 tls32_.use_mterp = false;
2294}
2295
2296void Thread::NotifyInTheadList() {
2297 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002298}
2299
Alex Lighte9f61032018-09-24 16:04:51 -07002300bool Thread::CanLoadClasses() const {
2301 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2302}
2303
Elliott Hughes7dc51662012-05-16 14:48:43 -07002304bool Thread::IsStillStarting() const {
2305 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002306 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002307 // 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 -07002308 // assigned fairly early on, and needs to be.
2309 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2310 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002311 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2312 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002313}
2314
Andreas Gamped9efea62014-07-21 22:56:08 -07002315void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002316 CHECK(IsExceptionPending()) << "Pending exception expected.";
2317}
2318
2319void Thread::AssertPendingOOMException() const {
2320 AssertPendingException();
2321 auto* e = GetException();
2322 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2323 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002324}
2325
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002326void Thread::AssertNoPendingException() const {
2327 if (UNLIKELY(IsExceptionPending())) {
2328 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002329 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002330 }
2331}
2332
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002333void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2334 if (UNLIKELY(IsExceptionPending())) {
2335 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002336 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002337 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002338 }
2339}
2340
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002341class MonitorExitVisitor : public SingleRootVisitor {
2342 public:
2343 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2344
2345 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2346 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002347 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002348 if (self_->HoldsLock(entered_monitor)) {
2349 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002350 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002351 << " left locked by native thread "
2352 << *Thread::Current() << " which is detaching";
2353 entered_monitor->MonitorExit(self_);
2354 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002355 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002356
2357 private:
2358 Thread* const self_;
2359};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002360
Elliott Hughesc0f09332012-03-26 13:27:06 -07002361void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002362 Thread* self = this;
2363 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002364
Ian Rogers68d8b422014-07-17 11:09:10 -07002365 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002366 {
2367 ScopedObjectAccess soa(self);
2368 MonitorExitVisitor visitor(self);
2369 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002370 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002371 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002372 // Release locally held global references which releasing may require the mutator lock.
2373 if (tlsPtr_.jpeer != nullptr) {
2374 // If pthread_create fails we don't have a jni env here.
2375 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2376 tlsPtr_.jpeer = nullptr;
2377 }
2378 if (tlsPtr_.class_loader_override != nullptr) {
2379 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2380 tlsPtr_.class_loader_override = nullptr;
2381 }
2382 }
2383
Ian Rogersdd7624d2014-03-14 17:43:00 -07002384 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002385 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002386 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002387 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002388 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002389 Runtime* runtime = Runtime::Current();
2390 if (runtime != nullptr) {
2391 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2392 }
Elliott Hughes534da072012-03-27 15:17:42 -07002393
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002394 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002395 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002396 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002397 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002398 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002399 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002400 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002401 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002402
Ian Rogerscfaa4552012-11-26 21:00:08 -08002403 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2404 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002405 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002406 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002407 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002408 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002409 StackHandleScope<1> hs(self);
2410 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002411 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002412 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002413 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002414 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002415 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002416
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002417 {
2418 ScopedObjectAccess soa(self);
2419 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002420 if (kUseReadBarrier) {
2421 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2422 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002423 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002424}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002425
Elliott Hughesc0f09332012-03-26 13:27:06 -07002426Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002427 CHECK(tlsPtr_.class_loader_override == nullptr);
2428 CHECK(tlsPtr_.jpeer == nullptr);
2429 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002430 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002431 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002432 delete tlsPtr_.jni_env;
2433 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002434 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002435 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002436 CHECK(!ReadFlag(kCheckpointRequest));
2437 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002438 CHECK(tlsPtr_.checkpoint_function == nullptr);
2439 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002440 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002441 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002442
Sebastien Hertz07474662015-08-25 15:12:33 +00002443 // Make sure we processed all deoptimization requests.
2444 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002445 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2446 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002447
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002448 // We may be deleting a still born thread.
2449 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002450
2451 delete wait_cond_;
2452 delete wait_mutex_;
2453
Ian Rogersdd7624d2014-03-14 17:43:00 -07002454 if (tlsPtr_.long_jump_context != nullptr) {
2455 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002456 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002457
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002458 if (initialized) {
2459 CleanupCpu();
2460 }
2461
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002462 if (tlsPtr_.single_step_control != nullptr) {
2463 delete tlsPtr_.single_step_control;
2464 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002465 delete tlsPtr_.instrumentation_stack;
2466 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002467 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002468
Ian Rogers68d8b422014-07-17 11:09:10 -07002469 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002470
Elliott Hughesd8af1592012-04-16 20:40:15 -07002471 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002472}
2473
Andreas Gampe513061a2017-06-01 09:17:34 -07002474void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002475 if (!IsExceptionPending()) {
2476 return;
2477 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002478 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002479 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002480
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002481 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002482 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2483 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002484
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002485 // Call the Thread instance's dispatchUncaughtException(Throwable)
2486 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2487 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2488 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002489
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002490 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002491 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002492}
2493
Andreas Gampe513061a2017-06-01 09:17:34 -07002494void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002495 // this.group.removeThread(this);
2496 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002497 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002498 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002499 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002500 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002501 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002502 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002503 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2504 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2505 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002506 }
2507}
2508
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002509bool Thread::HandleScopeContains(jobject obj) const {
2510 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002511 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002512 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002513 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002514 return true;
2515 }
2516 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002517 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2518 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002519}
2520
Hans Boehm0882af22017-08-31 15:21:57 -07002521void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002522 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2523 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002524 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2525 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002526 }
2527}
2528
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002529ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002530 if (obj == nullptr) {
2531 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002532 }
2533 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002534 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002535 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002536 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002537 // The "kinds" below are sorted by the frequency we expect to encounter them.
2538 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002539 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002540 // Local references do not need a read barrier.
2541 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002542 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002543 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002544 // Check if this is a local reference in the handle scope.
2545 if (LIKELY(HandleScopeContains(obj))) {
2546 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002547 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002548 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002549 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002550 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002551 expect_null = true;
2552 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002553 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002554 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002555 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002556 } else {
2557 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002558 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002559 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002560 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002561 expect_null = true;
2562 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002563 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002564 }
2565
Ian Rogersc0542af2014-09-03 16:16:56 -07002566 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002567 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002568 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002569 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002570 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002571}
2572
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002573bool Thread::IsJWeakCleared(jweak obj) const {
2574 CHECK(obj != nullptr);
2575 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002576 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002577 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002578 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002579}
2580
Ian Rogers81d425b2012-09-27 16:03:43 -07002581// Implements java.lang.Thread.interrupted.
2582bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002583 DCHECK_EQ(Thread::Current(), this);
2584 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002585 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002586 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002587 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002588 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002589 return interrupted;
2590}
2591
2592// Implements java.lang.Thread.isInterrupted.
2593bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002594 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002595}
2596
Ian Rogersdd7624d2014-03-14 17:43:00 -07002597void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002598 {
2599 MutexLock mu(self, *wait_mutex_);
2600 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2601 return;
2602 }
2603 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2604 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002605 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002606 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002607}
2608
2609void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002610 Thread* self = Thread::Current();
2611 MutexLock mu(self, *wait_mutex_);
2612 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002613}
2614
Ian Rogersc604d732012-10-14 16:09:54 -07002615void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002616 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002617 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002618 }
2619}
2620
Ian Rogers68d8b422014-07-17 11:09:10 -07002621void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2622 if (tlsPtr_.class_loader_override != nullptr) {
2623 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2624 }
2625 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2626}
2627
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002628using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2629
2630// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2631class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002632 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002633 explicit FetchStackTraceVisitor(Thread* thread,
2634 ArtMethodDexPcPair* saved_frames = nullptr,
2635 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002636 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002637 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002638 saved_frames_(saved_frames),
2639 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002640
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002641 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002642 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002643 // Note we also skip the frame if it doesn't have a method (namely the callee
2644 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002645 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002646 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002647 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002648 skipping_ = false;
2649 }
2650 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002651 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002652 if (depth_ < max_saved_frames_) {
2653 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002654 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002655 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002656 ++depth_;
2657 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002658 } else {
2659 ++skip_depth_;
2660 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002661 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002662 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002663
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002664 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002665 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002666 }
2667
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002668 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002669 return skip_depth_;
2670 }
2671
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002672 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002673 uint32_t depth_ = 0;
2674 uint32_t skip_depth_ = 0;
2675 bool skipping_ = true;
2676 ArtMethodDexPcPair* saved_frames_;
2677 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002678
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002679 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002680};
2681
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002682template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002683class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002684 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002685 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002686 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2687 self_(self),
2688 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002689 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002690
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002691 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002692 // Allocate method trace as an object array where the first element is a pointer array that
2693 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2694 // class of the ArtMethod pointers.
2695 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2696 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002697 ObjPtr<mirror::Class> array_class =
2698 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002699 // The first element is the methods and dex pc array, the other elements are declaring classes
2700 // for the methods to ensure classes in the stack trace don't get unloaded.
2701 Handle<mirror::ObjectArray<mirror::Object>> trace(
2702 hs.NewHandle(
2703 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002704 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002705 // Acquire uninterruptible_ in all paths.
2706 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002707 self_->AssertPendingOOMException();
2708 return false;
2709 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002710 ObjPtr<mirror::PointerArray> methods_and_pcs =
2711 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002712 const char* last_no_suspend_cause =
2713 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2714 if (methods_and_pcs == nullptr) {
2715 self_->AssertPendingOOMException();
2716 return false;
2717 }
2718 trace->Set(0, methods_and_pcs);
2719 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002720 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002721 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002722 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002723 }
2724
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002725 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2726 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002727 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002728
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002729 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002730 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002731 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002732 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002733 if (skip_depth_ > 0) {
2734 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002735 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002736 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002737 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002738 if (m->IsRuntimeMethod()) {
2739 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002740 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002741 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002742 return true;
2743 }
2744
2745 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002746 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002747 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002748 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2749 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002750 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002751 pointer_size_);
2752 // Save the declaring class of the method to ensure that the declaring classes of the methods
2753 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002754 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002755 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002756 }
2757
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002758 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
2759 return ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(trace_->Get(0)));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002760 }
2761
2762 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002763 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002764 }
2765
2766 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002767 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002768 // How many more frames to skip.
2769 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002770 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002771 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002772 // An object array where the first element is a pointer array that contains the ArtMethod
2773 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2774 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2775 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002776 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002777 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002778 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002779
2780 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002781};
2782
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002783template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002784jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002785 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2786 constexpr size_t kMaxSavedFrames = 256;
2787 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2788 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2789 &saved_frames[0],
2790 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002791 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002792 const uint32_t depth = count_visitor.GetDepth();
2793 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002794
Ian Rogers1f539342012-10-03 21:09:42 -07002795 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002796 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2797 const_cast<Thread*>(this),
2798 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002799 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002800 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002801 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002802 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2803 // than doing the stack walk twice.
2804 if (depth < kMaxSavedFrames) {
2805 for (size_t i = 0; i < depth; ++i) {
2806 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2807 }
2808 } else {
2809 build_trace_visitor.WalkStack();
2810 }
2811
Mathieu Chartier910e8272015-09-30 09:24:22 -07002812 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002813 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002814 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002815 // Second half of trace_methods is dex PCs.
2816 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2817 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002818 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2819 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002820 }
2821 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002822 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002823}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002824template jobject Thread::CreateInternalStackTrace<false>(
2825 const ScopedObjectAccessAlreadyRunnable& soa) const;
2826template jobject Thread::CreateInternalStackTrace<true>(
2827 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002828
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002829bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002830 // Only count the depth since we do not pass a stack frame array as an argument.
2831 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002832 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002833 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002834}
2835
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002836static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2837 const ScopedObjectAccessAlreadyRunnable& soa,
2838 ArtMethod* method,
2839 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2840 int32_t line_number;
2841 StackHandleScope<3> hs(soa.Self());
2842 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2843 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2844 if (method->IsProxyMethod()) {
2845 line_number = -1;
2846 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2847 // source_name_object intentionally left null for proxy methods
2848 } else {
2849 line_number = method->GetLineNumFromDexPC(dex_pc);
2850 // Allocate element, potentially triggering GC
2851 // TODO: reuse class_name_object via Class::name_?
2852 const char* descriptor = method->GetDeclaringClassDescriptor();
2853 CHECK(descriptor != nullptr);
2854 std::string class_name(PrettyDescriptor(descriptor));
2855 class_name_object.Assign(
2856 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2857 if (class_name_object == nullptr) {
2858 soa.Self()->AssertPendingOOMException();
2859 return nullptr;
2860 }
2861 const char* source_file = method->GetDeclaringClassSourceFile();
2862 if (line_number == -1) {
2863 // Make the line_number field of StackTraceElement hold the dex pc.
2864 // source_name_object is intentionally left null if we failed to map the dex pc to
2865 // a line number (most probably because there is no debug info). See b/30183883.
2866 line_number = dex_pc;
2867 } else {
2868 if (source_file != nullptr) {
2869 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2870 if (source_name_object == nullptr) {
2871 soa.Self()->AssertPendingOOMException();
2872 return nullptr;
2873 }
2874 }
2875 }
2876 }
2877 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2878 CHECK(method_name != nullptr);
2879 Handle<mirror::String> method_name_object(
2880 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2881 if (method_name_object == nullptr) {
2882 return nullptr;
2883 }
2884 return mirror::StackTraceElement::Alloc(soa.Self(),
2885 class_name_object,
2886 method_name_object,
2887 source_name_object,
2888 line_number);
2889}
2890
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002891jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002892 const ScopedObjectAccessAlreadyRunnable& soa,
2893 jobject internal,
2894 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002895 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002896 // Decode the internal stack trace into the depth, method trace and PC trace.
2897 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002898 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002899 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002900
Mathieu Chartier910e8272015-09-30 09:24:22 -07002901 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002902
Elliott Hughes01158d72011-09-19 19:47:10 -07002903 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002904
Dave Allison0aded082013-11-07 13:15:11 -08002905 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002906 // Reuse the array we were given.
2907 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002908 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002909 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002910 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002911 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002912 } else {
2913 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002914 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002915 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002916 if (java_traces == nullptr) {
2917 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002918 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002919 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002920 }
2921
Dave Allison0aded082013-11-07 13:15:11 -08002922 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002923 *stack_depth = depth;
2924 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002925
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002926 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002927 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002928 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002929 // Methods and dex PC trace is element 0.
2930 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002931 ObjPtr<mirror::PointerArray> const method_trace =
2932 ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(decoded_traces->Get(0)));
Ian Rogersaaa20802011-09-11 21:47:37 -07002933 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002934 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002935 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002936 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002937 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002938 if (obj == nullptr) {
2939 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002940 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002941 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002942 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002943 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002944 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002945}
2946
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002947jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2948 // This code allocates. Do not allow it to operate with a pending exception.
2949 if (IsExceptionPending()) {
2950 return nullptr;
2951 }
2952
2953 // If flip_function is not null, it means we have run a checkpoint
2954 // before the thread wakes up to execute the flip function and the
2955 // thread roots haven't been forwarded. So the following access to
2956 // the roots (locks or methods in the frames) would be bad. Run it
2957 // here. TODO: clean up.
2958 // Note: copied from DumpJavaStack.
2959 {
2960 Thread* this_thread = const_cast<Thread*>(this);
2961 Closure* flip_func = this_thread->GetFlipFunction();
2962 if (flip_func != nullptr) {
2963 flip_func->Run(this_thread);
2964 }
2965 }
2966
2967 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2968 public:
2969 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2970 Thread* self,
2971 Context* context)
2972 : MonitorObjectsStackVisitor(self, context),
2973 wait_jobject_(soaa_in.Env(), nullptr),
2974 block_jobject_(soaa_in.Env(), nullptr),
2975 soaa_(soaa_in) {}
2976
2977 protected:
2978 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002979 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002980 REQUIRES_SHARED(Locks::mutator_lock_) {
2981 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
2982 soaa_, m, GetDexPc(/* abort on error */ false));
2983 if (obj == nullptr) {
2984 return VisitMethodResult::kEndStackWalk;
2985 }
2986 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
2987 return VisitMethodResult::kContinueMethod;
2988 }
2989
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002990 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002991 lock_objects_.push_back({});
2992 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
2993
2994 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
2995
2996 return VisitMethodResult::kContinueMethod;
2997 }
2998
2999 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003000 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003001 REQUIRES_SHARED(Locks::mutator_lock_) {
3002 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3003 }
3004 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003005 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003006 REQUIRES_SHARED(Locks::mutator_lock_) {
3007 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3008 }
3009 void VisitBlockedOnObject(mirror::Object* obj,
3010 ThreadState state ATTRIBUTE_UNUSED,
3011 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003012 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003013 REQUIRES_SHARED(Locks::mutator_lock_) {
3014 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3015 }
3016 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003017 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003018 REQUIRES_SHARED(Locks::mutator_lock_) {
3019 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3020 }
3021
3022 public:
3023 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3024 ScopedLocalRef<jobject> wait_jobject_;
3025 ScopedLocalRef<jobject> block_jobject_;
3026 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3027
3028 private:
3029 const ScopedObjectAccessAlreadyRunnable& soaa_;
3030
3031 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3032 };
3033
3034 std::unique_ptr<Context> context(Context::Create());
3035 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3036 dumper.WalkStack();
3037
3038 // There should not be a pending exception. Otherwise, return with it pending.
3039 if (IsExceptionPending()) {
3040 return nullptr;
3041 }
3042
3043 // Now go and create Java arrays.
3044
3045 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3046
3047 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003048 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003049 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003050 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3051 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003052 return nullptr;
3053 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003054 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003055
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003056 Handle<mirror::Class> h_o_array_class =
3057 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3058 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003059
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003060
3061 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3062 class_linker->EnsureInitialized(soa.Self(),
3063 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003064 /* can_init_fields= */ true,
3065 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003066 if (soa.Self()->IsExceptionPending()) {
3067 // This should not fail in a healthy runtime.
3068 return nullptr;
3069 }
3070
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003071 ArtField* stack_trace_element_field = h_aste_class->FindField(
3072 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3073 DCHECK(stack_trace_element_field != nullptr);
3074 ArtField* held_locks_field = h_aste_class->FindField(
3075 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3076 DCHECK(held_locks_field != nullptr);
3077 ArtField* blocked_on_field = h_aste_class->FindField(
3078 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3079 DCHECK(blocked_on_field != nullptr);
3080
3081 size_t length = dumper.stack_trace_elements_.size();
3082 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003083 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003084 if (array == nullptr) {
3085 soa.Self()->AssertPendingOOMException();
3086 return nullptr;
3087 }
3088
3089 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3090
3091 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3092 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3093 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3094 for (size_t i = 0; i != length; ++i) {
3095 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3096 if (handle == nullptr) {
3097 soa.Self()->AssertPendingOOMException();
3098 return nullptr;
3099 }
3100
3101 // Set stack trace element.
3102 stack_trace_element_field->SetObject<false>(
3103 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3104
3105 // Create locked-on array.
3106 if (!dumper.lock_objects_[i].empty()) {
3107 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3108 h_o_array_class.Get(),
3109 dumper.lock_objects_[i].size()));
3110 if (handle2 == nullptr) {
3111 soa.Self()->AssertPendingOOMException();
3112 return nullptr;
3113 }
3114 int32_t j = 0;
3115 for (auto& scoped_local : dumper.lock_objects_[i]) {
3116 if (scoped_local == nullptr) {
3117 continue;
3118 }
3119 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3120 DCHECK(!soa.Self()->IsExceptionPending());
3121 j++;
3122 }
3123 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3124 }
3125
3126 // Set blocked-on object.
3127 if (i == 0) {
3128 if (dumper.block_jobject_ != nullptr) {
3129 blocked_on_field->SetObject<false>(
3130 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3131 }
3132 }
3133
3134 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3135 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3136 DCHECK(!soa.Self()->IsExceptionPending());
3137 }
3138
3139 return result.release();
3140}
3141
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003142void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003143 va_list args;
3144 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003145 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003146 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003147}
3148
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003149void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003150 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003151 std::string msg;
3152 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003153 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003154}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003155
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003156void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003157 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003158 // Callers should either clear or call ThrowNewWrappedException.
3159 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003160 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003161}
3162
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003163static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003164 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003165 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003166 return method != nullptr
3167 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003168 : nullptr;
3169}
3170
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003171void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003172 const char* msg) {
3173 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003174 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003175 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003176 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003177 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003178 ClearException();
3179 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003180 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003181 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003182 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003183 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003184 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003185 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003186 return;
3187 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003188
Ian Rogers7b078e82014-09-10 14:44:24 -07003189 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3190 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003191 DCHECK(IsExceptionPending());
3192 return;
3193 }
3194 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003195 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003196 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003197
Mathieu Chartier590fee92013-09-13 13:46:47 -07003198 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003199 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003200 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3201 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003202 return;
3203 }
3204
Ian Rogers62d6c772013-02-27 08:32:07 -08003205 // Choose an appropriate constructor and set up the arguments.
3206 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003207 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003208 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003209 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003210 msg_string.reset(
3211 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003212 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003213 CHECK(IsExceptionPending()); // OOME.
3214 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003215 }
Dave Allison0aded082013-11-07 13:15:11 -08003216 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003217 signature = "(Ljava/lang/String;)V";
3218 } else {
3219 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3220 }
3221 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003222 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003223 signature = "()V";
3224 } else {
3225 signature = "(Ljava/lang/Throwable;)V";
3226 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003227 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003228 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003229 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003230
Dave Allison0aded082013-11-07 13:15:11 -08003231 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003232 << PrettyDescriptor(exception_class_descriptor);
3233
3234 if (UNLIKELY(!runtime->IsStarted())) {
3235 // Something is trying to throw an exception without a started runtime, which is the common
3236 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3237 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003238 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003239 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003240 }
Dave Allison0aded082013-11-07 13:15:11 -08003241 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003242 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003243 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003244 ScopedLocalRef<jobject> trace(GetJniEnv(),
3245 Runtime::Current()->IsActiveTransaction()
3246 ? CreateInternalStackTrace<true>(soa)
3247 : CreateInternalStackTrace<false>(soa));
3248 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003249 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003250 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003251 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003252 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003253 jvalue jv_args[2];
3254 size_t i = 0;
3255
Dave Allison0aded082013-11-07 13:15:11 -08003256 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003257 jv_args[i].l = msg_string.get();
3258 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003259 }
Dave Allison0aded082013-11-07 13:15:11 -08003260 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003261 jv_args[i].l = cause.get();
3262 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003263 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003264 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08003265 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003266 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003267 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003268 }
Elliott Hughes30646832011-10-13 16:59:46 -07003269 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003270}
3271
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003272void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003273 LOG(WARNING) << "Throwing OutOfMemoryError "
3274 << '"' << msg << '"'
3275 << " (VmSize " << GetProcessStatus("VmSize")
3276 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003277 if (!tls32_.throwing_OutOfMemoryError) {
3278 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003279 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003280 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003281 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003282 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003283 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003284 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003285}
3286
Elliott Hughes498508c2011-10-17 14:58:22 -07003287Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003288 return Thread::Current();
3289}
3290
3291void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003292 std::ostringstream ss;
3293 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003294 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003295 // log to stderr for debugging command line processes
3296 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003297#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003298 // log to logcat for debugging frameworks processes
3299 LOG(INFO) << str;
3300#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003301}
3302
Ian Rogersdd7624d2014-03-14 17:43:00 -07003303// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003304template
3305void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3306template
3307void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003308
Andreas Gampe542451c2016-07-26 09:02:02 -07003309template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003310void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3311#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003312 if (offset == (x).Uint32Value()) { \
3313 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003314 return; \
3315 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003316 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3317 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3318 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3319 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3320 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3321 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3322 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3323 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003324 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003325 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003326 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003327 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003328 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003329#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003330
Ian Rogersdd7624d2014-03-14 17:43:00 -07003331#define JNI_ENTRY_POINT_INFO(x) \
3332 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3333 os << #x; \
3334 return; \
3335 }
3336 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3337#undef JNI_ENTRY_POINT_INFO
3338
Ian Rogersdd7624d2014-03-14 17:43:00 -07003339#define QUICK_ENTRY_POINT_INFO(x) \
3340 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3341 os << #x; \
3342 return; \
3343 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003344 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003345 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3346 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3347 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3348 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003349 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3350 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003351 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003352 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003353 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3354 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3355 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003356 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003357 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003358 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003359 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3360 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003361 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003362 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3363 QUICK_ENTRY_POINT_INFO(pSet8Static)
3364 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3365 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003366 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3367 QUICK_ENTRY_POINT_INFO(pSet32Static)
3368 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3369 QUICK_ENTRY_POINT_INFO(pSet64Static)
3370 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3371 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003372 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3373 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3374 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3375 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3376 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3377 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3378 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3379 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003380 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3381 QUICK_ENTRY_POINT_INFO(pGet32Static)
3382 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3383 QUICK_ENTRY_POINT_INFO(pGet64Static)
3384 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3385 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003386 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003387 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3388 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3389 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3390 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3391 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3392 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3393 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3394 QUICK_ENTRY_POINT_INFO(pLockObject)
3395 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3396 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3397 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3398 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3399 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003400 QUICK_ENTRY_POINT_INFO(pCos)
3401 QUICK_ENTRY_POINT_INFO(pSin)
3402 QUICK_ENTRY_POINT_INFO(pAcos)
3403 QUICK_ENTRY_POINT_INFO(pAsin)
3404 QUICK_ENTRY_POINT_INFO(pAtan)
3405 QUICK_ENTRY_POINT_INFO(pAtan2)
3406 QUICK_ENTRY_POINT_INFO(pCbrt)
3407 QUICK_ENTRY_POINT_INFO(pCosh)
3408 QUICK_ENTRY_POINT_INFO(pExp)
3409 QUICK_ENTRY_POINT_INFO(pExpm1)
3410 QUICK_ENTRY_POINT_INFO(pHypot)
3411 QUICK_ENTRY_POINT_INFO(pLog)
3412 QUICK_ENTRY_POINT_INFO(pLog10)
3413 QUICK_ENTRY_POINT_INFO(pNextAfter)
3414 QUICK_ENTRY_POINT_INFO(pSinh)
3415 QUICK_ENTRY_POINT_INFO(pTan)
3416 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003417 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003418 QUICK_ENTRY_POINT_INFO(pL2d)
3419 QUICK_ENTRY_POINT_INFO(pFmodf)
3420 QUICK_ENTRY_POINT_INFO(pL2f)
3421 QUICK_ENTRY_POINT_INFO(pD2iz)
3422 QUICK_ENTRY_POINT_INFO(pF2iz)
3423 QUICK_ENTRY_POINT_INFO(pIdivmod)
3424 QUICK_ENTRY_POINT_INFO(pD2l)
3425 QUICK_ENTRY_POINT_INFO(pF2l)
3426 QUICK_ENTRY_POINT_INFO(pLdiv)
3427 QUICK_ENTRY_POINT_INFO(pLmod)
3428 QUICK_ENTRY_POINT_INFO(pLmul)
3429 QUICK_ENTRY_POINT_INFO(pShlLong)
3430 QUICK_ENTRY_POINT_INFO(pShrLong)
3431 QUICK_ENTRY_POINT_INFO(pUshrLong)
3432 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003433 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3434 QUICK_ENTRY_POINT_INFO(pMemcpy)
3435 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3436 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3437 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3438 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3439 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3440 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3441 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3442 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003443 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003444 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3445 QUICK_ENTRY_POINT_INFO(pDeliverException)
3446 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3447 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003448 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3449 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003450 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003451 QUICK_ENTRY_POINT_INFO(pA64Load)
3452 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003453 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3454 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3455 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3456 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3457 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3458 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3459 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3460 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3461 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3462 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3463 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3464 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3465 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3466 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3467 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3468 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003469 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003470 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3471 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3472 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3473 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3474 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3475 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3476 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3477 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3478 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3479 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3480 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3481 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3482 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3483 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3484 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3485 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3486 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3487 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3488 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3489 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3490 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3491 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3492 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3493 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3494 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3495 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3496 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3497 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3498 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3499 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003500 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003501 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003502
3503 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3504 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003505#undef QUICK_ENTRY_POINT_INFO
3506
Elliott Hughes98e20172012-04-24 15:38:13 -07003507 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003508}
3509
jeffhao94d6df42012-11-26 16:02:12 -08003510void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003511 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003512 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003513 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003514 if (exception == GetDeoptimizationException()) {
3515 artDeoptimize(this);
3516 UNREACHABLE();
3517 }
3518
Roland Levillaina78f5b62017-09-29 13:50:44 +01003519 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003520
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003521 // This is a real exception: let the instrumentation know about it.
3522 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003523 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003524 IsExceptionThrownByCurrentMethod(exception)) {
3525 // Instrumentation may cause GC so keep the exception object safe.
3526 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003527 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Alex Light6e1607e2017-08-23 10:06:18 -07003528 instrumentation->ExceptionThrownEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003529 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003530 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3531 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3532 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3533 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003534 //
3535 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3536 // expected to happen fairly regularly but the second can only happen if we are using
3537 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3538 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003539 ShadowFrame* cf;
Alex Lightbe1f8d02018-10-15 11:44:42 -07003540 bool force_deopt;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003541 {
3542 NthCallerVisitor visitor(this, 0, false);
3543 visitor.WalkStack();
3544 cf = visitor.GetCurrentShadowFrame();
3545 if (cf == nullptr) {
3546 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3547 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003548 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3549 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003550 if (kIsDebugBuild && force_frame_pop) {
3551 NthCallerVisitor penultimate_visitor(this, 1, false);
3552 penultimate_visitor.WalkStack();
3553 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3554 if (penultimate_frame == nullptr) {
3555 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3556 }
3557 DCHECK(penultimate_frame != nullptr &&
3558 penultimate_frame->GetForceRetryInstruction())
3559 << "Force pop frame without retry instruction found. penultimate frame is null: "
3560 << (penultimate_frame == nullptr ? "true" : "false");
3561 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003562 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003563 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003564 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003565 NthCallerVisitor visitor(this, 0, false);
3566 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003567 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003568 // method_type shouldn't matter due to exception handling.
3569 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003570 // Save the exception into the deoptimization context so it can be restored
3571 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003572 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003573 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3574 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3575 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003576 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3577 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003578 ClearException();
3579 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003580 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003581 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003582 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003583 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003584 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003585 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003586 artDeoptimize(this);
3587 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003588 } else {
3589 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3590 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003591 }
3592 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003593
Ian Rogers28ad40d2011-10-27 15:19:26 -07003594 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003595 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003596 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003597 QuickExceptionHandler exception_handler(this, false);
3598 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003599 if (exception_handler.GetClearException()) {
3600 // Exception was cleared as part of delivery.
3601 DCHECK(!IsExceptionPending());
3602 } else {
3603 // Exception was put back with a throw location.
3604 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003605 // Check the to-space invariant on the re-installed exception (if applicable).
3606 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003607 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003608 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003609}
3610
Ian Rogersbdb03912011-09-14 00:55:44 -07003611Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003612 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003613 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003614 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003615 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003616 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003617 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003618 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003619 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003620}
3621
Andreas Gampec7d878d2018-11-19 18:42:06 +00003622ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003623 bool check_suspended,
3624 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003625 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3626 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3627 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003628 ArtMethod* method = nullptr;
3629 uint32_t dex_pc = dex::kDexNoIndex;
3630 StackVisitor::WalkStack(
3631 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3632 ArtMethod* m = visitor->GetMethod();
3633 if (m->IsRuntimeMethod()) {
3634 // Continue if this is a runtime method.
3635 return true;
3636 }
3637 method = m;
3638 dex_pc = visitor->GetDexPc(abort_on_error);
3639 return false;
3640 },
3641 const_cast<Thread*>(this),
3642 /* context= */ nullptr,
3643 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3644 check_suspended);
3645
3646 if (dex_pc_out != nullptr) {
3647 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003648 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003649 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003650}
3651
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003652bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3653 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003654}
3655
Roland Levillainad0777d2018-02-12 20:00:18 +00003656extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003657 REQUIRES_SHARED(Locks::mutator_lock_);
3658
Ian Rogers40e3bac2012-11-20 00:09:14 -08003659// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003660template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003661class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003662 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003663 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003664 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003665 // We are visiting the references in compiled frames, so we do not need
3666 // to know the inlined frames.
3667 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3668 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003669
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003670 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003671 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003672 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003673 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003674 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003675 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003676 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003677 VisitShadowFrame(shadow_frame);
3678 } else {
3679 VisitQuickFrame();
3680 }
3681 return true;
3682 }
3683
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003684 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003685 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003686 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003687 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003688 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003689 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
3690 // handle scope for JNI or References for interpreter.
3691 for (size_t reg = 0; reg < num_regs; ++reg) {
3692 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3693 if (ref != nullptr) {
3694 mirror::Object* new_ref = ref;
3695 visitor_(&new_ref, reg, this);
3696 if (new_ref != ref) {
3697 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003698 }
3699 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003700 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003701 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003702 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003703 }
3704
3705 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003706 // 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 -07003707 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3708 // the threads do not all hold the heap bitmap lock for parallel GC.
3709 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003710 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003711 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003712 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003713 // klass can be null for runtime methods.
3714 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003715 if (kVerifyImageObjectsMarked) {
3716 gc::Heap* const heap = Runtime::Current()->GetHeap();
3717 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003718 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003719 if (space != nullptr && space->IsImageSpace()) {
3720 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003721 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003722 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003723 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003724 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003725 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003726 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003727 }
3728 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003729 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3730 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3731 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003732 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003733 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003734 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3735 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003736 }
3737 }
3738 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003739 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003740 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003741 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003742 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003743 }
3744 }
3745 }
3746
Andreas Gampe585da952016-12-02 14:52:29 -08003747 template <typename T>
3748 ALWAYS_INLINE
3749 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003750 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003751 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003752 ArtMethod* m = *cur_quick_frame;
3753 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003754
Sebastien Hertz714f1752014-04-28 15:03:08 +02003755 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003756 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003757 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003758 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003759 StackReference<mirror::Object>* vreg_base =
3760 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003761 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbeckya2d29a32018-08-03 11:06:38 +01003762 CodeInfo code_info(method_header, kPrecise
David Srbecky42deda82018-08-10 11:23:27 +01003763 ? CodeInfo::DecodeFlags::AllTables // We will need dex register maps.
David Srbeckya2d29a32018-08-03 11:06:38 +01003764 : CodeInfo::DecodeFlags::GcMasksOnly);
David Srbecky052f8ca2018-04-26 15:42:54 +01003765 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003766 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003767
David Srbecky052f8ca2018-04-26 15:42:54 +01003768 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003769
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003770 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003771 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003772 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003773 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003774 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003775 mirror::Object* ref = ref_addr->AsMirrorPtr();
3776 if (ref != nullptr) {
3777 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003778 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003779 if (ref != new_ref) {
3780 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003781 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003782 }
3783 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003784 }
3785 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003786 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003787 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3788 if (register_mask & (1 << i)) {
3789 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003790 if (kIsDebugBuild && ref_addr == nullptr) {
3791 std::string thread_name;
3792 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003793 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003794 DescribeStack(GetThread());
3795 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3796 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3797 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003798 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003799 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003800 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003801 }
3802 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003803 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3804 // If this is a proxy method, visit its reference arguments.
3805 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003806 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003807 std::vector<StackReference<mirror::Object>*> ref_addrs =
3808 GetProxyReferenceArguments(cur_quick_frame);
3809 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3810 mirror::Object* ref = ref_addr->AsMirrorPtr();
3811 if (ref != nullptr) {
3812 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003813 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003814 if (ref != new_ref) {
3815 ref_addr->Assign(new_ref);
3816 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003817 }
3818 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003819 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003820 }
3821
Andreas Gampe585da952016-12-02 14:52:29 -08003822 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3823 if (kPrecise) {
3824 VisitQuickFramePrecise();
3825 } else {
3826 VisitQuickFrameNonPrecise();
3827 }
3828 }
3829
3830 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3831 struct UndefinedVRegInfo {
3832 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3833 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003834 const StackMap& map ATTRIBUTE_UNUSED,
3835 RootVisitor& _visitor)
3836 : visitor(_visitor) {
3837 }
3838
3839 ALWAYS_INLINE
3840 void VisitStack(mirror::Object** ref,
3841 size_t stack_index ATTRIBUTE_UNUSED,
3842 const StackVisitor* stack_visitor)
3843 REQUIRES_SHARED(Locks::mutator_lock_) {
3844 visitor(ref, -1, stack_visitor);
3845 }
3846
3847 ALWAYS_INLINE
3848 void VisitRegister(mirror::Object** ref,
3849 size_t register_index ATTRIBUTE_UNUSED,
3850 const StackVisitor* stack_visitor)
3851 REQUIRES_SHARED(Locks::mutator_lock_) {
3852 visitor(ref, -1, stack_visitor);
3853 }
3854
3855 RootVisitor& visitor;
3856 };
3857 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3858 }
3859
3860 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3861 struct StackMapVRegInfo {
3862 StackMapVRegInfo(ArtMethod* method,
3863 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003864 const StackMap& map,
3865 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003866 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003867 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003868 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003869 visitor(_visitor) {
3870 }
3871
3872 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3873 // lookups for each location.
3874 void FindWithType(const size_t index,
3875 const DexRegisterLocation::Kind kind,
3876 mirror::Object** ref,
3877 const StackVisitor* stack_visitor)
3878 REQUIRES_SHARED(Locks::mutator_lock_) {
3879 bool found = false;
3880 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003881 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003882 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3883 visitor(ref, dex_reg, stack_visitor);
3884 found = true;
3885 }
3886 }
3887
3888 if (!found) {
3889 // If nothing found, report with -1.
3890 visitor(ref, -1, stack_visitor);
3891 }
3892 }
3893
3894 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3895 REQUIRES_SHARED(Locks::mutator_lock_) {
3896 const size_t stack_offset = stack_index * kFrameSlotSize;
3897 FindWithType(stack_offset,
3898 DexRegisterLocation::Kind::kInStack,
3899 ref,
3900 stack_visitor);
3901 }
3902
3903 void VisitRegister(mirror::Object** ref,
3904 size_t register_index,
3905 const StackVisitor* stack_visitor)
3906 REQUIRES_SHARED(Locks::mutator_lock_) {
3907 FindWithType(register_index,
3908 DexRegisterLocation::Kind::kInRegister,
3909 ref,
3910 stack_visitor);
3911 }
3912
3913 size_t number_of_dex_registers;
3914 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003915 DexRegisterMap dex_register_map;
3916 RootVisitor& visitor;
3917 };
3918 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3919 }
3920
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003921 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003922 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003923};
3924
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003925class RootCallbackVisitor {
3926 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003927 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003928
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003929 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003930 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003931 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003932 }
3933
3934 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003935 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003936 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003937};
3938
Andreas Gampe585da952016-12-02 14:52:29 -08003939template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003940void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003941 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003942 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003943 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003944 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003945 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003946 }
Alex Light848574c2017-09-25 16:59:39 -07003947 if (tlsPtr_.async_exception != nullptr) {
3948 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3949 RootInfo(kRootNativeStack, thread_id));
3950 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003951 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003952 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3953 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003954 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003955 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003956 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003957 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003958 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003959 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003960 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003961 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003962 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3963 record != nullptr;
3964 record = record->GetLink()) {
3965 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3966 shadow_frame != nullptr;
3967 shadow_frame = shadow_frame->GetLink()) {
3968 mapper.VisitShadowFrame(shadow_frame);
3969 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003970 }
3971 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003972 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3973 record != nullptr;
3974 record = record->GetLink()) {
3975 if (record->IsReference()) {
3976 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003977 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003978 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003979 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3980 RootInfo(kRootThreadObject, thread_id));
3981 }
3982 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3983 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003984 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003985 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3986 record != nullptr;
3987 record = record->GetNext()) {
3988 mapper.VisitShadowFrame(record->GetShadowFrame());
3989 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003990 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003991 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3992 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003993 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003994 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003995 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003996 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003997 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08003998 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07003999 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004000 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004001 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004002}
4003
Andreas Gampe585da952016-12-02 14:52:29 -08004004void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4005 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004006 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004007 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004008 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004009 }
4010}
4011
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004012class VerifyRootVisitor : public SingleRootVisitor {
4013 public:
4014 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004015 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004016 VerifyObject(root);
4017 }
4018};
jeffhao25045522012-03-13 19:34:37 -07004019
Ian Rogers04d7aa92013-03-16 14:29:17 -07004020void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004021 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4022 VerifyRootVisitor visitor;
4023 std::unique_ptr<Context> context(Context::Create());
4024 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4025 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4026 mapper.WalkStack();
4027 }
jeffhao25045522012-03-13 19:34:37 -07004028}
jeffhao25045522012-03-13 19:34:37 -07004029
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004030// Set the stack end to that to be used during a stack overflow
4031void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004032 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004033 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004034 // However, we seem to have already extended to use the full stack.
4035 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004036 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004037 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004038 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004039 }
4040
Ian Rogersdd7624d2014-03-14 17:43:00 -07004041 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004042
4043 // Remove the stack overflow protection if is it set up.
4044 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4045 if (implicit_stack_check) {
4046 if (!UnprotectStack()) {
4047 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4048 }
4049 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004050}
4051
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004052void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004053 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004054 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004055 tlsPtr_.thread_local_start = start;
4056 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4057 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004058 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004059 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004060}
4061
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004062bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004063 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004064 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004065 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004066 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004067 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004068 }
4069 return has_tlab;
4070}
4071
Elliott Hughes330304d2011-08-12 14:28:05 -07004072std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004073 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004074 return os;
4075}
4076
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004077bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004078 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4079 VLOG(threads) << "Protecting stack at " << pregion;
4080 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004081 if (fatal_on_error) {
4082 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4083 "Reason: "
4084 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4085 }
4086 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004087 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004088 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004089}
4090
4091bool Thread::UnprotectStack() {
4092 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4093 VLOG(threads) << "Unprotecting stack at " << pregion;
4094 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4095}
4096
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004097void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4098 CHECK(Dbg::IsDebuggerActive());
4099 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4100 CHECK(ssc != nullptr);
4101 tlsPtr_.single_step_control = ssc;
4102}
4103
4104void Thread::DeactivateSingleStepControl() {
4105 CHECK(Dbg::IsDebuggerActive());
4106 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4107 SingleStepControl* ssc = GetSingleStepControl();
4108 tlsPtr_.single_step_control = nullptr;
4109 delete ssc;
4110}
Dave Allison648d7112014-07-25 16:15:27 -07004111
Sebastien Hertz1558b572015-02-25 15:05:59 +01004112void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4113 CHECK(Dbg::IsDebuggerActive());
4114 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4115 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4116 CHECK(req != nullptr);
4117 tlsPtr_.debug_invoke_req = req;
4118}
4119
4120void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004121 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4122 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004123 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004124 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004125 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004126}
4127
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004128void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4129 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004130 tlsPtr_.method_verifier = verifier;
4131}
4132
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004133void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004134 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004135 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004136}
4137
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004138size_t Thread::NumberOfHeldMutexes() const {
4139 size_t count = 0;
4140 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004141 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004142 }
4143 return count;
4144}
4145
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004146void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4147 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4148 ClearException();
4149 ShadowFrame* shadow_frame =
4150 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004151 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004152 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004153 DeoptimizationMethodType method_type;
4154 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004155 SetTopOfStack(nullptr);
4156 SetTopOfShadowStack(shadow_frame);
4157
4158 // Restore the exception that was pending before deoptimization then interpret the
4159 // deoptimized frames.
4160 if (pending_exception != nullptr) {
4161 SetException(pending_exception);
4162 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004163 interpreter::EnterInterpreterFromDeoptimize(this,
4164 shadow_frame,
4165 result,
4166 from_code,
4167 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004168}
4169
Alex Light848574c2017-09-25 16:59:39 -07004170void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4171 CHECK(new_exception != nullptr);
Lokesh Gidra9fd68f62018-12-21 00:33:46 +00004172 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004173 if (kIsDebugBuild) {
4174 // Make sure we are in a checkpoint.
4175 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4176 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4177 << "It doesn't look like this was called in a checkpoint! this: "
4178 << this << " count: " << GetSuspendCount();
4179 }
4180 tlsPtr_.async_exception = new_exception.Ptr();
4181}
4182
4183bool Thread::ObserveAsyncException() {
4184 DCHECK(this == Thread::Current());
4185 if (tlsPtr_.async_exception != nullptr) {
4186 if (tlsPtr_.exception != nullptr) {
4187 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4188 << tlsPtr_.exception->Dump();
4189 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4190 }
4191 tlsPtr_.exception = tlsPtr_.async_exception;
4192 tlsPtr_.async_exception = nullptr;
4193 return true;
4194 } else {
4195 return IsExceptionPending();
4196 }
4197}
4198
Mathieu Chartier0795f232016-09-27 18:43:30 -07004199void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004200 CHECK(new_exception != nullptr);
4201 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004202 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004203}
4204
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004205bool Thread::IsAotCompiler() {
4206 return Runtime::Current()->IsAotCompiler();
4207}
4208
Andreas Gampe202f85a2017-02-06 10:23:26 -08004209mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004210 DCHECK(tlsPtr_.jpeer == nullptr);
4211 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004212 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4213 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4214 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4215 // mark/forward it here.
4216 peer = art::ReadBarrier::Mark(peer);
4217 }
4218 return peer;
4219}
4220
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004221void Thread::SetReadBarrierEntrypoints() {
4222 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004223 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004224}
4225
David Srbecky912f36c2018-09-08 12:22:58 +01004226void Thread::ClearAllInterpreterCaches() {
4227 static struct ClearInterpreterCacheClosure : Closure {
4228 virtual void Run(Thread* thread) {
4229 thread->GetInterpreterCache()->Clear(thread);
4230 }
4231 } closure;
4232 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4233}
4234
Elliott Hughes8daa0922011-09-11 13:46:25 -07004235} // namespace art