blob: c3e4afe7682f0d4ec5503aaa640a9d05a49b0dcf [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Carl Shapirob5573532011-07-12 18:22:59 -070016
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "thread.h"
Carl Shapirob5573532011-07-12 18:22:59 -070018
Hans Boehm81dc7ab2019-04-19 17:34:31 -070019#include <limits.h> // for INT_MAX
Ian Rogersb033c752011-07-20 12:22:35 -070020#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070021#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080022#include <sys/resource.h>
23#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070024
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -070025#if __has_feature(hwaddress_sanitizer)
26#include <sanitizer/hwasan_interface.h>
27#else
28#define __hwasan_tag_pointer(p, t) (p)
29#endif
30
Carl Shapirob5573532011-07-12 18:22:59 -070031#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070032#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070033#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070034#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070035#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070036#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070037
Andreas Gampe43e72432019-05-14 16:15:24 -070038#include "android-base/file.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080039#include "android-base/stringprintf.h"
Evan Chengd57c51e2018-01-26 15:43:08 +080040#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080041
Mathieu Chartiera62b4532017-04-26 13:16:25 -070042#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070043#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070044#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070045#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000046#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010047#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010048#include "base/casts.h"
Andreas Gampee5d23982019-01-08 10:34:26 -080049#include "arch/context.h"
David Sehr891a50e2017-10-27 17:01:07 -070050#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070051#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080052#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070053#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070054#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080055#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070056#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080057#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010059#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070060#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080061#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080062#include "dex/dex_file-inl.h"
63#include "dex/dex_file_annotations.h"
64#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070065#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080066#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070067#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000068#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070069#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070070#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070071#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070072#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070073#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070074#include "indirect_reference_table-inl.h"
Andreas Gamped77abd92019-01-02 16:10:20 -080075#include "instrumentation.h"
Steven Morelande431e272017-07-18 16:53:49 -070076#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010077#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010078#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070079#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010080#include "jni/java_vm_ext.h"
81#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070082#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070083#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070084#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080085#include "mirror/object_array-inl.h"
86#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070087#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080088#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070089#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070090#include "nativehelper/scoped_local_ref.h"
91#include "nativehelper/scoped_utf_chars.h"
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"
Elliott Hughes68e76522011-10-05 13:22:16 -0700107#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100108#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700109#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700110#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700111#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800112#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700113#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700114
Yu Lieac44242015-06-29 10:50:03 +0800115#if ART_USE_FUTEXES
116#include "linux/futex.h"
117#include "sys/syscall.h"
118#ifndef SYS_futex
119#define SYS_futex __NR_futex
120#endif
121#endif // ART_USE_FUTEXES
122
Carl Shapirob5573532011-07-12 18:22:59 -0700123namespace art {
124
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800125using android::base::StringAppendV;
126using android::base::StringPrintf;
127
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700128extern "C" NO_RETURN void artDeoptimize(Thread* self);
129
Ian Rogers0878d652013-04-18 17:38:35 -0700130bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700131pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800132ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700133const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100134bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100135Thread* Thread::jit_sensitive_thread_ = nullptr;
Andreas Gampe82372002019-07-24 15:42:09 -0700136#ifndef __BIONIC__
137thread_local Thread* Thread::self_tls_ = nullptr;
138#endif
Calin Juravleb2771b42016-04-07 17:09:25 +0100139
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700140static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700141
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700142// For implicit overflow checks we reserve an extra piece of memory at the bottom
143// of the stack (lowest memory). The higher portion of the memory
144// is protected against reads and the lower is available for use while
145// throwing the StackOverflow exception.
146constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
147
Elliott Hughes7dc51662012-05-16 14:48:43 -0700148static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
149
Ian Rogers5d76c432011-10-31 21:42:49 -0700150void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700151 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700152}
153
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700154static void UnimplementedEntryPoint() {
155 UNIMPLEMENTED(FATAL);
156}
157
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700158void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700159void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800160
161void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
162 CHECK(kUseReadBarrier);
163 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700164 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800165 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800166}
Ian Rogers7655f292013-07-29 11:07:13 -0700167
Ian Rogers848871b2013-08-05 10:56:33 -0700168void Thread::InitTlsEntryPoints() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800169 ScopedTrace trace("InitTlsEntryPoints");
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700170 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700171 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800172 uintptr_t* end = reinterpret_cast<uintptr_t*>(
173 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700174 for (uintptr_t* it = begin; it != end; ++it) {
175 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
176 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700177 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700178}
179
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800180void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000181 if (kUseReadBarrier && kRuntimeISA != InstructionSet::kX86_64) {
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800182 // Allocation entrypoint switching is currently only implemented for X86_64.
183 is_marking = true;
184 }
185 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700186}
187
Sebastien Hertz07474662015-08-25 15:12:33 +0000188class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200189 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100190 DeoptimizationContextRecord(const JValue& ret_val,
191 bool is_reference,
192 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800193 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700194 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000195 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100196 : ret_val_(ret_val),
197 is_reference_(is_reference),
198 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800199 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700200 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000201 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200202
203 JValue GetReturnValue() const { return ret_val_; }
204 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100205 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800206 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000207 DeoptimizationContextRecord* GetLink() const { return link_; }
208 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200209 DCHECK(is_reference_);
210 return ret_val_.GetGCRoot();
211 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000212 mirror::Object** GetPendingExceptionAsGCRoot() {
213 return reinterpret_cast<mirror::Object**>(&pending_exception_);
214 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700215 DeoptimizationMethodType GetDeoptimizationMethodType() const {
216 return deopt_method_type_;
217 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200218
219 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000220 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200221 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200222
Sebastien Hertz07474662015-08-25 15:12:33 +0000223 // Indicates whether the returned value is a reference. If so, the GC will visit it.
224 const bool is_reference_;
225
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100226 // Whether the context was created from an explicit deoptimization in the code.
227 const bool from_code_;
228
Sebastien Hertz07474662015-08-25 15:12:33 +0000229 // The exception that was pending before deoptimization (or null if there was no pending
230 // exception).
231 mirror::Throwable* pending_exception_;
232
Mingyao Yang2ee17902017-08-30 11:37:08 -0700233 // Whether the context was created for an (idempotent) runtime method.
234 const DeoptimizationMethodType deopt_method_type_;
235
Sebastien Hertz07474662015-08-25 15:12:33 +0000236 // A link to the previous DeoptimizationContextRecord.
237 DeoptimizationContextRecord* const link_;
238
239 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200240};
241
242class StackedShadowFrameRecord {
243 public:
244 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
245 StackedShadowFrameType type,
246 StackedShadowFrameRecord* link)
247 : shadow_frame_(shadow_frame),
248 type_(type),
249 link_(link) {}
250
251 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
252 StackedShadowFrameType GetType() const { return type_; }
253 StackedShadowFrameRecord* GetLink() const { return link_; }
254
255 private:
256 ShadowFrame* const shadow_frame_;
257 const StackedShadowFrameType type_;
258 StackedShadowFrameRecord* const link_;
259
260 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
261};
262
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100263void Thread::PushDeoptimizationContext(const JValue& return_value,
264 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700265 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100266 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700267 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000268 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
269 return_value,
270 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100271 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000272 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700273 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000274 tlsPtr_.deoptimization_context_stack);
275 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700276}
277
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100278void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800279 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700280 bool* from_code,
281 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000282 AssertHasDeoptimizationContext();
283 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
284 tlsPtr_.deoptimization_context_stack = record->GetLink();
285 result->SetJ(record->GetReturnValue().GetJ());
286 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100287 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700288 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700289 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000290}
291
292void Thread::AssertHasDeoptimizationContext() {
293 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
294 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800295}
296
Charles Mungeraa31f492018-11-01 18:57:38 +0000297enum {
298 kPermitAvailable = 0, // Incrementing consumes the permit
299 kNoPermit = 1, // Incrementing marks as waiter waiting
300 kNoPermitWaiterWaiting = 2
301};
302
303void Thread::Park(bool is_absolute, int64_t time) {
304 DCHECK(this == Thread::Current());
305#if ART_USE_FUTEXES
306 // Consume the permit, or mark as waiting. This cannot cause park_state to go
307 // outside of its valid range (0, 1, 2), because in all cases where 2 is
308 // assigned it is set back to 1 before returning, and this method cannot run
309 // concurrently with itself since it operates on the current thread.
310 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
311 if (old_state == kNoPermit) {
312 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800313 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Munger5cc0e752018-11-09 12:30:46 -0800314 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000315 if (!is_absolute && time == 0) {
316 // Thread.getState() is documented to return waiting for untimed parks.
317 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
318 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
Charles Mungered19c672019-02-21 15:32:32 -0800319 int result = futex(tls32_.park_state_.Address(),
Charles Mungeraa31f492018-11-01 18:57:38 +0000320 FUTEX_WAIT_PRIVATE,
321 /* sleep if val = */ kNoPermitWaiterWaiting,
322 /* timeout */ nullptr,
323 nullptr,
324 0);
Charles Mungered19c672019-02-21 15:32:32 -0800325 // This errno check must happen before the scope is closed, to ensure that
326 // no destructors (such as ScopedThreadSuspension) overwrite errno.
327 if (result == -1) {
328 switch (errno) {
329 case EAGAIN:
330 FALLTHROUGH_INTENDED;
331 case EINTR: break; // park() is allowed to spuriously return
332 default: PLOG(FATAL) << "Failed to park";
333 }
334 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000335 } else if (time > 0) {
336 // Only actually suspend and futex_wait if we're going to wait for some
337 // positive amount of time - the kernel will reject negative times with
338 // EINVAL, and a zero time will just noop.
339
340 // Thread.getState() is documented to return timed wait for timed parks.
341 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
342 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
343 timespec timespec;
Charles Mungered19c672019-02-21 15:32:32 -0800344 int result = 0;
Charles Mungeraa31f492018-11-01 18:57:38 +0000345 if (is_absolute) {
346 // Time is millis when scheduled for an absolute time
347 timespec.tv_nsec = (time % 1000) * 1000000;
348 timespec.tv_sec = time / 1000;
349 // This odd looking pattern is recommended by futex documentation to
350 // wait until an absolute deadline, with otherwise identical behavior to
351 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
352 // correct time when the system clock changes.
353 result = futex(tls32_.park_state_.Address(),
354 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
355 /* sleep if val = */ kNoPermitWaiterWaiting,
356 &timespec,
357 nullptr,
358 FUTEX_BITSET_MATCH_ANY);
359 } else {
360 // Time is nanos when scheduled for a relative time
361 timespec.tv_sec = time / 1000000000;
362 timespec.tv_nsec = time % 1000000000;
363 result = futex(tls32_.park_state_.Address(),
364 FUTEX_WAIT_PRIVATE,
365 /* sleep if val = */ kNoPermitWaiterWaiting,
366 &timespec,
367 nullptr,
368 0);
369 }
Charles Mungered19c672019-02-21 15:32:32 -0800370 // This errno check must happen before the scope is closed, to ensure that
371 // no destructors (such as ScopedThreadSuspension) overwrite errno.
372 if (result == -1) {
373 switch (errno) {
374 case ETIMEDOUT:
375 timed_out = true;
376 FALLTHROUGH_INTENDED;
377 case EAGAIN:
378 case EINTR: break; // park() is allowed to spuriously return
379 default: PLOG(FATAL) << "Failed to park";
380 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000381 }
382 }
383 // Mark as no longer waiting, and consume permit if there is one.
384 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
385 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800386 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000387 } else {
388 // the fetch_add has consumed the permit. immediately return.
389 DCHECK_EQ(old_state, kPermitAvailable);
390 }
391#else
392 #pragma clang diagnostic push
393 #pragma clang diagnostic warning "-W#warnings"
394 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
395 #pragma clang diagnostic pop
396 UNUSED(is_absolute, time);
397 UNIMPLEMENTED(WARNING);
398 sched_yield();
399#endif
400}
401
402void Thread::Unpark() {
403#if ART_USE_FUTEXES
404 // Set permit available; will be consumed either by fetch_add (when the thread
405 // tries to park) or store (when the parked thread is woken up)
406 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
407 == kNoPermitWaiterWaiting) {
408 int result = futex(tls32_.park_state_.Address(),
409 FUTEX_WAKE_PRIVATE,
410 /* number of waiters = */ 1,
411 nullptr,
412 nullptr,
413 0);
414 if (result == -1) {
415 PLOG(FATAL) << "Failed to unpark";
416 }
417 }
418#else
419 UNIMPLEMENTED(WARNING);
420#endif
421}
422
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700423void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
424 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
425 sf, type, tlsPtr_.stacked_shadow_frame_record);
426 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800427}
428
Andreas Gampe639bdd12015-06-03 11:22:45 -0700429ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700430 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700431 if (must_be_present) {
432 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700433 } else {
434 if (record == nullptr || record->GetType() != type) {
435 return nullptr;
436 }
437 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700438 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
439 ShadowFrame* shadow_frame = record->GetShadowFrame();
440 delete record;
441 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700442}
443
Mingyao Yang99170c62015-07-06 11:10:37 -0700444class FrameIdToShadowFrame {
445 public:
446 static FrameIdToShadowFrame* Create(size_t frame_id,
447 ShadowFrame* shadow_frame,
448 FrameIdToShadowFrame* next,
449 size_t num_vregs) {
450 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
451 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
452 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
453 }
454
455 static void Delete(FrameIdToShadowFrame* f) {
456 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
457 delete[] memory;
458 }
459
460 size_t GetFrameId() const { return frame_id_; }
461 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
462 FrameIdToShadowFrame* GetNext() const { return next_; }
463 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
464 bool* GetUpdatedVRegFlags() {
465 return updated_vreg_flags_;
466 }
467
468 private:
469 FrameIdToShadowFrame(size_t frame_id,
470 ShadowFrame* shadow_frame,
471 FrameIdToShadowFrame* next)
472 : frame_id_(frame_id),
473 shadow_frame_(shadow_frame),
474 next_(next) {}
475
476 const size_t frame_id_;
477 ShadowFrame* const shadow_frame_;
478 FrameIdToShadowFrame* next_;
479 bool updated_vreg_flags_[0];
480
481 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
482};
483
484static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
485 size_t frame_id) {
486 FrameIdToShadowFrame* found = nullptr;
487 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
488 if (record->GetFrameId() == frame_id) {
489 if (kIsDebugBuild) {
490 // Sanity check we have at most one record for this frame.
491 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
492 found = record;
493 } else {
494 return record;
495 }
496 }
497 }
498 return found;
499}
500
501ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
502 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
503 tlsPtr_.frame_id_to_shadow_frame, frame_id);
504 if (record != nullptr) {
505 return record->GetShadowFrame();
506 }
507 return nullptr;
508}
509
510// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
511bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
512 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
513 tlsPtr_.frame_id_to_shadow_frame, frame_id);
514 CHECK(record != nullptr);
515 return record->GetUpdatedVRegFlags();
516}
517
518ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
519 uint32_t num_vregs,
520 ArtMethod* method,
521 uint32_t dex_pc) {
522 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
523 if (shadow_frame != nullptr) {
524 return shadow_frame;
525 }
David Sehr709b0702016-10-13 09:12:37 -0700526 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700527 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
528 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
529 shadow_frame,
530 tlsPtr_.frame_id_to_shadow_frame,
531 num_vregs);
532 for (uint32_t i = 0; i < num_vregs; i++) {
533 // Do this to clear all references for root visitors.
534 shadow_frame->SetVRegReference(i, nullptr);
535 // This flag will be changed to true if the debugger modifies the value.
536 record->GetUpdatedVRegFlags()[i] = false;
537 }
538 tlsPtr_.frame_id_to_shadow_frame = record;
539 return shadow_frame;
540}
541
Alex Light184f0752018-07-13 11:18:22 -0700542TLSData* Thread::GetCustomTLS(const char* key) {
543 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
544 auto it = custom_tls_.find(key);
545 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
546}
547
548void Thread::SetCustomTLS(const char* key, TLSData* data) {
549 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
550 // custom_tls_lock_.
551 std::unique_ptr<TLSData> old_data(data);
552 {
553 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
554 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
555 }
556}
557
Mingyao Yang99170c62015-07-06 11:10:37 -0700558void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
559 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
560 if (head->GetFrameId() == frame_id) {
561 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
562 FrameIdToShadowFrame::Delete(head);
563 return;
564 }
565 FrameIdToShadowFrame* prev = head;
566 for (FrameIdToShadowFrame* record = head->GetNext();
567 record != nullptr;
568 prev = record, record = record->GetNext()) {
569 if (record->GetFrameId() == frame_id) {
570 prev->SetNext(record->GetNext());
571 FrameIdToShadowFrame::Delete(record);
572 return;
573 }
574 }
575 LOG(FATAL) << "No shadow frame for frame " << frame_id;
576 UNREACHABLE();
577}
578
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700579void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700580 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700581}
582
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700583void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700584 // One thread (us) survived the fork, but we have a new tid so we need to
585 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700586 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700587}
588
Alex Light4847a072019-12-12 16:13:47 -0800589void Thread::DeleteJPeer(JNIEnv* env) {
590 // Make sure nothing can observe both opeer and jpeer set at the same time.
591 jobject old_jpeer = tlsPtr_.jpeer;
592 CHECK(old_jpeer != nullptr);
593 tlsPtr_.jpeer = nullptr;
594 env->DeleteGlobalRef(old_jpeer);
595}
596
Brian Carlstrom78128a62011-09-15 17:21:19 -0700597void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700598 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700599 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800600 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700601 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800602 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700603 }
604 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700605 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
606 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800607 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700608 // Check that if we got here we cannot be shutting down (as shutdown should never have started
609 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700610 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700611 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
612 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
613 // the runtime in such a case. In case this ever changes, we need to make sure here to
614 // delete the tmp_jni_env, as we own it at this point.
615 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
616 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700617 Runtime::Current()->EndThreadBirth();
618 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700619 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700620 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800621 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800622
623 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700624 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700625 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Alex Light4847a072019-12-12 16:13:47 -0800626 // Make sure nothing can observe both opeer and jpeer set at the same time.
627 self->DeleteJPeer(self->GetJniEnv());
Andreas Gampe08883de2016-11-08 13:20:52 -0800628 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100629
Andreas Gampe08883de2016-11-08 13:20:52 -0800630 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100631 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000632
Andreas Gampeac30fa22017-01-18 21:02:36 -0800633 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700634
Charles Mungeraa31f492018-11-01 18:57:38 +0000635 // Unpark ourselves if the java peer was unparked before it started (see
636 // b/28845097#comment49 for more information)
637
638 ArtField* unparkedField = jni::DecodeArtField(
639 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
640 bool should_unpark = false;
641 {
642 // Hold the lock here, so that if another thread calls unpark before the thread starts
643 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
644 // which could cause a lost unpark.
645 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
646 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
647 }
648 if (should_unpark) {
649 self->Unpark();
650 }
Ian Rogers365c1022012-06-22 15:05:28 -0700651 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800652 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700653 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700654 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
655 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700656 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700657 // Detach and delete self.
658 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700659
Dave Allison0aded082013-11-07 13:15:11 -0800660 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700661}
662
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700663Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800664 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800665 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100666 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700667 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
668 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700669 if (kIsDebugBuild) {
670 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800671 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700672 Locks::thread_list_lock_->AssertHeld(soa.Self());
673 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700674 }
675 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800676}
677
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700678Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
679 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100680 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700681}
682
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700683static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700684 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700685 if (stack_size == 0) {
686 stack_size = Runtime::Current()->GetDefaultStackSize();
687 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700688
Brian Carlstrom6414a972012-04-14 14:20:04 -0700689 // Dalvik used the bionic pthread default stack size for native threads,
690 // so include that here to support apps that expect large native stacks.
691 stack_size += 1 * MB;
692
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700693 // Under sanitization, frames of the interpreter may become bigger, both for C code as
694 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
695 // of all core classes cannot be done in all test circumstances.
696 if (kMemoryToolIsAvailable) {
697 stack_size = std::max(2 * MB, stack_size);
698 }
699
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700700 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
701 if (stack_size < PTHREAD_STACK_MIN) {
702 stack_size = PTHREAD_STACK_MIN;
703 }
704
Dave Allisonf9439142014-03-27 15:10:22 -0700705 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
706 // It's likely that callers are trying to ensure they have at least a certain amount of
707 // stack space, so we should add our reserved space on top of what they requested, rather
708 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700709 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700710 } else {
711 // If we are going to use implicit stack checks, allocate space for the protected
712 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000713 stack_size += Thread::kStackOverflowImplicitCheckSize +
714 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700715 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700716
717 // Some systems require the stack size to be a multiple of the system page size, so round up.
718 stack_size = RoundUp(stack_size, kPageSize);
719
720 return stack_size;
721}
722
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700723// Return the nearest page-aligned address below the current stack top.
724NO_INLINE
725static uint8_t* FindStackTop() {
726 return reinterpret_cast<uint8_t*>(
727 AlignDown(__builtin_frame_address(0), kPageSize));
728}
729
Dave Allisonf9439142014-03-27 15:10:22 -0700730// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700731// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700732ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700733void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700734 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700735 // Page containing current top of stack.
736 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700737
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700738 // Try to directly protect the stack.
739 VLOG(threads) << "installing stack protected region at " << std::hex <<
740 static_cast<void*>(pregion) << " to " <<
741 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700742 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700743 // Tell the kernel that we won't be needing these pages any more.
744 // NB. madvise will probably write zeroes into the memory (on linux it does).
745 uint32_t unwanted_size = stack_top - pregion - kPageSize;
746 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
793 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700794 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700795 // Remove tag from the pointer. Nop in non-hwasan builds.
796 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
797 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700798 Touch(target);
799 }
800 zero *= 2; // Try to avoid tail recursion.
801 }
802#pragma GCC diagnostic pop
803 };
804 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000805
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700806 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700807 static_cast<void*>(pregion) << " to " <<
808 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
809
Dave Allison648d7112014-07-25 16:15:27 -0700810 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700811 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700812
813 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000814 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700815 uint32_t unwanted_size = stack_top - pregion - kPageSize;
816 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700817}
818
Ian Rogers120f1c72012-09-28 17:17:10 -0700819void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800820 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800821 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700822
823 if (VLOG_IS_ON(threads)) {
824 ScopedObjectAccess soa(env);
825
Andreas Gampe08883de2016-11-08 13:20:52 -0800826 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700827 ObjPtr<mirror::String> java_name =
828 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700829 std::string thread_name;
830 if (java_name != nullptr) {
831 thread_name = java_name->ToModifiedUtf8();
832 } else {
833 thread_name = "(Unnamed)";
834 }
835
836 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700837 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700838 }
839
Ian Rogers120f1c72012-09-28 17:17:10 -0700840 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700841
Ian Rogers120f1c72012-09-28 17:17:10 -0700842 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
843 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700844 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700845 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700846 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700847 thread_start_during_shutdown = true;
848 } else {
849 runtime->StartThreadBirth();
850 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700851 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700852 if (thread_start_during_shutdown) {
853 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
854 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
855 return;
856 }
857
858 Thread* child_thread = new Thread(is_daemon);
859 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700860 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700861 stack_size = FixStackSize(stack_size);
862
Roland Levillain2ae376f2018-01-30 11:35:11 +0000863 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
864 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800865 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
866 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700867
Andreas Gampe449357d2015-06-01 22:29:51 -0700868 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
869 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100870 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700871 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100872 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700873
Andreas Gampe449357d2015-06-01 22:29:51 -0700874 int pthread_create_result = 0;
875 if (child_jni_env_ext.get() != nullptr) {
876 pthread_t new_pthread;
877 pthread_attr_t attr;
878 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
879 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
880 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
881 "PTHREAD_CREATE_DETACHED");
882 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
883 pthread_create_result = pthread_create(&new_pthread,
884 &attr,
885 Thread::CreateCallback,
886 child_thread);
887 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
888
889 if (pthread_create_result == 0) {
890 // pthread_create started the new thread. The child is now responsible for managing the
891 // JNIEnvExt we created.
892 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
893 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700894 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700895 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700896 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700897 }
898
899 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
900 {
901 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
902 runtime->EndThreadBirth();
903 }
Alex Light4847a072019-12-12 16:13:47 -0800904 // Manually delete the global reference since Thread::Init will not have been run. Make sure
905 // nothing can observe both opeer and jpeer set at the same time.
906 child_thread->DeleteJPeer(env);
Andreas Gampe449357d2015-06-01 22:29:51 -0700907 delete child_thread;
908 child_thread = nullptr;
909 // TODO: remove from thread group?
910 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
911 {
912 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100913 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700914 StringPrintf("pthread_create (%s stack) failed: %s",
915 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
916 ScopedObjectAccess soa(env);
917 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700918 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700919}
920
Andreas Gampe449357d2015-06-01 22:29:51 -0700921bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700922 // This function does all the initialization that must be run by the native thread it applies to.
923 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
924 // we can handshake with the corresponding native thread when it's ready.) Check this native
925 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800926 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800927
928 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
929 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
930 tlsPtr_.pthread_self = pthread_self();
931 CHECK(is_started_);
932
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800933 ScopedTrace trace("Thread::Init");
934
Elliott Hughesd8af1592012-04-16 20:40:15 -0700935 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800936 if (!InitStackHwm()) {
937 return false;
938 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700939 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700940 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800941 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700942 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700943 InitTid();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800944 {
945 ScopedTrace trace2("InitInterpreterTls");
946 interpreter::InitInterpreterTls(this);
947 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800948
Andreas Gampea47a6e82019-07-24 09:46:16 -0700949#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000950 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
951#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700952 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe82372002019-07-24 15:42:09 -0700953 Thread::self_tls_ = this;
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000954#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700955 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700956
Ian Rogersdd7624d2014-03-14 17:43:00 -0700957 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700958
Andreas Gampe449357d2015-06-01 22:29:51 -0700959 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800960 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
961 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700962 tlsPtr_.jni_env = jni_env_ext;
963 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100964 std::string error_msg;
965 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700966 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100967 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700968 return false;
969 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700970 }
971
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800972 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700973 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800974 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700975}
976
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800977template <typename PeerAction>
978Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700979 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800980 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800981 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900982 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
983 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800984 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700985 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800986 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700987 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800988 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800989 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700990 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900991 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
992 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800993 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700994 } else {
995 Runtime::Current()->StartThreadBirth();
996 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800997 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700998 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800999 if (!init_success) {
1000 delete self;
1001 return nullptr;
1002 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001003 }
1004 }
Elliott Hughes93e74e82011-09-13 11:07:03 -07001005
Jeff Hao848f70a2014-01-15 13:49:50 -08001006 self->InitStringEntryPoints();
1007
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001008 CHECK_NE(self->GetState(), kRunnable);
1009 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -07001010
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001011 // Run the action that is acting on the peer.
1012 if (!peer_action(self)) {
1013 runtime->GetThreadList()->Unregister(self);
1014 // Unregister deletes self, no need to do this here.
1015 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001016 }
Elliott Hughescac6cc72011-11-03 20:31:21 -07001017
Andreas Gampe56623832015-07-09 21:53:15 -07001018 if (VLOG_IS_ON(threads)) {
1019 if (thread_name != nullptr) {
1020 VLOG(threads) << "Attaching thread " << thread_name;
1021 } else {
1022 VLOG(threads) << "Attaching unnamed thread.";
1023 }
1024 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001025 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001026 }
1027
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001028 {
1029 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001030 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001031 }
1032
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001033 return self;
1034}
1035
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001036Thread* Thread::Attach(const char* thread_name,
1037 bool as_daemon,
1038 jobject thread_group,
1039 bool create_peer) {
1040 auto create_peer_action = [&](Thread* self) {
1041 // If we're the main thread, ClassLinker won't be created until after we're attached,
1042 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1043 // In the compiler, all threads need this hack, because no-one's going to be getting
1044 // a native peer!
1045 if (create_peer) {
1046 self->CreatePeer(thread_name, as_daemon, thread_group);
1047 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001048 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1049 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001050 {
1051 ScopedObjectAccess soa(self);
1052 LOG(ERROR) << "Exception creating thread peer:";
1053 LOG(ERROR) << self->GetException()->Dump();
1054 self->ClearException();
1055 }
1056 return false;
1057 }
1058 } else {
1059 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1060 if (thread_name != nullptr) {
1061 self->tlsPtr_.name->assign(thread_name);
1062 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001063 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001064 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1065 }
1066 }
1067 return true;
1068 };
1069 return Attach(thread_name, as_daemon, create_peer_action);
1070}
1071
1072Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1073 auto set_peer_action = [&](Thread* self) {
1074 // Install the given peer.
1075 {
1076 DCHECK(self == Thread::Current());
1077 ScopedObjectAccess soa(self);
1078 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1079 }
1080 self->GetJniEnv()->SetLongField(thread_peer,
1081 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001082 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001083 return true;
1084 };
1085 return Attach(thread_name, as_daemon, set_peer_action);
1086}
1087
Ian Rogers365c1022012-06-22 15:05:28 -07001088void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1089 Runtime* runtime = Runtime::Current();
1090 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001091 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001092
Dave Allison0aded082013-11-07 13:15:11 -08001093 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001094 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001095 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001096 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001097 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001098 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001099 CHECK(IsExceptionPending());
1100 return;
1101 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001102 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001103 jboolean thread_is_daemon = as_daemon;
1104
Elliott Hugheseac76672012-05-24 21:56:51 -07001105 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001106 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001107 CHECK(IsExceptionPending());
1108 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001109 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001110 {
1111 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001112 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001113 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001114 env->CallNonvirtualVoidMethod(peer.get(),
1115 WellKnownClasses::java_lang_Thread,
1116 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001117 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001118 if (IsExceptionPending()) {
1119 return;
1120 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001121
Ian Rogers120f1c72012-09-28 17:17:10 -07001122 Thread* self = this;
1123 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001124 env->SetLongField(peer.get(),
1125 WellKnownClasses::java_lang_Thread_nativePeer,
1126 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001127
1128 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001129 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001130 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001131 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001132 // The Thread constructor should have set the Thread.name to a
1133 // non-null value. However, because we can run without code
1134 // available (in the compiler, in tests), we manually assign the
1135 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001136 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001137 InitPeer<true>(soa,
1138 tlsPtr_.opeer,
1139 thread_is_daemon,
1140 thread_group,
1141 thread_name.get(),
1142 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001143 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001144 InitPeer<false>(soa,
1145 tlsPtr_.opeer,
1146 thread_is_daemon,
1147 thread_group,
1148 thread_name.get(),
1149 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001150 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001151 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001152 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001153 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001154 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001155 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001156 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001157}
1158
Andreas Gampebad529d2017-02-13 18:52:10 -08001159jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1160 const char* name,
1161 bool as_daemon,
1162 jobject thread_group) {
1163 Runtime* runtime = Runtime::Current();
1164 CHECK(!runtime->IsStarted());
1165
1166 if (thread_group == nullptr) {
1167 thread_group = runtime->GetMainThreadGroup();
1168 }
1169 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1170 // Add missing null check in case of OOM b/18297817
1171 if (name != nullptr && thread_name.get() == nullptr) {
1172 CHECK(Thread::Current()->IsExceptionPending());
1173 return nullptr;
1174 }
Andreas Gampea1e5b972019-03-18 16:54:25 -07001175 jint thread_priority = kNormThreadPriority; // Always normalize to NORM priority.
Andreas Gampebad529d2017-02-13 18:52:10 -08001176 jboolean thread_is_daemon = as_daemon;
1177
1178 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1179 if (peer.get() == nullptr) {
1180 CHECK(Thread::Current()->IsExceptionPending());
1181 return nullptr;
1182 }
1183
1184 // We cannot call Thread.init, as it will recursively ask for currentThread.
1185
1186 // The Thread constructor should have set the Thread.name to a
1187 // non-null value. However, because we can run without code
1188 // available (in the compiler, in tests), we manually assign the
1189 // fields the constructor should have set.
1190 ScopedObjectAccessUnchecked soa(Thread::Current());
1191 if (runtime->IsActiveTransaction()) {
1192 InitPeer<true>(soa,
1193 soa.Decode<mirror::Object>(peer.get()),
1194 thread_is_daemon,
1195 thread_group,
1196 thread_name.get(),
1197 thread_priority);
1198 } else {
1199 InitPeer<false>(soa,
1200 soa.Decode<mirror::Object>(peer.get()),
1201 thread_is_daemon,
1202 thread_group,
1203 thread_name.get(),
1204 thread_priority);
1205 }
1206
1207 return peer.release();
1208}
1209
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001210template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001211void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1212 ObjPtr<mirror::Object> peer,
1213 jboolean thread_is_daemon,
1214 jobject thread_group,
1215 jobject thread_name,
1216 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001217 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001218 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001219 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001220 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001221 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001222 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001223 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001224 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001225}
1226
Elliott Hughes899e7892012-01-24 14:57:32 -08001227void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001228 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001229 ::art::SetThreadName(name);
1230 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1231}
1232
Andreas Gampe9186ced2016-12-12 14:28:21 -08001233static void GetThreadStack(pthread_t thread,
1234 void** stack_base,
1235 size_t* stack_size,
1236 size_t* guard_size) {
1237#if defined(__APPLE__)
1238 *stack_size = pthread_get_stacksize_np(thread);
1239 void* stack_addr = pthread_get_stackaddr_np(thread);
1240
1241 // Check whether stack_addr is the base or end of the stack.
1242 // (On Mac OS 10.7, it's the end.)
1243 int stack_variable;
1244 if (stack_addr > &stack_variable) {
1245 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1246 } else {
1247 *stack_base = stack_addr;
1248 }
1249
1250 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1251 pthread_attr_t attributes;
1252 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1253 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1254 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1255#else
1256 pthread_attr_t attributes;
1257 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1258 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1259 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1260 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1261
1262#if defined(__GLIBC__)
1263 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1264 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1265 // will be broken because we'll die long before we get close to 2GB.
1266 bool is_main_thread = (::art::GetTid() == getpid());
1267 if (is_main_thread) {
1268 rlimit stack_limit;
1269 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1270 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1271 }
1272 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1273 size_t old_stack_size = *stack_size;
1274
1275 // Use the kernel default limit as our size, and adjust the base to match.
1276 *stack_size = 8 * MB;
1277 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1278
1279 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1280 << " to " << PrettySize(*stack_size)
1281 << " with base " << *stack_base;
1282 }
1283 }
1284#endif
1285
1286#endif
1287}
1288
Ian Rogersf4d4da12014-11-11 16:10:33 -08001289bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001290 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001291 void* read_stack_base;
1292 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001293 size_t read_guard_size;
1294 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001295
Ian Rogers13735952014-10-08 12:43:28 -07001296 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001297 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001298
Dave Allison648d7112014-07-25 16:15:27 -07001299 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1300 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1301 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1302 // between 8K and 12K.
1303 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1304 + 4 * KB;
1305 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001306 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001307 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1308 __LINE__,
1309 ::android::base::ERROR,
1310 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001311 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001312 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001313
Vladimir Markob8f2f632015-01-02 14:23:26 +00001314 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1315 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1316 read_stack_base,
1317 PrettySize(read_stack_size).c_str(),
1318 PrettySize(read_guard_size).c_str());
1319
Ian Rogers932746a2011-09-22 18:57:50 -07001320 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001321
1322 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001323 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001324
Dave Allisonb090a182014-08-14 17:02:48 +00001325 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001326
1327 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001328 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001329 // The thread might have protected region at the bottom. We need
1330 // to install our own region so we need to move the limits
1331 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001332
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001333 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1334 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1335 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001336
1337 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001338 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001339
1340 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001341 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001342
1343 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001344}
1345
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001346void Thread::ShortDump(std::ostream& os) const {
1347 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001348 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001349 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001350 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001351 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001352 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001353 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001354 << ",Thread*=" << this
1355 << ",peer=" << tlsPtr_.opeer
1356 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1357 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001358}
1359
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001360void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1361 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001362 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001363 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001364}
1365
Vladimir Marko4617d582019-03-28 13:48:31 +00001366ObjPtr<mirror::String> Thread::GetThreadName() const {
Andreas Gampe08883de2016-11-08 13:20:52 -08001367 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001368 if (tlsPtr_.opeer == nullptr) {
1369 return nullptr;
1370 }
1371 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1372 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001373}
1374
Elliott Hughesffb465f2012-03-01 18:46:05 -08001375void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001376 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001377}
1378
Jeff Hao57dac6e2013-08-15 16:36:24 -07001379uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001380#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001381 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001382 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001383 timespec now;
1384 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001385 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001386#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001387 UNIMPLEMENTED(WARNING);
1388 return -1;
1389#endif
1390}
1391
Ian Rogers01ae5802012-09-28 16:14:01 -07001392// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1393static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001394 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001395 Locks::thread_suspend_count_lock_->Unlock(self);
1396 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1397 Locks::mutator_lock_->SharedTryLock(self);
1398 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1399 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1400 }
1401 }
1402 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1403 Locks::thread_list_lock_->TryLock(self);
1404 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1405 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1406 }
1407 }
1408 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001409 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001410 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001411}
1412
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001413bool Thread::ModifySuspendCountInternal(Thread* self,
1414 int delta,
1415 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001416 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001417 if (kIsDebugBuild) {
1418 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001419 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001420 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1421 Locks::thread_suspend_count_lock_->AssertHeld(self);
1422 if (this != self && !IsSuspended()) {
1423 Locks::thread_list_lock_->AssertHeld(self);
1424 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001425 }
Alex Light88fd7202017-06-30 08:31:59 -07001426 // User code suspensions need to be checked more closely since they originate from code outside of
1427 // the runtime's control.
1428 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1429 Locks::user_code_suspension_lock_->AssertHeld(self);
1430 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1431 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1432 return false;
1433 }
1434 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001435 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001436 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001437 return false;
1438 }
1439
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001440 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1441 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1442 // deadlock. b/31683379.
1443 return false;
1444 }
1445
Yu Lieac44242015-06-29 10:50:03 +08001446 uint16_t flags = kSuspendRequest;
1447 if (delta > 0 && suspend_barrier != nullptr) {
1448 uint32_t available_barrier = kMaxSuspendBarriers;
1449 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1450 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1451 available_barrier = i;
1452 break;
1453 }
1454 }
1455 if (available_barrier == kMaxSuspendBarriers) {
1456 // No barrier spaces available, we can't add another.
1457 return false;
1458 }
1459 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1460 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001461 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001462
Ian Rogersdd7624d2014-03-14 17:43:00 -07001463 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001464 switch (reason) {
1465 case SuspendReason::kForDebugger:
1466 tls32_.debug_suspend_count += delta;
1467 break;
Alex Light88fd7202017-06-30 08:31:59 -07001468 case SuspendReason::kForUserCode:
1469 tls32_.user_code_suspend_count += delta;
1470 break;
Alex Light46f93402017-06-29 11:59:50 -07001471 case SuspendReason::kInternal:
1472 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001473 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001474
Ian Rogersdd7624d2014-03-14 17:43:00 -07001475 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001476 AtomicClearFlag(kSuspendRequest);
1477 } else {
Yu Lieac44242015-06-29 10:50:03 +08001478 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001479 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001480 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001481 }
Yu Lieac44242015-06-29 10:50:03 +08001482 return true;
1483}
1484
1485bool Thread::PassActiveSuspendBarriers(Thread* self) {
1486 // Grab the suspend_count lock and copy the current set of
1487 // barriers. Then clear the list and the flag. The ModifySuspendCount
1488 // function requires the lock so we prevent a race between setting
1489 // the kActiveSuspendBarrier flag and clearing it.
1490 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1491 {
1492 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1493 if (!ReadFlag(kActiveSuspendBarrier)) {
1494 // quick exit test: the barriers have already been claimed - this is
1495 // possible as there may be a race to claim and it doesn't matter
1496 // who wins.
1497 // All of the callers of this function (except the SuspendAllInternal)
1498 // will first test the kActiveSuspendBarrier flag without lock. Here
1499 // double-check whether the barrier has been passed with the
1500 // suspend_count lock.
1501 return false;
1502 }
1503
1504 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1505 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1506 tlsPtr_.active_suspend_barriers[i] = nullptr;
1507 }
1508 AtomicClearFlag(kActiveSuspendBarrier);
1509 }
1510
1511 uint32_t barrier_count = 0;
1512 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1513 AtomicInteger* pending_threads = pass_barriers[i];
1514 if (pending_threads != nullptr) {
1515 bool done = false;
1516 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001517 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001518 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1519 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001520 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001521#if ART_USE_FUTEXES
1522 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Hans Boehm81dc7ab2019-04-19 17:34:31 -07001523 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, INT_MAX, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001524 }
1525#endif
1526 } while (!done);
1527 ++barrier_count;
1528 }
1529 }
1530 CHECK_GT(barrier_count, 0U);
1531 return true;
1532}
1533
1534void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1535 CHECK(ReadFlag(kActiveSuspendBarrier));
1536 bool clear_flag = true;
1537 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1538 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1539 if (ptr == target) {
1540 tlsPtr_.active_suspend_barriers[i] = nullptr;
1541 } else if (ptr != nullptr) {
1542 clear_flag = false;
1543 }
1544 }
1545 if (LIKELY(clear_flag)) {
1546 AtomicClearFlag(kActiveSuspendBarrier);
1547 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001548}
1549
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001550void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001551 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1552 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1553 Closure* checkpoint;
1554 {
1555 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1556 checkpoint = tlsPtr_.checkpoint_function;
1557 if (!checkpoint_overflow_.empty()) {
1558 // Overflow list not empty, copy the first one out and continue.
1559 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1560 checkpoint_overflow_.pop_front();
1561 } else {
1562 // No overflow checkpoints. Clear the kCheckpointRequest flag
1563 tlsPtr_.checkpoint_function = nullptr;
1564 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001565 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001566 }
1567 // Outside the lock, run the checkpoint function.
1568 ScopedTrace trace("Run checkpoint function");
1569 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1570 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001571}
1572
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001573void Thread::RunEmptyCheckpoint() {
1574 DCHECK_EQ(Thread::Current(), this);
1575 AtomicClearFlag(kEmptyCheckpointRequest);
1576 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1577}
1578
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001579bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001580 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001581 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001582 if (old_state_and_flags.as_struct.state != kRunnable) {
1583 return false; // Fail, thread is suspended and so can't run a checkpoint.
1584 }
Dave Allison0aded082013-11-07 13:15:11 -08001585
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001586 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001587 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001588 union StateAndFlags new_state_and_flags;
1589 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001590 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001591 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001592 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001593 if (success) {
1594 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1595 if (tlsPtr_.checkpoint_function == nullptr) {
1596 tlsPtr_.checkpoint_function = function;
1597 } else {
1598 checkpoint_overflow_.push_back(function);
1599 }
Dave Allison0aded082013-11-07 13:15:11 -08001600 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001601 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001602 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001603 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001604}
1605
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001606bool Thread::RequestEmptyCheckpoint() {
1607 union StateAndFlags old_state_and_flags;
1608 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1609 if (old_state_and_flags.as_struct.state != kRunnable) {
1610 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1611 // heap access (eg. the read barrier).
1612 return false;
1613 }
1614
1615 // We must be runnable to request a checkpoint.
1616 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1617 union StateAndFlags new_state_and_flags;
1618 new_state_and_flags.as_int = old_state_and_flags.as_int;
1619 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001620 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001621 old_state_and_flags.as_int, new_state_and_flags.as_int);
1622 if (success) {
1623 TriggerSuspend();
1624 }
1625 return success;
1626}
1627
Andreas Gampee9f67122016-10-27 19:21:23 -07001628class BarrierClosure : public Closure {
1629 public:
1630 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1631
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001632 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001633 wrapped_->Run(self);
1634 barrier_.Pass(self);
1635 }
1636
Alex Light318afe62018-03-22 16:50:10 -07001637 void Wait(Thread* self, ThreadState suspend_state) {
1638 if (suspend_state != ThreadState::kRunnable) {
1639 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1640 } else {
1641 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1642 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001643 }
1644
1645 private:
1646 Closure* wrapped_;
1647 Barrier barrier_;
1648};
1649
Alex Lightb1e31a82017-10-04 16:57:36 -07001650// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001651bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001652 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001653 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001654 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1655 // Unlock the tll before running so that the state is the same regardless of thread.
1656 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001657 // Asked to run on this thread. Just run.
1658 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001659 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001660 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001661
1662 // The current thread is not this thread.
1663
Andreas Gampe28c4a232017-06-21 21:21:31 -07001664 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001665 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001666 return false;
1667 }
1668
Andreas Gampe28c4a232017-06-21 21:21:31 -07001669 struct ScopedThreadListLockUnlock {
1670 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1671 : self_thread(self_in) {
1672 Locks::thread_list_lock_->AssertHeld(self_thread);
1673 Locks::thread_list_lock_->Unlock(self_thread);
1674 }
1675
1676 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1677 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1678 Locks::thread_list_lock_->Lock(self_thread);
1679 }
1680
1681 Thread* self_thread;
1682 };
1683
Andreas Gampee9f67122016-10-27 19:21:23 -07001684 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001685 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001686 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1687 // suspend-count lock for too long.
1688 if (GetState() == ThreadState::kRunnable) {
1689 BarrierClosure barrier_closure(function);
1690 bool installed = false;
1691 {
1692 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1693 installed = RequestCheckpoint(&barrier_closure);
1694 }
1695 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001696 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1697 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1698 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001699 ScopedThreadStateChange sts(self, suspend_state);
1700 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001701 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001702 }
1703 // Fall-through.
1704 }
1705
1706 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1707 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1708 // certain situations.
1709 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001710 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1711
Alex Light46f93402017-06-29 11:59:50 -07001712 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001713 // Just retry the loop.
1714 sched_yield();
1715 continue;
1716 }
1717 }
1718
Andreas Gampe28c4a232017-06-21 21:21:31 -07001719 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001720 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1721 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001722 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001723 {
Alex Light318afe62018-03-22 16:50:10 -07001724 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001725 while (GetState() == ThreadState::kRunnable) {
1726 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1727 // moves us to suspended.
1728 sched_yield();
1729 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001730 }
1731
1732 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001733 }
1734
Andreas Gampee9f67122016-10-27 19:21:23 -07001735 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001736 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1737
1738 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001739 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001740 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001741 }
1742
Andreas Gampe117f9b32017-06-23 13:33:50 -07001743 {
1744 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1745 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1746 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1747 Thread::resume_cond_->Broadcast(self);
1748 }
1749
Alex Lightb1e31a82017-10-04 16:57:36 -07001750 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1751 Locks::thread_list_lock_->ExclusiveUnlock(self);
1752
Andreas Gampe28c4a232017-06-21 21:21:31 -07001753 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001754 }
1755}
1756
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001757Closure* Thread::GetFlipFunction() {
1758 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1759 Closure* func;
1760 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001761 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001762 if (func == nullptr) {
1763 return nullptr;
1764 }
Orion Hodson4557b382018-01-03 11:47:54 +00001765 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001766 DCHECK(func != nullptr);
1767 return func;
1768}
1769
1770void Thread::SetFlipFunction(Closure* function) {
1771 CHECK(function != nullptr);
1772 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001773 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001774}
1775
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001776void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001777 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001778 VLOG(threads) << this << " self-suspending";
1779 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001780 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001781 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001782 VLOG(threads) << this << " self-reviving";
1783}
1784
Andreas Gampe9186ced2016-12-12 14:28:21 -08001785static std::string GetSchedulerGroupName(pid_t tid) {
1786 // /proc/<pid>/cgroup looks like this:
1787 // 2:devices:/
1788 // 1:cpuacct,cpu:/
1789 // We want the third field from the line whose second field contains the "cpu" token.
1790 std::string cgroup_file;
Andreas Gampe43e72432019-05-14 16:15:24 -07001791 if (!android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid),
1792 &cgroup_file)) {
Andreas Gampe9186ced2016-12-12 14:28:21 -08001793 return "";
1794 }
1795 std::vector<std::string> cgroup_lines;
1796 Split(cgroup_file, '\n', &cgroup_lines);
1797 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1798 std::vector<std::string> cgroup_fields;
1799 Split(cgroup_lines[i], ':', &cgroup_fields);
1800 std::vector<std::string> cgroups;
1801 Split(cgroup_fields[1], ',', &cgroups);
1802 for (size_t j = 0; j < cgroups.size(); ++j) {
1803 if (cgroups[j] == "cpu") {
1804 return cgroup_fields[2].substr(1); // Skip the leading slash.
1805 }
1806 }
1807 }
1808 return "";
1809}
1810
1811
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001812void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001813 std::string group_name;
1814 int priority;
1815 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001816 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001817
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001818 // If flip_function is not null, it means we have run a checkpoint
1819 // before the thread wakes up to execute the flip function and the
1820 // thread roots haven't been forwarded. So the following access to
1821 // the roots (opeer or methods in the frames) would be bad. Run it
1822 // here. TODO: clean up.
1823 if (thread != nullptr) {
1824 ScopedObjectAccessUnchecked soa(self);
1825 Thread* this_thread = const_cast<Thread*>(thread);
1826 Closure* flip_func = this_thread->GetFlipFunction();
1827 if (flip_func != nullptr) {
1828 flip_func->Run(this_thread);
1829 }
1830 }
1831
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001832 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1833 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001834 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001835 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001836 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001837 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001838 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001839 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001840
Mathieu Chartier3398c782016-09-30 10:27:43 -07001841 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001842 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1843 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001844
Dave Allison0aded082013-11-07 13:15:11 -08001845 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001846 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001847 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001848 ObjPtr<mirror::String> group_name_string =
1849 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001850 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001851 }
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01001852 } else if (thread != nullptr) {
1853 priority = thread->GetNativePriority();
Elliott Hughesd369bb72011-09-12 14:41:14 -07001854 } else {
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01001855 PaletteStatus status = PaletteSchedGetPriority(tid, &priority);
1856 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
Elliott Hughesdcc24742011-09-07 14:02:44 -07001857 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001858
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001859 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001860 if (scheduler_group_name.empty()) {
1861 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001862 }
1863
Dave Allison0aded082013-11-07 13:15:11 -08001864 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001865 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001866 if (is_daemon) {
1867 os << " daemon";
1868 }
1869 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001870 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001871 << " " << thread->GetState();
1872 if (thread->IsStillStarting()) {
1873 os << " (still starting up)";
1874 }
1875 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001876 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001877 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001878 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001879 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001880 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001881
Dave Allison0aded082013-11-07 13:15:11 -08001882 if (thread != nullptr) {
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001883 auto suspend_log_fn = [&]() REQUIRES(Locks::thread_suspend_count_lock_) {
1884 os << " | group=\"" << group_name << "\""
1885 << " sCount=" << thread->tls32_.suspend_count
1886 << " dsCount=" << thread->tls32_.debug_suspend_count
1887 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
1888 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
1889 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1890 };
1891 if (Locks::thread_suspend_count_lock_->IsExclusiveHeld(self)) {
1892 Locks::thread_suspend_count_lock_->AssertExclusiveHeld(self); // For annotalysis.
1893 suspend_log_fn();
1894 } else {
1895 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1896 suspend_log_fn();
1897 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001898 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001899
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001900 os << " | sysTid=" << tid
1901 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001902 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001903 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001904 int policy;
1905 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001906#if !defined(__APPLE__)
1907 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1908 policy = sched_getscheduler(tid);
1909 if (policy == -1) {
1910 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1911 }
1912 int sched_getparam_result = sched_getparam(tid, &sp);
1913 if (sched_getparam_result == -1) {
1914 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1915 sp.sched_priority = -1;
1916 }
1917#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001918 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1919 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001920#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001921 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001922 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001923 }
1924 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001925
1926 // Grab the scheduler stats for this thread.
1927 std::string scheduler_stats;
Andreas Gampe43e72432019-05-14 16:15:24 -07001928 if (android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid),
1929 &scheduler_stats)
Evan Chengd57c51e2018-01-26 15:43:08 +08001930 && !scheduler_stats.empty()) {
1931 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001932 } else {
1933 scheduler_stats = "0 0 0";
1934 }
1935
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001936 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001937 int utime = 0;
1938 int stime = 0;
1939 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001940 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001941
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001942 os << " | state=" << native_thread_state
1943 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001944 << " utm=" << utime
1945 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001946 << " core=" << task_cpu
1947 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001948 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001949 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1950 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1951 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001952 // Dump the held mutexes.
1953 os << " | held mutexes=";
1954 for (size_t i = 0; i < kLockLevelCount; ++i) {
1955 if (i != kMonitorLock) {
1956 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1957 if (mutex != nullptr) {
1958 os << " \"" << mutex->GetName() << "\"";
1959 if (mutex->IsReaderWriterMutex()) {
1960 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001961 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001962 os << "(exclusive held)";
1963 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001964 os << "(shared held)";
1965 }
1966 }
1967 }
1968 }
1969 }
1970 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001971 }
1972}
1973
1974void Thread::DumpState(std::ostream& os) const {
1975 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001976}
1977
Andreas Gampe93104952017-12-13 17:13:15 -08001978struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001979 StackDumpVisitor(std::ostream& os_in,
1980 Thread* thread_in,
1981 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001982 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001983 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001984 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001985 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001986 : MonitorObjectsStackVisitor(thread_in,
1987 context,
1988 check_suspended,
1989 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001990 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001991 last_method(nullptr),
1992 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001993 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001994
Ian Rogersbdb03912011-09-14 00:55:44 -07001995 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001996 if (frame_count == 0) {
1997 os << " (no managed stack frames)\n";
1998 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001999 }
2000
Andreas Gampe93104952017-12-13 17:13:15 -08002001 static constexpr size_t kMaxRepetition = 3u;
2002
2003 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002004 override
Andreas Gampe93104952017-12-13 17:13:15 -08002005 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07002006 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00002007 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08002008 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08002009 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07002010 const DexFile* dex_file = dex_cache->GetDexFile();
2011 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08002012 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07002013 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08002014 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002015 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07002016 if (repetition_count >= kMaxRepetition) {
2017 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
2018 }
2019 repetition_count = 0;
2020 last_line_number = line_number;
2021 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002022 }
Andreas Gampe93104952017-12-13 17:13:15 -08002023
2024 if (repetition_count >= kMaxRepetition) {
2025 // Skip visiting=printing anything.
2026 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002027 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07002028
Andreas Gampe93104952017-12-13 17:13:15 -08002029 os << " at " << m->PrettyMethod(false);
2030 if (m->IsNative()) {
2031 os << "(Native method)";
2032 } else {
2033 const char* source_file(m->GetDeclaringClassSourceFile());
2034 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2035 << ":" << line_number << ")";
2036 }
2037 os << "\n";
2038 // Go and visit locks.
2039 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002040 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002041
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002042 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002043 return VisitMethodResult::kContinueMethod;
2044 }
2045
Vladimir Markof52d92f2019-03-29 12:33:02 +00002046 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002047 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002048 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002049 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2050 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002051 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002052 override
Andreas Gampe93104952017-12-13 17:13:15 -08002053 REQUIRES_SHARED(Locks::mutator_lock_) {
2054 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2055 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002056 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002057 ThreadState state,
2058 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002059 override
Andreas Gampe93104952017-12-13 17:13:15 -08002060 REQUIRES_SHARED(Locks::mutator_lock_) {
2061 const char* msg;
2062 switch (state) {
2063 case kBlocked:
2064 msg = " - waiting to lock ";
2065 break;
2066
2067 case kWaitingForLockInflation:
2068 msg = " - waiting for lock inflation of ";
2069 break;
2070
2071 default:
2072 LOG(FATAL) << "Unreachable";
2073 UNREACHABLE();
2074 }
2075 PrintObject(obj, msg, owner_tid);
2076 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002077 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002078 override
Andreas Gampe93104952017-12-13 17:13:15 -08002079 REQUIRES_SHARED(Locks::mutator_lock_) {
2080 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2081 }
2082
Vladimir Markof52d92f2019-03-29 12:33:02 +00002083 void PrintObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002084 const char* msg,
2085 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2086 if (obj == nullptr) {
2087 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002088 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002089 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002090 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2091 // Getting the identity hashcode here would result in lock inflation and suspension of the
2092 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002093 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
Vladimir Markof52d92f2019-03-29 12:33:02 +00002094 reinterpret_cast<intptr_t>(obj.Ptr()),
Andreas Gampe93104952017-12-13 17:13:15 -08002095 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002096 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002097 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2098 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2099 // suspension and move pretty_object.
2100 const std::string pretty_type(obj->PrettyTypeOf());
2101 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002102 }
2103 }
Andreas Gampe93104952017-12-13 17:13:15 -08002104 if (owner_tid != ThreadList::kInvalidThreadId) {
2105 os << " held by thread " << owner_tid;
2106 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002107 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002108 }
2109
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002110 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002111 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002112 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002113 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002114};
2115
Ian Rogers33e95662013-05-20 20:29:14 -07002116static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002117 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002118 ThreadState state = thread->GetState();
2119
2120 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2121 if (state > kWaiting && state < kStarting) {
2122 return true;
2123 }
2124
2125 // In an Object.wait variant or Thread.sleep? That's not interesting.
2126 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2127 return false;
2128 }
2129
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002130 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002131 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002132 return true;
2133 }
2134
Elliott Hughesaef701d2013-04-05 18:15:40 -07002135 // In some other native method? That's interesting.
2136 // We don't just check kNative because native methods will be in state kSuspended if they're
2137 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2138 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002139 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002140 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002141}
2142
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002143void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002144 // If flip_function is not null, it means we have run a checkpoint
2145 // before the thread wakes up to execute the flip function and the
2146 // thread roots haven't been forwarded. So the following access to
2147 // the roots (locks or methods in the frames) would be bad. Run it
2148 // here. TODO: clean up.
2149 {
2150 Thread* this_thread = const_cast<Thread*>(this);
2151 Closure* flip_func = this_thread->GetFlipFunction();
2152 if (flip_func != nullptr) {
2153 flip_func->Run(this_thread);
2154 }
2155 }
2156
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002157 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2158 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002159 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2160 // thread.
Alex Lightb7c640d2019-03-20 15:52:13 -07002161 ScopedExceptionStorage ses(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002162
Ian Rogers700a4022014-05-19 16:49:03 -07002163 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002164 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002165 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002166 dumper.WalkStack();
2167}
2168
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002169void Thread::DumpStack(std::ostream& os,
2170 bool dump_native_stack,
2171 BacktraceMap* backtrace_map,
2172 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002173 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2174 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2175 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002176 bool dump_for_abort = (gAborting > 0);
2177 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2178 if (!kIsDebugBuild) {
2179 // We always want to dump the stack for an abort, however, there is no point dumping another
2180 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2181 safe_to_dump = (safe_to_dump || dump_for_abort);
2182 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002183 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002184 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002185 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002186 ArtMethod* method =
2187 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002188 /*check_suspended=*/ !force_dump_stack,
2189 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002190 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002191 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002192 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002193 /*check_suspended=*/ !force_dump_stack,
2194 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002195 } else {
2196 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002197 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002198}
2199
Elliott Hughesbe759c62011-09-08 19:38:21 -07002200void Thread::ThreadExitCallback(void* arg) {
2201 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002202 if (self->tls32_.thread_exit_check_count == 0) {
2203 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2204 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002205 CHECK(is_started_);
Andreas Gampea47a6e82019-07-24 09:46:16 -07002206#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002207 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2208#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002209 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe82372002019-07-24 15:42:09 -07002210 Thread::self_tls_ = self;
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002211#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002212 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002213 } else {
2214 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2215 }
Carl Shapirob5573532011-07-12 18:22:59 -07002216}
2217
Elliott Hughesbe759c62011-09-08 19:38:21 -07002218void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002219 CHECK(!is_started_);
2220 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002221 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002222 // MutexLock to keep annotalysis happy.
2223 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002224 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002225 // return garbage since (is_started_ == true) and
2226 // Thread::pthread_key_self_ is not yet initialized.
2227 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002228 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002229 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2230 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002231 }
2232
Carl Shapirob5573532011-07-12 18:22:59 -07002233 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002234 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2235 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002236
2237 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002238 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2239 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002240 }
Andreas Gampe82372002019-07-24 15:42:09 -07002241#ifndef __BIONIC__
2242 CHECK(Thread::self_tls_ == nullptr);
2243#endif
Elliott Hughes038a8062011-09-18 14:12:41 -07002244}
Carl Shapirob5573532011-07-12 18:22:59 -07002245
Elliott Hughes038a8062011-09-18 14:12:41 -07002246void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002247 Runtime* runtime = Runtime::Current();
2248 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002249
Elliott Hughes01158d72011-09-19 19:47:10 -07002250 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002251 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002252 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2253 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002254
Vladimir Markodcfcce42018-06-27 10:00:28 +00002255 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002256
2257 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2258 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002259 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2260 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002261}
2262
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002263void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002264 CHECK(is_started_);
2265 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002266 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002267 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002268 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002269 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002270 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002271 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002272}
2273
Andreas Gampe56776012018-01-26 17:40:55 -08002274void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2275 ScopedLocalRef<jobject> thread_jobject(
2276 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2277 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2278 soa.Env(), nullptr);
2279 jobject thread_group_jobject = thread_group;
2280 if (thread_group == nullptr || kIsDebugBuild) {
2281 // There is always a group set. Retrieve it.
2282 thread_group_jobject_scoped.reset(
2283 soa.Env()->GetObjectField(thread_jobject.get(),
2284 WellKnownClasses::java_lang_Thread_group));
2285 thread_group_jobject = thread_group_jobject_scoped.get();
2286 if (kIsDebugBuild && thread_group != nullptr) {
2287 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2288 }
2289 }
2290 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2291 WellKnownClasses::java_lang_ThreadGroup,
2292 WellKnownClasses::java_lang_ThreadGroup_add,
2293 thread_jobject.get());
2294}
2295
Calin Juravleccd56952016-12-15 17:57:38 +00002296Thread::Thread(bool daemon)
2297 : tls32_(daemon),
2298 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002299 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002300 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002301 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002302 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2303 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2304
Roland Levillain33d69032015-06-18 18:20:59 +01002305 static_assert((sizeof(Thread) % 4) == 0U,
2306 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002307 tls32_.state_and_flags.as_struct.flags = 0;
2308 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002309 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002310 // Initialize with no permit; if the java Thread was unparked before being
2311 // started, it will unpark itself before calling into java code.
2312 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002313 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002314 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002315 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002316 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002317 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002318 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2319 tlsPtr_.active_suspend_barriers[i] = nullptr;
2320 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002321 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002322 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002323 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002324 tls32_.use_mterp = false;
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08002325 ResetTlab();
David Srbecky28f6cff2018-10-16 15:07:28 +01002326}
2327
2328void Thread::NotifyInTheadList() {
2329 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002330}
2331
Alex Lighte9f61032018-09-24 16:04:51 -07002332bool Thread::CanLoadClasses() const {
2333 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2334}
2335
Elliott Hughes7dc51662012-05-16 14:48:43 -07002336bool Thread::IsStillStarting() const {
2337 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002338 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002339 // 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 -07002340 // assigned fairly early on, and needs to be.
2341 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2342 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002343 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2344 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002345}
2346
Andreas Gamped9efea62014-07-21 22:56:08 -07002347void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002348 CHECK(IsExceptionPending()) << "Pending exception expected.";
2349}
2350
2351void Thread::AssertPendingOOMException() const {
2352 AssertPendingException();
2353 auto* e = GetException();
2354 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2355 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002356}
2357
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002358void Thread::AssertNoPendingException() const {
2359 if (UNLIKELY(IsExceptionPending())) {
2360 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002361 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002362 }
2363}
2364
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002365void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2366 if (UNLIKELY(IsExceptionPending())) {
2367 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002368 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002369 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002370 }
2371}
2372
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002373class MonitorExitVisitor : public SingleRootVisitor {
2374 public:
2375 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2376
2377 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2378 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002379 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002380 if (self_->HoldsLock(entered_monitor)) {
2381 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002382 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002383 << " left locked by native thread "
2384 << *Thread::Current() << " which is detaching";
2385 entered_monitor->MonitorExit(self_);
2386 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002387 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002388
2389 private:
2390 Thread* const self_;
2391};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002392
Elliott Hughesc0f09332012-03-26 13:27:06 -07002393void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002394 Thread* self = this;
2395 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002396
Ian Rogers68d8b422014-07-17 11:09:10 -07002397 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002398 {
2399 ScopedObjectAccess soa(self);
2400 MonitorExitVisitor visitor(self);
2401 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002402 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002403 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002404 // Release locally held global references which releasing may require the mutator lock.
2405 if (tlsPtr_.jpeer != nullptr) {
2406 // If pthread_create fails we don't have a jni env here.
2407 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2408 tlsPtr_.jpeer = nullptr;
2409 }
2410 if (tlsPtr_.class_loader_override != nullptr) {
2411 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2412 tlsPtr_.class_loader_override = nullptr;
2413 }
2414 }
2415
Ian Rogersdd7624d2014-03-14 17:43:00 -07002416 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002417 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002418 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002419 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002420 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002421 Runtime* runtime = Runtime::Current();
2422 if (runtime != nullptr) {
2423 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2424 }
Elliott Hughes534da072012-03-27 15:17:42 -07002425
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002426 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002427 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002428 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002429 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002430 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002431 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002432 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002433 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002434
Ian Rogerscfaa4552012-11-26 21:00:08 -08002435 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2436 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002437 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002438 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002439 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002440 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002441 StackHandleScope<1> hs(self);
2442 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002443 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002444 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002445 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002446 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002447 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002448
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002449 {
2450 ScopedObjectAccess soa(self);
2451 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Lokesh Gidra93170312019-12-04 13:46:11 -08002452 }
2453 // Mark-stack revocation must be performed at the very end. No
2454 // checkpoint/flip-function or read-barrier should be called after this.
2455 if (kUseReadBarrier) {
2456 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002457 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002458}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002459
Elliott Hughesc0f09332012-03-26 13:27:06 -07002460Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002461 CHECK(tlsPtr_.class_loader_override == nullptr);
2462 CHECK(tlsPtr_.jpeer == nullptr);
2463 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002464 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002465 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002466 delete tlsPtr_.jni_env;
2467 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002468 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002469 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002470 CHECK(!ReadFlag(kCheckpointRequest));
2471 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002472 CHECK(tlsPtr_.checkpoint_function == nullptr);
2473 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002474 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002475 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002476
Lokesh Gidra44465f72019-10-17 11:40:24 -07002477 if (kUseReadBarrier) {
Lokesh Gidra289e7122019-10-17 12:57:16 -07002478 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()
2479 ->AssertNoThreadMarkStackMapping(this);
Lokesh Gidrafaeaeaf2019-10-22 17:25:00 -07002480 gc::accounting::AtomicStack<mirror::Object>* tl_mark_stack = GetThreadLocalMarkStack();
Lokesh Gidraa0b46312019-12-04 22:06:48 +00002481 CHECK(tl_mark_stack == nullptr) << "mark-stack: " << tl_mark_stack;
Lokesh Gidra44465f72019-10-17 11:40:24 -07002482 }
Sebastien Hertz07474662015-08-25 15:12:33 +00002483 // Make sure we processed all deoptimization requests.
2484 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002485 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2486 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002487
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002488 // We may be deleting a still born thread.
2489 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002490
2491 delete wait_cond_;
2492 delete wait_mutex_;
2493
Ian Rogersdd7624d2014-03-14 17:43:00 -07002494 if (tlsPtr_.long_jump_context != nullptr) {
2495 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002496 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002497
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002498 if (initialized) {
2499 CleanupCpu();
2500 }
2501
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002502 if (tlsPtr_.single_step_control != nullptr) {
2503 delete tlsPtr_.single_step_control;
2504 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002505 delete tlsPtr_.instrumentation_stack;
2506 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002507 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002508
Ian Rogers68d8b422014-07-17 11:09:10 -07002509 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002510
Elliott Hughesd8af1592012-04-16 20:40:15 -07002511 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002512}
2513
Andreas Gampe513061a2017-06-01 09:17:34 -07002514void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002515 if (!IsExceptionPending()) {
2516 return;
2517 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002518 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002519 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002520
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002521 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002522 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2523 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002524
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002525 // Call the Thread instance's dispatchUncaughtException(Throwable)
2526 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2527 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2528 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002529
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002530 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002531 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002532}
2533
Andreas Gampe513061a2017-06-01 09:17:34 -07002534void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002535 // this.group.removeThread(this);
2536 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002537 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002538 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002539 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002540 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002541 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002542 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002543 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2544 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2545 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002546 }
2547}
2548
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002549bool Thread::HandleScopeContains(jobject obj) const {
2550 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002551 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002552 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002553 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002554 return true;
2555 }
2556 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002557 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2558 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002559}
2560
Hans Boehm0882af22017-08-31 15:21:57 -07002561void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002562 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2563 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002564 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2565 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002566 }
2567}
2568
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002569ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002570 if (obj == nullptr) {
2571 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002572 }
2573 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002574 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002575 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002576 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002577 // The "kinds" below are sorted by the frequency we expect to encounter them.
2578 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002579 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002580 // Local references do not need a read barrier.
2581 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002582 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002583 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002584 // Check if this is a local reference in the handle scope.
2585 if (LIKELY(HandleScopeContains(obj))) {
2586 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002587 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002588 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002589 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002590 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002591 expect_null = true;
2592 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002593 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002594 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002595 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002596 } else {
2597 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002598 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002599 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002600 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002601 expect_null = true;
2602 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002603 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002604 }
2605
Ian Rogersc0542af2014-09-03 16:16:56 -07002606 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002607 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002608 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002609 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002610 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002611}
2612
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002613bool Thread::IsJWeakCleared(jweak obj) const {
2614 CHECK(obj != nullptr);
2615 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002616 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002617 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002618 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002619}
2620
Ian Rogers81d425b2012-09-27 16:03:43 -07002621// Implements java.lang.Thread.interrupted.
2622bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002623 DCHECK_EQ(Thread::Current(), this);
2624 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002625 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002626 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002627 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002628 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002629 return interrupted;
2630}
2631
2632// Implements java.lang.Thread.isInterrupted.
2633bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002634 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002635}
2636
Ian Rogersdd7624d2014-03-14 17:43:00 -07002637void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002638 {
2639 MutexLock mu(self, *wait_mutex_);
2640 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2641 return;
2642 }
2643 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2644 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002645 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002646 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002647}
2648
2649void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002650 Thread* self = Thread::Current();
2651 MutexLock mu(self, *wait_mutex_);
2652 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002653}
2654
Ian Rogersc604d732012-10-14 16:09:54 -07002655void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002656 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002657 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002658 }
2659}
2660
Ian Rogers68d8b422014-07-17 11:09:10 -07002661void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2662 if (tlsPtr_.class_loader_override != nullptr) {
2663 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2664 }
2665 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2666}
2667
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002668using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2669
2670// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2671class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002672 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002673 explicit FetchStackTraceVisitor(Thread* thread,
2674 ArtMethodDexPcPair* saved_frames = nullptr,
2675 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002676 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002677 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002678 saved_frames_(saved_frames),
2679 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002680
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002681 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002682 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002683 // Note we also skip the frame if it doesn't have a method (namely the callee
2684 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002685 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002686 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002687 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002688 skipping_ = false;
2689 }
2690 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002691 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002692 if (depth_ < max_saved_frames_) {
2693 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002694 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002695 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002696 ++depth_;
2697 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002698 } else {
2699 ++skip_depth_;
2700 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002701 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002702 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002703
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002704 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002705 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002706 }
2707
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002708 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002709 return skip_depth_;
2710 }
2711
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002712 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002713 uint32_t depth_ = 0;
2714 uint32_t skip_depth_ = 0;
2715 bool skipping_ = true;
2716 ArtMethodDexPcPair* saved_frames_;
2717 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002718
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002719 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002720};
2721
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002722template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002723class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002724 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002725 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002726 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2727 self_(self),
2728 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002729 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002730
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002731 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002732 // Allocate method trace as an object array where the first element is a pointer array that
2733 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2734 // class of the ArtMethod pointers.
2735 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2736 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002737 ObjPtr<mirror::Class> array_class =
2738 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002739 // The first element is the methods and dex pc array, the other elements are declaring classes
2740 // for the methods to ensure classes in the stack trace don't get unloaded.
2741 Handle<mirror::ObjectArray<mirror::Object>> trace(
2742 hs.NewHandle(
2743 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002744 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002745 // Acquire uninterruptible_ in all paths.
2746 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002747 self_->AssertPendingOOMException();
2748 return false;
2749 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002750 ObjPtr<mirror::PointerArray> methods_and_pcs =
2751 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002752 const char* last_no_suspend_cause =
2753 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2754 if (methods_and_pcs == nullptr) {
2755 self_->AssertPendingOOMException();
2756 return false;
2757 }
2758 trace->Set(0, methods_and_pcs);
2759 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002760 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002761 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002762 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002763 }
2764
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002765 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2766 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002767 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002768
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002769 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002770 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002771 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002772 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002773 if (skip_depth_ > 0) {
2774 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002775 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002776 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002777 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002778 if (m->IsRuntimeMethod()) {
2779 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002780 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002781 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002782 return true;
2783 }
2784
2785 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002786 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002787 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002788 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2789 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002790 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002791 pointer_size_);
2792 // Save the declaring class of the method to ensure that the declaring classes of the methods
2793 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002794 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002795 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002796 }
2797
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002798 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002799 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002800 }
2801
2802 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002803 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002804 }
2805
2806 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002807 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002808 // How many more frames to skip.
2809 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002810 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002811 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002812 // An object array where the first element is a pointer array that contains the ArtMethod
2813 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2814 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2815 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002816 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002817 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002818 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002819
2820 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002821};
2822
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002823template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002824jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002825 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2826 constexpr size_t kMaxSavedFrames = 256;
2827 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2828 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2829 &saved_frames[0],
2830 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002831 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002832 const uint32_t depth = count_visitor.GetDepth();
2833 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002834
Ian Rogers1f539342012-10-03 21:09:42 -07002835 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002836 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2837 const_cast<Thread*>(this),
2838 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002839 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002840 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002841 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002842 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2843 // than doing the stack walk twice.
2844 if (depth < kMaxSavedFrames) {
2845 for (size_t i = 0; i < depth; ++i) {
2846 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2847 }
2848 } else {
2849 build_trace_visitor.WalkStack();
2850 }
2851
Mathieu Chartier910e8272015-09-30 09:24:22 -07002852 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002853 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002854 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002855 // Second half of trace_methods is dex PCs.
2856 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2857 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002858 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2859 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002860 }
2861 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002862 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002863}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002864template jobject Thread::CreateInternalStackTrace<false>(
2865 const ScopedObjectAccessAlreadyRunnable& soa) const;
2866template jobject Thread::CreateInternalStackTrace<true>(
2867 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002868
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002869bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002870 // Only count the depth since we do not pass a stack frame array as an argument.
2871 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002872 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002873 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002874}
2875
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002876static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2877 const ScopedObjectAccessAlreadyRunnable& soa,
2878 ArtMethod* method,
2879 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2880 int32_t line_number;
2881 StackHandleScope<3> hs(soa.Self());
2882 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2883 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2884 if (method->IsProxyMethod()) {
2885 line_number = -1;
2886 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2887 // source_name_object intentionally left null for proxy methods
2888 } else {
2889 line_number = method->GetLineNumFromDexPC(dex_pc);
2890 // Allocate element, potentially triggering GC
2891 // TODO: reuse class_name_object via Class::name_?
2892 const char* descriptor = method->GetDeclaringClassDescriptor();
2893 CHECK(descriptor != nullptr);
2894 std::string class_name(PrettyDescriptor(descriptor));
2895 class_name_object.Assign(
2896 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2897 if (class_name_object == nullptr) {
2898 soa.Self()->AssertPendingOOMException();
2899 return nullptr;
2900 }
2901 const char* source_file = method->GetDeclaringClassSourceFile();
2902 if (line_number == -1) {
2903 // Make the line_number field of StackTraceElement hold the dex pc.
2904 // source_name_object is intentionally left null if we failed to map the dex pc to
2905 // a line number (most probably because there is no debug info). See b/30183883.
2906 line_number = dex_pc;
2907 } else {
2908 if (source_file != nullptr) {
2909 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2910 if (source_name_object == nullptr) {
2911 soa.Self()->AssertPendingOOMException();
2912 return nullptr;
2913 }
2914 }
2915 }
2916 }
2917 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2918 CHECK(method_name != nullptr);
2919 Handle<mirror::String> method_name_object(
2920 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2921 if (method_name_object == nullptr) {
2922 return nullptr;
2923 }
2924 return mirror::StackTraceElement::Alloc(soa.Self(),
2925 class_name_object,
2926 method_name_object,
2927 source_name_object,
2928 line_number);
2929}
2930
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002931jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002932 const ScopedObjectAccessAlreadyRunnable& soa,
2933 jobject internal,
2934 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002935 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002936 // Decode the internal stack trace into the depth, method trace and PC trace.
2937 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002938 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002939 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002940
Mathieu Chartier910e8272015-09-30 09:24:22 -07002941 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002942
Elliott Hughes01158d72011-09-19 19:47:10 -07002943 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002944
Dave Allison0aded082013-11-07 13:15:11 -08002945 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002946 // Reuse the array we were given.
2947 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002948 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002949 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002950 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002951 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002952 } else {
2953 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002954 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002955 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002956 if (java_traces == nullptr) {
2957 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002958 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002959 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002960 }
2961
Dave Allison0aded082013-11-07 13:15:11 -08002962 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002963 *stack_depth = depth;
2964 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002965
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002966 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002967 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002968 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002969 // Methods and dex PC trace is element 0.
2970 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00002971 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002972 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07002973 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002974 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002975 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002976 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00002977 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002978 if (obj == nullptr) {
2979 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002980 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002981 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002982 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002983 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002984 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002985}
2986
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002987jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2988 // This code allocates. Do not allow it to operate with a pending exception.
2989 if (IsExceptionPending()) {
2990 return nullptr;
2991 }
2992
2993 // If flip_function is not null, it means we have run a checkpoint
2994 // before the thread wakes up to execute the flip function and the
2995 // thread roots haven't been forwarded. So the following access to
2996 // the roots (locks or methods in the frames) would be bad. Run it
2997 // here. TODO: clean up.
2998 // Note: copied from DumpJavaStack.
2999 {
3000 Thread* this_thread = const_cast<Thread*>(this);
3001 Closure* flip_func = this_thread->GetFlipFunction();
3002 if (flip_func != nullptr) {
3003 flip_func->Run(this_thread);
3004 }
3005 }
3006
3007 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
3008 public:
3009 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
3010 Thread* self,
3011 Context* context)
3012 : MonitorObjectsStackVisitor(self, context),
3013 wait_jobject_(soaa_in.Env(), nullptr),
3014 block_jobject_(soaa_in.Env(), nullptr),
3015 soaa_(soaa_in) {}
3016
3017 protected:
3018 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003019 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003020 REQUIRES_SHARED(Locks::mutator_lock_) {
3021 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
3022 soaa_, m, GetDexPc(/* abort on error */ false));
3023 if (obj == nullptr) {
3024 return VisitMethodResult::kEndStackWalk;
3025 }
3026 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
3027 return VisitMethodResult::kContinueMethod;
3028 }
3029
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003030 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003031 lock_objects_.push_back({});
3032 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3033
3034 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3035
3036 return VisitMethodResult::kContinueMethod;
3037 }
3038
Vladimir Markof52d92f2019-03-29 12:33:02 +00003039 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003040 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003041 REQUIRES_SHARED(Locks::mutator_lock_) {
3042 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3043 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003044 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003045 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003046 REQUIRES_SHARED(Locks::mutator_lock_) {
3047 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3048 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003049 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003050 ThreadState state ATTRIBUTE_UNUSED,
3051 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003052 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003053 REQUIRES_SHARED(Locks::mutator_lock_) {
3054 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3055 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003056 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003057 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003058 REQUIRES_SHARED(Locks::mutator_lock_) {
3059 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3060 }
3061
3062 public:
3063 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3064 ScopedLocalRef<jobject> wait_jobject_;
3065 ScopedLocalRef<jobject> block_jobject_;
3066 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3067
3068 private:
3069 const ScopedObjectAccessAlreadyRunnable& soaa_;
3070
3071 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3072 };
3073
3074 std::unique_ptr<Context> context(Context::Create());
3075 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3076 dumper.WalkStack();
3077
3078 // There should not be a pending exception. Otherwise, return with it pending.
3079 if (IsExceptionPending()) {
3080 return nullptr;
3081 }
3082
3083 // Now go and create Java arrays.
3084
3085 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3086
3087 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003088 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003089 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003090 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3091 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003092 return nullptr;
3093 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003094 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003095
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003096 Handle<mirror::Class> h_o_array_class =
3097 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3098 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003099
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003100
3101 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3102 class_linker->EnsureInitialized(soa.Self(),
3103 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003104 /* can_init_fields= */ true,
3105 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003106 if (soa.Self()->IsExceptionPending()) {
3107 // This should not fail in a healthy runtime.
3108 return nullptr;
3109 }
3110
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003111 ArtField* stack_trace_element_field = h_aste_class->FindField(
3112 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3113 DCHECK(stack_trace_element_field != nullptr);
3114 ArtField* held_locks_field = h_aste_class->FindField(
3115 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3116 DCHECK(held_locks_field != nullptr);
3117 ArtField* blocked_on_field = h_aste_class->FindField(
3118 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3119 DCHECK(blocked_on_field != nullptr);
3120
3121 size_t length = dumper.stack_trace_elements_.size();
3122 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003123 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003124 if (array == nullptr) {
3125 soa.Self()->AssertPendingOOMException();
3126 return nullptr;
3127 }
3128
3129 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3130
3131 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3132 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3133 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3134 for (size_t i = 0; i != length; ++i) {
3135 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3136 if (handle == nullptr) {
3137 soa.Self()->AssertPendingOOMException();
3138 return nullptr;
3139 }
3140
3141 // Set stack trace element.
3142 stack_trace_element_field->SetObject<false>(
3143 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3144
3145 // Create locked-on array.
3146 if (!dumper.lock_objects_[i].empty()) {
3147 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3148 h_o_array_class.Get(),
3149 dumper.lock_objects_[i].size()));
3150 if (handle2 == nullptr) {
3151 soa.Self()->AssertPendingOOMException();
3152 return nullptr;
3153 }
3154 int32_t j = 0;
3155 for (auto& scoped_local : dumper.lock_objects_[i]) {
3156 if (scoped_local == nullptr) {
3157 continue;
3158 }
3159 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3160 DCHECK(!soa.Self()->IsExceptionPending());
3161 j++;
3162 }
3163 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3164 }
3165
3166 // Set blocked-on object.
3167 if (i == 0) {
3168 if (dumper.block_jobject_ != nullptr) {
3169 blocked_on_field->SetObject<false>(
3170 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3171 }
3172 }
3173
3174 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3175 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3176 DCHECK(!soa.Self()->IsExceptionPending());
3177 }
3178
3179 return result.release();
3180}
3181
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003182void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003183 va_list args;
3184 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003185 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003186 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003187}
3188
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003189void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003190 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003191 std::string msg;
3192 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003193 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003194}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003195
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003196void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003197 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003198 // Callers should either clear or call ThrowNewWrappedException.
3199 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003200 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003201}
3202
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003203static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003204 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003205 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003206 return method != nullptr
3207 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003208 : nullptr;
3209}
3210
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003211void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003212 const char* msg) {
3213 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003214 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003215 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003216 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003217 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003218 ClearException();
3219 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003220 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003221 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003222 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003223 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003224 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003225 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003226 return;
3227 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003228
Ian Rogers7b078e82014-09-10 14:44:24 -07003229 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3230 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003231 DCHECK(IsExceptionPending());
3232 return;
3233 }
3234 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003235 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003236 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003237
Mathieu Chartier590fee92013-09-13 13:46:47 -07003238 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003239 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003240 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3241 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003242 return;
3243 }
3244
Ian Rogers62d6c772013-02-27 08:32:07 -08003245 // Choose an appropriate constructor and set up the arguments.
3246 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003247 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003248 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003249 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003250 msg_string.reset(
3251 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003252 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003253 CHECK(IsExceptionPending()); // OOME.
3254 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003255 }
Dave Allison0aded082013-11-07 13:15:11 -08003256 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003257 signature = "(Ljava/lang/String;)V";
3258 } else {
3259 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3260 }
3261 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003262 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003263 signature = "()V";
3264 } else {
3265 signature = "(Ljava/lang/Throwable;)V";
3266 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003267 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003268 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003269 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003270
Dave Allison0aded082013-11-07 13:15:11 -08003271 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003272 << PrettyDescriptor(exception_class_descriptor);
3273
3274 if (UNLIKELY(!runtime->IsStarted())) {
3275 // Something is trying to throw an exception without a started runtime, which is the common
3276 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3277 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003278 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003279 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003280 }
Dave Allison0aded082013-11-07 13:15:11 -08003281 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003282 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003283 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003284 ScopedLocalRef<jobject> trace(GetJniEnv(),
3285 Runtime::Current()->IsActiveTransaction()
3286 ? CreateInternalStackTrace<true>(soa)
3287 : CreateInternalStackTrace<false>(soa));
3288 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003289 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003290 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003291 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003292 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003293 jvalue jv_args[2];
3294 size_t i = 0;
3295
Dave Allison0aded082013-11-07 13:15:11 -08003296 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003297 jv_args[i].l = msg_string.get();
3298 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003299 }
Dave Allison0aded082013-11-07 13:15:11 -08003300 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003301 jv_args[i].l = cause.get();
3302 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003303 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003304 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Alex Light01fbfbe2019-06-27 10:47:04 -07003305 InvokeWithJValues(soa, ref.get(), exception_init_method, jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003306 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003307 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003308 }
Elliott Hughes30646832011-10-13 16:59:46 -07003309 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003310}
3311
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003312void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003313 LOG(WARNING) << "Throwing OutOfMemoryError "
3314 << '"' << msg << '"'
3315 << " (VmSize " << GetProcessStatus("VmSize")
3316 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003317 if (!tls32_.throwing_OutOfMemoryError) {
3318 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003319 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003320 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003321 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003322 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003323 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003324 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003325}
3326
Elliott Hughes498508c2011-10-17 14:58:22 -07003327Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003328 return Thread::Current();
3329}
3330
3331void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003332 std::ostringstream ss;
3333 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003334 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003335 // log to stderr for debugging command line processes
3336 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003337#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003338 // log to logcat for debugging frameworks processes
3339 LOG(INFO) << str;
3340#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003341}
3342
Ian Rogersdd7624d2014-03-14 17:43:00 -07003343// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003344template
3345void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3346template
3347void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003348
Andreas Gampe542451c2016-07-26 09:02:02 -07003349template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003350void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3351#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003352 if (offset == (x).Uint32Value()) { \
3353 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003354 return; \
3355 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003356 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3357 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3358 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3359 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3360 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3361 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3362 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3363 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003364 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003365 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003366 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003367 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003368 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003369#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003370
Ian Rogersdd7624d2014-03-14 17:43:00 -07003371#define JNI_ENTRY_POINT_INFO(x) \
3372 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3373 os << #x; \
3374 return; \
3375 }
3376 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3377#undef JNI_ENTRY_POINT_INFO
3378
Ian Rogersdd7624d2014-03-14 17:43:00 -07003379#define QUICK_ENTRY_POINT_INFO(x) \
3380 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3381 os << #x; \
3382 return; \
3383 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003384 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003385 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3386 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3387 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3388 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003389 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3390 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003391 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003392 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003393 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3394 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3395 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003396 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003397 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003398 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003399 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3400 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003401 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003402 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3403 QUICK_ENTRY_POINT_INFO(pSet8Static)
3404 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3405 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003406 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3407 QUICK_ENTRY_POINT_INFO(pSet32Static)
3408 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3409 QUICK_ENTRY_POINT_INFO(pSet64Static)
3410 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3411 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003412 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3413 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3414 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3415 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3416 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3417 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3418 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3419 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003420 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3421 QUICK_ENTRY_POINT_INFO(pGet32Static)
3422 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3423 QUICK_ENTRY_POINT_INFO(pGet64Static)
3424 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3425 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003426 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003427 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3428 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3429 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3430 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3431 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3432 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3433 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3434 QUICK_ENTRY_POINT_INFO(pLockObject)
3435 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3436 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3437 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3438 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3439 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003440 QUICK_ENTRY_POINT_INFO(pCos)
3441 QUICK_ENTRY_POINT_INFO(pSin)
3442 QUICK_ENTRY_POINT_INFO(pAcos)
3443 QUICK_ENTRY_POINT_INFO(pAsin)
3444 QUICK_ENTRY_POINT_INFO(pAtan)
3445 QUICK_ENTRY_POINT_INFO(pAtan2)
3446 QUICK_ENTRY_POINT_INFO(pCbrt)
3447 QUICK_ENTRY_POINT_INFO(pCosh)
3448 QUICK_ENTRY_POINT_INFO(pExp)
3449 QUICK_ENTRY_POINT_INFO(pExpm1)
3450 QUICK_ENTRY_POINT_INFO(pHypot)
3451 QUICK_ENTRY_POINT_INFO(pLog)
3452 QUICK_ENTRY_POINT_INFO(pLog10)
3453 QUICK_ENTRY_POINT_INFO(pNextAfter)
3454 QUICK_ENTRY_POINT_INFO(pSinh)
3455 QUICK_ENTRY_POINT_INFO(pTan)
3456 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003457 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003458 QUICK_ENTRY_POINT_INFO(pL2d)
3459 QUICK_ENTRY_POINT_INFO(pFmodf)
3460 QUICK_ENTRY_POINT_INFO(pL2f)
3461 QUICK_ENTRY_POINT_INFO(pD2iz)
3462 QUICK_ENTRY_POINT_INFO(pF2iz)
3463 QUICK_ENTRY_POINT_INFO(pIdivmod)
3464 QUICK_ENTRY_POINT_INFO(pD2l)
3465 QUICK_ENTRY_POINT_INFO(pF2l)
3466 QUICK_ENTRY_POINT_INFO(pLdiv)
3467 QUICK_ENTRY_POINT_INFO(pLmod)
3468 QUICK_ENTRY_POINT_INFO(pLmul)
3469 QUICK_ENTRY_POINT_INFO(pShlLong)
3470 QUICK_ENTRY_POINT_INFO(pShrLong)
3471 QUICK_ENTRY_POINT_INFO(pUshrLong)
3472 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003473 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3474 QUICK_ENTRY_POINT_INFO(pMemcpy)
3475 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3476 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3477 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3478 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3479 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3480 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3481 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3482 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003483 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003484 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3485 QUICK_ENTRY_POINT_INFO(pDeliverException)
3486 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3487 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003488 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3489 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003490 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003491 QUICK_ENTRY_POINT_INFO(pA64Load)
3492 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003493 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3494 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3495 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3496 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3497 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3498 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3499 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3500 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3501 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3502 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3503 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3504 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3505 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3506 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3507 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3508 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003509 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003510 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3511 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3512 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3513 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3514 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3515 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3516 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3517 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3518 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3519 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3520 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3521 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3522 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3523 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3524 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3525 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3526 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3527 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3528 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3529 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3530 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3531 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3532 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3533 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3534 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3535 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3536 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3537 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3538 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3539 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003540 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003541 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003542
3543 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3544 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003545#undef QUICK_ENTRY_POINT_INFO
3546
Elliott Hughes98e20172012-04-24 15:38:13 -07003547 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003548}
3549
jeffhao94d6df42012-11-26 16:02:12 -08003550void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003551 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003552 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003553 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003554 if (exception == GetDeoptimizationException()) {
3555 artDeoptimize(this);
3556 UNREACHABLE();
3557 }
3558
Roland Levillaina78f5b62017-09-29 13:50:44 +01003559 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003560
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003561 // This is a real exception: let the instrumentation know about it.
3562 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003563 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003564 IsExceptionThrownByCurrentMethod(exception)) {
3565 // Instrumentation may cause GC so keep the exception object safe.
3566 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003567 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Vladimir Marko19711d42019-04-12 14:05:34 +01003568 instrumentation->ExceptionThrownEvent(this, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003569 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003570 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3571 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3572 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3573 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003574 //
3575 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3576 // expected to happen fairly regularly but the second can only happen if we are using
3577 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3578 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003579 ShadowFrame* cf;
David Srbecky1cbac5c2019-07-18 20:05:32 +01003580 bool force_deopt = false;
3581 if (Runtime::Current()->AreNonStandardExitsEnabled() || kIsDebugBuild) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003582 NthCallerVisitor visitor(this, 0, false);
3583 visitor.WalkStack();
3584 cf = visitor.GetCurrentShadowFrame();
3585 if (cf == nullptr) {
3586 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3587 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003588 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3589 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003590 if (kIsDebugBuild && force_frame_pop) {
David Srbecky1cbac5c2019-07-18 20:05:32 +01003591 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
Alex Light0aa7a5a2018-10-10 15:58:14 +00003592 NthCallerVisitor penultimate_visitor(this, 1, false);
3593 penultimate_visitor.WalkStack();
3594 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3595 if (penultimate_frame == nullptr) {
3596 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3597 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003598 }
David Srbecky1cbac5c2019-07-18 20:05:32 +01003599 if (force_retry_instr) {
3600 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3601 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003602 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003603 }
Alex Light3dacdd62019-03-12 15:45:47 +00003604 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003605 NthCallerVisitor visitor(this, 0, false);
3606 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003607 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003608 // method_type shouldn't matter due to exception handling.
3609 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003610 // Save the exception into the deoptimization context so it can be restored
3611 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003612 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003613 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3614 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3615 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003616 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3617 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003618 ClearException();
3619 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003620 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003621 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003622 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003623 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003624 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003625 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003626 artDeoptimize(this);
3627 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003628 } else {
3629 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3630 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003631 }
3632 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003633
Ian Rogers28ad40d2011-10-27 15:19:26 -07003634 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003635 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003636 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003637 QuickExceptionHandler exception_handler(this, false);
3638 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003639 if (exception_handler.GetClearException()) {
3640 // Exception was cleared as part of delivery.
3641 DCHECK(!IsExceptionPending());
3642 } else {
3643 // Exception was put back with a throw location.
3644 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003645 // Check the to-space invariant on the re-installed exception (if applicable).
3646 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003647 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003648 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003649}
3650
Ian Rogersbdb03912011-09-14 00:55:44 -07003651Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003652 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003653 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003654 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003655 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003656 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003657 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003658 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003659 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003660}
3661
Andreas Gampec7d878d2018-11-19 18:42:06 +00003662ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003663 bool check_suspended,
3664 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003665 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3666 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3667 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003668 ArtMethod* method = nullptr;
3669 uint32_t dex_pc = dex::kDexNoIndex;
3670 StackVisitor::WalkStack(
3671 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3672 ArtMethod* m = visitor->GetMethod();
3673 if (m->IsRuntimeMethod()) {
3674 // Continue if this is a runtime method.
3675 return true;
3676 }
3677 method = m;
3678 dex_pc = visitor->GetDexPc(abort_on_error);
3679 return false;
3680 },
3681 const_cast<Thread*>(this),
3682 /* context= */ nullptr,
3683 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3684 check_suspended);
3685
3686 if (dex_pc_out != nullptr) {
3687 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003688 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003689 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003690}
3691
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003692bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3693 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003694}
3695
Roland Levillainad0777d2018-02-12 20:00:18 +00003696extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003697 REQUIRES_SHARED(Locks::mutator_lock_);
3698
Ian Rogers40e3bac2012-11-20 00:09:14 -08003699// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003700template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003701class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003702 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003703 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003704 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003705 // We are visiting the references in compiled frames, so we do not need
3706 // to know the inlined frames.
3707 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3708 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003709
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003710 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003711 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003712 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003713 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003714 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003715 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003716 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003717 VisitShadowFrame(shadow_frame);
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +00003718 } else if (GetCurrentOatQuickMethodHeader()->IsNterpMethodHeader()) {
3719 VisitNterpFrame();
Sebastien Hertz714f1752014-04-28 15:03:08 +02003720 } else {
3721 VisitQuickFrame();
3722 }
3723 return true;
3724 }
3725
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003726 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003727 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003728 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003729 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003730 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003731 // handle scope for JNI or References for interpreter.
3732 for (size_t reg = 0; reg < num_regs; ++reg) {
3733 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3734 if (ref != nullptr) {
3735 mirror::Object* new_ref = ref;
3736 visitor_(&new_ref, reg, this);
3737 if (new_ref != ref) {
3738 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003739 }
3740 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003741 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003742 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003743 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003744 }
3745
3746 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003747 // 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 -07003748 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3749 // the threads do not all hold the heap bitmap lock for parallel GC.
3750 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003751 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003752 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003753 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003754 // klass can be null for runtime methods.
3755 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003756 if (kVerifyImageObjectsMarked) {
3757 gc::Heap* const heap = Runtime::Current()->GetHeap();
3758 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003759 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003760 if (space != nullptr && space->IsImageSpace()) {
3761 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003762 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003763 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003764 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003765 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003766 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003767 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003768 }
3769 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003770 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3771 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3772 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003773 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003774 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003775 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3776 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003777 }
3778 }
3779 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003780 mirror::Object* new_ref = klass.Ptr();
Alex Light0054aa52019-09-10 16:46:48 -07003781 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kMethodDeclaringClass, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003782 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003783 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003784 }
3785 }
3786 }
3787
Nicolas Geoffray013d1ee2019-12-04 16:18:15 +00003788 void VisitNterpFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3789 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
3790 StackReference<mirror::Object>* vreg_ref_base =
3791 reinterpret_cast<StackReference<mirror::Object>*>(NterpGetReferenceArray(cur_quick_frame));
3792 StackReference<mirror::Object>* vreg_int_base =
3793 reinterpret_cast<StackReference<mirror::Object>*>(NterpGetRegistersArray(cur_quick_frame));
3794 CodeItemDataAccessor accessor((*cur_quick_frame)->DexInstructionData());
3795 const uint16_t num_regs = accessor.RegistersSize();
3796 // An nterp frame has two arrays: a dex register array and a reference array
3797 // that shadows the dex register array but only containing references
3798 // (non-reference dex registers have nulls). See nterp_helpers.cc.
3799 for (size_t reg = 0; reg < num_regs; ++reg) {
3800 StackReference<mirror::Object>* ref_addr = vreg_ref_base + reg;
3801 mirror::Object* ref = ref_addr->AsMirrorPtr();
3802 if (ref != nullptr) {
3803 mirror::Object* new_ref = ref;
3804 visitor_(&new_ref, reg, this);
3805 if (new_ref != ref) {
3806 ref_addr->Assign(new_ref);
3807 StackReference<mirror::Object>* int_addr = vreg_int_base + reg;
3808 int_addr->Assign(new_ref);
3809 }
3810 }
3811 }
3812 }
3813
Andreas Gampe585da952016-12-02 14:52:29 -08003814 template <typename T>
3815 ALWAYS_INLINE
3816 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003817 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003818 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003819 ArtMethod* m = *cur_quick_frame;
3820 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003821
Sebastien Hertz714f1752014-04-28 15:03:08 +02003822 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003823 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003824 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003825 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003826 StackReference<mirror::Object>* vreg_base =
3827 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003828 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbecky0d4567f2019-05-30 22:45:40 +01003829 CodeInfo code_info = kPrecise
3830 ? CodeInfo(method_header) // We will need dex register maps.
3831 : CodeInfo::DecodeGcMasksOnly(method_header);
David Srbecky052f8ca2018-04-26 15:42:54 +01003832 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003833 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003834
David Srbecky052f8ca2018-04-26 15:42:54 +01003835 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003836
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003837 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003838 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003839 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003840 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003841 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003842 mirror::Object* ref = ref_addr->AsMirrorPtr();
3843 if (ref != nullptr) {
3844 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003845 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003846 if (ref != new_ref) {
3847 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003848 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003849 }
3850 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003851 }
3852 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003853 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003854 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3855 if (register_mask & (1 << i)) {
3856 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003857 if (kIsDebugBuild && ref_addr == nullptr) {
3858 std::string thread_name;
3859 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003860 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003861 DescribeStack(GetThread());
3862 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3863 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3864 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003865 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003866 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003867 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003868 }
3869 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003870 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3871 // If this is a proxy method, visit its reference arguments.
3872 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003873 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003874 std::vector<StackReference<mirror::Object>*> ref_addrs =
3875 GetProxyReferenceArguments(cur_quick_frame);
3876 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3877 mirror::Object* ref = ref_addr->AsMirrorPtr();
3878 if (ref != nullptr) {
3879 mirror::Object* new_ref = ref;
Alex Light0054aa52019-09-10 16:46:48 -07003880 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kProxyReferenceArgument, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003881 if (ref != new_ref) {
3882 ref_addr->Assign(new_ref);
3883 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003884 }
3885 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003886 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003887 }
3888
Andreas Gampe585da952016-12-02 14:52:29 -08003889 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3890 if (kPrecise) {
3891 VisitQuickFramePrecise();
3892 } else {
3893 VisitQuickFrameNonPrecise();
3894 }
3895 }
3896
3897 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3898 struct UndefinedVRegInfo {
3899 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3900 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003901 const StackMap& map ATTRIBUTE_UNUSED,
3902 RootVisitor& _visitor)
3903 : visitor(_visitor) {
3904 }
3905
3906 ALWAYS_INLINE
3907 void VisitStack(mirror::Object** ref,
3908 size_t stack_index ATTRIBUTE_UNUSED,
3909 const StackVisitor* stack_visitor)
3910 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07003911 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003912 }
3913
3914 ALWAYS_INLINE
3915 void VisitRegister(mirror::Object** ref,
3916 size_t register_index ATTRIBUTE_UNUSED,
3917 const StackVisitor* stack_visitor)
3918 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07003919 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003920 }
3921
3922 RootVisitor& visitor;
3923 };
3924 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3925 }
3926
3927 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3928 struct StackMapVRegInfo {
3929 StackMapVRegInfo(ArtMethod* method,
3930 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003931 const StackMap& map,
3932 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003933 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003934 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003935 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003936 visitor(_visitor) {
Artem Serov2808be82018-12-20 19:15:11 +00003937 DCHECK_EQ(dex_register_map.size(), number_of_dex_registers);
Andreas Gampe585da952016-12-02 14:52:29 -08003938 }
3939
3940 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3941 // lookups for each location.
3942 void FindWithType(const size_t index,
3943 const DexRegisterLocation::Kind kind,
3944 mirror::Object** ref,
3945 const StackVisitor* stack_visitor)
3946 REQUIRES_SHARED(Locks::mutator_lock_) {
3947 bool found = false;
3948 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003949 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003950 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3951 visitor(ref, dex_reg, stack_visitor);
3952 found = true;
3953 }
3954 }
3955
3956 if (!found) {
Alex Light0054aa52019-09-10 16:46:48 -07003957 // If nothing found, report with unknown.
3958 visitor(ref, JavaFrameRootInfo::kUnknownVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003959 }
3960 }
3961
3962 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3963 REQUIRES_SHARED(Locks::mutator_lock_) {
3964 const size_t stack_offset = stack_index * kFrameSlotSize;
3965 FindWithType(stack_offset,
3966 DexRegisterLocation::Kind::kInStack,
3967 ref,
3968 stack_visitor);
3969 }
3970
3971 void VisitRegister(mirror::Object** ref,
3972 size_t register_index,
3973 const StackVisitor* stack_visitor)
3974 REQUIRES_SHARED(Locks::mutator_lock_) {
3975 FindWithType(register_index,
3976 DexRegisterLocation::Kind::kInRegister,
3977 ref,
3978 stack_visitor);
3979 }
3980
3981 size_t number_of_dex_registers;
3982 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003983 DexRegisterMap dex_register_map;
3984 RootVisitor& visitor;
3985 };
3986 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3987 }
3988
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003989 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003990 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003991};
3992
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003993class RootCallbackVisitor {
3994 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003995 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003996
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003997 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003998 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003999 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004000 }
4001
4002 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004003 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08004004 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07004005};
4006
Alex Light55eccdf2019-10-07 13:51:13 +00004007void Thread::VisitReflectiveTargets(ReflectiveValueVisitor* visitor) {
4008 for (BaseReflectiveHandleScope* brhs = GetTopReflectiveHandleScope();
4009 brhs != nullptr;
4010 brhs = brhs->GetLink()) {
4011 brhs->VisitTargets(visitor);
4012 }
4013}
4014
Andreas Gampe585da952016-12-02 14:52:29 -08004015template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004016void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07004017 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004018 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02004019 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004020 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00004021 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07004022 }
Alex Light848574c2017-09-25 16:59:39 -07004023 if (tlsPtr_.async_exception != nullptr) {
4024 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
4025 RootInfo(kRootNativeStack, thread_id));
4026 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004027 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08004028 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
4029 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004030 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004031 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004032 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07004033 }
Sebastien Hertz07474662015-08-25 15:12:33 +00004034 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07004035 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004036 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004037 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07004038 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
4039 record != nullptr;
4040 record = record->GetLink()) {
4041 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
4042 shadow_frame != nullptr;
4043 shadow_frame = shadow_frame->GetLink()) {
4044 mapper.VisitShadowFrame(shadow_frame);
4045 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02004046 }
4047 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004048 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
4049 record != nullptr;
4050 record = record->GetLink()) {
4051 if (record->IsReference()) {
4052 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00004053 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004054 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004055 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
4056 RootInfo(kRootThreadObject, thread_id));
4057 }
4058 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
4059 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004060 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07004061 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
4062 record != nullptr;
4063 record = record->GetNext()) {
4064 mapper.VisitShadowFrame(record->GetShadowFrame());
4065 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004066 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004067 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
4068 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004069 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004070 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004071 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004072 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004073 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004074 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07004075 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004076 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004077 }
Nicolas Geoffraye3f775b2019-12-04 14:41:52 +00004078}
4079
4080void Thread::SweepInterpreterCache(IsMarkedVisitor* visitor) {
Nicolas Geoffraya00b54b2019-12-03 14:36:42 +00004081 for (InterpreterCache::Entry& entry : GetInterpreterCache()->GetArray()) {
4082 const Instruction* inst = reinterpret_cast<const Instruction*>(entry.first);
Nicolas Geoffraye3f775b2019-12-04 14:41:52 +00004083 if (inst != nullptr) {
4084 if (inst->Opcode() == Instruction::NEW_INSTANCE ||
4085 inst->Opcode() == Instruction::CHECK_CAST ||
4086 inst->Opcode() == Instruction::INSTANCE_OF ||
4087 inst->Opcode() == Instruction::NEW_ARRAY ||
4088 inst->Opcode() == Instruction::CONST_CLASS) {
4089 mirror::Class* cls = reinterpret_cast<mirror::Class*>(entry.second);
4090 if (cls == nullptr || cls == Runtime::GetWeakClassSentinel()) {
4091 // Entry got deleted in a previous sweep.
4092 continue;
4093 }
4094 Runtime::ProcessWeakClass(
4095 reinterpret_cast<GcRoot<mirror::Class>*>(&entry.second),
4096 visitor,
4097 Runtime::GetWeakClassSentinel());
4098 } else if (inst->Opcode() == Instruction::CONST_STRING ||
4099 inst->Opcode() == Instruction::CONST_STRING_JUMBO) {
4100 mirror::Object* object = reinterpret_cast<mirror::Object*>(entry.second);
4101 mirror::Object* new_object = visitor->IsMarked(object);
4102 // We know the string is marked because it's a strongly-interned string that
4103 // is always alive (see b/117621117 for trying to make those strings weak).
4104 // The IsMarked implementation of the CMS collector returns
4105 // null for newly allocated objects, but we know those haven't moved. Therefore,
4106 // only update the entry if we get a different non-null string.
4107 if (new_object != nullptr && new_object != object) {
4108 entry.second = reinterpret_cast<size_t>(new_object);
4109 }
4110 }
Nicolas Geoffraya00b54b2019-12-03 14:36:42 +00004111 }
4112 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004113}
4114
Andreas Gampe585da952016-12-02 14:52:29 -08004115void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4116 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004117 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004118 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004119 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004120 }
4121}
4122
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004123class VerifyRootVisitor : public SingleRootVisitor {
4124 public:
4125 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004126 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004127 VerifyObject(root);
4128 }
4129};
jeffhao25045522012-03-13 19:34:37 -07004130
Ian Rogers04d7aa92013-03-16 14:29:17 -07004131void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004132 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4133 VerifyRootVisitor visitor;
4134 std::unique_ptr<Context> context(Context::Create());
4135 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4136 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4137 mapper.WalkStack();
4138 }
jeffhao25045522012-03-13 19:34:37 -07004139}
jeffhao25045522012-03-13 19:34:37 -07004140
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004141// Set the stack end to that to be used during a stack overflow
4142void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004143 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004144 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004145 // However, we seem to have already extended to use the full stack.
4146 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004147 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004148 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004149 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004150 }
4151
Ian Rogersdd7624d2014-03-14 17:43:00 -07004152 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004153
4154 // Remove the stack overflow protection if is it set up.
4155 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4156 if (implicit_stack_check) {
4157 if (!UnprotectStack()) {
4158 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4159 }
4160 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004161}
4162
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004163void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004164 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004165 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004166 tlsPtr_.thread_local_start = start;
4167 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4168 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004169 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004170 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004171}
4172
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004173void Thread::ResetTlab() {
4174 SetTlab(nullptr, nullptr, nullptr);
4175}
4176
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004177bool Thread::HasTlab() const {
Mathieu Chartierc4bf6672020-01-13 13:07:16 -08004178 const bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004179 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004180 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004181 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004182 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004183 }
4184 return has_tlab;
4185}
4186
Elliott Hughes330304d2011-08-12 14:28:05 -07004187std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004188 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004189 return os;
4190}
4191
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004192bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004193 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4194 VLOG(threads) << "Protecting stack at " << pregion;
4195 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004196 if (fatal_on_error) {
4197 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4198 "Reason: "
4199 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4200 }
4201 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004202 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004203 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004204}
4205
4206bool Thread::UnprotectStack() {
4207 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4208 VLOG(threads) << "Unprotecting stack at " << pregion;
4209 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4210}
4211
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004212void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4213 CHECK(Dbg::IsDebuggerActive());
4214 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4215 CHECK(ssc != nullptr);
4216 tlsPtr_.single_step_control = ssc;
4217}
4218
4219void Thread::DeactivateSingleStepControl() {
4220 CHECK(Dbg::IsDebuggerActive());
4221 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4222 SingleStepControl* ssc = GetSingleStepControl();
4223 tlsPtr_.single_step_control = nullptr;
4224 delete ssc;
4225}
Dave Allison648d7112014-07-25 16:15:27 -07004226
Sebastien Hertz1558b572015-02-25 15:05:59 +01004227void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4228 CHECK(Dbg::IsDebuggerActive());
4229 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4230 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4231 CHECK(req != nullptr);
4232 tlsPtr_.debug_invoke_req = req;
4233}
4234
4235void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004236 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4237 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004238 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004239 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004240 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004241}
4242
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004243void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4244 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004245 tlsPtr_.method_verifier = verifier;
4246}
4247
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004248void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004249 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004250 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004251}
4252
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004253size_t Thread::NumberOfHeldMutexes() const {
4254 size_t count = 0;
4255 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004256 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004257 }
4258 return count;
4259}
4260
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004261void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4262 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4263 ClearException();
4264 ShadowFrame* shadow_frame =
4265 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004266 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004267 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004268 DeoptimizationMethodType method_type;
4269 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004270 SetTopOfStack(nullptr);
4271 SetTopOfShadowStack(shadow_frame);
4272
4273 // Restore the exception that was pending before deoptimization then interpret the
4274 // deoptimized frames.
4275 if (pending_exception != nullptr) {
4276 SetException(pending_exception);
4277 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004278 interpreter::EnterInterpreterFromDeoptimize(this,
4279 shadow_frame,
4280 result,
4281 from_code,
4282 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004283}
4284
Alex Light848574c2017-09-25 16:59:39 -07004285void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4286 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004287 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004288 if (kIsDebugBuild) {
4289 // Make sure we are in a checkpoint.
4290 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4291 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4292 << "It doesn't look like this was called in a checkpoint! this: "
4293 << this << " count: " << GetSuspendCount();
4294 }
4295 tlsPtr_.async_exception = new_exception.Ptr();
4296}
4297
4298bool Thread::ObserveAsyncException() {
4299 DCHECK(this == Thread::Current());
4300 if (tlsPtr_.async_exception != nullptr) {
4301 if (tlsPtr_.exception != nullptr) {
4302 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4303 << tlsPtr_.exception->Dump();
4304 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4305 }
4306 tlsPtr_.exception = tlsPtr_.async_exception;
4307 tlsPtr_.async_exception = nullptr;
4308 return true;
4309 } else {
4310 return IsExceptionPending();
4311 }
4312}
4313
Mathieu Chartier0795f232016-09-27 18:43:30 -07004314void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004315 CHECK(new_exception != nullptr);
4316 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004317 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004318}
4319
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004320bool Thread::IsAotCompiler() {
4321 return Runtime::Current()->IsAotCompiler();
4322}
4323
Andreas Gampe202f85a2017-02-06 10:23:26 -08004324mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004325 DCHECK(tlsPtr_.jpeer == nullptr);
4326 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004327 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4328 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4329 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4330 // mark/forward it here.
4331 peer = art::ReadBarrier::Mark(peer);
4332 }
4333 return peer;
4334}
4335
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004336void Thread::SetReadBarrierEntrypoints() {
4337 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004338 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004339}
4340
David Srbecky912f36c2018-09-08 12:22:58 +01004341void Thread::ClearAllInterpreterCaches() {
4342 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004343 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004344 thread->GetInterpreterCache()->Clear(thread);
4345 }
4346 } closure;
4347 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4348}
4349
Orion Hodson119733d2019-01-30 15:14:41 +00004350
Andreas Gampee5d23982019-01-08 10:34:26 -08004351void Thread::ReleaseLongJumpContextInternal() {
4352 // Each QuickExceptionHandler gets a long jump context and uses
4353 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4354 // Both finding catch blocks and deoptimization can trigger another
4355 // exception such as a result of class loading. So there can be nested
4356 // cases of exception handling and multiple contexts being used.
4357 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4358 // for reuse so there is no need to always allocate a new one each time when
4359 // getting a context. Since we only keep one context for reuse, delete the
4360 // existing one since the passed in context is yet to be used for longjump.
4361 delete tlsPtr_.long_jump_context;
4362}
4363
Orion Hodson119733d2019-01-30 15:14:41 +00004364void Thread::SetNativePriority(int new_priority) {
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004365 PaletteStatus status = PaletteSchedSetPriority(GetTid(), new_priority);
Orion Hodson119733d2019-01-30 15:14:41 +00004366 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4367}
4368
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004369int Thread::GetNativePriority() const {
Orion Hodson119733d2019-01-30 15:14:41 +00004370 int priority = 0;
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004371 PaletteStatus status = PaletteSchedGetPriority(GetTid(), &priority);
Orion Hodson119733d2019-01-30 15:14:41 +00004372 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4373 return priority;
4374}
4375
Alex Lighte0b2ce42019-02-21 19:23:42 +00004376bool Thread::IsSystemDaemon() const {
4377 if (GetPeer() == nullptr) {
4378 return false;
4379 }
4380 return jni::DecodeArtField(
4381 WellKnownClasses::java_lang_Thread_systemDaemon)->GetBoolean(GetPeer());
4382}
4383
Alex Lightb7c640d2019-03-20 15:52:13 -07004384ScopedExceptionStorage::ScopedExceptionStorage(art::Thread* self)
4385 : self_(self), hs_(self_), excp_(hs_.NewHandle<art::mirror::Throwable>(self_->GetException())) {
4386 self_->ClearException();
4387}
4388
Alex Light79d6c802019-06-27 15:50:11 +00004389void ScopedExceptionStorage::SuppressOldException(const char* message) {
4390 CHECK(self_->IsExceptionPending()) << *self_;
4391 ObjPtr<mirror::Throwable> old_suppressed(excp_.Get());
4392 excp_.Assign(self_->GetException());
4393 LOG(WARNING) << message << "Suppressing old exception: " << old_suppressed->Dump();
4394 self_->ClearException();
4395}
4396
Alex Lightb7c640d2019-03-20 15:52:13 -07004397ScopedExceptionStorage::~ScopedExceptionStorage() {
Alex Light79d6c802019-06-27 15:50:11 +00004398 CHECK(!self_->IsExceptionPending()) << *self_;
Alex Lightb7c640d2019-03-20 15:52:13 -07004399 if (!excp_.IsNull()) {
4400 self_->SetException(excp_.Get());
4401 }
4402}
4403
Elliott Hughes8daa0922011-09-11 13:46:25 -07004404} // namespace art