Add X86 feature detection support for BMI instructions. Added new cpuid function...
[oota-llvm.git] / lib / Target / X86 / MCTargetDesc / X86MCTargetDesc.cpp
1 //===-- X86MCTargetDesc.cpp - X86 Target Descriptions -----------*- 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 // This file provides X86 specific target descriptions.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "X86MCTargetDesc.h"
15 #include "X86MCAsmInfo.h"
16 #include "InstPrinter/X86ATTInstPrinter.h"
17 #include "InstPrinter/X86IntelInstPrinter.h"
18 #include "llvm/MC/MachineLocation.h"
19 #include "llvm/MC/MCCodeGenInfo.h"
20 #include "llvm/MC/MCInstrAnalysis.h"
21 #include "llvm/MC/MCInstrInfo.h"
22 #include "llvm/MC/MCRegisterInfo.h"
23 #include "llvm/MC/MCStreamer.h"
24 #include "llvm/MC/MCSubtargetInfo.h"
25 #include "llvm/ADT/Triple.h"
26 #include "llvm/Support/Host.h"
27 #include "llvm/Support/TargetRegistry.h"
28
29 #define GET_REGINFO_MC_DESC
30 #include "X86GenRegisterInfo.inc"
31
32 #define GET_INSTRINFO_MC_DESC
33 #include "X86GenInstrInfo.inc"
34
35 #define GET_SUBTARGETINFO_MC_DESC
36 #include "X86GenSubtargetInfo.inc"
37
38 using namespace llvm;
39
40
41 std::string X86_MC::ParseX86Triple(StringRef TT) {
42   Triple TheTriple(TT);
43   std::string FS;
44   if (TheTriple.getArch() == Triple::x86_64)
45     FS = "+64bit-mode";
46   else
47     FS = "-64bit-mode";
48   if (TheTriple.getOS() == Triple::NativeClient)
49     FS += ",+nacl-mode";
50   else
51     FS += ",-nacl-mode";
52   return FS;
53 }
54
55 /// GetCpuIDAndInfo - Execute the specified cpuid and return the 4 values in the
56 /// specified arguments.  If we can't run cpuid on the host, return true.
57 bool X86_MC::GetCpuIDAndInfo(unsigned value, unsigned *rEAX,
58                              unsigned *rEBX, unsigned *rECX, unsigned *rEDX) {
59 #if defined(__x86_64__) || defined(_M_AMD64) || defined (_M_X64)
60   #if defined(__GNUC__)
61     // gcc doesn't know cpuid would clobber ebx/rbx. Preseve it manually.
62     asm ("movq\t%%rbx, %%rsi\n\t"
63          "cpuid\n\t"
64          "xchgq\t%%rbx, %%rsi\n\t"
65          : "=a" (*rEAX),
66            "=S" (*rEBX),
67            "=c" (*rECX),
68            "=d" (*rEDX)
69          :  "a" (value));
70     return false;
71   #elif defined(_MSC_VER)
72     int registers[4];
73     __cpuid(registers, value);
74     *rEAX = registers[0];
75     *rEBX = registers[1];
76     *rECX = registers[2];
77     *rEDX = registers[3];
78     return false;
79   #endif
80 #elif defined(i386) || defined(__i386__) || defined(__x86__) || defined(_M_IX86)
81   #if defined(__GNUC__)
82     asm ("movl\t%%ebx, %%esi\n\t"
83          "cpuid\n\t"
84          "xchgl\t%%ebx, %%esi\n\t"
85          : "=a" (*rEAX),
86            "=S" (*rEBX),
87            "=c" (*rECX),
88            "=d" (*rEDX)
89          :  "a" (value));
90     return false;
91   #elif defined(_MSC_VER)
92     __asm {
93       mov   eax,value
94       cpuid
95       mov   esi,rEAX
96       mov   dword ptr [esi],eax
97       mov   esi,rEBX
98       mov   dword ptr [esi],ebx
99       mov   esi,rECX
100       mov   dword ptr [esi],ecx
101       mov   esi,rEDX
102       mov   dword ptr [esi],edx
103     }
104     return false;
105   #endif
106 #endif
107   return true;
108 }
109
110 /// GetCpuIDAndInfoEx - Execute the specified cpuid with subleaf and return the
111 /// 4 values in the specified arguments.  If we can't run cpuid on the host,
112 /// return true.
113 bool X86_MC::GetCpuIDAndInfoEx(unsigned value, unsigned subleaf, unsigned *rEAX,
114                                unsigned *rEBX, unsigned *rECX, unsigned *rEDX) {
115 #if defined(__x86_64__) || defined(_M_AMD64) || defined (_M_X64)
116   #if defined(__GNUC__)
117     // gcc desn't know cpuid would clobber ebx/rbx. Preseve it manually.
118     asm ("movq\t%%rbx, %%rsi\n\t"
119          "cpuid\n\t"
120          "xchgq\t%%rbx, %%rsi\n\t"
121          : "=a" (*rEAX),
122            "=S" (*rEBX),
123            "=c" (*rECX),
124            "=d" (*rEDX)
125          :  "a" (value),
126             "c" (subleaf));
127     return false;
128   #elif defined(_MSC_VER)
129     // can't use __cpuidex because it isn't available in all supported versions
130     // of MSC
131     __asm {
132       mov   eax,value
133       mov   ecx,subleaf
134       cpuid
135       mov   rsi,rEAX
136       mov   dword ptr [rsi],eax
137       mov   rsi,rEBX
138       mov   dword ptr [rsi],ebx
139       mov   rsi,rECX
140       mov   dword ptr [rsi],ecx
141       mov   rsi,rEDX
142       mov   dword ptr [rsi],edx
143     }
144     return false;
145   #endif
146 #elif defined(i386) || defined(__i386__) || defined(__x86__) || defined(_M_IX86)
147   #if defined(__GNUC__)
148     asm ("movl\t%%ebx, %%esi\n\t"
149          "cpuid\n\t"
150          "xchgl\t%%ebx, %%esi\n\t"
151          : "=a" (*rEAX),
152            "=S" (*rEBX),
153            "=c" (*rECX),
154            "=d" (*rEDX)
155          :  "a" (value),
156             "c" (subleaf));
157     return false;
158   #elif defined(_MSC_VER)
159     __asm {
160       mov   eax,value
161       mov   ecx,subleaf
162       cpuid
163       mov   esi,rEAX
164       mov   dword ptr [esi],eax
165       mov   esi,rEBX
166       mov   dword ptr [esi],ebx
167       mov   esi,rECX
168       mov   dword ptr [esi],ecx
169       mov   esi,rEDX
170       mov   dword ptr [esi],edx
171     }
172     return false;
173   #endif
174 #endif
175   return true;
176 }
177
178 void X86_MC::DetectFamilyModel(unsigned EAX, unsigned &Family,
179                                unsigned &Model) {
180   Family = (EAX >> 8) & 0xf; // Bits 8 - 11
181   Model  = (EAX >> 4) & 0xf; // Bits 4 - 7
182   if (Family == 6 || Family == 0xf) {
183     if (Family == 0xf)
184       // Examine extended family ID if family ID is F.
185       Family += (EAX >> 20) & 0xff;    // Bits 20 - 27
186     // Examine extended model ID if family ID is 6 or F.
187     Model += ((EAX >> 16) & 0xf) << 4; // Bits 16 - 19
188   }
189 }
190
191 unsigned X86_MC::getDwarfRegFlavour(StringRef TT, bool isEH) {
192   Triple TheTriple(TT);
193   if (TheTriple.getArch() == Triple::x86_64)
194     return DWARFFlavour::X86_64;
195
196   if (TheTriple.isOSDarwin())
197     return isEH ? DWARFFlavour::X86_32_DarwinEH : DWARFFlavour::X86_32_Generic;
198   if (TheTriple.getOS() == Triple::MinGW32 ||
199       TheTriple.getOS() == Triple::Cygwin)
200     // Unsupported by now, just quick fallback
201     return DWARFFlavour::X86_32_Generic;
202   return DWARFFlavour::X86_32_Generic;
203 }
204
205 /// getX86RegNum - This function maps LLVM register identifiers to their X86
206 /// specific numbering, which is used in various places encoding instructions.
207 unsigned X86_MC::getX86RegNum(unsigned RegNo) {
208   switch(RegNo) {
209   case X86::RAX: case X86::EAX: case X86::AX: case X86::AL: return N86::EAX;
210   case X86::RCX: case X86::ECX: case X86::CX: case X86::CL: return N86::ECX;
211   case X86::RDX: case X86::EDX: case X86::DX: case X86::DL: return N86::EDX;
212   case X86::RBX: case X86::EBX: case X86::BX: case X86::BL: return N86::EBX;
213   case X86::RSP: case X86::ESP: case X86::SP: case X86::SPL: case X86::AH:
214     return N86::ESP;
215   case X86::RBP: case X86::EBP: case X86::BP: case X86::BPL: case X86::CH:
216     return N86::EBP;
217   case X86::RSI: case X86::ESI: case X86::SI: case X86::SIL: case X86::DH:
218     return N86::ESI;
219   case X86::RDI: case X86::EDI: case X86::DI: case X86::DIL: case X86::BH:
220     return N86::EDI;
221
222   case X86::R8:  case X86::R8D:  case X86::R8W:  case X86::R8B:
223     return N86::EAX;
224   case X86::R9:  case X86::R9D:  case X86::R9W:  case X86::R9B:
225     return N86::ECX;
226   case X86::R10: case X86::R10D: case X86::R10W: case X86::R10B:
227     return N86::EDX;
228   case X86::R11: case X86::R11D: case X86::R11W: case X86::R11B:
229     return N86::EBX;
230   case X86::R12: case X86::R12D: case X86::R12W: case X86::R12B:
231     return N86::ESP;
232   case X86::R13: case X86::R13D: case X86::R13W: case X86::R13B:
233     return N86::EBP;
234   case X86::R14: case X86::R14D: case X86::R14W: case X86::R14B:
235     return N86::ESI;
236   case X86::R15: case X86::R15D: case X86::R15W: case X86::R15B:
237     return N86::EDI;
238
239   case X86::ST0: case X86::ST1: case X86::ST2: case X86::ST3:
240   case X86::ST4: case X86::ST5: case X86::ST6: case X86::ST7:
241     return RegNo-X86::ST0;
242
243   case X86::XMM0: case X86::XMM8:
244   case X86::YMM0: case X86::YMM8: case X86::MM0:
245     return 0;
246   case X86::XMM1: case X86::XMM9:
247   case X86::YMM1: case X86::YMM9: case X86::MM1:
248     return 1;
249   case X86::XMM2: case X86::XMM10:
250   case X86::YMM2: case X86::YMM10: case X86::MM2:
251     return 2;
252   case X86::XMM3: case X86::XMM11:
253   case X86::YMM3: case X86::YMM11: case X86::MM3:
254     return 3;
255   case X86::XMM4: case X86::XMM12:
256   case X86::YMM4: case X86::YMM12: case X86::MM4:
257     return 4;
258   case X86::XMM5: case X86::XMM13:
259   case X86::YMM5: case X86::YMM13: case X86::MM5:
260     return 5;
261   case X86::XMM6: case X86::XMM14:
262   case X86::YMM6: case X86::YMM14: case X86::MM6:
263     return 6;
264   case X86::XMM7: case X86::XMM15:
265   case X86::YMM7: case X86::YMM15: case X86::MM7:
266     return 7;
267
268   case X86::ES: return 0;
269   case X86::CS: return 1;
270   case X86::SS: return 2;
271   case X86::DS: return 3;
272   case X86::FS: return 4;
273   case X86::GS: return 5;
274
275   case X86::CR0: case X86::CR8 : case X86::DR0: return 0;
276   case X86::CR1: case X86::CR9 : case X86::DR1: return 1;
277   case X86::CR2: case X86::CR10: case X86::DR2: return 2;
278   case X86::CR3: case X86::CR11: case X86::DR3: return 3;
279   case X86::CR4: case X86::CR12: case X86::DR4: return 4;
280   case X86::CR5: case X86::CR13: case X86::DR5: return 5;
281   case X86::CR6: case X86::CR14: case X86::DR6: return 6;
282   case X86::CR7: case X86::CR15: case X86::DR7: return 7;
283
284   // Pseudo index registers are equivalent to a "none"
285   // scaled index (See Intel Manual 2A, table 2-3)
286   case X86::EIZ:
287   case X86::RIZ:
288     return 4;
289
290   default:
291     assert((int(RegNo) > 0) && "Unknown physical register!");
292     return 0;
293   }
294 }
295
296 void X86_MC::InitLLVM2SEHRegisterMapping(MCRegisterInfo *MRI) {
297   // FIXME: TableGen these.
298   for (unsigned Reg = X86::NoRegister+1; Reg < X86::NUM_TARGET_REGS; ++Reg) {
299     int SEH = X86_MC::getX86RegNum(Reg);
300     switch (Reg) {
301     case X86::R8:  case X86::R8D:  case X86::R8W:  case X86::R8B:
302     case X86::R9:  case X86::R9D:  case X86::R9W:  case X86::R9B:
303     case X86::R10: case X86::R10D: case X86::R10W: case X86::R10B:
304     case X86::R11: case X86::R11D: case X86::R11W: case X86::R11B:
305     case X86::R12: case X86::R12D: case X86::R12W: case X86::R12B:
306     case X86::R13: case X86::R13D: case X86::R13W: case X86::R13B:
307     case X86::R14: case X86::R14D: case X86::R14W: case X86::R14B:
308     case X86::R15: case X86::R15D: case X86::R15W: case X86::R15B:
309     case X86::XMM8:  case X86::XMM9:  case X86::XMM10: case X86::XMM11:
310     case X86::XMM12: case X86::XMM13: case X86::XMM14: case X86::XMM15:
311     case X86::YMM8:  case X86::YMM9:  case X86::YMM10: case X86::YMM11:
312     case X86::YMM12: case X86::YMM13: case X86::YMM14: case X86::YMM15:
313       SEH += 8;
314       break;
315     }
316     MRI->mapLLVMRegToSEHReg(Reg, SEH);
317   }
318 }
319
320 MCSubtargetInfo *X86_MC::createX86MCSubtargetInfo(StringRef TT, StringRef CPU,
321                                                   StringRef FS) {
322   std::string ArchFS = X86_MC::ParseX86Triple(TT);
323   if (!FS.empty()) {
324     if (!ArchFS.empty())
325       ArchFS = ArchFS + "," + FS.str();
326     else
327       ArchFS = FS;
328   }
329
330   std::string CPUName = CPU;
331   if (CPUName.empty()) {
332 #if defined (__x86_64__) || defined(__i386__)
333     CPUName = sys::getHostCPUName();
334 #else
335     CPUName = "generic";
336 #endif
337   }
338
339   MCSubtargetInfo *X = new MCSubtargetInfo();
340   InitX86MCSubtargetInfo(X, TT, CPUName, ArchFS);
341   return X;
342 }
343
344 static MCInstrInfo *createX86MCInstrInfo() {
345   MCInstrInfo *X = new MCInstrInfo();
346   InitX86MCInstrInfo(X);
347   return X;
348 }
349
350 static MCRegisterInfo *createX86MCRegisterInfo(StringRef TT) {
351   Triple TheTriple(TT);
352   unsigned RA = (TheTriple.getArch() == Triple::x86_64)
353     ? X86::RIP     // Should have dwarf #16.
354     : X86::EIP;    // Should have dwarf #8.
355
356   MCRegisterInfo *X = new MCRegisterInfo();
357   InitX86MCRegisterInfo(X, RA,
358                         X86_MC::getDwarfRegFlavour(TT, false),
359                         X86_MC::getDwarfRegFlavour(TT, true));
360   X86_MC::InitLLVM2SEHRegisterMapping(X);
361   return X;
362 }
363
364 static MCAsmInfo *createX86MCAsmInfo(const Target &T, StringRef TT) {
365   Triple TheTriple(TT);
366   bool is64Bit = TheTriple.getArch() == Triple::x86_64;
367
368   MCAsmInfo *MAI;
369   if (TheTriple.isOSDarwin() || TheTriple.getEnvironment() == Triple::MachO) {
370     if (is64Bit)
371       MAI = new X86_64MCAsmInfoDarwin(TheTriple);
372     else
373       MAI = new X86MCAsmInfoDarwin(TheTriple);
374   } else if (TheTriple.isOSWindows()) {
375     MAI = new X86MCAsmInfoCOFF(TheTriple);
376   } else {
377     MAI = new X86ELFMCAsmInfo(TheTriple);
378   }
379
380   // Initialize initial frame state.
381   // Calculate amount of bytes used for return address storing
382   int stackGrowth = is64Bit ? -8 : -4;
383
384   // Initial state of the frame pointer is esp+stackGrowth.
385   MachineLocation Dst(MachineLocation::VirtualFP);
386   MachineLocation Src(is64Bit ? X86::RSP : X86::ESP, stackGrowth);
387   MAI->addInitialFrameState(0, Dst, Src);
388
389   // Add return address to move list
390   MachineLocation CSDst(is64Bit ? X86::RSP : X86::ESP, stackGrowth);
391   MachineLocation CSSrc(is64Bit ? X86::RIP : X86::EIP);
392   MAI->addInitialFrameState(0, CSDst, CSSrc);
393
394   return MAI;
395 }
396
397 static MCCodeGenInfo *createX86MCCodeGenInfo(StringRef TT, Reloc::Model RM,
398                                              CodeModel::Model CM) {
399   MCCodeGenInfo *X = new MCCodeGenInfo();
400
401   Triple T(TT);
402   bool is64Bit = T.getArch() == Triple::x86_64;
403
404   if (RM == Reloc::Default) {
405     // Darwin defaults to PIC in 64 bit mode and dynamic-no-pic in 32 bit mode.
406     // Win64 requires rip-rel addressing, thus we force it to PIC. Otherwise we
407     // use static relocation model by default.
408     if (T.isOSDarwin()) {
409       if (is64Bit)
410         RM = Reloc::PIC_;
411       else
412         RM = Reloc::DynamicNoPIC;
413     } else if (T.isOSWindows() && is64Bit)
414       RM = Reloc::PIC_;
415     else
416       RM = Reloc::Static;
417   }
418
419   // ELF and X86-64 don't have a distinct DynamicNoPIC model.  DynamicNoPIC
420   // is defined as a model for code which may be used in static or dynamic
421   // executables but not necessarily a shared library. On X86-32 we just
422   // compile in -static mode, in x86-64 we use PIC.
423   if (RM == Reloc::DynamicNoPIC) {
424     if (is64Bit)
425       RM = Reloc::PIC_;
426     else if (!T.isOSDarwin())
427       RM = Reloc::Static;
428   }
429
430   // If we are on Darwin, disallow static relocation model in X86-64 mode, since
431   // the Mach-O file format doesn't support it.
432   if (RM == Reloc::Static && T.isOSDarwin() && is64Bit)
433     RM = Reloc::PIC_;
434
435   // For static codegen, if we're not already set, use Small codegen.
436   if (CM == CodeModel::Default)
437     CM = CodeModel::Small;
438   else if (CM == CodeModel::JITDefault)
439     // 64-bit JIT places everything in the same buffer except external funcs.
440     CM = is64Bit ? CodeModel::Large : CodeModel::Small;
441
442   X->InitMCCodeGenInfo(RM, CM);
443   return X;
444 }
445
446 static MCStreamer *createMCStreamer(const Target &T, StringRef TT,
447                                     MCContext &Ctx, MCAsmBackend &MAB,
448                                     raw_ostream &_OS,
449                                     MCCodeEmitter *_Emitter,
450                                     bool RelaxAll,
451                                     bool NoExecStack) {
452   Triple TheTriple(TT);
453
454   if (TheTriple.isOSDarwin() || TheTriple.getEnvironment() == Triple::MachO)
455     return createMachOStreamer(Ctx, MAB, _OS, _Emitter, RelaxAll);
456
457   if (TheTriple.isOSWindows())
458     return createWinCOFFStreamer(Ctx, MAB, *_Emitter, _OS, RelaxAll);
459
460   return createELFStreamer(Ctx, MAB, _OS, _Emitter, RelaxAll, NoExecStack);
461 }
462
463 static MCInstPrinter *createX86MCInstPrinter(const Target &T,
464                                              unsigned SyntaxVariant,
465                                              const MCAsmInfo &MAI,
466                                              const MCSubtargetInfo &STI) {
467   if (SyntaxVariant == 0)
468     return new X86ATTInstPrinter(MAI);
469   if (SyntaxVariant == 1)
470     return new X86IntelInstPrinter(MAI);
471   return 0;
472 }
473
474 static MCInstrAnalysis *createX86MCInstrAnalysis(const MCInstrInfo *Info) {
475   return new MCInstrAnalysis(Info);
476 }
477
478 // Force static initialization.
479 extern "C" void LLVMInitializeX86TargetMC() {
480   // Register the MC asm info.
481   RegisterMCAsmInfoFn A(TheX86_32Target, createX86MCAsmInfo);
482   RegisterMCAsmInfoFn B(TheX86_64Target, createX86MCAsmInfo);
483
484   // Register the MC codegen info.
485   RegisterMCCodeGenInfoFn C(TheX86_32Target, createX86MCCodeGenInfo);
486   RegisterMCCodeGenInfoFn D(TheX86_64Target, createX86MCCodeGenInfo);
487
488   // Register the MC instruction info.
489   TargetRegistry::RegisterMCInstrInfo(TheX86_32Target, createX86MCInstrInfo);
490   TargetRegistry::RegisterMCInstrInfo(TheX86_64Target, createX86MCInstrInfo);
491
492   // Register the MC register info.
493   TargetRegistry::RegisterMCRegInfo(TheX86_32Target, createX86MCRegisterInfo);
494   TargetRegistry::RegisterMCRegInfo(TheX86_64Target, createX86MCRegisterInfo);
495
496   // Register the MC subtarget info.
497   TargetRegistry::RegisterMCSubtargetInfo(TheX86_32Target,
498                                           X86_MC::createX86MCSubtargetInfo);
499   TargetRegistry::RegisterMCSubtargetInfo(TheX86_64Target,
500                                           X86_MC::createX86MCSubtargetInfo);
501
502   // Register the MC instruction analyzer.
503   TargetRegistry::RegisterMCInstrAnalysis(TheX86_32Target,
504                                           createX86MCInstrAnalysis);
505   TargetRegistry::RegisterMCInstrAnalysis(TheX86_64Target,
506                                           createX86MCInstrAnalysis);
507
508   // Register the code emitter.
509   TargetRegistry::RegisterMCCodeEmitter(TheX86_32Target,
510                                         createX86MCCodeEmitter);
511   TargetRegistry::RegisterMCCodeEmitter(TheX86_64Target,
512                                         createX86MCCodeEmitter);
513
514   // Register the asm backend.
515   TargetRegistry::RegisterMCAsmBackend(TheX86_32Target,
516                                        createX86_32AsmBackend);
517   TargetRegistry::RegisterMCAsmBackend(TheX86_64Target,
518                                        createX86_64AsmBackend);
519
520   // Register the object streamer.
521   TargetRegistry::RegisterMCObjectStreamer(TheX86_32Target,
522                                            createMCStreamer);
523   TargetRegistry::RegisterMCObjectStreamer(TheX86_64Target,
524                                            createMCStreamer);
525
526   // Register the MCInstPrinter.
527   TargetRegistry::RegisterMCInstPrinter(TheX86_32Target,
528                                         createX86MCInstPrinter);
529   TargetRegistry::RegisterMCInstPrinter(TheX86_64Target,
530                                         createX86MCInstPrinter);
531 }