blob: 0481c03d52dace7da07168b27f8ce946425d1830 [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
Alex Light8c2b9292017-11-09 13:21:01 -080021#include <functional>
Andreas Gampef774a4e2017-07-06 22:15:18 -070022#include <memory>
Elliott Hughes545a0642011-11-08 19:10:03 -080023#include <set>
Andreas Gampef774a4e2017-07-06 22:15:18 -070024#include <vector>
Elliott Hughes545a0642011-11-08 19:10:03 -080025
Andreas Gampe46ee31b2016-12-14 10:11:49 -080026#include "android-base/stringprintf.h"
27
Ian Rogers166db042013-07-26 12:05:57 -070028#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070029#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070030#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070031#include "base/enums.h"
David Sehr67bf42e2018-02-26 16:43:04 -080032#include "base/safe_map.h"
Andreas Gampef774a4e2017-07-06 22:15:18 -070033#include "base/strlcpy.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010034#include "base/time_utils.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080035#include "class_linker-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070036#include "class_linker.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080037#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080038#include "dex/dex_file-inl.h"
39#include "dex/dex_file_annotations.h"
40#include "dex/dex_file_types.h"
41#include "dex/dex_instruction.h"
David Sehr0225f8e2018-01-31 08:52:24 +000042#include "dex/utf.h"
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -080043#include "entrypoints/runtime_asm_entrypoints.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070044#include "gc/accounting/card_table-inl.h"
Man Cao8c2ff642015-05-27 17:25:30 -070045#include "gc/allocation_record.h"
Andreas Gampe94c589d2017-12-27 12:43:01 -080046#include "gc/gc_cause.h"
Mathieu Chartieraa516822015-10-02 15:53:37 -070047#include "gc/scoped_gc_critical_section.h"
Andreas Gampe0c183382017-07-13 22:26:24 -070048#include "gc/space/bump_pointer_space-walk-inl.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070049#include "gc/space/large_object_space.h"
50#include "gc/space/space-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070051#include "handle_scope-inl.h"
Sebastien Hertzcbc50642015-06-01 17:33:12 +020052#include "jdwp/jdwp_priv.h"
Elliott Hughes64f574f2013-02-20 14:57:12 -080053#include "jdwp/object_registry.h"
Andreas Gampe13b27842016-11-07 16:48:23 -080054#include "jni_internal.h"
Mathieu Chartier28bd2e42016-10-04 13:54:57 -070055#include "jvalue-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080056#include "mirror/class-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070057#include "mirror/class.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080058#include "mirror/class_loader.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080059#include "mirror/object-inl.h"
60#include "mirror/object_array-inl.h"
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070061#include "mirror/string-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080062#include "mirror/throwable.h"
Andreas Gampe373a9b52017-10-18 09:01:57 -070063#include "nativehelper/scoped_local_ref.h"
64#include "nativehelper/scoped_primitive_array.h"
Nicolas Geoffray58cc1cb2017-11-20 13:27:29 +000065#include "oat_file.h"
Mathieu Chartier3398c782016-09-30 10:27:43 -070066#include "obj_ptr-inl.h"
Ian Rogers53b8b092014-03-13 23:45:53 -070067#include "reflection.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070068#include "scoped_thread_state_change-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070069#include "stack.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070070#include "thread_list.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070071#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070072
Elliott Hughes872d4ec2011-10-21 17:07:15 -070073namespace art {
74
Andreas Gampe46ee31b2016-12-14 10:11:49 -080075using android::base::StringPrintf;
76
Sebastien Hertz0462c4c2015-04-01 16:34:17 +020077// The key identifying the debugger to update instrumentation.
78static constexpr const char* kDbgInstrumentationKey = "Debugger";
79
Man Cao8c2ff642015-05-27 17:25:30 -070080// 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 -070081static uint16_t CappedAllocRecordCount(size_t alloc_record_count) {
Man Cao1ed11b92015-06-11 22:47:35 -070082 const size_t cap = 0xffff;
Man Cao8c2ff642015-05-27 17:25:30 -070083 if (alloc_record_count > cap) {
84 return cap;
Brian Carlstrom306db812014-09-05 13:01:41 -070085 }
86 return alloc_record_count;
87}
Elliott Hughes475fc232011-10-25 15:00:35 -070088
Mathieu Chartier41af5e52015-10-28 11:10:46 -070089class Breakpoint : public ValueObject {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070090 public:
Mathieu Chartier41af5e52015-10-28 11:10:46 -070091 Breakpoint(ArtMethod* method, uint32_t dex_pc, DeoptimizationRequest::Kind deoptimization_kind)
Alex Light97e78032017-06-27 17:51:55 -070092 : method_(method->GetCanonicalMethod(kRuntimePointerSize)),
Mathieu Chartier41af5e52015-10-28 11:10:46 -070093 dex_pc_(dex_pc),
94 deoptimization_kind_(deoptimization_kind) {
Sebastien Hertzf3928792014-11-17 19:00:37 +010095 CHECK(deoptimization_kind_ == DeoptimizationRequest::kNothing ||
96 deoptimization_kind_ == DeoptimizationRequest::kSelectiveDeoptimization ||
97 deoptimization_kind_ == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070098 }
99
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700100 Breakpoint(const Breakpoint& other) REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700101 : method_(other.method_),
102 dex_pc_(other.dex_pc_),
103 deoptimization_kind_(other.deoptimization_kind_) {}
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700104
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700105 // Method() is called from root visiting, do not use ScopedObjectAccess here or it can cause
106 // GC to deadlock if another thread tries to call SuspendAll while the GC is in a runnable state.
107 ArtMethod* Method() const {
108 return method_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700109 }
110
111 uint32_t DexPc() const {
112 return dex_pc_;
113 }
114
Sebastien Hertzf3928792014-11-17 19:00:37 +0100115 DeoptimizationRequest::Kind GetDeoptimizationKind() const {
116 return deoptimization_kind_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700117 }
118
Alex Light6c8467f2015-11-20 15:03:26 -0800119 // Returns true if the method of this breakpoint and the passed in method should be considered the
120 // same. That is, they are either the same method or they are copied from the same method.
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700121 bool IsInMethod(ArtMethod* m) const REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light97e78032017-06-27 17:51:55 -0700122 return method_ == m->GetCanonicalMethod(kRuntimePointerSize);
Alex Light6c8467f2015-11-20 15:03:26 -0800123 }
124
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700125 private:
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100126 // The location of this breakpoint.
Mathieu Chartier41af5e52015-10-28 11:10:46 -0700127 ArtMethod* method_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700128 uint32_t dex_pc_;
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100129
130 // Indicates whether breakpoint needs full deoptimization or selective deoptimization.
Sebastien Hertzf3928792014-11-17 19:00:37 +0100131 DeoptimizationRequest::Kind deoptimization_kind_;
Elliott Hughes86964332012-02-15 19:37:42 -0800132};
133
Sebastien Hertzed2be172014-08-19 15:33:43 +0200134static std::ostream& operator<<(std::ostream& os, const Breakpoint& rhs)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700135 REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr709b0702016-10-13 09:12:37 -0700136 os << StringPrintf("Breakpoint[%s @%#x]", ArtMethod::PrettyMethod(rhs.Method()).c_str(),
137 rhs.DexPc());
Elliott Hughes86964332012-02-15 19:37:42 -0800138 return os;
139}
140
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200141class DebugInstrumentationListener FINAL : public instrumentation::InstrumentationListener {
Ian Rogers62d6c772013-02-27 08:32:07 -0800142 public:
143 DebugInstrumentationListener() {}
144 virtual ~DebugInstrumentationListener() {}
145
Alex Lightd7661582017-05-01 13:48:16 -0700146 void MethodEntered(Thread* thread,
147 Handle<mirror::Object> this_object,
148 ArtMethod* method,
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200149 uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700150 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800151 if (method->IsNative()) {
152 // TODO: post location events is a suspension point and native method entry stubs aren't.
153 return;
154 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200155 if (IsListeningToDexPcMoved()) {
156 // We also listen to kDexPcMoved instrumentation event so we know the DexPcMoved method is
157 // going to be called right after us. To avoid sending JDWP events twice for this location,
158 // we report the event in DexPcMoved. However, we must remind this is method entry so we
159 // send the METHOD_ENTRY event. And we can also group it with other events for this location
160 // like BREAKPOINT or SINGLE_STEP (or even METHOD_EXIT if this is a RETURN instruction).
161 thread->SetDebugMethodEntry();
162 } else if (IsListeningToMethodExit() && IsReturn(method, dex_pc)) {
163 // We also listen to kMethodExited instrumentation event and the current instruction is a
164 // RETURN so we know the MethodExited method is going to be called right after us. To avoid
165 // sending JDWP events twice for this location, we report the event(s) in MethodExited.
166 // However, we must remind this is method entry so we send the METHOD_ENTRY event. And we can
167 // also group it with other events for this location like BREAKPOINT or SINGLE_STEP.
168 thread->SetDebugMethodEntry();
169 } else {
Alex Lightd7661582017-05-01 13:48:16 -0700170 Dbg::UpdateDebugger(thread, this_object.Get(), method, 0, Dbg::kMethodEntry, nullptr);
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200171 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800172 }
173
Alex Lightd7661582017-05-01 13:48:16 -0700174 void MethodExited(Thread* thread,
175 Handle<mirror::Object> this_object,
176 ArtMethod* method,
177 uint32_t dex_pc,
178 const JValue& return_value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700179 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800180 if (method->IsNative()) {
181 // TODO: post location events is a suspension point and native method entry stubs aren't.
182 return;
183 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200184 uint32_t events = Dbg::kMethodExit;
185 if (thread->IsDebugMethodEntry()) {
186 // It is also the method entry.
187 DCHECK(IsReturn(method, dex_pc));
188 events |= Dbg::kMethodEntry;
189 thread->ClearDebugMethodEntry();
190 }
Alex Lightd7661582017-05-01 13:48:16 -0700191 Dbg::UpdateDebugger(thread, this_object.Get(), method, dex_pc, events, &return_value);
Ian Rogers62d6c772013-02-27 08:32:07 -0800192 }
193
Alex Lightd7661582017-05-01 13:48:16 -0700194 void MethodUnwind(Thread* thread ATTRIBUTE_UNUSED,
195 Handle<mirror::Object> this_object ATTRIBUTE_UNUSED,
196 ArtMethod* method,
197 uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700198 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800199 // We're not recorded to listen to this kind of event, so complain.
David Sehr709b0702016-10-13 09:12:37 -0700200 LOG(ERROR) << "Unexpected method unwind event in debugger " << ArtMethod::PrettyMethod(method)
Sebastien Hertz51db44a2013-11-19 10:00:29 +0100201 << " " << dex_pc;
Ian Rogers62d6c772013-02-27 08:32:07 -0800202 }
203
Alex Lightd7661582017-05-01 13:48:16 -0700204 void DexPcMoved(Thread* thread,
205 Handle<mirror::Object> this_object,
206 ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200207 uint32_t new_dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700208 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200209 if (IsListeningToMethodExit() && IsReturn(method, new_dex_pc)) {
210 // We also listen to kMethodExited instrumentation event and the current instruction is a
211 // RETURN so we know the MethodExited method is going to be called right after us. Like in
212 // MethodEntered, we delegate event reporting to MethodExited.
213 // Besides, if this RETURN instruction is the only one in the method, we can send multiple
214 // JDWP events in the same packet: METHOD_ENTRY, METHOD_EXIT, BREAKPOINT and/or SINGLE_STEP.
215 // Therefore, we must not clear the debug method entry flag here.
216 } else {
217 uint32_t events = 0;
218 if (thread->IsDebugMethodEntry()) {
219 // It is also the method entry.
220 events = Dbg::kMethodEntry;
221 thread->ClearDebugMethodEntry();
222 }
Alex Lightd7661582017-05-01 13:48:16 -0700223 Dbg::UpdateDebugger(thread, this_object.Get(), method, new_dex_pc, events, nullptr);
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200224 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800225 }
226
Alex Lightd7661582017-05-01 13:48:16 -0700227 void FieldRead(Thread* thread ATTRIBUTE_UNUSED,
228 Handle<mirror::Object> this_object,
229 ArtMethod* method,
230 uint32_t dex_pc,
231 ArtField* field)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700232 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Lightd7661582017-05-01 13:48:16 -0700233 Dbg::PostFieldAccessEvent(method, dex_pc, this_object.Get(), field);
Ian Rogers62d6c772013-02-27 08:32:07 -0800234 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200235
Alex Lightd7661582017-05-01 13:48:16 -0700236 void FieldWritten(Thread* thread ATTRIBUTE_UNUSED,
237 Handle<mirror::Object> this_object,
238 ArtMethod* method,
239 uint32_t dex_pc,
240 ArtField* field,
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700241 const JValue& field_value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700242 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Lightd7661582017-05-01 13:48:16 -0700243 Dbg::PostFieldModificationEvent(method, dex_pc, this_object.Get(), field, &field_value);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200244 }
245
Alex Light6e1607e2017-08-23 10:06:18 -0700246 void ExceptionThrown(Thread* thread ATTRIBUTE_UNUSED,
Alex Lightd7661582017-05-01 13:48:16 -0700247 Handle<mirror::Throwable> exception_object)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700248 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Lightd7661582017-05-01 13:48:16 -0700249 Dbg::PostException(exception_object.Get());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200250 }
251
Nicolas Geoffray81f0f952016-01-20 16:25:19 +0000252 // We only care about branches in the Jit.
253 void Branch(Thread* /*thread*/, ArtMethod* method, uint32_t dex_pc, int32_t dex_pc_offset)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700254 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr709b0702016-10-13 09:12:37 -0700255 LOG(ERROR) << "Unexpected branch event in debugger " << ArtMethod::PrettyMethod(method)
Nicolas Geoffray81f0f952016-01-20 16:25:19 +0000256 << " " << dex_pc << ", " << dex_pc_offset;
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800257 }
258
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100259 // We only care about invokes in the Jit.
260 void InvokeVirtualOrInterface(Thread* thread ATTRIBUTE_UNUSED,
Alex Lightd7661582017-05-01 13:48:16 -0700261 Handle<mirror::Object> this_object ATTRIBUTE_UNUSED,
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100262 ArtMethod* method,
263 uint32_t dex_pc,
Alex Lightd7661582017-05-01 13:48:16 -0700264 ArtMethod* target ATTRIBUTE_UNUSED)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700265 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr709b0702016-10-13 09:12:37 -0700266 LOG(ERROR) << "Unexpected invoke event in debugger " << ArtMethod::PrettyMethod(method)
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100267 << " " << dex_pc;
268 }
269
Alex Light798eab02017-08-23 12:54:53 -0700270 // TODO Might be worth it to post ExceptionCatch event.
271 void ExceptionHandled(Thread* thread ATTRIBUTE_UNUSED,
272 Handle<mirror::Throwable> throwable ATTRIBUTE_UNUSED) OVERRIDE {
273 LOG(ERROR) << "Unexpected exception handled event in debugger";
274 }
275
Alex Light05f47742017-09-14 00:34:44 +0000276 // TODO Might be worth it to implement this.
277 void WatchedFramePop(Thread* thread ATTRIBUTE_UNUSED,
278 const ShadowFrame& frame ATTRIBUTE_UNUSED) OVERRIDE {
279 LOG(ERROR) << "Unexpected WatchedFramePop event in debugger";
280 }
Alex Light798eab02017-08-23 12:54:53 -0700281
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200282 private:
Mathieu Chartier808c7a52017-12-15 11:19:33 -0800283 static bool IsReturn(ArtMethod* method, uint32_t dex_pc) REQUIRES_SHARED(Locks::mutator_lock_) {
284 return method->DexInstructions().InstructionAt(dex_pc).IsReturn();
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200285 }
286
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700287 static bool IsListeningToDexPcMoved() REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200288 return IsListeningTo(instrumentation::Instrumentation::kDexPcMoved);
289 }
290
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700291 static bool IsListeningToMethodExit() REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200292 return IsListeningTo(instrumentation::Instrumentation::kMethodExited);
293 }
294
295 static bool IsListeningTo(instrumentation::Instrumentation::InstrumentationEvent event)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700296 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200297 return (Dbg::GetInstrumentationEvents() & event) != 0;
298 }
299
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200300 DISALLOW_COPY_AND_ASSIGN(DebugInstrumentationListener);
Ian Rogers62d6c772013-02-27 08:32:07 -0800301} gDebugInstrumentationListener;
302
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700303// JDWP is allowed unless the Zygote forbids it.
304static bool gJdwpAllowed = true;
305
Elliott Hughesc0f09332012-03-26 13:27:06 -0700306// Was there a -Xrunjdwp or -agentlib:jdwp= argument on the command line?
Elliott Hughes3bb81562011-10-21 18:52:59 -0700307static bool gJdwpConfigured = false;
308
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100309// JDWP options for debugging. Only valid if IsJdwpConfigured() is true.
310static JDWP::JdwpOptions gJdwpOptions;
311
Elliott Hughes3bb81562011-10-21 18:52:59 -0700312// Runtime JDWP state.
Ian Rogersc0542af2014-09-03 16:16:56 -0700313static JDWP::JdwpState* gJdwpState = nullptr;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700314static bool gDebuggerConnected; // debugger or DDMS is connected.
Elliott Hughes3bb81562011-10-21 18:52:59 -0700315
Elliott Hughes47fce012011-10-25 18:37:19 -0700316static bool gDdmThreadNotification = false;
317
Elliott Hughes767a1472011-10-26 18:49:02 -0700318// DDMS GC-related settings.
319static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
320static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
321static Dbg::HpsgWhat gDdmHpsgWhat;
322static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
323static Dbg::HpsgWhat gDdmNhsgWhat;
324
Daniel Mihalyieb076692014-08-22 17:33:31 +0200325bool Dbg::gDebuggerActive = false;
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100326bool Dbg::gDisposed = false;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200327ObjectRegistry* Dbg::gRegistry = nullptr;
Alex Light21611932017-09-26 13:07:39 -0700328DebuggerActiveMethodInspectionCallback Dbg::gDebugActiveCallback;
Alex Light8c2b9292017-11-09 13:21:01 -0800329DebuggerDdmCallback Dbg::gDebugDdmCallback;
Alex Light40320712017-12-14 11:52:04 -0800330InternalDebuggerControlCallback Dbg::gDebuggerControlCallback;
Elliott Hughes475fc232011-10-25 15:00:35 -0700331
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100332// Deoptimization support.
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100333std::vector<DeoptimizationRequest> Dbg::deoptimization_requests_;
334size_t Dbg::full_deoptimization_event_count_ = 0;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100335
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200336// Instrumentation event reference counters.
337size_t Dbg::dex_pc_change_event_ref_count_ = 0;
338size_t Dbg::method_enter_event_ref_count_ = 0;
339size_t Dbg::method_exit_event_ref_count_ = 0;
340size_t Dbg::field_read_event_ref_count_ = 0;
341size_t Dbg::field_write_event_ref_count_ = 0;
342size_t Dbg::exception_catch_event_ref_count_ = 0;
343uint32_t Dbg::instrumentation_events_ = 0;
344
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000345Dbg::DbgThreadLifecycleCallback Dbg::thread_lifecycle_callback_;
Andreas Gampe0f01b582017-01-18 15:22:37 -0800346Dbg::DbgClassLoadCallback Dbg::class_load_callback_;
Andreas Gampe04bbb5b2017-01-19 17:49:03 +0000347
Alex Light8c2b9292017-11-09 13:21:01 -0800348void DebuggerDdmCallback::DdmPublishChunk(uint32_t type, const ArrayRef<const uint8_t>& data) {
Alex Light772099a2017-11-21 14:05:04 -0800349 if (gJdwpState == nullptr) {
350 VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
351 } else {
352 iovec vec[1];
353 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(data.data()));
354 vec[0].iov_len = data.size();
355 gJdwpState->DdmSendChunkV(type, vec, 1);
356 }
Alex Light8c2b9292017-11-09 13:21:01 -0800357}
358
Alex Light21611932017-09-26 13:07:39 -0700359bool DebuggerActiveMethodInspectionCallback::IsMethodBeingInspected(ArtMethod* m ATTRIBUTE_UNUSED) {
360 return Dbg::IsDebuggerActive();
361}
362
Alex Light0fa17862017-10-24 13:43:05 -0700363bool DebuggerActiveMethodInspectionCallback::IsMethodSafeToJit(ArtMethod* m) {
364 return !Dbg::MethodHasAnyBreakpoints(m);
365}
366
Alex Lightd698ef52018-04-02 11:28:50 -0700367bool DebuggerActiveMethodInspectionCallback::MethodNeedsDebugVersion(
368 ArtMethod* m ATTRIBUTE_UNUSED) {
369 return Dbg::IsDebuggerActive();
370}
371
Alex Light40320712017-12-14 11:52:04 -0800372void InternalDebuggerControlCallback::StartDebugger() {
373 // Release the mutator lock.
374 ScopedThreadStateChange stsc(art::Thread::Current(), kNative);
375 Dbg::StartJdwp();
376}
377
378void InternalDebuggerControlCallback::StopDebugger() {
379 Dbg::StopJdwp();
380}
381
382bool InternalDebuggerControlCallback::IsDebuggerConfigured() {
383 return Dbg::IsJdwpConfigured();
384}
385
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100386// Breakpoints.
jeffhao09bfc6a2012-12-11 18:11:43 -0800387static std::vector<Breakpoint> gBreakpoints GUARDED_BY(Locks::breakpoint_lock_);
Elliott Hughes86964332012-02-15 19:37:42 -0800388
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -0700389void DebugInvokeReq::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
390 receiver.VisitRootIfNonNull(visitor, root_info); // null for static method call.
391 klass.VisitRoot(visitor, root_info);
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -0700392}
393
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100394void SingleStepControl::AddDexPc(uint32_t dex_pc) {
395 dex_pcs_.insert(dex_pc);
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200396}
397
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100398bool SingleStepControl::ContainsDexPc(uint32_t dex_pc) const {
399 return dex_pcs_.find(dex_pc) == dex_pcs_.end();
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200400}
401
Alex Light6c8467f2015-11-20 15:03:26 -0800402static bool IsBreakpoint(ArtMethod* m, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700403 REQUIRES(!Locks::breakpoint_lock_)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700404 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzed2be172014-08-19 15:33:43 +0200405 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100406 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Alex Light6c8467f2015-11-20 15:03:26 -0800407 if (gBreakpoints[i].DexPc() == dex_pc && gBreakpoints[i].IsInMethod(m)) {
Elliott Hughes86964332012-02-15 19:37:42 -0800408 VLOG(jdwp) << "Hit breakpoint #" << i << ": " << gBreakpoints[i];
409 return true;
410 }
411 }
412 return false;
413}
414
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100415static bool IsSuspendedForDebugger(ScopedObjectAccessUnchecked& soa, Thread* thread)
Mathieu Chartier90443472015-07-16 20:32:27 -0700416 REQUIRES(!Locks::thread_suspend_count_lock_) {
Elliott Hughes9e0c1752013-01-09 14:02:58 -0800417 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
418 // A thread may be suspended for GC; in this code, we really want to know whether
419 // there's a debugger suspension active.
420 return thread->IsSuspended() && thread->GetDebugSuspendCount() > 0;
421}
422
Ian Rogersc0542af2014-09-03 16:16:56 -0700423static mirror::Array* DecodeNonNullArray(JDWP::RefTypeId id, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700424 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200425 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700426 if (o == nullptr) {
427 *error = JDWP::ERR_INVALID_OBJECT;
428 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800429 }
430 if (!o->IsArrayInstance()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700431 *error = JDWP::ERR_INVALID_ARRAY;
432 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800433 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700434 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800435 return o->AsArray();
436}
437
Ian Rogersc0542af2014-09-03 16:16:56 -0700438static mirror::Class* DecodeClass(JDWP::RefTypeId id, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700439 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200440 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700441 if (o == nullptr) {
442 *error = JDWP::ERR_INVALID_OBJECT;
443 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800444 }
445 if (!o->IsClass()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700446 *error = JDWP::ERR_INVALID_CLASS;
447 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800448 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700449 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800450 return o->AsClass();
451}
452
Ian Rogersc0542af2014-09-03 16:16:56 -0700453static Thread* DecodeThread(ScopedObjectAccessUnchecked& soa, JDWP::ObjectId thread_id,
454 JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700455 REQUIRES_SHARED(Locks::mutator_lock_)
Mathieu Chartier90443472015-07-16 20:32:27 -0700456 REQUIRES(!Locks::thread_list_lock_, !Locks::thread_suspend_count_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200457 mirror::Object* thread_peer = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700458 if (thread_peer == nullptr) {
Elliott Hughes221229c2013-01-08 18:17:50 -0800459 // This isn't even an object.
Ian Rogersc0542af2014-09-03 16:16:56 -0700460 *error = JDWP::ERR_INVALID_OBJECT;
461 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800462 }
Elliott Hughes221229c2013-01-08 18:17:50 -0800463
Mathieu Chartier0795f232016-09-27 18:43:30 -0700464 ObjPtr<mirror::Class> java_lang_Thread =
465 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_Thread);
Elliott Hughes221229c2013-01-08 18:17:50 -0800466 if (!java_lang_Thread->IsAssignableFrom(thread_peer->GetClass())) {
467 // This isn't a thread.
Ian Rogersc0542af2014-09-03 16:16:56 -0700468 *error = JDWP::ERR_INVALID_THREAD;
469 return nullptr;
Elliott Hughes221229c2013-01-08 18:17:50 -0800470 }
471
Sebastien Hertz69206392015-04-07 15:54:25 +0200472 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
Ian Rogersc0542af2014-09-03 16:16:56 -0700473 Thread* thread = Thread::FromManagedThread(soa, thread_peer);
474 // If thread is null then this a java.lang.Thread without a Thread*. Must be a un-started or a
475 // zombie.
476 *error = (thread == nullptr) ? JDWP::ERR_THREAD_NOT_ALIVE : JDWP::ERR_NONE;
477 return thread;
Elliott Hughes436e3722012-02-17 20:01:47 -0800478}
479
Elliott Hughes24437992011-11-30 14:49:33 -0800480static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
481 // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
482 // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
483 return static_cast<JDWP::JdwpTag>(descriptor[0]);
484}
485
Ian Rogers1ff3c982014-08-12 02:30:58 -0700486static JDWP::JdwpTag BasicTagFromClass(mirror::Class* klass)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700487 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers1ff3c982014-08-12 02:30:58 -0700488 std::string temp;
489 const char* descriptor = klass->GetDescriptor(&temp);
490 return BasicTagFromDescriptor(descriptor);
491}
492
Ian Rogers98379392014-02-24 16:53:16 -0800493static JDWP::JdwpTag TagFromClass(const ScopedObjectAccessUnchecked& soa, mirror::Class* c)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700494 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700495 CHECK(c != nullptr);
Elliott Hughes24437992011-11-30 14:49:33 -0800496 if (c->IsArrayClass()) {
497 return JDWP::JT_ARRAY;
498 }
Elliott Hughes24437992011-11-30 14:49:33 -0800499 if (c->IsStringClass()) {
500 return JDWP::JT_STRING;
Elliott Hughes24437992011-11-30 14:49:33 -0800501 }
Ian Rogers98379392014-02-24 16:53:16 -0800502 if (c->IsClassClass()) {
503 return JDWP::JT_CLASS_OBJECT;
504 }
505 {
Mathieu Chartier0795f232016-09-27 18:43:30 -0700506 ObjPtr<mirror::Class> thread_class =
507 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_Thread);
Ian Rogers98379392014-02-24 16:53:16 -0800508 if (thread_class->IsAssignableFrom(c)) {
509 return JDWP::JT_THREAD;
510 }
511 }
512 {
Mathieu Chartier0795f232016-09-27 18:43:30 -0700513 ObjPtr<mirror::Class> thread_group_class =
514 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_ThreadGroup);
Ian Rogers98379392014-02-24 16:53:16 -0800515 if (thread_group_class->IsAssignableFrom(c)) {
516 return JDWP::JT_THREAD_GROUP;
517 }
518 }
519 {
Mathieu Chartier0795f232016-09-27 18:43:30 -0700520 ObjPtr<mirror::Class> class_loader_class =
521 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_ClassLoader);
Ian Rogers98379392014-02-24 16:53:16 -0800522 if (class_loader_class->IsAssignableFrom(c)) {
523 return JDWP::JT_CLASS_LOADER;
524 }
525 }
526 return JDWP::JT_OBJECT;
Elliott Hughes24437992011-11-30 14:49:33 -0800527}
528
529/*
530 * Objects declared to hold Object might actually hold a more specific
531 * type. The debugger may take a special interest in these (e.g. it
532 * wants to display the contents of Strings), so we want to return an
533 * appropriate tag.
534 *
535 * Null objects are tagged JT_OBJECT.
536 */
Sebastien Hertz6995c602014-09-09 12:10:13 +0200537JDWP::JdwpTag Dbg::TagFromObject(const ScopedObjectAccessUnchecked& soa, mirror::Object* o) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700538 return (o == nullptr) ? JDWP::JT_OBJECT : TagFromClass(soa, o->GetClass());
Elliott Hughes24437992011-11-30 14:49:33 -0800539}
540
541static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
542 switch (tag) {
543 case JDWP::JT_BOOLEAN:
544 case JDWP::JT_BYTE:
545 case JDWP::JT_CHAR:
546 case JDWP::JT_FLOAT:
547 case JDWP::JT_DOUBLE:
548 case JDWP::JT_INT:
549 case JDWP::JT_LONG:
550 case JDWP::JT_SHORT:
551 case JDWP::JT_VOID:
552 return true;
553 default:
554 return false;
555 }
556}
557
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100558void Dbg::StartJdwp() {
Elliott Hughesc0f09332012-03-26 13:27:06 -0700559 if (!gJdwpAllowed || !IsJdwpConfigured()) {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700560 // No JDWP for you!
561 return;
562 }
563
Ian Rogers719d1a32014-03-06 12:13:39 -0800564 CHECK(gRegistry == nullptr);
Elliott Hughes475fc232011-10-25 15:00:35 -0700565 gRegistry = new ObjectRegistry;
566
Alex Light8c2b9292017-11-09 13:21:01 -0800567 {
568 // Setup the Ddm listener
569 ScopedObjectAccess soa(Thread::Current());
570 Runtime::Current()->GetRuntimeCallbacks()->AddDdmCallback(&gDebugDdmCallback);
571 }
572
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700573 // Init JDWP if the debugger is enabled. This may connect out to a
574 // debugger, passively listen for a debugger, or block waiting for a
575 // debugger.
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100576 gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
Ian Rogersc0542af2014-09-03 16:16:56 -0700577 if (gJdwpState == nullptr) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -0800578 // We probably failed because some other process has the port already, which means that
579 // if we don't abort the user is likely to think they're talking to us when they're actually
580 // talking to that other process.
Elliott Hughes3d30d9b2011-12-07 17:35:48 -0800581 LOG(FATAL) << "Debugger thread failed to initialize";
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700582 }
583
584 // If a debugger has already attached, send the "welcome" message.
585 // This may cause us to suspend all threads.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700586 if (gJdwpState->IsActive()) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700587 ScopedObjectAccess soa(Thread::Current());
Sebastien Hertz7d955652014-10-22 10:57:10 +0200588 gJdwpState->PostVMStart();
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700589 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700590}
591
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700592void Dbg::StopJdwp() {
Sebastien Hertzc6345ef2014-08-18 19:26:39 +0200593 // Post VM_DEATH event before the JDWP connection is closed (either by the JDWP thread or the
594 // destruction of gJdwpState).
595 if (gJdwpState != nullptr && gJdwpState->IsActive()) {
596 gJdwpState->PostVMDeath();
597 }
Sebastien Hertz0376e6b2014-02-06 18:12:59 +0100598 // Prevent the JDWP thread from processing JDWP incoming packets after we close the connection.
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100599 Dispose();
Elliott Hughes376a7a02011-10-24 18:35:55 -0700600 delete gJdwpState;
Ian Rogers719d1a32014-03-06 12:13:39 -0800601 gJdwpState = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700602 delete gRegistry;
Ian Rogers719d1a32014-03-06 12:13:39 -0800603 gRegistry = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700604}
605
Elliott Hughes767a1472011-10-26 18:49:02 -0700606void Dbg::GcDidFinish() {
607 if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700608 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700609 VLOG(jdwp) << "Sending heap info to DDM";
Elliott Hughes7162ad92011-10-27 14:08:42 -0700610 DdmSendHeapInfo(gDdmHpifWhen);
Elliott Hughes767a1472011-10-26 18:49:02 -0700611 }
612 if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700613 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700614 VLOG(jdwp) << "Dumping heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700615 DdmSendHeapSegments(false);
Elliott Hughes767a1472011-10-26 18:49:02 -0700616 }
617 if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700618 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700619 VLOG(jdwp) << "Dumping native heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700620 DdmSendHeapSegments(true);
Elliott Hughes767a1472011-10-26 18:49:02 -0700621 }
622}
623
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700624void Dbg::SetJdwpAllowed(bool allowed) {
625 gJdwpAllowed = allowed;
626}
627
Leonard Mosescueb842212016-10-06 17:26:36 -0700628bool Dbg::IsJdwpAllowed() {
629 return gJdwpAllowed;
630}
631
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700632DebugInvokeReq* Dbg::GetInvokeReq() {
Elliott Hughes475fc232011-10-25 15:00:35 -0700633 return Thread::Current()->GetInvokeReq();
634}
635
636Thread* Dbg::GetDebugThread() {
Ian Rogersc0542af2014-09-03 16:16:56 -0700637 return (gJdwpState != nullptr) ? gJdwpState->GetDebugThread() : nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700638}
639
640void Dbg::ClearWaitForEventThread() {
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100641 gJdwpState->ReleaseJdwpTokenForEvent();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700642}
643
644void Dbg::Connected() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700645 CHECK(!gDebuggerConnected);
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -0800646 VLOG(jdwp) << "JDWP has attached";
Elliott Hughes3bb81562011-10-21 18:52:59 -0700647 gDebuggerConnected = true;
Elliott Hughes86964332012-02-15 19:37:42 -0800648 gDisposed = false;
649}
650
Sebastien Hertzf3928792014-11-17 19:00:37 +0100651bool Dbg::RequiresDeoptimization() {
652 // We don't need deoptimization if everything runs with interpreter after
653 // enabling -Xint mode.
654 return !Runtime::Current()->GetInstrumentation()->IsForcedInterpretOnly();
655}
656
Elliott Hughesa2155262011-11-16 16:26:58 -0800657void Dbg::GoActive() {
658 // Enable all debugging features, including scans for breakpoints.
659 // This is a no-op if we're already active.
660 // Only called from the JDWP handler thread.
Daniel Mihalyieb076692014-08-22 17:33:31 +0200661 if (IsDebuggerActive()) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800662 return;
663 }
664
Mathieu Chartieraa516822015-10-02 15:53:37 -0700665 Thread* const self = Thread::Current();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700666 {
667 // TODO: dalvik only warned if there were breakpoints left over. clear in Dbg::Disconnected?
Mathieu Chartieraa516822015-10-02 15:53:37 -0700668 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700669 CHECK_EQ(gBreakpoints.size(), 0U);
670 }
Elliott Hughesa2155262011-11-16 16:26:58 -0800671
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100672 {
Mathieu Chartieraa516822015-10-02 15:53:37 -0700673 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100674 CHECK_EQ(deoptimization_requests_.size(), 0U);
675 CHECK_EQ(full_deoptimization_event_count_, 0U);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200676 CHECK_EQ(dex_pc_change_event_ref_count_, 0U);
677 CHECK_EQ(method_enter_event_ref_count_, 0U);
678 CHECK_EQ(method_exit_event_ref_count_, 0U);
679 CHECK_EQ(field_read_event_ref_count_, 0U);
680 CHECK_EQ(field_write_event_ref_count_, 0U);
681 CHECK_EQ(exception_catch_event_ref_count_, 0U);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100682 }
683
Ian Rogers62d6c772013-02-27 08:32:07 -0800684 Runtime* runtime = Runtime::Current();
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000685 // Best effort deoptimization if the runtime is non-Java debuggable. This happens when
686 // ro.debuggable is set, but the application is not debuggable, or when a standalone
687 // dalvikvm invocation is not passed the debuggable option (-Xcompiler-option --debuggable).
688 //
689 // The performance cost of this is non-negligible during native-debugging due to the
David Srbeckyf4480162016-03-16 00:06:24 +0000690 // forced JIT, so we keep the AOT code in that case in exchange for limited native debugging.
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000691 if (!runtime->IsJavaDebuggable() &&
692 !runtime->GetInstrumentation()->IsForcedInterpretOnly() &&
693 !runtime->IsNativeDebuggable()) {
694 runtime->DeoptimizeBootImage();
Mingyao Yang6ea1a0e2016-01-29 12:12:49 -0800695 }
696
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700697 ScopedSuspendAll ssa(__FUNCTION__);
Sebastien Hertzf3928792014-11-17 19:00:37 +0100698 if (RequiresDeoptimization()) {
699 runtime->GetInstrumentation()->EnableDeoptimization();
700 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200701 instrumentation_events_ = 0;
Elliott Hughesa2155262011-11-16 16:26:58 -0800702 gDebuggerActive = true;
Alex Light21611932017-09-26 13:07:39 -0700703 Runtime::Current()->GetRuntimeCallbacks()->AddMethodInspectionCallback(&gDebugActiveCallback);
Ian Rogers62d6c772013-02-27 08:32:07 -0800704 LOG(INFO) << "Debugger is active";
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700705}
706
707void Dbg::Disconnected() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700708 CHECK(gDebuggerConnected);
709
Elliott Hughesc0f09332012-03-26 13:27:06 -0700710 LOG(INFO) << "Debugger is no longer active";
Elliott Hughes234ab152011-10-26 14:02:26 -0700711
Hiroshi Yamauchi98810e32016-05-24 14:55:40 -0700712 // Suspend all threads and exclusively acquire the mutator lock. Remove the debugger as a listener
Ian Rogers62d6c772013-02-27 08:32:07 -0800713 // and clear the object registry.
714 Runtime* runtime = Runtime::Current();
Ian Rogers62d6c772013-02-27 08:32:07 -0800715 Thread* self = Thread::Current();
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700716 {
Mathieu Chartieraa516822015-10-02 15:53:37 -0700717 // Required for DisableDeoptimization.
718 gc::ScopedGCCriticalSection gcs(self,
719 gc::kGcCauseInstrumentation,
720 gc::kCollectorTypeInstrumentation);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700721 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700722 // Debugger may not be active at this point.
723 if (IsDebuggerActive()) {
724 {
725 // Since we're going to disable deoptimization, we clear the deoptimization requests queue.
726 // This prevents us from having any pending deoptimization request when the debugger attaches
727 // to us again while no event has been requested yet.
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -0700728 MutexLock mu(self, *Locks::deoptimization_lock_);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700729 deoptimization_requests_.clear();
730 full_deoptimization_event_count_ = 0U;
731 }
732 if (instrumentation_events_ != 0) {
733 runtime->GetInstrumentation()->RemoveListener(&gDebugInstrumentationListener,
734 instrumentation_events_);
735 instrumentation_events_ = 0;
736 }
737 if (RequiresDeoptimization()) {
738 runtime->GetInstrumentation()->DisableDeoptimization(kDbgInstrumentationKey);
739 }
740 gDebuggerActive = false;
Alex Light21611932017-09-26 13:07:39 -0700741 Runtime::Current()->GetRuntimeCallbacks()->RemoveMethodInspectionCallback(
742 &gDebugActiveCallback);
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100743 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100744 }
Sebastien Hertz55f65342015-01-13 22:48:34 +0100745
746 {
747 ScopedObjectAccess soa(self);
748 gRegistry->Clear();
749 }
750
751 gDebuggerConnected = false;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700752}
753
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100754void Dbg::ConfigureJdwp(const JDWP::JdwpOptions& jdwp_options) {
755 CHECK_NE(jdwp_options.transport, JDWP::kJdwpTransportUnknown);
756 gJdwpOptions = jdwp_options;
757 gJdwpConfigured = true;
Alex Light40320712017-12-14 11:52:04 -0800758 Runtime::Current()->GetRuntimeCallbacks()->AddDebuggerControlCallback(&gDebuggerControlCallback);
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100759}
760
Elliott Hughesc0f09332012-03-26 13:27:06 -0700761bool Dbg::IsJdwpConfigured() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700762 return gJdwpConfigured;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700763}
764
765int64_t Dbg::LastDebuggerActivity() {
Elliott Hughesca951522011-12-05 12:01:32 -0800766 return gJdwpState->LastDebuggerActivity();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700767}
768
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700769void Dbg::UndoDebuggerSuspensions() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700770 Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700771}
772
Elliott Hughes88d63092013-01-09 09:55:54 -0800773std::string Dbg::GetClassName(JDWP::RefTypeId class_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700774 JDWP::JdwpError error;
775 mirror::Object* o = gRegistry->Get<mirror::Object*>(class_id, &error);
776 if (o == nullptr) {
777 if (error == JDWP::ERR_NONE) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700778 return "null";
Ian Rogersc0542af2014-09-03 16:16:56 -0700779 } else {
780 return StringPrintf("invalid object %p", reinterpret_cast<void*>(class_id));
781 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800782 }
783 if (!o->IsClass()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700784 return StringPrintf("non-class %p", o); // This is only used for debugging output anyway.
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800785 }
Sebastien Hertz6995c602014-09-09 12:10:13 +0200786 return GetClassName(o->AsClass());
787}
788
789std::string Dbg::GetClassName(mirror::Class* klass) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200790 if (klass == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700791 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200792 }
Ian Rogers1ff3c982014-08-12 02:30:58 -0700793 std::string temp;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200794 return DescriptorToName(klass->GetDescriptor(&temp));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700795}
796
Ian Rogersc0542af2014-09-03 16:16:56 -0700797JDWP::JdwpError Dbg::GetClassObject(JDWP::RefTypeId id, JDWP::ObjectId* class_object_id) {
Elliott Hughes436e3722012-02-17 20:01:47 -0800798 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700799 mirror::Class* c = DecodeClass(id, &status);
800 if (c == nullptr) {
801 *class_object_id = 0;
Elliott Hughes436e3722012-02-17 20:01:47 -0800802 return status;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800803 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700804 *class_object_id = gRegistry->Add(c);
Elliott Hughes436e3722012-02-17 20:01:47 -0800805 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -0800806}
807
Ian Rogersc0542af2014-09-03 16:16:56 -0700808JDWP::JdwpError Dbg::GetSuperclass(JDWP::RefTypeId id, JDWP::RefTypeId* superclass_id) {
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800809 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700810 mirror::Class* c = DecodeClass(id, &status);
811 if (c == nullptr) {
812 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800813 return status;
814 }
815 if (c->IsInterface()) {
816 // http://code.google.com/p/android/issues/detail?id=20856
Ian Rogersc0542af2014-09-03 16:16:56 -0700817 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800818 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700819 *superclass_id = gRegistry->Add(c->GetSuperClass());
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800820 }
821 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700822}
823
Elliott Hughes436e3722012-02-17 20:01:47 -0800824JDWP::JdwpError Dbg::GetClassLoader(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700825 JDWP::JdwpError error;
Andreas Gampe7929a482015-12-30 19:33:49 -0800826 mirror::Class* c = DecodeClass(id, &error);
827 if (c == nullptr) {
828 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -0800829 }
Andreas Gampe7929a482015-12-30 19:33:49 -0800830 expandBufAddObjectId(pReply, gRegistry->Add(c->GetClassLoader()));
Elliott Hughes436e3722012-02-17 20:01:47 -0800831 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700832}
833
Elliott Hughes436e3722012-02-17 20:01:47 -0800834JDWP::JdwpError Dbg::GetModifiers(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700835 JDWP::JdwpError error;
836 mirror::Class* c = DecodeClass(id, &error);
837 if (c == nullptr) {
838 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800839 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800840
841 uint32_t access_flags = c->GetAccessFlags() & kAccJavaFlagsMask;
842
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700843 // Set ACC_SUPER. Dex files don't contain this flag but only classes are supposed to have it set,
844 // not interfaces.
Elliott Hughes436e3722012-02-17 20:01:47 -0800845 // Class.getModifiers doesn't return it, but JDWP does, so we set it here.
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700846 if ((access_flags & kAccInterface) == 0) {
847 access_flags |= kAccSuper;
848 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800849
850 expandBufAdd4BE(pReply, access_flags);
851
852 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700853}
854
Ian Rogersc0542af2014-09-03 16:16:56 -0700855JDWP::JdwpError Dbg::GetMonitorInfo(JDWP::ObjectId object_id, JDWP::ExpandBuf* reply) {
856 JDWP::JdwpError error;
857 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
858 if (o == nullptr) {
Elliott Hughesf327e072013-01-09 16:01:26 -0800859 return JDWP::ERR_INVALID_OBJECT;
860 }
861
862 // Ensure all threads are suspended while we read objects' lock words.
863 Thread* self = Thread::Current();
Sebastien Hertz54263242014-03-19 18:16:50 +0100864 CHECK_EQ(self->GetState(), kRunnable);
Elliott Hughesf327e072013-01-09 16:01:26 -0800865
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700866 MonitorInfo monitor_info;
867 {
868 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -0700869 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700870 monitor_info = MonitorInfo(o);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -0700871 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700872 if (monitor_info.owner_ != nullptr) {
Nicolas Geoffraycafa0812017-02-15 18:27:34 +0000873 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.owner_->GetPeerFromOtherThread()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800874 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700875 expandBufAddObjectId(reply, gRegistry->Add(nullptr));
Elliott Hughesf327e072013-01-09 16:01:26 -0800876 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700877 expandBufAdd4BE(reply, monitor_info.entry_count_);
878 expandBufAdd4BE(reply, monitor_info.waiters_.size());
879 for (size_t i = 0; i < monitor_info.waiters_.size(); ++i) {
Nicolas Geoffraycafa0812017-02-15 18:27:34 +0000880 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.waiters_[i]->GetPeerFromOtherThread()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800881 }
882 return JDWP::ERR_NONE;
883}
884
Elliott Hughes734b8c62013-01-11 15:32:45 -0800885JDWP::JdwpError Dbg::GetOwnedMonitors(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700886 std::vector<JDWP::ObjectId>* monitors,
887 std::vector<uint32_t>* stack_depths) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800888 struct OwnedMonitorVisitor : public StackVisitor {
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700889 OwnedMonitorVisitor(Thread* thread, Context* context,
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700890 std::vector<JDWP::ObjectId>* monitor_vector,
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700891 std::vector<uint32_t>* stack_depth_vector)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700892 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +0100893 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
894 current_stack_depth(0),
895 monitors(monitor_vector),
896 stack_depths(stack_depth_vector) {}
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800897
898 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
899 // annotalysis.
900 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
901 if (!GetMethod()->IsRuntimeMethod()) {
902 Monitor::VisitLocks(this, AppendOwnedMonitors, this);
Elliott Hughes734b8c62013-01-11 15:32:45 -0800903 ++current_stack_depth;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800904 }
905 return true;
906 }
907
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700908 static void AppendOwnedMonitors(mirror::Object* owned_monitor, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700909 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers7a22fa62013-01-23 12:16:16 -0800910 OwnedMonitorVisitor* visitor = reinterpret_cast<OwnedMonitorVisitor*>(arg);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700911 visitor->monitors->push_back(gRegistry->Add(owned_monitor));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700912 visitor->stack_depths->push_back(visitor->current_stack_depth);
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800913 }
914
Elliott Hughes734b8c62013-01-11 15:32:45 -0800915 size_t current_stack_depth;
Ian Rogersc0542af2014-09-03 16:16:56 -0700916 std::vector<JDWP::ObjectId>* const monitors;
917 std::vector<uint32_t>* const stack_depths;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800918 };
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800919
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700920 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +0200921 JDWP::JdwpError error;
922 Thread* thread = DecodeThread(soa, thread_id, &error);
923 if (thread == nullptr) {
924 return error;
925 }
926 if (!IsSuspendedForDebugger(soa, thread)) {
927 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700928 }
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700929 std::unique_ptr<Context> context(Context::Create());
Ian Rogersc0542af2014-09-03 16:16:56 -0700930 OwnedMonitorVisitor visitor(thread, context.get(), monitors, stack_depths);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700931 visitor.WalkStack();
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800932 return JDWP::ERR_NONE;
933}
934
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100935JDWP::JdwpError Dbg::GetContendedMonitor(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700936 JDWP::ObjectId* contended_monitor) {
Elliott Hughesf9501702013-01-11 11:22:27 -0800937 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -0700938 *contended_monitor = 0;
Sebastien Hertz69206392015-04-07 15:54:25 +0200939 JDWP::JdwpError error;
940 Thread* thread = DecodeThread(soa, thread_id, &error);
941 if (thread == nullptr) {
942 return error;
Elliott Hughesf9501702013-01-11 11:22:27 -0800943 }
Sebastien Hertz69206392015-04-07 15:54:25 +0200944 if (!IsSuspendedForDebugger(soa, thread)) {
945 return JDWP::ERR_THREAD_NOT_SUSPENDED;
946 }
947 mirror::Object* contended_monitor_obj = Monitor::GetContendedMonitor(thread);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700948 // Add() requires the thread_list_lock_ not held to avoid the lock
949 // level violation.
Ian Rogersc0542af2014-09-03 16:16:56 -0700950 *contended_monitor = gRegistry->Add(contended_monitor_obj);
Elliott Hughesf9501702013-01-11 11:22:27 -0800951 return JDWP::ERR_NONE;
952}
953
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800954JDWP::JdwpError Dbg::GetInstanceCounts(const std::vector<JDWP::RefTypeId>& class_ids,
Ian Rogersc0542af2014-09-03 16:16:56 -0700955 std::vector<uint64_t>* counts) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800956 gc::Heap* heap = Runtime::Current()->GetHeap();
Roland Levillainaf290312018-02-27 20:02:17 +0000957 heap->CollectGarbage(/* clear_soft_references */ false, gc::GcCause::kGcCauseDebugger);
Mathieu Chartiere8a3c572016-10-11 16:52:17 -0700958 VariableSizedHandleScope hs(Thread::Current());
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700959 std::vector<Handle<mirror::Class>> classes;
Ian Rogersc0542af2014-09-03 16:16:56 -0700960 counts->clear();
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800961 for (size_t i = 0; i < class_ids.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700962 JDWP::JdwpError error;
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700963 ObjPtr<mirror::Class> c = DecodeClass(class_ids[i], &error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700964 if (c == nullptr) {
965 return error;
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800966 }
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700967 classes.push_back(hs.NewHandle(c));
Ian Rogersc0542af2014-09-03 16:16:56 -0700968 counts->push_back(0);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800969 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700970 heap->CountInstances(classes, false, &(*counts)[0]);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800971 return JDWP::ERR_NONE;
972}
973
Ian Rogersc0542af2014-09-03 16:16:56 -0700974JDWP::JdwpError Dbg::GetInstances(JDWP::RefTypeId class_id, int32_t max_count,
975 std::vector<JDWP::ObjectId>* instances) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800976 gc::Heap* heap = Runtime::Current()->GetHeap();
977 // We only want reachable instances, so do a GC.
Roland Levillainaf290312018-02-27 20:02:17 +0000978 heap->CollectGarbage(/* clear_soft_references */ false, gc::GcCause::kGcCauseDebugger);
Ian Rogersc0542af2014-09-03 16:16:56 -0700979 JDWP::JdwpError error;
Mathieu Chartier9d156d52016-10-06 17:44:26 -0700980 ObjPtr<mirror::Class> c = DecodeClass(class_id, &error);
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800981 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700982 return error;
Elliott Hughes3b78c942013-01-15 17:35:41 -0800983 }
Mathieu Chartier2d855952016-10-12 19:37:59 -0700984 VariableSizedHandleScope hs(Thread::Current());
985 std::vector<Handle<mirror::Object>> raw_instances;
Richard Uhler660be6f2017-11-22 16:12:29 +0000986 Runtime::Current()->GetHeap()->GetInstances(hs,
987 hs.NewHandle(c),
988 /* use_is_assignable_from */ false,
989 max_count,
990 raw_instances);
Elliott Hughes3b78c942013-01-15 17:35:41 -0800991 for (size_t i = 0; i < raw_instances.size(); ++i) {
Mathieu Chartier2d855952016-10-12 19:37:59 -0700992 instances->push_back(gRegistry->Add(raw_instances[i].Get()));
Elliott Hughes3b78c942013-01-15 17:35:41 -0800993 }
994 return JDWP::ERR_NONE;
995}
996
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800997JDWP::JdwpError Dbg::GetReferringObjects(JDWP::ObjectId object_id, int32_t max_count,
Ian Rogersc0542af2014-09-03 16:16:56 -0700998 std::vector<JDWP::ObjectId>* referring_objects) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800999 gc::Heap* heap = Runtime::Current()->GetHeap();
Roland Levillainaf290312018-02-27 20:02:17 +00001000 heap->CollectGarbage(/* clear_soft_references */ false, gc::GcCause::kGcCauseDebugger);
Ian Rogersc0542af2014-09-03 16:16:56 -07001001 JDWP::JdwpError error;
Mathieu Chartier9d156d52016-10-06 17:44:26 -07001002 ObjPtr<mirror::Object> o = gRegistry->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001003 if (o == nullptr) {
Elliott Hughes0cbaff52013-01-16 15:28:01 -08001004 return JDWP::ERR_INVALID_OBJECT;
1005 }
Mathieu Chartieraea9bfb2016-10-12 19:19:56 -07001006 VariableSizedHandleScope hs(Thread::Current());
1007 std::vector<Handle<mirror::Object>> raw_instances;
1008 heap->GetReferringObjects(hs, hs.NewHandle(o), max_count, raw_instances);
Elliott Hughes0cbaff52013-01-16 15:28:01 -08001009 for (size_t i = 0; i < raw_instances.size(); ++i) {
Mathieu Chartieraea9bfb2016-10-12 19:19:56 -07001010 referring_objects->push_back(gRegistry->Add(raw_instances[i].Get()));
Elliott Hughes0cbaff52013-01-16 15:28:01 -08001011 }
1012 return JDWP::ERR_NONE;
1013}
1014
Ian Rogersc0542af2014-09-03 16:16:56 -07001015JDWP::JdwpError Dbg::DisableCollection(JDWP::ObjectId object_id) {
1016 JDWP::JdwpError error;
1017 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1018 if (o == nullptr) {
Sebastien Hertze96060a2013-12-11 12:06:28 +01001019 return JDWP::ERR_INVALID_OBJECT;
1020 }
Elliott Hughes64f574f2013-02-20 14:57:12 -08001021 gRegistry->DisableCollection(object_id);
1022 return JDWP::ERR_NONE;
1023}
1024
Ian Rogersc0542af2014-09-03 16:16:56 -07001025JDWP::JdwpError Dbg::EnableCollection(JDWP::ObjectId object_id) {
1026 JDWP::JdwpError error;
1027 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
Sebastien Hertze96060a2013-12-11 12:06:28 +01001028 // Unlike DisableCollection, JDWP specs do not state an invalid object causes an error. The RI
1029 // also ignores these cases and never return an error. However it's not obvious why this command
1030 // should behave differently from DisableCollection and IsCollected commands. So let's be more
1031 // strict and return an error if this happens.
Ian Rogersc0542af2014-09-03 16:16:56 -07001032 if (o == nullptr) {
Sebastien Hertze96060a2013-12-11 12:06:28 +01001033 return JDWP::ERR_INVALID_OBJECT;
1034 }
Elliott Hughes64f574f2013-02-20 14:57:12 -08001035 gRegistry->EnableCollection(object_id);
1036 return JDWP::ERR_NONE;
1037}
1038
Ian Rogersc0542af2014-09-03 16:16:56 -07001039JDWP::JdwpError Dbg::IsCollected(JDWP::ObjectId object_id, bool* is_collected) {
1040 *is_collected = true;
Sebastien Hertz65637eb2014-01-10 17:40:02 +01001041 if (object_id == 0) {
1042 // Null object id is invalid.
Sebastien Hertze96060a2013-12-11 12:06:28 +01001043 return JDWP::ERR_INVALID_OBJECT;
1044 }
Sebastien Hertz65637eb2014-01-10 17:40:02 +01001045 // JDWP specs state an INVALID_OBJECT error is returned if the object ID is not valid. However
1046 // the RI seems to ignore this and assume object has been collected.
Ian Rogersc0542af2014-09-03 16:16:56 -07001047 JDWP::JdwpError error;
1048 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1049 if (o != nullptr) {
1050 *is_collected = gRegistry->IsCollected(object_id);
Sebastien Hertz65637eb2014-01-10 17:40:02 +01001051 }
Elliott Hughes64f574f2013-02-20 14:57:12 -08001052 return JDWP::ERR_NONE;
1053}
1054
Ian Rogersc0542af2014-09-03 16:16:56 -07001055void Dbg::DisposeObject(JDWP::ObjectId object_id, uint32_t reference_count) {
Elliott Hughes64f574f2013-02-20 14:57:12 -08001056 gRegistry->DisposeObject(object_id, reference_count);
1057}
1058
Mathieu Chartier3398c782016-09-30 10:27:43 -07001059JDWP::JdwpTypeTag Dbg::GetTypeTag(ObjPtr<mirror::Class> klass) {
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001060 DCHECK(klass != nullptr);
1061 if (klass->IsArrayClass()) {
1062 return JDWP::TT_ARRAY;
1063 } else if (klass->IsInterface()) {
1064 return JDWP::TT_INTERFACE;
1065 } else {
1066 return JDWP::TT_CLASS;
1067 }
1068}
1069
Elliott Hughes88d63092013-01-09 09:55:54 -08001070JDWP::JdwpError Dbg::GetReflectedType(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001071 JDWP::JdwpError error;
1072 mirror::Class* c = DecodeClass(class_id, &error);
1073 if (c == nullptr) {
1074 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001075 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001076
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001077 JDWP::JdwpTypeTag type_tag = GetTypeTag(c);
1078 expandBufAdd1(pReply, type_tag);
Elliott Hughes88d63092013-01-09 09:55:54 -08001079 expandBufAddRefTypeId(pReply, class_id);
Elliott Hughes436e3722012-02-17 20:01:47 -08001080 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001081}
1082
Mathieu Chartiere0671ce2015-07-28 17:23:28 -07001083// Get the complete list of reference classes (i.e. all classes except
1084// the primitive types).
1085// Returns a newly-allocated buffer full of RefTypeId values.
1086class ClassListCreator : public ClassVisitor {
1087 public:
1088 explicit ClassListCreator(std::vector<JDWP::RefTypeId>* classes) : classes_(classes) {}
1089
Mathieu Chartier28357fa2016-10-18 16:27:40 -07001090 bool operator()(ObjPtr<mirror::Class> c) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere0671ce2015-07-28 17:23:28 -07001091 if (!c->IsPrimitive()) {
1092 classes_->push_back(Dbg::GetObjectRegistry()->AddRefType(c));
1093 }
1094 return true;
1095 }
1096
1097 private:
1098 std::vector<JDWP::RefTypeId>* const classes_;
1099};
1100
Ian Rogersc0542af2014-09-03 16:16:56 -07001101void Dbg::GetClassList(std::vector<JDWP::RefTypeId>* classes) {
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001102 ClassListCreator clc(classes);
Mathieu Chartiere0671ce2015-07-28 17:23:28 -07001103 Runtime::Current()->GetClassLinker()->VisitClassesWithoutClassesLock(&clc);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001104}
1105
Ian Rogers1ff3c982014-08-12 02:30:58 -07001106JDWP::JdwpError Dbg::GetClassInfo(JDWP::RefTypeId class_id, JDWP::JdwpTypeTag* pTypeTag,
1107 uint32_t* pStatus, std::string* pDescriptor) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001108 JDWP::JdwpError error;
1109 mirror::Class* c = DecodeClass(class_id, &error);
1110 if (c == nullptr) {
1111 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001112 }
1113
Elliott Hughesa2155262011-11-16 16:26:58 -08001114 if (c->IsArrayClass()) {
1115 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
1116 *pTypeTag = JDWP::TT_ARRAY;
1117 } else {
1118 if (c->IsErroneous()) {
1119 *pStatus = JDWP::CS_ERROR;
1120 } else {
1121 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
1122 }
1123 *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
1124 }
1125
Ian Rogersc0542af2014-09-03 16:16:56 -07001126 if (pDescriptor != nullptr) {
Ian Rogers1ff3c982014-08-12 02:30:58 -07001127 std::string temp;
1128 *pDescriptor = c->GetDescriptor(&temp);
Elliott Hughesa2155262011-11-16 16:26:58 -08001129 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001130 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001131}
1132
Ian Rogersc0542af2014-09-03 16:16:56 -07001133void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>* ids) {
Mathieu Chartier28357fa2016-10-18 16:27:40 -07001134 std::vector<ObjPtr<mirror::Class>> classes;
Igor Murashkinb1d8c312015-08-04 11:18:43 -07001135 Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
Ian Rogersc0542af2014-09-03 16:16:56 -07001136 ids->clear();
Mathieu Chartier28357fa2016-10-18 16:27:40 -07001137 for (ObjPtr<mirror::Class> c : classes) {
1138 ids->push_back(gRegistry->Add(c));
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001139 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001140}
1141
Ian Rogersc0542af2014-09-03 16:16:56 -07001142JDWP::JdwpError Dbg::GetReferenceType(JDWP::ObjectId object_id, JDWP::ExpandBuf* pReply) {
1143 JDWP::JdwpError error;
1144 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1145 if (o == nullptr) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001146 return JDWP::ERR_INVALID_OBJECT;
Elliott Hughes499c5132011-11-17 14:55:11 -08001147 }
Elliott Hughes2435a572012-02-17 16:07:41 -08001148
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001149 JDWP::JdwpTypeTag type_tag = GetTypeTag(o->GetClass());
Elliott Hughes64f574f2013-02-20 14:57:12 -08001150 JDWP::RefTypeId type_id = gRegistry->AddRefType(o->GetClass());
Elliott Hughes2435a572012-02-17 16:07:41 -08001151
1152 expandBufAdd1(pReply, type_tag);
1153 expandBufAddRefTypeId(pReply, type_id);
1154
1155 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001156}
1157
Ian Rogersfc0e94b2013-09-23 23:51:32 -07001158JDWP::JdwpError Dbg::GetSignature(JDWP::RefTypeId class_id, std::string* signature) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001159 JDWP::JdwpError error;
1160 mirror::Class* c = DecodeClass(class_id, &error);
1161 if (c == nullptr) {
1162 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001163 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001164 std::string temp;
1165 *signature = c->GetDescriptor(&temp);
Elliott Hughes1fe7afb2012-02-13 17:23:03 -08001166 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001167}
1168
Orion Hodson77d8a1c2017-04-24 14:53:19 +01001169JDWP::JdwpError Dbg::GetSourceDebugExtension(JDWP::RefTypeId class_id,
1170 std::string* extension_data) {
1171 JDWP::JdwpError error;
1172 mirror::Class* c = DecodeClass(class_id, &error);
1173 if (c == nullptr) {
1174 return error;
1175 }
1176 StackHandleScope<1> hs(Thread::Current());
1177 Handle<mirror::Class> klass(hs.NewHandle(c));
1178 const char* data = annotations::GetSourceDebugExtension(klass);
1179 if (data == nullptr) {
1180 return JDWP::ERR_ABSENT_INFORMATION;
1181 }
1182 *extension_data = data;
1183 return JDWP::ERR_NONE;
1184}
1185
Ian Rogersc0542af2014-09-03 16:16:56 -07001186JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1187 JDWP::JdwpError error;
1188 mirror::Class* c = DecodeClass(class_id, &error);
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001189 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001190 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001191 }
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001192 const char* source_file = c->GetSourceFile();
1193 if (source_file == nullptr) {
Sebastien Hertzb7054ba2014-03-13 11:52:31 +01001194 return JDWP::ERR_ABSENT_INFORMATION;
1195 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001196 *result = source_file;
Elliott Hughes436e3722012-02-17 20:01:47 -08001197 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001198}
1199
Ian Rogersc0542af2014-09-03 16:16:56 -07001200JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
Ian Rogers98379392014-02-24 16:53:16 -08001201 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001202 JDWP::JdwpError error;
1203 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1204 if (error != JDWP::ERR_NONE) {
1205 *tag = JDWP::JT_VOID;
1206 return error;
Elliott Hughes546b9862012-06-20 16:06:13 -07001207 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001208 *tag = TagFromObject(soa, o);
Elliott Hughes546b9862012-06-20 16:06:13 -07001209 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001210}
1211
Elliott Hughesaed4be92011-12-02 16:16:23 -08001212size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001213 switch (tag) {
1214 case JDWP::JT_VOID:
1215 return 0;
1216 case JDWP::JT_BYTE:
1217 case JDWP::JT_BOOLEAN:
1218 return 1;
1219 case JDWP::JT_CHAR:
1220 case JDWP::JT_SHORT:
1221 return 2;
1222 case JDWP::JT_FLOAT:
1223 case JDWP::JT_INT:
1224 return 4;
1225 case JDWP::JT_ARRAY:
1226 case JDWP::JT_OBJECT:
1227 case JDWP::JT_STRING:
1228 case JDWP::JT_THREAD:
1229 case JDWP::JT_THREAD_GROUP:
1230 case JDWP::JT_CLASS_LOADER:
1231 case JDWP::JT_CLASS_OBJECT:
1232 return sizeof(JDWP::ObjectId);
1233 case JDWP::JT_DOUBLE:
1234 case JDWP::JT_LONG:
1235 return 8;
1236 default:
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08001237 LOG(FATAL) << "Unknown tag " << tag;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001238 return -1;
1239 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001240}
1241
Ian Rogersc0542af2014-09-03 16:16:56 -07001242JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1243 JDWP::JdwpError error;
1244 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1245 if (a == nullptr) {
1246 return error;
Elliott Hughes24437992011-11-30 14:49:33 -08001247 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001248 *length = a->GetLength();
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001249 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001250}
1251
Elliott Hughes88d63092013-01-09 09:55:54 -08001252JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001253 JDWP::JdwpError error;
1254 mirror::Array* a = DecodeNonNullArray(array_id, &error);
Ian Rogers98379392014-02-24 16:53:16 -08001255 if (a == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001256 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001257 }
Elliott Hughes24437992011-11-30 14:49:33 -08001258
1259 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1260 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001261 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughes24437992011-11-30 14:49:33 -08001262 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001263 JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1264 expandBufAdd1(pReply, element_tag);
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001265 expandBufAdd4BE(pReply, count);
1266
Ian Rogers1ff3c982014-08-12 02:30:58 -07001267 if (IsPrimitiveTag(element_tag)) {
1268 size_t width = GetTagWidth(element_tag);
Elliott Hughes24437992011-11-30 14:49:33 -08001269 uint8_t* dst = expandBufAddSpace(pReply, count * width);
1270 if (width == 8) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001271 const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001272 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1273 } else if (width == 4) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001274 const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001275 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1276 } else if (width == 2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001277 const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001278 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1279 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001280 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001281 memcpy(dst, &src[offset * width], count * width);
1282 }
1283 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001284 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001285 mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
Elliott Hughes24437992011-11-30 14:49:33 -08001286 for (int i = 0; i < count; ++i) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001287 mirror::Object* element = oa->Get(offset + i);
Ian Rogers98379392014-02-24 16:53:16 -08001288 JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
Ian Rogers1ff3c982014-08-12 02:30:58 -07001289 : element_tag;
Elliott Hughes24437992011-11-30 14:49:33 -08001290 expandBufAdd1(pReply, specific_tag);
1291 expandBufAddObjectId(pReply, gRegistry->Add(element));
1292 }
1293 }
1294
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001295 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001296}
1297
Ian Rogersef7d42f2014-01-06 12:55:46 -08001298template <typename T>
Ian Rogersc0542af2014-09-03 16:16:56 -07001299static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
Ian Rogersef7d42f2014-01-06 12:55:46 -08001300 NO_THREAD_SAFETY_ANALYSIS {
1301 // TODO: fix when annotalysis correctly handles non-member functions.
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001302 DCHECK(a->GetClass()->IsPrimitiveArray());
1303
Ian Rogersef7d42f2014-01-06 12:55:46 -08001304 T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001305 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001306 *dst++ = src->ReadValue(sizeof(T));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001307 }
1308}
1309
Elliott Hughes88d63092013-01-09 09:55:54 -08001310JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
Ian Rogersc0542af2014-09-03 16:16:56 -07001311 JDWP::Request* request) {
1312 JDWP::JdwpError error;
1313 mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1314 if (dst == nullptr) {
1315 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001316 }
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001317
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001318 if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001319 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001320 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001321 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001322 JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001323
Ian Rogers1ff3c982014-08-12 02:30:58 -07001324 if (IsPrimitiveTag(element_tag)) {
1325 size_t width = GetTagWidth(element_tag);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001326 if (width == 8) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001327 CopyArrayData<uint64_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001328 } else if (width == 4) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001329 CopyArrayData<uint32_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001330 } else if (width == 2) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001331 CopyArrayData<uint16_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001332 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001333 CopyArrayData<uint8_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001334 }
1335 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001336 mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001337 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001338 JDWP::ObjectId id = request->ReadObjectId();
Ian Rogersc0542af2014-09-03 16:16:56 -07001339 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1340 if (error != JDWP::ERR_NONE) {
1341 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -08001342 }
Sebastien Hertz2e1c16d2015-08-28 11:57:49 +02001343 // Check if the object's type is compatible with the array's type.
1344 if (o != nullptr && !o->InstanceOf(oa->GetClass()->GetComponentType())) {
1345 return JDWP::ERR_TYPE_MISMATCH;
1346 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001347 oa->Set<false>(offset + i, o);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001348 }
1349 }
1350
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001351 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001352}
1353
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001354JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1355 Thread* self = Thread::Current();
1356 mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1357 if (new_string == nullptr) {
1358 DCHECK(self->IsExceptionPending());
1359 self->ClearException();
1360 LOG(ERROR) << "Could not allocate string";
1361 *new_string_id = 0;
1362 return JDWP::ERR_OUT_OF_MEMORY;
1363 }
1364 *new_string_id = gRegistry->Add(new_string);
1365 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001366}
1367
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001368JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001369 JDWP::JdwpError error;
1370 mirror::Class* c = DecodeClass(class_id, &error);
1371 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001372 *new_object_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001373 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001374 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001375 Thread* self = Thread::Current();
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07001376 ObjPtr<mirror::Object> new_object;
Sebastien Hertz56d5e502015-11-03 17:38:35 +01001377 if (c->IsStringClass()) {
1378 // Special case for java.lang.String.
1379 gc::AllocatorType allocator_type = Runtime::Current()->GetHeap()->GetCurrentAllocator();
jessicahandojo3aaa37b2016-07-29 14:46:37 -07001380 new_object = mirror::String::AllocEmptyString<true>(self, allocator_type);
Sebastien Hertz56d5e502015-11-03 17:38:35 +01001381 } else {
1382 new_object = c->AllocObject(self);
1383 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001384 if (new_object == nullptr) {
1385 DCHECK(self->IsExceptionPending());
1386 self->ClearException();
David Sehr709b0702016-10-13 09:12:37 -07001387 LOG(ERROR) << "Could not allocate object of type " << mirror::Class::PrettyDescriptor(c);
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001388 *new_object_id = 0;
1389 return JDWP::ERR_OUT_OF_MEMORY;
1390 }
Mathieu Chartier28bd2e42016-10-04 13:54:57 -07001391 *new_object_id = gRegistry->Add(new_object.Ptr());
Elliott Hughes436e3722012-02-17 20:01:47 -08001392 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001393}
1394
Elliott Hughesbf13d362011-12-08 15:51:37 -08001395/*
1396 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1397 */
Elliott Hughes88d63092013-01-09 09:55:54 -08001398JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001399 JDWP::ObjectId* new_array_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001400 JDWP::JdwpError error;
1401 mirror::Class* c = DecodeClass(array_class_id, &error);
1402 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001403 *new_array_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001404 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001405 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001406 Thread* self = Thread::Current();
1407 gc::Heap* heap = Runtime::Current()->GetHeap();
1408 mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1409 c->GetComponentSizeShift(),
1410 heap->GetCurrentAllocator());
1411 if (new_array == nullptr) {
1412 DCHECK(self->IsExceptionPending());
1413 self->ClearException();
David Sehr709b0702016-10-13 09:12:37 -07001414 LOG(ERROR) << "Could not allocate array of type " << mirror::Class::PrettyDescriptor(c);
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001415 *new_array_id = 0;
1416 return JDWP::ERR_OUT_OF_MEMORY;
1417 }
1418 *new_array_id = gRegistry->Add(new_array);
Elliott Hughes436e3722012-02-17 20:01:47 -08001419 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001420}
1421
Mathieu Chartierc7853442015-03-27 14:35:38 -07001422JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001423 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
Elliott Hughes03181a82011-11-17 17:22:21 -08001424}
1425
Alex Light6c8467f2015-11-20 15:03:26 -08001426static JDWP::MethodId ToMethodId(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001427 REQUIRES_SHARED(Locks::mutator_lock_) {
Alex Light97e78032017-06-27 17:51:55 -07001428 return static_cast<JDWP::MethodId>(
1429 reinterpret_cast<uintptr_t>(m->GetCanonicalMethod(kRuntimePointerSize)));
Elliott Hughes03181a82011-11-17 17:22:21 -08001430}
1431
Mathieu Chartierc7853442015-03-27 14:35:38 -07001432static ArtField* FromFieldId(JDWP::FieldId fid)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001433 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001434 return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
Elliott Hughesaed4be92011-12-02 16:16:23 -08001435}
1436
Mathieu Chartiere401d142015-04-22 13:56:20 -07001437static ArtMethod* FromMethodId(JDWP::MethodId mid)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001438 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001439 return reinterpret_cast<ArtMethod*>(static_cast<uintptr_t>(mid));
Elliott Hughes03181a82011-11-17 17:22:21 -08001440}
1441
Sebastien Hertz6995c602014-09-09 12:10:13 +02001442bool Dbg::MatchThread(JDWP::ObjectId expected_thread_id, Thread* event_thread) {
1443 CHECK(event_thread != nullptr);
1444 JDWP::JdwpError error;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001445 mirror::Object* expected_thread_peer = gRegistry->Get<mirror::Object*>(
1446 expected_thread_id, &error);
Nicolas Geoffraycafa0812017-02-15 18:27:34 +00001447 return expected_thread_peer == event_thread->GetPeerFromOtherThread();
Sebastien Hertz6995c602014-09-09 12:10:13 +02001448}
1449
1450bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1451 const JDWP::EventLocation& event_location) {
1452 if (expected_location.dex_pc != event_location.dex_pc) {
1453 return false;
1454 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001455 ArtMethod* m = FromMethodId(expected_location.method_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001456 return m == event_location.method;
1457}
1458
Mathieu Chartier3398c782016-09-30 10:27:43 -07001459bool Dbg::MatchType(ObjPtr<mirror::Class> event_class, JDWP::RefTypeId class_id) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001460 if (event_class == nullptr) {
1461 return false;
1462 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02001463 JDWP::JdwpError error;
Mathieu Chartier3398c782016-09-30 10:27:43 -07001464 ObjPtr<mirror::Class> expected_class = DecodeClass(class_id, &error);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001465 CHECK(expected_class != nullptr);
1466 return expected_class->IsAssignableFrom(event_class);
1467}
1468
1469bool Dbg::MatchField(JDWP::RefTypeId expected_type_id, JDWP::FieldId expected_field_id,
Mathieu Chartierc7853442015-03-27 14:35:38 -07001470 ArtField* event_field) {
1471 ArtField* expected_field = FromFieldId(expected_field_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001472 if (expected_field != event_field) {
1473 return false;
1474 }
1475 return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1476}
1477
1478bool Dbg::MatchInstance(JDWP::ObjectId expected_instance_id, mirror::Object* event_instance) {
1479 JDWP::JdwpError error;
1480 mirror::Object* modifier_instance = gRegistry->Get<mirror::Object*>(expected_instance_id, &error);
1481 return modifier_instance == event_instance;
1482}
1483
Mathieu Chartier90443472015-07-16 20:32:27 -07001484void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, ArtMethod* m, uint32_t dex_pc) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001485 if (m == nullptr) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001486 memset(location, 0, sizeof(*location));
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001487 } else {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001488 mirror::Class* c = m->GetDeclaringClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07001489 location->type_tag = GetTypeTag(c);
1490 location->class_id = gRegistry->AddRefType(c);
Alex Light73376312017-04-06 10:10:51 -07001491 // The RI Seems to return 0 for all obsolete methods. For compatibility we shall do the same.
1492 location->method_id = m->IsObsolete() ? 0 : ToMethodId(m);
Ian Rogersc0542af2014-09-03 16:16:56 -07001493 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001494 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08001495}
1496
Ian Rogersc0542af2014-09-03 16:16:56 -07001497std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001498 ArtMethod* m = FromMethodId(method_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001499 if (m == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001500 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001501 }
Andreas Gampe542451c2016-07-26 09:02:02 -07001502 return m->GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001503}
1504
Alex Light73376312017-04-06 10:10:51 -07001505bool Dbg::IsMethodObsolete(JDWP::MethodId method_id) {
1506 ArtMethod* m = FromMethodId(method_id);
1507 if (m == nullptr) {
1508 // NB Since we return 0 as MID for obsolete methods we want to default to true here.
1509 return true;
1510 }
1511 return m->IsObsolete();
1512}
1513
Ian Rogersc0542af2014-09-03 16:16:56 -07001514std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001515 ArtField* f = FromFieldId(field_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001516 if (f == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001517 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001518 }
1519 return f->GetName();
Elliott Hughesa96836a2013-01-17 12:27:49 -08001520}
1521
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001522/*
1523 * Augment the access flags for synthetic methods and fields by setting
1524 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
1525 * flags not specified by the Java programming language.
1526 */
1527static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1528 accessFlags &= kAccJavaFlagsMask;
1529 if ((accessFlags & kAccSynthetic) != 0) {
1530 accessFlags |= 0xf0000000;
1531 }
1532 return accessFlags;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001533}
1534
Elliott Hughesdbb40792011-11-18 17:05:22 -08001535/*
Jeff Haob7cefc72013-11-14 14:51:09 -08001536 * Circularly shifts registers so that arguments come first. Debuggers
1537 * expect slots to begin with arguments, but dex code places them at
1538 * the end.
Elliott Hughesdbb40792011-11-18 17:05:22 -08001539 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001540static uint16_t MangleSlot(uint16_t slot, ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001541 REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr0225f8e2018-01-31 08:52:24 +00001542 CodeItemDataAccessor accessor(m->DexInstructionData());
Mathieu Chartier808c7a52017-12-15 11:19:33 -08001543 if (!accessor.HasCodeItem()) {
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001544 // We should not get here for a method without code (native, proxy or abstract). Log it and
1545 // return the slot as is since all registers are arguments.
David Sehr709b0702016-10-13 09:12:37 -07001546 LOG(WARNING) << "Trying to mangle slot for method without code " << m->PrettyMethod();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001547 return slot;
1548 }
Mathieu Chartier808c7a52017-12-15 11:19:33 -08001549 uint16_t ins_size = accessor.InsSize();
1550 uint16_t locals_size = accessor.RegistersSize() - ins_size;
Jeff Haob7cefc72013-11-14 14:51:09 -08001551 if (slot >= locals_size) {
1552 return slot - locals_size;
1553 } else {
1554 return slot + ins_size;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001555 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001556}
1557
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001558static size_t GetMethodNumArgRegistersIncludingThis(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001559 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001560 uint32_t num_registers = ArtMethod::NumArgRegisters(method->GetShorty());
1561 if (!method->IsStatic()) {
1562 ++num_registers;
1563 }
1564 return num_registers;
1565}
1566
Jeff Haob7cefc72013-11-14 14:51:09 -08001567/*
1568 * Circularly shifts registers so that arguments come last. Reverts
1569 * slots to dex style argument placement.
1570 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001571static uint16_t DemangleSlot(uint16_t slot, ArtMethod* m, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001572 REQUIRES_SHARED(Locks::mutator_lock_) {
David Sehr0225f8e2018-01-31 08:52:24 +00001573 CodeItemDataAccessor accessor(m->DexInstructionData());
Mathieu Chartier808c7a52017-12-15 11:19:33 -08001574 if (!accessor.HasCodeItem()) {
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001575 // We should not get here for a method without code (native, proxy or abstract). Log it and
1576 // return the slot as is since all registers are arguments.
David Sehr709b0702016-10-13 09:12:37 -07001577 LOG(WARNING) << "Trying to demangle slot for method without code "
1578 << m->PrettyMethod();
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001579 uint16_t vreg_count = GetMethodNumArgRegistersIncludingThis(m);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001580 if (slot < vreg_count) {
1581 *error = JDWP::ERR_NONE;
1582 return slot;
1583 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001584 } else {
Mathieu Chartier808c7a52017-12-15 11:19:33 -08001585 if (slot < accessor.RegistersSize()) {
1586 uint16_t ins_size = accessor.InsSize();
1587 uint16_t locals_size = accessor.RegistersSize() - ins_size;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001588 *error = JDWP::ERR_NONE;
1589 return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1590 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001591 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001592
1593 // Slot is invalid in the method.
David Sehr709b0702016-10-13 09:12:37 -07001594 LOG(ERROR) << "Invalid local slot " << slot << " for method " << m->PrettyMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001595 *error = JDWP::ERR_INVALID_SLOT;
1596 return DexFile::kDexNoIndex16;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001597}
1598
Mathieu Chartier90443472015-07-16 20:32:27 -07001599JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic,
1600 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001601 JDWP::JdwpError error;
1602 mirror::Class* c = DecodeClass(class_id, &error);
1603 if (c == nullptr) {
1604 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001605 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001606
1607 size_t instance_field_count = c->NumInstanceFields();
1608 size_t static_field_count = c->NumStaticFields();
1609
1610 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1611
1612 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
Mathieu Chartier90443472015-07-16 20:32:27 -07001613 ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) :
1614 c->GetStaticField(i - instance_field_count);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001615 expandBufAddFieldId(pReply, ToFieldId(f));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001616 expandBufAddUtf8String(pReply, f->GetName());
1617 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001618 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001619 static const char genericSignature[1] = "";
1620 expandBufAddUtf8String(pReply, genericSignature);
1621 }
1622 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1623 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001624 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001625}
1626
Elliott Hughes88d63092013-01-09 09:55:54 -08001627JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001628 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001629 JDWP::JdwpError error;
1630 mirror::Class* c = DecodeClass(class_id, &error);
1631 if (c == nullptr) {
1632 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001633 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001634
Alex Light51a64d52015-12-17 13:55:59 -08001635 expandBufAdd4BE(pReply, c->NumMethods());
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001636
Mathieu Chartiere401d142015-04-22 13:56:20 -07001637 auto* cl = Runtime::Current()->GetClassLinker();
1638 auto ptr_size = cl->GetImagePointerSize();
Alex Light51a64d52015-12-17 13:55:59 -08001639 for (ArtMethod& m : c->GetMethods(ptr_size)) {
1640 expandBufAddMethodId(pReply, ToMethodId(&m));
Andreas Gampe542451c2016-07-26 09:02:02 -07001641 expandBufAddUtf8String(pReply, m.GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetName());
1642 expandBufAddUtf8String(
1643 pReply, m.GetInterfaceMethodIfProxy(kRuntimePointerSize)->GetSignature().ToString());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001644 if (with_generic) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001645 const char* generic_signature = "";
1646 expandBufAddUtf8String(pReply, generic_signature);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001647 }
Alex Light51a64d52015-12-17 13:55:59 -08001648 expandBufAdd4BE(pReply, MangleAccessFlags(m.GetAccessFlags()));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001649 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001650 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001651}
1652
Elliott Hughes88d63092013-01-09 09:55:54 -08001653JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001654 JDWP::JdwpError error;
Mathieu Chartierf8322842014-05-16 10:59:25 -07001655 Thread* self = Thread::Current();
Vladimir Marko19a4d372016-12-08 14:41:46 +00001656 ObjPtr<mirror::Class> c = DecodeClass(class_id, &error);
1657 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001658 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001659 }
Mathieu Chartierf8322842014-05-16 10:59:25 -07001660 size_t interface_count = c->NumDirectInterfaces();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001661 expandBufAdd4BE(pReply, interface_count);
1662 for (size_t i = 0; i < interface_count; ++i) {
Vladimir Marko19a4d372016-12-08 14:41:46 +00001663 ObjPtr<mirror::Class> interface = mirror::Class::GetDirectInterface(self, c, i);
1664 DCHECK(interface != nullptr);
1665 expandBufAddRefTypeId(pReply, gRegistry->AddRefType(interface));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001666 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001667 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001668}
1669
Ian Rogersc0542af2014-09-03 16:16:56 -07001670void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001671 struct DebugCallbackContext {
1672 int numItems;
1673 JDWP::ExpandBuf* pReply;
1674
David Srbeckyb06e28e2015-12-10 13:15:00 +00001675 static bool Callback(void* context, const DexFile::PositionInfo& entry) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001676 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
David Srbeckyb06e28e2015-12-10 13:15:00 +00001677 expandBufAdd8BE(pContext->pReply, entry.address_);
1678 expandBufAdd4BE(pContext->pReply, entry.line_);
Elliott Hughes03181a82011-11-17 17:22:21 -08001679 pContext->numItems++;
Sebastien Hertzf2910ee2013-10-19 16:39:24 +02001680 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08001681 }
1682 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001683 ArtMethod* m = FromMethodId(method_id);
David Sehr0225f8e2018-01-31 08:52:24 +00001684 CodeItemDebugInfoAccessor accessor(m->DexInstructionDebugInfo());
Elliott Hughes03181a82011-11-17 17:22:21 -08001685 uint64_t start, end;
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08001686 if (!accessor.HasCodeItem()) {
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001687 DCHECK(m->IsNative() || m->IsProxyMethod());
Elliott Hughes03181a82011-11-17 17:22:21 -08001688 start = -1;
1689 end = -1;
1690 } else {
1691 start = 0;
jeffhao14f0db92012-12-14 17:50:42 -08001692 // Return the index of the last instruction
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08001693 end = accessor.InsnsSizeInCodeUnits() - 1;
Elliott Hughes03181a82011-11-17 17:22:21 -08001694 }
1695
1696 expandBufAdd8BE(pReply, start);
1697 expandBufAdd8BE(pReply, end);
1698
1699 // Add numLines later
1700 size_t numLinesOffset = expandBufGetLength(pReply);
1701 expandBufAdd4BE(pReply, 0);
1702
1703 DebugCallbackContext context;
1704 context.numItems = 0;
1705 context.pReply = pReply;
1706
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08001707 if (accessor.HasCodeItem()) {
1708 m->GetDexFile()->DecodeDebugPositionInfo(accessor.DebugInfoOffset(),
1709 DebugCallbackContext::Callback,
1710 &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001711 }
Elliott Hughes03181a82011-11-17 17:22:21 -08001712
1713 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001714}
1715
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001716void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1717 JDWP::ExpandBuf* pReply) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001718 struct DebugCallbackContext {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001719 ArtMethod* method;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001720 JDWP::ExpandBuf* pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001721 size_t variable_count;
1722 bool with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001723
David Srbeckyb06e28e2015-12-10 13:15:00 +00001724 static void Callback(void* context, const DexFile::LocalInfo& entry)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001725 REQUIRES_SHARED(Locks::mutator_lock_) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001726 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1727
David Srbeckyb06e28e2015-12-10 13:15:00 +00001728 uint16_t slot = entry.reg_;
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001729 VLOG(jdwp) << StringPrintf(" %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
David Srbeckyb06e28e2015-12-10 13:15:00 +00001730 pContext->variable_count, entry.start_address_,
1731 entry.end_address_ - entry.start_address_,
1732 entry.name_, entry.descriptor_, entry.signature_, slot,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001733 MangleSlot(slot, pContext->method));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001734
Jeff Haob7cefc72013-11-14 14:51:09 -08001735 slot = MangleSlot(slot, pContext->method);
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001736
David Srbeckyb06e28e2015-12-10 13:15:00 +00001737 expandBufAdd8BE(pContext->pReply, entry.start_address_);
1738 expandBufAddUtf8String(pContext->pReply, entry.name_);
1739 expandBufAddUtf8String(pContext->pReply, entry.descriptor_);
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001740 if (pContext->with_generic) {
David Srbeckyb06e28e2015-12-10 13:15:00 +00001741 expandBufAddUtf8String(pContext->pReply, entry.signature_);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001742 }
David Srbeckyb06e28e2015-12-10 13:15:00 +00001743 expandBufAdd4BE(pContext->pReply, entry.end_address_- entry.start_address_);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001744 expandBufAdd4BE(pContext->pReply, slot);
1745
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001746 ++pContext->variable_count;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001747 }
1748 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001749 ArtMethod* m = FromMethodId(method_id);
David Sehr0225f8e2018-01-31 08:52:24 +00001750 CodeItemDebugInfoAccessor accessor(m->DexInstructionDebugInfo());
Elliott Hughesdbb40792011-11-18 17:05:22 -08001751
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001752 // arg_count considers doubles and longs to take 2 units.
1753 // variable_count considers everything to take 1 unit.
Sebastien Hertzaef0c912016-08-08 10:20:28 +02001754 expandBufAdd4BE(pReply, GetMethodNumArgRegistersIncludingThis(m));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001755
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001756 // We don't know the total number of variables yet, so leave a blank and update it later.
1757 size_t variable_count_offset = expandBufGetLength(pReply);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001758 expandBufAdd4BE(pReply, 0);
1759
1760 DebugCallbackContext context;
Jeff Haob7cefc72013-11-14 14:51:09 -08001761 context.method = m;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001762 context.pReply = pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001763 context.variable_count = 0;
1764 context.with_generic = with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001765
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08001766 if (accessor.HasCodeItem()) {
1767 m->GetDexFile()->DecodeDebugLocalInfo(accessor.RegistersSize(),
1768 accessor.InsSize(),
1769 accessor.InsnsSizeInCodeUnits(),
1770 accessor.DebugInfoOffset(),
1771 m->IsStatic(),
1772 m->GetDexMethodIndex(),
1773 DebugCallbackContext::Callback,
1774 &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001775 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001776
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001777 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001778}
1779
Jeff Hao579b0242013-11-18 13:16:49 -08001780void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1781 JDWP::ExpandBuf* pReply) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001782 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001783 JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
Jeff Hao579b0242013-11-18 13:16:49 -08001784 OutputJValue(tag, return_value, pReply);
1785}
1786
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001787void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1788 JDWP::ExpandBuf* pReply) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001789 ArtField* f = FromFieldId(field_id);
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001790 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001791 OutputJValue(tag, field_value, pReply);
1792}
1793
Elliott Hughes9777ba22013-01-17 09:04:19 -08001794JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
Ian Rogersc0542af2014-09-03 16:16:56 -07001795 std::vector<uint8_t>* bytecodes) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001796 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07001797 if (m == nullptr) {
Elliott Hughes9777ba22013-01-17 09:04:19 -08001798 return JDWP::ERR_INVALID_METHODID;
1799 }
David Sehr0225f8e2018-01-31 08:52:24 +00001800 CodeItemDataAccessor accessor(m->DexInstructionData());
Mathieu Chartier808c7a52017-12-15 11:19:33 -08001801 size_t byte_count = accessor.InsnsSizeInCodeUnits() * 2;
1802 const uint8_t* begin = reinterpret_cast<const uint8_t*>(accessor.Insns());
Elliott Hughes9777ba22013-01-17 09:04:19 -08001803 const uint8_t* end = begin + byte_count;
1804 for (const uint8_t* p = begin; p != end; ++p) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001805 bytecodes->push_back(*p);
Elliott Hughes9777ba22013-01-17 09:04:19 -08001806 }
1807 return JDWP::ERR_NONE;
1808}
1809
Elliott Hughes88d63092013-01-09 09:55:54 -08001810JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001811 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001812}
1813
Elliott Hughes88d63092013-01-09 09:55:54 -08001814JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001815 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001816}
1817
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001818static JValue GetArtFieldValue(ArtField* f, mirror::Object* o)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001819 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001820 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1821 JValue field_value;
1822 switch (fieldType) {
1823 case Primitive::kPrimBoolean:
1824 field_value.SetZ(f->GetBoolean(o));
1825 return field_value;
1826
1827 case Primitive::kPrimByte:
1828 field_value.SetB(f->GetByte(o));
1829 return field_value;
1830
1831 case Primitive::kPrimChar:
1832 field_value.SetC(f->GetChar(o));
1833 return field_value;
1834
1835 case Primitive::kPrimShort:
1836 field_value.SetS(f->GetShort(o));
1837 return field_value;
1838
1839 case Primitive::kPrimInt:
1840 case Primitive::kPrimFloat:
1841 // Int and Float must be treated as 32-bit values in JDWP.
1842 field_value.SetI(f->GetInt(o));
1843 return field_value;
1844
1845 case Primitive::kPrimLong:
1846 case Primitive::kPrimDouble:
1847 // Long and Double must be treated as 64-bit values in JDWP.
1848 field_value.SetJ(f->GetLong(o));
1849 return field_value;
1850
1851 case Primitive::kPrimNot:
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07001852 field_value.SetL(f->GetObject(o).Ptr());
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001853 return field_value;
1854
1855 case Primitive::kPrimVoid:
1856 LOG(FATAL) << "Attempt to read from field of type 'void'";
1857 UNREACHABLE();
1858 }
1859 LOG(FATAL) << "Attempt to read from field of unknown type";
1860 UNREACHABLE();
1861}
1862
Elliott Hughes88d63092013-01-09 09:55:54 -08001863static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1864 JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001865 bool is_static)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001866 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001867 JDWP::JdwpError error;
1868 mirror::Class* c = DecodeClass(ref_type_id, &error);
1869 if (ref_type_id != 0 && c == nullptr) {
1870 return error;
Elliott Hughes0cf74332012-02-23 23:14:00 -08001871 }
1872
Jeff Haode19a252016-09-14 15:56:35 -07001873 Thread* self = Thread::Current();
1874 StackHandleScope<2> hs(self);
1875 MutableHandle<mirror::Object>
1876 o(hs.NewHandle(Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001877 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001878 return JDWP::ERR_INVALID_OBJECT;
1879 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001880 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001881
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001882 mirror::Class* receiver_class = c;
Andreas Gampefa4333d2017-02-14 11:10:34 -08001883 if (receiver_class == nullptr && o != nullptr) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001884 receiver_class = o->GetClass();
1885 }
Jeff Haode19a252016-09-14 15:56:35 -07001886
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001887 // TODO: should we give up now if receiver_class is null?
Ian Rogersc0542af2014-09-03 16:16:56 -07001888 if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
David Sehr709b0702016-10-13 09:12:37 -07001889 LOG(INFO) << "ERR_INVALID_FIELDID: " << f->PrettyField() << " "
1890 << receiver_class->PrettyClass();
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001891 return JDWP::ERR_INVALID_FIELDID;
1892 }
Elliott Hughesaed4be92011-12-02 16:16:23 -08001893
Jeff Haode19a252016-09-14 15:56:35 -07001894 // Ensure the field's class is initialized.
1895 Handle<mirror::Class> klass(hs.NewHandle(f->GetDeclaringClass()));
1896 if (!Runtime::Current()->GetClassLinker()->EnsureInitialized(self, klass, true, false)) {
David Sehr709b0702016-10-13 09:12:37 -07001897 LOG(WARNING) << "Not able to initialize class for SetValues: "
1898 << mirror::Class::PrettyClass(klass.Get());
Jeff Haode19a252016-09-14 15:56:35 -07001899 }
1900
Elliott Hughes0cf74332012-02-23 23:14:00 -08001901 // The RI only enforces the static/non-static mismatch in one direction.
1902 // TODO: should we change the tests and check both?
1903 if (is_static) {
1904 if (!f->IsStatic()) {
1905 return JDWP::ERR_INVALID_FIELDID;
1906 }
1907 } else {
1908 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001909 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.GetValues"
David Sehr709b0702016-10-13 09:12:37 -07001910 << " on static field " << f->PrettyField();
Elliott Hughes0cf74332012-02-23 23:14:00 -08001911 }
1912 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001913 if (f->IsStatic()) {
Jeff Haode19a252016-09-14 15:56:35 -07001914 o.Assign(f->GetDeclaringClass());
jeffhao0dfbb7e2012-11-28 15:26:03 -08001915 }
Elliott Hughes0cf74332012-02-23 23:14:00 -08001916
Jeff Haode19a252016-09-14 15:56:35 -07001917 JValue field_value(GetArtFieldValue(f, o.Get()));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001918 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Jeff Hao579b0242013-11-18 13:16:49 -08001919 Dbg::OutputJValue(tag, &field_value, pReply);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001920 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001921}
1922
Elliott Hughes88d63092013-01-09 09:55:54 -08001923JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001924 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001925 return GetFieldValueImpl(0, object_id, field_id, pReply, false);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001926}
1927
Ian Rogersc0542af2014-09-03 16:16:56 -07001928JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1929 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001930 return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001931}
1932
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001933static JDWP::JdwpError SetArtFieldValue(ArtField* f, mirror::Object* o, uint64_t value, int width)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001934 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001935 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1936 // Debugging only happens at runtime so we know we are not running in a transaction.
1937 static constexpr bool kNoTransactionMode = false;
1938 switch (fieldType) {
1939 case Primitive::kPrimBoolean:
1940 CHECK_EQ(width, 1);
1941 f->SetBoolean<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1942 return JDWP::ERR_NONE;
1943
1944 case Primitive::kPrimByte:
1945 CHECK_EQ(width, 1);
1946 f->SetByte<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1947 return JDWP::ERR_NONE;
1948
1949 case Primitive::kPrimChar:
1950 CHECK_EQ(width, 2);
1951 f->SetChar<kNoTransactionMode>(o, static_cast<uint16_t>(value));
1952 return JDWP::ERR_NONE;
1953
1954 case Primitive::kPrimShort:
1955 CHECK_EQ(width, 2);
1956 f->SetShort<kNoTransactionMode>(o, static_cast<int16_t>(value));
1957 return JDWP::ERR_NONE;
1958
1959 case Primitive::kPrimInt:
1960 case Primitive::kPrimFloat:
1961 CHECK_EQ(width, 4);
1962 // Int and Float must be treated as 32-bit values in JDWP.
1963 f->SetInt<kNoTransactionMode>(o, static_cast<int32_t>(value));
1964 return JDWP::ERR_NONE;
1965
1966 case Primitive::kPrimLong:
1967 case Primitive::kPrimDouble:
1968 CHECK_EQ(width, 8);
1969 // Long and Double must be treated as 64-bit values in JDWP.
1970 f->SetLong<kNoTransactionMode>(o, value);
1971 return JDWP::ERR_NONE;
1972
1973 case Primitive::kPrimNot: {
1974 JDWP::JdwpError error;
1975 mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1976 if (error != JDWP::ERR_NONE) {
1977 return JDWP::ERR_INVALID_OBJECT;
1978 }
1979 if (v != nullptr) {
Mathieu Chartier3398c782016-09-30 10:27:43 -07001980 ObjPtr<mirror::Class> field_type;
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001981 {
1982 StackHandleScope<2> hs(Thread::Current());
1983 HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1984 HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
Vladimir Marko4098a7a2017-11-06 16:00:51 +00001985 field_type = f->ResolveType();
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001986 }
1987 if (!field_type->IsAssignableFrom(v->GetClass())) {
1988 return JDWP::ERR_INVALID_OBJECT;
1989 }
1990 }
1991 f->SetObject<kNoTransactionMode>(o, v);
1992 return JDWP::ERR_NONE;
1993 }
1994
1995 case Primitive::kPrimVoid:
1996 LOG(FATAL) << "Attempt to write to field of type 'void'";
1997 UNREACHABLE();
1998 }
1999 LOG(FATAL) << "Attempt to write to field of unknown type";
2000 UNREACHABLE();
2001}
2002
Elliott Hughes88d63092013-01-09 09:55:54 -08002003static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002004 uint64_t value, int width, bool is_static)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002005 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07002006 JDWP::JdwpError error;
Jeff Haode19a252016-09-14 15:56:35 -07002007 Thread* self = Thread::Current();
2008 StackHandleScope<2> hs(self);
2009 MutableHandle<mirror::Object>
2010 o(hs.NewHandle(Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08002011 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08002012 return JDWP::ERR_INVALID_OBJECT;
2013 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07002014 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08002015
Jeff Haode19a252016-09-14 15:56:35 -07002016 // Ensure the field's class is initialized.
2017 Handle<mirror::Class> klass(hs.NewHandle(f->GetDeclaringClass()));
2018 if (!Runtime::Current()->GetClassLinker()->EnsureInitialized(self, klass, true, false)) {
David Sehr709b0702016-10-13 09:12:37 -07002019 LOG(WARNING) << "Not able to initialize class for SetValues: "
2020 << mirror::Class::PrettyClass(klass.Get());
Jeff Haode19a252016-09-14 15:56:35 -07002021 }
2022
Elliott Hughes0cf74332012-02-23 23:14:00 -08002023 // The RI only enforces the static/non-static mismatch in one direction.
2024 // TODO: should we change the tests and check both?
2025 if (is_static) {
2026 if (!f->IsStatic()) {
2027 return JDWP::ERR_INVALID_FIELDID;
2028 }
2029 } else {
2030 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02002031 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues"
David Sehr709b0702016-10-13 09:12:37 -07002032 << " on static field " << f->PrettyField();
Elliott Hughes0cf74332012-02-23 23:14:00 -08002033 }
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08002034 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08002035 if (f->IsStatic()) {
Jeff Haode19a252016-09-14 15:56:35 -07002036 o.Assign(f->GetDeclaringClass());
jeffhao0dfbb7e2012-11-28 15:26:03 -08002037 }
Jeff Haode19a252016-09-14 15:56:35 -07002038 return SetArtFieldValue(f, o.Get(), value, width);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002039}
2040
Elliott Hughes88d63092013-01-09 09:55:54 -08002041JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002042 int width) {
Elliott Hughes88d63092013-01-09 09:55:54 -08002043 return SetFieldValueImpl(object_id, field_id, value, width, false);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002044}
2045
Elliott Hughes88d63092013-01-09 09:55:54 -08002046JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
2047 return SetFieldValueImpl(0, field_id, value, width, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002048}
2049
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02002050JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
Ian Rogersc0542af2014-09-03 16:16:56 -07002051 JDWP::JdwpError error;
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02002052 mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
2053 if (error != JDWP::ERR_NONE) {
2054 return error;
2055 }
2056 if (obj == nullptr) {
2057 return JDWP::ERR_INVALID_OBJECT;
2058 }
2059 {
2060 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartier0795f232016-09-27 18:43:30 -07002061 ObjPtr<mirror::Class> java_lang_String =
2062 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_String);
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02002063 if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
2064 // This isn't a string.
2065 return JDWP::ERR_INVALID_STRING;
2066 }
2067 }
2068 *str = obj->AsString()->ToModifiedUtf8();
2069 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002070}
2071
Jeff Hao579b0242013-11-18 13:16:49 -08002072void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
2073 if (IsPrimitiveTag(tag)) {
2074 expandBufAdd1(pReply, tag);
2075 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
2076 expandBufAdd1(pReply, return_value->GetI());
2077 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
2078 expandBufAdd2BE(pReply, return_value->GetI());
2079 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
2080 expandBufAdd4BE(pReply, return_value->GetI());
2081 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
2082 expandBufAdd8BE(pReply, return_value->GetJ());
2083 } else {
2084 CHECK_EQ(tag, JDWP::JT_VOID);
2085 }
2086 } else {
Ian Rogers98379392014-02-24 16:53:16 -08002087 ScopedObjectAccessUnchecked soa(Thread::Current());
Jeff Hao579b0242013-11-18 13:16:49 -08002088 mirror::Object* value = return_value->GetL();
Ian Rogers98379392014-02-24 16:53:16 -08002089 expandBufAdd1(pReply, TagFromObject(soa, value));
Jeff Hao579b0242013-11-18 13:16:49 -08002090 expandBufAddObjectId(pReply, gRegistry->Add(value));
2091 }
2092}
2093
Ian Rogersc0542af2014-09-03 16:16:56 -07002094JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
jeffhaoa77f0f62012-12-05 17:19:31 -08002095 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002096 JDWP::JdwpError error;
Roland Levillain4b8f1ec2015-08-26 18:34:03 +01002097 DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002098 if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
2099 return error;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002100 }
Elliott Hughes221229c2013-01-08 18:17:50 -08002101
2102 // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
Ian Rogersc0542af2014-09-03 16:16:56 -07002103 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
2104 CHECK(thread_object != nullptr) << error;
Mathieu Chartierc7853442015-03-27 14:35:38 -07002105 ArtField* java_lang_Thread_name_field =
Andreas Gampe08883de2016-11-08 13:20:52 -08002106 jni::DecodeArtField(WellKnownClasses::java_lang_Thread_name);
Mathieu Chartierf8ac97f2016-10-05 15:56:52 -07002107 ObjPtr<mirror::String> s(java_lang_Thread_name_field->GetObject(thread_object)->AsString());
Ian Rogersc0542af2014-09-03 16:16:56 -07002108 if (s != nullptr) {
2109 *name = s->ToModifiedUtf8();
Elliott Hughes221229c2013-01-08 18:17:50 -08002110 }
2111 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002112}
2113
Elliott Hughes221229c2013-01-08 18:17:50 -08002114JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02002115 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002116 JDWP::JdwpError error;
2117 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
2118 if (error != JDWP::ERR_NONE) {
Elliott Hughes2435a572012-02-17 16:07:41 -08002119 return JDWP::ERR_INVALID_OBJECT;
2120 }
Mathieu Chartier268764d2016-09-13 12:09:38 -07002121 ScopedAssertNoThreadSuspension ants("Debugger: GetThreadGroup");
Elliott Hughes2435a572012-02-17 16:07:41 -08002122 // Okay, so it's an object, but is it actually a thread?
Roland Levillain4b8f1ec2015-08-26 18:34:03 +01002123 DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002124 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2125 // Zombie threads are in the null group.
2126 expandBufAddObjectId(pReply, JDWP::ObjectId(0));
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002127 error = JDWP::ERR_NONE;
2128 } else if (error == JDWP::ERR_NONE) {
Mathieu Chartier0795f232016-09-27 18:43:30 -07002129 ObjPtr<mirror::Class> c = soa.Decode<mirror::Class>(WellKnownClasses::java_lang_Thread);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002130 CHECK(c != nullptr);
Andreas Gampe08883de2016-11-08 13:20:52 -08002131 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07002132 CHECK(f != nullptr);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002133 ObjPtr<mirror::Object> group = f->GetObject(thread_object);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07002134 CHECK(group != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002135 JDWP::ObjectId thread_group_id = gRegistry->Add(group);
2136 expandBufAddObjectId(pReply, thread_group_id);
Elliott Hughes221229c2013-01-08 18:17:50 -08002137 }
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002138 return error;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002139}
2140
Sebastien Hertza06430c2014-09-15 19:21:30 +02002141static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
2142 JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002143 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002144 mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
2145 error);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002146 if (*error != JDWP::ERR_NONE) {
2147 return nullptr;
2148 }
2149 if (thread_group == nullptr) {
2150 *error = JDWP::ERR_INVALID_OBJECT;
2151 return nullptr;
2152 }
Mathieu Chartier0795f232016-09-27 18:43:30 -07002153 ObjPtr<mirror::Class> c =
2154 soa.Decode<mirror::Class>(WellKnownClasses::java_lang_ThreadGroup);
Ian Rogers98379392014-02-24 16:53:16 -08002155 CHECK(c != nullptr);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002156 if (!c->IsAssignableFrom(thread_group->GetClass())) {
2157 // This is not a java.lang.ThreadGroup.
2158 *error = JDWP::ERR_INVALID_THREAD_GROUP;
2159 return nullptr;
2160 }
2161 *error = JDWP::ERR_NONE;
2162 return thread_group;
2163}
2164
2165JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
2166 ScopedObjectAccessUnchecked soa(Thread::Current());
2167 JDWP::JdwpError error;
2168 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2169 if (error != JDWP::ERR_NONE) {
2170 return error;
2171 }
Mathieu Chartier268764d2016-09-13 12:09:38 -07002172 ScopedAssertNoThreadSuspension ants("Debugger: GetThreadGroupName");
Andreas Gampe08883de2016-11-08 13:20:52 -08002173 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_name);
Ian Rogersc0542af2014-09-03 16:16:56 -07002174 CHECK(f != nullptr);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002175 ObjPtr<mirror::String> s = f->GetObject(thread_group)->AsString();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002176
2177 std::string thread_group_name(s->ToModifiedUtf8());
2178 expandBufAddUtf8String(pReply, thread_group_name);
2179 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002180}
2181
Sebastien Hertza06430c2014-09-15 19:21:30 +02002182JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
Ian Rogers98379392014-02-24 16:53:16 -08002183 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002184 JDWP::JdwpError error;
Sebastien Hertza06430c2014-09-15 19:21:30 +02002185 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2186 if (error != JDWP::ERR_NONE) {
2187 return error;
2188 }
Mathieu Chartier3398c782016-09-30 10:27:43 -07002189 ObjPtr<mirror::Object> parent;
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002190 {
Mathieu Chartier268764d2016-09-13 12:09:38 -07002191 ScopedAssertNoThreadSuspension ants("Debugger: GetThreadGroupParent");
Andreas Gampe08883de2016-11-08 13:20:52 -08002192 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_parent);
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07002193 CHECK(f != nullptr);
2194 parent = f->GetObject(thread_group);
2195 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002196 JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
2197 expandBufAddObjectId(pReply, parent_group_id);
2198 return JDWP::ERR_NONE;
2199}
2200
Andreas Gampe08883de2016-11-08 13:20:52 -08002201static void GetChildThreadGroups(mirror::Object* thread_group,
Sebastien Hertza06430c2014-09-15 19:21:30 +02002202 std::vector<JDWP::ObjectId>* child_thread_group_ids)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002203 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02002204 CHECK(thread_group != nullptr);
2205
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002206 // Get the int "ngroups" count of this thread group...
Andreas Gampe08883de2016-11-08 13:20:52 -08002207 ArtField* ngroups_field = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_ngroups);
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002208 CHECK(ngroups_field != nullptr);
2209 const int32_t size = ngroups_field->GetInt(thread_group);
2210 if (size == 0) {
2211 return;
Sebastien Hertze49e1952014-10-13 11:27:13 +02002212 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002213
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002214 // Get the ThreadGroup[] "groups" out of this thread group...
Andreas Gampe08883de2016-11-08 13:20:52 -08002215 ArtField* groups_field = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_groups);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002216 ObjPtr<mirror::Object> groups_array = groups_field->GetObject(thread_group);
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002217
2218 CHECK(groups_array != nullptr);
2219 CHECK(groups_array->IsObjectArray());
2220
Mathieu Chartier3398c782016-09-30 10:27:43 -07002221 ObjPtr<mirror::ObjectArray<mirror::Object>> groups_array_as_array =
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002222 groups_array->AsObjectArray<mirror::Object>();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002223
2224 // Copy the first 'size' elements out of the array into the result.
Sebastien Hertz6995c602014-09-09 12:10:13 +02002225 ObjectRegistry* registry = Dbg::GetObjectRegistry();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002226 for (int32_t i = 0; i < size; ++i) {
Przemyslaw Szczepaniak464595f2015-11-24 11:59:59 +00002227 child_thread_group_ids->push_back(registry->Add(groups_array_as_array->Get(i)));
Sebastien Hertza06430c2014-09-15 19:21:30 +02002228 }
2229}
2230
2231JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2232 JDWP::ExpandBuf* pReply) {
2233 ScopedObjectAccessUnchecked soa(Thread::Current());
2234 JDWP::JdwpError error;
2235 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2236 if (error != JDWP::ERR_NONE) {
2237 return error;
2238 }
2239
2240 // Add child threads.
2241 {
2242 std::vector<JDWP::ObjectId> child_thread_ids;
2243 GetThreads(thread_group, &child_thread_ids);
2244 expandBufAdd4BE(pReply, child_thread_ids.size());
2245 for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2246 expandBufAddObjectId(pReply, child_thread_id);
2247 }
2248 }
2249
2250 // Add child thread groups.
2251 {
2252 std::vector<JDWP::ObjectId> child_thread_groups_ids;
Andreas Gampe08883de2016-11-08 13:20:52 -08002253 GetChildThreadGroups(thread_group, &child_thread_groups_ids);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002254 expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2255 for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2256 expandBufAddObjectId(pReply, child_thread_group_id);
2257 }
2258 }
2259
2260 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002261}
2262
2263JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002264 ScopedObjectAccessUnchecked soa(Thread::Current());
Andreas Gampe08883de2016-11-08 13:20:52 -08002265 ArtField* f = jni::DecodeArtField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002266 ObjPtr<mirror::Object> group = f->GetObject(f->GetDeclaringClass());
Ian Rogers365c1022012-06-22 15:05:28 -07002267 return gRegistry->Add(group);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002268}
2269
Jeff Hao920af3e2013-08-28 15:46:38 -07002270JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2271 switch (state) {
2272 case kBlocked:
2273 return JDWP::TS_MONITOR;
2274 case kNative:
2275 case kRunnable:
2276 case kSuspended:
2277 return JDWP::TS_RUNNING;
2278 case kSleeping:
2279 return JDWP::TS_SLEEPING;
2280 case kStarting:
2281 case kTerminated:
2282 return JDWP::TS_ZOMBIE;
2283 case kTimedWaiting:
Alex Light77fee872017-09-05 14:51:49 -07002284 case kWaitingForTaskProcessor:
2285 case kWaitingForLockInflation:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002286 case kWaitingForCheckPointsToRun:
Jeff Hao920af3e2013-08-28 15:46:38 -07002287 case kWaitingForDebuggerSend:
2288 case kWaitingForDebuggerSuspension:
2289 case kWaitingForDebuggerToAttach:
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01002290 case kWaitingForDeoptimization:
Jeff Hao920af3e2013-08-28 15:46:38 -07002291 case kWaitingForGcToComplete:
Mathieu Chartierb43390c2015-05-12 10:47:11 -07002292 case kWaitingForGetObjectsAllocated:
Jeff Hao920af3e2013-08-28 15:46:38 -07002293 case kWaitingForJniOnLoad:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002294 case kWaitingForMethodTracingStart:
Jeff Hao920af3e2013-08-28 15:46:38 -07002295 case kWaitingForSignalCatcherOutput:
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08002296 case kWaitingForVisitObjects:
Jeff Hao920af3e2013-08-28 15:46:38 -07002297 case kWaitingInMainDebuggerLoop:
2298 case kWaitingInMainSignalCatcherLoop:
2299 case kWaitingPerformingGc:
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07002300 case kWaitingWeakGcRootRead:
Hiroshi Yamauchi76f55b02015-08-21 16:10:39 -07002301 case kWaitingForGcThreadFlip:
Jeff Hao920af3e2013-08-28 15:46:38 -07002302 case kWaiting:
2303 return JDWP::TS_WAIT;
2304 // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2305 }
2306 LOG(FATAL) << "Unknown thread state: " << state;
2307 return JDWP::TS_ZOMBIE;
2308}
2309
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002310JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2311 JDWP::JdwpSuspendStatus* pSuspendStatus) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002312 ScopedObjectAccess soa(Thread::Current());
Elliott Hughes499c5132011-11-17 14:55:11 -08002313
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002314 *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2315
Ian Rogersc0542af2014-09-03 16:16:56 -07002316 JDWP::JdwpError error;
2317 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002318 if (error != JDWP::ERR_NONE) {
2319 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2320 *pThreadStatus = JDWP::TS_ZOMBIE;
Elliott Hughes221229c2013-01-08 18:17:50 -08002321 return JDWP::ERR_NONE;
2322 }
2323 return error;
Elliott Hughes499c5132011-11-17 14:55:11 -08002324 }
2325
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002326 if (IsSuspendedForDebugger(soa, thread)) {
2327 *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
Elliott Hughes499c5132011-11-17 14:55:11 -08002328 }
2329
Jeff Hao920af3e2013-08-28 15:46:38 -07002330 *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
Elliott Hughes221229c2013-01-08 18:17:50 -08002331 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002332}
2333
Elliott Hughes221229c2013-01-08 18:17:50 -08002334JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002335 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002336 JDWP::JdwpError error;
2337 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002338 if (error != JDWP::ERR_NONE) {
2339 return error;
Elliott Hughes2435a572012-02-17 16:07:41 -08002340 }
Ian Rogers50b35e22012-10-04 10:09:15 -07002341 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002342 expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
Elliott Hughes2435a572012-02-17 16:07:41 -08002343 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002344}
2345
Elliott Hughesf9501702013-01-11 11:22:27 -08002346JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2347 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002348 JDWP::JdwpError error;
2349 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughesf9501702013-01-11 11:22:27 -08002350 if (error != JDWP::ERR_NONE) {
2351 return error;
2352 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002353 thread->Interrupt(soa.Self());
Elliott Hughesf9501702013-01-11 11:22:27 -08002354 return JDWP::ERR_NONE;
2355}
2356
Andreas Gampe08883de2016-11-08 13:20:52 -08002357static bool IsInDesiredThreadGroup(mirror::Object* desired_thread_group, mirror::Object* peer)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002358 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz070f7322014-09-09 12:08:49 +02002359 // Do we want threads from all thread groups?
2360 if (desired_thread_group == nullptr) {
2361 return true;
2362 }
Andreas Gampe08883de2016-11-08 13:20:52 -08002363 ArtField* thread_group_field = jni::DecodeArtField(WellKnownClasses::java_lang_Thread_group);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002364 DCHECK(thread_group_field != nullptr);
Mathieu Chartier3398c782016-09-30 10:27:43 -07002365 ObjPtr<mirror::Object> group = thread_group_field->GetObject(peer);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002366 return (group == desired_thread_group);
2367}
2368
Sebastien Hertza06430c2014-09-15 19:21:30 +02002369void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002370 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz070f7322014-09-09 12:08:49 +02002371 std::list<Thread*> all_threads_list;
2372 {
2373 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2374 all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2375 }
2376 for (Thread* t : all_threads_list) {
2377 if (t == Dbg::GetDebugThread()) {
2378 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2379 // query all threads, so it's easier if we just don't tell them about this thread.
2380 continue;
2381 }
2382 if (t->IsStillStarting()) {
2383 // This thread is being started (and has been registered in the thread list). However, it is
2384 // not completely started yet so we must ignore it.
2385 continue;
2386 }
Nicolas Geoffraycafa0812017-02-15 18:27:34 +00002387 mirror::Object* peer = t->GetPeerFromOtherThread();
Sebastien Hertz070f7322014-09-09 12:08:49 +02002388 if (peer == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002389 // 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 +02002390 // this thread yet.
2391 // TODO: if we identified threads to the debugger by their Thread*
2392 // rather than their peer's mirror::Object*, we could fix this.
2393 // Doing so might help us report ZOMBIE threads too.
2394 continue;
2395 }
Andreas Gampe08883de2016-11-08 13:20:52 -08002396 if (IsInDesiredThreadGroup(thread_group, peer)) {
Sebastien Hertz070f7322014-09-09 12:08:49 +02002397 thread_ids->push_back(gRegistry->Add(peer));
2398 }
2399 }
Elliott Hughescaf76542012-06-28 16:08:22 -07002400}
Elliott Hughesa2155262011-11-16 16:26:58 -08002401
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002402static int GetStackDepth(Thread* thread) REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002403 struct CountStackDepthVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002404 explicit CountStackDepthVisitor(Thread* thread_in)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002405 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2406 depth(0) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002407
Elliott Hughes64f574f2013-02-20 14:57:12 -08002408 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2409 // annotalysis.
2410 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers0399dde2012-06-06 17:09:28 -07002411 if (!GetMethod()->IsRuntimeMethod()) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08002412 ++depth;
2413 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002414 return true;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002415 }
2416 size_t depth;
2417 };
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002418
Ian Rogers7a22fa62013-01-23 12:16:16 -08002419 CountStackDepthVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07002420 visitor.WalkStack();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002421 return visitor.depth;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002422}
2423
Ian Rogersc0542af2014-09-03 16:16:56 -07002424JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002425 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002426 JDWP::JdwpError error;
2427 *result = 0;
2428 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002429 if (error != JDWP::ERR_NONE) {
2430 return error;
2431 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002432 if (!IsSuspendedForDebugger(soa, thread)) {
2433 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2434 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002435 *result = GetStackDepth(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08002436 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -08002437}
2438
Ian Rogers306057f2012-11-26 12:45:53 -08002439JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2440 size_t frame_count, JDWP::ExpandBuf* buf) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002441 class GetFrameVisitor : public StackVisitor {
2442 public:
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002443 GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2444 JDWP::ExpandBuf* buf_in)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002445 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002446 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2447 depth_(0),
2448 start_frame_(start_frame_in),
2449 frame_count_(frame_count_in),
2450 buf_(buf_in) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002451 expandBufAdd4BE(buf_, frame_count_);
Elliott Hughes03181a82011-11-17 17:22:21 -08002452 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002453
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002454 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002455 if (GetMethod()->IsRuntimeMethod()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002456 return true; // The debugger can't do anything useful with a frame that has no Method*.
Elliott Hughes03181a82011-11-17 17:22:21 -08002457 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002458 if (depth_ >= start_frame_ + frame_count_) {
Elliott Hughes530fa002012-03-12 11:44:49 -07002459 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08002460 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002461 if (depth_ >= start_frame_) {
2462 JDWP::FrameId frame_id(GetFrameId());
2463 JDWP::JdwpLocation location;
Sebastien Hertz6995c602014-09-09 12:10:13 +02002464 SetJdwpLocation(&location, GetMethod(), GetDexPc());
Ian Rogersef7d42f2014-01-06 12:55:46 -08002465 VLOG(jdwp) << StringPrintf(" Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002466 expandBufAdd8BE(buf_, frame_id);
2467 expandBufAddLocation(buf_, location);
2468 }
2469 ++depth_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002470 return true;
Elliott Hughes03181a82011-11-17 17:22:21 -08002471 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002472
2473 private:
2474 size_t depth_;
2475 const size_t start_frame_;
2476 const size_t frame_count_;
2477 JDWP::ExpandBuf* buf_;
Elliott Hughes03181a82011-11-17 17:22:21 -08002478 };
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002479
2480 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002481 JDWP::JdwpError error;
2482 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002483 if (error != JDWP::ERR_NONE) {
2484 return error;
2485 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002486 if (!IsSuspendedForDebugger(soa, thread)) {
2487 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2488 }
Ian Rogers7a22fa62013-01-23 12:16:16 -08002489 GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
Ian Rogers0399dde2012-06-06 17:09:28 -07002490 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002491 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002492}
2493
2494JDWP::ObjectId Dbg::GetThreadSelfId() {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002495 return GetThreadId(Thread::Current());
2496}
2497
2498JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002499 ScopedObjectAccessUnchecked soa(Thread::Current());
Nicolas Geoffraycafa0812017-02-15 18:27:34 +00002500 return gRegistry->Add(thread->GetPeerFromOtherThread());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002501}
2502
Elliott Hughes475fc232011-10-25 15:00:35 -07002503void Dbg::SuspendVM() {
Hiroshi Yamauchi8f95cf32016-04-19 11:14:06 -07002504 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
2505 gc::ScopedGCCriticalSection gcs(Thread::Current(),
2506 gc::kGcCauseDebugger,
2507 gc::kCollectorTypeDebugger);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002508 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002509}
2510
2511void Dbg::ResumeVM() {
Sebastien Hertz253fa552014-10-14 17:27:15 +02002512 Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002513}
2514
Elliott Hughes221229c2013-01-08 18:17:50 -08002515JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002516 Thread* self = Thread::Current();
Ian Rogersc0542af2014-09-03 16:16:56 -07002517 ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002518 {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002519 ScopedObjectAccess soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07002520 JDWP::JdwpError error;
2521 peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
Elliott Hughes4e235312011-12-02 11:34:15 -08002522 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002523 if (peer.get() == nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002524 return JDWP::ERR_THREAD_NOT_ALIVE;
2525 }
Ian Rogers4ad5cd32014-11-11 23:08:07 -08002526 // Suspend thread to build stack trace.
Elliott Hughesf327e072013-01-09 16:01:26 -08002527 bool timed_out;
Brian Carlstromba32de42014-08-27 23:43:46 -07002528 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Sebastien Hertzcdd798d2017-04-18 18:28:51 +02002529 Thread* thread = thread_list->SuspendThreadByPeer(peer.get(),
2530 request_suspension,
Alex Light46f93402017-06-29 11:59:50 -07002531 SuspendReason::kForDebugger,
Brian Carlstromba32de42014-08-27 23:43:46 -07002532 &timed_out);
Ian Rogersc0542af2014-09-03 16:16:56 -07002533 if (thread != nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002534 return JDWP::ERR_NONE;
Elliott Hughesf327e072013-01-09 16:01:26 -08002535 } else if (timed_out) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002536 return JDWP::ERR_INTERNAL;
2537 } else {
2538 return JDWP::ERR_THREAD_NOT_ALIVE;
2539 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002540}
2541
Elliott Hughes221229c2013-01-08 18:17:50 -08002542void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002543 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002544 JDWP::JdwpError error;
2545 mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2546 CHECK(peer != nullptr) << error;
jeffhaoa77f0f62012-12-05 17:19:31 -08002547 Thread* thread;
2548 {
2549 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2550 thread = Thread::FromManagedThread(soa, peer);
2551 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002552 if (thread == nullptr) {
Elliott Hughes4e235312011-12-02 11:34:15 -08002553 LOG(WARNING) << "No such thread for resume: " << peer;
2554 return;
2555 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002556 bool needs_resume;
2557 {
Ian Rogers50b35e22012-10-04 10:09:15 -07002558 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Sebastien Hertz70d60272017-04-14 14:18:36 +02002559 needs_resume = thread->GetDebugSuspendCount() > 0;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002560 }
2561 if (needs_resume) {
Alex Light88fd7202017-06-30 08:31:59 -07002562 bool resumed = Runtime::Current()->GetThreadList()->Resume(thread, SuspendReason::kForDebugger);
2563 DCHECK(resumed);
Elliott Hughes546b9862012-06-20 16:06:13 -07002564 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002565}
2566
2567void Dbg::SuspendSelf() {
Elliott Hughes475fc232011-10-25 15:00:35 -07002568 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002569}
2570
Ian Rogers0399dde2012-06-06 17:09:28 -07002571struct GetThisVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002572 GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002573 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002574 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2575 this_object(nullptr),
2576 frame_id(frame_id_in) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002577
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002578 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2579 // annotalysis.
2580 virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002581 if (frame_id != GetFrameId()) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002582 return true; // continue
Ian Rogers0399dde2012-06-06 17:09:28 -07002583 } else {
Ian Rogers62d6c772013-02-27 08:32:07 -08002584 this_object = GetThisObject();
2585 return false;
Ian Rogers0399dde2012-06-06 17:09:28 -07002586 }
Elliott Hughes86b00102011-12-05 17:54:26 -08002587 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002588
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002589 mirror::Object* this_object;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002590 JDWP::FrameId frame_id;
Ian Rogers0399dde2012-06-06 17:09:28 -07002591};
2592
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002593JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2594 JDWP::ObjectId* result) {
2595 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002596 JDWP::JdwpError error;
2597 Thread* thread = DecodeThread(soa, thread_id, &error);
2598 if (error != JDWP::ERR_NONE) {
2599 return error;
2600 }
2601 if (!IsSuspendedForDebugger(soa, thread)) {
2602 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002603 }
Ian Rogers700a4022014-05-19 16:49:03 -07002604 std::unique_ptr<Context> context(Context::Create());
Ian Rogers7a22fa62013-01-23 12:16:16 -08002605 GetThisVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002606 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002607 *result = gRegistry->Add(visitor.this_object);
2608 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002609}
2610
Sebastien Hertz8009f392014-09-01 17:07:11 +02002611// Walks the stack until we find the frame with the given FrameId.
2612class FindFrameVisitor FINAL : public StackVisitor {
2613 public:
2614 FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002615 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002616 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2617 frame_id_(frame_id),
2618 error_(JDWP::ERR_INVALID_FRAMEID) {}
Ian Rogersca190662012-06-26 15:45:57 -07002619
Sebastien Hertz8009f392014-09-01 17:07:11 +02002620 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2621 // annotalysis.
2622 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2623 if (GetFrameId() != frame_id_) {
2624 return true; // Not our frame, carry on.
Ian Rogers0399dde2012-06-06 17:09:28 -07002625 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002626 ArtMethod* m = GetMethod();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002627 if (m->IsNative()) {
2628 // We can't read/write local value from/into native method.
2629 error_ = JDWP::ERR_OPAQUE_FRAME;
2630 } else {
2631 // We found our frame.
2632 error_ = JDWP::ERR_NONE;
2633 }
2634 return false;
2635 }
2636
2637 JDWP::JdwpError GetError() const {
2638 return error_;
2639 }
2640
2641 private:
2642 const JDWP::FrameId frame_id_;
2643 JDWP::JdwpError error_;
Sebastien Hertz26f72862015-09-15 09:52:07 +02002644
2645 DISALLOW_COPY_AND_ASSIGN(FindFrameVisitor);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002646};
2647
2648JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2649 JDWP::ObjectId thread_id = request->ReadThreadId();
2650 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002651
2652 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002653 JDWP::JdwpError error;
2654 Thread* thread = DecodeThread(soa, thread_id, &error);
2655 if (error != JDWP::ERR_NONE) {
2656 return error;
2657 }
2658 if (!IsSuspendedForDebugger(soa, thread)) {
2659 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002660 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002661 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002662 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002663 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002664 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002665 if (visitor.GetError() != JDWP::ERR_NONE) {
2666 return visitor.GetError();
2667 }
2668
2669 // Read the values from visitor's context.
2670 int32_t slot_count = request->ReadSigned32("slot count");
2671 expandBufAdd4BE(pReply, slot_count); /* "int values" */
2672 for (int32_t i = 0; i < slot_count; ++i) {
2673 uint32_t slot = request->ReadUnsigned32("slot");
2674 JDWP::JdwpTag reqSigByte = request->ReadTag();
2675
2676 VLOG(jdwp) << " --> slot " << slot << " " << reqSigByte;
2677
2678 size_t width = Dbg::GetTagWidth(reqSigByte);
Sebastien Hertz7d955652014-10-22 10:57:10 +02002679 uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
Sebastien Hertz69206392015-04-07 15:54:25 +02002680 error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002681 if (error != JDWP::ERR_NONE) {
2682 return error;
2683 }
2684 }
2685 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002686}
2687
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002688constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2689
2690static std::string GetStackContextAsString(const StackVisitor& visitor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002691 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002692 return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
David Sehr709b0702016-10-13 09:12:37 -07002693 ArtMethod::PrettyMethod(visitor.GetMethod()).c_str());
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002694}
2695
2696static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2697 JDWP::JdwpTag tag)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002698 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002699 LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2700 << GetStackContextAsString(visitor);
2701 return kStackFrameLocalAccessError;
2702}
2703
Sebastien Hertz8009f392014-09-01 17:07:11 +02002704JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2705 int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002706 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002707 JDWP::JdwpError error = JDWP::ERR_NONE;
2708 uint16_t vreg = DemangleSlot(slot, m, &error);
2709 if (error != JDWP::ERR_NONE) {
2710 return error;
2711 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002712 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002713 switch (tag) {
2714 case JDWP::JT_BOOLEAN: {
2715 CHECK_EQ(width, 1U);
2716 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002717 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2718 return FailGetLocalValue(visitor, vreg, tag);
Ian Rogers0399dde2012-06-06 17:09:28 -07002719 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002720 VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2721 JDWP::Set1(buf + 1, intVal != 0);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002722 break;
Ian Rogers0399dde2012-06-06 17:09:28 -07002723 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002724 case JDWP::JT_BYTE: {
2725 CHECK_EQ(width, 1U);
2726 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002727 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2728 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002729 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002730 VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2731 JDWP::Set1(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002732 break;
2733 }
2734 case JDWP::JT_SHORT:
2735 case JDWP::JT_CHAR: {
2736 CHECK_EQ(width, 2U);
2737 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002738 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2739 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002740 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002741 VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2742 JDWP::Set2BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002743 break;
2744 }
2745 case JDWP::JT_INT: {
2746 CHECK_EQ(width, 4U);
2747 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002748 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2749 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002750 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002751 VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2752 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002753 break;
2754 }
2755 case JDWP::JT_FLOAT: {
2756 CHECK_EQ(width, 4U);
2757 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002758 if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2759 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002760 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002761 VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2762 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002763 break;
2764 }
2765 case JDWP::JT_ARRAY:
2766 case JDWP::JT_CLASS_LOADER:
2767 case JDWP::JT_CLASS_OBJECT:
2768 case JDWP::JT_OBJECT:
2769 case JDWP::JT_STRING:
2770 case JDWP::JT_THREAD:
2771 case JDWP::JT_THREAD_GROUP: {
2772 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2773 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002774 if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2775 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002776 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002777 mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2778 VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2779 if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2780 LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2781 reinterpret_cast<uintptr_t>(o), vreg)
2782 << GetStackContextAsString(visitor);
2783 UNREACHABLE();
2784 }
2785 tag = TagFromObject(soa, o);
2786 JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002787 break;
2788 }
2789 case JDWP::JT_DOUBLE: {
2790 CHECK_EQ(width, 8U);
2791 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002792 if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2793 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002794 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002795 VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2796 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002797 break;
2798 }
2799 case JDWP::JT_LONG: {
2800 CHECK_EQ(width, 8U);
2801 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002802 if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2803 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002804 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002805 VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2806 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002807 break;
2808 }
2809 default:
2810 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002811 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002812 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002813
Sebastien Hertz8009f392014-09-01 17:07:11 +02002814 // Prepend tag, which may have been updated.
2815 JDWP::Set1(buf, tag);
2816 return JDWP::ERR_NONE;
2817}
2818
2819JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2820 JDWP::ObjectId thread_id = request->ReadThreadId();
2821 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002822
2823 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002824 JDWP::JdwpError error;
2825 Thread* thread = DecodeThread(soa, thread_id, &error);
2826 if (error != JDWP::ERR_NONE) {
2827 return error;
2828 }
2829 if (!IsSuspendedForDebugger(soa, thread)) {
2830 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002831 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002832 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002833 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002834 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002835 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002836 if (visitor.GetError() != JDWP::ERR_NONE) {
2837 return visitor.GetError();
2838 }
2839
2840 // Writes the values into visitor's context.
2841 int32_t slot_count = request->ReadSigned32("slot count");
2842 for (int32_t i = 0; i < slot_count; ++i) {
2843 uint32_t slot = request->ReadUnsigned32("slot");
2844 JDWP::JdwpTag sigByte = request->ReadTag();
2845 size_t width = Dbg::GetTagWidth(sigByte);
2846 uint64_t value = request->ReadValue(width);
2847
2848 VLOG(jdwp) << " --> slot " << slot << " " << sigByte << " " << value;
Mingyao Yang99170c62015-07-06 11:10:37 -07002849 error = Dbg::SetLocalValue(thread, visitor, slot, sigByte, value, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002850 if (error != JDWP::ERR_NONE) {
2851 return error;
2852 }
2853 }
2854 return JDWP::ERR_NONE;
2855}
2856
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002857template<typename T>
2858static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2859 JDWP::JdwpTag tag, T value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002860 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002861 LOG(ERROR) << "Failed to write " << tag << " local " << value
2862 << " (0x" << std::hex << value << ") into register v" << vreg
2863 << GetStackContextAsString(visitor);
2864 return kStackFrameLocalAccessError;
2865}
2866
Mingyao Yang99170c62015-07-06 11:10:37 -07002867JDWP::JdwpError Dbg::SetLocalValue(Thread* thread, StackVisitor& visitor, int slot,
2868 JDWP::JdwpTag tag, uint64_t value, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002869 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002870 JDWP::JdwpError error = JDWP::ERR_NONE;
2871 uint16_t vreg = DemangleSlot(slot, m, &error);
2872 if (error != JDWP::ERR_NONE) {
2873 return error;
2874 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002875 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002876 switch (tag) {
2877 case JDWP::JT_BOOLEAN:
2878 case JDWP::JT_BYTE:
2879 CHECK_EQ(width, 1U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002880 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002881 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002882 }
2883 break;
2884 case JDWP::JT_SHORT:
2885 case JDWP::JT_CHAR:
2886 CHECK_EQ(width, 2U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002887 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002888 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002889 }
2890 break;
2891 case JDWP::JT_INT:
2892 CHECK_EQ(width, 4U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002893 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002894 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002895 }
2896 break;
2897 case JDWP::JT_FLOAT:
2898 CHECK_EQ(width, 4U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002899 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002900 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002901 }
2902 break;
2903 case JDWP::JT_ARRAY:
2904 case JDWP::JT_CLASS_LOADER:
2905 case JDWP::JT_CLASS_OBJECT:
2906 case JDWP::JT_OBJECT:
2907 case JDWP::JT_STRING:
2908 case JDWP::JT_THREAD:
2909 case JDWP::JT_THREAD_GROUP: {
2910 CHECK_EQ(width, sizeof(JDWP::ObjectId));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002911 mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2912 &error);
2913 if (error != JDWP::ERR_NONE) {
2914 VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2915 return JDWP::ERR_INVALID_OBJECT;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002916 }
Mingyao Yang636b9252015-07-31 16:40:24 -07002917 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002918 kReferenceVReg)) {
2919 return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002920 }
2921 break;
2922 }
2923 case JDWP::JT_DOUBLE: {
2924 CHECK_EQ(width, 8U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002925 if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002926 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002927 }
2928 break;
2929 }
2930 case JDWP::JT_LONG: {
2931 CHECK_EQ(width, 8U);
Mingyao Yang636b9252015-07-31 16:40:24 -07002932 if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002933 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002934 }
2935 break;
2936 }
2937 default:
2938 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002939 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002940 }
Mingyao Yang99170c62015-07-06 11:10:37 -07002941
2942 // If we set the local variable in a compiled frame, we need to trigger a deoptimization of
2943 // the stack so we continue execution with the interpreter using the new value(s) of the updated
2944 // local variable(s). To achieve this, we install instrumentation exit stub on each method of the
2945 // thread's stack. The stub will cause the deoptimization to happen.
2946 if (!visitor.IsShadowFrame() && thread->HasDebuggerShadowFrames()) {
2947 Runtime::Current()->GetInstrumentation()->InstrumentThreadStack(thread);
2948 }
2949
Sebastien Hertz8009f392014-09-01 17:07:11 +02002950 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002951}
2952
Mathieu Chartiere401d142015-04-22 13:56:20 -07002953static void SetEventLocation(JDWP::EventLocation* location, ArtMethod* m, uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002954 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002955 DCHECK(location != nullptr);
2956 if (m == nullptr) {
2957 memset(location, 0, sizeof(*location));
2958 } else {
Alex Light97e78032017-06-27 17:51:55 -07002959 location->method = m->GetCanonicalMethod(kRuntimePointerSize);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002960 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002961 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002962}
2963
Mathieu Chartiere401d142015-04-22 13:56:20 -07002964void Dbg::PostLocationEvent(ArtMethod* m, int dex_pc, mirror::Object* this_object,
Jeff Hao579b0242013-11-18 13:16:49 -08002965 int event_flags, const JValue* return_value) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002966 if (!IsDebuggerActive()) {
2967 return;
2968 }
2969 DCHECK(m != nullptr);
2970 DCHECK_EQ(m->IsStatic(), this_object == nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002971 JDWP::EventLocation location;
2972 SetEventLocation(&location, m, dex_pc);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002973
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002974 // We need to be sure no exception is pending when calling JdwpState::PostLocationEvent.
2975 // This is required to be able to call JNI functions to create JDWP ids. To achieve this,
2976 // we temporarily clear the current thread's exception (if any) and will restore it after
2977 // the call.
2978 // Note: the only way to get a pending exception here is to suspend on a move-exception
2979 // instruction.
2980 Thread* const self = Thread::Current();
2981 StackHandleScope<1> hs(self);
2982 Handle<mirror::Throwable> pending_exception(hs.NewHandle(self->GetException()));
2983 self->ClearException();
Andreas Gampefa4333d2017-02-14 11:10:34 -08002984 if (kIsDebugBuild && pending_exception != nullptr) {
Mathieu Chartier808c7a52017-12-15 11:19:33 -08002985 const Instruction& instr = location.method->DexInstructions().InstructionAt(location.dex_pc);
2986 CHECK_EQ(Instruction::MOVE_EXCEPTION, instr.Opcode());
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002987 }
2988
Sebastien Hertz6995c602014-09-09 12:10:13 +02002989 gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002990
Andreas Gampefa4333d2017-02-14 11:10:34 -08002991 if (pending_exception != nullptr) {
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002992 self->SetException(pending_exception.Get());
2993 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002994}
2995
Mathieu Chartiere401d142015-04-22 13:56:20 -07002996void Dbg::PostFieldAccessEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002997 mirror::Object* this_object, ArtField* f) {
Alex Lighte00ec302017-06-16 08:56:43 -07002998 // TODO We should send events for native methods.
2999 if (!IsDebuggerActive() || m->IsNative()) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003000 return;
3001 }
3002 DCHECK(m != nullptr);
3003 DCHECK(f != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02003004 JDWP::EventLocation location;
3005 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003006
Sebastien Hertz6995c602014-09-09 12:10:13 +02003007 gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003008}
3009
Mathieu Chartiere401d142015-04-22 13:56:20 -07003010void Dbg::PostFieldModificationEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07003011 mirror::Object* this_object, ArtField* f,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003012 const JValue* field_value) {
Alex Lighte00ec302017-06-16 08:56:43 -07003013 // TODO We should send events for native methods.
3014 if (!IsDebuggerActive() || m->IsNative()) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003015 return;
3016 }
3017 DCHECK(m != nullptr);
3018 DCHECK(f != nullptr);
3019 DCHECK(field_value != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02003020 JDWP::EventLocation location;
3021 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003022
Sebastien Hertz6995c602014-09-09 12:10:13 +02003023 gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02003024}
3025
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003026/**
3027 * Finds the location where this exception will be caught. We search until we reach the top
3028 * frame, in which case this exception is considered uncaught.
3029 */
3030class CatchLocationFinder : public StackVisitor {
3031 public:
3032 CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003033 REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003034 : StackVisitor(self, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003035 exception_(exception),
3036 handle_scope_(self),
3037 this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
Mathieu Chartiere401d142015-04-22 13:56:20 -07003038 catch_method_(nullptr),
3039 throw_method_(nullptr),
Andreas Gampee2abbc62017-09-15 11:59:26 -07003040 catch_dex_pc_(dex::kDexNoIndex),
3041 throw_dex_pc_(dex::kDexNoIndex) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003042 }
3043
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003044 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003045 ArtMethod* method = GetMethod();
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003046 DCHECK(method != nullptr);
3047 if (method->IsRuntimeMethod()) {
3048 // Ignore callee save method.
3049 DCHECK(method->IsCalleeSaveMethod());
3050 return true;
3051 }
3052
3053 uint32_t dex_pc = GetDexPc();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003054 if (throw_method_ == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003055 // First Java method found. It is either the method that threw the exception,
3056 // or the Java native method that is reporting an exception thrown by
3057 // native code.
3058 this_at_throw_.Assign(GetThisObject());
Mathieu Chartiere401d142015-04-22 13:56:20 -07003059 throw_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003060 throw_dex_pc_ = dex_pc;
3061 }
3062
Andreas Gampee2abbc62017-09-15 11:59:26 -07003063 if (dex_pc != dex::kDexNoIndex) {
Sebastien Hertz26f72862015-09-15 09:52:07 +02003064 StackHandleScope<1> hs(GetThread());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003065 uint32_t found_dex_pc;
3066 Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003067 bool unused_clear_exception;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003068 found_dex_pc = method->FindCatchBlock(exception_class, dex_pc, &unused_clear_exception);
Andreas Gampee2abbc62017-09-15 11:59:26 -07003069 if (found_dex_pc != dex::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003070 catch_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003071 catch_dex_pc_ = found_dex_pc;
3072 return false; // End stack walk.
3073 }
3074 }
3075 return true; // Continue stack walk.
3076 }
3077
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003078 ArtMethod* GetCatchMethod() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003079 return catch_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003080 }
3081
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003082 ArtMethod* GetThrowMethod() REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003083 return throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003084 }
3085
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003086 mirror::Object* GetThisAtThrow() REQUIRES_SHARED(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003087 return this_at_throw_.Get();
3088 }
3089
3090 uint32_t GetCatchDexPc() const {
3091 return catch_dex_pc_;
3092 }
3093
3094 uint32_t GetThrowDexPc() const {
3095 return throw_dex_pc_;
3096 }
3097
3098 private:
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003099 const Handle<mirror::Throwable>& exception_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003100 StackHandleScope<1> handle_scope_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003101 MutableHandle<mirror::Object> this_at_throw_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003102 ArtMethod* catch_method_;
3103 ArtMethod* throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003104 uint32_t catch_dex_pc_;
3105 uint32_t throw_dex_pc_;
3106
3107 DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
3108};
3109
3110void Dbg::PostException(mirror::Throwable* exception_object) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07003111 if (!IsDebuggerActive()) {
Ian Rogers0ad5bb82011-12-07 10:16:32 -08003112 return;
3113 }
Sebastien Hertz261bc042015-04-08 09:36:07 +02003114 Thread* const self = Thread::Current();
3115 StackHandleScope<1> handle_scope(self);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003116 Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
3117 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz261bc042015-04-08 09:36:07 +02003118 CatchLocationFinder clf(self, h_exception, context.get());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003119 clf.WalkStack(/* include_transitions */ false);
Sebastien Hertz6995c602014-09-09 12:10:13 +02003120 JDWP::EventLocation exception_throw_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003121 SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
Sebastien Hertz6995c602014-09-09 12:10:13 +02003122 JDWP::EventLocation exception_catch_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003123 SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
Elliott Hughes4740cdf2011-12-07 14:07:12 -08003124
Nicolas Geoffray14691c52015-03-05 10:40:17 +00003125 gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
3126 clf.GetThisAtThrow());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003127}
3128
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08003129void Dbg::PostClassPrepare(mirror::Class* c) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07003130 if (!IsDebuggerActive()) {
Elliott Hughes4740cdf2011-12-07 14:07:12 -08003131 return;
3132 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02003133 gJdwpState->PostClassPrepare(c);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003134}
3135
Ian Rogers62d6c772013-02-27 08:32:07 -08003136void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003137 ArtMethod* m, uint32_t dex_pc,
Sebastien Hertz8379b222014-02-24 17:38:15 +01003138 int event_flags, const JValue* return_value) {
Ian Rogers62d6c772013-02-27 08:32:07 -08003139 if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
Elliott Hughes2aa2e392012-02-17 17:15:43 -08003140 return;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003141 }
3142
Elliott Hughes86964332012-02-15 19:37:42 -08003143 if (IsBreakpoint(m, dex_pc)) {
3144 event_flags |= kBreakpoint;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003145 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003146
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003147 // If the debugger is single-stepping one of our threads, check to
3148 // see if we're that thread and we've reached a step point.
3149 const SingleStepControl* single_step_control = thread->GetSingleStepControl();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003150 if (single_step_control != nullptr) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003151 CHECK(!m->IsNative());
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003152 if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003153 // Step into method calls. We break when the line number
3154 // or method pointer changes. If we're in SS_MIN mode, we
3155 // always stop.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003156 if (single_step_control->GetMethod() != m) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003157 event_flags |= kSingleStep;
3158 VLOG(jdwp) << "SS new method";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003159 } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003160 event_flags |= kSingleStep;
3161 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003162 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003163 event_flags |= kSingleStep;
3164 VLOG(jdwp) << "SS new line";
3165 }
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003166 } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003167 // Step over method calls. We break when the line number is
3168 // different and the frame depth is <= the original frame
3169 // depth. (We can't just compare on the method, because we
3170 // might get unrolled past it by an exception, and it's tricky
3171 // to identify recursion.)
3172
3173 int stack_depth = GetStackDepth(thread);
3174
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003175 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003176 // Popped up one or more frames, always trigger.
3177 event_flags |= kSingleStep;
3178 VLOG(jdwp) << "SS method pop";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003179 } else if (stack_depth == single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003180 // Same depth, see if we moved.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003181 if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Elliott Hughes86964332012-02-15 19:37:42 -08003182 event_flags |= kSingleStep;
3183 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003184 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003185 event_flags |= kSingleStep;
3186 VLOG(jdwp) << "SS new line";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003187 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003188 }
3189 } else {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003190 CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003191 // Return from the current method. We break when the frame
3192 // depth pops up.
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003193
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003194 // This differs from the "method exit" break in that it stops
3195 // with the PC at the next instruction in the returned-to
3196 // function, rather than the end of the returning function.
Elliott Hughes86964332012-02-15 19:37:42 -08003197
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003198 int stack_depth = GetStackDepth(thread);
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003199 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003200 event_flags |= kSingleStep;
3201 VLOG(jdwp) << "SS method pop";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003202 }
3203 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003204 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003205
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003206 // If there's something interesting going on, see if it matches one
3207 // of the debugger filters.
3208 if (event_flags != 0) {
Sebastien Hertz8379b222014-02-24 17:38:15 +01003209 Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08003210 }
3211}
3212
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003213size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
3214 switch (instrumentation_event) {
3215 case instrumentation::Instrumentation::kMethodEntered:
3216 return &method_enter_event_ref_count_;
3217 case instrumentation::Instrumentation::kMethodExited:
3218 return &method_exit_event_ref_count_;
3219 case instrumentation::Instrumentation::kDexPcMoved:
3220 return &dex_pc_change_event_ref_count_;
3221 case instrumentation::Instrumentation::kFieldRead:
3222 return &field_read_event_ref_count_;
3223 case instrumentation::Instrumentation::kFieldWritten:
3224 return &field_write_event_ref_count_;
Alex Light6e1607e2017-08-23 10:06:18 -07003225 case instrumentation::Instrumentation::kExceptionThrown:
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003226 return &exception_catch_event_ref_count_;
3227 default:
3228 return nullptr;
3229 }
3230}
3231
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003232// Process request while all mutator threads are suspended.
3233void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003234 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003235 switch (request.GetKind()) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003236 case DeoptimizationRequest::kNothing:
3237 LOG(WARNING) << "Ignoring empty deoptimization request.";
3238 break;
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003239 case DeoptimizationRequest::kRegisterForEvent:
3240 VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003241 request.InstrumentationEvent());
3242 instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
3243 instrumentation_events_ |= request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003244 break;
3245 case DeoptimizationRequest::kUnregisterForEvent:
3246 VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003247 request.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003248 instrumentation->RemoveListener(&gDebugInstrumentationListener,
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003249 request.InstrumentationEvent());
3250 instrumentation_events_ &= ~request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003251 break;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003252 case DeoptimizationRequest::kFullDeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003253 VLOG(jdwp) << "Deoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003254 instrumentation->DeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003255 VLOG(jdwp) << "Deoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003256 break;
3257 case DeoptimizationRequest::kFullUndeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003258 VLOG(jdwp) << "Undeoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003259 instrumentation->UndeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003260 VLOG(jdwp) << "Undeoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003261 break;
3262 case DeoptimizationRequest::kSelectiveDeoptimization:
David Sehr709b0702016-10-13 09:12:37 -07003263 VLOG(jdwp) << "Deoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " ...";
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003264 instrumentation->Deoptimize(request.Method());
David Sehr709b0702016-10-13 09:12:37 -07003265 VLOG(jdwp) << "Deoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003266 break;
3267 case DeoptimizationRequest::kSelectiveUndeoptimization:
David Sehr709b0702016-10-13 09:12:37 -07003268 VLOG(jdwp) << "Undeoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " ...";
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003269 instrumentation->Undeoptimize(request.Method());
David Sehr709b0702016-10-13 09:12:37 -07003270 VLOG(jdwp) << "Undeoptimize method " << ArtMethod::PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003271 break;
3272 default:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003273 LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003274 break;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003275 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003276}
3277
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003278void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003279 if (req.GetKind() == DeoptimizationRequest::kNothing) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003280 // Nothing to do.
3281 return;
3282 }
Brian Carlstrom306db812014-09-05 13:01:41 -07003283 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003284 RequestDeoptimizationLocked(req);
3285}
3286
3287void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003288 switch (req.GetKind()) {
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003289 case DeoptimizationRequest::kRegisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003290 DCHECK_NE(req.InstrumentationEvent(), 0u);
3291 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003292 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003293 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003294 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003295 VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003296 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003297 deoptimization_requests_.push_back(req);
3298 }
3299 *counter = *counter + 1;
3300 break;
3301 }
3302 case DeoptimizationRequest::kUnregisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003303 DCHECK_NE(req.InstrumentationEvent(), 0u);
3304 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003305 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003306 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003307 *counter = *counter - 1;
3308 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003309 VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003310 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003311 deoptimization_requests_.push_back(req);
3312 }
3313 break;
3314 }
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003315 case DeoptimizationRequest::kFullDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003316 DCHECK(req.Method() == nullptr);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003317 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003318 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3319 << " for full deoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003320 deoptimization_requests_.push_back(req);
3321 }
3322 ++full_deoptimization_event_count_;
3323 break;
3324 }
3325 case DeoptimizationRequest::kFullUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003326 DCHECK(req.Method() == nullptr);
Sebastien Hertze713d932014-05-15 10:48:53 +02003327 DCHECK_GT(full_deoptimization_event_count_, 0U);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003328 --full_deoptimization_event_count_;
3329 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003330 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3331 << " for full undeoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003332 deoptimization_requests_.push_back(req);
3333 }
3334 break;
3335 }
3336 case DeoptimizationRequest::kSelectiveDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003337 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003338 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
David Sehr709b0702016-10-13 09:12:37 -07003339 << " for deoptimization of " << req.Method()->PrettyMethod();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003340 deoptimization_requests_.push_back(req);
3341 break;
3342 }
3343 case DeoptimizationRequest::kSelectiveUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003344 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003345 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
David Sehr709b0702016-10-13 09:12:37 -07003346 << " for undeoptimization of " << req.Method()->PrettyMethod();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003347 deoptimization_requests_.push_back(req);
3348 break;
3349 }
3350 default: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003351 LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003352 break;
3353 }
3354 }
3355}
3356
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003357void Dbg::ManageDeoptimization() {
3358 Thread* const self = Thread::Current();
3359 {
3360 // Avoid suspend/resume if there is no pending request.
Brian Carlstrom306db812014-09-05 13:01:41 -07003361 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003362 if (deoptimization_requests_.empty()) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003363 return;
3364 }
3365 }
3366 CHECK_EQ(self->GetState(), kRunnable);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003367 ScopedThreadSuspension sts(self, kWaitingForDeoptimization);
Mathieu Chartieraa516822015-10-02 15:53:37 -07003368 // Required for ProcessDeoptimizationRequest.
3369 gc::ScopedGCCriticalSection gcs(self,
3370 gc::kGcCauseInstrumentation,
3371 gc::kCollectorTypeInstrumentation);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003372 // We need to suspend mutator threads first.
Mathieu Chartier4f55e222015-09-04 13:26:21 -07003373 ScopedSuspendAll ssa(__FUNCTION__);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003374 const ThreadState old_state = self->SetStateUnsafe(kRunnable);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003375 {
Brian Carlstrom306db812014-09-05 13:01:41 -07003376 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003377 size_t req_index = 0;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003378 for (DeoptimizationRequest& request : deoptimization_requests_) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003379 VLOG(jdwp) << "Process deoptimization request #" << req_index++;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003380 ProcessDeoptimizationRequest(request);
3381 }
3382 deoptimization_requests_.clear();
3383 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003384 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003385}
3386
Mathieu Chartiere401d142015-04-22 13:56:20 -07003387static const Breakpoint* FindFirstBreakpointForMethod(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003388 REQUIRES_SHARED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003389 for (Breakpoint& breakpoint : gBreakpoints) {
Alex Light6c8467f2015-11-20 15:03:26 -08003390 if (breakpoint.IsInMethod(m)) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003391 return &breakpoint;
3392 }
3393 }
3394 return nullptr;
3395}
3396
Mathieu Chartiere401d142015-04-22 13:56:20 -07003397bool Dbg::MethodHasAnyBreakpoints(ArtMethod* method) {
Mathieu Chartierd8565452015-03-26 09:41:50 -07003398 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3399 return FindFirstBreakpointForMethod(method) != nullptr;
3400}
3401
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003402// Sanity checks all existing breakpoints on the same method.
Mathieu Chartiere401d142015-04-22 13:56:20 -07003403static void SanityCheckExistingBreakpoints(ArtMethod* m,
Sebastien Hertzf3928792014-11-17 19:00:37 +01003404 DeoptimizationRequest::Kind deoptimization_kind)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003405 REQUIRES_SHARED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003406 for (const Breakpoint& breakpoint : gBreakpoints) {
Alex Light6c8467f2015-11-20 15:03:26 -08003407 if (breakpoint.IsInMethod(m)) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003408 CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3409 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003410 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003411 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3412 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003413 // We should have deoptimized everything but not "selectively" deoptimized this method.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003414 CHECK(instrumentation->AreAllMethodsDeoptimized());
3415 CHECK(!instrumentation->IsDeoptimized(m));
3416 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003417 // We should have "selectively" deoptimized this method.
3418 // Note: while we have not deoptimized everything for this method, we may have done it for
3419 // another event.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003420 CHECK(instrumentation->IsDeoptimized(m));
3421 } else {
3422 // This method does not require deoptimization.
3423 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3424 CHECK(!instrumentation->IsDeoptimized(m));
3425 }
3426}
3427
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003428// Returns the deoptimization kind required to set a breakpoint in a method.
3429// If a breakpoint has already been set, we also return the first breakpoint
3430// through the given 'existing_brkpt' pointer.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003431static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003432 ArtMethod* m,
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003433 const Breakpoint** existing_brkpt)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003434 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003435 if (!Dbg::RequiresDeoptimization()) {
3436 // We already run in interpreter-only mode so we don't need to deoptimize anything.
3437 VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
David Sehr709b0702016-10-13 09:12:37 -07003438 << ArtMethod::PrettyMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003439 return DeoptimizationRequest::kNothing;
3440 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003441 const Breakpoint* first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003442 {
3443 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003444 first_breakpoint = FindFirstBreakpointForMethod(m);
3445 *existing_brkpt = first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003446 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003447
3448 if (first_breakpoint == nullptr) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003449 // There is no breakpoint on this method yet: we need to deoptimize. If this method is default,
3450 // we deoptimize everything; otherwise we deoptimize only this method. We
Alex Light6c8467f2015-11-20 15:03:26 -08003451 // deoptimize with defaults because we do not know everywhere they are used. It is possible some
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003452 // of the copies could be missed.
Alex Light6c8467f2015-11-20 15:03:26 -08003453 // TODO Deoptimizing on default methods might not be necessary in all cases.
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003454 bool need_full_deoptimization = m->IsDefault();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003455 if (need_full_deoptimization) {
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003456 VLOG(jdwp) << "Need full deoptimization because of copying of method "
David Sehr709b0702016-10-13 09:12:37 -07003457 << ArtMethod::PrettyMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003458 return DeoptimizationRequest::kFullDeoptimization;
3459 } else {
3460 // We don't need to deoptimize if the method has not been compiled.
Nicolas Geoffraya5891e82015-11-06 14:18:27 +00003461 const bool is_compiled = m->HasAnyCompiledCode();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003462 if (is_compiled) {
David Sehr709b0702016-10-13 09:12:37 -07003463 VLOG(jdwp) << "Need selective deoptimization for compiled method "
3464 << ArtMethod::PrettyMethod(m);
Nicolas Geoffray6300fd72016-03-18 09:40:17 +00003465 return DeoptimizationRequest::kSelectiveDeoptimization;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003466 } else {
3467 // Method is not compiled: we don't need to deoptimize.
David Sehr709b0702016-10-13 09:12:37 -07003468 VLOG(jdwp) << "No need for deoptimization for non-compiled method "
3469 << ArtMethod::PrettyMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003470 return DeoptimizationRequest::kNothing;
3471 }
3472 }
3473 } else {
3474 // There is at least one breakpoint for this method: we don't need to deoptimize.
3475 // Let's check that all breakpoints are configured the same way for deoptimization.
3476 VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003477 DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003478 if (kIsDebugBuild) {
3479 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3480 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3481 }
3482 return DeoptimizationRequest::kNothing;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003483 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003484}
3485
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003486// Installs a breakpoint at the specified location. Also indicates through the deoptimization
3487// request if we need to deoptimize.
3488void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3489 Thread* const self = Thread::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003490 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003491 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003492
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003493 const Breakpoint* existing_breakpoint = nullptr;
3494 const DeoptimizationRequest::Kind deoptimization_kind =
3495 GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003496 req->SetKind(deoptimization_kind);
3497 if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3498 req->SetMethod(m);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003499 } else {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003500 CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3501 deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003502 req->SetMethod(nullptr);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003503 }
3504
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003505 {
3506 WriterMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003507 // If there is at least one existing breakpoint on the same method, the new breakpoint
3508 // must have the same deoptimization kind than the existing breakpoint(s).
3509 DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3510 if (existing_breakpoint != nullptr) {
3511 breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3512 } else {
3513 breakpoint_deoptimization_kind = deoptimization_kind;
3514 }
3515 gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003516 VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3517 << gBreakpoints[gBreakpoints.size() - 1];
3518 }
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003519}
3520
3521// Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3522// request if we need to undeoptimize.
3523void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
Sebastien Hertzed2be172014-08-19 15:33:43 +02003524 WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003525 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003526 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003527 DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003528 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Alex Light6c8467f2015-11-20 15:03:26 -08003529 if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].IsInMethod(m)) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003530 VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
Sebastien Hertzf3928792014-11-17 19:00:37 +01003531 deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3532 DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3533 Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003534 gBreakpoints.erase(gBreakpoints.begin() + i);
3535 break;
3536 }
3537 }
3538 const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3539 if (existing_breakpoint == nullptr) {
3540 // There is no more breakpoint on this method: we need to undeoptimize.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003541 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003542 // This method required full deoptimization: we need to undeoptimize everything.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003543 req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3544 req->SetMethod(nullptr);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003545 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003546 // This method required selective deoptimization: we need to undeoptimize only that method.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003547 req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3548 req->SetMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003549 } else {
3550 // This method had no need for deoptimization: do nothing.
3551 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3552 req->SetKind(DeoptimizationRequest::kNothing);
3553 req->SetMethod(nullptr);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003554 }
3555 } else {
3556 // There is at least one breakpoint for this method: we don't need to undeoptimize.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003557 req->SetKind(DeoptimizationRequest::kNothing);
3558 req->SetMethod(nullptr);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003559 if (kIsDebugBuild) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003560 SanityCheckExistingBreakpoints(m, deoptimization_kind);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003561 }
Elliott Hughes86964332012-02-15 19:37:42 -08003562 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003563}
3564
Mathieu Chartiere401d142015-04-22 13:56:20 -07003565bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003566 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3567 if (ssc == nullptr) {
3568 // If we are not single-stepping, then we don't have to force interpreter.
3569 return false;
3570 }
3571 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3572 // If we are in interpreter only mode, then we don't have to force interpreter.
3573 return false;
3574 }
3575
3576 if (!m->IsNative() && !m->IsProxyMethod()) {
3577 // If we want to step into a method, then we have to force interpreter on that call.
3578 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3579 return true;
3580 }
3581 }
3582 return false;
3583}
3584
Mathieu Chartiere401d142015-04-22 13:56:20 -07003585bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003586 instrumentation::Instrumentation* const instrumentation =
3587 Runtime::Current()->GetInstrumentation();
3588 // If we are in interpreter only mode, then we don't have to force interpreter.
3589 if (instrumentation->InterpretOnly()) {
3590 return false;
3591 }
3592 // We can only interpret pure Java method.
3593 if (m->IsNative() || m->IsProxyMethod()) {
3594 return false;
3595 }
3596 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3597 if (ssc != nullptr) {
3598 // If we want to step into a method, then we have to force interpreter on that call.
3599 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3600 return true;
3601 }
3602 // If we are stepping out from a static initializer, by issuing a step
3603 // in or step over, that was implicitly invoked by calling a static method,
3604 // then we need to step into that method. Having a lower stack depth than
3605 // the one the single step control has indicates that the step originates
3606 // from the static initializer.
3607 if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3608 ssc->GetStackDepth() > GetStackDepth(thread)) {
3609 return true;
3610 }
3611 }
3612 // There are cases where we have to force interpreter on deoptimized methods,
3613 // because in some cases the call will not be performed by invoking an entry
3614 // point that has been replaced by the deoptimization, but instead by directly
3615 // invoking the compiled code of the method, for example.
3616 return instrumentation->IsDeoptimized(m);
3617}
3618
Mathieu Chartiere401d142015-04-22 13:56:20 -07003619bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003620 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003621 if (m == nullptr) {
3622 return false;
3623 }
3624 instrumentation::Instrumentation* const instrumentation =
3625 Runtime::Current()->GetInstrumentation();
3626 // If we are in interpreter only mode, then we don't have to force interpreter.
3627 if (instrumentation->InterpretOnly()) {
3628 return false;
3629 }
3630 // We can only interpret pure Java method.
3631 if (m->IsNative() || m->IsProxyMethod()) {
3632 return false;
3633 }
3634 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3635 if (ssc != nullptr) {
3636 // If we are stepping out from a static initializer, by issuing a step
3637 // out, that was implicitly invoked by calling a static method, then we
3638 // need to step into the caller of that method. Having a lower stack
3639 // depth than the one the single step control has indicates that the
3640 // step originates from the static initializer.
3641 if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3642 ssc->GetStackDepth() > GetStackDepth(thread)) {
3643 return true;
3644 }
3645 }
3646 // If we are returning from a static intializer, that was implicitly
3647 // invoked by calling a static method and the caller is deoptimized,
3648 // then we have to deoptimize the stack without forcing interpreter
3649 // on the static method that was called originally. This problem can
3650 // be solved easily by forcing instrumentation on the called method,
3651 // because the instrumentation exit hook will recognise the need of
3652 // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3653 return instrumentation->IsDeoptimized(m);
3654}
3655
Mathieu Chartiere401d142015-04-22 13:56:20 -07003656bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003657 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003658 if (m == nullptr) {
3659 return false;
3660 }
3661 instrumentation::Instrumentation* const instrumentation =
3662 Runtime::Current()->GetInstrumentation();
3663 // If we are in interpreter only mode, then we don't have to force interpreter.
3664 if (instrumentation->InterpretOnly()) {
3665 return false;
3666 }
3667 // We can only interpret pure Java method.
3668 if (m->IsNative() || m->IsProxyMethod()) {
3669 return false;
3670 }
3671 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3672 if (ssc != nullptr) {
3673 // The debugger is not interested in what is happening under the level
3674 // of the step, thus we only force interpreter when we are not below of
3675 // the step.
3676 if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3677 return true;
3678 }
3679 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003680 if (thread->HasDebuggerShadowFrames()) {
3681 // We need to deoptimize the stack for the exception handling flow so that
3682 // we don't miss any deoptimization that should be done when there are
3683 // debugger shadow frames.
3684 return true;
3685 }
Daniel Mihalyieb076692014-08-22 17:33:31 +02003686 // We have to require stack deoptimization if the upcall is deoptimized.
3687 return instrumentation->IsDeoptimized(m);
3688}
3689
Mingyao Yang99170c62015-07-06 11:10:37 -07003690class NeedsDeoptimizationVisitor : public StackVisitor {
Sebastien Hertz520633b2015-09-08 17:03:36 +02003691 public:
3692 explicit NeedsDeoptimizationVisitor(Thread* self)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003693 REQUIRES_SHARED(Locks::mutator_lock_)
Sebastien Hertz520633b2015-09-08 17:03:36 +02003694 : StackVisitor(self, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3695 needs_deoptimization_(false) {}
3696
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003697 bool VisitFrame() OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz520633b2015-09-08 17:03:36 +02003698 // The visitor is meant to be used when handling exception from compiled code only.
David Sehr709b0702016-10-13 09:12:37 -07003699 CHECK(!IsShadowFrame()) << "We only expect to visit compiled frame: "
3700 << ArtMethod::PrettyMethod(GetMethod());
Sebastien Hertz520633b2015-09-08 17:03:36 +02003701 ArtMethod* method = GetMethod();
3702 if (method == nullptr) {
3703 // We reach an upcall and don't need to deoptimize this part of the stack (ManagedFragment)
3704 // so we can stop the visit.
3705 DCHECK(!needs_deoptimization_);
3706 return false;
3707 }
3708 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3709 // We found a compiled frame in the stack but instrumentation is set to interpret
3710 // everything: we need to deoptimize.
3711 needs_deoptimization_ = true;
3712 return false;
3713 }
3714 if (Runtime::Current()->GetInstrumentation()->IsDeoptimized(method)) {
3715 // We found a deoptimized method in the stack.
3716 needs_deoptimization_ = true;
3717 return false;
3718 }
Mingyao Yang99170c62015-07-06 11:10:37 -07003719 ShadowFrame* frame = GetThread()->FindDebuggerShadowFrame(GetFrameId());
3720 if (frame != nullptr) {
3721 // The debugger allocated a ShadowFrame to update a variable in the stack: we need to
3722 // deoptimize the stack to execute (and deallocate) this frame.
3723 needs_deoptimization_ = true;
3724 return false;
3725 }
Sebastien Hertz520633b2015-09-08 17:03:36 +02003726 return true;
3727 }
3728
3729 bool NeedsDeoptimization() const {
3730 return needs_deoptimization_;
3731 }
3732
3733 private:
3734 // Do we need to deoptimize the stack?
3735 bool needs_deoptimization_;
3736
3737 DISALLOW_COPY_AND_ASSIGN(NeedsDeoptimizationVisitor);
3738};
3739
3740// Do we need to deoptimize the stack to handle an exception?
3741bool Dbg::IsForcedInterpreterNeededForExceptionImpl(Thread* thread) {
3742 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3743 if (ssc != nullptr) {
3744 // We deopt to step into the catch handler.
3745 return true;
3746 }
3747 // Deoptimization is required if at least one method in the stack needs it. However we
3748 // skip frames that will be unwound (thus not executed).
3749 NeedsDeoptimizationVisitor visitor(thread);
3750 visitor.WalkStack(true); // includes upcall.
3751 return visitor.NeedsDeoptimization();
3752}
3753
Jeff Hao449db332013-04-12 18:30:52 -07003754// Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3755// cause suspension if the thread is the current thread.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003756class ScopedDebuggerThreadSuspension {
Jeff Hao449db332013-04-12 18:30:52 -07003757 public:
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003758 ScopedDebuggerThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
Mathieu Chartier90443472015-07-16 20:32:27 -07003759 REQUIRES(!Locks::thread_list_lock_)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003760 REQUIRES_SHARED(Locks::mutator_lock_) :
Ian Rogersf3d874c2014-07-17 18:52:42 -07003761 thread_(nullptr),
Jeff Hao449db332013-04-12 18:30:52 -07003762 error_(JDWP::ERR_NONE),
3763 self_suspend_(false),
Ian Rogers33e95662013-05-20 20:29:14 -07003764 other_suspend_(false) {
Jeff Hao449db332013-04-12 18:30:52 -07003765 ScopedObjectAccessUnchecked soa(self);
Sebastien Hertz69206392015-04-07 15:54:25 +02003766 thread_ = DecodeThread(soa, thread_id, &error_);
Jeff Hao449db332013-04-12 18:30:52 -07003767 if (error_ == JDWP::ERR_NONE) {
3768 if (thread_ == soa.Self()) {
3769 self_suspend_ = true;
3770 } else {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003771 Thread* suspended_thread;
3772 {
3773 ScopedThreadSuspension sts(self, kWaitingForDebuggerSuspension);
3774 jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
3775 bool timed_out;
3776 ThreadList* const thread_list = Runtime::Current()->GetThreadList();
Sebastien Hertzcdd798d2017-04-18 18:28:51 +02003777 suspended_thread = thread_list->SuspendThreadByPeer(thread_peer,
3778 /* request_suspension */ true,
Alex Light46f93402017-06-29 11:59:50 -07003779 SuspendReason::kForDebugger,
Sebastien Hertzcdd798d2017-04-18 18:28:51 +02003780 &timed_out);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003781 }
Ian Rogersf3d874c2014-07-17 18:52:42 -07003782 if (suspended_thread == nullptr) {
Jeff Hao449db332013-04-12 18:30:52 -07003783 // Thread terminated from under us while suspending.
3784 error_ = JDWP::ERR_INVALID_THREAD;
3785 } else {
3786 CHECK_EQ(suspended_thread, thread_);
3787 other_suspend_ = true;
3788 }
3789 }
3790 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003791 }
Elliott Hughes86964332012-02-15 19:37:42 -08003792
Jeff Hao449db332013-04-12 18:30:52 -07003793 Thread* GetThread() const {
3794 return thread_;
3795 }
3796
3797 JDWP::JdwpError GetError() const {
3798 return error_;
3799 }
3800
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003801 ~ScopedDebuggerThreadSuspension() {
Jeff Hao449db332013-04-12 18:30:52 -07003802 if (other_suspend_) {
Alex Light88fd7202017-06-30 08:31:59 -07003803 bool resumed = Runtime::Current()->GetThreadList()->Resume(thread_,
3804 SuspendReason::kForDebugger);
3805 DCHECK(resumed);
Jeff Hao449db332013-04-12 18:30:52 -07003806 }
3807 }
3808
3809 private:
3810 Thread* thread_;
3811 JDWP::JdwpError error_;
3812 bool self_suspend_;
3813 bool other_suspend_;
3814};
3815
3816JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3817 JDWP::JdwpStepDepth step_depth) {
3818 Thread* self = Thread::Current();
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07003819 ScopedDebuggerThreadSuspension sts(self, thread_id);
Jeff Hao449db332013-04-12 18:30:52 -07003820 if (sts.GetError() != JDWP::ERR_NONE) {
3821 return sts.GetError();
3822 }
3823
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003824 // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
Elliott Hughes2435a572012-02-17 16:07:41 -08003825 // is for step-out.
Ian Rogers0399dde2012-06-06 17:09:28 -07003826 struct SingleStepStackVisitor : public StackVisitor {
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07003827 explicit SingleStepStackVisitor(Thread* thread) REQUIRES_SHARED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003828 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3829 stack_depth(0),
3830 method(nullptr),
3831 line_number(-1) {}
Ian Rogersca190662012-06-26 15:45:57 -07003832
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003833 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3834 // annotalysis.
3835 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003836 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07003837 if (!m->IsRuntimeMethod()) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003838 ++stack_depth;
3839 if (method == nullptr) {
Alex Light73376312017-04-06 10:10:51 -07003840 const DexFile* dex_file = m->GetDexFile();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003841 method = m;
Alex Light73376312017-04-06 10:10:51 -07003842 if (dex_file != nullptr) {
David Sehr9323e6e2016-09-13 08:58:35 -07003843 line_number = annotations::GetLineNumFromPC(dex_file, m, GetDexPc());
Elliott Hughes2435a572012-02-17 16:07:41 -08003844 }
Elliott Hughes86964332012-02-15 19:37:42 -08003845 }
3846 }
Elliott Hughes530fa002012-03-12 11:44:49 -07003847 return true;
Elliott Hughes86964332012-02-15 19:37:42 -08003848 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003849
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003850 int stack_depth;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003851 ArtMethod* method;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003852 int32_t line_number;
Elliott Hughes86964332012-02-15 19:37:42 -08003853 };
Jeff Hao449db332013-04-12 18:30:52 -07003854
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003855 Thread* const thread = sts.GetThread();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003856 SingleStepStackVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07003857 visitor.WalkStack();
Elliott Hughes86964332012-02-15 19:37:42 -08003858
Elliott Hughes2435a572012-02-17 16:07:41 -08003859 // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
Elliott Hughes2435a572012-02-17 16:07:41 -08003860 struct DebugCallbackContext {
Roland Levillain3887c462015-08-12 18:15:42 +01003861 DebugCallbackContext(SingleStepControl* single_step_control_cb,
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08003862 int32_t line_number_cb, uint32_t num_insns_in_code_units)
Roland Levillain3887c462015-08-12 18:15:42 +01003863 : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08003864 num_insns_in_code_units_(num_insns_in_code_units), last_pc_valid(false), last_pc(0) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003865 }
3866
David Srbeckyb06e28e2015-12-10 13:15:00 +00003867 static bool Callback(void* raw_context, const DexFile::PositionInfo& entry) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003868 DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
David Srbeckyb06e28e2015-12-10 13:15:00 +00003869 if (static_cast<int32_t>(entry.line_) == context->line_number_) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003870 if (!context->last_pc_valid) {
3871 // Everything from this address until the next line change is ours.
David Srbeckyb06e28e2015-12-10 13:15:00 +00003872 context->last_pc = entry.address_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003873 context->last_pc_valid = true;
3874 }
3875 // Otherwise, if we're already in a valid range for this line,
3876 // just keep going (shouldn't really happen)...
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003877 } else if (context->last_pc_valid) { // and the line number is new
Elliott Hughes2435a572012-02-17 16:07:41 -08003878 // Add everything from the last entry up until here to the set
David Srbeckyb06e28e2015-12-10 13:15:00 +00003879 for (uint32_t dex_pc = context->last_pc; dex_pc < entry.address_; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003880 context->single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003881 }
3882 context->last_pc_valid = false;
3883 }
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003884 return false; // There may be multiple entries for any given line.
Elliott Hughes2435a572012-02-17 16:07:41 -08003885 }
3886
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003887 ~DebugCallbackContext() {
Elliott Hughes2435a572012-02-17 16:07:41 -08003888 // If the line number was the last in the position table...
3889 if (last_pc_valid) {
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08003890 for (uint32_t dex_pc = last_pc; dex_pc < num_insns_in_code_units_; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003891 single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003892 }
3893 }
3894 }
3895
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003896 SingleStepControl* const single_step_control_;
3897 const int32_t line_number_;
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08003898 const uint32_t num_insns_in_code_units_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003899 bool last_pc_valid;
3900 uint32_t last_pc;
3901 };
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003902
3903 // Allocate single step.
Sebastien Hertz1558b572015-02-25 15:05:59 +01003904 SingleStepControl* single_step_control =
3905 new (std::nothrow) SingleStepControl(step_size, step_depth,
3906 visitor.stack_depth, visitor.method);
3907 if (single_step_control == nullptr) {
3908 LOG(ERROR) << "Failed to allocate SingleStepControl";
3909 return JDWP::ERR_OUT_OF_MEMORY;
3910 }
3911
Mathieu Chartiere401d142015-04-22 13:56:20 -07003912 ArtMethod* m = single_step_control->GetMethod();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003913 const int32_t line_number = visitor.line_number;
Sebastien Hertz52f5f932015-05-28 11:00:57 +02003914 // Note: if the thread is not running Java code (pure native thread), there is no "current"
3915 // method on the stack (and no line number either).
3916 if (m != nullptr && !m->IsNative()) {
David Sehr0225f8e2018-01-31 08:52:24 +00003917 CodeItemDebugInfoAccessor accessor(m->DexInstructionDebugInfo());
Mathieu Chartier31f4c9f2017-12-08 15:46:11 -08003918 DebugCallbackContext context(single_step_control, line_number, accessor.InsnsSizeInCodeUnits());
3919 m->GetDexFile()->DecodeDebugPositionInfo(accessor.DebugInfoOffset(),
3920 DebugCallbackContext::Callback,
3921 &context);
Elliott Hughes3e2e1a22012-02-21 11:33:41 -08003922 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003923
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003924 // Activate single-step in the thread.
3925 thread->ActivateSingleStepControl(single_step_control);
Elliott Hughes86964332012-02-15 19:37:42 -08003926
Elliott Hughes2435a572012-02-17 16:07:41 -08003927 if (VLOG_IS_ON(jdwp)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003928 VLOG(jdwp) << "Single-step thread: " << *thread;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003929 VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3930 VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
David Sehr709b0702016-10-13 09:12:37 -07003931 VLOG(jdwp) << "Single-step current method: "
3932 << ArtMethod::PrettyMethod(single_step_control->GetMethod());
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003933 VLOG(jdwp) << "Single-step current line: " << line_number;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003934 VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
Elliott Hughes2435a572012-02-17 16:07:41 -08003935 VLOG(jdwp) << "Single-step dex_pc values:";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003936 for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003937 VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003938 }
3939 }
3940
3941 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003942}
3943
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003944void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3945 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07003946 JDWP::JdwpError error;
3947 Thread* thread = DecodeThread(soa, thread_id, &error);
Sebastien Hertz87118ed2013-11-26 17:57:18 +01003948 if (error == JDWP::ERR_NONE) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003949 thread->DeactivateSingleStepControl();
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003950 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003951}
3952
Elliott Hughes45651fd2012-02-21 15:48:20 -08003953static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3954 switch (tag) {
3955 default:
3956 LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
Ian Rogersfc787ec2014-10-09 21:56:44 -07003957 UNREACHABLE();
Elliott Hughes45651fd2012-02-21 15:48:20 -08003958
3959 // Primitives.
3960 case JDWP::JT_BYTE: return 'B';
3961 case JDWP::JT_CHAR: return 'C';
3962 case JDWP::JT_FLOAT: return 'F';
3963 case JDWP::JT_DOUBLE: return 'D';
3964 case JDWP::JT_INT: return 'I';
3965 case JDWP::JT_LONG: return 'J';
3966 case JDWP::JT_SHORT: return 'S';
3967 case JDWP::JT_VOID: return 'V';
3968 case JDWP::JT_BOOLEAN: return 'Z';
3969
3970 // Reference types.
3971 case JDWP::JT_ARRAY:
3972 case JDWP::JT_OBJECT:
3973 case JDWP::JT_STRING:
3974 case JDWP::JT_THREAD:
3975 case JDWP::JT_THREAD_GROUP:
3976 case JDWP::JT_CLASS_LOADER:
3977 case JDWP::JT_CLASS_OBJECT:
3978 return 'L';
3979 }
3980}
3981
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003982JDWP::JdwpError Dbg::PrepareInvokeMethod(uint32_t request_id, JDWP::ObjectId thread_id,
3983 JDWP::ObjectId object_id, JDWP::RefTypeId class_id,
3984 JDWP::MethodId method_id, uint32_t arg_count,
3985 uint64_t arg_values[], JDWP::JdwpTag* arg_types,
3986 uint32_t options) {
3987 Thread* const self = Thread::Current();
3988 CHECK_EQ(self, GetDebugThread()) << "This must be called by the JDWP thread";
Sebastien Hertzd4032e42015-06-12 15:47:34 +02003989 const bool resume_all_threads = ((options & JDWP::INVOKE_SINGLE_THREADED) == 0);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003990
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003991 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Ian Rogersc0542af2014-09-03 16:16:56 -07003992 Thread* targetThread = nullptr;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003993 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003994 ScopedObjectAccessUnchecked soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07003995 JDWP::JdwpError error;
3996 targetThread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08003997 if (error != JDWP::ERR_NONE) {
3998 LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3999 return error;
Elliott Hughesd07986f2011-12-06 18:27:45 -08004000 }
Sebastien Hertz1558b572015-02-25 15:05:59 +01004001 if (targetThread->GetInvokeReq() != nullptr) {
4002 // Thread is already invoking a method on behalf of the debugger.
4003 LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
4004 return JDWP::ERR_ALREADY_INVOKING;
4005 }
4006 if (!targetThread->IsReadyForDebugInvoke()) {
4007 // Thread is not suspended by an event so it cannot invoke a method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08004008 LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
4009 return JDWP::ERR_INVALID_THREAD;
4010 }
4011
4012 /*
Sebastien Hertzd4032e42015-06-12 15:47:34 +02004013 * According to the JDWP specs, we are expected to resume all threads (or only the
4014 * target thread) once. So if a thread has been suspended more than once (either by
4015 * the debugger for an event or by the runtime for GC), it will remain suspended before
4016 * the invoke is executed. This means the debugger is responsible to properly resume all
4017 * the threads it has suspended so the target thread can execute the method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08004018 *
Sebastien Hertzd4032e42015-06-12 15:47:34 +02004019 * However, for compatibility reason with older versions of debuggers (like Eclipse), we
4020 * fully resume all threads (by canceling *all* debugger suspensions) when the debugger
4021 * wants us to resume all threads. This is to avoid ending up in deadlock situation.
4022 *
4023 * On the other hand, if we are asked to only resume the target thread, then we follow the
4024 * JDWP specs by resuming that thread only once. This means the thread will remain suspended
4025 * if it has been suspended more than once before the invoke (and again, this is the
4026 * responsibility of the debugger to properly resume that thread before invoking a method).
Elliott Hughesd07986f2011-12-06 18:27:45 -08004027 */
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004028 int suspend_count;
4029 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004030 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004031 suspend_count = targetThread->GetSuspendCount();
4032 }
Sebastien Hertzd4032e42015-06-12 15:47:34 +02004033 if (suspend_count > 1 && resume_all_threads) {
4034 // The target thread will remain suspended even after we resume it. Let's emit a warning
4035 // to indicate the invoke won't be executed until the thread is resumed.
4036 LOG(WARNING) << *targetThread << " suspended more than once (suspend count == "
4037 << suspend_count << "). This thread will invoke the method only once "
4038 << "it is fully resumed.";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004039 }
4040
Ian Rogersc0542af2014-09-03 16:16:56 -07004041 mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
4042 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08004043 return JDWP::ERR_INVALID_OBJECT;
4044 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08004045
Sebastien Hertz1558b572015-02-25 15:05:59 +01004046 gRegistry->Get<mirror::Object*>(thread_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07004047 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08004048 return JDWP::ERR_INVALID_OBJECT;
4049 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08004050
Ian Rogersc0542af2014-09-03 16:16:56 -07004051 mirror::Class* c = DecodeClass(class_id, &error);
4052 if (c == nullptr) {
4053 return error;
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08004054 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08004055
Mathieu Chartiere401d142015-04-22 13:56:20 -07004056 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07004057 if (m->IsStatic() != (receiver == nullptr)) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08004058 return JDWP::ERR_INVALID_METHODID;
4059 }
4060 if (m->IsStatic()) {
4061 if (m->GetDeclaringClass() != c) {
4062 return JDWP::ERR_INVALID_METHODID;
4063 }
4064 } else {
4065 if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
4066 return JDWP::ERR_INVALID_METHODID;
4067 }
4068 }
4069
4070 // Check the argument list matches the method.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004071 uint32_t shorty_len = 0;
4072 const char* shorty = m->GetShorty(&shorty_len);
4073 if (shorty_len - 1 != arg_count) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08004074 return JDWP::ERR_ILLEGAL_ARGUMENT;
4075 }
Elliott Hughes09201632013-04-15 15:50:07 -07004076
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004077 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07004078 StackHandleScope<2> hs(soa.Self());
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004079 HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
4080 HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
4081 const DexFile::TypeList* types = m->GetParameterTypeList();
4082 for (size_t i = 0; i < arg_count; ++i) {
4083 if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
Elliott Hughes09201632013-04-15 15:50:07 -07004084 return JDWP::ERR_ILLEGAL_ARGUMENT;
4085 }
4086
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004087 if (shorty[i + 1] == 'L') {
4088 // Did we really get an argument of an appropriate reference type?
Vladimir Markob45528c2017-07-27 14:14:28 +01004089 ObjPtr<mirror::Class> parameter_type =
4090 m->ResolveClassFromTypeIndex(types->GetTypeItem(i).type_idx_);
Ian Rogersc0542af2014-09-03 16:16:56 -07004091 mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
4092 if (error != JDWP::ERR_NONE) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004093 return JDWP::ERR_INVALID_OBJECT;
4094 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004095 if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004096 return JDWP::ERR_ILLEGAL_ARGUMENT;
4097 }
4098
4099 // Turn the on-the-wire ObjectId into a jobject.
4100 jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
4101 v.l = gRegistry->GetJObject(arg_values[i]);
4102 }
Elliott Hughes09201632013-04-15 15:50:07 -07004103 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08004104 }
4105
Sebastien Hertz1558b572015-02-25 15:05:59 +01004106 // Allocates a DebugInvokeReq.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004107 DebugInvokeReq* req = new (std::nothrow) DebugInvokeReq(request_id, thread_id, receiver, c, m,
4108 options, arg_values, arg_count);
4109 if (req == nullptr) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004110 LOG(ERROR) << "Failed to allocate DebugInvokeReq";
4111 return JDWP::ERR_OUT_OF_MEMORY;
4112 }
4113
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004114 // Attaches the DebugInvokeReq to the target thread so it executes the method when
4115 // it is resumed. Once the invocation completes, the target thread will delete it before
4116 // suspending itself (see ThreadList::SuspendSelfForDebugger).
4117 targetThread->SetDebugInvokeReq(req);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004118 }
4119
4120 // 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 +02004121 // away we're sitting high and dry -- but we must release this before the UndoDebuggerSuspensions
4122 // call.
Sebastien Hertzd4032e42015-06-12 15:47:34 +02004123 if (resume_all_threads) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004124 VLOG(jdwp) << " Resuming all threads";
4125 thread_list->UndoDebuggerSuspensions();
4126 } else {
4127 VLOG(jdwp) << " Resuming event thread only";
Alex Light88fd7202017-06-30 08:31:59 -07004128 bool resumed = thread_list->Resume(targetThread, SuspendReason::kForDebugger);
4129 DCHECK(resumed);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004130 }
4131
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004132 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004133}
4134
4135void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004136 Thread* const self = Thread::Current();
4137 CHECK_NE(self, GetDebugThread()) << "This must be called by the event thread";
4138
4139 ScopedObjectAccess soa(self);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004140
Elliott Hughes81ff3182012-03-23 20:35:56 -07004141 // We can be called while an exception is pending. We need
Elliott Hughesd07986f2011-12-06 18:27:45 -08004142 // to preserve that across the method invocation.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004143 StackHandleScope<1> hs(soa.Self());
4144 Handle<mirror::Throwable> old_exception = hs.NewHandle(soa.Self()->GetException());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004145 soa.Self()->ClearException();
Elliott Hughesd07986f2011-12-06 18:27:45 -08004146
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004147 // Execute the method then sends reply to the debugger.
4148 ExecuteMethodWithoutPendingException(soa, pReq);
4149
4150 // If an exception was pending before the invoke, restore it now.
Andreas Gampefa4333d2017-02-14 11:10:34 -08004151 if (old_exception != nullptr) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004152 soa.Self()->SetException(old_exception.Get());
4153 }
4154}
4155
4156// Helper function: write a variable-width value into the output input buffer.
4157static void WriteValue(JDWP::ExpandBuf* pReply, int width, uint64_t value) {
4158 switch (width) {
4159 case 1:
4160 expandBufAdd1(pReply, value);
4161 break;
4162 case 2:
4163 expandBufAdd2BE(pReply, value);
4164 break;
4165 case 4:
4166 expandBufAdd4BE(pReply, value);
4167 break;
4168 case 8:
4169 expandBufAdd8BE(pReply, value);
4170 break;
4171 default:
4172 LOG(FATAL) << width;
4173 UNREACHABLE();
4174 }
4175}
4176
4177void Dbg::ExecuteMethodWithoutPendingException(ScopedObjectAccess& soa, DebugInvokeReq* pReq) {
4178 soa.Self()->AssertNoPendingException();
4179
Elliott Hughesd07986f2011-12-06 18:27:45 -08004180 // Translate the method through the vtable, unless the debugger wants to suppress it.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004181 ArtMethod* m = pReq->method;
Andreas Gampe542451c2016-07-26 09:02:02 -07004182 PointerSize image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
Sebastien Hertz1558b572015-02-25 15:05:59 +01004183 if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07004184 ArtMethod* actual_method =
4185 pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m, image_pointer_size);
4186 if (actual_method != m) {
David Sehr709b0702016-10-13 09:12:37 -07004187 VLOG(jdwp) << "ExecuteMethod translated " << ArtMethod::PrettyMethod(m)
4188 << " to " << ArtMethod::PrettyMethod(actual_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07004189 m = actual_method;
Elliott Hughes45651fd2012-02-21 15:48:20 -08004190 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08004191 }
David Sehr709b0702016-10-13 09:12:37 -07004192 VLOG(jdwp) << "ExecuteMethod " << ArtMethod::PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01004193 << " receiver=" << pReq->receiver.Read()
Sebastien Hertzd38667a2013-11-25 15:43:54 +01004194 << " arg_count=" << pReq->arg_count;
Mathieu Chartiere401d142015-04-22 13:56:20 -07004195 CHECK(m != nullptr);
Elliott Hughesd07986f2011-12-06 18:27:45 -08004196
Roland Levillain33d69032015-06-18 18:20:59 +01004197 static_assert(sizeof(jvalue) == sizeof(uint64_t), "jvalue and uint64_t have different sizes.");
Elliott Hughesd07986f2011-12-06 18:27:45 -08004198
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004199 // Invoke the method.
Jeff Hao39b6c242015-05-19 20:30:23 -07004200 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(pReq->receiver.Read()));
Andreas Gampe13b27842016-11-07 16:48:23 -08004201 JValue result = InvokeWithJValues(soa, ref.get(), jni::EncodeArtMethod(m),
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004202 reinterpret_cast<jvalue*>(pReq->arg_values.get()));
Elliott Hughesd07986f2011-12-06 18:27:45 -08004203
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004204 // Prepare JDWP ids for the reply.
4205 JDWP::JdwpTag result_tag = BasicTagFromDescriptor(m->GetShorty());
4206 const bool is_object_result = (result_tag == JDWP::JT_OBJECT);
Jeff Hao064d24e2016-08-25 03:52:40 +00004207 StackHandleScope<3> hs(soa.Self());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004208 Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
4209 Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
4210 soa.Self()->ClearException();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004211
4212 if (!IsDebuggerActive()) {
4213 // The debugger detached: we must not re-suspend threads. We also don't need to fill the reply
4214 // because it won't be sent either.
4215 return;
4216 }
4217
4218 JDWP::ObjectId exceptionObjectId = gRegistry->Add(exception);
4219 uint64_t result_value = 0;
4220 if (exceptionObjectId != 0) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01004221 VLOG(jdwp) << " JDWP invocation returning with exception=" << exception.Get()
4222 << " " << exception->Dump();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004223 result_value = 0;
Sebastien Hertz1558b572015-02-25 15:05:59 +01004224 } else if (is_object_result) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004225 /* if no exception was thrown, examine object result more closely */
Sebastien Hertz1558b572015-02-25 15:05:59 +01004226 JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004227 if (new_tag != result_tag) {
4228 VLOG(jdwp) << " JDWP promoted result from " << result_tag << " to " << new_tag;
4229 result_tag = new_tag;
Elliott Hughesd07986f2011-12-06 18:27:45 -08004230 }
4231
Sebastien Hertz1558b572015-02-25 15:05:59 +01004232 // Register the object in the registry and reference its ObjectId. This ensures
4233 // GC safety and prevents from accessing stale reference if the object is moved.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004234 result_value = gRegistry->Add(object_result.Get());
Sebastien Hertz1558b572015-02-25 15:05:59 +01004235 } else {
4236 // Primitive result.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004237 DCHECK(IsPrimitiveTag(result_tag));
4238 result_value = result.GetJ();
4239 }
4240 const bool is_constructor = m->IsConstructor() && !m->IsStatic();
4241 if (is_constructor) {
4242 // If we invoked a constructor (which actually returns void), return the receiver,
4243 // unless we threw, in which case we return null.
Sebastien Hertza3e13772015-11-05 12:09:44 +01004244 DCHECK_EQ(JDWP::JT_VOID, result_tag);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004245 if (exceptionObjectId == 0) {
Jeff Hao064d24e2016-08-25 03:52:40 +00004246 if (m->GetDeclaringClass()->IsStringClass()) {
4247 // For string constructors, the new string is remapped to the receiver (stored in ref).
4248 Handle<mirror::Object> decoded_ref = hs.NewHandle(soa.Self()->DecodeJObject(ref.get()));
4249 result_value = gRegistry->Add(decoded_ref);
4250 result_tag = TagFromObject(soa, decoded_ref.Get());
4251 } else {
4252 // TODO we could keep the receiver ObjectId in the DebugInvokeReq to avoid looking into the
4253 // object registry.
4254 result_value = GetObjectRegistry()->Add(pReq->receiver.Read());
4255 result_tag = TagFromObject(soa, pReq->receiver.Read());
4256 }
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004257 } else {
4258 result_value = 0;
Sebastien Hertza3e13772015-11-05 12:09:44 +01004259 result_tag = JDWP::JT_OBJECT;
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004260 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08004261 }
4262
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004263 // Suspend other threads if the invoke is not single-threaded.
4264 if ((pReq->options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004265 ScopedThreadSuspension sts(soa.Self(), kWaitingForDebuggerSuspension);
Hiroshi Yamauchi8f95cf32016-04-19 11:14:06 -07004266 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
4267 gc::ScopedGCCriticalSection gcs(soa.Self(), gc::kGcCauseDebugger, gc::kCollectorTypeDebugger);
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004268 VLOG(jdwp) << " Suspending all threads";
4269 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02004270 }
4271
4272 VLOG(jdwp) << " --> returned " << result_tag
4273 << StringPrintf(" %#" PRIx64 " (except=%#" PRIx64 ")", result_value,
4274 exceptionObjectId);
4275
4276 // Show detailed debug output.
4277 if (result_tag == JDWP::JT_STRING && exceptionObjectId == 0) {
4278 if (result_value != 0) {
4279 if (VLOG_IS_ON(jdwp)) {
4280 std::string result_string;
4281 JDWP::JdwpError error = Dbg::StringToUtf8(result_value, &result_string);
4282 CHECK_EQ(error, JDWP::ERR_NONE);
4283 VLOG(jdwp) << " string '" << result_string << "'";
4284 }
4285 } else {
4286 VLOG(jdwp) << " string (null)";
4287 }
4288 }
4289
4290 // Attach the reply to DebugInvokeReq so it can be sent to the debugger when the event thread
4291 // is ready to suspend.
4292 BuildInvokeReply(pReq->reply, pReq->request_id, result_tag, result_value, exceptionObjectId);
4293}
4294
4295void Dbg::BuildInvokeReply(JDWP::ExpandBuf* pReply, uint32_t request_id, JDWP::JdwpTag result_tag,
4296 uint64_t result_value, JDWP::ObjectId exception) {
4297 // Make room for the JDWP header since we do not know the size of the reply yet.
4298 JDWP::expandBufAddSpace(pReply, kJDWPHeaderLen);
4299
4300 size_t width = GetTagWidth(result_tag);
4301 JDWP::expandBufAdd1(pReply, result_tag);
4302 if (width != 0) {
4303 WriteValue(pReply, width, result_value);
4304 }
4305 JDWP::expandBufAdd1(pReply, JDWP::JT_OBJECT);
4306 JDWP::expandBufAddObjectId(pReply, exception);
4307
4308 // Now we know the size, we can complete the JDWP header.
4309 uint8_t* buf = expandBufGetBuffer(pReply);
4310 JDWP::Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReply));
4311 JDWP::Set4BE(buf + kJDWPHeaderIdOffset, request_id);
4312 JDWP::Set1(buf + kJDWPHeaderFlagsOffset, kJDWPFlagReply); // flags
4313 JDWP::Set2BE(buf + kJDWPHeaderErrorCodeOffset, JDWP::ERR_NONE);
4314}
4315
4316void Dbg::FinishInvokeMethod(DebugInvokeReq* pReq) {
4317 CHECK_NE(Thread::Current(), GetDebugThread()) << "This must be called by the event thread";
4318
4319 JDWP::ExpandBuf* const pReply = pReq->reply;
4320 CHECK(pReply != nullptr) << "No reply attached to DebugInvokeReq";
4321
4322 // We need to prevent other threads (including JDWP thread) from interacting with the debugger
4323 // while we send the reply but are not yet suspended. The JDWP token will be released just before
4324 // we suspend ourself again (see ThreadList::SuspendSelfForDebugger).
4325 gJdwpState->AcquireJdwpTokenForEvent(pReq->thread_id);
4326
4327 // Send the reply unless the debugger detached before the completion of the method.
4328 if (IsDebuggerActive()) {
4329 const size_t replyDataLength = expandBufGetLength(pReply) - kJDWPHeaderLen;
4330 VLOG(jdwp) << StringPrintf("REPLY INVOKE id=0x%06x (length=%zu)",
4331 pReq->request_id, replyDataLength);
4332
4333 gJdwpState->SendRequest(pReply);
4334 } else {
4335 VLOG(jdwp) << "Not sending invoke reply because debugger detached";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004336 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004337}
4338
Alex Light8c2b9292017-11-09 13:21:01 -08004339bool Dbg::DdmHandleChunk(JNIEnv* env,
4340 uint32_t type,
4341 const ArrayRef<const jbyte>& data,
4342 /*out*/uint32_t* out_type,
4343 /*out*/std::vector<uint8_t>* out_data) {
4344 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(data.size()));
Ian Rogersc0542af2014-09-03 16:16:56 -07004345 if (dataArray.get() == nullptr) {
Alex Light8c2b9292017-11-09 13:21:01 -08004346 LOG(WARNING) << "byte[] allocation failed: " << data.size();
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004347 env->ExceptionClear();
4348 return false;
4349 }
Alex Light8c2b9292017-11-09 13:21:01 -08004350 env->SetByteArrayRegion(dataArray.get(),
4351 0,
4352 data.size(),
4353 reinterpret_cast<const jbyte*>(data.data()));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004354 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
Alex Light8c2b9292017-11-09 13:21:01 -08004355 ScopedLocalRef<jobject> chunk(
4356 env,
4357 env->CallStaticObjectMethod(
4358 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4359 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
4360 type, dataArray.get(), 0, data.size()));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004361 if (env->ExceptionCheck()) {
4362 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
4363 env->ExceptionDescribe();
4364 env->ExceptionClear();
4365 return false;
4366 }
4367
Ian Rogersc0542af2014-09-03 16:16:56 -07004368 if (chunk.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004369 return false;
4370 }
4371
4372 /*
4373 * Pull the pieces out of the chunk. We copy the results into a
4374 * newly-allocated buffer that the caller can free. We don't want to
4375 * continue using the Chunk object because nothing has a reference to it.
4376 *
4377 * We could avoid this by returning type/data/offset/length and having
4378 * the caller be aware of the object lifetime issues, but that
Elliott Hughes81ff3182012-03-23 20:35:56 -07004379 * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004380 * if we have responses for multiple chunks.
4381 *
4382 * So we're pretty much stuck with copying data around multiple times.
4383 */
Alex Light8c2b9292017-11-09 13:21:01 -08004384 ScopedLocalRef<jbyteArray> replyData(
4385 env,
4386 reinterpret_cast<jbyteArray>(
4387 env->GetObjectField(
4388 chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_data)));
4389 jint offset = env->GetIntField(chunk.get(),
4390 WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
4391 jint length = env->GetIntField(chunk.get(),
4392 WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
4393 *out_type = env->GetIntField(chunk.get(),
4394 WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004395
Alex Light8c2b9292017-11-09 13:21:01 -08004396 VLOG(jdwp) << StringPrintf("DDM reply: type=0x%08x data=%p offset=%d length=%d",
4397 type,
4398 replyData.get(),
4399 offset,
4400 length);
Alex Light8c2b9292017-11-09 13:21:01 -08004401 out_data->resize(length);
4402 env->GetByteArrayRegion(replyData.get(),
4403 offset,
4404 length,
4405 reinterpret_cast<jbyte*>(out_data->data()));
Alex Light6f2a6342017-12-12 09:55:05 -08004406
Alex Lighte5463a82017-12-12 13:33:28 -08004407 if (env->ExceptionCheck()) {
4408 LOG(INFO) << StringPrintf("Exception thrown when reading response data from dispatcher 0x%08x",
4409 type);
4410 env->ExceptionDescribe();
4411 env->ExceptionClear();
4412 return false;
4413 }
4414
Alex Light8c2b9292017-11-09 13:21:01 -08004415 return true;
4416}
4417
4418/*
4419 * "request" contains a full JDWP packet, possibly with multiple chunks. We
4420 * need to process each, accumulate the replies, and ship the whole thing
4421 * back.
4422 *
4423 * Returns "true" if we have a reply. The reply buffer is newly allocated,
4424 * and includes the chunk type/length, followed by the data.
4425 *
4426 * OLD-TODO: we currently assume that the request and reply include a single
4427 * chunk. If this becomes inconvenient we will need to adapt.
4428 */
4429bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
4430 Thread* self = Thread::Current();
4431 JNIEnv* env = self->GetJniEnv();
4432
4433 uint32_t type = request->ReadUnsigned32("type");
4434 uint32_t length = request->ReadUnsigned32("length");
4435
4436 // Create a byte[] corresponding to 'request'.
4437 size_t request_length = request->size();
4438 // Run through and find all chunks. [Currently just find the first.]
4439 if (length != request_length) {
4440 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004441 return false;
4442 }
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004443
Alex Light8c2b9292017-11-09 13:21:01 -08004444 ArrayRef<const jbyte> data(reinterpret_cast<const jbyte*>(request->data()), request_length);
4445 std::vector<uint8_t> out_data;
4446 uint32_t out_type = 0;
4447 request->Skip(request_length);
Alex Light6f2a6342017-12-12 09:55:05 -08004448 if (!DdmHandleChunk(env, type, data, &out_type, &out_data) || out_data.empty()) {
Alex Light8c2b9292017-11-09 13:21:01 -08004449 return false;
4450 }
4451 const uint32_t kDdmHeaderSize = 8;
4452 *pReplyLen = out_data.size() + kDdmHeaderSize;
4453 *pReplyBuf = new uint8_t[out_data.size() + kDdmHeaderSize];
4454 memcpy((*pReplyBuf) + kDdmHeaderSize, out_data.data(), out_data.size());
4455 JDWP::Set4BE(*pReplyBuf, out_type);
4456 JDWP::Set4BE((*pReplyBuf) + 4, static_cast<uint32_t>(out_data.size()));
4457 VLOG(jdwp)
4458 << StringPrintf("dvmHandleDdm returning type=%.4s", reinterpret_cast<char*>(*pReplyBuf))
4459 << "0x" << std::hex << reinterpret_cast<uintptr_t>(*pReplyBuf) << std::dec
4460 << " len= " << out_data.size();
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004461 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004462}
4463
Elliott Hughesa2155262011-11-16 16:26:58 -08004464void Dbg::DdmBroadcast(bool connect) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004465 VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
Elliott Hughes47fce012011-10-25 18:37:19 -07004466
4467 Thread* self = Thread::Current();
Ian Rogers50b35e22012-10-04 10:09:15 -07004468 if (self->GetState() != kRunnable) {
4469 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4470 /* try anyway? */
Elliott Hughes47fce012011-10-25 18:37:19 -07004471 }
4472
4473 JNIEnv* env = self->GetJniEnv();
Elliott Hughes47fce012011-10-25 18:37:19 -07004474 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
Elliott Hugheseac76672012-05-24 21:56:51 -07004475 env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4476 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4477 event);
Elliott Hughes47fce012011-10-25 18:37:19 -07004478 if (env->ExceptionCheck()) {
4479 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4480 env->ExceptionDescribe();
4481 env->ExceptionClear();
4482 }
4483}
4484
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004485void Dbg::DdmConnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004486 Dbg::DdmBroadcast(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004487}
4488
4489void Dbg::DdmDisconnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004490 Dbg::DdmBroadcast(false);
Elliott Hughes47fce012011-10-25 18:37:19 -07004491 gDdmThreadNotification = false;
4492}
4493
4494/*
Elliott Hughes82188472011-11-07 18:11:48 -08004495 * Send a notification when a thread starts, stops, or changes its name.
Elliott Hughes47fce012011-10-25 18:37:19 -07004496 *
4497 * Because we broadcast the full set of threads when the notifications are
4498 * first enabled, it's possible for "thread" to be actively executing.
4499 */
Elliott Hughes82188472011-11-07 18:11:48 -08004500void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004501 if (!gDdmThreadNotification) {
4502 return;
4503 }
4504
Alex Light772099a2017-11-21 14:05:04 -08004505 RuntimeCallbacks* cb = Runtime::Current()->GetRuntimeCallbacks();
Elliott Hughes82188472011-11-07 18:11:48 -08004506 if (type == CHUNK_TYPE("THDE")) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004507 uint8_t buf[4];
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004508 JDWP::Set4BE(&buf[0], t->GetThreadId());
Alex Light772099a2017-11-21 14:05:04 -08004509 cb->DdmPublishChunk(CHUNK_TYPE("THDE"), ArrayRef<const uint8_t>(buf));
Elliott Hughes82188472011-11-07 18:11:48 -08004510 } else {
4511 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004512 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07004513 StackHandleScope<1> hs(soa.Self());
Andreas Gampe08883de2016-11-08 13:20:52 -08004514 Handle<mirror::String> name(hs.NewHandle(t->GetThreadName()));
Andreas Gampefa4333d2017-02-14 11:10:34 -08004515 size_t char_count = (name != nullptr) ? name->GetLength() : 0;
4516 const jchar* chars = (name != nullptr) ? name->GetValue() : nullptr;
4517 bool is_compressed = (name != nullptr) ? name->IsCompressed() : false;
Elliott Hughes82188472011-11-07 18:11:48 -08004518
Elliott Hughes21f32d72011-11-09 17:44:13 -08004519 std::vector<uint8_t> bytes;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004520 JDWP::Append4BE(bytes, t->GetThreadId());
jessicahandojo3aaa37b2016-07-29 14:46:37 -07004521 if (is_compressed) {
4522 const uint8_t* chars_compressed = name->GetValueCompressed();
4523 JDWP::AppendUtf16CompressedBE(bytes, chars_compressed, char_count);
4524 } else {
4525 JDWP::AppendUtf16BE(bytes, chars, char_count);
4526 }
Elliott Hughes21f32d72011-11-09 17:44:13 -08004527 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
Alex Light772099a2017-11-21 14:05:04 -08004528 cb->DdmPublishChunk(type, ArrayRef<const uint8_t>(bytes));
Elliott Hughes47fce012011-10-25 18:37:19 -07004529 }
4530}
4531
Elliott Hughes47fce012011-10-25 18:37:19 -07004532void Dbg::DdmSetThreadNotification(bool enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004533 // Enable/disable thread notifications.
Elliott Hughes47fce012011-10-25 18:37:19 -07004534 gDdmThreadNotification = enable;
4535 if (enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004536 // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4537 // see a suspension in progress and block until that ends. They then post their own start
4538 // notification.
4539 SuspendVM();
4540 std::list<Thread*> threads;
Ian Rogers50b35e22012-10-04 10:09:15 -07004541 Thread* self = Thread::Current();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004542 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004543 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004544 threads = Runtime::Current()->GetThreadList()->GetList();
4545 }
4546 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004547 ScopedObjectAccess soa(self);
Mathieu Chartier02e25112013-08-14 16:14:24 -07004548 for (Thread* thread : threads) {
4549 Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004550 }
4551 }
4552 ResumeVM();
Elliott Hughes47fce012011-10-25 18:37:19 -07004553 }
4554}
4555
Elliott Hughesa2155262011-11-16 16:26:58 -08004556void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07004557 if (IsDebuggerActive()) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02004558 gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004559 }
Elliott Hughes82188472011-11-07 18:11:48 -08004560 Dbg::DdmSendThreadNotification(t, type);
Elliott Hughes47fce012011-10-25 18:37:19 -07004561}
4562
4563void Dbg::PostThreadStart(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004564 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004565}
4566
4567void Dbg::PostThreadDeath(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004568 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004569}
4570
Mathieu Chartierad466ad2015-01-08 16:28:08 -08004571JDWP::JdwpState* Dbg::GetJdwpState() {
4572 return gJdwpState;
4573}
4574
Elliott Hughes767a1472011-10-26 18:49:02 -07004575int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4576 if (when == HPIF_WHEN_NOW) {
Elliott Hughes7162ad92011-10-27 14:08:42 -07004577 DdmSendHeapInfo(when);
Elliott Hughes767a1472011-10-26 18:49:02 -07004578 return true;
4579 }
4580
4581 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4582 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4583 return false;
4584 }
4585
4586 gDdmHpifWhen = when;
4587 return true;
4588}
4589
4590bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4591 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4592 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4593 return false;
4594 }
4595
4596 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4597 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4598 return false;
4599 }
4600
4601 if (native) {
4602 gDdmNhsgWhen = when;
4603 gDdmNhsgWhat = what;
4604 } else {
4605 gDdmHpsgWhen = when;
4606 gDdmHpsgWhat = what;
4607 }
4608 return true;
4609}
4610
Elliott Hughes7162ad92011-10-27 14:08:42 -07004611void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4612 // If there's a one-shot 'when', reset it.
4613 if (reason == gDdmHpifWhen) {
4614 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4615 gDdmHpifWhen = HPIF_WHEN_NEVER;
4616 }
4617 }
4618
4619 /*
4620 * Chunk HPIF (client --> server)
4621 *
4622 * Heap Info. General information about the heap,
4623 * suitable for a summary display.
4624 *
4625 * [u4]: number of heaps
4626 *
4627 * For each heap:
4628 * [u4]: heap ID
4629 * [u8]: timestamp in ms since Unix epoch
4630 * [u1]: capture reason (same as 'when' value from server)
4631 * [u4]: max heap size in bytes (-Xmx)
4632 * [u4]: current heap size in bytes
4633 * [u4]: current number of bytes allocated
4634 * [u4]: current number of objects allocated
4635 */
4636 uint8_t heap_count = 1;
Ian Rogers1d54e732013-05-02 21:10:01 -07004637 gc::Heap* heap = Runtime::Current()->GetHeap();
Elliott Hughes21f32d72011-11-09 17:44:13 -08004638 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08004639 JDWP::Append4BE(bytes, heap_count);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004640 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
Elliott Hughes545a0642011-11-08 19:10:03 -08004641 JDWP::Append8BE(bytes, MilliTime());
4642 JDWP::Append1BE(bytes, reason);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004643 JDWP::Append4BE(bytes, heap->GetMaxMemory()); // Max allowed heap size in bytes.
4644 JDWP::Append4BE(bytes, heap->GetTotalMemory()); // Current heap size in bytes.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -08004645 JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4646 JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
Elliott Hughes21f32d72011-11-09 17:44:13 -08004647 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
Alex Light772099a2017-11-21 14:05:04 -08004648 Runtime::Current()->GetRuntimeCallbacks()->DdmPublishChunk(CHUNK_TYPE("HPIF"),
4649 ArrayRef<const uint8_t>(bytes));
Elliott Hughes767a1472011-10-26 18:49:02 -07004650}
4651
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004652enum HpsgSolidity {
4653 SOLIDITY_FREE = 0,
4654 SOLIDITY_HARD = 1,
4655 SOLIDITY_SOFT = 2,
4656 SOLIDITY_WEAK = 3,
4657 SOLIDITY_PHANTOM = 4,
4658 SOLIDITY_FINALIZABLE = 5,
4659 SOLIDITY_SWEEP = 6,
4660};
4661
4662enum HpsgKind {
4663 KIND_OBJECT = 0,
4664 KIND_CLASS_OBJECT = 1,
4665 KIND_ARRAY_1 = 2,
4666 KIND_ARRAY_2 = 3,
4667 KIND_ARRAY_4 = 4,
4668 KIND_ARRAY_8 = 5,
4669 KIND_UNKNOWN = 6,
4670 KIND_NATIVE = 7,
4671};
4672
4673#define HPSG_PARTIAL (1<<7)
4674#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4675
Ian Rogers30fab402012-01-23 15:43:46 -08004676class HeapChunkContext {
4677 public:
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004678 // Maximum chunk size. Obtain this from the formula:
4679 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4680 HeapChunkContext(bool merge, bool native)
Ian Rogers30fab402012-01-23 15:43:46 -08004681 : buf_(16384 - 16),
4682 type_(0),
Mathieu Chartier36dab362014-07-30 14:59:56 -07004683 chunk_overhead_(0) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004684 Reset();
4685 if (native) {
Ian Rogers30fab402012-01-23 15:43:46 -08004686 type_ = CHUNK_TYPE("NHSG");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004687 } else {
Ian Rogers30fab402012-01-23 15:43:46 -08004688 type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004689 }
4690 }
4691
4692 ~HeapChunkContext() {
Ian Rogers30fab402012-01-23 15:43:46 -08004693 if (p_ > &buf_[0]) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004694 Flush();
4695 }
4696 }
4697
Mathieu Chartier36dab362014-07-30 14:59:56 -07004698 void SetChunkOverhead(size_t chunk_overhead) {
4699 chunk_overhead_ = chunk_overhead;
4700 }
4701
4702 void ResetStartOfNextChunk() {
4703 startOfNextMemoryChunk_ = nullptr;
4704 }
4705
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004706 void EnsureHeader(const void* chunk_ptr) {
Ian Rogers30fab402012-01-23 15:43:46 -08004707 if (!needHeader_) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004708 return;
4709 }
4710
4711 // Start a new HPSx chunk.
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004712 JDWP::Write4BE(&p_, 1); // Heap id (bogus; we only have one heap).
4713 JDWP::Write1BE(&p_, 8); // Size of allocation unit, in bytes.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004714
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004715 JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
4716 JDWP::Write4BE(&p_, 0); // offset of this piece (relative to the virtual address).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004717 // [u4]: length of piece, in allocation units
4718 // 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 -08004719 pieceLenField_ = p_;
4720 JDWP::Write4BE(&p_, 0x55555555);
4721 needHeader_ = false;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004722 }
4723
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004724 void Flush() REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004725 if (pieceLenField_ == nullptr) {
Ian Rogersd636b062013-01-18 17:51:18 -08004726 // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4727 CHECK(needHeader_);
4728 return;
4729 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004730 // Patch the "length of piece" field.
Ian Rogers30fab402012-01-23 15:43:46 -08004731 CHECK_LE(&buf_[0], pieceLenField_);
4732 CHECK_LE(pieceLenField_, p_);
4733 JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004734
Alex Light772099a2017-11-21 14:05:04 -08004735 ArrayRef<const uint8_t> out(&buf_[0], p_ - &buf_[0]);
4736 Runtime::Current()->GetRuntimeCallbacks()->DdmPublishChunk(type_, out);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004737 Reset();
4738 }
4739
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004740 static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004741 REQUIRES_SHARED(Locks::heap_bitmap_lock_,
Ian Rogersb726dcb2012-09-05 08:57:23 -07004742 Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004743 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4744 }
4745
4746 static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004747 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004748 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
Elliott Hughesa2155262011-11-16 16:26:58 -08004749 }
4750
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004751 private:
Elliott Hughesa2155262011-11-16 16:26:58 -08004752 enum { ALLOCATION_UNIT_SIZE = 8 };
4753
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004754 void Reset() {
Ian Rogers30fab402012-01-23 15:43:46 -08004755 p_ = &buf_[0];
Mathieu Chartier36dab362014-07-30 14:59:56 -07004756 ResetStartOfNextChunk();
Ian Rogers30fab402012-01-23 15:43:46 -08004757 totalAllocationUnits_ = 0;
4758 needHeader_ = true;
Ian Rogersc0542af2014-09-03 16:16:56 -07004759 pieceLenField_ = nullptr;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004760 }
4761
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004762 bool IsNative() const {
4763 return type_ == CHUNK_TYPE("NHSG");
4764 }
4765
4766 // Returns true if the object is not an empty chunk.
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004767 bool ProcessRecord(void* start, size_t used_bytes) REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers30fab402012-01-23 15:43:46 -08004768 // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4769 // in the following code not to allocate memory, by ensuring buf_ is of the correct size
Ian Rogers15bf2d32012-08-28 17:33:04 -07004770 if (used_bytes == 0) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004771 if (start == nullptr) {
4772 // Reset for start of new heap.
4773 startOfNextMemoryChunk_ = nullptr;
4774 Flush();
4775 }
4776 // Only process in use memory so that free region information
4777 // also includes dlmalloc book keeping.
4778 return false;
Elliott Hughesa2155262011-11-16 16:26:58 -08004779 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004780 if (startOfNextMemoryChunk_ != nullptr) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004781 // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4782 // of the use of mmaps, so don't report. If not free memory then start a new segment.
4783 bool flush = true;
4784 if (start > startOfNextMemoryChunk_) {
4785 const size_t kMaxFreeLen = 2 * kPageSize;
4786 void* free_start = startOfNextMemoryChunk_;
4787 void* free_end = start;
4788 const size_t free_len =
4789 reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4790 if (!IsNative() || free_len < kMaxFreeLen) {
4791 AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4792 flush = false;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004793 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004794 }
4795 if (flush) {
4796 startOfNextMemoryChunk_ = nullptr;
4797 Flush();
4798 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004799 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004800 return true;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004801 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004802
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004803 void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004804 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004805 if (ProcessRecord(start, used_bytes)) {
4806 uint8_t state = ExamineNativeObject(start);
4807 AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4808 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4809 }
4810 }
4811
4812 void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004813 REQUIRES_SHARED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004814 if (ProcessRecord(start, used_bytes)) {
4815 // Determine the type of this chunk.
4816 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4817 // If it's the same, we should combine them.
4818 uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4819 AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4820 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4821 }
4822 }
4823
4824 void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004825 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004826 // Make sure there's enough room left in the buffer.
4827 // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4828 // 17 bytes for any header.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004829 const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4830 size_t byte_left = &buf_.back() - p_;
4831 if (byte_left < needed) {
4832 if (is_native) {
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004833 // Cannot trigger memory allocation while walking native heap.
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004834 return;
4835 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004836 Flush();
4837 }
4838
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004839 byte_left = &buf_.back() - p_;
4840 if (byte_left < needed) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004841 LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4842 << needed << " bytes)";
4843 return;
4844 }
4845 EnsureHeader(ptr);
Elliott Hughesa2155262011-11-16 16:26:58 -08004846 // Write out the chunk description.
Ian Rogers15bf2d32012-08-28 17:33:04 -07004847 length /= ALLOCATION_UNIT_SIZE; // Convert to allocation units.
4848 totalAllocationUnits_ += length;
4849 while (length > 256) {
Ian Rogers30fab402012-01-23 15:43:46 -08004850 *p_++ = state | HPSG_PARTIAL;
4851 *p_++ = 255; // length - 1
Ian Rogers15bf2d32012-08-28 17:33:04 -07004852 length -= 256;
Elliott Hughesa2155262011-11-16 16:26:58 -08004853 }
Ian Rogers30fab402012-01-23 15:43:46 -08004854 *p_++ = state;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004855 *p_++ = length - 1;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004856 }
4857
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004858 uint8_t ExamineNativeObject(const void* p) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004859 return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4860 }
4861
4862 uint8_t ExamineJavaObject(mirror::Object* o)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07004863 REQUIRES_SHARED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004864 if (o == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004865 return HPSG_STATE(SOLIDITY_FREE, 0);
4866 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004867 // It's an allocated chunk. Figure out what it is.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004868 gc::Heap* heap = Runtime::Current()->GetHeap();
4869 if (!heap->IsLiveObjectLocked(o)) {
4870 LOG(ERROR) << "Invalid object in managed heap: " << o;
Elliott Hughesa2155262011-11-16 16:26:58 -08004871 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4872 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08004873 mirror::Class* c = o->GetClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07004874 if (c == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004875 // The object was probably just created but hasn't been initialized yet.
4876 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4877 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004878 if (!heap->IsValidObjectAddress(c)) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004879 LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
Elliott Hughesa2155262011-11-16 16:26:58 -08004880 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4881 }
Mathieu Chartierf26e1b32015-01-29 10:47:10 -08004882 if (c->GetClass() == nullptr) {
4883 LOG(ERROR) << "Null class of class " << c << " for object " << o;
4884 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4885 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004886 if (c->IsClassClass()) {
4887 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4888 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004889 if (c->IsArrayClass()) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004890 switch (c->GetComponentSize()) {
4891 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4892 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4893 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4894 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4895 }
4896 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004897 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4898 }
4899
Ian Rogers30fab402012-01-23 15:43:46 -08004900 std::vector<uint8_t> buf_;
4901 uint8_t* p_;
4902 uint8_t* pieceLenField_;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004903 void* startOfNextMemoryChunk_;
Ian Rogers30fab402012-01-23 15:43:46 -08004904 size_t totalAllocationUnits_;
4905 uint32_t type_;
Ian Rogers30fab402012-01-23 15:43:46 -08004906 bool needHeader_;
Mathieu Chartier36dab362014-07-30 14:59:56 -07004907 size_t chunk_overhead_;
Ian Rogers30fab402012-01-23 15:43:46 -08004908
Elliott Hughesa2155262011-11-16 16:26:58 -08004909 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4910};
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004911
4912void Dbg::DdmSendHeapSegments(bool native) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004913 Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4914 Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004915 if (when == HPSG_WHEN_NEVER) {
4916 return;
4917 }
Alex Light772099a2017-11-21 14:05:04 -08004918 RuntimeCallbacks* cb = Runtime::Current()->GetRuntimeCallbacks();
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004919 // Figure out what kind of chunks we'll be sending.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004920 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4921 << static_cast<int>(what);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004922
4923 // First, send a heap start chunk.
4924 uint8_t heap_id[4];
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004925 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
Alex Light772099a2017-11-21 14:05:04 -08004926 cb->DdmPublishChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"),
4927 ArrayRef<const uint8_t>(heap_id));
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004928 Thread* self = Thread::Current();
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004929 Locks::mutator_lock_->AssertSharedHeld(self);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004930
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004931 // Send a series of heap segment chunks.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004932 HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
Andreas Gampe0c183382017-07-13 22:26:24 -07004933 auto bump_pointer_space_visitor = [&](mirror::Object* obj)
4934 REQUIRES_SHARED(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
4935 const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
4936 HeapChunkContext::HeapChunkJavaCallback(
4937 obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, &context);
4938 };
Elliott Hughesa2155262011-11-16 16:26:58 -08004939 if (native) {
Dimitry Ivanove6465bc2015-12-14 18:55:02 -08004940 UNIMPLEMENTED(WARNING) << "Native heap inspection is not supported";
Elliott Hughesa2155262011-11-16 16:26:58 -08004941 } else {
Ian Rogers1d54e732013-05-02 21:10:01 -07004942 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004943 for (const auto& space : heap->GetContinuousSpaces()) {
4944 if (space->IsDlMallocSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004945 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004946 // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4947 // allocation then the first sizeof(size_t) may belong to it.
4948 context.SetChunkOverhead(sizeof(size_t));
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004949 space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004950 } else if (space->IsRosAllocSpace()) {
4951 context.SetChunkOverhead(0);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004952 // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4953 // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004954 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07004955 ScopedSuspendAll ssa(__FUNCTION__);
4956 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4957 space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004958 } else if (space->IsBumpPointerSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004959 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004960 context.SetChunkOverhead(0);
Andreas Gampe0c183382017-07-13 22:26:24 -07004961 space->AsBumpPointerSpace()->Walk(bump_pointer_space_visitor);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004962 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004963 } else if (space->IsRegionSpace()) {
4964 heap->IncrementDisableMovingGC(self);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004965 {
4966 ScopedThreadSuspension sts(self, kSuspended);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07004967 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004968 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4969 context.SetChunkOverhead(0);
Andreas Gampe0c183382017-07-13 22:26:24 -07004970 space->AsRegionSpace()->Walk(bump_pointer_space_visitor);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004971 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07004972 }
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004973 heap->DecrementDisableMovingGC(self);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004974 } else {
4975 UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004976 }
Mathieu Chartier36dab362014-07-30 14:59:56 -07004977 context.ResetStartOfNextChunk();
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004978 }
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004979 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartiere0f0cb32012-08-28 11:26:00 -07004980 // Walk the large objects, these are not in the AllocSpace.
Mathieu Chartier36dab362014-07-30 14:59:56 -07004981 context.SetChunkOverhead(0);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004982 heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Elliott Hughesa2155262011-11-16 16:26:58 -08004983 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004984
4985 // Finally, send a heap end chunk.
Alex Light772099a2017-11-21 14:05:04 -08004986 cb->DdmPublishChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"),
4987 ArrayRef<const uint8_t>(heap_id));
Elliott Hughes767a1472011-10-26 18:49:02 -07004988}
4989
Brian Carlstrom306db812014-09-05 13:01:41 -07004990void Dbg::SetAllocTrackingEnabled(bool enable) {
Man Cao8c2ff642015-05-27 17:25:30 -07004991 gc::AllocRecordObjectMap::SetAllocTrackingEnabled(enable);
Elliott Hughes545a0642011-11-08 19:10:03 -08004992}
4993
4994void Dbg::DumpRecentAllocations() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004995 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom306db812014-09-05 13:01:41 -07004996 MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004997 if (!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled()) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004998 LOG(INFO) << "Not recording tracked allocations";
4999 return;
5000 }
Man Cao8c2ff642015-05-27 17:25:30 -07005001 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
5002 CHECK(records != nullptr);
Elliott Hughes545a0642011-11-08 19:10:03 -08005003
Man Cao1ed11b92015-06-11 22:47:35 -07005004 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07005005 uint16_t count = capped_count;
Elliott Hughes545a0642011-11-08 19:10:03 -08005006
Man Cao8c2ff642015-05-27 17:25:30 -07005007 LOG(INFO) << "Tracked allocations, (count=" << count << ")";
5008 for (auto it = records->RBegin(), end = records->REnd();
5009 count > 0 && it != end; count--, it++) {
Mathieu Chartier458b1052016-03-29 14:02:55 -07005010 const gc::AllocRecord* record = &it->second;
Elliott Hughes545a0642011-11-08 19:10:03 -08005011
Man Cao8c2ff642015-05-27 17:25:30 -07005012 LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->GetTid(), record->ByteCount())
David Sehr709b0702016-10-13 09:12:37 -07005013 << mirror::Class::PrettyClass(record->GetClass());
Elliott Hughes545a0642011-11-08 19:10:03 -08005014
Man Cao8c2ff642015-05-27 17:25:30 -07005015 for (size_t stack_frame = 0, depth = record->GetDepth(); stack_frame < depth; ++stack_frame) {
5016 const gc::AllocRecordStackTraceElement& stack_element = record->StackElement(stack_frame);
5017 ArtMethod* m = stack_element.GetMethod();
David Sehr709b0702016-10-13 09:12:37 -07005018 LOG(INFO) << " " << ArtMethod::PrettyMethod(m) << " line "
5019 << stack_element.ComputeLineNumber();
Elliott Hughes545a0642011-11-08 19:10:03 -08005020 }
5021
5022 // pause periodically to help logcat catch up
5023 if ((count % 5) == 0) {
5024 usleep(40000);
5025 }
Elliott Hughes545a0642011-11-08 19:10:03 -08005026 }
5027}
5028
5029class StringTable {
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005030 private:
5031 struct Entry {
Andreas Gampe84eadb22017-07-07 15:08:01 -07005032 explicit Entry(const char* data_in)
5033 : data(data_in), hash(ComputeModifiedUtf8Hash(data_in)), index(0) {
5034 }
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005035 Entry(const Entry& entry) = default;
5036 Entry(Entry&& entry) = default;
5037
5038 // Pointer to the actual string data.
5039 const char* data;
Andreas Gampe84eadb22017-07-07 15:08:01 -07005040
5041 // The hash of the data.
5042 const uint32_t hash;
5043
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005044 // The index. This will be filled in on Finish and is not part of the ordering, so mark it
5045 // mutable.
5046 mutable uint32_t index;
5047
Andreas Gampe84eadb22017-07-07 15:08:01 -07005048 bool operator==(const Entry& other) const {
5049 return strcmp(data, other.data) == 0;
5050 }
5051 };
5052 struct EntryHash {
5053 size_t operator()(const Entry& entry) const {
5054 return entry.hash;
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005055 }
5056 };
5057
Elliott Hughes545a0642011-11-08 19:10:03 -08005058 public:
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005059 StringTable() : finished_(false) {
Elliott Hughes545a0642011-11-08 19:10:03 -08005060 }
5061
Andreas Gampef774a4e2017-07-06 22:15:18 -07005062 void Add(const char* str, bool copy_string) {
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005063 DCHECK(!finished_);
Andreas Gampef774a4e2017-07-06 22:15:18 -07005064 if (UNLIKELY(copy_string)) {
5065 // Check whether it's already there.
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005066 Entry entry(str);
5067 if (table_.find(entry) != table_.end()) {
Andreas Gampef774a4e2017-07-06 22:15:18 -07005068 return;
5069 }
Mathieu Chartier4345c462014-06-27 10:20:14 -07005070
Andreas Gampef774a4e2017-07-06 22:15:18 -07005071 // Make a copy.
5072 size_t str_len = strlen(str);
5073 char* copy = new char[str_len + 1];
5074 strlcpy(copy, str, str_len + 1);
5075 string_backup_.emplace_back(copy);
5076 str = copy;
5077 }
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005078 Entry entry(str);
5079 table_.insert(entry);
5080 }
5081
5082 // Update all entries and give them an index. Note that this is likely not the insertion order,
5083 // as the set will with high likelihood reorder elements. Thus, Add must not be called after
5084 // Finish, and Finish must be called before IndexOf. In that case, WriteTo will walk in
5085 // the same order as Finish, and indices will agree. The order invariant, as well as indices,
5086 // are enforced through debug checks.
5087 void Finish() {
5088 DCHECK(!finished_);
5089 finished_ = true;
5090 uint32_t index = 0;
5091 for (auto& entry : table_) {
5092 entry.index = index;
5093 ++index;
5094 }
Elliott Hughes545a0642011-11-08 19:10:03 -08005095 }
5096
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07005097 size_t IndexOf(const char* s) const {
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005098 DCHECK(finished_);
5099 Entry entry(s);
5100 auto it = table_.find(entry);
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07005101 if (it == table_.end()) {
5102 LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
5103 }
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005104 return it->index;
Elliott Hughes545a0642011-11-08 19:10:03 -08005105 }
5106
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07005107 size_t Size() const {
Elliott Hughes545a0642011-11-08 19:10:03 -08005108 return table_.size();
5109 }
5110
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07005111 void WriteTo(std::vector<uint8_t>& bytes) const {
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005112 DCHECK(finished_);
5113 uint32_t cur_index = 0;
5114 for (const auto& entry : table_) {
5115 DCHECK_EQ(cur_index++, entry.index);
5116
5117 size_t s_len = CountModifiedUtf8Chars(entry.data);
Christopher Ferris8a354052015-04-24 17:23:53 -07005118 std::unique_ptr<uint16_t[]> s_utf16(new uint16_t[s_len]);
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005119 ConvertModifiedUtf8ToUtf16(s_utf16.get(), entry.data);
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08005120 JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
Elliott Hughes545a0642011-11-08 19:10:03 -08005121 }
5122 }
5123
5124 private:
Andreas Gampe84eadb22017-07-07 15:08:01 -07005125 std::unordered_set<Entry, EntryHash> table_;
Andreas Gampef774a4e2017-07-06 22:15:18 -07005126 std::vector<std::unique_ptr<char[]>> string_backup_;
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005127
5128 bool finished_;
5129
Elliott Hughes545a0642011-11-08 19:10:03 -08005130 DISALLOW_COPY_AND_ASSIGN(StringTable);
5131};
5132
Mathieu Chartiere401d142015-04-22 13:56:20 -07005133static const char* GetMethodSourceFile(ArtMethod* method)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07005134 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07005135 DCHECK(method != nullptr);
5136 const char* source_file = method->GetDeclaringClassSourceFile();
Sebastien Hertz280286a2014-04-28 09:26:50 +02005137 return (source_file != nullptr) ? source_file : "";
5138}
5139
Elliott Hughes545a0642011-11-08 19:10:03 -08005140/*
5141 * The data we send to DDMS contains everything we have recorded.
5142 *
5143 * Message header (all values big-endian):
5144 * (1b) message header len (to allow future expansion); includes itself
5145 * (1b) entry header len
5146 * (1b) stack frame len
5147 * (2b) number of entries
5148 * (4b) offset to string table from start of message
5149 * (2b) number of class name strings
5150 * (2b) number of method name strings
5151 * (2b) number of source file name strings
5152 * For each entry:
5153 * (4b) total allocation size
Elliott Hughes221229c2013-01-08 18:17:50 -08005154 * (2b) thread id
Elliott Hughes545a0642011-11-08 19:10:03 -08005155 * (2b) allocated object's class name index
5156 * (1b) stack depth
5157 * For each stack frame:
5158 * (2b) method's class name
5159 * (2b) method name
5160 * (2b) method source file
5161 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
5162 * (xb) class name strings
5163 * (xb) method name strings
5164 * (xb) source file strings
5165 *
5166 * As with other DDM traffic, strings are sent as a 4-byte length
5167 * followed by UTF-16 data.
5168 *
5169 * We send up 16-bit unsigned indexes into string tables. In theory there
Brian Carlstrom306db812014-09-05 13:01:41 -07005170 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
Elliott Hughes545a0642011-11-08 19:10:03 -08005171 * each table, but in practice there should be far fewer.
5172 *
5173 * The chief reason for using a string table here is to keep the size of
5174 * the DDMS message to a minimum. This is partly to make the protocol
5175 * efficient, but also because we have to form the whole thing up all at
5176 * once in a memory buffer.
5177 *
5178 * We use separate string tables for class names, method names, and source
5179 * files to keep the indexes small. There will generally be no overlap
5180 * between the contents of these tables.
5181 */
5182jbyteArray Dbg::GetRecentAllocations() {
Ian Rogerscf7f1912014-10-22 22:06:39 -07005183 if ((false)) {
Elliott Hughes545a0642011-11-08 19:10:03 -08005184 DumpRecentAllocations();
5185 }
5186
Ian Rogers50b35e22012-10-04 10:09:15 -07005187 Thread* self = Thread::Current();
Elliott Hughes545a0642011-11-08 19:10:03 -08005188 std::vector<uint8_t> bytes;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005189 {
Brian Carlstrom306db812014-09-05 13:01:41 -07005190 MutexLock mu(self, *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07005191 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
5192 // In case this method is called when allocation tracker is disabled,
5193 // we should still send some data back.
5194 gc::AllocRecordObjectMap dummy;
5195 if (records == nullptr) {
5196 CHECK(!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled());
5197 records = &dummy;
5198 }
Man Cao41656de2015-07-06 18:53:15 -07005199 // We don't need to wait on the condition variable records->new_record_condition_, because this
5200 // function only reads the class objects, which are already marked so it doesn't change their
5201 // reachability.
Man Cao8c2ff642015-05-27 17:25:30 -07005202
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005203 //
5204 // Part 1: generate string tables.
5205 //
5206 StringTable class_names;
5207 StringTable method_names;
5208 StringTable filenames;
Elliott Hughes545a0642011-11-08 19:10:03 -08005209
Andreas Gampeff29cee2017-07-07 11:11:15 -07005210 VLOG(jdwp) << "Collecting StringTables.";
5211
Man Cao1ed11b92015-06-11 22:47:35 -07005212 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07005213 uint16_t count = capped_count;
Andreas Gamped0fc7682017-07-07 14:03:08 -07005214 size_t alloc_byte_count = 0;
Man Cao8c2ff642015-05-27 17:25:30 -07005215 for (auto it = records->RBegin(), end = records->REnd();
5216 count > 0 && it != end; count--, it++) {
Mathieu Chartier458b1052016-03-29 14:02:55 -07005217 const gc::AllocRecord* record = &it->second;
Ian Rogers1ff3c982014-08-12 02:30:58 -07005218 std::string temp;
Andreas Gampef774a4e2017-07-06 22:15:18 -07005219 const char* class_descr = record->GetClassDescriptor(&temp);
5220 class_names.Add(class_descr, !temp.empty());
Andreas Gamped0fc7682017-07-07 14:03:08 -07005221
5222 // Size + tid + class name index + stack depth.
5223 alloc_byte_count += 4u + 2u + 2u + 1u;
5224
Man Cao8c2ff642015-05-27 17:25:30 -07005225 for (size_t i = 0, depth = record->GetDepth(); i < depth; i++) {
5226 ArtMethod* m = record->StackElement(i).GetMethod();
Andreas Gampef774a4e2017-07-06 22:15:18 -07005227 class_names.Add(m->GetDeclaringClassDescriptor(), false);
5228 method_names.Add(m->GetName(), false);
5229 filenames.Add(GetMethodSourceFile(m), false);
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005230 }
Andreas Gamped0fc7682017-07-07 14:03:08 -07005231
5232 // Depth * (class index + method name index + file name index + line number).
5233 alloc_byte_count += record->GetDepth() * (2u + 2u + 2u + 2u);
Elliott Hughes545a0642011-11-08 19:10:03 -08005234 }
5235
Andreas Gampe2eeb01a2017-07-07 14:09:46 -07005236 class_names.Finish();
5237 method_names.Finish();
5238 filenames.Finish();
Andreas Gampeff29cee2017-07-07 11:11:15 -07005239 VLOG(jdwp) << "Done collecting StringTables:" << std::endl
5240 << " ClassNames: " << class_names.Size() << std::endl
5241 << " MethodNames: " << method_names.Size() << std::endl
5242 << " Filenames: " << filenames.Size();
5243
Man Cao8c2ff642015-05-27 17:25:30 -07005244 LOG(INFO) << "recent allocation records: " << capped_count;
5245 LOG(INFO) << "allocation records all objects: " << records->Size();
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005246
5247 //
5248 // Part 2: Generate the output and store it in the buffer.
5249 //
5250
5251 // (1b) message header len (to allow future expansion); includes itself
5252 // (1b) entry header len
5253 // (1b) stack frame len
5254 const int kMessageHeaderLen = 15;
5255 const int kEntryHeaderLen = 9;
5256 const int kStackFrameLen = 8;
5257 JDWP::Append1BE(bytes, kMessageHeaderLen);
5258 JDWP::Append1BE(bytes, kEntryHeaderLen);
5259 JDWP::Append1BE(bytes, kStackFrameLen);
5260
5261 // (2b) number of entries
5262 // (4b) offset to string table from start of message
5263 // (2b) number of class name strings
5264 // (2b) number of method name strings
5265 // (2b) number of source file name strings
Brian Carlstrom306db812014-09-05 13:01:41 -07005266 JDWP::Append2BE(bytes, capped_count);
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005267 size_t string_table_offset = bytes.size();
Brian Carlstrom7934ac22013-07-26 10:54:15 -07005268 JDWP::Append4BE(bytes, 0); // We'll patch this later...
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005269 JDWP::Append2BE(bytes, class_names.Size());
5270 JDWP::Append2BE(bytes, method_names.Size());
5271 JDWP::Append2BE(bytes, filenames.Size());
5272
Andreas Gampeff29cee2017-07-07 11:11:15 -07005273 VLOG(jdwp) << "Dumping allocations with stacks";
5274
Andreas Gamped0fc7682017-07-07 14:03:08 -07005275 // Enlarge the vector for the allocation data.
5276 size_t reserve_size = bytes.size() + alloc_byte_count;
5277 bytes.reserve(reserve_size);
5278
Ian Rogers1ff3c982014-08-12 02:30:58 -07005279 std::string temp;
Man Cao8c2ff642015-05-27 17:25:30 -07005280 count = capped_count;
5281 // The last "count" number of allocation records in "records" are the most recent "count" number
5282 // of allocations. Reverse iterate to get them. The most recent allocation is sent first.
5283 for (auto it = records->RBegin(), end = records->REnd();
5284 count > 0 && it != end; count--, it++) {
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005285 // For each entry:
5286 // (4b) total allocation size
5287 // (2b) thread id
5288 // (2b) allocated object's class name index
5289 // (1b) stack depth
Mathieu Chartier458b1052016-03-29 14:02:55 -07005290 const gc::AllocRecord* record = &it->second;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005291 size_t stack_depth = record->GetDepth();
Mathieu Chartierf8322842014-05-16 10:59:25 -07005292 size_t allocated_object_class_name_index =
Man Cao41656de2015-07-06 18:53:15 -07005293 class_names.IndexOf(record->GetClassDescriptor(&temp));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07005294 JDWP::Append4BE(bytes, record->ByteCount());
Man Cao8c2ff642015-05-27 17:25:30 -07005295 JDWP::Append2BE(bytes, static_cast<uint16_t>(record->GetTid()));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005296 JDWP::Append2BE(bytes, allocated_object_class_name_index);
5297 JDWP::Append1BE(bytes, stack_depth);
5298
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005299 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
5300 // For each stack frame:
5301 // (2b) method's class name
5302 // (2b) method name
5303 // (2b) method source file
5304 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
Man Cao8c2ff642015-05-27 17:25:30 -07005305 ArtMethod* m = record->StackElement(stack_frame).GetMethod();
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07005306 size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
5307 size_t method_name_index = method_names.IndexOf(m->GetName());
5308 size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005309 JDWP::Append2BE(bytes, class_name_index);
5310 JDWP::Append2BE(bytes, method_name_index);
5311 JDWP::Append2BE(bytes, file_name_index);
Man Cao8c2ff642015-05-27 17:25:30 -07005312 JDWP::Append2BE(bytes, record->StackElement(stack_frame).ComputeLineNumber());
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005313 }
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005314 }
5315
Andreas Gamped0fc7682017-07-07 14:03:08 -07005316 CHECK_EQ(bytes.size(), reserve_size);
Andreas Gampeff29cee2017-07-07 11:11:15 -07005317 VLOG(jdwp) << "Dumping tables.";
5318
Mathieu Chartier46e811b2013-07-10 17:09:14 -07005319 // (xb) class name strings
5320 // (xb) method name strings
5321 // (xb) source file strings
5322 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
5323 class_names.WriteTo(bytes);
5324 method_names.WriteTo(bytes);
5325 filenames.WriteTo(bytes);
Andreas Gampeff29cee2017-07-07 11:11:15 -07005326
5327 VLOG(jdwp) << "GetRecentAllocations: data created. " << bytes.size();
Elliott Hughes545a0642011-11-08 19:10:03 -08005328 }
Ian Rogers50b35e22012-10-04 10:09:15 -07005329 JNIEnv* env = self->GetJniEnv();
Elliott Hughes545a0642011-11-08 19:10:03 -08005330 jbyteArray result = env->NewByteArray(bytes.size());
Ian Rogersc0542af2014-09-03 16:16:56 -07005331 if (result != nullptr) {
Elliott Hughes545a0642011-11-08 19:10:03 -08005332 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
5333 }
5334 return result;
5335}
5336
Mathieu Chartiere401d142015-04-22 13:56:20 -07005337ArtMethod* DeoptimizationRequest::Method() const {
Andreas Gampe13b27842016-11-07 16:48:23 -08005338 return jni::DecodeArtMethod(method_);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07005339}
5340
Mathieu Chartiere401d142015-04-22 13:56:20 -07005341void DeoptimizationRequest::SetMethod(ArtMethod* m) {
Andreas Gampe13b27842016-11-07 16:48:23 -08005342 method_ = jni::EncodeArtMethod(m);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07005343}
5344
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -07005345void Dbg::VisitRoots(RootVisitor* visitor) {
5346 // Visit breakpoint roots, used to prevent unloading of methods with breakpoints.
5347 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
5348 BufferedRootVisitor<128> root_visitor(visitor, RootInfo(kRootVMInternal));
5349 for (Breakpoint& breakpoint : gBreakpoints) {
Andreas Gampe542451c2016-07-26 09:02:02 -07005350 breakpoint.Method()->VisitRoots(root_visitor, kRuntimePointerSize);
Mathieu Chartiera6b1ead2015-10-06 10:32:38 -07005351 }
5352}
5353
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00005354void Dbg::DbgThreadLifecycleCallback::ThreadStart(Thread* self) {
5355 Dbg::PostThreadStart(self);
5356}
5357
5358void Dbg::DbgThreadLifecycleCallback::ThreadDeath(Thread* self) {
5359 Dbg::PostThreadDeath(self);
5360}
5361
Andreas Gampe0f01b582017-01-18 15:22:37 -08005362void Dbg::DbgClassLoadCallback::ClassLoad(Handle<mirror::Class> klass ATTRIBUTE_UNUSED) {
5363 // Ignore ClassLoad;
5364}
5365void Dbg::DbgClassLoadCallback::ClassPrepare(Handle<mirror::Class> temp_klass ATTRIBUTE_UNUSED,
5366 Handle<mirror::Class> klass) {
5367 Dbg::PostClassPrepare(klass.Get());
5368}
5369
Elliott Hughes872d4ec2011-10-21 17:07:15 -07005370} // namespace art