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