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   unsigned FnAlign = OptimizeForSize ? 1 : 4;
  61   switch (F->getLinkage()) {
  62   default: assert(0 && "Unsupported linkage type!");
  63   case Function::InternalLinkage:
  64     EmitAlignment(FnAlign);
  65     break;
  66   case Function::DLLExportLinkage:
  67     DLLExportedFns.insert(CurrentFnName);
  68     //FALLS THROUGH
  69   case Function::ExternalLinkage:
  70     O << "\tpublic " << CurrentFnName << "\n";
  71     EmitAlignment(FnAlign);
  72     break;
  73   }
  74
  75   O << CurrentFnName << "\tproc near\n";
  76
  77   // Print out code for the function.
  78   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
  79        I != E; ++I) {
  80     // Print a label for the basic block if there are any predecessors.
  81     if (!I->pred_empty()) {
  82       printBasicBlockLabel(I, true, true);
  83       O << '\n';
  84     }
  85     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
  86          II != E; ++II) {
  87       // Print the assembly for the instruction.
  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).getImm();
 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   switch (MO.getType()) {
 119   case MachineOperand::MO_Register: {
 120     if (TargetRegisterInfo::isPhysicalRegister(MO.getReg())) {
 121       unsigned Reg = MO.getReg();
 122       if (Modifier && strncmp(Modifier, "subreg", strlen("subreg")) == 0) {
 123         MVT::ValueType VT = (strcmp(Modifier,"subreg64") == 0) ?
 124           MVT::i64 : ((strcmp(Modifier, "subreg32") == 0) ? MVT::i32 :
 125                       ((strcmp(Modifier,"subreg16") == 0) ? MVT::i16 :MVT::i8));
 126         Reg = getX86SubSuperRegister(Reg, VT);
 127       }
 128       O << TRI->getAsmName(Reg);
 129     } else
 130       O << "reg" << MO.getReg();
 131     return;
 132   }
 133   case MachineOperand::MO_Immediate:
 134     O << MO.getImm();
 135     return;
 136   case MachineOperand::MO_MachineBasicBlock:
 137     printBasicBlockLabel(MO.getMBB());
 138     return;
 139   case MachineOperand::MO_JumpTableIndex: {
 140     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
 141     if (!isMemOp) O << "OFFSET ";
 142     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 143       << "_" << MO.getIndex();
 144     return;
 145   }
 146   case MachineOperand::MO_ConstantPoolIndex: {
 147     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
 148     if (!isMemOp) O << "OFFSET ";
 149     O << "[" << TAI->getPrivateGlobalPrefix() << "CPI"
 150       << getFunctionNumber() << "_" << MO.getIndex();
 151     int Offset = MO.getOffset();
 152     if (Offset > 0)
 153       O << " + " << Offset;
 154     else if (Offset < 0)
 155       O << Offset;
 156     O << "]";
 157     return;
 158   }
 159   case MachineOperand::MO_GlobalAddress: {
 160     bool isCallOp = Modifier && !strcmp(Modifier, "call");
 161     bool isMemOp  = Modifier && !strcmp(Modifier, "mem");
 162     GlobalValue *GV = MO.getGlobal();
 163     std::string Name = Mang->getValueName(GV);
 164
 165     X86SharedAsmPrinter::decorateName(Name, GV);
 166
 167     if (!isMemOp && !isCallOp) O << "OFFSET ";
 168     if (GV->hasDLLImportLinkage()) {
 169       // FIXME: This should be fixed with full support of stdcall & fastcall
 170       // CC's
 171       O << "__imp_";
 172     }
 173     O << Name;
 174     int Offset = MO.getOffset();
 175     if (Offset > 0)
 176       O << " + " << Offset;
 177     else if (Offset < 0)
 178       O << Offset;
 179     return;
 180   }
 181   case MachineOperand::MO_ExternalSymbol: {
 182     bool isCallOp = Modifier && !strcmp(Modifier, "call");
 183     if (!isCallOp) O << "OFFSET ";
 184     O << TAI->getGlobalPrefix() << MO.getSymbolName();
 185     return;
 186   }
 187   default:
 188     O << "<unknown operand type>"; return;
 189   }
 190 }
 191
 192 void X86IntelAsmPrinter::printMemReference(const MachineInstr *MI, unsigned Op,
 193                                            const char *Modifier) {
 194   assert(isMem(MI, Op) && "Invalid memory reference!");
 195
 196   const MachineOperand &BaseReg  = MI->getOperand(Op);
 197   int ScaleVal                   = MI->getOperand(Op+1).getImm();
 198   const MachineOperand &IndexReg = MI->getOperand(Op+2);
 199   const MachineOperand &DispSpec = MI->getOperand(Op+3);
 200
 201   O << "[";
 202   bool NeedPlus = false;
 203   if (BaseReg.getReg()) {
 204     printOp(BaseReg, Modifier);
 205     NeedPlus = true;
 206   }
 207
 208   if (IndexReg.getReg()) {
 209     if (NeedPlus) O << " + ";
 210     if (ScaleVal != 1)
 211       O << ScaleVal << "*";
 212     printOp(IndexReg, Modifier);
 213     NeedPlus = true;
 214   }
 215
 216   if (DispSpec.isGlobalAddress() || DispSpec.isConstantPoolIndex() ||
 217       DispSpec.isJumpTableIndex()) {
 218     if (NeedPlus)
 219       O << " + ";
 220     printOp(DispSpec, "mem");
 221   } else {
 222     int DispVal = DispSpec.getImm();
 223     if (DispVal || (!BaseReg.getReg() && !IndexReg.getReg())) {
 224       if (NeedPlus) {
 225         if (DispVal > 0)
 226           O << " + ";
 227         else {
 228           O << " - ";
 229           DispVal = -DispVal;
 230         }
 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, 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   unsigned Reg = MO.getReg();
 257   switch (Mode) {
 258   default: return true;  // Unknown mode.
 259   case 'b': // Print QImode register
 260     Reg = getX86SubSuperRegister(Reg, MVT::i8);
 261     break;
 262   case 'h': // Print QImode high register
 263     Reg = getX86SubSuperRegister(Reg, MVT::i8, true);
 264     break;
 265   case 'w': // Print HImode register
 266     Reg = getX86SubSuperRegister(Reg, MVT::i16);
 267     break;
 268   case 'k': // Print SImode register
 269     Reg = getX86SubSuperRegister(Reg, MVT::i32);
 270     break;
 271   }
 272
 273   O << '%' << TRI->getAsmName(Reg);
 274   return false;
 275 }
 276
 277 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 278 ///
 279 bool X86IntelAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 280                                          unsigned AsmVariant,
 281                                          const char *ExtraCode) {
 282   // Does this asm operand have a single letter operand modifier?
 283   if (ExtraCode && ExtraCode[0]) {
 284     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 285
 286     switch (ExtraCode[0]) {
 287     default: return true;  // Unknown modifier.
 288     case 'b': // Print QImode register
 289     case 'h': // Print QImode high register
 290     case 'w': // Print HImode register
 291     case 'k': // Print SImode register
 292       return printAsmMRegister(MI->getOperand(OpNo), ExtraCode[0]);
 293     }
 294   }
 295
 296   printOperand(MI, OpNo);
 297   return false;
 298 }
 299
 300 bool X86IntelAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 301                                                unsigned OpNo,
 302                                                unsigned AsmVariant,
 303                                                const char *ExtraCode) {
 304   if (ExtraCode && ExtraCode[0])
 305     return true; // Unknown modifier.
 306   printMemReference(MI, OpNo);
 307   return false;
 308 }
 309
 310 /// printMachineInstruction -- Print out a single X86 LLVM instruction
 311 /// MI in Intel syntax to the current output stream.
 312 ///
 313 void X86IntelAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 314   ++EmittedInsts;
 315
 316   // Call the autogenerated instruction printer routines.
 317   printInstruction(MI);
 318 }
 319
 320 bool X86IntelAsmPrinter::doInitialization(Module &M) {
 321   bool Result = X86SharedAsmPrinter::doInitialization(M);
 322
 323   Mang->markCharUnacceptable('.');
 324
 325   O << "\t.686\n\t.model flat\n\n";
 326
 327   // Emit declarations for external functions.
 328   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 329     if (I->isDeclaration()) {
 330       std::string Name = Mang->getValueName(I);
 331       X86SharedAsmPrinter::decorateName(Name, I);
 332
 333       O << "\textern " ;
 334       if (I->hasDLLImportLinkage()) {
 335         O << "__imp_";
 336       }
 337       O << Name << ":near\n";
 338     }
 339
 340   // Emit declarations for external globals.  Note that VC++ always declares
 341   // external globals to have type byte, and if that's good enough for VC++...
 342   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 343        I != E; ++I) {
 344     if (I->isDeclaration()) {
 345       std::string Name = Mang->getValueName(I);
 346
 347       O << "\textern " ;
 348       if (I->hasDLLImportLinkage()) {
 349         O << "__imp_";
 350       }
 351       O << Name << ":byte\n";
 352     }
 353   }
 354
 355   return Result;
 356 }
 357
 358 bool X86IntelAsmPrinter::doFinalization(Module &M) {
 359   const TargetData *TD = TM.getTargetData();
 360
 361   // Print out module-level global variables here.
 362   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 363        I != E; ++I) {
 364     if (I->isDeclaration()) continue;   // External global require no code
 365
 366     // Check to see if this is a special global used by LLVM, if so, emit it.
 367     if (EmitSpecialLLVMGlobal(I))
 368       continue;
 369
 370     std::string name = Mang->getValueName(I);
 371     Constant *C = I->getInitializer();
 372     unsigned Align = TD->getPreferredAlignmentLog(I);
 373     bool bCustomSegment = false;
 374
 375     switch (I->getLinkage()) {
 376     case GlobalValue::LinkOnceLinkage:
 377     case GlobalValue::WeakLinkage:
 378       SwitchToDataSection("");
 379       O << name << "?\tsegment common 'COMMON'\n";
 380       bCustomSegment = true;
 381       // FIXME: the default alignment is 16 bytes, but 1, 2, 4, and 256
 382       // are also available.
 383       break;
 384     case GlobalValue::AppendingLinkage:
 385       SwitchToDataSection("");
 386       O << name << "?\tsegment public 'DATA'\n";
 387       bCustomSegment = true;
 388       // FIXME: the default alignment is 16 bytes, but 1, 2, 4, and 256
 389       // are also available.
 390       break;
 391     case GlobalValue::DLLExportLinkage:
 392       DLLExportedGVs.insert(name);
 393       // FALL THROUGH
 394     case GlobalValue::ExternalLinkage:
 395       O << "\tpublic " << name << "\n";
 396       // FALL THROUGH
 397     case GlobalValue::InternalLinkage:
 398       SwitchToDataSection(TAI->getDataSection(), I);
 399       break;
 400     default:
 401       assert(0 && "Unknown linkage type!");
 402     }
 403
 404     if (!bCustomSegment)
 405       EmitAlignment(Align, I);
 406
 407     O << name << ":\t\t\t\t" << TAI->getCommentString()
 408       << " " << I->getName() << '\n';
 409
 410     EmitGlobalConstant(C);
 411
 412     if (bCustomSegment)
 413       O << name << "?\tends\n";
 414   }
 415
 416     // Output linker support code for dllexported globals
 417   if (!DLLExportedGVs.empty() ||
 418       !DLLExportedFns.empty()) {
 419     SwitchToDataSection("");
 420     O << "; WARNING: The following code is valid only with MASM v8.x and (possible) higher\n"
 421       << "; This version of MASM is usually shipped with Microsoft Visual Studio 2005\n"
 422       << "; or (possible) further versions. Unfortunately, there is no way to support\n"
 423       << "; dllexported symbols in the earlier versions of MASM in fully automatic way\n\n";
 424     O << "_drectve\t segment info alias('.drectve')\n";
 425   }
 426
 427   for (std::set<std::string>::iterator i = DLLExportedGVs.begin(),
 428          e = DLLExportedGVs.end();
 429          i != e; ++i) {
 430     O << "\t db ' /EXPORT:" << *i << ",data'\n";
 431   }
 432
 433   for (std::set<std::string>::iterator i = DLLExportedFns.begin(),
 434          e = DLLExportedFns.end();
 435          i != e; ++i) {
 436     O << "\t db ' /EXPORT:" << *i << "'\n";
 437   }
 438
 439   if (!DLLExportedGVs.empty() ||
 440       !DLLExportedFns.empty()) {
 441     O << "_drectve\t ends\n";
 442   }
 443
 444   // Bypass X86SharedAsmPrinter::doFinalization().
 445   bool Result = AsmPrinter::doFinalization(M);
 446   SwitchToDataSection("");
 447   O << "\tend\n";
 448   return Result;
 449 }
 450
 451 void X86IntelAsmPrinter::EmitString(const ConstantArray *CVA) const {
 452   unsigned NumElts = CVA->getNumOperands();
 453   if (NumElts) {
 454     // ML does not have escape sequences except '' for '.  It also has a maximum
 455     // string length of 255.
 456     unsigned len = 0;
 457     bool inString = false;
 458     for (unsigned i = 0; i < NumElts; i++) {
 459       int n = cast<ConstantInt>(CVA->getOperand(i))->getZExtValue() & 255;
 460       if (len == 0)
 461         O << "\tdb ";
 462
 463       if (n >= 32 && n <= 127) {
 464         if (!inString) {
 465           if (len > 0) {
 466             O << ",'";
 467             len += 2;
 468           } else {
 469             O << "'";
 470             len++;
 471           }
 472           inString = true;
 473         }
 474         if (n == '\'') {
 475           O << "'";
 476           len++;
 477         }
 478         O << char(n);
 479       } else {
 480         if (inString) {
 481           O << "'";
 482           len++;
 483           inString = false;
 484         }
 485         if (len > 0) {
 486           O << ",";
 487           len++;
 488         }
 489         O << n;
 490         len += 1 + (n > 9) + (n > 99);
 491       }
 492
 493       if (len > 60) {
 494         if (inString) {
 495           O << "'";
 496           inString = false;
 497         }
 498         O << "\n";
 499         len = 0;
 500       }
 501     }
 502
 503     if (len > 0) {
 504       if (inString)
 505         O << "'";
 506       O << "\n";
 507     }
 508   }
 509 }
 510
 511 // Include the auto-generated portion of the assembly writer.
 512 #include "X86GenAsmWriter1.inc"