blob: eccebf1fc4508aa4642ef906e90e5d147add123b [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)
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -070075 SHARED_LOCKS_REQUIRED(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
84 Breakpoint(const Breakpoint& other) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
85 : 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 Chartiere401d142015-04-22 13:56:20 -070091 ArtMethod* Method() const SHARED_LOCKS_REQUIRED(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)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700114 SHARED_LOCKS_REQUIRED(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)
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200126 OVERRIDE SHARED_LOCKS_REQUIRED(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)
152 OVERRIDE SHARED_LOCKS_REQUIRED(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)
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200169 OVERRIDE SHARED_LOCKS_REQUIRED(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)
177 OVERRIDE SHARED_LOCKS_REQUIRED(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)
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200198 OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
199 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)
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200205 OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
206 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)
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +0200210 OVERRIDE SHARED_LOCKS_REQUIRED(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 Chartiere5f13e52015-02-24 09:37:21 -0800216 OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
217 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)
Sebastien Hertz9d6bf692015-04-10 12:12:33 +0200223 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
224 const DexFile::CodeItem* code_item = method->GetCodeItem();
225 const Instruction* instruction = Instruction::At(&code_item->insns_[dex_pc]);
226 return instruction->IsReturn();
227 }
228
229 static bool IsListeningToDexPcMoved() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
230 return IsListeningTo(instrumentation::Instrumentation::kDexPcMoved);
231 }
232
233 static bool IsListeningToMethodExit() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
234 return IsListeningTo(instrumentation::Instrumentation::kMethodExited);
235 }
236
237 static bool IsListeningTo(instrumentation::Instrumentation::InstrumentationEvent event)
238 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
239 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)
jeffhao09bfc6a2012-12-11 18:11:43 -0800301 LOCKS_EXCLUDED(Locks::breakpoint_lock_)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700302 SHARED_LOCKS_REQUIRED(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)
314 LOCKS_EXCLUDED(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)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700322 SHARED_LOCKS_REQUIRED(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)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700337 SHARED_LOCKS_REQUIRED(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)
Sebastien Hertz69206392015-04-07 15:54:25 +0200353 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
354 LOCKS_EXCLUDED(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)
384 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
385 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)
Ian Rogersb726dcb2012-09-05 08:57:23 -0700391 SHARED_LOCKS_REQUIRED(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)
Elliott Hughes4993bbc2013-01-10 15:41:25 -0800767 SHARED_LOCKS_REQUIRED(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)
784 SHARED_LOCKS_REQUIRED(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
Ian Rogersc0542af2014-09-03 16:16:56 -0700951void Dbg::GetClassList(std::vector<JDWP::RefTypeId>* classes) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800952 // Get the complete list of reference classes (i.e. all classes except
953 // the primitive types).
954 // Returns a newly-allocated buffer full of RefTypeId values.
955 struct ClassListCreator {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800956 explicit ClassListCreator(std::vector<JDWP::RefTypeId>* classes_in) : classes(classes_in) {
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800957 }
958
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800959 static bool Visit(mirror::Class* c, void* arg) {
Elliott Hughesa2155262011-11-16 16:26:58 -0800960 return reinterpret_cast<ClassListCreator*>(arg)->Visit(c);
961 }
962
Elliott Hughes64f574f2013-02-20 14:57:12 -0800963 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
964 // annotalysis.
965 bool Visit(mirror::Class* c) NO_THREAD_SAFETY_ANALYSIS {
Elliott Hughesa2155262011-11-16 16:26:58 -0800966 if (!c->IsPrimitive()) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700967 classes->push_back(gRegistry->AddRefType(c));
Elliott Hughesa2155262011-11-16 16:26:58 -0800968 }
969 return true;
970 }
971
Ian Rogersc0542af2014-09-03 16:16:56 -0700972 std::vector<JDWP::RefTypeId>* const classes;
Elliott Hughesa2155262011-11-16 16:26:58 -0800973 };
974
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800975 ClassListCreator clc(classes);
Sebastien Hertz4537c412014-08-28 14:41:50 +0200976 Runtime::Current()->GetClassLinker()->VisitClassesWithoutClassesLock(ClassListCreator::Visit,
977 &clc);
Elliott Hughes872d4ec2011-10-21 17:07:15 -0700978}
979
Ian Rogers1ff3c982014-08-12 02:30:58 -0700980JDWP::JdwpError Dbg::GetClassInfo(JDWP::RefTypeId class_id, JDWP::JdwpTypeTag* pTypeTag,
981 uint32_t* pStatus, std::string* pDescriptor) {
Ian Rogersc0542af2014-09-03 16:16:56 -0700982 JDWP::JdwpError error;
983 mirror::Class* c = DecodeClass(class_id, &error);
984 if (c == nullptr) {
985 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -0800986 }
987
Elliott Hughesa2155262011-11-16 16:26:58 -0800988 if (c->IsArrayClass()) {
989 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
990 *pTypeTag = JDWP::TT_ARRAY;
991 } else {
992 if (c->IsErroneous()) {
993 *pStatus = JDWP::CS_ERROR;
994 } else {
995 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
996 }
997 *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
998 }
999
Ian Rogersc0542af2014-09-03 16:16:56 -07001000 if (pDescriptor != nullptr) {
Ian Rogers1ff3c982014-08-12 02:30:58 -07001001 std::string temp;
1002 *pDescriptor = c->GetDescriptor(&temp);
Elliott Hughesa2155262011-11-16 16:26:58 -08001003 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001004 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001005}
1006
Ian Rogersc0542af2014-09-03 16:16:56 -07001007void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>* ids) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001008 std::vector<mirror::Class*> classes;
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001009 Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
Ian Rogersc0542af2014-09-03 16:16:56 -07001010 ids->clear();
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001011 for (size_t i = 0; i < classes.size(); ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001012 ids->push_back(gRegistry->Add(classes[i]));
Elliott Hughes6fa602d2011-12-02 17:54:25 -08001013 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001014}
1015
Ian Rogersc0542af2014-09-03 16:16:56 -07001016JDWP::JdwpError Dbg::GetReferenceType(JDWP::ObjectId object_id, JDWP::ExpandBuf* pReply) {
1017 JDWP::JdwpError error;
1018 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1019 if (o == nullptr) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001020 return JDWP::ERR_INVALID_OBJECT;
Elliott Hughes499c5132011-11-17 14:55:11 -08001021 }
Elliott Hughes2435a572012-02-17 16:07:41 -08001022
Sebastien Hertz4d8fd492014-03-28 16:29:41 +01001023 JDWP::JdwpTypeTag type_tag = GetTypeTag(o->GetClass());
Elliott Hughes64f574f2013-02-20 14:57:12 -08001024 JDWP::RefTypeId type_id = gRegistry->AddRefType(o->GetClass());
Elliott Hughes2435a572012-02-17 16:07:41 -08001025
1026 expandBufAdd1(pReply, type_tag);
1027 expandBufAddRefTypeId(pReply, type_id);
1028
1029 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001030}
1031
Ian Rogersfc0e94b2013-09-23 23:51:32 -07001032JDWP::JdwpError Dbg::GetSignature(JDWP::RefTypeId class_id, std::string* signature) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001033 JDWP::JdwpError error;
1034 mirror::Class* c = DecodeClass(class_id, &error);
1035 if (c == nullptr) {
1036 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001037 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001038 std::string temp;
1039 *signature = c->GetDescriptor(&temp);
Elliott Hughes1fe7afb2012-02-13 17:23:03 -08001040 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001041}
1042
Ian Rogersc0542af2014-09-03 16:16:56 -07001043JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1044 JDWP::JdwpError error;
1045 mirror::Class* c = DecodeClass(class_id, &error);
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001046 if (c == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001047 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001048 }
Sebastien Hertz4206eb52014-06-05 10:15:45 +02001049 const char* source_file = c->GetSourceFile();
1050 if (source_file == nullptr) {
Sebastien Hertzb7054ba2014-03-13 11:52:31 +01001051 return JDWP::ERR_ABSENT_INFORMATION;
1052 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001053 *result = source_file;
Elliott Hughes436e3722012-02-17 20:01:47 -08001054 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001055}
1056
Ian Rogersc0542af2014-09-03 16:16:56 -07001057JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
Ian Rogers98379392014-02-24 16:53:16 -08001058 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001059 JDWP::JdwpError error;
1060 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1061 if (error != JDWP::ERR_NONE) {
1062 *tag = JDWP::JT_VOID;
1063 return error;
Elliott Hughes546b9862012-06-20 16:06:13 -07001064 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001065 *tag = TagFromObject(soa, o);
Elliott Hughes546b9862012-06-20 16:06:13 -07001066 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001067}
1068
Elliott Hughesaed4be92011-12-02 16:16:23 -08001069size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001070 switch (tag) {
1071 case JDWP::JT_VOID:
1072 return 0;
1073 case JDWP::JT_BYTE:
1074 case JDWP::JT_BOOLEAN:
1075 return 1;
1076 case JDWP::JT_CHAR:
1077 case JDWP::JT_SHORT:
1078 return 2;
1079 case JDWP::JT_FLOAT:
1080 case JDWP::JT_INT:
1081 return 4;
1082 case JDWP::JT_ARRAY:
1083 case JDWP::JT_OBJECT:
1084 case JDWP::JT_STRING:
1085 case JDWP::JT_THREAD:
1086 case JDWP::JT_THREAD_GROUP:
1087 case JDWP::JT_CLASS_LOADER:
1088 case JDWP::JT_CLASS_OBJECT:
1089 return sizeof(JDWP::ObjectId);
1090 case JDWP::JT_DOUBLE:
1091 case JDWP::JT_LONG:
1092 return 8;
1093 default:
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08001094 LOG(FATAL) << "Unknown tag " << tag;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001095 return -1;
1096 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001097}
1098
Ian Rogersc0542af2014-09-03 16:16:56 -07001099JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1100 JDWP::JdwpError error;
1101 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1102 if (a == nullptr) {
1103 return error;
Elliott Hughes24437992011-11-30 14:49:33 -08001104 }
Ian Rogersc0542af2014-09-03 16:16:56 -07001105 *length = a->GetLength();
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001106 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001107}
1108
Elliott Hughes88d63092013-01-09 09:55:54 -08001109JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001110 JDWP::JdwpError error;
1111 mirror::Array* a = DecodeNonNullArray(array_id, &error);
Ian Rogers98379392014-02-24 16:53:16 -08001112 if (a == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001113 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001114 }
Elliott Hughes24437992011-11-30 14:49:33 -08001115
1116 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1117 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001118 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughes24437992011-11-30 14:49:33 -08001119 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001120 JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1121 expandBufAdd1(pReply, element_tag);
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001122 expandBufAdd4BE(pReply, count);
1123
Ian Rogers1ff3c982014-08-12 02:30:58 -07001124 if (IsPrimitiveTag(element_tag)) {
1125 size_t width = GetTagWidth(element_tag);
Elliott Hughes24437992011-11-30 14:49:33 -08001126 uint8_t* dst = expandBufAddSpace(pReply, count * width);
1127 if (width == 8) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001128 const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001129 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1130 } else if (width == 4) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001131 const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001132 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1133 } else if (width == 2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001134 const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001135 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1136 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001137 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
Elliott Hughes24437992011-11-30 14:49:33 -08001138 memcpy(dst, &src[offset * width], count * width);
1139 }
1140 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001141 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001142 mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
Elliott Hughes24437992011-11-30 14:49:33 -08001143 for (int i = 0; i < count; ++i) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001144 mirror::Object* element = oa->Get(offset + i);
Ian Rogers98379392014-02-24 16:53:16 -08001145 JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
Ian Rogers1ff3c982014-08-12 02:30:58 -07001146 : element_tag;
Elliott Hughes24437992011-11-30 14:49:33 -08001147 expandBufAdd1(pReply, specific_tag);
1148 expandBufAddObjectId(pReply, gRegistry->Add(element));
1149 }
1150 }
1151
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001152 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001153}
1154
Ian Rogersef7d42f2014-01-06 12:55:46 -08001155template <typename T>
Ian Rogersc0542af2014-09-03 16:16:56 -07001156static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
Ian Rogersef7d42f2014-01-06 12:55:46 -08001157 NO_THREAD_SAFETY_ANALYSIS {
1158 // TODO: fix when annotalysis correctly handles non-member functions.
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001159 DCHECK(a->GetClass()->IsPrimitiveArray());
1160
Ian Rogersef7d42f2014-01-06 12:55:46 -08001161 T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001162 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001163 *dst++ = src->ReadValue(sizeof(T));
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001164 }
1165}
1166
Elliott Hughes88d63092013-01-09 09:55:54 -08001167JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
Ian Rogersc0542af2014-09-03 16:16:56 -07001168 JDWP::Request* request) {
1169 JDWP::JdwpError error;
1170 mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1171 if (dst == nullptr) {
1172 return error;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001173 }
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001174
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001175 if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001176 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001177 return JDWP::ERR_INVALID_LENGTH;
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001178 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07001179 JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001180
Ian Rogers1ff3c982014-08-12 02:30:58 -07001181 if (IsPrimitiveTag(element_tag)) {
1182 size_t width = GetTagWidth(element_tag);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001183 if (width == 8) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001184 CopyArrayData<uint64_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001185 } else if (width == 4) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001186 CopyArrayData<uint32_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001187 } else if (width == 2) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001188 CopyArrayData<uint16_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001189 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001190 CopyArrayData<uint8_t>(dst, request, offset, count);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001191 }
1192 } else {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08001193 mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001194 for (int i = 0; i < count; ++i) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001195 JDWP::ObjectId id = request->ReadObjectId();
Ian Rogersc0542af2014-09-03 16:16:56 -07001196 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1197 if (error != JDWP::ERR_NONE) {
1198 return error;
Elliott Hughes436e3722012-02-17 20:01:47 -08001199 }
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +01001200 oa->Set<false>(offset + i, o);
Elliott Hughesf03b8f62011-12-02 14:26:25 -08001201 }
1202 }
1203
Elliott Hughes3d1ca6d2012-02-13 15:43:19 -08001204 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001205}
1206
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001207JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1208 Thread* self = Thread::Current();
1209 mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1210 if (new_string == nullptr) {
1211 DCHECK(self->IsExceptionPending());
1212 self->ClearException();
1213 LOG(ERROR) << "Could not allocate string";
1214 *new_string_id = 0;
1215 return JDWP::ERR_OUT_OF_MEMORY;
1216 }
1217 *new_string_id = gRegistry->Add(new_string);
1218 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001219}
1220
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001221JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001222 JDWP::JdwpError error;
1223 mirror::Class* c = DecodeClass(class_id, &error);
1224 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001225 *new_object_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001226 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001227 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001228 Thread* self = Thread::Current();
1229 mirror::Object* new_object = c->AllocObject(self);
1230 if (new_object == nullptr) {
1231 DCHECK(self->IsExceptionPending());
1232 self->ClearException();
1233 LOG(ERROR) << "Could not allocate object of type " << PrettyDescriptor(c);
1234 *new_object_id = 0;
1235 return JDWP::ERR_OUT_OF_MEMORY;
1236 }
1237 *new_object_id = gRegistry->Add(new_object);
Elliott Hughes436e3722012-02-17 20:01:47 -08001238 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001239}
1240
Elliott Hughesbf13d362011-12-08 15:51:37 -08001241/*
1242 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1243 */
Elliott Hughes88d63092013-01-09 09:55:54 -08001244JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001245 JDWP::ObjectId* new_array_id) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001246 JDWP::JdwpError error;
1247 mirror::Class* c = DecodeClass(array_class_id, &error);
1248 if (c == nullptr) {
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001249 *new_array_id = 0;
Ian Rogersc0542af2014-09-03 16:16:56 -07001250 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001251 }
Sebastien Hertz2c3e77a2015-04-02 16:26:48 +02001252 Thread* self = Thread::Current();
1253 gc::Heap* heap = Runtime::Current()->GetHeap();
1254 mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1255 c->GetComponentSizeShift(),
1256 heap->GetCurrentAllocator());
1257 if (new_array == nullptr) {
1258 DCHECK(self->IsExceptionPending());
1259 self->ClearException();
1260 LOG(ERROR) << "Could not allocate array of type " << PrettyDescriptor(c);
1261 *new_array_id = 0;
1262 return JDWP::ERR_OUT_OF_MEMORY;
1263 }
1264 *new_array_id = gRegistry->Add(new_array);
Elliott Hughes436e3722012-02-17 20:01:47 -08001265 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001266}
1267
Mathieu Chartierc7853442015-03-27 14:35:38 -07001268JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001269 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
Elliott Hughes03181a82011-11-17 17:22:21 -08001270}
1271
Mathieu Chartiere401d142015-04-22 13:56:20 -07001272static JDWP::MethodId ToMethodId(const ArtMethod* m)
Ian Rogersb726dcb2012-09-05 08:57:23 -07001273 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001274 return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(m));
Elliott Hughes03181a82011-11-17 17:22:21 -08001275}
1276
Mathieu Chartierc7853442015-03-27 14:35:38 -07001277static ArtField* FromFieldId(JDWP::FieldId fid)
Ian Rogersb726dcb2012-09-05 08:57:23 -07001278 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001279 return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
Elliott Hughesaed4be92011-12-02 16:16:23 -08001280}
1281
Mathieu Chartiere401d142015-04-22 13:56:20 -07001282static ArtMethod* FromMethodId(JDWP::MethodId mid)
Ian Rogersb726dcb2012-09-05 08:57:23 -07001283 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001284 return reinterpret_cast<ArtMethod*>(static_cast<uintptr_t>(mid));
Elliott Hughes03181a82011-11-17 17:22:21 -08001285}
1286
Sebastien Hertz6995c602014-09-09 12:10:13 +02001287bool Dbg::MatchThread(JDWP::ObjectId expected_thread_id, Thread* event_thread) {
1288 CHECK(event_thread != nullptr);
1289 JDWP::JdwpError error;
Mathieu Chartiere401d142015-04-22 13:56:20 -07001290 mirror::Object* expected_thread_peer = gRegistry->Get<mirror::Object*>(
1291 expected_thread_id, &error);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001292 return expected_thread_peer == event_thread->GetPeer();
1293}
1294
1295bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1296 const JDWP::EventLocation& event_location) {
1297 if (expected_location.dex_pc != event_location.dex_pc) {
1298 return false;
1299 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001300 ArtMethod* m = FromMethodId(expected_location.method_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001301 return m == event_location.method;
1302}
1303
1304bool Dbg::MatchType(mirror::Class* event_class, JDWP::RefTypeId class_id) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001305 if (event_class == nullptr) {
1306 return false;
1307 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02001308 JDWP::JdwpError error;
1309 mirror::Class* expected_class = DecodeClass(class_id, &error);
1310 CHECK(expected_class != nullptr);
1311 return expected_class->IsAssignableFrom(event_class);
1312}
1313
1314bool Dbg::MatchField(JDWP::RefTypeId expected_type_id, JDWP::FieldId expected_field_id,
Mathieu Chartierc7853442015-03-27 14:35:38 -07001315 ArtField* event_field) {
1316 ArtField* expected_field = FromFieldId(expected_field_id);
Sebastien Hertz6995c602014-09-09 12:10:13 +02001317 if (expected_field != event_field) {
1318 return false;
1319 }
1320 return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1321}
1322
1323bool Dbg::MatchInstance(JDWP::ObjectId expected_instance_id, mirror::Object* event_instance) {
1324 JDWP::JdwpError error;
1325 mirror::Object* modifier_instance = gRegistry->Get<mirror::Object*>(expected_instance_id, &error);
1326 return modifier_instance == event_instance;
1327}
1328
Mathieu Chartiere401d142015-04-22 13:56:20 -07001329void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, ArtMethod* m, uint32_t dex_pc)
Sebastien Hertz69206392015-04-07 15:54:25 +02001330 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
1331 LOCKS_EXCLUDED(Locks::thread_list_lock_,
1332 Locks::thread_suspend_count_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001333 if (m == nullptr) {
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001334 memset(location, 0, sizeof(*location));
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001335 } else {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001336 mirror::Class* c = m->GetDeclaringClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07001337 location->type_tag = GetTypeTag(c);
1338 location->class_id = gRegistry->AddRefType(c);
1339 location->method_id = ToMethodId(m);
1340 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08001341 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08001342}
1343
Ian Rogersc0542af2014-09-03 16:16:56 -07001344std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001345 ArtMethod* m = FromMethodId(method_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001346 if (m == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001347 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001348 }
Sebastien Hertz415fd082015-06-01 11:42:27 +02001349 return m->GetInterfaceMethodIfProxy(sizeof(void*))->GetName();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001350}
1351
Ian Rogersc0542af2014-09-03 16:16:56 -07001352std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001353 ArtField* f = FromFieldId(field_id);
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001354 if (f == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001355 return "null";
Sebastien Hertza9aa0ff2014-09-19 12:07:51 +02001356 }
1357 return f->GetName();
Elliott Hughesa96836a2013-01-17 12:27:49 -08001358}
1359
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001360/*
1361 * Augment the access flags for synthetic methods and fields by setting
1362 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
1363 * flags not specified by the Java programming language.
1364 */
1365static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1366 accessFlags &= kAccJavaFlagsMask;
1367 if ((accessFlags & kAccSynthetic) != 0) {
1368 accessFlags |= 0xf0000000;
1369 }
1370 return accessFlags;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001371}
1372
Elliott Hughesdbb40792011-11-18 17:05:22 -08001373/*
Jeff Haob7cefc72013-11-14 14:51:09 -08001374 * Circularly shifts registers so that arguments come first. Debuggers
1375 * expect slots to begin with arguments, but dex code places them at
1376 * the end.
Elliott Hughesdbb40792011-11-18 17:05:22 -08001377 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001378static uint16_t MangleSlot(uint16_t slot, ArtMethod* m)
Jeff Haob7cefc72013-11-14 14:51:09 -08001379 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001380 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001381 if (code_item == nullptr) {
1382 // We should not get here for a method without code (native, proxy or abstract). Log it and
1383 // return the slot as is since all registers are arguments.
1384 LOG(WARNING) << "Trying to mangle slot for method without code " << PrettyMethod(m);
1385 return slot;
1386 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001387 uint16_t ins_size = code_item->ins_size_;
1388 uint16_t locals_size = code_item->registers_size_ - ins_size;
1389 if (slot >= locals_size) {
1390 return slot - locals_size;
1391 } else {
1392 return slot + ins_size;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001393 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001394}
1395
Jeff Haob7cefc72013-11-14 14:51:09 -08001396/*
1397 * Circularly shifts registers so that arguments come last. Reverts
1398 * slots to dex style argument placement.
1399 */
Mathieu Chartiere401d142015-04-22 13:56:20 -07001400static uint16_t DemangleSlot(uint16_t slot, ArtMethod* m, JDWP::JdwpError* error)
Ian Rogersb726dcb2012-09-05 08:57:23 -07001401 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001402 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001403 if (code_item == nullptr) {
1404 // We should not get here for a method without code (native, proxy or abstract). Log it and
1405 // return the slot as is since all registers are arguments.
1406 LOG(WARNING) << "Trying to demangle slot for method without code " << PrettyMethod(m);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001407 uint16_t vreg_count = ArtMethod::NumArgRegisters(m->GetShorty());
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001408 if (slot < vreg_count) {
1409 *error = JDWP::ERR_NONE;
1410 return slot;
1411 }
Jeff Haob7cefc72013-11-14 14:51:09 -08001412 } else {
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001413 if (slot < code_item->registers_size_) {
1414 uint16_t ins_size = code_item->ins_size_;
1415 uint16_t locals_size = code_item->registers_size_ - ins_size;
1416 *error = JDWP::ERR_NONE;
1417 return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1418 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001419 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01001420
1421 // Slot is invalid in the method.
1422 LOG(ERROR) << "Invalid local slot " << slot << " for method " << PrettyMethod(m);
1423 *error = JDWP::ERR_INVALID_SLOT;
1424 return DexFile::kDexNoIndex16;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001425}
1426
Elliott Hughes88d63092013-01-09 09:55:54 -08001427JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001428 JDWP::JdwpError error;
1429 mirror::Class* c = DecodeClass(class_id, &error);
1430 if (c == nullptr) {
1431 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001432 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001433
1434 size_t instance_field_count = c->NumInstanceFields();
1435 size_t static_field_count = c->NumStaticFields();
1436
1437 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1438
1439 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001440 ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) : c->GetStaticField(i - instance_field_count);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001441 expandBufAddFieldId(pReply, ToFieldId(f));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001442 expandBufAddUtf8String(pReply, f->GetName());
1443 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001444 if (with_generic) {
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001445 static const char genericSignature[1] = "";
1446 expandBufAddUtf8String(pReply, genericSignature);
1447 }
1448 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1449 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001450 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001451}
1452
Elliott Hughes88d63092013-01-09 09:55:54 -08001453JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001454 JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001455 JDWP::JdwpError error;
1456 mirror::Class* c = DecodeClass(class_id, &error);
1457 if (c == nullptr) {
1458 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001459 }
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001460
1461 size_t direct_method_count = c->NumDirectMethods();
1462 size_t virtual_method_count = c->NumVirtualMethods();
1463
1464 expandBufAdd4BE(pReply, direct_method_count + virtual_method_count);
1465
Mathieu Chartiere401d142015-04-22 13:56:20 -07001466 auto* cl = Runtime::Current()->GetClassLinker();
1467 auto ptr_size = cl->GetImagePointerSize();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001468 for (size_t i = 0; i < direct_method_count + virtual_method_count; ++i) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001469 ArtMethod* m = i < direct_method_count ?
1470 c->GetDirectMethod(i, ptr_size) : c->GetVirtualMethod(i - direct_method_count, ptr_size);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001471 expandBufAddMethodId(pReply, ToMethodId(m));
Sebastien Hertz415fd082015-06-01 11:42:27 +02001472 expandBufAddUtf8String(pReply, m->GetInterfaceMethodIfProxy(sizeof(void*))->GetName());
1473 expandBufAddUtf8String(pReply,
1474 m->GetInterfaceMethodIfProxy(sizeof(void*))->GetSignature().ToString());
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001475 if (with_generic) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001476 const char* generic_signature = "";
1477 expandBufAddUtf8String(pReply, generic_signature);
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001478 }
1479 expandBufAdd4BE(pReply, MangleAccessFlags(m->GetAccessFlags()));
1480 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001481 return JDWP::ERR_NONE;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001482}
1483
Elliott Hughes88d63092013-01-09 09:55:54 -08001484JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001485 JDWP::JdwpError error;
Mathieu Chartierf8322842014-05-16 10:59:25 -07001486 Thread* self = Thread::Current();
1487 StackHandleScope<1> hs(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07001488 Handle<mirror::Class> c(hs.NewHandle(DecodeClass(class_id, &error)));
Mathieu Chartierf8322842014-05-16 10:59:25 -07001489 if (c.Get() == nullptr) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001490 return error;
Elliott Hughes7b3cdfc2011-12-08 21:28:17 -08001491 }
Mathieu Chartierf8322842014-05-16 10:59:25 -07001492 size_t interface_count = c->NumDirectInterfaces();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001493 expandBufAdd4BE(pReply, interface_count);
1494 for (size_t i = 0; i < interface_count; ++i) {
Mathieu Chartierf8322842014-05-16 10:59:25 -07001495 expandBufAddRefTypeId(pReply,
1496 gRegistry->AddRefType(mirror::Class::GetDirectInterface(self, c, i)));
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001497 }
Elliott Hughes436e3722012-02-17 20:01:47 -08001498 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001499}
1500
Ian Rogersc0542af2014-09-03 16:16:56 -07001501void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001502 struct DebugCallbackContext {
1503 int numItems;
1504 JDWP::ExpandBuf* pReply;
1505
Elliott Hughes2435a572012-02-17 16:07:41 -08001506 static bool Callback(void* context, uint32_t address, uint32_t line_number) {
Elliott Hughes03181a82011-11-17 17:22:21 -08001507 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1508 expandBufAdd8BE(pContext->pReply, address);
Elliott Hughes2435a572012-02-17 16:07:41 -08001509 expandBufAdd4BE(pContext->pReply, line_number);
Elliott Hughes03181a82011-11-17 17:22:21 -08001510 pContext->numItems++;
Sebastien Hertzf2910ee2013-10-19 16:39:24 +02001511 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08001512 }
1513 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001514 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001515 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes03181a82011-11-17 17:22:21 -08001516 uint64_t start, end;
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001517 if (code_item == nullptr) {
1518 DCHECK(m->IsNative() || m->IsProxyMethod());
Elliott Hughes03181a82011-11-17 17:22:21 -08001519 start = -1;
1520 end = -1;
1521 } else {
1522 start = 0;
jeffhao14f0db92012-12-14 17:50:42 -08001523 // Return the index of the last instruction
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001524 end = code_item->insns_size_in_code_units_ - 1;
Elliott Hughes03181a82011-11-17 17:22:21 -08001525 }
1526
1527 expandBufAdd8BE(pReply, start);
1528 expandBufAdd8BE(pReply, end);
1529
1530 // Add numLines later
1531 size_t numLinesOffset = expandBufGetLength(pReply);
1532 expandBufAdd4BE(pReply, 0);
1533
1534 DebugCallbackContext context;
1535 context.numItems = 0;
1536 context.pReply = pReply;
1537
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001538 if (code_item != nullptr) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001539 m->GetDexFile()->DecodeDebugInfo(code_item, m->IsStatic(), m->GetDexMethodIndex(),
Ian Rogersc0542af2014-09-03 16:16:56 -07001540 DebugCallbackContext::Callback, nullptr, &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001541 }
Elliott Hughes03181a82011-11-17 17:22:21 -08001542
1543 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001544}
1545
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001546void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1547 JDWP::ExpandBuf* pReply) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001548 struct DebugCallbackContext {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001549 ArtMethod* method;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001550 JDWP::ExpandBuf* pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001551 size_t variable_count;
1552 bool with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001553
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001554 static void Callback(void* context, uint16_t slot, uint32_t startAddress, uint32_t endAddress,
1555 const char* name, const char* descriptor, const char* signature)
Jeff Haob7cefc72013-11-14 14:51:09 -08001556 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001557 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1558
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001559 VLOG(jdwp) << StringPrintf(" %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
1560 pContext->variable_count, startAddress, endAddress - startAddress,
1561 name, descriptor, signature, slot,
1562 MangleSlot(slot, pContext->method));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001563
Jeff Haob7cefc72013-11-14 14:51:09 -08001564 slot = MangleSlot(slot, pContext->method);
Elliott Hughes68fdbd02011-11-29 19:22:47 -08001565
Elliott Hughesdbb40792011-11-18 17:05:22 -08001566 expandBufAdd8BE(pContext->pReply, startAddress);
1567 expandBufAddUtf8String(pContext->pReply, name);
1568 expandBufAddUtf8String(pContext->pReply, descriptor);
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001569 if (pContext->with_generic) {
Elliott Hughesdbb40792011-11-18 17:05:22 -08001570 expandBufAddUtf8String(pContext->pReply, signature);
1571 }
1572 expandBufAdd4BE(pContext->pReply, endAddress - startAddress);
1573 expandBufAdd4BE(pContext->pReply, slot);
1574
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001575 ++pContext->variable_count;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001576 }
1577 };
Mathieu Chartiere401d142015-04-22 13:56:20 -07001578 ArtMethod* m = FromMethodId(method_id);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001579
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001580 // arg_count considers doubles and longs to take 2 units.
1581 // variable_count considers everything to take 1 unit.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001582 std::string shorty(m->GetShorty());
Mathieu Chartiere401d142015-04-22 13:56:20 -07001583 expandBufAdd4BE(pReply, ArtMethod::NumArgRegisters(shorty));
Elliott Hughesdbb40792011-11-18 17:05:22 -08001584
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001585 // We don't know the total number of variables yet, so leave a blank and update it later.
1586 size_t variable_count_offset = expandBufGetLength(pReply);
Elliott Hughesdbb40792011-11-18 17:05:22 -08001587 expandBufAdd4BE(pReply, 0);
1588
1589 DebugCallbackContext context;
Jeff Haob7cefc72013-11-14 14:51:09 -08001590 context.method = m;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001591 context.pReply = pReply;
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001592 context.variable_count = 0;
1593 context.with_generic = with_generic;
Elliott Hughesdbb40792011-11-18 17:05:22 -08001594
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001595 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001596 if (code_item != nullptr) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001597 m->GetDexFile()->DecodeDebugInfo(
Ian Rogersc0542af2014-09-03 16:16:56 -07001598 code_item, m->IsStatic(), m->GetDexMethodIndex(), nullptr, DebugCallbackContext::Callback,
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001599 &context);
Sebastien Hertzcb19ebf2014-03-11 15:26:35 +01001600 }
Elliott Hughesdbb40792011-11-18 17:05:22 -08001601
Elliott Hughesc5b734a2011-12-01 17:20:58 -08001602 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001603}
1604
Jeff Hao579b0242013-11-18 13:16:49 -08001605void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1606 JDWP::ExpandBuf* pReply) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001607 ArtMethod* m = FromMethodId(method_id);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001608 JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
Jeff Hao579b0242013-11-18 13:16:49 -08001609 OutputJValue(tag, return_value, pReply);
1610}
1611
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001612void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1613 JDWP::ExpandBuf* pReply) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07001614 ArtField* f = FromFieldId(field_id);
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001615 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02001616 OutputJValue(tag, field_value, pReply);
1617}
1618
Elliott Hughes9777ba22013-01-17 09:04:19 -08001619JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
Ian Rogersc0542af2014-09-03 16:16:56 -07001620 std::vector<uint8_t>* bytecodes) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001621 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07001622 if (m == nullptr) {
Elliott Hughes9777ba22013-01-17 09:04:19 -08001623 return JDWP::ERR_INVALID_METHODID;
1624 }
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07001625 const DexFile::CodeItem* code_item = m->GetCodeItem();
Elliott Hughes9777ba22013-01-17 09:04:19 -08001626 size_t byte_count = code_item->insns_size_in_code_units_ * 2;
1627 const uint8_t* begin = reinterpret_cast<const uint8_t*>(code_item->insns_);
1628 const uint8_t* end = begin + byte_count;
1629 for (const uint8_t* p = begin; p != end; ++p) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001630 bytecodes->push_back(*p);
Elliott Hughes9777ba22013-01-17 09:04:19 -08001631 }
1632 return JDWP::ERR_NONE;
1633}
1634
Elliott Hughes88d63092013-01-09 09:55:54 -08001635JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001636 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001637}
1638
Elliott Hughes88d63092013-01-09 09:55:54 -08001639JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001640 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001641}
1642
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001643static JValue GetArtFieldValue(ArtField* f, mirror::Object* o)
1644 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1645 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1646 JValue field_value;
1647 switch (fieldType) {
1648 case Primitive::kPrimBoolean:
1649 field_value.SetZ(f->GetBoolean(o));
1650 return field_value;
1651
1652 case Primitive::kPrimByte:
1653 field_value.SetB(f->GetByte(o));
1654 return field_value;
1655
1656 case Primitive::kPrimChar:
1657 field_value.SetC(f->GetChar(o));
1658 return field_value;
1659
1660 case Primitive::kPrimShort:
1661 field_value.SetS(f->GetShort(o));
1662 return field_value;
1663
1664 case Primitive::kPrimInt:
1665 case Primitive::kPrimFloat:
1666 // Int and Float must be treated as 32-bit values in JDWP.
1667 field_value.SetI(f->GetInt(o));
1668 return field_value;
1669
1670 case Primitive::kPrimLong:
1671 case Primitive::kPrimDouble:
1672 // Long and Double must be treated as 64-bit values in JDWP.
1673 field_value.SetJ(f->GetLong(o));
1674 return field_value;
1675
1676 case Primitive::kPrimNot:
1677 field_value.SetL(f->GetObject(o));
1678 return field_value;
1679
1680 case Primitive::kPrimVoid:
1681 LOG(FATAL) << "Attempt to read from field of type 'void'";
1682 UNREACHABLE();
1683 }
1684 LOG(FATAL) << "Attempt to read from field of unknown type";
1685 UNREACHABLE();
1686}
1687
Elliott Hughes88d63092013-01-09 09:55:54 -08001688static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1689 JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001690 bool is_static)
Ian Rogersb726dcb2012-09-05 08:57:23 -07001691 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001692 JDWP::JdwpError error;
1693 mirror::Class* c = DecodeClass(ref_type_id, &error);
1694 if (ref_type_id != 0 && c == nullptr) {
1695 return error;
Elliott Hughes0cf74332012-02-23 23:14:00 -08001696 }
1697
Sebastien Hertz6995c602014-09-09 12:10:13 +02001698 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001699 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001700 return JDWP::ERR_INVALID_OBJECT;
1701 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001702 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001703
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001704 mirror::Class* receiver_class = c;
Ian Rogersc0542af2014-09-03 16:16:56 -07001705 if (receiver_class == nullptr && o != nullptr) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001706 receiver_class = o->GetClass();
1707 }
Mathieu Chartier2cebb242015-04-21 16:50:40 -07001708 // TODO: should we give up now if receiver_class is null?
Ian Rogersc0542af2014-09-03 16:16:56 -07001709 if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
Elliott Hughes0cf74332012-02-23 23:14:00 -08001710 LOG(INFO) << "ERR_INVALID_FIELDID: " << PrettyField(f) << " " << PrettyClass(receiver_class);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001711 return JDWP::ERR_INVALID_FIELDID;
1712 }
Elliott Hughesaed4be92011-12-02 16:16:23 -08001713
Elliott Hughes0cf74332012-02-23 23:14:00 -08001714 // The RI only enforces the static/non-static mismatch in one direction.
1715 // TODO: should we change the tests and check both?
1716 if (is_static) {
1717 if (!f->IsStatic()) {
1718 return JDWP::ERR_INVALID_FIELDID;
1719 }
1720 } else {
1721 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001722 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.GetValues"
1723 << " on static field " << PrettyField(f);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001724 }
1725 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001726 if (f->IsStatic()) {
1727 o = f->GetDeclaringClass();
1728 }
Elliott Hughes0cf74332012-02-23 23:14:00 -08001729
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001730 JValue field_value(GetArtFieldValue(f, o));
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07001731 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
Jeff Hao579b0242013-11-18 13:16:49 -08001732 Dbg::OutputJValue(tag, &field_value, pReply);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001733 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001734}
1735
Elliott Hughes88d63092013-01-09 09:55:54 -08001736JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001737 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001738 return GetFieldValueImpl(0, object_id, field_id, pReply, false);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001739}
1740
Ian Rogersc0542af2014-09-03 16:16:56 -07001741JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1742 JDWP::ExpandBuf* pReply) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001743 return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001744}
1745
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001746static JDWP::JdwpError SetArtFieldValue(ArtField* f, mirror::Object* o, uint64_t value, int width)
1747 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1748 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1749 // Debugging only happens at runtime so we know we are not running in a transaction.
1750 static constexpr bool kNoTransactionMode = false;
1751 switch (fieldType) {
1752 case Primitive::kPrimBoolean:
1753 CHECK_EQ(width, 1);
1754 f->SetBoolean<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1755 return JDWP::ERR_NONE;
1756
1757 case Primitive::kPrimByte:
1758 CHECK_EQ(width, 1);
1759 f->SetByte<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1760 return JDWP::ERR_NONE;
1761
1762 case Primitive::kPrimChar:
1763 CHECK_EQ(width, 2);
1764 f->SetChar<kNoTransactionMode>(o, static_cast<uint16_t>(value));
1765 return JDWP::ERR_NONE;
1766
1767 case Primitive::kPrimShort:
1768 CHECK_EQ(width, 2);
1769 f->SetShort<kNoTransactionMode>(o, static_cast<int16_t>(value));
1770 return JDWP::ERR_NONE;
1771
1772 case Primitive::kPrimInt:
1773 case Primitive::kPrimFloat:
1774 CHECK_EQ(width, 4);
1775 // Int and Float must be treated as 32-bit values in JDWP.
1776 f->SetInt<kNoTransactionMode>(o, static_cast<int32_t>(value));
1777 return JDWP::ERR_NONE;
1778
1779 case Primitive::kPrimLong:
1780 case Primitive::kPrimDouble:
1781 CHECK_EQ(width, 8);
1782 // Long and Double must be treated as 64-bit values in JDWP.
1783 f->SetLong<kNoTransactionMode>(o, value);
1784 return JDWP::ERR_NONE;
1785
1786 case Primitive::kPrimNot: {
1787 JDWP::JdwpError error;
1788 mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1789 if (error != JDWP::ERR_NONE) {
1790 return JDWP::ERR_INVALID_OBJECT;
1791 }
1792 if (v != nullptr) {
1793 mirror::Class* field_type;
1794 {
1795 StackHandleScope<2> hs(Thread::Current());
1796 HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1797 HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
1798 field_type = f->GetType<true>();
1799 }
1800 if (!field_type->IsAssignableFrom(v->GetClass())) {
1801 return JDWP::ERR_INVALID_OBJECT;
1802 }
1803 }
1804 f->SetObject<kNoTransactionMode>(o, v);
1805 return JDWP::ERR_NONE;
1806 }
1807
1808 case Primitive::kPrimVoid:
1809 LOG(FATAL) << "Attempt to write to field of type 'void'";
1810 UNREACHABLE();
1811 }
1812 LOG(FATAL) << "Attempt to write to field of unknown type";
1813 UNREACHABLE();
1814}
1815
Elliott Hughes88d63092013-01-09 09:55:54 -08001816static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001817 uint64_t value, int width, bool is_static)
Ian Rogersb726dcb2012-09-05 08:57:23 -07001818 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001819 JDWP::JdwpError error;
Sebastien Hertz6995c602014-09-09 12:10:13 +02001820 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07001821 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001822 return JDWP::ERR_INVALID_OBJECT;
1823 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07001824 ArtField* f = FromFieldId(field_id);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001825
1826 // The RI only enforces the static/non-static mismatch in one direction.
1827 // TODO: should we change the tests and check both?
1828 if (is_static) {
1829 if (!f->IsStatic()) {
1830 return JDWP::ERR_INVALID_FIELDID;
1831 }
1832 } else {
1833 if (f->IsStatic()) {
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001834 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues"
1835 << " on static field " << PrettyField(f);
Elliott Hughes0cf74332012-02-23 23:14:00 -08001836 }
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08001837 }
jeffhao0dfbb7e2012-11-28 15:26:03 -08001838 if (f->IsStatic()) {
1839 o = f->GetDeclaringClass();
1840 }
Sebastien Hertz05c26b32015-06-11 18:42:58 +02001841 return SetArtFieldValue(f, o, value, width);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001842}
1843
Elliott Hughes88d63092013-01-09 09:55:54 -08001844JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
Ian Rogers00f7d0e2012-07-19 15:28:27 -07001845 int width) {
Elliott Hughes88d63092013-01-09 09:55:54 -08001846 return SetFieldValueImpl(object_id, field_id, value, width, false);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001847}
1848
Elliott Hughes88d63092013-01-09 09:55:54 -08001849JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
1850 return SetFieldValueImpl(0, field_id, value, width, true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001851}
1852
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001853JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
Ian Rogersc0542af2014-09-03 16:16:56 -07001854 JDWP::JdwpError error;
Sebastien Hertzb0b0b492014-09-15 11:27:27 +02001855 mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
1856 if (error != JDWP::ERR_NONE) {
1857 return error;
1858 }
1859 if (obj == nullptr) {
1860 return JDWP::ERR_INVALID_OBJECT;
1861 }
1862 {
1863 ScopedObjectAccessUnchecked soa(Thread::Current());
1864 mirror::Class* java_lang_String = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_String);
1865 if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
1866 // This isn't a string.
1867 return JDWP::ERR_INVALID_STRING;
1868 }
1869 }
1870 *str = obj->AsString()->ToModifiedUtf8();
1871 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001872}
1873
Jeff Hao579b0242013-11-18 13:16:49 -08001874void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
1875 if (IsPrimitiveTag(tag)) {
1876 expandBufAdd1(pReply, tag);
1877 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
1878 expandBufAdd1(pReply, return_value->GetI());
1879 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
1880 expandBufAdd2BE(pReply, return_value->GetI());
1881 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
1882 expandBufAdd4BE(pReply, return_value->GetI());
1883 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1884 expandBufAdd8BE(pReply, return_value->GetJ());
1885 } else {
1886 CHECK_EQ(tag, JDWP::JT_VOID);
1887 }
1888 } else {
Ian Rogers98379392014-02-24 16:53:16 -08001889 ScopedObjectAccessUnchecked soa(Thread::Current());
Jeff Hao579b0242013-11-18 13:16:49 -08001890 mirror::Object* value = return_value->GetL();
Ian Rogers98379392014-02-24 16:53:16 -08001891 expandBufAdd1(pReply, TagFromObject(soa, value));
Jeff Hao579b0242013-11-18 13:16:49 -08001892 expandBufAddObjectId(pReply, gRegistry->Add(value));
1893 }
1894}
1895
Ian Rogersc0542af2014-09-03 16:16:56 -07001896JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
jeffhaoa77f0f62012-12-05 17:19:31 -08001897 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001898 JDWP::JdwpError error;
1899 Thread* thread = DecodeThread(soa, thread_id, &error);
1900 UNUSED(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08001901 if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
1902 return error;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08001903 }
Elliott Hughes221229c2013-01-08 18:17:50 -08001904
1905 // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
Ian Rogersc0542af2014-09-03 16:16:56 -07001906 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1907 CHECK(thread_object != nullptr) << error;
Mathieu Chartierc7853442015-03-27 14:35:38 -07001908 ArtField* java_lang_Thread_name_field =
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001909 soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
1910 mirror::String* s =
1911 reinterpret_cast<mirror::String*>(java_lang_Thread_name_field->GetObject(thread_object));
Ian Rogersc0542af2014-09-03 16:16:56 -07001912 if (s != nullptr) {
1913 *name = s->ToModifiedUtf8();
Elliott Hughes221229c2013-01-08 18:17:50 -08001914 }
1915 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001916}
1917
Elliott Hughes221229c2013-01-08 18:17:50 -08001918JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Sebastien Hertza06430c2014-09-15 19:21:30 +02001919 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001920 JDWP::JdwpError error;
1921 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1922 if (error != JDWP::ERR_NONE) {
Elliott Hughes2435a572012-02-17 16:07:41 -08001923 return JDWP::ERR_INVALID_OBJECT;
1924 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001925 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroup");
Elliott Hughes2435a572012-02-17 16:07:41 -08001926 // Okay, so it's an object, but is it actually a thread?
Sebastien Hertz69206392015-04-07 15:54:25 +02001927 Thread* thread = DecodeThread(soa, thread_id, &error);
1928 UNUSED(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08001929 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
1930 // Zombie threads are in the null group.
1931 expandBufAddObjectId(pReply, JDWP::ObjectId(0));
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001932 error = JDWP::ERR_NONE;
1933 } else if (error == JDWP::ERR_NONE) {
1934 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
1935 CHECK(c != nullptr);
Mathieu Chartierc7853442015-03-27 14:35:38 -07001936 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07001937 CHECK(f != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001938 mirror::Object* group = f->GetObject(thread_object);
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07001939 CHECK(group != nullptr);
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001940 JDWP::ObjectId thread_group_id = gRegistry->Add(group);
1941 expandBufAddObjectId(pReply, thread_group_id);
Elliott Hughes221229c2013-01-08 18:17:50 -08001942 }
Sebastien Hertz52d131d2014-03-13 16:17:40 +01001943 return error;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001944}
1945
Sebastien Hertza06430c2014-09-15 19:21:30 +02001946static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
1947 JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
1948 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02001949 mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
1950 error);
Sebastien Hertza06430c2014-09-15 19:21:30 +02001951 if (*error != JDWP::ERR_NONE) {
1952 return nullptr;
1953 }
1954 if (thread_group == nullptr) {
1955 *error = JDWP::ERR_INVALID_OBJECT;
1956 return nullptr;
1957 }
Ian Rogers98379392014-02-24 16:53:16 -08001958 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
1959 CHECK(c != nullptr);
Sebastien Hertza06430c2014-09-15 19:21:30 +02001960 if (!c->IsAssignableFrom(thread_group->GetClass())) {
1961 // This is not a java.lang.ThreadGroup.
1962 *error = JDWP::ERR_INVALID_THREAD_GROUP;
1963 return nullptr;
1964 }
1965 *error = JDWP::ERR_NONE;
1966 return thread_group;
1967}
1968
1969JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
1970 ScopedObjectAccessUnchecked soa(Thread::Current());
1971 JDWP::JdwpError error;
1972 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
1973 if (error != JDWP::ERR_NONE) {
1974 return error;
1975 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001976 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupName");
Mathieu Chartierc7853442015-03-27 14:35:38 -07001977 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_name);
Ian Rogersc0542af2014-09-03 16:16:56 -07001978 CHECK(f != nullptr);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001979 mirror::String* s = reinterpret_cast<mirror::String*>(f->GetObject(thread_group));
Sebastien Hertza06430c2014-09-15 19:21:30 +02001980
1981 std::string thread_group_name(s->ToModifiedUtf8());
1982 expandBufAddUtf8String(pReply, thread_group_name);
1983 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07001984}
1985
Sebastien Hertza06430c2014-09-15 19:21:30 +02001986JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
Ian Rogers98379392014-02-24 16:53:16 -08001987 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07001988 JDWP::JdwpError error;
Sebastien Hertza06430c2014-09-15 19:21:30 +02001989 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
1990 if (error != JDWP::ERR_NONE) {
1991 return error;
1992 }
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001993 mirror::Object* parent;
1994 {
1995 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupParent");
Mathieu Chartierc7853442015-03-27 14:35:38 -07001996 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_parent);
Mathieu Chartier2d5f39e2014-09-19 17:52:37 -07001997 CHECK(f != nullptr);
1998 parent = f->GetObject(thread_group);
1999 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002000 JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
2001 expandBufAddObjectId(pReply, parent_group_id);
2002 return JDWP::ERR_NONE;
2003}
2004
2005static void GetChildThreadGroups(ScopedObjectAccessUnchecked& soa, mirror::Object* thread_group,
2006 std::vector<JDWP::ObjectId>* child_thread_group_ids)
2007 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2008 CHECK(thread_group != nullptr);
2009
2010 // Get the ArrayList<ThreadGroup> "groups" out of this thread group...
Mathieu Chartierc7853442015-03-27 14:35:38 -07002011 ArtField* groups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_groups);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002012 mirror::Object* groups_array_list = groups_field->GetObject(thread_group);
Sebastien Hertze49e1952014-10-13 11:27:13 +02002013 {
2014 // The "groups" field is declared as a java.util.List: check it really is
2015 // an instance of java.util.ArrayList.
2016 CHECK(groups_array_list != nullptr);
2017 mirror::Class* java_util_ArrayList_class =
2018 soa.Decode<mirror::Class*>(WellKnownClasses::java_util_ArrayList);
2019 CHECK(groups_array_list->InstanceOf(java_util_ArrayList_class));
2020 }
Sebastien Hertza06430c2014-09-15 19:21:30 +02002021
2022 // Get the array and size out of the ArrayList<ThreadGroup>...
Mathieu Chartierc7853442015-03-27 14:35:38 -07002023 ArtField* array_field = soa.DecodeField(WellKnownClasses::java_util_ArrayList_array);
2024 ArtField* size_field = soa.DecodeField(WellKnownClasses::java_util_ArrayList_size);
Sebastien Hertza06430c2014-09-15 19:21:30 +02002025 mirror::ObjectArray<mirror::Object>* groups_array =
2026 array_field->GetObject(groups_array_list)->AsObjectArray<mirror::Object>();
2027 const int32_t size = size_field->GetInt(groups_array_list);
2028
2029 // Copy the first 'size' elements out of the array into the result.
Sebastien Hertz6995c602014-09-09 12:10:13 +02002030 ObjectRegistry* registry = Dbg::GetObjectRegistry();
Sebastien Hertza06430c2014-09-15 19:21:30 +02002031 for (int32_t i = 0; i < size; ++i) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002032 child_thread_group_ids->push_back(registry->Add(groups_array->Get(i)));
Sebastien Hertza06430c2014-09-15 19:21:30 +02002033 }
2034}
2035
2036JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2037 JDWP::ExpandBuf* pReply) {
2038 ScopedObjectAccessUnchecked soa(Thread::Current());
2039 JDWP::JdwpError error;
2040 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2041 if (error != JDWP::ERR_NONE) {
2042 return error;
2043 }
2044
2045 // Add child threads.
2046 {
2047 std::vector<JDWP::ObjectId> child_thread_ids;
2048 GetThreads(thread_group, &child_thread_ids);
2049 expandBufAdd4BE(pReply, child_thread_ids.size());
2050 for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2051 expandBufAddObjectId(pReply, child_thread_id);
2052 }
2053 }
2054
2055 // Add child thread groups.
2056 {
2057 std::vector<JDWP::ObjectId> child_thread_groups_ids;
2058 GetChildThreadGroups(soa, thread_group, &child_thread_groups_ids);
2059 expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2060 for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2061 expandBufAddObjectId(pReply, child_thread_group_id);
2062 }
2063 }
2064
2065 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002066}
2067
2068JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002069 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartierc7853442015-03-27 14:35:38 -07002070 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002071 mirror::Object* group = f->GetObject(f->GetDeclaringClass());
Ian Rogers365c1022012-06-22 15:05:28 -07002072 return gRegistry->Add(group);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002073}
2074
Jeff Hao920af3e2013-08-28 15:46:38 -07002075JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2076 switch (state) {
2077 case kBlocked:
2078 return JDWP::TS_MONITOR;
2079 case kNative:
2080 case kRunnable:
2081 case kSuspended:
2082 return JDWP::TS_RUNNING;
2083 case kSleeping:
2084 return JDWP::TS_SLEEPING;
2085 case kStarting:
2086 case kTerminated:
2087 return JDWP::TS_ZOMBIE;
2088 case kTimedWaiting:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002089 case kWaitingForCheckPointsToRun:
Jeff Hao920af3e2013-08-28 15:46:38 -07002090 case kWaitingForDebuggerSend:
2091 case kWaitingForDebuggerSuspension:
2092 case kWaitingForDebuggerToAttach:
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01002093 case kWaitingForDeoptimization:
Jeff Hao920af3e2013-08-28 15:46:38 -07002094 case kWaitingForGcToComplete:
Mathieu Chartierb43390c2015-05-12 10:47:11 -07002095 case kWaitingForGetObjectsAllocated:
Jeff Hao920af3e2013-08-28 15:46:38 -07002096 case kWaitingForJniOnLoad:
Sebastien Hertzbae182c2013-12-17 10:42:03 +01002097 case kWaitingForMethodTracingStart:
Jeff Hao920af3e2013-08-28 15:46:38 -07002098 case kWaitingForSignalCatcherOutput:
Hiroshi Yamauchi0c8c3032015-01-16 16:54:35 -08002099 case kWaitingForVisitObjects:
Jeff Hao920af3e2013-08-28 15:46:38 -07002100 case kWaitingInMainDebuggerLoop:
2101 case kWaitingInMainSignalCatcherLoop:
2102 case kWaitingPerformingGc:
Mathieu Chartier14c3bf92015-07-13 14:35:43 -07002103 case kWaitingWeakRootRead:
Jeff Hao920af3e2013-08-28 15:46:38 -07002104 case kWaiting:
2105 return JDWP::TS_WAIT;
2106 // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2107 }
2108 LOG(FATAL) << "Unknown thread state: " << state;
2109 return JDWP::TS_ZOMBIE;
2110}
2111
Sebastien Hertz52d131d2014-03-13 16:17:40 +01002112JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2113 JDWP::JdwpSuspendStatus* pSuspendStatus) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002114 ScopedObjectAccess soa(Thread::Current());
Elliott Hughes499c5132011-11-17 14:55:11 -08002115
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002116 *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2117
Ian Rogersc0542af2014-09-03 16:16:56 -07002118 JDWP::JdwpError error;
2119 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002120 if (error != JDWP::ERR_NONE) {
2121 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2122 *pThreadStatus = JDWP::TS_ZOMBIE;
Elliott Hughes221229c2013-01-08 18:17:50 -08002123 return JDWP::ERR_NONE;
2124 }
2125 return error;
Elliott Hughes499c5132011-11-17 14:55:11 -08002126 }
2127
Elliott Hughes9e0c1752013-01-09 14:02:58 -08002128 if (IsSuspendedForDebugger(soa, thread)) {
2129 *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
Elliott Hughes499c5132011-11-17 14:55:11 -08002130 }
2131
Jeff Hao920af3e2013-08-28 15:46:38 -07002132 *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
Elliott Hughes221229c2013-01-08 18:17:50 -08002133 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002134}
2135
Elliott Hughes221229c2013-01-08 18:17:50 -08002136JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002137 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002138 JDWP::JdwpError error;
2139 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002140 if (error != JDWP::ERR_NONE) {
2141 return error;
Elliott Hughes2435a572012-02-17 16:07:41 -08002142 }
Ian Rogers50b35e22012-10-04 10:09:15 -07002143 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002144 expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
Elliott Hughes2435a572012-02-17 16:07:41 -08002145 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002146}
2147
Elliott Hughesf9501702013-01-11 11:22:27 -08002148JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2149 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002150 JDWP::JdwpError error;
2151 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughesf9501702013-01-11 11:22:27 -08002152 if (error != JDWP::ERR_NONE) {
2153 return error;
2154 }
Ian Rogersdd7624d2014-03-14 17:43:00 -07002155 thread->Interrupt(soa.Self());
Elliott Hughesf9501702013-01-11 11:22:27 -08002156 return JDWP::ERR_NONE;
2157}
2158
Sebastien Hertz070f7322014-09-09 12:08:49 +02002159static bool IsInDesiredThreadGroup(ScopedObjectAccessUnchecked& soa,
2160 mirror::Object* desired_thread_group, mirror::Object* peer)
2161 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2162 // Do we want threads from all thread groups?
2163 if (desired_thread_group == nullptr) {
2164 return true;
2165 }
Mathieu Chartierc7853442015-03-27 14:35:38 -07002166 ArtField* thread_group_field = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
Sebastien Hertz070f7322014-09-09 12:08:49 +02002167 DCHECK(thread_group_field != nullptr);
2168 mirror::Object* group = thread_group_field->GetObject(peer);
2169 return (group == desired_thread_group);
2170}
2171
Sebastien Hertza06430c2014-09-15 19:21:30 +02002172void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002173 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz070f7322014-09-09 12:08:49 +02002174 std::list<Thread*> all_threads_list;
2175 {
2176 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2177 all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2178 }
2179 for (Thread* t : all_threads_list) {
2180 if (t == Dbg::GetDebugThread()) {
2181 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2182 // query all threads, so it's easier if we just don't tell them about this thread.
2183 continue;
2184 }
2185 if (t->IsStillStarting()) {
2186 // This thread is being started (and has been registered in the thread list). However, it is
2187 // not completely started yet so we must ignore it.
2188 continue;
2189 }
2190 mirror::Object* peer = t->GetPeer();
2191 if (peer == nullptr) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07002192 // 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 +02002193 // this thread yet.
2194 // TODO: if we identified threads to the debugger by their Thread*
2195 // rather than their peer's mirror::Object*, we could fix this.
2196 // Doing so might help us report ZOMBIE threads too.
2197 continue;
2198 }
2199 if (IsInDesiredThreadGroup(soa, thread_group, peer)) {
2200 thread_ids->push_back(gRegistry->Add(peer));
2201 }
2202 }
Elliott Hughescaf76542012-06-28 16:08:22 -07002203}
Elliott Hughesa2155262011-11-16 16:26:58 -08002204
Ian Rogersc0542af2014-09-03 16:16:56 -07002205static int GetStackDepth(Thread* thread) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002206 struct CountStackDepthVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002207 explicit CountStackDepthVisitor(Thread* thread_in)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002208 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2209 depth(0) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002210
Elliott Hughes64f574f2013-02-20 14:57:12 -08002211 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2212 // annotalysis.
2213 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Ian Rogers0399dde2012-06-06 17:09:28 -07002214 if (!GetMethod()->IsRuntimeMethod()) {
Elliott Hughesf8a2df72011-12-01 12:19:54 -08002215 ++depth;
2216 }
Elliott Hughes530fa002012-03-12 11:44:49 -07002217 return true;
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002218 }
2219 size_t depth;
2220 };
Elliott Hughes08fc03a2012-06-26 17:34:00 -07002221
Ian Rogers7a22fa62013-01-23 12:16:16 -08002222 CountStackDepthVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07002223 visitor.WalkStack();
Elliott Hughesa2e54f62011-11-17 13:01:30 -08002224 return visitor.depth;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002225}
2226
Ian Rogersc0542af2014-09-03 16:16:56 -07002227JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002228 ScopedObjectAccess soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002229 JDWP::JdwpError error;
2230 *result = 0;
2231 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002232 if (error != JDWP::ERR_NONE) {
2233 return error;
2234 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002235 if (!IsSuspendedForDebugger(soa, thread)) {
2236 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2237 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002238 *result = GetStackDepth(thread);
Elliott Hughes221229c2013-01-08 18:17:50 -08002239 return JDWP::ERR_NONE;
Elliott Hughes86964332012-02-15 19:37:42 -08002240}
2241
Ian Rogers306057f2012-11-26 12:45:53 -08002242JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2243 size_t frame_count, JDWP::ExpandBuf* buf) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002244 class GetFrameVisitor : public StackVisitor {
2245 public:
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002246 GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2247 JDWP::ExpandBuf* buf_in)
Ian Rogersb726dcb2012-09-05 08:57:23 -07002248 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002249 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2250 depth_(0),
2251 start_frame_(start_frame_in),
2252 frame_count_(frame_count_in),
2253 buf_(buf_in) {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002254 expandBufAdd4BE(buf_, frame_count_);
Elliott Hughes03181a82011-11-17 17:22:21 -08002255 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002256
Sebastien Hertz69206392015-04-07 15:54:25 +02002257 bool VisitFrame() OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002258 if (GetMethod()->IsRuntimeMethod()) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -07002259 return true; // The debugger can't do anything useful with a frame that has no Method*.
Elliott Hughes03181a82011-11-17 17:22:21 -08002260 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002261 if (depth_ >= start_frame_ + frame_count_) {
Elliott Hughes530fa002012-03-12 11:44:49 -07002262 return false;
Elliott Hughes03181a82011-11-17 17:22:21 -08002263 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002264 if (depth_ >= start_frame_) {
2265 JDWP::FrameId frame_id(GetFrameId());
2266 JDWP::JdwpLocation location;
Sebastien Hertz6995c602014-09-09 12:10:13 +02002267 SetJdwpLocation(&location, GetMethod(), GetDexPc());
Ian Rogersef7d42f2014-01-06 12:55:46 -08002268 VLOG(jdwp) << StringPrintf(" Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002269 expandBufAdd8BE(buf_, frame_id);
2270 expandBufAddLocation(buf_, location);
2271 }
2272 ++depth_;
Elliott Hughes530fa002012-03-12 11:44:49 -07002273 return true;
Elliott Hughes03181a82011-11-17 17:22:21 -08002274 }
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002275
2276 private:
2277 size_t depth_;
2278 const size_t start_frame_;
2279 const size_t frame_count_;
2280 JDWP::ExpandBuf* buf_;
Elliott Hughes03181a82011-11-17 17:22:21 -08002281 };
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002282
2283 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002284 JDWP::JdwpError error;
2285 Thread* thread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08002286 if (error != JDWP::ERR_NONE) {
2287 return error;
2288 }
Elliott Hughesf15f4a02013-01-09 10:09:38 -08002289 if (!IsSuspendedForDebugger(soa, thread)) {
2290 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2291 }
Ian Rogers7a22fa62013-01-23 12:16:16 -08002292 GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
Ian Rogers0399dde2012-06-06 17:09:28 -07002293 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002294 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002295}
2296
2297JDWP::ObjectId Dbg::GetThreadSelfId() {
Sebastien Hertz6995c602014-09-09 12:10:13 +02002298 return GetThreadId(Thread::Current());
2299}
2300
2301JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
Mathieu Chartierdbe6f462012-09-25 16:54:50 -07002302 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz6995c602014-09-09 12:10:13 +02002303 return gRegistry->Add(thread->GetPeer());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002304}
2305
Elliott Hughes475fc232011-10-25 15:00:35 -07002306void Dbg::SuspendVM() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002307 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002308}
2309
2310void Dbg::ResumeVM() {
Sebastien Hertz253fa552014-10-14 17:27:15 +02002311 Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002312}
2313
Elliott Hughes221229c2013-01-08 18:17:50 -08002314JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002315 Thread* self = Thread::Current();
Ian Rogersc0542af2014-09-03 16:16:56 -07002316 ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002317 {
Ian Rogersf3d874c2014-07-17 18:52:42 -07002318 ScopedObjectAccess soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07002319 JDWP::JdwpError error;
2320 peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
Elliott Hughes4e235312011-12-02 11:34:15 -08002321 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002322 if (peer.get() == nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002323 return JDWP::ERR_THREAD_NOT_ALIVE;
2324 }
Ian Rogers4ad5cd32014-11-11 23:08:07 -08002325 // Suspend thread to build stack trace.
Elliott Hughesf327e072013-01-09 16:01:26 -08002326 bool timed_out;
Brian Carlstromba32de42014-08-27 23:43:46 -07002327 ThreadList* thread_list = Runtime::Current()->GetThreadList();
2328 Thread* thread = thread_list->SuspendThreadByPeer(peer.get(), request_suspension, true,
2329 &timed_out);
Ian Rogersc0542af2014-09-03 16:16:56 -07002330 if (thread != nullptr) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002331 return JDWP::ERR_NONE;
Elliott Hughesf327e072013-01-09 16:01:26 -08002332 } else if (timed_out) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002333 return JDWP::ERR_INTERNAL;
2334 } else {
2335 return JDWP::ERR_THREAD_NOT_ALIVE;
2336 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002337}
2338
Elliott Hughes221229c2013-01-08 18:17:50 -08002339void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002340 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07002341 JDWP::JdwpError error;
2342 mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2343 CHECK(peer != nullptr) << error;
jeffhaoa77f0f62012-12-05 17:19:31 -08002344 Thread* thread;
2345 {
2346 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2347 thread = Thread::FromManagedThread(soa, peer);
2348 }
Ian Rogersc0542af2014-09-03 16:16:56 -07002349 if (thread == nullptr) {
Elliott Hughes4e235312011-12-02 11:34:15 -08002350 LOG(WARNING) << "No such thread for resume: " << peer;
2351 return;
2352 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002353 bool needs_resume;
2354 {
Ian Rogers50b35e22012-10-04 10:09:15 -07002355 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002356 needs_resume = thread->GetSuspendCount() > 0;
2357 }
2358 if (needs_resume) {
Elliott Hughes546b9862012-06-20 16:06:13 -07002359 Runtime::Current()->GetThreadList()->Resume(thread, true);
2360 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002361}
2362
2363void Dbg::SuspendSelf() {
Elliott Hughes475fc232011-10-25 15:00:35 -07002364 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002365}
2366
Ian Rogers0399dde2012-06-06 17:09:28 -07002367struct GetThisVisitor : public StackVisitor {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002368 GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
Ian Rogersb726dcb2012-09-05 08:57:23 -07002369 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002370 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2371 this_object(nullptr),
2372 frame_id(frame_id_in) {}
Ian Rogers0399dde2012-06-06 17:09:28 -07002373
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002374 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2375 // annotalysis.
2376 virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002377 if (frame_id != GetFrameId()) {
Ian Rogers0399dde2012-06-06 17:09:28 -07002378 return true; // continue
Ian Rogers0399dde2012-06-06 17:09:28 -07002379 } else {
Ian Rogers62d6c772013-02-27 08:32:07 -08002380 this_object = GetThisObject();
2381 return false;
Ian Rogers0399dde2012-06-06 17:09:28 -07002382 }
Elliott Hughes86b00102011-12-05 17:54:26 -08002383 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002384
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002385 mirror::Object* this_object;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002386 JDWP::FrameId frame_id;
Ian Rogers0399dde2012-06-06 17:09:28 -07002387};
2388
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002389JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2390 JDWP::ObjectId* result) {
2391 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002392 JDWP::JdwpError error;
2393 Thread* thread = DecodeThread(soa, thread_id, &error);
2394 if (error != JDWP::ERR_NONE) {
2395 return error;
2396 }
2397 if (!IsSuspendedForDebugger(soa, thread)) {
2398 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002399 }
Ian Rogers700a4022014-05-19 16:49:03 -07002400 std::unique_ptr<Context> context(Context::Create());
Ian Rogers7a22fa62013-01-23 12:16:16 -08002401 GetThisVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002402 visitor.WalkStack();
Elliott Hughes6e9d22c2012-06-22 15:02:37 -07002403 *result = gRegistry->Add(visitor.this_object);
2404 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002405}
2406
Sebastien Hertz8009f392014-09-01 17:07:11 +02002407// Walks the stack until we find the frame with the given FrameId.
2408class FindFrameVisitor FINAL : public StackVisitor {
2409 public:
2410 FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
2411 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002412 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2413 frame_id_(frame_id),
2414 error_(JDWP::ERR_INVALID_FRAMEID) {}
Ian Rogersca190662012-06-26 15:45:57 -07002415
Sebastien Hertz8009f392014-09-01 17:07:11 +02002416 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2417 // annotalysis.
2418 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2419 if (GetFrameId() != frame_id_) {
2420 return true; // Not our frame, carry on.
Ian Rogers0399dde2012-06-06 17:09:28 -07002421 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002422 ArtMethod* m = GetMethod();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002423 if (m->IsNative()) {
2424 // We can't read/write local value from/into native method.
2425 error_ = JDWP::ERR_OPAQUE_FRAME;
2426 } else {
2427 // We found our frame.
2428 error_ = JDWP::ERR_NONE;
2429 }
2430 return false;
2431 }
2432
2433 JDWP::JdwpError GetError() const {
2434 return error_;
2435 }
2436
2437 private:
2438 const JDWP::FrameId frame_id_;
2439 JDWP::JdwpError error_;
2440};
2441
2442JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2443 JDWP::ObjectId thread_id = request->ReadThreadId();
2444 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002445
2446 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002447 JDWP::JdwpError error;
2448 Thread* thread = DecodeThread(soa, thread_id, &error);
2449 if (error != JDWP::ERR_NONE) {
2450 return error;
2451 }
2452 if (!IsSuspendedForDebugger(soa, thread)) {
2453 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002454 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002455 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002456 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002457 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002458 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002459 if (visitor.GetError() != JDWP::ERR_NONE) {
2460 return visitor.GetError();
2461 }
2462
2463 // Read the values from visitor's context.
2464 int32_t slot_count = request->ReadSigned32("slot count");
2465 expandBufAdd4BE(pReply, slot_count); /* "int values" */
2466 for (int32_t i = 0; i < slot_count; ++i) {
2467 uint32_t slot = request->ReadUnsigned32("slot");
2468 JDWP::JdwpTag reqSigByte = request->ReadTag();
2469
2470 VLOG(jdwp) << " --> slot " << slot << " " << reqSigByte;
2471
2472 size_t width = Dbg::GetTagWidth(reqSigByte);
Sebastien Hertz7d955652014-10-22 10:57:10 +02002473 uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
Sebastien Hertz69206392015-04-07 15:54:25 +02002474 error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002475 if (error != JDWP::ERR_NONE) {
2476 return error;
2477 }
2478 }
2479 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002480}
2481
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002482constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2483
2484static std::string GetStackContextAsString(const StackVisitor& visitor)
2485 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2486 return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
2487 PrettyMethod(visitor.GetMethod()).c_str());
2488}
2489
2490static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2491 JDWP::JdwpTag tag)
2492 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2493 LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2494 << GetStackContextAsString(visitor);
2495 return kStackFrameLocalAccessError;
2496}
2497
Sebastien Hertz8009f392014-09-01 17:07:11 +02002498JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2499 int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002500 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002501 JDWP::JdwpError error = JDWP::ERR_NONE;
2502 uint16_t vreg = DemangleSlot(slot, m, &error);
2503 if (error != JDWP::ERR_NONE) {
2504 return error;
2505 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002506 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002507 switch (tag) {
2508 case JDWP::JT_BOOLEAN: {
2509 CHECK_EQ(width, 1U);
2510 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002511 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2512 return FailGetLocalValue(visitor, vreg, tag);
Ian Rogers0399dde2012-06-06 17:09:28 -07002513 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002514 VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2515 JDWP::Set1(buf + 1, intVal != 0);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002516 break;
Ian Rogers0399dde2012-06-06 17:09:28 -07002517 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002518 case JDWP::JT_BYTE: {
2519 CHECK_EQ(width, 1U);
2520 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002521 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2522 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002523 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002524 VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2525 JDWP::Set1(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002526 break;
2527 }
2528 case JDWP::JT_SHORT:
2529 case JDWP::JT_CHAR: {
2530 CHECK_EQ(width, 2U);
2531 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002532 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2533 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002534 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002535 VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2536 JDWP::Set2BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002537 break;
2538 }
2539 case JDWP::JT_INT: {
2540 CHECK_EQ(width, 4U);
2541 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002542 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2543 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002544 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002545 VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2546 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002547 break;
2548 }
2549 case JDWP::JT_FLOAT: {
2550 CHECK_EQ(width, 4U);
2551 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002552 if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2553 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002554 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002555 VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2556 JDWP::Set4BE(buf + 1, intVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002557 break;
2558 }
2559 case JDWP::JT_ARRAY:
2560 case JDWP::JT_CLASS_LOADER:
2561 case JDWP::JT_CLASS_OBJECT:
2562 case JDWP::JT_OBJECT:
2563 case JDWP::JT_STRING:
2564 case JDWP::JT_THREAD:
2565 case JDWP::JT_THREAD_GROUP: {
2566 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2567 uint32_t intVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002568 if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2569 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002570 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002571 mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2572 VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2573 if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2574 LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2575 reinterpret_cast<uintptr_t>(o), vreg)
2576 << GetStackContextAsString(visitor);
2577 UNREACHABLE();
2578 }
2579 tag = TagFromObject(soa, o);
2580 JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002581 break;
2582 }
2583 case JDWP::JT_DOUBLE: {
2584 CHECK_EQ(width, 8U);
2585 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002586 if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2587 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002588 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002589 VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2590 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002591 break;
2592 }
2593 case JDWP::JT_LONG: {
2594 CHECK_EQ(width, 8U);
2595 uint64_t longVal;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002596 if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2597 return FailGetLocalValue(visitor, vreg, tag);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002598 }
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002599 VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2600 JDWP::Set8BE(buf + 1, longVal);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002601 break;
2602 }
2603 default:
2604 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002605 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002606 }
Ian Rogers0399dde2012-06-06 17:09:28 -07002607
Sebastien Hertz8009f392014-09-01 17:07:11 +02002608 // Prepend tag, which may have been updated.
2609 JDWP::Set1(buf, tag);
2610 return JDWP::ERR_NONE;
2611}
2612
2613JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2614 JDWP::ObjectId thread_id = request->ReadThreadId();
2615 JDWP::FrameId frame_id = request->ReadFrameId();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002616
2617 ScopedObjectAccessUnchecked soa(Thread::Current());
Sebastien Hertz69206392015-04-07 15:54:25 +02002618 JDWP::JdwpError error;
2619 Thread* thread = DecodeThread(soa, thread_id, &error);
2620 if (error != JDWP::ERR_NONE) {
2621 return error;
2622 }
2623 if (!IsSuspendedForDebugger(soa, thread)) {
2624 return JDWP::ERR_THREAD_NOT_SUSPENDED;
Elliott Hughes221229c2013-01-08 18:17:50 -08002625 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002626 // Find the frame with the given frame_id.
Ian Rogers700a4022014-05-19 16:49:03 -07002627 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz8009f392014-09-01 17:07:11 +02002628 FindFrameVisitor visitor(thread, context.get(), frame_id);
Ian Rogers0399dde2012-06-06 17:09:28 -07002629 visitor.WalkStack();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002630 if (visitor.GetError() != JDWP::ERR_NONE) {
2631 return visitor.GetError();
2632 }
2633
2634 // Writes the values into visitor's context.
2635 int32_t slot_count = request->ReadSigned32("slot count");
2636 for (int32_t i = 0; i < slot_count; ++i) {
2637 uint32_t slot = request->ReadUnsigned32("slot");
2638 JDWP::JdwpTag sigByte = request->ReadTag();
2639 size_t width = Dbg::GetTagWidth(sigByte);
2640 uint64_t value = request->ReadValue(width);
2641
2642 VLOG(jdwp) << " --> slot " << slot << " " << sigByte << " " << value;
Sebastien Hertz69206392015-04-07 15:54:25 +02002643 error = Dbg::SetLocalValue(visitor, slot, sigByte, value, width);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002644 if (error != JDWP::ERR_NONE) {
2645 return error;
2646 }
2647 }
2648 return JDWP::ERR_NONE;
2649}
2650
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002651template<typename T>
2652static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2653 JDWP::JdwpTag tag, T value)
2654 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2655 LOG(ERROR) << "Failed to write " << tag << " local " << value
2656 << " (0x" << std::hex << value << ") into register v" << vreg
2657 << GetStackContextAsString(visitor);
2658 return kStackFrameLocalAccessError;
2659}
2660
Sebastien Hertz8009f392014-09-01 17:07:11 +02002661JDWP::JdwpError Dbg::SetLocalValue(StackVisitor& visitor, int slot, JDWP::JdwpTag tag,
2662 uint64_t value, size_t width) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002663 ArtMethod* m = visitor.GetMethod();
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002664 JDWP::JdwpError error = JDWP::ERR_NONE;
2665 uint16_t vreg = DemangleSlot(slot, m, &error);
2666 if (error != JDWP::ERR_NONE) {
2667 return error;
2668 }
Sebastien Hertz8009f392014-09-01 17:07:11 +02002669 // TODO: check that the tag is compatible with the actual type of the slot!
Sebastien Hertz8009f392014-09-01 17:07:11 +02002670 switch (tag) {
2671 case JDWP::JT_BOOLEAN:
2672 case JDWP::JT_BYTE:
2673 CHECK_EQ(width, 1U);
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_SHORT:
2679 case JDWP::JT_CHAR:
2680 CHECK_EQ(width, 2U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002681 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2682 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002683 }
2684 break;
2685 case JDWP::JT_INT:
2686 CHECK_EQ(width, 4U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002687 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2688 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002689 }
2690 break;
2691 case JDWP::JT_FLOAT:
2692 CHECK_EQ(width, 4U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002693 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
2694 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002695 }
2696 break;
2697 case JDWP::JT_ARRAY:
2698 case JDWP::JT_CLASS_LOADER:
2699 case JDWP::JT_CLASS_OBJECT:
2700 case JDWP::JT_OBJECT:
2701 case JDWP::JT_STRING:
2702 case JDWP::JT_THREAD:
2703 case JDWP::JT_THREAD_GROUP: {
2704 CHECK_EQ(width, sizeof(JDWP::ObjectId));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002705 mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2706 &error);
2707 if (error != JDWP::ERR_NONE) {
2708 VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2709 return JDWP::ERR_INVALID_OBJECT;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002710 }
2711 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
2712 kReferenceVReg)) {
2713 return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
Sebastien Hertz8009f392014-09-01 17:07:11 +02002714 }
2715 break;
2716 }
2717 case JDWP::JT_DOUBLE: {
2718 CHECK_EQ(width, 8U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002719 if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
2720 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002721 }
2722 break;
2723 }
2724 case JDWP::JT_LONG: {
2725 CHECK_EQ(width, 8U);
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002726 if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
2727 return FailSetLocalValue(visitor, vreg, tag, value);
Sebastien Hertz8009f392014-09-01 17:07:11 +02002728 }
2729 break;
2730 }
2731 default:
2732 LOG(FATAL) << "Unknown tag " << tag;
Sebastien Hertzabbabc82015-03-26 08:47:47 +01002733 UNREACHABLE();
Sebastien Hertz8009f392014-09-01 17:07:11 +02002734 }
2735 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002736}
2737
Mathieu Chartiere401d142015-04-22 13:56:20 -07002738static void SetEventLocation(JDWP::EventLocation* location, ArtMethod* m, uint32_t dex_pc)
Sebastien Hertz6995c602014-09-09 12:10:13 +02002739 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2740 DCHECK(location != nullptr);
2741 if (m == nullptr) {
2742 memset(location, 0, sizeof(*location));
2743 } else {
2744 location->method = m;
2745 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002746 }
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002747}
2748
Mathieu Chartiere401d142015-04-22 13:56:20 -07002749void Dbg::PostLocationEvent(ArtMethod* m, int dex_pc, mirror::Object* this_object,
Jeff Hao579b0242013-11-18 13:16:49 -08002750 int event_flags, const JValue* return_value) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002751 if (!IsDebuggerActive()) {
2752 return;
2753 }
2754 DCHECK(m != nullptr);
2755 DCHECK_EQ(m->IsStatic(), this_object == nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002756 JDWP::EventLocation location;
2757 SetEventLocation(&location, m, dex_pc);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002758
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002759 // We need to be sure no exception is pending when calling JdwpState::PostLocationEvent.
2760 // This is required to be able to call JNI functions to create JDWP ids. To achieve this,
2761 // we temporarily clear the current thread's exception (if any) and will restore it after
2762 // the call.
2763 // Note: the only way to get a pending exception here is to suspend on a move-exception
2764 // instruction.
2765 Thread* const self = Thread::Current();
2766 StackHandleScope<1> hs(self);
2767 Handle<mirror::Throwable> pending_exception(hs.NewHandle(self->GetException()));
2768 self->ClearException();
2769 if (kIsDebugBuild && pending_exception.Get() != nullptr) {
2770 const DexFile::CodeItem* code_item = location.method->GetCodeItem();
2771 const Instruction* instr = Instruction::At(&code_item->insns_[location.dex_pc]);
2772 CHECK_EQ(Instruction::MOVE_EXCEPTION, instr->Opcode());
2773 }
2774
Sebastien Hertz6995c602014-09-09 12:10:13 +02002775 gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
Sebastien Hertzde48aa62015-05-26 11:53:39 +02002776
2777 if (pending_exception.Get() != nullptr) {
2778 self->SetException(pending_exception.Get());
2779 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002780}
2781
Mathieu Chartiere401d142015-04-22 13:56:20 -07002782void Dbg::PostFieldAccessEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002783 mirror::Object* this_object, ArtField* f) {
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002784 if (!IsDebuggerActive()) {
2785 return;
2786 }
2787 DCHECK(m != nullptr);
2788 DCHECK(f != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002789 JDWP::EventLocation location;
2790 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002791
Sebastien Hertz6995c602014-09-09 12:10:13 +02002792 gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002793}
2794
Mathieu Chartiere401d142015-04-22 13:56:20 -07002795void Dbg::PostFieldModificationEvent(ArtMethod* m, int dex_pc,
Mathieu Chartierc7853442015-03-27 14:35:38 -07002796 mirror::Object* this_object, ArtField* f,
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002797 const JValue* field_value) {
2798 if (!IsDebuggerActive()) {
2799 return;
2800 }
2801 DCHECK(m != nullptr);
2802 DCHECK(f != nullptr);
2803 DCHECK(field_value != nullptr);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002804 JDWP::EventLocation location;
2805 SetEventLocation(&location, m, dex_pc);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002806
Sebastien Hertz6995c602014-09-09 12:10:13 +02002807 gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
Sebastien Hertz3f52eaf2014-04-04 17:50:18 +02002808}
2809
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002810/**
2811 * Finds the location where this exception will be caught. We search until we reach the top
2812 * frame, in which case this exception is considered uncaught.
2813 */
2814class CatchLocationFinder : public StackVisitor {
2815 public:
2816 CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
2817 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01002818 : StackVisitor(self, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002819 self_(self),
2820 exception_(exception),
2821 handle_scope_(self),
2822 this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002823 catch_method_(nullptr),
2824 throw_method_(nullptr),
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002825 catch_dex_pc_(DexFile::kDexNoIndex),
2826 throw_dex_pc_(DexFile::kDexNoIndex) {
2827 }
2828
2829 bool VisitFrame() OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002830 ArtMethod* method = GetMethod();
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002831 DCHECK(method != nullptr);
2832 if (method->IsRuntimeMethod()) {
2833 // Ignore callee save method.
2834 DCHECK(method->IsCalleeSaveMethod());
2835 return true;
2836 }
2837
2838 uint32_t dex_pc = GetDexPc();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002839 if (throw_method_ == nullptr) {
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002840 // First Java method found. It is either the method that threw the exception,
2841 // or the Java native method that is reporting an exception thrown by
2842 // native code.
2843 this_at_throw_.Assign(GetThisObject());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002844 throw_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002845 throw_dex_pc_ = dex_pc;
2846 }
2847
2848 if (dex_pc != DexFile::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002849 StackHandleScope<1> hs(self_);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002850 uint32_t found_dex_pc;
2851 Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002852 bool unused_clear_exception;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002853 found_dex_pc = method->FindCatchBlock(exception_class, dex_pc, &unused_clear_exception);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002854 if (found_dex_pc != DexFile::kDexNoIndex) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002855 catch_method_ = method;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002856 catch_dex_pc_ = found_dex_pc;
2857 return false; // End stack walk.
2858 }
2859 }
2860 return true; // Continue stack walk.
2861 }
2862
Mathieu Chartiere401d142015-04-22 13:56:20 -07002863 ArtMethod* GetCatchMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2864 return catch_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002865 }
2866
Mathieu Chartiere401d142015-04-22 13:56:20 -07002867 ArtMethod* GetThrowMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2868 return throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002869 }
2870
2871 mirror::Object* GetThisAtThrow() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2872 return this_at_throw_.Get();
2873 }
2874
2875 uint32_t GetCatchDexPc() const {
2876 return catch_dex_pc_;
2877 }
2878
2879 uint32_t GetThrowDexPc() const {
2880 return throw_dex_pc_;
2881 }
2882
2883 private:
2884 Thread* const self_;
2885 const Handle<mirror::Throwable>& exception_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002886 StackHandleScope<1> handle_scope_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002887 MutableHandle<mirror::Object> this_at_throw_;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002888 ArtMethod* catch_method_;
2889 ArtMethod* throw_method_;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002890 uint32_t catch_dex_pc_;
2891 uint32_t throw_dex_pc_;
2892
2893 DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
2894};
2895
2896void Dbg::PostException(mirror::Throwable* exception_object) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07002897 if (!IsDebuggerActive()) {
Ian Rogers0ad5bb82011-12-07 10:16:32 -08002898 return;
2899 }
Sebastien Hertz261bc042015-04-08 09:36:07 +02002900 Thread* const self = Thread::Current();
2901 StackHandleScope<1> handle_scope(self);
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002902 Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
2903 std::unique_ptr<Context> context(Context::Create());
Sebastien Hertz261bc042015-04-08 09:36:07 +02002904 CatchLocationFinder clf(self, h_exception, context.get());
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002905 clf.WalkStack(/* include_transitions */ false);
Sebastien Hertz6995c602014-09-09 12:10:13 +02002906 JDWP::EventLocation exception_throw_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002907 SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
Sebastien Hertz6995c602014-09-09 12:10:13 +02002908 JDWP::EventLocation exception_catch_location;
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002909 SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
Elliott Hughes4740cdf2011-12-07 14:07:12 -08002910
Nicolas Geoffray14691c52015-03-05 10:40:17 +00002911 gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
2912 clf.GetThisAtThrow());
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002913}
2914
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002915void Dbg::PostClassPrepare(mirror::Class* c) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07002916 if (!IsDebuggerActive()) {
Elliott Hughes4740cdf2011-12-07 14:07:12 -08002917 return;
2918 }
Sebastien Hertz6995c602014-09-09 12:10:13 +02002919 gJdwpState->PostClassPrepare(c);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07002920}
2921
Ian Rogers62d6c772013-02-27 08:32:07 -08002922void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
Mathieu Chartiere401d142015-04-22 13:56:20 -07002923 ArtMethod* m, uint32_t dex_pc,
Sebastien Hertz8379b222014-02-24 17:38:15 +01002924 int event_flags, const JValue* return_value) {
Ian Rogers62d6c772013-02-27 08:32:07 -08002925 if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
Elliott Hughes2aa2e392012-02-17 17:15:43 -08002926 return;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002927 }
2928
Elliott Hughes86964332012-02-15 19:37:42 -08002929 if (IsBreakpoint(m, dex_pc)) {
2930 event_flags |= kBreakpoint;
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002931 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002932
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002933 // If the debugger is single-stepping one of our threads, check to
2934 // see if we're that thread and we've reached a step point.
2935 const SingleStepControl* single_step_control = thread->GetSingleStepControl();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002936 if (single_step_control != nullptr) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002937 CHECK(!m->IsNative());
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002938 if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002939 // Step into method calls. We break when the line number
2940 // or method pointer changes. If we're in SS_MIN mode, we
2941 // always stop.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002942 if (single_step_control->GetMethod() != m) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002943 event_flags |= kSingleStep;
2944 VLOG(jdwp) << "SS new method";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002945 } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002946 event_flags |= kSingleStep;
2947 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02002948 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002949 event_flags |= kSingleStep;
2950 VLOG(jdwp) << "SS new line";
2951 }
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002952 } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002953 // Step over method calls. We break when the line number is
2954 // different and the frame depth is <= the original frame
2955 // depth. (We can't just compare on the method, because we
2956 // might get unrolled past it by an exception, and it's tricky
2957 // to identify recursion.)
2958
2959 int stack_depth = GetStackDepth(thread);
2960
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002961 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002962 // Popped up one or more frames, always trigger.
2963 event_flags |= kSingleStep;
2964 VLOG(jdwp) << "SS method pop";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002965 } else if (stack_depth == single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002966 // Same depth, see if we moved.
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002967 if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
Elliott Hughes86964332012-02-15 19:37:42 -08002968 event_flags |= kSingleStep;
2969 VLOG(jdwp) << "SS new instruction";
Sebastien Hertzbb43b432014-04-14 11:59:08 +02002970 } else if (single_step_control->ContainsDexPc(dex_pc)) {
Elliott Hughes2435a572012-02-17 16:07:41 -08002971 event_flags |= kSingleStep;
2972 VLOG(jdwp) << "SS new line";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002973 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002974 }
2975 } else {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002976 CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002977 // Return from the current method. We break when the frame
2978 // depth pops up.
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002979
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002980 // This differs from the "method exit" break in that it stops
2981 // with the PC at the next instruction in the returned-to
2982 // function, rather than the end of the returning function.
Elliott Hughes86964332012-02-15 19:37:42 -08002983
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002984 int stack_depth = GetStackDepth(thread);
Sebastien Hertz597c4f02015-01-26 17:37:14 +01002985 if (stack_depth < single_step_control->GetStackDepth()) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01002986 event_flags |= kSingleStep;
2987 VLOG(jdwp) << "SS method pop";
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002988 }
2989 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002990 }
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002991
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002992 // If there's something interesting going on, see if it matches one
2993 // of the debugger filters.
2994 if (event_flags != 0) {
Sebastien Hertz8379b222014-02-24 17:38:15 +01002995 Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
Elliott Hughes91bf6cd2012-02-14 17:27:48 -08002996 }
2997}
2998
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02002999size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
3000 switch (instrumentation_event) {
3001 case instrumentation::Instrumentation::kMethodEntered:
3002 return &method_enter_event_ref_count_;
3003 case instrumentation::Instrumentation::kMethodExited:
3004 return &method_exit_event_ref_count_;
3005 case instrumentation::Instrumentation::kDexPcMoved:
3006 return &dex_pc_change_event_ref_count_;
3007 case instrumentation::Instrumentation::kFieldRead:
3008 return &field_read_event_ref_count_;
3009 case instrumentation::Instrumentation::kFieldWritten:
3010 return &field_write_event_ref_count_;
3011 case instrumentation::Instrumentation::kExceptionCaught:
3012 return &exception_catch_event_ref_count_;
3013 default:
3014 return nullptr;
3015 }
3016}
3017
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003018// Process request while all mutator threads are suspended.
3019void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003020 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003021 switch (request.GetKind()) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003022 case DeoptimizationRequest::kNothing:
3023 LOG(WARNING) << "Ignoring empty deoptimization request.";
3024 break;
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003025 case DeoptimizationRequest::kRegisterForEvent:
3026 VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003027 request.InstrumentationEvent());
3028 instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
3029 instrumentation_events_ |= request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003030 break;
3031 case DeoptimizationRequest::kUnregisterForEvent:
3032 VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003033 request.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003034 instrumentation->RemoveListener(&gDebugInstrumentationListener,
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003035 request.InstrumentationEvent());
3036 instrumentation_events_ &= ~request.InstrumentationEvent();
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003037 break;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003038 case DeoptimizationRequest::kFullDeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003039 VLOG(jdwp) << "Deoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003040 instrumentation->DeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003041 VLOG(jdwp) << "Deoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003042 break;
3043 case DeoptimizationRequest::kFullUndeoptimization:
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003044 VLOG(jdwp) << "Undeoptimize the world ...";
Sebastien Hertz0462c4c2015-04-01 16:34:17 +02003045 instrumentation->UndeoptimizeEverything(kDbgInstrumentationKey);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003046 VLOG(jdwp) << "Undeoptimize the world DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003047 break;
3048 case DeoptimizationRequest::kSelectiveDeoptimization:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003049 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " ...";
3050 instrumentation->Deoptimize(request.Method());
3051 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003052 break;
3053 case DeoptimizationRequest::kSelectiveUndeoptimization:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003054 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " ...";
3055 instrumentation->Undeoptimize(request.Method());
3056 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " DONE";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003057 break;
3058 default:
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003059 LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003060 break;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003061 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003062}
3063
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003064void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003065 if (req.GetKind() == DeoptimizationRequest::kNothing) {
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003066 // Nothing to do.
3067 return;
3068 }
Brian Carlstrom306db812014-09-05 13:01:41 -07003069 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003070 RequestDeoptimizationLocked(req);
3071}
3072
3073void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003074 switch (req.GetKind()) {
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003075 case DeoptimizationRequest::kRegisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003076 DCHECK_NE(req.InstrumentationEvent(), 0u);
3077 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003078 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003079 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003080 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003081 VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003082 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003083 deoptimization_requests_.push_back(req);
3084 }
3085 *counter = *counter + 1;
3086 break;
3087 }
3088 case DeoptimizationRequest::kUnregisterForEvent: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003089 DCHECK_NE(req.InstrumentationEvent(), 0u);
3090 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003091 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003092 req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003093 *counter = *counter - 1;
3094 if (*counter == 0) {
Sebastien Hertz7d2ae432014-05-15 11:26:34 +02003095 VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003096 deoptimization_requests_.size(), req.InstrumentationEvent());
Sebastien Hertz42cd43f2014-05-13 14:15:41 +02003097 deoptimization_requests_.push_back(req);
3098 }
3099 break;
3100 }
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003101 case DeoptimizationRequest::kFullDeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003102 DCHECK(req.Method() == nullptr);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003103 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003104 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3105 << " for full deoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003106 deoptimization_requests_.push_back(req);
3107 }
3108 ++full_deoptimization_event_count_;
3109 break;
3110 }
3111 case DeoptimizationRequest::kFullUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003112 DCHECK(req.Method() == nullptr);
Sebastien Hertze713d932014-05-15 10:48:53 +02003113 DCHECK_GT(full_deoptimization_event_count_, 0U);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003114 --full_deoptimization_event_count_;
3115 if (full_deoptimization_event_count_ == 0) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003116 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3117 << " for full undeoptimization";
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003118 deoptimization_requests_.push_back(req);
3119 }
3120 break;
3121 }
3122 case DeoptimizationRequest::kSelectiveDeoptimization: {
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 deoptimization of " << PrettyMethod(req.Method());
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003126 deoptimization_requests_.push_back(req);
3127 break;
3128 }
3129 case DeoptimizationRequest::kSelectiveUndeoptimization: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003130 DCHECK(req.Method() != nullptr);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003131 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003132 << " for undeoptimization of " << PrettyMethod(req.Method());
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003133 deoptimization_requests_.push_back(req);
3134 break;
3135 }
3136 default: {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003137 LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003138 break;
3139 }
3140 }
3141}
3142
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003143void Dbg::ManageDeoptimization() {
3144 Thread* const self = Thread::Current();
3145 {
3146 // Avoid suspend/resume if there is no pending request.
Brian Carlstrom306db812014-09-05 13:01:41 -07003147 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003148 if (deoptimization_requests_.empty()) {
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003149 return;
3150 }
3151 }
3152 CHECK_EQ(self->GetState(), kRunnable);
3153 self->TransitionFromRunnableToSuspended(kWaitingForDeoptimization);
3154 // We need to suspend mutator threads first.
3155 Runtime* const runtime = Runtime::Current();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -07003156 runtime->GetThreadList()->SuspendAll(__FUNCTION__);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003157 const ThreadState old_state = self->SetStateUnsafe(kRunnable);
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003158 {
Brian Carlstrom306db812014-09-05 13:01:41 -07003159 MutexLock mu(self, *Locks::deoptimization_lock_);
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003160 size_t req_index = 0;
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003161 for (DeoptimizationRequest& request : deoptimization_requests_) {
Sebastien Hertz7ec2f1c2014-03-27 20:06:47 +01003162 VLOG(jdwp) << "Process deoptimization request #" << req_index++;
Sebastien Hertz4d25df32014-03-21 17:44:46 +01003163 ProcessDeoptimizationRequest(request);
3164 }
3165 deoptimization_requests_.clear();
3166 }
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003167 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
3168 runtime->GetThreadList()->ResumeAll();
3169 self->TransitionFromSuspendedToRunnable();
3170}
3171
Mathieu Chartiere401d142015-04-22 13:56:20 -07003172static bool IsMethodPossiblyInlined(Thread* self, ArtMethod* m)
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003173 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003174 const DexFile::CodeItem* code_item = m->GetCodeItem();
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003175 if (code_item == nullptr) {
3176 // TODO We should not be asked to watch location in a native or abstract method so the code item
3177 // should never be null. We could just check we never encounter this case.
3178 return false;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003179 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003180 // Note: method verifier may cause thread suspension.
3181 self->AssertThreadSuspensionIsAllowable();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003182 StackHandleScope<2> hs(self);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003183 mirror::Class* declaring_class = m->GetDeclaringClass();
3184 Handle<mirror::DexCache> dex_cache(hs.NewHandle(declaring_class->GetDexCache()));
3185 Handle<mirror::ClassLoader> class_loader(hs.NewHandle(declaring_class->GetClassLoader()));
Ian Rogers7b078e82014-09-10 14:44:24 -07003186 verifier::MethodVerifier verifier(self, dex_cache->GetDexFile(), dex_cache, class_loader,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003187 &m->GetClassDef(), code_item, m->GetDexMethodIndex(), m,
Mathieu Chartier4306ef82014-12-19 18:41:47 -08003188 m->GetAccessFlags(), false, true, false, true);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003189 // Note: we don't need to verify the method.
3190 return InlineMethodAnalyser::AnalyseMethodCode(&verifier, nullptr);
3191}
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003192
Mathieu Chartiere401d142015-04-22 13:56:20 -07003193static const Breakpoint* FindFirstBreakpointForMethod(ArtMethod* m)
Sebastien Hertzed2be172014-08-19 15:33:43 +02003194 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003195 for (Breakpoint& breakpoint : gBreakpoints) {
3196 if (breakpoint.Method() == m) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003197 return &breakpoint;
3198 }
3199 }
3200 return nullptr;
3201}
3202
Mathieu Chartiere401d142015-04-22 13:56:20 -07003203bool Dbg::MethodHasAnyBreakpoints(ArtMethod* method) {
Mathieu Chartierd8565452015-03-26 09:41:50 -07003204 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3205 return FindFirstBreakpointForMethod(method) != nullptr;
3206}
3207
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003208// Sanity checks all existing breakpoints on the same method.
Mathieu Chartiere401d142015-04-22 13:56:20 -07003209static void SanityCheckExistingBreakpoints(ArtMethod* m,
Sebastien Hertzf3928792014-11-17 19:00:37 +01003210 DeoptimizationRequest::Kind deoptimization_kind)
Sebastien Hertzed2be172014-08-19 15:33:43 +02003211 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003212 for (const Breakpoint& breakpoint : gBreakpoints) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003213 if (breakpoint.Method() == m) {
3214 CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3215 }
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003216 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003217 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3218 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003219 // We should have deoptimized everything but not "selectively" deoptimized this method.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003220 CHECK(instrumentation->AreAllMethodsDeoptimized());
3221 CHECK(!instrumentation->IsDeoptimized(m));
3222 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003223 // We should have "selectively" deoptimized this method.
3224 // Note: while we have not deoptimized everything for this method, we may have done it for
3225 // another event.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003226 CHECK(instrumentation->IsDeoptimized(m));
3227 } else {
3228 // This method does not require deoptimization.
3229 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3230 CHECK(!instrumentation->IsDeoptimized(m));
3231 }
3232}
3233
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003234// Returns the deoptimization kind required to set a breakpoint in a method.
3235// If a breakpoint has already been set, we also return the first breakpoint
3236// through the given 'existing_brkpt' pointer.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003237static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
Mathieu Chartiere401d142015-04-22 13:56:20 -07003238 ArtMethod* m,
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003239 const Breakpoint** existing_brkpt)
Sebastien Hertzf3928792014-11-17 19:00:37 +01003240 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3241 if (!Dbg::RequiresDeoptimization()) {
3242 // We already run in interpreter-only mode so we don't need to deoptimize anything.
3243 VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
3244 << PrettyMethod(m);
3245 return DeoptimizationRequest::kNothing;
3246 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003247 const Breakpoint* first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003248 {
3249 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003250 first_breakpoint = FindFirstBreakpointForMethod(m);
3251 *existing_brkpt = first_breakpoint;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003252 }
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003253
3254 if (first_breakpoint == nullptr) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003255 // There is no breakpoint on this method yet: we need to deoptimize. If this method may be
3256 // inlined, we deoptimize everything; otherwise we deoptimize only this method.
3257 // Note: IsMethodPossiblyInlined goes into the method verifier and may cause thread suspension.
3258 // Therefore we must not hold any lock when we call it.
3259 bool need_full_deoptimization = IsMethodPossiblyInlined(self, m);
3260 if (need_full_deoptimization) {
3261 VLOG(jdwp) << "Need full deoptimization because of possible inlining of method "
3262 << PrettyMethod(m);
3263 return DeoptimizationRequest::kFullDeoptimization;
3264 } else {
3265 // We don't need to deoptimize if the method has not been compiled.
3266 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
3267 const bool is_compiled = class_linker->GetOatMethodQuickCodeFor(m) != nullptr;
3268 if (is_compiled) {
Sebastien Hertz6963e442014-11-26 22:11:27 +01003269 // If the method may be called through its direct code pointer (without loading
3270 // its updated entrypoint), we need full deoptimization to not miss the breakpoint.
3271 if (class_linker->MayBeCalledWithDirectCodePointer(m)) {
3272 VLOG(jdwp) << "Need full deoptimization because of possible direct code call "
3273 << "into image for compiled method " << PrettyMethod(m);
3274 return DeoptimizationRequest::kFullDeoptimization;
3275 } else {
3276 VLOG(jdwp) << "Need selective deoptimization for compiled method " << PrettyMethod(m);
3277 return DeoptimizationRequest::kSelectiveDeoptimization;
3278 }
Sebastien Hertzf3928792014-11-17 19:00:37 +01003279 } else {
3280 // Method is not compiled: we don't need to deoptimize.
3281 VLOG(jdwp) << "No need for deoptimization for non-compiled method " << PrettyMethod(m);
3282 return DeoptimizationRequest::kNothing;
3283 }
3284 }
3285 } else {
3286 // There is at least one breakpoint for this method: we don't need to deoptimize.
3287 // Let's check that all breakpoints are configured the same way for deoptimization.
3288 VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003289 DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
Sebastien Hertzf3928792014-11-17 19:00:37 +01003290 if (kIsDebugBuild) {
3291 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3292 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3293 }
3294 return DeoptimizationRequest::kNothing;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003295 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003296}
3297
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003298// Installs a breakpoint at the specified location. Also indicates through the deoptimization
3299// request if we need to deoptimize.
3300void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3301 Thread* const self = Thread::Current();
Mathieu Chartiere401d142015-04-22 13:56:20 -07003302 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003303 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003304
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003305 const Breakpoint* existing_breakpoint = nullptr;
3306 const DeoptimizationRequest::Kind deoptimization_kind =
3307 GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003308 req->SetKind(deoptimization_kind);
3309 if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3310 req->SetMethod(m);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003311 } else {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003312 CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3313 deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003314 req->SetMethod(nullptr);
Sebastien Hertz138dbfc2013-12-04 18:15:25 +01003315 }
3316
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003317 {
3318 WriterMutexLock mu(self, *Locks::breakpoint_lock_);
Sebastien Hertzabe93e02014-12-17 16:35:50 +01003319 // If there is at least one existing breakpoint on the same method, the new breakpoint
3320 // must have the same deoptimization kind than the existing breakpoint(s).
3321 DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3322 if (existing_breakpoint != nullptr) {
3323 breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3324 } else {
3325 breakpoint_deoptimization_kind = deoptimization_kind;
3326 }
3327 gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003328 VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3329 << gBreakpoints[gBreakpoints.size() - 1];
3330 }
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003331}
3332
3333// Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3334// request if we need to undeoptimize.
3335void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
Sebastien Hertzed2be172014-08-19 15:33:43 +02003336 WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003337 ArtMethod* m = FromMethodId(location->method_id);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003338 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
Sebastien Hertzf3928792014-11-17 19:00:37 +01003339 DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003340 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003341 if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].Method() == m) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003342 VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
Sebastien Hertzf3928792014-11-17 19:00:37 +01003343 deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3344 DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3345 Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003346 gBreakpoints.erase(gBreakpoints.begin() + i);
3347 break;
3348 }
3349 }
3350 const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3351 if (existing_breakpoint == nullptr) {
3352 // There is no more breakpoint on this method: we need to undeoptimize.
Sebastien Hertzf3928792014-11-17 19:00:37 +01003353 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003354 // This method required full deoptimization: we need to undeoptimize everything.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003355 req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3356 req->SetMethod(nullptr);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003357 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003358 // This method required selective deoptimization: we need to undeoptimize only that method.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003359 req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3360 req->SetMethod(m);
Sebastien Hertzf3928792014-11-17 19:00:37 +01003361 } else {
3362 // This method had no need for deoptimization: do nothing.
3363 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3364 req->SetKind(DeoptimizationRequest::kNothing);
3365 req->SetMethod(nullptr);
Sebastien Hertza76a6d42014-03-20 16:40:17 +01003366 }
3367 } else {
3368 // There is at least one breakpoint for this method: we don't need to undeoptimize.
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07003369 req->SetKind(DeoptimizationRequest::kNothing);
3370 req->SetMethod(nullptr);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003371 if (kIsDebugBuild) {
Sebastien Hertzf3928792014-11-17 19:00:37 +01003372 SanityCheckExistingBreakpoints(m, deoptimization_kind);
Sebastien Hertz4d1e9ab2014-09-18 16:03:34 +02003373 }
Elliott Hughes86964332012-02-15 19:37:42 -08003374 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003375}
3376
Mathieu Chartiere401d142015-04-22 13:56:20 -07003377bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003378 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3379 if (ssc == nullptr) {
3380 // If we are not single-stepping, then we don't have to force interpreter.
3381 return false;
3382 }
3383 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3384 // If we are in interpreter only mode, then we don't have to force interpreter.
3385 return false;
3386 }
3387
3388 if (!m->IsNative() && !m->IsProxyMethod()) {
3389 // If we want to step into a method, then we have to force interpreter on that call.
3390 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3391 return true;
3392 }
3393 }
3394 return false;
3395}
3396
Mathieu Chartiere401d142015-04-22 13:56:20 -07003397bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Daniel Mihalyieb076692014-08-22 17:33:31 +02003398 instrumentation::Instrumentation* const instrumentation =
3399 Runtime::Current()->GetInstrumentation();
3400 // If we are in interpreter only mode, then we don't have to force interpreter.
3401 if (instrumentation->InterpretOnly()) {
3402 return false;
3403 }
3404 // We can only interpret pure Java method.
3405 if (m->IsNative() || m->IsProxyMethod()) {
3406 return false;
3407 }
3408 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3409 if (ssc != nullptr) {
3410 // If we want to step into a method, then we have to force interpreter on that call.
3411 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3412 return true;
3413 }
3414 // If we are stepping out from a static initializer, by issuing a step
3415 // in or step over, that was implicitly invoked by calling a static method,
3416 // then we need to step into that method. Having a lower stack depth than
3417 // the one the single step control has indicates that the step originates
3418 // from the static initializer.
3419 if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3420 ssc->GetStackDepth() > GetStackDepth(thread)) {
3421 return true;
3422 }
3423 }
3424 // There are cases where we have to force interpreter on deoptimized methods,
3425 // because in some cases the call will not be performed by invoking an entry
3426 // point that has been replaced by the deoptimization, but instead by directly
3427 // invoking the compiled code of the method, for example.
3428 return instrumentation->IsDeoptimized(m);
3429}
3430
Mathieu Chartiere401d142015-04-22 13:56:20 -07003431bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003432 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003433 if (m == nullptr) {
3434 return false;
3435 }
3436 instrumentation::Instrumentation* const instrumentation =
3437 Runtime::Current()->GetInstrumentation();
3438 // If we are in interpreter only mode, then we don't have to force interpreter.
3439 if (instrumentation->InterpretOnly()) {
3440 return false;
3441 }
3442 // We can only interpret pure Java method.
3443 if (m->IsNative() || m->IsProxyMethod()) {
3444 return false;
3445 }
3446 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3447 if (ssc != nullptr) {
3448 // If we are stepping out from a static initializer, by issuing a step
3449 // out, that was implicitly invoked by calling a static method, then we
3450 // need to step into the caller of that method. Having a lower stack
3451 // depth than the one the single step control has indicates that the
3452 // step originates from the static initializer.
3453 if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3454 ssc->GetStackDepth() > GetStackDepth(thread)) {
3455 return true;
3456 }
3457 }
3458 // If we are returning from a static intializer, that was implicitly
3459 // invoked by calling a static method and the caller is deoptimized,
3460 // then we have to deoptimize the stack without forcing interpreter
3461 // on the static method that was called originally. This problem can
3462 // be solved easily by forcing instrumentation on the called method,
3463 // because the instrumentation exit hook will recognise the need of
3464 // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3465 return instrumentation->IsDeoptimized(m);
3466}
3467
Mathieu Chartiere401d142015-04-22 13:56:20 -07003468bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, ArtMethod* m) {
Mathieu Chartier2cebb242015-04-21 16:50:40 -07003469 // The upcall can be null and in that case we don't need to do anything.
Daniel Mihalyieb076692014-08-22 17:33:31 +02003470 if (m == nullptr) {
3471 return false;
3472 }
3473 instrumentation::Instrumentation* const instrumentation =
3474 Runtime::Current()->GetInstrumentation();
3475 // If we are in interpreter only mode, then we don't have to force interpreter.
3476 if (instrumentation->InterpretOnly()) {
3477 return false;
3478 }
3479 // We can only interpret pure Java method.
3480 if (m->IsNative() || m->IsProxyMethod()) {
3481 return false;
3482 }
3483 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3484 if (ssc != nullptr) {
3485 // The debugger is not interested in what is happening under the level
3486 // of the step, thus we only force interpreter when we are not below of
3487 // the step.
3488 if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3489 return true;
3490 }
3491 }
3492 // We have to require stack deoptimization if the upcall is deoptimized.
3493 return instrumentation->IsDeoptimized(m);
3494}
3495
Jeff Hao449db332013-04-12 18:30:52 -07003496// Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3497// cause suspension if the thread is the current thread.
3498class ScopedThreadSuspension {
3499 public:
Ian Rogers33e95662013-05-20 20:29:14 -07003500 ScopedThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
Sebastien Hertz52d131d2014-03-13 16:17:40 +01003501 LOCKS_EXCLUDED(Locks::thread_list_lock_)
Ian Rogers33e95662013-05-20 20:29:14 -07003502 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) :
Ian Rogersf3d874c2014-07-17 18:52:42 -07003503 thread_(nullptr),
Jeff Hao449db332013-04-12 18:30:52 -07003504 error_(JDWP::ERR_NONE),
3505 self_suspend_(false),
Ian Rogers33e95662013-05-20 20:29:14 -07003506 other_suspend_(false) {
Jeff Hao449db332013-04-12 18:30:52 -07003507 ScopedObjectAccessUnchecked soa(self);
Sebastien Hertz69206392015-04-07 15:54:25 +02003508 thread_ = DecodeThread(soa, thread_id, &error_);
Jeff Hao449db332013-04-12 18:30:52 -07003509 if (error_ == JDWP::ERR_NONE) {
3510 if (thread_ == soa.Self()) {
3511 self_suspend_ = true;
3512 } else {
3513 soa.Self()->TransitionFromRunnableToSuspended(kWaitingForDebuggerSuspension);
Sebastien Hertz6995c602014-09-09 12:10:13 +02003514 jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
Jeff Hao449db332013-04-12 18:30:52 -07003515 bool timed_out;
Ian Rogers4ad5cd32014-11-11 23:08:07 -08003516 ThreadList* thread_list = Runtime::Current()->GetThreadList();
3517 Thread* suspended_thread = thread_list->SuspendThreadByPeer(thread_peer, true, true,
3518 &timed_out);
Jeff Hao449db332013-04-12 18:30:52 -07003519 CHECK_EQ(soa.Self()->TransitionFromSuspendedToRunnable(), kWaitingForDebuggerSuspension);
Ian Rogersf3d874c2014-07-17 18:52:42 -07003520 if (suspended_thread == nullptr) {
Jeff Hao449db332013-04-12 18:30:52 -07003521 // Thread terminated from under us while suspending.
3522 error_ = JDWP::ERR_INVALID_THREAD;
3523 } else {
3524 CHECK_EQ(suspended_thread, thread_);
3525 other_suspend_ = true;
3526 }
3527 }
3528 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003529 }
Elliott Hughes86964332012-02-15 19:37:42 -08003530
Jeff Hao449db332013-04-12 18:30:52 -07003531 Thread* GetThread() const {
3532 return thread_;
3533 }
3534
3535 JDWP::JdwpError GetError() const {
3536 return error_;
3537 }
3538
3539 ~ScopedThreadSuspension() {
3540 if (other_suspend_) {
3541 Runtime::Current()->GetThreadList()->Resume(thread_, true);
3542 }
3543 }
3544
3545 private:
3546 Thread* thread_;
3547 JDWP::JdwpError error_;
3548 bool self_suspend_;
3549 bool other_suspend_;
3550};
3551
3552JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3553 JDWP::JdwpStepDepth step_depth) {
3554 Thread* self = Thread::Current();
3555 ScopedThreadSuspension sts(self, thread_id);
3556 if (sts.GetError() != JDWP::ERR_NONE) {
3557 return sts.GetError();
3558 }
3559
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003560 // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
Elliott Hughes2435a572012-02-17 16:07:41 -08003561 // is for step-out.
Ian Rogers0399dde2012-06-06 17:09:28 -07003562 struct SingleStepStackVisitor : public StackVisitor {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003563 explicit SingleStepStackVisitor(Thread* thread) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
Nicolas Geoffray8e5bd182015-05-06 11:34:34 +01003564 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3565 stack_depth(0),
3566 method(nullptr),
3567 line_number(-1) {}
Ian Rogersca190662012-06-26 15:45:57 -07003568
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003569 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3570 // annotalysis.
3571 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003572 ArtMethod* m = GetMethod();
Ian Rogers0399dde2012-06-06 17:09:28 -07003573 if (!m->IsRuntimeMethod()) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003574 ++stack_depth;
3575 if (method == nullptr) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08003576 mirror::DexCache* dex_cache = m->GetDeclaringClass()->GetDexCache();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003577 method = m;
Ian Rogersc0542af2014-09-03 16:16:56 -07003578 if (dex_cache != nullptr) {
Ian Rogers4445a7e2012-10-05 17:19:13 -07003579 const DexFile& dex_file = *dex_cache->GetDexFile();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003580 line_number = dex_file.GetLineNumFromPC(m, GetDexPc());
Elliott Hughes2435a572012-02-17 16:07:41 -08003581 }
Elliott Hughes86964332012-02-15 19:37:42 -08003582 }
3583 }
Elliott Hughes530fa002012-03-12 11:44:49 -07003584 return true;
Elliott Hughes86964332012-02-15 19:37:42 -08003585 }
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003586
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003587 int stack_depth;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003588 ArtMethod* method;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003589 int32_t line_number;
Elliott Hughes86964332012-02-15 19:37:42 -08003590 };
Jeff Hao449db332013-04-12 18:30:52 -07003591
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003592 Thread* const thread = sts.GetThread();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003593 SingleStepStackVisitor visitor(thread);
Ian Rogers0399dde2012-06-06 17:09:28 -07003594 visitor.WalkStack();
Elliott Hughes86964332012-02-15 19:37:42 -08003595
Elliott Hughes2435a572012-02-17 16:07:41 -08003596 // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
Elliott Hughes2435a572012-02-17 16:07:41 -08003597 struct DebugCallbackContext {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003598 explicit DebugCallbackContext(SingleStepControl* single_step_control_cb,
3599 int32_t line_number_cb, const DexFile::CodeItem* code_item)
Andreas Gampe277ccbd2014-11-03 21:36:10 -08003600 : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
3601 code_item_(code_item), last_pc_valid(false), last_pc(0) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003602 }
3603
Andreas Gampe277ccbd2014-11-03 21:36:10 -08003604 static bool Callback(void* raw_context, uint32_t address, uint32_t line_number_cb) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003605 DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
Andreas Gampe277ccbd2014-11-03 21:36:10 -08003606 if (static_cast<int32_t>(line_number_cb) == context->line_number_) {
Elliott Hughes2435a572012-02-17 16:07:41 -08003607 if (!context->last_pc_valid) {
3608 // Everything from this address until the next line change is ours.
3609 context->last_pc = address;
3610 context->last_pc_valid = true;
3611 }
3612 // Otherwise, if we're already in a valid range for this line,
3613 // just keep going (shouldn't really happen)...
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003614 } else if (context->last_pc_valid) { // and the line number is new
Elliott Hughes2435a572012-02-17 16:07:41 -08003615 // Add everything from the last entry up until here to the set
3616 for (uint32_t dex_pc = context->last_pc; dex_pc < address; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003617 context->single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003618 }
3619 context->last_pc_valid = false;
3620 }
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003621 return false; // There may be multiple entries for any given line.
Elliott Hughes2435a572012-02-17 16:07:41 -08003622 }
3623
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003624 ~DebugCallbackContext() {
Elliott Hughes2435a572012-02-17 16:07:41 -08003625 // If the line number was the last in the position table...
3626 if (last_pc_valid) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003627 size_t end = code_item_->insns_size_in_code_units_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003628 for (uint32_t dex_pc = last_pc; dex_pc < end; ++dex_pc) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003629 single_step_control_->AddDexPc(dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003630 }
3631 }
3632 }
3633
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003634 SingleStepControl* const single_step_control_;
3635 const int32_t line_number_;
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003636 const DexFile::CodeItem* const code_item_;
Elliott Hughes2435a572012-02-17 16:07:41 -08003637 bool last_pc_valid;
3638 uint32_t last_pc;
3639 };
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003640
3641 // Allocate single step.
Sebastien Hertz1558b572015-02-25 15:05:59 +01003642 SingleStepControl* single_step_control =
3643 new (std::nothrow) SingleStepControl(step_size, step_depth,
3644 visitor.stack_depth, visitor.method);
3645 if (single_step_control == nullptr) {
3646 LOG(ERROR) << "Failed to allocate SingleStepControl";
3647 return JDWP::ERR_OUT_OF_MEMORY;
3648 }
3649
Mathieu Chartiere401d142015-04-22 13:56:20 -07003650 ArtMethod* m = single_step_control->GetMethod();
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003651 const int32_t line_number = visitor.line_number;
Sebastien Hertz52f5f932015-05-28 11:00:57 +02003652 // Note: if the thread is not running Java code (pure native thread), there is no "current"
3653 // method on the stack (and no line number either).
3654 if (m != nullptr && !m->IsNative()) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003655 const DexFile::CodeItem* const code_item = m->GetCodeItem();
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003656 DebugCallbackContext context(single_step_control, line_number, code_item);
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003657 m->GetDexFile()->DecodeDebugInfo(code_item, m->IsStatic(), m->GetDexMethodIndex(),
Ian Rogersc0542af2014-09-03 16:16:56 -07003658 DebugCallbackContext::Callback, nullptr, &context);
Elliott Hughes3e2e1a22012-02-21 11:33:41 -08003659 }
Elliott Hughes2435a572012-02-17 16:07:41 -08003660
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003661 // Activate single-step in the thread.
3662 thread->ActivateSingleStepControl(single_step_control);
Elliott Hughes86964332012-02-15 19:37:42 -08003663
Elliott Hughes2435a572012-02-17 16:07:41 -08003664 if (VLOG_IS_ON(jdwp)) {
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003665 VLOG(jdwp) << "Single-step thread: " << *thread;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003666 VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3667 VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
3668 VLOG(jdwp) << "Single-step current method: " << PrettyMethod(single_step_control->GetMethod());
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003669 VLOG(jdwp) << "Single-step current line: " << line_number;
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003670 VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
Elliott Hughes2435a572012-02-17 16:07:41 -08003671 VLOG(jdwp) << "Single-step dex_pc values:";
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003672 for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
Sebastien Hertzbb43b432014-04-14 11:59:08 +02003673 VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
Elliott Hughes2435a572012-02-17 16:07:41 -08003674 }
3675 }
3676
3677 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003678}
3679
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003680void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3681 ScopedObjectAccessUnchecked soa(Thread::Current());
Ian Rogersc0542af2014-09-03 16:16:56 -07003682 JDWP::JdwpError error;
3683 Thread* thread = DecodeThread(soa, thread_id, &error);
Sebastien Hertz87118ed2013-11-26 17:57:18 +01003684 if (error == JDWP::ERR_NONE) {
Sebastien Hertz597c4f02015-01-26 17:37:14 +01003685 thread->DeactivateSingleStepControl();
Sebastien Hertz61b7f1b2013-11-15 15:59:30 +01003686 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003687}
3688
Elliott Hughes45651fd2012-02-21 15:48:20 -08003689static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3690 switch (tag) {
3691 default:
3692 LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
Ian Rogersfc787ec2014-10-09 21:56:44 -07003693 UNREACHABLE();
Elliott Hughes45651fd2012-02-21 15:48:20 -08003694
3695 // Primitives.
3696 case JDWP::JT_BYTE: return 'B';
3697 case JDWP::JT_CHAR: return 'C';
3698 case JDWP::JT_FLOAT: return 'F';
3699 case JDWP::JT_DOUBLE: return 'D';
3700 case JDWP::JT_INT: return 'I';
3701 case JDWP::JT_LONG: return 'J';
3702 case JDWP::JT_SHORT: return 'S';
3703 case JDWP::JT_VOID: return 'V';
3704 case JDWP::JT_BOOLEAN: return 'Z';
3705
3706 // Reference types.
3707 case JDWP::JT_ARRAY:
3708 case JDWP::JT_OBJECT:
3709 case JDWP::JT_STRING:
3710 case JDWP::JT_THREAD:
3711 case JDWP::JT_THREAD_GROUP:
3712 case JDWP::JT_CLASS_LOADER:
3713 case JDWP::JT_CLASS_OBJECT:
3714 return 'L';
3715 }
3716}
3717
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003718JDWP::JdwpError Dbg::PrepareInvokeMethod(uint32_t request_id, JDWP::ObjectId thread_id,
3719 JDWP::ObjectId object_id, JDWP::RefTypeId class_id,
3720 JDWP::MethodId method_id, uint32_t arg_count,
3721 uint64_t arg_values[], JDWP::JdwpTag* arg_types,
3722 uint32_t options) {
3723 Thread* const self = Thread::Current();
3724 CHECK_EQ(self, GetDebugThread()) << "This must be called by the JDWP thread";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003725
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003726 ThreadList* thread_list = Runtime::Current()->GetThreadList();
Ian Rogersc0542af2014-09-03 16:16:56 -07003727 Thread* targetThread = nullptr;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003728 {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003729 ScopedObjectAccessUnchecked soa(self);
Ian Rogersc0542af2014-09-03 16:16:56 -07003730 JDWP::JdwpError error;
3731 targetThread = DecodeThread(soa, thread_id, &error);
Elliott Hughes221229c2013-01-08 18:17:50 -08003732 if (error != JDWP::ERR_NONE) {
3733 LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3734 return error;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003735 }
Sebastien Hertz1558b572015-02-25 15:05:59 +01003736 if (targetThread->GetInvokeReq() != nullptr) {
3737 // Thread is already invoking a method on behalf of the debugger.
3738 LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
3739 return JDWP::ERR_ALREADY_INVOKING;
3740 }
3741 if (!targetThread->IsReadyForDebugInvoke()) {
3742 // Thread is not suspended by an event so it cannot invoke a method.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003743 LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
3744 return JDWP::ERR_INVALID_THREAD;
3745 }
3746
3747 /*
3748 * We currently have a bug where we don't successfully resume the
3749 * target thread if the suspend count is too deep. We're expected to
3750 * require one "resume" for each "suspend", but when asked to execute
3751 * a method we have to resume fully and then re-suspend it back to the
3752 * same level. (The easiest way to cause this is to type "suspend"
3753 * multiple times in jdb.)
3754 *
3755 * It's unclear what this means when the event specifies "resume all"
3756 * and some threads are suspended more deeply than others. This is
3757 * a rare problem, so for now we just prevent it from hanging forever
3758 * by rejecting the method invocation request. Without this, we will
3759 * be stuck waiting on a suspended thread.
3760 */
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003761 int suspend_count;
3762 {
Ian Rogers50b35e22012-10-04 10:09:15 -07003763 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07003764 suspend_count = targetThread->GetSuspendCount();
3765 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08003766 if (suspend_count > 1) {
3767 LOG(ERROR) << *targetThread << " suspend count too deep for method invocation: " << suspend_count;
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003768 return JDWP::ERR_THREAD_SUSPENDED; // Probably not expected here.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003769 }
3770
Ian Rogersc0542af2014-09-03 16:16:56 -07003771 mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
3772 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003773 return JDWP::ERR_INVALID_OBJECT;
3774 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003775
Sebastien Hertz1558b572015-02-25 15:05:59 +01003776 gRegistry->Get<mirror::Object*>(thread_id, &error);
Ian Rogersc0542af2014-09-03 16:16:56 -07003777 if (error != JDWP::ERR_NONE) {
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003778 return JDWP::ERR_INVALID_OBJECT;
3779 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003780
Ian Rogersc0542af2014-09-03 16:16:56 -07003781 mirror::Class* c = DecodeClass(class_id, &error);
3782 if (c == nullptr) {
3783 return error;
Elliott Hughes3f4d58f2012-02-18 20:05:37 -08003784 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003785
Mathieu Chartiere401d142015-04-22 13:56:20 -07003786 ArtMethod* m = FromMethodId(method_id);
Ian Rogersc0542af2014-09-03 16:16:56 -07003787 if (m->IsStatic() != (receiver == nullptr)) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003788 return JDWP::ERR_INVALID_METHODID;
3789 }
3790 if (m->IsStatic()) {
3791 if (m->GetDeclaringClass() != c) {
3792 return JDWP::ERR_INVALID_METHODID;
3793 }
3794 } else {
3795 if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
3796 return JDWP::ERR_INVALID_METHODID;
3797 }
3798 }
3799
3800 // Check the argument list matches the method.
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003801 uint32_t shorty_len = 0;
3802 const char* shorty = m->GetShorty(&shorty_len);
3803 if (shorty_len - 1 != arg_count) {
Elliott Hughes45651fd2012-02-21 15:48:20 -08003804 return JDWP::ERR_ILLEGAL_ARGUMENT;
3805 }
Elliott Hughes09201632013-04-15 15:50:07 -07003806
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003807 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003808 StackHandleScope<2> hs(soa.Self());
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003809 HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
3810 HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
3811 const DexFile::TypeList* types = m->GetParameterTypeList();
3812 for (size_t i = 0; i < arg_count; ++i) {
3813 if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
Elliott Hughes09201632013-04-15 15:50:07 -07003814 return JDWP::ERR_ILLEGAL_ARGUMENT;
3815 }
3816
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003817 if (shorty[i + 1] == 'L') {
3818 // Did we really get an argument of an appropriate reference type?
Ian Rogersa0485602014-12-02 15:48:04 -08003819 mirror::Class* parameter_type =
Mathieu Chartiere401d142015-04-22 13:56:20 -07003820 m->GetClassFromTypeIndex(types->GetTypeItem(i).type_idx_, true);
Ian Rogersc0542af2014-09-03 16:16:56 -07003821 mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
3822 if (error != JDWP::ERR_NONE) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003823 return JDWP::ERR_INVALID_OBJECT;
3824 }
Ian Rogersc0542af2014-09-03 16:16:56 -07003825 if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07003826 return JDWP::ERR_ILLEGAL_ARGUMENT;
3827 }
3828
3829 // Turn the on-the-wire ObjectId into a jobject.
3830 jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
3831 v.l = gRegistry->GetJObject(arg_values[i]);
3832 }
Elliott Hughes09201632013-04-15 15:50:07 -07003833 }
Elliott Hughes45651fd2012-02-21 15:48:20 -08003834 }
3835
Sebastien Hertz1558b572015-02-25 15:05:59 +01003836 // Allocates a DebugInvokeReq.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003837 DebugInvokeReq* req = new (std::nothrow) DebugInvokeReq(request_id, thread_id, receiver, c, m,
3838 options, arg_values, arg_count);
3839 if (req == nullptr) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003840 LOG(ERROR) << "Failed to allocate DebugInvokeReq";
3841 return JDWP::ERR_OUT_OF_MEMORY;
3842 }
3843
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003844 // Attaches the DebugInvokeReq to the target thread so it executes the method when
3845 // it is resumed. Once the invocation completes, the target thread will delete it before
3846 // suspending itself (see ThreadList::SuspendSelfForDebugger).
3847 targetThread->SetDebugInvokeReq(req);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003848 }
3849
3850 // 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 +02003851 // away we're sitting high and dry -- but we must release this before the UndoDebuggerSuspensions
3852 // call.
Elliott Hughesd07986f2011-12-06 18:27:45 -08003853
Elliott Hughesd07986f2011-12-06 18:27:45 -08003854 if ((options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003855 VLOG(jdwp) << " Resuming all threads";
3856 thread_list->UndoDebuggerSuspensions();
3857 } else {
3858 VLOG(jdwp) << " Resuming event thread only";
Elliott Hughesd07986f2011-12-06 18:27:45 -08003859 thread_list->Resume(targetThread, true);
3860 }
3861
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003862 return JDWP::ERR_NONE;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07003863}
3864
3865void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003866 Thread* const self = Thread::Current();
3867 CHECK_NE(self, GetDebugThread()) << "This must be called by the event thread";
3868
3869 ScopedObjectAccess soa(self);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003870
Elliott Hughes81ff3182012-03-23 20:35:56 -07003871 // We can be called while an exception is pending. We need
Elliott Hughesd07986f2011-12-06 18:27:45 -08003872 // to preserve that across the method invocation.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003873 StackHandleScope<1> hs(soa.Self());
3874 Handle<mirror::Throwable> old_exception = hs.NewHandle(soa.Self()->GetException());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003875 soa.Self()->ClearException();
Elliott Hughesd07986f2011-12-06 18:27:45 -08003876
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003877 // Execute the method then sends reply to the debugger.
3878 ExecuteMethodWithoutPendingException(soa, pReq);
3879
3880 // If an exception was pending before the invoke, restore it now.
3881 if (old_exception.Get() != nullptr) {
3882 soa.Self()->SetException(old_exception.Get());
3883 }
3884}
3885
3886// Helper function: write a variable-width value into the output input buffer.
3887static void WriteValue(JDWP::ExpandBuf* pReply, int width, uint64_t value) {
3888 switch (width) {
3889 case 1:
3890 expandBufAdd1(pReply, value);
3891 break;
3892 case 2:
3893 expandBufAdd2BE(pReply, value);
3894 break;
3895 case 4:
3896 expandBufAdd4BE(pReply, value);
3897 break;
3898 case 8:
3899 expandBufAdd8BE(pReply, value);
3900 break;
3901 default:
3902 LOG(FATAL) << width;
3903 UNREACHABLE();
3904 }
3905}
3906
3907void Dbg::ExecuteMethodWithoutPendingException(ScopedObjectAccess& soa, DebugInvokeReq* pReq) {
3908 soa.Self()->AssertNoPendingException();
3909
Elliott Hughesd07986f2011-12-06 18:27:45 -08003910 // Translate the method through the vtable, unless the debugger wants to suppress it.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003911 ArtMethod* m = pReq->method;
3912 size_t image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
Sebastien Hertz1558b572015-02-25 15:05:59 +01003913 if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07003914 ArtMethod* actual_method =
3915 pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m, image_pointer_size);
3916 if (actual_method != m) {
3917 VLOG(jdwp) << "ExecuteMethod translated " << PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01003918 << " to " << PrettyMethod(actual_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07003919 m = actual_method;
Elliott Hughes45651fd2012-02-21 15:48:20 -08003920 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08003921 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07003922 VLOG(jdwp) << "ExecuteMethod " << PrettyMethod(m)
Sebastien Hertz1558b572015-02-25 15:05:59 +01003923 << " receiver=" << pReq->receiver.Read()
Sebastien Hertzd38667a2013-11-25 15:43:54 +01003924 << " arg_count=" << pReq->arg_count;
Mathieu Chartiere401d142015-04-22 13:56:20 -07003925 CHECK(m != nullptr);
Elliott Hughesd07986f2011-12-06 18:27:45 -08003926
Roland Levillain33d69032015-06-18 18:20:59 +01003927 static_assert(sizeof(jvalue) == sizeof(uint64_t), "jvalue and uint64_t have different sizes.");
Elliott Hughesd07986f2011-12-06 18:27:45 -08003928
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003929 // Invoke the method.
Jeff Hao39b6c242015-05-19 20:30:23 -07003930 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(pReq->receiver.Read()));
Mathieu Chartiere401d142015-04-22 13:56:20 -07003931 JValue result = InvokeWithJValues(soa, ref.get(), soa.EncodeMethod(m),
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003932 reinterpret_cast<jvalue*>(pReq->arg_values.get()));
Elliott Hughesd07986f2011-12-06 18:27:45 -08003933
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003934 // Prepare JDWP ids for the reply.
3935 JDWP::JdwpTag result_tag = BasicTagFromDescriptor(m->GetShorty());
3936 const bool is_object_result = (result_tag == JDWP::JT_OBJECT);
3937 StackHandleScope<2> hs(soa.Self());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003938 Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
3939 Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
3940 soa.Self()->ClearException();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003941
3942 if (!IsDebuggerActive()) {
3943 // The debugger detached: we must not re-suspend threads. We also don't need to fill the reply
3944 // because it won't be sent either.
3945 return;
3946 }
3947
3948 JDWP::ObjectId exceptionObjectId = gRegistry->Add(exception);
3949 uint64_t result_value = 0;
3950 if (exceptionObjectId != 0) {
Sebastien Hertz1558b572015-02-25 15:05:59 +01003951 VLOG(jdwp) << " JDWP invocation returning with exception=" << exception.Get()
3952 << " " << exception->Dump();
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003953 result_value = 0;
Sebastien Hertz1558b572015-02-25 15:05:59 +01003954 } else if (is_object_result) {
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003955 /* if no exception was thrown, examine object result more closely */
Sebastien Hertz1558b572015-02-25 15:05:59 +01003956 JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003957 if (new_tag != result_tag) {
3958 VLOG(jdwp) << " JDWP promoted result from " << result_tag << " to " << new_tag;
3959 result_tag = new_tag;
Elliott Hughesd07986f2011-12-06 18:27:45 -08003960 }
3961
Sebastien Hertz1558b572015-02-25 15:05:59 +01003962 // Register the object in the registry and reference its ObjectId. This ensures
3963 // GC safety and prevents from accessing stale reference if the object is moved.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003964 result_value = gRegistry->Add(object_result.Get());
Sebastien Hertz1558b572015-02-25 15:05:59 +01003965 } else {
3966 // Primitive result.
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003967 DCHECK(IsPrimitiveTag(result_tag));
3968 result_value = result.GetJ();
3969 }
3970 const bool is_constructor = m->IsConstructor() && !m->IsStatic();
3971 if (is_constructor) {
3972 // If we invoked a constructor (which actually returns void), return the receiver,
3973 // unless we threw, in which case we return null.
3974 result_tag = JDWP::JT_OBJECT;
3975 if (exceptionObjectId == 0) {
3976 // TODO we could keep the receiver ObjectId in the DebugInvokeReq to avoid looking into the
3977 // object registry.
3978 result_value = GetObjectRegistry()->Add(pReq->receiver.Read());
3979 } else {
3980 result_value = 0;
3981 }
Elliott Hughesd07986f2011-12-06 18:27:45 -08003982 }
3983
Sebastien Hertzcbc50642015-06-01 17:33:12 +02003984 // Suspend other threads if the invoke is not single-threaded.
3985 if ((pReq->options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
3986 soa.Self()->TransitionFromRunnableToSuspended(kWaitingForDebuggerSuspension);
3987 VLOG(jdwp) << " Suspending all threads";
3988 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
3989 soa.Self()->TransitionFromSuspendedToRunnable();
3990 }
3991
3992 VLOG(jdwp) << " --> returned " << result_tag
3993 << StringPrintf(" %#" PRIx64 " (except=%#" PRIx64 ")", result_value,
3994 exceptionObjectId);
3995
3996 // Show detailed debug output.
3997 if (result_tag == JDWP::JT_STRING && exceptionObjectId == 0) {
3998 if (result_value != 0) {
3999 if (VLOG_IS_ON(jdwp)) {
4000 std::string result_string;
4001 JDWP::JdwpError error = Dbg::StringToUtf8(result_value, &result_string);
4002 CHECK_EQ(error, JDWP::ERR_NONE);
4003 VLOG(jdwp) << " string '" << result_string << "'";
4004 }
4005 } else {
4006 VLOG(jdwp) << " string (null)";
4007 }
4008 }
4009
4010 // Attach the reply to DebugInvokeReq so it can be sent to the debugger when the event thread
4011 // is ready to suspend.
4012 BuildInvokeReply(pReq->reply, pReq->request_id, result_tag, result_value, exceptionObjectId);
4013}
4014
4015void Dbg::BuildInvokeReply(JDWP::ExpandBuf* pReply, uint32_t request_id, JDWP::JdwpTag result_tag,
4016 uint64_t result_value, JDWP::ObjectId exception) {
4017 // Make room for the JDWP header since we do not know the size of the reply yet.
4018 JDWP::expandBufAddSpace(pReply, kJDWPHeaderLen);
4019
4020 size_t width = GetTagWidth(result_tag);
4021 JDWP::expandBufAdd1(pReply, result_tag);
4022 if (width != 0) {
4023 WriteValue(pReply, width, result_value);
4024 }
4025 JDWP::expandBufAdd1(pReply, JDWP::JT_OBJECT);
4026 JDWP::expandBufAddObjectId(pReply, exception);
4027
4028 // Now we know the size, we can complete the JDWP header.
4029 uint8_t* buf = expandBufGetBuffer(pReply);
4030 JDWP::Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReply));
4031 JDWP::Set4BE(buf + kJDWPHeaderIdOffset, request_id);
4032 JDWP::Set1(buf + kJDWPHeaderFlagsOffset, kJDWPFlagReply); // flags
4033 JDWP::Set2BE(buf + kJDWPHeaderErrorCodeOffset, JDWP::ERR_NONE);
4034}
4035
4036void Dbg::FinishInvokeMethod(DebugInvokeReq* pReq) {
4037 CHECK_NE(Thread::Current(), GetDebugThread()) << "This must be called by the event thread";
4038
4039 JDWP::ExpandBuf* const pReply = pReq->reply;
4040 CHECK(pReply != nullptr) << "No reply attached to DebugInvokeReq";
4041
4042 // We need to prevent other threads (including JDWP thread) from interacting with the debugger
4043 // while we send the reply but are not yet suspended. The JDWP token will be released just before
4044 // we suspend ourself again (see ThreadList::SuspendSelfForDebugger).
4045 gJdwpState->AcquireJdwpTokenForEvent(pReq->thread_id);
4046
4047 // Send the reply unless the debugger detached before the completion of the method.
4048 if (IsDebuggerActive()) {
4049 const size_t replyDataLength = expandBufGetLength(pReply) - kJDWPHeaderLen;
4050 VLOG(jdwp) << StringPrintf("REPLY INVOKE id=0x%06x (length=%zu)",
4051 pReq->request_id, replyDataLength);
4052
4053 gJdwpState->SendRequest(pReply);
4054 } else {
4055 VLOG(jdwp) << "Not sending invoke reply because debugger detached";
Elliott Hughesd07986f2011-12-06 18:27:45 -08004056 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004057}
4058
Elliott Hughesd07986f2011-12-06 18:27:45 -08004059/*
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004060 * "request" contains a full JDWP packet, possibly with multiple chunks. We
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004061 * need to process each, accumulate the replies, and ship the whole thing
4062 * back.
4063 *
4064 * Returns "true" if we have a reply. The reply buffer is newly allocated,
4065 * and includes the chunk type/length, followed by the data.
4066 *
Elliott Hughes3d30d9b2011-12-07 17:35:48 -08004067 * OLD-TODO: we currently assume that the request and reply include a single
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004068 * chunk. If this becomes inconvenient we will need to adapt.
4069 */
Ian Rogersc0542af2014-09-03 16:16:56 -07004070bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004071 Thread* self = Thread::Current();
4072 JNIEnv* env = self->GetJniEnv();
4073
Ian Rogersc0542af2014-09-03 16:16:56 -07004074 uint32_t type = request->ReadUnsigned32("type");
4075 uint32_t length = request->ReadUnsigned32("length");
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004076
4077 // Create a byte[] corresponding to 'request'.
Ian Rogersc0542af2014-09-03 16:16:56 -07004078 size_t request_length = request->size();
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004079 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(request_length));
Ian Rogersc0542af2014-09-03 16:16:56 -07004080 if (dataArray.get() == nullptr) {
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004081 LOG(WARNING) << "byte[] allocation failed: " << request_length;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004082 env->ExceptionClear();
4083 return false;
4084 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004085 env->SetByteArrayRegion(dataArray.get(), 0, request_length,
4086 reinterpret_cast<const jbyte*>(request->data()));
4087 request->Skip(request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004088
4089 // Run through and find all chunks. [Currently just find the first.]
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004090 ScopedByteArrayRO contents(env, dataArray.get());
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004091 if (length != request_length) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08004092 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004093 return false;
4094 }
4095
4096 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
Elliott Hugheseac76672012-05-24 21:56:51 -07004097 ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4098 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004099 type, dataArray.get(), 0, length));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004100 if (env->ExceptionCheck()) {
4101 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
4102 env->ExceptionDescribe();
4103 env->ExceptionClear();
4104 return false;
4105 }
4106
Ian Rogersc0542af2014-09-03 16:16:56 -07004107 if (chunk.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004108 return false;
4109 }
4110
4111 /*
4112 * Pull the pieces out of the chunk. We copy the results into a
4113 * newly-allocated buffer that the caller can free. We don't want to
4114 * continue using the Chunk object because nothing has a reference to it.
4115 *
4116 * We could avoid this by returning type/data/offset/length and having
4117 * the caller be aware of the object lifetime issues, but that
Elliott Hughes81ff3182012-03-23 20:35:56 -07004118 * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004119 * if we have responses for multiple chunks.
4120 *
4121 * So we're pretty much stuck with copying data around multiple times.
4122 */
Elliott Hugheseac76672012-05-24 21:56:51 -07004123 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 -08004124 jint offset = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
Elliott Hugheseac76672012-05-24 21:56:51 -07004125 length = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
Elliott Hugheseac76672012-05-24 21:56:51 -07004126 type = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004127
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004128 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 -07004129 if (length == 0 || replyData.get() == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004130 return false;
4131 }
4132
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004133 const int kChunkHdrLen = 8;
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004134 uint8_t* reply = new uint8_t[length + kChunkHdrLen];
Ian Rogersc0542af2014-09-03 16:16:56 -07004135 if (reply == nullptr) {
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004136 LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
4137 return false;
4138 }
Elliott Hughesf7c3b662011-10-27 12:04:56 -07004139 JDWP::Set4BE(reply + 0, type);
4140 JDWP::Set4BE(reply + 4, length);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004141 env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004142
4143 *pReplyBuf = reply;
4144 *pReplyLen = length + kChunkHdrLen;
4145
Elliott Hughes4b9702c2013-02-20 18:13:24 -08004146 VLOG(jdwp) << StringPrintf("dvmHandleDdm returning type=%.4s %p len=%d", reinterpret_cast<char*>(reply), reply, length);
Elliott Hughesf6a1e1e2011-10-25 16:28:04 -07004147 return true;
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004148}
4149
Elliott Hughesa2155262011-11-16 16:26:58 -08004150void Dbg::DdmBroadcast(bool connect) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004151 VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
Elliott Hughes47fce012011-10-25 18:37:19 -07004152
4153 Thread* self = Thread::Current();
Ian Rogers50b35e22012-10-04 10:09:15 -07004154 if (self->GetState() != kRunnable) {
4155 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4156 /* try anyway? */
Elliott Hughes47fce012011-10-25 18:37:19 -07004157 }
4158
4159 JNIEnv* env = self->GetJniEnv();
Elliott Hughes47fce012011-10-25 18:37:19 -07004160 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
Elliott Hugheseac76672012-05-24 21:56:51 -07004161 env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4162 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4163 event);
Elliott Hughes47fce012011-10-25 18:37:19 -07004164 if (env->ExceptionCheck()) {
4165 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4166 env->ExceptionDescribe();
4167 env->ExceptionClear();
4168 }
4169}
4170
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004171void Dbg::DdmConnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004172 Dbg::DdmBroadcast(true);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004173}
4174
4175void Dbg::DdmDisconnected() {
Elliott Hughesa2155262011-11-16 16:26:58 -08004176 Dbg::DdmBroadcast(false);
Elliott Hughes47fce012011-10-25 18:37:19 -07004177 gDdmThreadNotification = false;
4178}
4179
4180/*
Elliott Hughes82188472011-11-07 18:11:48 -08004181 * Send a notification when a thread starts, stops, or changes its name.
Elliott Hughes47fce012011-10-25 18:37:19 -07004182 *
4183 * Because we broadcast the full set of threads when the notifications are
4184 * first enabled, it's possible for "thread" to be actively executing.
4185 */
Elliott Hughes82188472011-11-07 18:11:48 -08004186void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004187 if (!gDdmThreadNotification) {
4188 return;
4189 }
4190
Elliott Hughes82188472011-11-07 18:11:48 -08004191 if (type == CHUNK_TYPE("THDE")) {
Elliott Hughes47fce012011-10-25 18:37:19 -07004192 uint8_t buf[4];
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004193 JDWP::Set4BE(&buf[0], t->GetThreadId());
Elliott Hughes47fce012011-10-25 18:37:19 -07004194 Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
Elliott Hughes82188472011-11-07 18:11:48 -08004195 } else {
4196 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004197 ScopedObjectAccessUnchecked soa(Thread::Current());
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07004198 StackHandleScope<1> hs(soa.Self());
4199 Handle<mirror::String> name(hs.NewHandle(t->GetThreadName(soa)));
Ian Rogersc0542af2014-09-03 16:16:56 -07004200 size_t char_count = (name.Get() != nullptr) ? name->GetLength() : 0;
Jeff Hao848f70a2014-01-15 13:49:50 -08004201 const jchar* chars = (name.Get() != nullptr) ? name->GetValue() : nullptr;
Elliott Hughes82188472011-11-07 18:11:48 -08004202
Elliott Hughes21f32d72011-11-09 17:44:13 -08004203 std::vector<uint8_t> bytes;
Ian Rogersd9c4fc92013-10-01 19:45:43 -07004204 JDWP::Append4BE(bytes, t->GetThreadId());
Elliott Hughes545a0642011-11-08 19:10:03 -08004205 JDWP::AppendUtf16BE(bytes, chars, char_count);
Elliott Hughes21f32d72011-11-09 17:44:13 -08004206 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
4207 Dbg::DdmSendChunk(type, bytes);
Elliott Hughes47fce012011-10-25 18:37:19 -07004208 }
4209}
4210
Elliott Hughes47fce012011-10-25 18:37:19 -07004211void Dbg::DdmSetThreadNotification(bool enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004212 // Enable/disable thread notifications.
Elliott Hughes47fce012011-10-25 18:37:19 -07004213 gDdmThreadNotification = enable;
4214 if (enable) {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004215 // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4216 // see a suspension in progress and block until that ends. They then post their own start
4217 // notification.
4218 SuspendVM();
4219 std::list<Thread*> threads;
Ian Rogers50b35e22012-10-04 10:09:15 -07004220 Thread* self = Thread::Current();
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004221 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004222 MutexLock mu(self, *Locks::thread_list_lock_);
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004223 threads = Runtime::Current()->GetThreadList()->GetList();
4224 }
4225 {
Ian Rogers50b35e22012-10-04 10:09:15 -07004226 ScopedObjectAccess soa(self);
Mathieu Chartier02e25112013-08-14 16:14:24 -07004227 for (Thread* thread : threads) {
4228 Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004229 }
4230 }
4231 ResumeVM();
Elliott Hughes47fce012011-10-25 18:37:19 -07004232 }
4233}
4234
Elliott Hughesa2155262011-11-16 16:26:58 -08004235void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
Elliott Hughesc0f09332012-03-26 13:27:06 -07004236 if (IsDebuggerActive()) {
Sebastien Hertz6995c602014-09-09 12:10:13 +02004237 gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004238 }
Elliott Hughes82188472011-11-07 18:11:48 -08004239 Dbg::DdmSendThreadNotification(t, type);
Elliott Hughes47fce012011-10-25 18:37:19 -07004240}
4241
4242void Dbg::PostThreadStart(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004243 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
Elliott Hughes47fce012011-10-25 18:37:19 -07004244}
4245
4246void Dbg::PostThreadDeath(Thread* t) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004247 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004248}
4249
Elliott Hughes82188472011-11-07 18:11:48 -08004250void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004251 CHECK(buf != nullptr);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004252 iovec vec[1];
4253 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
4254 vec[0].iov_len = byte_count;
4255 Dbg::DdmSendChunkV(type, vec, 1);
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004256}
4257
Elliott Hughes21f32d72011-11-09 17:44:13 -08004258void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
4259 DdmSendChunk(type, bytes.size(), &bytes[0]);
4260}
4261
Brian Carlstromf5293522013-07-19 00:24:00 -07004262void Dbg::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004263 if (gJdwpState == nullptr) {
Elliott Hughes4dd9b4d2011-12-12 18:29:24 -08004264 VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
Elliott Hughes3bb81562011-10-21 18:52:59 -07004265 } else {
Elliott Hughescccd84f2011-12-05 16:51:54 -08004266 gJdwpState->DdmSendChunkV(type, iov, iov_count);
Elliott Hughes3bb81562011-10-21 18:52:59 -07004267 }
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004268}
4269
Mathieu Chartierad466ad2015-01-08 16:28:08 -08004270JDWP::JdwpState* Dbg::GetJdwpState() {
4271 return gJdwpState;
4272}
4273
Elliott Hughes767a1472011-10-26 18:49:02 -07004274int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4275 if (when == HPIF_WHEN_NOW) {
Elliott Hughes7162ad92011-10-27 14:08:42 -07004276 DdmSendHeapInfo(when);
Elliott Hughes767a1472011-10-26 18:49:02 -07004277 return true;
4278 }
4279
4280 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4281 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4282 return false;
4283 }
4284
4285 gDdmHpifWhen = when;
4286 return true;
4287}
4288
4289bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4290 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4291 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4292 return false;
4293 }
4294
4295 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4296 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4297 return false;
4298 }
4299
4300 if (native) {
4301 gDdmNhsgWhen = when;
4302 gDdmNhsgWhat = what;
4303 } else {
4304 gDdmHpsgWhen = when;
4305 gDdmHpsgWhat = what;
4306 }
4307 return true;
4308}
4309
Elliott Hughes7162ad92011-10-27 14:08:42 -07004310void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4311 // If there's a one-shot 'when', reset it.
4312 if (reason == gDdmHpifWhen) {
4313 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4314 gDdmHpifWhen = HPIF_WHEN_NEVER;
4315 }
4316 }
4317
4318 /*
4319 * Chunk HPIF (client --> server)
4320 *
4321 * Heap Info. General information about the heap,
4322 * suitable for a summary display.
4323 *
4324 * [u4]: number of heaps
4325 *
4326 * For each heap:
4327 * [u4]: heap ID
4328 * [u8]: timestamp in ms since Unix epoch
4329 * [u1]: capture reason (same as 'when' value from server)
4330 * [u4]: max heap size in bytes (-Xmx)
4331 * [u4]: current heap size in bytes
4332 * [u4]: current number of bytes allocated
4333 * [u4]: current number of objects allocated
4334 */
4335 uint8_t heap_count = 1;
Ian Rogers1d54e732013-05-02 21:10:01 -07004336 gc::Heap* heap = Runtime::Current()->GetHeap();
Elliott Hughes21f32d72011-11-09 17:44:13 -08004337 std::vector<uint8_t> bytes;
Elliott Hughes545a0642011-11-08 19:10:03 -08004338 JDWP::Append4BE(bytes, heap_count);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004339 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
Elliott Hughes545a0642011-11-08 19:10:03 -08004340 JDWP::Append8BE(bytes, MilliTime());
4341 JDWP::Append1BE(bytes, reason);
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004342 JDWP::Append4BE(bytes, heap->GetMaxMemory()); // Max allowed heap size in bytes.
4343 JDWP::Append4BE(bytes, heap->GetTotalMemory()); // Current heap size in bytes.
Elliott Hughesb3bd5f02012-03-08 21:05:27 -08004344 JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4345 JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
Elliott Hughes21f32d72011-11-09 17:44:13 -08004346 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
4347 Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
Elliott Hughes767a1472011-10-26 18:49:02 -07004348}
4349
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004350enum HpsgSolidity {
4351 SOLIDITY_FREE = 0,
4352 SOLIDITY_HARD = 1,
4353 SOLIDITY_SOFT = 2,
4354 SOLIDITY_WEAK = 3,
4355 SOLIDITY_PHANTOM = 4,
4356 SOLIDITY_FINALIZABLE = 5,
4357 SOLIDITY_SWEEP = 6,
4358};
4359
4360enum HpsgKind {
4361 KIND_OBJECT = 0,
4362 KIND_CLASS_OBJECT = 1,
4363 KIND_ARRAY_1 = 2,
4364 KIND_ARRAY_2 = 3,
4365 KIND_ARRAY_4 = 4,
4366 KIND_ARRAY_8 = 5,
4367 KIND_UNKNOWN = 6,
4368 KIND_NATIVE = 7,
4369};
4370
4371#define HPSG_PARTIAL (1<<7)
4372#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4373
Ian Rogers30fab402012-01-23 15:43:46 -08004374class HeapChunkContext {
4375 public:
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004376 // Maximum chunk size. Obtain this from the formula:
4377 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4378 HeapChunkContext(bool merge, bool native)
Ian Rogers30fab402012-01-23 15:43:46 -08004379 : buf_(16384 - 16),
4380 type_(0),
Mathieu Chartier36dab362014-07-30 14:59:56 -07004381 chunk_overhead_(0) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004382 Reset();
4383 if (native) {
Ian Rogers30fab402012-01-23 15:43:46 -08004384 type_ = CHUNK_TYPE("NHSG");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004385 } else {
Ian Rogers30fab402012-01-23 15:43:46 -08004386 type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004387 }
4388 }
4389
4390 ~HeapChunkContext() {
Ian Rogers30fab402012-01-23 15:43:46 -08004391 if (p_ > &buf_[0]) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004392 Flush();
4393 }
4394 }
4395
Mathieu Chartier36dab362014-07-30 14:59:56 -07004396 void SetChunkOverhead(size_t chunk_overhead) {
4397 chunk_overhead_ = chunk_overhead;
4398 }
4399
4400 void ResetStartOfNextChunk() {
4401 startOfNextMemoryChunk_ = nullptr;
4402 }
4403
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004404 void EnsureHeader(const void* chunk_ptr) {
Ian Rogers30fab402012-01-23 15:43:46 -08004405 if (!needHeader_) {
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004406 return;
4407 }
4408
4409 // Start a new HPSx chunk.
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004410 JDWP::Write4BE(&p_, 1); // Heap id (bogus; we only have one heap).
4411 JDWP::Write1BE(&p_, 8); // Size of allocation unit, in bytes.
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004412
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004413 JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
4414 JDWP::Write4BE(&p_, 0); // offset of this piece (relative to the virtual address).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004415 // [u4]: length of piece, in allocation units
4416 // 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 -08004417 pieceLenField_ = p_;
4418 JDWP::Write4BE(&p_, 0x55555555);
4419 needHeader_ = false;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004420 }
4421
Ian Rogersb726dcb2012-09-05 08:57:23 -07004422 void Flush() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004423 if (pieceLenField_ == nullptr) {
Ian Rogersd636b062013-01-18 17:51:18 -08004424 // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4425 CHECK(needHeader_);
4426 return;
4427 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004428 // Patch the "length of piece" field.
Ian Rogers30fab402012-01-23 15:43:46 -08004429 CHECK_LE(&buf_[0], pieceLenField_);
4430 CHECK_LE(pieceLenField_, p_);
4431 JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004432
Ian Rogers30fab402012-01-23 15:43:46 -08004433 Dbg::DdmSendChunk(type_, p_ - &buf_[0], &buf_[0]);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004434 Reset();
4435 }
4436
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004437 static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
Ian Rogersb726dcb2012-09-05 08:57:23 -07004438 SHARED_LOCKS_REQUIRED(Locks::heap_bitmap_lock_,
4439 Locks::mutator_lock_) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004440 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4441 }
4442
4443 static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
4444 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4445 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
Elliott Hughesa2155262011-11-16 16:26:58 -08004446 }
4447
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004448 private:
Elliott Hughesa2155262011-11-16 16:26:58 -08004449 enum { ALLOCATION_UNIT_SIZE = 8 };
4450
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004451 void Reset() {
Ian Rogers30fab402012-01-23 15:43:46 -08004452 p_ = &buf_[0];
Mathieu Chartier36dab362014-07-30 14:59:56 -07004453 ResetStartOfNextChunk();
Ian Rogers30fab402012-01-23 15:43:46 -08004454 totalAllocationUnits_ = 0;
4455 needHeader_ = true;
Ian Rogersc0542af2014-09-03 16:16:56 -07004456 pieceLenField_ = nullptr;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004457 }
4458
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004459 bool IsNative() const {
4460 return type_ == CHUNK_TYPE("NHSG");
4461 }
4462
4463 // Returns true if the object is not an empty chunk.
4464 bool ProcessRecord(void* start, size_t used_bytes) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers30fab402012-01-23 15:43:46 -08004465 // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4466 // in the following code not to allocate memory, by ensuring buf_ is of the correct size
Ian Rogers15bf2d32012-08-28 17:33:04 -07004467 if (used_bytes == 0) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004468 if (start == nullptr) {
4469 // Reset for start of new heap.
4470 startOfNextMemoryChunk_ = nullptr;
4471 Flush();
4472 }
4473 // Only process in use memory so that free region information
4474 // also includes dlmalloc book keeping.
4475 return false;
Elliott Hughesa2155262011-11-16 16:26:58 -08004476 }
Ian Rogersc0542af2014-09-03 16:16:56 -07004477 if (startOfNextMemoryChunk_ != nullptr) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004478 // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4479 // of the use of mmaps, so don't report. If not free memory then start a new segment.
4480 bool flush = true;
4481 if (start > startOfNextMemoryChunk_) {
4482 const size_t kMaxFreeLen = 2 * kPageSize;
4483 void* free_start = startOfNextMemoryChunk_;
4484 void* free_end = start;
4485 const size_t free_len =
4486 reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4487 if (!IsNative() || free_len < kMaxFreeLen) {
4488 AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4489 flush = false;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004490 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004491 }
4492 if (flush) {
4493 startOfNextMemoryChunk_ = nullptr;
4494 Flush();
4495 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004496 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004497 return true;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004498 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004499
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004500 void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
4501 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4502 if (ProcessRecord(start, used_bytes)) {
4503 uint8_t state = ExamineNativeObject(start);
4504 AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4505 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4506 }
4507 }
4508
4509 void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
4510 SHARED_LOCKS_REQUIRED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
4511 if (ProcessRecord(start, used_bytes)) {
4512 // Determine the type of this chunk.
4513 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4514 // If it's the same, we should combine them.
4515 uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4516 AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4517 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4518 }
4519 }
4520
4521 void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
Ian Rogersb726dcb2012-09-05 08:57:23 -07004522 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004523 // Make sure there's enough room left in the buffer.
4524 // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4525 // 17 bytes for any header.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004526 const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4527 size_t byte_left = &buf_.back() - p_;
4528 if (byte_left < needed) {
4529 if (is_native) {
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004530 // Cannot trigger memory allocation while walking native heap.
Pavel Vyssotski7522c742014-12-08 13:38:26 +06004531 return;
4532 }
Ian Rogers15bf2d32012-08-28 17:33:04 -07004533 Flush();
4534 }
4535
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004536 byte_left = &buf_.back() - p_;
4537 if (byte_left < needed) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004538 LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4539 << needed << " bytes)";
4540 return;
4541 }
4542 EnsureHeader(ptr);
Elliott Hughesa2155262011-11-16 16:26:58 -08004543 // Write out the chunk description.
Ian Rogers15bf2d32012-08-28 17:33:04 -07004544 length /= ALLOCATION_UNIT_SIZE; // Convert to allocation units.
4545 totalAllocationUnits_ += length;
4546 while (length > 256) {
Ian Rogers30fab402012-01-23 15:43:46 -08004547 *p_++ = state | HPSG_PARTIAL;
4548 *p_++ = 255; // length - 1
Ian Rogers15bf2d32012-08-28 17:33:04 -07004549 length -= 256;
Elliott Hughesa2155262011-11-16 16:26:58 -08004550 }
Ian Rogers30fab402012-01-23 15:43:46 -08004551 *p_++ = state;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004552 *p_++ = length - 1;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004553 }
4554
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004555 uint8_t ExamineNativeObject(const void* p) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4556 return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4557 }
4558
4559 uint8_t ExamineJavaObject(mirror::Object* o)
Ian Rogersef7d42f2014-01-06 12:55:46 -08004560 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
Ian Rogersc0542af2014-09-03 16:16:56 -07004561 if (o == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004562 return HPSG_STATE(SOLIDITY_FREE, 0);
4563 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004564 // It's an allocated chunk. Figure out what it is.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004565 gc::Heap* heap = Runtime::Current()->GetHeap();
4566 if (!heap->IsLiveObjectLocked(o)) {
4567 LOG(ERROR) << "Invalid object in managed heap: " << o;
Elliott Hughesa2155262011-11-16 16:26:58 -08004568 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4569 }
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08004570 mirror::Class* c = o->GetClass();
Ian Rogersc0542af2014-09-03 16:16:56 -07004571 if (c == nullptr) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004572 // The object was probably just created but hasn't been initialized yet.
4573 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4574 }
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004575 if (!heap->IsValidObjectAddress(c)) {
Ian Rogers15bf2d32012-08-28 17:33:04 -07004576 LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
Elliott Hughesa2155262011-11-16 16:26:58 -08004577 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4578 }
Mathieu Chartierf26e1b32015-01-29 10:47:10 -08004579 if (c->GetClass() == nullptr) {
4580 LOG(ERROR) << "Null class of class " << c << " for object " << o;
4581 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4582 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004583 if (c->IsClassClass()) {
4584 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4585 }
Elliott Hughesa2155262011-11-16 16:26:58 -08004586 if (c->IsArrayClass()) {
Elliott Hughesa2155262011-11-16 16:26:58 -08004587 switch (c->GetComponentSize()) {
4588 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4589 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4590 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4591 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4592 }
4593 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004594 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4595 }
4596
Ian Rogers30fab402012-01-23 15:43:46 -08004597 std::vector<uint8_t> buf_;
4598 uint8_t* p_;
4599 uint8_t* pieceLenField_;
Ian Rogers15bf2d32012-08-28 17:33:04 -07004600 void* startOfNextMemoryChunk_;
Ian Rogers30fab402012-01-23 15:43:46 -08004601 size_t totalAllocationUnits_;
4602 uint32_t type_;
Ian Rogers30fab402012-01-23 15:43:46 -08004603 bool needHeader_;
Mathieu Chartier36dab362014-07-30 14:59:56 -07004604 size_t chunk_overhead_;
Ian Rogers30fab402012-01-23 15:43:46 -08004605
Elliott Hughesa2155262011-11-16 16:26:58 -08004606 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4607};
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004608
Mathieu Chartier36dab362014-07-30 14:59:56 -07004609static void BumpPointerSpaceCallback(mirror::Object* obj, void* arg)
4610 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) EXCLUSIVE_LOCKS_REQUIRED(Locks::heap_bitmap_lock_) {
4611 const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004612 HeapChunkContext::HeapChunkJavaCallback(
Mathieu Chartier36dab362014-07-30 14:59:56 -07004613 obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, arg);
4614}
4615
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004616void Dbg::DdmSendHeapSegments(bool native) {
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004617 Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4618 Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004619 if (when == HPSG_WHEN_NEVER) {
4620 return;
4621 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004622 // Figure out what kind of chunks we'll be sending.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004623 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4624 << static_cast<int>(what);
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004625
4626 // First, send a heap start chunk.
4627 uint8_t heap_id[4];
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004628 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004629 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004630 Thread* self = Thread::Current();
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004631 Locks::mutator_lock_->AssertSharedHeld(self);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -07004632
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004633 // Send a series of heap segment chunks.
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004634 HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
Elliott Hughesa2155262011-11-16 16:26:58 -08004635 if (native) {
Ian Rogers872dd822014-10-30 11:19:14 -07004636#if defined(HAVE_ANDROID_OS) && defined(USE_DLMALLOC)
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004637 dlmalloc_inspect_all(HeapChunkContext::HeapChunkNativeCallback, &context);
4638 HeapChunkContext::HeapChunkNativeCallback(nullptr, nullptr, 0, &context); // Indicate end of a space.
Christopher Ferrisc4ddc042014-05-13 14:47:50 -07004639#else
4640 UNIMPLEMENTED(WARNING) << "Native heap inspection is only supported with dlmalloc";
4641#endif
Elliott Hughesa2155262011-11-16 16:26:58 -08004642 } else {
Ian Rogers1d54e732013-05-02 21:10:01 -07004643 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004644 for (const auto& space : heap->GetContinuousSpaces()) {
4645 if (space->IsDlMallocSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004646 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004647 // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4648 // allocation then the first sizeof(size_t) may belong to it.
4649 context.SetChunkOverhead(sizeof(size_t));
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004650 space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004651 } else if (space->IsRosAllocSpace()) {
4652 context.SetChunkOverhead(0);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004653 // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4654 // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
4655 self->TransitionFromRunnableToSuspended(kSuspended);
4656 ThreadList* tl = Runtime::Current()->GetThreadList();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -07004657 tl->SuspendAll(__FUNCTION__);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004658 {
4659 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004660 space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004661 }
4662 tl->ResumeAll();
4663 self->TransitionFromSuspendedToRunnable();
Mathieu Chartier36dab362014-07-30 14:59:56 -07004664 } else if (space->IsBumpPointerSpace()) {
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004665 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004666 context.SetChunkOverhead(0);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004667 space->AsBumpPointerSpace()->Walk(BumpPointerSpaceCallback, &context);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004668 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004669 } else if (space->IsRegionSpace()) {
4670 heap->IncrementDisableMovingGC(self);
4671 self->TransitionFromRunnableToSuspended(kSuspended);
4672 ThreadList* tl = Runtime::Current()->GetThreadList();
Mathieu Chartierbf9fc582015-03-13 17:21:25 -07004673 tl->SuspendAll(__FUNCTION__);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -08004674 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4675 context.SetChunkOverhead(0);
4676 space->AsRegionSpace()->Walk(BumpPointerSpaceCallback, &context);
4677 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
4678 tl->ResumeAll();
4679 self->TransitionFromSuspendedToRunnable();
4680 heap->DecrementDisableMovingGC(self);
Mathieu Chartier36dab362014-07-30 14:59:56 -07004681 } else {
4682 UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004683 }
Mathieu Chartier36dab362014-07-30 14:59:56 -07004684 context.ResetStartOfNextChunk();
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07004685 }
Mathieu Chartier4c69d7f2014-10-10 12:45:50 -07004686 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Mathieu Chartiere0f0cb32012-08-28 11:26:00 -07004687 // Walk the large objects, these are not in the AllocSpace.
Mathieu Chartier36dab362014-07-30 14:59:56 -07004688 context.SetChunkOverhead(0);
Mathieu Chartierbc689b72014-12-14 17:01:31 -08004689 heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
Elliott Hughesa2155262011-11-16 16:26:58 -08004690 }
Elliott Hughes6a5bd492011-10-28 14:33:57 -07004691
4692 // Finally, send a heap end chunk.
4693 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
Elliott Hughes767a1472011-10-26 18:49:02 -07004694}
4695
Brian Carlstrom306db812014-09-05 13:01:41 -07004696void Dbg::SetAllocTrackingEnabled(bool enable) {
Man Cao8c2ff642015-05-27 17:25:30 -07004697 gc::AllocRecordObjectMap::SetAllocTrackingEnabled(enable);
Elliott Hughes545a0642011-11-08 19:10:03 -08004698}
4699
4700void Dbg::DumpRecentAllocations() {
Ian Rogers00f7d0e2012-07-19 15:28:27 -07004701 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrom306db812014-09-05 13:01:41 -07004702 MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004703 if (!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled()) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004704 LOG(INFO) << "Not recording tracked allocations";
4705 return;
4706 }
Man Cao8c2ff642015-05-27 17:25:30 -07004707 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4708 CHECK(records != nullptr);
Elliott Hughes545a0642011-11-08 19:10:03 -08004709
Man Cao1ed11b92015-06-11 22:47:35 -07004710 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004711 uint16_t count = capped_count;
Elliott Hughes545a0642011-11-08 19:10:03 -08004712
Man Cao8c2ff642015-05-27 17:25:30 -07004713 LOG(INFO) << "Tracked allocations, (count=" << count << ")";
4714 for (auto it = records->RBegin(), end = records->REnd();
4715 count > 0 && it != end; count--, it++) {
4716 const gc::AllocRecord* record = it->second;
Elliott Hughes545a0642011-11-08 19:10:03 -08004717
Man Cao8c2ff642015-05-27 17:25:30 -07004718 LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->GetTid(), record->ByteCount())
Man Cao42c3c332015-06-23 16:38:25 -07004719 << PrettyClass(record->GetClass());
Elliott Hughes545a0642011-11-08 19:10:03 -08004720
Man Cao8c2ff642015-05-27 17:25:30 -07004721 for (size_t stack_frame = 0, depth = record->GetDepth(); stack_frame < depth; ++stack_frame) {
4722 const gc::AllocRecordStackTraceElement& stack_element = record->StackElement(stack_frame);
4723 ArtMethod* m = stack_element.GetMethod();
4724 LOG(INFO) << " " << PrettyMethod(m) << " line " << stack_element.ComputeLineNumber();
Elliott Hughes545a0642011-11-08 19:10:03 -08004725 }
4726
4727 // pause periodically to help logcat catch up
4728 if ((count % 5) == 0) {
4729 usleep(40000);
4730 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004731 }
4732}
4733
4734class StringTable {
4735 public:
4736 StringTable() {
4737 }
4738
Mathieu Chartier4345c462014-06-27 10:20:14 -07004739 void Add(const std::string& str) {
4740 table_.insert(str);
4741 }
4742
4743 void Add(const char* str) {
4744 table_.insert(str);
Elliott Hughes545a0642011-11-08 19:10:03 -08004745 }
4746
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004747 size_t IndexOf(const char* s) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004748 auto it = table_.find(s);
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004749 if (it == table_.end()) {
4750 LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
4751 }
4752 return std::distance(table_.begin(), it);
Elliott Hughes545a0642011-11-08 19:10:03 -08004753 }
4754
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004755 size_t Size() const {
Elliott Hughes545a0642011-11-08 19:10:03 -08004756 return table_.size();
4757 }
4758
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004759 void WriteTo(std::vector<uint8_t>& bytes) const {
Mathieu Chartier02e25112013-08-14 16:14:24 -07004760 for (const std::string& str : table_) {
4761 const char* s = str.c_str();
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004762 size_t s_len = CountModifiedUtf8Chars(s);
Christopher Ferris8a354052015-04-24 17:23:53 -07004763 std::unique_ptr<uint16_t[]> s_utf16(new uint16_t[s_len]);
Ian Rogers6d4d9fc2011-11-30 16:24:48 -08004764 ConvertModifiedUtf8ToUtf16(s_utf16.get(), s);
4765 JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
Elliott Hughes545a0642011-11-08 19:10:03 -08004766 }
4767 }
4768
4769 private:
Elliott Hughesa8f93cb2012-06-08 17:08:48 -07004770 std::set<std::string> table_;
Elliott Hughes545a0642011-11-08 19:10:03 -08004771 DISALLOW_COPY_AND_ASSIGN(StringTable);
4772};
4773
Mathieu Chartiere401d142015-04-22 13:56:20 -07004774static const char* GetMethodSourceFile(ArtMethod* method)
Sebastien Hertz280286a2014-04-28 09:26:50 +02004775 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004776 DCHECK(method != nullptr);
4777 const char* source_file = method->GetDeclaringClassSourceFile();
Sebastien Hertz280286a2014-04-28 09:26:50 +02004778 return (source_file != nullptr) ? source_file : "";
4779}
4780
Elliott Hughes545a0642011-11-08 19:10:03 -08004781/*
4782 * The data we send to DDMS contains everything we have recorded.
4783 *
4784 * Message header (all values big-endian):
4785 * (1b) message header len (to allow future expansion); includes itself
4786 * (1b) entry header len
4787 * (1b) stack frame len
4788 * (2b) number of entries
4789 * (4b) offset to string table from start of message
4790 * (2b) number of class name strings
4791 * (2b) number of method name strings
4792 * (2b) number of source file name strings
4793 * For each entry:
4794 * (4b) total allocation size
Elliott Hughes221229c2013-01-08 18:17:50 -08004795 * (2b) thread id
Elliott Hughes545a0642011-11-08 19:10:03 -08004796 * (2b) allocated object's class name index
4797 * (1b) stack depth
4798 * For each stack frame:
4799 * (2b) method's class name
4800 * (2b) method name
4801 * (2b) method source file
4802 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
4803 * (xb) class name strings
4804 * (xb) method name strings
4805 * (xb) source file strings
4806 *
4807 * As with other DDM traffic, strings are sent as a 4-byte length
4808 * followed by UTF-16 data.
4809 *
4810 * We send up 16-bit unsigned indexes into string tables. In theory there
Brian Carlstrom306db812014-09-05 13:01:41 -07004811 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
Elliott Hughes545a0642011-11-08 19:10:03 -08004812 * each table, but in practice there should be far fewer.
4813 *
4814 * The chief reason for using a string table here is to keep the size of
4815 * the DDMS message to a minimum. This is partly to make the protocol
4816 * efficient, but also because we have to form the whole thing up all at
4817 * once in a memory buffer.
4818 *
4819 * We use separate string tables for class names, method names, and source
4820 * files to keep the indexes small. There will generally be no overlap
4821 * between the contents of these tables.
4822 */
4823jbyteArray Dbg::GetRecentAllocations() {
Ian Rogerscf7f1912014-10-22 22:06:39 -07004824 if ((false)) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004825 DumpRecentAllocations();
4826 }
4827
Ian Rogers50b35e22012-10-04 10:09:15 -07004828 Thread* self = Thread::Current();
Elliott Hughes545a0642011-11-08 19:10:03 -08004829 std::vector<uint8_t> bytes;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004830 {
Brian Carlstrom306db812014-09-05 13:01:41 -07004831 MutexLock mu(self, *Locks::alloc_tracker_lock_);
Man Cao8c2ff642015-05-27 17:25:30 -07004832 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4833 // In case this method is called when allocation tracker is disabled,
4834 // we should still send some data back.
4835 gc::AllocRecordObjectMap dummy;
4836 if (records == nullptr) {
4837 CHECK(!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled());
4838 records = &dummy;
4839 }
Man Cao41656de2015-07-06 18:53:15 -07004840 // We don't need to wait on the condition variable records->new_record_condition_, because this
4841 // function only reads the class objects, which are already marked so it doesn't change their
4842 // reachability.
Man Cao8c2ff642015-05-27 17:25:30 -07004843
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004844 //
4845 // Part 1: generate string tables.
4846 //
4847 StringTable class_names;
4848 StringTable method_names;
4849 StringTable filenames;
Elliott Hughes545a0642011-11-08 19:10:03 -08004850
Man Cao1ed11b92015-06-11 22:47:35 -07004851 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
Brian Carlstrom306db812014-09-05 13:01:41 -07004852 uint16_t count = capped_count;
Man Cao8c2ff642015-05-27 17:25:30 -07004853 for (auto it = records->RBegin(), end = records->REnd();
4854 count > 0 && it != end; count--, it++) {
4855 const gc::AllocRecord* record = it->second;
Ian Rogers1ff3c982014-08-12 02:30:58 -07004856 std::string temp;
Man Cao41656de2015-07-06 18:53:15 -07004857 class_names.Add(record->GetClassDescriptor(&temp));
Man Cao8c2ff642015-05-27 17:25:30 -07004858 for (size_t i = 0, depth = record->GetDepth(); i < depth; i++) {
4859 ArtMethod* m = record->StackElement(i).GetMethod();
4860 class_names.Add(m->GetDeclaringClassDescriptor());
4861 method_names.Add(m->GetName());
4862 filenames.Add(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004863 }
Elliott Hughes545a0642011-11-08 19:10:03 -08004864 }
4865
Man Cao8c2ff642015-05-27 17:25:30 -07004866 LOG(INFO) << "recent allocation records: " << capped_count;
4867 LOG(INFO) << "allocation records all objects: " << records->Size();
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004868
4869 //
4870 // Part 2: Generate the output and store it in the buffer.
4871 //
4872
4873 // (1b) message header len (to allow future expansion); includes itself
4874 // (1b) entry header len
4875 // (1b) stack frame len
4876 const int kMessageHeaderLen = 15;
4877 const int kEntryHeaderLen = 9;
4878 const int kStackFrameLen = 8;
4879 JDWP::Append1BE(bytes, kMessageHeaderLen);
4880 JDWP::Append1BE(bytes, kEntryHeaderLen);
4881 JDWP::Append1BE(bytes, kStackFrameLen);
4882
4883 // (2b) number of entries
4884 // (4b) offset to string table from start of message
4885 // (2b) number of class name strings
4886 // (2b) number of method name strings
4887 // (2b) number of source file name strings
Brian Carlstrom306db812014-09-05 13:01:41 -07004888 JDWP::Append2BE(bytes, capped_count);
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004889 size_t string_table_offset = bytes.size();
Brian Carlstrom7934ac22013-07-26 10:54:15 -07004890 JDWP::Append4BE(bytes, 0); // We'll patch this later...
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004891 JDWP::Append2BE(bytes, class_names.Size());
4892 JDWP::Append2BE(bytes, method_names.Size());
4893 JDWP::Append2BE(bytes, filenames.Size());
4894
Ian Rogers1ff3c982014-08-12 02:30:58 -07004895 std::string temp;
Man Cao8c2ff642015-05-27 17:25:30 -07004896 count = capped_count;
4897 // The last "count" number of allocation records in "records" are the most recent "count" number
4898 // of allocations. Reverse iterate to get them. The most recent allocation is sent first.
4899 for (auto it = records->RBegin(), end = records->REnd();
4900 count > 0 && it != end; count--, it++) {
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004901 // For each entry:
4902 // (4b) total allocation size
4903 // (2b) thread id
4904 // (2b) allocated object's class name index
4905 // (1b) stack depth
Man Cao8c2ff642015-05-27 17:25:30 -07004906 const gc::AllocRecord* record = it->second;
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004907 size_t stack_depth = record->GetDepth();
Mathieu Chartierf8322842014-05-16 10:59:25 -07004908 size_t allocated_object_class_name_index =
Man Cao41656de2015-07-06 18:53:15 -07004909 class_names.IndexOf(record->GetClassDescriptor(&temp));
Hiroshi Yamauchib5a9e3d2014-06-09 12:11:20 -07004910 JDWP::Append4BE(bytes, record->ByteCount());
Man Cao8c2ff642015-05-27 17:25:30 -07004911 JDWP::Append2BE(bytes, static_cast<uint16_t>(record->GetTid()));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004912 JDWP::Append2BE(bytes, allocated_object_class_name_index);
4913 JDWP::Append1BE(bytes, stack_depth);
4914
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004915 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
4916 // For each stack frame:
4917 // (2b) method's class name
4918 // (2b) method name
4919 // (2b) method source file
4920 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
Man Cao8c2ff642015-05-27 17:25:30 -07004921 ArtMethod* m = record->StackElement(stack_frame).GetMethod();
Mathieu Chartierbfd9a432014-05-21 17:43:44 -07004922 size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
4923 size_t method_name_index = method_names.IndexOf(m->GetName());
4924 size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004925 JDWP::Append2BE(bytes, class_name_index);
4926 JDWP::Append2BE(bytes, method_name_index);
4927 JDWP::Append2BE(bytes, file_name_index);
Man Cao8c2ff642015-05-27 17:25:30 -07004928 JDWP::Append2BE(bytes, record->StackElement(stack_frame).ComputeLineNumber());
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004929 }
Mathieu Chartier46e811b2013-07-10 17:09:14 -07004930 }
4931
4932 // (xb) class name strings
4933 // (xb) method name strings
4934 // (xb) source file strings
4935 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
4936 class_names.WriteTo(bytes);
4937 method_names.WriteTo(bytes);
4938 filenames.WriteTo(bytes);
Elliott Hughes545a0642011-11-08 19:10:03 -08004939 }
Ian Rogers50b35e22012-10-04 10:09:15 -07004940 JNIEnv* env = self->GetJniEnv();
Elliott Hughes545a0642011-11-08 19:10:03 -08004941 jbyteArray result = env->NewByteArray(bytes.size());
Ian Rogersc0542af2014-09-03 16:16:56 -07004942 if (result != nullptr) {
Elliott Hughes545a0642011-11-08 19:10:03 -08004943 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
4944 }
4945 return result;
4946}
4947
Mathieu Chartiere401d142015-04-22 13:56:20 -07004948ArtMethod* DeoptimizationRequest::Method() const {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07004949 ScopedObjectAccessUnchecked soa(Thread::Current());
4950 return soa.DecodeMethod(method_);
4951}
4952
Mathieu Chartiere401d142015-04-22 13:56:20 -07004953void DeoptimizationRequest::SetMethod(ArtMethod* m) {
Hiroshi Yamauchi0ec17d22014-07-07 13:07:08 -07004954 ScopedObjectAccessUnchecked soa(Thread::Current());
4955 method_ = soa.EncodeMethod(m);
4956}
4957
Elliott Hughes872d4ec2011-10-21 17:07:15 -07004958} // namespace art