2 * Copyright (C) 2008 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 #include "arch/context.h"
24 #include "art_field-inl.h"
25 #include "art_method-inl.h"
26 #include "base/time_utils.h"
27 #include "class_linker.h"
28 #include "class_linker-inl.h"
29 #include "dex_file-inl.h"
30 #include "dex_instruction.h"
31 #include "entrypoints/runtime_asm_entrypoints.h"
32 #include "gc/accounting/card_table-inl.h"
33 #include "gc/allocation_record.h"
34 #include "gc/scoped_gc_critical_section.h"
35 #include "gc/space/large_object_space.h"
36 #include "gc/space/space-inl.h"
37 #include "handle_scope.h"
38 #include "jdwp/jdwp_priv.h"
39 #include "jdwp/object_registry.h"
40 #include "mirror/class.h"
41 #include "mirror/class-inl.h"
42 #include "mirror/class_loader.h"
43 #include "mirror/object-inl.h"
44 #include "mirror/object_array-inl.h"
45 #include "mirror/string-inl.h"
46 #include "mirror/throwable.h"
47 #include "reflection.h"
49 #include "scoped_thread_state_change.h"
50 #include "ScopedLocalRef.h"
51 #include "ScopedPrimitiveArray.h"
52 #include "handle_scope-inl.h"
53 #include "thread_list.h"
55 #include "well_known_classes.h"
59 // The key identifying the debugger to update instrumentation.
60 static constexpr const char* kDbgInstrumentationKey = "Debugger";
62 // Limit alloc_record_count to the 2BE value (64k-1) that is the limit of the current protocol.
63 static uint16_t CappedAllocRecordCount(size_t alloc_record_count) {
64 const size_t cap = 0xffff;
65 if (alloc_record_count > cap) {
68 return alloc_record_count;
71 // Takes a method and returns a 'canonical' one if the method is default (and therefore potentially
72 // copied from some other class). This ensures that the debugger does not get confused as to which
74 static ArtMethod* GetCanonicalMethod(ArtMethod* m)
75 SHARED_REQUIRES(Locks::mutator_lock_) {
76 if (LIKELY(!m->IsDefault())) {
79 mirror::Class* declaring_class = m->GetDeclaringClass();
80 return declaring_class->FindDeclaredVirtualMethod(declaring_class->GetDexCache(),
81 m->GetDexMethodIndex(),
86 class Breakpoint : public ValueObject {
88 Breakpoint(ArtMethod* method, uint32_t dex_pc, DeoptimizationRequest::Kind deoptimization_kind)
89 : method_(GetCanonicalMethod(method)),
91 deoptimization_kind_(deoptimization_kind) {
92 CHECK(deoptimization_kind_ == DeoptimizationRequest::kNothing ||
93 deoptimization_kind_ == DeoptimizationRequest::kSelectiveDeoptimization ||
94 deoptimization_kind_ == DeoptimizationRequest::kFullDeoptimization);
97 Breakpoint(const Breakpoint& other) SHARED_REQUIRES(Locks::mutator_lock_)
98 : method_(other.method_),
99 dex_pc_(other.dex_pc_),
100 deoptimization_kind_(other.deoptimization_kind_) {}
102 // Method() is called from root visiting, do not use ScopedObjectAccess here or it can cause
103 // GC to deadlock if another thread tries to call SuspendAll while the GC is in a runnable state.
104 ArtMethod* Method() const {
108 uint32_t DexPc() const {
112 DeoptimizationRequest::Kind GetDeoptimizationKind() const {
113 return deoptimization_kind_;
116 // Returns true if the method of this breakpoint and the passed in method should be considered the
117 // same. That is, they are either the same method or they are copied from the same method.
118 bool IsInMethod(ArtMethod* m) const SHARED_REQUIRES(Locks::mutator_lock_) {
119 return method_ == GetCanonicalMethod(m);
123 // The location of this breakpoint.
127 // Indicates whether breakpoint needs full deoptimization or selective deoptimization.
128 DeoptimizationRequest::Kind deoptimization_kind_;
131 static std::ostream& operator<<(std::ostream& os, const Breakpoint& rhs)
132 SHARED_REQUIRES(Locks::mutator_lock_) {
133 os << StringPrintf("Breakpoint[%s @%#x]", PrettyMethod(rhs.Method()).c_str(), rhs.DexPc());
137 class DebugInstrumentationListener FINAL : public instrumentation::InstrumentationListener {
139 DebugInstrumentationListener() {}
140 virtual ~DebugInstrumentationListener() {}
142 void MethodEntered(Thread* thread, mirror::Object* this_object, ArtMethod* method,
144 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
145 if (method->IsNative()) {
146 // TODO: post location events is a suspension point and native method entry stubs aren't.
149 if (IsListeningToDexPcMoved()) {
150 // We also listen to kDexPcMoved instrumentation event so we know the DexPcMoved method is
151 // going to be called right after us. To avoid sending JDWP events twice for this location,
152 // we report the event in DexPcMoved. However, we must remind this is method entry so we
153 // send the METHOD_ENTRY event. And we can also group it with other events for this location
154 // like BREAKPOINT or SINGLE_STEP (or even METHOD_EXIT if this is a RETURN instruction).
155 thread->SetDebugMethodEntry();
156 } else if (IsListeningToMethodExit() && IsReturn(method, dex_pc)) {
157 // We also listen to kMethodExited instrumentation event and the current instruction is a
158 // RETURN so we know the MethodExited method is going to be called right after us. To avoid
159 // sending JDWP events twice for this location, we report the event(s) in MethodExited.
160 // However, we must remind this is method entry so we send the METHOD_ENTRY event. And we can
161 // also group it with other events for this location like BREAKPOINT or SINGLE_STEP.
162 thread->SetDebugMethodEntry();
164 Dbg::UpdateDebugger(thread, this_object, method, 0, Dbg::kMethodEntry, nullptr);
168 void MethodExited(Thread* thread, mirror::Object* this_object, ArtMethod* method,
169 uint32_t dex_pc, const JValue& return_value)
170 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
171 if (method->IsNative()) {
172 // TODO: post location events is a suspension point and native method entry stubs aren't.
175 uint32_t events = Dbg::kMethodExit;
176 if (thread->IsDebugMethodEntry()) {
177 // It is also the method entry.
178 DCHECK(IsReturn(method, dex_pc));
179 events |= Dbg::kMethodEntry;
180 thread->ClearDebugMethodEntry();
182 Dbg::UpdateDebugger(thread, this_object, method, dex_pc, events, &return_value);
185 void MethodUnwind(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object ATTRIBUTE_UNUSED,
186 ArtMethod* method, uint32_t dex_pc)
187 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
188 // We're not recorded to listen to this kind of event, so complain.
189 LOG(ERROR) << "Unexpected method unwind event in debugger " << PrettyMethod(method)
193 void DexPcMoved(Thread* thread, mirror::Object* this_object, ArtMethod* method,
195 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
196 if (IsListeningToMethodExit() && IsReturn(method, new_dex_pc)) {
197 // We also listen to kMethodExited instrumentation event and the current instruction is a
198 // RETURN so we know the MethodExited method is going to be called right after us. Like in
199 // MethodEntered, we delegate event reporting to MethodExited.
200 // Besides, if this RETURN instruction is the only one in the method, we can send multiple
201 // JDWP events in the same packet: METHOD_ENTRY, METHOD_EXIT, BREAKPOINT and/or SINGLE_STEP.
202 // Therefore, we must not clear the debug method entry flag here.
205 if (thread->IsDebugMethodEntry()) {
206 // It is also the method entry.
207 events = Dbg::kMethodEntry;
208 thread->ClearDebugMethodEntry();
210 Dbg::UpdateDebugger(thread, this_object, method, new_dex_pc, events, nullptr);
214 void FieldRead(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
215 ArtMethod* method, uint32_t dex_pc, ArtField* field)
216 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
217 Dbg::PostFieldAccessEvent(method, dex_pc, this_object, field);
220 void FieldWritten(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
221 ArtMethod* method, uint32_t dex_pc, ArtField* field,
222 const JValue& field_value)
223 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
224 Dbg::PostFieldModificationEvent(method, dex_pc, this_object, field, &field_value);
227 void ExceptionCaught(Thread* thread ATTRIBUTE_UNUSED, mirror::Throwable* exception_object)
228 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
229 Dbg::PostException(exception_object);
232 // We only care about branches in the Jit.
233 void Branch(Thread* /*thread*/, ArtMethod* method, uint32_t dex_pc, int32_t dex_pc_offset)
234 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
235 LOG(ERROR) << "Unexpected branch event in debugger " << PrettyMethod(method)
236 << " " << dex_pc << ", " << dex_pc_offset;
239 // We only care about invokes in the Jit.
240 void InvokeVirtualOrInterface(Thread* thread ATTRIBUTE_UNUSED,
245 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
246 LOG(ERROR) << "Unexpected invoke event in debugger " << PrettyMethod(method)
251 static bool IsReturn(ArtMethod* method, uint32_t dex_pc)
252 SHARED_REQUIRES(Locks::mutator_lock_) {
253 const DexFile::CodeItem* code_item = method->GetCodeItem();
254 const Instruction* instruction = Instruction::At(&code_item->insns_[dex_pc]);
255 return instruction->IsReturn();
258 static bool IsListeningToDexPcMoved() SHARED_REQUIRES(Locks::mutator_lock_) {
259 return IsListeningTo(instrumentation::Instrumentation::kDexPcMoved);
262 static bool IsListeningToMethodExit() SHARED_REQUIRES(Locks::mutator_lock_) {
263 return IsListeningTo(instrumentation::Instrumentation::kMethodExited);
266 static bool IsListeningTo(instrumentation::Instrumentation::InstrumentationEvent event)
267 SHARED_REQUIRES(Locks::mutator_lock_) {
268 return (Dbg::GetInstrumentationEvents() & event) != 0;
271 DISALLOW_COPY_AND_ASSIGN(DebugInstrumentationListener);
272 } gDebugInstrumentationListener;
274 // JDWP is allowed unless the Zygote forbids it.
275 static bool gJdwpAllowed = true;
277 // Was there a -Xrunjdwp or -agentlib:jdwp= argument on the command line?
278 static bool gJdwpConfigured = false;
280 // JDWP options for debugging. Only valid if IsJdwpConfigured() is true.
281 static JDWP::JdwpOptions gJdwpOptions;
283 // Runtime JDWP state.
284 static JDWP::JdwpState* gJdwpState = nullptr;
285 static bool gDebuggerConnected; // debugger or DDMS is connected.
287 static bool gDdmThreadNotification = false;
289 // DDMS GC-related settings.
290 static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
291 static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
292 static Dbg::HpsgWhat gDdmHpsgWhat;
293 static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
294 static Dbg::HpsgWhat gDdmNhsgWhat;
296 bool Dbg::gDebuggerActive = false;
297 bool Dbg::gDisposed = false;
298 ObjectRegistry* Dbg::gRegistry = nullptr;
300 // Deoptimization support.
301 std::vector<DeoptimizationRequest> Dbg::deoptimization_requests_;
302 size_t Dbg::full_deoptimization_event_count_ = 0;
304 // Instrumentation event reference counters.
305 size_t Dbg::dex_pc_change_event_ref_count_ = 0;
306 size_t Dbg::method_enter_event_ref_count_ = 0;
307 size_t Dbg::method_exit_event_ref_count_ = 0;
308 size_t Dbg::field_read_event_ref_count_ = 0;
309 size_t Dbg::field_write_event_ref_count_ = 0;
310 size_t Dbg::exception_catch_event_ref_count_ = 0;
311 uint32_t Dbg::instrumentation_events_ = 0;
314 static std::vector<Breakpoint> gBreakpoints GUARDED_BY(Locks::breakpoint_lock_);
316 void DebugInvokeReq::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
317 receiver.VisitRootIfNonNull(visitor, root_info); // null for static method call.
318 klass.VisitRoot(visitor, root_info);
321 void SingleStepControl::AddDexPc(uint32_t dex_pc) {
322 dex_pcs_.insert(dex_pc);
325 bool SingleStepControl::ContainsDexPc(uint32_t dex_pc) const {
326 return dex_pcs_.find(dex_pc) == dex_pcs_.end();
329 static bool IsBreakpoint(ArtMethod* m, uint32_t dex_pc)
330 REQUIRES(!Locks::breakpoint_lock_)
331 SHARED_REQUIRES(Locks::mutator_lock_) {
332 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
333 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
334 if (gBreakpoints[i].DexPc() == dex_pc && gBreakpoints[i].IsInMethod(m)) {
335 VLOG(jdwp) << "Hit breakpoint #" << i << ": " << gBreakpoints[i];
342 static bool IsSuspendedForDebugger(ScopedObjectAccessUnchecked& soa, Thread* thread)
343 REQUIRES(!Locks::thread_suspend_count_lock_) {
344 MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
345 // A thread may be suspended for GC; in this code, we really want to know whether
346 // there's a debugger suspension active.
347 return thread->IsSuspended() && thread->GetDebugSuspendCount() > 0;
350 static mirror::Array* DecodeNonNullArray(JDWP::RefTypeId id, JDWP::JdwpError* error)
351 SHARED_REQUIRES(Locks::mutator_lock_) {
352 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
354 *error = JDWP::ERR_INVALID_OBJECT;
357 if (!o->IsArrayInstance()) {
358 *error = JDWP::ERR_INVALID_ARRAY;
361 *error = JDWP::ERR_NONE;
365 static mirror::Class* DecodeClass(JDWP::RefTypeId id, JDWP::JdwpError* error)
366 SHARED_REQUIRES(Locks::mutator_lock_) {
367 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
369 *error = JDWP::ERR_INVALID_OBJECT;
373 *error = JDWP::ERR_INVALID_CLASS;
376 *error = JDWP::ERR_NONE;
380 static Thread* DecodeThread(ScopedObjectAccessUnchecked& soa, JDWP::ObjectId thread_id,
381 JDWP::JdwpError* error)
382 SHARED_REQUIRES(Locks::mutator_lock_)
383 REQUIRES(!Locks::thread_list_lock_, !Locks::thread_suspend_count_lock_) {
384 mirror::Object* thread_peer = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_id, error);
385 if (thread_peer == nullptr) {
386 // This isn't even an object.
387 *error = JDWP::ERR_INVALID_OBJECT;
391 mirror::Class* java_lang_Thread = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
392 if (!java_lang_Thread->IsAssignableFrom(thread_peer->GetClass())) {
393 // This isn't a thread.
394 *error = JDWP::ERR_INVALID_THREAD;
398 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
399 Thread* thread = Thread::FromManagedThread(soa, thread_peer);
400 // If thread is null then this a java.lang.Thread without a Thread*. Must be a un-started or a
402 *error = (thread == nullptr) ? JDWP::ERR_THREAD_NOT_ALIVE : JDWP::ERR_NONE;
406 static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
407 // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
408 // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
409 return static_cast<JDWP::JdwpTag>(descriptor[0]);
412 static JDWP::JdwpTag BasicTagFromClass(mirror::Class* klass)
413 SHARED_REQUIRES(Locks::mutator_lock_) {
415 const char* descriptor = klass->GetDescriptor(&temp);
416 return BasicTagFromDescriptor(descriptor);
419 static JDWP::JdwpTag TagFromClass(const ScopedObjectAccessUnchecked& soa, mirror::Class* c)
420 SHARED_REQUIRES(Locks::mutator_lock_) {
422 if (c->IsArrayClass()) {
423 return JDWP::JT_ARRAY;
425 if (c->IsStringClass()) {
426 return JDWP::JT_STRING;
428 if (c->IsClassClass()) {
429 return JDWP::JT_CLASS_OBJECT;
432 mirror::Class* thread_class = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
433 if (thread_class->IsAssignableFrom(c)) {
434 return JDWP::JT_THREAD;
438 mirror::Class* thread_group_class =
439 soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
440 if (thread_group_class->IsAssignableFrom(c)) {
441 return JDWP::JT_THREAD_GROUP;
445 mirror::Class* class_loader_class =
446 soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ClassLoader);
447 if (class_loader_class->IsAssignableFrom(c)) {
448 return JDWP::JT_CLASS_LOADER;
451 return JDWP::JT_OBJECT;
455 * Objects declared to hold Object might actually hold a more specific
456 * type. The debugger may take a special interest in these (e.g. it
457 * wants to display the contents of Strings), so we want to return an
460 * Null objects are tagged JT_OBJECT.
462 JDWP::JdwpTag Dbg::TagFromObject(const ScopedObjectAccessUnchecked& soa, mirror::Object* o) {
463 return (o == nullptr) ? JDWP::JT_OBJECT : TagFromClass(soa, o->GetClass());
466 static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
468 case JDWP::JT_BOOLEAN:
472 case JDWP::JT_DOUBLE:
483 void Dbg::StartJdwp() {
484 if (!gJdwpAllowed || !IsJdwpConfigured()) {
489 CHECK(gRegistry == nullptr);
490 gRegistry = new ObjectRegistry;
492 // Init JDWP if the debugger is enabled. This may connect out to a
493 // debugger, passively listen for a debugger, or block waiting for a
495 gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
496 if (gJdwpState == nullptr) {
497 // We probably failed because some other process has the port already, which means that
498 // if we don't abort the user is likely to think they're talking to us when they're actually
499 // talking to that other process.
500 LOG(FATAL) << "Debugger thread failed to initialize";
503 // If a debugger has already attached, send the "welcome" message.
504 // This may cause us to suspend all threads.
505 if (gJdwpState->IsActive()) {
506 ScopedObjectAccess soa(Thread::Current());
507 gJdwpState->PostVMStart();
511 void Dbg::StopJdwp() {
512 // Post VM_DEATH event before the JDWP connection is closed (either by the JDWP thread or the
513 // destruction of gJdwpState).
514 if (gJdwpState != nullptr && gJdwpState->IsActive()) {
515 gJdwpState->PostVMDeath();
517 // Prevent the JDWP thread from processing JDWP incoming packets after we close the connection.
520 gJdwpState = nullptr;
525 void Dbg::GcDidFinish() {
526 if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
527 ScopedObjectAccess soa(Thread::Current());
528 VLOG(jdwp) << "Sending heap info to DDM";
529 DdmSendHeapInfo(gDdmHpifWhen);
531 if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
532 ScopedObjectAccess soa(Thread::Current());
533 VLOG(jdwp) << "Dumping heap to DDM";
534 DdmSendHeapSegments(false);
536 if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
537 ScopedObjectAccess soa(Thread::Current());
538 VLOG(jdwp) << "Dumping native heap to DDM";
539 DdmSendHeapSegments(true);
543 void Dbg::SetJdwpAllowed(bool allowed) {
544 gJdwpAllowed = allowed;
547 DebugInvokeReq* Dbg::GetInvokeReq() {
548 return Thread::Current()->GetInvokeReq();
551 Thread* Dbg::GetDebugThread() {
552 return (gJdwpState != nullptr) ? gJdwpState->GetDebugThread() : nullptr;
555 void Dbg::ClearWaitForEventThread() {
556 gJdwpState->ReleaseJdwpTokenForEvent();
559 void Dbg::Connected() {
560 CHECK(!gDebuggerConnected);
561 VLOG(jdwp) << "JDWP has attached";
562 gDebuggerConnected = true;
566 bool Dbg::RequiresDeoptimization() {
567 // We don't need deoptimization if everything runs with interpreter after
568 // enabling -Xint mode.
569 return !Runtime::Current()->GetInstrumentation()->IsForcedInterpretOnly();
572 // Used to patch boot image method entry point to interpreter bridge.
573 class UpdateEntryPointsClassVisitor : public ClassVisitor {
575 explicit UpdateEntryPointsClassVisitor(instrumentation::Instrumentation* instrumentation)
576 : instrumentation_(instrumentation) {}
578 bool operator()(mirror::Class* klass) OVERRIDE REQUIRES(Locks::mutator_lock_) {
579 auto pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
580 for (auto& m : klass->GetMethods(pointer_size)) {
581 const void* code = m.GetEntryPointFromQuickCompiledCode();
582 if (Runtime::Current()->GetHeap()->IsInBootImageOatFile(code) &&
584 !m.IsProxyMethod()) {
585 instrumentation_->UpdateMethodsCode(&m, GetQuickToInterpreterBridge());
592 instrumentation::Instrumentation* const instrumentation_;
595 void Dbg::GoActive() {
596 // Enable all debugging features, including scans for breakpoints.
597 // This is a no-op if we're already active.
598 // Only called from the JDWP handler thread.
599 if (IsDebuggerActive()) {
603 Thread* const self = Thread::Current();
605 // TODO: dalvik only warned if there were breakpoints left over. clear in Dbg::Disconnected?
606 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
607 CHECK_EQ(gBreakpoints.size(), 0U);
611 MutexLock mu(self, *Locks::deoptimization_lock_);
612 CHECK_EQ(deoptimization_requests_.size(), 0U);
613 CHECK_EQ(full_deoptimization_event_count_, 0U);
614 CHECK_EQ(dex_pc_change_event_ref_count_, 0U);
615 CHECK_EQ(method_enter_event_ref_count_, 0U);
616 CHECK_EQ(method_exit_event_ref_count_, 0U);
617 CHECK_EQ(field_read_event_ref_count_, 0U);
618 CHECK_EQ(field_write_event_ref_count_, 0U);
619 CHECK_EQ(exception_catch_event_ref_count_, 0U);
622 Runtime* runtime = Runtime::Current();
623 // Since boot image code may be AOT compiled as not debuggable, we need to patch
624 // entry points of methods in boot image to interpreter bridge.
625 // However, the performance cost of this is non-negligible during native-debugging due to the
626 // forced JIT, so we keep the AOT code in that case in exchange for limited native debugging.
627 if (!runtime->GetInstrumentation()->IsForcedInterpretOnly() && !runtime->IsNativeDebuggable()) {
628 ScopedObjectAccess soa(self);
629 UpdateEntryPointsClassVisitor visitor(runtime->GetInstrumentation());
630 runtime->GetClassLinker()->VisitClasses(&visitor);
633 ScopedSuspendAll ssa(__FUNCTION__);
634 if (RequiresDeoptimization()) {
635 runtime->GetInstrumentation()->EnableDeoptimization();
637 instrumentation_events_ = 0;
638 gDebuggerActive = true;
639 LOG(INFO) << "Debugger is active";
642 void Dbg::Disconnected() {
643 CHECK(gDebuggerConnected);
645 LOG(INFO) << "Debugger is no longer active";
647 // Suspend all threads and exclusively acquire the mutator lock. Set the state of the thread
648 // to kRunnable to avoid scoped object access transitions. Remove the debugger as a listener
649 // and clear the object registry.
650 Runtime* runtime = Runtime::Current();
651 Thread* self = Thread::Current();
653 // Required for DisableDeoptimization.
654 gc::ScopedGCCriticalSection gcs(self,
655 gc::kGcCauseInstrumentation,
656 gc::kCollectorTypeInstrumentation);
657 ScopedSuspendAll ssa(__FUNCTION__);
658 ThreadState old_state = self->SetStateUnsafe(kRunnable);
659 // Debugger may not be active at this point.
660 if (IsDebuggerActive()) {
662 // Since we're going to disable deoptimization, we clear the deoptimization requests queue.
663 // This prevents us from having any pending deoptimization request when the debugger attaches
664 // to us again while no event has been requested yet.
665 MutexLock mu(self, *Locks::deoptimization_lock_);
666 deoptimization_requests_.clear();
667 full_deoptimization_event_count_ = 0U;
669 if (instrumentation_events_ != 0) {
670 runtime->GetInstrumentation()->RemoveListener(&gDebugInstrumentationListener,
671 instrumentation_events_);
672 instrumentation_events_ = 0;
674 if (RequiresDeoptimization()) {
675 runtime->GetInstrumentation()->DisableDeoptimization(kDbgInstrumentationKey);
677 gDebuggerActive = false;
679 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
683 ScopedObjectAccess soa(self);
687 gDebuggerConnected = false;
690 void Dbg::ConfigureJdwp(const JDWP::JdwpOptions& jdwp_options) {
691 CHECK_NE(jdwp_options.transport, JDWP::kJdwpTransportUnknown);
692 gJdwpOptions = jdwp_options;
693 gJdwpConfigured = true;
696 bool Dbg::IsJdwpConfigured() {
697 return gJdwpConfigured;
700 int64_t Dbg::LastDebuggerActivity() {
701 return gJdwpState->LastDebuggerActivity();
704 void Dbg::UndoDebuggerSuspensions() {
705 Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
708 std::string Dbg::GetClassName(JDWP::RefTypeId class_id) {
709 JDWP::JdwpError error;
710 mirror::Object* o = gRegistry->Get<mirror::Object*>(class_id, &error);
712 if (error == JDWP::ERR_NONE) {
715 return StringPrintf("invalid object %p", reinterpret_cast<void*>(class_id));
719 return StringPrintf("non-class %p", o); // This is only used for debugging output anyway.
721 return GetClassName(o->AsClass());
724 std::string Dbg::GetClassName(mirror::Class* klass) {
725 if (klass == nullptr) {
729 return DescriptorToName(klass->GetDescriptor(&temp));
732 JDWP::JdwpError Dbg::GetClassObject(JDWP::RefTypeId id, JDWP::ObjectId* class_object_id) {
733 JDWP::JdwpError status;
734 mirror::Class* c = DecodeClass(id, &status);
736 *class_object_id = 0;
739 *class_object_id = gRegistry->Add(c);
740 return JDWP::ERR_NONE;
743 JDWP::JdwpError Dbg::GetSuperclass(JDWP::RefTypeId id, JDWP::RefTypeId* superclass_id) {
744 JDWP::JdwpError status;
745 mirror::Class* c = DecodeClass(id, &status);
750 if (c->IsInterface()) {
751 // http://code.google.com/p/android/issues/detail?id=20856
754 *superclass_id = gRegistry->Add(c->GetSuperClass());
756 return JDWP::ERR_NONE;
759 JDWP::JdwpError Dbg::GetClassLoader(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
760 JDWP::JdwpError error;
761 mirror::Class* c = DecodeClass(id, &error);
765 expandBufAddObjectId(pReply, gRegistry->Add(c->GetClassLoader()));
766 return JDWP::ERR_NONE;
769 JDWP::JdwpError Dbg::GetModifiers(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
770 JDWP::JdwpError error;
771 mirror::Class* c = DecodeClass(id, &error);
776 uint32_t access_flags = c->GetAccessFlags() & kAccJavaFlagsMask;
778 // Set ACC_SUPER. Dex files don't contain this flag but only classes are supposed to have it set,
780 // Class.getModifiers doesn't return it, but JDWP does, so we set it here.
781 if ((access_flags & kAccInterface) == 0) {
782 access_flags |= kAccSuper;
785 expandBufAdd4BE(pReply, access_flags);
787 return JDWP::ERR_NONE;
790 JDWP::JdwpError Dbg::GetMonitorInfo(JDWP::ObjectId object_id, JDWP::ExpandBuf* reply) {
791 JDWP::JdwpError error;
792 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
794 return JDWP::ERR_INVALID_OBJECT;
797 // Ensure all threads are suspended while we read objects' lock words.
798 Thread* self = Thread::Current();
799 CHECK_EQ(self->GetState(), kRunnable);
801 MonitorInfo monitor_info;
803 ScopedThreadSuspension sts(self, kSuspended);
804 ScopedSuspendAll ssa(__FUNCTION__);
805 monitor_info = MonitorInfo(o);
807 if (monitor_info.owner_ != nullptr) {
808 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.owner_->GetPeer()));
810 expandBufAddObjectId(reply, gRegistry->Add(nullptr));
812 expandBufAdd4BE(reply, monitor_info.entry_count_);
813 expandBufAdd4BE(reply, monitor_info.waiters_.size());
814 for (size_t i = 0; i < monitor_info.waiters_.size(); ++i) {
815 expandBufAddObjectId(reply, gRegistry->Add(monitor_info.waiters_[i]->GetPeer()));
817 return JDWP::ERR_NONE;
820 JDWP::JdwpError Dbg::GetOwnedMonitors(JDWP::ObjectId thread_id,
821 std::vector<JDWP::ObjectId>* monitors,
822 std::vector<uint32_t>* stack_depths) {
823 struct OwnedMonitorVisitor : public StackVisitor {
824 OwnedMonitorVisitor(Thread* thread, Context* context,
825 std::vector<JDWP::ObjectId>* monitor_vector,
826 std::vector<uint32_t>* stack_depth_vector)
827 SHARED_REQUIRES(Locks::mutator_lock_)
828 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
829 current_stack_depth(0),
830 monitors(monitor_vector),
831 stack_depths(stack_depth_vector) {}
833 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
835 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
836 if (!GetMethod()->IsRuntimeMethod()) {
837 Monitor::VisitLocks(this, AppendOwnedMonitors, this);
838 ++current_stack_depth;
843 static void AppendOwnedMonitors(mirror::Object* owned_monitor, void* arg)
844 SHARED_REQUIRES(Locks::mutator_lock_) {
845 OwnedMonitorVisitor* visitor = reinterpret_cast<OwnedMonitorVisitor*>(arg);
846 visitor->monitors->push_back(gRegistry->Add(owned_monitor));
847 visitor->stack_depths->push_back(visitor->current_stack_depth);
850 size_t current_stack_depth;
851 std::vector<JDWP::ObjectId>* const monitors;
852 std::vector<uint32_t>* const stack_depths;
855 ScopedObjectAccessUnchecked soa(Thread::Current());
856 JDWP::JdwpError error;
857 Thread* thread = DecodeThread(soa, thread_id, &error);
858 if (thread == nullptr) {
861 if (!IsSuspendedForDebugger(soa, thread)) {
862 return JDWP::ERR_THREAD_NOT_SUSPENDED;
864 std::unique_ptr<Context> context(Context::Create());
865 OwnedMonitorVisitor visitor(thread, context.get(), monitors, stack_depths);
867 return JDWP::ERR_NONE;
870 JDWP::JdwpError Dbg::GetContendedMonitor(JDWP::ObjectId thread_id,
871 JDWP::ObjectId* contended_monitor) {
872 ScopedObjectAccessUnchecked soa(Thread::Current());
873 *contended_monitor = 0;
874 JDWP::JdwpError error;
875 Thread* thread = DecodeThread(soa, thread_id, &error);
876 if (thread == nullptr) {
879 if (!IsSuspendedForDebugger(soa, thread)) {
880 return JDWP::ERR_THREAD_NOT_SUSPENDED;
882 mirror::Object* contended_monitor_obj = Monitor::GetContendedMonitor(thread);
883 // Add() requires the thread_list_lock_ not held to avoid the lock
885 *contended_monitor = gRegistry->Add(contended_monitor_obj);
886 return JDWP::ERR_NONE;
889 JDWP::JdwpError Dbg::GetInstanceCounts(const std::vector<JDWP::RefTypeId>& class_ids,
890 std::vector<uint64_t>* counts) {
891 gc::Heap* heap = Runtime::Current()->GetHeap();
892 heap->CollectGarbage(false);
893 std::vector<mirror::Class*> classes;
895 for (size_t i = 0; i < class_ids.size(); ++i) {
896 JDWP::JdwpError error;
897 mirror::Class* c = DecodeClass(class_ids[i], &error);
901 classes.push_back(c);
902 counts->push_back(0);
904 heap->CountInstances(classes, false, &(*counts)[0]);
905 return JDWP::ERR_NONE;
908 JDWP::JdwpError Dbg::GetInstances(JDWP::RefTypeId class_id, int32_t max_count,
909 std::vector<JDWP::ObjectId>* instances) {
910 gc::Heap* heap = Runtime::Current()->GetHeap();
911 // We only want reachable instances, so do a GC.
912 heap->CollectGarbage(false);
913 JDWP::JdwpError error;
914 mirror::Class* c = DecodeClass(class_id, &error);
918 std::vector<mirror::Object*> raw_instances;
919 Runtime::Current()->GetHeap()->GetInstances(c, max_count, raw_instances);
920 for (size_t i = 0; i < raw_instances.size(); ++i) {
921 instances->push_back(gRegistry->Add(raw_instances[i]));
923 return JDWP::ERR_NONE;
926 JDWP::JdwpError Dbg::GetReferringObjects(JDWP::ObjectId object_id, int32_t max_count,
927 std::vector<JDWP::ObjectId>* referring_objects) {
928 gc::Heap* heap = Runtime::Current()->GetHeap();
929 heap->CollectGarbage(false);
930 JDWP::JdwpError error;
931 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
933 return JDWP::ERR_INVALID_OBJECT;
935 std::vector<mirror::Object*> raw_instances;
936 heap->GetReferringObjects(o, max_count, raw_instances);
937 for (size_t i = 0; i < raw_instances.size(); ++i) {
938 referring_objects->push_back(gRegistry->Add(raw_instances[i]));
940 return JDWP::ERR_NONE;
943 JDWP::JdwpError Dbg::DisableCollection(JDWP::ObjectId object_id) {
944 JDWP::JdwpError error;
945 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
947 return JDWP::ERR_INVALID_OBJECT;
949 gRegistry->DisableCollection(object_id);
950 return JDWP::ERR_NONE;
953 JDWP::JdwpError Dbg::EnableCollection(JDWP::ObjectId object_id) {
954 JDWP::JdwpError error;
955 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
956 // Unlike DisableCollection, JDWP specs do not state an invalid object causes an error. The RI
957 // also ignores these cases and never return an error. However it's not obvious why this command
958 // should behave differently from DisableCollection and IsCollected commands. So let's be more
959 // strict and return an error if this happens.
961 return JDWP::ERR_INVALID_OBJECT;
963 gRegistry->EnableCollection(object_id);
964 return JDWP::ERR_NONE;
967 JDWP::JdwpError Dbg::IsCollected(JDWP::ObjectId object_id, bool* is_collected) {
968 *is_collected = true;
969 if (object_id == 0) {
970 // Null object id is invalid.
971 return JDWP::ERR_INVALID_OBJECT;
973 // JDWP specs state an INVALID_OBJECT error is returned if the object ID is not valid. However
974 // the RI seems to ignore this and assume object has been collected.
975 JDWP::JdwpError error;
976 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
978 *is_collected = gRegistry->IsCollected(object_id);
980 return JDWP::ERR_NONE;
983 void Dbg::DisposeObject(JDWP::ObjectId object_id, uint32_t reference_count) {
984 gRegistry->DisposeObject(object_id, reference_count);
987 JDWP::JdwpTypeTag Dbg::GetTypeTag(mirror::Class* klass) {
988 DCHECK(klass != nullptr);
989 if (klass->IsArrayClass()) {
990 return JDWP::TT_ARRAY;
991 } else if (klass->IsInterface()) {
992 return JDWP::TT_INTERFACE;
994 return JDWP::TT_CLASS;
998 JDWP::JdwpError Dbg::GetReflectedType(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
999 JDWP::JdwpError error;
1000 mirror::Class* c = DecodeClass(class_id, &error);
1005 JDWP::JdwpTypeTag type_tag = GetTypeTag(c);
1006 expandBufAdd1(pReply, type_tag);
1007 expandBufAddRefTypeId(pReply, class_id);
1008 return JDWP::ERR_NONE;
1011 // Get the complete list of reference classes (i.e. all classes except
1012 // the primitive types).
1013 // Returns a newly-allocated buffer full of RefTypeId values.
1014 class ClassListCreator : public ClassVisitor {
1016 explicit ClassListCreator(std::vector<JDWP::RefTypeId>* classes) : classes_(classes) {}
1018 bool operator()(mirror::Class* c) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
1019 if (!c->IsPrimitive()) {
1020 classes_->push_back(Dbg::GetObjectRegistry()->AddRefType(c));
1026 std::vector<JDWP::RefTypeId>* const classes_;
1029 void Dbg::GetClassList(std::vector<JDWP::RefTypeId>* classes) {
1030 ClassListCreator clc(classes);
1031 Runtime::Current()->GetClassLinker()->VisitClassesWithoutClassesLock(&clc);
1034 JDWP::JdwpError Dbg::GetClassInfo(JDWP::RefTypeId class_id, JDWP::JdwpTypeTag* pTypeTag,
1035 uint32_t* pStatus, std::string* pDescriptor) {
1036 JDWP::JdwpError error;
1037 mirror::Class* c = DecodeClass(class_id, &error);
1042 if (c->IsArrayClass()) {
1043 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
1044 *pTypeTag = JDWP::TT_ARRAY;
1046 if (c->IsErroneous()) {
1047 *pStatus = JDWP::CS_ERROR;
1049 *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
1051 *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
1054 if (pDescriptor != nullptr) {
1056 *pDescriptor = c->GetDescriptor(&temp);
1058 return JDWP::ERR_NONE;
1061 void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>* ids) {
1062 std::vector<mirror::Class*> classes;
1063 Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
1065 for (size_t i = 0; i < classes.size(); ++i) {
1066 ids->push_back(gRegistry->Add(classes[i]));
1070 JDWP::JdwpError Dbg::GetReferenceType(JDWP::ObjectId object_id, JDWP::ExpandBuf* pReply) {
1071 JDWP::JdwpError error;
1072 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1074 return JDWP::ERR_INVALID_OBJECT;
1077 JDWP::JdwpTypeTag type_tag = GetTypeTag(o->GetClass());
1078 JDWP::RefTypeId type_id = gRegistry->AddRefType(o->GetClass());
1080 expandBufAdd1(pReply, type_tag);
1081 expandBufAddRefTypeId(pReply, type_id);
1083 return JDWP::ERR_NONE;
1086 JDWP::JdwpError Dbg::GetSignature(JDWP::RefTypeId class_id, std::string* signature) {
1087 JDWP::JdwpError error;
1088 mirror::Class* c = DecodeClass(class_id, &error);
1093 *signature = c->GetDescriptor(&temp);
1094 return JDWP::ERR_NONE;
1097 JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1098 JDWP::JdwpError error;
1099 mirror::Class* c = DecodeClass(class_id, &error);
1103 const char* source_file = c->GetSourceFile();
1104 if (source_file == nullptr) {
1105 return JDWP::ERR_ABSENT_INFORMATION;
1107 *result = source_file;
1108 return JDWP::ERR_NONE;
1111 JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
1112 ScopedObjectAccessUnchecked soa(Thread::Current());
1113 JDWP::JdwpError error;
1114 mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1115 if (error != JDWP::ERR_NONE) {
1116 *tag = JDWP::JT_VOID;
1119 *tag = TagFromObject(soa, o);
1120 return JDWP::ERR_NONE;
1123 size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
1128 case JDWP::JT_BOOLEAN:
1131 case JDWP::JT_SHORT:
1133 case JDWP::JT_FLOAT:
1136 case JDWP::JT_ARRAY:
1137 case JDWP::JT_OBJECT:
1138 case JDWP::JT_STRING:
1139 case JDWP::JT_THREAD:
1140 case JDWP::JT_THREAD_GROUP:
1141 case JDWP::JT_CLASS_LOADER:
1142 case JDWP::JT_CLASS_OBJECT:
1143 return sizeof(JDWP::ObjectId);
1144 case JDWP::JT_DOUBLE:
1148 LOG(FATAL) << "Unknown tag " << tag;
1153 JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1154 JDWP::JdwpError error;
1155 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1159 *length = a->GetLength();
1160 return JDWP::ERR_NONE;
1163 JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
1164 JDWP::JdwpError error;
1165 mirror::Array* a = DecodeNonNullArray(array_id, &error);
1170 if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1171 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
1172 return JDWP::ERR_INVALID_LENGTH;
1174 JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1175 expandBufAdd1(pReply, element_tag);
1176 expandBufAdd4BE(pReply, count);
1178 if (IsPrimitiveTag(element_tag)) {
1179 size_t width = GetTagWidth(element_tag);
1180 uint8_t* dst = expandBufAddSpace(pReply, count * width);
1182 const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
1183 for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1184 } else if (width == 4) {
1185 const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
1186 for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1187 } else if (width == 2) {
1188 const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
1189 for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1191 const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
1192 memcpy(dst, &src[offset * width], count * width);
1195 ScopedObjectAccessUnchecked soa(Thread::Current());
1196 mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
1197 for (int i = 0; i < count; ++i) {
1198 mirror::Object* element = oa->Get(offset + i);
1199 JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
1201 expandBufAdd1(pReply, specific_tag);
1202 expandBufAddObjectId(pReply, gRegistry->Add(element));
1206 return JDWP::ERR_NONE;
1209 template <typename T>
1210 static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
1211 NO_THREAD_SAFETY_ANALYSIS {
1212 // TODO: fix when annotalysis correctly handles non-member functions.
1213 DCHECK(a->GetClass()->IsPrimitiveArray());
1215 T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
1216 for (int i = 0; i < count; ++i) {
1217 *dst++ = src->ReadValue(sizeof(T));
1221 JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
1222 JDWP::Request* request) {
1223 JDWP::JdwpError error;
1224 mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1225 if (dst == nullptr) {
1229 if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
1230 LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
1231 return JDWP::ERR_INVALID_LENGTH;
1233 JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
1235 if (IsPrimitiveTag(element_tag)) {
1236 size_t width = GetTagWidth(element_tag);
1238 CopyArrayData<uint64_t>(dst, request, offset, count);
1239 } else if (width == 4) {
1240 CopyArrayData<uint32_t>(dst, request, offset, count);
1241 } else if (width == 2) {
1242 CopyArrayData<uint16_t>(dst, request, offset, count);
1244 CopyArrayData<uint8_t>(dst, request, offset, count);
1247 mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
1248 for (int i = 0; i < count; ++i) {
1249 JDWP::ObjectId id = request->ReadObjectId();
1250 mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1251 if (error != JDWP::ERR_NONE) {
1254 // Check if the object's type is compatible with the array's type.
1255 if (o != nullptr && !o->InstanceOf(oa->GetClass()->GetComponentType())) {
1256 return JDWP::ERR_TYPE_MISMATCH;
1258 oa->Set<false>(offset + i, o);
1262 return JDWP::ERR_NONE;
1265 JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1266 Thread* self = Thread::Current();
1267 mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1268 if (new_string == nullptr) {
1269 DCHECK(self->IsExceptionPending());
1270 self->ClearException();
1271 LOG(ERROR) << "Could not allocate string";
1273 return JDWP::ERR_OUT_OF_MEMORY;
1275 *new_string_id = gRegistry->Add(new_string);
1276 return JDWP::ERR_NONE;
1279 JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
1280 JDWP::JdwpError error;
1281 mirror::Class* c = DecodeClass(class_id, &error);
1286 Thread* self = Thread::Current();
1287 mirror::Object* new_object;
1288 if (c->IsStringClass()) {
1289 // Special case for java.lang.String.
1290 gc::AllocatorType allocator_type = Runtime::Current()->GetHeap()->GetCurrentAllocator();
1291 mirror::SetStringCountVisitor visitor(0);
1292 new_object = mirror::String::Alloc<true>(self, 0, allocator_type, visitor);
1294 new_object = c->AllocObject(self);
1296 if (new_object == nullptr) {
1297 DCHECK(self->IsExceptionPending());
1298 self->ClearException();
1299 LOG(ERROR) << "Could not allocate object of type " << PrettyDescriptor(c);
1301 return JDWP::ERR_OUT_OF_MEMORY;
1303 *new_object_id = gRegistry->Add(new_object);
1304 return JDWP::ERR_NONE;
1308 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1310 JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
1311 JDWP::ObjectId* new_array_id) {
1312 JDWP::JdwpError error;
1313 mirror::Class* c = DecodeClass(array_class_id, &error);
1318 Thread* self = Thread::Current();
1319 gc::Heap* heap = Runtime::Current()->GetHeap();
1320 mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1321 c->GetComponentSizeShift(),
1322 heap->GetCurrentAllocator());
1323 if (new_array == nullptr) {
1324 DCHECK(self->IsExceptionPending());
1325 self->ClearException();
1326 LOG(ERROR) << "Could not allocate array of type " << PrettyDescriptor(c);
1328 return JDWP::ERR_OUT_OF_MEMORY;
1330 *new_array_id = gRegistry->Add(new_array);
1331 return JDWP::ERR_NONE;
1334 JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
1335 return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
1338 static JDWP::MethodId ToMethodId(ArtMethod* m)
1339 SHARED_REQUIRES(Locks::mutator_lock_) {
1340 return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(GetCanonicalMethod(m)));
1343 static ArtField* FromFieldId(JDWP::FieldId fid)
1344 SHARED_REQUIRES(Locks::mutator_lock_) {
1345 return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
1348 static ArtMethod* FromMethodId(JDWP::MethodId mid)
1349 SHARED_REQUIRES(Locks::mutator_lock_) {
1350 return reinterpret_cast<ArtMethod*>(static_cast<uintptr_t>(mid));
1353 bool Dbg::MatchThread(JDWP::ObjectId expected_thread_id, Thread* event_thread) {
1354 CHECK(event_thread != nullptr);
1355 JDWP::JdwpError error;
1356 mirror::Object* expected_thread_peer = gRegistry->Get<mirror::Object*>(
1357 expected_thread_id, &error);
1358 return expected_thread_peer == event_thread->GetPeer();
1361 bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1362 const JDWP::EventLocation& event_location) {
1363 if (expected_location.dex_pc != event_location.dex_pc) {
1366 ArtMethod* m = FromMethodId(expected_location.method_id);
1367 return m == event_location.method;
1370 bool Dbg::MatchType(mirror::Class* event_class, JDWP::RefTypeId class_id) {
1371 if (event_class == nullptr) {
1374 JDWP::JdwpError error;
1375 mirror::Class* expected_class = DecodeClass(class_id, &error);
1376 CHECK(expected_class != nullptr);
1377 return expected_class->IsAssignableFrom(event_class);
1380 bool Dbg::MatchField(JDWP::RefTypeId expected_type_id, JDWP::FieldId expected_field_id,
1381 ArtField* event_field) {
1382 ArtField* expected_field = FromFieldId(expected_field_id);
1383 if (expected_field != event_field) {
1386 return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1389 bool Dbg::MatchInstance(JDWP::ObjectId expected_instance_id, mirror::Object* event_instance) {
1390 JDWP::JdwpError error;
1391 mirror::Object* modifier_instance = gRegistry->Get<mirror::Object*>(expected_instance_id, &error);
1392 return modifier_instance == event_instance;
1395 void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, ArtMethod* m, uint32_t dex_pc) {
1397 memset(location, 0, sizeof(*location));
1399 mirror::Class* c = m->GetDeclaringClass();
1400 location->type_tag = GetTypeTag(c);
1401 location->class_id = gRegistry->AddRefType(c);
1402 location->method_id = ToMethodId(m);
1403 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
1407 std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
1408 ArtMethod* m = FromMethodId(method_id);
1412 return m->GetInterfaceMethodIfProxy(sizeof(void*))->GetName();
1415 std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
1416 ArtField* f = FromFieldId(field_id);
1420 return f->GetName();
1424 * Augment the access flags for synthetic methods and fields by setting
1425 * the (as described by the spec) "0xf0000000 bit". Also, strip out any
1426 * flags not specified by the Java programming language.
1428 static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1429 accessFlags &= kAccJavaFlagsMask;
1430 if ((accessFlags & kAccSynthetic) != 0) {
1431 accessFlags |= 0xf0000000;
1437 * Circularly shifts registers so that arguments come first. Debuggers
1438 * expect slots to begin with arguments, but dex code places them at
1441 static uint16_t MangleSlot(uint16_t slot, ArtMethod* m)
1442 SHARED_REQUIRES(Locks::mutator_lock_) {
1443 const DexFile::CodeItem* code_item = m->GetCodeItem();
1444 if (code_item == nullptr) {
1445 // We should not get here for a method without code (native, proxy or abstract). Log it and
1446 // return the slot as is since all registers are arguments.
1447 LOG(WARNING) << "Trying to mangle slot for method without code " << PrettyMethod(m);
1450 uint16_t ins_size = code_item->ins_size_;
1451 uint16_t locals_size = code_item->registers_size_ - ins_size;
1452 if (slot >= locals_size) {
1453 return slot - locals_size;
1455 return slot + ins_size;
1460 * Circularly shifts registers so that arguments come last. Reverts
1461 * slots to dex style argument placement.
1463 static uint16_t DemangleSlot(uint16_t slot, ArtMethod* m, JDWP::JdwpError* error)
1464 SHARED_REQUIRES(Locks::mutator_lock_) {
1465 const DexFile::CodeItem* code_item = m->GetCodeItem();
1466 if (code_item == nullptr) {
1467 // We should not get here for a method without code (native, proxy or abstract). Log it and
1468 // return the slot as is since all registers are arguments.
1469 LOG(WARNING) << "Trying to demangle slot for method without code " << PrettyMethod(m);
1470 uint16_t vreg_count = ArtMethod::NumArgRegisters(m->GetShorty());
1471 if (slot < vreg_count) {
1472 *error = JDWP::ERR_NONE;
1476 if (slot < code_item->registers_size_) {
1477 uint16_t ins_size = code_item->ins_size_;
1478 uint16_t locals_size = code_item->registers_size_ - ins_size;
1479 *error = JDWP::ERR_NONE;
1480 return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1484 // Slot is invalid in the method.
1485 LOG(ERROR) << "Invalid local slot " << slot << " for method " << PrettyMethod(m);
1486 *error = JDWP::ERR_INVALID_SLOT;
1487 return DexFile::kDexNoIndex16;
1490 JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic,
1491 JDWP::ExpandBuf* pReply) {
1492 JDWP::JdwpError error;
1493 mirror::Class* c = DecodeClass(class_id, &error);
1498 size_t instance_field_count = c->NumInstanceFields();
1499 size_t static_field_count = c->NumStaticFields();
1501 expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1503 for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
1504 ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) :
1505 c->GetStaticField(i - instance_field_count);
1506 expandBufAddFieldId(pReply, ToFieldId(f));
1507 expandBufAddUtf8String(pReply, f->GetName());
1508 expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
1510 static const char genericSignature[1] = "";
1511 expandBufAddUtf8String(pReply, genericSignature);
1513 expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1515 return JDWP::ERR_NONE;
1518 JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
1519 JDWP::ExpandBuf* pReply) {
1520 JDWP::JdwpError error;
1521 mirror::Class* c = DecodeClass(class_id, &error);
1526 expandBufAdd4BE(pReply, c->NumMethods());
1528 auto* cl = Runtime::Current()->GetClassLinker();
1529 auto ptr_size = cl->GetImagePointerSize();
1530 for (ArtMethod& m : c->GetMethods(ptr_size)) {
1531 expandBufAddMethodId(pReply, ToMethodId(&m));
1532 expandBufAddUtf8String(pReply, m.GetInterfaceMethodIfProxy(sizeof(void*))->GetName());
1533 expandBufAddUtf8String(pReply,
1534 m.GetInterfaceMethodIfProxy(sizeof(void*))->GetSignature().ToString());
1536 const char* generic_signature = "";
1537 expandBufAddUtf8String(pReply, generic_signature);
1539 expandBufAdd4BE(pReply, MangleAccessFlags(m.GetAccessFlags()));
1541 return JDWP::ERR_NONE;
1544 JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
1545 JDWP::JdwpError error;
1546 Thread* self = Thread::Current();
1547 StackHandleScope<1> hs(self);
1548 Handle<mirror::Class> c(hs.NewHandle(DecodeClass(class_id, &error)));
1549 if (c.Get() == nullptr) {
1552 size_t interface_count = c->NumDirectInterfaces();
1553 expandBufAdd4BE(pReply, interface_count);
1554 for (size_t i = 0; i < interface_count; ++i) {
1555 expandBufAddRefTypeId(pReply,
1556 gRegistry->AddRefType(mirror::Class::GetDirectInterface(self, c, i)));
1558 return JDWP::ERR_NONE;
1561 void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
1562 struct DebugCallbackContext {
1564 JDWP::ExpandBuf* pReply;
1566 static bool Callback(void* context, const DexFile::PositionInfo& entry) {
1567 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1568 expandBufAdd8BE(pContext->pReply, entry.address_);
1569 expandBufAdd4BE(pContext->pReply, entry.line_);
1570 pContext->numItems++;
1574 ArtMethod* m = FromMethodId(method_id);
1575 const DexFile::CodeItem* code_item = m->GetCodeItem();
1576 uint64_t start, end;
1577 if (code_item == nullptr) {
1578 DCHECK(m->IsNative() || m->IsProxyMethod());
1583 // Return the index of the last instruction
1584 end = code_item->insns_size_in_code_units_ - 1;
1587 expandBufAdd8BE(pReply, start);
1588 expandBufAdd8BE(pReply, end);
1590 // Add numLines later
1591 size_t numLinesOffset = expandBufGetLength(pReply);
1592 expandBufAdd4BE(pReply, 0);
1594 DebugCallbackContext context;
1595 context.numItems = 0;
1596 context.pReply = pReply;
1598 if (code_item != nullptr) {
1599 m->GetDexFile()->DecodeDebugPositionInfo(code_item, DebugCallbackContext::Callback, &context);
1602 JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
1605 void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1606 JDWP::ExpandBuf* pReply) {
1607 struct DebugCallbackContext {
1609 JDWP::ExpandBuf* pReply;
1610 size_t variable_count;
1613 static void Callback(void* context, const DexFile::LocalInfo& entry)
1614 SHARED_REQUIRES(Locks::mutator_lock_) {
1615 DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1617 uint16_t slot = entry.reg_;
1618 VLOG(jdwp) << StringPrintf(" %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
1619 pContext->variable_count, entry.start_address_,
1620 entry.end_address_ - entry.start_address_,
1621 entry.name_, entry.descriptor_, entry.signature_, slot,
1622 MangleSlot(slot, pContext->method));
1624 slot = MangleSlot(slot, pContext->method);
1626 expandBufAdd8BE(pContext->pReply, entry.start_address_);
1627 expandBufAddUtf8String(pContext->pReply, entry.name_);
1628 expandBufAddUtf8String(pContext->pReply, entry.descriptor_);
1629 if (pContext->with_generic) {
1630 expandBufAddUtf8String(pContext->pReply, entry.signature_);
1632 expandBufAdd4BE(pContext->pReply, entry.end_address_- entry.start_address_);
1633 expandBufAdd4BE(pContext->pReply, slot);
1635 ++pContext->variable_count;
1638 ArtMethod* m = FromMethodId(method_id);
1640 // arg_count considers doubles and longs to take 2 units.
1641 // variable_count considers everything to take 1 unit.
1642 std::string shorty(m->GetShorty());
1643 expandBufAdd4BE(pReply, ArtMethod::NumArgRegisters(shorty));
1645 // We don't know the total number of variables yet, so leave a blank and update it later.
1646 size_t variable_count_offset = expandBufGetLength(pReply);
1647 expandBufAdd4BE(pReply, 0);
1649 DebugCallbackContext context;
1651 context.pReply = pReply;
1652 context.variable_count = 0;
1653 context.with_generic = with_generic;
1655 const DexFile::CodeItem* code_item = m->GetCodeItem();
1656 if (code_item != nullptr) {
1657 m->GetDexFile()->DecodeDebugLocalInfo(
1658 code_item, m->IsStatic(), m->GetDexMethodIndex(), DebugCallbackContext::Callback,
1662 JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
1665 void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1666 JDWP::ExpandBuf* pReply) {
1667 ArtMethod* m = FromMethodId(method_id);
1668 JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
1669 OutputJValue(tag, return_value, pReply);
1672 void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1673 JDWP::ExpandBuf* pReply) {
1674 ArtField* f = FromFieldId(field_id);
1675 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
1676 OutputJValue(tag, field_value, pReply);
1679 JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
1680 std::vector<uint8_t>* bytecodes) {
1681 ArtMethod* m = FromMethodId(method_id);
1683 return JDWP::ERR_INVALID_METHODID;
1685 const DexFile::CodeItem* code_item = m->GetCodeItem();
1686 size_t byte_count = code_item->insns_size_in_code_units_ * 2;
1687 const uint8_t* begin = reinterpret_cast<const uint8_t*>(code_item->insns_);
1688 const uint8_t* end = begin + byte_count;
1689 for (const uint8_t* p = begin; p != end; ++p) {
1690 bytecodes->push_back(*p);
1692 return JDWP::ERR_NONE;
1695 JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
1696 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
1699 JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
1700 return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
1703 static JValue GetArtFieldValue(ArtField* f, mirror::Object* o)
1704 SHARED_REQUIRES(Locks::mutator_lock_) {
1705 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1707 switch (fieldType) {
1708 case Primitive::kPrimBoolean:
1709 field_value.SetZ(f->GetBoolean(o));
1712 case Primitive::kPrimByte:
1713 field_value.SetB(f->GetByte(o));
1716 case Primitive::kPrimChar:
1717 field_value.SetC(f->GetChar(o));
1720 case Primitive::kPrimShort:
1721 field_value.SetS(f->GetShort(o));
1724 case Primitive::kPrimInt:
1725 case Primitive::kPrimFloat:
1726 // Int and Float must be treated as 32-bit values in JDWP.
1727 field_value.SetI(f->GetInt(o));
1730 case Primitive::kPrimLong:
1731 case Primitive::kPrimDouble:
1732 // Long and Double must be treated as 64-bit values in JDWP.
1733 field_value.SetJ(f->GetLong(o));
1736 case Primitive::kPrimNot:
1737 field_value.SetL(f->GetObject(o));
1740 case Primitive::kPrimVoid:
1741 LOG(FATAL) << "Attempt to read from field of type 'void'";
1744 LOG(FATAL) << "Attempt to read from field of unknown type";
1748 static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1749 JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
1751 SHARED_REQUIRES(Locks::mutator_lock_) {
1752 JDWP::JdwpError error;
1753 mirror::Class* c = DecodeClass(ref_type_id, &error);
1754 if (ref_type_id != 0 && c == nullptr) {
1758 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
1759 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
1760 return JDWP::ERR_INVALID_OBJECT;
1762 ArtField* f = FromFieldId(field_id);
1764 mirror::Class* receiver_class = c;
1765 if (receiver_class == nullptr && o != nullptr) {
1766 receiver_class = o->GetClass();
1768 // TODO: should we give up now if receiver_class is null?
1769 if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
1770 LOG(INFO) << "ERR_INVALID_FIELDID: " << PrettyField(f) << " " << PrettyClass(receiver_class);
1771 return JDWP::ERR_INVALID_FIELDID;
1774 // The RI only enforces the static/non-static mismatch in one direction.
1775 // TODO: should we change the tests and check both?
1777 if (!f->IsStatic()) {
1778 return JDWP::ERR_INVALID_FIELDID;
1781 if (f->IsStatic()) {
1782 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.GetValues"
1783 << " on static field " << PrettyField(f);
1786 if (f->IsStatic()) {
1787 o = f->GetDeclaringClass();
1790 JValue field_value(GetArtFieldValue(f, o));
1791 JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
1792 Dbg::OutputJValue(tag, &field_value, pReply);
1793 return JDWP::ERR_NONE;
1796 JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
1797 JDWP::ExpandBuf* pReply) {
1798 return GetFieldValueImpl(0, object_id, field_id, pReply, false);
1801 JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1802 JDWP::ExpandBuf* pReply) {
1803 return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
1806 static JDWP::JdwpError SetArtFieldValue(ArtField* f, mirror::Object* o, uint64_t value, int width)
1807 SHARED_REQUIRES(Locks::mutator_lock_) {
1808 Primitive::Type fieldType = f->GetTypeAsPrimitiveType();
1809 // Debugging only happens at runtime so we know we are not running in a transaction.
1810 static constexpr bool kNoTransactionMode = false;
1811 switch (fieldType) {
1812 case Primitive::kPrimBoolean:
1814 f->SetBoolean<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1815 return JDWP::ERR_NONE;
1817 case Primitive::kPrimByte:
1819 f->SetByte<kNoTransactionMode>(o, static_cast<uint8_t>(value));
1820 return JDWP::ERR_NONE;
1822 case Primitive::kPrimChar:
1824 f->SetChar<kNoTransactionMode>(o, static_cast<uint16_t>(value));
1825 return JDWP::ERR_NONE;
1827 case Primitive::kPrimShort:
1829 f->SetShort<kNoTransactionMode>(o, static_cast<int16_t>(value));
1830 return JDWP::ERR_NONE;
1832 case Primitive::kPrimInt:
1833 case Primitive::kPrimFloat:
1835 // Int and Float must be treated as 32-bit values in JDWP.
1836 f->SetInt<kNoTransactionMode>(o, static_cast<int32_t>(value));
1837 return JDWP::ERR_NONE;
1839 case Primitive::kPrimLong:
1840 case Primitive::kPrimDouble:
1842 // Long and Double must be treated as 64-bit values in JDWP.
1843 f->SetLong<kNoTransactionMode>(o, value);
1844 return JDWP::ERR_NONE;
1846 case Primitive::kPrimNot: {
1847 JDWP::JdwpError error;
1848 mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1849 if (error != JDWP::ERR_NONE) {
1850 return JDWP::ERR_INVALID_OBJECT;
1853 mirror::Class* field_type;
1855 StackHandleScope<2> hs(Thread::Current());
1856 HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1857 HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
1858 field_type = f->GetType<true>();
1860 if (!field_type->IsAssignableFrom(v->GetClass())) {
1861 return JDWP::ERR_INVALID_OBJECT;
1864 f->SetObject<kNoTransactionMode>(o, v);
1865 return JDWP::ERR_NONE;
1868 case Primitive::kPrimVoid:
1869 LOG(FATAL) << "Attempt to write to field of type 'void'";
1872 LOG(FATAL) << "Attempt to write to field of unknown type";
1876 static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
1877 uint64_t value, int width, bool is_static)
1878 SHARED_REQUIRES(Locks::mutator_lock_) {
1879 JDWP::JdwpError error;
1880 mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
1881 if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
1882 return JDWP::ERR_INVALID_OBJECT;
1884 ArtField* f = FromFieldId(field_id);
1886 // The RI only enforces the static/non-static mismatch in one direction.
1887 // TODO: should we change the tests and check both?
1889 if (!f->IsStatic()) {
1890 return JDWP::ERR_INVALID_FIELDID;
1893 if (f->IsStatic()) {
1894 LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues"
1895 << " on static field " << PrettyField(f);
1898 if (f->IsStatic()) {
1899 o = f->GetDeclaringClass();
1901 return SetArtFieldValue(f, o, value, width);
1904 JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
1906 return SetFieldValueImpl(object_id, field_id, value, width, false);
1909 JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
1910 return SetFieldValueImpl(0, field_id, value, width, true);
1913 JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
1914 JDWP::JdwpError error;
1915 mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
1916 if (error != JDWP::ERR_NONE) {
1919 if (obj == nullptr) {
1920 return JDWP::ERR_INVALID_OBJECT;
1923 ScopedObjectAccessUnchecked soa(Thread::Current());
1924 mirror::Class* java_lang_String = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_String);
1925 if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
1926 // This isn't a string.
1927 return JDWP::ERR_INVALID_STRING;
1930 *str = obj->AsString()->ToModifiedUtf8();
1931 return JDWP::ERR_NONE;
1934 void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
1935 if (IsPrimitiveTag(tag)) {
1936 expandBufAdd1(pReply, tag);
1937 if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
1938 expandBufAdd1(pReply, return_value->GetI());
1939 } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
1940 expandBufAdd2BE(pReply, return_value->GetI());
1941 } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
1942 expandBufAdd4BE(pReply, return_value->GetI());
1943 } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1944 expandBufAdd8BE(pReply, return_value->GetJ());
1946 CHECK_EQ(tag, JDWP::JT_VOID);
1949 ScopedObjectAccessUnchecked soa(Thread::Current());
1950 mirror::Object* value = return_value->GetL();
1951 expandBufAdd1(pReply, TagFromObject(soa, value));
1952 expandBufAddObjectId(pReply, gRegistry->Add(value));
1956 JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
1957 ScopedObjectAccessUnchecked soa(Thread::Current());
1958 JDWP::JdwpError error;
1959 DecodeThread(soa, thread_id, &error);
1960 if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
1964 // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
1965 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1966 CHECK(thread_object != nullptr) << error;
1967 ArtField* java_lang_Thread_name_field =
1968 soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
1970 reinterpret_cast<mirror::String*>(java_lang_Thread_name_field->GetObject(thread_object));
1972 *name = s->ToModifiedUtf8();
1974 return JDWP::ERR_NONE;
1977 JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
1978 ScopedObjectAccessUnchecked soa(Thread::Current());
1979 JDWP::JdwpError error;
1980 mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1981 if (error != JDWP::ERR_NONE) {
1982 return JDWP::ERR_INVALID_OBJECT;
1984 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroup");
1985 // Okay, so it's an object, but is it actually a thread?
1986 DecodeThread(soa, thread_id, &error);
1987 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
1988 // Zombie threads are in the null group.
1989 expandBufAddObjectId(pReply, JDWP::ObjectId(0));
1990 error = JDWP::ERR_NONE;
1991 } else if (error == JDWP::ERR_NONE) {
1992 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
1993 CHECK(c != nullptr);
1994 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
1995 CHECK(f != nullptr);
1996 mirror::Object* group = f->GetObject(thread_object);
1997 CHECK(group != nullptr);
1998 JDWP::ObjectId thread_group_id = gRegistry->Add(group);
1999 expandBufAddObjectId(pReply, thread_group_id);
2004 static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
2005 JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
2006 SHARED_REQUIRES(Locks::mutator_lock_) {
2007 mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
2009 if (*error != JDWP::ERR_NONE) {
2012 if (thread_group == nullptr) {
2013 *error = JDWP::ERR_INVALID_OBJECT;
2016 mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
2017 CHECK(c != nullptr);
2018 if (!c->IsAssignableFrom(thread_group->GetClass())) {
2019 // This is not a java.lang.ThreadGroup.
2020 *error = JDWP::ERR_INVALID_THREAD_GROUP;
2023 *error = JDWP::ERR_NONE;
2024 return thread_group;
2027 JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
2028 ScopedObjectAccessUnchecked soa(Thread::Current());
2029 JDWP::JdwpError error;
2030 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2031 if (error != JDWP::ERR_NONE) {
2034 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupName");
2035 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_name);
2036 CHECK(f != nullptr);
2037 mirror::String* s = reinterpret_cast<mirror::String*>(f->GetObject(thread_group));
2039 std::string thread_group_name(s->ToModifiedUtf8());
2040 expandBufAddUtf8String(pReply, thread_group_name);
2041 return JDWP::ERR_NONE;
2044 JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
2045 ScopedObjectAccessUnchecked soa(Thread::Current());
2046 JDWP::JdwpError error;
2047 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2048 if (error != JDWP::ERR_NONE) {
2051 mirror::Object* parent;
2053 ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupParent");
2054 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_parent);
2055 CHECK(f != nullptr);
2056 parent = f->GetObject(thread_group);
2058 JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
2059 expandBufAddObjectId(pReply, parent_group_id);
2060 return JDWP::ERR_NONE;
2063 static void GetChildThreadGroups(ScopedObjectAccessUnchecked& soa, mirror::Object* thread_group,
2064 std::vector<JDWP::ObjectId>* child_thread_group_ids)
2065 SHARED_REQUIRES(Locks::mutator_lock_) {
2066 CHECK(thread_group != nullptr);
2068 // Get the int "ngroups" count of this thread group...
2069 ArtField* ngroups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_ngroups);
2070 CHECK(ngroups_field != nullptr);
2071 const int32_t size = ngroups_field->GetInt(thread_group);
2076 // Get the ThreadGroup[] "groups" out of this thread group...
2077 ArtField* groups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_groups);
2078 mirror::Object* groups_array = groups_field->GetObject(thread_group);
2080 CHECK(groups_array != nullptr);
2081 CHECK(groups_array->IsObjectArray());
2083 mirror::ObjectArray<mirror::Object>* groups_array_as_array =
2084 groups_array->AsObjectArray<mirror::Object>();
2086 // Copy the first 'size' elements out of the array into the result.
2087 ObjectRegistry* registry = Dbg::GetObjectRegistry();
2088 for (int32_t i = 0; i < size; ++i) {
2089 child_thread_group_ids->push_back(registry->Add(groups_array_as_array->Get(i)));
2093 JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2094 JDWP::ExpandBuf* pReply) {
2095 ScopedObjectAccessUnchecked soa(Thread::Current());
2096 JDWP::JdwpError error;
2097 mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
2098 if (error != JDWP::ERR_NONE) {
2102 // Add child threads.
2104 std::vector<JDWP::ObjectId> child_thread_ids;
2105 GetThreads(thread_group, &child_thread_ids);
2106 expandBufAdd4BE(pReply, child_thread_ids.size());
2107 for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2108 expandBufAddObjectId(pReply, child_thread_id);
2112 // Add child thread groups.
2114 std::vector<JDWP::ObjectId> child_thread_groups_ids;
2115 GetChildThreadGroups(soa, thread_group, &child_thread_groups_ids);
2116 expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2117 for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2118 expandBufAddObjectId(pReply, child_thread_group_id);
2122 return JDWP::ERR_NONE;
2125 JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
2126 ScopedObjectAccessUnchecked soa(Thread::Current());
2127 ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
2128 mirror::Object* group = f->GetObject(f->GetDeclaringClass());
2129 return gRegistry->Add(group);
2132 JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2135 return JDWP::TS_MONITOR;
2139 return JDWP::TS_RUNNING;
2141 return JDWP::TS_SLEEPING;
2144 return JDWP::TS_ZOMBIE;
2146 case kWaitingForCheckPointsToRun:
2147 case kWaitingForDebuggerSend:
2148 case kWaitingForDebuggerSuspension:
2149 case kWaitingForDebuggerToAttach:
2150 case kWaitingForDeoptimization:
2151 case kWaitingForGcToComplete:
2152 case kWaitingForGetObjectsAllocated:
2153 case kWaitingForJniOnLoad:
2154 case kWaitingForMethodTracingStart:
2155 case kWaitingForSignalCatcherOutput:
2156 case kWaitingForVisitObjects:
2157 case kWaitingInMainDebuggerLoop:
2158 case kWaitingInMainSignalCatcherLoop:
2159 case kWaitingPerformingGc:
2160 case kWaitingWeakGcRootRead:
2161 case kWaitingForGcThreadFlip:
2163 return JDWP::TS_WAIT;
2164 // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2166 LOG(FATAL) << "Unknown thread state: " << state;
2167 return JDWP::TS_ZOMBIE;
2170 JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2171 JDWP::JdwpSuspendStatus* pSuspendStatus) {
2172 ScopedObjectAccess soa(Thread::Current());
2174 *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2176 JDWP::JdwpError error;
2177 Thread* thread = DecodeThread(soa, thread_id, &error);
2178 if (error != JDWP::ERR_NONE) {
2179 if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2180 *pThreadStatus = JDWP::TS_ZOMBIE;
2181 return JDWP::ERR_NONE;
2186 if (IsSuspendedForDebugger(soa, thread)) {
2187 *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
2190 *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
2191 return JDWP::ERR_NONE;
2194 JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
2195 ScopedObjectAccess soa(Thread::Current());
2196 JDWP::JdwpError error;
2197 Thread* thread = DecodeThread(soa, thread_id, &error);
2198 if (error != JDWP::ERR_NONE) {
2201 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
2202 expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
2203 return JDWP::ERR_NONE;
2206 JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2207 ScopedObjectAccess soa(Thread::Current());
2208 JDWP::JdwpError error;
2209 Thread* thread = DecodeThread(soa, thread_id, &error);
2210 if (error != JDWP::ERR_NONE) {
2213 thread->Interrupt(soa.Self());
2214 return JDWP::ERR_NONE;
2217 static bool IsInDesiredThreadGroup(ScopedObjectAccessUnchecked& soa,
2218 mirror::Object* desired_thread_group, mirror::Object* peer)
2219 SHARED_REQUIRES(Locks::mutator_lock_) {
2220 // Do we want threads from all thread groups?
2221 if (desired_thread_group == nullptr) {
2224 ArtField* thread_group_field = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
2225 DCHECK(thread_group_field != nullptr);
2226 mirror::Object* group = thread_group_field->GetObject(peer);
2227 return (group == desired_thread_group);
2230 void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
2231 ScopedObjectAccessUnchecked soa(Thread::Current());
2232 std::list<Thread*> all_threads_list;
2234 MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2235 all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2237 for (Thread* t : all_threads_list) {
2238 if (t == Dbg::GetDebugThread()) {
2239 // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2240 // query all threads, so it's easier if we just don't tell them about this thread.
2243 if (t->IsStillStarting()) {
2244 // This thread is being started (and has been registered in the thread list). However, it is
2245 // not completely started yet so we must ignore it.
2248 mirror::Object* peer = t->GetPeer();
2249 if (peer == nullptr) {
2250 // peer might be null if the thread is still starting up. We can't tell the debugger about
2252 // TODO: if we identified threads to the debugger by their Thread*
2253 // rather than their peer's mirror::Object*, we could fix this.
2254 // Doing so might help us report ZOMBIE threads too.
2257 if (IsInDesiredThreadGroup(soa, thread_group, peer)) {
2258 thread_ids->push_back(gRegistry->Add(peer));
2263 static int GetStackDepth(Thread* thread) SHARED_REQUIRES(Locks::mutator_lock_) {
2264 struct CountStackDepthVisitor : public StackVisitor {
2265 explicit CountStackDepthVisitor(Thread* thread_in)
2266 : StackVisitor(thread_in, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2269 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2271 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2272 if (!GetMethod()->IsRuntimeMethod()) {
2280 CountStackDepthVisitor visitor(thread);
2281 visitor.WalkStack();
2282 return visitor.depth;
2285 JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
2286 ScopedObjectAccess soa(Thread::Current());
2287 JDWP::JdwpError error;
2289 Thread* thread = DecodeThread(soa, thread_id, &error);
2290 if (error != JDWP::ERR_NONE) {
2293 if (!IsSuspendedForDebugger(soa, thread)) {
2294 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2296 *result = GetStackDepth(thread);
2297 return JDWP::ERR_NONE;
2300 JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2301 size_t frame_count, JDWP::ExpandBuf* buf) {
2302 class GetFrameVisitor : public StackVisitor {
2304 GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2305 JDWP::ExpandBuf* buf_in)
2306 SHARED_REQUIRES(Locks::mutator_lock_)
2307 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2309 start_frame_(start_frame_in),
2310 frame_count_(frame_count_in),
2312 expandBufAdd4BE(buf_, frame_count_);
2315 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
2316 if (GetMethod()->IsRuntimeMethod()) {
2317 return true; // The debugger can't do anything useful with a frame that has no Method*.
2319 if (depth_ >= start_frame_ + frame_count_) {
2322 if (depth_ >= start_frame_) {
2323 JDWP::FrameId frame_id(GetFrameId());
2324 JDWP::JdwpLocation location;
2325 SetJdwpLocation(&location, GetMethod(), GetDexPc());
2326 VLOG(jdwp) << StringPrintf(" Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
2327 expandBufAdd8BE(buf_, frame_id);
2328 expandBufAddLocation(buf_, location);
2336 const size_t start_frame_;
2337 const size_t frame_count_;
2338 JDWP::ExpandBuf* buf_;
2341 ScopedObjectAccessUnchecked soa(Thread::Current());
2342 JDWP::JdwpError error;
2343 Thread* thread = DecodeThread(soa, thread_id, &error);
2344 if (error != JDWP::ERR_NONE) {
2347 if (!IsSuspendedForDebugger(soa, thread)) {
2348 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2350 GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
2351 visitor.WalkStack();
2352 return JDWP::ERR_NONE;
2355 JDWP::ObjectId Dbg::GetThreadSelfId() {
2356 return GetThreadId(Thread::Current());
2359 JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
2360 ScopedObjectAccessUnchecked soa(Thread::Current());
2361 return gRegistry->Add(thread->GetPeer());
2364 void Dbg::SuspendVM() {
2365 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
2366 gc::ScopedGCCriticalSection gcs(Thread::Current(),
2367 gc::kGcCauseDebugger,
2368 gc::kCollectorTypeDebugger);
2369 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
2372 void Dbg::ResumeVM() {
2373 Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
2376 JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
2377 Thread* self = Thread::Current();
2378 ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
2380 ScopedObjectAccess soa(self);
2381 JDWP::JdwpError error;
2382 peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
2384 if (peer.get() == nullptr) {
2385 return JDWP::ERR_THREAD_NOT_ALIVE;
2387 // Suspend thread to build stack trace.
2389 ThreadList* thread_list = Runtime::Current()->GetThreadList();
2390 Thread* thread = thread_list->SuspendThreadByPeer(peer.get(), request_suspension, true,
2392 if (thread != nullptr) {
2393 return JDWP::ERR_NONE;
2394 } else if (timed_out) {
2395 return JDWP::ERR_INTERNAL;
2397 return JDWP::ERR_THREAD_NOT_ALIVE;
2401 void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
2402 ScopedObjectAccessUnchecked soa(Thread::Current());
2403 JDWP::JdwpError error;
2404 mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2405 CHECK(peer != nullptr) << error;
2408 MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2409 thread = Thread::FromManagedThread(soa, peer);
2411 if (thread == nullptr) {
2412 LOG(WARNING) << "No such thread for resume: " << peer;
2417 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
2418 needs_resume = thread->GetSuspendCount() > 0;
2421 Runtime::Current()->GetThreadList()->Resume(thread, true);
2425 void Dbg::SuspendSelf() {
2426 Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
2429 struct GetThisVisitor : public StackVisitor {
2430 GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
2431 SHARED_REQUIRES(Locks::mutator_lock_)
2432 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2433 this_object(nullptr),
2434 frame_id(frame_id_in) {}
2436 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2438 virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2439 if (frame_id != GetFrameId()) {
2440 return true; // continue
2442 this_object = GetThisObject();
2447 mirror::Object* this_object;
2448 JDWP::FrameId frame_id;
2451 JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2452 JDWP::ObjectId* result) {
2453 ScopedObjectAccessUnchecked soa(Thread::Current());
2454 JDWP::JdwpError error;
2455 Thread* thread = DecodeThread(soa, thread_id, &error);
2456 if (error != JDWP::ERR_NONE) {
2459 if (!IsSuspendedForDebugger(soa, thread)) {
2460 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2462 std::unique_ptr<Context> context(Context::Create());
2463 GetThisVisitor visitor(thread, context.get(), frame_id);
2464 visitor.WalkStack();
2465 *result = gRegistry->Add(visitor.this_object);
2466 return JDWP::ERR_NONE;
2469 // Walks the stack until we find the frame with the given FrameId.
2470 class FindFrameVisitor FINAL : public StackVisitor {
2472 FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
2473 SHARED_REQUIRES(Locks::mutator_lock_)
2474 : StackVisitor(thread, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2475 frame_id_(frame_id),
2476 error_(JDWP::ERR_INVALID_FRAMEID) {}
2478 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2480 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2481 if (GetFrameId() != frame_id_) {
2482 return true; // Not our frame, carry on.
2484 ArtMethod* m = GetMethod();
2485 if (m->IsNative()) {
2486 // We can't read/write local value from/into native method.
2487 error_ = JDWP::ERR_OPAQUE_FRAME;
2489 // We found our frame.
2490 error_ = JDWP::ERR_NONE;
2495 JDWP::JdwpError GetError() const {
2500 const JDWP::FrameId frame_id_;
2501 JDWP::JdwpError error_;
2503 DISALLOW_COPY_AND_ASSIGN(FindFrameVisitor);
2506 JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2507 JDWP::ObjectId thread_id = request->ReadThreadId();
2508 JDWP::FrameId frame_id = request->ReadFrameId();
2510 ScopedObjectAccessUnchecked soa(Thread::Current());
2511 JDWP::JdwpError error;
2512 Thread* thread = DecodeThread(soa, thread_id, &error);
2513 if (error != JDWP::ERR_NONE) {
2516 if (!IsSuspendedForDebugger(soa, thread)) {
2517 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2519 // Find the frame with the given frame_id.
2520 std::unique_ptr<Context> context(Context::Create());
2521 FindFrameVisitor visitor(thread, context.get(), frame_id);
2522 visitor.WalkStack();
2523 if (visitor.GetError() != JDWP::ERR_NONE) {
2524 return visitor.GetError();
2527 // Read the values from visitor's context.
2528 int32_t slot_count = request->ReadSigned32("slot count");
2529 expandBufAdd4BE(pReply, slot_count); /* "int values" */
2530 for (int32_t i = 0; i < slot_count; ++i) {
2531 uint32_t slot = request->ReadUnsigned32("slot");
2532 JDWP::JdwpTag reqSigByte = request->ReadTag();
2534 VLOG(jdwp) << " --> slot " << slot << " " << reqSigByte;
2536 size_t width = Dbg::GetTagWidth(reqSigByte);
2537 uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
2538 error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
2539 if (error != JDWP::ERR_NONE) {
2543 return JDWP::ERR_NONE;
2546 constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2548 static std::string GetStackContextAsString(const StackVisitor& visitor)
2549 SHARED_REQUIRES(Locks::mutator_lock_) {
2550 return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
2551 PrettyMethod(visitor.GetMethod()).c_str());
2554 static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2556 SHARED_REQUIRES(Locks::mutator_lock_) {
2557 LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2558 << GetStackContextAsString(visitor);
2559 return kStackFrameLocalAccessError;
2562 JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2563 int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
2564 ArtMethod* m = visitor.GetMethod();
2565 JDWP::JdwpError error = JDWP::ERR_NONE;
2566 uint16_t vreg = DemangleSlot(slot, m, &error);
2567 if (error != JDWP::ERR_NONE) {
2570 // TODO: check that the tag is compatible with the actual type of the slot!
2572 case JDWP::JT_BOOLEAN: {
2573 CHECK_EQ(width, 1U);
2575 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2576 return FailGetLocalValue(visitor, vreg, tag);
2578 VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2579 JDWP::Set1(buf + 1, intVal != 0);
2582 case JDWP::JT_BYTE: {
2583 CHECK_EQ(width, 1U);
2585 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2586 return FailGetLocalValue(visitor, vreg, tag);
2588 VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2589 JDWP::Set1(buf + 1, intVal);
2592 case JDWP::JT_SHORT:
2593 case JDWP::JT_CHAR: {
2594 CHECK_EQ(width, 2U);
2596 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2597 return FailGetLocalValue(visitor, vreg, tag);
2599 VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2600 JDWP::Set2BE(buf + 1, intVal);
2603 case JDWP::JT_INT: {
2604 CHECK_EQ(width, 4U);
2606 if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2607 return FailGetLocalValue(visitor, vreg, tag);
2609 VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2610 JDWP::Set4BE(buf + 1, intVal);
2613 case JDWP::JT_FLOAT: {
2614 CHECK_EQ(width, 4U);
2616 if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2617 return FailGetLocalValue(visitor, vreg, tag);
2619 VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2620 JDWP::Set4BE(buf + 1, intVal);
2623 case JDWP::JT_ARRAY:
2624 case JDWP::JT_CLASS_LOADER:
2625 case JDWP::JT_CLASS_OBJECT:
2626 case JDWP::JT_OBJECT:
2627 case JDWP::JT_STRING:
2628 case JDWP::JT_THREAD:
2629 case JDWP::JT_THREAD_GROUP: {
2630 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2632 if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2633 return FailGetLocalValue(visitor, vreg, tag);
2635 mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2636 VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2637 if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2638 LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2639 reinterpret_cast<uintptr_t>(o), vreg)
2640 << GetStackContextAsString(visitor);
2643 tag = TagFromObject(soa, o);
2644 JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
2647 case JDWP::JT_DOUBLE: {
2648 CHECK_EQ(width, 8U);
2650 if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2651 return FailGetLocalValue(visitor, vreg, tag);
2653 VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2654 JDWP::Set8BE(buf + 1, longVal);
2657 case JDWP::JT_LONG: {
2658 CHECK_EQ(width, 8U);
2660 if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2661 return FailGetLocalValue(visitor, vreg, tag);
2663 VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2664 JDWP::Set8BE(buf + 1, longVal);
2668 LOG(FATAL) << "Unknown tag " << tag;
2672 // Prepend tag, which may have been updated.
2673 JDWP::Set1(buf, tag);
2674 return JDWP::ERR_NONE;
2677 JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2678 JDWP::ObjectId thread_id = request->ReadThreadId();
2679 JDWP::FrameId frame_id = request->ReadFrameId();
2681 ScopedObjectAccessUnchecked soa(Thread::Current());
2682 JDWP::JdwpError error;
2683 Thread* thread = DecodeThread(soa, thread_id, &error);
2684 if (error != JDWP::ERR_NONE) {
2687 if (!IsSuspendedForDebugger(soa, thread)) {
2688 return JDWP::ERR_THREAD_NOT_SUSPENDED;
2690 // Find the frame with the given frame_id.
2691 std::unique_ptr<Context> context(Context::Create());
2692 FindFrameVisitor visitor(thread, context.get(), frame_id);
2693 visitor.WalkStack();
2694 if (visitor.GetError() != JDWP::ERR_NONE) {
2695 return visitor.GetError();
2698 // Writes the values into visitor's context.
2699 int32_t slot_count = request->ReadSigned32("slot count");
2700 for (int32_t i = 0; i < slot_count; ++i) {
2701 uint32_t slot = request->ReadUnsigned32("slot");
2702 JDWP::JdwpTag sigByte = request->ReadTag();
2703 size_t width = Dbg::GetTagWidth(sigByte);
2704 uint64_t value = request->ReadValue(width);
2706 VLOG(jdwp) << " --> slot " << slot << " " << sigByte << " " << value;
2707 error = Dbg::SetLocalValue(thread, visitor, slot, sigByte, value, width);
2708 if (error != JDWP::ERR_NONE) {
2712 return JDWP::ERR_NONE;
2715 template<typename T>
2716 static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2717 JDWP::JdwpTag tag, T value)
2718 SHARED_REQUIRES(Locks::mutator_lock_) {
2719 LOG(ERROR) << "Failed to write " << tag << " local " << value
2720 << " (0x" << std::hex << value << ") into register v" << vreg
2721 << GetStackContextAsString(visitor);
2722 return kStackFrameLocalAccessError;
2725 JDWP::JdwpError Dbg::SetLocalValue(Thread* thread, StackVisitor& visitor, int slot,
2726 JDWP::JdwpTag tag, uint64_t value, size_t width) {
2727 ArtMethod* m = visitor.GetMethod();
2728 JDWP::JdwpError error = JDWP::ERR_NONE;
2729 uint16_t vreg = DemangleSlot(slot, m, &error);
2730 if (error != JDWP::ERR_NONE) {
2733 // TODO: check that the tag is compatible with the actual type of the slot!
2735 case JDWP::JT_BOOLEAN:
2737 CHECK_EQ(width, 1U);
2738 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2739 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2742 case JDWP::JT_SHORT:
2744 CHECK_EQ(width, 2U);
2745 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2746 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2750 CHECK_EQ(width, 4U);
2751 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2752 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2755 case JDWP::JT_FLOAT:
2756 CHECK_EQ(width, 4U);
2757 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
2758 return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2761 case JDWP::JT_ARRAY:
2762 case JDWP::JT_CLASS_LOADER:
2763 case JDWP::JT_CLASS_OBJECT:
2764 case JDWP::JT_OBJECT:
2765 case JDWP::JT_STRING:
2766 case JDWP::JT_THREAD:
2767 case JDWP::JT_THREAD_GROUP: {
2768 CHECK_EQ(width, sizeof(JDWP::ObjectId));
2769 mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2771 if (error != JDWP::ERR_NONE) {
2772 VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2773 return JDWP::ERR_INVALID_OBJECT;
2775 if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
2777 return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
2781 case JDWP::JT_DOUBLE: {
2782 CHECK_EQ(width, 8U);
2783 if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
2784 return FailSetLocalValue(visitor, vreg, tag, value);
2788 case JDWP::JT_LONG: {
2789 CHECK_EQ(width, 8U);
2790 if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
2791 return FailSetLocalValue(visitor, vreg, tag, value);
2796 LOG(FATAL) << "Unknown tag " << tag;
2800 // If we set the local variable in a compiled frame, we need to trigger a deoptimization of
2801 // the stack so we continue execution with the interpreter using the new value(s) of the updated
2802 // local variable(s). To achieve this, we install instrumentation exit stub on each method of the
2803 // thread's stack. The stub will cause the deoptimization to happen.
2804 if (!visitor.IsShadowFrame() && thread->HasDebuggerShadowFrames()) {
2805 Runtime::Current()->GetInstrumentation()->InstrumentThreadStack(thread);
2808 return JDWP::ERR_NONE;
2811 static void SetEventLocation(JDWP::EventLocation* location, ArtMethod* m, uint32_t dex_pc)
2812 SHARED_REQUIRES(Locks::mutator_lock_) {
2813 DCHECK(location != nullptr);
2815 memset(location, 0, sizeof(*location));
2817 location->method = GetCanonicalMethod(m);
2818 location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
2822 void Dbg::PostLocationEvent(ArtMethod* m, int dex_pc, mirror::Object* this_object,
2823 int event_flags, const JValue* return_value) {
2824 if (!IsDebuggerActive()) {
2827 DCHECK(m != nullptr);
2828 DCHECK_EQ(m->IsStatic(), this_object == nullptr);
2829 JDWP::EventLocation location;
2830 SetEventLocation(&location, m, dex_pc);
2832 // We need to be sure no exception is pending when calling JdwpState::PostLocationEvent.
2833 // This is required to be able to call JNI functions to create JDWP ids. To achieve this,
2834 // we temporarily clear the current thread's exception (if any) and will restore it after
2836 // Note: the only way to get a pending exception here is to suspend on a move-exception
2838 Thread* const self = Thread::Current();
2839 StackHandleScope<1> hs(self);
2840 Handle<mirror::Throwable> pending_exception(hs.NewHandle(self->GetException()));
2841 self->ClearException();
2842 if (kIsDebugBuild && pending_exception.Get() != nullptr) {
2843 const DexFile::CodeItem* code_item = location.method->GetCodeItem();
2844 const Instruction* instr = Instruction::At(&code_item->insns_[location.dex_pc]);
2845 CHECK_EQ(Instruction::MOVE_EXCEPTION, instr->Opcode());
2848 gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
2850 if (pending_exception.Get() != nullptr) {
2851 self->SetException(pending_exception.Get());
2855 void Dbg::PostFieldAccessEvent(ArtMethod* m, int dex_pc,
2856 mirror::Object* this_object, ArtField* f) {
2857 if (!IsDebuggerActive()) {
2860 DCHECK(m != nullptr);
2861 DCHECK(f != nullptr);
2862 JDWP::EventLocation location;
2863 SetEventLocation(&location, m, dex_pc);
2865 gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
2868 void Dbg::PostFieldModificationEvent(ArtMethod* m, int dex_pc,
2869 mirror::Object* this_object, ArtField* f,
2870 const JValue* field_value) {
2871 if (!IsDebuggerActive()) {
2874 DCHECK(m != nullptr);
2875 DCHECK(f != nullptr);
2876 DCHECK(field_value != nullptr);
2877 JDWP::EventLocation location;
2878 SetEventLocation(&location, m, dex_pc);
2880 gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
2884 * Finds the location where this exception will be caught. We search until we reach the top
2885 * frame, in which case this exception is considered uncaught.
2887 class CatchLocationFinder : public StackVisitor {
2889 CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
2890 SHARED_REQUIRES(Locks::mutator_lock_)
2891 : StackVisitor(self, context, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
2892 exception_(exception),
2893 handle_scope_(self),
2894 this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
2895 catch_method_(nullptr),
2896 throw_method_(nullptr),
2897 catch_dex_pc_(DexFile::kDexNoIndex),
2898 throw_dex_pc_(DexFile::kDexNoIndex) {
2901 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
2902 ArtMethod* method = GetMethod();
2903 DCHECK(method != nullptr);
2904 if (method->IsRuntimeMethod()) {
2905 // Ignore callee save method.
2906 DCHECK(method->IsCalleeSaveMethod());
2910 uint32_t dex_pc = GetDexPc();
2911 if (throw_method_ == nullptr) {
2912 // First Java method found. It is either the method that threw the exception,
2913 // or the Java native method that is reporting an exception thrown by
2915 this_at_throw_.Assign(GetThisObject());
2916 throw_method_ = method;
2917 throw_dex_pc_ = dex_pc;
2920 if (dex_pc != DexFile::kDexNoIndex) {
2921 StackHandleScope<1> hs(GetThread());
2922 uint32_t found_dex_pc;
2923 Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
2924 bool unused_clear_exception;
2925 found_dex_pc = method->FindCatchBlock(exception_class, dex_pc, &unused_clear_exception);
2926 if (found_dex_pc != DexFile::kDexNoIndex) {
2927 catch_method_ = method;
2928 catch_dex_pc_ = found_dex_pc;
2929 return false; // End stack walk.
2932 return true; // Continue stack walk.
2935 ArtMethod* GetCatchMethod() SHARED_REQUIRES(Locks::mutator_lock_) {
2936 return catch_method_;
2939 ArtMethod* GetThrowMethod() SHARED_REQUIRES(Locks::mutator_lock_) {
2940 return throw_method_;
2943 mirror::Object* GetThisAtThrow() SHARED_REQUIRES(Locks::mutator_lock_) {
2944 return this_at_throw_.Get();
2947 uint32_t GetCatchDexPc() const {
2948 return catch_dex_pc_;
2951 uint32_t GetThrowDexPc() const {
2952 return throw_dex_pc_;
2956 const Handle<mirror::Throwable>& exception_;
2957 StackHandleScope<1> handle_scope_;
2958 MutableHandle<mirror::Object> this_at_throw_;
2959 ArtMethod* catch_method_;
2960 ArtMethod* throw_method_;
2961 uint32_t catch_dex_pc_;
2962 uint32_t throw_dex_pc_;
2964 DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
2967 void Dbg::PostException(mirror::Throwable* exception_object) {
2968 if (!IsDebuggerActive()) {
2971 Thread* const self = Thread::Current();
2972 StackHandleScope<1> handle_scope(self);
2973 Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
2974 std::unique_ptr<Context> context(Context::Create());
2975 CatchLocationFinder clf(self, h_exception, context.get());
2976 clf.WalkStack(/* include_transitions */ false);
2977 JDWP::EventLocation exception_throw_location;
2978 SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
2979 JDWP::EventLocation exception_catch_location;
2980 SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
2982 gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
2983 clf.GetThisAtThrow());
2986 void Dbg::PostClassPrepare(mirror::Class* c) {
2987 if (!IsDebuggerActive()) {
2990 gJdwpState->PostClassPrepare(c);
2993 void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
2994 ArtMethod* m, uint32_t dex_pc,
2995 int event_flags, const JValue* return_value) {
2996 if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
3000 if (IsBreakpoint(m, dex_pc)) {
3001 event_flags |= kBreakpoint;
3004 // If the debugger is single-stepping one of our threads, check to
3005 // see if we're that thread and we've reached a step point.
3006 const SingleStepControl* single_step_control = thread->GetSingleStepControl();
3007 if (single_step_control != nullptr) {
3008 CHECK(!m->IsNative());
3009 if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
3010 // Step into method calls. We break when the line number
3011 // or method pointer changes. If we're in SS_MIN mode, we
3013 if (single_step_control->GetMethod() != m) {
3014 event_flags |= kSingleStep;
3015 VLOG(jdwp) << "SS new method";
3016 } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
3017 event_flags |= kSingleStep;
3018 VLOG(jdwp) << "SS new instruction";
3019 } else if (single_step_control->ContainsDexPc(dex_pc)) {
3020 event_flags |= kSingleStep;
3021 VLOG(jdwp) << "SS new line";
3023 } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
3024 // Step over method calls. We break when the line number is
3025 // different and the frame depth is <= the original frame
3026 // depth. (We can't just compare on the method, because we
3027 // might get unrolled past it by an exception, and it's tricky
3028 // to identify recursion.)
3030 int stack_depth = GetStackDepth(thread);
3032 if (stack_depth < single_step_control->GetStackDepth()) {
3033 // Popped up one or more frames, always trigger.
3034 event_flags |= kSingleStep;
3035 VLOG(jdwp) << "SS method pop";
3036 } else if (stack_depth == single_step_control->GetStackDepth()) {
3037 // Same depth, see if we moved.
3038 if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
3039 event_flags |= kSingleStep;
3040 VLOG(jdwp) << "SS new instruction";
3041 } else if (single_step_control->ContainsDexPc(dex_pc)) {
3042 event_flags |= kSingleStep;
3043 VLOG(jdwp) << "SS new line";
3047 CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
3048 // Return from the current method. We break when the frame
3051 // This differs from the "method exit" break in that it stops
3052 // with the PC at the next instruction in the returned-to
3053 // function, rather than the end of the returning function.
3055 int stack_depth = GetStackDepth(thread);
3056 if (stack_depth < single_step_control->GetStackDepth()) {
3057 event_flags |= kSingleStep;
3058 VLOG(jdwp) << "SS method pop";
3063 // If there's something interesting going on, see if it matches one
3064 // of the debugger filters.
3065 if (event_flags != 0) {
3066 Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
3070 size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
3071 switch (instrumentation_event) {
3072 case instrumentation::Instrumentation::kMethodEntered:
3073 return &method_enter_event_ref_count_;
3074 case instrumentation::Instrumentation::kMethodExited:
3075 return &method_exit_event_ref_count_;
3076 case instrumentation::Instrumentation::kDexPcMoved:
3077 return &dex_pc_change_event_ref_count_;
3078 case instrumentation::Instrumentation::kFieldRead:
3079 return &field_read_event_ref_count_;
3080 case instrumentation::Instrumentation::kFieldWritten:
3081 return &field_write_event_ref_count_;
3082 case instrumentation::Instrumentation::kExceptionCaught:
3083 return &exception_catch_event_ref_count_;
3089 // Process request while all mutator threads are suspended.
3090 void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
3091 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3092 switch (request.GetKind()) {
3093 case DeoptimizationRequest::kNothing:
3094 LOG(WARNING) << "Ignoring empty deoptimization request.";
3096 case DeoptimizationRequest::kRegisterForEvent:
3097 VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
3098 request.InstrumentationEvent());
3099 instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
3100 instrumentation_events_ |= request.InstrumentationEvent();
3102 case DeoptimizationRequest::kUnregisterForEvent:
3103 VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
3104 request.InstrumentationEvent());
3105 instrumentation->RemoveListener(&gDebugInstrumentationListener,
3106 request.InstrumentationEvent());
3107 instrumentation_events_ &= ~request.InstrumentationEvent();
3109 case DeoptimizationRequest::kFullDeoptimization:
3110 VLOG(jdwp) << "Deoptimize the world ...";
3111 instrumentation->DeoptimizeEverything(kDbgInstrumentationKey);
3112 VLOG(jdwp) << "Deoptimize the world DONE";
3114 case DeoptimizationRequest::kFullUndeoptimization:
3115 VLOG(jdwp) << "Undeoptimize the world ...";
3116 instrumentation->UndeoptimizeEverything(kDbgInstrumentationKey);
3117 VLOG(jdwp) << "Undeoptimize the world DONE";
3119 case DeoptimizationRequest::kSelectiveDeoptimization:
3120 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " ...";
3121 instrumentation->Deoptimize(request.Method());
3122 VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " DONE";
3124 case DeoptimizationRequest::kSelectiveUndeoptimization:
3125 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " ...";
3126 instrumentation->Undeoptimize(request.Method());
3127 VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " DONE";
3130 LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
3135 void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
3136 if (req.GetKind() == DeoptimizationRequest::kNothing) {
3140 MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
3141 RequestDeoptimizationLocked(req);
3144 void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
3145 switch (req.GetKind()) {
3146 case DeoptimizationRequest::kRegisterForEvent: {
3147 DCHECK_NE(req.InstrumentationEvent(), 0u);
3148 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
3149 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
3150 req.InstrumentationEvent());
3151 if (*counter == 0) {
3152 VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
3153 deoptimization_requests_.size(), req.InstrumentationEvent());
3154 deoptimization_requests_.push_back(req);
3156 *counter = *counter + 1;
3159 case DeoptimizationRequest::kUnregisterForEvent: {
3160 DCHECK_NE(req.InstrumentationEvent(), 0u);
3161 size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
3162 CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
3163 req.InstrumentationEvent());
3164 *counter = *counter - 1;
3165 if (*counter == 0) {
3166 VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
3167 deoptimization_requests_.size(), req.InstrumentationEvent());
3168 deoptimization_requests_.push_back(req);
3172 case DeoptimizationRequest::kFullDeoptimization: {
3173 DCHECK(req.Method() == nullptr);
3174 if (full_deoptimization_event_count_ == 0) {
3175 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3176 << " for full deoptimization";
3177 deoptimization_requests_.push_back(req);
3179 ++full_deoptimization_event_count_;
3182 case DeoptimizationRequest::kFullUndeoptimization: {
3183 DCHECK(req.Method() == nullptr);
3184 DCHECK_GT(full_deoptimization_event_count_, 0U);
3185 --full_deoptimization_event_count_;
3186 if (full_deoptimization_event_count_ == 0) {
3187 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3188 << " for full undeoptimization";
3189 deoptimization_requests_.push_back(req);
3193 case DeoptimizationRequest::kSelectiveDeoptimization: {
3194 DCHECK(req.Method() != nullptr);
3195 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3196 << " for deoptimization of " << PrettyMethod(req.Method());
3197 deoptimization_requests_.push_back(req);
3200 case DeoptimizationRequest::kSelectiveUndeoptimization: {
3201 DCHECK(req.Method() != nullptr);
3202 VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3203 << " for undeoptimization of " << PrettyMethod(req.Method());
3204 deoptimization_requests_.push_back(req);
3208 LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
3214 void Dbg::ManageDeoptimization() {
3215 Thread* const self = Thread::Current();
3217 // Avoid suspend/resume if there is no pending request.
3218 MutexLock mu(self, *Locks::deoptimization_lock_);
3219 if (deoptimization_requests_.empty()) {
3223 CHECK_EQ(self->GetState(), kRunnable);
3224 ScopedThreadSuspension sts(self, kWaitingForDeoptimization);
3225 // Required for ProcessDeoptimizationRequest.
3226 gc::ScopedGCCriticalSection gcs(self,
3227 gc::kGcCauseInstrumentation,
3228 gc::kCollectorTypeInstrumentation);
3229 // We need to suspend mutator threads first.
3230 ScopedSuspendAll ssa(__FUNCTION__);
3231 const ThreadState old_state = self->SetStateUnsafe(kRunnable);
3233 MutexLock mu(self, *Locks::deoptimization_lock_);
3234 size_t req_index = 0;
3235 for (DeoptimizationRequest& request : deoptimization_requests_) {
3236 VLOG(jdwp) << "Process deoptimization request #" << req_index++;
3237 ProcessDeoptimizationRequest(request);
3239 deoptimization_requests_.clear();
3241 CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
3244 static const Breakpoint* FindFirstBreakpointForMethod(ArtMethod* m)
3245 SHARED_REQUIRES(Locks::mutator_lock_, Locks::breakpoint_lock_) {
3246 for (Breakpoint& breakpoint : gBreakpoints) {
3247 if (breakpoint.IsInMethod(m)) {
3254 bool Dbg::MethodHasAnyBreakpoints(ArtMethod* method) {
3255 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3256 return FindFirstBreakpointForMethod(method) != nullptr;
3259 // Sanity checks all existing breakpoints on the same method.
3260 static void SanityCheckExistingBreakpoints(ArtMethod* m,
3261 DeoptimizationRequest::Kind deoptimization_kind)
3262 SHARED_REQUIRES(Locks::mutator_lock_, Locks::breakpoint_lock_) {
3263 for (const Breakpoint& breakpoint : gBreakpoints) {
3264 if (breakpoint.IsInMethod(m)) {
3265 CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3268 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3269 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
3270 // We should have deoptimized everything but not "selectively" deoptimized this method.
3271 CHECK(instrumentation->AreAllMethodsDeoptimized());
3272 CHECK(!instrumentation->IsDeoptimized(m));
3273 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3274 // We should have "selectively" deoptimized this method.
3275 // Note: while we have not deoptimized everything for this method, we may have done it for
3277 CHECK(instrumentation->IsDeoptimized(m));
3279 // This method does not require deoptimization.
3280 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3281 CHECK(!instrumentation->IsDeoptimized(m));
3285 // Returns the deoptimization kind required to set a breakpoint in a method.
3286 // If a breakpoint has already been set, we also return the first breakpoint
3287 // through the given 'existing_brkpt' pointer.
3288 static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
3290 const Breakpoint** existing_brkpt)
3291 SHARED_REQUIRES(Locks::mutator_lock_) {
3292 if (!Dbg::RequiresDeoptimization()) {
3293 // We already run in interpreter-only mode so we don't need to deoptimize anything.
3294 VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
3296 return DeoptimizationRequest::kNothing;
3298 const Breakpoint* first_breakpoint;
3300 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3301 first_breakpoint = FindFirstBreakpointForMethod(m);
3302 *existing_brkpt = first_breakpoint;
3305 if (first_breakpoint == nullptr) {
3306 // There is no breakpoint on this method yet: we need to deoptimize. If this method is default,
3307 // we deoptimize everything; otherwise we deoptimize only this method. We
3308 // deoptimize with defaults because we do not know everywhere they are used. It is possible some
3309 // of the copies could be missed.
3310 // TODO Deoptimizing on default methods might not be necessary in all cases.
3311 bool need_full_deoptimization = m->IsDefault();
3312 if (need_full_deoptimization) {
3313 VLOG(jdwp) << "Need full deoptimization because of copying of method "
3315 return DeoptimizationRequest::kFullDeoptimization;
3317 // We don't need to deoptimize if the method has not been compiled.
3318 const bool is_compiled = m->HasAnyCompiledCode();
3320 VLOG(jdwp) << "Need selective deoptimization for compiled method " << PrettyMethod(m);
3321 return DeoptimizationRequest::kSelectiveDeoptimization;
3323 // Method is not compiled: we don't need to deoptimize.
3324 VLOG(jdwp) << "No need for deoptimization for non-compiled method " << PrettyMethod(m);
3325 return DeoptimizationRequest::kNothing;
3329 // There is at least one breakpoint for this method: we don't need to deoptimize.
3330 // Let's check that all breakpoints are configured the same way for deoptimization.
3331 VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
3332 DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
3333 if (kIsDebugBuild) {
3334 ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3335 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3337 return DeoptimizationRequest::kNothing;
3341 // Installs a breakpoint at the specified location. Also indicates through the deoptimization
3342 // request if we need to deoptimize.
3343 void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3344 Thread* const self = Thread::Current();
3345 ArtMethod* m = FromMethodId(location->method_id);
3346 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
3348 const Breakpoint* existing_breakpoint = nullptr;
3349 const DeoptimizationRequest::Kind deoptimization_kind =
3350 GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
3351 req->SetKind(deoptimization_kind);
3352 if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3355 CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3356 deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
3357 req->SetMethod(nullptr);
3361 WriterMutexLock mu(self, *Locks::breakpoint_lock_);
3362 // If there is at least one existing breakpoint on the same method, the new breakpoint
3363 // must have the same deoptimization kind than the existing breakpoint(s).
3364 DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3365 if (existing_breakpoint != nullptr) {
3366 breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3368 breakpoint_deoptimization_kind = deoptimization_kind;
3370 gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
3371 VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3372 << gBreakpoints[gBreakpoints.size() - 1];
3376 // Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3377 // request if we need to undeoptimize.
3378 void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3379 WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3380 ArtMethod* m = FromMethodId(location->method_id);
3381 DCHECK(m != nullptr) << "No method for method id " << location->method_id;
3382 DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
3383 for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
3384 if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].IsInMethod(m)) {
3385 VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
3386 deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3387 DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3388 Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
3389 gBreakpoints.erase(gBreakpoints.begin() + i);
3393 const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3394 if (existing_breakpoint == nullptr) {
3395 // There is no more breakpoint on this method: we need to undeoptimize.
3396 if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
3397 // This method required full deoptimization: we need to undeoptimize everything.
3398 req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3399 req->SetMethod(nullptr);
3400 } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3401 // This method required selective deoptimization: we need to undeoptimize only that method.
3402 req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3405 // This method had no need for deoptimization: do nothing.
3406 CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3407 req->SetKind(DeoptimizationRequest::kNothing);
3408 req->SetMethod(nullptr);
3411 // There is at least one breakpoint for this method: we don't need to undeoptimize.
3412 req->SetKind(DeoptimizationRequest::kNothing);
3413 req->SetMethod(nullptr);
3414 if (kIsDebugBuild) {
3415 SanityCheckExistingBreakpoints(m, deoptimization_kind);
3420 bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, ArtMethod* m) {
3421 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3422 if (ssc == nullptr) {
3423 // If we are not single-stepping, then we don't have to force interpreter.
3426 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3427 // If we are in interpreter only mode, then we don't have to force interpreter.
3431 if (!m->IsNative() && !m->IsProxyMethod()) {
3432 // If we want to step into a method, then we have to force interpreter on that call.
3433 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3440 bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
3441 instrumentation::Instrumentation* const instrumentation =
3442 Runtime::Current()->GetInstrumentation();
3443 // If we are in interpreter only mode, then we don't have to force interpreter.
3444 if (instrumentation->InterpretOnly()) {
3447 // We can only interpret pure Java method.
3448 if (m->IsNative() || m->IsProxyMethod()) {
3451 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3452 if (ssc != nullptr) {
3453 // If we want to step into a method, then we have to force interpreter on that call.
3454 if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3457 // If we are stepping out from a static initializer, by issuing a step
3458 // in or step over, that was implicitly invoked by calling a static method,
3459 // then we need to step into that method. Having a lower stack depth than
3460 // the one the single step control has indicates that the step originates
3461 // from the static initializer.
3462 if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3463 ssc->GetStackDepth() > GetStackDepth(thread)) {
3467 // There are cases where we have to force interpreter on deoptimized methods,
3468 // because in some cases the call will not be performed by invoking an entry
3469 // point that has been replaced by the deoptimization, but instead by directly
3470 // invoking the compiled code of the method, for example.
3471 return instrumentation->IsDeoptimized(m);
3474 bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, ArtMethod* m) {
3475 // The upcall can be null and in that case we don't need to do anything.
3479 instrumentation::Instrumentation* const instrumentation =
3480 Runtime::Current()->GetInstrumentation();
3481 // If we are in interpreter only mode, then we don't have to force interpreter.
3482 if (instrumentation->InterpretOnly()) {
3485 // We can only interpret pure Java method.
3486 if (m->IsNative() || m->IsProxyMethod()) {
3489 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3490 if (ssc != nullptr) {
3491 // If we are stepping out from a static initializer, by issuing a step
3492 // out, that was implicitly invoked by calling a static method, then we
3493 // need to step into the caller of that method. Having a lower stack
3494 // depth than the one the single step control has indicates that the
3495 // step originates from the static initializer.
3496 if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3497 ssc->GetStackDepth() > GetStackDepth(thread)) {
3501 // If we are returning from a static intializer, that was implicitly
3502 // invoked by calling a static method and the caller is deoptimized,
3503 // then we have to deoptimize the stack without forcing interpreter
3504 // on the static method that was called originally. This problem can
3505 // be solved easily by forcing instrumentation on the called method,
3506 // because the instrumentation exit hook will recognise the need of
3507 // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3508 return instrumentation->IsDeoptimized(m);
3511 bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, ArtMethod* m) {
3512 // The upcall can be null and in that case we don't need to do anything.
3516 instrumentation::Instrumentation* const instrumentation =
3517 Runtime::Current()->GetInstrumentation();
3518 // If we are in interpreter only mode, then we don't have to force interpreter.
3519 if (instrumentation->InterpretOnly()) {
3522 // We can only interpret pure Java method.
3523 if (m->IsNative() || m->IsProxyMethod()) {
3526 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3527 if (ssc != nullptr) {
3528 // The debugger is not interested in what is happening under the level
3529 // of the step, thus we only force interpreter when we are not below of
3531 if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3535 if (thread->HasDebuggerShadowFrames()) {
3536 // We need to deoptimize the stack for the exception handling flow so that
3537 // we don't miss any deoptimization that should be done when there are
3538 // debugger shadow frames.
3541 // We have to require stack deoptimization if the upcall is deoptimized.
3542 return instrumentation->IsDeoptimized(m);
3545 class NeedsDeoptimizationVisitor : public StackVisitor {
3547 explicit NeedsDeoptimizationVisitor(Thread* self)
3548 SHARED_REQUIRES(Locks::mutator_lock_)
3549 : StackVisitor(self, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3550 needs_deoptimization_(false) {}
3552 bool VisitFrame() OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) {
3553 // The visitor is meant to be used when handling exception from compiled code only.
3554 CHECK(!IsShadowFrame()) << "We only expect to visit compiled frame: " << PrettyMethod(GetMethod());
3555 ArtMethod* method = GetMethod();
3556 if (method == nullptr) {
3557 // We reach an upcall and don't need to deoptimize this part of the stack (ManagedFragment)
3558 // so we can stop the visit.
3559 DCHECK(!needs_deoptimization_);
3562 if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3563 // We found a compiled frame in the stack but instrumentation is set to interpret
3564 // everything: we need to deoptimize.
3565 needs_deoptimization_ = true;
3568 if (Runtime::Current()->GetInstrumentation()->IsDeoptimized(method)) {
3569 // We found a deoptimized method in the stack.
3570 needs_deoptimization_ = true;
3573 ShadowFrame* frame = GetThread()->FindDebuggerShadowFrame(GetFrameId());
3574 if (frame != nullptr) {
3575 // The debugger allocated a ShadowFrame to update a variable in the stack: we need to
3576 // deoptimize the stack to execute (and deallocate) this frame.
3577 needs_deoptimization_ = true;
3583 bool NeedsDeoptimization() const {
3584 return needs_deoptimization_;
3588 // Do we need to deoptimize the stack?
3589 bool needs_deoptimization_;
3591 DISALLOW_COPY_AND_ASSIGN(NeedsDeoptimizationVisitor);
3594 // Do we need to deoptimize the stack to handle an exception?
3595 bool Dbg::IsForcedInterpreterNeededForExceptionImpl(Thread* thread) {
3596 const SingleStepControl* const ssc = thread->GetSingleStepControl();
3597 if (ssc != nullptr) {
3598 // We deopt to step into the catch handler.
3601 // Deoptimization is required if at least one method in the stack needs it. However we
3602 // skip frames that will be unwound (thus not executed).
3603 NeedsDeoptimizationVisitor visitor(thread);
3604 visitor.WalkStack(true); // includes upcall.
3605 return visitor.NeedsDeoptimization();
3608 // Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3609 // cause suspension if the thread is the current thread.
3610 class ScopedDebuggerThreadSuspension {
3612 ScopedDebuggerThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
3613 REQUIRES(!Locks::thread_list_lock_)
3614 SHARED_REQUIRES(Locks::mutator_lock_) :
3616 error_(JDWP::ERR_NONE),
3617 self_suspend_(false),
3618 other_suspend_(false) {
3619 ScopedObjectAccessUnchecked soa(self);
3620 thread_ = DecodeThread(soa, thread_id, &error_);
3621 if (error_ == JDWP::ERR_NONE) {
3622 if (thread_ == soa.Self()) {
3623 self_suspend_ = true;
3625 Thread* suspended_thread;
3627 ScopedThreadSuspension sts(self, kWaitingForDebuggerSuspension);
3628 jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
3630 ThreadList* const thread_list = Runtime::Current()->GetThreadList();
3631 suspended_thread = thread_list->SuspendThreadByPeer(thread_peer, true, true, &timed_out);
3633 if (suspended_thread == nullptr) {
3634 // Thread terminated from under us while suspending.
3635 error_ = JDWP::ERR_INVALID_THREAD;
3637 CHECK_EQ(suspended_thread, thread_);
3638 other_suspend_ = true;
3644 Thread* GetThread() const {
3648 JDWP::JdwpError GetError() const {
3652 ~ScopedDebuggerThreadSuspension() {
3653 if (other_suspend_) {
3654 Runtime::Current()->GetThreadList()->Resume(thread_, true);
3660 JDWP::JdwpError error_;
3662 bool other_suspend_;
3665 JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3666 JDWP::JdwpStepDepth step_depth) {
3667 Thread* self = Thread::Current();
3668 ScopedDebuggerThreadSuspension sts(self, thread_id);
3669 if (sts.GetError() != JDWP::ERR_NONE) {
3670 return sts.GetError();
3673 // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
3675 struct SingleStepStackVisitor : public StackVisitor {
3676 explicit SingleStepStackVisitor(Thread* thread) SHARED_REQUIRES(Locks::mutator_lock_)
3677 : StackVisitor(thread, nullptr, StackVisitor::StackWalkKind::kIncludeInlinedFrames),
3682 // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3684 bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
3685 ArtMethod* m = GetMethod();
3686 if (!m->IsRuntimeMethod()) {
3688 if (method == nullptr) {
3689 mirror::DexCache* dex_cache = m->GetDeclaringClass()->GetDexCache();
3691 if (dex_cache != nullptr) {
3692 const DexFile& dex_file = *dex_cache->GetDexFile();
3693 line_number = dex_file.GetLineNumFromPC(m, GetDexPc());
3702 int32_t line_number;
3705 Thread* const thread = sts.GetThread();
3706 SingleStepStackVisitor visitor(thread);
3707 visitor.WalkStack();
3709 // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
3710 struct DebugCallbackContext {
3711 DebugCallbackContext(SingleStepControl* single_step_control_cb,
3712 int32_t line_number_cb, const DexFile::CodeItem* code_item)
3713 : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
3714 code_item_(code_item), last_pc_valid(false), last_pc(0) {
3717 static bool Callback(void* raw_context, const DexFile::PositionInfo& entry) {
3718 DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
3719 if (static_cast<int32_t>(entry.line_) == context->line_number_) {
3720 if (!context->last_pc_valid) {
3721 // Everything from this address until the next line change is ours.
3722 context->last_pc = entry.address_;
3723 context->last_pc_valid = true;
3725 // Otherwise, if we're already in a valid range for this line,
3726 // just keep going (shouldn't really happen)...
3727 } else if (context->last_pc_valid) { // and the line number is new
3728 // Add everything from the last entry up until here to the set
3729 for (uint32_t dex_pc = context->last_pc; dex_pc < entry.address_; ++dex_pc) {
3730 context->single_step_control_->AddDexPc(dex_pc);
3732 context->last_pc_valid = false;
3734 return false; // There may be multiple entries for any given line.
3737 ~DebugCallbackContext() {
3738 // If the line number was the last in the position table...
3739 if (last_pc_valid) {
3740 size_t end = code_item_->insns_size_in_code_units_;
3741 for (uint32_t dex_pc = last_pc; dex_pc < end; ++dex_pc) {
3742 single_step_control_->AddDexPc(dex_pc);
3747 SingleStepControl* const single_step_control_;
3748 const int32_t line_number_;
3749 const DexFile::CodeItem* const code_item_;
3754 // Allocate single step.
3755 SingleStepControl* single_step_control =
3756 new (std::nothrow) SingleStepControl(step_size, step_depth,
3757 visitor.stack_depth, visitor.method);
3758 if (single_step_control == nullptr) {
3759 LOG(ERROR) << "Failed to allocate SingleStepControl";
3760 return JDWP::ERR_OUT_OF_MEMORY;
3763 ArtMethod* m = single_step_control->GetMethod();
3764 const int32_t line_number = visitor.line_number;
3765 // Note: if the thread is not running Java code (pure native thread), there is no "current"
3766 // method on the stack (and no line number either).
3767 if (m != nullptr && !m->IsNative()) {
3768 const DexFile::CodeItem* const code_item = m->GetCodeItem();
3769 DebugCallbackContext context(single_step_control, line_number, code_item);
3770 m->GetDexFile()->DecodeDebugPositionInfo(code_item, DebugCallbackContext::Callback, &context);
3773 // Activate single-step in the thread.
3774 thread->ActivateSingleStepControl(single_step_control);
3776 if (VLOG_IS_ON(jdwp)) {
3777 VLOG(jdwp) << "Single-step thread: " << *thread;
3778 VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3779 VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
3780 VLOG(jdwp) << "Single-step current method: " << PrettyMethod(single_step_control->GetMethod());
3781 VLOG(jdwp) << "Single-step current line: " << line_number;
3782 VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
3783 VLOG(jdwp) << "Single-step dex_pc values:";
3784 for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
3785 VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
3789 return JDWP::ERR_NONE;
3792 void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3793 ScopedObjectAccessUnchecked soa(Thread::Current());
3794 JDWP::JdwpError error;
3795 Thread* thread = DecodeThread(soa, thread_id, &error);
3796 if (error == JDWP::ERR_NONE) {
3797 thread->DeactivateSingleStepControl();
3801 static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3804 LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
3808 case JDWP::JT_BYTE: return 'B';
3809 case JDWP::JT_CHAR: return 'C';
3810 case JDWP::JT_FLOAT: return 'F';
3811 case JDWP::JT_DOUBLE: return 'D';
3812 case JDWP::JT_INT: return 'I';
3813 case JDWP::JT_LONG: return 'J';
3814 case JDWP::JT_SHORT: return 'S';
3815 case JDWP::JT_VOID: return 'V';
3816 case JDWP::JT_BOOLEAN: return 'Z';
3819 case JDWP::JT_ARRAY:
3820 case JDWP::JT_OBJECT:
3821 case JDWP::JT_STRING:
3822 case JDWP::JT_THREAD:
3823 case JDWP::JT_THREAD_GROUP:
3824 case JDWP::JT_CLASS_LOADER:
3825 case JDWP::JT_CLASS_OBJECT:
3830 JDWP::JdwpError Dbg::PrepareInvokeMethod(uint32_t request_id, JDWP::ObjectId thread_id,
3831 JDWP::ObjectId object_id, JDWP::RefTypeId class_id,
3832 JDWP::MethodId method_id, uint32_t arg_count,
3833 uint64_t arg_values[], JDWP::JdwpTag* arg_types,
3835 Thread* const self = Thread::Current();
3836 CHECK_EQ(self, GetDebugThread()) << "This must be called by the JDWP thread";
3837 const bool resume_all_threads = ((options & JDWP::INVOKE_SINGLE_THREADED) == 0);
3839 ThreadList* thread_list = Runtime::Current()->GetThreadList();
3840 Thread* targetThread = nullptr;
3842 ScopedObjectAccessUnchecked soa(self);
3843 JDWP::JdwpError error;
3844 targetThread = DecodeThread(soa, thread_id, &error);
3845 if (error != JDWP::ERR_NONE) {
3846 LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3849 if (targetThread->GetInvokeReq() != nullptr) {
3850 // Thread is already invoking a method on behalf of the debugger.
3851 LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
3852 return JDWP::ERR_ALREADY_INVOKING;
3854 if (!targetThread->IsReadyForDebugInvoke()) {
3855 // Thread is not suspended by an event so it cannot invoke a method.
3856 LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
3857 return JDWP::ERR_INVALID_THREAD;
3861 * According to the JDWP specs, we are expected to resume all threads (or only the
3862 * target thread) once. So if a thread has been suspended more than once (either by
3863 * the debugger for an event or by the runtime for GC), it will remain suspended before
3864 * the invoke is executed. This means the debugger is responsible to properly resume all
3865 * the threads it has suspended so the target thread can execute the method.
3867 * However, for compatibility reason with older versions of debuggers (like Eclipse), we
3868 * fully resume all threads (by canceling *all* debugger suspensions) when the debugger
3869 * wants us to resume all threads. This is to avoid ending up in deadlock situation.
3871 * On the other hand, if we are asked to only resume the target thread, then we follow the
3872 * JDWP specs by resuming that thread only once. This means the thread will remain suspended
3873 * if it has been suspended more than once before the invoke (and again, this is the
3874 * responsibility of the debugger to properly resume that thread before invoking a method).
3878 MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
3879 suspend_count = targetThread->GetSuspendCount();
3881 if (suspend_count > 1 && resume_all_threads) {
3882 // The target thread will remain suspended even after we resume it. Let's emit a warning
3883 // to indicate the invoke won't be executed until the thread is resumed.
3884 LOG(WARNING) << *targetThread << " suspended more than once (suspend count == "
3885 << suspend_count << "). This thread will invoke the method only once "
3886 << "it is fully resumed.";
3889 mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
3890 if (error != JDWP::ERR_NONE) {
3891 return JDWP::ERR_INVALID_OBJECT;
3894 gRegistry->Get<mirror::Object*>(thread_id, &error);
3895 if (error != JDWP::ERR_NONE) {
3896 return JDWP::ERR_INVALID_OBJECT;
3899 mirror::Class* c = DecodeClass(class_id, &error);
3904 ArtMethod* m = FromMethodId(method_id);
3905 if (m->IsStatic() != (receiver == nullptr)) {
3906 return JDWP::ERR_INVALID_METHODID;
3908 if (m->IsStatic()) {
3909 if (m->GetDeclaringClass() != c) {
3910 return JDWP::ERR_INVALID_METHODID;
3913 if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
3914 return JDWP::ERR_INVALID_METHODID;
3918 // Check the argument list matches the method.
3919 uint32_t shorty_len = 0;
3920 const char* shorty = m->GetShorty(&shorty_len);
3921 if (shorty_len - 1 != arg_count) {
3922 return JDWP::ERR_ILLEGAL_ARGUMENT;
3926 StackHandleScope<2> hs(soa.Self());
3927 HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
3928 HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
3929 const DexFile::TypeList* types = m->GetParameterTypeList();
3930 for (size_t i = 0; i < arg_count; ++i) {
3931 if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
3932 return JDWP::ERR_ILLEGAL_ARGUMENT;
3935 if (shorty[i + 1] == 'L') {
3936 // Did we really get an argument of an appropriate reference type?
3937 mirror::Class* parameter_type =
3938 m->GetClassFromTypeIndex(types->GetTypeItem(i).type_idx_,
3941 mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
3942 if (error != JDWP::ERR_NONE) {
3943 return JDWP::ERR_INVALID_OBJECT;
3945 if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
3946 return JDWP::ERR_ILLEGAL_ARGUMENT;
3949 // Turn the on-the-wire ObjectId into a jobject.
3950 jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
3951 v.l = gRegistry->GetJObject(arg_values[i]);
3956 // Allocates a DebugInvokeReq.
3957 DebugInvokeReq* req = new (std::nothrow) DebugInvokeReq(request_id, thread_id, receiver, c, m,
3958 options, arg_values, arg_count);
3959 if (req == nullptr) {
3960 LOG(ERROR) << "Failed to allocate DebugInvokeReq";
3961 return JDWP::ERR_OUT_OF_MEMORY;
3964 // Attaches the DebugInvokeReq to the target thread so it executes the method when
3965 // it is resumed. Once the invocation completes, the target thread will delete it before
3966 // suspending itself (see ThreadList::SuspendSelfForDebugger).
3967 targetThread->SetDebugInvokeReq(req);
3970 // The fact that we've released the thread list lock is a bit risky --- if the thread goes
3971 // away we're sitting high and dry -- but we must release this before the UndoDebuggerSuspensions
3973 if (resume_all_threads) {
3974 VLOG(jdwp) << " Resuming all threads";
3975 thread_list->UndoDebuggerSuspensions();
3977 VLOG(jdwp) << " Resuming event thread only";
3978 thread_list->Resume(targetThread, true);
3981 return JDWP::ERR_NONE;
3984 void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
3985 Thread* const self = Thread::Current();
3986 CHECK_NE(self, GetDebugThread()) << "This must be called by the event thread";
3988 ScopedObjectAccess soa(self);
3990 // We can be called while an exception is pending. We need
3991 // to preserve that across the method invocation.
3992 StackHandleScope<1> hs(soa.Self());
3993 Handle<mirror::Throwable> old_exception = hs.NewHandle(soa.Self()->GetException());
3994 soa.Self()->ClearException();
3996 // Execute the method then sends reply to the debugger.
3997 ExecuteMethodWithoutPendingException(soa, pReq);
3999 // If an exception was pending before the invoke, restore it now.
4000 if (old_exception.Get() != nullptr) {
4001 soa.Self()->SetException(old_exception.Get());
4005 // Helper function: write a variable-width value into the output input buffer.
4006 static void WriteValue(JDWP::ExpandBuf* pReply, int width, uint64_t value) {
4009 expandBufAdd1(pReply, value);
4012 expandBufAdd2BE(pReply, value);
4015 expandBufAdd4BE(pReply, value);
4018 expandBufAdd8BE(pReply, value);
4021 LOG(FATAL) << width;
4026 void Dbg::ExecuteMethodWithoutPendingException(ScopedObjectAccess& soa, DebugInvokeReq* pReq) {
4027 soa.Self()->AssertNoPendingException();
4029 // Translate the method through the vtable, unless the debugger wants to suppress it.
4030 ArtMethod* m = pReq->method;
4031 size_t image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
4032 if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
4033 ArtMethod* actual_method =
4034 pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m, image_pointer_size);
4035 if (actual_method != m) {
4036 VLOG(jdwp) << "ExecuteMethod translated " << PrettyMethod(m)
4037 << " to " << PrettyMethod(actual_method);
4041 VLOG(jdwp) << "ExecuteMethod " << PrettyMethod(m)
4042 << " receiver=" << pReq->receiver.Read()
4043 << " arg_count=" << pReq->arg_count;
4044 CHECK(m != nullptr);
4046 static_assert(sizeof(jvalue) == sizeof(uint64_t), "jvalue and uint64_t have different sizes.");
4048 // Invoke the method.
4049 ScopedLocalRef<jobject> ref(soa.Env(), soa.AddLocalReference<jobject>(pReq->receiver.Read()));
4050 JValue result = InvokeWithJValues(soa, ref.get(), soa.EncodeMethod(m),
4051 reinterpret_cast<jvalue*>(pReq->arg_values.get()));
4053 // Prepare JDWP ids for the reply.
4054 JDWP::JdwpTag result_tag = BasicTagFromDescriptor(m->GetShorty());
4055 const bool is_object_result = (result_tag == JDWP::JT_OBJECT);
4056 StackHandleScope<2> hs(soa.Self());
4057 Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
4058 Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
4059 soa.Self()->ClearException();
4061 if (!IsDebuggerActive()) {
4062 // The debugger detached: we must not re-suspend threads. We also don't need to fill the reply
4063 // because it won't be sent either.
4067 JDWP::ObjectId exceptionObjectId = gRegistry->Add(exception);
4068 uint64_t result_value = 0;
4069 if (exceptionObjectId != 0) {
4070 VLOG(jdwp) << " JDWP invocation returning with exception=" << exception.Get()
4071 << " " << exception->Dump();
4073 } else if (is_object_result) {
4074 /* if no exception was thrown, examine object result more closely */
4075 JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
4076 if (new_tag != result_tag) {
4077 VLOG(jdwp) << " JDWP promoted result from " << result_tag << " to " << new_tag;
4078 result_tag = new_tag;
4081 // Register the object in the registry and reference its ObjectId. This ensures
4082 // GC safety and prevents from accessing stale reference if the object is moved.
4083 result_value = gRegistry->Add(object_result.Get());
4085 // Primitive result.
4086 DCHECK(IsPrimitiveTag(result_tag));
4087 result_value = result.GetJ();
4089 const bool is_constructor = m->IsConstructor() && !m->IsStatic();
4090 if (is_constructor) {
4091 // If we invoked a constructor (which actually returns void), return the receiver,
4092 // unless we threw, in which case we return null.
4093 DCHECK_EQ(JDWP::JT_VOID, result_tag);
4094 if (exceptionObjectId == 0) {
4095 // TODO we could keep the receiver ObjectId in the DebugInvokeReq to avoid looking into the
4097 result_value = GetObjectRegistry()->Add(pReq->receiver.Read());
4098 result_tag = TagFromObject(soa, pReq->receiver.Read());
4101 result_tag = JDWP::JT_OBJECT;
4105 // Suspend other threads if the invoke is not single-threaded.
4106 if ((pReq->options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
4107 ScopedThreadSuspension sts(soa.Self(), kWaitingForDebuggerSuspension);
4108 // Avoid a deadlock between GC and debugger where GC gets suspended during GC. b/25800335.
4109 gc::ScopedGCCriticalSection gcs(soa.Self(), gc::kGcCauseDebugger, gc::kCollectorTypeDebugger);
4110 VLOG(jdwp) << " Suspending all threads";
4111 Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
4114 VLOG(jdwp) << " --> returned " << result_tag
4115 << StringPrintf(" %#" PRIx64 " (except=%#" PRIx64 ")", result_value,
4118 // Show detailed debug output.
4119 if (result_tag == JDWP::JT_STRING && exceptionObjectId == 0) {
4120 if (result_value != 0) {
4121 if (VLOG_IS_ON(jdwp)) {
4122 std::string result_string;
4123 JDWP::JdwpError error = Dbg::StringToUtf8(result_value, &result_string);
4124 CHECK_EQ(error, JDWP::ERR_NONE);
4125 VLOG(jdwp) << " string '" << result_string << "'";
4128 VLOG(jdwp) << " string (null)";
4132 // Attach the reply to DebugInvokeReq so it can be sent to the debugger when the event thread
4133 // is ready to suspend.
4134 BuildInvokeReply(pReq->reply, pReq->request_id, result_tag, result_value, exceptionObjectId);
4137 void Dbg::BuildInvokeReply(JDWP::ExpandBuf* pReply, uint32_t request_id, JDWP::JdwpTag result_tag,
4138 uint64_t result_value, JDWP::ObjectId exception) {
4139 // Make room for the JDWP header since we do not know the size of the reply yet.
4140 JDWP::expandBufAddSpace(pReply, kJDWPHeaderLen);
4142 size_t width = GetTagWidth(result_tag);
4143 JDWP::expandBufAdd1(pReply, result_tag);
4145 WriteValue(pReply, width, result_value);
4147 JDWP::expandBufAdd1(pReply, JDWP::JT_OBJECT);
4148 JDWP::expandBufAddObjectId(pReply, exception);
4150 // Now we know the size, we can complete the JDWP header.
4151 uint8_t* buf = expandBufGetBuffer(pReply);
4152 JDWP::Set4BE(buf + kJDWPHeaderSizeOffset, expandBufGetLength(pReply));
4153 JDWP::Set4BE(buf + kJDWPHeaderIdOffset, request_id);
4154 JDWP::Set1(buf + kJDWPHeaderFlagsOffset, kJDWPFlagReply); // flags
4155 JDWP::Set2BE(buf + kJDWPHeaderErrorCodeOffset, JDWP::ERR_NONE);
4158 void Dbg::FinishInvokeMethod(DebugInvokeReq* pReq) {
4159 CHECK_NE(Thread::Current(), GetDebugThread()) << "This must be called by the event thread";
4161 JDWP::ExpandBuf* const pReply = pReq->reply;
4162 CHECK(pReply != nullptr) << "No reply attached to DebugInvokeReq";
4164 // We need to prevent other threads (including JDWP thread) from interacting with the debugger
4165 // while we send the reply but are not yet suspended. The JDWP token will be released just before
4166 // we suspend ourself again (see ThreadList::SuspendSelfForDebugger).
4167 gJdwpState->AcquireJdwpTokenForEvent(pReq->thread_id);
4169 // Send the reply unless the debugger detached before the completion of the method.
4170 if (IsDebuggerActive()) {
4171 const size_t replyDataLength = expandBufGetLength(pReply) - kJDWPHeaderLen;
4172 VLOG(jdwp) << StringPrintf("REPLY INVOKE id=0x%06x (length=%zu)",
4173 pReq->request_id, replyDataLength);
4175 gJdwpState->SendRequest(pReply);
4177 VLOG(jdwp) << "Not sending invoke reply because debugger detached";
4182 * "request" contains a full JDWP packet, possibly with multiple chunks. We
4183 * need to process each, accumulate the replies, and ship the whole thing
4186 * Returns "true" if we have a reply. The reply buffer is newly allocated,
4187 * and includes the chunk type/length, followed by the data.
4189 * OLD-TODO: we currently assume that the request and reply include a single
4190 * chunk. If this becomes inconvenient we will need to adapt.
4192 bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
4193 Thread* self = Thread::Current();
4194 JNIEnv* env = self->GetJniEnv();
4196 uint32_t type = request->ReadUnsigned32("type");
4197 uint32_t length = request->ReadUnsigned32("length");
4199 // Create a byte[] corresponding to 'request'.
4200 size_t request_length = request->size();
4201 ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(request_length));
4202 if (dataArray.get() == nullptr) {
4203 LOG(WARNING) << "byte[] allocation failed: " << request_length;
4204 env->ExceptionClear();
4207 env->SetByteArrayRegion(dataArray.get(), 0, request_length,
4208 reinterpret_cast<const jbyte*>(request->data()));
4209 request->Skip(request_length);
4211 // Run through and find all chunks. [Currently just find the first.]
4212 ScopedByteArrayRO contents(env, dataArray.get());
4213 if (length != request_length) {
4214 LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
4218 // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
4219 ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4220 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
4221 type, dataArray.get(), 0, length));
4222 if (env->ExceptionCheck()) {
4223 LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
4224 env->ExceptionDescribe();
4225 env->ExceptionClear();
4229 if (chunk.get() == nullptr) {
4234 * Pull the pieces out of the chunk. We copy the results into a
4235 * newly-allocated buffer that the caller can free. We don't want to
4236 * continue using the Chunk object because nothing has a reference to it.
4238 * We could avoid this by returning type/data/offset/length and having
4239 * the caller be aware of the object lifetime issues, but that
4240 * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
4241 * if we have responses for multiple chunks.
4243 * So we're pretty much stuck with copying data around multiple times.
4245 ScopedLocalRef<jbyteArray> replyData(env, reinterpret_cast<jbyteArray>(env->GetObjectField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_data)));
4246 jint offset = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
4247 length = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
4248 type = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
4250 VLOG(jdwp) << StringPrintf("DDM reply: type=0x%08x data=%p offset=%d length=%d", type, replyData.get(), offset, length);
4251 if (length == 0 || replyData.get() == nullptr) {
4255 const int kChunkHdrLen = 8;
4256 uint8_t* reply = new uint8_t[length + kChunkHdrLen];
4257 if (reply == nullptr) {
4258 LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
4261 JDWP::Set4BE(reply + 0, type);
4262 JDWP::Set4BE(reply + 4, length);
4263 env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
4266 *pReplyLen = length + kChunkHdrLen;
4268 VLOG(jdwp) << StringPrintf("dvmHandleDdm returning type=%.4s %p len=%d", reinterpret_cast<char*>(reply), reply, length);
4272 void Dbg::DdmBroadcast(bool connect) {
4273 VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
4275 Thread* self = Thread::Current();
4276 if (self->GetState() != kRunnable) {
4277 LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4281 JNIEnv* env = self->GetJniEnv();
4282 jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
4283 env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4284 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4286 if (env->ExceptionCheck()) {
4287 LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4288 env->ExceptionDescribe();
4289 env->ExceptionClear();
4293 void Dbg::DdmConnected() {
4294 Dbg::DdmBroadcast(true);
4297 void Dbg::DdmDisconnected() {
4298 Dbg::DdmBroadcast(false);
4299 gDdmThreadNotification = false;
4303 * Send a notification when a thread starts, stops, or changes its name.
4305 * Because we broadcast the full set of threads when the notifications are
4306 * first enabled, it's possible for "thread" to be actively executing.
4308 void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
4309 if (!gDdmThreadNotification) {
4313 if (type == CHUNK_TYPE("THDE")) {
4315 JDWP::Set4BE(&buf[0], t->GetThreadId());
4316 Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
4318 CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
4319 ScopedObjectAccessUnchecked soa(Thread::Current());
4320 StackHandleScope<1> hs(soa.Self());
4321 Handle<mirror::String> name(hs.NewHandle(t->GetThreadName(soa)));
4322 size_t char_count = (name.Get() != nullptr) ? name->GetLength() : 0;
4323 const jchar* chars = (name.Get() != nullptr) ? name->GetValue() : nullptr;
4325 std::vector<uint8_t> bytes;
4326 JDWP::Append4BE(bytes, t->GetThreadId());
4327 JDWP::AppendUtf16BE(bytes, chars, char_count);
4328 CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
4329 Dbg::DdmSendChunk(type, bytes);
4333 void Dbg::DdmSetThreadNotification(bool enable) {
4334 // Enable/disable thread notifications.
4335 gDdmThreadNotification = enable;
4337 // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4338 // see a suspension in progress and block until that ends. They then post their own start
4341 std::list<Thread*> threads;
4342 Thread* self = Thread::Current();
4344 MutexLock mu(self, *Locks::thread_list_lock_);
4345 threads = Runtime::Current()->GetThreadList()->GetList();
4348 ScopedObjectAccess soa(self);
4349 for (Thread* thread : threads) {
4350 Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
4357 void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
4358 if (IsDebuggerActive()) {
4359 gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
4361 Dbg::DdmSendThreadNotification(t, type);
4364 void Dbg::PostThreadStart(Thread* t) {
4365 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
4368 void Dbg::PostThreadDeath(Thread* t) {
4369 Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
4372 void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
4373 CHECK(buf != nullptr);
4375 vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
4376 vec[0].iov_len = byte_count;
4377 Dbg::DdmSendChunkV(type, vec, 1);
4380 void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
4381 DdmSendChunk(type, bytes.size(), &bytes[0]);
4384 void Dbg::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
4385 if (gJdwpState == nullptr) {
4386 VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
4388 gJdwpState->DdmSendChunkV(type, iov, iov_count);
4392 JDWP::JdwpState* Dbg::GetJdwpState() {
4396 int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4397 if (when == HPIF_WHEN_NOW) {
4398 DdmSendHeapInfo(when);
4402 if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4403 LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4407 gDdmHpifWhen = when;
4411 bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4412 if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4413 LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4417 if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4418 LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4423 gDdmNhsgWhen = when;
4424 gDdmNhsgWhat = what;
4426 gDdmHpsgWhen = when;
4427 gDdmHpsgWhat = what;
4432 void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4433 // If there's a one-shot 'when', reset it.
4434 if (reason == gDdmHpifWhen) {
4435 if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4436 gDdmHpifWhen = HPIF_WHEN_NEVER;
4441 * Chunk HPIF (client --> server)
4443 * Heap Info. General information about the heap,
4444 * suitable for a summary display.
4446 * [u4]: number of heaps
4450 * [u8]: timestamp in ms since Unix epoch
4451 * [u1]: capture reason (same as 'when' value from server)
4452 * [u4]: max heap size in bytes (-Xmx)
4453 * [u4]: current heap size in bytes
4454 * [u4]: current number of bytes allocated
4455 * [u4]: current number of objects allocated
4457 uint8_t heap_count = 1;
4458 gc::Heap* heap = Runtime::Current()->GetHeap();
4459 std::vector<uint8_t> bytes;
4460 JDWP::Append4BE(bytes, heap_count);
4461 JDWP::Append4BE(bytes, 1); // Heap id (bogus; we only have one heap).
4462 JDWP::Append8BE(bytes, MilliTime());
4463 JDWP::Append1BE(bytes, reason);
4464 JDWP::Append4BE(bytes, heap->GetMaxMemory()); // Max allowed heap size in bytes.
4465 JDWP::Append4BE(bytes, heap->GetTotalMemory()); // Current heap size in bytes.
4466 JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4467 JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
4468 CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
4469 Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
4477 SOLIDITY_PHANTOM = 4,
4478 SOLIDITY_FINALIZABLE = 5,
4484 KIND_CLASS_OBJECT = 1,
4493 #define HPSG_PARTIAL (1<<7)
4494 #define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4496 class HeapChunkContext {
4498 // Maximum chunk size. Obtain this from the formula:
4499 // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4500 HeapChunkContext(bool merge, bool native)
4503 chunk_overhead_(0) {
4506 type_ = CHUNK_TYPE("NHSG");
4508 type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
4512 ~HeapChunkContext() {
4513 if (p_ > &buf_[0]) {
4518 void SetChunkOverhead(size_t chunk_overhead) {
4519 chunk_overhead_ = chunk_overhead;
4522 void ResetStartOfNextChunk() {
4523 startOfNextMemoryChunk_ = nullptr;
4526 void EnsureHeader(const void* chunk_ptr) {
4531 // Start a new HPSx chunk.
4532 JDWP::Write4BE(&p_, 1); // Heap id (bogus; we only have one heap).
4533 JDWP::Write1BE(&p_, 8); // Size of allocation unit, in bytes.
4535 JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr)); // virtual address of segment start.
4536 JDWP::Write4BE(&p_, 0); // offset of this piece (relative to the virtual address).
4537 // [u4]: length of piece, in allocation units
4538 // We won't know this until we're done, so save the offset and stuff in a dummy value.
4539 pieceLenField_ = p_;
4540 JDWP::Write4BE(&p_, 0x55555555);
4541 needHeader_ = false;
4544 void Flush() SHARED_REQUIRES(Locks::mutator_lock_) {
4545 if (pieceLenField_ == nullptr) {
4546 // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4550 // Patch the "length of piece" field.
4551 CHECK_LE(&buf_[0], pieceLenField_);
4552 CHECK_LE(pieceLenField_, p_);
4553 JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
4555 Dbg::DdmSendChunk(type_, p_ - &buf_[0], &buf_[0]);
4559 static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
4560 SHARED_REQUIRES(Locks::heap_bitmap_lock_,
4561 Locks::mutator_lock_) {
4562 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4565 static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
4566 SHARED_REQUIRES(Locks::mutator_lock_) {
4567 reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
4571 enum { ALLOCATION_UNIT_SIZE = 8 };
4575 ResetStartOfNextChunk();
4576 totalAllocationUnits_ = 0;
4578 pieceLenField_ = nullptr;
4581 bool IsNative() const {
4582 return type_ == CHUNK_TYPE("NHSG");
4585 // Returns true if the object is not an empty chunk.
4586 bool ProcessRecord(void* start, size_t used_bytes) SHARED_REQUIRES(Locks::mutator_lock_) {
4587 // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4588 // in the following code not to allocate memory, by ensuring buf_ is of the correct size
4589 if (used_bytes == 0) {
4590 if (start == nullptr) {
4591 // Reset for start of new heap.
4592 startOfNextMemoryChunk_ = nullptr;
4595 // Only process in use memory so that free region information
4596 // also includes dlmalloc book keeping.
4599 if (startOfNextMemoryChunk_ != nullptr) {
4600 // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4601 // of the use of mmaps, so don't report. If not free memory then start a new segment.
4603 if (start > startOfNextMemoryChunk_) {
4604 const size_t kMaxFreeLen = 2 * kPageSize;
4605 void* free_start = startOfNextMemoryChunk_;
4606 void* free_end = start;
4607 const size_t free_len =
4608 reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4609 if (!IsNative() || free_len < kMaxFreeLen) {
4610 AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4615 startOfNextMemoryChunk_ = nullptr;
4622 void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
4623 SHARED_REQUIRES(Locks::mutator_lock_) {
4624 if (ProcessRecord(start, used_bytes)) {
4625 uint8_t state = ExamineNativeObject(start);
4626 AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4627 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4631 void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
4632 SHARED_REQUIRES(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
4633 if (ProcessRecord(start, used_bytes)) {
4634 // Determine the type of this chunk.
4635 // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4636 // If it's the same, we should combine them.
4637 uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4638 AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4639 startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4643 void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
4644 SHARED_REQUIRES(Locks::mutator_lock_) {
4645 // Make sure there's enough room left in the buffer.
4646 // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4647 // 17 bytes for any header.
4648 const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4649 size_t byte_left = &buf_.back() - p_;
4650 if (byte_left < needed) {
4652 // Cannot trigger memory allocation while walking native heap.
4658 byte_left = &buf_.back() - p_;
4659 if (byte_left < needed) {
4660 LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4661 << needed << " bytes)";
4665 // Write out the chunk description.
4666 length /= ALLOCATION_UNIT_SIZE; // Convert to allocation units.
4667 totalAllocationUnits_ += length;
4668 while (length > 256) {
4669 *p_++ = state | HPSG_PARTIAL;
4670 *p_++ = 255; // length - 1
4677 uint8_t ExamineNativeObject(const void* p) SHARED_REQUIRES(Locks::mutator_lock_) {
4678 return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4681 uint8_t ExamineJavaObject(mirror::Object* o)
4682 SHARED_REQUIRES(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
4684 return HPSG_STATE(SOLIDITY_FREE, 0);
4686 // It's an allocated chunk. Figure out what it is.
4687 gc::Heap* heap = Runtime::Current()->GetHeap();
4688 if (!heap->IsLiveObjectLocked(o)) {
4689 LOG(ERROR) << "Invalid object in managed heap: " << o;
4690 return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4692 mirror::Class* c = o->GetClass();
4694 // The object was probably just created but hasn't been initialized yet.
4695 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4697 if (!heap->IsValidObjectAddress(c)) {
4698 LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
4699 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4701 if (c->GetClass() == nullptr) {
4702 LOG(ERROR) << "Null class of class " << c << " for object " << o;
4703 return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4705 if (c->IsClassClass()) {
4706 return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4708 if (c->IsArrayClass()) {
4709 switch (c->GetComponentSize()) {
4710 case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4711 case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4712 case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4713 case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4716 return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4719 std::vector<uint8_t> buf_;
4721 uint8_t* pieceLenField_;
4722 void* startOfNextMemoryChunk_;
4723 size_t totalAllocationUnits_;
4726 size_t chunk_overhead_;
4728 DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4731 static void BumpPointerSpaceCallback(mirror::Object* obj, void* arg)
4732 SHARED_REQUIRES(Locks::mutator_lock_) REQUIRES(Locks::heap_bitmap_lock_) {
4733 const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
4734 HeapChunkContext::HeapChunkJavaCallback(
4735 obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, arg);
4738 void Dbg::DdmSendHeapSegments(bool native) {
4739 Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4740 Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
4741 if (when == HPSG_WHEN_NEVER) {
4744 // Figure out what kind of chunks we'll be sending.
4745 CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4746 << static_cast<int>(what);
4748 // First, send a heap start chunk.
4750 JDWP::Set4BE(&heap_id[0], 1); // Heap id (bogus; we only have one heap).
4751 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
4752 Thread* self = Thread::Current();
4753 Locks::mutator_lock_->AssertSharedHeld(self);
4755 // Send a series of heap segment chunks.
4756 HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
4758 UNIMPLEMENTED(WARNING) << "Native heap inspection is not supported";
4760 gc::Heap* heap = Runtime::Current()->GetHeap();
4761 for (const auto& space : heap->GetContinuousSpaces()) {
4762 if (space->IsDlMallocSpace()) {
4763 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4764 // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4765 // allocation then the first sizeof(size_t) may belong to it.
4766 context.SetChunkOverhead(sizeof(size_t));
4767 space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
4768 } else if (space->IsRosAllocSpace()) {
4769 context.SetChunkOverhead(0);
4770 // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4771 // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
4772 ScopedThreadSuspension sts(self, kSuspended);
4773 ScopedSuspendAll ssa(__FUNCTION__);
4774 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4775 space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
4776 } else if (space->IsBumpPointerSpace()) {
4777 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4778 context.SetChunkOverhead(0);
4779 space->AsBumpPointerSpace()->Walk(BumpPointerSpaceCallback, &context);
4780 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
4781 } else if (space->IsRegionSpace()) {
4782 heap->IncrementDisableMovingGC(self);
4784 ScopedThreadSuspension sts(self, kSuspended);
4785 ScopedSuspendAll ssa(__FUNCTION__);
4786 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4787 context.SetChunkOverhead(0);
4788 space->AsRegionSpace()->Walk(BumpPointerSpaceCallback, &context);
4789 HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
4791 heap->DecrementDisableMovingGC(self);
4793 UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
4795 context.ResetStartOfNextChunk();
4797 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4798 // Walk the large objects, these are not in the AllocSpace.
4799 context.SetChunkOverhead(0);
4800 heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
4803 // Finally, send a heap end chunk.
4804 Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
4807 void Dbg::SetAllocTrackingEnabled(bool enable) {
4808 gc::AllocRecordObjectMap::SetAllocTrackingEnabled(enable);
4811 void Dbg::DumpRecentAllocations() {
4812 ScopedObjectAccess soa(Thread::Current());
4813 MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
4814 if (!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled()) {
4815 LOG(INFO) << "Not recording tracked allocations";
4818 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4819 CHECK(records != nullptr);
4821 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
4822 uint16_t count = capped_count;
4824 LOG(INFO) << "Tracked allocations, (count=" << count << ")";
4825 for (auto it = records->RBegin(), end = records->REnd();
4826 count > 0 && it != end; count--, it++) {
4827 const gc::AllocRecord* record = &it->second;
4829 LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->GetTid(), record->ByteCount())
4830 << PrettyClass(record->GetClass());
4832 for (size_t stack_frame = 0, depth = record->GetDepth(); stack_frame < depth; ++stack_frame) {
4833 const gc::AllocRecordStackTraceElement& stack_element = record->StackElement(stack_frame);
4834 ArtMethod* m = stack_element.GetMethod();
4835 LOG(INFO) << " " << PrettyMethod(m) << " line " << stack_element.ComputeLineNumber();
4838 // pause periodically to help logcat catch up
4839 if ((count % 5) == 0) {
4850 void Add(const std::string& str) {
4854 void Add(const char* str) {
4858 size_t IndexOf(const char* s) const {
4859 auto it = table_.find(s);
4860 if (it == table_.end()) {
4861 LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
4863 return std::distance(table_.begin(), it);
4866 size_t Size() const {
4867 return table_.size();
4870 void WriteTo(std::vector<uint8_t>& bytes) const {
4871 for (const std::string& str : table_) {
4872 const char* s = str.c_str();
4873 size_t s_len = CountModifiedUtf8Chars(s);
4874 std::unique_ptr<uint16_t[]> s_utf16(new uint16_t[s_len]);
4875 ConvertModifiedUtf8ToUtf16(s_utf16.get(), s);
4876 JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
4881 std::set<std::string> table_;
4882 DISALLOW_COPY_AND_ASSIGN(StringTable);
4885 static const char* GetMethodSourceFile(ArtMethod* method)
4886 SHARED_REQUIRES(Locks::mutator_lock_) {
4887 DCHECK(method != nullptr);
4888 const char* source_file = method->GetDeclaringClassSourceFile();
4889 return (source_file != nullptr) ? source_file : "";
4893 * The data we send to DDMS contains everything we have recorded.
4895 * Message header (all values big-endian):
4896 * (1b) message header len (to allow future expansion); includes itself
4897 * (1b) entry header len
4898 * (1b) stack frame len
4899 * (2b) number of entries
4900 * (4b) offset to string table from start of message
4901 * (2b) number of class name strings
4902 * (2b) number of method name strings
4903 * (2b) number of source file name strings
4905 * (4b) total allocation size
4907 * (2b) allocated object's class name index
4909 * For each stack frame:
4910 * (2b) method's class name
4912 * (2b) method source file
4913 * (2b) line number, clipped to 32767; -2 if native; -1 if no source
4914 * (xb) class name strings
4915 * (xb) method name strings
4916 * (xb) source file strings
4918 * As with other DDM traffic, strings are sent as a 4-byte length
4919 * followed by UTF-16 data.
4921 * We send up 16-bit unsigned indexes into string tables. In theory there
4922 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
4923 * each table, but in practice there should be far fewer.
4925 * The chief reason for using a string table here is to keep the size of
4926 * the DDMS message to a minimum. This is partly to make the protocol
4927 * efficient, but also because we have to form the whole thing up all at
4928 * once in a memory buffer.
4930 * We use separate string tables for class names, method names, and source
4931 * files to keep the indexes small. There will generally be no overlap
4932 * between the contents of these tables.
4934 jbyteArray Dbg::GetRecentAllocations() {
4936 DumpRecentAllocations();
4939 Thread* self = Thread::Current();
4940 std::vector<uint8_t> bytes;
4942 MutexLock mu(self, *Locks::alloc_tracker_lock_);
4943 gc::AllocRecordObjectMap* records = Runtime::Current()->GetHeap()->GetAllocationRecords();
4944 // In case this method is called when allocation tracker is disabled,
4945 // we should still send some data back.
4946 gc::AllocRecordObjectMap dummy;
4947 if (records == nullptr) {
4948 CHECK(!Runtime::Current()->GetHeap()->IsAllocTrackingEnabled());
4951 // We don't need to wait on the condition variable records->new_record_condition_, because this
4952 // function only reads the class objects, which are already marked so it doesn't change their
4956 // Part 1: generate string tables.
4958 StringTable class_names;
4959 StringTable method_names;
4960 StringTable filenames;
4962 const uint16_t capped_count = CappedAllocRecordCount(records->GetRecentAllocationSize());
4963 uint16_t count = capped_count;
4964 for (auto it = records->RBegin(), end = records->REnd();
4965 count > 0 && it != end; count--, it++) {
4966 const gc::AllocRecord* record = &it->second;
4968 class_names.Add(record->GetClassDescriptor(&temp));
4969 for (size_t i = 0, depth = record->GetDepth(); i < depth; i++) {
4970 ArtMethod* m = record->StackElement(i).GetMethod();
4971 class_names.Add(m->GetDeclaringClassDescriptor());
4972 method_names.Add(m->GetName());
4973 filenames.Add(GetMethodSourceFile(m));
4977 LOG(INFO) << "recent allocation records: " << capped_count;
4978 LOG(INFO) << "allocation records all objects: " << records->Size();
4981 // Part 2: Generate the output and store it in the buffer.
4984 // (1b) message header len (to allow future expansion); includes itself
4985 // (1b) entry header len
4986 // (1b) stack frame len
4987 const int kMessageHeaderLen = 15;
4988 const int kEntryHeaderLen = 9;
4989 const int kStackFrameLen = 8;
4990 JDWP::Append1BE(bytes, kMessageHeaderLen);
4991 JDWP::Append1BE(bytes, kEntryHeaderLen);
4992 JDWP::Append1BE(bytes, kStackFrameLen);
4994 // (2b) number of entries
4995 // (4b) offset to string table from start of message
4996 // (2b) number of class name strings
4997 // (2b) number of method name strings
4998 // (2b) number of source file name strings
4999 JDWP::Append2BE(bytes, capped_count);
5000 size_t string_table_offset = bytes.size();
5001 JDWP::Append4BE(bytes, 0); // We'll patch this later...
5002 JDWP::Append2BE(bytes, class_names.Size());
5003 JDWP::Append2BE(bytes, method_names.Size());
5004 JDWP::Append2BE(bytes, filenames.Size());
5007 count = capped_count;
5008 // The last "count" number of allocation records in "records" are the most recent "count" number
5009 // of allocations. Reverse iterate to get them. The most recent allocation is sent first.
5010 for (auto it = records->RBegin(), end = records->REnd();
5011 count > 0 && it != end; count--, it++) {
5013 // (4b) total allocation size
5015 // (2b) allocated object's class name index
5017 const gc::AllocRecord* record = &it->second;
5018 size_t stack_depth = record->GetDepth();
5019 size_t allocated_object_class_name_index =
5020 class_names.IndexOf(record->GetClassDescriptor(&temp));
5021 JDWP::Append4BE(bytes, record->ByteCount());
5022 JDWP::Append2BE(bytes, static_cast<uint16_t>(record->GetTid()));
5023 JDWP::Append2BE(bytes, allocated_object_class_name_index);
5024 JDWP::Append1BE(bytes, stack_depth);
5026 for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
5027 // For each stack frame:
5028 // (2b) method's class name
5030 // (2b) method source file
5031 // (2b) line number, clipped to 32767; -2 if native; -1 if no source
5032 ArtMethod* m = record->StackElement(stack_frame).GetMethod();
5033 size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
5034 size_t method_name_index = method_names.IndexOf(m->GetName());
5035 size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
5036 JDWP::Append2BE(bytes, class_name_index);
5037 JDWP::Append2BE(bytes, method_name_index);
5038 JDWP::Append2BE(bytes, file_name_index);
5039 JDWP::Append2BE(bytes, record->StackElement(stack_frame).ComputeLineNumber());
5043 // (xb) class name strings
5044 // (xb) method name strings
5045 // (xb) source file strings
5046 JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
5047 class_names.WriteTo(bytes);
5048 method_names.WriteTo(bytes);
5049 filenames.WriteTo(bytes);
5051 JNIEnv* env = self->GetJniEnv();
5052 jbyteArray result = env->NewByteArray(bytes.size());
5053 if (result != nullptr) {
5054 env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
5059 ArtMethod* DeoptimizationRequest::Method() const {
5060 ScopedObjectAccessUnchecked soa(Thread::Current());
5061 return soa.DecodeMethod(method_);
5064 void DeoptimizationRequest::SetMethod(ArtMethod* m) {
5065 ScopedObjectAccessUnchecked soa(Thread::Current());
5066 method_ = soa.EncodeMethod(m);
5069 void Dbg::VisitRoots(RootVisitor* visitor) {
5070 // Visit breakpoint roots, used to prevent unloading of methods with breakpoints.
5071 ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
5072 BufferedRootVisitor<128> root_visitor(visitor, RootInfo(kRootVMInternal));
5073 for (Breakpoint& breakpoint : gBreakpoints) {
5074 breakpoint.Method()->VisitRoots(root_visitor, sizeof(void*));