blob: 008c3882292cf45fa55328afa38772f8e981fbac [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Carl Shapirob5573532011-07-12 18:22:59 -070016
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "thread.h"
Carl Shapirob5573532011-07-12 18:22:59 -070018
Brian Carlstrom640a1042017-03-20 15:03:42 -070019#if !defined(__APPLE__)
20#include <sched.h>
21#endif
22
Ian Rogersb033c752011-07-20 12:22:35 -070023#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070024#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080025#include <sys/resource.h>
26#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070027
Carl Shapirob5573532011-07-12 18:22:59 -070028#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070029#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070030#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070031#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070032#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070033#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070034
Andreas Gampe46ee31b2016-12-14 10:11:49 -080035#include "android-base/stringprintf.h"
36
Ian Rogers166db042013-07-26 12:05:57 -070037#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070038#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070039#include "art_method-inl.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010040#include "base/bit_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070041#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080042#include "base/mutex.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080043#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070044#include "base/to_str.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080045#include "base/systrace.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080046#include "class_linker-inl.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070047#include "debugger.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070048#include "dex_file-inl.h"
David Sehr9323e6e2016-09-13 08:58:35 -070049#include "dex_file_annotations.h"
Ian Rogers7655f292013-07-29 11:07:13 -070050#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080051#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070052#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000053#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070054#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070055#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070056#include "gc/space/space-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070057#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070058#include "indirect_reference_table-inl.h"
Elliott Hughesc5f7c912011-08-18 14:00:42 -070059#include "jni_internal.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080060#include "mirror/class_loader.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070061#include "mirror/class-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080062#include "mirror/object_array-inl.h"
63#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070064#include "monitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070065#include "native_stack_dump.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070066#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010067#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070068#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070069#include "object_lock.h"
Sebastien Hertzfd3077e2014-04-23 10:32:43 +020070#include "quick_exception_handler.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010071#include "quick/quick_method_frame_info.h"
Andreas Gampe202f85a2017-02-06 10:23:26 -080072#include "read_barrier-inl.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050073#include "reflection.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070074#include "runtime.h"
Andreas Gampeac30fa22017-01-18 21:02:36 -080075#include "runtime_callbacks.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070076#include "scoped_thread_state_change-inl.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070077#include "ScopedLocalRef.h"
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -070078#include "ScopedUtfChars.h"
Elliott Hughes68e76522011-10-05 13:22:16 -070079#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +010080#include "stack_map.h"
Elliott Hughes8daa0922011-09-11 13:46:25 -070081#include "thread_list.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070082#include "thread-inl.h"
Elliott Hughesa0957642011-09-02 14:27:33 -070083#include "utils.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -070084#include "verifier/method_verifier.h"
Andreas Gampe90b936d2017-01-31 08:58:55 -080085#include "verify_object.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070086#include "well_known_classes.h"
buzbee1452bee2015-03-06 14:43:04 -080087#include "interpreter/interpreter.h"
Carl Shapirob5573532011-07-12 18:22:59 -070088
Yu Lieac44242015-06-29 10:50:03 +080089#if ART_USE_FUTEXES
90#include "linux/futex.h"
91#include "sys/syscall.h"
92#ifndef SYS_futex
93#define SYS_futex __NR_futex
94#endif
95#endif // ART_USE_FUTEXES
96
Carl Shapirob5573532011-07-12 18:22:59 -070097namespace art {
98
Andreas Gampe46ee31b2016-12-14 10:11:49 -080099using android::base::StringAppendV;
100using android::base::StringPrintf;
101
Mingyao Yangf711f2c2016-05-23 12:29:39 -0700102extern "C" NO_RETURN void artDeoptimize(Thread* self);
103
Ian Rogers0878d652013-04-18 17:38:35 -0700104bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -0700105pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -0800106ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -0700107const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +0100108bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +0100109Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +0100110
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700111static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700112
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700113// For implicit overflow checks we reserve an extra piece of memory at the bottom
114// of the stack (lowest memory). The higher portion of the memory
115// is protected against reads and the lower is available for use while
116// throwing the StackOverflow exception.
117constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
118
Elliott Hughes7dc51662012-05-16 14:48:43 -0700119static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
120
Ian Rogers5d76c432011-10-31 21:42:49 -0700121void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700122 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700123}
124
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700125static void UnimplementedEntryPoint() {
126 UNIMPLEMENTED(FATAL);
127}
128
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700129void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800130void UpdateReadBarrierEntrypoints(QuickEntryPoints* qpoints, bool is_marking);
131
132void Thread::SetIsGcMarkingAndUpdateEntrypoints(bool is_marking) {
133 CHECK(kUseReadBarrier);
134 tls32_.is_gc_marking = is_marking;
135 UpdateReadBarrierEntrypoints(&tlsPtr_.quick_entrypoints, is_marking);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800136 ResetQuickAllocEntryPointsForThread(is_marking);
Mathieu Chartierfe814e82016-11-09 14:32:49 -0800137}
Ian Rogers7655f292013-07-29 11:07:13 -0700138
Ian Rogers848871b2013-08-05 10:56:33 -0700139void Thread::InitTlsEntryPoints() {
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700140 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700141 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800142 uintptr_t* end = reinterpret_cast<uintptr_t*>(
143 reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) + sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700144 for (uintptr_t* it = begin; it != end; ++it) {
145 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
146 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700147 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700148}
149
Mathieu Chartier5ace2012016-11-30 10:15:41 -0800150void Thread::ResetQuickAllocEntryPointsForThread(bool is_marking) {
151 if (kUseReadBarrier && kRuntimeISA != kX86_64) {
152 // Allocation entrypoint switching is currently only implemented for X86_64.
153 is_marking = true;
154 }
155 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints, is_marking);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700156}
157
Sebastien Hertz07474662015-08-25 15:12:33 +0000158class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200159 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100160 DeoptimizationContextRecord(const JValue& ret_val,
161 bool is_reference,
162 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800163 ObjPtr<mirror::Throwable> pending_exception,
Sebastien Hertz07474662015-08-25 15:12:33 +0000164 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100165 : ret_val_(ret_val),
166 is_reference_(is_reference),
167 from_code_(from_code),
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800168 pending_exception_(pending_exception.Ptr()),
Sebastien Hertz07474662015-08-25 15:12:33 +0000169 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200170
171 JValue GetReturnValue() const { return ret_val_; }
172 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100173 bool GetFromCode() const { return from_code_; }
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800174 ObjPtr<mirror::Throwable> GetPendingException() const { return pending_exception_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000175 DeoptimizationContextRecord* GetLink() const { return link_; }
176 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200177 DCHECK(is_reference_);
178 return ret_val_.GetGCRoot();
179 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000180 mirror::Object** GetPendingExceptionAsGCRoot() {
181 return reinterpret_cast<mirror::Object**>(&pending_exception_);
182 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200183
184 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000185 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200186 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200187
Sebastien Hertz07474662015-08-25 15:12:33 +0000188 // Indicates whether the returned value is a reference. If so, the GC will visit it.
189 const bool is_reference_;
190
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100191 // Whether the context was created from an explicit deoptimization in the code.
192 const bool from_code_;
193
Sebastien Hertz07474662015-08-25 15:12:33 +0000194 // The exception that was pending before deoptimization (or null if there was no pending
195 // exception).
196 mirror::Throwable* pending_exception_;
197
198 // A link to the previous DeoptimizationContextRecord.
199 DeoptimizationContextRecord* const link_;
200
201 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200202};
203
204class StackedShadowFrameRecord {
205 public:
206 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
207 StackedShadowFrameType type,
208 StackedShadowFrameRecord* link)
209 : shadow_frame_(shadow_frame),
210 type_(type),
211 link_(link) {}
212
213 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
214 StackedShadowFrameType GetType() const { return type_; }
215 StackedShadowFrameRecord* GetLink() const { return link_; }
216
217 private:
218 ShadowFrame* const shadow_frame_;
219 const StackedShadowFrameType type_;
220 StackedShadowFrameRecord* const link_;
221
222 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
223};
224
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100225void Thread::PushDeoptimizationContext(const JValue& return_value,
226 bool is_reference,
227 bool from_code,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800228 ObjPtr<mirror::Throwable> exception) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000229 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
230 return_value,
231 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100232 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000233 exception,
234 tlsPtr_.deoptimization_context_stack);
235 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700236}
237
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100238void Thread::PopDeoptimizationContext(JValue* result,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800239 ObjPtr<mirror::Throwable>* exception,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100240 bool* from_code) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000241 AssertHasDeoptimizationContext();
242 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
243 tlsPtr_.deoptimization_context_stack = record->GetLink();
244 result->SetJ(record->GetReturnValue().GetJ());
245 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100246 *from_code = record->GetFromCode();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700247 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000248}
249
250void Thread::AssertHasDeoptimizationContext() {
251 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
252 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800253}
254
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700255void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
256 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
257 sf, type, tlsPtr_.stacked_shadow_frame_record);
258 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800259}
260
Andreas Gampe639bdd12015-06-03 11:22:45 -0700261ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700262 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700263 if (must_be_present) {
264 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700265 } else {
266 if (record == nullptr || record->GetType() != type) {
267 return nullptr;
268 }
269 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700270 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
271 ShadowFrame* shadow_frame = record->GetShadowFrame();
272 delete record;
273 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700274}
275
Mingyao Yang99170c62015-07-06 11:10:37 -0700276class FrameIdToShadowFrame {
277 public:
278 static FrameIdToShadowFrame* Create(size_t frame_id,
279 ShadowFrame* shadow_frame,
280 FrameIdToShadowFrame* next,
281 size_t num_vregs) {
282 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
283 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
284 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
285 }
286
287 static void Delete(FrameIdToShadowFrame* f) {
288 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
289 delete[] memory;
290 }
291
292 size_t GetFrameId() const { return frame_id_; }
293 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
294 FrameIdToShadowFrame* GetNext() const { return next_; }
295 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
296 bool* GetUpdatedVRegFlags() {
297 return updated_vreg_flags_;
298 }
299
300 private:
301 FrameIdToShadowFrame(size_t frame_id,
302 ShadowFrame* shadow_frame,
303 FrameIdToShadowFrame* next)
304 : frame_id_(frame_id),
305 shadow_frame_(shadow_frame),
306 next_(next) {}
307
308 const size_t frame_id_;
309 ShadowFrame* const shadow_frame_;
310 FrameIdToShadowFrame* next_;
311 bool updated_vreg_flags_[0];
312
313 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
314};
315
316static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
317 size_t frame_id) {
318 FrameIdToShadowFrame* found = nullptr;
319 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
320 if (record->GetFrameId() == frame_id) {
321 if (kIsDebugBuild) {
322 // Sanity check we have at most one record for this frame.
323 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
324 found = record;
325 } else {
326 return record;
327 }
328 }
329 }
330 return found;
331}
332
333ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
334 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
335 tlsPtr_.frame_id_to_shadow_frame, frame_id);
336 if (record != nullptr) {
337 return record->GetShadowFrame();
338 }
339 return nullptr;
340}
341
342// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
343bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
344 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
345 tlsPtr_.frame_id_to_shadow_frame, frame_id);
346 CHECK(record != nullptr);
347 return record->GetUpdatedVRegFlags();
348}
349
350ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
351 uint32_t num_vregs,
352 ArtMethod* method,
353 uint32_t dex_pc) {
354 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
355 if (shadow_frame != nullptr) {
356 return shadow_frame;
357 }
David Sehr709b0702016-10-13 09:12:37 -0700358 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700359 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
360 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
361 shadow_frame,
362 tlsPtr_.frame_id_to_shadow_frame,
363 num_vregs);
364 for (uint32_t i = 0; i < num_vregs; i++) {
365 // Do this to clear all references for root visitors.
366 shadow_frame->SetVRegReference(i, nullptr);
367 // This flag will be changed to true if the debugger modifies the value.
368 record->GetUpdatedVRegFlags()[i] = false;
369 }
370 tlsPtr_.frame_id_to_shadow_frame = record;
371 return shadow_frame;
372}
373
374void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
375 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
376 if (head->GetFrameId() == frame_id) {
377 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
378 FrameIdToShadowFrame::Delete(head);
379 return;
380 }
381 FrameIdToShadowFrame* prev = head;
382 for (FrameIdToShadowFrame* record = head->GetNext();
383 record != nullptr;
384 prev = record, record = record->GetNext()) {
385 if (record->GetFrameId() == frame_id) {
386 prev->SetNext(record->GetNext());
387 FrameIdToShadowFrame::Delete(record);
388 return;
389 }
390 }
391 LOG(FATAL) << "No shadow frame for frame " << frame_id;
392 UNREACHABLE();
393}
394
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700395void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700396 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700397}
398
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700399void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700400 // One thread (us) survived the fork, but we have a new tid so we need to
401 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700402 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700403}
404
Brian Carlstrom78128a62011-09-15 17:21:19 -0700405void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700406 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700407 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800408 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700409 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800410 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700411 }
412 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700413 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
414 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800415 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700416 // Check that if we got here we cannot be shutting down (as shutdown should never have started
417 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700418 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700419 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
420 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
421 // the runtime in such a case. In case this ever changes, we need to make sure here to
422 // delete the tmp_jni_env, as we own it at this point.
423 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
424 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700425 Runtime::Current()->EndThreadBirth();
426 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700427 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700428 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800429 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800430
431 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700432 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700433 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700434 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
435 self->tlsPtr_.jpeer = nullptr;
Andreas Gampe08883de2016-11-08 13:20:52 -0800436 self->SetThreadName(self->GetThreadName()->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100437
Andreas Gampe08883de2016-11-08 13:20:52 -0800438 ArtField* priorityField = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100439 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000440
Andreas Gampeac30fa22017-01-18 21:02:36 -0800441 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Ian Rogers365c1022012-06-22 15:05:28 -0700442
443 // Invoke the 'run' method of our java.lang.Thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800444 ObjPtr<mirror::Object> receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700445 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700446 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
447 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700448 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700449 // Detach and delete self.
450 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700451
Dave Allison0aded082013-11-07 13:15:11 -0800452 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700453}
454
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700455Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Mathieu Chartierf5769e12017-01-10 15:54:41 -0800456 ObjPtr<mirror::Object> thread_peer) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800457 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800458 Thread* result = reinterpret_cast<Thread*>(static_cast<uintptr_t>(f->GetLong(thread_peer)));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700459 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
460 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700461 if (kIsDebugBuild) {
462 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800463 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700464 Locks::thread_list_lock_->AssertHeld(soa.Self());
465 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700466 }
467 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800468}
469
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700470Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
471 jobject java_thread) {
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700472 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread).Ptr());
Elliott Hughes01158d72011-09-19 19:47:10 -0700473}
474
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700475static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700476 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700477 if (stack_size == 0) {
478 stack_size = Runtime::Current()->GetDefaultStackSize();
479 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700480
Brian Carlstrom6414a972012-04-14 14:20:04 -0700481 // Dalvik used the bionic pthread default stack size for native threads,
482 // so include that here to support apps that expect large native stacks.
483 stack_size += 1 * MB;
484
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700485 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
486 if (stack_size < PTHREAD_STACK_MIN) {
487 stack_size = PTHREAD_STACK_MIN;
488 }
489
Dave Allisonf9439142014-03-27 15:10:22 -0700490 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
491 // It's likely that callers are trying to ensure they have at least a certain amount of
492 // stack space, so we should add our reserved space on top of what they requested, rather
493 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700494 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700495 } else {
496 // If we are going to use implicit stack checks, allocate space for the protected
497 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000498 stack_size += Thread::kStackOverflowImplicitCheckSize +
499 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700500 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700501
502 // Some systems require the stack size to be a multiple of the system page size, so round up.
503 stack_size = RoundUp(stack_size, kPageSize);
504
505 return stack_size;
506}
507
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700508// Return the nearest page-aligned address below the current stack top.
509NO_INLINE
510static uint8_t* FindStackTop() {
511 return reinterpret_cast<uint8_t*>(
512 AlignDown(__builtin_frame_address(0), kPageSize));
513}
514
Dave Allisonf9439142014-03-27 15:10:22 -0700515// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700516// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700517ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700518void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700519 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700520 // Page containing current top of stack.
521 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700522
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700523 // Try to directly protect the stack.
524 VLOG(threads) << "installing stack protected region at " << std::hex <<
525 static_cast<void*>(pregion) << " to " <<
526 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
527 if (ProtectStack(/* fatal_on_error */ false)) {
528 // Tell the kernel that we won't be needing these pages any more.
529 // NB. madvise will probably write zeroes into the memory (on linux it does).
530 uint32_t unwanted_size = stack_top - pregion - kPageSize;
531 madvise(pregion, unwanted_size, MADV_DONTNEED);
532 return;
533 }
534
535 // There is a little complexity here that deserves a special mention. On some
536 // architectures, the stack is created using a VM_GROWSDOWN flag
537 // to prevent memory being allocated when it's not needed. This flag makes the
538 // kernel only allocate memory for the stack by growing down in memory. Because we
539 // want to put an mprotected region far away from that at the stack top, we need
540 // to make sure the pages for the stack are mapped in before we call mprotect.
541 //
542 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
543 // with a non-mapped stack (usually only the main thread).
544 //
545 // We map in the stack by reading every page from the stack bottom (highest address)
546 // to the stack top. (We then madvise this away.) This must be done by reading from the
547 // current stack pointer downwards. Any access more than a page below the current SP
548 // might cause a segv.
549 // TODO: This comment may be out of date. It seems possible to speed this up. As
550 // this is normally done once in the zygote on startup, ignore for now.
551 //
552 // AddressSanitizer does not like the part of this functions that reads every stack page.
553 // Looks a lot like an out-of-bounds access.
554
555 // (Defensively) first remove the protection on the protected region as will want to read
556 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700557 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000558
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700559 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
560 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000561
Dave Allison648d7112014-07-25 16:15:27 -0700562 // Read every page from the high address to the low.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700563 volatile uint8_t dont_optimize_this;
Roland Levillain48a7bae2016-03-21 14:09:54 +0000564 UNUSED(dont_optimize_this);
Ian Rogers13735952014-10-08 12:43:28 -0700565 for (uint8_t* p = stack_top; p >= pregion; p -= kPageSize) {
Dave Allison648d7112014-07-25 16:15:27 -0700566 dont_optimize_this = *p;
Dave Allison69dfe512014-07-11 17:11:58 +0000567 }
568
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700569 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700570 static_cast<void*>(pregion) << " to " <<
571 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
572
Dave Allison648d7112014-07-25 16:15:27 -0700573 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700574 ProtectStack(/* fatal_on_error */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700575
576 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000577 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700578 uint32_t unwanted_size = stack_top - pregion - kPageSize;
579 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700580}
581
Ian Rogers120f1c72012-09-28 17:17:10 -0700582void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800583 CHECK(java_peer != nullptr);
Ian Rogers120f1c72012-09-28 17:17:10 -0700584 Thread* self = static_cast<JNIEnvExt*>(env)->self;
Andreas Gampe56623832015-07-09 21:53:15 -0700585
586 if (VLOG_IS_ON(threads)) {
587 ScopedObjectAccess soa(env);
588
Andreas Gampe08883de2016-11-08 13:20:52 -0800589 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700590 ObjPtr<mirror::String> java_name =
591 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700592 std::string thread_name;
593 if (java_name != nullptr) {
594 thread_name = java_name->ToModifiedUtf8();
595 } else {
596 thread_name = "(Unnamed)";
597 }
598
599 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700600 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700601 }
602
Ian Rogers120f1c72012-09-28 17:17:10 -0700603 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700604
Ian Rogers120f1c72012-09-28 17:17:10 -0700605 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
606 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700607 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700608 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700609 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700610 thread_start_during_shutdown = true;
611 } else {
612 runtime->StartThreadBirth();
613 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700614 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700615 if (thread_start_during_shutdown) {
616 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
617 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
618 return;
619 }
620
621 Thread* child_thread = new Thread(is_daemon);
622 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700623 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700624 stack_size = FixStackSize(stack_size);
625
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -0700626 // 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 -0700627 // assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800628 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
629 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700630
Andreas Gampe449357d2015-06-01 22:29:51 -0700631 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
632 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100633 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700634 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100635 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700636
Andreas Gampe449357d2015-06-01 22:29:51 -0700637 int pthread_create_result = 0;
638 if (child_jni_env_ext.get() != nullptr) {
639 pthread_t new_pthread;
640 pthread_attr_t attr;
641 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
642 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
643 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
644 "PTHREAD_CREATE_DETACHED");
645 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
646 pthread_create_result = pthread_create(&new_pthread,
647 &attr,
648 Thread::CreateCallback,
649 child_thread);
650 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
651
652 if (pthread_create_result == 0) {
653 // pthread_create started the new thread. The child is now responsible for managing the
654 // JNIEnvExt we created.
655 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
656 // between the threads.
657 child_jni_env_ext.release();
658 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700659 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700660 }
661
662 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
663 {
664 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
665 runtime->EndThreadBirth();
666 }
667 // Manually delete the global reference since Thread::Init will not have been run.
668 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
669 child_thread->tlsPtr_.jpeer = nullptr;
670 delete child_thread;
671 child_thread = nullptr;
672 // TODO: remove from thread group?
673 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
674 {
675 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100676 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700677 StringPrintf("pthread_create (%s stack) failed: %s",
678 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
679 ScopedObjectAccess soa(env);
680 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700681 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700682}
683
Andreas Gampe449357d2015-06-01 22:29:51 -0700684bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700685 // This function does all the initialization that must be run by the native thread it applies to.
686 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
687 // we can handshake with the corresponding native thread when it's ready.) Check this native
688 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800689 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800690
691 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
692 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
693 tlsPtr_.pthread_self = pthread_self();
694 CHECK(is_started_);
695
Elliott Hughesd8af1592012-04-16 20:40:15 -0700696 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800697 if (!InitStackHwm()) {
698 return false;
699 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700700 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700701 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800702 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700703 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700704 InitTid();
buzbee1452bee2015-03-06 14:43:04 -0800705 interpreter::InitInterpreterTls(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800706
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100707#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000708 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
709#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700710 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000711#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700712 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700713
Ian Rogersdd7624d2014-03-14 17:43:00 -0700714 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700715
Andreas Gampe449357d2015-06-01 22:29:51 -0700716 if (jni_env_ext != nullptr) {
717 DCHECK_EQ(jni_env_ext->vm, java_vm);
718 DCHECK_EQ(jni_env_ext->self, this);
719 tlsPtr_.jni_env = jni_env_ext;
720 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100721 std::string error_msg;
722 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700723 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100724 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700725 return false;
726 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700727 }
728
Ian Rogers120f1c72012-09-28 17:17:10 -0700729 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800730 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700731}
732
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800733template <typename PeerAction>
734Thread* Thread::Attach(const char* thread_name, bool as_daemon, PeerAction peer_action) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700735 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800736 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700737 LOG(ERROR) << "Thread attaching to non-existent runtime: " << thread_name;
Dave Allison0aded082013-11-07 13:15:11 -0800738 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700739 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800740 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700741 {
Dave Allison0aded082013-11-07 13:15:11 -0800742 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700743 if (runtime->IsShuttingDownLocked()) {
Calin Juravlef39f0092016-04-28 12:59:33 +0100744 LOG(WARNING) << "Thread attaching while runtime is shutting down: " << thread_name;
Dave Allison0aded082013-11-07 13:15:11 -0800745 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700746 } else {
747 Runtime::Current()->StartThreadBirth();
748 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800749 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700750 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800751 if (!init_success) {
752 delete self;
753 return nullptr;
754 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700755 }
756 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700757
Jeff Hao848f70a2014-01-15 13:49:50 -0800758 self->InitStringEntryPoints();
759
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700760 CHECK_NE(self->GetState(), kRunnable);
761 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700762
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800763 // Run the action that is acting on the peer.
764 if (!peer_action(self)) {
765 runtime->GetThreadList()->Unregister(self);
766 // Unregister deletes self, no need to do this here.
767 return nullptr;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700768 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700769
Andreas Gampe56623832015-07-09 21:53:15 -0700770 if (VLOG_IS_ON(threads)) {
771 if (thread_name != nullptr) {
772 VLOG(threads) << "Attaching thread " << thread_name;
773 } else {
774 VLOG(threads) << "Attaching unnamed thread.";
775 }
776 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700777 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700778 }
779
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200780 {
781 ScopedObjectAccess soa(self);
Andreas Gampeac30fa22017-01-18 21:02:36 -0800782 runtime->GetRuntimeCallbacks()->ThreadStart(self);
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200783 }
784
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700785 return self;
786}
787
Andreas Gampe732b0ac2017-01-18 15:23:39 -0800788Thread* Thread::Attach(const char* thread_name,
789 bool as_daemon,
790 jobject thread_group,
791 bool create_peer) {
792 auto create_peer_action = [&](Thread* self) {
793 // If we're the main thread, ClassLinker won't be created until after we're attached,
794 // so that thread needs a two-stage attach. Regular threads don't need this hack.
795 // In the compiler, all threads need this hack, because no-one's going to be getting
796 // a native peer!
797 if (create_peer) {
798 self->CreatePeer(thread_name, as_daemon, thread_group);
799 if (self->IsExceptionPending()) {
800 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log it.
801 {
802 ScopedObjectAccess soa(self);
803 LOG(ERROR) << "Exception creating thread peer:";
804 LOG(ERROR) << self->GetException()->Dump();
805 self->ClearException();
806 }
807 return false;
808 }
809 } else {
810 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
811 if (thread_name != nullptr) {
812 self->tlsPtr_.name->assign(thread_name);
813 ::art::SetThreadName(thread_name);
814 } else if (self->GetJniEnv()->check_jni) {
815 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
816 }
817 }
818 return true;
819 };
820 return Attach(thread_name, as_daemon, create_peer_action);
821}
822
823Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_peer) {
824 auto set_peer_action = [&](Thread* self) {
825 // Install the given peer.
826 {
827 DCHECK(self == Thread::Current());
828 ScopedObjectAccess soa(self);
829 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(thread_peer).Ptr();
830 }
831 self->GetJniEnv()->SetLongField(thread_peer,
832 WellKnownClasses::java_lang_Thread_nativePeer,
833 reinterpret_cast<jlong>(self));
834 return true;
835 };
836 return Attach(thread_name, as_daemon, set_peer_action);
837}
838
Ian Rogers365c1022012-06-22 15:05:28 -0700839void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
840 Runtime* runtime = Runtime::Current();
841 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700842 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700843
Dave Allison0aded082013-11-07 13:15:11 -0800844 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -0700845 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -0700846 }
Elliott Hughes726079d2011-10-07 18:43:44 -0700847 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -0800848 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +0000849 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -0800850 CHECK(IsExceptionPending());
851 return;
852 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700853 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700854 jboolean thread_is_daemon = as_daemon;
855
Elliott Hugheseac76672012-05-24 21:56:51 -0700856 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -0800857 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700858 CHECK(IsExceptionPending());
859 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -0700860 }
Ian Rogerscfaa4552012-11-26 21:00:08 -0800861 {
862 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700863 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800864 }
Elliott Hugheseac76672012-05-24 21:56:51 -0700865 env->CallNonvirtualVoidMethod(peer.get(),
866 WellKnownClasses::java_lang_Thread,
867 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -0700868 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -0700869 if (IsExceptionPending()) {
870 return;
871 }
Elliott Hughesd369bb72011-09-12 14:41:14 -0700872
Ian Rogers120f1c72012-09-28 17:17:10 -0700873 Thread* self = this;
874 DCHECK_EQ(self, Thread::Current());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700875 env->SetLongField(peer.get(), WellKnownClasses::java_lang_Thread_nativePeer,
876 reinterpret_cast<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -0700877
878 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700879 StackHandleScope<1> hs(self);
Andreas Gampe08883de2016-11-08 13:20:52 -0800880 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -0800881 if (peer_thread_name == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -0700882 // The Thread constructor should have set the Thread.name to a
883 // non-null value. However, because we can run without code
884 // available (in the compiler, in tests), we manually assign the
885 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100886 if (runtime->IsActiveTransaction()) {
Andreas Gampebad529d2017-02-13 18:52:10 -0800887 InitPeer<true>(soa,
888 tlsPtr_.opeer,
889 thread_is_daemon,
890 thread_group,
891 thread_name.get(),
892 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100893 } else {
Andreas Gampebad529d2017-02-13 18:52:10 -0800894 InitPeer<false>(soa,
895 tlsPtr_.opeer,
896 thread_is_daemon,
897 thread_group,
898 thread_name.get(),
899 thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100900 }
Andreas Gampe08883de2016-11-08 13:20:52 -0800901 peer_thread_name.Assign(GetThreadName());
Brian Carlstrom00fae582011-10-28 01:16:28 -0700902 }
Elliott Hughes225f5a12012-06-11 11:23:48 -0700903 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Andreas Gampefa4333d2017-02-14 11:10:34 -0800904 if (peer_thread_name != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -0800905 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -0700906 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700907}
908
Andreas Gampebad529d2017-02-13 18:52:10 -0800909jobject Thread::CreateCompileTimePeer(JNIEnv* env,
910 const char* name,
911 bool as_daemon,
912 jobject thread_group) {
913 Runtime* runtime = Runtime::Current();
914 CHECK(!runtime->IsStarted());
915
916 if (thread_group == nullptr) {
917 thread_group = runtime->GetMainThreadGroup();
918 }
919 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
920 // Add missing null check in case of OOM b/18297817
921 if (name != nullptr && thread_name.get() == nullptr) {
922 CHECK(Thread::Current()->IsExceptionPending());
923 return nullptr;
924 }
925 jint thread_priority = GetNativePriority();
926 jboolean thread_is_daemon = as_daemon;
927
928 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
929 if (peer.get() == nullptr) {
930 CHECK(Thread::Current()->IsExceptionPending());
931 return nullptr;
932 }
933
934 // We cannot call Thread.init, as it will recursively ask for currentThread.
935
936 // The Thread constructor should have set the Thread.name to a
937 // non-null value. However, because we can run without code
938 // available (in the compiler, in tests), we manually assign the
939 // fields the constructor should have set.
940 ScopedObjectAccessUnchecked soa(Thread::Current());
941 if (runtime->IsActiveTransaction()) {
942 InitPeer<true>(soa,
943 soa.Decode<mirror::Object>(peer.get()),
944 thread_is_daemon,
945 thread_group,
946 thread_name.get(),
947 thread_priority);
948 } else {
949 InitPeer<false>(soa,
950 soa.Decode<mirror::Object>(peer.get()),
951 thread_is_daemon,
952 thread_group,
953 thread_name.get(),
954 thread_priority);
955 }
956
957 return peer.release();
958}
959
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100960template<bool kTransactionActive>
Andreas Gampebad529d2017-02-13 18:52:10 -0800961void Thread::InitPeer(ScopedObjectAccessAlreadyRunnable& soa,
962 ObjPtr<mirror::Object> peer,
963 jboolean thread_is_daemon,
964 jobject thread_group,
965 jobject thread_name,
966 jint thread_priority) {
Andreas Gampe08883de2016-11-08 13:20:52 -0800967 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)->
Andreas Gampebad529d2017-02-13 18:52:10 -0800968 SetBoolean<kTransactionActive>(peer, thread_is_daemon);
Andreas Gampe08883de2016-11-08 13:20:52 -0800969 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)->
Andreas Gampebad529d2017-02-13 18:52:10 -0800970 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_group));
Andreas Gampe08883de2016-11-08 13:20:52 -0800971 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name)->
Andreas Gampebad529d2017-02-13 18:52:10 -0800972 SetObject<kTransactionActive>(peer, soa.Decode<mirror::Object>(thread_name));
Andreas Gampe08883de2016-11-08 13:20:52 -0800973 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)->
Andreas Gampebad529d2017-02-13 18:52:10 -0800974 SetInt<kTransactionActive>(peer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100975}
976
Elliott Hughes899e7892012-01-24 14:57:32 -0800977void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700978 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -0800979 ::art::SetThreadName(name);
980 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
981}
982
Andreas Gampe9186ced2016-12-12 14:28:21 -0800983static void GetThreadStack(pthread_t thread,
984 void** stack_base,
985 size_t* stack_size,
986 size_t* guard_size) {
987#if defined(__APPLE__)
988 *stack_size = pthread_get_stacksize_np(thread);
989 void* stack_addr = pthread_get_stackaddr_np(thread);
990
991 // Check whether stack_addr is the base or end of the stack.
992 // (On Mac OS 10.7, it's the end.)
993 int stack_variable;
994 if (stack_addr > &stack_variable) {
995 *stack_base = reinterpret_cast<uint8_t*>(stack_addr) - *stack_size;
996 } else {
997 *stack_base = stack_addr;
998 }
999
1000 // This is wrong, but there doesn't seem to be a way to get the actual value on the Mac.
1001 pthread_attr_t attributes;
1002 CHECK_PTHREAD_CALL(pthread_attr_init, (&attributes), __FUNCTION__);
1003 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1004 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1005#else
1006 pthread_attr_t attributes;
1007 CHECK_PTHREAD_CALL(pthread_getattr_np, (thread, &attributes), __FUNCTION__);
1008 CHECK_PTHREAD_CALL(pthread_attr_getstack, (&attributes, stack_base, stack_size), __FUNCTION__);
1009 CHECK_PTHREAD_CALL(pthread_attr_getguardsize, (&attributes, guard_size), __FUNCTION__);
1010 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attributes), __FUNCTION__);
1011
1012#if defined(__GLIBC__)
1013 // If we're the main thread, check whether we were run with an unlimited stack. In that case,
1014 // glibc will have reported a 2GB stack for our 32-bit process, and our stack overflow detection
1015 // will be broken because we'll die long before we get close to 2GB.
1016 bool is_main_thread = (::art::GetTid() == getpid());
1017 if (is_main_thread) {
1018 rlimit stack_limit;
1019 if (getrlimit(RLIMIT_STACK, &stack_limit) == -1) {
1020 PLOG(FATAL) << "getrlimit(RLIMIT_STACK) failed";
1021 }
1022 if (stack_limit.rlim_cur == RLIM_INFINITY) {
1023 size_t old_stack_size = *stack_size;
1024
1025 // Use the kernel default limit as our size, and adjust the base to match.
1026 *stack_size = 8 * MB;
1027 *stack_base = reinterpret_cast<uint8_t*>(*stack_base) + (old_stack_size - *stack_size);
1028
1029 VLOG(threads) << "Limiting unlimited stack (reported as " << PrettySize(old_stack_size) << ")"
1030 << " to " << PrettySize(*stack_size)
1031 << " with base " << *stack_base;
1032 }
1033 }
1034#endif
1035
1036#endif
1037}
1038
Ian Rogersf4d4da12014-11-11 16:10:33 -08001039bool Thread::InitStackHwm() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001040 void* read_stack_base;
1041 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001042 size_t read_guard_size;
1043 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -07001044
Ian Rogers13735952014-10-08 12:43:28 -07001045 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001046 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -07001047
Dave Allison648d7112014-07-25 16:15:27 -07001048 // The minimum stack size we can cope with is the overflow reserved bytes (typically
1049 // 8K) + the protected region size (4K) + another page (4K). Typically this will
1050 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
1051 // between 8K and 12K.
1052 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
1053 + 4 * KB;
1054 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -08001055 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07001056 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
1057 __LINE__,
1058 ::android::base::ERROR,
1059 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -08001060 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001061 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001062
Vladimir Markob8f2f632015-01-02 14:23:26 +00001063 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
1064 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
1065 read_stack_base,
1066 PrettySize(read_stack_size).c_str(),
1067 PrettySize(read_guard_size).c_str());
1068
Ian Rogers932746a2011-09-22 18:57:50 -07001069 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -07001070
1071 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -08001072 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001073
1074 // Valgrind on arm doesn't give the right values here. Do not install the guard page, and
1075 // effectively disable stack overflow checks (we'll get segfaults, potentially) by setting
1076 // stack_begin to 0.
1077 const bool valgrind_on_arm =
1078 (kRuntimeISA == kArm || kRuntimeISA == kArm64) &&
1079 kMemoryToolIsValgrind &&
1080 RUNNING_ON_MEMORY_TOOL != 0;
1081 if (valgrind_on_arm) {
1082 tlsPtr_.stack_begin = nullptr;
1083 }
1084
Dave Allisonb090a182014-08-14 17:02:48 +00001085 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -07001086
1087 // Install the protected region if we are doing implicit overflow checks.
Andreas Gampe7df12cb2016-06-10 20:38:55 -07001088 if (implicit_stack_check && !valgrind_on_arm) {
Dave Allison648d7112014-07-25 16:15:27 -07001089 // The thread might have protected region at the bottom. We need
1090 // to install our own region so we need to move the limits
1091 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -07001092
Elliott Hughes6d3fc562014-08-27 11:47:01 -07001093 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
1094 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
1095 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -07001096
1097 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -07001098 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -07001099
1100 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -07001101 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -08001102
1103 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -07001104}
1105
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001106void Thread::ShortDump(std::ostream& os) const {
1107 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001108 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001109 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001110 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001111 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -07001112 }
Ian Rogers474b6da2012-09-25 00:20:38 -07001113 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -07001114 << ",Thread*=" << this
1115 << ",peer=" << tlsPtr_.opeer
1116 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
1117 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -07001118}
1119
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08001120void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map,
1121 bool force_dump_stack) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001122 DumpState(os);
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08001123 DumpStack(os, dump_native_stack, backtrace_map, force_dump_stack);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001124}
1125
Andreas Gampe08883de2016-11-08 13:20:52 -08001126mirror::String* Thread::GetThreadName() const {
1127 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001128 if (tlsPtr_.opeer == nullptr) {
1129 return nullptr;
1130 }
1131 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
1132 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -07001133}
1134
Elliott Hughesffb465f2012-03-01 18:46:05 -08001135void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001136 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -08001137}
1138
Jeff Hao57dac6e2013-08-15 16:36:24 -07001139uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -08001140#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -07001141 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001142 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -07001143 timespec now;
1144 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -07001145 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -08001146#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -07001147 UNIMPLEMENTED(WARNING);
1148 return -1;
1149#endif
1150}
1151
Ian Rogers01ae5802012-09-28 16:14:01 -07001152// Attempt to rectify locks so that we dump thread list with required locks before exiting.
1153static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -07001154 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -07001155 Locks::thread_suspend_count_lock_->Unlock(self);
1156 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1157 Locks::mutator_lock_->SharedTryLock(self);
1158 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
1159 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
1160 }
1161 }
1162 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1163 Locks::thread_list_lock_->TryLock(self);
1164 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
1165 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
1166 }
1167 }
1168 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -07001169 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -07001170 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -07001171}
1172
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001173bool Thread::ModifySuspendCountInternal(Thread* self,
1174 int delta,
1175 AtomicInteger* suspend_barrier,
1176 bool for_debugger) {
Ian Rogers2966e132014-04-02 08:34:36 -07001177 if (kIsDebugBuild) {
1178 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
1179 << delta << " " << tls32_.debug_suspend_count << " " << this;
1180 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1181 Locks::thread_suspend_count_lock_->AssertHeld(self);
1182 if (this != self && !IsSuspended()) {
1183 Locks::thread_list_lock_->AssertHeld(self);
1184 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001185 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001186 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001187 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001188 return false;
1189 }
1190
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001191 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1192 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1193 // deadlock. b/31683379.
1194 return false;
1195 }
1196
Yu Lieac44242015-06-29 10:50:03 +08001197 uint16_t flags = kSuspendRequest;
1198 if (delta > 0 && suspend_barrier != nullptr) {
1199 uint32_t available_barrier = kMaxSuspendBarriers;
1200 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1201 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1202 available_barrier = i;
1203 break;
1204 }
1205 }
1206 if (available_barrier == kMaxSuspendBarriers) {
1207 // No barrier spaces available, we can't add another.
1208 return false;
1209 }
1210 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1211 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001212 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001213
Ian Rogersdd7624d2014-03-14 17:43:00 -07001214 tls32_.suspend_count += delta;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001215 if (for_debugger) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001216 tls32_.debug_suspend_count += delta;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001217 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001218
Ian Rogersdd7624d2014-03-14 17:43:00 -07001219 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001220 AtomicClearFlag(kSuspendRequest);
1221 } else {
Yu Lieac44242015-06-29 10:50:03 +08001222 // Two bits might be set simultaneously.
1223 tls32_.state_and_flags.as_atomic_int.FetchAndOrSequentiallyConsistent(flags);
Dave Allisonb373e092014-02-20 16:06:36 -08001224 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001225 }
Yu Lieac44242015-06-29 10:50:03 +08001226 return true;
1227}
1228
1229bool Thread::PassActiveSuspendBarriers(Thread* self) {
1230 // Grab the suspend_count lock and copy the current set of
1231 // barriers. Then clear the list and the flag. The ModifySuspendCount
1232 // function requires the lock so we prevent a race between setting
1233 // the kActiveSuspendBarrier flag and clearing it.
1234 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1235 {
1236 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1237 if (!ReadFlag(kActiveSuspendBarrier)) {
1238 // quick exit test: the barriers have already been claimed - this is
1239 // possible as there may be a race to claim and it doesn't matter
1240 // who wins.
1241 // All of the callers of this function (except the SuspendAllInternal)
1242 // will first test the kActiveSuspendBarrier flag without lock. Here
1243 // double-check whether the barrier has been passed with the
1244 // suspend_count lock.
1245 return false;
1246 }
1247
1248 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1249 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1250 tlsPtr_.active_suspend_barriers[i] = nullptr;
1251 }
1252 AtomicClearFlag(kActiveSuspendBarrier);
1253 }
1254
1255 uint32_t barrier_count = 0;
1256 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1257 AtomicInteger* pending_threads = pass_barriers[i];
1258 if (pending_threads != nullptr) {
1259 bool done = false;
1260 do {
1261 int32_t cur_val = pending_threads->LoadRelaxed();
1262 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1263 // Reduce value by 1.
1264 done = pending_threads->CompareExchangeWeakRelaxed(cur_val, cur_val - 1);
1265#if ART_USE_FUTEXES
1266 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
1267 futex(pending_threads->Address(), FUTEX_WAKE, -1, nullptr, nullptr, 0);
1268 }
1269#endif
1270 } while (!done);
1271 ++barrier_count;
1272 }
1273 }
1274 CHECK_GT(barrier_count, 0U);
1275 return true;
1276}
1277
1278void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1279 CHECK(ReadFlag(kActiveSuspendBarrier));
1280 bool clear_flag = true;
1281 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1282 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1283 if (ptr == target) {
1284 tlsPtr_.active_suspend_barriers[i] = nullptr;
1285 } else if (ptr != nullptr) {
1286 clear_flag = false;
1287 }
1288 }
1289 if (LIKELY(clear_flag)) {
1290 AtomicClearFlag(kActiveSuspendBarrier);
1291 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001292}
1293
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001294void Thread::RunCheckpointFunction() {
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001295 bool done = false;
1296 do {
1297 // Grab the suspend_count lock and copy the checkpoints one by one. When the last checkpoint is
1298 // copied, clear the list and the flag. The RequestCheckpoint function will also grab this lock
1299 // to prevent a race between setting the kCheckpointRequest flag and clearing it.
1300 Closure* checkpoint = nullptr;
1301 {
1302 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1303 if (tlsPtr_.checkpoint_function != nullptr) {
1304 checkpoint = tlsPtr_.checkpoint_function;
1305 if (!checkpoint_overflow_.empty()) {
1306 // Overflow list not empty, copy the first one out and continue.
1307 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1308 checkpoint_overflow_.pop_front();
1309 } else {
1310 // No overflow checkpoints, this means that we are on the last pending checkpoint.
1311 tlsPtr_.checkpoint_function = nullptr;
1312 AtomicClearFlag(kCheckpointRequest);
1313 done = true;
1314 }
1315 } else {
1316 LOG(FATAL) << "Checkpoint flag set without pending checkpoint";
1317 }
Dave Allison0aded082013-11-07 13:15:11 -08001318 }
Dave Allison0aded082013-11-07 13:15:11 -08001319
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001320 // Outside the lock, run the checkpoint functions that we collected.
1321 ScopedTrace trace("Run checkpoint function");
1322 DCHECK(checkpoint != nullptr);
1323 checkpoint->Run(this);
1324 } while (!done);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001325}
1326
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001327void Thread::RunEmptyCheckpoint() {
1328 DCHECK_EQ(Thread::Current(), this);
1329 AtomicClearFlag(kEmptyCheckpointRequest);
1330 Runtime::Current()->GetThreadList()->EmptyCheckpointBarrier()->Pass(this);
1331}
1332
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001333bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001334 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001335 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001336 if (old_state_and_flags.as_struct.state != kRunnable) {
1337 return false; // Fail, thread is suspended and so can't run a checkpoint.
1338 }
Dave Allison0aded082013-11-07 13:15:11 -08001339
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001340 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001341 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001342 union StateAndFlags new_state_and_flags;
1343 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001344 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001345 bool success = tls32_.state_and_flags.as_atomic_int.CompareExchangeStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001346 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001347 if (success) {
1348 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1349 if (tlsPtr_.checkpoint_function == nullptr) {
1350 tlsPtr_.checkpoint_function = function;
1351 } else {
1352 checkpoint_overflow_.push_back(function);
1353 }
Dave Allison0aded082013-11-07 13:15:11 -08001354 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001355 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001356 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001357 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001358}
1359
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07001360bool Thread::RequestEmptyCheckpoint() {
1361 union StateAndFlags old_state_and_flags;
1362 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
1363 if (old_state_and_flags.as_struct.state != kRunnable) {
1364 // If it's not runnable, we don't need to do anything because it won't be in the middle of a
1365 // heap access (eg. the read barrier).
1366 return false;
1367 }
1368
1369 // We must be runnable to request a checkpoint.
1370 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
1371 union StateAndFlags new_state_and_flags;
1372 new_state_and_flags.as_int = old_state_and_flags.as_int;
1373 new_state_and_flags.as_struct.flags |= kEmptyCheckpointRequest;
1374 bool success = tls32_.state_and_flags.as_atomic_int.CompareExchangeStrongSequentiallyConsistent(
1375 old_state_and_flags.as_int, new_state_and_flags.as_int);
1376 if (success) {
1377 TriggerSuspend();
1378 }
1379 return success;
1380}
1381
Andreas Gampee9f67122016-10-27 19:21:23 -07001382class BarrierClosure : public Closure {
1383 public:
1384 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1385
1386 void Run(Thread* self) OVERRIDE {
1387 wrapped_->Run(self);
1388 barrier_.Pass(self);
1389 }
1390
1391 void Wait(Thread* self) {
1392 barrier_.Increment(self, 1);
1393 }
1394
1395 private:
1396 Closure* wrapped_;
1397 Barrier barrier_;
1398};
1399
1400void Thread::RequestSynchronousCheckpoint(Closure* function) {
1401 if (this == Thread::Current()) {
1402 // Asked to run on this thread. Just run.
1403 function->Run(this);
1404 return;
1405 }
1406 Thread* self = Thread::Current();
1407
1408 // The current thread is not this thread.
1409
1410 for (;;) {
1411 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1412 // suspend-count lock for too long.
1413 if (GetState() == ThreadState::kRunnable) {
1414 BarrierClosure barrier_closure(function);
1415 bool installed = false;
1416 {
1417 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1418 installed = RequestCheckpoint(&barrier_closure);
1419 }
1420 if (installed) {
1421 barrier_closure.Wait(self);
1422 return;
1423 }
1424 // Fall-through.
1425 }
1426
1427 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1428 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1429 // certain situations.
1430 {
1431 MutexLock mu(self, *Locks::thread_list_lock_);
1432 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1433
1434 if (!ModifySuspendCount(self, +1, nullptr, false)) {
1435 // Just retry the loop.
1436 sched_yield();
1437 continue;
1438 }
1439 }
1440
1441 while (GetState() == ThreadState::kRunnable) {
1442 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1443 // moves us to suspended.
1444 sched_yield();
1445 }
1446
1447 function->Run(this);
1448
1449 {
1450 MutexLock mu(self, *Locks::thread_list_lock_);
1451 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1452
1453 DCHECK_NE(GetState(), ThreadState::kRunnable);
1454 CHECK(ModifySuspendCount(self, -1, nullptr, false));
1455 }
1456
1457 return; // We're done, break out of the loop.
1458 }
1459}
1460
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001461Closure* Thread::GetFlipFunction() {
1462 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1463 Closure* func;
1464 do {
1465 func = atomic_func->LoadRelaxed();
1466 if (func == nullptr) {
1467 return nullptr;
1468 }
1469 } while (!atomic_func->CompareExchangeWeakSequentiallyConsistent(func, nullptr));
1470 DCHECK(func != nullptr);
1471 return func;
1472}
1473
1474void Thread::SetFlipFunction(Closure* function) {
1475 CHECK(function != nullptr);
1476 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1477 atomic_func->StoreSequentiallyConsistent(function);
1478}
1479
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001480void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001481 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001482 VLOG(threads) << this << " self-suspending";
1483 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001484 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
1485 ScopedThreadSuspension(this, kSuspended);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001486 VLOG(threads) << this << " self-reviving";
1487}
1488
Andreas Gampe9186ced2016-12-12 14:28:21 -08001489static std::string GetSchedulerGroupName(pid_t tid) {
1490 // /proc/<pid>/cgroup looks like this:
1491 // 2:devices:/
1492 // 1:cpuacct,cpu:/
1493 // We want the third field from the line whose second field contains the "cpu" token.
1494 std::string cgroup_file;
1495 if (!ReadFileToString(StringPrintf("/proc/self/task/%d/cgroup", tid), &cgroup_file)) {
1496 return "";
1497 }
1498 std::vector<std::string> cgroup_lines;
1499 Split(cgroup_file, '\n', &cgroup_lines);
1500 for (size_t i = 0; i < cgroup_lines.size(); ++i) {
1501 std::vector<std::string> cgroup_fields;
1502 Split(cgroup_lines[i], ':', &cgroup_fields);
1503 std::vector<std::string> cgroups;
1504 Split(cgroup_fields[1], ',', &cgroups);
1505 for (size_t j = 0; j < cgroups.size(); ++j) {
1506 if (cgroups[j] == "cpu") {
1507 return cgroup_fields[2].substr(1); // Skip the leading slash.
1508 }
1509 }
1510 }
1511 return "";
1512}
1513
1514
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001515void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001516 std::string group_name;
1517 int priority;
1518 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001519 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001520
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001521 // If flip_function is not null, it means we have run a checkpoint
1522 // before the thread wakes up to execute the flip function and the
1523 // thread roots haven't been forwarded. So the following access to
1524 // the roots (opeer or methods in the frames) would be bad. Run it
1525 // here. TODO: clean up.
1526 if (thread != nullptr) {
1527 ScopedObjectAccessUnchecked soa(self);
1528 Thread* this_thread = const_cast<Thread*>(thread);
1529 Closure* flip_func = this_thread->GetFlipFunction();
1530 if (flip_func != nullptr) {
1531 flip_func->Run(this_thread);
1532 }
1533 }
1534
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001535 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1536 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001537 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001538 ScopedObjectAccessUnchecked soa(self);
Andreas Gampe08883de2016-11-08 13:20:52 -08001539 priority = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_priority)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001540 ->GetInt(thread->tlsPtr_.opeer);
Andreas Gampe08883de2016-11-08 13:20:52 -08001541 is_daemon = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_daemon)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001542 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001543
Mathieu Chartier3398c782016-09-30 10:27:43 -07001544 ObjPtr<mirror::Object> thread_group =
Andreas Gampe08883de2016-11-08 13:20:52 -08001545 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
1546 ->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001547
Dave Allison0aded082013-11-07 13:15:11 -08001548 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001549 ArtField* group_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08001550 jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001551 ObjPtr<mirror::String> group_name_string =
1552 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001553 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001554 }
1555 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001556 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001557 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001558
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001559 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001560 if (scheduler_group_name.empty()) {
1561 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001562 }
1563
Dave Allison0aded082013-11-07 13:15:11 -08001564 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001565 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001566 if (is_daemon) {
1567 os << " daemon";
1568 }
1569 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001570 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001571 << " " << thread->GetState();
1572 if (thread->IsStillStarting()) {
1573 os << " (still starting up)";
1574 }
1575 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001576 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001577 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001578 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001579 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001580 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001581
Dave Allison0aded082013-11-07 13:15:11 -08001582 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001583 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001584 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001585 << " sCount=" << thread->tls32_.suspend_count
1586 << " dsCount=" << thread->tls32_.debug_suspend_count
Hiroshi Yamauchia82769c2016-12-02 17:01:51 -08001587 << " flags=" << thread->tls32_.state_and_flags.as_struct.flags
Ian Rogersdd7624d2014-03-14 17:43:00 -07001588 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001589 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1590 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001591
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001592 os << " | sysTid=" << tid
1593 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001594 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001595 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001596 int policy;
1597 sched_param sp;
Brian Carlstrom640a1042017-03-20 15:03:42 -07001598#if !defined(__APPLE__)
1599 // b/36445592 Don't use pthread_getschedparam since pthread may have exited.
1600 policy = sched_getscheduler(tid);
1601 if (policy == -1) {
1602 PLOG(WARNING) << "sched_getscheduler(" << tid << ")";
1603 }
1604 int sched_getparam_result = sched_getparam(tid, &sp);
1605 if (sched_getparam_result == -1) {
1606 PLOG(WARNING) << "sched_getparam(" << tid << ", &sp)";
1607 sp.sched_priority = -1;
1608 }
1609#else
Ian Rogersdd7624d2014-03-14 17:43:00 -07001610 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1611 __FUNCTION__);
Brian Carlstrom640a1042017-03-20 15:03:42 -07001612#endif
Elliott Hughes0d39c122012-06-06 16:41:17 -07001613 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001614 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001615 }
1616 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001617
1618 // Grab the scheduler stats for this thread.
1619 std::string scheduler_stats;
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001620 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001621 scheduler_stats.resize(scheduler_stats.size() - 1); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001622 } else {
1623 scheduler_stats = "0 0 0";
1624 }
1625
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001626 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001627 int utime = 0;
1628 int stime = 0;
1629 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001630 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001631
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001632 os << " | state=" << native_thread_state
1633 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001634 << " utm=" << utime
1635 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001636 << " core=" << task_cpu
1637 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001638 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001639 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1640 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1641 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001642 // Dump the held mutexes.
1643 os << " | held mutexes=";
1644 for (size_t i = 0; i < kLockLevelCount; ++i) {
1645 if (i != kMonitorLock) {
1646 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1647 if (mutex != nullptr) {
1648 os << " \"" << mutex->GetName() << "\"";
1649 if (mutex->IsReaderWriterMutex()) {
1650 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Ian Rogersa9d8c4c2014-07-07 21:38:36 -07001651 if (rw_mutex->GetExclusiveOwnerTid() == static_cast<uint64_t>(tid)) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001652 os << "(exclusive held)";
1653 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001654 os << "(shared held)";
1655 }
1656 }
1657 }
1658 }
1659 }
1660 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001661 }
1662}
1663
1664void Thread::DumpState(std::ostream& os) const {
1665 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001666}
1667
Ian Rogers0399dde2012-06-06 17:09:28 -07001668struct StackDumpVisitor : public StackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001669 StackDumpVisitor(std::ostream& os_in,
1670 Thread* thread_in,
1671 Context* context,
1672 bool can_allocate_in,
1673 bool check_suspended = true,
1674 bool dump_locks_in = true)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001675 REQUIRES_SHARED(Locks::mutator_lock_)
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001676 : StackVisitor(thread_in,
1677 context,
1678 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
1679 check_suspended),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001680 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001681 can_allocate(can_allocate_in),
1682 last_method(nullptr),
1683 last_line_number(0),
1684 repetition_count(0),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001685 frame_count(0),
1686 dump_locks(dump_locks_in) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001687
Ian Rogersbdb03912011-09-14 00:55:44 -07001688 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001689 if (frame_count == 0) {
1690 os << " (no managed stack frames)\n";
1691 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001692 }
1693
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001694 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001695 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07001696 if (m->IsRuntimeMethod()) {
Elliott Hughes530fa002012-03-12 11:44:49 -07001697 return true;
Ian Rogers90865722011-09-19 11:11:44 -07001698 }
Andreas Gampe542451c2016-07-26 09:02:02 -07001699 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Ian Rogers28ad40d2011-10-27 15:19:26 -07001700 const int kMaxRepetition = 3;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08001701 ObjPtr<mirror::Class> c = m->GetDeclaringClass();
1702 ObjPtr<mirror::DexCache> dex_cache = c->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001703 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001704 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001705 const DexFile* dex_file = dex_cache->GetDexFile();
1706 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001707 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001708 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001709 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001710 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001711 if (repetition_count >= kMaxRepetition) {
1712 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1713 }
1714 repetition_count = 0;
1715 last_line_number = line_number;
1716 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001717 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001718 if (repetition_count < kMaxRepetition) {
David Sehr709b0702016-10-13 09:12:37 -07001719 os << " at " << m->PrettyMethod(false);
Ian Rogers28ad40d2011-10-27 15:19:26 -07001720 if (m->IsNative()) {
1721 os << "(Native method)";
1722 } else {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001723 const char* source_file(m->GetDeclaringClassSourceFile());
Dave Allison0aded082013-11-07 13:15:11 -08001724 os << "(" << (source_file != nullptr ? source_file : "unavailable")
Brian Carlstrom2e450bf2013-09-06 15:39:46 -07001725 << ":" << line_number << ")";
Ian Rogers28ad40d2011-10-27 15:19:26 -07001726 }
1727 os << "\n";
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001728 if (frame_count == 0) {
Sebastien Hertz26f72862015-09-15 09:52:07 +02001729 Monitor::DescribeWait(os, GetThread());
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001730 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001731 if (can_allocate && dump_locks) {
Andreas Gampe956a5222014-08-16 13:41:10 -07001732 // Visit locks, but do not abort on errors. This would trigger a nested abort.
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001733 // Skip visiting locks if dump_locks is false as it would cause a bad_mutexes_held in
1734 // RegTypeCache::RegTypeCache due to thread_list_lock.
Andreas Gampe956a5222014-08-16 13:41:10 -07001735 Monitor::VisitLocks(this, DumpLockedObject, &os, false);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001736 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001737 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001738
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001739 ++frame_count;
Elliott Hughes530fa002012-03-12 11:44:49 -07001740 return true;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001741 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001742
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001743 static void DumpLockedObject(mirror::Object* o, void* context)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001744 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001745 std::ostream& os = *reinterpret_cast<std::ostream*>(context);
Ian Rogersd803bc72014-04-01 15:33:03 -07001746 os << " - locked ";
1747 if (o == nullptr) {
1748 os << "an unknown object";
1749 } else {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001750 if (kUseReadBarrier && Thread::Current()->GetIsGcMarking()) {
1751 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
1752 // may have not been flipped yet and "o" may be a from-space (stale) ref, in which case the
1753 // IdentityHashCode call below will crash. So explicitly mark/forward it here.
1754 o = ReadBarrier::Mark(o);
1755 }
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -07001756 if ((o->GetLockWord(false).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07001757 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
1758 // Getting the identity hashcode here would result in lock inflation and suspension of the
1759 // current thread, which isn't safe if this is the only runnable thread.
1760 os << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)", reinterpret_cast<intptr_t>(o),
David Sehr709b0702016-10-13 09:12:37 -07001761 o->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001762 } else {
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001763 // IdentityHashCode can cause thread suspension, which would invalidate o if it moved. So
1764 // we get the pretty type beofre we call IdentityHashCode.
David Sehr709b0702016-10-13 09:12:37 -07001765 const std::string pretty_type(o->PrettyTypeOf());
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001766 os << StringPrintf("<0x%08x> (a %s)", o->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001767 }
1768 }
1769 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001770 }
1771
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001772 std::ostream& os;
Ian Rogers0878d652013-04-18 17:38:35 -07001773 const bool can_allocate;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001774 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001775 int last_line_number;
1776 int repetition_count;
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001777 int frame_count;
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001778 const bool dump_locks;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001779};
1780
Ian Rogers33e95662013-05-20 20:29:14 -07001781static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001782 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07001783 ThreadState state = thread->GetState();
1784
1785 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
1786 if (state > kWaiting && state < kStarting) {
1787 return true;
1788 }
1789
1790 // In an Object.wait variant or Thread.sleep? That's not interesting.
1791 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
1792 return false;
1793 }
1794
Christopher Ferris2366f4e2014-09-19 17:23:59 -07001795 // Threads with no managed stack frames should be shown.
1796 const ManagedStack* managed_stack = thread->GetManagedStack();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001797 if (managed_stack == nullptr || (managed_stack->GetTopQuickFrame() == nullptr &&
1798 managed_stack->GetTopShadowFrame() == nullptr)) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07001799 return true;
1800 }
1801
Elliott Hughesaef701d2013-04-05 18:15:40 -07001802 // In some other native method? That's interesting.
1803 // We don't just check kNative because native methods will be in state kSuspended if they're
1804 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
1805 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07001806 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08001807 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07001808}
1809
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001810void Thread::DumpJavaStack(std::ostream& os, bool check_suspended, bool dump_locks) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001811 // If flip_function is not null, it means we have run a checkpoint
1812 // before the thread wakes up to execute the flip function and the
1813 // thread roots haven't been forwarded. So the following access to
1814 // the roots (locks or methods in the frames) would be bad. Run it
1815 // here. TODO: clean up.
1816 {
1817 Thread* this_thread = const_cast<Thread*>(this);
1818 Closure* flip_func = this_thread->GetFlipFunction();
1819 if (flip_func != nullptr) {
1820 flip_func->Run(this_thread);
1821 }
1822 }
1823
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001824 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
1825 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08001826 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
1827 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001828 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001829 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001830 bool have_exception = false;
1831 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001832 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001833 const_cast<Thread*>(this)->ClearException();
1834 have_exception = true;
1835 }
1836
Ian Rogers700a4022014-05-19 16:49:03 -07001837 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001838 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001839 !tls32_.throwing_OutOfMemoryError, check_suspended, dump_locks);
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001840 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001841
1842 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001843 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001844 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001845}
1846
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001847void Thread::DumpStack(std::ostream& os,
1848 bool dump_native_stack,
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08001849 BacktraceMap* backtrace_map,
1850 bool force_dump_stack) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07001851 // TODO: we call this code when dying but may not have suspended the thread ourself. The
1852 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
1853 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07001854 bool dump_for_abort = (gAborting > 0);
1855 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
1856 if (!kIsDebugBuild) {
1857 // We always want to dump the stack for an abort, however, there is no point dumping another
1858 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
1859 safe_to_dump = (safe_to_dump || dump_for_abort);
1860 }
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08001861 if (safe_to_dump || force_dump_stack) {
Ian Rogersf08e4732013-04-09 09:45:49 -07001862 // If we're currently in native code, dump that stack before dumping the managed stack.
Hiroshi Yamauchi13c16352017-01-31 10:15:08 -08001863 if (dump_native_stack && (dump_for_abort || force_dump_stack || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07001864 DumpKernelStack(os, GetTid(), " kernel: ", false);
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001865 ArtMethod* method =
1866 GetCurrentMethod(nullptr,
1867 /*check_suspended*/ !force_dump_stack,
1868 /*abort_on_error*/ !(dump_for_abort || force_dump_stack));
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001869 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07001870 }
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08001871 DumpJavaStack(os,
1872 /*check_suspended*/ !force_dump_stack,
1873 /*dump_locks*/ !force_dump_stack);
Ian Rogersf08e4732013-04-09 09:45:49 -07001874 } else {
1875 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08001876 }
Elliott Hughese27955c2011-08-26 15:21:24 -07001877}
1878
Elliott Hughesbe759c62011-09-08 19:38:21 -07001879void Thread::ThreadExitCallback(void* arg) {
1880 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001881 if (self->tls32_.thread_exit_check_count == 0) {
1882 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
1883 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07001884 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01001885#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001886 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
1887#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07001888 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001889#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07001890 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07001891 } else {
1892 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
1893 }
Carl Shapirob5573532011-07-12 18:22:59 -07001894}
1895
Elliott Hughesbe759c62011-09-08 19:38:21 -07001896void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07001897 CHECK(!is_started_);
1898 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001899 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07001900 // MutexLock to keep annotalysis happy.
1901 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001902 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07001903 // return garbage since (is_started_ == true) and
1904 // Thread::pthread_key_self_ is not yet initialized.
1905 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08001906 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001907 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
1908 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001909 }
1910
Carl Shapirob5573532011-07-12 18:22:59 -07001911 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08001912 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
1913 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07001914
1915 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08001916 if (pthread_getspecific(pthread_key_self_) != nullptr) {
1917 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07001918 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001919}
Carl Shapirob5573532011-07-12 18:22:59 -07001920
Elliott Hughes038a8062011-09-18 14:12:41 -07001921void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07001922 Runtime* runtime = Runtime::Current();
1923 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07001924
Elliott Hughes01158d72011-09-19 19:47:10 -07001925 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001926 ScopedObjectAccess soa(Thread::Current());
Ian Rogers365c1022012-06-22 15:05:28 -07001927 Thread::Current()->CreatePeer("main", false, runtime->GetMainThreadGroup());
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001928 Thread::Current()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05001929
Elliott Hughesaf8d15a2012-05-29 09:12:18 -07001930 Runtime::Current()->GetClassLinker()->RunRootClinits();
Carl Shapirob5573532011-07-12 18:22:59 -07001931}
1932
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001933void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07001934 CHECK(is_started_);
1935 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07001936 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07001937 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08001938 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07001939 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08001940 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07001941 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001942}
1943
Calin Juravleccd56952016-12-15 17:57:38 +00001944Thread::Thread(bool daemon)
1945 : tls32_(daemon),
1946 wait_monitor_(nullptr),
1947 interrupted_(false),
Andreas Gampe202f85a2017-02-06 10:23:26 -08001948 custom_tls_(nullptr),
Calin Juravleccd56952016-12-15 17:57:38 +00001949 can_call_into_java_(true) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001950 wait_mutex_ = new Mutex("a thread wait mutex");
1951 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001952 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
1953 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
1954
Roland Levillain33d69032015-06-18 18:20:59 +01001955 static_assert((sizeof(Thread) % 4) == 0U,
1956 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001957 tls32_.state_and_flags.as_struct.flags = 0;
1958 tls32_.state_and_flags.as_struct.state = kNative;
1959 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07001960 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08001961 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07001962 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001963 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08001964 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1965 tlsPtr_.active_suspend_barriers[i] = nullptr;
1966 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001967 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001968 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001969 tls32_.is_transitioning_to_runnable = false;
Elliott Hughesdcc24742011-09-07 14:02:44 -07001970}
1971
Elliott Hughes7dc51662012-05-16 14:48:43 -07001972bool Thread::IsStillStarting() const {
1973 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08001974 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001975 // 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 -07001976 // assigned fairly early on, and needs to be.
1977 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
1978 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07001979 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
1980 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07001981}
1982
Andreas Gamped9efea62014-07-21 22:56:08 -07001983void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07001984 CHECK(IsExceptionPending()) << "Pending exception expected.";
1985}
1986
1987void Thread::AssertPendingOOMException() const {
1988 AssertPendingException();
1989 auto* e = GetException();
1990 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
1991 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07001992}
1993
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001994void Thread::AssertNoPendingException() const {
1995 if (UNLIKELY(IsExceptionPending())) {
1996 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08001997 LOG(FATAL) << "No pending exception expected: " << GetException()->Dump();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001998 }
1999}
2000
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002001void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
2002 if (UNLIKELY(IsExceptionPending())) {
2003 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc114b5f2014-07-21 08:55:01 -07002004 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002005 << GetException()->Dump();
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002006 }
2007}
2008
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002009class MonitorExitVisitor : public SingleRootVisitor {
2010 public:
2011 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
2012
2013 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
2014 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
2015 OVERRIDE NO_THREAD_SAFETY_ANALYSIS {
2016 if (self_->HoldsLock(entered_monitor)) {
2017 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07002018 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002019 << " left locked by native thread "
2020 << *Thread::Current() << " which is detaching";
2021 entered_monitor->MonitorExit(self_);
2022 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002023 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002024
2025 private:
2026 Thread* const self_;
2027};
Elliott Hughes02b48d12011-09-07 17:15:51 -07002028
Elliott Hughesc0f09332012-03-26 13:27:06 -07002029void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07002030 Thread* self = this;
2031 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07002032
Ian Rogers68d8b422014-07-17 11:09:10 -07002033 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002034 {
2035 ScopedObjectAccess soa(self);
2036 MonitorExitVisitor visitor(self);
2037 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
2038 tlsPtr_.jni_env->monitors.VisitRoots(&visitor, RootInfo(kRootVMInternal));
2039 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002040 // Release locally held global references which releasing may require the mutator lock.
2041 if (tlsPtr_.jpeer != nullptr) {
2042 // If pthread_create fails we don't have a jni env here.
2043 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
2044 tlsPtr_.jpeer = nullptr;
2045 }
2046 if (tlsPtr_.class_loader_override != nullptr) {
2047 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
2048 tlsPtr_.class_loader_override = nullptr;
2049 }
2050 }
2051
Ian Rogersdd7624d2014-03-14 17:43:00 -07002052 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002053 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07002054 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08002055 HandleUncaughtExceptions(soa);
2056 RemoveFromThreadGroup(soa);
Elliott Hughes534da072012-03-27 15:17:42 -07002057
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07002058 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002059 if (Runtime::Current()->IsActiveTransaction()) {
Andreas Gampe08883de2016-11-08 13:20:52 -08002060 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002061 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002062 } else {
Andreas Gampe08883de2016-11-08 13:20:52 -08002063 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_nativePeer)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002064 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002065 }
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00002066 Runtime* runtime = Runtime::Current();
2067 if (runtime != nullptr) {
Andreas Gampeac30fa22017-01-18 21:02:36 -08002068 runtime->GetRuntimeCallbacks()->ThreadDeath(self);
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00002069 }
2070
Elliott Hughes02b48d12011-09-07 17:15:51 -07002071
Ian Rogerscfaa4552012-11-26 21:00:08 -08002072 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
2073 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002074 ObjPtr<mirror::Object> lock =
Andreas Gampe08883de2016-11-08 13:20:52 -08002075 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07002076 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08002077 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002078 StackHandleScope<1> hs(self);
2079 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07002080 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07002081 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07002082 }
Ian Rogers68d8b422014-07-17 11:09:10 -07002083 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07002084 }
Ian Rogers120f1c72012-09-28 17:17:10 -07002085
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002086 {
2087 ScopedObjectAccess soa(self);
2088 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07002089 if (kUseReadBarrier) {
2090 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
2091 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08002092 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07002093}
Elliott Hughes02b48d12011-09-07 17:15:51 -07002094
Elliott Hughesc0f09332012-03-26 13:27:06 -07002095Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07002096 CHECK(tlsPtr_.class_loader_override == nullptr);
2097 CHECK(tlsPtr_.jpeer == nullptr);
2098 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002099 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002100 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002101 delete tlsPtr_.jni_env;
2102 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002103 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002104 CHECK_NE(GetState(), kRunnable);
Hiroshi Yamauchi30493242016-11-03 13:06:52 -07002105 CHECK(!ReadFlag(kCheckpointRequest));
2106 CHECK(!ReadFlag(kEmptyCheckpointRequest));
Mathieu Chartier952e1e32016-06-13 14:04:02 -07002107 CHECK(tlsPtr_.checkpoint_function == nullptr);
2108 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08002109 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07002110 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08002111
Sebastien Hertz07474662015-08-25 15:12:33 +00002112 // Make sure we processed all deoptimization requests.
2113 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07002114 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
2115 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00002116
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002117 // We may be deleting a still born thread.
2118 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07002119
2120 delete wait_cond_;
2121 delete wait_mutex_;
2122
Ian Rogersdd7624d2014-03-14 17:43:00 -07002123 if (tlsPtr_.long_jump_context != nullptr) {
2124 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08002125 }
Elliott Hughes475fc232011-10-25 15:00:35 -07002126
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07002127 if (initialized) {
2128 CleanupCpu();
2129 }
2130
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002131 if (tlsPtr_.single_step_control != nullptr) {
2132 delete tlsPtr_.single_step_control;
2133 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002134 delete tlsPtr_.instrumentation_stack;
2135 delete tlsPtr_.name;
Nicolas Geoffray340dafa2016-11-18 16:03:10 +00002136 delete tlsPtr_.deps_or_stack_trace_sample.stack_trace_sample;
Elliott Hughesd8af1592012-04-16 20:40:15 -07002137
Ian Rogers68d8b422014-07-17 11:09:10 -07002138 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07002139
Elliott Hughesd8af1592012-04-16 20:40:15 -07002140 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07002141}
2142
Ian Rogerscfaa4552012-11-26 21:00:08 -08002143void Thread::HandleUncaughtExceptions(ScopedObjectAccess& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002144 if (!IsExceptionPending()) {
2145 return;
2146 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002147 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002148 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07002149
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002150 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002151 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
2152 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002153
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002154 // Call the Thread instance's dispatchUncaughtException(Throwable)
2155 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
2156 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
2157 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002158
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01002159 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07002160 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002161}
2162
Ian Rogerscfaa4552012-11-26 21:00:08 -08002163void Thread::RemoveFromThreadGroup(ScopedObjectAccess& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002164 // this.group.removeThread(this);
2165 // group can be null if we're in the compiler or a test.
Andreas Gampe08883de2016-11-08 13:20:52 -08002166 ObjPtr<mirror::Object> ogroup = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002167 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08002168 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08002169 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002170 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08002171 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002172 tlsPtr_.jni_env->CallVoidMethod(group.get(),
2173 WellKnownClasses::java_lang_ThreadGroup_removeThread,
2174 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07002175 }
2176}
2177
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002178bool Thread::HandleScopeContains(jobject obj) const {
2179 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08002180 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002181 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002182 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07002183 return true;
2184 }
2185 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002186 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
2187 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07002188}
2189
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002190void Thread::HandleScopeVisitRoots(RootVisitor* visitor, uint32_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07002191 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
2192 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07002193 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
2194 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07002195 }
2196}
2197
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002198ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08002199 if (obj == nullptr) {
2200 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002201 }
2202 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002203 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07002204 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07002205 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002206 // The "kinds" below are sorted by the frequency we expect to encounter them.
2207 if (kind == kLocal) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002208 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07002209 // Local references do not need a read barrier.
2210 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002211 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002212 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002213 // Check if this is a local reference in the handle scope.
2214 if (LIKELY(HandleScopeContains(obj))) {
2215 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08002216 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07002217 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07002218 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -07002219 tlsPtr_.jni_env->vm->JniAbortF(nullptr, "use of invalid jobject %p", obj);
2220 expect_null = true;
2221 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07002222 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002223 } else if (kind == kGlobal) {
Mathieu Chartier30b5e272015-09-01 11:14:34 -07002224 result = tlsPtr_.jni_env->vm->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002225 } else {
2226 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers68d8b422014-07-17 11:09:10 -07002227 result = tlsPtr_.jni_env->vm->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07002228 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002229 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07002230 expect_null = true;
2231 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07002232 }
Ian Rogers408f79a2011-08-23 18:22:33 -07002233 }
2234
Ian Rogersc0542af2014-09-03 16:16:56 -07002235 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers68d8b422014-07-17 11:09:10 -07002236 tlsPtr_.jni_env->vm->JniAbortF(nullptr, "use of deleted %s %p",
2237 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07002238 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002239 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07002240}
2241
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002242bool Thread::IsJWeakCleared(jweak obj) const {
2243 CHECK(obj != nullptr);
2244 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07002245 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002246 CHECK_EQ(kind, kWeakGlobal);
2247 return tlsPtr_.jni_env->vm->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
2248}
2249
Ian Rogers81d425b2012-09-27 16:03:43 -07002250// Implements java.lang.Thread.interrupted.
2251bool Thread::Interrupted() {
Ian Rogers50b35e22012-10-04 10:09:15 -07002252 MutexLock mu(Thread::Current(), *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002253 bool interrupted = IsInterruptedLocked();
2254 SetInterruptedLocked(false);
Ian Rogers81d425b2012-09-27 16:03:43 -07002255 return interrupted;
2256}
2257
2258// Implements java.lang.Thread.isInterrupted.
2259bool Thread::IsInterrupted() {
Ian Rogers50b35e22012-10-04 10:09:15 -07002260 MutexLock mu(Thread::Current(), *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002261 return IsInterruptedLocked();
Ian Rogers81d425b2012-09-27 16:03:43 -07002262}
2263
Ian Rogersdd7624d2014-03-14 17:43:00 -07002264void Thread::Interrupt(Thread* self) {
Ian Rogersc604d732012-10-14 16:09:54 -07002265 MutexLock mu(self, *wait_mutex_);
Ian Rogers81d425b2012-09-27 16:03:43 -07002266 if (interrupted_) {
2267 return;
2268 }
2269 interrupted_ = true;
Ian Rogersc604d732012-10-14 16:09:54 -07002270 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002271}
2272
2273void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002274 Thread* self = Thread::Current();
2275 MutexLock mu(self, *wait_mutex_);
2276 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002277}
2278
Ian Rogersc604d732012-10-14 16:09:54 -07002279void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002280 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002281 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002282 }
2283}
2284
Ian Rogers68d8b422014-07-17 11:09:10 -07002285void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2286 if (tlsPtr_.class_loader_override != nullptr) {
2287 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2288 }
2289 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2290}
2291
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002292using ArtMethodDexPcPair = std::pair<ArtMethod*, uint32_t>;
2293
2294// Counts the stack trace depth and also fetches the first max_saved_frames frames.
2295class FetchStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002296 public:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002297 explicit FetchStackTraceVisitor(Thread* thread,
2298 ArtMethodDexPcPair* saved_frames = nullptr,
2299 size_t max_saved_frames = 0)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002300 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002301 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002302 saved_frames_(saved_frames),
2303 max_saved_frames_(max_saved_frames) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002304
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002305 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002306 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002307 // Note we also skip the frame if it doesn't have a method (namely the callee
2308 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002309 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002310 if (skipping_ && !m->IsRuntimeMethod() &&
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002311 !mirror::Throwable::GetJavaLangThrowable()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002312 skipping_ = false;
2313 }
2314 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002315 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002316 if (depth_ < max_saved_frames_) {
2317 saved_frames_[depth_].first = m;
2318 saved_frames_[depth_].second = m->IsProxyMethod() ? DexFile::kDexNoIndex : GetDexPc();
2319 }
Ian Rogers6b0870d2011-12-15 19:38:12 -08002320 ++depth_;
2321 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002322 } else {
2323 ++skip_depth_;
2324 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002325 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002326 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002327
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002328 uint32_t GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002329 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002330 }
2331
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002332 uint32_t GetSkipDepth() const {
Elliott Hughes29f27422011-09-18 16:02:18 -07002333 return skip_depth_;
2334 }
2335
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002336 private:
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002337 uint32_t depth_ = 0;
2338 uint32_t skip_depth_ = 0;
2339 bool skipping_ = true;
2340 ArtMethodDexPcPair* saved_frames_;
2341 const size_t max_saved_frames_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002342
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002343 DISALLOW_COPY_AND_ASSIGN(FetchStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002344};
2345
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002346template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002347class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002348 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002349 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002350 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2351 self_(self),
2352 skip_depth_(skip_depth),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002353 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002354
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002355 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002356 // Allocate method trace as an object array where the first element is a pointer array that
2357 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2358 // class of the ArtMethod pointers.
2359 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2360 StackHandleScope<1> hs(self_);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002361 ObjPtr<mirror::Class> array_class = class_linker->GetClassRoot(ClassLinker::kObjectArrayClass);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002362 // The first element is the methods and dex pc array, the other elements are declaring classes
2363 // for the methods to ensure classes in the stack trace don't get unloaded.
2364 Handle<mirror::ObjectArray<mirror::Object>> trace(
2365 hs.NewHandle(
2366 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002367 if (trace == nullptr) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002368 // Acquire uninterruptible_ in all paths.
2369 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002370 self_->AssertPendingOOMException();
2371 return false;
2372 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002373 ObjPtr<mirror::PointerArray> methods_and_pcs =
2374 class_linker->AllocPointerArray(self_, depth * 2);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002375 const char* last_no_suspend_cause =
2376 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2377 if (methods_and_pcs == nullptr) {
2378 self_->AssertPendingOOMException();
2379 return false;
2380 }
2381 trace->Set(0, methods_and_pcs);
2382 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002383 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002384 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002385 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002386 }
2387
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002388 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2389 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002390 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002391
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002392 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002393 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002394 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002395 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002396 if (skip_depth_ > 0) {
2397 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002398 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002399 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002400 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002401 if (m->IsRuntimeMethod()) {
2402 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002403 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002404 AddFrame(m, m->IsProxyMethod() ? DexFile::kDexNoIndex : GetDexPc());
2405 return true;
2406 }
2407
2408 void AddFrame(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002409 ObjPtr<mirror::PointerArray> trace_methods_and_pcs = GetTraceMethodsAndPCs();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002410 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, method, pointer_size_);
Mathieu Chartier910e8272015-09-30 09:24:22 -07002411 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2412 trace_methods_and_pcs->GetLength() / 2 + count_,
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002413 dex_pc,
Mathieu Chartier910e8272015-09-30 09:24:22 -07002414 pointer_size_);
2415 // Save the declaring class of the method to ensure that the declaring classes of the methods
2416 // do not get unloaded while the stack trace is live.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002417 trace_->Set(count_ + 1, method->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002418 ++count_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002419 }
2420
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002421 ObjPtr<mirror::PointerArray> GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
2422 return ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(trace_->Get(0)));
Mathieu Chartier910e8272015-09-30 09:24:22 -07002423 }
2424
2425 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002426 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002427 }
2428
2429 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002430 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002431 // How many more frames to skip.
2432 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002433 // Current position down stack trace.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002434 uint32_t count_ = 0;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002435 // An object array where the first element is a pointer array that contains the ArtMethod
2436 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2437 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2438 // the i'th frame.
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002439 mirror::ObjectArray<mirror::Object>* trace_ = nullptr;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002440 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002441 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002442
2443 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002444};
2445
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002446template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002447jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002448 // Compute depth of stack, save frames if possible to avoid needing to recompute many.
2449 constexpr size_t kMaxSavedFrames = 256;
2450 std::unique_ptr<ArtMethodDexPcPair[]> saved_frames(new ArtMethodDexPcPair[kMaxSavedFrames]);
2451 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this),
2452 &saved_frames[0],
2453 kMaxSavedFrames);
Ian Rogers0399dde2012-06-06 17:09:28 -07002454 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002455 const uint32_t depth = count_visitor.GetDepth();
2456 const uint32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002457
Ian Rogers1f539342012-10-03 21:09:42 -07002458 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002459 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2460 const_cast<Thread*>(this),
2461 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002462 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002463 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002464 }
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002465 // If we saved all of the frames we don't even need to do the actual stack walk. This is faster
2466 // than doing the stack walk twice.
2467 if (depth < kMaxSavedFrames) {
2468 for (size_t i = 0; i < depth; ++i) {
2469 build_trace_visitor.AddFrame(saved_frames[i].first, saved_frames[i].second);
2470 }
2471 } else {
2472 build_trace_visitor.WalkStack();
2473 }
2474
Mathieu Chartier910e8272015-09-30 09:24:22 -07002475 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002476 if (kIsDebugBuild) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002477 ObjPtr<mirror::PointerArray> trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002478 // Second half of trace_methods is dex PCs.
2479 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2480 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002481 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2482 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002483 }
2484 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002485 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002486}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002487template jobject Thread::CreateInternalStackTrace<false>(
2488 const ScopedObjectAccessAlreadyRunnable& soa) const;
2489template jobject Thread::CreateInternalStackTrace<true>(
2490 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002491
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002492bool Thread::IsExceptionThrownByCurrentMethod(ObjPtr<mirror::Throwable> exception) const {
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002493 // Only count the depth since we do not pass a stack frame array as an argument.
2494 FetchStackTraceVisitor count_visitor(const_cast<Thread*>(this));
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002495 count_visitor.WalkStack();
Mathieu Chartier65b8bb22017-02-01 11:03:50 -08002496 return count_visitor.GetDepth() == static_cast<uint32_t>(exception->GetStackDepth());
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002497}
2498
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002499jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002500 const ScopedObjectAccessAlreadyRunnable& soa,
2501 jobject internal,
2502 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002503 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002504 // Decode the internal stack trace into the depth, method trace and PC trace.
2505 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002506 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002507 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002508
Mathieu Chartier910e8272015-09-30 09:24:22 -07002509 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002510
Elliott Hughes01158d72011-09-19 19:47:10 -07002511 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002512
Dave Allison0aded082013-11-07 13:15:11 -08002513 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002514 // Reuse the array we were given.
2515 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002516 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002517 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002518 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002519 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002520 } else {
2521 // Create java_trace array and place in local reference table
Mathieu Chartier530825b2013-09-25 17:56:49 -07002522 mirror::ObjectArray<mirror::StackTraceElement>* java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002523 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002524 if (java_traces == nullptr) {
2525 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002526 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002527 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002528 }
2529
Dave Allison0aded082013-11-07 13:15:11 -08002530 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002531 *stack_depth = depth;
2532 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002533
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002534 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002535 ObjPtr<mirror::ObjectArray<mirror::Object>> decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002536 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002537 // Methods and dex PC trace is element 0.
2538 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002539 ObjPtr<mirror::PointerArray> const method_trace =
2540 ObjPtr<mirror::PointerArray>::DownCast(MakeObjPtr(decoded_traces->Get(0)));
Ian Rogersaaa20802011-09-11 21:47:37 -07002541 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002542 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002543 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002544 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Jeff Hao228d6b82013-12-03 15:00:05 -08002545 int32_t line_number;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002546 StackHandleScope<3> hs(soa.Self());
2547 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2548 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
Jeff Hao228d6b82013-12-03 15:00:05 -08002549 if (method->IsProxyMethod()) {
2550 line_number = -1;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002551 class_name_object.Assign(method->GetDeclaringClass()->GetName());
Jeff Hao228d6b82013-12-03 15:00:05 -08002552 // source_name_object intentionally left null for proxy methods
2553 } else {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002554 line_number = method->GetLineNumFromDexPC(dex_pc);
Jeff Hao228d6b82013-12-03 15:00:05 -08002555 // Allocate element, potentially triggering GC
2556 // TODO: reuse class_name_object via Class::name_?
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002557 const char* descriptor = method->GetDeclaringClassDescriptor();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002558 CHECK(descriptor != nullptr);
Jeff Hao228d6b82013-12-03 15:00:05 -08002559 std::string class_name(PrettyDescriptor(descriptor));
Mathieu Chartiere401d142015-04-22 13:56:20 -07002560 class_name_object.Assign(
2561 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002562 if (class_name_object == nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002563 soa.Self()->AssertPendingOOMException();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002564 return nullptr;
Jeff Hao228d6b82013-12-03 15:00:05 -08002565 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002566 const char* source_file = method->GetDeclaringClassSourceFile();
Nicolas Geoffray374cd2c2017-02-15 15:38:52 +00002567 if (line_number == -1) {
2568 // Make the line_number field of StackTraceElement hold the dex pc.
2569 // source_name_object is intentionally left null if we failed to map the dex pc to
2570 // a line number (most probably because there is no debug info). See b/30183883.
2571 line_number = dex_pc;
2572 } else {
2573 if (source_file != nullptr) {
2574 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2575 if (source_name_object == nullptr) {
2576 soa.Self()->AssertPendingOOMException();
2577 return nullptr;
2578 }
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002579 }
Jeff Hao228d6b82013-12-03 15:00:05 -08002580 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -07002581 }
Andreas Gampe542451c2016-07-26 09:02:02 -07002582 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
Dave Allison0aded082013-11-07 13:15:11 -08002583 CHECK(method_name != nullptr);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002584 Handle<mirror::String> method_name_object(
2585 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002586 if (method_name_object == nullptr) {
Dave Allison0aded082013-11-07 13:15:11 -08002587 return nullptr;
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08002588 }
Nicolas Geoffray374cd2c2017-02-15 15:38:52 +00002589 ObjPtr<mirror::StackTraceElement> obj = mirror::StackTraceElement::Alloc(soa.Self(),
2590 class_name_object,
2591 method_name_object,
2592 source_name_object,
2593 line_number);
Dave Allison0aded082013-11-07 13:15:11 -08002594 if (obj == nullptr) {
2595 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002596 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002597 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002598 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002599 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002600 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002601}
2602
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002603void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002604 va_list args;
2605 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002606 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002607 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07002608}
2609
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002610void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002611 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07002612 std::string msg;
2613 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002614 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07002615}
Elliott Hughes37f7a402011-08-22 18:56:01 -07002616
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002617void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002618 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002619 // Callers should either clear or call ThrowNewWrappedException.
2620 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002621 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07002622}
2623
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002624static ObjPtr<mirror::ClassLoader> GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002625 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002626 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002627 return method != nullptr
2628 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002629 : nullptr;
2630}
2631
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002632void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002633 const char* msg) {
2634 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07002635 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002636 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002637 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002638 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08002639 ClearException();
2640 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002641 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002642 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002643 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002644 if (UNLIKELY(exception_class == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07002645 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08002646 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07002647 return;
2648 }
Ian Rogers62d6c772013-02-27 08:32:07 -08002649
Ian Rogers7b078e82014-09-10 14:44:24 -07002650 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
2651 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002652 DCHECK(IsExceptionPending());
2653 return;
2654 }
2655 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002656 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07002657 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08002658
Mathieu Chartier590fee92013-09-13 13:46:47 -07002659 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Andreas Gampefa4333d2017-02-14 11:10:34 -08002660 if (exception == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002661 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryError());
Mathieu Chartier590fee92013-09-13 13:46:47 -07002662 return;
2663 }
2664
Ian Rogers62d6c772013-02-27 08:32:07 -08002665 // Choose an appropriate constructor and set up the arguments.
2666 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07002667 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002668 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002669 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07002670 msg_string.reset(
2671 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08002672 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002673 CHECK(IsExceptionPending()); // OOME.
2674 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08002675 }
Dave Allison0aded082013-11-07 13:15:11 -08002676 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002677 signature = "(Ljava/lang/String;)V";
2678 } else {
2679 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
2680 }
2681 } else {
Dave Allison0aded082013-11-07 13:15:11 -08002682 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002683 signature = "()V";
2684 } else {
2685 signature = "(Ljava/lang/Throwable;)V";
2686 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08002687 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002688 ArtMethod* exception_init_method =
2689 exception_class->FindDeclaredDirectMethod("<init>", signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08002690
Dave Allison0aded082013-11-07 13:15:11 -08002691 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08002692 << PrettyDescriptor(exception_class_descriptor);
2693
2694 if (UNLIKELY(!runtime->IsStarted())) {
2695 // Something is trying to throw an exception without a started runtime, which is the common
2696 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
2697 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08002698 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002699 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08002700 }
Dave Allison0aded082013-11-07 13:15:11 -08002701 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002702 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08002703 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07002704 ScopedLocalRef<jobject> trace(GetJniEnv(),
2705 Runtime::Current()->IsActiveTransaction()
2706 ? CreateInternalStackTrace<true>(soa)
2707 : CreateInternalStackTrace<false>(soa));
2708 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002709 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07002710 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002711 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08002712 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07002713 jvalue jv_args[2];
2714 size_t i = 0;
2715
Dave Allison0aded082013-11-07 13:15:11 -08002716 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07002717 jv_args[i].l = msg_string.get();
2718 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08002719 }
Dave Allison0aded082013-11-07 13:15:11 -08002720 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07002721 jv_args[i].l = cause.get();
2722 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08002723 }
Jeff Hao39b6c242015-05-19 20:30:23 -07002724 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
Andreas Gampe13b27842016-11-07 16:48:23 -08002725 InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08002726 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002727 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08002728 }
Elliott Hughes30646832011-10-13 16:59:46 -07002729 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002730}
2731
Elliott Hughes2ced6a52011-10-16 18:44:48 -07002732void Thread::ThrowOutOfMemoryError(const char* msg) {
Andreas Gampee4301ff2015-02-17 19:25:29 -08002733 LOG(WARNING) << StringPrintf("Throwing OutOfMemoryError \"%s\"%s",
Ian Rogersdd7624d2014-03-14 17:43:00 -07002734 msg, (tls32_.throwing_OutOfMemoryError ? " (recursive case)" : ""));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002735 if (!tls32_.throwing_OutOfMemoryError) {
2736 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002737 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002738 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07002739 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002740 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002741 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryError());
Elliott Hughes418dfe72011-10-06 18:56:27 -07002742 }
Elliott Hughes79082e32011-08-25 12:07:32 -07002743}
2744
Elliott Hughes498508c2011-10-17 14:58:22 -07002745Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002746 return Thread::Current();
2747}
2748
2749void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002750 std::ostringstream ss;
2751 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08002752 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002753 // log to stderr for debugging command line processes
2754 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002755#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002756 // log to logcat for debugging frameworks processes
2757 LOG(INFO) << str;
2758#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002759}
2760
Ian Rogersdd7624d2014-03-14 17:43:00 -07002761// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07002762template
2763void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
2764template
2765void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07002766
Andreas Gampe542451c2016-07-26 09:02:02 -07002767template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07002768void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
2769#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07002770 if (offset == (x).Uint32Value()) { \
2771 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07002772 return; \
2773 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002774 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
2775 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
2776 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
2777 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
2778 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
2779 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
2780 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
2781 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
2782 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07002783 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002784 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07002785 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07002786#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07002787
Ian Rogersdd7624d2014-03-14 17:43:00 -07002788#define JNI_ENTRY_POINT_INFO(x) \
2789 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
2790 os << #x; \
2791 return; \
2792 }
2793 JNI_ENTRY_POINT_INFO(pDlsymLookup)
2794#undef JNI_ENTRY_POINT_INFO
2795
Ian Rogersdd7624d2014-03-14 17:43:00 -07002796#define QUICK_ENTRY_POINT_INFO(x) \
2797 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
2798 os << #x; \
2799 return; \
2800 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002801 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
Nicolas Geoffrayb048cb72017-01-23 22:50:24 +00002802 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved8)
2803 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved16)
2804 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved32)
2805 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved64)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002806 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
2807 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
Nicolas Geoffray0d3998b2017-01-12 15:35:12 +00002808 QUICK_ENTRY_POINT_INFO(pAllocObjectWithChecks)
Jeff Hao848f70a2014-01-15 13:49:50 -08002809 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
2810 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
2811 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002812 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
Mathieu Chartierb99f4d62016-11-07 16:17:26 -08002813 QUICK_ENTRY_POINT_INFO(pCheckInstanceOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002814 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
2815 QUICK_ENTRY_POINT_INFO(pInitializeTypeAndVerifyAccess)
2816 QUICK_ENTRY_POINT_INFO(pInitializeType)
2817 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07002818 QUICK_ENTRY_POINT_INFO(pSet8Instance)
2819 QUICK_ENTRY_POINT_INFO(pSet8Static)
2820 QUICK_ENTRY_POINT_INFO(pSet16Instance)
2821 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002822 QUICK_ENTRY_POINT_INFO(pSet32Instance)
2823 QUICK_ENTRY_POINT_INFO(pSet32Static)
2824 QUICK_ENTRY_POINT_INFO(pSet64Instance)
2825 QUICK_ENTRY_POINT_INFO(pSet64Static)
2826 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
2827 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07002828 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
2829 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
2830 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
2831 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
2832 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
2833 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
2834 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
2835 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002836 QUICK_ENTRY_POINT_INFO(pGet32Instance)
2837 QUICK_ENTRY_POINT_INFO(pGet32Static)
2838 QUICK_ENTRY_POINT_INFO(pGet64Instance)
2839 QUICK_ENTRY_POINT_INFO(pGet64Static)
2840 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
2841 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002842 QUICK_ENTRY_POINT_INFO(pAputObject)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002843 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
2844 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
2845 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
2846 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
2847 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
2848 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
2849 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
2850 QUICK_ENTRY_POINT_INFO(pLockObject)
2851 QUICK_ENTRY_POINT_INFO(pUnlockObject)
2852 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
2853 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
2854 QUICK_ENTRY_POINT_INFO(pCmplDouble)
2855 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04002856 QUICK_ENTRY_POINT_INFO(pCos)
2857 QUICK_ENTRY_POINT_INFO(pSin)
2858 QUICK_ENTRY_POINT_INFO(pAcos)
2859 QUICK_ENTRY_POINT_INFO(pAsin)
2860 QUICK_ENTRY_POINT_INFO(pAtan)
2861 QUICK_ENTRY_POINT_INFO(pAtan2)
2862 QUICK_ENTRY_POINT_INFO(pCbrt)
2863 QUICK_ENTRY_POINT_INFO(pCosh)
2864 QUICK_ENTRY_POINT_INFO(pExp)
2865 QUICK_ENTRY_POINT_INFO(pExpm1)
2866 QUICK_ENTRY_POINT_INFO(pHypot)
2867 QUICK_ENTRY_POINT_INFO(pLog)
2868 QUICK_ENTRY_POINT_INFO(pLog10)
2869 QUICK_ENTRY_POINT_INFO(pNextAfter)
2870 QUICK_ENTRY_POINT_INFO(pSinh)
2871 QUICK_ENTRY_POINT_INFO(pTan)
2872 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002873 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002874 QUICK_ENTRY_POINT_INFO(pL2d)
2875 QUICK_ENTRY_POINT_INFO(pFmodf)
2876 QUICK_ENTRY_POINT_INFO(pL2f)
2877 QUICK_ENTRY_POINT_INFO(pD2iz)
2878 QUICK_ENTRY_POINT_INFO(pF2iz)
2879 QUICK_ENTRY_POINT_INFO(pIdivmod)
2880 QUICK_ENTRY_POINT_INFO(pD2l)
2881 QUICK_ENTRY_POINT_INFO(pF2l)
2882 QUICK_ENTRY_POINT_INFO(pLdiv)
2883 QUICK_ENTRY_POINT_INFO(pLmod)
2884 QUICK_ENTRY_POINT_INFO(pLmul)
2885 QUICK_ENTRY_POINT_INFO(pShlLong)
2886 QUICK_ENTRY_POINT_INFO(pShrLong)
2887 QUICK_ENTRY_POINT_INFO(pUshrLong)
2888 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002889 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
2890 QUICK_ENTRY_POINT_INFO(pMemcpy)
2891 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
2892 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
2893 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
2894 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
2895 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
2896 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
2897 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
2898 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Orion Hodsonac141392017-01-13 11:53:47 +00002899 QUICK_ENTRY_POINT_INFO(pInvokePolymorphic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002900 QUICK_ENTRY_POINT_INFO(pTestSuspend)
2901 QUICK_ENTRY_POINT_INFO(pDeliverException)
2902 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
2903 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002904 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
2905 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07002906 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07002907 QUICK_ENTRY_POINT_INFO(pA64Load)
2908 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08002909 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
2910 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
2911 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
2912 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
2913 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
2914 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
2915 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
2916 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
2917 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
2918 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
2919 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
2920 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
2921 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
2922 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
2923 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
2924 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07002925 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01002926 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
2927 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
2928 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
2929 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
2930 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
2931 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
2932 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
2933 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
2934 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
2935 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
2936 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
2937 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
2938 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
2939 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
2940 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
2941 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
2942 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
2943 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
2944 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
2945 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
2946 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
2947 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
2948 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
2949 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
2950 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
2951 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
2952 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
2953 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
2954 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
2955 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07002956 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00002957 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07002958
2959 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
2960 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002961#undef QUICK_ENTRY_POINT_INFO
2962
Elliott Hughes98e20172012-04-24 15:38:13 -07002963 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07002964}
2965
jeffhao94d6df42012-11-26 16:02:12 -08002966void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08002967 // Get exception from thread.
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002968 ObjPtr<mirror::Throwable> exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08002969 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002970 if (exception == GetDeoptimizationException()) {
2971 artDeoptimize(this);
2972 UNREACHABLE();
2973 }
2974
2975 // This is a real exception: let the instrumentation know about it.
2976 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
2977 if (instrumentation->HasExceptionCaughtListeners() &&
2978 IsExceptionThrownByCurrentMethod(exception)) {
2979 // Instrumentation may cause GC so keep the exception object safe.
2980 StackHandleScope<1> hs(this);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08002981 HandleWrapperObjPtr<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
2982 instrumentation->ExceptionCaughtEvent(this, exception.Ptr());
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002983 }
2984 // Does instrumentation need to deoptimize the stack?
2985 // Note: we do this *after* reporting the exception to instrumentation in case it
2986 // now requires deoptimization. It may happen if a debugger is attached and requests
2987 // new events (single-step, breakpoint, ...) when the exception is reported.
2988 if (Dbg::IsForcedInterpreterNeededForException(this)) {
2989 NthCallerVisitor visitor(this, 0, false);
2990 visitor.WalkStack();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00002991 if (Runtime::Current()->IsAsyncDeoptimizeable(visitor.caller_pc)) {
Sebastien Hertz520633b2015-09-08 17:03:36 +02002992 // Save the exception into the deoptimization context so it can be restored
2993 // before entering the interpreter.
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01002994 PushDeoptimizationContext(
2995 JValue(), /*is_reference */ false, /* from_code */ false, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002996 artDeoptimize(this);
2997 UNREACHABLE();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +00002998 } else {
2999 LOG(WARNING) << "Got a deoptimization request on un-deoptimizable method "
3000 << visitor.caller->PrettyMethod();
Sebastien Hertz520633b2015-09-08 17:03:36 +02003001 }
3002 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003003
Ian Rogers28ad40d2011-10-27 15:19:26 -07003004 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08003005 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07003006 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07003007 QuickExceptionHandler exception_handler(this, false);
3008 exception_handler.FindCatch(exception);
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003009 exception_handler.UpdateInstrumentationStack();
3010 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003011}
3012
Ian Rogersbdb03912011-09-14 00:55:44 -07003013Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003014 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08003015 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07003016 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07003017 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003018 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08003019 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003020 }
Ian Rogersbdb03912011-09-14 00:55:44 -07003021 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07003022}
3023
Andreas Gampe4a8c3fa2014-07-16 22:20:31 -07003024// Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
3025// so we don't abort in a special situation (thinlocked monitor) when dumping the Java stack.
Ian Rogerse0dcd462014-03-08 15:21:04 -08003026struct CurrentMethodVisitor FINAL : public StackVisitor {
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003027 CurrentMethodVisitor(Thread* thread, Context* context, bool check_suspended, bool abort_on_error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003028 REQUIRES_SHARED(Locks::mutator_lock_)
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003029 : StackVisitor(thread,
3030 context,
3031 StackVisitor::StackWalkKind::kIncludeInlinedFrames,
3032 check_suspended),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003033 this_object_(nullptr),
3034 method_(nullptr),
3035 dex_pc_(0),
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07003036 abort_on_error_(abort_on_error) {}
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003037 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003038 ArtMethod* m = GetMethod();
Ian Rogers62d6c772013-02-27 08:32:07 -08003039 if (m->IsRuntimeMethod()) {
3040 // Continue if this is a runtime method.
3041 return true;
Ian Rogers0399dde2012-06-06 17:09:28 -07003042 }
Dave Allison0aded082013-11-07 13:15:11 -08003043 if (context_ != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003044 this_object_ = GetThisObject();
3045 }
3046 method_ = m;
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07003047 dex_pc_ = GetDexPc(abort_on_error_);
Ian Rogers62d6c772013-02-27 08:32:07 -08003048 return false;
3049 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003050 ObjPtr<mirror::Object> this_object_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003051 ArtMethod* method_;
Ian Rogers62d6c772013-02-27 08:32:07 -08003052 uint32_t dex_pc_;
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07003053 const bool abort_on_error_;
Ian Rogers62d6c772013-02-27 08:32:07 -08003054};
Ian Rogers0399dde2012-06-06 17:09:28 -07003055
Hiroshi Yamauchi02f365f2017-02-03 15:06:00 -08003056ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc,
3057 bool check_suspended,
3058 bool abort_on_error) const {
3059 CurrentMethodVisitor visitor(const_cast<Thread*>(this),
3060 nullptr,
3061 check_suspended,
3062 abort_on_error);
Ian Rogers0399dde2012-06-06 17:09:28 -07003063 visitor.WalkStack(false);
Dave Allison0aded082013-11-07 13:15:11 -08003064 if (dex_pc != nullptr) {
Ian Rogers0399dde2012-06-06 17:09:28 -07003065 *dex_pc = visitor.dex_pc_;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07003066 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003067 return visitor.method_;
jeffhao33dc7712011-11-09 17:54:24 -08003068}
3069
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003070bool Thread::HoldsLock(ObjPtr<mirror::Object> object) const {
3071 return object != nullptr && object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07003072}
3073
Ian Rogers40e3bac2012-11-20 00:09:14 -08003074// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
Andreas Gampe585da952016-12-02 14:52:29 -08003075template <typename RootVisitor, bool kPrecise = false>
Ian Rogers0399dde2012-06-06 17:09:28 -07003076class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07003077 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003078 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003079 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003080 // We are visiting the references in compiled frames, so we do not need
3081 // to know the inlined frames.
3082 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
3083 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07003084
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003085 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003086 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07003087 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02003088 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07003089 }
Ian Rogers0399dde2012-06-06 17:09:28 -07003090 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08003091 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02003092 VisitShadowFrame(shadow_frame);
3093 } else {
3094 VisitQuickFrame();
3095 }
3096 return true;
3097 }
3098
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003099 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003100 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003101 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07003102 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003103 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003104 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
3105 // handle scope for JNI or References for interpreter.
3106 for (size_t reg = 0; reg < num_regs; ++reg) {
3107 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
3108 if (ref != nullptr) {
3109 mirror::Object* new_ref = ref;
3110 visitor_(&new_ref, reg, this);
3111 if (new_ref != ref) {
3112 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08003113 }
3114 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003115 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07003116 // Mark lock count map required for structured locking checks.
3117 shadow_frame->GetLockCountData().VisitMonitors(visitor_, -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02003118 }
3119
3120 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003121 // 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 -07003122 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
3123 // the threads do not all hold the heap bitmap lock for parallel GC.
3124 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003125 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003126 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003127 ObjPtr<mirror::Class> klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003128 // klass can be null for runtime methods.
3129 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003130 if (kVerifyImageObjectsMarked) {
3131 gc::Heap* const heap = Runtime::Current()->GetHeap();
3132 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
3133 /*fail_ok*/true);
3134 if (space != nullptr && space->IsImageSpace()) {
3135 bool failed = false;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003136 if (!space->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003137 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003138 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003139 } else if (!heap->GetLiveBitmap()->Test(klass.Ptr())) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003140 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003141 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003142 }
3143 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003144 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
3145 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
3146 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003147 << " klass@" << klass.Ptr();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003148 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07003149 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
3150 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07003151 }
3152 }
3153 }
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003154 mirror::Object* new_ref = klass.Ptr();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003155 visitor_(&new_ref, -1, this);
3156 if (new_ref != klass) {
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003157 method->CASDeclaringClass(klass.Ptr(), new_ref->AsClass());
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003158 }
3159 }
3160 }
3161
Andreas Gampe585da952016-12-02 14:52:29 -08003162 template <typename T>
3163 ALWAYS_INLINE
3164 inline void VisitQuickFrameWithVregCallback() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003165 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003166 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07003167 ArtMethod* m = *cur_quick_frame;
3168 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07003169
Sebastien Hertz714f1752014-04-28 15:03:08 +02003170 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07003171 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01003172 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003173 DCHECK(method_header->IsOptimized());
3174 auto* vreg_base = reinterpret_cast<StackReference<mirror::Object>*>(
3175 reinterpret_cast<uintptr_t>(cur_quick_frame));
3176 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
3177 CodeInfo code_info = method_header->GetOptimizedCodeInfo();
3178 CodeInfoEncoding encoding = code_info.ExtractEncoding();
3179 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset, encoding);
3180 DCHECK(map.IsValid());
Andreas Gampe585da952016-12-02 14:52:29 -08003181
3182 T vreg_info(m, code_info, encoding, map, visitor_);
3183
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003184 // Visit stack entries that hold pointers.
David Srbecky45aa5982016-03-18 02:15:09 +00003185 const size_t number_of_bits = code_info.GetNumberOfStackMaskBits(encoding);
3186 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(encoding, map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003187 for (size_t i = 0; i < number_of_bits; ++i) {
David Srbecky45aa5982016-03-18 02:15:09 +00003188 if (stack_mask.LoadBit(i)) {
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003189 auto* ref_addr = vreg_base + i;
3190 mirror::Object* ref = ref_addr->AsMirrorPtr();
3191 if (ref != nullptr) {
3192 mirror::Object* new_ref = ref;
Andreas Gampe585da952016-12-02 14:52:29 -08003193 vreg_info.VisitStack(&new_ref, i, this);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003194 if (ref != new_ref) {
3195 ref_addr->Assign(new_ref);
David Srbecky45aa5982016-03-18 02:15:09 +00003196 }
Nicolas Geoffray39468442014-09-02 15:17:15 +01003197 }
3198 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003199 }
3200 // Visit callee-save registers that hold pointers.
Mathieu Chartier1a20b682017-01-31 14:25:16 -08003201 uint32_t register_mask = code_info.GetRegisterMaskOf(encoding, map);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003202 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
3203 if (register_mask & (1 << i)) {
3204 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003205 if (kIsDebugBuild && ref_addr == nullptr) {
3206 std::string thread_name;
3207 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003208 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07003209 DescribeStack(GetThread());
3210 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
3211 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
3212 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01003213 if (*ref_addr != nullptr) {
Andreas Gampe585da952016-12-02 14:52:29 -08003214 vreg_info.VisitRegister(ref_addr, i, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07003215 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003216 }
3217 }
3218 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003219 }
3220
Andreas Gampe585da952016-12-02 14:52:29 -08003221 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
3222 if (kPrecise) {
3223 VisitQuickFramePrecise();
3224 } else {
3225 VisitQuickFrameNonPrecise();
3226 }
3227 }
3228
3229 void VisitQuickFrameNonPrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3230 struct UndefinedVRegInfo {
3231 UndefinedVRegInfo(ArtMethod* method ATTRIBUTE_UNUSED,
3232 const CodeInfo& code_info ATTRIBUTE_UNUSED,
3233 const CodeInfoEncoding& encoding ATTRIBUTE_UNUSED,
3234 const StackMap& map ATTRIBUTE_UNUSED,
3235 RootVisitor& _visitor)
3236 : visitor(_visitor) {
3237 }
3238
3239 ALWAYS_INLINE
3240 void VisitStack(mirror::Object** ref,
3241 size_t stack_index ATTRIBUTE_UNUSED,
3242 const StackVisitor* stack_visitor)
3243 REQUIRES_SHARED(Locks::mutator_lock_) {
3244 visitor(ref, -1, stack_visitor);
3245 }
3246
3247 ALWAYS_INLINE
3248 void VisitRegister(mirror::Object** ref,
3249 size_t register_index ATTRIBUTE_UNUSED,
3250 const StackVisitor* stack_visitor)
3251 REQUIRES_SHARED(Locks::mutator_lock_) {
3252 visitor(ref, -1, stack_visitor);
3253 }
3254
3255 RootVisitor& visitor;
3256 };
3257 VisitQuickFrameWithVregCallback<UndefinedVRegInfo>();
3258 }
3259
3260 void VisitQuickFramePrecise() REQUIRES_SHARED(Locks::mutator_lock_) {
3261 struct StackMapVRegInfo {
3262 StackMapVRegInfo(ArtMethod* method,
3263 const CodeInfo& _code_info,
3264 const CodeInfoEncoding& _encoding,
3265 const StackMap& map,
3266 RootVisitor& _visitor)
3267 : number_of_dex_registers(method->GetCodeItem()->registers_size_),
3268 code_info(_code_info),
3269 encoding(_encoding),
3270 dex_register_map(code_info.GetDexRegisterMapOf(map,
3271 encoding,
3272 number_of_dex_registers)),
3273 visitor(_visitor) {
3274 }
3275
3276 // TODO: If necessary, we should consider caching a reverse map instead of the linear
3277 // lookups for each location.
3278 void FindWithType(const size_t index,
3279 const DexRegisterLocation::Kind kind,
3280 mirror::Object** ref,
3281 const StackVisitor* stack_visitor)
3282 REQUIRES_SHARED(Locks::mutator_lock_) {
3283 bool found = false;
3284 for (size_t dex_reg = 0; dex_reg != number_of_dex_registers; ++dex_reg) {
3285 DexRegisterLocation location = dex_register_map.GetDexRegisterLocation(
3286 dex_reg, number_of_dex_registers, code_info, encoding);
3287 if (location.GetKind() == kind && static_cast<size_t>(location.GetValue()) == index) {
3288 visitor(ref, dex_reg, stack_visitor);
3289 found = true;
3290 }
3291 }
3292
3293 if (!found) {
3294 // If nothing found, report with -1.
3295 visitor(ref, -1, stack_visitor);
3296 }
3297 }
3298
3299 void VisitStack(mirror::Object** ref, size_t stack_index, const StackVisitor* stack_visitor)
3300 REQUIRES_SHARED(Locks::mutator_lock_) {
3301 const size_t stack_offset = stack_index * kFrameSlotSize;
3302 FindWithType(stack_offset,
3303 DexRegisterLocation::Kind::kInStack,
3304 ref,
3305 stack_visitor);
3306 }
3307
3308 void VisitRegister(mirror::Object** ref,
3309 size_t register_index,
3310 const StackVisitor* stack_visitor)
3311 REQUIRES_SHARED(Locks::mutator_lock_) {
3312 FindWithType(register_index,
3313 DexRegisterLocation::Kind::kInRegister,
3314 ref,
3315 stack_visitor);
3316 }
3317
3318 size_t number_of_dex_registers;
3319 const CodeInfo& code_info;
3320 const CodeInfoEncoding& encoding;
3321 DexRegisterMap dex_register_map;
3322 RootVisitor& visitor;
3323 };
3324 VisitQuickFrameWithVregCallback<StackMapVRegInfo>();
3325 }
3326
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003327 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003328 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07003329};
3330
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003331class RootCallbackVisitor {
3332 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003333 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003334
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003335 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003336 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003337 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003338 }
3339
3340 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003341 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08003342 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07003343};
3344
Andreas Gampe585da952016-12-02 14:52:29 -08003345template <bool kPrecise>
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003346void Thread::VisitRoots(RootVisitor* visitor) {
3347 const uint32_t thread_id = GetThreadId();
3348 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02003349 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003350 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00003351 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07003352 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003353 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
3354 tlsPtr_.jni_env->locals.VisitRoots(visitor, RootInfo(kRootJNILocal, thread_id));
3355 tlsPtr_.jni_env->monitors.VisitRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
3356 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003357 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003358 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07003359 }
Sebastien Hertz07474662015-08-25 15:12:33 +00003360 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003361 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003362 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003363 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07003364 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
3365 record != nullptr;
3366 record = record->GetLink()) {
3367 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
3368 shadow_frame != nullptr;
3369 shadow_frame = shadow_frame->GetLink()) {
3370 mapper.VisitShadowFrame(shadow_frame);
3371 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02003372 }
3373 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003374 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
3375 record != nullptr;
3376 record = record->GetLink()) {
3377 if (record->IsReference()) {
3378 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00003379 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003380 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003381 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
3382 RootInfo(kRootThreadObject, thread_id));
3383 }
3384 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
3385 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003386 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang99170c62015-07-06 11:10:37 -07003387 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
3388 record != nullptr;
3389 record = record->GetNext()) {
3390 mapper.VisitShadowFrame(record->GetShadowFrame());
3391 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07003392 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003393 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
3394 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003395 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07003396 // Visit roots on this thread's stack
Ian Rogers0399dde2012-06-06 17:09:28 -07003397 Context* context = GetLongJumpContext();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003398 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Andreas Gampe585da952016-12-02 14:52:29 -08003399 ReferenceMapVisitor<RootCallbackVisitor, kPrecise> mapper(this, context, visitor_to_callback);
3400 mapper.template WalkStack<StackVisitor::CountTransitions::kNo>(false);
Ian Rogers0399dde2012-06-06 17:09:28 -07003401 ReleaseLongJumpContext(context);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07003402 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003403 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08003404 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07003405}
3406
Andreas Gampe585da952016-12-02 14:52:29 -08003407void Thread::VisitRoots(RootVisitor* visitor, VisitRootFlags flags) {
3408 if ((flags & VisitRootFlags::kVisitRootFlagPrecise) != 0) {
3409 VisitRoots<true>(visitor);
3410 } else {
3411 VisitRoots<false>(visitor);
3412 }
3413}
3414
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003415class VerifyRootVisitor : public SingleRootVisitor {
3416 public:
3417 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003418 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003419 VerifyObject(root);
3420 }
3421};
jeffhao25045522012-03-13 19:34:37 -07003422
Ian Rogers04d7aa92013-03-16 14:29:17 -07003423void Thread::VerifyStackImpl() {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003424 VerifyRootVisitor visitor;
Ian Rogers700a4022014-05-19 16:49:03 -07003425 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07003426 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
3427 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
Ian Rogers0399dde2012-06-06 17:09:28 -07003428 mapper.WalkStack();
jeffhao25045522012-03-13 19:34:37 -07003429}
jeffhao25045522012-03-13 19:34:37 -07003430
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003431// Set the stack end to that to be used during a stack overflow
3432void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003433 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07003434 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003435 // However, we seem to have already extended to use the full stack.
3436 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07003437 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003438 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003439 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003440 }
3441
Ian Rogersdd7624d2014-03-14 17:43:00 -07003442 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07003443
3444 // Remove the stack overflow protection if is it set up.
3445 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
3446 if (implicit_stack_check) {
3447 if (!UnprotectStack()) {
3448 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
3449 }
3450 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003451}
3452
Ian Rogers13735952014-10-08 12:43:28 -07003453void Thread::SetTlab(uint8_t* start, uint8_t* end) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08003454 DCHECK_LE(start, end);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003455 tlsPtr_.thread_local_start = start;
3456 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
3457 tlsPtr_.thread_local_end = end;
3458 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08003459}
3460
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003461bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003462 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003463 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003464 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003465 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003466 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003467 }
3468 return has_tlab;
3469}
3470
Elliott Hughes330304d2011-08-12 14:28:05 -07003471std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003472 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07003473 return os;
3474}
3475
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003476bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07003477 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
3478 VLOG(threads) << "Protecting stack at " << pregion;
3479 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003480 if (fatal_on_error) {
3481 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
3482 "Reason: "
3483 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
3484 }
3485 return false;
Dave Allison648d7112014-07-25 16:15:27 -07003486 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003487 return true;
Dave Allison648d7112014-07-25 16:15:27 -07003488}
3489
3490bool Thread::UnprotectStack() {
3491 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
3492 VLOG(threads) << "Unprotecting stack at " << pregion;
3493 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
3494}
3495
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003496void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
3497 CHECK(Dbg::IsDebuggerActive());
3498 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
3499 CHECK(ssc != nullptr);
3500 tlsPtr_.single_step_control = ssc;
3501}
3502
3503void Thread::DeactivateSingleStepControl() {
3504 CHECK(Dbg::IsDebuggerActive());
3505 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
3506 SingleStepControl* ssc = GetSingleStepControl();
3507 tlsPtr_.single_step_control = nullptr;
3508 delete ssc;
3509}
Dave Allison648d7112014-07-25 16:15:27 -07003510
Sebastien Hertz1558b572015-02-25 15:05:59 +01003511void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
3512 CHECK(Dbg::IsDebuggerActive());
3513 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
3514 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
3515 CHECK(req != nullptr);
3516 tlsPtr_.debug_invoke_req = req;
3517}
3518
3519void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003520 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
3521 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003522 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003523 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003524 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003525}
3526
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003527void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
3528 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003529 tlsPtr_.method_verifier = verifier;
3530}
3531
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003532void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003533 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003534 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003535}
3536
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07003537size_t Thread::NumberOfHeldMutexes() const {
3538 size_t count = 0;
3539 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07003540 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07003541 }
3542 return count;
3543}
3544
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003545void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
3546 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
3547 ClearException();
3548 ShadowFrame* shadow_frame =
3549 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
Mathieu Chartierf5769e12017-01-10 15:54:41 -08003550 ObjPtr<mirror::Throwable> pending_exception;
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003551 bool from_code = false;
3552 PopDeoptimizationContext(result, &pending_exception, &from_code);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003553 SetTopOfStack(nullptr);
3554 SetTopOfShadowStack(shadow_frame);
3555
3556 // Restore the exception that was pending before deoptimization then interpret the
3557 // deoptimized frames.
3558 if (pending_exception != nullptr) {
3559 SetException(pending_exception);
3560 }
3561 interpreter::EnterInterpreterFromDeoptimize(this, shadow_frame, from_code, result);
3562}
3563
Mathieu Chartier0795f232016-09-27 18:43:30 -07003564void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07003565 CHECK(new_exception != nullptr);
3566 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07003567 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07003568}
3569
Andreas Gampe2c19f5b2016-11-28 08:10:18 -08003570bool Thread::IsAotCompiler() {
3571 return Runtime::Current()->IsAotCompiler();
3572}
3573
Andreas Gampe202f85a2017-02-06 10:23:26 -08003574mirror::Object* Thread::GetPeerFromOtherThread() const {
Nicolas Geoffrayffc8cad2017-02-10 10:59:22 +00003575 DCHECK(tlsPtr_.jpeer == nullptr);
3576 mirror::Object* peer = tlsPtr_.opeer;
Andreas Gampe202f85a2017-02-06 10:23:26 -08003577 if (kUseReadBarrier && Current()->GetIsGcMarking()) {
3578 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
3579 // may have not been flipped yet and peer may be a from-space (stale) ref. So explicitly
3580 // mark/forward it here.
3581 peer = art::ReadBarrier::Mark(peer);
3582 }
3583 return peer;
3584}
3585
Elliott Hughes8daa0922011-09-11 13:46:25 -07003586} // namespace art