Files
UnrealEngine/Engine/Source/ThirdParty/Intel/ISPC/ispc-1.17.0/ispcrt/ispcrt.h
2025-05-18 13:04:45 +08:00

149 lines
4.7 KiB
C

// Copyright 2020-2021 Intel Corporation
// SPDX-License-Identifier: BSD-3-Clause
#pragma once
#include <stddef.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
// Opaque handle types ////////////////////////////////////////////////////////
#ifdef __cplusplus
struct _ISPCRTDevice;
struct _ISPCRTMemoryView;
struct _ISPCRTTaskQueue;
struct _ISPCRTModule;
struct _ISPCRTKernel;
struct _ISPCRTFuture;
typedef _ISPCRTDevice *ISPCRTDevice;
typedef _ISPCRTMemoryView *ISPCRTMemoryView;
typedef _ISPCRTTaskQueue *ISPCRTTaskQueue;
typedef _ISPCRTModule *ISPCRTModule;
typedef _ISPCRTKernel *ISPCRTKernel;
typedef _ISPCRTFuture *ISPCRTFuture;
#else
typedef void *ISPCRTDevice;
typedef void *ISPCRTMemoryView;
typedef void *ISPCRTTaskQueue;
typedef void *ISPCRTModule;
typedef void *ISPCRTKernel;
typedef void *ISPCRTFuture;
#endif
// NOTE: ISPCRTGenericHandle usage implies compatibility with any of the above
// handle types.
typedef void *ISPCRTGenericHandle;
// Error handling /////////////////////////////////////////////////////////////
typedef enum {
ISPCRT_NO_ERROR = 0,
ISPCRT_UNKNOWN_ERROR = 1,
ISPCRT_INVALID_ARGUMENT = 2,
ISPCRT_INVALID_OPERATION = 3,
ISPCRT_OUT_OF_MEMORY = 5,
ISPCRT_UNINITIALIZED = 6,
ISPCRT_UNSUPPORTED = 7,
ISPCRT_DEVICE_LOWER_POWER = 8,
ISPCRT_DEVICE_RESET = 9,
ISPCRT_DEVICE_LOST = 10
} ISPCRTError;
typedef void (*ISPCRTErrorFunc)(ISPCRTError, const char *errorMessage);
void ispcrtSetErrorFunc(ISPCRTErrorFunc);
// Object lifetime ////////////////////////////////////////////////////////////
void ispcrtRelease(ISPCRTGenericHandle);
void ispcrtRetain(ISPCRTGenericHandle);
// Device initialization //////////////////////////////////////////////////////
typedef enum {
ISPCRT_DEVICE_TYPE_CPU,
ISPCRT_DEVICE_TYPE_GPU,
ISPCRT_DEVICE_TYPE_AUTO // try 'GPU', but fallback to 'CPU' if no GPUs found
} ISPCRTDeviceType;
typedef struct {
uint32_t vendorId;
uint32_t deviceId;
} ISPCRTDeviceInfo;
// deviceIdx is an index of the device in the list of supported devices
// The list of the supported devices can be obtained with a ispcrtGetDeviceCount call
// and a series of ispcrtGetDeviceInfo calls
ISPCRTDevice ispcrtGetDevice(ISPCRTDeviceType, uint32_t deviceIdx);
uint32_t ispcrtGetDeviceCount(ISPCRTDeviceType);
void ispcrtGetDeviceInfo(ISPCRTDeviceType, uint32_t deviceIdx, ISPCRTDeviceInfo*);
// MemoryViews ////////////////////////////////////////////////////////////////
// Choose allocation type
typedef enum {
// Allocate memory on the device (and associate appMemory with this allocation)
ISPCRT_ALLOC_TYPE_DEVICE = 0,
// Allocate in the memory shared between the host and the device (ignore appMemory ptr)
ISPCRT_ALLOC_TYPE_SHARED,
} ISPCRTAllocationType;
typedef struct {
ISPCRTAllocationType allocType;
} ISPCRTNewMemoryViewFlags;
ISPCRTMemoryView ispcrtNewMemoryView(ISPCRTDevice, void *appMemory, size_t numBytes, ISPCRTNewMemoryViewFlags *flags);
void *ispcrtHostPtr(ISPCRTMemoryView);
void *ispcrtDevicePtr(ISPCRTMemoryView);
void *ispcrtSharedPtr(ISPCRTMemoryView);
size_t ispcrtSize(ISPCRTMemoryView);
// Kernels ////////////////////////////////////////////////////////////////////
typedef struct {
uint32_t stackSize;
} ISPCRTModuleOptions;
ISPCRTModule ispcrtLoadModule(ISPCRTDevice, const char *moduleFile, ISPCRTModuleOptions);
ISPCRTKernel ispcrtNewKernel(ISPCRTDevice, ISPCRTModule, const char *name);
// Task queues ////////////////////////////////////////////////////////////////
ISPCRTTaskQueue ispcrtNewTaskQueue(ISPCRTDevice);
void ispcrtDeviceBarrier(ISPCRTTaskQueue);
void ispcrtCopyToDevice(ISPCRTTaskQueue, ISPCRTMemoryView);
void ispcrtCopyToHost(ISPCRTTaskQueue, ISPCRTMemoryView);
// NOTE: 'params' can be a NULL handle (NULL will get passed to the ISPC task as the function parameter)
ISPCRTFuture ispcrtLaunch1D(ISPCRTTaskQueue, ISPCRTKernel, ISPCRTMemoryView params, size_t dim0);
ISPCRTFuture ispcrtLaunch2D(ISPCRTTaskQueue, ISPCRTKernel, ISPCRTMemoryView params, size_t dim0, size_t dim1);
ISPCRTFuture ispcrtLaunch3D(ISPCRTTaskQueue, ISPCRTKernel, ISPCRTMemoryView params, size_t dim0, size_t dim1,
size_t dim2);
void ispcrtSync(ISPCRTTaskQueue);
// Futures and task timing ////////////////////////////////////////////////////
uint64_t ispcrtFutureGetTimeNs(ISPCRTFuture);
bool ispcrtFutureIsValid(ISPCRTFuture);
// Access to objects of native runtime ///////////////////////////////////////
ISPCRTGenericHandle ispcrtPlatformNativeHandle(ISPCRTDevice);
ISPCRTGenericHandle ispcrtDeviceNativeHandle(ISPCRTDevice);
ISPCRTGenericHandle ispcrtContextNativeHandle(ISPCRTDevice);
ISPCRTGenericHandle ispcrtTaskQueueNativeHandle(ISPCRTTaskQueue);
#ifdef __cplusplus
} // extern "C"
#endif