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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
|
/*
* Copyright (C) 2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#pragma once
#include "shared/source/utilities/stackvec.h"
#include "level_zero/experimental/source/graph/graph_captured_apis.h"
#include "level_zero/ze_api.h"
#include <atomic>
#include <memory>
#include <span>
#include <unordered_map>
#include <variant>
#include <vector>
typedef struct _ze_graph_handle_t *ze_graph_handle_t;
typedef struct _ze_executable_graph_handle_t *ze_executable_graph_handle_t;
struct _ze_graph_handle_t {
};
struct _ze_executable_graph_handle_t {
};
namespace L0 {
inline std::atomic<bool> processUsesGraphs{false};
inline void enabledGraphs() {
bool graphsEnabled = false;
processUsesGraphs.compare_exchange_weak(graphsEnabled, true, std::memory_order_relaxed);
}
inline bool areGraphsEnabled() {
return processUsesGraphs.load();
}
using ClosureVariants = std::variant<
#define RR_CAPTURED_API(X) Closure<CaptureApi::X>,
RR_CAPTURED_APIS()
#undef RR_CAPTURED_API
int>;
using CapturedCommand = ClosureVariants;
using CapturedCommandId = uint32_t;
struct Graph;
struct ForkInfo {
CapturedCommandId forkCommandId = 0;
ze_event_handle_t forkEvent = nullptr;
};
struct ForkJoinInfo {
CapturedCommandId forkCommandId = 0;
CapturedCommandId joinCommandId = 0;
ze_event_handle_t forkEvent = nullptr;
ze_event_handle_t joinEvent = nullptr;
Graph *forkDestiny = nullptr;
};
struct Graph : _ze_graph_handle_t {
Graph(L0::Context *ctx, bool preallocated) : ctx(ctx), preallocated(preallocated) {
commands.reserve(16);
enabledGraphs();
}
~Graph();
Graph(const Graph &) = delete;
Graph &operator=(const Graph &) = delete;
static Graph *fromHandle(ze_graph_handle_t handle) {
return static_cast<Graph *>(handle);
}
inline ze_graph_handle_t toHandle() { return this; }
bool wasPreallocated() const {
return preallocated;
}
void startCapturingFrom(L0::CommandList &captureSrc, bool isSubGraph);
void stopCapturing();
template <CaptureApi api, typename... TArgs>
ze_result_t capture(TArgs... apiArgs) {
if (false == Closure<api>::isSupported) {
return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
}
using ApiArgsT = typename Closure<api>::ApiArgs;
auto capturedArgs = ApiArgsT{apiArgs...};
commands.push_back(CapturedCommand{Closure<api>(capturedArgs, externalStorage)});
return ZE_RESULT_SUCCESS;
}
const std::vector<CapturedCommand> &getCapturedCommands() const {
return commands;
}
const StackVec<Graph *, 16> &getSubgraphs() const {
return subGraphs;
}
const std::unordered_map<CapturedCommandId, ForkJoinInfo> &getJoinedForks() const {
return joinedForks;
}
const std::unordered_map<L0::CommandList *, ForkInfo> &getUnjoinedForks() const {
return unjoinedForks;
}
Graph *getJoinedForkTarget(CapturedCommandId cmdId) {
auto it = joinedForks.find(cmdId);
if (joinedForks.end() == it) {
return nullptr;
}
return it->second.forkDestiny;
}
const StackVec<Graph *, 16> &getSubgraphs() {
return subGraphs;
}
L0::Context *getContext() const {
return ctx;
}
struct CaptureTargetDesc {
ze_device_handle_t hDevice = nullptr;
ze_command_list_desc_t desc{};
};
const CaptureTargetDesc &getCaptureTargetDesc() const {
return captureTargetDesc;
}
bool empty() const {
return commands.empty();
}
bool validForInstantiation() const {
return closed() && unjoinedForks.empty() && std::all_of(subGraphs.begin(), subGraphs.end(), [](auto it) { return it->validForInstantiation(); });
}
bool valid() const {
return unjoinedForks.empty() && std::all_of(subGraphs.begin(), subGraphs.end(), [](auto it) { return it->valid(); });
}
bool closed() const {
return wasCapturingStopped;
}
L0::CommandList *getExecutionTarget() const {
return executionTarget;
}
bool isSubGraph() const {
return (nullptr != executionTarget);
}
bool hasUnjoinedForks() const {
return false == unjoinedForks.empty();
}
void tryJoinOnNextCommand(L0::CommandList &childCmdList, L0::Event &joinEvent);
void forkTo(L0::CommandList &childCmdList, Graph *&child, L0::Event &forkEvent);
void registerSignallingEventFromPreviousCommand(L0::Event &ev);
ClosureExternalStorage &getExternalStorage() {
return externalStorage;
}
const ClosureExternalStorage &getExternalStorage() const {
return externalStorage;
}
protected:
void unregisterSignallingEvents();
ClosureExternalStorage externalStorage;
CaptureTargetDesc captureTargetDesc;
std::vector<CapturedCommand> commands;
StackVec<Graph *, 16> subGraphs;
std::unordered_map<L0::Event *, CapturedCommandId> recordedSignals;
std::unordered_map<L0::CommandList *, ForkInfo> unjoinedForks;
std::unordered_map<CapturedCommandId, ForkJoinInfo> joinedForks;
L0::CommandList *captureSrc = nullptr;
L0::CommandList *executionTarget = nullptr;
L0::Context *ctx = nullptr;
bool preallocated = false;
bool wasCapturingStopped = false;
};
void recordHandleWaitEventsFromNextCommand(L0::CommandList &srcCmdList, Graph *&captureTarget, std::span<ze_event_handle_t> events);
void recordHandleSignalEventFromPreviousCommand(L0::CommandList &srcCmdList, Graph &captureTarget, ze_event_handle_t event);
template <CaptureApi api, typename... TArgs>
ze_result_t captureCommand(L0::CommandList &srcCmdList, Graph *&captureTarget, TArgs... apiArgs) {
if (false == areGraphsEnabled()) {
return ZE_RESULT_ERROR_NOT_AVAILABLE;
}
auto eventsWaitList = getCommandsWaitEventsList<api>(apiArgs...);
if ((false == eventsWaitList.empty()) && ((nullptr == captureTarget) || (captureTarget->hasUnjoinedForks()))) { // either is not capturing and is potential fork or this can be a join operation
recordHandleWaitEventsFromNextCommand(srcCmdList, captureTarget, eventsWaitList);
}
if (nullptr == captureTarget) {
return ZE_RESULT_ERROR_NOT_AVAILABLE;
}
auto ret = captureTarget->capture<api>(apiArgs...);
if (ZE_RESULT_SUCCESS != ret) {
return ret;
}
if (getCommandsSignalEvent<api>(apiArgs...)) {
recordHandleSignalEventFromPreviousCommand(srcCmdList, *captureTarget, getCommandsSignalEvent<api>(apiArgs...));
}
return ZE_RESULT_SUCCESS;
}
struct ExecutableGraph;
using GraphSubmissionSegment = std::variant<L0::CommandList *, ExecutableGraph *>;
using GraphSubmissionChain = std::vector<GraphSubmissionSegment>;
void handleExternalCbEvent(L0::Event *event, ExternalCbEventInfoContainer &container);
struct GraphInstatiateSettings {
GraphInstatiateSettings() = default;
GraphInstatiateSettings(void *pNext) {
UNRECOVERABLE_IF(nullptr != pNext);
}
enum ForkPolicy {
ForkPolicyMonolythicLevels, // build and submit monolythic commandlists for each level
ForkPolicySplitLevels // split commandlists on forks and interleave submission with child graphs (prevents deadlocks when submitting to single HW queue)
};
ForkPolicy forkPolicy = ForkPolicySplitLevels;
};
struct ExecutableGraph : _ze_executable_graph_handle_t {
ExecutableGraph();
ze_result_t instantiateFrom(Graph &graph, const GraphInstatiateSettings &settings);
ze_result_t instantiateFrom(Graph &graph) {
return instantiateFrom(graph, {});
}
~ExecutableGraph();
static ExecutableGraph *fromHandle(ze_executable_graph_handle_t handle) {
return static_cast<ExecutableGraph *>(handle);
}
inline ze_executable_graph_handle_t toHandle() { return this; }
bool empty() {
return myCommandLists.empty();
}
bool isSubGraph() const {
return (nullptr != executionTarget);
}
const StackVec<std::unique_ptr<ExecutableGraph>, 16> &getSubgraphs() {
return subGraphs;
}
ze_result_t execute(L0::CommandList *executionTarget, void *pNext, ze_event_handle_t hSignalEvent, uint32_t numWaitEvents, ze_event_handle_t *phWaitEvents);
ExternalCbEventInfoContainer &getExternalCbEventInfoContainer() {
return externalCbEventStorage;
}
protected:
L0::CommandList *allocateAndAddCommandListSubmissionNode();
void addSubGraphSubmissionNode(ExecutableGraph *subGraph);
Graph *src = nullptr;
L0::CommandList *executionTarget = nullptr;
std::vector<std::unique_ptr<L0::CommandList>> myCommandLists;
ExternalCbEventInfoContainer externalCbEventStorage;
StackVec<std::unique_ptr<ExecutableGraph>, 16> subGraphs;
GraphSubmissionChain submissionChain;
bool multiEngineGraph = false;
bool usePatchingPreamble = true;
};
constexpr size_t maxVariantSize = 2 * 64;
#define RR_CAPTURED_API(X) \
static_assert(sizeof(Closure<CaptureApi::X>) <= maxVariantSize, #X " is too big for common variant. Please export some of its state to ClosureExternalStorage");
RR_CAPTURED_APIS()
#undef RR_CAPTURED_API
} // namespace L0
|