[docs] Add LICENSE.txt to the root of the mono-repo
[llvm-project.git] / llvm / lib / CodeGen / AsmPrinter / DbgEntityHistoryCalculator.cpp
blobdabbfb45f687c3c79718c882696f8053188800a7
1 //===- llvm/CodeGen/AsmPrinter/DbgEntityHistoryCalculator.cpp -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
9 #include "llvm/CodeGen/DbgEntityHistoryCalculator.h"
10 #include "llvm/ADT/Optional.h"
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallSet.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/CodeGen/LexicalScopes.h"
15 #include "llvm/CodeGen/MachineBasicBlock.h"
16 #include "llvm/CodeGen/MachineFunction.h"
17 #include "llvm/CodeGen/MachineInstr.h"
18 #include "llvm/CodeGen/MachineOperand.h"
19 #include "llvm/CodeGen/TargetLowering.h"
20 #include "llvm/CodeGen/TargetRegisterInfo.h"
21 #include "llvm/CodeGen/TargetSubtargetInfo.h"
22 #include "llvm/IR/DebugInfoMetadata.h"
23 #include "llvm/IR/DebugLoc.h"
24 #include "llvm/MC/MCRegisterInfo.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/raw_ostream.h"
27 #include <cassert>
28 #include <map>
29 #include <utility>
31 using namespace llvm;
33 #define DEBUG_TYPE "dwarfdebug"
35 namespace {
36 using EntryIndex = DbgValueHistoryMap::EntryIndex;
39 void InstructionOrdering::initialize(const MachineFunction &MF) {
40 // We give meta instructions the same ordinal as the preceding instruction
41 // because this class is written for the task of comparing positions of
42 // variable location ranges against scope ranges. To reflect what we'll see
43 // in the binary, when we look at location ranges we must consider all
44 // DBG_VALUEs between two real instructions at the same position. And a
45 // scope range which ends on a meta instruction should be considered to end
46 // at the last seen real instruction. E.g.
48 // 1 instruction p Both the variable location for x and for y start
49 // 1 DBG_VALUE for "x" after instruction p so we give them all the same
50 // 1 DBG_VALUE for "y" number. If a scope range ends at DBG_VALUE for "y",
51 // 2 instruction q we should treat it as ending after instruction p
52 // because it will be the last real instruction in the
53 // range. DBG_VALUEs at or after this position for
54 // variables declared in the scope will have no effect.
55 clear();
56 unsigned Position = 0;
57 for (const MachineBasicBlock &MBB : MF)
58 for (const MachineInstr &MI : MBB)
59 InstNumberMap[&MI] = MI.isMetaInstruction() ? Position : ++Position;
62 bool InstructionOrdering::isBefore(const MachineInstr *A,
63 const MachineInstr *B) const {
64 assert(A->getParent() && B->getParent() && "Operands must have a parent");
65 assert(A->getMF() == B->getMF() &&
66 "Operands must be in the same MachineFunction");
67 return InstNumberMap.lookup(A) < InstNumberMap.lookup(B);
70 bool DbgValueHistoryMap::startDbgValue(InlinedEntity Var,
71 const MachineInstr &MI,
72 EntryIndex &NewIndex) {
73 // Instruction range should start with a DBG_VALUE instruction for the
74 // variable.
75 assert(MI.isDebugValue() && "not a DBG_VALUE");
76 auto &Entries = VarEntries[Var];
77 if (!Entries.empty() && Entries.back().isDbgValue() &&
78 !Entries.back().isClosed() &&
79 Entries.back().getInstr()->isIdenticalTo(MI)) {
80 LLVM_DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
81 << "\t" << Entries.back().getInstr() << "\t" << MI
82 << "\n");
83 return false;
85 Entries.emplace_back(&MI, Entry::DbgValue);
86 NewIndex = Entries.size() - 1;
87 return true;
90 EntryIndex DbgValueHistoryMap::startClobber(InlinedEntity Var,
91 const MachineInstr &MI) {
92 auto &Entries = VarEntries[Var];
93 // If an instruction clobbers multiple registers that the variable is
94 // described by, then we may have already created a clobbering instruction.
95 if (Entries.back().isClobber() && Entries.back().getInstr() == &MI)
96 return Entries.size() - 1;
97 Entries.emplace_back(&MI, Entry::Clobber);
98 return Entries.size() - 1;
101 void DbgValueHistoryMap::Entry::endEntry(EntryIndex Index) {
102 // For now, instruction ranges are not allowed to cross basic block
103 // boundaries.
104 assert(isDbgValue() && "Setting end index for non-debug value");
105 assert(!isClosed() && "End index has already been set");
106 EndIndex = Index;
109 /// Check if the instruction range [StartMI, EndMI] intersects any instruction
110 /// range in Ranges. EndMI can be nullptr to indicate that the range is
111 /// unbounded. Assumes Ranges is ordered and disjoint. Returns true and points
112 /// to the first intersecting scope range if one exists.
113 static Optional<ArrayRef<InsnRange>::iterator>
114 intersects(const MachineInstr *StartMI, const MachineInstr *EndMI,
115 const ArrayRef<InsnRange> &Ranges,
116 const InstructionOrdering &Ordering) {
117 for (auto RangesI = Ranges.begin(), RangesE = Ranges.end();
118 RangesI != RangesE; ++RangesI) {
119 if (EndMI && Ordering.isBefore(EndMI, RangesI->first))
120 return None;
121 if (EndMI && !Ordering.isBefore(RangesI->second, EndMI))
122 return RangesI;
123 if (Ordering.isBefore(StartMI, RangesI->second))
124 return RangesI;
126 return None;
129 void DbgValueHistoryMap::trimLocationRanges(
130 const MachineFunction &MF, LexicalScopes &LScopes,
131 const InstructionOrdering &Ordering) {
132 // The indices of the entries we're going to remove for each variable.
133 SmallVector<EntryIndex, 4> ToRemove;
134 // Entry reference count for each variable. Clobbers left with no references
135 // will be removed.
136 SmallVector<int, 4> ReferenceCount;
137 // Entries reference other entries by index. Offsets is used to remap these
138 // references if any entries are removed.
139 SmallVector<size_t, 4> Offsets;
141 for (auto &Record : VarEntries) {
142 auto &HistoryMapEntries = Record.second;
143 if (HistoryMapEntries.empty())
144 continue;
146 InlinedEntity Entity = Record.first;
147 const DILocalVariable *LocalVar = cast<DILocalVariable>(Entity.first);
149 LexicalScope *Scope = nullptr;
150 if (const DILocation *InlinedAt = Entity.second) {
151 Scope = LScopes.findInlinedScope(LocalVar->getScope(), InlinedAt);
152 } else {
153 Scope = LScopes.findLexicalScope(LocalVar->getScope());
154 // Ignore variables for non-inlined function level scopes. The scope
155 // ranges (from scope->getRanges()) will not include any instructions
156 // before the first one with a debug-location, which could cause us to
157 // incorrectly drop a location. We could introduce special casing for
158 // these variables, but it doesn't seem worth it because no out-of-scope
159 // locations have been observed for variables declared in function level
160 // scopes.
161 if (Scope &&
162 (Scope->getScopeNode() == Scope->getScopeNode()->getSubprogram()) &&
163 (Scope->getScopeNode() == LocalVar->getScope()))
164 continue;
167 // If there is no scope for the variable then something has probably gone
168 // wrong.
169 if (!Scope)
170 continue;
172 ToRemove.clear();
173 // Zero the reference counts.
174 ReferenceCount.assign(HistoryMapEntries.size(), 0);
175 // Index of the DBG_VALUE which marks the start of the current location
176 // range.
177 EntryIndex StartIndex = 0;
178 ArrayRef<InsnRange> ScopeRanges(Scope->getRanges());
179 for (auto EI = HistoryMapEntries.begin(), EE = HistoryMapEntries.end();
180 EI != EE; ++EI, ++StartIndex) {
181 // Only DBG_VALUEs can open location ranges so skip anything else.
182 if (!EI->isDbgValue())
183 continue;
185 // Index of the entry which closes this range.
186 EntryIndex EndIndex = EI->getEndIndex();
187 // If this range is closed bump the reference count of the closing entry.
188 if (EndIndex != NoEntry)
189 ReferenceCount[EndIndex] += 1;
190 // Skip this location range if the opening entry is still referenced. It
191 // may close a location range which intersects a scope range.
192 // TODO: We could be 'smarter' and trim these kinds of ranges such that
193 // they do not leak out of the scope ranges if they partially overlap.
194 if (ReferenceCount[StartIndex] > 0)
195 continue;
197 const MachineInstr *StartMI = EI->getInstr();
198 const MachineInstr *EndMI = EndIndex != NoEntry
199 ? HistoryMapEntries[EndIndex].getInstr()
200 : nullptr;
201 // Check if the location range [StartMI, EndMI] intersects with any scope
202 // range for the variable.
203 if (auto R = intersects(StartMI, EndMI, ScopeRanges, Ordering)) {
204 // Adjust ScopeRanges to exclude ranges which subsequent location ranges
205 // cannot possibly intersect.
206 ScopeRanges = ArrayRef<InsnRange>(*R, ScopeRanges.end());
207 } else {
208 // If the location range does not intersect any scope range then the
209 // DBG_VALUE which opened this location range is usless, mark it for
210 // removal.
211 ToRemove.push_back(StartIndex);
212 // Because we'll be removing this entry we need to update the reference
213 // count of the closing entry, if one exists.
214 if (EndIndex != NoEntry)
215 ReferenceCount[EndIndex] -= 1;
219 // If there is nothing to remove then jump to next variable.
220 if (ToRemove.empty())
221 continue;
223 // Mark clobbers that will no longer close any location ranges for removal.
224 for (size_t i = 0; i < HistoryMapEntries.size(); ++i)
225 if (ReferenceCount[i] <= 0 && HistoryMapEntries[i].isClobber())
226 ToRemove.push_back(i);
228 llvm::sort(ToRemove);
230 // Build an offset map so we can update the EndIndex of the remaining
231 // entries.
232 // Zero the offsets.
233 Offsets.assign(HistoryMapEntries.size(), 0);
234 size_t CurOffset = 0;
235 auto ToRemoveItr = ToRemove.begin();
236 for (size_t EntryIdx = *ToRemoveItr; EntryIdx < HistoryMapEntries.size();
237 ++EntryIdx) {
238 // Check if this is an entry which will be removed.
239 if (ToRemoveItr != ToRemove.end() && *ToRemoveItr == EntryIdx) {
240 ++ToRemoveItr;
241 ++CurOffset;
243 Offsets[EntryIdx] = CurOffset;
246 // Update the EndIndex of the entries to account for those which will be
247 // removed.
248 for (auto &Entry : HistoryMapEntries)
249 if (Entry.isClosed())
250 Entry.EndIndex -= Offsets[Entry.EndIndex];
252 // Now actually remove the entries. Iterate backwards so that our remaining
253 // ToRemove indices are valid after each erase.
254 for (EntryIndex Idx : llvm::reverse(ToRemove))
255 HistoryMapEntries.erase(HistoryMapEntries.begin() + Idx);
259 bool DbgValueHistoryMap::hasNonEmptyLocation(const Entries &Entries) const {
260 for (const auto &Entry : Entries) {
261 if (!Entry.isDbgValue())
262 continue;
264 const MachineInstr *MI = Entry.getInstr();
265 assert(MI->isDebugValue());
266 // A DBG_VALUE $noreg is an empty variable location
267 if (MI->getOperand(0).isReg() && MI->getOperand(0).getReg() == 0)
268 continue;
270 return true;
273 return false;
276 void DbgLabelInstrMap::addInstr(InlinedEntity Label, const MachineInstr &MI) {
277 assert(MI.isDebugLabel() && "not a DBG_LABEL");
278 LabelInstr[Label] = &MI;
281 namespace {
283 // Maps physreg numbers to the variables they describe.
284 using InlinedEntity = DbgValueHistoryMap::InlinedEntity;
285 using RegDescribedVarsMap = std::map<unsigned, SmallVector<InlinedEntity, 1>>;
287 // Keeps track of the debug value entries that are currently live for each
288 // inlined entity. As the history map entries are stored in a SmallVector, they
289 // may be moved at insertion of new entries, so store indices rather than
290 // pointers.
291 using DbgValueEntriesMap = std::map<InlinedEntity, SmallSet<EntryIndex, 1>>;
293 } // end anonymous namespace
295 // Claim that @Var is not described by @RegNo anymore.
296 static void dropRegDescribedVar(RegDescribedVarsMap &RegVars, unsigned RegNo,
297 InlinedEntity Var) {
298 const auto &I = RegVars.find(RegNo);
299 assert(RegNo != 0U && I != RegVars.end());
300 auto &VarSet = I->second;
301 const auto &VarPos = llvm::find(VarSet, Var);
302 assert(VarPos != VarSet.end());
303 VarSet.erase(VarPos);
304 // Don't keep empty sets in a map to keep it as small as possible.
305 if (VarSet.empty())
306 RegVars.erase(I);
309 // Claim that @Var is now described by @RegNo.
310 static void addRegDescribedVar(RegDescribedVarsMap &RegVars, unsigned RegNo,
311 InlinedEntity Var) {
312 assert(RegNo != 0U);
313 auto &VarSet = RegVars[RegNo];
314 assert(!is_contained(VarSet, Var));
315 VarSet.push_back(Var);
318 /// Create a clobbering entry and end all open debug value entries
319 /// for \p Var that are described by \p RegNo using that entry. Inserts into \p
320 /// FellowRegisters the set of Registers that were also used to describe \p Var
321 /// alongside \p RegNo.
322 static void clobberRegEntries(InlinedEntity Var, unsigned RegNo,
323 const MachineInstr &ClobberingInstr,
324 DbgValueEntriesMap &LiveEntries,
325 DbgValueHistoryMap &HistMap,
326 SmallVectorImpl<Register> &FellowRegisters) {
327 EntryIndex ClobberIndex = HistMap.startClobber(Var, ClobberingInstr);
328 // Close all entries whose values are described by the register.
329 SmallVector<EntryIndex, 4> IndicesToErase;
330 // If a given register appears in a live DBG_VALUE_LIST for Var alongside the
331 // clobbered register, and never appears in a live DBG_VALUE* for Var without
332 // the clobbered register, then it is no longer linked to the variable.
333 SmallSet<Register, 4> MaybeRemovedRegisters;
334 SmallSet<Register, 4> KeepRegisters;
335 for (auto Index : LiveEntries[Var]) {
336 auto &Entry = HistMap.getEntry(Var, Index);
337 assert(Entry.isDbgValue() && "Not a DBG_VALUE in LiveEntries");
338 if (Entry.getInstr()->isDebugEntryValue())
339 continue;
340 if (Entry.getInstr()->hasDebugOperandForReg(RegNo)) {
341 IndicesToErase.push_back(Index);
342 Entry.endEntry(ClobberIndex);
343 for (const auto &MO : Entry.getInstr()->debug_operands())
344 if (MO.isReg() && MO.getReg() && MO.getReg() != RegNo)
345 MaybeRemovedRegisters.insert(MO.getReg());
346 } else {
347 for (const auto &MO : Entry.getInstr()->debug_operands())
348 if (MO.isReg() && MO.getReg())
349 KeepRegisters.insert(MO.getReg());
353 for (Register Reg : MaybeRemovedRegisters)
354 if (!KeepRegisters.contains(Reg))
355 FellowRegisters.push_back(Reg);
357 // Drop all entries that have ended.
358 for (auto Index : IndicesToErase)
359 LiveEntries[Var].erase(Index);
362 /// Add a new debug value for \p Var. Closes all overlapping debug values.
363 static void handleNewDebugValue(InlinedEntity Var, const MachineInstr &DV,
364 RegDescribedVarsMap &RegVars,
365 DbgValueEntriesMap &LiveEntries,
366 DbgValueHistoryMap &HistMap) {
367 EntryIndex NewIndex;
368 if (HistMap.startDbgValue(Var, DV, NewIndex)) {
369 SmallDenseMap<unsigned, bool, 4> TrackedRegs;
371 // If we have created a new debug value entry, close all preceding
372 // live entries that overlap.
373 SmallVector<EntryIndex, 4> IndicesToErase;
374 const DIExpression *DIExpr = DV.getDebugExpression();
375 for (auto Index : LiveEntries[Var]) {
376 auto &Entry = HistMap.getEntry(Var, Index);
377 assert(Entry.isDbgValue() && "Not a DBG_VALUE in LiveEntries");
378 const MachineInstr &DV = *Entry.getInstr();
379 bool Overlaps = DIExpr->fragmentsOverlap(DV.getDebugExpression());
380 if (Overlaps) {
381 IndicesToErase.push_back(Index);
382 Entry.endEntry(NewIndex);
384 if (!DV.isDebugEntryValue())
385 for (const MachineOperand &Op : DV.debug_operands())
386 if (Op.isReg() && Op.getReg())
387 TrackedRegs[Op.getReg()] |= !Overlaps;
390 // If the new debug value is described by a register, add tracking of
391 // that register if it is not already tracked.
392 if (!DV.isDebugEntryValue()) {
393 for (const MachineOperand &Op : DV.debug_operands()) {
394 if (Op.isReg() && Op.getReg()) {
395 Register NewReg = Op.getReg();
396 if (!TrackedRegs.count(NewReg))
397 addRegDescribedVar(RegVars, NewReg, Var);
398 LiveEntries[Var].insert(NewIndex);
399 TrackedRegs[NewReg] = true;
404 // Drop tracking of registers that are no longer used.
405 for (auto I : TrackedRegs)
406 if (!I.second)
407 dropRegDescribedVar(RegVars, I.first, Var);
409 // Drop all entries that have ended, and mark the new entry as live.
410 for (auto Index : IndicesToErase)
411 LiveEntries[Var].erase(Index);
412 LiveEntries[Var].insert(NewIndex);
416 // Terminate the location range for variables described by register at
417 // @I by inserting @ClobberingInstr to their history.
418 static void clobberRegisterUses(RegDescribedVarsMap &RegVars,
419 RegDescribedVarsMap::iterator I,
420 DbgValueHistoryMap &HistMap,
421 DbgValueEntriesMap &LiveEntries,
422 const MachineInstr &ClobberingInstr) {
423 // Iterate over all variables described by this register and add this
424 // instruction to their history, clobbering it. All registers that also
425 // describe the clobbered variables (i.e. in variadic debug values) will have
426 // those Variables removed from their DescribedVars.
427 for (const auto &Var : I->second) {
428 SmallVector<Register, 4> FellowRegisters;
429 clobberRegEntries(Var, I->first, ClobberingInstr, LiveEntries, HistMap,
430 FellowRegisters);
431 for (Register RegNo : FellowRegisters)
432 dropRegDescribedVar(RegVars, RegNo, Var);
434 RegVars.erase(I);
437 // Terminate the location range for variables described by register
438 // @RegNo by inserting @ClobberingInstr to their history.
439 static void clobberRegisterUses(RegDescribedVarsMap &RegVars, unsigned RegNo,
440 DbgValueHistoryMap &HistMap,
441 DbgValueEntriesMap &LiveEntries,
442 const MachineInstr &ClobberingInstr) {
443 const auto &I = RegVars.find(RegNo);
444 if (I == RegVars.end())
445 return;
446 clobberRegisterUses(RegVars, I, HistMap, LiveEntries, ClobberingInstr);
449 void llvm::calculateDbgEntityHistory(const MachineFunction *MF,
450 const TargetRegisterInfo *TRI,
451 DbgValueHistoryMap &DbgValues,
452 DbgLabelInstrMap &DbgLabels) {
453 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
454 Register SP = TLI->getStackPointerRegisterToSaveRestore();
455 Register FrameReg = TRI->getFrameRegister(*MF);
456 RegDescribedVarsMap RegVars;
457 DbgValueEntriesMap LiveEntries;
458 for (const auto &MBB : *MF) {
459 for (const auto &MI : MBB) {
460 if (MI.isDebugValue()) {
461 assert(MI.getNumOperands() > 1 && "Invalid DBG_VALUE instruction!");
462 // Use the base variable (without any DW_OP_piece expressions)
463 // as index into History. The full variables including the
464 // piece expressions are attached to the MI.
465 const DILocalVariable *RawVar = MI.getDebugVariable();
466 assert(RawVar->isValidLocationForIntrinsic(MI.getDebugLoc()) &&
467 "Expected inlined-at fields to agree");
468 InlinedEntity Var(RawVar, MI.getDebugLoc()->getInlinedAt());
470 handleNewDebugValue(Var, MI, RegVars, LiveEntries, DbgValues);
471 } else if (MI.isDebugLabel()) {
472 assert(MI.getNumOperands() == 1 && "Invalid DBG_LABEL instruction!");
473 const DILabel *RawLabel = MI.getDebugLabel();
474 assert(RawLabel->isValidLocationForIntrinsic(MI.getDebugLoc()) &&
475 "Expected inlined-at fields to agree");
476 // When collecting debug information for labels, there is no MCSymbol
477 // generated for it. So, we keep MachineInstr in DbgLabels in order
478 // to query MCSymbol afterward.
479 InlinedEntity L(RawLabel, MI.getDebugLoc()->getInlinedAt());
480 DbgLabels.addInstr(L, MI);
483 // Meta Instructions have no output and do not change any values and so
484 // can be safely ignored.
485 if (MI.isMetaInstruction())
486 continue;
488 // Not a DBG_VALUE instruction. It may clobber registers which describe
489 // some variables.
490 for (const MachineOperand &MO : MI.operands()) {
491 if (MO.isReg() && MO.isDef() && MO.getReg()) {
492 // Ignore call instructions that claim to clobber SP. The AArch64
493 // backend does this for aggregate function arguments.
494 if (MI.isCall() && MO.getReg() == SP)
495 continue;
496 // If this is a virtual register, only clobber it since it doesn't
497 // have aliases.
498 if (Register::isVirtualRegister(MO.getReg()))
499 clobberRegisterUses(RegVars, MO.getReg(), DbgValues, LiveEntries,
500 MI);
501 // If this is a register def operand, it may end a debug value
502 // range. Ignore frame-register defs in the epilogue and prologue,
503 // we expect debuggers to understand that stack-locations are
504 // invalid outside of the function body.
505 else if (MO.getReg() != FrameReg ||
506 (!MI.getFlag(MachineInstr::FrameDestroy) &&
507 !MI.getFlag(MachineInstr::FrameSetup))) {
508 for (MCRegAliasIterator AI(MO.getReg(), TRI, true); AI.isValid();
509 ++AI)
510 clobberRegisterUses(RegVars, *AI, DbgValues, LiveEntries, MI);
512 } else if (MO.isRegMask()) {
513 // If this is a register mask operand, clobber all debug values in
514 // non-CSRs.
515 SmallVector<unsigned, 32> RegsToClobber;
516 // Don't consider SP to be clobbered by register masks.
517 for (auto It : RegVars) {
518 unsigned int Reg = It.first;
519 if (Reg != SP && Register::isPhysicalRegister(Reg) &&
520 MO.clobbersPhysReg(Reg))
521 RegsToClobber.push_back(Reg);
524 for (unsigned Reg : RegsToClobber) {
525 clobberRegisterUses(RegVars, Reg, DbgValues, LiveEntries, MI);
528 } // End MO loop.
529 } // End instr loop.
531 // Make sure locations for all variables are valid only until the end of
532 // the basic block (unless it's the last basic block, in which case let
533 // their liveness run off to the end of the function).
534 if (!MBB.empty() && &MBB != &MF->back()) {
535 // Iterate over all variables that have open debug values.
536 for (auto &Pair : LiveEntries) {
537 if (Pair.second.empty())
538 continue;
540 // Create a clobbering entry.
541 EntryIndex ClobIdx = DbgValues.startClobber(Pair.first, MBB.back());
543 // End all entries.
544 for (EntryIndex Idx : Pair.second) {
545 DbgValueHistoryMap::Entry &Ent = DbgValues.getEntry(Pair.first, Idx);
546 assert(Ent.isDbgValue() && !Ent.isClosed());
547 Ent.endEntry(ClobIdx);
551 LiveEntries.clear();
552 RegVars.clear();
557 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
558 LLVM_DUMP_METHOD void DbgValueHistoryMap::dump() const {
559 dbgs() << "DbgValueHistoryMap:\n";
560 for (const auto &VarRangePair : *this) {
561 const InlinedEntity &Var = VarRangePair.first;
562 const Entries &Entries = VarRangePair.second;
564 const DILocalVariable *LocalVar = cast<DILocalVariable>(Var.first);
565 const DILocation *Location = Var.second;
567 dbgs() << " - " << LocalVar->getName() << " at ";
569 if (Location)
570 dbgs() << Location->getFilename() << ":" << Location->getLine() << ":"
571 << Location->getColumn();
572 else
573 dbgs() << "<unknown location>";
575 dbgs() << " --\n";
577 for (const auto &E : enumerate(Entries)) {
578 const auto &Entry = E.value();
579 dbgs() << " Entry[" << E.index() << "]: ";
580 if (Entry.isDbgValue())
581 dbgs() << "Debug value\n";
582 else
583 dbgs() << "Clobber\n";
584 dbgs() << " Instr: " << *Entry.getInstr();
585 if (Entry.isDbgValue()) {
586 if (Entry.getEndIndex() == NoEntry)
587 dbgs() << " - Valid until end of function\n";
588 else
589 dbgs() << " - Closed by Entry[" << Entry.getEndIndex() << "]\n";
591 dbgs() << "\n";
595 #endif