lib/CodeGen/MachineModuleInfo.cpp

   1 //===-- llvm/CodeGen/MachineModuleInfo.cpp ----------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/CodeGen/MachineModuleInfo.h"
  11
  12 #include "llvm/Constants.h"
  13 #include "llvm/Analysis/ValueTracking.h"
  14 #include "llvm/CodeGen/MachineFunctionPass.h"
  15 #include "llvm/CodeGen/MachineFunction.h"
  16 #include "llvm/CodeGen/Passes.h"
  17 #include "llvm/Target/TargetInstrInfo.h"
  18 #include "llvm/Target/TargetMachine.h"
  19 #include "llvm/Target/TargetOptions.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/GlobalVariable.h"
  22 #include "llvm/Intrinsics.h"
  23 #include "llvm/Instructions.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/Support/Dwarf.h"
  26 #include "llvm/Support/Streams.h"
  27 using namespace llvm;
  28 using namespace llvm::dwarf;
  29
  30 // Handle the Pass registration stuff necessary to use TargetData's.
  31 static RegisterPass<MachineModuleInfo>
  32 X("machinemoduleinfo", "Module Information");
  33 char MachineModuleInfo::ID = 0;
  34
  35 //===----------------------------------------------------------------------===//
  36
  37 MachineModuleInfo::MachineModuleInfo()
  38 : ImmutablePass(&ID)
  39 , LabelIDList()
  40 , FrameMoves()
  41 , LandingPads()
  42 , Personalities()
  43 , CallsEHReturn(0)
  44 , CallsUnwindInit(0)
  45 , DbgInfoAvailable(false)
  46 {
  47   // Always emit "no personality" info
  48   Personalities.push_back(NULL);
  49 }
  50 MachineModuleInfo::~MachineModuleInfo() {
  51
  52 }
  53
  54 /// doInitialization - Initialize the state for a new module.
  55 ///
  56 bool MachineModuleInfo::doInitialization() {
  57   return false;
  58 }
  59
  60 /// doFinalization - Tear down the state after completion of a module.
  61 ///
  62 bool MachineModuleInfo::doFinalization() {
  63   return false;
  64 }
  65
  66 /// BeginFunction - Begin gathering function meta information.
  67 ///
  68 void MachineModuleInfo::BeginFunction(MachineFunction *MF) {
  69   // Coming soon.
  70 }
  71
  72 /// EndFunction - Discard function meta information.
  73 ///
  74 void MachineModuleInfo::EndFunction() {
  75   // Clean up frame info.
  76   FrameMoves.clear();
  77
  78   // Clean up exception info.
  79   LandingPads.clear();
  80   TypeInfos.clear();
  81   FilterIds.clear();
  82   FilterEnds.clear();
  83   CallsEHReturn = 0;
  84   CallsUnwindInit = 0;
  85 }
  86
  87 /// AnalyzeModule - Scan the module for global debug information.
  88 ///
  89 void MachineModuleInfo::AnalyzeModule(Module &M) {
  90   // Insert functions in the llvm.used array into UsedFunctions.
  91   GlobalVariable *GV = M.getGlobalVariable("llvm.used");
  92   if (!GV || !GV->hasInitializer()) return;
  93
  94   // Should be an array of 'i8*'.
  95   ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
  96   if (InitList == 0) return;
  97
  98   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
  99     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(InitList->getOperand(i)))
 100       if (CE->getOpcode() == Instruction::BitCast)
 101         if (Function *F = dyn_cast<Function>(CE->getOperand(0)))
 102           UsedFunctions.insert(F);
 103   }
 104 }
 105
 106 //===-EH-------------------------------------------------------------------===//
 107
 108 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
 109 /// specified MachineBasicBlock.
 110 LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
 111     (MachineBasicBlock *LandingPad) {
 112   unsigned N = LandingPads.size();
 113   for (unsigned i = 0; i < N; ++i) {
 114     LandingPadInfo &LP = LandingPads[i];
 115     if (LP.LandingPadBlock == LandingPad)
 116       return LP;
 117   }
 118
 119   LandingPads.push_back(LandingPadInfo(LandingPad));
 120   return LandingPads[N];
 121 }
 122
 123 /// addInvoke - Provide the begin and end labels of an invoke style call and
 124 /// associate it with a try landing pad block.
 125 void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
 126                                   unsigned BeginLabel, unsigned EndLabel) {
 127   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
 128   LP.BeginLabels.push_back(BeginLabel);
 129   LP.EndLabels.push_back(EndLabel);
 130 }
 131
 132 /// addLandingPad - Provide the label of a try LandingPad block.
 133 ///
 134 unsigned MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
 135   unsigned LandingPadLabel = NextLabelID();
 136   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
 137   LP.LandingPadLabel = LandingPadLabel;
 138   return LandingPadLabel;
 139 }
 140
 141 /// addPersonality - Provide the personality function for the exception
 142 /// information.
 143 void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
 144                                        Function *Personality) {
 145   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
 146   LP.Personality = Personality;
 147
 148   for (unsigned i = 0; i < Personalities.size(); ++i)
 149     if (Personalities[i] == Personality)
 150       return;
 151
 152   Personalities.push_back(Personality);
 153 }
 154
 155 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
 156 ///
 157 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock *LandingPad,
 158                                         std::vector<GlobalVariable *> &TyInfo) {
 159   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
 160   for (unsigned N = TyInfo.size(); N; --N)
 161     LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
 162 }
 163
 164 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
 165 ///
 166 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock *LandingPad,
 167                                         std::vector<GlobalVariable *> &TyInfo) {
 168   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
 169   std::vector<unsigned> IdsInFilter(TyInfo.size());
 170   for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
 171     IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
 172   LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
 173 }
 174
 175 /// addCleanup - Add a cleanup action for a landing pad.
 176 ///
 177 void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
 178   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
 179   LP.TypeIds.push_back(0);
 180 }
 181
 182 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
 183 /// pads.
 184 void MachineModuleInfo::TidyLandingPads() {
 185   for (unsigned i = 0; i != LandingPads.size(); ) {
 186     LandingPadInfo &LandingPad = LandingPads[i];
 187     LandingPad.LandingPadLabel = MappedLabel(LandingPad.LandingPadLabel);
 188
 189     // Special case: we *should* emit LPs with null LP MBB. This indicates
 190     // "nounwind" case.
 191     if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
 192       LandingPads.erase(LandingPads.begin() + i);
 193       continue;
 194     }
 195
 196     for (unsigned j=0; j != LandingPads[i].BeginLabels.size(); ) {
 197       unsigned BeginLabel = MappedLabel(LandingPad.BeginLabels[j]);
 198       unsigned EndLabel = MappedLabel(LandingPad.EndLabels[j]);
 199
 200       if (!BeginLabel || !EndLabel) {
 201         LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
 202         LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
 203         continue;
 204       }
 205
 206       LandingPad.BeginLabels[j] = BeginLabel;
 207       LandingPad.EndLabels[j] = EndLabel;
 208       ++j;
 209     }
 210
 211     // Remove landing pads with no try-ranges.
 212     if (LandingPads[i].BeginLabels.empty()) {
 213       LandingPads.erase(LandingPads.begin() + i);
 214       continue;
 215     }
 216
 217     // If there is no landing pad, ensure that the list of typeids is empty.
 218     // If the only typeid is a cleanup, this is the same as having no typeids.
 219     if (!LandingPad.LandingPadBlock ||
 220         (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
 221       LandingPad.TypeIds.clear();
 222
 223     ++i;
 224   }
 225 }
 226
 227 /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
 228 /// function wide.
 229 unsigned MachineModuleInfo::getTypeIDFor(GlobalVariable *TI) {
 230   for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
 231     if (TypeInfos[i] == TI) return i + 1;
 232
 233   TypeInfos.push_back(TI);
 234   return TypeInfos.size();
 235 }
 236
 237 /// getFilterIDFor - Return the filter id for the specified typeinfos.  This is
 238 /// function wide.
 239 int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
 240   // If the new filter coincides with the tail of an existing filter, then
 241   // re-use the existing filter.  Folding filters more than this requires
 242   // re-ordering filters and/or their elements - probably not worth it.
 243   for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
 244        E = FilterEnds.end(); I != E; ++I) {
 245     unsigned i = *I, j = TyIds.size();
 246
 247     while (i && j)
 248       if (FilterIds[--i] != TyIds[--j])
 249         goto try_next;
 250
 251     if (!j)
 252       // The new filter coincides with range [i, end) of the existing filter.
 253       return -(1 + i);
 254
 255 try_next:;
 256   }
 257
 258   // Add the new filter.
 259   int FilterID = -(1 + FilterIds.size());
 260   FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
 261   for (unsigned I = 0, N = TyIds.size(); I != N; ++I)
 262     FilterIds.push_back(TyIds[I]);
 263   FilterEnds.push_back(FilterIds.size());
 264   FilterIds.push_back(0); // terminator
 265   return FilterID;
 266 }
 267
 268 /// getPersonality - Return the personality function for the current function.
 269 Function *MachineModuleInfo::getPersonality() const {
 270   // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
 271   // function
 272   return !LandingPads.empty() ? LandingPads[0].Personality : NULL;
 273 }
 274
 275 /// getPersonalityIndex - Return unique index for current personality
 276 /// function. NULL personality function should always get zero index.
 277 unsigned MachineModuleInfo::getPersonalityIndex() const {
 278   const Function* Personality = NULL;
 279
 280   // Scan landing pads. If there is at least one non-NULL personality - use it.
 281   for (unsigned i = 0; i != LandingPads.size(); ++i)
 282     if (LandingPads[i].Personality) {
 283       Personality = LandingPads[i].Personality;
 284       break;
 285     }
 286
 287   for (unsigned i = 0; i < Personalities.size(); ++i) {
 288     if (Personalities[i] == Personality)
 289       return i;
 290   }
 291
 292   // This should never happen
 293   assert(0 && "Personality function should be set!");
 294   return 0;
 295 }
 296
 297 //===----------------------------------------------------------------------===//
 298 /// DebugLabelFolding pass - This pass prunes out redundant labels.  This allows
 299 /// a info consumer to determine if the range of two labels is empty, by seeing
 300 /// if the labels map to the same reduced label.
 301
 302 namespace llvm {
 303
 304 struct DebugLabelFolder : public MachineFunctionPass {
 305   static char ID;
 306   DebugLabelFolder() : MachineFunctionPass(&ID) {}
 307
 308   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 309     AU.addPreservedID(MachineLoopInfoID);
 310     AU.addPreservedID(MachineDominatorsID);
 311     MachineFunctionPass::getAnalysisUsage(AU);
 312   }
 313
 314   virtual bool runOnMachineFunction(MachineFunction &MF);
 315   virtual const char *getPassName() const { return "Label Folder"; }
 316 };
 317
 318 char DebugLabelFolder::ID = 0;
 319
 320 bool DebugLabelFolder::runOnMachineFunction(MachineFunction &MF) {
 321   // Get machine module info.
 322   MachineModuleInfo *MMI = getAnalysisIfAvailable<MachineModuleInfo>();
 323   if (!MMI) return false;
 324
 325   // Track if change is made.
 326   bool MadeChange = false;
 327   // No prior label to begin.
 328   unsigned PriorLabel = 0;
 329
 330   // Iterate through basic blocks.
 331   for (MachineFunction::iterator BB = MF.begin(), E = MF.end();
 332        BB != E; ++BB) {
 333     // Iterate through instructions.
 334     for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ) {
 335       // Is it a label.
 336       if (I->isDebugLabel() && !MMI->isDbgLabelUsed(I->getOperand(0).getImm())){
 337         // The label ID # is always operand #0, an immediate.
 338         unsigned NextLabel = I->getOperand(0).getImm();
 339
 340         // If there was an immediate prior label.
 341         if (PriorLabel) {
 342           // Remap the current label to prior label.
 343           MMI->RemapLabel(NextLabel, PriorLabel);
 344           // Delete the current label.
 345           I = BB->erase(I);
 346           // Indicate a change has been made.
 347           MadeChange = true;
 348           continue;
 349         } else {
 350           // Start a new round.
 351           PriorLabel = NextLabel;
 352         }
 353        } else {
 354         // No consecutive labels.
 355         PriorLabel = 0;
 356       }
 357
 358       ++I;
 359     }
 360   }
 361
 362   return MadeChange;
 363 }
 364
 365 FunctionPass *createDebugLabelFoldingPass() { return new DebugLabelFolder(); }
 366
 367 }
 368