#include <pass_manager.h>

Inheritance diagram for Logging::PassManager:

Public Member Functions
	PassManager (cstring logFilePrefix, Logging::Mode logMode=Logging::Mode::CREATE)

Public Member Functions inherited from P4::PassManager
	PassManager (const PassManager &)=default

	PassManager (const std::initializer_list< VisitorRef > &init)

	PassManager (PassManager &&)=default

void	addDebugHook (DebugHook h, bool recursive=false)

void	addDebugHooks (std::vector< DebugHook > hooks, bool recursive=false)

void	addPasses (const std::initializer_list< VisitorRef > &init)

const IR::Node *	apply_visitor (const IR::Node , const char =0) override

bool	backtrack (trigger &trig) override

PassManager *	clone () const override

void	early_exit ()

void	listPasses (std::ostream &, cstring sep) const

bool	never_backtracks () override

void	removePasses (const std::vector< cstring > &exclude)

void	setStopOnError (bool stop)

Public Member Functions inherited from P4::Visitor
virtual bool	check_clone (const Visitor *a)

virtual bool	check_global (cstring)

virtual void	clear_globals ()

virtual ControlFlowVisitor *	controlFlowVisitor ()

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 Visitor &	flow_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 Context *	getChildContext () const

int	getChildrenVisited () const

const Context *	getContext () const

int	getContextDepth () const

const IR::Node *	getCurrentNode () const

template<class T >
const T *	getCurrentNode () const

const IR::Node *	getOriginal () const

template<class T >
const T *	getOriginal () const

template<class T >
const T *	getParent () const

virtual bool	has_flow_joins () const

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 Visitor &	setCalledBy (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

Public Member Functions inherited from P4::Backtrack

Static Public Member Functions
static cstring	getNewLogFileName (const cstring &prefix)

Static Public Member Functions inherited from P4::Visitor
static cstring	demangle (const char *)

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

Protected Member Functions
void	end_apply () override

profile_t	init_apply (const IR::Node *root) override

Protected Member Functions inherited from P4::PassManager
profile_t	init_apply (const IR::Node *root) override

void	runDebugHooks (const char visitorName, const IR::Node node)

Protected Member Functions inherited from P4::Visitor
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
Logging::FileLog *	_logFile

cstring	_logFilePrefix

Logging::Mode	_logMode

Protected Attributes inherited from P4::PassManager
safe_vector< DebugHook >	debugHooks

safe_vector< Visitor * >	passes

bool	running = false

unsigned	seqNo = 0

bool	stop_on_error = true

Protected Attributes inherited from P4::Visitor
bool	dontForwardChildrenBeforePreorder = false

bool	joinFlows = false

bool	visitDagOnce = true

Static Protected Attributes
static int	invocationCount = -1

Additional Inherited Members
Public Types inherited from P4::Visitor
typedef Visitor_Context	Context

Public Attributes inherited from P4::Visitor
const Visitor *	called_by = nullptr

cstring	internalName

SplitFlowVisit_base *&	split_link

SplitFlowVisit_base *	split_link_mem = nullptr

Detailed Description

A Logging::PassManager is a wrapper around the base pass manager that adds logging capabilities to a file. It's a common enough pattern that we chose to encapsulate it into a class. Logging is done using a FileLog object, which essentially redirects clog to the opened file. The Logging::PassManager manages the logging file, opening it in init_apply and closing it in end_apply.

Member Function Documentation

◆ end_apply()

void Logging::PassManager::end_apply ( )

inlineoverrideprotectedvirtual

Reimplemented from P4::Visitor.

Member Data Documentation

◆ invocationCount

int PassManager::invocationCount = -1

staticprotected

Used to index logfiles based on how many times this class was instantiated and invoked on pipe nodes (when logMode is CREATE)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

SPDX-License-Identifier: Apache-2.0

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ end_apply()

Member Data Documentation

◆ invocationCount