include/llvm/CodeGen/MachineInstrBuilder.h

   1 //===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===//
   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 exposes a function named BuildMI, which is useful for dramatically
  11 // simplifying how MachineInstr's are created.  It allows use of code like this:
  12 //
  13 //   M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2);
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H
  18 #define LLVM_CODEGEN_MACHINEINSTRBUILDER_H
  19
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineInstrBundle.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23
  24 namespace llvm {
  25
  26 class MCInstrDesc;
  27 class MDNode;
  28
  29 namespace RegState {
  30   enum {
  31     Define         = 0x2,
  32     Implicit       = 0x4,
  33     Kill           = 0x8,
  34     Dead           = 0x10,
  35     Undef          = 0x20,
  36     EarlyClobber   = 0x40,
  37     Debug          = 0x80,
  38     InternalRead   = 0x100,
  39     DefineNoRead   = Define | Undef,
  40     ImplicitDefine = Implicit | Define,
  41     ImplicitKill   = Implicit | Kill
  42   };
  43 }
  44
  45 class MachineInstrBuilder {
  46   MachineFunction *MF;
  47   MachineInstr *MI;
  48 public:
  49   MachineInstrBuilder() : MF(nullptr), MI(nullptr) {}
  50
  51   /// Create a MachineInstrBuilder for manipulating an existing instruction.
  52   /// F must be the machine function  that was used to allocate I.
  53   MachineInstrBuilder(MachineFunction &F, MachineInstr *I) : MF(&F), MI(I) {}
  54
  55   /// Allow automatic conversion to the machine instruction we are working on.
  56   ///
  57   operator MachineInstr*() const { return MI; }
  58   MachineInstr *operator->() const { return MI; }
  59   operator MachineBasicBlock::iterator() const { return MI; }
  60
  61   /// If conversion operators fail, use this method to get the MachineInstr
  62   /// explicitly.
  63   MachineInstr *getInstr() const { return MI; }
  64
  65   /// addReg - Add a new virtual register operand...
  66   ///
  67   const
  68   MachineInstrBuilder &addReg(unsigned RegNo, unsigned flags = 0,
  69                               unsigned SubReg = 0) const {
  70     assert((flags & 0x1) == 0 &&
  71            "Passing in 'true' to addReg is forbidden! Use enums instead.");
  72     MI->addOperand(*MF, MachineOperand::CreateReg(RegNo,
  73                                                flags & RegState::Define,
  74                                                flags & RegState::Implicit,
  75                                                flags & RegState::Kill,
  76                                                flags & RegState::Dead,
  77                                                flags & RegState::Undef,
  78                                                flags & RegState::EarlyClobber,
  79                                                SubReg,
  80                                                flags & RegState::Debug,
  81                                                flags & RegState::InternalRead));
  82     return *this;
  83   }
  84
  85   /// addImm - Add a new immediate operand.
  86   ///
  87   const MachineInstrBuilder &addImm(int64_t Val) const {
  88     MI->addOperand(*MF, MachineOperand::CreateImm(Val));
  89     return *this;
  90   }
  91
  92   const MachineInstrBuilder &addCImm(const ConstantInt *Val) const {
  93     MI->addOperand(*MF, MachineOperand::CreateCImm(Val));
  94     return *this;
  95   }
  96
  97   const MachineInstrBuilder &addFPImm(const ConstantFP *Val) const {
  98     MI->addOperand(*MF, MachineOperand::CreateFPImm(Val));
  99     return *this;
 100   }
 101
 102   const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB,
 103                                     unsigned char TargetFlags = 0) const {
 104     MI->addOperand(*MF, MachineOperand::CreateMBB(MBB, TargetFlags));
 105     return *this;
 106   }
 107
 108   const MachineInstrBuilder &addFrameIndex(int Idx) const {
 109     MI->addOperand(*MF, MachineOperand::CreateFI(Idx));
 110     return *this;
 111   }
 112
 113   const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
 114                                                   int Offset = 0,
 115                                           unsigned char TargetFlags = 0) const {
 116     MI->addOperand(*MF, MachineOperand::CreateCPI(Idx, Offset, TargetFlags));
 117     return *this;
 118   }
 119
 120   const MachineInstrBuilder &addTargetIndex(unsigned Idx, int64_t Offset = 0,
 121                                           unsigned char TargetFlags = 0) const {
 122     MI->addOperand(*MF, MachineOperand::CreateTargetIndex(Idx, Offset,
 123                                                           TargetFlags));
 124     return *this;
 125   }
 126
 127   const MachineInstrBuilder &addJumpTableIndex(unsigned Idx,
 128                                           unsigned char TargetFlags = 0) const {
 129     MI->addOperand(*MF, MachineOperand::CreateJTI(Idx, TargetFlags));
 130     return *this;
 131   }
 132
 133   const MachineInstrBuilder &addGlobalAddress(const GlobalValue *GV,
 134                                               int64_t Offset = 0,
 135                                           unsigned char TargetFlags = 0) const {
 136     MI->addOperand(*MF, MachineOperand::CreateGA(GV, Offset, TargetFlags));
 137     return *this;
 138   }
 139
 140   const MachineInstrBuilder &addExternalSymbol(const char *FnName,
 141                                           unsigned char TargetFlags = 0) const {
 142     MI->addOperand(*MF, MachineOperand::CreateES(FnName, TargetFlags));
 143     return *this;
 144   }
 145
 146   const MachineInstrBuilder &addBlockAddress(const BlockAddress *BA,
 147                                              int64_t Offset = 0,
 148                                           unsigned char TargetFlags = 0) const {
 149     MI->addOperand(*MF, MachineOperand::CreateBA(BA, Offset, TargetFlags));
 150     return *this;
 151   }
 152
 153   const MachineInstrBuilder &addRegMask(const uint32_t *Mask) const {
 154     MI->addOperand(*MF, MachineOperand::CreateRegMask(Mask));
 155     return *this;
 156   }
 157
 158   const MachineInstrBuilder &addMemOperand(MachineMemOperand *MMO) const {
 159     MI->addMemOperand(*MF, MMO);
 160     return *this;
 161   }
 162
 163   const MachineInstrBuilder &setMemRefs(MachineInstr::mmo_iterator b,
 164                                         MachineInstr::mmo_iterator e) const {
 165     MI->setMemRefs(b, e);
 166     return *this;
 167   }
 168
 169
 170   const MachineInstrBuilder &addOperand(const MachineOperand &MO) const {
 171     MI->addOperand(*MF, MO);
 172     return *this;
 173   }
 174
 175   const MachineInstrBuilder &addMetadata(const MDNode *MD) const {
 176     MI->addOperand(*MF, MachineOperand::CreateMetadata(MD));
 177     assert((MI->isDebugValue() ? MI->getDebugVariable().Verify() : true) &&
 178            "first MDNode argument of a DBG_VALUE not a DIVariable");
 179     return *this;
 180   }
 181
 182   const MachineInstrBuilder &addCFIIndex(unsigned CFIIndex) const {
 183     MI->addOperand(*MF, MachineOperand::CreateCFIIndex(CFIIndex));
 184     return *this;
 185   }
 186
 187   const MachineInstrBuilder &addSym(MCSymbol *Sym) const {
 188     MI->addOperand(*MF, MachineOperand::CreateMCSymbol(Sym));
 189     return *this;
 190   }
 191
 192   const MachineInstrBuilder &setMIFlags(unsigned Flags) const {
 193     MI->setFlags(Flags);
 194     return *this;
 195   }
 196
 197   const MachineInstrBuilder &setMIFlag(MachineInstr::MIFlag Flag) const {
 198     MI->setFlag(Flag);
 199     return *this;
 200   }
 201
 202   // Add a displacement from an existing MachineOperand with an added offset.
 203   const MachineInstrBuilder &addDisp(const MachineOperand &Disp, int64_t off,
 204                                      unsigned char TargetFlags = 0) const {
 205     switch (Disp.getType()) {
 206       default:
 207         llvm_unreachable("Unhandled operand type in addDisp()");
 208       case MachineOperand::MO_Immediate:
 209         return addImm(Disp.getImm() + off);
 210       case MachineOperand::MO_GlobalAddress: {
 211         // If caller specifies new TargetFlags then use it, otherwise the
 212         // default behavior is to copy the target flags from the existing
 213         // MachineOperand. This means if the caller wants to clear the
 214         // target flags it needs to do so explicitly.
 215         if (TargetFlags)
 216           return addGlobalAddress(Disp.getGlobal(), Disp.getOffset() + off,
 217                                   TargetFlags);
 218         return addGlobalAddress(Disp.getGlobal(), Disp.getOffset() + off,
 219                                 Disp.getTargetFlags());
 220       }
 221     }
 222   }
 223
 224   /// Copy all the implicit operands from OtherMI onto this one.
 225   const MachineInstrBuilder &copyImplicitOps(const MachineInstr *OtherMI) {
 226     MI->copyImplicitOps(*MF, OtherMI);
 227     return *this;
 228   }
 229 };
 230
 231 /// BuildMI - Builder interface.  Specify how to create the initial instruction
 232 /// itself.
 233 ///
 234 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
 235                                    DebugLoc DL,
 236                                    const MCInstrDesc &MCID) {
 237   return MachineInstrBuilder(MF, MF.CreateMachineInstr(MCID, DL));
 238 }
 239
 240 /// BuildMI - This version of the builder sets up the first operand as a
 241 /// destination virtual register.
 242 ///
 243 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
 244                                    DebugLoc DL,
 245                                    const MCInstrDesc &MCID,
 246                                    unsigned DestReg) {
 247   return MachineInstrBuilder(MF, MF.CreateMachineInstr(MCID, DL))
 248            .addReg(DestReg, RegState::Define);
 249 }
 250
 251 /// BuildMI - This version of the builder inserts the newly-built
 252 /// instruction before the given position in the given MachineBasicBlock, and
 253 /// sets up the first operand as a destination virtual register.
 254 ///
 255 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 256                                    MachineBasicBlock::iterator I,
 257                                    DebugLoc DL,
 258                                    const MCInstrDesc &MCID,
 259                                    unsigned DestReg) {
 260   MachineFunction &MF = *BB.getParent();
 261   MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
 262   BB.insert(I, MI);
 263   return MachineInstrBuilder(MF, MI).addReg(DestReg, RegState::Define);
 264 }
 265
 266 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 267                                    MachineBasicBlock::instr_iterator I,
 268                                    DebugLoc DL,
 269                                    const MCInstrDesc &MCID,
 270                                    unsigned DestReg) {
 271   MachineFunction &MF = *BB.getParent();
 272   MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
 273   BB.insert(I, MI);
 274   return MachineInstrBuilder(MF, MI).addReg(DestReg, RegState::Define);
 275 }
 276
 277 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 278                                    MachineInstr *I,
 279                                    DebugLoc DL,
 280                                    const MCInstrDesc &MCID,
 281                                    unsigned DestReg) {
 282   if (I->isInsideBundle()) {
 283     MachineBasicBlock::instr_iterator MII = I;
 284     return BuildMI(BB, MII, DL, MCID, DestReg);
 285   }
 286
 287   MachineBasicBlock::iterator MII = I;
 288   return BuildMI(BB, MII, DL, MCID, DestReg);
 289 }
 290
 291 /// BuildMI - This version of the builder inserts the newly-built
 292 /// instruction before the given position in the given MachineBasicBlock, and
 293 /// does NOT take a destination register.
 294 ///
 295 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 296                                    MachineBasicBlock::iterator I,
 297                                    DebugLoc DL,
 298                                    const MCInstrDesc &MCID) {
 299   MachineFunction &MF = *BB.getParent();
 300   MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
 301   BB.insert(I, MI);
 302   return MachineInstrBuilder(MF, MI);
 303 }
 304
 305 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 306                                    MachineBasicBlock::instr_iterator I,
 307                                    DebugLoc DL,
 308                                    const MCInstrDesc &MCID) {
 309   MachineFunction &MF = *BB.getParent();
 310   MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
 311   BB.insert(I, MI);
 312   return MachineInstrBuilder(MF, MI);
 313 }
 314
 315 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 316                                    MachineInstr *I,
 317                                    DebugLoc DL,
 318                                    const MCInstrDesc &MCID) {
 319   if (I->isInsideBundle()) {
 320     MachineBasicBlock::instr_iterator MII = I;
 321     return BuildMI(BB, MII, DL, MCID);
 322   }
 323
 324   MachineBasicBlock::iterator MII = I;
 325   return BuildMI(BB, MII, DL, MCID);
 326 }
 327
 328 /// BuildMI - This version of the builder inserts the newly-built
 329 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
 330 /// destination register.
 331 ///
 332 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
 333                                    DebugLoc DL,
 334                                    const MCInstrDesc &MCID) {
 335   return BuildMI(*BB, BB->end(), DL, MCID);
 336 }
 337
 338 /// BuildMI - This version of the builder inserts the newly-built
 339 /// instruction at the end of the given MachineBasicBlock, and sets up the first
 340 /// operand as a destination virtual register.
 341 ///
 342 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
 343                                    DebugLoc DL,
 344                                    const MCInstrDesc &MCID,
 345                                    unsigned DestReg) {
 346   return BuildMI(*BB, BB->end(), DL, MCID, DestReg);
 347 }
 348
 349 /// BuildMI - This version of the builder builds a DBG_VALUE intrinsic
 350 /// for either a value in a register or a register-indirect+offset
 351 /// address.  The convention is that a DBG_VALUE is indirect iff the
 352 /// second operand is an immediate.
 353 ///
 354 inline MachineInstrBuilder BuildMI(MachineFunction &MF, DebugLoc DL,
 355                                    const MCInstrDesc &MCID, bool IsIndirect,
 356                                    unsigned Reg, unsigned Offset,
 357                                    const MDNode *Variable, const MDNode *Expr) {
 358   assert(DIVariable(Variable).Verify() && "not a DIVariable");
 359   assert(DIExpression(Expr)->isValid() && "not a DIExpression");
 360   assert(DIVariable(Variable)->isValidLocationForIntrinsic(DL) &&
 361          "Expected inlined-at fields to agree");
 362   if (IsIndirect)
 363     return BuildMI(MF, DL, MCID)
 364         .addReg(Reg, RegState::Debug)
 365         .addImm(Offset)
 366         .addMetadata(Variable)
 367         .addMetadata(Expr);
 368   else {
 369     assert(Offset == 0 && "A direct address cannot have an offset.");
 370     return BuildMI(MF, DL, MCID)
 371         .addReg(Reg, RegState::Debug)
 372         .addReg(0U, RegState::Debug)
 373         .addMetadata(Variable)
 374         .addMetadata(Expr);
 375   }
 376 }
 377
 378 /// BuildMI - This version of the builder builds a DBG_VALUE intrinsic
 379 /// for either a value in a register or a register-indirect+offset
 380 /// address and inserts it at position I.
 381 ///
 382 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 383                                    MachineBasicBlock::iterator I, DebugLoc DL,
 384                                    const MCInstrDesc &MCID, bool IsIndirect,
 385                                    unsigned Reg, unsigned Offset,
 386                                    const MDNode *Variable, const MDNode *Expr) {
 387   assert(DIVariable(Variable).Verify() && "not a DIVariable");
 388   assert(DIExpression(Expr)->isValid() && "not a DIExpression");
 389   MachineFunction &MF = *BB.getParent();
 390   MachineInstr *MI =
 391       BuildMI(MF, DL, MCID, IsIndirect, Reg, Offset, Variable, Expr);
 392   BB.insert(I, MI);
 393   return MachineInstrBuilder(MF, MI);
 394 }
 395
 396
 397 inline unsigned getDefRegState(bool B) {
 398   return B ? RegState::Define : 0;
 399 }
 400 inline unsigned getImplRegState(bool B) {
 401   return B ? RegState::Implicit : 0;
 402 }
 403 inline unsigned getKillRegState(bool B) {
 404   return B ? RegState::Kill : 0;
 405 }
 406 inline unsigned getDeadRegState(bool B) {
 407   return B ? RegState::Dead : 0;
 408 }
 409 inline unsigned getUndefRegState(bool B) {
 410   return B ? RegState::Undef : 0;
 411 }
 412 inline unsigned getInternalReadRegState(bool B) {
 413   return B ? RegState::InternalRead : 0;
 414 }
 415 inline unsigned getDebugRegState(bool B) {
 416   return B ? RegState::Debug : 0;
 417 }
 418
 419
 420 /// Helper class for constructing bundles of MachineInstrs.
 421 ///
 422 /// MIBundleBuilder can create a bundle from scratch by inserting new
 423 /// MachineInstrs one at a time, or it can create a bundle from a sequence of
 424 /// existing MachineInstrs in a basic block.
 425 class MIBundleBuilder {
 426   MachineBasicBlock &MBB;
 427   MachineBasicBlock::instr_iterator Begin;
 428   MachineBasicBlock::instr_iterator End;
 429
 430 public:
 431   /// Create an MIBundleBuilder that inserts instructions into a new bundle in
 432   /// BB above the bundle or instruction at Pos.
 433   MIBundleBuilder(MachineBasicBlock &BB,
 434                   MachineBasicBlock::iterator Pos)
 435     : MBB(BB), Begin(Pos.getInstrIterator()), End(Begin) {}
 436
 437   /// Create a bundle from the sequence of instructions between B and E.
 438   MIBundleBuilder(MachineBasicBlock &BB,
 439                   MachineBasicBlock::iterator B,
 440                   MachineBasicBlock::iterator E)
 441     : MBB(BB), Begin(B.getInstrIterator()), End(E.getInstrIterator()) {
 442     assert(B != E && "No instructions to bundle");
 443     ++B;
 444     while (B != E) {
 445       MachineInstr *MI = B;
 446       ++B;
 447       MI->bundleWithPred();
 448     }
 449   }
 450
 451   /// Create an MIBundleBuilder representing an existing instruction or bundle
 452   /// that has MI as its head.
 453   explicit MIBundleBuilder(MachineInstr *MI)
 454     : MBB(*MI->getParent()), Begin(MI), End(getBundleEnd(MI)) {}
 455
 456   /// Return a reference to the basic block containing this bundle.
 457   MachineBasicBlock &getMBB() const { return MBB; }
 458
 459   /// Return true if no instructions have been inserted in this bundle yet.
 460   /// Empty bundles aren't representable in a MachineBasicBlock.
 461   bool empty() const { return Begin == End; }
 462
 463   /// Return an iterator to the first bundled instruction.
 464   MachineBasicBlock::instr_iterator begin() const { return Begin; }
 465
 466   /// Return an iterator beyond the last bundled instruction.
 467   MachineBasicBlock::instr_iterator end() const { return End; }
 468
 469   /// Insert MI into this bundle before I which must point to an instruction in
 470   /// the bundle, or end().
 471   MIBundleBuilder &insert(MachineBasicBlock::instr_iterator I,
 472                           MachineInstr *MI) {
 473     MBB.insert(I, MI);
 474     if (I == Begin) {
 475       if (!empty())
 476         MI->bundleWithSucc();
 477       Begin = MI;
 478       return *this;
 479     }
 480     if (I == End) {
 481       MI->bundleWithPred();
 482       return *this;
 483     }
 484     // MI was inserted in the middle of the bundle, so its neighbors' flags are
 485     // already fine. Update MI's bundle flags manually.
 486     MI->setFlag(MachineInstr::BundledPred);
 487     MI->setFlag(MachineInstr::BundledSucc);
 488     return *this;
 489   }
 490
 491   /// Insert MI into MBB by prepending it to the instructions in the bundle.
 492   /// MI will become the first instruction in the bundle.
 493   MIBundleBuilder &prepend(MachineInstr *MI) {
 494     return insert(begin(), MI);
 495   }
 496
 497   /// Insert MI into MBB by appending it to the instructions in the bundle.
 498   /// MI will become the last instruction in the bundle.
 499   MIBundleBuilder &append(MachineInstr *MI) {
 500     return insert(end(), MI);
 501   }
 502 };
 503
 504 } // End llvm namespace
 505
 506 #endif