tvm::instrument::PassInstrumentNode Class Reference

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...
	TVM_DECLARE_BASE_OBJECT_INFO (PassInstrumentNode, Object)

Static Public Member Functions
static void	RegisterReflection ()

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

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

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:

1. Assume there is no dependency between PassInstrument implementations in instruments .
2. 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.
3. 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.

RegisterReflection()

static void tvm::instrument::PassInstrumentNode::RegisterReflection ( )

inlinestatic

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
	)

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