Skip to content

Commit 9f41c03

Browse files
author
Djordje Todorovic
committed
[Debugify][OriginalDIMode] Export the report into JSON file
By using the original-di check with debugify in the combination with the llvm/utils/llvm-original-di-preservation.py it becomes very user friendly tool. An example of the HTML page with the issues related to debug info can be found at [0]. [0] https://djolertrk.github.io/di-checker-html-report-example/ Differential Revision: https://reviews.llvm.org/D82546
1 parent b975e3b commit 9f41c03

File tree

9 files changed

+636
-41
lines changed

9 files changed

+636
-41
lines changed

‎llvm/docs/HowToUpdateDebugInfo.rst

+15
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,21 @@ pre-existing debug info metadata. It could be run as follows:
361361
# Check the preservation of original Debug Info after each pass.
362362
$ opt -verify-each-debuginfo-preserve -O2 sample.ll
363363
364+
Furthermore, there is a way to export the issues that have been found into
365+
a JSON file as follows:
366+
367+
.. code-block:: bash
368+
369+
$ opt -verify-debuginfo-preserve -verify-di-preserve-export=sample.json -pass-to-test sample.ll
370+
371+
and then use the ``llvm/utils/llvm-original-di-preservation.py`` script
372+
to generate an HTML page with the issues reported in a more human readable form
373+
as follows:
374+
375+
.. code-block:: bash
376+
377+
$ llvm-original-di-preservation.py sample.json sample.html
378+
364379
Mutation testing for MIR-level transformations
365380
----------------------------------------------
366381

‎llvm/include/llvm/Transforms/Utils/Debugify.h

+21-9
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ bool collectDebugInfoMetadata(Module &M,
8484
bool checkDebugInfoMetadata(Module &M,
8585
iterator_range<Module::iterator> Functions,
8686
DebugInfoPerPassMap &DIPreservationMap,
87-
StringRef Banner, StringRef NameOfWrappedPass);
87+
StringRef Banner, StringRef NameOfWrappedPass,
88+
StringRef OrigDIVerifyBugsReportFilePath);
8889
} // namespace llvm
8990

9091
/// Used to check whether we track synthetic or original debug info.
@@ -136,13 +137,15 @@ llvm::ModulePass *createCheckDebugifyModulePass(
136137
bool Strip = false, llvm::StringRef NameOfWrappedPass = "",
137138
DebugifyStatsMap *StatsMap = nullptr,
138139
enum DebugifyMode Mode = DebugifyMode::SyntheticDebugInfo,
139-
DebugInfoPerPassMap *DIPreservationMap = nullptr);
140+
DebugInfoPerPassMap *DIPreservationMap = nullptr,
141+
llvm::StringRef OrigDIVerifyBugsReportFilePath = "");
140142

141143
llvm::FunctionPass *createCheckDebugifyFunctionPass(
142144
bool Strip = false, llvm::StringRef NameOfWrappedPass = "",
143145
DebugifyStatsMap *StatsMap = nullptr,
144146
enum DebugifyMode Mode = DebugifyMode::SyntheticDebugInfo,
145-
DebugInfoPerPassMap *DIPreservationMap = nullptr);
147+
DebugInfoPerPassMap *DIPreservationMap = nullptr,
148+
llvm::StringRef OrigDIVerifyBugsReportFilePath = "");
146149

147150
struct NewPMCheckDebugifyPass
148151
: public llvm::PassInfoMixin<NewPMCheckDebugifyPass> {
@@ -163,6 +166,7 @@ struct DebugifyEachInstrumentation {
163166
/// NOTE: We support legacy custom pass manager only.
164167
/// TODO: Add New PM support for custom pass manager.
165168
class DebugifyCustomPassManager : public legacy::PassManager {
169+
StringRef OrigDIVerifyBugsReportFilePath;
166170
DebugifyStatsMap *DIStatsMap = nullptr;
167171
DebugInfoPerPassMap *DIPreservationMap = nullptr;
168172
enum DebugifyMode Mode = DebugifyMode::NoDebugify;
@@ -173,10 +177,9 @@ class DebugifyCustomPassManager : public legacy::PassManager {
173177
void add(Pass *P) override {
174178
// Wrap each pass with (-check)-debugify passes if requested, making
175179
// exceptions for passes which shouldn't see -debugify instrumentation.
176-
bool WrapWithDebugify =
177-
Mode != DebugifyMode::NoDebugify &&
178-
!P->getAsImmutablePass() && !isIRPrintingPass(P) &&
179-
!isBitcodeWriterPass(P);
180+
bool WrapWithDebugify = Mode != DebugifyMode::NoDebugify &&
181+
!P->getAsImmutablePass() && !isIRPrintingPass(P) &&
182+
!isBitcodeWriterPass(P);
180183
if (!WrapWithDebugify) {
181184
super::add(P);
182185
return;
@@ -194,13 +197,15 @@ class DebugifyCustomPassManager : public legacy::PassManager {
194197
super::add(createDebugifyFunctionPass(Mode, Name, DIPreservationMap));
195198
super::add(P);
196199
super::add(createCheckDebugifyFunctionPass(
197-
isSyntheticDebugInfo(), Name, DIStatsMap, Mode, DIPreservationMap));
200+
isSyntheticDebugInfo(), Name, DIStatsMap, Mode, DIPreservationMap,
201+
OrigDIVerifyBugsReportFilePath));
198202
break;
199203
case PT_Module:
200204
super::add(createDebugifyModulePass(Mode, Name, DIPreservationMap));
201205
super::add(P);
202206
super::add(createCheckDebugifyModulePass(
203-
isSyntheticDebugInfo(), Name, DIStatsMap, Mode, DIPreservationMap));
207+
isSyntheticDebugInfo(), Name, DIStatsMap, Mode, DIPreservationMap,
208+
OrigDIVerifyBugsReportFilePath));
204209
break;
205210
default:
206211
super::add(P);
@@ -214,6 +219,13 @@ class DebugifyCustomPassManager : public legacy::PassManager {
214219
void setDIPreservationMap(DebugInfoPerPassMap &PerPassMap) {
215220
DIPreservationMap = &PerPassMap;
216221
}
222+
void setOrigDIVerifyBugsReportFilePath(StringRef BugsReportFilePath) {
223+
OrigDIVerifyBugsReportFilePath = BugsReportFilePath;
224+
}
225+
StringRef getOrigDIVerifyBugsReportFilePath() const {
226+
return OrigDIVerifyBugsReportFilePath;
227+
}
228+
217229
void setDebugifyMode(enum DebugifyMode M) { Mode = M; }
218230

219231
bool isSyntheticDebugInfo() const {

‎llvm/lib/Transforms/Utils/Debugify.cpp

+104-30
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
#include "llvm/IR/PassInstrumentation.h"
2626
#include "llvm/Pass.h"
2727
#include "llvm/Support/CommandLine.h"
28+
#include "llvm/Support/JSON.h"
2829

2930
#define DEBUG_TYPE "debugify"
3031

@@ -334,25 +335,36 @@ bool llvm::collectDebugInfoMetadata(Module &M,
334335
static bool checkFunctions(const DebugFnMap &DIFunctionsBefore,
335336
const DebugFnMap &DIFunctionsAfter,
336337
StringRef NameOfWrappedPass,
337-
StringRef FileNameFromCU) {
338+
StringRef FileNameFromCU, bool ShouldWriteIntoJSON,
339+
llvm::json::Array &Bugs) {
338340
bool Preserved = true;
339341
for (const auto &F : DIFunctionsAfter) {
340342
if (F.second)
341343
continue;
342344
auto SPIt = DIFunctionsBefore.find(F.first);
343345
if (SPIt == DIFunctionsBefore.end()) {
344-
dbg() << "ERROR: " << NameOfWrappedPass
345-
<< " did not generate DISubprogram for " << F.first << " from "
346-
<< FileNameFromCU << '\n';
346+
if (ShouldWriteIntoJSON)
347+
Bugs.push_back(llvm::json::Object({{"metadata", "DISubprogram"},
348+
{"name", F.first},
349+
{"action", "not-generate"}}));
350+
else
351+
dbg() << "ERROR: " << NameOfWrappedPass
352+
<< " did not generate DISubprogram for " << F.first << " from "
353+
<< FileNameFromCU << '\n';
347354
Preserved = false;
348355
} else {
349356
auto SP = SPIt->second;
350357
if (!SP)
351358
continue;
352359
// If the function had the SP attached before the pass, consider it as
353360
// a debug info bug.
354-
dbg() << "ERROR: " << NameOfWrappedPass << " dropped DISubprogram of "
355-
<< F.first << " from " << FileNameFromCU << '\n';
361+
if (ShouldWriteIntoJSON)
362+
Bugs.push_back(llvm::json::Object({{"metadata", "DISubprogram"},
363+
{"name", F.first},
364+
{"action", "drop"}}));
365+
else
366+
dbg() << "ERROR: " << NameOfWrappedPass << " dropped DISubprogram of "
367+
<< F.first << " from " << FileNameFromCU << '\n';
356368
Preserved = false;
357369
}
358370
}
@@ -366,7 +378,9 @@ static bool checkInstructions(const DebugInstMap &DILocsBefore,
366378
const DebugInstMap &DILocsAfter,
367379
const WeakInstValueMap &InstToDelete,
368380
StringRef NameOfWrappedPass,
369-
StringRef FileNameFromCU) {
381+
StringRef FileNameFromCU,
382+
bool ShouldWriteIntoJSON,
383+
llvm::json::Array &Bugs) {
370384
bool Preserved = true;
371385
for (const auto &L : DILocsAfter) {
372386
if (L.second)
@@ -382,34 +396,73 @@ static bool checkInstructions(const DebugInstMap &DILocsBefore,
382396
auto FnName = Instr->getFunction()->getName();
383397
auto BB = Instr->getParent();
384398
auto BBName = BB->hasName() ? BB->getName() : "no-name";
399+
auto InstName = Instruction::getOpcodeName(Instr->getOpcode());
385400

386401
auto InstrIt = DILocsBefore.find(Instr);
387402
if (InstrIt == DILocsBefore.end()) {
388-
dbg() << "WARNING: " << NameOfWrappedPass
389-
<< " did not generate DILocation for " << *Instr
390-
<< " (BB: " << BBName << ", Fn: " << FnName
391-
<< ", File: " << FileNameFromCU << ")\n";
403+
if (ShouldWriteIntoJSON)
404+
Bugs.push_back(llvm::json::Object({{"metadata", "DILocation"},
405+
{"fn-name", FnName.str()},
406+
{"bb-name", BBName.str()},
407+
{"instr", InstName},
408+
{"action", "not-generate"}}));
409+
else
410+
dbg() << "WARNING: " << NameOfWrappedPass
411+
<< " did not generate DILocation for " << *Instr
412+
<< " (BB: " << BBName << ", Fn: " << FnName
413+
<< ", File: " << FileNameFromCU << ")\n";
392414
Preserved = false;
393415
} else {
394416
if (!InstrIt->second)
395417
continue;
396418
// If the instr had the !dbg attached before the pass, consider it as
397419
// a debug info issue.
398-
dbg() << "WARNING: " << NameOfWrappedPass << " dropped DILocation of "
399-
<< *Instr << " (BB: " << BBName << ", Fn: " << FnName
400-
<< ", File: " << FileNameFromCU << ")\n";
420+
if (ShouldWriteIntoJSON)
421+
Bugs.push_back(llvm::json::Object({{"metadata", "DILocation"},
422+
{"fn-name", FnName.str()},
423+
{"bb-name", BBName.str()},
424+
{"instr", InstName},
425+
{"action", "drop"}}));
426+
else
427+
dbg() << "WARNING: " << NameOfWrappedPass << " dropped DILocation of "
428+
<< *Instr << " (BB: " << BBName << ", Fn: " << FnName
429+
<< ", File: " << FileNameFromCU << ")\n";
401430
Preserved = false;
402431
}
403432
}
404433

405434
return Preserved;
406435
}
407436

437+
// Write the json data into the specifed file.
438+
static void writeJSON(StringRef OrigDIVerifyBugsReportFilePath,
439+
StringRef FileNameFromCU, StringRef NameOfWrappedPass,
440+
llvm::json::Array &Bugs) {
441+
std::error_code EC;
442+
raw_fd_ostream OS_FILE{OrigDIVerifyBugsReportFilePath, EC,
443+
sys::fs::OF_Append | sys::fs::OF_Text};
444+
if (EC) {
445+
errs() << "Could not open file: " << EC.message() << ", "
446+
<< OrigDIVerifyBugsReportFilePath << '\n';
447+
return;
448+
}
449+
450+
OS_FILE << "{\"file\":\"" << FileNameFromCU << "\", ";
451+
452+
StringRef PassName = NameOfWrappedPass != "" ? NameOfWrappedPass : "no-name";
453+
OS_FILE << "\"pass\":\"" << PassName << "\", ";
454+
455+
llvm::json::Value BugsToPrint{std::move(Bugs)};
456+
OS_FILE << "\"bugs\": " << BugsToPrint;
457+
458+
OS_FILE << "}\n";
459+
}
460+
408461
bool llvm::checkDebugInfoMetadata(Module &M,
409462
iterator_range<Module::iterator> Functions,
410463
DebugInfoPerPassMap &DIPreservationMap,
411-
StringRef Banner,
412-
StringRef NameOfWrappedPass) {
464+
StringRef Banner, StringRef NameOfWrappedPass,
465+
StringRef OrigDIVerifyBugsReportFilePath) {
413466
LLVM_DEBUG(dbgs() << Banner << ": (after) " << NameOfWrappedPass << '\n');
414467

415468
if (!M.getNamedMetadata("llvm.dbg.cu")) {
@@ -428,7 +481,8 @@ bool llvm::checkDebugInfoMetadata(Module &M,
428481
// TODO: Collect metadata other than DISubprograms.
429482
// Collect the DISubprogram.
430483
auto *SP = F.getSubprogram();
431-
DIPreservationAfter[NameOfWrappedPass].DIFunctions.insert({F.getName(), SP});
484+
DIPreservationAfter[NameOfWrappedPass].DIFunctions.insert(
485+
{F.getName(), SP});
432486
if (SP)
433487
LLVM_DEBUG(dbgs() << " Collecting subprogram: " << *SP << '\n');
434488

@@ -467,14 +521,22 @@ bool llvm::checkDebugInfoMetadata(Module &M,
467521

468522
auto InstToDelete = DIPreservationAfter[NameOfWrappedPass].InstToDelete;
469523

470-
bool ResultForFunc = checkFunctions(DIFunctionsBefore, DIFunctionsAfter,
471-
NameOfWrappedPass, FileNameFromCU);
472-
bool ResultForInsts =
473-
checkInstructions(DILocsBefore, DILocsAfter, InstToDelete,
474-
NameOfWrappedPass, FileNameFromCU);
524+
bool ShouldWriteIntoJSON = !OrigDIVerifyBugsReportFilePath.empty();
525+
llvm::json::Array Bugs;
526+
527+
bool ResultForFunc =
528+
checkFunctions(DIFunctionsBefore, DIFunctionsAfter, NameOfWrappedPass,
529+
FileNameFromCU, ShouldWriteIntoJSON, Bugs);
530+
bool ResultForInsts = checkInstructions(
531+
DILocsBefore, DILocsAfter, InstToDelete, NameOfWrappedPass,
532+
FileNameFromCU, ShouldWriteIntoJSON, Bugs);
475533
bool Result = ResultForFunc && ResultForInsts;
476534

477535
StringRef ResultBanner = NameOfWrappedPass != "" ? NameOfWrappedPass : Banner;
536+
if (ShouldWriteIntoJSON && !Bugs.empty())
537+
writeJSON(OrigDIVerifyBugsReportFilePath, FileNameFromCU, NameOfWrappedPass,
538+
Bugs);
539+
478540
if (Result)
479541
dbg() << ResultBanner << ": PASS\n";
480542
else
@@ -680,15 +742,18 @@ struct CheckDebugifyModulePass : public ModulePass {
680742
"CheckModuleDebugify", Strip, StatsMap);
681743
return checkDebugInfoMetadata(
682744
M, M.functions(), *DIPreservationMap,
683-
"CheckModuleDebugify (original debuginfo)", NameOfWrappedPass);
745+
"CheckModuleDebugify (original debuginfo)", NameOfWrappedPass,
746+
OrigDIVerifyBugsReportFilePath);
684747
}
685748

686749
CheckDebugifyModulePass(
687750
bool Strip = false, StringRef NameOfWrappedPass = "",
688751
DebugifyStatsMap *StatsMap = nullptr,
689752
enum DebugifyMode Mode = DebugifyMode::SyntheticDebugInfo,
690-
DebugInfoPerPassMap *DIPreservationMap = nullptr)
753+
DebugInfoPerPassMap *DIPreservationMap = nullptr,
754+
StringRef OrigDIVerifyBugsReportFilePath = "")
691755
: ModulePass(ID), NameOfWrappedPass(NameOfWrappedPass),
756+
OrigDIVerifyBugsReportFilePath(OrigDIVerifyBugsReportFilePath),
692757
StatsMap(StatsMap), DIPreservationMap(DIPreservationMap), Mode(Mode),
693758
Strip(Strip) {}
694759

@@ -700,6 +765,7 @@ struct CheckDebugifyModulePass : public ModulePass {
700765

701766
private:
702767
StringRef NameOfWrappedPass;
768+
StringRef OrigDIVerifyBugsReportFilePath;
703769
DebugifyStatsMap *StatsMap;
704770
DebugInfoPerPassMap *DIPreservationMap;
705771
enum DebugifyMode Mode;
@@ -718,15 +784,18 @@ struct CheckDebugifyFunctionPass : public FunctionPass {
718784
Strip, StatsMap);
719785
return checkDebugInfoMetadata(
720786
M, make_range(FuncIt, std::next(FuncIt)), *DIPreservationMap,
721-
"CheckFunctionDebugify (original debuginfo)", NameOfWrappedPass);
787+
"CheckFunctionDebugify (original debuginfo)", NameOfWrappedPass,
788+
OrigDIVerifyBugsReportFilePath);
722789
}
723790

724791
CheckDebugifyFunctionPass(
725792
bool Strip = false, StringRef NameOfWrappedPass = "",
726793
DebugifyStatsMap *StatsMap = nullptr,
727794
enum DebugifyMode Mode = DebugifyMode::SyntheticDebugInfo,
728-
DebugInfoPerPassMap *DIPreservationMap = nullptr)
795+
DebugInfoPerPassMap *DIPreservationMap = nullptr,
796+
StringRef OrigDIVerifyBugsReportFilePath = "")
729797
: FunctionPass(ID), NameOfWrappedPass(NameOfWrappedPass),
798+
OrigDIVerifyBugsReportFilePath(OrigDIVerifyBugsReportFilePath),
730799
StatsMap(StatsMap), DIPreservationMap(DIPreservationMap), Mode(Mode),
731800
Strip(Strip) {}
732801

@@ -738,6 +807,7 @@ struct CheckDebugifyFunctionPass : public FunctionPass {
738807

739808
private:
740809
StringRef NameOfWrappedPass;
810+
StringRef OrigDIVerifyBugsReportFilePath;
741811
DebugifyStatsMap *StatsMap;
742812
DebugInfoPerPassMap *DIPreservationMap;
743813
enum DebugifyMode Mode;
@@ -794,22 +864,26 @@ PreservedAnalyses NewPMDebugifyPass::run(Module &M, ModuleAnalysisManager &) {
794864

795865
ModulePass *createCheckDebugifyModulePass(
796866
bool Strip, StringRef NameOfWrappedPass, DebugifyStatsMap *StatsMap,
797-
enum DebugifyMode Mode, DebugInfoPerPassMap *DIPreservationMap) {
867+
enum DebugifyMode Mode, DebugInfoPerPassMap *DIPreservationMap,
868+
StringRef OrigDIVerifyBugsReportFilePath) {
798869
if (Mode == DebugifyMode::SyntheticDebugInfo)
799870
return new CheckDebugifyModulePass(Strip, NameOfWrappedPass, StatsMap);
800871
assert(Mode == DebugifyMode::OriginalDebugInfo && "Must be original mode");
801872
return new CheckDebugifyModulePass(false, NameOfWrappedPass, nullptr, Mode,
802-
DIPreservationMap);
873+
DIPreservationMap,
874+
OrigDIVerifyBugsReportFilePath);
803875
}
804876

805877
FunctionPass *createCheckDebugifyFunctionPass(
806878
bool Strip, StringRef NameOfWrappedPass, DebugifyStatsMap *StatsMap,
807-
enum DebugifyMode Mode, DebugInfoPerPassMap *DIPreservationMap) {
879+
enum DebugifyMode Mode, DebugInfoPerPassMap *DIPreservationMap,
880+
StringRef OrigDIVerifyBugsReportFilePath) {
808881
if (Mode == DebugifyMode::SyntheticDebugInfo)
809882
return new CheckDebugifyFunctionPass(Strip, NameOfWrappedPass, StatsMap);
810883
assert(Mode == DebugifyMode::OriginalDebugInfo && "Must be original mode");
811884
return new CheckDebugifyFunctionPass(false, NameOfWrappedPass, nullptr, Mode,
812-
DIPreservationMap);
885+
DIPreservationMap,
886+
OrigDIVerifyBugsReportFilePath);
813887
}
814888

815889
PreservedAnalyses NewPMCheckDebugifyPass::run(Module &M,

‎llvm/test/lit.cfg.py

+6
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,12 @@ def get_asan_rtlib():
124124

125125
opt_viewer_cmd = '%s %s/tools/opt-viewer/opt-viewer.py' % (sys.executable, config.llvm_src_root)
126126

127+
llvm_original_di_preservation_cmd = os.path.join(
128+
config.llvm_src_root,'utils', 'llvm-original-di-preservation.py')
129+
config.substitutions.append(
130+
('%llvm-original-di-preservation', "'%s' %s" % (
131+
config.python_executable, llvm_original_di_preservation_cmd)))
132+
127133
llvm_locstats_tool = os.path.join(config.llvm_tools_dir, 'llvm-locstats')
128134
config.substitutions.append(
129135
('%llvm-locstats', "'%s' %s" % (config.python_executable, llvm_locstats_tool)))

‎llvm/test/tools/llvm-original-di-preservation/Inputs/sample.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"file":"test.ll", "pass":"no-name", "bugs": [[{"action":"not-generate","bb-name":"no-name","fn-name":"fn","instr":"extractvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn","instr":"insertvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn","instr":"extractvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn1","instr":"insertvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn1","instr":"insertvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn","instr":"insertvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn1","instr":"extractvalue","metadata":"DILocation"},{"action":"not-generate","bb-name":"no-name","fn-name":"fn1","instr":"extractvalue","metadata":"DILocation"}]]}

0 commit comments

Comments
 (0)