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