blob: a5b06894736e63709fcb8b73cd6a0177f29b7517 [file] [log] [blame]
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001/*
2 * Copyright (C) 2008 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 */
16
17#include "debugger.h"
18
Elliott Hughes3bb81562011-10-21 18:52:59 -070019#include <sys/uio.h>
20
Elliott Hughes545a0642011-11-08 19:10:03 -080021#include <set>
22
Ian Rogers166db042013-07-26 12:05:57 -070023#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070024#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070025#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070026#include "base/enums.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010027#include "base/time_utils.h"
Elliott Hughes545a0642011-11-08 19:10:03 -080028#include "class_linker.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080029#include "class_linker-inl.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070030#include "dex_file-inl.h"
Ian Rogers776ac1f2012-04-13 23:36:36 -070031#include "dex_instruction.h"
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -080032#include "entrypoints/runtime_asm_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070033#include "gc/accounting/card_table-inl.h"
Man Cao8c2ff642015-05-27 17:25:30 -070034#include "gc/allocation_record.h"
Mathieu Chartieraa516822015-10-02 15:53:37 -070035#include "gc/scoped_gc_critical_section.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070036#include "gc/space/large_object_space.h"
37#include "gc/space/space-inl.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070038#include "handle_scope.h"
Sebastien Hertzcbc50642015-06-01 17:33:12 +020039#include "jdwp/jdwp_priv.h"
Elliott Hughes64f574f2013-02-20 14:57:12 -080040#include "jdwp/object_registry.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080041#include "mirror/class.h"
42#include "mirror/class-inl.h"
43#include "mirror/class_loader.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080044#include "mirror/object-inl.h"
45#include "mirror/object_array-inl.h"
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070046#include "mirror/string-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080047#include "mirror/throwable.h"
Ian Rogers53b8b092014-03-13 23:45:53 -070048#include "reflection.h"
Elliott Hughesa0e18062012-04-13 15:59:59 -070049#include "safe_map.h"
Elliott Hughes64f574f2013-02-20 14:57:12 -080050#include "scoped_thread_state_change.h"
Elliott Hughes6a5bd492011-10-28 14:33:57 -070051#include "ScopedLocalRef.h"
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -070052#include "ScopedPrimitiveArray.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070053#include "handle_scope-inl.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070054#include "thread_list.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080055#include "utf.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070056#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070057
Elliott Hughes872d4ec2011-10-21 17:07:15 -070058namespace art {
59
Sebastien Hertz0462c4c2015-04-01 16:34:17 +020060// The key identifying the debugger to update instrumentation.
61static constexpr const char* kDbgInstrumentationKey = "Debugger";
62
Man Cao8c2ff642015-05-27 17:25:30 -070063// Limit alloc_record_count to the 2BE value (64k-1) that is the limit of the current protocol.
Brian Carlstrom306db812014-09-05 13:01:41 -070064static uint16_t CappedAllocRecordCount(size_t alloc_record_count) {
Man Cao1ed11b92015-06-11 22:47:35 -070065 const size_t cap = 0xffff;
Man Cao8c2ff642015-05-27 17:25:30 -070066 if (alloc_record_count > cap) {
67 return cap;
Brian Carlstrom306db812014-09-05 13:01:41 -070068 }
69 return alloc_record_count;
70}
Elliott Hughes475fc232011-10-25 15:00:35 -070071
Alex Light6c8467f2015-11-20 15:03:26 -080072// Takes a method and returns a 'canonical' one if the method is default (and therefore potentially
73// copied from some other class). This ensures that the debugger does not get confused as to which
74// method we are in.
75static ArtMethod* GetCanonicalMethod(ArtMethod* m)
76 SHARED_REQUIRES(Locks::mutator_lock_) {
77 if (LIKELY(!m->IsDefault())) {
78 return m;
79 } else {
80 mirror::Class* declaring_class = m->GetDeclaringClass();
81 return declaring_class->FindDeclaredVirtualMethod(declaring_class->GetDexCache(),
82 m->GetDexMethodIndex(),
Andreas Gampe542451c2016-07-26 09:02:02 -070083 kRuntimePointerSize);
Alex Light6c8467f2015-11-20 15:03:26 -080084 }
85}
86
Mathieu Chartier41af5e52015-10-28 11:10:46 -070087class Breakpoint : public ValueObject {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070088 public:
Mathieu Chartier41af5e52015-10-28 11:10:46 -070089 Breakpoint(ArtMethod* method, uint32_t dex_pc, DeoptimizationRequest::Kind deoptimization_kind)
Alex Light6c8467f2015-11-20 15:03:26 -080090 : method_(GetCanonicalMethod(method)),
Mathieu Chartier41af5e52015-10-28 11:10:46 -070091 dex_pc_(dex_pc),
92 deoptimization_kind_(deoptimization_kind) {
Sebastien Hertzf3928792014-11-17 19:00:37 +010093 CHECK(deoptimization_kind_ == DeoptimizationRequest::kNothing ||
94 deoptimization_kind_ == DeoptimizationRequest::kSelectiveDeoptimization ||
95 deoptimization_kind_ == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070096 }
97
Mathieu Chartier90443472015-07-16 20:32:27 -070098 Breakpoint(const Breakpoint& other) SHARED_REQUIRES(Locks::mutator_lock_)
Mathieu Chartier41af5e52015-10-28 11:10:46 -070099 : method_(other.method_),
100 dex_pc_(other.dex_pc_),
101 deoptimization_kind_(other.deoptimization_kind_) {}
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700102
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700103 // Method() is called from root visiting, do not use ScopedObjectAccess here or it can cause
104 // GC to deadlock if another thread tries to call SuspendAll while the GC is in a runnable state.
105 ArtMethod* Method() const {
106 return method_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700107 }
108
109 uint32_t DexPc() const {
110 return dex_pc_;
111 }
112
Sebastien Hertzf3928792014-11-17 19:00:37 +0100113 DeoptimizationRequest::Kind GetDeoptimizationKind() const {
114 return deoptimization_kind_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700115 }
116
Alex Light6c8467f2015-11-20 15:03:26 -0800117 // Returns true if the method of this breakpoint and the passed in method should be considered the
118 // same. That is, they are either the same method or they are copied from the same method.
119 bool IsInMethod(ArtMethod* m) const SHARED_REQUIRES(Locks::mutator_lock_) {
120 return method_ == GetCanonicalMethod(m);
121 }
122
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700123 private:
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100124 // The location of this breakpoint.
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700125 ArtMethod* method_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700126 uint32_t dex_pc_;
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100127
128 // Indicates whether breakpoint needs full deoptimization or selective deoptimization.
Sebastien Hertzf3928792014-11-17 19:00:37 +0100129 DeoptimizationRequest::Kind deoptimization_kind_;
Elliott Hughes86964332012-02-15 19:37:42 -0800130};
131
Sebastien Hertzed2be172014-08-19 15:33:43 +0200132static std::ostream& operator<<(std::ostream& os, const Breakpoint& rhs)
Mathieu Chartier90443472015-07-16 20:32:27 -0700133 SHARED_REQUIRES(Locks::mutator_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700134 os << StringPrintf("Breakpoint[%s @%#x]", PrettyMethod(rhs.Method()).c_str(), rhs.DexPc());
Elliott Hughes86964332012-02-15 19:37:42 -0800135 return os;
136}
137
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200138class DebugInstrumentationListener FINAL : public instrumentation::InstrumentationListener {
Ian Rogers62d6c772013-02-27 08:32:07 -0800139 public:
140 DebugInstrumentationListener() {}
141 virtual ~DebugInstrumentationListener() {}
142
Mathieu Chartiere401d142015-04-22 13:56:20 -0700143 void MethodEntered(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200144 uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700145 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800146 if (method->IsNative()) {
147 // TODO: post location events is a suspension point and native method entry stubs aren't.
148 return;
149 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200150 if (IsListeningToDexPcMoved()) {
151 // We also listen to kDexPcMoved instrumentation event so we know the DexPcMoved method is
152 // going to be called right after us. To avoid sending JDWP events twice for this location,
153 // we report the event in DexPcMoved. However, we must remind this is method entry so we
154 // send the METHOD_ENTRY event. And we can also group it with other events for this location
155 // like BREAKPOINT or SINGLE_STEP (or even METHOD_EXIT if this is a RETURN instruction).
156 thread->SetDebugMethodEntry();
157 } else if (IsListeningToMethodExit() && IsReturn(method, dex_pc)) {
158 // We also listen to kMethodExited instrumentation event and the current instruction is a
159 // RETURN so we know the MethodExited method is going to be called right after us. To avoid
160 // sending JDWP events twice for this location, we report the event(s) in MethodExited.
161 // However, we must remind this is method entry so we send the METHOD_ENTRY event. And we can
162 // also group it with other events for this location like BREAKPOINT or SINGLE_STEP.
163 thread->SetDebugMethodEntry();
164 } else {
165 Dbg::UpdateDebugger(thread, this_object, method, 0, Dbg::kMethodEntry, nullptr);
166 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800167 }
168
Mathieu Chartiere401d142015-04-22 13:56:20 -0700169 void MethodExited(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200170 uint32_t dex_pc, const JValue& return_value)
Mathieu Chartier90443472015-07-16 20:32:27 -0700171 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800172 if (method->IsNative()) {
173 // TODO: post location events is a suspension point and native method entry stubs aren't.
174 return;
175 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200176 uint32_t events = Dbg::kMethodExit;
177 if (thread->IsDebugMethodEntry()) {
178 // It is also the method entry.
179 DCHECK(IsReturn(method, dex_pc));
180 events |= Dbg::kMethodEntry;
181 thread->ClearDebugMethodEntry();
182 }
183 Dbg::UpdateDebugger(thread, this_object, method, dex_pc, events, &return_value);
Ian Rogers62d6c772013-02-27 08:32:07 -0800184 }
185
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200186 void MethodUnwind(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object ATTRIBUTE_UNUSED,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700187 ArtMethod* method, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700188 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800189 // We're not recorded to listen to this kind of event, so complain.
190 LOG(ERROR) << "Unexpected method unwind event in debugger " << PrettyMethod(method)
Sebastien Hertz51db44a2013-11-19 10:00:29 +0100191 << " " << dex_pc;
Ian Rogers62d6c772013-02-27 08:32:07 -0800192 }
193
Mathieu Chartiere401d142015-04-22 13:56:20 -0700194 void DexPcMoved(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200195 uint32_t new_dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700196 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200197 if (IsListeningToMethodExit() && IsReturn(method, new_dex_pc)) {
198 // We also listen to kMethodExited instrumentation event and the current instruction is a
199 // RETURN so we know the MethodExited method is going to be called right after us. Like in
200 // MethodEntered, we delegate event reporting to MethodExited.
201 // Besides, if this RETURN instruction is the only one in the method, we can send multiple
202 // JDWP events in the same packet: METHOD_ENTRY, METHOD_EXIT, BREAKPOINT and/or SINGLE_STEP.
203 // Therefore, we must not clear the debug method entry flag here.
204 } else {
205 uint32_t events = 0;
206 if (thread->IsDebugMethodEntry()) {
207 // It is also the method entry.
208 events = Dbg::kMethodEntry;
209 thread->ClearDebugMethodEntry();
210 }
211 Dbg::UpdateDebugger(thread, this_object, method, new_dex_pc, events, nullptr);
212 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800213 }
214
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200215 void FieldRead(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700216 ArtMethod* method, uint32_t dex_pc, ArtField* field)
Mathieu Chartier90443472015-07-16 20:32:27 -0700217 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200218 Dbg::PostFieldAccessEvent(method, dex_pc, this_object, field);
Ian Rogers62d6c772013-02-27 08:32:07 -0800219 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200220
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700221 void FieldWritten(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700222 ArtMethod* method, uint32_t dex_pc, ArtField* field,
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700223 const JValue& field_value)
Mathieu Chartier90443472015-07-16 20:32:27 -0700224 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200225 Dbg::PostFieldModificationEvent(method, dex_pc, this_object, field, &field_value);
226 }
227
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000228 void ExceptionCaught(Thread* thread ATTRIBUTE_UNUSED, mirror::Throwable* exception_object)
Mathieu Chartier90443472015-07-16 20:32:27 -0700229 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000230 Dbg::PostException(exception_object);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200231 }
232
Nicolas Geoffray81f0f952016-01-20 16:25:19 +0000233 // We only care about branches in the Jit.
234 void Branch(Thread* /*thread*/, ArtMethod* method, uint32_t dex_pc, int32_t dex_pc_offset)
Mathieu Chartier90443472015-07-16 20:32:27 -0700235 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Nicolas Geoffray81f0f952016-01-20 16:25:19 +0000236 LOG(ERROR) << "Unexpected branch event in debugger " << PrettyMethod(method)
237 << " " << dex_pc << ", " << dex_pc_offset;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800238 }
239
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100240 // We only care about invokes in the Jit.
241 void InvokeVirtualOrInterface(Thread* thread ATTRIBUTE_UNUSED,
242 mirror::Object*,
243 ArtMethod* method,
244 uint32_t dex_pc,
245 ArtMethod*)
246 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
247 LOG(ERROR) << "Unexpected invoke event in debugger " << PrettyMethod(method)
248 << " " << dex_pc;
249 }
250
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200251 private:
Mathieu Chartiere401d142015-04-22 13:56:20 -0700252 static bool IsReturn(ArtMethod* method, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700253 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200254 const DexFile::CodeItem* code_item = method->GetCodeItem();
255 const Instruction* instruction = Instruction::At(&code_item->insns_[dex_pc]);
256 return instruction->IsReturn();
257 }
258
Mathieu Chartier90443472015-07-16 20:32:27 -0700259 static bool IsListeningToDexPcMoved() SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200260 return IsListeningTo(instrumentation::Instrumentation::kDexPcMoved);
261 }
262
Mathieu Chartier90443472015-07-16 20:32:27 -0700263 static bool IsListeningToMethodExit() SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200264 return IsListeningTo(instrumentation::Instrumentation::kMethodExited);
265 }
266
267 static bool IsListeningTo(instrumentation::Instrumentation::InstrumentationEvent event)
Mathieu Chartier90443472015-07-16 20:32:27 -0700268 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200269 return (Dbg::GetInstrumentationEvents() & event) != 0;
270 }
271
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200272 DISALLOW_COPY_AND_ASSIGN(DebugInstrumentationListener);
Ian Rogers62d6c772013-02-27 08:32:07 -0800273} gDebugInstrumentationListener;
274
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700275// JDWP is allowed unless the Zygote forbids it.
276static bool gJdwpAllowed = true;
277
Elliott Hughesc0f09332012-03-26 13:27:06 -0700278// Was there a -Xrunjdwp or -agentlib:jdwp= argument on the command line?
Elliott Hughes3bb81562011-10-21 18:52:59 -0700279static bool gJdwpConfigured = false;
280
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100281// JDWP options for debugging. Only valid if IsJdwpConfigured() is true.
282static JDWP::JdwpOptions gJdwpOptions;
283
Elliott Hughes3bb81562011-10-21 18:52:59 -0700284// Runtime JDWP state.
Ian Rogersc0542af2014-09-03 16:16:56 -0700285static JDWP::JdwpState* gJdwpState = nullptr;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700286static bool gDebuggerConnected; // debugger or DDMS is connected.
Elliott Hughes3bb81562011-10-21 18:52:59 -0700287
Elliott Hughes47fce012011-10-25 18:37:19 -0700288static bool gDdmThreadNotification = false;
289
Elliott Hughes767a1472011-10-26 18:49:02 -0700290// DDMS GC-related settings.
291static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
292static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
293static Dbg::HpsgWhat gDdmHpsgWhat;
294static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
295static Dbg::HpsgWhat gDdmNhsgWhat;
296
Daniel Mihalyieb076692014-08-22 17:33:31 +0200297bool Dbg::gDebuggerActive = false;
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100298bool Dbg::gDisposed = false;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200299ObjectRegistry* Dbg::gRegistry = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700300
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100301// Deoptimization support.
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100302std::vector<DeoptimizationRequest> Dbg::deoptimization_requests_;
303size_t Dbg::full_deoptimization_event_count_ = 0;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100304
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200305// Instrumentation event reference counters.
306size_t Dbg::dex_pc_change_event_ref_count_ = 0;
307size_t Dbg::method_enter_event_ref_count_ = 0;
308size_t Dbg::method_exit_event_ref_count_ = 0;
309size_t Dbg::field_read_event_ref_count_ = 0;
310size_t Dbg::field_write_event_ref_count_ = 0;
311size_t Dbg::exception_catch_event_ref_count_ = 0;
312uint32_t Dbg::instrumentation_events_ = 0;
313
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100314// Breakpoints.
jeffhao09bfc6a2012-12-11 18:11:43 -0800315static std::vector<Breakpoint> gBreakpoints GUARDED_BY(Locks::breakpoint_lock_);
Elliott Hughes86964332012-02-15 19:37:42 -0800316
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -0700317void DebugInvokeReq::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
318 receiver.VisitRootIfNonNull(visitor, root_info); // null for static method call.
319 klass.VisitRoot(visitor, root_info);
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -0700320}
321
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100322void SingleStepControl::AddDexPc(uint32_t dex_pc) {
323 dex_pcs_.insert(dex_pc);
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200324}
325
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100326bool SingleStepControl::ContainsDexPc(uint32_t dex_pc) const {
327 return dex_pcs_.find(dex_pc) == dex_pcs_.end();
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200328}
329
Alex Light6c8467f2015-11-20 15:03:26 -0800330static bool IsBreakpoint(ArtMethod* m, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700331 REQUIRES(!Locks::breakpoint_lock_)
332 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzed2be172014-08-19 15:33:43 +0200333 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100334 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Alex Light6c8467f2015-11-20 15:03:26 -0800335 if (gBreakpoints[i].DexPc() == dex_pc && gBreakpoints[i].IsInMethod(m)) {
Elliott Hughes86964332012-02-15 19:37:42 -0800336 VLOG(jdwp) << "Hit breakpoint #" << i << ": " << gBreakpoints[i];
337 return true;
338 }
339 }
340 return false;
341}
342
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100343static bool IsSuspendedForDebugger(ScopedObjectAccessUnchecked& soa, Thread* thread)
Mathieu Chartier90443472015-07-16 20:32:27 -0700344 REQUIRES(!Locks::thread_suspend_count_lock_) {
Elliott Hughes9e0c1752013-01-09 14:02:58 -0800345 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
346 // A thread may be suspended for GC; in this code, we really want to know whether
347 // there's a debugger suspension active.
348 return thread->IsSuspended() && thread->GetDebugSuspendCount() > 0;
349}
350
Ian Rogersc0542af2014-09-03 16:16:56 -0700351static mirror::Array* DecodeNonNullArray(JDWP::RefTypeId id, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -0700352 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200353 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700354 if (o == nullptr) {
355 *error = JDWP::ERR_INVALID_OBJECT;
356 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800357 }
358 if (!o->IsArrayInstance()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700359 *error = JDWP::ERR_INVALID_ARRAY;
360 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800361 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700362 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800363 return o->AsArray();
364}
365
Ian Rogersc0542af2014-09-03 16:16:56 -0700366static mirror::Class* DecodeClass(JDWP::RefTypeId id, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -0700367 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200368 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700369 if (o == nullptr) {
370 *error = JDWP::ERR_INVALID_OBJECT;
371 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800372 }
373 if (!o->IsClass()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700374 *error = JDWP::ERR_INVALID_CLASS;
375 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800376 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700377 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800378 return o->AsClass();
379}
380
Ian Rogersc0542af2014-09-03 16:16:56 -0700381static Thread* DecodeThread(ScopedObjectAccessUnchecked& soa, JDWP::ObjectId thread_id,
382 JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -0700383 SHARED_REQUIRES(Locks::mutator_lock_)
384 REQUIRES(!Locks::thread_list_lock_, !Locks::thread_suspend_count_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200385 mirror::Object* thread_peer = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700386 if (thread_peer == nullptr) {
Elliott Hughes221229c2013-01-08 18:17:50 -0800387 // This isn't even an object.
Ian Rogersc0542af2014-09-03 16:16:56 -0700388 *error = JDWP::ERR_INVALID_OBJECT;
389 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800390 }
Elliott Hughes221229c2013-01-08 18:17:50 -0800391
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800392 mirror::Class* java_lang_Thread = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
Elliott Hughes221229c2013-01-08 18:17:50 -0800393 if (!java_lang_Thread->IsAssignableFrom(thread_peer->GetClass())) {
394 // This isn't a thread.
Ian Rogersc0542af2014-09-03 16:16:56 -0700395 *error = JDWP::ERR_INVALID_THREAD;
396 return nullptr;
Elliott Hughes221229c2013-01-08 18:17:50 -0800397 }
398
Sebastien Hertz69206392015-04-07 15:54:25 +0200399 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
Ian Rogersc0542af2014-09-03 16:16:56 -0700400 Thread* thread = Thread::FromManagedThread(soa, thread_peer);
401 // If thread is null then this a java.lang.Thread without a Thread*. Must be a un-started or a
402 // zombie.
403 *error = (thread == nullptr) ? JDWP::ERR_THREAD_NOT_ALIVE : JDWP::ERR_NONE;
404 return thread;
Elliott Hughes436e3722012-02-17 20:01:47 -0800405}
406
Elliott Hughes24437992011-11-30 14:49:33 -0800407static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
408 // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
409 // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
410 return static_cast<JDWP::JdwpTag>(descriptor[0]);
411}
412
Ian Rogers1ff3c982014-08-12 02:30:58 -0700413static JDWP::JdwpTag BasicTagFromClass(mirror::Class* klass)
Mathieu Chartier90443472015-07-16 20:32:27 -0700414 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers1ff3c982014-08-12 02:30:58 -0700415 std::string temp;
416 const char* descriptor = klass->GetDescriptor(&temp);
417 return BasicTagFromDescriptor(descriptor);
418}
419
Ian Rogers98379392014-02-24 16:53:16 -0800420static JDWP::JdwpTag TagFromClass(const ScopedObjectAccessUnchecked& soa, mirror::Class* c)
Mathieu Chartier90443472015-07-16 20:32:27 -0700421 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700422 CHECK(c != nullptr);
Elliott Hughes24437992011-11-30 14:49:33 -0800423 if (c->IsArrayClass()) {
424 return JDWP::JT_ARRAY;
425 }
Elliott Hughes24437992011-11-30 14:49:33 -0800426 if (c->IsStringClass()) {
427 return JDWP::JT_STRING;
Elliott Hughes24437992011-11-30 14:49:33 -0800428 }
Ian Rogers98379392014-02-24 16:53:16 -0800429 if (c->IsClassClass()) {
430 return JDWP::JT_CLASS_OBJECT;
431 }
432 {
433 mirror::Class* thread_class = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
434 if (thread_class->IsAssignableFrom(c)) {
435 return JDWP::JT_THREAD;
436 }
437 }
438 {
439 mirror::Class* thread_group_class =
440 soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
441 if (thread_group_class->IsAssignableFrom(c)) {
442 return JDWP::JT_THREAD_GROUP;
443 }
444 }
445 {
446 mirror::Class* class_loader_class =
447 soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ClassLoader);
448 if (class_loader_class->IsAssignableFrom(c)) {
449 return JDWP::JT_CLASS_LOADER;
450 }
451 }
452 return JDWP::JT_OBJECT;
Elliott Hughes24437992011-11-30 14:49:33 -0800453}
454
455/*
456 * Objects declared to hold Object might actually hold a more specific
457 * type. The debugger may take a special interest in these (e.g. it
458 * wants to display the contents of Strings), so we want to return an
459 * appropriate tag.
460 *
461 * Null objects are tagged JT_OBJECT.
462 */
Sebastien Hertz6995c602014-09-09 12:10:13 +0200463JDWP::JdwpTag Dbg::TagFromObject(const ScopedObjectAccessUnchecked& soa, mirror::Object* o) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700464 return (o == nullptr) ? JDWP::JT_OBJECT : TagFromClass(soa, o->GetClass());
Elliott Hughes24437992011-11-30 14:49:33 -0800465}
466
467static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
468 switch (tag) {
469 case JDWP::JT_BOOLEAN:
470 case JDWP::JT_BYTE:
471 case JDWP::JT_CHAR:
472 case JDWP::JT_FLOAT:
473 case JDWP::JT_DOUBLE:
474 case JDWP::JT_INT:
475 case JDWP::JT_LONG:
476 case JDWP::JT_SHORT:
477 case JDWP::JT_VOID:
478 return true;
479 default:
480 return false;
481 }
482}
483
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100484void Dbg::StartJdwp() {
Elliott Hughesc0f09332012-03-26 13:27:06 -0700485 if (!gJdwpAllowed || !IsJdwpConfigured()) {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700486 // No JDWP for you!
487 return;
488 }
489
Ian Rogers719d1a32014-03-06 12:13:39 -0800490 CHECK(gRegistry == nullptr);
Elliott Hughes475fc232011-10-25 15:00:35 -0700491 gRegistry = new ObjectRegistry;
492
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700493 // Init JDWP if the debugger is enabled. This may connect out to a
494 // debugger, passively listen for a debugger, or block waiting for a
495 // debugger.
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100496 gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
Ian Rogersc0542af2014-09-03 16:16:56 -0700497 if (gJdwpState == nullptr) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -0800498 // We probably failed because some other process has the port already, which means that
499 // if we don't abort the user is likely to think they're talking to us when they're actually
500 // talking to that other process.
Elliott Hughes3d30d9b2011-12-07 17:35:48 -0800501 LOG(FATAL) << "Debugger thread failed to initialize";
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700502 }
503
504 // If a debugger has already attached, send the "welcome" message.
505 // This may cause us to suspend all threads.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700506 if (gJdwpState->IsActive()) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700507 ScopedObjectAccess soa(Thread::Current());
Sebastien Hertz7d955652014-10-22 10:57:10 +0200508 gJdwpState->PostVMStart();
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700509 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700510}
511
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700512void Dbg::StopJdwp() {
Sebastien Hertzc6345ef2014-08-18 19:26:39 +0200513 // Post VM_DEATH event before the JDWP connection is closed (either by the JDWP thread or the
514 // destruction of gJdwpState).
515 if (gJdwpState != nullptr && gJdwpState->IsActive()) {
516 gJdwpState->PostVMDeath();
517 }
Sebastien Hertz0376e6b2014-02-06 18:12:59 +0100518 // Prevent the JDWP thread from processing JDWP incoming packets after we close the connection.
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100519 Dispose();
Elliott Hughes376a7a02011-10-24 18:35:55 -0700520 delete gJdwpState;
Ian Rogers719d1a32014-03-06 12:13:39 -0800521 gJdwpState = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700522 delete gRegistry;
Ian Rogers719d1a32014-03-06 12:13:39 -0800523 gRegistry = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700524}
525
Elliott Hughes767a1472011-10-26 18:49:02 -0700526void Dbg::GcDidFinish() {
527 if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700528 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700529 VLOG(jdwp) << "Sending heap info to DDM";
Elliott Hughes7162ad92011-10-27 14:08:42 -0700530 DdmSendHeapInfo(gDdmHpifWhen);
Elliott Hughes767a1472011-10-26 18:49:02 -0700531 }
532 if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700533 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700534 VLOG(jdwp) << "Dumping heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700535 DdmSendHeapSegments(false);
Elliott Hughes767a1472011-10-26 18:49:02 -0700536 }
537 if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700538 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700539 VLOG(jdwp) << "Dumping native heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700540 DdmSendHeapSegments(true);
Elliott Hughes767a1472011-10-26 18:49:02 -0700541 }
542}
543
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700544void Dbg::SetJdwpAllowed(bool allowed) {
545 gJdwpAllowed = allowed;
546}
547
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700548DebugInvokeReq* Dbg::GetInvokeReq() {
Elliott Hughes475fc232011-10-25 15:00:35 -0700549 return Thread::Current()->GetInvokeReq();
550}
551
552Thread* Dbg::GetDebugThread() {
Ian Rogersc0542af2014-09-03 16:16:56 -0700553 return (gJdwpState != nullptr) ? gJdwpState->GetDebugThread() : nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700554}
555
556void Dbg::ClearWaitForEventThread() {
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100557 gJdwpState->ReleaseJdwpTokenForEvent();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700558}
559
560void Dbg::Connected() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700561 CHECK(!gDebuggerConnected);
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -0800562 VLOG(jdwp) << "JDWP has attached";
Elliott Hughes3bb81562011-10-21 18:52:59 -0700563 gDebuggerConnected = true;
Elliott Hughes86964332012-02-15 19:37:42 -0800564 gDisposed = false;
565}
566
Sebastien Hertzf3928792014-11-17 19:00:37 +0100567bool Dbg::RequiresDeoptimization() {
568 // We don't need deoptimization if everything runs with interpreter after
569 // enabling -Xint mode.
570 return !Runtime::Current()->GetInstrumentation()->IsForcedInterpretOnly();
571}
572
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -0800573// Used to patch boot image method entry point to interpreter bridge.
574class UpdateEntryPointsClassVisitor : public ClassVisitor {
575 public:
576 explicit UpdateEntryPointsClassVisitor(instrumentation::Instrumentation* instrumentation)
577 : instrumentation_(instrumentation) {}
578
579 bool operator()(mirror::Class* klass) OVERRIDE REQUIRES(Locks::mutator_lock_) {
580 auto pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
581 for (auto& m : klass->GetMethods(pointer_size)) {
582 const void* code = m.GetEntryPointFromQuickCompiledCode();
583 if (Runtime::Current()->GetHeap()->IsInBootImageOatFile(code) &&
584 !m.IsNative() &&
585 !m.IsProxyMethod()) {
Mingyao Yang3fd448a2016-05-10 14:30:41 -0700586 instrumentation_->UpdateMethodsCodeFromDebugger(&m, GetQuickToInterpreterBridge());
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -0800587 }
588 }
589 return true;
590 }
591
592 private:
593 instrumentation::Instrumentation* const instrumentation_;
594};
595
Elliott Hughesa2155262011-11-16 16:26:58 -0800596void Dbg::GoActive() {
597 // Enable all debugging features, including scans for breakpoints.
598 // This is a no-op if we're already active.
599 // Only called from the JDWP handler thread.
Daniel Mihalyieb076692014-08-22 17:33:31 +0200600 if (IsDebuggerActive()) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800601 return;
602 }
603
Mathieu Chartieraa516822015-10-02 15:53:37 -0700604 Thread* const self = Thread::Current();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700605 {
606 // TODO: dalvik only warned if there were breakpoints left over. clear in Dbg::Disconnected?
Mathieu Chartieraa516822015-10-02 15:53:37 -0700607 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700608 CHECK_EQ(gBreakpoints.size(), 0U);
609 }
Elliott Hughesa2155262011-11-16 16:26:58 -0800610
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100611 {
Mathieu Chartieraa516822015-10-02 15:53:37 -0700612 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100613 CHECK_EQ(deoptimization_requests_.size(), 0U);
614 CHECK_EQ(full_deoptimization_event_count_, 0U);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200615 CHECK_EQ(dex_pc_change_event_ref_count_, 0U);
616 CHECK_EQ(method_enter_event_ref_count_, 0U);
617 CHECK_EQ(method_exit_event_ref_count_, 0U);
618 CHECK_EQ(field_read_event_ref_count_, 0U);
619 CHECK_EQ(field_write_event_ref_count_, 0U);
620 CHECK_EQ(exception_catch_event_ref_count_, 0U);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100621 }
622
Ian Rogers62d6c772013-02-27 08:32:07 -0800623 Runtime* runtime = Runtime::Current();
David Srbeckyf4480162016-03-16 00:06:24 +0000624 // Since boot image code may be AOT compiled as not debuggable, we need to patch
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -0800625 // entry points of methods in boot image to interpreter bridge.
David Srbeckyf4480162016-03-16 00:06:24 +0000626 // However, the performance cost of this is non-negligible during native-debugging due to the
627 // forced JIT, so we keep the AOT code in that case in exchange for limited native debugging.
628 if (!runtime->GetInstrumentation()->IsForcedInterpretOnly() && !runtime->IsNativeDebuggable()) {
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -0800629 ScopedObjectAccess soa(self);
630 UpdateEntryPointsClassVisitor visitor(runtime->GetInstrumentation());
631 runtime->GetClassLinker()->VisitClasses(&visitor);
632 }
633
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700634 ScopedSuspendAll ssa(__FUNCTION__);
Sebastien Hertzf3928792014-11-17 19:00:37 +0100635 if (RequiresDeoptimization()) {
636 runtime->GetInstrumentation()->EnableDeoptimization();
637 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200638 instrumentation_events_ = 0;
Elliott Hughesa2155262011-11-16 16:26:58 -0800639 gDebuggerActive = true;
Ian Rogers62d6c772013-02-27 08:32:07 -0800640 LOG(INFO) << "Debugger is active";
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700641}
642
643void Dbg::Disconnected() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700644 CHECK(gDebuggerConnected);
645
Elliott Hughesc0f09332012-03-26 13:27:06 -0700646 LOG(INFO) << "Debugger is no longer active";
Elliott Hughes234ab152011-10-26 14:02:26 -0700647
Hiroshi Yamauchi98810e32016-05-24 14:55:40 -0700648 // Suspend all threads and exclusively acquire the mutator lock. Remove the debugger as a listener
Ian Rogers62d6c772013-02-27 08:32:07 -0800649 // and clear the object registry.
650 Runtime* runtime = Runtime::Current();
Ian Rogers62d6c772013-02-27 08:32:07 -0800651 Thread* self = Thread::Current();
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700652 {
Mathieu Chartieraa516822015-10-02 15:53:37 -0700653 // Required for DisableDeoptimization.
654 gc::ScopedGCCriticalSection gcs(self,
655 gc::kGcCauseInstrumentation,
656 gc::kCollectorTypeInstrumentation);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700657 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700658 // Debugger may not be active at this point.
659 if (IsDebuggerActive()) {
660 {
661 // Since we're going to disable deoptimization, we clear the deoptimization requests queue.
662 // This prevents us from having any pending deoptimization request when the debugger attaches
663 // to us again while no event has been requested yet.
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -0700664 MutexLock mu(self, *Locks::deoptimization_lock_);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700665 deoptimization_requests_.clear();
666 full_deoptimization_event_count_ = 0U;
667 }
668 if (instrumentation_events_ != 0) {
669 runtime->GetInstrumentation()->RemoveListener(&gDebugInstrumentationListener,
670 instrumentation_events_);
671 instrumentation_events_ = 0;
672 }
673 if (RequiresDeoptimization()) {
674 runtime->GetInstrumentation()->DisableDeoptimization(kDbgInstrumentationKey);
675 }
676 gDebuggerActive = false;
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100677 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100678 }
Sebastien Hertz55f65342015-01-13 22:48:34 +0100679
680 {
681 ScopedObjectAccess soa(self);
682 gRegistry->Clear();
683 }
684
685 gDebuggerConnected = false;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700686}
687
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100688void Dbg::ConfigureJdwp(const JDWP::JdwpOptions& jdwp_options) {
689 CHECK_NE(jdwp_options.transport, JDWP::kJdwpTransportUnknown);
690 gJdwpOptions = jdwp_options;
691 gJdwpConfigured = true;
692}
693
Elliott Hughesc0f09332012-03-26 13:27:06 -0700694bool Dbg::IsJdwpConfigured() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700695 return gJdwpConfigured;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700696}
697
698int64_t Dbg::LastDebuggerActivity() {
Elliott Hughesca951522011-12-05 12:01:32 -0800699 return gJdwpState->LastDebuggerActivity();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700700}
701
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700702void Dbg::UndoDebuggerSuspensions() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700703 Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700704}
705
Elliott Hughes88d63092013-01-09 09:55:54 -0800706std::string Dbg::GetClassName(JDWP::RefTypeId class_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700707 JDWP::JdwpError error;
708 mirror::Object* o = gRegistry->Get<mirror::Object*>(class_id, &error);
709 if (o == nullptr) {
710 if (error == JDWP::ERR_NONE) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700711 return "null";
Ian Rogersc0542af2014-09-03 16:16:56 -0700712 } else {
713 return StringPrintf("invalid object %p", reinterpret_cast<void*>(class_id));
714 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800715 }
716 if (!o->IsClass()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700717 return StringPrintf("non-class %p", o); // This is only used for debugging output anyway.
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800718 }
Sebastien Hertz6995c602014-09-09 12:10:13 +0200719 return GetClassName(o->AsClass());
720}
721
722std::string Dbg::GetClassName(mirror::Class* klass) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200723 if (klass == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700724 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200725 }
Ian Rogers1ff3c982014-08-12 02:30:58 -0700726 std::string temp;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200727 return DescriptorToName(klass->GetDescriptor(&temp));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700728}
729
Ian Rogersc0542af2014-09-03 16:16:56 -0700730JDWP::JdwpError Dbg::GetClassObject(JDWP::RefTypeId id, JDWP::ObjectId* class_object_id) {
Elliott Hughes436e3722012-02-17 20:01:47 -0800731 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700732 mirror::Class* c = DecodeClass(id, &status);
733 if (c == nullptr) {
734 *class_object_id = 0;
Elliott Hughes436e3722012-02-17 20:01:47 -0800735 return status;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800736 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700737 *class_object_id = gRegistry->Add(c);
Elliott Hughes436e3722012-02-17 20:01:47 -0800738 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -0800739}
740
Ian Rogersc0542af2014-09-03 16:16:56 -0700741JDWP::JdwpError Dbg::GetSuperclass(JDWP::RefTypeId id, JDWP::RefTypeId* superclass_id) {
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800742 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700743 mirror::Class* c = DecodeClass(id, &status);
744 if (c == nullptr) {
745 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800746 return status;
747 }
748 if (c->IsInterface()) {
749 // http://code.google.com/p/android/issues/detail?id=20856
Ian Rogersc0542af2014-09-03 16:16:56 -0700750 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800751 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700752 *superclass_id = gRegistry->Add(c->GetSuperClass());
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800753 }
754 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700755}
756
Elliott Hughes436e3722012-02-17 20:01:47 -0800757JDWP::JdwpError Dbg::GetClassLoader(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700758 JDWP::JdwpError error;
Andreas Gampe7929a482015-12-30 19:33:49 -0800759 mirror::Class* c = DecodeClass(id, &error);
760 if (c == nullptr) {
761 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -0800762 }
Andreas Gampe7929a482015-12-30 19:33:49 -0800763 expandBufAddObjectId(pReply, gRegistry->Add(c->GetClassLoader()));
Elliott Hughes436e3722012-02-17 20:01:47 -0800764 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700765}
766
Elliott Hughes436e3722012-02-17 20:01:47 -0800767JDWP::JdwpError Dbg::GetModifiers(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700768 JDWP::JdwpError error;
769 mirror::Class* c = DecodeClass(id, &error);
770 if (c == nullptr) {
771 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800772 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800773
774 uint32_t access_flags = c->GetAccessFlags() & kAccJavaFlagsMask;
775
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700776 // Set ACC_SUPER. Dex files don't contain this flag but only classes are supposed to have it set,
777 // not interfaces.
Elliott Hughes436e3722012-02-17 20:01:47 -0800778 // Class.getModifiers doesn't return it, but JDWP does, so we set it here.
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700779 if ((access_flags & kAccInterface) == 0) {
780 access_flags |= kAccSuper;
781 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800782
783 expandBufAdd4BE(pReply, access_flags);
784
785 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700786}
787
Ian Rogersc0542af2014-09-03 16:16:56 -0700788JDWP::JdwpError Dbg::GetMonitorInfo(JDWP::ObjectId object_id, JDWP::ExpandBuf* reply) {
789 JDWP::JdwpError error;
790 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
791 if (o == nullptr) {
Elliott Hughesf327e072013-01-09 16:01:26 -0800792 return JDWP::ERR_INVALID_OBJECT;
793 }
794
795 // Ensure all threads are suspended while we read objects' lock words.
796 Thread* self = Thread::Current();
Sebastien Hertz54263242014-03-19 18:16:50 +0100797 CHECK_EQ(self->GetState(), kRunnable);
Elliott Hughesf327e072013-01-09 16:01:26 -0800798
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700799 MonitorInfo monitor_info;
800 {
801 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700802 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700803 monitor_info = MonitorInfo(o);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700804 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700805 if (monitor_info.owner_ != nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700806 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.owner_->GetPeer()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800807 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700808 expandBufAddObjectId(reply, gRegistry->Add(nullptr));
Elliott Hughesf327e072013-01-09 16:01:26 -0800809 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700810 expandBufAdd4BE(reply, monitor_info.entry_count_);
811 expandBufAdd4BE(reply, monitor_info.waiters_.size());
812 for (size_t i = 0; i < monitor_info.waiters_.size(); ++i) {
813 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.waiters_[i]->GetPeer()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800814 }
815 return JDWP::ERR_NONE;
816}
817
Elliott Hughes734b8c62013-01-11 15:32:45 -0800818JDWP::JdwpError Dbg::GetOwnedMonitors(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700819 std::vector<JDWP::ObjectId>* monitors,
820 std::vector<uint32_t>* stack_depths) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800821 struct OwnedMonitorVisitor : public StackVisitor {
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700822 OwnedMonitorVisitor(Thread* thread, Context* context,
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700823 std::vector<JDWP::ObjectId>* monitor_vector,
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700824 std::vector<uint32_t>* stack_depth_vector)
Mathieu Chartier90443472015-07-16 20:32:27 -0700825 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +0100826 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
827 current_stack_depth(0),
828 monitors(monitor_vector),
829 stack_depths(stack_depth_vector) {}
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800830
831 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
832 // annotalysis.
833 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
834 if (!GetMethod()->IsRuntimeMethod()) {
835 Monitor::VisitLocks(this, AppendOwnedMonitors, this);
Elliott Hughes734b8c62013-01-11 15:32:45 -0800836 ++current_stack_depth;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800837 }
838 return true;
839 }
840
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700841 static void AppendOwnedMonitors(mirror::Object* owned_monitor, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -0700842 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers7a22fa62013-01-23 12:16:16 -0800843 OwnedMonitorVisitor* visitor = reinterpret_cast<OwnedMonitorVisitor*>(arg);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700844 visitor->monitors->push_back(gRegistry->Add(owned_monitor));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700845 visitor->stack_depths->push_back(visitor->current_stack_depth);
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800846 }
847
Elliott Hughes734b8c62013-01-11 15:32:45 -0800848 size_t current_stack_depth;
Ian Rogersc0542af2014-09-03 16:16:56 -0700849 std::vector<JDWP::ObjectId>* const monitors;
850 std::vector<uint32_t>* const stack_depths;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800851 };
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800852
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700853 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +0200854 JDWP::JdwpError error;
855 Thread* thread = DecodeThread(soa, thread_id, &error);
856 if (thread == nullptr) {
857 return error;
858 }
859 if (!IsSuspendedForDebugger(soa, thread)) {
860 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700861 }
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700862 std::unique_ptr<Context> context(Context::Create());
Ian Rogersc0542af2014-09-03 16:16:56 -0700863 OwnedMonitorVisitor visitor(thread, context.get(), monitors, stack_depths);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700864 visitor.WalkStack();
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800865 return JDWP::ERR_NONE;
866}
867
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100868JDWP::JdwpError Dbg::GetContendedMonitor(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700869 JDWP::ObjectId* contended_monitor) {
Elliott Hughesf9501702013-01-11 11:22:27 -0800870 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -0700871 *contended_monitor = 0;
Sebastien Hertz69206392015-04-07 15:54:25 +0200872 JDWP::JdwpError error;
873 Thread* thread = DecodeThread(soa, thread_id, &error);
874 if (thread == nullptr) {
875 return error;
Elliott Hughesf9501702013-01-11 11:22:27 -0800876 }
Sebastien Hertz69206392015-04-07 15:54:25 +0200877 if (!IsSuspendedForDebugger(soa, thread)) {
878 return JDWP::ERR_THREAD_NOT_SUSPENDED;
879 }
880 mirror::Object* contended_monitor_obj = Monitor::GetContendedMonitor(thread);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700881 // Add() requires the thread_list_lock_ not held to avoid the lock
882 // level violation.
Ian Rogersc0542af2014-09-03 16:16:56 -0700883 *contended_monitor = gRegistry->Add(contended_monitor_obj);
Elliott Hughesf9501702013-01-11 11:22:27 -0800884 return JDWP::ERR_NONE;
885}
886
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800887JDWP::JdwpError Dbg::GetInstanceCounts(const std::vector<JDWP::RefTypeId>& class_ids,
Ian Rogersc0542af2014-09-03 16:16:56 -0700888 std::vector<uint64_t>* counts) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800889 gc::Heap* heap = Runtime::Current()->GetHeap();
890 heap->CollectGarbage(false);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800891 std::vector<mirror::Class*> classes;
Ian Rogersc0542af2014-09-03 16:16:56 -0700892 counts->clear();
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800893 for (size_t i = 0; i < class_ids.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700894 JDWP::JdwpError error;
895 mirror::Class* c = DecodeClass(class_ids[i], &error);
896 if (c == nullptr) {
897 return error;
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800898 }
899 classes.push_back(c);
Ian Rogersc0542af2014-09-03 16:16:56 -0700900 counts->push_back(0);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800901 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700902 heap->CountInstances(classes, false, &(*counts)[0]);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800903 return JDWP::ERR_NONE;
904}
905
Ian Rogersc0542af2014-09-03 16:16:56 -0700906JDWP::JdwpError Dbg::GetInstances(JDWP::RefTypeId class_id, int32_t max_count,
907 std::vector<JDWP::ObjectId>* instances) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800908 gc::Heap* heap = Runtime::Current()->GetHeap();
909 // We only want reachable instances, so do a GC.
910 heap->CollectGarbage(false);
Ian Rogersc0542af2014-09-03 16:16:56 -0700911 JDWP::JdwpError error;
912 mirror::Class* c = DecodeClass(class_id, &error);
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800913 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700914 return error;
Elliott Hughes3b78c942013-01-15 17:35:41 -0800915 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800916 std::vector<mirror::Object*> raw_instances;
Elliott Hughes3b78c942013-01-15 17:35:41 -0800917 Runtime::Current()->GetHeap()->GetInstances(c, max_count, raw_instances);
918 for (size_t i = 0; i < raw_instances.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700919 instances->push_back(gRegistry->Add(raw_instances[i]));
Elliott Hughes3b78c942013-01-15 17:35:41 -0800920 }
921 return JDWP::ERR_NONE;
922}
923
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800924JDWP::JdwpError Dbg::GetReferringObjects(JDWP::ObjectId object_id, int32_t max_count,
Ian Rogersc0542af2014-09-03 16:16:56 -0700925 std::vector<JDWP::ObjectId>* referring_objects) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800926 gc::Heap* heap = Runtime::Current()->GetHeap();
927 heap->CollectGarbage(false);
Ian Rogersc0542af2014-09-03 16:16:56 -0700928 JDWP::JdwpError error;
929 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
930 if (o == nullptr) {
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800931 return JDWP::ERR_INVALID_OBJECT;
932 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800933 std::vector<mirror::Object*> raw_instances;
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800934 heap->GetReferringObjects(o, max_count, raw_instances);
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800935 for (size_t i = 0; i < raw_instances.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700936 referring_objects->push_back(gRegistry->Add(raw_instances[i]));
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800937 }
938 return JDWP::ERR_NONE;
939}
940
Ian Rogersc0542af2014-09-03 16:16:56 -0700941JDWP::JdwpError Dbg::DisableCollection(JDWP::ObjectId object_id) {
942 JDWP::JdwpError error;
943 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
944 if (o == nullptr) {
Sebastien Hertze96060a2013-12-11 12:06:28 +0100945 return JDWP::ERR_INVALID_OBJECT;
946 }
Elliott Hughes64f574f2013-02-20 14:57:12 -0800947 gRegistry->DisableCollection(object_id);
948 return JDWP::ERR_NONE;
949}
950
Ian Rogersc0542af2014-09-03 16:16:56 -0700951JDWP::JdwpError Dbg::EnableCollection(JDWP::ObjectId object_id) {
952 JDWP::JdwpError error;
953 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
Sebastien Hertze96060a2013-12-11 12:06:28 +0100954 // Unlike DisableCollection, JDWP specs do not state an invalid object causes an error. The RI
955 // also ignores these cases and never return an error. However it's not obvious why this command
956 // should behave differently from DisableCollection and IsCollected commands. So let's be more
957 // strict and return an error if this happens.
Ian Rogersc0542af2014-09-03 16:16:56 -0700958 if (o == nullptr) {
Sebastien Hertze96060a2013-12-11 12:06:28 +0100959 return JDWP::ERR_INVALID_OBJECT;
960 }
Elliott Hughes64f574f2013-02-20 14:57:12 -0800961 gRegistry->EnableCollection(object_id);
962 return JDWP::ERR_NONE;
963}
964
Ian Rogersc0542af2014-09-03 16:16:56 -0700965JDWP::JdwpError Dbg::IsCollected(JDWP::ObjectId object_id, bool* is_collected) {
966 *is_collected = true;
Sebastien Hertz65637eb2014-01-10 17:40:02 +0100967 if (object_id == 0) {
968 // Null object id is invalid.
Sebastien Hertze96060a2013-12-11 12:06:28 +0100969 return JDWP::ERR_INVALID_OBJECT;
970 }
Sebastien Hertz65637eb2014-01-10 17:40:02 +0100971 // JDWP specs state an INVALID_OBJECT error is returned if the object ID is not valid. However
972 // the RI seems to ignore this and assume object has been collected.
Ian Rogersc0542af2014-09-03 16:16:56 -0700973 JDWP::JdwpError error;
974 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
975 if (o != nullptr) {
976 *is_collected = gRegistry->IsCollected(object_id);
Sebastien Hertz65637eb2014-01-10 17:40:02 +0100977 }
Elliott Hughes64f574f2013-02-20 14:57:12 -0800978 return JDWP::ERR_NONE;
979}
980
Ian Rogersc0542af2014-09-03 16:16:56 -0700981void Dbg::DisposeObject(JDWP::ObjectId object_id, uint32_t reference_count) {
Elliott Hughes64f574f2013-02-20 14:57:12 -0800982 gRegistry->DisposeObject(object_id, reference_count);
983}
984
Sebastien Hertz6995c602014-09-09 12:10:13 +0200985JDWP::JdwpTypeTag Dbg::GetTypeTag(mirror::Class* klass) {
Sebastien Hertz4d8fd492014-03-28 16:29:41 +0100986 DCHECK(klass != nullptr);
987 if (klass->IsArrayClass()) {
988 return JDWP::TT_ARRAY;
989 } else if (klass->IsInterface()) {
990 return JDWP::TT_INTERFACE;
991 } else {
992 return JDWP::TT_CLASS;
993 }
994}
995
Elliott Hughes88d63092013-01-09 09:55:54 -0800996JDWP::JdwpError Dbg::GetReflectedType(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700997 JDWP::JdwpError error;
998 mirror::Class* c = DecodeClass(class_id, &error);
999 if (c == nullptr) {
1000 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001001 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001002
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001003 JDWP::JdwpTypeTag type_tag = GetTypeTag(c);
1004 expandBufAdd1(pReply, type_tag);
Elliott Hughes88d63092013-01-09 09:55:54 -08001005 expandBufAddRefTypeId(pReply, class_id);
Elliott Hughes436e3722012-02-17 20:01:47 -08001006 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001007}
1008
Mathieu Chartiere0671ce2015-07-28 17:23:28 -07001009// Get the complete list of reference classes (i.e. all classes except
1010// the primitive types).
1011// Returns a newly-allocated buffer full of RefTypeId values.
1012class ClassListCreator : public ClassVisitor {
1013 public:
1014 explicit ClassListCreator(std::vector<JDWP::RefTypeId>* classes) : classes_(classes) {}
1015
Mathieu Chartier1aa8ec22016-02-01 10:34:47 -08001016 bool operator()(mirror::Class* c) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere0671ce2015-07-28 17:23:28 -07001017 if (!c->IsPrimitive()) {
1018 classes_->push_back(Dbg::GetObjectRegistry()->AddRefType(c));
1019 }
1020 return true;
1021 }
1022
1023 private:
1024 std::vector<JDWP::RefTypeId>* const classes_;
1025};
1026
Ian Rogersc0542af2014-09-03 16:16:56 -07001027void Dbg::GetClassList(std::vector<JDWP::RefTypeId>* classes) {
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001028 ClassListCreator clc(classes);
Mathieu Chartiere0671ce2015-07-28 17:23:28 -07001029 Runtime::Current()->GetClassLinker()->VisitClassesWithoutClassesLock(&clc);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001030}
1031
Ian Rogers1ff3c982014-08-12 02:30:58 -07001032JDWP::JdwpError Dbg::GetClassInfo(JDWP::RefTypeId class_id, JDWP::JdwpTypeTag* pTypeTag,
1033 uint32_t* pStatus, std::string* pDescriptor) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001034 JDWP::JdwpError error;
1035 mirror::Class* c = DecodeClass(class_id, &error);
1036 if (c == nullptr) {
1037 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001038 }
1039
Elliott Hughesa2155262011-11-16 16:26:58 -08001040 if (c->IsArrayClass()) {
1041 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
1042 *pTypeTag = JDWP::TT_ARRAY;
1043 } else {
1044 if (c->IsErroneous()) {
1045 *pStatus = JDWP::CS_ERROR;
1046 } else {
1047 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
1048 }
1049 *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
1050 }
1051
Ian Rogersc0542af2014-09-03 16:16:56 -07001052 if (pDescriptor != nullptr) {
Ian Rogers1ff3c982014-08-12 02:30:58 -07001053 std::string temp;
1054 *pDescriptor = c->GetDescriptor(&temp);
Elliott Hughesa2155262011-11-16 16:26:58 -08001055 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001056 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001057}
1058
Ian Rogersc0542af2014-09-03 16:16:56 -07001059void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>* ids) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001060 std::vector<mirror::Class*> classes;
Igor Murashkinb1d8c312015-08-04 11:18:43 -07001061 Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
Ian Rogersc0542af2014-09-03 16:16:56 -07001062 ids->clear();
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001063 for (size_t i = 0; i < classes.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001064 ids->push_back(gRegistry->Add(classes[i]));
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001065 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001066}
1067
Ian Rogersc0542af2014-09-03 16:16:56 -07001068JDWP::JdwpError Dbg::GetReferenceType(JDWP::ObjectId object_id, JDWP::ExpandBuf* pReply) {
1069 JDWP::JdwpError error;
1070 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1071 if (o == nullptr) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001072 return JDWP::ERR_INVALID_OBJECT;
Elliott Hughes499c5132011-11-17 14:55:11 -08001073 }
Elliott Hughes2435a572012-02-17 16:07:41 -08001074
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001075 JDWP::JdwpTypeTag type_tag = GetTypeTag(o->GetClass());
Elliott Hughes64f574f2013-02-20 14:57:12 -08001076 JDWP::RefTypeId type_id = gRegistry->AddRefType(o->GetClass());
Elliott Hughes2435a572012-02-17 16:07:41 -08001077
1078 expandBufAdd1(pReply, type_tag);
1079 expandBufAddRefTypeId(pReply, type_id);
1080
1081 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001082}
1083
Ian Rogersfc0e94b2013-09-23 23:51:32 -07001084JDWP::JdwpError Dbg::GetSignature(JDWP::RefTypeId class_id, std::string* signature) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001085 JDWP::JdwpError error;
1086 mirror::Class* c = DecodeClass(class_id, &error);
1087 if (c == nullptr) {
1088 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001089 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001090 std::string temp;
1091 *signature = c->GetDescriptor(&temp);
Elliott Hughes1fe7afb2012-02-13 17:23:03 -08001092 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001093}
1094
Ian Rogersc0542af2014-09-03 16:16:56 -07001095JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1096 JDWP::JdwpError error;
1097 mirror::Class* c = DecodeClass(class_id, &error);
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001098 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001099 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001100 }
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001101 const char* source_file = c->GetSourceFile();
1102 if (source_file == nullptr) {
Sebastien Hertzb7054ba2014-03-13 11:52:31 +01001103 return JDWP::ERR_ABSENT_INFORMATION;
1104 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001105 *result = source_file;
Elliott Hughes436e3722012-02-17 20:01:47 -08001106 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001107}
1108
Ian Rogersc0542af2014-09-03 16:16:56 -07001109JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
Ian Rogers98379392014-02-24 16:53:16 -08001110 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001111 JDWP::JdwpError error;
1112 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1113 if (error != JDWP::ERR_NONE) {
1114 *tag = JDWP::JT_VOID;
1115 return error;
Elliott Hughes546b9862012-06-20 16:06:13 -07001116 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001117 *tag = TagFromObject(soa, o);
Elliott Hughes546b9862012-06-20 16:06:13 -07001118 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001119}
1120
Elliott Hughesaed4be92011-12-02 16:16:23 -08001121size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001122 switch (tag) {
1123 case JDWP::JT_VOID:
1124 return 0;
1125 case JDWP::JT_BYTE:
1126 case JDWP::JT_BOOLEAN:
1127 return 1;
1128 case JDWP::JT_CHAR:
1129 case JDWP::JT_SHORT:
1130 return 2;
1131 case JDWP::JT_FLOAT:
1132 case JDWP::JT_INT:
1133 return 4;
1134 case JDWP::JT_ARRAY:
1135 case JDWP::JT_OBJECT:
1136 case JDWP::JT_STRING:
1137 case JDWP::JT_THREAD:
1138 case JDWP::JT_THREAD_GROUP:
1139 case JDWP::JT_CLASS_LOADER:
1140 case JDWP::JT_CLASS_OBJECT:
1141 return sizeof(JDWP::ObjectId);
1142 case JDWP::JT_DOUBLE:
1143 case JDWP::JT_LONG:
1144 return 8;
1145 default:
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08001146 LOG(FATAL) << "Unknown tag " << tag;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001147 return -1;
1148 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001149}
1150
Ian Rogersc0542af2014-09-03 16:16:56 -07001151JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1152 JDWP::JdwpError error;
1153 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1154 if (a == nullptr) {
1155 return error;
Elliott Hughes24437992011-11-30 14:49:33 -08001156 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001157 *length = a->GetLength();
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001158 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001159}
1160
Elliott Hughes88d63092013-01-09 09:55:54 -08001161JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001162 JDWP::JdwpError error;
1163 mirror::Array* a = DecodeNonNullArray(array_id, &error);
Ian Rogers98379392014-02-24 16:53:16 -08001164 if (a == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001165 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001166 }
Elliott Hughes24437992011-11-30 14:49:33 -08001167
1168 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1169 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001170 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughes24437992011-11-30 14:49:33 -08001171 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001172 JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1173 expandBufAdd1(pReply, element_tag);
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001174 expandBufAdd4BE(pReply, count);
1175
Ian Rogers1ff3c982014-08-12 02:30:58 -07001176 if (IsPrimitiveTag(element_tag)) {
1177 size_t width = GetTagWidth(element_tag);
Elliott Hughes24437992011-11-30 14:49:33 -08001178 uint8_t* dst = expandBufAddSpace(pReply, count * width);
1179 if (width == 8) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001180 const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001181 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1182 } else if (width == 4) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001183 const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001184 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1185 } else if (width == 2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001186 const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001187 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1188 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001189 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001190 memcpy(dst, &src[offset * width], count * width);
1191 }
1192 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001193 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001194 mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
Elliott Hughes24437992011-11-30 14:49:33 -08001195 for (int i = 0; i < count; ++i) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001196 mirror::Object* element = oa->Get(offset + i);
Ian Rogers98379392014-02-24 16:53:16 -08001197 JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
Ian Rogers1ff3c982014-08-12 02:30:58 -07001198 : element_tag;
Elliott Hughes24437992011-11-30 14:49:33 -08001199 expandBufAdd1(pReply, specific_tag);
1200 expandBufAddObjectId(pReply, gRegistry->Add(element));
1201 }
1202 }
1203
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001204 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001205}
1206
Ian Rogersef7d42f2014-01-06 12:55:46 -08001207template <typename T>
Ian Rogersc0542af2014-09-03 16:16:56 -07001208static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
Ian Rogersef7d42f2014-01-06 12:55:46 -08001209 NO_THREAD_SAFETY_ANALYSIS {
1210 // TODO: fix when annotalysis correctly handles non-member functions.
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001211 DCHECK(a->GetClass()->IsPrimitiveArray());
1212
Ian Rogersef7d42f2014-01-06 12:55:46 -08001213 T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001214 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001215 *dst++ = src->ReadValue(sizeof(T));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001216 }
1217}
1218
Elliott Hughes88d63092013-01-09 09:55:54 -08001219JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
Ian Rogersc0542af2014-09-03 16:16:56 -07001220 JDWP::Request* request) {
1221 JDWP::JdwpError error;
1222 mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1223 if (dst == nullptr) {
1224 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001225 }
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001226
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001227 if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001228 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001229 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001230 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001231 JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001232
Ian Rogers1ff3c982014-08-12 02:30:58 -07001233 if (IsPrimitiveTag(element_tag)) {
1234 size_t width = GetTagWidth(element_tag);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001235 if (width == 8) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001236 CopyArrayData<uint64_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001237 } else if (width == 4) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001238 CopyArrayData<uint32_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001239 } else if (width == 2) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001240 CopyArrayData<uint16_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001241 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001242 CopyArrayData<uint8_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001243 }
1244 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001245 mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001246 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001247 JDWP::ObjectId id = request->ReadObjectId();
Ian Rogersc0542af2014-09-03 16:16:56 -07001248 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1249 if (error != JDWP::ERR_NONE) {
1250 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -08001251 }
Sebastien Hertz2e1c16d2015-08-28 11:57:49 +02001252 // Check if the object's type is compatible with the array's type.
1253 if (o != nullptr && !o->InstanceOf(oa->GetClass()->GetComponentType())) {
1254 return JDWP::ERR_TYPE_MISMATCH;
1255 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001256 oa->Set<false>(offset + i, o);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001257 }
1258 }
1259
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001260 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001261}
1262
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001263JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1264 Thread* self = Thread::Current();
1265 mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1266 if (new_string == nullptr) {
1267 DCHECK(self->IsExceptionPending());
1268 self->ClearException();
1269 LOG(ERROR) << "Could not allocate string";
1270 *new_string_id = 0;
1271 return JDWP::ERR_OUT_OF_MEMORY;
1272 }
1273 *new_string_id = gRegistry->Add(new_string);
1274 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001275}
1276
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001277JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001278 JDWP::JdwpError error;
1279 mirror::Class* c = DecodeClass(class_id, &error);
1280 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001281 *new_object_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001282 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001283 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001284 Thread* self = Thread::Current();
Sebastien Hertz56d5e502015-11-03 17:38:35 +01001285 mirror::Object* new_object;
1286 if (c->IsStringClass()) {
1287 // Special case for java.lang.String.
1288 gc::AllocatorType allocator_type = Runtime::Current()->GetHeap()->GetCurrentAllocator();
jessicahandojo3aaa37b2016-07-29 14:46:37 -07001289 new_object = mirror::String::AllocEmptyString<true>(self, allocator_type);
Sebastien Hertz56d5e502015-11-03 17:38:35 +01001290 } else {
1291 new_object = c->AllocObject(self);
1292 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001293 if (new_object == nullptr) {
1294 DCHECK(self->IsExceptionPending());
1295 self->ClearException();
1296 LOG(ERROR) << "Could not allocate object of type " << PrettyDescriptor(c);
1297 *new_object_id = 0;
1298 return JDWP::ERR_OUT_OF_MEMORY;
1299 }
1300 *new_object_id = gRegistry->Add(new_object);
Elliott Hughes436e3722012-02-17 20:01:47 -08001301 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001302}
1303
Elliott Hughesbf13d362011-12-08 15:51:37 -08001304/*
1305 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1306 */
Elliott Hughes88d63092013-01-09 09:55:54 -08001307JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001308 JDWP::ObjectId* new_array_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001309 JDWP::JdwpError error;
1310 mirror::Class* c = DecodeClass(array_class_id, &error);
1311 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001312 *new_array_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001313 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001314 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001315 Thread* self = Thread::Current();
1316 gc::Heap* heap = Runtime::Current()->GetHeap();
1317 mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1318 c->GetComponentSizeShift(),
1319 heap->GetCurrentAllocator());
1320 if (new_array == nullptr) {
1321 DCHECK(self->IsExceptionPending());
1322 self->ClearException();
1323 LOG(ERROR) << "Could not allocate array of type " << PrettyDescriptor(c);
1324 *new_array_id = 0;
1325 return JDWP::ERR_OUT_OF_MEMORY;
1326 }
1327 *new_array_id = gRegistry->Add(new_array);
Elliott Hughes436e3722012-02-17 20:01:47 -08001328 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001329}
1330
Mathieu Chartierc7853442015-03-27 14:35:38 -07001331JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001332 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
Elliott Hughes03181a82011-11-17 17:22:21 -08001333}
1334
Alex Light6c8467f2015-11-20 15:03:26 -08001335static JDWP::MethodId ToMethodId(ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07001336 SHARED_REQUIRES(Locks::mutator_lock_) {
Alex Light6c8467f2015-11-20 15:03:26 -08001337 return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(GetCanonicalMethod(m)));
Elliott Hughes03181a82011-11-17 17:22:21 -08001338}
1339
Mathieu Chartierc7853442015-03-27 14:35:38 -07001340static ArtField* FromFieldId(JDWP::FieldId fid)
Mathieu Chartier90443472015-07-16 20:32:27 -07001341 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001342 return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
Elliott Hughesaed4be92011-12-02 16:16:23 -08001343}
1344
Mathieu Chartiere401d142015-04-22 13:56:20 -07001345static ArtMethod* FromMethodId(JDWP::MethodId mid)
Mathieu Chartier90443472015-07-16 20:32:27 -07001346 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001347 return reinterpret_cast<ArtMethod*>(static_cast<uintptr_t>(mid));
Elliott Hughes03181a82011-11-17 17:22:21 -08001348}
1349
Sebastien Hertz6995c602014-09-09 12:10:13 +02001350bool Dbg::MatchThread(JDWP::ObjectId expected_thread_id, Thread* event_thread) {
1351 CHECK(event_thread != nullptr);
1352 JDWP::JdwpError error;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001353 mirror::Object* expected_thread_peer = gRegistry->Get<mirror::Object*>(
1354 expected_thread_id, &error);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001355 return expected_thread_peer == event_thread->GetPeer();
1356}
1357
1358bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1359 const JDWP::EventLocation& event_location) {
1360 if (expected_location.dex_pc != event_location.dex_pc) {
1361 return false;
1362 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001363 ArtMethod* m = FromMethodId(expected_location.method_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001364 return m == event_location.method;
1365}
1366
1367bool Dbg::MatchType(mirror::Class* event_class, JDWP::RefTypeId class_id) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001368 if (event_class == nullptr) {
1369 return false;
1370 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02001371 JDWP::JdwpError error;
1372 mirror::Class* expected_class = DecodeClass(class_id, &error);
1373 CHECK(expected_class != nullptr);
1374 return expected_class->IsAssignableFrom(event_class);
1375}
1376
1377bool Dbg::MatchField(JDWP::RefTypeId expected_type_id, JDWP::FieldId expected_field_id,
Mathieu Chartierc7853442015-03-27 14:35:38 -07001378 ArtField* event_field) {
1379 ArtField* expected_field = FromFieldId(expected_field_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001380 if (expected_field != event_field) {
1381 return false;
1382 }
1383 return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1384}
1385
1386bool Dbg::MatchInstance(JDWP::ObjectId expected_instance_id, mirror::Object* event_instance) {
1387 JDWP::JdwpError error;
1388 mirror::Object* modifier_instance = gRegistry->Get<mirror::Object*>(expected_instance_id, &error);
1389 return modifier_instance == event_instance;
1390}
1391
Mathieu Chartier90443472015-07-16 20:32:27 -07001392void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, ArtMethod* m, uint32_t dex_pc) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001393 if (m == nullptr) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001394 memset(location, 0, sizeof(*location));
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001395 } else {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001396 mirror::Class* c = m->GetDeclaringClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07001397 location->type_tag = GetTypeTag(c);
1398 location->class_id = gRegistry->AddRefType(c);
1399 location->method_id = ToMethodId(m);
1400 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001401 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08001402}
1403
Ian Rogersc0542af2014-09-03 16:16:56 -07001404std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001405 ArtMethod* m = FromMethodId(method_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001406 if (m == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001407 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001408 }
Andreas Gampe542451c2016-07-26 09:02:02 -07001409 return m->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001410}
1411
Ian Rogersc0542af2014-09-03 16:16:56 -07001412std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001413 ArtField* f = FromFieldId(field_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001414 if (f == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001415 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001416 }
1417 return f->GetName();
Elliott Hughesa96836a2013-01-17 12:27:49 -08001418}
1419
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001420/*
1421 * Augment the access flags for synthetic methods and fields by setting
1422 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
1423 * flags not specified by the Java programming language.
1424 */
1425static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1426 accessFlags &= kAccJavaFlagsMask;
1427 if ((accessFlags & kAccSynthetic) != 0) {
1428 accessFlags |= 0xf0000000;
1429 }
1430 return accessFlags;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001431}
1432
Elliott Hughesdbb40792011-11-18 17:05:22 -08001433/*
Jeff Haob7cefc72013-11-14 14:51:09 -08001434 * Circularly shifts registers so that arguments come first. Debuggers
1435 * expect slots to begin with arguments, but dex code places them at
1436 * the end.
Elliott Hughesdbb40792011-11-18 17:05:22 -08001437 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001438static uint16_t MangleSlot(uint16_t slot, ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07001439 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001440 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001441 if (code_item == nullptr) {
1442 // We should not get here for a method without code (native, proxy or abstract). Log it and
1443 // return the slot as is since all registers are arguments.
1444 LOG(WARNING) << "Trying to mangle slot for method without code " << PrettyMethod(m);
1445 return slot;
1446 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001447 uint16_t ins_size = code_item->ins_size_;
1448 uint16_t locals_size = code_item->registers_size_ - ins_size;
1449 if (slot >= locals_size) {
1450 return slot - locals_size;
1451 } else {
1452 return slot + ins_size;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001453 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001454}
1455
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001456static size_t GetMethodNumArgRegistersIncludingThis(ArtMethod* method)
1457 SHARED_REQUIRES(Locks::mutator_lock_) {
1458 uint32_t num_registers = ArtMethod::NumArgRegisters(method->GetShorty());
1459 if (!method->IsStatic()) {
1460 ++num_registers;
1461 }
1462 return num_registers;
1463}
1464
Jeff Haob7cefc72013-11-14 14:51:09 -08001465/*
1466 * Circularly shifts registers so that arguments come last. Reverts
1467 * slots to dex style argument placement.
1468 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001469static uint16_t DemangleSlot(uint16_t slot, ArtMethod* m, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -07001470 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001471 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001472 if (code_item == nullptr) {
1473 // We should not get here for a method without code (native, proxy or abstract). Log it and
1474 // return the slot as is since all registers are arguments.
1475 LOG(WARNING) << "Trying to demangle slot for method without code " << PrettyMethod(m);
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001476 uint16_t vreg_count = GetMethodNumArgRegistersIncludingThis(m);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001477 if (slot < vreg_count) {
1478 *error = JDWP::ERR_NONE;
1479 return slot;
1480 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001481 } else {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001482 if (slot < code_item->registers_size_) {
1483 uint16_t ins_size = code_item->ins_size_;
1484 uint16_t locals_size = code_item->registers_size_ - ins_size;
1485 *error = JDWP::ERR_NONE;
1486 return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1487 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001488 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001489
1490 // Slot is invalid in the method.
1491 LOG(ERROR) << "Invalid local slot " << slot << " for method " << PrettyMethod(m);
1492 *error = JDWP::ERR_INVALID_SLOT;
1493 return DexFile::kDexNoIndex16;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001494}
1495
Mathieu Chartier90443472015-07-16 20:32:27 -07001496JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic,
1497 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001498 JDWP::JdwpError error;
1499 mirror::Class* c = DecodeClass(class_id, &error);
1500 if (c == nullptr) {
1501 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001502 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001503
1504 size_t instance_field_count = c->NumInstanceFields();
1505 size_t static_field_count = c->NumStaticFields();
1506
1507 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1508
1509 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
Mathieu Chartier90443472015-07-16 20:32:27 -07001510 ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) :
1511 c->GetStaticField(i - instance_field_count);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001512 expandBufAddFieldId(pReply, ToFieldId(f));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001513 expandBufAddUtf8String(pReply, f->GetName());
1514 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001515 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001516 static const char genericSignature[1] = "";
1517 expandBufAddUtf8String(pReply, genericSignature);
1518 }
1519 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1520 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001521 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001522}
1523
Elliott Hughes88d63092013-01-09 09:55:54 -08001524JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001525 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001526 JDWP::JdwpError error;
1527 mirror::Class* c = DecodeClass(class_id, &error);
1528 if (c == nullptr) {
1529 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001530 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001531
Alex Light51a64d52015-12-17 13:55:59 -08001532 expandBufAdd4BE(pReply, c->NumMethods());
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001533
Mathieu Chartiere401d142015-04-22 13:56:20 -07001534 auto* cl = Runtime::Current()->GetClassLinker();
1535 auto ptr_size = cl->GetImagePointerSize();
Alex Light51a64d52015-12-17 13:55:59 -08001536 for (ArtMethod& m : c->GetMethods(ptr_size)) {
1537 expandBufAddMethodId(pReply, ToMethodId(&m));
Andreas Gampe542451c2016-07-26 09:02:02 -07001538 expandBufAddUtf8String(pReply, m.GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName());
1539 expandBufAddUtf8String(
1540 pReply, m.GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetSignature().ToString());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001541 if (with_generic) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001542 const char* generic_signature = "";
1543 expandBufAddUtf8String(pReply, generic_signature);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001544 }
Alex Light51a64d52015-12-17 13:55:59 -08001545 expandBufAdd4BE(pReply, MangleAccessFlags(m.GetAccessFlags()));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001546 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001547 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001548}
1549
Elliott Hughes88d63092013-01-09 09:55:54 -08001550JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001551 JDWP::JdwpError error;
Mathieu Chartierf8322842014-05-16 10:59:25 -07001552 Thread* self = Thread::Current();
1553 StackHandleScope<1> hs(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07001554 Handle<mirror::Class> c(hs.NewHandle(DecodeClass(class_id, &error)));
Mathieu Chartierf8322842014-05-16 10:59:25 -07001555 if (c.Get() == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001556 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001557 }
Mathieu Chartierf8322842014-05-16 10:59:25 -07001558 size_t interface_count = c->NumDirectInterfaces();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001559 expandBufAdd4BE(pReply, interface_count);
1560 for (size_t i = 0; i < interface_count; ++i) {
Mathieu Chartierf8322842014-05-16 10:59:25 -07001561 expandBufAddRefTypeId(pReply,
1562 gRegistry->AddRefType(mirror::Class::GetDirectInterface(self, c, i)));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001563 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001564 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001565}
1566
Ian Rogersc0542af2014-09-03 16:16:56 -07001567void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001568 struct DebugCallbackContext {
1569 int numItems;
1570 JDWP::ExpandBuf* pReply;
1571
David Srbeckyb06e28e2015-12-10 13:15:00 +00001572 static bool Callback(void* context, const DexFile::PositionInfo& entry) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001573 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
David Srbeckyb06e28e2015-12-10 13:15:00 +00001574 expandBufAdd8BE(pContext->pReply, entry.address_);
1575 expandBufAdd4BE(pContext->pReply, entry.line_);
Elliott Hughes03181a82011-11-17 17:22:21 -08001576 pContext->numItems++;
Sebastien Hertzf2910ee2013-10-19 16:39:24 +02001577 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08001578 }
1579 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001580 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001581 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes03181a82011-11-17 17:22:21 -08001582 uint64_t start, end;
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001583 if (code_item == nullptr) {
1584 DCHECK(m->IsNative() || m->IsProxyMethod());
Elliott Hughes03181a82011-11-17 17:22:21 -08001585 start = -1;
1586 end = -1;
1587 } else {
1588 start = 0;
jeffhao14f0db92012-12-14 17:50:42 -08001589 // Return the index of the last instruction
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001590 end = code_item->insns_size_in_code_units_ - 1;
Elliott Hughes03181a82011-11-17 17:22:21 -08001591 }
1592
1593 expandBufAdd8BE(pReply, start);
1594 expandBufAdd8BE(pReply, end);
1595
1596 // Add numLines later
1597 size_t numLinesOffset = expandBufGetLength(pReply);
1598 expandBufAdd4BE(pReply, 0);
1599
1600 DebugCallbackContext context;
1601 context.numItems = 0;
1602 context.pReply = pReply;
1603
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001604 if (code_item != nullptr) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001605 m->GetDexFile()->DecodeDebugPositionInfo(code_item, DebugCallbackContext::Callback, &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001606 }
Elliott Hughes03181a82011-11-17 17:22:21 -08001607
1608 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001609}
1610
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001611void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1612 JDWP::ExpandBuf* pReply) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001613 struct DebugCallbackContext {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001614 ArtMethod* method;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001615 JDWP::ExpandBuf* pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001616 size_t variable_count;
1617 bool with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001618
David Srbeckyb06e28e2015-12-10 13:15:00 +00001619 static void Callback(void* context, const DexFile::LocalInfo& entry)
Mathieu Chartier90443472015-07-16 20:32:27 -07001620 SHARED_REQUIRES(Locks::mutator_lock_) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001621 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1622
David Srbeckyb06e28e2015-12-10 13:15:00 +00001623 uint16_t slot = entry.reg_;
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001624 VLOG(jdwp) << StringPrintf(" %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
David Srbeckyb06e28e2015-12-10 13:15:00 +00001625 pContext->variable_count, entry.start_address_,
1626 entry.end_address_ - entry.start_address_,
1627 entry.name_, entry.descriptor_, entry.signature_, slot,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001628 MangleSlot(slot, pContext->method));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001629
Jeff Haob7cefc72013-11-14 14:51:09 -08001630 slot = MangleSlot(slot, pContext->method);
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001631
David Srbeckyb06e28e2015-12-10 13:15:00 +00001632 expandBufAdd8BE(pContext->pReply, entry.start_address_);
1633 expandBufAddUtf8String(pContext->pReply, entry.name_);
1634 expandBufAddUtf8String(pContext->pReply, entry.descriptor_);
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001635 if (pContext->with_generic) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001636 expandBufAddUtf8String(pContext->pReply, entry.signature_);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001637 }
David Srbeckyb06e28e2015-12-10 13:15:00 +00001638 expandBufAdd4BE(pContext->pReply, entry.end_address_- entry.start_address_);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001639 expandBufAdd4BE(pContext->pReply, slot);
1640
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001641 ++pContext->variable_count;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001642 }
1643 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001644 ArtMethod* m = FromMethodId(method_id);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001645
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001646 // arg_count considers doubles and longs to take 2 units.
1647 // variable_count considers everything to take 1 unit.
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001648 expandBufAdd4BE(pReply, GetMethodNumArgRegistersIncludingThis(m));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001649
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001650 // We don't know the total number of variables yet, so leave a blank and update it later.
1651 size_t variable_count_offset = expandBufGetLength(pReply);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001652 expandBufAdd4BE(pReply, 0);
1653
1654 DebugCallbackContext context;
Jeff Haob7cefc72013-11-14 14:51:09 -08001655 context.method = m;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001656 context.pReply = pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001657 context.variable_count = 0;
1658 context.with_generic = with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001659
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001660 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001661 if (code_item != nullptr) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001662 m->GetDexFile()->DecodeDebugLocalInfo(
1663 code_item, m->IsStatic(), m->GetDexMethodIndex(), DebugCallbackContext::Callback,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001664 &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001665 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001666
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001667 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001668}
1669
Jeff Hao579b0242013-11-18 13:16:49 -08001670void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1671 JDWP::ExpandBuf* pReply) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001672 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001673 JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
Jeff Hao579b0242013-11-18 13:16:49 -08001674 OutputJValue(tag, return_value, pReply);
1675}
1676
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001677void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1678 JDWP::ExpandBuf* pReply) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001679 ArtField* f = FromFieldId(field_id);
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001680 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001681 OutputJValue(tag, field_value, pReply);
1682}
1683
Elliott Hughes9777ba22013-01-17 09:04:19 -08001684JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
Ian Rogersc0542af2014-09-03 16:16:56 -07001685 std::vector<uint8_t>* bytecodes) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001686 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07001687 if (m == nullptr) {
Elliott Hughes9777ba22013-01-17 09:04:19 -08001688 return JDWP::ERR_INVALID_METHODID;
1689 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001690 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes9777ba22013-01-17 09:04:19 -08001691 size_t byte_count = code_item->insns_size_in_code_units_ * 2;
1692 const uint8_t* begin = reinterpret_cast<const uint8_t*>(code_item->insns_);
1693 const uint8_t* end = begin + byte_count;
1694 for (const uint8_t* p = begin; p != end; ++p) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001695 bytecodes->push_back(*p);
Elliott Hughes9777ba22013-01-17 09:04:19 -08001696 }
1697 return JDWP::ERR_NONE;
1698}
1699
Elliott Hughes88d63092013-01-09 09:55:54 -08001700JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001701 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001702}
1703
Elliott Hughes88d63092013-01-09 09:55:54 -08001704JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001705 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001706}
1707
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001708static JValue GetArtFieldValue(ArtField* f, mirror::Object* o)
Mathieu Chartier90443472015-07-16 20:32:27 -07001709 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001710 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1711 JValue field_value;
1712 switch (fieldType) {
1713 case Primitive::kPrimBoolean:
1714 field_value.SetZ(f->GetBoolean(o));
1715 return field_value;
1716
1717 case Primitive::kPrimByte:
1718 field_value.SetB(f->GetByte(o));
1719 return field_value;
1720
1721 case Primitive::kPrimChar:
1722 field_value.SetC(f->GetChar(o));
1723 return field_value;
1724
1725 case Primitive::kPrimShort:
1726 field_value.SetS(f->GetShort(o));
1727 return field_value;
1728
1729 case Primitive::kPrimInt:
1730 case Primitive::kPrimFloat:
1731 // Int and Float must be treated as 32-bit values in JDWP.
1732 field_value.SetI(f->GetInt(o));
1733 return field_value;
1734
1735 case Primitive::kPrimLong:
1736 case Primitive::kPrimDouble:
1737 // Long and Double must be treated as 64-bit values in JDWP.
1738 field_value.SetJ(f->GetLong(o));
1739 return field_value;
1740
1741 case Primitive::kPrimNot:
1742 field_value.SetL(f->GetObject(o));
1743 return field_value;
1744
1745 case Primitive::kPrimVoid:
1746 LOG(FATAL) << "Attempt to read from field of type 'void'";
1747 UNREACHABLE();
1748 }
1749 LOG(FATAL) << "Attempt to read from field of unknown type";
1750 UNREACHABLE();
1751}
1752
Elliott Hughes88d63092013-01-09 09:55:54 -08001753static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1754 JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001755 bool is_static)
Mathieu Chartier90443472015-07-16 20:32:27 -07001756 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001757 JDWP::JdwpError error;
1758 mirror::Class* c = DecodeClass(ref_type_id, &error);
1759 if (ref_type_id != 0 && c == nullptr) {
1760 return error;
Elliott Hughes0cf74332012-02-23 23:14:00 -08001761 }
1762
Sebastien Hertz6995c602014-09-09 12:10:13 +02001763 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001764 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001765 return JDWP::ERR_INVALID_OBJECT;
1766 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001767 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001768
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001769 mirror::Class* receiver_class = c;
Ian Rogersc0542af2014-09-03 16:16:56 -07001770 if (receiver_class == nullptr && o != nullptr) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001771 receiver_class = o->GetClass();
1772 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001773 // TODO: should we give up now if receiver_class is null?
Ian Rogersc0542af2014-09-03 16:16:56 -07001774 if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001775 LOG(INFO) << "ERR_INVALID_FIELDID: " << PrettyField(f) << " " << PrettyClass(receiver_class);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001776 return JDWP::ERR_INVALID_FIELDID;
1777 }
Elliott Hughesaed4be92011-12-02 16:16:23 -08001778
Elliott Hughes0cf74332012-02-23 23:14:00 -08001779 // The RI only enforces the static/non-static mismatch in one direction.
1780 // TODO: should we change the tests and check both?
1781 if (is_static) {
1782 if (!f->IsStatic()) {
1783 return JDWP::ERR_INVALID_FIELDID;
1784 }
1785 } else {
1786 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001787 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.GetValues"
1788 << " on static field " << PrettyField(f);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001789 }
1790 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001791 if (f->IsStatic()) {
1792 o = f->GetDeclaringClass();
1793 }
Elliott Hughes0cf74332012-02-23 23:14:00 -08001794
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001795 JValue field_value(GetArtFieldValue(f, o));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001796 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Jeff Hao579b0242013-11-18 13:16:49 -08001797 Dbg::OutputJValue(tag, &field_value, pReply);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001798 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001799}
1800
Elliott Hughes88d63092013-01-09 09:55:54 -08001801JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001802 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001803 return GetFieldValueImpl(0, object_id, field_id, pReply, false);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001804}
1805
Ian Rogersc0542af2014-09-03 16:16:56 -07001806JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1807 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001808 return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001809}
1810
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001811static JDWP::JdwpError SetArtFieldValue(ArtField* f, mirror::Object* o, uint64_t value, int width)
Mathieu Chartier90443472015-07-16 20:32:27 -07001812 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001813 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1814 // Debugging only happens at runtime so we know we are not running in a transaction.
1815 static constexpr bool kNoTransactionMode = false;
1816 switch (fieldType) {
1817 case Primitive::kPrimBoolean:
1818 CHECK_EQ(width, 1);
1819 f->SetBoolean<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1820 return JDWP::ERR_NONE;
1821
1822 case Primitive::kPrimByte:
1823 CHECK_EQ(width, 1);
1824 f->SetByte<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1825 return JDWP::ERR_NONE;
1826
1827 case Primitive::kPrimChar:
1828 CHECK_EQ(width, 2);
1829 f->SetChar<kNoTransactionMode>(o, static_cast<uint16_t>(value));
1830 return JDWP::ERR_NONE;
1831
1832 case Primitive::kPrimShort:
1833 CHECK_EQ(width, 2);
1834 f->SetShort<kNoTransactionMode>(o, static_cast<int16_t>(value));
1835 return JDWP::ERR_NONE;
1836
1837 case Primitive::kPrimInt:
1838 case Primitive::kPrimFloat:
1839 CHECK_EQ(width, 4);
1840 // Int and Float must be treated as 32-bit values in JDWP.
1841 f->SetInt<kNoTransactionMode>(o, static_cast<int32_t>(value));
1842 return JDWP::ERR_NONE;
1843
1844 case Primitive::kPrimLong:
1845 case Primitive::kPrimDouble:
1846 CHECK_EQ(width, 8);
1847 // Long and Double must be treated as 64-bit values in JDWP.
1848 f->SetLong<kNoTransactionMode>(o, value);
1849 return JDWP::ERR_NONE;
1850
1851 case Primitive::kPrimNot: {
1852 JDWP::JdwpError error;
1853 mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1854 if (error != JDWP::ERR_NONE) {
1855 return JDWP::ERR_INVALID_OBJECT;
1856 }
1857 if (v != nullptr) {
1858 mirror::Class* field_type;
1859 {
1860 StackHandleScope<2> hs(Thread::Current());
1861 HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1862 HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
1863 field_type = f->GetType<true>();
1864 }
1865 if (!field_type->IsAssignableFrom(v->GetClass())) {
1866 return JDWP::ERR_INVALID_OBJECT;
1867 }
1868 }
1869 f->SetObject<kNoTransactionMode>(o, v);
1870 return JDWP::ERR_NONE;
1871 }
1872
1873 case Primitive::kPrimVoid:
1874 LOG(FATAL) << "Attempt to write to field of type 'void'";
1875 UNREACHABLE();
1876 }
1877 LOG(FATAL) << "Attempt to write to field of unknown type";
1878 UNREACHABLE();
1879}
1880
Elliott Hughes88d63092013-01-09 09:55:54 -08001881static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001882 uint64_t value, int width, bool is_static)
Mathieu Chartier90443472015-07-16 20:32:27 -07001883 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001884 JDWP::JdwpError error;
Sebastien Hertz6995c602014-09-09 12:10:13 +02001885 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001886 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001887 return JDWP::ERR_INVALID_OBJECT;
1888 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001889 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001890
1891 // The RI only enforces the static/non-static mismatch in one direction.
1892 // TODO: should we change the tests and check both?
1893 if (is_static) {
1894 if (!f->IsStatic()) {
1895 return JDWP::ERR_INVALID_FIELDID;
1896 }
1897 } else {
1898 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001899 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues"
1900 << " on static field " << PrettyField(f);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001901 }
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001902 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001903 if (f->IsStatic()) {
1904 o = f->GetDeclaringClass();
1905 }
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001906 return SetArtFieldValue(f, o, value, width);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001907}
1908
Elliott Hughes88d63092013-01-09 09:55:54 -08001909JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001910 int width) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001911 return SetFieldValueImpl(object_id, field_id, value, width, false);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001912}
1913
Elliott Hughes88d63092013-01-09 09:55:54 -08001914JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
1915 return SetFieldValueImpl(0, field_id, value, width, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001916}
1917
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001918JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001919 JDWP::JdwpError error;
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001920 mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
1921 if (error != JDWP::ERR_NONE) {
1922 return error;
1923 }
1924 if (obj == nullptr) {
1925 return JDWP::ERR_INVALID_OBJECT;
1926 }
1927 {
1928 ScopedObjectAccessUnchecked soa(Thread::Current());
1929 mirror::Class* java_lang_String = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_String);
1930 if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
1931 // This isn't a string.
1932 return JDWP::ERR_INVALID_STRING;
1933 }
1934 }
1935 *str = obj->AsString()->ToModifiedUtf8();
1936 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001937}
1938
Jeff Hao579b0242013-11-18 13:16:49 -08001939void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
1940 if (IsPrimitiveTag(tag)) {
1941 expandBufAdd1(pReply, tag);
1942 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
1943 expandBufAdd1(pReply, return_value->GetI());
1944 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
1945 expandBufAdd2BE(pReply, return_value->GetI());
1946 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
1947 expandBufAdd4BE(pReply, return_value->GetI());
1948 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1949 expandBufAdd8BE(pReply, return_value->GetJ());
1950 } else {
1951 CHECK_EQ(tag, JDWP::JT_VOID);
1952 }
1953 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001954 ScopedObjectAccessUnchecked soa(Thread::Current());
Jeff Hao579b0242013-11-18 13:16:49 -08001955 mirror::Object* value = return_value->GetL();
Ian Rogers98379392014-02-24 16:53:16 -08001956 expandBufAdd1(pReply, TagFromObject(soa, value));
Jeff Hao579b0242013-11-18 13:16:49 -08001957 expandBufAddObjectId(pReply, gRegistry->Add(value));
1958 }
1959}
1960
Ian Rogersc0542af2014-09-03 16:16:56 -07001961JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001962 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001963 JDWP::JdwpError error;
Roland Levillain4b8f1ec2015-08-26 18:34:03 +01001964 DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08001965 if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
1966 return error;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001967 }
Elliott Hughes221229c2013-01-08 18:17:50 -08001968
1969 // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
Ian Rogersc0542af2014-09-03 16:16:56 -07001970 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1971 CHECK(thread_object != nullptr) << error;
Mathieu Chartierc7853442015-03-27 14:35:38 -07001972 ArtField* java_lang_Thread_name_field =
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001973 soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
1974 mirror::String* s =
1975 reinterpret_cast<mirror::String*>(java_lang_Thread_name_field->GetObject(thread_object));
Ian Rogersc0542af2014-09-03 16:16:56 -07001976 if (s != nullptr) {
1977 *name = s->ToModifiedUtf8();
Elliott Hughes221229c2013-01-08 18:17:50 -08001978 }
1979 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001980}
1981
Elliott Hughes221229c2013-01-08 18:17:50 -08001982JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02001983 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001984 JDWP::JdwpError error;
1985 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1986 if (error != JDWP::ERR_NONE) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001987 return JDWP::ERR_INVALID_OBJECT;
1988 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001989 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroup");
Elliott Hughes2435a572012-02-17 16:07:41 -08001990 // Okay, so it's an object, but is it actually a thread?
Roland Levillain4b8f1ec2015-08-26 18:34:03 +01001991 DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08001992 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
1993 // Zombie threads are in the null group.
1994 expandBufAddObjectId(pReply, JDWP::ObjectId(0));
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001995 error = JDWP::ERR_NONE;
1996 } else if (error == JDWP::ERR_NONE) {
1997 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
1998 CHECK(c != nullptr);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001999 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07002000 CHECK(f != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002001 mirror::Object* group = f->GetObject(thread_object);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07002002 CHECK(group != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002003 JDWP::ObjectId thread_group_id = gRegistry->Add(group);
2004 expandBufAddObjectId(pReply, thread_group_id);
Elliott Hughes221229c2013-01-08 18:17:50 -08002005 }
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002006 return error;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002007}
2008
Sebastien Hertza06430c2014-09-15 19:21:30 +02002009static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
2010 JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -07002011 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002012 mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
2013 error);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002014 if (*error != JDWP::ERR_NONE) {
2015 return nullptr;
2016 }
2017 if (thread_group == nullptr) {
2018 *error = JDWP::ERR_INVALID_OBJECT;
2019 return nullptr;
2020 }
Ian Rogers98379392014-02-24 16:53:16 -08002021 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
2022 CHECK(c != nullptr);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002023 if (!c->IsAssignableFrom(thread_group->GetClass())) {
2024 // This is not a java.lang.ThreadGroup.
2025 *error = JDWP::ERR_INVALID_THREAD_GROUP;
2026 return nullptr;
2027 }
2028 *error = JDWP::ERR_NONE;
2029 return thread_group;
2030}
2031
2032JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
2033 ScopedObjectAccessUnchecked soa(Thread::Current());
2034 JDWP::JdwpError error;
2035 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2036 if (error != JDWP::ERR_NONE) {
2037 return error;
2038 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002039 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupName");
Mathieu Chartierc7853442015-03-27 14:35:38 -07002040 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_name);
Ian Rogersc0542af2014-09-03 16:16:56 -07002041 CHECK(f != nullptr);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002042 mirror::String* s = reinterpret_cast<mirror::String*>(f->GetObject(thread_group));
Sebastien Hertza06430c2014-09-15 19:21:30 +02002043
2044 std::string thread_group_name(s->ToModifiedUtf8());
2045 expandBufAddUtf8String(pReply, thread_group_name);
2046 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002047}
2048
Sebastien Hertza06430c2014-09-15 19:21:30 +02002049JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
Ian Rogers98379392014-02-24 16:53:16 -08002050 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002051 JDWP::JdwpError error;
Sebastien Hertza06430c2014-09-15 19:21:30 +02002052 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2053 if (error != JDWP::ERR_NONE) {
2054 return error;
2055 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002056 mirror::Object* parent;
2057 {
2058 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupParent");
Mathieu Chartierc7853442015-03-27 14:35:38 -07002059 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_parent);
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002060 CHECK(f != nullptr);
2061 parent = f->GetObject(thread_group);
2062 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002063 JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
2064 expandBufAddObjectId(pReply, parent_group_id);
2065 return JDWP::ERR_NONE;
2066}
2067
2068static void GetChildThreadGroups(ScopedObjectAccessUnchecked& soa, mirror::Object* thread_group,
2069 std::vector<JDWP::ObjectId>* child_thread_group_ids)
Mathieu Chartier90443472015-07-16 20:32:27 -07002070 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02002071 CHECK(thread_group != nullptr);
2072
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002073 // Get the int "ngroups" count of this thread group...
2074 ArtField* ngroups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_ngroups);
2075 CHECK(ngroups_field != nullptr);
2076 const int32_t size = ngroups_field->GetInt(thread_group);
2077 if (size == 0) {
2078 return;
Sebastien Hertze49e1952014-10-13 11:27:13 +02002079 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002080
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002081 // Get the ThreadGroup[] "groups" out of this thread group...
2082 ArtField* groups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_groups);
2083 mirror::Object* groups_array = groups_field->GetObject(thread_group);
2084
2085 CHECK(groups_array != nullptr);
2086 CHECK(groups_array->IsObjectArray());
2087
2088 mirror::ObjectArray<mirror::Object>* groups_array_as_array =
2089 groups_array->AsObjectArray<mirror::Object>();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002090
2091 // Copy the first 'size' elements out of the array into the result.
Sebastien Hertz6995c602014-09-09 12:10:13 +02002092 ObjectRegistry* registry = Dbg::GetObjectRegistry();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002093 for (int32_t i = 0; i < size; ++i) {
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002094 child_thread_group_ids->push_back(registry->Add(groups_array_as_array->Get(i)));
Sebastien Hertza06430c2014-09-15 19:21:30 +02002095 }
2096}
2097
2098JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2099 JDWP::ExpandBuf* pReply) {
2100 ScopedObjectAccessUnchecked soa(Thread::Current());
2101 JDWP::JdwpError error;
2102 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2103 if (error != JDWP::ERR_NONE) {
2104 return error;
2105 }
2106
2107 // Add child threads.
2108 {
2109 std::vector<JDWP::ObjectId> child_thread_ids;
2110 GetThreads(thread_group, &child_thread_ids);
2111 expandBufAdd4BE(pReply, child_thread_ids.size());
2112 for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2113 expandBufAddObjectId(pReply, child_thread_id);
2114 }
2115 }
2116
2117 // Add child thread groups.
2118 {
2119 std::vector<JDWP::ObjectId> child_thread_groups_ids;
2120 GetChildThreadGroups(soa, thread_group, &child_thread_groups_ids);
2121 expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2122 for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2123 expandBufAddObjectId(pReply, child_thread_group_id);
2124 }
2125 }
2126
2127 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002128}
2129
2130JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002131 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartierc7853442015-03-27 14:35:38 -07002132 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002133 mirror::Object* group = f->GetObject(f->GetDeclaringClass());
Ian Rogers365c1022012-06-22 15:05:28 -07002134 return gRegistry->Add(group);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002135}
2136
Jeff Hao920af3e2013-08-28 15:46:38 -07002137JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2138 switch (state) {
2139 case kBlocked:
2140 return JDWP::TS_MONITOR;
2141 case kNative:
2142 case kRunnable:
2143 case kSuspended:
2144 return JDWP::TS_RUNNING;
2145 case kSleeping:
2146 return JDWP::TS_SLEEPING;
2147 case kStarting:
2148 case kTerminated:
2149 return JDWP::TS_ZOMBIE;
2150 case kTimedWaiting:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002151 case kWaitingForCheckPointsToRun:
Jeff Hao920af3e2013-08-28 15:46:38 -07002152 case kWaitingForDebuggerSend:
2153 case kWaitingForDebuggerSuspension:
2154 case kWaitingForDebuggerToAttach:
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01002155 case kWaitingForDeoptimization:
Jeff Hao920af3e2013-08-28 15:46:38 -07002156 case kWaitingForGcToComplete:
Mathieu Chartierb43390c2015-05-12 10:47:11 -07002157 case kWaitingForGetObjectsAllocated:
Jeff Hao920af3e2013-08-28 15:46:38 -07002158 case kWaitingForJniOnLoad:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002159 case kWaitingForMethodTracingStart:
Jeff Hao920af3e2013-08-28 15:46:38 -07002160 case kWaitingForSignalCatcherOutput:
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08002161 case kWaitingForVisitObjects:
Jeff Hao920af3e2013-08-28 15:46:38 -07002162 case kWaitingInMainDebuggerLoop:
2163 case kWaitingInMainSignalCatcherLoop:
2164 case kWaitingPerformingGc:
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07002165 case kWaitingWeakGcRootRead:
Hiroshi Yamauchi76f55b02015-08-21 16:10:39 -07002166 case kWaitingForGcThreadFlip:
Jeff Hao920af3e2013-08-28 15:46:38 -07002167 case kWaiting:
2168 return JDWP::TS_WAIT;
2169 // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2170 }
2171 LOG(FATAL) << "Unknown thread state: " << state;
2172 return JDWP::TS_ZOMBIE;
2173}
2174
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002175JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2176 JDWP::JdwpSuspendStatus* pSuspendStatus) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002177 ScopedObjectAccess soa(Thread::Current());
Elliott Hughes499c5132011-11-17 14:55:11 -08002178
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002179 *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2180
Ian Rogersc0542af2014-09-03 16:16:56 -07002181 JDWP::JdwpError error;
2182 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002183 if (error != JDWP::ERR_NONE) {
2184 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2185 *pThreadStatus = JDWP::TS_ZOMBIE;
Elliott Hughes221229c2013-01-08 18:17:50 -08002186 return JDWP::ERR_NONE;
2187 }
2188 return error;
Elliott Hughes499c5132011-11-17 14:55:11 -08002189 }
2190
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002191 if (IsSuspendedForDebugger(soa, thread)) {
2192 *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
Elliott Hughes499c5132011-11-17 14:55:11 -08002193 }
2194
Jeff Hao920af3e2013-08-28 15:46:38 -07002195 *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
Elliott Hughes221229c2013-01-08 18:17:50 -08002196 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002197}
2198
Elliott Hughes221229c2013-01-08 18:17:50 -08002199JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002200 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002201 JDWP::JdwpError error;
2202 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002203 if (error != JDWP::ERR_NONE) {
2204 return error;
Elliott Hughes2435a572012-02-17 16:07:41 -08002205 }
Ian Rogers50b35e22012-10-04 10:09:15 -07002206 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002207 expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
Elliott Hughes2435a572012-02-17 16:07:41 -08002208 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002209}
2210
Elliott Hughesf9501702013-01-11 11:22:27 -08002211JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2212 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002213 JDWP::JdwpError error;
2214 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughesf9501702013-01-11 11:22:27 -08002215 if (error != JDWP::ERR_NONE) {
2216 return error;
2217 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002218 thread->Interrupt(soa.Self());
Elliott Hughesf9501702013-01-11 11:22:27 -08002219 return JDWP::ERR_NONE;
2220}
2221
Sebastien Hertz070f7322014-09-09 12:08:49 +02002222static bool IsInDesiredThreadGroup(ScopedObjectAccessUnchecked& soa,
2223 mirror::Object* desired_thread_group, mirror::Object* peer)
Mathieu Chartier90443472015-07-16 20:32:27 -07002224 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz070f7322014-09-09 12:08:49 +02002225 // Do we want threads from all thread groups?
2226 if (desired_thread_group == nullptr) {
2227 return true;
2228 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07002229 ArtField* thread_group_field = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002230 DCHECK(thread_group_field != nullptr);
2231 mirror::Object* group = thread_group_field->GetObject(peer);
2232 return (group == desired_thread_group);
2233}
2234
Sebastien Hertza06430c2014-09-15 19:21:30 +02002235void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002236 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz070f7322014-09-09 12:08:49 +02002237 std::list<Thread*> all_threads_list;
2238 {
2239 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2240 all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2241 }
2242 for (Thread* t : all_threads_list) {
2243 if (t == Dbg::GetDebugThread()) {
2244 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2245 // query all threads, so it's easier if we just don't tell them about this thread.
2246 continue;
2247 }
2248 if (t->IsStillStarting()) {
2249 // This thread is being started (and has been registered in the thread list). However, it is
2250 // not completely started yet so we must ignore it.
2251 continue;
2252 }
2253 mirror::Object* peer = t->GetPeer();
2254 if (peer == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002255 // peer might be null if the thread is still starting up. We can't tell the debugger about
Sebastien Hertz070f7322014-09-09 12:08:49 +02002256 // this thread yet.
2257 // TODO: if we identified threads to the debugger by their Thread*
2258 // rather than their peer's mirror::Object*, we could fix this.
2259 // Doing so might help us report ZOMBIE threads too.
2260 continue;
2261 }
2262 if (IsInDesiredThreadGroup(soa, thread_group, peer)) {
2263 thread_ids->push_back(gRegistry->Add(peer));
2264 }
2265 }
Elliott Hughescaf76542012-06-28 16:08:22 -07002266}
Elliott Hughesa2155262011-11-16 16:26:58 -08002267
Mathieu Chartier90443472015-07-16 20:32:27 -07002268static int GetStackDepth(Thread* thread) SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002269 struct CountStackDepthVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002270 explicit CountStackDepthVisitor(Thread* thread_in)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002271 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2272 depth(0) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002273
Elliott Hughes64f574f2013-02-20 14:57:12 -08002274 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2275 // annotalysis.
2276 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers0399dde2012-06-06 17:09:28 -07002277 if (!GetMethod()->IsRuntimeMethod()) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08002278 ++depth;
2279 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002280 return true;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002281 }
2282 size_t depth;
2283 };
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002284
Ian Rogers7a22fa62013-01-23 12:16:16 -08002285 CountStackDepthVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07002286 visitor.WalkStack();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002287 return visitor.depth;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002288}
2289
Ian Rogersc0542af2014-09-03 16:16:56 -07002290JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002291 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002292 JDWP::JdwpError error;
2293 *result = 0;
2294 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002295 if (error != JDWP::ERR_NONE) {
2296 return error;
2297 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002298 if (!IsSuspendedForDebugger(soa, thread)) {
2299 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2300 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002301 *result = GetStackDepth(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08002302 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -08002303}
2304
Ian Rogers306057f2012-11-26 12:45:53 -08002305JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2306 size_t frame_count, JDWP::ExpandBuf* buf) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002307 class GetFrameVisitor : public StackVisitor {
2308 public:
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002309 GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2310 JDWP::ExpandBuf* buf_in)
Mathieu Chartier90443472015-07-16 20:32:27 -07002311 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002312 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2313 depth_(0),
2314 start_frame_(start_frame_in),
2315 frame_count_(frame_count_in),
2316 buf_(buf_in) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002317 expandBufAdd4BE(buf_, frame_count_);
Elliott Hughes03181a82011-11-17 17:22:21 -08002318 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002319
Mathieu Chartier90443472015-07-16 20:32:27 -07002320 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002321 if (GetMethod()->IsRuntimeMethod()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002322 return true; // The debugger can't do anything useful with a frame that has no Method*.
Elliott Hughes03181a82011-11-17 17:22:21 -08002323 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002324 if (depth_ >= start_frame_ + frame_count_) {
Elliott Hughes530fa002012-03-12 11:44:49 -07002325 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08002326 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002327 if (depth_ >= start_frame_) {
2328 JDWP::FrameId frame_id(GetFrameId());
2329 JDWP::JdwpLocation location;
Sebastien Hertz6995c602014-09-09 12:10:13 +02002330 SetJdwpLocation(&location, GetMethod(), GetDexPc());
Ian Rogersef7d42f2014-01-06 12:55:46 -08002331 VLOG(jdwp) << StringPrintf(" Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002332 expandBufAdd8BE(buf_, frame_id);
2333 expandBufAddLocation(buf_, location);
2334 }
2335 ++depth_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002336 return true;
Elliott Hughes03181a82011-11-17 17:22:21 -08002337 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002338
2339 private:
2340 size_t depth_;
2341 const size_t start_frame_;
2342 const size_t frame_count_;
2343 JDWP::ExpandBuf* buf_;
Elliott Hughes03181a82011-11-17 17:22:21 -08002344 };
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002345
2346 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002347 JDWP::JdwpError error;
2348 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002349 if (error != JDWP::ERR_NONE) {
2350 return error;
2351 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002352 if (!IsSuspendedForDebugger(soa, thread)) {
2353 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2354 }
Ian Rogers7a22fa62013-01-23 12:16:16 -08002355 GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
Ian Rogers0399dde2012-06-06 17:09:28 -07002356 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002357 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002358}
2359
2360JDWP::ObjectId Dbg::GetThreadSelfId() {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002361 return GetThreadId(Thread::Current());
2362}
2363
2364JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002365 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz6995c602014-09-09 12:10:13 +02002366 return gRegistry->Add(thread->GetPeer());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002367}
2368
Elliott Hughes475fc232011-10-25 15:00:35 -07002369void Dbg::SuspendVM() {
Hiroshi Yamauchi8f95cf32016-04-19 11:14:06 -07002370 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
2371 gc::ScopedGCCriticalSection gcs(Thread::Current(),
2372 gc::kGcCauseDebugger,
2373 gc::kCollectorTypeDebugger);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002374 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002375}
2376
2377void Dbg::ResumeVM() {
Sebastien Hertz253fa552014-10-14 17:27:15 +02002378 Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002379}
2380
Elliott Hughes221229c2013-01-08 18:17:50 -08002381JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002382 Thread* self = Thread::Current();
Ian Rogersc0542af2014-09-03 16:16:56 -07002383 ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002384 {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002385 ScopedObjectAccess soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07002386 JDWP::JdwpError error;
2387 peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
Elliott Hughes4e235312011-12-02 11:34:15 -08002388 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002389 if (peer.get() == nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002390 return JDWP::ERR_THREAD_NOT_ALIVE;
2391 }
Ian Rogers4ad5cd32014-11-11 23:08:07 -08002392 // Suspend thread to build stack trace.
Elliott Hughesf327e072013-01-09 16:01:26 -08002393 bool timed_out;
Brian Carlstromba32de42014-08-27 23:43:46 -07002394 ThreadList* thread_list = Runtime::Current()->GetThreadList();
2395 Thread* thread = thread_list->SuspendThreadByPeer(peer.get(), request_suspension, true,
2396 &timed_out);
Ian Rogersc0542af2014-09-03 16:16:56 -07002397 if (thread != nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002398 return JDWP::ERR_NONE;
Elliott Hughesf327e072013-01-09 16:01:26 -08002399 } else if (timed_out) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002400 return JDWP::ERR_INTERNAL;
2401 } else {
2402 return JDWP::ERR_THREAD_NOT_ALIVE;
2403 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002404}
2405
Elliott Hughes221229c2013-01-08 18:17:50 -08002406void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002407 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002408 JDWP::JdwpError error;
2409 mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2410 CHECK(peer != nullptr) << error;
jeffhaoa77f0f62012-12-05 17:19:31 -08002411 Thread* thread;
2412 {
2413 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2414 thread = Thread::FromManagedThread(soa, peer);
2415 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002416 if (thread == nullptr) {
Elliott Hughes4e235312011-12-02 11:34:15 -08002417 LOG(WARNING) << "No such thread for resume: " << peer;
2418 return;
2419 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002420 bool needs_resume;
2421 {
Ian Rogers50b35e22012-10-04 10:09:15 -07002422 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002423 needs_resume = thread->GetSuspendCount() > 0;
2424 }
2425 if (needs_resume) {
Elliott Hughes546b9862012-06-20 16:06:13 -07002426 Runtime::Current()->GetThreadList()->Resume(thread, true);
2427 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002428}
2429
2430void Dbg::SuspendSelf() {
Elliott Hughes475fc232011-10-25 15:00:35 -07002431 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002432}
2433
Ian Rogers0399dde2012-06-06 17:09:28 -07002434struct GetThisVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002435 GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
Mathieu Chartier90443472015-07-16 20:32:27 -07002436 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002437 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2438 this_object(nullptr),
2439 frame_id(frame_id_in) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002440
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002441 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2442 // annotalysis.
2443 virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002444 if (frame_id != GetFrameId()) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002445 return true; // continue
Ian Rogers0399dde2012-06-06 17:09:28 -07002446 } else {
Ian Rogers62d6c772013-02-27 08:32:07 -08002447 this_object = GetThisObject();
2448 return false;
Ian Rogers0399dde2012-06-06 17:09:28 -07002449 }
Elliott Hughes86b00102011-12-05 17:54:26 -08002450 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002451
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002452 mirror::Object* this_object;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002453 JDWP::FrameId frame_id;
Ian Rogers0399dde2012-06-06 17:09:28 -07002454};
2455
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002456JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2457 JDWP::ObjectId* result) {
2458 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002459 JDWP::JdwpError error;
2460 Thread* thread = DecodeThread(soa, thread_id, &error);
2461 if (error != JDWP::ERR_NONE) {
2462 return error;
2463 }
2464 if (!IsSuspendedForDebugger(soa, thread)) {
2465 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002466 }
Ian Rogers700a4022014-05-19 16:49:03 -07002467 std::unique_ptr<Context> context(Context::Create());
Ian Rogers7a22fa62013-01-23 12:16:16 -08002468 GetThisVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002469 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002470 *result = gRegistry->Add(visitor.this_object);
2471 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002472}
2473
Sebastien Hertz8009f392014-09-01 17:07:11 +02002474// Walks the stack until we find the frame with the given FrameId.
2475class FindFrameVisitor FINAL : public StackVisitor {
2476 public:
2477 FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
Mathieu Chartier90443472015-07-16 20:32:27 -07002478 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002479 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2480 frame_id_(frame_id),
2481 error_(JDWP::ERR_INVALID_FRAMEID) {}
Ian Rogersca190662012-06-26 15:45:57 -07002482
Sebastien Hertz8009f392014-09-01 17:07:11 +02002483 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2484 // annotalysis.
2485 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2486 if (GetFrameId() != frame_id_) {
2487 return true; // Not our frame, carry on.
Ian Rogers0399dde2012-06-06 17:09:28 -07002488 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002489 ArtMethod* m = GetMethod();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002490 if (m->IsNative()) {
2491 // We can't read/write local value from/into native method.
2492 error_ = JDWP::ERR_OPAQUE_FRAME;
2493 } else {
2494 // We found our frame.
2495 error_ = JDWP::ERR_NONE;
2496 }
2497 return false;
2498 }
2499
2500 JDWP::JdwpError GetError() const {
2501 return error_;
2502 }
2503
2504 private:
2505 const JDWP::FrameId frame_id_;
2506 JDWP::JdwpError error_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002507
2508 DISALLOW_COPY_AND_ASSIGN(FindFrameVisitor);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002509};
2510
2511JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2512 JDWP::ObjectId thread_id = request->ReadThreadId();
2513 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002514
2515 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002516 JDWP::JdwpError error;
2517 Thread* thread = DecodeThread(soa, thread_id, &error);
2518 if (error != JDWP::ERR_NONE) {
2519 return error;
2520 }
2521 if (!IsSuspendedForDebugger(soa, thread)) {
2522 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002523 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002524 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002525 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002526 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002527 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002528 if (visitor.GetError() != JDWP::ERR_NONE) {
2529 return visitor.GetError();
2530 }
2531
2532 // Read the values from visitor's context.
2533 int32_t slot_count = request->ReadSigned32("slot count");
2534 expandBufAdd4BE(pReply, slot_count); /* "int values" */
2535 for (int32_t i = 0; i < slot_count; ++i) {
2536 uint32_t slot = request->ReadUnsigned32("slot");
2537 JDWP::JdwpTag reqSigByte = request->ReadTag();
2538
2539 VLOG(jdwp) << " --> slot " << slot << " " << reqSigByte;
2540
2541 size_t width = Dbg::GetTagWidth(reqSigByte);
Sebastien Hertz7d955652014-10-22 10:57:10 +02002542 uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
Sebastien Hertz69206392015-04-07 15:54:25 +02002543 error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002544 if (error != JDWP::ERR_NONE) {
2545 return error;
2546 }
2547 }
2548 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002549}
2550
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002551constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2552
2553static std::string GetStackContextAsString(const StackVisitor& visitor)
Mathieu Chartier90443472015-07-16 20:32:27 -07002554 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002555 return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
2556 PrettyMethod(visitor.GetMethod()).c_str());
2557}
2558
2559static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2560 JDWP::JdwpTag tag)
Mathieu Chartier90443472015-07-16 20:32:27 -07002561 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002562 LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2563 << GetStackContextAsString(visitor);
2564 return kStackFrameLocalAccessError;
2565}
2566
Sebastien Hertz8009f392014-09-01 17:07:11 +02002567JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2568 int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002569 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002570 JDWP::JdwpError error = JDWP::ERR_NONE;
2571 uint16_t vreg = DemangleSlot(slot, m, &error);
2572 if (error != JDWP::ERR_NONE) {
2573 return error;
2574 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002575 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002576 switch (tag) {
2577 case JDWP::JT_BOOLEAN: {
2578 CHECK_EQ(width, 1U);
2579 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002580 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2581 return FailGetLocalValue(visitor, vreg, tag);
Ian Rogers0399dde2012-06-06 17:09:28 -07002582 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002583 VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2584 JDWP::Set1(buf + 1, intVal != 0);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002585 break;
Ian Rogers0399dde2012-06-06 17:09:28 -07002586 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002587 case JDWP::JT_BYTE: {
2588 CHECK_EQ(width, 1U);
2589 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002590 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2591 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002592 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002593 VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2594 JDWP::Set1(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002595 break;
2596 }
2597 case JDWP::JT_SHORT:
2598 case JDWP::JT_CHAR: {
2599 CHECK_EQ(width, 2U);
2600 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002601 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2602 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002603 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002604 VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2605 JDWP::Set2BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002606 break;
2607 }
2608 case JDWP::JT_INT: {
2609 CHECK_EQ(width, 4U);
2610 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002611 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2612 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002613 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002614 VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2615 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002616 break;
2617 }
2618 case JDWP::JT_FLOAT: {
2619 CHECK_EQ(width, 4U);
2620 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002621 if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2622 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002623 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002624 VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2625 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002626 break;
2627 }
2628 case JDWP::JT_ARRAY:
2629 case JDWP::JT_CLASS_LOADER:
2630 case JDWP::JT_CLASS_OBJECT:
2631 case JDWP::JT_OBJECT:
2632 case JDWP::JT_STRING:
2633 case JDWP::JT_THREAD:
2634 case JDWP::JT_THREAD_GROUP: {
2635 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2636 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002637 if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2638 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002639 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002640 mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2641 VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2642 if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2643 LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2644 reinterpret_cast<uintptr_t>(o), vreg)
2645 << GetStackContextAsString(visitor);
2646 UNREACHABLE();
2647 }
2648 tag = TagFromObject(soa, o);
2649 JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002650 break;
2651 }
2652 case JDWP::JT_DOUBLE: {
2653 CHECK_EQ(width, 8U);
2654 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002655 if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2656 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002657 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002658 VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2659 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002660 break;
2661 }
2662 case JDWP::JT_LONG: {
2663 CHECK_EQ(width, 8U);
2664 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002665 if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2666 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002667 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002668 VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2669 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002670 break;
2671 }
2672 default:
2673 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002674 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002675 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002676
Sebastien Hertz8009f392014-09-01 17:07:11 +02002677 // Prepend tag, which may have been updated.
2678 JDWP::Set1(buf, tag);
2679 return JDWP::ERR_NONE;
2680}
2681
2682JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2683 JDWP::ObjectId thread_id = request->ReadThreadId();
2684 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002685
2686 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002687 JDWP::JdwpError error;
2688 Thread* thread = DecodeThread(soa, thread_id, &error);
2689 if (error != JDWP::ERR_NONE) {
2690 return error;
2691 }
2692 if (!IsSuspendedForDebugger(soa, thread)) {
2693 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002694 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002695 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002696 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002697 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002698 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002699 if (visitor.GetError() != JDWP::ERR_NONE) {
2700 return visitor.GetError();
2701 }
2702
2703 // Writes the values into visitor's context.
2704 int32_t slot_count = request->ReadSigned32("slot count");
2705 for (int32_t i = 0; i < slot_count; ++i) {
2706 uint32_t slot = request->ReadUnsigned32("slot");
2707 JDWP::JdwpTag sigByte = request->ReadTag();
2708 size_t width = Dbg::GetTagWidth(sigByte);
2709 uint64_t value = request->ReadValue(width);
2710
2711 VLOG(jdwp) << " --> slot " << slot << " " << sigByte << " " << value;
Mingyao Yang99170c62015-07-06 11:10:37 -07002712 error = Dbg::SetLocalValue(thread, visitor, slot, sigByte, value, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002713 if (error != JDWP::ERR_NONE) {
2714 return error;
2715 }
2716 }
2717 return JDWP::ERR_NONE;
2718}
2719
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002720template<typename T>
2721static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2722 JDWP::JdwpTag tag, T value)
Mathieu Chartier90443472015-07-16 20:32:27 -07002723 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002724 LOG(ERROR) << "Failed to write " << tag << " local " << value
2725 << " (0x" << std::hex << value << ") into register v" << vreg
2726 << GetStackContextAsString(visitor);
2727 return kStackFrameLocalAccessError;
2728}
2729
Mingyao Yang99170c62015-07-06 11:10:37 -07002730JDWP::JdwpError Dbg::SetLocalValue(Thread* thread, StackVisitor& visitor, int slot,
2731 JDWP::JdwpTag tag, uint64_t value, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002732 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002733 JDWP::JdwpError error = JDWP::ERR_NONE;
2734 uint16_t vreg = DemangleSlot(slot, m, &error);
2735 if (error != JDWP::ERR_NONE) {
2736 return error;
2737 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002738 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002739 switch (tag) {
2740 case JDWP::JT_BOOLEAN:
2741 case JDWP::JT_BYTE:
2742 CHECK_EQ(width, 1U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002743 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002744 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002745 }
2746 break;
2747 case JDWP::JT_SHORT:
2748 case JDWP::JT_CHAR:
2749 CHECK_EQ(width, 2U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002750 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002751 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002752 }
2753 break;
2754 case JDWP::JT_INT:
2755 CHECK_EQ(width, 4U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002756 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002757 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002758 }
2759 break;
2760 case JDWP::JT_FLOAT:
2761 CHECK_EQ(width, 4U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002762 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002763 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002764 }
2765 break;
2766 case JDWP::JT_ARRAY:
2767 case JDWP::JT_CLASS_LOADER:
2768 case JDWP::JT_CLASS_OBJECT:
2769 case JDWP::JT_OBJECT:
2770 case JDWP::JT_STRING:
2771 case JDWP::JT_THREAD:
2772 case JDWP::JT_THREAD_GROUP: {
2773 CHECK_EQ(width, sizeof(JDWP::ObjectId));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002774 mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2775 &error);
2776 if (error != JDWP::ERR_NONE) {
2777 VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2778 return JDWP::ERR_INVALID_OBJECT;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002779 }
Mingyao Yang636b9252015-07-31 16:40:24 -07002780 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002781 kReferenceVReg)) {
2782 return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002783 }
2784 break;
2785 }
2786 case JDWP::JT_DOUBLE: {
2787 CHECK_EQ(width, 8U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002788 if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002789 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002790 }
2791 break;
2792 }
2793 case JDWP::JT_LONG: {
2794 CHECK_EQ(width, 8U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002795 if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002796 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002797 }
2798 break;
2799 }
2800 default:
2801 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002802 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002803 }
Mingyao Yang99170c62015-07-06 11:10:37 -07002804
2805 // If we set the local variable in a compiled frame, we need to trigger a deoptimization of
2806 // the stack so we continue execution with the interpreter using the new value(s) of the updated
2807 // local variable(s). To achieve this, we install instrumentation exit stub on each method of the
2808 // thread's stack. The stub will cause the deoptimization to happen.
2809 if (!visitor.IsShadowFrame() && thread->HasDebuggerShadowFrames()) {
2810 Runtime::Current()->GetInstrumentation()->InstrumentThreadStack(thread);
2811 }
2812
Sebastien Hertz8009f392014-09-01 17:07:11 +02002813 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002814}
2815
Mathieu Chartiere401d142015-04-22 13:56:20 -07002816static void SetEventLocation(JDWP::EventLocation* location, ArtMethod* m, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -07002817 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002818 DCHECK(location != nullptr);
2819 if (m == nullptr) {
2820 memset(location, 0, sizeof(*location));
2821 } else {
Alex Light6c8467f2015-11-20 15:03:26 -08002822 location->method = GetCanonicalMethod(m);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002823 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002824 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002825}
2826
Mathieu Chartiere401d142015-04-22 13:56:20 -07002827void Dbg::PostLocationEvent(ArtMethod* m, int dex_pc, mirror::Object* this_object,
Jeff Hao579b0242013-11-18 13:16:49 -08002828 int event_flags, const JValue* return_value) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002829 if (!IsDebuggerActive()) {
2830 return;
2831 }
2832 DCHECK(m != nullptr);
2833 DCHECK_EQ(m->IsStatic(), this_object == nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002834 JDWP::EventLocation location;
2835 SetEventLocation(&location, m, dex_pc);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002836
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002837 // We need to be sure no exception is pending when calling JdwpState::PostLocationEvent.
2838 // This is required to be able to call JNI functions to create JDWP ids. To achieve this,
2839 // we temporarily clear the current thread's exception (if any) and will restore it after
2840 // the call.
2841 // Note: the only way to get a pending exception here is to suspend on a move-exception
2842 // instruction.
2843 Thread* const self = Thread::Current();
2844 StackHandleScope<1> hs(self);
2845 Handle<mirror::Throwable> pending_exception(hs.NewHandle(self->GetException()));
2846 self->ClearException();
2847 if (kIsDebugBuild && pending_exception.Get() != nullptr) {
2848 const DexFile::CodeItem* code_item = location.method->GetCodeItem();
2849 const Instruction* instr = Instruction::At(&code_item->insns_[location.dex_pc]);
2850 CHECK_EQ(Instruction::MOVE_EXCEPTION, instr->Opcode());
2851 }
2852
Sebastien Hertz6995c602014-09-09 12:10:13 +02002853 gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002854
2855 if (pending_exception.Get() != nullptr) {
2856 self->SetException(pending_exception.Get());
2857 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002858}
2859
Mathieu Chartiere401d142015-04-22 13:56:20 -07002860void Dbg::PostFieldAccessEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002861 mirror::Object* this_object, ArtField* f) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002862 if (!IsDebuggerActive()) {
2863 return;
2864 }
2865 DCHECK(m != nullptr);
2866 DCHECK(f != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002867 JDWP::EventLocation location;
2868 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002869
Sebastien Hertz6995c602014-09-09 12:10:13 +02002870 gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002871}
2872
Mathieu Chartiere401d142015-04-22 13:56:20 -07002873void Dbg::PostFieldModificationEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002874 mirror::Object* this_object, ArtField* f,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002875 const JValue* field_value) {
2876 if (!IsDebuggerActive()) {
2877 return;
2878 }
2879 DCHECK(m != nullptr);
2880 DCHECK(f != nullptr);
2881 DCHECK(field_value != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002882 JDWP::EventLocation location;
2883 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002884
Sebastien Hertz6995c602014-09-09 12:10:13 +02002885 gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002886}
2887
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002888/**
2889 * Finds the location where this exception will be caught. We search until we reach the top
2890 * frame, in which case this exception is considered uncaught.
2891 */
2892class CatchLocationFinder : public StackVisitor {
2893 public:
2894 CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
Mathieu Chartier90443472015-07-16 20:32:27 -07002895 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002896 : StackVisitor(self, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002897 exception_(exception),
2898 handle_scope_(self),
2899 this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002900 catch_method_(nullptr),
2901 throw_method_(nullptr),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002902 catch_dex_pc_(DexFile::kDexNoIndex),
2903 throw_dex_pc_(DexFile::kDexNoIndex) {
2904 }
2905
Mathieu Chartier90443472015-07-16 20:32:27 -07002906 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002907 ArtMethod* method = GetMethod();
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002908 DCHECK(method != nullptr);
2909 if (method->IsRuntimeMethod()) {
2910 // Ignore callee save method.
2911 DCHECK(method->IsCalleeSaveMethod());
2912 return true;
2913 }
2914
2915 uint32_t dex_pc = GetDexPc();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002916 if (throw_method_ == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002917 // First Java method found. It is either the method that threw the exception,
2918 // or the Java native method that is reporting an exception thrown by
2919 // native code.
2920 this_at_throw_.Assign(GetThisObject());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002921 throw_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002922 throw_dex_pc_ = dex_pc;
2923 }
2924
2925 if (dex_pc != DexFile::kDexNoIndex) {
Sebastien Hertz26f72862015-09-15 09:52:07 +02002926 StackHandleScope<1> hs(GetThread());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002927 uint32_t found_dex_pc;
2928 Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002929 bool unused_clear_exception;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002930 found_dex_pc = method->FindCatchBlock(exception_class, dex_pc, &unused_clear_exception);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002931 if (found_dex_pc != DexFile::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002932 catch_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002933 catch_dex_pc_ = found_dex_pc;
2934 return false; // End stack walk.
2935 }
2936 }
2937 return true; // Continue stack walk.
2938 }
2939
Mathieu Chartier90443472015-07-16 20:32:27 -07002940 ArtMethod* GetCatchMethod() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002941 return catch_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002942 }
2943
Mathieu Chartier90443472015-07-16 20:32:27 -07002944 ArtMethod* GetThrowMethod() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002945 return throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002946 }
2947
Mathieu Chartier90443472015-07-16 20:32:27 -07002948 mirror::Object* GetThisAtThrow() SHARED_REQUIRES(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002949 return this_at_throw_.Get();
2950 }
2951
2952 uint32_t GetCatchDexPc() const {
2953 return catch_dex_pc_;
2954 }
2955
2956 uint32_t GetThrowDexPc() const {
2957 return throw_dex_pc_;
2958 }
2959
2960 private:
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002961 const Handle<mirror::Throwable>& exception_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002962 StackHandleScope<1> handle_scope_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002963 MutableHandle<mirror::Object> this_at_throw_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002964 ArtMethod* catch_method_;
2965 ArtMethod* throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002966 uint32_t catch_dex_pc_;
2967 uint32_t throw_dex_pc_;
2968
2969 DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
2970};
2971
2972void Dbg::PostException(mirror::Throwable* exception_object) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07002973 if (!IsDebuggerActive()) {
Ian Rogers0ad5bb82011-12-07 10:16:32 -08002974 return;
2975 }
Sebastien Hertz261bc042015-04-08 09:36:07 +02002976 Thread* const self = Thread::Current();
2977 StackHandleScope<1> handle_scope(self);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002978 Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
2979 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz261bc042015-04-08 09:36:07 +02002980 CatchLocationFinder clf(self, h_exception, context.get());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002981 clf.WalkStack(/* include_transitions */ false);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002982 JDWP::EventLocation exception_throw_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002983 SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
Sebastien Hertz6995c602014-09-09 12:10:13 +02002984 JDWP::EventLocation exception_catch_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002985 SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
Elliott Hughes4740cdf2011-12-07 14:07:12 -08002986
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002987 gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
2988 clf.GetThisAtThrow());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002989}
2990
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002991void Dbg::PostClassPrepare(mirror::Class* c) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07002992 if (!IsDebuggerActive()) {
Elliott Hughes4740cdf2011-12-07 14:07:12 -08002993 return;
2994 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02002995 gJdwpState->PostClassPrepare(c);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002996}
2997
Ian Rogers62d6c772013-02-27 08:32:07 -08002998void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -07002999 ArtMethod* m, uint32_t dex_pc,
Sebastien Hertz8379b222014-02-24 17:38:15 +01003000 int event_flags, const JValue* return_value) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003001 if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
Elliott Hughes2aa2e392012-02-17 17:15:43 -08003002 return;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003003 }
3004
Elliott Hughes86964332012-02-15 19:37:42 -08003005 if (IsBreakpoint(m, dex_pc)) {
3006 event_flags |= kBreakpoint;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003007 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003008
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003009 // If the debugger is single-stepping one of our threads, check to
3010 // see if we're that thread and we've reached a step point.
3011 const SingleStepControl* single_step_control = thread->GetSingleStepControl();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003012 if (single_step_control != nullptr) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003013 CHECK(!m->IsNative());
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003014 if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003015 // Step into method calls. We break when the line number
3016 // or method pointer changes. If we're in SS_MIN mode, we
3017 // always stop.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003018 if (single_step_control->GetMethod() != m) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003019 event_flags |= kSingleStep;
3020 VLOG(jdwp) << "SS new method";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003021 } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003022 event_flags |= kSingleStep;
3023 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003024 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003025 event_flags |= kSingleStep;
3026 VLOG(jdwp) << "SS new line";
3027 }
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003028 } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003029 // Step over method calls. We break when the line number is
3030 // different and the frame depth is <= the original frame
3031 // depth. (We can't just compare on the method, because we
3032 // might get unrolled past it by an exception, and it's tricky
3033 // to identify recursion.)
3034
3035 int stack_depth = GetStackDepth(thread);
3036
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003037 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003038 // Popped up one or more frames, always trigger.
3039 event_flags |= kSingleStep;
3040 VLOG(jdwp) << "SS method pop";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003041 } else if (stack_depth == single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003042 // Same depth, see if we moved.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003043 if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Elliott Hughes86964332012-02-15 19:37:42 -08003044 event_flags |= kSingleStep;
3045 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003046 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003047 event_flags |= kSingleStep;
3048 VLOG(jdwp) << "SS new line";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003049 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003050 }
3051 } else {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003052 CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003053 // Return from the current method. We break when the frame
3054 // depth pops up.
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003055
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003056 // This differs from the "method exit" break in that it stops
3057 // with the PC at the next instruction in the returned-to
3058 // function, rather than the end of the returning function.
Elliott Hughes86964332012-02-15 19:37:42 -08003059
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003060 int stack_depth = GetStackDepth(thread);
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003061 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003062 event_flags |= kSingleStep;
3063 VLOG(jdwp) << "SS method pop";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003064 }
3065 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003066 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003067
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003068 // If there's something interesting going on, see if it matches one
3069 // of the debugger filters.
3070 if (event_flags != 0) {
Sebastien Hertz8379b222014-02-24 17:38:15 +01003071 Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003072 }
3073}
3074
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003075size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
3076 switch (instrumentation_event) {
3077 case instrumentation::Instrumentation::kMethodEntered:
3078 return &method_enter_event_ref_count_;
3079 case instrumentation::Instrumentation::kMethodExited:
3080 return &method_exit_event_ref_count_;
3081 case instrumentation::Instrumentation::kDexPcMoved:
3082 return &dex_pc_change_event_ref_count_;
3083 case instrumentation::Instrumentation::kFieldRead:
3084 return &field_read_event_ref_count_;
3085 case instrumentation::Instrumentation::kFieldWritten:
3086 return &field_write_event_ref_count_;
3087 case instrumentation::Instrumentation::kExceptionCaught:
3088 return &exception_catch_event_ref_count_;
3089 default:
3090 return nullptr;
3091 }
3092}
3093
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003094// Process request while all mutator threads are suspended.
3095void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003096 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003097 switch (request.GetKind()) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003098 case DeoptimizationRequest::kNothing:
3099 LOG(WARNING) << "Ignoring empty deoptimization request.";
3100 break;
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003101 case DeoptimizationRequest::kRegisterForEvent:
3102 VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003103 request.InstrumentationEvent());
3104 instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
3105 instrumentation_events_ |= request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003106 break;
3107 case DeoptimizationRequest::kUnregisterForEvent:
3108 VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003109 request.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003110 instrumentation->RemoveListener(&gDebugInstrumentationListener,
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003111 request.InstrumentationEvent());
3112 instrumentation_events_ &= ~request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003113 break;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003114 case DeoptimizationRequest::kFullDeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003115 VLOG(jdwp) << "Deoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003116 instrumentation->DeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003117 VLOG(jdwp) << "Deoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003118 break;
3119 case DeoptimizationRequest::kFullUndeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003120 VLOG(jdwp) << "Undeoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003121 instrumentation->UndeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003122 VLOG(jdwp) << "Undeoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003123 break;
3124 case DeoptimizationRequest::kSelectiveDeoptimization:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003125 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " ...";
3126 instrumentation->Deoptimize(request.Method());
3127 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003128 break;
3129 case DeoptimizationRequest::kSelectiveUndeoptimization:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003130 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " ...";
3131 instrumentation->Undeoptimize(request.Method());
3132 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003133 break;
3134 default:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003135 LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003136 break;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003137 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003138}
3139
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003140void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003141 if (req.GetKind() == DeoptimizationRequest::kNothing) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003142 // Nothing to do.
3143 return;
3144 }
Brian Carlstrom306db812014-09-05 13:01:41 -07003145 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003146 RequestDeoptimizationLocked(req);
3147}
3148
3149void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003150 switch (req.GetKind()) {
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003151 case DeoptimizationRequest::kRegisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003152 DCHECK_NE(req.InstrumentationEvent(), 0u);
3153 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003154 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003155 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003156 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003157 VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003158 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003159 deoptimization_requests_.push_back(req);
3160 }
3161 *counter = *counter + 1;
3162 break;
3163 }
3164 case DeoptimizationRequest::kUnregisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003165 DCHECK_NE(req.InstrumentationEvent(), 0u);
3166 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003167 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003168 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003169 *counter = *counter - 1;
3170 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003171 VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003172 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003173 deoptimization_requests_.push_back(req);
3174 }
3175 break;
3176 }
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003177 case DeoptimizationRequest::kFullDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003178 DCHECK(req.Method() == nullptr);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003179 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003180 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3181 << " for full deoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003182 deoptimization_requests_.push_back(req);
3183 }
3184 ++full_deoptimization_event_count_;
3185 break;
3186 }
3187 case DeoptimizationRequest::kFullUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003188 DCHECK(req.Method() == nullptr);
Sebastien Hertze713d932014-05-15 10:48:53 +02003189 DCHECK_GT(full_deoptimization_event_count_, 0U);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003190 --full_deoptimization_event_count_;
3191 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003192 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3193 << " for full undeoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003194 deoptimization_requests_.push_back(req);
3195 }
3196 break;
3197 }
3198 case DeoptimizationRequest::kSelectiveDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003199 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003200 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003201 << " for deoptimization of " << PrettyMethod(req.Method());
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003202 deoptimization_requests_.push_back(req);
3203 break;
3204 }
3205 case DeoptimizationRequest::kSelectiveUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003206 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003207 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003208 << " for undeoptimization of " << PrettyMethod(req.Method());
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003209 deoptimization_requests_.push_back(req);
3210 break;
3211 }
3212 default: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003213 LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003214 break;
3215 }
3216 }
3217}
3218
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003219void Dbg::ManageDeoptimization() {
3220 Thread* const self = Thread::Current();
3221 {
3222 // Avoid suspend/resume if there is no pending request.
Brian Carlstrom306db812014-09-05 13:01:41 -07003223 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003224 if (deoptimization_requests_.empty()) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003225 return;
3226 }
3227 }
3228 CHECK_EQ(self->GetState(), kRunnable);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003229 ScopedThreadSuspension sts(self, kWaitingForDeoptimization);
Mathieu Chartieraa516822015-10-02 15:53:37 -07003230 // Required for ProcessDeoptimizationRequest.
3231 gc::ScopedGCCriticalSection gcs(self,
3232 gc::kGcCauseInstrumentation,
3233 gc::kCollectorTypeInstrumentation);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003234 // We need to suspend mutator threads first.
Mathieu Chartier4f55e222015-09-04 13:26:21 -07003235 ScopedSuspendAll ssa(__FUNCTION__);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003236 const ThreadState old_state = self->SetStateUnsafe(kRunnable);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003237 {
Brian Carlstrom306db812014-09-05 13:01:41 -07003238 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003239 size_t req_index = 0;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003240 for (DeoptimizationRequest& request : deoptimization_requests_) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003241 VLOG(jdwp) << "Process deoptimization request #" << req_index++;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003242 ProcessDeoptimizationRequest(request);
3243 }
3244 deoptimization_requests_.clear();
3245 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003246 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003247}
3248
Mathieu Chartiere401d142015-04-22 13:56:20 -07003249static const Breakpoint* FindFirstBreakpointForMethod(ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07003250 SHARED_REQUIRES(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003251 for (Breakpoint& breakpoint : gBreakpoints) {
Alex Light6c8467f2015-11-20 15:03:26 -08003252 if (breakpoint.IsInMethod(m)) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003253 return &breakpoint;
3254 }
3255 }
3256 return nullptr;
3257}
3258
Mathieu Chartiere401d142015-04-22 13:56:20 -07003259bool Dbg::MethodHasAnyBreakpoints(ArtMethod* method) {
Mathieu Chartierd8565452015-03-26 09:41:50 -07003260 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3261 return FindFirstBreakpointForMethod(method) != nullptr;
3262}
3263
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003264// Sanity checks all existing breakpoints on the same method.
Mathieu Chartiere401d142015-04-22 13:56:20 -07003265static void SanityCheckExistingBreakpoints(ArtMethod* m,
Sebastien Hertzf3928792014-11-17 19:00:37 +01003266 DeoptimizationRequest::Kind deoptimization_kind)
Mathieu Chartier90443472015-07-16 20:32:27 -07003267 SHARED_REQUIRES(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003268 for (const Breakpoint& breakpoint : gBreakpoints) {
Alex Light6c8467f2015-11-20 15:03:26 -08003269 if (breakpoint.IsInMethod(m)) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003270 CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3271 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003272 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003273 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3274 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003275 // We should have deoptimized everything but not "selectively" deoptimized this method.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003276 CHECK(instrumentation->AreAllMethodsDeoptimized());
3277 CHECK(!instrumentation->IsDeoptimized(m));
3278 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003279 // We should have "selectively" deoptimized this method.
3280 // Note: while we have not deoptimized everything for this method, we may have done it for
3281 // another event.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003282 CHECK(instrumentation->IsDeoptimized(m));
3283 } else {
3284 // This method does not require deoptimization.
3285 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3286 CHECK(!instrumentation->IsDeoptimized(m));
3287 }
3288}
3289
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003290// Returns the deoptimization kind required to set a breakpoint in a method.
3291// If a breakpoint has already been set, we also return the first breakpoint
3292// through the given 'existing_brkpt' pointer.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003293static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003294 ArtMethod* m,
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003295 const Breakpoint** existing_brkpt)
Mathieu Chartier90443472015-07-16 20:32:27 -07003296 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003297 if (!Dbg::RequiresDeoptimization()) {
3298 // We already run in interpreter-only mode so we don't need to deoptimize anything.
3299 VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
3300 << PrettyMethod(m);
3301 return DeoptimizationRequest::kNothing;
3302 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003303 const Breakpoint* first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003304 {
3305 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003306 first_breakpoint = FindFirstBreakpointForMethod(m);
3307 *existing_brkpt = first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003308 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003309
3310 if (first_breakpoint == nullptr) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003311 // There is no breakpoint on this method yet: we need to deoptimize. If this method is default,
3312 // we deoptimize everything; otherwise we deoptimize only this method. We
Alex Light6c8467f2015-11-20 15:03:26 -08003313 // deoptimize with defaults because we do not know everywhere they are used. It is possible some
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003314 // of the copies could be missed.
Alex Light6c8467f2015-11-20 15:03:26 -08003315 // TODO Deoptimizing on default methods might not be necessary in all cases.
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003316 bool need_full_deoptimization = m->IsDefault();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003317 if (need_full_deoptimization) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003318 VLOG(jdwp) << "Need full deoptimization because of copying of method "
Sebastien Hertzf3928792014-11-17 19:00:37 +01003319 << PrettyMethod(m);
3320 return DeoptimizationRequest::kFullDeoptimization;
3321 } else {
3322 // We don't need to deoptimize if the method has not been compiled.
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00003323 const bool is_compiled = m->HasAnyCompiledCode();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003324 if (is_compiled) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003325 VLOG(jdwp) << "Need selective deoptimization for compiled method " << PrettyMethod(m);
3326 return DeoptimizationRequest::kSelectiveDeoptimization;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003327 } else {
3328 // Method is not compiled: we don't need to deoptimize.
3329 VLOG(jdwp) << "No need for deoptimization for non-compiled method " << PrettyMethod(m);
3330 return DeoptimizationRequest::kNothing;
3331 }
3332 }
3333 } else {
3334 // There is at least one breakpoint for this method: we don't need to deoptimize.
3335 // Let's check that all breakpoints are configured the same way for deoptimization.
3336 VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003337 DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003338 if (kIsDebugBuild) {
3339 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3340 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3341 }
3342 return DeoptimizationRequest::kNothing;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003343 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003344}
3345
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003346// Installs a breakpoint at the specified location. Also indicates through the deoptimization
3347// request if we need to deoptimize.
3348void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3349 Thread* const self = Thread::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003350 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003351 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003352
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003353 const Breakpoint* existing_breakpoint = nullptr;
3354 const DeoptimizationRequest::Kind deoptimization_kind =
3355 GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003356 req->SetKind(deoptimization_kind);
3357 if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3358 req->SetMethod(m);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003359 } else {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003360 CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3361 deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003362 req->SetMethod(nullptr);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003363 }
3364
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003365 {
3366 WriterMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003367 // If there is at least one existing breakpoint on the same method, the new breakpoint
3368 // must have the same deoptimization kind than the existing breakpoint(s).
3369 DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3370 if (existing_breakpoint != nullptr) {
3371 breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3372 } else {
3373 breakpoint_deoptimization_kind = deoptimization_kind;
3374 }
3375 gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003376 VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3377 << gBreakpoints[gBreakpoints.size() - 1];
3378 }
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003379}
3380
3381// Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3382// request if we need to undeoptimize.
3383void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
Sebastien Hertzed2be172014-08-19 15:33:43 +02003384 WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003385 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003386 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003387 DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003388 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Alex Light6c8467f2015-11-20 15:03:26 -08003389 if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].IsInMethod(m)) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003390 VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
Sebastien Hertzf3928792014-11-17 19:00:37 +01003391 deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3392 DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3393 Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003394 gBreakpoints.erase(gBreakpoints.begin() + i);
3395 break;
3396 }
3397 }
3398 const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3399 if (existing_breakpoint == nullptr) {
3400 // There is no more breakpoint on this method: we need to undeoptimize.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003401 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003402 // This method required full deoptimization: we need to undeoptimize everything.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003403 req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3404 req->SetMethod(nullptr);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003405 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003406 // This method required selective deoptimization: we need to undeoptimize only that method.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003407 req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3408 req->SetMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003409 } else {
3410 // This method had no need for deoptimization: do nothing.
3411 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3412 req->SetKind(DeoptimizationRequest::kNothing);
3413 req->SetMethod(nullptr);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003414 }
3415 } else {
3416 // There is at least one breakpoint for this method: we don't need to undeoptimize.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003417 req->SetKind(DeoptimizationRequest::kNothing);
3418 req->SetMethod(nullptr);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003419 if (kIsDebugBuild) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003420 SanityCheckExistingBreakpoints(m, deoptimization_kind);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003421 }
Elliott Hughes86964332012-02-15 19:37:42 -08003422 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003423}
3424
Mathieu Chartiere401d142015-04-22 13:56:20 -07003425bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003426 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3427 if (ssc == nullptr) {
3428 // If we are not single-stepping, then we don't have to force interpreter.
3429 return false;
3430 }
3431 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3432 // If we are in interpreter only mode, then we don't have to force interpreter.
3433 return false;
3434 }
3435
3436 if (!m->IsNative() && !m->IsProxyMethod()) {
3437 // If we want to step into a method, then we have to force interpreter on that call.
3438 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3439 return true;
3440 }
3441 }
3442 return false;
3443}
3444
Mathieu Chartiere401d142015-04-22 13:56:20 -07003445bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003446 instrumentation::Instrumentation* const instrumentation =
3447 Runtime::Current()->GetInstrumentation();
3448 // If we are in interpreter only mode, then we don't have to force interpreter.
3449 if (instrumentation->InterpretOnly()) {
3450 return false;
3451 }
3452 // We can only interpret pure Java method.
3453 if (m->IsNative() || m->IsProxyMethod()) {
3454 return false;
3455 }
3456 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3457 if (ssc != nullptr) {
3458 // If we want to step into a method, then we have to force interpreter on that call.
3459 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3460 return true;
3461 }
3462 // If we are stepping out from a static initializer, by issuing a step
3463 // in or step over, that was implicitly invoked by calling a static method,
3464 // then we need to step into that method. Having a lower stack depth than
3465 // the one the single step control has indicates that the step originates
3466 // from the static initializer.
3467 if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3468 ssc->GetStackDepth() > GetStackDepth(thread)) {
3469 return true;
3470 }
3471 }
3472 // There are cases where we have to force interpreter on deoptimized methods,
3473 // because in some cases the call will not be performed by invoking an entry
3474 // point that has been replaced by the deoptimization, but instead by directly
3475 // invoking the compiled code of the method, for example.
3476 return instrumentation->IsDeoptimized(m);
3477}
3478
Mathieu Chartiere401d142015-04-22 13:56:20 -07003479bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003480 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003481 if (m == nullptr) {
3482 return false;
3483 }
3484 instrumentation::Instrumentation* const instrumentation =
3485 Runtime::Current()->GetInstrumentation();
3486 // If we are in interpreter only mode, then we don't have to force interpreter.
3487 if (instrumentation->InterpretOnly()) {
3488 return false;
3489 }
3490 // We can only interpret pure Java method.
3491 if (m->IsNative() || m->IsProxyMethod()) {
3492 return false;
3493 }
3494 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3495 if (ssc != nullptr) {
3496 // If we are stepping out from a static initializer, by issuing a step
3497 // out, that was implicitly invoked by calling a static method, then we
3498 // need to step into the caller of that method. Having a lower stack
3499 // depth than the one the single step control has indicates that the
3500 // step originates from the static initializer.
3501 if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3502 ssc->GetStackDepth() > GetStackDepth(thread)) {
3503 return true;
3504 }
3505 }
3506 // If we are returning from a static intializer, that was implicitly
3507 // invoked by calling a static method and the caller is deoptimized,
3508 // then we have to deoptimize the stack without forcing interpreter
3509 // on the static method that was called originally. This problem can
3510 // be solved easily by forcing instrumentation on the called method,
3511 // because the instrumentation exit hook will recognise the need of
3512 // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3513 return instrumentation->IsDeoptimized(m);
3514}
3515
Mathieu Chartiere401d142015-04-22 13:56:20 -07003516bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003517 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003518 if (m == nullptr) {
3519 return false;
3520 }
3521 instrumentation::Instrumentation* const instrumentation =
3522 Runtime::Current()->GetInstrumentation();
3523 // If we are in interpreter only mode, then we don't have to force interpreter.
3524 if (instrumentation->InterpretOnly()) {
3525 return false;
3526 }
3527 // We can only interpret pure Java method.
3528 if (m->IsNative() || m->IsProxyMethod()) {
3529 return false;
3530 }
3531 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3532 if (ssc != nullptr) {
3533 // The debugger is not interested in what is happening under the level
3534 // of the step, thus we only force interpreter when we are not below of
3535 // the step.
3536 if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3537 return true;
3538 }
3539 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003540 if (thread->HasDebuggerShadowFrames()) {
3541 // We need to deoptimize the stack for the exception handling flow so that
3542 // we don't miss any deoptimization that should be done when there are
3543 // debugger shadow frames.
3544 return true;
3545 }
Daniel Mihalyieb076692014-08-22 17:33:31 +02003546 // We have to require stack deoptimization if the upcall is deoptimized.
3547 return instrumentation->IsDeoptimized(m);
3548}
3549
Mingyao Yang99170c62015-07-06 11:10:37 -07003550class NeedsDeoptimizationVisitor : public StackVisitor {
Sebastien Hertz520633b2015-09-08 17:03:36 +02003551 public:
3552 explicit NeedsDeoptimizationVisitor(Thread* self)
3553 SHARED_REQUIRES(Locks::mutator_lock_)
3554 : StackVisitor(self, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3555 needs_deoptimization_(false) {}
3556
3557 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
3558 // The visitor is meant to be used when handling exception from compiled code only.
3559 CHECK(!IsShadowFrame()) << "We only expect to visit compiled frame: " << PrettyMethod(GetMethod());
3560 ArtMethod* method = GetMethod();
3561 if (method == nullptr) {
3562 // We reach an upcall and don't need to deoptimize this part of the stack (ManagedFragment)
3563 // so we can stop the visit.
3564 DCHECK(!needs_deoptimization_);
3565 return false;
3566 }
3567 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3568 // We found a compiled frame in the stack but instrumentation is set to interpret
3569 // everything: we need to deoptimize.
3570 needs_deoptimization_ = true;
3571 return false;
3572 }
3573 if (Runtime::Current()->GetInstrumentation()->IsDeoptimized(method)) {
3574 // We found a deoptimized method in the stack.
3575 needs_deoptimization_ = true;
3576 return false;
3577 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003578 ShadowFrame* frame = GetThread()->FindDebuggerShadowFrame(GetFrameId());
3579 if (frame != nullptr) {
3580 // The debugger allocated a ShadowFrame to update a variable in the stack: we need to
3581 // deoptimize the stack to execute (and deallocate) this frame.
3582 needs_deoptimization_ = true;
3583 return false;
3584 }
Sebastien Hertz520633b2015-09-08 17:03:36 +02003585 return true;
3586 }
3587
3588 bool NeedsDeoptimization() const {
3589 return needs_deoptimization_;
3590 }
3591
3592 private:
3593 // Do we need to deoptimize the stack?
3594 bool needs_deoptimization_;
3595
3596 DISALLOW_COPY_AND_ASSIGN(NeedsDeoptimizationVisitor);
3597};
3598
3599// Do we need to deoptimize the stack to handle an exception?
3600bool Dbg::IsForcedInterpreterNeededForExceptionImpl(Thread* thread) {
3601 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3602 if (ssc != nullptr) {
3603 // We deopt to step into the catch handler.
3604 return true;
3605 }
3606 // Deoptimization is required if at least one method in the stack needs it. However we
3607 // skip frames that will be unwound (thus not executed).
3608 NeedsDeoptimizationVisitor visitor(thread);
3609 visitor.WalkStack(true); // includes upcall.
3610 return visitor.NeedsDeoptimization();
3611}
3612
Jeff Hao449db332013-04-12 18:30:52 -07003613// Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3614// cause suspension if the thread is the current thread.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003615class ScopedDebuggerThreadSuspension {
Jeff Hao449db332013-04-12 18:30:52 -07003616 public:
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003617 ScopedDebuggerThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
Mathieu Chartier90443472015-07-16 20:32:27 -07003618 REQUIRES(!Locks::thread_list_lock_)
3619 SHARED_REQUIRES(Locks::mutator_lock_) :
Ian Rogersf3d874c2014-07-17 18:52:42 -07003620 thread_(nullptr),
Jeff Hao449db332013-04-12 18:30:52 -07003621 error_(JDWP::ERR_NONE),
3622 self_suspend_(false),
Ian Rogers33e95662013-05-20 20:29:14 -07003623 other_suspend_(false) {
Jeff Hao449db332013-04-12 18:30:52 -07003624 ScopedObjectAccessUnchecked soa(self);
Sebastien Hertz69206392015-04-07 15:54:25 +02003625 thread_ = DecodeThread(soa, thread_id, &error_);
Jeff Hao449db332013-04-12 18:30:52 -07003626 if (error_ == JDWP::ERR_NONE) {
3627 if (thread_ == soa.Self()) {
3628 self_suspend_ = true;
3629 } else {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003630 Thread* suspended_thread;
3631 {
3632 ScopedThreadSuspension sts(self, kWaitingForDebuggerSuspension);
3633 jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
3634 bool timed_out;
3635 ThreadList* const thread_list = Runtime::Current()->GetThreadList();
3636 suspended_thread = thread_list->SuspendThreadByPeer(thread_peer, true, true, &timed_out);
3637 }
Ian Rogersf3d874c2014-07-17 18:52:42 -07003638 if (suspended_thread == nullptr) {
Jeff Hao449db332013-04-12 18:30:52 -07003639 // Thread terminated from under us while suspending.
3640 error_ = JDWP::ERR_INVALID_THREAD;
3641 } else {
3642 CHECK_EQ(suspended_thread, thread_);
3643 other_suspend_ = true;
3644 }
3645 }
3646 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003647 }
Elliott Hughes86964332012-02-15 19:37:42 -08003648
Jeff Hao449db332013-04-12 18:30:52 -07003649 Thread* GetThread() const {
3650 return thread_;
3651 }
3652
3653 JDWP::JdwpError GetError() const {
3654 return error_;
3655 }
3656
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003657 ~ScopedDebuggerThreadSuspension() {
Jeff Hao449db332013-04-12 18:30:52 -07003658 if (other_suspend_) {
3659 Runtime::Current()->GetThreadList()->Resume(thread_, true);
3660 }
3661 }
3662
3663 private:
3664 Thread* thread_;
3665 JDWP::JdwpError error_;
3666 bool self_suspend_;
3667 bool other_suspend_;
3668};
3669
3670JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3671 JDWP::JdwpStepDepth step_depth) {
3672 Thread* self = Thread::Current();
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003673 ScopedDebuggerThreadSuspension sts(self, thread_id);
Jeff Hao449db332013-04-12 18:30:52 -07003674 if (sts.GetError() != JDWP::ERR_NONE) {
3675 return sts.GetError();
3676 }
3677
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003678 // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
Elliott Hughes2435a572012-02-17 16:07:41 -08003679 // is for step-out.
Ian Rogers0399dde2012-06-06 17:09:28 -07003680 struct SingleStepStackVisitor : public StackVisitor {
Mathieu Chartier90443472015-07-16 20:32:27 -07003681 explicit SingleStepStackVisitor(Thread* thread) SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003682 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3683 stack_depth(0),
3684 method(nullptr),
3685 line_number(-1) {}
Ian Rogersca190662012-06-26 15:45:57 -07003686
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003687 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3688 // annotalysis.
3689 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003690 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07003691 if (!m->IsRuntimeMethod()) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003692 ++stack_depth;
3693 if (method == nullptr) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08003694 mirror::DexCache* dex_cache = m->GetDeclaringClass()->GetDexCache();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003695 method = m;
Ian Rogersc0542af2014-09-03 16:16:56 -07003696 if (dex_cache != nullptr) {
Ian Rogers4445a7e2012-10-05 17:19:13 -07003697 const DexFile& dex_file = *dex_cache->GetDexFile();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003698 line_number = dex_file.GetLineNumFromPC(m, GetDexPc());
Elliott Hughes2435a572012-02-17 16:07:41 -08003699 }
Elliott Hughes86964332012-02-15 19:37:42 -08003700 }
3701 }
Elliott Hughes530fa002012-03-12 11:44:49 -07003702 return true;
Elliott Hughes86964332012-02-15 19:37:42 -08003703 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003704
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003705 int stack_depth;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003706 ArtMethod* method;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003707 int32_t line_number;
Elliott Hughes86964332012-02-15 19:37:42 -08003708 };
Jeff Hao449db332013-04-12 18:30:52 -07003709
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003710 Thread* const thread = sts.GetThread();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003711 SingleStepStackVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07003712 visitor.WalkStack();
Elliott Hughes86964332012-02-15 19:37:42 -08003713
Elliott Hughes2435a572012-02-17 16:07:41 -08003714 // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
Elliott Hughes2435a572012-02-17 16:07:41 -08003715 struct DebugCallbackContext {
Roland Levillain3887c462015-08-12 18:15:42 +01003716 DebugCallbackContext(SingleStepControl* single_step_control_cb,
3717 int32_t line_number_cb, const DexFile::CodeItem* code_item)
3718 : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
3719 code_item_(code_item), last_pc_valid(false), last_pc(0) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003720 }
3721
David Srbeckyb06e28e2015-12-10 13:15:00 +00003722 static bool Callback(void* raw_context, const DexFile::PositionInfo& entry) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003723 DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
David Srbeckyb06e28e2015-12-10 13:15:00 +00003724 if (static_cast<int32_t>(entry.line_) == context->line_number_) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003725 if (!context->last_pc_valid) {
3726 // Everything from this address until the next line change is ours.
David Srbeckyb06e28e2015-12-10 13:15:00 +00003727 context->last_pc = entry.address_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003728 context->last_pc_valid = true;
3729 }
3730 // Otherwise, if we're already in a valid range for this line,
3731 // just keep going (shouldn't really happen)...
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003732 } else if (context->last_pc_valid) { // and the line number is new
Elliott Hughes2435a572012-02-17 16:07:41 -08003733 // Add everything from the last entry up until here to the set
David Srbeckyb06e28e2015-12-10 13:15:00 +00003734 for (uint32_t dex_pc = context->last_pc; dex_pc < entry.address_; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003735 context->single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003736 }
3737 context->last_pc_valid = false;
3738 }
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003739 return false; // There may be multiple entries for any given line.
Elliott Hughes2435a572012-02-17 16:07:41 -08003740 }
3741
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003742 ~DebugCallbackContext() {
Elliott Hughes2435a572012-02-17 16:07:41 -08003743 // If the line number was the last in the position table...
3744 if (last_pc_valid) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003745 size_t end = code_item_->insns_size_in_code_units_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003746 for (uint32_t dex_pc = last_pc; dex_pc < end; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003747 single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003748 }
3749 }
3750 }
3751
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003752 SingleStepControl* const single_step_control_;
3753 const int32_t line_number_;
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003754 const DexFile::CodeItem* const code_item_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003755 bool last_pc_valid;
3756 uint32_t last_pc;
3757 };
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003758
3759 // Allocate single step.
Sebastien Hertz1558b572015-02-25 15:05:59 +01003760 SingleStepControl* single_step_control =
3761 new (std::nothrow) SingleStepControl(step_size, step_depth,
3762 visitor.stack_depth, visitor.method);
3763 if (single_step_control == nullptr) {
3764 LOG(ERROR) << "Failed to allocate SingleStepControl";
3765 return JDWP::ERR_OUT_OF_MEMORY;
3766 }
3767
Mathieu Chartiere401d142015-04-22 13:56:20 -07003768 ArtMethod* m = single_step_control->GetMethod();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003769 const int32_t line_number = visitor.line_number;
Sebastien Hertz52f5f932015-05-28 11:00:57 +02003770 // Note: if the thread is not running Java code (pure native thread), there is no "current"
3771 // method on the stack (and no line number either).
3772 if (m != nullptr && !m->IsNative()) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003773 const DexFile::CodeItem* const code_item = m->GetCodeItem();
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003774 DebugCallbackContext context(single_step_control, line_number, code_item);
David Srbeckyb06e28e2015-12-10 13:15:00 +00003775 m->GetDexFile()->DecodeDebugPositionInfo(code_item, DebugCallbackContext::Callback, &context);
Elliott Hughes3e2e1a22012-02-21 11:33:41 -08003776 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003777
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003778 // Activate single-step in the thread.
3779 thread->ActivateSingleStepControl(single_step_control);
Elliott Hughes86964332012-02-15 19:37:42 -08003780
Elliott Hughes2435a572012-02-17 16:07:41 -08003781 if (VLOG_IS_ON(jdwp)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003782 VLOG(jdwp) << "Single-step thread: " << *thread;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003783 VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3784 VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
3785 VLOG(jdwp) << "Single-step current method: " << PrettyMethod(single_step_control->GetMethod());
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003786 VLOG(jdwp) << "Single-step current line: " << line_number;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003787 VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
Elliott Hughes2435a572012-02-17 16:07:41 -08003788 VLOG(jdwp) << "Single-step dex_pc values:";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003789 for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003790 VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003791 }
3792 }
3793
3794 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003795}
3796
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003797void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3798 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07003799 JDWP::JdwpError error;
3800 Thread* thread = DecodeThread(soa, thread_id, &error);
Sebastien Hertz87118ed2013-11-26 17:57:18 +01003801 if (error == JDWP::ERR_NONE) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003802 thread->DeactivateSingleStepControl();
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003803 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003804}
3805
Elliott Hughes45651fd2012-02-21 15:48:20 -08003806static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3807 switch (tag) {
3808 default:
3809 LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
Ian Rogersfc787ec2014-10-09 21:56:44 -07003810 UNREACHABLE();
Elliott Hughes45651fd2012-02-21 15:48:20 -08003811
3812 // Primitives.
3813 case JDWP::JT_BYTE: return 'B';
3814 case JDWP::JT_CHAR: return 'C';
3815 case JDWP::JT_FLOAT: return 'F';
3816 case JDWP::JT_DOUBLE: return 'D';
3817 case JDWP::JT_INT: return 'I';
3818 case JDWP::JT_LONG: return 'J';
3819 case JDWP::JT_SHORT: return 'S';
3820 case JDWP::JT_VOID: return 'V';
3821 case JDWP::JT_BOOLEAN: return 'Z';
3822
3823 // Reference types.
3824 case JDWP::JT_ARRAY:
3825 case JDWP::JT_OBJECT:
3826 case JDWP::JT_STRING:
3827 case JDWP::JT_THREAD:
3828 case JDWP::JT_THREAD_GROUP:
3829 case JDWP::JT_CLASS_LOADER:
3830 case JDWP::JT_CLASS_OBJECT:
3831 return 'L';
3832 }
3833}
3834
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003835JDWP::JdwpError Dbg::PrepareInvokeMethod(uint32_t request_id, JDWP::ObjectId thread_id,
3836 JDWP::ObjectId object_id, JDWP::RefTypeId class_id,
3837 JDWP::MethodId method_id, uint32_t arg_count,
3838 uint64_t arg_values[], JDWP::JdwpTag* arg_types,
3839 uint32_t options) {
3840 Thread* const self = Thread::Current();
3841 CHECK_EQ(self, GetDebugThread()) << "This must be called by the JDWP thread";
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003842 const bool resume_all_threads = ((options & JDWP::INVOKE_SINGLE_THREADED) == 0);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003843
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003844 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Ian Rogersc0542af2014-09-03 16:16:56 -07003845 Thread* targetThread = nullptr;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003846 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003847 ScopedObjectAccessUnchecked soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07003848 JDWP::JdwpError error;
3849 targetThread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08003850 if (error != JDWP::ERR_NONE) {
3851 LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3852 return error;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003853 }
Sebastien Hertz1558b572015-02-25 15:05:59 +01003854 if (targetThread->GetInvokeReq() != nullptr) {
3855 // Thread is already invoking a method on behalf of the debugger.
3856 LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
3857 return JDWP::ERR_ALREADY_INVOKING;
3858 }
3859 if (!targetThread->IsReadyForDebugInvoke()) {
3860 // Thread is not suspended by an event so it cannot invoke a method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003861 LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
3862 return JDWP::ERR_INVALID_THREAD;
3863 }
3864
3865 /*
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003866 * According to the JDWP specs, we are expected to resume all threads (or only the
3867 * target thread) once. So if a thread has been suspended more than once (either by
3868 * the debugger for an event or by the runtime for GC), it will remain suspended before
3869 * the invoke is executed. This means the debugger is responsible to properly resume all
3870 * the threads it has suspended so the target thread can execute the method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003871 *
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003872 * However, for compatibility reason with older versions of debuggers (like Eclipse), we
3873 * fully resume all threads (by canceling *all* debugger suspensions) when the debugger
3874 * wants us to resume all threads. This is to avoid ending up in deadlock situation.
3875 *
3876 * On the other hand, if we are asked to only resume the target thread, then we follow the
3877 * JDWP specs by resuming that thread only once. This means the thread will remain suspended
3878 * if it has been suspended more than once before the invoke (and again, this is the
3879 * responsibility of the debugger to properly resume that thread before invoking a method).
Elliott Hughesd07986f2011-12-06 18:27:45 -08003880 */
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003881 int suspend_count;
3882 {
Ian Rogers50b35e22012-10-04 10:09:15 -07003883 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003884 suspend_count = targetThread->GetSuspendCount();
3885 }
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003886 if (suspend_count > 1 && resume_all_threads) {
3887 // The target thread will remain suspended even after we resume it. Let's emit a warning
3888 // to indicate the invoke won't be executed until the thread is resumed.
3889 LOG(WARNING) << *targetThread << " suspended more than once (suspend count == "
3890 << suspend_count << "). This thread will invoke the method only once "
3891 << "it is fully resumed.";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003892 }
3893
Ian Rogersc0542af2014-09-03 16:16:56 -07003894 mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
3895 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003896 return JDWP::ERR_INVALID_OBJECT;
3897 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003898
Sebastien Hertz1558b572015-02-25 15:05:59 +01003899 gRegistry->Get<mirror::Object*>(thread_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07003900 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003901 return JDWP::ERR_INVALID_OBJECT;
3902 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003903
Ian Rogersc0542af2014-09-03 16:16:56 -07003904 mirror::Class* c = DecodeClass(class_id, &error);
3905 if (c == nullptr) {
3906 return error;
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003907 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003908
Mathieu Chartiere401d142015-04-22 13:56:20 -07003909 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07003910 if (m->IsStatic() != (receiver == nullptr)) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003911 return JDWP::ERR_INVALID_METHODID;
3912 }
3913 if (m->IsStatic()) {
3914 if (m->GetDeclaringClass() != c) {
3915 return JDWP::ERR_INVALID_METHODID;
3916 }
3917 } else {
3918 if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
3919 return JDWP::ERR_INVALID_METHODID;
3920 }
3921 }
3922
3923 // Check the argument list matches the method.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003924 uint32_t shorty_len = 0;
3925 const char* shorty = m->GetShorty(&shorty_len);
3926 if (shorty_len - 1 != arg_count) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003927 return JDWP::ERR_ILLEGAL_ARGUMENT;
3928 }
Elliott Hughes09201632013-04-15 15:50:07 -07003929
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003930 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003931 StackHandleScope<2> hs(soa.Self());
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003932 HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
3933 HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
3934 const DexFile::TypeList* types = m->GetParameterTypeList();
3935 for (size_t i = 0; i < arg_count; ++i) {
3936 if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
Elliott Hughes09201632013-04-15 15:50:07 -07003937 return JDWP::ERR_ILLEGAL_ARGUMENT;
3938 }
3939
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003940 if (shorty[i + 1] == 'L') {
3941 // Did we really get an argument of an appropriate reference type?
Ian Rogersa0485602014-12-02 15:48:04 -08003942 mirror::Class* parameter_type =
Vladimir Marko05792b92015-08-03 11:56:49 +01003943 m->GetClassFromTypeIndex(types->GetTypeItem(i).type_idx_,
3944 true /* resolve */,
Andreas Gampe542451c2016-07-26 09:02:02 -07003945 kRuntimePointerSize);
Ian Rogersc0542af2014-09-03 16:16:56 -07003946 mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
3947 if (error != JDWP::ERR_NONE) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003948 return JDWP::ERR_INVALID_OBJECT;
3949 }
Ian Rogersc0542af2014-09-03 16:16:56 -07003950 if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003951 return JDWP::ERR_ILLEGAL_ARGUMENT;
3952 }
3953
3954 // Turn the on-the-wire ObjectId into a jobject.
3955 jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
3956 v.l = gRegistry->GetJObject(arg_values[i]);
3957 }
Elliott Hughes09201632013-04-15 15:50:07 -07003958 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003959 }
3960
Sebastien Hertz1558b572015-02-25 15:05:59 +01003961 // Allocates a DebugInvokeReq.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003962 DebugInvokeReq* req = new (std::nothrow) DebugInvokeReq(request_id, thread_id, receiver, c, m,
3963 options, arg_values, arg_count);
3964 if (req == nullptr) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003965 LOG(ERROR) << "Failed to allocate DebugInvokeReq";
3966 return JDWP::ERR_OUT_OF_MEMORY;
3967 }
3968
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003969 // Attaches the DebugInvokeReq to the target thread so it executes the method when
3970 // it is resumed. Once the invocation completes, the target thread will delete it before
3971 // suspending itself (see ThreadList::SuspendSelfForDebugger).
3972 targetThread->SetDebugInvokeReq(req);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003973 }
3974
3975 // The fact that we've released the thread list lock is a bit risky --- if the thread goes
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003976 // away we're sitting high and dry -- but we must release this before the UndoDebuggerSuspensions
3977 // call.
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003978 if (resume_all_threads) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003979 VLOG(jdwp) << " Resuming all threads";
3980 thread_list->UndoDebuggerSuspensions();
3981 } else {
3982 VLOG(jdwp) << " Resuming event thread only";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003983 thread_list->Resume(targetThread, true);
3984 }
3985
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003986 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003987}
3988
3989void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003990 Thread* const self = Thread::Current();
3991 CHECK_NE(self, GetDebugThread()) << "This must be called by the event thread";
3992
3993 ScopedObjectAccess soa(self);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003994
Elliott Hughes81ff3182012-03-23 20:35:56 -07003995 // We can be called while an exception is pending. We need
Elliott Hughesd07986f2011-12-06 18:27:45 -08003996 // to preserve that across the method invocation.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003997 StackHandleScope<1> hs(soa.Self());
3998 Handle<mirror::Throwable> old_exception = hs.NewHandle(soa.Self()->GetException());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003999 soa.Self()->ClearException();
Elliott Hughesd07986f2011-12-06 18:27:45 -08004000
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004001 // Execute the method then sends reply to the debugger.
4002 ExecuteMethodWithoutPendingException(soa, pReq);
4003
4004 // If an exception was pending before the invoke, restore it now.
4005 if (old_exception.Get() != nullptr) {
4006 soa.Self()->SetException(old_exception.Get());
4007 }
4008}
4009
4010// Helper function: write a variable-width value into the output input buffer.
4011static void WriteValue(JDWP::ExpandBuf* pReply, int width, uint64_t value) {
4012 switch (width) {
4013 case 1:
4014 expandBufAdd1(pReply, value);
4015 break;
4016 case 2:
4017 expandBufAdd2BE(pReply, value);
4018 break;
4019 case 4:
4020 expandBufAdd4BE(pReply, value);
4021 break;
4022 case 8:
4023 expandBufAdd8BE(pReply, value);
4024 break;
4025 default:
4026 LOG(FATAL) << width;
4027 UNREACHABLE();
4028 }
4029}
4030
4031void Dbg::ExecuteMethodWithoutPendingException(ScopedObjectAccess& soa, DebugInvokeReq* pReq) {
4032 soa.Self()->AssertNoPendingException();
4033
Elliott Hughesd07986f2011-12-06 18:27:45 -08004034 // Translate the method through the vtable, unless the debugger wants to suppress it.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004035 ArtMethod* m = pReq->method;
Andreas Gampe542451c2016-07-26 09:02:02 -07004036 PointerSize image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
Sebastien Hertz1558b572015-02-25 15:05:59 +01004037 if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07004038 ArtMethod* actual_method =
4039 pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m, image_pointer_size);
4040 if (actual_method != m) {
4041 VLOG(jdwp) << "ExecuteMethod translated " << PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01004042 << " to " << PrettyMethod(actual_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07004043 m = actual_method;
Elliott Hughes45651fd2012-02-21 15:48:20 -08004044 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08004045 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07004046 VLOG(jdwp) << "ExecuteMethod " << PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01004047 << " receiver=" << pReq->receiver.Read()
Sebastien Hertzd38667a2013-11-25 15:43:54 +01004048 << " arg_count=" << pReq->arg_count;
Mathieu Chartiere401d142015-04-22 13:56:20 -07004049 CHECK(m != nullptr);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004050
Roland Levillain33d69032015-06-18 18:20:59 +01004051 static_assert(sizeof(jvalue) == sizeof(uint64_t), "jvalue and uint64_t have different sizes.");
Elliott Hughesd07986f2011-12-06 18:27:45 -08004052
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004053 // Invoke the method.
Jeff Hao39b6c242015-05-19 20:30:23 -07004054 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(pReq->receiver.Read()));
Mathieu Chartiere401d142015-04-22 13:56:20 -07004055 JValue result = InvokeWithJValues(soa, ref.get(), soa.EncodeMethod(m),
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004056 reinterpret_cast<jvalue*>(pReq->arg_values.get()));
Elliott Hughesd07986f2011-12-06 18:27:45 -08004057
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004058 // Prepare JDWP ids for the reply.
4059 JDWP::JdwpTag result_tag = BasicTagFromDescriptor(m->GetShorty());
4060 const bool is_object_result = (result_tag == JDWP::JT_OBJECT);
Jeff Hao064d24e2016-08-25 03:52:40 +00004061 StackHandleScope<3> hs(soa.Self());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004062 Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
4063 Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
4064 soa.Self()->ClearException();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004065
4066 if (!IsDebuggerActive()) {
4067 // The debugger detached: we must not re-suspend threads. We also don't need to fill the reply
4068 // because it won't be sent either.
4069 return;
4070 }
4071
4072 JDWP::ObjectId exceptionObjectId = gRegistry->Add(exception);
4073 uint64_t result_value = 0;
4074 if (exceptionObjectId != 0) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004075 VLOG(jdwp) << " JDWP invocation returning with exception=" << exception.Get()
4076 << " " << exception->Dump();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004077 result_value = 0;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004078 } else if (is_object_result) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004079 /* if no exception was thrown, examine object result more closely */
Sebastien Hertz1558b572015-02-25 15:05:59 +01004080 JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004081 if (new_tag != result_tag) {
4082 VLOG(jdwp) << " JDWP promoted result from " << result_tag << " to " << new_tag;
4083 result_tag = new_tag;
Elliott Hughesd07986f2011-12-06 18:27:45 -08004084 }
4085
Sebastien Hertz1558b572015-02-25 15:05:59 +01004086 // Register the object in the registry and reference its ObjectId. This ensures
4087 // GC safety and prevents from accessing stale reference if the object is moved.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004088 result_value = gRegistry->Add(object_result.Get());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004089 } else {
4090 // Primitive result.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004091 DCHECK(IsPrimitiveTag(result_tag));
4092 result_value = result.GetJ();
4093 }
4094 const bool is_constructor = m->IsConstructor() && !m->IsStatic();
4095 if (is_constructor) {
4096 // If we invoked a constructor (which actually returns void), return the receiver,
4097 // unless we threw, in which case we return null.
Sebastien Hertza3e13772015-11-05 12:09:44 +01004098 DCHECK_EQ(JDWP::JT_VOID, result_tag);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004099 if (exceptionObjectId == 0) {
Jeff Hao064d24e2016-08-25 03:52:40 +00004100 if (m->GetDeclaringClass()->IsStringClass()) {
4101 // For string constructors, the new string is remapped to the receiver (stored in ref).
4102 Handle<mirror::Object> decoded_ref = hs.NewHandle(soa.Self()->DecodeJObject(ref.get()));
4103 result_value = gRegistry->Add(decoded_ref);
4104 result_tag = TagFromObject(soa, decoded_ref.Get());
4105 } else {
4106 // TODO we could keep the receiver ObjectId in the DebugInvokeReq to avoid looking into the
4107 // object registry.
4108 result_value = GetObjectRegistry()->Add(pReq->receiver.Read());
4109 result_tag = TagFromObject(soa, pReq->receiver.Read());
4110 }
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004111 } else {
4112 result_value = 0;
Sebastien Hertza3e13772015-11-05 12:09:44 +01004113 result_tag = JDWP::JT_OBJECT;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004114 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08004115 }
4116
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004117 // Suspend other threads if the invoke is not single-threaded.
4118 if ((pReq->options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004119 ScopedThreadSuspension sts(soa.Self(), kWaitingForDebuggerSuspension);
Hiroshi Yamauchi8f95cf32016-04-19 11:14:06 -07004120 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
4121 gc::ScopedGCCriticalSection gcs(soa.Self(), gc::kGcCauseDebugger, gc::kCollectorTypeDebugger);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004122 VLOG(jdwp) << " Suspending all threads";
4123 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004124 }
4125
4126 VLOG(jdwp) << " --> returned " << result_tag
4127 << StringPrintf(" %#" PRIx64 " (except=%#" PRIx64 ")", result_value,
4128 exceptionObjectId);
4129
4130 // Show detailed debug output.
4131 if (result_tag == JDWP::JT_STRING && exceptionObjectId == 0) {
4132 if (result_value != 0) {
4133 if (VLOG_IS_ON(jdwp)) {
4134 std::string result_string;
4135 JDWP::JdwpError error = Dbg::StringToUtf8(result_value, &result_string);
4136 CHECK_EQ(error, JDWP::ERR_NONE);
4137 VLOG(jdwp) << " string '" << result_string << "'";
4138 }
4139 } else {
4140 VLOG(jdwp) << " string (null)";
4141 }
4142 }
4143
4144 // Attach the reply to DebugInvokeReq so it can be sent to the debugger when the event thread
4145 // is ready to suspend.
4146 BuildInvokeReply(pReq->reply, pReq->request_id, result_tag, result_value, exceptionObjectId);
4147}
4148
4149void Dbg::BuildInvokeReply(JDWP::ExpandBuf* pReply, uint32_t request_id, JDWP::JdwpTag result_tag,
4150 uint64_t result_value, JDWP::ObjectId exception) {
4151 // Make room for the JDWP header since we do not know the size of the reply yet.
4152 JDWP::expandBufAddSpace(pReply, kJDWPHeaderLen);
4153
4154 size_t width = GetTagWidth(result_tag);
4155 JDWP::expandBufAdd1(pReply, result_tag);
4156 if (width != 0) {
4157 WriteValue(pReply, width, result_value);
4158 }
4159 JDWP::expandBufAdd1(pReply, JDWP::JT_OBJECT);
4160 JDWP::expandBufAddObjectId(pReply, exception);
4161
4162 // Now we know the size, we can complete the JDWP header.
4163 uint8_t* buf = expandBufGetBuffer(pReply);
4164 JDWP::Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReply));
4165 JDWP::Set4BE(buf + kJDWPHeaderIdOffset, request_id);
4166 JDWP::Set1(buf + kJDWPHeaderFlagsOffset, kJDWPFlagReply); // flags
4167 JDWP::Set2BE(buf + kJDWPHeaderErrorCodeOffset, JDWP::ERR_NONE);
4168}
4169
4170void Dbg::FinishInvokeMethod(DebugInvokeReq* pReq) {
4171 CHECK_NE(Thread::Current(), GetDebugThread()) << "This must be called by the event thread";
4172
4173 JDWP::ExpandBuf* const pReply = pReq->reply;
4174 CHECK(pReply != nullptr) << "No reply attached to DebugInvokeReq";
4175
4176 // We need to prevent other threads (including JDWP thread) from interacting with the debugger
4177 // while we send the reply but are not yet suspended. The JDWP token will be released just before
4178 // we suspend ourself again (see ThreadList::SuspendSelfForDebugger).
4179 gJdwpState->AcquireJdwpTokenForEvent(pReq->thread_id);
4180
4181 // Send the reply unless the debugger detached before the completion of the method.
4182 if (IsDebuggerActive()) {
4183 const size_t replyDataLength = expandBufGetLength(pReply) - kJDWPHeaderLen;
4184 VLOG(jdwp) << StringPrintf("REPLY INVOKE id=0x%06x (length=%zu)",
4185 pReq->request_id, replyDataLength);
4186
4187 gJdwpState->SendRequest(pReply);
4188 } else {
4189 VLOG(jdwp) << "Not sending invoke reply because debugger detached";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004190 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004191}
4192
Elliott Hughesd07986f2011-12-06 18:27:45 -08004193/*
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004194 * "request" contains a full JDWP packet, possibly with multiple chunks. We
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004195 * need to process each, accumulate the replies, and ship the whole thing
4196 * back.
4197 *
4198 * Returns "true" if we have a reply. The reply buffer is newly allocated,
4199 * and includes the chunk type/length, followed by the data.
4200 *
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08004201 * OLD-TODO: we currently assume that the request and reply include a single
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004202 * chunk. If this becomes inconvenient we will need to adapt.
4203 */
Ian Rogersc0542af2014-09-03 16:16:56 -07004204bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004205 Thread* self = Thread::Current();
4206 JNIEnv* env = self->GetJniEnv();
4207
Ian Rogersc0542af2014-09-03 16:16:56 -07004208 uint32_t type = request->ReadUnsigned32("type");
4209 uint32_t length = request->ReadUnsigned32("length");
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004210
4211 // Create a byte[] corresponding to 'request'.
Ian Rogersc0542af2014-09-03 16:16:56 -07004212 size_t request_length = request->size();
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004213 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(request_length));
Ian Rogersc0542af2014-09-03 16:16:56 -07004214 if (dataArray.get() == nullptr) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004215 LOG(WARNING) << "byte[] allocation failed: " << request_length;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004216 env->ExceptionClear();
4217 return false;
4218 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004219 env->SetByteArrayRegion(dataArray.get(), 0, request_length,
4220 reinterpret_cast<const jbyte*>(request->data()));
4221 request->Skip(request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004222
4223 // Run through and find all chunks. [Currently just find the first.]
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004224 ScopedByteArrayRO contents(env, dataArray.get());
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004225 if (length != request_length) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08004226 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004227 return false;
4228 }
4229
4230 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
Elliott Hugheseac76672012-05-24 21:56:51 -07004231 ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4232 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004233 type, dataArray.get(), 0, length));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004234 if (env->ExceptionCheck()) {
4235 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
4236 env->ExceptionDescribe();
4237 env->ExceptionClear();
4238 return false;
4239 }
4240
Ian Rogersc0542af2014-09-03 16:16:56 -07004241 if (chunk.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004242 return false;
4243 }
4244
4245 /*
4246 * Pull the pieces out of the chunk. We copy the results into a
4247 * newly-allocated buffer that the caller can free. We don't want to
4248 * continue using the Chunk object because nothing has a reference to it.
4249 *
4250 * We could avoid this by returning type/data/offset/length and having
4251 * the caller be aware of the object lifetime issues, but that
Elliott Hughes81ff3182012-03-23 20:35:56 -07004252 * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004253 * if we have responses for multiple chunks.
4254 *
4255 * So we're pretty much stuck with copying data around multiple times.
4256 */
Elliott Hugheseac76672012-05-24 21:56:51 -07004257 ScopedLocalRef<jbyteArray> replyData(env, reinterpret_cast<jbyteArray>(env->GetObjectField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_data)));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004258 jint offset = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
Elliott Hugheseac76672012-05-24 21:56:51 -07004259 length = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
Elliott Hugheseac76672012-05-24 21:56:51 -07004260 type = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004261
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004262 VLOG(jdwp) << StringPrintf("DDM reply: type=0x%08x data=%p offset=%d length=%d", type, replyData.get(), offset, length);
Ian Rogersc0542af2014-09-03 16:16:56 -07004263 if (length == 0 || replyData.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004264 return false;
4265 }
4266
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004267 const int kChunkHdrLen = 8;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004268 uint8_t* reply = new uint8_t[length + kChunkHdrLen];
Ian Rogersc0542af2014-09-03 16:16:56 -07004269 if (reply == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004270 LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
4271 return false;
4272 }
Elliott Hughesf7c3b662011-10-27 12:04:56 -07004273 JDWP::Set4BE(reply + 0, type);
4274 JDWP::Set4BE(reply + 4, length);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004275 env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004276
4277 *pReplyBuf = reply;
4278 *pReplyLen = length + kChunkHdrLen;
4279
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004280 VLOG(jdwp) << StringPrintf("dvmHandleDdm returning type=%.4s %p len=%d", reinterpret_cast<char*>(reply), reply, length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004281 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004282}
4283
Elliott Hughesa2155262011-11-16 16:26:58 -08004284void Dbg::DdmBroadcast(bool connect) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004285 VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
Elliott Hughes47fce012011-10-25 18:37:19 -07004286
4287 Thread* self = Thread::Current();
Ian Rogers50b35e22012-10-04 10:09:15 -07004288 if (self->GetState() != kRunnable) {
4289 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4290 /* try anyway? */
Elliott Hughes47fce012011-10-25 18:37:19 -07004291 }
4292
4293 JNIEnv* env = self->GetJniEnv();
Elliott Hughes47fce012011-10-25 18:37:19 -07004294 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
Elliott Hugheseac76672012-05-24 21:56:51 -07004295 env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4296 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4297 event);
Elliott Hughes47fce012011-10-25 18:37:19 -07004298 if (env->ExceptionCheck()) {
4299 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4300 env->ExceptionDescribe();
4301 env->ExceptionClear();
4302 }
4303}
4304
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004305void Dbg::DdmConnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004306 Dbg::DdmBroadcast(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004307}
4308
4309void Dbg::DdmDisconnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004310 Dbg::DdmBroadcast(false);
Elliott Hughes47fce012011-10-25 18:37:19 -07004311 gDdmThreadNotification = false;
4312}
4313
4314/*
Elliott Hughes82188472011-11-07 18:11:48 -08004315 * Send a notification when a thread starts, stops, or changes its name.
Elliott Hughes47fce012011-10-25 18:37:19 -07004316 *
4317 * Because we broadcast the full set of threads when the notifications are
4318 * first enabled, it's possible for "thread" to be actively executing.
4319 */
Elliott Hughes82188472011-11-07 18:11:48 -08004320void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004321 if (!gDdmThreadNotification) {
4322 return;
4323 }
4324
Elliott Hughes82188472011-11-07 18:11:48 -08004325 if (type == CHUNK_TYPE("THDE")) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004326 uint8_t buf[4];
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004327 JDWP::Set4BE(&buf[0], t->GetThreadId());
Elliott Hughes47fce012011-10-25 18:37:19 -07004328 Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
Elliott Hughes82188472011-11-07 18:11:48 -08004329 } else {
4330 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004331 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07004332 StackHandleScope<1> hs(soa.Self());
4333 Handle<mirror::String> name(hs.NewHandle(t->GetThreadName(soa)));
Ian Rogersc0542af2014-09-03 16:16:56 -07004334 size_t char_count = (name.Get() != nullptr) ? name->GetLength() : 0;
Jeff Hao848f70a2014-01-15 13:49:50 -08004335 const jchar* chars = (name.Get() != nullptr) ? name->GetValue() : nullptr;
jessicahandojo3aaa37b2016-07-29 14:46:37 -07004336 bool is_compressed = (name.Get() != nullptr) ? name->IsCompressed() : false;
Elliott Hughes82188472011-11-07 18:11:48 -08004337
Elliott Hughes21f32d72011-11-09 17:44:13 -08004338 std::vector<uint8_t> bytes;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004339 JDWP::Append4BE(bytes, t->GetThreadId());
jessicahandojo3aaa37b2016-07-29 14:46:37 -07004340 if (is_compressed) {
4341 const uint8_t* chars_compressed = name->GetValueCompressed();
4342 JDWP::AppendUtf16CompressedBE(bytes, chars_compressed, char_count);
4343 } else {
4344 JDWP::AppendUtf16BE(bytes, chars, char_count);
4345 }
Elliott Hughes21f32d72011-11-09 17:44:13 -08004346 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
4347 Dbg::DdmSendChunk(type, bytes);
Elliott Hughes47fce012011-10-25 18:37:19 -07004348 }
4349}
4350
Elliott Hughes47fce012011-10-25 18:37:19 -07004351void Dbg::DdmSetThreadNotification(bool enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004352 // Enable/disable thread notifications.
Elliott Hughes47fce012011-10-25 18:37:19 -07004353 gDdmThreadNotification = enable;
4354 if (enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004355 // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4356 // see a suspension in progress and block until that ends. They then post their own start
4357 // notification.
4358 SuspendVM();
4359 std::list<Thread*> threads;
Ian Rogers50b35e22012-10-04 10:09:15 -07004360 Thread* self = Thread::Current();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004361 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004362 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004363 threads = Runtime::Current()->GetThreadList()->GetList();
4364 }
4365 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004366 ScopedObjectAccess soa(self);
Mathieu Chartier02e25112013-08-14 16:14:24 -07004367 for (Thread* thread : threads) {
4368 Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004369 }
4370 }
4371 ResumeVM();
Elliott Hughes47fce012011-10-25 18:37:19 -07004372 }
4373}
4374
Elliott Hughesa2155262011-11-16 16:26:58 -08004375void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07004376 if (IsDebuggerActive()) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02004377 gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004378 }
Elliott Hughes82188472011-11-07 18:11:48 -08004379 Dbg::DdmSendThreadNotification(t, type);
Elliott Hughes47fce012011-10-25 18:37:19 -07004380}
4381
4382void Dbg::PostThreadStart(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004383 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004384}
4385
4386void Dbg::PostThreadDeath(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004387 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004388}
4389
Elliott Hughes82188472011-11-07 18:11:48 -08004390void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004391 CHECK(buf != nullptr);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004392 iovec vec[1];
4393 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
4394 vec[0].iov_len = byte_count;
4395 Dbg::DdmSendChunkV(type, vec, 1);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004396}
4397
Elliott Hughes21f32d72011-11-09 17:44:13 -08004398void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
4399 DdmSendChunk(type, bytes.size(), &bytes[0]);
4400}
4401
Brian Carlstromf5293522013-07-19 00:24:00 -07004402void Dbg::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004403 if (gJdwpState == nullptr) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004404 VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
Elliott Hughes3bb81562011-10-21 18:52:59 -07004405 } else {
Elliott Hughescccd84f2011-12-05 16:51:54 -08004406 gJdwpState->DdmSendChunkV(type, iov, iov_count);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004407 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004408}
4409
Mathieu Chartierad466ad2015-01-08 16:28:08 -08004410JDWP::JdwpState* Dbg::GetJdwpState() {
4411 return gJdwpState;
4412}
4413
Elliott Hughes767a1472011-10-26 18:49:02 -07004414int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4415 if (when == HPIF_WHEN_NOW) {
Elliott Hughes7162ad92011-10-27 14:08:42 -07004416 DdmSendHeapInfo(when);
Elliott Hughes767a1472011-10-26 18:49:02 -07004417 return true;
4418 }
4419
4420 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4421 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4422 return false;
4423 }
4424
4425 gDdmHpifWhen = when;
4426 return true;
4427}
4428
4429bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4430 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4431 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4432 return false;
4433 }
4434
4435 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4436 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4437 return false;
4438 }
4439
4440 if (native) {
4441 gDdmNhsgWhen = when;
4442 gDdmNhsgWhat = what;
4443 } else {
4444 gDdmHpsgWhen = when;
4445 gDdmHpsgWhat = what;
4446 }
4447 return true;
4448}
4449
Elliott Hughes7162ad92011-10-27 14:08:42 -07004450void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4451 // If there's a one-shot 'when', reset it.
4452 if (reason == gDdmHpifWhen) {
4453 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4454 gDdmHpifWhen = HPIF_WHEN_NEVER;
4455 }
4456 }
4457
4458 /*
4459 * Chunk HPIF (client --> server)
4460 *
4461 * Heap Info. General information about the heap,
4462 * suitable for a summary display.
4463 *
4464 * [u4]: number of heaps
4465 *
4466 * For each heap:
4467 * [u4]: heap ID
4468 * [u8]: timestamp in ms since Unix epoch
4469 * [u1]: capture reason (same as 'when' value from server)
4470 * [u4]: max heap size in bytes (-Xmx)
4471 * [u4]: current heap size in bytes
4472 * [u4]: current number of bytes allocated
4473 * [u4]: current number of objects allocated
4474 */
4475 uint8_t heap_count = 1;
Ian Rogers1d54e732013-05-02 21:10:01 -07004476 gc::Heap* heap = Runtime::Current()->GetHeap();
Elliott Hughes21f32d72011-11-09 17:44:13 -08004477 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08004478 JDWP::Append4BE(bytes, heap_count);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004479 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
Elliott Hughes545a0642011-11-08 19:10:03 -08004480 JDWP::Append8BE(bytes, MilliTime());
4481 JDWP::Append1BE(bytes, reason);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004482 JDWP::Append4BE(bytes, heap->GetMaxMemory()); // Max allowed heap size in bytes.
4483 JDWP::Append4BE(bytes, heap->GetTotalMemory()); // Current heap size in bytes.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -08004484 JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4485 JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
Elliott Hughes21f32d72011-11-09 17:44:13 -08004486 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
4487 Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
Elliott Hughes767a1472011-10-26 18:49:02 -07004488}
4489
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004490enum HpsgSolidity {
4491 SOLIDITY_FREE = 0,
4492 SOLIDITY_HARD = 1,
4493 SOLIDITY_SOFT = 2,
4494 SOLIDITY_WEAK = 3,
4495 SOLIDITY_PHANTOM = 4,
4496 SOLIDITY_FINALIZABLE = 5,
4497 SOLIDITY_SWEEP = 6,
4498};
4499
4500enum HpsgKind {
4501 KIND_OBJECT = 0,
4502 KIND_CLASS_OBJECT = 1,
4503 KIND_ARRAY_1 = 2,
4504 KIND_ARRAY_2 = 3,
4505 KIND_ARRAY_4 = 4,
4506 KIND_ARRAY_8 = 5,
4507 KIND_UNKNOWN = 6,
4508 KIND_NATIVE = 7,
4509};
4510
4511#define HPSG_PARTIAL (1<<7)
4512#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4513
Ian Rogers30fab402012-01-23 15:43:46 -08004514class HeapChunkContext {
4515 public:
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004516 // Maximum chunk size. Obtain this from the formula:
4517 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4518 HeapChunkContext(bool merge, bool native)
Ian Rogers30fab402012-01-23 15:43:46 -08004519 : buf_(16384 - 16),
4520 type_(0),
Mathieu Chartier36dab362014-07-30 14:59:56 -07004521 chunk_overhead_(0) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004522 Reset();
4523 if (native) {
Ian Rogers30fab402012-01-23 15:43:46 -08004524 type_ = CHUNK_TYPE("NHSG");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004525 } else {
Ian Rogers30fab402012-01-23 15:43:46 -08004526 type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004527 }
4528 }
4529
4530 ~HeapChunkContext() {
Ian Rogers30fab402012-01-23 15:43:46 -08004531 if (p_ > &buf_[0]) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004532 Flush();
4533 }
4534 }
4535
Mathieu Chartier36dab362014-07-30 14:59:56 -07004536 void SetChunkOverhead(size_t chunk_overhead) {
4537 chunk_overhead_ = chunk_overhead;
4538 }
4539
4540 void ResetStartOfNextChunk() {
4541 startOfNextMemoryChunk_ = nullptr;
4542 }
4543
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004544 void EnsureHeader(const void* chunk_ptr) {
Ian Rogers30fab402012-01-23 15:43:46 -08004545 if (!needHeader_) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004546 return;
4547 }
4548
4549 // Start a new HPSx chunk.
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004550 JDWP::Write4BE(&p_, 1); // Heap id (bogus; we only have one heap).
4551 JDWP::Write1BE(&p_, 8); // Size of allocation unit, in bytes.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004552
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004553 JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
4554 JDWP::Write4BE(&p_, 0); // offset of this piece (relative to the virtual address).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004555 // [u4]: length of piece, in allocation units
4556 // We won't know this until we're done, so save the offset and stuff in a dummy value.
Ian Rogers30fab402012-01-23 15:43:46 -08004557 pieceLenField_ = p_;
4558 JDWP::Write4BE(&p_, 0x55555555);
4559 needHeader_ = false;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004560 }
4561
Mathieu Chartier90443472015-07-16 20:32:27 -07004562 void Flush() SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004563 if (pieceLenField_ == nullptr) {
Ian Rogersd636b062013-01-18 17:51:18 -08004564 // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4565 CHECK(needHeader_);
4566 return;
4567 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004568 // Patch the "length of piece" field.
Ian Rogers30fab402012-01-23 15:43:46 -08004569 CHECK_LE(&buf_[0], pieceLenField_);
4570 CHECK_LE(pieceLenField_, p_);
4571 JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004572
Ian Rogers30fab402012-01-23 15:43:46 -08004573 Dbg::DdmSendChunk(type_, p_ - &buf_[0], &buf_[0]);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004574 Reset();
4575 }
4576
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004577 static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -07004578 SHARED_REQUIRES(Locks::heap_bitmap_lock_,
Ian Rogersb726dcb2012-09-05 08:57:23 -07004579 Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004580 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4581 }
4582
4583 static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -07004584 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004585 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
Elliott Hughesa2155262011-11-16 16:26:58 -08004586 }
4587
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004588 private:
Elliott Hughesa2155262011-11-16 16:26:58 -08004589 enum { ALLOCATION_UNIT_SIZE = 8 };
4590
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004591 void Reset() {
Ian Rogers30fab402012-01-23 15:43:46 -08004592 p_ = &buf_[0];
Mathieu Chartier36dab362014-07-30 14:59:56 -07004593 ResetStartOfNextChunk();
Ian Rogers30fab402012-01-23 15:43:46 -08004594 totalAllocationUnits_ = 0;
4595 needHeader_ = true;
Ian Rogersc0542af2014-09-03 16:16:56 -07004596 pieceLenField_ = nullptr;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004597 }
4598
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004599 bool IsNative() const {
4600 return type_ == CHUNK_TYPE("NHSG");
4601 }
4602
4603 // Returns true if the object is not an empty chunk.
Mathieu Chartier90443472015-07-16 20:32:27 -07004604 bool ProcessRecord(void* start, size_t used_bytes) SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers30fab402012-01-23 15:43:46 -08004605 // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4606 // in the following code not to allocate memory, by ensuring buf_ is of the correct size
Ian Rogers15bf2d32012-08-28 17:33:04 -07004607 if (used_bytes == 0) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004608 if (start == nullptr) {
4609 // Reset for start of new heap.
4610 startOfNextMemoryChunk_ = nullptr;
4611 Flush();
4612 }
4613 // Only process in use memory so that free region information
4614 // also includes dlmalloc book keeping.
4615 return false;
Elliott Hughesa2155262011-11-16 16:26:58 -08004616 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004617 if (startOfNextMemoryChunk_ != nullptr) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004618 // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4619 // of the use of mmaps, so don't report. If not free memory then start a new segment.
4620 bool flush = true;
4621 if (start > startOfNextMemoryChunk_) {
4622 const size_t kMaxFreeLen = 2 * kPageSize;
4623 void* free_start = startOfNextMemoryChunk_;
4624 void* free_end = start;
4625 const size_t free_len =
4626 reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4627 if (!IsNative() || free_len < kMaxFreeLen) {
4628 AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4629 flush = false;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004630 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004631 }
4632 if (flush) {
4633 startOfNextMemoryChunk_ = nullptr;
4634 Flush();
4635 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004636 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004637 return true;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004638 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004639
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004640 void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
Mathieu Chartier90443472015-07-16 20:32:27 -07004641 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004642 if (ProcessRecord(start, used_bytes)) {
4643 uint8_t state = ExamineNativeObject(start);
4644 AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4645 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4646 }
4647 }
4648
4649 void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
Mathieu Chartier90443472015-07-16 20:32:27 -07004650 SHARED_REQUIRES(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004651 if (ProcessRecord(start, used_bytes)) {
4652 // Determine the type of this chunk.
4653 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4654 // If it's the same, we should combine them.
4655 uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4656 AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4657 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4658 }
4659 }
4660
4661 void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
Mathieu Chartier90443472015-07-16 20:32:27 -07004662 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004663 // Make sure there's enough room left in the buffer.
4664 // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4665 // 17 bytes for any header.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004666 const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4667 size_t byte_left = &buf_.back() - p_;
4668 if (byte_left < needed) {
4669 if (is_native) {
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004670 // Cannot trigger memory allocation while walking native heap.
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004671 return;
4672 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004673 Flush();
4674 }
4675
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004676 byte_left = &buf_.back() - p_;
4677 if (byte_left < needed) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004678 LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4679 << needed << " bytes)";
4680 return;
4681 }
4682 EnsureHeader(ptr);
Elliott Hughesa2155262011-11-16 16:26:58 -08004683 // Write out the chunk description.
Ian Rogers15bf2d32012-08-28 17:33:04 -07004684 length /= ALLOCATION_UNIT_SIZE; // Convert to allocation units.
4685 totalAllocationUnits_ += length;
4686 while (length > 256) {
Ian Rogers30fab402012-01-23 15:43:46 -08004687 *p_++ = state | HPSG_PARTIAL;
4688 *p_++ = 255; // length - 1
Ian Rogers15bf2d32012-08-28 17:33:04 -07004689 length -= 256;
Elliott Hughesa2155262011-11-16 16:26:58 -08004690 }
Ian Rogers30fab402012-01-23 15:43:46 -08004691 *p_++ = state;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004692 *p_++ = length - 1;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004693 }
4694
Mathieu Chartier90443472015-07-16 20:32:27 -07004695 uint8_t ExamineNativeObject(const void* p) SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004696 return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4697 }
4698
4699 uint8_t ExamineJavaObject(mirror::Object* o)
Mathieu Chartier90443472015-07-16 20:32:27 -07004700 SHARED_REQUIRES(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004701 if (o == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004702 return HPSG_STATE(SOLIDITY_FREE, 0);
4703 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004704 // It's an allocated chunk. Figure out what it is.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004705 gc::Heap* heap = Runtime::Current()->GetHeap();
4706 if (!heap->IsLiveObjectLocked(o)) {
4707 LOG(ERROR) << "Invalid object in managed heap: " << o;
Elliott Hughesa2155262011-11-16 16:26:58 -08004708 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4709 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08004710 mirror::Class* c = o->GetClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07004711 if (c == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004712 // The object was probably just created but hasn't been initialized yet.
4713 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4714 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004715 if (!heap->IsValidObjectAddress(c)) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004716 LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
Elliott Hughesa2155262011-11-16 16:26:58 -08004717 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4718 }
Mathieu Chartierf26e1b32015-01-29 10:47:10 -08004719 if (c->GetClass() == nullptr) {
4720 LOG(ERROR) << "Null class of class " << c << " for object " << o;
4721 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4722 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004723 if (c->IsClassClass()) {
4724 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4725 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004726 if (c->IsArrayClass()) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004727 switch (c->GetComponentSize()) {
4728 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4729 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4730 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4731 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4732 }
4733 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004734 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4735 }
4736
Ian Rogers30fab402012-01-23 15:43:46 -08004737 std::vector<uint8_t> buf_;
4738 uint8_t* p_;
4739 uint8_t* pieceLenField_;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004740 void* startOfNextMemoryChunk_;
Ian Rogers30fab402012-01-23 15:43:46 -08004741 size_t totalAllocationUnits_;
4742 uint32_t type_;
Ian Rogers30fab402012-01-23 15:43:46 -08004743 bool needHeader_;
Mathieu Chartier36dab362014-07-30 14:59:56 -07004744 size_t chunk_overhead_;
Ian Rogers30fab402012-01-23 15:43:46 -08004745
Elliott Hughesa2155262011-11-16 16:26:58 -08004746 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4747};
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004748
Mathieu Chartier36dab362014-07-30 14:59:56 -07004749static void BumpPointerSpaceCallback(mirror::Object* obj, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -07004750 SHARED_REQUIRES(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
Mathieu Chartier36dab362014-07-30 14:59:56 -07004751 const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004752 HeapChunkContext::HeapChunkJavaCallback(
Mathieu Chartier36dab362014-07-30 14:59:56 -07004753 obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, arg);
4754}
4755
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004756void Dbg::DdmSendHeapSegments(bool native) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004757 Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4758 Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004759 if (when == HPSG_WHEN_NEVER) {
4760 return;
4761 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004762 // Figure out what kind of chunks we'll be sending.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004763 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4764 << static_cast<int>(what);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004765
4766 // First, send a heap start chunk.
4767 uint8_t heap_id[4];
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004768 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004769 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004770 Thread* self = Thread::Current();
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004771 Locks::mutator_lock_->AssertSharedHeld(self);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004772
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004773 // Send a series of heap segment chunks.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004774 HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
Elliott Hughesa2155262011-11-16 16:26:58 -08004775 if (native) {
Dimitry Ivanove6465bc2015-12-14 18:55:02 -08004776 UNIMPLEMENTED(WARNING) << "Native heap inspection is not supported";
Elliott Hughesa2155262011-11-16 16:26:58 -08004777 } else {
Ian Rogers1d54e732013-05-02 21:10:01 -07004778 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004779 for (const auto& space : heap->GetContinuousSpaces()) {
4780 if (space->IsDlMallocSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004781 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004782 // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4783 // allocation then the first sizeof(size_t) may belong to it.
4784 context.SetChunkOverhead(sizeof(size_t));
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004785 space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004786 } else if (space->IsRosAllocSpace()) {
4787 context.SetChunkOverhead(0);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004788 // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4789 // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004790 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07004791 ScopedSuspendAll ssa(__FUNCTION__);
4792 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4793 space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004794 } else if (space->IsBumpPointerSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004795 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004796 context.SetChunkOverhead(0);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004797 space->AsBumpPointerSpace()->Walk(BumpPointerSpaceCallback, &context);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004798 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004799 } else if (space->IsRegionSpace()) {
4800 heap->IncrementDisableMovingGC(self);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004801 {
4802 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07004803 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004804 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4805 context.SetChunkOverhead(0);
4806 space->AsRegionSpace()->Walk(BumpPointerSpaceCallback, &context);
4807 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004808 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004809 heap->DecrementDisableMovingGC(self);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004810 } else {
4811 UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004812 }
Mathieu Chartier36dab362014-07-30 14:59:56 -07004813 context.ResetStartOfNextChunk();
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004814 }
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004815 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartiere0f0cb32012-08-28 11:26:00 -07004816 // Walk the large objects, these are not in the AllocSpace.
Mathieu Chartier36dab362014-07-30 14:59:56 -07004817 context.SetChunkOverhead(0);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004818 heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Elliott Hughesa2155262011-11-16 16:26:58 -08004819 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004820
4821 // Finally, send a heap end chunk.
4822 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
Elliott Hughes767a1472011-10-26 18:49:02 -07004823}
4824
Brian Carlstrom306db812014-09-05 13:01:41 -07004825void Dbg::SetAllocTrackingEnabled(bool enable) {
Man Cao8c2ff642015-05-27 17:25:30 -07004826 gc::AllocRecordObjectMap::SetAllocTrackingEnabled(enable);
Elliott Hughes545a0642011-11-08 19:10:03 -08004827}
4828
4829void Dbg::DumpRecentAllocations() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004830 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom306db812014-09-05 13:01:41 -07004831 MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004832 if (!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled()) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004833 LOG(INFO) << "Not recording tracked allocations";
4834 return;
4835 }
Man Cao8c2ff642015-05-27 17:25:30 -07004836 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4837 CHECK(records != nullptr);
Elliott Hughes545a0642011-11-08 19:10:03 -08004838
Man Cao1ed11b92015-06-11 22:47:35 -07004839 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004840 uint16_t count = capped_count;
Elliott Hughes545a0642011-11-08 19:10:03 -08004841
Man Cao8c2ff642015-05-27 17:25:30 -07004842 LOG(INFO) << "Tracked allocations, (count=" << count << ")";
4843 for (auto it = records->RBegin(), end = records->REnd();
4844 count > 0 && it != end; count--, it++) {
Mathieu Chartier458b1052016-03-29 14:02:55 -07004845 const gc::AllocRecord* record = &it->second;
Elliott Hughes545a0642011-11-08 19:10:03 -08004846
Man Cao8c2ff642015-05-27 17:25:30 -07004847 LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->GetTid(), record->ByteCount())
Man Cao42c3c332015-06-23 16:38:25 -07004848 << PrettyClass(record->GetClass());
Elliott Hughes545a0642011-11-08 19:10:03 -08004849
Man Cao8c2ff642015-05-27 17:25:30 -07004850 for (size_t stack_frame = 0, depth = record->GetDepth(); stack_frame < depth; ++stack_frame) {
4851 const gc::AllocRecordStackTraceElement& stack_element = record->StackElement(stack_frame);
4852 ArtMethod* m = stack_element.GetMethod();
4853 LOG(INFO) << " " << PrettyMethod(m) << " line " << stack_element.ComputeLineNumber();
Elliott Hughes545a0642011-11-08 19:10:03 -08004854 }
4855
4856 // pause periodically to help logcat catch up
4857 if ((count % 5) == 0) {
4858 usleep(40000);
4859 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004860 }
4861}
4862
4863class StringTable {
4864 public:
4865 StringTable() {
4866 }
4867
Mathieu Chartier4345c462014-06-27 10:20:14 -07004868 void Add(const std::string& str) {
4869 table_.insert(str);
4870 }
4871
4872 void Add(const char* str) {
4873 table_.insert(str);
Elliott Hughes545a0642011-11-08 19:10:03 -08004874 }
4875
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004876 size_t IndexOf(const char* s) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004877 auto it = table_.find(s);
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004878 if (it == table_.end()) {
4879 LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
4880 }
4881 return std::distance(table_.begin(), it);
Elliott Hughes545a0642011-11-08 19:10:03 -08004882 }
4883
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004884 size_t Size() const {
Elliott Hughes545a0642011-11-08 19:10:03 -08004885 return table_.size();
4886 }
4887
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004888 void WriteTo(std::vector<uint8_t>& bytes) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004889 for (const std::string& str : table_) {
4890 const char* s = str.c_str();
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004891 size_t s_len = CountModifiedUtf8Chars(s);
Christopher Ferris8a354052015-04-24 17:23:53 -07004892 std::unique_ptr<uint16_t[]> s_utf16(new uint16_t[s_len]);
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004893 ConvertModifiedUtf8ToUtf16(s_utf16.get(), s);
4894 JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
Elliott Hughes545a0642011-11-08 19:10:03 -08004895 }
4896 }
4897
4898 private:
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004899 std::set<std::string> table_;
Elliott Hughes545a0642011-11-08 19:10:03 -08004900 DISALLOW_COPY_AND_ASSIGN(StringTable);
4901};
4902
Mathieu Chartiere401d142015-04-22 13:56:20 -07004903static const char* GetMethodSourceFile(ArtMethod* method)
Mathieu Chartier90443472015-07-16 20:32:27 -07004904 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004905 DCHECK(method != nullptr);
4906 const char* source_file = method->GetDeclaringClassSourceFile();
Sebastien Hertz280286a2014-04-28 09:26:50 +02004907 return (source_file != nullptr) ? source_file : "";
4908}
4909
Elliott Hughes545a0642011-11-08 19:10:03 -08004910/*
4911 * The data we send to DDMS contains everything we have recorded.
4912 *
4913 * Message header (all values big-endian):
4914 * (1b) message header len (to allow future expansion); includes itself
4915 * (1b) entry header len
4916 * (1b) stack frame len
4917 * (2b) number of entries
4918 * (4b) offset to string table from start of message
4919 * (2b) number of class name strings
4920 * (2b) number of method name strings
4921 * (2b) number of source file name strings
4922 * For each entry:
4923 * (4b) total allocation size
Elliott Hughes221229c2013-01-08 18:17:50 -08004924 * (2b) thread id
Elliott Hughes545a0642011-11-08 19:10:03 -08004925 * (2b) allocated object's class name index
4926 * (1b) stack depth
4927 * For each stack frame:
4928 * (2b) method's class name
4929 * (2b) method name
4930 * (2b) method source file
4931 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
4932 * (xb) class name strings
4933 * (xb) method name strings
4934 * (xb) source file strings
4935 *
4936 * As with other DDM traffic, strings are sent as a 4-byte length
4937 * followed by UTF-16 data.
4938 *
4939 * We send up 16-bit unsigned indexes into string tables. In theory there
Brian Carlstrom306db812014-09-05 13:01:41 -07004940 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
Elliott Hughes545a0642011-11-08 19:10:03 -08004941 * each table, but in practice there should be far fewer.
4942 *
4943 * The chief reason for using a string table here is to keep the size of
4944 * the DDMS message to a minimum. This is partly to make the protocol
4945 * efficient, but also because we have to form the whole thing up all at
4946 * once in a memory buffer.
4947 *
4948 * We use separate string tables for class names, method names, and source
4949 * files to keep the indexes small. There will generally be no overlap
4950 * between the contents of these tables.
4951 */
4952jbyteArray Dbg::GetRecentAllocations() {
Ian Rogerscf7f1912014-10-22 22:06:39 -07004953 if ((false)) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004954 DumpRecentAllocations();
4955 }
4956
Ian Rogers50b35e22012-10-04 10:09:15 -07004957 Thread* self = Thread::Current();
Elliott Hughes545a0642011-11-08 19:10:03 -08004958 std::vector<uint8_t> bytes;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004959 {
Brian Carlstrom306db812014-09-05 13:01:41 -07004960 MutexLock mu(self, *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004961 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4962 // In case this method is called when allocation tracker is disabled,
4963 // we should still send some data back.
4964 gc::AllocRecordObjectMap dummy;
4965 if (records == nullptr) {
4966 CHECK(!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled());
4967 records = &dummy;
4968 }
Man Cao41656de2015-07-06 18:53:15 -07004969 // We don't need to wait on the condition variable records->new_record_condition_, because this
4970 // function only reads the class objects, which are already marked so it doesn't change their
4971 // reachability.
Man Cao8c2ff642015-05-27 17:25:30 -07004972
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004973 //
4974 // Part 1: generate string tables.
4975 //
4976 StringTable class_names;
4977 StringTable method_names;
4978 StringTable filenames;
Elliott Hughes545a0642011-11-08 19:10:03 -08004979
Man Cao1ed11b92015-06-11 22:47:35 -07004980 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004981 uint16_t count = capped_count;
Man Cao8c2ff642015-05-27 17:25:30 -07004982 for (auto it = records->RBegin(), end = records->REnd();
4983 count > 0 && it != end; count--, it++) {
Mathieu Chartier458b1052016-03-29 14:02:55 -07004984 const gc::AllocRecord* record = &it->second;
Ian Rogers1ff3c982014-08-12 02:30:58 -07004985 std::string temp;
Man Cao41656de2015-07-06 18:53:15 -07004986 class_names.Add(record->GetClassDescriptor(&temp));
Man Cao8c2ff642015-05-27 17:25:30 -07004987 for (size_t i = 0, depth = record->GetDepth(); i < depth; i++) {
4988 ArtMethod* m = record->StackElement(i).GetMethod();
4989 class_names.Add(m->GetDeclaringClassDescriptor());
4990 method_names.Add(m->GetName());
4991 filenames.Add(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004992 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004993 }
4994
Man Cao8c2ff642015-05-27 17:25:30 -07004995 LOG(INFO) << "recent allocation records: " << capped_count;
4996 LOG(INFO) << "allocation records all objects: " << records->Size();
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004997
4998 //
4999 // Part 2: Generate the output and store it in the buffer.
5000 //
5001
5002 // (1b) message header len (to allow future expansion); includes itself
5003 // (1b) entry header len
5004 // (1b) stack frame len
5005 const int kMessageHeaderLen = 15;
5006 const int kEntryHeaderLen = 9;
5007 const int kStackFrameLen = 8;
5008 JDWP::Append1BE(bytes, kMessageHeaderLen);
5009 JDWP::Append1BE(bytes, kEntryHeaderLen);
5010 JDWP::Append1BE(bytes, kStackFrameLen);
5011
5012 // (2b) number of entries
5013 // (4b) offset to string table from start of message
5014 // (2b) number of class name strings
5015 // (2b) number of method name strings
5016 // (2b) number of source file name strings
Brian Carlstrom306db812014-09-05 13:01:41 -07005017 JDWP::Append2BE(bytes, capped_count);
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005018 size_t string_table_offset = bytes.size();
Brian Carlstrom7934ac22013-07-26 10:54:15 -07005019 JDWP::Append4BE(bytes, 0); // We'll patch this later...
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005020 JDWP::Append2BE(bytes, class_names.Size());
5021 JDWP::Append2BE(bytes, method_names.Size());
5022 JDWP::Append2BE(bytes, filenames.Size());
5023
Ian Rogers1ff3c982014-08-12 02:30:58 -07005024 std::string temp;
Man Cao8c2ff642015-05-27 17:25:30 -07005025 count = capped_count;
5026 // The last "count" number of allocation records in "records" are the most recent "count" number
5027 // of allocations. Reverse iterate to get them. The most recent allocation is sent first.
5028 for (auto it = records->RBegin(), end = records->REnd();
5029 count > 0 && it != end; count--, it++) {
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005030 // For each entry:
5031 // (4b) total allocation size
5032 // (2b) thread id
5033 // (2b) allocated object's class name index
5034 // (1b) stack depth
Mathieu Chartier458b1052016-03-29 14:02:55 -07005035 const gc::AllocRecord* record = &it->second;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005036 size_t stack_depth = record->GetDepth();
Mathieu Chartierf8322842014-05-16 10:59:25 -07005037 size_t allocated_object_class_name_index =
Man Cao41656de2015-07-06 18:53:15 -07005038 class_names.IndexOf(record->GetClassDescriptor(&temp));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07005039 JDWP::Append4BE(bytes, record->ByteCount());
Man Cao8c2ff642015-05-27 17:25:30 -07005040 JDWP::Append2BE(bytes, static_cast<uint16_t>(record->GetTid()));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005041 JDWP::Append2BE(bytes, allocated_object_class_name_index);
5042 JDWP::Append1BE(bytes, stack_depth);
5043
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005044 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
5045 // For each stack frame:
5046 // (2b) method's class name
5047 // (2b) method name
5048 // (2b) method source file
5049 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
Man Cao8c2ff642015-05-27 17:25:30 -07005050 ArtMethod* m = record->StackElement(stack_frame).GetMethod();
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07005051 size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
5052 size_t method_name_index = method_names.IndexOf(m->GetName());
5053 size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005054 JDWP::Append2BE(bytes, class_name_index);
5055 JDWP::Append2BE(bytes, method_name_index);
5056 JDWP::Append2BE(bytes, file_name_index);
Man Cao8c2ff642015-05-27 17:25:30 -07005057 JDWP::Append2BE(bytes, record->StackElement(stack_frame).ComputeLineNumber());
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005058 }
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005059 }
5060
5061 // (xb) class name strings
5062 // (xb) method name strings
5063 // (xb) source file strings
5064 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
5065 class_names.WriteTo(bytes);
5066 method_names.WriteTo(bytes);
5067 filenames.WriteTo(bytes);
Elliott Hughes545a0642011-11-08 19:10:03 -08005068 }
Ian Rogers50b35e22012-10-04 10:09:15 -07005069 JNIEnv* env = self->GetJniEnv();
Elliott Hughes545a0642011-11-08 19:10:03 -08005070 jbyteArray result = env->NewByteArray(bytes.size());
Ian Rogersc0542af2014-09-03 16:16:56 -07005071 if (result != nullptr) {
Elliott Hughes545a0642011-11-08 19:10:03 -08005072 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
5073 }
5074 return result;
5075}
5076
Mathieu Chartiere401d142015-04-22 13:56:20 -07005077ArtMethod* DeoptimizationRequest::Method() const {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07005078 ScopedObjectAccessUnchecked soa(Thread::Current());
5079 return soa.DecodeMethod(method_);
5080}
5081
Mathieu Chartiere401d142015-04-22 13:56:20 -07005082void DeoptimizationRequest::SetMethod(ArtMethod* m) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07005083 ScopedObjectAccessUnchecked soa(Thread::Current());
5084 method_ = soa.EncodeMethod(m);
5085}
5086
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -07005087void Dbg::VisitRoots(RootVisitor* visitor) {
5088 // Visit breakpoint roots, used to prevent unloading of methods with breakpoints.
5089 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
5090 BufferedRootVisitor<128> root_visitor(visitor, RootInfo(kRootVMInternal));
5091 for (Breakpoint& breakpoint : gBreakpoints) {
Andreas Gampe542451c2016-07-26 09:02:02 -07005092 breakpoint.Method()->VisitRoots(root_visitor, kRuntimePointerSize);
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -07005093 }
5094}
5095
Elliott Hughes872d4ec2011-10-21 17:07:15 -07005096} // namespace art