blob: 3f7d0868b092aca30db69075fdd20d82c84a0ea6 [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Carl Shapirob5573532011-07-12 18:22:59 -070016
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "thread.h"
Carl Shapirob5573532011-07-12 18:22:59 -070018
Ian Rogersb033c752011-07-20 12:22:35 -070019#include <pthread.h>
Elliott Hughes2acf36d2012-04-17 13:30:13 -070020#include <signal.h>
Brian Carlstromdbf05b72011-12-15 00:55:24 -080021#include <sys/resource.h>
22#include <sys/time.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070023
Carl Shapirob5573532011-07-12 18:22:59 -070024#include <algorithm>
Elliott Hughesdcc24742011-09-07 14:02:44 -070025#include <bitset>
Elliott Hugheseb4f6142011-07-15 17:43:51 -070026#include <cerrno>
Elliott Hughesa0957642011-09-02 14:27:33 -070027#include <iostream>
Carl Shapirob5573532011-07-12 18:22:59 -070028#include <list>
Ian Rogersc7dd2952014-10-21 23:31:19 -070029#include <sstream>
Carl Shapirob5573532011-07-12 18:22:59 -070030
Ian Rogers166db042013-07-26 12:05:57 -070031#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070032#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070033#include "art_method-inl.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010034#include "base/bit_utils.h"
Evgenii Stepanov1e133742015-05-20 12:30:59 -070035#include "base/memory_tool.h"
Elliott Hughes76b61672012-12-12 17:47:30 -080036#include "base/mutex.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080037#include "base/timing_logger.h"
Ian Rogersc7dd2952014-10-21 23:31:19 -070038#include "base/to_str.h"
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -080039#include "base/systrace.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080040#include "class_linker-inl.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070041#include "debugger.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070042#include "dex_file-inl.h"
David Sehr9323e6e2016-09-13 08:58:35 -070043#include "dex_file_annotations.h"
Ian Rogers7655f292013-07-29 11:07:13 -070044#include "entrypoints/entrypoint_utils.h"
Mathieu Chartierd8891782014-03-02 13:28:37 -080045#include "entrypoints/quick/quick_alloc_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070046#include "gc/accounting/card_table-inl.h"
Roland Levillain1fbd4522016-03-22 15:52:22 +000047#include "gc/accounting/heap_bitmap-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070048#include "gc/allocator/rosalloc.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070049#include "gc/heap.h"
Mathieu Chartierd5f3f322016-03-21 14:05:56 -070050#include "gc/space/space-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070051#include "handle_scope-inl.h"
Mathieu Chartierc56057e2014-05-04 13:18:58 -070052#include "indirect_reference_table-inl.h"
Elliott Hughesc5f7c912011-08-18 14:00:42 -070053#include "jni_internal.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080054#include "mirror/class_loader.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070055#include "mirror/class-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080056#include "mirror/object_array-inl.h"
57#include "mirror/stack_trace_element.h"
Elliott Hughes8e4aac52011-09-26 17:03:36 -070058#include "monitor.h"
Andreas Gampe5dd44d02016-08-02 17:20:03 -070059#include "native_stack_dump.h"
Mingyao Yangf711f2c2016-05-23 12:29:39 -070060#include "nth_caller_visitor.h"
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +010061#include "oat_quick_method_header.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070062#include "obj_ptr-inl.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070063#include "object_lock.h"
Sebastien Hertzfd3077e2014-04-23 10:32:43 +020064#include "quick_exception_handler.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010065#include "quick/quick_method_frame_info.h"
Jesse Wilson9a6bae82011-11-14 14:57:30 -050066#include "reflection.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070067#include "runtime.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070068#include "scoped_thread_state_change-inl.h"
Elliott Hughes46e251b2012-05-22 15:10:45 -070069#include "ScopedLocalRef.h"
Anwar Ghuloum3c539ff2013-06-20 08:58:23 -070070#include "ScopedUtfChars.h"
Elliott Hughes68e76522011-10-05 13:22:16 -070071#include "stack.h"
Nicolas Geoffray6bc43742015-10-12 18:11:10 +010072#include "stack_map.h"
Elliott Hughes8daa0922011-09-11 13:46:25 -070073#include "thread_list.h"
Ian Rogers22d5e732014-07-15 22:23:51 -070074#include "thread-inl.h"
Elliott Hughesa0957642011-09-02 14:27:33 -070075#include "utils.h"
Mathieu Chartier12d625f2015-03-13 11:33:37 -070076#include "verifier/method_verifier.h"
Mathieu Chartier4e305412014-02-19 10:54:44 -080077#include "verify_object-inl.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070078#include "well_known_classes.h"
buzbee1452bee2015-03-06 14:43:04 -080079#include "interpreter/interpreter.h"
Carl Shapirob5573532011-07-12 18:22:59 -070080
Yu Lieac44242015-06-29 10:50:03 +080081#if ART_USE_FUTEXES
82#include "linux/futex.h"
83#include "sys/syscall.h"
84#ifndef SYS_futex
85#define SYS_futex __NR_futex
86#endif
87#endif // ART_USE_FUTEXES
88
Carl Shapirob5573532011-07-12 18:22:59 -070089namespace art {
90
Mingyao Yangf711f2c2016-05-23 12:29:39 -070091extern "C" NO_RETURN void artDeoptimize(Thread* self);
92
Ian Rogers0878d652013-04-18 17:38:35 -070093bool Thread::is_started_ = false;
Carl Shapirob5573532011-07-12 18:22:59 -070094pthread_key_t Thread::pthread_key_self_;
Dave Allison0aded082013-11-07 13:15:11 -080095ConditionVariable* Thread::resume_cond_ = nullptr;
Dave Allison648d7112014-07-25 16:15:27 -070096const size_t Thread::kStackOverflowImplicitCheckSize = GetStackOverflowReservedBytes(kRuntimeISA);
Calin Juravleb2771b42016-04-07 17:09:25 +010097bool (*Thread::is_sensitive_thread_hook_)() = nullptr;
Calin Juravle97cbc922016-04-15 16:16:35 +010098Thread* Thread::jit_sensitive_thread_ = nullptr;
Calin Juravleb2771b42016-04-07 17:09:25 +010099
Mathieu Chartierb0026b42016-03-31 15:05:45 -0700100static constexpr bool kVerifyImageObjectsMarked = kIsDebugBuild;
Carl Shapirob5573532011-07-12 18:22:59 -0700101
Evgenii Stepanov1e133742015-05-20 12:30:59 -0700102// For implicit overflow checks we reserve an extra piece of memory at the bottom
103// of the stack (lowest memory). The higher portion of the memory
104// is protected against reads and the lower is available for use while
105// throwing the StackOverflow exception.
106constexpr size_t kStackOverflowProtectedSize = 4 * kMemoryToolStackGuardSizeScale * KB;
107
Elliott Hughes7dc51662012-05-16 14:48:43 -0700108static const char* kThreadNameDuringStartup = "<native thread without managed peer>";
109
Ian Rogers5d76c432011-10-31 21:42:49 -0700110void Thread::InitCardTable() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700111 tlsPtr_.card_table = Runtime::Current()->GetHeap()->GetCardTable()->GetBiasedBegin();
Ian Rogers5d76c432011-10-31 21:42:49 -0700112}
113
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700114static void UnimplementedEntryPoint() {
115 UNIMPLEMENTED(FATAL);
116}
117
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700118void InitEntryPoints(JniEntryPoints* jpoints, QuickEntryPoints* qpoints);
Ian Rogers7655f292013-07-29 11:07:13 -0700119
Ian Rogers848871b2013-08-05 10:56:33 -0700120void Thread::InitTlsEntryPoints() {
Elliott Hughes3ea0f422012-04-16 17:01:43 -0700121 // Insert a placeholder so we can easily tell if we call an unimplemented entry point.
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700122 uintptr_t* begin = reinterpret_cast<uintptr_t*>(&tlsPtr_.jni_entrypoints);
Xingxing Panacbb3082014-10-16 13:41:58 +0800123 uintptr_t* end = reinterpret_cast<uintptr_t*>(reinterpret_cast<uint8_t*>(&tlsPtr_.quick_entrypoints) +
124 sizeof(tlsPtr_.quick_entrypoints));
Ian Rogers7655f292013-07-29 11:07:13 -0700125 for (uintptr_t* it = begin; it != end; ++it) {
126 *it = reinterpret_cast<uintptr_t>(UnimplementedEntryPoint);
127 }
Andreas Gampe3cfa4d02015-10-06 17:04:01 -0700128 InitEntryPoints(&tlsPtr_.jni_entrypoints, &tlsPtr_.quick_entrypoints);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700129}
130
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700131void Thread::ResetQuickAllocEntryPointsForThread() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700132 ResetQuickAllocEntryPoints(&tlsPtr_.quick_entrypoints);
Hiroshi Yamauchi3b4c1892013-09-12 21:33:12 -0700133}
134
Sebastien Hertz07474662015-08-25 15:12:33 +0000135class DeoptimizationContextRecord {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200136 public:
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100137 DeoptimizationContextRecord(const JValue& ret_val,
138 bool is_reference,
139 bool from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000140 mirror::Throwable* pending_exception,
141 DeoptimizationContextRecord* link)
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100142 : ret_val_(ret_val),
143 is_reference_(is_reference),
144 from_code_(from_code),
145 pending_exception_(pending_exception),
Sebastien Hertz07474662015-08-25 15:12:33 +0000146 link_(link) {}
Sebastien Hertzf7958692015-06-09 14:09:14 +0200147
148 JValue GetReturnValue() const { return ret_val_; }
149 bool IsReference() const { return is_reference_; }
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100150 bool GetFromCode() const { return from_code_; }
Sebastien Hertz07474662015-08-25 15:12:33 +0000151 mirror::Throwable* GetPendingException() const { return pending_exception_; }
152 DeoptimizationContextRecord* GetLink() const { return link_; }
153 mirror::Object** GetReturnValueAsGCRoot() {
Sebastien Hertzf7958692015-06-09 14:09:14 +0200154 DCHECK(is_reference_);
155 return ret_val_.GetGCRoot();
156 }
Sebastien Hertz07474662015-08-25 15:12:33 +0000157 mirror::Object** GetPendingExceptionAsGCRoot() {
158 return reinterpret_cast<mirror::Object**>(&pending_exception_);
159 }
Sebastien Hertzf7958692015-06-09 14:09:14 +0200160
161 private:
Sebastien Hertz07474662015-08-25 15:12:33 +0000162 // The value returned by the method at the top of the stack before deoptimization.
Sebastien Hertzf7958692015-06-09 14:09:14 +0200163 JValue ret_val_;
Sebastien Hertz54b62482015-08-20 12:07:57 +0200164
Sebastien Hertz07474662015-08-25 15:12:33 +0000165 // Indicates whether the returned value is a reference. If so, the GC will visit it.
166 const bool is_reference_;
167
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100168 // Whether the context was created from an explicit deoptimization in the code.
169 const bool from_code_;
170
Sebastien Hertz07474662015-08-25 15:12:33 +0000171 // The exception that was pending before deoptimization (or null if there was no pending
172 // exception).
173 mirror::Throwable* pending_exception_;
174
175 // A link to the previous DeoptimizationContextRecord.
176 DeoptimizationContextRecord* const link_;
177
178 DISALLOW_COPY_AND_ASSIGN(DeoptimizationContextRecord);
Sebastien Hertzf7958692015-06-09 14:09:14 +0200179};
180
181class StackedShadowFrameRecord {
182 public:
183 StackedShadowFrameRecord(ShadowFrame* shadow_frame,
184 StackedShadowFrameType type,
185 StackedShadowFrameRecord* link)
186 : shadow_frame_(shadow_frame),
187 type_(type),
188 link_(link) {}
189
190 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
191 StackedShadowFrameType GetType() const { return type_; }
192 StackedShadowFrameRecord* GetLink() const { return link_; }
193
194 private:
195 ShadowFrame* const shadow_frame_;
196 const StackedShadowFrameType type_;
197 StackedShadowFrameRecord* const link_;
198
199 DISALLOW_COPY_AND_ASSIGN(StackedShadowFrameRecord);
200};
201
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100202void Thread::PushDeoptimizationContext(const JValue& return_value,
203 bool is_reference,
204 bool from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000205 mirror::Throwable* exception) {
206 DeoptimizationContextRecord* record = new DeoptimizationContextRecord(
207 return_value,
208 is_reference,
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100209 from_code,
Sebastien Hertz07474662015-08-25 15:12:33 +0000210 exception,
211 tlsPtr_.deoptimization_context_stack);
212 tlsPtr_.deoptimization_context_stack = record;
buzbee3ea4ec52011-08-22 17:37:19 -0700213}
214
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100215void Thread::PopDeoptimizationContext(JValue* result,
216 mirror::Throwable** exception,
217 bool* from_code) {
Sebastien Hertz07474662015-08-25 15:12:33 +0000218 AssertHasDeoptimizationContext();
219 DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
220 tlsPtr_.deoptimization_context_stack = record->GetLink();
221 result->SetJ(record->GetReturnValue().GetJ());
222 *exception = record->GetPendingException();
Nicolas Geoffray73be1e82015-09-17 15:22:56 +0100223 *from_code = record->GetFromCode();
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700224 delete record;
Sebastien Hertz07474662015-08-25 15:12:33 +0000225}
226
227void Thread::AssertHasDeoptimizationContext() {
228 CHECK(tlsPtr_.deoptimization_context_stack != nullptr)
229 << "No deoptimization context for thread " << *this;
Ian Rogers306057f2012-11-26 12:45:53 -0800230}
231
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700232void Thread::PushStackedShadowFrame(ShadowFrame* sf, StackedShadowFrameType type) {
233 StackedShadowFrameRecord* record = new StackedShadowFrameRecord(
234 sf, type, tlsPtr_.stacked_shadow_frame_record);
235 tlsPtr_.stacked_shadow_frame_record = record;
Ian Rogers306057f2012-11-26 12:45:53 -0800236}
237
Andreas Gampe639bdd12015-06-03 11:22:45 -0700238ShadowFrame* Thread::PopStackedShadowFrame(StackedShadowFrameType type, bool must_be_present) {
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700239 StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
Andreas Gampe639bdd12015-06-03 11:22:45 -0700240 if (must_be_present) {
241 DCHECK(record != nullptr);
Andreas Gampe639bdd12015-06-03 11:22:45 -0700242 } else {
243 if (record == nullptr || record->GetType() != type) {
244 return nullptr;
245 }
246 }
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -0700247 tlsPtr_.stacked_shadow_frame_record = record->GetLink();
248 ShadowFrame* shadow_frame = record->GetShadowFrame();
249 delete record;
250 return shadow_frame;
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -0700251}
252
Mingyao Yang99170c62015-07-06 11:10:37 -0700253class FrameIdToShadowFrame {
254 public:
255 static FrameIdToShadowFrame* Create(size_t frame_id,
256 ShadowFrame* shadow_frame,
257 FrameIdToShadowFrame* next,
258 size_t num_vregs) {
259 // Append a bool array at the end to keep track of what vregs are updated by the debugger.
260 uint8_t* memory = new uint8_t[sizeof(FrameIdToShadowFrame) + sizeof(bool) * num_vregs];
261 return new (memory) FrameIdToShadowFrame(frame_id, shadow_frame, next);
262 }
263
264 static void Delete(FrameIdToShadowFrame* f) {
265 uint8_t* memory = reinterpret_cast<uint8_t*>(f);
266 delete[] memory;
267 }
268
269 size_t GetFrameId() const { return frame_id_; }
270 ShadowFrame* GetShadowFrame() const { return shadow_frame_; }
271 FrameIdToShadowFrame* GetNext() const { return next_; }
272 void SetNext(FrameIdToShadowFrame* next) { next_ = next; }
273 bool* GetUpdatedVRegFlags() {
274 return updated_vreg_flags_;
275 }
276
277 private:
278 FrameIdToShadowFrame(size_t frame_id,
279 ShadowFrame* shadow_frame,
280 FrameIdToShadowFrame* next)
281 : frame_id_(frame_id),
282 shadow_frame_(shadow_frame),
283 next_(next) {}
284
285 const size_t frame_id_;
286 ShadowFrame* const shadow_frame_;
287 FrameIdToShadowFrame* next_;
288 bool updated_vreg_flags_[0];
289
290 DISALLOW_COPY_AND_ASSIGN(FrameIdToShadowFrame);
291};
292
293static FrameIdToShadowFrame* FindFrameIdToShadowFrame(FrameIdToShadowFrame* head,
294 size_t frame_id) {
295 FrameIdToShadowFrame* found = nullptr;
296 for (FrameIdToShadowFrame* record = head; record != nullptr; record = record->GetNext()) {
297 if (record->GetFrameId() == frame_id) {
298 if (kIsDebugBuild) {
299 // Sanity check we have at most one record for this frame.
300 CHECK(found == nullptr) << "Multiple records for the frame " << frame_id;
301 found = record;
302 } else {
303 return record;
304 }
305 }
306 }
307 return found;
308}
309
310ShadowFrame* Thread::FindDebuggerShadowFrame(size_t frame_id) {
311 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
312 tlsPtr_.frame_id_to_shadow_frame, frame_id);
313 if (record != nullptr) {
314 return record->GetShadowFrame();
315 }
316 return nullptr;
317}
318
319// Must only be called when FindDebuggerShadowFrame(frame_id) returns non-nullptr.
320bool* Thread::GetUpdatedVRegFlags(size_t frame_id) {
321 FrameIdToShadowFrame* record = FindFrameIdToShadowFrame(
322 tlsPtr_.frame_id_to_shadow_frame, frame_id);
323 CHECK(record != nullptr);
324 return record->GetUpdatedVRegFlags();
325}
326
327ShadowFrame* Thread::FindOrCreateDebuggerShadowFrame(size_t frame_id,
328 uint32_t num_vregs,
329 ArtMethod* method,
330 uint32_t dex_pc) {
331 ShadowFrame* shadow_frame = FindDebuggerShadowFrame(frame_id);
332 if (shadow_frame != nullptr) {
333 return shadow_frame;
334 }
David Sehr709b0702016-10-13 09:12:37 -0700335 VLOG(deopt) << "Create pre-deopted ShadowFrame for " << ArtMethod::PrettyMethod(method);
Mingyao Yang99170c62015-07-06 11:10:37 -0700336 shadow_frame = ShadowFrame::CreateDeoptimizedFrame(num_vregs, nullptr, method, dex_pc);
337 FrameIdToShadowFrame* record = FrameIdToShadowFrame::Create(frame_id,
338 shadow_frame,
339 tlsPtr_.frame_id_to_shadow_frame,
340 num_vregs);
341 for (uint32_t i = 0; i < num_vregs; i++) {
342 // Do this to clear all references for root visitors.
343 shadow_frame->SetVRegReference(i, nullptr);
344 // This flag will be changed to true if the debugger modifies the value.
345 record->GetUpdatedVRegFlags()[i] = false;
346 }
347 tlsPtr_.frame_id_to_shadow_frame = record;
348 return shadow_frame;
349}
350
351void Thread::RemoveDebuggerShadowFrameMapping(size_t frame_id) {
352 FrameIdToShadowFrame* head = tlsPtr_.frame_id_to_shadow_frame;
353 if (head->GetFrameId() == frame_id) {
354 tlsPtr_.frame_id_to_shadow_frame = head->GetNext();
355 FrameIdToShadowFrame::Delete(head);
356 return;
357 }
358 FrameIdToShadowFrame* prev = head;
359 for (FrameIdToShadowFrame* record = head->GetNext();
360 record != nullptr;
361 prev = record, record = record->GetNext()) {
362 if (record->GetFrameId() == frame_id) {
363 prev->SetNext(record->GetNext());
364 FrameIdToShadowFrame::Delete(record);
365 return;
366 }
367 }
368 LOG(FATAL) << "No shadow frame for frame " << frame_id;
369 UNREACHABLE();
370}
371
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700372void Thread::InitTid() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700373 tls32_.tid = ::art::GetTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700374}
375
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700376void Thread::InitAfterFork() {
Elliott Hughes8029cbe2012-05-22 09:13:08 -0700377 // One thread (us) survived the fork, but we have a new tid so we need to
378 // update the value stashed in this Thread*.
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700379 InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700380}
381
Brian Carlstrom78128a62011-09-15 17:21:19 -0700382void* Thread::CreateCallback(void* arg) {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700383 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogers120f1c72012-09-28 17:17:10 -0700384 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800385 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700386 LOG(ERROR) << "Thread attaching to non-existent runtime: " << *self;
Dave Allison0aded082013-11-07 13:15:11 -0800387 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700388 }
389 {
Ian Rogers50b35e22012-10-04 10:09:15 -0700390 // TODO: pass self to MutexLock - requires self to equal Thread::Current(), which is only true
391 // after self->Init().
Dave Allison0aded082013-11-07 13:15:11 -0800392 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Ian Rogers120f1c72012-09-28 17:17:10 -0700393 // Check that if we got here we cannot be shutting down (as shutdown should never have started
394 // while threads are being born).
Mathieu Chartier590fee92013-09-13 13:46:47 -0700395 CHECK(!runtime->IsShuttingDownLocked());
Andreas Gampe449357d2015-06-01 22:29:51 -0700396 // Note: given that the JNIEnv is created in the parent thread, the only failure point here is
397 // a mess in InitStackHwm. We do not have a reasonable way to recover from that, so abort
398 // the runtime in such a case. In case this ever changes, we need to make sure here to
399 // delete the tmp_jni_env, as we own it at this point.
400 CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
401 self->tlsPtr_.tmp_jni_env = nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700402 Runtime::Current()->EndThreadBirth();
403 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700404 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700405 ScopedObjectAccess soa(self);
Jeff Hao848f70a2014-01-15 13:49:50 -0800406 self->InitStringEntryPoints();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800407
408 // Copy peer into self, deleting global reference when done.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700409 CHECK(self->tlsPtr_.jpeer != nullptr);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700410 self->tlsPtr_.opeer = soa.Decode<mirror::Object>(self->tlsPtr_.jpeer).Ptr();
Ian Rogersdd7624d2014-03-14 17:43:00 -0700411 self->GetJniEnv()->DeleteGlobalRef(self->tlsPtr_.jpeer);
412 self->tlsPtr_.jpeer = nullptr;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700413 self->SetThreadName(self->GetThreadName(soa)->ToModifiedUtf8().c_str());
Narayan Kamatha0b34512014-10-07 12:51:26 +0100414
Mathieu Chartierc7853442015-03-27 14:35:38 -0700415 ArtField* priorityField = soa.DecodeField(WellKnownClasses::java_lang_Thread_priority);
Narayan Kamatha0b34512014-10-07 12:51:26 +0100416 self->SetNativePriority(priorityField->GetInt(self->tlsPtr_.opeer));
Ian Rogers365c1022012-06-22 15:05:28 -0700417 Dbg::PostThreadStart(self);
418
419 // Invoke the 'run' method of our java.lang.Thread.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700420 mirror::Object* receiver = self->tlsPtr_.opeer;
Ian Rogers365c1022012-06-22 15:05:28 -0700421 jmethodID mid = WellKnownClasses::java_lang_Thread_run;
Jeff Hao39b6c242015-05-19 20:30:23 -0700422 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(receiver));
423 InvokeVirtualOrInterfaceWithJValues(soa, ref.get(), mid, nullptr);
Elliott Hughes47179f72011-10-27 16:44:39 -0700424 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700425 // Detach and delete self.
426 Runtime::Current()->GetThreadList()->Unregister(self);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700427
Dave Allison0aded082013-11-07 13:15:11 -0800428 return nullptr;
Carl Shapirob5573532011-07-12 18:22:59 -0700429}
430
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700431Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800432 mirror::Object* thread_peer) {
Mathieu Chartierc7853442015-03-27 14:35:38 -0700433 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_nativePeer);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800434 Thread* result = reinterpret_cast<Thread*>(static_cast<uintptr_t>(f->GetLong(thread_peer)));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700435 // Sanity check that if we have a result it is either suspended or we hold the thread_list_lock_
436 // to stop it from going away.
Ian Rogers81d425b2012-09-27 16:03:43 -0700437 if (kIsDebugBuild) {
438 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -0800439 if (result != nullptr && !result->IsSuspended()) {
Ian Rogers81d425b2012-09-27 16:03:43 -0700440 Locks::thread_list_lock_->AssertHeld(soa.Self());
441 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700442 }
443 return result;
Elliott Hughes761928d2011-11-16 18:33:03 -0800444}
445
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700446Thread* Thread::FromManagedThread(const ScopedObjectAccessAlreadyRunnable& soa,
447 jobject java_thread) {
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700448 return FromManagedThread(soa, soa.Decode<mirror::Object>(java_thread).Ptr());
Elliott Hughes01158d72011-09-19 19:47:10 -0700449}
450
Elliott Hughesab7b9dc2012-03-27 13:16:29 -0700451static size_t FixStackSize(size_t stack_size) {
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700452 // A stack size of zero means "use the default".
Elliott Hughesd369bb72011-09-12 14:41:14 -0700453 if (stack_size == 0) {
454 stack_size = Runtime::Current()->GetDefaultStackSize();
455 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700456
Brian Carlstrom6414a972012-04-14 14:20:04 -0700457 // Dalvik used the bionic pthread default stack size for native threads,
458 // so include that here to support apps that expect large native stacks.
459 stack_size += 1 * MB;
460
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700461 // It's not possible to request a stack smaller than the system-defined PTHREAD_STACK_MIN.
462 if (stack_size < PTHREAD_STACK_MIN) {
463 stack_size = PTHREAD_STACK_MIN;
464 }
465
Dave Allisonf9439142014-03-27 15:10:22 -0700466 if (Runtime::Current()->ExplicitStackOverflowChecks()) {
467 // It's likely that callers are trying to ensure they have at least a certain amount of
468 // stack space, so we should add our reserved space on top of what they requested, rather
469 // than implicitly take it away from them.
Andreas Gampe7ea6f792014-07-14 16:21:44 -0700470 stack_size += GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700471 } else {
472 // If we are going to use implicit stack checks, allocate space for the protected
473 // region at the bottom of the stack.
Dave Allisonb090a182014-08-14 17:02:48 +0000474 stack_size += Thread::kStackOverflowImplicitCheckSize +
475 GetStackOverflowReservedBytes(kRuntimeISA);
Dave Allisonf9439142014-03-27 15:10:22 -0700476 }
Elliott Hughes7502e2a2011-10-02 13:24:37 -0700477
478 // Some systems require the stack size to be a multiple of the system page size, so round up.
479 stack_size = RoundUp(stack_size, kPageSize);
480
481 return stack_size;
482}
483
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700484// Return the nearest page-aligned address below the current stack top.
485NO_INLINE
486static uint8_t* FindStackTop() {
487 return reinterpret_cast<uint8_t*>(
488 AlignDown(__builtin_frame_address(0), kPageSize));
489}
490
Dave Allisonf9439142014-03-27 15:10:22 -0700491// Install a protected region in the stack. This is used to trigger a SIGSEGV if a stack
Dave Allison648d7112014-07-25 16:15:27 -0700492// overflow is detected. It is located right below the stack_begin_.
Evgenii Stepanov4abf4512015-07-13 10:41:57 -0700493ATTRIBUTE_NO_SANITIZE_ADDRESS
Dave Allison648d7112014-07-25 16:15:27 -0700494void Thread::InstallImplicitProtection() {
Ian Rogers13735952014-10-08 12:43:28 -0700495 uint8_t* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
Evgenii Stepanov84a4ab82016-05-13 14:01:41 -0700496 // Page containing current top of stack.
497 uint8_t* stack_top = FindStackTop();
Dave Allisonf9439142014-03-27 15:10:22 -0700498
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700499 // Try to directly protect the stack.
500 VLOG(threads) << "installing stack protected region at " << std::hex <<
501 static_cast<void*>(pregion) << " to " <<
502 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
503 if (ProtectStack(/* fatal_on_error */ false)) {
504 // Tell the kernel that we won't be needing these pages any more.
505 // NB. madvise will probably write zeroes into the memory (on linux it does).
506 uint32_t unwanted_size = stack_top - pregion - kPageSize;
507 madvise(pregion, unwanted_size, MADV_DONTNEED);
508 return;
509 }
510
511 // There is a little complexity here that deserves a special mention. On some
512 // architectures, the stack is created using a VM_GROWSDOWN flag
513 // to prevent memory being allocated when it's not needed. This flag makes the
514 // kernel only allocate memory for the stack by growing down in memory. Because we
515 // want to put an mprotected region far away from that at the stack top, we need
516 // to make sure the pages for the stack are mapped in before we call mprotect.
517 //
518 // The failed mprotect in UnprotectStack is an indication of a thread with VM_GROWSDOWN
519 // with a non-mapped stack (usually only the main thread).
520 //
521 // We map in the stack by reading every page from the stack bottom (highest address)
522 // to the stack top. (We then madvise this away.) This must be done by reading from the
523 // current stack pointer downwards. Any access more than a page below the current SP
524 // might cause a segv.
525 // TODO: This comment may be out of date. It seems possible to speed this up. As
526 // this is normally done once in the zygote on startup, ignore for now.
527 //
528 // AddressSanitizer does not like the part of this functions that reads every stack page.
529 // Looks a lot like an out-of-bounds access.
530
531 // (Defensively) first remove the protection on the protected region as will want to read
532 // and write it. Ignore errors.
Dave Allison648d7112014-07-25 16:15:27 -0700533 UnprotectStack();
Dave Allison69dfe512014-07-11 17:11:58 +0000534
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700535 VLOG(threads) << "Need to map in stack for thread at " << std::hex <<
536 static_cast<void*>(pregion);
Dave Allison69dfe512014-07-11 17:11:58 +0000537
Dave Allison648d7112014-07-25 16:15:27 -0700538 // Read every page from the high address to the low.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700539 volatile uint8_t dont_optimize_this;
Roland Levillain48a7bae2016-03-21 14:09:54 +0000540 UNUSED(dont_optimize_this);
Ian Rogers13735952014-10-08 12:43:28 -0700541 for (uint8_t* p = stack_top; p >= pregion; p -= kPageSize) {
Dave Allison648d7112014-07-25 16:15:27 -0700542 dont_optimize_this = *p;
Dave Allison69dfe512014-07-11 17:11:58 +0000543 }
544
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700545 VLOG(threads) << "(again) installing stack protected region at " << std::hex <<
Dave Allisonf9439142014-03-27 15:10:22 -0700546 static_cast<void*>(pregion) << " to " <<
547 static_cast<void*>(pregion + kStackOverflowProtectedSize - 1);
548
Dave Allison648d7112014-07-25 16:15:27 -0700549 // Protect the bottom of the stack to prevent read/write to it.
Andreas Gampe2c2d2a02016-03-17 21:27:19 -0700550 ProtectStack(/* fatal_on_error */ true);
Dave Allison5cd33752014-04-15 15:57:58 -0700551
552 // Tell the kernel that we won't be needing these pages any more.
Dave Allison69dfe512014-07-11 17:11:58 +0000553 // NB. madvise will probably write zeroes into the memory (on linux it does).
Dave Allison648d7112014-07-25 16:15:27 -0700554 uint32_t unwanted_size = stack_top - pregion - kPageSize;
555 madvise(pregion, unwanted_size, MADV_DONTNEED);
Dave Allisonf9439142014-03-27 15:10:22 -0700556}
557
Ian Rogers120f1c72012-09-28 17:17:10 -0700558void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
Dave Allison0aded082013-11-07 13:15:11 -0800559 CHECK(java_peer != nullptr);
Ian Rogers120f1c72012-09-28 17:17:10 -0700560 Thread* self = static_cast<JNIEnvExt*>(env)->self;
Andreas Gampe56623832015-07-09 21:53:15 -0700561
562 if (VLOG_IS_ON(threads)) {
563 ScopedObjectAccess soa(env);
564
565 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700566 ObjPtr<mirror::String> java_name =
567 f->GetObject(soa.Decode<mirror::Object>(java_peer))->AsString();
Andreas Gampe56623832015-07-09 21:53:15 -0700568 std::string thread_name;
569 if (java_name != nullptr) {
570 thread_name = java_name->ToModifiedUtf8();
571 } else {
572 thread_name = "(Unnamed)";
573 }
574
575 VLOG(threads) << "Creating native thread for " << thread_name;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700576 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700577 }
578
Ian Rogers120f1c72012-09-28 17:17:10 -0700579 Runtime* runtime = Runtime::Current();
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700580
Ian Rogers120f1c72012-09-28 17:17:10 -0700581 // Atomically start the birth of the thread ensuring the runtime isn't shutting down.
582 bool thread_start_during_shutdown = false;
Elliott Hughes47179f72011-10-27 16:44:39 -0700583 {
Ian Rogers120f1c72012-09-28 17:17:10 -0700584 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700585 if (runtime->IsShuttingDownLocked()) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700586 thread_start_during_shutdown = true;
587 } else {
588 runtime->StartThreadBirth();
589 }
Elliott Hughes47179f72011-10-27 16:44:39 -0700590 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700591 if (thread_start_during_shutdown) {
592 ScopedLocalRef<jclass> error_class(env, env->FindClass("java/lang/InternalError"));
593 env->ThrowNew(error_class.get(), "Thread starting during runtime shutdown");
594 return;
595 }
596
597 Thread* child_thread = new Thread(is_daemon);
598 // Use global JNI ref to hold peer live while child thread starts.
Ian Rogersdd7624d2014-03-14 17:43:00 -0700599 child_thread->tlsPtr_.jpeer = env->NewGlobalRef(java_peer);
Ian Rogers120f1c72012-09-28 17:17:10 -0700600 stack_size = FixStackSize(stack_size);
601
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -0700602 // 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 -0700603 // assign it.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800604 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer,
605 reinterpret_cast<jlong>(child_thread));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700606
Andreas Gampe449357d2015-06-01 22:29:51 -0700607 // Try to allocate a JNIEnvExt for the thread. We do this here as we might be out of memory and
608 // do not have a good way to report this on the child's side.
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100609 std::string error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700610 std::unique_ptr<JNIEnvExt> child_jni_env_ext(
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100611 JNIEnvExt::Create(child_thread, Runtime::Current()->GetJavaVM(), &error_msg));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700612
Andreas Gampe449357d2015-06-01 22:29:51 -0700613 int pthread_create_result = 0;
614 if (child_jni_env_ext.get() != nullptr) {
615 pthread_t new_pthread;
616 pthread_attr_t attr;
617 child_thread->tlsPtr_.tmp_jni_env = child_jni_env_ext.get();
618 CHECK_PTHREAD_CALL(pthread_attr_init, (&attr), "new thread");
619 CHECK_PTHREAD_CALL(pthread_attr_setdetachstate, (&attr, PTHREAD_CREATE_DETACHED),
620 "PTHREAD_CREATE_DETACHED");
621 CHECK_PTHREAD_CALL(pthread_attr_setstacksize, (&attr, stack_size), stack_size);
622 pthread_create_result = pthread_create(&new_pthread,
623 &attr,
624 Thread::CreateCallback,
625 child_thread);
626 CHECK_PTHREAD_CALL(pthread_attr_destroy, (&attr), "new thread");
627
628 if (pthread_create_result == 0) {
629 // pthread_create started the new thread. The child is now responsible for managing the
630 // JNIEnvExt we created.
631 // Note: we can't check for tmp_jni_env == nullptr, as that would require synchronization
632 // between the threads.
633 child_jni_env_ext.release();
634 return;
Ian Rogers120f1c72012-09-28 17:17:10 -0700635 }
Andreas Gampe449357d2015-06-01 22:29:51 -0700636 }
637
638 // Either JNIEnvExt::Create or pthread_create(3) failed, so clean up.
639 {
640 MutexLock mu(self, *Locks::runtime_shutdown_lock_);
641 runtime->EndThreadBirth();
642 }
643 // Manually delete the global reference since Thread::Init will not have been run.
644 env->DeleteGlobalRef(child_thread->tlsPtr_.jpeer);
645 child_thread->tlsPtr_.jpeer = nullptr;
646 delete child_thread;
647 child_thread = nullptr;
648 // TODO: remove from thread group?
649 env->SetLongField(java_peer, WellKnownClasses::java_lang_Thread_nativePeer, 0);
650 {
651 std::string msg(child_jni_env_ext.get() == nullptr ?
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100652 StringPrintf("Could not allocate JNI Env: %s", error_msg.c_str()) :
Andreas Gampe449357d2015-06-01 22:29:51 -0700653 StringPrintf("pthread_create (%s stack) failed: %s",
654 PrettySize(stack_size).c_str(), strerror(pthread_create_result)));
655 ScopedObjectAccess soa(env);
656 soa.Self()->ThrowOutOfMemoryError(msg.c_str());
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700657 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700658}
659
Andreas Gampe449357d2015-06-01 22:29:51 -0700660bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700661 // This function does all the initialization that must be run by the native thread it applies to.
662 // (When we create a new thread from managed code, we allocate the Thread* in Thread::Create so
663 // we can handshake with the corresponding native thread when it's ready.) Check this native
664 // thread hasn't been through here already...
Dave Allison0aded082013-11-07 13:15:11 -0800665 CHECK(Thread::Current() == nullptr);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800666
667 // Set pthread_self_ ahead of pthread_setspecific, that makes Thread::Current function, this
668 // avoids pthread_self_ ever being invalid when discovered from Thread::Current().
669 tlsPtr_.pthread_self = pthread_self();
670 CHECK(is_started_);
671
Elliott Hughesd8af1592012-04-16 20:40:15 -0700672 SetUpAlternateSignalStack();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800673 if (!InitStackHwm()) {
674 return false;
675 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700676 InitCpu();
Ian Rogers848871b2013-08-05 10:56:33 -0700677 InitTlsEntryPoints();
Dave Allisonb373e092014-02-20 16:06:36 -0800678 RemoveSuspendTrigger();
Ian Rogers5d76c432011-10-31 21:42:49 -0700679 InitCardTable();
Ian Rogers01ae5802012-09-28 16:14:01 -0700680 InitTid();
buzbee1452bee2015-03-06 14:43:04 -0800681 interpreter::InitInterpreterTls(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800682
Bilyan Borisovbb661c02016-04-04 16:27:32 +0100683#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000684 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = this;
685#else
Ian Rogers120f1c72012-09-28 17:17:10 -0700686 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, this), "attach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +0000687#endif
Ian Rogers120f1c72012-09-28 17:17:10 -0700688 DCHECK_EQ(Thread::Current(), this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700689
Ian Rogersdd7624d2014-03-14 17:43:00 -0700690 tls32_.thin_lock_thread_id = thread_list->AllocThreadId(this);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700691
Andreas Gampe449357d2015-06-01 22:29:51 -0700692 if (jni_env_ext != nullptr) {
693 DCHECK_EQ(jni_env_ext->vm, java_vm);
694 DCHECK_EQ(jni_env_ext->self, this);
695 tlsPtr_.jni_env = jni_env_ext;
696 } else {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100697 std::string error_msg;
698 tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
Andreas Gampe449357d2015-06-01 22:29:51 -0700699 if (tlsPtr_.jni_env == nullptr) {
Richard Uhlerda0a69e2016-10-11 15:06:38 +0100700 LOG(ERROR) << "Failed to create JNIEnvExt: " << error_msg;
Andreas Gampe449357d2015-06-01 22:29:51 -0700701 return false;
702 }
Andreas Gampe3f5881f2015-04-08 10:26:16 -0700703 }
704
Ian Rogers120f1c72012-09-28 17:17:10 -0700705 thread_list->Register(this);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800706 return true;
Elliott Hughes93e74e82011-09-13 11:07:03 -0700707}
708
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800709Thread* Thread::Attach(const char* thread_name, bool as_daemon, jobject thread_group,
710 bool create_peer) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700711 Runtime* runtime = Runtime::Current();
Dave Allison0aded082013-11-07 13:15:11 -0800712 if (runtime == nullptr) {
Ian Rogers120f1c72012-09-28 17:17:10 -0700713 LOG(ERROR) << "Thread attaching to non-existent runtime: " << thread_name;
Dave Allison0aded082013-11-07 13:15:11 -0800714 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700715 }
Ian Rogersf4d4da12014-11-11 16:10:33 -0800716 Thread* self;
Ian Rogers120f1c72012-09-28 17:17:10 -0700717 {
Dave Allison0aded082013-11-07 13:15:11 -0800718 MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
Mathieu Chartier590fee92013-09-13 13:46:47 -0700719 if (runtime->IsShuttingDownLocked()) {
Calin Juravlef39f0092016-04-28 12:59:33 +0100720 LOG(WARNING) << "Thread attaching while runtime is shutting down: " << thread_name;
Dave Allison0aded082013-11-07 13:15:11 -0800721 return nullptr;
Ian Rogers120f1c72012-09-28 17:17:10 -0700722 } else {
723 Runtime::Current()->StartThreadBirth();
724 self = new Thread(as_daemon);
Ian Rogersf4d4da12014-11-11 16:10:33 -0800725 bool init_success = self->Init(runtime->GetThreadList(), runtime->GetJavaVM());
Ian Rogers120f1c72012-09-28 17:17:10 -0700726 Runtime::Current()->EndThreadBirth();
Ian Rogersf4d4da12014-11-11 16:10:33 -0800727 if (!init_success) {
728 delete self;
729 return nullptr;
730 }
Ian Rogers120f1c72012-09-28 17:17:10 -0700731 }
732 }
Elliott Hughes93e74e82011-09-13 11:07:03 -0700733
Jeff Hao848f70a2014-01-15 13:49:50 -0800734 self->InitStringEntryPoints();
735
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700736 CHECK_NE(self->GetState(), kRunnable);
737 self->SetState(kNative);
Elliott Hughes93e74e82011-09-13 11:07:03 -0700738
Elliott Hughescac6cc72011-11-03 20:31:21 -0700739 // If we're the main thread, ClassLinker won't be created until after we're attached,
740 // so that thread needs a two-stage attach. Regular threads don't need this hack.
Elliott Hughesd9c67be2012-02-02 19:54:06 -0800741 // In the compiler, all threads need this hack, because no-one's going to be getting
742 // a native peer!
Mathieu Chartier664bebf2012-11-12 16:54:11 -0800743 if (create_peer) {
Elliott Hughes462c9442012-03-23 18:47:50 -0700744 self->CreatePeer(thread_name, as_daemon, thread_group);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -0700745 if (self->IsExceptionPending()) {
746 // We cannot keep the exception around, as we're deleting self. Try to be helpful and log it.
747 {
748 ScopedObjectAccess soa(self);
749 LOG(ERROR) << "Exception creating thread peer:";
750 LOG(ERROR) << self->GetException()->Dump();
751 self->ClearException();
752 }
753 runtime->GetThreadList()->Unregister(self);
754 // Unregister deletes self, no need to do this here.
755 return nullptr;
756 }
Elliott Hughes06e3ad42012-02-07 14:51:57 -0800757 } else {
758 // These aren't necessary, but they improve diagnostics for unit tests & command-line tools.
Dave Allison0aded082013-11-07 13:15:11 -0800759 if (thread_name != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700760 self->tlsPtr_.name->assign(thread_name);
Elliott Hughes22869a92012-03-27 14:08:24 -0700761 ::art::SetThreadName(thread_name);
Brian Carlstrom3ea69c02014-08-18 15:38:34 -0700762 } else if (self->GetJniEnv()->check_jni) {
763 LOG(WARNING) << *Thread::Current() << " attached without supplying a name";
Elliott Hughes22869a92012-03-27 14:08:24 -0700764 }
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700765 }
Elliott Hughescac6cc72011-11-03 20:31:21 -0700766
Andreas Gampe56623832015-07-09 21:53:15 -0700767 if (VLOG_IS_ON(threads)) {
768 if (thread_name != nullptr) {
769 VLOG(threads) << "Attaching thread " << thread_name;
770 } else {
771 VLOG(threads) << "Attaching unnamed thread.";
772 }
773 ScopedObjectAccess soa(self);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700774 self->Dump(LOG_STREAM(INFO));
Andreas Gampe56623832015-07-09 21:53:15 -0700775 }
776
Daniel Mihalyidfafeef2014-10-20 11:47:56 +0200777 {
778 ScopedObjectAccess soa(self);
779 Dbg::PostThreadStart(self);
780 }
781
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700782 return self;
783}
784
Ian Rogers365c1022012-06-22 15:05:28 -0700785void Thread::CreatePeer(const char* name, bool as_daemon, jobject thread_group) {
786 Runtime* runtime = Runtime::Current();
787 CHECK(runtime->IsStarted());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700788 JNIEnv* env = tlsPtr_.jni_env;
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700789
Dave Allison0aded082013-11-07 13:15:11 -0800790 if (thread_group == nullptr) {
Ian Rogers365c1022012-06-22 15:05:28 -0700791 thread_group = runtime->GetMainThreadGroup();
Elliott Hughes462c9442012-03-23 18:47:50 -0700792 }
Elliott Hughes726079d2011-10-07 18:43:44 -0700793 ScopedLocalRef<jobject> thread_name(env, env->NewStringUTF(name));
Mathieu Chartiere07fd172014-11-10 16:58:19 -0800794 // Add missing null check in case of OOM b/18297817
Vladimir Marko44512052014-11-12 15:41:57 +0000795 if (name != nullptr && thread_name.get() == nullptr) {
Mathieu Chartiere07fd172014-11-10 16:58:19 -0800796 CHECK(IsExceptionPending());
797 return;
798 }
Elliott Hughes8daa0922011-09-11 13:46:25 -0700799 jint thread_priority = GetNativePriority();
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700800 jboolean thread_is_daemon = as_daemon;
801
Elliott Hugheseac76672012-05-24 21:56:51 -0700802 ScopedLocalRef<jobject> peer(env, env->AllocObject(WellKnownClasses::java_lang_Thread));
Dave Allison0aded082013-11-07 13:15:11 -0800803 if (peer.get() == nullptr) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -0700804 CHECK(IsExceptionPending());
805 return;
Ian Rogers5d4bdc22011-11-02 22:15:43 -0700806 }
Ian Rogerscfaa4552012-11-26 21:00:08 -0800807 {
808 ScopedObjectAccess soa(this);
Mathieu Chartier1cc62e42016-10-03 18:01:28 -0700809 tlsPtr_.opeer = soa.Decode<mirror::Object>(peer.get()).Ptr();
Ian Rogerscfaa4552012-11-26 21:00:08 -0800810 }
Elliott Hugheseac76672012-05-24 21:56:51 -0700811 env->CallNonvirtualVoidMethod(peer.get(),
812 WellKnownClasses::java_lang_Thread,
813 WellKnownClasses::java_lang_Thread_init,
Ian Rogers365c1022012-06-22 15:05:28 -0700814 thread_group, thread_name.get(), thread_priority, thread_is_daemon);
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -0700815 if (IsExceptionPending()) {
816 return;
817 }
Elliott Hughesd369bb72011-09-12 14:41:14 -0700818
Ian Rogers120f1c72012-09-28 17:17:10 -0700819 Thread* self = this;
820 DCHECK_EQ(self, Thread::Current());
Ian Rogersdd7624d2014-03-14 17:43:00 -0700821 env->SetLongField(peer.get(), WellKnownClasses::java_lang_Thread_nativePeer,
822 reinterpret_cast<jlong>(self));
Ian Rogers120f1c72012-09-28 17:17:10 -0700823
824 ScopedObjectAccess soa(self);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700825 StackHandleScope<1> hs(self);
Andreas Gampe5a4b8a22014-09-11 08:30:08 -0700826 MutableHandle<mirror::String> peer_thread_name(hs.NewHandle(GetThreadName(soa)));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700827 if (peer_thread_name.Get() == nullptr) {
Brian Carlstrom00fae582011-10-28 01:16:28 -0700828 // The Thread constructor should have set the Thread.name to a
829 // non-null value. However, because we can run without code
830 // available (in the compiler, in tests), we manually assign the
831 // fields the constructor should have set.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100832 if (runtime->IsActiveTransaction()) {
833 InitPeer<true>(soa, thread_is_daemon, thread_group, thread_name.get(), thread_priority);
834 } else {
835 InitPeer<false>(soa, thread_is_daemon, thread_group, thread_name.get(), thread_priority);
836 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700837 peer_thread_name.Assign(GetThreadName(soa));
Brian Carlstrom00fae582011-10-28 01:16:28 -0700838 }
Elliott Hughes225f5a12012-06-11 11:23:48 -0700839 // 'thread_name' may have been null, so don't trust 'peer_thread_name' to be non-null.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700840 if (peer_thread_name.Get() != nullptr) {
Elliott Hughes899e7892012-01-24 14:57:32 -0800841 SetThreadName(peer_thread_name->ToModifiedUtf8().c_str());
Brian Carlstrom00fae582011-10-28 01:16:28 -0700842 }
Carl Shapiro61e019d2011-07-14 16:53:09 -0700843}
844
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100845template<bool kTransactionActive>
846void Thread::InitPeer(ScopedObjectAccess& soa, jboolean thread_is_daemon, jobject thread_group,
847 jobject thread_name, jint thread_priority) {
848 soa.DecodeField(WellKnownClasses::java_lang_Thread_daemon)->
Ian Rogersdd7624d2014-03-14 17:43:00 -0700849 SetBoolean<kTransactionActive>(tlsPtr_.opeer, thread_is_daemon);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100850 soa.DecodeField(WellKnownClasses::java_lang_Thread_group)->
Mathieu Chartier3398c782016-09-30 10:27:43 -0700851 SetObject<kTransactionActive>(tlsPtr_.opeer, soa.Decode<mirror::Object>(thread_group));
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100852 soa.DecodeField(WellKnownClasses::java_lang_Thread_name)->
Mathieu Chartier3398c782016-09-30 10:27:43 -0700853 SetObject<kTransactionActive>(tlsPtr_.opeer, soa.Decode<mirror::Object>(thread_name));
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100854 soa.DecodeField(WellKnownClasses::java_lang_Thread_priority)->
Ian Rogersdd7624d2014-03-14 17:43:00 -0700855 SetInt<kTransactionActive>(tlsPtr_.opeer, thread_priority);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100856}
857
Elliott Hughes899e7892012-01-24 14:57:32 -0800858void Thread::SetThreadName(const char* name) {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700859 tlsPtr_.name->assign(name);
Elliott Hughes899e7892012-01-24 14:57:32 -0800860 ::art::SetThreadName(name);
861 Dbg::DdmSendThreadNotification(this, CHUNK_TYPE("THNM"));
862}
863
Ian Rogersf4d4da12014-11-11 16:10:33 -0800864bool Thread::InitStackHwm() {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700865 void* read_stack_base;
866 size_t read_stack_size;
Elliott Hughes6d3fc562014-08-27 11:47:01 -0700867 size_t read_guard_size;
868 GetThreadStack(tlsPtr_.pthread_self, &read_stack_base, &read_stack_size, &read_guard_size);
Elliott Hughes36ecb782012-04-17 16:55:45 -0700869
Ian Rogers13735952014-10-08 12:43:28 -0700870 tlsPtr_.stack_begin = reinterpret_cast<uint8_t*>(read_stack_base);
Ian Rogersdd7624d2014-03-14 17:43:00 -0700871 tlsPtr_.stack_size = read_stack_size;
Elliott Hughes36ecb782012-04-17 16:55:45 -0700872
Dave Allison648d7112014-07-25 16:15:27 -0700873 // The minimum stack size we can cope with is the overflow reserved bytes (typically
874 // 8K) + the protected region size (4K) + another page (4K). Typically this will
875 // be 8+4+4 = 16K. The thread won't be able to do much with this stack even the GC takes
876 // between 8K and 12K.
877 uint32_t min_stack = GetStackOverflowReservedBytes(kRuntimeISA) + kStackOverflowProtectedSize
878 + 4 * KB;
879 if (read_stack_size <= min_stack) {
Ian Rogersf4d4da12014-11-11 16:10:33 -0800880 // Note, as we know the stack is small, avoid operations that could use a lot of stack.
Andreas Gampe3fec9ac2016-09-13 10:47:28 -0700881 LogHelper::LogLineLowStack(__PRETTY_FUNCTION__,
882 __LINE__,
883 ::android::base::ERROR,
884 "Attempt to attach a thread with a too-small stack");
Ian Rogersf4d4da12014-11-11 16:10:33 -0800885 return false;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700886 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700887
Vladimir Markob8f2f632015-01-02 14:23:26 +0000888 // This is included in the SIGQUIT output, but it's useful here for thread debugging.
889 VLOG(threads) << StringPrintf("Native stack is at %p (%s with %s guard)",
890 read_stack_base,
891 PrettySize(read_stack_size).c_str(),
892 PrettySize(read_guard_size).c_str());
893
Ian Rogers932746a2011-09-22 18:57:50 -0700894 // Set stack_end_ to the bottom of the stack saving space of stack overflows
Mathieu Chartier8e219ae2014-08-19 14:29:46 -0700895
896 Runtime* runtime = Runtime::Current();
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800897 bool implicit_stack_check = !runtime->ExplicitStackOverflowChecks() && !runtime->IsAotCompiler();
Andreas Gampe7df12cb2016-06-10 20:38:55 -0700898
899 // Valgrind on arm doesn't give the right values here. Do not install the guard page, and
900 // effectively disable stack overflow checks (we'll get segfaults, potentially) by setting
901 // stack_begin to 0.
902 const bool valgrind_on_arm =
903 (kRuntimeISA == kArm || kRuntimeISA == kArm64) &&
904 kMemoryToolIsValgrind &&
905 RUNNING_ON_MEMORY_TOOL != 0;
906 if (valgrind_on_arm) {
907 tlsPtr_.stack_begin = nullptr;
908 }
909
Dave Allisonb090a182014-08-14 17:02:48 +0000910 ResetDefaultStackEnd();
Dave Allisonf9439142014-03-27 15:10:22 -0700911
912 // Install the protected region if we are doing implicit overflow checks.
Andreas Gampe7df12cb2016-06-10 20:38:55 -0700913 if (implicit_stack_check && !valgrind_on_arm) {
Dave Allison648d7112014-07-25 16:15:27 -0700914 // The thread might have protected region at the bottom. We need
915 // to install our own region so we need to move the limits
916 // of the stack to make room for it.
Dave Allison216cf232014-08-18 15:49:51 -0700917
Elliott Hughes6d3fc562014-08-27 11:47:01 -0700918 tlsPtr_.stack_begin += read_guard_size + kStackOverflowProtectedSize;
919 tlsPtr_.stack_end += read_guard_size + kStackOverflowProtectedSize;
920 tlsPtr_.stack_size -= read_guard_size;
Dave Allison648d7112014-07-25 16:15:27 -0700921
922 InstallImplicitProtection();
Dave Allisonf9439142014-03-27 15:10:22 -0700923 }
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700924
925 // Sanity check.
Andreas Gampeb87c03f2016-06-10 20:34:55 -0700926 CHECK_GT(FindStackTop(), reinterpret_cast<void*>(tlsPtr_.stack_end));
Ian Rogersf4d4da12014-11-11 16:10:33 -0800927
928 return true;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700929}
930
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700931void Thread::ShortDump(std::ostream& os) const {
932 os << "Thread[";
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700933 if (GetThreadId() != 0) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700934 // If we're in kStarting, we won't have a thin lock id or tid yet.
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700935 os << GetThreadId()
Mathieu Chartierb28412e2015-04-24 15:28:36 -0700936 << ",tid=" << GetTid() << ',';
Elliott Hughese0918552011-10-28 17:18:29 -0700937 }
Ian Rogers474b6da2012-09-25 00:20:38 -0700938 os << GetState()
Mathieu Chartierb28412e2015-04-24 15:28:36 -0700939 << ",Thread*=" << this
940 << ",peer=" << tlsPtr_.opeer
941 << ",\"" << (tlsPtr_.name != nullptr ? *tlsPtr_.name : "null") << "\""
942 << "]";
Elliott Hughesa0957642011-09-02 14:27:33 -0700943}
944
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000945void Thread::Dump(std::ostream& os, bool dump_native_stack, BacktraceMap* backtrace_map) const {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700946 DumpState(os);
Nicolas Geoffraya73280d2016-02-15 13:05:16 +0000947 DumpStack(os, dump_native_stack, backtrace_map);
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700948}
949
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -0700950mirror::String* Thread::GetThreadName(const ScopedObjectAccessAlreadyRunnable& soa) const {
Mathieu Chartierc7853442015-03-27 14:35:38 -0700951 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -0700952 if (tlsPtr_.opeer == nullptr) {
953 return nullptr;
954 }
955 ObjPtr<mirror::Object> name = f->GetObject(tlsPtr_.opeer);
956 return name == nullptr ? nullptr : name->AsString();
Elliott Hughesfc861622011-10-17 17:57:47 -0700957}
958
Elliott Hughesffb465f2012-03-01 18:46:05 -0800959void Thread::GetThreadName(std::string& name) const {
Ian Rogersdd7624d2014-03-14 17:43:00 -0700960 name.assign(*tlsPtr_.name);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800961}
962
Jeff Hao57dac6e2013-08-15 16:36:24 -0700963uint64_t Thread::GetCpuMicroTime() const {
Elliott Hughes0a18df82015-01-09 15:16:16 -0800964#if defined(__linux__)
Jeff Hao57dac6e2013-08-15 16:36:24 -0700965 clockid_t cpu_clock_id;
Ian Rogersdd7624d2014-03-14 17:43:00 -0700966 pthread_getcpuclockid(tlsPtr_.pthread_self, &cpu_clock_id);
Jeff Hao57dac6e2013-08-15 16:36:24 -0700967 timespec now;
968 clock_gettime(cpu_clock_id, &now);
Ian Rogers0f678472014-03-10 16:18:37 -0700969 return static_cast<uint64_t>(now.tv_sec) * UINT64_C(1000000) + now.tv_nsec / UINT64_C(1000);
Elliott Hughes0a18df82015-01-09 15:16:16 -0800970#else // __APPLE__
Jeff Hao57dac6e2013-08-15 16:36:24 -0700971 UNIMPLEMENTED(WARNING);
972 return -1;
973#endif
974}
975
Ian Rogers01ae5802012-09-28 16:14:01 -0700976// Attempt to rectify locks so that we dump thread list with required locks before exiting.
977static void UnsafeLogFatalForSuspendCount(Thread* self, Thread* thread) NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers120f1c72012-09-28 17:17:10 -0700978 LOG(ERROR) << *thread << " suspend count already zero.";
Ian Rogers01ae5802012-09-28 16:14:01 -0700979 Locks::thread_suspend_count_lock_->Unlock(self);
980 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
981 Locks::mutator_lock_->SharedTryLock(self);
982 if (!Locks::mutator_lock_->IsSharedHeld(self)) {
983 LOG(WARNING) << "Dumping thread list without holding mutator_lock_";
984 }
985 }
986 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
987 Locks::thread_list_lock_->TryLock(self);
988 if (!Locks::thread_list_lock_->IsExclusiveHeld(self)) {
989 LOG(WARNING) << "Dumping thread list without holding thread_list_lock_";
990 }
991 }
992 std::ostringstream ss;
Ian Rogers7b078e82014-09-10 14:44:24 -0700993 Runtime::Current()->GetThreadList()->Dump(ss);
Ian Rogers120f1c72012-09-28 17:17:10 -0700994 LOG(FATAL) << ss.str();
Ian Rogers01ae5802012-09-28 16:14:01 -0700995}
996
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -0700997bool Thread::ModifySuspendCountInternal(Thread* self,
998 int delta,
999 AtomicInteger* suspend_barrier,
1000 bool for_debugger) {
Ian Rogers2966e132014-04-02 08:34:36 -07001001 if (kIsDebugBuild) {
1002 DCHECK(delta == -1 || delta == +1 || delta == -tls32_.debug_suspend_count)
1003 << delta << " " << tls32_.debug_suspend_count << " " << this;
1004 DCHECK_GE(tls32_.suspend_count, tls32_.debug_suspend_count) << this;
1005 Locks::thread_suspend_count_lock_->AssertHeld(self);
1006 if (this != self && !IsSuspended()) {
1007 Locks::thread_list_lock_->AssertHeld(self);
1008 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001009 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001010 if (UNLIKELY(delta < 0 && tls32_.suspend_count <= 0)) {
Ian Rogers01ae5802012-09-28 16:14:01 -07001011 UnsafeLogFatalForSuspendCount(self, this);
Yu Lieac44242015-06-29 10:50:03 +08001012 return false;
1013 }
1014
Hiroshi Yamauchi02e7f1a2016-10-03 15:32:01 -07001015 if (kUseReadBarrier && delta > 0 && this != self && tlsPtr_.flip_function != nullptr) {
1016 // Force retry of a suspend request if it's in the middle of a thread flip to avoid a
1017 // deadlock. b/31683379.
1018 return false;
1019 }
1020
Yu Lieac44242015-06-29 10:50:03 +08001021 uint16_t flags = kSuspendRequest;
1022 if (delta > 0 && suspend_barrier != nullptr) {
1023 uint32_t available_barrier = kMaxSuspendBarriers;
1024 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1025 if (tlsPtr_.active_suspend_barriers[i] == nullptr) {
1026 available_barrier = i;
1027 break;
1028 }
1029 }
1030 if (available_barrier == kMaxSuspendBarriers) {
1031 // No barrier spaces available, we can't add another.
1032 return false;
1033 }
1034 tlsPtr_.active_suspend_barriers[available_barrier] = suspend_barrier;
1035 flags |= kActiveSuspendBarrier;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001036 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001037
Ian Rogersdd7624d2014-03-14 17:43:00 -07001038 tls32_.suspend_count += delta;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001039 if (for_debugger) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001040 tls32_.debug_suspend_count += delta;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001041 }
Ian Rogers01ae5802012-09-28 16:14:01 -07001042
Ian Rogersdd7624d2014-03-14 17:43:00 -07001043 if (tls32_.suspend_count == 0) {
Ian Rogers474b6da2012-09-25 00:20:38 -07001044 AtomicClearFlag(kSuspendRequest);
1045 } else {
Yu Lieac44242015-06-29 10:50:03 +08001046 // Two bits might be set simultaneously.
1047 tls32_.state_and_flags.as_atomic_int.FetchAndOrSequentiallyConsistent(flags);
Dave Allisonb373e092014-02-20 16:06:36 -08001048 TriggerSuspend();
Ian Rogers474b6da2012-09-25 00:20:38 -07001049 }
Yu Lieac44242015-06-29 10:50:03 +08001050 return true;
1051}
1052
1053bool Thread::PassActiveSuspendBarriers(Thread* self) {
1054 // Grab the suspend_count lock and copy the current set of
1055 // barriers. Then clear the list and the flag. The ModifySuspendCount
1056 // function requires the lock so we prevent a race between setting
1057 // the kActiveSuspendBarrier flag and clearing it.
1058 AtomicInteger* pass_barriers[kMaxSuspendBarriers];
1059 {
1060 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1061 if (!ReadFlag(kActiveSuspendBarrier)) {
1062 // quick exit test: the barriers have already been claimed - this is
1063 // possible as there may be a race to claim and it doesn't matter
1064 // who wins.
1065 // All of the callers of this function (except the SuspendAllInternal)
1066 // will first test the kActiveSuspendBarrier flag without lock. Here
1067 // double-check whether the barrier has been passed with the
1068 // suspend_count lock.
1069 return false;
1070 }
1071
1072 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1073 pass_barriers[i] = tlsPtr_.active_suspend_barriers[i];
1074 tlsPtr_.active_suspend_barriers[i] = nullptr;
1075 }
1076 AtomicClearFlag(kActiveSuspendBarrier);
1077 }
1078
1079 uint32_t barrier_count = 0;
1080 for (uint32_t i = 0; i < kMaxSuspendBarriers; i++) {
1081 AtomicInteger* pending_threads = pass_barriers[i];
1082 if (pending_threads != nullptr) {
1083 bool done = false;
1084 do {
1085 int32_t cur_val = pending_threads->LoadRelaxed();
1086 CHECK_GT(cur_val, 0) << "Unexpected value for PassActiveSuspendBarriers(): " << cur_val;
1087 // Reduce value by 1.
1088 done = pending_threads->CompareExchangeWeakRelaxed(cur_val, cur_val - 1);
1089#if ART_USE_FUTEXES
1090 if (done && (cur_val - 1) == 0) { // Weak CAS may fail spuriously.
1091 futex(pending_threads->Address(), FUTEX_WAKE, -1, nullptr, nullptr, 0);
1092 }
1093#endif
1094 } while (!done);
1095 ++barrier_count;
1096 }
1097 }
1098 CHECK_GT(barrier_count, 0U);
1099 return true;
1100}
1101
1102void Thread::ClearSuspendBarrier(AtomicInteger* target) {
1103 CHECK(ReadFlag(kActiveSuspendBarrier));
1104 bool clear_flag = true;
1105 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1106 AtomicInteger* ptr = tlsPtr_.active_suspend_barriers[i];
1107 if (ptr == target) {
1108 tlsPtr_.active_suspend_barriers[i] = nullptr;
1109 } else if (ptr != nullptr) {
1110 clear_flag = false;
1111 }
1112 }
1113 if (LIKELY(clear_flag)) {
1114 AtomicClearFlag(kActiveSuspendBarrier);
1115 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001116}
1117
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001118void Thread::RunCheckpointFunction() {
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001119 bool done = false;
1120 do {
1121 // Grab the suspend_count lock and copy the checkpoints one by one. When the last checkpoint is
1122 // copied, clear the list and the flag. The RequestCheckpoint function will also grab this lock
1123 // to prevent a race between setting the kCheckpointRequest flag and clearing it.
1124 Closure* checkpoint = nullptr;
1125 {
1126 MutexLock mu(this, *Locks::thread_suspend_count_lock_);
1127 if (tlsPtr_.checkpoint_function != nullptr) {
1128 checkpoint = tlsPtr_.checkpoint_function;
1129 if (!checkpoint_overflow_.empty()) {
1130 // Overflow list not empty, copy the first one out and continue.
1131 tlsPtr_.checkpoint_function = checkpoint_overflow_.front();
1132 checkpoint_overflow_.pop_front();
1133 } else {
1134 // No overflow checkpoints, this means that we are on the last pending checkpoint.
1135 tlsPtr_.checkpoint_function = nullptr;
1136 AtomicClearFlag(kCheckpointRequest);
1137 done = true;
1138 }
1139 } else {
1140 LOG(FATAL) << "Checkpoint flag set without pending checkpoint";
1141 }
Dave Allison0aded082013-11-07 13:15:11 -08001142 }
Dave Allison0aded082013-11-07 13:15:11 -08001143
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001144 // Outside the lock, run the checkpoint functions that we collected.
1145 ScopedTrace trace("Run checkpoint function");
1146 DCHECK(checkpoint != nullptr);
1147 checkpoint->Run(this);
1148 } while (!done);
Mathieu Chartier752a0e62013-06-27 11:03:27 -07001149}
1150
Mathieu Chartier0e4627e2012-10-23 16:13:36 -07001151bool Thread::RequestCheckpoint(Closure* function) {
Chris Dearman59cde532013-12-04 18:53:49 -08001152 union StateAndFlags old_state_and_flags;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001153 old_state_and_flags.as_int = tls32_.state_and_flags.as_int;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001154 if (old_state_and_flags.as_struct.state != kRunnable) {
1155 return false; // Fail, thread is suspended and so can't run a checkpoint.
1156 }
Dave Allison0aded082013-11-07 13:15:11 -08001157
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001158 // We must be runnable to request a checkpoint.
Mathieu Chartier5f51d4b2013-12-03 14:24:05 -08001159 DCHECK_EQ(old_state_and_flags.as_struct.state, kRunnable);
Chris Dearman59cde532013-12-04 18:53:49 -08001160 union StateAndFlags new_state_and_flags;
1161 new_state_and_flags.as_int = old_state_and_flags.as_int;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001162 new_state_and_flags.as_struct.flags |= kCheckpointRequest;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001163 bool success = tls32_.state_and_flags.as_atomic_int.CompareExchangeStrongSequentiallyConsistent(
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001164 old_state_and_flags.as_int, new_state_and_flags.as_int);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001165 if (success) {
1166 // Succeeded setting checkpoint flag, now insert the actual checkpoint.
1167 if (tlsPtr_.checkpoint_function == nullptr) {
1168 tlsPtr_.checkpoint_function = function;
1169 } else {
1170 checkpoint_overflow_.push_back(function);
1171 }
Dave Allison0aded082013-11-07 13:15:11 -08001172 CHECK_EQ(ReadFlag(kCheckpointRequest), true);
Dave Allisonb373e092014-02-20 16:06:36 -08001173 TriggerSuspend();
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001174 }
Ian Rogers8c1b5f72014-07-09 22:02:36 -07001175 return success;
Mathieu Chartier858f1c52012-10-17 17:45:55 -07001176}
1177
Andreas Gampee9f67122016-10-27 19:21:23 -07001178class BarrierClosure : public Closure {
1179 public:
1180 explicit BarrierClosure(Closure* wrapped) : wrapped_(wrapped), barrier_(0) {}
1181
1182 void Run(Thread* self) OVERRIDE {
1183 wrapped_->Run(self);
1184 barrier_.Pass(self);
1185 }
1186
1187 void Wait(Thread* self) {
1188 barrier_.Increment(self, 1);
1189 }
1190
1191 private:
1192 Closure* wrapped_;
1193 Barrier barrier_;
1194};
1195
1196void Thread::RequestSynchronousCheckpoint(Closure* function) {
1197 if (this == Thread::Current()) {
1198 // Asked to run on this thread. Just run.
1199 function->Run(this);
1200 return;
1201 }
1202 Thread* self = Thread::Current();
1203
1204 // The current thread is not this thread.
1205
1206 for (;;) {
1207 // If this thread is runnable, try to schedule a checkpoint. Do some gymnastics to not hold the
1208 // suspend-count lock for too long.
1209 if (GetState() == ThreadState::kRunnable) {
1210 BarrierClosure barrier_closure(function);
1211 bool installed = false;
1212 {
1213 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
1214 installed = RequestCheckpoint(&barrier_closure);
1215 }
1216 if (installed) {
1217 barrier_closure.Wait(self);
1218 return;
1219 }
1220 // Fall-through.
1221 }
1222
1223 // This thread is not runnable, make sure we stay suspended, then run the checkpoint.
1224 // Note: ModifySuspendCountInternal also expects the thread_list_lock to be held in
1225 // certain situations.
1226 {
1227 MutexLock mu(self, *Locks::thread_list_lock_);
1228 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1229
1230 if (!ModifySuspendCount(self, +1, nullptr, false)) {
1231 // Just retry the loop.
1232 sched_yield();
1233 continue;
1234 }
1235 }
1236
1237 while (GetState() == ThreadState::kRunnable) {
1238 // We became runnable again. Wait till the suspend triggered in ModifySuspendCount
1239 // moves us to suspended.
1240 sched_yield();
1241 }
1242
1243 function->Run(this);
1244
1245 {
1246 MutexLock mu(self, *Locks::thread_list_lock_);
1247 MutexLock mu2(self, *Locks::thread_suspend_count_lock_);
1248
1249 DCHECK_NE(GetState(), ThreadState::kRunnable);
1250 CHECK(ModifySuspendCount(self, -1, nullptr, false));
1251 }
1252
1253 return; // We're done, break out of the loop.
1254 }
1255}
1256
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001257Closure* Thread::GetFlipFunction() {
1258 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1259 Closure* func;
1260 do {
1261 func = atomic_func->LoadRelaxed();
1262 if (func == nullptr) {
1263 return nullptr;
1264 }
1265 } while (!atomic_func->CompareExchangeWeakSequentiallyConsistent(func, nullptr));
1266 DCHECK(func != nullptr);
1267 return func;
1268}
1269
1270void Thread::SetFlipFunction(Closure* function) {
1271 CHECK(function != nullptr);
1272 Atomic<Closure*>* atomic_func = reinterpret_cast<Atomic<Closure*>*>(&tlsPtr_.flip_function);
1273 atomic_func->StoreSequentiallyConsistent(function);
1274}
1275
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001276void Thread::FullSuspendCheck() {
Mathieu Chartier32ce2ad2016-03-04 14:58:03 -08001277 ScopedTrace trace(__FUNCTION__);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001278 VLOG(threads) << this << " self-suspending";
1279 // Make thread appear suspended to other threads, release mutator_lock_.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001280 // Transition to suspended and back to runnable, re-acquire share on mutator_lock_.
1281 ScopedThreadSuspension(this, kSuspended);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001282 VLOG(threads) << this << " self-reviving";
1283}
1284
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001285void Thread::DumpState(std::ostream& os, const Thread* thread, pid_t tid) {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001286 std::string group_name;
1287 int priority;
1288 bool is_daemon = false;
Ian Rogers81d425b2012-09-27 16:03:43 -07001289 Thread* self = Thread::Current();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001290
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001291 // If flip_function is not null, it means we have run a checkpoint
1292 // before the thread wakes up to execute the flip function and the
1293 // thread roots haven't been forwarded. So the following access to
1294 // the roots (opeer or methods in the frames) would be bad. Run it
1295 // here. TODO: clean up.
1296 if (thread != nullptr) {
1297 ScopedObjectAccessUnchecked soa(self);
1298 Thread* this_thread = const_cast<Thread*>(thread);
1299 Closure* flip_func = this_thread->GetFlipFunction();
1300 if (flip_func != nullptr) {
1301 flip_func->Run(this_thread);
1302 }
1303 }
1304
Mathieu Chartierc7a966d2014-04-10 18:06:32 -07001305 // Don't do this if we are aborting since the GC may have all the threads suspended. This will
1306 // cause ScopedObjectAccessUnchecked to deadlock.
Nicolas Geoffraydb978712014-12-09 13:33:38 +00001307 if (gAborting == 0 && self != nullptr && thread != nullptr && thread->tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001308 ScopedObjectAccessUnchecked soa(self);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001309 priority = soa.DecodeField(WellKnownClasses::java_lang_Thread_priority)
1310 ->GetInt(thread->tlsPtr_.opeer);
1311 is_daemon = soa.DecodeField(WellKnownClasses::java_lang_Thread_daemon)
1312 ->GetBoolean(thread->tlsPtr_.opeer);
Elliott Hughesd369bb72011-09-12 14:41:14 -07001313
Mathieu Chartier3398c782016-09-30 10:27:43 -07001314 ObjPtr<mirror::Object> thread_group =
Ian Rogersdd7624d2014-03-14 17:43:00 -07001315 soa.DecodeField(WellKnownClasses::java_lang_Thread_group)->GetObject(thread->tlsPtr_.opeer);
Ian Rogers120f1c72012-09-28 17:17:10 -07001316
Dave Allison0aded082013-11-07 13:15:11 -08001317 if (thread_group != nullptr) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001318 ArtField* group_name_field =
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001319 soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_name);
Mathieu Chartier3398c782016-09-30 10:27:43 -07001320 ObjPtr<mirror::String> group_name_string =
1321 group_name_field->GetObject(thread_group)->AsString();
Dave Allison0aded082013-11-07 13:15:11 -08001322 group_name = (group_name_string != nullptr) ? group_name_string->ToModifiedUtf8() : "<null>";
Elliott Hughesd369bb72011-09-12 14:41:14 -07001323 }
1324 } else {
Elliott Hughesd369bb72011-09-12 14:41:14 -07001325 priority = GetNativePriority();
Elliott Hughesdcc24742011-09-07 14:02:44 -07001326 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001327
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001328 std::string scheduler_group_name(GetSchedulerGroupName(tid));
Elliott Hughes1bac54f2012-03-16 12:48:31 -07001329 if (scheduler_group_name.empty()) {
1330 scheduler_group_name = "default";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001331 }
1332
Dave Allison0aded082013-11-07 13:15:11 -08001333 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001334 os << '"' << *thread->tlsPtr_.name << '"';
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001335 if (is_daemon) {
1336 os << " daemon";
1337 }
1338 os << " prio=" << priority
Ian Rogersd9c4fc92013-10-01 19:45:43 -07001339 << " tid=" << thread->GetThreadId()
Elliott Hughes80537bb2013-01-04 16:37:26 -08001340 << " " << thread->GetState();
1341 if (thread->IsStillStarting()) {
1342 os << " (still starting up)";
1343 }
1344 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001345 } else {
Elliott Hughes289be852012-06-12 13:57:20 -07001346 os << '"' << ::art::GetThreadName(tid) << '"'
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001347 << " prio=" << priority
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001348 << " (not attached)\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001349 }
Elliott Hughesd92bec42011-09-02 17:04:36 -07001350
Dave Allison0aded082013-11-07 13:15:11 -08001351 if (thread != nullptr) {
Ian Rogers81d425b2012-09-27 16:03:43 -07001352 MutexLock mu(self, *Locks::thread_suspend_count_lock_);
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001353 os << " | group=\"" << group_name << "\""
Ian Rogersdd7624d2014-03-14 17:43:00 -07001354 << " sCount=" << thread->tls32_.suspend_count
1355 << " dsCount=" << thread->tls32_.debug_suspend_count
1356 << " obj=" << reinterpret_cast<void*>(thread->tlsPtr_.opeer)
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001357 << " self=" << reinterpret_cast<const void*>(thread) << "\n";
1358 }
Elliott Hughes0d39c122012-06-06 16:41:17 -07001359
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001360 os << " | sysTid=" << tid
1361 << " nice=" << getpriority(PRIO_PROCESS, tid)
Elliott Hughes0d39c122012-06-06 16:41:17 -07001362 << " cgrp=" << scheduler_group_name;
Dave Allison0aded082013-11-07 13:15:11 -08001363 if (thread != nullptr) {
Elliott Hughes0d39c122012-06-06 16:41:17 -07001364 int policy;
1365 sched_param sp;
Ian Rogersdd7624d2014-03-14 17:43:00 -07001366 CHECK_PTHREAD_CALL(pthread_getschedparam, (thread->tlsPtr_.pthread_self, &policy, &sp),
1367 __FUNCTION__);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001368 os << " sched=" << policy << "/" << sp.sched_priority
Ian Rogersdd7624d2014-03-14 17:43:00 -07001369 << " handle=" << reinterpret_cast<void*>(thread->tlsPtr_.pthread_self);
Elliott Hughes0d39c122012-06-06 16:41:17 -07001370 }
1371 os << "\n";
Elliott Hughesd92bec42011-09-02 17:04:36 -07001372
1373 // Grab the scheduler stats for this thread.
1374 std::string scheduler_stats;
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001375 if (ReadFileToString(StringPrintf("/proc/self/task/%d/schedstat", tid), &scheduler_stats)) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001376 scheduler_stats.resize(scheduler_stats.size() - 1); // Lose the trailing '\n'.
Elliott Hughesd92bec42011-09-02 17:04:36 -07001377 } else {
1378 scheduler_stats = "0 0 0";
1379 }
1380
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001381 char native_thread_state = '?';
Elliott Hughesd92bec42011-09-02 17:04:36 -07001382 int utime = 0;
1383 int stime = 0;
1384 int task_cpu = 0;
Brian Carlstrom29212012013-09-12 22:18:30 -07001385 GetTaskStats(tid, &native_thread_state, &utime, &stime, &task_cpu);
Elliott Hughesd92bec42011-09-02 17:04:36 -07001386
Elliott Hughesba0b9c52012-09-20 11:25:12 -07001387 os << " | state=" << native_thread_state
1388 << " schedstat=( " << scheduler_stats << " )"
Elliott Hughesd92bec42011-09-02 17:04:36 -07001389 << " utm=" << utime
1390 << " stm=" << stime
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001391 << " core=" << task_cpu
1392 << " HZ=" << sysconf(_SC_CLK_TCK) << "\n";
Dave Allison0aded082013-11-07 13:15:11 -08001393 if (thread != nullptr) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001394 os << " | stack=" << reinterpret_cast<void*>(thread->tlsPtr_.stack_begin) << "-"
1395 << reinterpret_cast<void*>(thread->tlsPtr_.stack_end) << " stackSize="
1396 << PrettySize(thread->tlsPtr_.stack_size) << "\n";
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001397 // Dump the held mutexes.
1398 os << " | held mutexes=";
1399 for (size_t i = 0; i < kLockLevelCount; ++i) {
1400 if (i != kMonitorLock) {
1401 BaseMutex* mutex = thread->GetHeldMutex(static_cast<LockLevel>(i));
1402 if (mutex != nullptr) {
1403 os << " \"" << mutex->GetName() << "\"";
1404 if (mutex->IsReaderWriterMutex()) {
1405 ReaderWriterMutex* rw_mutex = down_cast<ReaderWriterMutex*>(mutex);
Ian Rogersa9d8c4c2014-07-07 21:38:36 -07001406 if (rw_mutex->GetExclusiveOwnerTid() == static_cast<uint64_t>(tid)) {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001407 os << "(exclusive held)";
1408 } else {
Mathieu Chartier9db911e2014-06-04 11:23:58 -07001409 os << "(shared held)";
1410 }
1411 }
1412 }
1413 }
1414 }
1415 os << "\n";
Elliott Hughesabbe07d2012-06-05 17:42:23 -07001416 }
1417}
1418
1419void Thread::DumpState(std::ostream& os) const {
1420 Thread::DumpState(os, this, GetTid());
Elliott Hughesd92bec42011-09-02 17:04:36 -07001421}
1422
Ian Rogers0399dde2012-06-06 17:09:28 -07001423struct StackDumpVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001424 StackDumpVisitor(std::ostream& os_in, Thread* thread_in, Context* context, bool can_allocate_in)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001425 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001426 : StackVisitor(thread_in, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
1427 os(os_in),
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01001428 can_allocate(can_allocate_in),
1429 last_method(nullptr),
1430 last_line_number(0),
1431 repetition_count(0),
1432 frame_count(0) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07001433
Ian Rogersbdb03912011-09-14 00:55:44 -07001434 virtual ~StackDumpVisitor() {
Elliott Hughese85d2e92012-05-01 14:02:10 -07001435 if (frame_count == 0) {
1436 os << " (no managed stack frames)\n";
1437 }
Elliott Hughesd369bb72011-09-12 14:41:14 -07001438 }
1439
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001440 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001441 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07001442 if (m->IsRuntimeMethod()) {
Elliott Hughes530fa002012-03-12 11:44:49 -07001443 return true;
Ian Rogers90865722011-09-19 11:11:44 -07001444 }
Andreas Gampe542451c2016-07-26 09:02:02 -07001445 m = m->GetInterfaceMethodIfProxy(kRuntimePointerSize);
Ian Rogers28ad40d2011-10-27 15:19:26 -07001446 const int kMaxRepetition = 3;
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001447 mirror::Class* c = m->GetDeclaringClass();
Ian Rogersef7d42f2014-01-06 12:55:46 -08001448 mirror::DexCache* dex_cache = c->GetDexCache();
Ian Rogersb861dc02011-11-14 17:00:05 -08001449 int line_number = -1;
Dave Allison0aded082013-11-07 13:15:11 -08001450 if (dex_cache != nullptr) { // be tolerant of bad input
David Sehr9323e6e2016-09-13 08:58:35 -07001451 const DexFile* dex_file = dex_cache->GetDexFile();
1452 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc(false));
Ian Rogersb861dc02011-11-14 17:00:05 -08001453 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001454 if (line_number == last_line_number && last_method == m) {
Dave Allison0aded082013-11-07 13:15:11 -08001455 ++repetition_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001456 } else {
Ian Rogers28ad40d2011-10-27 15:19:26 -07001457 if (repetition_count >= kMaxRepetition) {
1458 os << " ... repeated " << (repetition_count - kMaxRepetition) << " times\n";
1459 }
1460 repetition_count = 0;
1461 last_line_number = line_number;
1462 last_method = m;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001463 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001464 if (repetition_count < kMaxRepetition) {
David Sehr709b0702016-10-13 09:12:37 -07001465 os << " at " << m->PrettyMethod(false);
Ian Rogers28ad40d2011-10-27 15:19:26 -07001466 if (m->IsNative()) {
1467 os << "(Native method)";
1468 } else {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001469 const char* source_file(m->GetDeclaringClassSourceFile());
Dave Allison0aded082013-11-07 13:15:11 -08001470 os << "(" << (source_file != nullptr ? source_file : "unavailable")
Brian Carlstrom2e450bf2013-09-06 15:39:46 -07001471 << ":" << line_number << ")";
Ian Rogers28ad40d2011-10-27 15:19:26 -07001472 }
1473 os << "\n";
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001474 if (frame_count == 0) {
Sebastien Hertz26f72862015-09-15 09:52:07 +02001475 Monitor::DescribeWait(os, GetThread());
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001476 }
1477 if (can_allocate) {
Andreas Gampe956a5222014-08-16 13:41:10 -07001478 // Visit locks, but do not abort on errors. This would trigger a nested abort.
1479 Monitor::VisitLocks(this, DumpLockedObject, &os, false);
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001480 }
Ian Rogers28ad40d2011-10-27 15:19:26 -07001481 }
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001482
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001483 ++frame_count;
Elliott Hughes530fa002012-03-12 11:44:49 -07001484 return true;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001485 }
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001486
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001487 static void DumpLockedObject(mirror::Object* o, void* context)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001488 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001489 std::ostream& os = *reinterpret_cast<std::ostream*>(context);
Ian Rogersd803bc72014-04-01 15:33:03 -07001490 os << " - locked ";
1491 if (o == nullptr) {
1492 os << "an unknown object";
1493 } else {
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001494 if (kUseReadBarrier && Thread::Current()->GetIsGcMarking()) {
1495 // We may call Thread::Dump() in the middle of the CC thread flip and this thread's stack
1496 // may have not been flipped yet and "o" may be a from-space (stale) ref, in which case the
1497 // IdentityHashCode call below will crash. So explicitly mark/forward it here.
1498 o = ReadBarrier::Mark(o);
1499 }
Mathieu Chartier4d7f61d2014-04-17 14:43:39 -07001500 if ((o->GetLockWord(false).GetState() == LockWord::kThinLocked) &&
Ian Rogersd803bc72014-04-01 15:33:03 -07001501 Locks::mutator_lock_->IsExclusiveHeld(Thread::Current())) {
1502 // Getting the identity hashcode here would result in lock inflation and suspension of the
1503 // current thread, which isn't safe if this is the only runnable thread.
1504 os << StringPrintf("<@addr=0x%" PRIxPTR "> (a %s)", reinterpret_cast<intptr_t>(o),
David Sehr709b0702016-10-13 09:12:37 -07001505 o->PrettyTypeOf().c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001506 } else {
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001507 // IdentityHashCode can cause thread suspension, which would invalidate o if it moved. So
1508 // we get the pretty type beofre we call IdentityHashCode.
David Sehr709b0702016-10-13 09:12:37 -07001509 const std::string pretty_type(o->PrettyTypeOf());
Mathieu Chartiere6a8eec2015-01-06 14:17:57 -08001510 os << StringPrintf("<0x%08x> (a %s)", o->IdentityHashCode(), pretty_type.c_str());
Ian Rogersd803bc72014-04-01 15:33:03 -07001511 }
1512 }
1513 os << "\n";
Elliott Hughes4993bbc2013-01-10 15:41:25 -08001514 }
1515
Elliott Hughes08fc03a2012-06-26 17:34:00 -07001516 std::ostream& os;
Ian Rogers0878d652013-04-18 17:38:35 -07001517 const bool can_allocate;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001518 ArtMethod* last_method;
Ian Rogers28ad40d2011-10-27 15:19:26 -07001519 int last_line_number;
1520 int repetition_count;
Elliott Hughes8e4aac52011-09-26 17:03:36 -07001521 int frame_count;
Elliott Hughesd369bb72011-09-12 14:41:14 -07001522};
1523
Ian Rogers33e95662013-05-20 20:29:14 -07001524static bool ShouldShowNativeStack(const Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001525 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesaef701d2013-04-05 18:15:40 -07001526 ThreadState state = thread->GetState();
1527
1528 // In native code somewhere in the VM (one of the kWaitingFor* states)? That's interesting.
1529 if (state > kWaiting && state < kStarting) {
1530 return true;
1531 }
1532
1533 // In an Object.wait variant or Thread.sleep? That's not interesting.
1534 if (state == kTimedWaiting || state == kSleeping || state == kWaiting) {
1535 return false;
1536 }
1537
Christopher Ferris2366f4e2014-09-19 17:23:59 -07001538 // Threads with no managed stack frames should be shown.
1539 const ManagedStack* managed_stack = thread->GetManagedStack();
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001540 if (managed_stack == nullptr || (managed_stack->GetTopQuickFrame() == nullptr &&
1541 managed_stack->GetTopShadowFrame() == nullptr)) {
Christopher Ferris2366f4e2014-09-19 17:23:59 -07001542 return true;
1543 }
1544
Elliott Hughesaef701d2013-04-05 18:15:40 -07001545 // In some other native method? That's interesting.
1546 // We don't just check kNative because native methods will be in state kSuspended if they're
1547 // calling back into the VM, or kBlocked if they're blocked on a monitor, or one of the
1548 // thread-startup states if it's early enough in their life cycle (http://b/7432159).
Mathieu Chartiere401d142015-04-22 13:56:20 -07001549 ArtMethod* current_method = thread->GetCurrentMethod(nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08001550 return current_method != nullptr && current_method->IsNative();
Elliott Hughesaef701d2013-04-05 18:15:40 -07001551}
1552
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001553void Thread::DumpJavaStack(std::ostream& os) const {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001554 // If flip_function is not null, it means we have run a checkpoint
1555 // before the thread wakes up to execute the flip function and the
1556 // thread roots haven't been forwarded. So the following access to
1557 // the roots (locks or methods in the frames) would be bad. Run it
1558 // here. TODO: clean up.
1559 {
1560 Thread* this_thread = const_cast<Thread*>(this);
1561 Closure* flip_func = this_thread->GetFlipFunction();
1562 if (flip_func != nullptr) {
1563 flip_func->Run(this_thread);
1564 }
1565 }
1566
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001567 // Dumping the Java stack involves the verifier for locks. The verifier operates under the
1568 // assumption that there is no exception pending on entry. Thus, stash any pending exception.
Mathieu Chartierbef89c92015-01-09 09:46:49 -08001569 // Thread::Current() instead of this in case a thread is dumping the stack of another suspended
1570 // thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001571 StackHandleScope<1> scope(Thread::Current());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001572 Handle<mirror::Throwable> exc;
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001573 bool have_exception = false;
1574 if (IsExceptionPending()) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001575 exc = scope.NewHandle(GetException());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001576 const_cast<Thread*>(this)->ClearException();
1577 have_exception = true;
1578 }
1579
Ian Rogers700a4022014-05-19 16:49:03 -07001580 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001581 StackDumpVisitor dumper(os, const_cast<Thread*>(this), context.get(),
1582 !tls32_.throwing_OutOfMemoryError);
1583 dumper.WalkStack();
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001584
1585 if (have_exception) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001586 const_cast<Thread*>(this)->SetException(exc.Get());
Andreas Gampe986c6fb2014-10-02 21:00:06 -07001587 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001588}
1589
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001590void Thread::DumpStack(std::ostream& os,
1591 bool dump_native_stack,
1592 BacktraceMap* backtrace_map) const {
Jeff Haoed1790e2013-04-12 09:58:14 -07001593 // TODO: we call this code when dying but may not have suspended the thread ourself. The
1594 // IsSuspended check is therefore racy with the use for dumping (normally we inhibit
1595 // the race with the thread_suspend_count_lock_).
Ian Rogerseef2e542014-06-24 22:48:01 -07001596 bool dump_for_abort = (gAborting > 0);
1597 bool safe_to_dump = (this == Thread::Current() || IsSuspended());
1598 if (!kIsDebugBuild) {
1599 // We always want to dump the stack for an abort, however, there is no point dumping another
1600 // thread's stack in debug builds where we'll hit the not suspended check in the stack walk.
1601 safe_to_dump = (safe_to_dump || dump_for_abort);
1602 }
1603 if (safe_to_dump) {
Ian Rogersf08e4732013-04-09 09:45:49 -07001604 // If we're currently in native code, dump that stack before dumping the managed stack.
Nicolas Geoffraya73280d2016-02-15 13:05:16 +00001605 if (dump_native_stack && (dump_for_abort || ShouldShowNativeStack(this))) {
Ian Rogersf08e4732013-04-09 09:45:49 -07001606 DumpKernelStack(os, GetTid(), " kernel: ", false);
Nicolas Geoffray6bc43742015-10-12 18:11:10 +01001607 ArtMethod* method = GetCurrentMethod(nullptr, !dump_for_abort);
Christopher Ferris6cff48f2014-01-26 21:36:13 -08001608 DumpNativeStack(os, GetTid(), backtrace_map, " native: ", method);
Ian Rogersf08e4732013-04-09 09:45:49 -07001609 }
Mathieu Chartierc751fdc2014-03-30 15:25:44 -07001610 DumpJavaStack(os);
Ian Rogersf08e4732013-04-09 09:45:49 -07001611 } else {
1612 os << "Not able to dump stack of thread that isn't suspended";
Elliott Hughesffb465f2012-03-01 18:46:05 -08001613 }
Elliott Hughese27955c2011-08-26 15:21:24 -07001614}
1615
Elliott Hughesbe759c62011-09-08 19:38:21 -07001616void Thread::ThreadExitCallback(void* arg) {
1617 Thread* self = reinterpret_cast<Thread*>(arg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001618 if (self->tls32_.thread_exit_check_count == 0) {
1619 LOG(WARNING) << "Native thread exiting without having called DetachCurrentThread (maybe it's "
1620 "going to use a pthread_key_create destructor?): " << *self;
Ian Rogers0878d652013-04-18 17:38:35 -07001621 CHECK(is_started_);
Bilyan Borisovbb661c02016-04-04 16:27:32 +01001622#ifdef ART_TARGET_ANDROID
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001623 __get_tls()[TLS_SLOT_ART_THREAD_SELF] = self;
1624#else
Elliott Hughes6a607ad2012-07-13 20:40:00 -07001625 CHECK_PTHREAD_CALL(pthread_setspecific, (Thread::pthread_key_self_, self), "reattach self");
Andreas Gampe4382f1e2015-08-05 01:08:53 +00001626#endif
Ian Rogersdd7624d2014-03-14 17:43:00 -07001627 self->tls32_.thread_exit_check_count = 1;
Elliott Hughes6a607ad2012-07-13 20:40:00 -07001628 } else {
1629 LOG(FATAL) << "Native thread exited without calling DetachCurrentThread: " << *self;
1630 }
Carl Shapirob5573532011-07-12 18:22:59 -07001631}
1632
Elliott Hughesbe759c62011-09-08 19:38:21 -07001633void Thread::Startup() {
Ian Rogers0878d652013-04-18 17:38:35 -07001634 CHECK(!is_started_);
1635 is_started_ = true;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001636 {
Brian Carlstrom6d69f592013-07-16 17:18:16 -07001637 // MutexLock to keep annotalysis happy.
1638 //
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001639 // Note we use null for the thread because Thread::Current can
Brian Carlstrom6d69f592013-07-16 17:18:16 -07001640 // return garbage since (is_started_ == true) and
1641 // Thread::pthread_key_self_ is not yet initialized.
1642 // This was seen on glibc.
Dave Allison0aded082013-11-07 13:15:11 -08001643 MutexLock mu(nullptr, *Locks::thread_suspend_count_lock_);
Ian Rogersc604d732012-10-14 16:09:54 -07001644 resume_cond_ = new ConditionVariable("Thread resumption condition variable",
1645 *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001646 }
1647
Carl Shapirob5573532011-07-12 18:22:59 -07001648 // Allocate a TLS slot.
Ian Rogersf4d4da12014-11-11 16:10:33 -08001649 CHECK_PTHREAD_CALL(pthread_key_create, (&Thread::pthread_key_self_, Thread::ThreadExitCallback),
1650 "self key");
Carl Shapirob5573532011-07-12 18:22:59 -07001651
1652 // Double-check the TLS slot allocation.
Dave Allison0aded082013-11-07 13:15:11 -08001653 if (pthread_getspecific(pthread_key_self_) != nullptr) {
1654 LOG(FATAL) << "Newly-created pthread TLS slot is not nullptr";
Carl Shapirob5573532011-07-12 18:22:59 -07001655 }
Elliott Hughes038a8062011-09-18 14:12:41 -07001656}
Carl Shapirob5573532011-07-12 18:22:59 -07001657
Elliott Hughes038a8062011-09-18 14:12:41 -07001658void Thread::FinishStartup() {
Ian Rogers365c1022012-06-22 15:05:28 -07001659 Runtime* runtime = Runtime::Current();
1660 CHECK(runtime->IsStarted());
Brian Carlstromb82b6872011-10-26 17:18:07 -07001661
Elliott Hughes01158d72011-09-19 19:47:10 -07001662 // Finish attaching the main thread.
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001663 ScopedObjectAccess soa(Thread::Current());
Ian Rogers365c1022012-06-22 15:05:28 -07001664 Thread::Current()->CreatePeer("main", false, runtime->GetMainThreadGroup());
Andreas Gampe4b1d4ec2015-10-01 16:47:26 -07001665 Thread::Current()->AssertNoPendingException();
Jesse Wilson9a6bae82011-11-14 14:57:30 -05001666
Elliott Hughesaf8d15a2012-05-29 09:12:18 -07001667 Runtime::Current()->GetClassLinker()->RunRootClinits();
Carl Shapirob5573532011-07-12 18:22:59 -07001668}
1669
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001670void Thread::Shutdown() {
Ian Rogers0878d652013-04-18 17:38:35 -07001671 CHECK(is_started_);
1672 is_started_ = false;
Elliott Hughes8d768a92011-09-14 16:35:25 -07001673 CHECK_PTHREAD_CALL(pthread_key_delete, (Thread::pthread_key_self_), "self key");
Ian Rogers33e95662013-05-20 20:29:14 -07001674 MutexLock mu(Thread::Current(), *Locks::thread_suspend_count_lock_);
Dave Allison0aded082013-11-07 13:15:11 -08001675 if (resume_cond_ != nullptr) {
Ian Rogers0878d652013-04-18 17:38:35 -07001676 delete resume_cond_;
Dave Allison0aded082013-11-07 13:15:11 -08001677 resume_cond_ = nullptr;
Ian Rogers0878d652013-04-18 17:38:35 -07001678 }
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001679}
1680
Ian Rogersdd7624d2014-03-14 17:43:00 -07001681Thread::Thread(bool daemon) : tls32_(daemon), wait_monitor_(nullptr), interrupted_(false) {
1682 wait_mutex_ = new Mutex("a thread wait mutex");
1683 wait_cond_ = new ConditionVariable("a thread wait condition variable", *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001684 tlsPtr_.instrumentation_stack = new std::deque<instrumentation::InstrumentationStackFrame>;
1685 tlsPtr_.name = new std::string(kThreadNameDuringStartup);
Dave Allison8ce6b902014-08-26 11:07:58 -07001686 tlsPtr_.nested_signal_state = static_cast<jmp_buf*>(malloc(sizeof(jmp_buf)));
Ian Rogersdd7624d2014-03-14 17:43:00 -07001687
Roland Levillain33d69032015-06-18 18:20:59 +01001688 static_assert((sizeof(Thread) % 4) == 0U,
1689 "art::Thread has a size which is not a multiple of 4.");
Ian Rogersdd7624d2014-03-14 17:43:00 -07001690 tls32_.state_and_flags.as_struct.flags = 0;
1691 tls32_.state_and_flags.as_struct.state = kNative;
1692 memset(&tlsPtr_.held_mutexes[0], 0, sizeof(tlsPtr_.held_mutexes));
Mathieu Chartier0651d412014-04-29 14:37:57 -07001693 std::fill(tlsPtr_.rosalloc_runs,
Hiroshi Yamauchi7ed9c562016-02-02 15:22:09 -08001694 tlsPtr_.rosalloc_runs + kNumRosAllocThreadLocalSizeBracketsInThread,
Mathieu Chartier73d1e172014-04-11 17:53:48 -07001695 gc::allocator::RosAlloc::GetDedicatedFullRun());
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001696 tlsPtr_.checkpoint_function = nullptr;
Yu Lieac44242015-06-29 10:50:03 +08001697 for (uint32_t i = 0; i < kMaxSuspendBarriers; ++i) {
1698 tlsPtr_.active_suspend_barriers[i] = nullptr;
1699 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001700 tlsPtr_.flip_function = nullptr;
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001701 tlsPtr_.thread_local_mark_stack = nullptr;
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001702 tls32_.is_transitioning_to_runnable = false;
Elliott Hughesdcc24742011-09-07 14:02:44 -07001703}
1704
Elliott Hughes7dc51662012-05-16 14:48:43 -07001705bool Thread::IsStillStarting() const {
1706 // You might think you can check whether the state is kStarting, but for much of thread startup,
Elliott Hughes80537bb2013-01-04 16:37:26 -08001707 // the thread is in kNative; it might also be in kVmWait.
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001708 // 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 -07001709 // assigned fairly early on, and needs to be.
1710 // It turns out that the last thing to change is the thread name; that's a good proxy for "has
1711 // this thread _ever_ entered kRunnable".
Ian Rogersdd7624d2014-03-14 17:43:00 -07001712 return (tlsPtr_.jpeer == nullptr && tlsPtr_.opeer == nullptr) ||
1713 (*tlsPtr_.name == kThreadNameDuringStartup);
Elliott Hughes7dc51662012-05-16 14:48:43 -07001714}
1715
Andreas Gamped9efea62014-07-21 22:56:08 -07001716void Thread::AssertPendingException() const {
Mathieu Chartiera61894d2015-04-23 16:32:54 -07001717 CHECK(IsExceptionPending()) << "Pending exception expected.";
1718}
1719
1720void Thread::AssertPendingOOMException() const {
1721 AssertPendingException();
1722 auto* e = GetException();
1723 CHECK_EQ(e->GetClass(), DecodeJObject(WellKnownClasses::java_lang_OutOfMemoryError)->AsClass())
1724 << e->Dump();
Andreas Gamped9efea62014-07-21 22:56:08 -07001725}
1726
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001727void Thread::AssertNoPendingException() const {
1728 if (UNLIKELY(IsExceptionPending())) {
1729 ScopedObjectAccess soa(Thread::Current());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001730 mirror::Throwable* exception = GetException();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001731 LOG(FATAL) << "No pending exception expected: " << exception->Dump();
1732 }
1733}
1734
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08001735void Thread::AssertNoPendingExceptionForNewException(const char* msg) const {
1736 if (UNLIKELY(IsExceptionPending())) {
1737 ScopedObjectAccess soa(Thread::Current());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00001738 mirror::Throwable* exception = GetException();
Ian Rogersc114b5f2014-07-21 08:55:01 -07001739 LOG(FATAL) << "Throwing new exception '" << msg << "' with unexpected pending exception: "
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08001740 << exception->Dump();
1741 }
1742}
1743
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001744class MonitorExitVisitor : public SingleRootVisitor {
1745 public:
1746 explicit MonitorExitVisitor(Thread* self) : self_(self) { }
1747
1748 // NO_THREAD_SAFETY_ANALYSIS due to MonitorExit.
1749 void VisitRoot(mirror::Object* entered_monitor, const RootInfo& info ATTRIBUTE_UNUSED)
1750 OVERRIDE NO_THREAD_SAFETY_ANALYSIS {
1751 if (self_->HoldsLock(entered_monitor)) {
1752 LOG(WARNING) << "Calling MonitorExit on object "
David Sehr709b0702016-10-13 09:12:37 -07001753 << entered_monitor << " (" << entered_monitor->PrettyTypeOf() << ")"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001754 << " left locked by native thread "
1755 << *Thread::Current() << " which is detaching";
1756 entered_monitor->MonitorExit(self_);
1757 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001758 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001759
1760 private:
1761 Thread* const self_;
1762};
Elliott Hughes02b48d12011-09-07 17:15:51 -07001763
Elliott Hughesc0f09332012-03-26 13:27:06 -07001764void Thread::Destroy() {
Ian Rogers120f1c72012-09-28 17:17:10 -07001765 Thread* self = this;
1766 DCHECK_EQ(self, Thread::Current());
Elliott Hughes02b48d12011-09-07 17:15:51 -07001767
Ian Rogers68d8b422014-07-17 11:09:10 -07001768 if (tlsPtr_.jni_env != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001769 {
1770 ScopedObjectAccess soa(self);
1771 MonitorExitVisitor visitor(self);
1772 // On thread detach, all monitors entered with JNI MonitorEnter are automatically exited.
1773 tlsPtr_.jni_env->monitors.VisitRoots(&visitor, RootInfo(kRootVMInternal));
1774 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001775 // Release locally held global references which releasing may require the mutator lock.
1776 if (tlsPtr_.jpeer != nullptr) {
1777 // If pthread_create fails we don't have a jni env here.
1778 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.jpeer);
1779 tlsPtr_.jpeer = nullptr;
1780 }
1781 if (tlsPtr_.class_loader_override != nullptr) {
1782 tlsPtr_.jni_env->DeleteGlobalRef(tlsPtr_.class_loader_override);
1783 tlsPtr_.class_loader_override = nullptr;
1784 }
1785 }
1786
Ian Rogersdd7624d2014-03-14 17:43:00 -07001787 if (tlsPtr_.opeer != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001788 ScopedObjectAccess soa(self);
Ian Rogers120f1c72012-09-28 17:17:10 -07001789 // We may need to call user-supplied managed code, do this before final clean-up.
Ian Rogerscfaa4552012-11-26 21:00:08 -08001790 HandleUncaughtExceptions(soa);
1791 RemoveFromThreadGroup(soa);
Elliott Hughes534da072012-03-27 15:17:42 -07001792
Anwar Ghuloum3c50a4b2013-06-21 13:05:23 -07001793 // this.nativePeer = 0;
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001794 if (Runtime::Current()->IsActiveTransaction()) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001795 soa.DecodeField(WellKnownClasses::java_lang_Thread_nativePeer)
1796 ->SetLong<true>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001797 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001798 soa.DecodeField(WellKnownClasses::java_lang_Thread_nativePeer)
1799 ->SetLong<false>(tlsPtr_.opeer, 0);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001800 }
Ian Rogerscfaa4552012-11-26 21:00:08 -08001801 Dbg::PostThreadDeath(self);
Elliott Hughes02b48d12011-09-07 17:15:51 -07001802
Ian Rogerscfaa4552012-11-26 21:00:08 -08001803 // Thread.join() is implemented as an Object.wait() on the Thread.lock object. Signal anyone
1804 // who is waiting.
Mathieu Chartier3398c782016-09-30 10:27:43 -07001805 ObjPtr<mirror::Object> lock =
Ian Rogersdd7624d2014-03-14 17:43:00 -07001806 soa.DecodeField(WellKnownClasses::java_lang_Thread_lock)->GetObject(tlsPtr_.opeer);
Elliott Hughes038a8062011-09-18 14:12:41 -07001807 // (This conditional is only needed for tests, where Thread.lock won't have been set.)
Mathieu Chartierc528dba2013-11-26 12:00:11 -08001808 if (lock != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001809 StackHandleScope<1> hs(self);
1810 Handle<mirror::Object> h_obj(hs.NewHandle(lock));
Mathieu Chartierdb2633c2014-05-16 09:59:29 -07001811 ObjectLock<mirror::Object> locker(self, h_obj);
Yevgeny Rouban63e8a682014-04-16 18:26:09 +07001812 locker.NotifyAll();
Elliott Hughes5f791332011-09-15 17:45:30 -07001813 }
Ian Rogers68d8b422014-07-17 11:09:10 -07001814 tlsPtr_.opeer = nullptr;
Elliott Hughes5f791332011-09-15 17:45:30 -07001815 }
Ian Rogers120f1c72012-09-28 17:17:10 -07001816
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08001817 {
1818 ScopedObjectAccess soa(self);
1819 Runtime::Current()->GetHeap()->RevokeThreadLocalBuffers(this);
Hiroshi Yamauchi0b713572015-06-16 18:29:23 -07001820 if (kUseReadBarrier) {
1821 Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->RevokeThreadLocalMarkStack(this);
1822 }
Hiroshi Yamauchia1b94c62014-12-17 15:49:56 -08001823 }
Elliott Hughesc0f09332012-03-26 13:27:06 -07001824}
Elliott Hughes02b48d12011-09-07 17:15:51 -07001825
Elliott Hughesc0f09332012-03-26 13:27:06 -07001826Thread::~Thread() {
Ian Rogers68d8b422014-07-17 11:09:10 -07001827 CHECK(tlsPtr_.class_loader_override == nullptr);
1828 CHECK(tlsPtr_.jpeer == nullptr);
1829 CHECK(tlsPtr_.opeer == nullptr);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001830 bool initialized = (tlsPtr_.jni_env != nullptr); // Did Thread::Init run?
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07001831 if (initialized) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001832 delete tlsPtr_.jni_env;
1833 tlsPtr_.jni_env = nullptr;
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07001834 }
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001835 CHECK_NE(GetState(), kRunnable);
Dave Allison0aded082013-11-07 13:15:11 -08001836 CHECK_NE(ReadFlag(kCheckpointRequest), true);
Mathieu Chartier952e1e32016-06-13 14:04:02 -07001837 CHECK(tlsPtr_.checkpoint_function == nullptr);
1838 CHECK_EQ(checkpoint_overflow_.size(), 0u);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08001839 CHECK(tlsPtr_.flip_function == nullptr);
Hiroshi Yamauchiee235822016-08-19 17:03:27 -07001840 CHECK_EQ(tls32_.is_transitioning_to_runnable, false);
Dave Allison0aded082013-11-07 13:15:11 -08001841
Sebastien Hertz07474662015-08-25 15:12:33 +00001842 // Make sure we processed all deoptimization requests.
1843 CHECK(tlsPtr_.deoptimization_context_stack == nullptr) << "Missed deoptimization";
Mingyao Yang99170c62015-07-06 11:10:37 -07001844 CHECK(tlsPtr_.frame_id_to_shadow_frame == nullptr) <<
1845 "Not all deoptimized frames have been consumed by the debugger.";
Sebastien Hertz07474662015-08-25 15:12:33 +00001846
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07001847 // We may be deleting a still born thread.
1848 SetStateUnsafe(kTerminated);
Elliott Hughes85d15452011-09-16 17:33:01 -07001849
1850 delete wait_cond_;
1851 delete wait_mutex_;
1852
Ian Rogersdd7624d2014-03-14 17:43:00 -07001853 if (tlsPtr_.long_jump_context != nullptr) {
1854 delete tlsPtr_.long_jump_context;
Ian Rogersc928de92013-02-27 14:30:44 -08001855 }
Elliott Hughes475fc232011-10-25 15:00:35 -07001856
Alexei Zavjalov1efa0a92014-02-04 02:08:31 +07001857 if (initialized) {
1858 CleanupCpu();
1859 }
1860
Sebastien Hertz597c4f02015-01-26 17:37:14 +01001861 if (tlsPtr_.single_step_control != nullptr) {
1862 delete tlsPtr_.single_step_control;
1863 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001864 delete tlsPtr_.instrumentation_stack;
1865 delete tlsPtr_.name;
1866 delete tlsPtr_.stack_trace_sample;
Dave Allison8ce6b902014-08-26 11:07:58 -07001867 free(tlsPtr_.nested_signal_state);
Elliott Hughesd8af1592012-04-16 20:40:15 -07001868
Ian Rogers68d8b422014-07-17 11:09:10 -07001869 Runtime::Current()->GetHeap()->AssertThreadLocalBuffersAreRevoked(this);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07001870
Elliott Hughesd8af1592012-04-16 20:40:15 -07001871 TearDownAlternateSignalStack();
Elliott Hughesc1674ed2011-08-25 18:09:09 -07001872}
1873
Ian Rogerscfaa4552012-11-26 21:00:08 -08001874void Thread::HandleUncaughtExceptions(ScopedObjectAccess& soa) {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07001875 if (!IsExceptionPending()) {
1876 return;
1877 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07001878 ScopedLocalRef<jobject> peer(tlsPtr_.jni_env, soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08001879 ScopedThreadStateChange tsc(this, kNative);
Ian Rogers120f1c72012-09-28 17:17:10 -07001880
Elliott Hughesaccd83d2011-10-17 14:25:58 -07001881 // Get and clear the exception.
Ian Rogersdd7624d2014-03-14 17:43:00 -07001882 ScopedLocalRef<jthrowable> exception(tlsPtr_.jni_env, tlsPtr_.jni_env->ExceptionOccurred());
1883 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07001884
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01001885 // Call the Thread instance's dispatchUncaughtException(Throwable)
1886 tlsPtr_.jni_env->CallVoidMethod(peer.get(),
1887 WellKnownClasses::java_lang_Thread_dispatchUncaughtException,
1888 exception.get());
Elliott Hughesaccd83d2011-10-17 14:25:58 -07001889
Tobias Thierer5cbe65d2016-07-22 18:37:59 +01001890 // If the dispatchUncaughtException threw, clear that exception too.
Ian Rogersdd7624d2014-03-14 17:43:00 -07001891 tlsPtr_.jni_env->ExceptionClear();
Elliott Hughesaccd83d2011-10-17 14:25:58 -07001892}
1893
Ian Rogerscfaa4552012-11-26 21:00:08 -08001894void Thread::RemoveFromThreadGroup(ScopedObjectAccess& soa) {
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07001895 // this.group.removeThread(this);
1896 // group can be null if we're in the compiler or a test.
Mathieu Chartier3398c782016-09-30 10:27:43 -07001897 ObjPtr<mirror::Object> ogroup = soa.DecodeField(WellKnownClasses::java_lang_Thread_group)
Ian Rogersdd7624d2014-03-14 17:43:00 -07001898 ->GetObject(tlsPtr_.opeer);
Dave Allison0aded082013-11-07 13:15:11 -08001899 if (ogroup != nullptr) {
Ian Rogerscfaa4552012-11-26 21:00:08 -08001900 ScopedLocalRef<jobject> group(soa.Env(), soa.AddLocalReference<jobject>(ogroup));
Ian Rogersdd7624d2014-03-14 17:43:00 -07001901 ScopedLocalRef<jobject> peer(soa.Env(), soa.AddLocalReference<jobject>(tlsPtr_.opeer));
Ian Rogerscfaa4552012-11-26 21:00:08 -08001902 ScopedThreadStateChange tsc(soa.Self(), kNative);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001903 tlsPtr_.jni_env->CallVoidMethod(group.get(),
1904 WellKnownClasses::java_lang_ThreadGroup_removeThread,
1905 peer.get());
Brian Carlstrom4514d3c2011-10-21 17:01:31 -07001906 }
1907}
1908
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001909bool Thread::HandleScopeContains(jobject obj) const {
1910 StackReference<mirror::Object>* hs_entry =
Ian Rogersef7d42f2014-01-06 12:55:46 -08001911 reinterpret_cast<StackReference<mirror::Object>*>(obj);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07001912 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur!= nullptr; cur = cur->GetLink()) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001913 if (cur->Contains(hs_entry)) {
Ian Rogersa8cd9f42011-08-19 16:43:41 -07001914 return true;
1915 }
1916 }
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001917 // JNI code invoked from portable code uses shadow frames rather than the handle scope.
1918 return tlsPtr_.managed_stack.ShadowFramesContain(hs_entry);
TDYa12728f1a142012-03-15 21:51:52 -07001919}
1920
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07001921void Thread::HandleScopeVisitRoots(RootVisitor* visitor, uint32_t thread_id) {
Mathieu Chartier4809d0a2015-04-07 10:39:04 -07001922 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(
1923 visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartiere8a3c572016-10-11 16:52:17 -07001924 for (BaseHandleScope* cur = tlsPtr_.top_handle_scope; cur; cur = cur->GetLink()) {
1925 cur->VisitRoots(buffered_visitor);
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -07001926 }
1927}
1928
Mathieu Chartierc4f39252016-10-05 18:32:08 -07001929ObjPtr<mirror::Object> Thread::DecodeJObject(jobject obj) const {
Dave Allison0aded082013-11-07 13:15:11 -08001930 if (obj == nullptr) {
1931 return nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07001932 }
1933 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07001934 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Mathieu Chartier8778c522016-10-04 19:06:30 -07001935 ObjPtr<mirror::Object> result;
Ian Rogersc0542af2014-09-03 16:16:56 -07001936 bool expect_null = false;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07001937 // The "kinds" below are sorted by the frequency we expect to encounter them.
1938 if (kind == kLocal) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07001939 IndirectReferenceTable& locals = tlsPtr_.jni_env->locals;
Hiroshi Yamauchi196851b2014-05-29 12:16:04 -07001940 // Local references do not need a read barrier.
1941 result = locals.Get<kWithoutReadBarrier>(ref);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001942 } else if (kind == kHandleScopeOrInvalid) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001943 // TODO: make stack indirect reference table lookup more efficient.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001944 // Check if this is a local reference in the handle scope.
1945 if (LIKELY(HandleScopeContains(obj))) {
1946 // Read from handle scope.
Ian Rogersef7d42f2014-01-06 12:55:46 -08001947 result = reinterpret_cast<StackReference<mirror::Object>*>(obj)->AsMirrorPtr();
Mathieu Chartier9d156d52016-10-06 17:44:26 -07001948 VerifyObject(result);
Ian Rogers408f79a2011-08-23 18:22:33 -07001949 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -07001950 tlsPtr_.jni_env->vm->JniAbortF(nullptr, "use of invalid jobject %p", obj);
1951 expect_null = true;
1952 result = nullptr;
Ian Rogers408f79a2011-08-23 18:22:33 -07001953 }
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07001954 } else if (kind == kGlobal) {
Mathieu Chartier30b5e272015-09-01 11:14:34 -07001955 result = tlsPtr_.jni_env->vm->DecodeGlobal(ref);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07001956 } else {
1957 DCHECK_EQ(kind, kWeakGlobal);
Ian Rogers68d8b422014-07-17 11:09:10 -07001958 result = tlsPtr_.jni_env->vm->DecodeWeakGlobal(const_cast<Thread*>(this), ref);
Ian Rogersc0542af2014-09-03 16:16:56 -07001959 if (Runtime::Current()->IsClearedJniWeakGlobal(result)) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001960 // This is a special case where it's okay to return null.
Ian Rogersc0542af2014-09-03 16:16:56 -07001961 expect_null = true;
1962 result = nullptr;
Ian Rogers4f6ad8a2013-03-18 15:27:28 -07001963 }
Ian Rogers408f79a2011-08-23 18:22:33 -07001964 }
1965
Ian Rogersc0542af2014-09-03 16:16:56 -07001966 if (UNLIKELY(!expect_null && result == nullptr)) {
Ian Rogers68d8b422014-07-17 11:09:10 -07001967 tlsPtr_.jni_env->vm->JniAbortF(nullptr, "use of deleted %s %p",
1968 ToStr<IndirectRefKind>(kind).c_str(), obj);
Ian Rogers408f79a2011-08-23 18:22:33 -07001969 }
Mathieu Chartierc4f39252016-10-05 18:32:08 -07001970 return result;
Ian Rogers408f79a2011-08-23 18:22:33 -07001971}
1972
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08001973bool Thread::IsJWeakCleared(jweak obj) const {
1974 CHECK(obj != nullptr);
1975 IndirectRef ref = reinterpret_cast<IndirectRef>(obj);
Andreas Gampedc061d02016-10-24 13:19:37 -07001976 IndirectRefKind kind = IndirectReferenceTable::GetIndirectRefKind(ref);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08001977 CHECK_EQ(kind, kWeakGlobal);
1978 return tlsPtr_.jni_env->vm->IsWeakGlobalCleared(const_cast<Thread*>(this), ref);
1979}
1980
Ian Rogers81d425b2012-09-27 16:03:43 -07001981// Implements java.lang.Thread.interrupted.
1982bool Thread::Interrupted() {
Ian Rogers50b35e22012-10-04 10:09:15 -07001983 MutexLock mu(Thread::Current(), *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001984 bool interrupted = IsInterruptedLocked();
1985 SetInterruptedLocked(false);
Ian Rogers81d425b2012-09-27 16:03:43 -07001986 return interrupted;
1987}
1988
1989// Implements java.lang.Thread.isInterrupted.
1990bool Thread::IsInterrupted() {
Ian Rogers50b35e22012-10-04 10:09:15 -07001991 MutexLock mu(Thread::Current(), *wait_mutex_);
Ian Rogersdd7624d2014-03-14 17:43:00 -07001992 return IsInterruptedLocked();
Ian Rogers81d425b2012-09-27 16:03:43 -07001993}
1994
Ian Rogersdd7624d2014-03-14 17:43:00 -07001995void Thread::Interrupt(Thread* self) {
Ian Rogersc604d732012-10-14 16:09:54 -07001996 MutexLock mu(self, *wait_mutex_);
Ian Rogers81d425b2012-09-27 16:03:43 -07001997 if (interrupted_) {
1998 return;
1999 }
2000 interrupted_ = true;
Ian Rogersc604d732012-10-14 16:09:54 -07002001 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002002}
2003
2004void Thread::Notify() {
Ian Rogersc604d732012-10-14 16:09:54 -07002005 Thread* self = Thread::Current();
2006 MutexLock mu(self, *wait_mutex_);
2007 NotifyLocked(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002008}
2009
Ian Rogersc604d732012-10-14 16:09:54 -07002010void Thread::NotifyLocked(Thread* self) {
Dave Allison0aded082013-11-07 13:15:11 -08002011 if (wait_monitor_ != nullptr) {
Ian Rogersc604d732012-10-14 16:09:54 -07002012 wait_cond_->Signal(self);
Ian Rogers81d425b2012-09-27 16:03:43 -07002013 }
2014}
2015
Ian Rogers68d8b422014-07-17 11:09:10 -07002016void Thread::SetClassLoaderOverride(jobject class_loader_override) {
2017 if (tlsPtr_.class_loader_override != nullptr) {
2018 GetJniEnv()->DeleteGlobalRef(tlsPtr_.class_loader_override);
2019 }
2020 tlsPtr_.class_loader_override = GetJniEnv()->NewGlobalRef(class_loader_override);
2021}
2022
Ian Rogers0399dde2012-06-06 17:09:28 -07002023class CountStackDepthVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002024 public:
Brian Carlstrom93ba8932013-07-17 21:31:49 -07002025 explicit CountStackDepthVisitor(Thread* thread)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002026 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002027 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002028 depth_(0), skip_depth_(0), skipping_(true) {}
Elliott Hughesd369bb72011-09-12 14:41:14 -07002029
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002030 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002031 // We want to skip frames up to and including the exception's constructor.
Ian Rogers90865722011-09-19 11:11:44 -07002032 // Note we also skip the frame if it doesn't have a method (namely the callee
2033 // save frame)
Mathieu Chartiere401d142015-04-22 13:56:20 -07002034 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002035 if (skipping_ && !m->IsRuntimeMethod() &&
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002036 !mirror::Throwable::GetJavaLangThrowable()->IsAssignableFrom(m->GetDeclaringClass())) {
Elliott Hughes29f27422011-09-18 16:02:18 -07002037 skipping_ = false;
2038 }
2039 if (!skipping_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002040 if (!m->IsRuntimeMethod()) { // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002041 ++depth_;
2042 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002043 } else {
2044 ++skip_depth_;
2045 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002046 return true;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002047 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002048
2049 int GetDepth() const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002050 return depth_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002051 }
2052
Elliott Hughes29f27422011-09-18 16:02:18 -07002053 int GetSkipDepth() const {
2054 return skip_depth_;
2055 }
2056
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002057 private:
Ian Rogersaaa20802011-09-11 21:47:37 -07002058 uint32_t depth_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002059 uint32_t skip_depth_;
2060 bool skipping_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002061
2062 DISALLOW_COPY_AND_ASSIGN(CountStackDepthVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002063};
2064
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002065template<bool kTransactionActive>
Ian Rogers0399dde2012-06-06 17:09:28 -07002066class BuildInternalStackTraceVisitor : public StackVisitor {
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002067 public:
Roland Levillain3887c462015-08-12 18:15:42 +01002068 BuildInternalStackTraceVisitor(Thread* self, Thread* thread, int skip_depth)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002069 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2070 self_(self),
2071 skip_depth_(skip_depth),
2072 count_(0),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002073 trace_(nullptr),
2074 pointer_size_(Runtime::Current()->GetClassLinker()->GetImagePointerSize()) {}
Ian Rogers283ed0d2012-02-16 15:25:09 -08002075
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002076 bool Init(int depth) REQUIRES_SHARED(Locks::mutator_lock_) ACQUIRE(Roles::uninterruptible_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002077 // Allocate method trace as an object array where the first element is a pointer array that
2078 // contains the ArtMethod pointers and dex PCs. The rest of the elements are the declaring
2079 // class of the ArtMethod pointers.
2080 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
2081 StackHandleScope<1> hs(self_);
2082 mirror::Class* array_class = class_linker->GetClassRoot(ClassLinker::kObjectArrayClass);
2083 // The first element is the methods and dex pc array, the other elements are declaring classes
2084 // for the methods to ensure classes in the stack trace don't get unloaded.
2085 Handle<mirror::ObjectArray<mirror::Object>> trace(
2086 hs.NewHandle(
2087 mirror::ObjectArray<mirror::Object>::Alloc(hs.Self(), array_class, depth + 1)));
2088 if (trace.Get() == nullptr) {
2089 // Acquire uninterruptible_ in all paths.
2090 self_->StartAssertNoThreadSuspension("Building internal stack trace");
Mathieu Chartier566fc922015-09-29 10:21:55 -07002091 self_->AssertPendingOOMException();
2092 return false;
2093 }
Mathieu Chartier910e8272015-09-30 09:24:22 -07002094 mirror::PointerArray* methods_and_pcs = class_linker->AllocPointerArray(self_, depth * 2);
2095 const char* last_no_suspend_cause =
2096 self_->StartAssertNoThreadSuspension("Building internal stack trace");
2097 if (methods_and_pcs == nullptr) {
2098 self_->AssertPendingOOMException();
2099 return false;
2100 }
2101 trace->Set(0, methods_and_pcs);
2102 trace_ = trace.Get();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002103 // If We are called from native, use non-transactional mode.
Dave Allison0aded082013-11-07 13:15:11 -08002104 CHECK(last_no_suspend_cause == nullptr) << last_no_suspend_cause;
Ian Rogers283ed0d2012-02-16 15:25:09 -08002105 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002106 }
2107
Mathieu Chartier4e2cb092015-07-22 16:17:51 -07002108 virtual ~BuildInternalStackTraceVisitor() RELEASE(Roles::uninterruptible_) {
2109 self_->EndAssertNoThreadSuspension(nullptr);
Ian Rogers0399dde2012-06-06 17:09:28 -07002110 }
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002111
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002112 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002113 if (trace_ == nullptr) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002114 return true; // We're probably trying to fillInStackTrace for an OutOfMemoryError.
Elliott Hughes726079d2011-10-07 18:43:44 -07002115 }
Elliott Hughes29f27422011-09-18 16:02:18 -07002116 if (skip_depth_ > 0) {
2117 skip_depth_--;
Elliott Hughes530fa002012-03-12 11:44:49 -07002118 return true;
Elliott Hughes29f27422011-09-18 16:02:18 -07002119 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002120 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07002121 if (m->IsRuntimeMethod()) {
2122 return true; // Ignore runtime frames (in particular callee save).
Ian Rogers6b0870d2011-12-15 19:38:12 -08002123 }
Mathieu Chartier910e8272015-09-30 09:24:22 -07002124 mirror::PointerArray* trace_methods_and_pcs = GetTraceMethodsAndPCs();
2125 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(count_, m, pointer_size_);
2126 trace_methods_and_pcs->SetElementPtrSize<kTransactionActive>(
2127 trace_methods_and_pcs->GetLength() / 2 + count_,
2128 m->IsProxyMethod() ? DexFile::kDexNoIndex : GetDexPc(),
2129 pointer_size_);
2130 // Save the declaring class of the method to ensure that the declaring classes of the methods
2131 // do not get unloaded while the stack trace is live.
2132 trace_->Set(count_ + 1, m->GetDeclaringClass());
Ian Rogersaaa20802011-09-11 21:47:37 -07002133 ++count_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002134 return true;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002135 }
2136
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002137 mirror::PointerArray* GetTraceMethodsAndPCs() const REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002138 return down_cast<mirror::PointerArray*>(trace_->Get(0));
2139 }
2140
2141 mirror::ObjectArray<mirror::Object>* GetInternalStackTrace() const {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002142 return trace_;
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002143 }
2144
2145 private:
Ian Rogers1f539342012-10-03 21:09:42 -07002146 Thread* const self_;
Elliott Hughes29f27422011-09-18 16:02:18 -07002147 // How many more frames to skip.
2148 int32_t skip_depth_;
Ian Rogers0399dde2012-06-06 17:09:28 -07002149 // Current position down stack trace.
Ian Rogersaaa20802011-09-11 21:47:37 -07002150 uint32_t count_;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002151 // An object array where the first element is a pointer array that contains the ArtMethod
2152 // pointers on the stack and dex PCs. The rest of the elements are the declaring
2153 // class of the ArtMethod pointers. trace_[i+1] contains the declaring class of the ArtMethod of
2154 // the i'th frame.
2155 mirror::ObjectArray<mirror::Object>* trace_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002156 // For cross compilation.
Andreas Gampe542451c2016-07-26 09:02:02 -07002157 const PointerSize pointer_size_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002158
2159 DISALLOW_COPY_AND_ASSIGN(BuildInternalStackTraceVisitor);
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002160};
2161
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002162template<bool kTransactionActive>
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002163jobject Thread::CreateInternalStackTrace(const ScopedObjectAccessAlreadyRunnable& soa) const {
Ian Rogersaaa20802011-09-11 21:47:37 -07002164 // Compute depth of stack
Ian Rogers7a22fa62013-01-23 12:16:16 -08002165 CountStackDepthVisitor count_visitor(const_cast<Thread*>(this));
Ian Rogers0399dde2012-06-06 17:09:28 -07002166 count_visitor.WalkStack();
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002167 int32_t depth = count_visitor.GetDepth();
Elliott Hughes29f27422011-09-18 16:02:18 -07002168 int32_t skip_depth = count_visitor.GetSkipDepth();
Shih-wei Liao44175362011-08-28 16:59:17 -07002169
Ian Rogers1f539342012-10-03 21:09:42 -07002170 // Build internal stack trace.
Sebastien Hertzee1d79a2014-02-21 15:46:30 +01002171 BuildInternalStackTraceVisitor<kTransactionActive> build_trace_visitor(soa.Self(),
2172 const_cast<Thread*>(this),
2173 skip_depth);
Ian Rogers1f539342012-10-03 21:09:42 -07002174 if (!build_trace_visitor.Init(depth)) {
Dave Allison0aded082013-11-07 13:15:11 -08002175 return nullptr; // Allocation failed.
Ian Rogers283ed0d2012-02-16 15:25:09 -08002176 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002177 build_trace_visitor.WalkStack();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002178 mirror::ObjectArray<mirror::Object>* trace = build_trace_visitor.GetInternalStackTrace();
Ian Rogers7a22fa62013-01-23 12:16:16 -08002179 if (kIsDebugBuild) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002180 mirror::PointerArray* trace_methods = build_trace_visitor.GetTraceMethodsAndPCs();
2181 // Second half of trace_methods is dex PCs.
2182 for (uint32_t i = 0; i < static_cast<uint32_t>(trace_methods->GetLength() / 2); ++i) {
2183 auto* method = trace_methods->GetElementPtrSize<ArtMethod*>(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002184 i, Runtime::Current()->GetClassLinker()->GetImagePointerSize());
2185 CHECK(method != nullptr);
Ian Rogers7a22fa62013-01-23 12:16:16 -08002186 }
2187 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002188 return soa.AddLocalReference<jobject>(trace);
Ian Rogersaaa20802011-09-11 21:47:37 -07002189}
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002190template jobject Thread::CreateInternalStackTrace<false>(
2191 const ScopedObjectAccessAlreadyRunnable& soa) const;
2192template jobject Thread::CreateInternalStackTrace<true>(
2193 const ScopedObjectAccessAlreadyRunnable& soa) const;
Ian Rogersaaa20802011-09-11 21:47:37 -07002194
Nicolas Geoffray7642cfc2015-02-26 10:56:09 +00002195bool Thread::IsExceptionThrownByCurrentMethod(mirror::Throwable* exception) const {
2196 CountStackDepthVisitor count_visitor(const_cast<Thread*>(this));
2197 count_visitor.WalkStack();
2198 return count_visitor.GetDepth() == exception->GetStackDepth();
2199}
2200
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002201jobjectArray Thread::InternalStackTraceToStackTraceElementArray(
Mathieu Chartier910e8272015-09-30 09:24:22 -07002202 const ScopedObjectAccessAlreadyRunnable& soa,
2203 jobject internal,
2204 jobjectArray output_array,
Mathieu Chartier2b7c4d12014-05-19 10:52:16 -07002205 int* stack_depth) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002206 // Decode the internal stack trace into the depth, method trace and PC trace.
2207 // Subtract one for the methods and PC trace.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002208 int32_t depth = soa.Decode<mirror::Array>(internal)->GetLength() - 1;
Mathieu Chartier910e8272015-09-30 09:24:22 -07002209 DCHECK_GE(depth, 0);
Ian Rogersaaa20802011-09-11 21:47:37 -07002210
Mathieu Chartier910e8272015-09-30 09:24:22 -07002211 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Ian Rogersaaa20802011-09-11 21:47:37 -07002212
Elliott Hughes01158d72011-09-19 19:47:10 -07002213 jobjectArray result;
Mathieu Chartier530825b2013-09-25 17:56:49 -07002214
Dave Allison0aded082013-11-07 13:15:11 -08002215 if (output_array != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002216 // Reuse the array we were given.
2217 result = output_array;
Elliott Hughes01158d72011-09-19 19:47:10 -07002218 // ...adjusting the number of frames we'll write to not exceed the array length.
Mathieu Chartier530825b2013-09-25 17:56:49 -07002219 const int32_t traces_length =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002220 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->GetLength();
Mathieu Chartier530825b2013-09-25 17:56:49 -07002221 depth = std::min(depth, traces_length);
Elliott Hughes01158d72011-09-19 19:47:10 -07002222 } else {
2223 // Create java_trace array and place in local reference table
Mathieu Chartier530825b2013-09-25 17:56:49 -07002224 mirror::ObjectArray<mirror::StackTraceElement>* java_traces =
Mathieu Chartier910e8272015-09-30 09:24:22 -07002225 class_linker->AllocStackTraceElementArray(soa.Self(), depth);
Dave Allison0aded082013-11-07 13:15:11 -08002226 if (java_traces == nullptr) {
2227 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002228 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002229 result = soa.AddLocalReference<jobjectArray>(java_traces);
Elliott Hughes01158d72011-09-19 19:47:10 -07002230 }
2231
Dave Allison0aded082013-11-07 13:15:11 -08002232 if (stack_depth != nullptr) {
Elliott Hughes01158d72011-09-19 19:47:10 -07002233 *stack_depth = depth;
2234 }
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002235
Shih-wei Liao9b576b42011-08-29 01:45:07 -07002236 for (int32_t i = 0; i < depth; ++i) {
Mathieu Chartier910e8272015-09-30 09:24:22 -07002237 mirror::ObjectArray<mirror::Object>* decoded_traces =
Mathieu Chartier0795f232016-09-27 18:43:30 -07002238 soa.Decode<mirror::Object>(internal)->AsObjectArray<mirror::Object>();
Mathieu Chartier910e8272015-09-30 09:24:22 -07002239 // Methods and dex PC trace is element 0.
2240 DCHECK(decoded_traces->Get(0)->IsIntArray() || decoded_traces->Get(0)->IsLongArray());
2241 mirror::PointerArray* const method_trace =
2242 down_cast<mirror::PointerArray*>(decoded_traces->Get(0));
Ian Rogersaaa20802011-09-11 21:47:37 -07002243 // Prepare parameters for StackTraceElement(String cls, String method, String file, int line)
Andreas Gampe542451c2016-07-26 09:02:02 -07002244 ArtMethod* method = method_trace->GetElementPtrSize<ArtMethod*>(i, kRuntimePointerSize);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002245 uint32_t dex_pc = method_trace->GetElementPtrSize<uint32_t>(
Andreas Gampe542451c2016-07-26 09:02:02 -07002246 i + method_trace->GetLength() / 2, kRuntimePointerSize);
Jeff Hao228d6b82013-12-03 15:00:05 -08002247 int32_t line_number;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002248 StackHandleScope<3> hs(soa.Self());
2249 auto class_name_object(hs.NewHandle<mirror::String>(nullptr));
2250 auto source_name_object(hs.NewHandle<mirror::String>(nullptr));
Jeff Hao228d6b82013-12-03 15:00:05 -08002251 if (method->IsProxyMethod()) {
2252 line_number = -1;
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002253 class_name_object.Assign(method->GetDeclaringClass()->GetName());
Jeff Hao228d6b82013-12-03 15:00:05 -08002254 // source_name_object intentionally left null for proxy methods
2255 } else {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002256 line_number = method->GetLineNumFromDexPC(dex_pc);
Jeff Hao228d6b82013-12-03 15:00:05 -08002257 // Allocate element, potentially triggering GC
2258 // TODO: reuse class_name_object via Class::name_?
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002259 const char* descriptor = method->GetDeclaringClassDescriptor();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002260 CHECK(descriptor != nullptr);
Jeff Hao228d6b82013-12-03 15:00:05 -08002261 std::string class_name(PrettyDescriptor(descriptor));
Mathieu Chartiere401d142015-04-22 13:56:20 -07002262 class_name_object.Assign(
2263 mirror::String::AllocFromModifiedUtf8(soa.Self(), class_name.c_str()));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002264 if (class_name_object.Get() == nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002265 soa.Self()->AssertPendingOOMException();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002266 return nullptr;
Jeff Hao228d6b82013-12-03 15:00:05 -08002267 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07002268 const char* source_file = method->GetDeclaringClassSourceFile();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002269 if (source_file != nullptr) {
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002270 source_name_object.Assign(mirror::String::AllocFromModifiedUtf8(soa.Self(), source_file));
2271 if (source_name_object.Get() == nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002272 soa.Self()->AssertPendingOOMException();
Brian Carlstrom7c6aca22014-01-31 18:44:56 -08002273 return nullptr;
2274 }
Jeff Hao228d6b82013-12-03 15:00:05 -08002275 }
Brian Carlstrom40381fb2011-10-19 14:13:40 -07002276 }
Andreas Gampe542451c2016-07-26 09:02:02 -07002277 const char* method_name = method->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
Dave Allison0aded082013-11-07 13:15:11 -08002278 CHECK(method_name != nullptr);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002279 Handle<mirror::String> method_name_object(
2280 hs.NewHandle(mirror::String::AllocFromModifiedUtf8(soa.Self(), method_name)));
2281 if (method_name_object.Get() == nullptr) {
Dave Allison0aded082013-11-07 13:15:11 -08002282 return nullptr;
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08002283 }
Mathieu Chartier590fee92013-09-13 13:46:47 -07002284 mirror::StackTraceElement* obj = mirror::StackTraceElement::Alloc(
2285 soa.Self(), class_name_object, method_name_object, source_name_object, line_number);
Dave Allison0aded082013-11-07 13:15:11 -08002286 if (obj == nullptr) {
2287 return nullptr;
Elliott Hughes30646832011-10-13 16:59:46 -07002288 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01002289 // We are called from native: use non-transactional mode.
Mathieu Chartier0795f232016-09-27 18:43:30 -07002290 soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(result)->Set<false>(i, obj);
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002291 }
Ian Rogersaaa20802011-09-11 21:47:37 -07002292 return result;
Shih-wei Liao55df06b2011-08-26 14:39:27 -07002293}
2294
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002295void Thread::ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...) {
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002296 va_list args;
2297 va_start(args, fmt);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002298 ThrowNewExceptionV(exception_class_descriptor, fmt, args);
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002299 va_end(args);
Elliott Hughes4a2b4172011-09-20 17:08:25 -07002300}
2301
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002302void Thread::ThrowNewExceptionV(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002303 const char* fmt, va_list ap) {
Elliott Hughes4a2b4172011-09-20 17:08:25 -07002304 std::string msg;
2305 StringAppendV(&msg, fmt, ap);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002306 ThrowNewException(exception_class_descriptor, msg.c_str());
Elliott Hughes5cb5ad22011-10-02 12:13:39 -07002307}
Elliott Hughes37f7a402011-08-22 18:56:01 -07002308
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002309void Thread::ThrowNewException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002310 const char* msg) {
Mathieu Chartier8d7672e2014-02-25 10:57:16 -08002311 // Callers should either clear or call ThrowNewWrappedException.
2312 AssertNoPendingExceptionForNewException(msg);
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002313 ThrowNewWrappedException(exception_class_descriptor, msg);
Elliott Hughesa4f94742012-05-29 16:28:38 -07002314}
2315
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002316static mirror::ClassLoader* GetCurrentClassLoader(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002317 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002318 ArtMethod* method = self->GetCurrentMethod(nullptr);
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002319 return method != nullptr
2320 ? method->GetDeclaringClass()->GetClassLoader()
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002321 : nullptr;
2322}
2323
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002324void Thread::ThrowNewWrappedException(const char* exception_class_descriptor,
Ian Rogers62d6c772013-02-27 08:32:07 -08002325 const char* msg) {
2326 DCHECK_EQ(this, Thread::Current());
Ian Rogers53b8b092014-03-13 23:45:53 -07002327 ScopedObjectAccessUnchecked soa(this);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002328 StackHandleScope<3> hs(soa.Self());
Nicolas Geoffrayee077032015-03-09 14:56:37 +00002329 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(GetCurrentClassLoader(soa.Self())));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002330 ScopedLocalRef<jobject> cause(GetJniEnv(), soa.AddLocalReference<jobject>(GetException()));
Ian Rogers62d6c772013-02-27 08:32:07 -08002331 ClearException();
2332 Runtime* runtime = Runtime::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002333 auto* cl = runtime->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002334 Handle<mirror::Class> exception_class(
Mathieu Chartiere401d142015-04-22 13:56:20 -07002335 hs.NewHandle(cl->FindClass(this, exception_class_descriptor, class_loader)));
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002336 if (UNLIKELY(exception_class.Get() == nullptr)) {
Elliott Hughes30646832011-10-13 16:59:46 -07002337 CHECK(IsExceptionPending());
Ian Rogers62d6c772013-02-27 08:32:07 -08002338 LOG(ERROR) << "No exception class " << PrettyDescriptor(exception_class_descriptor);
Elliott Hughes30646832011-10-13 16:59:46 -07002339 return;
2340 }
Ian Rogers62d6c772013-02-27 08:32:07 -08002341
Ian Rogers7b078e82014-09-10 14:44:24 -07002342 if (UNLIKELY(!runtime->GetClassLinker()->EnsureInitialized(soa.Self(), exception_class, true,
2343 true))) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002344 DCHECK(IsExceptionPending());
2345 return;
2346 }
2347 DCHECK(!runtime->IsStarted() || exception_class->IsThrowableClass());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002348 Handle<mirror::Throwable> exception(
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07002349 hs.NewHandle(ObjPtr<mirror::Throwable>::DownCast(exception_class->AllocObject(this))));
Ian Rogers62d6c772013-02-27 08:32:07 -08002350
Mathieu Chartier590fee92013-09-13 13:46:47 -07002351 // If we couldn't allocate the exception, throw the pre-allocated out of memory exception.
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002352 if (exception.Get() == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002353 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryError());
Mathieu Chartier590fee92013-09-13 13:46:47 -07002354 return;
2355 }
2356
Ian Rogers62d6c772013-02-27 08:32:07 -08002357 // Choose an appropriate constructor and set up the arguments.
2358 const char* signature;
Ian Rogers53b8b092014-03-13 23:45:53 -07002359 ScopedLocalRef<jstring> msg_string(GetJniEnv(), nullptr);
Dave Allison0aded082013-11-07 13:15:11 -08002360 if (msg != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002361 // Ensure we remember this and the method over the String allocation.
Ian Rogers53b8b092014-03-13 23:45:53 -07002362 msg_string.reset(
2363 soa.AddLocalReference<jstring>(mirror::String::AllocFromModifiedUtf8(this, msg)));
Dave Allison0aded082013-11-07 13:15:11 -08002364 if (UNLIKELY(msg_string.get() == nullptr)) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002365 CHECK(IsExceptionPending()); // OOME.
2366 return;
Brian Carlstromebd1fd22011-12-07 15:46:26 -08002367 }
Dave Allison0aded082013-11-07 13:15:11 -08002368 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002369 signature = "(Ljava/lang/String;)V";
2370 } else {
2371 signature = "(Ljava/lang/String;Ljava/lang/Throwable;)V";
2372 }
2373 } else {
Dave Allison0aded082013-11-07 13:15:11 -08002374 if (cause.get() == nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002375 signature = "()V";
2376 } else {
2377 signature = "(Ljava/lang/Throwable;)V";
2378 }
Brian Carlstromebd1fd22011-12-07 15:46:26 -08002379 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002380 ArtMethod* exception_init_method =
2381 exception_class->FindDeclaredDirectMethod("<init>", signature, cl->GetImagePointerSize());
Ian Rogers62d6c772013-02-27 08:32:07 -08002382
Dave Allison0aded082013-11-07 13:15:11 -08002383 CHECK(exception_init_method != nullptr) << "No <init>" << signature << " in "
Ian Rogers62d6c772013-02-27 08:32:07 -08002384 << PrettyDescriptor(exception_class_descriptor);
2385
2386 if (UNLIKELY(!runtime->IsStarted())) {
2387 // Something is trying to throw an exception without a started runtime, which is the common
2388 // case in the compiler. We won't be able to invoke the constructor of the exception, so set
2389 // the exception fields directly.
Dave Allison0aded082013-11-07 13:15:11 -08002390 if (msg != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002391 exception->SetDetailMessage(DecodeJObject(msg_string.get())->AsString());
Ian Rogers62d6c772013-02-27 08:32:07 -08002392 }
Dave Allison0aded082013-11-07 13:15:11 -08002393 if (cause.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002394 exception->SetCause(DecodeJObject(cause.get())->AsThrowable());
Ian Rogers62d6c772013-02-27 08:32:07 -08002395 }
Ian Rogersc45b8b52014-05-03 01:39:59 -07002396 ScopedLocalRef<jobject> trace(GetJniEnv(),
2397 Runtime::Current()->IsActiveTransaction()
2398 ? CreateInternalStackTrace<true>(soa)
2399 : CreateInternalStackTrace<false>(soa));
2400 if (trace.get() != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002401 exception->SetStackState(DecodeJObject(trace.get()).Ptr());
Ian Rogersc45b8b52014-05-03 01:39:59 -07002402 }
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002403 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08002404 } else {
Ian Rogers53b8b092014-03-13 23:45:53 -07002405 jvalue jv_args[2];
2406 size_t i = 0;
2407
Dave Allison0aded082013-11-07 13:15:11 -08002408 if (msg != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07002409 jv_args[i].l = msg_string.get();
2410 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08002411 }
Dave Allison0aded082013-11-07 13:15:11 -08002412 if (cause.get() != nullptr) {
Ian Rogers53b8b092014-03-13 23:45:53 -07002413 jv_args[i].l = cause.get();
2414 ++i;
Ian Rogers62d6c772013-02-27 08:32:07 -08002415 }
Jeff Hao39b6c242015-05-19 20:30:23 -07002416 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(exception.Get()));
2417 InvokeWithJValues(soa, ref.get(), soa.EncodeMethod(exception_init_method), jv_args);
Ian Rogers62d6c772013-02-27 08:32:07 -08002418 if (LIKELY(!IsExceptionPending())) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002419 SetException(exception.Get());
Ian Rogers62d6c772013-02-27 08:32:07 -08002420 }
Elliott Hughes30646832011-10-13 16:59:46 -07002421 }
Elliott Hughesa5b897e2011-08-16 11:33:06 -07002422}
2423
Elliott Hughes2ced6a52011-10-16 18:44:48 -07002424void Thread::ThrowOutOfMemoryError(const char* msg) {
Andreas Gampee4301ff2015-02-17 19:25:29 -08002425 LOG(WARNING) << StringPrintf("Throwing OutOfMemoryError \"%s\"%s",
Ian Rogersdd7624d2014-03-14 17:43:00 -07002426 msg, (tls32_.throwing_OutOfMemoryError ? " (recursive case)" : ""));
Ian Rogersdd7624d2014-03-14 17:43:00 -07002427 if (!tls32_.throwing_OutOfMemoryError) {
2428 tls32_.throwing_OutOfMemoryError = true;
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +00002429 ThrowNewException("Ljava/lang/OutOfMemoryError;", msg);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002430 tls32_.throwing_OutOfMemoryError = false;
Elliott Hughes418dfe72011-10-06 18:56:27 -07002431 } else {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002432 Dump(LOG_STREAM(WARNING)); // The pre-allocated OOME has no stack, so help out and log one.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002433 SetException(Runtime::Current()->GetPreAllocatedOutOfMemoryError());
Elliott Hughes418dfe72011-10-06 18:56:27 -07002434 }
Elliott Hughes79082e32011-08-25 12:07:32 -07002435}
2436
Elliott Hughes498508c2011-10-17 14:58:22 -07002437Thread* Thread::CurrentFromGdb() {
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002438 return Thread::Current();
2439}
2440
2441void Thread::DumpFromGdb() const {
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002442 std::ostringstream ss;
2443 Dump(ss);
Elliott Hughes95572412011-12-13 18:14:20 -08002444 std::string str(ss.str());
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002445 // log to stderr for debugging command line processes
2446 std::cerr << str;
Bilyan Borisovbb661c02016-04-04 16:27:32 +01002447#ifdef ART_TARGET_ANDROID
Brian Carlstrom6b4ef022011-10-23 14:59:04 -07002448 // log to logcat for debugging frameworks processes
2449 LOG(INFO) << str;
2450#endif
Elliott Hughesaccd83d2011-10-17 14:25:58 -07002451}
2452
Ian Rogersdd7624d2014-03-14 17:43:00 -07002453// Explicitly instantiate 32 and 64bit thread offset dumping support.
Andreas Gampe542451c2016-07-26 09:02:02 -07002454template
2455void Thread::DumpThreadOffset<PointerSize::k32>(std::ostream& os, uint32_t offset);
2456template
2457void Thread::DumpThreadOffset<PointerSize::k64>(std::ostream& os, uint32_t offset);
Elliott Hughes98e20172012-04-24 15:38:13 -07002458
Andreas Gampe542451c2016-07-26 09:02:02 -07002459template<PointerSize ptr_size>
Ian Rogersdd7624d2014-03-14 17:43:00 -07002460void Thread::DumpThreadOffset(std::ostream& os, uint32_t offset) {
2461#define DO_THREAD_OFFSET(x, y) \
Chih-Hung Hsiehfba39972016-05-11 11:26:48 -07002462 if (offset == (x).Uint32Value()) { \
2463 os << (y); \
Brian Carlstromf69863b2013-07-17 21:53:13 -07002464 return; \
2465 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002466 DO_THREAD_OFFSET(ThreadFlagsOffset<ptr_size>(), "state_and_flags")
2467 DO_THREAD_OFFSET(CardTableOffset<ptr_size>(), "card_table")
2468 DO_THREAD_OFFSET(ExceptionOffset<ptr_size>(), "exception")
2469 DO_THREAD_OFFSET(PeerOffset<ptr_size>(), "peer");
2470 DO_THREAD_OFFSET(JniEnvOffset<ptr_size>(), "jni_env")
2471 DO_THREAD_OFFSET(SelfOffset<ptr_size>(), "self")
2472 DO_THREAD_OFFSET(StackEndOffset<ptr_size>(), "stack_end")
2473 DO_THREAD_OFFSET(ThinLockIdOffset<ptr_size>(), "thin_lock_thread_id")
2474 DO_THREAD_OFFSET(TopOfManagedStackOffset<ptr_size>(), "top_quick_frame_method")
Ian Rogersdd7624d2014-03-14 17:43:00 -07002475 DO_THREAD_OFFSET(TopShadowFrameOffset<ptr_size>(), "top_shadow_frame")
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07002476 DO_THREAD_OFFSET(TopHandleScopeOffset<ptr_size>(), "top_handle_scope")
Ian Rogersdd7624d2014-03-14 17:43:00 -07002477 DO_THREAD_OFFSET(ThreadSuspendTriggerOffset<ptr_size>(), "suspend_trigger")
Elliott Hughes28fa76d2012-04-09 17:31:46 -07002478#undef DO_THREAD_OFFSET
Elliott Hughes98e20172012-04-24 15:38:13 -07002479
Ian Rogersdd7624d2014-03-14 17:43:00 -07002480#define JNI_ENTRY_POINT_INFO(x) \
2481 if (JNI_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
2482 os << #x; \
2483 return; \
2484 }
2485 JNI_ENTRY_POINT_INFO(pDlsymLookup)
2486#undef JNI_ENTRY_POINT_INFO
2487
Ian Rogersdd7624d2014-03-14 17:43:00 -07002488#define QUICK_ENTRY_POINT_INFO(x) \
2489 if (QUICK_ENTRYPOINT_OFFSET(ptr_size, x).Uint32Value() == offset) { \
2490 os << #x; \
2491 return; \
2492 }
2493 QUICK_ENTRY_POINT_INFO(pAllocArray)
2494 QUICK_ENTRY_POINT_INFO(pAllocArrayResolved)
2495 QUICK_ENTRY_POINT_INFO(pAllocArrayWithAccessCheck)
2496 QUICK_ENTRY_POINT_INFO(pAllocObject)
2497 QUICK_ENTRY_POINT_INFO(pAllocObjectResolved)
2498 QUICK_ENTRY_POINT_INFO(pAllocObjectInitialized)
2499 QUICK_ENTRY_POINT_INFO(pAllocObjectWithAccessCheck)
2500 QUICK_ENTRY_POINT_INFO(pCheckAndAllocArray)
2501 QUICK_ENTRY_POINT_INFO(pCheckAndAllocArrayWithAccessCheck)
Jeff Hao848f70a2014-01-15 13:49:50 -08002502 QUICK_ENTRY_POINT_INFO(pAllocStringFromBytes)
2503 QUICK_ENTRY_POINT_INFO(pAllocStringFromChars)
2504 QUICK_ENTRY_POINT_INFO(pAllocStringFromString)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002505 QUICK_ENTRY_POINT_INFO(pInstanceofNonTrivial)
2506 QUICK_ENTRY_POINT_INFO(pCheckCast)
2507 QUICK_ENTRY_POINT_INFO(pInitializeStaticStorage)
2508 QUICK_ENTRY_POINT_INFO(pInitializeTypeAndVerifyAccess)
2509 QUICK_ENTRY_POINT_INFO(pInitializeType)
2510 QUICK_ENTRY_POINT_INFO(pResolveString)
Fred Shih37f05ef2014-07-16 18:38:08 -07002511 QUICK_ENTRY_POINT_INFO(pSet8Instance)
2512 QUICK_ENTRY_POINT_INFO(pSet8Static)
2513 QUICK_ENTRY_POINT_INFO(pSet16Instance)
2514 QUICK_ENTRY_POINT_INFO(pSet16Static)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002515 QUICK_ENTRY_POINT_INFO(pSet32Instance)
2516 QUICK_ENTRY_POINT_INFO(pSet32Static)
2517 QUICK_ENTRY_POINT_INFO(pSet64Instance)
2518 QUICK_ENTRY_POINT_INFO(pSet64Static)
2519 QUICK_ENTRY_POINT_INFO(pSetObjInstance)
2520 QUICK_ENTRY_POINT_INFO(pSetObjStatic)
Fred Shih37f05ef2014-07-16 18:38:08 -07002521 QUICK_ENTRY_POINT_INFO(pGetByteInstance)
2522 QUICK_ENTRY_POINT_INFO(pGetBooleanInstance)
2523 QUICK_ENTRY_POINT_INFO(pGetByteStatic)
2524 QUICK_ENTRY_POINT_INFO(pGetBooleanStatic)
2525 QUICK_ENTRY_POINT_INFO(pGetShortInstance)
2526 QUICK_ENTRY_POINT_INFO(pGetCharInstance)
2527 QUICK_ENTRY_POINT_INFO(pGetShortStatic)
2528 QUICK_ENTRY_POINT_INFO(pGetCharStatic)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002529 QUICK_ENTRY_POINT_INFO(pGet32Instance)
2530 QUICK_ENTRY_POINT_INFO(pGet32Static)
2531 QUICK_ENTRY_POINT_INFO(pGet64Instance)
2532 QUICK_ENTRY_POINT_INFO(pGet64Static)
2533 QUICK_ENTRY_POINT_INFO(pGetObjInstance)
2534 QUICK_ENTRY_POINT_INFO(pGetObjStatic)
2535 QUICK_ENTRY_POINT_INFO(pAputObjectWithNullAndBoundCheck)
2536 QUICK_ENTRY_POINT_INFO(pAputObjectWithBoundCheck)
2537 QUICK_ENTRY_POINT_INFO(pAputObject)
2538 QUICK_ENTRY_POINT_INFO(pHandleFillArrayData)
2539 QUICK_ENTRY_POINT_INFO(pJniMethodStart)
2540 QUICK_ENTRY_POINT_INFO(pJniMethodStartSynchronized)
2541 QUICK_ENTRY_POINT_INFO(pJniMethodEnd)
2542 QUICK_ENTRY_POINT_INFO(pJniMethodEndSynchronized)
2543 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReference)
2544 QUICK_ENTRY_POINT_INFO(pJniMethodEndWithReferenceSynchronized)
2545 QUICK_ENTRY_POINT_INFO(pQuickGenericJniTrampoline)
2546 QUICK_ENTRY_POINT_INFO(pLockObject)
2547 QUICK_ENTRY_POINT_INFO(pUnlockObject)
2548 QUICK_ENTRY_POINT_INFO(pCmpgDouble)
2549 QUICK_ENTRY_POINT_INFO(pCmpgFloat)
2550 QUICK_ENTRY_POINT_INFO(pCmplDouble)
2551 QUICK_ENTRY_POINT_INFO(pCmplFloat)
Mark Mendella4f12202015-08-06 15:23:34 -04002552 QUICK_ENTRY_POINT_INFO(pCos)
2553 QUICK_ENTRY_POINT_INFO(pSin)
2554 QUICK_ENTRY_POINT_INFO(pAcos)
2555 QUICK_ENTRY_POINT_INFO(pAsin)
2556 QUICK_ENTRY_POINT_INFO(pAtan)
2557 QUICK_ENTRY_POINT_INFO(pAtan2)
2558 QUICK_ENTRY_POINT_INFO(pCbrt)
2559 QUICK_ENTRY_POINT_INFO(pCosh)
2560 QUICK_ENTRY_POINT_INFO(pExp)
2561 QUICK_ENTRY_POINT_INFO(pExpm1)
2562 QUICK_ENTRY_POINT_INFO(pHypot)
2563 QUICK_ENTRY_POINT_INFO(pLog)
2564 QUICK_ENTRY_POINT_INFO(pLog10)
2565 QUICK_ENTRY_POINT_INFO(pNextAfter)
2566 QUICK_ENTRY_POINT_INFO(pSinh)
2567 QUICK_ENTRY_POINT_INFO(pTan)
2568 QUICK_ENTRY_POINT_INFO(pTanh)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002569 QUICK_ENTRY_POINT_INFO(pFmod)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002570 QUICK_ENTRY_POINT_INFO(pL2d)
2571 QUICK_ENTRY_POINT_INFO(pFmodf)
2572 QUICK_ENTRY_POINT_INFO(pL2f)
2573 QUICK_ENTRY_POINT_INFO(pD2iz)
2574 QUICK_ENTRY_POINT_INFO(pF2iz)
2575 QUICK_ENTRY_POINT_INFO(pIdivmod)
2576 QUICK_ENTRY_POINT_INFO(pD2l)
2577 QUICK_ENTRY_POINT_INFO(pF2l)
2578 QUICK_ENTRY_POINT_INFO(pLdiv)
2579 QUICK_ENTRY_POINT_INFO(pLmod)
2580 QUICK_ENTRY_POINT_INFO(pLmul)
2581 QUICK_ENTRY_POINT_INFO(pShlLong)
2582 QUICK_ENTRY_POINT_INFO(pShrLong)
2583 QUICK_ENTRY_POINT_INFO(pUshrLong)
2584 QUICK_ENTRY_POINT_INFO(pIndexOf)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002585 QUICK_ENTRY_POINT_INFO(pStringCompareTo)
2586 QUICK_ENTRY_POINT_INFO(pMemcpy)
2587 QUICK_ENTRY_POINT_INFO(pQuickImtConflictTrampoline)
2588 QUICK_ENTRY_POINT_INFO(pQuickResolutionTrampoline)
2589 QUICK_ENTRY_POINT_INFO(pQuickToInterpreterBridge)
2590 QUICK_ENTRY_POINT_INFO(pInvokeDirectTrampolineWithAccessCheck)
2591 QUICK_ENTRY_POINT_INFO(pInvokeInterfaceTrampolineWithAccessCheck)
2592 QUICK_ENTRY_POINT_INFO(pInvokeStaticTrampolineWithAccessCheck)
2593 QUICK_ENTRY_POINT_INFO(pInvokeSuperTrampolineWithAccessCheck)
2594 QUICK_ENTRY_POINT_INFO(pInvokeVirtualTrampolineWithAccessCheck)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002595 QUICK_ENTRY_POINT_INFO(pTestSuspend)
2596 QUICK_ENTRY_POINT_INFO(pDeliverException)
2597 QUICK_ENTRY_POINT_INFO(pThrowArrayBounds)
2598 QUICK_ENTRY_POINT_INFO(pThrowDivZero)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002599 QUICK_ENTRY_POINT_INFO(pThrowNullPointer)
2600 QUICK_ENTRY_POINT_INFO(pThrowStackOverflow)
Mingyao Yangd43b3ac2015-04-01 14:03:04 -07002601 QUICK_ENTRY_POINT_INFO(pDeoptimize)
Douglas Leungd9cb8ae2014-07-09 14:28:35 -07002602 QUICK_ENTRY_POINT_INFO(pA64Load)
2603 QUICK_ENTRY_POINT_INFO(pA64Store)
Jeff Hao848f70a2014-01-15 13:49:50 -08002604 QUICK_ENTRY_POINT_INFO(pNewEmptyString)
2605 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_B)
2606 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BI)
2607 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BII)
2608 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIII)
2609 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIIString)
2610 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BString)
2611 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BIICharset)
2612 QUICK_ENTRY_POINT_INFO(pNewStringFromBytes_BCharset)
2613 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_C)
2614 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_CII)
2615 QUICK_ENTRY_POINT_INFO(pNewStringFromChars_IIC)
2616 QUICK_ENTRY_POINT_INFO(pNewStringFromCodePoints)
2617 QUICK_ENTRY_POINT_INFO(pNewStringFromString)
2618 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuffer)
2619 QUICK_ENTRY_POINT_INFO(pNewStringFromStringBuilder)
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -07002620 QUICK_ENTRY_POINT_INFO(pReadBarrierJni)
Roland Levillain02b75802016-07-13 11:54:35 +01002621 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg00)
2622 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg01)
2623 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg02)
2624 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg03)
2625 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg04)
2626 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg05)
2627 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg06)
2628 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg07)
2629 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg08)
2630 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg09)
2631 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg10)
2632 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg11)
2633 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg12)
2634 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg13)
2635 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg14)
2636 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg15)
2637 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg16)
2638 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg17)
2639 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg18)
2640 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg19)
2641 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg20)
2642 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg21)
2643 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg22)
2644 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg23)
2645 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg24)
2646 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg25)
2647 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg26)
2648 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg27)
2649 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg28)
2650 QUICK_ENTRY_POINT_INFO(pReadBarrierMarkReg29)
Man Cao1aee9002015-07-14 22:31:42 -07002651 QUICK_ENTRY_POINT_INFO(pReadBarrierSlow)
Roland Levillain0d5a2812015-11-13 10:07:31 +00002652 QUICK_ENTRY_POINT_INFO(pReadBarrierForRootSlow)
Igor Murashkin9d4b6da2016-07-29 09:51:58 -07002653
2654 QUICK_ENTRY_POINT_INFO(pJniMethodFastStart)
2655 QUICK_ENTRY_POINT_INFO(pJniMethodFastEnd)
Ian Rogersdd7624d2014-03-14 17:43:00 -07002656#undef QUICK_ENTRY_POINT_INFO
2657
Elliott Hughes98e20172012-04-24 15:38:13 -07002658 os << offset;
Elliott Hughes28fa76d2012-04-09 17:31:46 -07002659}
2660
jeffhao94d6df42012-11-26 16:02:12 -08002661void Thread::QuickDeliverException() {
Ian Rogers62d6c772013-02-27 08:32:07 -08002662 // Get exception from thread.
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002663 mirror::Throwable* exception = GetException();
Dave Allison0aded082013-11-07 13:15:11 -08002664 CHECK(exception != nullptr);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002665 if (exception == GetDeoptimizationException()) {
2666 artDeoptimize(this);
2667 UNREACHABLE();
2668 }
2669
2670 // This is a real exception: let the instrumentation know about it.
2671 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
2672 if (instrumentation->HasExceptionCaughtListeners() &&
2673 IsExceptionThrownByCurrentMethod(exception)) {
2674 // Instrumentation may cause GC so keep the exception object safe.
2675 StackHandleScope<1> hs(this);
2676 HandleWrapper<mirror::Throwable> h_exception(hs.NewHandleWrapper(&exception));
2677 instrumentation->ExceptionCaughtEvent(this, exception);
2678 }
2679 // Does instrumentation need to deoptimize the stack?
2680 // Note: we do this *after* reporting the exception to instrumentation in case it
2681 // now requires deoptimization. It may happen if a debugger is attached and requests
2682 // new events (single-step, breakpoint, ...) when the exception is reported.
2683 if (Dbg::IsForcedInterpreterNeededForException(this)) {
2684 NthCallerVisitor visitor(this, 0, false);
2685 visitor.WalkStack();
2686 if (Runtime::Current()->IsDeoptimizeable(visitor.caller_pc)) {
Sebastien Hertz520633b2015-09-08 17:03:36 +02002687 // Save the exception into the deoptimization context so it can be restored
2688 // before entering the interpreter.
Nicolas Geoffray73be1e82015-09-17 15:22:56 +01002689 PushDeoptimizationContext(
2690 JValue(), /*is_reference */ false, /* from_code */ false, exception);
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002691 artDeoptimize(this);
2692 UNREACHABLE();
Sebastien Hertz520633b2015-09-08 17:03:36 +02002693 }
2694 }
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002695
Ian Rogers28ad40d2011-10-27 15:19:26 -07002696 // Don't leave exception visible while we try to find the handler, which may cause class
Elliott Hughesd07986f2011-12-06 18:27:45 -08002697 // resolution.
Ian Rogers28ad40d2011-10-27 15:19:26 -07002698 ClearException();
Mingyao Yangf711f2c2016-05-23 12:29:39 -07002699 QuickExceptionHandler exception_handler(this, false);
2700 exception_handler.FindCatch(exception);
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02002701 exception_handler.UpdateInstrumentationStack();
2702 exception_handler.DoLongJump();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07002703}
2704
Ian Rogersbdb03912011-09-14 00:55:44 -07002705Context* Thread::GetLongJumpContext() {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002706 Context* result = tlsPtr_.long_jump_context;
Dave Allison0aded082013-11-07 13:15:11 -08002707 if (result == nullptr) {
Ian Rogersbdb03912011-09-14 00:55:44 -07002708 result = Context::Create();
Ian Rogers0399dde2012-06-06 17:09:28 -07002709 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07002710 tlsPtr_.long_jump_context = nullptr; // Avoid context being shared.
Mathieu Chartier67022432012-11-29 18:04:50 -08002711 result->Reset();
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07002712 }
Ian Rogersbdb03912011-09-14 00:55:44 -07002713 return result;
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -07002714}
2715
Andreas Gampe4a8c3fa2014-07-16 22:20:31 -07002716// Note: this visitor may return with a method set, but dex_pc_ being DexFile:kDexNoIndex. This is
2717// so we don't abort in a special situation (thinlocked monitor) when dumping the Java stack.
Ian Rogerse0dcd462014-03-08 15:21:04 -08002718struct CurrentMethodVisitor FINAL : public StackVisitor {
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002719 CurrentMethodVisitor(Thread* thread, Context* context, bool abort_on_error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002720 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002721 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2722 this_object_(nullptr),
2723 method_(nullptr),
2724 dex_pc_(0),
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002725 abort_on_error_(abort_on_error) {}
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002726 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002727 ArtMethod* m = GetMethod();
Ian Rogers62d6c772013-02-27 08:32:07 -08002728 if (m->IsRuntimeMethod()) {
2729 // Continue if this is a runtime method.
2730 return true;
Ian Rogers0399dde2012-06-06 17:09:28 -07002731 }
Dave Allison0aded082013-11-07 13:15:11 -08002732 if (context_ != nullptr) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002733 this_object_ = GetThisObject();
2734 }
2735 method_ = m;
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002736 dex_pc_ = GetDexPc(abort_on_error_);
Ian Rogers62d6c772013-02-27 08:32:07 -08002737 return false;
2738 }
2739 mirror::Object* this_object_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002740 ArtMethod* method_;
Ian Rogers62d6c772013-02-27 08:32:07 -08002741 uint32_t dex_pc_;
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002742 const bool abort_on_error_;
Ian Rogers62d6c772013-02-27 08:32:07 -08002743};
Ian Rogers0399dde2012-06-06 17:09:28 -07002744
Mathieu Chartiere401d142015-04-22 13:56:20 -07002745ArtMethod* Thread::GetCurrentMethod(uint32_t* dex_pc, bool abort_on_error) const {
Andreas Gampe6ec8ebd2014-07-25 13:36:56 -07002746 CurrentMethodVisitor visitor(const_cast<Thread*>(this), nullptr, abort_on_error);
Ian Rogers0399dde2012-06-06 17:09:28 -07002747 visitor.WalkStack(false);
Dave Allison0aded082013-11-07 13:15:11 -08002748 if (dex_pc != nullptr) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002749 *dex_pc = visitor.dex_pc_;
Elliott Hughes9fd66f52011-10-16 12:13:26 -07002750 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002751 return visitor.method_;
jeffhao33dc7712011-11-09 17:54:24 -08002752}
2753
Ian Rogersdd7624d2014-03-14 17:43:00 -07002754bool Thread::HoldsLock(mirror::Object* object) const {
Dave Allison0aded082013-11-07 13:15:11 -08002755 if (object == nullptr) {
Elliott Hughes5f791332011-09-15 17:45:30 -07002756 return false;
2757 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002758 return object->GetLockOwnerThreadId() == GetThreadId();
Elliott Hughes5f791332011-09-15 17:45:30 -07002759}
2760
Ian Rogers40e3bac2012-11-20 00:09:14 -08002761// RootVisitor parameters are: (const Object* obj, size_t vreg, const StackVisitor* visitor).
2762template <typename RootVisitor>
Ian Rogers0399dde2012-06-06 17:09:28 -07002763class ReferenceMapVisitor : public StackVisitor {
Ian Rogersd6b1f612011-09-27 13:38:14 -07002764 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002765 ReferenceMapVisitor(Thread* thread, Context* context, RootVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002766 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002767 // We are visiting the references in compiled frames, so we do not need
2768 // to know the inlined frames.
2769 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
2770 visitor_(visitor) {}
Ian Rogersd6b1f612011-09-27 13:38:14 -07002771
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002772 bool VisitFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07002773 if (false) {
David Sehr709b0702016-10-13 09:12:37 -07002774 LOG(INFO) << "Visiting stack roots in " << ArtMethod::PrettyMethod(GetMethod())
Sebastien Hertz714f1752014-04-28 15:03:08 +02002775 << StringPrintf("@ PC:%04x", GetDexPc());
Brian Carlstrom6a4be3a2011-10-20 16:34:03 -07002776 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002777 ShadowFrame* shadow_frame = GetCurrentShadowFrame();
Dave Allison0aded082013-11-07 13:15:11 -08002778 if (shadow_frame != nullptr) {
Sebastien Hertz714f1752014-04-28 15:03:08 +02002779 VisitShadowFrame(shadow_frame);
2780 } else {
2781 VisitQuickFrame();
2782 }
2783 return true;
2784 }
2785
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002786 void VisitShadowFrame(ShadowFrame* shadow_frame) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002787 ArtMethod* m = shadow_frame->GetMethod();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002788 VisitDeclaringClass(m);
Hiroshi Yamauchi92d1a662014-05-15 21:43:59 -07002789 DCHECK(m != nullptr);
Sebastien Hertz714f1752014-04-28 15:03:08 +02002790 size_t num_regs = shadow_frame->NumberOfVRegs();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002791 DCHECK(m->IsNative() || shadow_frame->HasReferenceArray());
2792 // handle scope for JNI or References for interpreter.
2793 for (size_t reg = 0; reg < num_regs; ++reg) {
2794 mirror::Object* ref = shadow_frame->GetVRegReference(reg);
2795 if (ref != nullptr) {
2796 mirror::Object* new_ref = ref;
2797 visitor_(&new_ref, reg, this);
2798 if (new_ref != ref) {
2799 shadow_frame->SetVRegReference(reg, new_ref);
TDYa127ce4cc0d2012-11-18 16:59:53 -08002800 }
2801 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02002802 }
Andreas Gampe03ec9302015-08-27 17:41:47 -07002803 // Mark lock count map required for structured locking checks.
2804 shadow_frame->GetLockCountData().VisitMonitors(visitor_, -1, this);
Sebastien Hertz714f1752014-04-28 15:03:08 +02002805 }
2806
2807 private:
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002808 // 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 -07002809 // is executing. We need to ensure that the code stays mapped. NO_THREAD_SAFETY_ANALYSIS since
2810 // the threads do not all hold the heap bitmap lock for parallel GC.
2811 void VisitDeclaringClass(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002812 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002813 NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartiere7f75f32016-02-01 16:08:15 -08002814 mirror::Class* klass = method->GetDeclaringClassUnchecked<kWithoutReadBarrier>();
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002815 // klass can be null for runtime methods.
2816 if (klass != nullptr) {
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002817 if (kVerifyImageObjectsMarked) {
2818 gc::Heap* const heap = Runtime::Current()->GetHeap();
2819 gc::space::ContinuousSpace* space = heap->FindContinuousSpaceFromObject(klass,
2820 /*fail_ok*/true);
2821 if (space != nullptr && space->IsImageSpace()) {
2822 bool failed = false;
2823 if (!space->GetLiveBitmap()->Test(klass)) {
2824 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002825 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002826 } else if (!heap->GetLiveBitmap()->Test(klass)) {
2827 failed = true;
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002828 LOG(FATAL_WITHOUT_ABORT) << "Unmarked object in image through live bitmap " << *space;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002829 }
2830 if (failed) {
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002831 GetThread()->Dump(LOG_STREAM(FATAL_WITHOUT_ABORT));
2832 space->AsImageSpace()->DumpSections(LOG_STREAM(FATAL_WITHOUT_ABORT));
2833 LOG(FATAL_WITHOUT_ABORT) << "Method@" << method->GetDexMethodIndex() << ":" << method
Andreas Gamped6e54bb2016-09-26 14:07:57 -07002834 << " klass@" << klass;
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002835 // Pretty info last in case it crashes.
David Sehr709b0702016-10-13 09:12:37 -07002836 LOG(FATAL) << "Method " << method->PrettyMethod() << " klass "
2837 << klass->PrettyClass();
Mathieu Chartierd5f3f322016-03-21 14:05:56 -07002838 }
2839 }
2840 }
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002841 mirror::Object* new_ref = klass;
2842 visitor_(&new_ref, -1, this);
2843 if (new_ref != klass) {
2844 method->CASDeclaringClass(klass, new_ref->AsClass());
2845 }
2846 }
2847 }
2848
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002849 void VisitQuickFrame() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002850 ArtMethod** cur_quick_frame = GetCurrentQuickFrame();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002851 DCHECK(cur_quick_frame != nullptr);
Mathieu Chartier10e5ea92015-08-13 12:56:31 -07002852 ArtMethod* m = *cur_quick_frame;
2853 VisitDeclaringClass(m);
Andreas Gampecf4035a2014-05-28 22:43:01 -07002854
Sebastien Hertz714f1752014-04-28 15:03:08 +02002855 // Process register map (which native and runtime methods don't have)
Jeff Hao84949432016-05-13 14:46:28 -07002856 if (!m->IsNative() && !m->IsRuntimeMethod() && (!m->IsProxyMethod() || m->IsConstructor())) {
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002857 const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002858 DCHECK(method_header->IsOptimized());
2859 auto* vreg_base = reinterpret_cast<StackReference<mirror::Object>*>(
2860 reinterpret_cast<uintptr_t>(cur_quick_frame));
2861 uintptr_t native_pc_offset = method_header->NativeQuickPcOffset(GetCurrentQuickFramePc());
2862 CodeInfo code_info = method_header->GetOptimizedCodeInfo();
2863 CodeInfoEncoding encoding = code_info.ExtractEncoding();
2864 StackMap map = code_info.GetStackMapForNativePcOffset(native_pc_offset, encoding);
2865 DCHECK(map.IsValid());
2866 // Visit stack entries that hold pointers.
2867 size_t number_of_bits = map.GetNumberOfStackMaskBits(encoding.stack_map_encoding);
2868 for (size_t i = 0; i < number_of_bits; ++i) {
2869 if (map.GetStackMaskBit(encoding.stack_map_encoding, i)) {
2870 auto* ref_addr = vreg_base + i;
2871 mirror::Object* ref = ref_addr->AsMirrorPtr();
2872 if (ref != nullptr) {
2873 mirror::Object* new_ref = ref;
2874 visitor_(&new_ref, -1, this);
2875 if (ref != new_ref) {
2876 ref_addr->Assign(new_ref);
Nicolas Geoffray39468442014-09-02 15:17:15 +01002877 }
2878 }
2879 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002880 }
2881 // Visit callee-save registers that hold pointers.
2882 uint32_t register_mask = map.GetRegisterMask(encoding.stack_map_encoding);
2883 for (size_t i = 0; i < BitSizeOf<uint32_t>(); ++i) {
2884 if (register_mask & (1 << i)) {
2885 mirror::Object** ref_addr = reinterpret_cast<mirror::Object**>(GetGPRAddress(i));
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07002886 if (kIsDebugBuild && ref_addr == nullptr) {
2887 std::string thread_name;
2888 GetThread()->GetThreadName(thread_name);
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07002889 LOG(FATAL_WITHOUT_ABORT) << "On thread " << thread_name;
Hiroshi Yamauchieb1680f2016-09-12 12:10:08 -07002890 DescribeStack(GetThread());
2891 LOG(FATAL) << "Found an unsaved callee-save register " << i << " (null GPRAddress) "
2892 << "set in register_mask=" << register_mask << " at " << DescribeLocation();
2893 }
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002894 if (*ref_addr != nullptr) {
2895 visitor_(ref_addr, -1, this);
Shih-wei Liao4f894e32011-09-27 21:33:19 -07002896 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07002897 }
2898 }
2899 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07002900 }
2901
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07002902 // Visitor for when we visit a root.
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002903 RootVisitor& visitor_;
Ian Rogersd6b1f612011-09-27 13:38:14 -07002904};
2905
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07002906class RootCallbackVisitor {
2907 public:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002908 RootCallbackVisitor(RootVisitor* visitor, uint32_t tid) : visitor_(visitor), tid_(tid) {}
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07002909
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002910 void operator()(mirror::Object** obj, size_t vreg, const StackVisitor* stack_visitor) const
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002911 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002912 visitor_->VisitRoot(obj, JavaFrameRootInfo(tid_, stack_visitor, vreg));
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07002913 }
2914
2915 private:
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002916 RootVisitor* const visitor_;
Mathieu Chartier83c8ee02014-01-28 14:50:23 -08002917 const uint32_t tid_;
Mathieu Chartier6f1c9492012-10-15 12:08:41 -07002918};
2919
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002920void Thread::VisitRoots(RootVisitor* visitor) {
2921 const uint32_t thread_id = GetThreadId();
2922 visitor->VisitRootIfNonNull(&tlsPtr_.opeer, RootInfo(kRootThreadObject, thread_id));
Sebastien Hertzfd3077e2014-04-23 10:32:43 +02002923 if (tlsPtr_.exception != nullptr && tlsPtr_.exception != GetDeoptimizationException()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002924 visitor->VisitRoot(reinterpret_cast<mirror::Object**>(&tlsPtr_.exception),
Sebastien Hertz07474662015-08-25 15:12:33 +00002925 RootInfo(kRootNativeStack, thread_id));
Elliott Hughesd369bb72011-09-12 14:41:14 -07002926 }
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002927 visitor->VisitRootIfNonNull(&tlsPtr_.monitor_enter_object, RootInfo(kRootNativeStack, thread_id));
2928 tlsPtr_.jni_env->locals.VisitRoots(visitor, RootInfo(kRootJNILocal, thread_id));
2929 tlsPtr_.jni_env->monitors.VisitRoots(visitor, RootInfo(kRootJNIMonitor, thread_id));
2930 HandleScopeVisitRoots(visitor, thread_id);
Ian Rogersdd7624d2014-03-14 17:43:00 -07002931 if (tlsPtr_.debug_invoke_req != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002932 tlsPtr_.debug_invoke_req->VisitRoots(visitor, RootInfo(kRootDebugger, thread_id));
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -07002933 }
Sebastien Hertz07474662015-08-25 15:12:33 +00002934 // Visit roots for deoptimization.
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07002935 if (tlsPtr_.stacked_shadow_frame_record != nullptr) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002936 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
2937 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, nullptr, visitor_to_callback);
Mingyao Yang1f2d3ba2015-05-18 12:12:50 -07002938 for (StackedShadowFrameRecord* record = tlsPtr_.stacked_shadow_frame_record;
2939 record != nullptr;
2940 record = record->GetLink()) {
2941 for (ShadowFrame* shadow_frame = record->GetShadowFrame();
2942 shadow_frame != nullptr;
2943 shadow_frame = shadow_frame->GetLink()) {
2944 mapper.VisitShadowFrame(shadow_frame);
2945 }
Sebastien Hertz714f1752014-04-28 15:03:08 +02002946 }
2947 }
Mingyao Yang99170c62015-07-06 11:10:37 -07002948 for (DeoptimizationContextRecord* record = tlsPtr_.deoptimization_context_stack;
2949 record != nullptr;
2950 record = record->GetLink()) {
2951 if (record->IsReference()) {
2952 visitor->VisitRootIfNonNull(record->GetReturnValueAsGCRoot(),
Sebastien Hertz07474662015-08-25 15:12:33 +00002953 RootInfo(kRootThreadObject, thread_id));
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07002954 }
Mingyao Yang99170c62015-07-06 11:10:37 -07002955 visitor->VisitRootIfNonNull(record->GetPendingExceptionAsGCRoot(),
2956 RootInfo(kRootThreadObject, thread_id));
2957 }
2958 if (tlsPtr_.frame_id_to_shadow_frame != nullptr) {
2959 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
2960 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, nullptr, visitor_to_callback);
2961 for (FrameIdToShadowFrame* record = tlsPtr_.frame_id_to_shadow_frame;
2962 record != nullptr;
2963 record = record->GetNext()) {
2964 mapper.VisitShadowFrame(record->GetShadowFrame());
2965 }
Andreas Gampe2a0d4ec2014-06-02 22:05:22 -07002966 }
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07002967 for (auto* verifier = tlsPtr_.method_verifier; verifier != nullptr; verifier = verifier->link_) {
2968 verifier->VisitRoots(visitor, RootInfo(kRootNativeStack, thread_id));
Mathieu Chartier12d625f2015-03-13 11:33:37 -07002969 }
Ian Rogersd6b1f612011-09-27 13:38:14 -07002970 // Visit roots on this thread's stack
Ian Rogers0399dde2012-06-06 17:09:28 -07002971 Context* context = GetLongJumpContext();
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002972 RootCallbackVisitor visitor_to_callback(visitor, thread_id);
Mathieu Chartiere34fa1d2015-01-14 14:55:47 -08002973 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context, visitor_to_callback);
Ian Rogers0399dde2012-06-06 17:09:28 -07002974 mapper.WalkStack();
2975 ReleaseLongJumpContext(context);
Mathieu Chartier423d2a32013-09-12 17:33:56 -07002976 for (instrumentation::InstrumentationStackFrame& frame : *GetInstrumentationStack()) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002977 visitor->VisitRootIfNonNull(&frame.this_object_, RootInfo(kRootVMInternal, thread_id));
Ian Rogers62d6c772013-02-27 08:32:07 -08002978 }
Elliott Hughes410c0c82011-09-01 17:58:25 -07002979}
2980
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002981class VerifyRootVisitor : public SingleRootVisitor {
2982 public:
2983 void VisitRoot(mirror::Object* root, const RootInfo& info ATTRIBUTE_UNUSED)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002984 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002985 VerifyObject(root);
2986 }
2987};
jeffhao25045522012-03-13 19:34:37 -07002988
Ian Rogers04d7aa92013-03-16 14:29:17 -07002989void Thread::VerifyStackImpl() {
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002990 VerifyRootVisitor visitor;
Ian Rogers700a4022014-05-19 16:49:03 -07002991 std::unique_ptr<Context> context(Context::Create());
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -07002992 RootCallbackVisitor visitor_to_callback(&visitor, GetThreadId());
2993 ReferenceMapVisitor<RootCallbackVisitor> mapper(this, context.get(), visitor_to_callback);
Ian Rogers0399dde2012-06-06 17:09:28 -07002994 mapper.WalkStack();
jeffhao25045522012-03-13 19:34:37 -07002995}
jeffhao25045522012-03-13 19:34:37 -07002996
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002997// Set the stack end to that to be used during a stack overflow
2998void Thread::SetStackEndForStackOverflow() {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07002999 // During stack overflow we allow use of the full stack.
Ian Rogersdd7624d2014-03-14 17:43:00 -07003000 if (tlsPtr_.stack_end == tlsPtr_.stack_begin) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003001 // However, we seem to have already extended to use the full stack.
3002 LOG(ERROR) << "Need to increase kStackOverflowReservedBytes (currently "
Andreas Gampe7ea6f792014-07-14 16:21:44 -07003003 << GetStackOverflowReservedBytes(kRuntimeISA) << ")?";
Andreas Gampe3fec9ac2016-09-13 10:47:28 -07003004 DumpStack(LOG_STREAM(ERROR));
Brian Carlstrom7571e8b2013-08-12 17:04:14 -07003005 LOG(FATAL) << "Recursive stack overflow.";
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003006 }
3007
Ian Rogersdd7624d2014-03-14 17:43:00 -07003008 tlsPtr_.stack_end = tlsPtr_.stack_begin;
Dave Allison648d7112014-07-25 16:15:27 -07003009
3010 // Remove the stack overflow protection if is it set up.
3011 bool implicit_stack_check = !Runtime::Current()->ExplicitStackOverflowChecks();
3012 if (implicit_stack_check) {
3013 if (!UnprotectStack()) {
3014 LOG(ERROR) << "Unable to remove stack protection for stack overflow";
3015 }
3016 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003017}
3018
Ian Rogers13735952014-10-08 12:43:28 -07003019void Thread::SetTlab(uint8_t* start, uint8_t* end) {
Mathieu Chartier692fafd2013-11-29 17:24:40 -08003020 DCHECK_LE(start, end);
Ian Rogersdd7624d2014-03-14 17:43:00 -07003021 tlsPtr_.thread_local_start = start;
3022 tlsPtr_.thread_local_pos = tlsPtr_.thread_local_start;
3023 tlsPtr_.thread_local_end = end;
3024 tlsPtr_.thread_local_objects = 0;
Mathieu Chartier692fafd2013-11-29 17:24:40 -08003025}
3026
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003027bool Thread::HasTlab() const {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003028 bool has_tlab = tlsPtr_.thread_local_pos != nullptr;
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003029 if (has_tlab) {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003030 DCHECK(tlsPtr_.thread_local_start != nullptr && tlsPtr_.thread_local_end != nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003031 } else {
Ian Rogersdd7624d2014-03-14 17:43:00 -07003032 DCHECK(tlsPtr_.thread_local_start == nullptr && tlsPtr_.thread_local_end == nullptr);
Hiroshi Yamauchic93c5302014-03-20 16:15:37 -07003033 }
3034 return has_tlab;
3035}
3036
Elliott Hughes330304d2011-08-12 14:28:05 -07003037std::ostream& operator<<(std::ostream& os, const Thread& thread) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003038 thread.ShortDump(os);
Elliott Hughes330304d2011-08-12 14:28:05 -07003039 return os;
3040}
3041
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003042bool Thread::ProtectStack(bool fatal_on_error) {
Dave Allison648d7112014-07-25 16:15:27 -07003043 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
3044 VLOG(threads) << "Protecting stack at " << pregion;
3045 if (mprotect(pregion, kStackOverflowProtectedSize, PROT_NONE) == -1) {
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003046 if (fatal_on_error) {
3047 LOG(FATAL) << "Unable to create protected region in stack for implicit overflow check. "
3048 "Reason: "
3049 << strerror(errno) << " size: " << kStackOverflowProtectedSize;
3050 }
3051 return false;
Dave Allison648d7112014-07-25 16:15:27 -07003052 }
Andreas Gampe2c2d2a02016-03-17 21:27:19 -07003053 return true;
Dave Allison648d7112014-07-25 16:15:27 -07003054}
3055
3056bool Thread::UnprotectStack() {
3057 void* pregion = tlsPtr_.stack_begin - kStackOverflowProtectedSize;
3058 VLOG(threads) << "Unprotecting stack at " << pregion;
3059 return mprotect(pregion, kStackOverflowProtectedSize, PROT_READ|PROT_WRITE) == 0;
3060}
3061
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003062void Thread::ActivateSingleStepControl(SingleStepControl* ssc) {
3063 CHECK(Dbg::IsDebuggerActive());
3064 CHECK(GetSingleStepControl() == nullptr) << "Single step already active in thread " << *this;
3065 CHECK(ssc != nullptr);
3066 tlsPtr_.single_step_control = ssc;
3067}
3068
3069void Thread::DeactivateSingleStepControl() {
3070 CHECK(Dbg::IsDebuggerActive());
3071 CHECK(GetSingleStepControl() != nullptr) << "Single step not active in thread " << *this;
3072 SingleStepControl* ssc = GetSingleStepControl();
3073 tlsPtr_.single_step_control = nullptr;
3074 delete ssc;
3075}
Dave Allison648d7112014-07-25 16:15:27 -07003076
Sebastien Hertz1558b572015-02-25 15:05:59 +01003077void Thread::SetDebugInvokeReq(DebugInvokeReq* req) {
3078 CHECK(Dbg::IsDebuggerActive());
3079 CHECK(GetInvokeReq() == nullptr) << "Debug invoke req already active in thread " << *this;
3080 CHECK(Thread::Current() != this) << "Debug invoke can't be dispatched by the thread itself";
3081 CHECK(req != nullptr);
3082 tlsPtr_.debug_invoke_req = req;
3083}
3084
3085void Thread::ClearDebugInvokeReq() {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003086 CHECK(GetInvokeReq() != nullptr) << "Debug invoke req not active in thread " << *this;
3087 CHECK(Thread::Current() == this) << "Debug invoke must be finished by the thread itself";
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003088 DebugInvokeReq* req = tlsPtr_.debug_invoke_req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003089 tlsPtr_.debug_invoke_req = nullptr;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003090 delete req;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003091}
3092
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003093void Thread::PushVerifier(verifier::MethodVerifier* verifier) {
3094 verifier->link_ = tlsPtr_.method_verifier;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003095 tlsPtr_.method_verifier = verifier;
3096}
3097
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003098void Thread::PopVerifier(verifier::MethodVerifier* verifier) {
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003099 CHECK_EQ(tlsPtr_.method_verifier, verifier);
Mathieu Chartierd0ad2ee2015-03-31 14:59:59 -07003100 tlsPtr_.method_verifier = verifier->link_;
Mathieu Chartier12d625f2015-03-13 11:33:37 -07003101}
3102
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07003103size_t Thread::NumberOfHeldMutexes() const {
3104 size_t count = 0;
3105 for (BaseMutex* mu : tlsPtr_.held_mutexes) {
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07003106 count += mu != nullptr ? 1 : 0;
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07003107 }
3108 return count;
3109}
3110
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003111void Thread::DeoptimizeWithDeoptimizationException(JValue* result) {
3112 DCHECK_EQ(GetException(), Thread::GetDeoptimizationException());
3113 ClearException();
3114 ShadowFrame* shadow_frame =
3115 PopStackedShadowFrame(StackedShadowFrameType::kDeoptimizationShadowFrame);
3116 mirror::Throwable* pending_exception = nullptr;
3117 bool from_code = false;
3118 PopDeoptimizationContext(result, &pending_exception, &from_code);
Nicolas Geoffrayb331feb2016-02-05 16:51:53 +00003119 SetTopOfStack(nullptr);
3120 SetTopOfShadowStack(shadow_frame);
3121
3122 // Restore the exception that was pending before deoptimization then interpret the
3123 // deoptimized frames.
3124 if (pending_exception != nullptr) {
3125 SetException(pending_exception);
3126 }
3127 interpreter::EnterInterpreterFromDeoptimize(this, shadow_frame, from_code, result);
3128}
3129
Mathieu Chartier0795f232016-09-27 18:43:30 -07003130void Thread::SetException(ObjPtr<mirror::Throwable> new_exception) {
Mathieu Chartiere42888f2016-04-14 10:49:19 -07003131 CHECK(new_exception != nullptr);
3132 // TODO: DCHECK(!IsExceptionPending());
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07003133 tlsPtr_.exception = new_exception.Ptr();
Mathieu Chartiere42888f2016-04-14 10:49:19 -07003134}
3135
Elliott Hughes8daa0922011-09-11 13:46:25 -07003136} // namespace art