blob: 84983b87bf09061ba4dd7ef2edccdfc6ea05154f [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Carl Shapirob5573532011-07-12 18:22:59 -070016
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "thread.h"
Carl Shapirob5573532011-07-12 18:22:59 -070018
Hans Boehm81dc7ab2019-04-19 17:34:31 -070019#include <limits.h> // for INT_MAX
Ian Rogersb033c752011-07-20 12:22:35 -070020#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070021#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080022#include <sys/resource.h>
23#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070024
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -070025#if __has_feature(hwaddress_sanitizer)
26#include <sanitizer/hwasan_interface.h>
27#else
28#define __hwasan_tag_pointer(p, t) (p)
29#endif
30
Carl Shapirob5573532011-07-12 18:22:59 -070031#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070032#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070033#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070034#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070035#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070036#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070037
Andreas Gampe43e72432019-05-14 16:15:24 -070038#include "android-base/file.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080039#include "android-base/stringprintf.h"
Evan Chengd57c51e2018-01-26 15:43:08 +080040#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080041
Mathieu Chartiera62b4532017-04-26 13:16:25 -070042#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070043#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070044#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070045#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000046#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010047#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010048#include "base/casts.h"
Andreas Gampee5d23982019-01-08 10:34:26 -080049#include "arch/context.h"
David Sehr891a50e2017-10-27 17:01:07 -070050#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070051#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080052#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070053#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070054#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080055#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070056#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080057#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010059#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070060#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080061#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080062#include "dex/dex_file-inl.h"
63#include "dex/dex_file_annotations.h"
64#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070065#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080066#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070067#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000068#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070069#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070070#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070071#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070072#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070073#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070074#include "indirect_reference_table-inl.h"
Andreas Gamped77abd92019-01-02 16:10:20 -080075#include "instrumentation.h"
Steven Morelande431e272017-07-18 16:53:49 -070076#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010077#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010078#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070079#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010080#include "jni/java_vm_ext.h"
81#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070082#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070083#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070084#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080085#include "mirror/object_array-inl.h"
86#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070087#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080088#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070089#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070090#include "nativehelper/scoped_local_ref.h"
91#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070092#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010093#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070094#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070095#include "object_lock.h"
Orion Hodson119733d2019-01-30 15:14:41 +000096#include "palette/palette.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010097#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070098#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080099#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -0500100#include "reflection.h"
David Srbecky28f6cff2018-10-16 15:07:28 +0100101#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700102#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800103#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700104#include "scoped_thread_state_change-inl.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700105#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100106#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700107#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700108#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700109#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800110#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700111#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700112
Yu Lieac44242015-06-29 10:50:03 +0800113#if ART_USE_FUTEXES
114#include "linux/futex.h"
115#include "sys/syscall.h"
116#ifndef SYS_futex
117#define SYS_futex __NR_futex
118#endif
119#endif // ART_USE_FUTEXES
120
Carl Shapirob5573532011-07-12 18:22:59 -0700121namespace art {
122
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800123using android::base::StringAppendV;
124using android::base::StringPrintf;
125
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700126extern "C" NO_RETURN void artDeoptimize(Thread* self);
127
Ian Rogers0878d652013-04-18 17:38:35 -0700128bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700129pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800130ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700131const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100132bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100133Thread* Thread::jit_sensitive_thread_ = nullptr;
Andreas Gampe82372002019-07-24 15:42:09 -0700134#ifndef __BIONIC__
135thread_local Thread* Thread::self_tls_ = nullptr;
136#endif
Calin Juravleb2771b42016-04-07 17:09:25 +0100137
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700138static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700139
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700140// For implicit overflow checks we reserve an extra piece of memory at the bottom
141// of the stack (lowest memory). The higher portion of the memory
142// is protected against reads and the lower is available for use while
143// throwing the StackOverflow exception.
144constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
145
Elliott Hughes7dc51662012-05-16 14:48:43 -0700146static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
147
Ian Rogers5d76c432011-10-31 21:42:49 -0700148void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700149 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700150}
151
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700152static void UnimplementedEntryPoint() {
153 UNIMPLEMENTED(FATAL);
154}
155
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700156void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700157void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800158
159void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
160 CHECK(kUseReadBarrier);
161 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700162 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800163 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800164}
Ian Rogers7655f292013-07-29 11:07:13 -0700165
Ian Rogers848871b2013-08-05 10:56:33 -0700166void Thread::InitTlsEntryPoints() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800167 ScopedTrace trace("InitTlsEntryPoints");
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700168 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700169 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800170 uintptr_t* end = reinterpret_cast<uintptr_t*>(
171 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700172 for (uintptr_t* it = begin; it != end; ++it) {
173 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
174 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700175 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700176}
177
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800178void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000179 if (kUseReadBarrier && kRuntimeISA != InstructionSet::kX86_64) {
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800180 // Allocation entrypoint switching is currently only implemented for X86_64.
181 is_marking = true;
182 }
183 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700184}
185
Sebastien Hertz07474662015-08-25 15:12:33 +0000186class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200187 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100188 DeoptimizationContextRecord(const JValue& ret_val,
189 bool is_reference,
190 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800191 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700192 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000193 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100194 : ret_val_(ret_val),
195 is_reference_(is_reference),
196 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800197 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700198 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000199 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200200
201 JValue GetReturnValue() const { return ret_val_; }
202 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100203 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800204 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000205 DeoptimizationContextRecord* GetLink() const { return link_; }
206 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200207 DCHECK(is_reference_);
208 return ret_val_.GetGCRoot();
209 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000210 mirror::Object** GetPendingExceptionAsGCRoot() {
211 return reinterpret_cast<mirror::Object**>(&pending_exception_);
212 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700213 DeoptimizationMethodType GetDeoptimizationMethodType() const {
214 return deopt_method_type_;
215 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200216
217 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000218 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200219 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200220
Sebastien Hertz07474662015-08-25 15:12:33 +0000221 // Indicates whether the returned value is a reference. If so, the GC will visit it.
222 const bool is_reference_;
223
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100224 // Whether the context was created from an explicit deoptimization in the code.
225 const bool from_code_;
226
Sebastien Hertz07474662015-08-25 15:12:33 +0000227 // The exception that was pending before deoptimization (or null if there was no pending
228 // exception).
229 mirror::Throwable* pending_exception_;
230
Mingyao Yang2ee17902017-08-30 11:37:08 -0700231 // Whether the context was created for an (idempotent) runtime method.
232 const DeoptimizationMethodType deopt_method_type_;
233
Sebastien Hertz07474662015-08-25 15:12:33 +0000234 // A link to the previous DeoptimizationContextRecord.
235 DeoptimizationContextRecord* const link_;
236
237 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200238};
239
240class StackedShadowFrameRecord {
241 public:
242 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
243 StackedShadowFrameType type,
244 StackedShadowFrameRecord* link)
245 : shadow_frame_(shadow_frame),
246 type_(type),
247 link_(link) {}
248
249 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
250 StackedShadowFrameType GetType() const { return type_; }
251 StackedShadowFrameRecord* GetLink() const { return link_; }
252
253 private:
254 ShadowFrame* const shadow_frame_;
255 const StackedShadowFrameType type_;
256 StackedShadowFrameRecord* const link_;
257
258 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
259};
260
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100261void Thread::PushDeoptimizationContext(const JValue& return_value,
262 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700263 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100264 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700265 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000266 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
267 return_value,
268 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100269 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000270 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700271 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000272 tlsPtr_.deoptimization_context_stack);
273 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700274}
275
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100276void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800277 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700278 bool* from_code,
279 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000280 AssertHasDeoptimizationContext();
281 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
282 tlsPtr_.deoptimization_context_stack = record->GetLink();
283 result->SetJ(record->GetReturnValue().GetJ());
284 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100285 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700286 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700287 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000288}
289
290void Thread::AssertHasDeoptimizationContext() {
291 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
292 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800293}
294
Charles Mungeraa31f492018-11-01 18:57:38 +0000295enum {
296 kPermitAvailable = 0, // Incrementing consumes the permit
297 kNoPermit = 1, // Incrementing marks as waiter waiting
298 kNoPermitWaiterWaiting = 2
299};
300
301void Thread::Park(bool is_absolute, int64_t time) {
302 DCHECK(this == Thread::Current());
303#if ART_USE_FUTEXES
304 // Consume the permit, or mark as waiting. This cannot cause park_state to go
305 // outside of its valid range (0, 1, 2), because in all cases where 2 is
306 // assigned it is set back to 1 before returning, and this method cannot run
307 // concurrently with itself since it operates on the current thread.
308 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
309 if (old_state == kNoPermit) {
310 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800311 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Munger5cc0e752018-11-09 12:30:46 -0800312 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000313 if (!is_absolute && time == 0) {
314 // Thread.getState() is documented to return waiting for untimed parks.
315 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
316 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
Charles Mungered19c672019-02-21 15:32:32 -0800317 int result = futex(tls32_.park_state_.Address(),
Charles Mungeraa31f492018-11-01 18:57:38 +0000318 FUTEX_WAIT_PRIVATE,
319 /* sleep if val = */ kNoPermitWaiterWaiting,
320 /* timeout */ nullptr,
321 nullptr,
322 0);
Charles Mungered19c672019-02-21 15:32:32 -0800323 // This errno check must happen before the scope is closed, to ensure that
324 // no destructors (such as ScopedThreadSuspension) overwrite errno.
325 if (result == -1) {
326 switch (errno) {
327 case EAGAIN:
328 FALLTHROUGH_INTENDED;
329 case EINTR: break; // park() is allowed to spuriously return
330 default: PLOG(FATAL) << "Failed to park";
331 }
332 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000333 } else if (time > 0) {
334 // Only actually suspend and futex_wait if we're going to wait for some
335 // positive amount of time - the kernel will reject negative times with
336 // EINVAL, and a zero time will just noop.
337
338 // Thread.getState() is documented to return timed wait for timed parks.
339 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
340 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
341 timespec timespec;
Charles Mungered19c672019-02-21 15:32:32 -0800342 int result = 0;
Charles Mungeraa31f492018-11-01 18:57:38 +0000343 if (is_absolute) {
344 // Time is millis when scheduled for an absolute time
345 timespec.tv_nsec = (time % 1000) * 1000000;
346 timespec.tv_sec = time / 1000;
347 // This odd looking pattern is recommended by futex documentation to
348 // wait until an absolute deadline, with otherwise identical behavior to
349 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
350 // correct time when the system clock changes.
351 result = futex(tls32_.park_state_.Address(),
352 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
353 /* sleep if val = */ kNoPermitWaiterWaiting,
354 &timespec,
355 nullptr,
356 FUTEX_BITSET_MATCH_ANY);
357 } else {
358 // Time is nanos when scheduled for a relative time
359 timespec.tv_sec = time / 1000000000;
360 timespec.tv_nsec = time % 1000000000;
361 result = futex(tls32_.park_state_.Address(),
362 FUTEX_WAIT_PRIVATE,
363 /* sleep if val = */ kNoPermitWaiterWaiting,
364 &timespec,
365 nullptr,
366 0);
367 }
Charles Mungered19c672019-02-21 15:32:32 -0800368 // This errno check must happen before the scope is closed, to ensure that
369 // no destructors (such as ScopedThreadSuspension) overwrite errno.
370 if (result == -1) {
371 switch (errno) {
372 case ETIMEDOUT:
373 timed_out = true;
374 FALLTHROUGH_INTENDED;
375 case EAGAIN:
376 case EINTR: break; // park() is allowed to spuriously return
377 default: PLOG(FATAL) << "Failed to park";
378 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000379 }
380 }
381 // Mark as no longer waiting, and consume permit if there is one.
382 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
383 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800384 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000385 } else {
386 // the fetch_add has consumed the permit. immediately return.
387 DCHECK_EQ(old_state, kPermitAvailable);
388 }
389#else
390 #pragma clang diagnostic push
391 #pragma clang diagnostic warning "-W#warnings"
392 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
393 #pragma clang diagnostic pop
394 UNUSED(is_absolute, time);
395 UNIMPLEMENTED(WARNING);
396 sched_yield();
397#endif
398}
399
400void Thread::Unpark() {
401#if ART_USE_FUTEXES
402 // Set permit available; will be consumed either by fetch_add (when the thread
403 // tries to park) or store (when the parked thread is woken up)
404 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
405 == kNoPermitWaiterWaiting) {
406 int result = futex(tls32_.park_state_.Address(),
407 FUTEX_WAKE_PRIVATE,
408 /* number of waiters = */ 1,
409 nullptr,
410 nullptr,
411 0);
412 if (result == -1) {
413 PLOG(FATAL) << "Failed to unpark";
414 }
415 }
416#else
417 UNIMPLEMENTED(WARNING);
418#endif
419}
420
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700421void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
422 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
423 sf, type, tlsPtr_.stacked_shadow_frame_record);
424 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800425}
426
Andreas Gampe639bdd12015-06-03 11:22:45 -0700427ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700428 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700429 if (must_be_present) {
430 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700431 } else {
432 if (record == nullptr || record->GetType() != type) {
433 return nullptr;
434 }
435 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700436 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
437 ShadowFrame* shadow_frame = record->GetShadowFrame();
438 delete record;
439 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700440}
441
Mingyao Yang99170c62015-07-06 11:10:37 -0700442class FrameIdToShadowFrame {
443 public:
444 static FrameIdToShadowFrame* Create(size_t frame_id,
445 ShadowFrame* shadow_frame,
446 FrameIdToShadowFrame* next,
447 size_t num_vregs) {
448 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
449 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
450 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
451 }
452
453 static void Delete(FrameIdToShadowFrame* f) {
454 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
455 delete[] memory;
456 }
457
458 size_t GetFrameId() const { return frame_id_; }
459 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
460 FrameIdToShadowFrame* GetNext() const { return next_; }
461 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
462 bool* GetUpdatedVRegFlags() {
463 return updated_vreg_flags_;
464 }
465
466 private:
467 FrameIdToShadowFrame(size_t frame_id,
468 ShadowFrame* shadow_frame,
469 FrameIdToShadowFrame* next)
470 : frame_id_(frame_id),
471 shadow_frame_(shadow_frame),
472 next_(next) {}
473
474 const size_t frame_id_;
475 ShadowFrame* const shadow_frame_;
476 FrameIdToShadowFrame* next_;
477 bool updated_vreg_flags_[0];
478
479 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
480};
481
482static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
483 size_t frame_id) {
484 FrameIdToShadowFrame* found = nullptr;
485 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
486 if (record->GetFrameId() == frame_id) {
487 if (kIsDebugBuild) {
488 // Sanity check we have at most one record for this frame.
489 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
490 found = record;
491 } else {
492 return record;
493 }
494 }
495 }
496 return found;
497}
498
499ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
500 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
501 tlsPtr_.frame_id_to_shadow_frame, frame_id);
502 if (record != nullptr) {
503 return record->GetShadowFrame();
504 }
505 return nullptr;
506}
507
508// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
509bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
510 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
511 tlsPtr_.frame_id_to_shadow_frame, frame_id);
512 CHECK(record != nullptr);
513 return record->GetUpdatedVRegFlags();
514}
515
516ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
517 uint32_t num_vregs,
518 ArtMethod* method,
519 uint32_t dex_pc) {
520 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
521 if (shadow_frame != nullptr) {
522 return shadow_frame;
523 }
David Sehr709b0702016-10-13 09:12:37 -0700524 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700525 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
526 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
527 shadow_frame,
528 tlsPtr_.frame_id_to_shadow_frame,
529 num_vregs);
530 for (uint32_t i = 0; i < num_vregs; i++) {
531 // Do this to clear all references for root visitors.
532 shadow_frame->SetVRegReference(i, nullptr);
533 // This flag will be changed to true if the debugger modifies the value.
534 record->GetUpdatedVRegFlags()[i] = false;
535 }
536 tlsPtr_.frame_id_to_shadow_frame = record;
537 return shadow_frame;
538}
539
Alex Light184f0752018-07-13 11:18:22 -0700540TLSData* Thread::GetCustomTLS(const char* key) {
541 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
542 auto it = custom_tls_.find(key);
543 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
544}
545
546void Thread::SetCustomTLS(const char* key, TLSData* data) {
547 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
548 // custom_tls_lock_.
549 std::unique_ptr<TLSData> old_data(data);
550 {
551 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
552 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
553 }
554}
555
Mingyao Yang99170c62015-07-06 11:10:37 -0700556void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
557 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
558 if (head->GetFrameId() == frame_id) {
559 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
560 FrameIdToShadowFrame::Delete(head);
561 return;
562 }
563 FrameIdToShadowFrame* prev = head;
564 for (FrameIdToShadowFrame* record = head->GetNext();
565 record != nullptr;
566 prev = record, record = record->GetNext()) {
567 if (record->GetFrameId() == frame_id) {
568 prev->SetNext(record->GetNext());
569 FrameIdToShadowFrame::Delete(record);
570 return;
571 }
572 }
573 LOG(FATAL) << "No shadow frame for frame " << frame_id;
574 UNREACHABLE();
575}
576
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700577void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700578 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700579}
580
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700581void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700582 // One thread (us) survived the fork, but we have a new tid so we need to
583 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700584 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700585}
586
Brian Carlstrom78128a62011-09-15 17:21:19 -0700587void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700588 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700589 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800590 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700591 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800592 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700593 }
594 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700595 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
596 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800597 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700598 // Check that if we got here we cannot be shutting down (as shutdown should never have started
599 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700600 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700601 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
602 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
603 // the runtime in such a case. In case this ever changes, we need to make sure here to
604 // delete the tmp_jni_env, as we own it at this point.
605 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
606 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700607 Runtime::Current()->EndThreadBirth();
608 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700609 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700610 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800611 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800612
613 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700614 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700615 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700616 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
617 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800618 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100619
Andreas Gampe08883de2016-11-08 13:20:52 -0800620 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100621 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000622
Andreas Gampeac30fa22017-01-18 21:02:36 -0800623 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700624
Charles Mungeraa31f492018-11-01 18:57:38 +0000625 // Unpark ourselves if the java peer was unparked before it started (see
626 // b/28845097#comment49 for more information)
627
628 ArtField* unparkedField = jni::DecodeArtField(
629 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
630 bool should_unpark = false;
631 {
632 // Hold the lock here, so that if another thread calls unpark before the thread starts
633 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
634 // which could cause a lost unpark.
635 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
636 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
637 }
638 if (should_unpark) {
639 self->Unpark();
640 }
Ian Rogers365c1022012-06-22 15:05:28 -0700641 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800642 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700643 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700644 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
645 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700646 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700647 // Detach and delete self.
648 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700649
Dave Allison0aded082013-11-07 13:15:11 -0800650 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700651}
652
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700653Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800654 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800655 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100656 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700657 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
658 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700659 if (kIsDebugBuild) {
660 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800661 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700662 Locks::thread_list_lock_->AssertHeld(soa.Self());
663 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700664 }
665 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800666}
667
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700668Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
669 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100670 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700671}
672
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700673static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700674 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700675 if (stack_size == 0) {
676 stack_size = Runtime::Current()->GetDefaultStackSize();
677 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700678
Brian Carlstrom6414a972012-04-14 14:20:04 -0700679 // Dalvik used the bionic pthread default stack size for native threads,
680 // so include that here to support apps that expect large native stacks.
681 stack_size += 1 * MB;
682
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700683 // Under sanitization, frames of the interpreter may become bigger, both for C code as
684 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
685 // of all core classes cannot be done in all test circumstances.
686 if (kMemoryToolIsAvailable) {
687 stack_size = std::max(2 * MB, stack_size);
688 }
689
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700690 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
691 if (stack_size < PTHREAD_STACK_MIN) {
692 stack_size = PTHREAD_STACK_MIN;
693 }
694
Dave Allisonf9439142014-03-27 15:10:22 -0700695 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
696 // It's likely that callers are trying to ensure they have at least a certain amount of
697 // stack space, so we should add our reserved space on top of what they requested, rather
698 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700699 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700700 } else {
701 // If we are going to use implicit stack checks, allocate space for the protected
702 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000703 stack_size += Thread::kStackOverflowImplicitCheckSize +
704 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700705 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700706
707 // Some systems require the stack size to be a multiple of the system page size, so round up.
708 stack_size = RoundUp(stack_size, kPageSize);
709
710 return stack_size;
711}
712
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700713// Return the nearest page-aligned address below the current stack top.
714NO_INLINE
715static uint8_t* FindStackTop() {
716 return reinterpret_cast<uint8_t*>(
717 AlignDown(__builtin_frame_address(0), kPageSize));
718}
719
Dave Allisonf9439142014-03-27 15:10:22 -0700720// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700721// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700722ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700723void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700724 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700725 // Page containing current top of stack.
726 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700727
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700728 // Try to directly protect the stack.
729 VLOG(threads) << "installing stack protected region at " << std::hex <<
730 static_cast<void*>(pregion) << " to " <<
731 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700732 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700733 // Tell the kernel that we won't be needing these pages any more.
734 // NB. madvise will probably write zeroes into the memory (on linux it does).
735 uint32_t unwanted_size = stack_top - pregion - kPageSize;
736 madvise(pregion, unwanted_size, MADV_DONTNEED);
737 return;
738 }
739
740 // There is a little complexity here that deserves a special mention. On some
741 // architectures, the stack is created using a VM_GROWSDOWN flag
742 // to prevent memory being allocated when it's not needed. This flag makes the
743 // kernel only allocate memory for the stack by growing down in memory. Because we
744 // want to put an mprotected region far away from that at the stack top, we need
745 // to make sure the pages for the stack are mapped in before we call mprotect.
746 //
747 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
748 // with a non-mapped stack (usually only the main thread).
749 //
750 // We map in the stack by reading every page from the stack bottom (highest address)
751 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700752 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700753 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700754 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
755 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
756 // thus have to move the stack pointer. We do this portably by using a recursive function with a
757 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700758
Andreas Gampe6c63f862017-06-28 17:20:15 -0700759 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700760 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700761 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000762
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700763 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
764 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000765
Andreas Gampe6c63f862017-06-28 17:20:15 -0700766 struct RecurseDownStack {
767 // This function has an intentionally large stack size.
768#pragma GCC diagnostic push
769#pragma GCC diagnostic ignored "-Wframe-larger-than="
770 NO_INLINE
771 static void Touch(uintptr_t target) {
772 volatile size_t zero = 0;
773 // Use a large local volatile array to ensure a large frame size. Do not use anything close
774 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
775 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700776 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
777 constexpr size_t kAsanMultiplier =
778#ifdef ADDRESS_SANITIZER
779 2u;
780#else
781 1u;
782#endif
783 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700784 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700785 // Remove tag from the pointer. Nop in non-hwasan builds.
786 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
787 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700788 Touch(target);
789 }
790 zero *= 2; // Try to avoid tail recursion.
791 }
792#pragma GCC diagnostic pop
793 };
794 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000795
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700796 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700797 static_cast<void*>(pregion) << " to " <<
798 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
799
Dave Allison648d7112014-07-25 16:15:27 -0700800 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700801 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700802
803 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000804 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700805 uint32_t unwanted_size = stack_top - pregion - kPageSize;
806 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700807}
808
Ian Rogers120f1c72012-09-28 17:17:10 -0700809void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800810 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800811 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700812
813 if (VLOG_IS_ON(threads)) {
814 ScopedObjectAccess soa(env);
815
Andreas Gampe08883de2016-11-08 13:20:52 -0800816 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700817 ObjPtr<mirror::String> java_name =
818 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700819 std::string thread_name;
820 if (java_name != nullptr) {
821 thread_name = java_name->ToModifiedUtf8();
822 } else {
823 thread_name = "(Unnamed)";
824 }
825
826 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700827 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700828 }
829
Ian Rogers120f1c72012-09-28 17:17:10 -0700830 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700831
Ian Rogers120f1c72012-09-28 17:17:10 -0700832 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
833 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700834 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700835 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700836 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700837 thread_start_during_shutdown = true;
838 } else {
839 runtime->StartThreadBirth();
840 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700841 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700842 if (thread_start_during_shutdown) {
843 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
844 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
845 return;
846 }
847
848 Thread* child_thread = new Thread(is_daemon);
849 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700850 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700851 stack_size = FixStackSize(stack_size);
852
Roland Levillain2ae376f2018-01-30 11:35:11 +0000853 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
854 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800855 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
856 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700857
Andreas Gampe449357d2015-06-01 22:29:51 -0700858 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
859 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100860 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700861 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100862 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700863
Andreas Gampe449357d2015-06-01 22:29:51 -0700864 int pthread_create_result = 0;
865 if (child_jni_env_ext.get() != nullptr) {
866 pthread_t new_pthread;
867 pthread_attr_t attr;
868 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
869 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
870 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
871 "PTHREAD_CREATE_DETACHED");
872 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
873 pthread_create_result = pthread_create(&new_pthread,
874 &attr,
875 Thread::CreateCallback,
876 child_thread);
877 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
878
879 if (pthread_create_result == 0) {
880 // pthread_create started the new thread. The child is now responsible for managing the
881 // JNIEnvExt we created.
882 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
883 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700884 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700885 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700886 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700887 }
888
889 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
890 {
891 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
892 runtime->EndThreadBirth();
893 }
894 // Manually delete the global reference since Thread::Init will not have been run.
895 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
896 child_thread->tlsPtr_.jpeer = nullptr;
897 delete child_thread;
898 child_thread = nullptr;
899 // TODO: remove from thread group?
900 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
901 {
902 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100903 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700904 StringPrintf("pthread_create (%s stack) failed: %s",
905 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
906 ScopedObjectAccess soa(env);
907 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700908 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700909}
910
Andreas Gampe449357d2015-06-01 22:29:51 -0700911bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700912 // This function does all the initialization that must be run by the native thread it applies to.
913 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
914 // we can handshake with the corresponding native thread when it's ready.) Check this native
915 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800916 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800917
918 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
919 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
920 tlsPtr_.pthread_self = pthread_self();
921 CHECK(is_started_);
922
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800923 ScopedTrace trace("Thread::Init");
924
Elliott Hughesd8af1592012-04-16 20:40:15 -0700925 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800926 if (!InitStackHwm()) {
927 return false;
928 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700929 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700930 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800931 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700932 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700933 InitTid();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800934 {
935 ScopedTrace trace2("InitInterpreterTls");
936 interpreter::InitInterpreterTls(this);
937 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800938
Andreas Gampea47a6e82019-07-24 09:46:16 -0700939#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000940 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
941#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700942 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe82372002019-07-24 15:42:09 -0700943 Thread::self_tls_ = this;
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000944#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700945 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700946
Ian Rogersdd7624d2014-03-14 17:43:00 -0700947 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700948
Andreas Gampe449357d2015-06-01 22:29:51 -0700949 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800950 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
951 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700952 tlsPtr_.jni_env = jni_env_ext;
953 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100954 std::string error_msg;
955 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700956 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100957 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700958 return false;
959 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700960 }
961
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800962 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700963 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800964 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700965}
966
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800967template <typename PeerAction>
968Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700969 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800970 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800971 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900972 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
973 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800974 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700975 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800976 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700977 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800978 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800979 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700980 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900981 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
982 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800983 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700984 } else {
985 Runtime::Current()->StartThreadBirth();
986 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800987 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700988 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800989 if (!init_success) {
990 delete self;
991 return nullptr;
992 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700993 }
994 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700995
Jeff Hao848f70a2014-01-15 13:49:50 -0800996 self->InitStringEntryPoints();
997
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700998 CHECK_NE(self->GetState(), kRunnable);
999 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -07001000
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001001 // Run the action that is acting on the peer.
1002 if (!peer_action(self)) {
1003 runtime->GetThreadList()->Unregister(self);
1004 // Unregister deletes self, no need to do this here.
1005 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001006 }
Elliott Hughescac6cc72011-11-03 20:31:21 -07001007
Andreas Gampe56623832015-07-09 21:53:15 -07001008 if (VLOG_IS_ON(threads)) {
1009 if (thread_name != nullptr) {
1010 VLOG(threads) << "Attaching thread " << thread_name;
1011 } else {
1012 VLOG(threads) << "Attaching unnamed thread.";
1013 }
1014 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001015 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001016 }
1017
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001018 {
1019 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001020 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001021 }
1022
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001023 return self;
1024}
1025
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001026Thread* Thread::Attach(const char* thread_name,
1027 bool as_daemon,
1028 jobject thread_group,
1029 bool create_peer) {
1030 auto create_peer_action = [&](Thread* self) {
1031 // If we're the main thread, ClassLinker won't be created until after we're attached,
1032 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1033 // In the compiler, all threads need this hack, because no-one's going to be getting
1034 // a native peer!
1035 if (create_peer) {
1036 self->CreatePeer(thread_name, as_daemon, thread_group);
1037 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001038 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1039 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001040 {
1041 ScopedObjectAccess soa(self);
1042 LOG(ERROR) << "Exception creating thread peer:";
1043 LOG(ERROR) << self->GetException()->Dump();
1044 self->ClearException();
1045 }
1046 return false;
1047 }
1048 } else {
1049 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1050 if (thread_name != nullptr) {
1051 self->tlsPtr_.name->assign(thread_name);
1052 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001053 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001054 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1055 }
1056 }
1057 return true;
1058 };
1059 return Attach(thread_name, as_daemon, create_peer_action);
1060}
1061
1062Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1063 auto set_peer_action = [&](Thread* self) {
1064 // Install the given peer.
1065 {
1066 DCHECK(self == Thread::Current());
1067 ScopedObjectAccess soa(self);
1068 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1069 }
1070 self->GetJniEnv()->SetLongField(thread_peer,
1071 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001072 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001073 return true;
1074 };
1075 return Attach(thread_name, as_daemon, set_peer_action);
1076}
1077
Ian Rogers365c1022012-06-22 15:05:28 -07001078void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1079 Runtime* runtime = Runtime::Current();
1080 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001081 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001082
Dave Allison0aded082013-11-07 13:15:11 -08001083 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001084 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001085 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001086 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001087 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001088 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001089 CHECK(IsExceptionPending());
1090 return;
1091 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001092 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001093 jboolean thread_is_daemon = as_daemon;
1094
Elliott Hugheseac76672012-05-24 21:56:51 -07001095 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001096 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001097 CHECK(IsExceptionPending());
1098 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001099 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001100 {
1101 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001102 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001103 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001104 env->CallNonvirtualVoidMethod(peer.get(),
1105 WellKnownClasses::java_lang_Thread,
1106 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001107 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001108 if (IsExceptionPending()) {
1109 return;
1110 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001111
Ian Rogers120f1c72012-09-28 17:17:10 -07001112 Thread* self = this;
1113 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001114 env->SetLongField(peer.get(),
1115 WellKnownClasses::java_lang_Thread_nativePeer,
1116 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001117
1118 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001119 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001120 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001121 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001122 // The Thread constructor should have set the Thread.name to a
1123 // non-null value. However, because we can run without code
1124 // available (in the compiler, in tests), we manually assign the
1125 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001126 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001127 InitPeer<true>(soa,
1128 tlsPtr_.opeer,
1129 thread_is_daemon,
1130 thread_group,
1131 thread_name.get(),
1132 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001133 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001134 InitPeer<false>(soa,
1135 tlsPtr_.opeer,
1136 thread_is_daemon,
1137 thread_group,
1138 thread_name.get(),
1139 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001140 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001141 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001142 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001143 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001144 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001145 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001146 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001147}
1148
Andreas Gampebad529d2017-02-13 18:52:10 -08001149jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1150 const char* name,
1151 bool as_daemon,
1152 jobject thread_group) {
1153 Runtime* runtime = Runtime::Current();
1154 CHECK(!runtime->IsStarted());
1155
1156 if (thread_group == nullptr) {
1157 thread_group = runtime->GetMainThreadGroup();
1158 }
1159 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1160 // Add missing null check in case of OOM b/18297817
1161 if (name != nullptr && thread_name.get() == nullptr) {
1162 CHECK(Thread::Current()->IsExceptionPending());
1163 return nullptr;
1164 }
Andreas Gampea1e5b972019-03-18 16:54:25 -07001165 jint thread_priority = kNormThreadPriority; // Always normalize to NORM priority.
Andreas Gampebad529d2017-02-13 18:52:10 -08001166 jboolean thread_is_daemon = as_daemon;
1167
1168 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1169 if (peer.get() == nullptr) {
1170 CHECK(Thread::Current()->IsExceptionPending());
1171 return nullptr;
1172 }
1173
1174 // We cannot call Thread.init, as it will recursively ask for currentThread.
1175
1176 // The Thread constructor should have set the Thread.name to a
1177 // non-null value. However, because we can run without code
1178 // available (in the compiler, in tests), we manually assign the
1179 // fields the constructor should have set.
1180 ScopedObjectAccessUnchecked soa(Thread::Current());
1181 if (runtime->IsActiveTransaction()) {
1182 InitPeer<true>(soa,
1183 soa.Decode<mirror::Object>(peer.get()),
1184 thread_is_daemon,
1185 thread_group,
1186 thread_name.get(),
1187 thread_priority);
1188 } else {
1189 InitPeer<false>(soa,
1190 soa.Decode<mirror::Object>(peer.get()),
1191 thread_is_daemon,
1192 thread_group,
1193 thread_name.get(),
1194 thread_priority);
1195 }
1196
1197 return peer.release();
1198}
1199
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001200template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001201void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1202 ObjPtr<mirror::Object> peer,
1203 jboolean thread_is_daemon,
1204 jobject thread_group,
1205 jobject thread_name,
1206 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001207 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001208 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001209 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001210 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001211 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001212 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001213 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001214 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001215}
1216
Elliott Hughes899e7892012-01-24 14:57:32 -08001217void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001218 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001219 ::art::SetThreadName(name);
1220 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1221}
1222
Andreas Gampe9186ced2016-12-12 14:28:21 -08001223static void GetThreadStack(pthread_t thread,
1224 void** stack_base,
1225 size_t* stack_size,
1226 size_t* guard_size) {
1227#if defined(__APPLE__)
1228 *stack_size = pthread_get_stacksize_np(thread);
1229 void* stack_addr = pthread_get_stackaddr_np(thread);
1230
1231 // Check whether stack_addr is the base or end of the stack.
1232 // (On Mac OS 10.7, it's the end.)
1233 int stack_variable;
1234 if (stack_addr > &stack_variable) {
1235 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1236 } else {
1237 *stack_base = stack_addr;
1238 }
1239
1240 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1241 pthread_attr_t attributes;
1242 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1243 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1244 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1245#else
1246 pthread_attr_t attributes;
1247 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1248 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1249 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1250 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1251
1252#if defined(__GLIBC__)
1253 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1254 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1255 // will be broken because we'll die long before we get close to 2GB.
1256 bool is_main_thread = (::art::GetTid() == getpid());
1257 if (is_main_thread) {
1258 rlimit stack_limit;
1259 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1260 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1261 }
1262 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1263 size_t old_stack_size = *stack_size;
1264
1265 // Use the kernel default limit as our size, and adjust the base to match.
1266 *stack_size = 8 * MB;
1267 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1268
1269 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1270 << " to " << PrettySize(*stack_size)
1271 << " with base " << *stack_base;
1272 }
1273 }
1274#endif
1275
1276#endif
1277}
1278
Ian Rogersf4d4da12014-11-11 16:10:33 -08001279bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001280 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001281 void* read_stack_base;
1282 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001283 size_t read_guard_size;
1284 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001285
Ian Rogers13735952014-10-08 12:43:28 -07001286 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001287 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001288
Dave Allison648d7112014-07-25 16:15:27 -07001289 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1290 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1291 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1292 // between 8K and 12K.
1293 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1294 + 4 * KB;
1295 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001296 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001297 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1298 __LINE__,
1299 ::android::base::ERROR,
1300 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001301 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001302 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001303
Vladimir Markob8f2f632015-01-02 14:23:26 +00001304 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1305 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1306 read_stack_base,
1307 PrettySize(read_stack_size).c_str(),
1308 PrettySize(read_guard_size).c_str());
1309
Ian Rogers932746a2011-09-22 18:57:50 -07001310 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001311
1312 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001313 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001314
Dave Allisonb090a182014-08-14 17:02:48 +00001315 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001316
1317 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001318 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001319 // The thread might have protected region at the bottom. We need
1320 // to install our own region so we need to move the limits
1321 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001322
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001323 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1324 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1325 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001326
1327 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001328 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001329
1330 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001331 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001332
1333 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001334}
1335
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001336void Thread::ShortDump(std::ostream& os) const {
1337 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001338 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001339 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001340 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001341 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001342 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001343 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001344 << ",Thread*=" << this
1345 << ",peer=" << tlsPtr_.opeer
1346 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1347 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001348}
1349
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001350void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1351 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001352 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001353 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001354}
1355
Vladimir Marko4617d582019-03-28 13:48:31 +00001356ObjPtr<mirror::String> Thread::GetThreadName() const {
Andreas Gampe08883de2016-11-08 13:20:52 -08001357 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001358 if (tlsPtr_.opeer == nullptr) {
1359 return nullptr;
1360 }
1361 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1362 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001363}
1364
Elliott Hughesffb465f2012-03-01 18:46:05 -08001365void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001366 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001367}
1368
Jeff Hao57dac6e2013-08-15 16:36:24 -07001369uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001370#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001371 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001372 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001373 timespec now;
1374 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001375 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001376#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001377 UNIMPLEMENTED(WARNING);
1378 return -1;
1379#endif
1380}
1381
Ian Rogers01ae5802012-09-28 16:14:01 -07001382// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1383static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001384 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001385 Locks::thread_suspend_count_lock_->Unlock(self);
1386 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1387 Locks::mutator_lock_->SharedTryLock(self);
1388 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1389 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1390 }
1391 }
1392 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1393 Locks::thread_list_lock_->TryLock(self);
1394 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1395 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1396 }
1397 }
1398 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001399 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001400 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001401}
1402
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001403bool Thread::ModifySuspendCountInternal(Thread* self,
1404 int delta,
1405 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001406 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001407 if (kIsDebugBuild) {
1408 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001409 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001410 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1411 Locks::thread_suspend_count_lock_->AssertHeld(self);
1412 if (this != self && !IsSuspended()) {
1413 Locks::thread_list_lock_->AssertHeld(self);
1414 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001415 }
Alex Light88fd7202017-06-30 08:31:59 -07001416 // User code suspensions need to be checked more closely since they originate from code outside of
1417 // the runtime's control.
1418 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1419 Locks::user_code_suspension_lock_->AssertHeld(self);
1420 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1421 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1422 return false;
1423 }
1424 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001425 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001426 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001427 return false;
1428 }
1429
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001430 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1431 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1432 // deadlock. b/31683379.
1433 return false;
1434 }
1435
Yu Lieac44242015-06-29 10:50:03 +08001436 uint16_t flags = kSuspendRequest;
1437 if (delta > 0 && suspend_barrier != nullptr) {
1438 uint32_t available_barrier = kMaxSuspendBarriers;
1439 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1440 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1441 available_barrier = i;
1442 break;
1443 }
1444 }
1445 if (available_barrier == kMaxSuspendBarriers) {
1446 // No barrier spaces available, we can't add another.
1447 return false;
1448 }
1449 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1450 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001451 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001452
Ian Rogersdd7624d2014-03-14 17:43:00 -07001453 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001454 switch (reason) {
1455 case SuspendReason::kForDebugger:
1456 tls32_.debug_suspend_count += delta;
1457 break;
Alex Light88fd7202017-06-30 08:31:59 -07001458 case SuspendReason::kForUserCode:
1459 tls32_.user_code_suspend_count += delta;
1460 break;
Alex Light46f93402017-06-29 11:59:50 -07001461 case SuspendReason::kInternal:
1462 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001463 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001464
Ian Rogersdd7624d2014-03-14 17:43:00 -07001465 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001466 AtomicClearFlag(kSuspendRequest);
1467 } else {
Yu Lieac44242015-06-29 10:50:03 +08001468 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001469 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001470 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001471 }
Yu Lieac44242015-06-29 10:50:03 +08001472 return true;
1473}
1474
1475bool Thread::PassActiveSuspendBarriers(Thread* self) {
1476 // Grab the suspend_count lock and copy the current set of
1477 // barriers. Then clear the list and the flag. The ModifySuspendCount
1478 // function requires the lock so we prevent a race between setting
1479 // the kActiveSuspendBarrier flag and clearing it.
1480 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1481 {
1482 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1483 if (!ReadFlag(kActiveSuspendBarrier)) {
1484 // quick exit test: the barriers have already been claimed - this is
1485 // possible as there may be a race to claim and it doesn't matter
1486 // who wins.
1487 // All of the callers of this function (except the SuspendAllInternal)
1488 // will first test the kActiveSuspendBarrier flag without lock. Here
1489 // double-check whether the barrier has been passed with the
1490 // suspend_count lock.
1491 return false;
1492 }
1493
1494 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1495 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1496 tlsPtr_.active_suspend_barriers[i] = nullptr;
1497 }
1498 AtomicClearFlag(kActiveSuspendBarrier);
1499 }
1500
1501 uint32_t barrier_count = 0;
1502 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1503 AtomicInteger* pending_threads = pass_barriers[i];
1504 if (pending_threads != nullptr) {
1505 bool done = false;
1506 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001507 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001508 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1509 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001510 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001511#if ART_USE_FUTEXES
1512 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Hans Boehm81dc7ab2019-04-19 17:34:31 -07001513 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, INT_MAX, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001514 }
1515#endif
1516 } while (!done);
1517 ++barrier_count;
1518 }
1519 }
1520 CHECK_GT(barrier_count, 0U);
1521 return true;
1522}
1523
1524void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1525 CHECK(ReadFlag(kActiveSuspendBarrier));
1526 bool clear_flag = true;
1527 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1528 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1529 if (ptr == target) {
1530 tlsPtr_.active_suspend_barriers[i] = nullptr;
1531 } else if (ptr != nullptr) {
1532 clear_flag = false;
1533 }
1534 }
1535 if (LIKELY(clear_flag)) {
1536 AtomicClearFlag(kActiveSuspendBarrier);
1537 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001538}
1539
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001540void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001541 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1542 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1543 Closure* checkpoint;
1544 {
1545 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1546 checkpoint = tlsPtr_.checkpoint_function;
1547 if (!checkpoint_overflow_.empty()) {
1548 // Overflow list not empty, copy the first one out and continue.
1549 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1550 checkpoint_overflow_.pop_front();
1551 } else {
1552 // No overflow checkpoints. Clear the kCheckpointRequest flag
1553 tlsPtr_.checkpoint_function = nullptr;
1554 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001555 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001556 }
1557 // Outside the lock, run the checkpoint function.
1558 ScopedTrace trace("Run checkpoint function");
1559 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1560 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001561}
1562
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001563void Thread::RunEmptyCheckpoint() {
1564 DCHECK_EQ(Thread::Current(), this);
1565 AtomicClearFlag(kEmptyCheckpointRequest);
1566 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1567}
1568
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001569bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001570 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001571 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001572 if (old_state_and_flags.as_struct.state != kRunnable) {
1573 return false; // Fail, thread is suspended and so can't run a checkpoint.
1574 }
Dave Allison0aded082013-11-07 13:15:11 -08001575
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001576 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001577 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001578 union StateAndFlags new_state_and_flags;
1579 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001580 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001581 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001582 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001583 if (success) {
1584 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1585 if (tlsPtr_.checkpoint_function == nullptr) {
1586 tlsPtr_.checkpoint_function = function;
1587 } else {
1588 checkpoint_overflow_.push_back(function);
1589 }
Dave Allison0aded082013-11-07 13:15:11 -08001590 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001591 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001592 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001593 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001594}
1595
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001596bool Thread::RequestEmptyCheckpoint() {
1597 union StateAndFlags old_state_and_flags;
1598 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1599 if (old_state_and_flags.as_struct.state != kRunnable) {
1600 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1601 // heap access (eg. the read barrier).
1602 return false;
1603 }
1604
1605 // We must be runnable to request a checkpoint.
1606 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1607 union StateAndFlags new_state_and_flags;
1608 new_state_and_flags.as_int = old_state_and_flags.as_int;
1609 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001610 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001611 old_state_and_flags.as_int, new_state_and_flags.as_int);
1612 if (success) {
1613 TriggerSuspend();
1614 }
1615 return success;
1616}
1617
Andreas Gampee9f67122016-10-27 19:21:23 -07001618class BarrierClosure : public Closure {
1619 public:
1620 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1621
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001622 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001623 wrapped_->Run(self);
1624 barrier_.Pass(self);
1625 }
1626
Alex Light318afe62018-03-22 16:50:10 -07001627 void Wait(Thread* self, ThreadState suspend_state) {
1628 if (suspend_state != ThreadState::kRunnable) {
1629 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1630 } else {
1631 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1632 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001633 }
1634
1635 private:
1636 Closure* wrapped_;
1637 Barrier barrier_;
1638};
1639
Alex Lightb1e31a82017-10-04 16:57:36 -07001640// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001641bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001642 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001643 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001644 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1645 // Unlock the tll before running so that the state is the same regardless of thread.
1646 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001647 // Asked to run on this thread. Just run.
1648 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001649 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001650 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001651
1652 // The current thread is not this thread.
1653
Andreas Gampe28c4a232017-06-21 21:21:31 -07001654 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001655 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001656 return false;
1657 }
1658
Andreas Gampe28c4a232017-06-21 21:21:31 -07001659 struct ScopedThreadListLockUnlock {
1660 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1661 : self_thread(self_in) {
1662 Locks::thread_list_lock_->AssertHeld(self_thread);
1663 Locks::thread_list_lock_->Unlock(self_thread);
1664 }
1665
1666 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1667 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1668 Locks::thread_list_lock_->Lock(self_thread);
1669 }
1670
1671 Thread* self_thread;
1672 };
1673
Andreas Gampee9f67122016-10-27 19:21:23 -07001674 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001675 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001676 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1677 // suspend-count lock for too long.
1678 if (GetState() == ThreadState::kRunnable) {
1679 BarrierClosure barrier_closure(function);
1680 bool installed = false;
1681 {
1682 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1683 installed = RequestCheckpoint(&barrier_closure);
1684 }
1685 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001686 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1687 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1688 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001689 ScopedThreadStateChange sts(self, suspend_state);
1690 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001691 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001692 }
1693 // Fall-through.
1694 }
1695
1696 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1697 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1698 // certain situations.
1699 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001700 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1701
Alex Light46f93402017-06-29 11:59:50 -07001702 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001703 // Just retry the loop.
1704 sched_yield();
1705 continue;
1706 }
1707 }
1708
Andreas Gampe28c4a232017-06-21 21:21:31 -07001709 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001710 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1711 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001712 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001713 {
Alex Light318afe62018-03-22 16:50:10 -07001714 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001715 while (GetState() == ThreadState::kRunnable) {
1716 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1717 // moves us to suspended.
1718 sched_yield();
1719 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001720 }
1721
1722 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001723 }
1724
Andreas Gampee9f67122016-10-27 19:21:23 -07001725 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001726 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1727
1728 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001729 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001730 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001731 }
1732
Andreas Gampe117f9b32017-06-23 13:33:50 -07001733 {
1734 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1735 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1736 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1737 Thread::resume_cond_->Broadcast(self);
1738 }
1739
Alex Lightb1e31a82017-10-04 16:57:36 -07001740 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1741 Locks::thread_list_lock_->ExclusiveUnlock(self);
1742
Andreas Gampe28c4a232017-06-21 21:21:31 -07001743 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001744 }
1745}
1746
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001747Closure* Thread::GetFlipFunction() {
1748 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1749 Closure* func;
1750 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001751 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001752 if (func == nullptr) {
1753 return nullptr;
1754 }
Orion Hodson4557b382018-01-03 11:47:54 +00001755 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001756 DCHECK(func != nullptr);
1757 return func;
1758}
1759
1760void Thread::SetFlipFunction(Closure* function) {
1761 CHECK(function != nullptr);
1762 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001763 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001764}
1765
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001766void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001767 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001768 VLOG(threads) << this << " self-suspending";
1769 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001770 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001771 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001772 VLOG(threads) << this << " self-reviving";
1773}
1774
Andreas Gampe9186ced2016-12-12 14:28:21 -08001775static std::string GetSchedulerGroupName(pid_t tid) {
1776 // /proc/<pid>/cgroup looks like this:
1777 // 2:devices:/
1778 // 1:cpuacct,cpu:/
1779 // We want the third field from the line whose second field contains the "cpu" token.
1780 std::string cgroup_file;
Andreas Gampe43e72432019-05-14 16:15:24 -07001781 if (!android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid),
1782 &cgroup_file)) {
Andreas Gampe9186ced2016-12-12 14:28:21 -08001783 return "";
1784 }
1785 std::vector<std::string> cgroup_lines;
1786 Split(cgroup_file, '\n', &cgroup_lines);
1787 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1788 std::vector<std::string> cgroup_fields;
1789 Split(cgroup_lines[i], ':', &cgroup_fields);
1790 std::vector<std::string> cgroups;
1791 Split(cgroup_fields[1], ',', &cgroups);
1792 for (size_t j = 0; j < cgroups.size(); ++j) {
1793 if (cgroups[j] == "cpu") {
1794 return cgroup_fields[2].substr(1); // Skip the leading slash.
1795 }
1796 }
1797 }
1798 return "";
1799}
1800
1801
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001802void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001803 std::string group_name;
1804 int priority;
1805 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001806 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001807
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001808 // If flip_function is not null, it means we have run a checkpoint
1809 // before the thread wakes up to execute the flip function and the
1810 // thread roots haven't been forwarded. So the following access to
1811 // the roots (opeer or methods in the frames) would be bad. Run it
1812 // here. TODO: clean up.
1813 if (thread != nullptr) {
1814 ScopedObjectAccessUnchecked soa(self);
1815 Thread* this_thread = const_cast<Thread*>(thread);
1816 Closure* flip_func = this_thread->GetFlipFunction();
1817 if (flip_func != nullptr) {
1818 flip_func->Run(this_thread);
1819 }
1820 }
1821
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001822 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1823 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001824 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001825 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001826 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001827 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001828 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001829 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001830
Mathieu Chartier3398c782016-09-30 10:27:43 -07001831 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001832 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1833 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001834
Dave Allison0aded082013-11-07 13:15:11 -08001835 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001836 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001837 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001838 ObjPtr<mirror::String> group_name_string =
1839 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001840 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001841 }
1842 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001843 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001844 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001845
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001846 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001847 if (scheduler_group_name.empty()) {
1848 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001849 }
1850
Dave Allison0aded082013-11-07 13:15:11 -08001851 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001852 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001853 if (is_daemon) {
1854 os << " daemon";
1855 }
1856 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001857 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001858 << " " << thread->GetState();
1859 if (thread->IsStillStarting()) {
1860 os << " (still starting up)";
1861 }
1862 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001863 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001864 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001865 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001866 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001867 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001868
Dave Allison0aded082013-11-07 13:15:11 -08001869 if (thread != nullptr) {
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001870 auto suspend_log_fn = [&]() REQUIRES(Locks::thread_suspend_count_lock_) {
1871 os << " | group=\"" << group_name << "\""
1872 << " sCount=" << thread->tls32_.suspend_count
1873 << " dsCount=" << thread->tls32_.debug_suspend_count
1874 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
1875 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
1876 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1877 };
1878 if (Locks::thread_suspend_count_lock_->IsExclusiveHeld(self)) {
1879 Locks::thread_suspend_count_lock_->AssertExclusiveHeld(self); // For annotalysis.
1880 suspend_log_fn();
1881 } else {
1882 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1883 suspend_log_fn();
1884 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001885 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001886
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001887 os << " | sysTid=" << tid
1888 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001889 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001890 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001891 int policy;
1892 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001893#if !defined(__APPLE__)
1894 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1895 policy = sched_getscheduler(tid);
1896 if (policy == -1) {
1897 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1898 }
1899 int sched_getparam_result = sched_getparam(tid, &sp);
1900 if (sched_getparam_result == -1) {
1901 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1902 sp.sched_priority = -1;
1903 }
1904#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001905 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1906 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001907#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001908 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001909 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001910 }
1911 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001912
1913 // Grab the scheduler stats for this thread.
1914 std::string scheduler_stats;
Andreas Gampe43e72432019-05-14 16:15:24 -07001915 if (android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid),
1916 &scheduler_stats)
Evan Chengd57c51e2018-01-26 15:43:08 +08001917 && !scheduler_stats.empty()) {
1918 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001919 } else {
1920 scheduler_stats = "0 0 0";
1921 }
1922
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001923 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001924 int utime = 0;
1925 int stime = 0;
1926 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001927 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001928
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001929 os << " | state=" << native_thread_state
1930 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001931 << " utm=" << utime
1932 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001933 << " core=" << task_cpu
1934 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001935 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001936 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1937 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1938 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001939 // Dump the held mutexes.
1940 os << " | held mutexes=";
1941 for (size_t i = 0; i < kLockLevelCount; ++i) {
1942 if (i != kMonitorLock) {
1943 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1944 if (mutex != nullptr) {
1945 os << " \"" << mutex->GetName() << "\"";
1946 if (mutex->IsReaderWriterMutex()) {
1947 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001948 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001949 os << "(exclusive held)";
1950 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001951 os << "(shared held)";
1952 }
1953 }
1954 }
1955 }
1956 }
1957 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001958 }
1959}
1960
1961void Thread::DumpState(std::ostream& os) const {
1962 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001963}
1964
Andreas Gampe93104952017-12-13 17:13:15 -08001965struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001966 StackDumpVisitor(std::ostream& os_in,
1967 Thread* thread_in,
1968 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001969 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001970 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001971 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001972 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001973 : MonitorObjectsStackVisitor(thread_in,
1974 context,
1975 check_suspended,
1976 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001977 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001978 last_method(nullptr),
1979 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001980 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001981
Ian Rogersbdb03912011-09-14 00:55:44 -07001982 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001983 if (frame_count == 0) {
1984 os << " (no managed stack frames)\n";
1985 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001986 }
1987
Andreas Gampe93104952017-12-13 17:13:15 -08001988 static constexpr size_t kMaxRepetition = 3u;
1989
1990 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001991 override
Andreas Gampe93104952017-12-13 17:13:15 -08001992 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001993 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001994 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001995 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001996 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001997 const DexFile* dex_file = dex_cache->GetDexFile();
1998 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001999 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07002000 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08002001 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002002 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07002003 if (repetition_count >= kMaxRepetition) {
2004 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
2005 }
2006 repetition_count = 0;
2007 last_line_number = line_number;
2008 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002009 }
Andreas Gampe93104952017-12-13 17:13:15 -08002010
2011 if (repetition_count >= kMaxRepetition) {
2012 // Skip visiting=printing anything.
2013 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002014 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07002015
Andreas Gampe93104952017-12-13 17:13:15 -08002016 os << " at " << m->PrettyMethod(false);
2017 if (m->IsNative()) {
2018 os << "(Native method)";
2019 } else {
2020 const char* source_file(m->GetDeclaringClassSourceFile());
2021 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2022 << ":" << line_number << ")";
2023 }
2024 os << "\n";
2025 // Go and visit locks.
2026 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002027 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002028
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002029 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002030 return VisitMethodResult::kContinueMethod;
2031 }
2032
Vladimir Markof52d92f2019-03-29 12:33:02 +00002033 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002034 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002035 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002036 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2037 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002038 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002039 override
Andreas Gampe93104952017-12-13 17:13:15 -08002040 REQUIRES_SHARED(Locks::mutator_lock_) {
2041 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2042 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002043 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002044 ThreadState state,
2045 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002046 override
Andreas Gampe93104952017-12-13 17:13:15 -08002047 REQUIRES_SHARED(Locks::mutator_lock_) {
2048 const char* msg;
2049 switch (state) {
2050 case kBlocked:
2051 msg = " - waiting to lock ";
2052 break;
2053
2054 case kWaitingForLockInflation:
2055 msg = " - waiting for lock inflation of ";
2056 break;
2057
2058 default:
2059 LOG(FATAL) << "Unreachable";
2060 UNREACHABLE();
2061 }
2062 PrintObject(obj, msg, owner_tid);
2063 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002064 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002065 override
Andreas Gampe93104952017-12-13 17:13:15 -08002066 REQUIRES_SHARED(Locks::mutator_lock_) {
2067 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2068 }
2069
Vladimir Markof52d92f2019-03-29 12:33:02 +00002070 void PrintObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002071 const char* msg,
2072 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2073 if (obj == nullptr) {
2074 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002075 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002076 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002077 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2078 // Getting the identity hashcode here would result in lock inflation and suspension of the
2079 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002080 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
Vladimir Markof52d92f2019-03-29 12:33:02 +00002081 reinterpret_cast<intptr_t>(obj.Ptr()),
Andreas Gampe93104952017-12-13 17:13:15 -08002082 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002083 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002084 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2085 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2086 // suspension and move pretty_object.
2087 const std::string pretty_type(obj->PrettyTypeOf());
2088 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002089 }
2090 }
Andreas Gampe93104952017-12-13 17:13:15 -08002091 if (owner_tid != ThreadList::kInvalidThreadId) {
2092 os << " held by thread " << owner_tid;
2093 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002094 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002095 }
2096
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002097 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002098 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002099 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002100 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002101};
2102
Ian Rogers33e95662013-05-20 20:29:14 -07002103static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002104 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002105 ThreadState state = thread->GetState();
2106
2107 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2108 if (state > kWaiting && state < kStarting) {
2109 return true;
2110 }
2111
2112 // In an Object.wait variant or Thread.sleep? That's not interesting.
2113 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2114 return false;
2115 }
2116
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002117 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002118 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002119 return true;
2120 }
2121
Elliott Hughesaef701d2013-04-05 18:15:40 -07002122 // In some other native method? That's interesting.
2123 // We don't just check kNative because native methods will be in state kSuspended if they're
2124 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2125 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002126 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002127 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002128}
2129
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002130void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002131 // If flip_function is not null, it means we have run a checkpoint
2132 // before the thread wakes up to execute the flip function and the
2133 // thread roots haven't been forwarded. So the following access to
2134 // the roots (locks or methods in the frames) would be bad. Run it
2135 // here. TODO: clean up.
2136 {
2137 Thread* this_thread = const_cast<Thread*>(this);
2138 Closure* flip_func = this_thread->GetFlipFunction();
2139 if (flip_func != nullptr) {
2140 flip_func->Run(this_thread);
2141 }
2142 }
2143
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002144 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2145 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002146 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2147 // thread.
Alex Lightb7c640d2019-03-20 15:52:13 -07002148 ScopedExceptionStorage ses(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002149
Ian Rogers700a4022014-05-19 16:49:03 -07002150 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002151 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002152 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002153 dumper.WalkStack();
2154}
2155
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002156void Thread::DumpStack(std::ostream& os,
2157 bool dump_native_stack,
2158 BacktraceMap* backtrace_map,
2159 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002160 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2161 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2162 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002163 bool dump_for_abort = (gAborting > 0);
2164 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2165 if (!kIsDebugBuild) {
2166 // We always want to dump the stack for an abort, however, there is no point dumping another
2167 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2168 safe_to_dump = (safe_to_dump || dump_for_abort);
2169 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002170 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002171 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002172 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002173 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002174 ArtMethod* method =
2175 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002176 /*check_suspended=*/ !force_dump_stack,
2177 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002178 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002179 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002180 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002181 /*check_suspended=*/ !force_dump_stack,
2182 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002183 } else {
2184 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002185 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002186}
2187
Elliott Hughesbe759c62011-09-08 19:38:21 -07002188void Thread::ThreadExitCallback(void* arg) {
2189 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002190 if (self->tls32_.thread_exit_check_count == 0) {
2191 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2192 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002193 CHECK(is_started_);
Andreas Gampea47a6e82019-07-24 09:46:16 -07002194#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002195 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2196#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002197 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe82372002019-07-24 15:42:09 -07002198 Thread::self_tls_ = self;
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002199#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002200 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002201 } else {
2202 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2203 }
Carl Shapirob5573532011-07-12 18:22:59 -07002204}
2205
Elliott Hughesbe759c62011-09-08 19:38:21 -07002206void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002207 CHECK(!is_started_);
2208 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002209 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002210 // MutexLock to keep annotalysis happy.
2211 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002212 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002213 // return garbage since (is_started_ == true) and
2214 // Thread::pthread_key_self_ is not yet initialized.
2215 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002216 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002217 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2218 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002219 }
2220
Carl Shapirob5573532011-07-12 18:22:59 -07002221 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002222 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2223 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002224
2225 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002226 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2227 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002228 }
Andreas Gampe82372002019-07-24 15:42:09 -07002229#ifndef __BIONIC__
2230 CHECK(Thread::self_tls_ == nullptr);
2231#endif
Elliott Hughes038a8062011-09-18 14:12:41 -07002232}
Carl Shapirob5573532011-07-12 18:22:59 -07002233
Elliott Hughes038a8062011-09-18 14:12:41 -07002234void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002235 Runtime* runtime = Runtime::Current();
2236 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002237
Elliott Hughes01158d72011-09-19 19:47:10 -07002238 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002239 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002240 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2241 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002242
Vladimir Markodcfcce42018-06-27 10:00:28 +00002243 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002244
2245 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2246 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002247 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2248 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002249}
2250
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002251void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002252 CHECK(is_started_);
2253 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002254 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002255 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002256 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002257 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002258 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002259 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002260}
2261
Andreas Gampe56776012018-01-26 17:40:55 -08002262void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2263 ScopedLocalRef<jobject> thread_jobject(
2264 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2265 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2266 soa.Env(), nullptr);
2267 jobject thread_group_jobject = thread_group;
2268 if (thread_group == nullptr || kIsDebugBuild) {
2269 // There is always a group set. Retrieve it.
2270 thread_group_jobject_scoped.reset(
2271 soa.Env()->GetObjectField(thread_jobject.get(),
2272 WellKnownClasses::java_lang_Thread_group));
2273 thread_group_jobject = thread_group_jobject_scoped.get();
2274 if (kIsDebugBuild && thread_group != nullptr) {
2275 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2276 }
2277 }
2278 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2279 WellKnownClasses::java_lang_ThreadGroup,
2280 WellKnownClasses::java_lang_ThreadGroup_add,
2281 thread_jobject.get());
2282}
2283
Calin Juravleccd56952016-12-15 17:57:38 +00002284Thread::Thread(bool daemon)
2285 : tls32_(daemon),
2286 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002287 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002288 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002289 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002290 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2291 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2292
Roland Levillain33d69032015-06-18 18:20:59 +01002293 static_assert((sizeof(Thread) % 4) == 0U,
2294 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002295 tls32_.state_and_flags.as_struct.flags = 0;
2296 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002297 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002298 // Initialize with no permit; if the java Thread was unparked before being
2299 // started, it will unpark itself before calling into java code.
2300 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002301 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002302 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002303 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002304 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002305 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002306 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2307 tlsPtr_.active_suspend_barriers[i] = nullptr;
2308 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002309 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002310 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002311 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002312 tls32_.use_mterp = false;
2313}
2314
2315void Thread::NotifyInTheadList() {
2316 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002317}
2318
Alex Lighte9f61032018-09-24 16:04:51 -07002319bool Thread::CanLoadClasses() const {
2320 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2321}
2322
Elliott Hughes7dc51662012-05-16 14:48:43 -07002323bool Thread::IsStillStarting() const {
2324 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002325 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002326 // 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 -07002327 // assigned fairly early on, and needs to be.
2328 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2329 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002330 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2331 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002332}
2333
Andreas Gamped9efea62014-07-21 22:56:08 -07002334void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002335 CHECK(IsExceptionPending()) << "Pending exception expected.";
2336}
2337
2338void Thread::AssertPendingOOMException() const {
2339 AssertPendingException();
2340 auto* e = GetException();
2341 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2342 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002343}
2344
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002345void Thread::AssertNoPendingException() const {
2346 if (UNLIKELY(IsExceptionPending())) {
2347 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002348 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002349 }
2350}
2351
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002352void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2353 if (UNLIKELY(IsExceptionPending())) {
2354 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002355 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002356 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002357 }
2358}
2359
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002360class MonitorExitVisitor : public SingleRootVisitor {
2361 public:
2362 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2363
2364 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2365 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002366 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002367 if (self_->HoldsLock(entered_monitor)) {
2368 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002369 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002370 << " left locked by native thread "
2371 << *Thread::Current() << " which is detaching";
2372 entered_monitor->MonitorExit(self_);
2373 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002374 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002375
2376 private:
2377 Thread* const self_;
2378};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002379
Elliott Hughesc0f09332012-03-26 13:27:06 -07002380void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002381 Thread* self = this;
2382 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002383
Ian Rogers68d8b422014-07-17 11:09:10 -07002384 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002385 {
2386 ScopedObjectAccess soa(self);
2387 MonitorExitVisitor visitor(self);
2388 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002389 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002390 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002391 // Release locally held global references which releasing may require the mutator lock.
2392 if (tlsPtr_.jpeer != nullptr) {
2393 // If pthread_create fails we don't have a jni env here.
2394 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2395 tlsPtr_.jpeer = nullptr;
2396 }
2397 if (tlsPtr_.class_loader_override != nullptr) {
2398 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2399 tlsPtr_.class_loader_override = nullptr;
2400 }
2401 }
2402
Ian Rogersdd7624d2014-03-14 17:43:00 -07002403 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002404 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002405 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002406 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002407 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002408 Runtime* runtime = Runtime::Current();
2409 if (runtime != nullptr) {
2410 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2411 }
Elliott Hughes534da072012-03-27 15:17:42 -07002412
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002413 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002414 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002415 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002416 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002417 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002418 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002419 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002420 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002421
Ian Rogerscfaa4552012-11-26 21:00:08 -08002422 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2423 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002424 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002425 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002426 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002427 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002428 StackHandleScope<1> hs(self);
2429 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002430 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002431 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002432 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002433 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002434 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002435
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002436 {
2437 ScopedObjectAccess soa(self);
2438 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002439 if (kUseReadBarrier) {
2440 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2441 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002442 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002443}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002444
Elliott Hughesc0f09332012-03-26 13:27:06 -07002445Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002446 CHECK(tlsPtr_.class_loader_override == nullptr);
2447 CHECK(tlsPtr_.jpeer == nullptr);
2448 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002449 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002450 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002451 delete tlsPtr_.jni_env;
2452 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002453 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002454 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002455 CHECK(!ReadFlag(kCheckpointRequest));
2456 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002457 CHECK(tlsPtr_.checkpoint_function == nullptr);
2458 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002459 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002460 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002461
Sebastien Hertz07474662015-08-25 15:12:33 +00002462 // Make sure we processed all deoptimization requests.
2463 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002464 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2465 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002466
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002467 // We may be deleting a still born thread.
2468 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002469
2470 delete wait_cond_;
2471 delete wait_mutex_;
2472
Ian Rogersdd7624d2014-03-14 17:43:00 -07002473 if (tlsPtr_.long_jump_context != nullptr) {
2474 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002475 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002476
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002477 if (initialized) {
2478 CleanupCpu();
2479 }
2480
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002481 if (tlsPtr_.single_step_control != nullptr) {
2482 delete tlsPtr_.single_step_control;
2483 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002484 delete tlsPtr_.instrumentation_stack;
2485 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002486 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002487
Ian Rogers68d8b422014-07-17 11:09:10 -07002488 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002489
Elliott Hughesd8af1592012-04-16 20:40:15 -07002490 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002491}
2492
Andreas Gampe513061a2017-06-01 09:17:34 -07002493void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002494 if (!IsExceptionPending()) {
2495 return;
2496 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002497 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002498 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002499
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002500 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002501 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2502 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002503
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002504 // Call the Thread instance's dispatchUncaughtException(Throwable)
2505 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2506 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2507 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002508
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002509 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002510 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002511}
2512
Andreas Gampe513061a2017-06-01 09:17:34 -07002513void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002514 // this.group.removeThread(this);
2515 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002516 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002517 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002518 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002519 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002520 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002521 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002522 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2523 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2524 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002525 }
2526}
2527
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002528bool Thread::HandleScopeContains(jobject obj) const {
2529 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002530 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002531 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002532 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002533 return true;
2534 }
2535 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002536 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2537 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002538}
2539
Hans Boehm0882af22017-08-31 15:21:57 -07002540void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002541 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2542 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002543 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2544 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002545 }
2546}
2547
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002548ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002549 if (obj == nullptr) {
2550 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002551 }
2552 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002553 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002554 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002555 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002556 // The "kinds" below are sorted by the frequency we expect to encounter them.
2557 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002558 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002559 // Local references do not need a read barrier.
2560 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002561 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002562 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002563 // Check if this is a local reference in the handle scope.
2564 if (LIKELY(HandleScopeContains(obj))) {
2565 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002566 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002567 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002568 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002569 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002570 expect_null = true;
2571 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002572 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002573 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002574 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002575 } else {
2576 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002577 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002578 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002579 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002580 expect_null = true;
2581 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002582 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002583 }
2584
Ian Rogersc0542af2014-09-03 16:16:56 -07002585 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002586 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002587 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002588 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002589 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002590}
2591
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002592bool Thread::IsJWeakCleared(jweak obj) const {
2593 CHECK(obj != nullptr);
2594 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002595 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002596 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002597 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002598}
2599
Ian Rogers81d425b2012-09-27 16:03:43 -07002600// Implements java.lang.Thread.interrupted.
2601bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002602 DCHECK_EQ(Thread::Current(), this);
2603 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002604 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002605 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002606 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002607 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002608 return interrupted;
2609}
2610
2611// Implements java.lang.Thread.isInterrupted.
2612bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002613 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002614}
2615
Ian Rogersdd7624d2014-03-14 17:43:00 -07002616void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002617 {
2618 MutexLock mu(self, *wait_mutex_);
2619 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2620 return;
2621 }
2622 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2623 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002624 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002625 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002626}
2627
2628void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002629 Thread* self = Thread::Current();
2630 MutexLock mu(self, *wait_mutex_);
2631 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002632}
2633
Ian Rogersc604d732012-10-14 16:09:54 -07002634void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002635 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002636 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002637 }
2638}
2639
Ian Rogers68d8b422014-07-17 11:09:10 -07002640void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2641 if (tlsPtr_.class_loader_override != nullptr) {
2642 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2643 }
2644 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2645}
2646
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002647using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2648
2649// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2650class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002651 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002652 explicit FetchStackTraceVisitor(Thread* thread,
2653 ArtMethodDexPcPair* saved_frames = nullptr,
2654 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002655 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002656 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002657 saved_frames_(saved_frames),
2658 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002659
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002660 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002661 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002662 // Note we also skip the frame if it doesn't have a method (namely the callee
2663 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002664 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002665 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002666 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002667 skipping_ = false;
2668 }
2669 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002670 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002671 if (depth_ < max_saved_frames_) {
2672 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002673 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002674 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002675 ++depth_;
2676 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002677 } else {
2678 ++skip_depth_;
2679 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002680 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002681 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002682
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002683 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002684 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002685 }
2686
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002687 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002688 return skip_depth_;
2689 }
2690
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002691 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002692 uint32_t depth_ = 0;
2693 uint32_t skip_depth_ = 0;
2694 bool skipping_ = true;
2695 ArtMethodDexPcPair* saved_frames_;
2696 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002697
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002698 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002699};
2700
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002701template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002702class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002703 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002704 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002705 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2706 self_(self),
2707 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002708 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002709
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002710 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002711 // Allocate method trace as an object array where the first element is a pointer array that
2712 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2713 // class of the ArtMethod pointers.
2714 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2715 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002716 ObjPtr<mirror::Class> array_class =
2717 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002718 // The first element is the methods and dex pc array, the other elements are declaring classes
2719 // for the methods to ensure classes in the stack trace don't get unloaded.
2720 Handle<mirror::ObjectArray<mirror::Object>> trace(
2721 hs.NewHandle(
2722 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002723 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002724 // Acquire uninterruptible_ in all paths.
2725 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002726 self_->AssertPendingOOMException();
2727 return false;
2728 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002729 ObjPtr<mirror::PointerArray> methods_and_pcs =
2730 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002731 const char* last_no_suspend_cause =
2732 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2733 if (methods_and_pcs == nullptr) {
2734 self_->AssertPendingOOMException();
2735 return false;
2736 }
2737 trace->Set(0, methods_and_pcs);
2738 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002739 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002740 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002741 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002742 }
2743
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002744 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2745 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002746 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002747
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002748 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002749 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002750 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002751 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002752 if (skip_depth_ > 0) {
2753 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002754 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002755 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002756 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002757 if (m->IsRuntimeMethod()) {
2758 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002759 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002760 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002761 return true;
2762 }
2763
2764 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002765 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002766 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002767 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2768 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002769 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002770 pointer_size_);
2771 // Save the declaring class of the method to ensure that the declaring classes of the methods
2772 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002773 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002774 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002775 }
2776
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002777 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002778 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002779 }
2780
2781 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002782 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002783 }
2784
2785 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002786 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002787 // How many more frames to skip.
2788 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002789 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002790 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002791 // An object array where the first element is a pointer array that contains the ArtMethod
2792 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2793 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2794 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002795 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002796 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002797 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002798
2799 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002800};
2801
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002802template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002803jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002804 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2805 constexpr size_t kMaxSavedFrames = 256;
2806 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2807 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2808 &saved_frames[0],
2809 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002810 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002811 const uint32_t depth = count_visitor.GetDepth();
2812 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002813
Ian Rogers1f539342012-10-03 21:09:42 -07002814 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002815 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2816 const_cast<Thread*>(this),
2817 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002818 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002819 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002820 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002821 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2822 // than doing the stack walk twice.
2823 if (depth < kMaxSavedFrames) {
2824 for (size_t i = 0; i < depth; ++i) {
2825 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2826 }
2827 } else {
2828 build_trace_visitor.WalkStack();
2829 }
2830
Mathieu Chartier910e8272015-09-30 09:24:22 -07002831 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002832 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002833 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002834 // Second half of trace_methods is dex PCs.
2835 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2836 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002837 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2838 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002839 }
2840 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002841 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002842}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002843template jobject Thread::CreateInternalStackTrace<false>(
2844 const ScopedObjectAccessAlreadyRunnable& soa) const;
2845template jobject Thread::CreateInternalStackTrace<true>(
2846 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002847
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002848bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002849 // Only count the depth since we do not pass a stack frame array as an argument.
2850 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002851 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002852 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002853}
2854
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002855static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2856 const ScopedObjectAccessAlreadyRunnable& soa,
2857 ArtMethod* method,
2858 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2859 int32_t line_number;
2860 StackHandleScope<3> hs(soa.Self());
2861 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2862 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2863 if (method->IsProxyMethod()) {
2864 line_number = -1;
2865 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2866 // source_name_object intentionally left null for proxy methods
2867 } else {
2868 line_number = method->GetLineNumFromDexPC(dex_pc);
2869 // Allocate element, potentially triggering GC
2870 // TODO: reuse class_name_object via Class::name_?
2871 const char* descriptor = method->GetDeclaringClassDescriptor();
2872 CHECK(descriptor != nullptr);
2873 std::string class_name(PrettyDescriptor(descriptor));
2874 class_name_object.Assign(
2875 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2876 if (class_name_object == nullptr) {
2877 soa.Self()->AssertPendingOOMException();
2878 return nullptr;
2879 }
2880 const char* source_file = method->GetDeclaringClassSourceFile();
2881 if (line_number == -1) {
2882 // Make the line_number field of StackTraceElement hold the dex pc.
2883 // source_name_object is intentionally left null if we failed to map the dex pc to
2884 // a line number (most probably because there is no debug info). See b/30183883.
2885 line_number = dex_pc;
2886 } else {
2887 if (source_file != nullptr) {
2888 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2889 if (source_name_object == nullptr) {
2890 soa.Self()->AssertPendingOOMException();
2891 return nullptr;
2892 }
2893 }
2894 }
2895 }
2896 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2897 CHECK(method_name != nullptr);
2898 Handle<mirror::String> method_name_object(
2899 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2900 if (method_name_object == nullptr) {
2901 return nullptr;
2902 }
2903 return mirror::StackTraceElement::Alloc(soa.Self(),
2904 class_name_object,
2905 method_name_object,
2906 source_name_object,
2907 line_number);
2908}
2909
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002910jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002911 const ScopedObjectAccessAlreadyRunnable& soa,
2912 jobject internal,
2913 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002914 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002915 // Decode the internal stack trace into the depth, method trace and PC trace.
2916 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002917 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002918 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002919
Mathieu Chartier910e8272015-09-30 09:24:22 -07002920 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002921
Elliott Hughes01158d72011-09-19 19:47:10 -07002922 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002923
Dave Allison0aded082013-11-07 13:15:11 -08002924 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002925 // Reuse the array we were given.
2926 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002927 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002928 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002929 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002930 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002931 } else {
2932 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002933 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002934 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002935 if (java_traces == nullptr) {
2936 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002937 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002938 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002939 }
2940
Dave Allison0aded082013-11-07 13:15:11 -08002941 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002942 *stack_depth = depth;
2943 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002944
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002945 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002946 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002947 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002948 // Methods and dex PC trace is element 0.
2949 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00002950 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002951 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07002952 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002953 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002954 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002955 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00002956 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002957 if (obj == nullptr) {
2958 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002959 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002960 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002961 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002962 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002963 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002964}
2965
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002966jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2967 // This code allocates. Do not allow it to operate with a pending exception.
2968 if (IsExceptionPending()) {
2969 return nullptr;
2970 }
2971
2972 // If flip_function is not null, it means we have run a checkpoint
2973 // before the thread wakes up to execute the flip function and the
2974 // thread roots haven't been forwarded. So the following access to
2975 // the roots (locks or methods in the frames) would be bad. Run it
2976 // here. TODO: clean up.
2977 // Note: copied from DumpJavaStack.
2978 {
2979 Thread* this_thread = const_cast<Thread*>(this);
2980 Closure* flip_func = this_thread->GetFlipFunction();
2981 if (flip_func != nullptr) {
2982 flip_func->Run(this_thread);
2983 }
2984 }
2985
2986 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2987 public:
2988 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2989 Thread* self,
2990 Context* context)
2991 : MonitorObjectsStackVisitor(self, context),
2992 wait_jobject_(soaa_in.Env(), nullptr),
2993 block_jobject_(soaa_in.Env(), nullptr),
2994 soaa_(soaa_in) {}
2995
2996 protected:
2997 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002998 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002999 REQUIRES_SHARED(Locks::mutator_lock_) {
3000 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
3001 soaa_, m, GetDexPc(/* abort on error */ false));
3002 if (obj == nullptr) {
3003 return VisitMethodResult::kEndStackWalk;
3004 }
3005 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
3006 return VisitMethodResult::kContinueMethod;
3007 }
3008
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003009 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003010 lock_objects_.push_back({});
3011 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3012
3013 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3014
3015 return VisitMethodResult::kContinueMethod;
3016 }
3017
Vladimir Markof52d92f2019-03-29 12:33:02 +00003018 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state 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 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3022 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003023 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003024 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003025 REQUIRES_SHARED(Locks::mutator_lock_) {
3026 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3027 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003028 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003029 ThreadState state ATTRIBUTE_UNUSED,
3030 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003031 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003032 REQUIRES_SHARED(Locks::mutator_lock_) {
3033 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3034 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003035 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003036 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003037 REQUIRES_SHARED(Locks::mutator_lock_) {
3038 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3039 }
3040
3041 public:
3042 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3043 ScopedLocalRef<jobject> wait_jobject_;
3044 ScopedLocalRef<jobject> block_jobject_;
3045 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3046
3047 private:
3048 const ScopedObjectAccessAlreadyRunnable& soaa_;
3049
3050 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3051 };
3052
3053 std::unique_ptr<Context> context(Context::Create());
3054 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3055 dumper.WalkStack();
3056
3057 // There should not be a pending exception. Otherwise, return with it pending.
3058 if (IsExceptionPending()) {
3059 return nullptr;
3060 }
3061
3062 // Now go and create Java arrays.
3063
3064 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3065
3066 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003067 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003068 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003069 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3070 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003071 return nullptr;
3072 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003073 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003074
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003075 Handle<mirror::Class> h_o_array_class =
3076 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3077 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003078
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003079
3080 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3081 class_linker->EnsureInitialized(soa.Self(),
3082 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003083 /* can_init_fields= */ true,
3084 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003085 if (soa.Self()->IsExceptionPending()) {
3086 // This should not fail in a healthy runtime.
3087 return nullptr;
3088 }
3089
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003090 ArtField* stack_trace_element_field = h_aste_class->FindField(
3091 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3092 DCHECK(stack_trace_element_field != nullptr);
3093 ArtField* held_locks_field = h_aste_class->FindField(
3094 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3095 DCHECK(held_locks_field != nullptr);
3096 ArtField* blocked_on_field = h_aste_class->FindField(
3097 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3098 DCHECK(blocked_on_field != nullptr);
3099
3100 size_t length = dumper.stack_trace_elements_.size();
3101 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003102 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003103 if (array == nullptr) {
3104 soa.Self()->AssertPendingOOMException();
3105 return nullptr;
3106 }
3107
3108 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3109
3110 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3111 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3112 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3113 for (size_t i = 0; i != length; ++i) {
3114 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3115 if (handle == nullptr) {
3116 soa.Self()->AssertPendingOOMException();
3117 return nullptr;
3118 }
3119
3120 // Set stack trace element.
3121 stack_trace_element_field->SetObject<false>(
3122 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3123
3124 // Create locked-on array.
3125 if (!dumper.lock_objects_[i].empty()) {
3126 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3127 h_o_array_class.Get(),
3128 dumper.lock_objects_[i].size()));
3129 if (handle2 == nullptr) {
3130 soa.Self()->AssertPendingOOMException();
3131 return nullptr;
3132 }
3133 int32_t j = 0;
3134 for (auto& scoped_local : dumper.lock_objects_[i]) {
3135 if (scoped_local == nullptr) {
3136 continue;
3137 }
3138 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3139 DCHECK(!soa.Self()->IsExceptionPending());
3140 j++;
3141 }
3142 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3143 }
3144
3145 // Set blocked-on object.
3146 if (i == 0) {
3147 if (dumper.block_jobject_ != nullptr) {
3148 blocked_on_field->SetObject<false>(
3149 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3150 }
3151 }
3152
3153 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3154 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3155 DCHECK(!soa.Self()->IsExceptionPending());
3156 }
3157
3158 return result.release();
3159}
3160
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003161void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003162 va_list args;
3163 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003164 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003165 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003166}
3167
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003168void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003169 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003170 std::string msg;
3171 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003172 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003173}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003174
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003175void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003176 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003177 // Callers should either clear or call ThrowNewWrappedException.
3178 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003179 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003180}
3181
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003182static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003183 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003184 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003185 return method != nullptr
3186 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003187 : nullptr;
3188}
3189
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003190void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003191 const char* msg) {
3192 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003193 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003194 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003195 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003196 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003197 ClearException();
3198 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003199 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003200 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003201 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003202 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003203 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003204 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003205 return;
3206 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003207
Ian Rogers7b078e82014-09-10 14:44:24 -07003208 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3209 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003210 DCHECK(IsExceptionPending());
3211 return;
3212 }
3213 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003214 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003215 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003216
Mathieu Chartier590fee92013-09-13 13:46:47 -07003217 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003218 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003219 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3220 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003221 return;
3222 }
3223
Ian Rogers62d6c772013-02-27 08:32:07 -08003224 // Choose an appropriate constructor and set up the arguments.
3225 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003226 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003227 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003228 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003229 msg_string.reset(
3230 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003231 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003232 CHECK(IsExceptionPending()); // OOME.
3233 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003234 }
Dave Allison0aded082013-11-07 13:15:11 -08003235 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003236 signature = "(Ljava/lang/String;)V";
3237 } else {
3238 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3239 }
3240 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003241 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003242 signature = "()V";
3243 } else {
3244 signature = "(Ljava/lang/Throwable;)V";
3245 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003246 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003247 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003248 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003249
Dave Allison0aded082013-11-07 13:15:11 -08003250 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003251 << PrettyDescriptor(exception_class_descriptor);
3252
3253 if (UNLIKELY(!runtime->IsStarted())) {
3254 // Something is trying to throw an exception without a started runtime, which is the common
3255 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3256 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003257 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003258 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003259 }
Dave Allison0aded082013-11-07 13:15:11 -08003260 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003261 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003262 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003263 ScopedLocalRef<jobject> trace(GetJniEnv(),
3264 Runtime::Current()->IsActiveTransaction()
3265 ? CreateInternalStackTrace<true>(soa)
3266 : CreateInternalStackTrace<false>(soa));
3267 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003268 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003269 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003270 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003271 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003272 jvalue jv_args[2];
3273 size_t i = 0;
3274
Dave Allison0aded082013-11-07 13:15:11 -08003275 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003276 jv_args[i].l = msg_string.get();
3277 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003278 }
Dave Allison0aded082013-11-07 13:15:11 -08003279 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003280 jv_args[i].l = cause.get();
3281 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003282 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003283 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Alex Light01fbfbe2019-06-27 10:47:04 -07003284 InvokeWithJValues(soa, ref.get(), exception_init_method, jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003285 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003286 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003287 }
Elliott Hughes30646832011-10-13 16:59:46 -07003288 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003289}
3290
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003291void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003292 LOG(WARNING) << "Throwing OutOfMemoryError "
3293 << '"' << msg << '"'
3294 << " (VmSize " << GetProcessStatus("VmSize")
3295 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003296 if (!tls32_.throwing_OutOfMemoryError) {
3297 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003298 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003299 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003300 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003301 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003302 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003303 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003304}
3305
Elliott Hughes498508c2011-10-17 14:58:22 -07003306Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003307 return Thread::Current();
3308}
3309
3310void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003311 std::ostringstream ss;
3312 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003313 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003314 // log to stderr for debugging command line processes
3315 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003316#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003317 // log to logcat for debugging frameworks processes
3318 LOG(INFO) << str;
3319#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003320}
3321
Ian Rogersdd7624d2014-03-14 17:43:00 -07003322// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003323template
3324void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3325template
3326void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003327
Andreas Gampe542451c2016-07-26 09:02:02 -07003328template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003329void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3330#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003331 if (offset == (x).Uint32Value()) { \
3332 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003333 return; \
3334 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003335 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3336 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3337 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3338 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3339 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3340 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3341 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3342 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003343 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003344 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003345 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003346 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003347 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003348#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003349
Ian Rogersdd7624d2014-03-14 17:43:00 -07003350#define JNI_ENTRY_POINT_INFO(x) \
3351 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3352 os << #x; \
3353 return; \
3354 }
3355 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3356#undef JNI_ENTRY_POINT_INFO
3357
Ian Rogersdd7624d2014-03-14 17:43:00 -07003358#define QUICK_ENTRY_POINT_INFO(x) \
3359 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3360 os << #x; \
3361 return; \
3362 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003363 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003364 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3365 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3366 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3367 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003368 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3369 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003370 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003371 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003372 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3373 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3374 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003375 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003376 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003377 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003378 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3379 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003380 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003381 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3382 QUICK_ENTRY_POINT_INFO(pSet8Static)
3383 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3384 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003385 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3386 QUICK_ENTRY_POINT_INFO(pSet32Static)
3387 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3388 QUICK_ENTRY_POINT_INFO(pSet64Static)
3389 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3390 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003391 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3392 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3393 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3394 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3395 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3396 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3397 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3398 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003399 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3400 QUICK_ENTRY_POINT_INFO(pGet32Static)
3401 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3402 QUICK_ENTRY_POINT_INFO(pGet64Static)
3403 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3404 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003405 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003406 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3407 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3408 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3409 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3410 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3411 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3412 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3413 QUICK_ENTRY_POINT_INFO(pLockObject)
3414 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3415 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3416 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3417 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3418 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003419 QUICK_ENTRY_POINT_INFO(pCos)
3420 QUICK_ENTRY_POINT_INFO(pSin)
3421 QUICK_ENTRY_POINT_INFO(pAcos)
3422 QUICK_ENTRY_POINT_INFO(pAsin)
3423 QUICK_ENTRY_POINT_INFO(pAtan)
3424 QUICK_ENTRY_POINT_INFO(pAtan2)
3425 QUICK_ENTRY_POINT_INFO(pCbrt)
3426 QUICK_ENTRY_POINT_INFO(pCosh)
3427 QUICK_ENTRY_POINT_INFO(pExp)
3428 QUICK_ENTRY_POINT_INFO(pExpm1)
3429 QUICK_ENTRY_POINT_INFO(pHypot)
3430 QUICK_ENTRY_POINT_INFO(pLog)
3431 QUICK_ENTRY_POINT_INFO(pLog10)
3432 QUICK_ENTRY_POINT_INFO(pNextAfter)
3433 QUICK_ENTRY_POINT_INFO(pSinh)
3434 QUICK_ENTRY_POINT_INFO(pTan)
3435 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003436 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003437 QUICK_ENTRY_POINT_INFO(pL2d)
3438 QUICK_ENTRY_POINT_INFO(pFmodf)
3439 QUICK_ENTRY_POINT_INFO(pL2f)
3440 QUICK_ENTRY_POINT_INFO(pD2iz)
3441 QUICK_ENTRY_POINT_INFO(pF2iz)
3442 QUICK_ENTRY_POINT_INFO(pIdivmod)
3443 QUICK_ENTRY_POINT_INFO(pD2l)
3444 QUICK_ENTRY_POINT_INFO(pF2l)
3445 QUICK_ENTRY_POINT_INFO(pLdiv)
3446 QUICK_ENTRY_POINT_INFO(pLmod)
3447 QUICK_ENTRY_POINT_INFO(pLmul)
3448 QUICK_ENTRY_POINT_INFO(pShlLong)
3449 QUICK_ENTRY_POINT_INFO(pShrLong)
3450 QUICK_ENTRY_POINT_INFO(pUshrLong)
3451 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003452 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3453 QUICK_ENTRY_POINT_INFO(pMemcpy)
3454 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3455 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3456 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3457 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3458 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3459 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3460 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3461 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003462 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003463 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3464 QUICK_ENTRY_POINT_INFO(pDeliverException)
3465 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3466 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003467 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3468 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003469 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003470 QUICK_ENTRY_POINT_INFO(pA64Load)
3471 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003472 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3473 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3474 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3475 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3476 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3477 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3478 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3479 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3480 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3481 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3482 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3483 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3484 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3485 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3486 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3487 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003488 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003489 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3490 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3491 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3492 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3493 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3494 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3495 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3496 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3497 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3498 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3499 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3500 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3501 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3502 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3503 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3504 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3505 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3506 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3507 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3508 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3509 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3510 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3511 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3512 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3513 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3514 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3515 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3516 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3517 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3518 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003519 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003520 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003521
3522 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3523 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003524#undef QUICK_ENTRY_POINT_INFO
3525
Elliott Hughes98e20172012-04-24 15:38:13 -07003526 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003527}
3528
jeffhao94d6df42012-11-26 16:02:12 -08003529void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003530 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003531 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003532 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003533 if (exception == GetDeoptimizationException()) {
3534 artDeoptimize(this);
3535 UNREACHABLE();
3536 }
3537
Roland Levillaina78f5b62017-09-29 13:50:44 +01003538 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003539
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003540 // This is a real exception: let the instrumentation know about it.
3541 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003542 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003543 IsExceptionThrownByCurrentMethod(exception)) {
3544 // Instrumentation may cause GC so keep the exception object safe.
3545 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003546 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Vladimir Marko19711d42019-04-12 14:05:34 +01003547 instrumentation->ExceptionThrownEvent(this, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003548 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003549 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3550 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3551 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3552 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003553 //
3554 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3555 // expected to happen fairly regularly but the second can only happen if we are using
3556 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3557 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003558 ShadowFrame* cf;
David Srbecky1cbac5c2019-07-18 20:05:32 +01003559 bool force_deopt = false;
3560 if (Runtime::Current()->AreNonStandardExitsEnabled() || kIsDebugBuild) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003561 NthCallerVisitor visitor(this, 0, false);
3562 visitor.WalkStack();
3563 cf = visitor.GetCurrentShadowFrame();
3564 if (cf == nullptr) {
3565 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3566 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003567 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3568 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003569 if (kIsDebugBuild && force_frame_pop) {
David Srbecky1cbac5c2019-07-18 20:05:32 +01003570 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
Alex Light0aa7a5a2018-10-10 15:58:14 +00003571 NthCallerVisitor penultimate_visitor(this, 1, false);
3572 penultimate_visitor.WalkStack();
3573 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3574 if (penultimate_frame == nullptr) {
3575 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3576 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003577 }
David Srbecky1cbac5c2019-07-18 20:05:32 +01003578 if (force_retry_instr) {
3579 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3580 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003581 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003582 }
Alex Light3dacdd62019-03-12 15:45:47 +00003583 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003584 NthCallerVisitor visitor(this, 0, false);
3585 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003586 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003587 // method_type shouldn't matter due to exception handling.
3588 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003589 // Save the exception into the deoptimization context so it can be restored
3590 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003591 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003592 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3593 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3594 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003595 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3596 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003597 ClearException();
3598 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003599 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003600 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003601 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003602 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003603 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003604 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003605 artDeoptimize(this);
3606 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003607 } else {
3608 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3609 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003610 }
3611 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003612
Ian Rogers28ad40d2011-10-27 15:19:26 -07003613 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003614 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003615 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003616 QuickExceptionHandler exception_handler(this, false);
3617 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003618 if (exception_handler.GetClearException()) {
3619 // Exception was cleared as part of delivery.
3620 DCHECK(!IsExceptionPending());
3621 } else {
3622 // Exception was put back with a throw location.
3623 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003624 // Check the to-space invariant on the re-installed exception (if applicable).
3625 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003626 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003627 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003628}
3629
Ian Rogersbdb03912011-09-14 00:55:44 -07003630Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003631 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003632 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003633 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003634 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003635 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003636 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003637 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003638 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003639}
3640
Andreas Gampec7d878d2018-11-19 18:42:06 +00003641ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003642 bool check_suspended,
3643 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003644 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3645 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3646 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003647 ArtMethod* method = nullptr;
3648 uint32_t dex_pc = dex::kDexNoIndex;
3649 StackVisitor::WalkStack(
3650 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3651 ArtMethod* m = visitor->GetMethod();
3652 if (m->IsRuntimeMethod()) {
3653 // Continue if this is a runtime method.
3654 return true;
3655 }
3656 method = m;
3657 dex_pc = visitor->GetDexPc(abort_on_error);
3658 return false;
3659 },
3660 const_cast<Thread*>(this),
3661 /* context= */ nullptr,
3662 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3663 check_suspended);
3664
3665 if (dex_pc_out != nullptr) {
3666 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003667 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003668 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003669}
3670
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003671bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3672 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003673}
3674
Roland Levillainad0777d2018-02-12 20:00:18 +00003675extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003676 REQUIRES_SHARED(Locks::mutator_lock_);
3677
Ian Rogers40e3bac2012-11-20 00:09:14 -08003678// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003679template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003680class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003681 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003682 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003683 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003684 // We are visiting the references in compiled frames, so we do not need
3685 // to know the inlined frames.
3686 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3687 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003688
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003689 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003690 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003691 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003692 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003693 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003694 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003695 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003696 VisitShadowFrame(shadow_frame);
3697 } else {
3698 VisitQuickFrame();
3699 }
3700 return true;
3701 }
3702
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003703 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003704 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003705 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003706 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003707 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003708 // handle scope for JNI or References for interpreter.
3709 for (size_t reg = 0; reg < num_regs; ++reg) {
3710 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3711 if (ref != nullptr) {
3712 mirror::Object* new_ref = ref;
3713 visitor_(&new_ref, reg, this);
3714 if (new_ref != ref) {
3715 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003716 }
3717 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003718 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003719 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003720 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003721 }
3722
3723 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003724 // 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 -07003725 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3726 // the threads do not all hold the heap bitmap lock for parallel GC.
3727 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003728 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003729 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003730 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003731 // klass can be null for runtime methods.
3732 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003733 if (kVerifyImageObjectsMarked) {
3734 gc::Heap* const heap = Runtime::Current()->GetHeap();
3735 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003736 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003737 if (space != nullptr && space->IsImageSpace()) {
3738 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003739 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003740 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003741 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003742 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003743 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003744 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003745 }
3746 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003747 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3748 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3749 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003750 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003751 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003752 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3753 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003754 }
3755 }
3756 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003757 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003758 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003759 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003760 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003761 }
3762 }
3763 }
3764
Andreas Gampe585da952016-12-02 14:52:29 -08003765 template <typename T>
3766 ALWAYS_INLINE
3767 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003768 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003769 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003770 ArtMethod* m = *cur_quick_frame;
3771 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003772
Sebastien Hertz714f1752014-04-28 15:03:08 +02003773 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003774 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003775 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003776 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003777 StackReference<mirror::Object>* vreg_base =
3778 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003779 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbecky0d4567f2019-05-30 22:45:40 +01003780 CodeInfo code_info = kPrecise
3781 ? CodeInfo(method_header) // We will need dex register maps.
3782 : CodeInfo::DecodeGcMasksOnly(method_header);
David Srbecky052f8ca2018-04-26 15:42:54 +01003783 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003784 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003785
David Srbecky052f8ca2018-04-26 15:42:54 +01003786 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003787
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003788 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003789 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003790 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003791 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003792 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003793 mirror::Object* ref = ref_addr->AsMirrorPtr();
3794 if (ref != nullptr) {
3795 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003796 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003797 if (ref != new_ref) {
3798 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003799 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003800 }
3801 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003802 }
3803 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003804 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003805 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3806 if (register_mask & (1 << i)) {
3807 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003808 if (kIsDebugBuild && ref_addr == nullptr) {
3809 std::string thread_name;
3810 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003811 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003812 DescribeStack(GetThread());
3813 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3814 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3815 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003816 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003817 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003818 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003819 }
3820 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003821 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3822 // If this is a proxy method, visit its reference arguments.
3823 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003824 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003825 std::vector<StackReference<mirror::Object>*> ref_addrs =
3826 GetProxyReferenceArguments(cur_quick_frame);
3827 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3828 mirror::Object* ref = ref_addr->AsMirrorPtr();
3829 if (ref != nullptr) {
3830 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003831 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003832 if (ref != new_ref) {
3833 ref_addr->Assign(new_ref);
3834 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003835 }
3836 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003837 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003838 }
3839
Andreas Gampe585da952016-12-02 14:52:29 -08003840 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3841 if (kPrecise) {
3842 VisitQuickFramePrecise();
3843 } else {
3844 VisitQuickFrameNonPrecise();
3845 }
3846 }
3847
3848 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3849 struct UndefinedVRegInfo {
3850 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3851 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003852 const StackMap& map ATTRIBUTE_UNUSED,
3853 RootVisitor& _visitor)
3854 : visitor(_visitor) {
3855 }
3856
3857 ALWAYS_INLINE
3858 void VisitStack(mirror::Object** ref,
3859 size_t stack_index ATTRIBUTE_UNUSED,
3860 const StackVisitor* stack_visitor)
3861 REQUIRES_SHARED(Locks::mutator_lock_) {
3862 visitor(ref, -1, stack_visitor);
3863 }
3864
3865 ALWAYS_INLINE
3866 void VisitRegister(mirror::Object** ref,
3867 size_t register_index ATTRIBUTE_UNUSED,
3868 const StackVisitor* stack_visitor)
3869 REQUIRES_SHARED(Locks::mutator_lock_) {
3870 visitor(ref, -1, stack_visitor);
3871 }
3872
3873 RootVisitor& visitor;
3874 };
3875 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3876 }
3877
3878 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3879 struct StackMapVRegInfo {
3880 StackMapVRegInfo(ArtMethod* method,
3881 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003882 const StackMap& map,
3883 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003884 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003885 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003886 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003887 visitor(_visitor) {
Artem Serov2808be82018-12-20 19:15:11 +00003888 DCHECK_EQ(dex_register_map.size(), number_of_dex_registers);
Andreas Gampe585da952016-12-02 14:52:29 -08003889 }
3890
3891 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3892 // lookups for each location.
3893 void FindWithType(const size_t index,
3894 const DexRegisterLocation::Kind kind,
3895 mirror::Object** ref,
3896 const StackVisitor* stack_visitor)
3897 REQUIRES_SHARED(Locks::mutator_lock_) {
3898 bool found = false;
3899 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003900 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003901 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3902 visitor(ref, dex_reg, stack_visitor);
3903 found = true;
3904 }
3905 }
3906
3907 if (!found) {
3908 // If nothing found, report with -1.
3909 visitor(ref, -1, stack_visitor);
3910 }
3911 }
3912
3913 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3914 REQUIRES_SHARED(Locks::mutator_lock_) {
3915 const size_t stack_offset = stack_index * kFrameSlotSize;
3916 FindWithType(stack_offset,
3917 DexRegisterLocation::Kind::kInStack,
3918 ref,
3919 stack_visitor);
3920 }
3921
3922 void VisitRegister(mirror::Object** ref,
3923 size_t register_index,
3924 const StackVisitor* stack_visitor)
3925 REQUIRES_SHARED(Locks::mutator_lock_) {
3926 FindWithType(register_index,
3927 DexRegisterLocation::Kind::kInRegister,
3928 ref,
3929 stack_visitor);
3930 }
3931
3932 size_t number_of_dex_registers;
3933 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003934 DexRegisterMap dex_register_map;
3935 RootVisitor& visitor;
3936 };
3937 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3938 }
3939
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003940 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003941 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003942};
3943
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003944class RootCallbackVisitor {
3945 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003946 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003947
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003948 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003949 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003950 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003951 }
3952
3953 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003954 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003955 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003956};
3957
Andreas Gampe585da952016-12-02 14:52:29 -08003958template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003959void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003960 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003961 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003962 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003963 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003964 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003965 }
Alex Light848574c2017-09-25 16:59:39 -07003966 if (tlsPtr_.async_exception != nullptr) {
3967 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3968 RootInfo(kRootNativeStack, thread_id));
3969 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003970 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003971 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3972 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003973 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003974 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003975 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003976 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003977 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003978 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003979 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003980 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003981 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3982 record != nullptr;
3983 record = record->GetLink()) {
3984 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3985 shadow_frame != nullptr;
3986 shadow_frame = shadow_frame->GetLink()) {
3987 mapper.VisitShadowFrame(shadow_frame);
3988 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003989 }
3990 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003991 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3992 record != nullptr;
3993 record = record->GetLink()) {
3994 if (record->IsReference()) {
3995 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003996 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003997 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003998 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3999 RootInfo(kRootThreadObject, thread_id));
4000 }
4001 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
4002 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004003 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07004004 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
4005 record != nullptr;
4006 record = record->GetNext()) {
4007 mapper.VisitShadowFrame(record->GetShadowFrame());
4008 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004009 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004010 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
4011 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004012 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004013 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004014 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004015 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004016 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004017 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07004018 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004019 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004020 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004021}
4022
Andreas Gampe585da952016-12-02 14:52:29 -08004023void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4024 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004025 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004026 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004027 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004028 }
4029}
4030
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004031class VerifyRootVisitor : public SingleRootVisitor {
4032 public:
4033 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004034 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004035 VerifyObject(root);
4036 }
4037};
jeffhao25045522012-03-13 19:34:37 -07004038
Ian Rogers04d7aa92013-03-16 14:29:17 -07004039void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004040 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4041 VerifyRootVisitor visitor;
4042 std::unique_ptr<Context> context(Context::Create());
4043 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4044 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4045 mapper.WalkStack();
4046 }
jeffhao25045522012-03-13 19:34:37 -07004047}
jeffhao25045522012-03-13 19:34:37 -07004048
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004049// Set the stack end to that to be used during a stack overflow
4050void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004051 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004052 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004053 // However, we seem to have already extended to use the full stack.
4054 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004055 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004056 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004057 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004058 }
4059
Ian Rogersdd7624d2014-03-14 17:43:00 -07004060 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004061
4062 // Remove the stack overflow protection if is it set up.
4063 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4064 if (implicit_stack_check) {
4065 if (!UnprotectStack()) {
4066 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4067 }
4068 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004069}
4070
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004071void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004072 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004073 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004074 tlsPtr_.thread_local_start = start;
4075 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4076 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004077 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004078 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004079}
4080
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004081bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004082 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004083 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004084 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004085 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004086 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004087 }
4088 return has_tlab;
4089}
4090
Elliott Hughes330304d2011-08-12 14:28:05 -07004091std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004092 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004093 return os;
4094}
4095
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004096bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004097 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4098 VLOG(threads) << "Protecting stack at " << pregion;
4099 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004100 if (fatal_on_error) {
4101 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4102 "Reason: "
4103 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4104 }
4105 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004106 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004107 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004108}
4109
4110bool Thread::UnprotectStack() {
4111 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4112 VLOG(threads) << "Unprotecting stack at " << pregion;
4113 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4114}
4115
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004116void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4117 CHECK(Dbg::IsDebuggerActive());
4118 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4119 CHECK(ssc != nullptr);
4120 tlsPtr_.single_step_control = ssc;
4121}
4122
4123void Thread::DeactivateSingleStepControl() {
4124 CHECK(Dbg::IsDebuggerActive());
4125 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4126 SingleStepControl* ssc = GetSingleStepControl();
4127 tlsPtr_.single_step_control = nullptr;
4128 delete ssc;
4129}
Dave Allison648d7112014-07-25 16:15:27 -07004130
Sebastien Hertz1558b572015-02-25 15:05:59 +01004131void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4132 CHECK(Dbg::IsDebuggerActive());
4133 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4134 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4135 CHECK(req != nullptr);
4136 tlsPtr_.debug_invoke_req = req;
4137}
4138
4139void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004140 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4141 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004142 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004143 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004144 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004145}
4146
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004147void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4148 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004149 tlsPtr_.method_verifier = verifier;
4150}
4151
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004152void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004153 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004154 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004155}
4156
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004157size_t Thread::NumberOfHeldMutexes() const {
4158 size_t count = 0;
4159 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004160 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004161 }
4162 return count;
4163}
4164
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004165void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4166 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4167 ClearException();
4168 ShadowFrame* shadow_frame =
4169 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004170 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004171 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004172 DeoptimizationMethodType method_type;
4173 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004174 SetTopOfStack(nullptr);
4175 SetTopOfShadowStack(shadow_frame);
4176
4177 // Restore the exception that was pending before deoptimization then interpret the
4178 // deoptimized frames.
4179 if (pending_exception != nullptr) {
4180 SetException(pending_exception);
4181 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004182 interpreter::EnterInterpreterFromDeoptimize(this,
4183 shadow_frame,
4184 result,
4185 from_code,
4186 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004187}
4188
Alex Light848574c2017-09-25 16:59:39 -07004189void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4190 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004191 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004192 if (kIsDebugBuild) {
4193 // Make sure we are in a checkpoint.
4194 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4195 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4196 << "It doesn't look like this was called in a checkpoint! this: "
4197 << this << " count: " << GetSuspendCount();
4198 }
4199 tlsPtr_.async_exception = new_exception.Ptr();
4200}
4201
4202bool Thread::ObserveAsyncException() {
4203 DCHECK(this == Thread::Current());
4204 if (tlsPtr_.async_exception != nullptr) {
4205 if (tlsPtr_.exception != nullptr) {
4206 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4207 << tlsPtr_.exception->Dump();
4208 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4209 }
4210 tlsPtr_.exception = tlsPtr_.async_exception;
4211 tlsPtr_.async_exception = nullptr;
4212 return true;
4213 } else {
4214 return IsExceptionPending();
4215 }
4216}
4217
Mathieu Chartier0795f232016-09-27 18:43:30 -07004218void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004219 CHECK(new_exception != nullptr);
4220 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004221 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004222}
4223
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004224bool Thread::IsAotCompiler() {
4225 return Runtime::Current()->IsAotCompiler();
4226}
4227
Andreas Gampe202f85a2017-02-06 10:23:26 -08004228mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004229 DCHECK(tlsPtr_.jpeer == nullptr);
4230 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004231 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4232 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4233 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4234 // mark/forward it here.
4235 peer = art::ReadBarrier::Mark(peer);
4236 }
4237 return peer;
4238}
4239
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004240void Thread::SetReadBarrierEntrypoints() {
4241 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004242 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004243}
4244
David Srbecky912f36c2018-09-08 12:22:58 +01004245void Thread::ClearAllInterpreterCaches() {
4246 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004247 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004248 thread->GetInterpreterCache()->Clear(thread);
4249 }
4250 } closure;
4251 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4252}
4253
Orion Hodson119733d2019-01-30 15:14:41 +00004254
Andreas Gampee5d23982019-01-08 10:34:26 -08004255void Thread::ReleaseLongJumpContextInternal() {
4256 // Each QuickExceptionHandler gets a long jump context and uses
4257 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4258 // Both finding catch blocks and deoptimization can trigger another
4259 // exception such as a result of class loading. So there can be nested
4260 // cases of exception handling and multiple contexts being used.
4261 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4262 // for reuse so there is no need to always allocate a new one each time when
4263 // getting a context. Since we only keep one context for reuse, delete the
4264 // existing one since the passed in context is yet to be used for longjump.
4265 delete tlsPtr_.long_jump_context;
4266}
4267
Orion Hodson119733d2019-01-30 15:14:41 +00004268void Thread::SetNativePriority(int new_priority) {
4269 // ART tests on JVM can reach this code path, use tid = 0 as shorthand for current thread.
4270 PaletteStatus status = PaletteSchedSetPriority(0, new_priority);
4271 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4272}
4273
4274int Thread::GetNativePriority() {
4275 int priority = 0;
4276 // ART tests on JVM can reach this code path, use tid = 0 as shorthand for current thread.
4277 PaletteStatus status = PaletteSchedGetPriority(0, &priority);
4278 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4279 return priority;
4280}
4281
Alex Lighte0b2ce42019-02-21 19:23:42 +00004282bool Thread::IsSystemDaemon() const {
4283 if (GetPeer() == nullptr) {
4284 return false;
4285 }
4286 return jni::DecodeArtField(
4287 WellKnownClasses::java_lang_Thread_systemDaemon)->GetBoolean(GetPeer());
4288}
4289
Alex Lightb7c640d2019-03-20 15:52:13 -07004290ScopedExceptionStorage::ScopedExceptionStorage(art::Thread* self)
4291 : self_(self), hs_(self_), excp_(hs_.NewHandle<art::mirror::Throwable>(self_->GetException())) {
4292 self_->ClearException();
4293}
4294
Alex Light79d6c802019-06-27 15:50:11 +00004295void ScopedExceptionStorage::SuppressOldException(const char* message) {
4296 CHECK(self_->IsExceptionPending()) << *self_;
4297 ObjPtr<mirror::Throwable> old_suppressed(excp_.Get());
4298 excp_.Assign(self_->GetException());
4299 LOG(WARNING) << message << "Suppressing old exception: " << old_suppressed->Dump();
4300 self_->ClearException();
4301}
4302
Alex Lightb7c640d2019-03-20 15:52:13 -07004303ScopedExceptionStorage::~ScopedExceptionStorage() {
Alex Light79d6c802019-06-27 15:50:11 +00004304 CHECK(!self_->IsExceptionPending()) << *self_;
Alex Lightb7c640d2019-03-20 15:52:13 -07004305 if (!excp_.IsNull()) {
4306 self_->SetException(excp_.Get());
4307 }
4308}
4309
Elliott Hughes8daa0922011-09-11 13:46:25 -07004310} // namespace art