blob: d0b50fe8208644d8a2170eedd329fb8bb78e4f40 [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
Andreas Gampe46ee31b2016-12-14 10:11:49 -080023#include "android-base/stringprintf.h"
24
Ian Rogers166db042013-07-26 12:05:57 -070025#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070026#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070027#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070028#include "base/enums.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010029#include "base/time_utils.h"
Elliott Hughes545a0642011-11-08 19:10:03 -080030#include "class_linker.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080031#include "class_linker-inl.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070032#include "dex_file-inl.h"
David Sehr9323e6e2016-09-13 08:58:35 -070033#include "dex_file_annotations.h"
Ian Rogers776ac1f2012-04-13 23:36:36 -070034#include "dex_instruction.h"
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -080035#include "entrypoints/runtime_asm_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070036#include "gc/accounting/card_table-inl.h"
Man Cao8c2ff642015-05-27 17:25:30 -070037#include "gc/allocation_record.h"
Mathieu Chartieraa516822015-10-02 15:53:37 -070038#include "gc/scoped_gc_critical_section.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070039#include "gc/space/large_object_space.h"
40#include "gc/space/space-inl.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070041#include "handle_scope.h"
Sebastien Hertzcbc50642015-06-01 17:33:12 +020042#include "jdwp/jdwp_priv.h"
Elliott Hughes64f574f2013-02-20 14:57:12 -080043#include "jdwp/object_registry.h"
Andreas Gampe13b27842016-11-07 16:48:23 -080044#include "jni_internal.h"
Mathieu Chartier28bd2e42016-10-04 13:54:57 -070045#include "jvalue-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080046#include "mirror/class.h"
47#include "mirror/class-inl.h"
48#include "mirror/class_loader.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080049#include "mirror/object-inl.h"
50#include "mirror/object_array-inl.h"
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070051#include "mirror/string-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080052#include "mirror/throwable.h"
Mathieu Chartier3398c782016-09-30 10:27:43 -070053#include "obj_ptr-inl.h"
Ian Rogers53b8b092014-03-13 23:45:53 -070054#include "reflection.h"
Elliott Hughesa0e18062012-04-13 15:59:59 -070055#include "safe_map.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070056#include "scoped_thread_state_change-inl.h"
Elliott Hughes6a5bd492011-10-28 14:33:57 -070057#include "ScopedLocalRef.h"
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -070058#include "ScopedPrimitiveArray.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070059#include "handle_scope-inl.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070060#include "thread_list.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080061#include "utf.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070062#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070063
Elliott Hughes872d4ec2011-10-21 17:07:15 -070064namespace art {
65
Andreas Gampe46ee31b2016-12-14 10:11:49 -080066using android::base::StringPrintf;
67
Sebastien Hertz0462c4c2015-04-01 16:34:17 +020068// The key identifying the debugger to update instrumentation.
69static constexpr const char* kDbgInstrumentationKey = "Debugger";
70
Man Cao8c2ff642015-05-27 17:25:30 -070071// 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 -070072static uint16_t CappedAllocRecordCount(size_t alloc_record_count) {
Man Cao1ed11b92015-06-11 22:47:35 -070073 const size_t cap = 0xffff;
Man Cao8c2ff642015-05-27 17:25:30 -070074 if (alloc_record_count > cap) {
75 return cap;
Brian Carlstrom306db812014-09-05 13:01:41 -070076 }
77 return alloc_record_count;
78}
Elliott Hughes475fc232011-10-25 15:00:35 -070079
Alex Light6c8467f2015-11-20 15:03:26 -080080// Takes a method and returns a 'canonical' one if the method is default (and therefore potentially
81// copied from some other class). This ensures that the debugger does not get confused as to which
82// method we are in.
83static ArtMethod* GetCanonicalMethod(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070084 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light6c8467f2015-11-20 15:03:26 -080085 if (LIKELY(!m->IsDefault())) {
86 return m;
87 } else {
88 mirror::Class* declaring_class = m->GetDeclaringClass();
89 return declaring_class->FindDeclaredVirtualMethod(declaring_class->GetDexCache(),
90 m->GetDexMethodIndex(),
Andreas Gampe542451c2016-07-26 09:02:02 -070091 kRuntimePointerSize);
Alex Light6c8467f2015-11-20 15:03:26 -080092 }
93}
94
Mathieu Chartier41af5e52015-10-28 11:10:46 -070095class Breakpoint : public ValueObject {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070096 public:
Mathieu Chartier41af5e52015-10-28 11:10:46 -070097 Breakpoint(ArtMethod* method, uint32_t dex_pc, DeoptimizationRequest::Kind deoptimization_kind)
Alex Light6c8467f2015-11-20 15:03:26 -080098 : method_(GetCanonicalMethod(method)),
Mathieu Chartier41af5e52015-10-28 11:10:46 -070099 dex_pc_(dex_pc),
100 deoptimization_kind_(deoptimization_kind) {
Sebastien Hertzf3928792014-11-17 19:00:37 +0100101 CHECK(deoptimization_kind_ == DeoptimizationRequest::kNothing ||
102 deoptimization_kind_ == DeoptimizationRequest::kSelectiveDeoptimization ||
103 deoptimization_kind_ == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700104 }
105
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700106 Breakpoint(const Breakpoint& other) REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700107 : method_(other.method_),
108 dex_pc_(other.dex_pc_),
109 deoptimization_kind_(other.deoptimization_kind_) {}
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700110
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700111 // Method() is called from root visiting, do not use ScopedObjectAccess here or it can cause
112 // GC to deadlock if another thread tries to call SuspendAll while the GC is in a runnable state.
113 ArtMethod* Method() const {
114 return method_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700115 }
116
117 uint32_t DexPc() const {
118 return dex_pc_;
119 }
120
Sebastien Hertzf3928792014-11-17 19:00:37 +0100121 DeoptimizationRequest::Kind GetDeoptimizationKind() const {
122 return deoptimization_kind_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700123 }
124
Alex Light6c8467f2015-11-20 15:03:26 -0800125 // Returns true if the method of this breakpoint and the passed in method should be considered the
126 // same. That is, they are either the same method or they are copied from the same method.
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700127 bool IsInMethod(ArtMethod* m) const REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light6c8467f2015-11-20 15:03:26 -0800128 return method_ == GetCanonicalMethod(m);
129 }
130
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700131 private:
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100132 // The location of this breakpoint.
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700133 ArtMethod* method_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700134 uint32_t dex_pc_;
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100135
136 // Indicates whether breakpoint needs full deoptimization or selective deoptimization.
Sebastien Hertzf3928792014-11-17 19:00:37 +0100137 DeoptimizationRequest::Kind deoptimization_kind_;
Elliott Hughes86964332012-02-15 19:37:42 -0800138};
139
Sebastien Hertzed2be172014-08-19 15:33:43 +0200140static std::ostream& operator<<(std::ostream& os, const Breakpoint& rhs)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700141 REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr709b0702016-10-13 09:12:37 -0700142 os << StringPrintf("Breakpoint[%s @%#x]", ArtMethod::PrettyMethod(rhs.Method()).c_str(),
143 rhs.DexPc());
Elliott Hughes86964332012-02-15 19:37:42 -0800144 return os;
145}
146
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200147class DebugInstrumentationListener FINAL : public instrumentation::InstrumentationListener {
Ian Rogers62d6c772013-02-27 08:32:07 -0800148 public:
149 DebugInstrumentationListener() {}
150 virtual ~DebugInstrumentationListener() {}
151
Mathieu Chartiere401d142015-04-22 13:56:20 -0700152 void MethodEntered(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200153 uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700154 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800155 if (method->IsNative()) {
156 // TODO: post location events is a suspension point and native method entry stubs aren't.
157 return;
158 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200159 if (IsListeningToDexPcMoved()) {
160 // We also listen to kDexPcMoved instrumentation event so we know the DexPcMoved method is
161 // going to be called right after us. To avoid sending JDWP events twice for this location,
162 // we report the event in DexPcMoved. However, we must remind this is method entry so we
163 // send the METHOD_ENTRY event. And we can also group it with other events for this location
164 // like BREAKPOINT or SINGLE_STEP (or even METHOD_EXIT if this is a RETURN instruction).
165 thread->SetDebugMethodEntry();
166 } else if (IsListeningToMethodExit() && IsReturn(method, dex_pc)) {
167 // We also listen to kMethodExited instrumentation event and the current instruction is a
168 // RETURN so we know the MethodExited method is going to be called right after us. To avoid
169 // sending JDWP events twice for this location, we report the event(s) in MethodExited.
170 // However, we must remind this is method entry so we send the METHOD_ENTRY event. And we can
171 // also group it with other events for this location like BREAKPOINT or SINGLE_STEP.
172 thread->SetDebugMethodEntry();
173 } else {
174 Dbg::UpdateDebugger(thread, this_object, method, 0, Dbg::kMethodEntry, nullptr);
175 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800176 }
177
Mathieu Chartiere401d142015-04-22 13:56:20 -0700178 void MethodExited(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200179 uint32_t dex_pc, const JValue& return_value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700180 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800181 if (method->IsNative()) {
182 // TODO: post location events is a suspension point and native method entry stubs aren't.
183 return;
184 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200185 uint32_t events = Dbg::kMethodExit;
186 if (thread->IsDebugMethodEntry()) {
187 // It is also the method entry.
188 DCHECK(IsReturn(method, dex_pc));
189 events |= Dbg::kMethodEntry;
190 thread->ClearDebugMethodEntry();
191 }
192 Dbg::UpdateDebugger(thread, this_object, method, dex_pc, events, &return_value);
Ian Rogers62d6c772013-02-27 08:32:07 -0800193 }
194
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200195 void MethodUnwind(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object ATTRIBUTE_UNUSED,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700196 ArtMethod* method, uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700197 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800198 // We're not recorded to listen to this kind of event, so complain.
David Sehr709b0702016-10-13 09:12:37 -0700199 LOG(ERROR) << "Unexpected method unwind event in debugger " << ArtMethod::PrettyMethod(method)
Sebastien Hertz51db44a2013-11-19 10:00:29 +0100200 << " " << dex_pc;
Ian Rogers62d6c772013-02-27 08:32:07 -0800201 }
202
Mathieu Chartiere401d142015-04-22 13:56:20 -0700203 void DexPcMoved(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200204 uint32_t new_dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700205 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200206 if (IsListeningToMethodExit() && IsReturn(method, new_dex_pc)) {
207 // We also listen to kMethodExited instrumentation event and the current instruction is a
208 // RETURN so we know the MethodExited method is going to be called right after us. Like in
209 // MethodEntered, we delegate event reporting to MethodExited.
210 // Besides, if this RETURN instruction is the only one in the method, we can send multiple
211 // JDWP events in the same packet: METHOD_ENTRY, METHOD_EXIT, BREAKPOINT and/or SINGLE_STEP.
212 // Therefore, we must not clear the debug method entry flag here.
213 } else {
214 uint32_t events = 0;
215 if (thread->IsDebugMethodEntry()) {
216 // It is also the method entry.
217 events = Dbg::kMethodEntry;
218 thread->ClearDebugMethodEntry();
219 }
220 Dbg::UpdateDebugger(thread, this_object, method, new_dex_pc, events, nullptr);
221 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800222 }
223
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200224 void FieldRead(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700225 ArtMethod* method, uint32_t dex_pc, ArtField* field)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700226 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200227 Dbg::PostFieldAccessEvent(method, dex_pc, this_object, field);
Ian Rogers62d6c772013-02-27 08:32:07 -0800228 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200229
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700230 void FieldWritten(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700231 ArtMethod* method, uint32_t dex_pc, ArtField* field,
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700232 const JValue& field_value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700233 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200234 Dbg::PostFieldModificationEvent(method, dex_pc, this_object, field, &field_value);
235 }
236
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000237 void ExceptionCaught(Thread* thread ATTRIBUTE_UNUSED, mirror::Throwable* exception_object)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700238 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000239 Dbg::PostException(exception_object);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200240 }
241
Nicolas Geoffray81f0f952016-01-20 16:25:19 +0000242 // We only care about branches in the Jit.
243 void Branch(Thread* /*thread*/, ArtMethod* method, uint32_t dex_pc, int32_t dex_pc_offset)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700244 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr709b0702016-10-13 09:12:37 -0700245 LOG(ERROR) << "Unexpected branch event in debugger " << ArtMethod::PrettyMethod(method)
Nicolas Geoffray81f0f952016-01-20 16:25:19 +0000246 << " " << dex_pc << ", " << dex_pc_offset;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800247 }
248
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100249 // We only care about invokes in the Jit.
250 void InvokeVirtualOrInterface(Thread* thread ATTRIBUTE_UNUSED,
251 mirror::Object*,
252 ArtMethod* method,
253 uint32_t dex_pc,
254 ArtMethod*)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700255 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr709b0702016-10-13 09:12:37 -0700256 LOG(ERROR) << "Unexpected invoke event in debugger " << ArtMethod::PrettyMethod(method)
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100257 << " " << dex_pc;
258 }
259
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200260 private:
Mathieu Chartiere401d142015-04-22 13:56:20 -0700261 static bool IsReturn(ArtMethod* method, uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700262 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200263 const DexFile::CodeItem* code_item = method->GetCodeItem();
264 const Instruction* instruction = Instruction::At(&code_item->insns_[dex_pc]);
265 return instruction->IsReturn();
266 }
267
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700268 static bool IsListeningToDexPcMoved() REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200269 return IsListeningTo(instrumentation::Instrumentation::kDexPcMoved);
270 }
271
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700272 static bool IsListeningToMethodExit() REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200273 return IsListeningTo(instrumentation::Instrumentation::kMethodExited);
274 }
275
276 static bool IsListeningTo(instrumentation::Instrumentation::InstrumentationEvent event)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700277 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200278 return (Dbg::GetInstrumentationEvents() & event) != 0;
279 }
280
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200281 DISALLOW_COPY_AND_ASSIGN(DebugInstrumentationListener);
Ian Rogers62d6c772013-02-27 08:32:07 -0800282} gDebugInstrumentationListener;
283
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700284// JDWP is allowed unless the Zygote forbids it.
285static bool gJdwpAllowed = true;
286
Elliott Hughesc0f09332012-03-26 13:27:06 -0700287// Was there a -Xrunjdwp or -agentlib:jdwp= argument on the command line?
Elliott Hughes3bb81562011-10-21 18:52:59 -0700288static bool gJdwpConfigured = false;
289
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100290// JDWP options for debugging. Only valid if IsJdwpConfigured() is true.
291static JDWP::JdwpOptions gJdwpOptions;
292
Elliott Hughes3bb81562011-10-21 18:52:59 -0700293// Runtime JDWP state.
Ian Rogersc0542af2014-09-03 16:16:56 -0700294static JDWP::JdwpState* gJdwpState = nullptr;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700295static bool gDebuggerConnected; // debugger or DDMS is connected.
Elliott Hughes3bb81562011-10-21 18:52:59 -0700296
Elliott Hughes47fce012011-10-25 18:37:19 -0700297static bool gDdmThreadNotification = false;
298
Elliott Hughes767a1472011-10-26 18:49:02 -0700299// DDMS GC-related settings.
300static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
301static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
302static Dbg::HpsgWhat gDdmHpsgWhat;
303static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
304static Dbg::HpsgWhat gDdmNhsgWhat;
305
Daniel Mihalyieb076692014-08-22 17:33:31 +0200306bool Dbg::gDebuggerActive = false;
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100307bool Dbg::gDisposed = false;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200308ObjectRegistry* Dbg::gRegistry = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700309
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100310// Deoptimization support.
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100311std::vector<DeoptimizationRequest> Dbg::deoptimization_requests_;
312size_t Dbg::full_deoptimization_event_count_ = 0;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100313
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200314// Instrumentation event reference counters.
315size_t Dbg::dex_pc_change_event_ref_count_ = 0;
316size_t Dbg::method_enter_event_ref_count_ = 0;
317size_t Dbg::method_exit_event_ref_count_ = 0;
318size_t Dbg::field_read_event_ref_count_ = 0;
319size_t Dbg::field_write_event_ref_count_ = 0;
320size_t Dbg::exception_catch_event_ref_count_ = 0;
321uint32_t Dbg::instrumentation_events_ = 0;
322
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000323Dbg::DbgThreadLifecycleCallback Dbg::thread_lifecycle_callback_;
Andreas Gampe0f01b582017-01-18 15:22:37 -0800324Dbg::DbgClassLoadCallback Dbg::class_load_callback_;
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000325
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100326// Breakpoints.
jeffhao09bfc6a2012-12-11 18:11:43 -0800327static std::vector<Breakpoint> gBreakpoints GUARDED_BY(Locks::breakpoint_lock_);
Elliott Hughes86964332012-02-15 19:37:42 -0800328
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -0700329void DebugInvokeReq::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
330 receiver.VisitRootIfNonNull(visitor, root_info); // null for static method call.
331 klass.VisitRoot(visitor, root_info);
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -0700332}
333
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100334void SingleStepControl::AddDexPc(uint32_t dex_pc) {
335 dex_pcs_.insert(dex_pc);
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200336}
337
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100338bool SingleStepControl::ContainsDexPc(uint32_t dex_pc) const {
339 return dex_pcs_.find(dex_pc) == dex_pcs_.end();
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200340}
341
Alex Light6c8467f2015-11-20 15:03:26 -0800342static bool IsBreakpoint(ArtMethod* m, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700343 REQUIRES(!Locks::breakpoint_lock_)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700344 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzed2be172014-08-19 15:33:43 +0200345 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100346 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Alex Light6c8467f2015-11-20 15:03:26 -0800347 if (gBreakpoints[i].DexPc() == dex_pc && gBreakpoints[i].IsInMethod(m)) {
Elliott Hughes86964332012-02-15 19:37:42 -0800348 VLOG(jdwp) << "Hit breakpoint #" << i << ": " << gBreakpoints[i];
349 return true;
350 }
351 }
352 return false;
353}
354
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100355static bool IsSuspendedForDebugger(ScopedObjectAccessUnchecked& soa, Thread* thread)
Mathieu Chartier90443472015-07-16 20:32:27 -0700356 REQUIRES(!Locks::thread_suspend_count_lock_) {
Elliott Hughes9e0c1752013-01-09 14:02:58 -0800357 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
358 // A thread may be suspended for GC; in this code, we really want to know whether
359 // there's a debugger suspension active.
360 return thread->IsSuspended() && thread->GetDebugSuspendCount() > 0;
361}
362
Ian Rogersc0542af2014-09-03 16:16:56 -0700363static mirror::Array* DecodeNonNullArray(JDWP::RefTypeId id, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700364 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200365 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700366 if (o == nullptr) {
367 *error = JDWP::ERR_INVALID_OBJECT;
368 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800369 }
370 if (!o->IsArrayInstance()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700371 *error = JDWP::ERR_INVALID_ARRAY;
372 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800373 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700374 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800375 return o->AsArray();
376}
377
Ian Rogersc0542af2014-09-03 16:16:56 -0700378static mirror::Class* DecodeClass(JDWP::RefTypeId id, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700379 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200380 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700381 if (o == nullptr) {
382 *error = JDWP::ERR_INVALID_OBJECT;
383 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800384 }
385 if (!o->IsClass()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700386 *error = JDWP::ERR_INVALID_CLASS;
387 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800388 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700389 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800390 return o->AsClass();
391}
392
Ian Rogersc0542af2014-09-03 16:16:56 -0700393static Thread* DecodeThread(ScopedObjectAccessUnchecked& soa, JDWP::ObjectId thread_id,
394 JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700395 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartier90443472015-07-16 20:32:27 -0700396 REQUIRES(!Locks::thread_list_lock_, !Locks::thread_suspend_count_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200397 mirror::Object* thread_peer = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700398 if (thread_peer == nullptr) {
Elliott Hughes221229c2013-01-08 18:17:50 -0800399 // This isn't even an object.
Ian Rogersc0542af2014-09-03 16:16:56 -0700400 *error = JDWP::ERR_INVALID_OBJECT;
401 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800402 }
Elliott Hughes221229c2013-01-08 18:17:50 -0800403
Mathieu Chartier0795f232016-09-27 18:43:30 -0700404 ObjPtr<mirror::Class> java_lang_Thread =
405 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_Thread);
Elliott Hughes221229c2013-01-08 18:17:50 -0800406 if (!java_lang_Thread->IsAssignableFrom(thread_peer->GetClass())) {
407 // This isn't a thread.
Ian Rogersc0542af2014-09-03 16:16:56 -0700408 *error = JDWP::ERR_INVALID_THREAD;
409 return nullptr;
Elliott Hughes221229c2013-01-08 18:17:50 -0800410 }
411
Sebastien Hertz69206392015-04-07 15:54:25 +0200412 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
Ian Rogersc0542af2014-09-03 16:16:56 -0700413 Thread* thread = Thread::FromManagedThread(soa, thread_peer);
414 // If thread is null then this a java.lang.Thread without a Thread*. Must be a un-started or a
415 // zombie.
416 *error = (thread == nullptr) ? JDWP::ERR_THREAD_NOT_ALIVE : JDWP::ERR_NONE;
417 return thread;
Elliott Hughes436e3722012-02-17 20:01:47 -0800418}
419
Elliott Hughes24437992011-11-30 14:49:33 -0800420static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
421 // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
422 // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
423 return static_cast<JDWP::JdwpTag>(descriptor[0]);
424}
425
Ian Rogers1ff3c982014-08-12 02:30:58 -0700426static JDWP::JdwpTag BasicTagFromClass(mirror::Class* klass)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700427 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers1ff3c982014-08-12 02:30:58 -0700428 std::string temp;
429 const char* descriptor = klass->GetDescriptor(&temp);
430 return BasicTagFromDescriptor(descriptor);
431}
432
Ian Rogers98379392014-02-24 16:53:16 -0800433static JDWP::JdwpTag TagFromClass(const ScopedObjectAccessUnchecked& soa, mirror::Class* c)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700434 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700435 CHECK(c != nullptr);
Elliott Hughes24437992011-11-30 14:49:33 -0800436 if (c->IsArrayClass()) {
437 return JDWP::JT_ARRAY;
438 }
Elliott Hughes24437992011-11-30 14:49:33 -0800439 if (c->IsStringClass()) {
440 return JDWP::JT_STRING;
Elliott Hughes24437992011-11-30 14:49:33 -0800441 }
Ian Rogers98379392014-02-24 16:53:16 -0800442 if (c->IsClassClass()) {
443 return JDWP::JT_CLASS_OBJECT;
444 }
445 {
Mathieu Chartier0795f232016-09-27 18:43:30 -0700446 ObjPtr<mirror::Class> thread_class =
447 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_Thread);
Ian Rogers98379392014-02-24 16:53:16 -0800448 if (thread_class->IsAssignableFrom(c)) {
449 return JDWP::JT_THREAD;
450 }
451 }
452 {
Mathieu Chartier0795f232016-09-27 18:43:30 -0700453 ObjPtr<mirror::Class> thread_group_class =
454 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_ThreadGroup);
Ian Rogers98379392014-02-24 16:53:16 -0800455 if (thread_group_class->IsAssignableFrom(c)) {
456 return JDWP::JT_THREAD_GROUP;
457 }
458 }
459 {
Mathieu Chartier0795f232016-09-27 18:43:30 -0700460 ObjPtr<mirror::Class> class_loader_class =
461 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_ClassLoader);
Ian Rogers98379392014-02-24 16:53:16 -0800462 if (class_loader_class->IsAssignableFrom(c)) {
463 return JDWP::JT_CLASS_LOADER;
464 }
465 }
466 return JDWP::JT_OBJECT;
Elliott Hughes24437992011-11-30 14:49:33 -0800467}
468
469/*
470 * Objects declared to hold Object might actually hold a more specific
471 * type. The debugger may take a special interest in these (e.g. it
472 * wants to display the contents of Strings), so we want to return an
473 * appropriate tag.
474 *
475 * Null objects are tagged JT_OBJECT.
476 */
Sebastien Hertz6995c602014-09-09 12:10:13 +0200477JDWP::JdwpTag Dbg::TagFromObject(const ScopedObjectAccessUnchecked& soa, mirror::Object* o) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700478 return (o == nullptr) ? JDWP::JT_OBJECT : TagFromClass(soa, o->GetClass());
Elliott Hughes24437992011-11-30 14:49:33 -0800479}
480
481static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
482 switch (tag) {
483 case JDWP::JT_BOOLEAN:
484 case JDWP::JT_BYTE:
485 case JDWP::JT_CHAR:
486 case JDWP::JT_FLOAT:
487 case JDWP::JT_DOUBLE:
488 case JDWP::JT_INT:
489 case JDWP::JT_LONG:
490 case JDWP::JT_SHORT:
491 case JDWP::JT_VOID:
492 return true;
493 default:
494 return false;
495 }
496}
497
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100498void Dbg::StartJdwp() {
Elliott Hughesc0f09332012-03-26 13:27:06 -0700499 if (!gJdwpAllowed || !IsJdwpConfigured()) {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700500 // No JDWP for you!
501 return;
502 }
503
Ian Rogers719d1a32014-03-06 12:13:39 -0800504 CHECK(gRegistry == nullptr);
Elliott Hughes475fc232011-10-25 15:00:35 -0700505 gRegistry = new ObjectRegistry;
506
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700507 // Init JDWP if the debugger is enabled. This may connect out to a
508 // debugger, passively listen for a debugger, or block waiting for a
509 // debugger.
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100510 gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
Ian Rogersc0542af2014-09-03 16:16:56 -0700511 if (gJdwpState == nullptr) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -0800512 // We probably failed because some other process has the port already, which means that
513 // if we don't abort the user is likely to think they're talking to us when they're actually
514 // talking to that other process.
Elliott Hughes3d30d9b2011-12-07 17:35:48 -0800515 LOG(FATAL) << "Debugger thread failed to initialize";
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700516 }
517
518 // If a debugger has already attached, send the "welcome" message.
519 // This may cause us to suspend all threads.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700520 if (gJdwpState->IsActive()) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700521 ScopedObjectAccess soa(Thread::Current());
Sebastien Hertz7d955652014-10-22 10:57:10 +0200522 gJdwpState->PostVMStart();
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700523 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700524}
525
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700526void Dbg::StopJdwp() {
Sebastien Hertzc6345ef2014-08-18 19:26:39 +0200527 // Post VM_DEATH event before the JDWP connection is closed (either by the JDWP thread or the
528 // destruction of gJdwpState).
529 if (gJdwpState != nullptr && gJdwpState->IsActive()) {
530 gJdwpState->PostVMDeath();
531 }
Sebastien Hertz0376e6b2014-02-06 18:12:59 +0100532 // Prevent the JDWP thread from processing JDWP incoming packets after we close the connection.
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100533 Dispose();
Elliott Hughes376a7a02011-10-24 18:35:55 -0700534 delete gJdwpState;
Ian Rogers719d1a32014-03-06 12:13:39 -0800535 gJdwpState = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700536 delete gRegistry;
Ian Rogers719d1a32014-03-06 12:13:39 -0800537 gRegistry = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700538}
539
Elliott Hughes767a1472011-10-26 18:49:02 -0700540void Dbg::GcDidFinish() {
541 if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700542 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700543 VLOG(jdwp) << "Sending heap info to DDM";
Elliott Hughes7162ad92011-10-27 14:08:42 -0700544 DdmSendHeapInfo(gDdmHpifWhen);
Elliott Hughes767a1472011-10-26 18:49:02 -0700545 }
546 if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700547 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700548 VLOG(jdwp) << "Dumping heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700549 DdmSendHeapSegments(false);
Elliott Hughes767a1472011-10-26 18:49:02 -0700550 }
551 if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700552 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700553 VLOG(jdwp) << "Dumping native heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700554 DdmSendHeapSegments(true);
Elliott Hughes767a1472011-10-26 18:49:02 -0700555 }
556}
557
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700558void Dbg::SetJdwpAllowed(bool allowed) {
559 gJdwpAllowed = allowed;
560}
561
Leonard Mosescueb842212016-10-06 17:26:36 -0700562bool Dbg::IsJdwpAllowed() {
563 return gJdwpAllowed;
564}
565
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700566DebugInvokeReq* Dbg::GetInvokeReq() {
Elliott Hughes475fc232011-10-25 15:00:35 -0700567 return Thread::Current()->GetInvokeReq();
568}
569
570Thread* Dbg::GetDebugThread() {
Ian Rogersc0542af2014-09-03 16:16:56 -0700571 return (gJdwpState != nullptr) ? gJdwpState->GetDebugThread() : nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700572}
573
574void Dbg::ClearWaitForEventThread() {
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100575 gJdwpState->ReleaseJdwpTokenForEvent();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700576}
577
578void Dbg::Connected() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700579 CHECK(!gDebuggerConnected);
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -0800580 VLOG(jdwp) << "JDWP has attached";
Elliott Hughes3bb81562011-10-21 18:52:59 -0700581 gDebuggerConnected = true;
Elliott Hughes86964332012-02-15 19:37:42 -0800582 gDisposed = false;
583}
584
Sebastien Hertzf3928792014-11-17 19:00:37 +0100585bool Dbg::RequiresDeoptimization() {
586 // We don't need deoptimization if everything runs with interpreter after
587 // enabling -Xint mode.
588 return !Runtime::Current()->GetInstrumentation()->IsForcedInterpretOnly();
589}
590
Elliott Hughesa2155262011-11-16 16:26:58 -0800591void Dbg::GoActive() {
592 // Enable all debugging features, including scans for breakpoints.
593 // This is a no-op if we're already active.
594 // Only called from the JDWP handler thread.
Daniel Mihalyieb076692014-08-22 17:33:31 +0200595 if (IsDebuggerActive()) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800596 return;
597 }
598
Mathieu Chartieraa516822015-10-02 15:53:37 -0700599 Thread* const self = Thread::Current();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700600 {
601 // TODO: dalvik only warned if there were breakpoints left over. clear in Dbg::Disconnected?
Mathieu Chartieraa516822015-10-02 15:53:37 -0700602 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700603 CHECK_EQ(gBreakpoints.size(), 0U);
604 }
Elliott Hughesa2155262011-11-16 16:26:58 -0800605
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100606 {
Mathieu Chartieraa516822015-10-02 15:53:37 -0700607 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100608 CHECK_EQ(deoptimization_requests_.size(), 0U);
609 CHECK_EQ(full_deoptimization_event_count_, 0U);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200610 CHECK_EQ(dex_pc_change_event_ref_count_, 0U);
611 CHECK_EQ(method_enter_event_ref_count_, 0U);
612 CHECK_EQ(method_exit_event_ref_count_, 0U);
613 CHECK_EQ(field_read_event_ref_count_, 0U);
614 CHECK_EQ(field_write_event_ref_count_, 0U);
615 CHECK_EQ(exception_catch_event_ref_count_, 0U);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100616 }
617
Ian Rogers62d6c772013-02-27 08:32:07 -0800618 Runtime* runtime = Runtime::Current();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000619 // Best effort deoptimization if the runtime is non-Java debuggable. This happens when
620 // ro.debuggable is set, but the application is not debuggable, or when a standalone
621 // dalvikvm invocation is not passed the debuggable option (-Xcompiler-option --debuggable).
622 //
623 // The performance cost of this is non-negligible during native-debugging due to the
David Srbeckyf4480162016-03-16 00:06:24 +0000624 // forced JIT, so we keep the AOT code in that case in exchange for limited native debugging.
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000625 if (!runtime->IsJavaDebuggable() &&
626 !runtime->GetInstrumentation()->IsForcedInterpretOnly() &&
627 !runtime->IsNativeDebuggable()) {
628 runtime->DeoptimizeBootImage();
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -0800629 }
630
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700631 ScopedSuspendAll ssa(__FUNCTION__);
Sebastien Hertzf3928792014-11-17 19:00:37 +0100632 if (RequiresDeoptimization()) {
633 runtime->GetInstrumentation()->EnableDeoptimization();
634 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200635 instrumentation_events_ = 0;
Elliott Hughesa2155262011-11-16 16:26:58 -0800636 gDebuggerActive = true;
Ian Rogers62d6c772013-02-27 08:32:07 -0800637 LOG(INFO) << "Debugger is active";
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700638}
639
640void Dbg::Disconnected() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700641 CHECK(gDebuggerConnected);
642
Elliott Hughesc0f09332012-03-26 13:27:06 -0700643 LOG(INFO) << "Debugger is no longer active";
Elliott Hughes234ab152011-10-26 14:02:26 -0700644
Hiroshi Yamauchi98810e32016-05-24 14:55:40 -0700645 // Suspend all threads and exclusively acquire the mutator lock. Remove the debugger as a listener
Ian Rogers62d6c772013-02-27 08:32:07 -0800646 // and clear the object registry.
647 Runtime* runtime = Runtime::Current();
Ian Rogers62d6c772013-02-27 08:32:07 -0800648 Thread* self = Thread::Current();
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700649 {
Mathieu Chartieraa516822015-10-02 15:53:37 -0700650 // Required for DisableDeoptimization.
651 gc::ScopedGCCriticalSection gcs(self,
652 gc::kGcCauseInstrumentation,
653 gc::kCollectorTypeInstrumentation);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700654 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700655 // Debugger may not be active at this point.
656 if (IsDebuggerActive()) {
657 {
658 // Since we're going to disable deoptimization, we clear the deoptimization requests queue.
659 // This prevents us from having any pending deoptimization request when the debugger attaches
660 // to us again while no event has been requested yet.
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -0700661 MutexLock mu(self, *Locks::deoptimization_lock_);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700662 deoptimization_requests_.clear();
663 full_deoptimization_event_count_ = 0U;
664 }
665 if (instrumentation_events_ != 0) {
666 runtime->GetInstrumentation()->RemoveListener(&gDebugInstrumentationListener,
667 instrumentation_events_);
668 instrumentation_events_ = 0;
669 }
670 if (RequiresDeoptimization()) {
671 runtime->GetInstrumentation()->DisableDeoptimization(kDbgInstrumentationKey);
672 }
673 gDebuggerActive = false;
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100674 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100675 }
Sebastien Hertz55f65342015-01-13 22:48:34 +0100676
677 {
678 ScopedObjectAccess soa(self);
679 gRegistry->Clear();
680 }
681
682 gDebuggerConnected = false;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700683}
684
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100685void Dbg::ConfigureJdwp(const JDWP::JdwpOptions& jdwp_options) {
686 CHECK_NE(jdwp_options.transport, JDWP::kJdwpTransportUnknown);
687 gJdwpOptions = jdwp_options;
688 gJdwpConfigured = true;
689}
690
Elliott Hughesc0f09332012-03-26 13:27:06 -0700691bool Dbg::IsJdwpConfigured() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700692 return gJdwpConfigured;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700693}
694
695int64_t Dbg::LastDebuggerActivity() {
Elliott Hughesca951522011-12-05 12:01:32 -0800696 return gJdwpState->LastDebuggerActivity();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700697}
698
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700699void Dbg::UndoDebuggerSuspensions() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700700 Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700701}
702
Elliott Hughes88d63092013-01-09 09:55:54 -0800703std::string Dbg::GetClassName(JDWP::RefTypeId class_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700704 JDWP::JdwpError error;
705 mirror::Object* o = gRegistry->Get<mirror::Object*>(class_id, &error);
706 if (o == nullptr) {
707 if (error == JDWP::ERR_NONE) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700708 return "null";
Ian Rogersc0542af2014-09-03 16:16:56 -0700709 } else {
710 return StringPrintf("invalid object %p", reinterpret_cast<void*>(class_id));
711 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800712 }
713 if (!o->IsClass()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700714 return StringPrintf("non-class %p", o); // This is only used for debugging output anyway.
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800715 }
Sebastien Hertz6995c602014-09-09 12:10:13 +0200716 return GetClassName(o->AsClass());
717}
718
719std::string Dbg::GetClassName(mirror::Class* klass) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200720 if (klass == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700721 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200722 }
Ian Rogers1ff3c982014-08-12 02:30:58 -0700723 std::string temp;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200724 return DescriptorToName(klass->GetDescriptor(&temp));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700725}
726
Ian Rogersc0542af2014-09-03 16:16:56 -0700727JDWP::JdwpError Dbg::GetClassObject(JDWP::RefTypeId id, JDWP::ObjectId* class_object_id) {
Elliott Hughes436e3722012-02-17 20:01:47 -0800728 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700729 mirror::Class* c = DecodeClass(id, &status);
730 if (c == nullptr) {
731 *class_object_id = 0;
Elliott Hughes436e3722012-02-17 20:01:47 -0800732 return status;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800733 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700734 *class_object_id = gRegistry->Add(c);
Elliott Hughes436e3722012-02-17 20:01:47 -0800735 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -0800736}
737
Ian Rogersc0542af2014-09-03 16:16:56 -0700738JDWP::JdwpError Dbg::GetSuperclass(JDWP::RefTypeId id, JDWP::RefTypeId* superclass_id) {
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800739 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700740 mirror::Class* c = DecodeClass(id, &status);
741 if (c == nullptr) {
742 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800743 return status;
744 }
745 if (c->IsInterface()) {
746 // http://code.google.com/p/android/issues/detail?id=20856
Ian Rogersc0542af2014-09-03 16:16:56 -0700747 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800748 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700749 *superclass_id = gRegistry->Add(c->GetSuperClass());
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800750 }
751 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700752}
753
Elliott Hughes436e3722012-02-17 20:01:47 -0800754JDWP::JdwpError Dbg::GetClassLoader(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700755 JDWP::JdwpError error;
Andreas Gampe7929a482015-12-30 19:33:49 -0800756 mirror::Class* c = DecodeClass(id, &error);
757 if (c == nullptr) {
758 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -0800759 }
Andreas Gampe7929a482015-12-30 19:33:49 -0800760 expandBufAddObjectId(pReply, gRegistry->Add(c->GetClassLoader()));
Elliott Hughes436e3722012-02-17 20:01:47 -0800761 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700762}
763
Elliott Hughes436e3722012-02-17 20:01:47 -0800764JDWP::JdwpError Dbg::GetModifiers(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700765 JDWP::JdwpError error;
766 mirror::Class* c = DecodeClass(id, &error);
767 if (c == nullptr) {
768 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800769 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800770
771 uint32_t access_flags = c->GetAccessFlags() & kAccJavaFlagsMask;
772
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700773 // Set ACC_SUPER. Dex files don't contain this flag but only classes are supposed to have it set,
774 // not interfaces.
Elliott Hughes436e3722012-02-17 20:01:47 -0800775 // Class.getModifiers doesn't return it, but JDWP does, so we set it here.
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700776 if ((access_flags & kAccInterface) == 0) {
777 access_flags |= kAccSuper;
778 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800779
780 expandBufAdd4BE(pReply, access_flags);
781
782 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700783}
784
Ian Rogersc0542af2014-09-03 16:16:56 -0700785JDWP::JdwpError Dbg::GetMonitorInfo(JDWP::ObjectId object_id, JDWP::ExpandBuf* reply) {
786 JDWP::JdwpError error;
787 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
788 if (o == nullptr) {
Elliott Hughesf327e072013-01-09 16:01:26 -0800789 return JDWP::ERR_INVALID_OBJECT;
790 }
791
792 // Ensure all threads are suspended while we read objects' lock words.
793 Thread* self = Thread::Current();
Sebastien Hertz54263242014-03-19 18:16:50 +0100794 CHECK_EQ(self->GetState(), kRunnable);
Elliott Hughesf327e072013-01-09 16:01:26 -0800795
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700796 MonitorInfo monitor_info;
797 {
798 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700799 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700800 monitor_info = MonitorInfo(o);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700801 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700802 if (monitor_info.owner_ != nullptr) {
Nicolas Geoffraycafa0812017-02-15 18:27:34 +0000803 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.owner_->GetPeerFromOtherThread()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800804 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700805 expandBufAddObjectId(reply, gRegistry->Add(nullptr));
Elliott Hughesf327e072013-01-09 16:01:26 -0800806 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700807 expandBufAdd4BE(reply, monitor_info.entry_count_);
808 expandBufAdd4BE(reply, monitor_info.waiters_.size());
809 for (size_t i = 0; i < monitor_info.waiters_.size(); ++i) {
Nicolas Geoffraycafa0812017-02-15 18:27:34 +0000810 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.waiters_[i]->GetPeerFromOtherThread()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800811 }
812 return JDWP::ERR_NONE;
813}
814
Elliott Hughes734b8c62013-01-11 15:32:45 -0800815JDWP::JdwpError Dbg::GetOwnedMonitors(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700816 std::vector<JDWP::ObjectId>* monitors,
817 std::vector<uint32_t>* stack_depths) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800818 struct OwnedMonitorVisitor : public StackVisitor {
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700819 OwnedMonitorVisitor(Thread* thread, Context* context,
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700820 std::vector<JDWP::ObjectId>* monitor_vector,
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700821 std::vector<uint32_t>* stack_depth_vector)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700822 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +0100823 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
824 current_stack_depth(0),
825 monitors(monitor_vector),
826 stack_depths(stack_depth_vector) {}
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800827
828 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
829 // annotalysis.
830 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
831 if (!GetMethod()->IsRuntimeMethod()) {
832 Monitor::VisitLocks(this, AppendOwnedMonitors, this);
Elliott Hughes734b8c62013-01-11 15:32:45 -0800833 ++current_stack_depth;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800834 }
835 return true;
836 }
837
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700838 static void AppendOwnedMonitors(mirror::Object* owned_monitor, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700839 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers7a22fa62013-01-23 12:16:16 -0800840 OwnedMonitorVisitor* visitor = reinterpret_cast<OwnedMonitorVisitor*>(arg);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700841 visitor->monitors->push_back(gRegistry->Add(owned_monitor));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700842 visitor->stack_depths->push_back(visitor->current_stack_depth);
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800843 }
844
Elliott Hughes734b8c62013-01-11 15:32:45 -0800845 size_t current_stack_depth;
Ian Rogersc0542af2014-09-03 16:16:56 -0700846 std::vector<JDWP::ObjectId>* const monitors;
847 std::vector<uint32_t>* const stack_depths;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800848 };
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800849
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700850 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +0200851 JDWP::JdwpError error;
852 Thread* thread = DecodeThread(soa, thread_id, &error);
853 if (thread == nullptr) {
854 return error;
855 }
856 if (!IsSuspendedForDebugger(soa, thread)) {
857 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700858 }
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700859 std::unique_ptr<Context> context(Context::Create());
Ian Rogersc0542af2014-09-03 16:16:56 -0700860 OwnedMonitorVisitor visitor(thread, context.get(), monitors, stack_depths);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700861 visitor.WalkStack();
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800862 return JDWP::ERR_NONE;
863}
864
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100865JDWP::JdwpError Dbg::GetContendedMonitor(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700866 JDWP::ObjectId* contended_monitor) {
Elliott Hughesf9501702013-01-11 11:22:27 -0800867 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -0700868 *contended_monitor = 0;
Sebastien Hertz69206392015-04-07 15:54:25 +0200869 JDWP::JdwpError error;
870 Thread* thread = DecodeThread(soa, thread_id, &error);
871 if (thread == nullptr) {
872 return error;
Elliott Hughesf9501702013-01-11 11:22:27 -0800873 }
Sebastien Hertz69206392015-04-07 15:54:25 +0200874 if (!IsSuspendedForDebugger(soa, thread)) {
875 return JDWP::ERR_THREAD_NOT_SUSPENDED;
876 }
877 mirror::Object* contended_monitor_obj = Monitor::GetContendedMonitor(thread);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700878 // Add() requires the thread_list_lock_ not held to avoid the lock
879 // level violation.
Ian Rogersc0542af2014-09-03 16:16:56 -0700880 *contended_monitor = gRegistry->Add(contended_monitor_obj);
Elliott Hughesf9501702013-01-11 11:22:27 -0800881 return JDWP::ERR_NONE;
882}
883
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800884JDWP::JdwpError Dbg::GetInstanceCounts(const std::vector<JDWP::RefTypeId>& class_ids,
Ian Rogersc0542af2014-09-03 16:16:56 -0700885 std::vector<uint64_t>* counts) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800886 gc::Heap* heap = Runtime::Current()->GetHeap();
887 heap->CollectGarbage(false);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -0700888 VariableSizedHandleScope hs(Thread::Current());
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700889 std::vector<Handle<mirror::Class>> classes;
Ian Rogersc0542af2014-09-03 16:16:56 -0700890 counts->clear();
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800891 for (size_t i = 0; i < class_ids.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700892 JDWP::JdwpError error;
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700893 ObjPtr<mirror::Class> c = DecodeClass(class_ids[i], &error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700894 if (c == nullptr) {
895 return error;
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800896 }
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700897 classes.push_back(hs.NewHandle(c));
Ian Rogersc0542af2014-09-03 16:16:56 -0700898 counts->push_back(0);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800899 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700900 heap->CountInstances(classes, false, &(*counts)[0]);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800901 return JDWP::ERR_NONE;
902}
903
Ian Rogersc0542af2014-09-03 16:16:56 -0700904JDWP::JdwpError Dbg::GetInstances(JDWP::RefTypeId class_id, int32_t max_count,
905 std::vector<JDWP::ObjectId>* instances) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800906 gc::Heap* heap = Runtime::Current()->GetHeap();
907 // We only want reachable instances, so do a GC.
908 heap->CollectGarbage(false);
Ian Rogersc0542af2014-09-03 16:16:56 -0700909 JDWP::JdwpError error;
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700910 ObjPtr<mirror::Class> c = DecodeClass(class_id, &error);
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800911 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700912 return error;
Elliott Hughes3b78c942013-01-15 17:35:41 -0800913 }
Mathieu Chartier2d855952016-10-12 19:37:59 -0700914 VariableSizedHandleScope hs(Thread::Current());
915 std::vector<Handle<mirror::Object>> raw_instances;
916 Runtime::Current()->GetHeap()->GetInstances(hs, hs.NewHandle(c), max_count, raw_instances);
Elliott Hughes3b78c942013-01-15 17:35:41 -0800917 for (size_t i = 0; i < raw_instances.size(); ++i) {
Mathieu Chartier2d855952016-10-12 19:37:59 -0700918 instances->push_back(gRegistry->Add(raw_instances[i].Get()));
Elliott Hughes3b78c942013-01-15 17:35:41 -0800919 }
920 return JDWP::ERR_NONE;
921}
922
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800923JDWP::JdwpError Dbg::GetReferringObjects(JDWP::ObjectId object_id, int32_t max_count,
Ian Rogersc0542af2014-09-03 16:16:56 -0700924 std::vector<JDWP::ObjectId>* referring_objects) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800925 gc::Heap* heap = Runtime::Current()->GetHeap();
926 heap->CollectGarbage(false);
Ian Rogersc0542af2014-09-03 16:16:56 -0700927 JDWP::JdwpError error;
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700928 ObjPtr<mirror::Object> o = gRegistry->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700929 if (o == nullptr) {
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800930 return JDWP::ERR_INVALID_OBJECT;
931 }
Mathieu Chartieraea9bfb2016-10-12 19:19:56 -0700932 VariableSizedHandleScope hs(Thread::Current());
933 std::vector<Handle<mirror::Object>> raw_instances;
934 heap->GetReferringObjects(hs, hs.NewHandle(o), max_count, raw_instances);
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800935 for (size_t i = 0; i < raw_instances.size(); ++i) {
Mathieu Chartieraea9bfb2016-10-12 19:19:56 -0700936 referring_objects->push_back(gRegistry->Add(raw_instances[i].Get()));
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
Mathieu Chartier3398c782016-09-30 10:27:43 -0700985JDWP::JdwpTypeTag Dbg::GetTypeTag(ObjPtr<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 Chartier28357fa2016-10-18 16:27:40 -07001016 bool operator()(ObjPtr<mirror::Class> c) OVERRIDE REQUIRES_SHARED(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) {
Mathieu Chartier28357fa2016-10-18 16:27:40 -07001060 std::vector<ObjPtr<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();
Mathieu Chartier28357fa2016-10-18 16:27:40 -07001063 for (ObjPtr<mirror::Class> c : classes) {
1064 ids->push_back(gRegistry->Add(c));
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
Orion Hodson70a45012017-03-30 16:30:31 +01001095JDWP::JdwpError Dbg::GetSourceDebugExtension(JDWP::RefTypeId class_id,
1096 std::string* extension_data) {
1097 JDWP::JdwpError error;
1098 mirror::Class* c = DecodeClass(class_id, &error);
1099 if (c == nullptr) {
1100 return error;
1101 }
1102 StackHandleScope<1> hs(Thread::Current());
1103 Handle<mirror::Class> klass(hs.NewHandle(c));
1104 const char* data = annotations::GetSourceDebugExtension(klass);
1105 if (data == nullptr) {
1106 return JDWP::ERR_ABSENT_INFORMATION;
1107 }
1108 *extension_data = data;
1109 return JDWP::ERR_NONE;
1110}
1111
Ian Rogersc0542af2014-09-03 16:16:56 -07001112JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1113 JDWP::JdwpError error;
1114 mirror::Class* c = DecodeClass(class_id, &error);
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001115 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001116 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001117 }
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001118 const char* source_file = c->GetSourceFile();
1119 if (source_file == nullptr) {
Sebastien Hertzb7054ba2014-03-13 11:52:31 +01001120 return JDWP::ERR_ABSENT_INFORMATION;
1121 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001122 *result = source_file;
Elliott Hughes436e3722012-02-17 20:01:47 -08001123 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001124}
1125
Ian Rogersc0542af2014-09-03 16:16:56 -07001126JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
Ian Rogers98379392014-02-24 16:53:16 -08001127 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001128 JDWP::JdwpError error;
1129 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1130 if (error != JDWP::ERR_NONE) {
1131 *tag = JDWP::JT_VOID;
1132 return error;
Elliott Hughes546b9862012-06-20 16:06:13 -07001133 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001134 *tag = TagFromObject(soa, o);
Elliott Hughes546b9862012-06-20 16:06:13 -07001135 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001136}
1137
Elliott Hughesaed4be92011-12-02 16:16:23 -08001138size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001139 switch (tag) {
1140 case JDWP::JT_VOID:
1141 return 0;
1142 case JDWP::JT_BYTE:
1143 case JDWP::JT_BOOLEAN:
1144 return 1;
1145 case JDWP::JT_CHAR:
1146 case JDWP::JT_SHORT:
1147 return 2;
1148 case JDWP::JT_FLOAT:
1149 case JDWP::JT_INT:
1150 return 4;
1151 case JDWP::JT_ARRAY:
1152 case JDWP::JT_OBJECT:
1153 case JDWP::JT_STRING:
1154 case JDWP::JT_THREAD:
1155 case JDWP::JT_THREAD_GROUP:
1156 case JDWP::JT_CLASS_LOADER:
1157 case JDWP::JT_CLASS_OBJECT:
1158 return sizeof(JDWP::ObjectId);
1159 case JDWP::JT_DOUBLE:
1160 case JDWP::JT_LONG:
1161 return 8;
1162 default:
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08001163 LOG(FATAL) << "Unknown tag " << tag;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001164 return -1;
1165 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001166}
1167
Ian Rogersc0542af2014-09-03 16:16:56 -07001168JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1169 JDWP::JdwpError error;
1170 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1171 if (a == nullptr) {
1172 return error;
Elliott Hughes24437992011-11-30 14:49:33 -08001173 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001174 *length = a->GetLength();
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001175 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001176}
1177
Elliott Hughes88d63092013-01-09 09:55:54 -08001178JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001179 JDWP::JdwpError error;
1180 mirror::Array* a = DecodeNonNullArray(array_id, &error);
Ian Rogers98379392014-02-24 16:53:16 -08001181 if (a == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001182 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001183 }
Elliott Hughes24437992011-11-30 14:49:33 -08001184
1185 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1186 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001187 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughes24437992011-11-30 14:49:33 -08001188 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001189 JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1190 expandBufAdd1(pReply, element_tag);
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001191 expandBufAdd4BE(pReply, count);
1192
Ian Rogers1ff3c982014-08-12 02:30:58 -07001193 if (IsPrimitiveTag(element_tag)) {
1194 size_t width = GetTagWidth(element_tag);
Elliott Hughes24437992011-11-30 14:49:33 -08001195 uint8_t* dst = expandBufAddSpace(pReply, count * width);
1196 if (width == 8) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001197 const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001198 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1199 } else if (width == 4) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001200 const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001201 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1202 } else if (width == 2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001203 const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001204 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1205 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001206 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001207 memcpy(dst, &src[offset * width], count * width);
1208 }
1209 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001210 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001211 mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
Elliott Hughes24437992011-11-30 14:49:33 -08001212 for (int i = 0; i < count; ++i) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001213 mirror::Object* element = oa->Get(offset + i);
Ian Rogers98379392014-02-24 16:53:16 -08001214 JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
Ian Rogers1ff3c982014-08-12 02:30:58 -07001215 : element_tag;
Elliott Hughes24437992011-11-30 14:49:33 -08001216 expandBufAdd1(pReply, specific_tag);
1217 expandBufAddObjectId(pReply, gRegistry->Add(element));
1218 }
1219 }
1220
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001221 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001222}
1223
Ian Rogersef7d42f2014-01-06 12:55:46 -08001224template <typename T>
Ian Rogersc0542af2014-09-03 16:16:56 -07001225static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
Ian Rogersef7d42f2014-01-06 12:55:46 -08001226 NO_THREAD_SAFETY_ANALYSIS {
1227 // TODO: fix when annotalysis correctly handles non-member functions.
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001228 DCHECK(a->GetClass()->IsPrimitiveArray());
1229
Ian Rogersef7d42f2014-01-06 12:55:46 -08001230 T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001231 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001232 *dst++ = src->ReadValue(sizeof(T));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001233 }
1234}
1235
Elliott Hughes88d63092013-01-09 09:55:54 -08001236JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
Ian Rogersc0542af2014-09-03 16:16:56 -07001237 JDWP::Request* request) {
1238 JDWP::JdwpError error;
1239 mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1240 if (dst == nullptr) {
1241 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001242 }
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001243
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001244 if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001245 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001246 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001247 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001248 JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001249
Ian Rogers1ff3c982014-08-12 02:30:58 -07001250 if (IsPrimitiveTag(element_tag)) {
1251 size_t width = GetTagWidth(element_tag);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001252 if (width == 8) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001253 CopyArrayData<uint64_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001254 } else if (width == 4) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001255 CopyArrayData<uint32_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001256 } else if (width == 2) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001257 CopyArrayData<uint16_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001258 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001259 CopyArrayData<uint8_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001260 }
1261 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001262 mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001263 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001264 JDWP::ObjectId id = request->ReadObjectId();
Ian Rogersc0542af2014-09-03 16:16:56 -07001265 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1266 if (error != JDWP::ERR_NONE) {
1267 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -08001268 }
Sebastien Hertz2e1c16d2015-08-28 11:57:49 +02001269 // Check if the object's type is compatible with the array's type.
1270 if (o != nullptr && !o->InstanceOf(oa->GetClass()->GetComponentType())) {
1271 return JDWP::ERR_TYPE_MISMATCH;
1272 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001273 oa->Set<false>(offset + i, o);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001274 }
1275 }
1276
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001277 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001278}
1279
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001280JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1281 Thread* self = Thread::Current();
1282 mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1283 if (new_string == nullptr) {
1284 DCHECK(self->IsExceptionPending());
1285 self->ClearException();
1286 LOG(ERROR) << "Could not allocate string";
1287 *new_string_id = 0;
1288 return JDWP::ERR_OUT_OF_MEMORY;
1289 }
1290 *new_string_id = gRegistry->Add(new_string);
1291 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001292}
1293
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001294JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001295 JDWP::JdwpError error;
1296 mirror::Class* c = DecodeClass(class_id, &error);
1297 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001298 *new_object_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001299 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001300 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001301 Thread* self = Thread::Current();
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07001302 ObjPtr<mirror::Object> new_object;
Sebastien Hertz56d5e502015-11-03 17:38:35 +01001303 if (c->IsStringClass()) {
1304 // Special case for java.lang.String.
1305 gc::AllocatorType allocator_type = Runtime::Current()->GetHeap()->GetCurrentAllocator();
jessicahandojo3aaa37b2016-07-29 14:46:37 -07001306 new_object = mirror::String::AllocEmptyString<true>(self, allocator_type);
Sebastien Hertz56d5e502015-11-03 17:38:35 +01001307 } else {
1308 new_object = c->AllocObject(self);
1309 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001310 if (new_object == nullptr) {
1311 DCHECK(self->IsExceptionPending());
1312 self->ClearException();
David Sehr709b0702016-10-13 09:12:37 -07001313 LOG(ERROR) << "Could not allocate object of type " << mirror::Class::PrettyDescriptor(c);
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001314 *new_object_id = 0;
1315 return JDWP::ERR_OUT_OF_MEMORY;
1316 }
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07001317 *new_object_id = gRegistry->Add(new_object.Ptr());
Elliott Hughes436e3722012-02-17 20:01:47 -08001318 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001319}
1320
Elliott Hughesbf13d362011-12-08 15:51:37 -08001321/*
1322 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1323 */
Elliott Hughes88d63092013-01-09 09:55:54 -08001324JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001325 JDWP::ObjectId* new_array_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001326 JDWP::JdwpError error;
1327 mirror::Class* c = DecodeClass(array_class_id, &error);
1328 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001329 *new_array_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001330 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001331 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001332 Thread* self = Thread::Current();
1333 gc::Heap* heap = Runtime::Current()->GetHeap();
1334 mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1335 c->GetComponentSizeShift(),
1336 heap->GetCurrentAllocator());
1337 if (new_array == nullptr) {
1338 DCHECK(self->IsExceptionPending());
1339 self->ClearException();
David Sehr709b0702016-10-13 09:12:37 -07001340 LOG(ERROR) << "Could not allocate array of type " << mirror::Class::PrettyDescriptor(c);
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001341 *new_array_id = 0;
1342 return JDWP::ERR_OUT_OF_MEMORY;
1343 }
1344 *new_array_id = gRegistry->Add(new_array);
Elliott Hughes436e3722012-02-17 20:01:47 -08001345 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001346}
1347
Mathieu Chartierc7853442015-03-27 14:35:38 -07001348JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001349 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
Elliott Hughes03181a82011-11-17 17:22:21 -08001350}
1351
Alex Light6c8467f2015-11-20 15:03:26 -08001352static JDWP::MethodId ToMethodId(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001353 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light6c8467f2015-11-20 15:03:26 -08001354 return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(GetCanonicalMethod(m)));
Elliott Hughes03181a82011-11-17 17:22:21 -08001355}
1356
Mathieu Chartierc7853442015-03-27 14:35:38 -07001357static ArtField* FromFieldId(JDWP::FieldId fid)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001358 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001359 return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
Elliott Hughesaed4be92011-12-02 16:16:23 -08001360}
1361
Mathieu Chartiere401d142015-04-22 13:56:20 -07001362static ArtMethod* FromMethodId(JDWP::MethodId mid)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001363 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001364 return reinterpret_cast<ArtMethod*>(static_cast<uintptr_t>(mid));
Elliott Hughes03181a82011-11-17 17:22:21 -08001365}
1366
Sebastien Hertz6995c602014-09-09 12:10:13 +02001367bool Dbg::MatchThread(JDWP::ObjectId expected_thread_id, Thread* event_thread) {
1368 CHECK(event_thread != nullptr);
1369 JDWP::JdwpError error;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001370 mirror::Object* expected_thread_peer = gRegistry->Get<mirror::Object*>(
1371 expected_thread_id, &error);
Nicolas Geoffraycafa0812017-02-15 18:27:34 +00001372 return expected_thread_peer == event_thread->GetPeerFromOtherThread();
Sebastien Hertz6995c602014-09-09 12:10:13 +02001373}
1374
1375bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1376 const JDWP::EventLocation& event_location) {
1377 if (expected_location.dex_pc != event_location.dex_pc) {
1378 return false;
1379 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001380 ArtMethod* m = FromMethodId(expected_location.method_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001381 return m == event_location.method;
1382}
1383
Mathieu Chartier3398c782016-09-30 10:27:43 -07001384bool Dbg::MatchType(ObjPtr<mirror::Class> event_class, JDWP::RefTypeId class_id) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001385 if (event_class == nullptr) {
1386 return false;
1387 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02001388 JDWP::JdwpError error;
Mathieu Chartier3398c782016-09-30 10:27:43 -07001389 ObjPtr<mirror::Class> expected_class = DecodeClass(class_id, &error);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001390 CHECK(expected_class != nullptr);
1391 return expected_class->IsAssignableFrom(event_class);
1392}
1393
1394bool Dbg::MatchField(JDWP::RefTypeId expected_type_id, JDWP::FieldId expected_field_id,
Mathieu Chartierc7853442015-03-27 14:35:38 -07001395 ArtField* event_field) {
1396 ArtField* expected_field = FromFieldId(expected_field_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001397 if (expected_field != event_field) {
1398 return false;
1399 }
1400 return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1401}
1402
1403bool Dbg::MatchInstance(JDWP::ObjectId expected_instance_id, mirror::Object* event_instance) {
1404 JDWP::JdwpError error;
1405 mirror::Object* modifier_instance = gRegistry->Get<mirror::Object*>(expected_instance_id, &error);
1406 return modifier_instance == event_instance;
1407}
1408
Mathieu Chartier90443472015-07-16 20:32:27 -07001409void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, ArtMethod* m, uint32_t dex_pc) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001410 if (m == nullptr) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001411 memset(location, 0, sizeof(*location));
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001412 } else {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001413 mirror::Class* c = m->GetDeclaringClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07001414 location->type_tag = GetTypeTag(c);
1415 location->class_id = gRegistry->AddRefType(c);
Alex Light73376312017-04-06 10:10:51 -07001416 // The RI Seems to return 0 for all obsolete methods. For compatibility we shall do the same.
1417 location->method_id = m->IsObsolete() ? 0 : ToMethodId(m);
Ian Rogersc0542af2014-09-03 16:16:56 -07001418 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001419 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08001420}
1421
Ian Rogersc0542af2014-09-03 16:16:56 -07001422std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001423 ArtMethod* m = FromMethodId(method_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001424 if (m == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001425 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001426 }
Andreas Gampe542451c2016-07-26 09:02:02 -07001427 return m->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001428}
1429
Alex Light73376312017-04-06 10:10:51 -07001430bool Dbg::IsMethodObsolete(JDWP::MethodId method_id) {
1431 ArtMethod* m = FromMethodId(method_id);
1432 if (m == nullptr) {
1433 // NB Since we return 0 as MID for obsolete methods we want to default to true here.
1434 return true;
1435 }
1436 return m->IsObsolete();
1437}
1438
Ian Rogersc0542af2014-09-03 16:16:56 -07001439std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001440 ArtField* f = FromFieldId(field_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001441 if (f == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001442 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001443 }
1444 return f->GetName();
Elliott Hughesa96836a2013-01-17 12:27:49 -08001445}
1446
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001447/*
1448 * Augment the access flags for synthetic methods and fields by setting
1449 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
1450 * flags not specified by the Java programming language.
1451 */
1452static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1453 accessFlags &= kAccJavaFlagsMask;
1454 if ((accessFlags & kAccSynthetic) != 0) {
1455 accessFlags |= 0xf0000000;
1456 }
1457 return accessFlags;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001458}
1459
Elliott Hughesdbb40792011-11-18 17:05:22 -08001460/*
Jeff Haob7cefc72013-11-14 14:51:09 -08001461 * Circularly shifts registers so that arguments come first. Debuggers
1462 * expect slots to begin with arguments, but dex code places them at
1463 * the end.
Elliott Hughesdbb40792011-11-18 17:05:22 -08001464 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001465static uint16_t MangleSlot(uint16_t slot, ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001466 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001467 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001468 if (code_item == nullptr) {
1469 // We should not get here for a method without code (native, proxy or abstract). Log it and
1470 // return the slot as is since all registers are arguments.
David Sehr709b0702016-10-13 09:12:37 -07001471 LOG(WARNING) << "Trying to mangle slot for method without code " << m->PrettyMethod();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001472 return slot;
1473 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001474 uint16_t ins_size = code_item->ins_size_;
1475 uint16_t locals_size = code_item->registers_size_ - ins_size;
1476 if (slot >= locals_size) {
1477 return slot - locals_size;
1478 } else {
1479 return slot + ins_size;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001480 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001481}
1482
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001483static size_t GetMethodNumArgRegistersIncludingThis(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001484 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001485 uint32_t num_registers = ArtMethod::NumArgRegisters(method->GetShorty());
1486 if (!method->IsStatic()) {
1487 ++num_registers;
1488 }
1489 return num_registers;
1490}
1491
Jeff Haob7cefc72013-11-14 14:51:09 -08001492/*
1493 * Circularly shifts registers so that arguments come last. Reverts
1494 * slots to dex style argument placement.
1495 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001496static uint16_t DemangleSlot(uint16_t slot, ArtMethod* m, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001497 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001498 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001499 if (code_item == nullptr) {
1500 // We should not get here for a method without code (native, proxy or abstract). Log it and
1501 // return the slot as is since all registers are arguments.
David Sehr709b0702016-10-13 09:12:37 -07001502 LOG(WARNING) << "Trying to demangle slot for method without code "
1503 << m->PrettyMethod();
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001504 uint16_t vreg_count = GetMethodNumArgRegistersIncludingThis(m);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001505 if (slot < vreg_count) {
1506 *error = JDWP::ERR_NONE;
1507 return slot;
1508 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001509 } else {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001510 if (slot < code_item->registers_size_) {
1511 uint16_t ins_size = code_item->ins_size_;
1512 uint16_t locals_size = code_item->registers_size_ - ins_size;
1513 *error = JDWP::ERR_NONE;
1514 return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1515 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001516 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001517
1518 // Slot is invalid in the method.
David Sehr709b0702016-10-13 09:12:37 -07001519 LOG(ERROR) << "Invalid local slot " << slot << " for method " << m->PrettyMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001520 *error = JDWP::ERR_INVALID_SLOT;
1521 return DexFile::kDexNoIndex16;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001522}
1523
Mathieu Chartier90443472015-07-16 20:32:27 -07001524JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic,
1525 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
1532 size_t instance_field_count = c->NumInstanceFields();
1533 size_t static_field_count = c->NumStaticFields();
1534
1535 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1536
1537 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
Mathieu Chartier90443472015-07-16 20:32:27 -07001538 ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) :
1539 c->GetStaticField(i - instance_field_count);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001540 expandBufAddFieldId(pReply, ToFieldId(f));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001541 expandBufAddUtf8String(pReply, f->GetName());
1542 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001543 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001544 static const char genericSignature[1] = "";
1545 expandBufAddUtf8String(pReply, genericSignature);
1546 }
1547 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1548 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001549 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001550}
1551
Elliott Hughes88d63092013-01-09 09:55:54 -08001552JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001553 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001554 JDWP::JdwpError error;
1555 mirror::Class* c = DecodeClass(class_id, &error);
1556 if (c == nullptr) {
1557 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001558 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001559
Alex Light51a64d52015-12-17 13:55:59 -08001560 expandBufAdd4BE(pReply, c->NumMethods());
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001561
Mathieu Chartiere401d142015-04-22 13:56:20 -07001562 auto* cl = Runtime::Current()->GetClassLinker();
1563 auto ptr_size = cl->GetImagePointerSize();
Alex Light51a64d52015-12-17 13:55:59 -08001564 for (ArtMethod& m : c->GetMethods(ptr_size)) {
1565 expandBufAddMethodId(pReply, ToMethodId(&m));
Andreas Gampe542451c2016-07-26 09:02:02 -07001566 expandBufAddUtf8String(pReply, m.GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName());
1567 expandBufAddUtf8String(
1568 pReply, m.GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetSignature().ToString());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001569 if (with_generic) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001570 const char* generic_signature = "";
1571 expandBufAddUtf8String(pReply, generic_signature);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001572 }
Alex Light51a64d52015-12-17 13:55:59 -08001573 expandBufAdd4BE(pReply, MangleAccessFlags(m.GetAccessFlags()));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001574 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001575 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001576}
1577
Elliott Hughes88d63092013-01-09 09:55:54 -08001578JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001579 JDWP::JdwpError error;
Mathieu Chartierf8322842014-05-16 10:59:25 -07001580 Thread* self = Thread::Current();
Vladimir Marko19a4d372016-12-08 14:41:46 +00001581 ObjPtr<mirror::Class> c = DecodeClass(class_id, &error);
1582 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001583 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001584 }
Mathieu Chartierf8322842014-05-16 10:59:25 -07001585 size_t interface_count = c->NumDirectInterfaces();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001586 expandBufAdd4BE(pReply, interface_count);
1587 for (size_t i = 0; i < interface_count; ++i) {
Vladimir Marko19a4d372016-12-08 14:41:46 +00001588 ObjPtr<mirror::Class> interface = mirror::Class::GetDirectInterface(self, c, i);
1589 DCHECK(interface != nullptr);
1590 expandBufAddRefTypeId(pReply, gRegistry->AddRefType(interface));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001591 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001592 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001593}
1594
Ian Rogersc0542af2014-09-03 16:16:56 -07001595void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001596 struct DebugCallbackContext {
1597 int numItems;
1598 JDWP::ExpandBuf* pReply;
1599
David Srbeckyb06e28e2015-12-10 13:15:00 +00001600 static bool Callback(void* context, const DexFile::PositionInfo& entry) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001601 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
David Srbeckyb06e28e2015-12-10 13:15:00 +00001602 expandBufAdd8BE(pContext->pReply, entry.address_);
1603 expandBufAdd4BE(pContext->pReply, entry.line_);
Elliott Hughes03181a82011-11-17 17:22:21 -08001604 pContext->numItems++;
Sebastien Hertzf2910ee2013-10-19 16:39:24 +02001605 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08001606 }
1607 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001608 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001609 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes03181a82011-11-17 17:22:21 -08001610 uint64_t start, end;
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001611 if (code_item == nullptr) {
1612 DCHECK(m->IsNative() || m->IsProxyMethod());
Elliott Hughes03181a82011-11-17 17:22:21 -08001613 start = -1;
1614 end = -1;
1615 } else {
1616 start = 0;
jeffhao14f0db92012-12-14 17:50:42 -08001617 // Return the index of the last instruction
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001618 end = code_item->insns_size_in_code_units_ - 1;
Elliott Hughes03181a82011-11-17 17:22:21 -08001619 }
1620
1621 expandBufAdd8BE(pReply, start);
1622 expandBufAdd8BE(pReply, end);
1623
1624 // Add numLines later
1625 size_t numLinesOffset = expandBufGetLength(pReply);
1626 expandBufAdd4BE(pReply, 0);
1627
1628 DebugCallbackContext context;
1629 context.numItems = 0;
1630 context.pReply = pReply;
1631
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001632 if (code_item != nullptr) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001633 m->GetDexFile()->DecodeDebugPositionInfo(code_item, DebugCallbackContext::Callback, &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001634 }
Elliott Hughes03181a82011-11-17 17:22:21 -08001635
1636 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001637}
1638
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001639void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1640 JDWP::ExpandBuf* pReply) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001641 struct DebugCallbackContext {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001642 ArtMethod* method;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001643 JDWP::ExpandBuf* pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001644 size_t variable_count;
1645 bool with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001646
David Srbeckyb06e28e2015-12-10 13:15:00 +00001647 static void Callback(void* context, const DexFile::LocalInfo& entry)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001648 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001649 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1650
David Srbeckyb06e28e2015-12-10 13:15:00 +00001651 uint16_t slot = entry.reg_;
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001652 VLOG(jdwp) << StringPrintf(" %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
David Srbeckyb06e28e2015-12-10 13:15:00 +00001653 pContext->variable_count, entry.start_address_,
1654 entry.end_address_ - entry.start_address_,
1655 entry.name_, entry.descriptor_, entry.signature_, slot,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001656 MangleSlot(slot, pContext->method));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001657
Jeff Haob7cefc72013-11-14 14:51:09 -08001658 slot = MangleSlot(slot, pContext->method);
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001659
David Srbeckyb06e28e2015-12-10 13:15:00 +00001660 expandBufAdd8BE(pContext->pReply, entry.start_address_);
1661 expandBufAddUtf8String(pContext->pReply, entry.name_);
1662 expandBufAddUtf8String(pContext->pReply, entry.descriptor_);
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001663 if (pContext->with_generic) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001664 expandBufAddUtf8String(pContext->pReply, entry.signature_);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001665 }
David Srbeckyb06e28e2015-12-10 13:15:00 +00001666 expandBufAdd4BE(pContext->pReply, entry.end_address_- entry.start_address_);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001667 expandBufAdd4BE(pContext->pReply, slot);
1668
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001669 ++pContext->variable_count;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001670 }
1671 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001672 ArtMethod* m = FromMethodId(method_id);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001673
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001674 // arg_count considers doubles and longs to take 2 units.
1675 // variable_count considers everything to take 1 unit.
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001676 expandBufAdd4BE(pReply, GetMethodNumArgRegistersIncludingThis(m));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001677
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001678 // We don't know the total number of variables yet, so leave a blank and update it later.
1679 size_t variable_count_offset = expandBufGetLength(pReply);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001680 expandBufAdd4BE(pReply, 0);
1681
1682 DebugCallbackContext context;
Jeff Haob7cefc72013-11-14 14:51:09 -08001683 context.method = m;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001684 context.pReply = pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001685 context.variable_count = 0;
1686 context.with_generic = with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001687
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001688 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001689 if (code_item != nullptr) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001690 m->GetDexFile()->DecodeDebugLocalInfo(
1691 code_item, m->IsStatic(), m->GetDexMethodIndex(), DebugCallbackContext::Callback,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001692 &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001693 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001694
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001695 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001696}
1697
Jeff Hao579b0242013-11-18 13:16:49 -08001698void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1699 JDWP::ExpandBuf* pReply) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001700 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001701 JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
Jeff Hao579b0242013-11-18 13:16:49 -08001702 OutputJValue(tag, return_value, pReply);
1703}
1704
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001705void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1706 JDWP::ExpandBuf* pReply) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001707 ArtField* f = FromFieldId(field_id);
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001708 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001709 OutputJValue(tag, field_value, pReply);
1710}
1711
Elliott Hughes9777ba22013-01-17 09:04:19 -08001712JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
Ian Rogersc0542af2014-09-03 16:16:56 -07001713 std::vector<uint8_t>* bytecodes) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001714 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07001715 if (m == nullptr) {
Elliott Hughes9777ba22013-01-17 09:04:19 -08001716 return JDWP::ERR_INVALID_METHODID;
1717 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001718 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes9777ba22013-01-17 09:04:19 -08001719 size_t byte_count = code_item->insns_size_in_code_units_ * 2;
1720 const uint8_t* begin = reinterpret_cast<const uint8_t*>(code_item->insns_);
1721 const uint8_t* end = begin + byte_count;
1722 for (const uint8_t* p = begin; p != end; ++p) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001723 bytecodes->push_back(*p);
Elliott Hughes9777ba22013-01-17 09:04:19 -08001724 }
1725 return JDWP::ERR_NONE;
1726}
1727
Elliott Hughes88d63092013-01-09 09:55:54 -08001728JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001729 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001730}
1731
Elliott Hughes88d63092013-01-09 09:55:54 -08001732JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001733 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001734}
1735
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001736static JValue GetArtFieldValue(ArtField* f, mirror::Object* o)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001737 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001738 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1739 JValue field_value;
1740 switch (fieldType) {
1741 case Primitive::kPrimBoolean:
1742 field_value.SetZ(f->GetBoolean(o));
1743 return field_value;
1744
1745 case Primitive::kPrimByte:
1746 field_value.SetB(f->GetByte(o));
1747 return field_value;
1748
1749 case Primitive::kPrimChar:
1750 field_value.SetC(f->GetChar(o));
1751 return field_value;
1752
1753 case Primitive::kPrimShort:
1754 field_value.SetS(f->GetShort(o));
1755 return field_value;
1756
1757 case Primitive::kPrimInt:
1758 case Primitive::kPrimFloat:
1759 // Int and Float must be treated as 32-bit values in JDWP.
1760 field_value.SetI(f->GetInt(o));
1761 return field_value;
1762
1763 case Primitive::kPrimLong:
1764 case Primitive::kPrimDouble:
1765 // Long and Double must be treated as 64-bit values in JDWP.
1766 field_value.SetJ(f->GetLong(o));
1767 return field_value;
1768
1769 case Primitive::kPrimNot:
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001770 field_value.SetL(f->GetObject(o).Ptr());
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001771 return field_value;
1772
1773 case Primitive::kPrimVoid:
1774 LOG(FATAL) << "Attempt to read from field of type 'void'";
1775 UNREACHABLE();
1776 }
1777 LOG(FATAL) << "Attempt to read from field of unknown type";
1778 UNREACHABLE();
1779}
1780
Elliott Hughes88d63092013-01-09 09:55:54 -08001781static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1782 JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001783 bool is_static)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001784 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001785 JDWP::JdwpError error;
1786 mirror::Class* c = DecodeClass(ref_type_id, &error);
1787 if (ref_type_id != 0 && c == nullptr) {
1788 return error;
Elliott Hughes0cf74332012-02-23 23:14:00 -08001789 }
1790
Jeff Haode19a252016-09-14 15:56:35 -07001791 Thread* self = Thread::Current();
1792 StackHandleScope<2> hs(self);
1793 MutableHandle<mirror::Object>
1794 o(hs.NewHandle(Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001795 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001796 return JDWP::ERR_INVALID_OBJECT;
1797 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001798 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001799
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001800 mirror::Class* receiver_class = c;
Andreas Gampefa4333d2017-02-14 11:10:34 -08001801 if (receiver_class == nullptr && o != nullptr) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001802 receiver_class = o->GetClass();
1803 }
Jeff Haode19a252016-09-14 15:56:35 -07001804
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001805 // TODO: should we give up now if receiver_class is null?
Ian Rogersc0542af2014-09-03 16:16:56 -07001806 if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
David Sehr709b0702016-10-13 09:12:37 -07001807 LOG(INFO) << "ERR_INVALID_FIELDID: " << f->PrettyField() << " "
1808 << receiver_class->PrettyClass();
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001809 return JDWP::ERR_INVALID_FIELDID;
1810 }
Elliott Hughesaed4be92011-12-02 16:16:23 -08001811
Jeff Haode19a252016-09-14 15:56:35 -07001812 // Ensure the field's class is initialized.
1813 Handle<mirror::Class> klass(hs.NewHandle(f->GetDeclaringClass()));
1814 if (!Runtime::Current()->GetClassLinker()->EnsureInitialized(self, klass, true, false)) {
David Sehr709b0702016-10-13 09:12:37 -07001815 LOG(WARNING) << "Not able to initialize class for SetValues: "
1816 << mirror::Class::PrettyClass(klass.Get());
Jeff Haode19a252016-09-14 15:56:35 -07001817 }
1818
Elliott Hughes0cf74332012-02-23 23:14:00 -08001819 // The RI only enforces the static/non-static mismatch in one direction.
1820 // TODO: should we change the tests and check both?
1821 if (is_static) {
1822 if (!f->IsStatic()) {
1823 return JDWP::ERR_INVALID_FIELDID;
1824 }
1825 } else {
1826 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001827 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.GetValues"
David Sehr709b0702016-10-13 09:12:37 -07001828 << " on static field " << f->PrettyField();
Elliott Hughes0cf74332012-02-23 23:14:00 -08001829 }
1830 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001831 if (f->IsStatic()) {
Jeff Haode19a252016-09-14 15:56:35 -07001832 o.Assign(f->GetDeclaringClass());
jeffhao0dfbb7e2012-11-28 15:26:03 -08001833 }
Elliott Hughes0cf74332012-02-23 23:14:00 -08001834
Jeff Haode19a252016-09-14 15:56:35 -07001835 JValue field_value(GetArtFieldValue(f, o.Get()));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001836 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Jeff Hao579b0242013-11-18 13:16:49 -08001837 Dbg::OutputJValue(tag, &field_value, pReply);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001838 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001839}
1840
Elliott Hughes88d63092013-01-09 09:55:54 -08001841JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001842 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001843 return GetFieldValueImpl(0, object_id, field_id, pReply, false);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001844}
1845
Ian Rogersc0542af2014-09-03 16:16:56 -07001846JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1847 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001848 return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001849}
1850
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001851static JDWP::JdwpError SetArtFieldValue(ArtField* f, mirror::Object* o, uint64_t value, int width)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001852 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001853 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1854 // Debugging only happens at runtime so we know we are not running in a transaction.
1855 static constexpr bool kNoTransactionMode = false;
1856 switch (fieldType) {
1857 case Primitive::kPrimBoolean:
1858 CHECK_EQ(width, 1);
1859 f->SetBoolean<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1860 return JDWP::ERR_NONE;
1861
1862 case Primitive::kPrimByte:
1863 CHECK_EQ(width, 1);
1864 f->SetByte<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1865 return JDWP::ERR_NONE;
1866
1867 case Primitive::kPrimChar:
1868 CHECK_EQ(width, 2);
1869 f->SetChar<kNoTransactionMode>(o, static_cast<uint16_t>(value));
1870 return JDWP::ERR_NONE;
1871
1872 case Primitive::kPrimShort:
1873 CHECK_EQ(width, 2);
1874 f->SetShort<kNoTransactionMode>(o, static_cast<int16_t>(value));
1875 return JDWP::ERR_NONE;
1876
1877 case Primitive::kPrimInt:
1878 case Primitive::kPrimFloat:
1879 CHECK_EQ(width, 4);
1880 // Int and Float must be treated as 32-bit values in JDWP.
1881 f->SetInt<kNoTransactionMode>(o, static_cast<int32_t>(value));
1882 return JDWP::ERR_NONE;
1883
1884 case Primitive::kPrimLong:
1885 case Primitive::kPrimDouble:
1886 CHECK_EQ(width, 8);
1887 // Long and Double must be treated as 64-bit values in JDWP.
1888 f->SetLong<kNoTransactionMode>(o, value);
1889 return JDWP::ERR_NONE;
1890
1891 case Primitive::kPrimNot: {
1892 JDWP::JdwpError error;
1893 mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1894 if (error != JDWP::ERR_NONE) {
1895 return JDWP::ERR_INVALID_OBJECT;
1896 }
1897 if (v != nullptr) {
Mathieu Chartier3398c782016-09-30 10:27:43 -07001898 ObjPtr<mirror::Class> field_type;
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001899 {
1900 StackHandleScope<2> hs(Thread::Current());
1901 HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1902 HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
1903 field_type = f->GetType<true>();
1904 }
1905 if (!field_type->IsAssignableFrom(v->GetClass())) {
1906 return JDWP::ERR_INVALID_OBJECT;
1907 }
1908 }
1909 f->SetObject<kNoTransactionMode>(o, v);
1910 return JDWP::ERR_NONE;
1911 }
1912
1913 case Primitive::kPrimVoid:
1914 LOG(FATAL) << "Attempt to write to field of type 'void'";
1915 UNREACHABLE();
1916 }
1917 LOG(FATAL) << "Attempt to write to field of unknown type";
1918 UNREACHABLE();
1919}
1920
Elliott Hughes88d63092013-01-09 09:55:54 -08001921static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001922 uint64_t value, int width, bool is_static)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001923 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001924 JDWP::JdwpError error;
Jeff Haode19a252016-09-14 15:56:35 -07001925 Thread* self = Thread::Current();
1926 StackHandleScope<2> hs(self);
1927 MutableHandle<mirror::Object>
1928 o(hs.NewHandle(Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001929 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001930 return JDWP::ERR_INVALID_OBJECT;
1931 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001932 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001933
Jeff Haode19a252016-09-14 15:56:35 -07001934 // Ensure the field's class is initialized.
1935 Handle<mirror::Class> klass(hs.NewHandle(f->GetDeclaringClass()));
1936 if (!Runtime::Current()->GetClassLinker()->EnsureInitialized(self, klass, true, false)) {
David Sehr709b0702016-10-13 09:12:37 -07001937 LOG(WARNING) << "Not able to initialize class for SetValues: "
1938 << mirror::Class::PrettyClass(klass.Get());
Jeff Haode19a252016-09-14 15:56:35 -07001939 }
1940
Elliott Hughes0cf74332012-02-23 23:14:00 -08001941 // The RI only enforces the static/non-static mismatch in one direction.
1942 // TODO: should we change the tests and check both?
1943 if (is_static) {
1944 if (!f->IsStatic()) {
1945 return JDWP::ERR_INVALID_FIELDID;
1946 }
1947 } else {
1948 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001949 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues"
David Sehr709b0702016-10-13 09:12:37 -07001950 << " on static field " << f->PrettyField();
Elliott Hughes0cf74332012-02-23 23:14:00 -08001951 }
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001952 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001953 if (f->IsStatic()) {
Jeff Haode19a252016-09-14 15:56:35 -07001954 o.Assign(f->GetDeclaringClass());
jeffhao0dfbb7e2012-11-28 15:26:03 -08001955 }
Jeff Haode19a252016-09-14 15:56:35 -07001956 return SetArtFieldValue(f, o.Get(), value, width);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001957}
1958
Elliott Hughes88d63092013-01-09 09:55:54 -08001959JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001960 int width) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001961 return SetFieldValueImpl(object_id, field_id, value, width, false);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001962}
1963
Elliott Hughes88d63092013-01-09 09:55:54 -08001964JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
1965 return SetFieldValueImpl(0, field_id, value, width, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001966}
1967
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001968JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001969 JDWP::JdwpError error;
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001970 mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
1971 if (error != JDWP::ERR_NONE) {
1972 return error;
1973 }
1974 if (obj == nullptr) {
1975 return JDWP::ERR_INVALID_OBJECT;
1976 }
1977 {
1978 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartier0795f232016-09-27 18:43:30 -07001979 ObjPtr<mirror::Class> java_lang_String =
1980 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_String);
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001981 if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
1982 // This isn't a string.
1983 return JDWP::ERR_INVALID_STRING;
1984 }
1985 }
1986 *str = obj->AsString()->ToModifiedUtf8();
1987 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001988}
1989
Jeff Hao579b0242013-11-18 13:16:49 -08001990void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
1991 if (IsPrimitiveTag(tag)) {
1992 expandBufAdd1(pReply, tag);
1993 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
1994 expandBufAdd1(pReply, return_value->GetI());
1995 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
1996 expandBufAdd2BE(pReply, return_value->GetI());
1997 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
1998 expandBufAdd4BE(pReply, return_value->GetI());
1999 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
2000 expandBufAdd8BE(pReply, return_value->GetJ());
2001 } else {
2002 CHECK_EQ(tag, JDWP::JT_VOID);
2003 }
2004 } else {
Ian Rogers98379392014-02-24 16:53:16 -08002005 ScopedObjectAccessUnchecked soa(Thread::Current());
Jeff Hao579b0242013-11-18 13:16:49 -08002006 mirror::Object* value = return_value->GetL();
Ian Rogers98379392014-02-24 16:53:16 -08002007 expandBufAdd1(pReply, TagFromObject(soa, value));
Jeff Hao579b0242013-11-18 13:16:49 -08002008 expandBufAddObjectId(pReply, gRegistry->Add(value));
2009 }
2010}
2011
Ian Rogersc0542af2014-09-03 16:16:56 -07002012JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
jeffhaoa77f0f62012-12-05 17:19:31 -08002013 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002014 JDWP::JdwpError error;
Roland Levillain4b8f1ec2015-08-26 18:34:03 +01002015 DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002016 if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
2017 return error;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002018 }
Elliott Hughes221229c2013-01-08 18:17:50 -08002019
2020 // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
Ian Rogersc0542af2014-09-03 16:16:56 -07002021 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
2022 CHECK(thread_object != nullptr) << error;
Mathieu Chartierc7853442015-03-27 14:35:38 -07002023 ArtField* java_lang_Thread_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08002024 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartierf8ac97f2016-10-05 15:56:52 -07002025 ObjPtr<mirror::String> s(java_lang_Thread_name_field->GetObject(thread_object)->AsString());
Ian Rogersc0542af2014-09-03 16:16:56 -07002026 if (s != nullptr) {
2027 *name = s->ToModifiedUtf8();
Elliott Hughes221229c2013-01-08 18:17:50 -08002028 }
2029 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002030}
2031
Elliott Hughes221229c2013-01-08 18:17:50 -08002032JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02002033 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002034 JDWP::JdwpError error;
2035 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
2036 if (error != JDWP::ERR_NONE) {
Elliott Hughes2435a572012-02-17 16:07:41 -08002037 return JDWP::ERR_INVALID_OBJECT;
2038 }
Mathieu Chartier268764d2016-09-13 12:09:38 -07002039 ScopedAssertNoThreadSuspension ants("Debugger: GetThreadGroup");
Elliott Hughes2435a572012-02-17 16:07:41 -08002040 // Okay, so it's an object, but is it actually a thread?
Roland Levillain4b8f1ec2015-08-26 18:34:03 +01002041 DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002042 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2043 // Zombie threads are in the null group.
2044 expandBufAddObjectId(pReply, JDWP::ObjectId(0));
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002045 error = JDWP::ERR_NONE;
2046 } else if (error == JDWP::ERR_NONE) {
Mathieu Chartier0795f232016-09-27 18:43:30 -07002047 ObjPtr<mirror::Class> c = soa.Decode<mirror::Class>(WellKnownClasses::java_lang_Thread);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002048 CHECK(c != nullptr);
Andreas Gampe08883de2016-11-08 13:20:52 -08002049 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07002050 CHECK(f != nullptr);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002051 ObjPtr<mirror::Object> group = f->GetObject(thread_object);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07002052 CHECK(group != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002053 JDWP::ObjectId thread_group_id = gRegistry->Add(group);
2054 expandBufAddObjectId(pReply, thread_group_id);
Elliott Hughes221229c2013-01-08 18:17:50 -08002055 }
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002056 return error;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002057}
2058
Sebastien Hertza06430c2014-09-15 19:21:30 +02002059static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
2060 JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002061 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002062 mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
2063 error);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002064 if (*error != JDWP::ERR_NONE) {
2065 return nullptr;
2066 }
2067 if (thread_group == nullptr) {
2068 *error = JDWP::ERR_INVALID_OBJECT;
2069 return nullptr;
2070 }
Mathieu Chartier0795f232016-09-27 18:43:30 -07002071 ObjPtr<mirror::Class> c =
2072 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_ThreadGroup);
Ian Rogers98379392014-02-24 16:53:16 -08002073 CHECK(c != nullptr);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002074 if (!c->IsAssignableFrom(thread_group->GetClass())) {
2075 // This is not a java.lang.ThreadGroup.
2076 *error = JDWP::ERR_INVALID_THREAD_GROUP;
2077 return nullptr;
2078 }
2079 *error = JDWP::ERR_NONE;
2080 return thread_group;
2081}
2082
2083JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
2084 ScopedObjectAccessUnchecked soa(Thread::Current());
2085 JDWP::JdwpError error;
2086 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2087 if (error != JDWP::ERR_NONE) {
2088 return error;
2089 }
Mathieu Chartier268764d2016-09-13 12:09:38 -07002090 ScopedAssertNoThreadSuspension ants("Debugger: GetThreadGroupName");
Andreas Gampe08883de2016-11-08 13:20:52 -08002091 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Ian Rogersc0542af2014-09-03 16:16:56 -07002092 CHECK(f != nullptr);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002093 ObjPtr<mirror::String> s = f->GetObject(thread_group)->AsString();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002094
2095 std::string thread_group_name(s->ToModifiedUtf8());
2096 expandBufAddUtf8String(pReply, thread_group_name);
2097 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002098}
2099
Sebastien Hertza06430c2014-09-15 19:21:30 +02002100JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
Ian Rogers98379392014-02-24 16:53:16 -08002101 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002102 JDWP::JdwpError error;
Sebastien Hertza06430c2014-09-15 19:21:30 +02002103 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2104 if (error != JDWP::ERR_NONE) {
2105 return error;
2106 }
Mathieu Chartier3398c782016-09-30 10:27:43 -07002107 ObjPtr<mirror::Object> parent;
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002108 {
Mathieu Chartier268764d2016-09-13 12:09:38 -07002109 ScopedAssertNoThreadSuspension ants("Debugger: GetThreadGroupParent");
Andreas Gampe08883de2016-11-08 13:20:52 -08002110 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_parent);
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002111 CHECK(f != nullptr);
2112 parent = f->GetObject(thread_group);
2113 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002114 JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
2115 expandBufAddObjectId(pReply, parent_group_id);
2116 return JDWP::ERR_NONE;
2117}
2118
Andreas Gampe08883de2016-11-08 13:20:52 -08002119static void GetChildThreadGroups(mirror::Object* thread_group,
Sebastien Hertza06430c2014-09-15 19:21:30 +02002120 std::vector<JDWP::ObjectId>* child_thread_group_ids)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002121 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02002122 CHECK(thread_group != nullptr);
2123
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002124 // Get the int "ngroups" count of this thread group...
Andreas Gampe08883de2016-11-08 13:20:52 -08002125 ArtField* ngroups_field = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_ngroups);
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002126 CHECK(ngroups_field != nullptr);
2127 const int32_t size = ngroups_field->GetInt(thread_group);
2128 if (size == 0) {
2129 return;
Sebastien Hertze49e1952014-10-13 11:27:13 +02002130 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002131
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002132 // Get the ThreadGroup[] "groups" out of this thread group...
Andreas Gampe08883de2016-11-08 13:20:52 -08002133 ArtField* groups_field = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_groups);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002134 ObjPtr<mirror::Object> groups_array = groups_field->GetObject(thread_group);
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002135
2136 CHECK(groups_array != nullptr);
2137 CHECK(groups_array->IsObjectArray());
2138
Mathieu Chartier3398c782016-09-30 10:27:43 -07002139 ObjPtr<mirror::ObjectArray<mirror::Object>> groups_array_as_array =
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002140 groups_array->AsObjectArray<mirror::Object>();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002141
2142 // Copy the first 'size' elements out of the array into the result.
Sebastien Hertz6995c602014-09-09 12:10:13 +02002143 ObjectRegistry* registry = Dbg::GetObjectRegistry();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002144 for (int32_t i = 0; i < size; ++i) {
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002145 child_thread_group_ids->push_back(registry->Add(groups_array_as_array->Get(i)));
Sebastien Hertza06430c2014-09-15 19:21:30 +02002146 }
2147}
2148
2149JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2150 JDWP::ExpandBuf* pReply) {
2151 ScopedObjectAccessUnchecked soa(Thread::Current());
2152 JDWP::JdwpError error;
2153 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2154 if (error != JDWP::ERR_NONE) {
2155 return error;
2156 }
2157
2158 // Add child threads.
2159 {
2160 std::vector<JDWP::ObjectId> child_thread_ids;
2161 GetThreads(thread_group, &child_thread_ids);
2162 expandBufAdd4BE(pReply, child_thread_ids.size());
2163 for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2164 expandBufAddObjectId(pReply, child_thread_id);
2165 }
2166 }
2167
2168 // Add child thread groups.
2169 {
2170 std::vector<JDWP::ObjectId> child_thread_groups_ids;
Andreas Gampe08883de2016-11-08 13:20:52 -08002171 GetChildThreadGroups(thread_group, &child_thread_groups_ids);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002172 expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2173 for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2174 expandBufAddObjectId(pReply, child_thread_group_id);
2175 }
2176 }
2177
2178 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002179}
2180
2181JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002182 ScopedObjectAccessUnchecked soa(Thread::Current());
Andreas Gampe08883de2016-11-08 13:20:52 -08002183 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002184 ObjPtr<mirror::Object> group = f->GetObject(f->GetDeclaringClass());
Ian Rogers365c1022012-06-22 15:05:28 -07002185 return gRegistry->Add(group);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002186}
2187
Jeff Hao920af3e2013-08-28 15:46:38 -07002188JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2189 switch (state) {
2190 case kBlocked:
2191 return JDWP::TS_MONITOR;
2192 case kNative:
2193 case kRunnable:
2194 case kSuspended:
2195 return JDWP::TS_RUNNING;
2196 case kSleeping:
2197 return JDWP::TS_SLEEPING;
2198 case kStarting:
2199 case kTerminated:
2200 return JDWP::TS_ZOMBIE;
2201 case kTimedWaiting:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002202 case kWaitingForCheckPointsToRun:
Jeff Hao920af3e2013-08-28 15:46:38 -07002203 case kWaitingForDebuggerSend:
2204 case kWaitingForDebuggerSuspension:
2205 case kWaitingForDebuggerToAttach:
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01002206 case kWaitingForDeoptimization:
Jeff Hao920af3e2013-08-28 15:46:38 -07002207 case kWaitingForGcToComplete:
Mathieu Chartierb43390c2015-05-12 10:47:11 -07002208 case kWaitingForGetObjectsAllocated:
Jeff Hao920af3e2013-08-28 15:46:38 -07002209 case kWaitingForJniOnLoad:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002210 case kWaitingForMethodTracingStart:
Jeff Hao920af3e2013-08-28 15:46:38 -07002211 case kWaitingForSignalCatcherOutput:
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08002212 case kWaitingForVisitObjects:
Jeff Hao920af3e2013-08-28 15:46:38 -07002213 case kWaitingInMainDebuggerLoop:
2214 case kWaitingInMainSignalCatcherLoop:
2215 case kWaitingPerformingGc:
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07002216 case kWaitingWeakGcRootRead:
Hiroshi Yamauchi76f55b02015-08-21 16:10:39 -07002217 case kWaitingForGcThreadFlip:
Jeff Hao920af3e2013-08-28 15:46:38 -07002218 case kWaiting:
2219 return JDWP::TS_WAIT;
2220 // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2221 }
2222 LOG(FATAL) << "Unknown thread state: " << state;
2223 return JDWP::TS_ZOMBIE;
2224}
2225
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002226JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2227 JDWP::JdwpSuspendStatus* pSuspendStatus) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002228 ScopedObjectAccess soa(Thread::Current());
Elliott Hughes499c5132011-11-17 14:55:11 -08002229
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002230 *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2231
Ian Rogersc0542af2014-09-03 16:16:56 -07002232 JDWP::JdwpError error;
2233 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002234 if (error != JDWP::ERR_NONE) {
2235 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2236 *pThreadStatus = JDWP::TS_ZOMBIE;
Elliott Hughes221229c2013-01-08 18:17:50 -08002237 return JDWP::ERR_NONE;
2238 }
2239 return error;
Elliott Hughes499c5132011-11-17 14:55:11 -08002240 }
2241
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002242 if (IsSuspendedForDebugger(soa, thread)) {
2243 *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
Elliott Hughes499c5132011-11-17 14:55:11 -08002244 }
2245
Jeff Hao920af3e2013-08-28 15:46:38 -07002246 *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
Elliott Hughes221229c2013-01-08 18:17:50 -08002247 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002248}
2249
Elliott Hughes221229c2013-01-08 18:17:50 -08002250JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002251 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002252 JDWP::JdwpError error;
2253 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002254 if (error != JDWP::ERR_NONE) {
2255 return error;
Elliott Hughes2435a572012-02-17 16:07:41 -08002256 }
Ian Rogers50b35e22012-10-04 10:09:15 -07002257 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002258 expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
Elliott Hughes2435a572012-02-17 16:07:41 -08002259 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002260}
2261
Elliott Hughesf9501702013-01-11 11:22:27 -08002262JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2263 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002264 JDWP::JdwpError error;
2265 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughesf9501702013-01-11 11:22:27 -08002266 if (error != JDWP::ERR_NONE) {
2267 return error;
2268 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002269 thread->Interrupt(soa.Self());
Elliott Hughesf9501702013-01-11 11:22:27 -08002270 return JDWP::ERR_NONE;
2271}
2272
Andreas Gampe08883de2016-11-08 13:20:52 -08002273static bool IsInDesiredThreadGroup(mirror::Object* desired_thread_group, mirror::Object* peer)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002274 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz070f7322014-09-09 12:08:49 +02002275 // Do we want threads from all thread groups?
2276 if (desired_thread_group == nullptr) {
2277 return true;
2278 }
Andreas Gampe08883de2016-11-08 13:20:52 -08002279 ArtField* thread_group_field = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002280 DCHECK(thread_group_field != nullptr);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002281 ObjPtr<mirror::Object> group = thread_group_field->GetObject(peer);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002282 return (group == desired_thread_group);
2283}
2284
Sebastien Hertza06430c2014-09-15 19:21:30 +02002285void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002286 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz070f7322014-09-09 12:08:49 +02002287 std::list<Thread*> all_threads_list;
2288 {
2289 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2290 all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2291 }
2292 for (Thread* t : all_threads_list) {
2293 if (t == Dbg::GetDebugThread()) {
2294 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2295 // query all threads, so it's easier if we just don't tell them about this thread.
2296 continue;
2297 }
2298 if (t->IsStillStarting()) {
2299 // This thread is being started (and has been registered in the thread list). However, it is
2300 // not completely started yet so we must ignore it.
2301 continue;
2302 }
Nicolas Geoffraycafa0812017-02-15 18:27:34 +00002303 mirror::Object* peer = t->GetPeerFromOtherThread();
Sebastien Hertz070f7322014-09-09 12:08:49 +02002304 if (peer == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002305 // 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 +02002306 // this thread yet.
2307 // TODO: if we identified threads to the debugger by their Thread*
2308 // rather than their peer's mirror::Object*, we could fix this.
2309 // Doing so might help us report ZOMBIE threads too.
2310 continue;
2311 }
Andreas Gampe08883de2016-11-08 13:20:52 -08002312 if (IsInDesiredThreadGroup(thread_group, peer)) {
Sebastien Hertz070f7322014-09-09 12:08:49 +02002313 thread_ids->push_back(gRegistry->Add(peer));
2314 }
2315 }
Elliott Hughescaf76542012-06-28 16:08:22 -07002316}
Elliott Hughesa2155262011-11-16 16:26:58 -08002317
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002318static int GetStackDepth(Thread* thread) REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002319 struct CountStackDepthVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002320 explicit CountStackDepthVisitor(Thread* thread_in)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002321 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2322 depth(0) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002323
Elliott Hughes64f574f2013-02-20 14:57:12 -08002324 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2325 // annotalysis.
2326 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers0399dde2012-06-06 17:09:28 -07002327 if (!GetMethod()->IsRuntimeMethod()) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08002328 ++depth;
2329 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002330 return true;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002331 }
2332 size_t depth;
2333 };
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002334
Ian Rogers7a22fa62013-01-23 12:16:16 -08002335 CountStackDepthVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07002336 visitor.WalkStack();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002337 return visitor.depth;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002338}
2339
Ian Rogersc0542af2014-09-03 16:16:56 -07002340JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002341 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002342 JDWP::JdwpError error;
2343 *result = 0;
2344 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002345 if (error != JDWP::ERR_NONE) {
2346 return error;
2347 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002348 if (!IsSuspendedForDebugger(soa, thread)) {
2349 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2350 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002351 *result = GetStackDepth(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08002352 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -08002353}
2354
Ian Rogers306057f2012-11-26 12:45:53 -08002355JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2356 size_t frame_count, JDWP::ExpandBuf* buf) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002357 class GetFrameVisitor : public StackVisitor {
2358 public:
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002359 GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2360 JDWP::ExpandBuf* buf_in)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002361 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002362 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2363 depth_(0),
2364 start_frame_(start_frame_in),
2365 frame_count_(frame_count_in),
2366 buf_(buf_in) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002367 expandBufAdd4BE(buf_, frame_count_);
Elliott Hughes03181a82011-11-17 17:22:21 -08002368 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002369
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002370 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002371 if (GetMethod()->IsRuntimeMethod()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002372 return true; // The debugger can't do anything useful with a frame that has no Method*.
Elliott Hughes03181a82011-11-17 17:22:21 -08002373 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002374 if (depth_ >= start_frame_ + frame_count_) {
Elliott Hughes530fa002012-03-12 11:44:49 -07002375 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08002376 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002377 if (depth_ >= start_frame_) {
2378 JDWP::FrameId frame_id(GetFrameId());
2379 JDWP::JdwpLocation location;
Sebastien Hertz6995c602014-09-09 12:10:13 +02002380 SetJdwpLocation(&location, GetMethod(), GetDexPc());
Ian Rogersef7d42f2014-01-06 12:55:46 -08002381 VLOG(jdwp) << StringPrintf(" Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002382 expandBufAdd8BE(buf_, frame_id);
2383 expandBufAddLocation(buf_, location);
2384 }
2385 ++depth_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002386 return true;
Elliott Hughes03181a82011-11-17 17:22:21 -08002387 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002388
2389 private:
2390 size_t depth_;
2391 const size_t start_frame_;
2392 const size_t frame_count_;
2393 JDWP::ExpandBuf* buf_;
Elliott Hughes03181a82011-11-17 17:22:21 -08002394 };
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002395
2396 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002397 JDWP::JdwpError error;
2398 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002399 if (error != JDWP::ERR_NONE) {
2400 return error;
2401 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002402 if (!IsSuspendedForDebugger(soa, thread)) {
2403 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2404 }
Ian Rogers7a22fa62013-01-23 12:16:16 -08002405 GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
Ian Rogers0399dde2012-06-06 17:09:28 -07002406 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002407 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002408}
2409
2410JDWP::ObjectId Dbg::GetThreadSelfId() {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002411 return GetThreadId(Thread::Current());
2412}
2413
2414JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002415 ScopedObjectAccessUnchecked soa(Thread::Current());
Nicolas Geoffraycafa0812017-02-15 18:27:34 +00002416 return gRegistry->Add(thread->GetPeerFromOtherThread());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002417}
2418
Elliott Hughes475fc232011-10-25 15:00:35 -07002419void Dbg::SuspendVM() {
Hiroshi Yamauchi8f95cf32016-04-19 11:14:06 -07002420 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
2421 gc::ScopedGCCriticalSection gcs(Thread::Current(),
2422 gc::kGcCauseDebugger,
2423 gc::kCollectorTypeDebugger);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002424 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002425}
2426
2427void Dbg::ResumeVM() {
Sebastien Hertz253fa552014-10-14 17:27:15 +02002428 Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002429}
2430
Elliott Hughes221229c2013-01-08 18:17:50 -08002431JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002432 Thread* self = Thread::Current();
Ian Rogersc0542af2014-09-03 16:16:56 -07002433 ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002434 {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002435 ScopedObjectAccess soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07002436 JDWP::JdwpError error;
2437 peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
Elliott Hughes4e235312011-12-02 11:34:15 -08002438 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002439 if (peer.get() == nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002440 return JDWP::ERR_THREAD_NOT_ALIVE;
2441 }
Ian Rogers4ad5cd32014-11-11 23:08:07 -08002442 // Suspend thread to build stack trace.
Elliott Hughesf327e072013-01-09 16:01:26 -08002443 bool timed_out;
Brian Carlstromba32de42014-08-27 23:43:46 -07002444 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Sebastien Hertzcdd798d2017-04-18 18:28:51 +02002445 Thread* thread = thread_list->SuspendThreadByPeer(peer.get(),
2446 request_suspension,
2447 /* debug_suspension */ true,
Brian Carlstromba32de42014-08-27 23:43:46 -07002448 &timed_out);
Ian Rogersc0542af2014-09-03 16:16:56 -07002449 if (thread != nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002450 return JDWP::ERR_NONE;
Elliott Hughesf327e072013-01-09 16:01:26 -08002451 } else if (timed_out) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002452 return JDWP::ERR_INTERNAL;
2453 } else {
2454 return JDWP::ERR_THREAD_NOT_ALIVE;
2455 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002456}
2457
Elliott Hughes221229c2013-01-08 18:17:50 -08002458void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002459 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002460 JDWP::JdwpError error;
2461 mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2462 CHECK(peer != nullptr) << error;
jeffhaoa77f0f62012-12-05 17:19:31 -08002463 Thread* thread;
2464 {
2465 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2466 thread = Thread::FromManagedThread(soa, peer);
2467 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002468 if (thread == nullptr) {
Elliott Hughes4e235312011-12-02 11:34:15 -08002469 LOG(WARNING) << "No such thread for resume: " << peer;
2470 return;
2471 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002472 bool needs_resume;
2473 {
Ian Rogers50b35e22012-10-04 10:09:15 -07002474 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Sebastien Hertz70d60272017-04-14 14:18:36 +02002475 needs_resume = thread->GetDebugSuspendCount() > 0;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002476 }
2477 if (needs_resume) {
Elliott Hughes546b9862012-06-20 16:06:13 -07002478 Runtime::Current()->GetThreadList()->Resume(thread, true);
2479 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002480}
2481
2482void Dbg::SuspendSelf() {
Elliott Hughes475fc232011-10-25 15:00:35 -07002483 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002484}
2485
Ian Rogers0399dde2012-06-06 17:09:28 -07002486struct GetThisVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002487 GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002488 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002489 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2490 this_object(nullptr),
2491 frame_id(frame_id_in) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002492
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002493 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2494 // annotalysis.
2495 virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002496 if (frame_id != GetFrameId()) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002497 return true; // continue
Ian Rogers0399dde2012-06-06 17:09:28 -07002498 } else {
Ian Rogers62d6c772013-02-27 08:32:07 -08002499 this_object = GetThisObject();
2500 return false;
Ian Rogers0399dde2012-06-06 17:09:28 -07002501 }
Elliott Hughes86b00102011-12-05 17:54:26 -08002502 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002503
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002504 mirror::Object* this_object;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002505 JDWP::FrameId frame_id;
Ian Rogers0399dde2012-06-06 17:09:28 -07002506};
2507
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002508JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2509 JDWP::ObjectId* result) {
2510 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002511 JDWP::JdwpError error;
2512 Thread* thread = DecodeThread(soa, thread_id, &error);
2513 if (error != JDWP::ERR_NONE) {
2514 return error;
2515 }
2516 if (!IsSuspendedForDebugger(soa, thread)) {
2517 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002518 }
Ian Rogers700a4022014-05-19 16:49:03 -07002519 std::unique_ptr<Context> context(Context::Create());
Ian Rogers7a22fa62013-01-23 12:16:16 -08002520 GetThisVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002521 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002522 *result = gRegistry->Add(visitor.this_object);
2523 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002524}
2525
Sebastien Hertz8009f392014-09-01 17:07:11 +02002526// Walks the stack until we find the frame with the given FrameId.
2527class FindFrameVisitor FINAL : public StackVisitor {
2528 public:
2529 FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002530 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002531 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2532 frame_id_(frame_id),
2533 error_(JDWP::ERR_INVALID_FRAMEID) {}
Ian Rogersca190662012-06-26 15:45:57 -07002534
Sebastien Hertz8009f392014-09-01 17:07:11 +02002535 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2536 // annotalysis.
2537 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2538 if (GetFrameId() != frame_id_) {
2539 return true; // Not our frame, carry on.
Ian Rogers0399dde2012-06-06 17:09:28 -07002540 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002541 ArtMethod* m = GetMethod();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002542 if (m->IsNative()) {
2543 // We can't read/write local value from/into native method.
2544 error_ = JDWP::ERR_OPAQUE_FRAME;
2545 } else {
2546 // We found our frame.
2547 error_ = JDWP::ERR_NONE;
2548 }
2549 return false;
2550 }
2551
2552 JDWP::JdwpError GetError() const {
2553 return error_;
2554 }
2555
2556 private:
2557 const JDWP::FrameId frame_id_;
2558 JDWP::JdwpError error_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002559
2560 DISALLOW_COPY_AND_ASSIGN(FindFrameVisitor);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002561};
2562
2563JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2564 JDWP::ObjectId thread_id = request->ReadThreadId();
2565 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002566
2567 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002568 JDWP::JdwpError error;
2569 Thread* thread = DecodeThread(soa, thread_id, &error);
2570 if (error != JDWP::ERR_NONE) {
2571 return error;
2572 }
2573 if (!IsSuspendedForDebugger(soa, thread)) {
2574 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002575 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002576 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002577 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002578 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002579 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002580 if (visitor.GetError() != JDWP::ERR_NONE) {
2581 return visitor.GetError();
2582 }
2583
2584 // Read the values from visitor's context.
2585 int32_t slot_count = request->ReadSigned32("slot count");
2586 expandBufAdd4BE(pReply, slot_count); /* "int values" */
2587 for (int32_t i = 0; i < slot_count; ++i) {
2588 uint32_t slot = request->ReadUnsigned32("slot");
2589 JDWP::JdwpTag reqSigByte = request->ReadTag();
2590
2591 VLOG(jdwp) << " --> slot " << slot << " " << reqSigByte;
2592
2593 size_t width = Dbg::GetTagWidth(reqSigByte);
Sebastien Hertz7d955652014-10-22 10:57:10 +02002594 uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
Sebastien Hertz69206392015-04-07 15:54:25 +02002595 error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002596 if (error != JDWP::ERR_NONE) {
2597 return error;
2598 }
2599 }
2600 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002601}
2602
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002603constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2604
2605static std::string GetStackContextAsString(const StackVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002606 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002607 return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
David Sehr709b0702016-10-13 09:12:37 -07002608 ArtMethod::PrettyMethod(visitor.GetMethod()).c_str());
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002609}
2610
2611static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2612 JDWP::JdwpTag tag)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002613 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002614 LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2615 << GetStackContextAsString(visitor);
2616 return kStackFrameLocalAccessError;
2617}
2618
Sebastien Hertz8009f392014-09-01 17:07:11 +02002619JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2620 int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002621 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002622 JDWP::JdwpError error = JDWP::ERR_NONE;
2623 uint16_t vreg = DemangleSlot(slot, m, &error);
2624 if (error != JDWP::ERR_NONE) {
2625 return error;
2626 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002627 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002628 switch (tag) {
2629 case JDWP::JT_BOOLEAN: {
2630 CHECK_EQ(width, 1U);
2631 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002632 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2633 return FailGetLocalValue(visitor, vreg, tag);
Ian Rogers0399dde2012-06-06 17:09:28 -07002634 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002635 VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2636 JDWP::Set1(buf + 1, intVal != 0);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002637 break;
Ian Rogers0399dde2012-06-06 17:09:28 -07002638 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002639 case JDWP::JT_BYTE: {
2640 CHECK_EQ(width, 1U);
2641 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002642 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2643 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002644 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002645 VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2646 JDWP::Set1(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002647 break;
2648 }
2649 case JDWP::JT_SHORT:
2650 case JDWP::JT_CHAR: {
2651 CHECK_EQ(width, 2U);
2652 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002653 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2654 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002655 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002656 VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2657 JDWP::Set2BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002658 break;
2659 }
2660 case JDWP::JT_INT: {
2661 CHECK_EQ(width, 4U);
2662 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002663 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2664 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002665 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002666 VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2667 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002668 break;
2669 }
2670 case JDWP::JT_FLOAT: {
2671 CHECK_EQ(width, 4U);
2672 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002673 if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2674 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002675 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002676 VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2677 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002678 break;
2679 }
2680 case JDWP::JT_ARRAY:
2681 case JDWP::JT_CLASS_LOADER:
2682 case JDWP::JT_CLASS_OBJECT:
2683 case JDWP::JT_OBJECT:
2684 case JDWP::JT_STRING:
2685 case JDWP::JT_THREAD:
2686 case JDWP::JT_THREAD_GROUP: {
2687 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2688 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002689 if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2690 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002691 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002692 mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2693 VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2694 if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2695 LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2696 reinterpret_cast<uintptr_t>(o), vreg)
2697 << GetStackContextAsString(visitor);
2698 UNREACHABLE();
2699 }
2700 tag = TagFromObject(soa, o);
2701 JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002702 break;
2703 }
2704 case JDWP::JT_DOUBLE: {
2705 CHECK_EQ(width, 8U);
2706 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002707 if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2708 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002709 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002710 VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2711 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002712 break;
2713 }
2714 case JDWP::JT_LONG: {
2715 CHECK_EQ(width, 8U);
2716 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002717 if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2718 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002719 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002720 VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2721 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002722 break;
2723 }
2724 default:
2725 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002726 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002727 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002728
Sebastien Hertz8009f392014-09-01 17:07:11 +02002729 // Prepend tag, which may have been updated.
2730 JDWP::Set1(buf, tag);
2731 return JDWP::ERR_NONE;
2732}
2733
2734JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2735 JDWP::ObjectId thread_id = request->ReadThreadId();
2736 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002737
2738 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002739 JDWP::JdwpError error;
2740 Thread* thread = DecodeThread(soa, thread_id, &error);
2741 if (error != JDWP::ERR_NONE) {
2742 return error;
2743 }
2744 if (!IsSuspendedForDebugger(soa, thread)) {
2745 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002746 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002747 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002748 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002749 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002750 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002751 if (visitor.GetError() != JDWP::ERR_NONE) {
2752 return visitor.GetError();
2753 }
2754
2755 // Writes the values into visitor's context.
2756 int32_t slot_count = request->ReadSigned32("slot count");
2757 for (int32_t i = 0; i < slot_count; ++i) {
2758 uint32_t slot = request->ReadUnsigned32("slot");
2759 JDWP::JdwpTag sigByte = request->ReadTag();
2760 size_t width = Dbg::GetTagWidth(sigByte);
2761 uint64_t value = request->ReadValue(width);
2762
2763 VLOG(jdwp) << " --> slot " << slot << " " << sigByte << " " << value;
Mingyao Yang99170c62015-07-06 11:10:37 -07002764 error = Dbg::SetLocalValue(thread, visitor, slot, sigByte, value, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002765 if (error != JDWP::ERR_NONE) {
2766 return error;
2767 }
2768 }
2769 return JDWP::ERR_NONE;
2770}
2771
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002772template<typename T>
2773static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2774 JDWP::JdwpTag tag, T value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002775 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002776 LOG(ERROR) << "Failed to write " << tag << " local " << value
2777 << " (0x" << std::hex << value << ") into register v" << vreg
2778 << GetStackContextAsString(visitor);
2779 return kStackFrameLocalAccessError;
2780}
2781
Mingyao Yang99170c62015-07-06 11:10:37 -07002782JDWP::JdwpError Dbg::SetLocalValue(Thread* thread, StackVisitor& visitor, int slot,
2783 JDWP::JdwpTag tag, uint64_t value, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002784 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002785 JDWP::JdwpError error = JDWP::ERR_NONE;
2786 uint16_t vreg = DemangleSlot(slot, m, &error);
2787 if (error != JDWP::ERR_NONE) {
2788 return error;
2789 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002790 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002791 switch (tag) {
2792 case JDWP::JT_BOOLEAN:
2793 case JDWP::JT_BYTE:
2794 CHECK_EQ(width, 1U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002795 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002796 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002797 }
2798 break;
2799 case JDWP::JT_SHORT:
2800 case JDWP::JT_CHAR:
2801 CHECK_EQ(width, 2U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002802 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002803 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002804 }
2805 break;
2806 case JDWP::JT_INT:
2807 CHECK_EQ(width, 4U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002808 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002809 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002810 }
2811 break;
2812 case JDWP::JT_FLOAT:
2813 CHECK_EQ(width, 4U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002814 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002815 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002816 }
2817 break;
2818 case JDWP::JT_ARRAY:
2819 case JDWP::JT_CLASS_LOADER:
2820 case JDWP::JT_CLASS_OBJECT:
2821 case JDWP::JT_OBJECT:
2822 case JDWP::JT_STRING:
2823 case JDWP::JT_THREAD:
2824 case JDWP::JT_THREAD_GROUP: {
2825 CHECK_EQ(width, sizeof(JDWP::ObjectId));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002826 mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2827 &error);
2828 if (error != JDWP::ERR_NONE) {
2829 VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2830 return JDWP::ERR_INVALID_OBJECT;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002831 }
Mingyao Yang636b9252015-07-31 16:40:24 -07002832 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002833 kReferenceVReg)) {
2834 return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002835 }
2836 break;
2837 }
2838 case JDWP::JT_DOUBLE: {
2839 CHECK_EQ(width, 8U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002840 if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002841 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002842 }
2843 break;
2844 }
2845 case JDWP::JT_LONG: {
2846 CHECK_EQ(width, 8U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002847 if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002848 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002849 }
2850 break;
2851 }
2852 default:
2853 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002854 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002855 }
Mingyao Yang99170c62015-07-06 11:10:37 -07002856
2857 // If we set the local variable in a compiled frame, we need to trigger a deoptimization of
2858 // the stack so we continue execution with the interpreter using the new value(s) of the updated
2859 // local variable(s). To achieve this, we install instrumentation exit stub on each method of the
2860 // thread's stack. The stub will cause the deoptimization to happen.
2861 if (!visitor.IsShadowFrame() && thread->HasDebuggerShadowFrames()) {
2862 Runtime::Current()->GetInstrumentation()->InstrumentThreadStack(thread);
2863 }
2864
Sebastien Hertz8009f392014-09-01 17:07:11 +02002865 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002866}
2867
Mathieu Chartiere401d142015-04-22 13:56:20 -07002868static void SetEventLocation(JDWP::EventLocation* location, ArtMethod* m, uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002869 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002870 DCHECK(location != nullptr);
2871 if (m == nullptr) {
2872 memset(location, 0, sizeof(*location));
2873 } else {
Alex Light6c8467f2015-11-20 15:03:26 -08002874 location->method = GetCanonicalMethod(m);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002875 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002876 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002877}
2878
Mathieu Chartiere401d142015-04-22 13:56:20 -07002879void Dbg::PostLocationEvent(ArtMethod* m, int dex_pc, mirror::Object* this_object,
Jeff Hao579b0242013-11-18 13:16:49 -08002880 int event_flags, const JValue* return_value) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002881 if (!IsDebuggerActive()) {
2882 return;
2883 }
2884 DCHECK(m != nullptr);
2885 DCHECK_EQ(m->IsStatic(), this_object == nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002886 JDWP::EventLocation location;
2887 SetEventLocation(&location, m, dex_pc);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002888
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002889 // We need to be sure no exception is pending when calling JdwpState::PostLocationEvent.
2890 // This is required to be able to call JNI functions to create JDWP ids. To achieve this,
2891 // we temporarily clear the current thread's exception (if any) and will restore it after
2892 // the call.
2893 // Note: the only way to get a pending exception here is to suspend on a move-exception
2894 // instruction.
2895 Thread* const self = Thread::Current();
2896 StackHandleScope<1> hs(self);
2897 Handle<mirror::Throwable> pending_exception(hs.NewHandle(self->GetException()));
2898 self->ClearException();
Andreas Gampefa4333d2017-02-14 11:10:34 -08002899 if (kIsDebugBuild && pending_exception != nullptr) {
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002900 const DexFile::CodeItem* code_item = location.method->GetCodeItem();
2901 const Instruction* instr = Instruction::At(&code_item->insns_[location.dex_pc]);
2902 CHECK_EQ(Instruction::MOVE_EXCEPTION, instr->Opcode());
2903 }
2904
Sebastien Hertz6995c602014-09-09 12:10:13 +02002905 gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002906
Andreas Gampefa4333d2017-02-14 11:10:34 -08002907 if (pending_exception != nullptr) {
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002908 self->SetException(pending_exception.Get());
2909 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002910}
2911
Mathieu Chartiere401d142015-04-22 13:56:20 -07002912void Dbg::PostFieldAccessEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002913 mirror::Object* this_object, ArtField* f) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002914 if (!IsDebuggerActive()) {
2915 return;
2916 }
2917 DCHECK(m != nullptr);
2918 DCHECK(f != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002919 JDWP::EventLocation location;
2920 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002921
Sebastien Hertz6995c602014-09-09 12:10:13 +02002922 gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002923}
2924
Mathieu Chartiere401d142015-04-22 13:56:20 -07002925void Dbg::PostFieldModificationEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002926 mirror::Object* this_object, ArtField* f,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002927 const JValue* field_value) {
2928 if (!IsDebuggerActive()) {
2929 return;
2930 }
2931 DCHECK(m != nullptr);
2932 DCHECK(f != nullptr);
2933 DCHECK(field_value != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002934 JDWP::EventLocation location;
2935 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002936
Sebastien Hertz6995c602014-09-09 12:10:13 +02002937 gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002938}
2939
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002940/**
2941 * Finds the location where this exception will be caught. We search until we reach the top
2942 * frame, in which case this exception is considered uncaught.
2943 */
2944class CatchLocationFinder : public StackVisitor {
2945 public:
2946 CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002947 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002948 : StackVisitor(self, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002949 exception_(exception),
2950 handle_scope_(self),
2951 this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002952 catch_method_(nullptr),
2953 throw_method_(nullptr),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002954 catch_dex_pc_(DexFile::kDexNoIndex),
2955 throw_dex_pc_(DexFile::kDexNoIndex) {
2956 }
2957
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002958 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002959 ArtMethod* method = GetMethod();
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002960 DCHECK(method != nullptr);
2961 if (method->IsRuntimeMethod()) {
2962 // Ignore callee save method.
2963 DCHECK(method->IsCalleeSaveMethod());
2964 return true;
2965 }
2966
2967 uint32_t dex_pc = GetDexPc();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002968 if (throw_method_ == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002969 // First Java method found. It is either the method that threw the exception,
2970 // or the Java native method that is reporting an exception thrown by
2971 // native code.
2972 this_at_throw_.Assign(GetThisObject());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002973 throw_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002974 throw_dex_pc_ = dex_pc;
2975 }
2976
2977 if (dex_pc != DexFile::kDexNoIndex) {
Sebastien Hertz26f72862015-09-15 09:52:07 +02002978 StackHandleScope<1> hs(GetThread());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002979 uint32_t found_dex_pc;
2980 Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002981 bool unused_clear_exception;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002982 found_dex_pc = method->FindCatchBlock(exception_class, dex_pc, &unused_clear_exception);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002983 if (found_dex_pc != DexFile::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002984 catch_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002985 catch_dex_pc_ = found_dex_pc;
2986 return false; // End stack walk.
2987 }
2988 }
2989 return true; // Continue stack walk.
2990 }
2991
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002992 ArtMethod* GetCatchMethod() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002993 return catch_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002994 }
2995
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002996 ArtMethod* GetThrowMethod() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002997 return throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002998 }
2999
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003000 mirror::Object* GetThisAtThrow() REQUIRES_SHARED(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003001 return this_at_throw_.Get();
3002 }
3003
3004 uint32_t GetCatchDexPc() const {
3005 return catch_dex_pc_;
3006 }
3007
3008 uint32_t GetThrowDexPc() const {
3009 return throw_dex_pc_;
3010 }
3011
3012 private:
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003013 const Handle<mirror::Throwable>& exception_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003014 StackHandleScope<1> handle_scope_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003015 MutableHandle<mirror::Object> this_at_throw_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003016 ArtMethod* catch_method_;
3017 ArtMethod* throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003018 uint32_t catch_dex_pc_;
3019 uint32_t throw_dex_pc_;
3020
3021 DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
3022};
3023
3024void Dbg::PostException(mirror::Throwable* exception_object) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07003025 if (!IsDebuggerActive()) {
Ian Rogers0ad5bb82011-12-07 10:16:32 -08003026 return;
3027 }
Sebastien Hertz261bc042015-04-08 09:36:07 +02003028 Thread* const self = Thread::Current();
3029 StackHandleScope<1> handle_scope(self);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003030 Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
3031 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz261bc042015-04-08 09:36:07 +02003032 CatchLocationFinder clf(self, h_exception, context.get());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003033 clf.WalkStack(/* include_transitions */ false);
Sebastien Hertz6995c602014-09-09 12:10:13 +02003034 JDWP::EventLocation exception_throw_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003035 SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
Sebastien Hertz6995c602014-09-09 12:10:13 +02003036 JDWP::EventLocation exception_catch_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003037 SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
Elliott Hughes4740cdf2011-12-07 14:07:12 -08003038
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003039 gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
3040 clf.GetThisAtThrow());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003041}
3042
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08003043void Dbg::PostClassPrepare(mirror::Class* c) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07003044 if (!IsDebuggerActive()) {
Elliott Hughes4740cdf2011-12-07 14:07:12 -08003045 return;
3046 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02003047 gJdwpState->PostClassPrepare(c);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003048}
3049
Ian Rogers62d6c772013-02-27 08:32:07 -08003050void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003051 ArtMethod* m, uint32_t dex_pc,
Sebastien Hertz8379b222014-02-24 17:38:15 +01003052 int event_flags, const JValue* return_value) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003053 if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
Elliott Hughes2aa2e392012-02-17 17:15:43 -08003054 return;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003055 }
3056
Elliott Hughes86964332012-02-15 19:37:42 -08003057 if (IsBreakpoint(m, dex_pc)) {
3058 event_flags |= kBreakpoint;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003059 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003060
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003061 // If the debugger is single-stepping one of our threads, check to
3062 // see if we're that thread and we've reached a step point.
3063 const SingleStepControl* single_step_control = thread->GetSingleStepControl();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003064 if (single_step_control != nullptr) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003065 CHECK(!m->IsNative());
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003066 if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003067 // Step into method calls. We break when the line number
3068 // or method pointer changes. If we're in SS_MIN mode, we
3069 // always stop.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003070 if (single_step_control->GetMethod() != m) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003071 event_flags |= kSingleStep;
3072 VLOG(jdwp) << "SS new method";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003073 } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003074 event_flags |= kSingleStep;
3075 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003076 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003077 event_flags |= kSingleStep;
3078 VLOG(jdwp) << "SS new line";
3079 }
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003080 } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003081 // Step over method calls. We break when the line number is
3082 // different and the frame depth is <= the original frame
3083 // depth. (We can't just compare on the method, because we
3084 // might get unrolled past it by an exception, and it's tricky
3085 // to identify recursion.)
3086
3087 int stack_depth = GetStackDepth(thread);
3088
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003089 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003090 // Popped up one or more frames, always trigger.
3091 event_flags |= kSingleStep;
3092 VLOG(jdwp) << "SS method pop";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003093 } else if (stack_depth == single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003094 // Same depth, see if we moved.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003095 if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Elliott Hughes86964332012-02-15 19:37:42 -08003096 event_flags |= kSingleStep;
3097 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003098 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003099 event_flags |= kSingleStep;
3100 VLOG(jdwp) << "SS new line";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003101 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003102 }
3103 } else {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003104 CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003105 // Return from the current method. We break when the frame
3106 // depth pops up.
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003107
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003108 // This differs from the "method exit" break in that it stops
3109 // with the PC at the next instruction in the returned-to
3110 // function, rather than the end of the returning function.
Elliott Hughes86964332012-02-15 19:37:42 -08003111
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003112 int stack_depth = GetStackDepth(thread);
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003113 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003114 event_flags |= kSingleStep;
3115 VLOG(jdwp) << "SS method pop";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003116 }
3117 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003118 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003119
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003120 // If there's something interesting going on, see if it matches one
3121 // of the debugger filters.
3122 if (event_flags != 0) {
Sebastien Hertz8379b222014-02-24 17:38:15 +01003123 Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003124 }
3125}
3126
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003127size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
3128 switch (instrumentation_event) {
3129 case instrumentation::Instrumentation::kMethodEntered:
3130 return &method_enter_event_ref_count_;
3131 case instrumentation::Instrumentation::kMethodExited:
3132 return &method_exit_event_ref_count_;
3133 case instrumentation::Instrumentation::kDexPcMoved:
3134 return &dex_pc_change_event_ref_count_;
3135 case instrumentation::Instrumentation::kFieldRead:
3136 return &field_read_event_ref_count_;
3137 case instrumentation::Instrumentation::kFieldWritten:
3138 return &field_write_event_ref_count_;
3139 case instrumentation::Instrumentation::kExceptionCaught:
3140 return &exception_catch_event_ref_count_;
3141 default:
3142 return nullptr;
3143 }
3144}
3145
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003146// Process request while all mutator threads are suspended.
3147void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003148 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003149 switch (request.GetKind()) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003150 case DeoptimizationRequest::kNothing:
3151 LOG(WARNING) << "Ignoring empty deoptimization request.";
3152 break;
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003153 case DeoptimizationRequest::kRegisterForEvent:
3154 VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003155 request.InstrumentationEvent());
3156 instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
3157 instrumentation_events_ |= request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003158 break;
3159 case DeoptimizationRequest::kUnregisterForEvent:
3160 VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003161 request.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003162 instrumentation->RemoveListener(&gDebugInstrumentationListener,
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003163 request.InstrumentationEvent());
3164 instrumentation_events_ &= ~request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003165 break;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003166 case DeoptimizationRequest::kFullDeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003167 VLOG(jdwp) << "Deoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003168 instrumentation->DeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003169 VLOG(jdwp) << "Deoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003170 break;
3171 case DeoptimizationRequest::kFullUndeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003172 VLOG(jdwp) << "Undeoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003173 instrumentation->UndeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003174 VLOG(jdwp) << "Undeoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003175 break;
3176 case DeoptimizationRequest::kSelectiveDeoptimization:
David Sehr709b0702016-10-13 09:12:37 -07003177 VLOG(jdwp) << "Deoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " ...";
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003178 instrumentation->Deoptimize(request.Method());
David Sehr709b0702016-10-13 09:12:37 -07003179 VLOG(jdwp) << "Deoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003180 break;
3181 case DeoptimizationRequest::kSelectiveUndeoptimization:
David Sehr709b0702016-10-13 09:12:37 -07003182 VLOG(jdwp) << "Undeoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " ...";
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003183 instrumentation->Undeoptimize(request.Method());
David Sehr709b0702016-10-13 09:12:37 -07003184 VLOG(jdwp) << "Undeoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003185 break;
3186 default:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003187 LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003188 break;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003189 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003190}
3191
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003192void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003193 if (req.GetKind() == DeoptimizationRequest::kNothing) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003194 // Nothing to do.
3195 return;
3196 }
Brian Carlstrom306db812014-09-05 13:01:41 -07003197 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003198 RequestDeoptimizationLocked(req);
3199}
3200
3201void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003202 switch (req.GetKind()) {
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003203 case DeoptimizationRequest::kRegisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003204 DCHECK_NE(req.InstrumentationEvent(), 0u);
3205 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003206 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003207 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003208 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003209 VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003210 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003211 deoptimization_requests_.push_back(req);
3212 }
3213 *counter = *counter + 1;
3214 break;
3215 }
3216 case DeoptimizationRequest::kUnregisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003217 DCHECK_NE(req.InstrumentationEvent(), 0u);
3218 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003219 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003220 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003221 *counter = *counter - 1;
3222 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003223 VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003224 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003225 deoptimization_requests_.push_back(req);
3226 }
3227 break;
3228 }
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003229 case DeoptimizationRequest::kFullDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003230 DCHECK(req.Method() == nullptr);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003231 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003232 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3233 << " for full deoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003234 deoptimization_requests_.push_back(req);
3235 }
3236 ++full_deoptimization_event_count_;
3237 break;
3238 }
3239 case DeoptimizationRequest::kFullUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003240 DCHECK(req.Method() == nullptr);
Sebastien Hertze713d932014-05-15 10:48:53 +02003241 DCHECK_GT(full_deoptimization_event_count_, 0U);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003242 --full_deoptimization_event_count_;
3243 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003244 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3245 << " for full undeoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003246 deoptimization_requests_.push_back(req);
3247 }
3248 break;
3249 }
3250 case DeoptimizationRequest::kSelectiveDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003251 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003252 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
David Sehr709b0702016-10-13 09:12:37 -07003253 << " for deoptimization of " << req.Method()->PrettyMethod();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003254 deoptimization_requests_.push_back(req);
3255 break;
3256 }
3257 case DeoptimizationRequest::kSelectiveUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003258 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003259 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
David Sehr709b0702016-10-13 09:12:37 -07003260 << " for undeoptimization of " << req.Method()->PrettyMethod();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003261 deoptimization_requests_.push_back(req);
3262 break;
3263 }
3264 default: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003265 LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003266 break;
3267 }
3268 }
3269}
3270
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003271void Dbg::ManageDeoptimization() {
3272 Thread* const self = Thread::Current();
3273 {
3274 // Avoid suspend/resume if there is no pending request.
Brian Carlstrom306db812014-09-05 13:01:41 -07003275 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003276 if (deoptimization_requests_.empty()) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003277 return;
3278 }
3279 }
3280 CHECK_EQ(self->GetState(), kRunnable);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003281 ScopedThreadSuspension sts(self, kWaitingForDeoptimization);
Mathieu Chartieraa516822015-10-02 15:53:37 -07003282 // Required for ProcessDeoptimizationRequest.
3283 gc::ScopedGCCriticalSection gcs(self,
3284 gc::kGcCauseInstrumentation,
3285 gc::kCollectorTypeInstrumentation);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003286 // We need to suspend mutator threads first.
Mathieu Chartier4f55e222015-09-04 13:26:21 -07003287 ScopedSuspendAll ssa(__FUNCTION__);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003288 const ThreadState old_state = self->SetStateUnsafe(kRunnable);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003289 {
Brian Carlstrom306db812014-09-05 13:01:41 -07003290 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003291 size_t req_index = 0;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003292 for (DeoptimizationRequest& request : deoptimization_requests_) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003293 VLOG(jdwp) << "Process deoptimization request #" << req_index++;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003294 ProcessDeoptimizationRequest(request);
3295 }
3296 deoptimization_requests_.clear();
3297 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003298 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003299}
3300
Mathieu Chartiere401d142015-04-22 13:56:20 -07003301static const Breakpoint* FindFirstBreakpointForMethod(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003302 REQUIRES_SHARED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003303 for (Breakpoint& breakpoint : gBreakpoints) {
Alex Light6c8467f2015-11-20 15:03:26 -08003304 if (breakpoint.IsInMethod(m)) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003305 return &breakpoint;
3306 }
3307 }
3308 return nullptr;
3309}
3310
Mathieu Chartiere401d142015-04-22 13:56:20 -07003311bool Dbg::MethodHasAnyBreakpoints(ArtMethod* method) {
Mathieu Chartierd8565452015-03-26 09:41:50 -07003312 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3313 return FindFirstBreakpointForMethod(method) != nullptr;
3314}
3315
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003316// Sanity checks all existing breakpoints on the same method.
Mathieu Chartiere401d142015-04-22 13:56:20 -07003317static void SanityCheckExistingBreakpoints(ArtMethod* m,
Sebastien Hertzf3928792014-11-17 19:00:37 +01003318 DeoptimizationRequest::Kind deoptimization_kind)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003319 REQUIRES_SHARED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003320 for (const Breakpoint& breakpoint : gBreakpoints) {
Alex Light6c8467f2015-11-20 15:03:26 -08003321 if (breakpoint.IsInMethod(m)) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003322 CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3323 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003324 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003325 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3326 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003327 // We should have deoptimized everything but not "selectively" deoptimized this method.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003328 CHECK(instrumentation->AreAllMethodsDeoptimized());
3329 CHECK(!instrumentation->IsDeoptimized(m));
3330 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003331 // We should have "selectively" deoptimized this method.
3332 // Note: while we have not deoptimized everything for this method, we may have done it for
3333 // another event.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003334 CHECK(instrumentation->IsDeoptimized(m));
3335 } else {
3336 // This method does not require deoptimization.
3337 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3338 CHECK(!instrumentation->IsDeoptimized(m));
3339 }
3340}
3341
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003342// Returns the deoptimization kind required to set a breakpoint in a method.
3343// If a breakpoint has already been set, we also return the first breakpoint
3344// through the given 'existing_brkpt' pointer.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003345static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003346 ArtMethod* m,
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003347 const Breakpoint** existing_brkpt)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003348 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003349 if (!Dbg::RequiresDeoptimization()) {
3350 // We already run in interpreter-only mode so we don't need to deoptimize anything.
3351 VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
David Sehr709b0702016-10-13 09:12:37 -07003352 << ArtMethod::PrettyMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003353 return DeoptimizationRequest::kNothing;
3354 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003355 const Breakpoint* first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003356 {
3357 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003358 first_breakpoint = FindFirstBreakpointForMethod(m);
3359 *existing_brkpt = first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003360 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003361
3362 if (first_breakpoint == nullptr) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003363 // There is no breakpoint on this method yet: we need to deoptimize. If this method is default,
3364 // we deoptimize everything; otherwise we deoptimize only this method. We
Alex Light6c8467f2015-11-20 15:03:26 -08003365 // deoptimize with defaults because we do not know everywhere they are used. It is possible some
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003366 // of the copies could be missed.
Alex Light6c8467f2015-11-20 15:03:26 -08003367 // TODO Deoptimizing on default methods might not be necessary in all cases.
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003368 bool need_full_deoptimization = m->IsDefault();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003369 if (need_full_deoptimization) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003370 VLOG(jdwp) << "Need full deoptimization because of copying of method "
David Sehr709b0702016-10-13 09:12:37 -07003371 << ArtMethod::PrettyMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003372 return DeoptimizationRequest::kFullDeoptimization;
3373 } else {
3374 // We don't need to deoptimize if the method has not been compiled.
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00003375 const bool is_compiled = m->HasAnyCompiledCode();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003376 if (is_compiled) {
David Sehr709b0702016-10-13 09:12:37 -07003377 VLOG(jdwp) << "Need selective deoptimization for compiled method "
3378 << ArtMethod::PrettyMethod(m);
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003379 return DeoptimizationRequest::kSelectiveDeoptimization;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003380 } else {
3381 // Method is not compiled: we don't need to deoptimize.
David Sehr709b0702016-10-13 09:12:37 -07003382 VLOG(jdwp) << "No need for deoptimization for non-compiled method "
3383 << ArtMethod::PrettyMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003384 return DeoptimizationRequest::kNothing;
3385 }
3386 }
3387 } else {
3388 // There is at least one breakpoint for this method: we don't need to deoptimize.
3389 // Let's check that all breakpoints are configured the same way for deoptimization.
3390 VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003391 DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003392 if (kIsDebugBuild) {
3393 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3394 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3395 }
3396 return DeoptimizationRequest::kNothing;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003397 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003398}
3399
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003400// Installs a breakpoint at the specified location. Also indicates through the deoptimization
3401// request if we need to deoptimize.
3402void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3403 Thread* const self = Thread::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003404 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003405 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003406
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003407 const Breakpoint* existing_breakpoint = nullptr;
3408 const DeoptimizationRequest::Kind deoptimization_kind =
3409 GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003410 req->SetKind(deoptimization_kind);
3411 if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3412 req->SetMethod(m);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003413 } else {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003414 CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3415 deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003416 req->SetMethod(nullptr);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003417 }
3418
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003419 {
3420 WriterMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003421 // If there is at least one existing breakpoint on the same method, the new breakpoint
3422 // must have the same deoptimization kind than the existing breakpoint(s).
3423 DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3424 if (existing_breakpoint != nullptr) {
3425 breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3426 } else {
3427 breakpoint_deoptimization_kind = deoptimization_kind;
3428 }
3429 gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003430 VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3431 << gBreakpoints[gBreakpoints.size() - 1];
3432 }
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003433}
3434
3435// Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3436// request if we need to undeoptimize.
3437void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
Sebastien Hertzed2be172014-08-19 15:33:43 +02003438 WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003439 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003440 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003441 DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003442 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Alex Light6c8467f2015-11-20 15:03:26 -08003443 if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].IsInMethod(m)) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003444 VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
Sebastien Hertzf3928792014-11-17 19:00:37 +01003445 deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3446 DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3447 Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003448 gBreakpoints.erase(gBreakpoints.begin() + i);
3449 break;
3450 }
3451 }
3452 const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3453 if (existing_breakpoint == nullptr) {
3454 // There is no more breakpoint on this method: we need to undeoptimize.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003455 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003456 // This method required full deoptimization: we need to undeoptimize everything.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003457 req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3458 req->SetMethod(nullptr);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003459 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003460 // This method required selective deoptimization: we need to undeoptimize only that method.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003461 req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3462 req->SetMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003463 } else {
3464 // This method had no need for deoptimization: do nothing.
3465 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3466 req->SetKind(DeoptimizationRequest::kNothing);
3467 req->SetMethod(nullptr);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003468 }
3469 } else {
3470 // There is at least one breakpoint for this method: we don't need to undeoptimize.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003471 req->SetKind(DeoptimizationRequest::kNothing);
3472 req->SetMethod(nullptr);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003473 if (kIsDebugBuild) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003474 SanityCheckExistingBreakpoints(m, deoptimization_kind);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003475 }
Elliott Hughes86964332012-02-15 19:37:42 -08003476 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003477}
3478
Mathieu Chartiere401d142015-04-22 13:56:20 -07003479bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003480 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3481 if (ssc == nullptr) {
3482 // If we are not single-stepping, then we don't have to force interpreter.
3483 return false;
3484 }
3485 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3486 // If we are in interpreter only mode, then we don't have to force interpreter.
3487 return false;
3488 }
3489
3490 if (!m->IsNative() && !m->IsProxyMethod()) {
3491 // If we want to step into a method, then we have to force interpreter on that call.
3492 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3493 return true;
3494 }
3495 }
3496 return false;
3497}
3498
Mathieu Chartiere401d142015-04-22 13:56:20 -07003499bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003500 instrumentation::Instrumentation* const instrumentation =
3501 Runtime::Current()->GetInstrumentation();
3502 // If we are in interpreter only mode, then we don't have to force interpreter.
3503 if (instrumentation->InterpretOnly()) {
3504 return false;
3505 }
3506 // We can only interpret pure Java method.
3507 if (m->IsNative() || m->IsProxyMethod()) {
3508 return false;
3509 }
3510 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3511 if (ssc != nullptr) {
3512 // If we want to step into a method, then we have to force interpreter on that call.
3513 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3514 return true;
3515 }
3516 // If we are stepping out from a static initializer, by issuing a step
3517 // in or step over, that was implicitly invoked by calling a static method,
3518 // then we need to step into that method. Having a lower stack depth than
3519 // the one the single step control has indicates that the step originates
3520 // from the static initializer.
3521 if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3522 ssc->GetStackDepth() > GetStackDepth(thread)) {
3523 return true;
3524 }
3525 }
3526 // There are cases where we have to force interpreter on deoptimized methods,
3527 // because in some cases the call will not be performed by invoking an entry
3528 // point that has been replaced by the deoptimization, but instead by directly
3529 // invoking the compiled code of the method, for example.
3530 return instrumentation->IsDeoptimized(m);
3531}
3532
Mathieu Chartiere401d142015-04-22 13:56:20 -07003533bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003534 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003535 if (m == nullptr) {
3536 return false;
3537 }
3538 instrumentation::Instrumentation* const instrumentation =
3539 Runtime::Current()->GetInstrumentation();
3540 // If we are in interpreter only mode, then we don't have to force interpreter.
3541 if (instrumentation->InterpretOnly()) {
3542 return false;
3543 }
3544 // We can only interpret pure Java method.
3545 if (m->IsNative() || m->IsProxyMethod()) {
3546 return false;
3547 }
3548 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3549 if (ssc != nullptr) {
3550 // If we are stepping out from a static initializer, by issuing a step
3551 // out, that was implicitly invoked by calling a static method, then we
3552 // need to step into the caller of that method. Having a lower stack
3553 // depth than the one the single step control has indicates that the
3554 // step originates from the static initializer.
3555 if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3556 ssc->GetStackDepth() > GetStackDepth(thread)) {
3557 return true;
3558 }
3559 }
3560 // If we are returning from a static intializer, that was implicitly
3561 // invoked by calling a static method and the caller is deoptimized,
3562 // then we have to deoptimize the stack without forcing interpreter
3563 // on the static method that was called originally. This problem can
3564 // be solved easily by forcing instrumentation on the called method,
3565 // because the instrumentation exit hook will recognise the need of
3566 // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3567 return instrumentation->IsDeoptimized(m);
3568}
3569
Mathieu Chartiere401d142015-04-22 13:56:20 -07003570bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003571 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003572 if (m == nullptr) {
3573 return false;
3574 }
3575 instrumentation::Instrumentation* const instrumentation =
3576 Runtime::Current()->GetInstrumentation();
3577 // If we are in interpreter only mode, then we don't have to force interpreter.
3578 if (instrumentation->InterpretOnly()) {
3579 return false;
3580 }
3581 // We can only interpret pure Java method.
3582 if (m->IsNative() || m->IsProxyMethod()) {
3583 return false;
3584 }
3585 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3586 if (ssc != nullptr) {
3587 // The debugger is not interested in what is happening under the level
3588 // of the step, thus we only force interpreter when we are not below of
3589 // the step.
3590 if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3591 return true;
3592 }
3593 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003594 if (thread->HasDebuggerShadowFrames()) {
3595 // We need to deoptimize the stack for the exception handling flow so that
3596 // we don't miss any deoptimization that should be done when there are
3597 // debugger shadow frames.
3598 return true;
3599 }
Daniel Mihalyieb076692014-08-22 17:33:31 +02003600 // We have to require stack deoptimization if the upcall is deoptimized.
3601 return instrumentation->IsDeoptimized(m);
3602}
3603
Mingyao Yang99170c62015-07-06 11:10:37 -07003604class NeedsDeoptimizationVisitor : public StackVisitor {
Sebastien Hertz520633b2015-09-08 17:03:36 +02003605 public:
3606 explicit NeedsDeoptimizationVisitor(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003607 REQUIRES_SHARED(Locks::mutator_lock_)
Sebastien Hertz520633b2015-09-08 17:03:36 +02003608 : StackVisitor(self, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3609 needs_deoptimization_(false) {}
3610
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003611 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz520633b2015-09-08 17:03:36 +02003612 // The visitor is meant to be used when handling exception from compiled code only.
David Sehr709b0702016-10-13 09:12:37 -07003613 CHECK(!IsShadowFrame()) << "We only expect to visit compiled frame: "
3614 << ArtMethod::PrettyMethod(GetMethod());
Sebastien Hertz520633b2015-09-08 17:03:36 +02003615 ArtMethod* method = GetMethod();
3616 if (method == nullptr) {
3617 // We reach an upcall and don't need to deoptimize this part of the stack (ManagedFragment)
3618 // so we can stop the visit.
3619 DCHECK(!needs_deoptimization_);
3620 return false;
3621 }
3622 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3623 // We found a compiled frame in the stack but instrumentation is set to interpret
3624 // everything: we need to deoptimize.
3625 needs_deoptimization_ = true;
3626 return false;
3627 }
3628 if (Runtime::Current()->GetInstrumentation()->IsDeoptimized(method)) {
3629 // We found a deoptimized method in the stack.
3630 needs_deoptimization_ = true;
3631 return false;
3632 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003633 ShadowFrame* frame = GetThread()->FindDebuggerShadowFrame(GetFrameId());
3634 if (frame != nullptr) {
3635 // The debugger allocated a ShadowFrame to update a variable in the stack: we need to
3636 // deoptimize the stack to execute (and deallocate) this frame.
3637 needs_deoptimization_ = true;
3638 return false;
3639 }
Sebastien Hertz520633b2015-09-08 17:03:36 +02003640 return true;
3641 }
3642
3643 bool NeedsDeoptimization() const {
3644 return needs_deoptimization_;
3645 }
3646
3647 private:
3648 // Do we need to deoptimize the stack?
3649 bool needs_deoptimization_;
3650
3651 DISALLOW_COPY_AND_ASSIGN(NeedsDeoptimizationVisitor);
3652};
3653
3654// Do we need to deoptimize the stack to handle an exception?
3655bool Dbg::IsForcedInterpreterNeededForExceptionImpl(Thread* thread) {
3656 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3657 if (ssc != nullptr) {
3658 // We deopt to step into the catch handler.
3659 return true;
3660 }
3661 // Deoptimization is required if at least one method in the stack needs it. However we
3662 // skip frames that will be unwound (thus not executed).
3663 NeedsDeoptimizationVisitor visitor(thread);
3664 visitor.WalkStack(true); // includes upcall.
3665 return visitor.NeedsDeoptimization();
3666}
3667
Jeff Hao449db332013-04-12 18:30:52 -07003668// Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3669// cause suspension if the thread is the current thread.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003670class ScopedDebuggerThreadSuspension {
Jeff Hao449db332013-04-12 18:30:52 -07003671 public:
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003672 ScopedDebuggerThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
Mathieu Chartier90443472015-07-16 20:32:27 -07003673 REQUIRES(!Locks::thread_list_lock_)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003674 REQUIRES_SHARED(Locks::mutator_lock_) :
Ian Rogersf3d874c2014-07-17 18:52:42 -07003675 thread_(nullptr),
Jeff Hao449db332013-04-12 18:30:52 -07003676 error_(JDWP::ERR_NONE),
3677 self_suspend_(false),
Ian Rogers33e95662013-05-20 20:29:14 -07003678 other_suspend_(false) {
Jeff Hao449db332013-04-12 18:30:52 -07003679 ScopedObjectAccessUnchecked soa(self);
Sebastien Hertz69206392015-04-07 15:54:25 +02003680 thread_ = DecodeThread(soa, thread_id, &error_);
Jeff Hao449db332013-04-12 18:30:52 -07003681 if (error_ == JDWP::ERR_NONE) {
3682 if (thread_ == soa.Self()) {
3683 self_suspend_ = true;
3684 } else {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003685 Thread* suspended_thread;
3686 {
3687 ScopedThreadSuspension sts(self, kWaitingForDebuggerSuspension);
3688 jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
3689 bool timed_out;
3690 ThreadList* const thread_list = Runtime::Current()->GetThreadList();
Sebastien Hertzcdd798d2017-04-18 18:28:51 +02003691 suspended_thread = thread_list->SuspendThreadByPeer(thread_peer,
3692 /* request_suspension */ true,
3693 /* debug_suspension */ true,
3694 &timed_out);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003695 }
Ian Rogersf3d874c2014-07-17 18:52:42 -07003696 if (suspended_thread == nullptr) {
Jeff Hao449db332013-04-12 18:30:52 -07003697 // Thread terminated from under us while suspending.
3698 error_ = JDWP::ERR_INVALID_THREAD;
3699 } else {
3700 CHECK_EQ(suspended_thread, thread_);
3701 other_suspend_ = true;
3702 }
3703 }
3704 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003705 }
Elliott Hughes86964332012-02-15 19:37:42 -08003706
Jeff Hao449db332013-04-12 18:30:52 -07003707 Thread* GetThread() const {
3708 return thread_;
3709 }
3710
3711 JDWP::JdwpError GetError() const {
3712 return error_;
3713 }
3714
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003715 ~ScopedDebuggerThreadSuspension() {
Jeff Hao449db332013-04-12 18:30:52 -07003716 if (other_suspend_) {
3717 Runtime::Current()->GetThreadList()->Resume(thread_, true);
3718 }
3719 }
3720
3721 private:
3722 Thread* thread_;
3723 JDWP::JdwpError error_;
3724 bool self_suspend_;
3725 bool other_suspend_;
3726};
3727
3728JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3729 JDWP::JdwpStepDepth step_depth) {
3730 Thread* self = Thread::Current();
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003731 ScopedDebuggerThreadSuspension sts(self, thread_id);
Jeff Hao449db332013-04-12 18:30:52 -07003732 if (sts.GetError() != JDWP::ERR_NONE) {
3733 return sts.GetError();
3734 }
3735
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003736 // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
Elliott Hughes2435a572012-02-17 16:07:41 -08003737 // is for step-out.
Ian Rogers0399dde2012-06-06 17:09:28 -07003738 struct SingleStepStackVisitor : public StackVisitor {
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003739 explicit SingleStepStackVisitor(Thread* thread) REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003740 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3741 stack_depth(0),
3742 method(nullptr),
3743 line_number(-1) {}
Ian Rogersca190662012-06-26 15:45:57 -07003744
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003745 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3746 // annotalysis.
3747 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003748 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07003749 if (!m->IsRuntimeMethod()) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003750 ++stack_depth;
3751 if (method == nullptr) {
Alex Light73376312017-04-06 10:10:51 -07003752 const DexFile* dex_file = m->GetDexFile();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003753 method = m;
Alex Light73376312017-04-06 10:10:51 -07003754 if (dex_file != nullptr) {
David Sehr9323e6e2016-09-13 08:58:35 -07003755 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc());
Elliott Hughes2435a572012-02-17 16:07:41 -08003756 }
Elliott Hughes86964332012-02-15 19:37:42 -08003757 }
3758 }
Elliott Hughes530fa002012-03-12 11:44:49 -07003759 return true;
Elliott Hughes86964332012-02-15 19:37:42 -08003760 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003761
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003762 int stack_depth;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003763 ArtMethod* method;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003764 int32_t line_number;
Elliott Hughes86964332012-02-15 19:37:42 -08003765 };
Jeff Hao449db332013-04-12 18:30:52 -07003766
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003767 Thread* const thread = sts.GetThread();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003768 SingleStepStackVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07003769 visitor.WalkStack();
Elliott Hughes86964332012-02-15 19:37:42 -08003770
Elliott Hughes2435a572012-02-17 16:07:41 -08003771 // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
Elliott Hughes2435a572012-02-17 16:07:41 -08003772 struct DebugCallbackContext {
Roland Levillain3887c462015-08-12 18:15:42 +01003773 DebugCallbackContext(SingleStepControl* single_step_control_cb,
3774 int32_t line_number_cb, const DexFile::CodeItem* code_item)
3775 : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
3776 code_item_(code_item), last_pc_valid(false), last_pc(0) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003777 }
3778
David Srbeckyb06e28e2015-12-10 13:15:00 +00003779 static bool Callback(void* raw_context, const DexFile::PositionInfo& entry) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003780 DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
David Srbeckyb06e28e2015-12-10 13:15:00 +00003781 if (static_cast<int32_t>(entry.line_) == context->line_number_) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003782 if (!context->last_pc_valid) {
3783 // Everything from this address until the next line change is ours.
David Srbeckyb06e28e2015-12-10 13:15:00 +00003784 context->last_pc = entry.address_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003785 context->last_pc_valid = true;
3786 }
3787 // Otherwise, if we're already in a valid range for this line,
3788 // just keep going (shouldn't really happen)...
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003789 } else if (context->last_pc_valid) { // and the line number is new
Elliott Hughes2435a572012-02-17 16:07:41 -08003790 // Add everything from the last entry up until here to the set
David Srbeckyb06e28e2015-12-10 13:15:00 +00003791 for (uint32_t dex_pc = context->last_pc; dex_pc < entry.address_; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003792 context->single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003793 }
3794 context->last_pc_valid = false;
3795 }
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003796 return false; // There may be multiple entries for any given line.
Elliott Hughes2435a572012-02-17 16:07:41 -08003797 }
3798
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003799 ~DebugCallbackContext() {
Elliott Hughes2435a572012-02-17 16:07:41 -08003800 // If the line number was the last in the position table...
3801 if (last_pc_valid) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003802 size_t end = code_item_->insns_size_in_code_units_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003803 for (uint32_t dex_pc = last_pc; dex_pc < end; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003804 single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003805 }
3806 }
3807 }
3808
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003809 SingleStepControl* const single_step_control_;
3810 const int32_t line_number_;
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003811 const DexFile::CodeItem* const code_item_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003812 bool last_pc_valid;
3813 uint32_t last_pc;
3814 };
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003815
3816 // Allocate single step.
Sebastien Hertz1558b572015-02-25 15:05:59 +01003817 SingleStepControl* single_step_control =
3818 new (std::nothrow) SingleStepControl(step_size, step_depth,
3819 visitor.stack_depth, visitor.method);
3820 if (single_step_control == nullptr) {
3821 LOG(ERROR) << "Failed to allocate SingleStepControl";
3822 return JDWP::ERR_OUT_OF_MEMORY;
3823 }
3824
Mathieu Chartiere401d142015-04-22 13:56:20 -07003825 ArtMethod* m = single_step_control->GetMethod();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003826 const int32_t line_number = visitor.line_number;
Sebastien Hertz52f5f932015-05-28 11:00:57 +02003827 // Note: if the thread is not running Java code (pure native thread), there is no "current"
3828 // method on the stack (and no line number either).
3829 if (m != nullptr && !m->IsNative()) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003830 const DexFile::CodeItem* const code_item = m->GetCodeItem();
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003831 DebugCallbackContext context(single_step_control, line_number, code_item);
David Srbeckyb06e28e2015-12-10 13:15:00 +00003832 m->GetDexFile()->DecodeDebugPositionInfo(code_item, DebugCallbackContext::Callback, &context);
Elliott Hughes3e2e1a22012-02-21 11:33:41 -08003833 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003834
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003835 // Activate single-step in the thread.
3836 thread->ActivateSingleStepControl(single_step_control);
Elliott Hughes86964332012-02-15 19:37:42 -08003837
Elliott Hughes2435a572012-02-17 16:07:41 -08003838 if (VLOG_IS_ON(jdwp)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003839 VLOG(jdwp) << "Single-step thread: " << *thread;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003840 VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3841 VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
David Sehr709b0702016-10-13 09:12:37 -07003842 VLOG(jdwp) << "Single-step current method: "
3843 << ArtMethod::PrettyMethod(single_step_control->GetMethod());
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003844 VLOG(jdwp) << "Single-step current line: " << line_number;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003845 VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
Elliott Hughes2435a572012-02-17 16:07:41 -08003846 VLOG(jdwp) << "Single-step dex_pc values:";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003847 for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003848 VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003849 }
3850 }
3851
3852 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003853}
3854
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003855void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3856 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07003857 JDWP::JdwpError error;
3858 Thread* thread = DecodeThread(soa, thread_id, &error);
Sebastien Hertz87118ed2013-11-26 17:57:18 +01003859 if (error == JDWP::ERR_NONE) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003860 thread->DeactivateSingleStepControl();
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003861 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003862}
3863
Elliott Hughes45651fd2012-02-21 15:48:20 -08003864static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3865 switch (tag) {
3866 default:
3867 LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
Ian Rogersfc787ec2014-10-09 21:56:44 -07003868 UNREACHABLE();
Elliott Hughes45651fd2012-02-21 15:48:20 -08003869
3870 // Primitives.
3871 case JDWP::JT_BYTE: return 'B';
3872 case JDWP::JT_CHAR: return 'C';
3873 case JDWP::JT_FLOAT: return 'F';
3874 case JDWP::JT_DOUBLE: return 'D';
3875 case JDWP::JT_INT: return 'I';
3876 case JDWP::JT_LONG: return 'J';
3877 case JDWP::JT_SHORT: return 'S';
3878 case JDWP::JT_VOID: return 'V';
3879 case JDWP::JT_BOOLEAN: return 'Z';
3880
3881 // Reference types.
3882 case JDWP::JT_ARRAY:
3883 case JDWP::JT_OBJECT:
3884 case JDWP::JT_STRING:
3885 case JDWP::JT_THREAD:
3886 case JDWP::JT_THREAD_GROUP:
3887 case JDWP::JT_CLASS_LOADER:
3888 case JDWP::JT_CLASS_OBJECT:
3889 return 'L';
3890 }
3891}
3892
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003893JDWP::JdwpError Dbg::PrepareInvokeMethod(uint32_t request_id, JDWP::ObjectId thread_id,
3894 JDWP::ObjectId object_id, JDWP::RefTypeId class_id,
3895 JDWP::MethodId method_id, uint32_t arg_count,
3896 uint64_t arg_values[], JDWP::JdwpTag* arg_types,
3897 uint32_t options) {
3898 Thread* const self = Thread::Current();
3899 CHECK_EQ(self, GetDebugThread()) << "This must be called by the JDWP thread";
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003900 const bool resume_all_threads = ((options & JDWP::INVOKE_SINGLE_THREADED) == 0);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003901
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003902 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Ian Rogersc0542af2014-09-03 16:16:56 -07003903 Thread* targetThread = nullptr;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003904 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003905 ScopedObjectAccessUnchecked soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07003906 JDWP::JdwpError error;
3907 targetThread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08003908 if (error != JDWP::ERR_NONE) {
3909 LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3910 return error;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003911 }
Sebastien Hertz1558b572015-02-25 15:05:59 +01003912 if (targetThread->GetInvokeReq() != nullptr) {
3913 // Thread is already invoking a method on behalf of the debugger.
3914 LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
3915 return JDWP::ERR_ALREADY_INVOKING;
3916 }
3917 if (!targetThread->IsReadyForDebugInvoke()) {
3918 // Thread is not suspended by an event so it cannot invoke a method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003919 LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
3920 return JDWP::ERR_INVALID_THREAD;
3921 }
3922
3923 /*
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003924 * According to the JDWP specs, we are expected to resume all threads (or only the
3925 * target thread) once. So if a thread has been suspended more than once (either by
3926 * the debugger for an event or by the runtime for GC), it will remain suspended before
3927 * the invoke is executed. This means the debugger is responsible to properly resume all
3928 * the threads it has suspended so the target thread can execute the method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003929 *
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003930 * However, for compatibility reason with older versions of debuggers (like Eclipse), we
3931 * fully resume all threads (by canceling *all* debugger suspensions) when the debugger
3932 * wants us to resume all threads. This is to avoid ending up in deadlock situation.
3933 *
3934 * On the other hand, if we are asked to only resume the target thread, then we follow the
3935 * JDWP specs by resuming that thread only once. This means the thread will remain suspended
3936 * if it has been suspended more than once before the invoke (and again, this is the
3937 * responsibility of the debugger to properly resume that thread before invoking a method).
Elliott Hughesd07986f2011-12-06 18:27:45 -08003938 */
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003939 int suspend_count;
3940 {
Ian Rogers50b35e22012-10-04 10:09:15 -07003941 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003942 suspend_count = targetThread->GetSuspendCount();
3943 }
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003944 if (suspend_count > 1 && resume_all_threads) {
3945 // The target thread will remain suspended even after we resume it. Let's emit a warning
3946 // to indicate the invoke won't be executed until the thread is resumed.
3947 LOG(WARNING) << *targetThread << " suspended more than once (suspend count == "
3948 << suspend_count << "). This thread will invoke the method only once "
3949 << "it is fully resumed.";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003950 }
3951
Ian Rogersc0542af2014-09-03 16:16:56 -07003952 mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
3953 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003954 return JDWP::ERR_INVALID_OBJECT;
3955 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003956
Sebastien Hertz1558b572015-02-25 15:05:59 +01003957 gRegistry->Get<mirror::Object*>(thread_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07003958 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003959 return JDWP::ERR_INVALID_OBJECT;
3960 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003961
Ian Rogersc0542af2014-09-03 16:16:56 -07003962 mirror::Class* c = DecodeClass(class_id, &error);
3963 if (c == nullptr) {
3964 return error;
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003965 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003966
Mathieu Chartiere401d142015-04-22 13:56:20 -07003967 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07003968 if (m->IsStatic() != (receiver == nullptr)) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003969 return JDWP::ERR_INVALID_METHODID;
3970 }
3971 if (m->IsStatic()) {
3972 if (m->GetDeclaringClass() != c) {
3973 return JDWP::ERR_INVALID_METHODID;
3974 }
3975 } else {
3976 if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
3977 return JDWP::ERR_INVALID_METHODID;
3978 }
3979 }
3980
3981 // Check the argument list matches the method.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003982 uint32_t shorty_len = 0;
3983 const char* shorty = m->GetShorty(&shorty_len);
3984 if (shorty_len - 1 != arg_count) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003985 return JDWP::ERR_ILLEGAL_ARGUMENT;
3986 }
Elliott Hughes09201632013-04-15 15:50:07 -07003987
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003988 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003989 StackHandleScope<2> hs(soa.Self());
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003990 HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
3991 HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
3992 const DexFile::TypeList* types = m->GetParameterTypeList();
3993 for (size_t i = 0; i < arg_count; ++i) {
3994 if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
Elliott Hughes09201632013-04-15 15:50:07 -07003995 return JDWP::ERR_ILLEGAL_ARGUMENT;
3996 }
3997
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003998 if (shorty[i + 1] == 'L') {
3999 // Did we really get an argument of an appropriate reference type?
Ian Rogersa0485602014-12-02 15:48:04 -08004000 mirror::Class* parameter_type =
Vladimir Marko942fd312017-01-16 20:52:19 +00004001 m->GetClassFromTypeIndex(types->GetTypeItem(i).type_idx_, true /* resolve */);
Ian Rogersc0542af2014-09-03 16:16:56 -07004002 mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
4003 if (error != JDWP::ERR_NONE) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004004 return JDWP::ERR_INVALID_OBJECT;
4005 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004006 if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004007 return JDWP::ERR_ILLEGAL_ARGUMENT;
4008 }
4009
4010 // Turn the on-the-wire ObjectId into a jobject.
4011 jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
4012 v.l = gRegistry->GetJObject(arg_values[i]);
4013 }
Elliott Hughes09201632013-04-15 15:50:07 -07004014 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08004015 }
4016
Sebastien Hertz1558b572015-02-25 15:05:59 +01004017 // Allocates a DebugInvokeReq.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004018 DebugInvokeReq* req = new (std::nothrow) DebugInvokeReq(request_id, thread_id, receiver, c, m,
4019 options, arg_values, arg_count);
4020 if (req == nullptr) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004021 LOG(ERROR) << "Failed to allocate DebugInvokeReq";
4022 return JDWP::ERR_OUT_OF_MEMORY;
4023 }
4024
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004025 // Attaches the DebugInvokeReq to the target thread so it executes the method when
4026 // it is resumed. Once the invocation completes, the target thread will delete it before
4027 // suspending itself (see ThreadList::SuspendSelfForDebugger).
4028 targetThread->SetDebugInvokeReq(req);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004029 }
4030
4031 // 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 +02004032 // away we're sitting high and dry -- but we must release this before the UndoDebuggerSuspensions
4033 // call.
Sebastien Hertzd4032e42015-06-12 15:47:34 +02004034 if (resume_all_threads) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004035 VLOG(jdwp) << " Resuming all threads";
4036 thread_list->UndoDebuggerSuspensions();
4037 } else {
4038 VLOG(jdwp) << " Resuming event thread only";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004039 thread_list->Resume(targetThread, true);
4040 }
4041
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004042 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004043}
4044
4045void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004046 Thread* const self = Thread::Current();
4047 CHECK_NE(self, GetDebugThread()) << "This must be called by the event thread";
4048
4049 ScopedObjectAccess soa(self);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004050
Elliott Hughes81ff3182012-03-23 20:35:56 -07004051 // We can be called while an exception is pending. We need
Elliott Hughesd07986f2011-12-06 18:27:45 -08004052 // to preserve that across the method invocation.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004053 StackHandleScope<1> hs(soa.Self());
4054 Handle<mirror::Throwable> old_exception = hs.NewHandle(soa.Self()->GetException());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004055 soa.Self()->ClearException();
Elliott Hughesd07986f2011-12-06 18:27:45 -08004056
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004057 // Execute the method then sends reply to the debugger.
4058 ExecuteMethodWithoutPendingException(soa, pReq);
4059
4060 // If an exception was pending before the invoke, restore it now.
Andreas Gampefa4333d2017-02-14 11:10:34 -08004061 if (old_exception != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004062 soa.Self()->SetException(old_exception.Get());
4063 }
4064}
4065
4066// Helper function: write a variable-width value into the output input buffer.
4067static void WriteValue(JDWP::ExpandBuf* pReply, int width, uint64_t value) {
4068 switch (width) {
4069 case 1:
4070 expandBufAdd1(pReply, value);
4071 break;
4072 case 2:
4073 expandBufAdd2BE(pReply, value);
4074 break;
4075 case 4:
4076 expandBufAdd4BE(pReply, value);
4077 break;
4078 case 8:
4079 expandBufAdd8BE(pReply, value);
4080 break;
4081 default:
4082 LOG(FATAL) << width;
4083 UNREACHABLE();
4084 }
4085}
4086
4087void Dbg::ExecuteMethodWithoutPendingException(ScopedObjectAccess& soa, DebugInvokeReq* pReq) {
4088 soa.Self()->AssertNoPendingException();
4089
Elliott Hughesd07986f2011-12-06 18:27:45 -08004090 // Translate the method through the vtable, unless the debugger wants to suppress it.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004091 ArtMethod* m = pReq->method;
Andreas Gampe542451c2016-07-26 09:02:02 -07004092 PointerSize image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
Sebastien Hertz1558b572015-02-25 15:05:59 +01004093 if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07004094 ArtMethod* actual_method =
4095 pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m, image_pointer_size);
4096 if (actual_method != m) {
David Sehr709b0702016-10-13 09:12:37 -07004097 VLOG(jdwp) << "ExecuteMethod translated " << ArtMethod::PrettyMethod(m)
4098 << " to " << ArtMethod::PrettyMethod(actual_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07004099 m = actual_method;
Elliott Hughes45651fd2012-02-21 15:48:20 -08004100 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08004101 }
David Sehr709b0702016-10-13 09:12:37 -07004102 VLOG(jdwp) << "ExecuteMethod " << ArtMethod::PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01004103 << " receiver=" << pReq->receiver.Read()
Sebastien Hertzd38667a2013-11-25 15:43:54 +01004104 << " arg_count=" << pReq->arg_count;
Mathieu Chartiere401d142015-04-22 13:56:20 -07004105 CHECK(m != nullptr);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004106
Roland Levillain33d69032015-06-18 18:20:59 +01004107 static_assert(sizeof(jvalue) == sizeof(uint64_t), "jvalue and uint64_t have different sizes.");
Elliott Hughesd07986f2011-12-06 18:27:45 -08004108
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004109 // Invoke the method.
Jeff Hao39b6c242015-05-19 20:30:23 -07004110 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(pReq->receiver.Read()));
Andreas Gampe13b27842016-11-07 16:48:23 -08004111 JValue result = InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(m),
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004112 reinterpret_cast<jvalue*>(pReq->arg_values.get()));
Elliott Hughesd07986f2011-12-06 18:27:45 -08004113
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004114 // Prepare JDWP ids for the reply.
4115 JDWP::JdwpTag result_tag = BasicTagFromDescriptor(m->GetShorty());
4116 const bool is_object_result = (result_tag == JDWP::JT_OBJECT);
Jeff Hao064d24e2016-08-25 03:52:40 +00004117 StackHandleScope<3> hs(soa.Self());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004118 Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
4119 Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
4120 soa.Self()->ClearException();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004121
4122 if (!IsDebuggerActive()) {
4123 // The debugger detached: we must not re-suspend threads. We also don't need to fill the reply
4124 // because it won't be sent either.
4125 return;
4126 }
4127
4128 JDWP::ObjectId exceptionObjectId = gRegistry->Add(exception);
4129 uint64_t result_value = 0;
4130 if (exceptionObjectId != 0) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004131 VLOG(jdwp) << " JDWP invocation returning with exception=" << exception.Get()
4132 << " " << exception->Dump();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004133 result_value = 0;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004134 } else if (is_object_result) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004135 /* if no exception was thrown, examine object result more closely */
Sebastien Hertz1558b572015-02-25 15:05:59 +01004136 JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004137 if (new_tag != result_tag) {
4138 VLOG(jdwp) << " JDWP promoted result from " << result_tag << " to " << new_tag;
4139 result_tag = new_tag;
Elliott Hughesd07986f2011-12-06 18:27:45 -08004140 }
4141
Sebastien Hertz1558b572015-02-25 15:05:59 +01004142 // Register the object in the registry and reference its ObjectId. This ensures
4143 // GC safety and prevents from accessing stale reference if the object is moved.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004144 result_value = gRegistry->Add(object_result.Get());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004145 } else {
4146 // Primitive result.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004147 DCHECK(IsPrimitiveTag(result_tag));
4148 result_value = result.GetJ();
4149 }
4150 const bool is_constructor = m->IsConstructor() && !m->IsStatic();
4151 if (is_constructor) {
4152 // If we invoked a constructor (which actually returns void), return the receiver,
4153 // unless we threw, in which case we return null.
Sebastien Hertza3e13772015-11-05 12:09:44 +01004154 DCHECK_EQ(JDWP::JT_VOID, result_tag);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004155 if (exceptionObjectId == 0) {
Jeff Hao064d24e2016-08-25 03:52:40 +00004156 if (m->GetDeclaringClass()->IsStringClass()) {
4157 // For string constructors, the new string is remapped to the receiver (stored in ref).
4158 Handle<mirror::Object> decoded_ref = hs.NewHandle(soa.Self()->DecodeJObject(ref.get()));
4159 result_value = gRegistry->Add(decoded_ref);
4160 result_tag = TagFromObject(soa, decoded_ref.Get());
4161 } else {
4162 // TODO we could keep the receiver ObjectId in the DebugInvokeReq to avoid looking into the
4163 // object registry.
4164 result_value = GetObjectRegistry()->Add(pReq->receiver.Read());
4165 result_tag = TagFromObject(soa, pReq->receiver.Read());
4166 }
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004167 } else {
4168 result_value = 0;
Sebastien Hertza3e13772015-11-05 12:09:44 +01004169 result_tag = JDWP::JT_OBJECT;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004170 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08004171 }
4172
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004173 // Suspend other threads if the invoke is not single-threaded.
4174 if ((pReq->options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004175 ScopedThreadSuspension sts(soa.Self(), kWaitingForDebuggerSuspension);
Hiroshi Yamauchi8f95cf32016-04-19 11:14:06 -07004176 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
4177 gc::ScopedGCCriticalSection gcs(soa.Self(), gc::kGcCauseDebugger, gc::kCollectorTypeDebugger);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004178 VLOG(jdwp) << " Suspending all threads";
4179 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004180 }
4181
4182 VLOG(jdwp) << " --> returned " << result_tag
4183 << StringPrintf(" %#" PRIx64 " (except=%#" PRIx64 ")", result_value,
4184 exceptionObjectId);
4185
4186 // Show detailed debug output.
4187 if (result_tag == JDWP::JT_STRING && exceptionObjectId == 0) {
4188 if (result_value != 0) {
4189 if (VLOG_IS_ON(jdwp)) {
4190 std::string result_string;
4191 JDWP::JdwpError error = Dbg::StringToUtf8(result_value, &result_string);
4192 CHECK_EQ(error, JDWP::ERR_NONE);
4193 VLOG(jdwp) << " string '" << result_string << "'";
4194 }
4195 } else {
4196 VLOG(jdwp) << " string (null)";
4197 }
4198 }
4199
4200 // Attach the reply to DebugInvokeReq so it can be sent to the debugger when the event thread
4201 // is ready to suspend.
4202 BuildInvokeReply(pReq->reply, pReq->request_id, result_tag, result_value, exceptionObjectId);
4203}
4204
4205void Dbg::BuildInvokeReply(JDWP::ExpandBuf* pReply, uint32_t request_id, JDWP::JdwpTag result_tag,
4206 uint64_t result_value, JDWP::ObjectId exception) {
4207 // Make room for the JDWP header since we do not know the size of the reply yet.
4208 JDWP::expandBufAddSpace(pReply, kJDWPHeaderLen);
4209
4210 size_t width = GetTagWidth(result_tag);
4211 JDWP::expandBufAdd1(pReply, result_tag);
4212 if (width != 0) {
4213 WriteValue(pReply, width, result_value);
4214 }
4215 JDWP::expandBufAdd1(pReply, JDWP::JT_OBJECT);
4216 JDWP::expandBufAddObjectId(pReply, exception);
4217
4218 // Now we know the size, we can complete the JDWP header.
4219 uint8_t* buf = expandBufGetBuffer(pReply);
4220 JDWP::Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReply));
4221 JDWP::Set4BE(buf + kJDWPHeaderIdOffset, request_id);
4222 JDWP::Set1(buf + kJDWPHeaderFlagsOffset, kJDWPFlagReply); // flags
4223 JDWP::Set2BE(buf + kJDWPHeaderErrorCodeOffset, JDWP::ERR_NONE);
4224}
4225
4226void Dbg::FinishInvokeMethod(DebugInvokeReq* pReq) {
4227 CHECK_NE(Thread::Current(), GetDebugThread()) << "This must be called by the event thread";
4228
4229 JDWP::ExpandBuf* const pReply = pReq->reply;
4230 CHECK(pReply != nullptr) << "No reply attached to DebugInvokeReq";
4231
4232 // We need to prevent other threads (including JDWP thread) from interacting with the debugger
4233 // while we send the reply but are not yet suspended. The JDWP token will be released just before
4234 // we suspend ourself again (see ThreadList::SuspendSelfForDebugger).
4235 gJdwpState->AcquireJdwpTokenForEvent(pReq->thread_id);
4236
4237 // Send the reply unless the debugger detached before the completion of the method.
4238 if (IsDebuggerActive()) {
4239 const size_t replyDataLength = expandBufGetLength(pReply) - kJDWPHeaderLen;
4240 VLOG(jdwp) << StringPrintf("REPLY INVOKE id=0x%06x (length=%zu)",
4241 pReq->request_id, replyDataLength);
4242
4243 gJdwpState->SendRequest(pReply);
4244 } else {
4245 VLOG(jdwp) << "Not sending invoke reply because debugger detached";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004246 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004247}
4248
Elliott Hughesd07986f2011-12-06 18:27:45 -08004249/*
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004250 * "request" contains a full JDWP packet, possibly with multiple chunks. We
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004251 * need to process each, accumulate the replies, and ship the whole thing
4252 * back.
4253 *
4254 * Returns "true" if we have a reply. The reply buffer is newly allocated,
4255 * and includes the chunk type/length, followed by the data.
4256 *
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08004257 * OLD-TODO: we currently assume that the request and reply include a single
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004258 * chunk. If this becomes inconvenient we will need to adapt.
4259 */
Ian Rogersc0542af2014-09-03 16:16:56 -07004260bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004261 Thread* self = Thread::Current();
4262 JNIEnv* env = self->GetJniEnv();
4263
Ian Rogersc0542af2014-09-03 16:16:56 -07004264 uint32_t type = request->ReadUnsigned32("type");
4265 uint32_t length = request->ReadUnsigned32("length");
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004266
4267 // Create a byte[] corresponding to 'request'.
Ian Rogersc0542af2014-09-03 16:16:56 -07004268 size_t request_length = request->size();
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004269 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(request_length));
Ian Rogersc0542af2014-09-03 16:16:56 -07004270 if (dataArray.get() == nullptr) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004271 LOG(WARNING) << "byte[] allocation failed: " << request_length;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004272 env->ExceptionClear();
4273 return false;
4274 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004275 env->SetByteArrayRegion(dataArray.get(), 0, request_length,
4276 reinterpret_cast<const jbyte*>(request->data()));
4277 request->Skip(request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004278
4279 // Run through and find all chunks. [Currently just find the first.]
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004280 ScopedByteArrayRO contents(env, dataArray.get());
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004281 if (length != request_length) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08004282 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004283 return false;
4284 }
4285
4286 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
Elliott Hugheseac76672012-05-24 21:56:51 -07004287 ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4288 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004289 type, dataArray.get(), 0, length));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004290 if (env->ExceptionCheck()) {
4291 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
4292 env->ExceptionDescribe();
4293 env->ExceptionClear();
4294 return false;
4295 }
4296
Ian Rogersc0542af2014-09-03 16:16:56 -07004297 if (chunk.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004298 return false;
4299 }
4300
4301 /*
4302 * Pull the pieces out of the chunk. We copy the results into a
4303 * newly-allocated buffer that the caller can free. We don't want to
4304 * continue using the Chunk object because nothing has a reference to it.
4305 *
4306 * We could avoid this by returning type/data/offset/length and having
4307 * the caller be aware of the object lifetime issues, but that
Elliott Hughes81ff3182012-03-23 20:35:56 -07004308 * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004309 * if we have responses for multiple chunks.
4310 *
4311 * So we're pretty much stuck with copying data around multiple times.
4312 */
Elliott Hugheseac76672012-05-24 21:56:51 -07004313 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 -08004314 jint offset = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
Elliott Hugheseac76672012-05-24 21:56:51 -07004315 length = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
Elliott Hugheseac76672012-05-24 21:56:51 -07004316 type = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004317
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004318 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 -07004319 if (length == 0 || replyData.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004320 return false;
4321 }
4322
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004323 const int kChunkHdrLen = 8;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004324 uint8_t* reply = new uint8_t[length + kChunkHdrLen];
Ian Rogersc0542af2014-09-03 16:16:56 -07004325 if (reply == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004326 LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
4327 return false;
4328 }
Elliott Hughesf7c3b662011-10-27 12:04:56 -07004329 JDWP::Set4BE(reply + 0, type);
4330 JDWP::Set4BE(reply + 4, length);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004331 env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004332
4333 *pReplyBuf = reply;
4334 *pReplyLen = length + kChunkHdrLen;
4335
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004336 VLOG(jdwp) << StringPrintf("dvmHandleDdm returning type=%.4s %p len=%d", reinterpret_cast<char*>(reply), reply, length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004337 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004338}
4339
Elliott Hughesa2155262011-11-16 16:26:58 -08004340void Dbg::DdmBroadcast(bool connect) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004341 VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
Elliott Hughes47fce012011-10-25 18:37:19 -07004342
4343 Thread* self = Thread::Current();
Ian Rogers50b35e22012-10-04 10:09:15 -07004344 if (self->GetState() != kRunnable) {
4345 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4346 /* try anyway? */
Elliott Hughes47fce012011-10-25 18:37:19 -07004347 }
4348
4349 JNIEnv* env = self->GetJniEnv();
Elliott Hughes47fce012011-10-25 18:37:19 -07004350 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
Elliott Hugheseac76672012-05-24 21:56:51 -07004351 env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4352 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4353 event);
Elliott Hughes47fce012011-10-25 18:37:19 -07004354 if (env->ExceptionCheck()) {
4355 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4356 env->ExceptionDescribe();
4357 env->ExceptionClear();
4358 }
4359}
4360
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004361void Dbg::DdmConnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004362 Dbg::DdmBroadcast(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004363}
4364
4365void Dbg::DdmDisconnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004366 Dbg::DdmBroadcast(false);
Elliott Hughes47fce012011-10-25 18:37:19 -07004367 gDdmThreadNotification = false;
4368}
4369
4370/*
Elliott Hughes82188472011-11-07 18:11:48 -08004371 * Send a notification when a thread starts, stops, or changes its name.
Elliott Hughes47fce012011-10-25 18:37:19 -07004372 *
4373 * Because we broadcast the full set of threads when the notifications are
4374 * first enabled, it's possible for "thread" to be actively executing.
4375 */
Elliott Hughes82188472011-11-07 18:11:48 -08004376void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004377 if (!gDdmThreadNotification) {
4378 return;
4379 }
4380
Elliott Hughes82188472011-11-07 18:11:48 -08004381 if (type == CHUNK_TYPE("THDE")) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004382 uint8_t buf[4];
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004383 JDWP::Set4BE(&buf[0], t->GetThreadId());
Elliott Hughes47fce012011-10-25 18:37:19 -07004384 Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
Elliott Hughes82188472011-11-07 18:11:48 -08004385 } else {
4386 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004387 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07004388 StackHandleScope<1> hs(soa.Self());
Andreas Gampe08883de2016-11-08 13:20:52 -08004389 Handle<mirror::String> name(hs.NewHandle(t->GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08004390 size_t char_count = (name != nullptr) ? name->GetLength() : 0;
4391 const jchar* chars = (name != nullptr) ? name->GetValue() : nullptr;
4392 bool is_compressed = (name != nullptr) ? name->IsCompressed() : false;
Elliott Hughes82188472011-11-07 18:11:48 -08004393
Elliott Hughes21f32d72011-11-09 17:44:13 -08004394 std::vector<uint8_t> bytes;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004395 JDWP::Append4BE(bytes, t->GetThreadId());
jessicahandojo3aaa37b2016-07-29 14:46:37 -07004396 if (is_compressed) {
4397 const uint8_t* chars_compressed = name->GetValueCompressed();
4398 JDWP::AppendUtf16CompressedBE(bytes, chars_compressed, char_count);
4399 } else {
4400 JDWP::AppendUtf16BE(bytes, chars, char_count);
4401 }
Elliott Hughes21f32d72011-11-09 17:44:13 -08004402 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
4403 Dbg::DdmSendChunk(type, bytes);
Elliott Hughes47fce012011-10-25 18:37:19 -07004404 }
4405}
4406
Elliott Hughes47fce012011-10-25 18:37:19 -07004407void Dbg::DdmSetThreadNotification(bool enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004408 // Enable/disable thread notifications.
Elliott Hughes47fce012011-10-25 18:37:19 -07004409 gDdmThreadNotification = enable;
4410 if (enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004411 // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4412 // see a suspension in progress and block until that ends. They then post their own start
4413 // notification.
4414 SuspendVM();
4415 std::list<Thread*> threads;
Ian Rogers50b35e22012-10-04 10:09:15 -07004416 Thread* self = Thread::Current();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004417 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004418 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004419 threads = Runtime::Current()->GetThreadList()->GetList();
4420 }
4421 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004422 ScopedObjectAccess soa(self);
Mathieu Chartier02e25112013-08-14 16:14:24 -07004423 for (Thread* thread : threads) {
4424 Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004425 }
4426 }
4427 ResumeVM();
Elliott Hughes47fce012011-10-25 18:37:19 -07004428 }
4429}
4430
Elliott Hughesa2155262011-11-16 16:26:58 -08004431void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07004432 if (IsDebuggerActive()) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02004433 gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004434 }
Elliott Hughes82188472011-11-07 18:11:48 -08004435 Dbg::DdmSendThreadNotification(t, type);
Elliott Hughes47fce012011-10-25 18:37:19 -07004436}
4437
4438void Dbg::PostThreadStart(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004439 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004440}
4441
4442void Dbg::PostThreadDeath(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004443 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004444}
4445
Elliott Hughes82188472011-11-07 18:11:48 -08004446void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004447 CHECK(buf != nullptr);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004448 iovec vec[1];
4449 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
4450 vec[0].iov_len = byte_count;
4451 Dbg::DdmSendChunkV(type, vec, 1);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004452}
4453
Elliott Hughes21f32d72011-11-09 17:44:13 -08004454void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
4455 DdmSendChunk(type, bytes.size(), &bytes[0]);
4456}
4457
Brian Carlstromf5293522013-07-19 00:24:00 -07004458void Dbg::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004459 if (gJdwpState == nullptr) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004460 VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
Elliott Hughes3bb81562011-10-21 18:52:59 -07004461 } else {
Elliott Hughescccd84f2011-12-05 16:51:54 -08004462 gJdwpState->DdmSendChunkV(type, iov, iov_count);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004463 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004464}
4465
Mathieu Chartierad466ad2015-01-08 16:28:08 -08004466JDWP::JdwpState* Dbg::GetJdwpState() {
4467 return gJdwpState;
4468}
4469
Elliott Hughes767a1472011-10-26 18:49:02 -07004470int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4471 if (when == HPIF_WHEN_NOW) {
Elliott Hughes7162ad92011-10-27 14:08:42 -07004472 DdmSendHeapInfo(when);
Elliott Hughes767a1472011-10-26 18:49:02 -07004473 return true;
4474 }
4475
4476 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4477 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4478 return false;
4479 }
4480
4481 gDdmHpifWhen = when;
4482 return true;
4483}
4484
4485bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4486 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4487 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4488 return false;
4489 }
4490
4491 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4492 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4493 return false;
4494 }
4495
4496 if (native) {
4497 gDdmNhsgWhen = when;
4498 gDdmNhsgWhat = what;
4499 } else {
4500 gDdmHpsgWhen = when;
4501 gDdmHpsgWhat = what;
4502 }
4503 return true;
4504}
4505
Elliott Hughes7162ad92011-10-27 14:08:42 -07004506void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4507 // If there's a one-shot 'when', reset it.
4508 if (reason == gDdmHpifWhen) {
4509 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4510 gDdmHpifWhen = HPIF_WHEN_NEVER;
4511 }
4512 }
4513
4514 /*
4515 * Chunk HPIF (client --> server)
4516 *
4517 * Heap Info. General information about the heap,
4518 * suitable for a summary display.
4519 *
4520 * [u4]: number of heaps
4521 *
4522 * For each heap:
4523 * [u4]: heap ID
4524 * [u8]: timestamp in ms since Unix epoch
4525 * [u1]: capture reason (same as 'when' value from server)
4526 * [u4]: max heap size in bytes (-Xmx)
4527 * [u4]: current heap size in bytes
4528 * [u4]: current number of bytes allocated
4529 * [u4]: current number of objects allocated
4530 */
4531 uint8_t heap_count = 1;
Ian Rogers1d54e732013-05-02 21:10:01 -07004532 gc::Heap* heap = Runtime::Current()->GetHeap();
Elliott Hughes21f32d72011-11-09 17:44:13 -08004533 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08004534 JDWP::Append4BE(bytes, heap_count);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004535 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
Elliott Hughes545a0642011-11-08 19:10:03 -08004536 JDWP::Append8BE(bytes, MilliTime());
4537 JDWP::Append1BE(bytes, reason);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004538 JDWP::Append4BE(bytes, heap->GetMaxMemory()); // Max allowed heap size in bytes.
4539 JDWP::Append4BE(bytes, heap->GetTotalMemory()); // Current heap size in bytes.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -08004540 JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4541 JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
Elliott Hughes21f32d72011-11-09 17:44:13 -08004542 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
4543 Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
Elliott Hughes767a1472011-10-26 18:49:02 -07004544}
4545
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004546enum HpsgSolidity {
4547 SOLIDITY_FREE = 0,
4548 SOLIDITY_HARD = 1,
4549 SOLIDITY_SOFT = 2,
4550 SOLIDITY_WEAK = 3,
4551 SOLIDITY_PHANTOM = 4,
4552 SOLIDITY_FINALIZABLE = 5,
4553 SOLIDITY_SWEEP = 6,
4554};
4555
4556enum HpsgKind {
4557 KIND_OBJECT = 0,
4558 KIND_CLASS_OBJECT = 1,
4559 KIND_ARRAY_1 = 2,
4560 KIND_ARRAY_2 = 3,
4561 KIND_ARRAY_4 = 4,
4562 KIND_ARRAY_8 = 5,
4563 KIND_UNKNOWN = 6,
4564 KIND_NATIVE = 7,
4565};
4566
4567#define HPSG_PARTIAL (1<<7)
4568#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4569
Ian Rogers30fab402012-01-23 15:43:46 -08004570class HeapChunkContext {
4571 public:
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004572 // Maximum chunk size. Obtain this from the formula:
4573 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4574 HeapChunkContext(bool merge, bool native)
Ian Rogers30fab402012-01-23 15:43:46 -08004575 : buf_(16384 - 16),
4576 type_(0),
Mathieu Chartier36dab362014-07-30 14:59:56 -07004577 chunk_overhead_(0) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004578 Reset();
4579 if (native) {
Ian Rogers30fab402012-01-23 15:43:46 -08004580 type_ = CHUNK_TYPE("NHSG");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004581 } else {
Ian Rogers30fab402012-01-23 15:43:46 -08004582 type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004583 }
4584 }
4585
4586 ~HeapChunkContext() {
Ian Rogers30fab402012-01-23 15:43:46 -08004587 if (p_ > &buf_[0]) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004588 Flush();
4589 }
4590 }
4591
Mathieu Chartier36dab362014-07-30 14:59:56 -07004592 void SetChunkOverhead(size_t chunk_overhead) {
4593 chunk_overhead_ = chunk_overhead;
4594 }
4595
4596 void ResetStartOfNextChunk() {
4597 startOfNextMemoryChunk_ = nullptr;
4598 }
4599
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004600 void EnsureHeader(const void* chunk_ptr) {
Ian Rogers30fab402012-01-23 15:43:46 -08004601 if (!needHeader_) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004602 return;
4603 }
4604
4605 // Start a new HPSx chunk.
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004606 JDWP::Write4BE(&p_, 1); // Heap id (bogus; we only have one heap).
4607 JDWP::Write1BE(&p_, 8); // Size of allocation unit, in bytes.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004608
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004609 JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
4610 JDWP::Write4BE(&p_, 0); // offset of this piece (relative to the virtual address).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004611 // [u4]: length of piece, in allocation units
4612 // 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 -08004613 pieceLenField_ = p_;
4614 JDWP::Write4BE(&p_, 0x55555555);
4615 needHeader_ = false;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004616 }
4617
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004618 void Flush() REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004619 if (pieceLenField_ == nullptr) {
Ian Rogersd636b062013-01-18 17:51:18 -08004620 // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4621 CHECK(needHeader_);
4622 return;
4623 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004624 // Patch the "length of piece" field.
Ian Rogers30fab402012-01-23 15:43:46 -08004625 CHECK_LE(&buf_[0], pieceLenField_);
4626 CHECK_LE(pieceLenField_, p_);
4627 JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004628
Ian Rogers30fab402012-01-23 15:43:46 -08004629 Dbg::DdmSendChunk(type_, p_ - &buf_[0], &buf_[0]);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004630 Reset();
4631 }
4632
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004633 static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004634 REQUIRES_SHARED(Locks::heap_bitmap_lock_,
Ian Rogersb726dcb2012-09-05 08:57:23 -07004635 Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004636 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4637 }
4638
4639 static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004640 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004641 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
Elliott Hughesa2155262011-11-16 16:26:58 -08004642 }
4643
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004644 private:
Elliott Hughesa2155262011-11-16 16:26:58 -08004645 enum { ALLOCATION_UNIT_SIZE = 8 };
4646
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004647 void Reset() {
Ian Rogers30fab402012-01-23 15:43:46 -08004648 p_ = &buf_[0];
Mathieu Chartier36dab362014-07-30 14:59:56 -07004649 ResetStartOfNextChunk();
Ian Rogers30fab402012-01-23 15:43:46 -08004650 totalAllocationUnits_ = 0;
4651 needHeader_ = true;
Ian Rogersc0542af2014-09-03 16:16:56 -07004652 pieceLenField_ = nullptr;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004653 }
4654
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004655 bool IsNative() const {
4656 return type_ == CHUNK_TYPE("NHSG");
4657 }
4658
4659 // Returns true if the object is not an empty chunk.
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004660 bool ProcessRecord(void* start, size_t used_bytes) REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers30fab402012-01-23 15:43:46 -08004661 // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4662 // in the following code not to allocate memory, by ensuring buf_ is of the correct size
Ian Rogers15bf2d32012-08-28 17:33:04 -07004663 if (used_bytes == 0) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004664 if (start == nullptr) {
4665 // Reset for start of new heap.
4666 startOfNextMemoryChunk_ = nullptr;
4667 Flush();
4668 }
4669 // Only process in use memory so that free region information
4670 // also includes dlmalloc book keeping.
4671 return false;
Elliott Hughesa2155262011-11-16 16:26:58 -08004672 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004673 if (startOfNextMemoryChunk_ != nullptr) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004674 // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4675 // of the use of mmaps, so don't report. If not free memory then start a new segment.
4676 bool flush = true;
4677 if (start > startOfNextMemoryChunk_) {
4678 const size_t kMaxFreeLen = 2 * kPageSize;
4679 void* free_start = startOfNextMemoryChunk_;
4680 void* free_end = start;
4681 const size_t free_len =
4682 reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4683 if (!IsNative() || free_len < kMaxFreeLen) {
4684 AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4685 flush = false;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004686 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004687 }
4688 if (flush) {
4689 startOfNextMemoryChunk_ = nullptr;
4690 Flush();
4691 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004692 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004693 return true;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004694 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004695
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004696 void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004697 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004698 if (ProcessRecord(start, used_bytes)) {
4699 uint8_t state = ExamineNativeObject(start);
4700 AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4701 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4702 }
4703 }
4704
4705 void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004706 REQUIRES_SHARED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004707 if (ProcessRecord(start, used_bytes)) {
4708 // Determine the type of this chunk.
4709 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4710 // If it's the same, we should combine them.
4711 uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4712 AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4713 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4714 }
4715 }
4716
4717 void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004718 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004719 // Make sure there's enough room left in the buffer.
4720 // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4721 // 17 bytes for any header.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004722 const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4723 size_t byte_left = &buf_.back() - p_;
4724 if (byte_left < needed) {
4725 if (is_native) {
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004726 // Cannot trigger memory allocation while walking native heap.
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004727 return;
4728 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004729 Flush();
4730 }
4731
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004732 byte_left = &buf_.back() - p_;
4733 if (byte_left < needed) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004734 LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4735 << needed << " bytes)";
4736 return;
4737 }
4738 EnsureHeader(ptr);
Elliott Hughesa2155262011-11-16 16:26:58 -08004739 // Write out the chunk description.
Ian Rogers15bf2d32012-08-28 17:33:04 -07004740 length /= ALLOCATION_UNIT_SIZE; // Convert to allocation units.
4741 totalAllocationUnits_ += length;
4742 while (length > 256) {
Ian Rogers30fab402012-01-23 15:43:46 -08004743 *p_++ = state | HPSG_PARTIAL;
4744 *p_++ = 255; // length - 1
Ian Rogers15bf2d32012-08-28 17:33:04 -07004745 length -= 256;
Elliott Hughesa2155262011-11-16 16:26:58 -08004746 }
Ian Rogers30fab402012-01-23 15:43:46 -08004747 *p_++ = state;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004748 *p_++ = length - 1;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004749 }
4750
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004751 uint8_t ExamineNativeObject(const void* p) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004752 return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4753 }
4754
4755 uint8_t ExamineJavaObject(mirror::Object* o)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004756 REQUIRES_SHARED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004757 if (o == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004758 return HPSG_STATE(SOLIDITY_FREE, 0);
4759 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004760 // It's an allocated chunk. Figure out what it is.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004761 gc::Heap* heap = Runtime::Current()->GetHeap();
4762 if (!heap->IsLiveObjectLocked(o)) {
4763 LOG(ERROR) << "Invalid object in managed heap: " << o;
Elliott Hughesa2155262011-11-16 16:26:58 -08004764 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4765 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08004766 mirror::Class* c = o->GetClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07004767 if (c == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004768 // The object was probably just created but hasn't been initialized yet.
4769 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4770 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004771 if (!heap->IsValidObjectAddress(c)) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004772 LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
Elliott Hughesa2155262011-11-16 16:26:58 -08004773 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4774 }
Mathieu Chartierf26e1b32015-01-29 10:47:10 -08004775 if (c->GetClass() == nullptr) {
4776 LOG(ERROR) << "Null class of class " << c << " for object " << o;
4777 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4778 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004779 if (c->IsClassClass()) {
4780 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4781 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004782 if (c->IsArrayClass()) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004783 switch (c->GetComponentSize()) {
4784 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4785 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4786 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4787 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4788 }
4789 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004790 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4791 }
4792
Ian Rogers30fab402012-01-23 15:43:46 -08004793 std::vector<uint8_t> buf_;
4794 uint8_t* p_;
4795 uint8_t* pieceLenField_;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004796 void* startOfNextMemoryChunk_;
Ian Rogers30fab402012-01-23 15:43:46 -08004797 size_t totalAllocationUnits_;
4798 uint32_t type_;
Ian Rogers30fab402012-01-23 15:43:46 -08004799 bool needHeader_;
Mathieu Chartier36dab362014-07-30 14:59:56 -07004800 size_t chunk_overhead_;
Ian Rogers30fab402012-01-23 15:43:46 -08004801
Elliott Hughesa2155262011-11-16 16:26:58 -08004802 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4803};
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004804
Mathieu Chartier36dab362014-07-30 14:59:56 -07004805static void BumpPointerSpaceCallback(mirror::Object* obj, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004806 REQUIRES_SHARED(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
Mathieu Chartier36dab362014-07-30 14:59:56 -07004807 const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004808 HeapChunkContext::HeapChunkJavaCallback(
Mathieu Chartier36dab362014-07-30 14:59:56 -07004809 obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, arg);
4810}
4811
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004812void Dbg::DdmSendHeapSegments(bool native) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004813 Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4814 Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004815 if (when == HPSG_WHEN_NEVER) {
4816 return;
4817 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004818 // Figure out what kind of chunks we'll be sending.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004819 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4820 << static_cast<int>(what);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004821
4822 // First, send a heap start chunk.
4823 uint8_t heap_id[4];
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004824 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004825 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004826 Thread* self = Thread::Current();
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004827 Locks::mutator_lock_->AssertSharedHeld(self);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004828
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004829 // Send a series of heap segment chunks.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004830 HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
Elliott Hughesa2155262011-11-16 16:26:58 -08004831 if (native) {
Dimitry Ivanove6465bc2015-12-14 18:55:02 -08004832 UNIMPLEMENTED(WARNING) << "Native heap inspection is not supported";
Elliott Hughesa2155262011-11-16 16:26:58 -08004833 } else {
Ian Rogers1d54e732013-05-02 21:10:01 -07004834 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004835 for (const auto& space : heap->GetContinuousSpaces()) {
4836 if (space->IsDlMallocSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004837 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004838 // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4839 // allocation then the first sizeof(size_t) may belong to it.
4840 context.SetChunkOverhead(sizeof(size_t));
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004841 space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004842 } else if (space->IsRosAllocSpace()) {
4843 context.SetChunkOverhead(0);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004844 // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4845 // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004846 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07004847 ScopedSuspendAll ssa(__FUNCTION__);
4848 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4849 space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004850 } else if (space->IsBumpPointerSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004851 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004852 context.SetChunkOverhead(0);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004853 space->AsBumpPointerSpace()->Walk(BumpPointerSpaceCallback, &context);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004854 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004855 } else if (space->IsRegionSpace()) {
4856 heap->IncrementDisableMovingGC(self);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004857 {
4858 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07004859 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004860 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4861 context.SetChunkOverhead(0);
4862 space->AsRegionSpace()->Walk(BumpPointerSpaceCallback, &context);
4863 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004864 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004865 heap->DecrementDisableMovingGC(self);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004866 } else {
4867 UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004868 }
Mathieu Chartier36dab362014-07-30 14:59:56 -07004869 context.ResetStartOfNextChunk();
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004870 }
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004871 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartiere0f0cb32012-08-28 11:26:00 -07004872 // Walk the large objects, these are not in the AllocSpace.
Mathieu Chartier36dab362014-07-30 14:59:56 -07004873 context.SetChunkOverhead(0);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004874 heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Elliott Hughesa2155262011-11-16 16:26:58 -08004875 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004876
4877 // Finally, send a heap end chunk.
4878 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
Elliott Hughes767a1472011-10-26 18:49:02 -07004879}
4880
Brian Carlstrom306db812014-09-05 13:01:41 -07004881void Dbg::SetAllocTrackingEnabled(bool enable) {
Man Cao8c2ff642015-05-27 17:25:30 -07004882 gc::AllocRecordObjectMap::SetAllocTrackingEnabled(enable);
Elliott Hughes545a0642011-11-08 19:10:03 -08004883}
4884
4885void Dbg::DumpRecentAllocations() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004886 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom306db812014-09-05 13:01:41 -07004887 MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004888 if (!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled()) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004889 LOG(INFO) << "Not recording tracked allocations";
4890 return;
4891 }
Man Cao8c2ff642015-05-27 17:25:30 -07004892 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4893 CHECK(records != nullptr);
Elliott Hughes545a0642011-11-08 19:10:03 -08004894
Man Cao1ed11b92015-06-11 22:47:35 -07004895 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004896 uint16_t count = capped_count;
Elliott Hughes545a0642011-11-08 19:10:03 -08004897
Man Cao8c2ff642015-05-27 17:25:30 -07004898 LOG(INFO) << "Tracked allocations, (count=" << count << ")";
4899 for (auto it = records->RBegin(), end = records->REnd();
4900 count > 0 && it != end; count--, it++) {
Mathieu Chartier458b1052016-03-29 14:02:55 -07004901 const gc::AllocRecord* record = &it->second;
Elliott Hughes545a0642011-11-08 19:10:03 -08004902
Man Cao8c2ff642015-05-27 17:25:30 -07004903 LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->GetTid(), record->ByteCount())
David Sehr709b0702016-10-13 09:12:37 -07004904 << mirror::Class::PrettyClass(record->GetClass());
Elliott Hughes545a0642011-11-08 19:10:03 -08004905
Man Cao8c2ff642015-05-27 17:25:30 -07004906 for (size_t stack_frame = 0, depth = record->GetDepth(); stack_frame < depth; ++stack_frame) {
4907 const gc::AllocRecordStackTraceElement& stack_element = record->StackElement(stack_frame);
4908 ArtMethod* m = stack_element.GetMethod();
David Sehr709b0702016-10-13 09:12:37 -07004909 LOG(INFO) << " " << ArtMethod::PrettyMethod(m) << " line "
4910 << stack_element.ComputeLineNumber();
Elliott Hughes545a0642011-11-08 19:10:03 -08004911 }
4912
4913 // pause periodically to help logcat catch up
4914 if ((count % 5) == 0) {
4915 usleep(40000);
4916 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004917 }
4918}
4919
4920class StringTable {
4921 public:
4922 StringTable() {
4923 }
4924
Mathieu Chartier4345c462014-06-27 10:20:14 -07004925 void Add(const std::string& str) {
4926 table_.insert(str);
4927 }
4928
4929 void Add(const char* str) {
4930 table_.insert(str);
Elliott Hughes545a0642011-11-08 19:10:03 -08004931 }
4932
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004933 size_t IndexOf(const char* s) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004934 auto it = table_.find(s);
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004935 if (it == table_.end()) {
4936 LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
4937 }
4938 return std::distance(table_.begin(), it);
Elliott Hughes545a0642011-11-08 19:10:03 -08004939 }
4940
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004941 size_t Size() const {
Elliott Hughes545a0642011-11-08 19:10:03 -08004942 return table_.size();
4943 }
4944
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004945 void WriteTo(std::vector<uint8_t>& bytes) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004946 for (const std::string& str : table_) {
4947 const char* s = str.c_str();
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004948 size_t s_len = CountModifiedUtf8Chars(s);
Christopher Ferris8a354052015-04-24 17:23:53 -07004949 std::unique_ptr<uint16_t[]> s_utf16(new uint16_t[s_len]);
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004950 ConvertModifiedUtf8ToUtf16(s_utf16.get(), s);
4951 JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
Elliott Hughes545a0642011-11-08 19:10:03 -08004952 }
4953 }
4954
4955 private:
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004956 std::set<std::string> table_;
Elliott Hughes545a0642011-11-08 19:10:03 -08004957 DISALLOW_COPY_AND_ASSIGN(StringTable);
4958};
4959
Mathieu Chartiere401d142015-04-22 13:56:20 -07004960static const char* GetMethodSourceFile(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004961 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004962 DCHECK(method != nullptr);
4963 const char* source_file = method->GetDeclaringClassSourceFile();
Sebastien Hertz280286a2014-04-28 09:26:50 +02004964 return (source_file != nullptr) ? source_file : "";
4965}
4966
Elliott Hughes545a0642011-11-08 19:10:03 -08004967/*
4968 * The data we send to DDMS contains everything we have recorded.
4969 *
4970 * Message header (all values big-endian):
4971 * (1b) message header len (to allow future expansion); includes itself
4972 * (1b) entry header len
4973 * (1b) stack frame len
4974 * (2b) number of entries
4975 * (4b) offset to string table from start of message
4976 * (2b) number of class name strings
4977 * (2b) number of method name strings
4978 * (2b) number of source file name strings
4979 * For each entry:
4980 * (4b) total allocation size
Elliott Hughes221229c2013-01-08 18:17:50 -08004981 * (2b) thread id
Elliott Hughes545a0642011-11-08 19:10:03 -08004982 * (2b) allocated object's class name index
4983 * (1b) stack depth
4984 * For each stack frame:
4985 * (2b) method's class name
4986 * (2b) method name
4987 * (2b) method source file
4988 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
4989 * (xb) class name strings
4990 * (xb) method name strings
4991 * (xb) source file strings
4992 *
4993 * As with other DDM traffic, strings are sent as a 4-byte length
4994 * followed by UTF-16 data.
4995 *
4996 * We send up 16-bit unsigned indexes into string tables. In theory there
Brian Carlstrom306db812014-09-05 13:01:41 -07004997 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
Elliott Hughes545a0642011-11-08 19:10:03 -08004998 * each table, but in practice there should be far fewer.
4999 *
5000 * The chief reason for using a string table here is to keep the size of
5001 * the DDMS message to a minimum. This is partly to make the protocol
5002 * efficient, but also because we have to form the whole thing up all at
5003 * once in a memory buffer.
5004 *
5005 * We use separate string tables for class names, method names, and source
5006 * files to keep the indexes small. There will generally be no overlap
5007 * between the contents of these tables.
5008 */
5009jbyteArray Dbg::GetRecentAllocations() {
Ian Rogerscf7f1912014-10-22 22:06:39 -07005010 if ((false)) {
Elliott Hughes545a0642011-11-08 19:10:03 -08005011 DumpRecentAllocations();
5012 }
5013
Ian Rogers50b35e22012-10-04 10:09:15 -07005014 Thread* self = Thread::Current();
Elliott Hughes545a0642011-11-08 19:10:03 -08005015 std::vector<uint8_t> bytes;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005016 {
Brian Carlstrom306db812014-09-05 13:01:41 -07005017 MutexLock mu(self, *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07005018 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
5019 // In case this method is called when allocation tracker is disabled,
5020 // we should still send some data back.
5021 gc::AllocRecordObjectMap dummy;
5022 if (records == nullptr) {
5023 CHECK(!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled());
5024 records = &dummy;
5025 }
Man Cao41656de2015-07-06 18:53:15 -07005026 // We don't need to wait on the condition variable records->new_record_condition_, because this
5027 // function only reads the class objects, which are already marked so it doesn't change their
5028 // reachability.
Man Cao8c2ff642015-05-27 17:25:30 -07005029
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005030 //
5031 // Part 1: generate string tables.
5032 //
5033 StringTable class_names;
5034 StringTable method_names;
5035 StringTable filenames;
Elliott Hughes545a0642011-11-08 19:10:03 -08005036
Man Cao1ed11b92015-06-11 22:47:35 -07005037 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07005038 uint16_t count = capped_count;
Man Cao8c2ff642015-05-27 17:25:30 -07005039 for (auto it = records->RBegin(), end = records->REnd();
5040 count > 0 && it != end; count--, it++) {
Mathieu Chartier458b1052016-03-29 14:02:55 -07005041 const gc::AllocRecord* record = &it->second;
Ian Rogers1ff3c982014-08-12 02:30:58 -07005042 std::string temp;
Man Cao41656de2015-07-06 18:53:15 -07005043 class_names.Add(record->GetClassDescriptor(&temp));
Man Cao8c2ff642015-05-27 17:25:30 -07005044 for (size_t i = 0, depth = record->GetDepth(); i < depth; i++) {
5045 ArtMethod* m = record->StackElement(i).GetMethod();
5046 class_names.Add(m->GetDeclaringClassDescriptor());
5047 method_names.Add(m->GetName());
5048 filenames.Add(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005049 }
Elliott Hughes545a0642011-11-08 19:10:03 -08005050 }
5051
Man Cao8c2ff642015-05-27 17:25:30 -07005052 LOG(INFO) << "recent allocation records: " << capped_count;
5053 LOG(INFO) << "allocation records all objects: " << records->Size();
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005054
5055 //
5056 // Part 2: Generate the output and store it in the buffer.
5057 //
5058
5059 // (1b) message header len (to allow future expansion); includes itself
5060 // (1b) entry header len
5061 // (1b) stack frame len
5062 const int kMessageHeaderLen = 15;
5063 const int kEntryHeaderLen = 9;
5064 const int kStackFrameLen = 8;
5065 JDWP::Append1BE(bytes, kMessageHeaderLen);
5066 JDWP::Append1BE(bytes, kEntryHeaderLen);
5067 JDWP::Append1BE(bytes, kStackFrameLen);
5068
5069 // (2b) number of entries
5070 // (4b) offset to string table from start of message
5071 // (2b) number of class name strings
5072 // (2b) number of method name strings
5073 // (2b) number of source file name strings
Brian Carlstrom306db812014-09-05 13:01:41 -07005074 JDWP::Append2BE(bytes, capped_count);
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005075 size_t string_table_offset = bytes.size();
Brian Carlstrom7934ac22013-07-26 10:54:15 -07005076 JDWP::Append4BE(bytes, 0); // We'll patch this later...
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005077 JDWP::Append2BE(bytes, class_names.Size());
5078 JDWP::Append2BE(bytes, method_names.Size());
5079 JDWP::Append2BE(bytes, filenames.Size());
5080
Ian Rogers1ff3c982014-08-12 02:30:58 -07005081 std::string temp;
Man Cao8c2ff642015-05-27 17:25:30 -07005082 count = capped_count;
5083 // The last "count" number of allocation records in "records" are the most recent "count" number
5084 // of allocations. Reverse iterate to get them. The most recent allocation is sent first.
5085 for (auto it = records->RBegin(), end = records->REnd();
5086 count > 0 && it != end; count--, it++) {
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005087 // For each entry:
5088 // (4b) total allocation size
5089 // (2b) thread id
5090 // (2b) allocated object's class name index
5091 // (1b) stack depth
Mathieu Chartier458b1052016-03-29 14:02:55 -07005092 const gc::AllocRecord* record = &it->second;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005093 size_t stack_depth = record->GetDepth();
Mathieu Chartierf8322842014-05-16 10:59:25 -07005094 size_t allocated_object_class_name_index =
Man Cao41656de2015-07-06 18:53:15 -07005095 class_names.IndexOf(record->GetClassDescriptor(&temp));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07005096 JDWP::Append4BE(bytes, record->ByteCount());
Man Cao8c2ff642015-05-27 17:25:30 -07005097 JDWP::Append2BE(bytes, static_cast<uint16_t>(record->GetTid()));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005098 JDWP::Append2BE(bytes, allocated_object_class_name_index);
5099 JDWP::Append1BE(bytes, stack_depth);
5100
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005101 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
5102 // For each stack frame:
5103 // (2b) method's class name
5104 // (2b) method name
5105 // (2b) method source file
5106 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
Man Cao8c2ff642015-05-27 17:25:30 -07005107 ArtMethod* m = record->StackElement(stack_frame).GetMethod();
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07005108 size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
5109 size_t method_name_index = method_names.IndexOf(m->GetName());
5110 size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005111 JDWP::Append2BE(bytes, class_name_index);
5112 JDWP::Append2BE(bytes, method_name_index);
5113 JDWP::Append2BE(bytes, file_name_index);
Man Cao8c2ff642015-05-27 17:25:30 -07005114 JDWP::Append2BE(bytes, record->StackElement(stack_frame).ComputeLineNumber());
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005115 }
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005116 }
5117
5118 // (xb) class name strings
5119 // (xb) method name strings
5120 // (xb) source file strings
5121 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
5122 class_names.WriteTo(bytes);
5123 method_names.WriteTo(bytes);
5124 filenames.WriteTo(bytes);
Elliott Hughes545a0642011-11-08 19:10:03 -08005125 }
Ian Rogers50b35e22012-10-04 10:09:15 -07005126 JNIEnv* env = self->GetJniEnv();
Elliott Hughes545a0642011-11-08 19:10:03 -08005127 jbyteArray result = env->NewByteArray(bytes.size());
Ian Rogersc0542af2014-09-03 16:16:56 -07005128 if (result != nullptr) {
Elliott Hughes545a0642011-11-08 19:10:03 -08005129 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
5130 }
5131 return result;
5132}
5133
Mathieu Chartiere401d142015-04-22 13:56:20 -07005134ArtMethod* DeoptimizationRequest::Method() const {
Andreas Gampe13b27842016-11-07 16:48:23 -08005135 return jni::DecodeArtMethod(method_);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07005136}
5137
Mathieu Chartiere401d142015-04-22 13:56:20 -07005138void DeoptimizationRequest::SetMethod(ArtMethod* m) {
Andreas Gampe13b27842016-11-07 16:48:23 -08005139 method_ = jni::EncodeArtMethod(m);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07005140}
5141
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -07005142void Dbg::VisitRoots(RootVisitor* visitor) {
5143 // Visit breakpoint roots, used to prevent unloading of methods with breakpoints.
5144 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
5145 BufferedRootVisitor<128> root_visitor(visitor, RootInfo(kRootVMInternal));
5146 for (Breakpoint& breakpoint : gBreakpoints) {
Andreas Gampe542451c2016-07-26 09:02:02 -07005147 breakpoint.Method()->VisitRoots(root_visitor, kRuntimePointerSize);
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -07005148 }
5149}
5150
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00005151void Dbg::DbgThreadLifecycleCallback::ThreadStart(Thread* self) {
5152 Dbg::PostThreadStart(self);
5153}
5154
5155void Dbg::DbgThreadLifecycleCallback::ThreadDeath(Thread* self) {
5156 Dbg::PostThreadDeath(self);
5157}
5158
Andreas Gampe0f01b582017-01-18 15:22:37 -08005159void Dbg::DbgClassLoadCallback::ClassLoad(Handle<mirror::Class> klass ATTRIBUTE_UNUSED) {
5160 // Ignore ClassLoad;
5161}
5162void Dbg::DbgClassLoadCallback::ClassPrepare(Handle<mirror::Class> temp_klass ATTRIBUTE_UNUSED,
5163 Handle<mirror::Class> klass) {
5164 Dbg::PostClassPrepare(klass.Get());
5165}
5166
Elliott Hughes872d4ec2011-10-21 17:07:15 -07005167} // namespace art