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.
62 lines
3.1 KiB
TableGen
62 lines
3.1 KiB
TableGen
//===-- Kernel.td - Kernel 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 kernel handle
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
def : Function {
|
|
let name = "olGetKernel";
|
|
let desc = "Get a kernel from the function identified by `KernelName` in the given program.";
|
|
let details = [
|
|
"The kernel handle returned is owned by the device so does not need to be destroyed."
|
|
];
|
|
let params = [
|
|
Param<"ol_program_handle_t", "Program", "handle of the program", PARAM_IN>,
|
|
Param<"const char*", "KernelName", "name of the kernel entry point in the program", PARAM_IN>,
|
|
Param<"ol_kernel_handle_t*", "Kernel", "output pointer for the fetched kernel", PARAM_OUT>
|
|
];
|
|
let returns = [];
|
|
}
|
|
|
|
def : Struct {
|
|
let name = "ol_kernel_launch_size_args_t";
|
|
let desc = "Size-related arguments for a kernel launch.";
|
|
let members = [
|
|
StructMember<"size_t", "Dimensions", "Number of work dimensions">,
|
|
StructMember<"size_t", "NumGroupsX", "Number of work groups on the X dimension">,
|
|
StructMember<"size_t", "NumGroupsY", "Number of work groups on the Y dimension">,
|
|
StructMember<"size_t", "NumGroupsZ", "Number of work groups on the Z dimension">,
|
|
StructMember<"size_t", "GroupSizeX", "Size of a work group on the X dimension.">,
|
|
StructMember<"size_t", "GroupSizeY", "Size of a work group on the Y dimension.">,
|
|
StructMember<"size_t", "GroupSizeZ", "Size of a work group on the Z dimension.">,
|
|
StructMember<"size_t", "DynSharedMemory", "Size of dynamic shared memory in bytes.">
|
|
];
|
|
}
|
|
|
|
def : Function {
|
|
let name = "olLaunchKernel";
|
|
let desc = "Enqueue a kernel launch with the specified size and parameters.";
|
|
let details = [
|
|
"If a queue is not specified, kernel execution happens synchronously"
|
|
];
|
|
let params = [
|
|
Param<"ol_queue_handle_t", "Queue", "handle of the queue", PARAM_IN_OPTIONAL>,
|
|
Param<"ol_device_handle_t", "Device", "handle of the device to execute on", PARAM_IN>,
|
|
Param<"ol_kernel_handle_t", "Kernel", "handle of the kernel", PARAM_IN>,
|
|
Param<"const void*", "ArgumentsData", "pointer to the kernel argument struct", PARAM_IN>,
|
|
Param<"size_t", "ArgumentsSize", "size of the kernel argument struct", PARAM_IN>,
|
|
Param<"const ol_kernel_launch_size_args_t*", "LaunchSizeArgs", "pointer to the struct containing launch size parameters", PARAM_IN>,
|
|
Param<"ol_event_handle_t*", "EventOut", "optional recorded event for the enqueued operation", PARAM_OUT_OPTIONAL>
|
|
];
|
|
let returns = [
|
|
Return<"OL_ERRC_INVALID_ARGUMENT", ["`Queue == NULL && EventOut != NULL`"]>,
|
|
Return<"OL_ERRC_INVALID_DEVICE", ["If Queue is non-null but does not belong to Device"]>,
|
|
];
|
|
}
|