lib/Target/SparcV9/SparcV9PreSelection.cpp

   1 //===- SparcV9PreSelection.cpp - Specialize LLVM code for SparcV9 ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the PreSelection pass which specializes LLVM code for
  11 // the SparcV9 instruction selector, while remaining in legal portable LLVM
  12 // form and preserving type information and type safety. This is meant to enable
  13 // dataflow optimizations on SparcV9-specific operations such as accesses to
  14 // constants, globals, and array indexing.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "SparcV9Internals.h"
  19 #include "SparcV9BurgISel.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/Instructions.h"
  23 #include "llvm/Module.h"
  24 #include "llvm/Pass.h"
  25 #include "llvm/Support/InstVisitor.h"
  26 #include "llvm/Support/GetElementPtrTypeIterator.h"
  27 #include "llvm/Target/TargetInstrInfo.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Transforms/Scalar.h"
  30 #include <algorithm>
  31 using namespace llvm;
  32
  33 namespace {
  34
  35   //===--------------------------------------------------------------------===//
  36   // PreSelection Pass - Specialize LLVM code for the SparcV9 instr. selector.
  37   //
  38   class PreSelection : public FunctionPass, public InstVisitor<PreSelection> {
  39     const TargetInstrInfo &instrInfo;
  40
  41   public:
  42     PreSelection(const TargetMachine &T)
  43       : instrInfo(*T.getInstrInfo()) {}
  44
  45     // runOnFunction - apply this pass to each Function
  46     bool runOnFunction(Function &F) {
  47       visit(F);
  48       return true;
  49     }
  50     const char *getPassName() const { return "SparcV9 Instr. Pre-selection"; }
  51
  52     // These methods do the actual work of specializing code
  53     void visitInstruction(Instruction &I);   // common work for every instr.
  54     void visitGetElementPtrInst(GetElementPtrInst &I);
  55     void visitCallInst(CallInst &I);
  56     void visitPHINode(PHINode &PN);
  57
  58     // Helper functions for visiting operands of every instruction
  59     //
  60     // visitOperands() works on every operand in [firstOp, lastOp-1].
  61     // If lastOp==0, lastOp defaults to #operands or #incoming Phi values.
  62     //
  63     // visitOneOperand() does all the work for one operand.
  64     //
  65     void visitOperands(Instruction &I, int firstOp=0);
  66     void visitOneOperand(Instruction &I, Value* Op, unsigned opNum,
  67                          Instruction& insertBefore);
  68   };
  69
  70 #if 0
  71   // Register the pass...
  72   RegisterPass<PreSelection> X("preselect",
  73                                "Specialize LLVM code for a target machine"
  74                                createPreselectionPass);
  75 #endif
  76
  77 }  // end anonymous namespace
  78
  79
  80 //------------------------------------------------------------------------------
  81 // Helper functions used by methods of class PreSelection
  82 //------------------------------------------------------------------------------
  83
  84
  85 // getGlobalAddr(): Put address of a global into a v. register.
  86 static GetElementPtrInst* getGlobalAddr(Value* ptr, Instruction& insertBefore) {
  87
  88   return (isa<GlobalVariable>(ptr))
  89     ? new GetElementPtrInst(ptr,
  90                     std::vector<Value*>(1, ConstantSInt::get(Type::LongTy, 0U)),
  91                     "addrOfGlobal:" + ptr->getName(), &insertBefore)
  92     : NULL;
  93 }
  94
  95 // Wrapper on Constant::classof to use in find_if
  96 inline static bool nonConstant(const Use& U) {
  97   return ! isa<Constant>(U);
  98 }
  99
 100 static Instruction* DecomposeConstantExpr(ConstantExpr* CE,
 101                                           Instruction& insertBefore)
 102 {
 103   Value *getArg1, *getArg2;
 104
 105   switch(CE->getOpcode())
 106     {
 107     case Instruction::Cast:
 108       getArg1 = CE->getOperand(0);
 109       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr>(getArg1))
 110         getArg1 = DecomposeConstantExpr(CEarg, insertBefore);
 111       return new CastInst(getArg1, CE->getType(), "constantCast",&insertBefore);
 112
 113     case Instruction::GetElementPtr:
 114       assert(find_if(CE->op_begin()+1, CE->op_end(),nonConstant) == CE->op_end()
 115              && "All indices in ConstantExpr getelementptr must be constant!");
 116       getArg1 = CE->getOperand(0);
 117       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr>(getArg1))
 118         getArg1 = DecomposeConstantExpr(CEarg, insertBefore);
 119       else if (GetElementPtrInst* gep = getGlobalAddr(getArg1, insertBefore))
 120         getArg1 = gep;
 121       return new GetElementPtrInst(getArg1,
 122                           std::vector<Value*>(CE->op_begin()+1, CE->op_end()),
 123                           "constantGEP:" + getArg1->getName(), &insertBefore);
 124
 125     case Instruction::Select: {
 126       Value *C, *S1, *S2;
 127       C = CE->getOperand (0);
 128       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr> (C))
 129         C = DecomposeConstantExpr (CEarg, insertBefore);
 130       S1 = CE->getOperand (1);
 131       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr> (S1))
 132         S1 = DecomposeConstantExpr (CEarg, insertBefore);
 133       S2 = CE->getOperand (2);
 134       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr> (S2))
 135         S2 = DecomposeConstantExpr (CEarg, insertBefore);
 136       return new SelectInst (C, S1, S2, "constantSelect", &insertBefore);
 137     }
 138
 139     default:                            // must be a binary operator
 140       assert(CE->getOpcode() >= Instruction::BinaryOpsBegin &&
 141              CE->getOpcode() <  Instruction::BinaryOpsEnd &&
 142              "Unhandled opcode in ConstantExpr");
 143       getArg1 = CE->getOperand(0);
 144       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr>(getArg1))
 145         getArg1 = DecomposeConstantExpr(CEarg, insertBefore);
 146       getArg2 = CE->getOperand(1);
 147       if (ConstantExpr* CEarg = dyn_cast<ConstantExpr>(getArg2))
 148         getArg2 = DecomposeConstantExpr(CEarg, insertBefore);
 149       return BinaryOperator::create((Instruction::BinaryOps) CE->getOpcode(),
 150                                     getArg1, getArg2,
 151                                     "constantBinaryOp", &insertBefore);
 152     }
 153 }
 154
 155 static inline bool ConstantTypeMustBeLoaded(const Type* CVT) {
 156   assert(CVT->isPrimitiveType() || isa<PointerType>(CVT));
 157   return !(CVT->isIntegral() || isa<PointerType>(CVT));
 158 }
 159
 160 //------------------------------------------------------------------------------
 161 // Instruction visitor methods to perform instruction-specific operations
 162 //------------------------------------------------------------------------------
 163 inline void
 164 PreSelection::visitOneOperand(Instruction &I, Value* Op, unsigned opNum,
 165                               Instruction& insertBefore)
 166 {
 167   assert(&insertBefore != NULL && "Must have instruction to insert before.");
 168
 169   if (GetElementPtrInst* gep = getGlobalAddr(Op, insertBefore)) {
 170     I.setOperand(opNum, gep);           // replace global operand
 171     return;                             // nothing more to do for this op.
 172   }
 173
 174   Constant* CV  = dyn_cast<Constant>(Op);
 175   if (CV == NULL)
 176     return;
 177
 178   if (ConstantExpr* CE = dyn_cast<ConstantExpr>(CV)) {
 179     // load-time constant: factor it out so we optimize as best we can
 180     Instruction* computeConst = DecomposeConstantExpr(CE, insertBefore);
 181     I.setOperand(opNum, computeConst); // replace expr operand with result
 182   } else if (ConstantTypeMustBeLoaded(CV->getType())) {
 183     // load address of constant into a register, then load the constant
 184     // this is now done during instruction selection
 185     // the constant will live in the MachineConstantPool later on
 186   } else if (ConstantMayNotFitInImmedField(CV, &I)) {
 187     // put the constant into a virtual register using a cast
 188     CastInst* castI = new CastInst(CV, CV->getType(), "copyConst",
 189                                    &insertBefore);
 190     I.setOperand(opNum, castI);      // replace operand with copy in v.reg.
 191   }
 192 }
 193
 194 /// visitOperands - transform individual operands of all instructions:
 195 /// -- Load "large" int constants into a virtual register.  What is large
 196 ///    depends on the type of instruction and on the target architecture.
 197 /// -- For any constants that cannot be put in an immediate field,
 198 ///    load address into virtual register first, and then load the constant.
 199 ///
 200 /// firstOp and lastOp can be used to skip leading and trailing operands.
 201 /// If lastOp is 0, it defaults to #operands or #incoming Phi values.
 202 ///
 203 inline void PreSelection::visitOperands(Instruction &I, int firstOp) {
 204   // For any instruction other than PHI, copies go just before the instr.
 205   for (unsigned i = firstOp, e = I.getNumOperands(); i != e; ++i)
 206     visitOneOperand(I, I.getOperand(i), i, I);
 207 }
 208
 209
 210 void PreSelection::visitPHINode(PHINode &PN) {
 211   // For a PHI, operand copies must be before the terminator of the
 212   // appropriate predecessor basic block.  Remaining logic is simple
 213   // so just handle PHIs and other instructions separately.
 214   //
 215   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 216     visitOneOperand(PN, PN.getIncomingValue(i),
 217                     PN.getOperandNumForIncomingValue(i),
 218                     *PN.getIncomingBlock(i)->getTerminator());
 219   // do not call visitOperands!
 220 }
 221
 222 // Common work for *all* instructions.  This needs to be called explicitly
 223 // by other visit<InstructionType> functions.
 224 inline void PreSelection::visitInstruction(Instruction &I) {
 225   visitOperands(I);              // Perform operand transformations
 226 }
 227
 228 // GetElementPtr instructions: check if pointer is a global
 229 void PreSelection::visitGetElementPtrInst(GetElementPtrInst &I) {
 230   Instruction* curI = &I;
 231
 232   // The Sparc backend doesn't handle array indexes that are not long types, so
 233   // insert a cast from whatever it is to long, if the sequential type index is
 234   // not a long already.
 235   unsigned Idx = 1;
 236   for (gep_type_iterator TI = gep_type_begin(I), E = gep_type_end(I); TI != E;
 237        ++TI, ++Idx)
 238     if (isa<SequentialType>(*TI) &&
 239         I.getOperand(Idx)->getType() != Type::LongTy) {
 240       Value *Op = I.getOperand(Idx);
 241       if (Op->getType()->isUnsigned())    // Must sign extend!
 242         Op = new CastInst(Op, Op->getType()->getSignedVersion(), "v9", &I);
 243       if (Op->getType() != Type::LongTy)
 244         Op = new CastInst(Op, Type::LongTy, "v9", &I);
 245       I.setOperand(Idx, Op);
 246     }
 247
 248
 249   // Decompose multidimensional array references
 250   if (I.getNumIndices() >= 2) {
 251     // DecomposeArrayRef() replaces I and deletes it, if successful,
 252     // so remember predecessor in order to find the replacement instruction.
 253     // Also remember the basic block in case there is no predecessor.
 254     Instruction* prevI = I.getPrev();
 255     BasicBlock* bb = I.getParent();
 256     if (DecomposeArrayRef(&I))
 257       // first instr. replacing I
 258       curI = cast<GetElementPtrInst>(prevI? prevI->getNext() : &bb->front());
 259   }
 260
 261   // Perform other transformations common to all instructions
 262   visitInstruction(*curI);
 263 }
 264
 265 void PreSelection::visitCallInst(CallInst &I) {
 266   // Tell visitOperands to ignore the function name if this is a direct call.
 267   visitOperands(I, (/*firstOp=*/ I.getCalledFunction()? 1 : 0));
 268 }
 269
 270 /// createPreSelectionPass - Public entry point for the PreSelection pass
 271 ///
 272 FunctionPass* llvm::createPreSelectionPass(const TargetMachine &TM) {
 273   return new PreSelection(TM);
 274 }