P4C
The P4 Compiler
Loading...
Searching...
No Matches
P4::Visitor Class Referenceabstract
Inheritance diagram for P4::Visitor:
[legend]

Classes

class  ChangeTracker
 Assists visitors in traversing the IR. More...
 
class  profile_t
 
class  Tracker
 Assists visitors in traversing the IR. More...
 

Public Types

typedef Visitor_Context Context
 

Public Member Functions

virtual const IR::Nodeapply_visitor (const IR::Node *n, const char *name=0)=0
 
virtual bool check_clone (const Visitor *a)
 
virtual bool check_global (cstring)
 
virtual void clear_globals ()
 
virtual Visitorclone () const
 
virtual ControlFlowVisitorcontrolFlowVisitor ()
 
virtual void end_apply ()
 
virtual void end_apply (const IR::Node *root)
 
virtual void erase_global (cstring)
 
template<class T >
const T * findContext () const
 
template<class T >
const T * findContext (const Context *&c) const
 
template<class T >
const T * findOrigCtxt () const
 
template<class T >
const T * findOrigCtxt (const Context *&c) const
 
virtual Visitorflow_clone ()
 
virtual void flow_merge (Visitor &)
 
virtual bool flow_merge_closure (Visitor &)
 
virtual void flow_merge_global_from (cstring)
 
virtual void flow_merge_global_to (cstring)
 
const ContextgetChildContext () const
 
int getChildrenVisited () const
 
const ContextgetContext () const
 
int getContextDepth () const
 
const IR::NodegetCurrentNode () const
 
template<class T >
const T * getCurrentNode () const
 
const IR::NodegetOriginal () const
 
template<class T >
const T * getOriginal () const
 
template<class T >
const T * getParent () const
 
virtual bool has_flow_joins () const
 
virtual profile_t init_apply (const IR::Node *root)
 
profile_t init_apply (const IR::Node *root, const Context *parent_context)
 
bool isInContext (const IR::Node *n) const
 
virtual const char * name () const
 
template<class T >
void parallel_visit (const IR::Vector< T > &v, const char *name, int cidx)
 
template<class T >
void parallel_visit (const IR::Vector< T > &v, const char *name=0)
 
template<class T >
void parallel_visit (IR::Vector< T > &v, const char *name, int cidx)
 
template<class T >
void parallel_visit (IR::Vector< T > &v, const char *name=0)
 
void print_context () const
 
const VisitorsetCalledBy (const Visitor *visitor)
 
void setName (const char *name)
 
void visit (const IR::Node &n, const char *name, int cidx)
 
void visit (const IR::Node &n, const char *name=0)
 
void visit (const IR::Node *&n, const char *name, int cidx)
 
void visit (const IR::Node *&n, const char *name=0)
 
void visit (const IR::Node *const &n, const char *name, int cidx)
 
void visit (const IR::Node *const &n, const char *name=0)
 
void visit (IR::Node &n, const char *name, int cidx)
 
void visit (IR::Node &n, const char *name=0)
 
void visit (IR::Node *&, const char *=0, int=0)
 
template<class T , typename = std::enable_if_t<Util::has_SourceInfo_v<T> && !std::is_pointer_v<T>>, class... Args>
void warn (const int kind, const char *format, const T &node, Args &&...args)
 The const ref variant of the above.
 
template<class T , typename = std::enable_if_t<Util::has_SourceInfo_v<T>>, class... Args>
void warn (const int kind, const char *format, const T *node, Args &&...args)
 
bool warning_enabled (int warning_kind) const
 

Static Public Member Functions

static cstring demangle (const char *)
 
static bool warning_enabled (const Visitor *visitor, int warning_kind)
 

Public Attributes

const Visitorcalled_by = nullptr
 
cstring internalName
 
SplitFlowVisit_base *& split_link
 
SplitFlowVisit_basesplit_link_mem = nullptr
 

Protected Member Functions

virtual void init_join_flows (const IR::Node *)
 
virtual bool join_flows (const IR::Node *)
 
virtual void post_join_flows (const IR::Node *, const IR::Node *)
 
void visit_children (const IR::Node *, std::function< void()> fn)
 
virtual void visitAgain () const
 
virtual void visitOnce () const
 

Protected Attributes

bool dontForwardChildrenBeforePreorder = false
 
bool joinFlows = false
 
bool visitDagOnce = true
 

Friends

class ControlFlowVisitor
 
class Inspector
 
class Modifier
 
class Transform
 

Member Function Documentation

◆ flow_merge()

virtual void P4::Visitor::flow_merge ( Visitor & )
inlinevirtual

Merge the given visitor into this visitor at a joint point in the control flow graph. Should update @this and leave the other unchanged.

Reimplemented in P4::ControlFlowVisitor.

◆ flow_merge_global_to()

virtual void P4::Visitor::flow_merge_global_to ( cstring )
inlinevirtual

Support methods for non-local ControlFlow computations

Reimplemented in P4::ControlFlowVisitor.

◆ getCurrentNode()

const IR::Node * P4::Visitor::getCurrentNode ( ) const
inline
Returns
the current node - i.e., the node that was passed to preorder() or postorder(). For Modifiers and Transforms, this is a clone of the node returned by getOriginal().

◆ init_apply()

Visitor::profile_t P4::Visitor::init_apply ( const IR::Node * root)
virtual

Reimplemented in P4::BMV2::HeaderConverter.

◆ join_flows()

virtual bool P4::Visitor::join_flows ( const IR::Node * )
inlineprotectedvirtual

If
is a join point in the control flow graph (i.e. has multiple incoming edges) and is not filtered out by filter_join_point, then:

  • if this is the first time a visitor has visited
    , store a clone of the visitor with this node and return true, deferring visiting this node until all incoming edges have been visited.
  • if this is NOT the first visitor, but also not the last, then merge this visitor into the stored visitor clone, and return true.
  • finally, if this is the is the final visitor, merge the stored, cloned visitor—which has accumulated all previous visitors—with this one, and return false.

join_flows(n) is invoked in apply_visitor(n, name), and
is only visited if this method returns false.

Returns
false if all upstream nodes from
have been visited, and it's time to visit
.

Reimplemented in P4::ControlFlowVisitor.

◆ post_join_flows()

virtual void P4::Visitor::post_join_flows ( const IR::Node * ,
const IR::Node *  )
inlineprotectedvirtual

Called from apply_visitor after visiting the node (pre- and postorder) and its children after join_flows returned false

Reimplemented in P4::ControlFlowVisitor.

◆ warning_enabled() [1/2]

bool P4::Visitor::warning_enabled ( const Visitor * visitor,
int warning_kind )
static

Static version of the above function, which can be called even if not directly in a visitor

◆ warning_enabled() [2/2]

bool P4::Visitor::warning_enabled ( int warning_kind) const
inline

True if the warning with this kind is enabled at this point. Warnings can be disabled by using the @noWarn("unused") annotation in an enclosing environment.