1 //===-- CommandObjectDisassemble.cpp --------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "CommandObjectDisassemble.h"
10 #include "lldb/Core/AddressRange.h"
11 #include "lldb/Core/Disassembler.h"
12 #include "lldb/Core/Module.h"
13 #include "lldb/Host/OptionParser.h"
14 #include "lldb/Interpreter/CommandInterpreter.h"
15 #include "lldb/Interpreter/CommandReturnObject.h"
16 #include "lldb/Interpreter/OptionArgParser.h"
17 #include "lldb/Interpreter/Options.h"
18 #include "lldb/Symbol/Function.h"
19 #include "lldb/Symbol/Symbol.h"
20 #include "lldb/Target/SectionLoadList.h"
21 #include "lldb/Target/StackFrame.h"
22 #include "lldb/Target/Target.h"
23 
24 static constexpr unsigned default_disasm_byte_size = 32;
25 static constexpr unsigned default_disasm_num_ins = 4;
26 
27 using namespace lldb;
28 using namespace lldb_private;
29 
30 #define LLDB_OPTIONS_disassemble
31 #include "CommandOptions.inc"
32 
33 CommandObjectDisassemble::CommandOptions::CommandOptions() {
34   OptionParsingStarting(nullptr);
35 }
36 
37 CommandObjectDisassemble::CommandOptions::~CommandOptions() = default;
38 
39 Status CommandObjectDisassemble::CommandOptions::SetOptionValue(
40     uint32_t option_idx, llvm::StringRef option_arg,
41     ExecutionContext *execution_context) {
42   Status error;
43 
44   const int short_option = m_getopt_table[option_idx].val;
45 
46   switch (short_option) {
47   case 'm':
48     show_mixed = true;
49     break;
50 
51   case 'C':
52     if (option_arg.getAsInteger(0, num_lines_context))
53       error.SetErrorStringWithFormat("invalid num context lines string: \"%s\"",
54                                      option_arg.str().c_str());
55     break;
56 
57   case 'c':
58     if (option_arg.getAsInteger(0, num_instructions))
59       error.SetErrorStringWithFormat(
60           "invalid num of instructions string: \"%s\"",
61           option_arg.str().c_str());
62     break;
63 
64   case 'b':
65     show_bytes = true;
66     break;
67 
68   case 'k':
69     show_control_flow_kind = true;
70     break;
71 
72   case 's': {
73     start_addr = OptionArgParser::ToAddress(execution_context, option_arg,
74                                             LLDB_INVALID_ADDRESS, &error);
75     if (start_addr != LLDB_INVALID_ADDRESS)
76       some_location_specified = true;
77   } break;
78   case 'e': {
79     end_addr = OptionArgParser::ToAddress(execution_context, option_arg,
80                                           LLDB_INVALID_ADDRESS, &error);
81     if (end_addr != LLDB_INVALID_ADDRESS)
82       some_location_specified = true;
83   } break;
84 
85   case 'n':
86     func_name.assign(std::string(option_arg));
87     some_location_specified = true;
88     break;
89 
90   case 'p':
91     at_pc = true;
92     some_location_specified = true;
93     break;
94 
95   case 'l':
96     frame_line = true;
97     // Disassemble the current source line kind of implies showing mixed source
98     // code context.
99     show_mixed = true;
100     some_location_specified = true;
101     break;
102 
103   case 'P':
104     plugin_name.assign(std::string(option_arg));
105     break;
106 
107   case 'F': {
108     TargetSP target_sp =
109         execution_context ? execution_context->GetTargetSP() : TargetSP();
110     if (target_sp && (target_sp->GetArchitecture().GetTriple().getArch() ==
111                           llvm::Triple::x86 ||
112                       target_sp->GetArchitecture().GetTriple().getArch() ==
113                           llvm::Triple::x86_64)) {
114       flavor_string.assign(std::string(option_arg));
115     } else
116       error.SetErrorStringWithFormat("Disassembler flavors are currently only "
117                                      "supported for x86 and x86_64 targets.");
118     break;
119   }
120 
121   case 'r':
122     raw = true;
123     break;
124 
125   case 'f':
126     current_function = true;
127     some_location_specified = true;
128     break;
129 
130   case 'A':
131     if (execution_context) {
132       const auto &target_sp = execution_context->GetTargetSP();
133       auto platform_ptr = target_sp ? target_sp->GetPlatform().get() : nullptr;
134       arch = Platform::GetAugmentedArchSpec(platform_ptr, option_arg);
135     }
136     break;
137 
138   case 'a': {
139     symbol_containing_addr = OptionArgParser::ToAddress(
140         execution_context, option_arg, LLDB_INVALID_ADDRESS, &error);
141     if (symbol_containing_addr != LLDB_INVALID_ADDRESS) {
142       some_location_specified = true;
143     }
144   } break;
145 
146   case '\x01':
147     force = true;
148     break;
149 
150   default:
151     llvm_unreachable("Unimplemented option");
152   }
153 
154   return error;
155 }
156 
157 void CommandObjectDisassemble::CommandOptions::OptionParsingStarting(
158     ExecutionContext *execution_context) {
159   show_mixed = false;
160   show_bytes = false;
161   show_control_flow_kind = false;
162   num_lines_context = 0;
163   num_instructions = 0;
164   func_name.clear();
165   current_function = false;
166   at_pc = false;
167   frame_line = false;
168   start_addr = LLDB_INVALID_ADDRESS;
169   end_addr = LLDB_INVALID_ADDRESS;
170   symbol_containing_addr = LLDB_INVALID_ADDRESS;
171   raw = false;
172   plugin_name.clear();
173 
174   Target *target =
175       execution_context ? execution_context->GetTargetPtr() : nullptr;
176 
177   // This is a hack till we get the ability to specify features based on
178   // architecture.  For now GetDisassemblyFlavor is really only valid for x86
179   // (and for the llvm assembler plugin, but I'm papering over that since that
180   // is the only disassembler plugin we have...
181   if (target) {
182     if (target->GetArchitecture().GetTriple().getArch() == llvm::Triple::x86 ||
183         target->GetArchitecture().GetTriple().getArch() ==
184             llvm::Triple::x86_64) {
185       flavor_string.assign(target->GetDisassemblyFlavor());
186     } else
187       flavor_string.assign("default");
188 
189   } else
190     flavor_string.assign("default");
191 
192   arch.Clear();
193   some_location_specified = false;
194   force = false;
195 }
196 
197 Status CommandObjectDisassemble::CommandOptions::OptionParsingFinished(
198     ExecutionContext *execution_context) {
199   if (!some_location_specified)
200     current_function = true;
201   return Status();
202 }
203 
204 llvm::ArrayRef<OptionDefinition>
205 CommandObjectDisassemble::CommandOptions::GetDefinitions() {
206   return llvm::makeArrayRef(g_disassemble_options);
207 }
208 
209 // CommandObjectDisassemble
210 
211 CommandObjectDisassemble::CommandObjectDisassemble(
212     CommandInterpreter &interpreter)
213     : CommandObjectParsed(
214           interpreter, "disassemble",
215           "Disassemble specified instructions in the current target.  "
216           "Defaults to the current function for the current thread and "
217           "stack frame.",
218           "disassemble [<cmd-options>]", eCommandRequiresTarget),
219       m_options() {}
220 
221 CommandObjectDisassemble::~CommandObjectDisassemble() = default;
222 
223 llvm::Error CommandObjectDisassemble::CheckRangeSize(const AddressRange &range,
224                                                      llvm::StringRef what) {
225   if (m_options.num_instructions > 0 || m_options.force ||
226       range.GetByteSize() < GetDebugger().GetStopDisassemblyMaxSize())
227     return llvm::Error::success();
228   StreamString msg;
229   msg << "Not disassembling " << what << " because it is very large ";
230   range.Dump(&msg, &GetSelectedTarget(), Address::DumpStyleLoadAddress,
231              Address::DumpStyleFileAddress);
232   msg << ". To disassemble specify an instruction count limit, start/stop "
233          "addresses or use the --force option.";
234   return llvm::createStringError(llvm::inconvertibleErrorCode(),
235                                  msg.GetString());
236 }
237 
238 llvm::Expected<std::vector<AddressRange>>
239 CommandObjectDisassemble::GetContainingAddressRanges() {
240   std::vector<AddressRange> ranges;
241   const auto &get_range = [&](Address addr) {
242     ModuleSP module_sp(addr.GetModule());
243     SymbolContext sc;
244     bool resolve_tail_call_address = true;
245     addr.GetModule()->ResolveSymbolContextForAddress(
246         addr, eSymbolContextEverything, sc, resolve_tail_call_address);
247     if (sc.function || sc.symbol) {
248       AddressRange range;
249       sc.GetAddressRange(eSymbolContextFunction | eSymbolContextSymbol, 0,
250                          false, range);
251       ranges.push_back(range);
252     }
253   };
254 
255   Target &target = GetSelectedTarget();
256   if (!target.GetSectionLoadList().IsEmpty()) {
257     Address symbol_containing_address;
258     if (target.GetSectionLoadList().ResolveLoadAddress(
259             m_options.symbol_containing_addr, symbol_containing_address)) {
260       get_range(symbol_containing_address);
261     }
262   } else {
263     for (lldb::ModuleSP module_sp : target.GetImages().Modules()) {
264       Address file_address;
265       if (module_sp->ResolveFileAddress(m_options.symbol_containing_addr,
266                                         file_address)) {
267         get_range(file_address);
268       }
269     }
270   }
271 
272   if (ranges.empty()) {
273     return llvm::createStringError(
274         llvm::inconvertibleErrorCode(),
275         "Could not find function bounds for address 0x%" PRIx64,
276         m_options.symbol_containing_addr);
277   }
278 
279   if (llvm::Error err = CheckRangeSize(ranges[0], "the function"))
280     return std::move(err);
281   return ranges;
282 }
283 
284 llvm::Expected<std::vector<AddressRange>>
285 CommandObjectDisassemble::GetCurrentFunctionRanges() {
286   Process *process = m_exe_ctx.GetProcessPtr();
287   StackFrame *frame = m_exe_ctx.GetFramePtr();
288   if (!frame) {
289     if (process) {
290       return llvm::createStringError(
291           llvm::inconvertibleErrorCode(),
292           "Cannot disassemble around the current "
293           "function without the process being stopped.\n");
294     } else {
295       return llvm::createStringError(llvm::inconvertibleErrorCode(),
296                                      "Cannot disassemble around the current "
297                                      "function without a selected frame: "
298                                      "no currently running process.\n");
299     }
300   }
301   SymbolContext sc(
302       frame->GetSymbolContext(eSymbolContextFunction | eSymbolContextSymbol));
303   AddressRange range;
304   if (sc.function)
305     range = sc.function->GetAddressRange();
306   else if (sc.symbol && sc.symbol->ValueIsAddress()) {
307     range = {sc.symbol->GetAddress(), sc.symbol->GetByteSize()};
308   } else
309     range = {frame->GetFrameCodeAddress(), default_disasm_byte_size};
310 
311   if (llvm::Error err = CheckRangeSize(range, "the current function"))
312     return std::move(err);
313   return std::vector<AddressRange>{range};
314 }
315 
316 llvm::Expected<std::vector<AddressRange>>
317 CommandObjectDisassemble::GetCurrentLineRanges() {
318   Process *process = m_exe_ctx.GetProcessPtr();
319   StackFrame *frame = m_exe_ctx.GetFramePtr();
320   if (!frame) {
321     if (process) {
322       return llvm::createStringError(
323           llvm::inconvertibleErrorCode(),
324           "Cannot disassemble around the current "
325           "function without the process being stopped.\n");
326     } else {
327       return llvm::createStringError(llvm::inconvertibleErrorCode(),
328                                      "Cannot disassemble around the current "
329                                      "line without a selected frame: "
330                                      "no currently running process.\n");
331     }
332   }
333 
334   LineEntry pc_line_entry(
335       frame->GetSymbolContext(eSymbolContextLineEntry).line_entry);
336   if (pc_line_entry.IsValid())
337     return std::vector<AddressRange>{pc_line_entry.range};
338 
339   // No line entry, so just disassemble around the current pc
340   m_options.show_mixed = false;
341   return GetPCRanges();
342 }
343 
344 llvm::Expected<std::vector<AddressRange>>
345 CommandObjectDisassemble::GetNameRanges(CommandReturnObject &result) {
346   ConstString name(m_options.func_name.c_str());
347 
348   ModuleFunctionSearchOptions function_options;
349   function_options.include_symbols = true;
350   function_options.include_inlines = true;
351 
352   // Find functions matching the given name.
353   SymbolContextList sc_list;
354   GetSelectedTarget().GetImages().FindFunctions(name, eFunctionNameTypeAuto,
355                                                 function_options, sc_list);
356 
357   std::vector<AddressRange> ranges;
358   llvm::Error range_errs = llvm::Error::success();
359   AddressRange range;
360   const uint32_t scope =
361       eSymbolContextBlock | eSymbolContextFunction | eSymbolContextSymbol;
362   const bool use_inline_block_range = true;
363   for (SymbolContext sc : sc_list.SymbolContexts()) {
364     for (uint32_t range_idx = 0;
365          sc.GetAddressRange(scope, range_idx, use_inline_block_range, range);
366          ++range_idx) {
367       if (llvm::Error err = CheckRangeSize(range, "a range"))
368         range_errs = joinErrors(std::move(range_errs), std::move(err));
369       else
370         ranges.push_back(range);
371     }
372   }
373   if (ranges.empty()) {
374     if (range_errs)
375       return std::move(range_errs);
376     return llvm::createStringError(llvm::inconvertibleErrorCode(),
377                                    "Unable to find symbol with name '%s'.\n",
378                                    name.GetCString());
379   }
380   if (range_errs)
381     result.AppendWarning(toString(std::move(range_errs)));
382   return ranges;
383 }
384 
385 llvm::Expected<std::vector<AddressRange>>
386 CommandObjectDisassemble::GetPCRanges() {
387   Process *process = m_exe_ctx.GetProcessPtr();
388   StackFrame *frame = m_exe_ctx.GetFramePtr();
389   if (!frame) {
390     if (process) {
391       return llvm::createStringError(
392           llvm::inconvertibleErrorCode(),
393           "Cannot disassemble around the current "
394           "function without the process being stopped.\n");
395     } else {
396       return llvm::createStringError(llvm::inconvertibleErrorCode(),
397                                      "Cannot disassemble around the current "
398                                      "PC without a selected frame: "
399                                      "no currently running process.\n");
400     }
401   }
402 
403   if (m_options.num_instructions == 0) {
404     // Disassembling at the PC always disassembles some number of
405     // instructions (not the whole function).
406     m_options.num_instructions = default_disasm_num_ins;
407   }
408   return std::vector<AddressRange>{{frame->GetFrameCodeAddress(), 0}};
409 }
410 
411 llvm::Expected<std::vector<AddressRange>>
412 CommandObjectDisassemble::GetStartEndAddressRanges() {
413   addr_t size = 0;
414   if (m_options.end_addr != LLDB_INVALID_ADDRESS) {
415     if (m_options.end_addr <= m_options.start_addr) {
416       return llvm::createStringError(llvm::inconvertibleErrorCode(),
417                                      "End address before start address.");
418     }
419     size = m_options.end_addr - m_options.start_addr;
420   }
421   return std::vector<AddressRange>{{Address(m_options.start_addr), size}};
422 }
423 
424 llvm::Expected<std::vector<AddressRange>>
425 CommandObjectDisassemble::GetRangesForSelectedMode(
426     CommandReturnObject &result) {
427   if (m_options.symbol_containing_addr != LLDB_INVALID_ADDRESS)
428     return CommandObjectDisassemble::GetContainingAddressRanges();
429   if (m_options.current_function)
430     return CommandObjectDisassemble::GetCurrentFunctionRanges();
431   if (m_options.frame_line)
432     return CommandObjectDisassemble::GetCurrentLineRanges();
433   if (!m_options.func_name.empty())
434     return CommandObjectDisassemble::GetNameRanges(result);
435   if (m_options.start_addr != LLDB_INVALID_ADDRESS)
436     return CommandObjectDisassemble::GetStartEndAddressRanges();
437   return CommandObjectDisassemble::GetPCRanges();
438 }
439 
440 bool CommandObjectDisassemble::DoExecute(Args &command,
441                                          CommandReturnObject &result) {
442   Target *target = &GetSelectedTarget();
443 
444   if (!m_options.arch.IsValid())
445     m_options.arch = target->GetArchitecture();
446 
447   if (!m_options.arch.IsValid()) {
448     result.AppendError(
449         "use the --arch option or set the target architecture to disassemble");
450     return false;
451   }
452 
453   const char *plugin_name = m_options.GetPluginName();
454   const char *flavor_string = m_options.GetFlavorString();
455 
456   DisassemblerSP disassembler =
457       Disassembler::FindPlugin(m_options.arch, flavor_string, plugin_name);
458 
459   if (!disassembler) {
460     if (plugin_name) {
461       result.AppendErrorWithFormat(
462           "Unable to find Disassembler plug-in named '%s' that supports the "
463           "'%s' architecture.\n",
464           plugin_name, m_options.arch.GetArchitectureName());
465     } else
466       result.AppendErrorWithFormat(
467           "Unable to find Disassembler plug-in for the '%s' architecture.\n",
468           m_options.arch.GetArchitectureName());
469     return false;
470   } else if (flavor_string != nullptr && !disassembler->FlavorValidForArchSpec(
471                                              m_options.arch, flavor_string))
472     result.AppendWarningWithFormat(
473         "invalid disassembler flavor \"%s\", using default.\n", flavor_string);
474 
475   result.SetStatus(eReturnStatusSuccessFinishResult);
476 
477   if (!command.empty()) {
478     result.AppendErrorWithFormat(
479         "\"disassemble\" arguments are specified as options.\n");
480     const int terminal_width =
481         GetCommandInterpreter().GetDebugger().GetTerminalWidth();
482     GetOptions()->GenerateOptionUsage(result.GetErrorStream(), *this,
483                                       terminal_width);
484     return false;
485   }
486 
487   if (m_options.show_mixed && m_options.num_lines_context == 0)
488     m_options.num_lines_context = 2;
489 
490   // Always show the PC in the disassembly
491   uint32_t options = Disassembler::eOptionMarkPCAddress;
492 
493   // Mark the source line for the current PC only if we are doing mixed source
494   // and assembly
495   if (m_options.show_mixed)
496     options |= Disassembler::eOptionMarkPCSourceLine;
497 
498   if (m_options.show_bytes)
499     options |= Disassembler::eOptionShowBytes;
500 
501   if (m_options.show_control_flow_kind)
502     options |= Disassembler::eOptionShowControlFlowKind;
503 
504   if (m_options.raw)
505     options |= Disassembler::eOptionRawOuput;
506 
507   llvm::Expected<std::vector<AddressRange>> ranges =
508       GetRangesForSelectedMode(result);
509   if (!ranges) {
510     result.AppendError(toString(ranges.takeError()));
511     return result.Succeeded();
512   }
513 
514   bool print_sc_header = ranges->size() > 1;
515   for (AddressRange cur_range : *ranges) {
516     Disassembler::Limit limit;
517     if (m_options.num_instructions == 0) {
518       limit = {Disassembler::Limit::Bytes, cur_range.GetByteSize()};
519       if (limit.value == 0)
520         limit.value = default_disasm_byte_size;
521     } else {
522       limit = {Disassembler::Limit::Instructions, m_options.num_instructions};
523     }
524     if (Disassembler::Disassemble(
525             GetDebugger(), m_options.arch, plugin_name, flavor_string,
526             m_exe_ctx, cur_range.GetBaseAddress(), limit, m_options.show_mixed,
527             m_options.show_mixed ? m_options.num_lines_context : 0, options,
528             result.GetOutputStream())) {
529       result.SetStatus(eReturnStatusSuccessFinishResult);
530     } else {
531       if (m_options.symbol_containing_addr != LLDB_INVALID_ADDRESS) {
532         result.AppendErrorWithFormat(
533             "Failed to disassemble memory in function at 0x%8.8" PRIx64 ".\n",
534             m_options.symbol_containing_addr);
535       } else {
536         result.AppendErrorWithFormat(
537             "Failed to disassemble memory at 0x%8.8" PRIx64 ".\n",
538             cur_range.GetBaseAddress().GetLoadAddress(target));
539       }
540     }
541     if (print_sc_header)
542       result.GetOutputStream() << "\n";
543   }
544 
545   return result.Succeeded();
546 }
547