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 <string.h>
  27
  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       cout << "\n\n*** Instruction trees for method "
  88            << (method->hasName()? method->getName() : "")
  89            << endl << endl;
  90       instrForest.dump();
  91     }
  92
  93   //
  94   // Invoke BURG instruction selection for each tree
  95   //
  96   const hash_set<InstructionNode*> &treeRoots = instrForest.getRootSet();
  97   for (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       cout << endl
 142            << "*** Machine instructions after INSTRUCTION SELECTION" << endl;
 143       MachineCodeForMethod::get(method).dump();
 144     }
 145
 146   return false;
 147 }
 148
 149
 150 //*********************** Private Functions *****************************/
 151
 152
 153 //-------------------------------------------------------------------------
 154 // Thid method inserts a copy instruction to a predecessor BB as a result
 155 // of phi elimination.
 156 //-------------------------------------------------------------------------
 157
 158 void InsertPhiElimInst(BasicBlock *BB, MachineInstr *CpMI) {
 159
 160   TerminatorInst *TermInst = BB->getTerminator();
 161   MachineCodeForVMInstr &MC4Term = TermInst->getMachineInstrVec();
 162   MachineInstr *FirstMIOfTerm = *( MC4Term.begin() );
 163
 164   assert( FirstMIOfTerm && "No Machine Instrs for terminator" );
 165
 166   // get an iterator to machine instructions in the BB
 167   MachineCodeForBasicBlock& bbMvec = BB->getMachineInstrVec();
 168   MachineCodeForBasicBlock::iterator MCIt =  bbMvec.begin();
 169
 170   // find the position of first machine instruction generated by the
 171   // terminator of this BB
 172   for( ; (MCIt != bbMvec.end()) && (*MCIt != FirstMIOfTerm) ; ++MCIt ) ;
 173
 174   assert( MCIt != bbMvec.end() && "Start inst of terminator not found");
 175
 176   // insert the copy instruction just before the first machine instruction
 177   // generated for the terminator
 178   bbMvec.insert( MCIt , CpMI );
 179
 180   //cerr << "\nPhiElimination copy inst: " <<   *CopyInstVec[0];
 181
 182 }
 183
 184 #if 0
 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           MachineInstr *CpMI =
 216             target.getRegInfo().cpValue2Value(PN->getIncomingValue(i), PN);
 217
 218           InsertPhiElimInst( PN->getIncomingBlock(i), CpMI);
 219         }
 220       }
 221       else break;   // since PHI nodes can only be at the top
 222
 223     }  // for each Phi Instr in BB
 224
 225   } // for all BBs in method
 226
 227 }
 228 #endif
 229
 230
 231 //-------------------------------------------------------------------------
 232 // This method inserts phi elimination code for all BBs in a method
 233 //-------------------------------------------------------------------------
 234 void InsertCode4AllPhisInMeth(Method *method, TargetMachine &target) {
 235
 236
 237   // for all basic blocks in method
 238   //
 239   for (Method::iterator BI = method->begin(); BI != method->end(); ++BI) {
 240
 241     BasicBlock *BB = *BI;
 242     const BasicBlock::InstListType &InstList = BB->getInstList();
 243     BasicBlock::InstListType::const_iterator  IIt = InstList.begin();
 244
 245     // for all instructions in the basic block
 246     //
 247     for( ; IIt != InstList.end(); ++IIt ) {
 248
 249       if( (*IIt)->getOpcode() == Instruction::PHINode ) {
 250
 251         PHINode *PN = (PHINode *) (*IIt);
 252
 253         Value *PhiCpRes = new Value(PN->getType(), PN->getValueType());
 254
 255         string *Name = new string("PhiCp:");
 256         (*Name) += (int) PhiCpRes;
 257         PhiCpRes->setName( *Name );
 258
 259
 260         // for each incoming value of the phi, insert phi elimination
 261         //
 262         for (unsigned i = 0; i < PN->getNumIncomingValues(); ++i) {
 263
 264           // insert the copy instruction to the predecessor BB
 265
 266           MachineInstr *CpMI =
 267             target.getRegInfo().cpValue2Value(PN->getIncomingValue(i),
 268                                               PhiCpRes);
 269
 270           InsertPhiElimInst(PN->getIncomingBlock(i), CpMI);
 271
 272         }
 273
 274
 275         MachineInstr *CpMI2 =
 276           target.getRegInfo().cpValue2Value(PhiCpRes, PN);
 277
 278         // get an iterator to machine instructions in the BB
 279         MachineCodeForBasicBlock& bbMvec = BB->getMachineInstrVec();
 280
 281         bbMvec.insert( bbMvec.begin(),  CpMI2);
 282
 283
 284       }
 285       else break;   // since PHI nodes can only be at the top
 286
 287     }  // for each Phi Instr in BB
 288
 289   } // for all BBs in method
 290
 291 }
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301 //---------------------------------------------------------------------------
 302 // Function AppendMachineCodeForVMInstr
 303 //
 304 // Append machine instr sequence to the machine code vec for a VM instr
 305 //---------------------------------------------------------------------------
 306
 307 inline void
 308 AppendMachineCodeForVMInstr(MachineInstr** minstrVec,
 309                             unsigned int N,
 310                             Instruction* vmInstr)
 311 {
 312   if (N == 0)
 313     return;
 314   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 315   mvec.insert(mvec.end(), minstrVec, minstrVec+N);
 316 }
 317
 318
 319
 320 //---------------------------------------------------------------------------
 321 // Function PostprocessMachineCodeForTree
 322 //
 323 // Apply any final cleanups to machine code for the root of a subtree
 324 // after selection for all its children has been completed.
 325 //---------------------------------------------------------------------------
 326
 327 static void
 328 PostprocessMachineCodeForTree(InstructionNode* instrNode,
 329                               int ruleForNode,
 330                               short* nts,
 331                               TargetMachine &target)
 332 {
 333   // Fix up any constant operands in the machine instructions to either
 334   // use an immediate field or to load the constant into a register
 335   // Walk backwards and use direct indexes to allow insertion before current
 336   //
 337   Instruction* vmInstr = instrNode->getInstruction();
 338   MachineCodeForVMInstr& mvec = vmInstr->getMachineInstrVec();
 339   for (int i = (int) mvec.size()-1; i >= 0; i--)
 340     {
 341       vector<MachineInstr*> loadConstVec =
 342         FixConstantOperandsForInstr(vmInstr, mvec[i], target);
 343
 344       if (loadConstVec.size() > 0)
 345         mvec.insert(mvec.begin()+i, loadConstVec.begin(), loadConstVec.end());
 346     }
 347 }
 348
 349 //---------------------------------------------------------------------------
 350 // Function SelectInstructionsForTree
 351 //
 352 // Recursively walk the tree to select instructions.
 353 // Do this top-down so that child instructions can exploit decisions
 354 // made at the child instructions.
 355 //
 356 // E.g., if br(setle(reg,const)) decides the constant is 0 and uses
 357 // a branch-on-integer-register instruction, then the setle node
 358 // can use that information to avoid generating the SUBcc instruction.
 359 //
 360 // Note that this cannot be done bottom-up because setle must do this
 361 // only if it is a child of the branch (otherwise, the result of setle
 362 // may be used by multiple instructions).
 363 //---------------------------------------------------------------------------
 364
 365 bool
 366 SelectInstructionsForTree(InstrTreeNode* treeRoot, int goalnt,
 367                           TargetMachine &target)
 368 {
 369   // Get the rule that matches this node.
 370   //
 371   int ruleForNode = burm_rule(treeRoot->state, goalnt);
 372
 373   if (ruleForNode == 0)
 374     {
 375       cerr << "Could not match instruction tree for instr selection" << endl;
 376       assert(0);
 377       return true;
 378     }
 379
 380   // Get this rule's non-terminals and the corresponding child nodes (if any)
 381   //
 382   short *nts = burm_nts[ruleForNode];
 383
 384   // First, select instructions for the current node and rule.
 385   // (If this is a list node, not an instruction, then skip this step).
 386   // This function is specific to the target architecture.
 387   //
 388   if (treeRoot->opLabel != VRegListOp)
 389     {
 390       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 391       assert(instrNode->getNodeType() == InstrTreeNode::NTInstructionNode);
 392
 393       unsigned N = GetInstructionsByRule(instrNode, ruleForNode, nts, target,
 394                                          minstrVec);
 395       if (N > 0)
 396         {
 397           assert(N <= MAX_INSTR_PER_VMINSTR);
 398           AppendMachineCodeForVMInstr(minstrVec,N,instrNode->getInstruction());
 399         }
 400     }
 401
 402   // Then, recursively compile the child nodes, if any.
 403   //
 404   if (nts[0])
 405     { // i.e., there is at least one kid
 406       InstrTreeNode* kids[2];
 407       int currentRule = ruleForNode;
 408       burm_kids(treeRoot, currentRule, kids);
 409
 410       // First skip over any chain rules so that we don't visit
 411       // the current node again.
 412       //
 413       while (ThisIsAChainRule(currentRule))
 414         {
 415           currentRule = burm_rule(treeRoot->state, nts[0]);
 416           nts = burm_nts[currentRule];
 417           burm_kids(treeRoot, currentRule, kids);
 418         }
 419
 420       // Now we have the first non-chain rule so we have found
 421       // the actual child nodes.  Recursively compile them.
 422       //
 423       for (int i = 0; nts[i]; i++)
 424         {
 425           assert(i < 2);
 426           InstrTreeNode::InstrTreeNodeType nodeType = kids[i]->getNodeType();
 427           if (nodeType == InstrTreeNode::NTVRegListNode ||
 428               nodeType == InstrTreeNode::NTInstructionNode)
 429             {
 430               if (SelectInstructionsForTree(kids[i], nts[i], target))
 431                 return true;                    // failure
 432             }
 433         }
 434     }
 435
 436   // Finally, do any postprocessing on this node after its children
 437   // have been translated
 438   //
 439   if (treeRoot->opLabel != VRegListOp)
 440     {
 441       InstructionNode* instrNode = (InstructionNode*)treeRoot;
 442       PostprocessMachineCodeForTree(instrNode, ruleForNode, nts, target);
 443     }
 444
 445   return false;                         // success
 446 }
 447