org.bytedeco.tvm

Class ModuleNode

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tvm.TVMObject

org.bytedeco.tvm.ModuleNode

All Implemented Interfaces:

AutoCloseable

@Namespace(value="tvm::runtime")
 @NoOffset
 @Properties(inherit=tvm_runtime.class)
public class ModuleNode
extends TVMObject

\brief Base container of module. Please subclass ModuleNode to create a specific runtime module.

  class MyModuleNode : public ModuleNode {
   public:
    // implement the interface
  };

  // use make_object to create a specific
  // instace of MyModuleNode.
  Module CreateMyModule() {
    ObjectPtr<MyModuleNode> n =
      tvm::runtime::make_object<MyModuleNode>();
    return Module(n);
  }

 

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.tvm.TVMObject

TVMObject.FDeleter

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static int	_type_child_slots
static boolean	_type_final
static int	_type_index

Fields inherited from class org.bytedeco.tvm.TVMObject

_type_child_slots_can_overflow, _type_has_method_sequal_reduce, _type_has_method_shash_reduce, _type_has_method_visit_attrs

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ModuleNode(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static int	_GetOrAllocRuntimeTypeIndex()
static int	_type_child_slots()
static boolean	_type_final()
static int	_type_index()
static BytePointer	_type_key()
BytePointer	GetFormat() \brief Get the format of the module, when available.
PackedFunc	GetFuncFromEnv(BytePointer name) \brief Get a function from current environment The environment includes all the imports as well as Global functions.
PackedFunc	GetFuncFromEnv(String name)
PackedFunc	GetFunction(BytePointer name)
PackedFunc	GetFunction(BytePointer name, boolean query_imports) \brief Get packed function from current module by name.
PackedFunc	GetFunction(BytePointer name, ObjectPtr sptr_to_self) \brief Get a PackedFunc from module.
PackedFunc	GetFunction(String name)
PackedFunc	GetFunction(String name, boolean query_imports)
PackedFunc	GetFunction(String name, ObjectPtr sptr_to_self)
BytePointer	GetSource()
BytePointer	GetSource(BytePointer format) \brief Get the source code of module, when available.
String	GetSource(String format)
boolean	ImplementsFunction(TVMString name)
boolean	ImplementsFunction(TVMString name, boolean query_imports) \brief Returns true if this module has a definition for a function of \p name.
void	Import(Module other) \brief Import another module into this module.
Module	imports()
boolean	IsDSOExportable() \brief Returns true if this module is 'DSO exportable'.
static int	RuntimeTypeIndex()
void	SaveToBinary(Stream stream) \brief Save the module to binary stream.
void	SaveToFile(BytePointer file_name, BytePointer format) \brief Save the module to file.
void	SaveToFile(String file_name, String format)
BytePointer	type_key()

Methods inherited from class org.bytedeco.tvm.TVMObject

_type_child_slots_can_overflow, _type_has_method_sequal_reduce, _type_has_method_shash_reduce, _type_has_method_visit_attrs, getPointer, GetTypeKey, GetTypeKeyHash, position, put, type_index, TypeIndex2Key, TypeIndex2KeyHash, TypeKey2Index, TypeKey2Index, unique

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_type_index

public static final int _type_index

_type_final

public static final boolean _type_final

_type_child_slots

public static final int _type_child_slots

Constructor Detail

ModuleNode

public ModuleNode(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

type_key

@Cast(value="const char*")
public BytePointer type_key()

Returns:

The per module type key. \note This key is used to for serializing custom modules.

GetFunction

@ByVal
public PackedFunc GetFunction(@StdString
                                      BytePointer name,
                                      @Const @ByRef
                                      ObjectPtr sptr_to_self)

\brief Get a PackedFunc from module. The PackedFunc may not be fully initialized, there might still be first time running overhead when executing the function on certain devices. For benchmarking, use prepare to eliminate

Parameters:

name - the name of the function.

sptr_to_self - The ObjectPtr that points to this module node.

Returns:

PackedFunc(nullptr) when it is not available. \note The function will always remain valid. If the function need resource from the module(e.g. late linking), it should capture sptr_to_self.

GetFunction

@ByVal
public PackedFunc GetFunction(@StdString
                                      String name,
                                      @Const @ByRef
                                      ObjectPtr sptr_to_self)

SaveToFile

public void SaveToFile(@StdString
                       BytePointer file_name,
                       @StdString
                       BytePointer format)

\brief Save the module to file.

Parameters:

file_name - The file to be saved to.

format - The format of the file.

SaveToFile

public void SaveToFile(@StdString
                       String file_name,
                       @StdString
                       String format)

SaveToBinary

public void SaveToBinary(Stream stream)

\brief Save the module to binary stream.

Parameters:

stream - The binary stream to save to. \note It is recommended to implement this for device modules, but not necessarily host modules. We can use this to do AOT loading of bundled device functions.

GetSource

@StdString
public BytePointer GetSource(@StdString
                                         BytePointer format)

\brief Get the source code of module, when available.

Parameters:

format - Format of the source code, can be empty by default.

Returns:

Possible source code when available.

GetSource

@StdString
public BytePointer GetSource()

GetSource

@StdString
public String GetSource(@StdString
                                    String format)

GetFormat

@StdString
public BytePointer GetFormat()

\brief Get the format of the module, when available.

Returns:

Possible format when available.

GetFunction

@ByVal
public PackedFunc GetFunction(@StdString
                                      BytePointer name,
                                      @Cast(value="bool")
                                      boolean query_imports)

\brief Get packed function from current module by name.

Parameters:

name - The name of the function.

query_imports - Whether also query dependency modules.

Returns:

The result function. This function will return PackedFunc(nullptr) if function do not exist. \note Implemented in packed_func.cc

GetFunction

@ByVal
public PackedFunc GetFunction(@StdString
                                      BytePointer name)

GetFunction

@ByVal
public PackedFunc GetFunction(@StdString
                                      String name,
                                      @Cast(value="bool")
                                      boolean query_imports)

GetFunction

@ByVal
public PackedFunc GetFunction(@StdString
                                      String name)

Import

public void Import(@ByVal
                   Module other)

\brief Import another module into this module.

Parameters:

other - The module to be imported. \note Cyclic dependency is not allowed among modules, An error will be thrown when cyclic dependency is detected.

GetFuncFromEnv

@Const
public PackedFunc GetFuncFromEnv(@StdString
                                         BytePointer name)

\brief Get a function from current environment The environment includes all the imports as well as Global functions.

Parameters:

name - name of the function.

Returns:

The corresponding function.

GetFuncFromEnv

@Const
public PackedFunc GetFuncFromEnv(@StdString
                                         String name)

imports

@StdVector
public Module imports()

Returns:

The module it imports from

IsDSOExportable

@Cast(value="bool")
public boolean IsDSOExportable()

\brief Returns true if this module is 'DSO exportable'. A DSO exportable module (eg a CSourceModuleNode of type_key 'c') can be incorporated into the final runtime artifact (ie shared library) by compilation and/or linking using the external compiler (llvm, nvcc, etc). DSO exportable modules must implement SaveToFile. By contrast, non-DSO exportable modules (eg CUDAModuleNode of type_key 'cuda') typically must be incorporated into the final runtime artifact by being serialized as data into the artifact, then deserialized at runtime. Non-DSO exportable modules must implement SaveToBinary, and have a matching deserializer registered as 'runtime.module.loadbinary_'. The default implementation returns false.

ImplementsFunction

@Cast(value="bool")
public boolean ImplementsFunction(@Const @ByRef
                                                       TVMString name,
                                                       @Cast(value="bool")
                                                       boolean query_imports)

\brief Returns true if this module has a definition for a function of \p name. If \p query_imports is true, also search in any imported modules. Note that even if this function returns true the corresponding \p GetFunction result may be nullptr if the function is not yet callable without further compilation. The default implementation just checkis if \p GetFunction is non-null.

ImplementsFunction

@Cast(value="bool")
public boolean ImplementsFunction(@Const @ByRef
                                                       TVMString name)

_type_index

@MemberGetter
 @Cast(value="const uint32_t")
public static int _type_index()

_type_key

@MemberGetter
 @Cast(value="const char*")
public static BytePointer _type_key()

_type_final

@MemberGetter
 @Cast(value="const bool")
public static boolean _type_final()

_type_child_slots

@MemberGetter
public static int _type_child_slots()

RuntimeTypeIndex

@Cast(value="uint32_t")
public static int RuntimeTypeIndex()

_GetOrAllocRuntimeTypeIndex

@Cast(value="uint32_t")
public static int _GetOrAllocRuntimeTypeIndex()