This file defines IR-printing pass instrumentation callbacks as well as StandardInstrumentations class that manages standard pass instrumentations. More...

#include "llvm/Passes/StandardInstrumentations.h"
#include "llvm/ADT/Any.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Analysis/CallGraphSCCPass.h"
#include "llvm/Analysis/LazyCallGraph.h"
#include "llvm/Analysis/LoopInfo.h"
#include "llvm/CodeGen/MIRPrinter.h"
#include "llvm/CodeGen/MachineFunction.h"
#include "llvm/CodeGen/MachineModuleInfo.h"
#include "llvm/CodeGen/MachineVerifier.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/PassInstrumentation.h"
#include "llvm/IR/PassManager.h"
#include "llvm/IR/PrintPasses.h"
#include "llvm/IR/StructuralHash.h"
#include "llvm/IR/Verifier.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/CrashRecoveryContext.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/GraphWriter.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/Program.h"
#include "llvm/Support/Regex.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Support/xxhash.h"
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>

Classes
struct	PreservedCFGCheckerAnalysis

struct	PreservedFunctionHashAnalysis

struct	PreservedFunctionHashAnalysis::FunctionHash

struct	PreservedModuleHashAnalysis

struct	PreservedModuleHashAnalysis::ModuleHash

struct	llvm::GraphTraits< DotCfgDiffDisplayGraph * >

struct	llvm::DOTGraphTraits< DotCfgDiffDisplayGraph * >

Namespaces
namespace	llvm
	This is an optimization pass for GlobalISel generic memory operations.

Enumerations
enum class	IRDumpFileSuffixType { Before , After , Invalidated }

Functions
template<typename IRUnitT >
static const IRUnitT *	unwrapIR (Any IR)

static bool	shouldGenerateData (const Function &F)

static bool	shouldGenerateData (const MachineFunction &MF)

static SmallString< 32 >	getIRFileDisplayName (Any IR)

static StringRef	getFileSuffix (IRDumpFileSuffixType Type)

static int	prepareDumpIRFileDescriptor (const StringRef DumpIRFilename)

static void	printBBName (raw_ostream &out, const BasicBlock *BB)

static SmallVector< Function *, 1 >	GetFunctions (Any IR)

Variables
static cl::opt< bool >	VerifyAnalysisInvalidation ("verify-analysis-invalidation", cl::Hidden, cl::init(false))

static cl::opt< bool >	PrintChangedBefore ("print-before-changed", cl::desc("Print before passes that change them"), cl::init(false), cl::Hidden)

static cl::opt< std::string >	DotBinary ("print-changed-dot-path", cl::Hidden, cl::init("dot"), cl::desc("system dot used by change reporters"))

static cl::opt< std::string >	BeforeColour ("dot-cfg-before-color", cl::desc("Color for dot-cfg before elements"), cl::Hidden, cl::init("red"))

static cl::opt< std::string >	AfterColour ("dot-cfg-after-color", cl::desc("Color for dot-cfg after elements"), cl::Hidden, cl::init("forestgreen"))

static cl::opt< std::string >	CommonColour ("dot-cfg-common-color", cl::desc("Color for dot-cfg common elements"), cl::Hidden, cl::init("black"))

static cl::opt< std::string >	DotCfgDir ("dot-cfg-dir", cl::desc("Generate dot files into specified directory for changed IRs"), cl::Hidden, cl::init("./"))

static cl::opt< std::string >	PrintOnCrashPath ("print-on-crash-path", cl::desc("Print the last form of the IR before crash to a file"), cl::Hidden)

static cl::opt< bool >	PrintOnCrash ("print-on-crash", cl::desc("Print the last form of the IR before crash (use -print-on-crash-path to dump to a file)"), cl::Hidden)

static cl::opt< std::string >	OptBisectPrintIRPath ("opt-bisect-print-ir-path", cl::desc("Print IR to path when opt-bisect-limit is reached"), cl::Hidden)

static cl::opt< bool >	PrintPassNumbers ("print-pass-numbers", cl::init(false), cl::Hidden, cl::desc("Print pass names and their ordinals"))

static cl::opt< unsigned >	PrintBeforePassNumber ("print-before-pass-number", cl::init(0), cl::Hidden, cl::desc("Print IR before the pass with this number as " "reported by print-pass-numbers"))

static cl::opt< unsigned >	PrintAfterPassNumber ("print-after-pass-number", cl::init(0), cl::Hidden, cl::desc("Print IR after the pass with this number as " "reported by print-pass-numbers"))

static cl::opt< std::string >	IRDumpDirectory ("ir-dump-directory", cl::desc("If specified, IR printed using the " "-print-[before\|after]{-all} options will be dumped into " "files in this directory rather than written to stderr"), cl::Hidden, cl::value_desc("filename"))

Detailed Description

This file defines IR-printing pass instrumentation callbacks as well as StandardInstrumentations class that manages standard pass instrumentations.

Definition in file StandardInstrumentations.cpp.

Enumeration Type Documentation

◆ IRDumpFileSuffixType

enum class IRDumpFileSuffixType

strong

Enumerator
Before
After
Invalidated

Definition at line 802 of file StandardInstrumentations.cpp.

Function Documentation

◆ getFileSuffix()

static StringRef getFileSuffix ( IRDumpFileSuffixType Type )

static

Definition at line 808 of file StandardInstrumentations.cpp.

◆ GetFunctions()

static SmallVector< Function *, 1 > GetFunctions ( Any IR )

static

Definition at line 1340 of file StandardInstrumentations.cpp.

References F, IR, and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by llvm::PreservedCFGCheckerInstrumentation::registerCallbacks().

◆ getIRFileDisplayName()

static SmallString< 32 > getIRFileDisplayName ( Any IR )

static

Definition at line 751 of file StandardInstrumentations.cpp.

References llvm::CallingConv::C, F, llvm::MachineFunction::getName(), IR, llvm_unreachable, llvm::Lower, llvm::write_hex(), and llvm::xxh3_64bits().

◆ prepareDumpIRFileDescriptor()

static int prepareDumpIRFileDescriptor ( const StringRef DumpIRFilename )

static

Definition at line 830 of file StandardInstrumentations.cpp.

References llvm::sys::fs::CD_OpenAlways, llvm::sys::fs::create_directories(), llvm::sys::fs::FA_Write, llvm::sys::fs::OF_Text, llvm::sys::fs::openFile(), llvm::sys::path::parent_path(), and llvm::report_fatal_error().

◆ printBBName()

static void printBBName	(	raw_ostream &	out,
		const BasicBlock *	BB
	)

static

Definition at line 1186 of file StandardInstrumentations.cpp.

References llvm::Value::getName(), llvm::BasicBlock::getParent(), llvm::Value::hasName(), and llvm::BasicBlock::isEntryBlock().

Referenced by llvm::PreservedCFGCheckerInstrumentation::CFG::printDiff().

◆ shouldGenerateData() [1/2]

static bool shouldGenerateData ( const Function & F )

static

Definition at line 716 of file StandardInstrumentations.cpp.

References F, and llvm::isFunctionInPrintList().

Referenced by llvm::IRComparer< T >::generateFunctionData().

◆ shouldGenerateData() [2/2]

static bool shouldGenerateData ( const MachineFunction & MF )

static

Definition at line 720 of file StandardInstrumentations.cpp.

References llvm::MachineFunction::getName(), and llvm::isFunctionInPrintList().

◆ unwrapIR()

template<typename IRUnitT >

static const IRUnitT * unwrapIR ( Any IR )

static

Definition at line 141 of file StandardInstrumentations.cpp.

References IR.

Variable Documentation

◆ AfterColour

cl::opt< std::string > AfterColour("dot-cfg-after-color", cl::desc("Color for dot-cfg after elements"), cl::Hidden, cl::init("forestgreen"))	(	"dot-cfg-after-color"	,
		cl::desc("Color for dot-cfg after elements")	,
		cl::Hidden	,
		cl::init("forestgreen")
	)

static

◆ BeforeColour

cl::opt< std::string > BeforeColour("dot-cfg-before-color", cl::desc("Color for dot-cfg before elements"), cl::Hidden, cl::init("red"))	(	"dot-cfg-before-color"	,
		cl::desc("Color for dot-cfg before elements")	,
		cl::Hidden	,
		cl::init("red")
	)

static

◆ CommonColour

cl::opt< std::string > CommonColour("dot-cfg-common-color", cl::desc("Color for dot-cfg common elements"), cl::Hidden, cl::init("black"))	(	"dot-cfg-common-color"	,
		cl::desc("Color for dot-cfg common elements")	,
		cl::Hidden	,
		cl::init("black")
	)

static

◆ DotBinary

cl::opt< std::string > DotBinary("print-changed-dot-path", cl::Hidden, cl::init("dot"), cl::desc("system dot used by change reporters"))	(	"print-changed-dot-path"	,
		cl::Hidden	,
		cl::init("dot")	,
		cl::desc("system dot used by change reporters")
	)

static

Referenced by llvm::DotCfgChangeReporter::genHTML().

◆ DotCfgDir

cl::opt< std::string > DotCfgDir("dot-cfg-dir", cl::desc("Generate dot files into specified directory for changed IRs"), cl::Hidden, cl::init("./"))	(	"dot-cfg-dir"	,
		cl::desc("Generate dot files into specified directory for changed IRs")	,
		cl::Hidden	,
		cl::init("./")
	)

static

Referenced by llvm::DotCfgChangeReporter::genHTML(), llvm::DotCfgChangeReporter::initializeHTML(), and llvm::DotCfgChangeReporter::registerCallbacks().

◆ IRDumpDirectory

cl::opt< std::string > IRDumpDirectory("ir-dump-directory", cl::desc("If specified, IR printed using the " "-print-[before\|after]{-all} options will be dumped into " "files in this directory rather than written to stderr"), cl::Hidden, cl::value_desc("filename"))	(	"ir-dump-directory"	,
		cl::desc("If specified, IR printed using the " "-print-[before\|after]{-all} options will be dumped into " "files in this directory rather than written to stderr")	,
		cl::Hidden	,
		cl::value_desc("filename")
	)

static

◆ OptBisectPrintIRPath

cl::opt< std::string > OptBisectPrintIRPath("opt-bisect-print-ir-path", cl::desc("Print IR to path when opt-bisect-limit is reached"), cl::Hidden)	(	"opt-bisect-print-ir-path"	,
		cl::desc("Print IR to path when opt-bisect-limit is reached")	,
		cl::Hidden
	)

static

Referenced by llvm::OptPassGateInstrumentation::shouldRun().

◆ PrintAfterPassNumber

cl::opt< unsigned > PrintAfterPassNumber("print-after-pass-number", cl::init(0), cl::Hidden, cl::desc("Print IR after the pass with this number as " "reported by print-pass-numbers"))	(	"print-after-pass-number"	,
		cl::init(0)	,
		cl::Hidden	,
		cl::desc("Print IR after the pass with this number as " "reported by print-pass-numbers")
	)

static

◆ PrintBeforePassNumber

cl::opt< unsigned > PrintBeforePassNumber("print-before-pass-number", cl::init(0), cl::Hidden, cl::desc("Print IR before the pass with this number as " "reported by print-pass-numbers"))	(	"print-before-pass-number"	,
		cl::init(0)	,
		cl::Hidden	,
		cl::desc("Print IR before the pass with this number as " "reported by print-pass-numbers")
	)

static

◆ PrintChangedBefore

cl::opt< bool > PrintChangedBefore("print-before-changed", cl::desc("Print before passes that change them"), cl::init(false), cl::Hidden)	(	"print-before-changed"	,
		cl::desc("Print before passes that change them")	,
		cl::init(false)	,
		cl::Hidden
	)

static

Referenced by llvm::IRChangedPrinter::handleAfter().

◆ PrintOnCrash

cl::opt< bool > PrintOnCrash("print-on-crash", cl::desc("Print the last form of the IR before crash (use -print-on-crash-path to dump to a file)"), cl::Hidden)	(	"print-on-crash"	,
		cl::desc("Print the last form of the IR before crash (use -print-on-crash-path to dump to a file)")	,
		cl::Hidden
	)

static

Referenced by llvm::PrintCrashIRInstrumentation::registerCallbacks(), and llvm::PrintCrashIRInstrumentation::~PrintCrashIRInstrumentation().

◆ PrintOnCrashPath

cl::opt< std::string > PrintOnCrashPath("print-on-crash-path", cl::desc("Print the last form of the IR before crash to a file"), cl::Hidden)	(	"print-on-crash-path"	,
		cl::desc("Print the last form of the IR before crash to a file")	,
		cl::Hidden
	)

static

Referenced by llvm::PrintCrashIRInstrumentation::registerCallbacks(), llvm::PrintCrashIRInstrumentation::reportCrashIR(), and llvm::PrintCrashIRInstrumentation::~PrintCrashIRInstrumentation().

◆ PrintPassNumbers

cl::opt< bool > PrintPassNumbers("print-pass-numbers", cl::init(false), cl::Hidden, cl::desc("Print pass names and their ordinals"))	(	"print-pass-numbers"	,
		cl::init(false)	,
		cl::Hidden	,
		cl::desc("Print pass names and their ordinals")
	)

static

◆ VerifyAnalysisInvalidation

cl::opt< bool > VerifyAnalysisInvalidation("verify-analysis-invalidation", cl::Hidden, cl::init(false))	(	"verify-analysis-invalidation"	,
		cl::Hidden	,
		cl::init(false)
	)

static

Referenced by llvm::PreservedCFGCheckerInstrumentation::registerCallbacks().

Classes

Namespaces

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ IRDumpFileSuffixType

Function Documentation

◆ getFileSuffix()

◆ GetFunctions()

◆ getIRFileDisplayName()

◆ prepareDumpIRFileDescriptor()

◆ printBBName()

◆ shouldGenerateData() [1/2]

◆ shouldGenerateData() [2/2]

◆ unwrapIR()

Variable Documentation

◆ AfterColour

◆ BeforeColour

◆ CommonColour

◆ DotBinary

◆ DotCfgDir

◆ IRDumpDirectory

◆ OptBisectPrintIRPath

◆ PrintAfterPassNumber

◆ PrintBeforePassNumber

◆ PrintChangedBefore

◆ PrintOnCrash

◆ PrintOnCrashPath

◆ PrintPassNumbers

◆ VerifyAnalysisInvalidation