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: // no asm emitted
  44         return 0;
  45         break;
  46       default:
  47         return 4; // PowerPC instructions are all 4 bytes
  48         break;
  49       }
  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           if (MBBI->getOpcode() == PPC::COND_BRANCH) {
  90             // condbranch operands:
  91             // 0. CR0 register
  92             // 1. bc opcode
  93             // 2. target MBB
  94             // 3. fallthrough MBB
  95             MachineBasicBlock *trueMBB =
  96               MBBI->getOperand(2).getMachineBasicBlock();
  97             MachineBasicBlock *falseMBB =
  98               MBBI->getOperand(3).getMachineBasicBlock();
  99
 100             int Displacement = OffsetMap[trueMBB] - ByteCount;
 101             unsigned Opcode = MBBI->getOperand(1).getImmedValue();
 102             unsigned Inverted = PPC32InstrInfo::invertPPCBranchOpcode(Opcode);
 103
 104             MachineInstr *MI = MBBI;
 105             if (Displacement >= -32768 && Displacement <= 32767) {
 106               BuildMI(*MBB, MBBI, Opcode, 2).addReg(PPC::CR0).addMBB(trueMBB);
 107             } else {
 108               BuildMI(*MBB, MBBI, Inverted, 2).addReg(PPC::CR0).addSImm(8);
 109               BuildMI(*MBB, MBBI, PPC::B, 1).addMBB(trueMBB);
 110               BuildMI(*MBB, MBBI, PPC::B, 1).addMBB(falseMBB);
 111             }
 112             MBB->erase(MI);
 113           }
 114           ByteCount += bytesForOpcode(MBBI->getOpcode());
 115         }
 116       }
 117
 118       OffsetMap.clear();
 119       return true;
 120     }
 121
 122     virtual const char *getPassName() const {
 123       return "PowerPC Branch Selection";
 124     }
 125   };
 126 }
 127
 128 /// createPPCBranchSelectionPass - returns an instance of the Branch Selection
 129 /// Pass
 130 ///
 131 FunctionPass *llvm::createPPCBranchSelectionPass() {
 132   return new BSel();
 133 }