blob: 8bec2d96738e3eadb5c4bd8a6f45d209a0fd17c0 [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
Brian Carlstrom640a1042017-03-20 15:03:42 -070019#if !defined(__APPLE__)
20#include <sched.h>
21#endif
22
Ian Rogersb033c752011-07-20 12:22:35 -070023#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070024#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080025#include <sys/resource.h>
26#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070027
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -070028#if __has_feature(hwaddress_sanitizer)
29#include <sanitizer/hwasan_interface.h>
30#else
31#define __hwasan_tag_pointer(p, t) (p)
32#endif
33
Carl Shapirob5573532011-07-12 18:22:59 -070034#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070035#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070036#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070037#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070038#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070039#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070040
Andreas Gampe46ee31b2016-12-14 10:11:49 -080041#include "android-base/stringprintf.h"
Evan Chengd57c51e2018-01-26 15:43:08 +080042#include "android-base/strings.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080043
Mathieu Chartiera62b4532017-04-26 13:16:25 -070044#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070045#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070046#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070047#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000048#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010049#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010050#include "base/casts.h"
David Sehr891a50e2017-10-27 17:01:07 -070051#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070052#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080053#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070054#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070055#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080056#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070057#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080058#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080059#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010060#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070061#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080062#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080063#include "dex/dex_file-inl.h"
64#include "dex/dex_file_annotations.h"
65#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070066#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080067#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070068#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000069#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070070#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070071#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070072#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070073#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070074#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070075#include "indirect_reference_table-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070076#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010077#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010078#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070079#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010080#include "jni/java_vm_ext.h"
81#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070082#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070083#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070084#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080085#include "mirror/object_array-inl.h"
86#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070087#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080088#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070089#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070090#include "nativehelper/scoped_local_ref.h"
91#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070092#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010093#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070094#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070095#include "object_lock.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010096#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070097#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080098#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050099#include "reflection.h"
David Srbecky28f6cff2018-10-16 15:07:28 +0100100#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700101#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800102#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700103#include "scoped_thread_state_change-inl.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700104#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100105#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700106#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700107#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700108#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800109#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700110#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700111
Yu Lieac44242015-06-29 10:50:03 +0800112#if ART_USE_FUTEXES
113#include "linux/futex.h"
114#include "sys/syscall.h"
115#ifndef SYS_futex
116#define SYS_futex __NR_futex
117#endif
118#endif // ART_USE_FUTEXES
119
Carl Shapirob5573532011-07-12 18:22:59 -0700120namespace art {
121
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800122using android::base::StringAppendV;
123using android::base::StringPrintf;
124
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700125extern "C" NO_RETURN void artDeoptimize(Thread* self);
126
Ian Rogers0878d652013-04-18 17:38:35 -0700127bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700128pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800129ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700130const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100131bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100132Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100133
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700134static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700135
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700136// For implicit overflow checks we reserve an extra piece of memory at the bottom
137// of the stack (lowest memory). The higher portion of the memory
138// is protected against reads and the lower is available for use while
139// throwing the StackOverflow exception.
140constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
141
Elliott Hughes7dc51662012-05-16 14:48:43 -0700142static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
143
Ian Rogers5d76c432011-10-31 21:42:49 -0700144void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700145 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700146}
147
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700148static void UnimplementedEntryPoint() {
149 UNIMPLEMENTED(FATAL);
150}
151
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700152void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700153void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800154
155void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
156 CHECK(kUseReadBarrier);
157 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700158 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800159 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800160}
Ian Rogers7655f292013-07-29 11:07:13 -0700161
Ian Rogers848871b2013-08-05 10:56:33 -0700162void Thread::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 Mungeraa31f492018-11-01 18:57:38 +0000307 int result = 0;
Charles Munger5cc0e752018-11-09 12:30:46 -0800308 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000309 if (!is_absolute && time == 0) {
310 // Thread.getState() is documented to return waiting for untimed parks.
311 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
312 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
313 result = futex(tls32_.park_state_.Address(),
314 FUTEX_WAIT_PRIVATE,
315 /* sleep if val = */ kNoPermitWaiterWaiting,
316 /* timeout */ nullptr,
317 nullptr,
318 0);
319 } else if (time > 0) {
320 // Only actually suspend and futex_wait if we're going to wait for some
321 // positive amount of time - the kernel will reject negative times with
322 // EINVAL, and a zero time will just noop.
323
324 // Thread.getState() is documented to return timed wait for timed parks.
325 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
326 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
327 timespec timespec;
328 if (is_absolute) {
329 // Time is millis when scheduled for an absolute time
330 timespec.tv_nsec = (time % 1000) * 1000000;
331 timespec.tv_sec = time / 1000;
332 // This odd looking pattern is recommended by futex documentation to
333 // wait until an absolute deadline, with otherwise identical behavior to
334 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
335 // correct time when the system clock changes.
336 result = futex(tls32_.park_state_.Address(),
337 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
338 /* sleep if val = */ kNoPermitWaiterWaiting,
339 &timespec,
340 nullptr,
341 FUTEX_BITSET_MATCH_ANY);
342 } else {
343 // Time is nanos when scheduled for a relative time
344 timespec.tv_sec = time / 1000000000;
345 timespec.tv_nsec = time % 1000000000;
346 result = futex(tls32_.park_state_.Address(),
347 FUTEX_WAIT_PRIVATE,
348 /* sleep if val = */ kNoPermitWaiterWaiting,
349 &timespec,
350 nullptr,
351 0);
352 }
353 }
354 if (result == -1) {
355 switch (errno) {
Charles Mungeraa31f492018-11-01 18:57:38 +0000356 case ETIMEDOUT:
Charles Munger5cc0e752018-11-09 12:30:46 -0800357 timed_out = true;
358 FALLTHROUGH_INTENDED;
359 case EAGAIN:
Charles Mungeraa31f492018-11-01 18:57:38 +0000360 case EINTR: break; // park() is allowed to spuriously return
361 default: PLOG(FATAL) << "Failed to park";
362 }
363 }
364 // Mark as no longer waiting, and consume permit if there is one.
365 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
366 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800367 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000368 } else {
369 // the fetch_add has consumed the permit. immediately return.
370 DCHECK_EQ(old_state, kPermitAvailable);
371 }
372#else
373 #pragma clang diagnostic push
374 #pragma clang diagnostic warning "-W#warnings"
375 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
376 #pragma clang diagnostic pop
377 UNUSED(is_absolute, time);
378 UNIMPLEMENTED(WARNING);
379 sched_yield();
380#endif
381}
382
383void Thread::Unpark() {
384#if ART_USE_FUTEXES
385 // Set permit available; will be consumed either by fetch_add (when the thread
386 // tries to park) or store (when the parked thread is woken up)
387 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
388 == kNoPermitWaiterWaiting) {
389 int result = futex(tls32_.park_state_.Address(),
390 FUTEX_WAKE_PRIVATE,
391 /* number of waiters = */ 1,
392 nullptr,
393 nullptr,
394 0);
395 if (result == -1) {
396 PLOG(FATAL) << "Failed to unpark";
397 }
398 }
399#else
400 UNIMPLEMENTED(WARNING);
401#endif
402}
403
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700404void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
405 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
406 sf, type, tlsPtr_.stacked_shadow_frame_record);
407 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800408}
409
Andreas Gampe639bdd12015-06-03 11:22:45 -0700410ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700411 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700412 if (must_be_present) {
413 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700414 } else {
415 if (record == nullptr || record->GetType() != type) {
416 return nullptr;
417 }
418 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700419 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
420 ShadowFrame* shadow_frame = record->GetShadowFrame();
421 delete record;
422 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700423}
424
Mingyao Yang99170c62015-07-06 11:10:37 -0700425class FrameIdToShadowFrame {
426 public:
427 static FrameIdToShadowFrame* Create(size_t frame_id,
428 ShadowFrame* shadow_frame,
429 FrameIdToShadowFrame* next,
430 size_t num_vregs) {
431 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
432 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
433 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
434 }
435
436 static void Delete(FrameIdToShadowFrame* f) {
437 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
438 delete[] memory;
439 }
440
441 size_t GetFrameId() const { return frame_id_; }
442 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
443 FrameIdToShadowFrame* GetNext() const { return next_; }
444 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
445 bool* GetUpdatedVRegFlags() {
446 return updated_vreg_flags_;
447 }
448
449 private:
450 FrameIdToShadowFrame(size_t frame_id,
451 ShadowFrame* shadow_frame,
452 FrameIdToShadowFrame* next)
453 : frame_id_(frame_id),
454 shadow_frame_(shadow_frame),
455 next_(next) {}
456
457 const size_t frame_id_;
458 ShadowFrame* const shadow_frame_;
459 FrameIdToShadowFrame* next_;
460 bool updated_vreg_flags_[0];
461
462 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
463};
464
465static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
466 size_t frame_id) {
467 FrameIdToShadowFrame* found = nullptr;
468 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
469 if (record->GetFrameId() == frame_id) {
470 if (kIsDebugBuild) {
471 // Sanity check we have at most one record for this frame.
472 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
473 found = record;
474 } else {
475 return record;
476 }
477 }
478 }
479 return found;
480}
481
482ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
483 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
484 tlsPtr_.frame_id_to_shadow_frame, frame_id);
485 if (record != nullptr) {
486 return record->GetShadowFrame();
487 }
488 return nullptr;
489}
490
491// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
492bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
493 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
494 tlsPtr_.frame_id_to_shadow_frame, frame_id);
495 CHECK(record != nullptr);
496 return record->GetUpdatedVRegFlags();
497}
498
499ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
500 uint32_t num_vregs,
501 ArtMethod* method,
502 uint32_t dex_pc) {
503 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
504 if (shadow_frame != nullptr) {
505 return shadow_frame;
506 }
David Sehr709b0702016-10-13 09:12:37 -0700507 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700508 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
509 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
510 shadow_frame,
511 tlsPtr_.frame_id_to_shadow_frame,
512 num_vregs);
513 for (uint32_t i = 0; i < num_vregs; i++) {
514 // Do this to clear all references for root visitors.
515 shadow_frame->SetVRegReference(i, nullptr);
516 // This flag will be changed to true if the debugger modifies the value.
517 record->GetUpdatedVRegFlags()[i] = false;
518 }
519 tlsPtr_.frame_id_to_shadow_frame = record;
520 return shadow_frame;
521}
522
Alex Light184f0752018-07-13 11:18:22 -0700523TLSData* Thread::GetCustomTLS(const char* key) {
524 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
525 auto it = custom_tls_.find(key);
526 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
527}
528
529void Thread::SetCustomTLS(const char* key, TLSData* data) {
530 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
531 // custom_tls_lock_.
532 std::unique_ptr<TLSData> old_data(data);
533 {
534 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
535 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
536 }
537}
538
Mingyao Yang99170c62015-07-06 11:10:37 -0700539void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
540 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
541 if (head->GetFrameId() == frame_id) {
542 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
543 FrameIdToShadowFrame::Delete(head);
544 return;
545 }
546 FrameIdToShadowFrame* prev = head;
547 for (FrameIdToShadowFrame* record = head->GetNext();
548 record != nullptr;
549 prev = record, record = record->GetNext()) {
550 if (record->GetFrameId() == frame_id) {
551 prev->SetNext(record->GetNext());
552 FrameIdToShadowFrame::Delete(record);
553 return;
554 }
555 }
556 LOG(FATAL) << "No shadow frame for frame " << frame_id;
557 UNREACHABLE();
558}
559
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700560void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700561 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700562}
563
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700564void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700565 // One thread (us) survived the fork, but we have a new tid so we need to
566 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700567 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700568}
569
Brian Carlstrom78128a62011-09-15 17:21:19 -0700570void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700571 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700572 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800573 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700574 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800575 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700576 }
577 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700578 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
579 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800580 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700581 // Check that if we got here we cannot be shutting down (as shutdown should never have started
582 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700583 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700584 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
585 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
586 // the runtime in such a case. In case this ever changes, we need to make sure here to
587 // delete the tmp_jni_env, as we own it at this point.
588 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
589 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700590 Runtime::Current()->EndThreadBirth();
591 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700592 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700593 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800594 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800595
596 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700597 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700598 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700599 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
600 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800601 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100602
Andreas Gampe08883de2016-11-08 13:20:52 -0800603 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100604 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000605
Andreas Gampeac30fa22017-01-18 21:02:36 -0800606 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700607
Charles Mungeraa31f492018-11-01 18:57:38 +0000608 // Unpark ourselves if the java peer was unparked before it started (see
609 // b/28845097#comment49 for more information)
610
611 ArtField* unparkedField = jni::DecodeArtField(
612 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
613 bool should_unpark = false;
614 {
615 // Hold the lock here, so that if another thread calls unpark before the thread starts
616 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
617 // which could cause a lost unpark.
618 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
619 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
620 }
621 if (should_unpark) {
622 self->Unpark();
623 }
Ian Rogers365c1022012-06-22 15:05:28 -0700624 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800625 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700626 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700627 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
628 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700629 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700630 // Detach and delete self.
631 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700632
Dave Allison0aded082013-11-07 13:15:11 -0800633 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700634}
635
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700636Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800637 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800638 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100639 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700640 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
641 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700642 if (kIsDebugBuild) {
643 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800644 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700645 Locks::thread_list_lock_->AssertHeld(soa.Self());
646 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700647 }
648 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800649}
650
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700651Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
652 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100653 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700654}
655
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700656static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700657 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700658 if (stack_size == 0) {
659 stack_size = Runtime::Current()->GetDefaultStackSize();
660 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700661
Brian Carlstrom6414a972012-04-14 14:20:04 -0700662 // Dalvik used the bionic pthread default stack size for native threads,
663 // so include that here to support apps that expect large native stacks.
664 stack_size += 1 * MB;
665
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700666 // Under sanitization, frames of the interpreter may become bigger, both for C code as
667 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
668 // of all core classes cannot be done in all test circumstances.
669 if (kMemoryToolIsAvailable) {
670 stack_size = std::max(2 * MB, stack_size);
671 }
672
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700673 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
674 if (stack_size < PTHREAD_STACK_MIN) {
675 stack_size = PTHREAD_STACK_MIN;
676 }
677
Dave Allisonf9439142014-03-27 15:10:22 -0700678 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
679 // It's likely that callers are trying to ensure they have at least a certain amount of
680 // stack space, so we should add our reserved space on top of what they requested, rather
681 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700682 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700683 } else {
684 // If we are going to use implicit stack checks, allocate space for the protected
685 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000686 stack_size += Thread::kStackOverflowImplicitCheckSize +
687 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700688 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700689
690 // Some systems require the stack size to be a multiple of the system page size, so round up.
691 stack_size = RoundUp(stack_size, kPageSize);
692
693 return stack_size;
694}
695
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700696// Return the nearest page-aligned address below the current stack top.
697NO_INLINE
698static uint8_t* FindStackTop() {
699 return reinterpret_cast<uint8_t*>(
700 AlignDown(__builtin_frame_address(0), kPageSize));
701}
702
Dave Allisonf9439142014-03-27 15:10:22 -0700703// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700704// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700705ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700706void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700707 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700708 // Page containing current top of stack.
709 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700710
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700711 // Try to directly protect the stack.
712 VLOG(threads) << "installing stack protected region at " << std::hex <<
713 static_cast<void*>(pregion) << " to " <<
714 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700715 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700716 // Tell the kernel that we won't be needing these pages any more.
717 // NB. madvise will probably write zeroes into the memory (on linux it does).
718 uint32_t unwanted_size = stack_top - pregion - kPageSize;
719 madvise(pregion, unwanted_size, MADV_DONTNEED);
720 return;
721 }
722
723 // There is a little complexity here that deserves a special mention. On some
724 // architectures, the stack is created using a VM_GROWSDOWN flag
725 // to prevent memory being allocated when it's not needed. This flag makes the
726 // kernel only allocate memory for the stack by growing down in memory. Because we
727 // want to put an mprotected region far away from that at the stack top, we need
728 // to make sure the pages for the stack are mapped in before we call mprotect.
729 //
730 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
731 // with a non-mapped stack (usually only the main thread).
732 //
733 // We map in the stack by reading every page from the stack bottom (highest address)
734 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700735 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700736 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700737 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
738 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
739 // thus have to move the stack pointer. We do this portably by using a recursive function with a
740 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700741
Andreas Gampe6c63f862017-06-28 17:20:15 -0700742 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700743 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700744 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000745
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700746 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
747 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000748
Andreas Gampe6c63f862017-06-28 17:20:15 -0700749 struct RecurseDownStack {
750 // This function has an intentionally large stack size.
751#pragma GCC diagnostic push
752#pragma GCC diagnostic ignored "-Wframe-larger-than="
753 NO_INLINE
754 static void Touch(uintptr_t target) {
755 volatile size_t zero = 0;
756 // Use a large local volatile array to ensure a large frame size. Do not use anything close
757 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
758 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700759 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
760 constexpr size_t kAsanMultiplier =
761#ifdef ADDRESS_SANITIZER
762 2u;
763#else
764 1u;
765#endif
766 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700767 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700768 // Remove tag from the pointer. Nop in non-hwasan builds.
769 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
770 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700771 Touch(target);
772 }
773 zero *= 2; // Try to avoid tail recursion.
774 }
775#pragma GCC diagnostic pop
776 };
777 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000778
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700779 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700780 static_cast<void*>(pregion) << " to " <<
781 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
782
Dave Allison648d7112014-07-25 16:15:27 -0700783 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700784 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700785
786 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000787 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700788 uint32_t unwanted_size = stack_top - pregion - kPageSize;
789 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700790}
791
Ian Rogers120f1c72012-09-28 17:17:10 -0700792void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800793 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800794 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700795
796 if (VLOG_IS_ON(threads)) {
797 ScopedObjectAccess soa(env);
798
Andreas Gampe08883de2016-11-08 13:20:52 -0800799 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700800 ObjPtr<mirror::String> java_name =
801 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700802 std::string thread_name;
803 if (java_name != nullptr) {
804 thread_name = java_name->ToModifiedUtf8();
805 } else {
806 thread_name = "(Unnamed)";
807 }
808
809 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700810 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700811 }
812
Ian Rogers120f1c72012-09-28 17:17:10 -0700813 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700814
Ian Rogers120f1c72012-09-28 17:17:10 -0700815 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
816 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700817 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700818 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700819 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700820 thread_start_during_shutdown = true;
821 } else {
822 runtime->StartThreadBirth();
823 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700824 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700825 if (thread_start_during_shutdown) {
826 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
827 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
828 return;
829 }
830
831 Thread* child_thread = new Thread(is_daemon);
832 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700833 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700834 stack_size = FixStackSize(stack_size);
835
Roland Levillain2ae376f2018-01-30 11:35:11 +0000836 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
837 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800838 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
839 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700840
Andreas Gampe449357d2015-06-01 22:29:51 -0700841 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
842 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100843 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700844 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100845 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700846
Andreas Gampe449357d2015-06-01 22:29:51 -0700847 int pthread_create_result = 0;
848 if (child_jni_env_ext.get() != nullptr) {
849 pthread_t new_pthread;
850 pthread_attr_t attr;
851 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
852 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
853 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
854 "PTHREAD_CREATE_DETACHED");
855 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
856 pthread_create_result = pthread_create(&new_pthread,
857 &attr,
858 Thread::CreateCallback,
859 child_thread);
860 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
861
862 if (pthread_create_result == 0) {
863 // pthread_create started the new thread. The child is now responsible for managing the
864 // JNIEnvExt we created.
865 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
866 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700867 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700868 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700869 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700870 }
871
872 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
873 {
874 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
875 runtime->EndThreadBirth();
876 }
877 // Manually delete the global reference since Thread::Init will not have been run.
878 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
879 child_thread->tlsPtr_.jpeer = nullptr;
880 delete child_thread;
881 child_thread = nullptr;
882 // TODO: remove from thread group?
883 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
884 {
885 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100886 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700887 StringPrintf("pthread_create (%s stack) failed: %s",
888 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
889 ScopedObjectAccess soa(env);
890 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700891 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700892}
893
Andreas Gampe449357d2015-06-01 22:29:51 -0700894bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700895 // This function does all the initialization that must be run by the native thread it applies to.
896 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
897 // we can handshake with the corresponding native thread when it's ready.) Check this native
898 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800899 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800900
901 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
902 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
903 tlsPtr_.pthread_self = pthread_self();
904 CHECK(is_started_);
905
Elliott Hughesd8af1592012-04-16 20:40:15 -0700906 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800907 if (!InitStackHwm()) {
908 return false;
909 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700910 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700911 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800912 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700913 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700914 InitTid();
buzbee1452bee2015-03-06 14:43:04 -0800915 interpreter::InitInterpreterTls(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800916
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100917#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000918 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
919#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700920 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000921#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700922 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700923
Ian Rogersdd7624d2014-03-14 17:43:00 -0700924 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700925
Andreas Gampe449357d2015-06-01 22:29:51 -0700926 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800927 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
928 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700929 tlsPtr_.jni_env = jni_env_ext;
930 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100931 std::string error_msg;
932 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700933 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100934 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700935 return false;
936 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700937 }
938
Ian Rogers120f1c72012-09-28 17:17:10 -0700939 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800940 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700941}
942
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800943template <typename PeerAction>
944Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700945 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800946 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900947 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
948 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800949 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700950 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800951 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700952 {
Dave Allison0aded082013-11-07 13:15:11 -0800953 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700954 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900955 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
956 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800957 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700958 } else {
959 Runtime::Current()->StartThreadBirth();
960 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800961 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700962 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800963 if (!init_success) {
964 delete self;
965 return nullptr;
966 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700967 }
968 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700969
Jeff Hao848f70a2014-01-15 13:49:50 -0800970 self->InitStringEntryPoints();
971
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700972 CHECK_NE(self->GetState(), kRunnable);
973 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700974
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800975 // Run the action that is acting on the peer.
976 if (!peer_action(self)) {
977 runtime->GetThreadList()->Unregister(self);
978 // Unregister deletes self, no need to do this here.
979 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700980 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700981
Andreas Gampe56623832015-07-09 21:53:15 -0700982 if (VLOG_IS_ON(threads)) {
983 if (thread_name != nullptr) {
984 VLOG(threads) << "Attaching thread " << thread_name;
985 } else {
986 VLOG(threads) << "Attaching unnamed thread.";
987 }
988 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700989 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700990 }
991
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200992 {
993 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -0800994 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200995 }
996
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700997 return self;
998}
999
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001000Thread* Thread::Attach(const char* thread_name,
1001 bool as_daemon,
1002 jobject thread_group,
1003 bool create_peer) {
1004 auto create_peer_action = [&](Thread* self) {
1005 // If we're the main thread, ClassLinker won't be created until after we're attached,
1006 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1007 // In the compiler, all threads need this hack, because no-one's going to be getting
1008 // a native peer!
1009 if (create_peer) {
1010 self->CreatePeer(thread_name, as_daemon, thread_group);
1011 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001012 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1013 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001014 {
1015 ScopedObjectAccess soa(self);
1016 LOG(ERROR) << "Exception creating thread peer:";
1017 LOG(ERROR) << self->GetException()->Dump();
1018 self->ClearException();
1019 }
1020 return false;
1021 }
1022 } else {
1023 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1024 if (thread_name != nullptr) {
1025 self->tlsPtr_.name->assign(thread_name);
1026 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001027 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001028 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1029 }
1030 }
1031 return true;
1032 };
1033 return Attach(thread_name, as_daemon, create_peer_action);
1034}
1035
1036Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1037 auto set_peer_action = [&](Thread* self) {
1038 // Install the given peer.
1039 {
1040 DCHECK(self == Thread::Current());
1041 ScopedObjectAccess soa(self);
1042 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1043 }
1044 self->GetJniEnv()->SetLongField(thread_peer,
1045 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001046 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001047 return true;
1048 };
1049 return Attach(thread_name, as_daemon, set_peer_action);
1050}
1051
Ian Rogers365c1022012-06-22 15:05:28 -07001052void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1053 Runtime* runtime = Runtime::Current();
1054 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001055 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001056
Dave Allison0aded082013-11-07 13:15:11 -08001057 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001058 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001059 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001060 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001061 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001062 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001063 CHECK(IsExceptionPending());
1064 return;
1065 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001066 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001067 jboolean thread_is_daemon = as_daemon;
1068
Elliott Hugheseac76672012-05-24 21:56:51 -07001069 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001070 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001071 CHECK(IsExceptionPending());
1072 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001073 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001074 {
1075 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001076 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001077 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001078 env->CallNonvirtualVoidMethod(peer.get(),
1079 WellKnownClasses::java_lang_Thread,
1080 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001081 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001082 if (IsExceptionPending()) {
1083 return;
1084 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001085
Ian Rogers120f1c72012-09-28 17:17:10 -07001086 Thread* self = this;
1087 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001088 env->SetLongField(peer.get(),
1089 WellKnownClasses::java_lang_Thread_nativePeer,
1090 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001091
1092 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001093 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001094 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001095 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001096 // The Thread constructor should have set the Thread.name to a
1097 // non-null value. However, because we can run without code
1098 // available (in the compiler, in tests), we manually assign the
1099 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001100 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001101 InitPeer<true>(soa,
1102 tlsPtr_.opeer,
1103 thread_is_daemon,
1104 thread_group,
1105 thread_name.get(),
1106 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001107 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001108 InitPeer<false>(soa,
1109 tlsPtr_.opeer,
1110 thread_is_daemon,
1111 thread_group,
1112 thread_name.get(),
1113 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001114 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001115 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001116 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001117 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001118 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001119 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001120 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001121}
1122
Andreas Gampebad529d2017-02-13 18:52:10 -08001123jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1124 const char* name,
1125 bool as_daemon,
1126 jobject thread_group) {
1127 Runtime* runtime = Runtime::Current();
1128 CHECK(!runtime->IsStarted());
1129
1130 if (thread_group == nullptr) {
1131 thread_group = runtime->GetMainThreadGroup();
1132 }
1133 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1134 // Add missing null check in case of OOM b/18297817
1135 if (name != nullptr && thread_name.get() == nullptr) {
1136 CHECK(Thread::Current()->IsExceptionPending());
1137 return nullptr;
1138 }
1139 jint thread_priority = GetNativePriority();
1140 jboolean thread_is_daemon = as_daemon;
1141
1142 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1143 if (peer.get() == nullptr) {
1144 CHECK(Thread::Current()->IsExceptionPending());
1145 return nullptr;
1146 }
1147
1148 // We cannot call Thread.init, as it will recursively ask for currentThread.
1149
1150 // The Thread constructor should have set the Thread.name to a
1151 // non-null value. However, because we can run without code
1152 // available (in the compiler, in tests), we manually assign the
1153 // fields the constructor should have set.
1154 ScopedObjectAccessUnchecked soa(Thread::Current());
1155 if (runtime->IsActiveTransaction()) {
1156 InitPeer<true>(soa,
1157 soa.Decode<mirror::Object>(peer.get()),
1158 thread_is_daemon,
1159 thread_group,
1160 thread_name.get(),
1161 thread_priority);
1162 } else {
1163 InitPeer<false>(soa,
1164 soa.Decode<mirror::Object>(peer.get()),
1165 thread_is_daemon,
1166 thread_group,
1167 thread_name.get(),
1168 thread_priority);
1169 }
1170
1171 return peer.release();
1172}
1173
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001174template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001175void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1176 ObjPtr<mirror::Object> peer,
1177 jboolean thread_is_daemon,
1178 jobject thread_group,
1179 jobject thread_name,
1180 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001181 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001182 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001183 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001184 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001185 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001186 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001187 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001188 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001189}
1190
Elliott Hughes899e7892012-01-24 14:57:32 -08001191void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001192 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001193 ::art::SetThreadName(name);
1194 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1195}
1196
Andreas Gampe9186ced2016-12-12 14:28:21 -08001197static void GetThreadStack(pthread_t thread,
1198 void** stack_base,
1199 size_t* stack_size,
1200 size_t* guard_size) {
1201#if defined(__APPLE__)
1202 *stack_size = pthread_get_stacksize_np(thread);
1203 void* stack_addr = pthread_get_stackaddr_np(thread);
1204
1205 // Check whether stack_addr is the base or end of the stack.
1206 // (On Mac OS 10.7, it's the end.)
1207 int stack_variable;
1208 if (stack_addr > &stack_variable) {
1209 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1210 } else {
1211 *stack_base = stack_addr;
1212 }
1213
1214 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1215 pthread_attr_t attributes;
1216 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1217 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1218 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1219#else
1220 pthread_attr_t attributes;
1221 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1222 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1223 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1224 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1225
1226#if defined(__GLIBC__)
1227 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1228 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1229 // will be broken because we'll die long before we get close to 2GB.
1230 bool is_main_thread = (::art::GetTid() == getpid());
1231 if (is_main_thread) {
1232 rlimit stack_limit;
1233 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1234 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1235 }
1236 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1237 size_t old_stack_size = *stack_size;
1238
1239 // Use the kernel default limit as our size, and adjust the base to match.
1240 *stack_size = 8 * MB;
1241 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1242
1243 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1244 << " to " << PrettySize(*stack_size)
1245 << " with base " << *stack_base;
1246 }
1247 }
1248#endif
1249
1250#endif
1251}
1252
Ian Rogersf4d4da12014-11-11 16:10:33 -08001253bool Thread::InitStackHwm() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001254 void* read_stack_base;
1255 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001256 size_t read_guard_size;
1257 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001258
Ian Rogers13735952014-10-08 12:43:28 -07001259 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001260 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001261
Dave Allison648d7112014-07-25 16:15:27 -07001262 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1263 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1264 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1265 // between 8K and 12K.
1266 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1267 + 4 * KB;
1268 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001269 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001270 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1271 __LINE__,
1272 ::android::base::ERROR,
1273 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001274 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001275 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001276
Vladimir Markob8f2f632015-01-02 14:23:26 +00001277 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1278 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1279 read_stack_base,
1280 PrettySize(read_stack_size).c_str(),
1281 PrettySize(read_guard_size).c_str());
1282
Ian Rogers932746a2011-09-22 18:57:50 -07001283 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001284
1285 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001286 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001287
Dave Allisonb090a182014-08-14 17:02:48 +00001288 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001289
1290 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001291 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001292 // The thread might have protected region at the bottom. We need
1293 // to install our own region so we need to move the limits
1294 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001295
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001296 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1297 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1298 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001299
1300 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001301 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001302
1303 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001304 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001305
1306 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001307}
1308
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001309void Thread::ShortDump(std::ostream& os) const {
1310 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001311 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001312 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001313 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001314 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001315 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001316 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001317 << ",Thread*=" << this
1318 << ",peer=" << tlsPtr_.opeer
1319 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1320 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001321}
1322
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001323void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1324 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001325 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001326 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001327}
1328
Andreas Gampe08883de2016-11-08 13:20:52 -08001329mirror::String* Thread::GetThreadName() const {
1330 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001331 if (tlsPtr_.opeer == nullptr) {
1332 return nullptr;
1333 }
1334 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1335 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001336}
1337
Elliott Hughesffb465f2012-03-01 18:46:05 -08001338void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001339 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001340}
1341
Jeff Hao57dac6e2013-08-15 16:36:24 -07001342uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001343#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001344 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001345 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001346 timespec now;
1347 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001348 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001349#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001350 UNIMPLEMENTED(WARNING);
1351 return -1;
1352#endif
1353}
1354
Ian Rogers01ae5802012-09-28 16:14:01 -07001355// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1356static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001357 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001358 Locks::thread_suspend_count_lock_->Unlock(self);
1359 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1360 Locks::mutator_lock_->SharedTryLock(self);
1361 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1362 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1363 }
1364 }
1365 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1366 Locks::thread_list_lock_->TryLock(self);
1367 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1368 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1369 }
1370 }
1371 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001372 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001373 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001374}
1375
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001376bool Thread::ModifySuspendCountInternal(Thread* self,
1377 int delta,
1378 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001379 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001380 if (kIsDebugBuild) {
1381 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001382 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001383 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1384 Locks::thread_suspend_count_lock_->AssertHeld(self);
1385 if (this != self && !IsSuspended()) {
1386 Locks::thread_list_lock_->AssertHeld(self);
1387 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001388 }
Alex Light88fd7202017-06-30 08:31:59 -07001389 // User code suspensions need to be checked more closely since they originate from code outside of
1390 // the runtime's control.
1391 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1392 Locks::user_code_suspension_lock_->AssertHeld(self);
1393 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1394 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1395 return false;
1396 }
1397 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001398 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001399 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001400 return false;
1401 }
1402
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001403 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1404 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1405 // deadlock. b/31683379.
1406 return false;
1407 }
1408
Yu Lieac44242015-06-29 10:50:03 +08001409 uint16_t flags = kSuspendRequest;
1410 if (delta > 0 && suspend_barrier != nullptr) {
1411 uint32_t available_barrier = kMaxSuspendBarriers;
1412 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1413 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1414 available_barrier = i;
1415 break;
1416 }
1417 }
1418 if (available_barrier == kMaxSuspendBarriers) {
1419 // No barrier spaces available, we can't add another.
1420 return false;
1421 }
1422 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1423 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001424 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001425
Ian Rogersdd7624d2014-03-14 17:43:00 -07001426 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001427 switch (reason) {
1428 case SuspendReason::kForDebugger:
1429 tls32_.debug_suspend_count += delta;
1430 break;
Alex Light88fd7202017-06-30 08:31:59 -07001431 case SuspendReason::kForUserCode:
1432 tls32_.user_code_suspend_count += delta;
1433 break;
Alex Light46f93402017-06-29 11:59:50 -07001434 case SuspendReason::kInternal:
1435 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001436 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001437
Ian Rogersdd7624d2014-03-14 17:43:00 -07001438 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001439 AtomicClearFlag(kSuspendRequest);
1440 } else {
Yu Lieac44242015-06-29 10:50:03 +08001441 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001442 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001443 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001444 }
Yu Lieac44242015-06-29 10:50:03 +08001445 return true;
1446}
1447
1448bool Thread::PassActiveSuspendBarriers(Thread* self) {
1449 // Grab the suspend_count lock and copy the current set of
1450 // barriers. Then clear the list and the flag. The ModifySuspendCount
1451 // function requires the lock so we prevent a race between setting
1452 // the kActiveSuspendBarrier flag and clearing it.
1453 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1454 {
1455 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1456 if (!ReadFlag(kActiveSuspendBarrier)) {
1457 // quick exit test: the barriers have already been claimed - this is
1458 // possible as there may be a race to claim and it doesn't matter
1459 // who wins.
1460 // All of the callers of this function (except the SuspendAllInternal)
1461 // will first test the kActiveSuspendBarrier flag without lock. Here
1462 // double-check whether the barrier has been passed with the
1463 // suspend_count lock.
1464 return false;
1465 }
1466
1467 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1468 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1469 tlsPtr_.active_suspend_barriers[i] = nullptr;
1470 }
1471 AtomicClearFlag(kActiveSuspendBarrier);
1472 }
1473
1474 uint32_t barrier_count = 0;
1475 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1476 AtomicInteger* pending_threads = pass_barriers[i];
1477 if (pending_threads != nullptr) {
1478 bool done = false;
1479 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001480 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001481 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1482 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001483 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001484#if ART_USE_FUTEXES
1485 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Charles Munger7530bae2018-10-29 20:03:51 -07001486 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, -1, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001487 }
1488#endif
1489 } while (!done);
1490 ++barrier_count;
1491 }
1492 }
1493 CHECK_GT(barrier_count, 0U);
1494 return true;
1495}
1496
1497void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1498 CHECK(ReadFlag(kActiveSuspendBarrier));
1499 bool clear_flag = true;
1500 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1501 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1502 if (ptr == target) {
1503 tlsPtr_.active_suspend_barriers[i] = nullptr;
1504 } else if (ptr != nullptr) {
1505 clear_flag = false;
1506 }
1507 }
1508 if (LIKELY(clear_flag)) {
1509 AtomicClearFlag(kActiveSuspendBarrier);
1510 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001511}
1512
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001513void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001514 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1515 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1516 Closure* checkpoint;
1517 {
1518 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1519 checkpoint = tlsPtr_.checkpoint_function;
1520 if (!checkpoint_overflow_.empty()) {
1521 // Overflow list not empty, copy the first one out and continue.
1522 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1523 checkpoint_overflow_.pop_front();
1524 } else {
1525 // No overflow checkpoints. Clear the kCheckpointRequest flag
1526 tlsPtr_.checkpoint_function = nullptr;
1527 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001528 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001529 }
1530 // Outside the lock, run the checkpoint function.
1531 ScopedTrace trace("Run checkpoint function");
1532 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1533 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001534}
1535
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001536void Thread::RunEmptyCheckpoint() {
1537 DCHECK_EQ(Thread::Current(), this);
1538 AtomicClearFlag(kEmptyCheckpointRequest);
1539 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1540}
1541
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001542bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001543 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001544 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001545 if (old_state_and_flags.as_struct.state != kRunnable) {
1546 return false; // Fail, thread is suspended and so can't run a checkpoint.
1547 }
Dave Allison0aded082013-11-07 13:15:11 -08001548
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001549 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001550 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001551 union StateAndFlags new_state_and_flags;
1552 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001553 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001554 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001555 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001556 if (success) {
1557 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1558 if (tlsPtr_.checkpoint_function == nullptr) {
1559 tlsPtr_.checkpoint_function = function;
1560 } else {
1561 checkpoint_overflow_.push_back(function);
1562 }
Dave Allison0aded082013-11-07 13:15:11 -08001563 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001564 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001565 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001566 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001567}
1568
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001569bool Thread::RequestEmptyCheckpoint() {
1570 union StateAndFlags old_state_and_flags;
1571 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1572 if (old_state_and_flags.as_struct.state != kRunnable) {
1573 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1574 // heap access (eg. the read barrier).
1575 return false;
1576 }
1577
1578 // We must be runnable to request a checkpoint.
1579 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1580 union StateAndFlags new_state_and_flags;
1581 new_state_and_flags.as_int = old_state_and_flags.as_int;
1582 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001583 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001584 old_state_and_flags.as_int, new_state_and_flags.as_int);
1585 if (success) {
1586 TriggerSuspend();
1587 }
1588 return success;
1589}
1590
Andreas Gampee9f67122016-10-27 19:21:23 -07001591class BarrierClosure : public Closure {
1592 public:
1593 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1594
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001595 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001596 wrapped_->Run(self);
1597 barrier_.Pass(self);
1598 }
1599
Alex Light318afe62018-03-22 16:50:10 -07001600 void Wait(Thread* self, ThreadState suspend_state) {
1601 if (suspend_state != ThreadState::kRunnable) {
1602 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1603 } else {
1604 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1605 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001606 }
1607
1608 private:
1609 Closure* wrapped_;
1610 Barrier barrier_;
1611};
1612
Alex Lightb1e31a82017-10-04 16:57:36 -07001613// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001614bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001615 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001616 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001617 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1618 // Unlock the tll before running so that the state is the same regardless of thread.
1619 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001620 // Asked to run on this thread. Just run.
1621 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001622 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001623 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001624
1625 // The current thread is not this thread.
1626
Andreas Gampe28c4a232017-06-21 21:21:31 -07001627 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001628 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001629 return false;
1630 }
1631
Andreas Gampe28c4a232017-06-21 21:21:31 -07001632 struct ScopedThreadListLockUnlock {
1633 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1634 : self_thread(self_in) {
1635 Locks::thread_list_lock_->AssertHeld(self_thread);
1636 Locks::thread_list_lock_->Unlock(self_thread);
1637 }
1638
1639 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1640 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1641 Locks::thread_list_lock_->Lock(self_thread);
1642 }
1643
1644 Thread* self_thread;
1645 };
1646
Andreas Gampee9f67122016-10-27 19:21:23 -07001647 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001648 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001649 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1650 // suspend-count lock for too long.
1651 if (GetState() == ThreadState::kRunnable) {
1652 BarrierClosure barrier_closure(function);
1653 bool installed = false;
1654 {
1655 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1656 installed = RequestCheckpoint(&barrier_closure);
1657 }
1658 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001659 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1660 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1661 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001662 ScopedThreadStateChange sts(self, suspend_state);
1663 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001664 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001665 }
1666 // Fall-through.
1667 }
1668
1669 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1670 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1671 // certain situations.
1672 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001673 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1674
Alex Light46f93402017-06-29 11:59:50 -07001675 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001676 // Just retry the loop.
1677 sched_yield();
1678 continue;
1679 }
1680 }
1681
Andreas Gampe28c4a232017-06-21 21:21:31 -07001682 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001683 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1684 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001685 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001686 {
Alex Light318afe62018-03-22 16:50:10 -07001687 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001688 while (GetState() == ThreadState::kRunnable) {
1689 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1690 // moves us to suspended.
1691 sched_yield();
1692 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001693 }
1694
1695 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001696 }
1697
Andreas Gampee9f67122016-10-27 19:21:23 -07001698 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001699 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1700
1701 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001702 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001703 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001704 }
1705
Andreas Gampe117f9b32017-06-23 13:33:50 -07001706 {
1707 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1708 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1709 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1710 Thread::resume_cond_->Broadcast(self);
1711 }
1712
Alex Lightb1e31a82017-10-04 16:57:36 -07001713 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1714 Locks::thread_list_lock_->ExclusiveUnlock(self);
1715
Andreas Gampe28c4a232017-06-21 21:21:31 -07001716 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001717 }
1718}
1719
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001720Closure* Thread::GetFlipFunction() {
1721 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1722 Closure* func;
1723 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001724 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001725 if (func == nullptr) {
1726 return nullptr;
1727 }
Orion Hodson4557b382018-01-03 11:47:54 +00001728 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001729 DCHECK(func != nullptr);
1730 return func;
1731}
1732
1733void Thread::SetFlipFunction(Closure* function) {
1734 CHECK(function != nullptr);
1735 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001736 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001737}
1738
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001739void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001740 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001741 VLOG(threads) << this << " self-suspending";
1742 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001743 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001744 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001745 VLOG(threads) << this << " self-reviving";
1746}
1747
Andreas Gampe9186ced2016-12-12 14:28:21 -08001748static std::string GetSchedulerGroupName(pid_t tid) {
1749 // /proc/<pid>/cgroup looks like this:
1750 // 2:devices:/
1751 // 1:cpuacct,cpu:/
1752 // We want the third field from the line whose second field contains the "cpu" token.
1753 std::string cgroup_file;
1754 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1755 return "";
1756 }
1757 std::vector<std::string> cgroup_lines;
1758 Split(cgroup_file, '\n', &cgroup_lines);
1759 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1760 std::vector<std::string> cgroup_fields;
1761 Split(cgroup_lines[i], ':', &cgroup_fields);
1762 std::vector<std::string> cgroups;
1763 Split(cgroup_fields[1], ',', &cgroups);
1764 for (size_t j = 0; j < cgroups.size(); ++j) {
1765 if (cgroups[j] == "cpu") {
1766 return cgroup_fields[2].substr(1); // Skip the leading slash.
1767 }
1768 }
1769 }
1770 return "";
1771}
1772
1773
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001774void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001775 std::string group_name;
1776 int priority;
1777 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001778 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001779
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001780 // If flip_function is not null, it means we have run a checkpoint
1781 // before the thread wakes up to execute the flip function and the
1782 // thread roots haven't been forwarded. So the following access to
1783 // the roots (opeer or methods in the frames) would be bad. Run it
1784 // here. TODO: clean up.
1785 if (thread != nullptr) {
1786 ScopedObjectAccessUnchecked soa(self);
1787 Thread* this_thread = const_cast<Thread*>(thread);
1788 Closure* flip_func = this_thread->GetFlipFunction();
1789 if (flip_func != nullptr) {
1790 flip_func->Run(this_thread);
1791 }
1792 }
1793
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001794 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1795 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001796 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001797 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001798 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001799 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001800 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001801 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001802
Mathieu Chartier3398c782016-09-30 10:27:43 -07001803 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001804 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1805 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001806
Dave Allison0aded082013-11-07 13:15:11 -08001807 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001808 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001809 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001810 ObjPtr<mirror::String> group_name_string =
1811 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001812 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001813 }
1814 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001815 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001816 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001817
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001818 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001819 if (scheduler_group_name.empty()) {
1820 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001821 }
1822
Dave Allison0aded082013-11-07 13:15:11 -08001823 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001824 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001825 if (is_daemon) {
1826 os << " daemon";
1827 }
1828 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001829 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001830 << " " << thread->GetState();
1831 if (thread->IsStillStarting()) {
1832 os << " (still starting up)";
1833 }
1834 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001835 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001836 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001837 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001838 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001839 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001840
Dave Allison0aded082013-11-07 13:15:11 -08001841 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001842 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001843 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001844 << " sCount=" << thread->tls32_.suspend_count
1845 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001846 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001847 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001848 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1849 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001850
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001851 os << " | sysTid=" << tid
1852 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001853 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001854 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001855 int policy;
1856 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001857#if !defined(__APPLE__)
1858 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1859 policy = sched_getscheduler(tid);
1860 if (policy == -1) {
1861 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1862 }
1863 int sched_getparam_result = sched_getparam(tid, &sp);
1864 if (sched_getparam_result == -1) {
1865 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1866 sp.sched_priority = -1;
1867 }
1868#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001869 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1870 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001871#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001872 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001873 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001874 }
1875 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001876
1877 // Grab the scheduler stats for this thread.
1878 std::string scheduler_stats;
Evan Chengd57c51e2018-01-26 15:43:08 +08001879 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)
1880 && !scheduler_stats.empty()) {
1881 scheduler_stats = android::base::Trim(scheduler_stats); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001882 } else {
1883 scheduler_stats = "0 0 0";
1884 }
1885
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001886 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001887 int utime = 0;
1888 int stime = 0;
1889 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001890 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001891
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001892 os << " | state=" << native_thread_state
1893 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001894 << " utm=" << utime
1895 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001896 << " core=" << task_cpu
1897 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001898 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001899 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1900 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1901 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001902 // Dump the held mutexes.
1903 os << " | held mutexes=";
1904 for (size_t i = 0; i < kLockLevelCount; ++i) {
1905 if (i != kMonitorLock) {
1906 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1907 if (mutex != nullptr) {
1908 os << " \"" << mutex->GetName() << "\"";
1909 if (mutex->IsReaderWriterMutex()) {
1910 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001911 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001912 os << "(exclusive held)";
1913 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001914 os << "(shared held)";
1915 }
1916 }
1917 }
1918 }
1919 }
1920 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001921 }
1922}
1923
1924void Thread::DumpState(std::ostream& os) const {
1925 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001926}
1927
Andreas Gampe93104952017-12-13 17:13:15 -08001928struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001929 StackDumpVisitor(std::ostream& os_in,
1930 Thread* thread_in,
1931 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001932 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001933 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001934 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001935 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001936 : MonitorObjectsStackVisitor(thread_in,
1937 context,
1938 check_suspended,
1939 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001940 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001941 last_method(nullptr),
1942 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001943 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001944
Ian Rogersbdb03912011-09-14 00:55:44 -07001945 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001946 if (frame_count == 0) {
1947 os << " (no managed stack frames)\n";
1948 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001949 }
1950
Andreas Gampe93104952017-12-13 17:13:15 -08001951 static constexpr size_t kMaxRepetition = 3u;
1952
1953 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001954 override
Andreas Gampe93104952017-12-13 17:13:15 -08001955 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001956 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001957 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001958 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001959 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001960 const DexFile* dex_file = dex_cache->GetDexFile();
1961 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001962 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001963 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001964 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001965 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001966 if (repetition_count >= kMaxRepetition) {
1967 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1968 }
1969 repetition_count = 0;
1970 last_line_number = line_number;
1971 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001972 }
Andreas Gampe93104952017-12-13 17:13:15 -08001973
1974 if (repetition_count >= kMaxRepetition) {
1975 // Skip visiting=printing anything.
1976 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001977 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001978
Andreas Gampe93104952017-12-13 17:13:15 -08001979 os << " at " << m->PrettyMethod(false);
1980 if (m->IsNative()) {
1981 os << "(Native method)";
1982 } else {
1983 const char* source_file(m->GetDeclaringClassSourceFile());
1984 os << "(" << (source_file != nullptr ? source_file : "unavailable")
1985 << ":" << line_number << ")";
1986 }
1987 os << "\n";
1988 // Go and visit locks.
1989 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001990 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001991
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001992 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08001993 return VisitMethodResult::kContinueMethod;
1994 }
1995
1996 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001997 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001998 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08001999 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
2000 }
2001 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002002 override
Andreas Gampe93104952017-12-13 17:13:15 -08002003 REQUIRES_SHARED(Locks::mutator_lock_) {
2004 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2005 }
2006 void VisitBlockedOnObject(mirror::Object* obj,
2007 ThreadState state,
2008 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002009 override
Andreas Gampe93104952017-12-13 17:13:15 -08002010 REQUIRES_SHARED(Locks::mutator_lock_) {
2011 const char* msg;
2012 switch (state) {
2013 case kBlocked:
2014 msg = " - waiting to lock ";
2015 break;
2016
2017 case kWaitingForLockInflation:
2018 msg = " - waiting for lock inflation of ";
2019 break;
2020
2021 default:
2022 LOG(FATAL) << "Unreachable";
2023 UNREACHABLE();
2024 }
2025 PrintObject(obj, msg, owner_tid);
2026 }
2027 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002028 override
Andreas Gampe93104952017-12-13 17:13:15 -08002029 REQUIRES_SHARED(Locks::mutator_lock_) {
2030 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2031 }
2032
2033 void PrintObject(mirror::Object* obj,
2034 const char* msg,
2035 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2036 if (obj == nullptr) {
2037 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002038 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002039 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002040 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2041 // Getting the identity hashcode here would result in lock inflation and suspension of the
2042 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002043 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
2044 reinterpret_cast<intptr_t>(obj),
2045 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002046 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002047 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2048 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2049 // suspension and move pretty_object.
2050 const std::string pretty_type(obj->PrettyTypeOf());
2051 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002052 }
2053 }
Andreas Gampe93104952017-12-13 17:13:15 -08002054 if (owner_tid != ThreadList::kInvalidThreadId) {
2055 os << " held by thread " << owner_tid;
2056 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002057 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002058 }
2059
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002060 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002061 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002062 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002063 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002064};
2065
Ian Rogers33e95662013-05-20 20:29:14 -07002066static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002067 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002068 ThreadState state = thread->GetState();
2069
2070 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2071 if (state > kWaiting && state < kStarting) {
2072 return true;
2073 }
2074
2075 // In an Object.wait variant or Thread.sleep? That's not interesting.
2076 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2077 return false;
2078 }
2079
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002080 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002081 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002082 return true;
2083 }
2084
Elliott Hughesaef701d2013-04-05 18:15:40 -07002085 // In some other native method? That's interesting.
2086 // We don't just check kNative because native methods will be in state kSuspended if they're
2087 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2088 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002089 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002090 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002091}
2092
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002093void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002094 // If flip_function is not null, it means we have run a checkpoint
2095 // before the thread wakes up to execute the flip function and the
2096 // thread roots haven't been forwarded. So the following access to
2097 // the roots (locks or methods in the frames) would be bad. Run it
2098 // here. TODO: clean up.
2099 {
2100 Thread* this_thread = const_cast<Thread*>(this);
2101 Closure* flip_func = this_thread->GetFlipFunction();
2102 if (flip_func != nullptr) {
2103 flip_func->Run(this_thread);
2104 }
2105 }
2106
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002107 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2108 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002109 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2110 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002111 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002112 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002113 bool have_exception = false;
2114 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002115 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002116 const_cast<Thread*>(this)->ClearException();
2117 have_exception = true;
2118 }
2119
Ian Rogers700a4022014-05-19 16:49:03 -07002120 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002121 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002122 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002123 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002124
2125 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002126 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002127 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002128}
2129
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002130void Thread::DumpStack(std::ostream& os,
2131 bool dump_native_stack,
2132 BacktraceMap* backtrace_map,
2133 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002134 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2135 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2136 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002137 bool dump_for_abort = (gAborting > 0);
2138 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2139 if (!kIsDebugBuild) {
2140 // We always want to dump the stack for an abort, however, there is no point dumping another
2141 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2142 safe_to_dump = (safe_to_dump || dump_for_abort);
2143 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002144 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002145 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002146 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002147 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002148 ArtMethod* method =
2149 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002150 /*check_suspended=*/ !force_dump_stack,
2151 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002152 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002153 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002154 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002155 /*check_suspended=*/ !force_dump_stack,
2156 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002157 } else {
2158 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002159 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002160}
2161
Elliott Hughesbe759c62011-09-08 19:38:21 -07002162void Thread::ThreadExitCallback(void* arg) {
2163 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002164 if (self->tls32_.thread_exit_check_count == 0) {
2165 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2166 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002167 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002168#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002169 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2170#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002171 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002172#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002173 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002174 } else {
2175 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2176 }
Carl Shapirob5573532011-07-12 18:22:59 -07002177}
2178
Elliott Hughesbe759c62011-09-08 19:38:21 -07002179void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002180 CHECK(!is_started_);
2181 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002182 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002183 // MutexLock to keep annotalysis happy.
2184 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002185 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002186 // return garbage since (is_started_ == true) and
2187 // Thread::pthread_key_self_ is not yet initialized.
2188 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002189 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002190 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2191 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002192 }
2193
Carl Shapirob5573532011-07-12 18:22:59 -07002194 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002195 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2196 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002197
2198 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002199 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2200 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002201 }
Elliott Hughes038a8062011-09-18 14:12:41 -07002202}
Carl Shapirob5573532011-07-12 18:22:59 -07002203
Elliott Hughes038a8062011-09-18 14:12:41 -07002204void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002205 Runtime* runtime = Runtime::Current();
2206 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002207
Elliott Hughes01158d72011-09-19 19:47:10 -07002208 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002209 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002210 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2211 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002212
Vladimir Markodcfcce42018-06-27 10:00:28 +00002213 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002214
2215 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2216 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002217 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2218 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002219}
2220
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002221void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002222 CHECK(is_started_);
2223 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002224 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002225 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002226 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002227 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002228 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002229 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002230}
2231
Andreas Gampe56776012018-01-26 17:40:55 -08002232void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2233 ScopedLocalRef<jobject> thread_jobject(
2234 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2235 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2236 soa.Env(), nullptr);
2237 jobject thread_group_jobject = thread_group;
2238 if (thread_group == nullptr || kIsDebugBuild) {
2239 // There is always a group set. Retrieve it.
2240 thread_group_jobject_scoped.reset(
2241 soa.Env()->GetObjectField(thread_jobject.get(),
2242 WellKnownClasses::java_lang_Thread_group));
2243 thread_group_jobject = thread_group_jobject_scoped.get();
2244 if (kIsDebugBuild && thread_group != nullptr) {
2245 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2246 }
2247 }
2248 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2249 WellKnownClasses::java_lang_ThreadGroup,
2250 WellKnownClasses::java_lang_ThreadGroup_add,
2251 thread_jobject.get());
2252}
2253
Calin Juravleccd56952016-12-15 17:57:38 +00002254Thread::Thread(bool daemon)
2255 : tls32_(daemon),
2256 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002257 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002258 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002259 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002260 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2261 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2262
Roland Levillain33d69032015-06-18 18:20:59 +01002263 static_assert((sizeof(Thread) % 4) == 0U,
2264 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002265 tls32_.state_and_flags.as_struct.flags = 0;
2266 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002267 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002268 // Initialize with no permit; if the java Thread was unparked before being
2269 // started, it will unpark itself before calling into java code.
2270 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002271 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002272 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002273 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002274 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002275 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002276 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2277 tlsPtr_.active_suspend_barriers[i] = nullptr;
2278 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002279 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002280 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002281 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002282 tls32_.use_mterp = false;
2283}
2284
2285void Thread::NotifyInTheadList() {
2286 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002287}
2288
Alex Lighte9f61032018-09-24 16:04:51 -07002289bool Thread::CanLoadClasses() const {
2290 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2291}
2292
Elliott Hughes7dc51662012-05-16 14:48:43 -07002293bool Thread::IsStillStarting() const {
2294 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002295 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002296 // 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 -07002297 // assigned fairly early on, and needs to be.
2298 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2299 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002300 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2301 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002302}
2303
Andreas Gamped9efea62014-07-21 22:56:08 -07002304void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002305 CHECK(IsExceptionPending()) << "Pending exception expected.";
2306}
2307
2308void Thread::AssertPendingOOMException() const {
2309 AssertPendingException();
2310 auto* e = GetException();
2311 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2312 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002313}
2314
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002315void Thread::AssertNoPendingException() const {
2316 if (UNLIKELY(IsExceptionPending())) {
2317 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002318 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002319 }
2320}
2321
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002322void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2323 if (UNLIKELY(IsExceptionPending())) {
2324 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002325 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002326 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002327 }
2328}
2329
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002330class MonitorExitVisitor : public SingleRootVisitor {
2331 public:
2332 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2333
2334 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2335 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002336 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002337 if (self_->HoldsLock(entered_monitor)) {
2338 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002339 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002340 << " left locked by native thread "
2341 << *Thread::Current() << " which is detaching";
2342 entered_monitor->MonitorExit(self_);
2343 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002344 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002345
2346 private:
2347 Thread* const self_;
2348};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002349
Elliott Hughesc0f09332012-03-26 13:27:06 -07002350void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002351 Thread* self = this;
2352 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002353
Ian Rogers68d8b422014-07-17 11:09:10 -07002354 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002355 {
2356 ScopedObjectAccess soa(self);
2357 MonitorExitVisitor visitor(self);
2358 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002359 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002360 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002361 // Release locally held global references which releasing may require the mutator lock.
2362 if (tlsPtr_.jpeer != nullptr) {
2363 // If pthread_create fails we don't have a jni env here.
2364 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2365 tlsPtr_.jpeer = nullptr;
2366 }
2367 if (tlsPtr_.class_loader_override != nullptr) {
2368 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2369 tlsPtr_.class_loader_override = nullptr;
2370 }
2371 }
2372
Ian Rogersdd7624d2014-03-14 17:43:00 -07002373 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002374 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002375 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002376 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002377 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002378 Runtime* runtime = Runtime::Current();
2379 if (runtime != nullptr) {
2380 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2381 }
Elliott Hughes534da072012-03-27 15:17:42 -07002382
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002383 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002384 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002385 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002386 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002387 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002388 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002389 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002390 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002391
Ian Rogerscfaa4552012-11-26 21:00:08 -08002392 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2393 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002394 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002395 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002396 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002397 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002398 StackHandleScope<1> hs(self);
2399 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002400 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002401 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002402 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002403 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002404 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002405
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002406 {
2407 ScopedObjectAccess soa(self);
2408 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002409 if (kUseReadBarrier) {
2410 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2411 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002412 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002413}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002414
Elliott Hughesc0f09332012-03-26 13:27:06 -07002415Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002416 CHECK(tlsPtr_.class_loader_override == nullptr);
2417 CHECK(tlsPtr_.jpeer == nullptr);
2418 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002419 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002420 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002421 delete tlsPtr_.jni_env;
2422 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002423 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002424 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002425 CHECK(!ReadFlag(kCheckpointRequest));
2426 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002427 CHECK(tlsPtr_.checkpoint_function == nullptr);
2428 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002429 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002430 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002431
Sebastien Hertz07474662015-08-25 15:12:33 +00002432 // Make sure we processed all deoptimization requests.
2433 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002434 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2435 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002436
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002437 // We may be deleting a still born thread.
2438 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002439
2440 delete wait_cond_;
2441 delete wait_mutex_;
2442
Ian Rogersdd7624d2014-03-14 17:43:00 -07002443 if (tlsPtr_.long_jump_context != nullptr) {
2444 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002445 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002446
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002447 if (initialized) {
2448 CleanupCpu();
2449 }
2450
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002451 if (tlsPtr_.single_step_control != nullptr) {
2452 delete tlsPtr_.single_step_control;
2453 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002454 delete tlsPtr_.instrumentation_stack;
2455 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002456 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002457
Ian Rogers68d8b422014-07-17 11:09:10 -07002458 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002459
Elliott Hughesd8af1592012-04-16 20:40:15 -07002460 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002461}
2462
Andreas Gampe513061a2017-06-01 09:17:34 -07002463void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002464 if (!IsExceptionPending()) {
2465 return;
2466 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002467 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002468 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002469
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002470 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002471 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2472 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002473
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002474 // Call the Thread instance's dispatchUncaughtException(Throwable)
2475 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2476 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2477 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002478
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002479 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002480 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002481}
2482
Andreas Gampe513061a2017-06-01 09:17:34 -07002483void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002484 // this.group.removeThread(this);
2485 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002486 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002487 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002488 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002489 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002490 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002491 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002492 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2493 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2494 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002495 }
2496}
2497
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002498bool Thread::HandleScopeContains(jobject obj) const {
2499 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002500 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002501 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002502 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002503 return true;
2504 }
2505 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002506 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2507 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002508}
2509
Hans Boehm0882af22017-08-31 15:21:57 -07002510void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002511 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2512 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002513 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2514 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002515 }
2516}
2517
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002518ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002519 if (obj == nullptr) {
2520 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002521 }
2522 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002523 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002524 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002525 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002526 // The "kinds" below are sorted by the frequency we expect to encounter them.
2527 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002528 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002529 // Local references do not need a read barrier.
2530 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002531 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002532 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002533 // Check if this is a local reference in the handle scope.
2534 if (LIKELY(HandleScopeContains(obj))) {
2535 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002536 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002537 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002538 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002539 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002540 expect_null = true;
2541 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002542 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002543 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002544 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002545 } else {
2546 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002547 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002548 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002549 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002550 expect_null = true;
2551 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002552 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002553 }
2554
Ian Rogersc0542af2014-09-03 16:16:56 -07002555 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002556 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002557 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002558 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002559 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002560}
2561
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002562bool Thread::IsJWeakCleared(jweak obj) const {
2563 CHECK(obj != nullptr);
2564 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002565 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002566 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002567 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002568}
2569
Ian Rogers81d425b2012-09-27 16:03:43 -07002570// Implements java.lang.Thread.interrupted.
2571bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002572 DCHECK_EQ(Thread::Current(), this);
2573 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002574 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002575 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002576 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002577 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002578 return interrupted;
2579}
2580
2581// Implements java.lang.Thread.isInterrupted.
2582bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002583 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002584}
2585
Ian Rogersdd7624d2014-03-14 17:43:00 -07002586void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002587 {
2588 MutexLock mu(self, *wait_mutex_);
2589 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2590 return;
2591 }
2592 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2593 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002594 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002595 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002596}
2597
2598void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002599 Thread* self = Thread::Current();
2600 MutexLock mu(self, *wait_mutex_);
2601 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002602}
2603
Ian Rogersc604d732012-10-14 16:09:54 -07002604void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002605 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002606 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002607 }
2608}
2609
Ian Rogers68d8b422014-07-17 11:09:10 -07002610void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2611 if (tlsPtr_.class_loader_override != nullptr) {
2612 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2613 }
2614 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2615}
2616
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002617using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2618
2619// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2620class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002621 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002622 explicit FetchStackTraceVisitor(Thread* thread,
2623 ArtMethodDexPcPair* saved_frames = nullptr,
2624 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002625 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002626 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002627 saved_frames_(saved_frames),
2628 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002629
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002630 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002631 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002632 // Note we also skip the frame if it doesn't have a method (namely the callee
2633 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002634 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002635 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002636 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002637 skipping_ = false;
2638 }
2639 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002640 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002641 if (depth_ < max_saved_frames_) {
2642 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002643 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002644 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002645 ++depth_;
2646 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002647 } else {
2648 ++skip_depth_;
2649 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002650 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002651 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002652
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002653 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002654 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002655 }
2656
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002657 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002658 return skip_depth_;
2659 }
2660
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002661 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002662 uint32_t depth_ = 0;
2663 uint32_t skip_depth_ = 0;
2664 bool skipping_ = true;
2665 ArtMethodDexPcPair* saved_frames_;
2666 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002667
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002668 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002669};
2670
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002671template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002672class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002673 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002674 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002675 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2676 self_(self),
2677 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002678 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002679
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002680 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002681 // Allocate method trace as an object array where the first element is a pointer array that
2682 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2683 // class of the ArtMethod pointers.
2684 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2685 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002686 ObjPtr<mirror::Class> array_class =
2687 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002688 // The first element is the methods and dex pc array, the other elements are declaring classes
2689 // for the methods to ensure classes in the stack trace don't get unloaded.
2690 Handle<mirror::ObjectArray<mirror::Object>> trace(
2691 hs.NewHandle(
2692 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002693 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002694 // Acquire uninterruptible_ in all paths.
2695 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002696 self_->AssertPendingOOMException();
2697 return false;
2698 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002699 ObjPtr<mirror::PointerArray> methods_and_pcs =
2700 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002701 const char* last_no_suspend_cause =
2702 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2703 if (methods_and_pcs == nullptr) {
2704 self_->AssertPendingOOMException();
2705 return false;
2706 }
2707 trace->Set(0, methods_and_pcs);
2708 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002709 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002710 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002711 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002712 }
2713
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002714 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2715 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002716 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002717
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002718 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002719 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002720 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002721 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002722 if (skip_depth_ > 0) {
2723 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002724 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002725 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002726 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002727 if (m->IsRuntimeMethod()) {
2728 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002729 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002730 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002731 return true;
2732 }
2733
2734 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002735 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002736 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002737 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2738 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002739 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002740 pointer_size_);
2741 // Save the declaring class of the method to ensure that the declaring classes of the methods
2742 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002743 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002744 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002745 }
2746
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002747 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
2748 return ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(trace_->Get(0)));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002749 }
2750
2751 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002752 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002753 }
2754
2755 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002756 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002757 // How many more frames to skip.
2758 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002759 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002760 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002761 // An object array where the first element is a pointer array that contains the ArtMethod
2762 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2763 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2764 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002765 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002766 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002767 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002768
2769 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002770};
2771
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002772template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002773jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002774 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2775 constexpr size_t kMaxSavedFrames = 256;
2776 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2777 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2778 &saved_frames[0],
2779 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002780 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002781 const uint32_t depth = count_visitor.GetDepth();
2782 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002783
Ian Rogers1f539342012-10-03 21:09:42 -07002784 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002785 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2786 const_cast<Thread*>(this),
2787 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002788 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002789 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002790 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002791 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2792 // than doing the stack walk twice.
2793 if (depth < kMaxSavedFrames) {
2794 for (size_t i = 0; i < depth; ++i) {
2795 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2796 }
2797 } else {
2798 build_trace_visitor.WalkStack();
2799 }
2800
Mathieu Chartier910e8272015-09-30 09:24:22 -07002801 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002802 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002803 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002804 // Second half of trace_methods is dex PCs.
2805 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2806 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002807 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2808 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002809 }
2810 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002811 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002812}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002813template jobject Thread::CreateInternalStackTrace<false>(
2814 const ScopedObjectAccessAlreadyRunnable& soa) const;
2815template jobject Thread::CreateInternalStackTrace<true>(
2816 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002817
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002818bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002819 // Only count the depth since we do not pass a stack frame array as an argument.
2820 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002821 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002822 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002823}
2824
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002825static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2826 const ScopedObjectAccessAlreadyRunnable& soa,
2827 ArtMethod* method,
2828 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2829 int32_t line_number;
2830 StackHandleScope<3> hs(soa.Self());
2831 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2832 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2833 if (method->IsProxyMethod()) {
2834 line_number = -1;
2835 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2836 // source_name_object intentionally left null for proxy methods
2837 } else {
2838 line_number = method->GetLineNumFromDexPC(dex_pc);
2839 // Allocate element, potentially triggering GC
2840 // TODO: reuse class_name_object via Class::name_?
2841 const char* descriptor = method->GetDeclaringClassDescriptor();
2842 CHECK(descriptor != nullptr);
2843 std::string class_name(PrettyDescriptor(descriptor));
2844 class_name_object.Assign(
2845 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2846 if (class_name_object == nullptr) {
2847 soa.Self()->AssertPendingOOMException();
2848 return nullptr;
2849 }
2850 const char* source_file = method->GetDeclaringClassSourceFile();
2851 if (line_number == -1) {
2852 // Make the line_number field of StackTraceElement hold the dex pc.
2853 // source_name_object is intentionally left null if we failed to map the dex pc to
2854 // a line number (most probably because there is no debug info). See b/30183883.
2855 line_number = dex_pc;
2856 } else {
2857 if (source_file != nullptr) {
2858 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2859 if (source_name_object == nullptr) {
2860 soa.Self()->AssertPendingOOMException();
2861 return nullptr;
2862 }
2863 }
2864 }
2865 }
2866 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2867 CHECK(method_name != nullptr);
2868 Handle<mirror::String> method_name_object(
2869 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2870 if (method_name_object == nullptr) {
2871 return nullptr;
2872 }
2873 return mirror::StackTraceElement::Alloc(soa.Self(),
2874 class_name_object,
2875 method_name_object,
2876 source_name_object,
2877 line_number);
2878}
2879
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002880jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002881 const ScopedObjectAccessAlreadyRunnable& soa,
2882 jobject internal,
2883 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002884 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002885 // Decode the internal stack trace into the depth, method trace and PC trace.
2886 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002887 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002888 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002889
Mathieu Chartier910e8272015-09-30 09:24:22 -07002890 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002891
Elliott Hughes01158d72011-09-19 19:47:10 -07002892 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002893
Dave Allison0aded082013-11-07 13:15:11 -08002894 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002895 // Reuse the array we were given.
2896 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002897 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002898 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002899 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002900 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002901 } else {
2902 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002903 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002904 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002905 if (java_traces == nullptr) {
2906 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002907 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002908 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002909 }
2910
Dave Allison0aded082013-11-07 13:15:11 -08002911 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002912 *stack_depth = depth;
2913 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002914
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002915 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002916 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002917 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002918 // Methods and dex PC trace is element 0.
2919 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002920 ObjPtr<mirror::PointerArray> const method_trace =
2921 ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(decoded_traces->Get(0)));
Ian Rogersaaa20802011-09-11 21:47:37 -07002922 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002923 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002924 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002925 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002926 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002927 if (obj == nullptr) {
2928 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002929 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002930 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002931 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002932 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002933 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002934}
2935
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002936jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2937 // This code allocates. Do not allow it to operate with a pending exception.
2938 if (IsExceptionPending()) {
2939 return nullptr;
2940 }
2941
2942 // If flip_function is not null, it means we have run a checkpoint
2943 // before the thread wakes up to execute the flip function and the
2944 // thread roots haven't been forwarded. So the following access to
2945 // the roots (locks or methods in the frames) would be bad. Run it
2946 // here. TODO: clean up.
2947 // Note: copied from DumpJavaStack.
2948 {
2949 Thread* this_thread = const_cast<Thread*>(this);
2950 Closure* flip_func = this_thread->GetFlipFunction();
2951 if (flip_func != nullptr) {
2952 flip_func->Run(this_thread);
2953 }
2954 }
2955
2956 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2957 public:
2958 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2959 Thread* self,
2960 Context* context)
2961 : MonitorObjectsStackVisitor(self, context),
2962 wait_jobject_(soaa_in.Env(), nullptr),
2963 block_jobject_(soaa_in.Env(), nullptr),
2964 soaa_(soaa_in) {}
2965
2966 protected:
2967 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002968 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002969 REQUIRES_SHARED(Locks::mutator_lock_) {
2970 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
2971 soaa_, m, GetDexPc(/* abort on error */ false));
2972 if (obj == nullptr) {
2973 return VisitMethodResult::kEndStackWalk;
2974 }
2975 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
2976 return VisitMethodResult::kContinueMethod;
2977 }
2978
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002979 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002980 lock_objects_.push_back({});
2981 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
2982
2983 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
2984
2985 return VisitMethodResult::kContinueMethod;
2986 }
2987
2988 void VisitWaitingObject(mirror::Object* obj, ThreadState state 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 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2992 }
2993 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002994 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002995 REQUIRES_SHARED(Locks::mutator_lock_) {
2996 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2997 }
2998 void VisitBlockedOnObject(mirror::Object* obj,
2999 ThreadState state ATTRIBUTE_UNUSED,
3000 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003001 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003002 REQUIRES_SHARED(Locks::mutator_lock_) {
3003 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3004 }
3005 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003006 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003007 REQUIRES_SHARED(Locks::mutator_lock_) {
3008 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3009 }
3010
3011 public:
3012 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3013 ScopedLocalRef<jobject> wait_jobject_;
3014 ScopedLocalRef<jobject> block_jobject_;
3015 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3016
3017 private:
3018 const ScopedObjectAccessAlreadyRunnable& soaa_;
3019
3020 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3021 };
3022
3023 std::unique_ptr<Context> context(Context::Create());
3024 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3025 dumper.WalkStack();
3026
3027 // There should not be a pending exception. Otherwise, return with it pending.
3028 if (IsExceptionPending()) {
3029 return nullptr;
3030 }
3031
3032 // Now go and create Java arrays.
3033
3034 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3035
3036 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003037 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003038 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003039 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3040 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003041 return nullptr;
3042 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003043 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003044
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003045 Handle<mirror::Class> h_o_array_class =
3046 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3047 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003048
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003049
3050 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3051 class_linker->EnsureInitialized(soa.Self(),
3052 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003053 /* can_init_fields= */ true,
3054 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003055 if (soa.Self()->IsExceptionPending()) {
3056 // This should not fail in a healthy runtime.
3057 return nullptr;
3058 }
3059
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003060 ArtField* stack_trace_element_field = h_aste_class->FindField(
3061 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3062 DCHECK(stack_trace_element_field != nullptr);
3063 ArtField* held_locks_field = h_aste_class->FindField(
3064 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3065 DCHECK(held_locks_field != nullptr);
3066 ArtField* blocked_on_field = h_aste_class->FindField(
3067 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3068 DCHECK(blocked_on_field != nullptr);
3069
3070 size_t length = dumper.stack_trace_elements_.size();
3071 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003072 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003073 if (array == nullptr) {
3074 soa.Self()->AssertPendingOOMException();
3075 return nullptr;
3076 }
3077
3078 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3079
3080 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3081 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3082 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3083 for (size_t i = 0; i != length; ++i) {
3084 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3085 if (handle == nullptr) {
3086 soa.Self()->AssertPendingOOMException();
3087 return nullptr;
3088 }
3089
3090 // Set stack trace element.
3091 stack_trace_element_field->SetObject<false>(
3092 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3093
3094 // Create locked-on array.
3095 if (!dumper.lock_objects_[i].empty()) {
3096 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3097 h_o_array_class.Get(),
3098 dumper.lock_objects_[i].size()));
3099 if (handle2 == nullptr) {
3100 soa.Self()->AssertPendingOOMException();
3101 return nullptr;
3102 }
3103 int32_t j = 0;
3104 for (auto& scoped_local : dumper.lock_objects_[i]) {
3105 if (scoped_local == nullptr) {
3106 continue;
3107 }
3108 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3109 DCHECK(!soa.Self()->IsExceptionPending());
3110 j++;
3111 }
3112 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3113 }
3114
3115 // Set blocked-on object.
3116 if (i == 0) {
3117 if (dumper.block_jobject_ != nullptr) {
3118 blocked_on_field->SetObject<false>(
3119 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3120 }
3121 }
3122
3123 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3124 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3125 DCHECK(!soa.Self()->IsExceptionPending());
3126 }
3127
3128 return result.release();
3129}
3130
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003131void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003132 va_list args;
3133 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003134 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003135 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003136}
3137
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003138void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003139 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003140 std::string msg;
3141 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003142 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003143}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003144
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003145void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003146 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003147 // Callers should either clear or call ThrowNewWrappedException.
3148 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003149 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003150}
3151
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003152static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003153 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003154 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003155 return method != nullptr
3156 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003157 : nullptr;
3158}
3159
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003160void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003161 const char* msg) {
3162 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003163 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003164 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003165 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003166 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003167 ClearException();
3168 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003169 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003170 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003171 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003172 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003173 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003174 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003175 return;
3176 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003177
Ian Rogers7b078e82014-09-10 14:44:24 -07003178 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3179 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003180 DCHECK(IsExceptionPending());
3181 return;
3182 }
3183 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003184 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003185 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003186
Mathieu Chartier590fee92013-09-13 13:46:47 -07003187 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003188 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003189 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3190 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003191 return;
3192 }
3193
Ian Rogers62d6c772013-02-27 08:32:07 -08003194 // Choose an appropriate constructor and set up the arguments.
3195 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003196 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003197 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003198 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003199 msg_string.reset(
3200 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003201 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003202 CHECK(IsExceptionPending()); // OOME.
3203 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003204 }
Dave Allison0aded082013-11-07 13:15:11 -08003205 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003206 signature = "(Ljava/lang/String;)V";
3207 } else {
3208 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3209 }
3210 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003211 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003212 signature = "()V";
3213 } else {
3214 signature = "(Ljava/lang/Throwable;)V";
3215 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003216 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003217 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003218 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003219
Dave Allison0aded082013-11-07 13:15:11 -08003220 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003221 << PrettyDescriptor(exception_class_descriptor);
3222
3223 if (UNLIKELY(!runtime->IsStarted())) {
3224 // Something is trying to throw an exception without a started runtime, which is the common
3225 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3226 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003227 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003228 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003229 }
Dave Allison0aded082013-11-07 13:15:11 -08003230 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003231 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003232 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003233 ScopedLocalRef<jobject> trace(GetJniEnv(),
3234 Runtime::Current()->IsActiveTransaction()
3235 ? CreateInternalStackTrace<true>(soa)
3236 : CreateInternalStackTrace<false>(soa));
3237 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003238 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003239 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003240 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003241 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003242 jvalue jv_args[2];
3243 size_t i = 0;
3244
Dave Allison0aded082013-11-07 13:15:11 -08003245 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003246 jv_args[i].l = msg_string.get();
3247 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003248 }
Dave Allison0aded082013-11-07 13:15:11 -08003249 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003250 jv_args[i].l = cause.get();
3251 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003252 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003253 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08003254 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003255 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003256 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003257 }
Elliott Hughes30646832011-10-13 16:59:46 -07003258 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003259}
3260
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003261void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003262 LOG(WARNING) << "Throwing OutOfMemoryError "
3263 << '"' << msg << '"'
3264 << " (VmSize " << GetProcessStatus("VmSize")
3265 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003266 if (!tls32_.throwing_OutOfMemoryError) {
3267 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003268 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003269 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003270 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003271 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003272 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003273 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003274}
3275
Elliott Hughes498508c2011-10-17 14:58:22 -07003276Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003277 return Thread::Current();
3278}
3279
3280void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003281 std::ostringstream ss;
3282 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003283 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003284 // log to stderr for debugging command line processes
3285 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003286#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003287 // log to logcat for debugging frameworks processes
3288 LOG(INFO) << str;
3289#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003290}
3291
Ian Rogersdd7624d2014-03-14 17:43:00 -07003292// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003293template
3294void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3295template
3296void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003297
Andreas Gampe542451c2016-07-26 09:02:02 -07003298template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003299void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3300#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003301 if (offset == (x).Uint32Value()) { \
3302 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003303 return; \
3304 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003305 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3306 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3307 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3308 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3309 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3310 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3311 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3312 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003313 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003314 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003315 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003316 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003317 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003318#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003319
Ian Rogersdd7624d2014-03-14 17:43:00 -07003320#define JNI_ENTRY_POINT_INFO(x) \
3321 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3322 os << #x; \
3323 return; \
3324 }
3325 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3326#undef JNI_ENTRY_POINT_INFO
3327
Ian Rogersdd7624d2014-03-14 17:43:00 -07003328#define QUICK_ENTRY_POINT_INFO(x) \
3329 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3330 os << #x; \
3331 return; \
3332 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003333 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003334 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3335 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3336 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3337 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003338 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3339 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003340 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003341 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003342 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3343 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3344 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003345 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003346 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003347 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003348 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3349 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003350 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003351 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3352 QUICK_ENTRY_POINT_INFO(pSet8Static)
3353 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3354 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003355 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3356 QUICK_ENTRY_POINT_INFO(pSet32Static)
3357 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3358 QUICK_ENTRY_POINT_INFO(pSet64Static)
3359 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3360 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003361 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3362 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3363 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3364 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3365 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3366 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3367 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3368 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003369 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3370 QUICK_ENTRY_POINT_INFO(pGet32Static)
3371 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3372 QUICK_ENTRY_POINT_INFO(pGet64Static)
3373 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3374 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003375 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003376 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3377 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3378 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3379 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3380 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3381 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3382 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3383 QUICK_ENTRY_POINT_INFO(pLockObject)
3384 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3385 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3386 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3387 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3388 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003389 QUICK_ENTRY_POINT_INFO(pCos)
3390 QUICK_ENTRY_POINT_INFO(pSin)
3391 QUICK_ENTRY_POINT_INFO(pAcos)
3392 QUICK_ENTRY_POINT_INFO(pAsin)
3393 QUICK_ENTRY_POINT_INFO(pAtan)
3394 QUICK_ENTRY_POINT_INFO(pAtan2)
3395 QUICK_ENTRY_POINT_INFO(pCbrt)
3396 QUICK_ENTRY_POINT_INFO(pCosh)
3397 QUICK_ENTRY_POINT_INFO(pExp)
3398 QUICK_ENTRY_POINT_INFO(pExpm1)
3399 QUICK_ENTRY_POINT_INFO(pHypot)
3400 QUICK_ENTRY_POINT_INFO(pLog)
3401 QUICK_ENTRY_POINT_INFO(pLog10)
3402 QUICK_ENTRY_POINT_INFO(pNextAfter)
3403 QUICK_ENTRY_POINT_INFO(pSinh)
3404 QUICK_ENTRY_POINT_INFO(pTan)
3405 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003406 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003407 QUICK_ENTRY_POINT_INFO(pL2d)
3408 QUICK_ENTRY_POINT_INFO(pFmodf)
3409 QUICK_ENTRY_POINT_INFO(pL2f)
3410 QUICK_ENTRY_POINT_INFO(pD2iz)
3411 QUICK_ENTRY_POINT_INFO(pF2iz)
3412 QUICK_ENTRY_POINT_INFO(pIdivmod)
3413 QUICK_ENTRY_POINT_INFO(pD2l)
3414 QUICK_ENTRY_POINT_INFO(pF2l)
3415 QUICK_ENTRY_POINT_INFO(pLdiv)
3416 QUICK_ENTRY_POINT_INFO(pLmod)
3417 QUICK_ENTRY_POINT_INFO(pLmul)
3418 QUICK_ENTRY_POINT_INFO(pShlLong)
3419 QUICK_ENTRY_POINT_INFO(pShrLong)
3420 QUICK_ENTRY_POINT_INFO(pUshrLong)
3421 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003422 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3423 QUICK_ENTRY_POINT_INFO(pMemcpy)
3424 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3425 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3426 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3427 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3428 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3429 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3430 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3431 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003432 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003433 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3434 QUICK_ENTRY_POINT_INFO(pDeliverException)
3435 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3436 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003437 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3438 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003439 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003440 QUICK_ENTRY_POINT_INFO(pA64Load)
3441 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003442 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3443 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3444 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3445 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3446 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3447 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3448 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3449 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3450 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3451 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3452 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3453 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3454 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3455 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3456 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3457 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003458 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003459 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3460 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3461 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3462 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3463 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3464 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3465 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3466 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3467 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3468 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3469 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3470 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3471 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3472 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3473 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3474 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3475 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3476 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3477 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3478 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3479 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3480 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3481 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3482 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3483 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3484 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3485 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3486 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3487 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3488 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003489 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003490 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003491
3492 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3493 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003494#undef QUICK_ENTRY_POINT_INFO
3495
Elliott Hughes98e20172012-04-24 15:38:13 -07003496 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003497}
3498
jeffhao94d6df42012-11-26 16:02:12 -08003499void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003500 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003501 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003502 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003503 if (exception == GetDeoptimizationException()) {
3504 artDeoptimize(this);
3505 UNREACHABLE();
3506 }
3507
Roland Levillaina78f5b62017-09-29 13:50:44 +01003508 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003509
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003510 // This is a real exception: let the instrumentation know about it.
3511 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003512 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003513 IsExceptionThrownByCurrentMethod(exception)) {
3514 // Instrumentation may cause GC so keep the exception object safe.
3515 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003516 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Alex Light6e1607e2017-08-23 10:06:18 -07003517 instrumentation->ExceptionThrownEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003518 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003519 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3520 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3521 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3522 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003523 //
3524 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3525 // expected to happen fairly regularly but the second can only happen if we are using
3526 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3527 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003528 ShadowFrame* cf;
Alex Lightbe1f8d02018-10-15 11:44:42 -07003529 bool force_deopt;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003530 {
3531 NthCallerVisitor visitor(this, 0, false);
3532 visitor.WalkStack();
3533 cf = visitor.GetCurrentShadowFrame();
3534 if (cf == nullptr) {
3535 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3536 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003537 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3538 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003539 if (kIsDebugBuild && force_frame_pop) {
3540 NthCallerVisitor penultimate_visitor(this, 1, false);
3541 penultimate_visitor.WalkStack();
3542 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3543 if (penultimate_frame == nullptr) {
3544 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3545 }
3546 DCHECK(penultimate_frame != nullptr &&
3547 penultimate_frame->GetForceRetryInstruction())
3548 << "Force pop frame without retry instruction found. penultimate frame is null: "
3549 << (penultimate_frame == nullptr ? "true" : "false");
3550 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003551 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003552 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003553 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003554 NthCallerVisitor visitor(this, 0, false);
3555 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003556 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003557 // method_type shouldn't matter due to exception handling.
3558 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003559 // Save the exception into the deoptimization context so it can be restored
3560 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003561 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003562 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3563 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3564 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003565 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3566 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003567 ClearException();
3568 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003569 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003570 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003571 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003572 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003573 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003574 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003575 artDeoptimize(this);
3576 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003577 } else {
3578 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3579 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003580 }
3581 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003582
Ian Rogers28ad40d2011-10-27 15:19:26 -07003583 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003584 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003585 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003586 QuickExceptionHandler exception_handler(this, false);
3587 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003588 if (exception_handler.GetClearException()) {
3589 // Exception was cleared as part of delivery.
3590 DCHECK(!IsExceptionPending());
3591 } else {
3592 // Exception was put back with a throw location.
3593 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003594 // Check the to-space invariant on the re-installed exception (if applicable).
3595 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003596 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003597 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003598}
3599
Ian Rogersbdb03912011-09-14 00:55:44 -07003600Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003601 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003602 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003603 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003604 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003605 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003606 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003607 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003608 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003609}
3610
Andreas Gampec7d878d2018-11-19 18:42:06 +00003611ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003612 bool check_suspended,
3613 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003614 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3615 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3616 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003617 ArtMethod* method = nullptr;
3618 uint32_t dex_pc = dex::kDexNoIndex;
3619 StackVisitor::WalkStack(
3620 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3621 ArtMethod* m = visitor->GetMethod();
3622 if (m->IsRuntimeMethod()) {
3623 // Continue if this is a runtime method.
3624 return true;
3625 }
3626 method = m;
3627 dex_pc = visitor->GetDexPc(abort_on_error);
3628 return false;
3629 },
3630 const_cast<Thread*>(this),
3631 /* context= */ nullptr,
3632 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3633 check_suspended);
3634
3635 if (dex_pc_out != nullptr) {
3636 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003637 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003638 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003639}
3640
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003641bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3642 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003643}
3644
Roland Levillainad0777d2018-02-12 20:00:18 +00003645extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003646 REQUIRES_SHARED(Locks::mutator_lock_);
3647
Ian Rogers40e3bac2012-11-20 00:09:14 -08003648// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003649template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003650class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003651 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003652 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003653 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003654 // We are visiting the references in compiled frames, so we do not need
3655 // to know the inlined frames.
3656 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3657 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003658
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003659 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003660 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003661 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003662 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003663 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003664 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003665 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003666 VisitShadowFrame(shadow_frame);
3667 } else {
3668 VisitQuickFrame();
3669 }
3670 return true;
3671 }
3672
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003673 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003674 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003675 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003676 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003677 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003678 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
3679 // handle scope for JNI or References for interpreter.
3680 for (size_t reg = 0; reg < num_regs; ++reg) {
3681 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3682 if (ref != nullptr) {
3683 mirror::Object* new_ref = ref;
3684 visitor_(&new_ref, reg, this);
3685 if (new_ref != ref) {
3686 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003687 }
3688 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003689 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003690 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003691 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003692 }
3693
3694 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003695 // 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 -07003696 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3697 // the threads do not all hold the heap bitmap lock for parallel GC.
3698 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003699 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003700 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003701 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003702 // klass can be null for runtime methods.
3703 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003704 if (kVerifyImageObjectsMarked) {
3705 gc::Heap* const heap = Runtime::Current()->GetHeap();
3706 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003707 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003708 if (space != nullptr && space->IsImageSpace()) {
3709 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003710 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003711 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003712 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003713 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003714 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003715 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003716 }
3717 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003718 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3719 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3720 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003721 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003722 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003723 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3724 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003725 }
3726 }
3727 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003728 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003729 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003730 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003731 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003732 }
3733 }
3734 }
3735
Andreas Gampe585da952016-12-02 14:52:29 -08003736 template <typename T>
3737 ALWAYS_INLINE
3738 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003739 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003740 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003741 ArtMethod* m = *cur_quick_frame;
3742 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003743
Sebastien Hertz714f1752014-04-28 15:03:08 +02003744 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003745 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003746 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003747 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003748 StackReference<mirror::Object>* vreg_base =
3749 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003750 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbeckya2d29a32018-08-03 11:06:38 +01003751 CodeInfo code_info(method_header, kPrecise
David Srbecky42deda82018-08-10 11:23:27 +01003752 ? CodeInfo::DecodeFlags::AllTables // We will need dex register maps.
David Srbeckya2d29a32018-08-03 11:06:38 +01003753 : CodeInfo::DecodeFlags::GcMasksOnly);
David Srbecky052f8ca2018-04-26 15:42:54 +01003754 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003755 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003756
David Srbecky052f8ca2018-04-26 15:42:54 +01003757 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003758
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003759 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003760 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003761 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003762 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003763 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003764 mirror::Object* ref = ref_addr->AsMirrorPtr();
3765 if (ref != nullptr) {
3766 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003767 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003768 if (ref != new_ref) {
3769 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003770 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003771 }
3772 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003773 }
3774 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003775 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003776 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3777 if (register_mask & (1 << i)) {
3778 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003779 if (kIsDebugBuild && ref_addr == nullptr) {
3780 std::string thread_name;
3781 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003782 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003783 DescribeStack(GetThread());
3784 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3785 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3786 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003787 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003788 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003789 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003790 }
3791 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003792 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3793 // If this is a proxy method, visit its reference arguments.
3794 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003795 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003796 std::vector<StackReference<mirror::Object>*> ref_addrs =
3797 GetProxyReferenceArguments(cur_quick_frame);
3798 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3799 mirror::Object* ref = ref_addr->AsMirrorPtr();
3800 if (ref != nullptr) {
3801 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003802 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003803 if (ref != new_ref) {
3804 ref_addr->Assign(new_ref);
3805 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003806 }
3807 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003808 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003809 }
3810
Andreas Gampe585da952016-12-02 14:52:29 -08003811 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3812 if (kPrecise) {
3813 VisitQuickFramePrecise();
3814 } else {
3815 VisitQuickFrameNonPrecise();
3816 }
3817 }
3818
3819 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3820 struct UndefinedVRegInfo {
3821 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3822 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003823 const StackMap& map ATTRIBUTE_UNUSED,
3824 RootVisitor& _visitor)
3825 : visitor(_visitor) {
3826 }
3827
3828 ALWAYS_INLINE
3829 void VisitStack(mirror::Object** ref,
3830 size_t stack_index ATTRIBUTE_UNUSED,
3831 const StackVisitor* stack_visitor)
3832 REQUIRES_SHARED(Locks::mutator_lock_) {
3833 visitor(ref, -1, stack_visitor);
3834 }
3835
3836 ALWAYS_INLINE
3837 void VisitRegister(mirror::Object** ref,
3838 size_t register_index ATTRIBUTE_UNUSED,
3839 const StackVisitor* stack_visitor)
3840 REQUIRES_SHARED(Locks::mutator_lock_) {
3841 visitor(ref, -1, stack_visitor);
3842 }
3843
3844 RootVisitor& visitor;
3845 };
3846 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3847 }
3848
3849 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3850 struct StackMapVRegInfo {
3851 StackMapVRegInfo(ArtMethod* method,
3852 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003853 const StackMap& map,
3854 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003855 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003856 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003857 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003858 visitor(_visitor) {
3859 }
3860
3861 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3862 // lookups for each location.
3863 void FindWithType(const size_t index,
3864 const DexRegisterLocation::Kind kind,
3865 mirror::Object** ref,
3866 const StackVisitor* stack_visitor)
3867 REQUIRES_SHARED(Locks::mutator_lock_) {
3868 bool found = false;
3869 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003870 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003871 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3872 visitor(ref, dex_reg, stack_visitor);
3873 found = true;
3874 }
3875 }
3876
3877 if (!found) {
3878 // If nothing found, report with -1.
3879 visitor(ref, -1, stack_visitor);
3880 }
3881 }
3882
3883 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3884 REQUIRES_SHARED(Locks::mutator_lock_) {
3885 const size_t stack_offset = stack_index * kFrameSlotSize;
3886 FindWithType(stack_offset,
3887 DexRegisterLocation::Kind::kInStack,
3888 ref,
3889 stack_visitor);
3890 }
3891
3892 void VisitRegister(mirror::Object** ref,
3893 size_t register_index,
3894 const StackVisitor* stack_visitor)
3895 REQUIRES_SHARED(Locks::mutator_lock_) {
3896 FindWithType(register_index,
3897 DexRegisterLocation::Kind::kInRegister,
3898 ref,
3899 stack_visitor);
3900 }
3901
3902 size_t number_of_dex_registers;
3903 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003904 DexRegisterMap dex_register_map;
3905 RootVisitor& visitor;
3906 };
3907 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3908 }
3909
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003910 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003911 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003912};
3913
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003914class RootCallbackVisitor {
3915 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003916 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003917
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003918 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003919 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003920 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003921 }
3922
3923 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003924 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003925 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003926};
3927
Andreas Gampe585da952016-12-02 14:52:29 -08003928template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003929void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003930 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003931 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003932 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003933 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003934 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003935 }
Alex Light848574c2017-09-25 16:59:39 -07003936 if (tlsPtr_.async_exception != nullptr) {
3937 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3938 RootInfo(kRootNativeStack, thread_id));
3939 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003940 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003941 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3942 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003943 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003944 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003945 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003946 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003947 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003948 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003949 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003950 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003951 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3952 record != nullptr;
3953 record = record->GetLink()) {
3954 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3955 shadow_frame != nullptr;
3956 shadow_frame = shadow_frame->GetLink()) {
3957 mapper.VisitShadowFrame(shadow_frame);
3958 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003959 }
3960 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003961 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3962 record != nullptr;
3963 record = record->GetLink()) {
3964 if (record->IsReference()) {
3965 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003966 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003967 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003968 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3969 RootInfo(kRootThreadObject, thread_id));
3970 }
3971 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3972 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003973 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003974 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3975 record != nullptr;
3976 record = record->GetNext()) {
3977 mapper.VisitShadowFrame(record->GetShadowFrame());
3978 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003979 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003980 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3981 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003982 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003983 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003984 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003985 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003986 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08003987 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07003988 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003989 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08003990 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07003991}
3992
Andreas Gampe585da952016-12-02 14:52:29 -08003993void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
3994 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003995 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003996 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003997 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003998 }
3999}
4000
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004001class VerifyRootVisitor : public SingleRootVisitor {
4002 public:
4003 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004004 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004005 VerifyObject(root);
4006 }
4007};
jeffhao25045522012-03-13 19:34:37 -07004008
Ian Rogers04d7aa92013-03-16 14:29:17 -07004009void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004010 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4011 VerifyRootVisitor visitor;
4012 std::unique_ptr<Context> context(Context::Create());
4013 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4014 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4015 mapper.WalkStack();
4016 }
jeffhao25045522012-03-13 19:34:37 -07004017}
jeffhao25045522012-03-13 19:34:37 -07004018
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004019// Set the stack end to that to be used during a stack overflow
4020void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004021 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004022 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004023 // However, we seem to have already extended to use the full stack.
4024 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004025 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004026 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004027 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004028 }
4029
Ian Rogersdd7624d2014-03-14 17:43:00 -07004030 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004031
4032 // Remove the stack overflow protection if is it set up.
4033 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4034 if (implicit_stack_check) {
4035 if (!UnprotectStack()) {
4036 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4037 }
4038 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004039}
4040
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004041void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004042 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004043 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004044 tlsPtr_.thread_local_start = start;
4045 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4046 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004047 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004048 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004049}
4050
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004051bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004052 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004053 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004054 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004055 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004056 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004057 }
4058 return has_tlab;
4059}
4060
Elliott Hughes330304d2011-08-12 14:28:05 -07004061std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004062 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004063 return os;
4064}
4065
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004066bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004067 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4068 VLOG(threads) << "Protecting stack at " << pregion;
4069 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004070 if (fatal_on_error) {
4071 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4072 "Reason: "
4073 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4074 }
4075 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004076 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004077 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004078}
4079
4080bool Thread::UnprotectStack() {
4081 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4082 VLOG(threads) << "Unprotecting stack at " << pregion;
4083 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4084}
4085
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004086void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4087 CHECK(Dbg::IsDebuggerActive());
4088 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4089 CHECK(ssc != nullptr);
4090 tlsPtr_.single_step_control = ssc;
4091}
4092
4093void Thread::DeactivateSingleStepControl() {
4094 CHECK(Dbg::IsDebuggerActive());
4095 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4096 SingleStepControl* ssc = GetSingleStepControl();
4097 tlsPtr_.single_step_control = nullptr;
4098 delete ssc;
4099}
Dave Allison648d7112014-07-25 16:15:27 -07004100
Sebastien Hertz1558b572015-02-25 15:05:59 +01004101void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4102 CHECK(Dbg::IsDebuggerActive());
4103 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4104 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4105 CHECK(req != nullptr);
4106 tlsPtr_.debug_invoke_req = req;
4107}
4108
4109void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004110 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4111 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004112 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004113 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004114 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004115}
4116
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004117void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4118 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004119 tlsPtr_.method_verifier = verifier;
4120}
4121
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004122void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004123 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004124 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004125}
4126
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004127size_t Thread::NumberOfHeldMutexes() const {
4128 size_t count = 0;
4129 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004130 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004131 }
4132 return count;
4133}
4134
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004135void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4136 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4137 ClearException();
4138 ShadowFrame* shadow_frame =
4139 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004140 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004141 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004142 DeoptimizationMethodType method_type;
4143 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004144 SetTopOfStack(nullptr);
4145 SetTopOfShadowStack(shadow_frame);
4146
4147 // Restore the exception that was pending before deoptimization then interpret the
4148 // deoptimized frames.
4149 if (pending_exception != nullptr) {
4150 SetException(pending_exception);
4151 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004152 interpreter::EnterInterpreterFromDeoptimize(this,
4153 shadow_frame,
4154 result,
4155 from_code,
4156 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004157}
4158
Alex Light848574c2017-09-25 16:59:39 -07004159void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4160 CHECK(new_exception != nullptr);
Alex Light7919db92017-11-29 09:00:55 -08004161 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004162 if (kIsDebugBuild) {
4163 // Make sure we are in a checkpoint.
4164 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4165 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4166 << "It doesn't look like this was called in a checkpoint! this: "
4167 << this << " count: " << GetSuspendCount();
4168 }
4169 tlsPtr_.async_exception = new_exception.Ptr();
4170}
4171
4172bool Thread::ObserveAsyncException() {
4173 DCHECK(this == Thread::Current());
4174 if (tlsPtr_.async_exception != nullptr) {
4175 if (tlsPtr_.exception != nullptr) {
4176 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4177 << tlsPtr_.exception->Dump();
4178 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4179 }
4180 tlsPtr_.exception = tlsPtr_.async_exception;
4181 tlsPtr_.async_exception = nullptr;
4182 return true;
4183 } else {
4184 return IsExceptionPending();
4185 }
4186}
4187
Mathieu Chartier0795f232016-09-27 18:43:30 -07004188void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004189 CHECK(new_exception != nullptr);
4190 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004191 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004192}
4193
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004194bool Thread::IsAotCompiler() {
4195 return Runtime::Current()->IsAotCompiler();
4196}
4197
Andreas Gampe202f85a2017-02-06 10:23:26 -08004198mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004199 DCHECK(tlsPtr_.jpeer == nullptr);
4200 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004201 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4202 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4203 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4204 // mark/forward it here.
4205 peer = art::ReadBarrier::Mark(peer);
4206 }
4207 return peer;
4208}
4209
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004210void Thread::SetReadBarrierEntrypoints() {
4211 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004212 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004213}
4214
David Srbecky912f36c2018-09-08 12:22:58 +01004215void Thread::ClearAllInterpreterCaches() {
4216 static struct ClearInterpreterCacheClosure : Closure {
4217 virtual void Run(Thread* thread) {
4218 thread->GetInterpreterCache()->Clear(thread);
4219 }
4220 } closure;
4221 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4222}
4223
Elliott Hughes8daa0922011-09-11 13:46:25 -07004224} // namespace art