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