2003-10-23 00:03:49 +08:00
|
|
|
//===- CFGPrinter.cpp - DOT printer for the control flow graph ------------===//
|
2005-04-22 05:13:18 +08:00
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
2005-04-22 05:13:18 +08:00
|
|
|
//
|
2003-10-23 00:03:49 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2018-10-09 12:30:23 +08:00
|
|
|
// This file defines a `-dot-cfg` analysis pass, which emits the
|
|
|
|
// `<prefix>.<fnname>.dot` file for each function in the program, with a graph
|
|
|
|
// of the CFG for that function. The default value for `<prefix>` is `cfg` but
|
|
|
|
// can be customized as needed.
|
2003-10-23 00:03:49 +08:00
|
|
|
//
|
|
|
|
// The other main feature of this file is that it implements the
|
|
|
|
// Function::viewCFG method, which is useful for debugging passes which operate
|
|
|
|
// on the CFG.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2004-04-27 00:27:08 +08:00
|
|
|
#include "llvm/Analysis/CFGPrinter.h"
|
2009-10-18 12:09:11 +08:00
|
|
|
#include "llvm/Pass.h"
|
2014-04-30 07:26:49 +08:00
|
|
|
#include "llvm/Support/FileSystem.h"
|
2003-12-12 05:48:18 +08:00
|
|
|
using namespace llvm;
|
2003-11-12 06:41:34 +08:00
|
|
|
|
2018-07-26 01:22:12 +08:00
|
|
|
static cl::opt<std::string> CFGFuncName(
|
|
|
|
"cfg-func-name", cl::Hidden,
|
|
|
|
cl::desc("The name of a function (or its substring)"
|
|
|
|
" whose CFG is viewed/printed."));
|
|
|
|
|
2018-10-09 12:30:23 +08:00
|
|
|
static cl::opt<std::string> CFGDotFilenamePrefix(
|
|
|
|
"cfg-dot-filename-prefix", cl::Hidden,
|
|
|
|
cl::desc("The prefix used for the CFG dot file names."));
|
|
|
|
|
2003-10-23 00:03:49 +08:00
|
|
|
namespace {
|
2018-06-30 01:48:58 +08:00
|
|
|
struct CFGViewerLegacyPass : public FunctionPass {
|
2007-05-14 22:25:08 +08:00
|
|
|
static char ID; // Pass identifcation, replacement for typeid
|
2018-06-30 01:48:58 +08:00
|
|
|
CFGViewerLegacyPass() : FunctionPass(ID) {
|
2016-09-16 02:35:27 +08:00
|
|
|
initializeCFGViewerLegacyPassPass(*PassRegistry::getPassRegistry());
|
2010-10-20 01:21:58 +08:00
|
|
|
}
|
2008-03-18 08:39:19 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
bool runOnFunction(Function &F) override {
|
|
|
|
F.viewCFG();
|
2007-05-14 22:25:08 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
void print(raw_ostream &OS, const Module* = nullptr) const override {}
|
2007-05-14 22:25:08 +08:00
|
|
|
|
2014-03-05 15:30:04 +08:00
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
2007-05-14 22:25:08 +08:00
|
|
|
AU.setPreservesAll();
|
|
|
|
}
|
|
|
|
};
|
2015-06-23 17:49:53 +08:00
|
|
|
}
|
2007-05-14 22:25:08 +08:00
|
|
|
|
2016-09-16 02:35:27 +08:00
|
|
|
char CFGViewerLegacyPass::ID = 0;
|
|
|
|
INITIALIZE_PASS(CFGViewerLegacyPass, "view-cfg", "View CFG of function", false, true)
|
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
PreservedAnalyses CFGViewerPass::run(Function &F,
|
|
|
|
FunctionAnalysisManager &AM) {
|
|
|
|
F.viewCFG();
|
2016-09-16 02:35:27 +08:00
|
|
|
return PreservedAnalyses::all();
|
|
|
|
}
|
|
|
|
|
2007-05-14 22:25:08 +08:00
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
namespace {
|
2018-06-30 01:48:58 +08:00
|
|
|
struct CFGOnlyViewerLegacyPass : public FunctionPass {
|
2007-05-14 22:25:08 +08:00
|
|
|
static char ID; // Pass identifcation, replacement for typeid
|
2018-06-30 01:48:58 +08:00
|
|
|
CFGOnlyViewerLegacyPass() : FunctionPass(ID) {
|
2016-09-16 02:35:27 +08:00
|
|
|
initializeCFGOnlyViewerLegacyPassPass(*PassRegistry::getPassRegistry());
|
2010-10-20 01:21:58 +08:00
|
|
|
}
|
2008-03-18 08:39:19 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
bool runOnFunction(Function &F) override {
|
|
|
|
F.viewCFGOnly();
|
2007-05-14 22:25:08 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
void print(raw_ostream &OS, const Module* = nullptr) const override {}
|
2007-05-14 22:25:08 +08:00
|
|
|
|
2014-03-05 15:30:04 +08:00
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
2007-05-14 22:25:08 +08:00
|
|
|
AU.setPreservesAll();
|
|
|
|
}
|
|
|
|
};
|
2015-06-23 17:49:53 +08:00
|
|
|
}
|
2007-05-14 22:25:08 +08:00
|
|
|
|
2016-09-16 02:35:27 +08:00
|
|
|
char CFGOnlyViewerLegacyPass::ID = 0;
|
|
|
|
INITIALIZE_PASS(CFGOnlyViewerLegacyPass, "view-cfg-only",
|
2010-10-08 06:25:06 +08:00
|
|
|
"View CFG of function (with no function bodies)", false, true)
|
2007-05-14 22:25:08 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
PreservedAnalyses CFGOnlyViewerPass::run(Function &F,
|
|
|
|
FunctionAnalysisManager &AM) {
|
|
|
|
F.viewCFGOnly();
|
2016-09-16 02:35:27 +08:00
|
|
|
return PreservedAnalyses::all();
|
|
|
|
}
|
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
static void writeCFGToDotFile(Function &F, bool CFGOnly = false) {
|
2018-07-26 01:22:12 +08:00
|
|
|
if (!CFGFuncName.empty() && !F.getName().contains(CFGFuncName))
|
|
|
|
return;
|
2018-10-09 12:30:23 +08:00
|
|
|
std::string Filename =
|
|
|
|
(CFGDotFilenamePrefix + "." + F.getName() + ".dot").str();
|
2018-06-30 01:48:58 +08:00
|
|
|
errs() << "Writing '" << Filename << "'...";
|
|
|
|
|
|
|
|
std::error_code EC;
|
|
|
|
raw_fd_ostream File(Filename, EC, sys::fs::F_Text);
|
|
|
|
|
|
|
|
if (!EC)
|
|
|
|
WriteGraph(File, (const Function*)&F, CFGOnly);
|
|
|
|
else
|
|
|
|
errs() << " error opening file for writing!";
|
|
|
|
errs() << "\n";
|
|
|
|
}
|
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
namespace {
|
2018-06-30 01:48:58 +08:00
|
|
|
struct CFGPrinterLegacyPass : public FunctionPass {
|
2007-05-06 21:37:16 +08:00
|
|
|
static char ID; // Pass identification, replacement for typeid
|
2018-06-30 01:48:58 +08:00
|
|
|
CFGPrinterLegacyPass() : FunctionPass(ID) {
|
2016-09-16 02:35:27 +08:00
|
|
|
initializeCFGPrinterLegacyPassPass(*PassRegistry::getPassRegistry());
|
2010-10-20 01:21:58 +08:00
|
|
|
}
|
2008-03-18 08:39:19 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
bool runOnFunction(Function &F) override {
|
|
|
|
writeCFGToDotFile(F);
|
2003-10-23 00:03:49 +08:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
void print(raw_ostream &OS, const Module* = nullptr) const override {}
|
2005-04-22 05:13:18 +08:00
|
|
|
|
2014-03-05 15:30:04 +08:00
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
2003-10-23 00:03:49 +08:00
|
|
|
AU.setPreservesAll();
|
|
|
|
}
|
|
|
|
};
|
2015-06-23 17:49:53 +08:00
|
|
|
}
|
2003-10-23 00:03:49 +08:00
|
|
|
|
2016-09-16 02:35:27 +08:00
|
|
|
char CFGPrinterLegacyPass::ID = 0;
|
2018-07-31 03:41:25 +08:00
|
|
|
INITIALIZE_PASS(CFGPrinterLegacyPass, "dot-cfg", "Print CFG of function to 'dot' file",
|
2010-10-08 06:25:06 +08:00
|
|
|
false, true)
|
2003-12-12 05:48:18 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
PreservedAnalyses CFGPrinterPass::run(Function &F,
|
|
|
|
FunctionAnalysisManager &AM) {
|
|
|
|
writeCFGToDotFile(F);
|
2016-09-16 02:35:27 +08:00
|
|
|
return PreservedAnalyses::all();
|
|
|
|
}
|
|
|
|
|
2008-05-13 08:00:25 +08:00
|
|
|
namespace {
|
2018-06-30 01:48:58 +08:00
|
|
|
struct CFGOnlyPrinterLegacyPass : public FunctionPass {
|
2007-05-06 21:37:16 +08:00
|
|
|
static char ID; // Pass identification, replacement for typeid
|
2018-06-30 01:48:58 +08:00
|
|
|
CFGOnlyPrinterLegacyPass() : FunctionPass(ID) {
|
2016-09-16 02:35:27 +08:00
|
|
|
initializeCFGOnlyPrinterLegacyPassPass(*PassRegistry::getPassRegistry());
|
2010-10-20 01:21:58 +08:00
|
|
|
}
|
2014-03-05 15:30:04 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
bool runOnFunction(Function &F) override {
|
|
|
|
writeCFGToDotFile(F, /*CFGOnly=*/true);
|
2003-12-12 05:48:18 +08:00
|
|
|
return false;
|
|
|
|
}
|
2018-06-30 01:48:58 +08:00
|
|
|
void print(raw_ostream &OS, const Module* = nullptr) const override {}
|
2005-04-22 05:13:18 +08:00
|
|
|
|
2014-03-05 15:30:04 +08:00
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
2003-12-12 05:48:18 +08:00
|
|
|
AU.setPreservesAll();
|
|
|
|
}
|
|
|
|
};
|
2015-06-23 17:49:53 +08:00
|
|
|
}
|
2003-10-23 00:03:49 +08:00
|
|
|
|
2016-09-16 02:35:27 +08:00
|
|
|
char CFGOnlyPrinterLegacyPass::ID = 0;
|
|
|
|
INITIALIZE_PASS(CFGOnlyPrinterLegacyPass, "dot-cfg-only",
|
2010-08-24 01:52:01 +08:00
|
|
|
"Print CFG of function to 'dot' file (with no function bodies)",
|
2010-10-08 06:25:06 +08:00
|
|
|
false, true)
|
2008-05-13 08:00:25 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
PreservedAnalyses CFGOnlyPrinterPass::run(Function &F,
|
|
|
|
FunctionAnalysisManager &AM) {
|
|
|
|
writeCFGToDotFile(F, /*CFGOnly=*/true);
|
2016-09-16 02:35:27 +08:00
|
|
|
return PreservedAnalyses::all();
|
|
|
|
}
|
|
|
|
|
2003-10-23 00:03:49 +08:00
|
|
|
/// viewCFG - This function is meant for use from the debugger. You can just
|
|
|
|
/// say 'call F->viewCFG()' and a ghostview window should pop up from the
|
|
|
|
/// program, displaying the CFG of the current function. This depends on there
|
|
|
|
/// being a 'dot' and 'gv' program in your path.
|
|
|
|
///
|
|
|
|
void Function::viewCFG() const {
|
2018-07-26 01:22:12 +08:00
|
|
|
if (!CFGFuncName.empty() && !getName().contains(CFGFuncName))
|
|
|
|
return;
|
2018-06-30 01:48:58 +08:00
|
|
|
ViewGraph(this, "cfg" + getName());
|
2003-10-23 00:03:49 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
/// viewCFGOnly - This function is meant for use from the debugger. It works
|
|
|
|
/// just like viewCFG, but it does not include the contents of basic blocks
|
2014-05-21 01:11:11 +08:00
|
|
|
/// into the nodes, just the label. If you are only interested in the CFG
|
|
|
|
/// this can make the graph smaller.
|
2003-10-23 00:03:49 +08:00
|
|
|
///
|
|
|
|
void Function::viewCFGOnly() const {
|
2018-07-26 01:22:12 +08:00
|
|
|
if (!CFGFuncName.empty() && !getName().contains(CFGFuncName))
|
|
|
|
return;
|
2018-06-30 01:48:58 +08:00
|
|
|
ViewGraph(this, "cfg" + getName(), true);
|
2003-10-23 00:03:49 +08:00
|
|
|
}
|
2004-04-27 00:27:08 +08:00
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
FunctionPass *llvm::createCFGPrinterLegacyPassPass () {
|
2016-09-16 02:35:27 +08:00
|
|
|
return new CFGPrinterLegacyPass();
|
2004-04-27 00:27:08 +08:00
|
|
|
}
|
|
|
|
|
2018-06-30 01:48:58 +08:00
|
|
|
FunctionPass *llvm::createCFGOnlyPrinterLegacyPassPass () {
|
2016-09-16 02:35:27 +08:00
|
|
|
return new CFGOnlyPrinterLegacyPass();
|
2004-04-27 00:27:08 +08:00
|
|
|
}
|
2018-06-30 01:48:58 +08:00
|
|
|
|