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, vector<MachineInstr*>& CopyInstVec) { // bak
 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   assert( (CopyInstVec.size()==1) && "Must be only one copy instr");
 175
 176   // insert the copy instruction just before the first machine instruction
 177   // generated for the terminator
 178   bbMvec.insert( MCIt , CopyInstVec[0] );
 179
 180   cerr << "\nPhiElimination copy inst: " <<   *CopyInstVec[0];
 181
 182 }
 183
 184
 185 //-------------------------------------------------------------------------
 186 // This method inserts phi elimination code for all BBs in a method
 187 //-------------------------------------------------------------------------
 188 void InsertCode4AllPhisInMeth(Method *method, TargetMachine &target) {
 189
 190
 191   // for all basic blocks in method
 192   //
 193   for (Method::iterator BI = method->begin(); BI != method->end(); ++BI) {
 194
 195     BasicBlock *BB = *BI;
 196     const BasicBlock::InstListType &InstList = BB->getInstList();
 197     BasicBlock::InstListType::const_iterator  IIt = InstList.begin();
 198
 199     // for all instructions in the basic block
 200     //
 201     for( ; IIt != InstList.end(); ++IIt ) {
 202
 203       if( (*IIt)->getOpcode() == Instruction::PHINode ) {
 204
 205         PHINode *PN = (PHINode *) (*IIt);
 206
 207         // for each incoming value of the phi, insert phi elimination
 208         //
 209         for (unsigned i = 0; i < PN->getNumIncomingValues(); ++i) {
 210
 211           // insert the copy instruction to the predecessor BB
 212
 213           vector<MachineInstr*> CopyInstVec;
 214
 215           // target.getInstrInfo().CreateCopyInstructionsByType(
 216           //    target, PN->getIncomingValue(i), PN, CopyInstVec );
 217
 218           MachineInstr *MI =
 219             target.getRegInfo().cpValue2Value(PN->getIncomingValue(i), PN);
 220
 221           CopyInstVec.push_back( MI );
 222
 223           InsertPhiElimInst( PN->getIncomingBlock(i), CopyInstVec);
 224
 225           // Map the generated copy instruction in pred BB to this phi
 226           // (PN->getMachineInstrVec()).push_back( CopyInstVec[0] );
 227
 228         }
 229       }
 230       else break;   // since PHI nodes can only be at the top
 231
 232     }  // for each Phi Instr in BB
 233
 234   } // for all BBs in method
 235
 236 }
 237
 238
 239
 240
 241
 242
 243 //---------------------------------------------------------------------------
 244 // Function AppendMachineCodeForVMInstr
 245 //
 246 // Append machine instr sequence to the machine code vec for a VM instr
 247 //---------------------------------------------------------------------------
 248
 249 inline void
 250 AppendMachineCodeForVMInstr(MachineInstr** minstrVec,
 251                             unsigned int N,
 252                             Instruction* vmInstr)
 253 {
 254   if (N == 0)
 255     return;
 256   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 257   mvec.insert(mvec.end(), minstrVec, minstrVec+N);
 258 }
 259
 260
 261
 262 //---------------------------------------------------------------------------
 263 // Function PostprocessMachineCodeForTree
 264 //
 265 // Apply any final cleanups to machine code for the root of a subtree
 266 // after selection for all its children has been completed.
 267 //---------------------------------------------------------------------------
 268
 269 static void
 270 PostprocessMachineCodeForTree(InstructionNode* instrNode,
 271                               int ruleForNode,
 272                               short* nts,
 273                               TargetMachine &target)
 274 {
 275   // Fix up any constant operands in the machine instructions to either
 276   // use an immediate field or to load the constant into a register
 277   // Walk backwards and use direct indexes to allow insertion before current
 278   //
 279   Instruction* vmInstr = instrNode->getInstruction();
 280   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 281   for (int i = (int) mvec.size()-1; i >= 0; i--)
 282     {
 283       vector<MachineInstr*> loadConstVec =
 284         FixConstantOperandsForInstr(vmInstr, mvec[i], target);
 285
 286       if (loadConstVec.size() > 0)
 287         mvec.insert(mvec.begin()+i, loadConstVec.begin(), loadConstVec.end());
 288     }
 289 }
 290
 291 //---------------------------------------------------------------------------
 292 // Function SelectInstructionsForTree
 293 //
 294 // Recursively walk the tree to select instructions.
 295 // Do this top-down so that child instructions can exploit decisions
 296 // made at the child instructions.
 297 //
 298 // E.g., if br(setle(reg,const)) decides the constant is 0 and uses
 299 // a branch-on-integer-register instruction, then the setle node
 300 // can use that information to avoid generating the SUBcc instruction.
 301 //
 302 // Note that this cannot be done bottom-up because setle must do this
 303 // only if it is a child of the branch (otherwise, the result of setle
 304 // may be used by multiple instructions).
 305 //---------------------------------------------------------------------------
 306
 307 bool
 308 SelectInstructionsForTree(InstrTreeNode* treeRoot, int goalnt,
 309                           TargetMachine &target)
 310 {
 311   // Get the rule that matches this node.
 312   //
 313   int ruleForNode = burm_rule(treeRoot->state, goalnt);
 314
 315   if (ruleForNode == 0)
 316     {
 317       cerr << "Could not match instruction tree for instr selection" << endl;
 318       assert(0);
 319       return true;
 320     }
 321
 322   // Get this rule's non-terminals and the corresponding child nodes (if any)
 323   //
 324   short *nts = burm_nts[ruleForNode];
 325
 326   // First, select instructions for the current node and rule.
 327   // (If this is a list node, not an instruction, then skip this step).
 328   // This function is specific to the target architecture.
 329   //
 330   if (treeRoot->opLabel != VRegListOp)
 331     {
 332       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 333       assert(instrNode->getNodeType() == InstrTreeNode::NTInstructionNode);
 334
 335       unsigned N = GetInstructionsByRule(instrNode, ruleForNode, nts, target,
 336                                          minstrVec);
 337       if (N > 0)
 338         {
 339           assert(N <= MAX_INSTR_PER_VMINSTR);
 340           AppendMachineCodeForVMInstr(minstrVec,N,instrNode->getInstruction());
 341         }
 342     }
 343
 344   // Then, recursively compile the child nodes, if any.
 345   //
 346   if (nts[0])
 347     { // i.e., there is at least one kid
 348       InstrTreeNode* kids[2];
 349       int currentRule = ruleForNode;
 350       burm_kids(treeRoot, currentRule, kids);
 351
 352       // First skip over any chain rules so that we don't visit
 353       // the current node again.
 354       //
 355       while (ThisIsAChainRule(currentRule))
 356         {
 357           currentRule = burm_rule(treeRoot->state, nts[0]);
 358           nts = burm_nts[currentRule];
 359           burm_kids(treeRoot, currentRule, kids);
 360         }
 361
 362       // Now we have the first non-chain rule so we have found
 363       // the actual child nodes.  Recursively compile them.
 364       //
 365       for (int i = 0; nts[i]; i++)
 366         {
 367           assert(i < 2);
 368           InstrTreeNode::InstrTreeNodeType nodeType = kids[i]->getNodeType();
 369           if (nodeType == InstrTreeNode::NTVRegListNode ||
 370               nodeType == InstrTreeNode::NTInstructionNode)
 371             {
 372               if (SelectInstructionsForTree(kids[i], nts[i], target))
 373                 return true;                    // failure
 374             }
 375         }
 376     }
 377
 378   // Finally, do any postprocessing on this node after its children
 379   // have been translated
 380   //
 381   if (treeRoot->opLabel != VRegListOp)
 382     {
 383       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 384       PostprocessMachineCodeForTree(instrNode, ruleForNode, nts, target);
 385     }
 386
 387   return false;                         // success
 388 }
 389