lib/Target/PowerPC/PPCBranchSelector.cpp

   1 //===-- PowerPCBranchSelector.cpp - Emit long conditional branches-*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Nate Baegeman and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a pass that scans a machine function to determine which
  11 // conditional branches need more than 16 bits of displacement to reach their
  12 // target basic block.  It does this in two passes; a calculation of basic block
  13 // positions pass, and a branch psuedo op to machine branch opcode pass.  This
  14 // pass should be run last, just before the assembly printer.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #define DEBUG_TYPE "bsel"
  19 #include "PowerPC.h"
  20 #include "PowerPCInstrBuilder.h"
  21 #include "PPC32InstrInfo.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/Support/Debug.h"
  24 #include <map>
  25 using namespace llvm;
  26
  27 namespace {
  28   struct BSel : public MachineFunctionPass {
  29     // OffsetMap - Mapping between BB and byte offset from start of function
  30     std::map<MachineBasicBlock*, unsigned> OffsetMap;
  31
  32     /// bytesForOpcode - A convenience function for totalling up the number of
  33     /// bytes in a basic block.
  34     ///
  35     static unsigned bytesForOpcode(unsigned opcode) {
  36       switch (opcode) {
  37       case PPC::COND_BRANCH:
  38         // while this will be 4 most of the time, if we emit 12 it is just a
  39         // minor pessimization that saves us from having to worry about
  40         // keeping the offsets up to date later when we emit long branch glue.
  41         return 12;
  42       case PPC::IMPLICIT_DEF_GPR: // no asm emitted
  43       case PPC::IMPLICIT_DEF_F4: // no asm emitted
  44       case PPC::IMPLICIT_DEF_F8: // no asm emitted
  45         return 0;
  46       default:
  47         break;
  48       }
  49       return 4; // PowerPC instructions are all 4 bytes
  50     }
  51
  52     virtual bool runOnMachineFunction(MachineFunction &Fn) {
  53       // Running total of instructions encountered since beginning of function
  54       unsigned ByteCount = 0;
  55
  56       // For each MBB, add its offset to the offset map, and count up its
  57       // instructions
  58       for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
  59            ++MFI) {
  60         MachineBasicBlock *MBB = MFI;
  61         OffsetMap[MBB] = ByteCount;
  62
  63         for (MachineBasicBlock::iterator MBBI = MBB->begin(), EE = MBB->end();
  64              MBBI != EE; ++MBBI)
  65           ByteCount += bytesForOpcode(MBBI->getOpcode());
  66       }
  67
  68       // We're about to run over the MBB's again, so reset the ByteCount
  69       ByteCount = 0;
  70
  71       // For each MBB, find the conditional branch pseudo instructions, and
  72       // calculate the difference between the target MBB and the current ICount
  73       // to decide whether or not to emit a short or long branch.
  74       //
  75       // short branch:
  76       // bCC .L_TARGET_MBB
  77       //
  78       // long branch:
  79       // bInverseCC $PC+8
  80       // b .L_TARGET_MBB
  81       // b .L_FALLTHROUGH_MBB
  82
  83       for (MachineFunction::iterator MFI = Fn.begin(), E = Fn.end(); MFI != E;
  84            ++MFI) {
  85         MachineBasicBlock *MBB = MFI;
  86
  87         for (MachineBasicBlock::iterator MBBI = MBB->begin(), EE = MBB->end();
  88              MBBI != EE; ++MBBI) {
  89           // We may end up deleting the MachineInstr that MBBI points to, so
  90           // remember its opcode now so we can refer to it after calling erase()
  91           unsigned OpcodeToReplace = MBBI->getOpcode();
  92
  93           if (OpcodeToReplace == PPC::COND_BRANCH) {
  94             MachineBasicBlock::iterator MBBJ = MBBI;
  95             ++MBBJ;
  96
  97             // condbranch operands:
  98             // 0. CR0 register
  99             // 1. bc opcode
 100             // 2. target MBB
 101             // 3. fallthrough MBB
 102             MachineBasicBlock *trueMBB =
 103               MBBI->getOperand(2).getMachineBasicBlock();
 104             MachineBasicBlock *falseMBB =
 105               MBBI->getOperand(3).getMachineBasicBlock();
 106
 107             int Displacement = OffsetMap[trueMBB] - ByteCount;
 108             unsigned Opcode = MBBI->getOperand(1).getImmedValue();
 109             unsigned CRReg = MBBI->getOperand(0).getReg();
 110             unsigned Inverted = PPC32InstrInfo::invertPPCBranchOpcode(Opcode);
 111
 112             if (Displacement >= -32768 && Displacement <= 32767) {
 113               BuildMI(*MBB, MBBJ, Opcode, 2).addReg(CRReg).addMBB(trueMBB);
 114             } else {
 115               BuildMI(*MBB, MBBJ, Inverted, 2).addReg(CRReg).addSImm(8);
 116               BuildMI(*MBB, MBBJ, PPC::B, 1).addMBB(trueMBB);
 117               BuildMI(*MBB, MBBJ, PPC::B, 1).addMBB(falseMBB);
 118             }
 119
 120             // Erase the psuedo COND_BRANCH instruction, and then back up the
 121             // iterator so that when the for loop increments it, we end up in
 122             // the correct place rather than iterating off the end.
 123             MBB->erase(MBBI);
 124             MBBI = --MBBJ;
 125           }
 126           ByteCount += bytesForOpcode(OpcodeToReplace);
 127         }
 128       }
 129
 130       OffsetMap.clear();
 131       return true;
 132     }
 133
 134     virtual const char *getPassName() const {
 135       return "PowerPC Branch Selection";
 136     }
 137   };
 138 }
 139
 140 /// createPPCBranchSelectionPass - returns an instance of the Branch Selection
 141 /// Pass
 142 ///
 143 FunctionPass *llvm::createPPCBranchSelectionPass() {
 144   return new BSel();
 145 }