blob: 8f0a7e08aa69ba7d936f93de42b9431e1b308d00 [file] [log] [blame]
Sean Callanan95e5c632012-02-17 00:53:45 +00001//===-- DisassemblerLLVMC.cpp -----------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "DisassemblerLLVMC.h"
11
12#include "llvm-c/Disassembler.h"
Jim Ingham0f063ba2013-03-02 00:26:47 +000013#include "llvm/MC/MCAsmInfo.h"
14#include "llvm/MC/MCContext.h"
15#include "llvm/MC/MCDisassembler.h"
16#include "llvm/MC/MCInst.h"
17#include "llvm/MC/MCInstPrinter.h"
18#include "llvm/MC/MCInstrInfo.h"
19#include "llvm/MC/MCRegisterInfo.h"
20#include "llvm/MC/MCSubtargetInfo.h"
21#include "llvm/Support/ErrorHandling.h"
22#include "llvm/Support/MemoryObject.h"
23#include "llvm/Support/TargetRegistry.h"
Sean Callanan95e5c632012-02-17 00:53:45 +000024#include "llvm/Support/TargetSelect.h"
Jim Ingham0f063ba2013-03-02 00:26:47 +000025#include "llvm/ADT/SmallString.h"
26
Sean Callanan95e5c632012-02-17 00:53:45 +000027
28#include "lldb/Core/Address.h"
29#include "lldb/Core/DataExtractor.h"
Greg Clayton1f746072012-08-29 21:13:06 +000030#include "lldb/Core/Module.h"
Sean Callanan95e5c632012-02-17 00:53:45 +000031#include "lldb/Core/Stream.h"
32#include "lldb/Symbol/SymbolContext.h"
33#include "lldb/Target/ExecutionContext.h"
34#include "lldb/Target/Process.h"
35#include "lldb/Target/RegisterContext.h"
36#include "lldb/Target/Target.h"
37#include "lldb/Target/StackFrame.h"
38
39#include <regex.h>
40
41using namespace lldb;
42using namespace lldb_private;
43
44class InstructionLLVMC : public lldb_private::Instruction
45{
46public:
47 InstructionLLVMC (DisassemblerLLVMC &disasm,
48 const lldb_private::Address &address,
Greg Claytonc8e0c242012-04-13 00:07:34 +000049 AddressClass addr_class) :
Greg Clayton3faf47c2013-03-28 23:42:53 +000050 Instruction (address, addr_class),
51 m_disasm_sp (disasm.shared_from_this()),
52 m_does_branch (eLazyBoolCalculate),
53 m_is_valid (false),
54 m_using_file_addr (false)
Sean Callanan95e5c632012-02-17 00:53:45 +000055 {
56 }
57
58 virtual
59 ~InstructionLLVMC ()
60 {
61 }
62
Sean Callanan95e5c632012-02-17 00:53:45 +000063 virtual bool
Jim Ingham32ce20c2013-03-13 01:55:16 +000064 DoesBranch ()
Sean Callanan95e5c632012-02-17 00:53:45 +000065 {
Jim Ingham32ce20c2013-03-13 01:55:16 +000066 if (m_does_branch == eLazyBoolCalculate)
67 {
Greg Clayton3faf47c2013-03-28 23:42:53 +000068 GetDisassemblerLLVMC().Lock(this, NULL);
Jim Ingham32ce20c2013-03-13 01:55:16 +000069 DataExtractor data;
70 if (m_opcode.GetData(data))
71 {
72 bool is_alternate_isa;
73 lldb::addr_t pc = m_address.GetFileAddress();
74
75 DisassemblerLLVMC::LLVMCDisassembler *mc_disasm_ptr = GetDisasmToUse (is_alternate_isa);
Greg Clayton3faf47c2013-03-28 23:42:53 +000076 const uint8_t *opcode_data = data.GetDataStart();
Jim Ingham32ce20c2013-03-13 01:55:16 +000077 const size_t opcode_data_len = data.GetByteSize();
78 llvm::MCInst inst;
Greg Clayton3faf47c2013-03-28 23:42:53 +000079 const size_t inst_size = mc_disasm_ptr->GetMCInst (opcode_data,
80 opcode_data_len,
81 pc,
82 inst);
Jim Ingham32ce20c2013-03-13 01:55:16 +000083 // Be conservative, if we didn't understand the instruction, say it might branch...
84 if (inst_size == 0)
85 m_does_branch = eLazyBoolYes;
86 else
87 {
Greg Clayton3faf47c2013-03-28 23:42:53 +000088 const bool can_branch = mc_disasm_ptr->CanBranch(inst);
Jim Ingham32ce20c2013-03-13 01:55:16 +000089 if (can_branch)
90 m_does_branch = eLazyBoolYes;
91 else
92 m_does_branch = eLazyBoolNo;
93 }
94 }
Greg Clayton3faf47c2013-03-28 23:42:53 +000095 GetDisassemblerLLVMC().Unlock();
Jim Ingham32ce20c2013-03-13 01:55:16 +000096 }
Sean Callanan7725a462012-03-02 23:22:53 +000097 return m_does_branch == eLazyBoolYes;
Sean Callanan95e5c632012-02-17 00:53:45 +000098 }
99
Jim Ingham32ce20c2013-03-13 01:55:16 +0000100 DisassemblerLLVMC::LLVMCDisassembler *
101 GetDisasmToUse (bool &is_alternate_isa)
102 {
Jim Ingham32ce20c2013-03-13 01:55:16 +0000103 is_alternate_isa = false;
Greg Clayton3faf47c2013-03-28 23:42:53 +0000104 DisassemblerLLVMC &llvm_disasm = GetDisassemblerLLVMC();
105 if (llvm_disasm.m_alternate_disasm_ap.get() != NULL)
Jim Ingham32ce20c2013-03-13 01:55:16 +0000106 {
107 const AddressClass address_class = GetAddressClass ();
108
109 if (address_class == eAddressClassCodeAlternateISA)
110 {
Jim Ingham32ce20c2013-03-13 01:55:16 +0000111 is_alternate_isa = true;
Greg Clayton3faf47c2013-03-28 23:42:53 +0000112 return llvm_disasm.m_alternate_disasm_ap.get();
Jim Ingham32ce20c2013-03-13 01:55:16 +0000113 }
114 }
Greg Clayton3faf47c2013-03-28 23:42:53 +0000115 return llvm_disasm.m_disasm_ap.get();
Jim Ingham32ce20c2013-03-13 01:55:16 +0000116 }
117
Sean Callanan95e5c632012-02-17 00:53:45 +0000118 virtual size_t
119 Decode (const lldb_private::Disassembler &disassembler,
120 const lldb_private::DataExtractor &data,
Greg Claytonc7bece562013-01-25 18:06:21 +0000121 lldb::offset_t data_offset)
Sean Callanan95e5c632012-02-17 00:53:45 +0000122 {
Greg Claytonba812f42012-05-10 02:52:23 +0000123 // All we have to do is read the opcode which can be easy for some
124 // architetures
125 bool got_op = false;
Greg Clayton3faf47c2013-03-28 23:42:53 +0000126 DisassemblerLLVMC &llvm_disasm = GetDisassemblerLLVMC();
127 const ArchSpec &arch = llvm_disasm.GetArchitecture();
Sean Callanan95e5c632012-02-17 00:53:45 +0000128
Greg Claytonba812f42012-05-10 02:52:23 +0000129 const uint32_t min_op_byte_size = arch.GetMinimumOpcodeByteSize();
130 const uint32_t max_op_byte_size = arch.GetMaximumOpcodeByteSize();
131 if (min_op_byte_size == max_op_byte_size)
132 {
133 // Fixed size instructions, just read that amount of data.
134 if (!data.ValidOffsetForDataOfSize(data_offset, min_op_byte_size))
135 return false;
136
137 switch (min_op_byte_size)
138 {
139 case 1:
140 m_opcode.SetOpcode8 (data.GetU8 (&data_offset));
141 got_op = true;
142 break;
143
144 case 2:
145 m_opcode.SetOpcode16 (data.GetU16 (&data_offset));
146 got_op = true;
147 break;
148
149 case 4:
150 m_opcode.SetOpcode32 (data.GetU32 (&data_offset));
151 got_op = true;
152 break;
153
154 case 8:
155 m_opcode.SetOpcode64 (data.GetU64 (&data_offset));
156 got_op = true;
157 break;
158
159 default:
160 m_opcode.SetOpcodeBytes(data.PeekData(data_offset, min_op_byte_size), min_op_byte_size);
161 got_op = true;
162 break;
163 }
164 }
165 if (!got_op)
166 {
Jim Ingham32ce20c2013-03-13 01:55:16 +0000167 bool is_alternate_isa = false;
168 DisassemblerLLVMC::LLVMCDisassembler *mc_disasm_ptr = GetDisasmToUse (is_alternate_isa);
Greg Claytonba812f42012-05-10 02:52:23 +0000169
Greg Claytonba812f42012-05-10 02:52:23 +0000170 const llvm::Triple::ArchType machine = arch.GetMachine();
171 if (machine == llvm::Triple::arm || machine == llvm::Triple::thumb)
172 {
Jim Ingham32ce20c2013-03-13 01:55:16 +0000173 if (machine == llvm::Triple::thumb || is_alternate_isa)
Greg Claytonba812f42012-05-10 02:52:23 +0000174 {
Greg Clayton79101b52012-08-07 01:29:29 +0000175 uint32_t thumb_opcode = data.GetU16(&data_offset);
Greg Claytonba812f42012-05-10 02:52:23 +0000176 if ((thumb_opcode & 0xe000) != 0xe000 || ((thumb_opcode & 0x1800u) == 0))
177 {
178 m_opcode.SetOpcode16 (thumb_opcode);
Sean Callanan5c97c2f2012-08-06 23:42:52 +0000179 m_is_valid = true;
Greg Claytonba812f42012-05-10 02:52:23 +0000180 }
181 else
182 {
Greg Clayton79101b52012-08-07 01:29:29 +0000183 thumb_opcode <<= 16;
184 thumb_opcode |= data.GetU16(&data_offset);
185 m_opcode.SetOpcode16_2 (thumb_opcode);
Greg Claytonba812f42012-05-10 02:52:23 +0000186 m_is_valid = true;
187 }
188 }
189 else
190 {
191 m_opcode.SetOpcode32 (data.GetU32(&data_offset));
Sean Callanan5c97c2f2012-08-06 23:42:52 +0000192 m_is_valid = true;
Greg Claytonba812f42012-05-10 02:52:23 +0000193 }
194 }
195 else
196 {
197 // The opcode isn't evenly sized, so we need to actually use the llvm
198 // disassembler to parse it and get the size.
Greg Claytonba812f42012-05-10 02:52:23 +0000199 uint8_t *opcode_data = const_cast<uint8_t *>(data.PeekData (data_offset, 1));
Greg Clayton3faf47c2013-03-28 23:42:53 +0000200 const size_t opcode_data_len = data.BytesLeft(data_offset);
Greg Claytonba812f42012-05-10 02:52:23 +0000201 const addr_t pc = m_address.GetFileAddress();
Jim Ingham0f063ba2013-03-02 00:26:47 +0000202 llvm::MCInst inst;
203
Greg Clayton3faf47c2013-03-28 23:42:53 +0000204 llvm_disasm.Lock(this, NULL);
Jim Ingham0f063ba2013-03-02 00:26:47 +0000205 const size_t inst_size = mc_disasm_ptr->GetMCInst(opcode_data,
Greg Clayton3faf47c2013-03-28 23:42:53 +0000206 opcode_data_len,
207 pc,
208 inst);
209 llvm_disasm.Unlock();
Greg Claytonba812f42012-05-10 02:52:23 +0000210 if (inst_size == 0)
211 m_opcode.Clear();
212 else
213 {
214 m_opcode.SetOpcodeBytes(opcode_data, inst_size);
215 m_is_valid = true;
216 }
217 }
218 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000219 return m_opcode.GetByteSize();
220 }
221
222 void
Greg Claytonba812f42012-05-10 02:52:23 +0000223 AppendComment (std::string &description)
Sean Callanan95e5c632012-02-17 00:53:45 +0000224 {
Greg Claytonba812f42012-05-10 02:52:23 +0000225 if (m_comment.empty())
226 m_comment.swap (description);
Sean Callanan95e5c632012-02-17 00:53:45 +0000227 else
Greg Claytonba812f42012-05-10 02:52:23 +0000228 {
229 m_comment.append(", ");
230 m_comment.append(description);
231 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000232 }
233
234 virtual void
Greg Claytonba812f42012-05-10 02:52:23 +0000235 CalculateMnemonicOperandsAndComment (const lldb_private::ExecutionContext *exe_ctx)
Sean Callanan95e5c632012-02-17 00:53:45 +0000236 {
Greg Claytonba812f42012-05-10 02:52:23 +0000237 DataExtractor data;
238 const AddressClass address_class = GetAddressClass ();
239
Sean Callanancd4ae1a2012-08-07 01:44:58 +0000240 if (m_opcode.GetData(data))
Greg Claytonba812f42012-05-10 02:52:23 +0000241 {
242 char out_string[512];
243
Greg Clayton3faf47c2013-03-28 23:42:53 +0000244 DisassemblerLLVMC &llvm_disasm = GetDisassemblerLLVMC();
245
Jim Ingham0f063ba2013-03-02 00:26:47 +0000246 DisassemblerLLVMC::LLVMCDisassembler *mc_disasm_ptr;
Greg Claytonba812f42012-05-10 02:52:23 +0000247
248 if (address_class == eAddressClassCodeAlternateISA)
Greg Clayton3faf47c2013-03-28 23:42:53 +0000249 mc_disasm_ptr = llvm_disasm.m_alternate_disasm_ap.get();
Greg Claytonba812f42012-05-10 02:52:23 +0000250 else
Greg Clayton3faf47c2013-03-28 23:42:53 +0000251 mc_disasm_ptr = llvm_disasm.m_disasm_ap.get();
Greg Claytonba812f42012-05-10 02:52:23 +0000252
Greg Clayton3faf47c2013-03-28 23:42:53 +0000253 lldb::addr_t pc = m_address.GetFileAddress();
254 m_using_file_addr = true;
Greg Claytonba812f42012-05-10 02:52:23 +0000255
Greg Clayton3faf47c2013-03-28 23:42:53 +0000256 const bool data_from_file = GetDisassemblerLLVMC().m_data_from_file;
257 if (!data_from_file)
Greg Claytonba812f42012-05-10 02:52:23 +0000258 {
Greg Clayton3faf47c2013-03-28 23:42:53 +0000259 if (exe_ctx)
260 {
261 Target *target = exe_ctx->GetTargetPtr();
262 if (target)
263 {
264 const lldb::addr_t load_addr = m_address.GetLoadAddress(target);
265 if (load_addr != LLDB_INVALID_ADDRESS)
266 {
267 pc = load_addr;
268 m_using_file_addr = false;
269 }
270 }
271 }
Greg Claytonba812f42012-05-10 02:52:23 +0000272 }
273
Greg Clayton3faf47c2013-03-28 23:42:53 +0000274 llvm_disasm.Lock(this, exe_ctx);
Greg Claytonba812f42012-05-10 02:52:23 +0000275
Greg Clayton3faf47c2013-03-28 23:42:53 +0000276 const uint8_t *opcode_data = data.GetDataStart();
Greg Claytonba812f42012-05-10 02:52:23 +0000277 const size_t opcode_data_len = data.GetByteSize();
Jim Ingham0f063ba2013-03-02 00:26:47 +0000278 llvm::MCInst inst;
Greg Clayton3faf47c2013-03-28 23:42:53 +0000279 size_t inst_size = mc_disasm_ptr->GetMCInst (opcode_data,
280 opcode_data_len,
281 pc,
282 inst);
Jim Ingham0f063ba2013-03-02 00:26:47 +0000283
284 if (inst_size > 0)
285 mc_disasm_ptr->PrintMCInst(inst, out_string, sizeof(out_string));
Greg Claytonba812f42012-05-10 02:52:23 +0000286
Greg Clayton3faf47c2013-03-28 23:42:53 +0000287 llvm_disasm.Unlock();
Greg Claytonba812f42012-05-10 02:52:23 +0000288
289 if (inst_size == 0)
290 {
291 m_comment.assign ("unknown opcode");
292 inst_size = m_opcode.GetByteSize();
293 StreamString mnemonic_strm;
Greg Claytonc7bece562013-01-25 18:06:21 +0000294 lldb::offset_t offset = 0;
Greg Claytonba812f42012-05-10 02:52:23 +0000295 switch (inst_size)
296 {
297 case 1:
298 {
299 const uint8_t uval8 = data.GetU8 (&offset);
300 m_opcode.SetOpcode8 (uval8);
301 m_opcode_name.assign (".byte");
302 mnemonic_strm.Printf("0x%2.2x", uval8);
303 }
304 break;
305 case 2:
306 {
307 const uint16_t uval16 = data.GetU16(&offset);
308 m_opcode.SetOpcode16(uval16);
309 m_opcode_name.assign (".short");
310 mnemonic_strm.Printf("0x%4.4x", uval16);
311 }
312 break;
313 case 4:
314 {
315 const uint32_t uval32 = data.GetU32(&offset);
316 m_opcode.SetOpcode32(uval32);
317 m_opcode_name.assign (".long");
318 mnemonic_strm.Printf("0x%8.8x", uval32);
319 }
320 break;
321 case 8:
322 {
323 const uint64_t uval64 = data.GetU64(&offset);
324 m_opcode.SetOpcode64(uval64);
325 m_opcode_name.assign (".quad");
Daniel Malead01b2952012-11-29 21:49:15 +0000326 mnemonic_strm.Printf("0x%16.16" PRIx64, uval64);
Greg Claytonba812f42012-05-10 02:52:23 +0000327 }
328 break;
329 default:
330 if (inst_size == 0)
331 return;
332 else
333 {
334 const uint8_t *bytes = data.PeekData(offset, inst_size);
335 if (bytes == NULL)
336 return;
337 m_opcode_name.assign (".byte");
338 m_opcode.SetOpcodeBytes(bytes, inst_size);
339 mnemonic_strm.Printf("0x%2.2x", bytes[0]);
340 for (uint32_t i=1; i<inst_size; ++i)
341 mnemonic_strm.Printf(" 0x%2.2x", bytes[i]);
342 }
343 break;
344 }
Jim Ingham0f063ba2013-03-02 00:26:47 +0000345 m_mnemonics.swap(mnemonic_strm.GetString());
Greg Claytonba812f42012-05-10 02:52:23 +0000346 return;
347 }
348 else
349 {
350 if (m_does_branch == eLazyBoolCalculate)
351 {
Greg Clayton3faf47c2013-03-28 23:42:53 +0000352 const bool can_branch = mc_disasm_ptr->CanBranch(inst);
Jim Ingham0f063ba2013-03-02 00:26:47 +0000353 if (can_branch)
Greg Claytonba812f42012-05-10 02:52:23 +0000354 m_does_branch = eLazyBoolYes;
355 else
356 m_does_branch = eLazyBoolNo;
Jim Ingham0f063ba2013-03-02 00:26:47 +0000357
Greg Claytonba812f42012-05-10 02:52:23 +0000358 }
359 }
360
361 if (!s_regex_compiled)
362 {
363 ::regcomp(&s_regex, "[ \t]*([^ ^\t]+)[ \t]*([^ ^\t].*)?", REG_EXTENDED);
364 s_regex_compiled = true;
365 }
366
367 ::regmatch_t matches[3];
368
369 if (!::regexec(&s_regex, out_string, sizeof(matches) / sizeof(::regmatch_t), matches, 0))
370 {
371 if (matches[1].rm_so != -1)
372 m_opcode_name.assign(out_string + matches[1].rm_so, matches[1].rm_eo - matches[1].rm_so);
373 if (matches[2].rm_so != -1)
Jim Ingham0f063ba2013-03-02 00:26:47 +0000374 m_mnemonics.assign(out_string + matches[2].rm_so, matches[2].rm_eo - matches[2].rm_so);
Greg Claytonba812f42012-05-10 02:52:23 +0000375 }
376 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000377 }
378
379 bool
Greg Clayton3faf47c2013-03-28 23:42:53 +0000380 IsValid () const
Sean Callanan95e5c632012-02-17 00:53:45 +0000381 {
382 return m_is_valid;
383 }
384
Greg Clayton3faf47c2013-03-28 23:42:53 +0000385 bool
386 UsingFileAddress() const
387 {
388 return m_using_file_addr;
389 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000390 size_t
Greg Clayton3faf47c2013-03-28 23:42:53 +0000391 GetByteSize () const
Sean Callanan95e5c632012-02-17 00:53:45 +0000392 {
393 return m_opcode.GetByteSize();
394 }
Greg Clayton3faf47c2013-03-28 23:42:53 +0000395
396 DisassemblerLLVMC &
397 GetDisassemblerLLVMC ()
398 {
399 return *(DisassemblerLLVMC *)m_disasm_sp.get();
400 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000401protected:
Sean Callanan95e5c632012-02-17 00:53:45 +0000402
Sean Callanan7e6d4e52012-08-01 18:50:59 +0000403 DisassemblerSP m_disasm_sp; // for ownership
Sean Callanan7725a462012-03-02 23:22:53 +0000404 LazyBool m_does_branch;
Greg Clayton3faf47c2013-03-28 23:42:53 +0000405 bool m_is_valid;
406 bool m_using_file_addr;
Sean Callanan95e5c632012-02-17 00:53:45 +0000407
408 static bool s_regex_compiled;
409 static ::regex_t s_regex;
410};
411
412bool InstructionLLVMC::s_regex_compiled = false;
413::regex_t InstructionLLVMC::s_regex;
414
Jim Ingham0f063ba2013-03-02 00:26:47 +0000415DisassemblerLLVMC::LLVMCDisassembler::LLVMCDisassembler (const char *triple, unsigned flavor, DisassemblerLLVMC &owner):
416 m_is_valid(true)
417{
418 std::string Error;
419 const llvm::Target *curr_target = llvm::TargetRegistry::lookupTarget(triple, Error);
420 if (!curr_target)
421 {
422 m_is_valid = false;
423 return;
424 }
425
426 m_instr_info_ap.reset(curr_target->createMCInstrInfo());
427 m_reg_info_ap.reset (curr_target->createMCRegInfo(triple));
428
429 std::string features_str;
430
431 m_subtarget_info_ap.reset(curr_target->createMCSubtargetInfo(triple, "",
432 features_str));
433
434 m_asm_info_ap.reset(curr_target->createMCAsmInfo(triple));
435
436 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)
437 {
Matt Kopec787d1622013-03-12 17:45:38 +0000438 m_is_valid = false;
Jim Ingham0f063ba2013-03-02 00:26:47 +0000439 return;
440 }
441
442 m_context_ap.reset(new llvm::MCContext(*m_asm_info_ap.get(), *(m_reg_info_ap.get()), 0));
443
444 m_disasm_ap.reset(curr_target->createMCDisassembler(*m_subtarget_info_ap.get()));
445 if (m_disasm_ap.get())
446 {
447 m_disasm_ap->setupForSymbolicDisassembly(NULL,
448 DisassemblerLLVMC::SymbolLookupCallback,
449 (void *) &owner,
450 m_context_ap.get());
451
452 unsigned asm_printer_variant;
453 if (flavor == ~0U)
454 asm_printer_variant = m_asm_info_ap->getAssemblerDialect();
455 else
456 {
457 asm_printer_variant = flavor;
458 }
459
460 m_instr_printer_ap.reset(curr_target->createMCInstPrinter(asm_printer_variant,
461 *m_asm_info_ap.get(),
462 *m_instr_info_ap.get(),
463 *m_reg_info_ap.get(),
464 *m_subtarget_info_ap.get()));
465 if (m_instr_printer_ap.get() == NULL)
466 {
467 m_disasm_ap.reset();
468 m_is_valid = false;
469 }
470 }
471 else
472 m_is_valid = false;
473}
474
Greg Claytone01e07b2013-04-18 18:10:51 +0000475DisassemblerLLVMC::LLVMCDisassembler::~LLVMCDisassembler()
476{
477}
478
Jim Ingham0f063ba2013-03-02 00:26:47 +0000479namespace {
480 // This is the memory object we use in GetInstruction.
481 class LLDBDisasmMemoryObject : public llvm::MemoryObject {
Greg Clayton3faf47c2013-03-28 23:42:53 +0000482 const uint8_t *m_bytes;
Jim Ingham0f063ba2013-03-02 00:26:47 +0000483 uint64_t m_size;
484 uint64_t m_base_PC;
485 public:
Greg Clayton3faf47c2013-03-28 23:42:53 +0000486 LLDBDisasmMemoryObject(const uint8_t *bytes, uint64_t size, uint64_t basePC) :
Jim Ingham0f063ba2013-03-02 00:26:47 +0000487 m_bytes(bytes), m_size(size), m_base_PC(basePC) {}
488
489 uint64_t getBase() const { return m_base_PC; }
490 uint64_t getExtent() const { return m_size; }
491
492 int readByte(uint64_t addr, uint8_t *byte) const {
493 if (addr - m_base_PC >= m_size)
494 return -1;
495 *byte = m_bytes[addr - m_base_PC];
496 return 0;
497 }
498 };
499} // End Anonymous Namespace
500
501uint64_t
Greg Clayton3faf47c2013-03-28 23:42:53 +0000502DisassemblerLLVMC::LLVMCDisassembler::GetMCInst (const uint8_t *opcode_data,
503 size_t opcode_data_len,
504 lldb::addr_t pc,
505 llvm::MCInst &mc_inst)
Jim Ingham0f063ba2013-03-02 00:26:47 +0000506{
507 LLDBDisasmMemoryObject memory_object (opcode_data, opcode_data_len, pc);
Jim Ingham0f063ba2013-03-02 00:26:47 +0000508 llvm::MCDisassembler::DecodeStatus status;
509
510 uint64_t new_inst_size;
511 status = m_disasm_ap->getInstruction(mc_inst,
512 new_inst_size,
513 memory_object,
514 pc,
515 llvm::nulls(),
516 llvm::nulls());
517 if (status == llvm::MCDisassembler::Success)
518 return new_inst_size;
519 else
520 return 0;
521}
522
523uint64_t
Greg Clayton3faf47c2013-03-28 23:42:53 +0000524DisassemblerLLVMC::LLVMCDisassembler::PrintMCInst (llvm::MCInst &mc_inst,
525 char *dst,
526 size_t dst_len)
Jim Ingham0f063ba2013-03-02 00:26:47 +0000527{
528 llvm::StringRef unused_annotations;
529 llvm::SmallString<64> inst_string;
530 llvm::raw_svector_ostream inst_stream(inst_string);
531 m_instr_printer_ap->printInst (&mc_inst, inst_stream, unused_annotations);
532 inst_stream.flush();
Greg Clayton3faf47c2013-03-28 23:42:53 +0000533 const size_t output_size = std::min(dst_len - 1, inst_string.size());
534 std::memcpy(dst, inst_string.data(), output_size);
535 dst[output_size] = '\0';
Jim Ingham0f063ba2013-03-02 00:26:47 +0000536
537 return output_size;
538}
539
540bool
541DisassemblerLLVMC::LLVMCDisassembler::CanBranch (llvm::MCInst &mc_inst)
542{
543 return m_instr_info_ap->get(mc_inst.getOpcode()).mayAffectControlFlow(mc_inst, *m_reg_info_ap.get());
544}
545
546bool
547DisassemblerLLVMC::FlavorValidForArchSpec (const lldb_private::ArchSpec &arch, const char *flavor)
548{
549 llvm::Triple triple = arch.GetTriple();
550 if (flavor == NULL || strcmp (flavor, "default") == 0)
551 return true;
552
553 if (triple.getArch() == llvm::Triple::x86 || triple.getArch() == llvm::Triple::x86_64)
554 {
555 if (strcmp (flavor, "intel") == 0 || strcmp (flavor, "att") == 0)
556 return true;
557 else
558 return false;
559 }
560 else
561 return false;
562}
563
564
Sean Callanan95e5c632012-02-17 00:53:45 +0000565Disassembler *
Jim Ingham0f063ba2013-03-02 00:26:47 +0000566DisassemblerLLVMC::CreateInstance (const ArchSpec &arch, const char *flavor)
Sean Callanan95e5c632012-02-17 00:53:45 +0000567{
Greg Clayton9e6cffc2012-09-19 22:25:17 +0000568 if (arch.GetTriple().getArch() != llvm::Triple::UnknownArch)
569 {
Greg Clayton7b0992d2013-04-18 22:45:39 +0000570 std::unique_ptr<DisassemblerLLVMC> disasm_ap (new DisassemblerLLVMC(arch, flavor));
Sean Callanan95e5c632012-02-17 00:53:45 +0000571
Greg Clayton9e6cffc2012-09-19 22:25:17 +0000572 if (disasm_ap.get() && disasm_ap->IsValid())
573 return disasm_ap.release();
574 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000575 return NULL;
576}
577
Jim Ingham0f063ba2013-03-02 00:26:47 +0000578DisassemblerLLVMC::DisassemblerLLVMC (const ArchSpec &arch, const char *flavor_string) :
579 Disassembler(arch, flavor_string),
Greg Claytonba812f42012-05-10 02:52:23 +0000580 m_exe_ctx (NULL),
Greg Clayton3faf47c2013-03-28 23:42:53 +0000581 m_inst (NULL),
582 m_data_from_file (false)
Sean Callanan95e5c632012-02-17 00:53:45 +0000583{
Jim Ingham0f063ba2013-03-02 00:26:47 +0000584 if (!FlavorValidForArchSpec (arch, m_flavor.c_str()))
585 {
586 m_flavor.assign("default");
587 }
588
589 const char *triple = arch.GetTriple().getTriple().c_str();
590 unsigned flavor = ~0U;
591
592 // So far the only supported flavor is "intel" on x86. The base class will set this
593 // correctly coming in.
594 if (arch.GetTriple().getArch() == llvm::Triple::x86
595 || arch.GetTriple().getArch() == llvm::Triple::x86_64)
596 {
597 if (m_flavor == "intel")
598 {
599 flavor = 1;
600 }
601 else if (m_flavor == "att")
602 {
603 flavor = 0;
604 }
605 }
606
607 m_disasm_ap.reset (new LLVMCDisassembler(triple, flavor, *this));
608 if (!m_disasm_ap->IsValid())
609 {
610 // We use m_disasm_ap.get() to tell whether we are valid or not, so if this isn't good for some reason,
611 // we reset it, and then we won't be valid and FindPlugin will fail and we won't get used.
612 m_disasm_ap.reset();
613 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000614
615 if (arch.GetTriple().getArch() == llvm::Triple::arm)
616 {
Greg Claytonba812f42012-05-10 02:52:23 +0000617 ArchSpec thumb_arch(arch);
618 thumb_arch.GetTriple().setArchName(llvm::StringRef("thumbv7"));
619 std::string thumb_triple(thumb_arch.GetTriple().getTriple());
620
Jim Ingham0f063ba2013-03-02 00:26:47 +0000621 m_alternate_disasm_ap.reset(new LLVMCDisassembler(thumb_triple.c_str(), flavor, *this));
622 if (!m_alternate_disasm_ap->IsValid())
623 {
624 m_disasm_ap.reset();
625 m_alternate_disasm_ap.reset();
626 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000627 }
628}
629
630DisassemblerLLVMC::~DisassemblerLLVMC()
631{
632}
633
634size_t
635DisassemblerLLVMC::DecodeInstructions (const Address &base_addr,
636 const DataExtractor& data,
Greg Claytonc7bece562013-01-25 18:06:21 +0000637 lldb::offset_t data_offset,
638 size_t num_instructions,
Greg Clayton3faf47c2013-03-28 23:42:53 +0000639 bool append,
640 bool data_from_file)
Sean Callanan95e5c632012-02-17 00:53:45 +0000641{
642 if (!append)
643 m_instruction_list.Clear();
644
645 if (!IsValid())
646 return 0;
647
Greg Clayton3faf47c2013-03-28 23:42:53 +0000648 m_data_from_file = data_from_file;
Sean Callanan95e5c632012-02-17 00:53:45 +0000649 uint32_t data_cursor = data_offset;
Greg Claytonba812f42012-05-10 02:52:23 +0000650 const size_t data_byte_size = data.GetByteSize();
Sean Callanan95e5c632012-02-17 00:53:45 +0000651 uint32_t instructions_parsed = 0;
Greg Claytonba812f42012-05-10 02:52:23 +0000652 Address inst_addr(base_addr);
Sean Callanan95e5c632012-02-17 00:53:45 +0000653
Greg Claytonba812f42012-05-10 02:52:23 +0000654 while (data_cursor < data_byte_size && instructions_parsed < num_instructions)
Sean Callanan95e5c632012-02-17 00:53:45 +0000655 {
Sean Callanan95e5c632012-02-17 00:53:45 +0000656
Greg Claytonba812f42012-05-10 02:52:23 +0000657 AddressClass address_class = eAddressClassCode;
Sean Callanan95e5c632012-02-17 00:53:45 +0000658
Jim Ingham0f063ba2013-03-02 00:26:47 +0000659 if (m_alternate_disasm_ap.get() != NULL)
Greg Claytonba812f42012-05-10 02:52:23 +0000660 address_class = inst_addr.GetAddressClass ();
Sean Callanan95e5c632012-02-17 00:53:45 +0000661
662 InstructionSP inst_sp(new InstructionLLVMC(*this,
Greg Claytonba812f42012-05-10 02:52:23 +0000663 inst_addr,
Sean Callanan95e5c632012-02-17 00:53:45 +0000664 address_class));
665
666 if (!inst_sp)
Greg Claytonba812f42012-05-10 02:52:23 +0000667 break;
668
Sean Callanan95e5c632012-02-17 00:53:45 +0000669 uint32_t inst_size = inst_sp->Decode(*this, data, data_cursor);
670
Greg Claytonba812f42012-05-10 02:52:23 +0000671 if (inst_size == 0)
672 break;
673
Sean Callanan95e5c632012-02-17 00:53:45 +0000674 m_instruction_list.Append(inst_sp);
Sean Callanan95e5c632012-02-17 00:53:45 +0000675 data_cursor += inst_size;
Greg Claytonba812f42012-05-10 02:52:23 +0000676 inst_addr.Slide(inst_size);
Sean Callanan95e5c632012-02-17 00:53:45 +0000677 instructions_parsed++;
678 }
679
680 return data_cursor - data_offset;
681}
682
683void
684DisassemblerLLVMC::Initialize()
685{
686 PluginManager::RegisterPlugin (GetPluginNameStatic(),
687 GetPluginDescriptionStatic(),
688 CreateInstance);
689
690 llvm::InitializeAllTargetInfos();
691 llvm::InitializeAllTargetMCs();
692 llvm::InitializeAllAsmParsers();
693 llvm::InitializeAllDisassemblers();
694}
695
696void
697DisassemblerLLVMC::Terminate()
698{
699 PluginManager::UnregisterPlugin (CreateInstance);
700}
701
702
703const char *
704DisassemblerLLVMC::GetPluginNameStatic()
705{
Greg Claytonf8712de2012-03-22 00:49:15 +0000706 return "llvm-mc";
Sean Callanan95e5c632012-02-17 00:53:45 +0000707}
708
709const char *
710DisassemblerLLVMC::GetPluginDescriptionStatic()
711{
Greg Claytonf8712de2012-03-22 00:49:15 +0000712 return "Disassembler that uses LLVM MC to disassemble i386, x86_64 and ARM.";
Sean Callanan95e5c632012-02-17 00:53:45 +0000713}
714
Greg Claytonba812f42012-05-10 02:52:23 +0000715int DisassemblerLLVMC::OpInfoCallback (void *disassembler,
716 uint64_t pc,
717 uint64_t offset,
718 uint64_t size,
719 int tag_type,
720 void *tag_bug)
Sean Callanan95e5c632012-02-17 00:53:45 +0000721{
Greg Claytonba812f42012-05-10 02:52:23 +0000722 return static_cast<DisassemblerLLVMC*>(disassembler)->OpInfo (pc,
723 offset,
724 size,
725 tag_type,
726 tag_bug);
Sean Callanan95e5c632012-02-17 00:53:45 +0000727}
728
Greg Claytonba812f42012-05-10 02:52:23 +0000729const char *DisassemblerLLVMC::SymbolLookupCallback (void *disassembler,
730 uint64_t value,
731 uint64_t *type,
732 uint64_t pc,
733 const char **name)
Sean Callanan95e5c632012-02-17 00:53:45 +0000734{
Greg Claytonba812f42012-05-10 02:52:23 +0000735 return static_cast<DisassemblerLLVMC*>(disassembler)->SymbolLookup(value,
736 type,
737 pc,
738 name);
Sean Callanan95e5c632012-02-17 00:53:45 +0000739}
740
741int DisassemblerLLVMC::OpInfo (uint64_t PC,
742 uint64_t Offset,
743 uint64_t Size,
Greg Claytonba812f42012-05-10 02:52:23 +0000744 int tag_type,
745 void *tag_bug)
Sean Callanan95e5c632012-02-17 00:53:45 +0000746{
Greg Claytonba812f42012-05-10 02:52:23 +0000747 switch (tag_type)
Sean Callanan95e5c632012-02-17 00:53:45 +0000748 {
749 default:
750 break;
751 case 1:
Greg Claytonba812f42012-05-10 02:52:23 +0000752 bzero (tag_bug, sizeof(::LLVMOpInfo1));
Sean Callanan95e5c632012-02-17 00:53:45 +0000753 break;
754 }
755 return 0;
756}
757
Greg Claytonba812f42012-05-10 02:52:23 +0000758const char *DisassemblerLLVMC::SymbolLookup (uint64_t value,
759 uint64_t *type_ptr,
760 uint64_t pc,
761 const char **name)
Sean Callanan95e5c632012-02-17 00:53:45 +0000762{
Greg Claytonba812f42012-05-10 02:52:23 +0000763 if (*type_ptr)
764 {
765 if (m_exe_ctx && m_inst)
766 {
767 //std::string remove_this_prior_to_checkin;
Greg Claytonba812f42012-05-10 02:52:23 +0000768 Target *target = m_exe_ctx ? m_exe_ctx->GetTargetPtr() : NULL;
Greg Clayton3faf47c2013-03-28 23:42:53 +0000769 Address value_so_addr;
770 if (m_inst->UsingFileAddress())
Greg Claytonba812f42012-05-10 02:52:23 +0000771 {
772 ModuleSP module_sp(m_inst->GetAddress().GetModule());
773 if (module_sp)
Greg Clayton3faf47c2013-03-28 23:42:53 +0000774 module_sp->ResolveFileAddress(value, value_so_addr);
Greg Claytonba812f42012-05-10 02:52:23 +0000775 }
Greg Clayton3faf47c2013-03-28 23:42:53 +0000776 else if (target && !target->GetSectionLoadList().IsEmpty())
777 {
778 target->GetSectionLoadList().ResolveLoadAddress(value, value_so_addr);
779 }
780
781 if (value_so_addr.IsValid() && value_so_addr.GetSection())
Sean Callanan95e5c632012-02-17 00:53:45 +0000782 {
Sean Callanan95e5c632012-02-17 00:53:45 +0000783 StreamString ss;
784
Greg Clayton3faf47c2013-03-28 23:42:53 +0000785 value_so_addr.Dump (&ss,
786 target,
787 Address::DumpStyleResolvedDescriptionNoModule,
788 Address::DumpStyleSectionNameOffset);
Sean Callanan95e5c632012-02-17 00:53:45 +0000789
Sean Callanan745af462012-03-22 20:04:23 +0000790 if (!ss.GetString().empty())
Greg Claytonba812f42012-05-10 02:52:23 +0000791 {
Greg Claytonba812f42012-05-10 02:52:23 +0000792 m_inst->AppendComment(ss.GetString());
793 }
Sean Callanan95e5c632012-02-17 00:53:45 +0000794 }
795 }
796 }
Greg Claytonba812f42012-05-10 02:52:23 +0000797
798 *type_ptr = LLVMDisassembler_ReferenceType_InOut_None;
799 *name = NULL;
800 return NULL;
Sean Callanan95e5c632012-02-17 00:53:45 +0000801}
802
803//------------------------------------------------------------------
804// PluginInterface protocol
805//------------------------------------------------------------------
806const char *
807DisassemblerLLVMC::GetPluginName()
808{
809 return "DisassemblerLLVMC";
810}
811
812const char *
813DisassemblerLLVMC::GetShortPluginName()
814{
815 return GetPluginNameStatic();
816}
817
818uint32_t
819DisassemblerLLVMC::GetPluginVersion()
820{
821 return 1;
822}
823