lib/Target/X86/Printer.cpp

   1 //===-- X86/Printer.cpp - Convert X86 LLVM code to Intel assembly ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a printer that converts from our internal
  11 // representation of machine-dependent LLVM code to Intel-format
  12 // assembly language. This printer is the output mechanism used
  13 // by `llc' and `lli -print-machineinstrs' on X86.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "X86.h"
  18 #include "X86InstrInfo.h"
  19 #include "llvm/Constants.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/Module.h"
  22 #include "llvm/Assembly/Writer.h"
  23 #include "llvm/CodeGen/MachineFunctionPass.h"
  24 #include "llvm/CodeGen/MachineConstantPool.h"
  25 #include "llvm/CodeGen/MachineInstr.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Support/Mangler.h"
  28 #include "Support/Statistic.h"
  29 #include "Support/StringExtras.h"
  30 #include "Support/CommandLine.h"
  31 using namespace llvm;
  32
  33 namespace {
  34   Statistic<> EmittedInsts("asm-printer", "Number of machine instrs printed");
  35
  36   // FIXME: This should be automatically picked up by autoconf from the C
  37   // frontend
  38   cl::opt<bool> EmitCygwin("enable-cygwin-compatible-output", cl::Hidden,
  39          cl::desc("Emit X86 assembly code suitable for consumption by cygwin"));
  40
  41   struct Printer : public MachineFunctionPass {
  42     /// Output stream on which we're printing assembly code.
  43     ///
  44     std::ostream &O;
  45
  46     /// Target machine description which we query for reg. names, data
  47     /// layout, etc.
  48     ///
  49     TargetMachine &TM;
  50
  51     /// Name-mangler for global names.
  52     ///
  53     Mangler *Mang;
  54
  55     Printer(std::ostream &o, TargetMachine &tm) : O(o), TM(tm) { }
  56
  57     /// We name each basic block in a Function with a unique number, so
  58     /// that we can consistently refer to them later. This is cleared
  59     /// at the beginning of each call to runOnMachineFunction().
  60     ///
  61     typedef std::map<const Value *, unsigned> ValueMapTy;
  62     ValueMapTy NumberForBB;
  63
  64     /// Cache of mangled name for current function. This is
  65     /// recalculated at the beginning of each call to
  66     /// runOnMachineFunction().
  67     ///
  68     std::string CurrentFnName;
  69
  70     virtual const char *getPassName() const {
  71       return "X86 Assembly Printer";
  72     }
  73
  74     void checkImplUses (const TargetInstrDescriptor &Desc);
  75     void printMachineInstruction(const MachineInstr *MI);
  76     void printOp(const MachineOperand &MO,
  77                  bool elideOffsetKeyword = false);
  78     void printMemReference(const MachineInstr *MI, unsigned Op);
  79     void printConstantPool(MachineConstantPool *MCP);
  80     bool runOnMachineFunction(MachineFunction &F);
  81     bool doInitialization(Module &M);
  82     bool doFinalization(Module &M);
  83     void emitGlobalConstant(const Constant* CV);
  84     void emitConstantValueOnly(const Constant *CV);
  85   };
  86 } // end of anonymous namespace
  87
  88 /// createX86CodePrinterPass - Returns a pass that prints the X86
  89 /// assembly code for a MachineFunction to the given output stream,
  90 /// using the given target machine description.  This should work
  91 /// regardless of whether the function is in SSA form.
  92 ///
  93 FunctionPass *llvm::createX86CodePrinterPass(std::ostream &o,TargetMachine &tm){
  94   return new Printer(o, tm);
  95 }
  96
  97 /// toOctal - Convert the low order bits of X into an octal digit.
  98 ///
  99 static inline char toOctal(int X) {
 100   return (X&7)+'0';
 101 }
 102
 103 /// getAsCString - Return the specified array as a C compatible
 104 /// string, only if the predicate isStringCompatible is true.
 105 ///
 106 static void printAsCString(std::ostream &O, const ConstantArray *CVA) {
 107   assert(CVA->isString() && "Array is not string compatible!");
 108
 109   O << "\"";
 110   for (unsigned i = 0; i != CVA->getNumOperands(); ++i) {
 111     unsigned char C = cast<ConstantInt>(CVA->getOperand(i))->getRawValue();
 112
 113     if (C == '"') {
 114       O << "\\\"";
 115     } else if (C == '\\') {
 116       O << "\\\\";
 117     } else if (isprint(C)) {
 118       O << C;
 119     } else {
 120       switch(C) {
 121       case '\b': O << "\\b"; break;
 122       case '\f': O << "\\f"; break;
 123       case '\n': O << "\\n"; break;
 124       case '\r': O << "\\r"; break;
 125       case '\t': O << "\\t"; break;
 126       default:
 127         O << '\\';
 128         O << toOctal(C >> 6);
 129         O << toOctal(C >> 3);
 130         O << toOctal(C >> 0);
 131         break;
 132       }
 133     }
 134   }
 135   O << "\"";
 136 }
 137
 138 // Print out the specified constant, without a storage class.  Only the
 139 // constants valid in constant expressions can occur here.
 140 void Printer::emitConstantValueOnly(const Constant *CV) {
 141   if (CV->isNullValue())
 142     O << "0";
 143   else if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
 144     assert(CB == ConstantBool::True);
 145     O << "1";
 146   } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV))
 147     if (((CI->getValue() << 32) >> 32) == CI->getValue())
 148       O << CI->getValue();
 149     else
 150       O << (unsigned long long)CI->getValue();
 151   else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV))
 152     O << CI->getValue();
 153   else if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CV))
 154     // This is a constant address for a global variable or function.  Use the
 155     // name of the variable or function as the address value.
 156     O << Mang->getValueName(CPR->getValue());
 157   else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 158     const TargetData &TD = TM.getTargetData();
 159     switch(CE->getOpcode()) {
 160     case Instruction::GetElementPtr: {
 161       // generate a symbolic expression for the byte address
 162       const Constant *ptrVal = CE->getOperand(0);
 163       std::vector<Value*> idxVec(CE->op_begin()+1, CE->op_end());
 164       if (unsigned Offset = TD.getIndexedOffset(ptrVal->getType(), idxVec)) {
 165         O << "(";
 166         emitConstantValueOnly(ptrVal);
 167         O << ") + " << Offset;
 168       } else {
 169         emitConstantValueOnly(ptrVal);
 170       }
 171       break;
 172     }
 173     case Instruction::Cast: {
 174       // Support only non-converting or widening casts for now, that is, ones
 175       // that do not involve a change in value.  This assertion is really gross,
 176       // and may not even be a complete check.
 177       Constant *Op = CE->getOperand(0);
 178       const Type *OpTy = Op->getType(), *Ty = CE->getType();
 179
 180       // Remember, kids, pointers on x86 can be losslessly converted back and
 181       // forth into 32-bit or wider integers, regardless of signedness. :-P
 182       assert(((isa<PointerType>(OpTy)
 183                && (Ty == Type::LongTy || Ty == Type::ULongTy
 184                    || Ty == Type::IntTy || Ty == Type::UIntTy))
 185               || (isa<PointerType>(Ty)
 186                   && (OpTy == Type::LongTy || OpTy == Type::ULongTy
 187                       || OpTy == Type::IntTy || OpTy == Type::UIntTy))
 188               || (((TD.getTypeSize(Ty) >= TD.getTypeSize(OpTy))
 189                    && OpTy->isLosslesslyConvertibleTo(Ty))))
 190              && "FIXME: Don't yet support this kind of constant cast expr");
 191       O << "(";
 192       emitConstantValueOnly(Op);
 193       O << ")";
 194       break;
 195     }
 196     case Instruction::Add:
 197       O << "(";
 198       emitConstantValueOnly(CE->getOperand(0));
 199       O << ") + (";
 200       emitConstantValueOnly(CE->getOperand(1));
 201       O << ")";
 202       break;
 203     default:
 204       assert(0 && "Unsupported operator!");
 205     }
 206   } else {
 207     assert(0 && "Unknown constant value!");
 208   }
 209 }
 210
 211 // Print a constant value or values, with the appropriate storage class as a
 212 // prefix.
 213 void Printer::emitGlobalConstant(const Constant *CV) {
 214   const TargetData &TD = TM.getTargetData();
 215
 216   if (CV->isNullValue()) {
 217     O << "\t.zero\t " << TD.getTypeSize(CV->getType()) << "\n";
 218     return;
 219   } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
 220     if (CVA->isString()) {
 221       O << "\t.ascii\t";
 222       printAsCString(O, CVA);
 223       O << "\n";
 224     } else { // Not a string.  Print the values in successive locations
 225       const std::vector<Use> &constValues = CVA->getValues();
 226       for (unsigned i=0; i < constValues.size(); i++)
 227         emitGlobalConstant(cast<Constant>(constValues[i].get()));
 228     }
 229     return;
 230   } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
 231     // Print the fields in successive locations. Pad to align if needed!
 232     const StructLayout *cvsLayout = TD.getStructLayout(CVS->getType());
 233     const std::vector<Use>& constValues = CVS->getValues();
 234     unsigned sizeSoFar = 0;
 235     for (unsigned i=0, N = constValues.size(); i < N; i++) {
 236       const Constant* field = cast<Constant>(constValues[i].get());
 237
 238       // Check if padding is needed and insert one or more 0s.
 239       unsigned fieldSize = TD.getTypeSize(field->getType());
 240       unsigned padSize = ((i == N-1? cvsLayout->StructSize
 241                            : cvsLayout->MemberOffsets[i+1])
 242                           - cvsLayout->MemberOffsets[i]) - fieldSize;
 243       sizeSoFar += fieldSize + padSize;
 244
 245       // Now print the actual field value
 246       emitGlobalConstant(field);
 247
 248       // Insert the field padding unless it's zero bytes...
 249       if (padSize)
 250         O << "\t.zero\t " << padSize << "\n";
 251     }
 252     assert(sizeSoFar == cvsLayout->StructSize &&
 253            "Layout of constant struct may be incorrect!");
 254     return;
 255   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 256     // FP Constants are printed as integer constants to avoid losing
 257     // precision...
 258     double Val = CFP->getValue();
 259     switch (CFP->getType()->getPrimitiveID()) {
 260     default: assert(0 && "Unknown floating point type!");
 261     case Type::FloatTyID: {
 262       union FU {                            // Abide by C TBAA rules
 263         float FVal;
 264         unsigned UVal;
 265       } U;
 266       U.FVal = Val;
 267       O << ".long\t" << U.UVal << "\t# float " << Val << "\n";
 268       return;
 269     }
 270     case Type::DoubleTyID: {
 271       union DU {                            // Abide by C TBAA rules
 272         double FVal;
 273         uint64_t UVal;
 274       } U;
 275       U.FVal = Val;
 276       O << ".quad\t" << U.UVal << "\t# double " << Val << "\n";
 277       return;
 278     }
 279     }
 280   }
 281
 282   const Type *type = CV->getType();
 283   O << "\t";
 284   switch (type->getPrimitiveID()) {
 285   case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
 286     O << ".byte";
 287     break;
 288   case Type::UShortTyID: case Type::ShortTyID:
 289     O << ".word";
 290     break;
 291   case Type::FloatTyID: case Type::PointerTyID:
 292   case Type::UIntTyID: case Type::IntTyID:
 293     O << ".long";
 294     break;
 295   case Type::DoubleTyID:
 296   case Type::ULongTyID: case Type::LongTyID:
 297     O << ".quad";
 298     break;
 299   default:
 300     assert (0 && "Can't handle printing this type of thing");
 301     break;
 302   }
 303   O << "\t";
 304   emitConstantValueOnly(CV);
 305   O << "\n";
 306 }
 307
 308 /// printConstantPool - Print to the current output stream assembly
 309 /// representations of the constants in the constant pool MCP. This is
 310 /// used to print out constants which have been "spilled to memory" by
 311 /// the code generator.
 312 ///
 313 void Printer::printConstantPool(MachineConstantPool *MCP) {
 314   const std::vector<Constant*> &CP = MCP->getConstants();
 315   const TargetData &TD = TM.getTargetData();
 316
 317   if (CP.empty()) return;
 318
 319   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
 320     O << "\t.section .rodata\n";
 321     O << "\t.align " << (unsigned)TD.getTypeAlignment(CP[i]->getType())
 322       << "\n";
 323     O << ".CPI" << CurrentFnName << "_" << i << ":\t\t\t\t\t#"
 324       << *CP[i] << "\n";
 325     emitGlobalConstant(CP[i]);
 326   }
 327 }
 328
 329 /// runOnMachineFunction - This uses the printMachineInstruction()
 330 /// method to print assembly for each instruction.
 331 ///
 332 bool Printer::runOnMachineFunction(MachineFunction &MF) {
 333   // BBNumber is used here so that a given Printer will never give two
 334   // BBs the same name. (If you have a better way, please let me know!)
 335   static unsigned BBNumber = 0;
 336
 337   O << "\n\n";
 338   // What's my mangled name?
 339   CurrentFnName = Mang->getValueName(MF.getFunction());
 340
 341   // Print out constants referenced by the function
 342   printConstantPool(MF.getConstantPool());
 343
 344   // Print out labels for the function.
 345   O << "\t.text\n";
 346   O << "\t.align 16\n";
 347   O << "\t.globl\t" << CurrentFnName << "\n";
 348   if (!EmitCygwin)
 349     O << "\t.type\t" << CurrentFnName << ", @function\n";
 350   O << CurrentFnName << ":\n";
 351
 352   // Number each basic block so that we can consistently refer to them
 353   // in PC-relative references.
 354   NumberForBB.clear();
 355   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 356        I != E; ++I) {
 357     NumberForBB[I->getBasicBlock()] = BBNumber++;
 358   }
 359
 360   // Print out code for the function.
 361   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 362        I != E; ++I) {
 363     // Print a label for the basic block.
 364     O << ".LBB" << NumberForBB[I->getBasicBlock()] << ":\t# "
 365       << I->getBasicBlock()->getName() << "\n";
 366     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 367          II != E; ++II) {
 368       // Print the assembly for the instruction.
 369       O << "\t";
 370       printMachineInstruction(II);
 371     }
 372   }
 373
 374   // We didn't modify anything.
 375   return false;
 376 }
 377
 378 static bool isScale(const MachineOperand &MO) {
 379   return MO.isImmediate() &&
 380     (MO.getImmedValue() == 1 || MO.getImmedValue() == 2 ||
 381      MO.getImmedValue() == 4 || MO.getImmedValue() == 8);
 382 }
 383
 384 static bool isMem(const MachineInstr *MI, unsigned Op) {
 385   if (MI->getOperand(Op).isFrameIndex()) return true;
 386   if (MI->getOperand(Op).isConstantPoolIndex()) return true;
 387   return Op+4 <= MI->getNumOperands() &&
 388     MI->getOperand(Op  ).isRegister() &&isScale(MI->getOperand(Op+1)) &&
 389     MI->getOperand(Op+2).isRegister() &&MI->getOperand(Op+3).isImmediate();
 390 }
 391
 392
 393
 394 void Printer::printOp(const MachineOperand &MO,
 395                       bool elideOffsetKeyword /* = false */) {
 396   const MRegisterInfo &RI = *TM.getRegisterInfo();
 397   switch (MO.getType()) {
 398   case MachineOperand::MO_VirtualRegister:
 399     if (Value *V = MO.getVRegValueOrNull()) {
 400       O << "<" << V->getName() << ">";
 401       return;
 402     }
 403     // FALLTHROUGH
 404   case MachineOperand::MO_MachineRegister:
 405     if (MRegisterInfo::isPhysicalRegister(MO.getReg()))
 406       // Bug Workaround: See note in Printer::doInitialization about %.
 407       O << "%" << RI.get(MO.getReg()).Name;
 408     else
 409       O << "%reg" << MO.getReg();
 410     return;
 411
 412   case MachineOperand::MO_SignExtendedImmed:
 413   case MachineOperand::MO_UnextendedImmed:
 414     O << (int)MO.getImmedValue();
 415     return;
 416   case MachineOperand::MO_PCRelativeDisp: {
 417     ValueMapTy::const_iterator i = NumberForBB.find(MO.getVRegValue());
 418     assert (i != NumberForBB.end()
 419             && "Could not find a BB in the NumberForBB map!");
 420     O << ".LBB" << i->second << " # PC rel: " << MO.getVRegValue()->getName();
 421     return;
 422   }
 423   case MachineOperand::MO_GlobalAddress:
 424     if (!elideOffsetKeyword)
 425       O << "OFFSET ";
 426     O << Mang->getValueName(MO.getGlobal());
 427     return;
 428   case MachineOperand::MO_ExternalSymbol:
 429     O << MO.getSymbolName();
 430     return;
 431   default:
 432     O << "<unknown operand type>"; return;
 433   }
 434 }
 435
 436 static const std::string sizePtr(const TargetInstrDescriptor &Desc) {
 437   switch (Desc.TSFlags & X86II::ArgMask) {
 438   default: assert(0 && "Unknown arg size!");
 439   case X86II::Arg8:   return "BYTE PTR";
 440   case X86II::Arg16:  return "WORD PTR";
 441   case X86II::Arg32:  return "DWORD PTR";
 442   case X86II::Arg64:  return "QWORD PTR";
 443   case X86II::ArgF32:  return "DWORD PTR";
 444   case X86II::ArgF64:  return "QWORD PTR";
 445   case X86II::ArgF80:  return "XWORD PTR";
 446   }
 447 }
 448
 449 void Printer::printMemReference(const MachineInstr *MI, unsigned Op) {
 450   assert(isMem(MI, Op) && "Invalid memory reference!");
 451
 452   if (MI->getOperand(Op).isFrameIndex()) {
 453     O << "[frame slot #" << MI->getOperand(Op).getFrameIndex();
 454     if (MI->getOperand(Op+3).getImmedValue())
 455       O << " + " << MI->getOperand(Op+3).getImmedValue();
 456     O << "]";
 457     return;
 458   } else if (MI->getOperand(Op).isConstantPoolIndex()) {
 459     O << "[.CPI" << CurrentFnName << "_"
 460       << MI->getOperand(Op).getConstantPoolIndex();
 461     if (MI->getOperand(Op+3).getImmedValue())
 462       O << " + " << MI->getOperand(Op+3).getImmedValue();
 463     O << "]";
 464     return;
 465   }
 466
 467   const MachineOperand &BaseReg  = MI->getOperand(Op);
 468   int ScaleVal                   = MI->getOperand(Op+1).getImmedValue();
 469   const MachineOperand &IndexReg = MI->getOperand(Op+2);
 470   int DispVal                    = MI->getOperand(Op+3).getImmedValue();
 471
 472   O << "[";
 473   bool NeedPlus = false;
 474   if (BaseReg.getReg()) {
 475     printOp(BaseReg);
 476     NeedPlus = true;
 477   }
 478
 479   if (IndexReg.getReg()) {
 480     if (NeedPlus) O << " + ";
 481     if (ScaleVal != 1)
 482       O << ScaleVal << "*";
 483     printOp(IndexReg);
 484     NeedPlus = true;
 485   }
 486
 487   if (DispVal) {
 488     if (NeedPlus)
 489       if (DispVal > 0)
 490         O << " + ";
 491       else {
 492         O << " - ";
 493         DispVal = -DispVal;
 494       }
 495     O << DispVal;
 496   }
 497   O << "]";
 498 }
 499
 500 /// checkImplUses - Emit the implicit-use registers for the
 501 /// instruction described by DESC, if its PrintImplUses flag is set.
 502 ///
 503 void Printer::checkImplUses (const TargetInstrDescriptor &Desc) {
 504   const MRegisterInfo &RI = *TM.getRegisterInfo();
 505   if (Desc.TSFlags & X86II::PrintImplUses) {
 506     for (const unsigned *p = Desc.ImplicitUses; *p; ++p) {
 507       // Bug Workaround: See note in Printer::doInitialization about %.
 508       O << ", %" << RI.get(*p).Name;
 509     }
 510   }
 511 }
 512
 513 /// printMachineInstruction -- Print out a single X86 LLVM instruction
 514 /// MI in Intel syntax to the current output stream.
 515 ///
 516 void Printer::printMachineInstruction(const MachineInstr *MI) {
 517   unsigned Opcode = MI->getOpcode();
 518   const TargetInstrInfo &TII = TM.getInstrInfo();
 519   const TargetInstrDescriptor &Desc = TII.get(Opcode);
 520
 521   ++EmittedInsts;
 522   switch (Desc.TSFlags & X86II::FormMask) {
 523   case X86II::Pseudo:
 524     // Print pseudo-instructions as comments; either they should have been
 525     // turned into real instructions by now, or they don't need to be
 526     // seen by the assembler (e.g., IMPLICIT_USEs.)
 527     O << "# ";
 528     if (Opcode == X86::PHI) {
 529       printOp(MI->getOperand(0));
 530       O << " = phi ";
 531       for (unsigned i = 1, e = MI->getNumOperands(); i != e; i+=2) {
 532         if (i != 1) O << ", ";
 533         O << "[";
 534         printOp(MI->getOperand(i));
 535         O << ", ";
 536         printOp(MI->getOperand(i+1));
 537         O << "]";
 538       }
 539     } else {
 540       unsigned i = 0;
 541       if (MI->getNumOperands() && MI->getOperand(0).isDef()) {
 542         printOp(MI->getOperand(0));
 543         O << " = ";
 544         ++i;
 545       }
 546       O << TII.getName(MI->getOpcode());
 547
 548       for (unsigned e = MI->getNumOperands(); i != e; ++i) {
 549         O << " ";
 550         if (MI->getOperand(i).isDef()) O << "*";
 551         printOp(MI->getOperand(i));
 552         if (MI->getOperand(i).isDef()) O << "*";
 553       }
 554     }
 555     O << "\n";
 556     return;
 557
 558   case X86II::RawFrm:
 559     // The accepted forms of Raw instructions are:
 560     //   1. nop     - No operand required
 561     //   2. jmp foo - PC relative displacement operand
 562     //   3. call bar - GlobalAddress Operand or External Symbol Operand
 563     //
 564     assert(MI->getNumOperands() == 0 ||
 565            (MI->getNumOperands() == 1 &&
 566             (MI->getOperand(0).isPCRelativeDisp() ||
 567              MI->getOperand(0).isGlobalAddress() ||
 568              MI->getOperand(0).isExternalSymbol())) &&
 569            "Illegal raw instruction!");
 570     O << TII.getName(MI->getOpcode()) << " ";
 571
 572     if (MI->getNumOperands() == 1) {
 573       printOp(MI->getOperand(0), true); // Don't print "OFFSET"...
 574     }
 575     O << "\n";
 576     return;
 577
 578   case X86II::AddRegFrm: {
 579     // There are currently two forms of acceptable AddRegFrm instructions.
 580     // Either the instruction JUST takes a single register (like inc, dec, etc),
 581     // or it takes a register and an immediate of the same size as the register
 582     // (move immediate f.e.).  Note that this immediate value might be stored as
 583     // an LLVM value, to represent, for example, loading the address of a global
 584     // into a register.  The initial register might be duplicated if this is a
 585     // M_2_ADDR_REG instruction
 586     //
 587     assert(MI->getOperand(0).isRegister() &&
 588            (MI->getNumOperands() == 1 ||
 589             (MI->getNumOperands() == 2 &&
 590              (MI->getOperand(1).getVRegValueOrNull() ||
 591               MI->getOperand(1).isImmediate() ||
 592               MI->getOperand(1).isRegister() ||
 593               MI->getOperand(1).isGlobalAddress() ||
 594               MI->getOperand(1).isExternalSymbol()))) &&
 595            "Illegal form for AddRegFrm instruction!");
 596
 597     unsigned Reg = MI->getOperand(0).getReg();
 598
 599     O << TII.getName(MI->getOpcode()) << " ";
 600     printOp(MI->getOperand(0));
 601     if (MI->getNumOperands() == 2 &&
 602         (!MI->getOperand(1).isRegister() ||
 603          MI->getOperand(1).getVRegValueOrNull() ||
 604          MI->getOperand(1).isGlobalAddress() ||
 605          MI->getOperand(1).isExternalSymbol())) {
 606       O << ", ";
 607       printOp(MI->getOperand(1));
 608     }
 609     checkImplUses(Desc);
 610     O << "\n";
 611     return;
 612   }
 613   case X86II::MRMDestReg: {
 614     // There are three forms of MRMDestReg instructions, those with 2
 615     // or 3 operands:
 616     //
 617     // 2 Operands: this is for things like mov that do not read a
 618     // second input.
 619     //
 620     // 2 Operands: two address instructions which def&use the first
 621     // argument and use the second as input.
 622     //
 623     // 3 Operands: in this form, two address instructions are the same
 624     // as in 2 but have a constant argument as well.
 625     //
 626     bool isTwoAddr = TII.isTwoAddrInstr(Opcode);
 627     assert(MI->getOperand(0).isRegister() &&
 628            (MI->getNumOperands() == 2 ||
 629             (MI->getNumOperands() == 3 && MI->getOperand(2).isImmediate()))
 630            && "Bad format for MRMDestReg!");
 631
 632     O << TII.getName(MI->getOpcode()) << " ";
 633     printOp(MI->getOperand(0));
 634     O << ", ";
 635     printOp(MI->getOperand(1));
 636     if (MI->getNumOperands() == 3) {
 637       O << ", ";
 638       printOp(MI->getOperand(2));
 639     }
 640     O << "\n";
 641     return;
 642   }
 643
 644   case X86II::MRMDestMem: {
 645     // These instructions are the same as MRMDestReg, but instead of having a
 646     // register reference for the mod/rm field, it's a memory reference.
 647     //
 648     assert(isMem(MI, 0) &&
 649            (MI->getNumOperands() == 4+1 ||
 650             (MI->getNumOperands() == 4+2 && MI->getOperand(5).isImmediate()))
 651            && "Bad format for MRMDestMem!");
 652
 653     O << TII.getName(MI->getOpcode()) << " " << sizePtr(Desc) << " ";
 654     printMemReference(MI, 0);
 655     O << ", ";
 656     printOp(MI->getOperand(4));
 657     if (MI->getNumOperands() == 4+2) {
 658       O << ", ";
 659       printOp(MI->getOperand(5));
 660     }
 661     O << "\n";
 662     return;
 663   }
 664
 665   case X86II::MRMSrcReg: {
 666     // There are three forms that are acceptable for MRMSrcReg
 667     // instructions, those with 2 or 3 operands:
 668     //
 669     // 2 Operands: this is for things like mov that do not read a
 670     // second input.
 671     //
 672     // 2 Operands: in this form, the last register is the ModR/M
 673     // input.  The first operand is a def&use.  This is for things
 674     // like: add r32, r/m32
 675     //
 676     // 3 Operands: in this form, we can have 'INST R1, R2, imm', which is used
 677     // for instructions like the IMULrri instructions.
 678     //
 679     //
 680     assert(MI->getOperand(0).isRegister() &&
 681            MI->getOperand(1).isRegister() &&
 682            (MI->getNumOperands() == 2 ||
 683             (MI->getNumOperands() == 3 &&
 684              (MI->getOperand(2).isImmediate())))
 685            && "Bad format for MRMSrcReg!");
 686
 687     O << TII.getName(MI->getOpcode()) << " ";
 688     printOp(MI->getOperand(0));
 689     O << ", ";
 690     printOp(MI->getOperand(1));
 691     if (MI->getNumOperands() == 3) {
 692         O << ", ";
 693         printOp(MI->getOperand(2));
 694     }
 695     O << "\n";
 696     return;
 697   }
 698
 699   case X86II::MRMSrcMem: {
 700     // These instructions are the same as MRMSrcReg, but instead of having a
 701     // register reference for the mod/rm field, it's a memory reference.
 702     //
 703     assert(MI->getOperand(0).isRegister() &&
 704            (MI->getNumOperands() == 1+4 && isMem(MI, 1)) ||
 705 (MI->getNumOperands() == 2+4 && MI->getOperand(5).isImmediate() && isMem(MI, 1))
 706            && "Bad format for MRMSrcMem!");
 707     O << TII.getName(MI->getOpcode()) << " ";
 708     printOp(MI->getOperand(0));
 709     O << ", " << sizePtr(Desc) << " ";
 710     printMemReference(MI, 1);
 711     if (MI->getNumOperands() == 2+4) {
 712       O << ", ";
 713       printOp(MI->getOperand(5));
 714     }
 715     O << "\n";
 716     return;
 717   }
 718
 719   case X86II::MRM0r: case X86II::MRM1r:
 720   case X86II::MRM2r: case X86II::MRM3r:
 721   case X86II::MRM4r: case X86II::MRM5r:
 722   case X86II::MRM6r: case X86II::MRM7r: {
 723     // In this form, the following are valid formats:
 724     //  1. sete r
 725     //  2. cmp reg, immediate
 726     //  2. shl rdest, rinput  <implicit CL or 1>
 727     //  3. sbb rdest, rinput, immediate   [rdest = rinput]
 728     //
 729     assert(MI->getNumOperands() > 0 && MI->getNumOperands() < 4 &&
 730            MI->getOperand(0).isRegister() && "Bad MRMSxR format!");
 731     assert((MI->getNumOperands() != 2 ||
 732             MI->getOperand(1).isRegister() || MI->getOperand(1).isImmediate())&&
 733            "Bad MRMSxR format!");
 734     assert((MI->getNumOperands() < 3 ||
 735             (MI->getOperand(1).isRegister() && MI->getOperand(2).isImmediate())) &&
 736            "Bad MRMSxR format!");
 737
 738     if (MI->getNumOperands() > 1 && MI->getOperand(1).isRegister() &&
 739         MI->getOperand(0).getReg() != MI->getOperand(1).getReg())
 740       O << "**";
 741
 742     O << TII.getName(MI->getOpcode()) << " ";
 743     printOp(MI->getOperand(0));
 744     if (MI->getOperand(MI->getNumOperands()-1).isImmediate()) {
 745       O << ", ";
 746       printOp(MI->getOperand(MI->getNumOperands()-1));
 747     }
 748     checkImplUses(Desc);
 749     O << "\n";
 750
 751     return;
 752   }
 753
 754   case X86II::MRM0m: case X86II::MRM1m:
 755   case X86II::MRM2m: case X86II::MRM3m:
 756   case X86II::MRM4m: case X86II::MRM5m:
 757   case X86II::MRM6m: case X86II::MRM7m: {
 758     // In this form, the following are valid formats:
 759     //  1. sete [m]
 760     //  2. cmp [m], immediate
 761     //  2. shl [m], rinput  <implicit CL or 1>
 762     //  3. sbb [m], immediate
 763     //
 764     assert(MI->getNumOperands() >= 4 && MI->getNumOperands() <= 5 &&
 765            isMem(MI, 0) && "Bad MRMSxM format!");
 766     assert((MI->getNumOperands() != 5 ||
 767             (MI->getOperand(4).isImmediate() ||
 768              MI->getOperand(4).isGlobalAddress())) &&
 769            "Bad MRMSxM format!");
 770
 771     const MachineOperand &Op3 = MI->getOperand(3);
 772
 773     // Bug: The 80-bit FP store-pop instruction "fstp XWORD PTR [...]"
 774     // is misassembled by gas in intel_syntax mode as its 32-bit
 775     // equivalent "fstp DWORD PTR [...]". Workaround: Output the raw
 776     // opcode bytes instead of the instruction.
 777     if (MI->getOpcode() == X86::FSTPr80) {
 778       if ((MI->getOperand(0).getReg() == X86::ESP)
 779           && (MI->getOperand(1).getImmedValue() == 1)) {
 780         if (Op3.isImmediate() &&
 781             Op3.getImmedValue() >= -128 && Op3.getImmedValue() <= 127) {
 782           // 1 byte disp.
 783           O << ".byte 0xdb, 0x7c, 0x24, 0x" << std::hex
 784             << ((unsigned)Op3.getImmedValue() & 255) << std::dec << "\t# ";
 785         } else {
 786           O << ".byte 0xdb, 0xbc, 0x24\n\t";
 787           O << ".long ";
 788           printOp(Op3);
 789           O << "\t# ";
 790         }
 791       }
 792     }
 793
 794     // Bug: The 80-bit FP load instruction "fld XWORD PTR [...]" is
 795     // misassembled by gas in intel_syntax mode as its 32-bit
 796     // equivalent "fld DWORD PTR [...]". Workaround: Output the raw
 797     // opcode bytes instead of the instruction.
 798     if (MI->getOpcode() == X86::FLDr80 &&
 799         MI->getOperand(0).getReg() == X86::ESP &&
 800         MI->getOperand(1).getImmedValue() == 1) {
 801       if (Op3.isImmediate() && Op3.getImmedValue() >= -128 &&
 802           Op3.getImmedValue() <= 127) {   // 1 byte displacement
 803         O << ".byte 0xdb, 0x6c, 0x24, 0x" << std::hex
 804           << ((unsigned)Op3.getImmedValue() & 255) << std::dec << "\t# ";
 805       } else {
 806         O << ".byte 0xdb, 0xac, 0x24\n\t";
 807         O << ".long ";
 808         printOp(Op3);
 809         O << "\t# ";
 810       }
 811     }
 812
 813     // Bug: gas intel_syntax mode treats "fild QWORD PTR [...]" as an
 814     // invalid opcode, saying "64 bit operations are only supported in
 815     // 64 bit modes." libopcodes disassembles it as "fild DWORD PTR
 816     // [...]", which is wrong. Workaround: Output the raw opcode bytes
 817     // instead of the instruction.
 818     if (MI->getOpcode() == X86::FILDr64 &&
 819         MI->getOperand(0).getReg() == X86::ESP &&
 820         MI->getOperand(1).getImmedValue() == 1) {
 821       if (Op3.isImmediate() && Op3.getImmedValue() >= -128 &&
 822           Op3.getImmedValue() <= 127) {   // 1 byte displacement
 823         O << ".byte 0xdf, 0x6c, 0x24, 0x" << std::hex
 824           << ((unsigned)Op3.getImmedValue() & 255) << std::dec << "\t# ";
 825       } else {
 826         O << ".byte 0xdf, 0xac, 0x24\n\t";
 827         O << ".long ";
 828         printOp(Op3);
 829         O << std::dec << "\t# ";
 830       }
 831     }
 832
 833     // Bug: gas intel_syntax mode treats "fistp QWORD PTR [...]" as
 834     // an invalid opcode, saying "64 bit operations are only
 835     // supported in 64 bit modes." libopcodes disassembles it as
 836     // "fistpll DWORD PTR [...]", which is wrong. Workaround: Output
 837     // "fistpll DWORD PTR " instead, which is what libopcodes is
 838     // expecting to see.
 839     if (MI->getOpcode() == X86::FISTPr64) {
 840       O << "fistpll DWORD PTR ";
 841       printMemReference(MI, 0);
 842       if (MI->getNumOperands() == 5) {
 843         O << ", ";
 844         printOp(MI->getOperand(4));
 845       }
 846       O << "\t# ";
 847     }
 848
 849     O << TII.getName(MI->getOpcode()) << " ";
 850     O << sizePtr(Desc) << " ";
 851     printMemReference(MI, 0);
 852     if (MI->getNumOperands() == 5) {
 853       O << ", ";
 854       printOp(MI->getOperand(4));
 855     }
 856     O << "\n";
 857     return;
 858   }
 859
 860   default:
 861     O << "\tUNKNOWN FORM:\t\t-"; MI->print(O, TM); break;
 862   }
 863 }
 864
 865 bool Printer::doInitialization(Module &M) {
 866   // Tell gas we are outputting Intel syntax (not AT&T syntax) assembly.
 867   //
 868   // Bug: gas in `intel_syntax noprefix' mode interprets the symbol `Sp' in an
 869   // instruction as a reference to the register named sp, and if you try to
 870   // reference a symbol `Sp' (e.g. `mov ECX, OFFSET Sp') then it gets lowercased
 871   // before being looked up in the symbol table. This creates spurious
 872   // `undefined symbol' errors when linking. Workaround: Do not use `noprefix'
 873   // mode, and decorate all register names with percent signs.
 874   O << "\t.intel_syntax\n";
 875   Mang = new Mangler(M, EmitCygwin);
 876   return false; // success
 877 }
 878
 879 // SwitchSection - Switch to the specified section of the executable if we are
 880 // not already in it!
 881 //
 882 static void SwitchSection(std::ostream &OS, std::string &CurSection,
 883                           const char *NewSection) {
 884   if (CurSection != NewSection) {
 885     CurSection = NewSection;
 886     if (!CurSection.empty())
 887       OS << "\t" << NewSection << "\n";
 888   }
 889 }
 890
 891 bool Printer::doFinalization(Module &M) {
 892   const TargetData &TD = TM.getTargetData();
 893   std::string CurSection;
 894
 895   // Print out module-level global variables here.
 896   for (Module::const_giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
 897     if (I->hasInitializer()) {   // External global require no code
 898       O << "\n\n";
 899       std::string name = Mang->getValueName(I);
 900       Constant *C = I->getInitializer();
 901       unsigned Size = TD.getTypeSize(C->getType());
 902       unsigned Align = TD.getTypeAlignment(C->getType());
 903
 904       if (C->isNullValue() &&
 905           (I->hasLinkOnceLinkage() || I->hasInternalLinkage() ||
 906            I->hasWeakLinkage() /* FIXME: Verify correct */)) {
 907         SwitchSection(O, CurSection, ".data");
 908         if (I->hasInternalLinkage())
 909           O << "\t.local " << name << "\n";
 910
 911         O << "\t.comm " << name << "," << TD.getTypeSize(C->getType())
 912           << "," << (unsigned)TD.getTypeAlignment(C->getType());
 913         O << "\t\t# ";
 914         WriteAsOperand(O, I, true, true, &M);
 915         O << "\n";
 916       } else {
 917         switch (I->getLinkage()) {
 918         case GlobalValue::LinkOnceLinkage:
 919         case GlobalValue::WeakLinkage:   // FIXME: Verify correct for weak.
 920           // Nonnull linkonce -> weak
 921           O << "\t.weak " << name << "\n";
 922           SwitchSection(O, CurSection, "");
 923           O << "\t.section\t.llvm.linkonce.d." << name << ",\"aw\",@progbits\n";
 924           break;
 925
 926         case GlobalValue::AppendingLinkage:
 927           // FIXME: appending linkage variables should go into a section of
 928           // their name or something.  For now, just emit them as external.
 929         case GlobalValue::ExternalLinkage:
 930           // If external or appending, declare as a global symbol
 931           O << "\t.globl " << name << "\n";
 932           // FALL THROUGH
 933         case GlobalValue::InternalLinkage:
 934           if (C->isNullValue())
 935             SwitchSection(O, CurSection, ".bss");
 936           else
 937             SwitchSection(O, CurSection, ".data");
 938           break;
 939         }
 940
 941         O << "\t.align " << Align << "\n";
 942         O << "\t.type " << name << ",@object\n";
 943         O << "\t.size " << name << "," << Size << "\n";
 944         O << name << ":\t\t\t\t# ";
 945         WriteAsOperand(O, I, true, true, &M);
 946         O << " = ";
 947         WriteAsOperand(O, C, false, false, &M);
 948         O << "\n";
 949         emitGlobalConstant(C);
 950       }
 951     }
 952
 953   delete Mang;
 954   return false; // success
 955 }