lib/Target/X86/AsmPrinter/X86IntelAsmPrinter.cpp

   1 //===-- X86IntelAsmPrinter.cpp - Convert X86 LLVM code to Intel 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 Intel format assembly language.
  12 // This printer is the output mechanism used by `llc'.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "asm-printer"
  17 #include "X86IntelAsmPrinter.h"
  18 #include "X86InstrInfo.h"
  19 #include "X86TargetAsmInfo.h"
  20 #include "X86.h"
  21 #include "llvm/CallingConv.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/DerivedTypes.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/ADT/Statistic.h"
  26 #include "llvm/ADT/StringExtras.h"
  27 #include "llvm/Assembly/Writer.h"
  28 #include "llvm/CodeGen/DwarfWriter.h"
  29 #include "llvm/Support/ErrorHandling.h"
  30 #include "llvm/Support/Mangler.h"
  31 #include "llvm/Target/TargetAsmInfo.h"
  32 #include "llvm/Target/TargetOptions.h"
  33 using namespace llvm;
  34
  35 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  36
  37 static X86MachineFunctionInfo calculateFunctionInfo(const Function *F,
  38                                                     const TargetData *TD) {
  39   X86MachineFunctionInfo Info;
  40   uint64_t Size = 0;
  41
  42   switch (F->getCallingConv()) {
  43   case CallingConv::X86_StdCall:
  44     Info.setDecorationStyle(StdCall);
  45     break;
  46   case CallingConv::X86_FastCall:
  47     Info.setDecorationStyle(FastCall);
  48     break;
  49   default:
  50     return Info;
  51   }
  52
  53   unsigned argNum = 1;
  54   for (Function::const_arg_iterator AI = F->arg_begin(), AE = F->arg_end();
  55        AI != AE; ++AI, ++argNum) {
  56     const Type* Ty = AI->getType();
  57
  58     // 'Dereference' type in case of byval parameter attribute
  59     if (F->paramHasAttr(argNum, Attribute::ByVal))
  60       Ty = cast<PointerType>(Ty)->getElementType();
  61
  62     // Size should be aligned to DWORD boundary
  63     Size += ((TD->getTypeAllocSize(Ty) + 3)/4)*4;
  64   }
  65
  66   // We're not supporting tooooo huge arguments :)
  67   Info.setBytesToPopOnReturn((unsigned int)Size);
  68   return Info;
  69 }
  70
  71
  72 /// decorateName - Query FunctionInfoMap and use this information for various
  73 /// name decoration.
  74 void X86IntelAsmPrinter::decorateName(std::string &Name,
  75                                       const GlobalValue *GV) {
  76   const Function *F = dyn_cast<Function>(GV);
  77   if (!F) return;
  78
  79   // We don't want to decorate non-stdcall or non-fastcall functions right now
  80   unsigned CC = F->getCallingConv();
  81   if (CC != CallingConv::X86_StdCall && CC != CallingConv::X86_FastCall)
  82     return;
  83
  84   FMFInfoMap::const_iterator info_item = FunctionInfoMap.find(F);
  85
  86   const X86MachineFunctionInfo *Info;
  87   if (info_item == FunctionInfoMap.end()) {
  88     // Calculate apropriate function info and populate map
  89     FunctionInfoMap[F] = calculateFunctionInfo(F, TM.getTargetData());
  90     Info = &FunctionInfoMap[F];
  91   } else {
  92     Info = &info_item->second;
  93   }
  94
  95   const FunctionType *FT = F->getFunctionType();
  96   switch (Info->getDecorationStyle()) {
  97   case None:
  98     break;
  99   case StdCall:
 100     // "Pure" variadic functions do not receive @0 suffix.
 101     if (!FT->isVarArg() || (FT->getNumParams() == 0) ||
 102         (FT->getNumParams() == 1 && F->hasStructRetAttr()))
 103       Name += '@' + utostr_32(Info->getBytesToPopOnReturn());
 104     break;
 105   case FastCall:
 106     // "Pure" variadic functions do not receive @0 suffix.
 107     if (!FT->isVarArg() || (FT->getNumParams() == 0) ||
 108         (FT->getNumParams() == 1 && F->hasStructRetAttr()))
 109       Name += '@' + utostr_32(Info->getBytesToPopOnReturn());
 110
 111     if (Name[0] == '_')
 112       Name[0] = '@';
 113     else
 114       Name = '@' + Name;
 115
 116     break;
 117   default:
 118     LLVM_UNREACHABLE( "Unsupported DecorationStyle");
 119   }
 120 }
 121
 122 /// runOnMachineFunction - This uses the printMachineInstruction()
 123 /// method to print assembly for each instruction.
 124 ///
 125 bool X86IntelAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 126   this->MF = &MF;
 127   SetupMachineFunction(MF);
 128   O << "\n\n";
 129
 130   // Print out constants referenced by the function
 131   EmitConstantPool(MF.getConstantPool());
 132
 133   // Print out labels for the function.
 134   const Function *F = MF.getFunction();
 135   unsigned CC = F->getCallingConv();
 136   unsigned FnAlign = MF.getAlignment();
 137
 138   // Populate function information map.  Actually, We don't want to populate
 139   // non-stdcall or non-fastcall functions' information right now.
 140   if (CC == CallingConv::X86_StdCall || CC == CallingConv::X86_FastCall)
 141     FunctionInfoMap[F] = *MF.getInfo<X86MachineFunctionInfo>();
 142
 143   decorateName(CurrentFnName, F);
 144
 145   SwitchToTextSection("_text", F);
 146   switch (F->getLinkage()) {
 147   default: LLVM_UNREACHABLE( "Unsupported linkage type!");
 148   case Function::PrivateLinkage:
 149   case Function::InternalLinkage:
 150     EmitAlignment(FnAlign);
 151     break;
 152   case Function::DLLExportLinkage:
 153     DLLExportedFns.insert(CurrentFnName);
 154     //FALLS THROUGH
 155   case Function::ExternalLinkage:
 156     O << "\tpublic " << CurrentFnName << "\n";
 157     EmitAlignment(FnAlign);
 158     break;
 159   }
 160
 161   O << CurrentFnName << "\tproc near\n";
 162
 163   // Print out code for the function.
 164   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 165        I != E; ++I) {
 166     // Print a label for the basic block if there are any predecessors.
 167     if (!I->pred_empty()) {
 168       printBasicBlockLabel(I, true, true);
 169       O << '\n';
 170     }
 171     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 172          II != E; ++II) {
 173       // Print the assembly for the instruction.
 174       printMachineInstruction(II);
 175     }
 176   }
 177
 178   // Print out jump tables referenced by the function.
 179   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 180
 181   O << CurrentFnName << "\tendp\n";
 182
 183   O.flush();
 184
 185   // We didn't modify anything.
 186   return false;
 187 }
 188
 189 void X86IntelAsmPrinter::printSSECC(const MachineInstr *MI, unsigned Op) {
 190   unsigned char value = MI->getOperand(Op).getImm();
 191   assert(value <= 7 && "Invalid ssecc argument!");
 192   switch (value) {
 193   case 0: O << "eq"; break;
 194   case 1: O << "lt"; break;
 195   case 2: O << "le"; break;
 196   case 3: O << "unord"; break;
 197   case 4: O << "neq"; break;
 198   case 5: O << "nlt"; break;
 199   case 6: O << "nle"; break;
 200   case 7: O << "ord"; break;
 201   }
 202 }
 203
 204 void X86IntelAsmPrinter::printOp(const MachineOperand &MO,
 205                                  const char *Modifier) {
 206   switch (MO.getType()) {
 207   case MachineOperand::MO_Register: {
 208     if (TargetRegisterInfo::isPhysicalRegister(MO.getReg())) {
 209       unsigned Reg = MO.getReg();
 210       if (Modifier && strncmp(Modifier, "subreg", strlen("subreg")) == 0) {
 211         MVT VT = (strcmp(Modifier,"subreg64") == 0) ?
 212           MVT::i64 : ((strcmp(Modifier, "subreg32") == 0) ? MVT::i32 :
 213                       ((strcmp(Modifier,"subreg16") == 0) ? MVT::i16 :MVT::i8));
 214         Reg = getX86SubSuperRegister(Reg, VT);
 215       }
 216       O << TRI->getName(Reg);
 217     } else
 218       O << "reg" << MO.getReg();
 219     return;
 220   }
 221   case MachineOperand::MO_Immediate:
 222     O << MO.getImm();
 223     return;
 224   case MachineOperand::MO_JumpTableIndex: {
 225     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
 226     if (!isMemOp) O << "OFFSET ";
 227     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 228       << "_" << MO.getIndex();
 229     return;
 230   }
 231   case MachineOperand::MO_ConstantPoolIndex: {
 232     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
 233     if (!isMemOp) O << "OFFSET ";
 234     O << "[" << TAI->getPrivateGlobalPrefix() << "CPI"
 235       << getFunctionNumber() << "_" << MO.getIndex();
 236     printOffset(MO.getOffset());
 237     O << "]";
 238     return;
 239   }
 240   case MachineOperand::MO_GlobalAddress: {
 241     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
 242     GlobalValue *GV = MO.getGlobal();
 243     std::string Name = Mang->getValueName(GV);
 244
 245     decorateName(Name, GV);
 246
 247     if (!isMemOp) O << "OFFSET ";
 248
 249     // Handle dllimport linkage.
 250     // FIXME: This should be fixed with full support of stdcall & fastcall
 251     // CC's
 252     if (MO.getTargetFlags() == X86II::MO_DLLIMPORT)
 253       O << "__imp_";
 254
 255     O << Name;
 256     printOffset(MO.getOffset());
 257     return;
 258   }
 259   case MachineOperand::MO_ExternalSymbol: {
 260     O << TAI->getGlobalPrefix() << MO.getSymbolName();
 261     return;
 262   }
 263   default:
 264     O << "<unknown operand type>"; return;
 265   }
 266 }
 267
 268 void X86IntelAsmPrinter::print_pcrel_imm(const MachineInstr *MI, unsigned OpNo){
 269   const MachineOperand &MO = MI->getOperand(OpNo);
 270   switch (MO.getType()) {
 271   default: LLVM_UNREACHABLE( "Unknown pcrel immediate operand");
 272   case MachineOperand::MO_Immediate:
 273     O << MO.getImm();
 274     return;
 275   case MachineOperand::MO_MachineBasicBlock:
 276     printBasicBlockLabel(MO.getMBB());
 277     return;
 278
 279   case MachineOperand::MO_GlobalAddress: {
 280     GlobalValue *GV = MO.getGlobal();
 281     std::string Name = Mang->getValueName(GV);
 282     decorateName(Name, GV);
 283
 284     // Handle dllimport linkage.
 285     // FIXME: This should be fixed with full support of stdcall & fastcall
 286     // CC's
 287     if (MO.getTargetFlags() == X86II::MO_DLLIMPORT)
 288       O << "__imp_";
 289     O << Name;
 290     printOffset(MO.getOffset());
 291     return;
 292   }
 293
 294   case MachineOperand::MO_ExternalSymbol:
 295     O << TAI->getGlobalPrefix() << MO.getSymbolName();
 296     return;
 297   }
 298 }
 299
 300
 301 void X86IntelAsmPrinter::printLeaMemReference(const MachineInstr *MI,
 302                                               unsigned Op,
 303                                               const char *Modifier) {
 304   const MachineOperand &BaseReg  = MI->getOperand(Op);
 305   int ScaleVal                   = MI->getOperand(Op+1).getImm();
 306   const MachineOperand &IndexReg = MI->getOperand(Op+2);
 307   const MachineOperand &DispSpec = MI->getOperand(Op+3);
 308
 309   O << "[";
 310   bool NeedPlus = false;
 311   if (BaseReg.getReg()) {
 312     printOp(BaseReg, Modifier);
 313     NeedPlus = true;
 314   }
 315
 316   if (IndexReg.getReg()) {
 317     if (NeedPlus) O << " + ";
 318     if (ScaleVal != 1)
 319       O << ScaleVal << "*";
 320     printOp(IndexReg, Modifier);
 321     NeedPlus = true;
 322   }
 323
 324   if (DispSpec.isGlobal() || DispSpec.isCPI() ||
 325       DispSpec.isJTI()) {
 326     if (NeedPlus)
 327       O << " + ";
 328     printOp(DispSpec, "mem");
 329   } else {
 330     int DispVal = DispSpec.getImm();
 331     if (DispVal || (!BaseReg.getReg() && !IndexReg.getReg())) {
 332       if (NeedPlus) {
 333         if (DispVal > 0)
 334           O << " + ";
 335         else {
 336           O << " - ";
 337           DispVal = -DispVal;
 338         }
 339       }
 340       O << DispVal;
 341     }
 342   }
 343   O << "]";
 344 }
 345
 346 void X86IntelAsmPrinter::printMemReference(const MachineInstr *MI, unsigned Op,
 347                                            const char *Modifier) {
 348   assert(isMem(MI, Op) && "Invalid memory reference!");
 349   MachineOperand Segment = MI->getOperand(Op+4);
 350   if (Segment.getReg()) {
 351       printOperand(MI, Op+4, Modifier);
 352       O << ':';
 353     }
 354   printLeaMemReference(MI, Op, Modifier);
 355 }
 356
 357 void X86IntelAsmPrinter::printPICJumpTableSetLabel(unsigned uid,
 358                                            const MachineBasicBlock *MBB) const {
 359   if (!TAI->getSetDirective())
 360     return;
 361
 362   O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
 363     << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
 364   printBasicBlockLabel(MBB, false, false, false);
 365   O << '-' << "\"L" << getFunctionNumber() << "$pb\"'\n";
 366 }
 367
 368 void X86IntelAsmPrinter::printPICLabel(const MachineInstr *MI, unsigned Op) {
 369   O << "L" << getFunctionNumber() << "$pb\n";
 370   O << "L" << getFunctionNumber() << "$pb:";
 371 }
 372
 373 bool X86IntelAsmPrinter::printAsmMRegister(const MachineOperand &MO,
 374                                            const char Mode) {
 375   unsigned Reg = MO.getReg();
 376   switch (Mode) {
 377   default: return true;  // Unknown mode.
 378   case 'b': // Print QImode register
 379     Reg = getX86SubSuperRegister(Reg, MVT::i8);
 380     break;
 381   case 'h': // Print QImode high register
 382     Reg = getX86SubSuperRegister(Reg, MVT::i8, true);
 383     break;
 384   case 'w': // Print HImode register
 385     Reg = getX86SubSuperRegister(Reg, MVT::i16);
 386     break;
 387   case 'k': // Print SImode register
 388     Reg = getX86SubSuperRegister(Reg, MVT::i32);
 389     break;
 390   }
 391
 392   O << TRI->getName(Reg);
 393   return false;
 394 }
 395
 396 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 397 ///
 398 bool X86IntelAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 399                                          unsigned AsmVariant,
 400                                          const char *ExtraCode) {
 401   // Does this asm operand have a single letter operand modifier?
 402   if (ExtraCode && ExtraCode[0]) {
 403     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 404
 405     switch (ExtraCode[0]) {
 406     default: return true;  // Unknown modifier.
 407     case 'b': // Print QImode register
 408     case 'h': // Print QImode high register
 409     case 'w': // Print HImode register
 410     case 'k': // Print SImode register
 411       return printAsmMRegister(MI->getOperand(OpNo), ExtraCode[0]);
 412     }
 413   }
 414
 415   printOperand(MI, OpNo);
 416   return false;
 417 }
 418
 419 bool X86IntelAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 420                                                unsigned OpNo,
 421                                                unsigned AsmVariant,
 422                                                const char *ExtraCode) {
 423   if (ExtraCode && ExtraCode[0])
 424     return true; // Unknown modifier.
 425   printMemReference(MI, OpNo);
 426   return false;
 427 }
 428
 429 /// printMachineInstruction -- Print out a single X86 LLVM instruction
 430 /// MI in Intel syntax to the current output stream.
 431 ///
 432 void X86IntelAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 433   ++EmittedInsts;
 434
 435   // Call the autogenerated instruction printer routines.
 436   printInstruction(MI);
 437 }
 438
 439 bool X86IntelAsmPrinter::doInitialization(Module &M) {
 440   bool Result = AsmPrinter::doInitialization(M);
 441
 442   Mang->markCharUnacceptable('.');
 443
 444   O << "\t.686\n\t.MMX\n\t.XMM\n\t.model flat\n\n";
 445
 446   // Emit declarations for external functions.
 447   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 448     if (I->isDeclaration()) {
 449       std::string Name = Mang->getValueName(I);
 450       decorateName(Name, I);
 451
 452       O << "\tEXTERN " ;
 453       if (I->hasDLLImportLinkage()) {
 454         O << "__imp_";
 455       }
 456       O << Name << ":near\n";
 457     }
 458
 459   // Emit declarations for external globals.  Note that VC++ always declares
 460   // external globals to have type byte, and if that's good enough for VC++...
 461   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 462        I != E; ++I) {
 463     if (I->isDeclaration()) {
 464       std::string Name = Mang->getValueName(I);
 465
 466       O << "\tEXTERN " ;
 467       if (I->hasDLLImportLinkage()) {
 468         O << "__imp_";
 469       }
 470       O << Name << ":byte\n";
 471     }
 472   }
 473
 474   return Result;
 475 }
 476
 477 bool X86IntelAsmPrinter::doFinalization(Module &M) {
 478   const TargetData *TD = TM.getTargetData();
 479
 480   // Print out module-level global variables here.
 481   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 482        I != E; ++I) {
 483     if (I->isDeclaration()) continue;   // External global require no code
 484
 485     // Check to see if this is a special global used by LLVM, if so, emit it.
 486     if (EmitSpecialLLVMGlobal(I))
 487       continue;
 488
 489     std::string name = Mang->getValueName(I);
 490     Constant *C = I->getInitializer();
 491     unsigned Align = TD->getPreferredAlignmentLog(I);
 492     bool bCustomSegment = false;
 493
 494     switch (I->getLinkage()) {
 495     case GlobalValue::CommonLinkage:
 496     case GlobalValue::LinkOnceAnyLinkage:
 497     case GlobalValue::LinkOnceODRLinkage:
 498     case GlobalValue::WeakAnyLinkage:
 499     case GlobalValue::WeakODRLinkage:
 500       SwitchToDataSection("");
 501       O << name << "?\tSEGEMNT PARA common 'COMMON'\n";
 502       bCustomSegment = true;
 503       // FIXME: the default alignment is 16 bytes, but 1, 2, 4, and 256
 504       // are also available.
 505       break;
 506     case GlobalValue::AppendingLinkage:
 507       SwitchToDataSection("");
 508       O << name << "?\tSEGMENT PARA public 'DATA'\n";
 509       bCustomSegment = true;
 510       // FIXME: the default alignment is 16 bytes, but 1, 2, 4, and 256
 511       // are also available.
 512       break;
 513     case GlobalValue::DLLExportLinkage:
 514       DLLExportedGVs.insert(name);
 515       // FALL THROUGH
 516     case GlobalValue::ExternalLinkage:
 517       O << "\tpublic " << name << "\n";
 518       // FALL THROUGH
 519     case GlobalValue::InternalLinkage:
 520       SwitchToSection(TAI->getDataSection());
 521       break;
 522     default:
 523       LLVM_UNREACHABLE( "Unknown linkage type!");
 524     }
 525
 526     if (!bCustomSegment)
 527       EmitAlignment(Align, I);
 528
 529     O << name << ":";
 530     if (VerboseAsm)
 531       O << "\t\t\t\t" << TAI->getCommentString()
 532         << " " << I->getName();
 533     O << '\n';
 534
 535     EmitGlobalConstant(C);
 536
 537     if (bCustomSegment)
 538       O << name << "?\tends\n";
 539   }
 540
 541     // Output linker support code for dllexported globals
 542   if (!DLLExportedGVs.empty() || !DLLExportedFns.empty()) {
 543     SwitchToDataSection("");
 544     O << "; WARNING: The following code is valid only with MASM v8.x"
 545       << "and (possible) higher\n"
 546       << "; This version of MASM is usually shipped with Microsoft "
 547       << "Visual Studio 2005\n"
 548       << "; or (possible) further versions. Unfortunately, there is no "
 549       << "way to support\n"
 550       << "; dllexported symbols in the earlier versions of MASM in fully "
 551       << "automatic way\n\n";
 552     O << "_drectve\t segment info alias('.drectve')\n";
 553   }
 554
 555   for (StringSet<>::iterator i = DLLExportedGVs.begin(),
 556          e = DLLExportedGVs.end();
 557          i != e; ++i)
 558     O << "\t db ' /EXPORT:" << i->getKeyData() << ",data'\n";
 559
 560   for (StringSet<>::iterator i = DLLExportedFns.begin(),
 561          e = DLLExportedFns.end();
 562          i != e; ++i)
 563     O << "\t db ' /EXPORT:" << i->getKeyData() << "'\n";
 564
 565   if (!DLLExportedGVs.empty() || !DLLExportedFns.empty())
 566     O << "_drectve\t ends\n";
 567
 568   // Bypass X86SharedAsmPrinter::doFinalization().
 569   bool Result = AsmPrinter::doFinalization(M);
 570   SwitchToDataSection("");
 571   O << "\tend\n";
 572   return Result;
 573 }
 574
 575 void X86IntelAsmPrinter::EmitString(const ConstantArray *CVA) const {
 576   unsigned NumElts = CVA->getNumOperands();
 577   if (NumElts) {
 578     // ML does not have escape sequences except '' for '.  It also has a maximum
 579     // string length of 255.
 580     unsigned len = 0;
 581     bool inString = false;
 582     for (unsigned i = 0; i < NumElts; i++) {
 583       int n = cast<ConstantInt>(CVA->getOperand(i))->getZExtValue() & 255;
 584       if (len == 0)
 585         O << "\tdb ";
 586
 587       if (n >= 32 && n <= 127) {
 588         if (!inString) {
 589           if (len > 0) {
 590             O << ",'";
 591             len += 2;
 592           } else {
 593             O << "'";
 594             len++;
 595           }
 596           inString = true;
 597         }
 598         if (n == '\'') {
 599           O << "'";
 600           len++;
 601         }
 602         O << char(n);
 603       } else {
 604         if (inString) {
 605           O << "'";
 606           len++;
 607           inString = false;
 608         }
 609         if (len > 0) {
 610           O << ",";
 611           len++;
 612         }
 613         O << n;
 614         len += 1 + (n > 9) + (n > 99);
 615       }
 616
 617       if (len > 60) {
 618         if (inString) {
 619           O << "'";
 620           inString = false;
 621         }
 622         O << "\n";
 623         len = 0;
 624       }
 625     }
 626
 627     if (len > 0) {
 628       if (inString)
 629         O << "'";
 630       O << "\n";
 631     }
 632   }
 633 }
 634
 635 // Include the auto-generated portion of the assembly writer.
 636 #include "X86GenAsmWriter1.inc"