xref: /freebsd/contrib/llvm-project/llvm/lib/Target/X86/MCTargetDesc/X86MCTargetDesc.cpp (revision 5e801ac66d24704442eba426ed13c3effb8a34e7)
1 //===-- X86MCTargetDesc.cpp - X86 Target Descriptions ---------------------===//
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 // This file provides X86 specific target descriptions.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "X86MCTargetDesc.h"
14 #include "TargetInfo/X86TargetInfo.h"
15 #include "X86ATTInstPrinter.h"
16 #include "X86BaseInfo.h"
17 #include "X86IntelInstPrinter.h"
18 #include "X86MCAsmInfo.h"
19 #include "llvm/ADT/APInt.h"
20 #include "llvm/ADT/Triple.h"
21 #include "llvm/DebugInfo/CodeView/CodeView.h"
22 #include "llvm/MC/MCDwarf.h"
23 #include "llvm/MC/MCInstrAnalysis.h"
24 #include "llvm/MC/MCInstrInfo.h"
25 #include "llvm/MC/MCRegisterInfo.h"
26 #include "llvm/MC/MCStreamer.h"
27 #include "llvm/MC/MCSubtargetInfo.h"
28 #include "llvm/MC/MachineLocation.h"
29 #include "llvm/MC/TargetRegistry.h"
30 #include "llvm/Support/ErrorHandling.h"
31 #include "llvm/Support/Host.h"
32 
33 using namespace llvm;
34 
35 #define GET_REGINFO_MC_DESC
36 #include "X86GenRegisterInfo.inc"
37 
38 #define GET_INSTRINFO_MC_DESC
39 #define GET_INSTRINFO_MC_HELPERS
40 #include "X86GenInstrInfo.inc"
41 
42 #define GET_SUBTARGETINFO_MC_DESC
43 #include "X86GenSubtargetInfo.inc"
44 
45 std::string X86_MC::ParseX86Triple(const Triple &TT) {
46   std::string FS;
47   // SSE2 should default to enabled in 64-bit mode, but can be turned off
48   // explicitly.
49   if (TT.isArch64Bit())
50     FS = "+64bit-mode,-32bit-mode,-16bit-mode,+sse2";
51   else if (TT.getEnvironment() != Triple::CODE16)
52     FS = "-64bit-mode,+32bit-mode,-16bit-mode";
53   else
54     FS = "-64bit-mode,-32bit-mode,+16bit-mode";
55 
56   return FS;
57 }
58 
59 unsigned X86_MC::getDwarfRegFlavour(const Triple &TT, bool isEH) {
60   if (TT.getArch() == Triple::x86_64)
61     return DWARFFlavour::X86_64;
62 
63   if (TT.isOSDarwin())
64     return isEH ? DWARFFlavour::X86_32_DarwinEH : DWARFFlavour::X86_32_Generic;
65   if (TT.isOSCygMing())
66     // Unsupported by now, just quick fallback
67     return DWARFFlavour::X86_32_Generic;
68   return DWARFFlavour::X86_32_Generic;
69 }
70 
71 bool X86_MC::hasLockPrefix(const MCInst &MI) {
72   return MI.getFlags() & X86::IP_HAS_LOCK;
73 }
74 
75 void X86_MC::initLLVMToSEHAndCVRegMapping(MCRegisterInfo *MRI) {
76   // FIXME: TableGen these.
77   for (unsigned Reg = X86::NoRegister + 1; Reg < X86::NUM_TARGET_REGS; ++Reg) {
78     unsigned SEH = MRI->getEncodingValue(Reg);
79     MRI->mapLLVMRegToSEHReg(Reg, SEH);
80   }
81 
82   // Mapping from CodeView to MC register id.
83   static const struct {
84     codeview::RegisterId CVReg;
85     MCPhysReg Reg;
86   } RegMap[] = {
87       {codeview::RegisterId::AL, X86::AL},
88       {codeview::RegisterId::CL, X86::CL},
89       {codeview::RegisterId::DL, X86::DL},
90       {codeview::RegisterId::BL, X86::BL},
91       {codeview::RegisterId::AH, X86::AH},
92       {codeview::RegisterId::CH, X86::CH},
93       {codeview::RegisterId::DH, X86::DH},
94       {codeview::RegisterId::BH, X86::BH},
95       {codeview::RegisterId::AX, X86::AX},
96       {codeview::RegisterId::CX, X86::CX},
97       {codeview::RegisterId::DX, X86::DX},
98       {codeview::RegisterId::BX, X86::BX},
99       {codeview::RegisterId::SP, X86::SP},
100       {codeview::RegisterId::BP, X86::BP},
101       {codeview::RegisterId::SI, X86::SI},
102       {codeview::RegisterId::DI, X86::DI},
103       {codeview::RegisterId::EAX, X86::EAX},
104       {codeview::RegisterId::ECX, X86::ECX},
105       {codeview::RegisterId::EDX, X86::EDX},
106       {codeview::RegisterId::EBX, X86::EBX},
107       {codeview::RegisterId::ESP, X86::ESP},
108       {codeview::RegisterId::EBP, X86::EBP},
109       {codeview::RegisterId::ESI, X86::ESI},
110       {codeview::RegisterId::EDI, X86::EDI},
111 
112       {codeview::RegisterId::EFLAGS, X86::EFLAGS},
113 
114       {codeview::RegisterId::ST0, X86::FP0},
115       {codeview::RegisterId::ST1, X86::FP1},
116       {codeview::RegisterId::ST2, X86::FP2},
117       {codeview::RegisterId::ST3, X86::FP3},
118       {codeview::RegisterId::ST4, X86::FP4},
119       {codeview::RegisterId::ST5, X86::FP5},
120       {codeview::RegisterId::ST6, X86::FP6},
121       {codeview::RegisterId::ST7, X86::FP7},
122 
123       {codeview::RegisterId::MM0, X86::MM0},
124       {codeview::RegisterId::MM1, X86::MM1},
125       {codeview::RegisterId::MM2, X86::MM2},
126       {codeview::RegisterId::MM3, X86::MM3},
127       {codeview::RegisterId::MM4, X86::MM4},
128       {codeview::RegisterId::MM5, X86::MM5},
129       {codeview::RegisterId::MM6, X86::MM6},
130       {codeview::RegisterId::MM7, X86::MM7},
131 
132       {codeview::RegisterId::XMM0, X86::XMM0},
133       {codeview::RegisterId::XMM1, X86::XMM1},
134       {codeview::RegisterId::XMM2, X86::XMM2},
135       {codeview::RegisterId::XMM3, X86::XMM3},
136       {codeview::RegisterId::XMM4, X86::XMM4},
137       {codeview::RegisterId::XMM5, X86::XMM5},
138       {codeview::RegisterId::XMM6, X86::XMM6},
139       {codeview::RegisterId::XMM7, X86::XMM7},
140 
141       {codeview::RegisterId::XMM8, X86::XMM8},
142       {codeview::RegisterId::XMM9, X86::XMM9},
143       {codeview::RegisterId::XMM10, X86::XMM10},
144       {codeview::RegisterId::XMM11, X86::XMM11},
145       {codeview::RegisterId::XMM12, X86::XMM12},
146       {codeview::RegisterId::XMM13, X86::XMM13},
147       {codeview::RegisterId::XMM14, X86::XMM14},
148       {codeview::RegisterId::XMM15, X86::XMM15},
149 
150       {codeview::RegisterId::SIL, X86::SIL},
151       {codeview::RegisterId::DIL, X86::DIL},
152       {codeview::RegisterId::BPL, X86::BPL},
153       {codeview::RegisterId::SPL, X86::SPL},
154       {codeview::RegisterId::RAX, X86::RAX},
155       {codeview::RegisterId::RBX, X86::RBX},
156       {codeview::RegisterId::RCX, X86::RCX},
157       {codeview::RegisterId::RDX, X86::RDX},
158       {codeview::RegisterId::RSI, X86::RSI},
159       {codeview::RegisterId::RDI, X86::RDI},
160       {codeview::RegisterId::RBP, X86::RBP},
161       {codeview::RegisterId::RSP, X86::RSP},
162       {codeview::RegisterId::R8, X86::R8},
163       {codeview::RegisterId::R9, X86::R9},
164       {codeview::RegisterId::R10, X86::R10},
165       {codeview::RegisterId::R11, X86::R11},
166       {codeview::RegisterId::R12, X86::R12},
167       {codeview::RegisterId::R13, X86::R13},
168       {codeview::RegisterId::R14, X86::R14},
169       {codeview::RegisterId::R15, X86::R15},
170       {codeview::RegisterId::R8B, X86::R8B},
171       {codeview::RegisterId::R9B, X86::R9B},
172       {codeview::RegisterId::R10B, X86::R10B},
173       {codeview::RegisterId::R11B, X86::R11B},
174       {codeview::RegisterId::R12B, X86::R12B},
175       {codeview::RegisterId::R13B, X86::R13B},
176       {codeview::RegisterId::R14B, X86::R14B},
177       {codeview::RegisterId::R15B, X86::R15B},
178       {codeview::RegisterId::R8W, X86::R8W},
179       {codeview::RegisterId::R9W, X86::R9W},
180       {codeview::RegisterId::R10W, X86::R10W},
181       {codeview::RegisterId::R11W, X86::R11W},
182       {codeview::RegisterId::R12W, X86::R12W},
183       {codeview::RegisterId::R13W, X86::R13W},
184       {codeview::RegisterId::R14W, X86::R14W},
185       {codeview::RegisterId::R15W, X86::R15W},
186       {codeview::RegisterId::R8D, X86::R8D},
187       {codeview::RegisterId::R9D, X86::R9D},
188       {codeview::RegisterId::R10D, X86::R10D},
189       {codeview::RegisterId::R11D, X86::R11D},
190       {codeview::RegisterId::R12D, X86::R12D},
191       {codeview::RegisterId::R13D, X86::R13D},
192       {codeview::RegisterId::R14D, X86::R14D},
193       {codeview::RegisterId::R15D, X86::R15D},
194       {codeview::RegisterId::AMD64_YMM0, X86::YMM0},
195       {codeview::RegisterId::AMD64_YMM1, X86::YMM1},
196       {codeview::RegisterId::AMD64_YMM2, X86::YMM2},
197       {codeview::RegisterId::AMD64_YMM3, X86::YMM3},
198       {codeview::RegisterId::AMD64_YMM4, X86::YMM4},
199       {codeview::RegisterId::AMD64_YMM5, X86::YMM5},
200       {codeview::RegisterId::AMD64_YMM6, X86::YMM6},
201       {codeview::RegisterId::AMD64_YMM7, X86::YMM7},
202       {codeview::RegisterId::AMD64_YMM8, X86::YMM8},
203       {codeview::RegisterId::AMD64_YMM9, X86::YMM9},
204       {codeview::RegisterId::AMD64_YMM10, X86::YMM10},
205       {codeview::RegisterId::AMD64_YMM11, X86::YMM11},
206       {codeview::RegisterId::AMD64_YMM12, X86::YMM12},
207       {codeview::RegisterId::AMD64_YMM13, X86::YMM13},
208       {codeview::RegisterId::AMD64_YMM14, X86::YMM14},
209       {codeview::RegisterId::AMD64_YMM15, X86::YMM15},
210       {codeview::RegisterId::AMD64_YMM16, X86::YMM16},
211       {codeview::RegisterId::AMD64_YMM17, X86::YMM17},
212       {codeview::RegisterId::AMD64_YMM18, X86::YMM18},
213       {codeview::RegisterId::AMD64_YMM19, X86::YMM19},
214       {codeview::RegisterId::AMD64_YMM20, X86::YMM20},
215       {codeview::RegisterId::AMD64_YMM21, X86::YMM21},
216       {codeview::RegisterId::AMD64_YMM22, X86::YMM22},
217       {codeview::RegisterId::AMD64_YMM23, X86::YMM23},
218       {codeview::RegisterId::AMD64_YMM24, X86::YMM24},
219       {codeview::RegisterId::AMD64_YMM25, X86::YMM25},
220       {codeview::RegisterId::AMD64_YMM26, X86::YMM26},
221       {codeview::RegisterId::AMD64_YMM27, X86::YMM27},
222       {codeview::RegisterId::AMD64_YMM28, X86::YMM28},
223       {codeview::RegisterId::AMD64_YMM29, X86::YMM29},
224       {codeview::RegisterId::AMD64_YMM30, X86::YMM30},
225       {codeview::RegisterId::AMD64_YMM31, X86::YMM31},
226       {codeview::RegisterId::AMD64_ZMM0, X86::ZMM0},
227       {codeview::RegisterId::AMD64_ZMM1, X86::ZMM1},
228       {codeview::RegisterId::AMD64_ZMM2, X86::ZMM2},
229       {codeview::RegisterId::AMD64_ZMM3, X86::ZMM3},
230       {codeview::RegisterId::AMD64_ZMM4, X86::ZMM4},
231       {codeview::RegisterId::AMD64_ZMM5, X86::ZMM5},
232       {codeview::RegisterId::AMD64_ZMM6, X86::ZMM6},
233       {codeview::RegisterId::AMD64_ZMM7, X86::ZMM7},
234       {codeview::RegisterId::AMD64_ZMM8, X86::ZMM8},
235       {codeview::RegisterId::AMD64_ZMM9, X86::ZMM9},
236       {codeview::RegisterId::AMD64_ZMM10, X86::ZMM10},
237       {codeview::RegisterId::AMD64_ZMM11, X86::ZMM11},
238       {codeview::RegisterId::AMD64_ZMM12, X86::ZMM12},
239       {codeview::RegisterId::AMD64_ZMM13, X86::ZMM13},
240       {codeview::RegisterId::AMD64_ZMM14, X86::ZMM14},
241       {codeview::RegisterId::AMD64_ZMM15, X86::ZMM15},
242       {codeview::RegisterId::AMD64_ZMM16, X86::ZMM16},
243       {codeview::RegisterId::AMD64_ZMM17, X86::ZMM17},
244       {codeview::RegisterId::AMD64_ZMM18, X86::ZMM18},
245       {codeview::RegisterId::AMD64_ZMM19, X86::ZMM19},
246       {codeview::RegisterId::AMD64_ZMM20, X86::ZMM20},
247       {codeview::RegisterId::AMD64_ZMM21, X86::ZMM21},
248       {codeview::RegisterId::AMD64_ZMM22, X86::ZMM22},
249       {codeview::RegisterId::AMD64_ZMM23, X86::ZMM23},
250       {codeview::RegisterId::AMD64_ZMM24, X86::ZMM24},
251       {codeview::RegisterId::AMD64_ZMM25, X86::ZMM25},
252       {codeview::RegisterId::AMD64_ZMM26, X86::ZMM26},
253       {codeview::RegisterId::AMD64_ZMM27, X86::ZMM27},
254       {codeview::RegisterId::AMD64_ZMM28, X86::ZMM28},
255       {codeview::RegisterId::AMD64_ZMM29, X86::ZMM29},
256       {codeview::RegisterId::AMD64_ZMM30, X86::ZMM30},
257       {codeview::RegisterId::AMD64_ZMM31, X86::ZMM31},
258       {codeview::RegisterId::AMD64_K0, X86::K0},
259       {codeview::RegisterId::AMD64_K1, X86::K1},
260       {codeview::RegisterId::AMD64_K2, X86::K2},
261       {codeview::RegisterId::AMD64_K3, X86::K3},
262       {codeview::RegisterId::AMD64_K4, X86::K4},
263       {codeview::RegisterId::AMD64_K5, X86::K5},
264       {codeview::RegisterId::AMD64_K6, X86::K6},
265       {codeview::RegisterId::AMD64_K7, X86::K7},
266       {codeview::RegisterId::AMD64_XMM16, X86::XMM16},
267       {codeview::RegisterId::AMD64_XMM17, X86::XMM17},
268       {codeview::RegisterId::AMD64_XMM18, X86::XMM18},
269       {codeview::RegisterId::AMD64_XMM19, X86::XMM19},
270       {codeview::RegisterId::AMD64_XMM20, X86::XMM20},
271       {codeview::RegisterId::AMD64_XMM21, X86::XMM21},
272       {codeview::RegisterId::AMD64_XMM22, X86::XMM22},
273       {codeview::RegisterId::AMD64_XMM23, X86::XMM23},
274       {codeview::RegisterId::AMD64_XMM24, X86::XMM24},
275       {codeview::RegisterId::AMD64_XMM25, X86::XMM25},
276       {codeview::RegisterId::AMD64_XMM26, X86::XMM26},
277       {codeview::RegisterId::AMD64_XMM27, X86::XMM27},
278       {codeview::RegisterId::AMD64_XMM28, X86::XMM28},
279       {codeview::RegisterId::AMD64_XMM29, X86::XMM29},
280       {codeview::RegisterId::AMD64_XMM30, X86::XMM30},
281       {codeview::RegisterId::AMD64_XMM31, X86::XMM31},
282 
283   };
284   for (unsigned I = 0; I < array_lengthof(RegMap); ++I)
285     MRI->mapLLVMRegToCVReg(RegMap[I].Reg, static_cast<int>(RegMap[I].CVReg));
286 }
287 
288 MCSubtargetInfo *X86_MC::createX86MCSubtargetInfo(const Triple &TT,
289                                                   StringRef CPU, StringRef FS) {
290   std::string ArchFS = X86_MC::ParseX86Triple(TT);
291   assert(!ArchFS.empty() && "Failed to parse X86 triple");
292   if (!FS.empty())
293     ArchFS = (Twine(ArchFS) + "," + FS).str();
294 
295   if (CPU.empty())
296     CPU = "generic";
297 
298   return createX86MCSubtargetInfoImpl(TT, CPU, /*TuneCPU*/ CPU, ArchFS);
299 }
300 
301 static MCInstrInfo *createX86MCInstrInfo() {
302   MCInstrInfo *X = new MCInstrInfo();
303   InitX86MCInstrInfo(X);
304   return X;
305 }
306 
307 static MCRegisterInfo *createX86MCRegisterInfo(const Triple &TT) {
308   unsigned RA = (TT.getArch() == Triple::x86_64)
309                     ? X86::RIP  // Should have dwarf #16.
310                     : X86::EIP; // Should have dwarf #8.
311 
312   MCRegisterInfo *X = new MCRegisterInfo();
313   InitX86MCRegisterInfo(X, RA, X86_MC::getDwarfRegFlavour(TT, false),
314                         X86_MC::getDwarfRegFlavour(TT, true), RA);
315   X86_MC::initLLVMToSEHAndCVRegMapping(X);
316   return X;
317 }
318 
319 static MCAsmInfo *createX86MCAsmInfo(const MCRegisterInfo &MRI,
320                                      const Triple &TheTriple,
321                                      const MCTargetOptions &Options) {
322   bool is64Bit = TheTriple.getArch() == Triple::x86_64;
323 
324   MCAsmInfo *MAI;
325   if (TheTriple.isOSBinFormatMachO()) {
326     if (is64Bit)
327       MAI = new X86_64MCAsmInfoDarwin(TheTriple);
328     else
329       MAI = new X86MCAsmInfoDarwin(TheTriple);
330   } else if (TheTriple.isOSBinFormatELF()) {
331     // Force the use of an ELF container.
332     MAI = new X86ELFMCAsmInfo(TheTriple);
333   } else if (TheTriple.isWindowsMSVCEnvironment() ||
334              TheTriple.isWindowsCoreCLREnvironment()) {
335     if (Options.getAssemblyLanguage().equals_insensitive("masm"))
336       MAI = new X86MCAsmInfoMicrosoftMASM(TheTriple);
337     else
338       MAI = new X86MCAsmInfoMicrosoft(TheTriple);
339   } else if (TheTriple.isOSCygMing() ||
340              TheTriple.isWindowsItaniumEnvironment()) {
341     MAI = new X86MCAsmInfoGNUCOFF(TheTriple);
342   } else {
343     // The default is ELF.
344     MAI = new X86ELFMCAsmInfo(TheTriple);
345   }
346 
347   // Initialize initial frame state.
348   // Calculate amount of bytes used for return address storing
349   int stackGrowth = is64Bit ? -8 : -4;
350 
351   // Initial state of the frame pointer is esp+stackGrowth.
352   unsigned StackPtr = is64Bit ? X86::RSP : X86::ESP;
353   MCCFIInstruction Inst = MCCFIInstruction::cfiDefCfa(
354       nullptr, MRI.getDwarfRegNum(StackPtr, true), -stackGrowth);
355   MAI->addInitialFrameState(Inst);
356 
357   // Add return address to move list
358   unsigned InstPtr = is64Bit ? X86::RIP : X86::EIP;
359   MCCFIInstruction Inst2 = MCCFIInstruction::createOffset(
360       nullptr, MRI.getDwarfRegNum(InstPtr, true), stackGrowth);
361   MAI->addInitialFrameState(Inst2);
362 
363   return MAI;
364 }
365 
366 static MCInstPrinter *createX86MCInstPrinter(const Triple &T,
367                                              unsigned SyntaxVariant,
368                                              const MCAsmInfo &MAI,
369                                              const MCInstrInfo &MII,
370                                              const MCRegisterInfo &MRI) {
371   if (SyntaxVariant == 0)
372     return new X86ATTInstPrinter(MAI, MII, MRI);
373   if (SyntaxVariant == 1)
374     return new X86IntelInstPrinter(MAI, MII, MRI);
375   return nullptr;
376 }
377 
378 static MCRelocationInfo *createX86MCRelocationInfo(const Triple &TheTriple,
379                                                    MCContext &Ctx) {
380   // Default to the stock relocation info.
381   return llvm::createMCRelocationInfo(TheTriple, Ctx);
382 }
383 
384 namespace llvm {
385 namespace X86_MC {
386 
387 class X86MCInstrAnalysis : public MCInstrAnalysis {
388   X86MCInstrAnalysis(const X86MCInstrAnalysis &) = delete;
389   X86MCInstrAnalysis &operator=(const X86MCInstrAnalysis &) = delete;
390   virtual ~X86MCInstrAnalysis() = default;
391 
392 public:
393   X86MCInstrAnalysis(const MCInstrInfo *MCII) : MCInstrAnalysis(MCII) {}
394 
395 #define GET_STIPREDICATE_DECLS_FOR_MC_ANALYSIS
396 #include "X86GenSubtargetInfo.inc"
397 
398   bool clearsSuperRegisters(const MCRegisterInfo &MRI, const MCInst &Inst,
399                             APInt &Mask) const override;
400   std::vector<std::pair<uint64_t, uint64_t>>
401   findPltEntries(uint64_t PltSectionVA, ArrayRef<uint8_t> PltContents,
402                  uint64_t GotSectionVA,
403                  const Triple &TargetTriple) const override;
404 
405   bool evaluateBranch(const MCInst &Inst, uint64_t Addr, uint64_t Size,
406                       uint64_t &Target) const override;
407   Optional<uint64_t> evaluateMemoryOperandAddress(const MCInst &Inst,
408                                                   const MCSubtargetInfo *STI,
409                                                   uint64_t Addr,
410                                                   uint64_t Size) const override;
411   Optional<uint64_t>
412   getMemoryOperandRelocationOffset(const MCInst &Inst,
413                                    uint64_t Size) const override;
414 };
415 
416 #define GET_STIPREDICATE_DEFS_FOR_MC_ANALYSIS
417 #include "X86GenSubtargetInfo.inc"
418 
419 bool X86MCInstrAnalysis::clearsSuperRegisters(const MCRegisterInfo &MRI,
420                                               const MCInst &Inst,
421                                               APInt &Mask) const {
422   const MCInstrDesc &Desc = Info->get(Inst.getOpcode());
423   unsigned NumDefs = Desc.getNumDefs();
424   unsigned NumImplicitDefs = Desc.getNumImplicitDefs();
425   assert(Mask.getBitWidth() == NumDefs + NumImplicitDefs &&
426          "Unexpected number of bits in the mask!");
427 
428   bool HasVEX = (Desc.TSFlags & X86II::EncodingMask) == X86II::VEX;
429   bool HasEVEX = (Desc.TSFlags & X86II::EncodingMask) == X86II::EVEX;
430   bool HasXOP = (Desc.TSFlags & X86II::EncodingMask) == X86II::XOP;
431 
432   const MCRegisterClass &GR32RC = MRI.getRegClass(X86::GR32RegClassID);
433   const MCRegisterClass &VR128XRC = MRI.getRegClass(X86::VR128XRegClassID);
434   const MCRegisterClass &VR256XRC = MRI.getRegClass(X86::VR256XRegClassID);
435 
436   auto ClearsSuperReg = [=](unsigned RegID) {
437     // On X86-64, a general purpose integer register is viewed as a 64-bit
438     // register internal to the processor.
439     // An update to the lower 32 bits of a 64 bit integer register is
440     // architecturally defined to zero extend the upper 32 bits.
441     if (GR32RC.contains(RegID))
442       return true;
443 
444     // Early exit if this instruction has no vex/evex/xop prefix.
445     if (!HasEVEX && !HasVEX && !HasXOP)
446       return false;
447 
448     // All VEX and EVEX encoded instructions are defined to zero the high bits
449     // of the destination register up to VLMAX (i.e. the maximum vector register
450     // width pertaining to the instruction).
451     // We assume the same behavior for XOP instructions too.
452     return VR128XRC.contains(RegID) || VR256XRC.contains(RegID);
453   };
454 
455   Mask.clearAllBits();
456   for (unsigned I = 0, E = NumDefs; I < E; ++I) {
457     const MCOperand &Op = Inst.getOperand(I);
458     if (ClearsSuperReg(Op.getReg()))
459       Mask.setBit(I);
460   }
461 
462   for (unsigned I = 0, E = NumImplicitDefs; I < E; ++I) {
463     const MCPhysReg Reg = Desc.getImplicitDefs()[I];
464     if (ClearsSuperReg(Reg))
465       Mask.setBit(NumDefs + I);
466   }
467 
468   return Mask.getBoolValue();
469 }
470 
471 static std::vector<std::pair<uint64_t, uint64_t>>
472 findX86PltEntries(uint64_t PltSectionVA, ArrayRef<uint8_t> PltContents,
473                   uint64_t GotPltSectionVA) {
474   // Do a lightweight parsing of PLT entries.
475   std::vector<std::pair<uint64_t, uint64_t>> Result;
476   for (uint64_t Byte = 0, End = PltContents.size(); Byte + 6 < End; ) {
477     // Recognize a jmp.
478     if (PltContents[Byte] == 0xff && PltContents[Byte + 1] == 0xa3) {
479       // The jmp instruction at the beginning of each PLT entry jumps to the
480       // address of the base of the .got.plt section plus the immediate.
481       uint32_t Imm = support::endian::read32le(PltContents.data() + Byte + 2);
482       Result.push_back(
483           std::make_pair(PltSectionVA + Byte, GotPltSectionVA + Imm));
484       Byte += 6;
485     } else if (PltContents[Byte] == 0xff && PltContents[Byte + 1] == 0x25) {
486       // The jmp instruction at the beginning of each PLT entry jumps to the
487       // immediate.
488       uint32_t Imm = support::endian::read32le(PltContents.data() + Byte + 2);
489       Result.push_back(std::make_pair(PltSectionVA + Byte, Imm));
490       Byte += 6;
491     } else
492       Byte++;
493   }
494   return Result;
495 }
496 
497 static std::vector<std::pair<uint64_t, uint64_t>>
498 findX86_64PltEntries(uint64_t PltSectionVA, ArrayRef<uint8_t> PltContents) {
499   // Do a lightweight parsing of PLT entries.
500   std::vector<std::pair<uint64_t, uint64_t>> Result;
501   for (uint64_t Byte = 0, End = PltContents.size(); Byte + 6 < End; ) {
502     // Recognize a jmp.
503     if (PltContents[Byte] == 0xff && PltContents[Byte + 1] == 0x25) {
504       // The jmp instruction at the beginning of each PLT entry jumps to the
505       // address of the next instruction plus the immediate.
506       uint32_t Imm = support::endian::read32le(PltContents.data() + Byte + 2);
507       Result.push_back(
508           std::make_pair(PltSectionVA + Byte, PltSectionVA + Byte + 6 + Imm));
509       Byte += 6;
510     } else
511       Byte++;
512   }
513   return Result;
514 }
515 
516 std::vector<std::pair<uint64_t, uint64_t>> X86MCInstrAnalysis::findPltEntries(
517     uint64_t PltSectionVA, ArrayRef<uint8_t> PltContents,
518     uint64_t GotPltSectionVA, const Triple &TargetTriple) const {
519   switch (TargetTriple.getArch()) {
520     case Triple::x86:
521       return findX86PltEntries(PltSectionVA, PltContents, GotPltSectionVA);
522     case Triple::x86_64:
523       return findX86_64PltEntries(PltSectionVA, PltContents);
524     default:
525       return {};
526     }
527 }
528 
529 bool X86MCInstrAnalysis::evaluateBranch(const MCInst &Inst, uint64_t Addr,
530                                         uint64_t Size, uint64_t &Target) const {
531   if (Inst.getNumOperands() == 0 ||
532       Info->get(Inst.getOpcode()).OpInfo[0].OperandType != MCOI::OPERAND_PCREL)
533     return false;
534   Target = Addr + Size + Inst.getOperand(0).getImm();
535   return true;
536 }
537 
538 Optional<uint64_t> X86MCInstrAnalysis::evaluateMemoryOperandAddress(
539     const MCInst &Inst, const MCSubtargetInfo *STI, uint64_t Addr,
540     uint64_t Size) const {
541   const MCInstrDesc &MCID = Info->get(Inst.getOpcode());
542   int MemOpStart = X86II::getMemoryOperandNo(MCID.TSFlags);
543   if (MemOpStart == -1)
544     return None;
545   MemOpStart += X86II::getOperandBias(MCID);
546 
547   const MCOperand &SegReg = Inst.getOperand(MemOpStart + X86::AddrSegmentReg);
548   const MCOperand &BaseReg = Inst.getOperand(MemOpStart + X86::AddrBaseReg);
549   const MCOperand &IndexReg = Inst.getOperand(MemOpStart + X86::AddrIndexReg);
550   const MCOperand &ScaleAmt = Inst.getOperand(MemOpStart + X86::AddrScaleAmt);
551   const MCOperand &Disp = Inst.getOperand(MemOpStart + X86::AddrDisp);
552   if (SegReg.getReg() != 0 || IndexReg.getReg() != 0 || ScaleAmt.getImm() != 1 ||
553       !Disp.isImm())
554     return None;
555 
556   // RIP-relative addressing.
557   if (BaseReg.getReg() == X86::RIP)
558     return Addr + Size + Disp.getImm();
559 
560   return None;
561 }
562 
563 Optional<uint64_t>
564 X86MCInstrAnalysis::getMemoryOperandRelocationOffset(const MCInst &Inst,
565                                                      uint64_t Size) const {
566   if (Inst.getOpcode() != X86::LEA64r)
567     return None;
568   const MCInstrDesc &MCID = Info->get(Inst.getOpcode());
569   int MemOpStart = X86II::getMemoryOperandNo(MCID.TSFlags);
570   if (MemOpStart == -1)
571     return None;
572   MemOpStart += X86II::getOperandBias(MCID);
573   const MCOperand &SegReg = Inst.getOperand(MemOpStart + X86::AddrSegmentReg);
574   const MCOperand &BaseReg = Inst.getOperand(MemOpStart + X86::AddrBaseReg);
575   const MCOperand &IndexReg = Inst.getOperand(MemOpStart + X86::AddrIndexReg);
576   const MCOperand &ScaleAmt = Inst.getOperand(MemOpStart + X86::AddrScaleAmt);
577   const MCOperand &Disp = Inst.getOperand(MemOpStart + X86::AddrDisp);
578   // Must be a simple rip-relative address.
579   if (BaseReg.getReg() != X86::RIP || SegReg.getReg() != 0 ||
580       IndexReg.getReg() != 0 || ScaleAmt.getImm() != 1 || !Disp.isImm())
581     return None;
582   // rip-relative ModR/M immediate is 32 bits.
583   assert(Size > 4 && "invalid instruction size for rip-relative lea");
584   return Size - 4;
585 }
586 
587 } // end of namespace X86_MC
588 
589 } // end of namespace llvm
590 
591 static MCInstrAnalysis *createX86MCInstrAnalysis(const MCInstrInfo *Info) {
592   return new X86_MC::X86MCInstrAnalysis(Info);
593 }
594 
595 // Force static initialization.
596 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeX86TargetMC() {
597   for (Target *T : {&getTheX86_32Target(), &getTheX86_64Target()}) {
598     // Register the MC asm info.
599     RegisterMCAsmInfoFn X(*T, createX86MCAsmInfo);
600 
601     // Register the MC instruction info.
602     TargetRegistry::RegisterMCInstrInfo(*T, createX86MCInstrInfo);
603 
604     // Register the MC register info.
605     TargetRegistry::RegisterMCRegInfo(*T, createX86MCRegisterInfo);
606 
607     // Register the MC subtarget info.
608     TargetRegistry::RegisterMCSubtargetInfo(*T,
609                                             X86_MC::createX86MCSubtargetInfo);
610 
611     // Register the MC instruction analyzer.
612     TargetRegistry::RegisterMCInstrAnalysis(*T, createX86MCInstrAnalysis);
613 
614     // Register the code emitter.
615     TargetRegistry::RegisterMCCodeEmitter(*T, createX86MCCodeEmitter);
616 
617     // Register the obj target streamer.
618     TargetRegistry::RegisterObjectTargetStreamer(*T,
619                                                  createX86ObjectTargetStreamer);
620 
621     // Register the asm target streamer.
622     TargetRegistry::RegisterAsmTargetStreamer(*T, createX86AsmTargetStreamer);
623 
624     TargetRegistry::RegisterCOFFStreamer(*T, createX86WinCOFFStreamer);
625 
626     // Register the MCInstPrinter.
627     TargetRegistry::RegisterMCInstPrinter(*T, createX86MCInstPrinter);
628 
629     // Register the MC relocation info.
630     TargetRegistry::RegisterMCRelocationInfo(*T, createX86MCRelocationInfo);
631   }
632 
633   // Register the asm backend.
634   TargetRegistry::RegisterMCAsmBackend(getTheX86_32Target(),
635                                        createX86_32AsmBackend);
636   TargetRegistry::RegisterMCAsmBackend(getTheX86_64Target(),
637                                        createX86_64AsmBackend);
638 }
639 
640 MCRegister llvm::getX86SubSuperRegisterOrZero(MCRegister Reg, unsigned Size,
641                                               bool High) {
642   switch (Size) {
643   default: return X86::NoRegister;
644   case 8:
645     if (High) {
646       switch (Reg.id()) {
647       default: return getX86SubSuperRegisterOrZero(Reg, 64);
648       case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
649         return X86::SI;
650       case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
651         return X86::DI;
652       case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
653         return X86::BP;
654       case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
655         return X86::SP;
656       case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
657         return X86::AH;
658       case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
659         return X86::DH;
660       case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
661         return X86::CH;
662       case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
663         return X86::BH;
664       }
665     } else {
666       switch (Reg.id()) {
667       default: return X86::NoRegister;
668       case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
669         return X86::AL;
670       case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
671         return X86::DL;
672       case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
673         return X86::CL;
674       case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
675         return X86::BL;
676       case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
677         return X86::SIL;
678       case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
679         return X86::DIL;
680       case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
681         return X86::BPL;
682       case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
683         return X86::SPL;
684       case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
685         return X86::R8B;
686       case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
687         return X86::R9B;
688       case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
689         return X86::R10B;
690       case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
691         return X86::R11B;
692       case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
693         return X86::R12B;
694       case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
695         return X86::R13B;
696       case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
697         return X86::R14B;
698       case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
699         return X86::R15B;
700       }
701     }
702   case 16:
703     switch (Reg.id()) {
704     default: return X86::NoRegister;
705     case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
706       return X86::AX;
707     case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
708       return X86::DX;
709     case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
710       return X86::CX;
711     case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
712       return X86::BX;
713     case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
714       return X86::SI;
715     case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
716       return X86::DI;
717     case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
718       return X86::BP;
719     case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
720       return X86::SP;
721     case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
722       return X86::R8W;
723     case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
724       return X86::R9W;
725     case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
726       return X86::R10W;
727     case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
728       return X86::R11W;
729     case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
730       return X86::R12W;
731     case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
732       return X86::R13W;
733     case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
734       return X86::R14W;
735     case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
736       return X86::R15W;
737     }
738   case 32:
739     switch (Reg.id()) {
740     default: return X86::NoRegister;
741     case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
742       return X86::EAX;
743     case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
744       return X86::EDX;
745     case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
746       return X86::ECX;
747     case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
748       return X86::EBX;
749     case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
750       return X86::ESI;
751     case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
752       return X86::EDI;
753     case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
754       return X86::EBP;
755     case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
756       return X86::ESP;
757     case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
758       return X86::R8D;
759     case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
760       return X86::R9D;
761     case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
762       return X86::R10D;
763     case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
764       return X86::R11D;
765     case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
766       return X86::R12D;
767     case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
768       return X86::R13D;
769     case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
770       return X86::R14D;
771     case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
772       return X86::R15D;
773     }
774   case 64:
775     switch (Reg.id()) {
776     default: return 0;
777     case X86::AH: case X86::AL: case X86::AX: case X86::EAX: case X86::RAX:
778       return X86::RAX;
779     case X86::DH: case X86::DL: case X86::DX: case X86::EDX: case X86::RDX:
780       return X86::RDX;
781     case X86::CH: case X86::CL: case X86::CX: case X86::ECX: case X86::RCX:
782       return X86::RCX;
783     case X86::BH: case X86::BL: case X86::BX: case X86::EBX: case X86::RBX:
784       return X86::RBX;
785     case X86::SIL: case X86::SI: case X86::ESI: case X86::RSI:
786       return X86::RSI;
787     case X86::DIL: case X86::DI: case X86::EDI: case X86::RDI:
788       return X86::RDI;
789     case X86::BPL: case X86::BP: case X86::EBP: case X86::RBP:
790       return X86::RBP;
791     case X86::SPL: case X86::SP: case X86::ESP: case X86::RSP:
792       return X86::RSP;
793     case X86::R8B: case X86::R8W: case X86::R8D: case X86::R8:
794       return X86::R8;
795     case X86::R9B: case X86::R9W: case X86::R9D: case X86::R9:
796       return X86::R9;
797     case X86::R10B: case X86::R10W: case X86::R10D: case X86::R10:
798       return X86::R10;
799     case X86::R11B: case X86::R11W: case X86::R11D: case X86::R11:
800       return X86::R11;
801     case X86::R12B: case X86::R12W: case X86::R12D: case X86::R12:
802       return X86::R12;
803     case X86::R13B: case X86::R13W: case X86::R13D: case X86::R13:
804       return X86::R13;
805     case X86::R14B: case X86::R14W: case X86::R14D: case X86::R14:
806       return X86::R14;
807     case X86::R15B: case X86::R15W: case X86::R15D: case X86::R15:
808       return X86::R15;
809     }
810   }
811 }
812 
813 MCRegister llvm::getX86SubSuperRegister(MCRegister Reg, unsigned Size, bool High) {
814   MCRegister Res = getX86SubSuperRegisterOrZero(Reg, Size, High);
815   assert(Res != X86::NoRegister && "Unexpected register or VT");
816   return Res;
817 }
818 
819 
820