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/Instruction.h"
  21 #include "llvm/BasicBlock.h"
  22 #include "llvm/Method.h"
  23 #include "llvm/iPHINode.h"
  24 #include "llvm/Target/MachineRegInfo.h"
  25 #include "Support/CommandLine.h"
  26 #include <iostream>
  27 using std::cerr;
  28
  29 //******************** Internal Data Declarations ************************/
  30
  31 // Use a static vector to avoid allocating a new one per VM instruction
  32 static MachineInstr* minstrVec[MAX_INSTR_PER_VMINSTR];
  33
  34
  35 enum SelectDebugLevel_t {
  36   Select_NoDebugInfo,
  37   Select_PrintMachineCode,
  38   Select_DebugInstTrees,
  39   Select_DebugBurgTrees,
  40 };
  41
  42 // Enable Debug Options to be specified on the command line
  43 cl::Enum<enum SelectDebugLevel_t> SelectDebugLevel("dselect", cl::NoFlags,
  44    "enable instruction selection debugging information",
  45    clEnumValN(Select_NoDebugInfo,      "n", "disable debug output"),
  46    clEnumValN(Select_PrintMachineCode, "y", "print generated machine code"),
  47    clEnumValN(Select_DebugInstTrees,   "i", "print debugging info for instruction selection "),
  48    clEnumValN(Select_DebugBurgTrees,   "b", "print burg trees"), 0);
  49
  50
  51 //******************** Forward Function Declarations ***********************/
  52
  53
  54 static bool SelectInstructionsForTree   (InstrTreeNode* treeRoot,
  55                                          int goalnt,
  56                                          TargetMachine &target);
  57
  58 static void PostprocessMachineCodeForTree(InstructionNode* instrNode,
  59                                           int ruleForNode,
  60                                           short* nts,
  61                                           TargetMachine &target);
  62
  63 static void InsertCode4AllPhisInMeth(Method *method, TargetMachine &target);
  64
  65
  66
  67 //******************* Externally Visible Functions *************************/
  68
  69
  70 //---------------------------------------------------------------------------
  71 // Entry point for instruction selection using BURG.
  72 // Returns true if instruction selection failed, false otherwise.
  73 //---------------------------------------------------------------------------
  74
  75 bool
  76 SelectInstructionsForMethod(Method* method, TargetMachine &target)
  77 {
  78   bool failed = false;
  79
  80   //
  81   // Build the instruction trees to be given as inputs to BURG.
  82   //
  83   InstrForest instrForest(method);
  84
  85   if (SelectDebugLevel >= Select_DebugInstTrees)
  86     {
  87       cerr << "\n\n*** Instruction trees for method "
  88            << (method->hasName()? method->getName() : "")
  89            << "\n\n";
  90       instrForest.dump();
  91     }
  92
  93   //
  94   // Invoke BURG instruction selection for each tree
  95   //
  96   const std::hash_set<InstructionNode*> &treeRoots = instrForest.getRootSet();
  97   for (std::hash_set<InstructionNode*>::const_iterator
  98          treeRootIter = treeRoots.begin(); treeRootIter != treeRoots.end();
  99        ++treeRootIter)
 100     {
 101       InstrTreeNode* basicNode = *treeRootIter;
 102
 103       // Invoke BURM to label each tree node with a state
 104       burm_label(basicNode);
 105
 106       if (SelectDebugLevel >= Select_DebugBurgTrees)
 107         {
 108           printcover(basicNode, 1, 0);
 109           cerr << "\nCover cost == " << treecost(basicNode, 1, 0) << "\n\n";
 110           printMatches(basicNode);
 111         }
 112
 113       // Then recursively walk the tree to select instructions
 114       if (SelectInstructionsForTree(basicNode, /*goalnt*/1, target))
 115         {
 116           failed = true;
 117           break;
 118         }
 119     }
 120
 121   //
 122   // Record instructions in the vector for each basic block
 123   //
 124   for (Method::iterator BI = method->begin(); BI != method->end(); ++BI)
 125     {
 126       MachineCodeForBasicBlock& bbMvec = (*BI)->getMachineInstrVec();
 127       for (BasicBlock::iterator II = (*BI)->begin(); II != (*BI)->end(); ++II)
 128         {
 129           MachineCodeForVMInstr& mvec = (*II)->getMachineInstrVec();
 130           for (unsigned i=0; i < mvec.size(); i++)
 131             bbMvec.push_back(mvec[i]);
 132         }
 133     }
 134
 135   // Insert phi elimination code -- added by Ruchira
 136   InsertCode4AllPhisInMeth(method, target);
 137
 138
 139   if (SelectDebugLevel >= Select_PrintMachineCode)
 140     {
 141       cerr << "\n*** Machine instructions after INSTRUCTION SELECTION\n";
 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           std::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 = new Value(PN->getType(), PN->getValueType(),"PhiCp:");
 253
 254         // for each incoming value of the phi, insert phi elimination
 255         //
 256         for (unsigned i = 0; i < PN->getNumIncomingValues(); ++i) {
 257
 258           // insert the copy instruction to the predecessor BB
 259           MachineInstr *CpMI =
 260             target.getRegInfo().cpValue2Value(PN->getIncomingValue(i),
 261                                               PhiCpRes);
 262
 263           InsertPhiElimInst(PN->getIncomingBlock(i), CpMI);
 264         }
 265
 266
 267         MachineInstr *CpMI2 =
 268           target.getRegInfo().cpValue2Value(PhiCpRes, PN);
 269
 270         // get an iterator to machine instructions in the BB
 271         MachineCodeForBasicBlock& bbMvec = BB->getMachineInstrVec();
 272
 273         bbMvec.insert( bbMvec.begin(),  CpMI2);
 274       }
 275       else break;   // since PHI nodes can only be at the top
 276
 277     }  // for each Phi Instr in BB
 278
 279   } // for all BBs in method
 280
 281 }
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291 //---------------------------------------------------------------------------
 292 // Function AppendMachineCodeForVMInstr
 293 //
 294 // Append machine instr sequence to the machine code vec for a VM instr
 295 //---------------------------------------------------------------------------
 296
 297 inline void
 298 AppendMachineCodeForVMInstr(MachineInstr** minstrVec,
 299                             unsigned int N,
 300                             Instruction* vmInstr)
 301 {
 302   if (N == 0)
 303     return;
 304   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 305   mvec.insert(mvec.end(), minstrVec, minstrVec+N);
 306 }
 307
 308
 309
 310 //---------------------------------------------------------------------------
 311 // Function PostprocessMachineCodeForTree
 312 //
 313 // Apply any final cleanups to machine code for the root of a subtree
 314 // after selection for all its children has been completed.
 315 //---------------------------------------------------------------------------
 316
 317 static void
 318 PostprocessMachineCodeForTree(InstructionNode* instrNode,
 319                               int ruleForNode,
 320                               short* nts,
 321                               TargetMachine &target)
 322 {
 323   // Fix up any constant operands in the machine instructions to either
 324   // use an immediate field or to load the constant into a register
 325   // Walk backwards and use direct indexes to allow insertion before current
 326   //
 327   Instruction* vmInstr = instrNode->getInstruction();
 328   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 329   for (int i = (int) mvec.size()-1; i >= 0; i--)
 330     {
 331       std::vector<MachineInstr*> loadConstVec =
 332         FixConstantOperandsForInstr(vmInstr, mvec[i], target);
 333
 334       if (loadConstVec.size() > 0)
 335         mvec.insert(mvec.begin()+i, loadConstVec.begin(), loadConstVec.end());
 336     }
 337 }
 338
 339 //---------------------------------------------------------------------------
 340 // Function SelectInstructionsForTree
 341 //
 342 // Recursively walk the tree to select instructions.
 343 // Do this top-down so that child instructions can exploit decisions
 344 // made at the child instructions.
 345 //
 346 // E.g., if br(setle(reg,const)) decides the constant is 0 and uses
 347 // a branch-on-integer-register instruction, then the setle node
 348 // can use that information to avoid generating the SUBcc instruction.
 349 //
 350 // Note that this cannot be done bottom-up because setle must do this
 351 // only if it is a child of the branch (otherwise, the result of setle
 352 // may be used by multiple instructions).
 353 //---------------------------------------------------------------------------
 354
 355 bool
 356 SelectInstructionsForTree(InstrTreeNode* treeRoot, int goalnt,
 357                           TargetMachine &target)
 358 {
 359   // Get the rule that matches this node.
 360   //
 361   int ruleForNode = burm_rule(treeRoot->state, goalnt);
 362
 363   if (ruleForNode == 0)
 364     {
 365       cerr << "Could not match instruction tree for instr selection\n";
 366       assert(0);
 367       return true;
 368     }
 369
 370   // Get this rule's non-terminals and the corresponding child nodes (if any)
 371   //
 372   short *nts = burm_nts[ruleForNode];
 373
 374   // First, select instructions for the current node and rule.
 375   // (If this is a list node, not an instruction, then skip this step).
 376   // This function is specific to the target architecture.
 377   //
 378   if (treeRoot->opLabel != VRegListOp)
 379     {
 380       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 381       assert(instrNode->getNodeType() == InstrTreeNode::NTInstructionNode);
 382
 383       unsigned N = GetInstructionsByRule(instrNode, ruleForNode, nts, target,
 384                                          minstrVec);
 385       if (N > 0)
 386         {
 387           assert(N <= MAX_INSTR_PER_VMINSTR);
 388           AppendMachineCodeForVMInstr(minstrVec,N,instrNode->getInstruction());
 389         }
 390     }
 391
 392   // Then, recursively compile the child nodes, if any.
 393   //
 394   if (nts[0])
 395     { // i.e., there is at least one kid
 396       InstrTreeNode* kids[2];
 397       int currentRule = ruleForNode;
 398       burm_kids(treeRoot, currentRule, kids);
 399
 400       // First skip over any chain rules so that we don't visit
 401       // the current node again.
 402       //
 403       while (ThisIsAChainRule(currentRule))
 404         {
 405           currentRule = burm_rule(treeRoot->state, nts[0]);
 406           nts = burm_nts[currentRule];
 407           burm_kids(treeRoot, currentRule, kids);
 408         }
 409
 410       // Now we have the first non-chain rule so we have found
 411       // the actual child nodes.  Recursively compile them.
 412       //
 413       for (int i = 0; nts[i]; i++)
 414         {
 415           assert(i < 2);
 416           InstrTreeNode::InstrTreeNodeType nodeType = kids[i]->getNodeType();
 417           if (nodeType == InstrTreeNode::NTVRegListNode ||
 418               nodeType == InstrTreeNode::NTInstructionNode)
 419             {
 420               if (SelectInstructionsForTree(kids[i], nts[i], target))
 421                 return true;                    // failure
 422             }
 423         }
 424     }
 425
 426   // Finally, do any postprocessing on this node after its children
 427   // have been translated
 428   //
 429   if (treeRoot->opLabel != VRegListOp)
 430     {
 431       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 432       PostprocessMachineCodeForTree(instrNode, ruleForNode, nts, target);
 433     }
 434
 435   return false;                         // success
 436 }
 437