1 //===-- CommandObjectMemory.cpp ---------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include <inttypes.h> 11 12 #include "clang/AST/Decl.h" 13 14 #include "CommandObjectMemory.h" 15 #include "Plugins/ExpressionParser/Clang/ClangPersistentVariables.h" 16 #include "lldb/Core/Debugger.h" 17 #include "lldb/Core/DumpDataExtractor.h" 18 #include "lldb/Core/Module.h" 19 #include "lldb/Core/Section.h" 20 #include "lldb/Core/ValueObjectMemory.h" 21 #include "lldb/DataFormatters/ValueObjectPrinter.h" 22 #include "lldb/Host/OptionParser.h" 23 #include "lldb/Interpreter/CommandInterpreter.h" 24 #include "lldb/Interpreter/CommandReturnObject.h" 25 #include "lldb/Interpreter/OptionArgParser.h" 26 #include "lldb/Interpreter/OptionGroupFormat.h" 27 #include "lldb/Interpreter/OptionGroupOutputFile.h" 28 #include "lldb/Interpreter/OptionGroupValueObjectDisplay.h" 29 #include "lldb/Interpreter/OptionValueString.h" 30 #include "lldb/Interpreter/Options.h" 31 #include "lldb/Symbol/ClangASTContext.h" 32 #include "lldb/Symbol/SymbolFile.h" 33 #include "lldb/Symbol/TypeList.h" 34 #include "lldb/Target/MemoryHistory.h" 35 #include "lldb/Target/MemoryRegionInfo.h" 36 #include "lldb/Target/Process.h" 37 #include "lldb/Target/StackFrame.h" 38 #include "lldb/Target/Thread.h" 39 #include "lldb/Utility/Args.h" 40 #include "lldb/Utility/DataBufferHeap.h" 41 #include "lldb/Utility/DataBufferLLVM.h" 42 #include "lldb/Utility/StreamString.h" 43 44 #include "lldb/lldb-private.h" 45 46 using namespace lldb; 47 using namespace lldb_private; 48 49 static constexpr OptionDefinition g_read_memory_options[] = { 50 // clang-format off 51 {LLDB_OPT_SET_1, false, "num-per-line", 'l', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeNumberPerLine, "The number of items per line to display." }, 52 {LLDB_OPT_SET_2, false, "binary", 'b', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "If true, memory will be saved as binary. If false, the memory is saved save as an ASCII dump that " 53 "uses the format, size, count and number per line settings." }, 54 {LLDB_OPT_SET_3, true , "type", 't', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeNone, "The name of a type to view memory as." }, 55 {LLDB_OPT_SET_3, false, "offset", 'E', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeCount, "How many elements of the specified type to skip before starting to display data." }, 56 {LLDB_OPT_SET_1 | 57 LLDB_OPT_SET_2 | 58 LLDB_OPT_SET_3, false, "force", 'r', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Necessary if reading over target.max-memory-read-size bytes." }, 59 // clang-format on 60 }; 61 62 class OptionGroupReadMemory : public OptionGroup { 63 public: 64 OptionGroupReadMemory() 65 : m_num_per_line(1, 1), m_output_as_binary(false), m_view_as_type(), 66 m_offset(0, 0) {} 67 68 ~OptionGroupReadMemory() override = default; 69 70 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 71 return llvm::makeArrayRef(g_read_memory_options); 72 } 73 74 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_value, 75 ExecutionContext *execution_context) override { 76 Status error; 77 const int short_option = g_read_memory_options[option_idx].short_option; 78 79 switch (short_option) { 80 case 'l': 81 error = m_num_per_line.SetValueFromString(option_value); 82 if (m_num_per_line.GetCurrentValue() == 0) 83 error.SetErrorStringWithFormat( 84 "invalid value for --num-per-line option '%s'", 85 option_value.str().c_str()); 86 break; 87 88 case 'b': 89 m_output_as_binary = true; 90 break; 91 92 case 't': 93 error = m_view_as_type.SetValueFromString(option_value); 94 break; 95 96 case 'r': 97 m_force = true; 98 break; 99 100 case 'E': 101 error = m_offset.SetValueFromString(option_value); 102 break; 103 104 default: 105 error.SetErrorStringWithFormat("unrecognized short option '%c'", 106 short_option); 107 break; 108 } 109 return error; 110 } 111 112 void OptionParsingStarting(ExecutionContext *execution_context) override { 113 m_num_per_line.Clear(); 114 m_output_as_binary = false; 115 m_view_as_type.Clear(); 116 m_force = false; 117 m_offset.Clear(); 118 } 119 120 Status FinalizeSettings(Target *target, OptionGroupFormat &format_options) { 121 Status error; 122 OptionValueUInt64 &byte_size_value = format_options.GetByteSizeValue(); 123 OptionValueUInt64 &count_value = format_options.GetCountValue(); 124 const bool byte_size_option_set = byte_size_value.OptionWasSet(); 125 const bool num_per_line_option_set = m_num_per_line.OptionWasSet(); 126 const bool count_option_set = format_options.GetCountValue().OptionWasSet(); 127 128 switch (format_options.GetFormat()) { 129 default: 130 break; 131 132 case eFormatBoolean: 133 if (!byte_size_option_set) 134 byte_size_value = 1; 135 if (!num_per_line_option_set) 136 m_num_per_line = 1; 137 if (!count_option_set) 138 format_options.GetCountValue() = 8; 139 break; 140 141 case eFormatCString: 142 break; 143 144 case eFormatInstruction: 145 if (count_option_set) 146 byte_size_value = target->GetArchitecture().GetMaximumOpcodeByteSize(); 147 m_num_per_line = 1; 148 break; 149 150 case eFormatAddressInfo: 151 if (!byte_size_option_set) 152 byte_size_value = target->GetArchitecture().GetAddressByteSize(); 153 m_num_per_line = 1; 154 if (!count_option_set) 155 format_options.GetCountValue() = 8; 156 break; 157 158 case eFormatPointer: 159 byte_size_value = target->GetArchitecture().GetAddressByteSize(); 160 if (!num_per_line_option_set) 161 m_num_per_line = 4; 162 if (!count_option_set) 163 format_options.GetCountValue() = 8; 164 break; 165 166 case eFormatBinary: 167 case eFormatFloat: 168 case eFormatOctal: 169 case eFormatDecimal: 170 case eFormatEnum: 171 case eFormatUnicode16: 172 case eFormatUnicode32: 173 case eFormatUnsigned: 174 case eFormatHexFloat: 175 if (!byte_size_option_set) 176 byte_size_value = 4; 177 if (!num_per_line_option_set) 178 m_num_per_line = 1; 179 if (!count_option_set) 180 format_options.GetCountValue() = 8; 181 break; 182 183 case eFormatBytes: 184 case eFormatBytesWithASCII: 185 if (byte_size_option_set) { 186 if (byte_size_value > 1) 187 error.SetErrorStringWithFormat( 188 "display format (bytes/bytes with ASCII) conflicts with the " 189 "specified byte size %" PRIu64 "\n" 190 "\tconsider using a different display format or don't specify " 191 "the byte size.", 192 byte_size_value.GetCurrentValue()); 193 } else 194 byte_size_value = 1; 195 if (!num_per_line_option_set) 196 m_num_per_line = 16; 197 if (!count_option_set) 198 format_options.GetCountValue() = 32; 199 break; 200 201 case eFormatCharArray: 202 case eFormatChar: 203 case eFormatCharPrintable: 204 if (!byte_size_option_set) 205 byte_size_value = 1; 206 if (!num_per_line_option_set) 207 m_num_per_line = 32; 208 if (!count_option_set) 209 format_options.GetCountValue() = 64; 210 break; 211 212 case eFormatComplex: 213 if (!byte_size_option_set) 214 byte_size_value = 8; 215 if (!num_per_line_option_set) 216 m_num_per_line = 1; 217 if (!count_option_set) 218 format_options.GetCountValue() = 8; 219 break; 220 221 case eFormatComplexInteger: 222 if (!byte_size_option_set) 223 byte_size_value = 8; 224 if (!num_per_line_option_set) 225 m_num_per_line = 1; 226 if (!count_option_set) 227 format_options.GetCountValue() = 8; 228 break; 229 230 case eFormatHex: 231 if (!byte_size_option_set) 232 byte_size_value = 4; 233 if (!num_per_line_option_set) { 234 switch (byte_size_value) { 235 case 1: 236 case 2: 237 m_num_per_line = 8; 238 break; 239 case 4: 240 m_num_per_line = 4; 241 break; 242 case 8: 243 m_num_per_line = 2; 244 break; 245 default: 246 m_num_per_line = 1; 247 break; 248 } 249 } 250 if (!count_option_set) 251 count_value = 8; 252 break; 253 254 case eFormatVectorOfChar: 255 case eFormatVectorOfSInt8: 256 case eFormatVectorOfUInt8: 257 case eFormatVectorOfSInt16: 258 case eFormatVectorOfUInt16: 259 case eFormatVectorOfSInt32: 260 case eFormatVectorOfUInt32: 261 case eFormatVectorOfSInt64: 262 case eFormatVectorOfUInt64: 263 case eFormatVectorOfFloat16: 264 case eFormatVectorOfFloat32: 265 case eFormatVectorOfFloat64: 266 case eFormatVectorOfUInt128: 267 if (!byte_size_option_set) 268 byte_size_value = 128; 269 if (!num_per_line_option_set) 270 m_num_per_line = 1; 271 if (!count_option_set) 272 count_value = 4; 273 break; 274 } 275 return error; 276 } 277 278 bool AnyOptionWasSet() const { 279 return m_num_per_line.OptionWasSet() || m_output_as_binary || 280 m_view_as_type.OptionWasSet() || m_offset.OptionWasSet(); 281 } 282 283 OptionValueUInt64 m_num_per_line; 284 bool m_output_as_binary; 285 OptionValueString m_view_as_type; 286 bool m_force; 287 OptionValueUInt64 m_offset; 288 }; 289 290 //---------------------------------------------------------------------- 291 // Read memory from the inferior process 292 //---------------------------------------------------------------------- 293 class CommandObjectMemoryRead : public CommandObjectParsed { 294 public: 295 CommandObjectMemoryRead(CommandInterpreter &interpreter) 296 : CommandObjectParsed( 297 interpreter, "memory read", 298 "Read from the memory of the current target process.", nullptr, 299 eCommandRequiresTarget | eCommandProcessMustBePaused), 300 m_option_group(), m_format_options(eFormatBytesWithASCII, 1, 8), 301 m_memory_options(), m_outfile_options(), m_varobj_options(), 302 m_next_addr(LLDB_INVALID_ADDRESS), m_prev_byte_size(0), 303 m_prev_format_options(eFormatBytesWithASCII, 1, 8), 304 m_prev_memory_options(), m_prev_outfile_options(), 305 m_prev_varobj_options() { 306 CommandArgumentEntry arg1; 307 CommandArgumentEntry arg2; 308 CommandArgumentData start_addr_arg; 309 CommandArgumentData end_addr_arg; 310 311 // Define the first (and only) variant of this arg. 312 start_addr_arg.arg_type = eArgTypeAddressOrExpression; 313 start_addr_arg.arg_repetition = eArgRepeatPlain; 314 315 // There is only one variant this argument could be; put it into the 316 // argument entry. 317 arg1.push_back(start_addr_arg); 318 319 // Define the first (and only) variant of this arg. 320 end_addr_arg.arg_type = eArgTypeAddressOrExpression; 321 end_addr_arg.arg_repetition = eArgRepeatOptional; 322 323 // There is only one variant this argument could be; put it into the 324 // argument entry. 325 arg2.push_back(end_addr_arg); 326 327 // Push the data for the first argument into the m_arguments vector. 328 m_arguments.push_back(arg1); 329 m_arguments.push_back(arg2); 330 331 // Add the "--format" and "--count" options to group 1 and 3 332 m_option_group.Append(&m_format_options, 333 OptionGroupFormat::OPTION_GROUP_FORMAT | 334 OptionGroupFormat::OPTION_GROUP_COUNT, 335 LLDB_OPT_SET_1 | LLDB_OPT_SET_2 | LLDB_OPT_SET_3); 336 m_option_group.Append(&m_format_options, 337 OptionGroupFormat::OPTION_GROUP_GDB_FMT, 338 LLDB_OPT_SET_1 | LLDB_OPT_SET_3); 339 // Add the "--size" option to group 1 and 2 340 m_option_group.Append(&m_format_options, 341 OptionGroupFormat::OPTION_GROUP_SIZE, 342 LLDB_OPT_SET_1 | LLDB_OPT_SET_2); 343 m_option_group.Append(&m_memory_options); 344 m_option_group.Append(&m_outfile_options, LLDB_OPT_SET_ALL, 345 LLDB_OPT_SET_1 | LLDB_OPT_SET_2 | LLDB_OPT_SET_3); 346 m_option_group.Append(&m_varobj_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_3); 347 m_option_group.Finalize(); 348 } 349 350 ~CommandObjectMemoryRead() override = default; 351 352 Options *GetOptions() override { return &m_option_group; } 353 354 const char *GetRepeatCommand(Args ¤t_command_args, 355 uint32_t index) override { 356 return m_cmd_name.c_str(); 357 } 358 359 protected: 360 bool DoExecute(Args &command, CommandReturnObject &result) override { 361 // No need to check "target" for validity as eCommandRequiresTarget ensures 362 // it is valid 363 Target *target = m_exe_ctx.GetTargetPtr(); 364 365 const size_t argc = command.GetArgumentCount(); 366 367 if ((argc == 0 && m_next_addr == LLDB_INVALID_ADDRESS) || argc > 2) { 368 result.AppendErrorWithFormat("%s takes a start address expression with " 369 "an optional end address expression.\n", 370 m_cmd_name.c_str()); 371 result.AppendRawWarning("Expressions should be quoted if they contain " 372 "spaces or other special characters.\n"); 373 result.SetStatus(eReturnStatusFailed); 374 return false; 375 } 376 377 CompilerType clang_ast_type; 378 Status error; 379 380 const char *view_as_type_cstr = 381 m_memory_options.m_view_as_type.GetCurrentValue(); 382 if (view_as_type_cstr && view_as_type_cstr[0]) { 383 // We are viewing memory as a type 384 385 const bool exact_match = false; 386 TypeList type_list; 387 uint32_t reference_count = 0; 388 uint32_t pointer_count = 0; 389 size_t idx; 390 391 #define ALL_KEYWORDS \ 392 KEYWORD("const") \ 393 KEYWORD("volatile") \ 394 KEYWORD("restrict") \ 395 KEYWORD("struct") \ 396 KEYWORD("class") \ 397 KEYWORD("union") 398 399 #define KEYWORD(s) s, 400 static const char *g_keywords[] = {ALL_KEYWORDS}; 401 #undef KEYWORD 402 403 #define KEYWORD(s) (sizeof(s) - 1), 404 static const int g_keyword_lengths[] = {ALL_KEYWORDS}; 405 #undef KEYWORD 406 407 #undef ALL_KEYWORDS 408 409 static size_t g_num_keywords = sizeof(g_keywords) / sizeof(const char *); 410 std::string type_str(view_as_type_cstr); 411 412 // Remove all instances of g_keywords that are followed by spaces 413 for (size_t i = 0; i < g_num_keywords; ++i) { 414 const char *keyword = g_keywords[i]; 415 int keyword_len = g_keyword_lengths[i]; 416 417 idx = 0; 418 while ((idx = type_str.find(keyword, idx)) != std::string::npos) { 419 if (type_str[idx + keyword_len] == ' ' || 420 type_str[idx + keyword_len] == '\t') { 421 type_str.erase(idx, keyword_len + 1); 422 idx = 0; 423 } else { 424 idx += keyword_len; 425 } 426 } 427 } 428 bool done = type_str.empty(); 429 // 430 idx = type_str.find_first_not_of(" \t"); 431 if (idx > 0 && idx != std::string::npos) 432 type_str.erase(0, idx); 433 while (!done) { 434 // Strip trailing spaces 435 if (type_str.empty()) 436 done = true; 437 else { 438 switch (type_str[type_str.size() - 1]) { 439 case '*': 440 ++pointer_count; 441 LLVM_FALLTHROUGH; 442 case ' ': 443 case '\t': 444 type_str.erase(type_str.size() - 1); 445 break; 446 447 case '&': 448 if (reference_count == 0) { 449 reference_count = 1; 450 type_str.erase(type_str.size() - 1); 451 } else { 452 result.AppendErrorWithFormat("invalid type string: '%s'\n", 453 view_as_type_cstr); 454 result.SetStatus(eReturnStatusFailed); 455 return false; 456 } 457 break; 458 459 default: 460 done = true; 461 break; 462 } 463 } 464 } 465 466 llvm::DenseSet<lldb_private::SymbolFile *> searched_symbol_files; 467 ConstString lookup_type_name(type_str.c_str()); 468 StackFrame *frame = m_exe_ctx.GetFramePtr(); 469 ModuleSP search_first; 470 if (frame) { 471 search_first = frame->GetSymbolContext(eSymbolContextModule).module_sp; 472 } 473 target->GetImages().FindTypes(search_first.get(), lookup_type_name, 474 exact_match, 1, searched_symbol_files, 475 type_list); 476 477 if (type_list.GetSize() == 0 && lookup_type_name.GetCString() && 478 *lookup_type_name.GetCString() == '$') { 479 if (ClangPersistentVariables *persistent_vars = 480 llvm::dyn_cast_or_null<ClangPersistentVariables>( 481 target->GetPersistentExpressionStateForLanguage( 482 lldb::eLanguageTypeC))) { 483 clang::TypeDecl *tdecl = llvm::dyn_cast_or_null<clang::TypeDecl>( 484 persistent_vars->GetPersistentDecl( 485 ConstString(lookup_type_name))); 486 487 if (tdecl) { 488 clang_ast_type.SetCompilerType( 489 ClangASTContext::GetASTContext(&tdecl->getASTContext()), 490 reinterpret_cast<lldb::opaque_compiler_type_t>( 491 const_cast<clang::Type *>(tdecl->getTypeForDecl()))); 492 } 493 } 494 } 495 496 if (!clang_ast_type.IsValid()) { 497 if (type_list.GetSize() == 0) { 498 result.AppendErrorWithFormat("unable to find any types that match " 499 "the raw type '%s' for full type '%s'\n", 500 lookup_type_name.GetCString(), 501 view_as_type_cstr); 502 result.SetStatus(eReturnStatusFailed); 503 return false; 504 } else { 505 TypeSP type_sp(type_list.GetTypeAtIndex(0)); 506 clang_ast_type = type_sp->GetFullCompilerType(); 507 } 508 } 509 510 while (pointer_count > 0) { 511 CompilerType pointer_type = clang_ast_type.GetPointerType(); 512 if (pointer_type.IsValid()) 513 clang_ast_type = pointer_type; 514 else { 515 result.AppendError("unable make a pointer type\n"); 516 result.SetStatus(eReturnStatusFailed); 517 return false; 518 } 519 --pointer_count; 520 } 521 522 auto size = clang_ast_type.GetByteSize(nullptr); 523 if (!size) { 524 result.AppendErrorWithFormat( 525 "unable to get the byte size of the type '%s'\n", 526 view_as_type_cstr); 527 result.SetStatus(eReturnStatusFailed); 528 return false; 529 } 530 m_format_options.GetByteSizeValue() = *size; 531 532 if (!m_format_options.GetCountValue().OptionWasSet()) 533 m_format_options.GetCountValue() = 1; 534 } else { 535 error = m_memory_options.FinalizeSettings(target, m_format_options); 536 } 537 538 // Look for invalid combinations of settings 539 if (error.Fail()) { 540 result.AppendError(error.AsCString()); 541 result.SetStatus(eReturnStatusFailed); 542 return false; 543 } 544 545 lldb::addr_t addr; 546 size_t total_byte_size = 0; 547 if (argc == 0) { 548 // Use the last address and byte size and all options as they were if no 549 // options have been set 550 addr = m_next_addr; 551 total_byte_size = m_prev_byte_size; 552 clang_ast_type = m_prev_clang_ast_type; 553 if (!m_format_options.AnyOptionWasSet() && 554 !m_memory_options.AnyOptionWasSet() && 555 !m_outfile_options.AnyOptionWasSet() && 556 !m_varobj_options.AnyOptionWasSet()) { 557 m_format_options = m_prev_format_options; 558 m_memory_options = m_prev_memory_options; 559 m_outfile_options = m_prev_outfile_options; 560 m_varobj_options = m_prev_varobj_options; 561 } 562 } 563 564 size_t item_count = m_format_options.GetCountValue().GetCurrentValue(); 565 566 // TODO For non-8-bit byte addressable architectures this needs to be 567 // revisited to fully support all lldb's range of formatting options. 568 // Furthermore code memory reads (for those architectures) will not be 569 // correctly formatted even w/o formatting options. 570 size_t item_byte_size = 571 target->GetArchitecture().GetDataByteSize() > 1 572 ? target->GetArchitecture().GetDataByteSize() 573 : m_format_options.GetByteSizeValue().GetCurrentValue(); 574 575 const size_t num_per_line = 576 m_memory_options.m_num_per_line.GetCurrentValue(); 577 578 if (total_byte_size == 0) { 579 total_byte_size = item_count * item_byte_size; 580 if (total_byte_size == 0) 581 total_byte_size = 32; 582 } 583 584 if (argc > 0) 585 addr = OptionArgParser::ToAddress(&m_exe_ctx, command[0].ref, 586 LLDB_INVALID_ADDRESS, &error); 587 588 if (addr == LLDB_INVALID_ADDRESS) { 589 result.AppendError("invalid start address expression."); 590 result.AppendError(error.AsCString()); 591 result.SetStatus(eReturnStatusFailed); 592 return false; 593 } 594 595 if (argc == 2) { 596 lldb::addr_t end_addr = OptionArgParser::ToAddress( 597 &m_exe_ctx, command[1].ref, LLDB_INVALID_ADDRESS, nullptr); 598 if (end_addr == LLDB_INVALID_ADDRESS) { 599 result.AppendError("invalid end address expression."); 600 result.AppendError(error.AsCString()); 601 result.SetStatus(eReturnStatusFailed); 602 return false; 603 } else if (end_addr <= addr) { 604 result.AppendErrorWithFormat( 605 "end address (0x%" PRIx64 606 ") must be greater that the start address (0x%" PRIx64 ").\n", 607 end_addr, addr); 608 result.SetStatus(eReturnStatusFailed); 609 return false; 610 } else if (m_format_options.GetCountValue().OptionWasSet()) { 611 result.AppendErrorWithFormat( 612 "specify either the end address (0x%" PRIx64 613 ") or the count (--count %" PRIu64 "), not both.\n", 614 end_addr, (uint64_t)item_count); 615 result.SetStatus(eReturnStatusFailed); 616 return false; 617 } 618 619 total_byte_size = end_addr - addr; 620 item_count = total_byte_size / item_byte_size; 621 } 622 623 uint32_t max_unforced_size = target->GetMaximumMemReadSize(); 624 625 if (total_byte_size > max_unforced_size && !m_memory_options.m_force) { 626 result.AppendErrorWithFormat( 627 "Normally, \'memory read\' will not read over %" PRIu32 628 " bytes of data.\n", 629 max_unforced_size); 630 result.AppendErrorWithFormat( 631 "Please use --force to override this restriction just once.\n"); 632 result.AppendErrorWithFormat("or set target.max-memory-read-size if you " 633 "will often need a larger limit.\n"); 634 return false; 635 } 636 637 DataBufferSP data_sp; 638 size_t bytes_read = 0; 639 if (clang_ast_type.GetOpaqueQualType()) { 640 // Make sure we don't display our type as ASCII bytes like the default 641 // memory read 642 if (!m_format_options.GetFormatValue().OptionWasSet()) 643 m_format_options.GetFormatValue().SetCurrentValue(eFormatDefault); 644 645 auto size = clang_ast_type.GetByteSize(nullptr); 646 if (!size) { 647 result.AppendError("can't get size of type"); 648 return false; 649 } 650 bytes_read = *size * m_format_options.GetCountValue().GetCurrentValue(); 651 652 if (argc > 0) 653 addr = addr + (*size * m_memory_options.m_offset.GetCurrentValue()); 654 } else if (m_format_options.GetFormatValue().GetCurrentValue() != 655 eFormatCString) { 656 data_sp.reset(new DataBufferHeap(total_byte_size, '\0')); 657 if (data_sp->GetBytes() == nullptr) { 658 result.AppendErrorWithFormat( 659 "can't allocate 0x%" PRIx32 660 " bytes for the memory read buffer, specify a smaller size to read", 661 (uint32_t)total_byte_size); 662 result.SetStatus(eReturnStatusFailed); 663 return false; 664 } 665 666 Address address(addr, nullptr); 667 bytes_read = target->ReadMemory(address, false, data_sp->GetBytes(), 668 data_sp->GetByteSize(), error); 669 if (bytes_read == 0) { 670 const char *error_cstr = error.AsCString(); 671 if (error_cstr && error_cstr[0]) { 672 result.AppendError(error_cstr); 673 } else { 674 result.AppendErrorWithFormat( 675 "failed to read memory from 0x%" PRIx64 ".\n", addr); 676 } 677 result.SetStatus(eReturnStatusFailed); 678 return false; 679 } 680 681 if (bytes_read < total_byte_size) 682 result.AppendWarningWithFormat( 683 "Not all bytes (%" PRIu64 "/%" PRIu64 684 ") were able to be read from 0x%" PRIx64 ".\n", 685 (uint64_t)bytes_read, (uint64_t)total_byte_size, addr); 686 } else { 687 // we treat c-strings as a special case because they do not have a fixed 688 // size 689 if (m_format_options.GetByteSizeValue().OptionWasSet() && 690 !m_format_options.HasGDBFormat()) 691 item_byte_size = m_format_options.GetByteSizeValue().GetCurrentValue(); 692 else 693 item_byte_size = target->GetMaximumSizeOfStringSummary(); 694 if (!m_format_options.GetCountValue().OptionWasSet()) 695 item_count = 1; 696 data_sp.reset(new DataBufferHeap((item_byte_size + 1) * item_count, 697 '\0')); // account for NULLs as necessary 698 if (data_sp->GetBytes() == nullptr) { 699 result.AppendErrorWithFormat( 700 "can't allocate 0x%" PRIx64 701 " bytes for the memory read buffer, specify a smaller size to read", 702 (uint64_t)((item_byte_size + 1) * item_count)); 703 result.SetStatus(eReturnStatusFailed); 704 return false; 705 } 706 uint8_t *data_ptr = data_sp->GetBytes(); 707 auto data_addr = addr; 708 auto count = item_count; 709 item_count = 0; 710 bool break_on_no_NULL = false; 711 while (item_count < count) { 712 std::string buffer; 713 buffer.resize(item_byte_size + 1, 0); 714 Status error; 715 size_t read = target->ReadCStringFromMemory(data_addr, &buffer[0], 716 item_byte_size + 1, error); 717 if (error.Fail()) { 718 result.AppendErrorWithFormat( 719 "failed to read memory from 0x%" PRIx64 ".\n", addr); 720 result.SetStatus(eReturnStatusFailed); 721 return false; 722 } 723 724 if (item_byte_size == read) { 725 result.AppendWarningWithFormat( 726 "unable to find a NULL terminated string at 0x%" PRIx64 727 ".Consider increasing the maximum read length.\n", 728 data_addr); 729 --read; 730 break_on_no_NULL = true; 731 } else 732 ++read; // account for final NULL byte 733 734 memcpy(data_ptr, &buffer[0], read); 735 data_ptr += read; 736 data_addr += read; 737 bytes_read += read; 738 item_count++; // if we break early we know we only read item_count 739 // strings 740 741 if (break_on_no_NULL) 742 break; 743 } 744 data_sp.reset(new DataBufferHeap(data_sp->GetBytes(), bytes_read + 1)); 745 } 746 747 m_next_addr = addr + bytes_read; 748 m_prev_byte_size = bytes_read; 749 m_prev_format_options = m_format_options; 750 m_prev_memory_options = m_memory_options; 751 m_prev_outfile_options = m_outfile_options; 752 m_prev_varobj_options = m_varobj_options; 753 m_prev_clang_ast_type = clang_ast_type; 754 755 StreamFile outfile_stream; 756 Stream *output_stream = nullptr; 757 const FileSpec &outfile_spec = 758 m_outfile_options.GetFile().GetCurrentValue(); 759 760 std::string path = outfile_spec.GetPath(); 761 if (outfile_spec) { 762 763 uint32_t open_options = 764 File::eOpenOptionWrite | File::eOpenOptionCanCreate; 765 const bool append = m_outfile_options.GetAppend().GetCurrentValue(); 766 if (append) 767 open_options |= File::eOpenOptionAppend; 768 769 Status error = FileSystem::Instance().Open(outfile_stream.GetFile(), 770 outfile_spec, open_options); 771 if (error.Success()) { 772 if (m_memory_options.m_output_as_binary) { 773 const size_t bytes_written = 774 outfile_stream.Write(data_sp->GetBytes(), bytes_read); 775 if (bytes_written > 0) { 776 result.GetOutputStream().Printf( 777 "%zi bytes %s to '%s'\n", bytes_written, 778 append ? "appended" : "written", path.c_str()); 779 return true; 780 } else { 781 result.AppendErrorWithFormat("Failed to write %" PRIu64 782 " bytes to '%s'.\n", 783 (uint64_t)bytes_read, path.c_str()); 784 result.SetStatus(eReturnStatusFailed); 785 return false; 786 } 787 } else { 788 // We are going to write ASCII to the file just point the 789 // output_stream to our outfile_stream... 790 output_stream = &outfile_stream; 791 } 792 } else { 793 result.AppendErrorWithFormat("Failed to open file '%s' for %s.\n", 794 path.c_str(), append ? "append" : "write"); 795 result.SetStatus(eReturnStatusFailed); 796 return false; 797 } 798 } else { 799 output_stream = &result.GetOutputStream(); 800 } 801 802 ExecutionContextScope *exe_scope = m_exe_ctx.GetBestExecutionContextScope(); 803 if (clang_ast_type.GetOpaqueQualType()) { 804 for (uint32_t i = 0; i < item_count; ++i) { 805 addr_t item_addr = addr + (i * item_byte_size); 806 Address address(item_addr); 807 StreamString name_strm; 808 name_strm.Printf("0x%" PRIx64, item_addr); 809 ValueObjectSP valobj_sp(ValueObjectMemory::Create( 810 exe_scope, name_strm.GetString(), address, clang_ast_type)); 811 if (valobj_sp) { 812 Format format = m_format_options.GetFormat(); 813 if (format != eFormatDefault) 814 valobj_sp->SetFormat(format); 815 816 DumpValueObjectOptions options(m_varobj_options.GetAsDumpOptions( 817 eLanguageRuntimeDescriptionDisplayVerbosityFull, format)); 818 819 valobj_sp->Dump(*output_stream, options); 820 } else { 821 result.AppendErrorWithFormat( 822 "failed to create a value object for: (%s) %s\n", 823 view_as_type_cstr, name_strm.GetData()); 824 result.SetStatus(eReturnStatusFailed); 825 return false; 826 } 827 } 828 return true; 829 } 830 831 result.SetStatus(eReturnStatusSuccessFinishResult); 832 DataExtractor data(data_sp, target->GetArchitecture().GetByteOrder(), 833 target->GetArchitecture().GetAddressByteSize(), 834 target->GetArchitecture().GetDataByteSize()); 835 836 Format format = m_format_options.GetFormat(); 837 if (((format == eFormatChar) || (format == eFormatCharPrintable)) && 838 (item_byte_size != 1)) { 839 // if a count was not passed, or it is 1 840 if (!m_format_options.GetCountValue().OptionWasSet() || item_count == 1) { 841 // this turns requests such as 842 // memory read -fc -s10 -c1 *charPtrPtr 843 // which make no sense (what is a char of size 10?) into a request for 844 // fetching 10 chars of size 1 from the same memory location 845 format = eFormatCharArray; 846 item_count = item_byte_size; 847 item_byte_size = 1; 848 } else { 849 // here we passed a count, and it was not 1 so we have a byte_size and 850 // a count we could well multiply those, but instead let's just fail 851 result.AppendErrorWithFormat( 852 "reading memory as characters of size %" PRIu64 " is not supported", 853 (uint64_t)item_byte_size); 854 result.SetStatus(eReturnStatusFailed); 855 return false; 856 } 857 } 858 859 assert(output_stream); 860 size_t bytes_dumped = DumpDataExtractor( 861 data, output_stream, 0, format, item_byte_size, item_count, 862 num_per_line / target->GetArchitecture().GetDataByteSize(), addr, 0, 0, 863 exe_scope); 864 m_next_addr = addr + bytes_dumped; 865 output_stream->EOL(); 866 return true; 867 } 868 869 OptionGroupOptions m_option_group; 870 OptionGroupFormat m_format_options; 871 OptionGroupReadMemory m_memory_options; 872 OptionGroupOutputFile m_outfile_options; 873 OptionGroupValueObjectDisplay m_varobj_options; 874 lldb::addr_t m_next_addr; 875 lldb::addr_t m_prev_byte_size; 876 OptionGroupFormat m_prev_format_options; 877 OptionGroupReadMemory m_prev_memory_options; 878 OptionGroupOutputFile m_prev_outfile_options; 879 OptionGroupValueObjectDisplay m_prev_varobj_options; 880 CompilerType m_prev_clang_ast_type; 881 }; 882 883 static constexpr OptionDefinition g_memory_find_option_table[] = { 884 // clang-format off 885 {LLDB_OPT_SET_1, true, "expression", 'e', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeExpression, "Evaluate an expression to obtain a byte pattern."}, 886 {LLDB_OPT_SET_2, true, "string", 's', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeName, "Use text to find a byte pattern."}, 887 {LLDB_OPT_SET_ALL, false, "count", 'c', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeCount, "How many times to perform the search."}, 888 {LLDB_OPT_SET_ALL, false, "dump-offset", 'o', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeOffset, "When dumping memory for a match, an offset from the match location to start dumping from."}, 889 // clang-format on 890 }; 891 892 //---------------------------------------------------------------------- 893 // Find the specified data in memory 894 //---------------------------------------------------------------------- 895 class CommandObjectMemoryFind : public CommandObjectParsed { 896 public: 897 class OptionGroupFindMemory : public OptionGroup { 898 public: 899 OptionGroupFindMemory() : OptionGroup(), m_count(1), m_offset(0) {} 900 901 ~OptionGroupFindMemory() override = default; 902 903 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 904 return llvm::makeArrayRef(g_memory_find_option_table); 905 } 906 907 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_value, 908 ExecutionContext *execution_context) override { 909 Status error; 910 const int short_option = 911 g_memory_find_option_table[option_idx].short_option; 912 913 switch (short_option) { 914 case 'e': 915 m_expr.SetValueFromString(option_value); 916 break; 917 918 case 's': 919 m_string.SetValueFromString(option_value); 920 break; 921 922 case 'c': 923 if (m_count.SetValueFromString(option_value).Fail()) 924 error.SetErrorString("unrecognized value for count"); 925 break; 926 927 case 'o': 928 if (m_offset.SetValueFromString(option_value).Fail()) 929 error.SetErrorString("unrecognized value for dump-offset"); 930 break; 931 932 default: 933 error.SetErrorStringWithFormat("unrecognized short option '%c'", 934 short_option); 935 break; 936 } 937 return error; 938 } 939 940 void OptionParsingStarting(ExecutionContext *execution_context) override { 941 m_expr.Clear(); 942 m_string.Clear(); 943 m_count.Clear(); 944 } 945 946 OptionValueString m_expr; 947 OptionValueString m_string; 948 OptionValueUInt64 m_count; 949 OptionValueUInt64 m_offset; 950 }; 951 952 CommandObjectMemoryFind(CommandInterpreter &interpreter) 953 : CommandObjectParsed( 954 interpreter, "memory find", 955 "Find a value in the memory of the current target process.", 956 nullptr, eCommandRequiresProcess | eCommandProcessMustBeLaunched), 957 m_option_group(), m_memory_options() { 958 CommandArgumentEntry arg1; 959 CommandArgumentEntry arg2; 960 CommandArgumentData addr_arg; 961 CommandArgumentData value_arg; 962 963 // Define the first (and only) variant of this arg. 964 addr_arg.arg_type = eArgTypeAddressOrExpression; 965 addr_arg.arg_repetition = eArgRepeatPlain; 966 967 // There is only one variant this argument could be; put it into the 968 // argument entry. 969 arg1.push_back(addr_arg); 970 971 // Define the first (and only) variant of this arg. 972 value_arg.arg_type = eArgTypeAddressOrExpression; 973 value_arg.arg_repetition = eArgRepeatPlain; 974 975 // There is only one variant this argument could be; put it into the 976 // argument entry. 977 arg2.push_back(value_arg); 978 979 // Push the data for the first argument into the m_arguments vector. 980 m_arguments.push_back(arg1); 981 m_arguments.push_back(arg2); 982 983 m_option_group.Append(&m_memory_options); 984 m_option_group.Finalize(); 985 } 986 987 ~CommandObjectMemoryFind() override = default; 988 989 Options *GetOptions() override { return &m_option_group; } 990 991 protected: 992 class ProcessMemoryIterator { 993 public: 994 ProcessMemoryIterator(ProcessSP process_sp, lldb::addr_t base) 995 : m_process_sp(process_sp), m_base_addr(base), m_is_valid(true) { 996 lldbassert(process_sp.get() != nullptr); 997 } 998 999 bool IsValid() { return m_is_valid; } 1000 1001 uint8_t operator[](lldb::addr_t offset) { 1002 if (!IsValid()) 1003 return 0; 1004 1005 uint8_t retval = 0; 1006 Status error; 1007 if (0 == 1008 m_process_sp->ReadMemory(m_base_addr + offset, &retval, 1, error)) { 1009 m_is_valid = false; 1010 return 0; 1011 } 1012 1013 return retval; 1014 } 1015 1016 private: 1017 ProcessSP m_process_sp; 1018 lldb::addr_t m_base_addr; 1019 bool m_is_valid; 1020 }; 1021 bool DoExecute(Args &command, CommandReturnObject &result) override { 1022 // No need to check "process" for validity as eCommandRequiresProcess 1023 // ensures it is valid 1024 Process *process = m_exe_ctx.GetProcessPtr(); 1025 1026 const size_t argc = command.GetArgumentCount(); 1027 1028 if (argc != 2) { 1029 result.AppendError("two addresses needed for memory find"); 1030 return false; 1031 } 1032 1033 Status error; 1034 lldb::addr_t low_addr = OptionArgParser::ToAddress( 1035 &m_exe_ctx, command[0].ref, LLDB_INVALID_ADDRESS, &error); 1036 if (low_addr == LLDB_INVALID_ADDRESS || error.Fail()) { 1037 result.AppendError("invalid low address"); 1038 return false; 1039 } 1040 lldb::addr_t high_addr = OptionArgParser::ToAddress( 1041 &m_exe_ctx, command[1].ref, LLDB_INVALID_ADDRESS, &error); 1042 if (high_addr == LLDB_INVALID_ADDRESS || error.Fail()) { 1043 result.AppendError("invalid high address"); 1044 return false; 1045 } 1046 1047 if (high_addr <= low_addr) { 1048 result.AppendError( 1049 "starting address must be smaller than ending address"); 1050 return false; 1051 } 1052 1053 lldb::addr_t found_location = LLDB_INVALID_ADDRESS; 1054 1055 DataBufferHeap buffer; 1056 1057 if (m_memory_options.m_string.OptionWasSet()) 1058 buffer.CopyData(m_memory_options.m_string.GetStringValue()); 1059 else if (m_memory_options.m_expr.OptionWasSet()) { 1060 StackFrame *frame = m_exe_ctx.GetFramePtr(); 1061 ValueObjectSP result_sp; 1062 if ((eExpressionCompleted == 1063 process->GetTarget().EvaluateExpression( 1064 m_memory_options.m_expr.GetStringValue(), frame, result_sp)) && 1065 result_sp) { 1066 uint64_t value = result_sp->GetValueAsUnsigned(0); 1067 auto size = result_sp->GetCompilerType().GetByteSize(nullptr); 1068 if (!size) 1069 return false; 1070 switch (*size) { 1071 case 1: { 1072 uint8_t byte = (uint8_t)value; 1073 buffer.CopyData(&byte, 1); 1074 } break; 1075 case 2: { 1076 uint16_t word = (uint16_t)value; 1077 buffer.CopyData(&word, 2); 1078 } break; 1079 case 4: { 1080 uint32_t lword = (uint32_t)value; 1081 buffer.CopyData(&lword, 4); 1082 } break; 1083 case 8: { 1084 buffer.CopyData(&value, 8); 1085 } break; 1086 case 3: 1087 case 5: 1088 case 6: 1089 case 7: 1090 result.AppendError("unknown type. pass a string instead"); 1091 return false; 1092 default: 1093 result.AppendError( 1094 "result size larger than 8 bytes. pass a string instead"); 1095 return false; 1096 } 1097 } else { 1098 result.AppendError( 1099 "expression evaluation failed. pass a string instead"); 1100 return false; 1101 } 1102 } else { 1103 result.AppendError( 1104 "please pass either a block of text, or an expression to evaluate."); 1105 return false; 1106 } 1107 1108 size_t count = m_memory_options.m_count.GetCurrentValue(); 1109 found_location = low_addr; 1110 bool ever_found = false; 1111 while (count) { 1112 found_location = FastSearch(found_location, high_addr, buffer.GetBytes(), 1113 buffer.GetByteSize()); 1114 if (found_location == LLDB_INVALID_ADDRESS) { 1115 if (!ever_found) { 1116 result.AppendMessage("data not found within the range.\n"); 1117 result.SetStatus(lldb::eReturnStatusSuccessFinishNoResult); 1118 } else 1119 result.AppendMessage("no more matches within the range.\n"); 1120 break; 1121 } 1122 result.AppendMessageWithFormat("data found at location: 0x%" PRIx64 "\n", 1123 found_location); 1124 1125 DataBufferHeap dumpbuffer(32, 0); 1126 process->ReadMemory( 1127 found_location + m_memory_options.m_offset.GetCurrentValue(), 1128 dumpbuffer.GetBytes(), dumpbuffer.GetByteSize(), error); 1129 if (!error.Fail()) { 1130 DataExtractor data(dumpbuffer.GetBytes(), dumpbuffer.GetByteSize(), 1131 process->GetByteOrder(), 1132 process->GetAddressByteSize()); 1133 DumpDataExtractor( 1134 data, &result.GetOutputStream(), 0, lldb::eFormatBytesWithASCII, 1, 1135 dumpbuffer.GetByteSize(), 16, 1136 found_location + m_memory_options.m_offset.GetCurrentValue(), 0, 0); 1137 result.GetOutputStream().EOL(); 1138 } 1139 1140 --count; 1141 found_location++; 1142 ever_found = true; 1143 } 1144 1145 result.SetStatus(lldb::eReturnStatusSuccessFinishResult); 1146 return true; 1147 } 1148 1149 lldb::addr_t FastSearch(lldb::addr_t low, lldb::addr_t high, uint8_t *buffer, 1150 size_t buffer_size) { 1151 const size_t region_size = high - low; 1152 1153 if (region_size < buffer_size) 1154 return LLDB_INVALID_ADDRESS; 1155 1156 std::vector<size_t> bad_char_heuristic(256, buffer_size); 1157 ProcessSP process_sp = m_exe_ctx.GetProcessSP(); 1158 ProcessMemoryIterator iterator(process_sp, low); 1159 1160 for (size_t idx = 0; idx < buffer_size - 1; idx++) { 1161 decltype(bad_char_heuristic)::size_type bcu_idx = buffer[idx]; 1162 bad_char_heuristic[bcu_idx] = buffer_size - idx - 1; 1163 } 1164 for (size_t s = 0; s <= (region_size - buffer_size);) { 1165 int64_t j = buffer_size - 1; 1166 while (j >= 0 && buffer[j] == iterator[s + j]) 1167 j--; 1168 if (j < 0) 1169 return low + s; 1170 else 1171 s += bad_char_heuristic[iterator[s + buffer_size - 1]]; 1172 } 1173 1174 return LLDB_INVALID_ADDRESS; 1175 } 1176 1177 OptionGroupOptions m_option_group; 1178 OptionGroupFindMemory m_memory_options; 1179 }; 1180 1181 static constexpr OptionDefinition g_memory_write_option_table[] = { 1182 // clang-format off 1183 {LLDB_OPT_SET_1, true, "infile", 'i', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeFilename, "Write memory using the contents of a file."}, 1184 {LLDB_OPT_SET_1, false, "offset", 'o', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeOffset, "Start writing bytes from an offset within the input file."}, 1185 // clang-format on 1186 }; 1187 1188 //---------------------------------------------------------------------- 1189 // Write memory to the inferior process 1190 //---------------------------------------------------------------------- 1191 class CommandObjectMemoryWrite : public CommandObjectParsed { 1192 public: 1193 class OptionGroupWriteMemory : public OptionGroup { 1194 public: 1195 OptionGroupWriteMemory() : OptionGroup() {} 1196 1197 ~OptionGroupWriteMemory() override = default; 1198 1199 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 1200 return llvm::makeArrayRef(g_memory_write_option_table); 1201 } 1202 1203 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_value, 1204 ExecutionContext *execution_context) override { 1205 Status error; 1206 const int short_option = 1207 g_memory_write_option_table[option_idx].short_option; 1208 1209 switch (short_option) { 1210 case 'i': 1211 m_infile.SetFile(option_value, FileSpec::Style::native); 1212 FileSystem::Instance().Resolve(m_infile); 1213 if (!FileSystem::Instance().Exists(m_infile)) { 1214 m_infile.Clear(); 1215 error.SetErrorStringWithFormat("input file does not exist: '%s'", 1216 option_value.str().c_str()); 1217 } 1218 break; 1219 1220 case 'o': { 1221 if (option_value.getAsInteger(0, m_infile_offset)) { 1222 m_infile_offset = 0; 1223 error.SetErrorStringWithFormat("invalid offset string '%s'", 1224 option_value.str().c_str()); 1225 } 1226 } break; 1227 1228 default: 1229 error.SetErrorStringWithFormat("unrecognized short option '%c'", 1230 short_option); 1231 break; 1232 } 1233 return error; 1234 } 1235 1236 void OptionParsingStarting(ExecutionContext *execution_context) override { 1237 m_infile.Clear(); 1238 m_infile_offset = 0; 1239 } 1240 1241 FileSpec m_infile; 1242 off_t m_infile_offset; 1243 }; 1244 1245 CommandObjectMemoryWrite(CommandInterpreter &interpreter) 1246 : CommandObjectParsed( 1247 interpreter, "memory write", 1248 "Write to the memory of the current target process.", nullptr, 1249 eCommandRequiresProcess | eCommandProcessMustBeLaunched), 1250 m_option_group(), m_format_options(eFormatBytes, 1, UINT64_MAX), 1251 m_memory_options() { 1252 CommandArgumentEntry arg1; 1253 CommandArgumentEntry arg2; 1254 CommandArgumentData addr_arg; 1255 CommandArgumentData value_arg; 1256 1257 // Define the first (and only) variant of this arg. 1258 addr_arg.arg_type = eArgTypeAddress; 1259 addr_arg.arg_repetition = eArgRepeatPlain; 1260 1261 // There is only one variant this argument could be; put it into the 1262 // argument entry. 1263 arg1.push_back(addr_arg); 1264 1265 // Define the first (and only) variant of this arg. 1266 value_arg.arg_type = eArgTypeValue; 1267 value_arg.arg_repetition = eArgRepeatPlus; 1268 1269 // There is only one variant this argument could be; put it into the 1270 // argument entry. 1271 arg2.push_back(value_arg); 1272 1273 // Push the data for the first argument into the m_arguments vector. 1274 m_arguments.push_back(arg1); 1275 m_arguments.push_back(arg2); 1276 1277 m_option_group.Append(&m_format_options, 1278 OptionGroupFormat::OPTION_GROUP_FORMAT, 1279 LLDB_OPT_SET_1); 1280 m_option_group.Append(&m_format_options, 1281 OptionGroupFormat::OPTION_GROUP_SIZE, 1282 LLDB_OPT_SET_1 | LLDB_OPT_SET_2); 1283 m_option_group.Append(&m_memory_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_2); 1284 m_option_group.Finalize(); 1285 } 1286 1287 ~CommandObjectMemoryWrite() override = default; 1288 1289 Options *GetOptions() override { return &m_option_group; } 1290 1291 bool UIntValueIsValidForSize(uint64_t uval64, size_t total_byte_size) { 1292 if (total_byte_size > 8) 1293 return false; 1294 1295 if (total_byte_size == 8) 1296 return true; 1297 1298 const uint64_t max = ((uint64_t)1 << (uint64_t)(total_byte_size * 8)) - 1; 1299 return uval64 <= max; 1300 } 1301 1302 bool SIntValueIsValidForSize(int64_t sval64, size_t total_byte_size) { 1303 if (total_byte_size > 8) 1304 return false; 1305 1306 if (total_byte_size == 8) 1307 return true; 1308 1309 const int64_t max = ((int64_t)1 << (uint64_t)(total_byte_size * 8 - 1)) - 1; 1310 const int64_t min = ~(max); 1311 return min <= sval64 && sval64 <= max; 1312 } 1313 1314 protected: 1315 bool DoExecute(Args &command, CommandReturnObject &result) override { 1316 // No need to check "process" for validity as eCommandRequiresProcess 1317 // ensures it is valid 1318 Process *process = m_exe_ctx.GetProcessPtr(); 1319 1320 const size_t argc = command.GetArgumentCount(); 1321 1322 if (m_memory_options.m_infile) { 1323 if (argc < 1) { 1324 result.AppendErrorWithFormat( 1325 "%s takes a destination address when writing file contents.\n", 1326 m_cmd_name.c_str()); 1327 result.SetStatus(eReturnStatusFailed); 1328 return false; 1329 } 1330 } else if (argc < 2) { 1331 result.AppendErrorWithFormat( 1332 "%s takes a destination address and at least one value.\n", 1333 m_cmd_name.c_str()); 1334 result.SetStatus(eReturnStatusFailed); 1335 return false; 1336 } 1337 1338 StreamString buffer( 1339 Stream::eBinary, 1340 process->GetTarget().GetArchitecture().GetAddressByteSize(), 1341 process->GetTarget().GetArchitecture().GetByteOrder()); 1342 1343 OptionValueUInt64 &byte_size_value = m_format_options.GetByteSizeValue(); 1344 size_t item_byte_size = byte_size_value.GetCurrentValue(); 1345 1346 Status error; 1347 lldb::addr_t addr = OptionArgParser::ToAddress( 1348 &m_exe_ctx, command[0].ref, LLDB_INVALID_ADDRESS, &error); 1349 1350 if (addr == LLDB_INVALID_ADDRESS) { 1351 result.AppendError("invalid address expression\n"); 1352 result.AppendError(error.AsCString()); 1353 result.SetStatus(eReturnStatusFailed); 1354 return false; 1355 } 1356 1357 if (m_memory_options.m_infile) { 1358 size_t length = SIZE_MAX; 1359 if (item_byte_size > 1) 1360 length = item_byte_size; 1361 auto data_sp = FileSystem::Instance().CreateDataBuffer( 1362 m_memory_options.m_infile.GetPath(), length, 1363 m_memory_options.m_infile_offset); 1364 if (data_sp) { 1365 length = data_sp->GetByteSize(); 1366 if (length > 0) { 1367 Status error; 1368 size_t bytes_written = 1369 process->WriteMemory(addr, data_sp->GetBytes(), length, error); 1370 1371 if (bytes_written == length) { 1372 // All bytes written 1373 result.GetOutputStream().Printf( 1374 "%" PRIu64 " bytes were written to 0x%" PRIx64 "\n", 1375 (uint64_t)bytes_written, addr); 1376 result.SetStatus(eReturnStatusSuccessFinishResult); 1377 } else if (bytes_written > 0) { 1378 // Some byte written 1379 result.GetOutputStream().Printf( 1380 "%" PRIu64 " bytes of %" PRIu64 1381 " requested were written to 0x%" PRIx64 "\n", 1382 (uint64_t)bytes_written, (uint64_t)length, addr); 1383 result.SetStatus(eReturnStatusSuccessFinishResult); 1384 } else { 1385 result.AppendErrorWithFormat("Memory write to 0x%" PRIx64 1386 " failed: %s.\n", 1387 addr, error.AsCString()); 1388 result.SetStatus(eReturnStatusFailed); 1389 } 1390 } 1391 } else { 1392 result.AppendErrorWithFormat("Unable to read contents of file.\n"); 1393 result.SetStatus(eReturnStatusFailed); 1394 } 1395 return result.Succeeded(); 1396 } else if (item_byte_size == 0) { 1397 if (m_format_options.GetFormat() == eFormatPointer) 1398 item_byte_size = buffer.GetAddressByteSize(); 1399 else 1400 item_byte_size = 1; 1401 } 1402 1403 command.Shift(); // shift off the address argument 1404 uint64_t uval64; 1405 int64_t sval64; 1406 bool success = false; 1407 for (auto &entry : command) { 1408 switch (m_format_options.GetFormat()) { 1409 case kNumFormats: 1410 case eFormatFloat: // TODO: add support for floats soon 1411 case eFormatCharPrintable: 1412 case eFormatBytesWithASCII: 1413 case eFormatComplex: 1414 case eFormatEnum: 1415 case eFormatUnicode16: 1416 case eFormatUnicode32: 1417 case eFormatVectorOfChar: 1418 case eFormatVectorOfSInt8: 1419 case eFormatVectorOfUInt8: 1420 case eFormatVectorOfSInt16: 1421 case eFormatVectorOfUInt16: 1422 case eFormatVectorOfSInt32: 1423 case eFormatVectorOfUInt32: 1424 case eFormatVectorOfSInt64: 1425 case eFormatVectorOfUInt64: 1426 case eFormatVectorOfFloat16: 1427 case eFormatVectorOfFloat32: 1428 case eFormatVectorOfFloat64: 1429 case eFormatVectorOfUInt128: 1430 case eFormatOSType: 1431 case eFormatComplexInteger: 1432 case eFormatAddressInfo: 1433 case eFormatHexFloat: 1434 case eFormatInstruction: 1435 case eFormatVoid: 1436 result.AppendError("unsupported format for writing memory"); 1437 result.SetStatus(eReturnStatusFailed); 1438 return false; 1439 1440 case eFormatDefault: 1441 case eFormatBytes: 1442 case eFormatHex: 1443 case eFormatHexUppercase: 1444 case eFormatPointer: 1445 { 1446 // Decode hex bytes 1447 // Be careful, getAsInteger with a radix of 16 rejects "0xab" so we 1448 // have to special case that: 1449 bool success = false; 1450 if (entry.ref.startswith("0x")) 1451 success = !entry.ref.getAsInteger(0, uval64); 1452 if (!success) 1453 success = !entry.ref.getAsInteger(16, uval64); 1454 if (!success) { 1455 result.AppendErrorWithFormat( 1456 "'%s' is not a valid hex string value.\n", entry.c_str()); 1457 result.SetStatus(eReturnStatusFailed); 1458 return false; 1459 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) { 1460 result.AppendErrorWithFormat("Value 0x%" PRIx64 1461 " is too large to fit in a %" PRIu64 1462 " byte unsigned integer value.\n", 1463 uval64, (uint64_t)item_byte_size); 1464 result.SetStatus(eReturnStatusFailed); 1465 return false; 1466 } 1467 buffer.PutMaxHex64(uval64, item_byte_size); 1468 break; 1469 } 1470 case eFormatBoolean: 1471 uval64 = OptionArgParser::ToBoolean(entry.ref, false, &success); 1472 if (!success) { 1473 result.AppendErrorWithFormat( 1474 "'%s' is not a valid boolean string value.\n", entry.c_str()); 1475 result.SetStatus(eReturnStatusFailed); 1476 return false; 1477 } 1478 buffer.PutMaxHex64(uval64, item_byte_size); 1479 break; 1480 1481 case eFormatBinary: 1482 if (entry.ref.getAsInteger(2, uval64)) { 1483 result.AppendErrorWithFormat( 1484 "'%s' is not a valid binary string value.\n", entry.c_str()); 1485 result.SetStatus(eReturnStatusFailed); 1486 return false; 1487 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) { 1488 result.AppendErrorWithFormat("Value 0x%" PRIx64 1489 " is too large to fit in a %" PRIu64 1490 " byte unsigned integer value.\n", 1491 uval64, (uint64_t)item_byte_size); 1492 result.SetStatus(eReturnStatusFailed); 1493 return false; 1494 } 1495 buffer.PutMaxHex64(uval64, item_byte_size); 1496 break; 1497 1498 case eFormatCharArray: 1499 case eFormatChar: 1500 case eFormatCString: { 1501 if (entry.ref.empty()) 1502 break; 1503 1504 size_t len = entry.ref.size(); 1505 // Include the NULL for C strings... 1506 if (m_format_options.GetFormat() == eFormatCString) 1507 ++len; 1508 Status error; 1509 if (process->WriteMemory(addr, entry.c_str(), len, error) == len) { 1510 addr += len; 1511 } else { 1512 result.AppendErrorWithFormat("Memory write to 0x%" PRIx64 1513 " failed: %s.\n", 1514 addr, error.AsCString()); 1515 result.SetStatus(eReturnStatusFailed); 1516 return false; 1517 } 1518 break; 1519 } 1520 case eFormatDecimal: 1521 if (entry.ref.getAsInteger(0, sval64)) { 1522 result.AppendErrorWithFormat( 1523 "'%s' is not a valid signed decimal value.\n", entry.c_str()); 1524 result.SetStatus(eReturnStatusFailed); 1525 return false; 1526 } else if (!SIntValueIsValidForSize(sval64, item_byte_size)) { 1527 result.AppendErrorWithFormat( 1528 "Value %" PRIi64 " is too large or small to fit in a %" PRIu64 1529 " byte signed integer value.\n", 1530 sval64, (uint64_t)item_byte_size); 1531 result.SetStatus(eReturnStatusFailed); 1532 return false; 1533 } 1534 buffer.PutMaxHex64(sval64, item_byte_size); 1535 break; 1536 1537 case eFormatUnsigned: 1538 1539 if (!entry.ref.getAsInteger(0, uval64)) { 1540 result.AppendErrorWithFormat( 1541 "'%s' is not a valid unsigned decimal string value.\n", 1542 entry.c_str()); 1543 result.SetStatus(eReturnStatusFailed); 1544 return false; 1545 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) { 1546 result.AppendErrorWithFormat("Value %" PRIu64 1547 " is too large to fit in a %" PRIu64 1548 " byte unsigned integer value.\n", 1549 uval64, (uint64_t)item_byte_size); 1550 result.SetStatus(eReturnStatusFailed); 1551 return false; 1552 } 1553 buffer.PutMaxHex64(uval64, item_byte_size); 1554 break; 1555 1556 case eFormatOctal: 1557 if (entry.ref.getAsInteger(8, uval64)) { 1558 result.AppendErrorWithFormat( 1559 "'%s' is not a valid octal string value.\n", entry.c_str()); 1560 result.SetStatus(eReturnStatusFailed); 1561 return false; 1562 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) { 1563 result.AppendErrorWithFormat("Value %" PRIo64 1564 " is too large to fit in a %" PRIu64 1565 " byte unsigned integer value.\n", 1566 uval64, (uint64_t)item_byte_size); 1567 result.SetStatus(eReturnStatusFailed); 1568 return false; 1569 } 1570 buffer.PutMaxHex64(uval64, item_byte_size); 1571 break; 1572 } 1573 } 1574 1575 if (!buffer.GetString().empty()) { 1576 Status error; 1577 if (process->WriteMemory(addr, buffer.GetString().data(), 1578 buffer.GetString().size(), 1579 error) == buffer.GetString().size()) 1580 return true; 1581 else { 1582 result.AppendErrorWithFormat("Memory write to 0x%" PRIx64 1583 " failed: %s.\n", 1584 addr, error.AsCString()); 1585 result.SetStatus(eReturnStatusFailed); 1586 return false; 1587 } 1588 } 1589 return true; 1590 } 1591 1592 OptionGroupOptions m_option_group; 1593 OptionGroupFormat m_format_options; 1594 OptionGroupWriteMemory m_memory_options; 1595 }; 1596 1597 //---------------------------------------------------------------------- 1598 // Get malloc/free history of a memory address. 1599 //---------------------------------------------------------------------- 1600 class CommandObjectMemoryHistory : public CommandObjectParsed { 1601 public: 1602 CommandObjectMemoryHistory(CommandInterpreter &interpreter) 1603 : CommandObjectParsed( 1604 interpreter, "memory history", "Print recorded stack traces for " 1605 "allocation/deallocation events " 1606 "associated with an address.", 1607 nullptr, 1608 eCommandRequiresTarget | eCommandRequiresProcess | 1609 eCommandProcessMustBePaused | eCommandProcessMustBeLaunched) { 1610 CommandArgumentEntry arg1; 1611 CommandArgumentData addr_arg; 1612 1613 // Define the first (and only) variant of this arg. 1614 addr_arg.arg_type = eArgTypeAddress; 1615 addr_arg.arg_repetition = eArgRepeatPlain; 1616 1617 // There is only one variant this argument could be; put it into the 1618 // argument entry. 1619 arg1.push_back(addr_arg); 1620 1621 // Push the data for the first argument into the m_arguments vector. 1622 m_arguments.push_back(arg1); 1623 } 1624 1625 ~CommandObjectMemoryHistory() override = default; 1626 1627 const char *GetRepeatCommand(Args ¤t_command_args, 1628 uint32_t index) override { 1629 return m_cmd_name.c_str(); 1630 } 1631 1632 protected: 1633 bool DoExecute(Args &command, CommandReturnObject &result) override { 1634 const size_t argc = command.GetArgumentCount(); 1635 1636 if (argc == 0 || argc > 1) { 1637 result.AppendErrorWithFormat("%s takes an address expression", 1638 m_cmd_name.c_str()); 1639 result.SetStatus(eReturnStatusFailed); 1640 return false; 1641 } 1642 1643 Status error; 1644 lldb::addr_t addr = OptionArgParser::ToAddress( 1645 &m_exe_ctx, command[0].ref, LLDB_INVALID_ADDRESS, &error); 1646 1647 if (addr == LLDB_INVALID_ADDRESS) { 1648 result.AppendError("invalid address expression"); 1649 result.AppendError(error.AsCString()); 1650 result.SetStatus(eReturnStatusFailed); 1651 return false; 1652 } 1653 1654 Stream *output_stream = &result.GetOutputStream(); 1655 1656 const ProcessSP &process_sp = m_exe_ctx.GetProcessSP(); 1657 const MemoryHistorySP &memory_history = 1658 MemoryHistory::FindPlugin(process_sp); 1659 1660 if (!memory_history) { 1661 result.AppendError("no available memory history provider"); 1662 result.SetStatus(eReturnStatusFailed); 1663 return false; 1664 } 1665 1666 HistoryThreads thread_list = memory_history->GetHistoryThreads(addr); 1667 1668 const bool stop_format = false; 1669 for (auto thread : thread_list) { 1670 thread->GetStatus(*output_stream, 0, UINT32_MAX, 0, stop_format); 1671 } 1672 1673 result.SetStatus(eReturnStatusSuccessFinishResult); 1674 1675 return true; 1676 } 1677 }; 1678 1679 //------------------------------------------------------------------------- 1680 // CommandObjectMemoryRegion 1681 //------------------------------------------------------------------------- 1682 #pragma mark CommandObjectMemoryRegion 1683 1684 class CommandObjectMemoryRegion : public CommandObjectParsed { 1685 public: 1686 CommandObjectMemoryRegion(CommandInterpreter &interpreter) 1687 : CommandObjectParsed(interpreter, "memory region", 1688 "Get information on the memory region containing " 1689 "an address in the current target process.", 1690 "memory region ADDR", 1691 eCommandRequiresProcess | eCommandTryTargetAPILock | 1692 eCommandProcessMustBeLaunched), 1693 m_prev_end_addr(LLDB_INVALID_ADDRESS) {} 1694 1695 ~CommandObjectMemoryRegion() override = default; 1696 1697 protected: 1698 bool DoExecute(Args &command, CommandReturnObject &result) override { 1699 ProcessSP process_sp = m_exe_ctx.GetProcessSP(); 1700 if (process_sp) { 1701 Status error; 1702 lldb::addr_t load_addr = m_prev_end_addr; 1703 m_prev_end_addr = LLDB_INVALID_ADDRESS; 1704 1705 const size_t argc = command.GetArgumentCount(); 1706 if (argc > 1 || (argc == 0 && load_addr == LLDB_INVALID_ADDRESS)) { 1707 result.AppendErrorWithFormat("'%s' takes one argument:\nUsage: %s\n", 1708 m_cmd_name.c_str(), m_cmd_syntax.c_str()); 1709 result.SetStatus(eReturnStatusFailed); 1710 } else { 1711 if (command.GetArgumentCount() == 1) { 1712 auto load_addr_str = command[0].ref; 1713 load_addr = OptionArgParser::ToAddress(&m_exe_ctx, load_addr_str, 1714 LLDB_INVALID_ADDRESS, &error); 1715 if (error.Fail() || load_addr == LLDB_INVALID_ADDRESS) { 1716 result.AppendErrorWithFormat( 1717 "invalid address argument \"%s\": %s\n", command[0].c_str(), 1718 error.AsCString()); 1719 result.SetStatus(eReturnStatusFailed); 1720 } 1721 } 1722 1723 lldb_private::MemoryRegionInfo range_info; 1724 error = process_sp->GetMemoryRegionInfo(load_addr, range_info); 1725 if (error.Success()) { 1726 lldb_private::Address addr; 1727 ConstString name = range_info.GetName(); 1728 ConstString section_name; 1729 if (process_sp->GetTarget().ResolveLoadAddress(load_addr, addr)) { 1730 SectionSP section_sp(addr.GetSection()); 1731 if (section_sp) { 1732 // Got the top most section, not the deepest section 1733 while (section_sp->GetParent()) 1734 section_sp = section_sp->GetParent(); 1735 section_name = section_sp->GetName(); 1736 } 1737 } 1738 result.AppendMessageWithFormat( 1739 "[0x%16.16" PRIx64 "-0x%16.16" PRIx64 ") %c%c%c%s%s%s%s\n", 1740 range_info.GetRange().GetRangeBase(), 1741 range_info.GetRange().GetRangeEnd(), 1742 range_info.GetReadable() ? 'r' : '-', 1743 range_info.GetWritable() ? 'w' : '-', 1744 range_info.GetExecutable() ? 'x' : '-', 1745 name ? " " : "", name.AsCString(""), 1746 section_name ? " " : "", section_name.AsCString("")); 1747 m_prev_end_addr = range_info.GetRange().GetRangeEnd(); 1748 result.SetStatus(eReturnStatusSuccessFinishResult); 1749 } else { 1750 result.SetStatus(eReturnStatusFailed); 1751 result.AppendErrorWithFormat("%s\n", error.AsCString()); 1752 } 1753 } 1754 } else { 1755 m_prev_end_addr = LLDB_INVALID_ADDRESS; 1756 result.AppendError("invalid process"); 1757 result.SetStatus(eReturnStatusFailed); 1758 } 1759 return result.Succeeded(); 1760 } 1761 1762 const char *GetRepeatCommand(Args ¤t_command_args, 1763 uint32_t index) override { 1764 // If we repeat this command, repeat it without any arguments so we can 1765 // show the next memory range 1766 return m_cmd_name.c_str(); 1767 } 1768 1769 lldb::addr_t m_prev_end_addr; 1770 }; 1771 1772 //------------------------------------------------------------------------- 1773 // CommandObjectMemory 1774 //------------------------------------------------------------------------- 1775 1776 CommandObjectMemory::CommandObjectMemory(CommandInterpreter &interpreter) 1777 : CommandObjectMultiword( 1778 interpreter, "memory", 1779 "Commands for operating on memory in the current target process.", 1780 "memory <subcommand> [<subcommand-options>]") { 1781 LoadSubCommand("find", 1782 CommandObjectSP(new CommandObjectMemoryFind(interpreter))); 1783 LoadSubCommand("read", 1784 CommandObjectSP(new CommandObjectMemoryRead(interpreter))); 1785 LoadSubCommand("write", 1786 CommandObjectSP(new CommandObjectMemoryWrite(interpreter))); 1787 LoadSubCommand("history", 1788 CommandObjectSP(new CommandObjectMemoryHistory(interpreter))); 1789 LoadSubCommand("region", 1790 CommandObjectSP(new CommandObjectMemoryRegion(interpreter))); 1791 } 1792 1793 CommandObjectMemory::~CommandObjectMemory() = default; 1794