1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
*
* Copyright (C) 2019-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
* @file zer_api.h
* @version v1.14-r1.14.33
*
*/
#ifndef _ZER_API_H
#define _ZER_API_H
#if defined(__cplusplus)
#pragma once
#endif
// 'core' API headers
#include "ze_api.h"
#if defined(__cplusplus)
extern "C" {
#endif
// Intel 'oneAPI' Level-Zero Runtime API common types
#if !defined(__GNUC__)
#pragma region common
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Immediate Command List default descriptor for GPU devices
static const ze_command_queue_desc_t zeDefaultGPUImmediateCommandQueueDesc = {
ZE_STRUCTURE_TYPE_COMMAND_QUEUE_DESC, ///< stype
0, ///< pNext
0, ///< ordinal
0, ///< index
ZE_COMMAND_QUEUE_FLAG_IN_ORDER | ZE_COMMAND_QUEUE_FLAG_COPY_OFFLOAD_HINT, ///< flags
ZE_COMMAND_QUEUE_MODE_ASYNCHRONOUS, ///< mode
ZE_COMMAND_QUEUE_PRIORITY_NORMAL, ///< priority
};
///////////////////////////////////////////////////////////////////////////////
/// @brief Device Unified Shared Memory Allocation default descriptor for GPU
/// devices
static const ze_device_mem_alloc_desc_t zeDefaultGPUDeviceMemAllocDesc = {
ZE_STRUCTURE_TYPE_DEVICE_MEM_ALLOC_DESC, ///< stype
0, ///< pNext
ZE_DEVICE_MEM_ALLOC_FLAG_BIAS_CACHED, ///< flags
0, ///< ordinal
};
///////////////////////////////////////////////////////////////////////////////
/// @brief Host Unified Shared Memory Allocation default descriptor for GPU
/// devices
static const ze_host_mem_alloc_desc_t zeDefaultGPUHostMemAllocDesc = {
ZE_STRUCTURE_TYPE_HOST_MEM_ALLOC_DESC, ///< stype
0, ///< pNext
ZE_HOST_MEM_ALLOC_FLAG_BIAS_CACHED | ZE_HOST_MEM_ALLOC_FLAG_BIAS_INITIAL_PLACEMENT, ///< flags
};
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves a string describing the last error code returned by the
/// default driver in the current thread.
///
/// @details
/// - String returned is thread local.
/// - String is only updated on calls returning an error, i.e., not on calls
/// returning ::ZE_RESULT_SUCCESS.
/// - String may be empty if driver considers error code is already explicit
/// enough to describe cause.
/// - Memory pointed to by ppString is owned by the default driver.
/// - String returned is null-terminated.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == ppString`
ZE_APIEXPORT ze_result_t ZE_APICALL
zerGetLastErrorDescription(
const char** ppString ///< [in,out] pointer to a null-terminated array of characters describing
///< cause of error.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Translates device handle to integer identifier.
///
/// @details
/// - The implementation of this function should be lock-free.
/// - This function does not return error code, to get info about failure
/// user may use ::zerGetLastErrorDescription function.
/// - In case of failure, this function returns UINT32_MAX.
///
/// @returns
/// - integer identifier for the device
/// - UINT32_MAX
ZE_APIEXPORT uint32_t ZE_APICALL
zerTranslateDeviceHandleToIdentifier(
ze_device_handle_t hDevice ///< [in] handle of the device
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Translates to integer identifier to a device handle.
///
/// @details
/// - The driver must be initialized before calling this function.
/// - The implementation of this function should be lock-free.
/// - This function does not return error code, to get info about failure
/// user may use ::zerGetLastErrorDescription function.
/// - In case of failure, this function returns null.
/// - Details on the error can be retrieved using
/// ::zerGetLastErrorDescription function.
///
/// @returns
/// - handle of the device with the given identifier
/// - nullptr
ZE_APIEXPORT ze_device_handle_t ZE_APICALL
zerTranslateIdentifierToDeviceHandle(
uint32_t identifier ///< [in] integer identifier of the device
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves handle to default context from the default driver.
///
/// @details
/// - The driver must be initialized before calling this function.
/// - The implementation of this function should be lock-free.
/// - This returned context contains all the devices available in the
/// default driver.
/// - This function does not return error code, to get info about failure
/// user may use ::zerGetLastErrorDescription function.
/// - In case of failure, this function returns null.
/// - Details on the error can be retrieved using
/// ::zerGetLastErrorDescription function.
///
/// @returns
/// - handle of the default context
/// - nullptr
ZE_APIEXPORT ze_context_handle_t ZE_APICALL
zerGetDefaultContext(
void
);
#if !defined(__GNUC__)
#pragma endregion
#endif
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // _ZER_API_H
|
