1 //===-- DisassemblerLLVMC.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 //===----------------------------------------------------------------------===//
10 #include "DisassemblerLLVMC.h"
12 #include "llvm-c/Disassembler.h"
13 #include "llvm/ADT/OwningPtr.h"
14 #include "llvm/MC/MCAsmInfo.h"
15 #include "llvm/MC/MCContext.h"
16 #include "llvm/MC/MCDisassembler.h"
17 #include "llvm/MC/MCInst.h"
18 #include "llvm/MC/MCInstPrinter.h"
19 #include "llvm/MC/MCInstrInfo.h"
20 #include "llvm/MC/MCRegisterInfo.h"
21 #include "llvm/MC/MCRelocationInfo.h"
22 #include "llvm/MC/MCSubtargetInfo.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/MemoryObject.h"
25 #include "llvm/Support/TargetRegistry.h"
26 #include "llvm/Support/TargetSelect.h"
27 #include "llvm/ADT/SmallString.h"
30 #include "lldb/Core/Address.h"
31 #include "lldb/Core/DataExtractor.h"
32 #include "lldb/Core/Module.h"
33 #include "lldb/Core/Stream.h"
34 #include "lldb/Symbol/SymbolContext.h"
35 #include "lldb/Target/ExecutionContext.h"
36 #include "lldb/Target/Process.h"
37 #include "lldb/Target/RegisterContext.h"
38 #include "lldb/Target/SectionLoadList.h"
39 #include "lldb/Target/Target.h"
40 #include "lldb/Target/StackFrame.h"
42 #include "lldb/Core/RegularExpression.h"
45 using namespace lldb_private;
47 class InstructionLLVMC : public lldb_private::Instruction
50 InstructionLLVMC (DisassemblerLLVMC &disasm,
51 const lldb_private::Address &address,
52 AddressClass addr_class) :
53 Instruction (address, addr_class),
54 m_disasm_sp (disasm.shared_from_this()),
55 m_does_branch (eLazyBoolCalculate),
57 m_using_file_addr (false)
69 if (m_does_branch == eLazyBoolCalculate)
71 GetDisassemblerLLVMC().Lock(this, NULL);
73 if (m_opcode.GetData(data))
75 bool is_alternate_isa;
76 lldb::addr_t pc = m_address.GetFileAddress();
78 DisassemblerLLVMC::LLVMCDisassembler *mc_disasm_ptr = GetDisasmToUse (is_alternate_isa);
79 const uint8_t *opcode_data = data.GetDataStart();
80 const size_t opcode_data_len = data.GetByteSize();
82 const size_t inst_size = mc_disasm_ptr->GetMCInst (opcode_data,
86 // Be conservative, if we didn't understand the instruction, say it might branch...
88 m_does_branch = eLazyBoolYes;
91 const bool can_branch = mc_disasm_ptr->CanBranch(inst);
93 m_does_branch = eLazyBoolYes;
95 m_does_branch = eLazyBoolNo;
98 GetDisassemblerLLVMC().Unlock();
100 return m_does_branch == eLazyBoolYes;
103 DisassemblerLLVMC::LLVMCDisassembler *
104 GetDisasmToUse (bool &is_alternate_isa)
106 is_alternate_isa = false;
107 DisassemblerLLVMC &llvm_disasm = GetDisassemblerLLVMC();
108 if (llvm_disasm.m_alternate_disasm_ap.get() != NULL)
110 const AddressClass address_class = GetAddressClass ();
112 if (address_class == eAddressClassCodeAlternateISA)
114 is_alternate_isa = true;
115 return llvm_disasm.m_alternate_disasm_ap.get();
118 return llvm_disasm.m_disasm_ap.get();
122 Decode (const lldb_private::Disassembler &disassembler,
123 const lldb_private::DataExtractor &data,
124 lldb::offset_t data_offset)
126 // All we have to do is read the opcode which can be easy for some
129 DisassemblerLLVMC &llvm_disasm = GetDisassemblerLLVMC();
130 const ArchSpec &arch = llvm_disasm.GetArchitecture();
131 const lldb::ByteOrder byte_order = data.GetByteOrder();
133 const uint32_t min_op_byte_size = arch.GetMinimumOpcodeByteSize();
134 const uint32_t max_op_byte_size = arch.GetMaximumOpcodeByteSize();
135 if (min_op_byte_size == max_op_byte_size)
137 // Fixed size instructions, just read that amount of data.
138 if (!data.ValidOffsetForDataOfSize(data_offset, min_op_byte_size))
141 switch (min_op_byte_size)
144 m_opcode.SetOpcode8 (data.GetU8 (&data_offset), byte_order);
149 m_opcode.SetOpcode16 (data.GetU16 (&data_offset), byte_order);
154 m_opcode.SetOpcode32 (data.GetU32 (&data_offset), byte_order);
159 m_opcode.SetOpcode64 (data.GetU64 (&data_offset), byte_order);
164 m_opcode.SetOpcodeBytes(data.PeekData(data_offset, min_op_byte_size), min_op_byte_size);
171 bool is_alternate_isa = false;
172 DisassemblerLLVMC::LLVMCDisassembler *mc_disasm_ptr = GetDisasmToUse (is_alternate_isa);
174 const llvm::Triple::ArchType machine = arch.GetMachine();
175 if (machine == llvm::Triple::arm || machine == llvm::Triple::thumb)
177 if (machine == llvm::Triple::thumb || is_alternate_isa)
179 uint32_t thumb_opcode = data.GetU16(&data_offset);
180 if ((thumb_opcode & 0xe000) != 0xe000 || ((thumb_opcode & 0x1800u) == 0))
182 m_opcode.SetOpcode16 (thumb_opcode, byte_order);
188 thumb_opcode |= data.GetU16(&data_offset);
189 m_opcode.SetOpcode16_2 (thumb_opcode, byte_order);
195 m_opcode.SetOpcode32 (data.GetU32(&data_offset), byte_order);
201 // The opcode isn't evenly sized, so we need to actually use the llvm
202 // disassembler to parse it and get the size.
203 uint8_t *opcode_data = const_cast<uint8_t *>(data.PeekData (data_offset, 1));
204 const size_t opcode_data_len = data.BytesLeft(data_offset);
205 const addr_t pc = m_address.GetFileAddress();
208 llvm_disasm.Lock(this, NULL);
209 const size_t inst_size = mc_disasm_ptr->GetMCInst(opcode_data,
213 llvm_disasm.Unlock();
218 m_opcode.SetOpcodeBytes(opcode_data, inst_size);
223 return m_opcode.GetByteSize();
227 AppendComment (std::string &description)
229 if (m_comment.empty())
230 m_comment.swap (description);
233 m_comment.append(", ");
234 m_comment.append(description);
239 CalculateMnemonicOperandsAndComment (const lldb_private::ExecutionContext *exe_ctx)
242 const AddressClass address_class = GetAddressClass ();
244 if (m_opcode.GetData(data))
246 char out_string[512];
248 DisassemblerLLVMC &llvm_disasm = GetDisassemblerLLVMC();
250 DisassemblerLLVMC::LLVMCDisassembler *mc_disasm_ptr;
252 if (address_class == eAddressClassCodeAlternateISA)
253 mc_disasm_ptr = llvm_disasm.m_alternate_disasm_ap.get();
255 mc_disasm_ptr = llvm_disasm.m_disasm_ap.get();
257 lldb::addr_t pc = m_address.GetFileAddress();
258 m_using_file_addr = true;
260 const bool data_from_file = GetDisassemblerLLVMC().m_data_from_file;
261 bool use_hex_immediates = true;
262 Disassembler::HexImmediateStyle hex_style = Disassembler::eHexStyleC;
266 Target *target = exe_ctx->GetTargetPtr();
269 use_hex_immediates = target->GetUseHexImmediates();
270 hex_style = target->GetHexImmediateStyle();
274 const lldb::addr_t load_addr = m_address.GetLoadAddress(target);
275 if (load_addr != LLDB_INVALID_ADDRESS)
278 m_using_file_addr = false;
284 llvm_disasm.Lock(this, exe_ctx);
286 const uint8_t *opcode_data = data.GetDataStart();
287 const size_t opcode_data_len = data.GetByteSize();
289 size_t inst_size = mc_disasm_ptr->GetMCInst (opcode_data,
296 mc_disasm_ptr->SetStyle(use_hex_immediates, hex_style);
297 mc_disasm_ptr->PrintMCInst(inst, out_string, sizeof(out_string));
300 llvm_disasm.Unlock();
304 m_comment.assign ("unknown opcode");
305 inst_size = m_opcode.GetByteSize();
306 StreamString mnemonic_strm;
307 lldb::offset_t offset = 0;
308 lldb::ByteOrder byte_order = data.GetByteOrder();
313 const uint8_t uval8 = data.GetU8 (&offset);
314 m_opcode.SetOpcode8 (uval8, byte_order);
315 m_opcode_name.assign (".byte");
316 mnemonic_strm.Printf("0x%2.2x", uval8);
321 const uint16_t uval16 = data.GetU16(&offset);
322 m_opcode.SetOpcode16(uval16, byte_order);
323 m_opcode_name.assign (".short");
324 mnemonic_strm.Printf("0x%4.4x", uval16);
329 const uint32_t uval32 = data.GetU32(&offset);
330 m_opcode.SetOpcode32(uval32, byte_order);
331 m_opcode_name.assign (".long");
332 mnemonic_strm.Printf("0x%8.8x", uval32);
337 const uint64_t uval64 = data.GetU64(&offset);
338 m_opcode.SetOpcode64(uval64, byte_order);
339 m_opcode_name.assign (".quad");
340 mnemonic_strm.Printf("0x%16.16" PRIx64, uval64);
348 const uint8_t *bytes = data.PeekData(offset, inst_size);
351 m_opcode_name.assign (".byte");
352 m_opcode.SetOpcodeBytes(bytes, inst_size);
353 mnemonic_strm.Printf("0x%2.2x", bytes[0]);
354 for (uint32_t i=1; i<inst_size; ++i)
355 mnemonic_strm.Printf(" 0x%2.2x", bytes[i]);
359 m_mnemonics.swap(mnemonic_strm.GetString());
364 if (m_does_branch == eLazyBoolCalculate)
366 const bool can_branch = mc_disasm_ptr->CanBranch(inst);
368 m_does_branch = eLazyBoolYes;
370 m_does_branch = eLazyBoolNo;
375 static RegularExpression s_regex("[ \t]*([^ ^\t]+)[ \t]*([^ ^\t].*)?", REG_EXTENDED);
377 RegularExpression::Match matches(3);
379 if (s_regex.Execute(out_string, &matches))
381 matches.GetMatchAtIndex(out_string, 1, m_opcode_name);
382 matches.GetMatchAtIndex(out_string, 2, m_mnemonics);
394 UsingFileAddress() const
396 return m_using_file_addr;
401 return m_opcode.GetByteSize();
405 GetDisassemblerLLVMC ()
407 return *(DisassemblerLLVMC *)m_disasm_sp.get();
411 DisassemblerSP m_disasm_sp; // for ownership
412 LazyBool m_does_branch;
414 bool m_using_file_addr;
419 DisassemblerLLVMC::LLVMCDisassembler::LLVMCDisassembler (const char *triple, unsigned flavor, DisassemblerLLVMC &owner):
423 const llvm::Target *curr_target = llvm::TargetRegistry::lookupTarget(triple, Error);
430 m_instr_info_ap.reset(curr_target->createMCInstrInfo());
431 m_reg_info_ap.reset (curr_target->createMCRegInfo(triple));
433 std::string features_str;
435 m_subtarget_info_ap.reset(curr_target->createMCSubtargetInfo(triple, "",
438 std::unique_ptr<llvm::MCRegisterInfo> reg_info(curr_target->createMCRegInfo(triple));
439 m_asm_info_ap.reset(curr_target->createMCAsmInfo(*reg_info, triple));
441 if (m_instr_info_ap.get() == NULL || m_reg_info_ap.get() == NULL || m_subtarget_info_ap.get() == NULL || m_asm_info_ap.get() == NULL)
447 m_context_ap.reset(new llvm::MCContext(m_asm_info_ap.get(), m_reg_info_ap.get(), 0));
449 m_disasm_ap.reset(curr_target->createMCDisassembler(*m_subtarget_info_ap.get()));
450 if (m_disasm_ap.get() && m_context_ap.get())
452 llvm::OwningPtr<llvm::MCRelocationInfo> RelInfo(curr_target->createMCRelocationInfo(triple, *m_context_ap.get()));
458 m_disasm_ap->setupForSymbolicDisassembly(NULL,
459 DisassemblerLLVMC::SymbolLookupCallback,
464 unsigned asm_printer_variant;
466 asm_printer_variant = m_asm_info_ap->getAssemblerDialect();
469 asm_printer_variant = flavor;
472 m_instr_printer_ap.reset(curr_target->createMCInstPrinter(asm_printer_variant,
473 *m_asm_info_ap.get(),
474 *m_instr_info_ap.get(),
475 *m_reg_info_ap.get(),
476 *m_subtarget_info_ap.get()));
477 if (m_instr_printer_ap.get() == NULL)
487 DisassemblerLLVMC::LLVMCDisassembler::~LLVMCDisassembler()
492 // This is the memory object we use in GetInstruction.
493 class LLDBDisasmMemoryObject : public llvm::MemoryObject {
494 const uint8_t *m_bytes;
498 LLDBDisasmMemoryObject(const uint8_t *bytes, uint64_t size, uint64_t basePC) :
499 m_bytes(bytes), m_size(size), m_base_PC(basePC) {}
501 uint64_t getBase() const { return m_base_PC; }
502 uint64_t getExtent() const { return m_size; }
504 int readByte(uint64_t addr, uint8_t *byte) const {
505 if (addr - m_base_PC >= m_size)
507 *byte = m_bytes[addr - m_base_PC];
511 } // End Anonymous Namespace
514 DisassemblerLLVMC::LLVMCDisassembler::GetMCInst (const uint8_t *opcode_data,
515 size_t opcode_data_len,
517 llvm::MCInst &mc_inst)
519 LLDBDisasmMemoryObject memory_object (opcode_data, opcode_data_len, pc);
520 llvm::MCDisassembler::DecodeStatus status;
522 uint64_t new_inst_size;
523 status = m_disasm_ap->getInstruction(mc_inst,
529 if (status == llvm::MCDisassembler::Success)
530 return new_inst_size;
536 DisassemblerLLVMC::LLVMCDisassembler::PrintMCInst (llvm::MCInst &mc_inst,
540 llvm::StringRef unused_annotations;
541 llvm::SmallString<64> inst_string;
542 llvm::raw_svector_ostream inst_stream(inst_string);
543 m_instr_printer_ap->printInst (&mc_inst, inst_stream, unused_annotations);
545 const size_t output_size = std::min(dst_len - 1, inst_string.size());
546 std::memcpy(dst, inst_string.data(), output_size);
547 dst[output_size] = '\0';
553 DisassemblerLLVMC::LLVMCDisassembler::SetStyle (bool use_hex_immed, HexImmediateStyle hex_style)
555 m_instr_printer_ap->setPrintImmHex(use_hex_immed);
558 case eHexStyleC: m_instr_printer_ap->setPrintImmHex(llvm::HexStyle::C); break;
559 case eHexStyleAsm: m_instr_printer_ap->setPrintImmHex(llvm::HexStyle::Asm); break;
564 DisassemblerLLVMC::LLVMCDisassembler::CanBranch (llvm::MCInst &mc_inst)
566 return m_instr_info_ap->get(mc_inst.getOpcode()).mayAffectControlFlow(mc_inst, *m_reg_info_ap.get());
570 DisassemblerLLVMC::FlavorValidForArchSpec (const lldb_private::ArchSpec &arch, const char *flavor)
572 llvm::Triple triple = arch.GetTriple();
573 if (flavor == NULL || strcmp (flavor, "default") == 0)
576 if (triple.getArch() == llvm::Triple::x86 || triple.getArch() == llvm::Triple::x86_64)
578 if (strcmp (flavor, "intel") == 0 || strcmp (flavor, "att") == 0)
589 DisassemblerLLVMC::CreateInstance (const ArchSpec &arch, const char *flavor)
591 if (arch.GetTriple().getArch() != llvm::Triple::UnknownArch)
593 std::unique_ptr<DisassemblerLLVMC> disasm_ap (new DisassemblerLLVMC(arch, flavor));
595 if (disasm_ap.get() && disasm_ap->IsValid())
596 return disasm_ap.release();
601 DisassemblerLLVMC::DisassemblerLLVMC (const ArchSpec &arch, const char *flavor_string) :
602 Disassembler(arch, flavor_string),
605 m_data_from_file (false)
607 if (!FlavorValidForArchSpec (arch, m_flavor.c_str()))
609 m_flavor.assign("default");
612 const char *triple = arch.GetTriple().getTriple().c_str();
613 unsigned flavor = ~0U;
615 // So far the only supported flavor is "intel" on x86. The base class will set this
616 // correctly coming in.
617 if (arch.GetTriple().getArch() == llvm::Triple::x86
618 || arch.GetTriple().getArch() == llvm::Triple::x86_64)
620 if (m_flavor == "intel")
624 else if (m_flavor == "att")
630 ArchSpec thumb_arch(arch);
631 if (arch.GetTriple().getArch() == llvm::Triple::arm)
633 std::string thumb_arch_name (thumb_arch.GetTriple().getArchName().str());
634 // Replace "arm" with "thumb" so we get all thumb variants correct
635 if (thumb_arch_name.size() > 3)
637 thumb_arch_name.erase(0,3);
638 thumb_arch_name.insert(0, "thumb");
642 thumb_arch_name = "thumbv7";
644 thumb_arch.GetTriple().setArchName(llvm::StringRef(thumb_arch_name.c_str()));
647 // Cortex-M3 devices (e.g. armv7m) can only execute thumb (T2) instructions,
648 // so hardcode the primary disassembler to thumb mode. Same for Cortex-M4 (armv7em).
650 // Handle the Cortex-M0 (armv6m) the same; the ISA is a subset of the T and T32
651 // instructions defined in ARMv7-A.
653 if (arch.GetTriple().getArch() == llvm::Triple::arm
654 && (arch.GetCore() == ArchSpec::Core::eCore_arm_armv7m
655 || arch.GetCore() == ArchSpec::Core::eCore_arm_armv7em
656 || arch.GetCore() == ArchSpec::Core::eCore_arm_armv6m))
658 triple = thumb_arch.GetTriple().getTriple().c_str();
661 m_disasm_ap.reset (new LLVMCDisassembler(triple, flavor, *this));
662 if (!m_disasm_ap->IsValid())
664 // We use m_disasm_ap.get() to tell whether we are valid or not, so if this isn't good for some reason,
665 // we reset it, and then we won't be valid and FindPlugin will fail and we won't get used.
669 // For arm CPUs that can execute arm or thumb instructions, also create a thumb instruction disassembler.
670 if (arch.GetTriple().getArch() == llvm::Triple::arm)
672 std::string thumb_triple(thumb_arch.GetTriple().getTriple());
673 m_alternate_disasm_ap.reset(new LLVMCDisassembler(thumb_triple.c_str(), flavor, *this));
674 if (!m_alternate_disasm_ap->IsValid())
677 m_alternate_disasm_ap.reset();
682 DisassemblerLLVMC::~DisassemblerLLVMC()
687 DisassemblerLLVMC::DecodeInstructions (const Address &base_addr,
688 const DataExtractor& data,
689 lldb::offset_t data_offset,
690 size_t num_instructions,
695 m_instruction_list.Clear();
700 m_data_from_file = data_from_file;
701 uint32_t data_cursor = data_offset;
702 const size_t data_byte_size = data.GetByteSize();
703 uint32_t instructions_parsed = 0;
704 Address inst_addr(base_addr);
706 while (data_cursor < data_byte_size && instructions_parsed < num_instructions)
709 AddressClass address_class = eAddressClassCode;
711 if (m_alternate_disasm_ap.get() != NULL)
712 address_class = inst_addr.GetAddressClass ();
714 InstructionSP inst_sp(new InstructionLLVMC(*this,
721 uint32_t inst_size = inst_sp->Decode(*this, data, data_cursor);
726 m_instruction_list.Append(inst_sp);
727 data_cursor += inst_size;
728 inst_addr.Slide(inst_size);
729 instructions_parsed++;
732 return data_cursor - data_offset;
736 DisassemblerLLVMC::Initialize()
738 PluginManager::RegisterPlugin (GetPluginNameStatic(),
739 "Disassembler that uses LLVM MC to disassemble i386, x86_64 and ARM.",
742 llvm::InitializeAllTargetInfos();
743 llvm::InitializeAllTargetMCs();
744 llvm::InitializeAllAsmParsers();
745 llvm::InitializeAllDisassemblers();
749 DisassemblerLLVMC::Terminate()
751 PluginManager::UnregisterPlugin (CreateInstance);
756 DisassemblerLLVMC::GetPluginNameStatic()
758 static ConstString g_name("llvm-mc");
762 int DisassemblerLLVMC::OpInfoCallback (void *disassembler,
769 return static_cast<DisassemblerLLVMC*>(disassembler)->OpInfo (pc,
776 const char *DisassemblerLLVMC::SymbolLookupCallback (void *disassembler,
782 return static_cast<DisassemblerLLVMC*>(disassembler)->SymbolLookup(value,
788 int DisassemblerLLVMC::OpInfo (uint64_t PC,
799 memset (tag_bug, 0, sizeof(::LLVMOpInfo1));
805 const char *DisassemblerLLVMC::SymbolLookup (uint64_t value,
812 if (m_exe_ctx && m_inst)
814 //std::string remove_this_prior_to_checkin;
815 Target *target = m_exe_ctx ? m_exe_ctx->GetTargetPtr() : NULL;
816 Address value_so_addr;
817 if (m_inst->UsingFileAddress())
819 ModuleSP module_sp(m_inst->GetAddress().GetModule());
821 module_sp->ResolveFileAddress(value, value_so_addr);
823 else if (target && !target->GetSectionLoadList().IsEmpty())
825 target->GetSectionLoadList().ResolveLoadAddress(value, value_so_addr);
828 if (value_so_addr.IsValid() && value_so_addr.GetSection())
832 value_so_addr.Dump (&ss,
834 Address::DumpStyleResolvedDescriptionNoModule,
835 Address::DumpStyleSectionNameOffset);
837 if (!ss.GetString().empty())
839 m_inst->AppendComment(ss.GetString());
845 *type_ptr = LLVMDisassembler_ReferenceType_InOut_None;
850 //------------------------------------------------------------------
851 // PluginInterface protocol
852 //------------------------------------------------------------------
854 DisassemblerLLVMC::GetPluginName()
856 return GetPluginNameStatic();
860 DisassemblerLLVMC::GetPluginVersion()