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