blob: bdbb69777d8793c2e84ef4e6bc9eb1084584e6d5 [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
Ian Rogersb033c752011-07-20 12:22:35 -070019#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070020#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080021#include <sys/resource.h>
22#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070023
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -070024#if __has_feature(hwaddress_sanitizer)
25#include <sanitizer/hwasan_interface.h>
26#else
27#define __hwasan_tag_pointer(p, t) (p)
28#endif
29
Carl Shapirob5573532011-07-12 18:22:59 -070030#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070031#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070032#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070033#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070034#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070035#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070036
Andreas Gampe46ee31b2016-12-14 10:11:49 -080037#include "android-base/stringprintf.h"
Evan Chengd57c51e2018-01-26 15:43:08 +080038#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080039
Mathieu Chartiera62b4532017-04-26 13:16:25 -070040#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070041#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070042#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070043#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000044#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010045#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010046#include "base/casts.h"
Andreas Gampee5d23982019-01-08 10:34:26 -080047#include "arch/context.h"
David Sehr891a50e2017-10-27 17:01:07 -070048#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070049#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080050#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070051#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070052#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080053#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070054#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080055#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080056#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010057#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070058#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080059#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080060#include "dex/dex_file-inl.h"
61#include "dex/dex_file_annotations.h"
62#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070063#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080064#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070065#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000066#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070067#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070068#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070069#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070070#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070071#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070072#include "indirect_reference_table-inl.h"
Andreas Gamped77abd92019-01-02 16:10:20 -080073#include "instrumentation.h"
Steven Morelande431e272017-07-18 16:53:49 -070074#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010075#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010076#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070077#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010078#include "jni/java_vm_ext.h"
79#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070080#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070081#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070082#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080083#include "mirror/object_array-inl.h"
84#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070085#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080086#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070087#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070088#include "nativehelper/scoped_local_ref.h"
89#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070090#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010091#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070092#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070093#include "object_lock.h"
Orion Hodson119733d2019-01-30 15:14:41 +000094#include "palette/palette.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010095#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070096#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080097#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050098#include "reflection.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010099#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700100#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800101#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700102#include "scoped_thread_state_change-inl.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700103#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100104#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700105#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700106#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700107#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800108#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700109#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700110
Yu Lieac44242015-06-29 10:50:03 +0800111#if ART_USE_FUTEXES
112#include "linux/futex.h"
113#include "sys/syscall.h"
114#ifndef SYS_futex
115#define SYS_futex __NR_futex
116#endif
117#endif // ART_USE_FUTEXES
118
Carl Shapirob5573532011-07-12 18:22:59 -0700119namespace art {
120
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800121using android::base::StringAppendV;
122using android::base::StringPrintf;
123
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700124extern "C" NO_RETURN void artDeoptimize(Thread* self);
125
Ian Rogers0878d652013-04-18 17:38:35 -0700126bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700127pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800128ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700129const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100130bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100131Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100132
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700133static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700134
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700135// For implicit overflow checks we reserve an extra piece of memory at the bottom
136// of the stack (lowest memory). The higher portion of the memory
137// is protected against reads and the lower is available for use while
138// throwing the StackOverflow exception.
139constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
140
Elliott Hughes7dc51662012-05-16 14:48:43 -0700141static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
142
Ian Rogers5d76c432011-10-31 21:42:49 -0700143void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700144 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700145}
146
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700147static void UnimplementedEntryPoint() {
148 UNIMPLEMENTED(FATAL);
149}
150
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700151void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700152void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800153
154void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
155 CHECK(kUseReadBarrier);
156 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700157 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800158 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800159}
Ian Rogers7655f292013-07-29 11:07:13 -0700160
Ian Rogers848871b2013-08-05 10:56:33 -0700161void Thread::InitTlsEntryPoints() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800162 ScopedTrace trace("InitTlsEntryPoints");
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700163 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700164 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800165 uintptr_t* end = reinterpret_cast<uintptr_t*>(
166 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700167 for (uintptr_t* it = begin; it != end; ++it) {
168 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
169 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700170 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700171}
172
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800173void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000174 if (kUseReadBarrier && kRuntimeISA != InstructionSet::kX86_64) {
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800175 // Allocation entrypoint switching is currently only implemented for X86_64.
176 is_marking = true;
177 }
178 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700179}
180
Sebastien Hertz07474662015-08-25 15:12:33 +0000181class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200182 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100183 DeoptimizationContextRecord(const JValue& ret_val,
184 bool is_reference,
185 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800186 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700187 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000188 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100189 : ret_val_(ret_val),
190 is_reference_(is_reference),
191 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800192 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700193 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000194 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200195
196 JValue GetReturnValue() const { return ret_val_; }
197 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100198 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800199 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000200 DeoptimizationContextRecord* GetLink() const { return link_; }
201 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200202 DCHECK(is_reference_);
203 return ret_val_.GetGCRoot();
204 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000205 mirror::Object** GetPendingExceptionAsGCRoot() {
206 return reinterpret_cast<mirror::Object**>(&pending_exception_);
207 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700208 DeoptimizationMethodType GetDeoptimizationMethodType() const {
209 return deopt_method_type_;
210 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200211
212 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000213 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200214 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200215
Sebastien Hertz07474662015-08-25 15:12:33 +0000216 // Indicates whether the returned value is a reference. If so, the GC will visit it.
217 const bool is_reference_;
218
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100219 // Whether the context was created from an explicit deoptimization in the code.
220 const bool from_code_;
221
Sebastien Hertz07474662015-08-25 15:12:33 +0000222 // The exception that was pending before deoptimization (or null if there was no pending
223 // exception).
224 mirror::Throwable* pending_exception_;
225
Mingyao Yang2ee17902017-08-30 11:37:08 -0700226 // Whether the context was created for an (idempotent) runtime method.
227 const DeoptimizationMethodType deopt_method_type_;
228
Sebastien Hertz07474662015-08-25 15:12:33 +0000229 // A link to the previous DeoptimizationContextRecord.
230 DeoptimizationContextRecord* const link_;
231
232 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200233};
234
235class StackedShadowFrameRecord {
236 public:
237 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
238 StackedShadowFrameType type,
239 StackedShadowFrameRecord* link)
240 : shadow_frame_(shadow_frame),
241 type_(type),
242 link_(link) {}
243
244 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
245 StackedShadowFrameType GetType() const { return type_; }
246 StackedShadowFrameRecord* GetLink() const { return link_; }
247
248 private:
249 ShadowFrame* const shadow_frame_;
250 const StackedShadowFrameType type_;
251 StackedShadowFrameRecord* const link_;
252
253 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
254};
255
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100256void Thread::PushDeoptimizationContext(const JValue& return_value,
257 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700258 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100259 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700260 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000261 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
262 return_value,
263 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100264 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000265 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700266 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000267 tlsPtr_.deoptimization_context_stack);
268 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700269}
270
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100271void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800272 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700273 bool* from_code,
274 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000275 AssertHasDeoptimizationContext();
276 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
277 tlsPtr_.deoptimization_context_stack = record->GetLink();
278 result->SetJ(record->GetReturnValue().GetJ());
279 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100280 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700281 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700282 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000283}
284
285void Thread::AssertHasDeoptimizationContext() {
286 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
287 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800288}
289
Charles Mungeraa31f492018-11-01 18:57:38 +0000290enum {
291 kPermitAvailable = 0, // Incrementing consumes the permit
292 kNoPermit = 1, // Incrementing marks as waiter waiting
293 kNoPermitWaiterWaiting = 2
294};
295
296void Thread::Park(bool is_absolute, int64_t time) {
297 DCHECK(this == Thread::Current());
298#if ART_USE_FUTEXES
299 // Consume the permit, or mark as waiting. This cannot cause park_state to go
300 // outside of its valid range (0, 1, 2), because in all cases where 2 is
301 // assigned it is set back to 1 before returning, and this method cannot run
302 // concurrently with itself since it operates on the current thread.
303 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
304 if (old_state == kNoPermit) {
305 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800306 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Munger5cc0e752018-11-09 12:30:46 -0800307 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000308 if (!is_absolute && time == 0) {
309 // Thread.getState() is documented to return waiting for untimed parks.
310 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
311 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
Charles Mungered19c672019-02-21 15:32:32 -0800312 int result = futex(tls32_.park_state_.Address(),
Charles Mungeraa31f492018-11-01 18:57:38 +0000313 FUTEX_WAIT_PRIVATE,
314 /* sleep if val = */ kNoPermitWaiterWaiting,
315 /* timeout */ nullptr,
316 nullptr,
317 0);
Charles Mungered19c672019-02-21 15:32:32 -0800318 // This errno check must happen before the scope is closed, to ensure that
319 // no destructors (such as ScopedThreadSuspension) overwrite errno.
320 if (result == -1) {
321 switch (errno) {
322 case EAGAIN:
323 FALLTHROUGH_INTENDED;
324 case EINTR: break; // park() is allowed to spuriously return
325 default: PLOG(FATAL) << "Failed to park";
326 }
327 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000328 } else if (time > 0) {
329 // Only actually suspend and futex_wait if we're going to wait for some
330 // positive amount of time - the kernel will reject negative times with
331 // EINVAL, and a zero time will just noop.
332
333 // Thread.getState() is documented to return timed wait for timed parks.
334 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
335 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
336 timespec timespec;
Charles Mungered19c672019-02-21 15:32:32 -0800337 int result = 0;
Charles Mungeraa31f492018-11-01 18:57:38 +0000338 if (is_absolute) {
339 // Time is millis when scheduled for an absolute time
340 timespec.tv_nsec = (time % 1000) * 1000000;
341 timespec.tv_sec = time / 1000;
342 // This odd looking pattern is recommended by futex documentation to
343 // wait until an absolute deadline, with otherwise identical behavior to
344 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
345 // correct time when the system clock changes.
346 result = futex(tls32_.park_state_.Address(),
347 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
348 /* sleep if val = */ kNoPermitWaiterWaiting,
349 &timespec,
350 nullptr,
351 FUTEX_BITSET_MATCH_ANY);
352 } else {
353 // Time is nanos when scheduled for a relative time
354 timespec.tv_sec = time / 1000000000;
355 timespec.tv_nsec = time % 1000000000;
356 result = futex(tls32_.park_state_.Address(),
357 FUTEX_WAIT_PRIVATE,
358 /* sleep if val = */ kNoPermitWaiterWaiting,
359 &timespec,
360 nullptr,
361 0);
362 }
Charles Mungered19c672019-02-21 15:32:32 -0800363 // This errno check must happen before the scope is closed, to ensure that
364 // no destructors (such as ScopedThreadSuspension) overwrite errno.
365 if (result == -1) {
366 switch (errno) {
367 case ETIMEDOUT:
368 timed_out = true;
369 FALLTHROUGH_INTENDED;
370 case EAGAIN:
371 case EINTR: break; // park() is allowed to spuriously return
372 default: PLOG(FATAL) << "Failed to park";
373 }
Charles Mungeraa31f492018-11-01 18:57:38 +0000374 }
375 }
376 // Mark as no longer waiting, and consume permit if there is one.
377 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
378 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800379 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000380 } else {
381 // the fetch_add has consumed the permit. immediately return.
382 DCHECK_EQ(old_state, kPermitAvailable);
383 }
384#else
385 #pragma clang diagnostic push
386 #pragma clang diagnostic warning "-W#warnings"
387 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
388 #pragma clang diagnostic pop
389 UNUSED(is_absolute, time);
390 UNIMPLEMENTED(WARNING);
391 sched_yield();
392#endif
393}
394
395void Thread::Unpark() {
396#if ART_USE_FUTEXES
397 // Set permit available; will be consumed either by fetch_add (when the thread
398 // tries to park) or store (when the parked thread is woken up)
399 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
400 == kNoPermitWaiterWaiting) {
401 int result = futex(tls32_.park_state_.Address(),
402 FUTEX_WAKE_PRIVATE,
403 /* number of waiters = */ 1,
404 nullptr,
405 nullptr,
406 0);
407 if (result == -1) {
408 PLOG(FATAL) << "Failed to unpark";
409 }
410 }
411#else
412 UNIMPLEMENTED(WARNING);
413#endif
414}
415
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700416void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
417 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
418 sf, type, tlsPtr_.stacked_shadow_frame_record);
419 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800420}
421
Andreas Gampe639bdd12015-06-03 11:22:45 -0700422ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700423 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700424 if (must_be_present) {
425 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700426 } else {
427 if (record == nullptr || record->GetType() != type) {
428 return nullptr;
429 }
430 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700431 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
432 ShadowFrame* shadow_frame = record->GetShadowFrame();
433 delete record;
434 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700435}
436
Mingyao Yang99170c62015-07-06 11:10:37 -0700437class FrameIdToShadowFrame {
438 public:
439 static FrameIdToShadowFrame* Create(size_t frame_id,
440 ShadowFrame* shadow_frame,
441 FrameIdToShadowFrame* next,
442 size_t num_vregs) {
443 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
444 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
445 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
446 }
447
448 static void Delete(FrameIdToShadowFrame* f) {
449 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
450 delete[] memory;
451 }
452
453 size_t GetFrameId() const { return frame_id_; }
454 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
455 FrameIdToShadowFrame* GetNext() const { return next_; }
456 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
457 bool* GetUpdatedVRegFlags() {
458 return updated_vreg_flags_;
459 }
460
461 private:
462 FrameIdToShadowFrame(size_t frame_id,
463 ShadowFrame* shadow_frame,
464 FrameIdToShadowFrame* next)
465 : frame_id_(frame_id),
466 shadow_frame_(shadow_frame),
467 next_(next) {}
468
469 const size_t frame_id_;
470 ShadowFrame* const shadow_frame_;
471 FrameIdToShadowFrame* next_;
472 bool updated_vreg_flags_[0];
473
474 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
475};
476
477static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
478 size_t frame_id) {
479 FrameIdToShadowFrame* found = nullptr;
480 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
481 if (record->GetFrameId() == frame_id) {
482 if (kIsDebugBuild) {
483 // Sanity check we have at most one record for this frame.
484 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
485 found = record;
486 } else {
487 return record;
488 }
489 }
490 }
491 return found;
492}
493
494ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
495 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
496 tlsPtr_.frame_id_to_shadow_frame, frame_id);
497 if (record != nullptr) {
498 return record->GetShadowFrame();
499 }
500 return nullptr;
501}
502
503// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
504bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
505 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
506 tlsPtr_.frame_id_to_shadow_frame, frame_id);
507 CHECK(record != nullptr);
508 return record->GetUpdatedVRegFlags();
509}
510
511ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
512 uint32_t num_vregs,
513 ArtMethod* method,
514 uint32_t dex_pc) {
515 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
516 if (shadow_frame != nullptr) {
517 return shadow_frame;
518 }
David Sehr709b0702016-10-13 09:12:37 -0700519 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700520 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
521 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
522 shadow_frame,
523 tlsPtr_.frame_id_to_shadow_frame,
524 num_vregs);
525 for (uint32_t i = 0; i < num_vregs; i++) {
526 // Do this to clear all references for root visitors.
527 shadow_frame->SetVRegReference(i, nullptr);
528 // This flag will be changed to true if the debugger modifies the value.
529 record->GetUpdatedVRegFlags()[i] = false;
530 }
531 tlsPtr_.frame_id_to_shadow_frame = record;
532 return shadow_frame;
533}
534
Alex Light184f0752018-07-13 11:18:22 -0700535TLSData* Thread::GetCustomTLS(const char* key) {
536 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
537 auto it = custom_tls_.find(key);
538 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
539}
540
541void Thread::SetCustomTLS(const char* key, TLSData* data) {
542 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
543 // custom_tls_lock_.
544 std::unique_ptr<TLSData> old_data(data);
545 {
546 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
547 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
548 }
549}
550
Mingyao Yang99170c62015-07-06 11:10:37 -0700551void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
552 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
553 if (head->GetFrameId() == frame_id) {
554 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
555 FrameIdToShadowFrame::Delete(head);
556 return;
557 }
558 FrameIdToShadowFrame* prev = head;
559 for (FrameIdToShadowFrame* record = head->GetNext();
560 record != nullptr;
561 prev = record, record = record->GetNext()) {
562 if (record->GetFrameId() == frame_id) {
563 prev->SetNext(record->GetNext());
564 FrameIdToShadowFrame::Delete(record);
565 return;
566 }
567 }
568 LOG(FATAL) << "No shadow frame for frame " << frame_id;
569 UNREACHABLE();
570}
571
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700572void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700573 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700574}
575
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700576void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700577 // One thread (us) survived the fork, but we have a new tid so we need to
578 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700579 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700580}
581
Brian Carlstrom78128a62011-09-15 17:21:19 -0700582void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700583 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700584 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800585 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700586 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800587 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700588 }
589 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700590 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
591 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800592 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700593 // Check that if we got here we cannot be shutting down (as shutdown should never have started
594 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700595 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700596 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
597 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
598 // the runtime in such a case. In case this ever changes, we need to make sure here to
599 // delete the tmp_jni_env, as we own it at this point.
600 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
601 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700602 Runtime::Current()->EndThreadBirth();
603 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700604 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700605 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800606 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800607
608 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700609 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700610 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700611 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
612 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800613 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100614
Andreas Gampe08883de2016-11-08 13:20:52 -0800615 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100616 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000617
Andreas Gampeac30fa22017-01-18 21:02:36 -0800618 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700619
Charles Mungeraa31f492018-11-01 18:57:38 +0000620 // Unpark ourselves if the java peer was unparked before it started (see
621 // b/28845097#comment49 for more information)
622
623 ArtField* unparkedField = jni::DecodeArtField(
624 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
625 bool should_unpark = false;
626 {
627 // Hold the lock here, so that if another thread calls unpark before the thread starts
628 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
629 // which could cause a lost unpark.
630 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
631 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
632 }
633 if (should_unpark) {
634 self->Unpark();
635 }
Ian Rogers365c1022012-06-22 15:05:28 -0700636 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800637 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700638 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700639 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
640 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700641 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700642 // Detach and delete self.
643 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700644
Dave Allison0aded082013-11-07 13:15:11 -0800645 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700646}
647
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700648Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800649 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800650 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100651 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700652 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
653 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700654 if (kIsDebugBuild) {
655 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800656 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700657 Locks::thread_list_lock_->AssertHeld(soa.Self());
658 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700659 }
660 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800661}
662
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700663Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
664 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100665 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700666}
667
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700668static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700669 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700670 if (stack_size == 0) {
671 stack_size = Runtime::Current()->GetDefaultStackSize();
672 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700673
Brian Carlstrom6414a972012-04-14 14:20:04 -0700674 // Dalvik used the bionic pthread default stack size for native threads,
675 // so include that here to support apps that expect large native stacks.
676 stack_size += 1 * MB;
677
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700678 // Under sanitization, frames of the interpreter may become bigger, both for C code as
679 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
680 // of all core classes cannot be done in all test circumstances.
681 if (kMemoryToolIsAvailable) {
682 stack_size = std::max(2 * MB, stack_size);
683 }
684
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700685 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
686 if (stack_size < PTHREAD_STACK_MIN) {
687 stack_size = PTHREAD_STACK_MIN;
688 }
689
Dave Allisonf9439142014-03-27 15:10:22 -0700690 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
691 // It's likely that callers are trying to ensure they have at least a certain amount of
692 // stack space, so we should add our reserved space on top of what they requested, rather
693 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700694 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700695 } else {
696 // If we are going to use implicit stack checks, allocate space for the protected
697 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000698 stack_size += Thread::kStackOverflowImplicitCheckSize +
699 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700700 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700701
702 // Some systems require the stack size to be a multiple of the system page size, so round up.
703 stack_size = RoundUp(stack_size, kPageSize);
704
705 return stack_size;
706}
707
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700708// Return the nearest page-aligned address below the current stack top.
709NO_INLINE
710static uint8_t* FindStackTop() {
711 return reinterpret_cast<uint8_t*>(
712 AlignDown(__builtin_frame_address(0), kPageSize));
713}
714
Dave Allisonf9439142014-03-27 15:10:22 -0700715// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700716// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700717ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700718void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700719 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700720 // Page containing current top of stack.
721 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700722
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700723 // Try to directly protect the stack.
724 VLOG(threads) << "installing stack protected region at " << std::hex <<
725 static_cast<void*>(pregion) << " to " <<
726 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700727 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700728 // Tell the kernel that we won't be needing these pages any more.
729 // NB. madvise will probably write zeroes into the memory (on linux it does).
730 uint32_t unwanted_size = stack_top - pregion - kPageSize;
731 madvise(pregion, unwanted_size, MADV_DONTNEED);
732 return;
733 }
734
735 // There is a little complexity here that deserves a special mention. On some
736 // architectures, the stack is created using a VM_GROWSDOWN flag
737 // to prevent memory being allocated when it's not needed. This flag makes the
738 // kernel only allocate memory for the stack by growing down in memory. Because we
739 // want to put an mprotected region far away from that at the stack top, we need
740 // to make sure the pages for the stack are mapped in before we call mprotect.
741 //
742 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
743 // with a non-mapped stack (usually only the main thread).
744 //
745 // We map in the stack by reading every page from the stack bottom (highest address)
746 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700747 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700748 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700749 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
750 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
751 // thus have to move the stack pointer. We do this portably by using a recursive function with a
752 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700753
Andreas Gampe6c63f862017-06-28 17:20:15 -0700754 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700755 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700756 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000757
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700758 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
759 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000760
Andreas Gampe6c63f862017-06-28 17:20:15 -0700761 struct RecurseDownStack {
762 // This function has an intentionally large stack size.
763#pragma GCC diagnostic push
764#pragma GCC diagnostic ignored "-Wframe-larger-than="
765 NO_INLINE
766 static void Touch(uintptr_t target) {
767 volatile size_t zero = 0;
768 // Use a large local volatile array to ensure a large frame size. Do not use anything close
769 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
770 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700771 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
772 constexpr size_t kAsanMultiplier =
773#ifdef ADDRESS_SANITIZER
774 2u;
775#else
776 1u;
777#endif
778 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700779 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700780 // Remove tag from the pointer. Nop in non-hwasan builds.
781 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
782 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700783 Touch(target);
784 }
785 zero *= 2; // Try to avoid tail recursion.
786 }
787#pragma GCC diagnostic pop
788 };
789 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000790
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700791 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700792 static_cast<void*>(pregion) << " to " <<
793 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
794
Dave Allison648d7112014-07-25 16:15:27 -0700795 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700796 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700797
798 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000799 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700800 uint32_t unwanted_size = stack_top - pregion - kPageSize;
801 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700802}
803
Ian Rogers120f1c72012-09-28 17:17:10 -0700804void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800805 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800806 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700807
808 if (VLOG_IS_ON(threads)) {
809 ScopedObjectAccess soa(env);
810
Andreas Gampe08883de2016-11-08 13:20:52 -0800811 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700812 ObjPtr<mirror::String> java_name =
813 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700814 std::string thread_name;
815 if (java_name != nullptr) {
816 thread_name = java_name->ToModifiedUtf8();
817 } else {
818 thread_name = "(Unnamed)";
819 }
820
821 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700822 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700823 }
824
Ian Rogers120f1c72012-09-28 17:17:10 -0700825 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700826
Ian Rogers120f1c72012-09-28 17:17:10 -0700827 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
828 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700829 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700830 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700831 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700832 thread_start_during_shutdown = true;
833 } else {
834 runtime->StartThreadBirth();
835 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700836 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700837 if (thread_start_during_shutdown) {
838 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
839 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
840 return;
841 }
842
843 Thread* child_thread = new Thread(is_daemon);
844 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700845 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700846 stack_size = FixStackSize(stack_size);
847
Roland Levillain2ae376f2018-01-30 11:35:11 +0000848 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
849 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800850 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
851 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700852
Andreas Gampe449357d2015-06-01 22:29:51 -0700853 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
854 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100855 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700856 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100857 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700858
Andreas Gampe449357d2015-06-01 22:29:51 -0700859 int pthread_create_result = 0;
860 if (child_jni_env_ext.get() != nullptr) {
861 pthread_t new_pthread;
862 pthread_attr_t attr;
863 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
864 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
865 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
866 "PTHREAD_CREATE_DETACHED");
867 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
868 pthread_create_result = pthread_create(&new_pthread,
869 &attr,
870 Thread::CreateCallback,
871 child_thread);
872 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
873
874 if (pthread_create_result == 0) {
875 // pthread_create started the new thread. The child is now responsible for managing the
876 // JNIEnvExt we created.
877 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
878 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700879 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700880 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700881 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700882 }
883
884 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
885 {
886 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
887 runtime->EndThreadBirth();
888 }
889 // Manually delete the global reference since Thread::Init will not have been run.
890 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
891 child_thread->tlsPtr_.jpeer = nullptr;
892 delete child_thread;
893 child_thread = nullptr;
894 // TODO: remove from thread group?
895 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
896 {
897 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100898 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700899 StringPrintf("pthread_create (%s stack) failed: %s",
900 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
901 ScopedObjectAccess soa(env);
902 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700903 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700904}
905
Andreas Gampe449357d2015-06-01 22:29:51 -0700906bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700907 // This function does all the initialization that must be run by the native thread it applies to.
908 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
909 // we can handshake with the corresponding native thread when it's ready.) Check this native
910 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800911 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800912
913 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
914 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
915 tlsPtr_.pthread_self = pthread_self();
916 CHECK(is_started_);
917
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800918 ScopedTrace trace("Thread::Init");
919
Elliott Hughesd8af1592012-04-16 20:40:15 -0700920 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800921 if (!InitStackHwm()) {
922 return false;
923 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700924 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700925 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800926 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700927 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700928 InitTid();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800929 {
930 ScopedTrace trace2("InitInterpreterTls");
931 interpreter::InitInterpreterTls(this);
932 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800933
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100934#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000935 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
936#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700937 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000938#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700939 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700940
Ian Rogersdd7624d2014-03-14 17:43:00 -0700941 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700942
Andreas Gampe449357d2015-06-01 22:29:51 -0700943 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800944 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
945 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700946 tlsPtr_.jni_env = jni_env_ext;
947 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100948 std::string error_msg;
949 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700950 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100951 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700952 return false;
953 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700954 }
955
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800956 ScopedTrace trace3("ThreadList::Register");
Ian Rogers120f1c72012-09-28 17:17:10 -0700957 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800958 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700959}
960
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800961template <typename PeerAction>
962Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700963 Runtime* runtime = Runtime::Current();
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800964 ScopedTrace trace("Thread::Attach");
Dave Allison0aded082013-11-07 13:15:11 -0800965 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900966 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
967 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800968 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700969 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800970 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700971 {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -0800972 ScopedTrace trace2("Thread birth");
Dave Allison0aded082013-11-07 13:15:11 -0800973 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700974 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900975 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
976 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800977 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700978 } else {
979 Runtime::Current()->StartThreadBirth();
980 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800981 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700982 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800983 if (!init_success) {
984 delete self;
985 return nullptr;
986 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700987 }
988 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700989
Jeff Hao848f70a2014-01-15 13:49:50 -0800990 self->InitStringEntryPoints();
991
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700992 CHECK_NE(self->GetState(), kRunnable);
993 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700994
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800995 // Run the action that is acting on the peer.
996 if (!peer_action(self)) {
997 runtime->GetThreadList()->Unregister(self);
998 // Unregister deletes self, no need to do this here.
999 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001000 }
Elliott Hughescac6cc72011-11-03 20:31:21 -07001001
Andreas Gampe56623832015-07-09 21:53:15 -07001002 if (VLOG_IS_ON(threads)) {
1003 if (thread_name != nullptr) {
1004 VLOG(threads) << "Attaching thread " << thread_name;
1005 } else {
1006 VLOG(threads) << "Attaching unnamed thread.";
1007 }
1008 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001009 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -07001010 }
1011
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001012 {
1013 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -08001014 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +02001015 }
1016
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001017 return self;
1018}
1019
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001020Thread* Thread::Attach(const char* thread_name,
1021 bool as_daemon,
1022 jobject thread_group,
1023 bool create_peer) {
1024 auto create_peer_action = [&](Thread* self) {
1025 // If we're the main thread, ClassLinker won't be created until after we're attached,
1026 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1027 // In the compiler, all threads need this hack, because no-one's going to be getting
1028 // a native peer!
1029 if (create_peer) {
1030 self->CreatePeer(thread_name, as_daemon, thread_group);
1031 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001032 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1033 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001034 {
1035 ScopedObjectAccess soa(self);
1036 LOG(ERROR) << "Exception creating thread peer:";
1037 LOG(ERROR) << self->GetException()->Dump();
1038 self->ClearException();
1039 }
1040 return false;
1041 }
1042 } else {
1043 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1044 if (thread_name != nullptr) {
1045 self->tlsPtr_.name->assign(thread_name);
1046 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001047 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001048 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1049 }
1050 }
1051 return true;
1052 };
1053 return Attach(thread_name, as_daemon, create_peer_action);
1054}
1055
1056Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1057 auto set_peer_action = [&](Thread* self) {
1058 // Install the given peer.
1059 {
1060 DCHECK(self == Thread::Current());
1061 ScopedObjectAccess soa(self);
1062 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1063 }
1064 self->GetJniEnv()->SetLongField(thread_peer,
1065 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001066 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001067 return true;
1068 };
1069 return Attach(thread_name, as_daemon, set_peer_action);
1070}
1071
Ian Rogers365c1022012-06-22 15:05:28 -07001072void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1073 Runtime* runtime = Runtime::Current();
1074 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001075 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001076
Dave Allison0aded082013-11-07 13:15:11 -08001077 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001078 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001079 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001080 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001081 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001082 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001083 CHECK(IsExceptionPending());
1084 return;
1085 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001086 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001087 jboolean thread_is_daemon = as_daemon;
1088
Elliott Hugheseac76672012-05-24 21:56:51 -07001089 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001090 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001091 CHECK(IsExceptionPending());
1092 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001093 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001094 {
1095 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001096 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001097 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001098 env->CallNonvirtualVoidMethod(peer.get(),
1099 WellKnownClasses::java_lang_Thread,
1100 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001101 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001102 if (IsExceptionPending()) {
1103 return;
1104 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001105
Ian Rogers120f1c72012-09-28 17:17:10 -07001106 Thread* self = this;
1107 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001108 env->SetLongField(peer.get(),
1109 WellKnownClasses::java_lang_Thread_nativePeer,
1110 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001111
1112 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001113 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001114 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001115 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001116 // The Thread constructor should have set the Thread.name to a
1117 // non-null value. However, because we can run without code
1118 // available (in the compiler, in tests), we manually assign the
1119 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001120 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001121 InitPeer<true>(soa,
1122 tlsPtr_.opeer,
1123 thread_is_daemon,
1124 thread_group,
1125 thread_name.get(),
1126 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001127 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001128 InitPeer<false>(soa,
1129 tlsPtr_.opeer,
1130 thread_is_daemon,
1131 thread_group,
1132 thread_name.get(),
1133 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001134 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001135 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001136 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001137 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001138 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001139 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001140 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001141}
1142
Andreas Gampebad529d2017-02-13 18:52:10 -08001143jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1144 const char* name,
1145 bool as_daemon,
1146 jobject thread_group) {
1147 Runtime* runtime = Runtime::Current();
1148 CHECK(!runtime->IsStarted());
1149
1150 if (thread_group == nullptr) {
1151 thread_group = runtime->GetMainThreadGroup();
1152 }
1153 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1154 // Add missing null check in case of OOM b/18297817
1155 if (name != nullptr && thread_name.get() == nullptr) {
1156 CHECK(Thread::Current()->IsExceptionPending());
1157 return nullptr;
1158 }
Andreas Gampea1e5b972019-03-18 16:54:25 -07001159 jint thread_priority = kNormThreadPriority; // Always normalize to NORM priority.
Andreas Gampebad529d2017-02-13 18:52:10 -08001160 jboolean thread_is_daemon = as_daemon;
1161
1162 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1163 if (peer.get() == nullptr) {
1164 CHECK(Thread::Current()->IsExceptionPending());
1165 return nullptr;
1166 }
1167
1168 // We cannot call Thread.init, as it will recursively ask for currentThread.
1169
1170 // The Thread constructor should have set the Thread.name to a
1171 // non-null value. However, because we can run without code
1172 // available (in the compiler, in tests), we manually assign the
1173 // fields the constructor should have set.
1174 ScopedObjectAccessUnchecked soa(Thread::Current());
1175 if (runtime->IsActiveTransaction()) {
1176 InitPeer<true>(soa,
1177 soa.Decode<mirror::Object>(peer.get()),
1178 thread_is_daemon,
1179 thread_group,
1180 thread_name.get(),
1181 thread_priority);
1182 } else {
1183 InitPeer<false>(soa,
1184 soa.Decode<mirror::Object>(peer.get()),
1185 thread_is_daemon,
1186 thread_group,
1187 thread_name.get(),
1188 thread_priority);
1189 }
1190
1191 return peer.release();
1192}
1193
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001194template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001195void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1196 ObjPtr<mirror::Object> peer,
1197 jboolean thread_is_daemon,
1198 jobject thread_group,
1199 jobject thread_name,
1200 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001201 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001202 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001203 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001204 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001205 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001206 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001207 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001208 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001209}
1210
Elliott Hughes899e7892012-01-24 14:57:32 -08001211void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001212 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001213 ::art::SetThreadName(name);
1214 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1215}
1216
Andreas Gampe9186ced2016-12-12 14:28:21 -08001217static void GetThreadStack(pthread_t thread,
1218 void** stack_base,
1219 size_t* stack_size,
1220 size_t* guard_size) {
1221#if defined(__APPLE__)
1222 *stack_size = pthread_get_stacksize_np(thread);
1223 void* stack_addr = pthread_get_stackaddr_np(thread);
1224
1225 // Check whether stack_addr is the base or end of the stack.
1226 // (On Mac OS 10.7, it's the end.)
1227 int stack_variable;
1228 if (stack_addr > &stack_variable) {
1229 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1230 } else {
1231 *stack_base = stack_addr;
1232 }
1233
1234 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1235 pthread_attr_t attributes;
1236 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1237 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1238 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1239#else
1240 pthread_attr_t attributes;
1241 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1242 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1243 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1244 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1245
1246#if defined(__GLIBC__)
1247 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1248 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1249 // will be broken because we'll die long before we get close to 2GB.
1250 bool is_main_thread = (::art::GetTid() == getpid());
1251 if (is_main_thread) {
1252 rlimit stack_limit;
1253 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1254 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1255 }
1256 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1257 size_t old_stack_size = *stack_size;
1258
1259 // Use the kernel default limit as our size, and adjust the base to match.
1260 *stack_size = 8 * MB;
1261 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1262
1263 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1264 << " to " << PrettySize(*stack_size)
1265 << " with base " << *stack_base;
1266 }
1267 }
1268#endif
1269
1270#endif
1271}
1272
Ian Rogersf4d4da12014-11-11 16:10:33 -08001273bool Thread::InitStackHwm() {
Mathieu Chartier3a0cd342018-12-13 13:45:17 -08001274 ScopedTrace trace("InitStackHwm");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001275 void* read_stack_base;
1276 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001277 size_t read_guard_size;
1278 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001279
Ian Rogers13735952014-10-08 12:43:28 -07001280 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001281 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001282
Dave Allison648d7112014-07-25 16:15:27 -07001283 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1284 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1285 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1286 // between 8K and 12K.
1287 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1288 + 4 * KB;
1289 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001290 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001291 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1292 __LINE__,
1293 ::android::base::ERROR,
1294 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001295 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001296 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001297
Vladimir Markob8f2f632015-01-02 14:23:26 +00001298 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1299 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1300 read_stack_base,
1301 PrettySize(read_stack_size).c_str(),
1302 PrettySize(read_guard_size).c_str());
1303
Ian Rogers932746a2011-09-22 18:57:50 -07001304 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001305
1306 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001307 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001308
Dave Allisonb090a182014-08-14 17:02:48 +00001309 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001310
1311 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001312 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001313 // The thread might have protected region at the bottom. We need
1314 // to install our own region so we need to move the limits
1315 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001316
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001317 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1318 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1319 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001320
1321 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001322 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001323
1324 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001325 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001326
1327 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001328}
1329
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001330void Thread::ShortDump(std::ostream& os) const {
1331 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001332 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001333 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001334 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001335 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001336 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001337 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001338 << ",Thread*=" << this
1339 << ",peer=" << tlsPtr_.opeer
1340 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1341 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001342}
1343
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001344void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1345 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001346 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001347 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001348}
1349
Vladimir Marko4617d582019-03-28 13:48:31 +00001350ObjPtr<mirror::String> Thread::GetThreadName() const {
Andreas Gampe08883de2016-11-08 13:20:52 -08001351 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001352 if (tlsPtr_.opeer == nullptr) {
1353 return nullptr;
1354 }
1355 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1356 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001357}
1358
Elliott Hughesffb465f2012-03-01 18:46:05 -08001359void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001360 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001361}
1362
Jeff Hao57dac6e2013-08-15 16:36:24 -07001363uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001364#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001365 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001366 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001367 timespec now;
1368 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001369 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001370#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001371 UNIMPLEMENTED(WARNING);
1372 return -1;
1373#endif
1374}
1375
Ian Rogers01ae5802012-09-28 16:14:01 -07001376// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1377static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001378 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001379 Locks::thread_suspend_count_lock_->Unlock(self);
1380 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1381 Locks::mutator_lock_->SharedTryLock(self);
1382 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1383 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1384 }
1385 }
1386 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1387 Locks::thread_list_lock_->TryLock(self);
1388 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1389 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1390 }
1391 }
1392 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001393 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001394 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001395}
1396
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001397bool Thread::ModifySuspendCountInternal(Thread* self,
1398 int delta,
1399 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001400 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001401 if (kIsDebugBuild) {
1402 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001403 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001404 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1405 Locks::thread_suspend_count_lock_->AssertHeld(self);
1406 if (this != self && !IsSuspended()) {
1407 Locks::thread_list_lock_->AssertHeld(self);
1408 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001409 }
Alex Light88fd7202017-06-30 08:31:59 -07001410 // User code suspensions need to be checked more closely since they originate from code outside of
1411 // the runtime's control.
1412 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1413 Locks::user_code_suspension_lock_->AssertHeld(self);
1414 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1415 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1416 return false;
1417 }
1418 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001419 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001420 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001421 return false;
1422 }
1423
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001424 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1425 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1426 // deadlock. b/31683379.
1427 return false;
1428 }
1429
Yu Lieac44242015-06-29 10:50:03 +08001430 uint16_t flags = kSuspendRequest;
1431 if (delta > 0 && suspend_barrier != nullptr) {
1432 uint32_t available_barrier = kMaxSuspendBarriers;
1433 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1434 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1435 available_barrier = i;
1436 break;
1437 }
1438 }
1439 if (available_barrier == kMaxSuspendBarriers) {
1440 // No barrier spaces available, we can't add another.
1441 return false;
1442 }
1443 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1444 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001445 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001446
Ian Rogersdd7624d2014-03-14 17:43:00 -07001447 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001448 switch (reason) {
1449 case SuspendReason::kForDebugger:
1450 tls32_.debug_suspend_count += delta;
1451 break;
Alex Light88fd7202017-06-30 08:31:59 -07001452 case SuspendReason::kForUserCode:
1453 tls32_.user_code_suspend_count += delta;
1454 break;
Alex Light46f93402017-06-29 11:59:50 -07001455 case SuspendReason::kInternal:
1456 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001457 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001458
Ian Rogersdd7624d2014-03-14 17:43:00 -07001459 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001460 AtomicClearFlag(kSuspendRequest);
1461 } else {
Yu Lieac44242015-06-29 10:50:03 +08001462 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001463 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001464 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001465 }
Yu Lieac44242015-06-29 10:50:03 +08001466 return true;
1467}
1468
1469bool Thread::PassActiveSuspendBarriers(Thread* self) {
1470 // Grab the suspend_count lock and copy the current set of
1471 // barriers. Then clear the list and the flag. The ModifySuspendCount
1472 // function requires the lock so we prevent a race between setting
1473 // the kActiveSuspendBarrier flag and clearing it.
1474 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1475 {
1476 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1477 if (!ReadFlag(kActiveSuspendBarrier)) {
1478 // quick exit test: the barriers have already been claimed - this is
1479 // possible as there may be a race to claim and it doesn't matter
1480 // who wins.
1481 // All of the callers of this function (except the SuspendAllInternal)
1482 // will first test the kActiveSuspendBarrier flag without lock. Here
1483 // double-check whether the barrier has been passed with the
1484 // suspend_count lock.
1485 return false;
1486 }
1487
1488 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1489 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1490 tlsPtr_.active_suspend_barriers[i] = nullptr;
1491 }
1492 AtomicClearFlag(kActiveSuspendBarrier);
1493 }
1494
1495 uint32_t barrier_count = 0;
1496 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1497 AtomicInteger* pending_threads = pass_barriers[i];
1498 if (pending_threads != nullptr) {
1499 bool done = false;
1500 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001501 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001502 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1503 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001504 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001505#if ART_USE_FUTEXES
1506 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Charles Munger7530bae2018-10-29 20:03:51 -07001507 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, -1, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001508 }
1509#endif
1510 } while (!done);
1511 ++barrier_count;
1512 }
1513 }
1514 CHECK_GT(barrier_count, 0U);
1515 return true;
1516}
1517
1518void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1519 CHECK(ReadFlag(kActiveSuspendBarrier));
1520 bool clear_flag = true;
1521 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1522 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1523 if (ptr == target) {
1524 tlsPtr_.active_suspend_barriers[i] = nullptr;
1525 } else if (ptr != nullptr) {
1526 clear_flag = false;
1527 }
1528 }
1529 if (LIKELY(clear_flag)) {
1530 AtomicClearFlag(kActiveSuspendBarrier);
1531 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001532}
1533
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001534void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001535 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1536 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1537 Closure* checkpoint;
1538 {
1539 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1540 checkpoint = tlsPtr_.checkpoint_function;
1541 if (!checkpoint_overflow_.empty()) {
1542 // Overflow list not empty, copy the first one out and continue.
1543 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1544 checkpoint_overflow_.pop_front();
1545 } else {
1546 // No overflow checkpoints. Clear the kCheckpointRequest flag
1547 tlsPtr_.checkpoint_function = nullptr;
1548 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001549 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001550 }
1551 // Outside the lock, run the checkpoint function.
1552 ScopedTrace trace("Run checkpoint function");
1553 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1554 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001555}
1556
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001557void Thread::RunEmptyCheckpoint() {
1558 DCHECK_EQ(Thread::Current(), this);
1559 AtomicClearFlag(kEmptyCheckpointRequest);
1560 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1561}
1562
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001563bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001564 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001565 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001566 if (old_state_and_flags.as_struct.state != kRunnable) {
1567 return false; // Fail, thread is suspended and so can't run a checkpoint.
1568 }
Dave Allison0aded082013-11-07 13:15:11 -08001569
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001570 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001571 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001572 union StateAndFlags new_state_and_flags;
1573 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001574 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001575 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001576 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001577 if (success) {
1578 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1579 if (tlsPtr_.checkpoint_function == nullptr) {
1580 tlsPtr_.checkpoint_function = function;
1581 } else {
1582 checkpoint_overflow_.push_back(function);
1583 }
Dave Allison0aded082013-11-07 13:15:11 -08001584 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001585 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001586 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001587 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001588}
1589
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001590bool Thread::RequestEmptyCheckpoint() {
1591 union StateAndFlags old_state_and_flags;
1592 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1593 if (old_state_and_flags.as_struct.state != kRunnable) {
1594 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1595 // heap access (eg. the read barrier).
1596 return false;
1597 }
1598
1599 // We must be runnable to request a checkpoint.
1600 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1601 union StateAndFlags new_state_and_flags;
1602 new_state_and_flags.as_int = old_state_and_flags.as_int;
1603 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001604 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001605 old_state_and_flags.as_int, new_state_and_flags.as_int);
1606 if (success) {
1607 TriggerSuspend();
1608 }
1609 return success;
1610}
1611
Andreas Gampee9f67122016-10-27 19:21:23 -07001612class BarrierClosure : public Closure {
1613 public:
1614 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1615
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001616 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001617 wrapped_->Run(self);
1618 barrier_.Pass(self);
1619 }
1620
Alex Light318afe62018-03-22 16:50:10 -07001621 void Wait(Thread* self, ThreadState suspend_state) {
1622 if (suspend_state != ThreadState::kRunnable) {
1623 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1624 } else {
1625 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1626 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001627 }
1628
1629 private:
1630 Closure* wrapped_;
1631 Barrier barrier_;
1632};
1633
Alex Lightb1e31a82017-10-04 16:57:36 -07001634// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001635bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001636 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001637 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001638 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1639 // Unlock the tll before running so that the state is the same regardless of thread.
1640 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001641 // Asked to run on this thread. Just run.
1642 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001643 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001644 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001645
1646 // The current thread is not this thread.
1647
Andreas Gampe28c4a232017-06-21 21:21:31 -07001648 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001649 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001650 return false;
1651 }
1652
Andreas Gampe28c4a232017-06-21 21:21:31 -07001653 struct ScopedThreadListLockUnlock {
1654 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1655 : self_thread(self_in) {
1656 Locks::thread_list_lock_->AssertHeld(self_thread);
1657 Locks::thread_list_lock_->Unlock(self_thread);
1658 }
1659
1660 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1661 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1662 Locks::thread_list_lock_->Lock(self_thread);
1663 }
1664
1665 Thread* self_thread;
1666 };
1667
Andreas Gampee9f67122016-10-27 19:21:23 -07001668 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001669 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001670 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1671 // suspend-count lock for too long.
1672 if (GetState() == ThreadState::kRunnable) {
1673 BarrierClosure barrier_closure(function);
1674 bool installed = false;
1675 {
1676 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1677 installed = RequestCheckpoint(&barrier_closure);
1678 }
1679 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001680 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1681 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1682 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001683 ScopedThreadStateChange sts(self, suspend_state);
1684 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001685 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001686 }
1687 // Fall-through.
1688 }
1689
1690 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1691 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1692 // certain situations.
1693 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001694 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1695
Alex Light46f93402017-06-29 11:59:50 -07001696 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001697 // Just retry the loop.
1698 sched_yield();
1699 continue;
1700 }
1701 }
1702
Andreas Gampe28c4a232017-06-21 21:21:31 -07001703 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001704 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1705 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001706 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001707 {
Alex Light318afe62018-03-22 16:50:10 -07001708 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001709 while (GetState() == ThreadState::kRunnable) {
1710 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1711 // moves us to suspended.
1712 sched_yield();
1713 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001714 }
1715
1716 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001717 }
1718
Andreas Gampee9f67122016-10-27 19:21:23 -07001719 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001720 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1721
1722 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001723 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001724 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001725 }
1726
Andreas Gampe117f9b32017-06-23 13:33:50 -07001727 {
1728 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1729 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1730 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1731 Thread::resume_cond_->Broadcast(self);
1732 }
1733
Alex Lightb1e31a82017-10-04 16:57:36 -07001734 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1735 Locks::thread_list_lock_->ExclusiveUnlock(self);
1736
Andreas Gampe28c4a232017-06-21 21:21:31 -07001737 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001738 }
1739}
1740
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001741Closure* Thread::GetFlipFunction() {
1742 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1743 Closure* func;
1744 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001745 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001746 if (func == nullptr) {
1747 return nullptr;
1748 }
Orion Hodson4557b382018-01-03 11:47:54 +00001749 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001750 DCHECK(func != nullptr);
1751 return func;
1752}
1753
1754void Thread::SetFlipFunction(Closure* function) {
1755 CHECK(function != nullptr);
1756 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001757 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001758}
1759
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001760void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001761 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001762 VLOG(threads) << this << " self-suspending";
1763 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001764 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001765 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001766 VLOG(threads) << this << " self-reviving";
1767}
1768
Andreas Gampe9186ced2016-12-12 14:28:21 -08001769static std::string GetSchedulerGroupName(pid_t tid) {
1770 // /proc/<pid>/cgroup looks like this:
1771 // 2:devices:/
1772 // 1:cpuacct,cpu:/
1773 // We want the third field from the line whose second field contains the "cpu" token.
1774 std::string cgroup_file;
1775 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1776 return "";
1777 }
1778 std::vector<std::string> cgroup_lines;
1779 Split(cgroup_file, '\n', &cgroup_lines);
1780 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1781 std::vector<std::string> cgroup_fields;
1782 Split(cgroup_lines[i], ':', &cgroup_fields);
1783 std::vector<std::string> cgroups;
1784 Split(cgroup_fields[1], ',', &cgroups);
1785 for (size_t j = 0; j < cgroups.size(); ++j) {
1786 if (cgroups[j] == "cpu") {
1787 return cgroup_fields[2].substr(1); // Skip the leading slash.
1788 }
1789 }
1790 }
1791 return "";
1792}
1793
1794
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001795void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001796 std::string group_name;
1797 int priority;
1798 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001799 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001800
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001801 // If flip_function is not null, it means we have run a checkpoint
1802 // before the thread wakes up to execute the flip function and the
1803 // thread roots haven't been forwarded. So the following access to
1804 // the roots (opeer or methods in the frames) would be bad. Run it
1805 // here. TODO: clean up.
1806 if (thread != nullptr) {
1807 ScopedObjectAccessUnchecked soa(self);
1808 Thread* this_thread = const_cast<Thread*>(thread);
1809 Closure* flip_func = this_thread->GetFlipFunction();
1810 if (flip_func != nullptr) {
1811 flip_func->Run(this_thread);
1812 }
1813 }
1814
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001815 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1816 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001817 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001818 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001819 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001820 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001821 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001822 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001823
Mathieu Chartier3398c782016-09-30 10:27:43 -07001824 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001825 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1826 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001827
Dave Allison0aded082013-11-07 13:15:11 -08001828 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001829 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001830 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001831 ObjPtr<mirror::String> group_name_string =
1832 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001833 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001834 }
1835 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001836 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001837 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001838
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001839 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001840 if (scheduler_group_name.empty()) {
1841 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001842 }
1843
Dave Allison0aded082013-11-07 13:15:11 -08001844 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001845 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001846 if (is_daemon) {
1847 os << " daemon";
1848 }
1849 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001850 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001851 << " " << thread->GetState();
1852 if (thread->IsStillStarting()) {
1853 os << " (still starting up)";
1854 }
1855 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001856 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001857 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001858 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001859 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001860 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001861
Dave Allison0aded082013-11-07 13:15:11 -08001862 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001863 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001864 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001865 << " sCount=" << thread->tls32_.suspend_count
1866 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001867 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001868 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001869 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1870 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001871
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001872 os << " | sysTid=" << tid
1873 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001874 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001875 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001876 int policy;
1877 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001878#if !defined(__APPLE__)
1879 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1880 policy = sched_getscheduler(tid);
1881 if (policy == -1) {
1882 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1883 }
1884 int sched_getparam_result = sched_getparam(tid, &sp);
1885 if (sched_getparam_result == -1) {
1886 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1887 sp.sched_priority = -1;
1888 }
1889#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001890 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1891 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001892#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001893 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001894 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001895 }
1896 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001897
1898 // Grab the scheduler stats for this thread.
1899 std::string scheduler_stats;
Evan Chengd57c51e2018-01-26 15:43:08 +08001900 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)
1901 && !scheduler_stats.empty()) {
1902 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001903 } else {
1904 scheduler_stats = "0 0 0";
1905 }
1906
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001907 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001908 int utime = 0;
1909 int stime = 0;
1910 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001911 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001912
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001913 os << " | state=" << native_thread_state
1914 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001915 << " utm=" << utime
1916 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001917 << " core=" << task_cpu
1918 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001919 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001920 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1921 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1922 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001923 // Dump the held mutexes.
1924 os << " | held mutexes=";
1925 for (size_t i = 0; i < kLockLevelCount; ++i) {
1926 if (i != kMonitorLock) {
1927 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1928 if (mutex != nullptr) {
1929 os << " \"" << mutex->GetName() << "\"";
1930 if (mutex->IsReaderWriterMutex()) {
1931 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001932 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001933 os << "(exclusive held)";
1934 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001935 os << "(shared held)";
1936 }
1937 }
1938 }
1939 }
1940 }
1941 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001942 }
1943}
1944
1945void Thread::DumpState(std::ostream& os) const {
1946 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001947}
1948
Andreas Gampe93104952017-12-13 17:13:15 -08001949struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001950 StackDumpVisitor(std::ostream& os_in,
1951 Thread* thread_in,
1952 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001953 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001954 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001955 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001956 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001957 : MonitorObjectsStackVisitor(thread_in,
1958 context,
1959 check_suspended,
1960 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001961 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001962 last_method(nullptr),
1963 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001964 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001965
Ian Rogersbdb03912011-09-14 00:55:44 -07001966 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001967 if (frame_count == 0) {
1968 os << " (no managed stack frames)\n";
1969 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001970 }
1971
Andreas Gampe93104952017-12-13 17:13:15 -08001972 static constexpr size_t kMaxRepetition = 3u;
1973
1974 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001975 override
Andreas Gampe93104952017-12-13 17:13:15 -08001976 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001977 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001978 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001979 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001980 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001981 const DexFile* dex_file = dex_cache->GetDexFile();
1982 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001983 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001984 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001985 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001986 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001987 if (repetition_count >= kMaxRepetition) {
1988 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1989 }
1990 repetition_count = 0;
1991 last_line_number = line_number;
1992 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001993 }
Andreas Gampe93104952017-12-13 17:13:15 -08001994
1995 if (repetition_count >= kMaxRepetition) {
1996 // Skip visiting=printing anything.
1997 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001998 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001999
Andreas Gampe93104952017-12-13 17:13:15 -08002000 os << " at " << m->PrettyMethod(false);
2001 if (m->IsNative()) {
2002 os << "(Native method)";
2003 } else {
2004 const char* source_file(m->GetDeclaringClassSourceFile());
2005 os << "(" << (source_file != nullptr ? source_file : "unavailable")
2006 << ":" << line_number << ")";
2007 }
2008 os << "\n";
2009 // Go and visit locks.
2010 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002011 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002012
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002013 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08002014 return VisitMethodResult::kContinueMethod;
2015 }
2016
2017 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002018 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002019 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08002020 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2021 }
2022 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002023 override
Andreas Gampe93104952017-12-13 17:13:15 -08002024 REQUIRES_SHARED(Locks::mutator_lock_) {
2025 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2026 }
2027 void VisitBlockedOnObject(mirror::Object* obj,
2028 ThreadState state,
2029 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002030 override
Andreas Gampe93104952017-12-13 17:13:15 -08002031 REQUIRES_SHARED(Locks::mutator_lock_) {
2032 const char* msg;
2033 switch (state) {
2034 case kBlocked:
2035 msg = " - waiting to lock ";
2036 break;
2037
2038 case kWaitingForLockInflation:
2039 msg = " - waiting for lock inflation of ";
2040 break;
2041
2042 default:
2043 LOG(FATAL) << "Unreachable";
2044 UNREACHABLE();
2045 }
2046 PrintObject(obj, msg, owner_tid);
2047 }
2048 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002049 override
Andreas Gampe93104952017-12-13 17:13:15 -08002050 REQUIRES_SHARED(Locks::mutator_lock_) {
2051 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2052 }
2053
2054 void PrintObject(mirror::Object* obj,
2055 const char* msg,
2056 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2057 if (obj == nullptr) {
2058 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002059 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002060 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002061 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2062 // Getting the identity hashcode here would result in lock inflation and suspension of the
2063 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002064 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
2065 reinterpret_cast<intptr_t>(obj),
2066 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002067 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002068 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2069 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2070 // suspension and move pretty_object.
2071 const std::string pretty_type(obj->PrettyTypeOf());
2072 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002073 }
2074 }
Andreas Gampe93104952017-12-13 17:13:15 -08002075 if (owner_tid != ThreadList::kInvalidThreadId) {
2076 os << " held by thread " << owner_tid;
2077 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002078 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002079 }
2080
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002081 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002082 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002083 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002084 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002085};
2086
Ian Rogers33e95662013-05-20 20:29:14 -07002087static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002088 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002089 ThreadState state = thread->GetState();
2090
2091 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2092 if (state > kWaiting && state < kStarting) {
2093 return true;
2094 }
2095
2096 // In an Object.wait variant or Thread.sleep? That's not interesting.
2097 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2098 return false;
2099 }
2100
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002101 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002102 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002103 return true;
2104 }
2105
Elliott Hughesaef701d2013-04-05 18:15:40 -07002106 // In some other native method? That's interesting.
2107 // We don't just check kNative because native methods will be in state kSuspended if they're
2108 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2109 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002110 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002111 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002112}
2113
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002114void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002115 // If flip_function is not null, it means we have run a checkpoint
2116 // before the thread wakes up to execute the flip function and the
2117 // thread roots haven't been forwarded. So the following access to
2118 // the roots (locks or methods in the frames) would be bad. Run it
2119 // here. TODO: clean up.
2120 {
2121 Thread* this_thread = const_cast<Thread*>(this);
2122 Closure* flip_func = this_thread->GetFlipFunction();
2123 if (flip_func != nullptr) {
2124 flip_func->Run(this_thread);
2125 }
2126 }
2127
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002128 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2129 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002130 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2131 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002132 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002133 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002134 bool have_exception = false;
2135 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002136 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002137 const_cast<Thread*>(this)->ClearException();
2138 have_exception = true;
2139 }
2140
Ian Rogers700a4022014-05-19 16:49:03 -07002141 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002142 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002143 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002144 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002145
2146 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002147 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002148 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002149}
2150
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002151void Thread::DumpStack(std::ostream& os,
2152 bool dump_native_stack,
2153 BacktraceMap* backtrace_map,
2154 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002155 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2156 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2157 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002158 bool dump_for_abort = (gAborting > 0);
2159 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2160 if (!kIsDebugBuild) {
2161 // We always want to dump the stack for an abort, however, there is no point dumping another
2162 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2163 safe_to_dump = (safe_to_dump || dump_for_abort);
2164 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002165 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002166 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002167 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002168 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002169 ArtMethod* method =
2170 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002171 /*check_suspended=*/ !force_dump_stack,
2172 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002173 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002174 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002175 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002176 /*check_suspended=*/ !force_dump_stack,
2177 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002178 } else {
2179 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002180 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002181}
2182
Elliott Hughesbe759c62011-09-08 19:38:21 -07002183void Thread::ThreadExitCallback(void* arg) {
2184 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002185 if (self->tls32_.thread_exit_check_count == 0) {
2186 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2187 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002188 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002189#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002190 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2191#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002192 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002193#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002194 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002195 } else {
2196 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2197 }
Carl Shapirob5573532011-07-12 18:22:59 -07002198}
2199
Elliott Hughesbe759c62011-09-08 19:38:21 -07002200void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002201 CHECK(!is_started_);
2202 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002203 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002204 // MutexLock to keep annotalysis happy.
2205 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002206 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002207 // return garbage since (is_started_ == true) and
2208 // Thread::pthread_key_self_ is not yet initialized.
2209 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002210 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002211 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2212 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002213 }
2214
Carl Shapirob5573532011-07-12 18:22:59 -07002215 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002216 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2217 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002218
2219 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002220 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2221 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002222 }
Elliott Hughes038a8062011-09-18 14:12:41 -07002223}
Carl Shapirob5573532011-07-12 18:22:59 -07002224
Elliott Hughes038a8062011-09-18 14:12:41 -07002225void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002226 Runtime* runtime = Runtime::Current();
2227 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002228
Elliott Hughes01158d72011-09-19 19:47:10 -07002229 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002230 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002231 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2232 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002233
Vladimir Markodcfcce42018-06-27 10:00:28 +00002234 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002235
2236 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2237 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002238 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2239 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002240}
2241
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002242void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002243 CHECK(is_started_);
2244 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002245 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002246 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002247 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002248 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002249 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002250 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002251}
2252
Andreas Gampe56776012018-01-26 17:40:55 -08002253void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2254 ScopedLocalRef<jobject> thread_jobject(
2255 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2256 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2257 soa.Env(), nullptr);
2258 jobject thread_group_jobject = thread_group;
2259 if (thread_group == nullptr || kIsDebugBuild) {
2260 // There is always a group set. Retrieve it.
2261 thread_group_jobject_scoped.reset(
2262 soa.Env()->GetObjectField(thread_jobject.get(),
2263 WellKnownClasses::java_lang_Thread_group));
2264 thread_group_jobject = thread_group_jobject_scoped.get();
2265 if (kIsDebugBuild && thread_group != nullptr) {
2266 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2267 }
2268 }
2269 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2270 WellKnownClasses::java_lang_ThreadGroup,
2271 WellKnownClasses::java_lang_ThreadGroup_add,
2272 thread_jobject.get());
2273}
2274
Calin Juravleccd56952016-12-15 17:57:38 +00002275Thread::Thread(bool daemon)
2276 : tls32_(daemon),
2277 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002278 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002279 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002280 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002281 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2282 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2283
Roland Levillain33d69032015-06-18 18:20:59 +01002284 static_assert((sizeof(Thread) % 4) == 0U,
2285 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002286 tls32_.state_and_flags.as_struct.flags = 0;
2287 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002288 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002289 // Initialize with no permit; if the java Thread was unparked before being
2290 // started, it will unpark itself before calling into java code.
2291 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002292 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002293 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002294 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002295 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002296 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002297 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2298 tlsPtr_.active_suspend_barriers[i] = nullptr;
2299 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002300 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002301 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002302 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002303 tls32_.use_mterp = false;
2304}
2305
2306void Thread::NotifyInTheadList() {
2307 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002308}
2309
Alex Lighte9f61032018-09-24 16:04:51 -07002310bool Thread::CanLoadClasses() const {
2311 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2312}
2313
Elliott Hughes7dc51662012-05-16 14:48:43 -07002314bool Thread::IsStillStarting() const {
2315 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002316 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002317 // 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 -07002318 // assigned fairly early on, and needs to be.
2319 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2320 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002321 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2322 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002323}
2324
Andreas Gamped9efea62014-07-21 22:56:08 -07002325void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002326 CHECK(IsExceptionPending()) << "Pending exception expected.";
2327}
2328
2329void Thread::AssertPendingOOMException() const {
2330 AssertPendingException();
2331 auto* e = GetException();
2332 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2333 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002334}
2335
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002336void Thread::AssertNoPendingException() const {
2337 if (UNLIKELY(IsExceptionPending())) {
2338 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002339 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002340 }
2341}
2342
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002343void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2344 if (UNLIKELY(IsExceptionPending())) {
2345 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002346 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002347 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002348 }
2349}
2350
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002351class MonitorExitVisitor : public SingleRootVisitor {
2352 public:
2353 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2354
2355 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2356 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002357 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002358 if (self_->HoldsLock(entered_monitor)) {
2359 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002360 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002361 << " left locked by native thread "
2362 << *Thread::Current() << " which is detaching";
2363 entered_monitor->MonitorExit(self_);
2364 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002365 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002366
2367 private:
2368 Thread* const self_;
2369};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002370
Elliott Hughesc0f09332012-03-26 13:27:06 -07002371void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002372 Thread* self = this;
2373 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002374
Ian Rogers68d8b422014-07-17 11:09:10 -07002375 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002376 {
2377 ScopedObjectAccess soa(self);
2378 MonitorExitVisitor visitor(self);
2379 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002380 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002381 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002382 // Release locally held global references which releasing may require the mutator lock.
2383 if (tlsPtr_.jpeer != nullptr) {
2384 // If pthread_create fails we don't have a jni env here.
2385 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2386 tlsPtr_.jpeer = nullptr;
2387 }
2388 if (tlsPtr_.class_loader_override != nullptr) {
2389 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2390 tlsPtr_.class_loader_override = nullptr;
2391 }
2392 }
2393
Ian Rogersdd7624d2014-03-14 17:43:00 -07002394 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002395 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002396 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002397 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002398 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002399 Runtime* runtime = Runtime::Current();
2400 if (runtime != nullptr) {
2401 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2402 }
Elliott Hughes534da072012-03-27 15:17:42 -07002403
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002404 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002405 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002406 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002407 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002408 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002409 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002410 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002411 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002412
Ian Rogerscfaa4552012-11-26 21:00:08 -08002413 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2414 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002415 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002416 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002417 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002418 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002419 StackHandleScope<1> hs(self);
2420 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002421 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002422 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002423 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002424 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002425 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002426
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002427 {
2428 ScopedObjectAccess soa(self);
2429 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002430 if (kUseReadBarrier) {
2431 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2432 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002433 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002434}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002435
Elliott Hughesc0f09332012-03-26 13:27:06 -07002436Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002437 CHECK(tlsPtr_.class_loader_override == nullptr);
2438 CHECK(tlsPtr_.jpeer == nullptr);
2439 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002440 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002441 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002442 delete tlsPtr_.jni_env;
2443 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002444 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002445 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002446 CHECK(!ReadFlag(kCheckpointRequest));
2447 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002448 CHECK(tlsPtr_.checkpoint_function == nullptr);
2449 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002450 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002451 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002452
Sebastien Hertz07474662015-08-25 15:12:33 +00002453 // Make sure we processed all deoptimization requests.
2454 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002455 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2456 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002457
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002458 // We may be deleting a still born thread.
2459 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002460
2461 delete wait_cond_;
2462 delete wait_mutex_;
2463
Ian Rogersdd7624d2014-03-14 17:43:00 -07002464 if (tlsPtr_.long_jump_context != nullptr) {
2465 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002466 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002467
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002468 if (initialized) {
2469 CleanupCpu();
2470 }
2471
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002472 if (tlsPtr_.single_step_control != nullptr) {
2473 delete tlsPtr_.single_step_control;
2474 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002475 delete tlsPtr_.instrumentation_stack;
2476 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002477 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002478
Ian Rogers68d8b422014-07-17 11:09:10 -07002479 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002480
Elliott Hughesd8af1592012-04-16 20:40:15 -07002481 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002482}
2483
Andreas Gampe513061a2017-06-01 09:17:34 -07002484void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002485 if (!IsExceptionPending()) {
2486 return;
2487 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002488 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002489 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002490
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002491 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002492 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2493 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002494
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002495 // Call the Thread instance's dispatchUncaughtException(Throwable)
2496 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2497 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2498 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002499
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002500 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002501 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002502}
2503
Andreas Gampe513061a2017-06-01 09:17:34 -07002504void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002505 // this.group.removeThread(this);
2506 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002507 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002508 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002509 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002510 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002511 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002512 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002513 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2514 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2515 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002516 }
2517}
2518
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002519bool Thread::HandleScopeContains(jobject obj) const {
2520 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002521 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002522 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002523 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002524 return true;
2525 }
2526 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002527 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2528 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002529}
2530
Hans Boehm0882af22017-08-31 15:21:57 -07002531void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002532 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2533 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002534 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2535 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002536 }
2537}
2538
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002539ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002540 if (obj == nullptr) {
2541 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002542 }
2543 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002544 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002545 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002546 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002547 // The "kinds" below are sorted by the frequency we expect to encounter them.
2548 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002549 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002550 // Local references do not need a read barrier.
2551 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002552 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002553 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002554 // Check if this is a local reference in the handle scope.
2555 if (LIKELY(HandleScopeContains(obj))) {
2556 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002557 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002558 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002559 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002560 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002561 expect_null = true;
2562 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002563 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002564 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002565 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002566 } else {
2567 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002568 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002569 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002570 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002571 expect_null = true;
2572 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002573 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002574 }
2575
Ian Rogersc0542af2014-09-03 16:16:56 -07002576 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002577 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002578 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002579 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002580 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002581}
2582
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002583bool Thread::IsJWeakCleared(jweak obj) const {
2584 CHECK(obj != nullptr);
2585 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002586 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002587 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002588 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002589}
2590
Ian Rogers81d425b2012-09-27 16:03:43 -07002591// Implements java.lang.Thread.interrupted.
2592bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002593 DCHECK_EQ(Thread::Current(), this);
2594 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002595 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002596 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002597 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002598 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002599 return interrupted;
2600}
2601
2602// Implements java.lang.Thread.isInterrupted.
2603bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002604 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002605}
2606
Ian Rogersdd7624d2014-03-14 17:43:00 -07002607void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002608 {
2609 MutexLock mu(self, *wait_mutex_);
2610 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2611 return;
2612 }
2613 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2614 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002615 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002616 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002617}
2618
2619void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002620 Thread* self = Thread::Current();
2621 MutexLock mu(self, *wait_mutex_);
2622 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002623}
2624
Ian Rogersc604d732012-10-14 16:09:54 -07002625void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002626 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002627 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002628 }
2629}
2630
Ian Rogers68d8b422014-07-17 11:09:10 -07002631void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2632 if (tlsPtr_.class_loader_override != nullptr) {
2633 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2634 }
2635 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2636}
2637
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002638using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2639
2640// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2641class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002642 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002643 explicit FetchStackTraceVisitor(Thread* thread,
2644 ArtMethodDexPcPair* saved_frames = nullptr,
2645 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002646 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002647 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002648 saved_frames_(saved_frames),
2649 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002650
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002651 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002652 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002653 // Note we also skip the frame if it doesn't have a method (namely the callee
2654 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002655 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002656 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002657 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002658 skipping_ = false;
2659 }
2660 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002661 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002662 if (depth_ < max_saved_frames_) {
2663 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002664 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002665 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002666 ++depth_;
2667 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002668 } else {
2669 ++skip_depth_;
2670 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002671 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002672 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002673
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002674 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002675 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002676 }
2677
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002678 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002679 return skip_depth_;
2680 }
2681
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002682 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002683 uint32_t depth_ = 0;
2684 uint32_t skip_depth_ = 0;
2685 bool skipping_ = true;
2686 ArtMethodDexPcPair* saved_frames_;
2687 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002688
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002689 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002690};
2691
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002692template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002693class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002694 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002695 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002696 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2697 self_(self),
2698 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002699 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002700
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002701 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002702 // Allocate method trace as an object array where the first element is a pointer array that
2703 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2704 // class of the ArtMethod pointers.
2705 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2706 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002707 ObjPtr<mirror::Class> array_class =
2708 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002709 // The first element is the methods and dex pc array, the other elements are declaring classes
2710 // for the methods to ensure classes in the stack trace don't get unloaded.
2711 Handle<mirror::ObjectArray<mirror::Object>> trace(
2712 hs.NewHandle(
2713 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002714 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002715 // Acquire uninterruptible_ in all paths.
2716 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002717 self_->AssertPendingOOMException();
2718 return false;
2719 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002720 ObjPtr<mirror::PointerArray> methods_and_pcs =
2721 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002722 const char* last_no_suspend_cause =
2723 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2724 if (methods_and_pcs == nullptr) {
2725 self_->AssertPendingOOMException();
2726 return false;
2727 }
2728 trace->Set(0, methods_and_pcs);
2729 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002730 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002731 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002732 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002733 }
2734
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002735 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2736 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002737 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002738
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002739 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002740 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002741 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002742 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002743 if (skip_depth_ > 0) {
2744 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002745 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002746 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002747 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002748 if (m->IsRuntimeMethod()) {
2749 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002750 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002751 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002752 return true;
2753 }
2754
2755 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002756 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002757 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002758 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2759 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002760 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002761 pointer_size_);
2762 // Save the declaring class of the method to ensure that the declaring classes of the methods
2763 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002764 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002765 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002766 }
2767
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002768 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002769 return ObjPtr<mirror::PointerArray>::DownCast(trace_->Get(0));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002770 }
2771
2772 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002773 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002774 }
2775
2776 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002777 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002778 // How many more frames to skip.
2779 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002780 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002781 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002782 // An object array where the first element is a pointer array that contains the ArtMethod
2783 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2784 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2785 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002786 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002787 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002788 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002789
2790 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002791};
2792
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002793template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002794jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002795 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2796 constexpr size_t kMaxSavedFrames = 256;
2797 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2798 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2799 &saved_frames[0],
2800 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002801 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002802 const uint32_t depth = count_visitor.GetDepth();
2803 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002804
Ian Rogers1f539342012-10-03 21:09:42 -07002805 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002806 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2807 const_cast<Thread*>(this),
2808 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002809 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002810 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002811 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002812 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2813 // than doing the stack walk twice.
2814 if (depth < kMaxSavedFrames) {
2815 for (size_t i = 0; i < depth; ++i) {
2816 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2817 }
2818 } else {
2819 build_trace_visitor.WalkStack();
2820 }
2821
Mathieu Chartier910e8272015-09-30 09:24:22 -07002822 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002823 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002824 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002825 // Second half of trace_methods is dex PCs.
2826 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2827 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002828 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2829 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002830 }
2831 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002832 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002833}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002834template jobject Thread::CreateInternalStackTrace<false>(
2835 const ScopedObjectAccessAlreadyRunnable& soa) const;
2836template jobject Thread::CreateInternalStackTrace<true>(
2837 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002838
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002839bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002840 // Only count the depth since we do not pass a stack frame array as an argument.
2841 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002842 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002843 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002844}
2845
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002846static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2847 const ScopedObjectAccessAlreadyRunnable& soa,
2848 ArtMethod* method,
2849 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2850 int32_t line_number;
2851 StackHandleScope<3> hs(soa.Self());
2852 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2853 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2854 if (method->IsProxyMethod()) {
2855 line_number = -1;
2856 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2857 // source_name_object intentionally left null for proxy methods
2858 } else {
2859 line_number = method->GetLineNumFromDexPC(dex_pc);
2860 // Allocate element, potentially triggering GC
2861 // TODO: reuse class_name_object via Class::name_?
2862 const char* descriptor = method->GetDeclaringClassDescriptor();
2863 CHECK(descriptor != nullptr);
2864 std::string class_name(PrettyDescriptor(descriptor));
2865 class_name_object.Assign(
2866 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2867 if (class_name_object == nullptr) {
2868 soa.Self()->AssertPendingOOMException();
2869 return nullptr;
2870 }
2871 const char* source_file = method->GetDeclaringClassSourceFile();
2872 if (line_number == -1) {
2873 // Make the line_number field of StackTraceElement hold the dex pc.
2874 // source_name_object is intentionally left null if we failed to map the dex pc to
2875 // a line number (most probably because there is no debug info). See b/30183883.
2876 line_number = dex_pc;
2877 } else {
2878 if (source_file != nullptr) {
2879 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2880 if (source_name_object == nullptr) {
2881 soa.Self()->AssertPendingOOMException();
2882 return nullptr;
2883 }
2884 }
2885 }
2886 }
2887 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2888 CHECK(method_name != nullptr);
2889 Handle<mirror::String> method_name_object(
2890 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2891 if (method_name_object == nullptr) {
2892 return nullptr;
2893 }
2894 return mirror::StackTraceElement::Alloc(soa.Self(),
2895 class_name_object,
2896 method_name_object,
2897 source_name_object,
2898 line_number);
2899}
2900
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002901jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002902 const ScopedObjectAccessAlreadyRunnable& soa,
2903 jobject internal,
2904 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002905 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002906 // Decode the internal stack trace into the depth, method trace and PC trace.
2907 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002908 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002909 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002910
Mathieu Chartier910e8272015-09-30 09:24:22 -07002911 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002912
Elliott Hughes01158d72011-09-19 19:47:10 -07002913 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002914
Dave Allison0aded082013-11-07 13:15:11 -08002915 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002916 // Reuse the array we were given.
2917 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002918 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002919 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002920 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002921 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002922 } else {
2923 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002924 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002925 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002926 if (java_traces == nullptr) {
2927 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002928 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002929 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002930 }
2931
Dave Allison0aded082013-11-07 13:15:11 -08002932 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002933 *stack_depth = depth;
2934 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002935
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002936 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002937 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002938 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002939 // Methods and dex PC trace is element 0.
2940 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Vladimir Marko0984e482019-03-27 16:41:41 +00002941 const ObjPtr<mirror::PointerArray> method_trace =
Vladimir Markod7e9bbf2019-03-28 13:18:57 +00002942 ObjPtr<mirror::PointerArray>::DownCast(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07002943 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002944 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002945 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002946 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Vladimir Marko0984e482019-03-27 16:41:41 +00002947 const ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002948 if (obj == nullptr) {
2949 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002950 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002951 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002952 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002953 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002954 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002955}
2956
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002957jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2958 // This code allocates. Do not allow it to operate with a pending exception.
2959 if (IsExceptionPending()) {
2960 return nullptr;
2961 }
2962
2963 // If flip_function is not null, it means we have run a checkpoint
2964 // before the thread wakes up to execute the flip function and the
2965 // thread roots haven't been forwarded. So the following access to
2966 // the roots (locks or methods in the frames) would be bad. Run it
2967 // here. TODO: clean up.
2968 // Note: copied from DumpJavaStack.
2969 {
2970 Thread* this_thread = const_cast<Thread*>(this);
2971 Closure* flip_func = this_thread->GetFlipFunction();
2972 if (flip_func != nullptr) {
2973 flip_func->Run(this_thread);
2974 }
2975 }
2976
2977 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2978 public:
2979 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2980 Thread* self,
2981 Context* context)
2982 : MonitorObjectsStackVisitor(self, context),
2983 wait_jobject_(soaa_in.Env(), nullptr),
2984 block_jobject_(soaa_in.Env(), nullptr),
2985 soaa_(soaa_in) {}
2986
2987 protected:
2988 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002989 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002990 REQUIRES_SHARED(Locks::mutator_lock_) {
2991 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
2992 soaa_, m, GetDexPc(/* abort on error */ false));
2993 if (obj == nullptr) {
2994 return VisitMethodResult::kEndStackWalk;
2995 }
2996 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
2997 return VisitMethodResult::kContinueMethod;
2998 }
2999
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003000 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003001 lock_objects_.push_back({});
3002 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
3003
3004 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
3005
3006 return VisitMethodResult::kContinueMethod;
3007 }
3008
3009 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003010 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003011 REQUIRES_SHARED(Locks::mutator_lock_) {
3012 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3013 }
3014 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003015 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003016 REQUIRES_SHARED(Locks::mutator_lock_) {
3017 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3018 }
3019 void VisitBlockedOnObject(mirror::Object* obj,
3020 ThreadState state ATTRIBUTE_UNUSED,
3021 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003022 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003023 REQUIRES_SHARED(Locks::mutator_lock_) {
3024 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3025 }
3026 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003027 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003028 REQUIRES_SHARED(Locks::mutator_lock_) {
3029 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3030 }
3031
3032 public:
3033 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3034 ScopedLocalRef<jobject> wait_jobject_;
3035 ScopedLocalRef<jobject> block_jobject_;
3036 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3037
3038 private:
3039 const ScopedObjectAccessAlreadyRunnable& soaa_;
3040
3041 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3042 };
3043
3044 std::unique_ptr<Context> context(Context::Create());
3045 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3046 dumper.WalkStack();
3047
3048 // There should not be a pending exception. Otherwise, return with it pending.
3049 if (IsExceptionPending()) {
3050 return nullptr;
3051 }
3052
3053 // Now go and create Java arrays.
3054
3055 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3056
3057 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003058 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003059 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003060 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3061 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003062 return nullptr;
3063 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003064 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003065
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003066 Handle<mirror::Class> h_o_array_class =
3067 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3068 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003069
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003070
3071 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3072 class_linker->EnsureInitialized(soa.Self(),
3073 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003074 /* can_init_fields= */ true,
3075 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003076 if (soa.Self()->IsExceptionPending()) {
3077 // This should not fail in a healthy runtime.
3078 return nullptr;
3079 }
3080
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003081 ArtField* stack_trace_element_field = h_aste_class->FindField(
3082 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3083 DCHECK(stack_trace_element_field != nullptr);
3084 ArtField* held_locks_field = h_aste_class->FindField(
3085 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3086 DCHECK(held_locks_field != nullptr);
3087 ArtField* blocked_on_field = h_aste_class->FindField(
3088 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3089 DCHECK(blocked_on_field != nullptr);
3090
3091 size_t length = dumper.stack_trace_elements_.size();
3092 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003093 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003094 if (array == nullptr) {
3095 soa.Self()->AssertPendingOOMException();
3096 return nullptr;
3097 }
3098
3099 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3100
3101 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3102 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3103 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3104 for (size_t i = 0; i != length; ++i) {
3105 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3106 if (handle == nullptr) {
3107 soa.Self()->AssertPendingOOMException();
3108 return nullptr;
3109 }
3110
3111 // Set stack trace element.
3112 stack_trace_element_field->SetObject<false>(
3113 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3114
3115 // Create locked-on array.
3116 if (!dumper.lock_objects_[i].empty()) {
3117 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3118 h_o_array_class.Get(),
3119 dumper.lock_objects_[i].size()));
3120 if (handle2 == nullptr) {
3121 soa.Self()->AssertPendingOOMException();
3122 return nullptr;
3123 }
3124 int32_t j = 0;
3125 for (auto& scoped_local : dumper.lock_objects_[i]) {
3126 if (scoped_local == nullptr) {
3127 continue;
3128 }
3129 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3130 DCHECK(!soa.Self()->IsExceptionPending());
3131 j++;
3132 }
3133 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3134 }
3135
3136 // Set blocked-on object.
3137 if (i == 0) {
3138 if (dumper.block_jobject_ != nullptr) {
3139 blocked_on_field->SetObject<false>(
3140 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3141 }
3142 }
3143
3144 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3145 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3146 DCHECK(!soa.Self()->IsExceptionPending());
3147 }
3148
3149 return result.release();
3150}
3151
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003152void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003153 va_list args;
3154 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003155 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003156 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003157}
3158
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003159void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003160 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003161 std::string msg;
3162 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003163 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003164}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003165
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003166void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003167 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003168 // Callers should either clear or call ThrowNewWrappedException.
3169 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003170 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003171}
3172
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003173static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003174 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003175 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003176 return method != nullptr
3177 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003178 : nullptr;
3179}
3180
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003181void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003182 const char* msg) {
3183 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003184 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003185 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003186 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003187 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003188 ClearException();
3189 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003190 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003191 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003192 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003193 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003194 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003195 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003196 return;
3197 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003198
Ian Rogers7b078e82014-09-10 14:44:24 -07003199 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3200 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003201 DCHECK(IsExceptionPending());
3202 return;
3203 }
3204 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003205 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003206 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003207
Mathieu Chartier590fee92013-09-13 13:46:47 -07003208 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003209 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003210 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3211 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003212 return;
3213 }
3214
Ian Rogers62d6c772013-02-27 08:32:07 -08003215 // Choose an appropriate constructor and set up the arguments.
3216 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003217 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003218 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003219 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003220 msg_string.reset(
3221 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003222 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003223 CHECK(IsExceptionPending()); // OOME.
3224 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003225 }
Dave Allison0aded082013-11-07 13:15:11 -08003226 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003227 signature = "(Ljava/lang/String;)V";
3228 } else {
3229 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3230 }
3231 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003232 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003233 signature = "()V";
3234 } else {
3235 signature = "(Ljava/lang/Throwable;)V";
3236 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003237 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003238 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003239 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003240
Dave Allison0aded082013-11-07 13:15:11 -08003241 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003242 << PrettyDescriptor(exception_class_descriptor);
3243
3244 if (UNLIKELY(!runtime->IsStarted())) {
3245 // Something is trying to throw an exception without a started runtime, which is the common
3246 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3247 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003248 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003249 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003250 }
Dave Allison0aded082013-11-07 13:15:11 -08003251 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003252 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003253 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003254 ScopedLocalRef<jobject> trace(GetJniEnv(),
3255 Runtime::Current()->IsActiveTransaction()
3256 ? CreateInternalStackTrace<true>(soa)
3257 : CreateInternalStackTrace<false>(soa));
3258 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003259 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003260 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003261 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003262 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003263 jvalue jv_args[2];
3264 size_t i = 0;
3265
Dave Allison0aded082013-11-07 13:15:11 -08003266 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003267 jv_args[i].l = msg_string.get();
3268 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003269 }
Dave Allison0aded082013-11-07 13:15:11 -08003270 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003271 jv_args[i].l = cause.get();
3272 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003273 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003274 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08003275 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003276 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003277 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003278 }
Elliott Hughes30646832011-10-13 16:59:46 -07003279 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003280}
3281
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003282void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003283 LOG(WARNING) << "Throwing OutOfMemoryError "
3284 << '"' << msg << '"'
3285 << " (VmSize " << GetProcessStatus("VmSize")
3286 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003287 if (!tls32_.throwing_OutOfMemoryError) {
3288 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003289 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003290 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003291 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003292 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003293 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003294 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003295}
3296
Elliott Hughes498508c2011-10-17 14:58:22 -07003297Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003298 return Thread::Current();
3299}
3300
3301void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003302 std::ostringstream ss;
3303 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003304 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003305 // log to stderr for debugging command line processes
3306 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003307#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003308 // log to logcat for debugging frameworks processes
3309 LOG(INFO) << str;
3310#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003311}
3312
Ian Rogersdd7624d2014-03-14 17:43:00 -07003313// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003314template
3315void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3316template
3317void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003318
Andreas Gampe542451c2016-07-26 09:02:02 -07003319template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003320void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3321#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003322 if (offset == (x).Uint32Value()) { \
3323 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003324 return; \
3325 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003326 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3327 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3328 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3329 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3330 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3331 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3332 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3333 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003334 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003335 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003336 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003337 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003338 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003339#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003340
Ian Rogersdd7624d2014-03-14 17:43:00 -07003341#define JNI_ENTRY_POINT_INFO(x) \
3342 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3343 os << #x; \
3344 return; \
3345 }
3346 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3347#undef JNI_ENTRY_POINT_INFO
3348
Ian Rogersdd7624d2014-03-14 17:43:00 -07003349#define QUICK_ENTRY_POINT_INFO(x) \
3350 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3351 os << #x; \
3352 return; \
3353 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003354 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003355 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3356 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3357 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3358 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003359 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3360 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003361 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003362 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003363 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3364 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3365 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003366 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003367 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003368 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003369 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3370 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003371 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003372 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3373 QUICK_ENTRY_POINT_INFO(pSet8Static)
3374 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3375 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003376 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3377 QUICK_ENTRY_POINT_INFO(pSet32Static)
3378 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3379 QUICK_ENTRY_POINT_INFO(pSet64Static)
3380 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3381 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003382 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3383 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3384 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3385 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3386 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3387 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3388 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3389 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003390 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3391 QUICK_ENTRY_POINT_INFO(pGet32Static)
3392 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3393 QUICK_ENTRY_POINT_INFO(pGet64Static)
3394 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3395 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003396 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003397 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3398 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3399 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3400 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3401 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3402 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3403 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3404 QUICK_ENTRY_POINT_INFO(pLockObject)
3405 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3406 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3407 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3408 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3409 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003410 QUICK_ENTRY_POINT_INFO(pCos)
3411 QUICK_ENTRY_POINT_INFO(pSin)
3412 QUICK_ENTRY_POINT_INFO(pAcos)
3413 QUICK_ENTRY_POINT_INFO(pAsin)
3414 QUICK_ENTRY_POINT_INFO(pAtan)
3415 QUICK_ENTRY_POINT_INFO(pAtan2)
3416 QUICK_ENTRY_POINT_INFO(pCbrt)
3417 QUICK_ENTRY_POINT_INFO(pCosh)
3418 QUICK_ENTRY_POINT_INFO(pExp)
3419 QUICK_ENTRY_POINT_INFO(pExpm1)
3420 QUICK_ENTRY_POINT_INFO(pHypot)
3421 QUICK_ENTRY_POINT_INFO(pLog)
3422 QUICK_ENTRY_POINT_INFO(pLog10)
3423 QUICK_ENTRY_POINT_INFO(pNextAfter)
3424 QUICK_ENTRY_POINT_INFO(pSinh)
3425 QUICK_ENTRY_POINT_INFO(pTan)
3426 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003427 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003428 QUICK_ENTRY_POINT_INFO(pL2d)
3429 QUICK_ENTRY_POINT_INFO(pFmodf)
3430 QUICK_ENTRY_POINT_INFO(pL2f)
3431 QUICK_ENTRY_POINT_INFO(pD2iz)
3432 QUICK_ENTRY_POINT_INFO(pF2iz)
3433 QUICK_ENTRY_POINT_INFO(pIdivmod)
3434 QUICK_ENTRY_POINT_INFO(pD2l)
3435 QUICK_ENTRY_POINT_INFO(pF2l)
3436 QUICK_ENTRY_POINT_INFO(pLdiv)
3437 QUICK_ENTRY_POINT_INFO(pLmod)
3438 QUICK_ENTRY_POINT_INFO(pLmul)
3439 QUICK_ENTRY_POINT_INFO(pShlLong)
3440 QUICK_ENTRY_POINT_INFO(pShrLong)
3441 QUICK_ENTRY_POINT_INFO(pUshrLong)
3442 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003443 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3444 QUICK_ENTRY_POINT_INFO(pMemcpy)
3445 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3446 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3447 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3448 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3449 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3450 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3451 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3452 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003453 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003454 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3455 QUICK_ENTRY_POINT_INFO(pDeliverException)
3456 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3457 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003458 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3459 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003460 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003461 QUICK_ENTRY_POINT_INFO(pA64Load)
3462 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003463 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3464 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3465 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3466 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3467 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3468 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3469 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3470 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3471 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3472 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3473 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3474 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3475 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3476 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3477 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3478 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003479 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003480 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3481 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3482 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3483 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3484 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3485 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3486 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3487 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3488 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3489 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3490 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3491 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3492 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3493 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3494 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3495 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3496 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3497 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3498 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3499 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3500 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3501 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3502 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3503 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3504 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3505 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3506 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3507 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3508 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3509 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003510 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003511 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003512
3513 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3514 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003515#undef QUICK_ENTRY_POINT_INFO
3516
Elliott Hughes98e20172012-04-24 15:38:13 -07003517 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003518}
3519
jeffhao94d6df42012-11-26 16:02:12 -08003520void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003521 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003522 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003523 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003524 if (exception == GetDeoptimizationException()) {
3525 artDeoptimize(this);
3526 UNREACHABLE();
3527 }
3528
Roland Levillaina78f5b62017-09-29 13:50:44 +01003529 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003530
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003531 // This is a real exception: let the instrumentation know about it.
3532 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003533 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003534 IsExceptionThrownByCurrentMethod(exception)) {
3535 // Instrumentation may cause GC so keep the exception object safe.
3536 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003537 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Alex Light6e1607e2017-08-23 10:06:18 -07003538 instrumentation->ExceptionThrownEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003539 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003540 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3541 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3542 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3543 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003544 //
3545 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3546 // expected to happen fairly regularly but the second can only happen if we are using
3547 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3548 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003549 ShadowFrame* cf;
Alex Lightbe1f8d02018-10-15 11:44:42 -07003550 bool force_deopt;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003551 {
3552 NthCallerVisitor visitor(this, 0, false);
3553 visitor.WalkStack();
3554 cf = visitor.GetCurrentShadowFrame();
3555 if (cf == nullptr) {
3556 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3557 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003558 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3559 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003560 if (kIsDebugBuild && force_frame_pop) {
3561 NthCallerVisitor penultimate_visitor(this, 1, false);
3562 penultimate_visitor.WalkStack();
3563 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3564 if (penultimate_frame == nullptr) {
3565 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3566 }
3567 DCHECK(penultimate_frame != nullptr &&
3568 penultimate_frame->GetForceRetryInstruction())
3569 << "Force pop frame without retry instruction found. penultimate frame is null: "
3570 << (penultimate_frame == nullptr ? "true" : "false");
3571 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003572 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003573 }
Alex Light3dacdd62019-03-12 15:45:47 +00003574 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt || IsForceInterpreter()) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003575 NthCallerVisitor visitor(this, 0, false);
3576 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003577 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003578 // method_type shouldn't matter due to exception handling.
3579 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003580 // Save the exception into the deoptimization context so it can be restored
3581 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003582 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003583 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3584 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3585 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003586 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3587 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003588 ClearException();
3589 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003590 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003591 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003592 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003593 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003594 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003595 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003596 artDeoptimize(this);
3597 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003598 } else {
3599 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3600 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003601 }
3602 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003603
Ian Rogers28ad40d2011-10-27 15:19:26 -07003604 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003605 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003606 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003607 QuickExceptionHandler exception_handler(this, false);
3608 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003609 if (exception_handler.GetClearException()) {
3610 // Exception was cleared as part of delivery.
3611 DCHECK(!IsExceptionPending());
3612 } else {
3613 // Exception was put back with a throw location.
3614 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003615 // Check the to-space invariant on the re-installed exception (if applicable).
3616 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003617 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003618 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003619}
3620
Ian Rogersbdb03912011-09-14 00:55:44 -07003621Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003622 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003623 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003624 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003625 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003626 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003627 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003628 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003629 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003630}
3631
Andreas Gampec7d878d2018-11-19 18:42:06 +00003632ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003633 bool check_suspended,
3634 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003635 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3636 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3637 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003638 ArtMethod* method = nullptr;
3639 uint32_t dex_pc = dex::kDexNoIndex;
3640 StackVisitor::WalkStack(
3641 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3642 ArtMethod* m = visitor->GetMethod();
3643 if (m->IsRuntimeMethod()) {
3644 // Continue if this is a runtime method.
3645 return true;
3646 }
3647 method = m;
3648 dex_pc = visitor->GetDexPc(abort_on_error);
3649 return false;
3650 },
3651 const_cast<Thread*>(this),
3652 /* context= */ nullptr,
3653 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3654 check_suspended);
3655
3656 if (dex_pc_out != nullptr) {
3657 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003658 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003659 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003660}
3661
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003662bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3663 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003664}
3665
Roland Levillainad0777d2018-02-12 20:00:18 +00003666extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003667 REQUIRES_SHARED(Locks::mutator_lock_);
3668
Ian Rogers40e3bac2012-11-20 00:09:14 -08003669// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003670template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003671class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003672 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003673 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003674 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003675 // We are visiting the references in compiled frames, so we do not need
3676 // to know the inlined frames.
3677 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3678 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003679
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003680 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003681 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003682 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003683 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003684 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003685 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003686 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003687 VisitShadowFrame(shadow_frame);
3688 } else {
3689 VisitQuickFrame();
3690 }
3691 return true;
3692 }
3693
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003694 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003695 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003696 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003697 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003698 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003699 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
3700 // handle scope for JNI or References for interpreter.
3701 for (size_t reg = 0; reg < num_regs; ++reg) {
3702 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3703 if (ref != nullptr) {
3704 mirror::Object* new_ref = ref;
3705 visitor_(&new_ref, reg, this);
3706 if (new_ref != ref) {
3707 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003708 }
3709 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003710 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003711 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003712 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003713 }
3714
3715 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003716 // 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 -07003717 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3718 // the threads do not all hold the heap bitmap lock for parallel GC.
3719 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003720 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003721 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003722 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003723 // klass can be null for runtime methods.
3724 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003725 if (kVerifyImageObjectsMarked) {
3726 gc::Heap* const heap = Runtime::Current()->GetHeap();
3727 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003728 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003729 if (space != nullptr && space->IsImageSpace()) {
3730 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003731 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003732 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003733 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003734 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003735 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003736 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003737 }
3738 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003739 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3740 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3741 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003742 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003743 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003744 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3745 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003746 }
3747 }
3748 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003749 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003750 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003751 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003752 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003753 }
3754 }
3755 }
3756
Andreas Gampe585da952016-12-02 14:52:29 -08003757 template <typename T>
3758 ALWAYS_INLINE
3759 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003760 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003761 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003762 ArtMethod* m = *cur_quick_frame;
3763 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003764
Sebastien Hertz714f1752014-04-28 15:03:08 +02003765 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003766 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003767 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003768 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003769 StackReference<mirror::Object>* vreg_base =
3770 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003771 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbeckya2d29a32018-08-03 11:06:38 +01003772 CodeInfo code_info(method_header, kPrecise
David Srbecky42deda82018-08-10 11:23:27 +01003773 ? CodeInfo::DecodeFlags::AllTables // We will need dex register maps.
David Srbeckya2d29a32018-08-03 11:06:38 +01003774 : CodeInfo::DecodeFlags::GcMasksOnly);
David Srbecky052f8ca2018-04-26 15:42:54 +01003775 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003776 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003777
David Srbecky052f8ca2018-04-26 15:42:54 +01003778 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003779
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003780 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003781 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003782 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003783 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003784 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003785 mirror::Object* ref = ref_addr->AsMirrorPtr();
3786 if (ref != nullptr) {
3787 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003788 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003789 if (ref != new_ref) {
3790 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003791 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003792 }
3793 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003794 }
3795 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003796 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003797 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3798 if (register_mask & (1 << i)) {
3799 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003800 if (kIsDebugBuild && ref_addr == nullptr) {
3801 std::string thread_name;
3802 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003803 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003804 DescribeStack(GetThread());
3805 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3806 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3807 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003808 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003809 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003810 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003811 }
3812 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003813 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3814 // If this is a proxy method, visit its reference arguments.
3815 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003816 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003817 std::vector<StackReference<mirror::Object>*> ref_addrs =
3818 GetProxyReferenceArguments(cur_quick_frame);
3819 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3820 mirror::Object* ref = ref_addr->AsMirrorPtr();
3821 if (ref != nullptr) {
3822 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003823 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003824 if (ref != new_ref) {
3825 ref_addr->Assign(new_ref);
3826 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003827 }
3828 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003829 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003830 }
3831
Andreas Gampe585da952016-12-02 14:52:29 -08003832 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3833 if (kPrecise) {
3834 VisitQuickFramePrecise();
3835 } else {
3836 VisitQuickFrameNonPrecise();
3837 }
3838 }
3839
3840 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3841 struct UndefinedVRegInfo {
3842 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3843 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003844 const StackMap& map ATTRIBUTE_UNUSED,
3845 RootVisitor& _visitor)
3846 : visitor(_visitor) {
3847 }
3848
3849 ALWAYS_INLINE
3850 void VisitStack(mirror::Object** ref,
3851 size_t stack_index ATTRIBUTE_UNUSED,
3852 const StackVisitor* stack_visitor)
3853 REQUIRES_SHARED(Locks::mutator_lock_) {
3854 visitor(ref, -1, stack_visitor);
3855 }
3856
3857 ALWAYS_INLINE
3858 void VisitRegister(mirror::Object** ref,
3859 size_t register_index ATTRIBUTE_UNUSED,
3860 const StackVisitor* stack_visitor)
3861 REQUIRES_SHARED(Locks::mutator_lock_) {
3862 visitor(ref, -1, stack_visitor);
3863 }
3864
3865 RootVisitor& visitor;
3866 };
3867 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3868 }
3869
3870 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3871 struct StackMapVRegInfo {
3872 StackMapVRegInfo(ArtMethod* method,
3873 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003874 const StackMap& map,
3875 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003876 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003877 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003878 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003879 visitor(_visitor) {
3880 }
3881
3882 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3883 // lookups for each location.
3884 void FindWithType(const size_t index,
3885 const DexRegisterLocation::Kind kind,
3886 mirror::Object** ref,
3887 const StackVisitor* stack_visitor)
3888 REQUIRES_SHARED(Locks::mutator_lock_) {
3889 bool found = false;
3890 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003891 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003892 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3893 visitor(ref, dex_reg, stack_visitor);
3894 found = true;
3895 }
3896 }
3897
3898 if (!found) {
3899 // If nothing found, report with -1.
3900 visitor(ref, -1, stack_visitor);
3901 }
3902 }
3903
3904 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3905 REQUIRES_SHARED(Locks::mutator_lock_) {
3906 const size_t stack_offset = stack_index * kFrameSlotSize;
3907 FindWithType(stack_offset,
3908 DexRegisterLocation::Kind::kInStack,
3909 ref,
3910 stack_visitor);
3911 }
3912
3913 void VisitRegister(mirror::Object** ref,
3914 size_t register_index,
3915 const StackVisitor* stack_visitor)
3916 REQUIRES_SHARED(Locks::mutator_lock_) {
3917 FindWithType(register_index,
3918 DexRegisterLocation::Kind::kInRegister,
3919 ref,
3920 stack_visitor);
3921 }
3922
3923 size_t number_of_dex_registers;
3924 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003925 DexRegisterMap dex_register_map;
3926 RootVisitor& visitor;
3927 };
3928 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3929 }
3930
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003931 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003932 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003933};
3934
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003935class RootCallbackVisitor {
3936 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003937 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003938
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003939 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003940 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003941 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003942 }
3943
3944 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003945 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003946 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003947};
3948
Andreas Gampe585da952016-12-02 14:52:29 -08003949template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003950void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003951 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003952 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003953 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003954 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003955 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003956 }
Alex Light848574c2017-09-25 16:59:39 -07003957 if (tlsPtr_.async_exception != nullptr) {
3958 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3959 RootInfo(kRootNativeStack, thread_id));
3960 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003961 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003962 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3963 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003964 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003965 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003966 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003967 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003968 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003969 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003970 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003971 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003972 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3973 record != nullptr;
3974 record = record->GetLink()) {
3975 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3976 shadow_frame != nullptr;
3977 shadow_frame = shadow_frame->GetLink()) {
3978 mapper.VisitShadowFrame(shadow_frame);
3979 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003980 }
3981 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003982 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3983 record != nullptr;
3984 record = record->GetLink()) {
3985 if (record->IsReference()) {
3986 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003987 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003988 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003989 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3990 RootInfo(kRootThreadObject, thread_id));
3991 }
3992 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3993 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003994 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003995 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3996 record != nullptr;
3997 record = record->GetNext()) {
3998 mapper.VisitShadowFrame(record->GetShadowFrame());
3999 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07004000 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004001 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
4002 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004003 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07004004 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004005 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004006 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07004007 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08004008 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07004009 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004010 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08004011 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07004012}
4013
Andreas Gampe585da952016-12-02 14:52:29 -08004014void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
4015 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004016 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004017 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004018 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08004019 }
4020}
4021
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004022class VerifyRootVisitor : public SingleRootVisitor {
4023 public:
4024 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004025 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004026 VerifyObject(root);
4027 }
4028};
jeffhao25045522012-03-13 19:34:37 -07004029
Ian Rogers04d7aa92013-03-16 14:29:17 -07004030void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004031 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4032 VerifyRootVisitor visitor;
4033 std::unique_ptr<Context> context(Context::Create());
4034 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4035 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4036 mapper.WalkStack();
4037 }
jeffhao25045522012-03-13 19:34:37 -07004038}
jeffhao25045522012-03-13 19:34:37 -07004039
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004040// Set the stack end to that to be used during a stack overflow
4041void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004042 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004043 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004044 // However, we seem to have already extended to use the full stack.
4045 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004046 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004047 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004048 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004049 }
4050
Ian Rogersdd7624d2014-03-14 17:43:00 -07004051 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004052
4053 // Remove the stack overflow protection if is it set up.
4054 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4055 if (implicit_stack_check) {
4056 if (!UnprotectStack()) {
4057 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4058 }
4059 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004060}
4061
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004062void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004063 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004064 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004065 tlsPtr_.thread_local_start = start;
4066 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4067 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004068 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004069 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004070}
4071
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004072bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004073 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004074 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004075 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004076 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004077 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004078 }
4079 return has_tlab;
4080}
4081
Elliott Hughes330304d2011-08-12 14:28:05 -07004082std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004083 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004084 return os;
4085}
4086
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004087bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004088 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4089 VLOG(threads) << "Protecting stack at " << pregion;
4090 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004091 if (fatal_on_error) {
4092 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4093 "Reason: "
4094 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4095 }
4096 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004097 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004098 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004099}
4100
4101bool Thread::UnprotectStack() {
4102 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4103 VLOG(threads) << "Unprotecting stack at " << pregion;
4104 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4105}
4106
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004107void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4108 CHECK(Dbg::IsDebuggerActive());
4109 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4110 CHECK(ssc != nullptr);
4111 tlsPtr_.single_step_control = ssc;
4112}
4113
4114void Thread::DeactivateSingleStepControl() {
4115 CHECK(Dbg::IsDebuggerActive());
4116 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4117 SingleStepControl* ssc = GetSingleStepControl();
4118 tlsPtr_.single_step_control = nullptr;
4119 delete ssc;
4120}
Dave Allison648d7112014-07-25 16:15:27 -07004121
Sebastien Hertz1558b572015-02-25 15:05:59 +01004122void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4123 CHECK(Dbg::IsDebuggerActive());
4124 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4125 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4126 CHECK(req != nullptr);
4127 tlsPtr_.debug_invoke_req = req;
4128}
4129
4130void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004131 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4132 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004133 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004134 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004135 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004136}
4137
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004138void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4139 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004140 tlsPtr_.method_verifier = verifier;
4141}
4142
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004143void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004144 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004145 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004146}
4147
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004148size_t Thread::NumberOfHeldMutexes() const {
4149 size_t count = 0;
4150 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004151 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004152 }
4153 return count;
4154}
4155
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004156void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4157 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4158 ClearException();
4159 ShadowFrame* shadow_frame =
4160 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004161 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004162 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004163 DeoptimizationMethodType method_type;
4164 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004165 SetTopOfStack(nullptr);
4166 SetTopOfShadowStack(shadow_frame);
4167
4168 // Restore the exception that was pending before deoptimization then interpret the
4169 // deoptimized frames.
4170 if (pending_exception != nullptr) {
4171 SetException(pending_exception);
4172 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004173 interpreter::EnterInterpreterFromDeoptimize(this,
4174 shadow_frame,
4175 result,
4176 from_code,
4177 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004178}
4179
Alex Light848574c2017-09-25 16:59:39 -07004180void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4181 CHECK(new_exception != nullptr);
David Srbeckyd3883902019-02-26 17:29:32 +00004182 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004183 if (kIsDebugBuild) {
4184 // Make sure we are in a checkpoint.
4185 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4186 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4187 << "It doesn't look like this was called in a checkpoint! this: "
4188 << this << " count: " << GetSuspendCount();
4189 }
4190 tlsPtr_.async_exception = new_exception.Ptr();
4191}
4192
4193bool Thread::ObserveAsyncException() {
4194 DCHECK(this == Thread::Current());
4195 if (tlsPtr_.async_exception != nullptr) {
4196 if (tlsPtr_.exception != nullptr) {
4197 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4198 << tlsPtr_.exception->Dump();
4199 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4200 }
4201 tlsPtr_.exception = tlsPtr_.async_exception;
4202 tlsPtr_.async_exception = nullptr;
4203 return true;
4204 } else {
4205 return IsExceptionPending();
4206 }
4207}
4208
Mathieu Chartier0795f232016-09-27 18:43:30 -07004209void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004210 CHECK(new_exception != nullptr);
4211 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004212 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004213}
4214
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004215bool Thread::IsAotCompiler() {
4216 return Runtime::Current()->IsAotCompiler();
4217}
4218
Andreas Gampe202f85a2017-02-06 10:23:26 -08004219mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004220 DCHECK(tlsPtr_.jpeer == nullptr);
4221 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004222 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4223 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4224 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4225 // mark/forward it here.
4226 peer = art::ReadBarrier::Mark(peer);
4227 }
4228 return peer;
4229}
4230
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004231void Thread::SetReadBarrierEntrypoints() {
4232 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004233 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004234}
4235
David Srbecky912f36c2018-09-08 12:22:58 +01004236void Thread::ClearAllInterpreterCaches() {
4237 static struct ClearInterpreterCacheClosure : Closure {
Yi Kong39402542019-03-24 02:47:16 -07004238 void Run(Thread* thread) override {
David Srbecky912f36c2018-09-08 12:22:58 +01004239 thread->GetInterpreterCache()->Clear(thread);
4240 }
4241 } closure;
4242 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4243}
4244
Orion Hodson119733d2019-01-30 15:14:41 +00004245
Andreas Gampee5d23982019-01-08 10:34:26 -08004246void Thread::ReleaseLongJumpContextInternal() {
4247 // Each QuickExceptionHandler gets a long jump context and uses
4248 // it for doing the long jump, after finding catch blocks/doing deoptimization.
4249 // Both finding catch blocks and deoptimization can trigger another
4250 // exception such as a result of class loading. So there can be nested
4251 // cases of exception handling and multiple contexts being used.
4252 // ReleaseLongJumpContext tries to save the context in tlsPtr_.long_jump_context
4253 // for reuse so there is no need to always allocate a new one each time when
4254 // getting a context. Since we only keep one context for reuse, delete the
4255 // existing one since the passed in context is yet to be used for longjump.
4256 delete tlsPtr_.long_jump_context;
4257}
4258
Orion Hodson119733d2019-01-30 15:14:41 +00004259void Thread::SetNativePriority(int new_priority) {
4260 // ART tests on JVM can reach this code path, use tid = 0 as shorthand for current thread.
4261 PaletteStatus status = PaletteSchedSetPriority(0, new_priority);
4262 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4263}
4264
4265int Thread::GetNativePriority() {
4266 int priority = 0;
4267 // ART tests on JVM can reach this code path, use tid = 0 as shorthand for current thread.
4268 PaletteStatus status = PaletteSchedGetPriority(0, &priority);
4269 CHECK(status == PaletteStatus::kOkay || status == PaletteStatus::kCheckErrno);
4270 return priority;
4271}
4272
Alex Lighte0b2ce42019-02-21 19:23:42 +00004273bool Thread::IsSystemDaemon() const {
4274 if (GetPeer() == nullptr) {
4275 return false;
4276 }
4277 return jni::DecodeArtField(
4278 WellKnownClasses::java_lang_Thread_systemDaemon)->GetBoolean(GetPeer());
4279}
4280
Elliott Hughes8daa0922011-09-11 13:46:25 -07004281} // namespace art