blob: 088f9978551dfb70f7ca4abdc7d59eaa7a2fbd88 [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 }
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01001842 } else if (thread != nullptr) {
1843 priority = thread->GetNativePriority();
Elliott Hughesd369bb72011-09-12 14:41:14 -07001844 } else {
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01001845 PaletteStatus status = PaletteSchedGetPriority(tid, &priority);
1846 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
Elliott Hughesdcc24742011-09-07 14:02:44 -07001847 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001848
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001849 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001850 if (scheduler_group_name.empty()) {
1851 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001852 }
1853
Dave Allison0aded082013-11-07 13:15:11 -08001854 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001855 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001856 if (is_daemon) {
1857 os << " daemon";
1858 }
1859 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001860 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001861 << " " << thread->GetState();
1862 if (thread->IsStillStarting()) {
1863 os << " (still starting up)";
1864 }
1865 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001866 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001867 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001868 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001869 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001870 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001871
Dave Allison0aded082013-11-07 13:15:11 -08001872 if (thread != nullptr) {
Andreas Gampe7d42cdd2019-05-31 16:54:46 -07001873 auto suspend_log_fn = [&]() REQUIRES(Locks::thread_suspend_count_lock_) {
1874 os << " | group=\"" << group_name << "\""
1875 << " sCount=" << thread->tls32_.suspend_count
1876 << " dsCount=" << thread->tls32_.debug_suspend_count
1877 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
1878 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
1879 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1880 };
1881 if (Locks::thread_suspend_count_lock_->IsExclusiveHeld(self)) {
1882 Locks::thread_suspend_count_lock_->AssertExclusiveHeld(self); // For annotalysis.
1883 suspend_log_fn();
1884 } else {
1885 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1886 suspend_log_fn();
1887 }
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001888 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001889
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001890 os << " | sysTid=" << tid
1891 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001892 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001893 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001894 int policy;
1895 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001896#if !defined(__APPLE__)
1897 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1898 policy = sched_getscheduler(tid);
1899 if (policy == -1) {
1900 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1901 }
1902 int sched_getparam_result = sched_getparam(tid, &sp);
1903 if (sched_getparam_result == -1) {
1904 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1905 sp.sched_priority = -1;
1906 }
1907#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001908 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1909 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001910#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001911 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001912 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001913 }
1914 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001915
1916 // Grab the scheduler stats for this thread.
1917 std::string scheduler_stats;
Andreas Gampe43e72432019-05-14 16:15:24 -07001918 if (android::base::ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid),
1919 &scheduler_stats)
Evan Chengd57c51e2018-01-26 15:43:08 +08001920 && !scheduler_stats.empty()) {
1921 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001922 } else {
1923 scheduler_stats = "0 0 0";
1924 }
1925
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001926 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001927 int utime = 0;
1928 int stime = 0;
1929 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001930 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001931
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001932 os << " | state=" << native_thread_state
1933 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001934 << " utm=" << utime
1935 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001936 << " core=" << task_cpu
1937 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001938 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001939 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1940 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1941 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001942 // Dump the held mutexes.
1943 os << " | held mutexes=";
1944 for (size_t i = 0; i < kLockLevelCount; ++i) {
1945 if (i != kMonitorLock) {
1946 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1947 if (mutex != nullptr) {
1948 os << " \"" << mutex->GetName() << "\"";
1949 if (mutex->IsReaderWriterMutex()) {
1950 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001951 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001952 os << "(exclusive held)";
1953 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001954 os << "(shared held)";
1955 }
1956 }
1957 }
1958 }
1959 }
1960 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001961 }
1962}
1963
1964void Thread::DumpState(std::ostream& os) const {
1965 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001966}
1967
Andreas Gampe93104952017-12-13 17:13:15 -08001968struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001969 StackDumpVisitor(std::ostream& os_in,
1970 Thread* thread_in,
1971 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001972 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001973 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001974 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001975 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001976 : MonitorObjectsStackVisitor(thread_in,
1977 context,
1978 check_suspended,
1979 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001980 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001981 last_method(nullptr),
1982 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001983 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001984
Ian Rogersbdb03912011-09-14 00:55:44 -07001985 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001986 if (frame_count == 0) {
1987 os << " (no managed stack frames)\n";
1988 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001989 }
1990
Andreas Gampe93104952017-12-13 17:13:15 -08001991 static constexpr size_t kMaxRepetition = 3u;
1992
1993 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001994 override
Andreas Gampe93104952017-12-13 17:13:15 -08001995 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001996 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001997 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001998 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001999 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07002000 const DexFile* dex_file = dex_cache->GetDexFile();
2001 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08002002 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07002003 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08002004 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002005 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07002006 if (repetition_count >= kMaxRepetition) {
2007 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
2008 }
2009 repetition_count = 0;
2010 last_line_number = line_number;
2011 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002012 }
Andreas Gampe93104952017-12-13 17:13:15 -08002013
2014 if (repetition_count >= kMaxRepetition) {
2015 // Skip visiting=printing anything.
2016 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002017 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07002018
Andreas Gampe93104952017-12-13 17:13:15 -08002019 os << " at " << m->PrettyMethod(false);
2020 if (m->IsNative()) {
2021 os << "(Native method)";
2022 } else {
2023 const char* source_file(m->GetDeclaringClassSourceFile());
2024 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2025 << ":" << line_number << ")";
2026 }
2027 os << "\n";
2028 // Go and visit locks.
2029 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002030 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002031
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002032 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002033 return VisitMethodResult::kContinueMethod;
2034 }
2035
Vladimir Markof52d92f2019-03-29 12:33:02 +00002036 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002037 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002038 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002039 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2040 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002041 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002042 override
Andreas Gampe93104952017-12-13 17:13:15 -08002043 REQUIRES_SHARED(Locks::mutator_lock_) {
2044 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2045 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002046 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002047 ThreadState state,
2048 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002049 override
Andreas Gampe93104952017-12-13 17:13:15 -08002050 REQUIRES_SHARED(Locks::mutator_lock_) {
2051 const char* msg;
2052 switch (state) {
2053 case kBlocked:
2054 msg = " - waiting to lock ";
2055 break;
2056
2057 case kWaitingForLockInflation:
2058 msg = " - waiting for lock inflation of ";
2059 break;
2060
2061 default:
2062 LOG(FATAL) << "Unreachable";
2063 UNREACHABLE();
2064 }
2065 PrintObject(obj, msg, owner_tid);
2066 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00002067 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002068 override
Andreas Gampe93104952017-12-13 17:13:15 -08002069 REQUIRES_SHARED(Locks::mutator_lock_) {
2070 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2071 }
2072
Vladimir Markof52d92f2019-03-29 12:33:02 +00002073 void PrintObject(ObjPtr<mirror::Object> obj,
Andreas Gampe93104952017-12-13 17:13:15 -08002074 const char* msg,
2075 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2076 if (obj == nullptr) {
2077 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002078 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002079 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002080 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2081 // Getting the identity hashcode here would result in lock inflation and suspension of the
2082 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002083 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
Vladimir Markof52d92f2019-03-29 12:33:02 +00002084 reinterpret_cast<intptr_t>(obj.Ptr()),
Andreas Gampe93104952017-12-13 17:13:15 -08002085 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002086 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002087 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2088 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2089 // suspension and move pretty_object.
2090 const std::string pretty_type(obj->PrettyTypeOf());
2091 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002092 }
2093 }
Andreas Gampe93104952017-12-13 17:13:15 -08002094 if (owner_tid != ThreadList::kInvalidThreadId) {
2095 os << " held by thread " << owner_tid;
2096 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002097 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002098 }
2099
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002100 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002101 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002102 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002103 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002104};
2105
Ian Rogers33e95662013-05-20 20:29:14 -07002106static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002107 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002108 ThreadState state = thread->GetState();
2109
2110 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2111 if (state > kWaiting && state < kStarting) {
2112 return true;
2113 }
2114
2115 // In an Object.wait variant or Thread.sleep? That's not interesting.
2116 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2117 return false;
2118 }
2119
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002120 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002121 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002122 return true;
2123 }
2124
Elliott Hughesaef701d2013-04-05 18:15:40 -07002125 // In some other native method? That's interesting.
2126 // We don't just check kNative because native methods will be in state kSuspended if they're
2127 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2128 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002129 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002130 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002131}
2132
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002133void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002134 // If flip_function is not null, it means we have run a checkpoint
2135 // before the thread wakes up to execute the flip function and the
2136 // thread roots haven't been forwarded. So the following access to
2137 // the roots (locks or methods in the frames) would be bad. Run it
2138 // here. TODO: clean up.
2139 {
2140 Thread* this_thread = const_cast<Thread*>(this);
2141 Closure* flip_func = this_thread->GetFlipFunction();
2142 if (flip_func != nullptr) {
2143 flip_func->Run(this_thread);
2144 }
2145 }
2146
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002147 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2148 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002149 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2150 // thread.
Alex Lightb7c640d2019-03-20 15:52:13 -07002151 ScopedExceptionStorage ses(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002152
Ian Rogers700a4022014-05-19 16:49:03 -07002153 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002154 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002155 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002156 dumper.WalkStack();
2157}
2158
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002159void Thread::DumpStack(std::ostream& os,
2160 bool dump_native_stack,
2161 BacktraceMap* backtrace_map,
2162 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002163 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2164 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2165 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002166 bool dump_for_abort = (gAborting > 0);
2167 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2168 if (!kIsDebugBuild) {
2169 // We always want to dump the stack for an abort, however, there is no point dumping another
2170 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2171 safe_to_dump = (safe_to_dump || dump_for_abort);
2172 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002173 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002174 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002175 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002176 ArtMethod* method =
2177 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002178 /*check_suspended=*/ !force_dump_stack,
2179 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002180 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002181 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002182 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002183 /*check_suspended=*/ !force_dump_stack,
2184 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002185 } else {
2186 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002187 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002188}
2189
Elliott Hughesbe759c62011-09-08 19:38:21 -07002190void Thread::ThreadExitCallback(void* arg) {
2191 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002192 if (self->tls32_.thread_exit_check_count == 0) {
2193 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2194 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002195 CHECK(is_started_);
Andreas Gampea47a6e82019-07-24 09:46:16 -07002196#ifdef __BIONIC__
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002197 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2198#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002199 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe82372002019-07-24 15:42:09 -07002200 Thread::self_tls_ = self;
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002201#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002202 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002203 } else {
2204 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2205 }
Carl Shapirob5573532011-07-12 18:22:59 -07002206}
2207
Elliott Hughesbe759c62011-09-08 19:38:21 -07002208void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002209 CHECK(!is_started_);
2210 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002211 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002212 // MutexLock to keep annotalysis happy.
2213 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002214 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002215 // return garbage since (is_started_ == true) and
2216 // Thread::pthread_key_self_ is not yet initialized.
2217 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002218 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002219 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2220 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002221 }
2222
Carl Shapirob5573532011-07-12 18:22:59 -07002223 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002224 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2225 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002226
2227 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002228 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2229 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002230 }
Andreas Gampe82372002019-07-24 15:42:09 -07002231#ifndef __BIONIC__
2232 CHECK(Thread::self_tls_ == nullptr);
2233#endif
Elliott Hughes038a8062011-09-18 14:12:41 -07002234}
Carl Shapirob5573532011-07-12 18:22:59 -07002235
Elliott Hughes038a8062011-09-18 14:12:41 -07002236void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002237 Runtime* runtime = Runtime::Current();
2238 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002239
Elliott Hughes01158d72011-09-19 19:47:10 -07002240 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002241 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002242 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2243 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002244
Vladimir Markodcfcce42018-06-27 10:00:28 +00002245 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002246
2247 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2248 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002249 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2250 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002251}
2252
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002253void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002254 CHECK(is_started_);
2255 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002256 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002257 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002258 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002259 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002260 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002261 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002262}
2263
Andreas Gampe56776012018-01-26 17:40:55 -08002264void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2265 ScopedLocalRef<jobject> thread_jobject(
2266 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2267 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2268 soa.Env(), nullptr);
2269 jobject thread_group_jobject = thread_group;
2270 if (thread_group == nullptr || kIsDebugBuild) {
2271 // There is always a group set. Retrieve it.
2272 thread_group_jobject_scoped.reset(
2273 soa.Env()->GetObjectField(thread_jobject.get(),
2274 WellKnownClasses::java_lang_Thread_group));
2275 thread_group_jobject = thread_group_jobject_scoped.get();
2276 if (kIsDebugBuild && thread_group != nullptr) {
2277 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2278 }
2279 }
2280 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2281 WellKnownClasses::java_lang_ThreadGroup,
2282 WellKnownClasses::java_lang_ThreadGroup_add,
2283 thread_jobject.get());
2284}
2285
Calin Juravleccd56952016-12-15 17:57:38 +00002286Thread::Thread(bool daemon)
2287 : tls32_(daemon),
2288 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002289 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002290 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002291 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002292 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2293 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2294
Roland Levillain33d69032015-06-18 18:20:59 +01002295 static_assert((sizeof(Thread) % 4) == 0U,
2296 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002297 tls32_.state_and_flags.as_struct.flags = 0;
2298 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002299 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002300 // Initialize with no permit; if the java Thread was unparked before being
2301 // started, it will unpark itself before calling into java code.
2302 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002303 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002304 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002305 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002306 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002307 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002308 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2309 tlsPtr_.active_suspend_barriers[i] = nullptr;
2310 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002311 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002312 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002313 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002314 tls32_.use_mterp = false;
2315}
2316
2317void Thread::NotifyInTheadList() {
2318 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002319}
2320
Alex Lighte9f61032018-09-24 16:04:51 -07002321bool Thread::CanLoadClasses() const {
2322 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2323}
2324
Elliott Hughes7dc51662012-05-16 14:48:43 -07002325bool Thread::IsStillStarting() const {
2326 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002327 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002328 // 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 -07002329 // assigned fairly early on, and needs to be.
2330 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2331 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002332 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2333 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002334}
2335
Andreas Gamped9efea62014-07-21 22:56:08 -07002336void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002337 CHECK(IsExceptionPending()) << "Pending exception expected.";
2338}
2339
2340void Thread::AssertPendingOOMException() const {
2341 AssertPendingException();
2342 auto* e = GetException();
2343 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2344 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002345}
2346
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002347void Thread::AssertNoPendingException() const {
2348 if (UNLIKELY(IsExceptionPending())) {
2349 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002350 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002351 }
2352}
2353
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002354void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2355 if (UNLIKELY(IsExceptionPending())) {
2356 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002357 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002358 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002359 }
2360}
2361
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002362class MonitorExitVisitor : public SingleRootVisitor {
2363 public:
2364 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2365
2366 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2367 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002368 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002369 if (self_->HoldsLock(entered_monitor)) {
2370 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002371 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002372 << " left locked by native thread "
2373 << *Thread::Current() << " which is detaching";
2374 entered_monitor->MonitorExit(self_);
2375 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002376 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002377
2378 private:
2379 Thread* const self_;
2380};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002381
Elliott Hughesc0f09332012-03-26 13:27:06 -07002382void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002383 Thread* self = this;
2384 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002385
Ian Rogers68d8b422014-07-17 11:09:10 -07002386 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002387 {
2388 ScopedObjectAccess soa(self);
2389 MonitorExitVisitor visitor(self);
2390 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002391 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002392 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002393 // Release locally held global references which releasing may require the mutator lock.
2394 if (tlsPtr_.jpeer != nullptr) {
2395 // If pthread_create fails we don't have a jni env here.
2396 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2397 tlsPtr_.jpeer = nullptr;
2398 }
2399 if (tlsPtr_.class_loader_override != nullptr) {
2400 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2401 tlsPtr_.class_loader_override = nullptr;
2402 }
2403 }
2404
Ian Rogersdd7624d2014-03-14 17:43:00 -07002405 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002406 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002407 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002408 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002409 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002410 Runtime* runtime = Runtime::Current();
2411 if (runtime != nullptr) {
2412 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2413 }
Elliott Hughes534da072012-03-27 15:17:42 -07002414
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002415 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002416 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002417 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002418 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002419 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002420 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002421 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002422 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002423
Ian Rogerscfaa4552012-11-26 21:00:08 -08002424 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2425 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002426 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002427 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002428 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002429 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002430 StackHandleScope<1> hs(self);
2431 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002432 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002433 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002434 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002435 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002436 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002437
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002438 {
2439 ScopedObjectAccess soa(self);
2440 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002441 if (kUseReadBarrier) {
2442 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2443 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002444 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002445}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002446
Elliott Hughesc0f09332012-03-26 13:27:06 -07002447Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002448 CHECK(tlsPtr_.class_loader_override == nullptr);
2449 CHECK(tlsPtr_.jpeer == nullptr);
2450 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002451 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002452 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002453 delete tlsPtr_.jni_env;
2454 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002455 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002456 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002457 CHECK(!ReadFlag(kCheckpointRequest));
2458 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002459 CHECK(tlsPtr_.checkpoint_function == nullptr);
2460 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002461 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002462 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002463
Sebastien Hertz07474662015-08-25 15:12:33 +00002464 // Make sure we processed all deoptimization requests.
2465 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002466 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2467 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002468
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002469 // We may be deleting a still born thread.
2470 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002471
2472 delete wait_cond_;
2473 delete wait_mutex_;
2474
Ian Rogersdd7624d2014-03-14 17:43:00 -07002475 if (tlsPtr_.long_jump_context != nullptr) {
2476 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002477 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002478
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002479 if (initialized) {
2480 CleanupCpu();
2481 }
2482
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002483 if (tlsPtr_.single_step_control != nullptr) {
2484 delete tlsPtr_.single_step_control;
2485 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002486 delete tlsPtr_.instrumentation_stack;
2487 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002488 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002489
Ian Rogers68d8b422014-07-17 11:09:10 -07002490 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002491
Elliott Hughesd8af1592012-04-16 20:40:15 -07002492 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002493}
2494
Andreas Gampe513061a2017-06-01 09:17:34 -07002495void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002496 if (!IsExceptionPending()) {
2497 return;
2498 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002499 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002500 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002501
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002502 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002503 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2504 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002505
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002506 // Call the Thread instance's dispatchUncaughtException(Throwable)
2507 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2508 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2509 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002510
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002511 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002512 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002513}
2514
Andreas Gampe513061a2017-06-01 09:17:34 -07002515void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002516 // this.group.removeThread(this);
2517 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002518 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002519 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002520 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002521 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002522 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002523 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002524 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2525 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2526 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002527 }
2528}
2529
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002530bool Thread::HandleScopeContains(jobject obj) const {
2531 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002532 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002533 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002534 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002535 return true;
2536 }
2537 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002538 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2539 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002540}
2541
Hans Boehm0882af22017-08-31 15:21:57 -07002542void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002543 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2544 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002545 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2546 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002547 }
2548}
2549
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002550ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002551 if (obj == nullptr) {
2552 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002553 }
2554 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002555 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002556 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002557 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002558 // The "kinds" below are sorted by the frequency we expect to encounter them.
2559 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002560 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002561 // Local references do not need a read barrier.
2562 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002563 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002564 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002565 // Check if this is a local reference in the handle scope.
2566 if (LIKELY(HandleScopeContains(obj))) {
2567 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002568 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002569 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002570 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002571 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002572 expect_null = true;
2573 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002574 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002575 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002576 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002577 } else {
2578 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002579 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002580 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002581 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002582 expect_null = true;
2583 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002584 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002585 }
2586
Ian Rogersc0542af2014-09-03 16:16:56 -07002587 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002588 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002589 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002590 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002591 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002592}
2593
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002594bool Thread::IsJWeakCleared(jweak obj) const {
2595 CHECK(obj != nullptr);
2596 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002597 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002598 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002599 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002600}
2601
Ian Rogers81d425b2012-09-27 16:03:43 -07002602// Implements java.lang.Thread.interrupted.
2603bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002604 DCHECK_EQ(Thread::Current(), this);
2605 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002606 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002607 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002608 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002609 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002610 return interrupted;
2611}
2612
2613// Implements java.lang.Thread.isInterrupted.
2614bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002615 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002616}
2617
Ian Rogersdd7624d2014-03-14 17:43:00 -07002618void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002619 {
2620 MutexLock mu(self, *wait_mutex_);
2621 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2622 return;
2623 }
2624 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2625 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002626 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002627 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002628}
2629
2630void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002631 Thread* self = Thread::Current();
2632 MutexLock mu(self, *wait_mutex_);
2633 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002634}
2635
Ian Rogersc604d732012-10-14 16:09:54 -07002636void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002637 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002638 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002639 }
2640}
2641
Ian Rogers68d8b422014-07-17 11:09:10 -07002642void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2643 if (tlsPtr_.class_loader_override != nullptr) {
2644 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2645 }
2646 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2647}
2648
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002649using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2650
2651// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2652class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002653 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002654 explicit FetchStackTraceVisitor(Thread* thread,
2655 ArtMethodDexPcPair* saved_frames = nullptr,
2656 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002657 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002658 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002659 saved_frames_(saved_frames),
2660 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002661
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002662 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002663 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002664 // Note we also skip the frame if it doesn't have a method (namely the callee
2665 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002666 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002667 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002668 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002669 skipping_ = false;
2670 }
2671 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002672 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002673 if (depth_ < max_saved_frames_) {
2674 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002675 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002676 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002677 ++depth_;
2678 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002679 } else {
2680 ++skip_depth_;
2681 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002682 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002683 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002684
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002685 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002686 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002687 }
2688
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002689 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002690 return skip_depth_;
2691 }
2692
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002693 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002694 uint32_t depth_ = 0;
2695 uint32_t skip_depth_ = 0;
2696 bool skipping_ = true;
2697 ArtMethodDexPcPair* saved_frames_;
2698 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002699
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002700 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002701};
2702
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002703template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002704class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002705 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002706 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002707 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2708 self_(self),
2709 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002710 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002711
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002712 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002713 // Allocate method trace as an object array where the first element is a pointer array that
2714 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2715 // class of the ArtMethod pointers.
2716 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2717 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002718 ObjPtr<mirror::Class> array_class =
2719 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002720 // The first element is the methods and dex pc array, the other elements are declaring classes
2721 // for the methods to ensure classes in the stack trace don't get unloaded.
2722 Handle<mirror::ObjectArray<mirror::Object>> trace(
2723 hs.NewHandle(
2724 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002725 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002726 // Acquire uninterruptible_ in all paths.
2727 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002728 self_->AssertPendingOOMException();
2729 return false;
2730 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002731 ObjPtr<mirror::PointerArray> methods_and_pcs =
2732 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002733 const char* last_no_suspend_cause =
2734 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2735 if (methods_and_pcs == nullptr) {
2736 self_->AssertPendingOOMException();
2737 return false;
2738 }
2739 trace->Set(0, methods_and_pcs);
2740 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002741 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002742 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002743 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002744 }
2745
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002746 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2747 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002748 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002749
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002750 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002751 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002752 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002753 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002754 if (skip_depth_ > 0) {
2755 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002756 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002757 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002758 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002759 if (m->IsRuntimeMethod()) {
2760 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002761 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002762 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002763 return true;
2764 }
2765
2766 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002767 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002768 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002769 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2770 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002771 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002772 pointer_size_);
2773 // Save the declaring class of the method to ensure that the declaring classes of the methods
2774 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002775 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002776 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002777 }
2778
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002779 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002780 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002781 }
2782
2783 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002784 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002785 }
2786
2787 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002788 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002789 // How many more frames to skip.
2790 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002791 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002792 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002793 // An object array where the first element is a pointer array that contains the ArtMethod
2794 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2795 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2796 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002797 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002798 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002799 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002800
2801 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002802};
2803
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002804template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002805jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002806 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2807 constexpr size_t kMaxSavedFrames = 256;
2808 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2809 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2810 &saved_frames[0],
2811 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002812 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002813 const uint32_t depth = count_visitor.GetDepth();
2814 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002815
Ian Rogers1f539342012-10-03 21:09:42 -07002816 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002817 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2818 const_cast<Thread*>(this),
2819 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002820 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002821 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002822 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002823 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2824 // than doing the stack walk twice.
2825 if (depth < kMaxSavedFrames) {
2826 for (size_t i = 0; i < depth; ++i) {
2827 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2828 }
2829 } else {
2830 build_trace_visitor.WalkStack();
2831 }
2832
Mathieu Chartier910e8272015-09-30 09:24:22 -07002833 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002834 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002835 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002836 // Second half of trace_methods is dex PCs.
2837 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2838 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002839 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2840 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002841 }
2842 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002843 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002844}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002845template jobject Thread::CreateInternalStackTrace<false>(
2846 const ScopedObjectAccessAlreadyRunnable& soa) const;
2847template jobject Thread::CreateInternalStackTrace<true>(
2848 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002849
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002850bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002851 // Only count the depth since we do not pass a stack frame array as an argument.
2852 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002853 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002854 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002855}
2856
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002857static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2858 const ScopedObjectAccessAlreadyRunnable& soa,
2859 ArtMethod* method,
2860 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2861 int32_t line_number;
2862 StackHandleScope<3> hs(soa.Self());
2863 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2864 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2865 if (method->IsProxyMethod()) {
2866 line_number = -1;
2867 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2868 // source_name_object intentionally left null for proxy methods
2869 } else {
2870 line_number = method->GetLineNumFromDexPC(dex_pc);
2871 // Allocate element, potentially triggering GC
2872 // TODO: reuse class_name_object via Class::name_?
2873 const char* descriptor = method->GetDeclaringClassDescriptor();
2874 CHECK(descriptor != nullptr);
2875 std::string class_name(PrettyDescriptor(descriptor));
2876 class_name_object.Assign(
2877 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2878 if (class_name_object == nullptr) {
2879 soa.Self()->AssertPendingOOMException();
2880 return nullptr;
2881 }
2882 const char* source_file = method->GetDeclaringClassSourceFile();
2883 if (line_number == -1) {
2884 // Make the line_number field of StackTraceElement hold the dex pc.
2885 // source_name_object is intentionally left null if we failed to map the dex pc to
2886 // a line number (most probably because there is no debug info). See b/30183883.
2887 line_number = dex_pc;
2888 } else {
2889 if (source_file != nullptr) {
2890 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2891 if (source_name_object == nullptr) {
2892 soa.Self()->AssertPendingOOMException();
2893 return nullptr;
2894 }
2895 }
2896 }
2897 }
2898 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2899 CHECK(method_name != nullptr);
2900 Handle<mirror::String> method_name_object(
2901 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2902 if (method_name_object == nullptr) {
2903 return nullptr;
2904 }
2905 return mirror::StackTraceElement::Alloc(soa.Self(),
2906 class_name_object,
2907 method_name_object,
2908 source_name_object,
2909 line_number);
2910}
2911
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002912jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002913 const ScopedObjectAccessAlreadyRunnable& soa,
2914 jobject internal,
2915 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002916 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002917 // Decode the internal stack trace into the depth, method trace and PC trace.
2918 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002919 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002920 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002921
Mathieu Chartier910e8272015-09-30 09:24:22 -07002922 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002923
Elliott Hughes01158d72011-09-19 19:47:10 -07002924 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002925
Dave Allison0aded082013-11-07 13:15:11 -08002926 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002927 // Reuse the array we were given.
2928 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002929 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002930 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002931 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002932 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002933 } else {
2934 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002935 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002936 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002937 if (java_traces == nullptr) {
2938 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002939 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002940 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002941 }
2942
Dave Allison0aded082013-11-07 13:15:11 -08002943 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002944 *stack_depth = depth;
2945 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002946
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002947 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002948 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002949 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002950 // Methods and dex PC trace is element 0.
2951 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00002952 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002953 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07002954 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002955 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002956 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002957 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00002958 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002959 if (obj == nullptr) {
2960 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002961 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002962 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002963 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002964 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002965 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002966}
2967
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002968jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2969 // This code allocates. Do not allow it to operate with a pending exception.
2970 if (IsExceptionPending()) {
2971 return nullptr;
2972 }
2973
2974 // If flip_function is not null, it means we have run a checkpoint
2975 // before the thread wakes up to execute the flip function and the
2976 // thread roots haven't been forwarded. So the following access to
2977 // the roots (locks or methods in the frames) would be bad. Run it
2978 // here. TODO: clean up.
2979 // Note: copied from DumpJavaStack.
2980 {
2981 Thread* this_thread = const_cast<Thread*>(this);
2982 Closure* flip_func = this_thread->GetFlipFunction();
2983 if (flip_func != nullptr) {
2984 flip_func->Run(this_thread);
2985 }
2986 }
2987
2988 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2989 public:
2990 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2991 Thread* self,
2992 Context* context)
2993 : MonitorObjectsStackVisitor(self, context),
2994 wait_jobject_(soaa_in.Env(), nullptr),
2995 block_jobject_(soaa_in.Env(), nullptr),
2996 soaa_(soaa_in) {}
2997
2998 protected:
2999 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003000 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003001 REQUIRES_SHARED(Locks::mutator_lock_) {
3002 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
3003 soaa_, m, GetDexPc(/* abort on error */ false));
3004 if (obj == nullptr) {
3005 return VisitMethodResult::kEndStackWalk;
3006 }
3007 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
3008 return VisitMethodResult::kContinueMethod;
3009 }
3010
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003011 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003012 lock_objects_.push_back({});
3013 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3014
3015 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3016
3017 return VisitMethodResult::kContinueMethod;
3018 }
3019
Vladimir Markof52d92f2019-03-29 12:33:02 +00003020 void VisitWaitingObject(ObjPtr<mirror::Object> obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003021 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003022 REQUIRES_SHARED(Locks::mutator_lock_) {
3023 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3024 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003025 void VisitSleepingObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003026 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003027 REQUIRES_SHARED(Locks::mutator_lock_) {
3028 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3029 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003030 void VisitBlockedOnObject(ObjPtr<mirror::Object> obj,
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003031 ThreadState state ATTRIBUTE_UNUSED,
3032 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003033 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003034 REQUIRES_SHARED(Locks::mutator_lock_) {
3035 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3036 }
Vladimir Markof52d92f2019-03-29 12:33:02 +00003037 void VisitLockedObject(ObjPtr<mirror::Object> obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003038 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003039 REQUIRES_SHARED(Locks::mutator_lock_) {
3040 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3041 }
3042
3043 public:
3044 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3045 ScopedLocalRef<jobject> wait_jobject_;
3046 ScopedLocalRef<jobject> block_jobject_;
3047 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3048
3049 private:
3050 const ScopedObjectAccessAlreadyRunnable& soaa_;
3051
3052 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3053 };
3054
3055 std::unique_ptr<Context> context(Context::Create());
3056 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3057 dumper.WalkStack();
3058
3059 // There should not be a pending exception. Otherwise, return with it pending.
3060 if (IsExceptionPending()) {
3061 return nullptr;
3062 }
3063
3064 // Now go and create Java arrays.
3065
3066 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3067
3068 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003069 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003070 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003071 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3072 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003073 return nullptr;
3074 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003075 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003076
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003077 Handle<mirror::Class> h_o_array_class =
3078 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3079 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003080
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003081
3082 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3083 class_linker->EnsureInitialized(soa.Self(),
3084 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003085 /* can_init_fields= */ true,
3086 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003087 if (soa.Self()->IsExceptionPending()) {
3088 // This should not fail in a healthy runtime.
3089 return nullptr;
3090 }
3091
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003092 ArtField* stack_trace_element_field = h_aste_class->FindField(
3093 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3094 DCHECK(stack_trace_element_field != nullptr);
3095 ArtField* held_locks_field = h_aste_class->FindField(
3096 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3097 DCHECK(held_locks_field != nullptr);
3098 ArtField* blocked_on_field = h_aste_class->FindField(
3099 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3100 DCHECK(blocked_on_field != nullptr);
3101
3102 size_t length = dumper.stack_trace_elements_.size();
3103 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003104 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003105 if (array == nullptr) {
3106 soa.Self()->AssertPendingOOMException();
3107 return nullptr;
3108 }
3109
3110 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3111
3112 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3113 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3114 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3115 for (size_t i = 0; i != length; ++i) {
3116 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3117 if (handle == nullptr) {
3118 soa.Self()->AssertPendingOOMException();
3119 return nullptr;
3120 }
3121
3122 // Set stack trace element.
3123 stack_trace_element_field->SetObject<false>(
3124 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3125
3126 // Create locked-on array.
3127 if (!dumper.lock_objects_[i].empty()) {
3128 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3129 h_o_array_class.Get(),
3130 dumper.lock_objects_[i].size()));
3131 if (handle2 == nullptr) {
3132 soa.Self()->AssertPendingOOMException();
3133 return nullptr;
3134 }
3135 int32_t j = 0;
3136 for (auto& scoped_local : dumper.lock_objects_[i]) {
3137 if (scoped_local == nullptr) {
3138 continue;
3139 }
3140 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3141 DCHECK(!soa.Self()->IsExceptionPending());
3142 j++;
3143 }
3144 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3145 }
3146
3147 // Set blocked-on object.
3148 if (i == 0) {
3149 if (dumper.block_jobject_ != nullptr) {
3150 blocked_on_field->SetObject<false>(
3151 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3152 }
3153 }
3154
3155 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3156 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3157 DCHECK(!soa.Self()->IsExceptionPending());
3158 }
3159
3160 return result.release();
3161}
3162
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003163void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003164 va_list args;
3165 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003166 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003167 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003168}
3169
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003170void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003171 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003172 std::string msg;
3173 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003174 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003175}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003176
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003177void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003178 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003179 // Callers should either clear or call ThrowNewWrappedException.
3180 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003181 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003182}
3183
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003184static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003185 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003186 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003187 return method != nullptr
3188 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003189 : nullptr;
3190}
3191
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003192void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003193 const char* msg) {
3194 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003195 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003196 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003197 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003198 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003199 ClearException();
3200 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003201 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003202 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003203 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003204 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003205 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003206 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003207 return;
3208 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003209
Ian Rogers7b078e82014-09-10 14:44:24 -07003210 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3211 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003212 DCHECK(IsExceptionPending());
3213 return;
3214 }
3215 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003216 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003217 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003218
Mathieu Chartier590fee92013-09-13 13:46:47 -07003219 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003220 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003221 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3222 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003223 return;
3224 }
3225
Ian Rogers62d6c772013-02-27 08:32:07 -08003226 // Choose an appropriate constructor and set up the arguments.
3227 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003228 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003229 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003230 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003231 msg_string.reset(
3232 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003233 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003234 CHECK(IsExceptionPending()); // OOME.
3235 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003236 }
Dave Allison0aded082013-11-07 13:15:11 -08003237 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003238 signature = "(Ljava/lang/String;)V";
3239 } else {
3240 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3241 }
3242 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003243 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003244 signature = "()V";
3245 } else {
3246 signature = "(Ljava/lang/Throwable;)V";
3247 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003248 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003249 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003250 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003251
Dave Allison0aded082013-11-07 13:15:11 -08003252 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003253 << PrettyDescriptor(exception_class_descriptor);
3254
3255 if (UNLIKELY(!runtime->IsStarted())) {
3256 // Something is trying to throw an exception without a started runtime, which is the common
3257 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3258 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003259 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003260 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003261 }
Dave Allison0aded082013-11-07 13:15:11 -08003262 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003263 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003264 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003265 ScopedLocalRef<jobject> trace(GetJniEnv(),
3266 Runtime::Current()->IsActiveTransaction()
3267 ? CreateInternalStackTrace<true>(soa)
3268 : CreateInternalStackTrace<false>(soa));
3269 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003270 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003271 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003272 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003273 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003274 jvalue jv_args[2];
3275 size_t i = 0;
3276
Dave Allison0aded082013-11-07 13:15:11 -08003277 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003278 jv_args[i].l = msg_string.get();
3279 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003280 }
Dave Allison0aded082013-11-07 13:15:11 -08003281 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003282 jv_args[i].l = cause.get();
3283 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003284 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003285 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Alex Light01fbfbe2019-06-27 10:47:04 -07003286 InvokeWithJValues(soa, ref.get(), exception_init_method, jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003287 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003288 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003289 }
Elliott Hughes30646832011-10-13 16:59:46 -07003290 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003291}
3292
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003293void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003294 LOG(WARNING) << "Throwing OutOfMemoryError "
3295 << '"' << msg << '"'
3296 << " (VmSize " << GetProcessStatus("VmSize")
3297 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003298 if (!tls32_.throwing_OutOfMemoryError) {
3299 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003300 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003301 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003302 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003303 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003304 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003305 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003306}
3307
Elliott Hughes498508c2011-10-17 14:58:22 -07003308Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003309 return Thread::Current();
3310}
3311
3312void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003313 std::ostringstream ss;
3314 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003315 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003316 // log to stderr for debugging command line processes
3317 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003318#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003319 // log to logcat for debugging frameworks processes
3320 LOG(INFO) << str;
3321#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003322}
3323
Ian Rogersdd7624d2014-03-14 17:43:00 -07003324// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003325template
3326void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3327template
3328void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003329
Andreas Gampe542451c2016-07-26 09:02:02 -07003330template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003331void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3332#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003333 if (offset == (x).Uint32Value()) { \
3334 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003335 return; \
3336 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003337 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3338 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3339 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3340 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3341 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3342 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3343 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3344 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003345 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003346 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003347 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003348 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003349 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003350#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003351
Ian Rogersdd7624d2014-03-14 17:43:00 -07003352#define JNI_ENTRY_POINT_INFO(x) \
3353 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3354 os << #x; \
3355 return; \
3356 }
3357 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3358#undef JNI_ENTRY_POINT_INFO
3359
Ian Rogersdd7624d2014-03-14 17:43:00 -07003360#define QUICK_ENTRY_POINT_INFO(x) \
3361 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3362 os << #x; \
3363 return; \
3364 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003365 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003366 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3367 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3368 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3369 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003370 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3371 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003372 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003373 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003374 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3375 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3376 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003377 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003378 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003379 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003380 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3381 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003382 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003383 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3384 QUICK_ENTRY_POINT_INFO(pSet8Static)
3385 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3386 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003387 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3388 QUICK_ENTRY_POINT_INFO(pSet32Static)
3389 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3390 QUICK_ENTRY_POINT_INFO(pSet64Static)
3391 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3392 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003393 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3394 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3395 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3396 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3397 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3398 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3399 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3400 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003401 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3402 QUICK_ENTRY_POINT_INFO(pGet32Static)
3403 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3404 QUICK_ENTRY_POINT_INFO(pGet64Static)
3405 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3406 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003407 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003408 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3409 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3410 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3411 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3412 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3413 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3414 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3415 QUICK_ENTRY_POINT_INFO(pLockObject)
3416 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3417 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3418 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3419 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3420 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003421 QUICK_ENTRY_POINT_INFO(pCos)
3422 QUICK_ENTRY_POINT_INFO(pSin)
3423 QUICK_ENTRY_POINT_INFO(pAcos)
3424 QUICK_ENTRY_POINT_INFO(pAsin)
3425 QUICK_ENTRY_POINT_INFO(pAtan)
3426 QUICK_ENTRY_POINT_INFO(pAtan2)
3427 QUICK_ENTRY_POINT_INFO(pCbrt)
3428 QUICK_ENTRY_POINT_INFO(pCosh)
3429 QUICK_ENTRY_POINT_INFO(pExp)
3430 QUICK_ENTRY_POINT_INFO(pExpm1)
3431 QUICK_ENTRY_POINT_INFO(pHypot)
3432 QUICK_ENTRY_POINT_INFO(pLog)
3433 QUICK_ENTRY_POINT_INFO(pLog10)
3434 QUICK_ENTRY_POINT_INFO(pNextAfter)
3435 QUICK_ENTRY_POINT_INFO(pSinh)
3436 QUICK_ENTRY_POINT_INFO(pTan)
3437 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003438 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003439 QUICK_ENTRY_POINT_INFO(pL2d)
3440 QUICK_ENTRY_POINT_INFO(pFmodf)
3441 QUICK_ENTRY_POINT_INFO(pL2f)
3442 QUICK_ENTRY_POINT_INFO(pD2iz)
3443 QUICK_ENTRY_POINT_INFO(pF2iz)
3444 QUICK_ENTRY_POINT_INFO(pIdivmod)
3445 QUICK_ENTRY_POINT_INFO(pD2l)
3446 QUICK_ENTRY_POINT_INFO(pF2l)
3447 QUICK_ENTRY_POINT_INFO(pLdiv)
3448 QUICK_ENTRY_POINT_INFO(pLmod)
3449 QUICK_ENTRY_POINT_INFO(pLmul)
3450 QUICK_ENTRY_POINT_INFO(pShlLong)
3451 QUICK_ENTRY_POINT_INFO(pShrLong)
3452 QUICK_ENTRY_POINT_INFO(pUshrLong)
3453 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003454 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3455 QUICK_ENTRY_POINT_INFO(pMemcpy)
3456 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3457 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3458 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3459 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3460 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3461 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3462 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3463 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003464 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003465 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3466 QUICK_ENTRY_POINT_INFO(pDeliverException)
3467 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3468 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003469 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3470 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003471 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003472 QUICK_ENTRY_POINT_INFO(pA64Load)
3473 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003474 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3475 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3476 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3477 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3478 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3479 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3480 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3481 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3482 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3483 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3484 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3485 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3486 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3487 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3488 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3489 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003490 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003491 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3492 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3493 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3494 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3495 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3496 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3497 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3498 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3499 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3500 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3501 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3502 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3503 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3504 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3505 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3506 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3507 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3508 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3509 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3510 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3511 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3512 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3513 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3514 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3515 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3516 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3517 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3518 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3519 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3520 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003521 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003522 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003523
3524 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3525 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003526#undef QUICK_ENTRY_POINT_INFO
3527
Elliott Hughes98e20172012-04-24 15:38:13 -07003528 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003529}
3530
jeffhao94d6df42012-11-26 16:02:12 -08003531void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003532 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003533 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003534 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003535 if (exception == GetDeoptimizationException()) {
3536 artDeoptimize(this);
3537 UNREACHABLE();
3538 }
3539
Roland Levillaina78f5b62017-09-29 13:50:44 +01003540 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003541
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003542 // This is a real exception: let the instrumentation know about it.
3543 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003544 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003545 IsExceptionThrownByCurrentMethod(exception)) {
3546 // Instrumentation may cause GC so keep the exception object safe.
3547 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003548 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Vladimir Marko19711d42019-04-12 14:05:34 +01003549 instrumentation->ExceptionThrownEvent(this, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003550 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003551 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3552 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3553 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3554 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003555 //
3556 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3557 // expected to happen fairly regularly but the second can only happen if we are using
3558 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3559 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003560 ShadowFrame* cf;
David Srbecky1cbac5c2019-07-18 20:05:32 +01003561 bool force_deopt = false;
3562 if (Runtime::Current()->AreNonStandardExitsEnabled() || kIsDebugBuild) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003563 NthCallerVisitor visitor(this, 0, false);
3564 visitor.WalkStack();
3565 cf = visitor.GetCurrentShadowFrame();
3566 if (cf == nullptr) {
3567 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3568 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003569 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3570 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003571 if (kIsDebugBuild && force_frame_pop) {
David Srbecky1cbac5c2019-07-18 20:05:32 +01003572 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
Alex Light0aa7a5a2018-10-10 15:58:14 +00003573 NthCallerVisitor penultimate_visitor(this, 1, false);
3574 penultimate_visitor.WalkStack();
3575 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3576 if (penultimate_frame == nullptr) {
3577 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3578 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003579 }
David Srbecky1cbac5c2019-07-18 20:05:32 +01003580 if (force_retry_instr) {
3581 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3582 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003583 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003584 }
Alex Light3dacdd62019-03-12 15:45:47 +00003585 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003586 NthCallerVisitor visitor(this, 0, false);
3587 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003588 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003589 // method_type shouldn't matter due to exception handling.
3590 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003591 // Save the exception into the deoptimization context so it can be restored
3592 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003593 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003594 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3595 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3596 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003597 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3598 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003599 ClearException();
3600 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003601 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003602 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003603 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003604 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003605 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003606 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003607 artDeoptimize(this);
3608 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003609 } else {
3610 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3611 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003612 }
3613 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003614
Ian Rogers28ad40d2011-10-27 15:19:26 -07003615 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003616 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003617 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003618 QuickExceptionHandler exception_handler(this, false);
3619 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003620 if (exception_handler.GetClearException()) {
3621 // Exception was cleared as part of delivery.
3622 DCHECK(!IsExceptionPending());
3623 } else {
3624 // Exception was put back with a throw location.
3625 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003626 // Check the to-space invariant on the re-installed exception (if applicable).
3627 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003628 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003629 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003630}
3631
Ian Rogersbdb03912011-09-14 00:55:44 -07003632Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003633 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003634 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003635 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003636 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003637 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003638 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003639 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003640 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003641}
3642
Andreas Gampec7d878d2018-11-19 18:42:06 +00003643ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003644 bool check_suspended,
3645 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003646 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3647 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3648 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003649 ArtMethod* method = nullptr;
3650 uint32_t dex_pc = dex::kDexNoIndex;
3651 StackVisitor::WalkStack(
3652 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3653 ArtMethod* m = visitor->GetMethod();
3654 if (m->IsRuntimeMethod()) {
3655 // Continue if this is a runtime method.
3656 return true;
3657 }
3658 method = m;
3659 dex_pc = visitor->GetDexPc(abort_on_error);
3660 return false;
3661 },
3662 const_cast<Thread*>(this),
3663 /* context= */ nullptr,
3664 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3665 check_suspended);
3666
3667 if (dex_pc_out != nullptr) {
3668 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003669 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003670 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003671}
3672
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003673bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3674 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003675}
3676
Roland Levillainad0777d2018-02-12 20:00:18 +00003677extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003678 REQUIRES_SHARED(Locks::mutator_lock_);
3679
Ian Rogers40e3bac2012-11-20 00:09:14 -08003680// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003681template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003682class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003683 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003684 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003685 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003686 // We are visiting the references in compiled frames, so we do not need
3687 // to know the inlined frames.
3688 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3689 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003690
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003691 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003692 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003693 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003694 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003695 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003696 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003697 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003698 VisitShadowFrame(shadow_frame);
3699 } else {
3700 VisitQuickFrame();
3701 }
3702 return true;
3703 }
3704
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003705 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003706 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003707 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003708 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003709 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003710 // handle scope for JNI or References for interpreter.
3711 for (size_t reg = 0; reg < num_regs; ++reg) {
3712 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3713 if (ref != nullptr) {
3714 mirror::Object* new_ref = ref;
3715 visitor_(&new_ref, reg, this);
3716 if (new_ref != ref) {
3717 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003718 }
3719 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003720 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003721 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003722 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003723 }
3724
3725 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003726 // 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 -07003727 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3728 // the threads do not all hold the heap bitmap lock for parallel GC.
3729 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003730 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003731 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003732 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003733 // klass can be null for runtime methods.
3734 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003735 if (kVerifyImageObjectsMarked) {
3736 gc::Heap* const heap = Runtime::Current()->GetHeap();
3737 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003738 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003739 if (space != nullptr && space->IsImageSpace()) {
3740 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003741 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003742 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003743 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003744 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003745 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003746 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003747 }
3748 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003749 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3750 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3751 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003752 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003753 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003754 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3755 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003756 }
3757 }
3758 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003759 mirror::Object* new_ref = klass.Ptr();
Alex Light0054aa52019-09-10 16:46:48 -07003760 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kMethodDeclaringClass, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003761 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003762 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003763 }
3764 }
3765 }
3766
Andreas Gampe585da952016-12-02 14:52:29 -08003767 template <typename T>
3768 ALWAYS_INLINE
3769 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003770 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003771 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003772 ArtMethod* m = *cur_quick_frame;
3773 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003774
Sebastien Hertz714f1752014-04-28 15:03:08 +02003775 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003776 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003777 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003778 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003779 StackReference<mirror::Object>* vreg_base =
3780 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003781 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbecky0d4567f2019-05-30 22:45:40 +01003782 CodeInfo code_info = kPrecise
3783 ? CodeInfo(method_header) // We will need dex register maps.
3784 : CodeInfo::DecodeGcMasksOnly(method_header);
David Srbecky052f8ca2018-04-26 15:42:54 +01003785 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003786 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003787
David Srbecky052f8ca2018-04-26 15:42:54 +01003788 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003789
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003790 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003791 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003792 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003793 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003794 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003795 mirror::Object* ref = ref_addr->AsMirrorPtr();
3796 if (ref != nullptr) {
3797 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003798 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003799 if (ref != new_ref) {
3800 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003801 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003802 }
3803 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003804 }
3805 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003806 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003807 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3808 if (register_mask & (1 << i)) {
3809 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003810 if (kIsDebugBuild && ref_addr == nullptr) {
3811 std::string thread_name;
3812 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003813 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003814 DescribeStack(GetThread());
3815 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3816 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3817 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003818 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003819 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003820 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003821 }
3822 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003823 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3824 // If this is a proxy method, visit its reference arguments.
3825 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003826 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003827 std::vector<StackReference<mirror::Object>*> ref_addrs =
3828 GetProxyReferenceArguments(cur_quick_frame);
3829 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3830 mirror::Object* ref = ref_addr->AsMirrorPtr();
3831 if (ref != nullptr) {
3832 mirror::Object* new_ref = ref;
Alex Light0054aa52019-09-10 16:46:48 -07003833 visitor_(&new_ref, /* vreg= */ JavaFrameRootInfo::kProxyReferenceArgument, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003834 if (ref != new_ref) {
3835 ref_addr->Assign(new_ref);
3836 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003837 }
3838 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003839 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003840 }
3841
Andreas Gampe585da952016-12-02 14:52:29 -08003842 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3843 if (kPrecise) {
3844 VisitQuickFramePrecise();
3845 } else {
3846 VisitQuickFrameNonPrecise();
3847 }
3848 }
3849
3850 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3851 struct UndefinedVRegInfo {
3852 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3853 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003854 const StackMap& map ATTRIBUTE_UNUSED,
3855 RootVisitor& _visitor)
3856 : visitor(_visitor) {
3857 }
3858
3859 ALWAYS_INLINE
3860 void VisitStack(mirror::Object** ref,
3861 size_t stack_index ATTRIBUTE_UNUSED,
3862 const StackVisitor* stack_visitor)
3863 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07003864 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003865 }
3866
3867 ALWAYS_INLINE
3868 void VisitRegister(mirror::Object** ref,
3869 size_t register_index ATTRIBUTE_UNUSED,
3870 const StackVisitor* stack_visitor)
3871 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light0054aa52019-09-10 16:46:48 -07003872 visitor(ref, JavaFrameRootInfo::kImpreciseVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003873 }
3874
3875 RootVisitor& visitor;
3876 };
3877 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3878 }
3879
3880 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3881 struct StackMapVRegInfo {
3882 StackMapVRegInfo(ArtMethod* method,
3883 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003884 const StackMap& map,
3885 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003886 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003887 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003888 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003889 visitor(_visitor) {
Artem Serov2808be82018-12-20 19:15:11 +00003890 DCHECK_EQ(dex_register_map.size(), number_of_dex_registers);
Andreas Gampe585da952016-12-02 14:52:29 -08003891 }
3892
3893 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3894 // lookups for each location.
3895 void FindWithType(const size_t index,
3896 const DexRegisterLocation::Kind kind,
3897 mirror::Object** ref,
3898 const StackVisitor* stack_visitor)
3899 REQUIRES_SHARED(Locks::mutator_lock_) {
3900 bool found = false;
3901 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003902 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003903 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3904 visitor(ref, dex_reg, stack_visitor);
3905 found = true;
3906 }
3907 }
3908
3909 if (!found) {
Alex Light0054aa52019-09-10 16:46:48 -07003910 // If nothing found, report with unknown.
3911 visitor(ref, JavaFrameRootInfo::kUnknownVreg, stack_visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003912 }
3913 }
3914
3915 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3916 REQUIRES_SHARED(Locks::mutator_lock_) {
3917 const size_t stack_offset = stack_index * kFrameSlotSize;
3918 FindWithType(stack_offset,
3919 DexRegisterLocation::Kind::kInStack,
3920 ref,
3921 stack_visitor);
3922 }
3923
3924 void VisitRegister(mirror::Object** ref,
3925 size_t register_index,
3926 const StackVisitor* stack_visitor)
3927 REQUIRES_SHARED(Locks::mutator_lock_) {
3928 FindWithType(register_index,
3929 DexRegisterLocation::Kind::kInRegister,
3930 ref,
3931 stack_visitor);
3932 }
3933
3934 size_t number_of_dex_registers;
3935 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003936 DexRegisterMap dex_register_map;
3937 RootVisitor& visitor;
3938 };
3939 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3940 }
3941
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003942 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003943 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003944};
3945
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003946class RootCallbackVisitor {
3947 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003948 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003949
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003950 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003951 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003952 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003953 }
3954
3955 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003956 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003957 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003958};
3959
Andreas Gampe585da952016-12-02 14:52:29 -08003960template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003961void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003962 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003963 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003964 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003965 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003966 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003967 }
Alex Light848574c2017-09-25 16:59:39 -07003968 if (tlsPtr_.async_exception != nullptr) {
3969 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3970 RootInfo(kRootNativeStack, thread_id));
3971 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003972 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003973 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3974 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003975 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003976 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003977 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003978 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003979 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003980 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003981 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003982 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003983 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3984 record != nullptr;
3985 record = record->GetLink()) {
3986 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3987 shadow_frame != nullptr;
3988 shadow_frame = shadow_frame->GetLink()) {
3989 mapper.VisitShadowFrame(shadow_frame);
3990 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003991 }
3992 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003993 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3994 record != nullptr;
3995 record = record->GetLink()) {
3996 if (record->IsReference()) {
3997 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003998 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003999 }
Mingyao Yang99170c62015-07-06 11:10:37 -07004000 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
4001 RootInfo(kRootThreadObject, thread_id));
4002 }
4003 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
4004 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08004005 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07004006 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
4007 record != nullptr;
4008 record = record->GetNext()) {
4009 mapper.VisitShadowFrame(record->GetShadowFrame());
4010 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004011 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004012 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
4013 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004014 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004015 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004016 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004017 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004018 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004019 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07004020 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004021 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004022 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004023}
4024
Andreas Gampe585da952016-12-02 14:52:29 -08004025void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4026 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004027 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004028 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004029 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004030 }
4031}
4032
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004033class VerifyRootVisitor : public SingleRootVisitor {
4034 public:
4035 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004036 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004037 VerifyObject(root);
4038 }
4039};
jeffhao25045522012-03-13 19:34:37 -07004040
Ian Rogers04d7aa92013-03-16 14:29:17 -07004041void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004042 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4043 VerifyRootVisitor visitor;
4044 std::unique_ptr<Context> context(Context::Create());
4045 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4046 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4047 mapper.WalkStack();
4048 }
jeffhao25045522012-03-13 19:34:37 -07004049}
jeffhao25045522012-03-13 19:34:37 -07004050
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004051// Set the stack end to that to be used during a stack overflow
4052void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004053 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004054 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004055 // However, we seem to have already extended to use the full stack.
4056 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004057 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004058 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004059 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004060 }
4061
Ian Rogersdd7624d2014-03-14 17:43:00 -07004062 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004063
4064 // Remove the stack overflow protection if is it set up.
4065 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4066 if (implicit_stack_check) {
4067 if (!UnprotectStack()) {
4068 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4069 }
4070 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004071}
4072
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004073void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004074 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004075 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004076 tlsPtr_.thread_local_start = start;
4077 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4078 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004079 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004080 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004081}
4082
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004083bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004084 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004085 if (has_tlab) {
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 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004088 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004089 }
4090 return has_tlab;
4091}
4092
Elliott Hughes330304d2011-08-12 14:28:05 -07004093std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004094 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004095 return os;
4096}
4097
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004098bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004099 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4100 VLOG(threads) << "Protecting stack at " << pregion;
4101 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004102 if (fatal_on_error) {
4103 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4104 "Reason: "
4105 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4106 }
4107 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004108 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004109 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004110}
4111
4112bool Thread::UnprotectStack() {
4113 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4114 VLOG(threads) << "Unprotecting stack at " << pregion;
4115 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4116}
4117
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004118void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4119 CHECK(Dbg::IsDebuggerActive());
4120 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4121 CHECK(ssc != nullptr);
4122 tlsPtr_.single_step_control = ssc;
4123}
4124
4125void Thread::DeactivateSingleStepControl() {
4126 CHECK(Dbg::IsDebuggerActive());
4127 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4128 SingleStepControl* ssc = GetSingleStepControl();
4129 tlsPtr_.single_step_control = nullptr;
4130 delete ssc;
4131}
Dave Allison648d7112014-07-25 16:15:27 -07004132
Sebastien Hertz1558b572015-02-25 15:05:59 +01004133void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4134 CHECK(Dbg::IsDebuggerActive());
4135 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4136 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4137 CHECK(req != nullptr);
4138 tlsPtr_.debug_invoke_req = req;
4139}
4140
4141void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004142 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4143 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004144 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004145 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004146 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004147}
4148
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004149void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4150 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004151 tlsPtr_.method_verifier = verifier;
4152}
4153
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004154void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004155 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004156 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004157}
4158
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004159size_t Thread::NumberOfHeldMutexes() const {
4160 size_t count = 0;
4161 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004162 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004163 }
4164 return count;
4165}
4166
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004167void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4168 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4169 ClearException();
4170 ShadowFrame* shadow_frame =
4171 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004172 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004173 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004174 DeoptimizationMethodType method_type;
4175 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004176 SetTopOfStack(nullptr);
4177 SetTopOfShadowStack(shadow_frame);
4178
4179 // Restore the exception that was pending before deoptimization then interpret the
4180 // deoptimized frames.
4181 if (pending_exception != nullptr) {
4182 SetException(pending_exception);
4183 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004184 interpreter::EnterInterpreterFromDeoptimize(this,
4185 shadow_frame,
4186 result,
4187 from_code,
4188 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004189}
4190
Alex Light848574c2017-09-25 16:59:39 -07004191void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4192 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004193 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004194 if (kIsDebugBuild) {
4195 // Make sure we are in a checkpoint.
4196 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4197 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4198 << "It doesn't look like this was called in a checkpoint! this: "
4199 << this << " count: " << GetSuspendCount();
4200 }
4201 tlsPtr_.async_exception = new_exception.Ptr();
4202}
4203
4204bool Thread::ObserveAsyncException() {
4205 DCHECK(this == Thread::Current());
4206 if (tlsPtr_.async_exception != nullptr) {
4207 if (tlsPtr_.exception != nullptr) {
4208 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4209 << tlsPtr_.exception->Dump();
4210 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4211 }
4212 tlsPtr_.exception = tlsPtr_.async_exception;
4213 tlsPtr_.async_exception = nullptr;
4214 return true;
4215 } else {
4216 return IsExceptionPending();
4217 }
4218}
4219
Mathieu Chartier0795f232016-09-27 18:43:30 -07004220void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004221 CHECK(new_exception != nullptr);
4222 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004223 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004224}
4225
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004226bool Thread::IsAotCompiler() {
4227 return Runtime::Current()->IsAotCompiler();
4228}
4229
Andreas Gampe202f85a2017-02-06 10:23:26 -08004230mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004231 DCHECK(tlsPtr_.jpeer == nullptr);
4232 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004233 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4234 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4235 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4236 // mark/forward it here.
4237 peer = art::ReadBarrier::Mark(peer);
4238 }
4239 return peer;
4240}
4241
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004242void Thread::SetReadBarrierEntrypoints() {
4243 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004244 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004245}
4246
David Srbecky912f36c2018-09-08 12:22:58 +01004247void Thread::ClearAllInterpreterCaches() {
4248 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004249 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004250 thread->GetInterpreterCache()->Clear(thread);
4251 }
4252 } closure;
4253 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4254}
4255
Orion Hodson119733d2019-01-30 15:14:41 +00004256
Andreas Gampee5d23982019-01-08 10:34:26 -08004257void Thread::ReleaseLongJumpContextInternal() {
4258 // Each QuickExceptionHandler gets a long jump context and uses
4259 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4260 // Both finding catch blocks and deoptimization can trigger another
4261 // exception such as a result of class loading. So there can be nested
4262 // cases of exception handling and multiple contexts being used.
4263 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4264 // for reuse so there is no need to always allocate a new one each time when
4265 // getting a context. Since we only keep one context for reuse, delete the
4266 // existing one since the passed in context is yet to be used for longjump.
4267 delete tlsPtr_.long_jump_context;
4268}
4269
Orion Hodson119733d2019-01-30 15:14:41 +00004270void Thread::SetNativePriority(int new_priority) {
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004271 PaletteStatus status = PaletteSchedSetPriority(GetTid(), new_priority);
Orion Hodson119733d2019-01-30 15:14:41 +00004272 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4273}
4274
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004275int Thread::GetNativePriority() const {
Orion Hodson119733d2019-01-30 15:14:41 +00004276 int priority = 0;
Nicolas Geoffrayfa595882019-08-06 17:40:09 +01004277 PaletteStatus status = PaletteSchedGetPriority(GetTid(), &priority);
Orion Hodson119733d2019-01-30 15:14:41 +00004278 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