lib/Target/X86/AsmPrinter/X86MCInstLower.cpp

   1 //===-- X86MCInstLower.cpp - Convert X86 MachineInstr to an MCInst --------===//
   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 code to lower X86 MachineInstrs to their corresponding
  11 // MCInst records.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "X86MCInstLower.h"
  16 #include "X86AsmPrinter.h"
  17 #include "X86COFFMachineModuleInfo.h"
  18 #include "X86MCAsmInfo.h"
  19 #include "X86MCTargetExpr.h"
  20 #include "llvm/Analysis/DebugInfo.h"
  21 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
  22 #include "llvm/MC/MCContext.h"
  23 #include "llvm/MC/MCExpr.h"
  24 #include "llvm/MC/MCInst.h"
  25 #include "llvm/MC/MCStreamer.h"
  26 #include "llvm/MC/MCSymbol.h"
  27 #include "llvm/Target/Mangler.h"
  28 #include "llvm/Support/FormattedStream.h"
  29 #include "llvm/ADT/SmallString.h"
  30 #include "llvm/Type.h"
  31 using namespace llvm;
  32
  33
  34 const X86Subtarget &X86MCInstLower::getSubtarget() const {
  35   return AsmPrinter.getSubtarget();
  36 }
  37
  38 MachineModuleInfoMachO &X86MCInstLower::getMachOMMI() const {
  39   assert(getSubtarget().isTargetDarwin() &&"Can only get MachO info on darwin");
  40   return AsmPrinter.MMI->getObjFileInfo<MachineModuleInfoMachO>();
  41 }
  42
  43
  44 MCSymbol *X86MCInstLower::GetPICBaseSymbol() const {
  45   const TargetLowering *TLI = AsmPrinter.TM.getTargetLowering();
  46   return static_cast<const X86TargetLowering*>(TLI)->
  47     getPICBaseSymbol(AsmPrinter.MF, Ctx);
  48 }
  49
  50 /// GetSymbolFromOperand - Lower an MO_GlobalAddress or MO_ExternalSymbol
  51 /// operand to an MCSymbol.
  52 MCSymbol *X86MCInstLower::
  53 GetSymbolFromOperand(const MachineOperand &MO) const {
  54   assert((MO.isGlobal() || MO.isSymbol()) && "Isn't a symbol reference");
  55
  56   SmallString<128> Name;
  57
  58   if (!MO.isGlobal()) {
  59     assert(MO.isSymbol());
  60     Name += AsmPrinter.MAI->getGlobalPrefix();
  61     Name += MO.getSymbolName();
  62   } else {
  63     const GlobalValue *GV = MO.getGlobal();
  64     bool isImplicitlyPrivate = false;
  65     if (MO.getTargetFlags() == X86II::MO_DARWIN_STUB ||
  66         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
  67         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE ||
  68         MO.getTargetFlags() == X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE)
  69       isImplicitlyPrivate = true;
  70
  71     Mang->getNameWithPrefix(Name, GV, isImplicitlyPrivate);
  72   }
  73
  74   // If the target flags on the operand changes the name of the symbol, do that
  75   // before we return the symbol.
  76   switch (MO.getTargetFlags()) {
  77   default: break;
  78   case X86II::MO_DLLIMPORT: {
  79     // Handle dllimport linkage.
  80     const char *Prefix = "__imp_";
  81     Name.insert(Name.begin(), Prefix, Prefix+strlen(Prefix));
  82     break;
  83   }
  84   case X86II::MO_DARWIN_NONLAZY:
  85   case X86II::MO_DARWIN_NONLAZY_PIC_BASE: {
  86     Name += "$non_lazy_ptr";
  87     MCSymbol *Sym = Ctx.GetOrCreateTemporarySymbol(Name.str());
  88
  89     MachineModuleInfoImpl::StubValueTy &StubSym =
  90       getMachOMMI().getGVStubEntry(Sym);
  91     if (StubSym.getPointer() == 0) {
  92       assert(MO.isGlobal() && "Extern symbol not handled yet");
  93       StubSym =
  94         MachineModuleInfoImpl::
  95         StubValueTy(AsmPrinter.Mang->getSymbol(MO.getGlobal()),
  96                     !MO.getGlobal()->hasInternalLinkage());
  97     }
  98     return Sym;
  99   }
 100   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: {
 101     Name += "$non_lazy_ptr";
 102     MCSymbol *Sym = Ctx.GetOrCreateTemporarySymbol(Name.str());
 103     MachineModuleInfoImpl::StubValueTy &StubSym =
 104       getMachOMMI().getHiddenGVStubEntry(Sym);
 105     if (StubSym.getPointer() == 0) {
 106       assert(MO.isGlobal() && "Extern symbol not handled yet");
 107       StubSym =
 108         MachineModuleInfoImpl::
 109         StubValueTy(AsmPrinter.Mang->getSymbol(MO.getGlobal()),
 110                     !MO.getGlobal()->hasInternalLinkage());
 111     }
 112     return Sym;
 113   }
 114   case X86II::MO_DARWIN_STUB: {
 115     Name += "$stub";
 116     MCSymbol *Sym = Ctx.GetOrCreateTemporarySymbol(Name.str());
 117     MachineModuleInfoImpl::StubValueTy &StubSym =
 118       getMachOMMI().getFnStubEntry(Sym);
 119     if (StubSym.getPointer())
 120       return Sym;
 121
 122     if (MO.isGlobal()) {
 123       StubSym =
 124         MachineModuleInfoImpl::
 125         StubValueTy(AsmPrinter.Mang->getSymbol(MO.getGlobal()),
 126                     !MO.getGlobal()->hasInternalLinkage());
 127     } else {
 128       Name.erase(Name.end()-5, Name.end());
 129       StubSym =
 130         MachineModuleInfoImpl::
 131         StubValueTy(Ctx.GetOrCreateTemporarySymbol(Name.str()), false);
 132     }
 133     return Sym;
 134   }
 135   }
 136
 137   return Ctx.GetOrCreateSymbol(Name.str());
 138 }
 139
 140 MCOperand X86MCInstLower::LowerSymbolOperand(const MachineOperand &MO,
 141                                              MCSymbol *Sym) const {
 142   // FIXME: We would like an efficient form for this, so we don't have to do a
 143   // lot of extra uniquing.
 144   const MCExpr *Expr = 0;
 145   X86MCTargetExpr::VariantKind RefKind = X86MCTargetExpr::Invalid;
 146
 147   switch (MO.getTargetFlags()) {
 148   default: llvm_unreachable("Unknown target flag on GV operand");
 149   case X86II::MO_NO_FLAG:    // No flag.
 150   // These affect the name of the symbol, not any suffix.
 151   case X86II::MO_DARWIN_NONLAZY:
 152   case X86II::MO_DLLIMPORT:
 153   case X86II::MO_DARWIN_STUB:
 154     break;
 155
 156   case X86II::MO_TLSGD:     RefKind = X86MCTargetExpr::TLSGD; break;
 157   case X86II::MO_GOTTPOFF:  RefKind = X86MCTargetExpr::GOTTPOFF; break;
 158   case X86II::MO_INDNTPOFF: RefKind = X86MCTargetExpr::INDNTPOFF; break;
 159   case X86II::MO_TPOFF:     RefKind = X86MCTargetExpr::TPOFF; break;
 160   case X86II::MO_NTPOFF:    RefKind = X86MCTargetExpr::NTPOFF; break;
 161   case X86II::MO_GOTPCREL:  RefKind = X86MCTargetExpr::GOTPCREL; break;
 162   case X86II::MO_GOT:       RefKind = X86MCTargetExpr::GOT; break;
 163   case X86II::MO_GOTOFF:    RefKind = X86MCTargetExpr::GOTOFF; break;
 164   case X86II::MO_PLT:       RefKind = X86MCTargetExpr::PLT; break;
 165   case X86II::MO_PIC_BASE_OFFSET:
 166   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
 167   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE:
 168     Expr = MCSymbolRefExpr::Create(Sym, Ctx);
 169     // Subtract the pic base.
 170     Expr = MCBinaryExpr::CreateSub(Expr,
 171                                MCSymbolRefExpr::Create(GetPICBaseSymbol(), Ctx),
 172                                    Ctx);
 173     break;
 174   }
 175
 176   if (Expr == 0) {
 177     if (RefKind == X86MCTargetExpr::Invalid)
 178       Expr = MCSymbolRefExpr::Create(Sym, Ctx);
 179     else
 180       Expr = X86MCTargetExpr::Create(Sym, RefKind, Ctx);
 181   }
 182
 183   if (!MO.isJTI() && MO.getOffset())
 184     Expr = MCBinaryExpr::CreateAdd(Expr,
 185                                    MCConstantExpr::Create(MO.getOffset(), Ctx),
 186                                    Ctx);
 187   return MCOperand::CreateExpr(Expr);
 188 }
 189
 190
 191
 192 static void lower_subreg32(MCInst *MI, unsigned OpNo) {
 193   // Convert registers in the addr mode according to subreg32.
 194   unsigned Reg = MI->getOperand(OpNo).getReg();
 195   if (Reg != 0)
 196     MI->getOperand(OpNo).setReg(getX86SubSuperRegister(Reg, MVT::i32));
 197 }
 198
 199 static void lower_lea64_32mem(MCInst *MI, unsigned OpNo) {
 200   // Convert registers in the addr mode according to subreg64.
 201   for (unsigned i = 0; i != 4; ++i) {
 202     if (!MI->getOperand(OpNo+i).isReg()) continue;
 203
 204     unsigned Reg = MI->getOperand(OpNo+i).getReg();
 205     if (Reg == 0) continue;
 206
 207     MI->getOperand(OpNo+i).setReg(getX86SubSuperRegister(Reg, MVT::i64));
 208   }
 209 }
 210
 211 /// LowerSubReg32_Op0 - Things like MOVZX16rr8 -> MOVZX32rr8.
 212 static void LowerSubReg32_Op0(MCInst &OutMI, unsigned NewOpc) {
 213   OutMI.setOpcode(NewOpc);
 214   lower_subreg32(&OutMI, 0);
 215 }
 216 /// LowerUnaryToTwoAddr - R = setb   -> R = sbb R, R
 217 static void LowerUnaryToTwoAddr(MCInst &OutMI, unsigned NewOpc) {
 218   OutMI.setOpcode(NewOpc);
 219   OutMI.addOperand(OutMI.getOperand(0));
 220   OutMI.addOperand(OutMI.getOperand(0));
 221 }
 222
 223
 224 void X86MCInstLower::Lower(const MachineInstr *MI, MCInst &OutMI) const {
 225   OutMI.setOpcode(MI->getOpcode());
 226
 227   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 228     const MachineOperand &MO = MI->getOperand(i);
 229
 230     MCOperand MCOp;
 231     switch (MO.getType()) {
 232     default:
 233       MI->dump();
 234       llvm_unreachable("unknown operand type");
 235     case MachineOperand::MO_Register:
 236       // Ignore all implicit register operands.
 237       if (MO.isImplicit()) continue;
 238       MCOp = MCOperand::CreateReg(MO.getReg());
 239       break;
 240     case MachineOperand::MO_Immediate:
 241       MCOp = MCOperand::CreateImm(MO.getImm());
 242       break;
 243     case MachineOperand::MO_MachineBasicBlock:
 244       MCOp = MCOperand::CreateExpr(MCSymbolRefExpr::Create(
 245                        MO.getMBB()->getSymbol(), Ctx));
 246       break;
 247     case MachineOperand::MO_GlobalAddress:
 248       MCOp = LowerSymbolOperand(MO, GetSymbolFromOperand(MO));
 249       break;
 250     case MachineOperand::MO_ExternalSymbol:
 251       MCOp = LowerSymbolOperand(MO, GetSymbolFromOperand(MO));
 252       break;
 253     case MachineOperand::MO_JumpTableIndex:
 254       MCOp = LowerSymbolOperand(MO, AsmPrinter.GetJTISymbol(MO.getIndex()));
 255       break;
 256     case MachineOperand::MO_ConstantPoolIndex:
 257       MCOp = LowerSymbolOperand(MO, AsmPrinter.GetCPISymbol(MO.getIndex()));
 258       break;
 259     case MachineOperand::MO_BlockAddress:
 260       MCOp = LowerSymbolOperand(MO,
 261                         AsmPrinter.GetBlockAddressSymbol(MO.getBlockAddress()));
 262       break;
 263     }
 264
 265     OutMI.addOperand(MCOp);
 266   }
 267
 268   // Handle a few special cases to eliminate operand modifiers.
 269   switch (OutMI.getOpcode()) {
 270   case X86::LEA64_32r: // Handle 'subreg rewriting' for the lea64_32mem operand.
 271     lower_lea64_32mem(&OutMI, 1);
 272     break;
 273   case X86::MOVZX16rr8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rr8); break;
 274   case X86::MOVZX16rm8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rm8); break;
 275   case X86::MOVSX16rr8:   LowerSubReg32_Op0(OutMI, X86::MOVSX32rr8); break;
 276   case X86::MOVSX16rm8:   LowerSubReg32_Op0(OutMI, X86::MOVSX32rm8); break;
 277   case X86::MOVZX64rr32:  LowerSubReg32_Op0(OutMI, X86::MOV32rr); break;
 278   case X86::MOVZX64rm32:  LowerSubReg32_Op0(OutMI, X86::MOV32rm); break;
 279   case X86::MOV64ri64i32: LowerSubReg32_Op0(OutMI, X86::MOV32ri); break;
 280   case X86::MOVZX64rr8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rr8); break;
 281   case X86::MOVZX64rm8:   LowerSubReg32_Op0(OutMI, X86::MOVZX32rm8); break;
 282   case X86::MOVZX64rr16:  LowerSubReg32_Op0(OutMI, X86::MOVZX32rr16); break;
 283   case X86::MOVZX64rm16:  LowerSubReg32_Op0(OutMI, X86::MOVZX32rm16); break;
 284   case X86::SETB_C8r:     LowerUnaryToTwoAddr(OutMI, X86::SBB8rr); break;
 285   case X86::SETB_C16r:    LowerUnaryToTwoAddr(OutMI, X86::SBB16rr); break;
 286   case X86::SETB_C32r:    LowerUnaryToTwoAddr(OutMI, X86::SBB32rr); break;
 287   case X86::SETB_C64r:    LowerUnaryToTwoAddr(OutMI, X86::SBB64rr); break;
 288   case X86::MOV8r0:       LowerUnaryToTwoAddr(OutMI, X86::XOR8rr); break;
 289   case X86::MOV32r0:      LowerUnaryToTwoAddr(OutMI, X86::XOR32rr); break;
 290   case X86::MMX_V_SET0:   LowerUnaryToTwoAddr(OutMI, X86::MMX_PXORrr); break;
 291   case X86::MMX_V_SETALLONES:
 292     LowerUnaryToTwoAddr(OutMI, X86::MMX_PCMPEQDrr); break;
 293   case X86::FsFLD0SS:     LowerUnaryToTwoAddr(OutMI, X86::PXORrr); break;
 294   case X86::FsFLD0SD:     LowerUnaryToTwoAddr(OutMI, X86::PXORrr); break;
 295   case X86::V_SET0:       LowerUnaryToTwoAddr(OutMI, X86::XORPSrr); break;
 296   case X86::V_SETALLONES: LowerUnaryToTwoAddr(OutMI, X86::PCMPEQDrr); break;
 297
 298   case X86::MOV16r0:
 299     LowerSubReg32_Op0(OutMI, X86::MOV32r0);   // MOV16r0 -> MOV32r0
 300     LowerUnaryToTwoAddr(OutMI, X86::XOR32rr); // MOV32r0 -> XOR32rr
 301     break;
 302   case X86::MOV64r0:
 303     LowerSubReg32_Op0(OutMI, X86::MOV32r0);   // MOV64r0 -> MOV32r0
 304     LowerUnaryToTwoAddr(OutMI, X86::XOR32rr); // MOV32r0 -> XOR32rr
 305     break;
 306   }
 307 }
 308
 309
 310
 311 void X86AsmPrinter::EmitInstruction(const MachineInstr *MI) {
 312   X86MCInstLower MCInstLowering(OutContext, Mang, *this);
 313   switch (MI->getOpcode()) {
 314   case TargetOpcode::DBG_VALUE: {
 315     // FIXME: if this is implemented for another target before it goes
 316     // away completely, the common part should be moved into AsmPrinter.
 317     if (!VerboseAsm)
 318       return;
 319     O << '\t' << MAI->getCommentString() << "DEBUG_VALUE: ";
 320     unsigned NOps = MI->getNumOperands();
 321     // cast away const; DIetc do not take const operands for some reason.
 322     DIVariable V((MDNode*)(MI->getOperand(NOps-1).getMetadata()));
 323     O << V.getName();
 324     O << " <- ";
 325     if (NOps==3) {
 326       // Register or immediate value. Register 0 means undef.
 327       assert(MI->getOperand(0).getType()==MachineOperand::MO_Register ||
 328              MI->getOperand(0).getType()==MachineOperand::MO_Immediate ||
 329              MI->getOperand(0).getType()==MachineOperand::MO_FPImmediate);
 330       if (MI->getOperand(0).getType()==MachineOperand::MO_Register &&
 331           MI->getOperand(0).getReg()==0) {
 332         // Suppress offset in this case, it is not meaningful.
 333         O << "undef";
 334         OutStreamer.AddBlankLine();
 335         return;
 336       } else if (MI->getOperand(0).getType()==MachineOperand::MO_FPImmediate) {
 337         // This is more naturally done in printOperand, but since the only use
 338         // of such an operand is in this comment and that is temporary (and it's
 339         // ugly), we prefer to keep this localized.
 340         // The include of Type.h may be removable when this code is.
 341         if (MI->getOperand(0).getFPImm()->getType()->isFloatTy() ||
 342             MI->getOperand(0).getFPImm()->getType()->isDoubleTy())
 343           MI->getOperand(0).print(O, &TM);
 344         else {
 345           // There is no good way to print long double.  Convert a copy to
 346           // double.  Ah well, it's only a comment.
 347           bool ignored;
 348           APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
 349           APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
 350                       &ignored);
 351           O << "(long double) " << APF.convertToDouble();
 352         }
 353       } else
 354         printOperand(MI, 0);
 355     } else {
 356       if (MI->getOperand(0).getType()==MachineOperand::MO_Register &&
 357           MI->getOperand(0).getReg()==0) {
 358         // Suppress offset in this case, it is not meaningful.
 359         O << "undef";
 360         OutStreamer.AddBlankLine();
 361         return;
 362       }
 363       // Frame address.  Currently handles register +- offset only.
 364       assert(MI->getOperand(0).getType()==MachineOperand::MO_Register);
 365       assert(MI->getOperand(3).getType()==MachineOperand::MO_Immediate);
 366       O << '['; printOperand(MI, 0); O << '+'; printOperand(MI, 3); O << ']';
 367     }
 368     O << "+";
 369     printOperand(MI, NOps-2);
 370     OutStreamer.AddBlankLine();
 371     return;
 372   }
 373   case X86::MOVPC32r: {
 374     MCInst TmpInst;
 375     // This is a pseudo op for a two instruction sequence with a label, which
 376     // looks like:
 377     //     call "L1$pb"
 378     // "L1$pb":
 379     //     popl %esi
 380
 381     // Emit the call.
 382     MCSymbol *PICBase = MCInstLowering.GetPICBaseSymbol();
 383     TmpInst.setOpcode(X86::CALLpcrel32);
 384     // FIXME: We would like an efficient form for this, so we don't have to do a
 385     // lot of extra uniquing.
 386     TmpInst.addOperand(MCOperand::CreateExpr(MCSymbolRefExpr::Create(PICBase,
 387                                                                  OutContext)));
 388     OutStreamer.EmitInstruction(TmpInst);
 389
 390     // Emit the label.
 391     OutStreamer.EmitLabel(PICBase);
 392
 393     // popl $reg
 394     TmpInst.setOpcode(X86::POP32r);
 395     TmpInst.getOperand(0) = MCOperand::CreateReg(MI->getOperand(0).getReg());
 396     OutStreamer.EmitInstruction(TmpInst);
 397     return;
 398   }
 399
 400   case X86::ADD32ri: {
 401     // Lower the MO_GOT_ABSOLUTE_ADDRESS form of ADD32ri.
 402     if (MI->getOperand(2).getTargetFlags() != X86II::MO_GOT_ABSOLUTE_ADDRESS)
 403       break;
 404
 405     // Okay, we have something like:
 406     //  EAX = ADD32ri EAX, MO_GOT_ABSOLUTE_ADDRESS(@MYGLOBAL)
 407
 408     // For this, we want to print something like:
 409     //   MYGLOBAL + (. - PICBASE)
 410     // However, we can't generate a ".", so just emit a new label here and refer
 411     // to it.
 412     MCSymbol *DotSym = OutContext.GetOrCreateTemporarySymbol();
 413     OutStreamer.EmitLabel(DotSym);
 414
 415     // Now that we have emitted the label, lower the complex operand expression.
 416     MCSymbol *OpSym = MCInstLowering.GetSymbolFromOperand(MI->getOperand(2));
 417
 418     const MCExpr *DotExpr = MCSymbolRefExpr::Create(DotSym, OutContext);
 419     const MCExpr *PICBase =
 420       MCSymbolRefExpr::Create(MCInstLowering.GetPICBaseSymbol(), OutContext);
 421     DotExpr = MCBinaryExpr::CreateSub(DotExpr, PICBase, OutContext);
 422
 423     DotExpr = MCBinaryExpr::CreateAdd(MCSymbolRefExpr::Create(OpSym,OutContext),
 424                                       DotExpr, OutContext);
 425
 426     MCInst TmpInst;
 427     TmpInst.setOpcode(X86::ADD32ri);
 428     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(0).getReg()));
 429     TmpInst.addOperand(MCOperand::CreateReg(MI->getOperand(1).getReg()));
 430     TmpInst.addOperand(MCOperand::CreateExpr(DotExpr));
 431     OutStreamer.EmitInstruction(TmpInst);
 432     return;
 433   }
 434   }
 435
 436   MCInst TmpInst;
 437   MCInstLowering.Lower(MI, TmpInst);
 438
 439   OutStreamer.EmitInstruction(TmpInst);
 440 }
 441