blob: d93eab10a027ad58974cf566af8732387090114e [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Carl Shapirob5573532011-07-12 18:22:59 -070016
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "thread.h"
Carl Shapirob5573532011-07-12 18:22:59 -070018
Ian Rogersb033c752011-07-20 12:22:35 -070019#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070020#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080021#include <sys/resource.h>
22#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070023
Carl Shapirob5573532011-07-12 18:22:59 -070024#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070025#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070026#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070027#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070028#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070029#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070030
Andreas Gampe46ee31b2016-12-14 10:11:49 -080031#include "android-base/stringprintf.h"
32
Ian Rogers166db042013-07-26 12:05:57 -070033#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070034#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070035#include "art_method-inl.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010036#include "base/bit_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070037#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080038#include "base/mutex.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080039#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070040#include "base/to_str.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080041#include "base/systrace.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080042#include "class_linker-inl.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070043#include "debugger.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070044#include "dex_file-inl.h"
David Sehr9323e6e2016-09-13 08:58:35 -070045#include "dex_file_annotations.h"
Ian Rogers7655f292013-07-29 11:07:13 -070046#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080047#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070048#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000049#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070050#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070051#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070052#include "gc/space/space-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070053#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070054#include "indirect_reference_table-inl.h"
Elliott Hughesc5f7c912011-08-18 14:00:42 -070055#include "jni_internal.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080056#include "mirror/class_loader.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070057#include "mirror/class-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "mirror/object_array-inl.h"
59#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070060#include "monitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070061#include "native_stack_dump.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070062#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010063#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070064#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070065#include "object_lock.h"
Sebastien Hertzfd3077e2014-04-23 10:32:43 +020066#include "quick_exception_handler.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010067#include "quick/quick_method_frame_info.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050068#include "reflection.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070069#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -080070#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070071#include "scoped_thread_state_change-inl.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070072#include "ScopedLocalRef.h"
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -070073#include "ScopedUtfChars.h"
Elliott Hughes68e76522011-10-05 13:22:16 -070074#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +010075#include "stack_map.h"
Elliott Hughes8daa0922011-09-11 13:46:25 -070076#include "thread_list.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070077#include "thread-inl.h"
Elliott Hughesa0957642011-09-02 14:27:33 -070078#include "utils.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -070079#include "verifier/method_verifier.h"
Mathieu Chartier4e305412014-02-19 10:54:44 -080080#include "verify_object-inl.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070081#include "well_known_classes.h"
buzbee1452bee2015-03-06 14:43:04 -080082#include "interpreter/interpreter.h"
Carl Shapirob5573532011-07-12 18:22:59 -070083
Yu Lieac44242015-06-29 10:50:03 +080084#if ART_USE_FUTEXES
85#include "linux/futex.h"
86#include "sys/syscall.h"
87#ifndef SYS_futex
88#define SYS_futex __NR_futex
89#endif
90#endif // ART_USE_FUTEXES
91
Carl Shapirob5573532011-07-12 18:22:59 -070092namespace art {
93
Andreas Gampe46ee31b2016-12-14 10:11:49 -080094using android::base::StringAppendV;
95using android::base::StringPrintf;
96
Mingyao Yangf711f2c2016-05-23 12:29:39 -070097extern "C" NO_RETURN void artDeoptimize(Thread* self);
98
Ian Rogers0878d652013-04-18 17:38:35 -070099bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700100pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800101ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700102const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100103bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100104Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100105
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700106static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700107
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700108// For implicit overflow checks we reserve an extra piece of memory at the bottom
109// of the stack (lowest memory). The higher portion of the memory
110// is protected against reads and the lower is available for use while
111// throwing the StackOverflow exception.
112constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
113
Elliott Hughes7dc51662012-05-16 14:48:43 -0700114static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
115
Ian Rogers5d76c432011-10-31 21:42:49 -0700116void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700117 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700118}
119
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700120static void UnimplementedEntryPoint() {
121 UNIMPLEMENTED(FATAL);
122}
123
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700124void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800125void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_marking);
126
127void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
128 CHECK(kUseReadBarrier);
129 tls32_.is_gc_marking = is_marking;
130 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800131 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800132}
Ian Rogers7655f292013-07-29 11:07:13 -0700133
Ian Rogers848871b2013-08-05 10:56:33 -0700134void Thread::InitTlsEntryPoints() {
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700135 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700136 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800137 uintptr_t* end = reinterpret_cast<uintptr_t*>(
138 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700139 for (uintptr_t* it = begin; it != end; ++it) {
140 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
141 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700142 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700143}
144
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800145void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
146 if (kUseReadBarrier && kRuntimeISA != kX86_64) {
147 // Allocation entrypoint switching is currently only implemented for X86_64.
148 is_marking = true;
149 }
150 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700151}
152
Sebastien Hertz07474662015-08-25 15:12:33 +0000153class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200154 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100155 DeoptimizationContextRecord(const JValue& ret_val,
156 bool is_reference,
157 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800158 ObjPtr<mirror::Throwable> pending_exception,
Sebastien Hertz07474662015-08-25 15:12:33 +0000159 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100160 : ret_val_(ret_val),
161 is_reference_(is_reference),
162 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800163 pending_exception_(pending_exception.Ptr()),
Sebastien Hertz07474662015-08-25 15:12:33 +0000164 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200165
166 JValue GetReturnValue() const { return ret_val_; }
167 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100168 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800169 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000170 DeoptimizationContextRecord* GetLink() const { return link_; }
171 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200172 DCHECK(is_reference_);
173 return ret_val_.GetGCRoot();
174 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000175 mirror::Object** GetPendingExceptionAsGCRoot() {
176 return reinterpret_cast<mirror::Object**>(&pending_exception_);
177 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200178
179 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000180 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200181 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200182
Sebastien Hertz07474662015-08-25 15:12:33 +0000183 // Indicates whether the returned value is a reference. If so, the GC will visit it.
184 const bool is_reference_;
185
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100186 // Whether the context was created from an explicit deoptimization in the code.
187 const bool from_code_;
188
Sebastien Hertz07474662015-08-25 15:12:33 +0000189 // The exception that was pending before deoptimization (or null if there was no pending
190 // exception).
191 mirror::Throwable* pending_exception_;
192
193 // A link to the previous DeoptimizationContextRecord.
194 DeoptimizationContextRecord* const link_;
195
196 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200197};
198
199class StackedShadowFrameRecord {
200 public:
201 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
202 StackedShadowFrameType type,
203 StackedShadowFrameRecord* link)
204 : shadow_frame_(shadow_frame),
205 type_(type),
206 link_(link) {}
207
208 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
209 StackedShadowFrameType GetType() const { return type_; }
210 StackedShadowFrameRecord* GetLink() const { return link_; }
211
212 private:
213 ShadowFrame* const shadow_frame_;
214 const StackedShadowFrameType type_;
215 StackedShadowFrameRecord* const link_;
216
217 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
218};
219
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100220void Thread::PushDeoptimizationContext(const JValue& return_value,
221 bool is_reference,
222 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800223 ObjPtr<mirror::Throwable> exception) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000224 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
225 return_value,
226 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100227 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000228 exception,
229 tlsPtr_.deoptimization_context_stack);
230 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700231}
232
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100233void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800234 ObjPtr<mirror::Throwable>* exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100235 bool* from_code) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000236 AssertHasDeoptimizationContext();
237 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
238 tlsPtr_.deoptimization_context_stack = record->GetLink();
239 result->SetJ(record->GetReturnValue().GetJ());
240 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100241 *from_code = record->GetFromCode();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700242 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000243}
244
245void Thread::AssertHasDeoptimizationContext() {
246 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
247 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800248}
249
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700250void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
251 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
252 sf, type, tlsPtr_.stacked_shadow_frame_record);
253 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800254}
255
Andreas Gampe639bdd12015-06-03 11:22:45 -0700256ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700257 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700258 if (must_be_present) {
259 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700260 } else {
261 if (record == nullptr || record->GetType() != type) {
262 return nullptr;
263 }
264 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700265 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
266 ShadowFrame* shadow_frame = record->GetShadowFrame();
267 delete record;
268 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700269}
270
Mingyao Yang99170c62015-07-06 11:10:37 -0700271class FrameIdToShadowFrame {
272 public:
273 static FrameIdToShadowFrame* Create(size_t frame_id,
274 ShadowFrame* shadow_frame,
275 FrameIdToShadowFrame* next,
276 size_t num_vregs) {
277 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
278 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
279 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
280 }
281
282 static void Delete(FrameIdToShadowFrame* f) {
283 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
284 delete[] memory;
285 }
286
287 size_t GetFrameId() const { return frame_id_; }
288 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
289 FrameIdToShadowFrame* GetNext() const { return next_; }
290 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
291 bool* GetUpdatedVRegFlags() {
292 return updated_vreg_flags_;
293 }
294
295 private:
296 FrameIdToShadowFrame(size_t frame_id,
297 ShadowFrame* shadow_frame,
298 FrameIdToShadowFrame* next)
299 : frame_id_(frame_id),
300 shadow_frame_(shadow_frame),
301 next_(next) {}
302
303 const size_t frame_id_;
304 ShadowFrame* const shadow_frame_;
305 FrameIdToShadowFrame* next_;
306 bool updated_vreg_flags_[0];
307
308 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
309};
310
311static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
312 size_t frame_id) {
313 FrameIdToShadowFrame* found = nullptr;
314 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
315 if (record->GetFrameId() == frame_id) {
316 if (kIsDebugBuild) {
317 // Sanity check we have at most one record for this frame.
318 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
319 found = record;
320 } else {
321 return record;
322 }
323 }
324 }
325 return found;
326}
327
328ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
329 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
330 tlsPtr_.frame_id_to_shadow_frame, frame_id);
331 if (record != nullptr) {
332 return record->GetShadowFrame();
333 }
334 return nullptr;
335}
336
337// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
338bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
339 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
340 tlsPtr_.frame_id_to_shadow_frame, frame_id);
341 CHECK(record != nullptr);
342 return record->GetUpdatedVRegFlags();
343}
344
345ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
346 uint32_t num_vregs,
347 ArtMethod* method,
348 uint32_t dex_pc) {
349 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
350 if (shadow_frame != nullptr) {
351 return shadow_frame;
352 }
David Sehr709b0702016-10-13 09:12:37 -0700353 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700354 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
355 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
356 shadow_frame,
357 tlsPtr_.frame_id_to_shadow_frame,
358 num_vregs);
359 for (uint32_t i = 0; i < num_vregs; i++) {
360 // Do this to clear all references for root visitors.
361 shadow_frame->SetVRegReference(i, nullptr);
362 // This flag will be changed to true if the debugger modifies the value.
363 record->GetUpdatedVRegFlags()[i] = false;
364 }
365 tlsPtr_.frame_id_to_shadow_frame = record;
366 return shadow_frame;
367}
368
369void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
370 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
371 if (head->GetFrameId() == frame_id) {
372 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
373 FrameIdToShadowFrame::Delete(head);
374 return;
375 }
376 FrameIdToShadowFrame* prev = head;
377 for (FrameIdToShadowFrame* record = head->GetNext();
378 record != nullptr;
379 prev = record, record = record->GetNext()) {
380 if (record->GetFrameId() == frame_id) {
381 prev->SetNext(record->GetNext());
382 FrameIdToShadowFrame::Delete(record);
383 return;
384 }
385 }
386 LOG(FATAL) << "No shadow frame for frame " << frame_id;
387 UNREACHABLE();
388}
389
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700390void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700391 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700392}
393
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700394void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700395 // One thread (us) survived the fork, but we have a new tid so we need to
396 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700397 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700398}
399
Brian Carlstrom78128a62011-09-15 17:21:19 -0700400void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700401 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700402 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800403 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700404 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800405 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700406 }
407 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700408 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
409 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800410 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700411 // Check that if we got here we cannot be shutting down (as shutdown should never have started
412 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700413 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700414 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
415 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
416 // the runtime in such a case. In case this ever changes, we need to make sure here to
417 // delete the tmp_jni_env, as we own it at this point.
418 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
419 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700420 Runtime::Current()->EndThreadBirth();
421 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700422 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700423 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800424 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800425
426 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700427 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700428 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700429 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
430 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800431 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100432
Andreas Gampe08883de2016-11-08 13:20:52 -0800433 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100434 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000435
Andreas Gampeac30fa22017-01-18 21:02:36 -0800436 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700437
438 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800439 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700440 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700441 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
442 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700443 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700444 // Detach and delete self.
445 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700446
Dave Allison0aded082013-11-07 13:15:11 -0800447 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700448}
449
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700450Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800451 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800452 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800453 Thread* result = reinterpret_cast<Thread*>(static_cast<uintptr_t>(f->GetLong(thread_peer)));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700454 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
455 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700456 if (kIsDebugBuild) {
457 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800458 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700459 Locks::thread_list_lock_->AssertHeld(soa.Self());
460 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700461 }
462 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800463}
464
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700465Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
466 jobject java_thread) {
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700467 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread).Ptr());
Elliott Hughes01158d72011-09-19 19:47:10 -0700468}
469
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700470static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700471 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700472 if (stack_size == 0) {
473 stack_size = Runtime::Current()->GetDefaultStackSize();
474 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700475
Brian Carlstrom6414a972012-04-14 14:20:04 -0700476 // Dalvik used the bionic pthread default stack size for native threads,
477 // so include that here to support apps that expect large native stacks.
478 stack_size += 1 * MB;
479
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700480 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
481 if (stack_size < PTHREAD_STACK_MIN) {
482 stack_size = PTHREAD_STACK_MIN;
483 }
484
Dave Allisonf9439142014-03-27 15:10:22 -0700485 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
486 // It's likely that callers are trying to ensure they have at least a certain amount of
487 // stack space, so we should add our reserved space on top of what they requested, rather
488 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700489 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700490 } else {
491 // If we are going to use implicit stack checks, allocate space for the protected
492 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000493 stack_size += Thread::kStackOverflowImplicitCheckSize +
494 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700495 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700496
497 // Some systems require the stack size to be a multiple of the system page size, so round up.
498 stack_size = RoundUp(stack_size, kPageSize);
499
500 return stack_size;
501}
502
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700503// Return the nearest page-aligned address below the current stack top.
504NO_INLINE
505static uint8_t* FindStackTop() {
506 return reinterpret_cast<uint8_t*>(
507 AlignDown(__builtin_frame_address(0), kPageSize));
508}
509
Dave Allisonf9439142014-03-27 15:10:22 -0700510// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700511// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700512ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700513void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700514 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700515 // Page containing current top of stack.
516 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700517
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700518 // Try to directly protect the stack.
519 VLOG(threads) << "installing stack protected region at " << std::hex <<
520 static_cast<void*>(pregion) << " to " <<
521 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
522 if (ProtectStack(/* fatal_on_error */ false)) {
523 // Tell the kernel that we won't be needing these pages any more.
524 // NB. madvise will probably write zeroes into the memory (on linux it does).
525 uint32_t unwanted_size = stack_top - pregion - kPageSize;
526 madvise(pregion, unwanted_size, MADV_DONTNEED);
527 return;
528 }
529
530 // There is a little complexity here that deserves a special mention. On some
531 // architectures, the stack is created using a VM_GROWSDOWN flag
532 // to prevent memory being allocated when it's not needed. This flag makes the
533 // kernel only allocate memory for the stack by growing down in memory. Because we
534 // want to put an mprotected region far away from that at the stack top, we need
535 // to make sure the pages for the stack are mapped in before we call mprotect.
536 //
537 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
538 // with a non-mapped stack (usually only the main thread).
539 //
540 // We map in the stack by reading every page from the stack bottom (highest address)
541 // to the stack top. (We then madvise this away.) This must be done by reading from the
542 // current stack pointer downwards. Any access more than a page below the current SP
543 // might cause a segv.
544 // TODO: This comment may be out of date. It seems possible to speed this up. As
545 // this is normally done once in the zygote on startup, ignore for now.
546 //
547 // AddressSanitizer does not like the part of this functions that reads every stack page.
548 // Looks a lot like an out-of-bounds access.
549
550 // (Defensively) first remove the protection on the protected region as will want to read
551 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700552 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000553
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700554 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
555 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000556
Dave Allison648d7112014-07-25 16:15:27 -0700557 // Read every page from the high address to the low.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700558 volatile uint8_t dont_optimize_this;
Roland Levillain48a7bae2016-03-21 14:09:54 +0000559 UNUSED(dont_optimize_this);
Ian Rogers13735952014-10-08 12:43:28 -0700560 for (uint8_t* p = stack_top; p >= pregion; p -= kPageSize) {
Dave Allison648d7112014-07-25 16:15:27 -0700561 dont_optimize_this = *p;
Dave Allison69dfe512014-07-11 17:11:58 +0000562 }
563
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700564 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700565 static_cast<void*>(pregion) << " to " <<
566 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
567
Dave Allison648d7112014-07-25 16:15:27 -0700568 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700569 ProtectStack(/* fatal_on_error */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700570
571 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000572 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700573 uint32_t unwanted_size = stack_top - pregion - kPageSize;
574 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700575}
576
Ian Rogers120f1c72012-09-28 17:17:10 -0700577void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800578 CHECK(java_peer != nullptr);
Ian Rogers120f1c72012-09-28 17:17:10 -0700579 Thread* self = static_cast<JNIEnvExt*>(env)->self;
Andreas Gampe56623832015-07-09 21:53:15 -0700580
581 if (VLOG_IS_ON(threads)) {
582 ScopedObjectAccess soa(env);
583
Andreas Gampe08883de2016-11-08 13:20:52 -0800584 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700585 ObjPtr<mirror::String> java_name =
586 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700587 std::string thread_name;
588 if (java_name != nullptr) {
589 thread_name = java_name->ToModifiedUtf8();
590 } else {
591 thread_name = "(Unnamed)";
592 }
593
594 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700595 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700596 }
597
Ian Rogers120f1c72012-09-28 17:17:10 -0700598 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700599
Ian Rogers120f1c72012-09-28 17:17:10 -0700600 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
601 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700602 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700603 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700604 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700605 thread_start_during_shutdown = true;
606 } else {
607 runtime->StartThreadBirth();
608 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700609 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700610 if (thread_start_during_shutdown) {
611 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
612 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
613 return;
614 }
615
616 Thread* child_thread = new Thread(is_daemon);
617 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700618 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700619 stack_size = FixStackSize(stack_size);
620
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -0700621 // Thread.start is synchronized, so we know that nativePeer is 0, and know that we're not racing to
Ian Rogers120f1c72012-09-28 17:17:10 -0700622 // assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800623 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
624 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700625
Andreas Gampe449357d2015-06-01 22:29:51 -0700626 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
627 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100628 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700629 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100630 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700631
Andreas Gampe449357d2015-06-01 22:29:51 -0700632 int pthread_create_result = 0;
633 if (child_jni_env_ext.get() != nullptr) {
634 pthread_t new_pthread;
635 pthread_attr_t attr;
636 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
637 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
638 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
639 "PTHREAD_CREATE_DETACHED");
640 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
641 pthread_create_result = pthread_create(&new_pthread,
642 &attr,
643 Thread::CreateCallback,
644 child_thread);
645 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
646
647 if (pthread_create_result == 0) {
648 // pthread_create started the new thread. The child is now responsible for managing the
649 // JNIEnvExt we created.
650 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
651 // between the threads.
652 child_jni_env_ext.release();
653 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700654 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700655 }
656
657 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
658 {
659 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
660 runtime->EndThreadBirth();
661 }
662 // Manually delete the global reference since Thread::Init will not have been run.
663 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
664 child_thread->tlsPtr_.jpeer = nullptr;
665 delete child_thread;
666 child_thread = nullptr;
667 // TODO: remove from thread group?
668 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
669 {
670 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100671 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700672 StringPrintf("pthread_create (%s stack) failed: %s",
673 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
674 ScopedObjectAccess soa(env);
675 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700676 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700677}
678
Andreas Gampe449357d2015-06-01 22:29:51 -0700679bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700680 // This function does all the initialization that must be run by the native thread it applies to.
681 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
682 // we can handshake with the corresponding native thread when it's ready.) Check this native
683 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800684 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800685
686 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
687 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
688 tlsPtr_.pthread_self = pthread_self();
689 CHECK(is_started_);
690
Elliott Hughesd8af1592012-04-16 20:40:15 -0700691 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800692 if (!InitStackHwm()) {
693 return false;
694 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700695 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700696 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800697 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700698 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700699 InitTid();
buzbee1452bee2015-03-06 14:43:04 -0800700 interpreter::InitInterpreterTls(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800701
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100702#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000703 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
704#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700705 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000706#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700707 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700708
Ian Rogersdd7624d2014-03-14 17:43:00 -0700709 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700710
Andreas Gampe449357d2015-06-01 22:29:51 -0700711 if (jni_env_ext != nullptr) {
712 DCHECK_EQ(jni_env_ext->vm, java_vm);
713 DCHECK_EQ(jni_env_ext->self, this);
714 tlsPtr_.jni_env = jni_env_ext;
715 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100716 std::string error_msg;
717 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700718 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100719 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700720 return false;
721 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700722 }
723
Ian Rogers120f1c72012-09-28 17:17:10 -0700724 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800725 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700726}
727
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800728template <typename PeerAction>
729Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700730 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800731 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700732 LOG(ERROR) << "Thread attaching to non-existent runtime: " << thread_name;
Dave Allison0aded082013-11-07 13:15:11 -0800733 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700734 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800735 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700736 {
Dave Allison0aded082013-11-07 13:15:11 -0800737 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700738 if (runtime->IsShuttingDownLocked()) {
Calin Juravlef39f0092016-04-28 12:59:33 +0100739 LOG(WARNING) << "Thread attaching while runtime is shutting down: " << thread_name;
Dave Allison0aded082013-11-07 13:15:11 -0800740 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700741 } else {
742 Runtime::Current()->StartThreadBirth();
743 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800744 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700745 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800746 if (!init_success) {
747 delete self;
748 return nullptr;
749 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700750 }
751 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700752
Jeff Hao848f70a2014-01-15 13:49:50 -0800753 self->InitStringEntryPoints();
754
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700755 CHECK_NE(self->GetState(), kRunnable);
756 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700757
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800758 // Run the action that is acting on the peer.
759 if (!peer_action(self)) {
760 runtime->GetThreadList()->Unregister(self);
761 // Unregister deletes self, no need to do this here.
762 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700763 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700764
Andreas Gampe56623832015-07-09 21:53:15 -0700765 if (VLOG_IS_ON(threads)) {
766 if (thread_name != nullptr) {
767 VLOG(threads) << "Attaching thread " << thread_name;
768 } else {
769 VLOG(threads) << "Attaching unnamed thread.";
770 }
771 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700772 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700773 }
774
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200775 {
776 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -0800777 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200778 }
779
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700780 return self;
781}
782
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800783Thread* Thread::Attach(const char* thread_name,
784 bool as_daemon,
785 jobject thread_group,
786 bool create_peer) {
787 auto create_peer_action = [&](Thread* self) {
788 // If we're the main thread, ClassLinker won't be created until after we're attached,
789 // so that thread needs a two-stage attach. Regular threads don't need this hack.
790 // In the compiler, all threads need this hack, because no-one's going to be getting
791 // a native peer!
792 if (create_peer) {
793 self->CreatePeer(thread_name, as_daemon, thread_group);
794 if (self->IsExceptionPending()) {
795 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log it.
796 {
797 ScopedObjectAccess soa(self);
798 LOG(ERROR) << "Exception creating thread peer:";
799 LOG(ERROR) << self->GetException()->Dump();
800 self->ClearException();
801 }
802 return false;
803 }
804 } else {
805 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
806 if (thread_name != nullptr) {
807 self->tlsPtr_.name->assign(thread_name);
808 ::art::SetThreadName(thread_name);
809 } else if (self->GetJniEnv()->check_jni) {
810 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
811 }
812 }
813 return true;
814 };
815 return Attach(thread_name, as_daemon, create_peer_action);
816}
817
818Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
819 auto set_peer_action = [&](Thread* self) {
820 // Install the given peer.
821 {
822 DCHECK(self == Thread::Current());
823 ScopedObjectAccess soa(self);
824 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
825 }
826 self->GetJniEnv()->SetLongField(thread_peer,
827 WellKnownClasses::java_lang_Thread_nativePeer,
828 reinterpret_cast<jlong>(self));
829 return true;
830 };
831 return Attach(thread_name, as_daemon, set_peer_action);
832}
833
Ian Rogers365c1022012-06-22 15:05:28 -0700834void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
835 Runtime* runtime = Runtime::Current();
836 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700837 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700838
Dave Allison0aded082013-11-07 13:15:11 -0800839 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -0700840 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -0700841 }
Elliott Hughes726079d2011-10-07 18:43:44 -0700842 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -0800843 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +0000844 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -0800845 CHECK(IsExceptionPending());
846 return;
847 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700848 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700849 jboolean thread_is_daemon = as_daemon;
850
Elliott Hugheseac76672012-05-24 21:56:51 -0700851 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -0800852 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700853 CHECK(IsExceptionPending());
854 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -0700855 }
Ian Rogerscfaa4552012-11-26 21:00:08 -0800856 {
857 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700858 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800859 }
Elliott Hugheseac76672012-05-24 21:56:51 -0700860 env->CallNonvirtualVoidMethod(peer.get(),
861 WellKnownClasses::java_lang_Thread,
862 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -0700863 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -0700864 if (IsExceptionPending()) {
865 return;
866 }
Elliott Hughesd369bb72011-09-12 14:41:14 -0700867
Ian Rogers120f1c72012-09-28 17:17:10 -0700868 Thread* self = this;
869 DCHECK_EQ(self, Thread::Current());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700870 env->SetLongField(peer.get(), WellKnownClasses::java_lang_Thread_nativePeer,
871 reinterpret_cast<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -0700872
873 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700874 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -0800875 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700876 if (peer_thread_name.Get() == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -0700877 // The Thread constructor should have set the Thread.name to a
878 // non-null value. However, because we can run without code
879 // available (in the compiler, in tests), we manually assign the
880 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100881 if (runtime->IsActiveTransaction()) {
882 InitPeer<true>(soa, thread_is_daemon, thread_group, thread_name.get(), thread_priority);
883 } else {
884 InitPeer<false>(soa, thread_is_daemon, thread_group, thread_name.get(), thread_priority);
885 }
Andreas Gampe08883de2016-11-08 13:20:52 -0800886 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -0700887 }
Elliott Hughes225f5a12012-06-11 11:23:48 -0700888 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700889 if (peer_thread_name.Get() != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -0800890 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -0700891 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700892}
893
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100894template<bool kTransactionActive>
895void Thread::InitPeer(ScopedObjectAccess& soa, jboolean thread_is_daemon, jobject thread_group,
896 jobject thread_name, jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800897 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Ian Rogersdd7624d2014-03-14 17:43:00 -0700898 SetBoolean<kTransactionActive>(tlsPtr_.opeer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -0800899 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Mathieu Chartier3398c782016-09-30 10:27:43 -0700900 SetObject<kTransactionActive>(tlsPtr_.opeer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -0800901 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Mathieu Chartier3398c782016-09-30 10:27:43 -0700902 SetObject<kTransactionActive>(tlsPtr_.opeer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -0800903 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Ian Rogersdd7624d2014-03-14 17:43:00 -0700904 SetInt<kTransactionActive>(tlsPtr_.opeer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100905}
906
Elliott Hughes899e7892012-01-24 14:57:32 -0800907void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700908 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -0800909 ::art::SetThreadName(name);
910 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
911}
912
Andreas Gampe9186ced2016-12-12 14:28:21 -0800913static void GetThreadStack(pthread_t thread,
914 void** stack_base,
915 size_t* stack_size,
916 size_t* guard_size) {
917#if defined(__APPLE__)
918 *stack_size = pthread_get_stacksize_np(thread);
919 void* stack_addr = pthread_get_stackaddr_np(thread);
920
921 // Check whether stack_addr is the base or end of the stack.
922 // (On Mac OS 10.7, it's the end.)
923 int stack_variable;
924 if (stack_addr > &stack_variable) {
925 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
926 } else {
927 *stack_base = stack_addr;
928 }
929
930 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
931 pthread_attr_t attributes;
932 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
933 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
934 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
935#else
936 pthread_attr_t attributes;
937 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
938 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
939 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
940 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
941
942#if defined(__GLIBC__)
943 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
944 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
945 // will be broken because we'll die long before we get close to 2GB.
946 bool is_main_thread = (::art::GetTid() == getpid());
947 if (is_main_thread) {
948 rlimit stack_limit;
949 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
950 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
951 }
952 if (stack_limit.rlim_cur == RLIM_INFINITY) {
953 size_t old_stack_size = *stack_size;
954
955 // Use the kernel default limit as our size, and adjust the base to match.
956 *stack_size = 8 * MB;
957 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
958
959 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
960 << " to " << PrettySize(*stack_size)
961 << " with base " << *stack_base;
962 }
963 }
964#endif
965
966#endif
967}
968
Ian Rogersf4d4da12014-11-11 16:10:33 -0800969bool Thread::InitStackHwm() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700970 void* read_stack_base;
971 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -0700972 size_t read_guard_size;
973 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -0700974
Ian Rogers13735952014-10-08 12:43:28 -0700975 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700976 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -0700977
Dave Allison648d7112014-07-25 16:15:27 -0700978 // The minimum stack size we can cope with is the overflow reserved bytes (typically
979 // 8K) + the protected region size (4K) + another page (4K). Typically this will
980 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
981 // between 8K and 12K.
982 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
983 + 4 * KB;
984 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -0800985 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700986 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
987 __LINE__,
988 ::android::base::ERROR,
989 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -0800990 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700991 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700992
Vladimir Markob8f2f632015-01-02 14:23:26 +0000993 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
994 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
995 read_stack_base,
996 PrettySize(read_stack_size).c_str(),
997 PrettySize(read_guard_size).c_str());
998
Ian Rogers932746a2011-09-22 18:57:50 -0700999 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001000
1001 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001002 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001003
1004 // Valgrind on arm doesn't give the right values here. Do not install the guard page, and
1005 // effectively disable stack overflow checks (we'll get segfaults, potentially) by setting
1006 // stack_begin to 0.
1007 const bool valgrind_on_arm =
1008 (kRuntimeISA == kArm || kRuntimeISA == kArm64) &&
1009 kMemoryToolIsValgrind &&
1010 RUNNING_ON_MEMORY_TOOL != 0;
1011 if (valgrind_on_arm) {
1012 tlsPtr_.stack_begin = nullptr;
1013 }
1014
Dave Allisonb090a182014-08-14 17:02:48 +00001015 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001016
1017 // Install the protected region if we are doing implicit overflow checks.
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001018 if (implicit_stack_check && !valgrind_on_arm) {
Dave Allison648d7112014-07-25 16:15:27 -07001019 // The thread might have protected region at the bottom. We need
1020 // to install our own region so we need to move the limits
1021 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001022
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001023 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1024 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1025 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001026
1027 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001028 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001029
1030 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001031 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001032
1033 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001034}
1035
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001036void Thread::ShortDump(std::ostream& os) const {
1037 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001038 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001039 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001040 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001041 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001042 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001043 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001044 << ",Thread*=" << this
1045 << ",peer=" << tlsPtr_.opeer
1046 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1047 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001048}
1049
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001050void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001051 DumpState(os);
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001052 DumpStack(os, dump_native_stack, backtrace_map);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001053}
1054
Andreas Gampe08883de2016-11-08 13:20:52 -08001055mirror::String* Thread::GetThreadName() const {
1056 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001057 if (tlsPtr_.opeer == nullptr) {
1058 return nullptr;
1059 }
1060 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1061 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001062}
1063
Elliott Hughesffb465f2012-03-01 18:46:05 -08001064void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001065 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001066}
1067
Jeff Hao57dac6e2013-08-15 16:36:24 -07001068uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001069#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001070 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001071 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001072 timespec now;
1073 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001074 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001075#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001076 UNIMPLEMENTED(WARNING);
1077 return -1;
1078#endif
1079}
1080
Ian Rogers01ae5802012-09-28 16:14:01 -07001081// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1082static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001083 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001084 Locks::thread_suspend_count_lock_->Unlock(self);
1085 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1086 Locks::mutator_lock_->SharedTryLock(self);
1087 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1088 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1089 }
1090 }
1091 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1092 Locks::thread_list_lock_->TryLock(self);
1093 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1094 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1095 }
1096 }
1097 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001098 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001099 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001100}
1101
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001102bool Thread::ModifySuspendCountInternal(Thread* self,
1103 int delta,
1104 AtomicInteger* suspend_barrier,
1105 bool for_debugger) {
Ian Rogers2966e132014-04-02 08:34:36 -07001106 if (kIsDebugBuild) {
1107 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
1108 << delta << " " << tls32_.debug_suspend_count << " " << this;
1109 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1110 Locks::thread_suspend_count_lock_->AssertHeld(self);
1111 if (this != self && !IsSuspended()) {
1112 Locks::thread_list_lock_->AssertHeld(self);
1113 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001114 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001115 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001116 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001117 return false;
1118 }
1119
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001120 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1121 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1122 // deadlock. b/31683379.
1123 return false;
1124 }
1125
Yu Lieac44242015-06-29 10:50:03 +08001126 uint16_t flags = kSuspendRequest;
1127 if (delta > 0 && suspend_barrier != nullptr) {
1128 uint32_t available_barrier = kMaxSuspendBarriers;
1129 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1130 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1131 available_barrier = i;
1132 break;
1133 }
1134 }
1135 if (available_barrier == kMaxSuspendBarriers) {
1136 // No barrier spaces available, we can't add another.
1137 return false;
1138 }
1139 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1140 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001141 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001142
Ian Rogersdd7624d2014-03-14 17:43:00 -07001143 tls32_.suspend_count += delta;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001144 if (for_debugger) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001145 tls32_.debug_suspend_count += delta;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001146 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001147
Ian Rogersdd7624d2014-03-14 17:43:00 -07001148 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001149 AtomicClearFlag(kSuspendRequest);
1150 } else {
Yu Lieac44242015-06-29 10:50:03 +08001151 // Two bits might be set simultaneously.
1152 tls32_.state_and_flags.as_atomic_int.FetchAndOrSequentiallyConsistent(flags);
Dave Allisonb373e092014-02-20 16:06:36 -08001153 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001154 }
Yu Lieac44242015-06-29 10:50:03 +08001155 return true;
1156}
1157
1158bool Thread::PassActiveSuspendBarriers(Thread* self) {
1159 // Grab the suspend_count lock and copy the current set of
1160 // barriers. Then clear the list and the flag. The ModifySuspendCount
1161 // function requires the lock so we prevent a race between setting
1162 // the kActiveSuspendBarrier flag and clearing it.
1163 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1164 {
1165 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1166 if (!ReadFlag(kActiveSuspendBarrier)) {
1167 // quick exit test: the barriers have already been claimed - this is
1168 // possible as there may be a race to claim and it doesn't matter
1169 // who wins.
1170 // All of the callers of this function (except the SuspendAllInternal)
1171 // will first test the kActiveSuspendBarrier flag without lock. Here
1172 // double-check whether the barrier has been passed with the
1173 // suspend_count lock.
1174 return false;
1175 }
1176
1177 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1178 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1179 tlsPtr_.active_suspend_barriers[i] = nullptr;
1180 }
1181 AtomicClearFlag(kActiveSuspendBarrier);
1182 }
1183
1184 uint32_t barrier_count = 0;
1185 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1186 AtomicInteger* pending_threads = pass_barriers[i];
1187 if (pending_threads != nullptr) {
1188 bool done = false;
1189 do {
1190 int32_t cur_val = pending_threads->LoadRelaxed();
1191 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1192 // Reduce value by 1.
1193 done = pending_threads->CompareExchangeWeakRelaxed(cur_val, cur_val - 1);
1194#if ART_USE_FUTEXES
1195 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
1196 futex(pending_threads->Address(), FUTEX_WAKE, -1, nullptr, nullptr, 0);
1197 }
1198#endif
1199 } while (!done);
1200 ++barrier_count;
1201 }
1202 }
1203 CHECK_GT(barrier_count, 0U);
1204 return true;
1205}
1206
1207void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1208 CHECK(ReadFlag(kActiveSuspendBarrier));
1209 bool clear_flag = true;
1210 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1211 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1212 if (ptr == target) {
1213 tlsPtr_.active_suspend_barriers[i] = nullptr;
1214 } else if (ptr != nullptr) {
1215 clear_flag = false;
1216 }
1217 }
1218 if (LIKELY(clear_flag)) {
1219 AtomicClearFlag(kActiveSuspendBarrier);
1220 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001221}
1222
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001223void Thread::RunCheckpointFunction() {
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001224 bool done = false;
1225 do {
1226 // Grab the suspend_count lock and copy the checkpoints one by one. When the last checkpoint is
1227 // copied, clear the list and the flag. The RequestCheckpoint function will also grab this lock
1228 // to prevent a race between setting the kCheckpointRequest flag and clearing it.
1229 Closure* checkpoint = nullptr;
1230 {
1231 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1232 if (tlsPtr_.checkpoint_function != nullptr) {
1233 checkpoint = tlsPtr_.checkpoint_function;
1234 if (!checkpoint_overflow_.empty()) {
1235 // Overflow list not empty, copy the first one out and continue.
1236 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1237 checkpoint_overflow_.pop_front();
1238 } else {
1239 // No overflow checkpoints, this means that we are on the last pending checkpoint.
1240 tlsPtr_.checkpoint_function = nullptr;
1241 AtomicClearFlag(kCheckpointRequest);
1242 done = true;
1243 }
1244 } else {
1245 LOG(FATAL) << "Checkpoint flag set without pending checkpoint";
1246 }
Dave Allison0aded082013-11-07 13:15:11 -08001247 }
Dave Allison0aded082013-11-07 13:15:11 -08001248
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001249 // Outside the lock, run the checkpoint functions that we collected.
1250 ScopedTrace trace("Run checkpoint function");
1251 DCHECK(checkpoint != nullptr);
1252 checkpoint->Run(this);
1253 } while (!done);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001254}
1255
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001256void Thread::RunEmptyCheckpoint() {
1257 DCHECK_EQ(Thread::Current(), this);
1258 AtomicClearFlag(kEmptyCheckpointRequest);
1259 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1260}
1261
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001262bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001263 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001264 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001265 if (old_state_and_flags.as_struct.state != kRunnable) {
1266 return false; // Fail, thread is suspended and so can't run a checkpoint.
1267 }
Dave Allison0aded082013-11-07 13:15:11 -08001268
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001269 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001270 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001271 union StateAndFlags new_state_and_flags;
1272 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001273 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001274 bool success = tls32_.state_and_flags.as_atomic_int.CompareExchangeStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001275 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001276 if (success) {
1277 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1278 if (tlsPtr_.checkpoint_function == nullptr) {
1279 tlsPtr_.checkpoint_function = function;
1280 } else {
1281 checkpoint_overflow_.push_back(function);
1282 }
Dave Allison0aded082013-11-07 13:15:11 -08001283 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001284 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001285 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001286 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001287}
1288
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001289bool Thread::RequestEmptyCheckpoint() {
1290 union StateAndFlags old_state_and_flags;
1291 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1292 if (old_state_and_flags.as_struct.state != kRunnable) {
1293 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1294 // heap access (eg. the read barrier).
1295 return false;
1296 }
1297
1298 // We must be runnable to request a checkpoint.
1299 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1300 union StateAndFlags new_state_and_flags;
1301 new_state_and_flags.as_int = old_state_and_flags.as_int;
1302 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
1303 bool success = tls32_.state_and_flags.as_atomic_int.CompareExchangeStrongSequentiallyConsistent(
1304 old_state_and_flags.as_int, new_state_and_flags.as_int);
1305 if (success) {
1306 TriggerSuspend();
1307 }
1308 return success;
1309}
1310
Andreas Gampee9f67122016-10-27 19:21:23 -07001311class BarrierClosure : public Closure {
1312 public:
1313 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1314
1315 void Run(Thread* self) OVERRIDE {
1316 wrapped_->Run(self);
1317 barrier_.Pass(self);
1318 }
1319
1320 void Wait(Thread* self) {
1321 barrier_.Increment(self, 1);
1322 }
1323
1324 private:
1325 Closure* wrapped_;
1326 Barrier barrier_;
1327};
1328
1329void Thread::RequestSynchronousCheckpoint(Closure* function) {
1330 if (this == Thread::Current()) {
1331 // Asked to run on this thread. Just run.
1332 function->Run(this);
1333 return;
1334 }
1335 Thread* self = Thread::Current();
1336
1337 // The current thread is not this thread.
1338
1339 for (;;) {
1340 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1341 // suspend-count lock for too long.
1342 if (GetState() == ThreadState::kRunnable) {
1343 BarrierClosure barrier_closure(function);
1344 bool installed = false;
1345 {
1346 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1347 installed = RequestCheckpoint(&barrier_closure);
1348 }
1349 if (installed) {
1350 barrier_closure.Wait(self);
1351 return;
1352 }
1353 // Fall-through.
1354 }
1355
1356 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1357 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1358 // certain situations.
1359 {
1360 MutexLock mu(self, *Locks::thread_list_lock_);
1361 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1362
1363 if (!ModifySuspendCount(self, +1, nullptr, false)) {
1364 // Just retry the loop.
1365 sched_yield();
1366 continue;
1367 }
1368 }
1369
1370 while (GetState() == ThreadState::kRunnable) {
1371 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1372 // moves us to suspended.
1373 sched_yield();
1374 }
1375
1376 function->Run(this);
1377
1378 {
1379 MutexLock mu(self, *Locks::thread_list_lock_);
1380 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1381
1382 DCHECK_NE(GetState(), ThreadState::kRunnable);
1383 CHECK(ModifySuspendCount(self, -1, nullptr, false));
1384 }
1385
1386 return; // We're done, break out of the loop.
1387 }
1388}
1389
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001390Closure* Thread::GetFlipFunction() {
1391 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1392 Closure* func;
1393 do {
1394 func = atomic_func->LoadRelaxed();
1395 if (func == nullptr) {
1396 return nullptr;
1397 }
1398 } while (!atomic_func->CompareExchangeWeakSequentiallyConsistent(func, nullptr));
1399 DCHECK(func != nullptr);
1400 return func;
1401}
1402
1403void Thread::SetFlipFunction(Closure* function) {
1404 CHECK(function != nullptr);
1405 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1406 atomic_func->StoreSequentiallyConsistent(function);
1407}
1408
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001409void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001410 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001411 VLOG(threads) << this << " self-suspending";
1412 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001413 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
1414 ScopedThreadSuspension(this, kSuspended);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001415 VLOG(threads) << this << " self-reviving";
1416}
1417
Andreas Gampe9186ced2016-12-12 14:28:21 -08001418static std::string GetSchedulerGroupName(pid_t tid) {
1419 // /proc/<pid>/cgroup looks like this:
1420 // 2:devices:/
1421 // 1:cpuacct,cpu:/
1422 // We want the third field from the line whose second field contains the "cpu" token.
1423 std::string cgroup_file;
1424 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1425 return "";
1426 }
1427 std::vector<std::string> cgroup_lines;
1428 Split(cgroup_file, '\n', &cgroup_lines);
1429 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1430 std::vector<std::string> cgroup_fields;
1431 Split(cgroup_lines[i], ':', &cgroup_fields);
1432 std::vector<std::string> cgroups;
1433 Split(cgroup_fields[1], ',', &cgroups);
1434 for (size_t j = 0; j < cgroups.size(); ++j) {
1435 if (cgroups[j] == "cpu") {
1436 return cgroup_fields[2].substr(1); // Skip the leading slash.
1437 }
1438 }
1439 }
1440 return "";
1441}
1442
1443
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001444void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001445 std::string group_name;
1446 int priority;
1447 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001448 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001449
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001450 // If flip_function is not null, it means we have run a checkpoint
1451 // before the thread wakes up to execute the flip function and the
1452 // thread roots haven't been forwarded. So the following access to
1453 // the roots (opeer or methods in the frames) would be bad. Run it
1454 // here. TODO: clean up.
1455 if (thread != nullptr) {
1456 ScopedObjectAccessUnchecked soa(self);
1457 Thread* this_thread = const_cast<Thread*>(thread);
1458 Closure* flip_func = this_thread->GetFlipFunction();
1459 if (flip_func != nullptr) {
1460 flip_func->Run(this_thread);
1461 }
1462 }
1463
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001464 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1465 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001466 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001467 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001468 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001469 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001470 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001471 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001472
Mathieu Chartier3398c782016-09-30 10:27:43 -07001473 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001474 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1475 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001476
Dave Allison0aded082013-11-07 13:15:11 -08001477 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001478 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001479 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001480 ObjPtr<mirror::String> group_name_string =
1481 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001482 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001483 }
1484 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001485 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001486 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001487
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001488 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001489 if (scheduler_group_name.empty()) {
1490 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001491 }
1492
Dave Allison0aded082013-11-07 13:15:11 -08001493 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001494 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001495 if (is_daemon) {
1496 os << " daemon";
1497 }
1498 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001499 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001500 << " " << thread->GetState();
1501 if (thread->IsStillStarting()) {
1502 os << " (still starting up)";
1503 }
1504 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001505 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001506 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001507 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001508 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001509 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001510
Dave Allison0aded082013-11-07 13:15:11 -08001511 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001512 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001513 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001514 << " sCount=" << thread->tls32_.suspend_count
1515 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001516 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001517 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001518 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1519 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001520
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001521 os << " | sysTid=" << tid
1522 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001523 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001524 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001525 int policy;
1526 sched_param sp;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001527 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1528 __FUNCTION__);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001529 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001530 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001531 }
1532 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001533
1534 // Grab the scheduler stats for this thread.
1535 std::string scheduler_stats;
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001536 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001537 scheduler_stats.resize(scheduler_stats.size() - 1); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001538 } else {
1539 scheduler_stats = "0 0 0";
1540 }
1541
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001542 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001543 int utime = 0;
1544 int stime = 0;
1545 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001546 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001547
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001548 os << " | state=" << native_thread_state
1549 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001550 << " utm=" << utime
1551 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001552 << " core=" << task_cpu
1553 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001554 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001555 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1556 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1557 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001558 // Dump the held mutexes.
1559 os << " | held mutexes=";
1560 for (size_t i = 0; i < kLockLevelCount; ++i) {
1561 if (i != kMonitorLock) {
1562 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1563 if (mutex != nullptr) {
1564 os << " \"" << mutex->GetName() << "\"";
1565 if (mutex->IsReaderWriterMutex()) {
1566 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Ian Rogersa9d8c4c2014-07-07 21:38:36 -07001567 if (rw_mutex->GetExclusiveOwnerTid() == static_cast<uint64_t>(tid)) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001568 os << "(exclusive held)";
1569 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001570 os << "(shared held)";
1571 }
1572 }
1573 }
1574 }
1575 }
1576 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001577 }
1578}
1579
1580void Thread::DumpState(std::ostream& os) const {
1581 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001582}
1583
Ian Rogers0399dde2012-06-06 17:09:28 -07001584struct StackDumpVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001585 StackDumpVisitor(std::ostream& os_in, Thread* thread_in, Context* context, bool can_allocate_in)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001586 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001587 : StackVisitor(thread_in, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
1588 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001589 can_allocate(can_allocate_in),
1590 last_method(nullptr),
1591 last_line_number(0),
1592 repetition_count(0),
1593 frame_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001594
Ian Rogersbdb03912011-09-14 00:55:44 -07001595 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001596 if (frame_count == 0) {
1597 os << " (no managed stack frames)\n";
1598 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001599 }
1600
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001601 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001602 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07001603 if (m->IsRuntimeMethod()) {
Elliott Hughes530fa002012-03-12 11:44:49 -07001604 return true;
Ian Rogers90865722011-09-19 11:11:44 -07001605 }
Andreas Gampe542451c2016-07-26 09:02:02 -07001606 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Ian Rogers28ad40d2011-10-27 15:19:26 -07001607 const int kMaxRepetition = 3;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08001608 ObjPtr<mirror::Class> c = m->GetDeclaringClass();
1609 ObjPtr<mirror::DexCache> dex_cache = c->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001610 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001611 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001612 const DexFile* dex_file = dex_cache->GetDexFile();
1613 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001614 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001615 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001616 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001617 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001618 if (repetition_count >= kMaxRepetition) {
1619 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1620 }
1621 repetition_count = 0;
1622 last_line_number = line_number;
1623 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001624 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001625 if (repetition_count < kMaxRepetition) {
David Sehr709b0702016-10-13 09:12:37 -07001626 os << " at " << m->PrettyMethod(false);
Ian Rogers28ad40d2011-10-27 15:19:26 -07001627 if (m->IsNative()) {
1628 os << "(Native method)";
1629 } else {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001630 const char* source_file(m->GetDeclaringClassSourceFile());
Dave Allison0aded082013-11-07 13:15:11 -08001631 os << "(" << (source_file != nullptr ? source_file : "unavailable")
Brian Carlstrom2e450bf2013-09-06 15:39:46 -07001632 << ":" << line_number << ")";
Ian Rogers28ad40d2011-10-27 15:19:26 -07001633 }
1634 os << "\n";
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001635 if (frame_count == 0) {
Sebastien Hertz26f72862015-09-15 09:52:07 +02001636 Monitor::DescribeWait(os, GetThread());
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001637 }
1638 if (can_allocate) {
Andreas Gampe956a5222014-08-16 13:41:10 -07001639 // Visit locks, but do not abort on errors. This would trigger a nested abort.
1640 Monitor::VisitLocks(this, DumpLockedObject, &os, false);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001641 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001642 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001643
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001644 ++frame_count;
Elliott Hughes530fa002012-03-12 11:44:49 -07001645 return true;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001646 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001647
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001648 static void DumpLockedObject(mirror::Object* o, void* context)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001649 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001650 std::ostream& os = *reinterpret_cast<std::ostream*>(context);
Ian Rogersd803bc72014-04-01 15:33:03 -07001651 os << " - locked ";
1652 if (o == nullptr) {
1653 os << "an unknown object";
1654 } else {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001655 if (kUseReadBarrier && Thread::Current()->GetIsGcMarking()) {
1656 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
1657 // may have not been flipped yet and "o" may be a from-space (stale) ref, in which case the
1658 // IdentityHashCode call below will crash. So explicitly mark/forward it here.
1659 o = ReadBarrier::Mark(o);
1660 }
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -07001661 if ((o->GetLockWord(false).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07001662 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
1663 // Getting the identity hashcode here would result in lock inflation and suspension of the
1664 // current thread, which isn't safe if this is the only runnable thread.
1665 os << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)", reinterpret_cast<intptr_t>(o),
David Sehr709b0702016-10-13 09:12:37 -07001666 o->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001667 } else {
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001668 // IdentityHashCode can cause thread suspension, which would invalidate o if it moved. So
1669 // we get the pretty type beofre we call IdentityHashCode.
David Sehr709b0702016-10-13 09:12:37 -07001670 const std::string pretty_type(o->PrettyTypeOf());
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001671 os << StringPrintf("<0x%08x> (a %s)", o->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001672 }
1673 }
1674 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001675 }
1676
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001677 std::ostream& os;
Ian Rogers0878d652013-04-18 17:38:35 -07001678 const bool can_allocate;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001679 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001680 int last_line_number;
1681 int repetition_count;
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001682 int frame_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001683};
1684
Ian Rogers33e95662013-05-20 20:29:14 -07001685static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001686 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07001687 ThreadState state = thread->GetState();
1688
1689 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
1690 if (state > kWaiting && state < kStarting) {
1691 return true;
1692 }
1693
1694 // In an Object.wait variant or Thread.sleep? That's not interesting.
1695 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
1696 return false;
1697 }
1698
Christopher Ferris2366f4e2014-09-19 17:23:59 -07001699 // Threads with no managed stack frames should be shown.
1700 const ManagedStack* managed_stack = thread->GetManagedStack();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001701 if (managed_stack == nullptr || (managed_stack->GetTopQuickFrame() == nullptr &&
1702 managed_stack->GetTopShadowFrame() == nullptr)) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07001703 return true;
1704 }
1705
Elliott Hughesaef701d2013-04-05 18:15:40 -07001706 // In some other native method? That's interesting.
1707 // We don't just check kNative because native methods will be in state kSuspended if they're
1708 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
1709 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07001710 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08001711 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07001712}
1713
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001714void Thread::DumpJavaStack(std::ostream& os) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001715 // If flip_function is not null, it means we have run a checkpoint
1716 // before the thread wakes up to execute the flip function and the
1717 // thread roots haven't been forwarded. So the following access to
1718 // the roots (locks or methods in the frames) would be bad. Run it
1719 // here. TODO: clean up.
1720 {
1721 Thread* this_thread = const_cast<Thread*>(this);
1722 Closure* flip_func = this_thread->GetFlipFunction();
1723 if (flip_func != nullptr) {
1724 flip_func->Run(this_thread);
1725 }
1726 }
1727
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001728 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
1729 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08001730 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
1731 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001732 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001733 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001734 bool have_exception = false;
1735 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001736 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001737 const_cast<Thread*>(this)->ClearException();
1738 have_exception = true;
1739 }
1740
Ian Rogers700a4022014-05-19 16:49:03 -07001741 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001742 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
1743 !tls32_.throwing_OutOfMemoryError);
1744 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001745
1746 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001747 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001748 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001749}
1750
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001751void Thread::DumpStack(std::ostream& os,
1752 bool dump_native_stack,
1753 BacktraceMap* backtrace_map) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07001754 // TODO: we call this code when dying but may not have suspended the thread ourself. The
1755 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
1756 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07001757 bool dump_for_abort = (gAborting > 0);
1758 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
1759 if (!kIsDebugBuild) {
1760 // We always want to dump the stack for an abort, however, there is no point dumping another
1761 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
1762 safe_to_dump = (safe_to_dump || dump_for_abort);
1763 }
1764 if (safe_to_dump) {
Ian Rogersf08e4732013-04-09 09:45:49 -07001765 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001766 if (dump_native_stack && (dump_for_abort || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07001767 DumpKernelStack(os, GetTid(), " kernel: ", false);
Nicolas Geoffray6bc43742015-10-12 18:11:10 +01001768 ArtMethod* method = GetCurrentMethod(nullptr, !dump_for_abort);
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001769 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07001770 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001771 DumpJavaStack(os);
Ian Rogersf08e4732013-04-09 09:45:49 -07001772 } else {
1773 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08001774 }
Elliott Hughese27955c2011-08-26 15:21:24 -07001775}
1776
Elliott Hughesbe759c62011-09-08 19:38:21 -07001777void Thread::ThreadExitCallback(void* arg) {
1778 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001779 if (self->tls32_.thread_exit_check_count == 0) {
1780 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
1781 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07001782 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01001783#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001784 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
1785#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07001786 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001787#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07001788 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07001789 } else {
1790 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
1791 }
Carl Shapirob5573532011-07-12 18:22:59 -07001792}
1793
Elliott Hughesbe759c62011-09-08 19:38:21 -07001794void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07001795 CHECK(!is_started_);
1796 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001797 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07001798 // MutexLock to keep annotalysis happy.
1799 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001800 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07001801 // return garbage since (is_started_ == true) and
1802 // Thread::pthread_key_self_ is not yet initialized.
1803 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08001804 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001805 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
1806 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001807 }
1808
Carl Shapirob5573532011-07-12 18:22:59 -07001809 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08001810 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
1811 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07001812
1813 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08001814 if (pthread_getspecific(pthread_key_self_) != nullptr) {
1815 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07001816 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001817}
Carl Shapirob5573532011-07-12 18:22:59 -07001818
Elliott Hughes038a8062011-09-18 14:12:41 -07001819void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07001820 Runtime* runtime = Runtime::Current();
1821 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07001822
Elliott Hughes01158d72011-09-19 19:47:10 -07001823 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001824 ScopedObjectAccess soa(Thread::Current());
Ian Rogers365c1022012-06-22 15:05:28 -07001825 Thread::Current()->CreatePeer("main", false, runtime->GetMainThreadGroup());
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001826 Thread::Current()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05001827
Elliott Hughesaf8d15a2012-05-29 09:12:18 -07001828 Runtime::Current()->GetClassLinker()->RunRootClinits();
Carl Shapirob5573532011-07-12 18:22:59 -07001829}
1830
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001831void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07001832 CHECK(is_started_);
1833 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07001834 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07001835 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08001836 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07001837 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08001838 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07001839 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001840}
1841
Calin Juravleccd56952016-12-15 17:57:38 +00001842Thread::Thread(bool daemon)
1843 : tls32_(daemon),
1844 wait_monitor_(nullptr),
1845 interrupted_(false),
1846 can_call_into_java_(true) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001847 wait_mutex_ = new Mutex("a thread wait mutex");
1848 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001849 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
1850 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
Dave Allison8ce6b902014-08-26 11:07:58 -07001851 tlsPtr_.nested_signal_state = static_cast<jmp_buf*>(malloc(sizeof(jmp_buf)));
Ian Rogersdd7624d2014-03-14 17:43:00 -07001852
Roland Levillain33d69032015-06-18 18:20:59 +01001853 static_assert((sizeof(Thread) % 4) == 0U,
1854 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001855 tls32_.state_and_flags.as_struct.flags = 0;
1856 tls32_.state_and_flags.as_struct.state = kNative;
1857 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07001858 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08001859 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07001860 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001861 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08001862 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1863 tlsPtr_.active_suspend_barriers[i] = nullptr;
1864 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001865 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001866 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001867 tls32_.is_transitioning_to_runnable = false;
Elliott Hughesdcc24742011-09-07 14:02:44 -07001868}
1869
Elliott Hughes7dc51662012-05-16 14:48:43 -07001870bool Thread::IsStillStarting() const {
1871 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08001872 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001873 // 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 -07001874 // assigned fairly early on, and needs to be.
1875 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
1876 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07001877 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
1878 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07001879}
1880
Andreas Gamped9efea62014-07-21 22:56:08 -07001881void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07001882 CHECK(IsExceptionPending()) << "Pending exception expected.";
1883}
1884
1885void Thread::AssertPendingOOMException() const {
1886 AssertPendingException();
1887 auto* e = GetException();
1888 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
1889 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07001890}
1891
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001892void Thread::AssertNoPendingException() const {
1893 if (UNLIKELY(IsExceptionPending())) {
1894 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08001895 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001896 }
1897}
1898
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08001899void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
1900 if (UNLIKELY(IsExceptionPending())) {
1901 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07001902 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08001903 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08001904 }
1905}
1906
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001907class MonitorExitVisitor : public SingleRootVisitor {
1908 public:
1909 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
1910
1911 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
1912 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
1913 OVERRIDE NO_THREAD_SAFETY_ANALYSIS {
1914 if (self_->HoldsLock(entered_monitor)) {
1915 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07001916 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001917 << " left locked by native thread "
1918 << *Thread::Current() << " which is detaching";
1919 entered_monitor->MonitorExit(self_);
1920 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001921 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001922
1923 private:
1924 Thread* const self_;
1925};
Elliott Hughes02b48d12011-09-07 17:15:51 -07001926
Elliott Hughesc0f09332012-03-26 13:27:06 -07001927void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07001928 Thread* self = this;
1929 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07001930
Ian Rogers68d8b422014-07-17 11:09:10 -07001931 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001932 {
1933 ScopedObjectAccess soa(self);
1934 MonitorExitVisitor visitor(self);
1935 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
1936 tlsPtr_.jni_env->monitors.VisitRoots(&visitor, RootInfo(kRootVMInternal));
1937 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001938 // Release locally held global references which releasing may require the mutator lock.
1939 if (tlsPtr_.jpeer != nullptr) {
1940 // If pthread_create fails we don't have a jni env here.
1941 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
1942 tlsPtr_.jpeer = nullptr;
1943 }
1944 if (tlsPtr_.class_loader_override != nullptr) {
1945 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
1946 tlsPtr_.class_loader_override = nullptr;
1947 }
1948 }
1949
Ian Rogersdd7624d2014-03-14 17:43:00 -07001950 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001951 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07001952 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08001953 HandleUncaughtExceptions(soa);
1954 RemoveFromThreadGroup(soa);
Elliott Hughes534da072012-03-27 15:17:42 -07001955
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07001956 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001957 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08001958 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001959 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001960 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08001961 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001962 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001963 }
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00001964 Runtime* runtime = Runtime::Current();
1965 if (runtime != nullptr) {
Andreas Gampeac30fa22017-01-18 21:02:36 -08001966 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00001967 }
1968
Elliott Hughes02b48d12011-09-07 17:15:51 -07001969
Ian Rogerscfaa4552012-11-26 21:00:08 -08001970 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
1971 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07001972 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08001973 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07001974 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08001975 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001976 StackHandleScope<1> hs(self);
1977 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07001978 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07001979 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07001980 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001981 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07001982 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001983
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08001984 {
1985 ScopedObjectAccess soa(self);
1986 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001987 if (kUseReadBarrier) {
1988 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
1989 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08001990 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07001991}
Elliott Hughes02b48d12011-09-07 17:15:51 -07001992
Elliott Hughesc0f09332012-03-26 13:27:06 -07001993Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07001994 CHECK(tlsPtr_.class_loader_override == nullptr);
1995 CHECK(tlsPtr_.jpeer == nullptr);
1996 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001997 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07001998 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001999 delete tlsPtr_.jni_env;
2000 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002001 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002002 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002003 CHECK(!ReadFlag(kCheckpointRequest));
2004 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002005 CHECK(tlsPtr_.checkpoint_function == nullptr);
2006 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002007 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002008 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002009
Sebastien Hertz07474662015-08-25 15:12:33 +00002010 // Make sure we processed all deoptimization requests.
2011 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002012 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2013 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002014
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002015 // We may be deleting a still born thread.
2016 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002017
2018 delete wait_cond_;
2019 delete wait_mutex_;
2020
Ian Rogersdd7624d2014-03-14 17:43:00 -07002021 if (tlsPtr_.long_jump_context != nullptr) {
2022 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002023 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002024
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002025 if (initialized) {
2026 CleanupCpu();
2027 }
2028
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002029 if (tlsPtr_.single_step_control != nullptr) {
2030 delete tlsPtr_.single_step_control;
2031 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002032 delete tlsPtr_.instrumentation_stack;
2033 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002034 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Dave Allison8ce6b902014-08-26 11:07:58 -07002035 free(tlsPtr_.nested_signal_state);
Elliott Hughesd8af1592012-04-16 20:40:15 -07002036
Ian Rogers68d8b422014-07-17 11:09:10 -07002037 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002038
Elliott Hughesd8af1592012-04-16 20:40:15 -07002039 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002040}
2041
Ian Rogerscfaa4552012-11-26 21:00:08 -08002042void Thread::HandleUncaughtExceptions(ScopedObjectAccess& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002043 if (!IsExceptionPending()) {
2044 return;
2045 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002046 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002047 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002048
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002049 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002050 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2051 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002052
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002053 // Call the Thread instance's dispatchUncaughtException(Throwable)
2054 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2055 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2056 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002057
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002058 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002059 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002060}
2061
Ian Rogerscfaa4552012-11-26 21:00:08 -08002062void Thread::RemoveFromThreadGroup(ScopedObjectAccess& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002063 // this.group.removeThread(this);
2064 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002065 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002066 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002067 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002068 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002069 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002070 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002071 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2072 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2073 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002074 }
2075}
2076
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002077bool Thread::HandleScopeContains(jobject obj) const {
2078 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002079 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002080 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002081 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002082 return true;
2083 }
2084 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002085 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2086 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002087}
2088
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002089void Thread::HandleScopeVisitRoots(RootVisitor* visitor, uint32_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002090 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2091 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002092 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2093 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002094 }
2095}
2096
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002097ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002098 if (obj == nullptr) {
2099 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002100 }
2101 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002102 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002103 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002104 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002105 // The "kinds" below are sorted by the frequency we expect to encounter them.
2106 if (kind == kLocal) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002107 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002108 // Local references do not need a read barrier.
2109 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002110 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002111 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002112 // Check if this is a local reference in the handle scope.
2113 if (LIKELY(HandleScopeContains(obj))) {
2114 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002115 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002116 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002117 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -07002118 tlsPtr_.jni_env->vm->JniAbortF(nullptr, "use of invalid jobject %p", obj);
2119 expect_null = true;
2120 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002121 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002122 } else if (kind == kGlobal) {
Mathieu Chartier30b5e272015-09-01 11:14:34 -07002123 result = tlsPtr_.jni_env->vm->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002124 } else {
2125 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers68d8b422014-07-17 11:09:10 -07002126 result = tlsPtr_.jni_env->vm->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002127 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002128 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002129 expect_null = true;
2130 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002131 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002132 }
2133
Ian Rogersc0542af2014-09-03 16:16:56 -07002134 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers68d8b422014-07-17 11:09:10 -07002135 tlsPtr_.jni_env->vm->JniAbortF(nullptr, "use of deleted %s %p",
2136 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002137 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002138 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002139}
2140
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002141bool Thread::IsJWeakCleared(jweak obj) const {
2142 CHECK(obj != nullptr);
2143 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002144 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002145 CHECK_EQ(kind, kWeakGlobal);
2146 return tlsPtr_.jni_env->vm->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
2147}
2148
Ian Rogers81d425b2012-09-27 16:03:43 -07002149// Implements java.lang.Thread.interrupted.
2150bool Thread::Interrupted() {
Ian Rogers50b35e22012-10-04 10:09:15 -07002151 MutexLock mu(Thread::Current(), *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002152 bool interrupted = IsInterruptedLocked();
2153 SetInterruptedLocked(false);
Ian Rogers81d425b2012-09-27 16:03:43 -07002154 return interrupted;
2155}
2156
2157// Implements java.lang.Thread.isInterrupted.
2158bool Thread::IsInterrupted() {
Ian Rogers50b35e22012-10-04 10:09:15 -07002159 MutexLock mu(Thread::Current(), *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002160 return IsInterruptedLocked();
Ian Rogers81d425b2012-09-27 16:03:43 -07002161}
2162
Ian Rogersdd7624d2014-03-14 17:43:00 -07002163void Thread::Interrupt(Thread* self) {
Ian Rogersc604d732012-10-14 16:09:54 -07002164 MutexLock mu(self, *wait_mutex_);
Ian Rogers81d425b2012-09-27 16:03:43 -07002165 if (interrupted_) {
2166 return;
2167 }
2168 interrupted_ = true;
Ian Rogersc604d732012-10-14 16:09:54 -07002169 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002170}
2171
2172void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002173 Thread* self = Thread::Current();
2174 MutexLock mu(self, *wait_mutex_);
2175 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002176}
2177
Ian Rogersc604d732012-10-14 16:09:54 -07002178void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002179 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002180 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002181 }
2182}
2183
Ian Rogers68d8b422014-07-17 11:09:10 -07002184void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2185 if (tlsPtr_.class_loader_override != nullptr) {
2186 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2187 }
2188 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2189}
2190
Ian Rogers0399dde2012-06-06 17:09:28 -07002191class CountStackDepthVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002192 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -07002193 explicit CountStackDepthVisitor(Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002194 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002195 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002196 depth_(0), skip_depth_(0), skipping_(true) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002197
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002198 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002199 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002200 // Note we also skip the frame if it doesn't have a method (namely the callee
2201 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002202 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002203 if (skipping_ && !m->IsRuntimeMethod() &&
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002204 !mirror::Throwable::GetJavaLangThrowable()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002205 skipping_ = false;
2206 }
2207 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002208 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002209 ++depth_;
2210 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002211 } else {
2212 ++skip_depth_;
2213 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002214 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002215 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002216
2217 int GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002218 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002219 }
2220
Elliott Hughes29f27422011-09-18 16:02:18 -07002221 int GetSkipDepth() const {
2222 return skip_depth_;
2223 }
2224
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002225 private:
Ian Rogersaaa20802011-09-11 21:47:37 -07002226 uint32_t depth_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002227 uint32_t skip_depth_;
2228 bool skipping_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002229
2230 DISALLOW_COPY_AND_ASSIGN(CountStackDepthVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002231};
2232
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002233template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002234class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002235 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002236 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002237 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2238 self_(self),
2239 skip_depth_(skip_depth),
2240 count_(0),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002241 trace_(nullptr),
2242 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002243
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002244 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002245 // Allocate method trace as an object array where the first element is a pointer array that
2246 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2247 // class of the ArtMethod pointers.
2248 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2249 StackHandleScope<1> hs(self_);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002250 ObjPtr<mirror::Class> array_class = class_linker->GetClassRoot(ClassLinker::kObjectArrayClass);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002251 // The first element is the methods and dex pc array, the other elements are declaring classes
2252 // for the methods to ensure classes in the stack trace don't get unloaded.
2253 Handle<mirror::ObjectArray<mirror::Object>> trace(
2254 hs.NewHandle(
2255 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
2256 if (trace.Get() == nullptr) {
2257 // Acquire uninterruptible_ in all paths.
2258 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002259 self_->AssertPendingOOMException();
2260 return false;
2261 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002262 ObjPtr<mirror::PointerArray> methods_and_pcs =
2263 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002264 const char* last_no_suspend_cause =
2265 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2266 if (methods_and_pcs == nullptr) {
2267 self_->AssertPendingOOMException();
2268 return false;
2269 }
2270 trace->Set(0, methods_and_pcs);
2271 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002272 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002273 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002274 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002275 }
2276
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002277 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2278 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002279 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002280
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002281 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002282 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002283 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002284 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002285 if (skip_depth_ > 0) {
2286 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002287 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002288 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002289 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002290 if (m->IsRuntimeMethod()) {
2291 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002292 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002293 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002294 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, m, pointer_size_);
2295 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2296 trace_methods_and_pcs->GetLength() / 2 + count_,
2297 m->IsProxyMethod() ? DexFile::kDexNoIndex : GetDexPc(),
2298 pointer_size_);
2299 // Save the declaring class of the method to ensure that the declaring classes of the methods
2300 // do not get unloaded while the stack trace is live.
2301 trace_->Set(count_ + 1, m->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002302 ++count_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002303 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002304 }
2305
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002306 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
2307 return ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(trace_->Get(0)));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002308 }
2309
2310 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002311 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002312 }
2313
2314 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002315 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002316 // How many more frames to skip.
2317 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002318 // Current position down stack trace.
Ian Rogersaaa20802011-09-11 21:47:37 -07002319 uint32_t count_;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002320 // An object array where the first element is a pointer array that contains the ArtMethod
2321 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2322 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2323 // the i'th frame.
2324 mirror::ObjectArray<mirror::Object>* trace_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002325 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002326 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002327
2328 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002329};
2330
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002331template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002332jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002333 // Compute depth of stack
Ian Rogers7a22fa62013-01-23 12:16:16 -08002334 CountStackDepthVisitor count_visitor(const_cast<Thread*>(this));
Ian Rogers0399dde2012-06-06 17:09:28 -07002335 count_visitor.WalkStack();
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002336 int32_t depth = count_visitor.GetDepth();
Elliott Hughes29f27422011-09-18 16:02:18 -07002337 int32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002338
Ian Rogers1f539342012-10-03 21:09:42 -07002339 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002340 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2341 const_cast<Thread*>(this),
2342 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002343 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002344 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002345 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002346 build_trace_visitor.WalkStack();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002347 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002348 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002349 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002350 // Second half of trace_methods is dex PCs.
2351 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2352 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002353 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2354 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002355 }
2356 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002357 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002358}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002359template jobject Thread::CreateInternalStackTrace<false>(
2360 const ScopedObjectAccessAlreadyRunnable& soa) const;
2361template jobject Thread::CreateInternalStackTrace<true>(
2362 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002363
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002364bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002365 CountStackDepthVisitor count_visitor(const_cast<Thread*>(this));
2366 count_visitor.WalkStack();
2367 return count_visitor.GetDepth() == exception->GetStackDepth();
2368}
2369
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002370jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002371 const ScopedObjectAccessAlreadyRunnable& soa,
2372 jobject internal,
2373 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002374 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002375 // Decode the internal stack trace into the depth, method trace and PC trace.
2376 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002377 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002378 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002379
Mathieu Chartier910e8272015-09-30 09:24:22 -07002380 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002381
Elliott Hughes01158d72011-09-19 19:47:10 -07002382 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002383
Dave Allison0aded082013-11-07 13:15:11 -08002384 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002385 // Reuse the array we were given.
2386 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002387 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002388 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002389 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002390 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002391 } else {
2392 // Create java_trace array and place in local reference table
Mathieu Chartier530825b2013-09-25 17:56:49 -07002393 mirror::ObjectArray<mirror::StackTraceElement>* java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002394 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002395 if (java_traces == nullptr) {
2396 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002397 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002398 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002399 }
2400
Dave Allison0aded082013-11-07 13:15:11 -08002401 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002402 *stack_depth = depth;
2403 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002404
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002405 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002406 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002407 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002408 // Methods and dex PC trace is element 0.
2409 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002410 ObjPtr<mirror::PointerArray> const method_trace =
2411 ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(decoded_traces->Get(0)));
Ian Rogersaaa20802011-09-11 21:47:37 -07002412 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002413 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002414 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002415 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Jeff Hao228d6b82013-12-03 15:00:05 -08002416 int32_t line_number;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002417 StackHandleScope<3> hs(soa.Self());
2418 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2419 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
Jeff Hao228d6b82013-12-03 15:00:05 -08002420 if (method->IsProxyMethod()) {
2421 line_number = -1;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002422 class_name_object.Assign(method->GetDeclaringClass()->GetName());
Jeff Hao228d6b82013-12-03 15:00:05 -08002423 // source_name_object intentionally left null for proxy methods
2424 } else {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002425 line_number = method->GetLineNumFromDexPC(dex_pc);
Jeff Hao228d6b82013-12-03 15:00:05 -08002426 // Allocate element, potentially triggering GC
2427 // TODO: reuse class_name_object via Class::name_?
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002428 const char* descriptor = method->GetDeclaringClassDescriptor();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002429 CHECK(descriptor != nullptr);
Jeff Hao228d6b82013-12-03 15:00:05 -08002430 std::string class_name(PrettyDescriptor(descriptor));
Mathieu Chartiere401d142015-04-22 13:56:20 -07002431 class_name_object.Assign(
2432 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002433 if (class_name_object.Get() == nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002434 soa.Self()->AssertPendingOOMException();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002435 return nullptr;
Jeff Hao228d6b82013-12-03 15:00:05 -08002436 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002437 const char* source_file = method->GetDeclaringClassSourceFile();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002438 if (source_file != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002439 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2440 if (source_name_object.Get() == nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002441 soa.Self()->AssertPendingOOMException();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002442 return nullptr;
2443 }
Jeff Hao228d6b82013-12-03 15:00:05 -08002444 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -07002445 }
Andreas Gampe542451c2016-07-26 09:02:02 -07002446 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
Dave Allison0aded082013-11-07 13:15:11 -08002447 CHECK(method_name != nullptr);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002448 Handle<mirror::String> method_name_object(
2449 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2450 if (method_name_object.Get() == nullptr) {
Dave Allison0aded082013-11-07 13:15:11 -08002451 return nullptr;
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08002452 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002453 ObjPtr<mirror::StackTraceElement> obj =mirror::StackTraceElement::Alloc(soa.Self(),
2454 class_name_object,
2455 method_name_object,
2456 source_name_object,
2457 line_number);
Dave Allison0aded082013-11-07 13:15:11 -08002458 if (obj == nullptr) {
2459 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002460 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002461 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002462 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002463 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002464 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002465}
2466
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002467void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002468 va_list args;
2469 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002470 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002471 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07002472}
2473
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002474void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002475 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07002476 std::string msg;
2477 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002478 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07002479}
Elliott Hughes37f7a402011-08-22 18:56:01 -07002480
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002481void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002482 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002483 // Callers should either clear or call ThrowNewWrappedException.
2484 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002485 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07002486}
2487
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002488static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002489 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002490 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002491 return method != nullptr
2492 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002493 : nullptr;
2494}
2495
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002496void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002497 const char* msg) {
2498 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07002499 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002500 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002501 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002502 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08002503 ClearException();
2504 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002505 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002506 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002507 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002508 if (UNLIKELY(exception_class.Get() == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07002509 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08002510 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07002511 return;
2512 }
Ian Rogers62d6c772013-02-27 08:32:07 -08002513
Ian Rogers7b078e82014-09-10 14:44:24 -07002514 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
2515 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002516 DCHECK(IsExceptionPending());
2517 return;
2518 }
2519 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002520 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07002521 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08002522
Mathieu Chartier590fee92013-09-13 13:46:47 -07002523 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002524 if (exception.Get() == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002525 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryError());
Mathieu Chartier590fee92013-09-13 13:46:47 -07002526 return;
2527 }
2528
Ian Rogers62d6c772013-02-27 08:32:07 -08002529 // Choose an appropriate constructor and set up the arguments.
2530 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07002531 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002532 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002533 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07002534 msg_string.reset(
2535 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08002536 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002537 CHECK(IsExceptionPending()); // OOME.
2538 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08002539 }
Dave Allison0aded082013-11-07 13:15:11 -08002540 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002541 signature = "(Ljava/lang/String;)V";
2542 } else {
2543 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
2544 }
2545 } else {
Dave Allison0aded082013-11-07 13:15:11 -08002546 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002547 signature = "()V";
2548 } else {
2549 signature = "(Ljava/lang/Throwable;)V";
2550 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08002551 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002552 ArtMethod* exception_init_method =
2553 exception_class->FindDeclaredDirectMethod("<init>", signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08002554
Dave Allison0aded082013-11-07 13:15:11 -08002555 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08002556 << PrettyDescriptor(exception_class_descriptor);
2557
2558 if (UNLIKELY(!runtime->IsStarted())) {
2559 // Something is trying to throw an exception without a started runtime, which is the common
2560 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
2561 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08002562 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002563 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08002564 }
Dave Allison0aded082013-11-07 13:15:11 -08002565 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002566 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08002567 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07002568 ScopedLocalRef<jobject> trace(GetJniEnv(),
2569 Runtime::Current()->IsActiveTransaction()
2570 ? CreateInternalStackTrace<true>(soa)
2571 : CreateInternalStackTrace<false>(soa));
2572 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002573 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07002574 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002575 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08002576 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07002577 jvalue jv_args[2];
2578 size_t i = 0;
2579
Dave Allison0aded082013-11-07 13:15:11 -08002580 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07002581 jv_args[i].l = msg_string.get();
2582 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08002583 }
Dave Allison0aded082013-11-07 13:15:11 -08002584 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07002585 jv_args[i].l = cause.get();
2586 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08002587 }
Jeff Hao39b6c242015-05-19 20:30:23 -07002588 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08002589 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08002590 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002591 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08002592 }
Elliott Hughes30646832011-10-13 16:59:46 -07002593 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002594}
2595
Elliott Hughes2ced6a52011-10-16 18:44:48 -07002596void Thread::ThrowOutOfMemoryError(const char* msg) {
Andreas Gampee4301ff2015-02-17 19:25:29 -08002597 LOG(WARNING) << StringPrintf("Throwing OutOfMemoryError \"%s\"%s",
Ian Rogersdd7624d2014-03-14 17:43:00 -07002598 msg, (tls32_.throwing_OutOfMemoryError ? " (recursive case)" : ""));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002599 if (!tls32_.throwing_OutOfMemoryError) {
2600 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002601 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002602 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07002603 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002604 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002605 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryError());
Elliott Hughes418dfe72011-10-06 18:56:27 -07002606 }
Elliott Hughes79082e32011-08-25 12:07:32 -07002607}
2608
Elliott Hughes498508c2011-10-17 14:58:22 -07002609Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002610 return Thread::Current();
2611}
2612
2613void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002614 std::ostringstream ss;
2615 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08002616 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002617 // log to stderr for debugging command line processes
2618 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002619#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002620 // log to logcat for debugging frameworks processes
2621 LOG(INFO) << str;
2622#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002623}
2624
Ian Rogersdd7624d2014-03-14 17:43:00 -07002625// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07002626template
2627void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
2628template
2629void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07002630
Andreas Gampe542451c2016-07-26 09:02:02 -07002631template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07002632void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
2633#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07002634 if (offset == (x).Uint32Value()) { \
2635 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07002636 return; \
2637 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002638 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
2639 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
2640 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
2641 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
2642 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
2643 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
2644 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
2645 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
2646 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07002647 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002648 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07002649 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07002650#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07002651
Ian Rogersdd7624d2014-03-14 17:43:00 -07002652#define JNI_ENTRY_POINT_INFO(x) \
2653 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
2654 os << #x; \
2655 return; \
2656 }
2657 JNI_ENTRY_POINT_INFO(pDlsymLookup)
2658#undef JNI_ENTRY_POINT_INFO
2659
Ian Rogersdd7624d2014-03-14 17:43:00 -07002660#define QUICK_ENTRY_POINT_INFO(x) \
2661 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
2662 os << #x; \
2663 return; \
2664 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002665 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002666 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
2667 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00002668 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Jeff Hao848f70a2014-01-15 13:49:50 -08002669 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
2670 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
2671 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002672 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08002673 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002674 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
2675 QUICK_ENTRY_POINT_INFO(pInitializeTypeAndVerifyAccess)
2676 QUICK_ENTRY_POINT_INFO(pInitializeType)
2677 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07002678 QUICK_ENTRY_POINT_INFO(pSet8Instance)
2679 QUICK_ENTRY_POINT_INFO(pSet8Static)
2680 QUICK_ENTRY_POINT_INFO(pSet16Instance)
2681 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002682 QUICK_ENTRY_POINT_INFO(pSet32Instance)
2683 QUICK_ENTRY_POINT_INFO(pSet32Static)
2684 QUICK_ENTRY_POINT_INFO(pSet64Instance)
2685 QUICK_ENTRY_POINT_INFO(pSet64Static)
2686 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
2687 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07002688 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
2689 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
2690 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
2691 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
2692 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
2693 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
2694 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
2695 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002696 QUICK_ENTRY_POINT_INFO(pGet32Instance)
2697 QUICK_ENTRY_POINT_INFO(pGet32Static)
2698 QUICK_ENTRY_POINT_INFO(pGet64Instance)
2699 QUICK_ENTRY_POINT_INFO(pGet64Static)
2700 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
2701 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002702 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002703 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
2704 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
2705 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
2706 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
2707 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
2708 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
2709 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
2710 QUICK_ENTRY_POINT_INFO(pLockObject)
2711 QUICK_ENTRY_POINT_INFO(pUnlockObject)
2712 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
2713 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
2714 QUICK_ENTRY_POINT_INFO(pCmplDouble)
2715 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04002716 QUICK_ENTRY_POINT_INFO(pCos)
2717 QUICK_ENTRY_POINT_INFO(pSin)
2718 QUICK_ENTRY_POINT_INFO(pAcos)
2719 QUICK_ENTRY_POINT_INFO(pAsin)
2720 QUICK_ENTRY_POINT_INFO(pAtan)
2721 QUICK_ENTRY_POINT_INFO(pAtan2)
2722 QUICK_ENTRY_POINT_INFO(pCbrt)
2723 QUICK_ENTRY_POINT_INFO(pCosh)
2724 QUICK_ENTRY_POINT_INFO(pExp)
2725 QUICK_ENTRY_POINT_INFO(pExpm1)
2726 QUICK_ENTRY_POINT_INFO(pHypot)
2727 QUICK_ENTRY_POINT_INFO(pLog)
2728 QUICK_ENTRY_POINT_INFO(pLog10)
2729 QUICK_ENTRY_POINT_INFO(pNextAfter)
2730 QUICK_ENTRY_POINT_INFO(pSinh)
2731 QUICK_ENTRY_POINT_INFO(pTan)
2732 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002733 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002734 QUICK_ENTRY_POINT_INFO(pL2d)
2735 QUICK_ENTRY_POINT_INFO(pFmodf)
2736 QUICK_ENTRY_POINT_INFO(pL2f)
2737 QUICK_ENTRY_POINT_INFO(pD2iz)
2738 QUICK_ENTRY_POINT_INFO(pF2iz)
2739 QUICK_ENTRY_POINT_INFO(pIdivmod)
2740 QUICK_ENTRY_POINT_INFO(pD2l)
2741 QUICK_ENTRY_POINT_INFO(pF2l)
2742 QUICK_ENTRY_POINT_INFO(pLdiv)
2743 QUICK_ENTRY_POINT_INFO(pLmod)
2744 QUICK_ENTRY_POINT_INFO(pLmul)
2745 QUICK_ENTRY_POINT_INFO(pShlLong)
2746 QUICK_ENTRY_POINT_INFO(pShrLong)
2747 QUICK_ENTRY_POINT_INFO(pUshrLong)
2748 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002749 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
2750 QUICK_ENTRY_POINT_INFO(pMemcpy)
2751 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
2752 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
2753 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
2754 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
2755 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
2756 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
2757 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
2758 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00002759 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002760 QUICK_ENTRY_POINT_INFO(pTestSuspend)
2761 QUICK_ENTRY_POINT_INFO(pDeliverException)
2762 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
2763 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002764 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
2765 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07002766 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07002767 QUICK_ENTRY_POINT_INFO(pA64Load)
2768 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08002769 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
2770 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
2771 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
2772 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
2773 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
2774 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
2775 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
2776 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
2777 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
2778 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
2779 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
2780 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
2781 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
2782 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
2783 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
2784 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07002785 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01002786 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
2787 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
2788 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
2789 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
2790 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
2791 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
2792 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
2793 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
2794 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
2795 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
2796 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
2797 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
2798 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
2799 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
2800 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
2801 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
2802 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
2803 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
2804 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
2805 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
2806 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
2807 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
2808 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
2809 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
2810 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
2811 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
2812 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
2813 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
2814 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
2815 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07002816 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00002817 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07002818
2819 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
2820 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002821#undef QUICK_ENTRY_POINT_INFO
2822
Elliott Hughes98e20172012-04-24 15:38:13 -07002823 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07002824}
2825
jeffhao94d6df42012-11-26 16:02:12 -08002826void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08002827 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002828 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08002829 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002830 if (exception == GetDeoptimizationException()) {
2831 artDeoptimize(this);
2832 UNREACHABLE();
2833 }
2834
2835 // This is a real exception: let the instrumentation know about it.
2836 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
2837 if (instrumentation->HasExceptionCaughtListeners() &&
2838 IsExceptionThrownByCurrentMethod(exception)) {
2839 // Instrumentation may cause GC so keep the exception object safe.
2840 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002841 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
2842 instrumentation->ExceptionCaughtEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002843 }
2844 // Does instrumentation need to deoptimize the stack?
2845 // Note: we do this *after* reporting the exception to instrumentation in case it
2846 // now requires deoptimization. It may happen if a debugger is attached and requests
2847 // new events (single-step, breakpoint, ...) when the exception is reported.
2848 if (Dbg::IsForcedInterpreterNeededForException(this)) {
2849 NthCallerVisitor visitor(this, 0, false);
2850 visitor.WalkStack();
2851 if (Runtime::Current()->IsDeoptimizeable(visitor.caller_pc)) {
Sebastien Hertz520633b2015-09-08 17:03:36 +02002852 // Save the exception into the deoptimization context so it can be restored
2853 // before entering the interpreter.
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01002854 PushDeoptimizationContext(
2855 JValue(), /*is_reference */ false, /* from_code */ false, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002856 artDeoptimize(this);
2857 UNREACHABLE();
Sebastien Hertz520633b2015-09-08 17:03:36 +02002858 }
2859 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002860
Ian Rogers28ad40d2011-10-27 15:19:26 -07002861 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08002862 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07002863 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002864 QuickExceptionHandler exception_handler(this, false);
2865 exception_handler.FindCatch(exception);
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02002866 exception_handler.UpdateInstrumentationStack();
2867 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07002868}
2869
Ian Rogersbdb03912011-09-14 00:55:44 -07002870Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002871 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08002872 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07002873 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07002874 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002875 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08002876 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07002877 }
Ian Rogersbdb03912011-09-14 00:55:44 -07002878 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07002879}
2880
Andreas Gampe4a8c3fa2014-07-16 22:20:31 -07002881// Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
2882// so we don't abort in a special situation (thinlocked monitor) when dumping the Java stack.
Ian Rogerse0dcd462014-03-08 15:21:04 -08002883struct CurrentMethodVisitor FINAL : public StackVisitor {
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002884 CurrentMethodVisitor(Thread* thread, Context* context, bool abort_on_error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002885 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002886 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2887 this_object_(nullptr),
2888 method_(nullptr),
2889 dex_pc_(0),
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002890 abort_on_error_(abort_on_error) {}
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002891 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002892 ArtMethod* m = GetMethod();
Ian Rogers62d6c772013-02-27 08:32:07 -08002893 if (m->IsRuntimeMethod()) {
2894 // Continue if this is a runtime method.
2895 return true;
Ian Rogers0399dde2012-06-06 17:09:28 -07002896 }
Dave Allison0aded082013-11-07 13:15:11 -08002897 if (context_ != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002898 this_object_ = GetThisObject();
2899 }
2900 method_ = m;
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002901 dex_pc_ = GetDexPc(abort_on_error_);
Ian Rogers62d6c772013-02-27 08:32:07 -08002902 return false;
2903 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002904 ObjPtr<mirror::Object> this_object_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002905 ArtMethod* method_;
Ian Rogers62d6c772013-02-27 08:32:07 -08002906 uint32_t dex_pc_;
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002907 const bool abort_on_error_;
Ian Rogers62d6c772013-02-27 08:32:07 -08002908};
Ian Rogers0399dde2012-06-06 17:09:28 -07002909
Mathieu Chartiere401d142015-04-22 13:56:20 -07002910ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc, bool abort_on_error) const {
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002911 CurrentMethodVisitor visitor(const_cast<Thread*>(this), nullptr, abort_on_error);
Ian Rogers0399dde2012-06-06 17:09:28 -07002912 visitor.WalkStack(false);
Dave Allison0aded082013-11-07 13:15:11 -08002913 if (dex_pc != nullptr) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002914 *dex_pc = visitor.dex_pc_;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07002915 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002916 return visitor.method_;
jeffhao33dc7712011-11-09 17:54:24 -08002917}
2918
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002919bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
2920 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07002921}
2922
Ian Rogers40e3bac2012-11-20 00:09:14 -08002923// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08002924template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07002925class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07002926 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002927 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002928 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002929 // We are visiting the references in compiled frames, so we do not need
2930 // to know the inlined frames.
2931 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
2932 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07002933
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002934 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07002935 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07002936 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02002937 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07002938 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002939 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08002940 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02002941 VisitShadowFrame(shadow_frame);
2942 } else {
2943 VisitQuickFrame();
2944 }
2945 return true;
2946 }
2947
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002948 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002949 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002950 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07002951 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02002952 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002953 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
2954 // handle scope for JNI or References for interpreter.
2955 for (size_t reg = 0; reg < num_regs; ++reg) {
2956 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
2957 if (ref != nullptr) {
2958 mirror::Object* new_ref = ref;
2959 visitor_(&new_ref, reg, this);
2960 if (new_ref != ref) {
2961 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08002962 }
2963 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02002964 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07002965 // Mark lock count map required for structured locking checks.
2966 shadow_frame->GetLockCountData().VisitMonitors(visitor_, -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02002967 }
2968
2969 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002970 // 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 -07002971 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
2972 // the threads do not all hold the heap bitmap lock for parallel GC.
2973 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002974 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002975 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002976 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002977 // klass can be null for runtime methods.
2978 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002979 if (kVerifyImageObjectsMarked) {
2980 gc::Heap* const heap = Runtime::Current()->GetHeap();
2981 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
2982 /*fail_ok*/true);
2983 if (space != nullptr && space->IsImageSpace()) {
2984 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002985 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002986 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002987 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002988 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002989 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002990 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002991 }
2992 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002993 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
2994 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
2995 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002996 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002997 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07002998 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
2999 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003000 }
3001 }
3002 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003003 mirror::Object* new_ref = klass.Ptr();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003004 visitor_(&new_ref, -1, this);
3005 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003006 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003007 }
3008 }
3009 }
3010
Andreas Gampe585da952016-12-02 14:52:29 -08003011 template <typename T>
3012 ALWAYS_INLINE
3013 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003014 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003015 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003016 ArtMethod* m = *cur_quick_frame;
3017 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003018
Sebastien Hertz714f1752014-04-28 15:03:08 +02003019 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003020 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003021 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003022 DCHECK(method_header->IsOptimized());
3023 auto* vreg_base = reinterpret_cast<StackReference<mirror::Object>*>(
3024 reinterpret_cast<uintptr_t>(cur_quick_frame));
3025 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
3026 CodeInfo code_info = method_header->GetOptimizedCodeInfo();
3027 CodeInfoEncoding encoding = code_info.ExtractEncoding();
3028 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset, encoding);
3029 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003030
3031 T vreg_info(m, code_info, encoding, map, visitor_);
3032
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003033 // Visit stack entries that hold pointers.
3034 size_t number_of_bits = map.GetNumberOfStackMaskBits(encoding.stack_map_encoding);
3035 for (size_t i = 0; i < number_of_bits; ++i) {
3036 if (map.GetStackMaskBit(encoding.stack_map_encoding, i)) {
3037 auto* ref_addr = vreg_base + i;
3038 mirror::Object* ref = ref_addr->AsMirrorPtr();
3039 if (ref != nullptr) {
3040 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003041 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003042 if (ref != new_ref) {
3043 ref_addr->Assign(new_ref);
Nicolas Geoffray39468442014-09-02 15:17:15 +01003044 }
3045 }
3046 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003047 }
3048 // Visit callee-save registers that hold pointers.
3049 uint32_t register_mask = map.GetRegisterMask(encoding.stack_map_encoding);
3050 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3051 if (register_mask & (1 << i)) {
3052 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003053 if (kIsDebugBuild && ref_addr == nullptr) {
3054 std::string thread_name;
3055 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003056 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003057 DescribeStack(GetThread());
3058 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3059 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3060 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003061 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003062 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003063 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003064 }
3065 }
3066 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003067 }
3068
Andreas Gampe585da952016-12-02 14:52:29 -08003069 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3070 if (kPrecise) {
3071 VisitQuickFramePrecise();
3072 } else {
3073 VisitQuickFrameNonPrecise();
3074 }
3075 }
3076
3077 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3078 struct UndefinedVRegInfo {
3079 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3080 const CodeInfo& code_info ATTRIBUTE_UNUSED,
3081 const CodeInfoEncoding& encoding ATTRIBUTE_UNUSED,
3082 const StackMap& map ATTRIBUTE_UNUSED,
3083 RootVisitor& _visitor)
3084 : visitor(_visitor) {
3085 }
3086
3087 ALWAYS_INLINE
3088 void VisitStack(mirror::Object** ref,
3089 size_t stack_index ATTRIBUTE_UNUSED,
3090 const StackVisitor* stack_visitor)
3091 REQUIRES_SHARED(Locks::mutator_lock_) {
3092 visitor(ref, -1, stack_visitor);
3093 }
3094
3095 ALWAYS_INLINE
3096 void VisitRegister(mirror::Object** ref,
3097 size_t register_index ATTRIBUTE_UNUSED,
3098 const StackVisitor* stack_visitor)
3099 REQUIRES_SHARED(Locks::mutator_lock_) {
3100 visitor(ref, -1, stack_visitor);
3101 }
3102
3103 RootVisitor& visitor;
3104 };
3105 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3106 }
3107
3108 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3109 struct StackMapVRegInfo {
3110 StackMapVRegInfo(ArtMethod* method,
3111 const CodeInfo& _code_info,
3112 const CodeInfoEncoding& _encoding,
3113 const StackMap& map,
3114 RootVisitor& _visitor)
3115 : number_of_dex_registers(method->GetCodeItem()->registers_size_),
3116 code_info(_code_info),
3117 encoding(_encoding),
3118 dex_register_map(code_info.GetDexRegisterMapOf(map,
3119 encoding,
3120 number_of_dex_registers)),
3121 visitor(_visitor) {
3122 }
3123
3124 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3125 // lookups for each location.
3126 void FindWithType(const size_t index,
3127 const DexRegisterLocation::Kind kind,
3128 mirror::Object** ref,
3129 const StackVisitor* stack_visitor)
3130 REQUIRES_SHARED(Locks::mutator_lock_) {
3131 bool found = false;
3132 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
3133 DexRegisterLocation location = dex_register_map.GetDexRegisterLocation(
3134 dex_reg, number_of_dex_registers, code_info, encoding);
3135 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3136 visitor(ref, dex_reg, stack_visitor);
3137 found = true;
3138 }
3139 }
3140
3141 if (!found) {
3142 // If nothing found, report with -1.
3143 visitor(ref, -1, stack_visitor);
3144 }
3145 }
3146
3147 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3148 REQUIRES_SHARED(Locks::mutator_lock_) {
3149 const size_t stack_offset = stack_index * kFrameSlotSize;
3150 FindWithType(stack_offset,
3151 DexRegisterLocation::Kind::kInStack,
3152 ref,
3153 stack_visitor);
3154 }
3155
3156 void VisitRegister(mirror::Object** ref,
3157 size_t register_index,
3158 const StackVisitor* stack_visitor)
3159 REQUIRES_SHARED(Locks::mutator_lock_) {
3160 FindWithType(register_index,
3161 DexRegisterLocation::Kind::kInRegister,
3162 ref,
3163 stack_visitor);
3164 }
3165
3166 size_t number_of_dex_registers;
3167 const CodeInfo& code_info;
3168 const CodeInfoEncoding& encoding;
3169 DexRegisterMap dex_register_map;
3170 RootVisitor& visitor;
3171 };
3172 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3173 }
3174
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003175 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003176 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003177};
3178
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003179class RootCallbackVisitor {
3180 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003181 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003182
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003183 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003184 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003185 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003186 }
3187
3188 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003189 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003190 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003191};
3192
Andreas Gampe585da952016-12-02 14:52:29 -08003193template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003194void Thread::VisitRoots(RootVisitor* visitor) {
3195 const uint32_t thread_id = GetThreadId();
3196 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003197 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003198 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003199 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003200 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003201 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
3202 tlsPtr_.jni_env->locals.VisitRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3203 tlsPtr_.jni_env->monitors.VisitRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
3204 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003205 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003206 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003207 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003208 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003209 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003210 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003211 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003212 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3213 record != nullptr;
3214 record = record->GetLink()) {
3215 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3216 shadow_frame != nullptr;
3217 shadow_frame = shadow_frame->GetLink()) {
3218 mapper.VisitShadowFrame(shadow_frame);
3219 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003220 }
3221 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003222 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3223 record != nullptr;
3224 record = record->GetLink()) {
3225 if (record->IsReference()) {
3226 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003227 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003228 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003229 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3230 RootInfo(kRootThreadObject, thread_id));
3231 }
3232 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3233 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003234 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003235 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3236 record != nullptr;
3237 record = record->GetNext()) {
3238 mapper.VisitShadowFrame(record->GetShadowFrame());
3239 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003240 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003241 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3242 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003243 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003244 // Visit roots on this thread's stack
Ian Rogers0399dde2012-06-06 17:09:28 -07003245 Context* context = GetLongJumpContext();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003246 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003247 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, context, visitor_to_callback);
3248 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Ian Rogers0399dde2012-06-06 17:09:28 -07003249 ReleaseLongJumpContext(context);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07003250 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003251 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08003252 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07003253}
3254
Andreas Gampe585da952016-12-02 14:52:29 -08003255void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
3256 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
3257 VisitRoots<true>(visitor);
3258 } else {
3259 VisitRoots<false>(visitor);
3260 }
3261}
3262
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003263class VerifyRootVisitor : public SingleRootVisitor {
3264 public:
3265 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003266 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003267 VerifyObject(root);
3268 }
3269};
jeffhao25045522012-03-13 19:34:37 -07003270
Ian Rogers04d7aa92013-03-16 14:29:17 -07003271void Thread::VerifyStackImpl() {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003272 VerifyRootVisitor visitor;
Ian Rogers700a4022014-05-19 16:49:03 -07003273 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003274 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
3275 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
Ian Rogers0399dde2012-06-06 17:09:28 -07003276 mapper.WalkStack();
jeffhao25045522012-03-13 19:34:37 -07003277}
jeffhao25045522012-03-13 19:34:37 -07003278
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003279// Set the stack end to that to be used during a stack overflow
3280void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003281 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07003282 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003283 // However, we seem to have already extended to use the full stack.
3284 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07003285 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003286 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003287 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003288 }
3289
Ian Rogersdd7624d2014-03-14 17:43:00 -07003290 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07003291
3292 // Remove the stack overflow protection if is it set up.
3293 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
3294 if (implicit_stack_check) {
3295 if (!UnprotectStack()) {
3296 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
3297 }
3298 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003299}
3300
Ian Rogers13735952014-10-08 12:43:28 -07003301void Thread::SetTlab(uint8_t* start, uint8_t* end) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08003302 DCHECK_LE(start, end);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003303 tlsPtr_.thread_local_start = start;
3304 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
3305 tlsPtr_.thread_local_end = end;
3306 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08003307}
3308
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003309bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003310 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003311 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003312 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003313 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003314 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003315 }
3316 return has_tlab;
3317}
3318
Elliott Hughes330304d2011-08-12 14:28:05 -07003319std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003320 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07003321 return os;
3322}
3323
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003324bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07003325 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
3326 VLOG(threads) << "Protecting stack at " << pregion;
3327 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003328 if (fatal_on_error) {
3329 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
3330 "Reason: "
3331 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
3332 }
3333 return false;
Dave Allison648d7112014-07-25 16:15:27 -07003334 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003335 return true;
Dave Allison648d7112014-07-25 16:15:27 -07003336}
3337
3338bool Thread::UnprotectStack() {
3339 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
3340 VLOG(threads) << "Unprotecting stack at " << pregion;
3341 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
3342}
3343
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003344void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
3345 CHECK(Dbg::IsDebuggerActive());
3346 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
3347 CHECK(ssc != nullptr);
3348 tlsPtr_.single_step_control = ssc;
3349}
3350
3351void Thread::DeactivateSingleStepControl() {
3352 CHECK(Dbg::IsDebuggerActive());
3353 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
3354 SingleStepControl* ssc = GetSingleStepControl();
3355 tlsPtr_.single_step_control = nullptr;
3356 delete ssc;
3357}
Dave Allison648d7112014-07-25 16:15:27 -07003358
Sebastien Hertz1558b572015-02-25 15:05:59 +01003359void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
3360 CHECK(Dbg::IsDebuggerActive());
3361 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
3362 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
3363 CHECK(req != nullptr);
3364 tlsPtr_.debug_invoke_req = req;
3365}
3366
3367void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003368 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
3369 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003370 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003371 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003372 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003373}
3374
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003375void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
3376 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003377 tlsPtr_.method_verifier = verifier;
3378}
3379
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003380void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003381 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003382 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003383}
3384
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07003385size_t Thread::NumberOfHeldMutexes() const {
3386 size_t count = 0;
3387 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07003388 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07003389 }
3390 return count;
3391}
3392
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003393void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
3394 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
3395 ClearException();
3396 ShadowFrame* shadow_frame =
3397 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003398 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003399 bool from_code = false;
3400 PopDeoptimizationContext(result, &pending_exception, &from_code);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003401 SetTopOfStack(nullptr);
3402 SetTopOfShadowStack(shadow_frame);
3403
3404 // Restore the exception that was pending before deoptimization then interpret the
3405 // deoptimized frames.
3406 if (pending_exception != nullptr) {
3407 SetException(pending_exception);
3408 }
3409 interpreter::EnterInterpreterFromDeoptimize(this, shadow_frame, from_code, result);
3410}
3411
Mathieu Chartier0795f232016-09-27 18:43:30 -07003412void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07003413 CHECK(new_exception != nullptr);
3414 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07003415 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07003416}
3417
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08003418bool Thread::IsAotCompiler() {
3419 return Runtime::Current()->IsAotCompiler();
3420}
3421
Elliott Hughes8daa0922011-09-11 13:46:25 -07003422} // namespace art