Update include - this class doesn't use the target machine, but
[oota-llvm.git] / lib / Target / Mips / MipsLongBranch.cpp
1 //===-- MipsLongBranch.cpp - Emit long branches ---------------------------===//
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 pass expands a branch or jump instruction into a long branch if its
11 // offset is too large to fit into its immediate field.
12 //
13 // FIXME: Fix pc-region jump instructions which cross 256MB segment boundaries.
14 //===----------------------------------------------------------------------===//
15
16 #include "Mips.h"
17 #include "MCTargetDesc/MipsBaseInfo.h"
18 #include "MCTargetDesc/MipsMCNaCl.h"
19 #include "MipsMachineFunction.h"
20 #include "MipsTargetMachine.h"
21 #include "llvm/ADT/Statistic.h"
22 #include "llvm/CodeGen/MachineFunctionPass.h"
23 #include "llvm/CodeGen/MachineInstrBuilder.h"
24 #include "llvm/IR/Function.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Support/MathExtras.h"
27 #include "llvm/Target/TargetInstrInfo.h"
28 #include "llvm/Target/TargetMachine.h"
29 #include "llvm/Target/TargetRegisterInfo.h"
30
31 using namespace llvm;
32
33 #define DEBUG_TYPE "mips-long-branch"
34
35 STATISTIC(LongBranches, "Number of long branches.");
36
37 static cl::opt<bool> SkipLongBranch(
38   "skip-mips-long-branch",
39   cl::init(false),
40   cl::desc("MIPS: Skip long branch pass."),
41   cl::Hidden);
42
43 static cl::opt<bool> ForceLongBranch(
44   "force-mips-long-branch",
45   cl::init(false),
46   cl::desc("MIPS: Expand all branches to long format."),
47   cl::Hidden);
48
49 namespace {
50   typedef MachineBasicBlock::iterator Iter;
51   typedef MachineBasicBlock::reverse_iterator ReverseIter;
52
53   struct MBBInfo {
54     uint64_t Size, Address;
55     bool HasLongBranch;
56     MachineInstr *Br;
57
58     MBBInfo() : Size(0), HasLongBranch(false), Br(nullptr) {}
59   };
60
61   class MipsLongBranch : public MachineFunctionPass {
62
63   public:
64     static char ID;
65     MipsLongBranch(TargetMachine &tm)
66       : MachineFunctionPass(ID), TM(tm),
67         IsPIC(TM.getRelocationModel() == Reloc::PIC_),
68         ABI(TM.getSubtarget<MipsSubtarget>().getABI()),
69         LongBranchSeqSize(!IsPIC ? 2 : (ABI.IsN64() ? 10 :
70             (!TM.getSubtarget<MipsSubtarget>().isTargetNaCl() ? 9 : 10))) {}
71
72     const char *getPassName() const override {
73       return "Mips Long Branch";
74     }
75
76     bool runOnMachineFunction(MachineFunction &F) override;
77
78   private:
79     void splitMBB(MachineBasicBlock *MBB);
80     void initMBBInfo();
81     int64_t computeOffset(const MachineInstr *Br);
82     void replaceBranch(MachineBasicBlock &MBB, Iter Br, DebugLoc DL,
83                        MachineBasicBlock *MBBOpnd);
84     void expandToLongBranch(MBBInfo &Info);
85
86     const TargetMachine &TM;
87     MachineFunction *MF;
88     SmallVector<MBBInfo, 16> MBBInfos;
89     bool IsPIC;
90     MipsABIInfo ABI;
91     unsigned LongBranchSeqSize;
92   };
93
94   char MipsLongBranch::ID = 0;
95 } // end of anonymous namespace
96
97 /// createMipsLongBranchPass - Returns a pass that converts branches to long
98 /// branches.
99 FunctionPass *llvm::createMipsLongBranchPass(MipsTargetMachine &tm) {
100   return new MipsLongBranch(tm);
101 }
102
103 /// Iterate over list of Br's operands and search for a MachineBasicBlock
104 /// operand.
105 static MachineBasicBlock *getTargetMBB(const MachineInstr &Br) {
106   for (unsigned I = 0, E = Br.getDesc().getNumOperands(); I < E; ++I) {
107     const MachineOperand &MO = Br.getOperand(I);
108
109     if (MO.isMBB())
110       return MO.getMBB();
111   }
112
113   llvm_unreachable("This instruction does not have an MBB operand.");
114 }
115
116 // Traverse the list of instructions backwards until a non-debug instruction is
117 // found or it reaches E.
118 static ReverseIter getNonDebugInstr(ReverseIter B, ReverseIter E) {
119   for (; B != E; ++B)
120     if (!B->isDebugValue())
121       return B;
122
123   return E;
124 }
125
126 // Split MBB if it has two direct jumps/branches.
127 void MipsLongBranch::splitMBB(MachineBasicBlock *MBB) {
128   ReverseIter End = MBB->rend();
129   ReverseIter LastBr = getNonDebugInstr(MBB->rbegin(), End);
130
131   // Return if MBB has no branch instructions.
132   if ((LastBr == End) ||
133       (!LastBr->isConditionalBranch() && !LastBr->isUnconditionalBranch()))
134     return;
135
136   ReverseIter FirstBr = getNonDebugInstr(std::next(LastBr), End);
137
138   // MBB has only one branch instruction if FirstBr is not a branch
139   // instruction.
140   if ((FirstBr == End) ||
141       (!FirstBr->isConditionalBranch() && !FirstBr->isUnconditionalBranch()))
142     return;
143
144   assert(!FirstBr->isIndirectBranch() && "Unexpected indirect branch found.");
145
146   // Create a new MBB. Move instructions in MBB to the newly created MBB.
147   MachineBasicBlock *NewMBB =
148     MF->CreateMachineBasicBlock(MBB->getBasicBlock());
149
150   // Insert NewMBB and fix control flow.
151   MachineBasicBlock *Tgt = getTargetMBB(*FirstBr);
152   NewMBB->transferSuccessors(MBB);
153   NewMBB->removeSuccessor(Tgt);
154   MBB->addSuccessor(NewMBB);
155   MBB->addSuccessor(Tgt);
156   MF->insert(std::next(MachineFunction::iterator(MBB)), NewMBB);
157
158   NewMBB->splice(NewMBB->end(), MBB, (++LastBr).base(), MBB->end());
159 }
160
161 // Fill MBBInfos.
162 void MipsLongBranch::initMBBInfo() {
163   // Split the MBBs if they have two branches. Each basic block should have at
164   // most one branch after this loop is executed.
165   for (MachineFunction::iterator I = MF->begin(), E = MF->end(); I != E;)
166     splitMBB(I++);
167
168   MF->RenumberBlocks();
169   MBBInfos.clear();
170   MBBInfos.resize(MF->size());
171
172   const MipsInstrInfo *TII =
173       static_cast<const MipsInstrInfo *>(TM.getSubtargetImpl()->getInstrInfo());
174   for (unsigned I = 0, E = MBBInfos.size(); I < E; ++I) {
175     MachineBasicBlock *MBB = MF->getBlockNumbered(I);
176
177     // Compute size of MBB.
178     for (MachineBasicBlock::instr_iterator MI = MBB->instr_begin();
179          MI != MBB->instr_end(); ++MI)
180       MBBInfos[I].Size += TII->GetInstSizeInBytes(&*MI);
181
182     // Search for MBB's branch instruction.
183     ReverseIter End = MBB->rend();
184     ReverseIter Br = getNonDebugInstr(MBB->rbegin(), End);
185
186     if ((Br != End) && !Br->isIndirectBranch() &&
187         (Br->isConditionalBranch() ||
188          (Br->isUnconditionalBranch() &&
189           TM.getRelocationModel() == Reloc::PIC_)))
190       MBBInfos[I].Br = (++Br).base();
191   }
192 }
193
194 // Compute offset of branch in number of bytes.
195 int64_t MipsLongBranch::computeOffset(const MachineInstr *Br) {
196   int64_t Offset = 0;
197   int ThisMBB = Br->getParent()->getNumber();
198   int TargetMBB = getTargetMBB(*Br)->getNumber();
199
200   // Compute offset of a forward branch.
201   if (ThisMBB < TargetMBB) {
202     for (int N = ThisMBB + 1; N < TargetMBB; ++N)
203       Offset += MBBInfos[N].Size;
204
205     return Offset + 4;
206   }
207
208   // Compute offset of a backward branch.
209   for (int N = ThisMBB; N >= TargetMBB; --N)
210     Offset += MBBInfos[N].Size;
211
212   return -Offset + 4;
213 }
214
215 // Replace Br with a branch which has the opposite condition code and a
216 // MachineBasicBlock operand MBBOpnd.
217 void MipsLongBranch::replaceBranch(MachineBasicBlock &MBB, Iter Br,
218                                    DebugLoc DL, MachineBasicBlock *MBBOpnd) {
219   const MipsInstrInfo *TII =
220       static_cast<const MipsInstrInfo *>(TM.getSubtargetImpl()->getInstrInfo());
221   unsigned NewOpc = TII->getOppositeBranchOpc(Br->getOpcode());
222   const MCInstrDesc &NewDesc = TII->get(NewOpc);
223
224   MachineInstrBuilder MIB = BuildMI(MBB, Br, DL, NewDesc);
225
226   for (unsigned I = 0, E = Br->getDesc().getNumOperands(); I < E; ++I) {
227     MachineOperand &MO = Br->getOperand(I);
228
229     if (!MO.isReg()) {
230       assert(MO.isMBB() && "MBB operand expected.");
231       break;
232     }
233
234     MIB.addReg(MO.getReg());
235   }
236
237   MIB.addMBB(MBBOpnd);
238
239   if (Br->hasDelaySlot()) {
240     // Bundle the instruction in the delay slot to the newly created branch
241     // and erase the original branch.
242     assert(Br->isBundledWithSucc());
243     MachineBasicBlock::instr_iterator II(Br);
244     MIBundleBuilder(&*MIB).append((++II)->removeFromBundle());
245   }
246   Br->eraseFromParent();
247 }
248
249 // Expand branch instructions to long branches.
250 void MipsLongBranch::expandToLongBranch(MBBInfo &I) {
251   MachineBasicBlock::iterator Pos;
252   MachineBasicBlock *MBB = I.Br->getParent(), *TgtMBB = getTargetMBB(*I.Br);
253   DebugLoc DL = I.Br->getDebugLoc();
254   const BasicBlock *BB = MBB->getBasicBlock();
255   MachineFunction::iterator FallThroughMBB = ++MachineFunction::iterator(MBB);
256   MachineBasicBlock *LongBrMBB = MF->CreateMachineBasicBlock(BB);
257
258   const MipsInstrInfo *TII =
259       static_cast<const MipsInstrInfo *>(TM.getSubtargetImpl()->getInstrInfo());
260
261   MF->insert(FallThroughMBB, LongBrMBB);
262   MBB->removeSuccessor(TgtMBB);
263   MBB->addSuccessor(LongBrMBB);
264
265   if (IsPIC) {
266     MachineBasicBlock *BalTgtMBB = MF->CreateMachineBasicBlock(BB);
267     MF->insert(FallThroughMBB, BalTgtMBB);
268     LongBrMBB->addSuccessor(BalTgtMBB);
269     BalTgtMBB->addSuccessor(TgtMBB);
270
271     // We must select between the MIPS32r6/MIPS64r6 BAL (which is a normal
272     // instruction) and the pre-MIPS32r6/MIPS64r6 definition (which is an
273     // pseudo-instruction wrapping BGEZAL).
274
275     const MipsSubtarget &Subtarget = TM.getSubtarget<MipsSubtarget>();
276     unsigned BalOp = Subtarget.hasMips32r6() ? Mips::BAL : Mips::BAL_BR;
277
278     if (!ABI.IsN64()) {
279       // $longbr:
280       //  addiu $sp, $sp, -8
281       //  sw $ra, 0($sp)
282       //  lui $at, %hi($tgt - $baltgt)
283       //  bal $baltgt
284       //  addiu $at, $at, %lo($tgt - $baltgt)
285       // $baltgt:
286       //  addu $at, $ra, $at
287       //  lw $ra, 0($sp)
288       //  jr $at
289       //  addiu $sp, $sp, 8
290       // $fallthrough:
291       //
292
293       Pos = LongBrMBB->begin();
294
295       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::ADDiu), Mips::SP)
296         .addReg(Mips::SP).addImm(-8);
297       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::SW)).addReg(Mips::RA)
298         .addReg(Mips::SP).addImm(0);
299
300       // LUi and ADDiu instructions create 32-bit offset of the target basic
301       // block from the target of BAL instruction.  We cannot use immediate
302       // value for this offset because it cannot be determined accurately when
303       // the program has inline assembly statements.  We therefore use the
304       // relocation expressions %hi($tgt-$baltgt) and %lo($tgt-$baltgt) which
305       // are resolved during the fixup, so the values will always be correct.
306       //
307       // Since we cannot create %hi($tgt-$baltgt) and %lo($tgt-$baltgt)
308       // expressions at this point (it is possible only at the MC layer),
309       // we replace LUi and ADDiu with pseudo instructions
310       // LONG_BRANCH_LUi and LONG_BRANCH_ADDiu, and add both basic
311       // blocks as operands to these instructions.  When lowering these pseudo
312       // instructions to LUi and ADDiu in the MC layer, we will create
313       // %hi($tgt-$baltgt) and %lo($tgt-$baltgt) expressions and add them as
314       // operands to lowered instructions.
315
316       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::LONG_BRANCH_LUi), Mips::AT)
317         .addMBB(TgtMBB).addMBB(BalTgtMBB);
318       MIBundleBuilder(*LongBrMBB, Pos)
319           .append(BuildMI(*MF, DL, TII->get(BalOp)).addMBB(BalTgtMBB))
320           .append(BuildMI(*MF, DL, TII->get(Mips::LONG_BRANCH_ADDiu), Mips::AT)
321                       .addReg(Mips::AT)
322                       .addMBB(TgtMBB)
323                       .addMBB(BalTgtMBB));
324
325       Pos = BalTgtMBB->begin();
326
327       BuildMI(*BalTgtMBB, Pos, DL, TII->get(Mips::ADDu), Mips::AT)
328         .addReg(Mips::RA).addReg(Mips::AT);
329       BuildMI(*BalTgtMBB, Pos, DL, TII->get(Mips::LW), Mips::RA)
330         .addReg(Mips::SP).addImm(0);
331
332       if (!TM.getSubtarget<MipsSubtarget>().isTargetNaCl()) {
333         MIBundleBuilder(*BalTgtMBB, Pos)
334           .append(BuildMI(*MF, DL, TII->get(Mips::JR)).addReg(Mips::AT))
335           .append(BuildMI(*MF, DL, TII->get(Mips::ADDiu), Mips::SP)
336                   .addReg(Mips::SP).addImm(8));
337       } else {
338         // In NaCl, modifying the sp is not allowed in branch delay slot.
339         BuildMI(*BalTgtMBB, Pos, DL, TII->get(Mips::ADDiu), Mips::SP)
340           .addReg(Mips::SP).addImm(8);
341
342         MIBundleBuilder(*BalTgtMBB, Pos)
343           .append(BuildMI(*MF, DL, TII->get(Mips::JR)).addReg(Mips::AT))
344           .append(BuildMI(*MF, DL, TII->get(Mips::NOP)));
345
346         // Bundle-align the target of indirect branch JR.
347         TgtMBB->setAlignment(MIPS_NACL_BUNDLE_ALIGN);
348       }
349     } else {
350       // $longbr:
351       //  daddiu $sp, $sp, -16
352       //  sd $ra, 0($sp)
353       //  daddiu $at, $zero, %hi($tgt - $baltgt)
354       //  dsll $at, $at, 16
355       //  bal $baltgt
356       //  daddiu $at, $at, %lo($tgt - $baltgt)
357       // $baltgt:
358       //  daddu $at, $ra, $at
359       //  ld $ra, 0($sp)
360       //  jr64 $at
361       //  daddiu $sp, $sp, 16
362       // $fallthrough:
363       //
364
365       // We assume the branch is within-function, and that offset is within
366       // +/- 2GB.  High 32 bits will therefore always be zero.
367
368       // Note that this will work even if the offset is negative, because
369       // of the +1 modification that's added in that case.  For example, if the
370       // offset is -1MB (0xFFFFFFFFFFF00000), the computation for %higher is
371       //
372       // 0xFFFFFFFFFFF00000 + 0x80008000 = 0x000000007FF08000
373       //
374       // and the bits [47:32] are zero.  For %highest
375       //
376       // 0xFFFFFFFFFFF00000 + 0x800080008000 = 0x000080007FF08000
377       //
378       // and the bits [63:48] are zero.
379
380       Pos = LongBrMBB->begin();
381
382       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::DADDiu), Mips::SP_64)
383         .addReg(Mips::SP_64).addImm(-16);
384       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::SD)).addReg(Mips::RA_64)
385         .addReg(Mips::SP_64).addImm(0);
386       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::LONG_BRANCH_DADDiu),
387               Mips::AT_64).addReg(Mips::ZERO_64)
388                           .addMBB(TgtMBB, MipsII::MO_ABS_HI).addMBB(BalTgtMBB);
389       BuildMI(*LongBrMBB, Pos, DL, TII->get(Mips::DSLL), Mips::AT_64)
390         .addReg(Mips::AT_64).addImm(16);
391
392       MIBundleBuilder(*LongBrMBB, Pos)
393           .append(BuildMI(*MF, DL, TII->get(BalOp)).addMBB(BalTgtMBB))
394           .append(
395               BuildMI(*MF, DL, TII->get(Mips::LONG_BRANCH_DADDiu), Mips::AT_64)
396                   .addReg(Mips::AT_64)
397                   .addMBB(TgtMBB, MipsII::MO_ABS_LO)
398                   .addMBB(BalTgtMBB));
399
400       Pos = BalTgtMBB->begin();
401
402       BuildMI(*BalTgtMBB, Pos, DL, TII->get(Mips::DADDu), Mips::AT_64)
403         .addReg(Mips::RA_64).addReg(Mips::AT_64);
404       BuildMI(*BalTgtMBB, Pos, DL, TII->get(Mips::LD), Mips::RA_64)
405         .addReg(Mips::SP_64).addImm(0);
406
407       MIBundleBuilder(*BalTgtMBB, Pos)
408         .append(BuildMI(*MF, DL, TII->get(Mips::JR64)).addReg(Mips::AT_64))
409         .append(BuildMI(*MF, DL, TII->get(Mips::DADDiu), Mips::SP_64)
410                 .addReg(Mips::SP_64).addImm(16));
411     }
412
413     assert(LongBrMBB->size() + BalTgtMBB->size() == LongBranchSeqSize);
414   } else {
415     // $longbr:
416     //  j $tgt
417     //  nop
418     // $fallthrough:
419     //
420     Pos = LongBrMBB->begin();
421     LongBrMBB->addSuccessor(TgtMBB);
422     MIBundleBuilder(*LongBrMBB, Pos)
423       .append(BuildMI(*MF, DL, TII->get(Mips::J)).addMBB(TgtMBB))
424       .append(BuildMI(*MF, DL, TII->get(Mips::NOP)));
425
426     assert(LongBrMBB->size() == LongBranchSeqSize);
427   }
428
429   if (I.Br->isUnconditionalBranch()) {
430     // Change branch destination.
431     assert(I.Br->getDesc().getNumOperands() == 1);
432     I.Br->RemoveOperand(0);
433     I.Br->addOperand(MachineOperand::CreateMBB(LongBrMBB));
434   } else
435     // Change branch destination and reverse condition.
436     replaceBranch(*MBB, I.Br, DL, FallThroughMBB);
437 }
438
439 static void emitGPDisp(MachineFunction &F, const MipsInstrInfo *TII) {
440   MachineBasicBlock &MBB = F.front();
441   MachineBasicBlock::iterator I = MBB.begin();
442   DebugLoc DL = MBB.findDebugLoc(MBB.begin());
443   BuildMI(MBB, I, DL, TII->get(Mips::LUi), Mips::V0)
444     .addExternalSymbol("_gp_disp", MipsII::MO_ABS_HI);
445   BuildMI(MBB, I, DL, TII->get(Mips::ADDiu), Mips::V0)
446     .addReg(Mips::V0).addExternalSymbol("_gp_disp", MipsII::MO_ABS_LO);
447   MBB.removeLiveIn(Mips::V0);
448 }
449
450 bool MipsLongBranch::runOnMachineFunction(MachineFunction &F) {
451   const MipsInstrInfo *TII =
452       static_cast<const MipsInstrInfo *>(TM.getSubtargetImpl()->getInstrInfo());
453
454   const MipsSubtarget &STI = TM.getSubtarget<MipsSubtarget>();
455   if (STI.inMips16Mode() || !STI.enableLongBranchPass())
456     return false;
457   if ((TM.getRelocationModel() == Reloc::PIC_) &&
458       TM.getSubtarget<MipsSubtarget>().isABI_O32() &&
459       F.getInfo<MipsFunctionInfo>()->globalBaseRegSet())
460     emitGPDisp(F, TII);
461
462   if (SkipLongBranch)
463     return true;
464
465   MF = &F;
466   initMBBInfo();
467
468   SmallVectorImpl<MBBInfo>::iterator I, E = MBBInfos.end();
469   bool EverMadeChange = false, MadeChange = true;
470
471   while (MadeChange) {
472     MadeChange = false;
473
474     for (I = MBBInfos.begin(); I != E; ++I) {
475       // Skip if this MBB doesn't have a branch or the branch has already been
476       // converted to a long branch.
477       if (!I->Br || I->HasLongBranch)
478         continue;
479
480       int ShVal = TM.getSubtarget<MipsSubtarget>().inMicroMipsMode() ? 2 : 4;
481       int64_t Offset = computeOffset(I->Br) / ShVal;
482
483       if (TM.getSubtarget<MipsSubtarget>().isTargetNaCl()) {
484         // The offset calculation does not include sandboxing instructions
485         // that will be added later in the MC layer.  Since at this point we
486         // don't know the exact amount of code that "sandboxing" will add, we
487         // conservatively estimate that code will not grow more than 100%.
488         Offset *= 2;
489       }
490
491       // Check if offset fits into 16-bit immediate field of branches.
492       if (!ForceLongBranch && isInt<16>(Offset))
493         continue;
494
495       I->HasLongBranch = true;
496       I->Size += LongBranchSeqSize * 4;
497       ++LongBranches;
498       EverMadeChange = MadeChange = true;
499     }
500   }
501
502   if (!EverMadeChange)
503     return true;
504
505   // Compute basic block addresses.
506   if (TM.getRelocationModel() == Reloc::PIC_) {
507     uint64_t Address = 0;
508
509     for (I = MBBInfos.begin(); I != E; Address += I->Size, ++I)
510       I->Address = Address;
511   }
512
513   // Do the expansion.
514   for (I = MBBInfos.begin(); I != E; ++I)
515     if (I->HasLongBranch)
516       expandToLongBranch(*I);
517
518   MF->RenumberBlocks();
519
520   return true;
521 }