contrib/llvm/lib/CodeGen/AsmPrinter/DebugHandlerBase.cpp

   1 //===-- llvm/lib/CodeGen/AsmPrinter/DebugHandlerBase.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 // Common functionality for different debug information format backends.
  11 // LLVM currently supports DWARF and CodeView.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "DebugHandlerBase.h"
  16 #include "llvm/CodeGen/AsmPrinter.h"
  17 #include "llvm/CodeGen/MachineFunction.h"
  18 #include "llvm/CodeGen/MachineInstr.h"
  19 #include "llvm/CodeGen/MachineModuleInfo.h"
  20 #include "llvm/IR/DebugInfo.h"
  21 #include "llvm/MC/MCStreamer.h"
  22 #include "llvm/Target/TargetSubtargetInfo.h"
  23
  24 using namespace llvm;
  25
  26 DebugHandlerBase::DebugHandlerBase(AsmPrinter *A) : Asm(A), MMI(Asm->MMI) {}
  27
  28 // Each LexicalScope has first instruction and last instruction to mark
  29 // beginning and end of a scope respectively. Create an inverse map that list
  30 // scopes starts (and ends) with an instruction. One instruction may start (or
  31 // end) multiple scopes. Ignore scopes that are not reachable.
  32 void DebugHandlerBase::identifyScopeMarkers() {
  33   SmallVector<LexicalScope *, 4> WorkList;
  34   WorkList.push_back(LScopes.getCurrentFunctionScope());
  35   while (!WorkList.empty()) {
  36     LexicalScope *S = WorkList.pop_back_val();
  37
  38     const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
  39     if (!Children.empty())
  40       WorkList.append(Children.begin(), Children.end());
  41
  42     if (S->isAbstractScope())
  43       continue;
  44
  45     for (const InsnRange &R : S->getRanges()) {
  46       assert(R.first && "InsnRange does not have first instruction!");
  47       assert(R.second && "InsnRange does not have second instruction!");
  48       requestLabelBeforeInsn(R.first);
  49       requestLabelAfterInsn(R.second);
  50     }
  51   }
  52 }
  53
  54 // Return Label preceding the instruction.
  55 MCSymbol *DebugHandlerBase::getLabelBeforeInsn(const MachineInstr *MI) {
  56   MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
  57   assert(Label && "Didn't insert label before instruction");
  58   return Label;
  59 }
  60
  61 // Return Label immediately following the instruction.
  62 MCSymbol *DebugHandlerBase::getLabelAfterInsn(const MachineInstr *MI) {
  63   return LabelsAfterInsn.lookup(MI);
  64 }
  65
  66 int DebugHandlerBase::fragmentCmp(const DIExpression *P1,
  67                                   const DIExpression *P2) {
  68   auto Fragment1 = *P1->getFragmentInfo();
  69   auto Fragment2 = *P2->getFragmentInfo();
  70   unsigned l1 = Fragment1.OffsetInBits;
  71   unsigned l2 = Fragment2.OffsetInBits;
  72   unsigned r1 = l1 + Fragment1.SizeInBits;
  73   unsigned r2 = l2 + Fragment2.SizeInBits;
  74   if (r1 <= l2)
  75     return -1;
  76   else if (r2 <= l1)
  77     return 1;
  78   else
  79     return 0;
  80 }
  81
  82 bool DebugHandlerBase::fragmentsOverlap(const DIExpression *P1,
  83                                         const DIExpression *P2) {
  84   if (!P1->isFragment() || !P2->isFragment())
  85     return true;
  86   return fragmentCmp(P1, P2) == 0;
  87 }
  88
  89 /// If this type is derived from a base type then return base type size.
  90 uint64_t DebugHandlerBase::getBaseTypeSize(const DITypeRef TyRef) {
  91   DIType *Ty = TyRef.resolve();
  92   assert(Ty);
  93   DIDerivedType *DDTy = dyn_cast<DIDerivedType>(Ty);
  94   if (!DDTy)
  95     return Ty->getSizeInBits();
  96
  97   unsigned Tag = DDTy->getTag();
  98
  99   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
 100       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
 101       Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_atomic_type)
 102     return DDTy->getSizeInBits();
 103
 104   DIType *BaseType = DDTy->getBaseType().resolve();
 105
 106   assert(BaseType && "Unexpected invalid base type");
 107
 108   // If this is a derived type, go ahead and get the base type, unless it's a
 109   // reference then it's just the size of the field. Pointer types have no need
 110   // of this since they're a different type of qualification on the type.
 111   if (BaseType->getTag() == dwarf::DW_TAG_reference_type ||
 112       BaseType->getTag() == dwarf::DW_TAG_rvalue_reference_type)
 113     return Ty->getSizeInBits();
 114
 115   return getBaseTypeSize(BaseType);
 116 }
 117
 118 void DebugHandlerBase::beginFunction(const MachineFunction *MF) {
 119   // Grab the lexical scopes for the function, if we don't have any of those
 120   // then we're not going to be able to do anything.
 121   LScopes.initialize(*MF);
 122   if (LScopes.empty())
 123     return;
 124
 125   // Make sure that each lexical scope will have a begin/end label.
 126   identifyScopeMarkers();
 127
 128   // Calculate history for local variables.
 129   assert(DbgValues.empty() && "DbgValues map wasn't cleaned!");
 130   calculateDbgValueHistory(MF, Asm->MF->getSubtarget().getRegisterInfo(),
 131                            DbgValues);
 132
 133   // Request labels for the full history.
 134   for (const auto &I : DbgValues) {
 135     const auto &Ranges = I.second;
 136     if (Ranges.empty())
 137       continue;
 138
 139     // The first mention of a function argument gets the CurrentFnBegin
 140     // label, so arguments are visible when breaking at function entry.
 141     const DILocalVariable *DIVar = Ranges.front().first->getDebugVariable();
 142     if (DIVar->isParameter() &&
 143         getDISubprogram(DIVar->getScope())->describes(MF->getFunction())) {
 144       LabelsBeforeInsn[Ranges.front().first] = Asm->getFunctionBegin();
 145       if (Ranges.front().first->getDebugExpression()->isFragment()) {
 146         // Mark all non-overlapping initial fragments.
 147         for (auto I = Ranges.begin(); I != Ranges.end(); ++I) {
 148           const DIExpression *Fragment = I->first->getDebugExpression();
 149           if (std::all_of(Ranges.begin(), I,
 150                           [&](DbgValueHistoryMap::InstrRange Pred) {
 151                             return !fragmentsOverlap(
 152                                 Fragment, Pred.first->getDebugExpression());
 153                           }))
 154             LabelsBeforeInsn[I->first] = Asm->getFunctionBegin();
 155           else
 156             break;
 157         }
 158       }
 159     }
 160
 161     for (const auto &Range : Ranges) {
 162       requestLabelBeforeInsn(Range.first);
 163       if (Range.second)
 164         requestLabelAfterInsn(Range.second);
 165     }
 166   }
 167
 168   PrevInstLoc = DebugLoc();
 169   PrevLabel = Asm->getFunctionBegin();
 170 }
 171
 172 void DebugHandlerBase::beginInstruction(const MachineInstr *MI) {
 173   if (!MMI->hasDebugInfo())
 174     return;
 175
 176   assert(CurMI == nullptr);
 177   CurMI = MI;
 178
 179   // Insert labels where requested.
 180   DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
 181       LabelsBeforeInsn.find(MI);
 182
 183   // No label needed.
 184   if (I == LabelsBeforeInsn.end())
 185     return;
 186
 187   // Label already assigned.
 188   if (I->second)
 189     return;
 190
 191   if (!PrevLabel) {
 192     PrevLabel = MMI->getContext().createTempSymbol();
 193     Asm->OutStreamer->EmitLabel(PrevLabel);
 194   }
 195   I->second = PrevLabel;
 196 }
 197
 198 void DebugHandlerBase::endInstruction() {
 199   if (!MMI->hasDebugInfo())
 200     return;
 201
 202   assert(CurMI != nullptr);
 203   // Don't create a new label after DBG_VALUE instructions.
 204   // They don't generate code.
 205   if (!CurMI->isDebugValue()) {
 206     PrevLabel = nullptr;
 207     PrevInstBB = CurMI->getParent();
 208   }
 209
 210   DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
 211       LabelsAfterInsn.find(CurMI);
 212   CurMI = nullptr;
 213
 214   // No label needed.
 215   if (I == LabelsAfterInsn.end())
 216     return;
 217
 218   // Label already assigned.
 219   if (I->second)
 220     return;
 221
 222   // We need a label after this instruction.
 223   if (!PrevLabel) {
 224     PrevLabel = MMI->getContext().createTempSymbol();
 225     Asm->OutStreamer->EmitLabel(PrevLabel);
 226   }
 227   I->second = PrevLabel;
 228 }
 229
 230 void DebugHandlerBase::endFunction(const MachineFunction *MF) {
 231   DbgValues.clear();
 232   LabelsBeforeInsn.clear();
 233   LabelsAfterInsn.clear();
 234 }