torch-mlir/include/npcomp/JITRuntime/README.md

Utilities for compiling and running on the npcomp runtime with a JIT.

The runtime itself lives in {include,lib}/runtime/, but since it is totally
firewalled from the compiler codebase, it presents a fairly bare-bones
interface (e.g. it doesn't use libSupport, can't use LLVM's JIT interfaces,
etc.).

The interface provided in this directory uses standard LLVM conventions and
freely relies on libSupport, JIT utilities, etc.
Rework e2e flow to use new "npcomprt" This ~totally reworks the existing "runtime" stuff to be more principled and usable, such as from Python. It's still not fully production-quality, mainly in the department of memory management (e.g. it currently leaks memory; we need to figure out "who frees memrefs" + the analysis and transformation needed to do that (maybe use upstream buffer allocation pass?)). The user API is in include/npcomp/runtime/UserAPI.h, though include/npcomp/JITRuntime/JITModule.h is a friendlier wrapper. The stuff under {include,lib}/runtime is totally firewalled from the compiler and tiny (<6kB, though no attention has gone into optimizing that size). For example, we don't link in libSupport into the runtime, instead having our own bare bones replacements for basics like ArrayRef (the JITRuntime helps with bridging that gap, since it can depend on all common LLVM utilities). The overall features of npcomprt is that it exposes a module that with multiple function entry points. Each function has arguments and results that are tensor-valued, and npcomprt::Tensor is the runtime type that is used to interact with that (and a npcomprt::Ref<T> reference-counting wrapper is provided to wrap npcomprt::Tensor in the common case). From an implementation perspective, an npcomprt module at the LLVM/object/binary level exposes a single module descriptor struct that has pointers to other metadata (currently just a list of function metadata descriptors). All interactions with the npcomp runtime are keyed off of that module descriptor, including function lookups and dispatching. This is done to dodge platform ABI issues and also allow enough reflection to e.g. verify provided arguments. Most of the compiler-side work here was in LowerToNpcomprtABI and LowerToLLVM. Also, - Rename npcomp_rt/NpcompRt to npcomprt/Npcomprt; it was getting annoying to type the underscores/caps. - misc improvements to bash_helpers.sh 2020-07-09 08:15:40 +08:00			`Utilities for compiling and running on the npcomp runtime with a JIT.`

			`The runtime itself lives in {include,lib}/runtime/, but since it is totally`
			`firewalled from the compiler codebase, it presents a fairly bare-bones`
			`interface (e.g. it doesn't use libSupport, can't use LLVM's JIT interfaces,`
			`etc.).`

			`The interface provided in this directory uses standard LLVM conventions and`
			`freely relies on libSupport, JIT utilities, etc.`