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