blob: 61a751c14fe4c9bc7a38d7156bb449e76ba73d39 [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"
David Srbecky28f6cff2018-10-16 15:07:28 +010077#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010078#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070079#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010080#include "jni/java_vm_ext.h"
81#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070082#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070083#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070084#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080085#include "mirror/object_array-inl.h"
86#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070087#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080088#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070089#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070090#include "nativehelper/scoped_local_ref.h"
91#include "nativehelper/scoped_utf_chars.h"
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +000092#include "nterp_helpers.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070093#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010094#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070095#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070096#include "object_lock.h"
Orion Hodson119733d2019-01-30 15:14:41 +000097#include "palette/palette.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010098#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070099#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -0800100#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -0500101#include "reflection.h"
Alex Light55eccdf2019-10-07 13:51:13 +0000102#include "reflective_handle_scope-inl.h"
David Srbecky28f6cff2018-10-16 15:07:28 +0100103#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700104#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800105#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700106#include "scoped_thread_state_change-inl.h"
Calin Juravle2c2724c2021-01-14 19:54:23 -0800107#include "scoped_disable_public_sdk_checker.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700108#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100109#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700110#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700111#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700112#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800113#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700114#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700115
Yu Lieac44242015-06-29 10:50:03 +0800116#if ART_USE_FUTEXES
117#include "linux/futex.h"
118#include "sys/syscall.h"
119#ifndef SYS_futex
120#define SYS_futex __NR_futex
121#endif
122#endif // ART_USE_FUTEXES
123
Eric Holkf1e1dd12020-08-21 15:38:12 -0700124#pragma clang diagnostic push
125#pragma clang diagnostic error "-Wconversion"
126
Carl Shapirob5573532011-07-12 18:22:59 -0700127namespace art {
128
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800129using android::base::StringAppendV;
130using android::base::StringPrintf;
131
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700132extern "C" NO_RETURN void artDeoptimize(Thread* self);
133
Ian Rogers0878d652013-04-18 17:38:35 -0700134bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700135pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800136ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700137const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100138bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100139Thread* Thread::jit_sensitive_thread_ = nullptr;
Andreas Gampe82372002019-07-24 15:42:09 -0700140#ifndef __BIONIC__
141thread_local Thread* Thread::self_tls_ = nullptr;
142#endif
Calin Juravleb2771b42016-04-07 17:09:25 +0100143
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700144static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700145
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700146// For implicit overflow checks we reserve an extra piece of memory at the bottom
147// of the stack (lowest memory). The higher portion of the memory
148// is protected against reads and the lower is available for use while
149// throwing the StackOverflow exception.
150constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
151
Elliott Hughes7dc51662012-05-16 14:48:43 -0700152static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
153
Ian Rogers5d76c432011-10-31 21:42:49 -0700154void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700155 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700156}
157
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700158static void UnimplementedEntryPoint() {
159 UNIMPLEMENTED(FATAL);
160}
161
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700162void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700163void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800164
165void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
166 CHECK(kUseReadBarrier);
167 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700168 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800169}
Ian Rogers7655f292013-07-29 11:07:13 -0700170
Ian Rogers848871b2013-08-05 10:56:33 -0700171void Thread::InitTlsEntryPoints() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800172 ScopedTrace trace("InitTlsEntryPoints");
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700173 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700174 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800175 uintptr_t* end = reinterpret_cast<uintptr_t*>(
176 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700177 for (uintptr_t* it = begin; it != end; ++it) {
178 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
179 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700180 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700181}
182
Lokesh Gidra7e678d32020-04-28 16:17:49 -0700183void Thread::ResetQuickAllocEntryPointsForThread() {
184 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700185}
186
Sebastien Hertz07474662015-08-25 15:12:33 +0000187class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200188 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100189 DeoptimizationContextRecord(const JValue& ret_val,
190 bool is_reference,
191 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800192 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700193 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000194 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100195 : ret_val_(ret_val),
196 is_reference_(is_reference),
197 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800198 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700199 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000200 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200201
202 JValue GetReturnValue() const { return ret_val_; }
203 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100204 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800205 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000206 DeoptimizationContextRecord* GetLink() const { return link_; }
207 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200208 DCHECK(is_reference_);
209 return ret_val_.GetGCRoot();
210 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000211 mirror::Object** GetPendingExceptionAsGCRoot() {
212 return reinterpret_cast<mirror::Object**>(&pending_exception_);
213 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700214 DeoptimizationMethodType GetDeoptimizationMethodType() const {
215 return deopt_method_type_;
216 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200217
218 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000219 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200220 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200221
Sebastien Hertz07474662015-08-25 15:12:33 +0000222 // Indicates whether the returned value is a reference. If so, the GC will visit it.
223 const bool is_reference_;
224
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100225 // Whether the context was created from an explicit deoptimization in the code.
226 const bool from_code_;
227
Sebastien Hertz07474662015-08-25 15:12:33 +0000228 // The exception that was pending before deoptimization (or null if there was no pending
229 // exception).
230 mirror::Throwable* pending_exception_;
231
Mingyao Yang2ee17902017-08-30 11:37:08 -0700232 // Whether the context was created for an (idempotent) runtime method.
233 const DeoptimizationMethodType deopt_method_type_;
234
Sebastien Hertz07474662015-08-25 15:12:33 +0000235 // A link to the previous DeoptimizationContextRecord.
236 DeoptimizationContextRecord* const link_;
237
238 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200239};
240
241class StackedShadowFrameRecord {
242 public:
243 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
244 StackedShadowFrameType type,
245 StackedShadowFrameRecord* link)
246 : shadow_frame_(shadow_frame),
247 type_(type),
248 link_(link) {}
249
250 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
251 StackedShadowFrameType GetType() const { return type_; }
252 StackedShadowFrameRecord* GetLink() const { return link_; }
253
254 private:
255 ShadowFrame* const shadow_frame_;
256 const StackedShadowFrameType type_;
257 StackedShadowFrameRecord* const link_;
258
259 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
260};
261
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100262void Thread::PushDeoptimizationContext(const JValue& return_value,
263 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700264 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100265 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700266 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000267 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
268 return_value,
269 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100270 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000271 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700272 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000273 tlsPtr_.deoptimization_context_stack);
274 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700275}
276
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100277void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800278 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700279 bool* from_code,
280 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000281 AssertHasDeoptimizationContext();
282 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
283 tlsPtr_.deoptimization_context_stack = record->GetLink();
284 result->SetJ(record->GetReturnValue().GetJ());
285 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100286 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700287 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700288 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000289}
290
291void Thread::AssertHasDeoptimizationContext() {
292 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
293 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800294}
295
Charles Mungeraa31f492018-11-01 18:57:38 +0000296enum {
297 kPermitAvailable = 0, // Incrementing consumes the permit
298 kNoPermit = 1, // Incrementing marks as waiter waiting
299 kNoPermitWaiterWaiting = 2
300};
301
302void Thread::Park(bool is_absolute, int64_t time) {
303 DCHECK(this == Thread::Current());
304#if ART_USE_FUTEXES
305 // Consume the permit, or mark as waiting. This cannot cause park_state to go
306 // outside of its valid range (0, 1, 2), because in all cases where 2 is
307 // assigned it is set back to 1 before returning, and this method cannot run
308 // concurrently with itself since it operates on the current thread.
309 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
310 if (old_state == kNoPermit) {
311 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800312 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Munger5cc0e752018-11-09 12:30:46 -0800313 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000314 if (!is_absolute && time == 0) {
315 // Thread.getState() is documented to return waiting for untimed parks.
316 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
317 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
Charles Mungered19c672019-02-21 15:32:32 -0800318 int result = futex(tls32_.park_state_.Address(),
Charles Mungeraa31f492018-11-01 18:57:38 +0000319 FUTEX_WAIT_PRIVATE,
320 /* sleep if val = */ kNoPermitWaiterWaiting,
321 /* timeout */ nullptr,
322 nullptr,
323 0);
Charles Mungered19c672019-02-21 15:32:32 -0800324 // This errno check must happen before the scope is closed, to ensure that
325 // no destructors (such as ScopedThreadSuspension) overwrite errno.
326 if (result == -1) {
327 switch (errno) {
328 case EAGAIN:
329 FALLTHROUGH_INTENDED;
330 case EINTR: break; // park() is allowed to spuriously return
331 default: PLOG(FATAL) << "Failed to park";
332 }
333 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000334 } else if (time > 0) {
335 // Only actually suspend and futex_wait if we're going to wait for some
336 // positive amount of time - the kernel will reject negative times with
337 // EINVAL, and a zero time will just noop.
338
339 // Thread.getState() is documented to return timed wait for timed parks.
340 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
341 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
342 timespec timespec;
Charles Mungered19c672019-02-21 15:32:32 -0800343 int result = 0;
Charles Mungeraa31f492018-11-01 18:57:38 +0000344 if (is_absolute) {
345 // Time is millis when scheduled for an absolute time
346 timespec.tv_nsec = (time % 1000) * 1000000;
Hans Boehm33701432020-08-19 15:05:03 -0700347 timespec.tv_sec = SaturatedTimeT(time / 1000);
Charles Mungeraa31f492018-11-01 18:57:38 +0000348 // This odd looking pattern is recommended by futex documentation to
349 // wait until an absolute deadline, with otherwise identical behavior to
350 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
351 // correct time when the system clock changes.
352 result = futex(tls32_.park_state_.Address(),
353 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
354 /* sleep if val = */ kNoPermitWaiterWaiting,
355 &timespec,
356 nullptr,
Eric Holkf1e1dd12020-08-21 15:38:12 -0700357 static_cast<int>(FUTEX_BITSET_MATCH_ANY));
Charles Mungeraa31f492018-11-01 18:57:38 +0000358 } else {
359 // Time is nanos when scheduled for a relative time
Hans Boehm33701432020-08-19 15:05:03 -0700360 timespec.tv_sec = SaturatedTimeT(time / 1000000000);
Charles Mungeraa31f492018-11-01 18:57:38 +0000361 timespec.tv_nsec = time % 1000000000;
362 result = futex(tls32_.park_state_.Address(),
363 FUTEX_WAIT_PRIVATE,
364 /* sleep if val = */ kNoPermitWaiterWaiting,
365 &timespec,
366 nullptr,
367 0);
368 }
Charles Mungered19c672019-02-21 15:32:32 -0800369 // This errno check must happen before the scope is closed, to ensure that
370 // no destructors (such as ScopedThreadSuspension) overwrite errno.
371 if (result == -1) {
372 switch (errno) {
373 case ETIMEDOUT:
374 timed_out = true;
375 FALLTHROUGH_INTENDED;
376 case EAGAIN:
377 case EINTR: break; // park() is allowed to spuriously return
378 default: PLOG(FATAL) << "Failed to park";
379 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000380 }
381 }
382 // Mark as no longer waiting, and consume permit if there is one.
383 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
384 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800385 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000386 } else {
387 // the fetch_add has consumed the permit. immediately return.
388 DCHECK_EQ(old_state, kPermitAvailable);
389 }
390#else
391 #pragma clang diagnostic push
392 #pragma clang diagnostic warning "-W#warnings"
393 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
394 #pragma clang diagnostic pop
395 UNUSED(is_absolute, time);
396 UNIMPLEMENTED(WARNING);
397 sched_yield();
398#endif
399}
400
401void Thread::Unpark() {
402#if ART_USE_FUTEXES
403 // Set permit available; will be consumed either by fetch_add (when the thread
404 // tries to park) or store (when the parked thread is woken up)
405 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
406 == kNoPermitWaiterWaiting) {
407 int result = futex(tls32_.park_state_.Address(),
408 FUTEX_WAKE_PRIVATE,
409 /* number of waiters = */ 1,
410 nullptr,
411 nullptr,
412 0);
413 if (result == -1) {
414 PLOG(FATAL) << "Failed to unpark";
415 }
416 }
417#else
418 UNIMPLEMENTED(WARNING);
419#endif
420}
421
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700422void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
423 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
424 sf, type, tlsPtr_.stacked_shadow_frame_record);
425 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800426}
427
Andreas Gampe639bdd12015-06-03 11:22:45 -0700428ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700429 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700430 if (must_be_present) {
431 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700432 } else {
433 if (record == nullptr || record->GetType() != type) {
434 return nullptr;
435 }
436 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700437 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
438 ShadowFrame* shadow_frame = record->GetShadowFrame();
439 delete record;
440 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700441}
442
Mingyao Yang99170c62015-07-06 11:10:37 -0700443class FrameIdToShadowFrame {
444 public:
445 static FrameIdToShadowFrame* Create(size_t frame_id,
446 ShadowFrame* shadow_frame,
447 FrameIdToShadowFrame* next,
448 size_t num_vregs) {
449 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
450 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
451 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
452 }
453
454 static void Delete(FrameIdToShadowFrame* f) {
455 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
456 delete[] memory;
457 }
458
459 size_t GetFrameId() const { return frame_id_; }
460 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
461 FrameIdToShadowFrame* GetNext() const { return next_; }
462 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
463 bool* GetUpdatedVRegFlags() {
464 return updated_vreg_flags_;
465 }
466
467 private:
468 FrameIdToShadowFrame(size_t frame_id,
469 ShadowFrame* shadow_frame,
470 FrameIdToShadowFrame* next)
471 : frame_id_(frame_id),
472 shadow_frame_(shadow_frame),
473 next_(next) {}
474
475 const size_t frame_id_;
476 ShadowFrame* const shadow_frame_;
477 FrameIdToShadowFrame* next_;
478 bool updated_vreg_flags_[0];
479
480 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
481};
482
483static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
484 size_t frame_id) {
485 FrameIdToShadowFrame* found = nullptr;
486 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
487 if (record->GetFrameId() == frame_id) {
488 if (kIsDebugBuild) {
David Srbecky346fd962020-07-27 16:51:00 +0100489 // Check we have at most one record for this frame.
Mingyao Yang99170c62015-07-06 11:10:37 -0700490 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
491 found = record;
492 } else {
493 return record;
494 }
495 }
496 }
497 return found;
498}
499
500ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
501 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
502 tlsPtr_.frame_id_to_shadow_frame, frame_id);
503 if (record != nullptr) {
504 return record->GetShadowFrame();
505 }
506 return nullptr;
507}
508
509// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
510bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
511 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
512 tlsPtr_.frame_id_to_shadow_frame, frame_id);
513 CHECK(record != nullptr);
514 return record->GetUpdatedVRegFlags();
515}
516
517ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
518 uint32_t num_vregs,
519 ArtMethod* method,
520 uint32_t dex_pc) {
521 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
522 if (shadow_frame != nullptr) {
523 return shadow_frame;
524 }
David Sehr709b0702016-10-13 09:12:37 -0700525 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700526 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
527 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
528 shadow_frame,
529 tlsPtr_.frame_id_to_shadow_frame,
530 num_vregs);
531 for (uint32_t i = 0; i < num_vregs; i++) {
532 // Do this to clear all references for root visitors.
533 shadow_frame->SetVRegReference(i, nullptr);
534 // This flag will be changed to true if the debugger modifies the value.
535 record->GetUpdatedVRegFlags()[i] = false;
536 }
537 tlsPtr_.frame_id_to_shadow_frame = record;
538 return shadow_frame;
539}
540
Alex Light184f0752018-07-13 11:18:22 -0700541TLSData* Thread::GetCustomTLS(const char* key) {
542 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
543 auto it = custom_tls_.find(key);
544 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
545}
546
547void Thread::SetCustomTLS(const char* key, TLSData* data) {
548 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
549 // custom_tls_lock_.
550 std::unique_ptr<TLSData> old_data(data);
551 {
552 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
553 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
554 }
555}
556
Mingyao Yang99170c62015-07-06 11:10:37 -0700557void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
558 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
559 if (head->GetFrameId() == frame_id) {
560 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
561 FrameIdToShadowFrame::Delete(head);
562 return;
563 }
564 FrameIdToShadowFrame* prev = head;
565 for (FrameIdToShadowFrame* record = head->GetNext();
566 record != nullptr;
567 prev = record, record = record->GetNext()) {
568 if (record->GetFrameId() == frame_id) {
569 prev->SetNext(record->GetNext());
570 FrameIdToShadowFrame::Delete(record);
571 return;
572 }
573 }
574 LOG(FATAL) << "No shadow frame for frame " << frame_id;
575 UNREACHABLE();
576}
577
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700578void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700579 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700580}
581
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700582void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700583 // One thread (us) survived the fork, but we have a new tid so we need to
584 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700585 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700586}
587
Alex Light4847a072019-12-12 16:13:47 -0800588void Thread::DeleteJPeer(JNIEnv* env) {
589 // Make sure nothing can observe both opeer and jpeer set at the same time.
590 jobject old_jpeer = tlsPtr_.jpeer;
591 CHECK(old_jpeer != nullptr);
592 tlsPtr_.jpeer = nullptr;
593 env->DeleteGlobalRef(old_jpeer);
594}
595
Brian Carlstrom78128a62011-09-15 17:21:19 -0700596void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700597 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700598 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800599 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700600 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800601 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700602 }
603 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700604 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
605 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800606 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700607 // Check that if we got here we cannot be shutting down (as shutdown should never have started
608 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700609 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700610 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
611 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
612 // the runtime in such a case. In case this ever changes, we need to make sure here to
613 // delete the tmp_jni_env, as we own it at this point.
614 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
615 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700616 Runtime::Current()->EndThreadBirth();
617 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700618 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700619 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800620 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800621
622 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700623 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700624 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Alex Light4847a072019-12-12 16:13:47 -0800625 // Make sure nothing can observe both opeer and jpeer set at the same time.
626 self->DeleteJPeer(self->GetJniEnv());
Andreas Gampe08883de2016-11-08 13:20:52 -0800627 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100628
Andreas Gampe08883de2016-11-08 13:20:52 -0800629 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100630 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000631
Andreas Gampeac30fa22017-01-18 21:02:36 -0800632 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700633
Charles Mungeraa31f492018-11-01 18:57:38 +0000634 // Unpark ourselves if the java peer was unparked before it started (see
635 // b/28845097#comment49 for more information)
636
637 ArtField* unparkedField = jni::DecodeArtField(
638 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
639 bool should_unpark = false;
640 {
641 // Hold the lock here, so that if another thread calls unpark before the thread starts
642 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
643 // which could cause a lost unpark.
644 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
645 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
646 }
647 if (should_unpark) {
648 self->Unpark();
649 }
Ian Rogers365c1022012-06-22 15:05:28 -0700650 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800651 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700652 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700653 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
654 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700655 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700656 // Detach and delete self.
657 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700658
Dave Allison0aded082013-11-07 13:15:11 -0800659 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700660}
661
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700662Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800663 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800664 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100665 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
David Srbecky346fd962020-07-27 16:51:00 +0100666 // 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 -0700667 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700668 if (kIsDebugBuild) {
669 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800670 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700671 Locks::thread_list_lock_->AssertHeld(soa.Self());
672 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700673 }
674 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800675}
676
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700677Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
678 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100679 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700680}
681
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700682static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700683 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700684 if (stack_size == 0) {
685 stack_size = Runtime::Current()->GetDefaultStackSize();
686 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700687
Brian Carlstrom6414a972012-04-14 14:20:04 -0700688 // Dalvik used the bionic pthread default stack size for native threads,
689 // so include that here to support apps that expect large native stacks.
690 stack_size += 1 * MB;
691
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700692 // Under sanitization, frames of the interpreter may become bigger, both for C code as
693 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
694 // of all core classes cannot be done in all test circumstances.
695 if (kMemoryToolIsAvailable) {
696 stack_size = std::max(2 * MB, stack_size);
697 }
698
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700699 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
700 if (stack_size < PTHREAD_STACK_MIN) {
701 stack_size = PTHREAD_STACK_MIN;
702 }
703
Dave Allisonf9439142014-03-27 15:10:22 -0700704 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
705 // It's likely that callers are trying to ensure they have at least a certain amount of
706 // stack space, so we should add our reserved space on top of what they requested, rather
707 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700708 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700709 } else {
710 // If we are going to use implicit stack checks, allocate space for the protected
711 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000712 stack_size += Thread::kStackOverflowImplicitCheckSize +
713 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700714 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700715
716 // Some systems require the stack size to be a multiple of the system page size, so round up.
717 stack_size = RoundUp(stack_size, kPageSize);
718
719 return stack_size;
720}
721
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700722// Return the nearest page-aligned address below the current stack top.
723NO_INLINE
724static uint8_t* FindStackTop() {
725 return reinterpret_cast<uint8_t*>(
726 AlignDown(__builtin_frame_address(0), kPageSize));
727}
728
Dave Allisonf9439142014-03-27 15:10:22 -0700729// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700730// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700731ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700732void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700733 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700734 // Page containing current top of stack.
735 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700736
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700737 // Try to directly protect the stack.
738 VLOG(threads) << "installing stack protected region at " << std::hex <<
739 static_cast<void*>(pregion) << " to " <<
740 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700741 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700742 // Tell the kernel that we won't be needing these pages any more.
743 // NB. madvise will probably write zeroes into the memory (on linux it does).
Eric Holkf1e1dd12020-08-21 15:38:12 -0700744 size_t unwanted_size =
745 reinterpret_cast<uintptr_t>(stack_top) - reinterpret_cast<uintptr_t>(pregion) - kPageSize;
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700746 madvise(pregion, unwanted_size, MADV_DONTNEED);
747 return;
748 }
749
750 // There is a little complexity here that deserves a special mention. On some
751 // architectures, the stack is created using a VM_GROWSDOWN flag
752 // to prevent memory being allocated when it's not needed. This flag makes the
753 // kernel only allocate memory for the stack by growing down in memory. Because we
754 // want to put an mprotected region far away from that at the stack top, we need
755 // to make sure the pages for the stack are mapped in before we call mprotect.
756 //
757 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
758 // with a non-mapped stack (usually only the main thread).
759 //
760 // We map in the stack by reading every page from the stack bottom (highest address)
761 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700762 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700763 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700764 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
765 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
766 // thus have to move the stack pointer. We do this portably by using a recursive function with a
767 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700768
Andreas Gampe6c63f862017-06-28 17:20:15 -0700769 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700770 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700771 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000772
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700773 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
774 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000775
Andreas Gampe6c63f862017-06-28 17:20:15 -0700776 struct RecurseDownStack {
777 // This function has an intentionally large stack size.
778#pragma GCC diagnostic push
779#pragma GCC diagnostic ignored "-Wframe-larger-than="
780 NO_INLINE
781 static void Touch(uintptr_t target) {
782 volatile size_t zero = 0;
783 // Use a large local volatile array to ensure a large frame size. Do not use anything close
784 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
785 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700786 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
787 constexpr size_t kAsanMultiplier =
788#ifdef ADDRESS_SANITIZER
789 2u;
790#else
791 1u;
792#endif
Stephen Hines469016b2020-01-22 17:50:41 -0800793 // Keep space uninitialized as it can overflow the stack otherwise (should Clang actually
794 // auto-initialize this local variable).
795 volatile char space[kPageSize - (kAsanMultiplier * 256)] __attribute__((uninitialized));
Andreas Gampee383d232018-06-19 12:29:51 -0700796 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700797 // Remove tag from the pointer. Nop in non-hwasan builds.
798 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
799 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700800 Touch(target);
801 }
802 zero *= 2; // Try to avoid tail recursion.
803 }
804#pragma GCC diagnostic pop
805 };
806 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000807
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700808 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700809 static_cast<void*>(pregion) << " to " <<
810 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
811
Dave Allison648d7112014-07-25 16:15:27 -0700812 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700813 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700814
815 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000816 // NB. madvise will probably write zeroes into the memory (on linux it does).
Eric Holkf1e1dd12020-08-21 15:38:12 -0700817 size_t unwanted_size =
818 reinterpret_cast<uintptr_t>(stack_top) - reinterpret_cast<uintptr_t>(pregion) - kPageSize;
Dave Allison648d7112014-07-25 16:15:27 -0700819 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700820}
821
Ian Rogers120f1c72012-09-28 17:17:10 -0700822void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800823 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800824 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700825
826 if (VLOG_IS_ON(threads)) {
827 ScopedObjectAccess soa(env);
828
Andreas Gampe08883de2016-11-08 13:20:52 -0800829 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700830 ObjPtr<mirror::String> java_name =
831 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700832 std::string thread_name;
833 if (java_name != nullptr) {
834 thread_name = java_name->ToModifiedUtf8();
835 } else {
836 thread_name = "(Unnamed)";
837 }
838
839 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700840 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700841 }
842
Ian Rogers120f1c72012-09-28 17:17:10 -0700843 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700844
Ian Rogers120f1c72012-09-28 17:17:10 -0700845 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
846 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700847 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700848 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700849 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700850 thread_start_during_shutdown = true;
851 } else {
852 runtime->StartThreadBirth();
853 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700854 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700855 if (thread_start_during_shutdown) {
856 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
857 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
858 return;
859 }
860
861 Thread* child_thread = new Thread(is_daemon);
862 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700863 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700864 stack_size = FixStackSize(stack_size);
865
Roland Levillain2ae376f2018-01-30 11:35:11 +0000866 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
867 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800868 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
869 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700870
Andreas Gampe449357d2015-06-01 22:29:51 -0700871 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
872 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100873 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700874 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100875 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700876
Andreas Gampe449357d2015-06-01 22:29:51 -0700877 int pthread_create_result = 0;
878 if (child_jni_env_ext.get() != nullptr) {
879 pthread_t new_pthread;
880 pthread_attr_t attr;
881 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
882 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
883 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
884 "PTHREAD_CREATE_DETACHED");
885 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
886 pthread_create_result = pthread_create(&new_pthread,
887 &attr,
888 Thread::CreateCallback,
889 child_thread);
890 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
891
892 if (pthread_create_result == 0) {
893 // pthread_create started the new thread. The child is now responsible for managing the
894 // JNIEnvExt we created.
895 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
896 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700897 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700898 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700899 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700900 }
901
902 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
903 {
904 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
905 runtime->EndThreadBirth();
906 }
Alex Light4847a072019-12-12 16:13:47 -0800907 // Manually delete the global reference since Thread::Init will not have been run. Make sure
908 // nothing can observe both opeer and jpeer set at the same time.
909 child_thread->DeleteJPeer(env);
Andreas Gampe449357d2015-06-01 22:29:51 -0700910 delete child_thread;
911 child_thread = nullptr;
912 // TODO: remove from thread group?
913 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
914 {
915 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100916 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700917 StringPrintf("pthread_create (%s stack) failed: %s",
918 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
919 ScopedObjectAccess soa(env);
920 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700921 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700922}
923
Andreas Gampe449357d2015-06-01 22:29:51 -0700924bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700925 // This function does all the initialization that must be run by the native thread it applies to.
926 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
927 // we can handshake with the corresponding native thread when it's ready.) Check this native
928 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800929 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800930
931 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
932 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
933 tlsPtr_.pthread_self = pthread_self();
934 CHECK(is_started_);
935
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800936 ScopedTrace trace("Thread::Init");
937
Elliott Hughesd8af1592012-04-16 20:40:15 -0700938 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800939 if (!InitStackHwm()) {
940 return false;
941 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700942 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700943 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800944 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700945 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700946 InitTid();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800947 {
948 ScopedTrace trace2("InitInterpreterTls");
949 interpreter::InitInterpreterTls(this);
950 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800951
Andreas Gampea47a6e82019-07-24 09:46:16 -0700952#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000953 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
954#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700955 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe82372002019-07-24 15:42:09 -0700956 Thread::self_tls_ = this;
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000957#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700958 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700959
Ian Rogersdd7624d2014-03-14 17:43:00 -0700960 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700961
Andreas Gampe449357d2015-06-01 22:29:51 -0700962 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800963 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
964 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700965 tlsPtr_.jni_env = jni_env_ext;
966 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100967 std::string error_msg;
968 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700969 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100970 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700971 return false;
972 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700973 }
974
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800975 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700976 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800977 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700978}
979
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800980template <typename PeerAction>
981Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700982 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800983 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800984 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900985 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
986 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800987 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700988 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800989 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700990 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800991 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800992 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700993 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900994 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
995 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800996 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700997 } else {
998 Runtime::Current()->StartThreadBirth();
999 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -08001000 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -07001001 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -08001002 if (!init_success) {
1003 delete self;
1004 return nullptr;
1005 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001006 }
1007 }
Elliott Hughes93e74e82011-09-13 11:07:03 -07001008
Jeff Hao848f70a2014-01-15 13:49:50 -08001009 self->InitStringEntryPoints();
1010
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001011 CHECK_NE(self->GetState(), kRunnable);
1012 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -07001013
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001014 // Run the action that is acting on the peer.
1015 if (!peer_action(self)) {
1016 runtime->GetThreadList()->Unregister(self);
1017 // Unregister deletes self, no need to do this here.
1018 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001019 }
Elliott Hughescac6cc72011-11-03 20:31:21 -07001020
Andreas Gampe56623832015-07-09 21:53:15 -07001021 if (VLOG_IS_ON(threads)) {
1022 if (thread_name != nullptr) {
1023 VLOG(threads) << "Attaching thread " << thread_name;
1024 } else {
1025 VLOG(threads) << "Attaching unnamed thread.";
1026 }
1027 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001028 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001029 }
1030
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001031 {
1032 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001033 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001034 }
1035
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001036 return self;
1037}
1038
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001039Thread* Thread::Attach(const char* thread_name,
1040 bool as_daemon,
1041 jobject thread_group,
1042 bool create_peer) {
1043 auto create_peer_action = [&](Thread* self) {
1044 // If we're the main thread, ClassLinker won't be created until after we're attached,
1045 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1046 // In the compiler, all threads need this hack, because no-one's going to be getting
1047 // a native peer!
1048 if (create_peer) {
1049 self->CreatePeer(thread_name, as_daemon, thread_group);
1050 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001051 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
Vladimir Marko1b3fb622021-02-08 10:54:38 +00001052 // the failure but do not dump the exception details. If we fail to allocate the peer, we
1053 // usually also fail to allocate an exception object and throw a pre-allocated OOME without
1054 // any useful information. If we do manage to allocate the exception object, the memory
1055 // information in the message could have been collected too late and therefore misleading.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001056 {
1057 ScopedObjectAccess soa(self);
Vladimir Marko1b3fb622021-02-08 10:54:38 +00001058 LOG(ERROR) << "Exception creating thread peer: "
1059 << ((thread_name != nullptr) ? thread_name : "<null>");
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001060 self->ClearException();
1061 }
1062 return false;
1063 }
1064 } else {
1065 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1066 if (thread_name != nullptr) {
1067 self->tlsPtr_.name->assign(thread_name);
1068 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001069 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001070 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1071 }
1072 }
1073 return true;
1074 };
1075 return Attach(thread_name, as_daemon, create_peer_action);
1076}
1077
1078Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1079 auto set_peer_action = [&](Thread* self) {
1080 // Install the given peer.
1081 {
1082 DCHECK(self == Thread::Current());
1083 ScopedObjectAccess soa(self);
1084 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1085 }
1086 self->GetJniEnv()->SetLongField(thread_peer,
1087 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001088 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001089 return true;
1090 };
1091 return Attach(thread_name, as_daemon, set_peer_action);
1092}
1093
Ian Rogers365c1022012-06-22 15:05:28 -07001094void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1095 Runtime* runtime = Runtime::Current();
1096 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001097 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001098
Dave Allison0aded082013-11-07 13:15:11 -08001099 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001100 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001101 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001102 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001103 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001104 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001105 CHECK(IsExceptionPending());
1106 return;
1107 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001108 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001109 jboolean thread_is_daemon = as_daemon;
1110
Elliott Hugheseac76672012-05-24 21:56:51 -07001111 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001112 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001113 CHECK(IsExceptionPending());
1114 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001115 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001116 {
1117 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001118 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001119 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001120 env->CallNonvirtualVoidMethod(peer.get(),
1121 WellKnownClasses::java_lang_Thread,
1122 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001123 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001124 if (IsExceptionPending()) {
1125 return;
1126 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001127
Ian Rogers120f1c72012-09-28 17:17:10 -07001128 Thread* self = this;
1129 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001130 env->SetLongField(peer.get(),
1131 WellKnownClasses::java_lang_Thread_nativePeer,
1132 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001133
1134 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001135 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001136 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001137 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001138 // The Thread constructor should have set the Thread.name to a
1139 // non-null value. However, because we can run without code
1140 // available (in the compiler, in tests), we manually assign the
1141 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001142 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001143 InitPeer<true>(soa,
1144 tlsPtr_.opeer,
1145 thread_is_daemon,
1146 thread_group,
1147 thread_name.get(),
1148 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001149 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001150 InitPeer<false>(soa,
1151 tlsPtr_.opeer,
1152 thread_is_daemon,
1153 thread_group,
1154 thread_name.get(),
1155 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001156 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001157 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001158 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001159 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001160 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001161 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001162 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001163}
1164
Andreas Gampebad529d2017-02-13 18:52:10 -08001165jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1166 const char* name,
1167 bool as_daemon,
1168 jobject thread_group) {
1169 Runtime* runtime = Runtime::Current();
1170 CHECK(!runtime->IsStarted());
1171
1172 if (thread_group == nullptr) {
1173 thread_group = runtime->GetMainThreadGroup();
1174 }
1175 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1176 // Add missing null check in case of OOM b/18297817
1177 if (name != nullptr && thread_name.get() == nullptr) {
1178 CHECK(Thread::Current()->IsExceptionPending());
1179 return nullptr;
1180 }
Andreas Gampea1e5b972019-03-18 16:54:25 -07001181 jint thread_priority = kNormThreadPriority; // Always normalize to NORM priority.
Andreas Gampebad529d2017-02-13 18:52:10 -08001182 jboolean thread_is_daemon = as_daemon;
1183
1184 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1185 if (peer.get() == nullptr) {
1186 CHECK(Thread::Current()->IsExceptionPending());
1187 return nullptr;
1188 }
1189
1190 // We cannot call Thread.init, as it will recursively ask for currentThread.
1191
1192 // The Thread constructor should have set the Thread.name to a
1193 // non-null value. However, because we can run without code
1194 // available (in the compiler, in tests), we manually assign the
1195 // fields the constructor should have set.
1196 ScopedObjectAccessUnchecked soa(Thread::Current());
1197 if (runtime->IsActiveTransaction()) {
1198 InitPeer<true>(soa,
1199 soa.Decode<mirror::Object>(peer.get()),
1200 thread_is_daemon,
1201 thread_group,
1202 thread_name.get(),
1203 thread_priority);
1204 } else {
1205 InitPeer<false>(soa,
1206 soa.Decode<mirror::Object>(peer.get()),
1207 thread_is_daemon,
1208 thread_group,
1209 thread_name.get(),
1210 thread_priority);
1211 }
1212
1213 return peer.release();
1214}
1215
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001216template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001217void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1218 ObjPtr<mirror::Object> peer,
1219 jboolean thread_is_daemon,
1220 jobject thread_group,
1221 jobject thread_name,
1222 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001223 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001224 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001225 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001226 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001227 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001228 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001229 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001230 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001231}
1232
Elliott Hughes899e7892012-01-24 14:57:32 -08001233void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001234 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001235 ::art::SetThreadName(name);
1236 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1237}
1238
Andreas Gampe9186ced2016-12-12 14:28:21 -08001239static void GetThreadStack(pthread_t thread,
1240 void** stack_base,
1241 size_t* stack_size,
1242 size_t* guard_size) {
1243#if defined(__APPLE__)
1244 *stack_size = pthread_get_stacksize_np(thread);
1245 void* stack_addr = pthread_get_stackaddr_np(thread);
1246
1247 // Check whether stack_addr is the base or end of the stack.
1248 // (On Mac OS 10.7, it's the end.)
1249 int stack_variable;
1250 if (stack_addr > &stack_variable) {
1251 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1252 } else {
1253 *stack_base = stack_addr;
1254 }
1255
1256 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1257 pthread_attr_t attributes;
1258 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1259 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1260 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1261#else
1262 pthread_attr_t attributes;
1263 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1264 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1265 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1266 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1267
1268#if defined(__GLIBC__)
1269 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1270 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1271 // will be broken because we'll die long before we get close to 2GB.
Eric Holkf1e1dd12020-08-21 15:38:12 -07001272 bool is_main_thread = (::art::GetTid() == static_cast<uint32_t>(getpid()));
Andreas Gampe9186ced2016-12-12 14:28:21 -08001273 if (is_main_thread) {
1274 rlimit stack_limit;
1275 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1276 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1277 }
1278 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1279 size_t old_stack_size = *stack_size;
1280
1281 // Use the kernel default limit as our size, and adjust the base to match.
1282 *stack_size = 8 * MB;
1283 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1284
1285 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1286 << " to " << PrettySize(*stack_size)
1287 << " with base " << *stack_base;
1288 }
1289 }
1290#endif
1291
1292#endif
1293}
1294
Ian Rogersf4d4da12014-11-11 16:10:33 -08001295bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001296 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001297 void* read_stack_base;
1298 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001299 size_t read_guard_size;
1300 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001301
Ian Rogers13735952014-10-08 12:43:28 -07001302 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001303 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001304
Dave Allison648d7112014-07-25 16:15:27 -07001305 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1306 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1307 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1308 // between 8K and 12K.
1309 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1310 + 4 * KB;
1311 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001312 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001313 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1314 __LINE__,
1315 ::android::base::ERROR,
1316 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001317 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001318 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001319
Vladimir Markob8f2f632015-01-02 14:23:26 +00001320 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1321 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1322 read_stack_base,
1323 PrettySize(read_stack_size).c_str(),
1324 PrettySize(read_guard_size).c_str());
1325
Ian Rogers932746a2011-09-22 18:57:50 -07001326 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001327
1328 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001329 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001330
Dave Allisonb090a182014-08-14 17:02:48 +00001331 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001332
1333 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001334 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001335 // The thread might have protected region at the bottom. We need
1336 // to install our own region so we need to move the limits
1337 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001338
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001339 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1340 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
Vladimir Markocedec9d2021-02-08 16:16:13 +00001341 tlsPtr_.stack_size -= read_guard_size + kStackOverflowProtectedSize;
Dave Allison648d7112014-07-25 16:15:27 -07001342
1343 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001344 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001345
David Srbecky346fd962020-07-27 16:51:00 +01001346 // Consistency check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001347 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001348
1349 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001350}
1351
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001352void Thread::ShortDump(std::ostream& os) const {
1353 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001354 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001355 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001356 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001357 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001358 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001359 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001360 << ",Thread*=" << this
1361 << ",peer=" << tlsPtr_.opeer
1362 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1363 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001364}
1365
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001366void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1367 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001368 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001369 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001370}
1371
Vladimir Marko4617d582019-03-28 13:48:31 +00001372ObjPtr<mirror::String> Thread::GetThreadName() const {
Andreas Gampe08883de2016-11-08 13:20:52 -08001373 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001374 if (tlsPtr_.opeer == nullptr) {
1375 return nullptr;
1376 }
1377 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1378 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001379}
1380
Elliott Hughesffb465f2012-03-01 18:46:05 -08001381void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001382 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001383}
1384
Jeff Hao57dac6e2013-08-15 16:36:24 -07001385uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001386#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001387 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001388 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001389 timespec now;
1390 clock_gettime(cpu_clock_id, &now);
Eric Holkf1e1dd12020-08-21 15:38:12 -07001391 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) +
1392 static_cast<uint64_t>(now.tv_nsec) / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001393#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001394 UNIMPLEMENTED(WARNING);
1395 return -1;
1396#endif
1397}
1398
Ian Rogers01ae5802012-09-28 16:14:01 -07001399// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1400static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001401 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001402 Locks::thread_suspend_count_lock_->Unlock(self);
1403 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1404 Locks::mutator_lock_->SharedTryLock(self);
1405 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1406 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1407 }
1408 }
1409 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1410 Locks::thread_list_lock_->TryLock(self);
1411 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1412 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1413 }
1414 }
1415 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001416 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001417 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001418}
1419
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001420bool Thread::ModifySuspendCountInternal(Thread* self,
1421 int delta,
1422 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001423 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001424 if (kIsDebugBuild) {
Alex Light72e27b02020-07-27 12:59:58 -07001425 DCHECK(delta == -1 || delta == +1)
1426 << reason << " " << delta << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001427 Locks::thread_suspend_count_lock_->AssertHeld(self);
1428 if (this != self && !IsSuspended()) {
1429 Locks::thread_list_lock_->AssertHeld(self);
1430 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001431 }
Alex Light88fd7202017-06-30 08:31:59 -07001432 // User code suspensions need to be checked more closely since they originate from code outside of
1433 // the runtime's control.
1434 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1435 Locks::user_code_suspension_lock_->AssertHeld(self);
1436 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1437 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1438 return false;
1439 }
1440 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001441 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001442 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001443 return false;
1444 }
1445
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001446 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1447 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1448 // deadlock. b/31683379.
1449 return false;
1450 }
1451
Yu Lieac44242015-06-29 10:50:03 +08001452 uint16_t flags = kSuspendRequest;
1453 if (delta > 0 && suspend_barrier != nullptr) {
1454 uint32_t available_barrier = kMaxSuspendBarriers;
1455 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1456 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1457 available_barrier = i;
1458 break;
1459 }
1460 }
1461 if (available_barrier == kMaxSuspendBarriers) {
1462 // No barrier spaces available, we can't add another.
1463 return false;
1464 }
1465 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1466 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001467 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001468
Ian Rogersdd7624d2014-03-14 17:43:00 -07001469 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001470 switch (reason) {
Alex Light88fd7202017-06-30 08:31:59 -07001471 case SuspendReason::kForUserCode:
1472 tls32_.user_code_suspend_count += delta;
1473 break;
Alex Light46f93402017-06-29 11:59:50 -07001474 case SuspendReason::kInternal:
1475 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001476 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001477
Ian Rogersdd7624d2014-03-14 17:43:00 -07001478 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001479 AtomicClearFlag(kSuspendRequest);
1480 } else {
Yu Lieac44242015-06-29 10:50:03 +08001481 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001482 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001483 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001484 }
Yu Lieac44242015-06-29 10:50:03 +08001485 return true;
1486}
1487
1488bool Thread::PassActiveSuspendBarriers(Thread* self) {
1489 // Grab the suspend_count lock and copy the current set of
1490 // barriers. Then clear the list and the flag. The ModifySuspendCount
1491 // function requires the lock so we prevent a race between setting
1492 // the kActiveSuspendBarrier flag and clearing it.
1493 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1494 {
1495 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1496 if (!ReadFlag(kActiveSuspendBarrier)) {
1497 // quick exit test: the barriers have already been claimed - this is
1498 // possible as there may be a race to claim and it doesn't matter
1499 // who wins.
1500 // All of the callers of this function (except the SuspendAllInternal)
1501 // will first test the kActiveSuspendBarrier flag without lock. Here
1502 // double-check whether the barrier has been passed with the
1503 // suspend_count lock.
1504 return false;
1505 }
1506
1507 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1508 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1509 tlsPtr_.active_suspend_barriers[i] = nullptr;
1510 }
1511 AtomicClearFlag(kActiveSuspendBarrier);
1512 }
1513
1514 uint32_t barrier_count = 0;
1515 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1516 AtomicInteger* pending_threads = pass_barriers[i];
1517 if (pending_threads != nullptr) {
1518 bool done = false;
1519 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001520 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001521 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1522 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001523 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001524#if ART_USE_FUTEXES
1525 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Hans Boehm81dc7ab2019-04-19 17:34:31 -07001526 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, INT_MAX, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001527 }
1528#endif
1529 } while (!done);
1530 ++barrier_count;
1531 }
1532 }
1533 CHECK_GT(barrier_count, 0U);
1534 return true;
1535}
1536
1537void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1538 CHECK(ReadFlag(kActiveSuspendBarrier));
1539 bool clear_flag = true;
1540 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1541 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1542 if (ptr == target) {
1543 tlsPtr_.active_suspend_barriers[i] = nullptr;
1544 } else if (ptr != nullptr) {
1545 clear_flag = false;
1546 }
1547 }
1548 if (LIKELY(clear_flag)) {
1549 AtomicClearFlag(kActiveSuspendBarrier);
1550 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001551}
1552
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001553void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001554 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1555 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1556 Closure* checkpoint;
1557 {
1558 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1559 checkpoint = tlsPtr_.checkpoint_function;
1560 if (!checkpoint_overflow_.empty()) {
1561 // Overflow list not empty, copy the first one out and continue.
1562 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1563 checkpoint_overflow_.pop_front();
1564 } else {
1565 // No overflow checkpoints. Clear the kCheckpointRequest flag
1566 tlsPtr_.checkpoint_function = nullptr;
1567 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001568 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001569 }
1570 // Outside the lock, run the checkpoint function.
1571 ScopedTrace trace("Run checkpoint function");
1572 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1573 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001574}
1575
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001576void Thread::RunEmptyCheckpoint() {
1577 DCHECK_EQ(Thread::Current(), this);
1578 AtomicClearFlag(kEmptyCheckpointRequest);
1579 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1580}
1581
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001582bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001583 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001584 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001585 if (old_state_and_flags.as_struct.state != kRunnable) {
1586 return false; // Fail, thread is suspended and so can't run a checkpoint.
1587 }
Dave Allison0aded082013-11-07 13:15:11 -08001588
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001589 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001590 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001591 union StateAndFlags new_state_and_flags;
1592 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001593 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001594 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001595 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001596 if (success) {
1597 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1598 if (tlsPtr_.checkpoint_function == nullptr) {
1599 tlsPtr_.checkpoint_function = function;
1600 } else {
1601 checkpoint_overflow_.push_back(function);
1602 }
Dave Allison0aded082013-11-07 13:15:11 -08001603 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001604 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001605 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001606 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001607}
1608
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001609bool Thread::RequestEmptyCheckpoint() {
1610 union StateAndFlags old_state_and_flags;
1611 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1612 if (old_state_and_flags.as_struct.state != kRunnable) {
1613 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1614 // heap access (eg. the read barrier).
1615 return false;
1616 }
1617
1618 // We must be runnable to request a checkpoint.
1619 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1620 union StateAndFlags new_state_and_flags;
1621 new_state_and_flags.as_int = old_state_and_flags.as_int;
1622 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001623 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001624 old_state_and_flags.as_int, new_state_and_flags.as_int);
1625 if (success) {
1626 TriggerSuspend();
1627 }
1628 return success;
1629}
1630
Andreas Gampee9f67122016-10-27 19:21:23 -07001631class BarrierClosure : public Closure {
1632 public:
1633 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1634
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001635 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001636 wrapped_->Run(self);
1637 barrier_.Pass(self);
1638 }
1639
Alex Light318afe62018-03-22 16:50:10 -07001640 void Wait(Thread* self, ThreadState suspend_state) {
1641 if (suspend_state != ThreadState::kRunnable) {
1642 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1643 } else {
1644 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1645 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001646 }
1647
1648 private:
1649 Closure* wrapped_;
1650 Barrier barrier_;
1651};
1652
Alex Lightb1e31a82017-10-04 16:57:36 -07001653// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001654bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001655 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001656 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001657 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1658 // Unlock the tll before running so that the state is the same regardless of thread.
1659 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001660 // Asked to run on this thread. Just run.
1661 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001662 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001663 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001664
1665 // The current thread is not this thread.
1666
Andreas Gampe28c4a232017-06-21 21:21:31 -07001667 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001668 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001669 return false;
1670 }
1671
Andreas Gampe28c4a232017-06-21 21:21:31 -07001672 struct ScopedThreadListLockUnlock {
1673 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1674 : self_thread(self_in) {
1675 Locks::thread_list_lock_->AssertHeld(self_thread);
1676 Locks::thread_list_lock_->Unlock(self_thread);
1677 }
1678
1679 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1680 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1681 Locks::thread_list_lock_->Lock(self_thread);
1682 }
1683
1684 Thread* self_thread;
1685 };
1686
Andreas Gampee9f67122016-10-27 19:21:23 -07001687 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001688 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001689 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1690 // suspend-count lock for too long.
1691 if (GetState() == ThreadState::kRunnable) {
1692 BarrierClosure barrier_closure(function);
1693 bool installed = false;
1694 {
1695 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1696 installed = RequestCheckpoint(&barrier_closure);
1697 }
1698 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001699 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1700 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1701 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001702 ScopedThreadStateChange sts(self, suspend_state);
1703 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001704 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001705 }
1706 // Fall-through.
1707 }
1708
1709 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1710 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1711 // certain situations.
1712 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001713 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1714
Alex Light46f93402017-06-29 11:59:50 -07001715 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001716 // Just retry the loop.
1717 sched_yield();
1718 continue;
1719 }
1720 }
1721
Andreas Gampe28c4a232017-06-21 21:21:31 -07001722 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001723 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1724 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001725 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001726 {
Alex Light318afe62018-03-22 16:50:10 -07001727 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001728 while (GetState() == ThreadState::kRunnable) {
1729 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1730 // moves us to suspended.
1731 sched_yield();
1732 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001733 }
1734
1735 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001736 }
1737
Andreas Gampee9f67122016-10-27 19:21:23 -07001738 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001739 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1740
1741 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001742 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001743 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001744 }
1745
Andreas Gampe117f9b32017-06-23 13:33:50 -07001746 {
1747 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1748 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1749 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1750 Thread::resume_cond_->Broadcast(self);
1751 }
1752
Alex Lightb1e31a82017-10-04 16:57:36 -07001753 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1754 Locks::thread_list_lock_->ExclusiveUnlock(self);
1755
Andreas Gampe28c4a232017-06-21 21:21:31 -07001756 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001757 }
1758}
1759
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001760Closure* Thread::GetFlipFunction() {
1761 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1762 Closure* func;
1763 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001764 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001765 if (func == nullptr) {
1766 return nullptr;
1767 }
Orion Hodson4557b382018-01-03 11:47:54 +00001768 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001769 DCHECK(func != nullptr);
1770 return func;
1771}
1772
1773void Thread::SetFlipFunction(Closure* function) {
1774 CHECK(function != nullptr);
1775 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001776 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001777}
1778
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001779void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001780 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001781 VLOG(threads) << this << " self-suspending";
1782 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001783 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001784 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001785 VLOG(threads) << this << " self-reviving";
1786}
1787
Andreas Gampe9186ced2016-12-12 14:28:21 -08001788static std::string GetSchedulerGroupName(pid_t tid) {
1789 // /proc/<pid>/cgroup looks like this:
1790 // 2:devices:/
1791 // 1:cpuacct,cpu:/
1792 // We want the third field from the line whose second field contains the "cpu" token.
1793 std::string cgroup_file;
Andreas Gampe43e72432019-05-14 16:15:24 -07001794 if (!android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid),
1795 &cgroup_file)) {
Andreas Gampe9186ced2016-12-12 14:28:21 -08001796 return "";
1797 }
1798 std::vector<std::string> cgroup_lines;
1799 Split(cgroup_file, '\n', &cgroup_lines);
1800 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1801 std::vector<std::string> cgroup_fields;
1802 Split(cgroup_lines[i], ':', &cgroup_fields);
1803 std::vector<std::string> cgroups;
1804 Split(cgroup_fields[1], ',', &cgroups);
1805 for (size_t j = 0; j < cgroups.size(); ++j) {
1806 if (cgroups[j] == "cpu") {
1807 return cgroup_fields[2].substr(1); // Skip the leading slash.
1808 }
1809 }
1810 }
1811 return "";
1812}
1813
1814
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001815void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001816 std::string group_name;
1817 int priority;
1818 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001819 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001820
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001821 // If flip_function is not null, it means we have run a checkpoint
1822 // before the thread wakes up to execute the flip function and the
1823 // thread roots haven't been forwarded. So the following access to
1824 // the roots (opeer or methods in the frames) would be bad. Run it
1825 // here. TODO: clean up.
1826 if (thread != nullptr) {
1827 ScopedObjectAccessUnchecked soa(self);
1828 Thread* this_thread = const_cast<Thread*>(thread);
1829 Closure* flip_func = this_thread->GetFlipFunction();
1830 if (flip_func != nullptr) {
1831 flip_func->Run(this_thread);
1832 }
1833 }
1834
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001835 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1836 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001837 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001838 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001839 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001840 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001841 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001842 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001843
Mathieu Chartier3398c782016-09-30 10:27:43 -07001844 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001845 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1846 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001847
Dave Allison0aded082013-11-07 13:15:11 -08001848 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001849 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001850 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001851 ObjPtr<mirror::String> group_name_string =
1852 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001853 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001854 }
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01001855 } else if (thread != nullptr) {
1856 priority = thread->GetNativePriority();
Elliott Hughesd369bb72011-09-12 14:41:14 -07001857 } else {
Orion Hodsonc5323fe2021-02-04 21:20:30 +00001858 palette_status_t status = PaletteSchedGetPriority(tid, &priority);
1859 CHECK(status == PALETTE_STATUS_OK || status == PALETTE_STATUS_CHECK_ERRNO);
Elliott Hughesdcc24742011-09-07 14:02:44 -07001860 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001861
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001862 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001863 if (scheduler_group_name.empty()) {
1864 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001865 }
1866
Dave Allison0aded082013-11-07 13:15:11 -08001867 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001868 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001869 if (is_daemon) {
1870 os << " daemon";
1871 }
1872 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001873 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001874 << " " << thread->GetState();
1875 if (thread->IsStillStarting()) {
1876 os << " (still starting up)";
1877 }
1878 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001879 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001880 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001881 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001882 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001883 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001884
Dave Allison0aded082013-11-07 13:15:11 -08001885 if (thread != nullptr) {
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001886 auto suspend_log_fn = [&]() REQUIRES(Locks::thread_suspend_count_lock_) {
1887 os << " | group=\"" << group_name << "\""
1888 << " sCount=" << thread->tls32_.suspend_count
Alex Lighta462fa62020-07-27 12:58:33 -07001889 << " ucsCount=" << thread->tls32_.user_code_suspend_count
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001890 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
1891 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
1892 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1893 };
1894 if (Locks::thread_suspend_count_lock_->IsExclusiveHeld(self)) {
1895 Locks::thread_suspend_count_lock_->AssertExclusiveHeld(self); // For annotalysis.
1896 suspend_log_fn();
1897 } else {
1898 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1899 suspend_log_fn();
1900 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001901 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001902
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001903 os << " | sysTid=" << tid
Eric Holkf1e1dd12020-08-21 15:38:12 -07001904 << " nice=" << getpriority(PRIO_PROCESS, static_cast<id_t>(tid))
Elliott Hughes0d39c122012-06-06 16:41:17 -07001905 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001906 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001907 int policy;
1908 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001909#if !defined(__APPLE__)
1910 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1911 policy = sched_getscheduler(tid);
1912 if (policy == -1) {
1913 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1914 }
1915 int sched_getparam_result = sched_getparam(tid, &sp);
1916 if (sched_getparam_result == -1) {
1917 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1918 sp.sched_priority = -1;
1919 }
1920#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001921 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1922 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001923#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001924 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001925 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001926 }
1927 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001928
1929 // Grab the scheduler stats for this thread.
1930 std::string scheduler_stats;
Andreas Gampe43e72432019-05-14 16:15:24 -07001931 if (android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid),
1932 &scheduler_stats)
Evan Chengd57c51e2018-01-26 15:43:08 +08001933 && !scheduler_stats.empty()) {
1934 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001935 } else {
1936 scheduler_stats = "0 0 0";
1937 }
1938
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001939 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001940 int utime = 0;
1941 int stime = 0;
1942 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001943 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001944
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001945 os << " | state=" << native_thread_state
1946 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001947 << " utm=" << utime
1948 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001949 << " core=" << task_cpu
1950 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001951 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001952 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1953 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1954 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001955 // Dump the held mutexes.
1956 os << " | held mutexes=";
1957 for (size_t i = 0; i < kLockLevelCount; ++i) {
1958 if (i != kMonitorLock) {
1959 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1960 if (mutex != nullptr) {
1961 os << " \"" << mutex->GetName() << "\"";
1962 if (mutex->IsReaderWriterMutex()) {
1963 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001964 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001965 os << "(exclusive held)";
1966 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001967 os << "(shared held)";
1968 }
1969 }
1970 }
1971 }
1972 }
1973 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001974 }
1975}
1976
1977void Thread::DumpState(std::ostream& os) const {
1978 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001979}
1980
Andreas Gampe93104952017-12-13 17:13:15 -08001981struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001982 StackDumpVisitor(std::ostream& os_in,
1983 Thread* thread_in,
1984 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001985 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001986 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001987 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001988 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001989 : MonitorObjectsStackVisitor(thread_in,
1990 context,
1991 check_suspended,
1992 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001993 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001994 last_method(nullptr),
1995 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001996 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001997
Ian Rogersbdb03912011-09-14 00:55:44 -07001998 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001999 if (frame_count == 0) {
2000 os << " (no managed stack frames)\n";
2001 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07002002 }
2003
Andreas Gampe93104952017-12-13 17:13:15 -08002004 static constexpr size_t kMaxRepetition = 3u;
2005
2006 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002007 override
Andreas Gampe93104952017-12-13 17:13:15 -08002008 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07002009 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00002010 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08002011 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08002012 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07002013 const DexFile* dex_file = dex_cache->GetDexFile();
2014 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08002015 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07002016 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08002017 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002018 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07002019 if (repetition_count >= kMaxRepetition) {
2020 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
2021 }
2022 repetition_count = 0;
2023 last_line_number = line_number;
2024 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002025 }
Andreas Gampe93104952017-12-13 17:13:15 -08002026
2027 if (repetition_count >= kMaxRepetition) {
2028 // Skip visiting=printing anything.
2029 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002030 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07002031
Andreas Gampe93104952017-12-13 17:13:15 -08002032 os << " at " << m->PrettyMethod(false);
2033 if (m->IsNative()) {
2034 os << "(Native method)";
2035 } else {
2036 const char* source_file(m->GetDeclaringClassSourceFile());
2037 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2038 << ":" << line_number << ")";
2039 }
2040 os << "\n";
2041 // Go and visit locks.
2042 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002043 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002044
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002045 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002046 return VisitMethodResult::kContinueMethod;
2047 }
2048
Vladimir Markof52d92f2019-03-29 12:33:02 +00002049 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002050 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002051 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002052 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2053 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002054 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002055 override
Andreas Gampe93104952017-12-13 17:13:15 -08002056 REQUIRES_SHARED(Locks::mutator_lock_) {
2057 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2058 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002059 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002060 ThreadState state,
2061 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002062 override
Andreas Gampe93104952017-12-13 17:13:15 -08002063 REQUIRES_SHARED(Locks::mutator_lock_) {
2064 const char* msg;
2065 switch (state) {
2066 case kBlocked:
2067 msg = " - waiting to lock ";
2068 break;
2069
2070 case kWaitingForLockInflation:
2071 msg = " - waiting for lock inflation of ";
2072 break;
2073
2074 default:
2075 LOG(FATAL) << "Unreachable";
2076 UNREACHABLE();
2077 }
2078 PrintObject(obj, msg, owner_tid);
2079 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002080 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002081 override
Andreas Gampe93104952017-12-13 17:13:15 -08002082 REQUIRES_SHARED(Locks::mutator_lock_) {
2083 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2084 }
2085
Vladimir Markof52d92f2019-03-29 12:33:02 +00002086 void PrintObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002087 const char* msg,
2088 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2089 if (obj == nullptr) {
2090 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002091 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002092 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002093 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2094 // Getting the identity hashcode here would result in lock inflation and suspension of the
2095 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002096 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
Vladimir Markof52d92f2019-03-29 12:33:02 +00002097 reinterpret_cast<intptr_t>(obj.Ptr()),
Andreas Gampe93104952017-12-13 17:13:15 -08002098 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002099 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002100 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2101 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2102 // suspension and move pretty_object.
2103 const std::string pretty_type(obj->PrettyTypeOf());
2104 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002105 }
2106 }
Andreas Gampe93104952017-12-13 17:13:15 -08002107 if (owner_tid != ThreadList::kInvalidThreadId) {
2108 os << " held by thread " << owner_tid;
2109 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002110 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002111 }
2112
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002113 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002114 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002115 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002116 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002117};
2118
Ian Rogers33e95662013-05-20 20:29:14 -07002119static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002120 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002121 ThreadState state = thread->GetState();
2122
2123 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2124 if (state > kWaiting && state < kStarting) {
2125 return true;
2126 }
2127
2128 // In an Object.wait variant or Thread.sleep? That's not interesting.
2129 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2130 return false;
2131 }
2132
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002133 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002134 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002135 return true;
2136 }
2137
Elliott Hughesaef701d2013-04-05 18:15:40 -07002138 // In some other native method? That's interesting.
2139 // We don't just check kNative because native methods will be in state kSuspended if they're
2140 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2141 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002142 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002143 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002144}
2145
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002146void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002147 // If flip_function is not null, it means we have run a checkpoint
2148 // before the thread wakes up to execute the flip function and the
2149 // thread roots haven't been forwarded. So the following access to
2150 // the roots (locks or methods in the frames) would be bad. Run it
2151 // here. TODO: clean up.
2152 {
2153 Thread* this_thread = const_cast<Thread*>(this);
2154 Closure* flip_func = this_thread->GetFlipFunction();
2155 if (flip_func != nullptr) {
2156 flip_func->Run(this_thread);
2157 }
2158 }
2159
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002160 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2161 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002162 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2163 // thread.
Alex Lightb7c640d2019-03-20 15:52:13 -07002164 ScopedExceptionStorage ses(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002165
Ian Rogers700a4022014-05-19 16:49:03 -07002166 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002167 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002168 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002169 dumper.WalkStack();
2170}
2171
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002172void Thread::DumpStack(std::ostream& os,
2173 bool dump_native_stack,
2174 BacktraceMap* backtrace_map,
2175 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002176 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2177 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2178 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002179 bool dump_for_abort = (gAborting > 0);
2180 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2181 if (!kIsDebugBuild) {
2182 // We always want to dump the stack for an abort, however, there is no point dumping another
2183 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2184 safe_to_dump = (safe_to_dump || dump_for_abort);
2185 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002186 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002187 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002188 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002189 ArtMethod* method =
2190 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002191 /*check_suspended=*/ !force_dump_stack,
2192 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002193 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002194 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002195 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002196 /*check_suspended=*/ !force_dump_stack,
2197 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002198 } else {
2199 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002200 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002201}
2202
Elliott Hughesbe759c62011-09-08 19:38:21 -07002203void Thread::ThreadExitCallback(void* arg) {
2204 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002205 if (self->tls32_.thread_exit_check_count == 0) {
2206 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2207 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002208 CHECK(is_started_);
Andreas Gampea47a6e82019-07-24 09:46:16 -07002209#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002210 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2211#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002212 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe82372002019-07-24 15:42:09 -07002213 Thread::self_tls_ = self;
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002214#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002215 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002216 } else {
2217 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2218 }
Carl Shapirob5573532011-07-12 18:22:59 -07002219}
2220
Elliott Hughesbe759c62011-09-08 19:38:21 -07002221void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002222 CHECK(!is_started_);
2223 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002224 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002225 // MutexLock to keep annotalysis happy.
2226 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002227 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002228 // return garbage since (is_started_ == true) and
2229 // Thread::pthread_key_self_ is not yet initialized.
2230 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002231 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002232 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2233 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002234 }
2235
Carl Shapirob5573532011-07-12 18:22:59 -07002236 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002237 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2238 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002239
2240 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002241 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2242 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002243 }
Andreas Gampe82372002019-07-24 15:42:09 -07002244#ifndef __BIONIC__
2245 CHECK(Thread::self_tls_ == nullptr);
2246#endif
Elliott Hughes038a8062011-09-18 14:12:41 -07002247}
Carl Shapirob5573532011-07-12 18:22:59 -07002248
Elliott Hughes038a8062011-09-18 14:12:41 -07002249void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002250 Runtime* runtime = Runtime::Current();
2251 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002252
Elliott Hughes01158d72011-09-19 19:47:10 -07002253 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002254 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002255 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2256 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002257
Vladimir Markodcfcce42018-06-27 10:00:28 +00002258 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002259
2260 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2261 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002262 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2263 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002264}
2265
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002266void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002267 CHECK(is_started_);
2268 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002269 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002270 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002271 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002272 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002273 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002274 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002275}
2276
Andreas Gampe56776012018-01-26 17:40:55 -08002277void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2278 ScopedLocalRef<jobject> thread_jobject(
2279 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2280 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2281 soa.Env(), nullptr);
2282 jobject thread_group_jobject = thread_group;
2283 if (thread_group == nullptr || kIsDebugBuild) {
2284 // There is always a group set. Retrieve it.
2285 thread_group_jobject_scoped.reset(
2286 soa.Env()->GetObjectField(thread_jobject.get(),
2287 WellKnownClasses::java_lang_Thread_group));
2288 thread_group_jobject = thread_group_jobject_scoped.get();
2289 if (kIsDebugBuild && thread_group != nullptr) {
2290 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2291 }
2292 }
2293 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2294 WellKnownClasses::java_lang_ThreadGroup,
2295 WellKnownClasses::java_lang_ThreadGroup_add,
2296 thread_jobject.get());
2297}
2298
Calin Juravleccd56952016-12-15 17:57:38 +00002299Thread::Thread(bool daemon)
2300 : tls32_(daemon),
2301 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002302 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002303 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002304 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Nicolas Geoffraye91e7952020-01-23 10:15:56 +00002305 tlsPtr_.instrumentation_stack =
2306 new std::map<uintptr_t, instrumentation::InstrumentationStackFrame>;
Ian Rogersdd7624d2014-03-14 17:43:00 -07002307 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2308
Roland Levillain33d69032015-06-18 18:20:59 +01002309 static_assert((sizeof(Thread) % 4) == 0U,
2310 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002311 tls32_.state_and_flags.as_struct.flags = 0;
2312 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002313 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002314 // Initialize with no permit; if the java Thread was unparked before being
2315 // started, it will unpark itself before calling into java code.
2316 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002317 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002318 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002319 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002320 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002321 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002322 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2323 tlsPtr_.active_suspend_barriers[i] = nullptr;
2324 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002325 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002326 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002327 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002328 tls32_.use_mterp = false;
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08002329 ResetTlab();
David Srbecky28f6cff2018-10-16 15:07:28 +01002330}
2331
2332void Thread::NotifyInTheadList() {
2333 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002334}
2335
Alex Lighte9f61032018-09-24 16:04:51 -07002336bool Thread::CanLoadClasses() const {
2337 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2338}
2339
Elliott Hughes7dc51662012-05-16 14:48:43 -07002340bool Thread::IsStillStarting() const {
2341 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002342 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002343 // 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 -07002344 // assigned fairly early on, and needs to be.
2345 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2346 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002347 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2348 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002349}
2350
Andreas Gamped9efea62014-07-21 22:56:08 -07002351void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002352 CHECK(IsExceptionPending()) << "Pending exception expected.";
2353}
2354
2355void Thread::AssertPendingOOMException() const {
2356 AssertPendingException();
2357 auto* e = GetException();
2358 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2359 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002360}
2361
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002362void Thread::AssertNoPendingException() const {
2363 if (UNLIKELY(IsExceptionPending())) {
2364 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002365 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002366 }
2367}
2368
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002369void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2370 if (UNLIKELY(IsExceptionPending())) {
2371 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002372 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002373 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002374 }
2375}
2376
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002377class MonitorExitVisitor : public SingleRootVisitor {
2378 public:
2379 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2380
2381 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2382 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002383 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002384 if (self_->HoldsLock(entered_monitor)) {
2385 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002386 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002387 << " left locked by native thread "
2388 << *Thread::Current() << " which is detaching";
2389 entered_monitor->MonitorExit(self_);
2390 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002391 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002392
2393 private:
2394 Thread* const self_;
2395};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002396
Elliott Hughesc0f09332012-03-26 13:27:06 -07002397void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002398 Thread* self = this;
2399 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002400
Ian Rogers68d8b422014-07-17 11:09:10 -07002401 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002402 {
2403 ScopedObjectAccess soa(self);
2404 MonitorExitVisitor visitor(self);
2405 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002406 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002407 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002408 // Release locally held global references which releasing may require the mutator lock.
2409 if (tlsPtr_.jpeer != nullptr) {
2410 // If pthread_create fails we don't have a jni env here.
2411 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2412 tlsPtr_.jpeer = nullptr;
2413 }
2414 if (tlsPtr_.class_loader_override != nullptr) {
2415 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2416 tlsPtr_.class_loader_override = nullptr;
2417 }
2418 }
2419
Ian Rogersdd7624d2014-03-14 17:43:00 -07002420 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002421 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002422 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002423 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002424 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002425 Runtime* runtime = Runtime::Current();
2426 if (runtime != nullptr) {
2427 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2428 }
Elliott Hughes534da072012-03-27 15:17:42 -07002429
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002430 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002431 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002432 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002433 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002434 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002435 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002436 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002437 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002438
Ian Rogerscfaa4552012-11-26 21:00:08 -08002439 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2440 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002441 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002442 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002443 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002444 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002445 StackHandleScope<1> hs(self);
2446 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002447 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002448 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002449 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002450 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002451 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002452
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002453 {
2454 ScopedObjectAccess soa(self);
2455 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Lokesh Gidra93170312019-12-04 13:46:11 -08002456 }
2457 // Mark-stack revocation must be performed at the very end. No
2458 // checkpoint/flip-function or read-barrier should be called after this.
2459 if (kUseReadBarrier) {
2460 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002461 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002462}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002463
Elliott Hughesc0f09332012-03-26 13:27:06 -07002464Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002465 CHECK(tlsPtr_.class_loader_override == nullptr);
2466 CHECK(tlsPtr_.jpeer == nullptr);
2467 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002468 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002469 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002470 delete tlsPtr_.jni_env;
2471 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002472 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002473 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002474 CHECK(!ReadFlag(kCheckpointRequest));
2475 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002476 CHECK(tlsPtr_.checkpoint_function == nullptr);
2477 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002478 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002479 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002480
Sebastien Hertz07474662015-08-25 15:12:33 +00002481 // Make sure we processed all deoptimization requests.
2482 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002483 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2484 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002485
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002486 // We may be deleting a still born thread.
2487 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002488
2489 delete wait_cond_;
2490 delete wait_mutex_;
2491
Ian Rogersdd7624d2014-03-14 17:43:00 -07002492 if (tlsPtr_.long_jump_context != nullptr) {
2493 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002494 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002495
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002496 if (initialized) {
2497 CleanupCpu();
2498 }
2499
Ian Rogersdd7624d2014-03-14 17:43:00 -07002500 delete tlsPtr_.instrumentation_stack;
2501 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002502 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002503
Ian Rogers68d8b422014-07-17 11:09:10 -07002504 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002505
Elliott Hughesd8af1592012-04-16 20:40:15 -07002506 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002507}
2508
Andreas Gampe513061a2017-06-01 09:17:34 -07002509void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002510 if (!IsExceptionPending()) {
2511 return;
2512 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002513 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002514 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002515
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002516 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002517 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2518 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002519
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002520 // Call the Thread instance's dispatchUncaughtException(Throwable)
2521 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2522 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2523 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002524
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002525 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002526 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002527}
2528
Andreas Gampe513061a2017-06-01 09:17:34 -07002529void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002530 // this.group.removeThread(this);
2531 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002532 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002533 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002534 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002535 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002536 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002537 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002538 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2539 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2540 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002541 }
2542}
2543
Vladimir Markocedec9d2021-02-08 16:16:13 +00002544template <bool kPointsToStack>
2545class JniTransitionReferenceVisitor : public StackVisitor {
2546 public:
2547 JniTransitionReferenceVisitor(Thread* thread, void* obj) REQUIRES_SHARED(Locks::mutator_lock_)
2548 : StackVisitor(thread, /*context=*/ nullptr, StackVisitor::StackWalkKind::kSkipInlinedFrames),
2549 obj_(obj),
2550 found_(false) {}
2551
2552 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
2553 ArtMethod* m = GetMethod();
2554 if (!m->IsNative() || m->IsCriticalNative()) {
2555 return true;
2556 }
2557 if (kPointsToStack) {
2558 uint8_t* sp = reinterpret_cast<uint8_t*>(GetCurrentQuickFrame());
2559 size_t frame_size = GetCurrentQuickFrameInfo().FrameSizeInBytes();
2560 uint32_t* current_vreg = reinterpret_cast<uint32_t*>(sp + frame_size + sizeof(ArtMethod*));
2561 if (!m->IsStatic()) {
2562 if (current_vreg == obj_) {
2563 found_ = true;
2564 return false;
2565 }
2566 current_vreg += 1u;
2567 }
2568 const char* shorty = m->GetShorty();
2569 for (size_t i = 1, len = strlen(shorty); i != len; ++i) {
2570 switch (shorty[i]) {
2571 case 'D':
2572 case 'J':
2573 current_vreg += 2u;
2574 break;
2575 case 'L':
2576 if (current_vreg == obj_) {
2577 found_ = true;
2578 return false;
2579 }
2580 FALLTHROUGH_INTENDED;
2581 default:
2582 current_vreg += 1u;
2583 break;
2584 }
2585 }
2586 // Continue only if the object is somewhere higher on the stack.
2587 return obj_ >= current_vreg;
2588 } else { // if (kPointsToStack)
2589 if (m->IsStatic() && obj_ == m->GetDeclaringClassAddressWithoutBarrier()) {
2590 found_ = true;
2591 return false;
2592 }
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002593 return true;
2594 }
2595 }
Vladimir Markocedec9d2021-02-08 16:16:13 +00002596
2597 bool Found() const {
2598 return found_;
2599 }
2600
2601 private:
2602 void* obj_;
2603 bool found_;
2604};
2605
2606bool Thread::IsJniTransitionReference(jobject obj) const {
2607 DCHECK(obj != nullptr);
2608 // We need a non-const pointer for stack walk even if we're not modifying the thread state.
2609 Thread* thread = const_cast<Thread*>(this);
2610 uint8_t* raw_obj = reinterpret_cast<uint8_t*>(obj);
2611 if (static_cast<size_t>(raw_obj - tlsPtr_.stack_begin) < tlsPtr_.stack_size) {
2612 JniTransitionReferenceVisitor</*kPointsToStack=*/ true> visitor(thread, raw_obj);
2613 visitor.WalkStack();
2614 return visitor.Found();
2615 } else {
2616 JniTransitionReferenceVisitor</*kPointsToStack=*/ false> visitor(thread, raw_obj);
2617 visitor.WalkStack();
2618 return visitor.Found();
2619 }
TDYa12728f1a142012-03-15 21:51:52 -07002620}
2621
Eric Holkf1e1dd12020-08-21 15:38:12 -07002622void Thread::HandleScopeVisitRoots(RootVisitor* visitor, uint32_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002623 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2624 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002625 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2626 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002627 }
2628}
2629
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002630ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002631 if (obj == nullptr) {
2632 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002633 }
2634 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002635 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002636 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002637 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002638 // The "kinds" below are sorted by the frequency we expect to encounter them.
2639 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002640 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002641 // Local references do not need a read barrier.
2642 result = locals.Get<kWithoutReadBarrier>(ref);
Vladimir Markocedec9d2021-02-08 16:16:13 +00002643 } else if (kind == kJniTransitionOrInvalid) {
2644 // The `jclass` for a static method points to the CompressedReference<> in the
2645 // `ArtMethod::declaring_class_`. Other `jobject` arguments point to spilled stack
2646 // references but a StackReference<> is just a subclass of CompressedReference<>.
2647 DCHECK(IsJniTransitionReference(obj));
2648 result = reinterpret_cast<mirror::CompressedReference<mirror::Object>*>(obj)->AsMirrorPtr();
Vladimir Marko17491ac2020-12-01 12:02:29 +00002649 VerifyObject(result);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002650 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002651 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002652 } else {
2653 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002654 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002655 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002656 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002657 expect_null = true;
2658 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002659 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002660 }
2661
Vladimir Marko17491ac2020-12-01 12:02:29 +00002662 DCHECK(expect_null || result != nullptr)
2663 << "use of deleted " << ToStr<IndirectRefKind>(kind).c_str()
2664 << " " << static_cast<const void*>(obj);
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002665 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002666}
2667
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002668bool Thread::IsJWeakCleared(jweak obj) const {
2669 CHECK(obj != nullptr);
2670 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002671 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002672 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002673 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002674}
2675
Ian Rogers81d425b2012-09-27 16:03:43 -07002676// Implements java.lang.Thread.interrupted.
2677bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002678 DCHECK_EQ(Thread::Current(), this);
2679 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002680 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002681 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002682 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002683 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002684 return interrupted;
2685}
2686
2687// Implements java.lang.Thread.isInterrupted.
2688bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002689 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002690}
2691
Ian Rogersdd7624d2014-03-14 17:43:00 -07002692void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002693 {
2694 MutexLock mu(self, *wait_mutex_);
2695 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2696 return;
2697 }
2698 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2699 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002700 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002701 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002702}
2703
2704void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002705 Thread* self = Thread::Current();
2706 MutexLock mu(self, *wait_mutex_);
2707 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002708}
2709
Ian Rogersc604d732012-10-14 16:09:54 -07002710void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002711 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002712 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002713 }
2714}
2715
Ian Rogers68d8b422014-07-17 11:09:10 -07002716void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2717 if (tlsPtr_.class_loader_override != nullptr) {
2718 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2719 }
2720 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2721}
2722
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002723using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2724
2725// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2726class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002727 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002728 explicit FetchStackTraceVisitor(Thread* thread,
2729 ArtMethodDexPcPair* saved_frames = nullptr,
2730 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002731 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002732 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002733 saved_frames_(saved_frames),
2734 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002735
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002736 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002737 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002738 // Note we also skip the frame if it doesn't have a method (namely the callee
2739 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002740 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002741 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002742 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002743 skipping_ = false;
2744 }
2745 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002746 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002747 if (depth_ < max_saved_frames_) {
2748 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002749 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002750 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002751 ++depth_;
2752 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002753 } else {
2754 ++skip_depth_;
2755 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002756 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002757 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002758
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002759 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002760 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002761 }
2762
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002763 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002764 return skip_depth_;
2765 }
2766
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002767 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002768 uint32_t depth_ = 0;
2769 uint32_t skip_depth_ = 0;
2770 bool skipping_ = true;
2771 ArtMethodDexPcPair* saved_frames_;
2772 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002773
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002774 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002775};
2776
Ian Rogers0399dde2012-06-06 17:09:28 -07002777class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002778 public:
Eric Holkf1e1dd12020-08-21 15:38:12 -07002779 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, uint32_t skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002780 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2781 self_(self),
2782 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002783 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002784
Eric Holkf1e1dd12020-08-21 15:38:12 -07002785 bool Init(uint32_t depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002786 // Allocate method trace as an object array where the first element is a pointer array that
2787 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2788 // class of the ArtMethod pointers.
2789 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2790 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002791 ObjPtr<mirror::Class> array_class =
2792 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002793 // The first element is the methods and dex pc array, the other elements are declaring classes
2794 // for the methods to ensure classes in the stack trace don't get unloaded.
2795 Handle<mirror::ObjectArray<mirror::Object>> trace(
Eric Holkf1e1dd12020-08-21 15:38:12 -07002796 hs.NewHandle(mirror::ObjectArray<mirror::Object>::Alloc(
2797 hs.Self(), array_class, static_cast<int32_t>(depth) + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002798 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002799 // Acquire uninterruptible_ in all paths.
2800 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002801 self_->AssertPendingOOMException();
2802 return false;
2803 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002804 ObjPtr<mirror::PointerArray> methods_and_pcs =
2805 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002806 const char* last_no_suspend_cause =
2807 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2808 if (methods_and_pcs == nullptr) {
2809 self_->AssertPendingOOMException();
2810 return false;
2811 }
Vladimir Markod34b73b2020-05-05 10:07:59 +01002812 trace->Set</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(0, methods_and_pcs);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002813 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002814 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002815 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002816 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002817 }
2818
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002819 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2820 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002821 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002822
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002823 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002824 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002825 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002826 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002827 if (skip_depth_ > 0) {
2828 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002829 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002830 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002831 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002832 if (m->IsRuntimeMethod()) {
2833 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002834 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002835 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002836 return true;
2837 }
2838
2839 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod34b73b2020-05-05 10:07:59 +01002840 ObjPtr<mirror::PointerArray> methods_and_pcs = GetTraceMethodsAndPCs();
2841 methods_and_pcs->SetElementPtrSize</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(
2842 count_, method, pointer_size_);
2843 methods_and_pcs->SetElementPtrSize</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(
Eric Holkf1e1dd12020-08-21 15:38:12 -07002844 static_cast<uint32_t>(methods_and_pcs->GetLength()) / 2 + count_, dex_pc, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002845 // Save the declaring class of the method to ensure that the declaring classes of the methods
2846 // do not get unloaded while the stack trace is live.
Vladimir Markod34b73b2020-05-05 10:07:59 +01002847 trace_->Set</*kTransactionActive=*/ false, /*kCheckTransaction=*/ false>(
Eric Holkf1e1dd12020-08-21 15:38:12 -07002848 static_cast<int32_t>(count_) + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002849 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002850 }
2851
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002852 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002853 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002854 }
2855
2856 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002857 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002858 }
2859
2860 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002861 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002862 // How many more frames to skip.
Eric Holkf1e1dd12020-08-21 15:38:12 -07002863 uint32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002864 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002865 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002866 // An object array where the first element is a pointer array that contains the ArtMethod
Vladimir Markod34b73b2020-05-05 10:07:59 +01002867 // pointers on the stack and dex PCs. The rest of the elements are the declaring class of
2868 // the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of the
2869 // i'th frame. We're initializing a newly allocated trace, so we do not need to record that
2870 // under a transaction. If the transaction is aborted, the whole trace shall be unreachable.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002871 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002872 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002873 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002874
2875 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002876};
2877
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002878jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002879 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2880 constexpr size_t kMaxSavedFrames = 256;
2881 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2882 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2883 &saved_frames[0],
2884 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002885 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002886 const uint32_t depth = count_visitor.GetDepth();
2887 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002888
Ian Rogers1f539342012-10-03 21:09:42 -07002889 // Build internal stack trace.
Vladimir Markod34b73b2020-05-05 10:07:59 +01002890 BuildInternalStackTraceVisitor build_trace_visitor(
2891 soa.Self(), const_cast<Thread*>(this), skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002892 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002893 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002894 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002895 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2896 // than doing the stack walk twice.
2897 if (depth < kMaxSavedFrames) {
2898 for (size_t i = 0; i < depth; ++i) {
2899 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2900 }
2901 } else {
2902 build_trace_visitor.WalkStack();
2903 }
2904
Mathieu Chartier910e8272015-09-30 09:24:22 -07002905 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002906 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002907 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002908 // Second half of trace_methods is dex PCs.
2909 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2910 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002911 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2912 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002913 }
2914 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002915 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002916}
2917
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002918bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002919 // Only count the depth since we do not pass a stack frame array as an argument.
2920 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002921 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002922 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002923}
2924
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002925static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2926 const ScopedObjectAccessAlreadyRunnable& soa,
2927 ArtMethod* method,
2928 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2929 int32_t line_number;
2930 StackHandleScope<3> hs(soa.Self());
2931 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2932 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2933 if (method->IsProxyMethod()) {
2934 line_number = -1;
2935 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2936 // source_name_object intentionally left null for proxy methods
2937 } else {
2938 line_number = method->GetLineNumFromDexPC(dex_pc);
2939 // Allocate element, potentially triggering GC
2940 // TODO: reuse class_name_object via Class::name_?
2941 const char* descriptor = method->GetDeclaringClassDescriptor();
2942 CHECK(descriptor != nullptr);
2943 std::string class_name(PrettyDescriptor(descriptor));
2944 class_name_object.Assign(
2945 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2946 if (class_name_object == nullptr) {
2947 soa.Self()->AssertPendingOOMException();
2948 return nullptr;
2949 }
2950 const char* source_file = method->GetDeclaringClassSourceFile();
2951 if (line_number == -1) {
2952 // Make the line_number field of StackTraceElement hold the dex pc.
2953 // source_name_object is intentionally left null if we failed to map the dex pc to
2954 // a line number (most probably because there is no debug info). See b/30183883.
Eric Holkf1e1dd12020-08-21 15:38:12 -07002955 line_number = static_cast<int32_t>(dex_pc);
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002956 } else {
2957 if (source_file != nullptr) {
2958 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2959 if (source_name_object == nullptr) {
2960 soa.Self()->AssertPendingOOMException();
2961 return nullptr;
2962 }
2963 }
2964 }
2965 }
2966 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2967 CHECK(method_name != nullptr);
2968 Handle<mirror::String> method_name_object(
2969 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2970 if (method_name_object == nullptr) {
2971 return nullptr;
2972 }
2973 return mirror::StackTraceElement::Alloc(soa.Self(),
2974 class_name_object,
2975 method_name_object,
2976 source_name_object,
2977 line_number);
2978}
2979
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002980jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002981 const ScopedObjectAccessAlreadyRunnable& soa,
2982 jobject internal,
2983 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002984 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002985 // Decode the internal stack trace into the depth, method trace and PC trace.
2986 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002987 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002988 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002989
Mathieu Chartier910e8272015-09-30 09:24:22 -07002990 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002991
Elliott Hughes01158d72011-09-19 19:47:10 -07002992 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002993
Dave Allison0aded082013-11-07 13:15:11 -08002994 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002995 // Reuse the array we were given.
2996 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002997 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002998 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002999 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07003000 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07003001 } else {
3002 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01003003 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Eric Holkf1e1dd12020-08-21 15:38:12 -07003004 class_linker->AllocStackTraceElementArray(soa.Self(), static_cast<size_t>(depth));
Dave Allison0aded082013-11-07 13:15:11 -08003005 if (java_traces == nullptr) {
3006 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07003007 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003008 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07003009 }
3010
Dave Allison0aded082013-11-07 13:15:11 -08003011 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07003012 *stack_depth = depth;
3013 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07003014
Eric Holkf1e1dd12020-08-21 15:38:12 -07003015 for (uint32_t i = 0; i < static_cast<uint32_t>(depth); ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003016 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07003017 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07003018 // Methods and dex PC trace is element 0.
3019 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00003020 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00003021 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07003022 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07003023 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003024 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Eric Holkf1e1dd12020-08-21 15:38:12 -07003025 i + static_cast<uint32_t>(method_trace->GetLength()) / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00003026 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08003027 if (obj == nullptr) {
3028 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07003029 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01003030 // We are called from native: use non-transactional mode.
Eric Holkf1e1dd12020-08-21 15:38:12 -07003031 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(
3032 static_cast<int32_t>(i), obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07003033 }
Ian Rogersaaa20802011-09-11 21:47:37 -07003034 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07003035}
3036
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003037jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
3038 // This code allocates. Do not allow it to operate with a pending exception.
3039 if (IsExceptionPending()) {
3040 return nullptr;
3041 }
3042
3043 // If flip_function is not null, it means we have run a checkpoint
3044 // before the thread wakes up to execute the flip function and the
3045 // thread roots haven't been forwarded. So the following access to
3046 // the roots (locks or methods in the frames) would be bad. Run it
3047 // here. TODO: clean up.
3048 // Note: copied from DumpJavaStack.
3049 {
3050 Thread* this_thread = const_cast<Thread*>(this);
3051 Closure* flip_func = this_thread->GetFlipFunction();
3052 if (flip_func != nullptr) {
3053 flip_func->Run(this_thread);
3054 }
3055 }
3056
3057 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
3058 public:
3059 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
3060 Thread* self,
3061 Context* context)
3062 : MonitorObjectsStackVisitor(self, context),
3063 wait_jobject_(soaa_in.Env(), nullptr),
3064 block_jobject_(soaa_in.Env(), nullptr),
3065 soaa_(soaa_in) {}
3066
3067 protected:
3068 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003069 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003070 REQUIRES_SHARED(Locks::mutator_lock_) {
3071 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
3072 soaa_, m, GetDexPc(/* abort on error */ false));
3073 if (obj == nullptr) {
3074 return VisitMethodResult::kEndStackWalk;
3075 }
3076 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
3077 return VisitMethodResult::kContinueMethod;
3078 }
3079
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003080 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003081 lock_objects_.push_back({});
3082 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3083
3084 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3085
3086 return VisitMethodResult::kContinueMethod;
3087 }
3088
Vladimir Markof52d92f2019-03-29 12:33:02 +00003089 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003090 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003091 REQUIRES_SHARED(Locks::mutator_lock_) {
3092 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3093 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003094 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003095 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003096 REQUIRES_SHARED(Locks::mutator_lock_) {
3097 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3098 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003099 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003100 ThreadState state ATTRIBUTE_UNUSED,
3101 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003102 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003103 REQUIRES_SHARED(Locks::mutator_lock_) {
3104 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3105 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003106 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003107 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003108 REQUIRES_SHARED(Locks::mutator_lock_) {
3109 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3110 }
3111
3112 public:
3113 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3114 ScopedLocalRef<jobject> wait_jobject_;
3115 ScopedLocalRef<jobject> block_jobject_;
3116 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3117
3118 private:
3119 const ScopedObjectAccessAlreadyRunnable& soaa_;
3120
3121 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3122 };
3123
3124 std::unique_ptr<Context> context(Context::Create());
3125 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3126 dumper.WalkStack();
3127
3128 // There should not be a pending exception. Otherwise, return with it pending.
3129 if (IsExceptionPending()) {
3130 return nullptr;
3131 }
3132
3133 // Now go and create Java arrays.
3134
3135 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3136
3137 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003138 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003139 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003140 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3141 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003142 return nullptr;
3143 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003144 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003145
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003146 Handle<mirror::Class> h_o_array_class =
3147 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3148 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003149
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003150
3151 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3152 class_linker->EnsureInitialized(soa.Self(),
3153 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003154 /* can_init_fields= */ true,
3155 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003156 if (soa.Self()->IsExceptionPending()) {
3157 // This should not fail in a healthy runtime.
3158 return nullptr;
3159 }
3160
Vladimir Markoe300c4e2021-06-08 16:00:05 +01003161 ArtField* stack_trace_element_field =
3162 h_aste_class->FindDeclaredInstanceField("stackTraceElement", "Ljava/lang/StackTraceElement;");
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003163 DCHECK(stack_trace_element_field != nullptr);
Vladimir Markoe300c4e2021-06-08 16:00:05 +01003164 ArtField* held_locks_field =
3165 h_aste_class->FindDeclaredInstanceField("heldLocks", "[Ljava/lang/Object;");
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003166 DCHECK(held_locks_field != nullptr);
Vladimir Markoe300c4e2021-06-08 16:00:05 +01003167 ArtField* blocked_on_field =
3168 h_aste_class->FindDeclaredInstanceField("blockedOn", "Ljava/lang/Object;");
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003169 DCHECK(blocked_on_field != nullptr);
3170
Eric Holkf1e1dd12020-08-21 15:38:12 -07003171 int32_t length = static_cast<int32_t>(dumper.stack_trace_elements_.size());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003172 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003173 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003174 if (array == nullptr) {
3175 soa.Self()->AssertPendingOOMException();
3176 return nullptr;
3177 }
3178
3179 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3180
3181 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3182 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3183 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
Eric Holkf1e1dd12020-08-21 15:38:12 -07003184 for (size_t i = 0; i != static_cast<size_t>(length); ++i) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003185 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3186 if (handle == nullptr) {
3187 soa.Self()->AssertPendingOOMException();
3188 return nullptr;
3189 }
3190
3191 // Set stack trace element.
3192 stack_trace_element_field->SetObject<false>(
3193 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3194
3195 // Create locked-on array.
3196 if (!dumper.lock_objects_[i].empty()) {
Eric Holkf1e1dd12020-08-21 15:38:12 -07003197 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(
3198 soa.Self(), h_o_array_class.Get(), static_cast<int32_t>(dumper.lock_objects_[i].size())));
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003199 if (handle2 == nullptr) {
3200 soa.Self()->AssertPendingOOMException();
3201 return nullptr;
3202 }
3203 int32_t j = 0;
3204 for (auto& scoped_local : dumper.lock_objects_[i]) {
3205 if (scoped_local == nullptr) {
3206 continue;
3207 }
3208 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3209 DCHECK(!soa.Self()->IsExceptionPending());
3210 j++;
3211 }
3212 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3213 }
3214
3215 // Set blocked-on object.
3216 if (i == 0) {
3217 if (dumper.block_jobject_ != nullptr) {
3218 blocked_on_field->SetObject<false>(
3219 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3220 }
3221 }
3222
3223 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
Eric Holkf1e1dd12020-08-21 15:38:12 -07003224 soa.Env()->SetObjectArrayElement(result.get(), static_cast<jsize>(i), elem.get());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003225 DCHECK(!soa.Self()->IsExceptionPending());
3226 }
3227
3228 return result.release();
3229}
3230
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003231void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003232 va_list args;
3233 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003234 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003235 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003236}
3237
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003238void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003239 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003240 std::string msg;
3241 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003242 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003243}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003244
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003245void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003246 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003247 // Callers should either clear or call ThrowNewWrappedException.
3248 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003249 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003250}
3251
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003252static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003253 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003254 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003255 return method != nullptr
3256 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003257 : nullptr;
3258}
3259
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003260void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003261 const char* msg) {
3262 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003263 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003264 StackHandleScope<3> hs(soa.Self());
Calin Juravle2c2724c2021-01-14 19:54:23 -08003265
3266 // Disable public sdk checks if we need to throw exceptions.
3267 // The checks are only used in AOT compilation and may block (exception) class
3268 // initialization if it needs access to private fields (e.g. serialVersionUID).
3269 //
3270 // Since throwing an exception will EnsureInitialization and the public sdk may
3271 // block that, disable the checks. It's ok to do so, because the thrown exceptions
3272 // are not part of the application code that needs to verified.
3273 ScopedDisablePublicSdkChecker sdpsc;
3274
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003275 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003276 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003277 ClearException();
3278 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003279 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003280 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003281 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003282 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003283 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003284 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003285 return;
3286 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003287
Ian Rogers7b078e82014-09-10 14:44:24 -07003288 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3289 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003290 DCHECK(IsExceptionPending());
3291 return;
3292 }
3293 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003294 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003295 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003296
Mathieu Chartier590fee92013-09-13 13:46:47 -07003297 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003298 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003299 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3300 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003301 return;
3302 }
3303
Ian Rogers62d6c772013-02-27 08:32:07 -08003304 // Choose an appropriate constructor and set up the arguments.
3305 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003306 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003307 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003308 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003309 msg_string.reset(
3310 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003311 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003312 CHECK(IsExceptionPending()); // OOME.
3313 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003314 }
Dave Allison0aded082013-11-07 13:15:11 -08003315 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003316 signature = "(Ljava/lang/String;)V";
3317 } else {
3318 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3319 }
3320 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003321 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003322 signature = "()V";
3323 } else {
3324 signature = "(Ljava/lang/Throwable;)V";
3325 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003326 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003327 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003328 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003329
Dave Allison0aded082013-11-07 13:15:11 -08003330 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003331 << PrettyDescriptor(exception_class_descriptor);
3332
3333 if (UNLIKELY(!runtime->IsStarted())) {
3334 // Something is trying to throw an exception without a started runtime, which is the common
3335 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3336 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003337 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003338 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003339 }
Dave Allison0aded082013-11-07 13:15:11 -08003340 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003341 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003342 }
Vladimir Markod34b73b2020-05-05 10:07:59 +01003343 ScopedLocalRef<jobject> trace(GetJniEnv(), CreateInternalStackTrace(soa));
Ian Rogersc45b8b52014-05-03 01:39:59 -07003344 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003345 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003346 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003347 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003348 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003349 jvalue jv_args[2];
3350 size_t i = 0;
3351
Dave Allison0aded082013-11-07 13:15:11 -08003352 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003353 jv_args[i].l = msg_string.get();
3354 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003355 }
Dave Allison0aded082013-11-07 13:15:11 -08003356 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003357 jv_args[i].l = cause.get();
3358 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003359 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003360 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Alex Light01fbfbe2019-06-27 10:47:04 -07003361 InvokeWithJValues(soa, ref.get(), exception_init_method, jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003362 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003363 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003364 }
Elliott Hughes30646832011-10-13 16:59:46 -07003365 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003366}
3367
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003368void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003369 LOG(WARNING) << "Throwing OutOfMemoryError "
3370 << '"' << msg << '"'
3371 << " (VmSize " << GetProcessStatus("VmSize")
3372 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003373 if (!tls32_.throwing_OutOfMemoryError) {
3374 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003375 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003376 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003377 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003378 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003379 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003380 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003381}
3382
Elliott Hughes498508c2011-10-17 14:58:22 -07003383Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003384 return Thread::Current();
3385}
3386
3387void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003388 std::ostringstream ss;
3389 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003390 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003391 // log to stderr for debugging command line processes
3392 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003393#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003394 // log to logcat for debugging frameworks processes
3395 LOG(INFO) << str;
3396#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003397}
3398
Ian Rogersdd7624d2014-03-14 17:43:00 -07003399// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003400template
3401void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3402template
3403void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003404
Andreas Gampe542451c2016-07-26 09:02:02 -07003405template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003406void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3407#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003408 if (offset == (x).Uint32Value()) { \
3409 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003410 return; \
3411 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003412 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3413 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3414 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3415 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3416 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3417 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3418 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3419 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003420 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003421 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003422 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003423 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003424 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003425#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003426
Ian Rogersdd7624d2014-03-14 17:43:00 -07003427#define JNI_ENTRY_POINT_INFO(x) \
3428 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3429 os << #x; \
3430 return; \
3431 }
3432 JNI_ENTRY_POINT_INFO(pDlsymLookup)
Vladimir Markofa458ac2020-02-12 14:08:07 +00003433 JNI_ENTRY_POINT_INFO(pDlsymLookupCritical)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003434#undef JNI_ENTRY_POINT_INFO
3435
Ian Rogersdd7624d2014-03-14 17:43:00 -07003436#define QUICK_ENTRY_POINT_INFO(x) \
3437 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3438 os << #x; \
3439 return; \
3440 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003441 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003442 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3443 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3444 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3445 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003446 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3447 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003448 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003449 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003450 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3451 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3452 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003453 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003454 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003455 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003456 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3457 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003458 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003459 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3460 QUICK_ENTRY_POINT_INFO(pSet8Static)
3461 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3462 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003463 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3464 QUICK_ENTRY_POINT_INFO(pSet32Static)
3465 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3466 QUICK_ENTRY_POINT_INFO(pSet64Static)
3467 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3468 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003469 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3470 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3471 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3472 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3473 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3474 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3475 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3476 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003477 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3478 QUICK_ENTRY_POINT_INFO(pGet32Static)
3479 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3480 QUICK_ENTRY_POINT_INFO(pGet64Static)
3481 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3482 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003483 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003484 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3485 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3486 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3487 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3488 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3489 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3490 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3491 QUICK_ENTRY_POINT_INFO(pLockObject)
3492 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3493 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3494 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3495 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3496 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003497 QUICK_ENTRY_POINT_INFO(pCos)
3498 QUICK_ENTRY_POINT_INFO(pSin)
3499 QUICK_ENTRY_POINT_INFO(pAcos)
3500 QUICK_ENTRY_POINT_INFO(pAsin)
3501 QUICK_ENTRY_POINT_INFO(pAtan)
3502 QUICK_ENTRY_POINT_INFO(pAtan2)
3503 QUICK_ENTRY_POINT_INFO(pCbrt)
3504 QUICK_ENTRY_POINT_INFO(pCosh)
3505 QUICK_ENTRY_POINT_INFO(pExp)
3506 QUICK_ENTRY_POINT_INFO(pExpm1)
3507 QUICK_ENTRY_POINT_INFO(pHypot)
3508 QUICK_ENTRY_POINT_INFO(pLog)
3509 QUICK_ENTRY_POINT_INFO(pLog10)
3510 QUICK_ENTRY_POINT_INFO(pNextAfter)
3511 QUICK_ENTRY_POINT_INFO(pSinh)
3512 QUICK_ENTRY_POINT_INFO(pTan)
3513 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003514 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003515 QUICK_ENTRY_POINT_INFO(pL2d)
3516 QUICK_ENTRY_POINT_INFO(pFmodf)
3517 QUICK_ENTRY_POINT_INFO(pL2f)
3518 QUICK_ENTRY_POINT_INFO(pD2iz)
3519 QUICK_ENTRY_POINT_INFO(pF2iz)
3520 QUICK_ENTRY_POINT_INFO(pIdivmod)
3521 QUICK_ENTRY_POINT_INFO(pD2l)
3522 QUICK_ENTRY_POINT_INFO(pF2l)
3523 QUICK_ENTRY_POINT_INFO(pLdiv)
3524 QUICK_ENTRY_POINT_INFO(pLmod)
3525 QUICK_ENTRY_POINT_INFO(pLmul)
3526 QUICK_ENTRY_POINT_INFO(pShlLong)
3527 QUICK_ENTRY_POINT_INFO(pShrLong)
3528 QUICK_ENTRY_POINT_INFO(pUshrLong)
3529 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003530 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3531 QUICK_ENTRY_POINT_INFO(pMemcpy)
3532 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3533 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3534 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3535 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3536 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3537 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3538 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3539 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003540 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003541 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3542 QUICK_ENTRY_POINT_INFO(pDeliverException)
3543 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3544 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003545 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3546 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003547 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003548 QUICK_ENTRY_POINT_INFO(pA64Load)
3549 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003550 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3551 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3552 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3553 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3554 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3555 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3556 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3557 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3558 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3559 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3560 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3561 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3562 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3563 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3564 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3565 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003566 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003567 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3568 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3569 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3570 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3571 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3572 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3573 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3574 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3575 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3576 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3577 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3578 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3579 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3580 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3581 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3582 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3583 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3584 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3585 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3586 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3587 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3588 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3589 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3590 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3591 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3592 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3593 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3594 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3595 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3596 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003597 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003598 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003599
3600 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3601 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003602#undef QUICK_ENTRY_POINT_INFO
3603
Elliott Hughes98e20172012-04-24 15:38:13 -07003604 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003605}
3606
jeffhao94d6df42012-11-26 16:02:12 -08003607void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003608 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003609 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003610 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003611 if (exception == GetDeoptimizationException()) {
3612 artDeoptimize(this);
3613 UNREACHABLE();
3614 }
3615
Roland Levillaina78f5b62017-09-29 13:50:44 +01003616 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003617
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003618 // This is a real exception: let the instrumentation know about it.
3619 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003620 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003621 IsExceptionThrownByCurrentMethod(exception)) {
3622 // Instrumentation may cause GC so keep the exception object safe.
3623 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003624 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Vladimir Marko19711d42019-04-12 14:05:34 +01003625 instrumentation->ExceptionThrownEvent(this, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003626 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003627 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3628 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3629 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3630 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003631 //
3632 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3633 // expected to happen fairly regularly but the second can only happen if we are using
3634 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3635 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003636 ShadowFrame* cf;
David Srbecky1cbac5c2019-07-18 20:05:32 +01003637 bool force_deopt = false;
3638 if (Runtime::Current()->AreNonStandardExitsEnabled() || kIsDebugBuild) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003639 NthCallerVisitor visitor(this, 0, false);
3640 visitor.WalkStack();
3641 cf = visitor.GetCurrentShadowFrame();
3642 if (cf == nullptr) {
3643 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3644 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003645 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3646 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003647 if (kIsDebugBuild && force_frame_pop) {
David Srbecky1cbac5c2019-07-18 20:05:32 +01003648 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
Alex Light0aa7a5a2018-10-10 15:58:14 +00003649 NthCallerVisitor penultimate_visitor(this, 1, false);
3650 penultimate_visitor.WalkStack();
3651 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3652 if (penultimate_frame == nullptr) {
3653 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3654 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003655 }
David Srbecky1cbac5c2019-07-18 20:05:32 +01003656 if (force_retry_instr) {
3657 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3658 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003659 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003660 }
Alex Light3dacdd62019-03-12 15:45:47 +00003661 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003662 NthCallerVisitor visitor(this, 0, false);
3663 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003664 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003665 // method_type shouldn't matter due to exception handling.
3666 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003667 // Save the exception into the deoptimization context so it can be restored
3668 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003669 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003670 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3671 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3672 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003673 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3674 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003675 ClearException();
3676 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003677 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003678 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003679 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003680 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003681 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003682 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003683 artDeoptimize(this);
3684 UNREACHABLE();
Nicolas Geoffraye91e7952020-01-23 10:15:56 +00003685 } else if (visitor.caller != nullptr) {
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003686 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3687 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003688 }
3689 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003690
Ian Rogers28ad40d2011-10-27 15:19:26 -07003691 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003692 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003693 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003694 QuickExceptionHandler exception_handler(this, false);
3695 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003696 if (exception_handler.GetClearException()) {
3697 // Exception was cleared as part of delivery.
3698 DCHECK(!IsExceptionPending());
3699 } else {
3700 // Exception was put back with a throw location.
3701 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003702 // Check the to-space invariant on the re-installed exception (if applicable).
3703 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003704 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003705 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003706}
3707
Ian Rogersbdb03912011-09-14 00:55:44 -07003708Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003709 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003710 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003711 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003712 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003713 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003714 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003715 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003716 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003717}
3718
Andreas Gampec7d878d2018-11-19 18:42:06 +00003719ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003720 bool check_suspended,
3721 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003722 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3723 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3724 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003725 ArtMethod* method = nullptr;
3726 uint32_t dex_pc = dex::kDexNoIndex;
3727 StackVisitor::WalkStack(
3728 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3729 ArtMethod* m = visitor->GetMethod();
3730 if (m->IsRuntimeMethod()) {
3731 // Continue if this is a runtime method.
3732 return true;
3733 }
3734 method = m;
3735 dex_pc = visitor->GetDexPc(abort_on_error);
3736 return false;
3737 },
3738 const_cast<Thread*>(this),
3739 /* context= */ nullptr,
3740 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3741 check_suspended);
3742
3743 if (dex_pc_out != nullptr) {
3744 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003745 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003746 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003747}
3748
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003749bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3750 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003751}
3752
Roland Levillainad0777d2018-02-12 20:00:18 +00003753extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003754 REQUIRES_SHARED(Locks::mutator_lock_);
3755
Ian Rogers40e3bac2012-11-20 00:09:14 -08003756// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003757template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003758class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003759 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003760 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003761 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003762 // We are visiting the references in compiled frames, so we do not need
3763 // to know the inlined frames.
3764 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3765 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003766
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003767 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003768 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003769 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003770 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003771 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003772 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003773 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003774 VisitShadowFrame(shadow_frame);
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +00003775 } else if (GetCurrentOatQuickMethodHeader()->IsNterpMethodHeader()) {
3776 VisitNterpFrame();
Sebastien Hertz714f1752014-04-28 15:03:08 +02003777 } else {
3778 VisitQuickFrame();
3779 }
3780 return true;
3781 }
3782
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003783 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003784 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003785 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003786 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003787 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003788 // handle scope for JNI or References for interpreter.
3789 for (size_t reg = 0; reg < num_regs; ++reg) {
3790 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3791 if (ref != nullptr) {
3792 mirror::Object* new_ref = ref;
3793 visitor_(&new_ref, reg, this);
3794 if (new_ref != ref) {
3795 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003796 }
3797 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003798 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003799 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003800 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003801 }
3802
3803 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003804 // 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 -07003805 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3806 // the threads do not all hold the heap bitmap lock for parallel GC.
3807 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003808 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003809 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003810 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003811 // klass can be null for runtime methods.
3812 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003813 if (kVerifyImageObjectsMarked) {
3814 gc::Heap* const heap = Runtime::Current()->GetHeap();
3815 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003816 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003817 if (space != nullptr && space->IsImageSpace()) {
3818 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003819 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003820 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003821 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003822 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003823 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003824 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003825 }
3826 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003827 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3828 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3829 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003830 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003831 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003832 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3833 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003834 }
3835 }
3836 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003837 mirror::Object* new_ref = klass.Ptr();
Alex Light0054aa52019-09-10 16:46:48 -07003838 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kMethodDeclaringClass, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003839 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003840 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003841 }
3842 }
3843 }
3844
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +00003845 void VisitNterpFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3846 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
3847 StackReference<mirror::Object>* vreg_ref_base =
3848 reinterpret_cast<StackReference<mirror::Object>*>(NterpGetReferenceArray(cur_quick_frame));
3849 StackReference<mirror::Object>* vreg_int_base =
3850 reinterpret_cast<StackReference<mirror::Object>*>(NterpGetRegistersArray(cur_quick_frame));
3851 CodeItemDataAccessor accessor((*cur_quick_frame)->DexInstructionData());
3852 const uint16_t num_regs = accessor.RegistersSize();
3853 // An nterp frame has two arrays: a dex register array and a reference array
3854 // that shadows the dex register array but only containing references
3855 // (non-reference dex registers have nulls). See nterp_helpers.cc.
3856 for (size_t reg = 0; reg < num_regs; ++reg) {
3857 StackReference<mirror::Object>* ref_addr = vreg_ref_base + reg;
3858 mirror::Object* ref = ref_addr->AsMirrorPtr();
3859 if (ref != nullptr) {
3860 mirror::Object* new_ref = ref;
3861 visitor_(&new_ref, reg, this);
3862 if (new_ref != ref) {
3863 ref_addr->Assign(new_ref);
3864 StackReference<mirror::Object>* int_addr = vreg_int_base + reg;
3865 int_addr->Assign(new_ref);
3866 }
3867 }
3868 }
3869 }
3870
Andreas Gampe585da952016-12-02 14:52:29 -08003871 template <typename T>
3872 ALWAYS_INLINE
3873 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003874 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003875 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003876 ArtMethod* m = *cur_quick_frame;
3877 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003878
Vladimir Markocedec9d2021-02-08 16:16:13 +00003879 if (m->IsNative()) {
3880 // TODO: Spill the `this` reference in the AOT-compiled String.charAt()
3881 // slow-path for throwing SIOOBE, so that we can remove this carve-out.
3882 if (UNLIKELY(m->IsIntrinsic()) &&
3883 m->GetIntrinsic() == enum_cast<uint32_t>(Intrinsics::kStringCharAt)) {
3884 // The String.charAt() method is AOT-compiled with an intrinsic implementation
3885 // instead of a JNI stub. It has a slow path that constructs a runtime frame
3886 // for throwing SIOOBE and in that path we do not get the `this` pointer
3887 // spilled on the stack, so there is nothing to visit. We can distinguish
3888 // this from the GenericJni path by checking that the PC is in the boot image
3889 // (PC shall be known thanks to the runtime frame for throwing SIOOBE).
3890 // Note that JIT does not emit that intrinic implementation.
3891 const void* pc = reinterpret_cast<const void*>(GetCurrentQuickFramePc());
3892 if (pc != 0u && Runtime::Current()->GetHeap()->IsInBootImageOatFile(pc)) {
3893 return;
3894 }
3895 }
3896 // Native methods spill their arguments to the reserved vregs in the caller's frame
3897 // and use pointers to these stack references as jobject, jclass, jarray, etc.
3898 // Note: We can come here for a @CriticalNative method when it needs to resolve the
3899 // target native function but there would be no references to visit below.
3900 const size_t frame_size = GetCurrentQuickFrameInfo().FrameSizeInBytes();
3901 const size_t method_pointer_size = static_cast<size_t>(kRuntimePointerSize);
3902 uint32_t* current_vreg = reinterpret_cast<uint32_t*>(
3903 reinterpret_cast<uint8_t*>(cur_quick_frame) + frame_size + method_pointer_size);
3904 auto visit = [&]() REQUIRES_SHARED(Locks::mutator_lock_) {
3905 auto* ref_addr = reinterpret_cast<StackReference<mirror::Object>*>(current_vreg);
3906 mirror::Object* ref = ref_addr->AsMirrorPtr();
3907 if (ref != nullptr) {
3908 mirror::Object* new_ref = ref;
3909 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kNativeReferenceArgument, this);
3910 if (ref != new_ref) {
3911 ref_addr->Assign(new_ref);
3912 }
3913 }
3914 };
3915 const char* shorty = m->GetShorty();
3916 if (!m->IsStatic()) {
3917 visit();
3918 current_vreg += 1u;
3919 }
3920 for (shorty += 1u; *shorty != 0; ++shorty) {
3921 switch (*shorty) {
3922 case 'D':
3923 case 'J':
3924 current_vreg += 2u;
3925 break;
3926 case 'L':
3927 visit();
3928 FALLTHROUGH_INTENDED;
3929 default:
3930 current_vreg += 1u;
3931 break;
3932 }
3933 }
3934 } else if (!m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
3935 // Process register map (which native, runtime and proxy methods don't have)
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003936 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003937 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003938 StackReference<mirror::Object>* vreg_base =
3939 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003940 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbecky0d4567f2019-05-30 22:45:40 +01003941 CodeInfo code_info = kPrecise
3942 ? CodeInfo(method_header) // We will need dex register maps.
3943 : CodeInfo::DecodeGcMasksOnly(method_header);
David Srbecky052f8ca2018-04-26 15:42:54 +01003944 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003945 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003946
David Srbecky052f8ca2018-04-26 15:42:54 +01003947 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003948
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003949 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003950 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003951 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003952 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003953 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003954 mirror::Object* ref = ref_addr->AsMirrorPtr();
3955 if (ref != nullptr) {
3956 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003957 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003958 if (ref != new_ref) {
3959 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003960 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003961 }
3962 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003963 }
3964 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003965 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Eric Holkf1e1dd12020-08-21 15:38:12 -07003966 for (uint32_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003967 if (register_mask & (1 << i)) {
3968 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003969 if (kIsDebugBuild && ref_addr == nullptr) {
3970 std::string thread_name;
3971 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003972 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003973 DescribeStack(GetThread());
3974 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3975 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3976 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003977 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003978 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003979 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003980 }
3981 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003982 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3983 // If this is a proxy method, visit its reference arguments.
3984 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003985 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003986 std::vector<StackReference<mirror::Object>*> ref_addrs =
3987 GetProxyReferenceArguments(cur_quick_frame);
3988 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3989 mirror::Object* ref = ref_addr->AsMirrorPtr();
3990 if (ref != nullptr) {
3991 mirror::Object* new_ref = ref;
Alex Light0054aa52019-09-10 16:46:48 -07003992 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kProxyReferenceArgument, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003993 if (ref != new_ref) {
3994 ref_addr->Assign(new_ref);
3995 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003996 }
3997 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003998 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003999 }
4000
Andreas Gampe585da952016-12-02 14:52:29 -08004001 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
4002 if (kPrecise) {
4003 VisitQuickFramePrecise();
4004 } else {
4005 VisitQuickFrameNonPrecise();
4006 }
4007 }
4008
4009 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
4010 struct UndefinedVRegInfo {
4011 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
4012 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08004013 const StackMap& map ATTRIBUTE_UNUSED,
4014 RootVisitor& _visitor)
4015 : visitor(_visitor) {
4016 }
4017
4018 ALWAYS_INLINE
4019 void VisitStack(mirror::Object** ref,
4020 size_t stack_index ATTRIBUTE_UNUSED,
4021 const StackVisitor* stack_visitor)
4022 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07004023 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004024 }
4025
4026 ALWAYS_INLINE
4027 void VisitRegister(mirror::Object** ref,
4028 size_t register_index ATTRIBUTE_UNUSED,
4029 const StackVisitor* stack_visitor)
4030 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07004031 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004032 }
4033
4034 RootVisitor& visitor;
4035 };
4036 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
4037 }
4038
4039 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
4040 struct StackMapVRegInfo {
4041 StackMapVRegInfo(ArtMethod* method,
4042 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08004043 const StackMap& map,
4044 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00004045 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08004046 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01004047 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08004048 visitor(_visitor) {
Artem Serov2808be82018-12-20 19:15:11 +00004049 DCHECK_EQ(dex_register_map.size(), number_of_dex_registers);
Andreas Gampe585da952016-12-02 14:52:29 -08004050 }
4051
4052 // TODO: If necessary, we should consider caching a reverse map instead of the linear
4053 // lookups for each location.
4054 void FindWithType(const size_t index,
4055 const DexRegisterLocation::Kind kind,
4056 mirror::Object** ref,
4057 const StackVisitor* stack_visitor)
4058 REQUIRES_SHARED(Locks::mutator_lock_) {
4059 bool found = false;
4060 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01004061 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08004062 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
4063 visitor(ref, dex_reg, stack_visitor);
4064 found = true;
4065 }
4066 }
4067
4068 if (!found) {
Alex Light0054aa52019-09-10 16:46:48 -07004069 // If nothing found, report with unknown.
4070 visitor(ref, JavaFrameRootInfo::kUnknownVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004071 }
4072 }
4073
4074 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
4075 REQUIRES_SHARED(Locks::mutator_lock_) {
4076 const size_t stack_offset = stack_index * kFrameSlotSize;
4077 FindWithType(stack_offset,
4078 DexRegisterLocation::Kind::kInStack,
4079 ref,
4080 stack_visitor);
4081 }
4082
4083 void VisitRegister(mirror::Object** ref,
4084 size_t register_index,
4085 const StackVisitor* stack_visitor)
4086 REQUIRES_SHARED(Locks::mutator_lock_) {
4087 FindWithType(register_index,
4088 DexRegisterLocation::Kind::kInRegister,
4089 ref,
4090 stack_visitor);
4091 }
4092
4093 size_t number_of_dex_registers;
4094 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08004095 DexRegisterMap dex_register_map;
4096 RootVisitor& visitor;
4097 };
4098 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
4099 }
4100
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004101 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004102 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07004103};
4104
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004105class RootCallbackVisitor {
4106 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004107 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004108
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004109 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004110 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004111 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004112 }
4113
4114 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004115 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08004116 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004117};
4118
Alex Light55eccdf2019-10-07 13:51:13 +00004119void Thread::VisitReflectiveTargets(ReflectiveValueVisitor* visitor) {
4120 for (BaseReflectiveHandleScope* brhs = GetTopReflectiveHandleScope();
4121 brhs != nullptr;
4122 brhs = brhs->GetLink()) {
4123 brhs->VisitTargets(visitor);
4124 }
4125}
4126
Andreas Gampe585da952016-12-02 14:52:29 -08004127template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004128void Thread::VisitRoots(RootVisitor* visitor) {
Eric Holkf1e1dd12020-08-21 15:38:12 -07004129 const uint32_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004130 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02004131 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004132 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00004133 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07004134 }
Alex Light848574c2017-09-25 16:59:39 -07004135 if (tlsPtr_.async_exception != nullptr) {
4136 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
4137 RootInfo(kRootNativeStack, thread_id));
4138 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004139 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08004140 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
4141 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004142 HandleScopeVisitRoots(visitor, thread_id);
Sebastien Hertz07474662015-08-25 15:12:33 +00004143 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07004144 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004145 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004146 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07004147 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
4148 record != nullptr;
4149 record = record->GetLink()) {
4150 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
4151 shadow_frame != nullptr;
4152 shadow_frame = shadow_frame->GetLink()) {
4153 mapper.VisitShadowFrame(shadow_frame);
4154 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02004155 }
4156 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004157 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
4158 record != nullptr;
4159 record = record->GetLink()) {
4160 if (record->IsReference()) {
4161 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00004162 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004163 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004164 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
4165 RootInfo(kRootThreadObject, thread_id));
4166 }
4167 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
4168 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004169 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07004170 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
4171 record != nullptr;
4172 record = record->GetNext()) {
4173 mapper.VisitShadowFrame(record->GetShadowFrame());
4174 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004175 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004176 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
4177 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004178 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004179 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004180 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004181 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004182 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004183 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Nicolas Geoffraye91e7952020-01-23 10:15:56 +00004184 for (auto& entry : *GetInstrumentationStack()) {
4185 visitor->VisitRootIfNonNull(&entry.second.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004186 }
Nicolas Geoffraye3f775b2019-12-04 14:41:52 +00004187}
4188
4189void Thread::SweepInterpreterCache(IsMarkedVisitor* visitor) {
Nicolas Geoffraya00b54b2019-12-03 14:36:42 +00004190 for (InterpreterCache::Entry& entry : GetInterpreterCache()->GetArray()) {
4191 const Instruction* inst = reinterpret_cast<const Instruction*>(entry.first);
Nicolas Geoffraye3f775b2019-12-04 14:41:52 +00004192 if (inst != nullptr) {
4193 if (inst->Opcode() == Instruction::NEW_INSTANCE ||
4194 inst->Opcode() == Instruction::CHECK_CAST ||
4195 inst->Opcode() == Instruction::INSTANCE_OF ||
4196 inst->Opcode() == Instruction::NEW_ARRAY ||
4197 inst->Opcode() == Instruction::CONST_CLASS) {
4198 mirror::Class* cls = reinterpret_cast<mirror::Class*>(entry.second);
4199 if (cls == nullptr || cls == Runtime::GetWeakClassSentinel()) {
4200 // Entry got deleted in a previous sweep.
4201 continue;
4202 }
4203 Runtime::ProcessWeakClass(
4204 reinterpret_cast<GcRoot<mirror::Class>*>(&entry.second),
4205 visitor,
4206 Runtime::GetWeakClassSentinel());
4207 } else if (inst->Opcode() == Instruction::CONST_STRING ||
4208 inst->Opcode() == Instruction::CONST_STRING_JUMBO) {
4209 mirror::Object* object = reinterpret_cast<mirror::Object*>(entry.second);
4210 mirror::Object* new_object = visitor->IsMarked(object);
4211 // We know the string is marked because it's a strongly-interned string that
4212 // is always alive (see b/117621117 for trying to make those strings weak).
4213 // The IsMarked implementation of the CMS collector returns
4214 // null for newly allocated objects, but we know those haven't moved. Therefore,
4215 // only update the entry if we get a different non-null string.
4216 if (new_object != nullptr && new_object != object) {
4217 entry.second = reinterpret_cast<size_t>(new_object);
4218 }
4219 }
Nicolas Geoffraya00b54b2019-12-03 14:36:42 +00004220 }
4221 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004222}
4223
Andreas Gampe585da952016-12-02 14:52:29 -08004224void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4225 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004226 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004227 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004228 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004229 }
4230}
4231
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004232class VerifyRootVisitor : public SingleRootVisitor {
4233 public:
4234 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004235 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004236 VerifyObject(root);
4237 }
4238};
jeffhao25045522012-03-13 19:34:37 -07004239
Ian Rogers04d7aa92013-03-16 14:29:17 -07004240void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004241 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4242 VerifyRootVisitor visitor;
4243 std::unique_ptr<Context> context(Context::Create());
4244 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4245 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4246 mapper.WalkStack();
4247 }
jeffhao25045522012-03-13 19:34:37 -07004248}
jeffhao25045522012-03-13 19:34:37 -07004249
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004250// Set the stack end to that to be used during a stack overflow
4251void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004252 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004253 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004254 // However, we seem to have already extended to use the full stack.
4255 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004256 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004257 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004258 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004259 }
4260
Ian Rogersdd7624d2014-03-14 17:43:00 -07004261 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004262
4263 // Remove the stack overflow protection if is it set up.
4264 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4265 if (implicit_stack_check) {
4266 if (!UnprotectStack()) {
4267 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4268 }
4269 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004270}
4271
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004272void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004273 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004274 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004275 tlsPtr_.thread_local_start = start;
4276 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4277 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004278 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004279 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004280}
4281
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004282void Thread::ResetTlab() {
Wessam Hassaneinb5a10be2020-11-11 16:42:52 -08004283 gc::Heap* const heap = Runtime::Current()->GetHeap();
4284 if (heap->GetHeapSampler().IsEnabled()) {
4285 // Note: We always ResetTlab before SetTlab, therefore we can do the sample
4286 // offset adjustment here.
4287 heap->AdjustSampleOffset(GetTlabPosOffset());
4288 VLOG(heap) << "JHP: ResetTlab, Tid: " << GetTid()
4289 << " adjustment = "
4290 << (tlsPtr_.thread_local_pos - tlsPtr_.thread_local_start);
4291 }
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004292 SetTlab(nullptr, nullptr, nullptr);
4293}
4294
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004295bool Thread::HasTlab() const {
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004296 const bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004297 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004298 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004299 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004300 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004301 }
4302 return has_tlab;
4303}
4304
Elliott Hughes330304d2011-08-12 14:28:05 -07004305std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004306 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004307 return os;
4308}
4309
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004310bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004311 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4312 VLOG(threads) << "Protecting stack at " << pregion;
4313 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004314 if (fatal_on_error) {
4315 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4316 "Reason: "
4317 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4318 }
4319 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004320 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004321 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004322}
4323
4324bool Thread::UnprotectStack() {
4325 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4326 VLOG(threads) << "Unprotecting stack at " << pregion;
4327 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4328}
4329
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004330void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4331 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004332 tlsPtr_.method_verifier = verifier;
4333}
4334
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004335void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004336 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004337 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004338}
4339
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004340size_t Thread::NumberOfHeldMutexes() const {
4341 size_t count = 0;
4342 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004343 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004344 }
4345 return count;
4346}
4347
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004348void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4349 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4350 ClearException();
4351 ShadowFrame* shadow_frame =
4352 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004353 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004354 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004355 DeoptimizationMethodType method_type;
4356 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004357 SetTopOfStack(nullptr);
4358 SetTopOfShadowStack(shadow_frame);
4359
4360 // Restore the exception that was pending before deoptimization then interpret the
4361 // deoptimized frames.
4362 if (pending_exception != nullptr) {
4363 SetException(pending_exception);
4364 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004365 interpreter::EnterInterpreterFromDeoptimize(this,
4366 shadow_frame,
4367 result,
4368 from_code,
4369 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004370}
4371
Alex Light848574c2017-09-25 16:59:39 -07004372void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4373 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004374 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004375 if (kIsDebugBuild) {
4376 // Make sure we are in a checkpoint.
4377 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4378 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4379 << "It doesn't look like this was called in a checkpoint! this: "
4380 << this << " count: " << GetSuspendCount();
4381 }
4382 tlsPtr_.async_exception = new_exception.Ptr();
4383}
4384
4385bool Thread::ObserveAsyncException() {
4386 DCHECK(this == Thread::Current());
4387 if (tlsPtr_.async_exception != nullptr) {
4388 if (tlsPtr_.exception != nullptr) {
4389 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4390 << tlsPtr_.exception->Dump();
4391 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4392 }
4393 tlsPtr_.exception = tlsPtr_.async_exception;
4394 tlsPtr_.async_exception = nullptr;
4395 return true;
4396 } else {
4397 return IsExceptionPending();
4398 }
4399}
4400
Mathieu Chartier0795f232016-09-27 18:43:30 -07004401void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004402 CHECK(new_exception != nullptr);
4403 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004404 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004405}
4406
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004407bool Thread::IsAotCompiler() {
4408 return Runtime::Current()->IsAotCompiler();
4409}
4410
Andreas Gampe202f85a2017-02-06 10:23:26 -08004411mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004412 DCHECK(tlsPtr_.jpeer == nullptr);
4413 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004414 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4415 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4416 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4417 // mark/forward it here.
4418 peer = art::ReadBarrier::Mark(peer);
4419 }
4420 return peer;
4421}
4422
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004423void Thread::SetReadBarrierEntrypoints() {
4424 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004425 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004426}
4427
David Srbecky912f36c2018-09-08 12:22:58 +01004428void Thread::ClearAllInterpreterCaches() {
4429 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004430 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004431 thread->GetInterpreterCache()->Clear(thread);
4432 }
4433 } closure;
4434 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4435}
4436
Orion Hodson119733d2019-01-30 15:14:41 +00004437
Andreas Gampee5d23982019-01-08 10:34:26 -08004438void Thread::ReleaseLongJumpContextInternal() {
4439 // Each QuickExceptionHandler gets a long jump context and uses
4440 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4441 // Both finding catch blocks and deoptimization can trigger another
4442 // exception such as a result of class loading. So there can be nested
4443 // cases of exception handling and multiple contexts being used.
4444 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4445 // for reuse so there is no need to always allocate a new one each time when
4446 // getting a context. Since we only keep one context for reuse, delete the
4447 // existing one since the passed in context is yet to be used for longjump.
4448 delete tlsPtr_.long_jump_context;
4449}
4450
Orion Hodson119733d2019-01-30 15:14:41 +00004451void Thread::SetNativePriority(int new_priority) {
Orion Hodsonc5323fe2021-02-04 21:20:30 +00004452 palette_status_t status = PaletteSchedSetPriority(GetTid(), new_priority);
4453 CHECK(status == PALETTE_STATUS_OK || status == PALETTE_STATUS_CHECK_ERRNO);
Orion Hodson119733d2019-01-30 15:14:41 +00004454}
4455
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004456int Thread::GetNativePriority() const {
Orion Hodson119733d2019-01-30 15:14:41 +00004457 int priority = 0;
Orion Hodsonc5323fe2021-02-04 21:20:30 +00004458 palette_status_t status = PaletteSchedGetPriority(GetTid(), &priority);
4459 CHECK(status == PALETTE_STATUS_OK || status == PALETTE_STATUS_CHECK_ERRNO);
Orion Hodson119733d2019-01-30 15:14:41 +00004460 return priority;
4461}
4462
Alex Lighte0b2ce42019-02-21 19:23:42 +00004463bool Thread::IsSystemDaemon() const {
4464 if (GetPeer() == nullptr) {
4465 return false;
4466 }
4467 return jni::DecodeArtField(
4468 WellKnownClasses::java_lang_Thread_systemDaemon)->GetBoolean(GetPeer());
4469}
4470
Hans Boehm9d27fbc2021-05-21 09:23:38 -07004471std::string Thread::StateAndFlagsAsHexString() const {
4472 std::stringstream result_stream;
4473 result_stream << std::hex << tls32_.state_and_flags.as_atomic_int.load();
4474 return result_stream.str();
4475}
4476
Alex Lightb7c640d2019-03-20 15:52:13 -07004477ScopedExceptionStorage::ScopedExceptionStorage(art::Thread* self)
4478 : self_(self), hs_(self_), excp_(hs_.NewHandle<art::mirror::Throwable>(self_->GetException())) {
4479 self_->ClearException();
4480}
4481
Alex Light79d6c802019-06-27 15:50:11 +00004482void ScopedExceptionStorage::SuppressOldException(const char* message) {
4483 CHECK(self_->IsExceptionPending()) << *self_;
4484 ObjPtr<mirror::Throwable> old_suppressed(excp_.Get());
4485 excp_.Assign(self_->GetException());
4486 LOG(WARNING) << message << "Suppressing old exception: " << old_suppressed->Dump();
4487 self_->ClearException();
4488}
4489
Alex Lightb7c640d2019-03-20 15:52:13 -07004490ScopedExceptionStorage::~ScopedExceptionStorage() {
Alex Light79d6c802019-06-27 15:50:11 +00004491 CHECK(!self_->IsExceptionPending()) << *self_;
Alex Lightb7c640d2019-03-20 15:52:13 -07004492 if (!excp_.IsNull()) {
4493 self_->SetException(excp_.Get());
4494 }
4495}
4496
Elliott Hughes8daa0922011-09-11 13:46:25 -07004497} // namespace art
Eric Holkf1e1dd12020-08-21 15:38:12 -07004498
4499#pragma clang diagnostic pop // -Wconversion