debugger.cc revision 2cebb24bfc3247d3e9be138a3350106737455918
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "debugger.h"
18
19#include <sys/uio.h>
20
21#include <set>
22
23#include "arch/context.h"
24#include "art_field-inl.h"
25#include "class_linker.h"
26#include "class_linker-inl.h"
27#include "dex_file-inl.h"
28#include "dex_instruction.h"
29#include "gc/accounting/card_table-inl.h"
30#include "gc/space/large_object_space.h"
31#include "gc/space/space-inl.h"
32#include "handle_scope.h"
33#include "jdwp/object_registry.h"
34#include "mirror/art_method-inl.h"
35#include "mirror/class.h"
36#include "mirror/class-inl.h"
37#include "mirror/class_loader.h"
38#include "mirror/object-inl.h"
39#include "mirror/object_array-inl.h"
40#include "mirror/string-inl.h"
41#include "mirror/throwable.h"
42#include "quick/inline_method_analyser.h"
43#include "reflection.h"
44#include "safe_map.h"
45#include "scoped_thread_state_change.h"
46#include "ScopedLocalRef.h"
47#include "ScopedPrimitiveArray.h"
48#include "handle_scope-inl.h"
49#include "thread_list.h"
50#include "utf.h"
51#include "verifier/method_verifier-inl.h"
52#include "well_known_classes.h"
53
54#ifdef HAVE_ANDROID_OS
55#include "cutils/properties.h"
56#endif
57
58namespace art {
59
60static const size_t kMaxAllocRecordStackDepth = 16;  // Max 255.
61static const size_t kDefaultNumAllocRecords = 64*1024;  // Must be a power of 2. 2BE can hold 64k-1.
62
63// Limit alloc_record_count to the 2BE value that is the limit of the current protocol.
64static uint16_t CappedAllocRecordCount(size_t alloc_record_count) {
65  if (alloc_record_count > 0xffff) {
66    return 0xffff;
67  }
68  return alloc_record_count;
69}
70
71class AllocRecordStackTraceElement {
72 public:
73  AllocRecordStackTraceElement() : method_(nullptr), dex_pc_(0) {
74  }
75
76  int32_t LineNumber() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
77    mirror::ArtMethod* method = Method();
78    DCHECK(method != nullptr);
79    return method->GetLineNumFromDexPC(DexPc());
80  }
81
82  mirror::ArtMethod* Method() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
83    ScopedObjectAccessUnchecked soa(Thread::Current());
84    return soa.DecodeMethod(method_);
85  }
86
87  void SetMethod(mirror::ArtMethod* m) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
88    ScopedObjectAccessUnchecked soa(Thread::Current());
89    method_ = soa.EncodeMethod(m);
90  }
91
92  uint32_t DexPc() const {
93    return dex_pc_;
94  }
95
96  void SetDexPc(uint32_t pc) {
97    dex_pc_ = pc;
98  }
99
100 private:
101  jmethodID method_;
102  uint32_t dex_pc_;
103};
104
105jobject Dbg::TypeCache::Add(mirror::Class* t) {
106  ScopedObjectAccessUnchecked soa(Thread::Current());
107  JNIEnv* const env = soa.Env();
108  ScopedLocalRef<jobject> local_ref(soa.Env(), soa.AddLocalReference<jobject>(t));
109  const int32_t hash_code = soa.Decode<mirror::Class*>(local_ref.get())->IdentityHashCode();
110  auto range = objects_.equal_range(hash_code);
111  for (auto it = range.first; it != range.second; ++it) {
112    if (soa.Decode<mirror::Class*>(it->second) == soa.Decode<mirror::Class*>(local_ref.get())) {
113      // Found a matching weak global, return it.
114      return it->second;
115    }
116  }
117  const jobject weak_global = env->NewWeakGlobalRef(local_ref.get());
118  objects_.insert(std::make_pair(hash_code, weak_global));
119  return weak_global;
120}
121
122void Dbg::TypeCache::Clear() {
123  JavaVMExt* vm = Runtime::Current()->GetJavaVM();
124  Thread* self = Thread::Current();
125  for (const auto& p : objects_) {
126    vm->DeleteWeakGlobalRef(self, p.second);
127  }
128  objects_.clear();
129}
130
131class AllocRecord {
132 public:
133  AllocRecord() : type_(nullptr), byte_count_(0), thin_lock_id_(0) {}
134
135  mirror::Class* Type() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
136    return down_cast<mirror::Class*>(Thread::Current()->DecodeJObject(type_));
137  }
138
139  void SetType(mirror::Class* t) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_,
140                                                       Locks::alloc_tracker_lock_) {
141    type_ = Dbg::type_cache_.Add(t);
142  }
143
144  size_t GetDepth() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
145    size_t depth = 0;
146    while (depth < kMaxAllocRecordStackDepth && stack_[depth].Method() != nullptr) {
147      ++depth;
148    }
149    return depth;
150  }
151
152  size_t ByteCount() const {
153    return byte_count_;
154  }
155
156  void SetByteCount(size_t count) {
157    byte_count_ = count;
158  }
159
160  uint16_t ThinLockId() const {
161    return thin_lock_id_;
162  }
163
164  void SetThinLockId(uint16_t id) {
165    thin_lock_id_ = id;
166  }
167
168  AllocRecordStackTraceElement* StackElement(size_t index) {
169    DCHECK_LT(index, kMaxAllocRecordStackDepth);
170    return &stack_[index];
171  }
172
173 private:
174  jobject type_;  // This is a weak global.
175  size_t byte_count_;
176  uint16_t thin_lock_id_;
177  // Unused entries have null method.
178  AllocRecordStackTraceElement stack_[kMaxAllocRecordStackDepth];
179};
180
181class Breakpoint {
182 public:
183  Breakpoint(mirror::ArtMethod* method, uint32_t dex_pc,
184             DeoptimizationRequest::Kind deoptimization_kind)
185    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
186    : method_(nullptr), dex_pc_(dex_pc), deoptimization_kind_(deoptimization_kind) {
187    CHECK(deoptimization_kind_ == DeoptimizationRequest::kNothing ||
188          deoptimization_kind_ == DeoptimizationRequest::kSelectiveDeoptimization ||
189          deoptimization_kind_ == DeoptimizationRequest::kFullDeoptimization);
190    ScopedObjectAccessUnchecked soa(Thread::Current());
191    method_ = soa.EncodeMethod(method);
192  }
193
194  Breakpoint(const Breakpoint& other) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
195    : method_(nullptr), dex_pc_(other.dex_pc_),
196      deoptimization_kind_(other.deoptimization_kind_) {
197    ScopedObjectAccessUnchecked soa(Thread::Current());
198    method_ = soa.EncodeMethod(other.Method());
199  }
200
201  mirror::ArtMethod* Method() const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
202    ScopedObjectAccessUnchecked soa(Thread::Current());
203    return soa.DecodeMethod(method_);
204  }
205
206  uint32_t DexPc() const {
207    return dex_pc_;
208  }
209
210  DeoptimizationRequest::Kind GetDeoptimizationKind() const {
211    return deoptimization_kind_;
212  }
213
214 private:
215  // The location of this breakpoint.
216  jmethodID method_;
217  uint32_t dex_pc_;
218
219  // Indicates whether breakpoint needs full deoptimization or selective deoptimization.
220  DeoptimizationRequest::Kind deoptimization_kind_;
221};
222
223static std::ostream& operator<<(std::ostream& os, const Breakpoint& rhs)
224    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
225  os << StringPrintf("Breakpoint[%s @%#x]", PrettyMethod(rhs.Method()).c_str(), rhs.DexPc());
226  return os;
227}
228
229class DebugInstrumentationListener FINAL : public instrumentation::InstrumentationListener {
230 public:
231  DebugInstrumentationListener() {}
232  virtual ~DebugInstrumentationListener() {}
233
234  void MethodEntered(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
235                     uint32_t dex_pc ATTRIBUTE_UNUSED)
236      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
237    if (method->IsNative()) {
238      // TODO: post location events is a suspension point and native method entry stubs aren't.
239      return;
240    }
241    Dbg::UpdateDebugger(thread, this_object, method, 0, Dbg::kMethodEntry, nullptr);
242  }
243
244  void MethodExited(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
245                    uint32_t dex_pc, const JValue& return_value)
246      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
247    if (method->IsNative()) {
248      // TODO: post location events is a suspension point and native method entry stubs aren't.
249      return;
250    }
251    Dbg::UpdateDebugger(thread, this_object, method, dex_pc, Dbg::kMethodExit, &return_value);
252  }
253
254  void MethodUnwind(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
255                    uint32_t dex_pc)
256      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
257    // We're not recorded to listen to this kind of event, so complain.
258    UNUSED(thread, this_object, method, dex_pc);
259    LOG(ERROR) << "Unexpected method unwind event in debugger " << PrettyMethod(method)
260               << " " << dex_pc;
261  }
262
263  void DexPcMoved(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
264                  uint32_t new_dex_pc)
265      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
266    Dbg::UpdateDebugger(thread, this_object, method, new_dex_pc, 0, nullptr);
267  }
268
269  void FieldRead(Thread* thread, mirror::Object* this_object, mirror::ArtMethod* method,
270                 uint32_t dex_pc, ArtField* field)
271      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
272    UNUSED(thread);
273    Dbg::PostFieldAccessEvent(method, dex_pc, this_object, field);
274  }
275
276  void FieldWritten(Thread* thread ATTRIBUTE_UNUSED, mirror::Object* this_object,
277                    mirror::ArtMethod* method, uint32_t dex_pc, ArtField* field,
278                    const JValue& field_value)
279      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
280    Dbg::PostFieldModificationEvent(method, dex_pc, this_object, field, &field_value);
281  }
282
283  void ExceptionCaught(Thread* thread ATTRIBUTE_UNUSED, mirror::Throwable* exception_object)
284      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
285    Dbg::PostException(exception_object);
286  }
287
288  // We only care about how many backward branches were executed in the Jit.
289  void BackwardBranch(Thread* /*thread*/, mirror::ArtMethod* method, int32_t dex_pc_offset)
290      OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
291    LOG(ERROR) << "Unexpected backward branch event in debugger " << PrettyMethod(method)
292               << " " << dex_pc_offset;
293  }
294
295 private:
296  DISALLOW_COPY_AND_ASSIGN(DebugInstrumentationListener);
297} gDebugInstrumentationListener;
298
299// JDWP is allowed unless the Zygote forbids it.
300static bool gJdwpAllowed = true;
301
302// Was there a -Xrunjdwp or -agentlib:jdwp= argument on the command line?
303static bool gJdwpConfigured = false;
304
305// JDWP options for debugging. Only valid if IsJdwpConfigured() is true.
306static JDWP::JdwpOptions gJdwpOptions;
307
308// Runtime JDWP state.
309static JDWP::JdwpState* gJdwpState = nullptr;
310static bool gDebuggerConnected;  // debugger or DDMS is connected.
311
312static bool gDdmThreadNotification = false;
313
314// DDMS GC-related settings.
315static Dbg::HpifWhen gDdmHpifWhen = Dbg::HPIF_WHEN_NEVER;
316static Dbg::HpsgWhen gDdmHpsgWhen = Dbg::HPSG_WHEN_NEVER;
317static Dbg::HpsgWhat gDdmHpsgWhat;
318static Dbg::HpsgWhen gDdmNhsgWhen = Dbg::HPSG_WHEN_NEVER;
319static Dbg::HpsgWhat gDdmNhsgWhat;
320
321bool Dbg::gDebuggerActive = false;
322bool Dbg::gDisposed = false;
323ObjectRegistry* Dbg::gRegistry = nullptr;
324
325// Recent allocation tracking.
326AllocRecord* Dbg::recent_allocation_records_ = nullptr;  // TODO: CircularBuffer<AllocRecord>
327size_t Dbg::alloc_record_max_ = 0;
328size_t Dbg::alloc_record_head_ = 0;
329size_t Dbg::alloc_record_count_ = 0;
330Dbg::TypeCache Dbg::type_cache_;
331
332// Deoptimization support.
333std::vector<DeoptimizationRequest> Dbg::deoptimization_requests_;
334size_t Dbg::full_deoptimization_event_count_ = 0;
335
336// Instrumentation event reference counters.
337size_t Dbg::dex_pc_change_event_ref_count_ = 0;
338size_t Dbg::method_enter_event_ref_count_ = 0;
339size_t Dbg::method_exit_event_ref_count_ = 0;
340size_t Dbg::field_read_event_ref_count_ = 0;
341size_t Dbg::field_write_event_ref_count_ = 0;
342size_t Dbg::exception_catch_event_ref_count_ = 0;
343uint32_t Dbg::instrumentation_events_ = 0;
344
345// Breakpoints.
346static std::vector<Breakpoint> gBreakpoints GUARDED_BY(Locks::breakpoint_lock_);
347
348void DebugInvokeReq::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
349  receiver.VisitRootIfNonNull(visitor, root_info);  // null for static method call.
350  klass.VisitRoot(visitor, root_info);
351  method.VisitRoot(visitor, root_info);
352}
353
354void SingleStepControl::VisitRoots(RootVisitor* visitor, const RootInfo& root_info) {
355  visitor->VisitRootIfNonNull(reinterpret_cast<mirror::Object**>(&method_), root_info);
356}
357
358void SingleStepControl::AddDexPc(uint32_t dex_pc) {
359  dex_pcs_.insert(dex_pc);
360}
361
362bool SingleStepControl::ContainsDexPc(uint32_t dex_pc) const {
363  return dex_pcs_.find(dex_pc) == dex_pcs_.end();
364}
365
366static bool IsBreakpoint(const mirror::ArtMethod* m, uint32_t dex_pc)
367    LOCKS_EXCLUDED(Locks::breakpoint_lock_)
368    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
369  ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
370  for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
371    if (gBreakpoints[i].DexPc() == dex_pc && gBreakpoints[i].Method() == m) {
372      VLOG(jdwp) << "Hit breakpoint #" << i << ": " << gBreakpoints[i];
373      return true;
374    }
375  }
376  return false;
377}
378
379static bool IsSuspendedForDebugger(ScopedObjectAccessUnchecked& soa, Thread* thread)
380    LOCKS_EXCLUDED(Locks::thread_suspend_count_lock_) {
381  MutexLock mu(soa.Self(), *Locks::thread_suspend_count_lock_);
382  // A thread may be suspended for GC; in this code, we really want to know whether
383  // there's a debugger suspension active.
384  return thread->IsSuspended() && thread->GetDebugSuspendCount() > 0;
385}
386
387static mirror::Array* DecodeNonNullArray(JDWP::RefTypeId id, JDWP::JdwpError* error)
388    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
389  mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
390  if (o == nullptr) {
391    *error = JDWP::ERR_INVALID_OBJECT;
392    return nullptr;
393  }
394  if (!o->IsArrayInstance()) {
395    *error = JDWP::ERR_INVALID_ARRAY;
396    return nullptr;
397  }
398  *error = JDWP::ERR_NONE;
399  return o->AsArray();
400}
401
402static mirror::Class* DecodeClass(JDWP::RefTypeId id, JDWP::JdwpError* error)
403    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
404  mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(id, error);
405  if (o == nullptr) {
406    *error = JDWP::ERR_INVALID_OBJECT;
407    return nullptr;
408  }
409  if (!o->IsClass()) {
410    *error = JDWP::ERR_INVALID_CLASS;
411    return nullptr;
412  }
413  *error = JDWP::ERR_NONE;
414  return o->AsClass();
415}
416
417static Thread* DecodeThread(ScopedObjectAccessUnchecked& soa, JDWP::ObjectId thread_id,
418                            JDWP::JdwpError* error)
419    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
420    LOCKS_EXCLUDED(Locks::thread_list_lock_, Locks::thread_suspend_count_lock_) {
421  mirror::Object* thread_peer = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_id, error);
422  if (thread_peer == nullptr) {
423    // This isn't even an object.
424    *error = JDWP::ERR_INVALID_OBJECT;
425    return nullptr;
426  }
427
428  mirror::Class* java_lang_Thread = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
429  if (!java_lang_Thread->IsAssignableFrom(thread_peer->GetClass())) {
430    // This isn't a thread.
431    *error = JDWP::ERR_INVALID_THREAD;
432    return nullptr;
433  }
434
435  MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
436  Thread* thread = Thread::FromManagedThread(soa, thread_peer);
437  // If thread is null then this a java.lang.Thread without a Thread*. Must be a un-started or a
438  // zombie.
439  *error = (thread == nullptr) ? JDWP::ERR_THREAD_NOT_ALIVE : JDWP::ERR_NONE;
440  return thread;
441}
442
443static JDWP::JdwpTag BasicTagFromDescriptor(const char* descriptor) {
444  // JDWP deliberately uses the descriptor characters' ASCII values for its enum.
445  // Note that by "basic" we mean that we don't get more specific than JT_OBJECT.
446  return static_cast<JDWP::JdwpTag>(descriptor[0]);
447}
448
449static JDWP::JdwpTag BasicTagFromClass(mirror::Class* klass)
450    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
451  std::string temp;
452  const char* descriptor = klass->GetDescriptor(&temp);
453  return BasicTagFromDescriptor(descriptor);
454}
455
456static JDWP::JdwpTag TagFromClass(const ScopedObjectAccessUnchecked& soa, mirror::Class* c)
457    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
458  CHECK(c != nullptr);
459  if (c->IsArrayClass()) {
460    return JDWP::JT_ARRAY;
461  }
462  if (c->IsStringClass()) {
463    return JDWP::JT_STRING;
464  }
465  if (c->IsClassClass()) {
466    return JDWP::JT_CLASS_OBJECT;
467  }
468  {
469    mirror::Class* thread_class = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
470    if (thread_class->IsAssignableFrom(c)) {
471      return JDWP::JT_THREAD;
472    }
473  }
474  {
475    mirror::Class* thread_group_class =
476        soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
477    if (thread_group_class->IsAssignableFrom(c)) {
478      return JDWP::JT_THREAD_GROUP;
479    }
480  }
481  {
482    mirror::Class* class_loader_class =
483        soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ClassLoader);
484    if (class_loader_class->IsAssignableFrom(c)) {
485      return JDWP::JT_CLASS_LOADER;
486    }
487  }
488  return JDWP::JT_OBJECT;
489}
490
491/*
492 * Objects declared to hold Object might actually hold a more specific
493 * type.  The debugger may take a special interest in these (e.g. it
494 * wants to display the contents of Strings), so we want to return an
495 * appropriate tag.
496 *
497 * Null objects are tagged JT_OBJECT.
498 */
499JDWP::JdwpTag Dbg::TagFromObject(const ScopedObjectAccessUnchecked& soa, mirror::Object* o) {
500  return (o == nullptr) ? JDWP::JT_OBJECT : TagFromClass(soa, o->GetClass());
501}
502
503static bool IsPrimitiveTag(JDWP::JdwpTag tag) {
504  switch (tag) {
505  case JDWP::JT_BOOLEAN:
506  case JDWP::JT_BYTE:
507  case JDWP::JT_CHAR:
508  case JDWP::JT_FLOAT:
509  case JDWP::JT_DOUBLE:
510  case JDWP::JT_INT:
511  case JDWP::JT_LONG:
512  case JDWP::JT_SHORT:
513  case JDWP::JT_VOID:
514    return true;
515  default:
516    return false;
517  }
518}
519
520void Dbg::StartJdwp() {
521  if (!gJdwpAllowed || !IsJdwpConfigured()) {
522    // No JDWP for you!
523    return;
524  }
525
526  CHECK(gRegistry == nullptr);
527  gRegistry = new ObjectRegistry;
528
529  // Init JDWP if the debugger is enabled. This may connect out to a
530  // debugger, passively listen for a debugger, or block waiting for a
531  // debugger.
532  gJdwpState = JDWP::JdwpState::Create(&gJdwpOptions);
533  if (gJdwpState == nullptr) {
534    // We probably failed because some other process has the port already, which means that
535    // if we don't abort the user is likely to think they're talking to us when they're actually
536    // talking to that other process.
537    LOG(FATAL) << "Debugger thread failed to initialize";
538  }
539
540  // If a debugger has already attached, send the "welcome" message.
541  // This may cause us to suspend all threads.
542  if (gJdwpState->IsActive()) {
543    ScopedObjectAccess soa(Thread::Current());
544    gJdwpState->PostVMStart();
545  }
546}
547
548void Dbg::StopJdwp() {
549  // Post VM_DEATH event before the JDWP connection is closed (either by the JDWP thread or the
550  // destruction of gJdwpState).
551  if (gJdwpState != nullptr && gJdwpState->IsActive()) {
552    gJdwpState->PostVMDeath();
553  }
554  // Prevent the JDWP thread from processing JDWP incoming packets after we close the connection.
555  Dispose();
556  delete gJdwpState;
557  gJdwpState = nullptr;
558  delete gRegistry;
559  gRegistry = nullptr;
560}
561
562void Dbg::GcDidFinish() {
563  if (gDdmHpifWhen != HPIF_WHEN_NEVER) {
564    ScopedObjectAccess soa(Thread::Current());
565    VLOG(jdwp) << "Sending heap info to DDM";
566    DdmSendHeapInfo(gDdmHpifWhen);
567  }
568  if (gDdmHpsgWhen != HPSG_WHEN_NEVER) {
569    ScopedObjectAccess soa(Thread::Current());
570    VLOG(jdwp) << "Dumping heap to DDM";
571    DdmSendHeapSegments(false);
572  }
573  if (gDdmNhsgWhen != HPSG_WHEN_NEVER) {
574    ScopedObjectAccess soa(Thread::Current());
575    VLOG(jdwp) << "Dumping native heap to DDM";
576    DdmSendHeapSegments(true);
577  }
578}
579
580void Dbg::SetJdwpAllowed(bool allowed) {
581  gJdwpAllowed = allowed;
582}
583
584DebugInvokeReq* Dbg::GetInvokeReq() {
585  return Thread::Current()->GetInvokeReq();
586}
587
588Thread* Dbg::GetDebugThread() {
589  return (gJdwpState != nullptr) ? gJdwpState->GetDebugThread() : nullptr;
590}
591
592void Dbg::ClearWaitForEventThread() {
593  gJdwpState->ReleaseJdwpTokenForEvent();
594}
595
596void Dbg::Connected() {
597  CHECK(!gDebuggerConnected);
598  VLOG(jdwp) << "JDWP has attached";
599  gDebuggerConnected = true;
600  gDisposed = false;
601}
602
603bool Dbg::RequiresDeoptimization() {
604  // We don't need deoptimization if everything runs with interpreter after
605  // enabling -Xint mode.
606  return !Runtime::Current()->GetInstrumentation()->IsForcedInterpretOnly();
607}
608
609void Dbg::GoActive() {
610  // Enable all debugging features, including scans for breakpoints.
611  // This is a no-op if we're already active.
612  // Only called from the JDWP handler thread.
613  if (IsDebuggerActive()) {
614    return;
615  }
616
617  {
618    // TODO: dalvik only warned if there were breakpoints left over. clear in Dbg::Disconnected?
619    ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
620    CHECK_EQ(gBreakpoints.size(), 0U);
621  }
622
623  {
624    MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
625    CHECK_EQ(deoptimization_requests_.size(), 0U);
626    CHECK_EQ(full_deoptimization_event_count_, 0U);
627    CHECK_EQ(dex_pc_change_event_ref_count_, 0U);
628    CHECK_EQ(method_enter_event_ref_count_, 0U);
629    CHECK_EQ(method_exit_event_ref_count_, 0U);
630    CHECK_EQ(field_read_event_ref_count_, 0U);
631    CHECK_EQ(field_write_event_ref_count_, 0U);
632    CHECK_EQ(exception_catch_event_ref_count_, 0U);
633  }
634
635  Runtime* runtime = Runtime::Current();
636  runtime->GetThreadList()->SuspendAll(__FUNCTION__);
637  Thread* self = Thread::Current();
638  ThreadState old_state = self->SetStateUnsafe(kRunnable);
639  CHECK_NE(old_state, kRunnable);
640  if (RequiresDeoptimization()) {
641    runtime->GetInstrumentation()->EnableDeoptimization();
642  }
643  instrumentation_events_ = 0;
644  gDebuggerActive = true;
645  CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
646  runtime->GetThreadList()->ResumeAll();
647
648  LOG(INFO) << "Debugger is active";
649}
650
651void Dbg::Disconnected() {
652  CHECK(gDebuggerConnected);
653
654  LOG(INFO) << "Debugger is no longer active";
655
656  // Suspend all threads and exclusively acquire the mutator lock. Set the state of the thread
657  // to kRunnable to avoid scoped object access transitions. Remove the debugger as a listener
658  // and clear the object registry.
659  Runtime* runtime = Runtime::Current();
660  runtime->GetThreadList()->SuspendAll(__FUNCTION__);
661  Thread* self = Thread::Current();
662  ThreadState old_state = self->SetStateUnsafe(kRunnable);
663
664  // Debugger may not be active at this point.
665  if (IsDebuggerActive()) {
666    {
667      // Since we're going to disable deoptimization, we clear the deoptimization requests queue.
668      // This prevents us from having any pending deoptimization request when the debugger attaches
669      // to us again while no event has been requested yet.
670      MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
671      deoptimization_requests_.clear();
672      full_deoptimization_event_count_ = 0U;
673    }
674    if (instrumentation_events_ != 0) {
675      runtime->GetInstrumentation()->RemoveListener(&gDebugInstrumentationListener,
676                                                    instrumentation_events_);
677      instrumentation_events_ = 0;
678    }
679    if (RequiresDeoptimization()) {
680      runtime->GetInstrumentation()->DisableDeoptimization();
681    }
682    gDebuggerActive = false;
683  }
684  CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
685  runtime->GetThreadList()->ResumeAll();
686
687  {
688    ScopedObjectAccess soa(self);
689    gRegistry->Clear();
690  }
691
692  gDebuggerConnected = false;
693}
694
695void Dbg::ConfigureJdwp(const JDWP::JdwpOptions& jdwp_options) {
696  CHECK_NE(jdwp_options.transport, JDWP::kJdwpTransportUnknown);
697  gJdwpOptions = jdwp_options;
698  gJdwpConfigured = true;
699}
700
701bool Dbg::IsJdwpConfigured() {
702  return gJdwpConfigured;
703}
704
705int64_t Dbg::LastDebuggerActivity() {
706  return gJdwpState->LastDebuggerActivity();
707}
708
709void Dbg::UndoDebuggerSuspensions() {
710  Runtime::Current()->GetThreadList()->UndoDebuggerSuspensions();
711}
712
713std::string Dbg::GetClassName(JDWP::RefTypeId class_id) {
714  JDWP::JdwpError error;
715  mirror::Object* o = gRegistry->Get<mirror::Object*>(class_id, &error);
716  if (o == nullptr) {
717    if (error == JDWP::ERR_NONE) {
718      return "null";
719    } else {
720      return StringPrintf("invalid object %p", reinterpret_cast<void*>(class_id));
721    }
722  }
723  if (!o->IsClass()) {
724    return StringPrintf("non-class %p", o);  // This is only used for debugging output anyway.
725  }
726  return GetClassName(o->AsClass());
727}
728
729std::string Dbg::GetClassName(mirror::Class* klass) {
730  if (klass == nullptr) {
731    return "null";
732  }
733  std::string temp;
734  return DescriptorToName(klass->GetDescriptor(&temp));
735}
736
737JDWP::JdwpError Dbg::GetClassObject(JDWP::RefTypeId id, JDWP::ObjectId* class_object_id) {
738  JDWP::JdwpError status;
739  mirror::Class* c = DecodeClass(id, &status);
740  if (c == nullptr) {
741    *class_object_id = 0;
742    return status;
743  }
744  *class_object_id = gRegistry->Add(c);
745  return JDWP::ERR_NONE;
746}
747
748JDWP::JdwpError Dbg::GetSuperclass(JDWP::RefTypeId id, JDWP::RefTypeId* superclass_id) {
749  JDWP::JdwpError status;
750  mirror::Class* c = DecodeClass(id, &status);
751  if (c == nullptr) {
752    *superclass_id = 0;
753    return status;
754  }
755  if (c->IsInterface()) {
756    // http://code.google.com/p/android/issues/detail?id=20856
757    *superclass_id = 0;
758  } else {
759    *superclass_id = gRegistry->Add(c->GetSuperClass());
760  }
761  return JDWP::ERR_NONE;
762}
763
764JDWP::JdwpError Dbg::GetClassLoader(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
765  JDWP::JdwpError error;
766  mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
767  if (o == nullptr) {
768    return JDWP::ERR_INVALID_OBJECT;
769  }
770  expandBufAddObjectId(pReply, gRegistry->Add(o->GetClass()->GetClassLoader()));
771  return JDWP::ERR_NONE;
772}
773
774JDWP::JdwpError Dbg::GetModifiers(JDWP::RefTypeId id, JDWP::ExpandBuf* pReply) {
775  JDWP::JdwpError error;
776  mirror::Class* c = DecodeClass(id, &error);
777  if (c == nullptr) {
778    return error;
779  }
780
781  uint32_t access_flags = c->GetAccessFlags() & kAccJavaFlagsMask;
782
783  // Set ACC_SUPER. Dex files don't contain this flag but only classes are supposed to have it set,
784  // not interfaces.
785  // Class.getModifiers doesn't return it, but JDWP does, so we set it here.
786  if ((access_flags & kAccInterface) == 0) {
787    access_flags |= kAccSuper;
788  }
789
790  expandBufAdd4BE(pReply, access_flags);
791
792  return JDWP::ERR_NONE;
793}
794
795JDWP::JdwpError Dbg::GetMonitorInfo(JDWP::ObjectId object_id, JDWP::ExpandBuf* reply) {
796  JDWP::JdwpError error;
797  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
798  if (o == nullptr) {
799    return JDWP::ERR_INVALID_OBJECT;
800  }
801
802  // Ensure all threads are suspended while we read objects' lock words.
803  Thread* self = Thread::Current();
804  CHECK_EQ(self->GetState(), kRunnable);
805  self->TransitionFromRunnableToSuspended(kSuspended);
806  Runtime::Current()->GetThreadList()->SuspendAll(__FUNCTION__);
807
808  MonitorInfo monitor_info(o);
809
810  Runtime::Current()->GetThreadList()->ResumeAll();
811  self->TransitionFromSuspendedToRunnable();
812
813  if (monitor_info.owner_ != nullptr) {
814    expandBufAddObjectId(reply, gRegistry->Add(monitor_info.owner_->GetPeer()));
815  } else {
816    expandBufAddObjectId(reply, gRegistry->Add(nullptr));
817  }
818  expandBufAdd4BE(reply, monitor_info.entry_count_);
819  expandBufAdd4BE(reply, monitor_info.waiters_.size());
820  for (size_t i = 0; i < monitor_info.waiters_.size(); ++i) {
821    expandBufAddObjectId(reply, gRegistry->Add(monitor_info.waiters_[i]->GetPeer()));
822  }
823  return JDWP::ERR_NONE;
824}
825
826JDWP::JdwpError Dbg::GetOwnedMonitors(JDWP::ObjectId thread_id,
827                                      std::vector<JDWP::ObjectId>* monitors,
828                                      std::vector<uint32_t>* stack_depths) {
829  struct OwnedMonitorVisitor : public StackVisitor {
830    OwnedMonitorVisitor(Thread* thread, Context* context,
831                        std::vector<JDWP::ObjectId>* monitor_vector,
832                        std::vector<uint32_t>* stack_depth_vector)
833        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
834      : StackVisitor(thread, context), current_stack_depth(0),
835        monitors(monitor_vector), stack_depths(stack_depth_vector) {}
836
837    // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
838    // annotalysis.
839    bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
840      if (!GetMethod()->IsRuntimeMethod()) {
841        Monitor::VisitLocks(this, AppendOwnedMonitors, this);
842        ++current_stack_depth;
843      }
844      return true;
845    }
846
847    static void AppendOwnedMonitors(mirror::Object* owned_monitor, void* arg)
848        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
849      OwnedMonitorVisitor* visitor = reinterpret_cast<OwnedMonitorVisitor*>(arg);
850      visitor->monitors->push_back(gRegistry->Add(owned_monitor));
851      visitor->stack_depths->push_back(visitor->current_stack_depth);
852    }
853
854    size_t current_stack_depth;
855    std::vector<JDWP::ObjectId>* const monitors;
856    std::vector<uint32_t>* const stack_depths;
857  };
858
859  ScopedObjectAccessUnchecked soa(Thread::Current());
860  JDWP::JdwpError error;
861  Thread* thread = DecodeThread(soa, thread_id, &error);
862  if (thread == nullptr) {
863    return error;
864  }
865  if (!IsSuspendedForDebugger(soa, thread)) {
866    return JDWP::ERR_THREAD_NOT_SUSPENDED;
867  }
868  std::unique_ptr<Context> context(Context::Create());
869  OwnedMonitorVisitor visitor(thread, context.get(), monitors, stack_depths);
870  visitor.WalkStack();
871  return JDWP::ERR_NONE;
872}
873
874JDWP::JdwpError Dbg::GetContendedMonitor(JDWP::ObjectId thread_id,
875                                         JDWP::ObjectId* contended_monitor) {
876  ScopedObjectAccessUnchecked soa(Thread::Current());
877  *contended_monitor = 0;
878  JDWP::JdwpError error;
879  Thread* thread = DecodeThread(soa, thread_id, &error);
880  if (thread == nullptr) {
881    return error;
882  }
883  if (!IsSuspendedForDebugger(soa, thread)) {
884    return JDWP::ERR_THREAD_NOT_SUSPENDED;
885  }
886  mirror::Object* contended_monitor_obj = Monitor::GetContendedMonitor(thread);
887  // Add() requires the thread_list_lock_ not held to avoid the lock
888  // level violation.
889  *contended_monitor = gRegistry->Add(contended_monitor_obj);
890  return JDWP::ERR_NONE;
891}
892
893JDWP::JdwpError Dbg::GetInstanceCounts(const std::vector<JDWP::RefTypeId>& class_ids,
894                                       std::vector<uint64_t>* counts) {
895  gc::Heap* heap = Runtime::Current()->GetHeap();
896  heap->CollectGarbage(false);
897  std::vector<mirror::Class*> classes;
898  counts->clear();
899  for (size_t i = 0; i < class_ids.size(); ++i) {
900    JDWP::JdwpError error;
901    mirror::Class* c = DecodeClass(class_ids[i], &error);
902    if (c == nullptr) {
903      return error;
904    }
905    classes.push_back(c);
906    counts->push_back(0);
907  }
908  heap->CountInstances(classes, false, &(*counts)[0]);
909  return JDWP::ERR_NONE;
910}
911
912JDWP::JdwpError Dbg::GetInstances(JDWP::RefTypeId class_id, int32_t max_count,
913                                  std::vector<JDWP::ObjectId>* instances) {
914  gc::Heap* heap = Runtime::Current()->GetHeap();
915  // We only want reachable instances, so do a GC.
916  heap->CollectGarbage(false);
917  JDWP::JdwpError error;
918  mirror::Class* c = DecodeClass(class_id, &error);
919  if (c == nullptr) {
920    return error;
921  }
922  std::vector<mirror::Object*> raw_instances;
923  Runtime::Current()->GetHeap()->GetInstances(c, max_count, raw_instances);
924  for (size_t i = 0; i < raw_instances.size(); ++i) {
925    instances->push_back(gRegistry->Add(raw_instances[i]));
926  }
927  return JDWP::ERR_NONE;
928}
929
930JDWP::JdwpError Dbg::GetReferringObjects(JDWP::ObjectId object_id, int32_t max_count,
931                                         std::vector<JDWP::ObjectId>* referring_objects) {
932  gc::Heap* heap = Runtime::Current()->GetHeap();
933  heap->CollectGarbage(false);
934  JDWP::JdwpError error;
935  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
936  if (o == nullptr) {
937    return JDWP::ERR_INVALID_OBJECT;
938  }
939  std::vector<mirror::Object*> raw_instances;
940  heap->GetReferringObjects(o, max_count, raw_instances);
941  for (size_t i = 0; i < raw_instances.size(); ++i) {
942    referring_objects->push_back(gRegistry->Add(raw_instances[i]));
943  }
944  return JDWP::ERR_NONE;
945}
946
947JDWP::JdwpError Dbg::DisableCollection(JDWP::ObjectId object_id) {
948  JDWP::JdwpError error;
949  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
950  if (o == nullptr) {
951    return JDWP::ERR_INVALID_OBJECT;
952  }
953  gRegistry->DisableCollection(object_id);
954  return JDWP::ERR_NONE;
955}
956
957JDWP::JdwpError Dbg::EnableCollection(JDWP::ObjectId object_id) {
958  JDWP::JdwpError error;
959  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
960  // Unlike DisableCollection, JDWP specs do not state an invalid object causes an error. The RI
961  // also ignores these cases and never return an error. However it's not obvious why this command
962  // should behave differently from DisableCollection and IsCollected commands. So let's be more
963  // strict and return an error if this happens.
964  if (o == nullptr) {
965    return JDWP::ERR_INVALID_OBJECT;
966  }
967  gRegistry->EnableCollection(object_id);
968  return JDWP::ERR_NONE;
969}
970
971JDWP::JdwpError Dbg::IsCollected(JDWP::ObjectId object_id, bool* is_collected) {
972  *is_collected = true;
973  if (object_id == 0) {
974    // Null object id is invalid.
975    return JDWP::ERR_INVALID_OBJECT;
976  }
977  // JDWP specs state an INVALID_OBJECT error is returned if the object ID is not valid. However
978  // the RI seems to ignore this and assume object has been collected.
979  JDWP::JdwpError error;
980  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
981  if (o != nullptr) {
982    *is_collected = gRegistry->IsCollected(object_id);
983  }
984  return JDWP::ERR_NONE;
985}
986
987void Dbg::DisposeObject(JDWP::ObjectId object_id, uint32_t reference_count) {
988  gRegistry->DisposeObject(object_id, reference_count);
989}
990
991JDWP::JdwpTypeTag Dbg::GetTypeTag(mirror::Class* klass) {
992  DCHECK(klass != nullptr);
993  if (klass->IsArrayClass()) {
994    return JDWP::TT_ARRAY;
995  } else if (klass->IsInterface()) {
996    return JDWP::TT_INTERFACE;
997  } else {
998    return JDWP::TT_CLASS;
999  }
1000}
1001
1002JDWP::JdwpError Dbg::GetReflectedType(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
1003  JDWP::JdwpError error;
1004  mirror::Class* c = DecodeClass(class_id, &error);
1005  if (c == nullptr) {
1006    return error;
1007  }
1008
1009  JDWP::JdwpTypeTag type_tag = GetTypeTag(c);
1010  expandBufAdd1(pReply, type_tag);
1011  expandBufAddRefTypeId(pReply, class_id);
1012  return JDWP::ERR_NONE;
1013}
1014
1015void Dbg::GetClassList(std::vector<JDWP::RefTypeId>* classes) {
1016  // Get the complete list of reference classes (i.e. all classes except
1017  // the primitive types).
1018  // Returns a newly-allocated buffer full of RefTypeId values.
1019  struct ClassListCreator {
1020    explicit ClassListCreator(std::vector<JDWP::RefTypeId>* classes_in) : classes(classes_in) {
1021    }
1022
1023    static bool Visit(mirror::Class* c, void* arg) {
1024      return reinterpret_cast<ClassListCreator*>(arg)->Visit(c);
1025    }
1026
1027    // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
1028    // annotalysis.
1029    bool Visit(mirror::Class* c) NO_THREAD_SAFETY_ANALYSIS {
1030      if (!c->IsPrimitive()) {
1031        classes->push_back(gRegistry->AddRefType(c));
1032      }
1033      return true;
1034    }
1035
1036    std::vector<JDWP::RefTypeId>* const classes;
1037  };
1038
1039  ClassListCreator clc(classes);
1040  Runtime::Current()->GetClassLinker()->VisitClassesWithoutClassesLock(ClassListCreator::Visit,
1041                                                                       &clc);
1042}
1043
1044JDWP::JdwpError Dbg::GetClassInfo(JDWP::RefTypeId class_id, JDWP::JdwpTypeTag* pTypeTag,
1045                                  uint32_t* pStatus, std::string* pDescriptor) {
1046  JDWP::JdwpError error;
1047  mirror::Class* c = DecodeClass(class_id, &error);
1048  if (c == nullptr) {
1049    return error;
1050  }
1051
1052  if (c->IsArrayClass()) {
1053    *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED;
1054    *pTypeTag = JDWP::TT_ARRAY;
1055  } else {
1056    if (c->IsErroneous()) {
1057      *pStatus = JDWP::CS_ERROR;
1058    } else {
1059      *pStatus = JDWP::CS_VERIFIED | JDWP::CS_PREPARED | JDWP::CS_INITIALIZED;
1060    }
1061    *pTypeTag = c->IsInterface() ? JDWP::TT_INTERFACE : JDWP::TT_CLASS;
1062  }
1063
1064  if (pDescriptor != nullptr) {
1065    std::string temp;
1066    *pDescriptor = c->GetDescriptor(&temp);
1067  }
1068  return JDWP::ERR_NONE;
1069}
1070
1071void Dbg::FindLoadedClassBySignature(const char* descriptor, std::vector<JDWP::RefTypeId>* ids) {
1072  std::vector<mirror::Class*> classes;
1073  Runtime::Current()->GetClassLinker()->LookupClasses(descriptor, classes);
1074  ids->clear();
1075  for (size_t i = 0; i < classes.size(); ++i) {
1076    ids->push_back(gRegistry->Add(classes[i]));
1077  }
1078}
1079
1080JDWP::JdwpError Dbg::GetReferenceType(JDWP::ObjectId object_id, JDWP::ExpandBuf* pReply) {
1081  JDWP::JdwpError error;
1082  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1083  if (o == nullptr) {
1084    return JDWP::ERR_INVALID_OBJECT;
1085  }
1086
1087  JDWP::JdwpTypeTag type_tag = GetTypeTag(o->GetClass());
1088  JDWP::RefTypeId type_id = gRegistry->AddRefType(o->GetClass());
1089
1090  expandBufAdd1(pReply, type_tag);
1091  expandBufAddRefTypeId(pReply, type_id);
1092
1093  return JDWP::ERR_NONE;
1094}
1095
1096JDWP::JdwpError Dbg::GetSignature(JDWP::RefTypeId class_id, std::string* signature) {
1097  JDWP::JdwpError error;
1098  mirror::Class* c = DecodeClass(class_id, &error);
1099  if (c == nullptr) {
1100    return error;
1101  }
1102  std::string temp;
1103  *signature = c->GetDescriptor(&temp);
1104  return JDWP::ERR_NONE;
1105}
1106
1107JDWP::JdwpError Dbg::GetSourceFile(JDWP::RefTypeId class_id, std::string* result) {
1108  JDWP::JdwpError error;
1109  mirror::Class* c = DecodeClass(class_id, &error);
1110  if (c == nullptr) {
1111    return error;
1112  }
1113  const char* source_file = c->GetSourceFile();
1114  if (source_file == nullptr) {
1115    return JDWP::ERR_ABSENT_INFORMATION;
1116  }
1117  *result = source_file;
1118  return JDWP::ERR_NONE;
1119}
1120
1121JDWP::JdwpError Dbg::GetObjectTag(JDWP::ObjectId object_id, uint8_t* tag) {
1122  ScopedObjectAccessUnchecked soa(Thread::Current());
1123  JDWP::JdwpError error;
1124  mirror::Object* o = gRegistry->Get<mirror::Object*>(object_id, &error);
1125  if (error != JDWP::ERR_NONE) {
1126    *tag = JDWP::JT_VOID;
1127    return error;
1128  }
1129  *tag = TagFromObject(soa, o);
1130  return JDWP::ERR_NONE;
1131}
1132
1133size_t Dbg::GetTagWidth(JDWP::JdwpTag tag) {
1134  switch (tag) {
1135  case JDWP::JT_VOID:
1136    return 0;
1137  case JDWP::JT_BYTE:
1138  case JDWP::JT_BOOLEAN:
1139    return 1;
1140  case JDWP::JT_CHAR:
1141  case JDWP::JT_SHORT:
1142    return 2;
1143  case JDWP::JT_FLOAT:
1144  case JDWP::JT_INT:
1145    return 4;
1146  case JDWP::JT_ARRAY:
1147  case JDWP::JT_OBJECT:
1148  case JDWP::JT_STRING:
1149  case JDWP::JT_THREAD:
1150  case JDWP::JT_THREAD_GROUP:
1151  case JDWP::JT_CLASS_LOADER:
1152  case JDWP::JT_CLASS_OBJECT:
1153    return sizeof(JDWP::ObjectId);
1154  case JDWP::JT_DOUBLE:
1155  case JDWP::JT_LONG:
1156    return 8;
1157  default:
1158    LOG(FATAL) << "Unknown tag " << tag;
1159    return -1;
1160  }
1161}
1162
1163JDWP::JdwpError Dbg::GetArrayLength(JDWP::ObjectId array_id, int32_t* length) {
1164  JDWP::JdwpError error;
1165  mirror::Array* a = DecodeNonNullArray(array_id, &error);
1166  if (a == nullptr) {
1167    return error;
1168  }
1169  *length = a->GetLength();
1170  return JDWP::ERR_NONE;
1171}
1172
1173JDWP::JdwpError Dbg::OutputArray(JDWP::ObjectId array_id, int offset, int count, JDWP::ExpandBuf* pReply) {
1174  JDWP::JdwpError error;
1175  mirror::Array* a = DecodeNonNullArray(array_id, &error);
1176  if (a == nullptr) {
1177    return error;
1178  }
1179
1180  if (offset < 0 || count < 0 || offset > a->GetLength() || a->GetLength() - offset < count) {
1181    LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
1182    return JDWP::ERR_INVALID_LENGTH;
1183  }
1184  JDWP::JdwpTag element_tag = BasicTagFromClass(a->GetClass()->GetComponentType());
1185  expandBufAdd1(pReply, element_tag);
1186  expandBufAdd4BE(pReply, count);
1187
1188  if (IsPrimitiveTag(element_tag)) {
1189    size_t width = GetTagWidth(element_tag);
1190    uint8_t* dst = expandBufAddSpace(pReply, count * width);
1191    if (width == 8) {
1192      const uint64_t* src8 = reinterpret_cast<uint64_t*>(a->GetRawData(sizeof(uint64_t), 0));
1193      for (int i = 0; i < count; ++i) JDWP::Write8BE(&dst, src8[offset + i]);
1194    } else if (width == 4) {
1195      const uint32_t* src4 = reinterpret_cast<uint32_t*>(a->GetRawData(sizeof(uint32_t), 0));
1196      for (int i = 0; i < count; ++i) JDWP::Write4BE(&dst, src4[offset + i]);
1197    } else if (width == 2) {
1198      const uint16_t* src2 = reinterpret_cast<uint16_t*>(a->GetRawData(sizeof(uint16_t), 0));
1199      for (int i = 0; i < count; ++i) JDWP::Write2BE(&dst, src2[offset + i]);
1200    } else {
1201      const uint8_t* src = reinterpret_cast<uint8_t*>(a->GetRawData(sizeof(uint8_t), 0));
1202      memcpy(dst, &src[offset * width], count * width);
1203    }
1204  } else {
1205    ScopedObjectAccessUnchecked soa(Thread::Current());
1206    mirror::ObjectArray<mirror::Object>* oa = a->AsObjectArray<mirror::Object>();
1207    for (int i = 0; i < count; ++i) {
1208      mirror::Object* element = oa->Get(offset + i);
1209      JDWP::JdwpTag specific_tag = (element != nullptr) ? TagFromObject(soa, element)
1210                                                        : element_tag;
1211      expandBufAdd1(pReply, specific_tag);
1212      expandBufAddObjectId(pReply, gRegistry->Add(element));
1213    }
1214  }
1215
1216  return JDWP::ERR_NONE;
1217}
1218
1219template <typename T>
1220static void CopyArrayData(mirror::Array* a, JDWP::Request* src, int offset, int count)
1221    NO_THREAD_SAFETY_ANALYSIS {
1222  // TODO: fix when annotalysis correctly handles non-member functions.
1223  DCHECK(a->GetClass()->IsPrimitiveArray());
1224
1225  T* dst = reinterpret_cast<T*>(a->GetRawData(sizeof(T), offset));
1226  for (int i = 0; i < count; ++i) {
1227    *dst++ = src->ReadValue(sizeof(T));
1228  }
1229}
1230
1231JDWP::JdwpError Dbg::SetArrayElements(JDWP::ObjectId array_id, int offset, int count,
1232                                      JDWP::Request* request) {
1233  JDWP::JdwpError error;
1234  mirror::Array* dst = DecodeNonNullArray(array_id, &error);
1235  if (dst == nullptr) {
1236    return error;
1237  }
1238
1239  if (offset < 0 || count < 0 || offset > dst->GetLength() || dst->GetLength() - offset < count) {
1240    LOG(WARNING) << __FUNCTION__ << " access out of bounds: offset=" << offset << "; count=" << count;
1241    return JDWP::ERR_INVALID_LENGTH;
1242  }
1243  JDWP::JdwpTag element_tag = BasicTagFromClass(dst->GetClass()->GetComponentType());
1244
1245  if (IsPrimitiveTag(element_tag)) {
1246    size_t width = GetTagWidth(element_tag);
1247    if (width == 8) {
1248      CopyArrayData<uint64_t>(dst, request, offset, count);
1249    } else if (width == 4) {
1250      CopyArrayData<uint32_t>(dst, request, offset, count);
1251    } else if (width == 2) {
1252      CopyArrayData<uint16_t>(dst, request, offset, count);
1253    } else {
1254      CopyArrayData<uint8_t>(dst, request, offset, count);
1255    }
1256  } else {
1257    mirror::ObjectArray<mirror::Object>* oa = dst->AsObjectArray<mirror::Object>();
1258    for (int i = 0; i < count; ++i) {
1259      JDWP::ObjectId id = request->ReadObjectId();
1260      mirror::Object* o = gRegistry->Get<mirror::Object*>(id, &error);
1261      if (error != JDWP::ERR_NONE) {
1262        return error;
1263      }
1264      oa->Set<false>(offset + i, o);
1265    }
1266  }
1267
1268  return JDWP::ERR_NONE;
1269}
1270
1271JDWP::JdwpError Dbg::CreateString(const std::string& str, JDWP::ObjectId* new_string_id) {
1272  Thread* self = Thread::Current();
1273  mirror::String* new_string = mirror::String::AllocFromModifiedUtf8(self, str.c_str());
1274  if (new_string == nullptr) {
1275    DCHECK(self->IsExceptionPending());
1276    self->ClearException();
1277    LOG(ERROR) << "Could not allocate string";
1278    *new_string_id = 0;
1279    return JDWP::ERR_OUT_OF_MEMORY;
1280  }
1281  *new_string_id = gRegistry->Add(new_string);
1282  return JDWP::ERR_NONE;
1283}
1284
1285JDWP::JdwpError Dbg::CreateObject(JDWP::RefTypeId class_id, JDWP::ObjectId* new_object_id) {
1286  JDWP::JdwpError error;
1287  mirror::Class* c = DecodeClass(class_id, &error);
1288  if (c == nullptr) {
1289    *new_object_id = 0;
1290    return error;
1291  }
1292  Thread* self = Thread::Current();
1293  mirror::Object* new_object = c->AllocObject(self);
1294  if (new_object == nullptr) {
1295    DCHECK(self->IsExceptionPending());
1296    self->ClearException();
1297    LOG(ERROR) << "Could not allocate object of type " << PrettyDescriptor(c);
1298    *new_object_id = 0;
1299    return JDWP::ERR_OUT_OF_MEMORY;
1300  }
1301  *new_object_id = gRegistry->Add(new_object);
1302  return JDWP::ERR_NONE;
1303}
1304
1305/*
1306 * Used by Eclipse's "Display" view to evaluate "new byte[5]" to get "(byte[]) [0, 0, 0, 0, 0]".
1307 */
1308JDWP::JdwpError Dbg::CreateArrayObject(JDWP::RefTypeId array_class_id, uint32_t length,
1309                                       JDWP::ObjectId* new_array_id) {
1310  JDWP::JdwpError error;
1311  mirror::Class* c = DecodeClass(array_class_id, &error);
1312  if (c == nullptr) {
1313    *new_array_id = 0;
1314    return error;
1315  }
1316  Thread* self = Thread::Current();
1317  gc::Heap* heap = Runtime::Current()->GetHeap();
1318  mirror::Array* new_array = mirror::Array::Alloc<true>(self, c, length,
1319                                                        c->GetComponentSizeShift(),
1320                                                        heap->GetCurrentAllocator());
1321  if (new_array == nullptr) {
1322    DCHECK(self->IsExceptionPending());
1323    self->ClearException();
1324    LOG(ERROR) << "Could not allocate array of type " << PrettyDescriptor(c);
1325    *new_array_id = 0;
1326    return JDWP::ERR_OUT_OF_MEMORY;
1327  }
1328  *new_array_id = gRegistry->Add(new_array);
1329  return JDWP::ERR_NONE;
1330}
1331
1332JDWP::FieldId Dbg::ToFieldId(const ArtField* f) {
1333  return static_cast<JDWP::FieldId>(reinterpret_cast<uintptr_t>(f));
1334}
1335
1336static JDWP::MethodId ToMethodId(const mirror::ArtMethod* m)
1337    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1338  CHECK(!kMovingMethods);
1339  return static_cast<JDWP::MethodId>(reinterpret_cast<uintptr_t>(m));
1340}
1341
1342static ArtField* FromFieldId(JDWP::FieldId fid)
1343    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1344  return reinterpret_cast<ArtField*>(static_cast<uintptr_t>(fid));
1345}
1346
1347static mirror::ArtMethod* FromMethodId(JDWP::MethodId mid)
1348    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1349  CHECK(!kMovingMethods);
1350  return reinterpret_cast<mirror::ArtMethod*>(static_cast<uintptr_t>(mid));
1351}
1352
1353bool 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*>(expected_thread_id,
1357                                                                         &error);
1358  return expected_thread_peer == event_thread->GetPeer();
1359}
1360
1361bool Dbg::MatchLocation(const JDWP::JdwpLocation& expected_location,
1362                        const JDWP::EventLocation& event_location) {
1363  if (expected_location.dex_pc != event_location.dex_pc) {
1364    return false;
1365  }
1366  mirror::ArtMethod* m = FromMethodId(expected_location.method_id);
1367  return m == event_location.method;
1368}
1369
1370bool Dbg::MatchType(mirror::Class* event_class, JDWP::RefTypeId class_id) {
1371  if (event_class == nullptr) {
1372    return false;
1373  }
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);
1378}
1379
1380bool 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) {
1384    return false;
1385  }
1386  return Dbg::MatchType(event_field->GetDeclaringClass(), expected_type_id);
1387}
1388
1389bool 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;
1393}
1394
1395void Dbg::SetJdwpLocation(JDWP::JdwpLocation* location, mirror::ArtMethod* m, uint32_t dex_pc)
1396    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
1397    LOCKS_EXCLUDED(Locks::thread_list_lock_,
1398                   Locks::thread_suspend_count_lock_) {
1399  if (m == nullptr) {
1400    memset(location, 0, sizeof(*location));
1401  } else {
1402    mirror::Class* c = m->GetDeclaringClass();
1403    location->type_tag = GetTypeTag(c);
1404    location->class_id = gRegistry->AddRefType(c);
1405    location->method_id = ToMethodId(m);
1406    location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint64_t>(-1) : dex_pc;
1407  }
1408}
1409
1410std::string Dbg::GetMethodName(JDWP::MethodId method_id) {
1411  mirror::ArtMethod* m = FromMethodId(method_id);
1412  if (m == nullptr) {
1413    return "null";
1414  }
1415  return m->GetName();
1416}
1417
1418std::string Dbg::GetFieldName(JDWP::FieldId field_id) {
1419  ArtField* f = FromFieldId(field_id);
1420  if (f == nullptr) {
1421    return "null";
1422  }
1423  return f->GetName();
1424}
1425
1426/*
1427 * Augment the access flags for synthetic methods and fields by setting
1428 * the (as described by the spec) "0xf0000000 bit".  Also, strip out any
1429 * flags not specified by the Java programming language.
1430 */
1431static uint32_t MangleAccessFlags(uint32_t accessFlags) {
1432  accessFlags &= kAccJavaFlagsMask;
1433  if ((accessFlags & kAccSynthetic) != 0) {
1434    accessFlags |= 0xf0000000;
1435  }
1436  return accessFlags;
1437}
1438
1439/*
1440 * Circularly shifts registers so that arguments come first. Debuggers
1441 * expect slots to begin with arguments, but dex code places them at
1442 * the end.
1443 */
1444static uint16_t MangleSlot(uint16_t slot, mirror::ArtMethod* m)
1445    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1446  const DexFile::CodeItem* code_item = m->GetCodeItem();
1447  if (code_item == nullptr) {
1448    // We should not get here for a method without code (native, proxy or abstract). Log it and
1449    // return the slot as is since all registers are arguments.
1450    LOG(WARNING) << "Trying to mangle slot for method without code " << PrettyMethod(m);
1451    return slot;
1452  }
1453  uint16_t ins_size = code_item->ins_size_;
1454  uint16_t locals_size = code_item->registers_size_ - ins_size;
1455  if (slot >= locals_size) {
1456    return slot - locals_size;
1457  } else {
1458    return slot + ins_size;
1459  }
1460}
1461
1462/*
1463 * Circularly shifts registers so that arguments come last. Reverts
1464 * slots to dex style argument placement.
1465 */
1466static uint16_t DemangleSlot(uint16_t slot, mirror::ArtMethod* m, JDWP::JdwpError* error)
1467    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1468  const DexFile::CodeItem* code_item = m->GetCodeItem();
1469  if (code_item == nullptr) {
1470    // We should not get here for a method without code (native, proxy or abstract). Log it and
1471    // return the slot as is since all registers are arguments.
1472    LOG(WARNING) << "Trying to demangle slot for method without code " << PrettyMethod(m);
1473    uint16_t vreg_count = mirror::ArtMethod::NumArgRegisters(m->GetShorty());
1474    if (slot < vreg_count) {
1475      *error = JDWP::ERR_NONE;
1476      return slot;
1477    }
1478  } else {
1479    if (slot < code_item->registers_size_) {
1480      uint16_t ins_size = code_item->ins_size_;
1481      uint16_t locals_size = code_item->registers_size_ - ins_size;
1482      *error = JDWP::ERR_NONE;
1483      return (slot < ins_size) ? slot + locals_size : slot - ins_size;
1484    }
1485  }
1486
1487  // Slot is invalid in the method.
1488  LOG(ERROR) << "Invalid local slot " << slot << " for method " << PrettyMethod(m);
1489  *error = JDWP::ERR_INVALID_SLOT;
1490  return DexFile::kDexNoIndex16;
1491}
1492
1493JDWP::JdwpError Dbg::OutputDeclaredFields(JDWP::RefTypeId class_id, bool with_generic, JDWP::ExpandBuf* pReply) {
1494  JDWP::JdwpError error;
1495  mirror::Class* c = DecodeClass(class_id, &error);
1496  if (c == nullptr) {
1497    return error;
1498  }
1499
1500  size_t instance_field_count = c->NumInstanceFields();
1501  size_t static_field_count = c->NumStaticFields();
1502
1503  expandBufAdd4BE(pReply, instance_field_count + static_field_count);
1504
1505  for (size_t i = 0; i < instance_field_count + static_field_count; ++i) {
1506    ArtField* f = (i < instance_field_count) ? c->GetInstanceField(i) : c->GetStaticField(i - instance_field_count);
1507    expandBufAddFieldId(pReply, ToFieldId(f));
1508    expandBufAddUtf8String(pReply, f->GetName());
1509    expandBufAddUtf8String(pReply, f->GetTypeDescriptor());
1510    if (with_generic) {
1511      static const char genericSignature[1] = "";
1512      expandBufAddUtf8String(pReply, genericSignature);
1513    }
1514    expandBufAdd4BE(pReply, MangleAccessFlags(f->GetAccessFlags()));
1515  }
1516  return JDWP::ERR_NONE;
1517}
1518
1519JDWP::JdwpError Dbg::OutputDeclaredMethods(JDWP::RefTypeId class_id, bool with_generic,
1520                                           JDWP::ExpandBuf* pReply) {
1521  JDWP::JdwpError error;
1522  mirror::Class* c = DecodeClass(class_id, &error);
1523  if (c == nullptr) {
1524    return error;
1525  }
1526
1527  size_t direct_method_count = c->NumDirectMethods();
1528  size_t virtual_method_count = c->NumVirtualMethods();
1529
1530  expandBufAdd4BE(pReply, direct_method_count + virtual_method_count);
1531
1532  for (size_t i = 0; i < direct_method_count + virtual_method_count; ++i) {
1533    mirror::ArtMethod* m = (i < direct_method_count) ? c->GetDirectMethod(i) : c->GetVirtualMethod(i - direct_method_count);
1534    expandBufAddMethodId(pReply, ToMethodId(m));
1535    expandBufAddUtf8String(pReply, m->GetName());
1536    expandBufAddUtf8String(pReply, m->GetSignature().ToString());
1537    if (with_generic) {
1538      static const char genericSignature[1] = "";
1539      expandBufAddUtf8String(pReply, genericSignature);
1540    }
1541    expandBufAdd4BE(pReply, MangleAccessFlags(m->GetAccessFlags()));
1542  }
1543  return JDWP::ERR_NONE;
1544}
1545
1546JDWP::JdwpError Dbg::OutputDeclaredInterfaces(JDWP::RefTypeId class_id, JDWP::ExpandBuf* pReply) {
1547  JDWP::JdwpError error;
1548  Thread* self = Thread::Current();
1549  StackHandleScope<1> hs(self);
1550  Handle<mirror::Class> c(hs.NewHandle(DecodeClass(class_id, &error)));
1551  if (c.Get() == nullptr) {
1552    return error;
1553  }
1554  size_t interface_count = c->NumDirectInterfaces();
1555  expandBufAdd4BE(pReply, interface_count);
1556  for (size_t i = 0; i < interface_count; ++i) {
1557    expandBufAddRefTypeId(pReply,
1558                          gRegistry->AddRefType(mirror::Class::GetDirectInterface(self, c, i)));
1559  }
1560  return JDWP::ERR_NONE;
1561}
1562
1563void Dbg::OutputLineTable(JDWP::RefTypeId, JDWP::MethodId method_id, JDWP::ExpandBuf* pReply) {
1564  struct DebugCallbackContext {
1565    int numItems;
1566    JDWP::ExpandBuf* pReply;
1567
1568    static bool Callback(void* context, uint32_t address, uint32_t line_number) {
1569      DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1570      expandBufAdd8BE(pContext->pReply, address);
1571      expandBufAdd4BE(pContext->pReply, line_number);
1572      pContext->numItems++;
1573      return false;
1574    }
1575  };
1576  mirror::ArtMethod* m = FromMethodId(method_id);
1577  const DexFile::CodeItem* code_item = m->GetCodeItem();
1578  uint64_t start, end;
1579  if (code_item == nullptr) {
1580    DCHECK(m->IsNative() || m->IsProxyMethod());
1581    start = -1;
1582    end = -1;
1583  } else {
1584    start = 0;
1585    // Return the index of the last instruction
1586    end = code_item->insns_size_in_code_units_ - 1;
1587  }
1588
1589  expandBufAdd8BE(pReply, start);
1590  expandBufAdd8BE(pReply, end);
1591
1592  // Add numLines later
1593  size_t numLinesOffset = expandBufGetLength(pReply);
1594  expandBufAdd4BE(pReply, 0);
1595
1596  DebugCallbackContext context;
1597  context.numItems = 0;
1598  context.pReply = pReply;
1599
1600  if (code_item != nullptr) {
1601    m->GetDexFile()->DecodeDebugInfo(code_item, m->IsStatic(), m->GetDexMethodIndex(),
1602                                     DebugCallbackContext::Callback, nullptr, &context);
1603  }
1604
1605  JDWP::Set4BE(expandBufGetBuffer(pReply) + numLinesOffset, context.numItems);
1606}
1607
1608void Dbg::OutputVariableTable(JDWP::RefTypeId, JDWP::MethodId method_id, bool with_generic,
1609                              JDWP::ExpandBuf* pReply) {
1610  struct DebugCallbackContext {
1611    mirror::ArtMethod* method;
1612    JDWP::ExpandBuf* pReply;
1613    size_t variable_count;
1614    bool with_generic;
1615
1616    static void Callback(void* context, uint16_t slot, uint32_t startAddress, uint32_t endAddress,
1617                         const char* name, const char* descriptor, const char* signature)
1618        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1619      DebugCallbackContext* pContext = reinterpret_cast<DebugCallbackContext*>(context);
1620
1621      VLOG(jdwp) << StringPrintf("    %2zd: %d(%d) '%s' '%s' '%s' actual slot=%d mangled slot=%d",
1622                                 pContext->variable_count, startAddress, endAddress - startAddress,
1623                                 name, descriptor, signature, slot,
1624                                 MangleSlot(slot, pContext->method));
1625
1626      slot = MangleSlot(slot, pContext->method);
1627
1628      expandBufAdd8BE(pContext->pReply, startAddress);
1629      expandBufAddUtf8String(pContext->pReply, name);
1630      expandBufAddUtf8String(pContext->pReply, descriptor);
1631      if (pContext->with_generic) {
1632        expandBufAddUtf8String(pContext->pReply, signature);
1633      }
1634      expandBufAdd4BE(pContext->pReply, endAddress - startAddress);
1635      expandBufAdd4BE(pContext->pReply, slot);
1636
1637      ++pContext->variable_count;
1638    }
1639  };
1640  mirror::ArtMethod* m = FromMethodId(method_id);
1641
1642  // arg_count considers doubles and longs to take 2 units.
1643  // variable_count considers everything to take 1 unit.
1644  std::string shorty(m->GetShorty());
1645  expandBufAdd4BE(pReply, mirror::ArtMethod::NumArgRegisters(shorty));
1646
1647  // We don't know the total number of variables yet, so leave a blank and update it later.
1648  size_t variable_count_offset = expandBufGetLength(pReply);
1649  expandBufAdd4BE(pReply, 0);
1650
1651  DebugCallbackContext context;
1652  context.method = m;
1653  context.pReply = pReply;
1654  context.variable_count = 0;
1655  context.with_generic = with_generic;
1656
1657  const DexFile::CodeItem* code_item = m->GetCodeItem();
1658  if (code_item != nullptr) {
1659    m->GetDexFile()->DecodeDebugInfo(
1660        code_item, m->IsStatic(), m->GetDexMethodIndex(), nullptr, DebugCallbackContext::Callback,
1661        &context);
1662  }
1663
1664  JDWP::Set4BE(expandBufGetBuffer(pReply) + variable_count_offset, context.variable_count);
1665}
1666
1667void Dbg::OutputMethodReturnValue(JDWP::MethodId method_id, const JValue* return_value,
1668                                  JDWP::ExpandBuf* pReply) {
1669  mirror::ArtMethod* m = FromMethodId(method_id);
1670  JDWP::JdwpTag tag = BasicTagFromDescriptor(m->GetShorty());
1671  OutputJValue(tag, return_value, pReply);
1672}
1673
1674void Dbg::OutputFieldValue(JDWP::FieldId field_id, const JValue* field_value,
1675                           JDWP::ExpandBuf* pReply) {
1676  ArtField* f = FromFieldId(field_id);
1677  JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
1678  OutputJValue(tag, field_value, pReply);
1679}
1680
1681JDWP::JdwpError Dbg::GetBytecodes(JDWP::RefTypeId, JDWP::MethodId method_id,
1682                                  std::vector<uint8_t>* bytecodes) {
1683  mirror::ArtMethod* m = FromMethodId(method_id);
1684  if (m == nullptr) {
1685    return JDWP::ERR_INVALID_METHODID;
1686  }
1687  const DexFile::CodeItem* code_item = m->GetCodeItem();
1688  size_t byte_count = code_item->insns_size_in_code_units_ * 2;
1689  const uint8_t* begin = reinterpret_cast<const uint8_t*>(code_item->insns_);
1690  const uint8_t* end = begin + byte_count;
1691  for (const uint8_t* p = begin; p != end; ++p) {
1692    bytecodes->push_back(*p);
1693  }
1694  return JDWP::ERR_NONE;
1695}
1696
1697JDWP::JdwpTag Dbg::GetFieldBasicTag(JDWP::FieldId field_id) {
1698  return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
1699}
1700
1701JDWP::JdwpTag Dbg::GetStaticFieldBasicTag(JDWP::FieldId field_id) {
1702  return BasicTagFromDescriptor(FromFieldId(field_id)->GetTypeDescriptor());
1703}
1704
1705static JDWP::JdwpError GetFieldValueImpl(JDWP::RefTypeId ref_type_id, JDWP::ObjectId object_id,
1706                                         JDWP::FieldId field_id, JDWP::ExpandBuf* pReply,
1707                                         bool is_static)
1708    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1709  JDWP::JdwpError error;
1710  mirror::Class* c = DecodeClass(ref_type_id, &error);
1711  if (ref_type_id != 0 && c == nullptr) {
1712    return error;
1713  }
1714
1715  mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
1716  if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
1717    return JDWP::ERR_INVALID_OBJECT;
1718  }
1719  ArtField* f = FromFieldId(field_id);
1720
1721  mirror::Class* receiver_class = c;
1722  if (receiver_class == nullptr && o != nullptr) {
1723    receiver_class = o->GetClass();
1724  }
1725  // TODO: should we give up now if receiver_class is null?
1726  if (receiver_class != nullptr && !f->GetDeclaringClass()->IsAssignableFrom(receiver_class)) {
1727    LOG(INFO) << "ERR_INVALID_FIELDID: " << PrettyField(f) << " " << PrettyClass(receiver_class);
1728    return JDWP::ERR_INVALID_FIELDID;
1729  }
1730
1731  // The RI only enforces the static/non-static mismatch in one direction.
1732  // TODO: should we change the tests and check both?
1733  if (is_static) {
1734    if (!f->IsStatic()) {
1735      return JDWP::ERR_INVALID_FIELDID;
1736    }
1737  } else {
1738    if (f->IsStatic()) {
1739      LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues on static field "
1740          << PrettyField(f);
1741    }
1742  }
1743  if (f->IsStatic()) {
1744    o = f->GetDeclaringClass();
1745  }
1746
1747  JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
1748  JValue field_value;
1749  if (tag == JDWP::JT_VOID) {
1750    LOG(FATAL) << "Unknown tag: " << tag;
1751  } else if (!IsPrimitiveTag(tag)) {
1752    field_value.SetL(f->GetObject(o));
1753  } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1754    field_value.SetJ(f->Get64(o));
1755  } else {
1756    field_value.SetI(f->Get32(o));
1757  }
1758  Dbg::OutputJValue(tag, &field_value, pReply);
1759
1760  return JDWP::ERR_NONE;
1761}
1762
1763JDWP::JdwpError Dbg::GetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id,
1764                                   JDWP::ExpandBuf* pReply) {
1765  return GetFieldValueImpl(0, object_id, field_id, pReply, false);
1766}
1767
1768JDWP::JdwpError Dbg::GetStaticFieldValue(JDWP::RefTypeId ref_type_id, JDWP::FieldId field_id,
1769                                         JDWP::ExpandBuf* pReply) {
1770  return GetFieldValueImpl(ref_type_id, 0, field_id, pReply, true);
1771}
1772
1773static JDWP::JdwpError SetFieldValueImpl(JDWP::ObjectId object_id, JDWP::FieldId field_id,
1774                                         uint64_t value, int width, bool is_static)
1775    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1776  JDWP::JdwpError error;
1777  mirror::Object* o = Dbg::GetObjectRegistry()->Get<mirror::Object*>(object_id, &error);
1778  if ((!is_static && o == nullptr) || error != JDWP::ERR_NONE) {
1779    return JDWP::ERR_INVALID_OBJECT;
1780  }
1781  ArtField* f = FromFieldId(field_id);
1782
1783  // The RI only enforces the static/non-static mismatch in one direction.
1784  // TODO: should we change the tests and check both?
1785  if (is_static) {
1786    if (!f->IsStatic()) {
1787      return JDWP::ERR_INVALID_FIELDID;
1788    }
1789  } else {
1790    if (f->IsStatic()) {
1791      LOG(WARNING) << "Ignoring non-nullptr receiver for ObjectReference.SetValues on static field " << PrettyField(f);
1792    }
1793  }
1794  if (f->IsStatic()) {
1795    o = f->GetDeclaringClass();
1796  }
1797
1798  JDWP::JdwpTag tag = BasicTagFromDescriptor(f->GetTypeDescriptor());
1799
1800  if (IsPrimitiveTag(tag)) {
1801    if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1802      CHECK_EQ(width, 8);
1803      // Debugging can't use transactional mode (runtime only).
1804      f->Set64<false>(o, value);
1805    } else {
1806      CHECK_LE(width, 4);
1807      // Debugging can't use transactional mode (runtime only).
1808      f->Set32<false>(o, value);
1809    }
1810  } else {
1811    mirror::Object* v = Dbg::GetObjectRegistry()->Get<mirror::Object*>(value, &error);
1812    if (error != JDWP::ERR_NONE) {
1813      return JDWP::ERR_INVALID_OBJECT;
1814    }
1815    if (v != nullptr) {
1816      mirror::Class* field_type;
1817      {
1818        StackHandleScope<2> hs(Thread::Current());
1819        HandleWrapper<mirror::Object> h_v(hs.NewHandleWrapper(&v));
1820        HandleWrapper<mirror::Object> h_o(hs.NewHandleWrapper(&o));
1821        field_type = f->GetType<true>();
1822      }
1823      if (!field_type->IsAssignableFrom(v->GetClass())) {
1824        return JDWP::ERR_INVALID_OBJECT;
1825      }
1826    }
1827    // Debugging can't use transactional mode (runtime only).
1828    f->SetObject<false>(o, v);
1829  }
1830
1831  return JDWP::ERR_NONE;
1832}
1833
1834JDWP::JdwpError Dbg::SetFieldValue(JDWP::ObjectId object_id, JDWP::FieldId field_id, uint64_t value,
1835                                   int width) {
1836  return SetFieldValueImpl(object_id, field_id, value, width, false);
1837}
1838
1839JDWP::JdwpError Dbg::SetStaticFieldValue(JDWP::FieldId field_id, uint64_t value, int width) {
1840  return SetFieldValueImpl(0, field_id, value, width, true);
1841}
1842
1843JDWP::JdwpError Dbg::StringToUtf8(JDWP::ObjectId string_id, std::string* str) {
1844  JDWP::JdwpError error;
1845  mirror::Object* obj = gRegistry->Get<mirror::Object*>(string_id, &error);
1846  if (error != JDWP::ERR_NONE) {
1847    return error;
1848  }
1849  if (obj == nullptr) {
1850    return JDWP::ERR_INVALID_OBJECT;
1851  }
1852  {
1853    ScopedObjectAccessUnchecked soa(Thread::Current());
1854    mirror::Class* java_lang_String = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_String);
1855    if (!java_lang_String->IsAssignableFrom(obj->GetClass())) {
1856      // This isn't a string.
1857      return JDWP::ERR_INVALID_STRING;
1858    }
1859  }
1860  *str = obj->AsString()->ToModifiedUtf8();
1861  return JDWP::ERR_NONE;
1862}
1863
1864void Dbg::OutputJValue(JDWP::JdwpTag tag, const JValue* return_value, JDWP::ExpandBuf* pReply) {
1865  if (IsPrimitiveTag(tag)) {
1866    expandBufAdd1(pReply, tag);
1867    if (tag == JDWP::JT_BOOLEAN || tag == JDWP::JT_BYTE) {
1868      expandBufAdd1(pReply, return_value->GetI());
1869    } else if (tag == JDWP::JT_CHAR || tag == JDWP::JT_SHORT) {
1870      expandBufAdd2BE(pReply, return_value->GetI());
1871    } else if (tag == JDWP::JT_FLOAT || tag == JDWP::JT_INT) {
1872      expandBufAdd4BE(pReply, return_value->GetI());
1873    } else if (tag == JDWP::JT_DOUBLE || tag == JDWP::JT_LONG) {
1874      expandBufAdd8BE(pReply, return_value->GetJ());
1875    } else {
1876      CHECK_EQ(tag, JDWP::JT_VOID);
1877    }
1878  } else {
1879    ScopedObjectAccessUnchecked soa(Thread::Current());
1880    mirror::Object* value = return_value->GetL();
1881    expandBufAdd1(pReply, TagFromObject(soa, value));
1882    expandBufAddObjectId(pReply, gRegistry->Add(value));
1883  }
1884}
1885
1886JDWP::JdwpError Dbg::GetThreadName(JDWP::ObjectId thread_id, std::string* name) {
1887  ScopedObjectAccessUnchecked soa(Thread::Current());
1888  JDWP::JdwpError error;
1889  Thread* thread = DecodeThread(soa, thread_id, &error);
1890  UNUSED(thread);
1891  if (error != JDWP::ERR_NONE && error != JDWP::ERR_THREAD_NOT_ALIVE) {
1892    return error;
1893  }
1894
1895  // We still need to report the zombie threads' names, so we can't just call Thread::GetThreadName.
1896  mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1897  CHECK(thread_object != nullptr) << error;
1898  ArtField* java_lang_Thread_name_field =
1899      soa.DecodeField(WellKnownClasses::java_lang_Thread_name);
1900  mirror::String* s =
1901      reinterpret_cast<mirror::String*>(java_lang_Thread_name_field->GetObject(thread_object));
1902  if (s != nullptr) {
1903    *name = s->ToModifiedUtf8();
1904  }
1905  return JDWP::ERR_NONE;
1906}
1907
1908JDWP::JdwpError Dbg::GetThreadGroup(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
1909  ScopedObjectAccessUnchecked soa(Thread::Current());
1910  JDWP::JdwpError error;
1911  mirror::Object* thread_object = gRegistry->Get<mirror::Object*>(thread_id, &error);
1912  if (error != JDWP::ERR_NONE) {
1913    return JDWP::ERR_INVALID_OBJECT;
1914  }
1915  ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroup");
1916  // Okay, so it's an object, but is it actually a thread?
1917  Thread* thread = DecodeThread(soa, thread_id, &error);
1918  UNUSED(thread);
1919  if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
1920    // Zombie threads are in the null group.
1921    expandBufAddObjectId(pReply, JDWP::ObjectId(0));
1922    error = JDWP::ERR_NONE;
1923  } else if (error == JDWP::ERR_NONE) {
1924    mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_Thread);
1925    CHECK(c != nullptr);
1926    ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
1927    CHECK(f != nullptr);
1928    mirror::Object* group = f->GetObject(thread_object);
1929    CHECK(group != nullptr);
1930    JDWP::ObjectId thread_group_id = gRegistry->Add(group);
1931    expandBufAddObjectId(pReply, thread_group_id);
1932  }
1933  return error;
1934}
1935
1936static mirror::Object* DecodeThreadGroup(ScopedObjectAccessUnchecked& soa,
1937                                         JDWP::ObjectId thread_group_id, JDWP::JdwpError* error)
1938    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1939  mirror::Object* thread_group = Dbg::GetObjectRegistry()->Get<mirror::Object*>(thread_group_id,
1940                                                                                error);
1941  if (*error != JDWP::ERR_NONE) {
1942    return nullptr;
1943  }
1944  if (thread_group == nullptr) {
1945    *error = JDWP::ERR_INVALID_OBJECT;
1946    return nullptr;
1947  }
1948  mirror::Class* c = soa.Decode<mirror::Class*>(WellKnownClasses::java_lang_ThreadGroup);
1949  CHECK(c != nullptr);
1950  if (!c->IsAssignableFrom(thread_group->GetClass())) {
1951    // This is not a java.lang.ThreadGroup.
1952    *error = JDWP::ERR_INVALID_THREAD_GROUP;
1953    return nullptr;
1954  }
1955  *error = JDWP::ERR_NONE;
1956  return thread_group;
1957}
1958
1959JDWP::JdwpError Dbg::GetThreadGroupName(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
1960  ScopedObjectAccessUnchecked soa(Thread::Current());
1961  JDWP::JdwpError error;
1962  mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
1963  if (error != JDWP::ERR_NONE) {
1964    return error;
1965  }
1966  ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupName");
1967  ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_name);
1968  CHECK(f != nullptr);
1969  mirror::String* s = reinterpret_cast<mirror::String*>(f->GetObject(thread_group));
1970
1971  std::string thread_group_name(s->ToModifiedUtf8());
1972  expandBufAddUtf8String(pReply, thread_group_name);
1973  return JDWP::ERR_NONE;
1974}
1975
1976JDWP::JdwpError Dbg::GetThreadGroupParent(JDWP::ObjectId thread_group_id, JDWP::ExpandBuf* pReply) {
1977  ScopedObjectAccessUnchecked soa(Thread::Current());
1978  JDWP::JdwpError error;
1979  mirror::Object* thread_group = DecodeThreadGroup(soa, thread_group_id, &error);
1980  if (error != JDWP::ERR_NONE) {
1981    return error;
1982  }
1983  mirror::Object* parent;
1984  {
1985    ScopedAssertNoThreadSuspension ants(soa.Self(), "Debugger: GetThreadGroupParent");
1986    ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_parent);
1987    CHECK(f != nullptr);
1988    parent = f->GetObject(thread_group);
1989  }
1990  JDWP::ObjectId parent_group_id = gRegistry->Add(parent);
1991  expandBufAddObjectId(pReply, parent_group_id);
1992  return JDWP::ERR_NONE;
1993}
1994
1995static void GetChildThreadGroups(ScopedObjectAccessUnchecked& soa, mirror::Object* thread_group,
1996                                 std::vector<JDWP::ObjectId>* child_thread_group_ids)
1997    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1998  CHECK(thread_group != nullptr);
1999
2000  // Get the ArrayList<ThreadGroup> "groups" out of this thread group...
2001  ArtField* groups_field = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_groups);
2002  mirror::Object* groups_array_list = groups_field->GetObject(thread_group);
2003  {
2004    // The "groups" field is declared as a java.util.List: check it really is
2005    // an instance of java.util.ArrayList.
2006    CHECK(groups_array_list != nullptr);
2007    mirror::Class* java_util_ArrayList_class =
2008        soa.Decode<mirror::Class*>(WellKnownClasses::java_util_ArrayList);
2009    CHECK(groups_array_list->InstanceOf(java_util_ArrayList_class));
2010  }
2011
2012  // Get the array and size out of the ArrayList<ThreadGroup>...
2013  ArtField* array_field = soa.DecodeField(WellKnownClasses::java_util_ArrayList_array);
2014  ArtField* size_field = soa.DecodeField(WellKnownClasses::java_util_ArrayList_size);
2015  mirror::ObjectArray<mirror::Object>* groups_array =
2016      array_field->GetObject(groups_array_list)->AsObjectArray<mirror::Object>();
2017  const int32_t size = size_field->GetInt(groups_array_list);
2018
2019  // Copy the first 'size' elements out of the array into the result.
2020  ObjectRegistry* registry = Dbg::GetObjectRegistry();
2021  for (int32_t i = 0; i < size; ++i) {
2022    child_thread_group_ids->push_back(registry->Add(groups_array->Get(i)));
2023  }
2024}
2025
2026JDWP::JdwpError Dbg::GetThreadGroupChildren(JDWP::ObjectId thread_group_id,
2027                                            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) {
2032    return error;
2033  }
2034
2035  // Add child threads.
2036  {
2037    std::vector<JDWP::ObjectId> child_thread_ids;
2038    GetThreads(thread_group, &child_thread_ids);
2039    expandBufAdd4BE(pReply, child_thread_ids.size());
2040    for (JDWP::ObjectId child_thread_id : child_thread_ids) {
2041      expandBufAddObjectId(pReply, child_thread_id);
2042    }
2043  }
2044
2045  // Add child thread groups.
2046  {
2047    std::vector<JDWP::ObjectId> child_thread_groups_ids;
2048    GetChildThreadGroups(soa, thread_group, &child_thread_groups_ids);
2049    expandBufAdd4BE(pReply, child_thread_groups_ids.size());
2050    for (JDWP::ObjectId child_thread_group_id : child_thread_groups_ids) {
2051      expandBufAddObjectId(pReply, child_thread_group_id);
2052    }
2053  }
2054
2055  return JDWP::ERR_NONE;
2056}
2057
2058JDWP::ObjectId Dbg::GetSystemThreadGroupId() {
2059  ScopedObjectAccessUnchecked soa(Thread::Current());
2060  ArtField* f = soa.DecodeField(WellKnownClasses::java_lang_ThreadGroup_systemThreadGroup);
2061  mirror::Object* group = f->GetObject(f->GetDeclaringClass());
2062  return gRegistry->Add(group);
2063}
2064
2065JDWP::JdwpThreadStatus Dbg::ToJdwpThreadStatus(ThreadState state) {
2066  switch (state) {
2067    case kBlocked:
2068      return JDWP::TS_MONITOR;
2069    case kNative:
2070    case kRunnable:
2071    case kSuspended:
2072      return JDWP::TS_RUNNING;
2073    case kSleeping:
2074      return JDWP::TS_SLEEPING;
2075    case kStarting:
2076    case kTerminated:
2077      return JDWP::TS_ZOMBIE;
2078    case kTimedWaiting:
2079    case kWaitingForCheckPointsToRun:
2080    case kWaitingForDebuggerSend:
2081    case kWaitingForDebuggerSuspension:
2082    case kWaitingForDebuggerToAttach:
2083    case kWaitingForDeoptimization:
2084    case kWaitingForGcToComplete:
2085    case kWaitingForJniOnLoad:
2086    case kWaitingForMethodTracingStart:
2087    case kWaitingForSignalCatcherOutput:
2088    case kWaitingForVisitObjects:
2089    case kWaitingInMainDebuggerLoop:
2090    case kWaitingInMainSignalCatcherLoop:
2091    case kWaitingPerformingGc:
2092    case kWaiting:
2093      return JDWP::TS_WAIT;
2094      // Don't add a 'default' here so the compiler can spot incompatible enum changes.
2095  }
2096  LOG(FATAL) << "Unknown thread state: " << state;
2097  return JDWP::TS_ZOMBIE;
2098}
2099
2100JDWP::JdwpError Dbg::GetThreadStatus(JDWP::ObjectId thread_id, JDWP::JdwpThreadStatus* pThreadStatus,
2101                                     JDWP::JdwpSuspendStatus* pSuspendStatus) {
2102  ScopedObjectAccess soa(Thread::Current());
2103
2104  *pSuspendStatus = JDWP::SUSPEND_STATUS_NOT_SUSPENDED;
2105
2106  JDWP::JdwpError error;
2107  Thread* thread = DecodeThread(soa, thread_id, &error);
2108  if (error != JDWP::ERR_NONE) {
2109    if (error == JDWP::ERR_THREAD_NOT_ALIVE) {
2110      *pThreadStatus = JDWP::TS_ZOMBIE;
2111      return JDWP::ERR_NONE;
2112    }
2113    return error;
2114  }
2115
2116  if (IsSuspendedForDebugger(soa, thread)) {
2117    *pSuspendStatus = JDWP::SUSPEND_STATUS_SUSPENDED;
2118  }
2119
2120  *pThreadStatus = ToJdwpThreadStatus(thread->GetState());
2121  return JDWP::ERR_NONE;
2122}
2123
2124JDWP::JdwpError Dbg::GetThreadDebugSuspendCount(JDWP::ObjectId thread_id, JDWP::ExpandBuf* pReply) {
2125  ScopedObjectAccess soa(Thread::Current());
2126  JDWP::JdwpError error;
2127  Thread* thread = DecodeThread(soa, thread_id, &error);
2128  if (error != JDWP::ERR_NONE) {
2129    return error;
2130  }
2131  MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
2132  expandBufAdd4BE(pReply, thread->GetDebugSuspendCount());
2133  return JDWP::ERR_NONE;
2134}
2135
2136JDWP::JdwpError Dbg::Interrupt(JDWP::ObjectId thread_id) {
2137  ScopedObjectAccess soa(Thread::Current());
2138  JDWP::JdwpError error;
2139  Thread* thread = DecodeThread(soa, thread_id, &error);
2140  if (error != JDWP::ERR_NONE) {
2141    return error;
2142  }
2143  thread->Interrupt(soa.Self());
2144  return JDWP::ERR_NONE;
2145}
2146
2147static bool IsInDesiredThreadGroup(ScopedObjectAccessUnchecked& soa,
2148                                   mirror::Object* desired_thread_group, mirror::Object* peer)
2149    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2150  // Do we want threads from all thread groups?
2151  if (desired_thread_group == nullptr) {
2152    return true;
2153  }
2154  ArtField* thread_group_field = soa.DecodeField(WellKnownClasses::java_lang_Thread_group);
2155  DCHECK(thread_group_field != nullptr);
2156  mirror::Object* group = thread_group_field->GetObject(peer);
2157  return (group == desired_thread_group);
2158}
2159
2160void Dbg::GetThreads(mirror::Object* thread_group, std::vector<JDWP::ObjectId>* thread_ids) {
2161  ScopedObjectAccessUnchecked soa(Thread::Current());
2162  std::list<Thread*> all_threads_list;
2163  {
2164    MutexLock mu(Thread::Current(), *Locks::thread_list_lock_);
2165    all_threads_list = Runtime::Current()->GetThreadList()->GetList();
2166  }
2167  for (Thread* t : all_threads_list) {
2168    if (t == Dbg::GetDebugThread()) {
2169      // Skip the JDWP thread. Some debuggers get bent out of shape when they can't suspend and
2170      // query all threads, so it's easier if we just don't tell them about this thread.
2171      continue;
2172    }
2173    if (t->IsStillStarting()) {
2174      // This thread is being started (and has been registered in the thread list). However, it is
2175      // not completely started yet so we must ignore it.
2176      continue;
2177    }
2178    mirror::Object* peer = t->GetPeer();
2179    if (peer == nullptr) {
2180      // peer might be null if the thread is still starting up. We can't tell the debugger about
2181      // this thread yet.
2182      // TODO: if we identified threads to the debugger by their Thread*
2183      // rather than their peer's mirror::Object*, we could fix this.
2184      // Doing so might help us report ZOMBIE threads too.
2185      continue;
2186    }
2187    if (IsInDesiredThreadGroup(soa, thread_group, peer)) {
2188      thread_ids->push_back(gRegistry->Add(peer));
2189    }
2190  }
2191}
2192
2193static int GetStackDepth(Thread* thread) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2194  struct CountStackDepthVisitor : public StackVisitor {
2195    explicit CountStackDepthVisitor(Thread* thread_in)
2196        : StackVisitor(thread_in, nullptr), depth(0) {}
2197
2198    // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2199    // annotalysis.
2200    bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2201      if (!GetMethod()->IsRuntimeMethod()) {
2202        ++depth;
2203      }
2204      return true;
2205    }
2206    size_t depth;
2207  };
2208
2209  CountStackDepthVisitor visitor(thread);
2210  visitor.WalkStack();
2211  return visitor.depth;
2212}
2213
2214JDWP::JdwpError Dbg::GetThreadFrameCount(JDWP::ObjectId thread_id, size_t* result) {
2215  ScopedObjectAccess soa(Thread::Current());
2216  JDWP::JdwpError error;
2217  *result = 0;
2218  Thread* thread = DecodeThread(soa, thread_id, &error);
2219  if (error != JDWP::ERR_NONE) {
2220    return error;
2221  }
2222  if (!IsSuspendedForDebugger(soa, thread)) {
2223    return JDWP::ERR_THREAD_NOT_SUSPENDED;
2224  }
2225  *result = GetStackDepth(thread);
2226  return JDWP::ERR_NONE;
2227}
2228
2229JDWP::JdwpError Dbg::GetThreadFrames(JDWP::ObjectId thread_id, size_t start_frame,
2230                                     size_t frame_count, JDWP::ExpandBuf* buf) {
2231  class GetFrameVisitor : public StackVisitor {
2232   public:
2233    GetFrameVisitor(Thread* thread, size_t start_frame_in, size_t frame_count_in,
2234                    JDWP::ExpandBuf* buf_in)
2235        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
2236        : StackVisitor(thread, nullptr), depth_(0),
2237          start_frame_(start_frame_in), frame_count_(frame_count_in), buf_(buf_in) {
2238      expandBufAdd4BE(buf_, frame_count_);
2239    }
2240
2241    bool VisitFrame() OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2242      if (GetMethod()->IsRuntimeMethod()) {
2243        return true;  // The debugger can't do anything useful with a frame that has no Method*.
2244      }
2245      if (depth_ >= start_frame_ + frame_count_) {
2246        return false;
2247      }
2248      if (depth_ >= start_frame_) {
2249        JDWP::FrameId frame_id(GetFrameId());
2250        JDWP::JdwpLocation location;
2251        SetJdwpLocation(&location, GetMethod(), GetDexPc());
2252        VLOG(jdwp) << StringPrintf("    Frame %3zd: id=%3" PRIu64 " ", depth_, frame_id) << location;
2253        expandBufAdd8BE(buf_, frame_id);
2254        expandBufAddLocation(buf_, location);
2255      }
2256      ++depth_;
2257      return true;
2258    }
2259
2260   private:
2261    size_t depth_;
2262    const size_t start_frame_;
2263    const size_t frame_count_;
2264    JDWP::ExpandBuf* buf_;
2265  };
2266
2267  ScopedObjectAccessUnchecked soa(Thread::Current());
2268  JDWP::JdwpError error;
2269  Thread* thread = DecodeThread(soa, thread_id, &error);
2270  if (error != JDWP::ERR_NONE) {
2271    return error;
2272  }
2273  if (!IsSuspendedForDebugger(soa, thread)) {
2274    return JDWP::ERR_THREAD_NOT_SUSPENDED;
2275  }
2276  GetFrameVisitor visitor(thread, start_frame, frame_count, buf);
2277  visitor.WalkStack();
2278  return JDWP::ERR_NONE;
2279}
2280
2281JDWP::ObjectId Dbg::GetThreadSelfId() {
2282  return GetThreadId(Thread::Current());
2283}
2284
2285JDWP::ObjectId Dbg::GetThreadId(Thread* thread) {
2286  ScopedObjectAccessUnchecked soa(Thread::Current());
2287  return gRegistry->Add(thread->GetPeer());
2288}
2289
2290void Dbg::SuspendVM() {
2291  Runtime::Current()->GetThreadList()->SuspendAllForDebugger();
2292}
2293
2294void Dbg::ResumeVM() {
2295  Runtime::Current()->GetThreadList()->ResumeAllForDebugger();
2296}
2297
2298JDWP::JdwpError Dbg::SuspendThread(JDWP::ObjectId thread_id, bool request_suspension) {
2299  Thread* self = Thread::Current();
2300  ScopedLocalRef<jobject> peer(self->GetJniEnv(), nullptr);
2301  {
2302    ScopedObjectAccess soa(self);
2303    JDWP::JdwpError error;
2304    peer.reset(soa.AddLocalReference<jobject>(gRegistry->Get<mirror::Object*>(thread_id, &error)));
2305  }
2306  if (peer.get() == nullptr) {
2307    return JDWP::ERR_THREAD_NOT_ALIVE;
2308  }
2309  // Suspend thread to build stack trace.
2310  bool timed_out;
2311  ThreadList* thread_list = Runtime::Current()->GetThreadList();
2312  Thread* thread = thread_list->SuspendThreadByPeer(peer.get(), request_suspension, true,
2313                                                    &timed_out);
2314  if (thread != nullptr) {
2315    return JDWP::ERR_NONE;
2316  } else if (timed_out) {
2317    return JDWP::ERR_INTERNAL;
2318  } else {
2319    return JDWP::ERR_THREAD_NOT_ALIVE;
2320  }
2321}
2322
2323void Dbg::ResumeThread(JDWP::ObjectId thread_id) {
2324  ScopedObjectAccessUnchecked soa(Thread::Current());
2325  JDWP::JdwpError error;
2326  mirror::Object* peer = gRegistry->Get<mirror::Object*>(thread_id, &error);
2327  CHECK(peer != nullptr) << error;
2328  Thread* thread;
2329  {
2330    MutexLock mu(soa.Self(), *Locks::thread_list_lock_);
2331    thread = Thread::FromManagedThread(soa, peer);
2332  }
2333  if (thread == nullptr) {
2334    LOG(WARNING) << "No such thread for resume: " << peer;
2335    return;
2336  }
2337  bool needs_resume;
2338  {
2339    MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
2340    needs_resume = thread->GetSuspendCount() > 0;
2341  }
2342  if (needs_resume) {
2343    Runtime::Current()->GetThreadList()->Resume(thread, true);
2344  }
2345}
2346
2347void Dbg::SuspendSelf() {
2348  Runtime::Current()->GetThreadList()->SuspendSelfForDebugger();
2349}
2350
2351struct GetThisVisitor : public StackVisitor {
2352  GetThisVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id_in)
2353      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
2354      : StackVisitor(thread, context), this_object(nullptr), frame_id(frame_id_in) {}
2355
2356  // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2357  // annotalysis.
2358  virtual bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2359    if (frame_id != GetFrameId()) {
2360      return true;  // continue
2361    } else {
2362      this_object = GetThisObject();
2363      return false;
2364    }
2365  }
2366
2367  mirror::Object* this_object;
2368  JDWP::FrameId frame_id;
2369};
2370
2371JDWP::JdwpError Dbg::GetThisObject(JDWP::ObjectId thread_id, JDWP::FrameId frame_id,
2372                                   JDWP::ObjectId* result) {
2373  ScopedObjectAccessUnchecked soa(Thread::Current());
2374  JDWP::JdwpError error;
2375  Thread* thread = DecodeThread(soa, thread_id, &error);
2376  if (error != JDWP::ERR_NONE) {
2377    return error;
2378  }
2379  if (!IsSuspendedForDebugger(soa, thread)) {
2380    return JDWP::ERR_THREAD_NOT_SUSPENDED;
2381  }
2382  std::unique_ptr<Context> context(Context::Create());
2383  GetThisVisitor visitor(thread, context.get(), frame_id);
2384  visitor.WalkStack();
2385  *result = gRegistry->Add(visitor.this_object);
2386  return JDWP::ERR_NONE;
2387}
2388
2389// Walks the stack until we find the frame with the given FrameId.
2390class FindFrameVisitor FINAL : public StackVisitor {
2391 public:
2392  FindFrameVisitor(Thread* thread, Context* context, JDWP::FrameId frame_id)
2393      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
2394      : StackVisitor(thread, context), frame_id_(frame_id), error_(JDWP::ERR_INVALID_FRAMEID) {}
2395
2396  // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
2397  // annotalysis.
2398  bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
2399    if (GetFrameId() != frame_id_) {
2400      return true;  // Not our frame, carry on.
2401    }
2402    mirror::ArtMethod* m = GetMethod();
2403    if (m->IsNative()) {
2404      // We can't read/write local value from/into native method.
2405      error_ = JDWP::ERR_OPAQUE_FRAME;
2406    } else {
2407      // We found our frame.
2408      error_ = JDWP::ERR_NONE;
2409    }
2410    return false;
2411  }
2412
2413  JDWP::JdwpError GetError() const {
2414    return error_;
2415  }
2416
2417 private:
2418  const JDWP::FrameId frame_id_;
2419  JDWP::JdwpError error_;
2420};
2421
2422JDWP::JdwpError Dbg::GetLocalValues(JDWP::Request* request, JDWP::ExpandBuf* pReply) {
2423  JDWP::ObjectId thread_id = request->ReadThreadId();
2424  JDWP::FrameId frame_id = request->ReadFrameId();
2425
2426  ScopedObjectAccessUnchecked soa(Thread::Current());
2427  JDWP::JdwpError error;
2428  Thread* thread = DecodeThread(soa, thread_id, &error);
2429  if (error != JDWP::ERR_NONE) {
2430    return error;
2431  }
2432  if (!IsSuspendedForDebugger(soa, thread)) {
2433    return JDWP::ERR_THREAD_NOT_SUSPENDED;
2434  }
2435  // Find the frame with the given frame_id.
2436  std::unique_ptr<Context> context(Context::Create());
2437  FindFrameVisitor visitor(thread, context.get(), frame_id);
2438  visitor.WalkStack();
2439  if (visitor.GetError() != JDWP::ERR_NONE) {
2440    return visitor.GetError();
2441  }
2442
2443  // Read the values from visitor's context.
2444  int32_t slot_count = request->ReadSigned32("slot count");
2445  expandBufAdd4BE(pReply, slot_count);     /* "int values" */
2446  for (int32_t i = 0; i < slot_count; ++i) {
2447    uint32_t slot = request->ReadUnsigned32("slot");
2448    JDWP::JdwpTag reqSigByte = request->ReadTag();
2449
2450    VLOG(jdwp) << "    --> slot " << slot << " " << reqSigByte;
2451
2452    size_t width = Dbg::GetTagWidth(reqSigByte);
2453    uint8_t* ptr = expandBufAddSpace(pReply, width + 1);
2454    error = Dbg::GetLocalValue(visitor, soa, slot, reqSigByte, ptr, width);
2455    if (error != JDWP::ERR_NONE) {
2456      return error;
2457    }
2458  }
2459  return JDWP::ERR_NONE;
2460}
2461
2462constexpr JDWP::JdwpError kStackFrameLocalAccessError = JDWP::ERR_ABSENT_INFORMATION;
2463
2464static std::string GetStackContextAsString(const StackVisitor& visitor)
2465    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2466  return StringPrintf(" at DEX pc 0x%08x in method %s", visitor.GetDexPc(false),
2467                      PrettyMethod(visitor.GetMethod()).c_str());
2468}
2469
2470static JDWP::JdwpError FailGetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2471                                         JDWP::JdwpTag tag)
2472    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2473  LOG(ERROR) << "Failed to read " << tag << " local from register v" << vreg
2474             << GetStackContextAsString(visitor);
2475  return kStackFrameLocalAccessError;
2476}
2477
2478JDWP::JdwpError Dbg::GetLocalValue(const StackVisitor& visitor, ScopedObjectAccessUnchecked& soa,
2479                                   int slot, JDWP::JdwpTag tag, uint8_t* buf, size_t width) {
2480  mirror::ArtMethod* m = visitor.GetMethod();
2481  JDWP::JdwpError error = JDWP::ERR_NONE;
2482  uint16_t vreg = DemangleSlot(slot, m, &error);
2483  if (error != JDWP::ERR_NONE) {
2484    return error;
2485  }
2486  // TODO: check that the tag is compatible with the actual type of the slot!
2487  switch (tag) {
2488    case JDWP::JT_BOOLEAN: {
2489      CHECK_EQ(width, 1U);
2490      uint32_t intVal;
2491      if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2492        return FailGetLocalValue(visitor, vreg, tag);
2493      }
2494      VLOG(jdwp) << "get boolean local " << vreg << " = " << intVal;
2495      JDWP::Set1(buf + 1, intVal != 0);
2496      break;
2497    }
2498    case JDWP::JT_BYTE: {
2499      CHECK_EQ(width, 1U);
2500      uint32_t intVal;
2501      if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2502        return FailGetLocalValue(visitor, vreg, tag);
2503      }
2504      VLOG(jdwp) << "get byte local " << vreg << " = " << intVal;
2505      JDWP::Set1(buf + 1, intVal);
2506      break;
2507    }
2508    case JDWP::JT_SHORT:
2509    case JDWP::JT_CHAR: {
2510      CHECK_EQ(width, 2U);
2511      uint32_t intVal;
2512      if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2513        return FailGetLocalValue(visitor, vreg, tag);
2514      }
2515      VLOG(jdwp) << "get short/char local " << vreg << " = " << intVal;
2516      JDWP::Set2BE(buf + 1, intVal);
2517      break;
2518    }
2519    case JDWP::JT_INT: {
2520      CHECK_EQ(width, 4U);
2521      uint32_t intVal;
2522      if (!visitor.GetVReg(m, vreg, kIntVReg, &intVal)) {
2523        return FailGetLocalValue(visitor, vreg, tag);
2524      }
2525      VLOG(jdwp) << "get int local " << vreg << " = " << intVal;
2526      JDWP::Set4BE(buf + 1, intVal);
2527      break;
2528    }
2529    case JDWP::JT_FLOAT: {
2530      CHECK_EQ(width, 4U);
2531      uint32_t intVal;
2532      if (!visitor.GetVReg(m, vreg, kFloatVReg, &intVal)) {
2533        return FailGetLocalValue(visitor, vreg, tag);
2534      }
2535      VLOG(jdwp) << "get float local " << vreg << " = " << intVal;
2536      JDWP::Set4BE(buf + 1, intVal);
2537      break;
2538    }
2539    case JDWP::JT_ARRAY:
2540    case JDWP::JT_CLASS_LOADER:
2541    case JDWP::JT_CLASS_OBJECT:
2542    case JDWP::JT_OBJECT:
2543    case JDWP::JT_STRING:
2544    case JDWP::JT_THREAD:
2545    case JDWP::JT_THREAD_GROUP: {
2546      CHECK_EQ(width, sizeof(JDWP::ObjectId));
2547      uint32_t intVal;
2548      if (!visitor.GetVReg(m, vreg, kReferenceVReg, &intVal)) {
2549        return FailGetLocalValue(visitor, vreg, tag);
2550      }
2551      mirror::Object* o = reinterpret_cast<mirror::Object*>(intVal);
2552      VLOG(jdwp) << "get " << tag << " object local " << vreg << " = " << o;
2553      if (!Runtime::Current()->GetHeap()->IsValidObjectAddress(o)) {
2554        LOG(FATAL) << StringPrintf("Found invalid object %#" PRIxPTR " in register v%u",
2555                                   reinterpret_cast<uintptr_t>(o), vreg)
2556                                   << GetStackContextAsString(visitor);
2557        UNREACHABLE();
2558      }
2559      tag = TagFromObject(soa, o);
2560      JDWP::SetObjectId(buf + 1, gRegistry->Add(o));
2561      break;
2562    }
2563    case JDWP::JT_DOUBLE: {
2564      CHECK_EQ(width, 8U);
2565      uint64_t longVal;
2566      if (!visitor.GetVRegPair(m, vreg, kDoubleLoVReg, kDoubleHiVReg, &longVal)) {
2567        return FailGetLocalValue(visitor, vreg, tag);
2568      }
2569      VLOG(jdwp) << "get double local " << vreg << " = " << longVal;
2570      JDWP::Set8BE(buf + 1, longVal);
2571      break;
2572    }
2573    case JDWP::JT_LONG: {
2574      CHECK_EQ(width, 8U);
2575      uint64_t longVal;
2576      if (!visitor.GetVRegPair(m, vreg, kLongLoVReg, kLongHiVReg, &longVal)) {
2577        return FailGetLocalValue(visitor, vreg, tag);
2578      }
2579      VLOG(jdwp) << "get long local " << vreg << " = " << longVal;
2580      JDWP::Set8BE(buf + 1, longVal);
2581      break;
2582    }
2583    default:
2584      LOG(FATAL) << "Unknown tag " << tag;
2585      UNREACHABLE();
2586  }
2587
2588  // Prepend tag, which may have been updated.
2589  JDWP::Set1(buf, tag);
2590  return JDWP::ERR_NONE;
2591}
2592
2593JDWP::JdwpError Dbg::SetLocalValues(JDWP::Request* request) {
2594  JDWP::ObjectId thread_id = request->ReadThreadId();
2595  JDWP::FrameId frame_id = request->ReadFrameId();
2596
2597  ScopedObjectAccessUnchecked soa(Thread::Current());
2598  JDWP::JdwpError error;
2599  Thread* thread = DecodeThread(soa, thread_id, &error);
2600  if (error != JDWP::ERR_NONE) {
2601    return error;
2602  }
2603  if (!IsSuspendedForDebugger(soa, thread)) {
2604    return JDWP::ERR_THREAD_NOT_SUSPENDED;
2605  }
2606  // Find the frame with the given frame_id.
2607  std::unique_ptr<Context> context(Context::Create());
2608  FindFrameVisitor visitor(thread, context.get(), frame_id);
2609  visitor.WalkStack();
2610  if (visitor.GetError() != JDWP::ERR_NONE) {
2611    return visitor.GetError();
2612  }
2613
2614  // Writes the values into visitor's context.
2615  int32_t slot_count = request->ReadSigned32("slot count");
2616  for (int32_t i = 0; i < slot_count; ++i) {
2617    uint32_t slot = request->ReadUnsigned32("slot");
2618    JDWP::JdwpTag sigByte = request->ReadTag();
2619    size_t width = Dbg::GetTagWidth(sigByte);
2620    uint64_t value = request->ReadValue(width);
2621
2622    VLOG(jdwp) << "    --> slot " << slot << " " << sigByte << " " << value;
2623    error = Dbg::SetLocalValue(visitor, slot, sigByte, value, width);
2624    if (error != JDWP::ERR_NONE) {
2625      return error;
2626    }
2627  }
2628  return JDWP::ERR_NONE;
2629}
2630
2631template<typename T>
2632static JDWP::JdwpError FailSetLocalValue(const StackVisitor& visitor, uint16_t vreg,
2633                                         JDWP::JdwpTag tag, T value)
2634    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2635  LOG(ERROR) << "Failed to write " << tag << " local " << value
2636             << " (0x" << std::hex << value << ") into register v" << vreg
2637             << GetStackContextAsString(visitor);
2638  return kStackFrameLocalAccessError;
2639}
2640
2641JDWP::JdwpError Dbg::SetLocalValue(StackVisitor& visitor, int slot, JDWP::JdwpTag tag,
2642                                   uint64_t value, size_t width) {
2643  mirror::ArtMethod* m = visitor.GetMethod();
2644  JDWP::JdwpError error = JDWP::ERR_NONE;
2645  uint16_t vreg = DemangleSlot(slot, m, &error);
2646  if (error != JDWP::ERR_NONE) {
2647    return error;
2648  }
2649  // TODO: check that the tag is compatible with the actual type of the slot!
2650  switch (tag) {
2651    case JDWP::JT_BOOLEAN:
2652    case JDWP::JT_BYTE:
2653      CHECK_EQ(width, 1U);
2654      if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2655        return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2656      }
2657      break;
2658    case JDWP::JT_SHORT:
2659    case JDWP::JT_CHAR:
2660      CHECK_EQ(width, 2U);
2661      if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2662        return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2663      }
2664      break;
2665    case JDWP::JT_INT:
2666      CHECK_EQ(width, 4U);
2667      if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kIntVReg)) {
2668        return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2669      }
2670      break;
2671    case JDWP::JT_FLOAT:
2672      CHECK_EQ(width, 4U);
2673      if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(value), kFloatVReg)) {
2674        return FailSetLocalValue(visitor, vreg, tag, static_cast<uint32_t>(value));
2675      }
2676      break;
2677    case JDWP::JT_ARRAY:
2678    case JDWP::JT_CLASS_LOADER:
2679    case JDWP::JT_CLASS_OBJECT:
2680    case JDWP::JT_OBJECT:
2681    case JDWP::JT_STRING:
2682    case JDWP::JT_THREAD:
2683    case JDWP::JT_THREAD_GROUP: {
2684      CHECK_EQ(width, sizeof(JDWP::ObjectId));
2685      mirror::Object* o = gRegistry->Get<mirror::Object*>(static_cast<JDWP::ObjectId>(value),
2686                                                          &error);
2687      if (error != JDWP::ERR_NONE) {
2688        VLOG(jdwp) << tag << " object " << o << " is an invalid object";
2689        return JDWP::ERR_INVALID_OBJECT;
2690      }
2691      if (!visitor.SetVReg(m, vreg, static_cast<uint32_t>(reinterpret_cast<uintptr_t>(o)),
2692                                 kReferenceVReg)) {
2693        return FailSetLocalValue(visitor, vreg, tag, reinterpret_cast<uintptr_t>(o));
2694      }
2695      break;
2696    }
2697    case JDWP::JT_DOUBLE: {
2698      CHECK_EQ(width, 8U);
2699      if (!visitor.SetVRegPair(m, vreg, value, kDoubleLoVReg, kDoubleHiVReg)) {
2700        return FailSetLocalValue(visitor, vreg, tag, value);
2701      }
2702      break;
2703    }
2704    case JDWP::JT_LONG: {
2705      CHECK_EQ(width, 8U);
2706      if (!visitor.SetVRegPair(m, vreg, value, kLongLoVReg, kLongHiVReg)) {
2707        return FailSetLocalValue(visitor, vreg, tag, value);
2708      }
2709      break;
2710    }
2711    default:
2712      LOG(FATAL) << "Unknown tag " << tag;
2713      UNREACHABLE();
2714  }
2715  return JDWP::ERR_NONE;
2716}
2717
2718static void SetEventLocation(JDWP::EventLocation* location, mirror::ArtMethod* m, uint32_t dex_pc)
2719    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2720  DCHECK(location != nullptr);
2721  if (m == nullptr) {
2722    memset(location, 0, sizeof(*location));
2723  } else {
2724    location->method = m;
2725    location->dex_pc = (m->IsNative() || m->IsProxyMethod()) ? static_cast<uint32_t>(-1) : dex_pc;
2726  }
2727}
2728
2729void Dbg::PostLocationEvent(mirror::ArtMethod* m, int dex_pc, mirror::Object* this_object,
2730                            int event_flags, const JValue* return_value) {
2731  if (!IsDebuggerActive()) {
2732    return;
2733  }
2734  DCHECK(m != nullptr);
2735  DCHECK_EQ(m->IsStatic(), this_object == nullptr);
2736  JDWP::EventLocation location;
2737  SetEventLocation(&location, m, dex_pc);
2738
2739  gJdwpState->PostLocationEvent(&location, this_object, event_flags, return_value);
2740}
2741
2742void Dbg::PostFieldAccessEvent(mirror::ArtMethod* m, int dex_pc,
2743                               mirror::Object* this_object, ArtField* f) {
2744  if (!IsDebuggerActive()) {
2745    return;
2746  }
2747  DCHECK(m != nullptr);
2748  DCHECK(f != nullptr);
2749  JDWP::EventLocation location;
2750  SetEventLocation(&location, m, dex_pc);
2751
2752  gJdwpState->PostFieldEvent(&location, f, this_object, nullptr, false);
2753}
2754
2755void Dbg::PostFieldModificationEvent(mirror::ArtMethod* m, int dex_pc,
2756                                     mirror::Object* this_object, ArtField* f,
2757                                     const JValue* field_value) {
2758  if (!IsDebuggerActive()) {
2759    return;
2760  }
2761  DCHECK(m != nullptr);
2762  DCHECK(f != nullptr);
2763  DCHECK(field_value != nullptr);
2764  JDWP::EventLocation location;
2765  SetEventLocation(&location, m, dex_pc);
2766
2767  gJdwpState->PostFieldEvent(&location, f, this_object, field_value, true);
2768}
2769
2770/**
2771 * Finds the location where this exception will be caught. We search until we reach the top
2772 * frame, in which case this exception is considered uncaught.
2773 */
2774class CatchLocationFinder : public StackVisitor {
2775 public:
2776  CatchLocationFinder(Thread* self, const Handle<mirror::Throwable>& exception, Context* context)
2777      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
2778    : StackVisitor(self, context),
2779      self_(self),
2780      exception_(exception),
2781      handle_scope_(self),
2782      this_at_throw_(handle_scope_.NewHandle<mirror::Object>(nullptr)),
2783      catch_method_(handle_scope_.NewHandle<mirror::ArtMethod>(nullptr)),
2784      throw_method_(handle_scope_.NewHandle<mirror::ArtMethod>(nullptr)),
2785      catch_dex_pc_(DexFile::kDexNoIndex),
2786      throw_dex_pc_(DexFile::kDexNoIndex) {
2787  }
2788
2789  bool VisitFrame() OVERRIDE SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2790    mirror::ArtMethod* method = GetMethod();
2791    DCHECK(method != nullptr);
2792    if (method->IsRuntimeMethod()) {
2793      // Ignore callee save method.
2794      DCHECK(method->IsCalleeSaveMethod());
2795      return true;
2796    }
2797
2798    uint32_t dex_pc = GetDexPc();
2799    if (throw_method_.Get() == nullptr) {
2800      // First Java method found. It is either the method that threw the exception,
2801      // or the Java native method that is reporting an exception thrown by
2802      // native code.
2803      this_at_throw_.Assign(GetThisObject());
2804      throw_method_.Assign(method);
2805      throw_dex_pc_ = dex_pc;
2806    }
2807
2808    if (dex_pc != DexFile::kDexNoIndex) {
2809      StackHandleScope<2> hs(self_);
2810      uint32_t found_dex_pc;
2811      Handle<mirror::Class> exception_class(hs.NewHandle(exception_->GetClass()));
2812      Handle<mirror::ArtMethod> h_method(hs.NewHandle(method));
2813      bool unused_clear_exception;
2814      found_dex_pc = mirror::ArtMethod::FindCatchBlock(
2815          h_method, exception_class, dex_pc, &unused_clear_exception);
2816      if (found_dex_pc != DexFile::kDexNoIndex) {
2817        catch_method_.Assign(method);
2818        catch_dex_pc_ = found_dex_pc;
2819        return false;  // End stack walk.
2820      }
2821    }
2822    return true;  // Continue stack walk.
2823  }
2824
2825  mirror::ArtMethod* GetCatchMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2826    return catch_method_.Get();
2827  }
2828
2829  mirror::ArtMethod* GetThrowMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2830    return throw_method_.Get();
2831  }
2832
2833  mirror::Object* GetThisAtThrow() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2834    return this_at_throw_.Get();
2835  }
2836
2837  uint32_t GetCatchDexPc() const {
2838    return catch_dex_pc_;
2839  }
2840
2841  uint32_t GetThrowDexPc() const {
2842    return throw_dex_pc_;
2843  }
2844
2845 private:
2846  Thread* const self_;
2847  const Handle<mirror::Throwable>& exception_;
2848  StackHandleScope<3> handle_scope_;
2849  MutableHandle<mirror::Object> this_at_throw_;
2850  MutableHandle<mirror::ArtMethod> catch_method_;
2851  MutableHandle<mirror::ArtMethod> throw_method_;
2852  uint32_t catch_dex_pc_;
2853  uint32_t throw_dex_pc_;
2854
2855  DISALLOW_COPY_AND_ASSIGN(CatchLocationFinder);
2856};
2857
2858void Dbg::PostException(mirror::Throwable* exception_object) {
2859  if (!IsDebuggerActive()) {
2860    return;
2861  }
2862  StackHandleScope<1> handle_scope(Thread::Current());
2863  Handle<mirror::Throwable> h_exception(handle_scope.NewHandle(exception_object));
2864  std::unique_ptr<Context> context(Context::Create());
2865  CatchLocationFinder clf(Thread::Current(), h_exception, context.get());
2866  clf.WalkStack(/* include_transitions */ false);
2867  JDWP::EventLocation exception_throw_location;
2868  SetEventLocation(&exception_throw_location, clf.GetThrowMethod(), clf.GetThrowDexPc());
2869  JDWP::EventLocation exception_catch_location;
2870  SetEventLocation(&exception_catch_location, clf.GetCatchMethod(), clf.GetCatchDexPc());
2871
2872  gJdwpState->PostException(&exception_throw_location, h_exception.Get(), &exception_catch_location,
2873                            clf.GetThisAtThrow());
2874}
2875
2876void Dbg::PostClassPrepare(mirror::Class* c) {
2877  if (!IsDebuggerActive()) {
2878    return;
2879  }
2880  gJdwpState->PostClassPrepare(c);
2881}
2882
2883void Dbg::UpdateDebugger(Thread* thread, mirror::Object* this_object,
2884                         mirror::ArtMethod* m, uint32_t dex_pc,
2885                         int event_flags, const JValue* return_value) {
2886  if (!IsDebuggerActive() || dex_pc == static_cast<uint32_t>(-2) /* fake method exit */) {
2887    return;
2888  }
2889
2890  if (IsBreakpoint(m, dex_pc)) {
2891    event_flags |= kBreakpoint;
2892  }
2893
2894  // If the debugger is single-stepping one of our threads, check to
2895  // see if we're that thread and we've reached a step point.
2896  const SingleStepControl* single_step_control = thread->GetSingleStepControl();
2897  if (single_step_control != nullptr) {
2898    CHECK(!m->IsNative());
2899    if (single_step_control->GetStepDepth() == JDWP::SD_INTO) {
2900      // Step into method calls.  We break when the line number
2901      // or method pointer changes.  If we're in SS_MIN mode, we
2902      // always stop.
2903      if (single_step_control->GetMethod() != m) {
2904        event_flags |= kSingleStep;
2905        VLOG(jdwp) << "SS new method";
2906      } else if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
2907        event_flags |= kSingleStep;
2908        VLOG(jdwp) << "SS new instruction";
2909      } else if (single_step_control->ContainsDexPc(dex_pc)) {
2910        event_flags |= kSingleStep;
2911        VLOG(jdwp) << "SS new line";
2912      }
2913    } else if (single_step_control->GetStepDepth() == JDWP::SD_OVER) {
2914      // Step over method calls.  We break when the line number is
2915      // different and the frame depth is <= the original frame
2916      // depth.  (We can't just compare on the method, because we
2917      // might get unrolled past it by an exception, and it's tricky
2918      // to identify recursion.)
2919
2920      int stack_depth = GetStackDepth(thread);
2921
2922      if (stack_depth < single_step_control->GetStackDepth()) {
2923        // Popped up one or more frames, always trigger.
2924        event_flags |= kSingleStep;
2925        VLOG(jdwp) << "SS method pop";
2926      } else if (stack_depth == single_step_control->GetStackDepth()) {
2927        // Same depth, see if we moved.
2928        if (single_step_control->GetStepSize() == JDWP::SS_MIN) {
2929          event_flags |= kSingleStep;
2930          VLOG(jdwp) << "SS new instruction";
2931        } else if (single_step_control->ContainsDexPc(dex_pc)) {
2932          event_flags |= kSingleStep;
2933          VLOG(jdwp) << "SS new line";
2934        }
2935      }
2936    } else {
2937      CHECK_EQ(single_step_control->GetStepDepth(), JDWP::SD_OUT);
2938      // Return from the current method.  We break when the frame
2939      // depth pops up.
2940
2941      // This differs from the "method exit" break in that it stops
2942      // with the PC at the next instruction in the returned-to
2943      // function, rather than the end of the returning function.
2944
2945      int stack_depth = GetStackDepth(thread);
2946      if (stack_depth < single_step_control->GetStackDepth()) {
2947        event_flags |= kSingleStep;
2948        VLOG(jdwp) << "SS method pop";
2949      }
2950    }
2951  }
2952
2953  // If there's something interesting going on, see if it matches one
2954  // of the debugger filters.
2955  if (event_flags != 0) {
2956    Dbg::PostLocationEvent(m, dex_pc, this_object, event_flags, return_value);
2957  }
2958}
2959
2960size_t* Dbg::GetReferenceCounterForEvent(uint32_t instrumentation_event) {
2961  switch (instrumentation_event) {
2962    case instrumentation::Instrumentation::kMethodEntered:
2963      return &method_enter_event_ref_count_;
2964    case instrumentation::Instrumentation::kMethodExited:
2965      return &method_exit_event_ref_count_;
2966    case instrumentation::Instrumentation::kDexPcMoved:
2967      return &dex_pc_change_event_ref_count_;
2968    case instrumentation::Instrumentation::kFieldRead:
2969      return &field_read_event_ref_count_;
2970    case instrumentation::Instrumentation::kFieldWritten:
2971      return &field_write_event_ref_count_;
2972    case instrumentation::Instrumentation::kExceptionCaught:
2973      return &exception_catch_event_ref_count_;
2974    default:
2975      return nullptr;
2976  }
2977}
2978
2979// Process request while all mutator threads are suspended.
2980void Dbg::ProcessDeoptimizationRequest(const DeoptimizationRequest& request) {
2981  instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
2982  switch (request.GetKind()) {
2983    case DeoptimizationRequest::kNothing:
2984      LOG(WARNING) << "Ignoring empty deoptimization request.";
2985      break;
2986    case DeoptimizationRequest::kRegisterForEvent:
2987      VLOG(jdwp) << StringPrintf("Add debugger as listener for instrumentation event 0x%x",
2988                                 request.InstrumentationEvent());
2989      instrumentation->AddListener(&gDebugInstrumentationListener, request.InstrumentationEvent());
2990      instrumentation_events_ |= request.InstrumentationEvent();
2991      break;
2992    case DeoptimizationRequest::kUnregisterForEvent:
2993      VLOG(jdwp) << StringPrintf("Remove debugger as listener for instrumentation event 0x%x",
2994                                 request.InstrumentationEvent());
2995      instrumentation->RemoveListener(&gDebugInstrumentationListener,
2996                                      request.InstrumentationEvent());
2997      instrumentation_events_ &= ~request.InstrumentationEvent();
2998      break;
2999    case DeoptimizationRequest::kFullDeoptimization:
3000      VLOG(jdwp) << "Deoptimize the world ...";
3001      instrumentation->DeoptimizeEverything();
3002      VLOG(jdwp) << "Deoptimize the world DONE";
3003      break;
3004    case DeoptimizationRequest::kFullUndeoptimization:
3005      VLOG(jdwp) << "Undeoptimize the world ...";
3006      instrumentation->UndeoptimizeEverything();
3007      VLOG(jdwp) << "Undeoptimize the world DONE";
3008      break;
3009    case DeoptimizationRequest::kSelectiveDeoptimization:
3010      VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " ...";
3011      instrumentation->Deoptimize(request.Method());
3012      VLOG(jdwp) << "Deoptimize method " << PrettyMethod(request.Method()) << " DONE";
3013      break;
3014    case DeoptimizationRequest::kSelectiveUndeoptimization:
3015      VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " ...";
3016      instrumentation->Undeoptimize(request.Method());
3017      VLOG(jdwp) << "Undeoptimize method " << PrettyMethod(request.Method()) << " DONE";
3018      break;
3019    default:
3020      LOG(FATAL) << "Unsupported deoptimization request kind " << request.GetKind();
3021      break;
3022  }
3023}
3024
3025void Dbg::RequestDeoptimization(const DeoptimizationRequest& req) {
3026  if (req.GetKind() == DeoptimizationRequest::kNothing) {
3027    // Nothing to do.
3028    return;
3029  }
3030  MutexLock mu(Thread::Current(), *Locks::deoptimization_lock_);
3031  RequestDeoptimizationLocked(req);
3032}
3033
3034void Dbg::RequestDeoptimizationLocked(const DeoptimizationRequest& req) {
3035  switch (req.GetKind()) {
3036    case DeoptimizationRequest::kRegisterForEvent: {
3037      DCHECK_NE(req.InstrumentationEvent(), 0u);
3038      size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
3039      CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
3040                                                req.InstrumentationEvent());
3041      if (*counter == 0) {
3042        VLOG(jdwp) << StringPrintf("Queue request #%zd to start listening to instrumentation event 0x%x",
3043                                   deoptimization_requests_.size(), req.InstrumentationEvent());
3044        deoptimization_requests_.push_back(req);
3045      }
3046      *counter = *counter + 1;
3047      break;
3048    }
3049    case DeoptimizationRequest::kUnregisterForEvent: {
3050      DCHECK_NE(req.InstrumentationEvent(), 0u);
3051      size_t* counter = GetReferenceCounterForEvent(req.InstrumentationEvent());
3052      CHECK(counter != nullptr) << StringPrintf("No counter for instrumentation event 0x%x",
3053                                                req.InstrumentationEvent());
3054      *counter = *counter - 1;
3055      if (*counter == 0) {
3056        VLOG(jdwp) << StringPrintf("Queue request #%zd to stop listening to instrumentation event 0x%x",
3057                                   deoptimization_requests_.size(), req.InstrumentationEvent());
3058        deoptimization_requests_.push_back(req);
3059      }
3060      break;
3061    }
3062    case DeoptimizationRequest::kFullDeoptimization: {
3063      DCHECK(req.Method() == nullptr);
3064      if (full_deoptimization_event_count_ == 0) {
3065        VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3066                   << " for full deoptimization";
3067        deoptimization_requests_.push_back(req);
3068      }
3069      ++full_deoptimization_event_count_;
3070      break;
3071    }
3072    case DeoptimizationRequest::kFullUndeoptimization: {
3073      DCHECK(req.Method() == nullptr);
3074      DCHECK_GT(full_deoptimization_event_count_, 0U);
3075      --full_deoptimization_event_count_;
3076      if (full_deoptimization_event_count_ == 0) {
3077        VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3078                   << " for full undeoptimization";
3079        deoptimization_requests_.push_back(req);
3080      }
3081      break;
3082    }
3083    case DeoptimizationRequest::kSelectiveDeoptimization: {
3084      DCHECK(req.Method() != nullptr);
3085      VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3086                 << " for deoptimization of " << PrettyMethod(req.Method());
3087      deoptimization_requests_.push_back(req);
3088      break;
3089    }
3090    case DeoptimizationRequest::kSelectiveUndeoptimization: {
3091      DCHECK(req.Method() != nullptr);
3092      VLOG(jdwp) << "Queue request #" << deoptimization_requests_.size()
3093                 << " for undeoptimization of " << PrettyMethod(req.Method());
3094      deoptimization_requests_.push_back(req);
3095      break;
3096    }
3097    default: {
3098      LOG(FATAL) << "Unknown deoptimization request kind " << req.GetKind();
3099      break;
3100    }
3101  }
3102}
3103
3104void Dbg::ManageDeoptimization() {
3105  Thread* const self = Thread::Current();
3106  {
3107    // Avoid suspend/resume if there is no pending request.
3108    MutexLock mu(self, *Locks::deoptimization_lock_);
3109    if (deoptimization_requests_.empty()) {
3110      return;
3111    }
3112  }
3113  CHECK_EQ(self->GetState(), kRunnable);
3114  self->TransitionFromRunnableToSuspended(kWaitingForDeoptimization);
3115  // We need to suspend mutator threads first.
3116  Runtime* const runtime = Runtime::Current();
3117  runtime->GetThreadList()->SuspendAll(__FUNCTION__);
3118  const ThreadState old_state = self->SetStateUnsafe(kRunnable);
3119  {
3120    MutexLock mu(self, *Locks::deoptimization_lock_);
3121    size_t req_index = 0;
3122    for (DeoptimizationRequest& request : deoptimization_requests_) {
3123      VLOG(jdwp) << "Process deoptimization request #" << req_index++;
3124      ProcessDeoptimizationRequest(request);
3125    }
3126    deoptimization_requests_.clear();
3127  }
3128  CHECK_EQ(self->SetStateUnsafe(old_state), kRunnable);
3129  runtime->GetThreadList()->ResumeAll();
3130  self->TransitionFromSuspendedToRunnable();
3131}
3132
3133static bool IsMethodPossiblyInlined(Thread* self, mirror::ArtMethod* m)
3134    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3135  const DexFile::CodeItem* code_item = m->GetCodeItem();
3136  if (code_item == nullptr) {
3137    // TODO We should not be asked to watch location in a native or abstract method so the code item
3138    // should never be null. We could just check we never encounter this case.
3139    return false;
3140  }
3141  // Note: method verifier may cause thread suspension.
3142  self->AssertThreadSuspensionIsAllowable();
3143  StackHandleScope<3> hs(self);
3144  mirror::Class* declaring_class = m->GetDeclaringClass();
3145  Handle<mirror::DexCache> dex_cache(hs.NewHandle(declaring_class->GetDexCache()));
3146  Handle<mirror::ClassLoader> class_loader(hs.NewHandle(declaring_class->GetClassLoader()));
3147  Handle<mirror::ArtMethod> method(hs.NewHandle(m));
3148  verifier::MethodVerifier verifier(self, dex_cache->GetDexFile(), dex_cache, class_loader,
3149                                    &m->GetClassDef(), code_item, m->GetDexMethodIndex(), method,
3150                                    m->GetAccessFlags(), false, true, false, true);
3151  // Note: we don't need to verify the method.
3152  return InlineMethodAnalyser::AnalyseMethodCode(&verifier, nullptr);
3153}
3154
3155static const Breakpoint* FindFirstBreakpointForMethod(mirror::ArtMethod* m)
3156    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
3157  for (Breakpoint& breakpoint : gBreakpoints) {
3158    if (breakpoint.Method() == m) {
3159      return &breakpoint;
3160    }
3161  }
3162  return nullptr;
3163}
3164
3165bool Dbg::MethodHasAnyBreakpoints(mirror::ArtMethod* method) {
3166  ReaderMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3167  return FindFirstBreakpointForMethod(method) != nullptr;
3168}
3169
3170// Sanity checks all existing breakpoints on the same method.
3171static void SanityCheckExistingBreakpoints(mirror::ArtMethod* m,
3172                                           DeoptimizationRequest::Kind deoptimization_kind)
3173    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::breakpoint_lock_) {
3174  for (const Breakpoint& breakpoint : gBreakpoints) {
3175    if (breakpoint.Method() == m) {
3176      CHECK_EQ(deoptimization_kind, breakpoint.GetDeoptimizationKind());
3177    }
3178  }
3179  instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
3180  if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
3181    // We should have deoptimized everything but not "selectively" deoptimized this method.
3182    CHECK(instrumentation->AreAllMethodsDeoptimized());
3183    CHECK(!instrumentation->IsDeoptimized(m));
3184  } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3185    // We should have "selectively" deoptimized this method.
3186    // Note: while we have not deoptimized everything for this method, we may have done it for
3187    // another event.
3188    CHECK(instrumentation->IsDeoptimized(m));
3189  } else {
3190    // This method does not require deoptimization.
3191    CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3192    CHECK(!instrumentation->IsDeoptimized(m));
3193  }
3194}
3195
3196// Returns the deoptimization kind required to set a breakpoint in a method.
3197// If a breakpoint has already been set, we also return the first breakpoint
3198// through the given 'existing_brkpt' pointer.
3199static DeoptimizationRequest::Kind GetRequiredDeoptimizationKind(Thread* self,
3200                                                                 mirror::ArtMethod* m,
3201                                                                 const Breakpoint** existing_brkpt)
3202    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
3203  if (!Dbg::RequiresDeoptimization()) {
3204    // We already run in interpreter-only mode so we don't need to deoptimize anything.
3205    VLOG(jdwp) << "No need for deoptimization when fully running with interpreter for method "
3206               << PrettyMethod(m);
3207    return DeoptimizationRequest::kNothing;
3208  }
3209  const Breakpoint* first_breakpoint;
3210  {
3211    ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3212    first_breakpoint = FindFirstBreakpointForMethod(m);
3213    *existing_brkpt = first_breakpoint;
3214  }
3215
3216  if (first_breakpoint == nullptr) {
3217    // There is no breakpoint on this method yet: we need to deoptimize. If this method may be
3218    // inlined, we deoptimize everything; otherwise we deoptimize only this method.
3219    // Note: IsMethodPossiblyInlined goes into the method verifier and may cause thread suspension.
3220    // Therefore we must not hold any lock when we call it.
3221    bool need_full_deoptimization = IsMethodPossiblyInlined(self, m);
3222    if (need_full_deoptimization) {
3223      VLOG(jdwp) << "Need full deoptimization because of possible inlining of method "
3224                 << PrettyMethod(m);
3225      return DeoptimizationRequest::kFullDeoptimization;
3226    } else {
3227      // We don't need to deoptimize if the method has not been compiled.
3228      ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
3229      const bool is_compiled = class_linker->GetOatMethodQuickCodeFor(m) != nullptr;
3230      if (is_compiled) {
3231        // If the method may be called through its direct code pointer (without loading
3232        // its updated entrypoint), we need full deoptimization to not miss the breakpoint.
3233        if (class_linker->MayBeCalledWithDirectCodePointer(m)) {
3234          VLOG(jdwp) << "Need full deoptimization because of possible direct code call "
3235                     << "into image for compiled method " << PrettyMethod(m);
3236          return DeoptimizationRequest::kFullDeoptimization;
3237        } else {
3238          VLOG(jdwp) << "Need selective deoptimization for compiled method " << PrettyMethod(m);
3239          return DeoptimizationRequest::kSelectiveDeoptimization;
3240        }
3241      } else {
3242        // Method is not compiled: we don't need to deoptimize.
3243        VLOG(jdwp) << "No need for deoptimization for non-compiled method " << PrettyMethod(m);
3244        return DeoptimizationRequest::kNothing;
3245      }
3246    }
3247  } else {
3248    // There is at least one breakpoint for this method: we don't need to deoptimize.
3249    // Let's check that all breakpoints are configured the same way for deoptimization.
3250    VLOG(jdwp) << "Breakpoint already set: no deoptimization is required";
3251    DeoptimizationRequest::Kind deoptimization_kind = first_breakpoint->GetDeoptimizationKind();
3252    if (kIsDebugBuild) {
3253      ReaderMutexLock mu(self, *Locks::breakpoint_lock_);
3254      SanityCheckExistingBreakpoints(m, deoptimization_kind);
3255    }
3256    return DeoptimizationRequest::kNothing;
3257  }
3258}
3259
3260// Installs a breakpoint at the specified location. Also indicates through the deoptimization
3261// request if we need to deoptimize.
3262void Dbg::WatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3263  Thread* const self = Thread::Current();
3264  mirror::ArtMethod* m = FromMethodId(location->method_id);
3265  DCHECK(m != nullptr) << "No method for method id " << location->method_id;
3266
3267  const Breakpoint* existing_breakpoint = nullptr;
3268  const DeoptimizationRequest::Kind deoptimization_kind =
3269      GetRequiredDeoptimizationKind(self, m, &existing_breakpoint);
3270  req->SetKind(deoptimization_kind);
3271  if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3272    req->SetMethod(m);
3273  } else {
3274    CHECK(deoptimization_kind == DeoptimizationRequest::kNothing ||
3275          deoptimization_kind == DeoptimizationRequest::kFullDeoptimization);
3276    req->SetMethod(nullptr);
3277  }
3278
3279  {
3280    WriterMutexLock mu(self, *Locks::breakpoint_lock_);
3281    // If there is at least one existing breakpoint on the same method, the new breakpoint
3282    // must have the same deoptimization kind than the existing breakpoint(s).
3283    DeoptimizationRequest::Kind breakpoint_deoptimization_kind;
3284    if (existing_breakpoint != nullptr) {
3285      breakpoint_deoptimization_kind = existing_breakpoint->GetDeoptimizationKind();
3286    } else {
3287      breakpoint_deoptimization_kind = deoptimization_kind;
3288    }
3289    gBreakpoints.push_back(Breakpoint(m, location->dex_pc, breakpoint_deoptimization_kind));
3290    VLOG(jdwp) << "Set breakpoint #" << (gBreakpoints.size() - 1) << ": "
3291               << gBreakpoints[gBreakpoints.size() - 1];
3292  }
3293}
3294
3295// Uninstalls a breakpoint at the specified location. Also indicates through the deoptimization
3296// request if we need to undeoptimize.
3297void Dbg::UnwatchLocation(const JDWP::JdwpLocation* location, DeoptimizationRequest* req) {
3298  WriterMutexLock mu(Thread::Current(), *Locks::breakpoint_lock_);
3299  mirror::ArtMethod* m = FromMethodId(location->method_id);
3300  DCHECK(m != nullptr) << "No method for method id " << location->method_id;
3301  DeoptimizationRequest::Kind deoptimization_kind = DeoptimizationRequest::kNothing;
3302  for (size_t i = 0, e = gBreakpoints.size(); i < e; ++i) {
3303    if (gBreakpoints[i].DexPc() == location->dex_pc && gBreakpoints[i].Method() == m) {
3304      VLOG(jdwp) << "Removed breakpoint #" << i << ": " << gBreakpoints[i];
3305      deoptimization_kind = gBreakpoints[i].GetDeoptimizationKind();
3306      DCHECK_EQ(deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization,
3307                Runtime::Current()->GetInstrumentation()->IsDeoptimized(m));
3308      gBreakpoints.erase(gBreakpoints.begin() + i);
3309      break;
3310    }
3311  }
3312  const Breakpoint* const existing_breakpoint = FindFirstBreakpointForMethod(m);
3313  if (existing_breakpoint == nullptr) {
3314    // There is no more breakpoint on this method: we need to undeoptimize.
3315    if (deoptimization_kind == DeoptimizationRequest::kFullDeoptimization) {
3316      // This method required full deoptimization: we need to undeoptimize everything.
3317      req->SetKind(DeoptimizationRequest::kFullUndeoptimization);
3318      req->SetMethod(nullptr);
3319    } else if (deoptimization_kind == DeoptimizationRequest::kSelectiveDeoptimization) {
3320      // This method required selective deoptimization: we need to undeoptimize only that method.
3321      req->SetKind(DeoptimizationRequest::kSelectiveUndeoptimization);
3322      req->SetMethod(m);
3323    } else {
3324      // This method had no need for deoptimization: do nothing.
3325      CHECK_EQ(deoptimization_kind, DeoptimizationRequest::kNothing);
3326      req->SetKind(DeoptimizationRequest::kNothing);
3327      req->SetMethod(nullptr);
3328    }
3329  } else {
3330    // There is at least one breakpoint for this method: we don't need to undeoptimize.
3331    req->SetKind(DeoptimizationRequest::kNothing);
3332    req->SetMethod(nullptr);
3333    if (kIsDebugBuild) {
3334      SanityCheckExistingBreakpoints(m, deoptimization_kind);
3335    }
3336  }
3337}
3338
3339bool Dbg::IsForcedInterpreterNeededForCallingImpl(Thread* thread, mirror::ArtMethod* m) {
3340  const SingleStepControl* const ssc = thread->GetSingleStepControl();
3341  if (ssc == nullptr) {
3342    // If we are not single-stepping, then we don't have to force interpreter.
3343    return false;
3344  }
3345  if (Runtime::Current()->GetInstrumentation()->InterpretOnly()) {
3346    // If we are in interpreter only mode, then we don't have to force interpreter.
3347    return false;
3348  }
3349
3350  if (!m->IsNative() && !m->IsProxyMethod()) {
3351    // If we want to step into a method, then we have to force interpreter on that call.
3352    if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3353      return true;
3354    }
3355  }
3356  return false;
3357}
3358
3359bool Dbg::IsForcedInterpreterNeededForResolutionImpl(Thread* thread, mirror::ArtMethod* m) {
3360  instrumentation::Instrumentation* const instrumentation =
3361      Runtime::Current()->GetInstrumentation();
3362  // If we are in interpreter only mode, then we don't have to force interpreter.
3363  if (instrumentation->InterpretOnly()) {
3364    return false;
3365  }
3366  // We can only interpret pure Java method.
3367  if (m->IsNative() || m->IsProxyMethod()) {
3368    return false;
3369  }
3370  const SingleStepControl* const ssc = thread->GetSingleStepControl();
3371  if (ssc != nullptr) {
3372    // If we want to step into a method, then we have to force interpreter on that call.
3373    if (ssc->GetStepDepth() == JDWP::SD_INTO) {
3374      return true;
3375    }
3376    // If we are stepping out from a static initializer, by issuing a step
3377    // in or step over, that was implicitly invoked by calling a static method,
3378    // then we need to step into that method. Having a lower stack depth than
3379    // the one the single step control has indicates that the step originates
3380    // from the static initializer.
3381    if (ssc->GetStepDepth() != JDWP::SD_OUT &&
3382        ssc->GetStackDepth() > GetStackDepth(thread)) {
3383      return true;
3384    }
3385  }
3386  // There are cases where we have to force interpreter on deoptimized methods,
3387  // because in some cases the call will not be performed by invoking an entry
3388  // point that has been replaced by the deoptimization, but instead by directly
3389  // invoking the compiled code of the method, for example.
3390  return instrumentation->IsDeoptimized(m);
3391}
3392
3393bool Dbg::IsForcedInstrumentationNeededForResolutionImpl(Thread* thread, mirror::ArtMethod* m) {
3394  // The upcall can be null and in that case we don't need to do anything.
3395  if (m == nullptr) {
3396    return false;
3397  }
3398  instrumentation::Instrumentation* const instrumentation =
3399      Runtime::Current()->GetInstrumentation();
3400  // If we are in interpreter only mode, then we don't have to force interpreter.
3401  if (instrumentation->InterpretOnly()) {
3402    return false;
3403  }
3404  // We can only interpret pure Java method.
3405  if (m->IsNative() || m->IsProxyMethod()) {
3406    return false;
3407  }
3408  const SingleStepControl* const ssc = thread->GetSingleStepControl();
3409  if (ssc != nullptr) {
3410    // If we are stepping out from a static initializer, by issuing a step
3411    // out, that was implicitly invoked by calling a static method, then we
3412    // need to step into the caller of that method. Having a lower stack
3413    // depth than the one the single step control has indicates that the
3414    // step originates from the static initializer.
3415    if (ssc->GetStepDepth() == JDWP::SD_OUT &&
3416        ssc->GetStackDepth() > GetStackDepth(thread)) {
3417      return true;
3418    }
3419  }
3420  // If we are returning from a static intializer, that was implicitly
3421  // invoked by calling a static method and the caller is deoptimized,
3422  // then we have to deoptimize the stack without forcing interpreter
3423  // on the static method that was called originally. This problem can
3424  // be solved easily by forcing instrumentation on the called method,
3425  // because the instrumentation exit hook will recognise the need of
3426  // stack deoptimization by calling IsForcedInterpreterNeededForUpcall.
3427  return instrumentation->IsDeoptimized(m);
3428}
3429
3430bool Dbg::IsForcedInterpreterNeededForUpcallImpl(Thread* thread, mirror::ArtMethod* m) {
3431  // The upcall can be null and in that case we don't need to do anything.
3432  if (m == nullptr) {
3433    return false;
3434  }
3435  instrumentation::Instrumentation* const instrumentation =
3436      Runtime::Current()->GetInstrumentation();
3437  // If we are in interpreter only mode, then we don't have to force interpreter.
3438  if (instrumentation->InterpretOnly()) {
3439    return false;
3440  }
3441  // We can only interpret pure Java method.
3442  if (m->IsNative() || m->IsProxyMethod()) {
3443    return false;
3444  }
3445  const SingleStepControl* const ssc = thread->GetSingleStepControl();
3446  if (ssc != nullptr) {
3447    // The debugger is not interested in what is happening under the level
3448    // of the step, thus we only force interpreter when we are not below of
3449    // the step.
3450    if (ssc->GetStackDepth() >= GetStackDepth(thread)) {
3451      return true;
3452    }
3453  }
3454  // We have to require stack deoptimization if the upcall is deoptimized.
3455  return instrumentation->IsDeoptimized(m);
3456}
3457
3458// Scoped utility class to suspend a thread so that we may do tasks such as walk its stack. Doesn't
3459// cause suspension if the thread is the current thread.
3460class ScopedThreadSuspension {
3461 public:
3462  ScopedThreadSuspension(Thread* self, JDWP::ObjectId thread_id)
3463      LOCKS_EXCLUDED(Locks::thread_list_lock_)
3464      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) :
3465      thread_(nullptr),
3466      error_(JDWP::ERR_NONE),
3467      self_suspend_(false),
3468      other_suspend_(false) {
3469    ScopedObjectAccessUnchecked soa(self);
3470    thread_ = DecodeThread(soa, thread_id, &error_);
3471    if (error_ == JDWP::ERR_NONE) {
3472      if (thread_ == soa.Self()) {
3473        self_suspend_ = true;
3474      } else {
3475        soa.Self()->TransitionFromRunnableToSuspended(kWaitingForDebuggerSuspension);
3476        jobject thread_peer = Dbg::GetObjectRegistry()->GetJObject(thread_id);
3477        bool timed_out;
3478        ThreadList* thread_list = Runtime::Current()->GetThreadList();
3479        Thread* suspended_thread = thread_list->SuspendThreadByPeer(thread_peer, true, true,
3480                                                                    &timed_out);
3481        CHECK_EQ(soa.Self()->TransitionFromSuspendedToRunnable(), kWaitingForDebuggerSuspension);
3482        if (suspended_thread == nullptr) {
3483          // Thread terminated from under us while suspending.
3484          error_ = JDWP::ERR_INVALID_THREAD;
3485        } else {
3486          CHECK_EQ(suspended_thread, thread_);
3487          other_suspend_ = true;
3488        }
3489      }
3490    }
3491  }
3492
3493  Thread* GetThread() const {
3494    return thread_;
3495  }
3496
3497  JDWP::JdwpError GetError() const {
3498    return error_;
3499  }
3500
3501  ~ScopedThreadSuspension() {
3502    if (other_suspend_) {
3503      Runtime::Current()->GetThreadList()->Resume(thread_, true);
3504    }
3505  }
3506
3507 private:
3508  Thread* thread_;
3509  JDWP::JdwpError error_;
3510  bool self_suspend_;
3511  bool other_suspend_;
3512};
3513
3514JDWP::JdwpError Dbg::ConfigureStep(JDWP::ObjectId thread_id, JDWP::JdwpStepSize step_size,
3515                                   JDWP::JdwpStepDepth step_depth) {
3516  Thread* self = Thread::Current();
3517  ScopedThreadSuspension sts(self, thread_id);
3518  if (sts.GetError() != JDWP::ERR_NONE) {
3519    return sts.GetError();
3520  }
3521
3522  // Work out what ArtMethod* we're in, the current line number, and how deep the stack currently
3523  // is for step-out.
3524  struct SingleStepStackVisitor : public StackVisitor {
3525    explicit SingleStepStackVisitor(Thread* thread) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
3526        : StackVisitor(thread, nullptr), stack_depth(0), method(nullptr), line_number(-1) {
3527    }
3528
3529    // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
3530    // annotalysis.
3531    bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
3532      mirror::ArtMethod* m = GetMethod();
3533      if (!m->IsRuntimeMethod()) {
3534        ++stack_depth;
3535        if (method == nullptr) {
3536          mirror::DexCache* dex_cache = m->GetDeclaringClass()->GetDexCache();
3537          method = m;
3538          if (dex_cache != nullptr) {
3539            const DexFile& dex_file = *dex_cache->GetDexFile();
3540            line_number = dex_file.GetLineNumFromPC(m, GetDexPc());
3541          }
3542        }
3543      }
3544      return true;
3545    }
3546
3547    int stack_depth;
3548    mirror::ArtMethod* method;
3549    int32_t line_number;
3550  };
3551
3552  Thread* const thread = sts.GetThread();
3553  SingleStepStackVisitor visitor(thread);
3554  visitor.WalkStack();
3555
3556  // Find the dex_pc values that correspond to the current line, for line-based single-stepping.
3557  struct DebugCallbackContext {
3558    explicit DebugCallbackContext(SingleStepControl* single_step_control_cb,
3559                                  int32_t line_number_cb, const DexFile::CodeItem* code_item)
3560      : single_step_control_(single_step_control_cb), line_number_(line_number_cb),
3561        code_item_(code_item), last_pc_valid(false), last_pc(0) {
3562    }
3563
3564    static bool Callback(void* raw_context, uint32_t address, uint32_t line_number_cb) {
3565      DebugCallbackContext* context = reinterpret_cast<DebugCallbackContext*>(raw_context);
3566      if (static_cast<int32_t>(line_number_cb) == context->line_number_) {
3567        if (!context->last_pc_valid) {
3568          // Everything from this address until the next line change is ours.
3569          context->last_pc = address;
3570          context->last_pc_valid = true;
3571        }
3572        // Otherwise, if we're already in a valid range for this line,
3573        // just keep going (shouldn't really happen)...
3574      } else if (context->last_pc_valid) {  // and the line number is new
3575        // Add everything from the last entry up until here to the set
3576        for (uint32_t dex_pc = context->last_pc; dex_pc < address; ++dex_pc) {
3577          context->single_step_control_->AddDexPc(dex_pc);
3578        }
3579        context->last_pc_valid = false;
3580      }
3581      return false;  // There may be multiple entries for any given line.
3582    }
3583
3584    ~DebugCallbackContext() {
3585      // If the line number was the last in the position table...
3586      if (last_pc_valid) {
3587        size_t end = code_item_->insns_size_in_code_units_;
3588        for (uint32_t dex_pc = last_pc; dex_pc < end; ++dex_pc) {
3589          single_step_control_->AddDexPc(dex_pc);
3590        }
3591      }
3592    }
3593
3594    SingleStepControl* const single_step_control_;
3595    const int32_t line_number_;
3596    const DexFile::CodeItem* const code_item_;
3597    bool last_pc_valid;
3598    uint32_t last_pc;
3599  };
3600
3601  // Allocate single step.
3602  SingleStepControl* single_step_control =
3603      new (std::nothrow) SingleStepControl(step_size, step_depth,
3604                                           visitor.stack_depth, visitor.method);
3605  if (single_step_control == nullptr) {
3606    LOG(ERROR) << "Failed to allocate SingleStepControl";
3607    return JDWP::ERR_OUT_OF_MEMORY;
3608  }
3609
3610  mirror::ArtMethod* m = single_step_control->GetMethod();
3611  const int32_t line_number = visitor.line_number;
3612  if (!m->IsNative()) {
3613    const DexFile::CodeItem* const code_item = m->GetCodeItem();
3614    DebugCallbackContext context(single_step_control, line_number, code_item);
3615    m->GetDexFile()->DecodeDebugInfo(code_item, m->IsStatic(), m->GetDexMethodIndex(),
3616                                     DebugCallbackContext::Callback, nullptr, &context);
3617  }
3618
3619  // Activate single-step in the thread.
3620  thread->ActivateSingleStepControl(single_step_control);
3621
3622  if (VLOG_IS_ON(jdwp)) {
3623    VLOG(jdwp) << "Single-step thread: " << *thread;
3624    VLOG(jdwp) << "Single-step step size: " << single_step_control->GetStepSize();
3625    VLOG(jdwp) << "Single-step step depth: " << single_step_control->GetStepDepth();
3626    VLOG(jdwp) << "Single-step current method: " << PrettyMethod(single_step_control->GetMethod());
3627    VLOG(jdwp) << "Single-step current line: " << line_number;
3628    VLOG(jdwp) << "Single-step current stack depth: " << single_step_control->GetStackDepth();
3629    VLOG(jdwp) << "Single-step dex_pc values:";
3630    for (uint32_t dex_pc : single_step_control->GetDexPcs()) {
3631      VLOG(jdwp) << StringPrintf(" %#x", dex_pc);
3632    }
3633  }
3634
3635  return JDWP::ERR_NONE;
3636}
3637
3638void Dbg::UnconfigureStep(JDWP::ObjectId thread_id) {
3639  ScopedObjectAccessUnchecked soa(Thread::Current());
3640  JDWP::JdwpError error;
3641  Thread* thread = DecodeThread(soa, thread_id, &error);
3642  if (error == JDWP::ERR_NONE) {
3643    thread->DeactivateSingleStepControl();
3644  }
3645}
3646
3647static char JdwpTagToShortyChar(JDWP::JdwpTag tag) {
3648  switch (tag) {
3649    default:
3650      LOG(FATAL) << "unknown JDWP tag: " << PrintableChar(tag);
3651      UNREACHABLE();
3652
3653    // Primitives.
3654    case JDWP::JT_BYTE:    return 'B';
3655    case JDWP::JT_CHAR:    return 'C';
3656    case JDWP::JT_FLOAT:   return 'F';
3657    case JDWP::JT_DOUBLE:  return 'D';
3658    case JDWP::JT_INT:     return 'I';
3659    case JDWP::JT_LONG:    return 'J';
3660    case JDWP::JT_SHORT:   return 'S';
3661    case JDWP::JT_VOID:    return 'V';
3662    case JDWP::JT_BOOLEAN: return 'Z';
3663
3664    // Reference types.
3665    case JDWP::JT_ARRAY:
3666    case JDWP::JT_OBJECT:
3667    case JDWP::JT_STRING:
3668    case JDWP::JT_THREAD:
3669    case JDWP::JT_THREAD_GROUP:
3670    case JDWP::JT_CLASS_LOADER:
3671    case JDWP::JT_CLASS_OBJECT:
3672      return 'L';
3673  }
3674}
3675
3676JDWP::JdwpError Dbg::InvokeMethod(JDWP::ObjectId thread_id, JDWP::ObjectId object_id,
3677                                  JDWP::RefTypeId class_id, JDWP::MethodId method_id,
3678                                  uint32_t arg_count, uint64_t* arg_values,
3679                                  JDWP::JdwpTag* arg_types, uint32_t options,
3680                                  JDWP::JdwpTag* pResultTag, uint64_t* pResultValue,
3681                                  JDWP::ObjectId* pExceptionId) {
3682  ThreadList* thread_list = Runtime::Current()->GetThreadList();
3683
3684  Thread* targetThread = nullptr;
3685  std::unique_ptr<DebugInvokeReq> req;
3686  Thread* self = Thread::Current();
3687  {
3688    ScopedObjectAccessUnchecked soa(self);
3689    JDWP::JdwpError error;
3690    targetThread = DecodeThread(soa, thread_id, &error);
3691    if (error != JDWP::ERR_NONE) {
3692      LOG(ERROR) << "InvokeMethod request for invalid thread id " << thread_id;
3693      return error;
3694    }
3695    if (targetThread->GetInvokeReq() != nullptr) {
3696      // Thread is already invoking a method on behalf of the debugger.
3697      LOG(ERROR) << "InvokeMethod request for thread already invoking a method: " << *targetThread;
3698      return JDWP::ERR_ALREADY_INVOKING;
3699    }
3700    if (!targetThread->IsReadyForDebugInvoke()) {
3701      // Thread is not suspended by an event so it cannot invoke a method.
3702      LOG(ERROR) << "InvokeMethod request for thread not stopped by event: " << *targetThread;
3703      return JDWP::ERR_INVALID_THREAD;
3704    }
3705
3706    /*
3707     * We currently have a bug where we don't successfully resume the
3708     * target thread if the suspend count is too deep.  We're expected to
3709     * require one "resume" for each "suspend", but when asked to execute
3710     * a method we have to resume fully and then re-suspend it back to the
3711     * same level.  (The easiest way to cause this is to type "suspend"
3712     * multiple times in jdb.)
3713     *
3714     * It's unclear what this means when the event specifies "resume all"
3715     * and some threads are suspended more deeply than others.  This is
3716     * a rare problem, so for now we just prevent it from hanging forever
3717     * by rejecting the method invocation request.  Without this, we will
3718     * be stuck waiting on a suspended thread.
3719     */
3720    int suspend_count;
3721    {
3722      MutexLock mu2(soa.Self(), *Locks::thread_suspend_count_lock_);
3723      suspend_count = targetThread->GetSuspendCount();
3724    }
3725    if (suspend_count > 1) {
3726      LOG(ERROR) << *targetThread << " suspend count too deep for method invocation: " << suspend_count;
3727      return JDWP::ERR_THREAD_SUSPENDED;  // Probably not expected here.
3728    }
3729
3730    mirror::Object* receiver = gRegistry->Get<mirror::Object*>(object_id, &error);
3731    if (error != JDWP::ERR_NONE) {
3732      return JDWP::ERR_INVALID_OBJECT;
3733    }
3734
3735    gRegistry->Get<mirror::Object*>(thread_id, &error);
3736    if (error != JDWP::ERR_NONE) {
3737      return JDWP::ERR_INVALID_OBJECT;
3738    }
3739
3740    mirror::Class* c = DecodeClass(class_id, &error);
3741    if (c == nullptr) {
3742      return error;
3743    }
3744
3745    mirror::ArtMethod* m = FromMethodId(method_id);
3746    if (m->IsStatic() != (receiver == nullptr)) {
3747      return JDWP::ERR_INVALID_METHODID;
3748    }
3749    if (m->IsStatic()) {
3750      if (m->GetDeclaringClass() != c) {
3751        return JDWP::ERR_INVALID_METHODID;
3752      }
3753    } else {
3754      if (!m->GetDeclaringClass()->IsAssignableFrom(c)) {
3755        return JDWP::ERR_INVALID_METHODID;
3756      }
3757    }
3758
3759    // Check the argument list matches the method.
3760    uint32_t shorty_len = 0;
3761    const char* shorty = m->GetShorty(&shorty_len);
3762    if (shorty_len - 1 != arg_count) {
3763      return JDWP::ERR_ILLEGAL_ARGUMENT;
3764    }
3765
3766    {
3767      StackHandleScope<3> hs(soa.Self());
3768      HandleWrapper<mirror::ArtMethod> h_m(hs.NewHandleWrapper(&m));
3769      HandleWrapper<mirror::Object> h_obj(hs.NewHandleWrapper(&receiver));
3770      HandleWrapper<mirror::Class> h_klass(hs.NewHandleWrapper(&c));
3771      const DexFile::TypeList* types = m->GetParameterTypeList();
3772      for (size_t i = 0; i < arg_count; ++i) {
3773        if (shorty[i + 1] != JdwpTagToShortyChar(arg_types[i])) {
3774          return JDWP::ERR_ILLEGAL_ARGUMENT;
3775        }
3776
3777        if (shorty[i + 1] == 'L') {
3778          // Did we really get an argument of an appropriate reference type?
3779          mirror::Class* parameter_type =
3780              h_m->GetClassFromTypeIndex(types->GetTypeItem(i).type_idx_, true);
3781          mirror::Object* argument = gRegistry->Get<mirror::Object*>(arg_values[i], &error);
3782          if (error != JDWP::ERR_NONE) {
3783            return JDWP::ERR_INVALID_OBJECT;
3784          }
3785          if (argument != nullptr && !argument->InstanceOf(parameter_type)) {
3786            return JDWP::ERR_ILLEGAL_ARGUMENT;
3787          }
3788
3789          // Turn the on-the-wire ObjectId into a jobject.
3790          jvalue& v = reinterpret_cast<jvalue&>(arg_values[i]);
3791          v.l = gRegistry->GetJObject(arg_values[i]);
3792        }
3793      }
3794    }
3795
3796    // Allocates a DebugInvokeReq.
3797    req.reset(new (std::nothrow) DebugInvokeReq(receiver, c, m, options, arg_values, arg_count));
3798    if (req.get() == nullptr) {
3799      LOG(ERROR) << "Failed to allocate DebugInvokeReq";
3800      return JDWP::ERR_OUT_OF_MEMORY;
3801    }
3802
3803    // Attach the DebugInvokeReq to the target thread so it executes the method when
3804    // it is resumed. Once the invocation completes, it will detach it and signal us
3805    // before suspending itself.
3806    targetThread->SetDebugInvokeReq(req.get());
3807  }
3808
3809  // The fact that we've released the thread list lock is a bit risky --- if the thread goes
3810  // away we're sitting high and dry -- but we must release this before the ResumeAllThreads
3811  // call, and it's unwise to hold it during WaitForSuspend.
3812
3813  {
3814    /*
3815     * We change our (JDWP thread) status, which should be THREAD_RUNNING,
3816     * so we can suspend for a GC if the invoke request causes us to
3817     * run out of memory.  It's also a good idea to change it before locking
3818     * the invokeReq mutex, although that should never be held for long.
3819     */
3820    self->TransitionFromRunnableToSuspended(kWaitingForDebuggerSend);
3821
3822    VLOG(jdwp) << "    Transferring control to event thread";
3823    {
3824      MutexLock mu(self, req->lock);
3825
3826      if ((options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
3827        VLOG(jdwp) << "      Resuming all threads";
3828        thread_list->UndoDebuggerSuspensions();
3829      } else {
3830        VLOG(jdwp) << "      Resuming event thread only";
3831        thread_list->Resume(targetThread, true);
3832      }
3833
3834      // The target thread is resumed but needs the JDWP token we're holding.
3835      // We release it now and will acquire it again when the invocation is
3836      // complete and the target thread suspends itself.
3837      gJdwpState->ReleaseJdwpTokenForCommand();
3838
3839      // Wait for the request to finish executing.
3840      while (targetThread->GetInvokeReq() != nullptr) {
3841        req->cond.Wait(self);
3842      }
3843    }
3844    VLOG(jdwp) << "    Control has returned from event thread";
3845
3846    /* wait for thread to re-suspend itself */
3847    SuspendThread(thread_id, false /* request_suspension */);
3848
3849    // Now the thread is suspended again, we can re-acquire the JDWP token.
3850    gJdwpState->AcquireJdwpTokenForCommand();
3851
3852    self->TransitionFromSuspendedToRunnable();
3853  }
3854
3855  /*
3856   * Suspend the threads.  We waited for the target thread to suspend
3857   * itself, so all we need to do is suspend the others.
3858   *
3859   * The SuspendAllForDebugger() call will double-suspend the event thread,
3860   * so we want to resume the target thread once to keep the books straight.
3861   */
3862  if ((options & JDWP::INVOKE_SINGLE_THREADED) == 0) {
3863    self->TransitionFromRunnableToSuspended(kWaitingForDebuggerSuspension);
3864    VLOG(jdwp) << "      Suspending all threads";
3865    thread_list->SuspendAllForDebugger();
3866    self->TransitionFromSuspendedToRunnable();
3867    VLOG(jdwp) << "      Resuming event thread to balance the count";
3868    thread_list->Resume(targetThread, true);
3869  }
3870
3871  // Copy the result.
3872  *pResultTag = req->result_tag;
3873  *pResultValue = req->result_value;
3874  *pExceptionId = req->exception;
3875  return req->error;
3876}
3877
3878void Dbg::ExecuteMethod(DebugInvokeReq* pReq) {
3879  ScopedObjectAccess soa(Thread::Current());
3880
3881  // We can be called while an exception is pending. We need
3882  // to preserve that across the method invocation.
3883  StackHandleScope<4> hs(soa.Self());
3884  auto old_exception = hs.NewHandle<mirror::Throwable>(soa.Self()->GetException());
3885  soa.Self()->ClearException();
3886
3887  // Translate the method through the vtable, unless the debugger wants to suppress it.
3888  MutableHandle<mirror::ArtMethod> m(hs.NewHandle(pReq->method.Read()));
3889  if ((pReq->options & JDWP::INVOKE_NONVIRTUAL) == 0 && pReq->receiver.Read() != nullptr) {
3890    mirror::ArtMethod* actual_method = pReq->klass.Read()->FindVirtualMethodForVirtualOrInterface(m.Get());
3891    if (actual_method != m.Get()) {
3892      VLOG(jdwp) << "ExecuteMethod translated " << PrettyMethod(m.Get())
3893                 << " to " << PrettyMethod(actual_method);
3894      m.Assign(actual_method);
3895    }
3896  }
3897  VLOG(jdwp) << "ExecuteMethod " << PrettyMethod(m.Get())
3898             << " receiver=" << pReq->receiver.Read()
3899             << " arg_count=" << pReq->arg_count;
3900  CHECK(m.Get() != nullptr);
3901
3902  CHECK_EQ(sizeof(jvalue), sizeof(uint64_t));
3903
3904  JValue result = InvokeWithJValues(soa, pReq->receiver.Read(), soa.EncodeMethod(m.Get()),
3905                                    reinterpret_cast<jvalue*>(pReq->arg_values));
3906
3907  pReq->result_tag = BasicTagFromDescriptor(m.Get()->GetShorty());
3908  const bool is_object_result = (pReq->result_tag == JDWP::JT_OBJECT);
3909  Handle<mirror::Object> object_result = hs.NewHandle(is_object_result ? result.GetL() : nullptr);
3910  Handle<mirror::Throwable> exception = hs.NewHandle(soa.Self()->GetException());
3911  soa.Self()->ClearException();
3912  pReq->exception = gRegistry->Add(exception.Get());
3913  if (pReq->exception != 0) {
3914    VLOG(jdwp) << "  JDWP invocation returning with exception=" << exception.Get()
3915               << " " << exception->Dump();
3916    pReq->result_value = 0;
3917  } else if (is_object_result) {
3918    /* if no exception thrown, examine object result more closely */
3919    JDWP::JdwpTag new_tag = TagFromObject(soa, object_result.Get());
3920    if (new_tag != pReq->result_tag) {
3921      VLOG(jdwp) << "  JDWP promoted result from " << pReq->result_tag << " to " << new_tag;
3922      pReq->result_tag = new_tag;
3923    }
3924
3925    // Register the object in the registry and reference its ObjectId. This ensures
3926    // GC safety and prevents from accessing stale reference if the object is moved.
3927    pReq->result_value = gRegistry->Add(object_result.Get());
3928  } else {
3929    // Primitive result.
3930    DCHECK(IsPrimitiveTag(pReq->result_tag));
3931    pReq->result_value = result.GetJ();
3932  }
3933
3934  if (old_exception.Get() != nullptr) {
3935    soa.Self()->SetException(old_exception.Get());
3936  }
3937}
3938
3939/*
3940 * "request" contains a full JDWP packet, possibly with multiple chunks.  We
3941 * need to process each, accumulate the replies, and ship the whole thing
3942 * back.
3943 *
3944 * Returns "true" if we have a reply.  The reply buffer is newly allocated,
3945 * and includes the chunk type/length, followed by the data.
3946 *
3947 * OLD-TODO: we currently assume that the request and reply include a single
3948 * chunk.  If this becomes inconvenient we will need to adapt.
3949 */
3950bool Dbg::DdmHandlePacket(JDWP::Request* request, uint8_t** pReplyBuf, int* pReplyLen) {
3951  Thread* self = Thread::Current();
3952  JNIEnv* env = self->GetJniEnv();
3953
3954  uint32_t type = request->ReadUnsigned32("type");
3955  uint32_t length = request->ReadUnsigned32("length");
3956
3957  // Create a byte[] corresponding to 'request'.
3958  size_t request_length = request->size();
3959  ScopedLocalRef<jbyteArray> dataArray(env, env->NewByteArray(request_length));
3960  if (dataArray.get() == nullptr) {
3961    LOG(WARNING) << "byte[] allocation failed: " << request_length;
3962    env->ExceptionClear();
3963    return false;
3964  }
3965  env->SetByteArrayRegion(dataArray.get(), 0, request_length,
3966                          reinterpret_cast<const jbyte*>(request->data()));
3967  request->Skip(request_length);
3968
3969  // Run through and find all chunks.  [Currently just find the first.]
3970  ScopedByteArrayRO contents(env, dataArray.get());
3971  if (length != request_length) {
3972    LOG(WARNING) << StringPrintf("bad chunk found (len=%u pktLen=%zd)", length, request_length);
3973    return false;
3974  }
3975
3976  // Call "private static Chunk dispatch(int type, byte[] data, int offset, int length)".
3977  ScopedLocalRef<jobject> chunk(env, env->CallStaticObjectMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
3978                                                                 WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_dispatch,
3979                                                                 type, dataArray.get(), 0, length));
3980  if (env->ExceptionCheck()) {
3981    LOG(INFO) << StringPrintf("Exception thrown by dispatcher for 0x%08x", type);
3982    env->ExceptionDescribe();
3983    env->ExceptionClear();
3984    return false;
3985  }
3986
3987  if (chunk.get() == nullptr) {
3988    return false;
3989  }
3990
3991  /*
3992   * Pull the pieces out of the chunk.  We copy the results into a
3993   * newly-allocated buffer that the caller can free.  We don't want to
3994   * continue using the Chunk object because nothing has a reference to it.
3995   *
3996   * We could avoid this by returning type/data/offset/length and having
3997   * the caller be aware of the object lifetime issues, but that
3998   * integrates the JDWP code more tightly into the rest of the runtime, and doesn't work
3999   * if we have responses for multiple chunks.
4000   *
4001   * So we're pretty much stuck with copying data around multiple times.
4002   */
4003  ScopedLocalRef<jbyteArray> replyData(env, reinterpret_cast<jbyteArray>(env->GetObjectField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_data)));
4004  jint offset = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_offset);
4005  length = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_length);
4006  type = env->GetIntField(chunk.get(), WellKnownClasses::org_apache_harmony_dalvik_ddmc_Chunk_type);
4007
4008  VLOG(jdwp) << StringPrintf("DDM reply: type=0x%08x data=%p offset=%d length=%d", type, replyData.get(), offset, length);
4009  if (length == 0 || replyData.get() == nullptr) {
4010    return false;
4011  }
4012
4013  const int kChunkHdrLen = 8;
4014  uint8_t* reply = new uint8_t[length + kChunkHdrLen];
4015  if (reply == nullptr) {
4016    LOG(WARNING) << "malloc failed: " << (length + kChunkHdrLen);
4017    return false;
4018  }
4019  JDWP::Set4BE(reply + 0, type);
4020  JDWP::Set4BE(reply + 4, length);
4021  env->GetByteArrayRegion(replyData.get(), offset, length, reinterpret_cast<jbyte*>(reply + kChunkHdrLen));
4022
4023  *pReplyBuf = reply;
4024  *pReplyLen = length + kChunkHdrLen;
4025
4026  VLOG(jdwp) << StringPrintf("dvmHandleDdm returning type=%.4s %p len=%d", reinterpret_cast<char*>(reply), reply, length);
4027  return true;
4028}
4029
4030void Dbg::DdmBroadcast(bool connect) {
4031  VLOG(jdwp) << "Broadcasting DDM " << (connect ? "connect" : "disconnect") << "...";
4032
4033  Thread* self = Thread::Current();
4034  if (self->GetState() != kRunnable) {
4035    LOG(ERROR) << "DDM broadcast in thread state " << self->GetState();
4036    /* try anyway? */
4037  }
4038
4039  JNIEnv* env = self->GetJniEnv();
4040  jint event = connect ? 1 /*DdmServer.CONNECTED*/ : 2 /*DdmServer.DISCONNECTED*/;
4041  env->CallStaticVoidMethod(WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer,
4042                            WellKnownClasses::org_apache_harmony_dalvik_ddmc_DdmServer_broadcast,
4043                            event);
4044  if (env->ExceptionCheck()) {
4045    LOG(ERROR) << "DdmServer.broadcast " << event << " failed";
4046    env->ExceptionDescribe();
4047    env->ExceptionClear();
4048  }
4049}
4050
4051void Dbg::DdmConnected() {
4052  Dbg::DdmBroadcast(true);
4053}
4054
4055void Dbg::DdmDisconnected() {
4056  Dbg::DdmBroadcast(false);
4057  gDdmThreadNotification = false;
4058}
4059
4060/*
4061 * Send a notification when a thread starts, stops, or changes its name.
4062 *
4063 * Because we broadcast the full set of threads when the notifications are
4064 * first enabled, it's possible for "thread" to be actively executing.
4065 */
4066void Dbg::DdmSendThreadNotification(Thread* t, uint32_t type) {
4067  if (!gDdmThreadNotification) {
4068    return;
4069  }
4070
4071  if (type == CHUNK_TYPE("THDE")) {
4072    uint8_t buf[4];
4073    JDWP::Set4BE(&buf[0], t->GetThreadId());
4074    Dbg::DdmSendChunk(CHUNK_TYPE("THDE"), 4, buf);
4075  } else {
4076    CHECK(type == CHUNK_TYPE("THCR") || type == CHUNK_TYPE("THNM")) << type;
4077    ScopedObjectAccessUnchecked soa(Thread::Current());
4078    StackHandleScope<1> hs(soa.Self());
4079    Handle<mirror::String> name(hs.NewHandle(t->GetThreadName(soa)));
4080    size_t char_count = (name.Get() != nullptr) ? name->GetLength() : 0;
4081    const jchar* chars = (name.Get() != nullptr) ? name->GetCharArray()->GetData() : nullptr;
4082
4083    std::vector<uint8_t> bytes;
4084    JDWP::Append4BE(bytes, t->GetThreadId());
4085    JDWP::AppendUtf16BE(bytes, chars, char_count);
4086    CHECK_EQ(bytes.size(), char_count*2 + sizeof(uint32_t)*2);
4087    Dbg::DdmSendChunk(type, bytes);
4088  }
4089}
4090
4091void Dbg::DdmSetThreadNotification(bool enable) {
4092  // Enable/disable thread notifications.
4093  gDdmThreadNotification = enable;
4094  if (enable) {
4095    // Suspend the VM then post thread start notifications for all threads. Threads attaching will
4096    // see a suspension in progress and block until that ends. They then post their own start
4097    // notification.
4098    SuspendVM();
4099    std::list<Thread*> threads;
4100    Thread* self = Thread::Current();
4101    {
4102      MutexLock mu(self, *Locks::thread_list_lock_);
4103      threads = Runtime::Current()->GetThreadList()->GetList();
4104    }
4105    {
4106      ScopedObjectAccess soa(self);
4107      for (Thread* thread : threads) {
4108        Dbg::DdmSendThreadNotification(thread, CHUNK_TYPE("THCR"));
4109      }
4110    }
4111    ResumeVM();
4112  }
4113}
4114
4115void Dbg::PostThreadStartOrStop(Thread* t, uint32_t type) {
4116  if (IsDebuggerActive()) {
4117    gJdwpState->PostThreadChange(t, type == CHUNK_TYPE("THCR"));
4118  }
4119  Dbg::DdmSendThreadNotification(t, type);
4120}
4121
4122void Dbg::PostThreadStart(Thread* t) {
4123  Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THCR"));
4124}
4125
4126void Dbg::PostThreadDeath(Thread* t) {
4127  Dbg::PostThreadStartOrStop(t, CHUNK_TYPE("THDE"));
4128}
4129
4130void Dbg::DdmSendChunk(uint32_t type, size_t byte_count, const uint8_t* buf) {
4131  CHECK(buf != nullptr);
4132  iovec vec[1];
4133  vec[0].iov_base = reinterpret_cast<void*>(const_cast<uint8_t*>(buf));
4134  vec[0].iov_len = byte_count;
4135  Dbg::DdmSendChunkV(type, vec, 1);
4136}
4137
4138void Dbg::DdmSendChunk(uint32_t type, const std::vector<uint8_t>& bytes) {
4139  DdmSendChunk(type, bytes.size(), &bytes[0]);
4140}
4141
4142void Dbg::DdmSendChunkV(uint32_t type, const iovec* iov, int iov_count) {
4143  if (gJdwpState == nullptr) {
4144    VLOG(jdwp) << "Debugger thread not active, ignoring DDM send: " << type;
4145  } else {
4146    gJdwpState->DdmSendChunkV(type, iov, iov_count);
4147  }
4148}
4149
4150JDWP::JdwpState* Dbg::GetJdwpState() {
4151  return gJdwpState;
4152}
4153
4154int Dbg::DdmHandleHpifChunk(HpifWhen when) {
4155  if (when == HPIF_WHEN_NOW) {
4156    DdmSendHeapInfo(when);
4157    return true;
4158  }
4159
4160  if (when != HPIF_WHEN_NEVER && when != HPIF_WHEN_NEXT_GC && when != HPIF_WHEN_EVERY_GC) {
4161    LOG(ERROR) << "invalid HpifWhen value: " << static_cast<int>(when);
4162    return false;
4163  }
4164
4165  gDdmHpifWhen = when;
4166  return true;
4167}
4168
4169bool Dbg::DdmHandleHpsgNhsgChunk(Dbg::HpsgWhen when, Dbg::HpsgWhat what, bool native) {
4170  if (when != HPSG_WHEN_NEVER && when != HPSG_WHEN_EVERY_GC) {
4171    LOG(ERROR) << "invalid HpsgWhen value: " << static_cast<int>(when);
4172    return false;
4173  }
4174
4175  if (what != HPSG_WHAT_MERGED_OBJECTS && what != HPSG_WHAT_DISTINCT_OBJECTS) {
4176    LOG(ERROR) << "invalid HpsgWhat value: " << static_cast<int>(what);
4177    return false;
4178  }
4179
4180  if (native) {
4181    gDdmNhsgWhen = when;
4182    gDdmNhsgWhat = what;
4183  } else {
4184    gDdmHpsgWhen = when;
4185    gDdmHpsgWhat = what;
4186  }
4187  return true;
4188}
4189
4190void Dbg::DdmSendHeapInfo(HpifWhen reason) {
4191  // If there's a one-shot 'when', reset it.
4192  if (reason == gDdmHpifWhen) {
4193    if (gDdmHpifWhen == HPIF_WHEN_NEXT_GC) {
4194      gDdmHpifWhen = HPIF_WHEN_NEVER;
4195    }
4196  }
4197
4198  /*
4199   * Chunk HPIF (client --> server)
4200   *
4201   * Heap Info. General information about the heap,
4202   * suitable for a summary display.
4203   *
4204   *   [u4]: number of heaps
4205   *
4206   *   For each heap:
4207   *     [u4]: heap ID
4208   *     [u8]: timestamp in ms since Unix epoch
4209   *     [u1]: capture reason (same as 'when' value from server)
4210   *     [u4]: max heap size in bytes (-Xmx)
4211   *     [u4]: current heap size in bytes
4212   *     [u4]: current number of bytes allocated
4213   *     [u4]: current number of objects allocated
4214   */
4215  uint8_t heap_count = 1;
4216  gc::Heap* heap = Runtime::Current()->GetHeap();
4217  std::vector<uint8_t> bytes;
4218  JDWP::Append4BE(bytes, heap_count);
4219  JDWP::Append4BE(bytes, 1);  // Heap id (bogus; we only have one heap).
4220  JDWP::Append8BE(bytes, MilliTime());
4221  JDWP::Append1BE(bytes, reason);
4222  JDWP::Append4BE(bytes, heap->GetMaxMemory());  // Max allowed heap size in bytes.
4223  JDWP::Append4BE(bytes, heap->GetTotalMemory());  // Current heap size in bytes.
4224  JDWP::Append4BE(bytes, heap->GetBytesAllocated());
4225  JDWP::Append4BE(bytes, heap->GetObjectsAllocated());
4226  CHECK_EQ(bytes.size(), 4U + (heap_count * (4 + 8 + 1 + 4 + 4 + 4 + 4)));
4227  Dbg::DdmSendChunk(CHUNK_TYPE("HPIF"), bytes);
4228}
4229
4230enum HpsgSolidity {
4231  SOLIDITY_FREE = 0,
4232  SOLIDITY_HARD = 1,
4233  SOLIDITY_SOFT = 2,
4234  SOLIDITY_WEAK = 3,
4235  SOLIDITY_PHANTOM = 4,
4236  SOLIDITY_FINALIZABLE = 5,
4237  SOLIDITY_SWEEP = 6,
4238};
4239
4240enum HpsgKind {
4241  KIND_OBJECT = 0,
4242  KIND_CLASS_OBJECT = 1,
4243  KIND_ARRAY_1 = 2,
4244  KIND_ARRAY_2 = 3,
4245  KIND_ARRAY_4 = 4,
4246  KIND_ARRAY_8 = 5,
4247  KIND_UNKNOWN = 6,
4248  KIND_NATIVE = 7,
4249};
4250
4251#define HPSG_PARTIAL (1<<7)
4252#define HPSG_STATE(solidity, kind) ((uint8_t)((((kind) & 0x7) << 3) | ((solidity) & 0x7)))
4253
4254class HeapChunkContext {
4255 public:
4256  // Maximum chunk size.  Obtain this from the formula:
4257  // (((maximum_heap_size / ALLOCATION_UNIT_SIZE) + 255) / 256) * 2
4258  HeapChunkContext(bool merge, bool native)
4259      : buf_(16384 - 16),
4260        type_(0),
4261        chunk_overhead_(0) {
4262    Reset();
4263    if (native) {
4264      type_ = CHUNK_TYPE("NHSG");
4265    } else {
4266      type_ = merge ? CHUNK_TYPE("HPSG") : CHUNK_TYPE("HPSO");
4267    }
4268  }
4269
4270  ~HeapChunkContext() {
4271    if (p_ > &buf_[0]) {
4272      Flush();
4273    }
4274  }
4275
4276  void SetChunkOverhead(size_t chunk_overhead) {
4277    chunk_overhead_ = chunk_overhead;
4278  }
4279
4280  void ResetStartOfNextChunk() {
4281    startOfNextMemoryChunk_ = nullptr;
4282  }
4283
4284  void EnsureHeader(const void* chunk_ptr) {
4285    if (!needHeader_) {
4286      return;
4287    }
4288
4289    // Start a new HPSx chunk.
4290    JDWP::Write4BE(&p_, 1);  // Heap id (bogus; we only have one heap).
4291    JDWP::Write1BE(&p_, 8);  // Size of allocation unit, in bytes.
4292
4293    JDWP::Write4BE(&p_, reinterpret_cast<uintptr_t>(chunk_ptr));  // virtual address of segment start.
4294    JDWP::Write4BE(&p_, 0);  // offset of this piece (relative to the virtual address).
4295    // [u4]: length of piece, in allocation units
4296    // We won't know this until we're done, so save the offset and stuff in a dummy value.
4297    pieceLenField_ = p_;
4298    JDWP::Write4BE(&p_, 0x55555555);
4299    needHeader_ = false;
4300  }
4301
4302  void Flush() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4303    if (pieceLenField_ == nullptr) {
4304      // Flush immediately post Reset (maybe back-to-back Flush). Ignore.
4305      CHECK(needHeader_);
4306      return;
4307    }
4308    // Patch the "length of piece" field.
4309    CHECK_LE(&buf_[0], pieceLenField_);
4310    CHECK_LE(pieceLenField_, p_);
4311    JDWP::Set4BE(pieceLenField_, totalAllocationUnits_);
4312
4313    Dbg::DdmSendChunk(type_, p_ - &buf_[0], &buf_[0]);
4314    Reset();
4315  }
4316
4317  static void HeapChunkJavaCallback(void* start, void* end, size_t used_bytes, void* arg)
4318      SHARED_LOCKS_REQUIRED(Locks::heap_bitmap_lock_,
4319                            Locks::mutator_lock_) {
4320    reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkJavaCallback(start, end, used_bytes);
4321  }
4322
4323  static void HeapChunkNativeCallback(void* start, void* end, size_t used_bytes, void* arg)
4324      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4325    reinterpret_cast<HeapChunkContext*>(arg)->HeapChunkNativeCallback(start, end, used_bytes);
4326  }
4327
4328 private:
4329  enum { ALLOCATION_UNIT_SIZE = 8 };
4330
4331  void Reset() {
4332    p_ = &buf_[0];
4333    ResetStartOfNextChunk();
4334    totalAllocationUnits_ = 0;
4335    needHeader_ = true;
4336    pieceLenField_ = nullptr;
4337  }
4338
4339  bool IsNative() const {
4340    return type_ == CHUNK_TYPE("NHSG");
4341  }
4342
4343  // Returns true if the object is not an empty chunk.
4344  bool ProcessRecord(void* start, size_t used_bytes) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4345    // Note: heap call backs cannot manipulate the heap upon which they are crawling, care is taken
4346    // in the following code not to allocate memory, by ensuring buf_ is of the correct size
4347    if (used_bytes == 0) {
4348      if (start == nullptr) {
4349        // Reset for start of new heap.
4350        startOfNextMemoryChunk_ = nullptr;
4351        Flush();
4352      }
4353      // Only process in use memory so that free region information
4354      // also includes dlmalloc book keeping.
4355      return false;
4356    }
4357    if (startOfNextMemoryChunk_ != nullptr) {
4358      // Transmit any pending free memory. Native free memory of over kMaxFreeLen could be because
4359      // of the use of mmaps, so don't report. If not free memory then start a new segment.
4360      bool flush = true;
4361      if (start > startOfNextMemoryChunk_) {
4362        const size_t kMaxFreeLen = 2 * kPageSize;
4363        void* free_start = startOfNextMemoryChunk_;
4364        void* free_end = start;
4365        const size_t free_len =
4366            reinterpret_cast<uintptr_t>(free_end) - reinterpret_cast<uintptr_t>(free_start);
4367        if (!IsNative() || free_len < kMaxFreeLen) {
4368          AppendChunk(HPSG_STATE(SOLIDITY_FREE, 0), free_start, free_len, IsNative());
4369          flush = false;
4370        }
4371      }
4372      if (flush) {
4373        startOfNextMemoryChunk_ = nullptr;
4374        Flush();
4375      }
4376    }
4377    return true;
4378  }
4379
4380  void HeapChunkNativeCallback(void* start, void* /*end*/, size_t used_bytes)
4381      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4382    if (ProcessRecord(start, used_bytes)) {
4383      uint8_t state = ExamineNativeObject(start);
4384      AppendChunk(state, start, used_bytes + chunk_overhead_, true /*is_native*/);
4385      startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4386    }
4387  }
4388
4389  void HeapChunkJavaCallback(void* start, void* /*end*/, size_t used_bytes)
4390      SHARED_LOCKS_REQUIRED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
4391    if (ProcessRecord(start, used_bytes)) {
4392      // Determine the type of this chunk.
4393      // OLD-TODO: if context.merge, see if this chunk is different from the last chunk.
4394      // If it's the same, we should combine them.
4395      uint8_t state = ExamineJavaObject(reinterpret_cast<mirror::Object*>(start));
4396      AppendChunk(state, start, used_bytes + chunk_overhead_, false /*is_native*/);
4397      startOfNextMemoryChunk_ = reinterpret_cast<char*>(start) + used_bytes + chunk_overhead_;
4398    }
4399  }
4400
4401  void AppendChunk(uint8_t state, void* ptr, size_t length, bool is_native)
4402      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4403    // Make sure there's enough room left in the buffer.
4404    // We need to use two bytes for every fractional 256 allocation units used by the chunk plus
4405    // 17 bytes for any header.
4406    const size_t needed = ((RoundUp(length / ALLOCATION_UNIT_SIZE, 256) / 256) * 2) + 17;
4407    size_t byte_left = &buf_.back() - p_;
4408    if (byte_left < needed) {
4409      if (is_native) {
4410      // Cannot trigger memory allocation while walking native heap.
4411        return;
4412      }
4413      Flush();
4414    }
4415
4416    byte_left = &buf_.back() - p_;
4417    if (byte_left < needed) {
4418      LOG(WARNING) << "Chunk is too big to transmit (chunk_len=" << length << ", "
4419          << needed << " bytes)";
4420      return;
4421    }
4422    EnsureHeader(ptr);
4423    // Write out the chunk description.
4424    length /= ALLOCATION_UNIT_SIZE;   // Convert to allocation units.
4425    totalAllocationUnits_ += length;
4426    while (length > 256) {
4427      *p_++ = state | HPSG_PARTIAL;
4428      *p_++ = 255;     // length - 1
4429      length -= 256;
4430    }
4431    *p_++ = state;
4432    *p_++ = length - 1;
4433  }
4434
4435  uint8_t ExamineNativeObject(const void* p) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4436    return p == nullptr ? HPSG_STATE(SOLIDITY_FREE, 0) : HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4437  }
4438
4439  uint8_t ExamineJavaObject(mirror::Object* o)
4440      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
4441    if (o == nullptr) {
4442      return HPSG_STATE(SOLIDITY_FREE, 0);
4443    }
4444    // It's an allocated chunk. Figure out what it is.
4445    gc::Heap* heap = Runtime::Current()->GetHeap();
4446    if (!heap->IsLiveObjectLocked(o)) {
4447      LOG(ERROR) << "Invalid object in managed heap: " << o;
4448      return HPSG_STATE(SOLIDITY_HARD, KIND_NATIVE);
4449    }
4450    mirror::Class* c = o->GetClass();
4451    if (c == nullptr) {
4452      // The object was probably just created but hasn't been initialized yet.
4453      return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4454    }
4455    if (!heap->IsValidObjectAddress(c)) {
4456      LOG(ERROR) << "Invalid class for managed heap object: " << o << " " << c;
4457      return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4458    }
4459    if (c->GetClass() == nullptr) {
4460      LOG(ERROR) << "Null class of class " << c << " for object " << o;
4461      return HPSG_STATE(SOLIDITY_HARD, KIND_UNKNOWN);
4462    }
4463    if (c->IsClassClass()) {
4464      return HPSG_STATE(SOLIDITY_HARD, KIND_CLASS_OBJECT);
4465    }
4466    if (c->IsArrayClass()) {
4467      switch (c->GetComponentSize()) {
4468      case 1: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_1);
4469      case 2: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_2);
4470      case 4: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_4);
4471      case 8: return HPSG_STATE(SOLIDITY_HARD, KIND_ARRAY_8);
4472      }
4473    }
4474    return HPSG_STATE(SOLIDITY_HARD, KIND_OBJECT);
4475  }
4476
4477  std::vector<uint8_t> buf_;
4478  uint8_t* p_;
4479  uint8_t* pieceLenField_;
4480  void* startOfNextMemoryChunk_;
4481  size_t totalAllocationUnits_;
4482  uint32_t type_;
4483  bool needHeader_;
4484  size_t chunk_overhead_;
4485
4486  DISALLOW_COPY_AND_ASSIGN(HeapChunkContext);
4487};
4488
4489static void BumpPointerSpaceCallback(mirror::Object* obj, void* arg)
4490    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) EXCLUSIVE_LOCKS_REQUIRED(Locks::heap_bitmap_lock_) {
4491  const size_t size = RoundUp(obj->SizeOf(), kObjectAlignment);
4492  HeapChunkContext::HeapChunkJavaCallback(
4493      obj, reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(obj) + size), size, arg);
4494}
4495
4496void Dbg::DdmSendHeapSegments(bool native) {
4497  Dbg::HpsgWhen when = native ? gDdmNhsgWhen : gDdmHpsgWhen;
4498  Dbg::HpsgWhat what = native ? gDdmNhsgWhat : gDdmHpsgWhat;
4499  if (when == HPSG_WHEN_NEVER) {
4500    return;
4501  }
4502  // Figure out what kind of chunks we'll be sending.
4503  CHECK(what == HPSG_WHAT_MERGED_OBJECTS || what == HPSG_WHAT_DISTINCT_OBJECTS)
4504      << static_cast<int>(what);
4505
4506  // First, send a heap start chunk.
4507  uint8_t heap_id[4];
4508  JDWP::Set4BE(&heap_id[0], 1);  // Heap id (bogus; we only have one heap).
4509  Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHST") : CHUNK_TYPE("HPST"), sizeof(heap_id), heap_id);
4510  Thread* self = Thread::Current();
4511  Locks::mutator_lock_->AssertSharedHeld(self);
4512
4513  // Send a series of heap segment chunks.
4514  HeapChunkContext context(what == HPSG_WHAT_MERGED_OBJECTS, native);
4515  if (native) {
4516#if defined(HAVE_ANDROID_OS) && defined(USE_DLMALLOC)
4517    dlmalloc_inspect_all(HeapChunkContext::HeapChunkNativeCallback, &context);
4518    HeapChunkContext::HeapChunkNativeCallback(nullptr, nullptr, 0, &context);  // Indicate end of a space.
4519#else
4520    UNIMPLEMENTED(WARNING) << "Native heap inspection is only supported with dlmalloc";
4521#endif
4522  } else {
4523    gc::Heap* heap = Runtime::Current()->GetHeap();
4524    for (const auto& space : heap->GetContinuousSpaces()) {
4525      if (space->IsDlMallocSpace()) {
4526        ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4527        // dlmalloc's chunk header is 2 * sizeof(size_t), but if the previous chunk is in use for an
4528        // allocation then the first sizeof(size_t) may belong to it.
4529        context.SetChunkOverhead(sizeof(size_t));
4530        space->AsDlMallocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
4531      } else if (space->IsRosAllocSpace()) {
4532        context.SetChunkOverhead(0);
4533        // Need to acquire the mutator lock before the heap bitmap lock with exclusive access since
4534        // RosAlloc's internal logic doesn't know to release and reacquire the heap bitmap lock.
4535        self->TransitionFromRunnableToSuspended(kSuspended);
4536        ThreadList* tl = Runtime::Current()->GetThreadList();
4537        tl->SuspendAll(__FUNCTION__);
4538        {
4539          ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4540          space->AsRosAllocSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
4541        }
4542        tl->ResumeAll();
4543        self->TransitionFromSuspendedToRunnable();
4544      } else if (space->IsBumpPointerSpace()) {
4545        ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4546        context.SetChunkOverhead(0);
4547        space->AsBumpPointerSpace()->Walk(BumpPointerSpaceCallback, &context);
4548        HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
4549      } else if (space->IsRegionSpace()) {
4550        heap->IncrementDisableMovingGC(self);
4551        self->TransitionFromRunnableToSuspended(kSuspended);
4552        ThreadList* tl = Runtime::Current()->GetThreadList();
4553        tl->SuspendAll(__FUNCTION__);
4554        ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4555        context.SetChunkOverhead(0);
4556        space->AsRegionSpace()->Walk(BumpPointerSpaceCallback, &context);
4557        HeapChunkContext::HeapChunkJavaCallback(nullptr, nullptr, 0, &context);
4558        tl->ResumeAll();
4559        self->TransitionFromSuspendedToRunnable();
4560        heap->DecrementDisableMovingGC(self);
4561      } else {
4562        UNIMPLEMENTED(WARNING) << "Not counting objects in space " << *space;
4563      }
4564      context.ResetStartOfNextChunk();
4565    }
4566    ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
4567    // Walk the large objects, these are not in the AllocSpace.
4568    context.SetChunkOverhead(0);
4569    heap->GetLargeObjectsSpace()->Walk(HeapChunkContext::HeapChunkJavaCallback, &context);
4570  }
4571
4572  // Finally, send a heap end chunk.
4573  Dbg::DdmSendChunk(native ? CHUNK_TYPE("NHEN") : CHUNK_TYPE("HPEN"), sizeof(heap_id), heap_id);
4574}
4575
4576static size_t GetAllocTrackerMax() {
4577#ifdef HAVE_ANDROID_OS
4578  // Check whether there's a system property overriding the number of records.
4579  const char* propertyName = "dalvik.vm.allocTrackerMax";
4580  char allocRecordMaxString[PROPERTY_VALUE_MAX];
4581  if (property_get(propertyName, allocRecordMaxString, "") > 0) {
4582    char* end;
4583    size_t value = strtoul(allocRecordMaxString, &end, 10);
4584    if (*end != '\0') {
4585      LOG(ERROR) << "Ignoring  " << propertyName << " '" << allocRecordMaxString
4586                 << "' --- invalid";
4587      return kDefaultNumAllocRecords;
4588    }
4589    if (!IsPowerOfTwo(value)) {
4590      LOG(ERROR) << "Ignoring  " << propertyName << " '" << allocRecordMaxString
4591                 << "' --- not power of two";
4592      return kDefaultNumAllocRecords;
4593    }
4594    return value;
4595  }
4596#endif
4597  return kDefaultNumAllocRecords;
4598}
4599
4600void Dbg::SetAllocTrackingEnabled(bool enable) {
4601  Thread* self = Thread::Current();
4602  if (enable) {
4603    {
4604      MutexLock mu(self, *Locks::alloc_tracker_lock_);
4605      if (recent_allocation_records_ != nullptr) {
4606        return;  // Already enabled, bail.
4607      }
4608      alloc_record_max_ = GetAllocTrackerMax();
4609      LOG(INFO) << "Enabling alloc tracker (" << alloc_record_max_ << " entries of "
4610                << kMaxAllocRecordStackDepth << " frames, taking "
4611                << PrettySize(sizeof(AllocRecord) * alloc_record_max_) << ")";
4612      DCHECK_EQ(alloc_record_head_, 0U);
4613      DCHECK_EQ(alloc_record_count_, 0U);
4614      recent_allocation_records_ = new AllocRecord[alloc_record_max_];
4615      CHECK(recent_allocation_records_ != nullptr);
4616    }
4617    Runtime::Current()->GetInstrumentation()->InstrumentQuickAllocEntryPoints();
4618  } else {
4619    {
4620      ScopedObjectAccess soa(self);  // For type_cache_.Clear();
4621      MutexLock mu(self, *Locks::alloc_tracker_lock_);
4622      if (recent_allocation_records_ == nullptr) {
4623        return;  // Already disabled, bail.
4624      }
4625      LOG(INFO) << "Disabling alloc tracker";
4626      delete[] recent_allocation_records_;
4627      recent_allocation_records_ = nullptr;
4628      alloc_record_head_ = 0;
4629      alloc_record_count_ = 0;
4630      type_cache_.Clear();
4631    }
4632    // If an allocation comes in before we uninstrument, we will safely drop it on the floor.
4633    Runtime::Current()->GetInstrumentation()->UninstrumentQuickAllocEntryPoints();
4634  }
4635}
4636
4637struct AllocRecordStackVisitor : public StackVisitor {
4638  AllocRecordStackVisitor(Thread* thread, AllocRecord* record_in)
4639      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
4640      : StackVisitor(thread, nullptr), record(record_in), depth(0) {}
4641
4642  // TODO: Enable annotalysis. We know lock is held in constructor, but abstraction confuses
4643  // annotalysis.
4644  bool VisitFrame() NO_THREAD_SAFETY_ANALYSIS {
4645    if (depth >= kMaxAllocRecordStackDepth) {
4646      return false;
4647    }
4648    mirror::ArtMethod* m = GetMethod();
4649    if (!m->IsRuntimeMethod()) {
4650      record->StackElement(depth)->SetMethod(m);
4651      record->StackElement(depth)->SetDexPc(GetDexPc());
4652      ++depth;
4653    }
4654    return true;
4655  }
4656
4657  ~AllocRecordStackVisitor() {
4658    // Clear out any unused stack trace elements.
4659    for (; depth < kMaxAllocRecordStackDepth; ++depth) {
4660      record->StackElement(depth)->SetMethod(nullptr);
4661      record->StackElement(depth)->SetDexPc(0);
4662    }
4663  }
4664
4665  AllocRecord* record;
4666  size_t depth;
4667};
4668
4669void Dbg::RecordAllocation(Thread* self, mirror::Class* type, size_t byte_count) {
4670  MutexLock mu(self, *Locks::alloc_tracker_lock_);
4671  if (recent_allocation_records_ == nullptr) {
4672    // In the process of shutting down recording, bail.
4673    return;
4674  }
4675
4676  // Advance and clip.
4677  if (++alloc_record_head_ == alloc_record_max_) {
4678    alloc_record_head_ = 0;
4679  }
4680
4681  // Fill in the basics.
4682  AllocRecord* record = &recent_allocation_records_[alloc_record_head_];
4683  record->SetType(type);
4684  record->SetByteCount(byte_count);
4685  record->SetThinLockId(self->GetThreadId());
4686
4687  // Fill in the stack trace.
4688  AllocRecordStackVisitor visitor(self, record);
4689  visitor.WalkStack();
4690
4691  if (alloc_record_count_ < alloc_record_max_) {
4692    ++alloc_record_count_;
4693  }
4694}
4695
4696// Returns the index of the head element.
4697//
4698// We point at the most-recently-written record, so if alloc_record_count_ is 1
4699// we want to use the current element.  Take "head+1" and subtract count
4700// from it.
4701//
4702// We need to handle underflow in our circular buffer, so we add
4703// alloc_record_max_ and then mask it back down.
4704size_t Dbg::HeadIndex() {
4705  return (Dbg::alloc_record_head_ + 1 + Dbg::alloc_record_max_ - Dbg::alloc_record_count_) &
4706      (Dbg::alloc_record_max_ - 1);
4707}
4708
4709void Dbg::DumpRecentAllocations() {
4710  ScopedObjectAccess soa(Thread::Current());
4711  MutexLock mu(soa.Self(), *Locks::alloc_tracker_lock_);
4712  if (recent_allocation_records_ == nullptr) {
4713    LOG(INFO) << "Not recording tracked allocations";
4714    return;
4715  }
4716
4717  // "i" is the head of the list.  We want to start at the end of the
4718  // list and move forward to the tail.
4719  size_t i = HeadIndex();
4720  const uint16_t capped_count = CappedAllocRecordCount(Dbg::alloc_record_count_);
4721  uint16_t count = capped_count;
4722
4723  LOG(INFO) << "Tracked allocations, (head=" << alloc_record_head_ << " count=" << count << ")";
4724  while (count--) {
4725    AllocRecord* record = &recent_allocation_records_[i];
4726
4727    LOG(INFO) << StringPrintf(" Thread %-2d %6zd bytes ", record->ThinLockId(), record->ByteCount())
4728              << PrettyClass(record->Type());
4729
4730    for (size_t stack_frame = 0; stack_frame < kMaxAllocRecordStackDepth; ++stack_frame) {
4731      AllocRecordStackTraceElement* stack_element = record->StackElement(stack_frame);
4732      mirror::ArtMethod* m = stack_element->Method();
4733      if (m == nullptr) {
4734        break;
4735      }
4736      LOG(INFO) << "    " << PrettyMethod(m) << " line " << stack_element->LineNumber();
4737    }
4738
4739    // pause periodically to help logcat catch up
4740    if ((count % 5) == 0) {
4741      usleep(40000);
4742    }
4743
4744    i = (i + 1) & (alloc_record_max_ - 1);
4745  }
4746}
4747
4748class StringTable {
4749 public:
4750  StringTable() {
4751  }
4752
4753  void Add(const std::string& str) {
4754    table_.insert(str);
4755  }
4756
4757  void Add(const char* str) {
4758    table_.insert(str);
4759  }
4760
4761  size_t IndexOf(const char* s) const {
4762    auto it = table_.find(s);
4763    if (it == table_.end()) {
4764      LOG(FATAL) << "IndexOf(\"" << s << "\") failed";
4765    }
4766    return std::distance(table_.begin(), it);
4767  }
4768
4769  size_t Size() const {
4770    return table_.size();
4771  }
4772
4773  void WriteTo(std::vector<uint8_t>& bytes) const {
4774    for (const std::string& str : table_) {
4775      const char* s = str.c_str();
4776      size_t s_len = CountModifiedUtf8Chars(s);
4777      std::unique_ptr<uint16_t> s_utf16(new uint16_t[s_len]);
4778      ConvertModifiedUtf8ToUtf16(s_utf16.get(), s);
4779      JDWP::AppendUtf16BE(bytes, s_utf16.get(), s_len);
4780    }
4781  }
4782
4783 private:
4784  std::set<std::string> table_;
4785  DISALLOW_COPY_AND_ASSIGN(StringTable);
4786};
4787
4788static const char* GetMethodSourceFile(mirror::ArtMethod* method)
4789    SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
4790  DCHECK(method != nullptr);
4791  const char* source_file = method->GetDeclaringClassSourceFile();
4792  return (source_file != nullptr) ? source_file : "";
4793}
4794
4795/*
4796 * The data we send to DDMS contains everything we have recorded.
4797 *
4798 * Message header (all values big-endian):
4799 * (1b) message header len (to allow future expansion); includes itself
4800 * (1b) entry header len
4801 * (1b) stack frame len
4802 * (2b) number of entries
4803 * (4b) offset to string table from start of message
4804 * (2b) number of class name strings
4805 * (2b) number of method name strings
4806 * (2b) number of source file name strings
4807 * For each entry:
4808 *   (4b) total allocation size
4809 *   (2b) thread id
4810 *   (2b) allocated object's class name index
4811 *   (1b) stack depth
4812 *   For each stack frame:
4813 *     (2b) method's class name
4814 *     (2b) method name
4815 *     (2b) method source file
4816 *     (2b) line number, clipped to 32767; -2 if native; -1 if no source
4817 * (xb) class name strings
4818 * (xb) method name strings
4819 * (xb) source file strings
4820 *
4821 * As with other DDM traffic, strings are sent as a 4-byte length
4822 * followed by UTF-16 data.
4823 *
4824 * We send up 16-bit unsigned indexes into string tables.  In theory there
4825 * can be (kMaxAllocRecordStackDepth * alloc_record_max_) unique strings in
4826 * each table, but in practice there should be far fewer.
4827 *
4828 * The chief reason for using a string table here is to keep the size of
4829 * the DDMS message to a minimum.  This is partly to make the protocol
4830 * efficient, but also because we have to form the whole thing up all at
4831 * once in a memory buffer.
4832 *
4833 * We use separate string tables for class names, method names, and source
4834 * files to keep the indexes small.  There will generally be no overlap
4835 * between the contents of these tables.
4836 */
4837jbyteArray Dbg::GetRecentAllocations() {
4838  if ((false)) {
4839    DumpRecentAllocations();
4840  }
4841
4842  Thread* self = Thread::Current();
4843  std::vector<uint8_t> bytes;
4844  {
4845    MutexLock mu(self, *Locks::alloc_tracker_lock_);
4846    //
4847    // Part 1: generate string tables.
4848    //
4849    StringTable class_names;
4850    StringTable method_names;
4851    StringTable filenames;
4852
4853    const uint16_t capped_count = CappedAllocRecordCount(Dbg::alloc_record_count_);
4854    uint16_t count = capped_count;
4855    size_t idx = HeadIndex();
4856    while (count--) {
4857      AllocRecord* record = &recent_allocation_records_[idx];
4858      std::string temp;
4859      class_names.Add(record->Type()->GetDescriptor(&temp));
4860      for (size_t i = 0; i < kMaxAllocRecordStackDepth; i++) {
4861        mirror::ArtMethod* m = record->StackElement(i)->Method();
4862        if (m != nullptr) {
4863          class_names.Add(m->GetDeclaringClassDescriptor());
4864          method_names.Add(m->GetName());
4865          filenames.Add(GetMethodSourceFile(m));
4866        }
4867      }
4868
4869      idx = (idx + 1) & (alloc_record_max_ - 1);
4870    }
4871
4872    LOG(INFO) << "allocation records: " << capped_count;
4873
4874    //
4875    // Part 2: Generate the output and store it in the buffer.
4876    //
4877
4878    // (1b) message header len (to allow future expansion); includes itself
4879    // (1b) entry header len
4880    // (1b) stack frame len
4881    const int kMessageHeaderLen = 15;
4882    const int kEntryHeaderLen = 9;
4883    const int kStackFrameLen = 8;
4884    JDWP::Append1BE(bytes, kMessageHeaderLen);
4885    JDWP::Append1BE(bytes, kEntryHeaderLen);
4886    JDWP::Append1BE(bytes, kStackFrameLen);
4887
4888    // (2b) number of entries
4889    // (4b) offset to string table from start of message
4890    // (2b) number of class name strings
4891    // (2b) number of method name strings
4892    // (2b) number of source file name strings
4893    JDWP::Append2BE(bytes, capped_count);
4894    size_t string_table_offset = bytes.size();
4895    JDWP::Append4BE(bytes, 0);  // We'll patch this later...
4896    JDWP::Append2BE(bytes, class_names.Size());
4897    JDWP::Append2BE(bytes, method_names.Size());
4898    JDWP::Append2BE(bytes, filenames.Size());
4899
4900    idx = HeadIndex();
4901    std::string temp;
4902    for (count = capped_count; count != 0; --count) {
4903      // For each entry:
4904      // (4b) total allocation size
4905      // (2b) thread id
4906      // (2b) allocated object's class name index
4907      // (1b) stack depth
4908      AllocRecord* record = &recent_allocation_records_[idx];
4909      size_t stack_depth = record->GetDepth();
4910      size_t allocated_object_class_name_index =
4911          class_names.IndexOf(record->Type()->GetDescriptor(&temp));
4912      JDWP::Append4BE(bytes, record->ByteCount());
4913      JDWP::Append2BE(bytes, record->ThinLockId());
4914      JDWP::Append2BE(bytes, allocated_object_class_name_index);
4915      JDWP::Append1BE(bytes, stack_depth);
4916
4917      for (size_t stack_frame = 0; stack_frame < stack_depth; ++stack_frame) {
4918        // For each stack frame:
4919        // (2b) method's class name
4920        // (2b) method name
4921        // (2b) method source file
4922        // (2b) line number, clipped to 32767; -2 if native; -1 if no source
4923        mirror::ArtMethod* m = record->StackElement(stack_frame)->Method();
4924        size_t class_name_index = class_names.IndexOf(m->GetDeclaringClassDescriptor());
4925        size_t method_name_index = method_names.IndexOf(m->GetName());
4926        size_t file_name_index = filenames.IndexOf(GetMethodSourceFile(m));
4927        JDWP::Append2BE(bytes, class_name_index);
4928        JDWP::Append2BE(bytes, method_name_index);
4929        JDWP::Append2BE(bytes, file_name_index);
4930        JDWP::Append2BE(bytes, record->StackElement(stack_frame)->LineNumber());
4931      }
4932      idx = (idx + 1) & (alloc_record_max_ - 1);
4933    }
4934
4935    // (xb) class name strings
4936    // (xb) method name strings
4937    // (xb) source file strings
4938    JDWP::Set4BE(&bytes[string_table_offset], bytes.size());
4939    class_names.WriteTo(bytes);
4940    method_names.WriteTo(bytes);
4941    filenames.WriteTo(bytes);
4942  }
4943  JNIEnv* env = self->GetJniEnv();
4944  jbyteArray result = env->NewByteArray(bytes.size());
4945  if (result != nullptr) {
4946    env->SetByteArrayRegion(result, 0, bytes.size(), reinterpret_cast<const jbyte*>(&bytes[0]));
4947  }
4948  return result;
4949}
4950
4951mirror::ArtMethod* DeoptimizationRequest::Method() const {
4952  ScopedObjectAccessUnchecked soa(Thread::Current());
4953  return soa.DecodeMethod(method_);
4954}
4955
4956void DeoptimizationRequest::SetMethod(mirror::ArtMethod* m) {
4957  ScopedObjectAccessUnchecked soa(Thread::Current());
4958  method_ = soa.EncodeMethod(m);
4959}
4960
4961}  // namespace art
4962