blob: dfb7f63274a7afe87380fc0213d47f9c5e5af9db [file] [log] [blame]
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "debugger.h"
18
Elliott Hughes3bb81562011-10-21 18:52:59 -070019#include <sys/uio.h>
20
Elliott Hughes545a0642011-11-08 19:10:03 -080021#include <set>
22
Ian Rogers166db042013-07-26 12:05:57 -070023#include "arch/context.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070024#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070025#include "art_method-inl.h"
Vladimir Marko80afd022015-05-19 18:08:00 +010026#include "base/time_utils.h"
Elliott Hughes545a0642011-11-08 19:10:03 -080027#include "class_linker.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080028#include "class_linker-inl.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070029#include "dex_file-inl.h"
Ian Rogers776ac1f2012-04-13 23:36:36 -070030#include "dex_instruction.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070031#include "gc/accounting/card_table-inl.h"
Man Cao8c2ff642015-05-27 17:25:30 -070032#include "gc/allocation_record.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070033#include "gc/space/large_object_space.h"
34#include "gc/space/space-inl.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070035#include "handle_scope.h"
Sebastien Hertzcbc50642015-06-01 17:33:12 +020036#include "jdwp/jdwp_priv.h"
Elliott Hughes64f574f2013-02-20 14:57:12 -080037#include "jdwp/object_registry.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080038#include "mirror/class.h"
39#include "mirror/class-inl.h"
40#include "mirror/class_loader.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080041#include "mirror/object-inl.h"
42#include "mirror/object_array-inl.h"
Ian Rogersb0fa5dc2014-04-28 16:47:08 -070043#include "mirror/string-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080044#include "mirror/throwable.h"
Sebastien Hertza76a6d42014-03-20 16:40:17 +010045#include "quick/inline_method_analyser.h"
Ian Rogers53b8b092014-03-13 23:45:53 -070046#include "reflection.h"
Elliott Hughesa0e18062012-04-13 15:59:59 -070047#include "safe_map.h"
Elliott Hughes64f574f2013-02-20 14:57:12 -080048#include "scoped_thread_state_change.h"
Elliott Hughes6a5bd492011-10-28 14:33:57 -070049#include "ScopedLocalRef.h"
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -070050#include "ScopedPrimitiveArray.h"
Mathieu Chartiereb8167a2014-05-07 15:43:14 -070051#include "handle_scope-inl.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070052#include "thread_list.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080053#include "utf.h"
Sebastien Hertza76a6d42014-03-20 16:40:17 +010054#include "verifier/method_verifier-inl.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070055#include "well_known_classes.h"
Elliott Hughes475fc232011-10-25 15:00:35 -070056
Elliott Hughes872d4ec2011-10-21 17:07:15 -070057namespace art {
58
Sebastien Hertz0462c4c2015-04-01 16:34:17 +020059// The key identifying the debugger to update instrumentation.
60static constexpr const char* kDbgInstrumentationKey = "Debugger";
61
Man Cao8c2ff642015-05-27 17:25:30 -070062// 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 -070063static uint16_t CappedAllocRecordCount(size_t alloc_record_count) {
Man Cao1ed11b92015-06-11 22:47:35 -070064 const size_t cap = 0xffff;
Man Cao8c2ff642015-05-27 17:25:30 -070065 if (alloc_record_count > cap) {
66 return cap;
Brian Carlstrom306db812014-09-05 13:01:41 -070067 }
68 return alloc_record_count;
69}
Elliott Hughes475fc232011-10-25 15:00:35 -070070
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070071class Breakpoint {
72 public:
Mathieu Chartiere401d142015-04-22 13:56:20 -070073 Breakpoint(ArtMethod* method, uint32_t dex_pc,
Sebastien Hertzf3928792014-11-17 19:00:37 +010074 DeoptimizationRequest::Kind deoptimization_kind)
Mathieu Chartier90443472015-07-16 20:32:27 -070075 SHARED_REQUIRES(Locks::mutator_lock_)
Sebastien Hertzf3928792014-11-17 19:00:37 +010076 : method_(nullptr), dex_pc_(dex_pc), deoptimization_kind_(deoptimization_kind) {
77 CHECK(deoptimization_kind_ == DeoptimizationRequest::kNothing ||
78 deoptimization_kind_ == DeoptimizationRequest::kSelectiveDeoptimization ||
79 deoptimization_kind_ == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070080 ScopedObjectAccessUnchecked soa(Thread::Current());
81 method_ = soa.EncodeMethod(method);
82 }
83
Mathieu Chartier90443472015-07-16 20:32:27 -070084 Breakpoint(const Breakpoint& other) SHARED_REQUIRES(Locks::mutator_lock_)
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070085 : method_(nullptr), dex_pc_(other.dex_pc_),
Sebastien Hertzf3928792014-11-17 19:00:37 +010086 deoptimization_kind_(other.deoptimization_kind_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070087 ScopedObjectAccessUnchecked soa(Thread::Current());
88 method_ = soa.EncodeMethod(other.Method());
89 }
90
Mathieu Chartier90443472015-07-16 20:32:27 -070091 ArtMethod* Method() const SHARED_REQUIRES(Locks::mutator_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070092 ScopedObjectAccessUnchecked soa(Thread::Current());
93 return soa.DecodeMethod(method_);
94 }
95
96 uint32_t DexPc() const {
97 return dex_pc_;
98 }
99
Sebastien Hertzf3928792014-11-17 19:00:37 +0100100 DeoptimizationRequest::Kind GetDeoptimizationKind() const {
101 return deoptimization_kind_;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700102 }
103
104 private:
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100105 // The location of this breakpoint.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700106 jmethodID method_;
107 uint32_t dex_pc_;
Sebastien Hertza76a6d42014-03-20 16:40:17 +0100108
109 // Indicates whether breakpoint needs full deoptimization or selective deoptimization.
Sebastien Hertzf3928792014-11-17 19:00:37 +0100110 DeoptimizationRequest::Kind deoptimization_kind_;
Elliott Hughes86964332012-02-15 19:37:42 -0800111};
112
Sebastien Hertzed2be172014-08-19 15:33:43 +0200113static std::ostream& operator<<(std::ostream& os, const Breakpoint& rhs)
Mathieu Chartier90443472015-07-16 20:32:27 -0700114 SHARED_REQUIRES(Locks::mutator_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700115 os << StringPrintf("Breakpoint[%s @%#x]", PrettyMethod(rhs.Method()).c_str(), rhs.DexPc());
Elliott Hughes86964332012-02-15 19:37:42 -0800116 return os;
117}
118
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200119class DebugInstrumentationListener FINAL : public instrumentation::InstrumentationListener {
Ian Rogers62d6c772013-02-27 08:32:07 -0800120 public:
121 DebugInstrumentationListener() {}
122 virtual ~DebugInstrumentationListener() {}
123
Mathieu Chartiere401d142015-04-22 13:56:20 -0700124 void MethodEntered(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200125 uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700126 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800127 if (method->IsNative()) {
128 // TODO: post location events is a suspension point and native method entry stubs aren't.
129 return;
130 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200131 if (IsListeningToDexPcMoved()) {
132 // We also listen to kDexPcMoved instrumentation event so we know the DexPcMoved method is
133 // going to be called right after us. To avoid sending JDWP events twice for this location,
134 // we report the event in DexPcMoved. However, we must remind this is method entry so we
135 // send the METHOD_ENTRY event. And we can also group it with other events for this location
136 // like BREAKPOINT or SINGLE_STEP (or even METHOD_EXIT if this is a RETURN instruction).
137 thread->SetDebugMethodEntry();
138 } else if (IsListeningToMethodExit() && IsReturn(method, dex_pc)) {
139 // We also listen to kMethodExited instrumentation event and the current instruction is a
140 // RETURN so we know the MethodExited method is going to be called right after us. To avoid
141 // sending JDWP events twice for this location, we report the event(s) in MethodExited.
142 // However, we must remind this is method entry so we send the METHOD_ENTRY event. And we can
143 // also group it with other events for this location like BREAKPOINT or SINGLE_STEP.
144 thread->SetDebugMethodEntry();
145 } else {
146 Dbg::UpdateDebugger(thread, this_object, method, 0, Dbg::kMethodEntry, nullptr);
147 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800148 }
149
Mathieu Chartiere401d142015-04-22 13:56:20 -0700150 void MethodExited(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200151 uint32_t dex_pc, const JValue& return_value)
Mathieu Chartier90443472015-07-16 20:32:27 -0700152 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800153 if (method->IsNative()) {
154 // TODO: post location events is a suspension point and native method entry stubs aren't.
155 return;
156 }
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200157 uint32_t events = Dbg::kMethodExit;
158 if (thread->IsDebugMethodEntry()) {
159 // It is also the method entry.
160 DCHECK(IsReturn(method, dex_pc));
161 events |= Dbg::kMethodEntry;
162 thread->ClearDebugMethodEntry();
163 }
164 Dbg::UpdateDebugger(thread, this_object, method, dex_pc, events, &return_value);
Ian Rogers62d6c772013-02-27 08:32:07 -0800165 }
166
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200167 void MethodUnwind(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object ATTRIBUTE_UNUSED,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700168 ArtMethod* method, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700169 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers62d6c772013-02-27 08:32:07 -0800170 // We're not recorded to listen to this kind of event, so complain.
171 LOG(ERROR) << "Unexpected method unwind event in debugger " << PrettyMethod(method)
Sebastien Hertz51db44a2013-11-19 10:00:29 +0100172 << " " << dex_pc;
Ian Rogers62d6c772013-02-27 08:32:07 -0800173 }
174
Mathieu Chartiere401d142015-04-22 13:56:20 -0700175 void DexPcMoved(Thread* thread, mirror::Object* this_object, ArtMethod* method,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200176 uint32_t new_dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700177 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200178 if (IsListeningToMethodExit() && IsReturn(method, new_dex_pc)) {
179 // We also listen to kMethodExited instrumentation event and the current instruction is a
180 // RETURN so we know the MethodExited method is going to be called right after us. Like in
181 // MethodEntered, we delegate event reporting to MethodExited.
182 // Besides, if this RETURN instruction is the only one in the method, we can send multiple
183 // JDWP events in the same packet: METHOD_ENTRY, METHOD_EXIT, BREAKPOINT and/or SINGLE_STEP.
184 // Therefore, we must not clear the debug method entry flag here.
185 } else {
186 uint32_t events = 0;
187 if (thread->IsDebugMethodEntry()) {
188 // It is also the method entry.
189 events = Dbg::kMethodEntry;
190 thread->ClearDebugMethodEntry();
191 }
192 Dbg::UpdateDebugger(thread, this_object, method, new_dex_pc, events, nullptr);
193 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800194 }
195
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200196 void FieldRead(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700197 ArtMethod* method, uint32_t dex_pc, ArtField* field)
Mathieu Chartier90443472015-07-16 20:32:27 -0700198 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200199 Dbg::PostFieldAccessEvent(method, dex_pc, this_object, field);
Ian Rogers62d6c772013-02-27 08:32:07 -0800200 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200201
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700202 void FieldWritten(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700203 ArtMethod* method, uint32_t dex_pc, ArtField* field,
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700204 const JValue& field_value)
Mathieu Chartier90443472015-07-16 20:32:27 -0700205 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200206 Dbg::PostFieldModificationEvent(method, dex_pc, this_object, field, &field_value);
207 }
208
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000209 void ExceptionCaught(Thread* thread ATTRIBUTE_UNUSED, mirror::Throwable* exception_object)
Mathieu Chartier90443472015-07-16 20:32:27 -0700210 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +0000211 Dbg::PostException(exception_object);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200212 }
213
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800214 // We only care about how many backward branches were executed in the Jit.
Mathieu Chartiere401d142015-04-22 13:56:20 -0700215 void BackwardBranch(Thread* /*thread*/, ArtMethod* method, int32_t dex_pc_offset)
Mathieu Chartier90443472015-07-16 20:32:27 -0700216 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere5f13e52015-02-24 09:37:21 -0800217 LOG(ERROR) << "Unexpected backward branch event in debugger " << PrettyMethod(method)
218 << " " << dex_pc_offset;
219 }
220
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200221 private:
Mathieu Chartiere401d142015-04-22 13:56:20 -0700222 static bool IsReturn(ArtMethod* method, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700223 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200224 const DexFile::CodeItem* code_item = method->GetCodeItem();
225 const Instruction* instruction = Instruction::At(&code_item->insns_[dex_pc]);
226 return instruction->IsReturn();
227 }
228
Mathieu Chartier90443472015-07-16 20:32:27 -0700229 static bool IsListeningToDexPcMoved() SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200230 return IsListeningTo(instrumentation::Instrumentation::kDexPcMoved);
231 }
232
Mathieu Chartier90443472015-07-16 20:32:27 -0700233 static bool IsListeningToMethodExit() SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200234 return IsListeningTo(instrumentation::Instrumentation::kMethodExited);
235 }
236
237 static bool IsListeningTo(instrumentation::Instrumentation::InstrumentationEvent event)
Mathieu Chartier90443472015-07-16 20:32:27 -0700238 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200239 return (Dbg::GetInstrumentationEvents() & event) != 0;
240 }
241
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200242 DISALLOW_COPY_AND_ASSIGN(DebugInstrumentationListener);
Ian Rogers62d6c772013-02-27 08:32:07 -0800243} gDebugInstrumentationListener;
244
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700245// JDWP is allowed unless the Zygote forbids it.
246static bool gJdwpAllowed = true;
247
Elliott Hughesc0f09332012-03-26 13:27:06 -0700248// Was there a -Xrunjdwp or -agentlib:jdwp= argument on the command line?
Elliott Hughes3bb81562011-10-21 18:52:59 -0700249static bool gJdwpConfigured = false;
250
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100251// JDWP options for debugging. Only valid if IsJdwpConfigured() is true.
252static JDWP::JdwpOptions gJdwpOptions;
253
Elliott Hughes3bb81562011-10-21 18:52:59 -0700254// Runtime JDWP state.
Ian Rogersc0542af2014-09-03 16:16:56 -0700255static JDWP::JdwpState* gJdwpState = nullptr;
Elliott Hughes3bb81562011-10-21 18:52:59 -0700256static bool gDebuggerConnected; // debugger or DDMS is connected.
Elliott Hughes3bb81562011-10-21 18:52:59 -0700257
Elliott Hughes47fce012011-10-25 18:37:19 -0700258static bool gDdmThreadNotification = false;
259
Elliott Hughes767a1472011-10-26 18:49:02 -0700260// DDMS GC-related settings.
261static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
262static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
263static Dbg::HpsgWhat gDdmHpsgWhat;
264static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
265static Dbg::HpsgWhat gDdmNhsgWhat;
266
Daniel Mihalyieb076692014-08-22 17:33:31 +0200267bool Dbg::gDebuggerActive = false;
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100268bool Dbg::gDisposed = false;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200269ObjectRegistry* Dbg::gRegistry = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700270
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100271// Deoptimization support.
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100272std::vector<DeoptimizationRequest> Dbg::deoptimization_requests_;
273size_t Dbg::full_deoptimization_event_count_ = 0;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100274
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200275// Instrumentation event reference counters.
276size_t Dbg::dex_pc_change_event_ref_count_ = 0;
277size_t Dbg::method_enter_event_ref_count_ = 0;
278size_t Dbg::method_exit_event_ref_count_ = 0;
279size_t Dbg::field_read_event_ref_count_ = 0;
280size_t Dbg::field_write_event_ref_count_ = 0;
281size_t Dbg::exception_catch_event_ref_count_ = 0;
282uint32_t Dbg::instrumentation_events_ = 0;
283
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100284// Breakpoints.
jeffhao09bfc6a2012-12-11 18:11:43 -0800285static std::vector<Breakpoint> gBreakpoints GUARDED_BY(Locks::breakpoint_lock_);
Elliott Hughes86964332012-02-15 19:37:42 -0800286
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -0700287void DebugInvokeReq::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
288 receiver.VisitRootIfNonNull(visitor, root_info); // null for static method call.
289 klass.VisitRoot(visitor, root_info);
Mathieu Chartier3b05e9b2014-03-25 09:29:43 -0700290}
291
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100292void SingleStepControl::AddDexPc(uint32_t dex_pc) {
293 dex_pcs_.insert(dex_pc);
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200294}
295
Sebastien Hertz597c4f02015-01-26 17:37:14 +0100296bool SingleStepControl::ContainsDexPc(uint32_t dex_pc) const {
297 return dex_pcs_.find(dex_pc) == dex_pcs_.end();
Sebastien Hertzbb43b432014-04-14 11:59:08 +0200298}
299
Mathieu Chartiere401d142015-04-22 13:56:20 -0700300static bool IsBreakpoint(const ArtMethod* m, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -0700301 REQUIRES(!Locks::breakpoint_lock_)
302 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzed2be172014-08-19 15:33:43 +0200303 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100304 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -0700305 if (gBreakpoints[i].DexPc() == dex_pc && gBreakpoints[i].Method() == m) {
Elliott Hughes86964332012-02-15 19:37:42 -0800306 VLOG(jdwp) << "Hit breakpoint #" << i << ": " << gBreakpoints[i];
307 return true;
308 }
309 }
310 return false;
311}
312
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100313static bool IsSuspendedForDebugger(ScopedObjectAccessUnchecked& soa, Thread* thread)
Mathieu Chartier90443472015-07-16 20:32:27 -0700314 REQUIRES(!Locks::thread_suspend_count_lock_) {
Elliott Hughes9e0c1752013-01-09 14:02:58 -0800315 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
316 // A thread may be suspended for GC; in this code, we really want to know whether
317 // there's a debugger suspension active.
318 return thread->IsSuspended() && thread->GetDebugSuspendCount() > 0;
319}
320
Ian Rogersc0542af2014-09-03 16:16:56 -0700321static mirror::Array* DecodeNonNullArray(JDWP::RefTypeId id, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -0700322 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200323 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700324 if (o == nullptr) {
325 *error = JDWP::ERR_INVALID_OBJECT;
326 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800327 }
328 if (!o->IsArrayInstance()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700329 *error = JDWP::ERR_INVALID_ARRAY;
330 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800331 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700332 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800333 return o->AsArray();
334}
335
Ian Rogersc0542af2014-09-03 16:16:56 -0700336static mirror::Class* DecodeClass(JDWP::RefTypeId id, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -0700337 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200338 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700339 if (o == nullptr) {
340 *error = JDWP::ERR_INVALID_OBJECT;
341 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800342 }
343 if (!o->IsClass()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700344 *error = JDWP::ERR_INVALID_CLASS;
345 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800346 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700347 *error = JDWP::ERR_NONE;
Elliott Hughes436e3722012-02-17 20:01:47 -0800348 return o->AsClass();
349}
350
Ian Rogersc0542af2014-09-03 16:16:56 -0700351static Thread* DecodeThread(ScopedObjectAccessUnchecked& soa, JDWP::ObjectId thread_id,
352 JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -0700353 SHARED_REQUIRES(Locks::mutator_lock_)
354 REQUIRES(!Locks::thread_list_lock_, !Locks::thread_suspend_count_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +0200355 mirror::Object* thread_peer = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_id, error);
Ian Rogersc0542af2014-09-03 16:16:56 -0700356 if (thread_peer == nullptr) {
Elliott Hughes221229c2013-01-08 18:17:50 -0800357 // This isn't even an object.
Ian Rogersc0542af2014-09-03 16:16:56 -0700358 *error = JDWP::ERR_INVALID_OBJECT;
359 return nullptr;
Elliott Hughes436e3722012-02-17 20:01:47 -0800360 }
Elliott Hughes221229c2013-01-08 18:17:50 -0800361
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800362 mirror::Class* java_lang_Thread = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
Elliott Hughes221229c2013-01-08 18:17:50 -0800363 if (!java_lang_Thread->IsAssignableFrom(thread_peer->GetClass())) {
364 // This isn't a thread.
Ian Rogersc0542af2014-09-03 16:16:56 -0700365 *error = JDWP::ERR_INVALID_THREAD;
366 return nullptr;
Elliott Hughes221229c2013-01-08 18:17:50 -0800367 }
368
Sebastien Hertz69206392015-04-07 15:54:25 +0200369 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
Ian Rogersc0542af2014-09-03 16:16:56 -0700370 Thread* thread = Thread::FromManagedThread(soa, thread_peer);
371 // If thread is null then this a java.lang.Thread without a Thread*. Must be a un-started or a
372 // zombie.
373 *error = (thread == nullptr) ? JDWP::ERR_THREAD_NOT_ALIVE : JDWP::ERR_NONE;
374 return thread;
Elliott Hughes436e3722012-02-17 20:01:47 -0800375}
376
Elliott Hughes24437992011-11-30 14:49:33 -0800377static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
378 // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
379 // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
380 return static_cast<JDWP::JdwpTag>(descriptor[0]);
381}
382
Ian Rogers1ff3c982014-08-12 02:30:58 -0700383static JDWP::JdwpTag BasicTagFromClass(mirror::Class* klass)
Mathieu Chartier90443472015-07-16 20:32:27 -0700384 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers1ff3c982014-08-12 02:30:58 -0700385 std::string temp;
386 const char* descriptor = klass->GetDescriptor(&temp);
387 return BasicTagFromDescriptor(descriptor);
388}
389
Ian Rogers98379392014-02-24 16:53:16 -0800390static JDWP::JdwpTag TagFromClass(const ScopedObjectAccessUnchecked& soa, mirror::Class* c)
Mathieu Chartier90443472015-07-16 20:32:27 -0700391 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700392 CHECK(c != nullptr);
Elliott Hughes24437992011-11-30 14:49:33 -0800393 if (c->IsArrayClass()) {
394 return JDWP::JT_ARRAY;
395 }
Elliott Hughes24437992011-11-30 14:49:33 -0800396 if (c->IsStringClass()) {
397 return JDWP::JT_STRING;
Elliott Hughes24437992011-11-30 14:49:33 -0800398 }
Ian Rogers98379392014-02-24 16:53:16 -0800399 if (c->IsClassClass()) {
400 return JDWP::JT_CLASS_OBJECT;
401 }
402 {
403 mirror::Class* thread_class = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
404 if (thread_class->IsAssignableFrom(c)) {
405 return JDWP::JT_THREAD;
406 }
407 }
408 {
409 mirror::Class* thread_group_class =
410 soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
411 if (thread_group_class->IsAssignableFrom(c)) {
412 return JDWP::JT_THREAD_GROUP;
413 }
414 }
415 {
416 mirror::Class* class_loader_class =
417 soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ClassLoader);
418 if (class_loader_class->IsAssignableFrom(c)) {
419 return JDWP::JT_CLASS_LOADER;
420 }
421 }
422 return JDWP::JT_OBJECT;
Elliott Hughes24437992011-11-30 14:49:33 -0800423}
424
425/*
426 * Objects declared to hold Object might actually hold a more specific
427 * type. The debugger may take a special interest in these (e.g. it
428 * wants to display the contents of Strings), so we want to return an
429 * appropriate tag.
430 *
431 * Null objects are tagged JT_OBJECT.
432 */
Sebastien Hertz6995c602014-09-09 12:10:13 +0200433JDWP::JdwpTag Dbg::TagFromObject(const ScopedObjectAccessUnchecked& soa, mirror::Object* o) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700434 return (o == nullptr) ? JDWP::JT_OBJECT : TagFromClass(soa, o->GetClass());
Elliott Hughes24437992011-11-30 14:49:33 -0800435}
436
437static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
438 switch (tag) {
439 case JDWP::JT_BOOLEAN:
440 case JDWP::JT_BYTE:
441 case JDWP::JT_CHAR:
442 case JDWP::JT_FLOAT:
443 case JDWP::JT_DOUBLE:
444 case JDWP::JT_INT:
445 case JDWP::JT_LONG:
446 case JDWP::JT_SHORT:
447 case JDWP::JT_VOID:
448 return true;
449 default:
450 return false;
451 }
452}
453
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100454void Dbg::StartJdwp() {
Elliott Hughesc0f09332012-03-26 13:27:06 -0700455 if (!gJdwpAllowed || !IsJdwpConfigured()) {
Elliott Hughes376a7a02011-10-24 18:35:55 -0700456 // No JDWP for you!
457 return;
458 }
459
Ian Rogers719d1a32014-03-06 12:13:39 -0800460 CHECK(gRegistry == nullptr);
Elliott Hughes475fc232011-10-25 15:00:35 -0700461 gRegistry = new ObjectRegistry;
462
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700463 // Init JDWP if the debugger is enabled. This may connect out to a
464 // debugger, passively listen for a debugger, or block waiting for a
465 // debugger.
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100466 gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
Ian Rogersc0542af2014-09-03 16:16:56 -0700467 if (gJdwpState == nullptr) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -0800468 // We probably failed because some other process has the port already, which means that
469 // if we don't abort the user is likely to think they're talking to us when they're actually
470 // talking to that other process.
Elliott Hughes3d30d9b2011-12-07 17:35:48 -0800471 LOG(FATAL) << "Debugger thread failed to initialize";
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700472 }
473
474 // If a debugger has already attached, send the "welcome" message.
475 // This may cause us to suspend all threads.
Elliott Hughes376a7a02011-10-24 18:35:55 -0700476 if (gJdwpState->IsActive()) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700477 ScopedObjectAccess soa(Thread::Current());
Sebastien Hertz7d955652014-10-22 10:57:10 +0200478 gJdwpState->PostVMStart();
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700479 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700480}
481
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700482void Dbg::StopJdwp() {
Sebastien Hertzc6345ef2014-08-18 19:26:39 +0200483 // Post VM_DEATH event before the JDWP connection is closed (either by the JDWP thread or the
484 // destruction of gJdwpState).
485 if (gJdwpState != nullptr && gJdwpState->IsActive()) {
486 gJdwpState->PostVMDeath();
487 }
Sebastien Hertz0376e6b2014-02-06 18:12:59 +0100488 // Prevent the JDWP thread from processing JDWP incoming packets after we close the connection.
Sebastien Hertz4e5b2082015-03-24 19:03:40 +0100489 Dispose();
Elliott Hughes376a7a02011-10-24 18:35:55 -0700490 delete gJdwpState;
Ian Rogers719d1a32014-03-06 12:13:39 -0800491 gJdwpState = nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700492 delete gRegistry;
Ian Rogers719d1a32014-03-06 12:13:39 -0800493 gRegistry = nullptr;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700494}
495
Elliott Hughes767a1472011-10-26 18:49:02 -0700496void Dbg::GcDidFinish() {
497 if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700498 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700499 VLOG(jdwp) << "Sending heap info to DDM";
Elliott Hughes7162ad92011-10-27 14:08:42 -0700500 DdmSendHeapInfo(gDdmHpifWhen);
Elliott Hughes767a1472011-10-26 18:49:02 -0700501 }
502 if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700503 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700504 VLOG(jdwp) << "Dumping heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700505 DdmSendHeapSegments(false);
Elliott Hughes767a1472011-10-26 18:49:02 -0700506 }
507 if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700508 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom4d466a82014-05-08 19:05:29 -0700509 VLOG(jdwp) << "Dumping native heap to DDM";
Elliott Hughes6a5bd492011-10-28 14:33:57 -0700510 DdmSendHeapSegments(true);
Elliott Hughes767a1472011-10-26 18:49:02 -0700511 }
512}
513
Elliott Hughes4ffd3132011-10-24 12:06:42 -0700514void Dbg::SetJdwpAllowed(bool allowed) {
515 gJdwpAllowed = allowed;
516}
517
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700518DebugInvokeReq* Dbg::GetInvokeReq() {
Elliott Hughes475fc232011-10-25 15:00:35 -0700519 return Thread::Current()->GetInvokeReq();
520}
521
522Thread* Dbg::GetDebugThread() {
Ian Rogersc0542af2014-09-03 16:16:56 -0700523 return (gJdwpState != nullptr) ? gJdwpState->GetDebugThread() : nullptr;
Elliott Hughes475fc232011-10-25 15:00:35 -0700524}
525
526void Dbg::ClearWaitForEventThread() {
Sebastien Hertz2bf93f42015-01-09 18:44:05 +0100527 gJdwpState->ReleaseJdwpTokenForEvent();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700528}
529
530void Dbg::Connected() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700531 CHECK(!gDebuggerConnected);
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -0800532 VLOG(jdwp) << "JDWP has attached";
Elliott Hughes3bb81562011-10-21 18:52:59 -0700533 gDebuggerConnected = true;
Elliott Hughes86964332012-02-15 19:37:42 -0800534 gDisposed = false;
535}
536
Sebastien Hertzf3928792014-11-17 19:00:37 +0100537bool Dbg::RequiresDeoptimization() {
538 // We don't need deoptimization if everything runs with interpreter after
539 // enabling -Xint mode.
540 return !Runtime::Current()->GetInstrumentation()->IsForcedInterpretOnly();
541}
542
Elliott Hughesa2155262011-11-16 16:26:58 -0800543void Dbg::GoActive() {
544 // Enable all debugging features, including scans for breakpoints.
545 // This is a no-op if we're already active.
546 // Only called from the JDWP handler thread.
Daniel Mihalyieb076692014-08-22 17:33:31 +0200547 if (IsDebuggerActive()) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800548 return;
549 }
550
Elliott Hughesc0f09332012-03-26 13:27:06 -0700551 {
552 // TODO: dalvik only warned if there were breakpoints left over. clear in Dbg::Disconnected?
Sebastien Hertzed2be172014-08-19 15:33:43 +0200553 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Elliott Hughesc0f09332012-03-26 13:27:06 -0700554 CHECK_EQ(gBreakpoints.size(), 0U);
555 }
Elliott Hughesa2155262011-11-16 16:26:58 -0800556
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100557 {
Brian Carlstrom306db812014-09-05 13:01:41 -0700558 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100559 CHECK_EQ(deoptimization_requests_.size(), 0U);
560 CHECK_EQ(full_deoptimization_event_count_, 0U);
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200561 CHECK_EQ(dex_pc_change_event_ref_count_, 0U);
562 CHECK_EQ(method_enter_event_ref_count_, 0U);
563 CHECK_EQ(method_exit_event_ref_count_, 0U);
564 CHECK_EQ(field_read_event_ref_count_, 0U);
565 CHECK_EQ(field_write_event_ref_count_, 0U);
566 CHECK_EQ(exception_catch_event_ref_count_, 0U);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100567 }
568
Ian Rogers62d6c772013-02-27 08:32:07 -0800569 Runtime* runtime = Runtime::Current();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700570 runtime->GetThreadList()->SuspendAll(__FUNCTION__);
Ian Rogers62d6c772013-02-27 08:32:07 -0800571 Thread* self = Thread::Current();
572 ThreadState old_state = self->SetStateUnsafe(kRunnable);
573 CHECK_NE(old_state, kRunnable);
Sebastien Hertzf3928792014-11-17 19:00:37 +0100574 if (RequiresDeoptimization()) {
575 runtime->GetInstrumentation()->EnableDeoptimization();
576 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200577 instrumentation_events_ = 0;
Elliott Hughesa2155262011-11-16 16:26:58 -0800578 gDebuggerActive = true;
Ian Rogers62d6c772013-02-27 08:32:07 -0800579 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
580 runtime->GetThreadList()->ResumeAll();
581
582 LOG(INFO) << "Debugger is active";
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700583}
584
585void Dbg::Disconnected() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700586 CHECK(gDebuggerConnected);
587
Elliott Hughesc0f09332012-03-26 13:27:06 -0700588 LOG(INFO) << "Debugger is no longer active";
Elliott Hughes234ab152011-10-26 14:02:26 -0700589
Ian Rogers62d6c772013-02-27 08:32:07 -0800590 // Suspend all threads and exclusively acquire the mutator lock. Set the state of the thread
591 // to kRunnable to avoid scoped object access transitions. Remove the debugger as a listener
592 // and clear the object registry.
593 Runtime* runtime = Runtime::Current();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700594 runtime->GetThreadList()->SuspendAll(__FUNCTION__);
Ian Rogers62d6c772013-02-27 08:32:07 -0800595 Thread* self = Thread::Current();
596 ThreadState old_state = self->SetStateUnsafe(kRunnable);
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100597
598 // Debugger may not be active at this point.
Daniel Mihalyieb076692014-08-22 17:33:31 +0200599 if (IsDebuggerActive()) {
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100600 {
601 // Since we're going to disable deoptimization, we clear the deoptimization requests queue.
602 // This prevents us from having any pending deoptimization request when the debugger attaches
603 // to us again while no event has been requested yet.
Brian Carlstrom306db812014-09-05 13:01:41 -0700604 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +0100605 deoptimization_requests_.clear();
606 full_deoptimization_event_count_ = 0U;
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100607 }
Sebastien Hertz42cd43f2014-05-13 14:15:41 +0200608 if (instrumentation_events_ != 0) {
609 runtime->GetInstrumentation()->RemoveListener(&gDebugInstrumentationListener,
610 instrumentation_events_);
611 instrumentation_events_ = 0;
612 }
Sebastien Hertzf3928792014-11-17 19:00:37 +0100613 if (RequiresDeoptimization()) {
Sebastien Hertz0462c4c2015-04-01 16:34:17 +0200614 runtime->GetInstrumentation()->DisableDeoptimization(kDbgInstrumentationKey);
Sebastien Hertzf3928792014-11-17 19:00:37 +0100615 }
Sebastien Hertzaaea7342014-02-25 15:10:04 +0100616 gDebuggerActive = false;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +0100617 }
Ian Rogers62d6c772013-02-27 08:32:07 -0800618 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
619 runtime->GetThreadList()->ResumeAll();
Sebastien Hertz55f65342015-01-13 22:48:34 +0100620
621 {
622 ScopedObjectAccess soa(self);
623 gRegistry->Clear();
624 }
625
626 gDebuggerConnected = false;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700627}
628
Sebastien Hertzb3b173b2015-02-06 09:16:32 +0100629void Dbg::ConfigureJdwp(const JDWP::JdwpOptions& jdwp_options) {
630 CHECK_NE(jdwp_options.transport, JDWP::kJdwpTransportUnknown);
631 gJdwpOptions = jdwp_options;
632 gJdwpConfigured = true;
633}
634
Elliott Hughesc0f09332012-03-26 13:27:06 -0700635bool Dbg::IsJdwpConfigured() {
Elliott Hughes3bb81562011-10-21 18:52:59 -0700636 return gJdwpConfigured;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700637}
638
639int64_t Dbg::LastDebuggerActivity() {
Elliott Hughesca951522011-12-05 12:01:32 -0800640 return gJdwpState->LastDebuggerActivity();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700641}
642
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700643void Dbg::UndoDebuggerSuspensions() {
Elliott Hughes234ab152011-10-26 14:02:26 -0700644 Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700645}
646
Elliott Hughes88d63092013-01-09 09:55:54 -0800647std::string Dbg::GetClassName(JDWP::RefTypeId class_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700648 JDWP::JdwpError error;
649 mirror::Object* o = gRegistry->Get<mirror::Object*>(class_id, &error);
650 if (o == nullptr) {
651 if (error == JDWP::ERR_NONE) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700652 return "null";
Ian Rogersc0542af2014-09-03 16:16:56 -0700653 } else {
654 return StringPrintf("invalid object %p", reinterpret_cast<void*>(class_id));
655 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800656 }
657 if (!o->IsClass()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700658 return StringPrintf("non-class %p", o); // This is only used for debugging output anyway.
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800659 }
Sebastien Hertz6995c602014-09-09 12:10:13 +0200660 return GetClassName(o->AsClass());
661}
662
663std::string Dbg::GetClassName(mirror::Class* klass) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200664 if (klass == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700665 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +0200666 }
Ian Rogers1ff3c982014-08-12 02:30:58 -0700667 std::string temp;
Sebastien Hertz6995c602014-09-09 12:10:13 +0200668 return DescriptorToName(klass->GetDescriptor(&temp));
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700669}
670
Ian Rogersc0542af2014-09-03 16:16:56 -0700671JDWP::JdwpError Dbg::GetClassObject(JDWP::RefTypeId id, JDWP::ObjectId* class_object_id) {
Elliott Hughes436e3722012-02-17 20:01:47 -0800672 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700673 mirror::Class* c = DecodeClass(id, &status);
674 if (c == nullptr) {
675 *class_object_id = 0;
Elliott Hughes436e3722012-02-17 20:01:47 -0800676 return status;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800677 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700678 *class_object_id = gRegistry->Add(c);
Elliott Hughes436e3722012-02-17 20:01:47 -0800679 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -0800680}
681
Ian Rogersc0542af2014-09-03 16:16:56 -0700682JDWP::JdwpError Dbg::GetSuperclass(JDWP::RefTypeId id, JDWP::RefTypeId* superclass_id) {
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800683 JDWP::JdwpError status;
Ian Rogersc0542af2014-09-03 16:16:56 -0700684 mirror::Class* c = DecodeClass(id, &status);
685 if (c == nullptr) {
686 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800687 return status;
688 }
689 if (c->IsInterface()) {
690 // http://code.google.com/p/android/issues/detail?id=20856
Ian Rogersc0542af2014-09-03 16:16:56 -0700691 *superclass_id = 0;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800692 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700693 *superclass_id = gRegistry->Add(c->GetSuperClass());
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -0800694 }
695 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700696}
697
Elliott Hughes436e3722012-02-17 20:01:47 -0800698JDWP::JdwpError Dbg::GetClassLoader(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700699 JDWP::JdwpError error;
700 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
701 if (o == nullptr) {
Elliott Hughes436e3722012-02-17 20:01:47 -0800702 return JDWP::ERR_INVALID_OBJECT;
703 }
704 expandBufAddObjectId(pReply, gRegistry->Add(o->GetClass()->GetClassLoader()));
705 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700706}
707
Elliott Hughes436e3722012-02-17 20:01:47 -0800708JDWP::JdwpError Dbg::GetModifiers(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700709 JDWP::JdwpError error;
710 mirror::Class* c = DecodeClass(id, &error);
711 if (c == nullptr) {
712 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800713 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800714
715 uint32_t access_flags = c->GetAccessFlags() & kAccJavaFlagsMask;
716
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700717 // Set ACC_SUPER. Dex files don't contain this flag but only classes are supposed to have it set,
718 // not interfaces.
Elliott Hughes436e3722012-02-17 20:01:47 -0800719 // Class.getModifiers doesn't return it, but JDWP does, so we set it here.
Yevgeny Roubande34eea2014-02-15 01:06:03 +0700720 if ((access_flags & kAccInterface) == 0) {
721 access_flags |= kAccSuper;
722 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800723
724 expandBufAdd4BE(pReply, access_flags);
725
726 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700727}
728
Ian Rogersc0542af2014-09-03 16:16:56 -0700729JDWP::JdwpError Dbg::GetMonitorInfo(JDWP::ObjectId object_id, JDWP::ExpandBuf* reply) {
730 JDWP::JdwpError error;
731 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
732 if (o == nullptr) {
Elliott Hughesf327e072013-01-09 16:01:26 -0800733 return JDWP::ERR_INVALID_OBJECT;
734 }
735
736 // Ensure all threads are suspended while we read objects' lock words.
737 Thread* self = Thread::Current();
Sebastien Hertz54263242014-03-19 18:16:50 +0100738 CHECK_EQ(self->GetState(), kRunnable);
739 self->TransitionFromRunnableToSuspended(kSuspended);
Mathieu Chartierbf9fc582015-03-13 17:21:25 -0700740 Runtime::Current()->GetThreadList()->SuspendAll(__FUNCTION__);
Elliott Hughesf327e072013-01-09 16:01:26 -0800741
742 MonitorInfo monitor_info(o);
743
Sebastien Hertz54263242014-03-19 18:16:50 +0100744 Runtime::Current()->GetThreadList()->ResumeAll();
745 self->TransitionFromSuspendedToRunnable();
Elliott Hughesf327e072013-01-09 16:01:26 -0800746
Ian Rogersc0542af2014-09-03 16:16:56 -0700747 if (monitor_info.owner_ != nullptr) {
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700748 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.owner_->GetPeer()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800749 } else {
Ian Rogersc0542af2014-09-03 16:16:56 -0700750 expandBufAddObjectId(reply, gRegistry->Add(nullptr));
Elliott Hughesf327e072013-01-09 16:01:26 -0800751 }
Ian Rogersd9c4fc92013-10-01 19:45:43 -0700752 expandBufAdd4BE(reply, monitor_info.entry_count_);
753 expandBufAdd4BE(reply, monitor_info.waiters_.size());
754 for (size_t i = 0; i < monitor_info.waiters_.size(); ++i) {
755 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.waiters_[i]->GetPeer()));
Elliott Hughesf327e072013-01-09 16:01:26 -0800756 }
757 return JDWP::ERR_NONE;
758}
759
Elliott Hughes734b8c62013-01-11 15:32:45 -0800760JDWP::JdwpError Dbg::GetOwnedMonitors(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700761 std::vector<JDWP::ObjectId>* monitors,
762 std::vector<uint32_t>* stack_depths) {
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800763 struct OwnedMonitorVisitor : public StackVisitor {
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700764 OwnedMonitorVisitor(Thread* thread, Context* context,
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700765 std::vector<JDWP::ObjectId>* monitor_vector,
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700766 std::vector<uint32_t>* stack_depth_vector)
Mathieu Chartier90443472015-07-16 20:32:27 -0700767 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +0100768 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
769 current_stack_depth(0),
770 monitors(monitor_vector),
771 stack_depths(stack_depth_vector) {}
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800772
773 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
774 // annotalysis.
775 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
776 if (!GetMethod()->IsRuntimeMethod()) {
777 Monitor::VisitLocks(this, AppendOwnedMonitors, this);
Elliott Hughes734b8c62013-01-11 15:32:45 -0800778 ++current_stack_depth;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800779 }
780 return true;
781 }
782
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700783 static void AppendOwnedMonitors(mirror::Object* owned_monitor, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -0700784 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers7a22fa62013-01-23 12:16:16 -0800785 OwnedMonitorVisitor* visitor = reinterpret_cast<OwnedMonitorVisitor*>(arg);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700786 visitor->monitors->push_back(gRegistry->Add(owned_monitor));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700787 visitor->stack_depths->push_back(visitor->current_stack_depth);
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800788 }
789
Elliott Hughes734b8c62013-01-11 15:32:45 -0800790 size_t current_stack_depth;
Ian Rogersc0542af2014-09-03 16:16:56 -0700791 std::vector<JDWP::ObjectId>* const monitors;
792 std::vector<uint32_t>* const stack_depths;
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800793 };
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800794
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700795 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +0200796 JDWP::JdwpError error;
797 Thread* thread = DecodeThread(soa, thread_id, &error);
798 if (thread == nullptr) {
799 return error;
800 }
801 if (!IsSuspendedForDebugger(soa, thread)) {
802 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700803 }
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700804 std::unique_ptr<Context> context(Context::Create());
Ian Rogersc0542af2014-09-03 16:16:56 -0700805 OwnedMonitorVisitor visitor(thread, context.get(), monitors, stack_depths);
Hiroshi Yamauchicc8c5c52014-06-13 15:08:05 -0700806 visitor.WalkStack();
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800807 return JDWP::ERR_NONE;
808}
809
Sebastien Hertz52d131d2014-03-13 16:17:40 +0100810JDWP::JdwpError Dbg::GetContendedMonitor(JDWP::ObjectId thread_id,
Ian Rogersc0542af2014-09-03 16:16:56 -0700811 JDWP::ObjectId* contended_monitor) {
Elliott Hughesf9501702013-01-11 11:22:27 -0800812 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -0700813 *contended_monitor = 0;
Sebastien Hertz69206392015-04-07 15:54:25 +0200814 JDWP::JdwpError error;
815 Thread* thread = DecodeThread(soa, thread_id, &error);
816 if (thread == nullptr) {
817 return error;
Elliott Hughesf9501702013-01-11 11:22:27 -0800818 }
Sebastien Hertz69206392015-04-07 15:54:25 +0200819 if (!IsSuspendedForDebugger(soa, thread)) {
820 return JDWP::ERR_THREAD_NOT_SUSPENDED;
821 }
822 mirror::Object* contended_monitor_obj = Monitor::GetContendedMonitor(thread);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -0700823 // Add() requires the thread_list_lock_ not held to avoid the lock
824 // level violation.
Ian Rogersc0542af2014-09-03 16:16:56 -0700825 *contended_monitor = gRegistry->Add(contended_monitor_obj);
Elliott Hughesf9501702013-01-11 11:22:27 -0800826 return JDWP::ERR_NONE;
827}
828
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800829JDWP::JdwpError Dbg::GetInstanceCounts(const std::vector<JDWP::RefTypeId>& class_ids,
Ian Rogersc0542af2014-09-03 16:16:56 -0700830 std::vector<uint64_t>* counts) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800831 gc::Heap* heap = Runtime::Current()->GetHeap();
832 heap->CollectGarbage(false);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800833 std::vector<mirror::Class*> classes;
Ian Rogersc0542af2014-09-03 16:16:56 -0700834 counts->clear();
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800835 for (size_t i = 0; i < class_ids.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700836 JDWP::JdwpError error;
837 mirror::Class* c = DecodeClass(class_ids[i], &error);
838 if (c == nullptr) {
839 return error;
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800840 }
841 classes.push_back(c);
Ian Rogersc0542af2014-09-03 16:16:56 -0700842 counts->push_back(0);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800843 }
Ian Rogersc0542af2014-09-03 16:16:56 -0700844 heap->CountInstances(classes, false, &(*counts)[0]);
Elliott Hughesec0f83d2013-01-15 16:54:08 -0800845 return JDWP::ERR_NONE;
846}
847
Ian Rogersc0542af2014-09-03 16:16:56 -0700848JDWP::JdwpError Dbg::GetInstances(JDWP::RefTypeId class_id, int32_t max_count,
849 std::vector<JDWP::ObjectId>* instances) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800850 gc::Heap* heap = Runtime::Current()->GetHeap();
851 // We only want reachable instances, so do a GC.
852 heap->CollectGarbage(false);
Ian Rogersc0542af2014-09-03 16:16:56 -0700853 JDWP::JdwpError error;
854 mirror::Class* c = DecodeClass(class_id, &error);
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800855 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700856 return error;
Elliott Hughes3b78c942013-01-15 17:35:41 -0800857 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800858 std::vector<mirror::Object*> raw_instances;
Elliott Hughes3b78c942013-01-15 17:35:41 -0800859 Runtime::Current()->GetHeap()->GetInstances(c, max_count, raw_instances);
860 for (size_t i = 0; i < raw_instances.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700861 instances->push_back(gRegistry->Add(raw_instances[i]));
Elliott Hughes3b78c942013-01-15 17:35:41 -0800862 }
863 return JDWP::ERR_NONE;
864}
865
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800866JDWP::JdwpError Dbg::GetReferringObjects(JDWP::ObjectId object_id, int32_t max_count,
Ian Rogersc0542af2014-09-03 16:16:56 -0700867 std::vector<JDWP::ObjectId>* referring_objects) {
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800868 gc::Heap* heap = Runtime::Current()->GetHeap();
869 heap->CollectGarbage(false);
Ian Rogersc0542af2014-09-03 16:16:56 -0700870 JDWP::JdwpError error;
871 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
872 if (o == nullptr) {
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800873 return JDWP::ERR_INVALID_OBJECT;
874 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800875 std::vector<mirror::Object*> raw_instances;
Mathieu Chartier412c7fc2014-02-07 12:18:39 -0800876 heap->GetReferringObjects(o, max_count, raw_instances);
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800877 for (size_t i = 0; i < raw_instances.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700878 referring_objects->push_back(gRegistry->Add(raw_instances[i]));
Elliott Hughes0cbaff52013-01-16 15:28:01 -0800879 }
880 return JDWP::ERR_NONE;
881}
882
Ian Rogersc0542af2014-09-03 16:16:56 -0700883JDWP::JdwpError Dbg::DisableCollection(JDWP::ObjectId object_id) {
884 JDWP::JdwpError error;
885 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
886 if (o == nullptr) {
Sebastien Hertze96060a2013-12-11 12:06:28 +0100887 return JDWP::ERR_INVALID_OBJECT;
888 }
Elliott Hughes64f574f2013-02-20 14:57:12 -0800889 gRegistry->DisableCollection(object_id);
890 return JDWP::ERR_NONE;
891}
892
Ian Rogersc0542af2014-09-03 16:16:56 -0700893JDWP::JdwpError Dbg::EnableCollection(JDWP::ObjectId object_id) {
894 JDWP::JdwpError error;
895 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
Sebastien Hertze96060a2013-12-11 12:06:28 +0100896 // Unlike DisableCollection, JDWP specs do not state an invalid object causes an error. The RI
897 // also ignores these cases and never return an error. However it's not obvious why this command
898 // should behave differently from DisableCollection and IsCollected commands. So let's be more
899 // strict and return an error if this happens.
Ian Rogersc0542af2014-09-03 16:16:56 -0700900 if (o == nullptr) {
Sebastien Hertze96060a2013-12-11 12:06:28 +0100901 return JDWP::ERR_INVALID_OBJECT;
902 }
Elliott Hughes64f574f2013-02-20 14:57:12 -0800903 gRegistry->EnableCollection(object_id);
904 return JDWP::ERR_NONE;
905}
906
Ian Rogersc0542af2014-09-03 16:16:56 -0700907JDWP::JdwpError Dbg::IsCollected(JDWP::ObjectId object_id, bool* is_collected) {
908 *is_collected = true;
Sebastien Hertz65637eb2014-01-10 17:40:02 +0100909 if (object_id == 0) {
910 // Null object id is invalid.
Sebastien Hertze96060a2013-12-11 12:06:28 +0100911 return JDWP::ERR_INVALID_OBJECT;
912 }
Sebastien Hertz65637eb2014-01-10 17:40:02 +0100913 // JDWP specs state an INVALID_OBJECT error is returned if the object ID is not valid. However
914 // the RI seems to ignore this and assume object has been collected.
Ian Rogersc0542af2014-09-03 16:16:56 -0700915 JDWP::JdwpError error;
916 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
917 if (o != nullptr) {
918 *is_collected = gRegistry->IsCollected(object_id);
Sebastien Hertz65637eb2014-01-10 17:40:02 +0100919 }
Elliott Hughes64f574f2013-02-20 14:57:12 -0800920 return JDWP::ERR_NONE;
921}
922
Ian Rogersc0542af2014-09-03 16:16:56 -0700923void Dbg::DisposeObject(JDWP::ObjectId object_id, uint32_t reference_count) {
Elliott Hughes64f574f2013-02-20 14:57:12 -0800924 gRegistry->DisposeObject(object_id, reference_count);
925}
926
Sebastien Hertz6995c602014-09-09 12:10:13 +0200927JDWP::JdwpTypeTag Dbg::GetTypeTag(mirror::Class* klass) {
Sebastien Hertz4d8fd492014-03-28 16:29:41 +0100928 DCHECK(klass != nullptr);
929 if (klass->IsArrayClass()) {
930 return JDWP::TT_ARRAY;
931 } else if (klass->IsInterface()) {
932 return JDWP::TT_INTERFACE;
933 } else {
934 return JDWP::TT_CLASS;
935 }
936}
937
Elliott Hughes88d63092013-01-09 09:55:54 -0800938JDWP::JdwpError Dbg::GetReflectedType(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700939 JDWP::JdwpError error;
940 mirror::Class* c = DecodeClass(class_id, &error);
941 if (c == nullptr) {
942 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800943 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800944
Sebastien Hertz4d8fd492014-03-28 16:29:41 +0100945 JDWP::JdwpTypeTag type_tag = GetTypeTag(c);
946 expandBufAdd1(pReply, type_tag);
Elliott Hughes88d63092013-01-09 09:55:54 -0800947 expandBufAddRefTypeId(pReply, class_id);
Elliott Hughes436e3722012-02-17 20:01:47 -0800948 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700949}
950
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700951// Get the complete list of reference classes (i.e. all classes except
952// the primitive types).
953// Returns a newly-allocated buffer full of RefTypeId values.
954class ClassListCreator : public ClassVisitor {
955 public:
956 explicit ClassListCreator(std::vector<JDWP::RefTypeId>* classes) : classes_(classes) {}
957
958 bool Visit(mirror::Class* c) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
959 if (!c->IsPrimitive()) {
960 classes_->push_back(Dbg::GetObjectRegistry()->AddRefType(c));
961 }
962 return true;
963 }
964
965 private:
966 std::vector<JDWP::RefTypeId>* const classes_;
967};
968
Ian Rogersc0542af2014-09-03 16:16:56 -0700969void Dbg::GetClassList(std::vector<JDWP::RefTypeId>* classes) {
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800970 ClassListCreator clc(classes);
Mathieu Chartiere0671ce2015-07-28 17:23:28 -0700971 Runtime::Current()->GetClassLinker()->VisitClassesWithoutClassesLock(&clc);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700972}
973
Ian Rogers1ff3c982014-08-12 02:30:58 -0700974JDWP::JdwpError Dbg::GetClassInfo(JDWP::RefTypeId class_id, JDWP::JdwpTypeTag* pTypeTag,
975 uint32_t* pStatus, std::string* pDescriptor) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700976 JDWP::JdwpError error;
977 mirror::Class* c = DecodeClass(class_id, &error);
978 if (c == nullptr) {
979 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800980 }
981
Elliott Hughesa2155262011-11-16 16:26:58 -0800982 if (c->IsArrayClass()) {
983 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
984 *pTypeTag = JDWP::TT_ARRAY;
985 } else {
986 if (c->IsErroneous()) {
987 *pStatus = JDWP::CS_ERROR;
988 } else {
989 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
990 }
991 *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
992 }
993
Ian Rogersc0542af2014-09-03 16:16:56 -0700994 if (pDescriptor != nullptr) {
Ian Rogers1ff3c982014-08-12 02:30:58 -0700995 std::string temp;
996 *pDescriptor = c->GetDescriptor(&temp);
Elliott Hughesa2155262011-11-16 16:26:58 -0800997 }
Elliott Hughes436e3722012-02-17 20:01:47 -0800998 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700999}
1000
Ian Rogersc0542af2014-09-03 16:16:56 -07001001void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>* ids) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001002 std::vector<mirror::Class*> classes;
Igor Murashkinb1d8c312015-08-04 11:18:43 -07001003 Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
Ian Rogersc0542af2014-09-03 16:16:56 -07001004 ids->clear();
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001005 for (size_t i = 0; i < classes.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001006 ids->push_back(gRegistry->Add(classes[i]));
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001007 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001008}
1009
Ian Rogersc0542af2014-09-03 16:16:56 -07001010JDWP::JdwpError Dbg::GetReferenceType(JDWP::ObjectId object_id, JDWP::ExpandBuf* pReply) {
1011 JDWP::JdwpError error;
1012 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1013 if (o == nullptr) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001014 return JDWP::ERR_INVALID_OBJECT;
Elliott Hughes499c5132011-11-17 14:55:11 -08001015 }
Elliott Hughes2435a572012-02-17 16:07:41 -08001016
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001017 JDWP::JdwpTypeTag type_tag = GetTypeTag(o->GetClass());
Elliott Hughes64f574f2013-02-20 14:57:12 -08001018 JDWP::RefTypeId type_id = gRegistry->AddRefType(o->GetClass());
Elliott Hughes2435a572012-02-17 16:07:41 -08001019
1020 expandBufAdd1(pReply, type_tag);
1021 expandBufAddRefTypeId(pReply, type_id);
1022
1023 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001024}
1025
Ian Rogersfc0e94b2013-09-23 23:51:32 -07001026JDWP::JdwpError Dbg::GetSignature(JDWP::RefTypeId class_id, std::string* signature) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001027 JDWP::JdwpError error;
1028 mirror::Class* c = DecodeClass(class_id, &error);
1029 if (c == nullptr) {
1030 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001031 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001032 std::string temp;
1033 *signature = c->GetDescriptor(&temp);
Elliott Hughes1fe7afb2012-02-13 17:23:03 -08001034 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001035}
1036
Ian Rogersc0542af2014-09-03 16:16:56 -07001037JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1038 JDWP::JdwpError error;
1039 mirror::Class* c = DecodeClass(class_id, &error);
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001040 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001041 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001042 }
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001043 const char* source_file = c->GetSourceFile();
1044 if (source_file == nullptr) {
Sebastien Hertzb7054ba2014-03-13 11:52:31 +01001045 return JDWP::ERR_ABSENT_INFORMATION;
1046 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001047 *result = source_file;
Elliott Hughes436e3722012-02-17 20:01:47 -08001048 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001049}
1050
Ian Rogersc0542af2014-09-03 16:16:56 -07001051JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
Ian Rogers98379392014-02-24 16:53:16 -08001052 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001053 JDWP::JdwpError error;
1054 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1055 if (error != JDWP::ERR_NONE) {
1056 *tag = JDWP::JT_VOID;
1057 return error;
Elliott Hughes546b9862012-06-20 16:06:13 -07001058 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001059 *tag = TagFromObject(soa, o);
Elliott Hughes546b9862012-06-20 16:06:13 -07001060 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001061}
1062
Elliott Hughesaed4be92011-12-02 16:16:23 -08001063size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001064 switch (tag) {
1065 case JDWP::JT_VOID:
1066 return 0;
1067 case JDWP::JT_BYTE:
1068 case JDWP::JT_BOOLEAN:
1069 return 1;
1070 case JDWP::JT_CHAR:
1071 case JDWP::JT_SHORT:
1072 return 2;
1073 case JDWP::JT_FLOAT:
1074 case JDWP::JT_INT:
1075 return 4;
1076 case JDWP::JT_ARRAY:
1077 case JDWP::JT_OBJECT:
1078 case JDWP::JT_STRING:
1079 case JDWP::JT_THREAD:
1080 case JDWP::JT_THREAD_GROUP:
1081 case JDWP::JT_CLASS_LOADER:
1082 case JDWP::JT_CLASS_OBJECT:
1083 return sizeof(JDWP::ObjectId);
1084 case JDWP::JT_DOUBLE:
1085 case JDWP::JT_LONG:
1086 return 8;
1087 default:
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08001088 LOG(FATAL) << "Unknown tag " << tag;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001089 return -1;
1090 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001091}
1092
Ian Rogersc0542af2014-09-03 16:16:56 -07001093JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1094 JDWP::JdwpError error;
1095 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1096 if (a == nullptr) {
1097 return error;
Elliott Hughes24437992011-11-30 14:49:33 -08001098 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001099 *length = a->GetLength();
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001100 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001101}
1102
Elliott Hughes88d63092013-01-09 09:55:54 -08001103JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001104 JDWP::JdwpError error;
1105 mirror::Array* a = DecodeNonNullArray(array_id, &error);
Ian Rogers98379392014-02-24 16:53:16 -08001106 if (a == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001107 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001108 }
Elliott Hughes24437992011-11-30 14:49:33 -08001109
1110 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1111 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001112 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughes24437992011-11-30 14:49:33 -08001113 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001114 JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1115 expandBufAdd1(pReply, element_tag);
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001116 expandBufAdd4BE(pReply, count);
1117
Ian Rogers1ff3c982014-08-12 02:30:58 -07001118 if (IsPrimitiveTag(element_tag)) {
1119 size_t width = GetTagWidth(element_tag);
Elliott Hughes24437992011-11-30 14:49:33 -08001120 uint8_t* dst = expandBufAddSpace(pReply, count * width);
1121 if (width == 8) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001122 const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001123 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1124 } else if (width == 4) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001125 const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001126 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1127 } else if (width == 2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001128 const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001129 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1130 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001131 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001132 memcpy(dst, &src[offset * width], count * width);
1133 }
1134 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001135 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001136 mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
Elliott Hughes24437992011-11-30 14:49:33 -08001137 for (int i = 0; i < count; ++i) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001138 mirror::Object* element = oa->Get(offset + i);
Ian Rogers98379392014-02-24 16:53:16 -08001139 JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
Ian Rogers1ff3c982014-08-12 02:30:58 -07001140 : element_tag;
Elliott Hughes24437992011-11-30 14:49:33 -08001141 expandBufAdd1(pReply, specific_tag);
1142 expandBufAddObjectId(pReply, gRegistry->Add(element));
1143 }
1144 }
1145
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001146 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001147}
1148
Ian Rogersef7d42f2014-01-06 12:55:46 -08001149template <typename T>
Ian Rogersc0542af2014-09-03 16:16:56 -07001150static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
Ian Rogersef7d42f2014-01-06 12:55:46 -08001151 NO_THREAD_SAFETY_ANALYSIS {
1152 // TODO: fix when annotalysis correctly handles non-member functions.
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001153 DCHECK(a->GetClass()->IsPrimitiveArray());
1154
Ian Rogersef7d42f2014-01-06 12:55:46 -08001155 T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001156 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001157 *dst++ = src->ReadValue(sizeof(T));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001158 }
1159}
1160
Elliott Hughes88d63092013-01-09 09:55:54 -08001161JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
Ian Rogersc0542af2014-09-03 16:16:56 -07001162 JDWP::Request* request) {
1163 JDWP::JdwpError error;
1164 mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1165 if (dst == nullptr) {
1166 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001167 }
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001168
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001169 if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001170 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001171 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001172 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001173 JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001174
Ian Rogers1ff3c982014-08-12 02:30:58 -07001175 if (IsPrimitiveTag(element_tag)) {
1176 size_t width = GetTagWidth(element_tag);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001177 if (width == 8) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001178 CopyArrayData<uint64_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001179 } else if (width == 4) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001180 CopyArrayData<uint32_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001181 } else if (width == 2) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001182 CopyArrayData<uint16_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001183 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001184 CopyArrayData<uint8_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001185 }
1186 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001187 mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001188 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001189 JDWP::ObjectId id = request->ReadObjectId();
Ian Rogersc0542af2014-09-03 16:16:56 -07001190 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1191 if (error != JDWP::ERR_NONE) {
1192 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -08001193 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001194 oa->Set<false>(offset + i, o);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001195 }
1196 }
1197
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001198 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001199}
1200
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001201JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1202 Thread* self = Thread::Current();
1203 mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1204 if (new_string == nullptr) {
1205 DCHECK(self->IsExceptionPending());
1206 self->ClearException();
1207 LOG(ERROR) << "Could not allocate string";
1208 *new_string_id = 0;
1209 return JDWP::ERR_OUT_OF_MEMORY;
1210 }
1211 *new_string_id = gRegistry->Add(new_string);
1212 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001213}
1214
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001215JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001216 JDWP::JdwpError error;
1217 mirror::Class* c = DecodeClass(class_id, &error);
1218 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001219 *new_object_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001220 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001221 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001222 Thread* self = Thread::Current();
1223 mirror::Object* new_object = c->AllocObject(self);
1224 if (new_object == nullptr) {
1225 DCHECK(self->IsExceptionPending());
1226 self->ClearException();
1227 LOG(ERROR) << "Could not allocate object of type " << PrettyDescriptor(c);
1228 *new_object_id = 0;
1229 return JDWP::ERR_OUT_OF_MEMORY;
1230 }
1231 *new_object_id = gRegistry->Add(new_object);
Elliott Hughes436e3722012-02-17 20:01:47 -08001232 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001233}
1234
Elliott Hughesbf13d362011-12-08 15:51:37 -08001235/*
1236 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1237 */
Elliott Hughes88d63092013-01-09 09:55:54 -08001238JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001239 JDWP::ObjectId* new_array_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001240 JDWP::JdwpError error;
1241 mirror::Class* c = DecodeClass(array_class_id, &error);
1242 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001243 *new_array_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001244 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001245 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001246 Thread* self = Thread::Current();
1247 gc::Heap* heap = Runtime::Current()->GetHeap();
1248 mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1249 c->GetComponentSizeShift(),
1250 heap->GetCurrentAllocator());
1251 if (new_array == nullptr) {
1252 DCHECK(self->IsExceptionPending());
1253 self->ClearException();
1254 LOG(ERROR) << "Could not allocate array of type " << PrettyDescriptor(c);
1255 *new_array_id = 0;
1256 return JDWP::ERR_OUT_OF_MEMORY;
1257 }
1258 *new_array_id = gRegistry->Add(new_array);
Elliott Hughes436e3722012-02-17 20:01:47 -08001259 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001260}
1261
Mathieu Chartierc7853442015-03-27 14:35:38 -07001262JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001263 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
Elliott Hughes03181a82011-11-17 17:22:21 -08001264}
1265
Mathieu Chartiere401d142015-04-22 13:56:20 -07001266static JDWP::MethodId ToMethodId(const ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07001267 SHARED_REQUIRES(Locks::mutator_lock_) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001268 return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(m));
Elliott Hughes03181a82011-11-17 17:22:21 -08001269}
1270
Mathieu Chartierc7853442015-03-27 14:35:38 -07001271static ArtField* FromFieldId(JDWP::FieldId fid)
Mathieu Chartier90443472015-07-16 20:32:27 -07001272 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001273 return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
Elliott Hughesaed4be92011-12-02 16:16:23 -08001274}
1275
Mathieu Chartiere401d142015-04-22 13:56:20 -07001276static ArtMethod* FromMethodId(JDWP::MethodId mid)
Mathieu Chartier90443472015-07-16 20:32:27 -07001277 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001278 return reinterpret_cast<ArtMethod*>(static_cast<uintptr_t>(mid));
Elliott Hughes03181a82011-11-17 17:22:21 -08001279}
1280
Sebastien Hertz6995c602014-09-09 12:10:13 +02001281bool Dbg::MatchThread(JDWP::ObjectId expected_thread_id, Thread* event_thread) {
1282 CHECK(event_thread != nullptr);
1283 JDWP::JdwpError error;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001284 mirror::Object* expected_thread_peer = gRegistry->Get<mirror::Object*>(
1285 expected_thread_id, &error);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001286 return expected_thread_peer == event_thread->GetPeer();
1287}
1288
1289bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1290 const JDWP::EventLocation& event_location) {
1291 if (expected_location.dex_pc != event_location.dex_pc) {
1292 return false;
1293 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001294 ArtMethod* m = FromMethodId(expected_location.method_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001295 return m == event_location.method;
1296}
1297
1298bool Dbg::MatchType(mirror::Class* event_class, JDWP::RefTypeId class_id) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001299 if (event_class == nullptr) {
1300 return false;
1301 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02001302 JDWP::JdwpError error;
1303 mirror::Class* expected_class = DecodeClass(class_id, &error);
1304 CHECK(expected_class != nullptr);
1305 return expected_class->IsAssignableFrom(event_class);
1306}
1307
1308bool Dbg::MatchField(JDWP::RefTypeId expected_type_id, JDWP::FieldId expected_field_id,
Mathieu Chartierc7853442015-03-27 14:35:38 -07001309 ArtField* event_field) {
1310 ArtField* expected_field = FromFieldId(expected_field_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001311 if (expected_field != event_field) {
1312 return false;
1313 }
1314 return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1315}
1316
1317bool Dbg::MatchInstance(JDWP::ObjectId expected_instance_id, mirror::Object* event_instance) {
1318 JDWP::JdwpError error;
1319 mirror::Object* modifier_instance = gRegistry->Get<mirror::Object*>(expected_instance_id, &error);
1320 return modifier_instance == event_instance;
1321}
1322
Mathieu Chartier90443472015-07-16 20:32:27 -07001323void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, ArtMethod* m, uint32_t dex_pc) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001324 if (m == nullptr) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001325 memset(location, 0, sizeof(*location));
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001326 } else {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001327 mirror::Class* c = m->GetDeclaringClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07001328 location->type_tag = GetTypeTag(c);
1329 location->class_id = gRegistry->AddRefType(c);
1330 location->method_id = ToMethodId(m);
1331 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001332 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08001333}
1334
Ian Rogersc0542af2014-09-03 16:16:56 -07001335std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001336 ArtMethod* m = FromMethodId(method_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001337 if (m == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001338 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001339 }
Sebastien Hertz415fd082015-06-01 11:42:27 +02001340 return m->GetInterfaceMethodIfProxy(sizeof(void*))->GetName();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001341}
1342
Ian Rogersc0542af2014-09-03 16:16:56 -07001343std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001344 ArtField* f = FromFieldId(field_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001345 if (f == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001346 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001347 }
1348 return f->GetName();
Elliott Hughesa96836a2013-01-17 12:27:49 -08001349}
1350
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001351/*
1352 * Augment the access flags for synthetic methods and fields by setting
1353 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
1354 * flags not specified by the Java programming language.
1355 */
1356static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1357 accessFlags &= kAccJavaFlagsMask;
1358 if ((accessFlags & kAccSynthetic) != 0) {
1359 accessFlags |= 0xf0000000;
1360 }
1361 return accessFlags;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001362}
1363
Elliott Hughesdbb40792011-11-18 17:05:22 -08001364/*
Jeff Haob7cefc72013-11-14 14:51:09 -08001365 * Circularly shifts registers so that arguments come first. Debuggers
1366 * expect slots to begin with arguments, but dex code places them at
1367 * the end.
Elliott Hughesdbb40792011-11-18 17:05:22 -08001368 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001369static uint16_t MangleSlot(uint16_t slot, ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07001370 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001371 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001372 if (code_item == nullptr) {
1373 // We should not get here for a method without code (native, proxy or abstract). Log it and
1374 // return the slot as is since all registers are arguments.
1375 LOG(WARNING) << "Trying to mangle slot for method without code " << PrettyMethod(m);
1376 return slot;
1377 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001378 uint16_t ins_size = code_item->ins_size_;
1379 uint16_t locals_size = code_item->registers_size_ - ins_size;
1380 if (slot >= locals_size) {
1381 return slot - locals_size;
1382 } else {
1383 return slot + ins_size;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001384 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001385}
1386
Jeff Haob7cefc72013-11-14 14:51:09 -08001387/*
1388 * Circularly shifts registers so that arguments come last. Reverts
1389 * slots to dex style argument placement.
1390 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001391static uint16_t DemangleSlot(uint16_t slot, ArtMethod* m, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -07001392 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001393 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001394 if (code_item == nullptr) {
1395 // We should not get here for a method without code (native, proxy or abstract). Log it and
1396 // return the slot as is since all registers are arguments.
1397 LOG(WARNING) << "Trying to demangle slot for method without code " << PrettyMethod(m);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001398 uint16_t vreg_count = ArtMethod::NumArgRegisters(m->GetShorty());
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001399 if (slot < vreg_count) {
1400 *error = JDWP::ERR_NONE;
1401 return slot;
1402 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001403 } else {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001404 if (slot < code_item->registers_size_) {
1405 uint16_t ins_size = code_item->ins_size_;
1406 uint16_t locals_size = code_item->registers_size_ - ins_size;
1407 *error = JDWP::ERR_NONE;
1408 return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1409 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001410 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001411
1412 // Slot is invalid in the method.
1413 LOG(ERROR) << "Invalid local slot " << slot << " for method " << PrettyMethod(m);
1414 *error = JDWP::ERR_INVALID_SLOT;
1415 return DexFile::kDexNoIndex16;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001416}
1417
Mathieu Chartier90443472015-07-16 20:32:27 -07001418JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic,
1419 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001420 JDWP::JdwpError error;
1421 mirror::Class* c = DecodeClass(class_id, &error);
1422 if (c == nullptr) {
1423 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001424 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001425
1426 size_t instance_field_count = c->NumInstanceFields();
1427 size_t static_field_count = c->NumStaticFields();
1428
1429 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1430
1431 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
Mathieu Chartier90443472015-07-16 20:32:27 -07001432 ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) :
1433 c->GetStaticField(i - instance_field_count);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001434 expandBufAddFieldId(pReply, ToFieldId(f));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001435 expandBufAddUtf8String(pReply, f->GetName());
1436 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001437 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001438 static const char genericSignature[1] = "";
1439 expandBufAddUtf8String(pReply, genericSignature);
1440 }
1441 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1442 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001443 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001444}
1445
Elliott Hughes88d63092013-01-09 09:55:54 -08001446JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001447 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001448 JDWP::JdwpError error;
1449 mirror::Class* c = DecodeClass(class_id, &error);
1450 if (c == nullptr) {
1451 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001452 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001453
1454 size_t direct_method_count = c->NumDirectMethods();
1455 size_t virtual_method_count = c->NumVirtualMethods();
1456
1457 expandBufAdd4BE(pReply, direct_method_count + virtual_method_count);
1458
Mathieu Chartiere401d142015-04-22 13:56:20 -07001459 auto* cl = Runtime::Current()->GetClassLinker();
1460 auto ptr_size = cl->GetImagePointerSize();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001461 for (size_t i = 0; i < direct_method_count + virtual_method_count; ++i) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001462 ArtMethod* m = i < direct_method_count ?
1463 c->GetDirectMethod(i, ptr_size) : c->GetVirtualMethod(i - direct_method_count, ptr_size);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001464 expandBufAddMethodId(pReply, ToMethodId(m));
Sebastien Hertz415fd082015-06-01 11:42:27 +02001465 expandBufAddUtf8String(pReply, m->GetInterfaceMethodIfProxy(sizeof(void*))->GetName());
1466 expandBufAddUtf8String(pReply,
1467 m->GetInterfaceMethodIfProxy(sizeof(void*))->GetSignature().ToString());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001468 if (with_generic) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001469 const char* generic_signature = "";
1470 expandBufAddUtf8String(pReply, generic_signature);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001471 }
1472 expandBufAdd4BE(pReply, MangleAccessFlags(m->GetAccessFlags()));
1473 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001474 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001475}
1476
Elliott Hughes88d63092013-01-09 09:55:54 -08001477JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001478 JDWP::JdwpError error;
Mathieu Chartierf8322842014-05-16 10:59:25 -07001479 Thread* self = Thread::Current();
1480 StackHandleScope<1> hs(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07001481 Handle<mirror::Class> c(hs.NewHandle(DecodeClass(class_id, &error)));
Mathieu Chartierf8322842014-05-16 10:59:25 -07001482 if (c.Get() == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001483 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001484 }
Mathieu Chartierf8322842014-05-16 10:59:25 -07001485 size_t interface_count = c->NumDirectInterfaces();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001486 expandBufAdd4BE(pReply, interface_count);
1487 for (size_t i = 0; i < interface_count; ++i) {
Mathieu Chartierf8322842014-05-16 10:59:25 -07001488 expandBufAddRefTypeId(pReply,
1489 gRegistry->AddRefType(mirror::Class::GetDirectInterface(self, c, i)));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001490 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001491 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001492}
1493
Ian Rogersc0542af2014-09-03 16:16:56 -07001494void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001495 struct DebugCallbackContext {
1496 int numItems;
1497 JDWP::ExpandBuf* pReply;
1498
Elliott Hughes2435a572012-02-17 16:07:41 -08001499 static bool Callback(void* context, uint32_t address, uint32_t line_number) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001500 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1501 expandBufAdd8BE(pContext->pReply, address);
Elliott Hughes2435a572012-02-17 16:07:41 -08001502 expandBufAdd4BE(pContext->pReply, line_number);
Elliott Hughes03181a82011-11-17 17:22:21 -08001503 pContext->numItems++;
Sebastien Hertzf2910ee2013-10-19 16:39:24 +02001504 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08001505 }
1506 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001507 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001508 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes03181a82011-11-17 17:22:21 -08001509 uint64_t start, end;
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001510 if (code_item == nullptr) {
1511 DCHECK(m->IsNative() || m->IsProxyMethod());
Elliott Hughes03181a82011-11-17 17:22:21 -08001512 start = -1;
1513 end = -1;
1514 } else {
1515 start = 0;
jeffhao14f0db92012-12-14 17:50:42 -08001516 // Return the index of the last instruction
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001517 end = code_item->insns_size_in_code_units_ - 1;
Elliott Hughes03181a82011-11-17 17:22:21 -08001518 }
1519
1520 expandBufAdd8BE(pReply, start);
1521 expandBufAdd8BE(pReply, end);
1522
1523 // Add numLines later
1524 size_t numLinesOffset = expandBufGetLength(pReply);
1525 expandBufAdd4BE(pReply, 0);
1526
1527 DebugCallbackContext context;
1528 context.numItems = 0;
1529 context.pReply = pReply;
1530
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001531 if (code_item != nullptr) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001532 m->GetDexFile()->DecodeDebugInfo(code_item, m->IsStatic(), m->GetDexMethodIndex(),
Ian Rogersc0542af2014-09-03 16:16:56 -07001533 DebugCallbackContext::Callback, nullptr, &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001534 }
Elliott Hughes03181a82011-11-17 17:22:21 -08001535
1536 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001537}
1538
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001539void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1540 JDWP::ExpandBuf* pReply) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001541 struct DebugCallbackContext {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001542 ArtMethod* method;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001543 JDWP::ExpandBuf* pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001544 size_t variable_count;
1545 bool with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001546
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001547 static void Callback(void* context, uint16_t slot, uint32_t startAddress, uint32_t endAddress,
1548 const char* name, const char* descriptor, const char* signature)
Mathieu Chartier90443472015-07-16 20:32:27 -07001549 SHARED_REQUIRES(Locks::mutator_lock_) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001550 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1551
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001552 VLOG(jdwp) << StringPrintf(" %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
1553 pContext->variable_count, startAddress, endAddress - startAddress,
1554 name, descriptor, signature, slot,
1555 MangleSlot(slot, pContext->method));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001556
Jeff Haob7cefc72013-11-14 14:51:09 -08001557 slot = MangleSlot(slot, pContext->method);
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001558
Elliott Hughesdbb40792011-11-18 17:05:22 -08001559 expandBufAdd8BE(pContext->pReply, startAddress);
1560 expandBufAddUtf8String(pContext->pReply, name);
1561 expandBufAddUtf8String(pContext->pReply, descriptor);
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001562 if (pContext->with_generic) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001563 expandBufAddUtf8String(pContext->pReply, signature);
1564 }
1565 expandBufAdd4BE(pContext->pReply, endAddress - startAddress);
1566 expandBufAdd4BE(pContext->pReply, slot);
1567
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001568 ++pContext->variable_count;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001569 }
1570 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001571 ArtMethod* m = FromMethodId(method_id);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001572
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001573 // arg_count considers doubles and longs to take 2 units.
1574 // variable_count considers everything to take 1 unit.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001575 std::string shorty(m->GetShorty());
Mathieu Chartiere401d142015-04-22 13:56:20 -07001576 expandBufAdd4BE(pReply, ArtMethod::NumArgRegisters(shorty));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001577
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001578 // We don't know the total number of variables yet, so leave a blank and update it later.
1579 size_t variable_count_offset = expandBufGetLength(pReply);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001580 expandBufAdd4BE(pReply, 0);
1581
1582 DebugCallbackContext context;
Jeff Haob7cefc72013-11-14 14:51:09 -08001583 context.method = m;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001584 context.pReply = pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001585 context.variable_count = 0;
1586 context.with_generic = with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001587
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001588 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001589 if (code_item != nullptr) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001590 m->GetDexFile()->DecodeDebugInfo(
Ian Rogersc0542af2014-09-03 16:16:56 -07001591 code_item, m->IsStatic(), m->GetDexMethodIndex(), nullptr, DebugCallbackContext::Callback,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001592 &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001593 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001594
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001595 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001596}
1597
Jeff Hao579b0242013-11-18 13:16:49 -08001598void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1599 JDWP::ExpandBuf* pReply) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001600 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001601 JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
Jeff Hao579b0242013-11-18 13:16:49 -08001602 OutputJValue(tag, return_value, pReply);
1603}
1604
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001605void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1606 JDWP::ExpandBuf* pReply) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001607 ArtField* f = FromFieldId(field_id);
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001608 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001609 OutputJValue(tag, field_value, pReply);
1610}
1611
Elliott Hughes9777ba22013-01-17 09:04:19 -08001612JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
Ian Rogersc0542af2014-09-03 16:16:56 -07001613 std::vector<uint8_t>* bytecodes) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001614 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07001615 if (m == nullptr) {
Elliott Hughes9777ba22013-01-17 09:04:19 -08001616 return JDWP::ERR_INVALID_METHODID;
1617 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001618 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes9777ba22013-01-17 09:04:19 -08001619 size_t byte_count = code_item->insns_size_in_code_units_ * 2;
1620 const uint8_t* begin = reinterpret_cast<const uint8_t*>(code_item->insns_);
1621 const uint8_t* end = begin + byte_count;
1622 for (const uint8_t* p = begin; p != end; ++p) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001623 bytecodes->push_back(*p);
Elliott Hughes9777ba22013-01-17 09:04:19 -08001624 }
1625 return JDWP::ERR_NONE;
1626}
1627
Elliott Hughes88d63092013-01-09 09:55:54 -08001628JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001629 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001630}
1631
Elliott Hughes88d63092013-01-09 09:55:54 -08001632JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001633 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001634}
1635
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001636static JValue GetArtFieldValue(ArtField* f, mirror::Object* o)
Mathieu Chartier90443472015-07-16 20:32:27 -07001637 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001638 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1639 JValue field_value;
1640 switch (fieldType) {
1641 case Primitive::kPrimBoolean:
1642 field_value.SetZ(f->GetBoolean(o));
1643 return field_value;
1644
1645 case Primitive::kPrimByte:
1646 field_value.SetB(f->GetByte(o));
1647 return field_value;
1648
1649 case Primitive::kPrimChar:
1650 field_value.SetC(f->GetChar(o));
1651 return field_value;
1652
1653 case Primitive::kPrimShort:
1654 field_value.SetS(f->GetShort(o));
1655 return field_value;
1656
1657 case Primitive::kPrimInt:
1658 case Primitive::kPrimFloat:
1659 // Int and Float must be treated as 32-bit values in JDWP.
1660 field_value.SetI(f->GetInt(o));
1661 return field_value;
1662
1663 case Primitive::kPrimLong:
1664 case Primitive::kPrimDouble:
1665 // Long and Double must be treated as 64-bit values in JDWP.
1666 field_value.SetJ(f->GetLong(o));
1667 return field_value;
1668
1669 case Primitive::kPrimNot:
1670 field_value.SetL(f->GetObject(o));
1671 return field_value;
1672
1673 case Primitive::kPrimVoid:
1674 LOG(FATAL) << "Attempt to read from field of type 'void'";
1675 UNREACHABLE();
1676 }
1677 LOG(FATAL) << "Attempt to read from field of unknown type";
1678 UNREACHABLE();
1679}
1680
Elliott Hughes88d63092013-01-09 09:55:54 -08001681static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1682 JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001683 bool is_static)
Mathieu Chartier90443472015-07-16 20:32:27 -07001684 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001685 JDWP::JdwpError error;
1686 mirror::Class* c = DecodeClass(ref_type_id, &error);
1687 if (ref_type_id != 0 && c == nullptr) {
1688 return error;
Elliott Hughes0cf74332012-02-23 23:14:00 -08001689 }
1690
Sebastien Hertz6995c602014-09-09 12:10:13 +02001691 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001692 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001693 return JDWP::ERR_INVALID_OBJECT;
1694 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001695 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001696
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001697 mirror::Class* receiver_class = c;
Ian Rogersc0542af2014-09-03 16:16:56 -07001698 if (receiver_class == nullptr && o != nullptr) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001699 receiver_class = o->GetClass();
1700 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001701 // TODO: should we give up now if receiver_class is null?
Ian Rogersc0542af2014-09-03 16:16:56 -07001702 if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001703 LOG(INFO) << "ERR_INVALID_FIELDID: " << PrettyField(f) << " " << PrettyClass(receiver_class);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001704 return JDWP::ERR_INVALID_FIELDID;
1705 }
Elliott Hughesaed4be92011-12-02 16:16:23 -08001706
Elliott Hughes0cf74332012-02-23 23:14:00 -08001707 // The RI only enforces the static/non-static mismatch in one direction.
1708 // TODO: should we change the tests and check both?
1709 if (is_static) {
1710 if (!f->IsStatic()) {
1711 return JDWP::ERR_INVALID_FIELDID;
1712 }
1713 } else {
1714 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001715 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.GetValues"
1716 << " on static field " << PrettyField(f);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001717 }
1718 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001719 if (f->IsStatic()) {
1720 o = f->GetDeclaringClass();
1721 }
Elliott Hughes0cf74332012-02-23 23:14:00 -08001722
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001723 JValue field_value(GetArtFieldValue(f, o));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001724 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Jeff Hao579b0242013-11-18 13:16:49 -08001725 Dbg::OutputJValue(tag, &field_value, pReply);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001726 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001727}
1728
Elliott Hughes88d63092013-01-09 09:55:54 -08001729JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001730 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001731 return GetFieldValueImpl(0, object_id, field_id, pReply, false);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001732}
1733
Ian Rogersc0542af2014-09-03 16:16:56 -07001734JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1735 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001736 return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001737}
1738
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001739static JDWP::JdwpError SetArtFieldValue(ArtField* f, mirror::Object* o, uint64_t value, int width)
Mathieu Chartier90443472015-07-16 20:32:27 -07001740 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001741 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1742 // Debugging only happens at runtime so we know we are not running in a transaction.
1743 static constexpr bool kNoTransactionMode = false;
1744 switch (fieldType) {
1745 case Primitive::kPrimBoolean:
1746 CHECK_EQ(width, 1);
1747 f->SetBoolean<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1748 return JDWP::ERR_NONE;
1749
1750 case Primitive::kPrimByte:
1751 CHECK_EQ(width, 1);
1752 f->SetByte<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1753 return JDWP::ERR_NONE;
1754
1755 case Primitive::kPrimChar:
1756 CHECK_EQ(width, 2);
1757 f->SetChar<kNoTransactionMode>(o, static_cast<uint16_t>(value));
1758 return JDWP::ERR_NONE;
1759
1760 case Primitive::kPrimShort:
1761 CHECK_EQ(width, 2);
1762 f->SetShort<kNoTransactionMode>(o, static_cast<int16_t>(value));
1763 return JDWP::ERR_NONE;
1764
1765 case Primitive::kPrimInt:
1766 case Primitive::kPrimFloat:
1767 CHECK_EQ(width, 4);
1768 // Int and Float must be treated as 32-bit values in JDWP.
1769 f->SetInt<kNoTransactionMode>(o, static_cast<int32_t>(value));
1770 return JDWP::ERR_NONE;
1771
1772 case Primitive::kPrimLong:
1773 case Primitive::kPrimDouble:
1774 CHECK_EQ(width, 8);
1775 // Long and Double must be treated as 64-bit values in JDWP.
1776 f->SetLong<kNoTransactionMode>(o, value);
1777 return JDWP::ERR_NONE;
1778
1779 case Primitive::kPrimNot: {
1780 JDWP::JdwpError error;
1781 mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1782 if (error != JDWP::ERR_NONE) {
1783 return JDWP::ERR_INVALID_OBJECT;
1784 }
1785 if (v != nullptr) {
1786 mirror::Class* field_type;
1787 {
1788 StackHandleScope<2> hs(Thread::Current());
1789 HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1790 HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
1791 field_type = f->GetType<true>();
1792 }
1793 if (!field_type->IsAssignableFrom(v->GetClass())) {
1794 return JDWP::ERR_INVALID_OBJECT;
1795 }
1796 }
1797 f->SetObject<kNoTransactionMode>(o, v);
1798 return JDWP::ERR_NONE;
1799 }
1800
1801 case Primitive::kPrimVoid:
1802 LOG(FATAL) << "Attempt to write to field of type 'void'";
1803 UNREACHABLE();
1804 }
1805 LOG(FATAL) << "Attempt to write to field of unknown type";
1806 UNREACHABLE();
1807}
1808
Elliott Hughes88d63092013-01-09 09:55:54 -08001809static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001810 uint64_t value, int width, bool is_static)
Mathieu Chartier90443472015-07-16 20:32:27 -07001811 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001812 JDWP::JdwpError error;
Sebastien Hertz6995c602014-09-09 12:10:13 +02001813 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001814 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001815 return JDWP::ERR_INVALID_OBJECT;
1816 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001817 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001818
1819 // The RI only enforces the static/non-static mismatch in one direction.
1820 // TODO: should we change the tests and check both?
1821 if (is_static) {
1822 if (!f->IsStatic()) {
1823 return JDWP::ERR_INVALID_FIELDID;
1824 }
1825 } else {
1826 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001827 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues"
1828 << " on static field " << PrettyField(f);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001829 }
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001830 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001831 if (f->IsStatic()) {
1832 o = f->GetDeclaringClass();
1833 }
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001834 return SetArtFieldValue(f, o, value, width);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001835}
1836
Elliott Hughes88d63092013-01-09 09:55:54 -08001837JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001838 int width) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001839 return SetFieldValueImpl(object_id, field_id, value, width, false);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001840}
1841
Elliott Hughes88d63092013-01-09 09:55:54 -08001842JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
1843 return SetFieldValueImpl(0, field_id, value, width, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001844}
1845
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001846JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001847 JDWP::JdwpError error;
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001848 mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
1849 if (error != JDWP::ERR_NONE) {
1850 return error;
1851 }
1852 if (obj == nullptr) {
1853 return JDWP::ERR_INVALID_OBJECT;
1854 }
1855 {
1856 ScopedObjectAccessUnchecked soa(Thread::Current());
1857 mirror::Class* java_lang_String = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_String);
1858 if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
1859 // This isn't a string.
1860 return JDWP::ERR_INVALID_STRING;
1861 }
1862 }
1863 *str = obj->AsString()->ToModifiedUtf8();
1864 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001865}
1866
Jeff Hao579b0242013-11-18 13:16:49 -08001867void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
1868 if (IsPrimitiveTag(tag)) {
1869 expandBufAdd1(pReply, tag);
1870 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
1871 expandBufAdd1(pReply, return_value->GetI());
1872 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
1873 expandBufAdd2BE(pReply, return_value->GetI());
1874 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
1875 expandBufAdd4BE(pReply, return_value->GetI());
1876 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1877 expandBufAdd8BE(pReply, return_value->GetJ());
1878 } else {
1879 CHECK_EQ(tag, JDWP::JT_VOID);
1880 }
1881 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001882 ScopedObjectAccessUnchecked soa(Thread::Current());
Jeff Hao579b0242013-11-18 13:16:49 -08001883 mirror::Object* value = return_value->GetL();
Ian Rogers98379392014-02-24 16:53:16 -08001884 expandBufAdd1(pReply, TagFromObject(soa, value));
Jeff Hao579b0242013-11-18 13:16:49 -08001885 expandBufAddObjectId(pReply, gRegistry->Add(value));
1886 }
1887}
1888
Ian Rogersc0542af2014-09-03 16:16:56 -07001889JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001890 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001891 JDWP::JdwpError error;
1892 Thread* thread = DecodeThread(soa, thread_id, &error);
1893 UNUSED(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08001894 if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
1895 return error;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001896 }
Elliott Hughes221229c2013-01-08 18:17:50 -08001897
1898 // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
Ian Rogersc0542af2014-09-03 16:16:56 -07001899 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1900 CHECK(thread_object != nullptr) << error;
Mathieu Chartierc7853442015-03-27 14:35:38 -07001901 ArtField* java_lang_Thread_name_field =
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001902 soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
1903 mirror::String* s =
1904 reinterpret_cast<mirror::String*>(java_lang_Thread_name_field->GetObject(thread_object));
Ian Rogersc0542af2014-09-03 16:16:56 -07001905 if (s != nullptr) {
1906 *name = s->ToModifiedUtf8();
Elliott Hughes221229c2013-01-08 18:17:50 -08001907 }
1908 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001909}
1910
Elliott Hughes221229c2013-01-08 18:17:50 -08001911JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02001912 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001913 JDWP::JdwpError error;
1914 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1915 if (error != JDWP::ERR_NONE) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001916 return JDWP::ERR_INVALID_OBJECT;
1917 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001918 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroup");
Elliott Hughes2435a572012-02-17 16:07:41 -08001919 // Okay, so it's an object, but is it actually a thread?
Sebastien Hertz69206392015-04-07 15:54:25 +02001920 Thread* thread = DecodeThread(soa, thread_id, &error);
1921 UNUSED(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08001922 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
1923 // Zombie threads are in the null group.
1924 expandBufAddObjectId(pReply, JDWP::ObjectId(0));
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001925 error = JDWP::ERR_NONE;
1926 } else if (error == JDWP::ERR_NONE) {
1927 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
1928 CHECK(c != nullptr);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001929 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07001930 CHECK(f != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001931 mirror::Object* group = f->GetObject(thread_object);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07001932 CHECK(group != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001933 JDWP::ObjectId thread_group_id = gRegistry->Add(group);
1934 expandBufAddObjectId(pReply, thread_group_id);
Elliott Hughes221229c2013-01-08 18:17:50 -08001935 }
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001936 return error;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001937}
1938
Sebastien Hertza06430c2014-09-15 19:21:30 +02001939static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
1940 JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
Mathieu Chartier90443472015-07-16 20:32:27 -07001941 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02001942 mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
1943 error);
Sebastien Hertza06430c2014-09-15 19:21:30 +02001944 if (*error != JDWP::ERR_NONE) {
1945 return nullptr;
1946 }
1947 if (thread_group == nullptr) {
1948 *error = JDWP::ERR_INVALID_OBJECT;
1949 return nullptr;
1950 }
Ian Rogers98379392014-02-24 16:53:16 -08001951 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
1952 CHECK(c != nullptr);
Sebastien Hertza06430c2014-09-15 19:21:30 +02001953 if (!c->IsAssignableFrom(thread_group->GetClass())) {
1954 // This is not a java.lang.ThreadGroup.
1955 *error = JDWP::ERR_INVALID_THREAD_GROUP;
1956 return nullptr;
1957 }
1958 *error = JDWP::ERR_NONE;
1959 return thread_group;
1960}
1961
1962JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
1963 ScopedObjectAccessUnchecked soa(Thread::Current());
1964 JDWP::JdwpError error;
1965 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
1966 if (error != JDWP::ERR_NONE) {
1967 return error;
1968 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001969 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupName");
Mathieu Chartierc7853442015-03-27 14:35:38 -07001970 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_name);
Ian Rogersc0542af2014-09-03 16:16:56 -07001971 CHECK(f != nullptr);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001972 mirror::String* s = reinterpret_cast<mirror::String*>(f->GetObject(thread_group));
Sebastien Hertza06430c2014-09-15 19:21:30 +02001973
1974 std::string thread_group_name(s->ToModifiedUtf8());
1975 expandBufAddUtf8String(pReply, thread_group_name);
1976 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001977}
1978
Sebastien Hertza06430c2014-09-15 19:21:30 +02001979JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
Ian Rogers98379392014-02-24 16:53:16 -08001980 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001981 JDWP::JdwpError error;
Sebastien Hertza06430c2014-09-15 19:21:30 +02001982 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
1983 if (error != JDWP::ERR_NONE) {
1984 return error;
1985 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001986 mirror::Object* parent;
1987 {
1988 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupParent");
Mathieu Chartierc7853442015-03-27 14:35:38 -07001989 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_parent);
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001990 CHECK(f != nullptr);
1991 parent = f->GetObject(thread_group);
1992 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02001993 JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
1994 expandBufAddObjectId(pReply, parent_group_id);
1995 return JDWP::ERR_NONE;
1996}
1997
1998static void GetChildThreadGroups(ScopedObjectAccessUnchecked& soa, mirror::Object* thread_group,
1999 std::vector<JDWP::ObjectId>* child_thread_group_ids)
Mathieu Chartier90443472015-07-16 20:32:27 -07002000 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02002001 CHECK(thread_group != nullptr);
2002
2003 // Get the ArrayList<ThreadGroup> "groups" out of this thread group...
Mathieu Chartierc7853442015-03-27 14:35:38 -07002004 ArtField* groups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_groups);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002005 mirror::Object* groups_array_list = groups_field->GetObject(thread_group);
Sebastien Hertze49e1952014-10-13 11:27:13 +02002006 {
2007 // The "groups" field is declared as a java.util.List: check it really is
2008 // an instance of java.util.ArrayList.
2009 CHECK(groups_array_list != nullptr);
2010 mirror::Class* java_util_ArrayList_class =
2011 soa.Decode<mirror::Class*>(WellKnownClasses::java_util_ArrayList);
2012 CHECK(groups_array_list->InstanceOf(java_util_ArrayList_class));
2013 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002014
2015 // Get the array and size out of the ArrayList<ThreadGroup>...
Mathieu Chartierc7853442015-03-27 14:35:38 -07002016 ArtField* array_field = soa.DecodeField(WellKnownClasses::java_util_ArrayList_array);
2017 ArtField* size_field = soa.DecodeField(WellKnownClasses::java_util_ArrayList_size);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002018 mirror::ObjectArray<mirror::Object>* groups_array =
2019 array_field->GetObject(groups_array_list)->AsObjectArray<mirror::Object>();
2020 const int32_t size = size_field->GetInt(groups_array_list);
2021
2022 // Copy the first 'size' elements out of the array into the result.
Sebastien Hertz6995c602014-09-09 12:10:13 +02002023 ObjectRegistry* registry = Dbg::GetObjectRegistry();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002024 for (int32_t i = 0; i < size; ++i) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002025 child_thread_group_ids->push_back(registry->Add(groups_array->Get(i)));
Sebastien Hertza06430c2014-09-15 19:21:30 +02002026 }
2027}
2028
2029JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2030 JDWP::ExpandBuf* pReply) {
2031 ScopedObjectAccessUnchecked soa(Thread::Current());
2032 JDWP::JdwpError error;
2033 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2034 if (error != JDWP::ERR_NONE) {
2035 return error;
2036 }
2037
2038 // Add child threads.
2039 {
2040 std::vector<JDWP::ObjectId> child_thread_ids;
2041 GetThreads(thread_group, &child_thread_ids);
2042 expandBufAdd4BE(pReply, child_thread_ids.size());
2043 for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2044 expandBufAddObjectId(pReply, child_thread_id);
2045 }
2046 }
2047
2048 // Add child thread groups.
2049 {
2050 std::vector<JDWP::ObjectId> child_thread_groups_ids;
2051 GetChildThreadGroups(soa, thread_group, &child_thread_groups_ids);
2052 expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2053 for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2054 expandBufAddObjectId(pReply, child_thread_group_id);
2055 }
2056 }
2057
2058 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002059}
2060
2061JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002062 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartierc7853442015-03-27 14:35:38 -07002063 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002064 mirror::Object* group = f->GetObject(f->GetDeclaringClass());
Ian Rogers365c1022012-06-22 15:05:28 -07002065 return gRegistry->Add(group);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002066}
2067
Jeff Hao920af3e2013-08-28 15:46:38 -07002068JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2069 switch (state) {
2070 case kBlocked:
2071 return JDWP::TS_MONITOR;
2072 case kNative:
2073 case kRunnable:
2074 case kSuspended:
2075 return JDWP::TS_RUNNING;
2076 case kSleeping:
2077 return JDWP::TS_SLEEPING;
2078 case kStarting:
2079 case kTerminated:
2080 return JDWP::TS_ZOMBIE;
2081 case kTimedWaiting:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002082 case kWaitingForCheckPointsToRun:
Jeff Hao920af3e2013-08-28 15:46:38 -07002083 case kWaitingForDebuggerSend:
2084 case kWaitingForDebuggerSuspension:
2085 case kWaitingForDebuggerToAttach:
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01002086 case kWaitingForDeoptimization:
Jeff Hao920af3e2013-08-28 15:46:38 -07002087 case kWaitingForGcToComplete:
Mathieu Chartierb43390c2015-05-12 10:47:11 -07002088 case kWaitingForGetObjectsAllocated:
Jeff Hao920af3e2013-08-28 15:46:38 -07002089 case kWaitingForJniOnLoad:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002090 case kWaitingForMethodTracingStart:
Jeff Hao920af3e2013-08-28 15:46:38 -07002091 case kWaitingForSignalCatcherOutput:
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08002092 case kWaitingForVisitObjects:
Jeff Hao920af3e2013-08-28 15:46:38 -07002093 case kWaitingInMainDebuggerLoop:
2094 case kWaitingInMainSignalCatcherLoop:
2095 case kWaitingPerformingGc:
Mathieu Chartier90ef3db2015-08-04 15:19:41 -07002096 case kWaitingWeakGcRootRead:
Jeff Hao920af3e2013-08-28 15:46:38 -07002097 case kWaiting:
2098 return JDWP::TS_WAIT;
2099 // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2100 }
2101 LOG(FATAL) << "Unknown thread state: " << state;
2102 return JDWP::TS_ZOMBIE;
2103}
2104
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002105JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2106 JDWP::JdwpSuspendStatus* pSuspendStatus) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002107 ScopedObjectAccess soa(Thread::Current());
Elliott Hughes499c5132011-11-17 14:55:11 -08002108
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002109 *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2110
Ian Rogersc0542af2014-09-03 16:16:56 -07002111 JDWP::JdwpError error;
2112 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002113 if (error != JDWP::ERR_NONE) {
2114 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2115 *pThreadStatus = JDWP::TS_ZOMBIE;
Elliott Hughes221229c2013-01-08 18:17:50 -08002116 return JDWP::ERR_NONE;
2117 }
2118 return error;
Elliott Hughes499c5132011-11-17 14:55:11 -08002119 }
2120
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002121 if (IsSuspendedForDebugger(soa, thread)) {
2122 *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
Elliott Hughes499c5132011-11-17 14:55:11 -08002123 }
2124
Jeff Hao920af3e2013-08-28 15:46:38 -07002125 *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
Elliott Hughes221229c2013-01-08 18:17:50 -08002126 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002127}
2128
Elliott Hughes221229c2013-01-08 18:17:50 -08002129JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002130 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002131 JDWP::JdwpError error;
2132 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002133 if (error != JDWP::ERR_NONE) {
2134 return error;
Elliott Hughes2435a572012-02-17 16:07:41 -08002135 }
Ian Rogers50b35e22012-10-04 10:09:15 -07002136 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002137 expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
Elliott Hughes2435a572012-02-17 16:07:41 -08002138 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002139}
2140
Elliott Hughesf9501702013-01-11 11:22:27 -08002141JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2142 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002143 JDWP::JdwpError error;
2144 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughesf9501702013-01-11 11:22:27 -08002145 if (error != JDWP::ERR_NONE) {
2146 return error;
2147 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002148 thread->Interrupt(soa.Self());
Elliott Hughesf9501702013-01-11 11:22:27 -08002149 return JDWP::ERR_NONE;
2150}
2151
Sebastien Hertz070f7322014-09-09 12:08:49 +02002152static bool IsInDesiredThreadGroup(ScopedObjectAccessUnchecked& soa,
2153 mirror::Object* desired_thread_group, mirror::Object* peer)
Mathieu Chartier90443472015-07-16 20:32:27 -07002154 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz070f7322014-09-09 12:08:49 +02002155 // Do we want threads from all thread groups?
2156 if (desired_thread_group == nullptr) {
2157 return true;
2158 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07002159 ArtField* thread_group_field = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002160 DCHECK(thread_group_field != nullptr);
2161 mirror::Object* group = thread_group_field->GetObject(peer);
2162 return (group == desired_thread_group);
2163}
2164
Sebastien Hertza06430c2014-09-15 19:21:30 +02002165void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002166 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz070f7322014-09-09 12:08:49 +02002167 std::list<Thread*> all_threads_list;
2168 {
2169 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2170 all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2171 }
2172 for (Thread* t : all_threads_list) {
2173 if (t == Dbg::GetDebugThread()) {
2174 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2175 // query all threads, so it's easier if we just don't tell them about this thread.
2176 continue;
2177 }
2178 if (t->IsStillStarting()) {
2179 // This thread is being started (and has been registered in the thread list). However, it is
2180 // not completely started yet so we must ignore it.
2181 continue;
2182 }
2183 mirror::Object* peer = t->GetPeer();
2184 if (peer == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002185 // 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 +02002186 // this thread yet.
2187 // TODO: if we identified threads to the debugger by their Thread*
2188 // rather than their peer's mirror::Object*, we could fix this.
2189 // Doing so might help us report ZOMBIE threads too.
2190 continue;
2191 }
2192 if (IsInDesiredThreadGroup(soa, thread_group, peer)) {
2193 thread_ids->push_back(gRegistry->Add(peer));
2194 }
2195 }
Elliott Hughescaf76542012-06-28 16:08:22 -07002196}
Elliott Hughesa2155262011-11-16 16:26:58 -08002197
Mathieu Chartier90443472015-07-16 20:32:27 -07002198static int GetStackDepth(Thread* thread) SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002199 struct CountStackDepthVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002200 explicit CountStackDepthVisitor(Thread* thread_in)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002201 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2202 depth(0) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002203
Elliott Hughes64f574f2013-02-20 14:57:12 -08002204 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2205 // annotalysis.
2206 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers0399dde2012-06-06 17:09:28 -07002207 if (!GetMethod()->IsRuntimeMethod()) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08002208 ++depth;
2209 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002210 return true;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002211 }
2212 size_t depth;
2213 };
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002214
Ian Rogers7a22fa62013-01-23 12:16:16 -08002215 CountStackDepthVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07002216 visitor.WalkStack();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002217 return visitor.depth;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002218}
2219
Ian Rogersc0542af2014-09-03 16:16:56 -07002220JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002221 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002222 JDWP::JdwpError error;
2223 *result = 0;
2224 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002225 if (error != JDWP::ERR_NONE) {
2226 return error;
2227 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002228 if (!IsSuspendedForDebugger(soa, thread)) {
2229 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2230 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002231 *result = GetStackDepth(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08002232 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -08002233}
2234
Ian Rogers306057f2012-11-26 12:45:53 -08002235JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2236 size_t frame_count, JDWP::ExpandBuf* buf) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002237 class GetFrameVisitor : public StackVisitor {
2238 public:
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002239 GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2240 JDWP::ExpandBuf* buf_in)
Mathieu Chartier90443472015-07-16 20:32:27 -07002241 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002242 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2243 depth_(0),
2244 start_frame_(start_frame_in),
2245 frame_count_(frame_count_in),
2246 buf_(buf_in) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002247 expandBufAdd4BE(buf_, frame_count_);
Elliott Hughes03181a82011-11-17 17:22:21 -08002248 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002249
Mathieu Chartier90443472015-07-16 20:32:27 -07002250 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002251 if (GetMethod()->IsRuntimeMethod()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002252 return true; // The debugger can't do anything useful with a frame that has no Method*.
Elliott Hughes03181a82011-11-17 17:22:21 -08002253 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002254 if (depth_ >= start_frame_ + frame_count_) {
Elliott Hughes530fa002012-03-12 11:44:49 -07002255 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08002256 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002257 if (depth_ >= start_frame_) {
2258 JDWP::FrameId frame_id(GetFrameId());
2259 JDWP::JdwpLocation location;
Sebastien Hertz6995c602014-09-09 12:10:13 +02002260 SetJdwpLocation(&location, GetMethod(), GetDexPc());
Ian Rogersef7d42f2014-01-06 12:55:46 -08002261 VLOG(jdwp) << StringPrintf(" Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002262 expandBufAdd8BE(buf_, frame_id);
2263 expandBufAddLocation(buf_, location);
2264 }
2265 ++depth_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002266 return true;
Elliott Hughes03181a82011-11-17 17:22:21 -08002267 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002268
2269 private:
2270 size_t depth_;
2271 const size_t start_frame_;
2272 const size_t frame_count_;
2273 JDWP::ExpandBuf* buf_;
Elliott Hughes03181a82011-11-17 17:22:21 -08002274 };
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002275
2276 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002277 JDWP::JdwpError error;
2278 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002279 if (error != JDWP::ERR_NONE) {
2280 return error;
2281 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002282 if (!IsSuspendedForDebugger(soa, thread)) {
2283 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2284 }
Ian Rogers7a22fa62013-01-23 12:16:16 -08002285 GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
Ian Rogers0399dde2012-06-06 17:09:28 -07002286 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002287 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002288}
2289
2290JDWP::ObjectId Dbg::GetThreadSelfId() {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002291 return GetThreadId(Thread::Current());
2292}
2293
2294JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002295 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz6995c602014-09-09 12:10:13 +02002296 return gRegistry->Add(thread->GetPeer());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002297}
2298
Elliott Hughes475fc232011-10-25 15:00:35 -07002299void Dbg::SuspendVM() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002300 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002301}
2302
2303void Dbg::ResumeVM() {
Sebastien Hertz253fa552014-10-14 17:27:15 +02002304 Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002305}
2306
Elliott Hughes221229c2013-01-08 18:17:50 -08002307JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002308 Thread* self = Thread::Current();
Ian Rogersc0542af2014-09-03 16:16:56 -07002309 ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002310 {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002311 ScopedObjectAccess soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07002312 JDWP::JdwpError error;
2313 peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
Elliott Hughes4e235312011-12-02 11:34:15 -08002314 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002315 if (peer.get() == nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002316 return JDWP::ERR_THREAD_NOT_ALIVE;
2317 }
Ian Rogers4ad5cd32014-11-11 23:08:07 -08002318 // Suspend thread to build stack trace.
Elliott Hughesf327e072013-01-09 16:01:26 -08002319 bool timed_out;
Brian Carlstromba32de42014-08-27 23:43:46 -07002320 ThreadList* thread_list = Runtime::Current()->GetThreadList();
2321 Thread* thread = thread_list->SuspendThreadByPeer(peer.get(), request_suspension, true,
2322 &timed_out);
Ian Rogersc0542af2014-09-03 16:16:56 -07002323 if (thread != nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002324 return JDWP::ERR_NONE;
Elliott Hughesf327e072013-01-09 16:01:26 -08002325 } else if (timed_out) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002326 return JDWP::ERR_INTERNAL;
2327 } else {
2328 return JDWP::ERR_THREAD_NOT_ALIVE;
2329 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002330}
2331
Elliott Hughes221229c2013-01-08 18:17:50 -08002332void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002333 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002334 JDWP::JdwpError error;
2335 mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2336 CHECK(peer != nullptr) << error;
jeffhaoa77f0f62012-12-05 17:19:31 -08002337 Thread* thread;
2338 {
2339 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2340 thread = Thread::FromManagedThread(soa, peer);
2341 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002342 if (thread == nullptr) {
Elliott Hughes4e235312011-12-02 11:34:15 -08002343 LOG(WARNING) << "No such thread for resume: " << peer;
2344 return;
2345 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002346 bool needs_resume;
2347 {
Ian Rogers50b35e22012-10-04 10:09:15 -07002348 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002349 needs_resume = thread->GetSuspendCount() > 0;
2350 }
2351 if (needs_resume) {
Elliott Hughes546b9862012-06-20 16:06:13 -07002352 Runtime::Current()->GetThreadList()->Resume(thread, true);
2353 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002354}
2355
2356void Dbg::SuspendSelf() {
Elliott Hughes475fc232011-10-25 15:00:35 -07002357 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002358}
2359
Ian Rogers0399dde2012-06-06 17:09:28 -07002360struct GetThisVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002361 GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
Mathieu Chartier90443472015-07-16 20:32:27 -07002362 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002363 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2364 this_object(nullptr),
2365 frame_id(frame_id_in) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002366
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002367 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2368 // annotalysis.
2369 virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002370 if (frame_id != GetFrameId()) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002371 return true; // continue
Ian Rogers0399dde2012-06-06 17:09:28 -07002372 } else {
Ian Rogers62d6c772013-02-27 08:32:07 -08002373 this_object = GetThisObject();
2374 return false;
Ian Rogers0399dde2012-06-06 17:09:28 -07002375 }
Elliott Hughes86b00102011-12-05 17:54:26 -08002376 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002377
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002378 mirror::Object* this_object;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002379 JDWP::FrameId frame_id;
Ian Rogers0399dde2012-06-06 17:09:28 -07002380};
2381
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002382JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2383 JDWP::ObjectId* result) {
2384 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002385 JDWP::JdwpError error;
2386 Thread* thread = DecodeThread(soa, thread_id, &error);
2387 if (error != JDWP::ERR_NONE) {
2388 return error;
2389 }
2390 if (!IsSuspendedForDebugger(soa, thread)) {
2391 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002392 }
Ian Rogers700a4022014-05-19 16:49:03 -07002393 std::unique_ptr<Context> context(Context::Create());
Ian Rogers7a22fa62013-01-23 12:16:16 -08002394 GetThisVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002395 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002396 *result = gRegistry->Add(visitor.this_object);
2397 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002398}
2399
Sebastien Hertz8009f392014-09-01 17:07:11 +02002400// Walks the stack until we find the frame with the given FrameId.
2401class FindFrameVisitor FINAL : public StackVisitor {
2402 public:
2403 FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
Mathieu Chartier90443472015-07-16 20:32:27 -07002404 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002405 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2406 frame_id_(frame_id),
2407 error_(JDWP::ERR_INVALID_FRAMEID) {}
Ian Rogersca190662012-06-26 15:45:57 -07002408
Sebastien Hertz8009f392014-09-01 17:07:11 +02002409 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2410 // annotalysis.
2411 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2412 if (GetFrameId() != frame_id_) {
2413 return true; // Not our frame, carry on.
Ian Rogers0399dde2012-06-06 17:09:28 -07002414 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002415 ArtMethod* m = GetMethod();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002416 if (m->IsNative()) {
2417 // We can't read/write local value from/into native method.
2418 error_ = JDWP::ERR_OPAQUE_FRAME;
2419 } else {
2420 // We found our frame.
2421 error_ = JDWP::ERR_NONE;
2422 }
2423 return false;
2424 }
2425
2426 JDWP::JdwpError GetError() const {
2427 return error_;
2428 }
2429
2430 private:
2431 const JDWP::FrameId frame_id_;
2432 JDWP::JdwpError error_;
2433};
2434
2435JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2436 JDWP::ObjectId thread_id = request->ReadThreadId();
2437 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002438
2439 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002440 JDWP::JdwpError error;
2441 Thread* thread = DecodeThread(soa, thread_id, &error);
2442 if (error != JDWP::ERR_NONE) {
2443 return error;
2444 }
2445 if (!IsSuspendedForDebugger(soa, thread)) {
2446 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002447 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002448 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002449 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002450 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002451 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002452 if (visitor.GetError() != JDWP::ERR_NONE) {
2453 return visitor.GetError();
2454 }
2455
2456 // Read the values from visitor's context.
2457 int32_t slot_count = request->ReadSigned32("slot count");
2458 expandBufAdd4BE(pReply, slot_count); /* "int values" */
2459 for (int32_t i = 0; i < slot_count; ++i) {
2460 uint32_t slot = request->ReadUnsigned32("slot");
2461 JDWP::JdwpTag reqSigByte = request->ReadTag();
2462
2463 VLOG(jdwp) << " --> slot " << slot << " " << reqSigByte;
2464
2465 size_t width = Dbg::GetTagWidth(reqSigByte);
Sebastien Hertz7d955652014-10-22 10:57:10 +02002466 uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
Sebastien Hertz69206392015-04-07 15:54:25 +02002467 error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002468 if (error != JDWP::ERR_NONE) {
2469 return error;
2470 }
2471 }
2472 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002473}
2474
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002475constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2476
2477static std::string GetStackContextAsString(const StackVisitor& visitor)
Mathieu Chartier90443472015-07-16 20:32:27 -07002478 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002479 return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
2480 PrettyMethod(visitor.GetMethod()).c_str());
2481}
2482
2483static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2484 JDWP::JdwpTag tag)
Mathieu Chartier90443472015-07-16 20:32:27 -07002485 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002486 LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2487 << GetStackContextAsString(visitor);
2488 return kStackFrameLocalAccessError;
2489}
2490
Sebastien Hertz8009f392014-09-01 17:07:11 +02002491JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2492 int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002493 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002494 JDWP::JdwpError error = JDWP::ERR_NONE;
2495 uint16_t vreg = DemangleSlot(slot, m, &error);
2496 if (error != JDWP::ERR_NONE) {
2497 return error;
2498 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002499 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002500 switch (tag) {
2501 case JDWP::JT_BOOLEAN: {
2502 CHECK_EQ(width, 1U);
2503 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002504 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2505 return FailGetLocalValue(visitor, vreg, tag);
Ian Rogers0399dde2012-06-06 17:09:28 -07002506 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002507 VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2508 JDWP::Set1(buf + 1, intVal != 0);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002509 break;
Ian Rogers0399dde2012-06-06 17:09:28 -07002510 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002511 case JDWP::JT_BYTE: {
2512 CHECK_EQ(width, 1U);
2513 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002514 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2515 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002516 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002517 VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2518 JDWP::Set1(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002519 break;
2520 }
2521 case JDWP::JT_SHORT:
2522 case JDWP::JT_CHAR: {
2523 CHECK_EQ(width, 2U);
2524 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002525 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2526 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002527 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002528 VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2529 JDWP::Set2BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002530 break;
2531 }
2532 case JDWP::JT_INT: {
2533 CHECK_EQ(width, 4U);
2534 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002535 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2536 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002537 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002538 VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2539 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002540 break;
2541 }
2542 case JDWP::JT_FLOAT: {
2543 CHECK_EQ(width, 4U);
2544 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002545 if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2546 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002547 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002548 VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2549 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002550 break;
2551 }
2552 case JDWP::JT_ARRAY:
2553 case JDWP::JT_CLASS_LOADER:
2554 case JDWP::JT_CLASS_OBJECT:
2555 case JDWP::JT_OBJECT:
2556 case JDWP::JT_STRING:
2557 case JDWP::JT_THREAD:
2558 case JDWP::JT_THREAD_GROUP: {
2559 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2560 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002561 if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2562 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002563 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002564 mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2565 VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2566 if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2567 LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2568 reinterpret_cast<uintptr_t>(o), vreg)
2569 << GetStackContextAsString(visitor);
2570 UNREACHABLE();
2571 }
2572 tag = TagFromObject(soa, o);
2573 JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002574 break;
2575 }
2576 case JDWP::JT_DOUBLE: {
2577 CHECK_EQ(width, 8U);
2578 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002579 if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2580 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002581 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002582 VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2583 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002584 break;
2585 }
2586 case JDWP::JT_LONG: {
2587 CHECK_EQ(width, 8U);
2588 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002589 if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2590 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002591 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002592 VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2593 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002594 break;
2595 }
2596 default:
2597 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002598 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002599 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002600
Sebastien Hertz8009f392014-09-01 17:07:11 +02002601 // Prepend tag, which may have been updated.
2602 JDWP::Set1(buf, tag);
2603 return JDWP::ERR_NONE;
2604}
2605
2606JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2607 JDWP::ObjectId thread_id = request->ReadThreadId();
2608 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002609
2610 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002611 JDWP::JdwpError error;
2612 Thread* thread = DecodeThread(soa, thread_id, &error);
2613 if (error != JDWP::ERR_NONE) {
2614 return error;
2615 }
2616 if (!IsSuspendedForDebugger(soa, thread)) {
2617 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002618 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002619 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002620 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002621 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002622 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002623 if (visitor.GetError() != JDWP::ERR_NONE) {
2624 return visitor.GetError();
2625 }
2626
2627 // Writes the values into visitor's context.
2628 int32_t slot_count = request->ReadSigned32("slot count");
2629 for (int32_t i = 0; i < slot_count; ++i) {
2630 uint32_t slot = request->ReadUnsigned32("slot");
2631 JDWP::JdwpTag sigByte = request->ReadTag();
2632 size_t width = Dbg::GetTagWidth(sigByte);
2633 uint64_t value = request->ReadValue(width);
2634
2635 VLOG(jdwp) << " --> slot " << slot << " " << sigByte << " " << value;
Sebastien Hertz69206392015-04-07 15:54:25 +02002636 error = Dbg::SetLocalValue(visitor, slot, sigByte, value, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002637 if (error != JDWP::ERR_NONE) {
2638 return error;
2639 }
2640 }
2641 return JDWP::ERR_NONE;
2642}
2643
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002644template<typename T>
2645static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2646 JDWP::JdwpTag tag, T value)
Mathieu Chartier90443472015-07-16 20:32:27 -07002647 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002648 LOG(ERROR) << "Failed to write " << tag << " local " << value
2649 << " (0x" << std::hex << value << ") into register v" << vreg
2650 << GetStackContextAsString(visitor);
2651 return kStackFrameLocalAccessError;
2652}
2653
Sebastien Hertz8009f392014-09-01 17:07:11 +02002654JDWP::JdwpError Dbg::SetLocalValue(StackVisitor& visitor, int slot, JDWP::JdwpTag tag,
2655 uint64_t value, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002656 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002657 JDWP::JdwpError error = JDWP::ERR_NONE;
2658 uint16_t vreg = DemangleSlot(slot, m, &error);
2659 if (error != JDWP::ERR_NONE) {
2660 return error;
2661 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002662 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002663 switch (tag) {
2664 case JDWP::JT_BOOLEAN:
2665 case JDWP::JT_BYTE:
2666 CHECK_EQ(width, 1U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002667 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2668 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002669 }
2670 break;
2671 case JDWP::JT_SHORT:
2672 case JDWP::JT_CHAR:
2673 CHECK_EQ(width, 2U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002674 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2675 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002676 }
2677 break;
2678 case JDWP::JT_INT:
2679 CHECK_EQ(width, 4U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002680 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2681 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002682 }
2683 break;
2684 case JDWP::JT_FLOAT:
2685 CHECK_EQ(width, 4U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002686 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
2687 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002688 }
2689 break;
2690 case JDWP::JT_ARRAY:
2691 case JDWP::JT_CLASS_LOADER:
2692 case JDWP::JT_CLASS_OBJECT:
2693 case JDWP::JT_OBJECT:
2694 case JDWP::JT_STRING:
2695 case JDWP::JT_THREAD:
2696 case JDWP::JT_THREAD_GROUP: {
2697 CHECK_EQ(width, sizeof(JDWP::ObjectId));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002698 mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2699 &error);
2700 if (error != JDWP::ERR_NONE) {
2701 VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2702 return JDWP::ERR_INVALID_OBJECT;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002703 }
2704 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
2705 kReferenceVReg)) {
2706 return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002707 }
2708 break;
2709 }
2710 case JDWP::JT_DOUBLE: {
2711 CHECK_EQ(width, 8U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002712 if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
2713 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002714 }
2715 break;
2716 }
2717 case JDWP::JT_LONG: {
2718 CHECK_EQ(width, 8U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002719 if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
2720 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002721 }
2722 break;
2723 }
2724 default:
2725 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002726 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002727 }
2728 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002729}
2730
Mathieu Chartiere401d142015-04-22 13:56:20 -07002731static void SetEventLocation(JDWP::EventLocation* location, ArtMethod* m, uint32_t dex_pc)
Mathieu Chartier90443472015-07-16 20:32:27 -07002732 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002733 DCHECK(location != nullptr);
2734 if (m == nullptr) {
2735 memset(location, 0, sizeof(*location));
2736 } else {
2737 location->method = m;
2738 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002739 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002740}
2741
Mathieu Chartiere401d142015-04-22 13:56:20 -07002742void Dbg::PostLocationEvent(ArtMethod* m, int dex_pc, mirror::Object* this_object,
Jeff Hao579b0242013-11-18 13:16:49 -08002743 int event_flags, const JValue* return_value) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002744 if (!IsDebuggerActive()) {
2745 return;
2746 }
2747 DCHECK(m != nullptr);
2748 DCHECK_EQ(m->IsStatic(), this_object == nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002749 JDWP::EventLocation location;
2750 SetEventLocation(&location, m, dex_pc);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002751
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002752 // We need to be sure no exception is pending when calling JdwpState::PostLocationEvent.
2753 // This is required to be able to call JNI functions to create JDWP ids. To achieve this,
2754 // we temporarily clear the current thread's exception (if any) and will restore it after
2755 // the call.
2756 // Note: the only way to get a pending exception here is to suspend on a move-exception
2757 // instruction.
2758 Thread* const self = Thread::Current();
2759 StackHandleScope<1> hs(self);
2760 Handle<mirror::Throwable> pending_exception(hs.NewHandle(self->GetException()));
2761 self->ClearException();
2762 if (kIsDebugBuild && pending_exception.Get() != nullptr) {
2763 const DexFile::CodeItem* code_item = location.method->GetCodeItem();
2764 const Instruction* instr = Instruction::At(&code_item->insns_[location.dex_pc]);
2765 CHECK_EQ(Instruction::MOVE_EXCEPTION, instr->Opcode());
2766 }
2767
Sebastien Hertz6995c602014-09-09 12:10:13 +02002768 gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002769
2770 if (pending_exception.Get() != nullptr) {
2771 self->SetException(pending_exception.Get());
2772 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002773}
2774
Mathieu Chartiere401d142015-04-22 13:56:20 -07002775void Dbg::PostFieldAccessEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002776 mirror::Object* this_object, ArtField* f) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002777 if (!IsDebuggerActive()) {
2778 return;
2779 }
2780 DCHECK(m != nullptr);
2781 DCHECK(f != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002782 JDWP::EventLocation location;
2783 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002784
Sebastien Hertz6995c602014-09-09 12:10:13 +02002785 gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002786}
2787
Mathieu Chartiere401d142015-04-22 13:56:20 -07002788void Dbg::PostFieldModificationEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002789 mirror::Object* this_object, ArtField* f,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002790 const JValue* field_value) {
2791 if (!IsDebuggerActive()) {
2792 return;
2793 }
2794 DCHECK(m != nullptr);
2795 DCHECK(f != nullptr);
2796 DCHECK(field_value != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002797 JDWP::EventLocation location;
2798 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002799
Sebastien Hertz6995c602014-09-09 12:10:13 +02002800 gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002801}
2802
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002803/**
2804 * Finds the location where this exception will be caught. We search until we reach the top
2805 * frame, in which case this exception is considered uncaught.
2806 */
2807class CatchLocationFinder : public StackVisitor {
2808 public:
2809 CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
Mathieu Chartier90443472015-07-16 20:32:27 -07002810 SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002811 : StackVisitor(self, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002812 self_(self),
2813 exception_(exception),
2814 handle_scope_(self),
2815 this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002816 catch_method_(nullptr),
2817 throw_method_(nullptr),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002818 catch_dex_pc_(DexFile::kDexNoIndex),
2819 throw_dex_pc_(DexFile::kDexNoIndex) {
2820 }
2821
Mathieu Chartier90443472015-07-16 20:32:27 -07002822 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002823 ArtMethod* method = GetMethod();
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002824 DCHECK(method != nullptr);
2825 if (method->IsRuntimeMethod()) {
2826 // Ignore callee save method.
2827 DCHECK(method->IsCalleeSaveMethod());
2828 return true;
2829 }
2830
2831 uint32_t dex_pc = GetDexPc();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002832 if (throw_method_ == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002833 // First Java method found. It is either the method that threw the exception,
2834 // or the Java native method that is reporting an exception thrown by
2835 // native code.
2836 this_at_throw_.Assign(GetThisObject());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002837 throw_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002838 throw_dex_pc_ = dex_pc;
2839 }
2840
2841 if (dex_pc != DexFile::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002842 StackHandleScope<1> hs(self_);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002843 uint32_t found_dex_pc;
2844 Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002845 bool unused_clear_exception;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002846 found_dex_pc = method->FindCatchBlock(exception_class, dex_pc, &unused_clear_exception);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002847 if (found_dex_pc != DexFile::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002848 catch_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002849 catch_dex_pc_ = found_dex_pc;
2850 return false; // End stack walk.
2851 }
2852 }
2853 return true; // Continue stack walk.
2854 }
2855
Mathieu Chartier90443472015-07-16 20:32:27 -07002856 ArtMethod* GetCatchMethod() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002857 return catch_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002858 }
2859
Mathieu Chartier90443472015-07-16 20:32:27 -07002860 ArtMethod* GetThrowMethod() SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002861 return throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002862 }
2863
Mathieu Chartier90443472015-07-16 20:32:27 -07002864 mirror::Object* GetThisAtThrow() SHARED_REQUIRES(Locks::mutator_lock_) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002865 return this_at_throw_.Get();
2866 }
2867
2868 uint32_t GetCatchDexPc() const {
2869 return catch_dex_pc_;
2870 }
2871
2872 uint32_t GetThrowDexPc() const {
2873 return throw_dex_pc_;
2874 }
2875
2876 private:
2877 Thread* const self_;
2878 const Handle<mirror::Throwable>& exception_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002879 StackHandleScope<1> handle_scope_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002880 MutableHandle<mirror::Object> this_at_throw_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002881 ArtMethod* catch_method_;
2882 ArtMethod* throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002883 uint32_t catch_dex_pc_;
2884 uint32_t throw_dex_pc_;
2885
2886 DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
2887};
2888
2889void Dbg::PostException(mirror::Throwable* exception_object) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07002890 if (!IsDebuggerActive()) {
Ian Rogers0ad5bb82011-12-07 10:16:32 -08002891 return;
2892 }
Sebastien Hertz261bc042015-04-08 09:36:07 +02002893 Thread* const self = Thread::Current();
2894 StackHandleScope<1> handle_scope(self);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002895 Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
2896 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz261bc042015-04-08 09:36:07 +02002897 CatchLocationFinder clf(self, h_exception, context.get());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002898 clf.WalkStack(/* include_transitions */ false);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002899 JDWP::EventLocation exception_throw_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002900 SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
Sebastien Hertz6995c602014-09-09 12:10:13 +02002901 JDWP::EventLocation exception_catch_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002902 SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
Elliott Hughes4740cdf2011-12-07 14:07:12 -08002903
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002904 gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
2905 clf.GetThisAtThrow());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002906}
2907
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002908void Dbg::PostClassPrepare(mirror::Class* c) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07002909 if (!IsDebuggerActive()) {
Elliott Hughes4740cdf2011-12-07 14:07:12 -08002910 return;
2911 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02002912 gJdwpState->PostClassPrepare(c);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002913}
2914
Ian Rogers62d6c772013-02-27 08:32:07 -08002915void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -07002916 ArtMethod* m, uint32_t dex_pc,
Sebastien Hertz8379b222014-02-24 17:38:15 +01002917 int event_flags, const JValue* return_value) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002918 if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
Elliott Hughes2aa2e392012-02-17 17:15:43 -08002919 return;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002920 }
2921
Elliott Hughes86964332012-02-15 19:37:42 -08002922 if (IsBreakpoint(m, dex_pc)) {
2923 event_flags |= kBreakpoint;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002924 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002925
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002926 // If the debugger is single-stepping one of our threads, check to
2927 // see if we're that thread and we've reached a step point.
2928 const SingleStepControl* single_step_control = thread->GetSingleStepControl();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002929 if (single_step_control != nullptr) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002930 CHECK(!m->IsNative());
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002931 if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002932 // Step into method calls. We break when the line number
2933 // or method pointer changes. If we're in SS_MIN mode, we
2934 // always stop.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002935 if (single_step_control->GetMethod() != m) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002936 event_flags |= kSingleStep;
2937 VLOG(jdwp) << "SS new method";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002938 } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002939 event_flags |= kSingleStep;
2940 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02002941 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002942 event_flags |= kSingleStep;
2943 VLOG(jdwp) << "SS new line";
2944 }
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002945 } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002946 // Step over method calls. We break when the line number is
2947 // different and the frame depth is <= the original frame
2948 // depth. (We can't just compare on the method, because we
2949 // might get unrolled past it by an exception, and it's tricky
2950 // to identify recursion.)
2951
2952 int stack_depth = GetStackDepth(thread);
2953
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002954 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002955 // Popped up one or more frames, always trigger.
2956 event_flags |= kSingleStep;
2957 VLOG(jdwp) << "SS method pop";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002958 } else if (stack_depth == single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002959 // Same depth, see if we moved.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002960 if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Elliott Hughes86964332012-02-15 19:37:42 -08002961 event_flags |= kSingleStep;
2962 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02002963 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Elliott Hughes2435a572012-02-17 16:07:41 -08002964 event_flags |= kSingleStep;
2965 VLOG(jdwp) << "SS new line";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002966 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002967 }
2968 } else {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002969 CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002970 // Return from the current method. We break when the frame
2971 // depth pops up.
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002972
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002973 // This differs from the "method exit" break in that it stops
2974 // with the PC at the next instruction in the returned-to
2975 // function, rather than the end of the returning function.
Elliott Hughes86964332012-02-15 19:37:42 -08002976
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002977 int stack_depth = GetStackDepth(thread);
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002978 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002979 event_flags |= kSingleStep;
2980 VLOG(jdwp) << "SS method pop";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002981 }
2982 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002983 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002984
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002985 // If there's something interesting going on, see if it matches one
2986 // of the debugger filters.
2987 if (event_flags != 0) {
Sebastien Hertz8379b222014-02-24 17:38:15 +01002988 Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002989 }
2990}
2991
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02002992size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
2993 switch (instrumentation_event) {
2994 case instrumentation::Instrumentation::kMethodEntered:
2995 return &method_enter_event_ref_count_;
2996 case instrumentation::Instrumentation::kMethodExited:
2997 return &method_exit_event_ref_count_;
2998 case instrumentation::Instrumentation::kDexPcMoved:
2999 return &dex_pc_change_event_ref_count_;
3000 case instrumentation::Instrumentation::kFieldRead:
3001 return &field_read_event_ref_count_;
3002 case instrumentation::Instrumentation::kFieldWritten:
3003 return &field_write_event_ref_count_;
3004 case instrumentation::Instrumentation::kExceptionCaught:
3005 return &exception_catch_event_ref_count_;
3006 default:
3007 return nullptr;
3008 }
3009}
3010
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003011// Process request while all mutator threads are suspended.
3012void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003013 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003014 switch (request.GetKind()) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003015 case DeoptimizationRequest::kNothing:
3016 LOG(WARNING) << "Ignoring empty deoptimization request.";
3017 break;
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003018 case DeoptimizationRequest::kRegisterForEvent:
3019 VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003020 request.InstrumentationEvent());
3021 instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
3022 instrumentation_events_ |= request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003023 break;
3024 case DeoptimizationRequest::kUnregisterForEvent:
3025 VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003026 request.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003027 instrumentation->RemoveListener(&gDebugInstrumentationListener,
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003028 request.InstrumentationEvent());
3029 instrumentation_events_ &= ~request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003030 break;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003031 case DeoptimizationRequest::kFullDeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003032 VLOG(jdwp) << "Deoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003033 instrumentation->DeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003034 VLOG(jdwp) << "Deoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003035 break;
3036 case DeoptimizationRequest::kFullUndeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003037 VLOG(jdwp) << "Undeoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003038 instrumentation->UndeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003039 VLOG(jdwp) << "Undeoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003040 break;
3041 case DeoptimizationRequest::kSelectiveDeoptimization:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003042 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " ...";
3043 instrumentation->Deoptimize(request.Method());
3044 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003045 break;
3046 case DeoptimizationRequest::kSelectiveUndeoptimization:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003047 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " ...";
3048 instrumentation->Undeoptimize(request.Method());
3049 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003050 break;
3051 default:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003052 LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003053 break;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003054 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003055}
3056
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003057void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003058 if (req.GetKind() == DeoptimizationRequest::kNothing) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003059 // Nothing to do.
3060 return;
3061 }
Brian Carlstrom306db812014-09-05 13:01:41 -07003062 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003063 RequestDeoptimizationLocked(req);
3064}
3065
3066void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003067 switch (req.GetKind()) {
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003068 case DeoptimizationRequest::kRegisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003069 DCHECK_NE(req.InstrumentationEvent(), 0u);
3070 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003071 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003072 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003073 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003074 VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003075 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003076 deoptimization_requests_.push_back(req);
3077 }
3078 *counter = *counter + 1;
3079 break;
3080 }
3081 case DeoptimizationRequest::kUnregisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003082 DCHECK_NE(req.InstrumentationEvent(), 0u);
3083 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003084 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003085 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003086 *counter = *counter - 1;
3087 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003088 VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003089 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003090 deoptimization_requests_.push_back(req);
3091 }
3092 break;
3093 }
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003094 case DeoptimizationRequest::kFullDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003095 DCHECK(req.Method() == nullptr);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003096 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003097 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3098 << " for full deoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003099 deoptimization_requests_.push_back(req);
3100 }
3101 ++full_deoptimization_event_count_;
3102 break;
3103 }
3104 case DeoptimizationRequest::kFullUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003105 DCHECK(req.Method() == nullptr);
Sebastien Hertze713d932014-05-15 10:48:53 +02003106 DCHECK_GT(full_deoptimization_event_count_, 0U);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003107 --full_deoptimization_event_count_;
3108 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003109 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3110 << " for full undeoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003111 deoptimization_requests_.push_back(req);
3112 }
3113 break;
3114 }
3115 case DeoptimizationRequest::kSelectiveDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003116 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003117 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003118 << " for deoptimization of " << PrettyMethod(req.Method());
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003119 deoptimization_requests_.push_back(req);
3120 break;
3121 }
3122 case DeoptimizationRequest::kSelectiveUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003123 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003124 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003125 << " for undeoptimization of " << PrettyMethod(req.Method());
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003126 deoptimization_requests_.push_back(req);
3127 break;
3128 }
3129 default: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003130 LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003131 break;
3132 }
3133 }
3134}
3135
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003136void Dbg::ManageDeoptimization() {
3137 Thread* const self = Thread::Current();
3138 {
3139 // Avoid suspend/resume if there is no pending request.
Brian Carlstrom306db812014-09-05 13:01:41 -07003140 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003141 if (deoptimization_requests_.empty()) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003142 return;
3143 }
3144 }
3145 CHECK_EQ(self->GetState(), kRunnable);
3146 self->TransitionFromRunnableToSuspended(kWaitingForDeoptimization);
3147 // We need to suspend mutator threads first.
3148 Runtime* const runtime = Runtime::Current();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -07003149 runtime->GetThreadList()->SuspendAll(__FUNCTION__);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003150 const ThreadState old_state = self->SetStateUnsafe(kRunnable);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003151 {
Brian Carlstrom306db812014-09-05 13:01:41 -07003152 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003153 size_t req_index = 0;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003154 for (DeoptimizationRequest& request : deoptimization_requests_) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003155 VLOG(jdwp) << "Process deoptimization request #" << req_index++;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003156 ProcessDeoptimizationRequest(request);
3157 }
3158 deoptimization_requests_.clear();
3159 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003160 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
3161 runtime->GetThreadList()->ResumeAll();
3162 self->TransitionFromSuspendedToRunnable();
3163}
3164
Mathieu Chartiere401d142015-04-22 13:56:20 -07003165static bool IsMethodPossiblyInlined(Thread* self, ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07003166 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003167 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003168 if (code_item == nullptr) {
3169 // TODO We should not be asked to watch location in a native or abstract method so the code item
3170 // should never be null. We could just check we never encounter this case.
3171 return false;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003172 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003173 // Note: method verifier may cause thread suspension.
3174 self->AssertThreadSuspensionIsAllowable();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003175 StackHandleScope<2> hs(self);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003176 mirror::Class* declaring_class = m->GetDeclaringClass();
3177 Handle<mirror::DexCache> dex_cache(hs.NewHandle(declaring_class->GetDexCache()));
3178 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(declaring_class->GetClassLoader()));
Ian Rogers7b078e82014-09-10 14:44:24 -07003179 verifier::MethodVerifier verifier(self, dex_cache->GetDexFile(), dex_cache, class_loader,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003180 &m->GetClassDef(), code_item, m->GetDexMethodIndex(), m,
Mathieu Chartier4306ef82014-12-19 18:41:47 -08003181 m->GetAccessFlags(), false, true, false, true);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003182 // Note: we don't need to verify the method.
3183 return InlineMethodAnalyser::AnalyseMethodCode(&verifier, nullptr);
3184}
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003185
Mathieu Chartiere401d142015-04-22 13:56:20 -07003186static const Breakpoint* FindFirstBreakpointForMethod(ArtMethod* m)
Mathieu Chartier90443472015-07-16 20:32:27 -07003187 SHARED_REQUIRES(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003188 for (Breakpoint& breakpoint : gBreakpoints) {
3189 if (breakpoint.Method() == m) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003190 return &breakpoint;
3191 }
3192 }
3193 return nullptr;
3194}
3195
Mathieu Chartiere401d142015-04-22 13:56:20 -07003196bool Dbg::MethodHasAnyBreakpoints(ArtMethod* method) {
Mathieu Chartierd8565452015-03-26 09:41:50 -07003197 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3198 return FindFirstBreakpointForMethod(method) != nullptr;
3199}
3200
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003201// Sanity checks all existing breakpoints on the same method.
Mathieu Chartiere401d142015-04-22 13:56:20 -07003202static void SanityCheckExistingBreakpoints(ArtMethod* m,
Sebastien Hertzf3928792014-11-17 19:00:37 +01003203 DeoptimizationRequest::Kind deoptimization_kind)
Mathieu Chartier90443472015-07-16 20:32:27 -07003204 SHARED_REQUIRES(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003205 for (const Breakpoint& breakpoint : gBreakpoints) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003206 if (breakpoint.Method() == m) {
3207 CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3208 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003209 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003210 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3211 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003212 // We should have deoptimized everything but not "selectively" deoptimized this method.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003213 CHECK(instrumentation->AreAllMethodsDeoptimized());
3214 CHECK(!instrumentation->IsDeoptimized(m));
3215 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003216 // We should have "selectively" deoptimized this method.
3217 // Note: while we have not deoptimized everything for this method, we may have done it for
3218 // another event.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003219 CHECK(instrumentation->IsDeoptimized(m));
3220 } else {
3221 // This method does not require deoptimization.
3222 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3223 CHECK(!instrumentation->IsDeoptimized(m));
3224 }
3225}
3226
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003227// Returns the deoptimization kind required to set a breakpoint in a method.
3228// If a breakpoint has already been set, we also return the first breakpoint
3229// through the given 'existing_brkpt' pointer.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003230static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003231 ArtMethod* m,
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003232 const Breakpoint** existing_brkpt)
Mathieu Chartier90443472015-07-16 20:32:27 -07003233 SHARED_REQUIRES(Locks::mutator_lock_) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003234 if (!Dbg::RequiresDeoptimization()) {
3235 // We already run in interpreter-only mode so we don't need to deoptimize anything.
3236 VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
3237 << PrettyMethod(m);
3238 return DeoptimizationRequest::kNothing;
3239 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003240 const Breakpoint* first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003241 {
3242 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003243 first_breakpoint = FindFirstBreakpointForMethod(m);
3244 *existing_brkpt = first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003245 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003246
3247 if (first_breakpoint == nullptr) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003248 // There is no breakpoint on this method yet: we need to deoptimize. If this method may be
3249 // inlined, we deoptimize everything; otherwise we deoptimize only this method.
3250 // Note: IsMethodPossiblyInlined goes into the method verifier and may cause thread suspension.
3251 // Therefore we must not hold any lock when we call it.
3252 bool need_full_deoptimization = IsMethodPossiblyInlined(self, m);
3253 if (need_full_deoptimization) {
3254 VLOG(jdwp) << "Need full deoptimization because of possible inlining of method "
3255 << PrettyMethod(m);
3256 return DeoptimizationRequest::kFullDeoptimization;
3257 } else {
3258 // We don't need to deoptimize if the method has not been compiled.
3259 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
3260 const bool is_compiled = class_linker->GetOatMethodQuickCodeFor(m) != nullptr;
3261 if (is_compiled) {
Sebastien Hertz6963e442014-11-26 22:11:27 +01003262 // If the method may be called through its direct code pointer (without loading
3263 // its updated entrypoint), we need full deoptimization to not miss the breakpoint.
3264 if (class_linker->MayBeCalledWithDirectCodePointer(m)) {
3265 VLOG(jdwp) << "Need full deoptimization because of possible direct code call "
3266 << "into image for compiled method " << PrettyMethod(m);
3267 return DeoptimizationRequest::kFullDeoptimization;
3268 } else {
3269 VLOG(jdwp) << "Need selective deoptimization for compiled method " << PrettyMethod(m);
3270 return DeoptimizationRequest::kSelectiveDeoptimization;
3271 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003272 } else {
3273 // Method is not compiled: we don't need to deoptimize.
3274 VLOG(jdwp) << "No need for deoptimization for non-compiled method " << PrettyMethod(m);
3275 return DeoptimizationRequest::kNothing;
3276 }
3277 }
3278 } else {
3279 // There is at least one breakpoint for this method: we don't need to deoptimize.
3280 // Let's check that all breakpoints are configured the same way for deoptimization.
3281 VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003282 DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003283 if (kIsDebugBuild) {
3284 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3285 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3286 }
3287 return DeoptimizationRequest::kNothing;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003288 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003289}
3290
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003291// Installs a breakpoint at the specified location. Also indicates through the deoptimization
3292// request if we need to deoptimize.
3293void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3294 Thread* const self = Thread::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003295 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003296 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003297
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003298 const Breakpoint* existing_breakpoint = nullptr;
3299 const DeoptimizationRequest::Kind deoptimization_kind =
3300 GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003301 req->SetKind(deoptimization_kind);
3302 if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3303 req->SetMethod(m);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003304 } else {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003305 CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3306 deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003307 req->SetMethod(nullptr);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003308 }
3309
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003310 {
3311 WriterMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003312 // If there is at least one existing breakpoint on the same method, the new breakpoint
3313 // must have the same deoptimization kind than the existing breakpoint(s).
3314 DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3315 if (existing_breakpoint != nullptr) {
3316 breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3317 } else {
3318 breakpoint_deoptimization_kind = deoptimization_kind;
3319 }
3320 gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003321 VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3322 << gBreakpoints[gBreakpoints.size() - 1];
3323 }
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003324}
3325
3326// Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3327// request if we need to undeoptimize.
3328void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
Sebastien Hertzed2be172014-08-19 15:33:43 +02003329 WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003330 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003331 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003332 DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003333 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003334 if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].Method() == m) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003335 VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
Sebastien Hertzf3928792014-11-17 19:00:37 +01003336 deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3337 DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3338 Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003339 gBreakpoints.erase(gBreakpoints.begin() + i);
3340 break;
3341 }
3342 }
3343 const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3344 if (existing_breakpoint == nullptr) {
3345 // There is no more breakpoint on this method: we need to undeoptimize.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003346 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003347 // This method required full deoptimization: we need to undeoptimize everything.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003348 req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3349 req->SetMethod(nullptr);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003350 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003351 // This method required selective deoptimization: we need to undeoptimize only that method.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003352 req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3353 req->SetMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003354 } else {
3355 // This method had no need for deoptimization: do nothing.
3356 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3357 req->SetKind(DeoptimizationRequest::kNothing);
3358 req->SetMethod(nullptr);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003359 }
3360 } else {
3361 // There is at least one breakpoint for this method: we don't need to undeoptimize.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003362 req->SetKind(DeoptimizationRequest::kNothing);
3363 req->SetMethod(nullptr);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003364 if (kIsDebugBuild) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003365 SanityCheckExistingBreakpoints(m, deoptimization_kind);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003366 }
Elliott Hughes86964332012-02-15 19:37:42 -08003367 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003368}
3369
Mathieu Chartiere401d142015-04-22 13:56:20 -07003370bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003371 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3372 if (ssc == nullptr) {
3373 // If we are not single-stepping, then we don't have to force interpreter.
3374 return false;
3375 }
3376 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3377 // If we are in interpreter only mode, then we don't have to force interpreter.
3378 return false;
3379 }
3380
3381 if (!m->IsNative() && !m->IsProxyMethod()) {
3382 // If we want to step into a method, then we have to force interpreter on that call.
3383 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3384 return true;
3385 }
3386 }
3387 return false;
3388}
3389
Mathieu Chartiere401d142015-04-22 13:56:20 -07003390bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003391 instrumentation::Instrumentation* const instrumentation =
3392 Runtime::Current()->GetInstrumentation();
3393 // If we are in interpreter only mode, then we don't have to force interpreter.
3394 if (instrumentation->InterpretOnly()) {
3395 return false;
3396 }
3397 // We can only interpret pure Java method.
3398 if (m->IsNative() || m->IsProxyMethod()) {
3399 return false;
3400 }
3401 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3402 if (ssc != nullptr) {
3403 // If we want to step into a method, then we have to force interpreter on that call.
3404 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3405 return true;
3406 }
3407 // If we are stepping out from a static initializer, by issuing a step
3408 // in or step over, that was implicitly invoked by calling a static method,
3409 // then we need to step into that method. Having a lower stack depth than
3410 // the one the single step control has indicates that the step originates
3411 // from the static initializer.
3412 if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3413 ssc->GetStackDepth() > GetStackDepth(thread)) {
3414 return true;
3415 }
3416 }
3417 // There are cases where we have to force interpreter on deoptimized methods,
3418 // because in some cases the call will not be performed by invoking an entry
3419 // point that has been replaced by the deoptimization, but instead by directly
3420 // invoking the compiled code of the method, for example.
3421 return instrumentation->IsDeoptimized(m);
3422}
3423
Mathieu Chartiere401d142015-04-22 13:56:20 -07003424bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003425 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003426 if (m == nullptr) {
3427 return false;
3428 }
3429 instrumentation::Instrumentation* const instrumentation =
3430 Runtime::Current()->GetInstrumentation();
3431 // If we are in interpreter only mode, then we don't have to force interpreter.
3432 if (instrumentation->InterpretOnly()) {
3433 return false;
3434 }
3435 // We can only interpret pure Java method.
3436 if (m->IsNative() || m->IsProxyMethod()) {
3437 return false;
3438 }
3439 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3440 if (ssc != nullptr) {
3441 // If we are stepping out from a static initializer, by issuing a step
3442 // out, that was implicitly invoked by calling a static method, then we
3443 // need to step into the caller of that method. Having a lower stack
3444 // depth than the one the single step control has indicates that the
3445 // step originates from the static initializer.
3446 if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3447 ssc->GetStackDepth() > GetStackDepth(thread)) {
3448 return true;
3449 }
3450 }
3451 // If we are returning from a static intializer, that was implicitly
3452 // invoked by calling a static method and the caller is deoptimized,
3453 // then we have to deoptimize the stack without forcing interpreter
3454 // on the static method that was called originally. This problem can
3455 // be solved easily by forcing instrumentation on the called method,
3456 // because the instrumentation exit hook will recognise the need of
3457 // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3458 return instrumentation->IsDeoptimized(m);
3459}
3460
Mathieu Chartiere401d142015-04-22 13:56:20 -07003461bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003462 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003463 if (m == nullptr) {
3464 return false;
3465 }
3466 instrumentation::Instrumentation* const instrumentation =
3467 Runtime::Current()->GetInstrumentation();
3468 // If we are in interpreter only mode, then we don't have to force interpreter.
3469 if (instrumentation->InterpretOnly()) {
3470 return false;
3471 }
3472 // We can only interpret pure Java method.
3473 if (m->IsNative() || m->IsProxyMethod()) {
3474 return false;
3475 }
3476 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3477 if (ssc != nullptr) {
3478 // The debugger is not interested in what is happening under the level
3479 // of the step, thus we only force interpreter when we are not below of
3480 // the step.
3481 if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3482 return true;
3483 }
3484 }
3485 // We have to require stack deoptimization if the upcall is deoptimized.
3486 return instrumentation->IsDeoptimized(m);
3487}
3488
Jeff Hao449db332013-04-12 18:30:52 -07003489// Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3490// cause suspension if the thread is the current thread.
3491class ScopedThreadSuspension {
3492 public:
Ian Rogers33e95662013-05-20 20:29:14 -07003493 ScopedThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
Mathieu Chartier90443472015-07-16 20:32:27 -07003494 REQUIRES(!Locks::thread_list_lock_)
3495 SHARED_REQUIRES(Locks::mutator_lock_) :
Ian Rogersf3d874c2014-07-17 18:52:42 -07003496 thread_(nullptr),
Jeff Hao449db332013-04-12 18:30:52 -07003497 error_(JDWP::ERR_NONE),
3498 self_suspend_(false),
Ian Rogers33e95662013-05-20 20:29:14 -07003499 other_suspend_(false) {
Jeff Hao449db332013-04-12 18:30:52 -07003500 ScopedObjectAccessUnchecked soa(self);
Sebastien Hertz69206392015-04-07 15:54:25 +02003501 thread_ = DecodeThread(soa, thread_id, &error_);
Jeff Hao449db332013-04-12 18:30:52 -07003502 if (error_ == JDWP::ERR_NONE) {
3503 if (thread_ == soa.Self()) {
3504 self_suspend_ = true;
3505 } else {
3506 soa.Self()->TransitionFromRunnableToSuspended(kWaitingForDebuggerSuspension);
Sebastien Hertz6995c602014-09-09 12:10:13 +02003507 jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
Jeff Hao449db332013-04-12 18:30:52 -07003508 bool timed_out;
Ian Rogers4ad5cd32014-11-11 23:08:07 -08003509 ThreadList* thread_list = Runtime::Current()->GetThreadList();
3510 Thread* suspended_thread = thread_list->SuspendThreadByPeer(thread_peer, true, true,
3511 &timed_out);
Jeff Hao449db332013-04-12 18:30:52 -07003512 CHECK_EQ(soa.Self()->TransitionFromSuspendedToRunnable(), kWaitingForDebuggerSuspension);
Ian Rogersf3d874c2014-07-17 18:52:42 -07003513 if (suspended_thread == nullptr) {
Jeff Hao449db332013-04-12 18:30:52 -07003514 // Thread terminated from under us while suspending.
3515 error_ = JDWP::ERR_INVALID_THREAD;
3516 } else {
3517 CHECK_EQ(suspended_thread, thread_);
3518 other_suspend_ = true;
3519 }
3520 }
3521 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003522 }
Elliott Hughes86964332012-02-15 19:37:42 -08003523
Jeff Hao449db332013-04-12 18:30:52 -07003524 Thread* GetThread() const {
3525 return thread_;
3526 }
3527
3528 JDWP::JdwpError GetError() const {
3529 return error_;
3530 }
3531
3532 ~ScopedThreadSuspension() {
3533 if (other_suspend_) {
3534 Runtime::Current()->GetThreadList()->Resume(thread_, true);
3535 }
3536 }
3537
3538 private:
3539 Thread* thread_;
3540 JDWP::JdwpError error_;
3541 bool self_suspend_;
3542 bool other_suspend_;
3543};
3544
3545JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3546 JDWP::JdwpStepDepth step_depth) {
3547 Thread* self = Thread::Current();
3548 ScopedThreadSuspension sts(self, thread_id);
3549 if (sts.GetError() != JDWP::ERR_NONE) {
3550 return sts.GetError();
3551 }
3552
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003553 // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
Elliott Hughes2435a572012-02-17 16:07:41 -08003554 // is for step-out.
Ian Rogers0399dde2012-06-06 17:09:28 -07003555 struct SingleStepStackVisitor : public StackVisitor {
Mathieu Chartier90443472015-07-16 20:32:27 -07003556 explicit SingleStepStackVisitor(Thread* thread) SHARED_REQUIRES(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003557 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3558 stack_depth(0),
3559 method(nullptr),
3560 line_number(-1) {}
Ian Rogersca190662012-06-26 15:45:57 -07003561
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003562 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3563 // annotalysis.
3564 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003565 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07003566 if (!m->IsRuntimeMethod()) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003567 ++stack_depth;
3568 if (method == nullptr) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08003569 mirror::DexCache* dex_cache = m->GetDeclaringClass()->GetDexCache();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003570 method = m;
Ian Rogersc0542af2014-09-03 16:16:56 -07003571 if (dex_cache != nullptr) {
Ian Rogers4445a7e2012-10-05 17:19:13 -07003572 const DexFile& dex_file = *dex_cache->GetDexFile();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003573 line_number = dex_file.GetLineNumFromPC(m, GetDexPc());
Elliott Hughes2435a572012-02-17 16:07:41 -08003574 }
Elliott Hughes86964332012-02-15 19:37:42 -08003575 }
3576 }
Elliott Hughes530fa002012-03-12 11:44:49 -07003577 return true;
Elliott Hughes86964332012-02-15 19:37:42 -08003578 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003579
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003580 int stack_depth;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003581 ArtMethod* method;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003582 int32_t line_number;
Elliott Hughes86964332012-02-15 19:37:42 -08003583 };
Jeff Hao449db332013-04-12 18:30:52 -07003584
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003585 Thread* const thread = sts.GetThread();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003586 SingleStepStackVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07003587 visitor.WalkStack();
Elliott Hughes86964332012-02-15 19:37:42 -08003588
Elliott Hughes2435a572012-02-17 16:07:41 -08003589 // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
Elliott Hughes2435a572012-02-17 16:07:41 -08003590 struct DebugCallbackContext {
Roland Levillain3887c462015-08-12 18:15:42 +01003591 DebugCallbackContext(SingleStepControl* single_step_control_cb,
3592 int32_t line_number_cb, const DexFile::CodeItem* code_item)
3593 : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
3594 code_item_(code_item), last_pc_valid(false), last_pc(0) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003595 }
3596
Andreas Gampe277ccbd2014-11-03 21:36:10 -08003597 static bool Callback(void* raw_context, uint32_t address, uint32_t line_number_cb) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003598 DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
Andreas Gampe277ccbd2014-11-03 21:36:10 -08003599 if (static_cast<int32_t>(line_number_cb) == context->line_number_) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003600 if (!context->last_pc_valid) {
3601 // Everything from this address until the next line change is ours.
3602 context->last_pc = address;
3603 context->last_pc_valid = true;
3604 }
3605 // Otherwise, if we're already in a valid range for this line,
3606 // just keep going (shouldn't really happen)...
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003607 } else if (context->last_pc_valid) { // and the line number is new
Elliott Hughes2435a572012-02-17 16:07:41 -08003608 // Add everything from the last entry up until here to the set
3609 for (uint32_t dex_pc = context->last_pc; dex_pc < address; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003610 context->single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003611 }
3612 context->last_pc_valid = false;
3613 }
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003614 return false; // There may be multiple entries for any given line.
Elliott Hughes2435a572012-02-17 16:07:41 -08003615 }
3616
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003617 ~DebugCallbackContext() {
Elliott Hughes2435a572012-02-17 16:07:41 -08003618 // If the line number was the last in the position table...
3619 if (last_pc_valid) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003620 size_t end = code_item_->insns_size_in_code_units_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003621 for (uint32_t dex_pc = last_pc; dex_pc < end; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003622 single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003623 }
3624 }
3625 }
3626
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003627 SingleStepControl* const single_step_control_;
3628 const int32_t line_number_;
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003629 const DexFile::CodeItem* const code_item_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003630 bool last_pc_valid;
3631 uint32_t last_pc;
3632 };
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003633
3634 // Allocate single step.
Sebastien Hertz1558b572015-02-25 15:05:59 +01003635 SingleStepControl* single_step_control =
3636 new (std::nothrow) SingleStepControl(step_size, step_depth,
3637 visitor.stack_depth, visitor.method);
3638 if (single_step_control == nullptr) {
3639 LOG(ERROR) << "Failed to allocate SingleStepControl";
3640 return JDWP::ERR_OUT_OF_MEMORY;
3641 }
3642
Mathieu Chartiere401d142015-04-22 13:56:20 -07003643 ArtMethod* m = single_step_control->GetMethod();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003644 const int32_t line_number = visitor.line_number;
Sebastien Hertz52f5f932015-05-28 11:00:57 +02003645 // Note: if the thread is not running Java code (pure native thread), there is no "current"
3646 // method on the stack (and no line number either).
3647 if (m != nullptr && !m->IsNative()) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003648 const DexFile::CodeItem* const code_item = m->GetCodeItem();
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003649 DebugCallbackContext context(single_step_control, line_number, code_item);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003650 m->GetDexFile()->DecodeDebugInfo(code_item, m->IsStatic(), m->GetDexMethodIndex(),
Ian Rogersc0542af2014-09-03 16:16:56 -07003651 DebugCallbackContext::Callback, nullptr, &context);
Elliott Hughes3e2e1a22012-02-21 11:33:41 -08003652 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003653
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003654 // Activate single-step in the thread.
3655 thread->ActivateSingleStepControl(single_step_control);
Elliott Hughes86964332012-02-15 19:37:42 -08003656
Elliott Hughes2435a572012-02-17 16:07:41 -08003657 if (VLOG_IS_ON(jdwp)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003658 VLOG(jdwp) << "Single-step thread: " << *thread;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003659 VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3660 VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
3661 VLOG(jdwp) << "Single-step current method: " << PrettyMethod(single_step_control->GetMethod());
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003662 VLOG(jdwp) << "Single-step current line: " << line_number;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003663 VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
Elliott Hughes2435a572012-02-17 16:07:41 -08003664 VLOG(jdwp) << "Single-step dex_pc values:";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003665 for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003666 VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003667 }
3668 }
3669
3670 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003671}
3672
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003673void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3674 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07003675 JDWP::JdwpError error;
3676 Thread* thread = DecodeThread(soa, thread_id, &error);
Sebastien Hertz87118ed2013-11-26 17:57:18 +01003677 if (error == JDWP::ERR_NONE) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003678 thread->DeactivateSingleStepControl();
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003679 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003680}
3681
Elliott Hughes45651fd2012-02-21 15:48:20 -08003682static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3683 switch (tag) {
3684 default:
3685 LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
Ian Rogersfc787ec2014-10-09 21:56:44 -07003686 UNREACHABLE();
Elliott Hughes45651fd2012-02-21 15:48:20 -08003687
3688 // Primitives.
3689 case JDWP::JT_BYTE: return 'B';
3690 case JDWP::JT_CHAR: return 'C';
3691 case JDWP::JT_FLOAT: return 'F';
3692 case JDWP::JT_DOUBLE: return 'D';
3693 case JDWP::JT_INT: return 'I';
3694 case JDWP::JT_LONG: return 'J';
3695 case JDWP::JT_SHORT: return 'S';
3696 case JDWP::JT_VOID: return 'V';
3697 case JDWP::JT_BOOLEAN: return 'Z';
3698
3699 // Reference types.
3700 case JDWP::JT_ARRAY:
3701 case JDWP::JT_OBJECT:
3702 case JDWP::JT_STRING:
3703 case JDWP::JT_THREAD:
3704 case JDWP::JT_THREAD_GROUP:
3705 case JDWP::JT_CLASS_LOADER:
3706 case JDWP::JT_CLASS_OBJECT:
3707 return 'L';
3708 }
3709}
3710
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003711JDWP::JdwpError Dbg::PrepareInvokeMethod(uint32_t request_id, JDWP::ObjectId thread_id,
3712 JDWP::ObjectId object_id, JDWP::RefTypeId class_id,
3713 JDWP::MethodId method_id, uint32_t arg_count,
3714 uint64_t arg_values[], JDWP::JdwpTag* arg_types,
3715 uint32_t options) {
3716 Thread* const self = Thread::Current();
3717 CHECK_EQ(self, GetDebugThread()) << "This must be called by the JDWP thread";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003718
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003719 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Ian Rogersc0542af2014-09-03 16:16:56 -07003720 Thread* targetThread = nullptr;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003721 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003722 ScopedObjectAccessUnchecked soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07003723 JDWP::JdwpError error;
3724 targetThread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08003725 if (error != JDWP::ERR_NONE) {
3726 LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3727 return error;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003728 }
Sebastien Hertz1558b572015-02-25 15:05:59 +01003729 if (targetThread->GetInvokeReq() != nullptr) {
3730 // Thread is already invoking a method on behalf of the debugger.
3731 LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
3732 return JDWP::ERR_ALREADY_INVOKING;
3733 }
3734 if (!targetThread->IsReadyForDebugInvoke()) {
3735 // Thread is not suspended by an event so it cannot invoke a method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003736 LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
3737 return JDWP::ERR_INVALID_THREAD;
3738 }
3739
3740 /*
3741 * We currently have a bug where we don't successfully resume the
3742 * target thread if the suspend count is too deep. We're expected to
3743 * require one "resume" for each "suspend", but when asked to execute
3744 * a method we have to resume fully and then re-suspend it back to the
3745 * same level. (The easiest way to cause this is to type "suspend"
3746 * multiple times in jdb.)
3747 *
3748 * It's unclear what this means when the event specifies "resume all"
3749 * and some threads are suspended more deeply than others. This is
3750 * a rare problem, so for now we just prevent it from hanging forever
3751 * by rejecting the method invocation request. Without this, we will
3752 * be stuck waiting on a suspended thread.
3753 */
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003754 int suspend_count;
3755 {
Ian Rogers50b35e22012-10-04 10:09:15 -07003756 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003757 suspend_count = targetThread->GetSuspendCount();
3758 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08003759 if (suspend_count > 1) {
3760 LOG(ERROR) << *targetThread << " suspend count too deep for method invocation: " << suspend_count;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003761 return JDWP::ERR_THREAD_SUSPENDED; // Probably not expected here.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003762 }
3763
Ian Rogersc0542af2014-09-03 16:16:56 -07003764 mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
3765 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003766 return JDWP::ERR_INVALID_OBJECT;
3767 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003768
Sebastien Hertz1558b572015-02-25 15:05:59 +01003769 gRegistry->Get<mirror::Object*>(thread_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07003770 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003771 return JDWP::ERR_INVALID_OBJECT;
3772 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003773
Ian Rogersc0542af2014-09-03 16:16:56 -07003774 mirror::Class* c = DecodeClass(class_id, &error);
3775 if (c == nullptr) {
3776 return error;
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003777 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003778
Mathieu Chartiere401d142015-04-22 13:56:20 -07003779 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07003780 if (m->IsStatic() != (receiver == nullptr)) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003781 return JDWP::ERR_INVALID_METHODID;
3782 }
3783 if (m->IsStatic()) {
3784 if (m->GetDeclaringClass() != c) {
3785 return JDWP::ERR_INVALID_METHODID;
3786 }
3787 } else {
3788 if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
3789 return JDWP::ERR_INVALID_METHODID;
3790 }
3791 }
3792
3793 // Check the argument list matches the method.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003794 uint32_t shorty_len = 0;
3795 const char* shorty = m->GetShorty(&shorty_len);
3796 if (shorty_len - 1 != arg_count) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003797 return JDWP::ERR_ILLEGAL_ARGUMENT;
3798 }
Elliott Hughes09201632013-04-15 15:50:07 -07003799
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003800 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003801 StackHandleScope<2> hs(soa.Self());
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003802 HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
3803 HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
3804 const DexFile::TypeList* types = m->GetParameterTypeList();
3805 for (size_t i = 0; i < arg_count; ++i) {
3806 if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
Elliott Hughes09201632013-04-15 15:50:07 -07003807 return JDWP::ERR_ILLEGAL_ARGUMENT;
3808 }
3809
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003810 if (shorty[i + 1] == 'L') {
3811 // Did we really get an argument of an appropriate reference type?
Ian Rogersa0485602014-12-02 15:48:04 -08003812 mirror::Class* parameter_type =
Mathieu Chartiere401d142015-04-22 13:56:20 -07003813 m->GetClassFromTypeIndex(types->GetTypeItem(i).type_idx_, true);
Ian Rogersc0542af2014-09-03 16:16:56 -07003814 mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
3815 if (error != JDWP::ERR_NONE) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003816 return JDWP::ERR_INVALID_OBJECT;
3817 }
Ian Rogersc0542af2014-09-03 16:16:56 -07003818 if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003819 return JDWP::ERR_ILLEGAL_ARGUMENT;
3820 }
3821
3822 // Turn the on-the-wire ObjectId into a jobject.
3823 jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
3824 v.l = gRegistry->GetJObject(arg_values[i]);
3825 }
Elliott Hughes09201632013-04-15 15:50:07 -07003826 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003827 }
3828
Sebastien Hertz1558b572015-02-25 15:05:59 +01003829 // Allocates a DebugInvokeReq.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003830 DebugInvokeReq* req = new (std::nothrow) DebugInvokeReq(request_id, thread_id, receiver, c, m,
3831 options, arg_values, arg_count);
3832 if (req == nullptr) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003833 LOG(ERROR) << "Failed to allocate DebugInvokeReq";
3834 return JDWP::ERR_OUT_OF_MEMORY;
3835 }
3836
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003837 // Attaches the DebugInvokeReq to the target thread so it executes the method when
3838 // it is resumed. Once the invocation completes, the target thread will delete it before
3839 // suspending itself (see ThreadList::SuspendSelfForDebugger).
3840 targetThread->SetDebugInvokeReq(req);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003841 }
3842
3843 // 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 +02003844 // away we're sitting high and dry -- but we must release this before the UndoDebuggerSuspensions
3845 // call.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003846
Elliott Hughesd07986f2011-12-06 18:27:45 -08003847 if ((options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003848 VLOG(jdwp) << " Resuming all threads";
3849 thread_list->UndoDebuggerSuspensions();
3850 } else {
3851 VLOG(jdwp) << " Resuming event thread only";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003852 thread_list->Resume(targetThread, true);
3853 }
3854
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003855 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003856}
3857
3858void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003859 Thread* const self = Thread::Current();
3860 CHECK_NE(self, GetDebugThread()) << "This must be called by the event thread";
3861
3862 ScopedObjectAccess soa(self);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003863
Elliott Hughes81ff3182012-03-23 20:35:56 -07003864 // We can be called while an exception is pending. We need
Elliott Hughesd07986f2011-12-06 18:27:45 -08003865 // to preserve that across the method invocation.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003866 StackHandleScope<1> hs(soa.Self());
3867 Handle<mirror::Throwable> old_exception = hs.NewHandle(soa.Self()->GetException());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003868 soa.Self()->ClearException();
Elliott Hughesd07986f2011-12-06 18:27:45 -08003869
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003870 // Execute the method then sends reply to the debugger.
3871 ExecuteMethodWithoutPendingException(soa, pReq);
3872
3873 // If an exception was pending before the invoke, restore it now.
3874 if (old_exception.Get() != nullptr) {
3875 soa.Self()->SetException(old_exception.Get());
3876 }
3877}
3878
3879// Helper function: write a variable-width value into the output input buffer.
3880static void WriteValue(JDWP::ExpandBuf* pReply, int width, uint64_t value) {
3881 switch (width) {
3882 case 1:
3883 expandBufAdd1(pReply, value);
3884 break;
3885 case 2:
3886 expandBufAdd2BE(pReply, value);
3887 break;
3888 case 4:
3889 expandBufAdd4BE(pReply, value);
3890 break;
3891 case 8:
3892 expandBufAdd8BE(pReply, value);
3893 break;
3894 default:
3895 LOG(FATAL) << width;
3896 UNREACHABLE();
3897 }
3898}
3899
3900void Dbg::ExecuteMethodWithoutPendingException(ScopedObjectAccess& soa, DebugInvokeReq* pReq) {
3901 soa.Self()->AssertNoPendingException();
3902
Elliott Hughesd07986f2011-12-06 18:27:45 -08003903 // Translate the method through the vtable, unless the debugger wants to suppress it.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003904 ArtMethod* m = pReq->method;
3905 size_t image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
Sebastien Hertz1558b572015-02-25 15:05:59 +01003906 if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003907 ArtMethod* actual_method =
3908 pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m, image_pointer_size);
3909 if (actual_method != m) {
3910 VLOG(jdwp) << "ExecuteMethod translated " << PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01003911 << " to " << PrettyMethod(actual_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003912 m = actual_method;
Elliott Hughes45651fd2012-02-21 15:48:20 -08003913 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08003914 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003915 VLOG(jdwp) << "ExecuteMethod " << PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01003916 << " receiver=" << pReq->receiver.Read()
Sebastien Hertzd38667a2013-11-25 15:43:54 +01003917 << " arg_count=" << pReq->arg_count;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003918 CHECK(m != nullptr);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003919
Roland Levillain33d69032015-06-18 18:20:59 +01003920 static_assert(sizeof(jvalue) == sizeof(uint64_t), "jvalue and uint64_t have different sizes.");
Elliott Hughesd07986f2011-12-06 18:27:45 -08003921
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003922 // Invoke the method.
Jeff Hao39b6c242015-05-19 20:30:23 -07003923 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(pReq->receiver.Read()));
Mathieu Chartiere401d142015-04-22 13:56:20 -07003924 JValue result = InvokeWithJValues(soa, ref.get(), soa.EncodeMethod(m),
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003925 reinterpret_cast<jvalue*>(pReq->arg_values.get()));
Elliott Hughesd07986f2011-12-06 18:27:45 -08003926
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003927 // Prepare JDWP ids for the reply.
3928 JDWP::JdwpTag result_tag = BasicTagFromDescriptor(m->GetShorty());
3929 const bool is_object_result = (result_tag == JDWP::JT_OBJECT);
3930 StackHandleScope<2> hs(soa.Self());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003931 Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
3932 Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
3933 soa.Self()->ClearException();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003934
3935 if (!IsDebuggerActive()) {
3936 // The debugger detached: we must not re-suspend threads. We also don't need to fill the reply
3937 // because it won't be sent either.
3938 return;
3939 }
3940
3941 JDWP::ObjectId exceptionObjectId = gRegistry->Add(exception);
3942 uint64_t result_value = 0;
3943 if (exceptionObjectId != 0) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003944 VLOG(jdwp) << " JDWP invocation returning with exception=" << exception.Get()
3945 << " " << exception->Dump();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003946 result_value = 0;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003947 } else if (is_object_result) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003948 /* if no exception was thrown, examine object result more closely */
Sebastien Hertz1558b572015-02-25 15:05:59 +01003949 JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003950 if (new_tag != result_tag) {
3951 VLOG(jdwp) << " JDWP promoted result from " << result_tag << " to " << new_tag;
3952 result_tag = new_tag;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003953 }
3954
Sebastien Hertz1558b572015-02-25 15:05:59 +01003955 // Register the object in the registry and reference its ObjectId. This ensures
3956 // GC safety and prevents from accessing stale reference if the object is moved.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003957 result_value = gRegistry->Add(object_result.Get());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003958 } else {
3959 // Primitive result.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003960 DCHECK(IsPrimitiveTag(result_tag));
3961 result_value = result.GetJ();
3962 }
3963 const bool is_constructor = m->IsConstructor() && !m->IsStatic();
3964 if (is_constructor) {
3965 // If we invoked a constructor (which actually returns void), return the receiver,
3966 // unless we threw, in which case we return null.
3967 result_tag = JDWP::JT_OBJECT;
3968 if (exceptionObjectId == 0) {
3969 // TODO we could keep the receiver ObjectId in the DebugInvokeReq to avoid looking into the
3970 // object registry.
3971 result_value = GetObjectRegistry()->Add(pReq->receiver.Read());
3972 } else {
3973 result_value = 0;
3974 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08003975 }
3976
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003977 // Suspend other threads if the invoke is not single-threaded.
3978 if ((pReq->options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
3979 soa.Self()->TransitionFromRunnableToSuspended(kWaitingForDebuggerSuspension);
3980 VLOG(jdwp) << " Suspending all threads";
3981 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
3982 soa.Self()->TransitionFromSuspendedToRunnable();
3983 }
3984
3985 VLOG(jdwp) << " --> returned " << result_tag
3986 << StringPrintf(" %#" PRIx64 " (except=%#" PRIx64 ")", result_value,
3987 exceptionObjectId);
3988
3989 // Show detailed debug output.
3990 if (result_tag == JDWP::JT_STRING && exceptionObjectId == 0) {
3991 if (result_value != 0) {
3992 if (VLOG_IS_ON(jdwp)) {
3993 std::string result_string;
3994 JDWP::JdwpError error = Dbg::StringToUtf8(result_value, &result_string);
3995 CHECK_EQ(error, JDWP::ERR_NONE);
3996 VLOG(jdwp) << " string '" << result_string << "'";
3997 }
3998 } else {
3999 VLOG(jdwp) << " string (null)";
4000 }
4001 }
4002
4003 // Attach the reply to DebugInvokeReq so it can be sent to the debugger when the event thread
4004 // is ready to suspend.
4005 BuildInvokeReply(pReq->reply, pReq->request_id, result_tag, result_value, exceptionObjectId);
4006}
4007
4008void Dbg::BuildInvokeReply(JDWP::ExpandBuf* pReply, uint32_t request_id, JDWP::JdwpTag result_tag,
4009 uint64_t result_value, JDWP::ObjectId exception) {
4010 // Make room for the JDWP header since we do not know the size of the reply yet.
4011 JDWP::expandBufAddSpace(pReply, kJDWPHeaderLen);
4012
4013 size_t width = GetTagWidth(result_tag);
4014 JDWP::expandBufAdd1(pReply, result_tag);
4015 if (width != 0) {
4016 WriteValue(pReply, width, result_value);
4017 }
4018 JDWP::expandBufAdd1(pReply, JDWP::JT_OBJECT);
4019 JDWP::expandBufAddObjectId(pReply, exception);
4020
4021 // Now we know the size, we can complete the JDWP header.
4022 uint8_t* buf = expandBufGetBuffer(pReply);
4023 JDWP::Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReply));
4024 JDWP::Set4BE(buf + kJDWPHeaderIdOffset, request_id);
4025 JDWP::Set1(buf + kJDWPHeaderFlagsOffset, kJDWPFlagReply); // flags
4026 JDWP::Set2BE(buf + kJDWPHeaderErrorCodeOffset, JDWP::ERR_NONE);
4027}
4028
4029void Dbg::FinishInvokeMethod(DebugInvokeReq* pReq) {
4030 CHECK_NE(Thread::Current(), GetDebugThread()) << "This must be called by the event thread";
4031
4032 JDWP::ExpandBuf* const pReply = pReq->reply;
4033 CHECK(pReply != nullptr) << "No reply attached to DebugInvokeReq";
4034
4035 // We need to prevent other threads (including JDWP thread) from interacting with the debugger
4036 // while we send the reply but are not yet suspended. The JDWP token will be released just before
4037 // we suspend ourself again (see ThreadList::SuspendSelfForDebugger).
4038 gJdwpState->AcquireJdwpTokenForEvent(pReq->thread_id);
4039
4040 // Send the reply unless the debugger detached before the completion of the method.
4041 if (IsDebuggerActive()) {
4042 const size_t replyDataLength = expandBufGetLength(pReply) - kJDWPHeaderLen;
4043 VLOG(jdwp) << StringPrintf("REPLY INVOKE id=0x%06x (length=%zu)",
4044 pReq->request_id, replyDataLength);
4045
4046 gJdwpState->SendRequest(pReply);
4047 } else {
4048 VLOG(jdwp) << "Not sending invoke reply because debugger detached";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004049 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004050}
4051
Elliott Hughesd07986f2011-12-06 18:27:45 -08004052/*
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004053 * "request" contains a full JDWP packet, possibly with multiple chunks. We
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004054 * need to process each, accumulate the replies, and ship the whole thing
4055 * back.
4056 *
4057 * Returns "true" if we have a reply. The reply buffer is newly allocated,
4058 * and includes the chunk type/length, followed by the data.
4059 *
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08004060 * OLD-TODO: we currently assume that the request and reply include a single
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004061 * chunk. If this becomes inconvenient we will need to adapt.
4062 */
Ian Rogersc0542af2014-09-03 16:16:56 -07004063bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004064 Thread* self = Thread::Current();
4065 JNIEnv* env = self->GetJniEnv();
4066
Ian Rogersc0542af2014-09-03 16:16:56 -07004067 uint32_t type = request->ReadUnsigned32("type");
4068 uint32_t length = request->ReadUnsigned32("length");
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004069
4070 // Create a byte[] corresponding to 'request'.
Ian Rogersc0542af2014-09-03 16:16:56 -07004071 size_t request_length = request->size();
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004072 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(request_length));
Ian Rogersc0542af2014-09-03 16:16:56 -07004073 if (dataArray.get() == nullptr) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004074 LOG(WARNING) << "byte[] allocation failed: " << request_length;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004075 env->ExceptionClear();
4076 return false;
4077 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004078 env->SetByteArrayRegion(dataArray.get(), 0, request_length,
4079 reinterpret_cast<const jbyte*>(request->data()));
4080 request->Skip(request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004081
4082 // Run through and find all chunks. [Currently just find the first.]
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004083 ScopedByteArrayRO contents(env, dataArray.get());
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004084 if (length != request_length) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08004085 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004086 return false;
4087 }
4088
4089 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
Elliott Hugheseac76672012-05-24 21:56:51 -07004090 ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4091 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004092 type, dataArray.get(), 0, length));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004093 if (env->ExceptionCheck()) {
4094 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
4095 env->ExceptionDescribe();
4096 env->ExceptionClear();
4097 return false;
4098 }
4099
Ian Rogersc0542af2014-09-03 16:16:56 -07004100 if (chunk.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004101 return false;
4102 }
4103
4104 /*
4105 * Pull the pieces out of the chunk. We copy the results into a
4106 * newly-allocated buffer that the caller can free. We don't want to
4107 * continue using the Chunk object because nothing has a reference to it.
4108 *
4109 * We could avoid this by returning type/data/offset/length and having
4110 * the caller be aware of the object lifetime issues, but that
Elliott Hughes81ff3182012-03-23 20:35:56 -07004111 * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004112 * if we have responses for multiple chunks.
4113 *
4114 * So we're pretty much stuck with copying data around multiple times.
4115 */
Elliott Hugheseac76672012-05-24 21:56:51 -07004116 ScopedLocalRef<jbyteArray> replyData(env, reinterpret_cast<jbyteArray>(env->GetObjectField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_data)));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004117 jint offset = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
Elliott Hugheseac76672012-05-24 21:56:51 -07004118 length = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
Elliott Hugheseac76672012-05-24 21:56:51 -07004119 type = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004120
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004121 VLOG(jdwp) << StringPrintf("DDM reply: type=0x%08x data=%p offset=%d length=%d", type, replyData.get(), offset, length);
Ian Rogersc0542af2014-09-03 16:16:56 -07004122 if (length == 0 || replyData.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004123 return false;
4124 }
4125
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004126 const int kChunkHdrLen = 8;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004127 uint8_t* reply = new uint8_t[length + kChunkHdrLen];
Ian Rogersc0542af2014-09-03 16:16:56 -07004128 if (reply == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004129 LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
4130 return false;
4131 }
Elliott Hughesf7c3b662011-10-27 12:04:56 -07004132 JDWP::Set4BE(reply + 0, type);
4133 JDWP::Set4BE(reply + 4, length);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004134 env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004135
4136 *pReplyBuf = reply;
4137 *pReplyLen = length + kChunkHdrLen;
4138
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004139 VLOG(jdwp) << StringPrintf("dvmHandleDdm returning type=%.4s %p len=%d", reinterpret_cast<char*>(reply), reply, length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004140 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004141}
4142
Elliott Hughesa2155262011-11-16 16:26:58 -08004143void Dbg::DdmBroadcast(bool connect) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004144 VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
Elliott Hughes47fce012011-10-25 18:37:19 -07004145
4146 Thread* self = Thread::Current();
Ian Rogers50b35e22012-10-04 10:09:15 -07004147 if (self->GetState() != kRunnable) {
4148 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4149 /* try anyway? */
Elliott Hughes47fce012011-10-25 18:37:19 -07004150 }
4151
4152 JNIEnv* env = self->GetJniEnv();
Elliott Hughes47fce012011-10-25 18:37:19 -07004153 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
Elliott Hugheseac76672012-05-24 21:56:51 -07004154 env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4155 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4156 event);
Elliott Hughes47fce012011-10-25 18:37:19 -07004157 if (env->ExceptionCheck()) {
4158 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4159 env->ExceptionDescribe();
4160 env->ExceptionClear();
4161 }
4162}
4163
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004164void Dbg::DdmConnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004165 Dbg::DdmBroadcast(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004166}
4167
4168void Dbg::DdmDisconnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004169 Dbg::DdmBroadcast(false);
Elliott Hughes47fce012011-10-25 18:37:19 -07004170 gDdmThreadNotification = false;
4171}
4172
4173/*
Elliott Hughes82188472011-11-07 18:11:48 -08004174 * Send a notification when a thread starts, stops, or changes its name.
Elliott Hughes47fce012011-10-25 18:37:19 -07004175 *
4176 * Because we broadcast the full set of threads when the notifications are
4177 * first enabled, it's possible for "thread" to be actively executing.
4178 */
Elliott Hughes82188472011-11-07 18:11:48 -08004179void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004180 if (!gDdmThreadNotification) {
4181 return;
4182 }
4183
Elliott Hughes82188472011-11-07 18:11:48 -08004184 if (type == CHUNK_TYPE("THDE")) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004185 uint8_t buf[4];
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004186 JDWP::Set4BE(&buf[0], t->GetThreadId());
Elliott Hughes47fce012011-10-25 18:37:19 -07004187 Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
Elliott Hughes82188472011-11-07 18:11:48 -08004188 } else {
4189 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004190 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07004191 StackHandleScope<1> hs(soa.Self());
4192 Handle<mirror::String> name(hs.NewHandle(t->GetThreadName(soa)));
Ian Rogersc0542af2014-09-03 16:16:56 -07004193 size_t char_count = (name.Get() != nullptr) ? name->GetLength() : 0;
Jeff Hao848f70a2014-01-15 13:49:50 -08004194 const jchar* chars = (name.Get() != nullptr) ? name->GetValue() : nullptr;
Elliott Hughes82188472011-11-07 18:11:48 -08004195
Elliott Hughes21f32d72011-11-09 17:44:13 -08004196 std::vector<uint8_t> bytes;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004197 JDWP::Append4BE(bytes, t->GetThreadId());
Elliott Hughes545a0642011-11-08 19:10:03 -08004198 JDWP::AppendUtf16BE(bytes, chars, char_count);
Elliott Hughes21f32d72011-11-09 17:44:13 -08004199 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
4200 Dbg::DdmSendChunk(type, bytes);
Elliott Hughes47fce012011-10-25 18:37:19 -07004201 }
4202}
4203
Elliott Hughes47fce012011-10-25 18:37:19 -07004204void Dbg::DdmSetThreadNotification(bool enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004205 // Enable/disable thread notifications.
Elliott Hughes47fce012011-10-25 18:37:19 -07004206 gDdmThreadNotification = enable;
4207 if (enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004208 // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4209 // see a suspension in progress and block until that ends. They then post their own start
4210 // notification.
4211 SuspendVM();
4212 std::list<Thread*> threads;
Ian Rogers50b35e22012-10-04 10:09:15 -07004213 Thread* self = Thread::Current();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004214 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004215 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004216 threads = Runtime::Current()->GetThreadList()->GetList();
4217 }
4218 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004219 ScopedObjectAccess soa(self);
Mathieu Chartier02e25112013-08-14 16:14:24 -07004220 for (Thread* thread : threads) {
4221 Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004222 }
4223 }
4224 ResumeVM();
Elliott Hughes47fce012011-10-25 18:37:19 -07004225 }
4226}
4227
Elliott Hughesa2155262011-11-16 16:26:58 -08004228void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07004229 if (IsDebuggerActive()) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02004230 gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004231 }
Elliott Hughes82188472011-11-07 18:11:48 -08004232 Dbg::DdmSendThreadNotification(t, type);
Elliott Hughes47fce012011-10-25 18:37:19 -07004233}
4234
4235void Dbg::PostThreadStart(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004236 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004237}
4238
4239void Dbg::PostThreadDeath(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004240 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004241}
4242
Elliott Hughes82188472011-11-07 18:11:48 -08004243void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004244 CHECK(buf != nullptr);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004245 iovec vec[1];
4246 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
4247 vec[0].iov_len = byte_count;
4248 Dbg::DdmSendChunkV(type, vec, 1);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004249}
4250
Elliott Hughes21f32d72011-11-09 17:44:13 -08004251void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
4252 DdmSendChunk(type, bytes.size(), &bytes[0]);
4253}
4254
Brian Carlstromf5293522013-07-19 00:24:00 -07004255void Dbg::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004256 if (gJdwpState == nullptr) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004257 VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
Elliott Hughes3bb81562011-10-21 18:52:59 -07004258 } else {
Elliott Hughescccd84f2011-12-05 16:51:54 -08004259 gJdwpState->DdmSendChunkV(type, iov, iov_count);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004260 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004261}
4262
Mathieu Chartierad466ad2015-01-08 16:28:08 -08004263JDWP::JdwpState* Dbg::GetJdwpState() {
4264 return gJdwpState;
4265}
4266
Elliott Hughes767a1472011-10-26 18:49:02 -07004267int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4268 if (when == HPIF_WHEN_NOW) {
Elliott Hughes7162ad92011-10-27 14:08:42 -07004269 DdmSendHeapInfo(when);
Elliott Hughes767a1472011-10-26 18:49:02 -07004270 return true;
4271 }
4272
4273 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4274 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4275 return false;
4276 }
4277
4278 gDdmHpifWhen = when;
4279 return true;
4280}
4281
4282bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4283 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4284 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4285 return false;
4286 }
4287
4288 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4289 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4290 return false;
4291 }
4292
4293 if (native) {
4294 gDdmNhsgWhen = when;
4295 gDdmNhsgWhat = what;
4296 } else {
4297 gDdmHpsgWhen = when;
4298 gDdmHpsgWhat = what;
4299 }
4300 return true;
4301}
4302
Elliott Hughes7162ad92011-10-27 14:08:42 -07004303void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4304 // If there's a one-shot 'when', reset it.
4305 if (reason == gDdmHpifWhen) {
4306 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4307 gDdmHpifWhen = HPIF_WHEN_NEVER;
4308 }
4309 }
4310
4311 /*
4312 * Chunk HPIF (client --> server)
4313 *
4314 * Heap Info. General information about the heap,
4315 * suitable for a summary display.
4316 *
4317 * [u4]: number of heaps
4318 *
4319 * For each heap:
4320 * [u4]: heap ID
4321 * [u8]: timestamp in ms since Unix epoch
4322 * [u1]: capture reason (same as 'when' value from server)
4323 * [u4]: max heap size in bytes (-Xmx)
4324 * [u4]: current heap size in bytes
4325 * [u4]: current number of bytes allocated
4326 * [u4]: current number of objects allocated
4327 */
4328 uint8_t heap_count = 1;
Ian Rogers1d54e732013-05-02 21:10:01 -07004329 gc::Heap* heap = Runtime::Current()->GetHeap();
Elliott Hughes21f32d72011-11-09 17:44:13 -08004330 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08004331 JDWP::Append4BE(bytes, heap_count);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004332 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
Elliott Hughes545a0642011-11-08 19:10:03 -08004333 JDWP::Append8BE(bytes, MilliTime());
4334 JDWP::Append1BE(bytes, reason);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004335 JDWP::Append4BE(bytes, heap->GetMaxMemory()); // Max allowed heap size in bytes.
4336 JDWP::Append4BE(bytes, heap->GetTotalMemory()); // Current heap size in bytes.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -08004337 JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4338 JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
Elliott Hughes21f32d72011-11-09 17:44:13 -08004339 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
4340 Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
Elliott Hughes767a1472011-10-26 18:49:02 -07004341}
4342
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004343enum HpsgSolidity {
4344 SOLIDITY_FREE = 0,
4345 SOLIDITY_HARD = 1,
4346 SOLIDITY_SOFT = 2,
4347 SOLIDITY_WEAK = 3,
4348 SOLIDITY_PHANTOM = 4,
4349 SOLIDITY_FINALIZABLE = 5,
4350 SOLIDITY_SWEEP = 6,
4351};
4352
4353enum HpsgKind {
4354 KIND_OBJECT = 0,
4355 KIND_CLASS_OBJECT = 1,
4356 KIND_ARRAY_1 = 2,
4357 KIND_ARRAY_2 = 3,
4358 KIND_ARRAY_4 = 4,
4359 KIND_ARRAY_8 = 5,
4360 KIND_UNKNOWN = 6,
4361 KIND_NATIVE = 7,
4362};
4363
4364#define HPSG_PARTIAL (1<<7)
4365#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4366
Ian Rogers30fab402012-01-23 15:43:46 -08004367class HeapChunkContext {
4368 public:
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004369 // Maximum chunk size. Obtain this from the formula:
4370 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4371 HeapChunkContext(bool merge, bool native)
Ian Rogers30fab402012-01-23 15:43:46 -08004372 : buf_(16384 - 16),
4373 type_(0),
Mathieu Chartier36dab362014-07-30 14:59:56 -07004374 chunk_overhead_(0) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004375 Reset();
4376 if (native) {
Ian Rogers30fab402012-01-23 15:43:46 -08004377 type_ = CHUNK_TYPE("NHSG");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004378 } else {
Ian Rogers30fab402012-01-23 15:43:46 -08004379 type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004380 }
4381 }
4382
4383 ~HeapChunkContext() {
Ian Rogers30fab402012-01-23 15:43:46 -08004384 if (p_ > &buf_[0]) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004385 Flush();
4386 }
4387 }
4388
Mathieu Chartier36dab362014-07-30 14:59:56 -07004389 void SetChunkOverhead(size_t chunk_overhead) {
4390 chunk_overhead_ = chunk_overhead;
4391 }
4392
4393 void ResetStartOfNextChunk() {
4394 startOfNextMemoryChunk_ = nullptr;
4395 }
4396
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004397 void EnsureHeader(const void* chunk_ptr) {
Ian Rogers30fab402012-01-23 15:43:46 -08004398 if (!needHeader_) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004399 return;
4400 }
4401
4402 // Start a new HPSx chunk.
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004403 JDWP::Write4BE(&p_, 1); // Heap id (bogus; we only have one heap).
4404 JDWP::Write1BE(&p_, 8); // Size of allocation unit, in bytes.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004405
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004406 JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
4407 JDWP::Write4BE(&p_, 0); // offset of this piece (relative to the virtual address).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004408 // [u4]: length of piece, in allocation units
4409 // 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 -08004410 pieceLenField_ = p_;
4411 JDWP::Write4BE(&p_, 0x55555555);
4412 needHeader_ = false;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004413 }
4414
Mathieu Chartier90443472015-07-16 20:32:27 -07004415 void Flush() SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004416 if (pieceLenField_ == nullptr) {
Ian Rogersd636b062013-01-18 17:51:18 -08004417 // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4418 CHECK(needHeader_);
4419 return;
4420 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004421 // Patch the "length of piece" field.
Ian Rogers30fab402012-01-23 15:43:46 -08004422 CHECK_LE(&buf_[0], pieceLenField_);
4423 CHECK_LE(pieceLenField_, p_);
4424 JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004425
Ian Rogers30fab402012-01-23 15:43:46 -08004426 Dbg::DdmSendChunk(type_, p_ - &buf_[0], &buf_[0]);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004427 Reset();
4428 }
4429
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004430 static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -07004431 SHARED_REQUIRES(Locks::heap_bitmap_lock_,
Ian Rogersb726dcb2012-09-05 08:57:23 -07004432 Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004433 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4434 }
4435
4436 static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -07004437 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004438 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
Elliott Hughesa2155262011-11-16 16:26:58 -08004439 }
4440
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004441 private:
Elliott Hughesa2155262011-11-16 16:26:58 -08004442 enum { ALLOCATION_UNIT_SIZE = 8 };
4443
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004444 void Reset() {
Ian Rogers30fab402012-01-23 15:43:46 -08004445 p_ = &buf_[0];
Mathieu Chartier36dab362014-07-30 14:59:56 -07004446 ResetStartOfNextChunk();
Ian Rogers30fab402012-01-23 15:43:46 -08004447 totalAllocationUnits_ = 0;
4448 needHeader_ = true;
Ian Rogersc0542af2014-09-03 16:16:56 -07004449 pieceLenField_ = nullptr;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004450 }
4451
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004452 bool IsNative() const {
4453 return type_ == CHUNK_TYPE("NHSG");
4454 }
4455
4456 // Returns true if the object is not an empty chunk.
Mathieu Chartier90443472015-07-16 20:32:27 -07004457 bool ProcessRecord(void* start, size_t used_bytes) SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers30fab402012-01-23 15:43:46 -08004458 // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4459 // in the following code not to allocate memory, by ensuring buf_ is of the correct size
Ian Rogers15bf2d32012-08-28 17:33:04 -07004460 if (used_bytes == 0) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004461 if (start == nullptr) {
4462 // Reset for start of new heap.
4463 startOfNextMemoryChunk_ = nullptr;
4464 Flush();
4465 }
4466 // Only process in use memory so that free region information
4467 // also includes dlmalloc book keeping.
4468 return false;
Elliott Hughesa2155262011-11-16 16:26:58 -08004469 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004470 if (startOfNextMemoryChunk_ != nullptr) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004471 // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4472 // of the use of mmaps, so don't report. If not free memory then start a new segment.
4473 bool flush = true;
4474 if (start > startOfNextMemoryChunk_) {
4475 const size_t kMaxFreeLen = 2 * kPageSize;
4476 void* free_start = startOfNextMemoryChunk_;
4477 void* free_end = start;
4478 const size_t free_len =
4479 reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4480 if (!IsNative() || free_len < kMaxFreeLen) {
4481 AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4482 flush = false;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004483 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004484 }
4485 if (flush) {
4486 startOfNextMemoryChunk_ = nullptr;
4487 Flush();
4488 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004489 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004490 return true;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004491 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004492
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004493 void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
Mathieu Chartier90443472015-07-16 20:32:27 -07004494 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004495 if (ProcessRecord(start, used_bytes)) {
4496 uint8_t state = ExamineNativeObject(start);
4497 AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4498 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4499 }
4500 }
4501
4502 void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
Mathieu Chartier90443472015-07-16 20:32:27 -07004503 SHARED_REQUIRES(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004504 if (ProcessRecord(start, used_bytes)) {
4505 // Determine the type of this chunk.
4506 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4507 // If it's the same, we should combine them.
4508 uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4509 AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4510 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4511 }
4512 }
4513
4514 void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
Mathieu Chartier90443472015-07-16 20:32:27 -07004515 SHARED_REQUIRES(Locks::mutator_lock_) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004516 // Make sure there's enough room left in the buffer.
4517 // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4518 // 17 bytes for any header.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004519 const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4520 size_t byte_left = &buf_.back() - p_;
4521 if (byte_left < needed) {
4522 if (is_native) {
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004523 // Cannot trigger memory allocation while walking native heap.
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004524 return;
4525 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004526 Flush();
4527 }
4528
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004529 byte_left = &buf_.back() - p_;
4530 if (byte_left < needed) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004531 LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4532 << needed << " bytes)";
4533 return;
4534 }
4535 EnsureHeader(ptr);
Elliott Hughesa2155262011-11-16 16:26:58 -08004536 // Write out the chunk description.
Ian Rogers15bf2d32012-08-28 17:33:04 -07004537 length /= ALLOCATION_UNIT_SIZE; // Convert to allocation units.
4538 totalAllocationUnits_ += length;
4539 while (length > 256) {
Ian Rogers30fab402012-01-23 15:43:46 -08004540 *p_++ = state | HPSG_PARTIAL;
4541 *p_++ = 255; // length - 1
Ian Rogers15bf2d32012-08-28 17:33:04 -07004542 length -= 256;
Elliott Hughesa2155262011-11-16 16:26:58 -08004543 }
Ian Rogers30fab402012-01-23 15:43:46 -08004544 *p_++ = state;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004545 *p_++ = length - 1;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004546 }
4547
Mathieu Chartier90443472015-07-16 20:32:27 -07004548 uint8_t ExamineNativeObject(const void* p) SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004549 return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4550 }
4551
4552 uint8_t ExamineJavaObject(mirror::Object* o)
Mathieu Chartier90443472015-07-16 20:32:27 -07004553 SHARED_REQUIRES(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004554 if (o == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004555 return HPSG_STATE(SOLIDITY_FREE, 0);
4556 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004557 // It's an allocated chunk. Figure out what it is.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004558 gc::Heap* heap = Runtime::Current()->GetHeap();
4559 if (!heap->IsLiveObjectLocked(o)) {
4560 LOG(ERROR) << "Invalid object in managed heap: " << o;
Elliott Hughesa2155262011-11-16 16:26:58 -08004561 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4562 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08004563 mirror::Class* c = o->GetClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07004564 if (c == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004565 // The object was probably just created but hasn't been initialized yet.
4566 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4567 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004568 if (!heap->IsValidObjectAddress(c)) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004569 LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
Elliott Hughesa2155262011-11-16 16:26:58 -08004570 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4571 }
Mathieu Chartierf26e1b32015-01-29 10:47:10 -08004572 if (c->GetClass() == nullptr) {
4573 LOG(ERROR) << "Null class of class " << c << " for object " << o;
4574 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4575 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004576 if (c->IsClassClass()) {
4577 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4578 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004579 if (c->IsArrayClass()) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004580 switch (c->GetComponentSize()) {
4581 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4582 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4583 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4584 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4585 }
4586 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004587 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4588 }
4589
Ian Rogers30fab402012-01-23 15:43:46 -08004590 std::vector<uint8_t> buf_;
4591 uint8_t* p_;
4592 uint8_t* pieceLenField_;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004593 void* startOfNextMemoryChunk_;
Ian Rogers30fab402012-01-23 15:43:46 -08004594 size_t totalAllocationUnits_;
4595 uint32_t type_;
Ian Rogers30fab402012-01-23 15:43:46 -08004596 bool needHeader_;
Mathieu Chartier36dab362014-07-30 14:59:56 -07004597 size_t chunk_overhead_;
Ian Rogers30fab402012-01-23 15:43:46 -08004598
Elliott Hughesa2155262011-11-16 16:26:58 -08004599 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4600};
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004601
Mathieu Chartier36dab362014-07-30 14:59:56 -07004602static void BumpPointerSpaceCallback(mirror::Object* obj, void* arg)
Mathieu Chartier90443472015-07-16 20:32:27 -07004603 SHARED_REQUIRES(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
Mathieu Chartier36dab362014-07-30 14:59:56 -07004604 const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004605 HeapChunkContext::HeapChunkJavaCallback(
Mathieu Chartier36dab362014-07-30 14:59:56 -07004606 obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, arg);
4607}
4608
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004609void Dbg::DdmSendHeapSegments(bool native) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004610 Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4611 Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004612 if (when == HPSG_WHEN_NEVER) {
4613 return;
4614 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004615 // Figure out what kind of chunks we'll be sending.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004616 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4617 << static_cast<int>(what);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004618
4619 // First, send a heap start chunk.
4620 uint8_t heap_id[4];
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004621 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004622 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004623 Thread* self = Thread::Current();
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004624 Locks::mutator_lock_->AssertSharedHeld(self);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004625
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004626 // Send a series of heap segment chunks.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004627 HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
Elliott Hughesa2155262011-11-16 16:26:58 -08004628 if (native) {
Andreas Gampec60e1b72015-07-30 08:57:50 -07004629#if defined(__ANDROID__) && defined(USE_DLMALLOC)
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004630 dlmalloc_inspect_all(HeapChunkContext::HeapChunkNativeCallback, &context);
4631 HeapChunkContext::HeapChunkNativeCallback(nullptr, nullptr, 0, &context); // Indicate end of a space.
Christopher Ferrisc4ddc042014-05-13 14:47:50 -07004632#else
4633 UNIMPLEMENTED(WARNING) << "Native heap inspection is only supported with dlmalloc";
4634#endif
Elliott Hughesa2155262011-11-16 16:26:58 -08004635 } else {
Ian Rogers1d54e732013-05-02 21:10:01 -07004636 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004637 for (const auto& space : heap->GetContinuousSpaces()) {
4638 if (space->IsDlMallocSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004639 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004640 // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4641 // allocation then the first sizeof(size_t) may belong to it.
4642 context.SetChunkOverhead(sizeof(size_t));
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004643 space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004644 } else if (space->IsRosAllocSpace()) {
4645 context.SetChunkOverhead(0);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004646 // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4647 // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
4648 self->TransitionFromRunnableToSuspended(kSuspended);
4649 ThreadList* tl = Runtime::Current()->GetThreadList();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -07004650 tl->SuspendAll(__FUNCTION__);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004651 {
4652 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004653 space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004654 }
4655 tl->ResumeAll();
4656 self->TransitionFromSuspendedToRunnable();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004657 } else if (space->IsBumpPointerSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004658 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004659 context.SetChunkOverhead(0);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004660 space->AsBumpPointerSpace()->Walk(BumpPointerSpaceCallback, &context);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004661 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004662 } else if (space->IsRegionSpace()) {
4663 heap->IncrementDisableMovingGC(self);
4664 self->TransitionFromRunnableToSuspended(kSuspended);
4665 ThreadList* tl = Runtime::Current()->GetThreadList();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -07004666 tl->SuspendAll(__FUNCTION__);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004667 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4668 context.SetChunkOverhead(0);
4669 space->AsRegionSpace()->Walk(BumpPointerSpaceCallback, &context);
4670 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
4671 tl->ResumeAll();
4672 self->TransitionFromSuspendedToRunnable();
4673 heap->DecrementDisableMovingGC(self);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004674 } else {
4675 UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004676 }
Mathieu Chartier36dab362014-07-30 14:59:56 -07004677 context.ResetStartOfNextChunk();
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004678 }
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004679 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartiere0f0cb32012-08-28 11:26:00 -07004680 // Walk the large objects, these are not in the AllocSpace.
Mathieu Chartier36dab362014-07-30 14:59:56 -07004681 context.SetChunkOverhead(0);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004682 heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Elliott Hughesa2155262011-11-16 16:26:58 -08004683 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004684
4685 // Finally, send a heap end chunk.
4686 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
Elliott Hughes767a1472011-10-26 18:49:02 -07004687}
4688
Brian Carlstrom306db812014-09-05 13:01:41 -07004689void Dbg::SetAllocTrackingEnabled(bool enable) {
Man Cao8c2ff642015-05-27 17:25:30 -07004690 gc::AllocRecordObjectMap::SetAllocTrackingEnabled(enable);
Elliott Hughes545a0642011-11-08 19:10:03 -08004691}
4692
4693void Dbg::DumpRecentAllocations() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004694 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom306db812014-09-05 13:01:41 -07004695 MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004696 if (!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled()) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004697 LOG(INFO) << "Not recording tracked allocations";
4698 return;
4699 }
Man Cao8c2ff642015-05-27 17:25:30 -07004700 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4701 CHECK(records != nullptr);
Elliott Hughes545a0642011-11-08 19:10:03 -08004702
Man Cao1ed11b92015-06-11 22:47:35 -07004703 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004704 uint16_t count = capped_count;
Elliott Hughes545a0642011-11-08 19:10:03 -08004705
Man Cao8c2ff642015-05-27 17:25:30 -07004706 LOG(INFO) << "Tracked allocations, (count=" << count << ")";
4707 for (auto it = records->RBegin(), end = records->REnd();
4708 count > 0 && it != end; count--, it++) {
4709 const gc::AllocRecord* record = it->second;
Elliott Hughes545a0642011-11-08 19:10:03 -08004710
Man Cao8c2ff642015-05-27 17:25:30 -07004711 LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->GetTid(), record->ByteCount())
Man Cao42c3c332015-06-23 16:38:25 -07004712 << PrettyClass(record->GetClass());
Elliott Hughes545a0642011-11-08 19:10:03 -08004713
Man Cao8c2ff642015-05-27 17:25:30 -07004714 for (size_t stack_frame = 0, depth = record->GetDepth(); stack_frame < depth; ++stack_frame) {
4715 const gc::AllocRecordStackTraceElement& stack_element = record->StackElement(stack_frame);
4716 ArtMethod* m = stack_element.GetMethod();
4717 LOG(INFO) << " " << PrettyMethod(m) << " line " << stack_element.ComputeLineNumber();
Elliott Hughes545a0642011-11-08 19:10:03 -08004718 }
4719
4720 // pause periodically to help logcat catch up
4721 if ((count % 5) == 0) {
4722 usleep(40000);
4723 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004724 }
4725}
4726
4727class StringTable {
4728 public:
4729 StringTable() {
4730 }
4731
Mathieu Chartier4345c462014-06-27 10:20:14 -07004732 void Add(const std::string& str) {
4733 table_.insert(str);
4734 }
4735
4736 void Add(const char* str) {
4737 table_.insert(str);
Elliott Hughes545a0642011-11-08 19:10:03 -08004738 }
4739
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004740 size_t IndexOf(const char* s) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004741 auto it = table_.find(s);
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004742 if (it == table_.end()) {
4743 LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
4744 }
4745 return std::distance(table_.begin(), it);
Elliott Hughes545a0642011-11-08 19:10:03 -08004746 }
4747
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004748 size_t Size() const {
Elliott Hughes545a0642011-11-08 19:10:03 -08004749 return table_.size();
4750 }
4751
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004752 void WriteTo(std::vector<uint8_t>& bytes) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004753 for (const std::string& str : table_) {
4754 const char* s = str.c_str();
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004755 size_t s_len = CountModifiedUtf8Chars(s);
Christopher Ferris8a354052015-04-24 17:23:53 -07004756 std::unique_ptr<uint16_t[]> s_utf16(new uint16_t[s_len]);
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004757 ConvertModifiedUtf8ToUtf16(s_utf16.get(), s);
4758 JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
Elliott Hughes545a0642011-11-08 19:10:03 -08004759 }
4760 }
4761
4762 private:
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004763 std::set<std::string> table_;
Elliott Hughes545a0642011-11-08 19:10:03 -08004764 DISALLOW_COPY_AND_ASSIGN(StringTable);
4765};
4766
Mathieu Chartiere401d142015-04-22 13:56:20 -07004767static const char* GetMethodSourceFile(ArtMethod* method)
Mathieu Chartier90443472015-07-16 20:32:27 -07004768 SHARED_REQUIRES(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004769 DCHECK(method != nullptr);
4770 const char* source_file = method->GetDeclaringClassSourceFile();
Sebastien Hertz280286a2014-04-28 09:26:50 +02004771 return (source_file != nullptr) ? source_file : "";
4772}
4773
Elliott Hughes545a0642011-11-08 19:10:03 -08004774/*
4775 * The data we send to DDMS contains everything we have recorded.
4776 *
4777 * Message header (all values big-endian):
4778 * (1b) message header len (to allow future expansion); includes itself
4779 * (1b) entry header len
4780 * (1b) stack frame len
4781 * (2b) number of entries
4782 * (4b) offset to string table from start of message
4783 * (2b) number of class name strings
4784 * (2b) number of method name strings
4785 * (2b) number of source file name strings
4786 * For each entry:
4787 * (4b) total allocation size
Elliott Hughes221229c2013-01-08 18:17:50 -08004788 * (2b) thread id
Elliott Hughes545a0642011-11-08 19:10:03 -08004789 * (2b) allocated object's class name index
4790 * (1b) stack depth
4791 * For each stack frame:
4792 * (2b) method's class name
4793 * (2b) method name
4794 * (2b) method source file
4795 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
4796 * (xb) class name strings
4797 * (xb) method name strings
4798 * (xb) source file strings
4799 *
4800 * As with other DDM traffic, strings are sent as a 4-byte length
4801 * followed by UTF-16 data.
4802 *
4803 * We send up 16-bit unsigned indexes into string tables. In theory there
Brian Carlstrom306db812014-09-05 13:01:41 -07004804 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
Elliott Hughes545a0642011-11-08 19:10:03 -08004805 * each table, but in practice there should be far fewer.
4806 *
4807 * The chief reason for using a string table here is to keep the size of
4808 * the DDMS message to a minimum. This is partly to make the protocol
4809 * efficient, but also because we have to form the whole thing up all at
4810 * once in a memory buffer.
4811 *
4812 * We use separate string tables for class names, method names, and source
4813 * files to keep the indexes small. There will generally be no overlap
4814 * between the contents of these tables.
4815 */
4816jbyteArray Dbg::GetRecentAllocations() {
Ian Rogerscf7f1912014-10-22 22:06:39 -07004817 if ((false)) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004818 DumpRecentAllocations();
4819 }
4820
Ian Rogers50b35e22012-10-04 10:09:15 -07004821 Thread* self = Thread::Current();
Elliott Hughes545a0642011-11-08 19:10:03 -08004822 std::vector<uint8_t> bytes;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004823 {
Brian Carlstrom306db812014-09-05 13:01:41 -07004824 MutexLock mu(self, *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004825 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4826 // In case this method is called when allocation tracker is disabled,
4827 // we should still send some data back.
4828 gc::AllocRecordObjectMap dummy;
4829 if (records == nullptr) {
4830 CHECK(!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled());
4831 records = &dummy;
4832 }
Man Cao41656de2015-07-06 18:53:15 -07004833 // We don't need to wait on the condition variable records->new_record_condition_, because this
4834 // function only reads the class objects, which are already marked so it doesn't change their
4835 // reachability.
Man Cao8c2ff642015-05-27 17:25:30 -07004836
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004837 //
4838 // Part 1: generate string tables.
4839 //
4840 StringTable class_names;
4841 StringTable method_names;
4842 StringTable filenames;
Elliott Hughes545a0642011-11-08 19:10:03 -08004843
Man Cao1ed11b92015-06-11 22:47:35 -07004844 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004845 uint16_t count = capped_count;
Man Cao8c2ff642015-05-27 17:25:30 -07004846 for (auto it = records->RBegin(), end = records->REnd();
4847 count > 0 && it != end; count--, it++) {
4848 const gc::AllocRecord* record = it->second;
Ian Rogers1ff3c982014-08-12 02:30:58 -07004849 std::string temp;
Man Cao41656de2015-07-06 18:53:15 -07004850 class_names.Add(record->GetClassDescriptor(&temp));
Man Cao8c2ff642015-05-27 17:25:30 -07004851 for (size_t i = 0, depth = record->GetDepth(); i < depth; i++) {
4852 ArtMethod* m = record->StackElement(i).GetMethod();
4853 class_names.Add(m->GetDeclaringClassDescriptor());
4854 method_names.Add(m->GetName());
4855 filenames.Add(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004856 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004857 }
4858
Man Cao8c2ff642015-05-27 17:25:30 -07004859 LOG(INFO) << "recent allocation records: " << capped_count;
4860 LOG(INFO) << "allocation records all objects: " << records->Size();
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004861
4862 //
4863 // Part 2: Generate the output and store it in the buffer.
4864 //
4865
4866 // (1b) message header len (to allow future expansion); includes itself
4867 // (1b) entry header len
4868 // (1b) stack frame len
4869 const int kMessageHeaderLen = 15;
4870 const int kEntryHeaderLen = 9;
4871 const int kStackFrameLen = 8;
4872 JDWP::Append1BE(bytes, kMessageHeaderLen);
4873 JDWP::Append1BE(bytes, kEntryHeaderLen);
4874 JDWP::Append1BE(bytes, kStackFrameLen);
4875
4876 // (2b) number of entries
4877 // (4b) offset to string table from start of message
4878 // (2b) number of class name strings
4879 // (2b) number of method name strings
4880 // (2b) number of source file name strings
Brian Carlstrom306db812014-09-05 13:01:41 -07004881 JDWP::Append2BE(bytes, capped_count);
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004882 size_t string_table_offset = bytes.size();
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004883 JDWP::Append4BE(bytes, 0); // We'll patch this later...
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004884 JDWP::Append2BE(bytes, class_names.Size());
4885 JDWP::Append2BE(bytes, method_names.Size());
4886 JDWP::Append2BE(bytes, filenames.Size());
4887
Ian Rogers1ff3c982014-08-12 02:30:58 -07004888 std::string temp;
Man Cao8c2ff642015-05-27 17:25:30 -07004889 count = capped_count;
4890 // The last "count" number of allocation records in "records" are the most recent "count" number
4891 // of allocations. Reverse iterate to get them. The most recent allocation is sent first.
4892 for (auto it = records->RBegin(), end = records->REnd();
4893 count > 0 && it != end; count--, it++) {
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004894 // For each entry:
4895 // (4b) total allocation size
4896 // (2b) thread id
4897 // (2b) allocated object's class name index
4898 // (1b) stack depth
Man Cao8c2ff642015-05-27 17:25:30 -07004899 const gc::AllocRecord* record = it->second;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004900 size_t stack_depth = record->GetDepth();
Mathieu Chartierf8322842014-05-16 10:59:25 -07004901 size_t allocated_object_class_name_index =
Man Cao41656de2015-07-06 18:53:15 -07004902 class_names.IndexOf(record->GetClassDescriptor(&temp));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07004903 JDWP::Append4BE(bytes, record->ByteCount());
Man Cao8c2ff642015-05-27 17:25:30 -07004904 JDWP::Append2BE(bytes, static_cast<uint16_t>(record->GetTid()));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004905 JDWP::Append2BE(bytes, allocated_object_class_name_index);
4906 JDWP::Append1BE(bytes, stack_depth);
4907
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004908 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
4909 // For each stack frame:
4910 // (2b) method's class name
4911 // (2b) method name
4912 // (2b) method source file
4913 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
Man Cao8c2ff642015-05-27 17:25:30 -07004914 ArtMethod* m = record->StackElement(stack_frame).GetMethod();
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004915 size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
4916 size_t method_name_index = method_names.IndexOf(m->GetName());
4917 size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004918 JDWP::Append2BE(bytes, class_name_index);
4919 JDWP::Append2BE(bytes, method_name_index);
4920 JDWP::Append2BE(bytes, file_name_index);
Man Cao8c2ff642015-05-27 17:25:30 -07004921 JDWP::Append2BE(bytes, record->StackElement(stack_frame).ComputeLineNumber());
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004922 }
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004923 }
4924
4925 // (xb) class name strings
4926 // (xb) method name strings
4927 // (xb) source file strings
4928 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
4929 class_names.WriteTo(bytes);
4930 method_names.WriteTo(bytes);
4931 filenames.WriteTo(bytes);
Elliott Hughes545a0642011-11-08 19:10:03 -08004932 }
Ian Rogers50b35e22012-10-04 10:09:15 -07004933 JNIEnv* env = self->GetJniEnv();
Elliott Hughes545a0642011-11-08 19:10:03 -08004934 jbyteArray result = env->NewByteArray(bytes.size());
Ian Rogersc0542af2014-09-03 16:16:56 -07004935 if (result != nullptr) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004936 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
4937 }
4938 return result;
4939}
4940
Mathieu Chartiere401d142015-04-22 13:56:20 -07004941ArtMethod* DeoptimizationRequest::Method() const {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07004942 ScopedObjectAccessUnchecked soa(Thread::Current());
4943 return soa.DecodeMethod(method_);
4944}
4945
Mathieu Chartiere401d142015-04-22 13:56:20 -07004946void DeoptimizationRequest::SetMethod(ArtMethod* m) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07004947 ScopedObjectAccessUnchecked soa(Thread::Current());
4948 method_ = soa.EncodeMethod(m);
4949}
4950
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004951} // namespace art