800d949bb3
Implement the complete initial version of the Offload API, to the extent that is usable for simple offloading programs. Tested with a basic SYCL program. As far as possible, these are simple wrappers over existing functionality in the plugins. * Allocating and freeing memory (host, device, shared). * Creating a program * Creating a queue (wrapper over asynchronous stream resource) * Enqueuing memcpy operations * Enqueuing kernel executions * Waiting on (optional) output events from the enqueue operations * Waiting on a queue to finish Objects created with the API have reference counting semantics to handle their lifetime. They are created with an initial reference count of 1, which can be incremented and decremented with retain and release functions. They are freed when their reference count reaches 0. Platform and device objects are not reference counted, as they are expected to persist as long as the library is in use, and it's not meaningful for users to create or destroy them. Tests have been added to `offload.unittests`, including device code for testing program and kernel related functionality. The API should still be considered unstable and it's very likely we will need to change the existing entry points.
80 lines
3.2 KiB
TableGen
80 lines
3.2 KiB
TableGen
//===-- Platform.td - Platform definitions for Offload -----*- tablegen -*-===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file contains Offload API definitions related to the Platform handle
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
def : Enum {
|
|
let name = "ol_platform_info_t";
|
|
let desc = "Supported platform info.";
|
|
let is_typed = 1;
|
|
let etors = [
|
|
TaggedEtor<"NAME", "char[]", "The string denoting name of the platform. The size of the info needs to be dynamically queried.">,
|
|
TaggedEtor<"VENDOR_NAME", "char[]", "The string denoting name of the vendor of the platform. The size of the info needs to be dynamically queried.">,
|
|
TaggedEtor<"VERSION", "char[]", "The string denoting the version of the platform. The size of the info needs to be dynamically queried.">,
|
|
TaggedEtor<"BACKEND", "ol_platform_backend_t", "The native backend of the platform.">
|
|
];
|
|
}
|
|
|
|
def : Enum {
|
|
let name = "ol_platform_backend_t";
|
|
let desc = "Identifies the native backend of the platform.";
|
|
let etors =[
|
|
Etor<"UNKNOWN", "The backend is not recognized">,
|
|
Etor<"CUDA", "The backend is CUDA">,
|
|
Etor<"AMDGPU", "The backend is AMDGPU">,
|
|
Etor<"HOST", "The backend is the host">,
|
|
];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olGetPlatformInfo";
|
|
let desc = "Queries the given property of the platform.";
|
|
let details = [
|
|
"`olGetPlatformInfoSize` can be used to query the storage size "
|
|
"required for the given query."
|
|
];
|
|
let params = [
|
|
Param<"ol_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
|
|
Param<"ol_platform_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
|
|
Param<"size_t", "PropSize", "the number of bytes pointed to by pPlatformInfo.", PARAM_IN>,
|
|
TypeTaggedParam<"void*", "PropValue", "array of bytes holding the info. "
|
|
"If Size is not equal to or greater to the real number of bytes needed to return the info "
|
|
"then the OL_ERRC_INVALID_SIZE error is returned and pPlatformInfo is not used.", PARAM_OUT,
|
|
TypeInfo<"PropName" , "PropSize">>
|
|
];
|
|
let returns = [
|
|
Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
|
|
"If `PropName` is not supported by the platform."
|
|
]>,
|
|
Return<"OL_ERRC_INVALID_SIZE", [
|
|
"`PropSize == 0`",
|
|
"If `PropSize` is less than the real number of bytes needed to return the info."
|
|
]>,
|
|
Return<"OL_ERRC_INVALID_PLATFORM">
|
|
];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olGetPlatformInfoSize";
|
|
let desc = "Returns the storage size of the given platform query.";
|
|
let details = [];
|
|
let params = [
|
|
Param<"ol_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
|
|
Param<"ol_platform_info_t", "PropName", "type of the info to query", PARAM_IN>,
|
|
Param<"size_t*", "PropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
|
|
];
|
|
let returns = [
|
|
Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
|
|
"If `PropName` is not supported by the platform."
|
|
]>,
|
|
Return<"OL_ERRC_INVALID_PLATFORM">
|
|
];
|
|
}
|