lib/CodeGen/InstrSelection/InstrSelection.cpp

   1 //===- InstrSelection.cpp - Machine Independent Inst Selection Driver -----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Machine-independent driver file for instruction selection.  This file
  11 // constructs a forest of BURG instruction trees and then uses the
  12 // BURG-generated tree grammar (BURM) to find the optimal instruction sequences
  13 // for a given machine.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Function.h"
  18 #include "llvm/iPHINode.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/CodeGen/InstrForest.h"
  21 #include "llvm/CodeGen/InstrSelection.h"
  22 #include "llvm/CodeGen/InstrSelectionSupport.h"
  23 #include "llvm/CodeGen/MachineCodeForInstruction.h"
  24 #include "llvm/CodeGen/MachineFunction.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Target/TargetRegInfo.h"
  27 #include "Support/CommandLine.h"
  28 #include "Support/LeakDetector.h"
  29 #include <vector>
  30
  31 std::vector<MachineInstr*>
  32 FixConstantOperandsForInstr(Instruction* vmInstr, MachineInstr* minstr,
  33                             TargetMachine& target);
  34
  35 namespace {
  36   //===--------------------------------------------------------------------===//
  37   // SelectDebugLevel - Allow command line control over debugging.
  38   //
  39   enum SelectDebugLevel_t {
  40     Select_NoDebugInfo,
  41     Select_PrintMachineCode,
  42     Select_DebugInstTrees,
  43     Select_DebugBurgTrees,
  44   };
  45
  46   // Enable Debug Options to be specified on the command line
  47   cl::opt<SelectDebugLevel_t>
  48   SelectDebugLevel("dselect", cl::Hidden,
  49                    cl::desc("enable instruction selection debug information"),
  50                    cl::values(
  51      clEnumValN(Select_NoDebugInfo,      "n", "disable debug output"),
  52      clEnumValN(Select_PrintMachineCode, "y", "print generated machine code"),
  53      clEnumValN(Select_DebugInstTrees,   "i",
  54                 "print debugging info for instruction selection"),
  55      clEnumValN(Select_DebugBurgTrees,   "b", "print burg trees"),
  56                               0));
  57
  58
  59   //===--------------------------------------------------------------------===//
  60   //  InstructionSelection Pass
  61   //
  62   // This is the actual pass object that drives the instruction selection
  63   // process.
  64   //
  65   class InstructionSelection : public FunctionPass {
  66     TargetMachine &Target;
  67     void InsertCodeForPhis(Function &F);
  68     void InsertPhiElimInstructions(BasicBlock *BB,
  69                                    const std::vector<MachineInstr*>& CpVec);
  70     void SelectInstructionsForTree(InstrTreeNode* treeRoot, int goalnt);
  71     void PostprocessMachineCodeForTree(InstructionNode* instrNode,
  72                                        int ruleForNode, short* nts);
  73   public:
  74     InstructionSelection(TargetMachine &T) : Target(T) {}
  75
  76     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  77       AU.setPreservesCFG();
  78     }
  79
  80     bool runOnFunction(Function &F);
  81     virtual const char *getPassName() const { return "Instruction Selection"; }
  82   };
  83 }
  84
  85 TmpInstruction::TmpInstruction(MachineCodeForInstruction& mcfi,
  86                                Value *s1, Value *s2, const std::string &name)
  87   : Instruction(s1->getType(), Instruction::UserOp1, name)
  88 {
  89   mcfi.addTemp(this);
  90
  91   Operands.push_back(Use(s1, this));  // s1 must be non-null
  92   if (s2)
  93     Operands.push_back(Use(s2, this));
  94
  95   // TmpInstructions should not be garbage checked.
  96   LeakDetector::removeGarbageObject(this);
  97 }
  98
  99 // Constructor that requires the type of the temporary to be specified.
 100 // Both S1 and S2 may be NULL.(
 101 TmpInstruction::TmpInstruction(MachineCodeForInstruction& mcfi,
 102                                const Type *Ty, Value *s1, Value* s2,
 103                                const std::string &name)
 104   : Instruction(Ty, Instruction::UserOp1, name)
 105 {
 106   mcfi.addTemp(this);
 107
 108   if (s1)
 109     Operands.push_back(Use(s1, this));
 110   if (s2)
 111     Operands.push_back(Use(s2, this));
 112
 113   // TmpInstructions should not be garbage checked.
 114   LeakDetector::removeGarbageObject(this);
 115 }
 116
 117
 118 bool InstructionSelection::runOnFunction(Function &F)
 119 {
 120   //
 121   // Build the instruction trees to be given as inputs to BURG.
 122   //
 123   InstrForest instrForest(&F);
 124
 125   if (SelectDebugLevel >= Select_DebugInstTrees) {
 126     std::cerr << "\n\n*** Input to instruction selection for function "
 127               << F.getName() << "\n\n" << F
 128               << "\n\n*** Instruction trees for function "
 129               << F.getName() << "\n\n";
 130     instrForest.dump();
 131   }
 132
 133   //
 134   // Invoke BURG instruction selection for each tree
 135   //
 136   for (InstrForest::const_root_iterator RI = instrForest.roots_begin();
 137        RI != instrForest.roots_end(); ++RI) {
 138     InstructionNode* basicNode = *RI;
 139     assert(basicNode->parent() == NULL && "A `root' node has a parent?");
 140
 141     // Invoke BURM to label each tree node with a state
 142     burm_label(basicNode);
 143
 144     if (SelectDebugLevel >= Select_DebugBurgTrees) {
 145       printcover(basicNode, 1, 0);
 146       std::cerr << "\nCover cost == " << treecost(basicNode, 1, 0) <<"\n\n";
 147       printMatches(basicNode);
 148     }
 149
 150     // Then recursively walk the tree to select instructions
 151     SelectInstructionsForTree(basicNode, /*goalnt*/1);
 152   }
 153
 154   //
 155   // Create the MachineBasicBlock records and add all of the MachineInstrs
 156   // defined in the MachineCodeForInstruction objects to also live in the
 157   // MachineBasicBlock objects.
 158   //
 159   MachineFunction &MF = MachineFunction::get(&F);
 160   for (Function::iterator BI = F.begin(), BE = F.end(); BI != BE; ++BI) {
 161     MachineBasicBlock *MCBB = new MachineBasicBlock(BI);
 162     MF.getBasicBlockList().push_back(MCBB);
 163
 164     for (BasicBlock::iterator II = BI->begin(); II != BI->end(); ++II) {
 165       MachineCodeForInstruction &mvec = MachineCodeForInstruction::get(II);
 166       MCBB->insert(MCBB->end(), mvec.begin(), mvec.end());
 167     }
 168   }
 169
 170   // Insert phi elimination code
 171   InsertCodeForPhis(F);
 172
 173   if (SelectDebugLevel >= Select_PrintMachineCode) {
 174     std::cerr << "\n*** Machine instructions after INSTRUCTION SELECTION\n";
 175     MachineFunction::get(&F).dump();
 176   }
 177
 178   return true;
 179 }
 180
 181
 182 //-------------------------------------------------------------------------
 183 // This method inserts phi elimination code for all BBs in a method
 184 //-------------------------------------------------------------------------
 185
 186 void
 187 InstructionSelection::InsertCodeForPhis(Function &F) {
 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         std::vector<MachineInstr*> mvec, CpVec;
 207         Target.getRegInfo().cpValue2Value(PN->getIncomingValue(i), PhiCpRes,
 208                                           mvec);
 209         for (std::vector<MachineInstr*>::iterator MI=mvec.begin();
 210              MI != mvec.end(); ++MI) {
 211           std::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       std::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 std::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   // unnecessary.
 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     std::vector<MachineInstr*> minstrVec;
 305
 306     InstructionNode* instrNode = (InstructionNode*)treeRoot;
 307     assert(instrNode->getNodeType() == InstrTreeNode::NTInstructionNode);
 308
 309     GetInstructionsByRule(instrNode, ruleForNode, nts, Target, minstrVec);
 310
 311     MachineCodeForInstruction &mvec =
 312       MachineCodeForInstruction::get(instrNode->getInstruction());
 313     mvec.insert(mvec.end(), minstrVec.begin(), minstrVec.end());
 314   }
 315
 316   // Then, recursively compile the child nodes, if any.
 317   //
 318   if (nts[0]) {
 319     // i.e., there is at least one kid
 320     InstrTreeNode* kids[2];
 321     int currentRule = ruleForNode;
 322     burm_kids(treeRoot, currentRule, kids);
 323
 324     // First skip over any chain rules so that we don't visit
 325     // the current node again.
 326     //
 327     while (ThisIsAChainRule(currentRule)) {
 328       currentRule = burm_rule(treeRoot->state, nts[0]);
 329       nts = burm_nts[currentRule];
 330       burm_kids(treeRoot, currentRule, kids);
 331     }
 332
 333     // Now we have the first non-chain rule so we have found
 334     // the actual child nodes.  Recursively compile them.
 335     //
 336     for (unsigned i = 0; nts[i]; i++) {
 337       assert(i < 2);
 338       InstrTreeNode::InstrTreeNodeType nodeType = kids[i]->getNodeType();
 339       if (nodeType == InstrTreeNode::NTVRegListNode ||
 340           nodeType == InstrTreeNode::NTInstructionNode)
 341         SelectInstructionsForTree(kids[i], nts[i]);
 342     }
 343   }
 344
 345   // Finally, do any post-processing on this node after its children
 346   // have been translated
 347   //
 348   if (treeRoot->opLabel != VRegListOp)
 349     PostprocessMachineCodeForTree((InstructionNode*)treeRoot, ruleForNode, nts);
 350 }
 351
 352 //---------------------------------------------------------------------------
 353 // Function PostprocessMachineCodeForTree
 354 //
 355 // Apply any final cleanups to machine code for the root of a subtree
 356 // after selection for all its children has been completed.
 357 //
 358 void
 359 InstructionSelection::PostprocessMachineCodeForTree(InstructionNode* instrNode,
 360                                                     int ruleForNode,
 361                                                     short* nts)
 362 {
 363   // Fix up any constant operands in the machine instructions to either
 364   // use an immediate field or to load the constant into a register
 365   // Walk backwards and use direct indexes to allow insertion before current
 366   //
 367   Instruction* vmInstr = instrNode->getInstruction();
 368   MachineCodeForInstruction &mvec = MachineCodeForInstruction::get(vmInstr);
 369   for (unsigned i = mvec.size(); i != 0; --i) {
 370     std::vector<MachineInstr*> loadConstVec =
 371       FixConstantOperandsForInstr(vmInstr, mvec[i-1], Target);
 372
 373     mvec.insert(mvec.begin()+i-1, loadConstVec.begin(), loadConstVec.end());
 374   }
 375 }
 376
 377
 378
 379 //===----------------------------------------------------------------------===//
 380 // createInstructionSelectionPass - Public entrypoint for instruction selection
 381 // and this file as a whole...
 382 //
 383 FunctionPass *createInstructionSelectionPass(TargetMachine &T) {
 384   return new InstructionSelection(T);
 385 }