fd3907ccb5
Reland #118503. Added a fix for builds with `-DBUILD_SHARED_LIBS=ON` (see last commit). Otherwise the changes are identical. --- ### New API Previous discussions at the LLVM/Offload meeting have brought up the need for a new API for exposing the functionality of the plugins. This change introduces a very small subset of a new API, which is primarily for testing the offload tooling and demonstrating how a new API can fit into the existing code base without being too disruptive. Exact designs for these entry points and future additions can be worked out over time. The new API does however introduce the bare minimum functionality to implement device discovery for Unified Runtime and SYCL. This means that the `urinfo` and `sycl-ls` tools can be used on top of Offload. A (rough) implementation of a Unified Runtime adapter (aka plugin) for Offload is available [here](https://github.com/callumfare/unified-runtime/tree/offload_adapter). Our intention is to maintain this and use it to implement and test Offload API changes with SYCL. ### Demoing the new API ```sh # From the runtime build directory $ ninja LibomptUnitTests $ OFFLOAD_TRACE=1 ./offload/unittests/OffloadAPI/offload.unittests ``` ### Open questions and future work * Only some of the available device info is exposed, and not all the possible device queries needed for SYCL are implemented by the plugins. A sensible next step would be to refactor and extend the existing device info queries in the plugins. The existing info queries are all strings, but the new API introduces the ability to return any arbitrary type. * It may be sensible at some point for the plugins to implement the new API directly, and the higher level code on top of it could be made generic, but this is more of a long-term possibility.
107 lines
4.0 KiB
TableGen
107 lines
4.0 KiB
TableGen
//===-- Device.td - Device 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 Device handle
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
def : Enum {
|
|
let name = "ol_device_type_t";
|
|
let desc = "Supported device types";
|
|
let etors =[
|
|
Etor<"DEFAULT", "The default device type as preferred by the runtime">,
|
|
Etor<"ALL", "Devices of all types">,
|
|
Etor<"GPU", "GPU device type">,
|
|
Etor<"CPU", "CPU device type">,
|
|
];
|
|
}
|
|
|
|
def : Enum {
|
|
let name = "ol_device_info_t";
|
|
let desc = "Supported device info";
|
|
let is_typed = 1;
|
|
let etors =[
|
|
TaggedEtor<"TYPE", "ol_device_type_t", "type of the device">,
|
|
TaggedEtor<"PLATFORM", "ol_platform_handle_t", "the platform associated with the device">,
|
|
TaggedEtor<"NAME", "char[]", "Device name">,
|
|
TaggedEtor<"VENDOR", "char[]", "Device vendor">,
|
|
TaggedEtor<"DRIVER_VERSION", "char[]", "Driver version">
|
|
];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olGetDeviceCount";
|
|
let desc = "Retrieves the number of available devices within a platform";
|
|
let params = [
|
|
Param<"ol_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
|
|
Param<"uint32_t*", "NumDevices", "pointer to the number of devices.", PARAM_OUT>
|
|
];
|
|
let returns = [];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olGetDevice";
|
|
let desc = "Retrieves devices within a platform";
|
|
let details = [
|
|
"Multiple calls to this function will return identical device handles, in the same order.",
|
|
];
|
|
let params = [
|
|
Param<"ol_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
|
|
Param<"uint32_t", "NumEntries", "the number of devices to be added to phDevices, which must be greater than zero", PARAM_IN>,
|
|
RangedParam<"ol_device_handle_t*", "Devices", "Array of device handles. "
|
|
"If NumEntries is less than the number of devices available, then this function shall only retrieve that number of devices.", PARAM_OUT,
|
|
Range<"0", "NumEntries">>
|
|
];
|
|
let returns = [
|
|
Return<"OL_ERRC_INVALID_SIZE", [
|
|
"`NumEntries == 0`"
|
|
]>
|
|
];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olGetDeviceInfo";
|
|
let desc = "Queries the given property of the device";
|
|
let details = [];
|
|
let params = [
|
|
Param<"ol_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
|
|
Param<"ol_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
|
|
Param<"size_t", "PropSize", "the number of bytes pointed to by PropValue.", PARAM_IN>,
|
|
TypeTaggedParam<"void*", "PropValue", "array of bytes holding the info. If PropSize is not equal to or greater than the real "
|
|
"number of bytes needed to return the info then the OL_ERRC_INVALID_SIZE error is returned and "
|
|
"PropValue is not used.", PARAM_OUT, TypeInfo<"PropName" , "PropSize">>
|
|
];
|
|
let returns = [
|
|
Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
|
|
"If `PropName` is not supported by the device."
|
|
]>,
|
|
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_DEVICE">
|
|
];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olGetDeviceInfoSize";
|
|
let desc = "Returns the storage size of the given device query";
|
|
let details = [];
|
|
let params = [
|
|
Param<"ol_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
|
|
Param<"ol_device_info_t", "PropName", "type of the info to retrieve", 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 device."
|
|
]>,
|
|
Return<"OL_ERRC_INVALID_DEVICE">
|
|
];
|
|
}
|