lib/Target/SparcV9/InstrSelection/InstrSelection.cpp

   1 //===- InstrSelection.cpp - Machine Independant Inst Selection Driver -----===//
   2 //
   3 // Machine-independent driver file for instruction selection.  This file
   4 // constructs a forest of BURG instruction trees and then uses the
   5 // BURG-generated tree grammar (BURM) to find the optimal instruction sequences
   6 // for a given machine.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/CodeGen/InstrSelection.h"
  11 #include "llvm/CodeGen/InstrSelectionSupport.h"
  12 #include "llvm/CodeGen/InstrForest.h"
  13 #include "llvm/CodeGen/MachineCodeForInstruction.h"
  14 #include "llvm/CodeGen/MachineFunction.h"
  15 #include "llvm/Target/MachineRegInfo.h"
  16 #include "llvm/Target/TargetMachine.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/iPHINode.h"
  19 #include "llvm/Pass.h"
  20 #include "Support/CommandLine.h"
  21 #include "Support/LeakDetector.h"
  22 using std::cerr;
  23 using std::vector;
  24
  25 namespace {
  26   //===--------------------------------------------------------------------===//
  27   // SelectDebugLevel - Allow command line control over debugging.
  28   //
  29   enum SelectDebugLevel_t {
  30     Select_NoDebugInfo,
  31     Select_PrintMachineCode,
  32     Select_DebugInstTrees,
  33     Select_DebugBurgTrees,
  34   };
  35
  36   // Enable Debug Options to be specified on the command line
  37   cl::opt<SelectDebugLevel_t>
  38   SelectDebugLevel("dselect", cl::Hidden,
  39                    cl::desc("enable instruction selection debug information"),
  40                    cl::values(
  41      clEnumValN(Select_NoDebugInfo,      "n", "disable debug output"),
  42      clEnumValN(Select_PrintMachineCode, "y", "print generated machine code"),
  43      clEnumValN(Select_DebugInstTrees,   "i",
  44                 "print debugging info for instruction selection"),
  45      clEnumValN(Select_DebugBurgTrees,   "b", "print burg trees"),
  46                               0));
  47
  48
  49   //===--------------------------------------------------------------------===//
  50   //  InstructionSelection Pass
  51   //
  52   // This is the actual pass object that drives the instruction selection
  53   // process.
  54   //
  55   class InstructionSelection : public FunctionPass {
  56     TargetMachine &Target;
  57     void InsertCodeForPhis(Function &F);
  58     void InsertPhiElimInstructions(BasicBlock *BB,
  59                                    const vector<MachineInstr*>& CpVec);
  60     void SelectInstructionsForTree(InstrTreeNode* treeRoot, int goalnt);
  61     void PostprocessMachineCodeForTree(InstructionNode* instrNode,
  62                                        int ruleForNode, short* nts);
  63   public:
  64     InstructionSelection(TargetMachine &T) : Target(T) {}
  65
  66     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  67       AU.setPreservesCFG();
  68     }
  69
  70     bool runOnFunction(Function &F);
  71   };
  72 }
  73
  74 // Register the pass...
  75 static RegisterLLC<InstructionSelection>
  76 X("instselect", "Instruction Selection", createInstructionSelectionPass);
  77
  78 TmpInstruction::TmpInstruction(Value *s1, Value *s2, const std::string &name)
  79   : Instruction(s1->getType(), Instruction::UserOp1, name) {
  80   Operands.push_back(Use(s1, this));  // s1 must be nonnull
  81   if (s2) {
  82     Operands.push_back(Use(s2, this));
  83   }
  84
  85   // TmpInstructions should not be garbage checked.
  86   LeakDetector::removeGarbageObject(this);
  87 }
  88
  89 // Constructor that requires the type of the temporary to be specified.
  90 // Both S1 and S2 may be NULL.(
  91 TmpInstruction::TmpInstruction(const Type *Ty, Value *s1, Value* s2,
  92                                const std::string &name)
  93   : Instruction(Ty, Instruction::UserOp1, name) {
  94   if (s1) { Operands.push_back(Use(s1, this)); }
  95   if (s2) { Operands.push_back(Use(s2, this)); }
  96
  97   // TmpInstructions should not be garbage checked.
  98   LeakDetector::removeGarbageObject(this);
  99 }
 100
 101
 102 bool InstructionSelection::runOnFunction(Function &F)
 103 {
 104   //
 105   // Build the instruction trees to be given as inputs to BURG.
 106   //
 107   InstrForest instrForest(&F);
 108
 109   if (SelectDebugLevel >= Select_DebugInstTrees)
 110     {
 111       cerr << "\n\n*** Input to instruction selection for function "
 112            << F.getName() << "\n\n" << F
 113            << "\n\n*** Instruction trees for function "
 114            << F.getName() << "\n\n";
 115       instrForest.dump();
 116     }
 117
 118   //
 119   // Invoke BURG instruction selection for each tree
 120   //
 121   for (InstrForest::const_root_iterator RI = instrForest.roots_begin();
 122        RI != instrForest.roots_end(); ++RI)
 123     {
 124       InstructionNode* basicNode = *RI;
 125       assert(basicNode->parent() == NULL && "A `root' node has a parent?");
 126
 127       // Invoke BURM to label each tree node with a state
 128       burm_label(basicNode);
 129
 130       if (SelectDebugLevel >= Select_DebugBurgTrees)
 131         {
 132           printcover(basicNode, 1, 0);
 133           cerr << "\nCover cost == " << treecost(basicNode, 1, 0) << "\n\n";
 134           printMatches(basicNode);
 135         }
 136
 137       // Then recursively walk the tree to select instructions
 138       SelectInstructionsForTree(basicNode, /*goalnt*/1);
 139     }
 140
 141   //
 142   // Create the MachineBasicBlock records and add all of the MachineInstrs
 143   // defined in the MachineCodeForInstruction objects to also live in the
 144   // MachineBasicBlock objects.
 145   //
 146   MachineFunction &MF = MachineFunction::get(&F);
 147   for (Function::iterator BI = F.begin(), BE = F.end(); BI != BE; ++BI) {
 148     MachineBasicBlock *MCBB = new MachineBasicBlock(BI);
 149     MF.getBasicBlockList().push_back(MCBB);
 150
 151     for (BasicBlock::iterator II = BI->begin(); II != BI->end(); ++II) {
 152       MachineCodeForInstruction &mvec = MachineCodeForInstruction::get(II);
 153       MCBB->insert(MCBB->end(), mvec.begin(), mvec.end());
 154     }
 155   }
 156
 157   // Insert phi elimination code
 158   InsertCodeForPhis(F);
 159
 160   if (SelectDebugLevel >= Select_PrintMachineCode)
 161     {
 162       cerr << "\n*** Machine instructions after INSTRUCTION SELECTION\n";
 163       MachineFunction::get(&F).dump();
 164     }
 165
 166   return true;
 167 }
 168
 169
 170 //-------------------------------------------------------------------------
 171 // This method inserts phi elimination code for all BBs in a method
 172 //-------------------------------------------------------------------------
 173
 174 void
 175 InstructionSelection::InsertCodeForPhis(Function &F)
 176 {
 177   // for all basic blocks in function
 178   //
 179   for (Function::iterator BB = F.begin(); BB != F.end(); ++BB) {
 180     BasicBlock::InstListType &InstList = BB->getInstList();
 181     for (BasicBlock::iterator IIt = InstList.begin();
 182          PHINode *PN = dyn_cast<PHINode>(&*IIt); ++IIt) {
 183       // FIXME: This is probably wrong...
 184       Value *PhiCpRes = new PHINode(PN->getType(), "PhiCp:");
 185
 186       // The leak detector shouldn't track these nodes.  They are not garbage,
 187       // even though their parent field is never filled in.
 188       //
 189       LeakDetector::removeGarbageObject(PhiCpRes);
 190
 191       // for each incoming value of the phi, insert phi elimination
 192       //
 193       for (unsigned i = 0; i < PN->getNumIncomingValues(); ++i) {
 194         // insert the copy instruction to the predecessor BB
 195         vector<MachineInstr*> mvec, CpVec;
 196         Target.getRegInfo().cpValue2Value(PN->getIncomingValue(i), PhiCpRes,
 197                                           mvec);
 198         for (vector<MachineInstr*>::iterator MI=mvec.begin();
 199              MI != mvec.end(); ++MI) {
 200           vector<MachineInstr*> CpVec2 =
 201             FixConstantOperandsForInstr(PN, *MI, Target);
 202           CpVec2.push_back(*MI);
 203           CpVec.insert(CpVec.end(), CpVec2.begin(), CpVec2.end());
 204         }
 205
 206         InsertPhiElimInstructions(PN->getIncomingBlock(i), CpVec);
 207       }
 208
 209       vector<MachineInstr*> mvec;
 210       Target.getRegInfo().cpValue2Value(PhiCpRes, PN, mvec);
 211
 212       // get an iterator to machine instructions in the BB
 213       MachineBasicBlock& bbMvec = MachineBasicBlock::get(BB);
 214
 215       bbMvec.insert(bbMvec.begin(), mvec.begin(), mvec.end());
 216     }  // for each Phi Instr in BB
 217   } // for all BBs in function
 218 }
 219
 220 //-------------------------------------------------------------------------
 221 // Thid method inserts a copy instruction to a predecessor BB as a result
 222 // of phi elimination.
 223 //-------------------------------------------------------------------------
 224
 225 void
 226 InstructionSelection::InsertPhiElimInstructions(BasicBlock *BB,
 227                                                 const vector<MachineInstr*>& CpVec)
 228 {
 229   Instruction *TermInst = (Instruction*)BB->getTerminator();
 230   MachineCodeForInstruction &MC4Term = MachineCodeForInstruction::get(TermInst);
 231   MachineInstr *FirstMIOfTerm = MC4Term.front();
 232
 233   assert (FirstMIOfTerm && "No Machine Instrs for terminator");
 234
 235   MachineBasicBlock &bbMvec = MachineBasicBlock::get(BB);
 236
 237   // find the position of first machine instruction generated by the
 238   // terminator of this BB
 239   MachineBasicBlock::iterator MCIt =
 240     std::find(bbMvec.begin(), bbMvec.end(), FirstMIOfTerm);
 241
 242   assert( MCIt != bbMvec.end() && "Start inst of terminator not found");
 243
 244   // insert the copy instructions just before the first machine instruction
 245   // generated for the terminator
 246   bbMvec.insert(MCIt, CpVec.begin(), CpVec.end());
 247 }
 248
 249
 250 //---------------------------------------------------------------------------
 251 // Function SelectInstructionsForTree
 252 //
 253 // Recursively walk the tree to select instructions.
 254 // Do this top-down so that child instructions can exploit decisions
 255 // made at the child instructions.
 256 //
 257 // E.g., if br(setle(reg,const)) decides the constant is 0 and uses
 258 // a branch-on-integer-register instruction, then the setle node
 259 // can use that information to avoid generating the SUBcc instruction.
 260 //
 261 // Note that this cannot be done bottom-up because setle must do this
 262 // only if it is a child of the branch (otherwise, the result of setle
 263 // may be used by multiple instructions).
 264 //---------------------------------------------------------------------------
 265
 266 void
 267 InstructionSelection::SelectInstructionsForTree(InstrTreeNode* treeRoot,
 268                                                 int goalnt)
 269 {
 270   // Get the rule that matches this node.
 271   //
 272   int ruleForNode = burm_rule(treeRoot->state, goalnt);
 273
 274   if (ruleForNode == 0) {
 275     cerr << "Could not match instruction tree for instr selection\n";
 276     abort();
 277   }
 278
 279   // Get this rule's non-terminals and the corresponding child nodes (if any)
 280   //
 281   short *nts = burm_nts[ruleForNode];
 282
 283   // First, select instructions for the current node and rule.
 284   // (If this is a list node, not an instruction, then skip this step).
 285   // This function is specific to the target architecture.
 286   //
 287   if (treeRoot->opLabel != VRegListOp)
 288     {
 289       vector<MachineInstr*> minstrVec;
 290
 291       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 292       assert(instrNode->getNodeType() == InstrTreeNode::NTInstructionNode);
 293
 294       GetInstructionsByRule(instrNode, ruleForNode, nts, Target, minstrVec);
 295
 296       MachineCodeForInstruction &mvec =
 297         MachineCodeForInstruction::get(instrNode->getInstruction());
 298       mvec.insert(mvec.end(), minstrVec.begin(), minstrVec.end());
 299     }
 300
 301   // Then, recursively compile the child nodes, if any.
 302   //
 303   if (nts[0])
 304     { // i.e., there is at least one kid
 305       InstrTreeNode* kids[2];
 306       int currentRule = ruleForNode;
 307       burm_kids(treeRoot, currentRule, kids);
 308
 309       // First skip over any chain rules so that we don't visit
 310       // the current node again.
 311       //
 312       while (ThisIsAChainRule(currentRule))
 313         {
 314           currentRule = burm_rule(treeRoot->state, nts[0]);
 315           nts = burm_nts[currentRule];
 316           burm_kids(treeRoot, currentRule, kids);
 317         }
 318
 319       // Now we have the first non-chain rule so we have found
 320       // the actual child nodes.  Recursively compile them.
 321       //
 322       for (unsigned i = 0; nts[i]; i++)
 323         {
 324           assert(i < 2);
 325           InstrTreeNode::InstrTreeNodeType nodeType = kids[i]->getNodeType();
 326           if (nodeType == InstrTreeNode::NTVRegListNode ||
 327               nodeType == InstrTreeNode::NTInstructionNode)
 328             SelectInstructionsForTree(kids[i], nts[i]);
 329         }
 330     }
 331
 332   // Finally, do any postprocessing on this node after its children
 333   // have been translated
 334   //
 335   if (treeRoot->opLabel != VRegListOp)
 336     PostprocessMachineCodeForTree((InstructionNode*)treeRoot, ruleForNode, nts);
 337 }
 338
 339 //---------------------------------------------------------------------------
 340 // Function PostprocessMachineCodeForTree
 341 //
 342 // Apply any final cleanups to machine code for the root of a subtree
 343 // after selection for all its children has been completed.
 344 //
 345 void
 346 InstructionSelection::PostprocessMachineCodeForTree(InstructionNode* instrNode,
 347                                                     int ruleForNode,
 348                                                     short* nts)
 349 {
 350   // Fix up any constant operands in the machine instructions to either
 351   // use an immediate field or to load the constant into a register
 352   // Walk backwards and use direct indexes to allow insertion before current
 353   //
 354   Instruction* vmInstr = instrNode->getInstruction();
 355   MachineCodeForInstruction &mvec = MachineCodeForInstruction::get(vmInstr);
 356   for (unsigned i = mvec.size(); i != 0; --i)
 357     {
 358       vector<MachineInstr*> loadConstVec =
 359         FixConstantOperandsForInstr(vmInstr, mvec[i-1], Target);
 360
 361       mvec.insert(mvec.begin()+i-1, loadConstVec.begin(), loadConstVec.end());
 362     }
 363 }
 364
 365
 366
 367 //===----------------------------------------------------------------------===//
 368 // createInstructionSelectionPass - Public entrypoint for instruction selection
 369 // and this file as a whole...
 370 //
 371 Pass *createInstructionSelectionPass(TargetMachine &T) {
 372   return new InstructionSelection(T);
 373 }
 374