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