lib/Target/SparcV9/InstrSelection/InstrSelection.cpp

   1 // $Id$ -*-c++-*-
   2 //***************************************************************************
   3 // File:
   4 //      InstrSelection.cpp
   5 //
   6 // Purpose:
   7 //      Machine-independent driver file for instruction selection.
   8 //      This file constructs a forest of BURG instruction trees and then
   9 //      uses the BURG-generated tree grammar (BURM) to find the optimal
  10 //      instruction sequences for a given machine.
  11 //
  12 // History:
  13 //      7/02/01  -  Vikram Adve  -  Created
  14 //**************************************************************************/
  15
  16
  17 #include "llvm/CodeGen/InstrSelection.h"
  18 #include "llvm/CodeGen/InstrSelectionSupport.h"
  19 #include "llvm/CodeGen/MachineInstr.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Instruction.h"
  22 #include "llvm/BasicBlock.h"
  23 #include "llvm/Method.h"
  24 #include "llvm/iOther.h"
  25 #include "llvm/Target/MachineRegInfo.h"
  26
  27
  28 //******************** Internal Data Declarations ************************/
  29
  30 // Use a static vector to avoid allocating a new one per VM instruction
  31 static MachineInstr* minstrVec[MAX_INSTR_PER_VMINSTR];
  32
  33
  34 enum SelectDebugLevel_t {
  35   Select_NoDebugInfo,
  36   Select_PrintMachineCode,
  37   Select_DebugInstTrees,
  38   Select_DebugBurgTrees,
  39 };
  40
  41 // Enable Debug Options to be specified on the command line
  42 cl::Enum<enum SelectDebugLevel_t> SelectDebugLevel("dselect", cl::NoFlags,
  43    "enable instruction selection debugging information",
  44    clEnumValN(Select_NoDebugInfo,      "n", "disable debug output"),
  45    clEnumValN(Select_PrintMachineCode, "y", "print generated machine code"),
  46    clEnumValN(Select_DebugInstTrees,   "i", "print debugging info for instruction selection "),
  47    clEnumValN(Select_DebugBurgTrees,   "b", "print burg trees"), 0);
  48
  49
  50 //******************** Forward Function Declarations ***********************/
  51
  52
  53 static bool SelectInstructionsForTree   (InstrTreeNode* treeRoot,
  54                                          int goalnt,
  55                                          TargetMachine &target);
  56
  57 static void PostprocessMachineCodeForTree(InstructionNode* instrNode,
  58                                           int ruleForNode,
  59                                           short* nts,
  60                                           TargetMachine &target);
  61
  62 static void InsertCode4AllPhisInMeth(Method *method, TargetMachine &target);
  63
  64
  65
  66 //******************* Externally Visible Functions *************************/
  67
  68
  69 //---------------------------------------------------------------------------
  70 // Entry point for instruction selection using BURG.
  71 // Returns true if instruction selection failed, false otherwise.
  72 //---------------------------------------------------------------------------
  73
  74 bool
  75 SelectInstructionsForMethod(Method* method, TargetMachine &target)
  76 {
  77   bool failed = false;
  78
  79   //
  80   // Build the instruction trees to be given as inputs to BURG.
  81   //
  82   InstrForest instrForest(method);
  83
  84   if (SelectDebugLevel >= Select_DebugInstTrees)
  85     {
  86       cout << "\n\n*** Instruction trees for method "
  87            << (method->hasName()? method->getName() : "")
  88            << endl << endl;
  89       instrForest.dump();
  90     }
  91
  92   //
  93   // Invoke BURG instruction selection for each tree
  94   //
  95   const hash_set<InstructionNode*> &treeRoots = instrForest.getRootSet();
  96   for (hash_set<InstructionNode*>::const_iterator
  97          treeRootIter = treeRoots.begin(); treeRootIter != treeRoots.end();
  98        ++treeRootIter)
  99     {
 100       InstrTreeNode* basicNode = *treeRootIter;
 101
 102       // Invoke BURM to label each tree node with a state
 103       burm_label(basicNode);
 104
 105       if (SelectDebugLevel >= Select_DebugBurgTrees)
 106         {
 107           printcover(basicNode, 1, 0);
 108           cerr << "\nCover cost == " << treecost(basicNode, 1, 0) << "\n\n";
 109           printMatches(basicNode);
 110         }
 111
 112       // Then recursively walk the tree to select instructions
 113       if (SelectInstructionsForTree(basicNode, /*goalnt*/1, target))
 114         {
 115           failed = true;
 116           break;
 117         }
 118     }
 119
 120   //
 121   // Record instructions in the vector for each basic block
 122   //
 123   for (Method::iterator BI = method->begin(); BI != method->end(); ++BI)
 124     {
 125       MachineCodeForBasicBlock& bbMvec = (*BI)->getMachineInstrVec();
 126       for (BasicBlock::iterator II = (*BI)->begin(); II != (*BI)->end(); ++II)
 127         {
 128           MachineCodeForVMInstr& mvec = (*II)->getMachineInstrVec();
 129           for (unsigned i=0; i < mvec.size(); i++)
 130             bbMvec.push_back(mvec[i]);
 131         }
 132     }
 133
 134   // Insert phi elimination code -- added by Ruchira
 135   InsertCode4AllPhisInMeth(method, target);
 136
 137
 138   if (SelectDebugLevel >= Select_PrintMachineCode)
 139     {
 140       cout << endl
 141            << "*** Machine instructions after INSTRUCTION SELECTION" << endl;
 142       MachineCodeForMethod::get(method).dump();
 143     }
 144
 145   return false;
 146 }
 147
 148
 149 //*********************** Private Functions *****************************/
 150
 151
 152 //-------------------------------------------------------------------------
 153 // Thid method inserts a copy instruction to a predecessor BB as a result
 154 // of phi elimination.
 155 //-------------------------------------------------------------------------
 156
 157 void InsertPhiElimInst(BasicBlock *BB, MachineInstr *CpMI) {
 158
 159   TerminatorInst *TermInst = BB->getTerminator();
 160   MachineCodeForVMInstr &MC4Term = TermInst->getMachineInstrVec();
 161   MachineInstr *FirstMIOfTerm = *( MC4Term.begin() );
 162
 163   assert( FirstMIOfTerm && "No Machine Instrs for terminator" );
 164
 165   // get an iterator to machine instructions in the BB
 166   MachineCodeForBasicBlock& bbMvec = BB->getMachineInstrVec();
 167   MachineCodeForBasicBlock::iterator MCIt =  bbMvec.begin();
 168
 169   // find the position of first machine instruction generated by the
 170   // terminator of this BB
 171   for( ; (MCIt != bbMvec.end()) && (*MCIt != FirstMIOfTerm) ; ++MCIt ) ;
 172
 173   assert( MCIt != bbMvec.end() && "Start inst of terminator not found");
 174
 175   // insert the copy instruction just before the first machine instruction
 176   // generated for the terminator
 177   bbMvec.insert( MCIt , CpMI );
 178
 179   //cerr << "\nPhiElimination copy inst: " <<   *CopyInstVec[0];
 180
 181 }
 182
 183 #if 0
 184 //-------------------------------------------------------------------------
 185 // This method inserts phi elimination code for all BBs in a method
 186 //-------------------------------------------------------------------------
 187 void InsertCode4AllPhisInMeth(Method *method, TargetMachine &target) {
 188
 189
 190   // for all basic blocks in method
 191   //
 192   for (Method::iterator BI = method->begin(); BI != method->end(); ++BI) {
 193
 194     BasicBlock *BB = *BI;
 195     const BasicBlock::InstListType &InstList = BB->getInstList();
 196     BasicBlock::InstListType::const_iterator  IIt = InstList.begin();
 197
 198     // for all instructions in the basic block
 199     //
 200     for( ; IIt != InstList.end(); ++IIt ) {
 201
 202       if( (*IIt)->getOpcode() == Instruction::PHINode ) {
 203
 204         PHINode *PN = (PHINode *) (*IIt);
 205
 206         // for each incoming value of the phi, insert phi elimination
 207         //
 208         for (unsigned i = 0; i < PN->getNumIncomingValues(); ++i) {
 209
 210           // insert the copy instruction to the predecessor BB
 211
 212           vector<MachineInstr*> CopyInstVec;
 213
 214           MachineInstr *CpMI =
 215             target.getRegInfo().cpValue2Value(PN->getIncomingValue(i), PN);
 216
 217           InsertPhiElimInst( PN->getIncomingBlock(i), CpMI);
 218         }
 219       }
 220       else break;   // since PHI nodes can only be at the top
 221
 222     }  // for each Phi Instr in BB
 223
 224   } // for all BBs in method
 225
 226 }
 227 #endif
 228
 229
 230 //-------------------------------------------------------------------------
 231 // This method inserts phi elimination code for all BBs in a method
 232 //-------------------------------------------------------------------------
 233 void InsertCode4AllPhisInMeth(Method *method, TargetMachine &target) {
 234
 235
 236   // for all basic blocks in method
 237   //
 238   for (Method::iterator BI = method->begin(); BI != method->end(); ++BI) {
 239
 240     BasicBlock *BB = *BI;
 241     const BasicBlock::InstListType &InstList = BB->getInstList();
 242     BasicBlock::InstListType::const_iterator  IIt = InstList.begin();
 243
 244     // for all instructions in the basic block
 245     //
 246     for( ; IIt != InstList.end(); ++IIt ) {
 247
 248       if( (*IIt)->getOpcode() == Instruction::PHINode ) {
 249
 250         PHINode *PN = (PHINode *) (*IIt);
 251
 252         Value *PhiCpRes =
 253           new Value(PN->getType(), PN->getValueType() );
 254
 255         // for each incoming value of the phi, insert phi elimination
 256         //
 257         for (unsigned i = 0; i < PN->getNumIncomingValues(); ++i) {
 258
 259           // insert the copy instruction to the predecessor BB
 260
 261           MachineInstr *CpMI =
 262             target.getRegInfo().cpValue2Value(PN->getIncomingValue(i),
 263                                               PhiCpRes);
 264
 265           InsertPhiElimInst(PN->getIncomingBlock(i), CpMI);
 266
 267         }
 268
 269
 270         MachineInstr *CpMI2 =
 271           target.getRegInfo().cpValue2Value(PhiCpRes, PN);
 272
 273         // get an iterator to machine instructions in the BB
 274         MachineCodeForBasicBlock& bbMvec = BB->getMachineInstrVec();
 275
 276         bbMvec.insert( bbMvec.begin(),  CpMI2);
 277
 278
 279       }
 280       else break;   // since PHI nodes can only be at the top
 281
 282     }  // for each Phi Instr in BB
 283
 284   } // for all BBs in method
 285
 286 }
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296 //---------------------------------------------------------------------------
 297 // Function AppendMachineCodeForVMInstr
 298 //
 299 // Append machine instr sequence to the machine code vec for a VM instr
 300 //---------------------------------------------------------------------------
 301
 302 inline void
 303 AppendMachineCodeForVMInstr(MachineInstr** minstrVec,
 304                             unsigned int N,
 305                             Instruction* vmInstr)
 306 {
 307   if (N == 0)
 308     return;
 309   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 310   mvec.insert(mvec.end(), minstrVec, minstrVec+N);
 311 }
 312
 313
 314
 315 //---------------------------------------------------------------------------
 316 // Function PostprocessMachineCodeForTree
 317 //
 318 // Apply any final cleanups to machine code for the root of a subtree
 319 // after selection for all its children has been completed.
 320 //---------------------------------------------------------------------------
 321
 322 static void
 323 PostprocessMachineCodeForTree(InstructionNode* instrNode,
 324                               int ruleForNode,
 325                               short* nts,
 326                               TargetMachine &target)
 327 {
 328   // Fix up any constant operands in the machine instructions to either
 329   // use an immediate field or to load the constant into a register
 330   // Walk backwards and use direct indexes to allow insertion before current
 331   //
 332   Instruction* vmInstr = instrNode->getInstruction();
 333   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 334   for (int i = (int) mvec.size()-1; i >= 0; i--)
 335     {
 336       vector<MachineInstr*> loadConstVec =
 337         FixConstantOperandsForInstr(vmInstr, mvec[i], target);
 338
 339       if (loadConstVec.size() > 0)
 340         mvec.insert(mvec.begin()+i, loadConstVec.begin(), loadConstVec.end());
 341     }
 342 }
 343
 344 //---------------------------------------------------------------------------
 345 // Function SelectInstructionsForTree
 346 //
 347 // Recursively walk the tree to select instructions.
 348 // Do this top-down so that child instructions can exploit decisions
 349 // made at the child instructions.
 350 //
 351 // E.g., if br(setle(reg,const)) decides the constant is 0 and uses
 352 // a branch-on-integer-register instruction, then the setle node
 353 // can use that information to avoid generating the SUBcc instruction.
 354 //
 355 // Note that this cannot be done bottom-up because setle must do this
 356 // only if it is a child of the branch (otherwise, the result of setle
 357 // may be used by multiple instructions).
 358 //---------------------------------------------------------------------------
 359
 360 bool
 361 SelectInstructionsForTree(InstrTreeNode* treeRoot, int goalnt,
 362                           TargetMachine &target)
 363 {
 364   // Get the rule that matches this node.
 365   //
 366   int ruleForNode = burm_rule(treeRoot->state, goalnt);
 367
 368   if (ruleForNode == 0)
 369     {
 370       cerr << "Could not match instruction tree for instr selection" << endl;
 371       assert(0);
 372       return true;
 373     }
 374
 375   // Get this rule's non-terminals and the corresponding child nodes (if any)
 376   //
 377   short *nts = burm_nts[ruleForNode];
 378
 379   // First, select instructions for the current node and rule.
 380   // (If this is a list node, not an instruction, then skip this step).
 381   // This function is specific to the target architecture.
 382   //
 383   if (treeRoot->opLabel != VRegListOp)
 384     {
 385       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 386       assert(instrNode->getNodeType() == InstrTreeNode::NTInstructionNode);
 387
 388       unsigned N = GetInstructionsByRule(instrNode, ruleForNode, nts, target,
 389                                          minstrVec);
 390       if (N > 0)
 391         {
 392           assert(N <= MAX_INSTR_PER_VMINSTR);
 393           AppendMachineCodeForVMInstr(minstrVec,N,instrNode->getInstruction());
 394         }
 395     }
 396
 397   // Then, recursively compile the child nodes, if any.
 398   //
 399   if (nts[0])
 400     { // i.e., there is at least one kid
 401       InstrTreeNode* kids[2];
 402       int currentRule = ruleForNode;
 403       burm_kids(treeRoot, currentRule, kids);
 404
 405       // First skip over any chain rules so that we don't visit
 406       // the current node again.
 407       //
 408       while (ThisIsAChainRule(currentRule))
 409         {
 410           currentRule = burm_rule(treeRoot->state, nts[0]);
 411           nts = burm_nts[currentRule];
 412           burm_kids(treeRoot, currentRule, kids);
 413         }
 414
 415       // Now we have the first non-chain rule so we have found
 416       // the actual child nodes.  Recursively compile them.
 417       //
 418       for (int i = 0; nts[i]; i++)
 419         {
 420           assert(i < 2);
 421           InstrTreeNode::InstrTreeNodeType nodeType = kids[i]->getNodeType();
 422           if (nodeType == InstrTreeNode::NTVRegListNode ||
 423               nodeType == InstrTreeNode::NTInstructionNode)
 424             {
 425               if (SelectInstructionsForTree(kids[i], nts[i], target))
 426                 return true;                    // failure
 427             }
 428         }
 429     }
 430
 431   // Finally, do any postprocessing on this node after its children
 432   // have been translated
 433   //
 434   if (treeRoot->opLabel != VRegListOp)
 435     {
 436       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 437       PostprocessMachineCodeForTree(instrNode, ruleForNode, nts, target);
 438     }
 439
 440   return false;                         // success
 441 }
 442