lib/Target/SparcV9/InstrSelection/InstrForest.cpp

   1 //===-- InstrForest.cpp - Build instruction forest for inst selection -----===//
   2 //
   3 //  The key goal is to group instructions into a single
   4 //  tree if one or more of them might be potentially combined into a single
   5 //  complex instruction in the target machine.
   6 //  Since this grouping is completely machine-independent, we do it as
   7 //  aggressive as possible to exploit any possible target instructions.
   8 //  In particular, we group two instructions O and I if:
   9 //      (1) Instruction O computes an operand used by instruction I,
  10 //  and (2) O and I are part of the same basic block,
  11 //  and (3) O has only a single use, viz., I.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/CodeGen/InstrForest.h"
  16 #include "llvm/CodeGen/MachineCodeForInstruction.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/iTerminators.h"
  19 #include "llvm/iMemory.h"
  20 #include "llvm/Constant.h"
  21 #include "llvm/Type.h"
  22 #include "llvm/CodeGen/MachineInstr.h"
  23 #include "Support/STLExtras.h"
  24 #include "Config/alloca.h"
  25
  26 //------------------------------------------------------------------------
  27 // class InstrTreeNode
  28 //------------------------------------------------------------------------
  29
  30 void
  31 InstrTreeNode::dump(int dumpChildren, int indent) const
  32 {
  33   dumpNode(indent);
  34
  35   if (dumpChildren)
  36     {
  37       if (LeftChild)
  38         LeftChild->dump(dumpChildren, indent+1);
  39       if (RightChild)
  40         RightChild->dump(dumpChildren, indent+1);
  41     }
  42 }
  43
  44
  45 InstructionNode::InstructionNode(Instruction* I)
  46   : InstrTreeNode(NTInstructionNode, I),
  47     codeIsFoldedIntoParent(false)
  48 {
  49   opLabel = I->getOpcode();
  50
  51   // Distinguish special cases of some instructions such as Ret and Br
  52   //
  53   if (opLabel == Instruction::Ret && cast<ReturnInst>(I)->getReturnValue())
  54     {
  55       opLabel = RetValueOp;                      // ret(value) operation
  56     }
  57   else if (opLabel ==Instruction::Br && !cast<BranchInst>(I)->isUnconditional())
  58     {
  59       opLabel = BrCondOp;               // br(cond) operation
  60     }
  61   else if (opLabel >= Instruction::SetEQ && opLabel <= Instruction::SetGT)
  62     {
  63       opLabel = SetCCOp;                // common label for all SetCC ops
  64     }
  65   else if (opLabel == Instruction::Alloca && I->getNumOperands() > 0)
  66     {
  67       opLabel = AllocaN;                 // Alloca(ptr, N) operation
  68     }
  69   else if (opLabel == Instruction::GetElementPtr &&
  70            cast<GetElementPtrInst>(I)->hasIndices())
  71     {
  72       opLabel = opLabel + 100;           // getElem with index vector
  73     }
  74   else if (opLabel == Instruction::Xor &&
  75            BinaryOperator::isNot(I))
  76     {
  77       opLabel = (I->getType() == Type::BoolTy)?  NotOp  // boolean Not operator
  78                                               : BNotOp; // bitwise Not operator
  79     }
  80   else if (opLabel == Instruction::And ||
  81            opLabel == Instruction::Or ||
  82            opLabel == Instruction::Xor)
  83     {
  84       // Distinguish bitwise operators from logical operators!
  85       if (I->getType() != Type::BoolTy)
  86         opLabel = opLabel + 100;         // bitwise operator
  87     }
  88   else if (opLabel == Instruction::Cast)
  89     {
  90       const Type *ITy = I->getType();
  91       switch(ITy->getPrimitiveID())
  92         {
  93         case Type::BoolTyID:    opLabel = ToBoolTy;    break;
  94         case Type::UByteTyID:   opLabel = ToUByteTy;   break;
  95         case Type::SByteTyID:   opLabel = ToSByteTy;   break;
  96         case Type::UShortTyID:  opLabel = ToUShortTy;  break;
  97         case Type::ShortTyID:   opLabel = ToShortTy;   break;
  98         case Type::UIntTyID:    opLabel = ToUIntTy;    break;
  99         case Type::IntTyID:     opLabel = ToIntTy;     break;
 100         case Type::ULongTyID:   opLabel = ToULongTy;   break;
 101         case Type::LongTyID:    opLabel = ToLongTy;    break;
 102         case Type::FloatTyID:   opLabel = ToFloatTy;   break;
 103         case Type::DoubleTyID:  opLabel = ToDoubleTy;  break;
 104         case Type::ArrayTyID:   opLabel = ToArrayTy;   break;
 105         case Type::PointerTyID: opLabel = ToPointerTy; break;
 106         default:
 107           // Just use `Cast' opcode otherwise. It's probably ignored.
 108           break;
 109         }
 110     }
 111 }
 112
 113
 114 void
 115 InstructionNode::dumpNode(int indent) const
 116 {
 117   for (int i=0; i < indent; i++)
 118     std::cerr << "    ";
 119   std::cerr << getInstruction()->getOpcodeName()
 120             << " [label " << getOpLabel() << "]" << "\n";
 121 }
 122
 123
 124 void
 125 VRegListNode::dumpNode(int indent) const
 126 {
 127   for (int i=0; i < indent; i++)
 128     std::cerr << "    ";
 129
 130   std::cerr << "List" << "\n";
 131 }
 132
 133
 134 void
 135 VRegNode::dumpNode(int indent) const
 136 {
 137   for (int i=0; i < indent; i++)
 138     std::cerr << "    ";
 139
 140   std::cerr << "VReg " << getValue() << "\t(type "
 141             << (int) getValue()->getValueType() << ")" << "\n";
 142 }
 143
 144 void
 145 ConstantNode::dumpNode(int indent) const
 146 {
 147   for (int i=0; i < indent; i++)
 148     std::cerr << "    ";
 149
 150   std::cerr << "Constant " << getValue() << "\t(type "
 151             << (int) getValue()->getValueType() << ")" << "\n";
 152 }
 153
 154 void
 155 LabelNode::dumpNode(int indent) const
 156 {
 157   for (int i=0; i < indent; i++)
 158     std::cerr << "    ";
 159
 160   std::cerr << "Label " << getValue() << "\n";
 161 }
 162
 163 //------------------------------------------------------------------------
 164 // class InstrForest
 165 //
 166 // A forest of instruction trees, usually for a single method.
 167 //------------------------------------------------------------------------
 168
 169 InstrForest::InstrForest(Function *F)
 170 {
 171   for (Function::iterator BB = F->begin(), FE = F->end(); BB != FE; ++BB) {
 172     for(BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 173       buildTreeForInstruction(I);
 174   }
 175 }
 176
 177 InstrForest::~InstrForest()
 178 {
 179   for_each(treeRoots.begin(), treeRoots.end(), deleter<InstructionNode>);
 180 }
 181
 182 void
 183 InstrForest::dump() const
 184 {
 185   for (const_root_iterator I = roots_begin(); I != roots_end(); ++I)
 186     (*I)->dump(/*dumpChildren*/ 1, /*indent*/ 0);
 187 }
 188
 189 inline void
 190 InstrForest::eraseRoot(InstructionNode* node)
 191 {
 192   for (RootSet::reverse_iterator RI=treeRoots.rbegin(), RE=treeRoots.rend();
 193        RI != RE; ++RI)
 194     if (*RI == node)
 195       treeRoots.erase(RI.base()-1);
 196 }
 197
 198 inline void
 199 InstrForest::noteTreeNodeForInstr(Instruction *instr,
 200                                   InstructionNode *treeNode)
 201 {
 202   (*this)[instr] = treeNode;
 203   treeRoots.push_back(treeNode);        // mark node as root of a new tree
 204 }
 205
 206
 207 inline void
 208 InstrForest::setLeftChild(InstrTreeNode *parent, InstrTreeNode *child)
 209 {
 210   parent->LeftChild = child;
 211   child->Parent = parent;
 212   if (InstructionNode* instrNode = dyn_cast<InstructionNode>(child))
 213     eraseRoot(instrNode); // no longer a tree root
 214 }
 215
 216 inline void
 217 InstrForest::setRightChild(InstrTreeNode *parent, InstrTreeNode *child)
 218 {
 219   parent->RightChild = child;
 220   child->Parent = parent;
 221   if (InstructionNode* instrNode = dyn_cast<InstructionNode>(child))
 222     eraseRoot(instrNode); // no longer a tree root
 223 }
 224
 225
 226 InstructionNode*
 227 InstrForest::buildTreeForInstruction(Instruction *instr)
 228 {
 229   InstructionNode *treeNode = getTreeNodeForInstr(instr);
 230   if (treeNode)
 231     {
 232       // treeNode has already been constructed for this instruction
 233       assert(treeNode->getInstruction() == instr);
 234       return treeNode;
 235     }
 236
 237   // Otherwise, create a new tree node for this instruction.
 238   //
 239   treeNode = new InstructionNode(instr);
 240   noteTreeNodeForInstr(instr, treeNode);
 241
 242   if (instr->getOpcode() == Instruction::Call)
 243     { // Operands of call instruction
 244       return treeNode;
 245     }
 246
 247   // If the instruction has more than 2 instruction operands,
 248   // then we need to create artificial list nodes to hold them.
 249   // (Note that we only count operands that get tree nodes, and not
 250   // others such as branch labels for a branch or switch instruction.)
 251   //
 252   // To do this efficiently, we'll walk all operands, build treeNodes
 253   // for all appropriate operands and save them in an array.  We then
 254   // insert children at the end, creating list nodes where needed.
 255   // As a performance optimization, allocate a child array only
 256   // if a fixed array is too small.
 257   //
 258   int numChildren = 0;
 259   InstrTreeNode** childArray = new InstrTreeNode*[instr->getNumOperands()];
 260
 261   //
 262   // Walk the operands of the instruction
 263   //
 264   for (Instruction::op_iterator O = instr->op_begin(); O!=instr->op_end(); ++O)
 265     {
 266       Value* operand = *O;
 267
 268       // Check if the operand is a data value, not an branch label, type,
 269       // method or module.  If the operand is an address type (i.e., label
 270       // or method) that is used in an non-branching operation, e.g., `add'.
 271       // that should be considered a data value.
 272
 273       // Check latter condition here just to simplify the next IF.
 274       bool includeAddressOperand =
 275         (isa<BasicBlock>(operand) || isa<Function>(operand))
 276         && !instr->isTerminator();
 277
 278       if (includeAddressOperand || isa<Instruction>(operand) ||
 279           isa<Constant>(operand) || isa<Argument>(operand) ||
 280           isa<GlobalVariable>(operand))
 281         {
 282           // This operand is a data value
 283
 284           // An instruction that computes the incoming value is added as a
 285           // child of the current instruction if:
 286           //   the value has only a single use
 287           //   AND both instructions are in the same basic block.
 288           //   AND the current instruction is not a PHI (because the incoming
 289           //            value is conceptually in a predecessor block,
 290           //            even though it may be in the same static block)
 291           //
 292           // (Note that if the value has only a single use (viz., `instr'),
 293           //  the def of the value can be safely moved just before instr
 294           //  and therefore it is safe to combine these two instructions.)
 295           //
 296           // In all other cases, the virtual register holding the value
 297           // is used directly, i.e., made a child of the instruction node.
 298           //
 299           InstrTreeNode* opTreeNode;
 300           if (isa<Instruction>(operand) && operand->hasOneUse() &&
 301               cast<Instruction>(operand)->getParent() == instr->getParent() &&
 302               instr->getOpcode() != Instruction::PHI &&
 303               instr->getOpcode() != Instruction::Call)
 304             {
 305               // Recursively create a treeNode for it.
 306               opTreeNode = buildTreeForInstruction((Instruction*)operand);
 307             }
 308           else if (Constant *CPV = dyn_cast<Constant>(operand))
 309             {
 310               // Create a leaf node for a constant
 311               opTreeNode = new ConstantNode(CPV);
 312             }
 313           else
 314             {
 315               // Create a leaf node for the virtual register
 316               opTreeNode = new VRegNode(operand);
 317             }
 318
 319           childArray[numChildren++] = opTreeNode;
 320         }
 321     }
 322
 323   //--------------------------------------------------------------------
 324   // Add any selected operands as children in the tree.
 325   // Certain instructions can have more than 2 in some instances (viz.,
 326   // a CALL or a memory access -- LOAD, STORE, and GetElemPtr -- to an
 327   // array or struct). Make the operands of every such instruction into
 328   // a right-leaning binary tree with the operand nodes at the leaves
 329   // and VRegList nodes as internal nodes.
 330   //--------------------------------------------------------------------
 331
 332   InstrTreeNode *parent = treeNode;
 333
 334   if (numChildren > 2)
 335     {
 336       unsigned instrOpcode = treeNode->getInstruction()->getOpcode();
 337       assert(instrOpcode == Instruction::PHI ||
 338              instrOpcode == Instruction::Call ||
 339              instrOpcode == Instruction::Load ||
 340              instrOpcode == Instruction::Store ||
 341              instrOpcode == Instruction::GetElementPtr);
 342     }
 343
 344   // Insert the first child as a direct child
 345   if (numChildren >= 1)
 346     setLeftChild(parent, childArray[0]);
 347
 348   int n;
 349
 350   // Create a list node for children 2 .. N-1, if any
 351   for (n = numChildren-1; n >= 2; n--)
 352     {
 353       // We have more than two children
 354       InstrTreeNode *listNode = new VRegListNode();
 355       setRightChild(parent, listNode);
 356       setLeftChild(listNode, childArray[numChildren - n]);
 357       parent = listNode;
 358     }
 359
 360   // Now insert the last remaining child (if any).
 361   if (numChildren >= 2)
 362     {
 363       assert(n == 1);
 364       setRightChild(parent, childArray[numChildren - 1]);
 365     }
 366
 367   delete [] childArray;
 368   return treeNode;
 369 }