PassInstrumentNode forms an instrument implementation. It provides API for users to register callbacks at different instrumentation points. More...

#include <instrument.h>

Inheritance diagram for tvm::instrument::PassInstrumentNode:

Collaboration diagram for tvm::instrument::PassInstrumentNode:

Public Member Functions
virtual	~PassInstrumentNode ()

virtual void	EnterPassContext () const =0
	Instrument when entering PassContext. Called once within a PassContext. More...

virtual void	ExitPassContext () const =0
	Instrument when exiting PassContext. Called once within a PassContext. More...

virtual bool	ShouldRun (const IRModule &mod, const transform::PassInfo &info) const =0
	Determine whether to run the pass or not. Called multiple times depend on number of passes. More...

virtual void	RunBeforePass (const IRModule &mod, const transform::PassInfo &info) const =0
	Instrument before pass run. Called multiple times depend on number of passes. More...

virtual void	RunAfterPass (const IRModule &mod, const transform::PassInfo &info) const =0
	Instrument after pass run. Called multiple time depend on number of passes. More...

void	VisitAttrs (AttrVisitor *v)

	TVM_DECLARE_BASE_OBJECT_INFO (PassInstrumentNode, Object)

Public Member Functions inherited from tvm::runtime::Object
uint32_t	type_index () const

std::string	GetTypeKey () const

size_t	GetTypeKeyHash () const

template<typename TargetType >
bool	IsInstance () const

bool	unique () const

	Object ()

	Object (const Object &other)

	Object (Object &&other)

Object &	operator= (const Object &other)

Object &	operator= (Object &&other)

Public Attributes
String	name
	Name of this pass instrument object. More...

Static Public Attributes
static constexpr const char *	_type_key = "instrument.PassInstrument"

Static Public Attributes inherited from tvm::runtime::Object
static constexpr const char *	_type_key = "runtime.Object"

static constexpr bool	_type_final = false

static constexpr uint32_t	_type_child_slots = 0

static constexpr bool	_type_child_slots_can_overflow = true

static constexpr bool	_type_has_method_visit_attrs = true

static constexpr bool	_type_has_method_sequal_reduce = false

static constexpr bool	_type_has_method_shash_reduce = false

static constexpr uint32_t	_type_index = TypeIndex::kDynamic

Additional Inherited Members
Public Types inherited from tvm::runtime::Object
typedef void(*	FDeleter) (Object *self)
	Object deleter. More...

using	RefCounterType = std::atomic< int32_t >

Static Public Member Functions inherited from tvm::runtime::Object
static std::string	TypeIndex2Key (uint32_t tindex)
	Get the type key of the corresponding index from runtime. More...

static size_t	TypeIndex2KeyHash (uint32_t tindex)
	Get the type key hash of the corresponding index from runtime. More...

static uint32_t	TypeKey2Index (const std::string &key)
	Get the type index of the corresponding key from runtime. More...

static uint32_t	_GetOrAllocRuntimeTypeIndex ()

static uint32_t	RuntimeTypeIndex ()

Protected Member Functions inherited from tvm::runtime::Object
void	IncRef ()
	developer function, increases reference counter. More...

void	DecRef ()
	developer function, decrease reference counter. More...

Static Protected Member Functions inherited from tvm::runtime::Object
static uint32_t	GetOrAllocRuntimeTypeIndex (const std::string &key, uint32_t static_tindex, uint32_t parent_tindex, uint32_t type_child_slots, bool type_child_slots_can_overflow)
	Get the type index using type key. More...

Protected Attributes inherited from tvm::runtime::Object
uint32_t	type_index_ {0}
	Type index(tag) that indicates the type of the object. More...

RefCounterType	ref_counter_ {0}
	The internal reference counter. More...

FDeleter	deleter_ = nullptr
	deleter of this object to enable customized allocation. If the deleter is nullptr, no deletion will be performed. The creator of the object must always set the deleter field properly. More...

Detailed Description

PassInstrumentNode forms an instrument implementation. It provides API for users to register callbacks at different instrumentation points.

Within a PassContext, call sequence of a PassInstrument implementation is like:

with PassContext(instruments=[pi]): # pi = a PassInstrument implementation pi.EnterPassContext()

if pi.ShouldRun(Pass1): pi.RunBeforePass() Pass1() pi.RunAfterPass()

if pi.ShouldRun(Pass2): pi.RunBeforePass() Pass2() pi.RunAfterPass()

pi.ExitPassContext()

EnterPassContext and ExitPassContext are only called once when entering/exiting a PassContext. ShouldRun, RunBeforePass and RunAfterPass are called multiple times depending on how many passes.

If there are multiple pass instrumentations provided, the instrument points are the same. PassInstrument implementations' callbacks are called in order:

with PassContext(instruments=[pi1, pi2]): # pi1, pi2 = two distinct PassInstrument impls pi.EnterPassContext() for pi in instruments

should_run = all([pi.ShoudRun(Pass1) for pi in instruments)]) if (should_run) pi.RunBeforePass() for pi in instruments Pass1() pi.RunAfterPass() for pi in instruments

should_run = all([pi.ShouldRun(Pass2) for pi in instruments)]) if (should_run) pi.RunBeforePass() for pi in instruments Pass2() pi.RunAfterPass() for pi in instruments

pi.ExitPassContext() for pi in instruments

Note:

Assume there is no dependency between PassInstrument implementations in instruments .
EnterPassContext and ExitPassContext have with behavior (see PassContext and its FFI): If there is any exception raised in ShouldRun(), RunBeforePass(), RunAfterPass() and Pass(), ExitPassContext() is still called.
In mutiple PassInstrument instances scenario, callbacks are called in order: If one throws exceptions, remainings will not be called.

See also: PassInstrument; src/ir/transform.cc

Constructor & Destructor Documentation

◆ ~PassInstrumentNode()

virtual tvm::instrument::PassInstrumentNode::~PassInstrumentNode ( )

inlinevirtual

Member Function Documentation

◆ EnterPassContext()

virtual void tvm::instrument::PassInstrumentNode::EnterPassContext ( ) const

pure virtual

Instrument when entering PassContext. Called once within a PassContext.

◆ ExitPassContext()

virtual void tvm::instrument::PassInstrumentNode::ExitPassContext ( ) const

pure virtual

Instrument when exiting PassContext. Called once within a PassContext.

◆ RunAfterPass()

virtual void tvm::instrument::PassInstrumentNode::RunAfterPass	(	const IRModule &	mod,
		const transform::PassInfo &	info
	)		const

pure virtual

Instrument after pass run. Called multiple time depend on number of passes.

Parameters

mod	The module that an optimization pass runs on.
info	The pass information.

◆ RunBeforePass()

virtual void tvm::instrument::PassInstrumentNode::RunBeforePass	(	const IRModule &	mod,
		const transform::PassInfo &	info
	)		const

pure virtual

Instrument before pass run. Called multiple times depend on number of passes.

Parameters

mod	The module that an optimization pass runs on.
info	The pass information.

◆ ShouldRun()

virtual bool tvm::instrument::PassInstrumentNode::ShouldRun	(	const IRModule &	mod,
		const transform::PassInfo &	info
	)		const

pure virtual

Determine whether to run the pass or not. Called multiple times depend on number of passes.

Parameters

mod	The module that an optimization pass runs on.
info	The pass information.

Returns: true to run the pass; false to skip the pass.

◆ TVM_DECLARE_BASE_OBJECT_INFO()

tvm::instrument::PassInstrumentNode::TVM_DECLARE_BASE_OBJECT_INFO	(	PassInstrumentNode	,
		Object
	)

◆ VisitAttrs()

void tvm::instrument::PassInstrumentNode::VisitAttrs ( AttrVisitor * v )

inline

Member Data Documentation

◆ _type_key

constexpr const char* tvm::instrument::PassInstrumentNode::_type_key = "instrument.PassInstrument"

staticconstexpr

◆ name

String tvm::instrument::PassInstrumentNode::name

Name of this pass instrument object.

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

include/tvm/ir/instrument.h

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PassInstrumentNode()

Member Function Documentation

◆ EnterPassContext()

◆ ExitPassContext()

◆ RunAfterPass()

◆ RunBeforePass()

◆ ShouldRun()

◆ TVM_DECLARE_BASE_OBJECT_INFO()

◆ VisitAttrs()

Member Data Documentation

◆ _type_key

◆ name