#include <dlpack/dlpack.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

Include dependency graph for c_runtime_api.h:

This graph shows which files directly or indirectly include this file:

Classes
union	TVMValue
	Union type of values being passed through API and function calls. More...

struct	TVMByteArray
	Byte array type used to pass in byte array When kTVMBytes is used as data type. More...

Macros
#define	TVM_WEAK __attribute__((weak))

#define	TVM_ATTRIBUTE_UNUSED

#define	TVM_VERSION "0.19.dev0"

Typedefs
typedef int64_t	tvm_index_t
	type of array index. More...

typedef DLTensor *	TVMArrayHandle
	the array handle More...

typedef void *	TVMModuleHandle
	Handle to TVM runtime modules. More...

typedef void *	TVMFunctionHandle
	Handle to packed function handle. More...

typedef void *	TVMRetValueHandle
	Handle to hold return value. More...

typedef void *	TVMStreamHandle
	The stream that is specific to device can be NULL, which indicates the default one. More...

typedef void *	TVMObjectHandle
	Handle to Object. More...

typedef int(*	TVMPackedCFunc) (TVMValue args, int type_codes, int num_args, TVMRetValueHandle ret, void *resource_handle)
	C type of packed function. More...

typedef void(*	TVMPackedCFuncFinalizer) (void *resource_handle)
	C callback to free the resource handle in C packed function. More...

typedef int(*	TVMExtensionFuncDeclarer) (TVMFunctionHandle register_func_handle)
	Signature for extension function declarer. More...

Enumerations
enum	TVMDeviceExtType { kDLAOCL = 32 , kDLSDAccel , kOpenGL , kDLMicroDev , TVMDeviceExtType_End }
	Extension device types in TVM. More...

enum	TVMArgTypeCode { kTVMArgInt = kDLInt , kTVMArgFloat = kDLFloat , kTVMOpaqueHandle = 3U , kTVMNullptr = 4U , kTVMDataType = 5U , kDLDevice = 6U , kTVMDLTensorHandle = 7U , kTVMObjectHandle = 8U , kTVMModuleHandle = 9U , kTVMPackedFuncHandle = 10U , kTVMStr = 11U , kTVMBytes = 12U , kTVMNDArrayHandle = 13U , kTVMObjectRValueRefArg = 14U , kTVMArgBool = 15U , kTVMExtBegin = 16U , kTVMNNVMFirst = 16U , kTVMNNVMLast = 20U , kTVMExtReserveEnd = 64U , kTVMExtEnd = 128U }
	The type code in used and only used in TVM FFI for argument passing. More...

Functions
void	TVMAPISetLastError (const char *msg)
	Used for implementing C API function. Set last error message before return. More...

void	TVMAPISetLastPythonError (void *py_object)
	Used for implementing C API function. Set last exception before return. More...

void *	TVMGetLastPythonError ()
	Return the previous python error, if any. More...

const char *	TVMGetLastError (void)
	return str message of the last error all function in this file will return 0 when success and nonzero when an error occurred, TVMGetLastError can be called to retrieve the error More...

const char *	TVMGetLastBacktrace ()
	Return the backtrace of the most recent error. More...

void	TVMDropLastPythonError ()
	Remove the propagated python error, if any. More...

void	TVMThrowLastError ()
	Re-throw the most recent error. More...

int	TVMModLoadFromFile (const char file_name, const char format, TVMModuleHandle *out)
	Load module from file. More...

int	TVMModImport (TVMModuleHandle mod, TVMModuleHandle dep)
	Add dep to mod's dependency. This allows functions in this module to use modules. More...

int	TVMModGetFunction (TVMModuleHandle mod, const char func_name, int query_imports, TVMFunctionHandle out)
	Get function from the module. More...

int	TVMModFree (TVMModuleHandle mod)
	Free the Module. More...

int	TVMFuncFree (TVMFunctionHandle func)
	Free the function when it is no longer needed. More...

int	TVMFuncCall (TVMFunctionHandle func, TVMValue arg_values, int type_codes, int num_args, TVMValue ret_val, int ret_type_code)
	Call a Packed TVM Function. More...

int	TVMCFuncSetReturn (TVMRetValueHandle ret, TVMValue value, int type_code, int num_ret)
	Set the return value of TVMPackedCFunc. More...

int	TVMCbArgToReturn (TVMValue value, int code)
	Inplace translate callback argument value to return value. This is only needed for non-POD arguments. More...

int	TVMFuncCreateFromCFunc (TVMPackedCFunc func, void resource_handle, TVMPackedCFuncFinalizer fin, TVMFunctionHandle out)
	Wrap a TVMPackedCFunc to become a FunctionHandle. More...

int	TVMFuncRegisterGlobal (const char *name, TVMFunctionHandle f, int override)
	Register the function to runtime's global table. More...

int	TVMFuncGetGlobal (const char name, TVMFunctionHandle out)
	Get a global function. More...

int	TVMFuncListGlobalNames (int out_size, const char **out_array)
	List all the globally registered function name. More...

int	TVMFuncRemoveGlobal (const char *name)
	Remove a global function. More...

int	TVMArrayAlloc (const tvm_index_t shape, int ndim, int dtype_code, int dtype_bits, int dtype_lanes, int device_type, int device_id, TVMArrayHandle out)
	Allocate a nd-array's memory, including space of shape, of given spec. More...

int	TVMArrayFree (TVMArrayHandle handle)
	Free the TVM Array. More...

int	TVMArrayCopyFromBytes (TVMArrayHandle handle, void *data, size_t nbytes)
	Copy array data from CPU byte array. More...

int	TVMArrayCopyToBytes (TVMArrayHandle handle, void *data, size_t nbytes)
	Copy array data to CPU byte array. More...

int	TVMArrayCopyFromTo (TVMArrayHandle from, TVMArrayHandle to, TVMStreamHandle stream)
	Copy the array, both from and to must be valid during the copy. More...

int	TVMArrayFromDLPack (DLManagedTensor from, TVMArrayHandle out)
	Produce an array from the DLManagedTensor that shares data memory with the DLManagedTensor. More...

int	TVMArrayToDLPack (TVMArrayHandle from, DLManagedTensor **out)
	Produce a DLMangedTensor from the array that shares data memory with the array. More...

void	TVMDLManagedTensorCallDeleter (DLManagedTensor *dltensor)
	Delete (free) a DLManagedTensor's data. More...

int	TVMStreamCreate (int device_type, int device_id, TVMStreamHandle *out)
	Create a new runtime stream. More...

int	TVMStreamFree (int device_type, int device_id, TVMStreamHandle stream)
	Free a created stream handle. More...

int	TVMSetStream (int device_type, int device_id, TVMStreamHandle handle)
	Set the runtime stream of current thread to be stream. The subsequent calls to the same device_type will use the setted stream handle. The specific type of stream is runtime device dependent. More...

int	TVMSynchronize (int device_type, int device_id, TVMStreamHandle stream)
	Wait until all computations on stream completes. More...

int	TVMStreamStreamSynchronize (int device_type, int device_id, TVMStreamHandle src, TVMStreamHandle dst)
	Synchronize two streams of execution. More...

int	TVMObjectGetTypeIndex (TVMObjectHandle obj, unsigned *out_tindex)
	Get the type_index from an object. More...

int	TVMObjectTypeKey2Index (const char type_key, unsigned out_tindex)
	Convert type key to type index. More...

int	TVMObjectTypeIndex2Key (unsigned tindex, char **out_type_key)
	Convert type index to type key. More...

int	TVMObjectRetain (TVMObjectHandle obj)
	Increase the reference count of an object. More...

int	TVMObjectFree (TVMObjectHandle obj)
	Free the object. More...

int	TVMByteArrayFree (TVMByteArray *arr)
	Free a TVMByteArray returned from TVMFuncCall, and associated memory. More...

int	TVMDeviceAllocDataSpace (DLDevice dev, size_t nbytes, size_t alignment, DLDataType type_hint, void **out_data)
	Allocate a data space on device. More...

int	TVMDeviceAllocDataSpaceWithScope (DLDevice dev, int ndim, const int64_t shape, DLDataType dtype, const char mem_scope, void **out_data)
	Allocate a data space on device with special memory scope. More...

int	TVMDeviceFreeDataSpace (DLDevice dev, void *ptr)
	Free a data space on device. More...

int	TVMDeviceCopyDataFromTo (DLTensor from, DLTensor to, TVMStreamHandle stream)
	Copy data from one place to another. More...

int	TVMObjectDerivedFrom (uint32_t child_type_index, uint32_t parent_type_index, int *is_derived)
	Check that an object is derived from another. More...

Macro Definition Documentation

◆ TVM_ATTRIBUTE_UNUSED

#define TVM_ATTRIBUTE_UNUSED

◆ TVM_VERSION

#define TVM_VERSION "0.19.dev0"

◆ TVM_WEAK

#define TVM_WEAK __attribute__((weak))

Typedef Documentation

◆ tvm_index_t

typedef int64_t tvm_index_t

type of array index.

◆ TVMArrayHandle

typedef DLTensor* TVMArrayHandle

the array handle

◆ TVMExtensionFuncDeclarer

typedef int(* TVMExtensionFuncDeclarer) (TVMFunctionHandle register_func_handle)

Signature for extension function declarer.

TVM call this function to get the extension functions The declarer will call register_func to register function and their name.

Parameters

register_func_handle The register function

Returns: 0 if success, -1 if failure happens

◆ TVMFunctionHandle

typedef void* TVMFunctionHandle

Handle to packed function handle.

◆ TVMModuleHandle

typedef void* TVMModuleHandle

Handle to TVM runtime modules.

◆ TVMObjectHandle

typedef void* TVMObjectHandle

Handle to Object.

◆ TVMPackedCFunc

typedef int(* TVMPackedCFunc) (TVMValue *args, int *type_codes, int num_args, TVMRetValueHandle ret, void *resource_handle)

C type of packed function.

Parameters

args	The arguments
type_codes	The type codes of the arguments
num_args	Number of arguments.
ret	The return value handle.
resource_handle	The handle additional resouce handle from front-end.

Returns: 0 if success, -1 if failure happens, set error via TVMAPISetLastError.

See also: TVMCFuncSetReturn

◆ TVMPackedCFuncFinalizer

typedef void(* TVMPackedCFuncFinalizer) (void *resource_handle)

C callback to free the resource handle in C packed function.

Parameters

resource_handle The handle additional resouce handle from front-end.

◆ TVMRetValueHandle

typedef void* TVMRetValueHandle

Handle to hold return value.

◆ TVMStreamHandle

typedef void* TVMStreamHandle

The stream that is specific to device can be NULL, which indicates the default one.

Enumeration Type Documentation

◆ TVMArgTypeCode

enum TVMArgTypeCode

The type code in used and only used in TVM FFI for argument passing.

DLPack consistency: 1) kTVMArgInt is compatible with kDLInt 2) kTVMArgFloat is compatible with kDLFloat 3) kDLUInt is not in ArgTypeCode, but has a spared slot

Downstream consistency: The kDLInt, kDLUInt, kDLFloat are kept consistent with the original ArgType code

It is only used in argument passing, and should not be confused with DataType::TypeCode, which is DLPack-compatible.

See also: tvm::runtime::DataType::TypeCode

Enumerator
kTVMArgInt
kTVMArgFloat
kTVMOpaqueHandle
kTVMNullptr
kTVMDataType
kDLDevice
kTVMDLTensorHandle
kTVMObjectHandle
kTVMModuleHandle
kTVMPackedFuncHandle
kTVMStr
kTVMBytes
kTVMNDArrayHandle
kTVMObjectRValueRefArg
kTVMArgBool
kTVMExtBegin
kTVMNNVMFirst
kTVMNNVMLast
kTVMExtReserveEnd
kTVMExtEnd

◆ TVMDeviceExtType

enum TVMDeviceExtType

Extension device types in TVM.

Additional enumerators to supplement those provided by DLPack's DLDeviceType enumeration.

MAINTAINERS NOTE #1: We need to ensure that the two devices are identified by the same integer. Currently this requires manual verification. Discussed here: https://github.com/dmlc/dlpack/issues/111 As of DLPack v0.7, the highest-valued enumerator in DLDeviceType is kDLHexagon = 16.

MAINTAINERS NOTE #2: As of DLPack v0.7, the definition for DLDeviceType specifies an underlying storage type of int32_t. That guarantees a variable of type DLDeviceType is capable of holding any integers provided by either of these enumerations.

However, the int32_t specification only applies when the header file is compiled as C++, and this header file is also meant to work as C code. So the unspecified storage type could be a latent bug when compiled as C.

Enumerator
kDLAOCL
kDLSDAccel
kOpenGL
kDLMicroDev
TVMDeviceExtType_End

Function Documentation

◆ TVMAPISetLastError()

void TVMAPISetLastError ( const char * msg )

Used for implementing C API function. Set last error message before return.

Parameters

msg	The error message to be set.

◆ TVMAPISetLastPythonError()

void TVMAPISetLastPythonError ( void * py_object )

Used for implementing C API function. Set last exception before return.

Parameters

py_object The python exception to be set

◆ TVMArrayAlloc()

int TVMArrayAlloc	(	const tvm_index_t *	shape,
		int	ndim,
		int	dtype_code,
		int	dtype_bits,
		int	dtype_lanes,
		int	device_type,
		int	device_id,
		TVMArrayHandle *	out
	)

Allocate a nd-array's memory, including space of shape, of given spec.

Parameters

shape	The shape of the array, the data content will be copied to out
ndim	The number of dimension of the array.
dtype_code	The type code of the dtype
dtype_bits	The number of bits of dtype
dtype_lanes	The number of lanes in the dtype.
device_type	The device type.
device_id	The device id.
out	The output handle.

Returns: 0 when success, nonzero when failure happens

◆ TVMArrayCopyFromBytes()

int TVMArrayCopyFromBytes	(	TVMArrayHandle	handle,
		void *	data,
		size_t	nbytes
	)

Copy array data from CPU byte array.

Parameters

handle	The array handle.
data	the data pointer
nbytes	The number of bytes to copy.

Returns: 0 when success, nonzero when failure happens

◆ TVMArrayCopyFromTo()

int TVMArrayCopyFromTo	(	TVMArrayHandle	from,
		TVMArrayHandle	to,
		TVMStreamHandle	stream
	)

Copy the array, both from and to must be valid during the copy.

Parameters

from	The array to be copied from.
to	The target space.
stream	The stream where the copy happens, can be NULL.

Returns: 0 when success, nonzero when failure happens

◆ TVMArrayCopyToBytes()

int TVMArrayCopyToBytes	(	TVMArrayHandle	handle,
		void *	data,
		size_t	nbytes
	)

Copy array data to CPU byte array.

Parameters

handle	The array handle.
data	the data pointer
nbytes	The number of bytes to copy.

Returns: 0 when success, nonzero when failure happens

◆ TVMArrayFree()

int TVMArrayFree ( TVMArrayHandle handle )

Free the TVM Array.

Parameters

handle The array handle to be freed.

Returns: 0 when success, nonzero when failure happens

◆ TVMArrayFromDLPack()

int TVMArrayFromDLPack	(	DLManagedTensor *	from,
		TVMArrayHandle *	out
	)

Produce an array from the DLManagedTensor that shares data memory with the DLManagedTensor.

Parameters

from	The source DLManagedTensor.
out	The output array handle.

Returns: 0 when success, nonzero when failure happens

◆ TVMArrayToDLPack()

int TVMArrayToDLPack	(	TVMArrayHandle	from,
		DLManagedTensor **	out
	)

Produce a DLMangedTensor from the array that shares data memory with the array.

Parameters

from	The source array.
out	The DLManagedTensor handle.

Returns: 0 when success, nonzero when failure happens

◆ TVMByteArrayFree()

int TVMByteArrayFree ( TVMByteArray * arr )

Free a TVMByteArray returned from TVMFuncCall, and associated memory.

Parameters

arr	The TVMByteArray instance.

Returns: 0 on success, -1 on failure.

◆ TVMCbArgToReturn()

int TVMCbArgToReturn	(	TVMValue *	value,
		int *	code
	)

Inplace translate callback argument value to return value. This is only needed for non-POD arguments.

Parameters

value	The value to be translated.
code	The type code to be translated.

Note: This function will do a shallow copy when necessary.

Returns: 0 when success, nonzero when failure happens.

◆ TVMCFuncSetReturn()

int TVMCFuncSetReturn	(	TVMRetValueHandle	ret,
		TVMValue *	value,
		int *	type_code,
		int	num_ret
	)

Set the return value of TVMPackedCFunc.

This function is called by TVMPackedCFunc to set the return value. When this function is not called, the function returns null by default.

Parameters

ret	The return value handle, pass by ret in TVMPackedCFunc
value	The value to be returned.
type_code	The type of the value to be returned.
num_ret	Number of return values, for now only 1 is supported.

◆ TVMDeviceAllocDataSpace()

int TVMDeviceAllocDataSpace	(	DLDevice	dev,
		size_t	nbytes,
		size_t	alignment,
		DLDataType	type_hint,
		void **	out_data
	)

Allocate a data space on device.

Parameters

dev	The device to perform operation.
nbytes	The number of bytes in memory.
alignment	The alignment of the memory.
type_hint	The type of elements. Only needed by certain backends such as nbytes & alignment are sufficient for most backends.
out_data	The allocated device pointer.

Returns: 0 when success, nonzero when failure happens

◆ TVMDeviceAllocDataSpaceWithScope()

int TVMDeviceAllocDataSpaceWithScope	(	DLDevice	dev,
		int	ndim,
		const int64_t *	shape,
		DLDataType	dtype,
		const char *	mem_scope,
		void **	out_data
	)

Allocate a data space on device with special memory scope.

Note: The memory could use a special multi-dimensional memory layout. That is why we pass shape and dtype instead of raw number of bytes.

Parameters

dev	The device to perform operation.
ndim	The number of dimension of the tensor.
shape	The shape of the tensor.
dtype	The type of elements.
mem_scope	The memory scope of the tensor, can be nullptr, which indicate the default global DRAM
out_data	The allocated device pointer.

Returns: 0 when success, nonzero when failure happens

◆ TVMDeviceCopyDataFromTo()

int TVMDeviceCopyDataFromTo	(	DLTensor *	from,
		DLTensor *	to,
		TVMStreamHandle	stream
	)

Copy data from one place to another.

Note: This API is designed to support special memory with shape dependent layout. We pass in DLTensor* with shape information to support these cases.

Parameters

from	The source tensor.
to	The target tensor.
stream	Optional stream object.

Returns: 0 when success, nonzero when failure happens.

◆ TVMDeviceFreeDataSpace()

int TVMDeviceFreeDataSpace	(	DLDevice	dev,
		void *	ptr
	)

Free a data space on device.

Parameters

dev	The device to perform operation.
ptr	The data space.

Returns: 0 when success, nonzero when failure happens

◆ TVMDLManagedTensorCallDeleter()

void TVMDLManagedTensorCallDeleter ( DLManagedTensor * dltensor )

Delete (free) a DLManagedTensor's data.

Parameters

dltensor Pointer to the DLManagedTensor.

◆ TVMDropLastPythonError()

void TVMDropLastPythonError ( )

Remove the propagated python error, if any.

Removes the TVM-held reference to a thrown python exception object. Because these objects contain references to the stack frames from which the exception was thrown, maintaining a reference to an exception object prevents any local python variables from being garbage-collected. After retrieving the object using TVMGetLastPythonError, the Python FFI interface uses this method to clear the TVM-held reference to the exception, to allow garbage collection to continue.

◆ TVMFuncCall()

int TVMFuncCall	(	TVMFunctionHandle	func,
		TVMValue *	arg_values,
		int *	type_codes,
		int	num_args,
		TVMValue *	ret_val,
		int *	ret_type_code
	)

Call a Packed TVM Function.

Parameters

func	node handle of the function.
arg_values	The arguments
type_codes	The type codes of the arguments
num_args	Number of arguments.
ret_val	The return value.
ret_type_code	the type code of return value.

Returns: 0 when success, nonzero when failure happens

Note: TVM calls always exchanges with type bits=64, lanes=1; API calls always exchanges with type bits=64, lanes=1 If API call returns container handles (e.g. FunctionHandle) these handles should be managed by the front-end. The front-end need to call free function (e.g. TVMFuncFree) to free these handles.

◆ TVMFuncCreateFromCFunc()

int TVMFuncCreateFromCFunc	(	TVMPackedCFunc	func,
		void *	resource_handle,
		TVMPackedCFuncFinalizer	fin,
		TVMFunctionHandle *	out
	)

Wrap a TVMPackedCFunc to become a FunctionHandle.

The resource_handle will be managed by TVM API, until the function is no longer used.

Parameters

func	The packed C function.
resource_handle	The resource handle from front-end, can be NULL.
fin	The finalizer on resource handle when the FunctionHandle get freed, can be NULL
out	the result function handle.

Returns: 0 when success, nonzero when failure happens

◆ TVMFuncFree()

int TVMFuncFree ( TVMFunctionHandle func )

Free the function when it is no longer needed.

Parameters

func	The function handle

Returns: 0 when success, nonzero when failure happens

◆ TVMFuncGetGlobal()

int TVMFuncGetGlobal	(	const char *	name,
		TVMFunctionHandle *	out
	)

Get a global function.

Parameters

name	The name of the function.
out	the result function pointer, NULL if it does not exist.

Note: The function handle of global function is managed by TVM runtime, So TVMFuncFree is should not be called when it get deleted.

◆ TVMFuncListGlobalNames()

int TVMFuncListGlobalNames	(	int *	out_size,
		const char ***	out_array
	)

List all the globally registered function name.

Parameters

out_size	The number of functions
out_array	The array of function names.

Returns: 0 when success, nonzero when failure happens

◆ TVMFuncRegisterGlobal()

int TVMFuncRegisterGlobal	(	const char *	name,
		TVMFunctionHandle	f,
		int	override
	)

Register the function to runtime's global table.

The registered function then can be pulled by the backend by the name.

Parameters

name	The name of the function.
f	The function to be registered.
override	Whether allow override already registered function.

◆ TVMFuncRemoveGlobal()

int TVMFuncRemoveGlobal ( const char * name )

Remove a global function.

Parameters

name	The name of the function.

◆ TVMGetLastBacktrace()

const char* TVMGetLastBacktrace ( )

Return the backtrace of the most recent error.

Returns the backtrace of the most recent error, if an error exists, and the error contains a backtrace. If no error exists or the error does not contain a backtrace, returns nullptr.

Returns: The backtrace of the most recent error

◆ TVMGetLastError()

const char* TVMGetLastError ( void )

return str message of the last error all function in this file will return 0 when success and nonzero when an error occurred, TVMGetLastError can be called to retrieve the error

this function is threadsafe and can be called by different thread

Returns: error info

◆ TVMGetLastPythonError()

void* TVMGetLastPythonError ( )

Return the previous python error, if any.

Used to propagate the original Python exception to a python try/except, when there are C++ stack frames between the location thro

Returns: The previous argument passed during the most recent call to TVMAPISetLastPythonError. If TVMAPISetLastPythonError has not been called, or if TVMDropLastPythonError has been called since the most recent to TVMAPISetLastPythonError, returns nullptr.

◆ TVMModFree()

int TVMModFree ( TVMModuleHandle mod )

Free the Module.

Parameters

mod	The module to be freed.

Note: This may not free up the module's resources. If there is active TVMFunctionHandle uses the module Or if this module is imported by another active module.

The all functions remains valid until TVMFuncFree is called.

Returns: 0 when success, nonzero when failure happens

◆ TVMModGetFunction()

int TVMModGetFunction	(	TVMModuleHandle	mod,
		const char *	func_name,
		int	query_imports,
		TVMFunctionHandle *	out
	)

Get function from the module.

Parameters

mod	The module handle.
func_name	The name of the function.
query_imports	Whether to query imported modules
out	The result function, can be NULL if it is not available.

Returns: 0 when no error is thrown, nonzero when failure happens

◆ TVMModImport()

int TVMModImport	(	TVMModuleHandle	mod,
		TVMModuleHandle	dep
	)

Add dep to mod's dependency. This allows functions in this module to use modules.

Parameters

mod	The module handle.
dep	The dependent module to be imported.

Returns: 0 when success, nonzero when failure happens

◆ TVMModLoadFromFile()

int TVMModLoadFromFile	(	const char *	file_name,
		const char *	format,
		TVMModuleHandle *	out
	)

Load module from file.

Parameters

file_name	The file name to load the module from.
format	The format of the module.
out	The result module

Returns: 0 when success, nonzero when failure happens

Note: The resulting module do not contain import relation. It can be reconstructed by TVMModImport.

◆ TVMObjectDerivedFrom()

int TVMObjectDerivedFrom	(	uint32_t	child_type_index,
		uint32_t	parent_type_index,
		int *	is_derived
	)

Check that an object is derived from another.

Parameters

child_type_index	The type index of the derived type.
parent_type_index	The type index of the parent type.
is_derived	A boolean representing whether this predicate holds.

Returns: 0 when success, nonzero when failure happens.

◆ TVMObjectFree()

int TVMObjectFree ( TVMObjectHandle obj )

Free the object.

Parameters

obj	The object handle.

Note: Internally we decrease the reference counter of the object. The object will be freed when every reference to the object are removed.

Returns: 0 when success, nonzero when failure happens

◆ TVMObjectGetTypeIndex()

int TVMObjectGetTypeIndex	(	TVMObjectHandle	obj,
		unsigned *	out_tindex
	)

Get the type_index from an object.

Parameters

obj	The object handle.
out_tindex	the output type index.

Returns: 0 when success, nonzero when failure happens

◆ TVMObjectRetain()

int TVMObjectRetain ( TVMObjectHandle obj )

Increase the reference count of an object.

Parameters

obj	The object handle.

Note: Internally we increase the reference counter of the object.

Returns: 0 when success, nonzero when failure happens

◆ TVMObjectTypeIndex2Key()

int TVMObjectTypeIndex2Key	(	unsigned	tindex,
		char **	out_type_key
	)

Convert type index to type key.

Parameters

tindex	The type index.
out_type_key	The output type key.

Returns: 0 when success, nonzero when failure happens

◆ TVMObjectTypeKey2Index()

int TVMObjectTypeKey2Index	(	const char *	type_key,
		unsigned *	out_tindex
	)

Convert type key to type index.

Parameters

type_key	The key of the type.
out_tindex	the corresponding type index.

Returns: 0 when success, nonzero when failure happens

◆ TVMSetStream()

int TVMSetStream	(	int	device_type,
		int	device_id,
		TVMStreamHandle	handle
	)

Set the runtime stream of current thread to be stream. The subsequent calls to the same device_type will use the setted stream handle. The specific type of stream is runtime device dependent.

Parameters

device_type	The device type.
device_id	The device id.
handle	The stream handle.

Returns: 0 when success, nonzero when failure happens

◆ TVMStreamCreate()

int TVMStreamCreate	(	int	device_type,
		int	device_id,
		TVMStreamHandle *	out
	)

Create a new runtime stream.

Parameters

device_type	The device type.
device_id	The device id.
out	The new stream handle.

Returns: 0 when success, nonzero when failure happens

◆ TVMStreamFree()

int TVMStreamFree	(	int	device_type,
		int	device_id,
		TVMStreamHandle	stream
	)

Free a created stream handle.

Parameters

device_type	The device type.
device_id	The device id.
stream	The stream to be freed.

Returns: 0 when success, nonzero when failure happens

◆ TVMStreamStreamSynchronize()

int TVMStreamStreamSynchronize	(	int	device_type,
		int	device_id,
		TVMStreamHandle	src,
		TVMStreamHandle	dst
	)

Synchronize two streams of execution.

Parameters

device_type	The device type.
device_id	The device id.
src	The source stream to synchronize.
dst	The destination stream to synchronize.

Returns: 0 when success, nonzero when failure happens

◆ TVMSynchronize()

int TVMSynchronize	(	int	device_type,
		int	device_id,
		TVMStreamHandle	stream
	)

Wait until all computations on stream completes.

Parameters

device_type	The device type.
device_id	The device id.
stream	The stream to be synchronized.

Returns: 0 when success, nonzero when failure happens

◆ TVMThrowLastError()

void TVMThrowLastError ( )

Re-throw the most recent error.

If an error was previously set using TVMAPISetLastError or TVMAPISetLastPythonError, re-throw the error. This is similar to LOG(FATAL) << TVMGetLastError(), but includes handling to propagate a python exception across C++ stack frames, or to append a stack trace to an error message.

Classes

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ TVM_ATTRIBUTE_UNUSED

◆ TVM_VERSION

◆ TVM_WEAK

Typedef Documentation

◆ tvm_index_t

◆ TVMArrayHandle

◆ TVMExtensionFuncDeclarer

◆ TVMFunctionHandle

◆ TVMModuleHandle

◆ TVMObjectHandle

◆ TVMPackedCFunc

◆ TVMPackedCFuncFinalizer

◆ TVMRetValueHandle

◆ TVMStreamHandle

Enumeration Type Documentation

◆ TVMArgTypeCode

◆ TVMDeviceExtType

Function Documentation

◆ TVMAPISetLastError()

◆ TVMAPISetLastPythonError()

◆ TVMArrayAlloc()

◆ TVMArrayCopyFromBytes()

◆ TVMArrayCopyFromTo()

◆ TVMArrayCopyToBytes()

◆ TVMArrayFree()

◆ TVMArrayFromDLPack()

◆ TVMArrayToDLPack()

◆ TVMByteArrayFree()

◆ TVMCbArgToReturn()

◆ TVMCFuncSetReturn()

◆ TVMDeviceAllocDataSpace()

◆ TVMDeviceAllocDataSpaceWithScope()

◆ TVMDeviceCopyDataFromTo()

◆ TVMDeviceFreeDataSpace()

◆ TVMDLManagedTensorCallDeleter()

◆ TVMDropLastPythonError()

◆ TVMFuncCall()

◆ TVMFuncCreateFromCFunc()

◆ TVMFuncFree()

◆ TVMFuncGetGlobal()

◆ TVMFuncListGlobalNames()

◆ TVMFuncRegisterGlobal()

◆ TVMFuncRemoveGlobal()

◆ TVMGetLastBacktrace()

◆ TVMGetLastError()

◆ TVMGetLastPythonError()

◆ TVMModFree()

◆ TVMModGetFunction()

◆ TVMModImport()

◆ TVMModLoadFromFile()

◆ TVMObjectDerivedFrom()

◆ TVMObjectFree()

◆ TVMObjectGetTypeIndex()

◆ TVMObjectRetain()

◆ TVMObjectTypeIndex2Key()

◆ TVMObjectTypeKey2Index()

◆ TVMSetStream()

◆ TVMStreamCreate()

◆ TVMStreamFree()

◆ TVMStreamStreamSynchronize()

◆ TVMSynchronize()

◆ TVMThrowLastError()