blob: 4ade7c7c64d67835bce11e7c9336629cae51e1eb [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"
David Sehr891a50e2017-10-27 17:01:07 -070049#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070050#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080051#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070052#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070053#include "base/systrace.h"
Hans Boehmca834382020-08-26 21:41:13 -070054#include "base/time_utils.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 Marko5868ada2020-05-12 11:50:34 +010059#include "class_root-inl.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"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010077#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070078#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010079#include "jni/java_vm_ext.h"
80#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070081#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070082#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070083#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080084#include "mirror/object_array-inl.h"
85#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070086#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080087#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070088#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070089#include "nativehelper/scoped_local_ref.h"
90#include "nativehelper/scoped_utf_chars.h"
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +000091#include "nterp_helpers.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"
Alex Light55eccdf2019-10-07 13:51:13 +0000101#include "reflective_handle_scope-inl.h"
David Srbecky28f6cff2018-10-16 15:07:28 +0100102#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700103#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800104#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700105#include "scoped_thread_state_change-inl.h"
Calin Juravle2c2724c2021-01-14 19:54:23 -0800106#include "scoped_disable_public_sdk_checker.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700107#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100108#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700109#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700110#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700111#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800112#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700113#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700114
Yu Lieac44242015-06-29 10:50:03 +0800115#if ART_USE_FUTEXES
116#include "linux/futex.h"
117#include "sys/syscall.h"
118#ifndef SYS_futex
119#define SYS_futex __NR_futex
120#endif
121#endif // ART_USE_FUTEXES
122
Eric Holkf1e1dd12020-08-21 15:38:12 -0700123#pragma clang diagnostic push
124#pragma clang diagnostic error "-Wconversion"
125
Carl Shapirob5573532011-07-12 18:22:59 -0700126namespace art {
127
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800128using android::base::StringAppendV;
129using android::base::StringPrintf;
130
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700131extern "C" NO_RETURN void artDeoptimize(Thread* self);
132
Ian Rogers0878d652013-04-18 17:38:35 -0700133bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700134pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800135ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700136const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100137bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100138Thread* Thread::jit_sensitive_thread_ = nullptr;
Andreas Gampe82372002019-07-24 15:42:09 -0700139#ifndef __BIONIC__
140thread_local Thread* Thread::self_tls_ = nullptr;
141#endif
Calin Juravleb2771b42016-04-07 17:09:25 +0100142
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700143static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700144
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700145// For implicit overflow checks we reserve an extra piece of memory at the bottom
146// of the stack (lowest memory). The higher portion of the memory
147// is protected against reads and the lower is available for use while
148// throwing the StackOverflow exception.
149constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
150
Elliott Hughes7dc51662012-05-16 14:48:43 -0700151static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
152
Ian Rogers5d76c432011-10-31 21:42:49 -0700153void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700154 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700155}
156
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700157static void UnimplementedEntryPoint() {
158 UNIMPLEMENTED(FATAL);
159}
160
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700161void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700162void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800163
164void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
165 CHECK(kUseReadBarrier);
166 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700167 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800168}
Ian Rogers7655f292013-07-29 11:07:13 -0700169
Ian Rogers848871b2013-08-05 10:56:33 -0700170void Thread::InitTlsEntryPoints() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800171 ScopedTrace trace("InitTlsEntryPoints");
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700172 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700173 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800174 uintptr_t* end = reinterpret_cast<uintptr_t*>(
175 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700176 for (uintptr_t* it = begin; it != end; ++it) {
177 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
178 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700179 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700180}
181
Lokesh Gidra7e678d32020-04-28 16:17:49 -0700182void Thread::ResetQuickAllocEntryPointsForThread() {
183 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700184}
185
Sebastien Hertz07474662015-08-25 15:12:33 +0000186class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200187 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100188 DeoptimizationContextRecord(const JValue& ret_val,
189 bool is_reference,
190 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800191 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700192 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000193 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100194 : ret_val_(ret_val),
195 is_reference_(is_reference),
196 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800197 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700198 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000199 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200200
201 JValue GetReturnValue() const { return ret_val_; }
202 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100203 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800204 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000205 DeoptimizationContextRecord* GetLink() const { return link_; }
206 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200207 DCHECK(is_reference_);
208 return ret_val_.GetGCRoot();
209 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000210 mirror::Object** GetPendingExceptionAsGCRoot() {
211 return reinterpret_cast<mirror::Object**>(&pending_exception_);
212 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700213 DeoptimizationMethodType GetDeoptimizationMethodType() const {
214 return deopt_method_type_;
215 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200216
217 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000218 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200219 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200220
Sebastien Hertz07474662015-08-25 15:12:33 +0000221 // Indicates whether the returned value is a reference. If so, the GC will visit it.
222 const bool is_reference_;
223
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100224 // Whether the context was created from an explicit deoptimization in the code.
225 const bool from_code_;
226
Sebastien Hertz07474662015-08-25 15:12:33 +0000227 // The exception that was pending before deoptimization (or null if there was no pending
228 // exception).
229 mirror::Throwable* pending_exception_;
230
Mingyao Yang2ee17902017-08-30 11:37:08 -0700231 // Whether the context was created for an (idempotent) runtime method.
232 const DeoptimizationMethodType deopt_method_type_;
233
Sebastien Hertz07474662015-08-25 15:12:33 +0000234 // A link to the previous DeoptimizationContextRecord.
235 DeoptimizationContextRecord* const link_;
236
237 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200238};
239
240class StackedShadowFrameRecord {
241 public:
242 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
243 StackedShadowFrameType type,
244 StackedShadowFrameRecord* link)
245 : shadow_frame_(shadow_frame),
246 type_(type),
247 link_(link) {}
248
249 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
250 StackedShadowFrameType GetType() const { return type_; }
251 StackedShadowFrameRecord* GetLink() const { return link_; }
252
253 private:
254 ShadowFrame* const shadow_frame_;
255 const StackedShadowFrameType type_;
256 StackedShadowFrameRecord* const link_;
257
258 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
259};
260
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100261void Thread::PushDeoptimizationContext(const JValue& return_value,
262 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700263 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100264 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700265 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000266 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
267 return_value,
268 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100269 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000270 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700271 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000272 tlsPtr_.deoptimization_context_stack);
273 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700274}
275
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100276void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800277 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700278 bool* from_code,
279 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000280 AssertHasDeoptimizationContext();
281 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
282 tlsPtr_.deoptimization_context_stack = record->GetLink();
283 result->SetJ(record->GetReturnValue().GetJ());
284 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100285 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700286 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700287 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000288}
289
290void Thread::AssertHasDeoptimizationContext() {
291 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
292 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800293}
294
Charles Mungeraa31f492018-11-01 18:57:38 +0000295enum {
296 kPermitAvailable = 0, // Incrementing consumes the permit
297 kNoPermit = 1, // Incrementing marks as waiter waiting
298 kNoPermitWaiterWaiting = 2
299};
300
301void Thread::Park(bool is_absolute, int64_t time) {
302 DCHECK(this == Thread::Current());
303#if ART_USE_FUTEXES
304 // Consume the permit, or mark as waiting. This cannot cause park_state to go
305 // outside of its valid range (0, 1, 2), because in all cases where 2 is
306 // assigned it is set back to 1 before returning, and this method cannot run
307 // concurrently with itself since it operates on the current thread.
308 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
309 if (old_state == kNoPermit) {
310 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800311 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Munger5cc0e752018-11-09 12:30:46 -0800312 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000313 if (!is_absolute && time == 0) {
314 // Thread.getState() is documented to return waiting for untimed parks.
315 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
316 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
Charles Mungered19c672019-02-21 15:32:32 -0800317 int result = futex(tls32_.park_state_.Address(),
Charles Mungeraa31f492018-11-01 18:57:38 +0000318 FUTEX_WAIT_PRIVATE,
319 /* sleep if val = */ kNoPermitWaiterWaiting,
320 /* timeout */ nullptr,
321 nullptr,
322 0);
Charles Mungered19c672019-02-21 15:32:32 -0800323 // This errno check must happen before the scope is closed, to ensure that
324 // no destructors (such as ScopedThreadSuspension) overwrite errno.
325 if (result == -1) {
326 switch (errno) {
327 case EAGAIN:
328 FALLTHROUGH_INTENDED;
329 case EINTR: break; // park() is allowed to spuriously return
330 default: PLOG(FATAL) << "Failed to park";
331 }
332 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000333 } else if (time > 0) {
334 // Only actually suspend and futex_wait if we're going to wait for some
335 // positive amount of time - the kernel will reject negative times with
336 // EINVAL, and a zero time will just noop.
337
338 // Thread.getState() is documented to return timed wait for timed parks.
339 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
340 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
341 timespec timespec;
Charles Mungered19c672019-02-21 15:32:32 -0800342 int result = 0;
Charles Mungeraa31f492018-11-01 18:57:38 +0000343 if (is_absolute) {
344 // Time is millis when scheduled for an absolute time
345 timespec.tv_nsec = (time % 1000) * 1000000;
Hans Boehm33701432020-08-19 15:05:03 -0700346 timespec.tv_sec = SaturatedTimeT(time / 1000);
Charles Mungeraa31f492018-11-01 18:57:38 +0000347 // This odd looking pattern is recommended by futex documentation to
348 // wait until an absolute deadline, with otherwise identical behavior to
349 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
350 // correct time when the system clock changes.
351 result = futex(tls32_.park_state_.Address(),
352 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
353 /* sleep if val = */ kNoPermitWaiterWaiting,
354 &timespec,
355 nullptr,
Eric Holkf1e1dd12020-08-21 15:38:12 -0700356 static_cast<int>(FUTEX_BITSET_MATCH_ANY));
Charles Mungeraa31f492018-11-01 18:57:38 +0000357 } else {
358 // Time is nanos when scheduled for a relative time
Hans Boehm33701432020-08-19 15:05:03 -0700359 timespec.tv_sec = SaturatedTimeT(time / 1000000000);
Charles Mungeraa31f492018-11-01 18:57:38 +0000360 timespec.tv_nsec = time % 1000000000;
361 result = futex(tls32_.park_state_.Address(),
362 FUTEX_WAIT_PRIVATE,
363 /* sleep if val = */ kNoPermitWaiterWaiting,
364 &timespec,
365 nullptr,
366 0);
367 }
Charles Mungered19c672019-02-21 15:32:32 -0800368 // This errno check must happen before the scope is closed, to ensure that
369 // no destructors (such as ScopedThreadSuspension) overwrite errno.
370 if (result == -1) {
371 switch (errno) {
372 case ETIMEDOUT:
373 timed_out = true;
374 FALLTHROUGH_INTENDED;
375 case EAGAIN:
376 case EINTR: break; // park() is allowed to spuriously return
377 default: PLOG(FATAL) << "Failed to park";
378 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000379 }
380 }
381 // Mark as no longer waiting, and consume permit if there is one.
382 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
383 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800384 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000385 } else {
386 // the fetch_add has consumed the permit. immediately return.
387 DCHECK_EQ(old_state, kPermitAvailable);
388 }
389#else
390 #pragma clang diagnostic push
391 #pragma clang diagnostic warning "-W#warnings"
392 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
393 #pragma clang diagnostic pop
394 UNUSED(is_absolute, time);
395 UNIMPLEMENTED(WARNING);
396 sched_yield();
397#endif
398}
399
400void Thread::Unpark() {
401#if ART_USE_FUTEXES
402 // Set permit available; will be consumed either by fetch_add (when the thread
403 // tries to park) or store (when the parked thread is woken up)
404 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
405 == kNoPermitWaiterWaiting) {
406 int result = futex(tls32_.park_state_.Address(),
407 FUTEX_WAKE_PRIVATE,
408 /* number of waiters = */ 1,
409 nullptr,
410 nullptr,
411 0);
412 if (result == -1) {
413 PLOG(FATAL) << "Failed to unpark";
414 }
415 }
416#else
417 UNIMPLEMENTED(WARNING);
418#endif
419}
420
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700421void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
422 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
423 sf, type, tlsPtr_.stacked_shadow_frame_record);
424 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800425}
426
Andreas Gampe639bdd12015-06-03 11:22:45 -0700427ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700428 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700429 if (must_be_present) {
430 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700431 } else {
432 if (record == nullptr || record->GetType() != type) {
433 return nullptr;
434 }
435 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700436 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
437 ShadowFrame* shadow_frame = record->GetShadowFrame();
438 delete record;
439 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700440}
441
Mingyao Yang99170c62015-07-06 11:10:37 -0700442class FrameIdToShadowFrame {
443 public:
444 static FrameIdToShadowFrame* Create(size_t frame_id,
445 ShadowFrame* shadow_frame,
446 FrameIdToShadowFrame* next,
447 size_t num_vregs) {
448 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
449 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
450 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
451 }
452
453 static void Delete(FrameIdToShadowFrame* f) {
454 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
455 delete[] memory;
456 }
457
458 size_t GetFrameId() const { return frame_id_; }
459 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
460 FrameIdToShadowFrame* GetNext() const { return next_; }
461 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
462 bool* GetUpdatedVRegFlags() {
463 return updated_vreg_flags_;
464 }
465
466 private:
467 FrameIdToShadowFrame(size_t frame_id,
468 ShadowFrame* shadow_frame,
469 FrameIdToShadowFrame* next)
470 : frame_id_(frame_id),
471 shadow_frame_(shadow_frame),
472 next_(next) {}
473
474 const size_t frame_id_;
475 ShadowFrame* const shadow_frame_;
476 FrameIdToShadowFrame* next_;
477 bool updated_vreg_flags_[0];
478
479 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
480};
481
482static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
483 size_t frame_id) {
484 FrameIdToShadowFrame* found = nullptr;
485 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
486 if (record->GetFrameId() == frame_id) {
487 if (kIsDebugBuild) {
David Srbecky346fd962020-07-27 16:51:00 +0100488 // Check we have at most one record for this frame.
Mingyao Yang99170c62015-07-06 11:10:37 -0700489 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
490 found = record;
491 } else {
492 return record;
493 }
494 }
495 }
496 return found;
497}
498
499ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
500 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
501 tlsPtr_.frame_id_to_shadow_frame, frame_id);
502 if (record != nullptr) {
503 return record->GetShadowFrame();
504 }
505 return nullptr;
506}
507
508// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
509bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
510 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
511 tlsPtr_.frame_id_to_shadow_frame, frame_id);
512 CHECK(record != nullptr);
513 return record->GetUpdatedVRegFlags();
514}
515
516ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
517 uint32_t num_vregs,
518 ArtMethod* method,
519 uint32_t dex_pc) {
520 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
521 if (shadow_frame != nullptr) {
522 return shadow_frame;
523 }
David Sehr709b0702016-10-13 09:12:37 -0700524 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700525 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
526 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
527 shadow_frame,
528 tlsPtr_.frame_id_to_shadow_frame,
529 num_vregs);
530 for (uint32_t i = 0; i < num_vregs; i++) {
531 // Do this to clear all references for root visitors.
532 shadow_frame->SetVRegReference(i, nullptr);
533 // This flag will be changed to true if the debugger modifies the value.
534 record->GetUpdatedVRegFlags()[i] = false;
535 }
536 tlsPtr_.frame_id_to_shadow_frame = record;
537 return shadow_frame;
538}
539
Alex Light184f0752018-07-13 11:18:22 -0700540TLSData* Thread::GetCustomTLS(const char* key) {
541 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
542 auto it = custom_tls_.find(key);
543 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
544}
545
546void Thread::SetCustomTLS(const char* key, TLSData* data) {
547 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
548 // custom_tls_lock_.
549 std::unique_ptr<TLSData> old_data(data);
550 {
551 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
552 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
553 }
554}
555
Mingyao Yang99170c62015-07-06 11:10:37 -0700556void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
557 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
558 if (head->GetFrameId() == frame_id) {
559 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
560 FrameIdToShadowFrame::Delete(head);
561 return;
562 }
563 FrameIdToShadowFrame* prev = head;
564 for (FrameIdToShadowFrame* record = head->GetNext();
565 record != nullptr;
566 prev = record, record = record->GetNext()) {
567 if (record->GetFrameId() == frame_id) {
568 prev->SetNext(record->GetNext());
569 FrameIdToShadowFrame::Delete(record);
570 return;
571 }
572 }
573 LOG(FATAL) << "No shadow frame for frame " << frame_id;
574 UNREACHABLE();
575}
576
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700577void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700578 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700579}
580
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700581void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700582 // One thread (us) survived the fork, but we have a new tid so we need to
583 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700584 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700585}
586
Alex Light4847a072019-12-12 16:13:47 -0800587void Thread::DeleteJPeer(JNIEnv* env) {
588 // Make sure nothing can observe both opeer and jpeer set at the same time.
589 jobject old_jpeer = tlsPtr_.jpeer;
590 CHECK(old_jpeer != nullptr);
591 tlsPtr_.jpeer = nullptr;
592 env->DeleteGlobalRef(old_jpeer);
593}
594
Brian Carlstrom78128a62011-09-15 17:21:19 -0700595void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700596 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700597 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800598 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700599 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800600 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700601 }
602 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700603 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
604 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800605 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700606 // Check that if we got here we cannot be shutting down (as shutdown should never have started
607 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700608 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700609 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
610 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
611 // the runtime in such a case. In case this ever changes, we need to make sure here to
612 // delete the tmp_jni_env, as we own it at this point.
613 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
614 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700615 Runtime::Current()->EndThreadBirth();
616 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700617 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700618 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800619 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800620
621 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700622 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700623 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Alex Light4847a072019-12-12 16:13:47 -0800624 // Make sure nothing can observe both opeer and jpeer set at the same time.
625 self->DeleteJPeer(self->GetJniEnv());
Andreas Gampe08883de2016-11-08 13:20:52 -0800626 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100627
Andreas Gampe08883de2016-11-08 13:20:52 -0800628 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100629 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000630
Andreas Gampeac30fa22017-01-18 21:02:36 -0800631 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700632
Charles Mungeraa31f492018-11-01 18:57:38 +0000633 // Unpark ourselves if the java peer was unparked before it started (see
634 // b/28845097#comment49 for more information)
635
636 ArtField* unparkedField = jni::DecodeArtField(
637 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
638 bool should_unpark = false;
639 {
640 // Hold the lock here, so that if another thread calls unpark before the thread starts
641 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
642 // which could cause a lost unpark.
643 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
644 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
645 }
646 if (should_unpark) {
647 self->Unpark();
648 }
Ian Rogers365c1022012-06-22 15:05:28 -0700649 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800650 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700651 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700652 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
653 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700654 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700655 // Detach and delete self.
656 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700657
Dave Allison0aded082013-11-07 13:15:11 -0800658 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700659}
660
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700661Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800662 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800663 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100664 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
David Srbecky346fd962020-07-27 16:51:00 +0100665 // Check that if we have a result it is either suspended or we hold the thread_list_lock_
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700666 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700667 if (kIsDebugBuild) {
668 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800669 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700670 Locks::thread_list_lock_->AssertHeld(soa.Self());
671 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700672 }
673 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800674}
675
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700676Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
677 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100678 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700679}
680
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700681static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700682 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700683 if (stack_size == 0) {
684 stack_size = Runtime::Current()->GetDefaultStackSize();
685 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700686
Brian Carlstrom6414a972012-04-14 14:20:04 -0700687 // Dalvik used the bionic pthread default stack size for native threads,
688 // so include that here to support apps that expect large native stacks.
689 stack_size += 1 * MB;
690
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700691 // Under sanitization, frames of the interpreter may become bigger, both for C code as
692 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
693 // of all core classes cannot be done in all test circumstances.
694 if (kMemoryToolIsAvailable) {
695 stack_size = std::max(2 * MB, stack_size);
696 }
697
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700698 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
699 if (stack_size < PTHREAD_STACK_MIN) {
700 stack_size = PTHREAD_STACK_MIN;
701 }
702
Dave Allisonf9439142014-03-27 15:10:22 -0700703 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
704 // It's likely that callers are trying to ensure they have at least a certain amount of
705 // stack space, so we should add our reserved space on top of what they requested, rather
706 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700707 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700708 } else {
709 // If we are going to use implicit stack checks, allocate space for the protected
710 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000711 stack_size += Thread::kStackOverflowImplicitCheckSize +
712 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700713 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700714
715 // Some systems require the stack size to be a multiple of the system page size, so round up.
716 stack_size = RoundUp(stack_size, kPageSize);
717
718 return stack_size;
719}
720
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700721// Return the nearest page-aligned address below the current stack top.
722NO_INLINE
723static uint8_t* FindStackTop() {
724 return reinterpret_cast<uint8_t*>(
725 AlignDown(__builtin_frame_address(0), kPageSize));
726}
727
Dave Allisonf9439142014-03-27 15:10:22 -0700728// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700729// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700730ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700731void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700732 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700733 // Page containing current top of stack.
734 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700735
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700736 // Try to directly protect the stack.
737 VLOG(threads) << "installing stack protected region at " << std::hex <<
738 static_cast<void*>(pregion) << " to " <<
739 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700740 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700741 // Tell the kernel that we won't be needing these pages any more.
742 // NB. madvise will probably write zeroes into the memory (on linux it does).
Eric Holkf1e1dd12020-08-21 15:38:12 -0700743 size_t unwanted_size =
744 reinterpret_cast<uintptr_t>(stack_top) - reinterpret_cast<uintptr_t>(pregion) - kPageSize;
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700745 madvise(pregion, unwanted_size, MADV_DONTNEED);
746 return;
747 }
748
749 // There is a little complexity here that deserves a special mention. On some
750 // architectures, the stack is created using a VM_GROWSDOWN flag
751 // to prevent memory being allocated when it's not needed. This flag makes the
752 // kernel only allocate memory for the stack by growing down in memory. Because we
753 // want to put an mprotected region far away from that at the stack top, we need
754 // to make sure the pages for the stack are mapped in before we call mprotect.
755 //
756 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
757 // with a non-mapped stack (usually only the main thread).
758 //
759 // We map in the stack by reading every page from the stack bottom (highest address)
760 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700761 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700762 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700763 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
764 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
765 // thus have to move the stack pointer. We do this portably by using a recursive function with a
766 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700767
Andreas Gampe6c63f862017-06-28 17:20:15 -0700768 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700769 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700770 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000771
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700772 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
773 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000774
Andreas Gampe6c63f862017-06-28 17:20:15 -0700775 struct RecurseDownStack {
776 // This function has an intentionally large stack size.
777#pragma GCC diagnostic push
778#pragma GCC diagnostic ignored "-Wframe-larger-than="
779 NO_INLINE
780 static void Touch(uintptr_t target) {
781 volatile size_t zero = 0;
782 // Use a large local volatile array to ensure a large frame size. Do not use anything close
783 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
784 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700785 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
786 constexpr size_t kAsanMultiplier =
787#ifdef ADDRESS_SANITIZER
788 2u;
789#else
790 1u;
791#endif
Stephen Hines469016b2020-01-22 17:50:41 -0800792 // Keep space uninitialized as it can overflow the stack otherwise (should Clang actually
793 // auto-initialize this local variable).
794 volatile char space[kPageSize - (kAsanMultiplier * 256)] __attribute__((uninitialized));
Andreas Gampee383d232018-06-19 12:29:51 -0700795 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700796 // Remove tag from the pointer. Nop in non-hwasan builds.
797 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
798 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700799 Touch(target);
800 }
801 zero *= 2; // Try to avoid tail recursion.
802 }
803#pragma GCC diagnostic pop
804 };
805 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000806
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700807 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700808 static_cast<void*>(pregion) << " to " <<
809 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
810
Dave Allison648d7112014-07-25 16:15:27 -0700811 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700812 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700813
814 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000815 // NB. madvise will probably write zeroes into the memory (on linux it does).
Eric Holkf1e1dd12020-08-21 15:38:12 -0700816 size_t unwanted_size =
817 reinterpret_cast<uintptr_t>(stack_top) - reinterpret_cast<uintptr_t>(pregion) - kPageSize;
Dave Allison648d7112014-07-25 16:15:27 -0700818 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700819}
820
Ian Rogers120f1c72012-09-28 17:17:10 -0700821void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800822 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800823 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700824
825 if (VLOG_IS_ON(threads)) {
826 ScopedObjectAccess soa(env);
827
Andreas Gampe08883de2016-11-08 13:20:52 -0800828 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700829 ObjPtr<mirror::String> java_name =
830 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700831 std::string thread_name;
832 if (java_name != nullptr) {
833 thread_name = java_name->ToModifiedUtf8();
834 } else {
835 thread_name = "(Unnamed)";
836 }
837
838 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700839 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700840 }
841
Ian Rogers120f1c72012-09-28 17:17:10 -0700842 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700843
Ian Rogers120f1c72012-09-28 17:17:10 -0700844 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
845 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700846 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700847 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700848 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700849 thread_start_during_shutdown = true;
850 } else {
851 runtime->StartThreadBirth();
852 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700853 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700854 if (thread_start_during_shutdown) {
855 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
856 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
857 return;
858 }
859
860 Thread* child_thread = new Thread(is_daemon);
861 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700862 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700863 stack_size = FixStackSize(stack_size);
864
Roland Levillain2ae376f2018-01-30 11:35:11 +0000865 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
866 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800867 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
868 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700869
Andreas Gampe449357d2015-06-01 22:29:51 -0700870 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
871 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100872 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700873 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100874 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700875
Andreas Gampe449357d2015-06-01 22:29:51 -0700876 int pthread_create_result = 0;
877 if (child_jni_env_ext.get() != nullptr) {
878 pthread_t new_pthread;
879 pthread_attr_t attr;
880 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
881 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
882 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
883 "PTHREAD_CREATE_DETACHED");
884 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
885 pthread_create_result = pthread_create(&new_pthread,
886 &attr,
887 Thread::CreateCallback,
888 child_thread);
889 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
890
891 if (pthread_create_result == 0) {
892 // pthread_create started the new thread. The child is now responsible for managing the
893 // JNIEnvExt we created.
894 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
895 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700896 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700897 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700898 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700899 }
900
901 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
902 {
903 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
904 runtime->EndThreadBirth();
905 }
Alex Light4847a072019-12-12 16:13:47 -0800906 // Manually delete the global reference since Thread::Init will not have been run. Make sure
907 // nothing can observe both opeer and jpeer set at the same time.
908 child_thread->DeleteJPeer(env);
Andreas Gampe449357d2015-06-01 22:29:51 -0700909 delete child_thread;
910 child_thread = nullptr;
911 // TODO: remove from thread group?
912 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
913 {
914 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100915 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700916 StringPrintf("pthread_create (%s stack) failed: %s",
917 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
918 ScopedObjectAccess soa(env);
919 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700920 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700921}
922
Andreas Gampe449357d2015-06-01 22:29:51 -0700923bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700924 // This function does all the initialization that must be run by the native thread it applies to.
925 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
926 // we can handshake with the corresponding native thread when it's ready.) Check this native
927 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800928 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800929
930 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
931 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
932 tlsPtr_.pthread_self = pthread_self();
933 CHECK(is_started_);
934
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800935 ScopedTrace trace("Thread::Init");
936
Elliott Hughesd8af1592012-04-16 20:40:15 -0700937 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800938 if (!InitStackHwm()) {
939 return false;
940 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700941 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700942 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800943 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700944 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700945 InitTid();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800946
Andreas Gampea47a6e82019-07-24 09:46:16 -0700947#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000948 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
949#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700950 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe82372002019-07-24 15:42:09 -0700951 Thread::self_tls_ = this;
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000952#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700953 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700954
Ian Rogersdd7624d2014-03-14 17:43:00 -0700955 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700956
Andreas Gampe449357d2015-06-01 22:29:51 -0700957 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800958 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
959 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700960 tlsPtr_.jni_env = jni_env_ext;
961 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100962 std::string error_msg;
963 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700964 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100965 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700966 return false;
967 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700968 }
969
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800970 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700971 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800972 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700973}
974
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800975template <typename PeerAction>
976Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700977 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800978 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800979 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900980 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
981 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800982 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700983 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800984 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700985 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800986 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800987 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700988 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900989 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
990 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800991 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700992 } else {
993 Runtime::Current()->StartThreadBirth();
994 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800995 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700996 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800997 if (!init_success) {
998 delete self;
999 return nullptr;
1000 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001001 }
1002 }
Elliott Hughes93e74e82011-09-13 11:07:03 -07001003
Jeff Hao848f70a2014-01-15 13:49:50 -08001004 self->InitStringEntryPoints();
1005
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001006 CHECK_NE(self->GetState(), kRunnable);
1007 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -07001008
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001009 // Run the action that is acting on the peer.
1010 if (!peer_action(self)) {
1011 runtime->GetThreadList()->Unregister(self);
1012 // Unregister deletes self, no need to do this here.
1013 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001014 }
Elliott Hughescac6cc72011-11-03 20:31:21 -07001015
Andreas Gampe56623832015-07-09 21:53:15 -07001016 if (VLOG_IS_ON(threads)) {
1017 if (thread_name != nullptr) {
1018 VLOG(threads) << "Attaching thread " << thread_name;
1019 } else {
1020 VLOG(threads) << "Attaching unnamed thread.";
1021 }
1022 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001023 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001024 }
1025
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001026 {
1027 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001028 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001029 }
1030
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001031 return self;
1032}
1033
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001034Thread* Thread::Attach(const char* thread_name,
1035 bool as_daemon,
1036 jobject thread_group,
1037 bool create_peer) {
1038 auto create_peer_action = [&](Thread* self) {
1039 // If we're the main thread, ClassLinker won't be created until after we're attached,
1040 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1041 // In the compiler, all threads need this hack, because no-one's going to be getting
1042 // a native peer!
1043 if (create_peer) {
1044 self->CreatePeer(thread_name, as_daemon, thread_group);
1045 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001046 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
Vladimir Marko1b3fb622021-02-08 10:54:38 +00001047 // the failure but do not dump the exception details. If we fail to allocate the peer, we
1048 // usually also fail to allocate an exception object and throw a pre-allocated OOME without
1049 // any useful information. If we do manage to allocate the exception object, the memory
1050 // information in the message could have been collected too late and therefore misleading.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001051 {
1052 ScopedObjectAccess soa(self);
Vladimir Marko1b3fb622021-02-08 10:54:38 +00001053 LOG(ERROR) << "Exception creating thread peer: "
1054 << ((thread_name != nullptr) ? thread_name : "<null>");
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001055 self->ClearException();
1056 }
1057 return false;
1058 }
1059 } else {
1060 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1061 if (thread_name != nullptr) {
1062 self->tlsPtr_.name->assign(thread_name);
1063 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001064 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001065 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1066 }
1067 }
1068 return true;
1069 };
1070 return Attach(thread_name, as_daemon, create_peer_action);
1071}
1072
1073Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1074 auto set_peer_action = [&](Thread* self) {
1075 // Install the given peer.
1076 {
1077 DCHECK(self == Thread::Current());
1078 ScopedObjectAccess soa(self);
1079 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1080 }
1081 self->GetJniEnv()->SetLongField(thread_peer,
1082 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001083 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001084 return true;
1085 };
1086 return Attach(thread_name, as_daemon, set_peer_action);
1087}
1088
Ian Rogers365c1022012-06-22 15:05:28 -07001089void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1090 Runtime* runtime = Runtime::Current();
1091 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001092 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001093
Dave Allison0aded082013-11-07 13:15:11 -08001094 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001095 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001096 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001097 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001098 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001099 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001100 CHECK(IsExceptionPending());
1101 return;
1102 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001103 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001104 jboolean thread_is_daemon = as_daemon;
1105
Elliott Hugheseac76672012-05-24 21:56:51 -07001106 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001107 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001108 CHECK(IsExceptionPending());
1109 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001110 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001111 {
1112 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001113 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001114 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001115 env->CallNonvirtualVoidMethod(peer.get(),
1116 WellKnownClasses::java_lang_Thread,
1117 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001118 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001119 if (IsExceptionPending()) {
1120 return;
1121 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001122
Ian Rogers120f1c72012-09-28 17:17:10 -07001123 Thread* self = this;
1124 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001125 env->SetLongField(peer.get(),
1126 WellKnownClasses::java_lang_Thread_nativePeer,
1127 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001128
1129 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001130 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001131 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001132 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001133 // The Thread constructor should have set the Thread.name to a
1134 // non-null value. However, because we can run without code
1135 // available (in the compiler, in tests), we manually assign the
1136 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001137 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001138 InitPeer<true>(soa,
1139 tlsPtr_.opeer,
1140 thread_is_daemon,
1141 thread_group,
1142 thread_name.get(),
1143 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001144 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001145 InitPeer<false>(soa,
1146 tlsPtr_.opeer,
1147 thread_is_daemon,
1148 thread_group,
1149 thread_name.get(),
1150 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001151 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001152 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001153 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001154 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001155 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001156 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001157 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001158}
1159
Andreas Gampebad529d2017-02-13 18:52:10 -08001160jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1161 const char* name,
1162 bool as_daemon,
1163 jobject thread_group) {
1164 Runtime* runtime = Runtime::Current();
1165 CHECK(!runtime->IsStarted());
1166
1167 if (thread_group == nullptr) {
1168 thread_group = runtime->GetMainThreadGroup();
1169 }
1170 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1171 // Add missing null check in case of OOM b/18297817
1172 if (name != nullptr && thread_name.get() == nullptr) {
1173 CHECK(Thread::Current()->IsExceptionPending());
1174 return nullptr;
1175 }
Andreas Gampea1e5b972019-03-18 16:54:25 -07001176 jint thread_priority = kNormThreadPriority; // Always normalize to NORM priority.
Andreas Gampebad529d2017-02-13 18:52:10 -08001177 jboolean thread_is_daemon = as_daemon;
1178
1179 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1180 if (peer.get() == nullptr) {
1181 CHECK(Thread::Current()->IsExceptionPending());
1182 return nullptr;
1183 }
1184
1185 // We cannot call Thread.init, as it will recursively ask for currentThread.
1186
1187 // The Thread constructor should have set the Thread.name to a
1188 // non-null value. However, because we can run without code
1189 // available (in the compiler, in tests), we manually assign the
1190 // fields the constructor should have set.
1191 ScopedObjectAccessUnchecked soa(Thread::Current());
1192 if (runtime->IsActiveTransaction()) {
1193 InitPeer<true>(soa,
1194 soa.Decode<mirror::Object>(peer.get()),
1195 thread_is_daemon,
1196 thread_group,
1197 thread_name.get(),
1198 thread_priority);
1199 } else {
1200 InitPeer<false>(soa,
1201 soa.Decode<mirror::Object>(peer.get()),
1202 thread_is_daemon,
1203 thread_group,
1204 thread_name.get(),
1205 thread_priority);
1206 }
1207
1208 return peer.release();
1209}
1210
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001211template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001212void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1213 ObjPtr<mirror::Object> peer,
1214 jboolean thread_is_daemon,
1215 jobject thread_group,
1216 jobject thread_name,
1217 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001218 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001219 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001220 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001221 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001222 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001223 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001224 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001225 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001226}
1227
Elliott Hughes899e7892012-01-24 14:57:32 -08001228void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001229 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001230 ::art::SetThreadName(name);
1231 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1232}
1233
Andreas Gampe9186ced2016-12-12 14:28:21 -08001234static void GetThreadStack(pthread_t thread,
1235 void** stack_base,
1236 size_t* stack_size,
1237 size_t* guard_size) {
1238#if defined(__APPLE__)
1239 *stack_size = pthread_get_stacksize_np(thread);
1240 void* stack_addr = pthread_get_stackaddr_np(thread);
1241
1242 // Check whether stack_addr is the base or end of the stack.
1243 // (On Mac OS 10.7, it's the end.)
1244 int stack_variable;
1245 if (stack_addr > &stack_variable) {
1246 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1247 } else {
1248 *stack_base = stack_addr;
1249 }
1250
1251 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1252 pthread_attr_t attributes;
1253 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1254 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1255 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1256#else
1257 pthread_attr_t attributes;
1258 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1259 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1260 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1261 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1262
1263#if defined(__GLIBC__)
1264 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1265 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1266 // will be broken because we'll die long before we get close to 2GB.
Eric Holkf1e1dd12020-08-21 15:38:12 -07001267 bool is_main_thread = (::art::GetTid() == static_cast<uint32_t>(getpid()));
Andreas Gampe9186ced2016-12-12 14:28:21 -08001268 if (is_main_thread) {
1269 rlimit stack_limit;
1270 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1271 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1272 }
1273 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1274 size_t old_stack_size = *stack_size;
1275
1276 // Use the kernel default limit as our size, and adjust the base to match.
1277 *stack_size = 8 * MB;
1278 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1279
1280 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1281 << " to " << PrettySize(*stack_size)
1282 << " with base " << *stack_base;
1283 }
1284 }
1285#endif
1286
1287#endif
1288}
1289
Ian Rogersf4d4da12014-11-11 16:10:33 -08001290bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001291 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001292 void* read_stack_base;
1293 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001294 size_t read_guard_size;
1295 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001296
Ian Rogers13735952014-10-08 12:43:28 -07001297 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001298 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001299
Dave Allison648d7112014-07-25 16:15:27 -07001300 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1301 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1302 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1303 // between 8K and 12K.
1304 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1305 + 4 * KB;
1306 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001307 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001308 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1309 __LINE__,
1310 ::android::base::ERROR,
1311 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001312 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001313 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001314
Vladimir Markob8f2f632015-01-02 14:23:26 +00001315 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1316 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1317 read_stack_base,
1318 PrettySize(read_stack_size).c_str(),
1319 PrettySize(read_guard_size).c_str());
1320
Ian Rogers932746a2011-09-22 18:57:50 -07001321 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001322
1323 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001324 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001325
Dave Allisonb090a182014-08-14 17:02:48 +00001326 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001327
1328 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001329 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001330 // The thread might have protected region at the bottom. We need
1331 // to install our own region so we need to move the limits
1332 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001333
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001334 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1335 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
Vladimir Markocedec9d2021-02-08 16:16:13 +00001336 tlsPtr_.stack_size -= read_guard_size + kStackOverflowProtectedSize;
Dave Allison648d7112014-07-25 16:15:27 -07001337
1338 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001339 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001340
David Srbecky346fd962020-07-27 16:51:00 +01001341 // Consistency check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001342 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001343
1344 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001345}
1346
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001347void Thread::ShortDump(std::ostream& os) const {
1348 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001349 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001350 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001351 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001352 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001353 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001354 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001355 << ",Thread*=" << this
1356 << ",peer=" << tlsPtr_.opeer
1357 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1358 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001359}
1360
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001361void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1362 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001363 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001364 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001365}
1366
Vladimir Marko4617d582019-03-28 13:48:31 +00001367ObjPtr<mirror::String> Thread::GetThreadName() const {
Andreas Gampe08883de2016-11-08 13:20:52 -08001368 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001369 if (tlsPtr_.opeer == nullptr) {
1370 return nullptr;
1371 }
1372 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1373 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001374}
1375
Elliott Hughesffb465f2012-03-01 18:46:05 -08001376void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001377 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001378}
1379
Jeff Hao57dac6e2013-08-15 16:36:24 -07001380uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001381#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001382 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001383 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001384 timespec now;
1385 clock_gettime(cpu_clock_id, &now);
Eric Holkf1e1dd12020-08-21 15:38:12 -07001386 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) +
1387 static_cast<uint64_t>(now.tv_nsec) / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001388#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001389 UNIMPLEMENTED(WARNING);
1390 return -1;
1391#endif
1392}
1393
Ian Rogers01ae5802012-09-28 16:14:01 -07001394// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1395static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001396 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001397 Locks::thread_suspend_count_lock_->Unlock(self);
1398 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1399 Locks::mutator_lock_->SharedTryLock(self);
1400 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1401 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1402 }
1403 }
1404 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1405 Locks::thread_list_lock_->TryLock(self);
1406 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1407 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1408 }
1409 }
1410 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001411 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001412 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001413}
1414
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001415bool Thread::ModifySuspendCountInternal(Thread* self,
1416 int delta,
1417 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001418 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001419 if (kIsDebugBuild) {
Alex Light72e27b02020-07-27 12:59:58 -07001420 DCHECK(delta == -1 || delta == +1)
1421 << reason << " " << delta << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001422 Locks::thread_suspend_count_lock_->AssertHeld(self);
1423 if (this != self && !IsSuspended()) {
1424 Locks::thread_list_lock_->AssertHeld(self);
1425 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001426 }
Alex Light88fd7202017-06-30 08:31:59 -07001427 // User code suspensions need to be checked more closely since they originate from code outside of
1428 // the runtime's control.
1429 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1430 Locks::user_code_suspension_lock_->AssertHeld(self);
1431 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1432 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1433 return false;
1434 }
1435 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001436 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001437 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001438 return false;
1439 }
1440
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001441 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1442 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1443 // deadlock. b/31683379.
1444 return false;
1445 }
1446
Yu Lieac44242015-06-29 10:50:03 +08001447 uint16_t flags = kSuspendRequest;
1448 if (delta > 0 && suspend_barrier != nullptr) {
1449 uint32_t available_barrier = kMaxSuspendBarriers;
1450 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1451 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1452 available_barrier = i;
1453 break;
1454 }
1455 }
1456 if (available_barrier == kMaxSuspendBarriers) {
1457 // No barrier spaces available, we can't add another.
1458 return false;
1459 }
1460 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1461 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001462 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001463
Ian Rogersdd7624d2014-03-14 17:43:00 -07001464 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001465 switch (reason) {
Alex Light88fd7202017-06-30 08:31:59 -07001466 case SuspendReason::kForUserCode:
1467 tls32_.user_code_suspend_count += delta;
1468 break;
Alex Light46f93402017-06-29 11:59:50 -07001469 case SuspendReason::kInternal:
1470 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001471 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001472
Ian Rogersdd7624d2014-03-14 17:43:00 -07001473 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001474 AtomicClearFlag(kSuspendRequest);
1475 } else {
Yu Lieac44242015-06-29 10:50:03 +08001476 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001477 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001478 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001479 }
Yu Lieac44242015-06-29 10:50:03 +08001480 return true;
1481}
1482
1483bool Thread::PassActiveSuspendBarriers(Thread* self) {
1484 // Grab the suspend_count lock and copy the current set of
1485 // barriers. Then clear the list and the flag. The ModifySuspendCount
1486 // function requires the lock so we prevent a race between setting
1487 // the kActiveSuspendBarrier flag and clearing it.
1488 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1489 {
1490 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1491 if (!ReadFlag(kActiveSuspendBarrier)) {
1492 // quick exit test: the barriers have already been claimed - this is
1493 // possible as there may be a race to claim and it doesn't matter
1494 // who wins.
1495 // All of the callers of this function (except the SuspendAllInternal)
1496 // will first test the kActiveSuspendBarrier flag without lock. Here
1497 // double-check whether the barrier has been passed with the
1498 // suspend_count lock.
1499 return false;
1500 }
1501
1502 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1503 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1504 tlsPtr_.active_suspend_barriers[i] = nullptr;
1505 }
1506 AtomicClearFlag(kActiveSuspendBarrier);
1507 }
1508
1509 uint32_t barrier_count = 0;
1510 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1511 AtomicInteger* pending_threads = pass_barriers[i];
1512 if (pending_threads != nullptr) {
1513 bool done = false;
1514 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001515 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001516 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1517 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001518 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001519#if ART_USE_FUTEXES
1520 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Hans Boehm81dc7ab2019-04-19 17:34:31 -07001521 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, INT_MAX, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001522 }
1523#endif
1524 } while (!done);
1525 ++barrier_count;
1526 }
1527 }
1528 CHECK_GT(barrier_count, 0U);
1529 return true;
1530}
1531
1532void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1533 CHECK(ReadFlag(kActiveSuspendBarrier));
1534 bool clear_flag = true;
1535 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1536 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1537 if (ptr == target) {
1538 tlsPtr_.active_suspend_barriers[i] = nullptr;
1539 } else if (ptr != nullptr) {
1540 clear_flag = false;
1541 }
1542 }
1543 if (LIKELY(clear_flag)) {
1544 AtomicClearFlag(kActiveSuspendBarrier);
1545 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001546}
1547
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001548void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001549 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1550 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1551 Closure* checkpoint;
1552 {
1553 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1554 checkpoint = tlsPtr_.checkpoint_function;
1555 if (!checkpoint_overflow_.empty()) {
1556 // Overflow list not empty, copy the first one out and continue.
1557 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1558 checkpoint_overflow_.pop_front();
1559 } else {
1560 // No overflow checkpoints. Clear the kCheckpointRequest flag
1561 tlsPtr_.checkpoint_function = nullptr;
1562 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001563 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001564 }
1565 // Outside the lock, run the checkpoint function.
1566 ScopedTrace trace("Run checkpoint function");
1567 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1568 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001569}
1570
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001571void Thread::RunEmptyCheckpoint() {
1572 DCHECK_EQ(Thread::Current(), this);
1573 AtomicClearFlag(kEmptyCheckpointRequest);
1574 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1575}
1576
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001577bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001578 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001579 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001580 if (old_state_and_flags.as_struct.state != kRunnable) {
1581 return false; // Fail, thread is suspended and so can't run a checkpoint.
1582 }
Dave Allison0aded082013-11-07 13:15:11 -08001583
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001584 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001585 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001586 union StateAndFlags new_state_and_flags;
1587 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001588 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001589 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001590 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001591 if (success) {
1592 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1593 if (tlsPtr_.checkpoint_function == nullptr) {
1594 tlsPtr_.checkpoint_function = function;
1595 } else {
1596 checkpoint_overflow_.push_back(function);
1597 }
Dave Allison0aded082013-11-07 13:15:11 -08001598 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001599 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001600 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001601 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001602}
1603
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001604bool Thread::RequestEmptyCheckpoint() {
1605 union StateAndFlags old_state_and_flags;
1606 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1607 if (old_state_and_flags.as_struct.state != kRunnable) {
1608 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1609 // heap access (eg. the read barrier).
1610 return false;
1611 }
1612
1613 // We must be runnable to request a checkpoint.
1614 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1615 union StateAndFlags new_state_and_flags;
1616 new_state_and_flags.as_int = old_state_and_flags.as_int;
1617 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001618 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001619 old_state_and_flags.as_int, new_state_and_flags.as_int);
1620 if (success) {
1621 TriggerSuspend();
1622 }
1623 return success;
1624}
1625
Andreas Gampee9f67122016-10-27 19:21:23 -07001626class BarrierClosure : public Closure {
1627 public:
1628 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1629
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001630 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001631 wrapped_->Run(self);
1632 barrier_.Pass(self);
1633 }
1634
Alex Light318afe62018-03-22 16:50:10 -07001635 void Wait(Thread* self, ThreadState suspend_state) {
1636 if (suspend_state != ThreadState::kRunnable) {
1637 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1638 } else {
1639 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1640 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001641 }
1642
1643 private:
1644 Closure* wrapped_;
1645 Barrier barrier_;
1646};
1647
Alex Lightb1e31a82017-10-04 16:57:36 -07001648// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001649bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001650 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001651 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001652 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1653 // Unlock the tll before running so that the state is the same regardless of thread.
1654 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001655 // Asked to run on this thread. Just run.
1656 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001657 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001658 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001659
1660 // The current thread is not this thread.
1661
Andreas Gampe28c4a232017-06-21 21:21:31 -07001662 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001663 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001664 return false;
1665 }
1666
Andreas Gampe28c4a232017-06-21 21:21:31 -07001667 struct ScopedThreadListLockUnlock {
1668 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1669 : self_thread(self_in) {
1670 Locks::thread_list_lock_->AssertHeld(self_thread);
1671 Locks::thread_list_lock_->Unlock(self_thread);
1672 }
1673
1674 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1675 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1676 Locks::thread_list_lock_->Lock(self_thread);
1677 }
1678
1679 Thread* self_thread;
1680 };
1681
Andreas Gampee9f67122016-10-27 19:21:23 -07001682 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001683 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001684 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1685 // suspend-count lock for too long.
1686 if (GetState() == ThreadState::kRunnable) {
1687 BarrierClosure barrier_closure(function);
1688 bool installed = false;
1689 {
1690 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1691 installed = RequestCheckpoint(&barrier_closure);
1692 }
1693 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001694 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1695 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1696 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001697 ScopedThreadStateChange sts(self, suspend_state);
1698 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001699 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001700 }
1701 // Fall-through.
1702 }
1703
1704 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1705 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1706 // certain situations.
1707 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001708 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1709
Alex Light46f93402017-06-29 11:59:50 -07001710 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001711 // Just retry the loop.
1712 sched_yield();
1713 continue;
1714 }
1715 }
1716
Andreas Gampe28c4a232017-06-21 21:21:31 -07001717 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001718 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1719 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001720 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001721 {
Alex Light318afe62018-03-22 16:50:10 -07001722 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001723 while (GetState() == ThreadState::kRunnable) {
1724 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1725 // moves us to suspended.
1726 sched_yield();
1727 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001728 }
1729
1730 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001731 }
1732
Andreas Gampee9f67122016-10-27 19:21:23 -07001733 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001734 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1735
1736 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001737 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001738 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001739 }
1740
Andreas Gampe117f9b32017-06-23 13:33:50 -07001741 {
1742 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1743 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1744 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1745 Thread::resume_cond_->Broadcast(self);
1746 }
1747
Alex Lightb1e31a82017-10-04 16:57:36 -07001748 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1749 Locks::thread_list_lock_->ExclusiveUnlock(self);
1750
Andreas Gampe28c4a232017-06-21 21:21:31 -07001751 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001752 }
1753}
1754
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001755Closure* Thread::GetFlipFunction() {
1756 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1757 Closure* func;
1758 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001759 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001760 if (func == nullptr) {
1761 return nullptr;
1762 }
Orion Hodson4557b382018-01-03 11:47:54 +00001763 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001764 DCHECK(func != nullptr);
1765 return func;
1766}
1767
1768void Thread::SetFlipFunction(Closure* function) {
1769 CHECK(function != nullptr);
1770 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001771 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001772}
1773
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001774void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001775 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001776 VLOG(threads) << this << " self-suspending";
1777 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001778 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001779 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001780 VLOG(threads) << this << " self-reviving";
1781}
1782
Andreas Gampe9186ced2016-12-12 14:28:21 -08001783static std::string GetSchedulerGroupName(pid_t tid) {
1784 // /proc/<pid>/cgroup looks like this:
1785 // 2:devices:/
1786 // 1:cpuacct,cpu:/
1787 // We want the third field from the line whose second field contains the "cpu" token.
1788 std::string cgroup_file;
Andreas Gampe43e72432019-05-14 16:15:24 -07001789 if (!android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid),
1790 &cgroup_file)) {
Andreas Gampe9186ced2016-12-12 14:28:21 -08001791 return "";
1792 }
1793 std::vector<std::string> cgroup_lines;
1794 Split(cgroup_file, '\n', &cgroup_lines);
1795 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1796 std::vector<std::string> cgroup_fields;
1797 Split(cgroup_lines[i], ':', &cgroup_fields);
1798 std::vector<std::string> cgroups;
1799 Split(cgroup_fields[1], ',', &cgroups);
1800 for (size_t j = 0; j < cgroups.size(); ++j) {
1801 if (cgroups[j] == "cpu") {
1802 return cgroup_fields[2].substr(1); // Skip the leading slash.
1803 }
1804 }
1805 }
1806 return "";
1807}
1808
1809
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001810void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001811 std::string group_name;
1812 int priority;
1813 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001814 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001815
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001816 // If flip_function is not null, it means we have run a checkpoint
1817 // before the thread wakes up to execute the flip function and the
1818 // thread roots haven't been forwarded. So the following access to
1819 // the roots (opeer or methods in the frames) would be bad. Run it
1820 // here. TODO: clean up.
1821 if (thread != nullptr) {
1822 ScopedObjectAccessUnchecked soa(self);
1823 Thread* this_thread = const_cast<Thread*>(thread);
1824 Closure* flip_func = this_thread->GetFlipFunction();
1825 if (flip_func != nullptr) {
1826 flip_func->Run(this_thread);
1827 }
1828 }
1829
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001830 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1831 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001832 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001833 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001834 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001835 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001836 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001837 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001838
Mathieu Chartier3398c782016-09-30 10:27:43 -07001839 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001840 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1841 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001842
Dave Allison0aded082013-11-07 13:15:11 -08001843 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001844 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001845 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001846 ObjPtr<mirror::String> group_name_string =
1847 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001848 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001849 }
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01001850 } else if (thread != nullptr) {
1851 priority = thread->GetNativePriority();
Elliott Hughesd369bb72011-09-12 14:41:14 -07001852 } else {
Orion Hodsonc5323fe2021-02-04 21:20:30 +00001853 palette_status_t status = PaletteSchedGetPriority(tid, &priority);
1854 CHECK(status == PALETTE_STATUS_OK || status == PALETTE_STATUS_CHECK_ERRNO);
Elliott Hughesdcc24742011-09-07 14:02:44 -07001855 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001856
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001857 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001858 if (scheduler_group_name.empty()) {
1859 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001860 }
1861
Dave Allison0aded082013-11-07 13:15:11 -08001862 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001863 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001864 if (is_daemon) {
1865 os << " daemon";
1866 }
1867 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001868 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001869 << " " << thread->GetState();
1870 if (thread->IsStillStarting()) {
1871 os << " (still starting up)";
1872 }
1873 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001874 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001875 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001876 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001877 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001878 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001879
Dave Allison0aded082013-11-07 13:15:11 -08001880 if (thread != nullptr) {
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001881 auto suspend_log_fn = [&]() REQUIRES(Locks::thread_suspend_count_lock_) {
1882 os << " | group=\"" << group_name << "\""
1883 << " sCount=" << thread->tls32_.suspend_count
Alex Lighta462fa62020-07-27 12:58:33 -07001884 << " ucsCount=" << thread->tls32_.user_code_suspend_count
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001885 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
1886 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
1887 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1888 };
1889 if (Locks::thread_suspend_count_lock_->IsExclusiveHeld(self)) {
1890 Locks::thread_suspend_count_lock_->AssertExclusiveHeld(self); // For annotalysis.
1891 suspend_log_fn();
1892 } else {
1893 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1894 suspend_log_fn();
1895 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001896 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001897
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001898 os << " | sysTid=" << tid
Eric Holkf1e1dd12020-08-21 15:38:12 -07001899 << " nice=" << getpriority(PRIO_PROCESS, static_cast<id_t>(tid))
Elliott Hughes0d39c122012-06-06 16:41:17 -07001900 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001901 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001902 int policy;
1903 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001904#if !defined(__APPLE__)
1905 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1906 policy = sched_getscheduler(tid);
1907 if (policy == -1) {
1908 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1909 }
1910 int sched_getparam_result = sched_getparam(tid, &sp);
1911 if (sched_getparam_result == -1) {
1912 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1913 sp.sched_priority = -1;
1914 }
1915#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001916 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1917 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001918#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001919 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001920 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001921 }
1922 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001923
1924 // Grab the scheduler stats for this thread.
1925 std::string scheduler_stats;
Andreas Gampe43e72432019-05-14 16:15:24 -07001926 if (android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid),
1927 &scheduler_stats)
Evan Chengd57c51e2018-01-26 15:43:08 +08001928 && !scheduler_stats.empty()) {
1929 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001930 } else {
1931 scheduler_stats = "0 0 0";
1932 }
1933
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001934 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001935 int utime = 0;
1936 int stime = 0;
1937 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001938 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001939
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001940 os << " | state=" << native_thread_state
1941 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001942 << " utm=" << utime
1943 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001944 << " core=" << task_cpu
1945 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001946 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001947 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1948 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1949 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001950 // Dump the held mutexes.
1951 os << " | held mutexes=";
1952 for (size_t i = 0; i < kLockLevelCount; ++i) {
1953 if (i != kMonitorLock) {
1954 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1955 if (mutex != nullptr) {
1956 os << " \"" << mutex->GetName() << "\"";
1957 if (mutex->IsReaderWriterMutex()) {
1958 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001959 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001960 os << "(exclusive held)";
1961 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001962 os << "(shared held)";
1963 }
1964 }
1965 }
1966 }
1967 }
1968 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001969 }
1970}
1971
1972void Thread::DumpState(std::ostream& os) const {
1973 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001974}
1975
Andreas Gampe93104952017-12-13 17:13:15 -08001976struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001977 StackDumpVisitor(std::ostream& os_in,
1978 Thread* thread_in,
1979 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001980 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001981 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001982 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001983 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001984 : MonitorObjectsStackVisitor(thread_in,
1985 context,
1986 check_suspended,
1987 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001988 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001989 last_method(nullptr),
1990 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001991 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001992
Ian Rogersbdb03912011-09-14 00:55:44 -07001993 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001994 if (frame_count == 0) {
1995 os << " (no managed stack frames)\n";
1996 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001997 }
1998
Andreas Gampe93104952017-12-13 17:13:15 -08001999 static constexpr size_t kMaxRepetition = 3u;
2000
2001 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002002 override
Andreas Gampe93104952017-12-13 17:13:15 -08002003 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07002004 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00002005 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08002006 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08002007 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07002008 const DexFile* dex_file = dex_cache->GetDexFile();
2009 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08002010 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07002011 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08002012 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002013 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07002014 if (repetition_count >= kMaxRepetition) {
2015 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
2016 }
2017 repetition_count = 0;
2018 last_line_number = line_number;
2019 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002020 }
Andreas Gampe93104952017-12-13 17:13:15 -08002021
2022 if (repetition_count >= kMaxRepetition) {
2023 // Skip visiting=printing anything.
2024 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002025 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07002026
Andreas Gampe93104952017-12-13 17:13:15 -08002027 os << " at " << m->PrettyMethod(false);
2028 if (m->IsNative()) {
2029 os << "(Native method)";
2030 } else {
2031 const char* source_file(m->GetDeclaringClassSourceFile());
2032 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2033 << ":" << line_number << ")";
2034 }
2035 os << "\n";
2036 // Go and visit locks.
2037 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002038 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002039
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002040 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002041 return VisitMethodResult::kContinueMethod;
2042 }
2043
Vladimir Markof52d92f2019-03-29 12:33:02 +00002044 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002045 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002046 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002047 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2048 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002049 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002050 override
Andreas Gampe93104952017-12-13 17:13:15 -08002051 REQUIRES_SHARED(Locks::mutator_lock_) {
2052 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2053 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002054 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002055 ThreadState state,
2056 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002057 override
Andreas Gampe93104952017-12-13 17:13:15 -08002058 REQUIRES_SHARED(Locks::mutator_lock_) {
2059 const char* msg;
2060 switch (state) {
2061 case kBlocked:
2062 msg = " - waiting to lock ";
2063 break;
2064
2065 case kWaitingForLockInflation:
2066 msg = " - waiting for lock inflation of ";
2067 break;
2068
2069 default:
2070 LOG(FATAL) << "Unreachable";
2071 UNREACHABLE();
2072 }
2073 PrintObject(obj, msg, owner_tid);
2074 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002075 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002076 override
Andreas Gampe93104952017-12-13 17:13:15 -08002077 REQUIRES_SHARED(Locks::mutator_lock_) {
2078 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2079 }
2080
Vladimir Markof52d92f2019-03-29 12:33:02 +00002081 void PrintObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002082 const char* msg,
2083 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2084 if (obj == nullptr) {
2085 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002086 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002087 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002088 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2089 // Getting the identity hashcode here would result in lock inflation and suspension of the
2090 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002091 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
Vladimir Markof52d92f2019-03-29 12:33:02 +00002092 reinterpret_cast<intptr_t>(obj.Ptr()),
Andreas Gampe93104952017-12-13 17:13:15 -08002093 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002094 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002095 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2096 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2097 // suspension and move pretty_object.
2098 const std::string pretty_type(obj->PrettyTypeOf());
2099 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002100 }
2101 }
Andreas Gampe93104952017-12-13 17:13:15 -08002102 if (owner_tid != ThreadList::kInvalidThreadId) {
2103 os << " held by thread " << owner_tid;
2104 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002105 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002106 }
2107
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002108 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002109 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002110 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002111 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002112};
2113
Ian Rogers33e95662013-05-20 20:29:14 -07002114static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002115 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002116 ThreadState state = thread->GetState();
2117
2118 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2119 if (state > kWaiting && state < kStarting) {
2120 return true;
2121 }
2122
2123 // In an Object.wait variant or Thread.sleep? That's not interesting.
2124 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2125 return false;
2126 }
2127
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002128 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002129 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002130 return true;
2131 }
2132
Elliott Hughesaef701d2013-04-05 18:15:40 -07002133 // In some other native method? That's interesting.
2134 // We don't just check kNative because native methods will be in state kSuspended if they're
2135 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2136 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002137 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002138 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002139}
2140
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002141void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002142 // If flip_function is not null, it means we have run a checkpoint
2143 // before the thread wakes up to execute the flip function and the
2144 // thread roots haven't been forwarded. So the following access to
2145 // the roots (locks or methods in the frames) would be bad. Run it
2146 // here. TODO: clean up.
2147 {
2148 Thread* this_thread = const_cast<Thread*>(this);
2149 Closure* flip_func = this_thread->GetFlipFunction();
2150 if (flip_func != nullptr) {
2151 flip_func->Run(this_thread);
2152 }
2153 }
2154
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002155 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2156 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002157 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2158 // thread.
Alex Lightb7c640d2019-03-20 15:52:13 -07002159 ScopedExceptionStorage ses(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002160
Ian Rogers700a4022014-05-19 16:49:03 -07002161 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002162 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002163 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002164 dumper.WalkStack();
2165}
2166
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002167void Thread::DumpStack(std::ostream& os,
2168 bool dump_native_stack,
2169 BacktraceMap* backtrace_map,
2170 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002171 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2172 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2173 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002174 bool dump_for_abort = (gAborting > 0);
2175 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2176 if (!kIsDebugBuild) {
2177 // We always want to dump the stack for an abort, however, there is no point dumping another
2178 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2179 safe_to_dump = (safe_to_dump || dump_for_abort);
2180 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002181 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002182 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002183 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002184 ArtMethod* method =
2185 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002186 /*check_suspended=*/ !force_dump_stack,
2187 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002188 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002189 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002190 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002191 /*check_suspended=*/ !force_dump_stack,
2192 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002193 } else {
2194 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002195 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002196}
2197
Elliott Hughesbe759c62011-09-08 19:38:21 -07002198void Thread::ThreadExitCallback(void* arg) {
2199 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002200 if (self->tls32_.thread_exit_check_count == 0) {
2201 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2202 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002203 CHECK(is_started_);
Andreas Gampea47a6e82019-07-24 09:46:16 -07002204#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002205 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2206#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002207 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe82372002019-07-24 15:42:09 -07002208 Thread::self_tls_ = self;
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002209#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002210 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002211 } else {
2212 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2213 }
Carl Shapirob5573532011-07-12 18:22:59 -07002214}
2215
Elliott Hughesbe759c62011-09-08 19:38:21 -07002216void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002217 CHECK(!is_started_);
2218 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002219 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002220 // MutexLock to keep annotalysis happy.
2221 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002222 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002223 // return garbage since (is_started_ == true) and
2224 // Thread::pthread_key_self_ is not yet initialized.
2225 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002226 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002227 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2228 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002229 }
2230
Carl Shapirob5573532011-07-12 18:22:59 -07002231 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002232 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2233 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002234
2235 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002236 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2237 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002238 }
Andreas Gampe82372002019-07-24 15:42:09 -07002239#ifndef __BIONIC__
2240 CHECK(Thread::self_tls_ == nullptr);
2241#endif
Elliott Hughes038a8062011-09-18 14:12:41 -07002242}
Carl Shapirob5573532011-07-12 18:22:59 -07002243
Elliott Hughes038a8062011-09-18 14:12:41 -07002244void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002245 Runtime* runtime = Runtime::Current();
2246 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002247
Elliott Hughes01158d72011-09-19 19:47:10 -07002248 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002249 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002250 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2251 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002252
Vladimir Markodcfcce42018-06-27 10:00:28 +00002253 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002254
2255 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2256 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002257 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2258 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002259}
2260
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002261void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002262 CHECK(is_started_);
2263 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002264 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002265 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002266 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002267 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002268 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002269 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002270}
2271
Andreas Gampe56776012018-01-26 17:40:55 -08002272void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2273 ScopedLocalRef<jobject> thread_jobject(
2274 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2275 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2276 soa.Env(), nullptr);
2277 jobject thread_group_jobject = thread_group;
2278 if (thread_group == nullptr || kIsDebugBuild) {
2279 // There is always a group set. Retrieve it.
2280 thread_group_jobject_scoped.reset(
2281 soa.Env()->GetObjectField(thread_jobject.get(),
2282 WellKnownClasses::java_lang_Thread_group));
2283 thread_group_jobject = thread_group_jobject_scoped.get();
2284 if (kIsDebugBuild && thread_group != nullptr) {
2285 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2286 }
2287 }
2288 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2289 WellKnownClasses::java_lang_ThreadGroup,
2290 WellKnownClasses::java_lang_ThreadGroup_add,
2291 thread_jobject.get());
2292}
2293
Calin Juravleccd56952016-12-15 17:57:38 +00002294Thread::Thread(bool daemon)
2295 : tls32_(daemon),
2296 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002297 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002298 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002299 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Nicolas Geoffraye91e7952020-01-23 10:15:56 +00002300 tlsPtr_.instrumentation_stack =
2301 new std::map<uintptr_t, instrumentation::InstrumentationStackFrame>;
Ian Rogersdd7624d2014-03-14 17:43:00 -07002302 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2303
Roland Levillain33d69032015-06-18 18:20:59 +01002304 static_assert((sizeof(Thread) % 4) == 0U,
2305 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002306 tls32_.state_and_flags.as_struct.flags = 0;
2307 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002308 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002309 // Initialize with no permit; if the java Thread was unparked before being
2310 // started, it will unpark itself before calling into java code.
2311 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002312 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002313 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002314 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002315 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002316 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002317 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2318 tlsPtr_.active_suspend_barriers[i] = nullptr;
2319 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002320 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002321 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002322 tls32_.is_transitioning_to_runnable = false;
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08002323 ResetTlab();
David Srbecky28f6cff2018-10-16 15:07:28 +01002324}
2325
Alex Lighte9f61032018-09-24 16:04:51 -07002326bool Thread::CanLoadClasses() const {
2327 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2328}
2329
Elliott Hughes7dc51662012-05-16 14:48:43 -07002330bool Thread::IsStillStarting() const {
2331 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002332 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002333 // 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 -07002334 // assigned fairly early on, and needs to be.
2335 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2336 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002337 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2338 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002339}
2340
Andreas Gamped9efea62014-07-21 22:56:08 -07002341void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002342 CHECK(IsExceptionPending()) << "Pending exception expected.";
2343}
2344
2345void Thread::AssertPendingOOMException() const {
2346 AssertPendingException();
2347 auto* e = GetException();
2348 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2349 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002350}
2351
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002352void Thread::AssertNoPendingException() const {
2353 if (UNLIKELY(IsExceptionPending())) {
2354 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002355 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002356 }
2357}
2358
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002359void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2360 if (UNLIKELY(IsExceptionPending())) {
2361 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002362 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002363 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002364 }
2365}
2366
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002367class MonitorExitVisitor : public SingleRootVisitor {
2368 public:
2369 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2370
2371 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2372 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002373 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002374 if (self_->HoldsLock(entered_monitor)) {
2375 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002376 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002377 << " left locked by native thread "
2378 << *Thread::Current() << " which is detaching";
2379 entered_monitor->MonitorExit(self_);
2380 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002381 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002382
2383 private:
2384 Thread* const self_;
2385};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002386
Elliott Hughesc0f09332012-03-26 13:27:06 -07002387void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002388 Thread* self = this;
2389 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002390
Ian Rogers68d8b422014-07-17 11:09:10 -07002391 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002392 {
2393 ScopedObjectAccess soa(self);
2394 MonitorExitVisitor visitor(self);
2395 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002396 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002397 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002398 // Release locally held global references which releasing may require the mutator lock.
2399 if (tlsPtr_.jpeer != nullptr) {
2400 // If pthread_create fails we don't have a jni env here.
2401 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2402 tlsPtr_.jpeer = nullptr;
2403 }
2404 if (tlsPtr_.class_loader_override != nullptr) {
2405 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2406 tlsPtr_.class_loader_override = nullptr;
2407 }
2408 }
2409
Ian Rogersdd7624d2014-03-14 17:43:00 -07002410 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002411 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002412 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002413 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002414 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002415 Runtime* runtime = Runtime::Current();
2416 if (runtime != nullptr) {
2417 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2418 }
Elliott Hughes534da072012-03-27 15:17:42 -07002419
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002420 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002421 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002422 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002423 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002424 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002425 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002426 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002427 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002428
Ian Rogerscfaa4552012-11-26 21:00:08 -08002429 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2430 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002431 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002432 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002433 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002434 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002435 StackHandleScope<1> hs(self);
2436 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002437 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002438 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002439 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002440 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002441 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002442
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002443 {
2444 ScopedObjectAccess soa(self);
2445 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Lokesh Gidra93170312019-12-04 13:46:11 -08002446 }
2447 // Mark-stack revocation must be performed at the very end. No
2448 // checkpoint/flip-function or read-barrier should be called after this.
2449 if (kUseReadBarrier) {
2450 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002451 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002452}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002453
Elliott Hughesc0f09332012-03-26 13:27:06 -07002454Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002455 CHECK(tlsPtr_.class_loader_override == nullptr);
2456 CHECK(tlsPtr_.jpeer == nullptr);
2457 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002458 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002459 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002460 delete tlsPtr_.jni_env;
2461 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002462 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002463 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002464 CHECK(!ReadFlag(kCheckpointRequest));
2465 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002466 CHECK(tlsPtr_.checkpoint_function == nullptr);
2467 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002468 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002469 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002470
Sebastien Hertz07474662015-08-25 15:12:33 +00002471 // Make sure we processed all deoptimization requests.
2472 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002473 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2474 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002475
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002476 // We may be deleting a still born thread.
2477 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002478
2479 delete wait_cond_;
2480 delete wait_mutex_;
2481
Ian Rogersdd7624d2014-03-14 17:43:00 -07002482 if (tlsPtr_.long_jump_context != nullptr) {
2483 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002484 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002485
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002486 if (initialized) {
2487 CleanupCpu();
2488 }
2489
Ian Rogersdd7624d2014-03-14 17:43:00 -07002490 delete tlsPtr_.instrumentation_stack;
2491 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002492 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002493
Ian Rogers68d8b422014-07-17 11:09:10 -07002494 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002495
Elliott Hughesd8af1592012-04-16 20:40:15 -07002496 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002497}
2498
Andreas Gampe513061a2017-06-01 09:17:34 -07002499void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002500 if (!IsExceptionPending()) {
2501 return;
2502 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002503 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002504 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002505
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002506 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002507 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2508 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002509
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002510 // Call the Thread instance's dispatchUncaughtException(Throwable)
2511 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2512 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2513 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002514
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002515 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002516 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002517}
2518
Andreas Gampe513061a2017-06-01 09:17:34 -07002519void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002520 // this.group.removeThread(this);
2521 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002522 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002523 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002524 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002525 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002526 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002527 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002528 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2529 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2530 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002531 }
2532}
2533
Vladimir Markocedec9d2021-02-08 16:16:13 +00002534template <bool kPointsToStack>
2535class JniTransitionReferenceVisitor : public StackVisitor {
2536 public:
2537 JniTransitionReferenceVisitor(Thread* thread, void* obj) REQUIRES_SHARED(Locks::mutator_lock_)
2538 : StackVisitor(thread, /*context=*/ nullptr, StackVisitor::StackWalkKind::kSkipInlinedFrames),
2539 obj_(obj),
2540 found_(false) {}
2541
2542 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
2543 ArtMethod* m = GetMethod();
2544 if (!m->IsNative() || m->IsCriticalNative()) {
2545 return true;
2546 }
2547 if (kPointsToStack) {
2548 uint8_t* sp = reinterpret_cast<uint8_t*>(GetCurrentQuickFrame());
2549 size_t frame_size = GetCurrentQuickFrameInfo().FrameSizeInBytes();
2550 uint32_t* current_vreg = reinterpret_cast<uint32_t*>(sp + frame_size + sizeof(ArtMethod*));
2551 if (!m->IsStatic()) {
2552 if (current_vreg == obj_) {
2553 found_ = true;
2554 return false;
2555 }
2556 current_vreg += 1u;
2557 }
2558 const char* shorty = m->GetShorty();
2559 for (size_t i = 1, len = strlen(shorty); i != len; ++i) {
2560 switch (shorty[i]) {
2561 case 'D':
2562 case 'J':
2563 current_vreg += 2u;
2564 break;
2565 case 'L':
2566 if (current_vreg == obj_) {
2567 found_ = true;
2568 return false;
2569 }
2570 FALLTHROUGH_INTENDED;
2571 default:
2572 current_vreg += 1u;
2573 break;
2574 }
2575 }
2576 // Continue only if the object is somewhere higher on the stack.
2577 return obj_ >= current_vreg;
2578 } else { // if (kPointsToStack)
2579 if (m->IsStatic() && obj_ == m->GetDeclaringClassAddressWithoutBarrier()) {
2580 found_ = true;
2581 return false;
2582 }
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002583 return true;
2584 }
2585 }
Vladimir Markocedec9d2021-02-08 16:16:13 +00002586
2587 bool Found() const {
2588 return found_;
2589 }
2590
2591 private:
2592 void* obj_;
2593 bool found_;
2594};
2595
2596bool Thread::IsJniTransitionReference(jobject obj) const {
2597 DCHECK(obj != nullptr);
2598 // We need a non-const pointer for stack walk even if we're not modifying the thread state.
2599 Thread* thread = const_cast<Thread*>(this);
2600 uint8_t* raw_obj = reinterpret_cast<uint8_t*>(obj);
2601 if (static_cast<size_t>(raw_obj - tlsPtr_.stack_begin) < tlsPtr_.stack_size) {
2602 JniTransitionReferenceVisitor</*kPointsToStack=*/ true> visitor(thread, raw_obj);
2603 visitor.WalkStack();
2604 return visitor.Found();
2605 } else {
2606 JniTransitionReferenceVisitor</*kPointsToStack=*/ false> visitor(thread, raw_obj);
2607 visitor.WalkStack();
2608 return visitor.Found();
2609 }
TDYa12728f1a142012-03-15 21:51:52 -07002610}
2611
Eric Holkf1e1dd12020-08-21 15:38:12 -07002612void Thread::HandleScopeVisitRoots(RootVisitor* visitor, uint32_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002613 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2614 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002615 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2616 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002617 }
2618}
2619
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002620ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002621 if (obj == nullptr) {
2622 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002623 }
2624 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002625 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002626 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002627 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002628 // The "kinds" below are sorted by the frequency we expect to encounter them.
2629 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002630 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002631 // Local references do not need a read barrier.
2632 result = locals.Get<kWithoutReadBarrier>(ref);
Vladimir Markocedec9d2021-02-08 16:16:13 +00002633 } else if (kind == kJniTransitionOrInvalid) {
2634 // The `jclass` for a static method points to the CompressedReference<> in the
2635 // `ArtMethod::declaring_class_`. Other `jobject` arguments point to spilled stack
2636 // references but a StackReference<> is just a subclass of CompressedReference<>.
2637 DCHECK(IsJniTransitionReference(obj));
2638 result = reinterpret_cast<mirror::CompressedReference<mirror::Object>*>(obj)->AsMirrorPtr();
Vladimir Marko17491ac2020-12-01 12:02:29 +00002639 VerifyObject(result);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002640 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002641 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002642 } else {
2643 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002644 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002645 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002646 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002647 expect_null = true;
2648 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002649 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002650 }
2651
Vladimir Marko17491ac2020-12-01 12:02:29 +00002652 DCHECK(expect_null || result != nullptr)
2653 << "use of deleted " << ToStr<IndirectRefKind>(kind).c_str()
2654 << " " << static_cast<const void*>(obj);
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002655 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002656}
2657
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002658bool Thread::IsJWeakCleared(jweak obj) const {
2659 CHECK(obj != nullptr);
2660 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002661 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002662 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002663 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002664}
2665
Ian Rogers81d425b2012-09-27 16:03:43 -07002666// Implements java.lang.Thread.interrupted.
2667bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002668 DCHECK_EQ(Thread::Current(), this);
2669 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002670 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002671 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002672 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002673 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002674 return interrupted;
2675}
2676
2677// Implements java.lang.Thread.isInterrupted.
2678bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002679 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002680}
2681
Ian Rogersdd7624d2014-03-14 17:43:00 -07002682void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002683 {
2684 MutexLock mu(self, *wait_mutex_);
2685 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2686 return;
2687 }
2688 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2689 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002690 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002691 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002692}
2693
2694void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002695 Thread* self = Thread::Current();
2696 MutexLock mu(self, *wait_mutex_);
2697 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002698}
2699
Ian Rogersc604d732012-10-14 16:09:54 -07002700void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002701 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002702 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002703 }
2704}
2705
Ian Rogers68d8b422014-07-17 11:09:10 -07002706void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2707 if (tlsPtr_.class_loader_override != nullptr) {
2708 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2709 }
2710 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2711}
2712
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002713using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2714
2715// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2716class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002717 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002718 explicit FetchStackTraceVisitor(Thread* thread,
2719 ArtMethodDexPcPair* saved_frames = nullptr,
2720 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002721 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002722 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002723 saved_frames_(saved_frames),
2724 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002725
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002726 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002727 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002728 // Note we also skip the frame if it doesn't have a method (namely the callee
2729 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002730 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002731 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002732 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002733 skipping_ = false;
2734 }
2735 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002736 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002737 if (depth_ < max_saved_frames_) {
2738 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002739 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002740 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002741 ++depth_;
2742 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002743 } else {
2744 ++skip_depth_;
2745 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002746 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002747 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002748
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002749 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002750 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002751 }
2752
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002753 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002754 return skip_depth_;
2755 }
2756
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002757 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002758 uint32_t depth_ = 0;
2759 uint32_t skip_depth_ = 0;
2760 bool skipping_ = true;
2761 ArtMethodDexPcPair* saved_frames_;
2762 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002763
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002764 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002765};
2766
Ian Rogers0399dde2012-06-06 17:09:28 -07002767class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002768 public:
Eric Holkf1e1dd12020-08-21 15:38:12 -07002769 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, uint32_t skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002770 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2771 self_(self),
2772 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002773 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002774
Eric Holkf1e1dd12020-08-21 15:38:12 -07002775 bool Init(uint32_t depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002776 // Allocate method trace as an object array where the first element is a pointer array that
2777 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2778 // class of the ArtMethod pointers.
2779 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2780 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002781 ObjPtr<mirror::Class> array_class =
2782 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002783 // The first element is the methods and dex pc array, the other elements are declaring classes
2784 // for the methods to ensure classes in the stack trace don't get unloaded.
2785 Handle<mirror::ObjectArray<mirror::Object>> trace(
Eric Holkf1e1dd12020-08-21 15:38:12 -07002786 hs.NewHandle(mirror::ObjectArray<mirror::Object>::Alloc(
2787 hs.Self(), array_class, static_cast<int32_t>(depth) + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002788 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002789 // Acquire uninterruptible_ in all paths.
2790 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002791 self_->AssertPendingOOMException();
2792 return false;
2793 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002794 ObjPtr<mirror::PointerArray> methods_and_pcs =
2795 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002796 const char* last_no_suspend_cause =
2797 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2798 if (methods_and_pcs == nullptr) {
2799 self_->AssertPendingOOMException();
2800 return false;
2801 }
Vladimir Markod34b73b2020-05-05 10:07:59 +01002802 trace->Set</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(0, methods_and_pcs);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002803 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002804 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002805 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002806 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002807 }
2808
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002809 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2810 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002811 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002812
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002813 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002814 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002815 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002816 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002817 if (skip_depth_ > 0) {
2818 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002819 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002820 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002821 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002822 if (m->IsRuntimeMethod()) {
2823 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002824 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002825 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002826 return true;
2827 }
2828
2829 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod34b73b2020-05-05 10:07:59 +01002830 ObjPtr<mirror::PointerArray> methods_and_pcs = GetTraceMethodsAndPCs();
2831 methods_and_pcs->SetElementPtrSize</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(
2832 count_, method, pointer_size_);
2833 methods_and_pcs->SetElementPtrSize</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(
Eric Holkf1e1dd12020-08-21 15:38:12 -07002834 static_cast<uint32_t>(methods_and_pcs->GetLength()) / 2 + count_, dex_pc, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002835 // Save the declaring class of the method to ensure that the declaring classes of the methods
2836 // do not get unloaded while the stack trace is live.
Vladimir Markod34b73b2020-05-05 10:07:59 +01002837 trace_->Set</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(
Eric Holkf1e1dd12020-08-21 15:38:12 -07002838 static_cast<int32_t>(count_) + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002839 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002840 }
2841
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002842 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002843 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002844 }
2845
2846 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002847 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002848 }
2849
2850 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002851 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002852 // How many more frames to skip.
Eric Holkf1e1dd12020-08-21 15:38:12 -07002853 uint32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002854 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002855 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002856 // An object array where the first element is a pointer array that contains the ArtMethod
Vladimir Markod34b73b2020-05-05 10:07:59 +01002857 // pointers on the stack and dex PCs. The rest of the elements are the declaring class of
2858 // the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of the
2859 // i'th frame. We're initializing a newly allocated trace, so we do not need to record that
2860 // under a transaction. If the transaction is aborted, the whole trace shall be unreachable.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002861 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002862 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002863 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002864
2865 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002866};
2867
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002868jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002869 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2870 constexpr size_t kMaxSavedFrames = 256;
2871 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2872 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2873 &saved_frames[0],
2874 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002875 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002876 const uint32_t depth = count_visitor.GetDepth();
2877 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002878
Ian Rogers1f539342012-10-03 21:09:42 -07002879 // Build internal stack trace.
Vladimir Markod34b73b2020-05-05 10:07:59 +01002880 BuildInternalStackTraceVisitor build_trace_visitor(
2881 soa.Self(), const_cast<Thread*>(this), skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002882 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002883 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002884 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002885 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2886 // than doing the stack walk twice.
2887 if (depth < kMaxSavedFrames) {
2888 for (size_t i = 0; i < depth; ++i) {
2889 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2890 }
2891 } else {
2892 build_trace_visitor.WalkStack();
2893 }
2894
Mathieu Chartier910e8272015-09-30 09:24:22 -07002895 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002896 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002897 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002898 // Second half of trace_methods is dex PCs.
2899 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2900 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002901 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2902 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002903 }
2904 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002905 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002906}
2907
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002908bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002909 // Only count the depth since we do not pass a stack frame array as an argument.
2910 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002911 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002912 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002913}
2914
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002915static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2916 const ScopedObjectAccessAlreadyRunnable& soa,
2917 ArtMethod* method,
2918 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2919 int32_t line_number;
2920 StackHandleScope<3> hs(soa.Self());
2921 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2922 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2923 if (method->IsProxyMethod()) {
2924 line_number = -1;
2925 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2926 // source_name_object intentionally left null for proxy methods
2927 } else {
2928 line_number = method->GetLineNumFromDexPC(dex_pc);
2929 // Allocate element, potentially triggering GC
2930 // TODO: reuse class_name_object via Class::name_?
2931 const char* descriptor = method->GetDeclaringClassDescriptor();
2932 CHECK(descriptor != nullptr);
2933 std::string class_name(PrettyDescriptor(descriptor));
2934 class_name_object.Assign(
2935 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2936 if (class_name_object == nullptr) {
2937 soa.Self()->AssertPendingOOMException();
2938 return nullptr;
2939 }
2940 const char* source_file = method->GetDeclaringClassSourceFile();
2941 if (line_number == -1) {
2942 // Make the line_number field of StackTraceElement hold the dex pc.
2943 // source_name_object is intentionally left null if we failed to map the dex pc to
2944 // a line number (most probably because there is no debug info). See b/30183883.
Eric Holkf1e1dd12020-08-21 15:38:12 -07002945 line_number = static_cast<int32_t>(dex_pc);
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002946 } else {
2947 if (source_file != nullptr) {
2948 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2949 if (source_name_object == nullptr) {
2950 soa.Self()->AssertPendingOOMException();
2951 return nullptr;
2952 }
2953 }
2954 }
2955 }
2956 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2957 CHECK(method_name != nullptr);
2958 Handle<mirror::String> method_name_object(
2959 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2960 if (method_name_object == nullptr) {
2961 return nullptr;
2962 }
2963 return mirror::StackTraceElement::Alloc(soa.Self(),
2964 class_name_object,
2965 method_name_object,
2966 source_name_object,
2967 line_number);
2968}
2969
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002970jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002971 const ScopedObjectAccessAlreadyRunnable& soa,
2972 jobject internal,
2973 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002974 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002975 // Decode the internal stack trace into the depth, method trace and PC trace.
2976 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002977 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002978 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002979
Mathieu Chartier910e8272015-09-30 09:24:22 -07002980 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002981
Elliott Hughes01158d72011-09-19 19:47:10 -07002982 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002983
Dave Allison0aded082013-11-07 13:15:11 -08002984 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002985 // Reuse the array we were given.
2986 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002987 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002988 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002989 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002990 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002991 } else {
2992 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002993 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Eric Holkf1e1dd12020-08-21 15:38:12 -07002994 class_linker->AllocStackTraceElementArray(soa.Self(), static_cast<size_t>(depth));
Dave Allison0aded082013-11-07 13:15:11 -08002995 if (java_traces == nullptr) {
2996 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002997 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002998 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002999 }
3000
Dave Allison0aded082013-11-07 13:15:11 -08003001 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07003002 *stack_depth = depth;
3003 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07003004
Eric Holkf1e1dd12020-08-21 15:38:12 -07003005 for (uint32_t i = 0; i < static_cast<uint32_t>(depth); ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003006 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07003007 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07003008 // Methods and dex PC trace is element 0.
3009 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00003010 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00003011 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07003012 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07003013 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003014 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Eric Holkf1e1dd12020-08-21 15:38:12 -07003015 i + static_cast<uint32_t>(method_trace->GetLength()) / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00003016 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08003017 if (obj == nullptr) {
3018 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07003019 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01003020 // We are called from native: use non-transactional mode.
Eric Holkf1e1dd12020-08-21 15:38:12 -07003021 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(
3022 static_cast<int32_t>(i), obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07003023 }
Ian Rogersaaa20802011-09-11 21:47:37 -07003024 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07003025}
3026
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003027jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
3028 // This code allocates. Do not allow it to operate with a pending exception.
3029 if (IsExceptionPending()) {
3030 return nullptr;
3031 }
3032
3033 // If flip_function is not null, it means we have run a checkpoint
3034 // before the thread wakes up to execute the flip function and the
3035 // thread roots haven't been forwarded. So the following access to
3036 // the roots (locks or methods in the frames) would be bad. Run it
3037 // here. TODO: clean up.
3038 // Note: copied from DumpJavaStack.
3039 {
3040 Thread* this_thread = const_cast<Thread*>(this);
3041 Closure* flip_func = this_thread->GetFlipFunction();
3042 if (flip_func != nullptr) {
3043 flip_func->Run(this_thread);
3044 }
3045 }
3046
3047 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
3048 public:
3049 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
3050 Thread* self,
3051 Context* context)
3052 : MonitorObjectsStackVisitor(self, context),
3053 wait_jobject_(soaa_in.Env(), nullptr),
3054 block_jobject_(soaa_in.Env(), nullptr),
3055 soaa_(soaa_in) {}
3056
3057 protected:
3058 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003059 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003060 REQUIRES_SHARED(Locks::mutator_lock_) {
3061 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
3062 soaa_, m, GetDexPc(/* abort on error */ false));
3063 if (obj == nullptr) {
3064 return VisitMethodResult::kEndStackWalk;
3065 }
3066 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
3067 return VisitMethodResult::kContinueMethod;
3068 }
3069
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003070 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003071 lock_objects_.push_back({});
3072 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3073
3074 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3075
3076 return VisitMethodResult::kContinueMethod;
3077 }
3078
Vladimir Markof52d92f2019-03-29 12:33:02 +00003079 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003080 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003081 REQUIRES_SHARED(Locks::mutator_lock_) {
3082 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3083 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003084 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003085 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003086 REQUIRES_SHARED(Locks::mutator_lock_) {
3087 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3088 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003089 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003090 ThreadState state ATTRIBUTE_UNUSED,
3091 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003092 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003093 REQUIRES_SHARED(Locks::mutator_lock_) {
3094 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3095 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003096 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003097 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003098 REQUIRES_SHARED(Locks::mutator_lock_) {
3099 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3100 }
3101
3102 public:
3103 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3104 ScopedLocalRef<jobject> wait_jobject_;
3105 ScopedLocalRef<jobject> block_jobject_;
3106 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3107
3108 private:
3109 const ScopedObjectAccessAlreadyRunnable& soaa_;
3110
3111 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3112 };
3113
3114 std::unique_ptr<Context> context(Context::Create());
3115 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3116 dumper.WalkStack();
3117
3118 // There should not be a pending exception. Otherwise, return with it pending.
3119 if (IsExceptionPending()) {
3120 return nullptr;
3121 }
3122
3123 // Now go and create Java arrays.
3124
3125 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3126
3127 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003128 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003129 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003130 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3131 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003132 return nullptr;
3133 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003134 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003135
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003136 Handle<mirror::Class> h_o_array_class =
3137 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3138 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003139
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003140
3141 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3142 class_linker->EnsureInitialized(soa.Self(),
3143 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003144 /* can_init_fields= */ true,
3145 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003146 if (soa.Self()->IsExceptionPending()) {
3147 // This should not fail in a healthy runtime.
3148 return nullptr;
3149 }
3150
Vladimir Markoe300c4e2021-06-08 16:00:05 +01003151 ArtField* stack_trace_element_field =
3152 h_aste_class->FindDeclaredInstanceField("stackTraceElement", "Ljava/lang/StackTraceElement;");
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003153 DCHECK(stack_trace_element_field != nullptr);
Vladimir Markoe300c4e2021-06-08 16:00:05 +01003154 ArtField* held_locks_field =
3155 h_aste_class->FindDeclaredInstanceField("heldLocks", "[Ljava/lang/Object;");
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003156 DCHECK(held_locks_field != nullptr);
Vladimir Markoe300c4e2021-06-08 16:00:05 +01003157 ArtField* blocked_on_field =
3158 h_aste_class->FindDeclaredInstanceField("blockedOn", "Ljava/lang/Object;");
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003159 DCHECK(blocked_on_field != nullptr);
3160
Eric Holkf1e1dd12020-08-21 15:38:12 -07003161 int32_t length = static_cast<int32_t>(dumper.stack_trace_elements_.size());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003162 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003163 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003164 if (array == nullptr) {
3165 soa.Self()->AssertPendingOOMException();
3166 return nullptr;
3167 }
3168
3169 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3170
3171 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3172 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3173 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
Eric Holkf1e1dd12020-08-21 15:38:12 -07003174 for (size_t i = 0; i != static_cast<size_t>(length); ++i) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003175 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3176 if (handle == nullptr) {
3177 soa.Self()->AssertPendingOOMException();
3178 return nullptr;
3179 }
3180
3181 // Set stack trace element.
3182 stack_trace_element_field->SetObject<false>(
3183 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3184
3185 // Create locked-on array.
3186 if (!dumper.lock_objects_[i].empty()) {
Eric Holkf1e1dd12020-08-21 15:38:12 -07003187 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(
3188 soa.Self(), h_o_array_class.Get(), static_cast<int32_t>(dumper.lock_objects_[i].size())));
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003189 if (handle2 == nullptr) {
3190 soa.Self()->AssertPendingOOMException();
3191 return nullptr;
3192 }
3193 int32_t j = 0;
3194 for (auto& scoped_local : dumper.lock_objects_[i]) {
3195 if (scoped_local == nullptr) {
3196 continue;
3197 }
3198 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3199 DCHECK(!soa.Self()->IsExceptionPending());
3200 j++;
3201 }
3202 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3203 }
3204
3205 // Set blocked-on object.
3206 if (i == 0) {
3207 if (dumper.block_jobject_ != nullptr) {
3208 blocked_on_field->SetObject<false>(
3209 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3210 }
3211 }
3212
3213 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
Eric Holkf1e1dd12020-08-21 15:38:12 -07003214 soa.Env()->SetObjectArrayElement(result.get(), static_cast<jsize>(i), elem.get());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003215 DCHECK(!soa.Self()->IsExceptionPending());
3216 }
3217
3218 return result.release();
3219}
3220
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003221void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003222 va_list args;
3223 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003224 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003225 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003226}
3227
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003228void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003229 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003230 std::string msg;
3231 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003232 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003233}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003234
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003235void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003236 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003237 // Callers should either clear or call ThrowNewWrappedException.
3238 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003239 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003240}
3241
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003242static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003243 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003244 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003245 return method != nullptr
3246 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003247 : nullptr;
3248}
3249
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003250void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003251 const char* msg) {
3252 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003253 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003254 StackHandleScope<3> hs(soa.Self());
Calin Juravle2c2724c2021-01-14 19:54:23 -08003255
3256 // Disable public sdk checks if we need to throw exceptions.
3257 // The checks are only used in AOT compilation and may block (exception) class
3258 // initialization if it needs access to private fields (e.g. serialVersionUID).
3259 //
3260 // Since throwing an exception will EnsureInitialization and the public sdk may
3261 // block that, disable the checks. It's ok to do so, because the thrown exceptions
3262 // are not part of the application code that needs to verified.
3263 ScopedDisablePublicSdkChecker sdpsc;
3264
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003265 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003266 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003267 ClearException();
3268 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003269 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003270 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003271 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003272 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003273 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003274 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003275 return;
3276 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003277
Ian Rogers7b078e82014-09-10 14:44:24 -07003278 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3279 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003280 DCHECK(IsExceptionPending());
3281 return;
3282 }
3283 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003284 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003285 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003286
Mathieu Chartier590fee92013-09-13 13:46:47 -07003287 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003288 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003289 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3290 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003291 return;
3292 }
3293
Ian Rogers62d6c772013-02-27 08:32:07 -08003294 // Choose an appropriate constructor and set up the arguments.
3295 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003296 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003297 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003298 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003299 msg_string.reset(
3300 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003301 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003302 CHECK(IsExceptionPending()); // OOME.
3303 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003304 }
Dave Allison0aded082013-11-07 13:15:11 -08003305 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003306 signature = "(Ljava/lang/String;)V";
3307 } else {
3308 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3309 }
3310 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003311 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003312 signature = "()V";
3313 } else {
3314 signature = "(Ljava/lang/Throwable;)V";
3315 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003316 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003317 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003318 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003319
Dave Allison0aded082013-11-07 13:15:11 -08003320 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003321 << PrettyDescriptor(exception_class_descriptor);
3322
3323 if (UNLIKELY(!runtime->IsStarted())) {
3324 // Something is trying to throw an exception without a started runtime, which is the common
3325 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3326 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003327 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003328 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003329 }
Dave Allison0aded082013-11-07 13:15:11 -08003330 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003331 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003332 }
Vladimir Markod34b73b2020-05-05 10:07:59 +01003333 ScopedLocalRef<jobject> trace(GetJniEnv(), CreateInternalStackTrace(soa));
Ian Rogersc45b8b52014-05-03 01:39:59 -07003334 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003335 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003336 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003337 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003338 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003339 jvalue jv_args[2];
3340 size_t i = 0;
3341
Dave Allison0aded082013-11-07 13:15:11 -08003342 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003343 jv_args[i].l = msg_string.get();
3344 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003345 }
Dave Allison0aded082013-11-07 13:15:11 -08003346 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003347 jv_args[i].l = cause.get();
3348 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003349 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003350 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Alex Light01fbfbe2019-06-27 10:47:04 -07003351 InvokeWithJValues(soa, ref.get(), exception_init_method, jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003352 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003353 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003354 }
Elliott Hughes30646832011-10-13 16:59:46 -07003355 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003356}
3357
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003358void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003359 LOG(WARNING) << "Throwing OutOfMemoryError "
3360 << '"' << msg << '"'
3361 << " (VmSize " << GetProcessStatus("VmSize")
3362 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003363 if (!tls32_.throwing_OutOfMemoryError) {
3364 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003365 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003366 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003367 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003368 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003369 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003370 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003371}
3372
Elliott Hughes498508c2011-10-17 14:58:22 -07003373Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003374 return Thread::Current();
3375}
3376
3377void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003378 std::ostringstream ss;
3379 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003380 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003381 // log to stderr for debugging command line processes
3382 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003383#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003384 // log to logcat for debugging frameworks processes
3385 LOG(INFO) << str;
3386#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003387}
3388
Ian Rogersdd7624d2014-03-14 17:43:00 -07003389// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003390template
3391void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3392template
3393void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003394
Andreas Gampe542451c2016-07-26 09:02:02 -07003395template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003396void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3397#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003398 if (offset == (x).Uint32Value()) { \
3399 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003400 return; \
3401 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003402 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3403 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3404 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3405 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3406 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3407 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3408 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3409 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003410 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003411 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003412 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003413 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003414 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003415#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003416
Ian Rogersdd7624d2014-03-14 17:43:00 -07003417#define JNI_ENTRY_POINT_INFO(x) \
3418 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3419 os << #x; \
3420 return; \
3421 }
3422 JNI_ENTRY_POINT_INFO(pDlsymLookup)
Vladimir Markofa458ac2020-02-12 14:08:07 +00003423 JNI_ENTRY_POINT_INFO(pDlsymLookupCritical)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003424#undef JNI_ENTRY_POINT_INFO
3425
Ian Rogersdd7624d2014-03-14 17:43:00 -07003426#define QUICK_ENTRY_POINT_INFO(x) \
3427 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3428 os << #x; \
3429 return; \
3430 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003431 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003432 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3433 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3434 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3435 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003436 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3437 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003438 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003439 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003440 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3441 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3442 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003443 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003444 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003445 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003446 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3447 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003448 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003449 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3450 QUICK_ENTRY_POINT_INFO(pSet8Static)
3451 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3452 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003453 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3454 QUICK_ENTRY_POINT_INFO(pSet32Static)
3455 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3456 QUICK_ENTRY_POINT_INFO(pSet64Static)
3457 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3458 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003459 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3460 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3461 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3462 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3463 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3464 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3465 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3466 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003467 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3468 QUICK_ENTRY_POINT_INFO(pGet32Static)
3469 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3470 QUICK_ENTRY_POINT_INFO(pGet64Static)
3471 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3472 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003473 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003474 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3475 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3476 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3477 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3478 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3479 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3480 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3481 QUICK_ENTRY_POINT_INFO(pLockObject)
3482 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3483 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3484 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3485 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3486 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003487 QUICK_ENTRY_POINT_INFO(pCos)
3488 QUICK_ENTRY_POINT_INFO(pSin)
3489 QUICK_ENTRY_POINT_INFO(pAcos)
3490 QUICK_ENTRY_POINT_INFO(pAsin)
3491 QUICK_ENTRY_POINT_INFO(pAtan)
3492 QUICK_ENTRY_POINT_INFO(pAtan2)
3493 QUICK_ENTRY_POINT_INFO(pCbrt)
3494 QUICK_ENTRY_POINT_INFO(pCosh)
3495 QUICK_ENTRY_POINT_INFO(pExp)
3496 QUICK_ENTRY_POINT_INFO(pExpm1)
3497 QUICK_ENTRY_POINT_INFO(pHypot)
3498 QUICK_ENTRY_POINT_INFO(pLog)
3499 QUICK_ENTRY_POINT_INFO(pLog10)
3500 QUICK_ENTRY_POINT_INFO(pNextAfter)
3501 QUICK_ENTRY_POINT_INFO(pSinh)
3502 QUICK_ENTRY_POINT_INFO(pTan)
3503 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003504 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003505 QUICK_ENTRY_POINT_INFO(pL2d)
3506 QUICK_ENTRY_POINT_INFO(pFmodf)
3507 QUICK_ENTRY_POINT_INFO(pL2f)
3508 QUICK_ENTRY_POINT_INFO(pD2iz)
3509 QUICK_ENTRY_POINT_INFO(pF2iz)
3510 QUICK_ENTRY_POINT_INFO(pIdivmod)
3511 QUICK_ENTRY_POINT_INFO(pD2l)
3512 QUICK_ENTRY_POINT_INFO(pF2l)
3513 QUICK_ENTRY_POINT_INFO(pLdiv)
3514 QUICK_ENTRY_POINT_INFO(pLmod)
3515 QUICK_ENTRY_POINT_INFO(pLmul)
3516 QUICK_ENTRY_POINT_INFO(pShlLong)
3517 QUICK_ENTRY_POINT_INFO(pShrLong)
3518 QUICK_ENTRY_POINT_INFO(pUshrLong)
3519 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003520 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3521 QUICK_ENTRY_POINT_INFO(pMemcpy)
3522 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3523 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3524 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3525 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3526 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3527 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3528 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3529 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003530 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003531 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3532 QUICK_ENTRY_POINT_INFO(pDeliverException)
3533 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3534 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003535 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3536 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003537 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003538 QUICK_ENTRY_POINT_INFO(pA64Load)
3539 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003540 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3541 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3542 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3543 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3544 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3545 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3546 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3547 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3548 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3549 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3550 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3551 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3552 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3553 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3554 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3555 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003556 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003557 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3558 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3559 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3560 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3561 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3562 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3563 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3564 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3565 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3566 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3567 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3568 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3569 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3570 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3571 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3572 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3573 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3574 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3575 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3576 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3577 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3578 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3579 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3580 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3581 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3582 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3583 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3584 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3585 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3586 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003587 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003588 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003589
3590 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3591 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003592#undef QUICK_ENTRY_POINT_INFO
3593
Elliott Hughes98e20172012-04-24 15:38:13 -07003594 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003595}
3596
jeffhao94d6df42012-11-26 16:02:12 -08003597void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003598 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003599 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003600 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003601 if (exception == GetDeoptimizationException()) {
3602 artDeoptimize(this);
3603 UNREACHABLE();
3604 }
3605
Roland Levillaina78f5b62017-09-29 13:50:44 +01003606 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003607
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003608 // This is a real exception: let the instrumentation know about it.
3609 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003610 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003611 IsExceptionThrownByCurrentMethod(exception)) {
3612 // Instrumentation may cause GC so keep the exception object safe.
3613 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003614 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Vladimir Marko19711d42019-04-12 14:05:34 +01003615 instrumentation->ExceptionThrownEvent(this, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003616 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003617 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3618 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3619 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3620 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003621 //
3622 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3623 // expected to happen fairly regularly but the second can only happen if we are using
3624 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3625 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003626 ShadowFrame* cf;
David Srbecky1cbac5c2019-07-18 20:05:32 +01003627 bool force_deopt = false;
3628 if (Runtime::Current()->AreNonStandardExitsEnabled() || kIsDebugBuild) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003629 NthCallerVisitor visitor(this, 0, false);
3630 visitor.WalkStack();
3631 cf = visitor.GetCurrentShadowFrame();
3632 if (cf == nullptr) {
3633 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3634 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003635 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3636 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003637 if (kIsDebugBuild && force_frame_pop) {
David Srbecky1cbac5c2019-07-18 20:05:32 +01003638 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
Alex Light0aa7a5a2018-10-10 15:58:14 +00003639 NthCallerVisitor penultimate_visitor(this, 1, false);
3640 penultimate_visitor.WalkStack();
3641 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3642 if (penultimate_frame == nullptr) {
3643 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3644 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003645 }
David Srbecky1cbac5c2019-07-18 20:05:32 +01003646 if (force_retry_instr) {
3647 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3648 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003649 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003650 }
Alex Light3dacdd62019-03-12 15:45:47 +00003651 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003652 NthCallerVisitor visitor(this, 0, false);
3653 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003654 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003655 // method_type shouldn't matter due to exception handling.
3656 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003657 // Save the exception into the deoptimization context so it can be restored
3658 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003659 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003660 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3661 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3662 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003663 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3664 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003665 ClearException();
3666 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003667 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003668 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003669 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003670 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003671 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003672 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003673 artDeoptimize(this);
3674 UNREACHABLE();
Nicolas Geoffraye91e7952020-01-23 10:15:56 +00003675 } else if (visitor.caller != nullptr) {
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003676 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3677 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003678 }
3679 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003680
Ian Rogers28ad40d2011-10-27 15:19:26 -07003681 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003682 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003683 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003684 QuickExceptionHandler exception_handler(this, false);
3685 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003686 if (exception_handler.GetClearException()) {
3687 // Exception was cleared as part of delivery.
3688 DCHECK(!IsExceptionPending());
3689 } else {
3690 // Exception was put back with a throw location.
3691 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003692 // Check the to-space invariant on the re-installed exception (if applicable).
3693 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003694 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003695 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003696}
3697
Ian Rogersbdb03912011-09-14 00:55:44 -07003698Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003699 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003700 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003701 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003702 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003703 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003704 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003705 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003706 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003707}
3708
Andreas Gampec7d878d2018-11-19 18:42:06 +00003709ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003710 bool check_suspended,
3711 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003712 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3713 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3714 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003715 ArtMethod* method = nullptr;
3716 uint32_t dex_pc = dex::kDexNoIndex;
3717 StackVisitor::WalkStack(
3718 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3719 ArtMethod* m = visitor->GetMethod();
3720 if (m->IsRuntimeMethod()) {
3721 // Continue if this is a runtime method.
3722 return true;
3723 }
3724 method = m;
3725 dex_pc = visitor->GetDexPc(abort_on_error);
3726 return false;
3727 },
3728 const_cast<Thread*>(this),
3729 /* context= */ nullptr,
3730 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3731 check_suspended);
3732
3733 if (dex_pc_out != nullptr) {
3734 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003735 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003736 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003737}
3738
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003739bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3740 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003741}
3742
Roland Levillainad0777d2018-02-12 20:00:18 +00003743extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003744 REQUIRES_SHARED(Locks::mutator_lock_);
3745
Ian Rogers40e3bac2012-11-20 00:09:14 -08003746// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003747template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003748class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003749 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003750 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003751 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003752 // We are visiting the references in compiled frames, so we do not need
3753 // to know the inlined frames.
3754 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3755 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003756
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003757 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003758 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003759 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003760 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003761 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003762 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003763 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003764 VisitShadowFrame(shadow_frame);
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +00003765 } else if (GetCurrentOatQuickMethodHeader()->IsNterpMethodHeader()) {
3766 VisitNterpFrame();
Sebastien Hertz714f1752014-04-28 15:03:08 +02003767 } else {
3768 VisitQuickFrame();
3769 }
3770 return true;
3771 }
3772
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003773 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003774 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003775 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003776 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003777 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003778 // handle scope for JNI or References for interpreter.
3779 for (size_t reg = 0; reg < num_regs; ++reg) {
3780 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3781 if (ref != nullptr) {
3782 mirror::Object* new_ref = ref;
3783 visitor_(&new_ref, reg, this);
3784 if (new_ref != ref) {
3785 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003786 }
3787 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003788 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003789 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003790 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003791 }
3792
3793 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003794 // 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 -07003795 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3796 // the threads do not all hold the heap bitmap lock for parallel GC.
3797 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003798 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003799 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003800 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003801 // klass can be null for runtime methods.
3802 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003803 if (kVerifyImageObjectsMarked) {
3804 gc::Heap* const heap = Runtime::Current()->GetHeap();
3805 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003806 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003807 if (space != nullptr && space->IsImageSpace()) {
3808 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003809 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003810 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003811 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003812 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003813 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003814 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003815 }
3816 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003817 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3818 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3819 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003820 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003821 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003822 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3823 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003824 }
3825 }
3826 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003827 mirror::Object* new_ref = klass.Ptr();
Alex Light0054aa52019-09-10 16:46:48 -07003828 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kMethodDeclaringClass, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003829 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003830 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003831 }
3832 }
3833 }
3834
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +00003835 void VisitNterpFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3836 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
3837 StackReference<mirror::Object>* vreg_ref_base =
3838 reinterpret_cast<StackReference<mirror::Object>*>(NterpGetReferenceArray(cur_quick_frame));
3839 StackReference<mirror::Object>* vreg_int_base =
3840 reinterpret_cast<StackReference<mirror::Object>*>(NterpGetRegistersArray(cur_quick_frame));
3841 CodeItemDataAccessor accessor((*cur_quick_frame)->DexInstructionData());
3842 const uint16_t num_regs = accessor.RegistersSize();
3843 // An nterp frame has two arrays: a dex register array and a reference array
3844 // that shadows the dex register array but only containing references
3845 // (non-reference dex registers have nulls). See nterp_helpers.cc.
3846 for (size_t reg = 0; reg < num_regs; ++reg) {
3847 StackReference<mirror::Object>* ref_addr = vreg_ref_base + reg;
3848 mirror::Object* ref = ref_addr->AsMirrorPtr();
3849 if (ref != nullptr) {
3850 mirror::Object* new_ref = ref;
3851 visitor_(&new_ref, reg, this);
3852 if (new_ref != ref) {
3853 ref_addr->Assign(new_ref);
3854 StackReference<mirror::Object>* int_addr = vreg_int_base + reg;
3855 int_addr->Assign(new_ref);
3856 }
3857 }
3858 }
3859 }
3860
Andreas Gampe585da952016-12-02 14:52:29 -08003861 template <typename T>
3862 ALWAYS_INLINE
3863 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003864 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003865 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003866 ArtMethod* m = *cur_quick_frame;
3867 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003868
Vladimir Markocedec9d2021-02-08 16:16:13 +00003869 if (m->IsNative()) {
3870 // TODO: Spill the `this` reference in the AOT-compiled String.charAt()
3871 // slow-path for throwing SIOOBE, so that we can remove this carve-out.
3872 if (UNLIKELY(m->IsIntrinsic()) &&
3873 m->GetIntrinsic() == enum_cast<uint32_t>(Intrinsics::kStringCharAt)) {
3874 // The String.charAt() method is AOT-compiled with an intrinsic implementation
3875 // instead of a JNI stub. It has a slow path that constructs a runtime frame
3876 // for throwing SIOOBE and in that path we do not get the `this` pointer
3877 // spilled on the stack, so there is nothing to visit. We can distinguish
3878 // this from the GenericJni path by checking that the PC is in the boot image
3879 // (PC shall be known thanks to the runtime frame for throwing SIOOBE).
3880 // Note that JIT does not emit that intrinic implementation.
3881 const void* pc = reinterpret_cast<const void*>(GetCurrentQuickFramePc());
3882 if (pc != 0u && Runtime::Current()->GetHeap()->IsInBootImageOatFile(pc)) {
3883 return;
3884 }
3885 }
3886 // Native methods spill their arguments to the reserved vregs in the caller's frame
3887 // and use pointers to these stack references as jobject, jclass, jarray, etc.
3888 // Note: We can come here for a @CriticalNative method when it needs to resolve the
3889 // target native function but there would be no references to visit below.
3890 const size_t frame_size = GetCurrentQuickFrameInfo().FrameSizeInBytes();
3891 const size_t method_pointer_size = static_cast<size_t>(kRuntimePointerSize);
3892 uint32_t* current_vreg = reinterpret_cast<uint32_t*>(
3893 reinterpret_cast<uint8_t*>(cur_quick_frame) + frame_size + method_pointer_size);
3894 auto visit = [&]() REQUIRES_SHARED(Locks::mutator_lock_) {
3895 auto* ref_addr = reinterpret_cast<StackReference<mirror::Object>*>(current_vreg);
3896 mirror::Object* ref = ref_addr->AsMirrorPtr();
3897 if (ref != nullptr) {
3898 mirror::Object* new_ref = ref;
3899 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kNativeReferenceArgument, this);
3900 if (ref != new_ref) {
3901 ref_addr->Assign(new_ref);
3902 }
3903 }
3904 };
3905 const char* shorty = m->GetShorty();
3906 if (!m->IsStatic()) {
3907 visit();
3908 current_vreg += 1u;
3909 }
3910 for (shorty += 1u; *shorty != 0; ++shorty) {
3911 switch (*shorty) {
3912 case 'D':
3913 case 'J':
3914 current_vreg += 2u;
3915 break;
3916 case 'L':
3917 visit();
3918 FALLTHROUGH_INTENDED;
3919 default:
3920 current_vreg += 1u;
3921 break;
3922 }
3923 }
3924 } else if (!m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
3925 // Process register map (which native, runtime and proxy methods don't have)
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003926 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003927 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003928 StackReference<mirror::Object>* vreg_base =
3929 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003930 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbecky0d4567f2019-05-30 22:45:40 +01003931 CodeInfo code_info = kPrecise
3932 ? CodeInfo(method_header) // We will need dex register maps.
3933 : CodeInfo::DecodeGcMasksOnly(method_header);
David Srbecky052f8ca2018-04-26 15:42:54 +01003934 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003935 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003936
David Srbecky052f8ca2018-04-26 15:42:54 +01003937 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003938
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003939 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003940 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003941 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003942 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003943 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003944 mirror::Object* ref = ref_addr->AsMirrorPtr();
3945 if (ref != nullptr) {
3946 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003947 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003948 if (ref != new_ref) {
3949 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003950 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003951 }
3952 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003953 }
3954 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003955 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Eric Holkf1e1dd12020-08-21 15:38:12 -07003956 for (uint32_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003957 if (register_mask & (1 << i)) {
3958 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003959 if (kIsDebugBuild && ref_addr == nullptr) {
3960 std::string thread_name;
3961 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003962 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003963 DescribeStack(GetThread());
3964 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3965 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3966 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003967 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003968 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003969 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003970 }
3971 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003972 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3973 // If this is a proxy method, visit its reference arguments.
3974 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003975 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003976 std::vector<StackReference<mirror::Object>*> ref_addrs =
3977 GetProxyReferenceArguments(cur_quick_frame);
3978 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3979 mirror::Object* ref = ref_addr->AsMirrorPtr();
3980 if (ref != nullptr) {
3981 mirror::Object* new_ref = ref;
Alex Light0054aa52019-09-10 16:46:48 -07003982 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kProxyReferenceArgument, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003983 if (ref != new_ref) {
3984 ref_addr->Assign(new_ref);
3985 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003986 }
3987 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003988 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003989 }
3990
Andreas Gampe585da952016-12-02 14:52:29 -08003991 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3992 if (kPrecise) {
3993 VisitQuickFramePrecise();
3994 } else {
3995 VisitQuickFrameNonPrecise();
3996 }
3997 }
3998
3999 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
4000 struct UndefinedVRegInfo {
4001 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
4002 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08004003 const StackMap& map ATTRIBUTE_UNUSED,
4004 RootVisitor& _visitor)
4005 : visitor(_visitor) {
4006 }
4007
4008 ALWAYS_INLINE
4009 void VisitStack(mirror::Object** ref,
4010 size_t stack_index ATTRIBUTE_UNUSED,
4011 const StackVisitor* stack_visitor)
4012 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07004013 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004014 }
4015
4016 ALWAYS_INLINE
4017 void VisitRegister(mirror::Object** ref,
4018 size_t register_index ATTRIBUTE_UNUSED,
4019 const StackVisitor* stack_visitor)
4020 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07004021 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004022 }
4023
4024 RootVisitor& visitor;
4025 };
4026 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
4027 }
4028
4029 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
4030 struct StackMapVRegInfo {
4031 StackMapVRegInfo(ArtMethod* method,
4032 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08004033 const StackMap& map,
4034 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00004035 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08004036 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01004037 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08004038 visitor(_visitor) {
Artem Serov2808be82018-12-20 19:15:11 +00004039 DCHECK_EQ(dex_register_map.size(), number_of_dex_registers);
Andreas Gampe585da952016-12-02 14:52:29 -08004040 }
4041
4042 // TODO: If necessary, we should consider caching a reverse map instead of the linear
4043 // lookups for each location.
4044 void FindWithType(const size_t index,
4045 const DexRegisterLocation::Kind kind,
4046 mirror::Object** ref,
4047 const StackVisitor* stack_visitor)
4048 REQUIRES_SHARED(Locks::mutator_lock_) {
4049 bool found = false;
4050 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01004051 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08004052 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
4053 visitor(ref, dex_reg, stack_visitor);
4054 found = true;
4055 }
4056 }
4057
4058 if (!found) {
Alex Light0054aa52019-09-10 16:46:48 -07004059 // If nothing found, report with unknown.
4060 visitor(ref, JavaFrameRootInfo::kUnknownVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004061 }
4062 }
4063
4064 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
4065 REQUIRES_SHARED(Locks::mutator_lock_) {
4066 const size_t stack_offset = stack_index * kFrameSlotSize;
4067 FindWithType(stack_offset,
4068 DexRegisterLocation::Kind::kInStack,
4069 ref,
4070 stack_visitor);
4071 }
4072
4073 void VisitRegister(mirror::Object** ref,
4074 size_t register_index,
4075 const StackVisitor* stack_visitor)
4076 REQUIRES_SHARED(Locks::mutator_lock_) {
4077 FindWithType(register_index,
4078 DexRegisterLocation::Kind::kInRegister,
4079 ref,
4080 stack_visitor);
4081 }
4082
4083 size_t number_of_dex_registers;
4084 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08004085 DexRegisterMap dex_register_map;
4086 RootVisitor& visitor;
4087 };
4088 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
4089 }
4090
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004091 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004092 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07004093};
4094
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004095class RootCallbackVisitor {
4096 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004097 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004098
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004099 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004100 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004101 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004102 }
4103
4104 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004105 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08004106 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004107};
4108
Alex Light55eccdf2019-10-07 13:51:13 +00004109void Thread::VisitReflectiveTargets(ReflectiveValueVisitor* visitor) {
4110 for (BaseReflectiveHandleScope* brhs = GetTopReflectiveHandleScope();
4111 brhs != nullptr;
4112 brhs = brhs->GetLink()) {
4113 brhs->VisitTargets(visitor);
4114 }
4115}
4116
Andreas Gampe585da952016-12-02 14:52:29 -08004117template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004118void Thread::VisitRoots(RootVisitor* visitor) {
Eric Holkf1e1dd12020-08-21 15:38:12 -07004119 const uint32_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004120 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02004121 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004122 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00004123 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07004124 }
Alex Light848574c2017-09-25 16:59:39 -07004125 if (tlsPtr_.async_exception != nullptr) {
4126 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
4127 RootInfo(kRootNativeStack, thread_id));
4128 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004129 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08004130 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
4131 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004132 HandleScopeVisitRoots(visitor, thread_id);
Sebastien Hertz07474662015-08-25 15:12:33 +00004133 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07004134 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004135 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004136 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07004137 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
4138 record != nullptr;
4139 record = record->GetLink()) {
4140 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
4141 shadow_frame != nullptr;
4142 shadow_frame = shadow_frame->GetLink()) {
4143 mapper.VisitShadowFrame(shadow_frame);
4144 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02004145 }
4146 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004147 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
4148 record != nullptr;
4149 record = record->GetLink()) {
4150 if (record->IsReference()) {
4151 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00004152 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004153 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004154 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
4155 RootInfo(kRootThreadObject, thread_id));
4156 }
4157 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
4158 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004159 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07004160 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
4161 record != nullptr;
4162 record = record->GetNext()) {
4163 mapper.VisitShadowFrame(record->GetShadowFrame());
4164 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004165 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004166 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
4167 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004168 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004169 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004170 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004171 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004172 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004173 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Nicolas Geoffraye91e7952020-01-23 10:15:56 +00004174 for (auto& entry : *GetInstrumentationStack()) {
4175 visitor->VisitRootIfNonNull(&entry.second.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004176 }
Nicolas Geoffraye3f775b2019-12-04 14:41:52 +00004177}
4178
4179void Thread::SweepInterpreterCache(IsMarkedVisitor* visitor) {
Nicolas Geoffraya00b54b2019-12-03 14:36:42 +00004180 for (InterpreterCache::Entry& entry : GetInterpreterCache()->GetArray()) {
4181 const Instruction* inst = reinterpret_cast<const Instruction*>(entry.first);
Nicolas Geoffraye3f775b2019-12-04 14:41:52 +00004182 if (inst != nullptr) {
4183 if (inst->Opcode() == Instruction::NEW_INSTANCE ||
4184 inst->Opcode() == Instruction::CHECK_CAST ||
4185 inst->Opcode() == Instruction::INSTANCE_OF ||
4186 inst->Opcode() == Instruction::NEW_ARRAY ||
4187 inst->Opcode() == Instruction::CONST_CLASS) {
4188 mirror::Class* cls = reinterpret_cast<mirror::Class*>(entry.second);
4189 if (cls == nullptr || cls == Runtime::GetWeakClassSentinel()) {
4190 // Entry got deleted in a previous sweep.
4191 continue;
4192 }
4193 Runtime::ProcessWeakClass(
4194 reinterpret_cast<GcRoot<mirror::Class>*>(&entry.second),
4195 visitor,
4196 Runtime::GetWeakClassSentinel());
4197 } else if (inst->Opcode() == Instruction::CONST_STRING ||
4198 inst->Opcode() == Instruction::CONST_STRING_JUMBO) {
4199 mirror::Object* object = reinterpret_cast<mirror::Object*>(entry.second);
4200 mirror::Object* new_object = visitor->IsMarked(object);
4201 // We know the string is marked because it's a strongly-interned string that
4202 // is always alive (see b/117621117 for trying to make those strings weak).
4203 // The IsMarked implementation of the CMS collector returns
4204 // null for newly allocated objects, but we know those haven't moved. Therefore,
4205 // only update the entry if we get a different non-null string.
4206 if (new_object != nullptr && new_object != object) {
4207 entry.second = reinterpret_cast<size_t>(new_object);
4208 }
4209 }
Nicolas Geoffraya00b54b2019-12-03 14:36:42 +00004210 }
4211 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004212}
4213
Andreas Gampe585da952016-12-02 14:52:29 -08004214void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4215 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004216 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004217 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004218 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004219 }
4220}
4221
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004222class VerifyRootVisitor : public SingleRootVisitor {
4223 public:
4224 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004225 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004226 VerifyObject(root);
4227 }
4228};
jeffhao25045522012-03-13 19:34:37 -07004229
Ian Rogers04d7aa92013-03-16 14:29:17 -07004230void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004231 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4232 VerifyRootVisitor visitor;
4233 std::unique_ptr<Context> context(Context::Create());
4234 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4235 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4236 mapper.WalkStack();
4237 }
jeffhao25045522012-03-13 19:34:37 -07004238}
jeffhao25045522012-03-13 19:34:37 -07004239
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004240// Set the stack end to that to be used during a stack overflow
4241void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004242 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004243 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004244 // However, we seem to have already extended to use the full stack.
4245 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004246 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004247 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004248 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004249 }
4250
Ian Rogersdd7624d2014-03-14 17:43:00 -07004251 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004252
4253 // Remove the stack overflow protection if is it set up.
4254 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4255 if (implicit_stack_check) {
4256 if (!UnprotectStack()) {
4257 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4258 }
4259 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004260}
4261
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004262void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004263 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004264 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004265 tlsPtr_.thread_local_start = start;
4266 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4267 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004268 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004269 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004270}
4271
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004272void Thread::ResetTlab() {
Wessam Hassaneinb5a10be2020-11-11 16:42:52 -08004273 gc::Heap* const heap = Runtime::Current()->GetHeap();
4274 if (heap->GetHeapSampler().IsEnabled()) {
4275 // Note: We always ResetTlab before SetTlab, therefore we can do the sample
4276 // offset adjustment here.
4277 heap->AdjustSampleOffset(GetTlabPosOffset());
4278 VLOG(heap) << "JHP: ResetTlab, Tid: " << GetTid()
4279 << " adjustment = "
4280 << (tlsPtr_.thread_local_pos - tlsPtr_.thread_local_start);
4281 }
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004282 SetTlab(nullptr, nullptr, nullptr);
4283}
4284
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004285bool Thread::HasTlab() const {
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004286 const bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004287 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004288 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004289 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004290 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004291 }
4292 return has_tlab;
4293}
4294
Elliott Hughes330304d2011-08-12 14:28:05 -07004295std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004296 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004297 return os;
4298}
4299
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004300bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004301 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4302 VLOG(threads) << "Protecting stack at " << pregion;
4303 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004304 if (fatal_on_error) {
4305 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4306 "Reason: "
4307 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4308 }
4309 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004310 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004311 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004312}
4313
4314bool Thread::UnprotectStack() {
4315 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4316 VLOG(threads) << "Unprotecting stack at " << pregion;
4317 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4318}
4319
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004320void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4321 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004322 tlsPtr_.method_verifier = verifier;
4323}
4324
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004325void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004326 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004327 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004328}
4329
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004330size_t Thread::NumberOfHeldMutexes() const {
4331 size_t count = 0;
4332 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004333 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004334 }
4335 return count;
4336}
4337
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004338void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4339 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4340 ClearException();
4341 ShadowFrame* shadow_frame =
4342 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004343 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004344 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004345 DeoptimizationMethodType method_type;
4346 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004347 SetTopOfStack(nullptr);
4348 SetTopOfShadowStack(shadow_frame);
4349
4350 // Restore the exception that was pending before deoptimization then interpret the
4351 // deoptimized frames.
4352 if (pending_exception != nullptr) {
4353 SetException(pending_exception);
4354 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004355 interpreter::EnterInterpreterFromDeoptimize(this,
4356 shadow_frame,
4357 result,
4358 from_code,
4359 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004360}
4361
Alex Light848574c2017-09-25 16:59:39 -07004362void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4363 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004364 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004365 if (kIsDebugBuild) {
4366 // Make sure we are in a checkpoint.
4367 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4368 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4369 << "It doesn't look like this was called in a checkpoint! this: "
4370 << this << " count: " << GetSuspendCount();
4371 }
4372 tlsPtr_.async_exception = new_exception.Ptr();
4373}
4374
4375bool Thread::ObserveAsyncException() {
4376 DCHECK(this == Thread::Current());
4377 if (tlsPtr_.async_exception != nullptr) {
4378 if (tlsPtr_.exception != nullptr) {
4379 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4380 << tlsPtr_.exception->Dump();
4381 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4382 }
4383 tlsPtr_.exception = tlsPtr_.async_exception;
4384 tlsPtr_.async_exception = nullptr;
4385 return true;
4386 } else {
4387 return IsExceptionPending();
4388 }
4389}
4390
Mathieu Chartier0795f232016-09-27 18:43:30 -07004391void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004392 CHECK(new_exception != nullptr);
4393 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004394 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004395}
4396
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004397bool Thread::IsAotCompiler() {
4398 return Runtime::Current()->IsAotCompiler();
4399}
4400
Andreas Gampe202f85a2017-02-06 10:23:26 -08004401mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004402 DCHECK(tlsPtr_.jpeer == nullptr);
4403 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004404 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4405 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4406 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4407 // mark/forward it here.
4408 peer = art::ReadBarrier::Mark(peer);
4409 }
4410 return peer;
4411}
4412
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004413void Thread::SetReadBarrierEntrypoints() {
4414 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004415 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004416}
4417
David Srbecky912f36c2018-09-08 12:22:58 +01004418void Thread::ClearAllInterpreterCaches() {
4419 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004420 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004421 thread->GetInterpreterCache()->Clear(thread);
4422 }
4423 } closure;
4424 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4425}
4426
Orion Hodson119733d2019-01-30 15:14:41 +00004427
Andreas Gampee5d23982019-01-08 10:34:26 -08004428void Thread::ReleaseLongJumpContextInternal() {
4429 // Each QuickExceptionHandler gets a long jump context and uses
4430 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4431 // Both finding catch blocks and deoptimization can trigger another
4432 // exception such as a result of class loading. So there can be nested
4433 // cases of exception handling and multiple contexts being used.
4434 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4435 // for reuse so there is no need to always allocate a new one each time when
4436 // getting a context. Since we only keep one context for reuse, delete the
4437 // existing one since the passed in context is yet to be used for longjump.
4438 delete tlsPtr_.long_jump_context;
4439}
4440
Orion Hodson119733d2019-01-30 15:14:41 +00004441void Thread::SetNativePriority(int new_priority) {
Orion Hodsonc5323fe2021-02-04 21:20:30 +00004442 palette_status_t status = PaletteSchedSetPriority(GetTid(), new_priority);
4443 CHECK(status == PALETTE_STATUS_OK || status == PALETTE_STATUS_CHECK_ERRNO);
Orion Hodson119733d2019-01-30 15:14:41 +00004444}
4445
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004446int Thread::GetNativePriority() const {
Orion Hodson119733d2019-01-30 15:14:41 +00004447 int priority = 0;
Orion Hodsonc5323fe2021-02-04 21:20:30 +00004448 palette_status_t status = PaletteSchedGetPriority(GetTid(), &priority);
4449 CHECK(status == PALETTE_STATUS_OK || status == PALETTE_STATUS_CHECK_ERRNO);
Orion Hodson119733d2019-01-30 15:14:41 +00004450 return priority;
4451}
4452
Alex Lighte0b2ce42019-02-21 19:23:42 +00004453bool Thread::IsSystemDaemon() const {
4454 if (GetPeer() == nullptr) {
4455 return false;
4456 }
4457 return jni::DecodeArtField(
4458 WellKnownClasses::java_lang_Thread_systemDaemon)->GetBoolean(GetPeer());
4459}
4460
Hans Boehm9d27fbc2021-05-21 09:23:38 -07004461std::string Thread::StateAndFlagsAsHexString() const {
4462 std::stringstream result_stream;
4463 result_stream << std::hex << tls32_.state_and_flags.as_atomic_int.load();
4464 return result_stream.str();
4465}
4466
Alex Lightb7c640d2019-03-20 15:52:13 -07004467ScopedExceptionStorage::ScopedExceptionStorage(art::Thread* self)
4468 : self_(self), hs_(self_), excp_(hs_.NewHandle<art::mirror::Throwable>(self_->GetException())) {
4469 self_->ClearException();
4470}
4471
Alex Light79d6c802019-06-27 15:50:11 +00004472void ScopedExceptionStorage::SuppressOldException(const char* message) {
4473 CHECK(self_->IsExceptionPending()) << *self_;
4474 ObjPtr<mirror::Throwable> old_suppressed(excp_.Get());
4475 excp_.Assign(self_->GetException());
4476 LOG(WARNING) << message << "Suppressing old exception: " << old_suppressed->Dump();
4477 self_->ClearException();
4478}
4479
Alex Lightb7c640d2019-03-20 15:52:13 -07004480ScopedExceptionStorage::~ScopedExceptionStorage() {
Alex Light79d6c802019-06-27 15:50:11 +00004481 CHECK(!self_->IsExceptionPending()) << *self_;
Alex Lightb7c640d2019-03-20 15:52:13 -07004482 if (!excp_.IsNull()) {
4483 self_->SetException(excp_.Get());
4484 }
4485}
4486
Elliott Hughes8daa0922011-09-11 13:46:25 -07004487} // namespace art
Eric Holkf1e1dd12020-08-21 15:38:12 -07004488
4489#pragma clang diagnostic pop // -Wconversion