Skip to content

Commit 3b908d0

Browse files
rastogishubhamrastogishubham
committed
[NFC] Move DroppedVariableStats to its own file.
Move DroppedVariableStats code to its own file and change the class to have an extensible design so that we can use it to add dropped statistics to MIR passes and the instruction selector.
1 parent 6b21cf8 commit 3b908d0

File tree

7 files changed

+349
-299
lines changed

7 files changed

+349
-299
lines changed

‎llvm/include/llvm/CodeGen/DroppedVariableStats.h

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
///===- DroppedVariableStats.h - Opt Diagnostics -*- C++ -*----------------===//
2+
///
3+
/// Part of the LLVM Project, under the Apache License v2.0 with LLVM
4+
/// Exceptions. See https://llvm.org/LICENSE.txt for license information.
5+
/// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
///
7+
///===---------------------------------------------------------------------===//
8+
/// \file
9+
/// Dropped Variable Statistics for Debug Information. Reports any number
10+
/// of #dbg_value that get dropped due to an optimization pass.
11+
///
12+
///===---------------------------------------------------------------------===//
13+
14+
#ifndef LLVM_CODEGEN_DROPPEDVARIABLESTATS_H
15+
#define LLVM_CODEGEN_DROPPEDVARIABLESTATS_H
16+
17+
#include "llvm/CodeGen/MachinePassManager.h"
18+
#include "llvm/IR/DebugInfoMetadata.h"
19+
#include "llvm/IR/DiagnosticInfo.h"
20+
#include "llvm/IR/Function.h"
21+
#include "llvm/IR/Module.h"
22+
#include "llvm/IR/PassInstrumentation.h"
23+
24+
namespace llvm {
25+
26+
/// A unique key that represents a #dbg_value.
27+
using VarID =
28+
std::tuple<const DIScope *, const DIScope *, const DILocalVariable *>;
29+
30+
/// A base class to collect and print dropped debug information variable
31+
/// statistics.
32+
class DroppedVariableStats {
33+
public:
34+
DroppedVariableStats(bool DroppedVarStatsEnabled)
35+
: DroppedVariableStatsEnabled(DroppedVarStatsEnabled) {
36+
if (DroppedVarStatsEnabled)
37+
llvm::outs()
38+
<< "Pass Level, Pass Name, Num of Dropped Variables, Func or "
39+
"Module Name\n";
40+
};
41+
// We intend this to be unique per-compilation, thus no copies.
42+
DroppedVariableStats(const DroppedVariableStats &) = delete;
43+
void operator=(const DroppedVariableStats &) = delete;
44+
45+
void setup() {
46+
DebugVariablesStack.push_back(
47+
{DenseMap<const Function *, DebugVariables>()});
48+
InlinedAts.push_back(
49+
{DenseMap<StringRef, DenseMap<VarID, DILocation *>>()});
50+
return;
51+
}
52+
53+
void cleanup() {
54+
DebugVariablesStack.pop_back();
55+
InlinedAts.pop_back();
56+
return;
57+
}
58+
59+
bool getPassDroppedVariables() { return PassDroppedVariables; }
60+
61+
protected:
62+
bool PassDroppedVariables = false;
63+
bool DroppedVariableStatsEnabled = false;
64+
65+
struct DebugVariables {
66+
/// DenseSet of VarIDs before an optimization pass has run.
67+
DenseSet<VarID> DebugVariablesBefore;
68+
/// DenseSet of VarIDs after an optimization pass has run.
69+
DenseSet<VarID> DebugVariablesAfter;
70+
};
71+
72+
/// A stack of a DenseMap, that maps DebugVariables for every pass to an
73+
/// llvm::Function. A stack is used because an optimization pass can call
74+
/// other passes.
75+
SmallVector<DenseMap<const Function *, DebugVariables>> DebugVariablesStack;
76+
77+
/// A DenseSet tracking whether a scope was visited before.
78+
DenseSet<const DIScope *> VisitedScope;
79+
/// A stack of DenseMaps, which map the name of an llvm::Function to a
80+
/// DenseMap of VarIDs and their inlinedAt locations before an optimization
81+
/// pass has run.
82+
SmallVector<DenseMap<StringRef, DenseMap<VarID, DILocation *>>> InlinedAts;
83+
/// Remove a dropped #dbg_value VarID from all Sets in the
84+
/// DroppedVariablesBefore stack.
85+
void removeVarFromAllSets(VarID Var, const Function *F) {
86+
// Do not remove Var from the last element, it will be popped from the
87+
// stack.
88+
for (auto &DebugVariablesMap : llvm::drop_end(DebugVariablesStack))
89+
DebugVariablesMap[F].DebugVariablesBefore.erase(Var);
90+
}
91+
/// Return true if \p Scope is the same as \p DbgValScope or a child scope of
92+
/// \p DbgValScope, return false otherwise.
93+
bool isScopeChildOfOrEqualTo(DIScope *Scope, const DIScope *DbgValScope);
94+
/// Return true if \p InlinedAt is the same as \p DbgValInlinedAt or part of
95+
/// the InlinedAt chain, return false otherwise.
96+
bool isInlinedAtChildOfOrEqualTo(const DILocation *InlinedAt,
97+
const DILocation *DbgValInlinedAt);
98+
};
99+
100+
/// A class to collect and print dropped debug information due to LLVM IR
101+
/// optimization passes. After every LLVM IR pass is run, it will print how many
102+
/// #dbg_values were dropped due to that pass.
103+
class DroppedVariableStatsIR : public DroppedVariableStats {
104+
public:
105+
DroppedVariableStatsIR(bool DroppedVarStatsEnabled)
106+
: llvm::DroppedVariableStats(DroppedVarStatsEnabled) {}
107+
108+
void runBeforePass(Any IR) {
109+
setup();
110+
if (const auto *M = unwrapIR<Module>(IR))
111+
return this->runOnModule(M, true);
112+
if (const auto *F = unwrapIR<Function>(IR))
113+
return this->runOnFunction(F, true);
114+
}
115+
116+
void runAfterPass(StringRef P, Any IR) {
117+
if (const auto *M = unwrapIR<Module>(IR))
118+
runAfterPassModule(P, M);
119+
else if (const auto *F = unwrapIR<Function>(IR))
120+
runAfterPassFunction(P, F);
121+
return cleanup();
122+
}
123+
124+
void registerCallbacks(PassInstrumentationCallbacks &PIC);
125+
126+
private:
127+
void runAfterPassFunction(StringRef PassID, const Function *F) {
128+
runOnFunction(F, false);
129+
calculateDroppedVarStatsOnFunction(F, PassID, F->getName().str(),
130+
"Function");
131+
}
132+
133+
void runAfterPassModule(StringRef PassID, const Module *M) {
134+
runOnModule(M, false);
135+
calculateDroppedVarStatsOnModule(M, PassID, M->getName().str(), "Module");
136+
}
137+
/// Populate DebugVariablesBefore, DebugVariablesAfter, InlinedAts before or
138+
/// after a pass has run to facilitate dropped variable calculation for an
139+
/// llvm::Function.
140+
void runOnFunction(const Function *F, bool Before);
141+
/// Iterate over all Instructions in a Function and report any dropped debug
142+
/// information.
143+
void calculateDroppedVarStatsOnFunction(const Function *F, StringRef PassID,
144+
std::string FuncOrModName,
145+
std::string PassLevel);
146+
/// Populate DebugVariablesBefore, DebugVariablesAfter, InlinedAts before or
147+
/// after a pass has run to facilitate dropped variable calculation for an
148+
/// llvm::Module. Calls runOnFunction on every Function in the Module.
149+
void runOnModule(const Module *M, bool Before);
150+
/// Iterate over all Functions in a Module and report any dropped debug
151+
/// information. Will call calculateDroppedVarStatsOnFunction on every
152+
/// Function.
153+
void calculateDroppedVarStatsOnModule(const Module *M, StringRef PassID,
154+
std::string FuncOrModName,
155+
std::string PassLevel);
156+
157+
template <typename IRUnitT> static const IRUnitT *unwrapIR(Any IR) {
158+
const IRUnitT **IRPtr = llvm::any_cast<const IRUnitT *>(&IR);
159+
return IRPtr ? *IRPtr : nullptr;
160+
}
161+
};
162+
163+
} // namespace llvm
164+
165+
#endif

‎llvm/include/llvm/Passes/StandardInstrumentations.h

Lines changed: 2 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
#include "llvm/ADT/SmallVector.h"
2020
#include "llvm/ADT/StringRef.h"
2121
#include "llvm/ADT/StringSet.h"
22+
#include "llvm/CodeGen/DroppedVariableStats.h"
2223
#include "llvm/CodeGen/MachineBasicBlock.h"
2324
#include "llvm/IR/BasicBlock.h"
2425
#include "llvm/IR/DebugInfoMetadata.h"
@@ -579,83 +580,6 @@ class PrintCrashIRInstrumentation {
579580
static void SignalHandler(void *);
580581
};
581582

582-
/// A class to collect and print dropped debug information variable statistics.
583-
/// After every LLVM IR pass is run, it will print how many #dbg_values were
584-
/// dropped due to that pass.
585-
class DroppedVariableStats {
586-
public:
587-
DroppedVariableStats(bool DroppedVarStatsEnabled) {
588-
if (DroppedVarStatsEnabled)
589-
llvm::outs()
590-
<< "Pass Level, Pass Name, Num of Dropped Variables, Func or "
591-
"Module Name\n";
592-
};
593-
// We intend this to be unique per-compilation, thus no copies.
594-
DroppedVariableStats(const DroppedVariableStats &) = delete;
595-
void operator=(const DroppedVariableStats &) = delete;
596-
597-
void registerCallbacks(PassInstrumentationCallbacks &PIC);
598-
void runBeforePass(StringRef PassID, Any IR);
599-
void runAfterPass(StringRef PassID, Any IR, const PreservedAnalyses &PA);
600-
void runAfterPassInvalidated(StringRef PassID, const PreservedAnalyses &PA);
601-
bool getPassDroppedVariables() { return PassDroppedVariables; }
602-
603-
private:
604-
bool PassDroppedVariables = false;
605-
/// A unique key that represents a #dbg_value.
606-
using VarID =
607-
std::tuple<const DIScope *, const DIScope *, const DILocalVariable *>;
608-
609-
struct DebugVariables {
610-
/// DenseSet of VarIDs before an optimization pass has run.
611-
DenseSet<VarID> DebugVariablesBefore;
612-
/// DenseSet of VarIDs after an optimization pass has run.
613-
DenseSet<VarID> DebugVariablesAfter;
614-
};
615-
616-
/// A stack of a DenseMap, that maps DebugVariables for every pass to an
617-
/// llvm::Function. A stack is used because an optimization pass can call
618-
/// other passes.
619-
SmallVector<DenseMap<const Function *, DebugVariables>> DebugVariablesStack;
620-
621-
/// A DenseSet tracking whether a scope was visited before.
622-
DenseSet<const DIScope *> VisitedScope;
623-
/// A stack of DenseMaps, which map the name of an llvm::Function to a
624-
/// DenseMap of VarIDs and their inlinedAt locations before an optimization
625-
/// pass has run.
626-
SmallVector<DenseMap<StringRef, DenseMap<VarID, DILocation *>>> InlinedAts;
627-
628-
/// Iterate over all Functions in a Module and report any dropped debug
629-
/// information. Will call calculateDroppedVarStatsOnFunction on every
630-
/// Function.
631-
void calculateDroppedVarStatsOnModule(const Module *M, StringRef PassID,
632-
std::string FuncOrModName,
633-
std::string PassLevel);
634-
/// Iterate over all Instructions in a Function and report any dropped debug
635-
/// information.
636-
void calculateDroppedVarStatsOnFunction(const Function *F, StringRef PassID,
637-
std::string FuncOrModName,
638-
std::string PassLevel);
639-
/// Populate DebugVariablesBefore, DebugVariablesAfter, InlinedAts before or
640-
/// after a pass has run to facilitate dropped variable calculation for an
641-
/// llvm::Function.
642-
void runOnFunction(const Function *F, bool Before);
643-
/// Populate DebugVariablesBefore, DebugVariablesAfter, InlinedAts before or
644-
/// after a pass has run to facilitate dropped variable calculation for an
645-
/// llvm::Module. Calls runOnFunction on every Function in the Module.
646-
void runOnModule(const Module *M, bool Before);
647-
/// Remove a dropped #dbg_value VarID from all Sets in the
648-
/// DroppedVariablesBefore stack.
649-
void removeVarFromAllSets(VarID Var, const Function *F);
650-
/// Return true if \p Scope is the same as \p DbgValScope or a child scope of
651-
/// \p DbgValScope, return false otherwise.
652-
bool isScopeChildOfOrEqualTo(DIScope *Scope, const DIScope *DbgValScope);
653-
/// Return true if \p InlinedAt is the same as \p DbgValInlinedAt or part of
654-
/// the InlinedAt chain, return false otherwise.
655-
bool isInlinedAtChildOfOrEqualTo(const DILocation *InlinedAt,
656-
const DILocation *DbgValInlinedAt);
657-
};
658-
659583
/// This class provides an interface to register all the standard pass
660584
/// instrumentations and manages their state (if any).
661585
class StandardInstrumentations {
@@ -673,7 +597,7 @@ class StandardInstrumentations {
673597
PrintCrashIRInstrumentation PrintCrashIR;
674598
IRChangedTester ChangeTester;
675599
VerifyInstrumentation Verify;
676-
DroppedVariableStats DroppedStats;
600+
DroppedVariableStatsIR DroppedStatsIR;
677601

678602
bool VerifyEach;
679603

‎llvm/lib/CodeGen/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ add_llvm_component_library(LLVMCodeGen
5050
DeadMachineInstructionElim.cpp
5151
DetectDeadLanes.cpp
5252
DFAPacketizer.cpp
53+
DroppedVariableStats.cpp
5354
DwarfEHPrepare.cpp
5455
EarlyIfConversion.cpp
5556
EdgeBundles.cpp

0 commit comments

Comments
 (0)