lib/Target/SparcV9/RegAlloc/LiveRangeInfo.cpp

   1 //===-- LiveRangeInfo.cpp -------------------------------------------------===//
   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 //  Live range construction for coloring-based register allocation for LLVM.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "IGNode.h"
  15 #include "LiveRangeInfo.h"
  16 #include "RegAllocCommon.h"
  17 #include "RegClass.h"
  18 #include "llvm/Function.h"
  19 #include "llvm/Type.h"
  20 #include "llvm/CodeGen/MachineInstr.h"
  21 #include "llvm/CodeGen/MachineFunction.h"
  22 #include "llvm/Target/TargetMachine.h"
  23 #include "llvm/Target/TargetInstrInfo.h"
  24 #include "../SparcV9RegInfo.h"
  25 #include "llvm/ADT/SetOperations.h"
  26 #include <iostream>
  27
  28 namespace llvm {
  29
  30 unsigned LiveRange::getRegClassID() const { return getRegClass()->getID(); }
  31
  32 LiveRangeInfo::LiveRangeInfo(const Function *F, const TargetMachine &tm,
  33                              std::vector<RegClass *> &RCL)
  34   : Meth(F), TM(tm), RegClassList(RCL), MRI(*tm.getRegInfo()) { }
  35
  36
  37 LiveRangeInfo::~LiveRangeInfo() {
  38   for (LiveRangeMapType::iterator MI = LiveRangeMap.begin();
  39        MI != LiveRangeMap.end(); ++MI) {
  40
  41     if (MI->first && MI->second) {
  42       LiveRange *LR = MI->second;
  43
  44       // we need to be careful in deleting LiveRanges in LiveRangeMap
  45       // since two/more Values in the live range map can point to the same
  46       // live range. We have to make the other entries NULL when we delete
  47       // a live range.
  48
  49       for (LiveRange::iterator LI = LR->begin(); LI != LR->end(); ++LI)
  50         LiveRangeMap[*LI] = 0;
  51
  52       delete LR;
  53     }
  54   }
  55 }
  56
  57
  58 //---------------------------------------------------------------------------
  59 // union two live ranges into one. The 2nd LR is deleted. Used for coalescing.
  60 // Note: the caller must make sure that L1 and L2 are distinct and both
  61 // LRs don't have suggested colors
  62 //---------------------------------------------------------------------------
  63
  64 void LiveRangeInfo::unionAndUpdateLRs(LiveRange *L1, LiveRange *L2) {
  65   assert(L1 != L2 && (!L1->hasSuggestedColor() || !L2->hasSuggestedColor()));
  66   assert(! (L1->hasColor() && L2->hasColor()) ||
  67          L1->getColor() == L2->getColor());
  68
  69   L2->insert (L1->begin(), L1->end());   // add elements of L2 to L1
  70
  71   for(LiveRange::iterator L2It = L2->begin(); L2It != L2->end(); ++L2It) {
  72     L1->insert(*L2It);                  // add the var in L2 to L1
  73     LiveRangeMap[*L2It] = L1;           // now the elements in L2 should map
  74                                         //to L1
  75   }
  76
  77   // set call interference for L1 from L2
  78   if (L2->isCallInterference())
  79     L1->setCallInterference();
  80
  81   // add the spill costs
  82   L1->addSpillCost(L2->getSpillCost());
  83
  84   // If L2 has a color, give L1 that color.  Note that L1 may have had the same
  85   // color or none, but would not have a different color as asserted above.
  86   if (L2->hasColor())
  87     L1->setColor(L2->getColor());
  88
  89   // Similarly, if LROfUse(L2) has a suggested color, the new range
  90   // must have the same color.
  91   if (L2->hasSuggestedColor())
  92     L1->setSuggestedColor(L2->getSuggestedColor());
  93
  94   delete L2;                        // delete L2 as it is no longer needed
  95 }
  96
  97
  98 //---------------------------------------------------------------------------
  99 // Method for creating a single live range for a definition.
 100 // The definition must be represented by a virtual register (a Value).
 101 // Note: this function does *not* check that no live range exists for def.
 102 //---------------------------------------------------------------------------
 103
 104 LiveRange*
 105 LiveRangeInfo::createNewLiveRange(const Value* Def, bool isCC /* = false*/)
 106 {
 107   LiveRange* DefRange = new LiveRange();  // Create a new live range,
 108   DefRange->insert(Def);                  // add Def to it,
 109   LiveRangeMap[Def] = DefRange;           // and update the map.
 110
 111   // set the register class of the new live range
 112   DefRange->setRegClass(RegClassList[MRI.getRegClassIDOfType(Def->getType(),
 113                                                              isCC)]);
 114
 115   if (DEBUG_RA >= RA_DEBUG_LiveRanges) {
 116     std::cerr << "  Creating a LR for def ";
 117     if (isCC) std::cerr << " (CC Register!)";
 118     std::cerr << " : " << RAV(Def) << "\n";
 119   }
 120   return DefRange;
 121 }
 122
 123
 124 LiveRange*
 125 LiveRangeInfo::createOrAddToLiveRange(const Value* Def, bool isCC /* = false*/)
 126 {
 127   LiveRange *DefRange = LiveRangeMap[Def];
 128
 129   // check if the LR is already there (because of multiple defs)
 130   if (!DefRange) {
 131     DefRange = createNewLiveRange(Def, isCC);
 132   } else {                          // live range already exists
 133     DefRange->insert(Def);          // add the operand to the range
 134     LiveRangeMap[Def] = DefRange;   // make operand point to merged set
 135     if (DEBUG_RA >= RA_DEBUG_LiveRanges)
 136       std::cerr << "   Added to existing LR for def: " << RAV(Def) << "\n";
 137   }
 138   return DefRange;
 139 }
 140
 141
 142 //---------------------------------------------------------------------------
 143 // Method for constructing all live ranges in a function. It creates live
 144 // ranges for all values defined in the instruction stream. Also, it
 145 // creates live ranges for all incoming arguments of the function.
 146 //---------------------------------------------------------------------------
 147 void LiveRangeInfo::constructLiveRanges() {
 148
 149   if (DEBUG_RA >= RA_DEBUG_LiveRanges)
 150     std::cerr << "Constructing Live Ranges ...\n";
 151
 152   // first find the live ranges for all incoming args of the function since
 153   // those LRs start from the start of the function
 154   for (Function::const_arg_iterator AI = Meth->arg_begin(); AI != Meth->arg_end(); ++AI)
 155     createNewLiveRange(AI, /*isCC*/ false);
 156
 157   // Now suggest hardware registers for these function args
 158   MRI.suggestRegs4MethodArgs(Meth, *this);
 159
 160   // Now create LRs for machine instructions.  A new LR will be created
 161   // only for defs in the machine instr since, we assume that all Values are
 162   // defined before they are used. However, there can be multiple defs for
 163   // the same Value in machine instructions.
 164   //
 165   // Also, find CALL and RETURN instructions, which need extra work.
 166   //
 167   MachineFunction &MF = MachineFunction::get(Meth);
 168   for (MachineFunction::iterator BBI = MF.begin(); BBI != MF.end(); ++BBI) {
 169     MachineBasicBlock &MBB = *BBI;
 170
 171     // iterate over all the machine instructions in BB
 172     for(MachineBasicBlock::iterator MInstIterator = MBB.begin();
 173         MInstIterator != MBB.end(); ++MInstIterator) {
 174       MachineInstr *MInst = MInstIterator;
 175
 176       // If the machine instruction is a  call/return instruction, add it to
 177       // CallRetInstrList for processing its args, ret value, and ret addr.
 178       //
 179       if(TM.getInstrInfo()->isReturn(MInst->getOpcode()) ||
 180          TM.getInstrInfo()->isCall(MInst->getOpcode()))
 181         CallRetInstrList.push_back(MInst);
 182
 183       // iterate over explicit MI operands and create a new LR
 184       // for each operand that is defined by the instruction
 185       for (MachineInstr::val_op_iterator OpI = MInst->begin(),
 186              OpE = MInst->end(); OpI != OpE; ++OpI)
 187         if (OpI.isDef()) {
 188           const Value *Def = *OpI;
 189           bool isCC = (OpI.getMachineOperand().getType()
 190                        == MachineOperand::MO_CCRegister);
 191           LiveRange* LR = createOrAddToLiveRange(Def, isCC);
 192
 193           // If the operand has a pre-assigned register,
 194           // set it directly in the LiveRange
 195           if (OpI.getMachineOperand().hasAllocatedReg()) {
 196             unsigned getClassId;
 197             LR->setColor(MRI.getClassRegNum(OpI.getMachineOperand().getReg(),
 198                                             getClassId));
 199           }
 200         }
 201
 202       // iterate over implicit MI operands and create a new LR
 203       // for each operand that is defined by the instruction
 204       for (unsigned i = 0; i < MInst->getNumImplicitRefs(); ++i)
 205         if (MInst->getImplicitOp(i).isDef()) {
 206           const Value *Def = MInst->getImplicitRef(i);
 207           LiveRange* LR = createOrAddToLiveRange(Def, /*isCC*/ false);
 208
 209           // If the implicit operand has a pre-assigned register,
 210           // set it directly in the LiveRange
 211           if (MInst->getImplicitOp(i).hasAllocatedReg()) {
 212             unsigned getClassId;
 213             LR->setColor(MRI.getClassRegNum(
 214                                 MInst->getImplicitOp(i).getReg(),
 215                                 getClassId));
 216           }
 217         }
 218
 219     } // for all machine instructions in the BB
 220   } // for all BBs in function
 221
 222   // Now we have to suggest clors for call and return arg live ranges.
 223   // Also, if there are implicit defs (e.g., retun value of a call inst)
 224   // they must be added to the live range list
 225   //
 226   suggestRegs4CallRets();
 227
 228   if( DEBUG_RA >= RA_DEBUG_LiveRanges)
 229     std::cerr << "Initial Live Ranges constructed!\n";
 230 }
 231
 232
 233 //---------------------------------------------------------------------------
 234 // If some live ranges must be colored with specific hardware registers
 235 // (e.g., for outgoing call args), suggesting of colors for such live
 236 // ranges is done using target specific function. Those functions are called
 237 // from this function. The target specific methods must:
 238 //    1) suggest colors for call and return args.
 239 //    2) create new LRs for implicit defs in machine instructions
 240 //---------------------------------------------------------------------------
 241 void LiveRangeInfo::suggestRegs4CallRets() {
 242   std::vector<MachineInstr*>::iterator It = CallRetInstrList.begin();
 243   for( ; It != CallRetInstrList.end(); ++It) {
 244     MachineInstr *MInst = *It;
 245     MachineOpCode OpCode = MInst->getOpcode();
 246
 247     if (TM.getInstrInfo()->isReturn(OpCode))
 248       MRI.suggestReg4RetValue(MInst, *this);
 249     else if (TM.getInstrInfo()->isCall(OpCode))
 250       MRI.suggestRegs4CallArgs(MInst, *this);
 251     else
 252       assert( 0 && "Non call/ret instr in CallRetInstrList" );
 253   }
 254 }
 255
 256
 257 //--------------------------------------------------------------------------
 258 // The following method coalesces live ranges when possible. This method
 259 // must be called after the interference graph has been constructed.
 260
 261
 262 /* Algorithm:
 263    for each BB in function
 264      for each machine instruction (inst)
 265        for each definition (def) in inst
 266          for each operand (op) of inst that is a use
 267            if the def and op are of the same register type
 268              if the def and op do not interfere //i.e., not simultaneously live
 269                if (degree(LR of def) + degree(LR of op)) <= # avail regs
 270                  if both LRs do not have suggested colors
 271                     merge2IGNodes(def, op) // i.e., merge 2 LRs
 272
 273 */
 274 //---------------------------------------------------------------------------
 275
 276
 277 // Checks if live range LR interferes with any node assigned or suggested to
 278 // be assigned the specified color
 279 //
 280 inline bool InterferesWithColor(const LiveRange& LR, unsigned color) {
 281   IGNode* lrNode = LR.getUserIGNode();
 282   for (unsigned n=0, NN = lrNode->getNumOfNeighbors(); n < NN; n++) {
 283     LiveRange *neighLR = lrNode->getAdjIGNode(n)->getParentLR();
 284     if (neighLR->hasColor() && neighLR->getColor() == color)
 285       return true;
 286     if (neighLR->hasSuggestedColor() && neighLR->getSuggestedColor() == color)
 287       return true;
 288   }
 289   return false;
 290 }
 291
 292 // Cannot coalesce if any of the following is true:
 293 // (1) Both LRs have suggested colors (should be "different suggested colors"?)
 294 // (2) Both LR1 and LR2 have colors and the colors are different
 295 //    (but if the colors are the same, it is definitely safe to coalesce)
 296 // (3) LR1 has color and LR2 interferes with any LR that has the same color
 297 // (4) LR2 has color and LR1 interferes with any LR that has the same color
 298 //
 299 inline bool InterfsPreventCoalescing(const LiveRange& LROfDef,
 300                                      const LiveRange& LROfUse) {
 301   // (4) if they have different suggested colors, cannot coalesce
 302   if (LROfDef.hasSuggestedColor() && LROfUse.hasSuggestedColor())
 303     return true;
 304
 305   // if neither has a color, nothing more to do.
 306   if (! LROfDef.hasColor() && ! LROfUse.hasColor())
 307     return false;
 308
 309   // (2, 3) if L1 has color...
 310   if (LROfDef.hasColor()) {
 311     if (LROfUse.hasColor())
 312       return (LROfUse.getColor() != LROfDef.getColor());
 313     return InterferesWithColor(LROfUse, LROfDef.getColor());
 314   }
 315
 316   // (4) else only LROfUse has a color: check if that could interfere
 317   return InterferesWithColor(LROfDef, LROfUse.getColor());
 318 }
 319
 320
 321 void LiveRangeInfo::coalesceLRs()
 322 {
 323   if(DEBUG_RA >= RA_DEBUG_LiveRanges)
 324     std::cerr << "\nCoalescing LRs ...\n";
 325
 326   MachineFunction &MF = MachineFunction::get(Meth);
 327   for (MachineFunction::iterator BBI = MF.begin(); BBI != MF.end(); ++BBI) {
 328     MachineBasicBlock &MBB = *BBI;
 329
 330     // iterate over all the machine instructions in BB
 331     for(MachineBasicBlock::iterator MII = MBB.begin(); MII != MBB.end(); ++MII){
 332       const MachineInstr *MI = MII;
 333
 334       if( DEBUG_RA >= RA_DEBUG_LiveRanges) {
 335         std::cerr << " *Iterating over machine instr ";
 336         MI->dump();
 337         std::cerr << "\n";
 338       }
 339
 340       // iterate over  MI operands to find defs
 341       for(MachineInstr::const_val_op_iterator DefI = MI->begin(),
 342             DefE = MI->end(); DefI != DefE; ++DefI) {
 343         if (DefI.isDef()) { // this operand is modified
 344           LiveRange *LROfDef = getLiveRangeForValue( *DefI );
 345           RegClass *RCOfDef = LROfDef->getRegClass();
 346
 347           MachineInstr::const_val_op_iterator UseI = MI->begin(),
 348             UseE = MI->end();
 349           for( ; UseI != UseE; ++UseI) { // for all uses
 350             LiveRange *LROfUse = getLiveRangeForValue( *UseI );
 351             if (!LROfUse) {             // if LR of use is not found
 352               //don't warn about labels
 353               if (!isa<BasicBlock>(*UseI) && DEBUG_RA >= RA_DEBUG_LiveRanges)
 354                 std::cerr << " !! Warning: No LR for use " << RAV(*UseI)<< "\n";
 355               continue;                 // ignore and continue
 356             }
 357
 358             if (LROfUse == LROfDef)     // nothing to merge if they are same
 359               continue;
 360
 361             if (MRI.getRegTypeForLR(LROfDef) ==
 362                 MRI.getRegTypeForLR(LROfUse)) {
 363               // If the two RegTypes are the same
 364               if (!RCOfDef->getInterference(LROfDef, LROfUse) ) {
 365
 366                 unsigned CombinedDegree =
 367                   LROfDef->getUserIGNode()->getNumOfNeighbors() +
 368                   LROfUse->getUserIGNode()->getNumOfNeighbors();
 369
 370                 if (CombinedDegree > RCOfDef->getNumOfAvailRegs()) {
 371                   // get more precise estimate of combined degree
 372                   CombinedDegree = LROfDef->getUserIGNode()->
 373                     getCombinedDegree(LROfUse->getUserIGNode());
 374                 }
 375
 376                 if (CombinedDegree <= RCOfDef->getNumOfAvailRegs()) {
 377                   // if both LRs do not have different pre-assigned colors
 378                   // and both LRs do not have suggested colors
 379                   if (! InterfsPreventCoalescing(*LROfDef, *LROfUse)) {
 380                     RCOfDef->mergeIGNodesOfLRs(LROfDef, LROfUse);
 381                     unionAndUpdateLRs(LROfDef, LROfUse);
 382                   }
 383
 384                 } // if combined degree is less than # of regs
 385               } // if def and use do not interfere
 386             }// if reg classes are the same
 387           } // for all uses
 388         } // if def
 389       } // for all defs
 390     } // for all machine instructions
 391   } // for all BBs
 392
 393   if (DEBUG_RA >= RA_DEBUG_LiveRanges)
 394     std::cerr << "\nCoalescing Done!\n";
 395 }
 396
 397 /*--------------------------- Debug code for printing ---------------*/
 398
 399
 400 void LiveRangeInfo::printLiveRanges() {
 401   LiveRangeMapType::iterator HMI = LiveRangeMap.begin();   // hash map iterator
 402   std::cerr << "\nPrinting Live Ranges from Hash Map:\n";
 403   for( ; HMI != LiveRangeMap.end(); ++HMI) {
 404     if (HMI->first && HMI->second) {
 405       std::cerr << " Value* " << RAV(HMI->first) << "\t: ";
 406       if (IGNode* igNode = HMI->second->getUserIGNode())
 407         std::cerr << "LR# " << igNode->getIndex();
 408       else
 409         std::cerr << "LR# " << "<no-IGNode>";
 410       std::cerr << "\t:Values = " << *HMI->second << "\n";
 411     }
 412   }
 413 }
 414
 415 } // End llvm namespace