blob: 6c41ae42b7c8015eabf5ec58db1323499da45da0 [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"
42
Mathieu Chartiera62b4532017-04-26 13:16:25 -070043#include "arch/context-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070044#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070045#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070046#include "art_method-inl.h"
Charles Mungeraa31f492018-11-01 18:57:38 +000047#include "base/atomic.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010048#include "base/bit_utils.h"
Vladimir Marko78baed52018-10-11 10:44:58 +010049#include "base/casts.h"
David Sehr891a50e2017-10-27 17:01:07 -070050#include "base/file_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070051#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080052#include "base/mutex.h"
Alex Light184f0752018-07-13 11:18:22 -070053#include "base/stl_util.h"
Steven Morelande431e272017-07-18 16:53:49 -070054#include "base/systrace.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080055#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070056#include "base/to_str.h"
David Sehrc431b9d2018-03-02 12:01:51 -080057#include "base/utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "class_linker-inl.h"
Vladimir Markob4eb1b12018-05-24 11:09:38 +010059#include "class_root.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070060#include "debugger.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080061#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080062#include "dex/dex_file-inl.h"
63#include "dex/dex_file_annotations.h"
64#include "dex/dex_file_types.h"
Ian Rogers7655f292013-07-29 11:07:13 -070065#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080066#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070067#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000068#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070069#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070070#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070071#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070072#include "gc_root.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070073#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070074#include "indirect_reference_table-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070075#include "interpreter/interpreter.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010076#include "interpreter/mterp/mterp.h"
Vladimir Marko6ec2a1b2018-05-22 15:33:48 +010077#include "interpreter/shadow_frame-inl.h"
Andreas Gampe36a296f2017-06-13 14:11:11 -070078#include "java_frame_root_info.h"
Vladimir Markoa3ad0cd2018-05-04 10:06:38 +010079#include "jni/java_vm_ext.h"
80#include "jni/jni_internal.h"
Andreas Gampe70f5fd02018-10-24 19:58:37 -070081#include "mirror/class-alloc-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070082#include "mirror/class_loader.h"
Andreas Gampe52ecb652018-10-24 15:18:21 -070083#include "mirror/object_array-alloc-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080084#include "mirror/object_array-inl.h"
85#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070086#include "monitor.h"
Andreas Gampe93104952017-12-13 17:13:15 -080087#include "monitor_objects_stack_visitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070088#include "native_stack_dump.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070089#include "nativehelper/scoped_local_ref.h"
90#include "nativehelper/scoped_utf_chars.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070091#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010092#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070093#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070094#include "object_lock.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010095#include "quick/quick_method_frame_info.h"
Steven Morelande431e272017-07-18 16:53:49 -070096#include "quick_exception_handler.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080097#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050098#include "reflection.h"
David Srbecky28f6cff2018-10-16 15:07:28 +010099#include "runtime-inl.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -0700100#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -0800101#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -0700102#include "scoped_thread_state_change-inl.h"
Elliott Hughes68e76522011-10-05 13:22:16 -0700103#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +0100104#include "stack_map.h"
Ian Rogers22d5e732014-07-15 22:23:51 -0700105#include "thread-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -0700106#include "thread_list.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -0700107#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -0800108#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -0700109#include "well_known_classes.h"
Carl Shapirob5573532011-07-12 18:22:59 -0700110
Yu Lieac44242015-06-29 10:50:03 +0800111#if ART_USE_FUTEXES
112#include "linux/futex.h"
113#include "sys/syscall.h"
114#ifndef SYS_futex
115#define SYS_futex __NR_futex
116#endif
117#endif // ART_USE_FUTEXES
118
Carl Shapirob5573532011-07-12 18:22:59 -0700119namespace art {
120
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800121using android::base::StringAppendV;
122using android::base::StringPrintf;
123
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700124extern "C" NO_RETURN void artDeoptimize(Thread* self);
125
Ian Rogers0878d652013-04-18 17:38:35 -0700126bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700127pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800128ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700129const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100130bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100131Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100132
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700133static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700134
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700135// For implicit overflow checks we reserve an extra piece of memory at the bottom
136// of the stack (lowest memory). The higher portion of the memory
137// is protected against reads and the lower is available for use while
138// throwing the StackOverflow exception.
139constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
140
Elliott Hughes7dc51662012-05-16 14:48:43 -0700141static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
142
Ian Rogers5d76c432011-10-31 21:42:49 -0700143void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700144 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700145}
146
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700147static void UnimplementedEntryPoint() {
148 UNIMPLEMENTED(FATAL);
149}
150
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700151void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartier3768ade2017-05-02 14:04:39 -0700152void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_active);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800153
154void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
155 CHECK(kUseReadBarrier);
156 tls32_.is_gc_marking = is_marking;
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700157 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active= */ is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800158 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800159}
Ian Rogers7655f292013-07-29 11:07:13 -0700160
Ian Rogers848871b2013-08-05 10:56:33 -0700161void Thread::InitTlsEntryPoints() {
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700162 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700163 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800164 uintptr_t* end = reinterpret_cast<uintptr_t*>(
165 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700166 for (uintptr_t* it = begin; it != end; ++it) {
167 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
168 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700169 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700170}
171
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800172void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
Vladimir Marko33bff252017-11-01 14:35:42 +0000173 if (kUseReadBarrier && kRuntimeISA != InstructionSet::kX86_64) {
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800174 // Allocation entrypoint switching is currently only implemented for X86_64.
175 is_marking = true;
176 }
177 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700178}
179
Sebastien Hertz07474662015-08-25 15:12:33 +0000180class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200181 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100182 DeoptimizationContextRecord(const JValue& ret_val,
183 bool is_reference,
184 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800185 ObjPtr<mirror::Throwable> pending_exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700186 DeoptimizationMethodType method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000187 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100188 : ret_val_(ret_val),
189 is_reference_(is_reference),
190 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800191 pending_exception_(pending_exception.Ptr()),
Mingyao Yang2ee17902017-08-30 11:37:08 -0700192 deopt_method_type_(method_type),
Sebastien Hertz07474662015-08-25 15:12:33 +0000193 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200194
195 JValue GetReturnValue() const { return ret_val_; }
196 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100197 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800198 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000199 DeoptimizationContextRecord* GetLink() const { return link_; }
200 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200201 DCHECK(is_reference_);
202 return ret_val_.GetGCRoot();
203 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000204 mirror::Object** GetPendingExceptionAsGCRoot() {
205 return reinterpret_cast<mirror::Object**>(&pending_exception_);
206 }
Mingyao Yang2ee17902017-08-30 11:37:08 -0700207 DeoptimizationMethodType GetDeoptimizationMethodType() const {
208 return deopt_method_type_;
209 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200210
211 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000212 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200213 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200214
Sebastien Hertz07474662015-08-25 15:12:33 +0000215 // Indicates whether the returned value is a reference. If so, the GC will visit it.
216 const bool is_reference_;
217
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100218 // Whether the context was created from an explicit deoptimization in the code.
219 const bool from_code_;
220
Sebastien Hertz07474662015-08-25 15:12:33 +0000221 // The exception that was pending before deoptimization (or null if there was no pending
222 // exception).
223 mirror::Throwable* pending_exception_;
224
Mingyao Yang2ee17902017-08-30 11:37:08 -0700225 // Whether the context was created for an (idempotent) runtime method.
226 const DeoptimizationMethodType deopt_method_type_;
227
Sebastien Hertz07474662015-08-25 15:12:33 +0000228 // A link to the previous DeoptimizationContextRecord.
229 DeoptimizationContextRecord* const link_;
230
231 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200232};
233
234class StackedShadowFrameRecord {
235 public:
236 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
237 StackedShadowFrameType type,
238 StackedShadowFrameRecord* link)
239 : shadow_frame_(shadow_frame),
240 type_(type),
241 link_(link) {}
242
243 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
244 StackedShadowFrameType GetType() const { return type_; }
245 StackedShadowFrameRecord* GetLink() const { return link_; }
246
247 private:
248 ShadowFrame* const shadow_frame_;
249 const StackedShadowFrameType type_;
250 StackedShadowFrameRecord* const link_;
251
252 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
253};
254
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100255void Thread::PushDeoptimizationContext(const JValue& return_value,
256 bool is_reference,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700257 ObjPtr<mirror::Throwable> exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100258 bool from_code,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700259 DeoptimizationMethodType method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000260 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
261 return_value,
262 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100263 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000264 exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700265 method_type,
Sebastien Hertz07474662015-08-25 15:12:33 +0000266 tlsPtr_.deoptimization_context_stack);
267 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700268}
269
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100270void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800271 ObjPtr<mirror::Throwable>* exception,
Mingyao Yang2ee17902017-08-30 11:37:08 -0700272 bool* from_code,
273 DeoptimizationMethodType* method_type) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000274 AssertHasDeoptimizationContext();
275 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
276 tlsPtr_.deoptimization_context_stack = record->GetLink();
277 result->SetJ(record->GetReturnValue().GetJ());
278 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100279 *from_code = record->GetFromCode();
Mingyao Yang2ee17902017-08-30 11:37:08 -0700280 *method_type = record->GetDeoptimizationMethodType();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700281 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000282}
283
284void Thread::AssertHasDeoptimizationContext() {
285 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
286 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800287}
288
Charles Mungeraa31f492018-11-01 18:57:38 +0000289enum {
290 kPermitAvailable = 0, // Incrementing consumes the permit
291 kNoPermit = 1, // Incrementing marks as waiter waiting
292 kNoPermitWaiterWaiting = 2
293};
294
295void Thread::Park(bool is_absolute, int64_t time) {
296 DCHECK(this == Thread::Current());
297#if ART_USE_FUTEXES
298 // Consume the permit, or mark as waiting. This cannot cause park_state to go
299 // outside of its valid range (0, 1, 2), because in all cases where 2 is
300 // assigned it is set back to 1 before returning, and this method cannot run
301 // concurrently with itself since it operates on the current thread.
302 int old_state = tls32_.park_state_.fetch_add(1, std::memory_order_relaxed);
303 if (old_state == kNoPermit) {
304 // no permit was available. block thread until later.
Charles Munger5cc0e752018-11-09 12:30:46 -0800305 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkStart(is_absolute, time);
Charles Mungeraa31f492018-11-01 18:57:38 +0000306 int result = 0;
Charles Munger5cc0e752018-11-09 12:30:46 -0800307 bool timed_out = false;
Charles Mungeraa31f492018-11-01 18:57:38 +0000308 if (!is_absolute && time == 0) {
309 // Thread.getState() is documented to return waiting for untimed parks.
310 ScopedThreadSuspension sts(this, ThreadState::kWaiting);
311 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
312 result = futex(tls32_.park_state_.Address(),
313 FUTEX_WAIT_PRIVATE,
314 /* sleep if val = */ kNoPermitWaiterWaiting,
315 /* timeout */ nullptr,
316 nullptr,
317 0);
318 } else if (time > 0) {
319 // Only actually suspend and futex_wait if we're going to wait for some
320 // positive amount of time - the kernel will reject negative times with
321 // EINVAL, and a zero time will just noop.
322
323 // Thread.getState() is documented to return timed wait for timed parks.
324 ScopedThreadSuspension sts(this, ThreadState::kTimedWaiting);
325 DCHECK_EQ(NumberOfHeldMutexes(), 0u);
326 timespec timespec;
327 if (is_absolute) {
328 // Time is millis when scheduled for an absolute time
329 timespec.tv_nsec = (time % 1000) * 1000000;
330 timespec.tv_sec = time / 1000;
331 // This odd looking pattern is recommended by futex documentation to
332 // wait until an absolute deadline, with otherwise identical behavior to
333 // FUTEX_WAIT_PRIVATE. This also allows parkUntil() to return at the
334 // correct time when the system clock changes.
335 result = futex(tls32_.park_state_.Address(),
336 FUTEX_WAIT_BITSET_PRIVATE | FUTEX_CLOCK_REALTIME,
337 /* sleep if val = */ kNoPermitWaiterWaiting,
338 &timespec,
339 nullptr,
340 FUTEX_BITSET_MATCH_ANY);
341 } else {
342 // Time is nanos when scheduled for a relative time
343 timespec.tv_sec = time / 1000000000;
344 timespec.tv_nsec = time % 1000000000;
345 result = futex(tls32_.park_state_.Address(),
346 FUTEX_WAIT_PRIVATE,
347 /* sleep if val = */ kNoPermitWaiterWaiting,
348 &timespec,
349 nullptr,
350 0);
351 }
352 }
353 if (result == -1) {
354 switch (errno) {
Charles Mungeraa31f492018-11-01 18:57:38 +0000355 case ETIMEDOUT:
Charles Munger5cc0e752018-11-09 12:30:46 -0800356 timed_out = true;
357 FALLTHROUGH_INTENDED;
358 case EAGAIN:
Charles Mungeraa31f492018-11-01 18:57:38 +0000359 case EINTR: break; // park() is allowed to spuriously return
360 default: PLOG(FATAL) << "Failed to park";
361 }
362 }
363 // Mark as no longer waiting, and consume permit if there is one.
364 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
365 // TODO: Call to signal jvmti here
Charles Munger5cc0e752018-11-09 12:30:46 -0800366 Runtime::Current()->GetRuntimeCallbacks()->ThreadParkFinished(timed_out);
Charles Mungeraa31f492018-11-01 18:57:38 +0000367 } else {
368 // the fetch_add has consumed the permit. immediately return.
369 DCHECK_EQ(old_state, kPermitAvailable);
370 }
371#else
372 #pragma clang diagnostic push
373 #pragma clang diagnostic warning "-W#warnings"
374 #warning "LockSupport.park/unpark implemented as noops without FUTEX support."
375 #pragma clang diagnostic pop
376 UNUSED(is_absolute, time);
377 UNIMPLEMENTED(WARNING);
378 sched_yield();
379#endif
380}
381
382void Thread::Unpark() {
383#if ART_USE_FUTEXES
384 // Set permit available; will be consumed either by fetch_add (when the thread
385 // tries to park) or store (when the parked thread is woken up)
386 if (tls32_.park_state_.exchange(kPermitAvailable, std::memory_order_relaxed)
387 == kNoPermitWaiterWaiting) {
388 int result = futex(tls32_.park_state_.Address(),
389 FUTEX_WAKE_PRIVATE,
390 /* number of waiters = */ 1,
391 nullptr,
392 nullptr,
393 0);
394 if (result == -1) {
395 PLOG(FATAL) << "Failed to unpark";
396 }
397 }
398#else
399 UNIMPLEMENTED(WARNING);
400#endif
401}
402
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700403void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
404 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
405 sf, type, tlsPtr_.stacked_shadow_frame_record);
406 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800407}
408
Andreas Gampe639bdd12015-06-03 11:22:45 -0700409ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700410 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700411 if (must_be_present) {
412 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700413 } else {
414 if (record == nullptr || record->GetType() != type) {
415 return nullptr;
416 }
417 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700418 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
419 ShadowFrame* shadow_frame = record->GetShadowFrame();
420 delete record;
421 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700422}
423
Mingyao Yang99170c62015-07-06 11:10:37 -0700424class FrameIdToShadowFrame {
425 public:
426 static FrameIdToShadowFrame* Create(size_t frame_id,
427 ShadowFrame* shadow_frame,
428 FrameIdToShadowFrame* next,
429 size_t num_vregs) {
430 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
431 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
432 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
433 }
434
435 static void Delete(FrameIdToShadowFrame* f) {
436 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
437 delete[] memory;
438 }
439
440 size_t GetFrameId() const { return frame_id_; }
441 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
442 FrameIdToShadowFrame* GetNext() const { return next_; }
443 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
444 bool* GetUpdatedVRegFlags() {
445 return updated_vreg_flags_;
446 }
447
448 private:
449 FrameIdToShadowFrame(size_t frame_id,
450 ShadowFrame* shadow_frame,
451 FrameIdToShadowFrame* next)
452 : frame_id_(frame_id),
453 shadow_frame_(shadow_frame),
454 next_(next) {}
455
456 const size_t frame_id_;
457 ShadowFrame* const shadow_frame_;
458 FrameIdToShadowFrame* next_;
459 bool updated_vreg_flags_[0];
460
461 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
462};
463
464static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
465 size_t frame_id) {
466 FrameIdToShadowFrame* found = nullptr;
467 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
468 if (record->GetFrameId() == frame_id) {
469 if (kIsDebugBuild) {
470 // Sanity check we have at most one record for this frame.
471 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
472 found = record;
473 } else {
474 return record;
475 }
476 }
477 }
478 return found;
479}
480
481ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
482 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
483 tlsPtr_.frame_id_to_shadow_frame, frame_id);
484 if (record != nullptr) {
485 return record->GetShadowFrame();
486 }
487 return nullptr;
488}
489
490// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
491bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
492 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
493 tlsPtr_.frame_id_to_shadow_frame, frame_id);
494 CHECK(record != nullptr);
495 return record->GetUpdatedVRegFlags();
496}
497
498ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
499 uint32_t num_vregs,
500 ArtMethod* method,
501 uint32_t dex_pc) {
502 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
503 if (shadow_frame != nullptr) {
504 return shadow_frame;
505 }
David Sehr709b0702016-10-13 09:12:37 -0700506 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700507 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
508 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
509 shadow_frame,
510 tlsPtr_.frame_id_to_shadow_frame,
511 num_vregs);
512 for (uint32_t i = 0; i < num_vregs; i++) {
513 // Do this to clear all references for root visitors.
514 shadow_frame->SetVRegReference(i, nullptr);
515 // This flag will be changed to true if the debugger modifies the value.
516 record->GetUpdatedVRegFlags()[i] = false;
517 }
518 tlsPtr_.frame_id_to_shadow_frame = record;
519 return shadow_frame;
520}
521
Alex Light184f0752018-07-13 11:18:22 -0700522TLSData* Thread::GetCustomTLS(const char* key) {
523 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
524 auto it = custom_tls_.find(key);
525 return (it != custom_tls_.end()) ? it->second.get() : nullptr;
526}
527
528void Thread::SetCustomTLS(const char* key, TLSData* data) {
529 // We will swap the old data (which might be nullptr) with this and then delete it outside of the
530 // custom_tls_lock_.
531 std::unique_ptr<TLSData> old_data(data);
532 {
533 MutexLock mu(Thread::Current(), *Locks::custom_tls_lock_);
534 custom_tls_.GetOrCreate(key, []() { return std::unique_ptr<TLSData>(); }).swap(old_data);
535 }
536}
537
Mingyao Yang99170c62015-07-06 11:10:37 -0700538void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
539 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
540 if (head->GetFrameId() == frame_id) {
541 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
542 FrameIdToShadowFrame::Delete(head);
543 return;
544 }
545 FrameIdToShadowFrame* prev = head;
546 for (FrameIdToShadowFrame* record = head->GetNext();
547 record != nullptr;
548 prev = record, record = record->GetNext()) {
549 if (record->GetFrameId() == frame_id) {
550 prev->SetNext(record->GetNext());
551 FrameIdToShadowFrame::Delete(record);
552 return;
553 }
554 }
555 LOG(FATAL) << "No shadow frame for frame " << frame_id;
556 UNREACHABLE();
557}
558
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700559void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700560 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700561}
562
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700563void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700564 // One thread (us) survived the fork, but we have a new tid so we need to
565 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700566 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700567}
568
Brian Carlstrom78128a62011-09-15 17:21:19 -0700569void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700570 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700571 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800572 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700573 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800574 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700575 }
576 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700577 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
578 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800579 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700580 // Check that if we got here we cannot be shutting down (as shutdown should never have started
581 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700582 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700583 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
584 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
585 // the runtime in such a case. In case this ever changes, we need to make sure here to
586 // delete the tmp_jni_env, as we own it at this point.
587 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
588 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700589 Runtime::Current()->EndThreadBirth();
590 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700591 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700592 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800593 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800594
595 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700596 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700597 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700598 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
599 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800600 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100601
Andreas Gampe08883de2016-11-08 13:20:52 -0800602 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100603 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000604
Andreas Gampeac30fa22017-01-18 21:02:36 -0800605 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700606
Charles Mungeraa31f492018-11-01 18:57:38 +0000607 // Unpark ourselves if the java peer was unparked before it started (see
608 // b/28845097#comment49 for more information)
609
610 ArtField* unparkedField = jni::DecodeArtField(
611 WellKnownClasses::java_lang_Thread_unparkedBeforeStart);
612 bool should_unpark = false;
613 {
614 // Hold the lock here, so that if another thread calls unpark before the thread starts
615 // we don't observe the unparkedBeforeStart field before the unparker writes to it,
616 // which could cause a lost unpark.
617 art::MutexLock mu(soa.Self(), *art::Locks::thread_list_lock_);
618 should_unpark = unparkedField->GetBoolean(self->tlsPtr_.opeer) == JNI_TRUE;
619 }
620 if (should_unpark) {
621 self->Unpark();
622 }
Ian Rogers365c1022012-06-22 15:05:28 -0700623 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800624 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700625 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700626 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
627 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700628 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700629 // Detach and delete self.
630 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700631
Dave Allison0aded082013-11-07 13:15:11 -0800632 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700633}
634
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700635Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800636 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800637 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Vladimir Marko78baed52018-10-11 10:44:58 +0100638 Thread* result = reinterpret_cast64<Thread*>(f->GetLong(thread_peer));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700639 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
640 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700641 if (kIsDebugBuild) {
642 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800643 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700644 Locks::thread_list_lock_->AssertHeld(soa.Self());
645 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700646 }
647 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800648}
649
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700650Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
651 jobject java_thread) {
Vladimir Markobcf17522018-06-01 13:14:32 +0100652 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread));
Elliott Hughes01158d72011-09-19 19:47:10 -0700653}
654
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700655static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700656 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700657 if (stack_size == 0) {
658 stack_size = Runtime::Current()->GetDefaultStackSize();
659 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700660
Brian Carlstrom6414a972012-04-14 14:20:04 -0700661 // Dalvik used the bionic pthread default stack size for native threads,
662 // so include that here to support apps that expect large native stacks.
663 stack_size += 1 * MB;
664
Andreas Gampe7a55ce02018-06-19 10:07:18 -0700665 // Under sanitization, frames of the interpreter may become bigger, both for C code as
666 // well as the ShadowFrame. Ensure a larger minimum size. Otherwise initialization
667 // of all core classes cannot be done in all test circumstances.
668 if (kMemoryToolIsAvailable) {
669 stack_size = std::max(2 * MB, stack_size);
670 }
671
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700672 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
673 if (stack_size < PTHREAD_STACK_MIN) {
674 stack_size = PTHREAD_STACK_MIN;
675 }
676
Dave Allisonf9439142014-03-27 15:10:22 -0700677 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
678 // It's likely that callers are trying to ensure they have at least a certain amount of
679 // stack space, so we should add our reserved space on top of what they requested, rather
680 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700681 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700682 } else {
683 // If we are going to use implicit stack checks, allocate space for the protected
684 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000685 stack_size += Thread::kStackOverflowImplicitCheckSize +
686 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700687 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700688
689 // Some systems require the stack size to be a multiple of the system page size, so round up.
690 stack_size = RoundUp(stack_size, kPageSize);
691
692 return stack_size;
693}
694
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700695// Return the nearest page-aligned address below the current stack top.
696NO_INLINE
697static uint8_t* FindStackTop() {
698 return reinterpret_cast<uint8_t*>(
699 AlignDown(__builtin_frame_address(0), kPageSize));
700}
701
Dave Allisonf9439142014-03-27 15:10:22 -0700702// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700703// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700704ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700705void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700706 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700707 // Page containing current top of stack.
708 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700709
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700710 // Try to directly protect the stack.
711 VLOG(threads) << "installing stack protected region at " << std::hex <<
712 static_cast<void*>(pregion) << " to " <<
713 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700714 if (ProtectStack(/* fatal_on_error= */ false)) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700715 // Tell the kernel that we won't be needing these pages any more.
716 // NB. madvise will probably write zeroes into the memory (on linux it does).
717 uint32_t unwanted_size = stack_top - pregion - kPageSize;
718 madvise(pregion, unwanted_size, MADV_DONTNEED);
719 return;
720 }
721
722 // There is a little complexity here that deserves a special mention. On some
723 // architectures, the stack is created using a VM_GROWSDOWN flag
724 // to prevent memory being allocated when it's not needed. This flag makes the
725 // kernel only allocate memory for the stack by growing down in memory. Because we
726 // want to put an mprotected region far away from that at the stack top, we need
727 // to make sure the pages for the stack are mapped in before we call mprotect.
728 //
729 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
730 // with a non-mapped stack (usually only the main thread).
731 //
732 // We map in the stack by reading every page from the stack bottom (highest address)
733 // to the stack top. (We then madvise this away.) This must be done by reading from the
Andreas Gampe6c63f862017-06-28 17:20:15 -0700734 // current stack pointer downwards.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700735 //
Andreas Gampe6c63f862017-06-28 17:20:15 -0700736 // Accesses too far below the current machine register corresponding to the stack pointer (e.g.,
737 // ESP on x86[-32], SP on ARM) might cause a SIGSEGV (at least on x86 with newer kernels). We
738 // thus have to move the stack pointer. We do this portably by using a recursive function with a
739 // large stack frame size.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700740
Andreas Gampe6c63f862017-06-28 17:20:15 -0700741 // (Defensively) first remove the protection on the protected region as we'll want to read
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700742 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700743 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000744
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700745 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
746 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000747
Andreas Gampe6c63f862017-06-28 17:20:15 -0700748 struct RecurseDownStack {
749 // This function has an intentionally large stack size.
750#pragma GCC diagnostic push
751#pragma GCC diagnostic ignored "-Wframe-larger-than="
752 NO_INLINE
753 static void Touch(uintptr_t target) {
754 volatile size_t zero = 0;
755 // Use a large local volatile array to ensure a large frame size. Do not use anything close
756 // to a full page for ASAN. It would be nice to ensure the frame size is at most a page, but
757 // there is no pragma support for this.
Andreas Gampe6f1c7512017-07-05 19:18:31 -0700758 // Note: for ASAN we need to shrink the array a bit, as there's other overhead.
759 constexpr size_t kAsanMultiplier =
760#ifdef ADDRESS_SANITIZER
761 2u;
762#else
763 1u;
764#endif
765 volatile char space[kPageSize - (kAsanMultiplier * 256)];
Andreas Gampee383d232018-06-19 12:29:51 -0700766 char sink ATTRIBUTE_UNUSED = space[zero]; // NOLINT
Evgenii Stepanov9b7656d2018-08-21 15:18:49 -0700767 // Remove tag from the pointer. Nop in non-hwasan builds.
768 uintptr_t addr = reinterpret_cast<uintptr_t>(__hwasan_tag_pointer(space, 0));
769 if (addr >= target + kPageSize) {
Andreas Gampe6c63f862017-06-28 17:20:15 -0700770 Touch(target);
771 }
772 zero *= 2; // Try to avoid tail recursion.
773 }
774#pragma GCC diagnostic pop
775 };
776 RecurseDownStack::Touch(reinterpret_cast<uintptr_t>(pregion));
Dave Allison69dfe512014-07-11 17:11:58 +0000777
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700778 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700779 static_cast<void*>(pregion) << " to " <<
780 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
781
Dave Allison648d7112014-07-25 16:15:27 -0700782 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe98ea9d92018-10-19 14:06:15 -0700783 ProtectStack(/* fatal_on_error= */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700784
785 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000786 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700787 uint32_t unwanted_size = stack_top - pregion - kPageSize;
788 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700789}
790
Ian Rogers120f1c72012-09-28 17:17:10 -0700791void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800792 CHECK(java_peer != nullptr);
Ian Rogers55256cb2017-12-21 17:07:11 -0800793 Thread* self = static_cast<JNIEnvExt*>(env)->GetSelf();
Andreas Gampe56623832015-07-09 21:53:15 -0700794
795 if (VLOG_IS_ON(threads)) {
796 ScopedObjectAccess soa(env);
797
Andreas Gampe08883de2016-11-08 13:20:52 -0800798 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700799 ObjPtr<mirror::String> java_name =
800 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700801 std::string thread_name;
802 if (java_name != nullptr) {
803 thread_name = java_name->ToModifiedUtf8();
804 } else {
805 thread_name = "(Unnamed)";
806 }
807
808 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700809 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700810 }
811
Ian Rogers120f1c72012-09-28 17:17:10 -0700812 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700813
Ian Rogers120f1c72012-09-28 17:17:10 -0700814 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
815 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700816 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700817 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700818 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700819 thread_start_during_shutdown = true;
820 } else {
821 runtime->StartThreadBirth();
822 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700823 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700824 if (thread_start_during_shutdown) {
825 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
826 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
827 return;
828 }
829
830 Thread* child_thread = new Thread(is_daemon);
831 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700832 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700833 stack_size = FixStackSize(stack_size);
834
Roland Levillain2ae376f2018-01-30 11:35:11 +0000835 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing
836 // to assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800837 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
838 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700839
Andreas Gampe449357d2015-06-01 22:29:51 -0700840 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
841 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100842 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700843 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100844 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700845
Andreas Gampe449357d2015-06-01 22:29:51 -0700846 int pthread_create_result = 0;
847 if (child_jni_env_ext.get() != nullptr) {
848 pthread_t new_pthread;
849 pthread_attr_t attr;
850 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
851 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
852 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
853 "PTHREAD_CREATE_DETACHED");
854 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
855 pthread_create_result = pthread_create(&new_pthread,
856 &attr,
857 Thread::CreateCallback,
858 child_thread);
859 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
860
861 if (pthread_create_result == 0) {
862 // pthread_create started the new thread. The child is now responsible for managing the
863 // JNIEnvExt we created.
864 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
865 // between the threads.
Andreas Gampeafaf7f82018-10-16 11:32:38 -0700866 child_jni_env_ext.release(); // NOLINT pthreads API.
Andreas Gampe449357d2015-06-01 22:29:51 -0700867 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700868 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700869 }
870
871 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
872 {
873 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
874 runtime->EndThreadBirth();
875 }
876 // Manually delete the global reference since Thread::Init will not have been run.
877 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
878 child_thread->tlsPtr_.jpeer = nullptr;
879 delete child_thread;
880 child_thread = nullptr;
881 // TODO: remove from thread group?
882 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
883 {
884 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100885 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700886 StringPrintf("pthread_create (%s stack) failed: %s",
887 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
888 ScopedObjectAccess soa(env);
889 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700890 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700891}
892
Andreas Gampe449357d2015-06-01 22:29:51 -0700893bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700894 // This function does all the initialization that must be run by the native thread it applies to.
895 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
896 // we can handshake with the corresponding native thread when it's ready.) Check this native
897 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800898 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800899
900 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
901 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
902 tlsPtr_.pthread_self = pthread_self();
903 CHECK(is_started_);
904
Elliott Hughesd8af1592012-04-16 20:40:15 -0700905 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800906 if (!InitStackHwm()) {
907 return false;
908 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700909 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700910 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800911 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700912 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700913 InitTid();
buzbee1452bee2015-03-06 14:43:04 -0800914 interpreter::InitInterpreterTls(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800915
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100916#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000917 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
918#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700919 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000920#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700921 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700922
Ian Rogersdd7624d2014-03-14 17:43:00 -0700923 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700924
Andreas Gampe449357d2015-06-01 22:29:51 -0700925 if (jni_env_ext != nullptr) {
Ian Rogers55256cb2017-12-21 17:07:11 -0800926 DCHECK_EQ(jni_env_ext->GetVm(), java_vm);
927 DCHECK_EQ(jni_env_ext->GetSelf(), this);
Andreas Gampe449357d2015-06-01 22:29:51 -0700928 tlsPtr_.jni_env = jni_env_ext;
929 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100930 std::string error_msg;
931 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700932 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100933 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700934 return false;
935 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700936 }
937
Ian Rogers120f1c72012-09-28 17:17:10 -0700938 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800939 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700940}
941
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800942template <typename PeerAction>
943Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700944 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800945 if (runtime == nullptr) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900946 LOG(ERROR) << "Thread attaching to non-existent runtime: " <<
947 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800948 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700949 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800950 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700951 {
Dave Allison0aded082013-11-07 13:15:11 -0800952 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700953 if (runtime->IsShuttingDownLocked()) {
Kazuhiro Inaba9ff12512017-12-04 16:26:38 +0900954 LOG(WARNING) << "Thread attaching while runtime is shutting down: " <<
955 ((thread_name != nullptr) ? thread_name : "(Unnamed)");
Dave Allison0aded082013-11-07 13:15:11 -0800956 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700957 } else {
958 Runtime::Current()->StartThreadBirth();
959 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800960 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700961 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800962 if (!init_success) {
963 delete self;
964 return nullptr;
965 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700966 }
967 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700968
Jeff Hao848f70a2014-01-15 13:49:50 -0800969 self->InitStringEntryPoints();
970
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700971 CHECK_NE(self->GetState(), kRunnable);
972 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700973
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800974 // Run the action that is acting on the peer.
975 if (!peer_action(self)) {
976 runtime->GetThreadList()->Unregister(self);
977 // Unregister deletes self, no need to do this here.
978 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700979 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700980
Andreas Gampe56623832015-07-09 21:53:15 -0700981 if (VLOG_IS_ON(threads)) {
982 if (thread_name != nullptr) {
983 VLOG(threads) << "Attaching thread " << thread_name;
984 } else {
985 VLOG(threads) << "Attaching unnamed thread.";
986 }
987 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700988 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700989 }
990
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200991 {
992 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -0800993 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200994 }
995
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700996 return self;
997}
998
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800999Thread* Thread::Attach(const char* thread_name,
1000 bool as_daemon,
1001 jobject thread_group,
1002 bool create_peer) {
1003 auto create_peer_action = [&](Thread* self) {
1004 // If we're the main thread, ClassLinker won't be created until after we're attached,
1005 // so that thread needs a two-stage attach. Regular threads don't need this hack.
1006 // In the compiler, all threads need this hack, because no-one's going to be getting
1007 // a native peer!
1008 if (create_peer) {
1009 self->CreatePeer(thread_name, as_daemon, thread_group);
1010 if (self->IsExceptionPending()) {
Roland Levillain2ae376f2018-01-30 11:35:11 +00001011 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log
1012 // it.
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001013 {
1014 ScopedObjectAccess soa(self);
1015 LOG(ERROR) << "Exception creating thread peer:";
1016 LOG(ERROR) << self->GetException()->Dump();
1017 self->ClearException();
1018 }
1019 return false;
1020 }
1021 } else {
1022 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
1023 if (thread_name != nullptr) {
1024 self->tlsPtr_.name->assign(thread_name);
1025 ::art::SetThreadName(thread_name);
Ian Rogers55256cb2017-12-21 17:07:11 -08001026 } else if (self->GetJniEnv()->IsCheckJniEnabled()) {
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001027 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
1028 }
1029 }
1030 return true;
1031 };
1032 return Attach(thread_name, as_daemon, create_peer_action);
1033}
1034
1035Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
1036 auto set_peer_action = [&](Thread* self) {
1037 // Install the given peer.
1038 {
1039 DCHECK(self == Thread::Current());
1040 ScopedObjectAccess soa(self);
1041 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
1042 }
1043 self->GetJniEnv()->SetLongField(thread_peer,
1044 WellKnownClasses::java_lang_Thread_nativePeer,
Vladimir Marko78baed52018-10-11 10:44:58 +01001045 reinterpret_cast64<jlong>(self));
Andreas Gampe732b0ac2017-01-18 15:23:39 -08001046 return true;
1047 };
1048 return Attach(thread_name, as_daemon, set_peer_action);
1049}
1050
Ian Rogers365c1022012-06-22 15:05:28 -07001051void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
1052 Runtime* runtime = Runtime::Current();
1053 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -07001054 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001055
Dave Allison0aded082013-11-07 13:15:11 -08001056 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -07001057 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -07001058 }
Elliott Hughes726079d2011-10-07 18:43:44 -07001059 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001060 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +00001061 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -08001062 CHECK(IsExceptionPending());
1063 return;
1064 }
Elliott Hughes8daa0922011-09-11 13:46:25 -07001065 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -07001066 jboolean thread_is_daemon = as_daemon;
1067
Elliott Hugheseac76672012-05-24 21:56:51 -07001068 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -08001069 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001070 CHECK(IsExceptionPending());
1071 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -07001072 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001073 {
1074 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001075 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -08001076 }
Elliott Hugheseac76672012-05-24 21:56:51 -07001077 env->CallNonvirtualVoidMethod(peer.get(),
1078 WellKnownClasses::java_lang_Thread,
1079 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -07001080 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001081 if (IsExceptionPending()) {
1082 return;
1083 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001084
Ian Rogers120f1c72012-09-28 17:17:10 -07001085 Thread* self = this;
1086 DCHECK_EQ(self, Thread::Current());
Vladimir Marko78baed52018-10-11 10:44:58 +01001087 env->SetLongField(peer.get(),
1088 WellKnownClasses::java_lang_Thread_nativePeer,
1089 reinterpret_cast64<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -07001090
1091 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001092 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001093 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001094 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -07001095 // The Thread constructor should have set the Thread.name to a
1096 // non-null value. However, because we can run without code
1097 // available (in the compiler, in tests), we manually assign the
1098 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001099 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -08001100 InitPeer<true>(soa,
1101 tlsPtr_.opeer,
1102 thread_is_daemon,
1103 thread_group,
1104 thread_name.get(),
1105 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001106 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -08001107 InitPeer<false>(soa,
1108 tlsPtr_.opeer,
1109 thread_is_daemon,
1110 thread_group,
1111 thread_name.get(),
1112 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001113 }
Andreas Gampe08883de2016-11-08 13:20:52 -08001114 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001115 }
Elliott Hughes225f5a12012-06-11 11:23:48 -07001116 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -08001117 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -08001118 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -07001119 }
Carl Shapiro61e019d2011-07-14 16:53:09 -07001120}
1121
Andreas Gampebad529d2017-02-13 18:52:10 -08001122jobject Thread::CreateCompileTimePeer(JNIEnv* env,
1123 const char* name,
1124 bool as_daemon,
1125 jobject thread_group) {
1126 Runtime* runtime = Runtime::Current();
1127 CHECK(!runtime->IsStarted());
1128
1129 if (thread_group == nullptr) {
1130 thread_group = runtime->GetMainThreadGroup();
1131 }
1132 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
1133 // Add missing null check in case of OOM b/18297817
1134 if (name != nullptr && thread_name.get() == nullptr) {
1135 CHECK(Thread::Current()->IsExceptionPending());
1136 return nullptr;
1137 }
1138 jint thread_priority = GetNativePriority();
1139 jboolean thread_is_daemon = as_daemon;
1140
1141 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
1142 if (peer.get() == nullptr) {
1143 CHECK(Thread::Current()->IsExceptionPending());
1144 return nullptr;
1145 }
1146
1147 // We cannot call Thread.init, as it will recursively ask for currentThread.
1148
1149 // The Thread constructor should have set the Thread.name to a
1150 // non-null value. However, because we can run without code
1151 // available (in the compiler, in tests), we manually assign the
1152 // fields the constructor should have set.
1153 ScopedObjectAccessUnchecked soa(Thread::Current());
1154 if (runtime->IsActiveTransaction()) {
1155 InitPeer<true>(soa,
1156 soa.Decode<mirror::Object>(peer.get()),
1157 thread_is_daemon,
1158 thread_group,
1159 thread_name.get(),
1160 thread_priority);
1161 } else {
1162 InitPeer<false>(soa,
1163 soa.Decode<mirror::Object>(peer.get()),
1164 thread_is_daemon,
1165 thread_group,
1166 thread_name.get(),
1167 thread_priority);
1168 }
1169
1170 return peer.release();
1171}
1172
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001173template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -08001174void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
1175 ObjPtr<mirror::Object> peer,
1176 jboolean thread_is_daemon,
1177 jobject thread_group,
1178 jobject thread_name,
1179 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001180 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001181 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -08001182 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001183 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -08001184 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001185 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -08001186 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -08001187 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001188}
1189
Elliott Hughes899e7892012-01-24 14:57:32 -08001190void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001191 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -08001192 ::art::SetThreadName(name);
1193 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
1194}
1195
Andreas Gampe9186ced2016-12-12 14:28:21 -08001196static void GetThreadStack(pthread_t thread,
1197 void** stack_base,
1198 size_t* stack_size,
1199 size_t* guard_size) {
1200#if defined(__APPLE__)
1201 *stack_size = pthread_get_stacksize_np(thread);
1202 void* stack_addr = pthread_get_stackaddr_np(thread);
1203
1204 // Check whether stack_addr is the base or end of the stack.
1205 // (On Mac OS 10.7, it's the end.)
1206 int stack_variable;
1207 if (stack_addr > &stack_variable) {
1208 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
1209 } else {
1210 *stack_base = stack_addr;
1211 }
1212
1213 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1214 pthread_attr_t attributes;
1215 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1216 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1217 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1218#else
1219 pthread_attr_t attributes;
1220 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1221 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1222 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1223 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1224
1225#if defined(__GLIBC__)
1226 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1227 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1228 // will be broken because we'll die long before we get close to 2GB.
1229 bool is_main_thread = (::art::GetTid() == getpid());
1230 if (is_main_thread) {
1231 rlimit stack_limit;
1232 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1233 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1234 }
1235 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1236 size_t old_stack_size = *stack_size;
1237
1238 // Use the kernel default limit as our size, and adjust the base to match.
1239 *stack_size = 8 * MB;
1240 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1241
1242 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1243 << " to " << PrettySize(*stack_size)
1244 << " with base " << *stack_base;
1245 }
1246 }
1247#endif
1248
1249#endif
1250}
1251
Ian Rogersf4d4da12014-11-11 16:10:33 -08001252bool Thread::InitStackHwm() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001253 void* read_stack_base;
1254 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001255 size_t read_guard_size;
1256 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001257
Ian Rogers13735952014-10-08 12:43:28 -07001258 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001259 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001260
Dave Allison648d7112014-07-25 16:15:27 -07001261 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1262 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1263 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1264 // between 8K and 12K.
1265 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1266 + 4 * KB;
1267 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001268 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001269 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1270 __LINE__,
1271 ::android::base::ERROR,
1272 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001273 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001274 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001275
Vladimir Markob8f2f632015-01-02 14:23:26 +00001276 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1277 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1278 read_stack_base,
1279 PrettySize(read_stack_size).c_str(),
1280 PrettySize(read_guard_size).c_str());
1281
Ian Rogers932746a2011-09-22 18:57:50 -07001282 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001283
1284 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001285 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001286
Dave Allisonb090a182014-08-14 17:02:48 +00001287 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001288
1289 // Install the protected region if we are doing implicit overflow checks.
Roland Levillain05e34f42018-05-24 13:19:05 +00001290 if (implicit_stack_check) {
Dave Allison648d7112014-07-25 16:15:27 -07001291 // The thread might have protected region at the bottom. We need
1292 // to install our own region so we need to move the limits
1293 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001294
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001295 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1296 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1297 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001298
1299 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001300 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001301
1302 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001303 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001304
1305 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001306}
1307
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001308void Thread::ShortDump(std::ostream& os) const {
1309 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001310 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001311 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001312 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001313 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001314 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001315 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001316 << ",Thread*=" << this
1317 << ",peer=" << tlsPtr_.opeer
1318 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1319 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001320}
1321
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001322void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1323 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001324 DumpState(os);
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00001325 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001326}
1327
Andreas Gampe08883de2016-11-08 13:20:52 -08001328mirror::String* Thread::GetThreadName() const {
1329 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001330 if (tlsPtr_.opeer == nullptr) {
1331 return nullptr;
1332 }
1333 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1334 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001335}
1336
Elliott Hughesffb465f2012-03-01 18:46:05 -08001337void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001338 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001339}
1340
Jeff Hao57dac6e2013-08-15 16:36:24 -07001341uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001342#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001343 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001344 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001345 timespec now;
1346 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001347 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001348#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001349 UNIMPLEMENTED(WARNING);
1350 return -1;
1351#endif
1352}
1353
Ian Rogers01ae5802012-09-28 16:14:01 -07001354// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1355static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001356 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001357 Locks::thread_suspend_count_lock_->Unlock(self);
1358 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1359 Locks::mutator_lock_->SharedTryLock(self);
1360 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1361 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1362 }
1363 }
1364 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1365 Locks::thread_list_lock_->TryLock(self);
1366 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1367 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1368 }
1369 }
1370 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001371 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001372 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001373}
1374
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001375bool Thread::ModifySuspendCountInternal(Thread* self,
1376 int delta,
1377 AtomicInteger* suspend_barrier,
Alex Light46f93402017-06-29 11:59:50 -07001378 SuspendReason reason) {
Ian Rogers2966e132014-04-02 08:34:36 -07001379 if (kIsDebugBuild) {
1380 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
Alex Light46f93402017-06-29 11:59:50 -07001381 << reason << " " << delta << " " << tls32_.debug_suspend_count << " " << this;
Ian Rogers2966e132014-04-02 08:34:36 -07001382 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1383 Locks::thread_suspend_count_lock_->AssertHeld(self);
1384 if (this != self && !IsSuspended()) {
1385 Locks::thread_list_lock_->AssertHeld(self);
1386 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001387 }
Alex Light88fd7202017-06-30 08:31:59 -07001388 // User code suspensions need to be checked more closely since they originate from code outside of
1389 // the runtime's control.
1390 if (UNLIKELY(reason == SuspendReason::kForUserCode)) {
1391 Locks::user_code_suspension_lock_->AssertHeld(self);
1392 if (UNLIKELY(delta + tls32_.user_code_suspend_count < 0)) {
1393 LOG(ERROR) << "attempting to modify suspend count in an illegal way.";
1394 return false;
1395 }
1396 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001397 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001398 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001399 return false;
1400 }
1401
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001402 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1403 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1404 // deadlock. b/31683379.
1405 return false;
1406 }
1407
Yu Lieac44242015-06-29 10:50:03 +08001408 uint16_t flags = kSuspendRequest;
1409 if (delta > 0 && suspend_barrier != nullptr) {
1410 uint32_t available_barrier = kMaxSuspendBarriers;
1411 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1412 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1413 available_barrier = i;
1414 break;
1415 }
1416 }
1417 if (available_barrier == kMaxSuspendBarriers) {
1418 // No barrier spaces available, we can't add another.
1419 return false;
1420 }
1421 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1422 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001423 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001424
Ian Rogersdd7624d2014-03-14 17:43:00 -07001425 tls32_.suspend_count += delta;
Alex Light46f93402017-06-29 11:59:50 -07001426 switch (reason) {
1427 case SuspendReason::kForDebugger:
1428 tls32_.debug_suspend_count += delta;
1429 break;
Alex Light88fd7202017-06-30 08:31:59 -07001430 case SuspendReason::kForUserCode:
1431 tls32_.user_code_suspend_count += delta;
1432 break;
Alex Light46f93402017-06-29 11:59:50 -07001433 case SuspendReason::kInternal:
1434 break;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001435 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001436
Ian Rogersdd7624d2014-03-14 17:43:00 -07001437 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001438 AtomicClearFlag(kSuspendRequest);
1439 } else {
Yu Lieac44242015-06-29 10:50:03 +08001440 // Two bits might be set simultaneously.
Orion Hodson88591fe2018-03-06 13:35:43 +00001441 tls32_.state_and_flags.as_atomic_int.fetch_or(flags, std::memory_order_seq_cst);
Dave Allisonb373e092014-02-20 16:06:36 -08001442 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001443 }
Yu Lieac44242015-06-29 10:50:03 +08001444 return true;
1445}
1446
1447bool Thread::PassActiveSuspendBarriers(Thread* self) {
1448 // Grab the suspend_count lock and copy the current set of
1449 // barriers. Then clear the list and the flag. The ModifySuspendCount
1450 // function requires the lock so we prevent a race between setting
1451 // the kActiveSuspendBarrier flag and clearing it.
1452 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1453 {
1454 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1455 if (!ReadFlag(kActiveSuspendBarrier)) {
1456 // quick exit test: the barriers have already been claimed - this is
1457 // possible as there may be a race to claim and it doesn't matter
1458 // who wins.
1459 // All of the callers of this function (except the SuspendAllInternal)
1460 // will first test the kActiveSuspendBarrier flag without lock. Here
1461 // double-check whether the barrier has been passed with the
1462 // suspend_count lock.
1463 return false;
1464 }
1465
1466 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1467 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1468 tlsPtr_.active_suspend_barriers[i] = nullptr;
1469 }
1470 AtomicClearFlag(kActiveSuspendBarrier);
1471 }
1472
1473 uint32_t barrier_count = 0;
1474 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1475 AtomicInteger* pending_threads = pass_barriers[i];
1476 if (pending_threads != nullptr) {
1477 bool done = false;
1478 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001479 int32_t cur_val = pending_threads->load(std::memory_order_relaxed);
Yu Lieac44242015-06-29 10:50:03 +08001480 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1481 // Reduce value by 1.
Orion Hodson4557b382018-01-03 11:47:54 +00001482 done = pending_threads->CompareAndSetWeakRelaxed(cur_val, cur_val - 1);
Yu Lieac44242015-06-29 10:50:03 +08001483#if ART_USE_FUTEXES
1484 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
Charles Munger7530bae2018-10-29 20:03:51 -07001485 futex(pending_threads->Address(), FUTEX_WAKE_PRIVATE, -1, nullptr, nullptr, 0);
Yu Lieac44242015-06-29 10:50:03 +08001486 }
1487#endif
1488 } while (!done);
1489 ++barrier_count;
1490 }
1491 }
1492 CHECK_GT(barrier_count, 0U);
1493 return true;
1494}
1495
1496void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1497 CHECK(ReadFlag(kActiveSuspendBarrier));
1498 bool clear_flag = true;
1499 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1500 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1501 if (ptr == target) {
1502 tlsPtr_.active_suspend_barriers[i] = nullptr;
1503 } else if (ptr != nullptr) {
1504 clear_flag = false;
1505 }
1506 }
1507 if (LIKELY(clear_flag)) {
1508 AtomicClearFlag(kActiveSuspendBarrier);
1509 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001510}
1511
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001512void Thread::RunCheckpointFunction() {
Alex Lightdf00a1e2017-11-01 09:29:53 -07001513 // Grab the suspend_count lock, get the next checkpoint and update all the checkpoint fields. If
1514 // there are no more checkpoints we will also clear the kCheckpointRequest flag.
1515 Closure* checkpoint;
1516 {
1517 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1518 checkpoint = tlsPtr_.checkpoint_function;
1519 if (!checkpoint_overflow_.empty()) {
1520 // Overflow list not empty, copy the first one out and continue.
1521 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1522 checkpoint_overflow_.pop_front();
1523 } else {
1524 // No overflow checkpoints. Clear the kCheckpointRequest flag
1525 tlsPtr_.checkpoint_function = nullptr;
1526 AtomicClearFlag(kCheckpointRequest);
Dave Allison0aded082013-11-07 13:15:11 -08001527 }
Alex Lightdf00a1e2017-11-01 09:29:53 -07001528 }
1529 // Outside the lock, run the checkpoint function.
1530 ScopedTrace trace("Run checkpoint function");
1531 CHECK(checkpoint != nullptr) << "Checkpoint flag set without pending checkpoint";
1532 checkpoint->Run(this);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001533}
1534
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001535void Thread::RunEmptyCheckpoint() {
1536 DCHECK_EQ(Thread::Current(), this);
1537 AtomicClearFlag(kEmptyCheckpointRequest);
1538 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1539}
1540
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001541bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001542 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001543 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001544 if (old_state_and_flags.as_struct.state != kRunnable) {
1545 return false; // Fail, thread is suspended and so can't run a checkpoint.
1546 }
Dave Allison0aded082013-11-07 13:15:11 -08001547
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001548 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001549 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001550 union StateAndFlags new_state_and_flags;
1551 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001552 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001553 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001554 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001555 if (success) {
1556 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1557 if (tlsPtr_.checkpoint_function == nullptr) {
1558 tlsPtr_.checkpoint_function = function;
1559 } else {
1560 checkpoint_overflow_.push_back(function);
1561 }
Dave Allison0aded082013-11-07 13:15:11 -08001562 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001563 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001564 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001565 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001566}
1567
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001568bool Thread::RequestEmptyCheckpoint() {
1569 union StateAndFlags old_state_and_flags;
1570 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1571 if (old_state_and_flags.as_struct.state != kRunnable) {
1572 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1573 // heap access (eg. the read barrier).
1574 return false;
1575 }
1576
1577 // We must be runnable to request a checkpoint.
1578 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1579 union StateAndFlags new_state_and_flags;
1580 new_state_and_flags.as_int = old_state_and_flags.as_int;
1581 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
Orion Hodson4557b382018-01-03 11:47:54 +00001582 bool success = tls32_.state_and_flags.as_atomic_int.CompareAndSetStrongSequentiallyConsistent(
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001583 old_state_and_flags.as_int, new_state_and_flags.as_int);
1584 if (success) {
1585 TriggerSuspend();
1586 }
1587 return success;
1588}
1589
Andreas Gampee9f67122016-10-27 19:21:23 -07001590class BarrierClosure : public Closure {
1591 public:
1592 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1593
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001594 void Run(Thread* self) override {
Andreas Gampee9f67122016-10-27 19:21:23 -07001595 wrapped_->Run(self);
1596 barrier_.Pass(self);
1597 }
1598
Alex Light318afe62018-03-22 16:50:10 -07001599 void Wait(Thread* self, ThreadState suspend_state) {
1600 if (suspend_state != ThreadState::kRunnable) {
1601 barrier_.Increment<Barrier::kDisallowHoldingLocks>(self, 1);
1602 } else {
1603 barrier_.Increment<Barrier::kAllowHoldingLocks>(self, 1);
1604 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001605 }
1606
1607 private:
1608 Closure* wrapped_;
1609 Barrier barrier_;
1610};
1611
Alex Lightb1e31a82017-10-04 16:57:36 -07001612// RequestSynchronousCheckpoint releases the thread_list_lock_ as a part of its execution.
Alex Light318afe62018-03-22 16:50:10 -07001613bool Thread::RequestSynchronousCheckpoint(Closure* function, ThreadState suspend_state) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001614 Thread* self = Thread::Current();
Andreas Gampee9f67122016-10-27 19:21:23 -07001615 if (this == Thread::Current()) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001616 Locks::thread_list_lock_->AssertExclusiveHeld(self);
1617 // Unlock the tll before running so that the state is the same regardless of thread.
1618 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001619 // Asked to run on this thread. Just run.
1620 function->Run(this);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001621 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001622 }
Andreas Gampee9f67122016-10-27 19:21:23 -07001623
1624 // The current thread is not this thread.
1625
Andreas Gampe28c4a232017-06-21 21:21:31 -07001626 if (GetState() == ThreadState::kTerminated) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001627 Locks::thread_list_lock_->ExclusiveUnlock(self);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001628 return false;
1629 }
1630
Andreas Gampe28c4a232017-06-21 21:21:31 -07001631 struct ScopedThreadListLockUnlock {
1632 explicit ScopedThreadListLockUnlock(Thread* self_in) RELEASE(*Locks::thread_list_lock_)
1633 : self_thread(self_in) {
1634 Locks::thread_list_lock_->AssertHeld(self_thread);
1635 Locks::thread_list_lock_->Unlock(self_thread);
1636 }
1637
1638 ~ScopedThreadListLockUnlock() ACQUIRE(*Locks::thread_list_lock_) {
1639 Locks::thread_list_lock_->AssertNotHeld(self_thread);
1640 Locks::thread_list_lock_->Lock(self_thread);
1641 }
1642
1643 Thread* self_thread;
1644 };
1645
Andreas Gampee9f67122016-10-27 19:21:23 -07001646 for (;;) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001647 Locks::thread_list_lock_->AssertExclusiveHeld(self);
Andreas Gampee9f67122016-10-27 19:21:23 -07001648 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1649 // suspend-count lock for too long.
1650 if (GetState() == ThreadState::kRunnable) {
1651 BarrierClosure barrier_closure(function);
1652 bool installed = false;
1653 {
1654 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1655 installed = RequestCheckpoint(&barrier_closure);
1656 }
1657 if (installed) {
Alex Lightb1e31a82017-10-04 16:57:36 -07001658 // Relinquish the thread-list lock. We should not wait holding any locks. We cannot
1659 // reacquire it since we don't know if 'this' hasn't been deleted yet.
1660 Locks::thread_list_lock_->ExclusiveUnlock(self);
Alex Light318afe62018-03-22 16:50:10 -07001661 ScopedThreadStateChange sts(self, suspend_state);
1662 barrier_closure.Wait(self, suspend_state);
Andreas Gampe28c4a232017-06-21 21:21:31 -07001663 return true;
Andreas Gampee9f67122016-10-27 19:21:23 -07001664 }
1665 // Fall-through.
1666 }
1667
1668 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1669 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1670 // certain situations.
1671 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001672 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1673
Alex Light46f93402017-06-29 11:59:50 -07001674 if (!ModifySuspendCount(self, +1, nullptr, SuspendReason::kInternal)) {
Andreas Gampee9f67122016-10-27 19:21:23 -07001675 // Just retry the loop.
1676 sched_yield();
1677 continue;
1678 }
1679 }
1680
Andreas Gampe28c4a232017-06-21 21:21:31 -07001681 {
Alex Lightb1e31a82017-10-04 16:57:36 -07001682 // Release for the wait. The suspension will keep us from being deleted. Reacquire after so
1683 // that we can call ModifySuspendCount without racing against ThreadList::Unregister.
Andreas Gampe28c4a232017-06-21 21:21:31 -07001684 ScopedThreadListLockUnlock stllu(self);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001685 {
Alex Light318afe62018-03-22 16:50:10 -07001686 ScopedThreadStateChange sts(self, suspend_state);
Andreas Gampe117f9b32017-06-23 13:33:50 -07001687 while (GetState() == ThreadState::kRunnable) {
1688 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1689 // moves us to suspended.
1690 sched_yield();
1691 }
Andreas Gampe28c4a232017-06-21 21:21:31 -07001692 }
1693
1694 function->Run(this);
Andreas Gampee9f67122016-10-27 19:21:23 -07001695 }
1696
Andreas Gampee9f67122016-10-27 19:21:23 -07001697 {
Andreas Gampee9f67122016-10-27 19:21:23 -07001698 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1699
1700 DCHECK_NE(GetState(), ThreadState::kRunnable);
Alex Light46f93402017-06-29 11:59:50 -07001701 bool updated = ModifySuspendCount(self, -1, nullptr, SuspendReason::kInternal);
Sebastien Hertz1c8f4ff2017-04-14 15:05:12 +02001702 DCHECK(updated);
Andreas Gampee9f67122016-10-27 19:21:23 -07001703 }
1704
Andreas Gampe117f9b32017-06-23 13:33:50 -07001705 {
1706 // Imitate ResumeAll, the thread may be waiting on Thread::resume_cond_ since we raised its
1707 // suspend count. Now the suspend_count_ is lowered so we must do the broadcast.
1708 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1709 Thread::resume_cond_->Broadcast(self);
1710 }
1711
Alex Lightb1e31a82017-10-04 16:57:36 -07001712 // Release the thread_list_lock_ to be consistent with the barrier-closure path.
1713 Locks::thread_list_lock_->ExclusiveUnlock(self);
1714
Andreas Gampe28c4a232017-06-21 21:21:31 -07001715 return true; // We're done, break out of the loop.
Andreas Gampee9f67122016-10-27 19:21:23 -07001716 }
1717}
1718
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001719Closure* Thread::GetFlipFunction() {
1720 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1721 Closure* func;
1722 do {
Orion Hodson88591fe2018-03-06 13:35:43 +00001723 func = atomic_func->load(std::memory_order_relaxed);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001724 if (func == nullptr) {
1725 return nullptr;
1726 }
Orion Hodson4557b382018-01-03 11:47:54 +00001727 } while (!atomic_func->CompareAndSetWeakSequentiallyConsistent(func, nullptr));
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001728 DCHECK(func != nullptr);
1729 return func;
1730}
1731
1732void Thread::SetFlipFunction(Closure* function) {
1733 CHECK(function != nullptr);
1734 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
Orion Hodson88591fe2018-03-06 13:35:43 +00001735 atomic_func->store(function, std::memory_order_seq_cst);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001736}
1737
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001738void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001739 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001740 VLOG(threads) << this << " self-suspending";
1741 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001742 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
Andreas Gampe896583e2018-06-15 13:31:58 -07001743 ScopedThreadSuspension(this, kSuspended); // NOLINT
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001744 VLOG(threads) << this << " self-reviving";
1745}
1746
Andreas Gampe9186ced2016-12-12 14:28:21 -08001747static std::string GetSchedulerGroupName(pid_t tid) {
1748 // /proc/<pid>/cgroup looks like this:
1749 // 2:devices:/
1750 // 1:cpuacct,cpu:/
1751 // We want the third field from the line whose second field contains the "cpu" token.
1752 std::string cgroup_file;
1753 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1754 return "";
1755 }
1756 std::vector<std::string> cgroup_lines;
1757 Split(cgroup_file, '\n', &cgroup_lines);
1758 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1759 std::vector<std::string> cgroup_fields;
1760 Split(cgroup_lines[i], ':', &cgroup_fields);
1761 std::vector<std::string> cgroups;
1762 Split(cgroup_fields[1], ',', &cgroups);
1763 for (size_t j = 0; j < cgroups.size(); ++j) {
1764 if (cgroups[j] == "cpu") {
1765 return cgroup_fields[2].substr(1); // Skip the leading slash.
1766 }
1767 }
1768 }
1769 return "";
1770}
1771
1772
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001773void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001774 std::string group_name;
1775 int priority;
1776 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001777 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001778
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001779 // If flip_function is not null, it means we have run a checkpoint
1780 // before the thread wakes up to execute the flip function and the
1781 // thread roots haven't been forwarded. So the following access to
1782 // the roots (opeer or methods in the frames) would be bad. Run it
1783 // here. TODO: clean up.
1784 if (thread != nullptr) {
1785 ScopedObjectAccessUnchecked soa(self);
1786 Thread* this_thread = const_cast<Thread*>(thread);
1787 Closure* flip_func = this_thread->GetFlipFunction();
1788 if (flip_func != nullptr) {
1789 flip_func->Run(this_thread);
1790 }
1791 }
1792
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001793 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1794 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001795 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001796 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001797 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001798 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001799 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001800 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001801
Mathieu Chartier3398c782016-09-30 10:27:43 -07001802 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001803 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1804 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001805
Dave Allison0aded082013-11-07 13:15:11 -08001806 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001807 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001808 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001809 ObjPtr<mirror::String> group_name_string =
1810 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001811 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001812 }
1813 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001814 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001815 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001816
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001817 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001818 if (scheduler_group_name.empty()) {
1819 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001820 }
1821
Dave Allison0aded082013-11-07 13:15:11 -08001822 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001823 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001824 if (is_daemon) {
1825 os << " daemon";
1826 }
1827 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001828 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001829 << " " << thread->GetState();
1830 if (thread->IsStillStarting()) {
1831 os << " (still starting up)";
1832 }
1833 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001834 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001835 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001836 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001837 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001838 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001839
Dave Allison0aded082013-11-07 13:15:11 -08001840 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001841 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001842 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001843 << " sCount=" << thread->tls32_.suspend_count
1844 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001845 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001846 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001847 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1848 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001849
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001850 os << " | sysTid=" << tid
1851 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001852 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001853 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001854 int policy;
1855 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001856#if !defined(__APPLE__)
1857 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1858 policy = sched_getscheduler(tid);
1859 if (policy == -1) {
1860 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1861 }
1862 int sched_getparam_result = sched_getparam(tid, &sp);
1863 if (sched_getparam_result == -1) {
1864 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1865 sp.sched_priority = -1;
1866 }
1867#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001868 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1869 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001870#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001871 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001872 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001873 }
1874 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001875
1876 // Grab the scheduler stats for this thread.
1877 std::string scheduler_stats;
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001878 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001879 scheduler_stats.resize(scheduler_stats.size() - 1); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001880 } else {
1881 scheduler_stats = "0 0 0";
1882 }
1883
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001884 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001885 int utime = 0;
1886 int stime = 0;
1887 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001888 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001889
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001890 os << " | state=" << native_thread_state
1891 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001892 << " utm=" << utime
1893 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001894 << " core=" << task_cpu
1895 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001896 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001897 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1898 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1899 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001900 // Dump the held mutexes.
1901 os << " | held mutexes=";
1902 for (size_t i = 0; i < kLockLevelCount; ++i) {
1903 if (i != kMonitorLock) {
1904 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1905 if (mutex != nullptr) {
1906 os << " \"" << mutex->GetName() << "\"";
1907 if (mutex->IsReaderWriterMutex()) {
1908 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Hans Boehm0882af22017-08-31 15:21:57 -07001909 if (rw_mutex->GetExclusiveOwnerTid() == tid) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001910 os << "(exclusive held)";
1911 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001912 os << "(shared held)";
1913 }
1914 }
1915 }
1916 }
1917 }
1918 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001919 }
1920}
1921
1922void Thread::DumpState(std::ostream& os) const {
1923 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001924}
1925
Andreas Gampe93104952017-12-13 17:13:15 -08001926struct StackDumpVisitor : public MonitorObjectsStackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001927 StackDumpVisitor(std::ostream& os_in,
1928 Thread* thread_in,
1929 Context* context,
Andreas Gampe93104952017-12-13 17:13:15 -08001930 bool can_allocate,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001931 bool check_suspended = true,
Andreas Gampe93104952017-12-13 17:13:15 -08001932 bool dump_locks = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001933 REQUIRES_SHARED(Locks::mutator_lock_)
Andreas Gampe93104952017-12-13 17:13:15 -08001934 : MonitorObjectsStackVisitor(thread_in,
1935 context,
1936 check_suspended,
1937 can_allocate && dump_locks),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001938 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001939 last_method(nullptr),
1940 last_line_number(0),
Andreas Gampe93104952017-12-13 17:13:15 -08001941 repetition_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001942
Ian Rogersbdb03912011-09-14 00:55:44 -07001943 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001944 if (frame_count == 0) {
1945 os << " (no managed stack frames)\n";
1946 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001947 }
1948
Andreas Gampe93104952017-12-13 17:13:15 -08001949 static constexpr size_t kMaxRepetition = 3u;
1950
1951 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001952 override
Andreas Gampe93104952017-12-13 17:13:15 -08001953 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe542451c2016-07-26 09:02:02 -07001954 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Vladimir Marko813a8632018-11-29 16:17:01 +00001955 ObjPtr<mirror::DexCache> dex_cache = m->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001956 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001957 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001958 const DexFile* dex_file = dex_cache->GetDexFile();
1959 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001960 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001961 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001962 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001963 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001964 if (repetition_count >= kMaxRepetition) {
1965 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1966 }
1967 repetition_count = 0;
1968 last_line_number = line_number;
1969 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001970 }
Andreas Gampe93104952017-12-13 17:13:15 -08001971
1972 if (repetition_count >= kMaxRepetition) {
1973 // Skip visiting=printing anything.
1974 return VisitMethodResult::kSkipMethod;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001975 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001976
Andreas Gampe93104952017-12-13 17:13:15 -08001977 os << " at " << m->PrettyMethod(false);
1978 if (m->IsNative()) {
1979 os << "(Native method)";
1980 } else {
1981 const char* source_file(m->GetDeclaringClassSourceFile());
1982 os << "(" << (source_file != nullptr ? source_file : "unavailable")
1983 << ":" << line_number << ")";
1984 }
1985 os << "\n";
1986 // Go and visit locks.
1987 return VisitMethodResult::kContinueMethod;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001988 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001989
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001990 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampe93104952017-12-13 17:13:15 -08001991 return VisitMethodResult::kContinueMethod;
1992 }
1993
1994 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01001995 override
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001996 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe93104952017-12-13 17:13:15 -08001997 PrintObject(obj, " - waiting on ", ThreadList::kInvalidThreadId);
1998 }
1999 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002000 override
Andreas Gampe93104952017-12-13 17:13:15 -08002001 REQUIRES_SHARED(Locks::mutator_lock_) {
2002 PrintObject(obj, " - sleeping on ", ThreadList::kInvalidThreadId);
2003 }
2004 void VisitBlockedOnObject(mirror::Object* obj,
2005 ThreadState state,
2006 uint32_t owner_tid)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002007 override
Andreas Gampe93104952017-12-13 17:13:15 -08002008 REQUIRES_SHARED(Locks::mutator_lock_) {
2009 const char* msg;
2010 switch (state) {
2011 case kBlocked:
2012 msg = " - waiting to lock ";
2013 break;
2014
2015 case kWaitingForLockInflation:
2016 msg = " - waiting for lock inflation of ";
2017 break;
2018
2019 default:
2020 LOG(FATAL) << "Unreachable";
2021 UNREACHABLE();
2022 }
2023 PrintObject(obj, msg, owner_tid);
2024 }
2025 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002026 override
Andreas Gampe93104952017-12-13 17:13:15 -08002027 REQUIRES_SHARED(Locks::mutator_lock_) {
2028 PrintObject(obj, " - locked ", ThreadList::kInvalidThreadId);
2029 }
2030
2031 void PrintObject(mirror::Object* obj,
2032 const char* msg,
2033 uint32_t owner_tid) REQUIRES_SHARED(Locks::mutator_lock_) {
2034 if (obj == nullptr) {
2035 os << msg << "an unknown object";
Ian Rogersd803bc72014-04-01 15:33:03 -07002036 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002037 if ((obj->GetLockWord(true).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07002038 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
2039 // Getting the identity hashcode here would result in lock inflation and suspension of the
2040 // current thread, which isn't safe if this is the only runnable thread.
Andreas Gampe93104952017-12-13 17:13:15 -08002041 os << msg << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)",
2042 reinterpret_cast<intptr_t>(obj),
2043 obj->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002044 } else {
Andreas Gampe93104952017-12-13 17:13:15 -08002045 // - waiting on <0x6008c468> (a java.lang.Class<java.lang.ref.ReferenceQueue>)
2046 // Call PrettyTypeOf before IdentityHashCode since IdentityHashCode can cause thread
2047 // suspension and move pretty_object.
2048 const std::string pretty_type(obj->PrettyTypeOf());
2049 os << msg << StringPrintf("<0x%08x> (a %s)", obj->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07002050 }
2051 }
Andreas Gampe93104952017-12-13 17:13:15 -08002052 if (owner_tid != ThreadList::kInvalidThreadId) {
2053 os << " held by thread " << owner_tid;
2054 }
Ian Rogersd803bc72014-04-01 15:33:03 -07002055 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08002056 }
2057
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002058 std::ostream& os;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002059 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07002060 int last_line_number;
Andreas Gampe93104952017-12-13 17:13:15 -08002061 size_t repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07002062};
2063
Ian Rogers33e95662013-05-20 20:29:14 -07002064static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002065 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07002066 ThreadState state = thread->GetState();
2067
2068 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
2069 if (state > kWaiting && state < kStarting) {
2070 return true;
2071 }
2072
2073 // In an Object.wait variant or Thread.sleep? That's not interesting.
2074 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
2075 return false;
2076 }
2077
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002078 // Threads with no managed stack frames should be shown.
Vladimir Markoe7441632017-11-29 13:00:56 +00002079 if (!thread->HasManagedStack()) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07002080 return true;
2081 }
2082
Elliott Hughesaef701d2013-04-05 18:15:40 -07002083 // In some other native method? That's interesting.
2084 // We don't just check kNative because native methods will be in state kSuspended if they're
2085 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
2086 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07002087 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002088 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07002089}
2090
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002091void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002092 // If flip_function is not null, it means we have run a checkpoint
2093 // before the thread wakes up to execute the flip function and the
2094 // thread roots haven't been forwarded. So the following access to
2095 // the roots (locks or methods in the frames) would be bad. Run it
2096 // here. TODO: clean up.
2097 {
2098 Thread* this_thread = const_cast<Thread*>(this);
2099 Closure* flip_func = this_thread->GetFlipFunction();
2100 if (flip_func != nullptr) {
2101 flip_func->Run(this_thread);
2102 }
2103 }
2104
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002105 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
2106 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08002107 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
2108 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002109 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002110 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002111 bool have_exception = false;
2112 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002113 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002114 const_cast<Thread*>(this)->ClearException();
2115 have_exception = true;
2116 }
2117
Ian Rogers700a4022014-05-19 16:49:03 -07002118 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002119 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002120 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002121 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002122
2123 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002124 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07002125 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07002126}
2127
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002128void Thread::DumpStack(std::ostream& os,
2129 bool dump_native_stack,
2130 BacktraceMap* backtrace_map,
2131 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07002132 // TODO: we call this code when dying but may not have suspended the thread ourself. The
2133 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
2134 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07002135 bool dump_for_abort = (gAborting > 0);
2136 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
2137 if (!kIsDebugBuild) {
2138 // We always want to dump the stack for an abort, however, there is no point dumping another
2139 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
2140 safe_to_dump = (safe_to_dump || dump_for_abort);
2141 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08002142 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002143 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffray6ee49712018-03-30 14:39:05 +00002144 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07002145 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002146 ArtMethod* method =
2147 GetCurrentMethod(nullptr,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002148 /*check_suspended=*/ !force_dump_stack,
2149 /*abort_on_error=*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08002150 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07002151 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08002152 DumpJavaStack(os,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07002153 /*check_suspended=*/ !force_dump_stack,
2154 /*dump_locks=*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07002155 } else {
2156 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08002157 }
Elliott Hughese27955c2011-08-26 15:21:24 -07002158}
2159
Elliott Hughesbe759c62011-09-08 19:38:21 -07002160void Thread::ThreadExitCallback(void* arg) {
2161 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002162 if (self->tls32_.thread_exit_check_count == 0) {
2163 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
2164 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07002165 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002166#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002167 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
2168#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002169 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00002170#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07002171 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07002172 } else {
2173 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
2174 }
Carl Shapirob5573532011-07-12 18:22:59 -07002175}
2176
Elliott Hughesbe759c62011-09-08 19:38:21 -07002177void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07002178 CHECK(!is_started_);
2179 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002180 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002181 // MutexLock to keep annotalysis happy.
2182 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002183 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07002184 // return garbage since (is_started_ == true) and
2185 // Thread::pthread_key_self_ is not yet initialized.
2186 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08002187 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07002188 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
2189 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002190 }
2191
Carl Shapirob5573532011-07-12 18:22:59 -07002192 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08002193 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
2194 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07002195
2196 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08002197 if (pthread_getspecific(pthread_key_self_) != nullptr) {
2198 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07002199 }
Elliott Hughes038a8062011-09-18 14:12:41 -07002200}
Carl Shapirob5573532011-07-12 18:22:59 -07002201
Elliott Hughes038a8062011-09-18 14:12:41 -07002202void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07002203 Runtime* runtime = Runtime::Current();
2204 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07002205
Elliott Hughes01158d72011-09-19 19:47:10 -07002206 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002207 ScopedObjectAccess soa(Thread::Current());
Vladimir Markodcfcce42018-06-27 10:00:28 +00002208 soa.Self()->CreatePeer("main", false, runtime->GetMainThreadGroup());
2209 soa.Self()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05002210
Vladimir Markodcfcce42018-06-27 10:00:28 +00002211 runtime->RunRootClinits(soa.Self());
Andreas Gampe21cf95d2017-04-17 20:19:14 -07002212
2213 // The thread counts as started from now on. We need to add it to the ThreadGroup. For regular
2214 // threads, this is done in Thread.start() on the Java side.
Vladimir Markodcfcce42018-06-27 10:00:28 +00002215 soa.Self()->NotifyThreadGroup(soa, runtime->GetMainThreadGroup());
2216 soa.Self()->AssertNoPendingException();
Carl Shapirob5573532011-07-12 18:22:59 -07002217}
2218
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002219void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07002220 CHECK(is_started_);
2221 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07002222 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07002223 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08002224 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07002225 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08002226 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07002227 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002228}
2229
Andreas Gampe56776012018-01-26 17:40:55 -08002230void Thread::NotifyThreadGroup(ScopedObjectAccessAlreadyRunnable& soa, jobject thread_group) {
2231 ScopedLocalRef<jobject> thread_jobject(
2232 soa.Env(), soa.Env()->AddLocalReference<jobject>(Thread::Current()->GetPeer()));
2233 ScopedLocalRef<jobject> thread_group_jobject_scoped(
2234 soa.Env(), nullptr);
2235 jobject thread_group_jobject = thread_group;
2236 if (thread_group == nullptr || kIsDebugBuild) {
2237 // There is always a group set. Retrieve it.
2238 thread_group_jobject_scoped.reset(
2239 soa.Env()->GetObjectField(thread_jobject.get(),
2240 WellKnownClasses::java_lang_Thread_group));
2241 thread_group_jobject = thread_group_jobject_scoped.get();
2242 if (kIsDebugBuild && thread_group != nullptr) {
2243 CHECK(soa.Env()->IsSameObject(thread_group, thread_group_jobject));
2244 }
2245 }
2246 soa.Env()->CallNonvirtualVoidMethod(thread_group_jobject,
2247 WellKnownClasses::java_lang_ThreadGroup,
2248 WellKnownClasses::java_lang_ThreadGroup_add,
2249 thread_jobject.get());
2250}
2251
Calin Juravleccd56952016-12-15 17:57:38 +00002252Thread::Thread(bool daemon)
2253 : tls32_(daemon),
2254 wait_monitor_(nullptr),
Alex Lightcea42152018-09-18 22:51:55 +00002255 is_runtime_thread_(false) {
Charles Mungerc665d632018-11-06 16:20:13 +00002256 wait_mutex_ = new Mutex("a thread wait mutex", LockLevel::kThreadWaitLock);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002257 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002258 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
2259 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
2260
Roland Levillain33d69032015-06-18 18:20:59 +01002261 static_assert((sizeof(Thread) % 4) == 0U,
2262 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07002263 tls32_.state_and_flags.as_struct.flags = 0;
2264 tls32_.state_and_flags.as_struct.state = kNative;
Orion Hodson88591fe2018-03-06 13:35:43 +00002265 tls32_.interrupted.store(false, std::memory_order_relaxed);
Charles Mungeraa31f492018-11-01 18:57:38 +00002266 // Initialize with no permit; if the java Thread was unparked before being
2267 // started, it will unpark itself before calling into java code.
2268 tls32_.park_state_.store(kNoPermit, std::memory_order_relaxed);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002269 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07002270 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08002271 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07002272 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002273 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08002274 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
2275 tlsPtr_.active_suspend_barriers[i] = nullptr;
2276 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002277 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002278 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002279 tls32_.is_transitioning_to_runnable = false;
David Srbecky28f6cff2018-10-16 15:07:28 +01002280 tls32_.use_mterp = false;
2281}
2282
2283void Thread::NotifyInTheadList() {
2284 tls32_.use_mterp = interpreter::CanUseMterp();
Elliott Hughesdcc24742011-09-07 14:02:44 -07002285}
2286
Alex Lighte9f61032018-09-24 16:04:51 -07002287bool Thread::CanLoadClasses() const {
2288 return !IsRuntimeThread() || !Runtime::Current()->IsJavaDebuggable();
2289}
2290
Elliott Hughes7dc51662012-05-16 14:48:43 -07002291bool Thread::IsStillStarting() const {
2292 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08002293 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002294 // 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 -07002295 // assigned fairly early on, and needs to be.
2296 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
2297 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07002298 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
2299 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07002300}
2301
Andreas Gamped9efea62014-07-21 22:56:08 -07002302void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07002303 CHECK(IsExceptionPending()) << "Pending exception expected.";
2304}
2305
2306void Thread::AssertPendingOOMException() const {
2307 AssertPendingException();
2308 auto* e = GetException();
2309 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
2310 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07002311}
2312
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002313void Thread::AssertNoPendingException() const {
2314 if (UNLIKELY(IsExceptionPending())) {
2315 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002316 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002317 }
2318}
2319
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002320void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2321 if (UNLIKELY(IsExceptionPending())) {
2322 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002323 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002324 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002325 }
2326}
2327
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002328class MonitorExitVisitor : public SingleRootVisitor {
2329 public:
2330 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2331
2332 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2333 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002334 override NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002335 if (self_->HoldsLock(entered_monitor)) {
2336 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002337 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002338 << " left locked by native thread "
2339 << *Thread::Current() << " which is detaching";
2340 entered_monitor->MonitorExit(self_);
2341 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002342 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002343
2344 private:
2345 Thread* const self_;
2346};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002347
Elliott Hughesc0f09332012-03-26 13:27:06 -07002348void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002349 Thread* self = this;
2350 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002351
Ian Rogers68d8b422014-07-17 11:09:10 -07002352 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002353 {
2354 ScopedObjectAccess soa(self);
2355 MonitorExitVisitor visitor(self);
2356 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
Ian Rogers55256cb2017-12-21 17:07:11 -08002357 tlsPtr_.jni_env->monitors_.VisitRoots(&visitor, RootInfo(kRootVMInternal));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002358 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002359 // Release locally held global references which releasing may require the mutator lock.
2360 if (tlsPtr_.jpeer != nullptr) {
2361 // If pthread_create fails we don't have a jni env here.
2362 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2363 tlsPtr_.jpeer = nullptr;
2364 }
2365 if (tlsPtr_.class_loader_override != nullptr) {
2366 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2367 tlsPtr_.class_loader_override = nullptr;
2368 }
2369 }
2370
Ian Rogersdd7624d2014-03-14 17:43:00 -07002371 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002372 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002373 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002374 HandleUncaughtExceptions(soa);
Alex Lightdf132402017-09-29 12:54:33 -07002375 RemoveFromThreadGroup(soa);
Alex Light8c5e2da2017-07-11 10:32:20 -07002376 Runtime* runtime = Runtime::Current();
2377 if (runtime != nullptr) {
2378 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
2379 }
Elliott Hughes534da072012-03-27 15:17:42 -07002380
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002381 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002382 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002383 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002384 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002385 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002386 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002387 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002388 }
Elliott Hughes02b48d12011-09-07 17:15:51 -07002389
Ian Rogerscfaa4552012-11-26 21:00:08 -08002390 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2391 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002392 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002393 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002394 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002395 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002396 StackHandleScope<1> hs(self);
2397 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002398 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002399 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002400 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002401 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002402 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002403
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002404 {
2405 ScopedObjectAccess soa(self);
2406 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002407 if (kUseReadBarrier) {
2408 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2409 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002410 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002411}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002412
Elliott Hughesc0f09332012-03-26 13:27:06 -07002413Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002414 CHECK(tlsPtr_.class_loader_override == nullptr);
2415 CHECK(tlsPtr_.jpeer == nullptr);
2416 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002417 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002418 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002419 delete tlsPtr_.jni_env;
2420 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002421 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002422 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002423 CHECK(!ReadFlag(kCheckpointRequest));
2424 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002425 CHECK(tlsPtr_.checkpoint_function == nullptr);
2426 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002427 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002428 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002429
Sebastien Hertz07474662015-08-25 15:12:33 +00002430 // Make sure we processed all deoptimization requests.
2431 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002432 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2433 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002434
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002435 // We may be deleting a still born thread.
2436 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002437
2438 delete wait_cond_;
2439 delete wait_mutex_;
2440
Ian Rogersdd7624d2014-03-14 17:43:00 -07002441 if (tlsPtr_.long_jump_context != nullptr) {
2442 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002443 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002444
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002445 if (initialized) {
2446 CleanupCpu();
2447 }
2448
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002449 if (tlsPtr_.single_step_control != nullptr) {
2450 delete tlsPtr_.single_step_control;
2451 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002452 delete tlsPtr_.instrumentation_stack;
2453 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002454 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002455
Ian Rogers68d8b422014-07-17 11:09:10 -07002456 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002457
Elliott Hughesd8af1592012-04-16 20:40:15 -07002458 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002459}
2460
Andreas Gampe513061a2017-06-01 09:17:34 -07002461void Thread::HandleUncaughtExceptions(ScopedObjectAccessAlreadyRunnable& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002462 if (!IsExceptionPending()) {
2463 return;
2464 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002465 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002466 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002467
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002468 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002469 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2470 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002471
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002472 // Call the Thread instance's dispatchUncaughtException(Throwable)
2473 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2474 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2475 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002476
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002477 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002478 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002479}
2480
Andreas Gampe513061a2017-06-01 09:17:34 -07002481void Thread::RemoveFromThreadGroup(ScopedObjectAccessAlreadyRunnable& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002482 // this.group.removeThread(this);
2483 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002484 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002485 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002486 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002487 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002488 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002489 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002490 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2491 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2492 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002493 }
2494}
2495
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002496bool Thread::HandleScopeContains(jobject obj) const {
2497 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002498 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002499 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002500 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002501 return true;
2502 }
2503 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002504 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2505 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002506}
2507
Hans Boehm0882af22017-08-31 15:21:57 -07002508void Thread::HandleScopeVisitRoots(RootVisitor* visitor, pid_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002509 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2510 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002511 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2512 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002513 }
2514}
2515
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002516ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002517 if (obj == nullptr) {
2518 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002519 }
2520 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002521 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002522 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002523 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002524 // The "kinds" below are sorted by the frequency we expect to encounter them.
2525 if (kind == kLocal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002526 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals_;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002527 // Local references do not need a read barrier.
2528 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002529 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002530 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002531 // Check if this is a local reference in the handle scope.
2532 if (LIKELY(HandleScopeContains(obj))) {
2533 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002534 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002535 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002536 } else {
Ian Rogers55256cb2017-12-21 17:07:11 -08002537 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of invalid jobject %p", obj);
Ian Rogersc0542af2014-09-03 16:16:56 -07002538 expect_null = true;
2539 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002540 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002541 } else if (kind == kGlobal) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002542 result = tlsPtr_.jni_env->vm_->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002543 } else {
2544 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002545 result = tlsPtr_.jni_env->vm_->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002546 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002547 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002548 expect_null = true;
2549 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002550 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002551 }
2552
Ian Rogersc0542af2014-09-03 16:16:56 -07002553 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers55256cb2017-12-21 17:07:11 -08002554 tlsPtr_.jni_env->vm_->JniAbortF(nullptr, "use of deleted %s %p",
Ian Rogers68d8b422014-07-17 11:09:10 -07002555 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002556 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002557 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002558}
2559
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002560bool Thread::IsJWeakCleared(jweak obj) const {
2561 CHECK(obj != nullptr);
2562 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002563 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002564 CHECK_EQ(kind, kWeakGlobal);
Ian Rogers55256cb2017-12-21 17:07:11 -08002565 return tlsPtr_.jni_env->vm_->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002566}
2567
Ian Rogers81d425b2012-09-27 16:03:43 -07002568// Implements java.lang.Thread.interrupted.
2569bool Thread::Interrupted() {
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002570 DCHECK_EQ(Thread::Current(), this);
2571 // No other thread can concurrently reset the interrupted flag.
Orion Hodson88591fe2018-03-06 13:35:43 +00002572 bool interrupted = tls32_.interrupted.load(std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002573 if (interrupted) {
Orion Hodson88591fe2018-03-06 13:35:43 +00002574 tls32_.interrupted.store(false, std::memory_order_seq_cst);
Nicolas Geoffray365719c2017-03-08 13:11:50 +00002575 }
Ian Rogers81d425b2012-09-27 16:03:43 -07002576 return interrupted;
2577}
2578
2579// Implements java.lang.Thread.isInterrupted.
2580bool Thread::IsInterrupted() {
Orion Hodson88591fe2018-03-06 13:35:43 +00002581 return tls32_.interrupted.load(std::memory_order_seq_cst);
Ian Rogers81d425b2012-09-27 16:03:43 -07002582}
2583
Ian Rogersdd7624d2014-03-14 17:43:00 -07002584void Thread::Interrupt(Thread* self) {
Charles Mungeraa31f492018-11-01 18:57:38 +00002585 {
2586 MutexLock mu(self, *wait_mutex_);
2587 if (tls32_.interrupted.load(std::memory_order_seq_cst)) {
2588 return;
2589 }
2590 tls32_.interrupted.store(true, std::memory_order_seq_cst);
2591 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002592 }
Charles Mungeraa31f492018-11-01 18:57:38 +00002593 Unpark();
Ian Rogers81d425b2012-09-27 16:03:43 -07002594}
2595
2596void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002597 Thread* self = Thread::Current();
2598 MutexLock mu(self, *wait_mutex_);
2599 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002600}
2601
Ian Rogersc604d732012-10-14 16:09:54 -07002602void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002603 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002604 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002605 }
2606}
2607
Ian Rogers68d8b422014-07-17 11:09:10 -07002608void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2609 if (tlsPtr_.class_loader_override != nullptr) {
2610 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2611 }
2612 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2613}
2614
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002615using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2616
2617// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2618class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002619 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002620 explicit FetchStackTraceVisitor(Thread* thread,
2621 ArtMethodDexPcPair* saved_frames = nullptr,
2622 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002623 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002624 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002625 saved_frames_(saved_frames),
2626 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002627
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002628 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002629 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002630 // Note we also skip the frame if it doesn't have a method (namely the callee
2631 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002632 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002633 if (skipping_ && !m->IsRuntimeMethod() &&
Vladimir Markoadbceb72018-05-29 14:34:14 +01002634 !GetClassRoot<mirror::Throwable>()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002635 skipping_ = false;
2636 }
2637 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002638 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002639 if (depth_ < max_saved_frames_) {
2640 saved_frames_[depth_].first = m;
Andreas Gampee2abbc62017-09-15 11:59:26 -07002641 saved_frames_[depth_].second = m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002642 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002643 ++depth_;
2644 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002645 } else {
2646 ++skip_depth_;
2647 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002648 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002649 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002650
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002651 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002652 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002653 }
2654
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002655 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002656 return skip_depth_;
2657 }
2658
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002659 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002660 uint32_t depth_ = 0;
2661 uint32_t skip_depth_ = 0;
2662 bool skipping_ = true;
2663 ArtMethodDexPcPair* saved_frames_;
2664 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002665
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002666 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002667};
2668
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002669template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002670class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002671 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002672 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002673 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2674 self_(self),
2675 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002676 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002677
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002678 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002679 // Allocate method trace as an object array where the first element is a pointer array that
2680 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2681 // class of the ArtMethod pointers.
2682 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2683 StackHandleScope<1> hs(self_);
Vladimir Markob4eb1b12018-05-24 11:09:38 +01002684 ObjPtr<mirror::Class> array_class =
2685 GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002686 // The first element is the methods and dex pc array, the other elements are declaring classes
2687 // for the methods to ensure classes in the stack trace don't get unloaded.
2688 Handle<mirror::ObjectArray<mirror::Object>> trace(
2689 hs.NewHandle(
2690 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002691 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002692 // Acquire uninterruptible_ in all paths.
2693 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002694 self_->AssertPendingOOMException();
2695 return false;
2696 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002697 ObjPtr<mirror::PointerArray> methods_and_pcs =
2698 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002699 const char* last_no_suspend_cause =
2700 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2701 if (methods_and_pcs == nullptr) {
2702 self_->AssertPendingOOMException();
2703 return false;
2704 }
2705 trace->Set(0, methods_and_pcs);
2706 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002707 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002708 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002709 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002710 }
2711
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002712 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2713 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002714 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002715
Andreas Gampefa6a1b02018-09-07 08:11:55 -07002716 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002717 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002718 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002719 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002720 if (skip_depth_ > 0) {
2721 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002722 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002723 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002724 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002725 if (m->IsRuntimeMethod()) {
2726 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002727 }
Andreas Gampee2abbc62017-09-15 11:59:26 -07002728 AddFrame(m, m->IsProxyMethod() ? dex::kDexNoIndex : GetDexPc());
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002729 return true;
2730 }
2731
2732 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002733 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002734 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002735 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2736 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002737 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002738 pointer_size_);
2739 // Save the declaring class of the method to ensure that the declaring classes of the methods
2740 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002741 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002742 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002743 }
2744
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002745 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
2746 return ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(trace_->Get(0)));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002747 }
2748
2749 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002750 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002751 }
2752
2753 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002754 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002755 // How many more frames to skip.
2756 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002757 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002758 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002759 // An object array where the first element is a pointer array that contains the ArtMethod
2760 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2761 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2762 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002763 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002764 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002765 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002766
2767 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002768};
2769
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002770template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002771jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002772 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2773 constexpr size_t kMaxSavedFrames = 256;
2774 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2775 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2776 &saved_frames[0],
2777 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002778 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002779 const uint32_t depth = count_visitor.GetDepth();
2780 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002781
Ian Rogers1f539342012-10-03 21:09:42 -07002782 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002783 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2784 const_cast<Thread*>(this),
2785 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002786 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002787 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002788 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002789 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2790 // than doing the stack walk twice.
2791 if (depth < kMaxSavedFrames) {
2792 for (size_t i = 0; i < depth; ++i) {
2793 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2794 }
2795 } else {
2796 build_trace_visitor.WalkStack();
2797 }
2798
Mathieu Chartier910e8272015-09-30 09:24:22 -07002799 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002800 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002801 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002802 // Second half of trace_methods is dex PCs.
2803 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2804 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002805 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2806 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002807 }
2808 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002809 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002810}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002811template jobject Thread::CreateInternalStackTrace<false>(
2812 const ScopedObjectAccessAlreadyRunnable& soa) const;
2813template jobject Thread::CreateInternalStackTrace<true>(
2814 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002815
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002816bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002817 // Only count the depth since we do not pass a stack frame array as an argument.
2818 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002819 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002820 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002821}
2822
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002823static ObjPtr<mirror::StackTraceElement> CreateStackTraceElement(
2824 const ScopedObjectAccessAlreadyRunnable& soa,
2825 ArtMethod* method,
2826 uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
2827 int32_t line_number;
2828 StackHandleScope<3> hs(soa.Self());
2829 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2830 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
2831 if (method->IsProxyMethod()) {
2832 line_number = -1;
2833 class_name_object.Assign(method->GetDeclaringClass()->GetName());
2834 // source_name_object intentionally left null for proxy methods
2835 } else {
2836 line_number = method->GetLineNumFromDexPC(dex_pc);
2837 // Allocate element, potentially triggering GC
2838 // TODO: reuse class_name_object via Class::name_?
2839 const char* descriptor = method->GetDeclaringClassDescriptor();
2840 CHECK(descriptor != nullptr);
2841 std::string class_name(PrettyDescriptor(descriptor));
2842 class_name_object.Assign(
2843 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
2844 if (class_name_object == nullptr) {
2845 soa.Self()->AssertPendingOOMException();
2846 return nullptr;
2847 }
2848 const char* source_file = method->GetDeclaringClassSourceFile();
2849 if (line_number == -1) {
2850 // Make the line_number field of StackTraceElement hold the dex pc.
2851 // source_name_object is intentionally left null if we failed to map the dex pc to
2852 // a line number (most probably because there is no debug info). See b/30183883.
2853 line_number = dex_pc;
2854 } else {
2855 if (source_file != nullptr) {
2856 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2857 if (source_name_object == nullptr) {
2858 soa.Self()->AssertPendingOOMException();
2859 return nullptr;
2860 }
2861 }
2862 }
2863 }
2864 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
2865 CHECK(method_name != nullptr);
2866 Handle<mirror::String> method_name_object(
2867 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2868 if (method_name_object == nullptr) {
2869 return nullptr;
2870 }
2871 return mirror::StackTraceElement::Alloc(soa.Self(),
2872 class_name_object,
2873 method_name_object,
2874 source_name_object,
2875 line_number);
2876}
2877
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002878jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002879 const ScopedObjectAccessAlreadyRunnable& soa,
2880 jobject internal,
2881 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002882 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002883 // Decode the internal stack trace into the depth, method trace and PC trace.
2884 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002885 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002886 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002887
Mathieu Chartier910e8272015-09-30 09:24:22 -07002888 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002889
Elliott Hughes01158d72011-09-19 19:47:10 -07002890 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002891
Dave Allison0aded082013-11-07 13:15:11 -08002892 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002893 // Reuse the array we were given.
2894 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002895 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002896 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002897 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002898 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002899 } else {
2900 // Create java_trace array and place in local reference table
Vladimir Markobcf17522018-06-01 13:14:32 +01002901 ObjPtr<mirror::ObjectArray<mirror::StackTraceElement>> java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002902 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002903 if (java_traces == nullptr) {
2904 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002905 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002906 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002907 }
2908
Dave Allison0aded082013-11-07 13:15:11 -08002909 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002910 *stack_depth = depth;
2911 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002912
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002913 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002914 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002915 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002916 // Methods and dex PC trace is element 0.
2917 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002918 ObjPtr<mirror::PointerArray> const method_trace =
2919 ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(decoded_traces->Get(0)));
Ian Rogersaaa20802011-09-11 21:47:37 -07002920 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002921 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002922 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002923 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Andreas Gampeb6f309e2017-12-11 20:45:41 -08002924 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(soa, method, dex_pc);
Dave Allison0aded082013-11-07 13:15:11 -08002925 if (obj == nullptr) {
2926 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002927 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002928 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002929 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002930 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002931 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002932}
2933
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002934jobjectArray Thread::CreateAnnotatedStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
2935 // This code allocates. Do not allow it to operate with a pending exception.
2936 if (IsExceptionPending()) {
2937 return nullptr;
2938 }
2939
2940 // If flip_function is not null, it means we have run a checkpoint
2941 // before the thread wakes up to execute the flip function and the
2942 // thread roots haven't been forwarded. So the following access to
2943 // the roots (locks or methods in the frames) would be bad. Run it
2944 // here. TODO: clean up.
2945 // Note: copied from DumpJavaStack.
2946 {
2947 Thread* this_thread = const_cast<Thread*>(this);
2948 Closure* flip_func = this_thread->GetFlipFunction();
2949 if (flip_func != nullptr) {
2950 flip_func->Run(this_thread);
2951 }
2952 }
2953
2954 class CollectFramesAndLocksStackVisitor : public MonitorObjectsStackVisitor {
2955 public:
2956 CollectFramesAndLocksStackVisitor(const ScopedObjectAccessAlreadyRunnable& soaa_in,
2957 Thread* self,
2958 Context* context)
2959 : MonitorObjectsStackVisitor(self, context),
2960 wait_jobject_(soaa_in.Env(), nullptr),
2961 block_jobject_(soaa_in.Env(), nullptr),
2962 soaa_(soaa_in) {}
2963
2964 protected:
2965 VisitMethodResult StartMethod(ArtMethod* m, size_t frame_nr ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002966 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002967 REQUIRES_SHARED(Locks::mutator_lock_) {
2968 ObjPtr<mirror::StackTraceElement> obj = CreateStackTraceElement(
2969 soaa_, m, GetDexPc(/* abort on error */ false));
2970 if (obj == nullptr) {
2971 return VisitMethodResult::kEndStackWalk;
2972 }
2973 stack_trace_elements_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj.Ptr()));
2974 return VisitMethodResult::kContinueMethod;
2975 }
2976
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002977 VisitMethodResult EndMethod(ArtMethod* m ATTRIBUTE_UNUSED) override {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002978 lock_objects_.push_back({});
2979 lock_objects_[lock_objects_.size() - 1].swap(frame_lock_objects_);
2980
2981 DCHECK_EQ(lock_objects_.size(), stack_trace_elements_.size());
2982
2983 return VisitMethodResult::kContinueMethod;
2984 }
2985
2986 void VisitWaitingObject(mirror::Object* obj, ThreadState state ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002987 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002988 REQUIRES_SHARED(Locks::mutator_lock_) {
2989 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2990 }
2991 void VisitSleepingObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002992 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08002993 REQUIRES_SHARED(Locks::mutator_lock_) {
2994 wait_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
2995 }
2996 void VisitBlockedOnObject(mirror::Object* obj,
2997 ThreadState state ATTRIBUTE_UNUSED,
2998 uint32_t owner_tid ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01002999 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003000 REQUIRES_SHARED(Locks::mutator_lock_) {
3001 block_jobject_.reset(soaa_.AddLocalReference<jobject>(obj));
3002 }
3003 void VisitLockedObject(mirror::Object* obj)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01003004 override
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003005 REQUIRES_SHARED(Locks::mutator_lock_) {
3006 frame_lock_objects_.emplace_back(soaa_.Env(), soaa_.AddLocalReference<jobject>(obj));
3007 }
3008
3009 public:
3010 std::vector<ScopedLocalRef<jobject>> stack_trace_elements_;
3011 ScopedLocalRef<jobject> wait_jobject_;
3012 ScopedLocalRef<jobject> block_jobject_;
3013 std::vector<std::vector<ScopedLocalRef<jobject>>> lock_objects_;
3014
3015 private:
3016 const ScopedObjectAccessAlreadyRunnable& soaa_;
3017
3018 std::vector<ScopedLocalRef<jobject>> frame_lock_objects_;
3019 };
3020
3021 std::unique_ptr<Context> context(Context::Create());
3022 CollectFramesAndLocksStackVisitor dumper(soa, const_cast<Thread*>(this), context.get());
3023 dumper.WalkStack();
3024
3025 // There should not be a pending exception. Otherwise, return with it pending.
3026 if (IsExceptionPending()) {
3027 return nullptr;
3028 }
3029
3030 // Now go and create Java arrays.
3031
3032 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
3033
3034 StackHandleScope<6> hs(soa.Self());
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003035 Handle<mirror::Class> h_aste_array_class = hs.NewHandle(class_linker->FindSystemClass(
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003036 soa.Self(),
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003037 "[Ldalvik/system/AnnotatedStackTraceElement;"));
3038 if (h_aste_array_class == nullptr) {
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003039 return nullptr;
3040 }
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003041 Handle<mirror::Class> h_aste_class = hs.NewHandle(h_aste_array_class->GetComponentType());
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003042
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003043 Handle<mirror::Class> h_o_array_class =
3044 hs.NewHandle(GetClassRoot<mirror::ObjectArray<mirror::Object>>(class_linker));
3045 DCHECK(h_o_array_class != nullptr); // Class roots must be already initialized.
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003046
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003047
3048 // Make sure the AnnotatedStackTraceElement.class is initialized, b/76208924 .
3049 class_linker->EnsureInitialized(soa.Self(),
3050 h_aste_class,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003051 /* can_init_fields= */ true,
3052 /* can_init_parents= */ true);
Vladimir Markoc4b1c0c2018-03-29 17:07:17 +01003053 if (soa.Self()->IsExceptionPending()) {
3054 // This should not fail in a healthy runtime.
3055 return nullptr;
3056 }
3057
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003058 ArtField* stack_trace_element_field = h_aste_class->FindField(
3059 soa.Self(), h_aste_class.Get(), "stackTraceElement", "Ljava/lang/StackTraceElement;");
3060 DCHECK(stack_trace_element_field != nullptr);
3061 ArtField* held_locks_field = h_aste_class->FindField(
3062 soa.Self(), h_aste_class.Get(), "heldLocks", "[Ljava/lang/Object;");
3063 DCHECK(held_locks_field != nullptr);
3064 ArtField* blocked_on_field = h_aste_class->FindField(
3065 soa.Self(), h_aste_class.Get(), "blockedOn", "Ljava/lang/Object;");
3066 DCHECK(blocked_on_field != nullptr);
3067
3068 size_t length = dumper.stack_trace_elements_.size();
3069 ObjPtr<mirror::ObjectArray<mirror::Object>> array =
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003070 mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(), h_aste_array_class.Get(), length);
Andreas Gampefb6b0b12017-12-11 20:47:56 -08003071 if (array == nullptr) {
3072 soa.Self()->AssertPendingOOMException();
3073 return nullptr;
3074 }
3075
3076 ScopedLocalRef<jobjectArray> result(soa.Env(), soa.Env()->AddLocalReference<jobjectArray>(array));
3077
3078 MutableHandle<mirror::Object> handle(hs.NewHandle<mirror::Object>(nullptr));
3079 MutableHandle<mirror::ObjectArray<mirror::Object>> handle2(
3080 hs.NewHandle<mirror::ObjectArray<mirror::Object>>(nullptr));
3081 for (size_t i = 0; i != length; ++i) {
3082 handle.Assign(h_aste_class->AllocObject(soa.Self()));
3083 if (handle == nullptr) {
3084 soa.Self()->AssertPendingOOMException();
3085 return nullptr;
3086 }
3087
3088 // Set stack trace element.
3089 stack_trace_element_field->SetObject<false>(
3090 handle.Get(), soa.Decode<mirror::Object>(dumper.stack_trace_elements_[i].get()));
3091
3092 // Create locked-on array.
3093 if (!dumper.lock_objects_[i].empty()) {
3094 handle2.Assign(mirror::ObjectArray<mirror::Object>::Alloc(soa.Self(),
3095 h_o_array_class.Get(),
3096 dumper.lock_objects_[i].size()));
3097 if (handle2 == nullptr) {
3098 soa.Self()->AssertPendingOOMException();
3099 return nullptr;
3100 }
3101 int32_t j = 0;
3102 for (auto& scoped_local : dumper.lock_objects_[i]) {
3103 if (scoped_local == nullptr) {
3104 continue;
3105 }
3106 handle2->Set(j, soa.Decode<mirror::Object>(scoped_local.get()));
3107 DCHECK(!soa.Self()->IsExceptionPending());
3108 j++;
3109 }
3110 held_locks_field->SetObject<false>(handle.Get(), handle2.Get());
3111 }
3112
3113 // Set blocked-on object.
3114 if (i == 0) {
3115 if (dumper.block_jobject_ != nullptr) {
3116 blocked_on_field->SetObject<false>(
3117 handle.Get(), soa.Decode<mirror::Object>(dumper.block_jobject_.get()));
3118 }
3119 }
3120
3121 ScopedLocalRef<jobject> elem(soa.Env(), soa.AddLocalReference<jobject>(handle.Get()));
3122 soa.Env()->SetObjectArrayElement(result.get(), i, elem.get());
3123 DCHECK(!soa.Self()->IsExceptionPending());
3124 }
3125
3126 return result.release();
3127}
3128
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003129void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003130 va_list args;
3131 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003132 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003133 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003134}
3135
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003136void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003137 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07003138 std::string msg;
3139 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003140 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07003141}
Elliott Hughes37f7a402011-08-22 18:56:01 -07003142
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003143void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003144 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08003145 // Callers should either clear or call ThrowNewWrappedException.
3146 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003147 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07003148}
3149
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003150static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003151 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003152 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003153 return method != nullptr
3154 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003155 : nullptr;
3156}
3157
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003158void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08003159 const char* msg) {
3160 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07003161 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003162 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00003163 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003164 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08003165 ClearException();
3166 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003167 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003168 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07003169 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003170 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07003171 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08003172 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07003173 return;
3174 }
Ian Rogers62d6c772013-02-27 08:32:07 -08003175
Ian Rogers7b078e82014-09-10 14:44:24 -07003176 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
3177 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003178 DCHECK(IsExceptionPending());
3179 return;
3180 }
3181 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003182 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07003183 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08003184
Mathieu Chartier590fee92013-09-13 13:46:47 -07003185 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08003186 if (exception == nullptr) {
Roland Levillain7b0e8442018-04-11 18:27:47 +01003187 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
3188 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingException());
Mathieu Chartier590fee92013-09-13 13:46:47 -07003189 return;
3190 }
3191
Ian Rogers62d6c772013-02-27 08:32:07 -08003192 // Choose an appropriate constructor and set up the arguments.
3193 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07003194 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08003195 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003196 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07003197 msg_string.reset(
3198 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08003199 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003200 CHECK(IsExceptionPending()); // OOME.
3201 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003202 }
Dave Allison0aded082013-11-07 13:15:11 -08003203 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003204 signature = "(Ljava/lang/String;)V";
3205 } else {
3206 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
3207 }
3208 } else {
Dave Allison0aded082013-11-07 13:15:11 -08003209 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003210 signature = "()V";
3211 } else {
3212 signature = "(Ljava/lang/Throwable;)V";
3213 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08003214 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003215 ArtMethod* exception_init_method =
Vladimir Markoba118822017-06-12 15:41:56 +01003216 exception_class->FindConstructor(signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08003217
Dave Allison0aded082013-11-07 13:15:11 -08003218 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08003219 << PrettyDescriptor(exception_class_descriptor);
3220
3221 if (UNLIKELY(!runtime->IsStarted())) {
3222 // Something is trying to throw an exception without a started runtime, which is the common
3223 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
3224 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08003225 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003226 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08003227 }
Dave Allison0aded082013-11-07 13:15:11 -08003228 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003229 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08003230 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07003231 ScopedLocalRef<jobject> trace(GetJniEnv(),
3232 Runtime::Current()->IsActiveTransaction()
3233 ? CreateInternalStackTrace<true>(soa)
3234 : CreateInternalStackTrace<false>(soa));
3235 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07003236 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07003237 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003238 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003239 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07003240 jvalue jv_args[2];
3241 size_t i = 0;
3242
Dave Allison0aded082013-11-07 13:15:11 -08003243 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003244 jv_args[i].l = msg_string.get();
3245 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003246 }
Dave Allison0aded082013-11-07 13:15:11 -08003247 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07003248 jv_args[i].l = cause.get();
3249 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08003250 }
Jeff Hao39b6c242015-05-19 20:30:23 -07003251 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08003252 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08003253 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003254 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08003255 }
Elliott Hughes30646832011-10-13 16:59:46 -07003256 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07003257}
3258
Elliott Hughes2ced6a52011-10-16 18:44:48 -07003259void Thread::ThrowOutOfMemoryError(const char* msg) {
Wei Li8991ad02018-09-13 16:43:39 +08003260 LOG(WARNING) << "Throwing OutOfMemoryError "
3261 << '"' << msg << '"'
3262 << " (VmSize " << GetProcessStatus("VmSize")
3263 << (tls32_.throwing_OutOfMemoryError ? ", recursive case)" : ")");
Ian Rogersdd7624d2014-03-14 17:43:00 -07003264 if (!tls32_.throwing_OutOfMemoryError) {
3265 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00003266 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003267 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07003268 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003269 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Roland Levillain7b0e8442018-04-11 18:27:47 +01003270 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryErrorWhenThrowingOOME());
Elliott Hughes418dfe72011-10-06 18:56:27 -07003271 }
Elliott Hughes79082e32011-08-25 12:07:32 -07003272}
3273
Elliott Hughes498508c2011-10-17 14:58:22 -07003274Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003275 return Thread::Current();
3276}
3277
3278void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003279 std::ostringstream ss;
3280 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08003281 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003282 // log to stderr for debugging command line processes
3283 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01003284#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07003285 // log to logcat for debugging frameworks processes
3286 LOG(INFO) << str;
3287#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07003288}
3289
Ian Rogersdd7624d2014-03-14 17:43:00 -07003290// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07003291template
3292void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
3293template
3294void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07003295
Andreas Gampe542451c2016-07-26 09:02:02 -07003296template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07003297void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
3298#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07003299 if (offset == (x).Uint32Value()) { \
3300 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07003301 return; \
3302 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003303 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
3304 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
3305 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
3306 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
3307 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
3308 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
3309 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
3310 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
Roland Levillain97c46462017-05-11 14:04:03 +01003311 DO_THREAD_OFFSET(IsGcMarkingOffset<ptr_size>(), "is_gc_marking")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003312 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003313 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07003314 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07003315 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003316#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07003317
Ian Rogersdd7624d2014-03-14 17:43:00 -07003318#define JNI_ENTRY_POINT_INFO(x) \
3319 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3320 os << #x; \
3321 return; \
3322 }
3323 JNI_ENTRY_POINT_INFO(pDlsymLookup)
3324#undef JNI_ENTRY_POINT_INFO
3325
Ian Rogersdd7624d2014-03-14 17:43:00 -07003326#define QUICK_ENTRY_POINT_INFO(x) \
3327 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
3328 os << #x; \
3329 return; \
3330 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07003331 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00003332 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
3333 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
3334 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
3335 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003336 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
3337 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00003338 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Alex Lightd109e302018-06-27 10:25:41 -07003339 QUICK_ENTRY_POINT_INFO(pAllocStringObject)
Jeff Hao848f70a2014-01-15 13:49:50 -08003340 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
3341 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
3342 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003343 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08003344 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003345 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
Vladimir Marko9d479252018-07-24 11:35:20 +01003346 QUICK_ENTRY_POINT_INFO(pResolveTypeAndVerifyAccess)
3347 QUICK_ENTRY_POINT_INFO(pResolveType)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003348 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07003349 QUICK_ENTRY_POINT_INFO(pSet8Instance)
3350 QUICK_ENTRY_POINT_INFO(pSet8Static)
3351 QUICK_ENTRY_POINT_INFO(pSet16Instance)
3352 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003353 QUICK_ENTRY_POINT_INFO(pSet32Instance)
3354 QUICK_ENTRY_POINT_INFO(pSet32Static)
3355 QUICK_ENTRY_POINT_INFO(pSet64Instance)
3356 QUICK_ENTRY_POINT_INFO(pSet64Static)
3357 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
3358 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07003359 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
3360 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
3361 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
3362 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
3363 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
3364 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
3365 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
3366 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003367 QUICK_ENTRY_POINT_INFO(pGet32Instance)
3368 QUICK_ENTRY_POINT_INFO(pGet32Static)
3369 QUICK_ENTRY_POINT_INFO(pGet64Instance)
3370 QUICK_ENTRY_POINT_INFO(pGet64Static)
3371 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
3372 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003373 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003374 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
3375 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
3376 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
3377 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
3378 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
3379 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
3380 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
3381 QUICK_ENTRY_POINT_INFO(pLockObject)
3382 QUICK_ENTRY_POINT_INFO(pUnlockObject)
3383 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
3384 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
3385 QUICK_ENTRY_POINT_INFO(pCmplDouble)
3386 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04003387 QUICK_ENTRY_POINT_INFO(pCos)
3388 QUICK_ENTRY_POINT_INFO(pSin)
3389 QUICK_ENTRY_POINT_INFO(pAcos)
3390 QUICK_ENTRY_POINT_INFO(pAsin)
3391 QUICK_ENTRY_POINT_INFO(pAtan)
3392 QUICK_ENTRY_POINT_INFO(pAtan2)
3393 QUICK_ENTRY_POINT_INFO(pCbrt)
3394 QUICK_ENTRY_POINT_INFO(pCosh)
3395 QUICK_ENTRY_POINT_INFO(pExp)
3396 QUICK_ENTRY_POINT_INFO(pExpm1)
3397 QUICK_ENTRY_POINT_INFO(pHypot)
3398 QUICK_ENTRY_POINT_INFO(pLog)
3399 QUICK_ENTRY_POINT_INFO(pLog10)
3400 QUICK_ENTRY_POINT_INFO(pNextAfter)
3401 QUICK_ENTRY_POINT_INFO(pSinh)
3402 QUICK_ENTRY_POINT_INFO(pTan)
3403 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003404 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003405 QUICK_ENTRY_POINT_INFO(pL2d)
3406 QUICK_ENTRY_POINT_INFO(pFmodf)
3407 QUICK_ENTRY_POINT_INFO(pL2f)
3408 QUICK_ENTRY_POINT_INFO(pD2iz)
3409 QUICK_ENTRY_POINT_INFO(pF2iz)
3410 QUICK_ENTRY_POINT_INFO(pIdivmod)
3411 QUICK_ENTRY_POINT_INFO(pD2l)
3412 QUICK_ENTRY_POINT_INFO(pF2l)
3413 QUICK_ENTRY_POINT_INFO(pLdiv)
3414 QUICK_ENTRY_POINT_INFO(pLmod)
3415 QUICK_ENTRY_POINT_INFO(pLmul)
3416 QUICK_ENTRY_POINT_INFO(pShlLong)
3417 QUICK_ENTRY_POINT_INFO(pShrLong)
3418 QUICK_ENTRY_POINT_INFO(pUshrLong)
3419 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003420 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
3421 QUICK_ENTRY_POINT_INFO(pMemcpy)
3422 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
3423 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
3424 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
3425 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
3426 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
3427 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
3428 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
3429 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00003430 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003431 QUICK_ENTRY_POINT_INFO(pTestSuspend)
3432 QUICK_ENTRY_POINT_INFO(pDeliverException)
3433 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
3434 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003435 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
3436 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07003437 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07003438 QUICK_ENTRY_POINT_INFO(pA64Load)
3439 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08003440 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
3441 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
3442 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
3443 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
3444 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
3445 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
3446 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
3447 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
3448 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
3449 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
3450 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
3451 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
3452 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
3453 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
3454 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
3455 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07003456 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01003457 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
3458 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
3459 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
3460 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
3461 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
3462 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
3463 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
3464 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
3465 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
3466 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
3467 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
3468 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
3469 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
3470 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
3471 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
3472 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
3473 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
3474 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
3475 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
3476 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
3477 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
3478 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
3479 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
3480 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
3481 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
3482 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
3483 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
3484 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
3485 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
3486 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07003487 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00003488 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07003489
3490 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
3491 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07003492#undef QUICK_ENTRY_POINT_INFO
3493
Elliott Hughes98e20172012-04-24 15:38:13 -07003494 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07003495}
3496
jeffhao94d6df42012-11-26 16:02:12 -08003497void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08003498 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003499 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08003500 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003501 if (exception == GetDeoptimizationException()) {
3502 artDeoptimize(this);
3503 UNREACHABLE();
3504 }
3505
Roland Levillaina78f5b62017-09-29 13:50:44 +01003506 ReadBarrier::MaybeAssertToSpaceInvariant(exception.Ptr());
Roland Levillainb77b6982017-06-08 18:03:48 +01003507
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003508 // This is a real exception: let the instrumentation know about it.
3509 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Alex Light6e1607e2017-08-23 10:06:18 -07003510 if (instrumentation->HasExceptionThrownListeners() &&
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003511 IsExceptionThrownByCurrentMethod(exception)) {
3512 // Instrumentation may cause GC so keep the exception object safe.
3513 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003514 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
Alex Light6e1607e2017-08-23 10:06:18 -07003515 instrumentation->ExceptionThrownEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003516 }
Alex Light0aa7a5a2018-10-10 15:58:14 +00003517 // Does instrumentation need to deoptimize the stack or otherwise go to interpreter for something?
3518 // Note: we do this *after* reporting the exception to instrumentation in case it now requires
3519 // deoptimization. It may happen if a debugger is attached and requests new events (single-step,
3520 // breakpoint, ...) when the exception is reported.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003521 //
3522 // Note we need to check for both force_frame_pop and force_retry_instruction. The first is
3523 // expected to happen fairly regularly but the second can only happen if we are using
3524 // instrumentation trampolines (for example with DDMS tracing). That forces us to do deopt later
3525 // and see every frame being popped. We don't need to handle it any differently.
Alex Light0aa7a5a2018-10-10 15:58:14 +00003526 ShadowFrame* cf;
Alex Lightbe1f8d02018-10-15 11:44:42 -07003527 bool force_deopt;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003528 {
3529 NthCallerVisitor visitor(this, 0, false);
3530 visitor.WalkStack();
3531 cf = visitor.GetCurrentShadowFrame();
3532 if (cf == nullptr) {
3533 cf = FindDebuggerShadowFrame(visitor.GetFrameId());
3534 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003535 bool force_frame_pop = cf != nullptr && cf->GetForcePopFrame();
3536 bool force_retry_instr = cf != nullptr && cf->GetForceRetryInstruction();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003537 if (kIsDebugBuild && force_frame_pop) {
3538 NthCallerVisitor penultimate_visitor(this, 1, false);
3539 penultimate_visitor.WalkStack();
3540 ShadowFrame* penultimate_frame = penultimate_visitor.GetCurrentShadowFrame();
3541 if (penultimate_frame == nullptr) {
3542 penultimate_frame = FindDebuggerShadowFrame(penultimate_visitor.GetFrameId());
3543 }
3544 DCHECK(penultimate_frame != nullptr &&
3545 penultimate_frame->GetForceRetryInstruction())
3546 << "Force pop frame without retry instruction found. penultimate frame is null: "
3547 << (penultimate_frame == nullptr ? "true" : "false");
3548 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003549 force_deopt = force_frame_pop || force_retry_instr;
Alex Light0aa7a5a2018-10-10 15:58:14 +00003550 }
Alex Lightbe1f8d02018-10-15 11:44:42 -07003551 if (Dbg::IsForcedInterpreterNeededForException(this) || force_deopt) {
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003552 NthCallerVisitor visitor(this, 0, false);
3553 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003554 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Mingyao Yang2ee17902017-08-30 11:37:08 -07003555 // method_type shouldn't matter due to exception handling.
3556 const DeoptimizationMethodType method_type = DeoptimizationMethodType::kDefault;
Sebastien Hertz520633b2015-09-08 17:03:36 +02003557 // Save the exception into the deoptimization context so it can be restored
3558 // before entering the interpreter.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003559 if (force_deopt) {
Alex Light0aa7a5a2018-10-10 15:58:14 +00003560 VLOG(deopt) << "Deopting " << cf->GetMethod()->PrettyMethod() << " for frame-pop";
3561 DCHECK(Runtime::Current()->AreNonStandardExitsEnabled());
3562 // Get rid of the exception since we are doing a framepop instead.
Alex Lightbe1f8d02018-10-15 11:44:42 -07003563 LOG(WARNING) << "Suppressing pending exception for retry-instruction/frame-pop: "
3564 << exception->Dump();
Alex Light0aa7a5a2018-10-10 15:58:14 +00003565 ClearException();
3566 }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01003567 PushDeoptimizationContext(
Mingyao Yang2ee17902017-08-30 11:37:08 -07003568 JValue(),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003569 /* is_reference= */ false,
Alex Lightbe1f8d02018-10-15 11:44:42 -07003570 (force_deopt ? nullptr : exception),
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003571 /* from_code= */ false,
Mingyao Yang2ee17902017-08-30 11:37:08 -07003572 method_type);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003573 artDeoptimize(this);
3574 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00003575 } else {
3576 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3577 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003578 }
3579 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003580
Ian Rogers28ad40d2011-10-27 15:19:26 -07003581 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003582 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003583 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003584 QuickExceptionHandler exception_handler(this, false);
3585 exception_handler.FindCatch(exception);
Roland Levillainb77b6982017-06-08 18:03:48 +01003586 if (exception_handler.GetClearException()) {
3587 // Exception was cleared as part of delivery.
3588 DCHECK(!IsExceptionPending());
3589 } else {
3590 // Exception was put back with a throw location.
3591 DCHECK(IsExceptionPending());
Roland Levillaina78f5b62017-09-29 13:50:44 +01003592 // Check the to-space invariant on the re-installed exception (if applicable).
3593 ReadBarrier::MaybeAssertToSpaceInvariant(GetException());
Roland Levillainb77b6982017-06-08 18:03:48 +01003594 }
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003595 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003596}
3597
Ian Rogersbdb03912011-09-14 00:55:44 -07003598Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003599 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003600 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003601 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003602 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003603 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003604 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003605 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003606 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003607}
3608
Andreas Gampec7d878d2018-11-19 18:42:06 +00003609ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc_out,
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003610 bool check_suspended,
3611 bool abort_on_error) const {
Andreas Gampe1b5c5c82018-09-27 10:42:18 -07003612 // Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3613 // so we don't abort in a special situation (thinlocked monitor) when dumping the Java
3614 // stack.
Andreas Gampec7d878d2018-11-19 18:42:06 +00003615 ArtMethod* method = nullptr;
3616 uint32_t dex_pc = dex::kDexNoIndex;
3617 StackVisitor::WalkStack(
3618 [&](const StackVisitor* visitor) REQUIRES_SHARED(Locks::mutator_lock_) {
3619 ArtMethod* m = visitor->GetMethod();
3620 if (m->IsRuntimeMethod()) {
3621 // Continue if this is a runtime method.
3622 return true;
3623 }
3624 method = m;
3625 dex_pc = visitor->GetDexPc(abort_on_error);
3626 return false;
3627 },
3628 const_cast<Thread*>(this),
3629 /* context= */ nullptr,
3630 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3631 check_suspended);
3632
3633 if (dex_pc_out != nullptr) {
3634 *dex_pc_out = dex_pc;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003635 }
Andreas Gampec7d878d2018-11-19 18:42:06 +00003636 return method;
jeffhao33dc7712011-11-09 17:54:24 -08003637}
3638
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003639bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3640 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003641}
3642
Roland Levillainad0777d2018-02-12 20:00:18 +00003643extern std::vector<StackReference<mirror::Object>*> GetProxyReferenceArguments(ArtMethod** sp)
Roland Levillainfa854e42018-02-07 13:09:55 +00003644 REQUIRES_SHARED(Locks::mutator_lock_);
3645
Ian Rogers40e3bac2012-11-20 00:09:14 -08003646// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003647template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003648class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003649 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003650 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003651 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003652 // We are visiting the references in compiled frames, so we do not need
3653 // to know the inlined frames.
3654 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3655 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003656
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003657 bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003658 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003659 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003660 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003661 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003662 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003663 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003664 VisitShadowFrame(shadow_frame);
3665 } else {
3666 VisitQuickFrame();
3667 }
3668 return true;
3669 }
3670
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003671 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003672 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003673 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003674 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003675 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003676 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
3677 // handle scope for JNI or References for interpreter.
3678 for (size_t reg = 0; reg < num_regs; ++reg) {
3679 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3680 if (ref != nullptr) {
3681 mirror::Object* new_ref = ref;
3682 visitor_(&new_ref, reg, this);
3683 if (new_ref != ref) {
3684 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003685 }
3686 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003687 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003688 // Mark lock count map required for structured locking checks.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003689 shadow_frame->GetLockCountData().VisitMonitors(visitor_, /* vreg= */ -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003690 }
3691
3692 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003693 // 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 -07003694 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3695 // the threads do not all hold the heap bitmap lock for parallel GC.
3696 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003697 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003698 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003699 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003700 // klass can be null for runtime methods.
3701 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003702 if (kVerifyImageObjectsMarked) {
3703 gc::Heap* const heap = Runtime::Current()->GetHeap();
3704 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003705 /*fail_ok=*/true);
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003706 if (space != nullptr && space->IsImageSpace()) {
3707 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003708 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003709 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003710 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003711 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003712 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003713 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003714 }
3715 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003716 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3717 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3718 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003719 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003720 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003721 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3722 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003723 }
3724 }
3725 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003726 mirror::Object* new_ref = klass.Ptr();
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003727 visitor_(&new_ref, /* vreg= */ -1, this);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003728 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003729 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003730 }
3731 }
3732 }
3733
Andreas Gampe585da952016-12-02 14:52:29 -08003734 template <typename T>
3735 ALWAYS_INLINE
3736 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003737 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003738 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003739 ArtMethod* m = *cur_quick_frame;
3740 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003741
Sebastien Hertz714f1752014-04-28 15:03:08 +02003742 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003743 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003744 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003745 DCHECK(method_header->IsOptimized());
Vladimir Marko78baed52018-10-11 10:44:58 +01003746 StackReference<mirror::Object>* vreg_base =
3747 reinterpret_cast<StackReference<mirror::Object>*>(cur_quick_frame);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003748 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
David Srbeckya2d29a32018-08-03 11:06:38 +01003749 CodeInfo code_info(method_header, kPrecise
David Srbecky42deda82018-08-10 11:23:27 +01003750 ? CodeInfo::DecodeFlags::AllTables // We will need dex register maps.
David Srbeckya2d29a32018-08-03 11:06:38 +01003751 : CodeInfo::DecodeFlags::GcMasksOnly);
David Srbecky052f8ca2018-04-26 15:42:54 +01003752 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003753 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003754
David Srbecky052f8ca2018-04-26 15:42:54 +01003755 T vreg_info(m, code_info, map, visitor_);
Andreas Gampe585da952016-12-02 14:52:29 -08003756
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003757 // Visit stack entries that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003758 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(map);
David Srbecky4b59d102018-05-29 21:46:10 +00003759 for (size_t i = 0; i < stack_mask.size_in_bits(); ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003760 if (stack_mask.LoadBit(i)) {
Roland Levillainfa854e42018-02-07 13:09:55 +00003761 StackReference<mirror::Object>* ref_addr = vreg_base + i;
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003762 mirror::Object* ref = ref_addr->AsMirrorPtr();
3763 if (ref != nullptr) {
3764 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003765 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003766 if (ref != new_ref) {
3767 ref_addr->Assign(new_ref);
David Srbeckya2d29a32018-08-03 11:06:38 +01003768 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003769 }
3770 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003771 }
3772 // Visit callee-save registers that hold pointers.
David Srbecky052f8ca2018-04-26 15:42:54 +01003773 uint32_t register_mask = code_info.GetRegisterMaskOf(map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003774 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3775 if (register_mask & (1 << i)) {
3776 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003777 if (kIsDebugBuild && ref_addr == nullptr) {
3778 std::string thread_name;
3779 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003780 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003781 DescribeStack(GetThread());
3782 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3783 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3784 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003785 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003786 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003787 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003788 }
3789 }
Roland Levillainad0777d2018-02-12 20:00:18 +00003790 } else if (!m->IsRuntimeMethod() && m->IsProxyMethod()) {
3791 // If this is a proxy method, visit its reference arguments.
3792 DCHECK(!m->IsStatic());
Roland Levillainfa854e42018-02-07 13:09:55 +00003793 DCHECK(!m->IsNative());
Roland Levillainad0777d2018-02-12 20:00:18 +00003794 std::vector<StackReference<mirror::Object>*> ref_addrs =
3795 GetProxyReferenceArguments(cur_quick_frame);
3796 for (StackReference<mirror::Object>* ref_addr : ref_addrs) {
3797 mirror::Object* ref = ref_addr->AsMirrorPtr();
3798 if (ref != nullptr) {
3799 mirror::Object* new_ref = ref;
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003800 visitor_(&new_ref, /* vreg= */ -1, this);
Roland Levillainad0777d2018-02-12 20:00:18 +00003801 if (ref != new_ref) {
3802 ref_addr->Assign(new_ref);
3803 }
Roland Levillainfa854e42018-02-07 13:09:55 +00003804 }
3805 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003806 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003807 }
3808
Andreas Gampe585da952016-12-02 14:52:29 -08003809 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3810 if (kPrecise) {
3811 VisitQuickFramePrecise();
3812 } else {
3813 VisitQuickFrameNonPrecise();
3814 }
3815 }
3816
3817 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3818 struct UndefinedVRegInfo {
3819 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3820 const CodeInfo& code_info ATTRIBUTE_UNUSED,
Andreas Gampe585da952016-12-02 14:52:29 -08003821 const StackMap& map ATTRIBUTE_UNUSED,
3822 RootVisitor& _visitor)
3823 : visitor(_visitor) {
3824 }
3825
3826 ALWAYS_INLINE
3827 void VisitStack(mirror::Object** ref,
3828 size_t stack_index ATTRIBUTE_UNUSED,
3829 const StackVisitor* stack_visitor)
3830 REQUIRES_SHARED(Locks::mutator_lock_) {
3831 visitor(ref, -1, stack_visitor);
3832 }
3833
3834 ALWAYS_INLINE
3835 void VisitRegister(mirror::Object** ref,
3836 size_t register_index ATTRIBUTE_UNUSED,
3837 const StackVisitor* stack_visitor)
3838 REQUIRES_SHARED(Locks::mutator_lock_) {
3839 visitor(ref, -1, stack_visitor);
3840 }
3841
3842 RootVisitor& visitor;
3843 };
3844 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3845 }
3846
3847 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3848 struct StackMapVRegInfo {
3849 StackMapVRegInfo(ArtMethod* method,
3850 const CodeInfo& _code_info,
Andreas Gampe585da952016-12-02 14:52:29 -08003851 const StackMap& map,
3852 RootVisitor& _visitor)
David Sehr0225f8e2018-01-31 08:52:24 +00003853 : number_of_dex_registers(method->DexInstructionData().RegistersSize()),
Andreas Gampe585da952016-12-02 14:52:29 -08003854 code_info(_code_info),
David Srbeckyfd89b072018-06-03 12:00:22 +01003855 dex_register_map(code_info.GetDexRegisterMapOf(map)),
Andreas Gampe585da952016-12-02 14:52:29 -08003856 visitor(_visitor) {
3857 }
3858
3859 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3860 // lookups for each location.
3861 void FindWithType(const size_t index,
3862 const DexRegisterLocation::Kind kind,
3863 mirror::Object** ref,
3864 const StackVisitor* stack_visitor)
3865 REQUIRES_SHARED(Locks::mutator_lock_) {
3866 bool found = false;
3867 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
David Srbeckye1402122018-06-13 18:20:45 +01003868 DexRegisterLocation location = dex_register_map[dex_reg];
Andreas Gampe585da952016-12-02 14:52:29 -08003869 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3870 visitor(ref, dex_reg, stack_visitor);
3871 found = true;
3872 }
3873 }
3874
3875 if (!found) {
3876 // If nothing found, report with -1.
3877 visitor(ref, -1, stack_visitor);
3878 }
3879 }
3880
3881 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3882 REQUIRES_SHARED(Locks::mutator_lock_) {
3883 const size_t stack_offset = stack_index * kFrameSlotSize;
3884 FindWithType(stack_offset,
3885 DexRegisterLocation::Kind::kInStack,
3886 ref,
3887 stack_visitor);
3888 }
3889
3890 void VisitRegister(mirror::Object** ref,
3891 size_t register_index,
3892 const StackVisitor* stack_visitor)
3893 REQUIRES_SHARED(Locks::mutator_lock_) {
3894 FindWithType(register_index,
3895 DexRegisterLocation::Kind::kInRegister,
3896 ref,
3897 stack_visitor);
3898 }
3899
3900 size_t number_of_dex_registers;
3901 const CodeInfo& code_info;
Andreas Gampe585da952016-12-02 14:52:29 -08003902 DexRegisterMap dex_register_map;
3903 RootVisitor& visitor;
3904 };
3905 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3906 }
3907
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003908 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003909 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003910};
3911
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003912class RootCallbackVisitor {
3913 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003914 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003915
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003916 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003917 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003918 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003919 }
3920
3921 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003922 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003923 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003924};
3925
Andreas Gampe585da952016-12-02 14:52:29 -08003926template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003927void Thread::VisitRoots(RootVisitor* visitor) {
Hans Boehm0882af22017-08-31 15:21:57 -07003928 const pid_t thread_id = GetThreadId();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003929 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003930 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003931 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003932 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003933 }
Alex Light848574c2017-09-25 16:59:39 -07003934 if (tlsPtr_.async_exception != nullptr) {
3935 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.async_exception),
3936 RootInfo(kRootNativeStack, thread_id));
3937 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003938 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
Ian Rogers55256cb2017-12-21 17:07:11 -08003939 tlsPtr_.jni_env->VisitJniLocalRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3940 tlsPtr_.jni_env->VisitMonitorRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003941 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003942 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003943 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003944 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003945 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003946 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003947 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003948 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003949 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3950 record != nullptr;
3951 record = record->GetLink()) {
3952 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3953 shadow_frame != nullptr;
3954 shadow_frame = shadow_frame->GetLink()) {
3955 mapper.VisitShadowFrame(shadow_frame);
3956 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003957 }
3958 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003959 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3960 record != nullptr;
3961 record = record->GetLink()) {
3962 if (record->IsReference()) {
3963 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003964 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003965 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003966 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3967 RootInfo(kRootThreadObject, thread_id));
3968 }
3969 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3970 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003971 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003972 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3973 record != nullptr;
3974 record = record->GetNext()) {
3975 mapper.VisitShadowFrame(record->GetShadowFrame());
3976 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003977 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003978 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3979 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003980 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003981 // Visit roots on this thread's stack
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003982 RuntimeContextType context;
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003983 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiera62b4532017-04-26 13:16:25 -07003984 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, &context, visitor_to_callback);
Andreas Gampe585da952016-12-02 14:52:29 -08003985 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07003986 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003987 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08003988 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07003989}
3990
Andreas Gampe585da952016-12-02 14:52:29 -08003991void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
3992 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003993 VisitRoots</* kPrecise= */ true>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003994 } else {
Andreas Gampe98ea9d92018-10-19 14:06:15 -07003995 VisitRoots</* kPrecise= */ false>(visitor);
Andreas Gampe585da952016-12-02 14:52:29 -08003996 }
3997}
3998
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003999class VerifyRootVisitor : public SingleRootVisitor {
4000 public:
4001 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Roland Levillainbbc6e7e2018-08-24 16:58:47 +01004002 override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07004003 VerifyObject(root);
4004 }
4005};
jeffhao25045522012-03-13 19:34:37 -07004006
Ian Rogers04d7aa92013-03-16 14:29:17 -07004007void Thread::VerifyStackImpl() {
Andreas Gamped4901292017-05-30 18:41:34 -07004008 if (Runtime::Current()->GetHeap()->IsObjectValidationEnabled()) {
4009 VerifyRootVisitor visitor;
4010 std::unique_ptr<Context> context(Context::Create());
4011 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
4012 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
4013 mapper.WalkStack();
4014 }
jeffhao25045522012-03-13 19:34:37 -07004015}
jeffhao25045522012-03-13 19:34:37 -07004016
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004017// Set the stack end to that to be used during a stack overflow
4018void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004019 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07004020 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004021 // However, we seem to have already extended to use the full stack.
4022 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07004023 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07004024 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07004025 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004026 }
4027
Ian Rogersdd7624d2014-03-14 17:43:00 -07004028 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07004029
4030 // Remove the stack overflow protection if is it set up.
4031 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
4032 if (implicit_stack_check) {
4033 if (!UnprotectStack()) {
4034 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
4035 }
4036 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004037}
4038
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004039void Thread::SetTlab(uint8_t* start, uint8_t* end, uint8_t* limit) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004040 DCHECK_LE(start, end);
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004041 DCHECK_LE(end, limit);
Ian Rogersdd7624d2014-03-14 17:43:00 -07004042 tlsPtr_.thread_local_start = start;
4043 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
4044 tlsPtr_.thread_local_end = end;
Mathieu Chartier6bc77742017-04-18 17:46:23 -07004045 tlsPtr_.thread_local_limit = limit;
Ian Rogersdd7624d2014-03-14 17:43:00 -07004046 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08004047}
4048
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004049bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004050 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004051 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07004052 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07004053 } else {
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 }
4056 return has_tlab;
4057}
4058
Elliott Hughes330304d2011-08-12 14:28:05 -07004059std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004060 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07004061 return os;
4062}
4063
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004064bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07004065 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4066 VLOG(threads) << "Protecting stack at " << pregion;
4067 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004068 if (fatal_on_error) {
4069 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
4070 "Reason: "
4071 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
4072 }
4073 return false;
Dave Allison648d7112014-07-25 16:15:27 -07004074 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07004075 return true;
Dave Allison648d7112014-07-25 16:15:27 -07004076}
4077
4078bool Thread::UnprotectStack() {
4079 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
4080 VLOG(threads) << "Unprotecting stack at " << pregion;
4081 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
4082}
4083
Sebastien Hertz597c4f02015-01-26 17:37:14 +01004084void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
4085 CHECK(Dbg::IsDebuggerActive());
4086 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
4087 CHECK(ssc != nullptr);
4088 tlsPtr_.single_step_control = ssc;
4089}
4090
4091void Thread::DeactivateSingleStepControl() {
4092 CHECK(Dbg::IsDebuggerActive());
4093 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
4094 SingleStepControl* ssc = GetSingleStepControl();
4095 tlsPtr_.single_step_control = nullptr;
4096 delete ssc;
4097}
Dave Allison648d7112014-07-25 16:15:27 -07004098
Sebastien Hertz1558b572015-02-25 15:05:59 +01004099void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
4100 CHECK(Dbg::IsDebuggerActive());
4101 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
4102 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
4103 CHECK(req != nullptr);
4104 tlsPtr_.debug_invoke_req = req;
4105}
4106
4107void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004108 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
4109 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004110 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004111 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004112 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004113}
4114
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004115void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
4116 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004117 tlsPtr_.method_verifier = verifier;
4118}
4119
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004120void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004121 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07004122 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07004123}
4124
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004125size_t Thread::NumberOfHeldMutexes() const {
4126 size_t count = 0;
4127 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07004128 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07004129 }
4130 return count;
4131}
4132
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004133void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
4134 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
4135 ClearException();
4136 ShadowFrame* shadow_frame =
4137 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08004138 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004139 bool from_code = false;
Mingyao Yang2ee17902017-08-30 11:37:08 -07004140 DeoptimizationMethodType method_type;
4141 PopDeoptimizationContext(result, &pending_exception, &from_code, &method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004142 SetTopOfStack(nullptr);
4143 SetTopOfShadowStack(shadow_frame);
4144
4145 // Restore the exception that was pending before deoptimization then interpret the
4146 // deoptimized frames.
4147 if (pending_exception != nullptr) {
4148 SetException(pending_exception);
4149 }
Mingyao Yang2ee17902017-08-30 11:37:08 -07004150 interpreter::EnterInterpreterFromDeoptimize(this,
4151 shadow_frame,
4152 result,
4153 from_code,
4154 method_type);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00004155}
4156
Alex Light848574c2017-09-25 16:59:39 -07004157void Thread::SetAsyncException(ObjPtr<mirror::Throwable> new_exception) {
4158 CHECK(new_exception != nullptr);
Alex Light7919db92017-11-29 09:00:55 -08004159 Runtime::Current()->SetAsyncExceptionsThrown();
Alex Light848574c2017-09-25 16:59:39 -07004160 if (kIsDebugBuild) {
4161 // Make sure we are in a checkpoint.
4162 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
4163 CHECK(this == Thread::Current() || GetSuspendCount() >= 1)
4164 << "It doesn't look like this was called in a checkpoint! this: "
4165 << this << " count: " << GetSuspendCount();
4166 }
4167 tlsPtr_.async_exception = new_exception.Ptr();
4168}
4169
4170bool Thread::ObserveAsyncException() {
4171 DCHECK(this == Thread::Current());
4172 if (tlsPtr_.async_exception != nullptr) {
4173 if (tlsPtr_.exception != nullptr) {
4174 LOG(WARNING) << "Overwriting pending exception with async exception. Pending exception is: "
4175 << tlsPtr_.exception->Dump();
4176 LOG(WARNING) << "Async exception is " << tlsPtr_.async_exception->Dump();
4177 }
4178 tlsPtr_.exception = tlsPtr_.async_exception;
4179 tlsPtr_.async_exception = nullptr;
4180 return true;
4181 } else {
4182 return IsExceptionPending();
4183 }
4184}
4185
Mathieu Chartier0795f232016-09-27 18:43:30 -07004186void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004187 CHECK(new_exception != nullptr);
4188 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07004189 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07004190}
4191
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08004192bool Thread::IsAotCompiler() {
4193 return Runtime::Current()->IsAotCompiler();
4194}
4195
Andreas Gampe202f85a2017-02-06 10:23:26 -08004196mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00004197 DCHECK(tlsPtr_.jpeer == nullptr);
4198 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08004199 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
4200 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
4201 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
4202 // mark/forward it here.
4203 peer = art::ReadBarrier::Mark(peer);
4204 }
4205 return peer;
4206}
4207
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004208void Thread::SetReadBarrierEntrypoints() {
4209 // Make sure entrypoints aren't null.
Andreas Gampe98ea9d92018-10-19 14:06:15 -07004210 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, /* is_active=*/ true);
Mathieu Chartier3768ade2017-05-02 14:04:39 -07004211}
4212
David Srbecky912f36c2018-09-08 12:22:58 +01004213void Thread::ClearAllInterpreterCaches() {
4214 static struct ClearInterpreterCacheClosure : Closure {
4215 virtual void Run(Thread* thread) {
4216 thread->GetInterpreterCache()->Clear(thread);
4217 }
4218 } closure;
4219 Runtime::Current()->GetThreadList()->RunCheckpoint(&closure);
4220}
4221
Elliott Hughes8daa0922011-09-11 13:46:25 -07004222} // namespace art