tvm::IRModuleNode Class Reference

IRModule that holds functions and type definitions. More...

#include <module.h>

Inheritance diagram for tvm::IRModuleNode:

Collaboration diagram for tvm::IRModuleNode:

Public Member Functions
template<typename TObjectRef >
ffi::Optional< TObjectRef >	GetAttr (const std::string &attr_key, ffi::Optional< TObjectRef > default_value=ffi::Optional< TObjectRef >(std::nullopt)) const
	Get a module attribute. More...
template<typename TObjectRef >
ffi::Optional< TObjectRef >	GetAttr (const std::string &attr_key, TObjectRef default_value) const
DictAttrs	GetAttrs () const
	Get the metadata attributes. More...
bool	HasNonzeroAttr (const std::string &attr_key) const
	Check whether the module has an non-zero integer attr. More...
	IRModuleNode ()
bool	SEqual (const IRModuleNode *other, ffi::TypedFunction< bool(AnyView, AnyView, bool, AnyView)> equal) const
uint64_t	SHash (uint64_t init_hash, ffi::TypedFunction< uint64_t(AnyView, uint64_t, bool)> hash) const
void	Add (const GlobalVar &var, const BaseFunc &func, bool update=false)
	Add a function to the global environment. More...
void	AddUnchecked (const GlobalVar &var, const BaseFunc &func)
	Add a function to the global environment. More...
void	Update (const GlobalVar &var, const BaseFunc &func)
	Update a function in the global environment. More...
void	UpdateGlobalInfo (const ffi::String &name, const ffi::Array< GlobalInfo > &info)
	Update an array of global infos in the global environment. More...
void	Remove (const GlobalVar &var)
	Remove a function from the global environment. More...
bool	ContainGlobalVar (const ffi::String &name) const
	Check if the global_var_map_ contains a global variable. More...
GlobalVar	GetGlobalVar (const ffi::String &str) const
	Lookup a global function by its variable. More...
ffi::Array< GlobalVar >	GetGlobalVars () const
	Collect all global vars defined in this module, ordered by the global variable name. More...
BaseFunc	Lookup (const GlobalVar &var) const
	Look up a global function by its variable. More...
BaseFunc	Lookup (const ffi::String &name) const
	Look up a global function by its string name. More...
void	Update (const IRModule &other)
	Update the functions inside this environment by functions in another environment. More...
IRModule	ShallowCopy ()
	Create a shallow copy of this IRModule. More...
std::unordered_set< ffi::String >	Imports () const
	The set of imported files. More...
	TVM_OBJECT_ENABLE_SCRIPT_PRINTER ()
	TVM_FFI_DECLARE_OBJECT_INFO_FINAL ("ir.IRModule", IRModuleNode, Object)

Static Public Member Functions
static void	RegisterReflection ()

Public Attributes
ffi::Map< GlobalVar, BaseFunc >	functions
	A map from ids to all global functions. More...
SourceMap	source_map
	The source map for the module. More...
DictAttrs	attrs
ffi::Map< ffi::String, ffi::Array< GlobalInfo > >	global_infos
	Globally static object that are referred by the IR itself. More...
ffi::Map< ffi::String, GlobalVar >	global_var_map_
	A map from string names to global variables that ensures global uniqueness. More...

Static Public Attributes
static constexpr TVMFFISEqHashKind	_type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode

Friends
class	IRModule
	The IRModule declaration statement. More...

Detailed Description

IRModule that holds functions and type definitions.

IRModule is the basic unit for all IR transformations across the stack.

Many operations require access to the global IRModule. We pass the IRModule by value in a functional style as an explicit argument, but we mutate the Module while optimizing programs.

See also

IRModule

Constructor & Destructor Documentation

IRModuleNode()

tvm::IRModuleNode::IRModuleNode ( )

inline

Member Function Documentation

Add()

void tvm::IRModuleNode::Add	(	const GlobalVar &	var,
		const BaseFunc &	func,
		bool	update = false
	)

Add a function to the global environment.

Parameters

var	The var of the global function.
func	The function.
update	Controls whether you can replace a definition in the environment.

AddUnchecked()

void tvm::IRModuleNode::AddUnchecked	(	const GlobalVar &	var,
		const BaseFunc &	func
	)

Add a function to the global environment.

Parameters

var	The name of the global function.
func	The function.

It does not do type inference as Add does.

ContainGlobalVar()

bool tvm::IRModuleNode::ContainGlobalVar

(

const ffi::String &

name

)

const

Check if the global_var_map_ contains a global variable.

Parameters

name	The variable name.

Returns

true if contains, otherise false.

GetAttr() [1/2]

template<typename TObjectRef >

ffi::Optional<TObjectRef> tvm::IRModuleNode::GetAttr ( const std::string &  attr_key, ffi::Optional< TObjectRef >  default_value = ffi::Optional<TObjectRef>(std::nullopt)  ) const

inline

Get a module attribute.

Parameters

attr_key	The attribute key.
default_value	The default value if the key does not exist, defaults to nullptr.

Returns

The result

Template Parameters

TObjectRef

the expected object type.

Exceptions

Error

if the key exists but the value does not match TObjectRef

void GetAttrExample(const IRModule& mod) {
  auto value = f->GetAttr<Integer>("AttrKey", 0);
}

GetAttr() [2/2]

template<typename TObjectRef >

ffi::Optional<TObjectRef> tvm::IRModuleNode::GetAttr ( const std::string &  attr_key, TObjectRef  default_value  ) const

inline

GetAttrs()

DictAttrs tvm::IRModuleNode::GetAttrs ( ) const

inline

Get the metadata attributes.

Returns

The additional meta-data attributes

GetGlobalVar()

GlobalVar tvm::IRModuleNode::GetGlobalVar

(

const ffi::String &

str

)

const

Lookup a global function by its variable.

Parameters

str	The unique string specifying the global variable.

Returns

The global variable.

GetGlobalVars()

ffi::Array<GlobalVar> tvm::IRModuleNode::GetGlobalVars

(

)

const

Collect all global vars defined in this module, ordered by the global variable name.

Returns

An array of global vars

HasNonzeroAttr()

bool tvm::IRModuleNode::HasNonzeroAttr ( const std::string &  attr_key ) const

inline

Check whether the module has an non-zero integer attr.

This function can be used to check whether an optional attribute mark(e.g. inline) exists.

Parameters

attr_key

The key to the attribute.

Returns

The check result.

void HasNonzeroAttrExample(const IRModule& mod) {
  if (mod->HasNonzeroAttr(attr::kInline)) {
    // inline the function.
  }
}

Imports()

std::unordered_set<ffi::String> tvm::IRModuleNode::Imports

(

)

const

The set of imported files.

Lookup() [1/2]

BaseFunc tvm::IRModuleNode::Lookup

(

const ffi::String &

name

)

const

Look up a global function by its string name.

Parameters

name	The name of the function.

Returns

The function named by the argument.

Lookup() [2/2]

BaseFunc tvm::IRModuleNode::Lookup

(

const GlobalVar &

var

)

const

Look up a global function by its variable.

Parameters

var	The global var to lookup.

Returns

The function named by the variable argument.

RegisterReflection()

static void tvm::IRModuleNode::RegisterReflection ( )

inlinestatic

Remove()

void tvm::IRModuleNode::Remove

(

const GlobalVar &

var

)

Remove a function from the global environment.

Parameters

var	The name of the global function to update.

SEqual()

bool tvm::IRModuleNode::SEqual	(	const IRModuleNode *	other,
		ffi::TypedFunction< bool(AnyView, AnyView, bool, AnyView)>	equal
	)		const

ShallowCopy()

IRModule tvm::IRModuleNode::ShallowCopy

(

)

Create a shallow copy of this IRModule.

Returns

The shallow copy of the IRModule.

SHash()

uint64_t tvm::IRModuleNode::SHash	(	uint64_t	init_hash,
		ffi::TypedFunction< uint64_t(AnyView, uint64_t, bool)>	hash
	)		const

TVM_FFI_DECLARE_OBJECT_INFO_FINAL()

tvm::IRModuleNode::TVM_FFI_DECLARE_OBJECT_INFO_FINAL	(	"ir.IRModule"	,
		IRModuleNode	,
		Object
	)

TVM_OBJECT_ENABLE_SCRIPT_PRINTER()

tvm::IRModuleNode::TVM_OBJECT_ENABLE_SCRIPT_PRINTER

(

)

Update() [1/2]

void tvm::IRModuleNode::Update	(	const GlobalVar &	var,
		const BaseFunc &	func
	)

Update a function in the global environment.

Parameters

var	The name of the global function to update.
func	The new function.

Update() [2/2]

void tvm::IRModuleNode::Update

(

const IRModule &

other

)

Update the functions inside this environment by functions in another environment.

Parameters

other

The other environment.

UpdateGlobalInfo()

void tvm::IRModuleNode::UpdateGlobalInfo	(	const ffi::String &	name,
		const ffi::Array< GlobalInfo > &	info
	)

Update an array of global infos in the global environment.

Parameters

name	The name of the global info.
info	The new array of global infos.

Friends And Related Function Documentation

IRModule

friend class IRModule

friend

The IRModule declaration statement.

Returns

The IRModuleFrame.

Member Data Documentation

_type_s_eq_hash_kind

constexpr TVMFFISEqHashKind tvm::IRModuleNode::_type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode

staticconstexpr

attrs

DictAttrs tvm::IRModuleNode::attrs

functions

ffi::Map<GlobalVar, BaseFunc> tvm::IRModuleNode::functions

A map from ids to all global functions.

global_infos

ffi::Map<ffi::String, ffi::Array<GlobalInfo> > tvm::IRModuleNode::global_infos

Globally static object that are referred by the IR itself.

global_var_map_

ffi::Map<ffi::String, GlobalVar> tvm::IRModuleNode::global_var_map_

A map from string names to global variables that ensures global uniqueness.

source_map

SourceMap tvm::IRModuleNode::source_map

The source map for the module.

---

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

• include/tvm/ir/module.h