blob: 27d10382b6f907538db430a863c127d6a038a8bd [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
Hans Boehm81dc7ab2019-04-19 17:34:31 -070019#include <limits.h> // for INT_MAX
Ian Rogersb033c752011-07-20 12:22:35 -070020#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070021#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080022#include <sys/resource.h>
23#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070024
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -070025#if __has_feature(hwaddress_sanitizer)
26#include <sanitizer/hwasan_interface.h>
27#else
28#define __hwasan_tag_pointer(p, t) (p)
29#endif
30
Carl Shapirob5573532011-07-12 18:22:59 -070031#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070032#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070033#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070034#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070035#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070036#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070037
Andreas Gampe43e72432019-05-14 16:15:24 -070038#include "android-base/file.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080039#include "android-base/stringprintf.h"
Evan Chengd57c51e2018-01-26 15:43:08 +080040#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080041
Mathieu Chartiera62b4532017-04-26 13:16:25 -070042#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070043#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070044#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070045#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000046#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010047#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010048#include "base/casts.h"
Andreas Gampee5d23982019-01-08 10:34:26 -080049#include "arch/context.h"
David Sehr891a50e2017-10-27 17:01:07 -070050#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070051#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080052#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070053#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070054#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080055#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070056#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080057#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010059#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070060#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080061#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080062#include "dex/dex_file-inl.h"
63#include "dex/dex_file_annotations.h"
64#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070065#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080066#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070067#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000068#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070069#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070070#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070071#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070072#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070073#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070074#include "indirect_reference_table-inl.h"
Andreas Gamped77abd92019-01-02 16:10:20 -080075#include "instrumentation.h"
Steven Morelande431e272017-07-18 16:53:49 -070076#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010077#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010078#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070079#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010080#include "jni/java_vm_ext.h"
81#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070082#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070083#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070084#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080085#include "mirror/object_array-inl.h"
86#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070087#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080088#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070089#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070090#include "nativehelper/scoped_local_ref.h"
91#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070092#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010093#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070094#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070095#include "object_lock.h"
Orion Hodson119733d2019-01-30 15:14:41 +000096#include "palette/palette.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 Munger5cc0e752018-11-09 12:30:46 -0800309 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000310 if (!is_absolute && time == 0) {
311 // Thread.getState() is documented to return waiting for untimed parks.
312 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
313 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
Charles Mungered19c672019-02-21 15:32:32 -0800314 int result = futex(tls32_.park_state_.Address(),
Charles Mungeraa31f492018-11-01 18:57:38 +0000315 FUTEX_WAIT_PRIVATE,
316 /* sleep if val = */ kNoPermitWaiterWaiting,
317 /* timeout */ nullptr,
318 nullptr,
319 0);
Charles Mungered19c672019-02-21 15:32:32 -0800320 // This errno check must happen before the scope is closed, to ensure that
321 // no destructors (such as ScopedThreadSuspension) overwrite errno.
322 if (result == -1) {
323 switch (errno) {
324 case EAGAIN:
325 FALLTHROUGH_INTENDED;
326 case EINTR: break; // park() is allowed to spuriously return
327 default: PLOG(FATAL) << "Failed to park";
328 }
329 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000330 } else if (time > 0) {
331 // Only actually suspend and futex_wait if we're going to wait for some
332 // positive amount of time - the kernel will reject negative times with
333 // EINVAL, and a zero time will just noop.
334
335 // Thread.getState() is documented to return timed wait for timed parks.
336 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
337 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
338 timespec timespec;
Charles Mungered19c672019-02-21 15:32:32 -0800339 int result = 0;
Charles Mungeraa31f492018-11-01 18:57:38 +0000340 if (is_absolute) {
341 // Time is millis when scheduled for an absolute time
342 timespec.tv_nsec = (time % 1000) * 1000000;
343 timespec.tv_sec = time / 1000;
344 // This odd looking pattern is recommended by futex documentation to
345 // wait until an absolute deadline, with otherwise identical behavior to
346 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
347 // correct time when the system clock changes.
348 result = futex(tls32_.park_state_.Address(),
349 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
350 /* sleep if val = */ kNoPermitWaiterWaiting,
351 &timespec,
352 nullptr,
353 FUTEX_BITSET_MATCH_ANY);
354 } else {
355 // Time is nanos when scheduled for a relative time
356 timespec.tv_sec = time / 1000000000;
357 timespec.tv_nsec = time % 1000000000;
358 result = futex(tls32_.park_state_.Address(),
359 FUTEX_WAIT_PRIVATE,
360 /* sleep if val = */ kNoPermitWaiterWaiting,
361 &timespec,
362 nullptr,
363 0);
364 }
Charles Mungered19c672019-02-21 15:32:32 -0800365 // This errno check must happen before the scope is closed, to ensure that
366 // no destructors (such as ScopedThreadSuspension) overwrite errno.
367 if (result == -1) {
368 switch (errno) {
369 case ETIMEDOUT:
370 timed_out = true;
371 FALLTHROUGH_INTENDED;
372 case EAGAIN:
373 case EINTR: break; // park() is allowed to spuriously return
374 default: PLOG(FATAL) << "Failed to park";
375 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000376 }
377 }
378 // Mark as no longer waiting, and consume permit if there is one.
379 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
380 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800381 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000382 } else {
383 // the fetch_add has consumed the permit. immediately return.
384 DCHECK_EQ(old_state, kPermitAvailable);
385 }
386#else
387 #pragma clang diagnostic push
388 #pragma clang diagnostic warning "-W#warnings"
389 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
390 #pragma clang diagnostic pop
391 UNUSED(is_absolute, time);
392 UNIMPLEMENTED(WARNING);
393 sched_yield();
394#endif
395}
396
397void Thread::Unpark() {
398#if ART_USE_FUTEXES
399 // Set permit available; will be consumed either by fetch_add (when the thread
400 // tries to park) or store (when the parked thread is woken up)
401 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
402 == kNoPermitWaiterWaiting) {
403 int result = futex(tls32_.park_state_.Address(),
404 FUTEX_WAKE_PRIVATE,
405 /* number of waiters = */ 1,
406 nullptr,
407 nullptr,
408 0);
409 if (result == -1) {
410 PLOG(FATAL) << "Failed to unpark";
411 }
412 }
413#else
414 UNIMPLEMENTED(WARNING);
415#endif
416}
417
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700418void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
419 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
420 sf, type, tlsPtr_.stacked_shadow_frame_record);
421 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800422}
423
Andreas Gampe639bdd12015-06-03 11:22:45 -0700424ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700425 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700426 if (must_be_present) {
427 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700428 } else {
429 if (record == nullptr || record->GetType() != type) {
430 return nullptr;
431 }
432 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700433 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
434 ShadowFrame* shadow_frame = record->GetShadowFrame();
435 delete record;
436 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700437}
438
Mingyao Yang99170c62015-07-06 11:10:37 -0700439class FrameIdToShadowFrame {
440 public:
441 static FrameIdToShadowFrame* Create(size_t frame_id,
442 ShadowFrame* shadow_frame,
443 FrameIdToShadowFrame* next,
444 size_t num_vregs) {
445 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
446 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
447 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
448 }
449
450 static void Delete(FrameIdToShadowFrame* f) {
451 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
452 delete[] memory;
453 }
454
455 size_t GetFrameId() const { return frame_id_; }
456 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
457 FrameIdToShadowFrame* GetNext() const { return next_; }
458 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
459 bool* GetUpdatedVRegFlags() {
460 return updated_vreg_flags_;
461 }
462
463 private:
464 FrameIdToShadowFrame(size_t frame_id,
465 ShadowFrame* shadow_frame,
466 FrameIdToShadowFrame* next)
467 : frame_id_(frame_id),
468 shadow_frame_(shadow_frame),
469 next_(next) {}
470
471 const size_t frame_id_;
472 ShadowFrame* const shadow_frame_;
473 FrameIdToShadowFrame* next_;
474 bool updated_vreg_flags_[0];
475
476 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
477};
478
479static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
480 size_t frame_id) {
481 FrameIdToShadowFrame* found = nullptr;
482 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
483 if (record->GetFrameId() == frame_id) {
484 if (kIsDebugBuild) {
485 // Sanity check we have at most one record for this frame.
486 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
487 found = record;
488 } else {
489 return record;
490 }
491 }
492 }
493 return found;
494}
495
496ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
497 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
498 tlsPtr_.frame_id_to_shadow_frame, frame_id);
499 if (record != nullptr) {
500 return record->GetShadowFrame();
501 }
502 return nullptr;
503}
504
505// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
506bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
507 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
508 tlsPtr_.frame_id_to_shadow_frame, frame_id);
509 CHECK(record != nullptr);
510 return record->GetUpdatedVRegFlags();
511}
512
513ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
514 uint32_t num_vregs,
515 ArtMethod* method,
516 uint32_t dex_pc) {
517 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
518 if (shadow_frame != nullptr) {
519 return shadow_frame;
520 }
David Sehr709b0702016-10-13 09:12:37 -0700521 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700522 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
523 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
524 shadow_frame,
525 tlsPtr_.frame_id_to_shadow_frame,
526 num_vregs);
527 for (uint32_t i = 0; i < num_vregs; i++) {
528 // Do this to clear all references for root visitors.
529 shadow_frame->SetVRegReference(i, nullptr);
530 // This flag will be changed to true if the debugger modifies the value.
531 record->GetUpdatedVRegFlags()[i] = false;
532 }
533 tlsPtr_.frame_id_to_shadow_frame = record;
534 return shadow_frame;
535}
536
Alex Light184f0752018-07-13 11:18:22 -0700537TLSData* Thread::GetCustomTLS(const char* key) {
538 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
539 auto it = custom_tls_.find(key);
540 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
541}
542
543void Thread::SetCustomTLS(const char* key, TLSData* data) {
544 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
545 // custom_tls_lock_.
546 std::unique_ptr<TLSData> old_data(data);
547 {
548 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
549 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
550 }
551}
552
Mingyao Yang99170c62015-07-06 11:10:37 -0700553void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
554 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
555 if (head->GetFrameId() == frame_id) {
556 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
557 FrameIdToShadowFrame::Delete(head);
558 return;
559 }
560 FrameIdToShadowFrame* prev = head;
561 for (FrameIdToShadowFrame* record = head->GetNext();
562 record != nullptr;
563 prev = record, record = record->GetNext()) {
564 if (record->GetFrameId() == frame_id) {
565 prev->SetNext(record->GetNext());
566 FrameIdToShadowFrame::Delete(record);
567 return;
568 }
569 }
570 LOG(FATAL) << "No shadow frame for frame " << frame_id;
571 UNREACHABLE();
572}
573
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700574void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700575 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700576}
577
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700578void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700579 // One thread (us) survived the fork, but we have a new tid so we need to
580 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700581 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700582}
583
Brian Carlstrom78128a62011-09-15 17:21:19 -0700584void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700585 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700586 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800587 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700588 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800589 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700590 }
591 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700592 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
593 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800594 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700595 // Check that if we got here we cannot be shutting down (as shutdown should never have started
596 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700597 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700598 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
599 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
600 // the runtime in such a case. In case this ever changes, we need to make sure here to
601 // delete the tmp_jni_env, as we own it at this point.
602 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
603 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700604 Runtime::Current()->EndThreadBirth();
605 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700606 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700607 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800608 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800609
610 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700611 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700612 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700613 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
614 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800615 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100616
Andreas Gampe08883de2016-11-08 13:20:52 -0800617 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100618 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000619
Andreas Gampeac30fa22017-01-18 21:02:36 -0800620 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700621
Charles Mungeraa31f492018-11-01 18:57:38 +0000622 // Unpark ourselves if the java peer was unparked before it started (see
623 // b/28845097#comment49 for more information)
624
625 ArtField* unparkedField = jni::DecodeArtField(
626 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
627 bool should_unpark = false;
628 {
629 // Hold the lock here, so that if another thread calls unpark before the thread starts
630 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
631 // which could cause a lost unpark.
632 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
633 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
634 }
635 if (should_unpark) {
636 self->Unpark();
637 }
Ian Rogers365c1022012-06-22 15:05:28 -0700638 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800639 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700640 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700641 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
642 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700643 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700644 // Detach and delete self.
645 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700646
Dave Allison0aded082013-11-07 13:15:11 -0800647 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700648}
649
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700650Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800651 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800652 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100653 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700654 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
655 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700656 if (kIsDebugBuild) {
657 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800658 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700659 Locks::thread_list_lock_->AssertHeld(soa.Self());
660 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700661 }
662 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800663}
664
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700665Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
666 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100667 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700668}
669
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700670static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700671 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700672 if (stack_size == 0) {
673 stack_size = Runtime::Current()->GetDefaultStackSize();
674 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700675
Brian Carlstrom6414a972012-04-14 14:20:04 -0700676 // Dalvik used the bionic pthread default stack size for native threads,
677 // so include that here to support apps that expect large native stacks.
678 stack_size += 1 * MB;
679
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700680 // Under sanitization, frames of the interpreter may become bigger, both for C code as
681 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
682 // of all core classes cannot be done in all test circumstances.
683 if (kMemoryToolIsAvailable) {
684 stack_size = std::max(2 * MB, stack_size);
685 }
686
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700687 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
688 if (stack_size < PTHREAD_STACK_MIN) {
689 stack_size = PTHREAD_STACK_MIN;
690 }
691
Dave Allisonf9439142014-03-27 15:10:22 -0700692 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
693 // It's likely that callers are trying to ensure they have at least a certain amount of
694 // stack space, so we should add our reserved space on top of what they requested, rather
695 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700696 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700697 } else {
698 // If we are going to use implicit stack checks, allocate space for the protected
699 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000700 stack_size += Thread::kStackOverflowImplicitCheckSize +
701 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700702 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700703
704 // Some systems require the stack size to be a multiple of the system page size, so round up.
705 stack_size = RoundUp(stack_size, kPageSize);
706
707 return stack_size;
708}
709
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700710// Return the nearest page-aligned address below the current stack top.
711NO_INLINE
712static uint8_t* FindStackTop() {
713 return reinterpret_cast<uint8_t*>(
714 AlignDown(__builtin_frame_address(0), kPageSize));
715}
716
Dave Allisonf9439142014-03-27 15:10:22 -0700717// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700718// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700719ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700720void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700721 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700722 // Page containing current top of stack.
723 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700724
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700725 // Try to directly protect the stack.
726 VLOG(threads) << "installing stack protected region at " << std::hex <<
727 static_cast<void*>(pregion) << " to " <<
728 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700729 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700730 // Tell the kernel that we won't be needing these pages any more.
731 // NB. madvise will probably write zeroes into the memory (on linux it does).
732 uint32_t unwanted_size = stack_top - pregion - kPageSize;
733 madvise(pregion, unwanted_size, MADV_DONTNEED);
734 return;
735 }
736
737 // There is a little complexity here that deserves a special mention. On some
738 // architectures, the stack is created using a VM_GROWSDOWN flag
739 // to prevent memory being allocated when it's not needed. This flag makes the
740 // kernel only allocate memory for the stack by growing down in memory. Because we
741 // want to put an mprotected region far away from that at the stack top, we need
742 // to make sure the pages for the stack are mapped in before we call mprotect.
743 //
744 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
745 // with a non-mapped stack (usually only the main thread).
746 //
747 // We map in the stack by reading every page from the stack bottom (highest address)
748 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700749 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700750 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700751 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
752 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
753 // thus have to move the stack pointer. We do this portably by using a recursive function with a
754 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700755
Andreas Gampe6c63f862017-06-28 17:20:15 -0700756 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700757 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700758 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000759
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700760 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
761 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000762
Andreas Gampe6c63f862017-06-28 17:20:15 -0700763 struct RecurseDownStack {
764 // This function has an intentionally large stack size.
765#pragma GCC diagnostic push
766#pragma GCC diagnostic ignored "-Wframe-larger-than="
767 NO_INLINE
768 static void Touch(uintptr_t target) {
769 volatile size_t zero = 0;
770 // Use a large local volatile array to ensure a large frame size. Do not use anything close
771 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
772 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700773 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
774 constexpr size_t kAsanMultiplier =
775#ifdef ADDRESS_SANITIZER
776 2u;
777#else
778 1u;
779#endif
780 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700781 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700782 // Remove tag from the pointer. Nop in non-hwasan builds.
783 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
784 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700785 Touch(target);
786 }
787 zero *= 2; // Try to avoid tail recursion.
788 }
789#pragma GCC diagnostic pop
790 };
791 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000792
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700793 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700794 static_cast<void*>(pregion) << " to " <<
795 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
796
Dave Allison648d7112014-07-25 16:15:27 -0700797 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700798 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700799
800 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000801 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700802 uint32_t unwanted_size = stack_top - pregion - kPageSize;
803 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700804}
805
Ian Rogers120f1c72012-09-28 17:17:10 -0700806void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800807 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800808 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700809
810 if (VLOG_IS_ON(threads)) {
811 ScopedObjectAccess soa(env);
812
Andreas Gampe08883de2016-11-08 13:20:52 -0800813 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700814 ObjPtr<mirror::String> java_name =
815 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700816 std::string thread_name;
817 if (java_name != nullptr) {
818 thread_name = java_name->ToModifiedUtf8();
819 } else {
820 thread_name = "(Unnamed)";
821 }
822
823 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700824 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700825 }
826
Ian Rogers120f1c72012-09-28 17:17:10 -0700827 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700828
Ian Rogers120f1c72012-09-28 17:17:10 -0700829 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
830 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700831 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700832 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700833 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700834 thread_start_during_shutdown = true;
835 } else {
836 runtime->StartThreadBirth();
837 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700838 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700839 if (thread_start_during_shutdown) {
840 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
841 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
842 return;
843 }
844
845 Thread* child_thread = new Thread(is_daemon);
846 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700847 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700848 stack_size = FixStackSize(stack_size);
849
Roland Levillain2ae376f2018-01-30 11:35:11 +0000850 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
851 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800852 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
853 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700854
Andreas Gampe449357d2015-06-01 22:29:51 -0700855 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
856 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100857 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700858 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100859 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700860
Andreas Gampe449357d2015-06-01 22:29:51 -0700861 int pthread_create_result = 0;
862 if (child_jni_env_ext.get() != nullptr) {
863 pthread_t new_pthread;
864 pthread_attr_t attr;
865 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
866 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
867 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
868 "PTHREAD_CREATE_DETACHED");
869 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
870 pthread_create_result = pthread_create(&new_pthread,
871 &attr,
872 Thread::CreateCallback,
873 child_thread);
874 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
875
876 if (pthread_create_result == 0) {
877 // pthread_create started the new thread. The child is now responsible for managing the
878 // JNIEnvExt we created.
879 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
880 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700881 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700882 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700883 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700884 }
885
886 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
887 {
888 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
889 runtime->EndThreadBirth();
890 }
891 // Manually delete the global reference since Thread::Init will not have been run.
892 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
893 child_thread->tlsPtr_.jpeer = nullptr;
894 delete child_thread;
895 child_thread = nullptr;
896 // TODO: remove from thread group?
897 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
898 {
899 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100900 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700901 StringPrintf("pthread_create (%s stack) failed: %s",
902 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
903 ScopedObjectAccess soa(env);
904 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700905 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700906}
907
Andreas Gampe449357d2015-06-01 22:29:51 -0700908bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700909 // This function does all the initialization that must be run by the native thread it applies to.
910 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
911 // we can handshake with the corresponding native thread when it's ready.) Check this native
912 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800913 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800914
915 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
916 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
917 tlsPtr_.pthread_self = pthread_self();
918 CHECK(is_started_);
919
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800920 ScopedTrace trace("Thread::Init");
921
Elliott Hughesd8af1592012-04-16 20:40:15 -0700922 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800923 if (!InitStackHwm()) {
924 return false;
925 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700926 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700927 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800928 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700929 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700930 InitTid();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800931 {
932 ScopedTrace trace2("InitInterpreterTls");
933 interpreter::InitInterpreterTls(this);
934 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800935
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100936#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000937 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
938#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700939 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000940#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700941 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700942
Ian Rogersdd7624d2014-03-14 17:43:00 -0700943 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700944
Andreas Gampe449357d2015-06-01 22:29:51 -0700945 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800946 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
947 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700948 tlsPtr_.jni_env = jni_env_ext;
949 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100950 std::string error_msg;
951 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700952 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100953 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700954 return false;
955 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700956 }
957
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800958 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700959 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800960 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700961}
962
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800963template <typename PeerAction>
964Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700965 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800966 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800967 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900968 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
969 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800970 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700971 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800972 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700973 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800974 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800975 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700976 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900977 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
978 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800979 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700980 } else {
981 Runtime::Current()->StartThreadBirth();
982 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800983 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700984 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800985 if (!init_success) {
986 delete self;
987 return nullptr;
988 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700989 }
990 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700991
Jeff Hao848f70a2014-01-15 13:49:50 -0800992 self->InitStringEntryPoints();
993
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700994 CHECK_NE(self->GetState(), kRunnable);
995 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700996
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800997 // Run the action that is acting on the peer.
998 if (!peer_action(self)) {
999 runtime->GetThreadList()->Unregister(self);
1000 // Unregister deletes self, no need to do this here.
1001 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001002 }
Elliott Hughescac6cc72011-11-03 20:31:21 -07001003
Andreas Gampe56623832015-07-09 21:53:15 -07001004 if (VLOG_IS_ON(threads)) {
1005 if (thread_name != nullptr) {
1006 VLOG(threads) << "Attaching thread " << thread_name;
1007 } else {
1008 VLOG(threads) << "Attaching unnamed thread.";
1009 }
1010 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001011 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001012 }
1013
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001014 {
1015 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001016 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001017 }
1018
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001019 return self;
1020}
1021
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001022Thread* Thread::Attach(const char* thread_name,
1023 bool as_daemon,
1024 jobject thread_group,
1025 bool create_peer) {
1026 auto create_peer_action = [&](Thread* self) {
1027 // If we're the main thread, ClassLinker won't be created until after we're attached,
1028 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1029 // In the compiler, all threads need this hack, because no-one's going to be getting
1030 // a native peer!
1031 if (create_peer) {
1032 self->CreatePeer(thread_name, as_daemon, thread_group);
1033 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001034 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1035 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001036 {
1037 ScopedObjectAccess soa(self);
1038 LOG(ERROR) << "Exception creating thread peer:";
1039 LOG(ERROR) << self->GetException()->Dump();
1040 self->ClearException();
1041 }
1042 return false;
1043 }
1044 } else {
1045 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1046 if (thread_name != nullptr) {
1047 self->tlsPtr_.name->assign(thread_name);
1048 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001049 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001050 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1051 }
1052 }
1053 return true;
1054 };
1055 return Attach(thread_name, as_daemon, create_peer_action);
1056}
1057
1058Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1059 auto set_peer_action = [&](Thread* self) {
1060 // Install the given peer.
1061 {
1062 DCHECK(self == Thread::Current());
1063 ScopedObjectAccess soa(self);
1064 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1065 }
1066 self->GetJniEnv()->SetLongField(thread_peer,
1067 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001068 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001069 return true;
1070 };
1071 return Attach(thread_name, as_daemon, set_peer_action);
1072}
1073
Ian Rogers365c1022012-06-22 15:05:28 -07001074void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1075 Runtime* runtime = Runtime::Current();
1076 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001077 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001078
Dave Allison0aded082013-11-07 13:15:11 -08001079 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001080 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001081 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001082 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001083 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001084 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001085 CHECK(IsExceptionPending());
1086 return;
1087 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001088 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001089 jboolean thread_is_daemon = as_daemon;
1090
Elliott Hugheseac76672012-05-24 21:56:51 -07001091 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001092 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001093 CHECK(IsExceptionPending());
1094 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001095 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001096 {
1097 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001098 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001099 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001100 env->CallNonvirtualVoidMethod(peer.get(),
1101 WellKnownClasses::java_lang_Thread,
1102 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001103 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001104 if (IsExceptionPending()) {
1105 return;
1106 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001107
Ian Rogers120f1c72012-09-28 17:17:10 -07001108 Thread* self = this;
1109 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001110 env->SetLongField(peer.get(),
1111 WellKnownClasses::java_lang_Thread_nativePeer,
1112 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001113
1114 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001115 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001116 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001117 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001118 // The Thread constructor should have set the Thread.name to a
1119 // non-null value. However, because we can run without code
1120 // available (in the compiler, in tests), we manually assign the
1121 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001122 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001123 InitPeer<true>(soa,
1124 tlsPtr_.opeer,
1125 thread_is_daemon,
1126 thread_group,
1127 thread_name.get(),
1128 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001129 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001130 InitPeer<false>(soa,
1131 tlsPtr_.opeer,
1132 thread_is_daemon,
1133 thread_group,
1134 thread_name.get(),
1135 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001136 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001137 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001138 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001139 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001140 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001141 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001142 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001143}
1144
Andreas Gampebad529d2017-02-13 18:52:10 -08001145jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1146 const char* name,
1147 bool as_daemon,
1148 jobject thread_group) {
1149 Runtime* runtime = Runtime::Current();
1150 CHECK(!runtime->IsStarted());
1151
1152 if (thread_group == nullptr) {
1153 thread_group = runtime->GetMainThreadGroup();
1154 }
1155 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1156 // Add missing null check in case of OOM b/18297817
1157 if (name != nullptr && thread_name.get() == nullptr) {
1158 CHECK(Thread::Current()->IsExceptionPending());
1159 return nullptr;
1160 }
Andreas Gampea1e5b972019-03-18 16:54:25 -07001161 jint thread_priority = kNormThreadPriority; // Always normalize to NORM priority.
Andreas Gampebad529d2017-02-13 18:52:10 -08001162 jboolean thread_is_daemon = as_daemon;
1163
1164 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1165 if (peer.get() == nullptr) {
1166 CHECK(Thread::Current()->IsExceptionPending());
1167 return nullptr;
1168 }
1169
1170 // We cannot call Thread.init, as it will recursively ask for currentThread.
1171
1172 // The Thread constructor should have set the Thread.name to a
1173 // non-null value. However, because we can run without code
1174 // available (in the compiler, in tests), we manually assign the
1175 // fields the constructor should have set.
1176 ScopedObjectAccessUnchecked soa(Thread::Current());
1177 if (runtime->IsActiveTransaction()) {
1178 InitPeer<true>(soa,
1179 soa.Decode<mirror::Object>(peer.get()),
1180 thread_is_daemon,
1181 thread_group,
1182 thread_name.get(),
1183 thread_priority);
1184 } else {
1185 InitPeer<false>(soa,
1186 soa.Decode<mirror::Object>(peer.get()),
1187 thread_is_daemon,
1188 thread_group,
1189 thread_name.get(),
1190 thread_priority);
1191 }
1192
1193 return peer.release();
1194}
1195
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001196template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001197void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1198 ObjPtr<mirror::Object> peer,
1199 jboolean thread_is_daemon,
1200 jobject thread_group,
1201 jobject thread_name,
1202 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001203 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001204 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001205 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001206 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001207 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001208 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001209 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001210 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001211}
1212
Elliott Hughes899e7892012-01-24 14:57:32 -08001213void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001214 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001215 ::art::SetThreadName(name);
1216 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1217}
1218
Andreas Gampe9186ced2016-12-12 14:28:21 -08001219static void GetThreadStack(pthread_t thread,
1220 void** stack_base,
1221 size_t* stack_size,
1222 size_t* guard_size) {
1223#if defined(__APPLE__)
1224 *stack_size = pthread_get_stacksize_np(thread);
1225 void* stack_addr = pthread_get_stackaddr_np(thread);
1226
1227 // Check whether stack_addr is the base or end of the stack.
1228 // (On Mac OS 10.7, it's the end.)
1229 int stack_variable;
1230 if (stack_addr > &stack_variable) {
1231 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1232 } else {
1233 *stack_base = stack_addr;
1234 }
1235
1236 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1237 pthread_attr_t attributes;
1238 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1239 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1240 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1241#else
1242 pthread_attr_t attributes;
1243 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1244 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1245 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1246 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1247
1248#if defined(__GLIBC__)
1249 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1250 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1251 // will be broken because we'll die long before we get close to 2GB.
1252 bool is_main_thread = (::art::GetTid() == getpid());
1253 if (is_main_thread) {
1254 rlimit stack_limit;
1255 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1256 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1257 }
1258 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1259 size_t old_stack_size = *stack_size;
1260
1261 // Use the kernel default limit as our size, and adjust the base to match.
1262 *stack_size = 8 * MB;
1263 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1264
1265 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1266 << " to " << PrettySize(*stack_size)
1267 << " with base " << *stack_base;
1268 }
1269 }
1270#endif
1271
1272#endif
1273}
1274
Ian Rogersf4d4da12014-11-11 16:10:33 -08001275bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001276 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001277 void* read_stack_base;
1278 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001279 size_t read_guard_size;
1280 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001281
Ian Rogers13735952014-10-08 12:43:28 -07001282 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001283 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001284
Dave Allison648d7112014-07-25 16:15:27 -07001285 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1286 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1287 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1288 // between 8K and 12K.
1289 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1290 + 4 * KB;
1291 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001292 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001293 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1294 __LINE__,
1295 ::android::base::ERROR,
1296 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001297 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001298 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001299
Vladimir Markob8f2f632015-01-02 14:23:26 +00001300 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1301 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1302 read_stack_base,
1303 PrettySize(read_stack_size).c_str(),
1304 PrettySize(read_guard_size).c_str());
1305
Ian Rogers932746a2011-09-22 18:57:50 -07001306 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001307
1308 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001309 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001310
Dave Allisonb090a182014-08-14 17:02:48 +00001311 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001312
1313 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001314 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001315 // The thread might have protected region at the bottom. We need
1316 // to install our own region so we need to move the limits
1317 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001318
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001319 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1320 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1321 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001322
1323 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001324 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001325
1326 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001327 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001328
1329 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001330}
1331
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001332void Thread::ShortDump(std::ostream& os) const {
1333 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001334 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001335 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001336 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001337 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001338 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001339 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001340 << ",Thread*=" << this
1341 << ",peer=" << tlsPtr_.opeer
1342 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1343 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001344}
1345
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001346void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1347 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001348 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001349 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001350}
1351
Vladimir Marko4617d582019-03-28 13:48:31 +00001352ObjPtr<mirror::String> Thread::GetThreadName() const {
Andreas Gampe08883de2016-11-08 13:20:52 -08001353 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001354 if (tlsPtr_.opeer == nullptr) {
1355 return nullptr;
1356 }
1357 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1358 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001359}
1360
Elliott Hughesffb465f2012-03-01 18:46:05 -08001361void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001362 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001363}
1364
Jeff Hao57dac6e2013-08-15 16:36:24 -07001365uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001366#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001367 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001368 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001369 timespec now;
1370 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001371 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001372#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001373 UNIMPLEMENTED(WARNING);
1374 return -1;
1375#endif
1376}
1377
Ian Rogers01ae5802012-09-28 16:14:01 -07001378// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1379static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001380 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001381 Locks::thread_suspend_count_lock_->Unlock(self);
1382 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1383 Locks::mutator_lock_->SharedTryLock(self);
1384 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1385 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1386 }
1387 }
1388 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1389 Locks::thread_list_lock_->TryLock(self);
1390 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1391 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1392 }
1393 }
1394 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001395 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001396 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001397}
1398
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001399bool Thread::ModifySuspendCountInternal(Thread* self,
1400 int delta,
1401 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001402 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001403 if (kIsDebugBuild) {
1404 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001405 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001406 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1407 Locks::thread_suspend_count_lock_->AssertHeld(self);
1408 if (this != self && !IsSuspended()) {
1409 Locks::thread_list_lock_->AssertHeld(self);
1410 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001411 }
Alex Light88fd7202017-06-30 08:31:59 -07001412 // User code suspensions need to be checked more closely since they originate from code outside of
1413 // the runtime's control.
1414 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1415 Locks::user_code_suspension_lock_->AssertHeld(self);
1416 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1417 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1418 return false;
1419 }
1420 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001421 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001422 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001423 return false;
1424 }
1425
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001426 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1427 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1428 // deadlock. b/31683379.
1429 return false;
1430 }
1431
Yu Lieac44242015-06-29 10:50:03 +08001432 uint16_t flags = kSuspendRequest;
1433 if (delta > 0 && suspend_barrier != nullptr) {
1434 uint32_t available_barrier = kMaxSuspendBarriers;
1435 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1436 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1437 available_barrier = i;
1438 break;
1439 }
1440 }
1441 if (available_barrier == kMaxSuspendBarriers) {
1442 // No barrier spaces available, we can't add another.
1443 return false;
1444 }
1445 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1446 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001447 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001448
Ian Rogersdd7624d2014-03-14 17:43:00 -07001449 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001450 switch (reason) {
1451 case SuspendReason::kForDebugger:
1452 tls32_.debug_suspend_count += delta;
1453 break;
Alex Light88fd7202017-06-30 08:31:59 -07001454 case SuspendReason::kForUserCode:
1455 tls32_.user_code_suspend_count += delta;
1456 break;
Alex Light46f93402017-06-29 11:59:50 -07001457 case SuspendReason::kInternal:
1458 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001459 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001460
Ian Rogersdd7624d2014-03-14 17:43:00 -07001461 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001462 AtomicClearFlag(kSuspendRequest);
1463 } else {
Yu Lieac44242015-06-29 10:50:03 +08001464 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001465 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001466 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001467 }
Yu Lieac44242015-06-29 10:50:03 +08001468 return true;
1469}
1470
1471bool Thread::PassActiveSuspendBarriers(Thread* self) {
1472 // Grab the suspend_count lock and copy the current set of
1473 // barriers. Then clear the list and the flag. The ModifySuspendCount
1474 // function requires the lock so we prevent a race between setting
1475 // the kActiveSuspendBarrier flag and clearing it.
1476 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1477 {
1478 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1479 if (!ReadFlag(kActiveSuspendBarrier)) {
1480 // quick exit test: the barriers have already been claimed - this is
1481 // possible as there may be a race to claim and it doesn't matter
1482 // who wins.
1483 // All of the callers of this function (except the SuspendAllInternal)
1484 // will first test the kActiveSuspendBarrier flag without lock. Here
1485 // double-check whether the barrier has been passed with the
1486 // suspend_count lock.
1487 return false;
1488 }
1489
1490 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1491 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1492 tlsPtr_.active_suspend_barriers[i] = nullptr;
1493 }
1494 AtomicClearFlag(kActiveSuspendBarrier);
1495 }
1496
1497 uint32_t barrier_count = 0;
1498 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1499 AtomicInteger* pending_threads = pass_barriers[i];
1500 if (pending_threads != nullptr) {
1501 bool done = false;
1502 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001503 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001504 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1505 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001506 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001507#if ART_USE_FUTEXES
1508 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Hans Boehm81dc7ab2019-04-19 17:34:31 -07001509 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, INT_MAX, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001510 }
1511#endif
1512 } while (!done);
1513 ++barrier_count;
1514 }
1515 }
1516 CHECK_GT(barrier_count, 0U);
1517 return true;
1518}
1519
1520void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1521 CHECK(ReadFlag(kActiveSuspendBarrier));
1522 bool clear_flag = true;
1523 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1524 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1525 if (ptr == target) {
1526 tlsPtr_.active_suspend_barriers[i] = nullptr;
1527 } else if (ptr != nullptr) {
1528 clear_flag = false;
1529 }
1530 }
1531 if (LIKELY(clear_flag)) {
1532 AtomicClearFlag(kActiveSuspendBarrier);
1533 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001534}
1535
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001536void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001537 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1538 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1539 Closure* checkpoint;
1540 {
1541 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1542 checkpoint = tlsPtr_.checkpoint_function;
1543 if (!checkpoint_overflow_.empty()) {
1544 // Overflow list not empty, copy the first one out and continue.
1545 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1546 checkpoint_overflow_.pop_front();
1547 } else {
1548 // No overflow checkpoints. Clear the kCheckpointRequest flag
1549 tlsPtr_.checkpoint_function = nullptr;
1550 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001551 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001552 }
1553 // Outside the lock, run the checkpoint function.
1554 ScopedTrace trace("Run checkpoint function");
1555 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1556 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001557}
1558
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001559void Thread::RunEmptyCheckpoint() {
1560 DCHECK_EQ(Thread::Current(), this);
1561 AtomicClearFlag(kEmptyCheckpointRequest);
1562 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1563}
1564
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001565bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001566 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001567 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001568 if (old_state_and_flags.as_struct.state != kRunnable) {
1569 return false; // Fail, thread is suspended and so can't run a checkpoint.
1570 }
Dave Allison0aded082013-11-07 13:15:11 -08001571
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001572 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001573 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001574 union StateAndFlags new_state_and_flags;
1575 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001576 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001577 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001578 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001579 if (success) {
1580 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1581 if (tlsPtr_.checkpoint_function == nullptr) {
1582 tlsPtr_.checkpoint_function = function;
1583 } else {
1584 checkpoint_overflow_.push_back(function);
1585 }
Dave Allison0aded082013-11-07 13:15:11 -08001586 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001587 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001588 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001589 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001590}
1591
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001592bool Thread::RequestEmptyCheckpoint() {
1593 union StateAndFlags old_state_and_flags;
1594 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1595 if (old_state_and_flags.as_struct.state != kRunnable) {
1596 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1597 // heap access (eg. the read barrier).
1598 return false;
1599 }
1600
1601 // We must be runnable to request a checkpoint.
1602 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1603 union StateAndFlags new_state_and_flags;
1604 new_state_and_flags.as_int = old_state_and_flags.as_int;
1605 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001606 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001607 old_state_and_flags.as_int, new_state_and_flags.as_int);
1608 if (success) {
1609 TriggerSuspend();
1610 }
1611 return success;
1612}
1613
Andreas Gampee9f67122016-10-27 19:21:23 -07001614class BarrierClosure : public Closure {
1615 public:
1616 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1617
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001618 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001619 wrapped_->Run(self);
1620 barrier_.Pass(self);
1621 }
1622
Alex Light318afe62018-03-22 16:50:10 -07001623 void Wait(Thread* self, ThreadState suspend_state) {
1624 if (suspend_state != ThreadState::kRunnable) {
1625 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1626 } else {
1627 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1628 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001629 }
1630
1631 private:
1632 Closure* wrapped_;
1633 Barrier barrier_;
1634};
1635
Alex Lightb1e31a82017-10-04 16:57:36 -07001636// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001637bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001638 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001639 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001640 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1641 // Unlock the tll before running so that the state is the same regardless of thread.
1642 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001643 // Asked to run on this thread. Just run.
1644 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001645 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001646 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001647
1648 // The current thread is not this thread.
1649
Andreas Gampe28c4a232017-06-21 21:21:31 -07001650 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001651 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001652 return false;
1653 }
1654
Andreas Gampe28c4a232017-06-21 21:21:31 -07001655 struct ScopedThreadListLockUnlock {
1656 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1657 : self_thread(self_in) {
1658 Locks::thread_list_lock_->AssertHeld(self_thread);
1659 Locks::thread_list_lock_->Unlock(self_thread);
1660 }
1661
1662 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1663 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1664 Locks::thread_list_lock_->Lock(self_thread);
1665 }
1666
1667 Thread* self_thread;
1668 };
1669
Andreas Gampee9f67122016-10-27 19:21:23 -07001670 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001671 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001672 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1673 // suspend-count lock for too long.
1674 if (GetState() == ThreadState::kRunnable) {
1675 BarrierClosure barrier_closure(function);
1676 bool installed = false;
1677 {
1678 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1679 installed = RequestCheckpoint(&barrier_closure);
1680 }
1681 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001682 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1683 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1684 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001685 ScopedThreadStateChange sts(self, suspend_state);
1686 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001687 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001688 }
1689 // Fall-through.
1690 }
1691
1692 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1693 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1694 // certain situations.
1695 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001696 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1697
Alex Light46f93402017-06-29 11:59:50 -07001698 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001699 // Just retry the loop.
1700 sched_yield();
1701 continue;
1702 }
1703 }
1704
Andreas Gampe28c4a232017-06-21 21:21:31 -07001705 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001706 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1707 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001708 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001709 {
Alex Light318afe62018-03-22 16:50:10 -07001710 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001711 while (GetState() == ThreadState::kRunnable) {
1712 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1713 // moves us to suspended.
1714 sched_yield();
1715 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001716 }
1717
1718 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001719 }
1720
Andreas Gampee9f67122016-10-27 19:21:23 -07001721 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001722 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1723
1724 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001725 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001726 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001727 }
1728
Andreas Gampe117f9b32017-06-23 13:33:50 -07001729 {
1730 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1731 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1732 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1733 Thread::resume_cond_->Broadcast(self);
1734 }
1735
Alex Lightb1e31a82017-10-04 16:57:36 -07001736 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1737 Locks::thread_list_lock_->ExclusiveUnlock(self);
1738
Andreas Gampe28c4a232017-06-21 21:21:31 -07001739 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001740 }
1741}
1742
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001743Closure* Thread::GetFlipFunction() {
1744 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1745 Closure* func;
1746 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001747 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001748 if (func == nullptr) {
1749 return nullptr;
1750 }
Orion Hodson4557b382018-01-03 11:47:54 +00001751 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001752 DCHECK(func != nullptr);
1753 return func;
1754}
1755
1756void Thread::SetFlipFunction(Closure* function) {
1757 CHECK(function != nullptr);
1758 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001759 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001760}
1761
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001762void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001763 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001764 VLOG(threads) << this << " self-suspending";
1765 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001766 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001767 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001768 VLOG(threads) << this << " self-reviving";
1769}
1770
Andreas Gampe9186ced2016-12-12 14:28:21 -08001771static std::string GetSchedulerGroupName(pid_t tid) {
1772 // /proc/<pid>/cgroup looks like this:
1773 // 2:devices:/
1774 // 1:cpuacct,cpu:/
1775 // We want the third field from the line whose second field contains the "cpu" token.
1776 std::string cgroup_file;
Andreas Gampe43e72432019-05-14 16:15:24 -07001777 if (!android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid),
1778 &cgroup_file)) {
Andreas Gampe9186ced2016-12-12 14:28:21 -08001779 return "";
1780 }
1781 std::vector<std::string> cgroup_lines;
1782 Split(cgroup_file, '\n', &cgroup_lines);
1783 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1784 std::vector<std::string> cgroup_fields;
1785 Split(cgroup_lines[i], ':', &cgroup_fields);
1786 std::vector<std::string> cgroups;
1787 Split(cgroup_fields[1], ',', &cgroups);
1788 for (size_t j = 0; j < cgroups.size(); ++j) {
1789 if (cgroups[j] == "cpu") {
1790 return cgroup_fields[2].substr(1); // Skip the leading slash.
1791 }
1792 }
1793 }
1794 return "";
1795}
1796
1797
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001798void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001799 std::string group_name;
1800 int priority;
1801 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001802 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001803
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001804 // If flip_function is not null, it means we have run a checkpoint
1805 // before the thread wakes up to execute the flip function and the
1806 // thread roots haven't been forwarded. So the following access to
1807 // the roots (opeer or methods in the frames) would be bad. Run it
1808 // here. TODO: clean up.
1809 if (thread != nullptr) {
1810 ScopedObjectAccessUnchecked soa(self);
1811 Thread* this_thread = const_cast<Thread*>(thread);
1812 Closure* flip_func = this_thread->GetFlipFunction();
1813 if (flip_func != nullptr) {
1814 flip_func->Run(this_thread);
1815 }
1816 }
1817
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001818 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1819 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001820 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001821 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001822 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001823 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001824 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001825 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001826
Mathieu Chartier3398c782016-09-30 10:27:43 -07001827 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001828 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1829 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001830
Dave Allison0aded082013-11-07 13:15:11 -08001831 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001832 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001833 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001834 ObjPtr<mirror::String> group_name_string =
1835 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001836 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001837 }
1838 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001839 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001840 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001841
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001842 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001843 if (scheduler_group_name.empty()) {
1844 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001845 }
1846
Dave Allison0aded082013-11-07 13:15:11 -08001847 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001848 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001849 if (is_daemon) {
1850 os << " daemon";
1851 }
1852 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001853 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001854 << " " << thread->GetState();
1855 if (thread->IsStillStarting()) {
1856 os << " (still starting up)";
1857 }
1858 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001859 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001860 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001861 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001862 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001863 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001864
Dave Allison0aded082013-11-07 13:15:11 -08001865 if (thread != nullptr) {
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001866 auto suspend_log_fn = [&]() REQUIRES(Locks::thread_suspend_count_lock_) {
1867 os << " | group=\"" << group_name << "\""
1868 << " sCount=" << thread->tls32_.suspend_count
1869 << " dsCount=" << thread->tls32_.debug_suspend_count
1870 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
1871 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
1872 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1873 };
1874 if (Locks::thread_suspend_count_lock_->IsExclusiveHeld(self)) {
1875 Locks::thread_suspend_count_lock_->AssertExclusiveHeld(self); // For annotalysis.
1876 suspend_log_fn();
1877 } else {
1878 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1879 suspend_log_fn();
1880 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001881 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001882
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001883 os << " | sysTid=" << tid
1884 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001885 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001886 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001887 int policy;
1888 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001889#if !defined(__APPLE__)
1890 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1891 policy = sched_getscheduler(tid);
1892 if (policy == -1) {
1893 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1894 }
1895 int sched_getparam_result = sched_getparam(tid, &sp);
1896 if (sched_getparam_result == -1) {
1897 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1898 sp.sched_priority = -1;
1899 }
1900#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001901 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1902 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001903#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001904 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001905 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001906 }
1907 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001908
1909 // Grab the scheduler stats for this thread.
1910 std::string scheduler_stats;
Andreas Gampe43e72432019-05-14 16:15:24 -07001911 if (android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid),
1912 &scheduler_stats)
Evan Chengd57c51e2018-01-26 15:43:08 +08001913 && !scheduler_stats.empty()) {
1914 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001915 } else {
1916 scheduler_stats = "0 0 0";
1917 }
1918
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001919 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001920 int utime = 0;
1921 int stime = 0;
1922 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001923 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001924
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001925 os << " | state=" << native_thread_state
1926 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001927 << " utm=" << utime
1928 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001929 << " core=" << task_cpu
1930 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001931 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001932 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1933 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1934 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001935 // Dump the held mutexes.
1936 os << " | held mutexes=";
1937 for (size_t i = 0; i < kLockLevelCount; ++i) {
1938 if (i != kMonitorLock) {
1939 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1940 if (mutex != nullptr) {
1941 os << " \"" << mutex->GetName() << "\"";
1942 if (mutex->IsReaderWriterMutex()) {
1943 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001944 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001945 os << "(exclusive held)";
1946 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001947 os << "(shared held)";
1948 }
1949 }
1950 }
1951 }
1952 }
1953 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001954 }
1955}
1956
1957void Thread::DumpState(std::ostream& os) const {
1958 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001959}
1960
Andreas Gampe93104952017-12-13 17:13:15 -08001961struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001962 StackDumpVisitor(std::ostream& os_in,
1963 Thread* thread_in,
1964 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001965 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001966 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001967 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001968 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001969 : MonitorObjectsStackVisitor(thread_in,
1970 context,
1971 check_suspended,
1972 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001973 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001974 last_method(nullptr),
1975 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001976 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001977
Ian Rogersbdb03912011-09-14 00:55:44 -07001978 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001979 if (frame_count == 0) {
1980 os << " (no managed stack frames)\n";
1981 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001982 }
1983
Andreas Gampe93104952017-12-13 17:13:15 -08001984 static constexpr size_t kMaxRepetition = 3u;
1985
1986 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001987 override
Andreas Gampe93104952017-12-13 17:13:15 -08001988 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001989 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001990 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001991 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001992 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001993 const DexFile* dex_file = dex_cache->GetDexFile();
1994 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001995 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001996 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001997 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001998 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001999 if (repetition_count >= kMaxRepetition) {
2000 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
2001 }
2002 repetition_count = 0;
2003 last_line_number = line_number;
2004 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002005 }
Andreas Gampe93104952017-12-13 17:13:15 -08002006
2007 if (repetition_count >= kMaxRepetition) {
2008 // Skip visiting=printing anything.
2009 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002010 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07002011
Andreas Gampe93104952017-12-13 17:13:15 -08002012 os << " at " << m->PrettyMethod(false);
2013 if (m->IsNative()) {
2014 os << "(Native method)";
2015 } else {
2016 const char* source_file(m->GetDeclaringClassSourceFile());
2017 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2018 << ":" << line_number << ")";
2019 }
2020 os << "\n";
2021 // Go and visit locks.
2022 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002023 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002024
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002025 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002026 return VisitMethodResult::kContinueMethod;
2027 }
2028
Vladimir Markof52d92f2019-03-29 12:33:02 +00002029 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002030 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002031 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002032 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2033 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002034 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002035 override
Andreas Gampe93104952017-12-13 17:13:15 -08002036 REQUIRES_SHARED(Locks::mutator_lock_) {
2037 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2038 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002039 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002040 ThreadState state,
2041 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002042 override
Andreas Gampe93104952017-12-13 17:13:15 -08002043 REQUIRES_SHARED(Locks::mutator_lock_) {
2044 const char* msg;
2045 switch (state) {
2046 case kBlocked:
2047 msg = " - waiting to lock ";
2048 break;
2049
2050 case kWaitingForLockInflation:
2051 msg = " - waiting for lock inflation of ";
2052 break;
2053
2054 default:
2055 LOG(FATAL) << "Unreachable";
2056 UNREACHABLE();
2057 }
2058 PrintObject(obj, msg, owner_tid);
2059 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002060 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002061 override
Andreas Gampe93104952017-12-13 17:13:15 -08002062 REQUIRES_SHARED(Locks::mutator_lock_) {
2063 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2064 }
2065
Vladimir Markof52d92f2019-03-29 12:33:02 +00002066 void PrintObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002067 const char* msg,
2068 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2069 if (obj == nullptr) {
2070 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002071 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002072 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002073 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2074 // Getting the identity hashcode here would result in lock inflation and suspension of the
2075 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002076 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
Vladimir Markof52d92f2019-03-29 12:33:02 +00002077 reinterpret_cast<intptr_t>(obj.Ptr()),
Andreas Gampe93104952017-12-13 17:13:15 -08002078 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002079 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002080 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2081 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2082 // suspension and move pretty_object.
2083 const std::string pretty_type(obj->PrettyTypeOf());
2084 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002085 }
2086 }
Andreas Gampe93104952017-12-13 17:13:15 -08002087 if (owner_tid != ThreadList::kInvalidThreadId) {
2088 os << " held by thread " << owner_tid;
2089 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002090 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002091 }
2092
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002093 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002094 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002095 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002096 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002097};
2098
Ian Rogers33e95662013-05-20 20:29:14 -07002099static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002100 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002101 ThreadState state = thread->GetState();
2102
2103 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2104 if (state > kWaiting && state < kStarting) {
2105 return true;
2106 }
2107
2108 // In an Object.wait variant or Thread.sleep? That's not interesting.
2109 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2110 return false;
2111 }
2112
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002113 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002114 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002115 return true;
2116 }
2117
Elliott Hughesaef701d2013-04-05 18:15:40 -07002118 // In some other native method? That's interesting.
2119 // We don't just check kNative because native methods will be in state kSuspended if they're
2120 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2121 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002122 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002123 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002124}
2125
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002126void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002127 // If flip_function is not null, it means we have run a checkpoint
2128 // before the thread wakes up to execute the flip function and the
2129 // thread roots haven't been forwarded. So the following access to
2130 // the roots (locks or methods in the frames) would be bad. Run it
2131 // here. TODO: clean up.
2132 {
2133 Thread* this_thread = const_cast<Thread*>(this);
2134 Closure* flip_func = this_thread->GetFlipFunction();
2135 if (flip_func != nullptr) {
2136 flip_func->Run(this_thread);
2137 }
2138 }
2139
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002140 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2141 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002142 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2143 // thread.
Alex Lightb7c640d2019-03-20 15:52:13 -07002144 ScopedExceptionStorage ses(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002145
Ian Rogers700a4022014-05-19 16:49:03 -07002146 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002147 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002148 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002149 dumper.WalkStack();
2150}
2151
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002152void Thread::DumpStack(std::ostream& os,
2153 bool dump_native_stack,
2154 BacktraceMap* backtrace_map,
2155 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002156 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2157 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2158 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002159 bool dump_for_abort = (gAborting > 0);
2160 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2161 if (!kIsDebugBuild) {
2162 // We always want to dump the stack for an abort, however, there is no point dumping another
2163 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2164 safe_to_dump = (safe_to_dump || dump_for_abort);
2165 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002166 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002167 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002168 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002169 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002170 ArtMethod* method =
2171 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002172 /*check_suspended=*/ !force_dump_stack,
2173 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002174 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002175 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002176 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002177 /*check_suspended=*/ !force_dump_stack,
2178 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002179 } else {
2180 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002181 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002182}
2183
Elliott Hughesbe759c62011-09-08 19:38:21 -07002184void Thread::ThreadExitCallback(void* arg) {
2185 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002186 if (self->tls32_.thread_exit_check_count == 0) {
2187 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2188 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002189 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002190#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002191 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2192#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002193 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002194#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002195 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002196 } else {
2197 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2198 }
Carl Shapirob5573532011-07-12 18:22:59 -07002199}
2200
Elliott Hughesbe759c62011-09-08 19:38:21 -07002201void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002202 CHECK(!is_started_);
2203 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002204 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002205 // MutexLock to keep annotalysis happy.
2206 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002207 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002208 // return garbage since (is_started_ == true) and
2209 // Thread::pthread_key_self_ is not yet initialized.
2210 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002211 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002212 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2213 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002214 }
2215
Carl Shapirob5573532011-07-12 18:22:59 -07002216 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002217 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2218 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002219
2220 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002221 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2222 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002223 }
Elliott Hughes038a8062011-09-18 14:12:41 -07002224}
Carl Shapirob5573532011-07-12 18:22:59 -07002225
Elliott Hughes038a8062011-09-18 14:12:41 -07002226void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002227 Runtime* runtime = Runtime::Current();
2228 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002229
Elliott Hughes01158d72011-09-19 19:47:10 -07002230 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002231 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002232 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2233 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002234
Vladimir Markodcfcce42018-06-27 10:00:28 +00002235 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002236
2237 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2238 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002239 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2240 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002241}
2242
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002243void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002244 CHECK(is_started_);
2245 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002246 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002247 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002248 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002249 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002250 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002251 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002252}
2253
Andreas Gampe56776012018-01-26 17:40:55 -08002254void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2255 ScopedLocalRef<jobject> thread_jobject(
2256 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2257 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2258 soa.Env(), nullptr);
2259 jobject thread_group_jobject = thread_group;
2260 if (thread_group == nullptr || kIsDebugBuild) {
2261 // There is always a group set. Retrieve it.
2262 thread_group_jobject_scoped.reset(
2263 soa.Env()->GetObjectField(thread_jobject.get(),
2264 WellKnownClasses::java_lang_Thread_group));
2265 thread_group_jobject = thread_group_jobject_scoped.get();
2266 if (kIsDebugBuild && thread_group != nullptr) {
2267 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2268 }
2269 }
2270 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2271 WellKnownClasses::java_lang_ThreadGroup,
2272 WellKnownClasses::java_lang_ThreadGroup_add,
2273 thread_jobject.get());
2274}
2275
Calin Juravleccd56952016-12-15 17:57:38 +00002276Thread::Thread(bool daemon)
2277 : tls32_(daemon),
2278 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002279 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002280 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002281 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002282 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2283 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2284
Roland Levillain33d69032015-06-18 18:20:59 +01002285 static_assert((sizeof(Thread) % 4) == 0U,
2286 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002287 tls32_.state_and_flags.as_struct.flags = 0;
2288 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002289 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002290 // Initialize with no permit; if the java Thread was unparked before being
2291 // started, it will unpark itself before calling into java code.
2292 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002293 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002294 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002295 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002296 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002297 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002298 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2299 tlsPtr_.active_suspend_barriers[i] = nullptr;
2300 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002301 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002302 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002303 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002304 tls32_.use_mterp = false;
2305}
2306
2307void Thread::NotifyInTheadList() {
2308 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002309}
2310
Alex Lighte9f61032018-09-24 16:04:51 -07002311bool Thread::CanLoadClasses() const {
2312 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2313}
2314
Elliott Hughes7dc51662012-05-16 14:48:43 -07002315bool Thread::IsStillStarting() const {
2316 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002317 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002318 // 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 -07002319 // assigned fairly early on, and needs to be.
2320 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2321 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002322 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2323 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002324}
2325
Andreas Gamped9efea62014-07-21 22:56:08 -07002326void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002327 CHECK(IsExceptionPending()) << "Pending exception expected.";
2328}
2329
2330void Thread::AssertPendingOOMException() const {
2331 AssertPendingException();
2332 auto* e = GetException();
2333 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2334 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002335}
2336
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002337void Thread::AssertNoPendingException() const {
2338 if (UNLIKELY(IsExceptionPending())) {
2339 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002340 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002341 }
2342}
2343
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002344void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2345 if (UNLIKELY(IsExceptionPending())) {
2346 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002347 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002348 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002349 }
2350}
2351
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002352class MonitorExitVisitor : public SingleRootVisitor {
2353 public:
2354 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2355
2356 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2357 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002358 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002359 if (self_->HoldsLock(entered_monitor)) {
2360 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002361 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002362 << " left locked by native thread "
2363 << *Thread::Current() << " which is detaching";
2364 entered_monitor->MonitorExit(self_);
2365 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002366 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002367
2368 private:
2369 Thread* const self_;
2370};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002371
Elliott Hughesc0f09332012-03-26 13:27:06 -07002372void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002373 Thread* self = this;
2374 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002375
Ian Rogers68d8b422014-07-17 11:09:10 -07002376 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002377 {
2378 ScopedObjectAccess soa(self);
2379 MonitorExitVisitor visitor(self);
2380 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002381 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002382 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002383 // Release locally held global references which releasing may require the mutator lock.
2384 if (tlsPtr_.jpeer != nullptr) {
2385 // If pthread_create fails we don't have a jni env here.
2386 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2387 tlsPtr_.jpeer = nullptr;
2388 }
2389 if (tlsPtr_.class_loader_override != nullptr) {
2390 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2391 tlsPtr_.class_loader_override = nullptr;
2392 }
2393 }
2394
Ian Rogersdd7624d2014-03-14 17:43:00 -07002395 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002396 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002397 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002398 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002399 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002400 Runtime* runtime = Runtime::Current();
2401 if (runtime != nullptr) {
2402 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2403 }
Elliott Hughes534da072012-03-27 15:17:42 -07002404
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002405 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002406 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002407 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002408 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002409 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002410 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002411 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002412 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002413
Ian Rogerscfaa4552012-11-26 21:00:08 -08002414 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2415 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002416 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002417 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002418 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002419 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002420 StackHandleScope<1> hs(self);
2421 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002422 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002423 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002424 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002425 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002426 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002427
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002428 {
2429 ScopedObjectAccess soa(self);
2430 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002431 if (kUseReadBarrier) {
2432 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2433 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002434 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002435}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002436
Elliott Hughesc0f09332012-03-26 13:27:06 -07002437Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002438 CHECK(tlsPtr_.class_loader_override == nullptr);
2439 CHECK(tlsPtr_.jpeer == nullptr);
2440 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002441 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002442 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002443 delete tlsPtr_.jni_env;
2444 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002445 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002446 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002447 CHECK(!ReadFlag(kCheckpointRequest));
2448 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002449 CHECK(tlsPtr_.checkpoint_function == nullptr);
2450 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002451 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002452 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002453
Sebastien Hertz07474662015-08-25 15:12:33 +00002454 // Make sure we processed all deoptimization requests.
2455 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002456 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2457 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002458
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002459 // We may be deleting a still born thread.
2460 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002461
2462 delete wait_cond_;
2463 delete wait_mutex_;
2464
Ian Rogersdd7624d2014-03-14 17:43:00 -07002465 if (tlsPtr_.long_jump_context != nullptr) {
2466 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002467 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002468
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002469 if (initialized) {
2470 CleanupCpu();
2471 }
2472
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002473 if (tlsPtr_.single_step_control != nullptr) {
2474 delete tlsPtr_.single_step_control;
2475 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002476 delete tlsPtr_.instrumentation_stack;
2477 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002478 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002479
Ian Rogers68d8b422014-07-17 11:09:10 -07002480 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002481
Elliott Hughesd8af1592012-04-16 20:40:15 -07002482 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002483}
2484
Andreas Gampe513061a2017-06-01 09:17:34 -07002485void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002486 if (!IsExceptionPending()) {
2487 return;
2488 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002489 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002490 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002491
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002492 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002493 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2494 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002495
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002496 // Call the Thread instance's dispatchUncaughtException(Throwable)
2497 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2498 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2499 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002500
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002501 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002502 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002503}
2504
Andreas Gampe513061a2017-06-01 09:17:34 -07002505void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002506 // this.group.removeThread(this);
2507 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002508 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002509 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002510 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002511 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002512 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002513 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002514 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2515 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2516 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002517 }
2518}
2519
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002520bool Thread::HandleScopeContains(jobject obj) const {
2521 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002522 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002523 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002524 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002525 return true;
2526 }
2527 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002528 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2529 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002530}
2531
Hans Boehm0882af22017-08-31 15:21:57 -07002532void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002533 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2534 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002535 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2536 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002537 }
2538}
2539
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002540ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002541 if (obj == nullptr) {
2542 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002543 }
2544 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002545 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002546 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002547 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002548 // The "kinds" below are sorted by the frequency we expect to encounter them.
2549 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002550 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002551 // Local references do not need a read barrier.
2552 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002553 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002554 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002555 // Check if this is a local reference in the handle scope.
2556 if (LIKELY(HandleScopeContains(obj))) {
2557 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002558 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002559 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002560 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002561 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002562 expect_null = true;
2563 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002564 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002565 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002566 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002567 } else {
2568 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002569 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002570 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002571 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002572 expect_null = true;
2573 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002574 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002575 }
2576
Ian Rogersc0542af2014-09-03 16:16:56 -07002577 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002578 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002579 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002580 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002581 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002582}
2583
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002584bool Thread::IsJWeakCleared(jweak obj) const {
2585 CHECK(obj != nullptr);
2586 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002587 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002588 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002589 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002590}
2591
Ian Rogers81d425b2012-09-27 16:03:43 -07002592// Implements java.lang.Thread.interrupted.
2593bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002594 DCHECK_EQ(Thread::Current(), this);
2595 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002596 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002597 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002598 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002599 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002600 return interrupted;
2601}
2602
2603// Implements java.lang.Thread.isInterrupted.
2604bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002605 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002606}
2607
Ian Rogersdd7624d2014-03-14 17:43:00 -07002608void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002609 {
2610 MutexLock mu(self, *wait_mutex_);
2611 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2612 return;
2613 }
2614 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2615 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002616 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002617 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002618}
2619
2620void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002621 Thread* self = Thread::Current();
2622 MutexLock mu(self, *wait_mutex_);
2623 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002624}
2625
Ian Rogersc604d732012-10-14 16:09:54 -07002626void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002627 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002628 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002629 }
2630}
2631
Ian Rogers68d8b422014-07-17 11:09:10 -07002632void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2633 if (tlsPtr_.class_loader_override != nullptr) {
2634 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2635 }
2636 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2637}
2638
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002639using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2640
2641// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2642class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002643 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002644 explicit FetchStackTraceVisitor(Thread* thread,
2645 ArtMethodDexPcPair* saved_frames = nullptr,
2646 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002647 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002648 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002649 saved_frames_(saved_frames),
2650 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002651
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002652 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002653 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002654 // Note we also skip the frame if it doesn't have a method (namely the callee
2655 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002656 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002657 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002658 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002659 skipping_ = false;
2660 }
2661 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002662 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002663 if (depth_ < max_saved_frames_) {
2664 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002665 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002666 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002667 ++depth_;
2668 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002669 } else {
2670 ++skip_depth_;
2671 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002672 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002673 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002674
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002675 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002676 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002677 }
2678
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002679 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002680 return skip_depth_;
2681 }
2682
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002683 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002684 uint32_t depth_ = 0;
2685 uint32_t skip_depth_ = 0;
2686 bool skipping_ = true;
2687 ArtMethodDexPcPair* saved_frames_;
2688 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002689
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002690 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002691};
2692
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002693template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002694class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002695 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002696 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002697 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2698 self_(self),
2699 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002700 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002701
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002702 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002703 // Allocate method trace as an object array where the first element is a pointer array that
2704 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2705 // class of the ArtMethod pointers.
2706 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2707 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002708 ObjPtr<mirror::Class> array_class =
2709 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002710 // The first element is the methods and dex pc array, the other elements are declaring classes
2711 // for the methods to ensure classes in the stack trace don't get unloaded.
2712 Handle<mirror::ObjectArray<mirror::Object>> trace(
2713 hs.NewHandle(
2714 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002715 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002716 // Acquire uninterruptible_ in all paths.
2717 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002718 self_->AssertPendingOOMException();
2719 return false;
2720 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002721 ObjPtr<mirror::PointerArray> methods_and_pcs =
2722 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002723 const char* last_no_suspend_cause =
2724 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2725 if (methods_and_pcs == nullptr) {
2726 self_->AssertPendingOOMException();
2727 return false;
2728 }
2729 trace->Set(0, methods_and_pcs);
2730 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002731 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002732 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002733 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002734 }
2735
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002736 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2737 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002738 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002739
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002740 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002741 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002742 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002743 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002744 if (skip_depth_ > 0) {
2745 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002746 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002747 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002748 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002749 if (m->IsRuntimeMethod()) {
2750 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002751 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002752 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002753 return true;
2754 }
2755
2756 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002757 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002758 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002759 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2760 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002761 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002762 pointer_size_);
2763 // Save the declaring class of the method to ensure that the declaring classes of the methods
2764 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002765 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002766 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002767 }
2768
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002769 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002770 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002771 }
2772
2773 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002774 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002775 }
2776
2777 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002778 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002779 // How many more frames to skip.
2780 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002781 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002782 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002783 // An object array where the first element is a pointer array that contains the ArtMethod
2784 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2785 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2786 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002787 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002788 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002789 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002790
2791 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002792};
2793
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002794template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002795jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002796 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2797 constexpr size_t kMaxSavedFrames = 256;
2798 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2799 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2800 &saved_frames[0],
2801 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002802 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002803 const uint32_t depth = count_visitor.GetDepth();
2804 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002805
Ian Rogers1f539342012-10-03 21:09:42 -07002806 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002807 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2808 const_cast<Thread*>(this),
2809 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002810 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002811 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002812 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002813 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2814 // than doing the stack walk twice.
2815 if (depth < kMaxSavedFrames) {
2816 for (size_t i = 0; i < depth; ++i) {
2817 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2818 }
2819 } else {
2820 build_trace_visitor.WalkStack();
2821 }
2822
Mathieu Chartier910e8272015-09-30 09:24:22 -07002823 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002824 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002825 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002826 // Second half of trace_methods is dex PCs.
2827 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2828 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002829 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2830 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002831 }
2832 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002833 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002834}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002835template jobject Thread::CreateInternalStackTrace<false>(
2836 const ScopedObjectAccessAlreadyRunnable& soa) const;
2837template jobject Thread::CreateInternalStackTrace<true>(
2838 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002839
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002840bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002841 // Only count the depth since we do not pass a stack frame array as an argument.
2842 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002843 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002844 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002845}
2846
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002847static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2848 const ScopedObjectAccessAlreadyRunnable& soa,
2849 ArtMethod* method,
2850 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2851 int32_t line_number;
2852 StackHandleScope<3> hs(soa.Self());
2853 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2854 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2855 if (method->IsProxyMethod()) {
2856 line_number = -1;
2857 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2858 // source_name_object intentionally left null for proxy methods
2859 } else {
2860 line_number = method->GetLineNumFromDexPC(dex_pc);
2861 // Allocate element, potentially triggering GC
2862 // TODO: reuse class_name_object via Class::name_?
2863 const char* descriptor = method->GetDeclaringClassDescriptor();
2864 CHECK(descriptor != nullptr);
2865 std::string class_name(PrettyDescriptor(descriptor));
2866 class_name_object.Assign(
2867 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2868 if (class_name_object == nullptr) {
2869 soa.Self()->AssertPendingOOMException();
2870 return nullptr;
2871 }
2872 const char* source_file = method->GetDeclaringClassSourceFile();
2873 if (line_number == -1) {
2874 // Make the line_number field of StackTraceElement hold the dex pc.
2875 // source_name_object is intentionally left null if we failed to map the dex pc to
2876 // a line number (most probably because there is no debug info). See b/30183883.
2877 line_number = dex_pc;
2878 } else {
2879 if (source_file != nullptr) {
2880 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2881 if (source_name_object == nullptr) {
2882 soa.Self()->AssertPendingOOMException();
2883 return nullptr;
2884 }
2885 }
2886 }
2887 }
2888 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2889 CHECK(method_name != nullptr);
2890 Handle<mirror::String> method_name_object(
2891 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2892 if (method_name_object == nullptr) {
2893 return nullptr;
2894 }
2895 return mirror::StackTraceElement::Alloc(soa.Self(),
2896 class_name_object,
2897 method_name_object,
2898 source_name_object,
2899 line_number);
2900}
2901
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002902jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002903 const ScopedObjectAccessAlreadyRunnable& soa,
2904 jobject internal,
2905 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002906 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002907 // Decode the internal stack trace into the depth, method trace and PC trace.
2908 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002909 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002910 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002911
Mathieu Chartier910e8272015-09-30 09:24:22 -07002912 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002913
Elliott Hughes01158d72011-09-19 19:47:10 -07002914 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002915
Dave Allison0aded082013-11-07 13:15:11 -08002916 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002917 // Reuse the array we were given.
2918 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002919 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002920 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002921 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002922 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002923 } else {
2924 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002925 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002926 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002927 if (java_traces == nullptr) {
2928 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002929 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002930 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002931 }
2932
Dave Allison0aded082013-11-07 13:15:11 -08002933 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002934 *stack_depth = depth;
2935 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002936
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002937 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002938 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002939 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002940 // Methods and dex PC trace is element 0.
2941 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00002942 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002943 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07002944 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002945 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002946 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002947 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00002948 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002949 if (obj == nullptr) {
2950 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002951 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002952 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002953 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002954 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002955 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002956}
2957
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002958jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2959 // This code allocates. Do not allow it to operate with a pending exception.
2960 if (IsExceptionPending()) {
2961 return nullptr;
2962 }
2963
2964 // If flip_function is not null, it means we have run a checkpoint
2965 // before the thread wakes up to execute the flip function and the
2966 // thread roots haven't been forwarded. So the following access to
2967 // the roots (locks or methods in the frames) would be bad. Run it
2968 // here. TODO: clean up.
2969 // Note: copied from DumpJavaStack.
2970 {
2971 Thread* this_thread = const_cast<Thread*>(this);
2972 Closure* flip_func = this_thread->GetFlipFunction();
2973 if (flip_func != nullptr) {
2974 flip_func->Run(this_thread);
2975 }
2976 }
2977
2978 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2979 public:
2980 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2981 Thread* self,
2982 Context* context)
2983 : MonitorObjectsStackVisitor(self, context),
2984 wait_jobject_(soaa_in.Env(), nullptr),
2985 block_jobject_(soaa_in.Env(), nullptr),
2986 soaa_(soaa_in) {}
2987
2988 protected:
2989 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002990 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002991 REQUIRES_SHARED(Locks::mutator_lock_) {
2992 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
2993 soaa_, m, GetDexPc(/* abort on error */ false));
2994 if (obj == nullptr) {
2995 return VisitMethodResult::kEndStackWalk;
2996 }
2997 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
2998 return VisitMethodResult::kContinueMethod;
2999 }
3000
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003001 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003002 lock_objects_.push_back({});
3003 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3004
3005 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3006
3007 return VisitMethodResult::kContinueMethod;
3008 }
3009
Vladimir Markof52d92f2019-03-29 12:33:02 +00003010 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003011 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003012 REQUIRES_SHARED(Locks::mutator_lock_) {
3013 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3014 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003015 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003016 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003017 REQUIRES_SHARED(Locks::mutator_lock_) {
3018 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3019 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003020 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003021 ThreadState state ATTRIBUTE_UNUSED,
3022 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003023 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003024 REQUIRES_SHARED(Locks::mutator_lock_) {
3025 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3026 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003027 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003028 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003029 REQUIRES_SHARED(Locks::mutator_lock_) {
3030 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3031 }
3032
3033 public:
3034 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3035 ScopedLocalRef<jobject> wait_jobject_;
3036 ScopedLocalRef<jobject> block_jobject_;
3037 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3038
3039 private:
3040 const ScopedObjectAccessAlreadyRunnable& soaa_;
3041
3042 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3043 };
3044
3045 std::unique_ptr<Context> context(Context::Create());
3046 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3047 dumper.WalkStack();
3048
3049 // There should not be a pending exception. Otherwise, return with it pending.
3050 if (IsExceptionPending()) {
3051 return nullptr;
3052 }
3053
3054 // Now go and create Java arrays.
3055
3056 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3057
3058 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003059 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003060 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003061 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3062 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003063 return nullptr;
3064 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003065 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003066
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003067 Handle<mirror::Class> h_o_array_class =
3068 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3069 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003070
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003071
3072 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3073 class_linker->EnsureInitialized(soa.Self(),
3074 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003075 /* can_init_fields= */ true,
3076 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003077 if (soa.Self()->IsExceptionPending()) {
3078 // This should not fail in a healthy runtime.
3079 return nullptr;
3080 }
3081
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003082 ArtField* stack_trace_element_field = h_aste_class->FindField(
3083 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3084 DCHECK(stack_trace_element_field != nullptr);
3085 ArtField* held_locks_field = h_aste_class->FindField(
3086 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3087 DCHECK(held_locks_field != nullptr);
3088 ArtField* blocked_on_field = h_aste_class->FindField(
3089 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3090 DCHECK(blocked_on_field != nullptr);
3091
3092 size_t length = dumper.stack_trace_elements_.size();
3093 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003094 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003095 if (array == nullptr) {
3096 soa.Self()->AssertPendingOOMException();
3097 return nullptr;
3098 }
3099
3100 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3101
3102 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3103 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3104 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3105 for (size_t i = 0; i != length; ++i) {
3106 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3107 if (handle == nullptr) {
3108 soa.Self()->AssertPendingOOMException();
3109 return nullptr;
3110 }
3111
3112 // Set stack trace element.
3113 stack_trace_element_field->SetObject<false>(
3114 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3115
3116 // Create locked-on array.
3117 if (!dumper.lock_objects_[i].empty()) {
3118 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3119 h_o_array_class.Get(),
3120 dumper.lock_objects_[i].size()));
3121 if (handle2 == nullptr) {
3122 soa.Self()->AssertPendingOOMException();
3123 return nullptr;
3124 }
3125 int32_t j = 0;
3126 for (auto& scoped_local : dumper.lock_objects_[i]) {
3127 if (scoped_local == nullptr) {
3128 continue;
3129 }
3130 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3131 DCHECK(!soa.Self()->IsExceptionPending());
3132 j++;
3133 }
3134 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3135 }
3136
3137 // Set blocked-on object.
3138 if (i == 0) {
3139 if (dumper.block_jobject_ != nullptr) {
3140 blocked_on_field->SetObject<false>(
3141 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3142 }
3143 }
3144
3145 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3146 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3147 DCHECK(!soa.Self()->IsExceptionPending());
3148 }
3149
3150 return result.release();
3151}
3152
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003153void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003154 va_list args;
3155 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003156 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003157 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003158}
3159
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003160void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003161 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003162 std::string msg;
3163 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003164 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003165}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003166
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003167void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003168 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003169 // Callers should either clear or call ThrowNewWrappedException.
3170 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003171 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003172}
3173
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003174static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003175 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003176 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003177 return method != nullptr
3178 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003179 : nullptr;
3180}
3181
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003182void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003183 const char* msg) {
3184 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003185 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003186 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003187 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003188 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003189 ClearException();
3190 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003191 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003192 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003193 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003194 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003195 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003196 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003197 return;
3198 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003199
Ian Rogers7b078e82014-09-10 14:44:24 -07003200 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3201 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003202 DCHECK(IsExceptionPending());
3203 return;
3204 }
3205 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003206 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003207 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003208
Mathieu Chartier590fee92013-09-13 13:46:47 -07003209 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003210 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003211 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3212 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003213 return;
3214 }
3215
Ian Rogers62d6c772013-02-27 08:32:07 -08003216 // Choose an appropriate constructor and set up the arguments.
3217 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003218 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003219 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003220 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003221 msg_string.reset(
3222 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003223 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003224 CHECK(IsExceptionPending()); // OOME.
3225 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003226 }
Dave Allison0aded082013-11-07 13:15:11 -08003227 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003228 signature = "(Ljava/lang/String;)V";
3229 } else {
3230 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3231 }
3232 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003233 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003234 signature = "()V";
3235 } else {
3236 signature = "(Ljava/lang/Throwable;)V";
3237 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003238 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003239 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003240 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003241
Dave Allison0aded082013-11-07 13:15:11 -08003242 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003243 << PrettyDescriptor(exception_class_descriptor);
3244
3245 if (UNLIKELY(!runtime->IsStarted())) {
3246 // Something is trying to throw an exception without a started runtime, which is the common
3247 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3248 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003249 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003250 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003251 }
Dave Allison0aded082013-11-07 13:15:11 -08003252 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003253 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003254 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003255 ScopedLocalRef<jobject> trace(GetJniEnv(),
3256 Runtime::Current()->IsActiveTransaction()
3257 ? CreateInternalStackTrace<true>(soa)
3258 : CreateInternalStackTrace<false>(soa));
3259 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003260 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003261 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003262 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003263 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003264 jvalue jv_args[2];
3265 size_t i = 0;
3266
Dave Allison0aded082013-11-07 13:15:11 -08003267 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003268 jv_args[i].l = msg_string.get();
3269 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003270 }
Dave Allison0aded082013-11-07 13:15:11 -08003271 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003272 jv_args[i].l = cause.get();
3273 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003274 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003275 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Alex Light01fbfbe2019-06-27 10:47:04 -07003276 InvokeWithJValues(soa, ref.get(), exception_init_method, jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003277 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003278 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003279 }
Elliott Hughes30646832011-10-13 16:59:46 -07003280 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003281}
3282
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003283void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003284 LOG(WARNING) << "Throwing OutOfMemoryError "
3285 << '"' << msg << '"'
3286 << " (VmSize " << GetProcessStatus("VmSize")
3287 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003288 if (!tls32_.throwing_OutOfMemoryError) {
3289 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003290 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003291 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003292 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003293 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003294 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003295 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003296}
3297
Elliott Hughes498508c2011-10-17 14:58:22 -07003298Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003299 return Thread::Current();
3300}
3301
3302void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003303 std::ostringstream ss;
3304 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003305 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003306 // log to stderr for debugging command line processes
3307 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003308#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003309 // log to logcat for debugging frameworks processes
3310 LOG(INFO) << str;
3311#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003312}
3313
Ian Rogersdd7624d2014-03-14 17:43:00 -07003314// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003315template
3316void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3317template
3318void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003319
Andreas Gampe542451c2016-07-26 09:02:02 -07003320template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003321void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3322#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003323 if (offset == (x).Uint32Value()) { \
3324 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003325 return; \
3326 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003327 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3328 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3329 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3330 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3331 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3332 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3333 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3334 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003335 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003336 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003337 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003338 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003339 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003340#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003341
Ian Rogersdd7624d2014-03-14 17:43:00 -07003342#define JNI_ENTRY_POINT_INFO(x) \
3343 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3344 os << #x; \
3345 return; \
3346 }
3347 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3348#undef JNI_ENTRY_POINT_INFO
3349
Ian Rogersdd7624d2014-03-14 17:43:00 -07003350#define QUICK_ENTRY_POINT_INFO(x) \
3351 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3352 os << #x; \
3353 return; \
3354 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003355 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003356 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3357 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3358 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3359 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003360 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3361 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003362 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003363 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003364 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3365 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3366 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003367 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003368 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003369 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003370 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3371 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003372 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003373 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3374 QUICK_ENTRY_POINT_INFO(pSet8Static)
3375 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3376 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003377 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3378 QUICK_ENTRY_POINT_INFO(pSet32Static)
3379 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3380 QUICK_ENTRY_POINT_INFO(pSet64Static)
3381 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3382 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003383 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3384 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3385 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3386 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3387 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3388 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3389 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3390 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003391 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3392 QUICK_ENTRY_POINT_INFO(pGet32Static)
3393 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3394 QUICK_ENTRY_POINT_INFO(pGet64Static)
3395 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3396 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003397 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003398 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3399 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3400 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3401 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3402 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3403 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3404 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3405 QUICK_ENTRY_POINT_INFO(pLockObject)
3406 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3407 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3408 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3409 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3410 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003411 QUICK_ENTRY_POINT_INFO(pCos)
3412 QUICK_ENTRY_POINT_INFO(pSin)
3413 QUICK_ENTRY_POINT_INFO(pAcos)
3414 QUICK_ENTRY_POINT_INFO(pAsin)
3415 QUICK_ENTRY_POINT_INFO(pAtan)
3416 QUICK_ENTRY_POINT_INFO(pAtan2)
3417 QUICK_ENTRY_POINT_INFO(pCbrt)
3418 QUICK_ENTRY_POINT_INFO(pCosh)
3419 QUICK_ENTRY_POINT_INFO(pExp)
3420 QUICK_ENTRY_POINT_INFO(pExpm1)
3421 QUICK_ENTRY_POINT_INFO(pHypot)
3422 QUICK_ENTRY_POINT_INFO(pLog)
3423 QUICK_ENTRY_POINT_INFO(pLog10)
3424 QUICK_ENTRY_POINT_INFO(pNextAfter)
3425 QUICK_ENTRY_POINT_INFO(pSinh)
3426 QUICK_ENTRY_POINT_INFO(pTan)
3427 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003428 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003429 QUICK_ENTRY_POINT_INFO(pL2d)
3430 QUICK_ENTRY_POINT_INFO(pFmodf)
3431 QUICK_ENTRY_POINT_INFO(pL2f)
3432 QUICK_ENTRY_POINT_INFO(pD2iz)
3433 QUICK_ENTRY_POINT_INFO(pF2iz)
3434 QUICK_ENTRY_POINT_INFO(pIdivmod)
3435 QUICK_ENTRY_POINT_INFO(pD2l)
3436 QUICK_ENTRY_POINT_INFO(pF2l)
3437 QUICK_ENTRY_POINT_INFO(pLdiv)
3438 QUICK_ENTRY_POINT_INFO(pLmod)
3439 QUICK_ENTRY_POINT_INFO(pLmul)
3440 QUICK_ENTRY_POINT_INFO(pShlLong)
3441 QUICK_ENTRY_POINT_INFO(pShrLong)
3442 QUICK_ENTRY_POINT_INFO(pUshrLong)
3443 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003444 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3445 QUICK_ENTRY_POINT_INFO(pMemcpy)
3446 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3447 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3448 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3449 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3450 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3451 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3452 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3453 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003454 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003455 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3456 QUICK_ENTRY_POINT_INFO(pDeliverException)
3457 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3458 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003459 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3460 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003461 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003462 QUICK_ENTRY_POINT_INFO(pA64Load)
3463 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003464 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3465 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3466 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3467 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3468 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3469 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3470 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3471 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3472 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3473 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3474 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3475 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3476 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3477 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3478 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3479 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003480 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003481 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3482 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3483 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3484 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3485 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3486 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3487 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3488 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3489 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3490 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3491 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3492 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3493 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3494 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3495 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3496 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3497 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3498 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3499 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3500 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3501 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3502 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3503 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3504 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3505 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3506 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3507 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3508 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3509 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3510 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003511 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003512 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003513
3514 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3515 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003516#undef QUICK_ENTRY_POINT_INFO
3517
Elliott Hughes98e20172012-04-24 15:38:13 -07003518 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003519}
3520
jeffhao94d6df42012-11-26 16:02:12 -08003521void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003522 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003523 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003524 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003525 if (exception == GetDeoptimizationException()) {
3526 artDeoptimize(this);
3527 UNREACHABLE();
3528 }
3529
Roland Levillaina78f5b62017-09-29 13:50:44 +01003530 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003531
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003532 // This is a real exception: let the instrumentation know about it.
3533 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003534 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003535 IsExceptionThrownByCurrentMethod(exception)) {
3536 // Instrumentation may cause GC so keep the exception object safe.
3537 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003538 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Vladimir Marko19711d42019-04-12 14:05:34 +01003539 instrumentation->ExceptionThrownEvent(this, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003540 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003541 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3542 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3543 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3544 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003545 //
3546 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3547 // expected to happen fairly regularly but the second can only happen if we are using
3548 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3549 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003550 ShadowFrame* cf;
Alex Lightbe1f8d02018-10-15 11:44:42 -07003551 bool force_deopt;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003552 {
3553 NthCallerVisitor visitor(this, 0, false);
3554 visitor.WalkStack();
3555 cf = visitor.GetCurrentShadowFrame();
3556 if (cf == nullptr) {
3557 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3558 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003559 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3560 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003561 if (kIsDebugBuild && force_frame_pop) {
3562 NthCallerVisitor penultimate_visitor(this, 1, false);
3563 penultimate_visitor.WalkStack();
3564 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3565 if (penultimate_frame == nullptr) {
3566 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3567 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003568 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003569 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003570 }
Alex Light3dacdd62019-03-12 15:45:47 +00003571 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003572 NthCallerVisitor visitor(this, 0, false);
3573 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003574 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003575 // method_type shouldn't matter due to exception handling.
3576 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003577 // Save the exception into the deoptimization context so it can be restored
3578 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003579 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003580 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3581 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3582 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003583 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3584 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003585 ClearException();
3586 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003587 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003588 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003589 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003590 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003591 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003592 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003593 artDeoptimize(this);
3594 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003595 } else {
3596 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3597 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003598 }
3599 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003600
Ian Rogers28ad40d2011-10-27 15:19:26 -07003601 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003602 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003603 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003604 QuickExceptionHandler exception_handler(this, false);
3605 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003606 if (exception_handler.GetClearException()) {
3607 // Exception was cleared as part of delivery.
3608 DCHECK(!IsExceptionPending());
3609 } else {
3610 // Exception was put back with a throw location.
3611 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003612 // Check the to-space invariant on the re-installed exception (if applicable).
3613 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003614 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003615 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003616}
3617
Ian Rogersbdb03912011-09-14 00:55:44 -07003618Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003619 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003620 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003621 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003622 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003623 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003624 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003625 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003626 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003627}
3628
Andreas Gampec7d878d2018-11-19 18:42:06 +00003629ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003630 bool check_suspended,
3631 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003632 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3633 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3634 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003635 ArtMethod* method = nullptr;
3636 uint32_t dex_pc = dex::kDexNoIndex;
3637 StackVisitor::WalkStack(
3638 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3639 ArtMethod* m = visitor->GetMethod();
3640 if (m->IsRuntimeMethod()) {
3641 // Continue if this is a runtime method.
3642 return true;
3643 }
3644 method = m;
3645 dex_pc = visitor->GetDexPc(abort_on_error);
3646 return false;
3647 },
3648 const_cast<Thread*>(this),
3649 /* context= */ nullptr,
3650 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3651 check_suspended);
3652
3653 if (dex_pc_out != nullptr) {
3654 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003655 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003656 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003657}
3658
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003659bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3660 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003661}
3662
Roland Levillainad0777d2018-02-12 20:00:18 +00003663extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003664 REQUIRES_SHARED(Locks::mutator_lock_);
3665
Ian Rogers40e3bac2012-11-20 00:09:14 -08003666// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003667template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003668class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003669 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003670 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003671 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003672 // We are visiting the references in compiled frames, so we do not need
3673 // to know the inlined frames.
3674 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3675 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003676
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003677 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003678 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003679 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003680 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003681 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003682 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003683 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003684 VisitShadowFrame(shadow_frame);
3685 } else {
3686 VisitQuickFrame();
3687 }
3688 return true;
3689 }
3690
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003691 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003692 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003693 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003694 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003695 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003696 // handle scope for JNI or References for interpreter.
3697 for (size_t reg = 0; reg < num_regs; ++reg) {
3698 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3699 if (ref != nullptr) {
3700 mirror::Object* new_ref = ref;
3701 visitor_(&new_ref, reg, this);
3702 if (new_ref != ref) {
3703 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003704 }
3705 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003706 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003707 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003708 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003709 }
3710
3711 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003712 // 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 -07003713 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3714 // the threads do not all hold the heap bitmap lock for parallel GC.
3715 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003716 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003717 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003718 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003719 // klass can be null for runtime methods.
3720 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003721 if (kVerifyImageObjectsMarked) {
3722 gc::Heap* const heap = Runtime::Current()->GetHeap();
3723 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003724 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003725 if (space != nullptr && space->IsImageSpace()) {
3726 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003727 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003728 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003729 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003730 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003731 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003732 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003733 }
3734 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003735 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3736 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3737 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003738 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003739 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003740 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3741 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003742 }
3743 }
3744 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003745 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003746 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003747 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003748 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003749 }
3750 }
3751 }
3752
Andreas Gampe585da952016-12-02 14:52:29 -08003753 template <typename T>
3754 ALWAYS_INLINE
3755 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003756 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003757 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003758 ArtMethod* m = *cur_quick_frame;
3759 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003760
Sebastien Hertz714f1752014-04-28 15:03:08 +02003761 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003762 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003763 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003764 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003765 StackReference<mirror::Object>* vreg_base =
3766 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003767 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbecky0d4567f2019-05-30 22:45:40 +01003768 CodeInfo code_info = kPrecise
3769 ? CodeInfo(method_header) // We will need dex register maps.
3770 : CodeInfo::DecodeGcMasksOnly(method_header);
David Srbecky052f8ca2018-04-26 15:42:54 +01003771 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003772 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003773
David Srbecky052f8ca2018-04-26 15:42:54 +01003774 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003775
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003776 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003777 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003778 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003779 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003780 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003781 mirror::Object* ref = ref_addr->AsMirrorPtr();
3782 if (ref != nullptr) {
3783 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003784 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003785 if (ref != new_ref) {
3786 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003787 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003788 }
3789 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003790 }
3791 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003792 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003793 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3794 if (register_mask & (1 << i)) {
3795 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003796 if (kIsDebugBuild && ref_addr == nullptr) {
3797 std::string thread_name;
3798 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003799 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003800 DescribeStack(GetThread());
3801 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3802 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3803 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003804 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003805 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003806 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003807 }
3808 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003809 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3810 // If this is a proxy method, visit its reference arguments.
3811 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003812 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003813 std::vector<StackReference<mirror::Object>*> ref_addrs =
3814 GetProxyReferenceArguments(cur_quick_frame);
3815 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3816 mirror::Object* ref = ref_addr->AsMirrorPtr();
3817 if (ref != nullptr) {
3818 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003819 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003820 if (ref != new_ref) {
3821 ref_addr->Assign(new_ref);
3822 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003823 }
3824 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003825 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003826 }
3827
Andreas Gampe585da952016-12-02 14:52:29 -08003828 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3829 if (kPrecise) {
3830 VisitQuickFramePrecise();
3831 } else {
3832 VisitQuickFrameNonPrecise();
3833 }
3834 }
3835
3836 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3837 struct UndefinedVRegInfo {
3838 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3839 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003840 const StackMap& map ATTRIBUTE_UNUSED,
3841 RootVisitor& _visitor)
3842 : visitor(_visitor) {
3843 }
3844
3845 ALWAYS_INLINE
3846 void VisitStack(mirror::Object** ref,
3847 size_t stack_index ATTRIBUTE_UNUSED,
3848 const StackVisitor* stack_visitor)
3849 REQUIRES_SHARED(Locks::mutator_lock_) {
3850 visitor(ref, -1, stack_visitor);
3851 }
3852
3853 ALWAYS_INLINE
3854 void VisitRegister(mirror::Object** ref,
3855 size_t register_index ATTRIBUTE_UNUSED,
3856 const StackVisitor* stack_visitor)
3857 REQUIRES_SHARED(Locks::mutator_lock_) {
3858 visitor(ref, -1, stack_visitor);
3859 }
3860
3861 RootVisitor& visitor;
3862 };
3863 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3864 }
3865
3866 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3867 struct StackMapVRegInfo {
3868 StackMapVRegInfo(ArtMethod* method,
3869 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003870 const StackMap& map,
3871 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003872 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003873 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003874 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003875 visitor(_visitor) {
Artem Serov2808be82018-12-20 19:15:11 +00003876 DCHECK_EQ(dex_register_map.size(), number_of_dex_registers);
Andreas Gampe585da952016-12-02 14:52:29 -08003877 }
3878
3879 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3880 // lookups for each location.
3881 void FindWithType(const size_t index,
3882 const DexRegisterLocation::Kind kind,
3883 mirror::Object** ref,
3884 const StackVisitor* stack_visitor)
3885 REQUIRES_SHARED(Locks::mutator_lock_) {
3886 bool found = false;
3887 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003888 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003889 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3890 visitor(ref, dex_reg, stack_visitor);
3891 found = true;
3892 }
3893 }
3894
3895 if (!found) {
3896 // If nothing found, report with -1.
3897 visitor(ref, -1, stack_visitor);
3898 }
3899 }
3900
3901 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3902 REQUIRES_SHARED(Locks::mutator_lock_) {
3903 const size_t stack_offset = stack_index * kFrameSlotSize;
3904 FindWithType(stack_offset,
3905 DexRegisterLocation::Kind::kInStack,
3906 ref,
3907 stack_visitor);
3908 }
3909
3910 void VisitRegister(mirror::Object** ref,
3911 size_t register_index,
3912 const StackVisitor* stack_visitor)
3913 REQUIRES_SHARED(Locks::mutator_lock_) {
3914 FindWithType(register_index,
3915 DexRegisterLocation::Kind::kInRegister,
3916 ref,
3917 stack_visitor);
3918 }
3919
3920 size_t number_of_dex_registers;
3921 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003922 DexRegisterMap dex_register_map;
3923 RootVisitor& visitor;
3924 };
3925 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3926 }
3927
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003928 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003929 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003930};
3931
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003932class RootCallbackVisitor {
3933 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003934 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003935
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003936 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003937 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003938 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003939 }
3940
3941 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003942 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003943 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003944};
3945
Andreas Gampe585da952016-12-02 14:52:29 -08003946template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003947void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003948 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003949 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003950 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003951 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003952 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003953 }
Alex Light848574c2017-09-25 16:59:39 -07003954 if (tlsPtr_.async_exception != nullptr) {
3955 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3956 RootInfo(kRootNativeStack, thread_id));
3957 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003958 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003959 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3960 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003961 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003962 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003963 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003964 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003965 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003966 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003967 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003968 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003969 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3970 record != nullptr;
3971 record = record->GetLink()) {
3972 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3973 shadow_frame != nullptr;
3974 shadow_frame = shadow_frame->GetLink()) {
3975 mapper.VisitShadowFrame(shadow_frame);
3976 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003977 }
3978 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003979 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3980 record != nullptr;
3981 record = record->GetLink()) {
3982 if (record->IsReference()) {
3983 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003984 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003985 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003986 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3987 RootInfo(kRootThreadObject, thread_id));
3988 }
3989 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3990 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003991 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003992 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3993 record != nullptr;
3994 record = record->GetNext()) {
3995 mapper.VisitShadowFrame(record->GetShadowFrame());
3996 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003997 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003998 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3999 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004000 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004001 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004002 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004003 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004004 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004005 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07004006 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004007 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004008 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004009}
4010
Andreas Gampe585da952016-12-02 14:52:29 -08004011void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4012 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004013 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004014 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004015 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004016 }
4017}
4018
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004019class VerifyRootVisitor : public SingleRootVisitor {
4020 public:
4021 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004022 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004023 VerifyObject(root);
4024 }
4025};
jeffhao25045522012-03-13 19:34:37 -07004026
Ian Rogers04d7aa92013-03-16 14:29:17 -07004027void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004028 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4029 VerifyRootVisitor visitor;
4030 std::unique_ptr<Context> context(Context::Create());
4031 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4032 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4033 mapper.WalkStack();
4034 }
jeffhao25045522012-03-13 19:34:37 -07004035}
jeffhao25045522012-03-13 19:34:37 -07004036
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004037// Set the stack end to that to be used during a stack overflow
4038void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004039 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004040 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004041 // However, we seem to have already extended to use the full stack.
4042 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004043 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004044 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004045 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004046 }
4047
Ian Rogersdd7624d2014-03-14 17:43:00 -07004048 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004049
4050 // Remove the stack overflow protection if is it set up.
4051 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4052 if (implicit_stack_check) {
4053 if (!UnprotectStack()) {
4054 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4055 }
4056 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004057}
4058
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004059void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004060 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004061 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004062 tlsPtr_.thread_local_start = start;
4063 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4064 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004065 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004066 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004067}
4068
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004069bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004070 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004071 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004072 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004073 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004074 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004075 }
4076 return has_tlab;
4077}
4078
Elliott Hughes330304d2011-08-12 14:28:05 -07004079std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004080 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004081 return os;
4082}
4083
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004084bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004085 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4086 VLOG(threads) << "Protecting stack at " << pregion;
4087 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004088 if (fatal_on_error) {
4089 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4090 "Reason: "
4091 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4092 }
4093 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004094 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004095 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004096}
4097
4098bool Thread::UnprotectStack() {
4099 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4100 VLOG(threads) << "Unprotecting stack at " << pregion;
4101 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4102}
4103
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004104void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4105 CHECK(Dbg::IsDebuggerActive());
4106 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4107 CHECK(ssc != nullptr);
4108 tlsPtr_.single_step_control = ssc;
4109}
4110
4111void Thread::DeactivateSingleStepControl() {
4112 CHECK(Dbg::IsDebuggerActive());
4113 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4114 SingleStepControl* ssc = GetSingleStepControl();
4115 tlsPtr_.single_step_control = nullptr;
4116 delete ssc;
4117}
Dave Allison648d7112014-07-25 16:15:27 -07004118
Sebastien Hertz1558b572015-02-25 15:05:59 +01004119void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4120 CHECK(Dbg::IsDebuggerActive());
4121 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4122 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4123 CHECK(req != nullptr);
4124 tlsPtr_.debug_invoke_req = req;
4125}
4126
4127void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004128 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4129 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004130 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004131 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004132 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004133}
4134
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004135void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4136 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004137 tlsPtr_.method_verifier = verifier;
4138}
4139
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004140void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004141 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004142 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004143}
4144
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004145size_t Thread::NumberOfHeldMutexes() const {
4146 size_t count = 0;
4147 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004148 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004149 }
4150 return count;
4151}
4152
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004153void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4154 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4155 ClearException();
4156 ShadowFrame* shadow_frame =
4157 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004158 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004159 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004160 DeoptimizationMethodType method_type;
4161 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004162 SetTopOfStack(nullptr);
4163 SetTopOfShadowStack(shadow_frame);
4164
4165 // Restore the exception that was pending before deoptimization then interpret the
4166 // deoptimized frames.
4167 if (pending_exception != nullptr) {
4168 SetException(pending_exception);
4169 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004170 interpreter::EnterInterpreterFromDeoptimize(this,
4171 shadow_frame,
4172 result,
4173 from_code,
4174 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004175}
4176
Alex Light848574c2017-09-25 16:59:39 -07004177void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4178 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004179 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004180 if (kIsDebugBuild) {
4181 // Make sure we are in a checkpoint.
4182 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4183 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4184 << "It doesn't look like this was called in a checkpoint! this: "
4185 << this << " count: " << GetSuspendCount();
4186 }
4187 tlsPtr_.async_exception = new_exception.Ptr();
4188}
4189
4190bool Thread::ObserveAsyncException() {
4191 DCHECK(this == Thread::Current());
4192 if (tlsPtr_.async_exception != nullptr) {
4193 if (tlsPtr_.exception != nullptr) {
4194 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4195 << tlsPtr_.exception->Dump();
4196 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4197 }
4198 tlsPtr_.exception = tlsPtr_.async_exception;
4199 tlsPtr_.async_exception = nullptr;
4200 return true;
4201 } else {
4202 return IsExceptionPending();
4203 }
4204}
4205
Mathieu Chartier0795f232016-09-27 18:43:30 -07004206void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004207 CHECK(new_exception != nullptr);
4208 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004209 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004210}
4211
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004212bool Thread::IsAotCompiler() {
4213 return Runtime::Current()->IsAotCompiler();
4214}
4215
Andreas Gampe202f85a2017-02-06 10:23:26 -08004216mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004217 DCHECK(tlsPtr_.jpeer == nullptr);
4218 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004219 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4220 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4221 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4222 // mark/forward it here.
4223 peer = art::ReadBarrier::Mark(peer);
4224 }
4225 return peer;
4226}
4227
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004228void Thread::SetReadBarrierEntrypoints() {
4229 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004230 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004231}
4232
David Srbecky912f36c2018-09-08 12:22:58 +01004233void Thread::ClearAllInterpreterCaches() {
4234 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004235 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004236 thread->GetInterpreterCache()->Clear(thread);
4237 }
4238 } closure;
4239 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4240}
4241
Orion Hodson119733d2019-01-30 15:14:41 +00004242
Andreas Gampee5d23982019-01-08 10:34:26 -08004243void Thread::ReleaseLongJumpContextInternal() {
4244 // Each QuickExceptionHandler gets a long jump context and uses
4245 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4246 // Both finding catch blocks and deoptimization can trigger another
4247 // exception such as a result of class loading. So there can be nested
4248 // cases of exception handling and multiple contexts being used.
4249 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4250 // for reuse so there is no need to always allocate a new one each time when
4251 // getting a context. Since we only keep one context for reuse, delete the
4252 // existing one since the passed in context is yet to be used for longjump.
4253 delete tlsPtr_.long_jump_context;
4254}
4255
Orion Hodson119733d2019-01-30 15:14:41 +00004256void Thread::SetNativePriority(int new_priority) {
4257 // ART tests on JVM can reach this code path, use tid = 0 as shorthand for current thread.
4258 PaletteStatus status = PaletteSchedSetPriority(0, new_priority);
4259 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4260}
4261
4262int Thread::GetNativePriority() {
4263 int priority = 0;
4264 // ART tests on JVM can reach this code path, use tid = 0 as shorthand for current thread.
4265 PaletteStatus status = PaletteSchedGetPriority(0, &priority);
4266 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4267 return priority;
4268}
4269
Alex Lighte0b2ce42019-02-21 19:23:42 +00004270bool Thread::IsSystemDaemon() const {
4271 if (GetPeer() == nullptr) {
4272 return false;
4273 }
4274 return jni::DecodeArtField(
4275 WellKnownClasses::java_lang_Thread_systemDaemon)->GetBoolean(GetPeer());
4276}
4277
Alex Lightb7c640d2019-03-20 15:52:13 -07004278ScopedExceptionStorage::ScopedExceptionStorage(art::Thread* self)
4279 : self_(self), hs_(self_), excp_(hs_.NewHandle<art::mirror::Throwable>(self_->GetException())) {
4280 self_->ClearException();
4281}
4282
Alex Light79d6c802019-06-27 15:50:11 +00004283void ScopedExceptionStorage::SuppressOldException(const char* message) {
4284 CHECK(self_->IsExceptionPending()) << *self_;
4285 ObjPtr<mirror::Throwable> old_suppressed(excp_.Get());
4286 excp_.Assign(self_->GetException());
4287 LOG(WARNING) << message << "Suppressing old exception: " << old_suppressed->Dump();
4288 self_->ClearException();
4289}
4290
Alex Lightb7c640d2019-03-20 15:52:13 -07004291ScopedExceptionStorage::~ScopedExceptionStorage() {
Alex Light79d6c802019-06-27 15:50:11 +00004292 CHECK(!self_->IsExceptionPending()) << *self_;
Alex Lightb7c640d2019-03-20 15:52:13 -07004293 if (!excp_.IsNull()) {
4294 self_->SetException(excp_.Get());
4295 }
4296}
4297
Elliott Hughes8daa0922011-09-11 13:46:25 -07004298} // namespace art