lib/Target/X86/AsmPrinter/X86AsmPrinter.cpp

   1 //===-- X86AsmPrinter.cpp - Convert X86 LLVM code to AT&T assembly --------===//
   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 contains a printer that converts from our internal representation
  11 // of machine-dependent LLVM code to AT&T format assembly
  12 // language. This printer is the output mechanism used by `llc'.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "asm-printer"
  17 #include "X86AsmPrinter.h"
  18 #include "X86ATTInstPrinter.h"
  19 #include "X86IntelInstPrinter.h"
  20 #include "X86MCInstLower.h"
  21 #include "X86.h"
  22 #include "X86COFF.h"
  23 #include "X86COFFMachineModuleInfo.h"
  24 #include "X86MachineFunctionInfo.h"
  25 #include "X86TargetMachine.h"
  26 #include "llvm/CallingConv.h"
  27 #include "llvm/DerivedTypes.h"
  28 #include "llvm/Module.h"
  29 #include "llvm/Type.h"
  30 #include "llvm/Assembly/Writer.h"
  31 #include "llvm/MC/MCContext.h"
  32 #include "llvm/MC/MCSectionMachO.h"
  33 #include "llvm/MC/MCStreamer.h"
  34 #include "llvm/MC/MCSymbol.h"
  35 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  36 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
  37 #include "llvm/Support/ErrorHandling.h"
  38 #include "llvm/Support/FormattedStream.h"
  39 #include "llvm/MC/MCAsmInfo.h"
  40 #include "llvm/Target/TargetLoweringObjectFile.h"
  41 #include "llvm/Target/TargetOptions.h"
  42 #include "llvm/Target/TargetRegistry.h"
  43 #include "llvm/ADT/SmallString.h"
  44 #include "llvm/ADT/Statistic.h"
  45 using namespace llvm;
  46
  47 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  48
  49 //===----------------------------------------------------------------------===//
  50 // Primitive Helper Functions.
  51 //===----------------------------------------------------------------------===//
  52
  53 void X86AsmPrinter::printMCInst(const MCInst *MI) {
  54   if (MAI->getAssemblerDialect() == 0)
  55     X86ATTInstPrinter(O, *MAI).printInstruction(MI);
  56   else
  57     X86IntelInstPrinter(O, *MAI).printInstruction(MI);
  58 }
  59
  60 void X86AsmPrinter::PrintPICBaseSymbol() const {
  61   // FIXME: Gross const cast hack.
  62   X86AsmPrinter *AP = const_cast<X86AsmPrinter*>(this);
  63   O << *X86MCInstLower(OutContext, 0, *AP).GetPICBaseSymbol();
  64 }
  65
  66 void X86AsmPrinter::emitFunctionHeader(const MachineFunction &MF) {
  67   unsigned FnAlign = MF.getAlignment();
  68   const Function *F = MF.getFunction();
  69
  70   if (Subtarget->isTargetCygMing()) {
  71     X86COFFMachineModuleInfo &COFFMMI =
  72       MMI->getObjFileInfo<X86COFFMachineModuleInfo>();
  73     COFFMMI.DecorateCygMingName(CurrentFnSym, OutContext, F,
  74                                 *TM.getTargetData());
  75   }
  76
  77   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
  78   EmitAlignment(FnAlign, F);
  79
  80   switch (F->getLinkage()) {
  81   default: llvm_unreachable("Unknown linkage type!");
  82   case Function::InternalLinkage:  // Symbols default to internal.
  83   case Function::PrivateLinkage:
  84     break;
  85   case Function::DLLExportLinkage:
  86   case Function::ExternalLinkage:
  87     OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCStreamer::Global);
  88     break;
  89   case Function::LinkerPrivateLinkage:
  90   case Function::LinkOnceAnyLinkage:
  91   case Function::LinkOnceODRLinkage:
  92   case Function::WeakAnyLinkage:
  93   case Function::WeakODRLinkage:
  94     if (Subtarget->isTargetDarwin()) {
  95       OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCStreamer::Global);
  96       O << MAI->getWeakDefDirective() << *CurrentFnSym << '\n';
  97     } else if (Subtarget->isTargetCygMing()) {
  98       OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCStreamer::Global);
  99       O << "\t.linkonce discard\n";
 100     } else {
 101       O << "\t.weak\t" << *CurrentFnSym << '\n';
 102     }
 103     break;
 104   }
 105
 106   printVisibility(CurrentFnSym, F->getVisibility());
 107
 108   if (Subtarget->isTargetELF()) {
 109     O << "\t.type\t" << *CurrentFnSym << ",@function\n";
 110   } else if (Subtarget->isTargetCygMing()) {
 111     O << "\t.def\t " << *CurrentFnSym;
 112     O << ";\t.scl\t" <<
 113       (F->hasInternalLinkage() ? COFF::C_STAT : COFF::C_EXT)
 114       << ";\t.type\t" << (COFF::DT_FCN << COFF::N_BTSHFT)
 115       << ";\t.endef\n";
 116   }
 117
 118   O << *CurrentFnSym << ':';
 119   if (VerboseAsm) {
 120     O.PadToColumn(MAI->getCommentColumn());
 121     O << MAI->getCommentString() << ' ';
 122     WriteAsOperand(O, F, /*PrintType=*/false, F->getParent());
 123   }
 124   O << '\n';
 125
 126   // Add some workaround for linkonce linkage on Cygwin\MinGW
 127   if (Subtarget->isTargetCygMing() &&
 128       (F->hasLinkOnceLinkage() || F->hasWeakLinkage()))
 129     O << "Lllvm$workaround$fake$stub$" << *CurrentFnSym << ":\n";
 130 }
 131
 132 /// runOnMachineFunction - This uses the printMachineInstruction()
 133 /// method to print assembly for each instruction.
 134 ///
 135 bool X86AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 136   const Function *F = MF.getFunction();
 137   this->MF = &MF;
 138   CallingConv::ID CC = F->getCallingConv();
 139
 140   SetupMachineFunction(MF);
 141   O << "\n\n";
 142
 143   if (Subtarget->isTargetCOFF()) {
 144     X86COFFMachineModuleInfo &COFFMMI =
 145     MMI->getObjFileInfo<X86COFFMachineModuleInfo>();
 146
 147     // Populate function information map.  Don't want to populate
 148     // non-stdcall or non-fastcall functions' information right now.
 149     if (CC == CallingConv::X86_StdCall || CC == CallingConv::X86_FastCall)
 150       COFFMMI.AddFunctionInfo(F, *MF.getInfo<X86MachineFunctionInfo>());
 151   }
 152
 153   // Print out constants referenced by the function
 154   EmitConstantPool(MF.getConstantPool());
 155
 156   // Print the 'header' of function
 157   emitFunctionHeader(MF);
 158
 159   // Emit pre-function debug and/or EH information.
 160   if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
 161     DW->BeginFunction(&MF);
 162
 163   // Print out code for the function.
 164   bool hasAnyRealCode = false;
 165   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 166        I != E; ++I) {
 167     // Print a label for the basic block.
 168     EmitBasicBlockStart(I);
 169     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
 170          II != IE; ++II) {
 171       // Print the assembly for the instruction.
 172       if (!II->isLabel())
 173         hasAnyRealCode = true;
 174       printMachineInstruction(II);
 175     }
 176   }
 177
 178   if (Subtarget->isTargetDarwin() && !hasAnyRealCode) {
 179     // If the function is empty, then we need to emit *something*. Otherwise,
 180     // the function's label might be associated with something that it wasn't
 181     // meant to be associated with. We emit a noop in this situation.
 182     // We are assuming inline asms are code.
 183     O << "\tnop\n";
 184   }
 185
 186   if (MAI->hasDotTypeDotSizeDirective())
 187     O << "\t.size\t" << *CurrentFnSym << ", .-" << *CurrentFnSym << '\n';
 188
 189   // Emit post-function debug information.
 190   if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
 191     DW->EndFunction(&MF);
 192
 193   // Print out jump tables referenced by the function.
 194   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 195
 196   // We didn't modify anything.
 197   return false;
 198 }
 199
 200 /// printSymbolOperand - Print a raw symbol reference operand.  This handles
 201 /// jump tables, constant pools, global address and external symbols, all of
 202 /// which print to a label with various suffixes for relocation types etc.
 203 void X86AsmPrinter::printSymbolOperand(const MachineOperand &MO) {
 204   switch (MO.getType()) {
 205   default: llvm_unreachable("unknown symbol type!");
 206   case MachineOperand::MO_JumpTableIndex:
 207     O << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber() << '_'
 208       << MO.getIndex();
 209     break;
 210   case MachineOperand::MO_ConstantPoolIndex:
 211     O << MAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
 212       << MO.getIndex();
 213     printOffset(MO.getOffset());
 214     break;
 215   case MachineOperand::MO_GlobalAddress: {
 216     const GlobalValue *GV = MO.getGlobal();
 217
 218     MCSymbol *GVSym;
 219     if (MO.getTargetFlags() == X86II::MO_DARWIN_STUB)
 220       GVSym = GetSymbolWithGlobalValueBase(GV, "$stub");
 221     else if (MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
 222              MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE ||
 223              MO.getTargetFlags() == X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE)
 224       GVSym = GetSymbolWithGlobalValueBase(GV, "$non_lazy_ptr");
 225     else
 226       GVSym = GetGlobalValueSymbol(GV);
 227
 228     if (Subtarget->isTargetCygMing()) {
 229       X86COFFMachineModuleInfo &COFFMMI =
 230         MMI->getObjFileInfo<X86COFFMachineModuleInfo>();
 231       COFFMMI.DecorateCygMingName(GVSym, OutContext, GV, *TM.getTargetData());
 232     }
 233
 234     // Handle dllimport linkage.
 235     if (MO.getTargetFlags() == X86II::MO_DLLIMPORT)
 236       GVSym = OutContext.GetOrCreateSymbol(Twine("__imp_") + GVSym->getName());
 237
 238     if (MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
 239         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE) {
 240       MCSymbol *Sym = GetSymbolWithGlobalValueBase(GV, "$non_lazy_ptr");
 241
 242       const MCSymbol *&StubSym =
 243         MMI->getObjFileInfo<MachineModuleInfoMachO>().getGVStubEntry(Sym);
 244       if (StubSym == 0)
 245         StubSym = GetGlobalValueSymbol(GV);
 246
 247     } else if (MO.getTargetFlags() == X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE){
 248       MCSymbol *Sym = GetSymbolWithGlobalValueBase(GV, "$non_lazy_ptr");
 249       const MCSymbol *&StubSym =
 250         MMI->getObjFileInfo<MachineModuleInfoMachO>().getHiddenGVStubEntry(Sym);
 251       if (StubSym == 0)
 252         StubSym = GetGlobalValueSymbol(GV);
 253     } else if (MO.getTargetFlags() == X86II::MO_DARWIN_STUB) {
 254       MCSymbol *Sym = GetSymbolWithGlobalValueBase(GV, "$stub");
 255       const MCSymbol *&StubSym =
 256         MMI->getObjFileInfo<MachineModuleInfoMachO>().getFnStubEntry(Sym);
 257       if (StubSym == 0)
 258         StubSym = GetGlobalValueSymbol(GV);
 259     }
 260
 261     // If the name begins with a dollar-sign, enclose it in parens.  We do this
 262     // to avoid having it look like an integer immediate to the assembler.
 263     if (GVSym->getName()[0] != '$')
 264       O << *GVSym;
 265     else
 266       O << '(' << *GVSym << ')';
 267     printOffset(MO.getOffset());
 268     break;
 269   }
 270   case MachineOperand::MO_ExternalSymbol: {
 271     const MCSymbol *SymToPrint;
 272     if (MO.getTargetFlags() == X86II::MO_DARWIN_STUB) {
 273       SmallString<128> TempNameStr;
 274       TempNameStr += StringRef(MO.getSymbolName());
 275       TempNameStr += StringRef("$stub");
 276
 277       const MCSymbol *Sym = GetExternalSymbolSymbol(TempNameStr.str());
 278       const MCSymbol *&StubSym =
 279         MMI->getObjFileInfo<MachineModuleInfoMachO>().getFnStubEntry(Sym);
 280       if (StubSym == 0) {
 281         TempNameStr.erase(TempNameStr.end()-5, TempNameStr.end());
 282         StubSym = OutContext.GetOrCreateSymbol(TempNameStr.str());
 283       }
 284       SymToPrint = StubSym;
 285     } else {
 286       SymToPrint = GetExternalSymbolSymbol(MO.getSymbolName());
 287     }
 288
 289     // If the name begins with a dollar-sign, enclose it in parens.  We do this
 290     // to avoid having it look like an integer immediate to the assembler.
 291     if (SymToPrint->getName()[0] != '$')
 292       O << *SymToPrint;
 293     else
 294       O << '(' << *SymToPrint << '(';
 295     break;
 296   }
 297   }
 298
 299   switch (MO.getTargetFlags()) {
 300   default:
 301     llvm_unreachable("Unknown target flag on GV operand");
 302   case X86II::MO_NO_FLAG:    // No flag.
 303     break;
 304   case X86II::MO_DARWIN_NONLAZY:
 305   case X86II::MO_DLLIMPORT:
 306   case X86II::MO_DARWIN_STUB:
 307     // These affect the name of the symbol, not any suffix.
 308     break;
 309   case X86II::MO_GOT_ABSOLUTE_ADDRESS:
 310     O << " + [.-";
 311     PrintPICBaseSymbol();
 312     O << ']';
 313     break;
 314   case X86II::MO_PIC_BASE_OFFSET:
 315   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
 316   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
 317     O << '-';
 318     PrintPICBaseSymbol();
 319     break;
 320   case X86II::MO_TLSGD:     O << "@TLSGD";     break;
 321   case X86II::MO_GOTTPOFF:  O << "@GOTTPOFF";  break;
 322   case X86II::MO_INDNTPOFF: O << "@INDNTPOFF"; break;
 323   case X86II::MO_TPOFF:     O << "@TPOFF";     break;
 324   case X86II::MO_NTPOFF:    O << "@NTPOFF";    break;
 325   case X86II::MO_GOTPCREL:  O << "@GOTPCREL";  break;
 326   case X86II::MO_GOT:       O << "@GOT";       break;
 327   case X86II::MO_GOTOFF:    O << "@GOTOFF";    break;
 328   case X86II::MO_PLT:       O << "@PLT";       break;
 329   }
 330 }
 331
 332 /// print_pcrel_imm - This is used to print an immediate value that ends up
 333 /// being encoded as a pc-relative value.  These print slightly differently, for
 334 /// example, a $ is not emitted.
 335 void X86AsmPrinter::print_pcrel_imm(const MachineInstr *MI, unsigned OpNo) {
 336   const MachineOperand &MO = MI->getOperand(OpNo);
 337   switch (MO.getType()) {
 338   default: llvm_unreachable("Unknown pcrel immediate operand");
 339   case MachineOperand::MO_Immediate:
 340     O << MO.getImm();
 341     return;
 342   case MachineOperand::MO_MachineBasicBlock:
 343     O << *GetMBBSymbol(MO.getMBB()->getNumber());
 344     return;
 345   case MachineOperand::MO_GlobalAddress:
 346   case MachineOperand::MO_ExternalSymbol:
 347     printSymbolOperand(MO);
 348     return;
 349   }
 350 }
 351
 352
 353 void X86AsmPrinter::printOperand(const MachineInstr *MI, unsigned OpNo,
 354                                  const char *Modifier) {
 355   const MachineOperand &MO = MI->getOperand(OpNo);
 356   switch (MO.getType()) {
 357   default: llvm_unreachable("unknown operand type!");
 358   case MachineOperand::MO_Register: {
 359     O << '%';
 360     unsigned Reg = MO.getReg();
 361     if (Modifier && strncmp(Modifier, "subreg", strlen("subreg")) == 0) {
 362       EVT VT = (strcmp(Modifier+6,"64") == 0) ?
 363         MVT::i64 : ((strcmp(Modifier+6, "32") == 0) ? MVT::i32 :
 364                     ((strcmp(Modifier+6,"16") == 0) ? MVT::i16 : MVT::i8));
 365       Reg = getX86SubSuperRegister(Reg, VT);
 366     }
 367     O << X86ATTInstPrinter::getRegisterName(Reg);
 368     return;
 369   }
 370
 371   case MachineOperand::MO_Immediate:
 372     O << '$' << MO.getImm();
 373     return;
 374
 375   case MachineOperand::MO_JumpTableIndex:
 376   case MachineOperand::MO_ConstantPoolIndex:
 377   case MachineOperand::MO_GlobalAddress:
 378   case MachineOperand::MO_ExternalSymbol: {
 379     O << '$';
 380     printSymbolOperand(MO);
 381     break;
 382   }
 383   }
 384 }
 385
 386 void X86AsmPrinter::printSSECC(const MachineInstr *MI, unsigned Op) {
 387   unsigned char value = MI->getOperand(Op).getImm();
 388   assert(value <= 7 && "Invalid ssecc argument!");
 389   switch (value) {
 390   case 0: O << "eq"; break;
 391   case 1: O << "lt"; break;
 392   case 2: O << "le"; break;
 393   case 3: O << "unord"; break;
 394   case 4: O << "neq"; break;
 395   case 5: O << "nlt"; break;
 396   case 6: O << "nle"; break;
 397   case 7: O << "ord"; break;
 398   }
 399 }
 400
 401 void X86AsmPrinter::printLeaMemReference(const MachineInstr *MI, unsigned Op,
 402                                          const char *Modifier) {
 403   const MachineOperand &BaseReg  = MI->getOperand(Op);
 404   const MachineOperand &IndexReg = MI->getOperand(Op+2);
 405   const MachineOperand &DispSpec = MI->getOperand(Op+3);
 406
 407   // If we really don't want to print out (rip), don't.
 408   bool HasBaseReg = BaseReg.getReg() != 0;
 409   if (HasBaseReg && Modifier && !strcmp(Modifier, "no-rip") &&
 410       BaseReg.getReg() == X86::RIP)
 411     HasBaseReg = false;
 412
 413   // HasParenPart - True if we will print out the () part of the mem ref.
 414   bool HasParenPart = IndexReg.getReg() || HasBaseReg;
 415
 416   if (DispSpec.isImm()) {
 417     int DispVal = DispSpec.getImm();
 418     if (DispVal || !HasParenPart)
 419       O << DispVal;
 420   } else {
 421     assert(DispSpec.isGlobal() || DispSpec.isCPI() ||
 422            DispSpec.isJTI() || DispSpec.isSymbol());
 423     printSymbolOperand(MI->getOperand(Op+3));
 424   }
 425
 426   if (HasParenPart) {
 427     assert(IndexReg.getReg() != X86::ESP &&
 428            "X86 doesn't allow scaling by ESP");
 429
 430     O << '(';
 431     if (HasBaseReg)
 432       printOperand(MI, Op, Modifier);
 433
 434     if (IndexReg.getReg()) {
 435       O << ',';
 436       printOperand(MI, Op+2, Modifier);
 437       unsigned ScaleVal = MI->getOperand(Op+1).getImm();
 438       if (ScaleVal != 1)
 439         O << ',' << ScaleVal;
 440     }
 441     O << ')';
 442   }
 443 }
 444
 445 void X86AsmPrinter::printMemReference(const MachineInstr *MI, unsigned Op,
 446                                       const char *Modifier) {
 447   assert(isMem(MI, Op) && "Invalid memory reference!");
 448   const MachineOperand &Segment = MI->getOperand(Op+4);
 449   if (Segment.getReg()) {
 450     printOperand(MI, Op+4, Modifier);
 451     O << ':';
 452   }
 453   printLeaMemReference(MI, Op, Modifier);
 454 }
 455
 456 void X86AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
 457                                            const MachineBasicBlock *MBB) const {
 458   if (!MAI->getSetDirective())
 459     return;
 460
 461   // We don't need .set machinery if we have GOT-style relocations
 462   if (Subtarget->isPICStyleGOT())
 463     return;
 464
 465   O << MAI->getSetDirective() << ' ' << MAI->getPrivateGlobalPrefix()
 466     << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
 467
 468   O << *GetMBBSymbol(MBB->getNumber());
 469
 470   if (Subtarget->isPICStyleRIPRel())
 471     O << '-' << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 472       << '_' << uid << '\n';
 473   else {
 474     O << '-';
 475     PrintPICBaseSymbol();
 476     O << '\n';
 477   }
 478 }
 479
 480
 481 void X86AsmPrinter::printPICLabel(const MachineInstr *MI, unsigned Op) {
 482   PrintPICBaseSymbol();
 483   O << '\n';
 484   PrintPICBaseSymbol();
 485   O << ':';
 486 }
 487
 488 void X86AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
 489                                            const MachineBasicBlock *MBB,
 490                                            unsigned uid) const {
 491   const char *JTEntryDirective = MJTI->getEntrySize() == 4 ?
 492     MAI->getData32bitsDirective() : MAI->getData64bitsDirective();
 493
 494   O << JTEntryDirective << ' ';
 495
 496   if (Subtarget->isPICStyleRIPRel() || Subtarget->isPICStyleStubPIC()) {
 497     O << MAI->getPrivateGlobalPrefix() << getFunctionNumber()
 498       << '_' << uid << "_set_" << MBB->getNumber();
 499   } else if (Subtarget->isPICStyleGOT())
 500     O << *GetMBBSymbol(MBB->getNumber()) << "@GOTOFF";
 501   else
 502     O << *GetMBBSymbol(MBB->getNumber());
 503 }
 504
 505 bool X86AsmPrinter::printAsmMRegister(const MachineOperand &MO, char Mode) {
 506   unsigned Reg = MO.getReg();
 507   switch (Mode) {
 508   default: return true;  // Unknown mode.
 509   case 'b': // Print QImode register
 510     Reg = getX86SubSuperRegister(Reg, MVT::i8);
 511     break;
 512   case 'h': // Print QImode high register
 513     Reg = getX86SubSuperRegister(Reg, MVT::i8, true);
 514     break;
 515   case 'w': // Print HImode register
 516     Reg = getX86SubSuperRegister(Reg, MVT::i16);
 517     break;
 518   case 'k': // Print SImode register
 519     Reg = getX86SubSuperRegister(Reg, MVT::i32);
 520     break;
 521   case 'q': // Print DImode register
 522     Reg = getX86SubSuperRegister(Reg, MVT::i64);
 523     break;
 524   }
 525
 526   O << '%' << X86ATTInstPrinter::getRegisterName(Reg);
 527   return false;
 528 }
 529
 530 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 531 ///
 532 bool X86AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 533                                     unsigned AsmVariant,
 534                                     const char *ExtraCode) {
 535   // Does this asm operand have a single letter operand modifier?
 536   if (ExtraCode && ExtraCode[0]) {
 537     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 538
 539     const MachineOperand &MO = MI->getOperand(OpNo);
 540
 541     switch (ExtraCode[0]) {
 542     default: return true;  // Unknown modifier.
 543     case 'a': // This is an address.  Currently only 'i' and 'r' are expected.
 544       if (MO.isImm()) {
 545         O << MO.getImm();
 546         return false;
 547       }
 548       if (MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isSymbol()) {
 549         printSymbolOperand(MO);
 550         return false;
 551       }
 552       if (MO.isReg()) {
 553         O << '(';
 554         printOperand(MI, OpNo);
 555         O << ')';
 556         return false;
 557       }
 558       return true;
 559
 560     case 'c': // Don't print "$" before a global var name or constant.
 561       if (MO.isImm())
 562         O << MO.getImm();
 563       else if (MO.isGlobal() || MO.isCPI() || MO.isJTI() || MO.isSymbol())
 564         printSymbolOperand(MO);
 565       else
 566         printOperand(MI, OpNo);
 567       return false;
 568
 569     case 'A': // Print '*' before a register (it must be a register)
 570       if (MO.isReg()) {
 571         O << '*';
 572         printOperand(MI, OpNo);
 573         return false;
 574       }
 575       return true;
 576
 577     case 'b': // Print QImode register
 578     case 'h': // Print QImode high register
 579     case 'w': // Print HImode register
 580     case 'k': // Print SImode register
 581     case 'q': // Print DImode register
 582       if (MO.isReg())
 583         return printAsmMRegister(MO, ExtraCode[0]);
 584       printOperand(MI, OpNo);
 585       return false;
 586
 587     case 'P': // This is the operand of a call, treat specially.
 588       print_pcrel_imm(MI, OpNo);
 589       return false;
 590
 591     case 'n':  // Negate the immediate or print a '-' before the operand.
 592       // Note: this is a temporary solution. It should be handled target
 593       // independently as part of the 'MC' work.
 594       if (MO.isImm()) {
 595         O << -MO.getImm();
 596         return false;
 597       }
 598       O << '-';
 599     }
 600   }
 601
 602   printOperand(MI, OpNo);
 603   return false;
 604 }
 605
 606 bool X86AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 607                                           unsigned OpNo, unsigned AsmVariant,
 608                                           const char *ExtraCode) {
 609   if (ExtraCode && ExtraCode[0]) {
 610     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 611
 612     switch (ExtraCode[0]) {
 613     default: return true;  // Unknown modifier.
 614     case 'b': // Print QImode register
 615     case 'h': // Print QImode high register
 616     case 'w': // Print HImode register
 617     case 'k': // Print SImode register
 618     case 'q': // Print SImode register
 619       // These only apply to registers, ignore on mem.
 620       break;
 621     case 'P': // Don't print @PLT, but do print as memory.
 622       printMemReference(MI, OpNo, "no-rip");
 623       return false;
 624     }
 625   }
 626   printMemReference(MI, OpNo);
 627   return false;
 628 }
 629
 630
 631
 632 /// printMachineInstruction -- Print out a single X86 LLVM instruction MI in
 633 /// AT&T syntax to the current output stream.
 634 ///
 635 void X86AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 636   ++EmittedInsts;
 637
 638   processDebugLoc(MI, true);
 639
 640   printInstructionThroughMCStreamer(MI);
 641
 642   if (VerboseAsm)
 643     EmitComments(*MI);
 644   O << '\n';
 645
 646   processDebugLoc(MI, false);
 647 }
 648
 649 void X86AsmPrinter::PrintGlobalVariable(const GlobalVariable* GVar) {
 650   if (!GVar->hasInitializer())
 651     return;   // External global require no code
 652
 653   // Check to see if this is a special global used by LLVM, if so, emit it.
 654   if (EmitSpecialLLVMGlobal(GVar)) {
 655     if (Subtarget->isTargetDarwin() &&
 656         TM.getRelocationModel() == Reloc::Static) {
 657       if (GVar->getName() == "llvm.global_ctors")
 658         O << ".reference .constructors_used\n";
 659       else if (GVar->getName() == "llvm.global_dtors")
 660         O << ".reference .destructors_used\n";
 661     }
 662     return;
 663   }
 664
 665   const TargetData *TD = TM.getTargetData();
 666
 667   MCSymbol *GVSym = GetGlobalValueSymbol(GVar);
 668   Constant *C = GVar->getInitializer();
 669   const Type *Type = C->getType();
 670   unsigned Size = TD->getTypeAllocSize(Type);
 671   unsigned Align = TD->getPreferredAlignmentLog(GVar);
 672
 673   printVisibility(GVSym, GVar->getVisibility());
 674
 675   if (Subtarget->isTargetELF())
 676     O << "\t.type\t" << *GVSym << ",@object\n";
 677
 678   SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GVar, TM);
 679   const MCSection *TheSection =
 680     getObjFileLowering().SectionForGlobal(GVar, GVKind, Mang, TM);
 681   OutStreamer.SwitchSection(TheSection);
 682
 683   // FIXME: get this stuff from section kind flags.
 684   if (C->isNullValue() && !GVar->hasSection() &&
 685       // Don't put things that should go in the cstring section into "comm".
 686       !TheSection->getKind().isMergeableCString()) {
 687     if (GVar->hasExternalLinkage()) {
 688       if (MAI->hasZeroFillDirective()) {
 689         // .globl _foo
 690         OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
 691         // .zerofill __DATA, __common, _foo, 400, 5
 692         TargetLoweringObjectFileMachO &TLOFMacho =
 693           static_cast<TargetLoweringObjectFileMachO &>(getObjFileLowering());
 694         // FIXME: This stuff should already be handled by SectionForGlobal!
 695         const MCSection *TheSection =
 696           TLOFMacho.getMachOSection("__DATA", "__common",
 697                                     MCSectionMachO::S_ZEROFILL,
 698                                     SectionKind::getBSS());
 699
 700         OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << Align);
 701         return;
 702       }
 703     }
 704
 705     if (!GVar->isThreadLocal() &&
 706         (GVar->hasLocalLinkage() || GVar->isWeakForLinker())) {
 707       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 708
 709       if (MAI->getLCOMMDirective() != NULL) {
 710         if (GVar->hasLocalLinkage()) {
 711           O << MAI->getLCOMMDirective() << *GVSym << ',' << Size;
 712           if (Subtarget->isTargetDarwin())
 713             O << ',' << Align;
 714         } else if (Subtarget->isTargetDarwin() && !GVar->hasCommonLinkage()) {
 715           OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
 716           O << MAI->getWeakDefDirective() << *GVSym << '\n';
 717           EmitAlignment(Align, GVar);
 718           O << *GVSym << ":";
 719           if (VerboseAsm) {
 720             O.PadToColumn(MAI->getCommentColumn());
 721             O << MAI->getCommentString() << ' ';
 722             WriteAsOperand(O, GVar, /*PrintType=*/false, GVar->getParent());
 723           }
 724           O << '\n';
 725           EmitGlobalConstant(C);
 726           return;
 727         } else {
 728           O << MAI->getCOMMDirective() << *GVSym << ',' << Size;
 729           if (MAI->getCOMMDirectiveTakesAlignment())
 730             O << ',' << (MAI->getAlignmentIsInBytes() ? (1 << Align) : Align);
 731         }
 732       } else {
 733         if (!Subtarget->isTargetCygMing()) {
 734           if (GVar->hasLocalLinkage())
 735             O << "\t.local\t" << *GVSym << '\n';
 736         }
 737         O << MAI->getCOMMDirective() << *GVSym << ',' << Size;
 738         if (MAI->getCOMMDirectiveTakesAlignment())
 739           O << ',' << (MAI->getAlignmentIsInBytes() ? (1 << Align) : Align);
 740       }
 741       if (VerboseAsm) {
 742         O.PadToColumn(MAI->getCommentColumn());
 743         O << MAI->getCommentString() << ' ';
 744         WriteAsOperand(O, GVar, /*PrintType=*/false, GVar->getParent());
 745       }
 746       O << '\n';
 747       return;
 748     }
 749   }
 750
 751   switch (GVar->getLinkage()) {
 752   case GlobalValue::CommonLinkage:
 753   case GlobalValue::LinkOnceAnyLinkage:
 754   case GlobalValue::LinkOnceODRLinkage:
 755   case GlobalValue::WeakAnyLinkage:
 756   case GlobalValue::WeakODRLinkage:
 757   case GlobalValue::LinkerPrivateLinkage:
 758     if (Subtarget->isTargetDarwin()) {
 759       OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
 760       O << MAI->getWeakDefDirective() << *GVSym << '\n';
 761     } else if (Subtarget->isTargetCygMing()) {
 762       OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
 763       O << "\t.linkonce same_size\n";
 764     } else
 765       O << "\t.weak\t" << *GVSym << '\n';
 766     break;
 767   case GlobalValue::DLLExportLinkage:
 768   case GlobalValue::AppendingLinkage:
 769     // FIXME: appending linkage variables should go into a section of
 770     // their name or something.  For now, just emit them as external.
 771   case GlobalValue::ExternalLinkage:
 772     // If external or appending, declare as a global symbol
 773     OutStreamer.EmitSymbolAttribute(GVSym, MCStreamer::Global);
 774     break;
 775   case GlobalValue::PrivateLinkage:
 776   case GlobalValue::InternalLinkage:
 777      break;
 778   default:
 779     llvm_unreachable("Unknown linkage type!");
 780   }
 781
 782   EmitAlignment(Align, GVar);
 783   O << *GVSym << ":";
 784   if (VerboseAsm){
 785     O.PadToColumn(MAI->getCommentColumn());
 786     O << MAI->getCommentString() << ' ';
 787     WriteAsOperand(O, GVar, /*PrintType=*/false, GVar->getParent());
 788   }
 789   O << '\n';
 790
 791   EmitGlobalConstant(C);
 792
 793   if (MAI->hasDotTypeDotSizeDirective())
 794     O << "\t.size\t" << *GVSym << ", " << Size << '\n';
 795 }
 796
 797 void X86AsmPrinter::EmitEndOfAsmFile(Module &M) {
 798   if (Subtarget->isTargetDarwin()) {
 799     // All darwin targets use mach-o.
 800     TargetLoweringObjectFileMachO &TLOFMacho =
 801       static_cast<TargetLoweringObjectFileMachO &>(getObjFileLowering());
 802
 803     MachineModuleInfoMachO &MMIMacho =
 804       MMI->getObjFileInfo<MachineModuleInfoMachO>();
 805
 806     // Output stubs for dynamically-linked functions.
 807     MachineModuleInfoMachO::SymbolListTy Stubs;
 808
 809     Stubs = MMIMacho.GetFnStubList();
 810     if (!Stubs.empty()) {
 811       const MCSection *TheSection =
 812         TLOFMacho.getMachOSection("__IMPORT", "__jump_table",
 813                                   MCSectionMachO::S_SYMBOL_STUBS |
 814                                   MCSectionMachO::S_ATTR_SELF_MODIFYING_CODE |
 815                                   MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
 816                                   5, SectionKind::getMetadata());
 817       OutStreamer.SwitchSection(TheSection);
 818
 819       for (unsigned i = 0, e = Stubs.size(); i != e; ++i) {
 820         O << *Stubs[i].first << ":\n";
 821         // Get the MCSymbol without the $stub suffix.
 822         O << "\t.indirect_symbol " << *Stubs[i].second;
 823         O << "\n\thlt ; hlt ; hlt ; hlt ; hlt\n";
 824       }
 825       O << '\n';
 826
 827       Stubs.clear();
 828     }
 829
 830     // Output stubs for external and common global variables.
 831     Stubs = MMIMacho.GetGVStubList();
 832     if (!Stubs.empty()) {
 833       const MCSection *TheSection =
 834         TLOFMacho.getMachOSection("__IMPORT", "__pointers",
 835                                   MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS,
 836                                   SectionKind::getMetadata());
 837       OutStreamer.SwitchSection(TheSection);
 838
 839       for (unsigned i = 0, e = Stubs.size(); i != e; ++i) {
 840         O << *Stubs[i].first << ":\n\t.indirect_symbol " << *Stubs[i].second;
 841         O << "\n\t.long\t0\n";
 842       }
 843       Stubs.clear();
 844     }
 845
 846     Stubs = MMIMacho.GetHiddenGVStubList();
 847     if (!Stubs.empty()) {
 848       OutStreamer.SwitchSection(getObjFileLowering().getDataSection());
 849       EmitAlignment(2);
 850
 851       for (unsigned i = 0, e = Stubs.size(); i != e; ++i) {
 852         O << *Stubs[i].first << ":\n" << MAI->getData32bitsDirective();
 853         O << *Stubs[i].second << '\n';
 854       }
 855       Stubs.clear();
 856     }
 857
 858     // Funny Darwin hack: This flag tells the linker that no global symbols
 859     // contain code that falls through to other global symbols (e.g. the obvious
 860     // implementation of multiple entry points).  If this doesn't occur, the
 861     // linker can safely perform dead code stripping.  Since LLVM never
 862     // generates code that does this, it is always safe to set.
 863     OutStreamer.EmitAssemblerFlag(MCStreamer::SubsectionsViaSymbols);
 864   }
 865
 866   if (Subtarget->isTargetCOFF()) {
 867     X86COFFMachineModuleInfo &COFFMMI =
 868       MMI->getObjFileInfo<X86COFFMachineModuleInfo>();
 869
 870     // Emit type information for external functions
 871     for (X86COFFMachineModuleInfo::stub_iterator I = COFFMMI.stub_begin(),
 872            E = COFFMMI.stub_end(); I != E; ++I) {
 873       O << "\t.def\t " << I->getKeyData()
 874         << ";\t.scl\t" << COFF::C_EXT
 875         << ";\t.type\t" << (COFF::DT_FCN << COFF::N_BTSHFT)
 876         << ";\t.endef\n";
 877     }
 878
 879     if (Subtarget->isTargetCygMing()) {
 880       // Necessary for dllexport support
 881       std::vector<const MCSymbol*> DLLExportedFns, DLLExportedGlobals;
 882
 883       TargetLoweringObjectFileCOFF &TLOFCOFF =
 884         static_cast<TargetLoweringObjectFileCOFF&>(getObjFileLowering());
 885
 886       for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
 887         if (I->hasDLLExportLinkage()) {
 888           MCSymbol *Sym = GetGlobalValueSymbol(I);
 889           COFFMMI.DecorateCygMingName(Sym, OutContext, I, *TM.getTargetData());
 890           DLLExportedFns.push_back(Sym);
 891         }
 892
 893       for (Module::const_global_iterator I = M.global_begin(),
 894              E = M.global_end(); I != E; ++I)
 895         if (I->hasDLLExportLinkage())
 896           DLLExportedGlobals.push_back(GetGlobalValueSymbol(I));
 897
 898       // Output linker support code for dllexported globals on windows.
 899       if (!DLLExportedGlobals.empty() || !DLLExportedFns.empty()) {
 900         OutStreamer.SwitchSection(TLOFCOFF.getCOFFSection(".section .drectve",
 901                                                           true,
 902                                                    SectionKind::getMetadata()));
 903         for (unsigned i = 0, e = DLLExportedGlobals.size(); i != e; ++i)
 904           O << "\t.ascii \" -export:" << *DLLExportedGlobals[i] << ",data\"\n";
 905
 906         for (unsigned i = 0, e = DLLExportedFns.size(); i != e; ++i)
 907           O << "\t.ascii \" -export:" << *DLLExportedFns[i] << "\"\n";
 908       }
 909     }
 910   }
 911 }
 912
 913
 914 //===----------------------------------------------------------------------===//
 915 // Target Registry Stuff
 916 //===----------------------------------------------------------------------===//
 917
 918 static MCInstPrinter *createX86MCInstPrinter(const Target &T,
 919                                              unsigned SyntaxVariant,
 920                                              const MCAsmInfo &MAI,
 921                                              raw_ostream &O) {
 922   if (SyntaxVariant == 0)
 923     return new X86ATTInstPrinter(O, MAI);
 924   if (SyntaxVariant == 1)
 925     return new X86IntelInstPrinter(O, MAI);
 926   return 0;
 927 }
 928
 929 // Force static initialization.
 930 extern "C" void LLVMInitializeX86AsmPrinter() {
 931   RegisterAsmPrinter<X86AsmPrinter> X(TheX86_32Target);
 932   RegisterAsmPrinter<X86AsmPrinter> Y(TheX86_64Target);
 933
 934   TargetRegistry::RegisterMCInstPrinter(TheX86_32Target,createX86MCInstPrinter);
 935   TargetRegistry::RegisterMCInstPrinter(TheX86_64Target,createX86MCInstPrinter);
 936 }