torch-mlir/include/npcomp/runtime/Support.h

100 lines
2.7 KiB
C
Raw Normal View History

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
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Trimmed down support classes intended to provide a familiar LLVM-like API,
// but without actually pulling in the LLVM ones.
//
//===----------------------------------------------------------------------===//
#ifndef NPCOMP_RUNTIME_SUPPORT_H
#define NPCOMP_RUNTIME_SUPPORT_H
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <cstring>
namespace npcomprt {
class StringRef {
public:
StringRef(const char *ptr, std::size_t length) : ptr(ptr), length(length){};
// Construct from NUL-terminated C string.
StringRef(const char *ptr) : ptr(ptr), length(std::strlen(ptr)) {}
bool equals(StringRef other) {
if (length != other.length)
return false;
return std::memcmp(ptr, other.ptr, length) == 0;
}
private:
const char *ptr;
std::size_t length;
};
inline bool operator==(StringRef lhs, StringRef rhs) { return lhs.equals(rhs); }
inline bool operator!=(StringRef lhs, StringRef rhs) {
return !operator==(lhs, rhs);
}
template <typename T> class ArrayRef {
public:
ArrayRef(const T *ptr, std::size_t length) : ptr(ptr), length(length){};
const T &operator[](std::size_t i) const {
assert(i < length);
return ptr[i];
}
const T *data() const { return ptr; }
std::size_t size() const { return length; }
private:
const T *ptr;
std::size_t length;
};
template <typename T> class MutableArrayRef {
public:
MutableArrayRef(T *ptr, std::size_t length) : ptr(ptr), length(length){};
T &operator[](std::size_t i) {
assert(i < length);
return ptr[i];
}
T *data() const { return ptr; }
std::size_t size() const { return length; }
private:
T *ptr;
std::size_t length;
};
// Literally copied from MLIR.
struct LogicalResult {
enum ResultEnum { Success, Failure } value;
LogicalResult(ResultEnum v) : value(v) {}
};
inline LogicalResult success(bool isSuccess = true) {
return LogicalResult{isSuccess ? LogicalResult::Success
: LogicalResult::Failure};
}
inline LogicalResult failure(bool isFailure = true) {
return LogicalResult{isFailure ? LogicalResult::Failure
: LogicalResult::Success};
}
inline bool succeeded(LogicalResult result) {
return result.value == LogicalResult::Success;
}
inline bool failed(LogicalResult result) {
return result.value == LogicalResult::Failure;
}
} // namespace npcomprt
#endif // NPCOMP_RUNTIME_SUPPORT_H