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