LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
llvm::DOTGraphTraits< DOTFuncInfo * > Struct Reference

#include "llvm/Analysis/CFGPrinter.h"

Inheritance diagram for llvm::DOTGraphTraits< DOTFuncInfo * >:
Inheritance graph
[legend]
Collaboration diagram for llvm::DOTGraphTraits< DOTFuncInfo * >:
Collaboration graph
[legend]

Public Member Functions

 DOTGraphTraits (bool isSimple=false)
 
std::string getNodeLabel (const BasicBlock *Node, DOTFuncInfo *CFGInfo)
 
std::string getEdgeAttributes (const BasicBlock *Node, const_succ_iterator I, DOTFuncInfo *CFGInfo)
 Display the raw branch weights from PGO. More...
 
std::string getNodeAttributes (const BasicBlock *Node, DOTFuncInfo *CFGInfo)
 
bool isNodeHidden (const BasicBlock *Node, const DOTFuncInfo *CFGInfo)
 
void computeDeoptOrUnreachablePaths (const Function *F)
 
- Public Member Functions inherited from llvm::DefaultDOTGraphTraits
 DefaultDOTGraphTraits (bool simple=false)
 
template<typename GraphType >
std::string getNodeLabel (const void *, const GraphType &)
 getNodeLabel - Given a node and a pointer to the top level graph, return the label to print in the node. More...
 

Static Public Member Functions

static std::string getGraphName (DOTFuncInfo *CFGInfo)
 
static std::string getSimpleNodeLabel (const BasicBlock *Node, DOTFuncInfo *)
 
static void eraseComment (std::string &OutStr, unsigned &I, unsigned Idx)
 
static std::string getCompleteNodeLabel (const BasicBlock *Node, DOTFuncInfo *, llvm::function_ref< void(raw_string_ostream &, const BasicBlock &)> HandleBasicBlock=[](raw_string_ostream &OS, const BasicBlock &Node) -> void { OS<< Node;}, llvm::function_ref< void(std::string &, unsigned &, unsigned)> HandleComment=eraseComment)
 
static std::string getEdgeSourceLabel (const BasicBlock *Node, const_succ_iterator I)
 
- Static Public Member Functions inherited from llvm::DefaultDOTGraphTraits
template<typename GraphType >
static std::string getGraphName (const GraphType &)
 getGraphName - Return the label for the graph as a whole. More...
 
template<typename GraphType >
static std::string getGraphProperties (const GraphType &)
 getGraphProperties - Return any custom properties that should be included in the top level graph structure for dot. More...
 
static bool renderGraphFromBottomUp ()
 renderGraphFromBottomUp - If this function returns true, the graph is emitted bottom-up instead of top-down. More...
 
template<typename GraphType >
static bool isNodeHidden (const void *, const GraphType &)
 isNodeHidden - If the function returns true, the given node is not displayed in the graph. More...
 
template<typename GraphType >
static std::string getNodeIdentifierLabel (const void *, const GraphType &)
 
template<typename GraphType >
static std::string getNodeDescription (const void *, const GraphType &)
 
template<typename GraphType >
static std::string getNodeAttributes (const void *, const GraphType &)
 If you want to specify custom node attributes, this is the place to do so. More...
 
template<typename EdgeIter , typename GraphType >
static std::string getEdgeAttributes (const void *, EdgeIter, const GraphType &)
 If you want to override the dot attributes printed for a particular edge, override this method. More...
 
template<typename EdgeIter >
static std::string getEdgeSourceLabel (const void *, EdgeIter)
 getEdgeSourceLabel - If you want to label the edge source itself, implement this method. More...
 
template<typename EdgeIter >
static bool edgeTargetsEdgeSource (const void *, EdgeIter)
 edgeTargetsEdgeSource - This method returns true if this outgoing edge should actually target another edge source, not a node. More...
 
template<typename EdgeIter >
static EdgeIter getEdgeTarget (const void *, EdgeIter I)
 getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is called to determine which outgoing edge of Node is the target of this edge. More...
 
static bool hasEdgeDestLabels ()
 hasEdgeDestLabels - If this function returns true, the graph is able to provide labels for edge destinations. More...
 
static unsigned numEdgeDestLabels (const void *)
 numEdgeDestLabels - If hasEdgeDestLabels, this function returns the number of incoming edge labels the given node has. More...
 
static std::string getEdgeDestLabel (const void *, unsigned)
 getEdgeDestLabel - If hasEdgeDestLabels, this function returns the incoming edge label with the given index in the given node. More...
 
template<typename GraphType , typename GraphWriter >
static void addCustomGraphFeatures (const GraphType &, GraphWriter &)
 addCustomGraphFeatures - If a graph is made up of more than just straight-forward nodes and edges, this is the place to put all of the custom stuff necessary. More...
 

Public Attributes

llvm::DenseMap< const BasicBlock *, bool > isOnDeoptOrUnreachablePath
 

Additional Inherited Members

- Protected Member Functions inherited from llvm::DefaultDOTGraphTraits
bool isSimple ()
 

Detailed Description

Definition at line 123 of file CFGPrinter.h.

Constructor & Destructor Documentation

◆ DOTGraphTraits()

llvm::DOTGraphTraits< DOTFuncInfo * >::DOTGraphTraits ( bool  isSimple = false)
inline

Definition at line 128 of file CFGPrinter.h.

Member Function Documentation

◆ computeDeoptOrUnreachablePaths()

void llvm::DOTGraphTraits< DOTFuncInfo * >::computeDeoptOrUnreachablePaths ( const Function F)

◆ eraseComment()

static void llvm::DOTGraphTraits< DOTFuncInfo * >::eraseComment ( std::string &  OutStr,
unsigned &  I,
unsigned  Idx 
)
inlinestatic

Definition at line 145 of file CFGPrinter.h.

References I.

◆ getCompleteNodeLabel()

static std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getCompleteNodeLabel ( const BasicBlock Node,
DOTFuncInfo ,
llvm::function_ref< void(raw_string_ostream &, const BasicBlock &)>  HandleBasicBlock = [](raw_string_ostream &OS,                                const BasicBlock &Node) -> void { OS << Node; },
llvm::function_ref< void(std::string &, unsigned &, unsigned)>  HandleComment = eraseComment 
)
inlinestatic

Definition at line 150 of file CFGPrinter.h.

◆ getEdgeAttributes()

std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getEdgeAttributes ( const BasicBlock Node,
const_succ_iterator  I,
DOTFuncInfo CFGInfo 
)
inline

◆ getEdgeSourceLabel()

static std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getEdgeSourceLabel ( const BasicBlock Node,
const_succ_iterator  I 
)
inlinestatic

◆ getGraphName()

static std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getGraphName ( DOTFuncInfo CFGInfo)
inlinestatic

◆ getNodeAttributes()

std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getNodeAttributes ( const BasicBlock Node,
DOTFuncInfo CFGInfo 
)
inline

◆ getNodeLabel()

std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getNodeLabel ( const BasicBlock Node,
DOTFuncInfo CFGInfo 
)
inline

Definition at line 199 of file CFGPrinter.h.

References isSimple().

◆ getSimpleNodeLabel()

static std::string llvm::DOTGraphTraits< DOTFuncInfo * >::getSimpleNodeLabel ( const BasicBlock Node,
DOTFuncInfo  
)
inlinestatic

Definition at line 134 of file CFGPrinter.h.

References llvm::raw_string_ostream::str().

◆ isNodeHidden()

bool llvm::DOTGraphTraits< DOTFuncInfo * >::isNodeHidden ( const BasicBlock Node,
const DOTFuncInfo CFGInfo 
)

Member Data Documentation

◆ isOnDeoptOrUnreachablePath

llvm::DenseMap<const BasicBlock *, bool> llvm::DOTGraphTraits< DOTFuncInfo * >::isOnDeoptOrUnreachablePath

Definition at line 126 of file CFGPrinter.h.


The documentation for this struct was generated from the following file: