"""Container of compiled functions of TVM.""" from __future__ import absolute_import as _abs from collections import namedtuple from ._ffi.function import ModuleBase, _set_class_module from ._ffi.function import _init_api from .contrib import cc as _cc, util as _util ProfileResult = namedtuple("ProfileResult", ["mean"]) class Module(ModuleBase): """Module container of all TVM generated functions""" def __repr__(self): return "Module(%s, %x)" % (self.type_key, self.handle.value) @property def type_key(self): """Get type key of the module.""" return _GetTypeKey(self) def get_source(self, fmt=""): """Get source code from module, if available. Parameters ---------- fmt : str, optional The specified format. Returns ------- source : str The result source code. """ return _GetSource(self, fmt) @property def imported_modules(self): """Get imported modules Returns ---------- modules : list of Module The module """ nmod = _ImportsSize(self) return [_GetImport(self, i) for i in range(nmod)] def save(self, file_name, fmt=""): """Save the module to file. This do not save the dependent device modules. See also export_shared Parameters ---------- file_name : str The name of the file. fmt : str The format of the file. See Also -------- Module.export_library : export the module to shared library. """ _SaveToFile(self, file_name, fmt) def export_library(self, file_name, fcompile=None, **kwargs): """Export the module and its imported device code one library. This function only works on host llvm modules. It will pack all the imported modules Parameters ---------- file_name : str The name of the shared library. fcompile : function(target, file_list, kwargs), optional Compilation function to use create dynamic library. kwargs : dict, optiona; Additional arguments passed to fcompile """ if self.type_key == "stacktvm": raise ValueError("Module[%s]: export_library requires llvm module," " did you build with LLVM enabled?" % self.type_key) if self.type_key != "llvm": raise ValueError("Module[%s]: Only llvm support export shared" % self.type_key) temp = _util.tempdir() path_obj = temp.relpath("lib.o") self.save(path_obj) files = [path_obj] is_system_lib = self.get_function("__tvm_is_system_module")() if self.imported_modules: path_cc = temp.relpath("devc.cc") with open(path_cc, "w") as f: f.write(_PackImportsToC(self, is_system_lib)) files.append(path_cc) fcompile = fcompile if fcompile else _cc.create_shared fcompile(file_name, files, **kwargs) def time_evaluator(self, func_name, ctx, number): """Get an evaluator that measures time cost of running function. Parameters ---------- func_name: str The name of the function in the module. ctx: TVMContext The context we should run this function on. number: int The number of repeative times to run evaluation. Note ---- The function will be invoked number + 1 times, with the first call discarded in case there is lazy initialization. Returns ------- ftimer : Function The function that takes same argument as func and return a float representing seconds per function call. """ try: feval = _RPCTimeEvaluator( self, func_name, ctx.device_type, ctx.device_id, number) def evaluator(*args): """Internal wrapped evaluator.""" # Wrap feval so we can add more stats in future. mean = feval(*args) return ProfileResult(mean=mean) return evaluator except NameError: raise NameError("time_evaluate is only supported when RPC is enabled") def system_lib(): """Get system-wide library module singleton. System lib is a global module that contains self register functions in startup. Unlike normal dso modules which need to be loaded explicitly. It is useful in environments where dynamic loading api like dlopen is banned. To build system lib function, simply specify target option ```llvm --system-lib``` The system lib will be available as long as the result code is linked by the program. The system lib is intended to be linked and loaded during the entire life-cyle of the program. If you want dynamic loading features, use dso modules instead. Returns ------- module : Module The system-wide library module. """ return _GetSystemLib() def load(path, fmt=""): """Load module from file Parameters ---------- path : str The path to the module file. fmt : str, optional The format of the file, if not specified it will be inferred from suffix of the file. Returns ------- module : Module The loaded module """ return _LoadFromFile(path, fmt) def enabled(target): """Whether module runtime is enabled for target Parameters ---------- target : str The target device type. Returns ------- enabled : bool Whether runtime is enabled. Examples -------- The following code checks if gpu is enabled. >>> tvm.module.enabled("gpu") """ return _Enabled(target) _init_api("tvm.module") _set_class_module(Module)