1 //===-- CommandObjectMemory.cpp ---------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
14 // Other libraries and framework includes
15 #include "clang/AST/Decl.h"
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"
46 #include "lldb/lldb-private.h"
49 using namespace lldb_private;
51 static OptionDefinition g_read_memory_options[] = {
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." },
60 LLDB_OPT_SET_3, false, "force", 'r', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, "Necessary if reading over target.max-memory-read-size bytes." },
64 class OptionGroupReadMemory : public OptionGroup {
66 OptionGroupReadMemory()
67 : m_num_per_line(1, 1), m_output_as_binary(false), m_view_as_type(),
70 ~OptionGroupReadMemory() override = default;
72 llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
73 return llvm::makeArrayRef(g_read_memory_options);
76 Error SetOptionValue(uint32_t option_idx, llvm::StringRef option_value,
77 ExecutionContext *execution_context) override {
79 const int short_option = g_read_memory_options[option_idx].short_option;
81 switch (short_option) {
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());
91 m_output_as_binary = true;
95 error = m_view_as_type.SetValueFromString(option_value);
103 error = m_offset.SetValueFromString(option_value);
107 error.SetErrorStringWithFormat("unrecognized short option '%c'",
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();
122 Error FinalizeSettings(Target *target, OptionGroupFormat &format_options) {
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();
130 switch (format_options.GetFormat()) {
135 if (!byte_size_option_set)
137 if (!num_per_line_option_set)
139 if (!count_option_set)
140 format_options.GetCountValue() = 8;
146 case eFormatInstruction:
147 if (count_option_set)
148 byte_size_value = target->GetArchitecture().GetMaximumOpcodeByteSize();
152 case eFormatAddressInfo:
153 if (!byte_size_option_set)
154 byte_size_value = target->GetArchitecture().GetAddressByteSize();
156 if (!count_option_set)
157 format_options.GetCountValue() = 8;
161 byte_size_value = target->GetArchitecture().GetAddressByteSize();
162 if (!num_per_line_option_set)
164 if (!count_option_set)
165 format_options.GetCountValue() = 8;
173 case eFormatUnicode16:
174 case eFormatUnicode32:
175 case eFormatUnsigned:
176 case eFormatHexFloat:
177 if (!byte_size_option_set)
179 if (!num_per_line_option_set)
181 if (!count_option_set)
182 format_options.GetCountValue() = 8;
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 "
194 byte_size_value.GetCurrentValue());
197 if (!num_per_line_option_set)
199 if (!count_option_set)
200 format_options.GetCountValue() = 32;
203 case eFormatCharArray:
205 case eFormatCharPrintable:
206 if (!byte_size_option_set)
208 if (!num_per_line_option_set)
210 if (!count_option_set)
211 format_options.GetCountValue() = 64;
215 if (!byte_size_option_set)
217 if (!num_per_line_option_set)
219 if (!count_option_set)
220 format_options.GetCountValue() = 8;
223 case eFormatComplexInteger:
224 if (!byte_size_option_set)
226 if (!num_per_line_option_set)
228 if (!count_option_set)
229 format_options.GetCountValue() = 8;
233 if (!byte_size_option_set)
235 if (!num_per_line_option_set) {
236 switch (byte_size_value) {
252 if (!count_option_set)
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)
273 if (!count_option_set)
280 bool AnyOptionWasSet() const {
281 return m_num_per_line.OptionWasSet() || m_output_as_binary ||
282 m_view_as_type.OptionWasSet() || m_offset.OptionWasSet();
285 OptionValueUInt64 m_num_per_line;
286 bool m_output_as_binary;
287 OptionValueString m_view_as_type;
289 OptionValueUInt64 m_offset;
292 //----------------------------------------------------------------------
293 // Read memory from the inferior process
294 //----------------------------------------------------------------------
295 class CommandObjectMemoryRead : public CommandObjectParsed {
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;
313 // Define the first (and only) variant of this arg.
314 start_addr_arg.arg_type = eArgTypeAddressOrExpression;
315 start_addr_arg.arg_repetition = eArgRepeatPlain;
317 // There is only one variant this argument could be; put it into the
319 arg1.push_back(start_addr_arg);
321 // Define the first (and only) variant of this arg.
322 end_addr_arg.arg_type = eArgTypeAddressOrExpression;
323 end_addr_arg.arg_repetition = eArgRepeatOptional;
325 // There is only one variant this argument could be; put it into the
327 arg2.push_back(end_addr_arg);
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);
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();
352 ~CommandObjectMemoryRead() override = default;
354 Options *GetOptions() override { return &m_option_group; }
356 const char *GetRepeatCommand(Args ¤t_command_args,
357 uint32_t index) override {
358 return m_cmd_name.c_str();
362 bool DoExecute(Args &command, CommandReturnObject &result) override {
363 // No need to check "target" for validity as eCommandRequiresTarget ensures
365 Target *target = m_exe_ctx.GetTargetPtr();
367 const size_t argc = command.GetArgumentCount();
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",
373 result.AppendRawWarning("Expressions should be quoted if they contain "
374 "spaces or other special characters.\n");
375 result.SetStatus(eReturnStatusFailed);
379 CompilerType clang_ast_type;
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
388 const bool exact_match = false;
390 uint32_t reference_count = 0;
391 uint32_t pointer_count = 0;
394 #define ALL_KEYWORDS \
396 KEYWORD("volatile") \
397 KEYWORD("restrict") \
402 #define KEYWORD(s) s,
403 static const char *g_keywords[] = {ALL_KEYWORDS};
406 #define KEYWORD(s) (sizeof(s) - 1),
407 static const int g_keyword_lengths[] = {ALL_KEYWORDS};
412 static size_t g_num_keywords = sizeof(g_keywords) / sizeof(const char *);
413 std::string type_str(view_as_type_cstr);
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];
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);
431 bool done = type_str.empty();
433 idx = type_str.find_first_not_of(" \t");
434 if (idx > 0 && idx != std::string::npos)
435 type_str.erase(0, idx);
437 // Strip trailing spaces
438 if (type_str.empty())
441 switch (type_str[type_str.size() - 1]) {
447 type_str.erase(type_str.size() - 1);
451 if (reference_count == 0) {
453 type_str.erase(type_str.size() - 1);
455 result.AppendErrorWithFormat("invalid type string: '%s'\n",
457 result.SetStatus(eReturnStatusFailed);
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();
473 sc = frame->GetSymbolContext(eSymbolContextModule);
475 sc.module_sp->FindTypes(sc, lookup_type_name, exact_match, 1,
476 searched_symbol_files, type_list);
479 if (type_list.GetSize() == 0) {
480 target->GetImages().FindTypes(sc, lookup_type_name, exact_match, 1,
481 searched_symbol_files, type_list);
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)));
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())));
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(),
509 result.SetStatus(eReturnStatusFailed);
512 TypeSP type_sp(type_list.GetTypeAtIndex(0));
513 clang_ast_type = type_sp->GetFullCompilerType();
517 while (pointer_count > 0) {
518 CompilerType pointer_type = clang_ast_type.GetPointerType();
519 if (pointer_type.IsValid())
520 clang_ast_type = pointer_type;
522 result.AppendError("unable make a pointer type\n");
523 result.SetStatus(eReturnStatusFailed);
529 m_format_options.GetByteSizeValue() = clang_ast_type.GetByteSize(nullptr);
531 if (m_format_options.GetByteSizeValue() == 0) {
532 result.AppendErrorWithFormat(
533 "unable to get the byte size of the type '%s'\n",
535 result.SetStatus(eReturnStatusFailed);
539 if (!m_format_options.GetCountValue().OptionWasSet())
540 m_format_options.GetCountValue() = 1;
542 error = m_memory_options.FinalizeSettings(target, m_format_options);
545 // Look for invalid combinations of settings
547 result.AppendError(error.AsCString());
548 result.SetStatus(eReturnStatusFailed);
553 size_t total_byte_size = 0;
555 // Use the last address and byte size and all options as they were
556 // if no options have been set
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;
571 size_t item_count = m_format_options.GetCountValue().GetCurrentValue();
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();
582 const size_t num_per_line =
583 m_memory_options.m_num_per_line.GetCurrentValue();
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;
592 addr = Args::StringToAddress(&m_exe_ctx, command[0].ref,
593 LLDB_INVALID_ADDRESS, &error);
595 if (addr == LLDB_INVALID_ADDRESS) {
596 result.AppendError("invalid start address expression.");
597 result.AppendError(error.AsCString());
598 result.SetStatus(eReturnStatusFailed);
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);
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",
615 result.SetStatus(eReturnStatusFailed);
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);
626 total_byte_size = end_addr - addr;
627 item_count = total_byte_size / item_byte_size;
630 uint32_t max_unforced_size = target->GetMaximumMemReadSize();
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
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");
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
649 if (!m_format_options.GetFormatValue().OptionWasSet())
650 m_format_options.GetFormatValue().SetCurrentValue(eFormatDefault);
652 bytes_read = clang_ast_type.GetByteSize(nullptr) *
653 m_format_options.GetCountValue().GetCurrentValue();
656 addr = addr + (clang_ast_type.GetByteSize(nullptr) *
657 m_memory_options.m_offset.GetCurrentValue());
658 } else if (m_format_options.GetFormatValue().GetCurrentValue() !=
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);
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);
678 result.AppendErrorWithFormat(
679 "failed to read memory from 0x%" PRIx64 ".\n", addr);
681 result.SetStatus(eReturnStatusFailed);
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);
691 // we treat c-strings as a special case because they do not have a fixed
693 if (m_format_options.GetByteSizeValue().OptionWasSet() &&
694 !m_format_options.HasGDBFormat())
695 item_byte_size = m_format_options.GetByteSizeValue().GetCurrentValue();
697 item_byte_size = target->GetMaximumSizeOfStringSummary();
698 if (!m_format_options.GetCountValue().OptionWasSet())
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);
710 uint8_t *data_ptr = data_sp->GetBytes();
711 auto data_addr = addr;
712 auto count = item_count;
714 bool break_on_no_NULL = false;
715 while (item_count < count) {
717 buffer.resize(item_byte_size + 1, 0);
719 size_t read = target->ReadCStringFromMemory(data_addr, &buffer[0],
720 item_byte_size + 1, error);
722 result.AppendErrorWithFormat(
723 "failed to read memory from 0x%" PRIx64 ".\n", addr);
724 result.SetStatus(eReturnStatusFailed);
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",
734 break_on_no_NULL = true;
736 ++read; // account for final NULL byte
738 memcpy(data_ptr, &buffer[0], read);
742 item_count++; // if we break early we know we only read item_count
745 if (break_on_no_NULL)
748 data_sp.reset(new DataBufferHeap(data_sp->GetBytes(), bytes_read + 1));
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;
759 StreamFile outfile_stream;
760 Stream *output_stream = nullptr;
761 const FileSpec &outfile_spec =
762 m_outfile_options.GetFile().GetCurrentValue();
765 outfile_spec.GetPath(path, sizeof(path));
767 uint32_t open_options =
768 File::eOpenOptionWrite | File::eOpenOptionCanCreate;
769 const bool append = m_outfile_options.GetAppend().GetCurrentValue();
771 open_options |= File::eOpenOptionAppend;
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);
783 result.AppendErrorWithFormat("Failed to write %" PRIu64
785 (uint64_t)bytes_read, path);
786 result.SetStatus(eReturnStatusFailed);
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;
795 result.AppendErrorWithFormat("Failed to open file '%s' for %s.\n", path,
796 append ? "append" : "write");
797 result.SetStatus(eReturnStatusFailed);
801 output_stream = &result.GetOutputStream();
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));
814 Format format = m_format_options.GetFormat();
815 if (format != eFormatDefault)
816 valobj_sp->SetFormat(format);
818 DumpValueObjectOptions options(m_varobj_options.GetAsDumpOptions(
819 eLanguageRuntimeDescriptionDisplayVerbosityFull, format));
821 valobj_sp->Dump(*output_stream, options);
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);
833 result.SetStatus(eReturnStatusSuccessFinishResult);
834 DataExtractor data(data_sp, target->GetArchitecture().GetByteOrder(),
835 target->GetArchitecture().GetAddressByteSize(),
836 target->GetArchitecture().GetDataByteSize());
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
848 format = eFormatCharArray;
849 item_count = item_byte_size;
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);
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();
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;
887 OptionDefinition g_memory_find_option_table[] = {
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."},
896 //----------------------------------------------------------------------
897 // Find the specified data in memory
898 //----------------------------------------------------------------------
899 class CommandObjectMemoryFind : public CommandObjectParsed {
901 class OptionGroupFindMemory : public OptionGroup {
903 OptionGroupFindMemory() : OptionGroup(), m_count(1), m_offset(0) {}
905 ~OptionGroupFindMemory() override = default;
907 llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
908 return llvm::makeArrayRef(g_memory_find_option_table);
911 Error SetOptionValue(uint32_t option_idx, llvm::StringRef option_value,
912 ExecutionContext *execution_context) override {
914 const int short_option =
915 g_memory_find_option_table[option_idx].short_option;
917 switch (short_option) {
919 m_expr.SetValueFromString(option_value);
923 m_string.SetValueFromString(option_value);
927 if (m_count.SetValueFromString(option_value).Fail())
928 error.SetErrorString("unrecognized value for count");
932 if (m_offset.SetValueFromString(option_value).Fail())
933 error.SetErrorString("unrecognized value for dump-offset");
937 error.SetErrorStringWithFormat("unrecognized short option '%c'",
944 void OptionParsingStarting(ExecutionContext *execution_context) override {
950 OptionValueString m_expr;
951 OptionValueString m_string;
952 OptionValueUInt64 m_count;
953 OptionValueUInt64 m_offset;
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;
967 // Define the first (and only) variant of this arg.
968 addr_arg.arg_type = eArgTypeAddressOrExpression;
969 addr_arg.arg_repetition = eArgRepeatPlain;
971 // There is only one variant this argument could be; put it into the
973 arg1.push_back(addr_arg);
975 // Define the first (and only) variant of this arg.
976 value_arg.arg_type = eArgTypeAddressOrExpression;
977 value_arg.arg_repetition = eArgRepeatPlain;
979 // There is only one variant this argument could be; put it into the
981 arg2.push_back(value_arg);
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);
987 m_option_group.Append(&m_memory_options);
988 m_option_group.Finalize();
991 ~CommandObjectMemoryFind() override = default;
993 Options *GetOptions() override { return &m_option_group; }
996 class ProcessMemoryIterator {
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);
1003 bool IsValid() { return m_is_valid; }
1005 uint8_t operator[](lldb::addr_t offset) {
1012 m_process_sp->ReadMemory(m_base_addr + offset, &retval, 1, error)) {
1021 ProcessSP m_process_sp;
1022 lldb::addr_t m_base_addr;
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();
1030 const size_t argc = command.GetArgumentCount();
1033 result.AppendError("two addresses needed for memory find");
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");
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");
1051 if (high_addr <= low_addr) {
1053 "starting address must be smaller than ending address");
1057 lldb::addr_t found_location = LLDB_INVALID_ADDRESS;
1059 DataBufferHeap buffer;
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)) &&
1070 uint64_t value = result_sp->GetValueAsUnsigned(0);
1071 switch (result_sp->GetCompilerType().GetByteSize(nullptr)) {
1073 uint8_t byte = (uint8_t)value;
1074 buffer.CopyData(&byte, 1);
1077 uint16_t word = (uint16_t)value;
1078 buffer.CopyData(&word, 2);
1081 uint32_t lword = (uint32_t)value;
1082 buffer.CopyData(&lword, 4);
1085 buffer.CopyData(&value, 8);
1091 result.AppendError("unknown type. pass a string instead");
1095 "result size larger than 8 bytes. pass a string instead");
1100 "expression evaluation failed. pass a string instead");
1105 "please pass either a block of text, or an expression to evaluate.");
1109 size_t count = m_memory_options.m_count.GetCurrentValue();
1110 found_location = low_addr;
1111 bool ever_found = false;
1113 found_location = FastSearch(found_location, high_addr, buffer.GetBytes(),
1114 buffer.GetByteSize());
1115 if (found_location == LLDB_INVALID_ADDRESS) {
1117 result.AppendMessage("data not found within the range.\n");
1118 result.SetStatus(lldb::eReturnStatusSuccessFinishNoResult);
1120 result.AppendMessage("no more matches within the range.\n");
1123 result.AppendMessageWithFormat("data found at location: 0x%" PRIx64 "\n",
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(),
1138 result.GetOutputStream().EOL();
1146 result.SetStatus(lldb::eReturnStatusSuccessFinishResult);
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;
1154 if (region_size < buffer_size)
1155 return LLDB_INVALID_ADDRESS;
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);
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;
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])
1172 s += bad_char_heuristic[iterator[s + buffer_size - 1]];
1175 return LLDB_INVALID_ADDRESS;
1178 OptionGroupOptions m_option_group;
1179 OptionGroupFindMemory m_memory_options;
1182 OptionDefinition g_memory_write_option_table[] = {
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."},
1189 //----------------------------------------------------------------------
1190 // Write memory to the inferior process
1191 //----------------------------------------------------------------------
1192 class CommandObjectMemoryWrite : public CommandObjectParsed {
1194 class OptionGroupWriteMemory : public OptionGroup {
1196 OptionGroupWriteMemory() : OptionGroup() {}
1198 ~OptionGroupWriteMemory() override = default;
1200 llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
1201 return llvm::makeArrayRef(g_memory_write_option_table);
1204 Error SetOptionValue(uint32_t option_idx, llvm::StringRef option_value,
1205 ExecutionContext *execution_context) override {
1207 const int short_option =
1208 g_memory_write_option_table[option_idx].short_option;
1210 switch (short_option) {
1212 m_infile.SetFile(option_value, true);
1213 if (!m_infile.Exists()) {
1215 error.SetErrorStringWithFormat("input file does not exist: '%s'",
1216 option_value.str().c_str());
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());
1229 error.SetErrorStringWithFormat("unrecognized short option '%c'",
1236 void OptionParsingStarting(ExecutionContext *execution_context) override {
1238 m_infile_offset = 0;
1242 off_t m_infile_offset;
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;
1257 // Define the first (and only) variant of this arg.
1258 addr_arg.arg_type = eArgTypeAddress;
1259 addr_arg.arg_repetition = eArgRepeatPlain;
1261 // There is only one variant this argument could be; put it into the
1263 arg1.push_back(addr_arg);
1265 // Define the first (and only) variant of this arg.
1266 value_arg.arg_type = eArgTypeValue;
1267 value_arg.arg_repetition = eArgRepeatPlus;
1269 // There is only one variant this argument could be; put it into the
1271 arg2.push_back(value_arg);
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);
1277 m_option_group.Append(&m_format_options,
1278 OptionGroupFormat::OPTION_GROUP_FORMAT,
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();
1287 ~CommandObjectMemoryWrite() override = default;
1289 Options *GetOptions() override { return &m_option_group; }
1291 bool UIntValueIsValidForSize(uint64_t uval64, size_t total_byte_size) {
1292 if (total_byte_size > 8)
1295 if (total_byte_size == 8)
1298 const uint64_t max = ((uint64_t)1 << (uint64_t)(total_byte_size * 8)) - 1;
1299 return uval64 <= max;
1302 bool SIntValueIsValidForSize(int64_t sval64, size_t total_byte_size) {
1303 if (total_byte_size > 8)
1306 if (total_byte_size == 8)
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;
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();
1320 const size_t argc = command.GetArgumentCount();
1322 if (m_memory_options.m_infile) {
1324 result.AppendErrorWithFormat(
1325 "%s takes a destination address when writing file contents.\n",
1326 m_cmd_name.c_str());
1327 result.SetStatus(eReturnStatusFailed);
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);
1338 StreamString buffer(
1340 process->GetTarget().GetArchitecture().GetAddressByteSize(),
1341 process->GetTarget().GetArchitecture().GetByteOrder());
1343 OptionValueUInt64 &byte_size_value = m_format_options.GetByteSizeValue();
1344 size_t item_byte_size = byte_size_value.GetCurrentValue();
1347 lldb::addr_t addr = Args::StringToAddress(&m_exe_ctx, command[0].ref,
1348 LLDB_INVALID_ADDRESS, &error);
1350 if (addr == LLDB_INVALID_ADDRESS) {
1351 result.AppendError("invalid address expression\n");
1352 result.AppendError(error.AsCString());
1353 result.SetStatus(eReturnStatusFailed);
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));
1364 length = data_sp->GetByteSize();
1367 size_t bytes_written =
1368 process->WriteMemory(addr, data_sp->GetBytes(), length, error);
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);
1384 result.AppendErrorWithFormat("Memory write to 0x%" PRIx64
1386 addr, error.AsCString());
1387 result.SetStatus(eReturnStatusFailed);
1391 result.AppendErrorWithFormat("Unable to read contents of file.\n");
1392 result.SetStatus(eReturnStatusFailed);
1394 return result.Succeeded();
1395 } else if (item_byte_size == 0) {
1396 if (m_format_options.GetFormat() == eFormatPointer)
1397 item_byte_size = buffer.GetAddressByteSize();
1402 command.Shift(); // shift off the address argument
1405 bool success = false;
1406 for (auto &entry : command) {
1407 switch (m_format_options.GetFormat()) {
1409 case eFormatFloat: // TODO: add support for floats soon
1410 case eFormatCharPrintable:
1411 case eFormatBytesWithASCII:
1412 case eFormatComplex:
1414 case eFormatUnicode16:
1415 case eFormatUnicode32:
1416 case eFormatVectorOfChar:
1417 case eFormatVectorOfSInt8:
1418 case eFormatVectorOfUInt8:
1419 case eFormatVectorOfSInt16:
1420 case eFormatVectorOfUInt16:
1421 case eFormatVectorOfSInt32:
1422 case eFormatVectorOfUInt32:
1423 case eFormatVectorOfSInt64:
1424 case eFormatVectorOfUInt64:
1425 case eFormatVectorOfFloat16:
1426 case eFormatVectorOfFloat32:
1427 case eFormatVectorOfFloat64:
1428 case eFormatVectorOfUInt128:
1430 case eFormatComplexInteger:
1431 case eFormatAddressInfo:
1432 case eFormatHexFloat:
1433 case eFormatInstruction:
1435 result.AppendError("unsupported format for writing memory");
1436 result.SetStatus(eReturnStatusFailed);
1439 case eFormatDefault:
1442 case eFormatHexUppercase:
1443 case eFormatPointer:
1445 if (entry.ref.getAsInteger(16, uval64)) {
1446 result.AppendErrorWithFormat(
1447 "'%s' is not a valid hex string value.\n", entry.c_str());
1448 result.SetStatus(eReturnStatusFailed);
1450 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) {
1451 result.AppendErrorWithFormat("Value 0x%" PRIx64
1452 " is too large to fit in a %" PRIu64
1453 " byte unsigned integer value.\n",
1454 uval64, (uint64_t)item_byte_size);
1455 result.SetStatus(eReturnStatusFailed);
1458 buffer.PutMaxHex64(uval64, item_byte_size);
1461 case eFormatBoolean:
1462 uval64 = Args::StringToBoolean(entry.ref, false, &success);
1464 result.AppendErrorWithFormat(
1465 "'%s' is not a valid boolean string value.\n", entry.c_str());
1466 result.SetStatus(eReturnStatusFailed);
1469 buffer.PutMaxHex64(uval64, item_byte_size);
1473 if (entry.ref.getAsInteger(2, uval64)) {
1474 result.AppendErrorWithFormat(
1475 "'%s' is not a valid binary string value.\n", entry.c_str());
1476 result.SetStatus(eReturnStatusFailed);
1478 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) {
1479 result.AppendErrorWithFormat("Value 0x%" PRIx64
1480 " is too large to fit in a %" PRIu64
1481 " byte unsigned integer value.\n",
1482 uval64, (uint64_t)item_byte_size);
1483 result.SetStatus(eReturnStatusFailed);
1486 buffer.PutMaxHex64(uval64, item_byte_size);
1489 case eFormatCharArray:
1491 case eFormatCString: {
1492 if (entry.ref.empty())
1495 size_t len = entry.ref.size();
1496 // Include the NULL for C strings...
1497 if (m_format_options.GetFormat() == eFormatCString)
1500 if (process->WriteMemory(addr, entry.c_str(), len, error) == len) {
1503 result.AppendErrorWithFormat("Memory write to 0x%" PRIx64
1505 addr, error.AsCString());
1506 result.SetStatus(eReturnStatusFailed);
1511 case eFormatDecimal:
1512 if (entry.ref.getAsInteger(0, sval64)) {
1513 result.AppendErrorWithFormat(
1514 "'%s' is not a valid signed decimal value.\n", entry.c_str());
1515 result.SetStatus(eReturnStatusFailed);
1517 } else if (!SIntValueIsValidForSize(sval64, item_byte_size)) {
1518 result.AppendErrorWithFormat(
1519 "Value %" PRIi64 " is too large or small to fit in a %" PRIu64
1520 " byte signed integer value.\n",
1521 sval64, (uint64_t)item_byte_size);
1522 result.SetStatus(eReturnStatusFailed);
1525 buffer.PutMaxHex64(sval64, item_byte_size);
1528 case eFormatUnsigned:
1530 if (!entry.ref.getAsInteger(0, uval64)) {
1531 result.AppendErrorWithFormat(
1532 "'%s' is not a valid unsigned decimal string value.\n",
1534 result.SetStatus(eReturnStatusFailed);
1536 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) {
1537 result.AppendErrorWithFormat("Value %" PRIu64
1538 " is too large to fit in a %" PRIu64
1539 " byte unsigned integer value.\n",
1540 uval64, (uint64_t)item_byte_size);
1541 result.SetStatus(eReturnStatusFailed);
1544 buffer.PutMaxHex64(uval64, item_byte_size);
1548 if (entry.ref.getAsInteger(8, uval64)) {
1549 result.AppendErrorWithFormat(
1550 "'%s' is not a valid octal string value.\n", entry.c_str());
1551 result.SetStatus(eReturnStatusFailed);
1553 } else if (!UIntValueIsValidForSize(uval64, item_byte_size)) {
1554 result.AppendErrorWithFormat("Value %" PRIo64
1555 " is too large to fit in a %" PRIu64
1556 " byte unsigned integer value.\n",
1557 uval64, (uint64_t)item_byte_size);
1558 result.SetStatus(eReturnStatusFailed);
1561 buffer.PutMaxHex64(uval64, item_byte_size);
1566 if (!buffer.GetString().empty()) {
1568 if (process->WriteMemory(addr, buffer.GetString().data(),
1569 buffer.GetString().size(),
1570 error) == buffer.GetString().size())
1573 result.AppendErrorWithFormat("Memory write to 0x%" PRIx64
1575 addr, error.AsCString());
1576 result.SetStatus(eReturnStatusFailed);
1583 OptionGroupOptions m_option_group;
1584 OptionGroupFormat m_format_options;
1585 OptionGroupWriteMemory m_memory_options;
1588 //----------------------------------------------------------------------
1589 // Get malloc/free history of a memory address.
1590 //----------------------------------------------------------------------
1591 class CommandObjectMemoryHistory : public CommandObjectParsed {
1593 CommandObjectMemoryHistory(CommandInterpreter &interpreter)
1594 : CommandObjectParsed(
1595 interpreter, "memory history", "Print recorded stack traces for "
1596 "allocation/deallocation events "
1597 "associated with an address.",
1599 eCommandRequiresTarget | eCommandRequiresProcess |
1600 eCommandProcessMustBePaused | eCommandProcessMustBeLaunched) {
1601 CommandArgumentEntry arg1;
1602 CommandArgumentData addr_arg;
1604 // Define the first (and only) variant of this arg.
1605 addr_arg.arg_type = eArgTypeAddress;
1606 addr_arg.arg_repetition = eArgRepeatPlain;
1608 // There is only one variant this argument could be; put it into the
1610 arg1.push_back(addr_arg);
1612 // Push the data for the first argument into the m_arguments vector.
1613 m_arguments.push_back(arg1);
1616 ~CommandObjectMemoryHistory() override = default;
1618 const char *GetRepeatCommand(Args ¤t_command_args,
1619 uint32_t index) override {
1620 return m_cmd_name.c_str();
1624 bool DoExecute(Args &command, CommandReturnObject &result) override {
1625 const size_t argc = command.GetArgumentCount();
1627 if (argc == 0 || argc > 1) {
1628 result.AppendErrorWithFormat("%s takes an address expression",
1629 m_cmd_name.c_str());
1630 result.SetStatus(eReturnStatusFailed);
1635 lldb::addr_t addr = Args::StringToAddress(&m_exe_ctx, command[0].ref,
1636 LLDB_INVALID_ADDRESS, &error);
1638 if (addr == LLDB_INVALID_ADDRESS) {
1639 result.AppendError("invalid address expression");
1640 result.AppendError(error.AsCString());
1641 result.SetStatus(eReturnStatusFailed);
1645 Stream *output_stream = &result.GetOutputStream();
1647 const ProcessSP &process_sp = m_exe_ctx.GetProcessSP();
1648 const MemoryHistorySP &memory_history =
1649 MemoryHistory::FindPlugin(process_sp);
1651 if (!memory_history) {
1652 result.AppendError("no available memory history provider");
1653 result.SetStatus(eReturnStatusFailed);
1657 HistoryThreads thread_list = memory_history->GetHistoryThreads(addr);
1659 const bool stop_format = false;
1660 for (auto thread : thread_list) {
1661 thread->GetStatus(*output_stream, 0, UINT32_MAX, 0, stop_format);
1664 result.SetStatus(eReturnStatusSuccessFinishResult);
1670 //-------------------------------------------------------------------------
1671 // CommandObjectMemoryRegion
1672 //-------------------------------------------------------------------------
1673 #pragma mark CommandObjectMemoryRegion
1675 class CommandObjectMemoryRegion : public CommandObjectParsed {
1677 CommandObjectMemoryRegion(CommandInterpreter &interpreter)
1678 : CommandObjectParsed(interpreter, "memory region",
1679 "Get information on the memory region containing "
1680 "an address in the current target process.",
1681 "memory region ADDR",
1682 eCommandRequiresProcess | eCommandTryTargetAPILock |
1683 eCommandProcessMustBeLaunched),
1684 m_prev_end_addr(LLDB_INVALID_ADDRESS) {}
1686 ~CommandObjectMemoryRegion() override = default;
1689 bool DoExecute(Args &command, CommandReturnObject &result) override {
1690 ProcessSP process_sp = m_exe_ctx.GetProcessSP();
1693 lldb::addr_t load_addr = m_prev_end_addr;
1694 m_prev_end_addr = LLDB_INVALID_ADDRESS;
1696 const size_t argc = command.GetArgumentCount();
1697 if (argc > 1 || (argc == 0 && load_addr == LLDB_INVALID_ADDRESS)) {
1698 result.AppendErrorWithFormat("'%s' takes one argument:\nUsage: %s\n",
1699 m_cmd_name.c_str(), m_cmd_syntax.c_str());
1700 result.SetStatus(eReturnStatusFailed);
1702 auto load_addr_str = command[0].ref;
1703 if (command.GetArgumentCount() == 1) {
1704 load_addr = Args::StringToAddress(&m_exe_ctx, load_addr_str,
1705 LLDB_INVALID_ADDRESS, &error);
1706 if (error.Fail() || load_addr == LLDB_INVALID_ADDRESS) {
1707 result.AppendErrorWithFormat(
1708 "invalid address argument \"%s\": %s\n", command[0].c_str(),
1710 result.SetStatus(eReturnStatusFailed);
1714 lldb_private::MemoryRegionInfo range_info;
1715 error = process_sp->GetMemoryRegionInfo(load_addr, range_info);
1716 if (error.Success()) {
1717 lldb_private::Address addr;
1718 ConstString section_name;
1719 if (process_sp->GetTarget().ResolveLoadAddress(load_addr, addr)) {
1720 SectionSP section_sp(addr.GetSection());
1722 // Got the top most section, not the deepest section
1723 while (section_sp->GetParent())
1724 section_sp = section_sp->GetParent();
1725 section_name = section_sp->GetName();
1728 result.AppendMessageWithFormat(
1729 "[0x%16.16" PRIx64 "-0x%16.16" PRIx64 ") %c%c%c%s%s\n",
1730 range_info.GetRange().GetRangeBase(),
1731 range_info.GetRange().GetRangeEnd(),
1732 range_info.GetReadable() ? 'r' : '-',
1733 range_info.GetWritable() ? 'w' : '-',
1734 range_info.GetExecutable() ? 'x' : '-', section_name ? " " : "",
1735 section_name ? section_name.AsCString() : "");
1736 m_prev_end_addr = range_info.GetRange().GetRangeEnd();
1737 result.SetStatus(eReturnStatusSuccessFinishResult);
1739 result.SetStatus(eReturnStatusFailed);
1740 result.AppendErrorWithFormat("%s\n", error.AsCString());
1744 m_prev_end_addr = LLDB_INVALID_ADDRESS;
1745 result.AppendError("invalid process");
1746 result.SetStatus(eReturnStatusFailed);
1748 return result.Succeeded();
1751 const char *GetRepeatCommand(Args ¤t_command_args,
1752 uint32_t index) override {
1753 // If we repeat this command, repeat it without any arguments so we can
1754 // show the next memory range
1755 return m_cmd_name.c_str();
1758 lldb::addr_t m_prev_end_addr;
1761 //-------------------------------------------------------------------------
1762 // CommandObjectMemory
1763 //-------------------------------------------------------------------------
1765 CommandObjectMemory::CommandObjectMemory(CommandInterpreter &interpreter)
1766 : CommandObjectMultiword(
1767 interpreter, "memory",
1768 "Commands for operating on memory in the current target process.",
1769 "memory <subcommand> [<subcommand-options>]") {
1770 LoadSubCommand("find",
1771 CommandObjectSP(new CommandObjectMemoryFind(interpreter)));
1772 LoadSubCommand("read",
1773 CommandObjectSP(new CommandObjectMemoryRead(interpreter)));
1774 LoadSubCommand("write",
1775 CommandObjectSP(new CommandObjectMemoryWrite(interpreter)));
1776 LoadSubCommand("history",
1777 CommandObjectSP(new CommandObjectMemoryHistory(interpreter)));
1778 LoadSubCommand("region",
1779 CommandObjectSP(new CommandObjectMemoryRegion(interpreter)));
1782 CommandObjectMemory::~CommandObjectMemory() = default;