llvm/llvm/include/llvm/Analysis/CFGPrinter.h

//===-- CFGPrinter.h - CFG printer external interface -----------*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file defines a 'dot-cfg' analysis pass, which emits the
// cfg.<fnname>.dot file for each function in the program, with a graph of the
// CFG for that function.
//
// This file defines external functions that can be called to explicitly
// instantiate the CFG printer.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_ANALYSIS_CFGPRINTER_H
#define LLVM_ANALYSIS_CFGPRINTER_H

#include "llvm/Analysis/BlockFrequencyInfo.h"
#include "llvm/Analysis/BranchProbabilityInfo.h"
#include "llvm/Analysis/HeatUtils.h"
#include "llvm/IR/CFG.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/PassManager.h"
#include "llvm/IR/ProfDataUtils.h"
#include "llvm/Support/DOTGraphTraits.h"
#include "llvm/Support/FormatVariadic.h"

namespace llvm {
template <class GraphType> struct GraphTraits;
class CFGViewerPass : public PassInfoMixin<CFGViewerPass> { … };

class CFGOnlyViewerPass : public PassInfoMixin<CFGOnlyViewerPass> { … };

class CFGPrinterPass : public PassInfoMixin<CFGPrinterPass> { … };

class CFGOnlyPrinterPass : public PassInfoMixin<CFGOnlyPrinterPass> { … };

class DOTFuncInfo { … };

template <>
struct GraphTraits<DOTFuncInfo *> : public GraphTraits<const BasicBlock *> { … };

template <typename BasicBlockT>
std::string SimpleNodeLabelString(const BasicBlockT *Node) { … }

template <typename BasicBlockT>
std::string CompleteNodeLabelString(
    const BasicBlockT *Node,
    function_ref<void(raw_string_ostream &, const BasicBlockT &)>
        HandleBasicBlock,
    function_ref<void(std::string &, unsigned &, unsigned)>
        HandleComment) { … }

template <>
struct DOTGraphTraits<DOTFuncInfo *> : public DefaultDOTGraphTraits { … };
} // End llvm namespace

#endif