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
|
/*
* Copyright (C) 2020-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#pragma once
#include "tracing.h"
#include "ze_api.h"
#include "ze_tracing_cb_structs.h"
#include <atomic>
#include <chrono>
#include <iostream>
#include <list>
#include <mutex>
#include <thread>
#include <vector>
#define UNRECOVERABLE_IF(expression) \
\
if (expression) { \
std::cout << "Abort was called at " << __LINE__ \
<< " line in file: " << __FILE__ << std::endl; \
std::abort(); \
}
namespace tracing_layer {
extern thread_local ze_bool_t tracingInProgress;
extern struct APITracerContextImp *pGlobalAPITracerContextImp;
typedef struct tracer_array_entry {
zel_ze_all_callbacks_t corePrologues;
zel_ze_all_callbacks_t coreEpilogues;
zel_zer_all_callbacks_t runtimePrologues;
zel_zer_all_callbacks_t runtimeEpilogues;
void *pUserData;
} tracer_array_entry_t;
typedef struct tracerArray {
size_t tracerArrayCount;
tracer_array_entry_t *tracerArrayEntries;
} tracer_array_t;
typedef enum tracingState {
disabledState, // tracing has never been enabled
enabledState, // tracing is enabled.
disabledWaitingState, // tracing has been disabled, but not waited for
} tracingState_t;
struct APITracerImp : APITracer {
ze_result_t destroyTracer(zel_tracer_handle_t phTracer) override;
ze_result_t setPrologues(zel_core_callbacks_t *pCoreCbs) override;
ze_result_t setEpilogues(zel_core_callbacks_t *pCoreCbs) override;
zel_ze_all_callbacks_t& getZeProEpilogues(zel_tracer_reg_t callback_type, ze_result_t& result) override;
zel_zer_all_callbacks_t &getZerProEpilogues(zel_tracer_reg_t callback_type, ze_result_t &result) override;
ze_result_t resetAllCallbacks() override;
ze_result_t enableTracer(ze_bool_t enable) override;
tracer_array_entry_t tracerFunctions;
tracingState_t tracingState;
private:
void copyCoreCbsToAllCbs(zel_ze_all_callbacks_t& allCbs, zel_core_callbacks_t& Cbs);
};
class ThreadPrivateTracerData {
public:
void clearThreadTracerDataOnList(void) { onList = false; }
void removeThreadTracerDataFromList(void);
bool testAndSetThreadTracerDataInitializedAndOnList(void);
bool onList;
bool isInitialized;
ThreadPrivateTracerData();
~ThreadPrivateTracerData();
std::atomic<tracer_array_t *> tracerArrayPointer;
private:
ThreadPrivateTracerData(const ThreadPrivateTracerData &);
ThreadPrivateTracerData &operator=(const ThreadPrivateTracerData &);
};
struct APITracerContextImp : APITracerContext {
public:
APITracerContextImp() {
activeTracerArray.store(&emptyTracerArray, std::memory_order_relaxed);
};
~APITracerContextImp() override;
static void apiTracingEnable(ze_init_flag_t flag);
void *getActiveTracersList() override;
void releaseActivetracersList() override;
ze_result_t enableTracingImp(struct APITracerImp *newTracer,
ze_bool_t enable);
ze_result_t finalizeDisableImpTracingWait(struct APITracerImp *oldTracer);
bool isTracingEnabled();
void addThreadTracerDataToList(ThreadPrivateTracerData *threadDataP);
void removeThreadTracerDataFromList(ThreadPrivateTracerData *threadDataP);
private:
std::mutex traceTableMutex;
tracer_array_t emptyTracerArray = {0, NULL};
std::atomic<tracer_array_t *> activeTracerArray;
//
// a list of tracer arrays that were once active, but
// have been replaced by a new active array. These
// once-active tracer arrays may continue for some time
// to have references to them among the per-thread
// tracer array pointers.
//
std::list<tracer_array_t *> retiringTracerArrayList;
std::list<struct APITracerImp *> enabledTracerImpList;
ze_bool_t testForTracerArrayReferences(tracer_array_t *tracerArray);
size_t testAndFreeRetiredTracers();
size_t updateTracerArrays();
std::list<ThreadPrivateTracerData *> threadTracerDataList;
std::mutex threadTracerDataListMutex;
};
extern thread_local ThreadPrivateTracerData myThreadPrivateTracerData;
template <class T>
class APITracerCallbackStateImp {
public:
T current_api_callback;
void *pUserData;
};
template <class T>
class APITracerCallbackDataImp {
public:
T apiOrdinal = nullptr;
std::vector<tracing_layer::APITracerCallbackStateImp<T>> prologCallbacks;
std::vector<tracing_layer::APITracerCallbackStateImp<T>> epilogCallbacks;
};
#define ZE_HANDLE_TRACER_RECURSION(ze_api_ptr, ...) \
do { \
if (tracing_layer::tracingInProgress) { \
return ze_api_ptr(__VA_ARGS__); \
} \
tracing_layer::tracingInProgress = 1; \
} while (0)
#define ZE_GEN_TRACER_ARRAY_ENTRY(callbackPtr, tracerArray, tracerArrayIndex, \
callbackType, callbackCategory, \
callbackFunction) \
do { \
callbackPtr = tracerArray->tracerArrayEntries[tracerArrayIndex] \
.callbackType.callbackCategory.callbackFunction; \
} while (0)
#define ZE_GEN_PER_API_CALLBACK_STATE(perApiCallbackData, tracerType, \
callbackCategory, callbackFunctionType) \
tracing_layer::tracer_array_t *currentTracerArray; \
currentTracerArray = \
(tracing_layer::tracer_array_t *) \
tracing_layer::pGlobalAPITracerContextImp->getActiveTracersList(); \
if (currentTracerArray) { \
for (size_t i = 0; i < currentTracerArray->tracerArrayCount; i++) { \
tracerType prologueCallbackPtr; \
tracerType epilogue_callback_ptr; \
ZE_GEN_TRACER_ARRAY_ENTRY(prologueCallbackPtr, currentTracerArray, i, \
corePrologues, callbackCategory, \
callbackFunctionType); \
ZE_GEN_TRACER_ARRAY_ENTRY(epilogue_callback_ptr, currentTracerArray, i, \
coreEpilogues, callbackCategory, \
callbackFunctionType); \
\
tracing_layer::APITracerCallbackStateImp<tracerType> prologCallback; \
prologCallback.current_api_callback = prologueCallbackPtr; \
prologCallback.pUserData = \
currentTracerArray->tracerArrayEntries[i].pUserData; \
perApiCallbackData.prologCallbacks.push_back(prologCallback); \
\
tracing_layer::APITracerCallbackStateImp<tracerType> epilogCallback; \
epilogCallback.current_api_callback = epilogue_callback_ptr; \
epilogCallback.pUserData = \
currentTracerArray->tracerArrayEntries[i].pUserData; \
perApiCallbackData.epilogCallbacks.push_back(epilogCallback); \
} \
}
#define ZER_GEN_PER_API_CALLBACK_STATE(perApiCallbackData, tracerType, \
callbackCategory, callbackFunctionType) \
tracing_layer::tracer_array_t *currentTracerArray; \
currentTracerArray = \
(tracing_layer::tracer_array_t *) \
tracing_layer::pGlobalAPITracerContextImp->getActiveTracersList(); \
if (currentTracerArray) { \
for (size_t i = 0; i < currentTracerArray->tracerArrayCount; i++){ \
tracerType prologueCallbackPtr; \
tracerType epilogue_callback_ptr; \
ZE_GEN_TRACER_ARRAY_ENTRY(prologueCallbackPtr, currentTracerArray, i, \
runtimePrologues, callbackCategory, \
callbackFunctionType); \
ZE_GEN_TRACER_ARRAY_ENTRY(epilogue_callback_ptr, currentTracerArray, i, \
runtimeEpilogues, callbackCategory, \
callbackFunctionType); \
\
tracing_layer::APITracerCallbackStateImp<tracerType> prologCallback; \
prologCallback.current_api_callback = prologueCallbackPtr; \
prologCallback.pUserData = \
currentTracerArray->tracerArrayEntries[i].pUserData; \
perApiCallbackData.prologCallbacks.push_back(prologCallback); \
\
tracing_layer::APITracerCallbackStateImp<tracerType> epilogCallback; \
epilogCallback.current_api_callback = epilogue_callback_ptr; \
epilogCallback.pUserData = \
currentTracerArray->tracerArrayEntries[i].pUserData; \
perApiCallbackData.epilogCallbacks.push_back(epilogCallback); \
} \
}
template <typename TRet, typename TFunction_pointer, typename TParams, typename TTracer,
typename TTracerPrologCallbacks, typename TTracerEpilogCallbacks,
typename... Args>
TRet
APITracerWrapperImp(TFunction_pointer zeApiPtr, TParams paramsStruct,
TTracer apiOrdinal, TTracerPrologCallbacks prologCallbacks,
TTracerEpilogCallbacks epilogCallbacks, Args &&...args)
{
TRet ret {};
std::vector<APITracerCallbackStateImp<TTracer>> *callbacks_prologs =
&prologCallbacks;
std::vector<void *> ppTracerInstanceUserData;
ppTracerInstanceUserData.resize(callbacks_prologs->size());
for (size_t i = 0; i < callbacks_prologs->size(); i++) {
if (callbacks_prologs->at(i).current_api_callback != nullptr)
callbacks_prologs->at(i).current_api_callback(
paramsStruct, ret, callbacks_prologs->at(i).pUserData,
&ppTracerInstanceUserData[i]);
}
ret = zeApiPtr(args...);
std::vector<APITracerCallbackStateImp<TTracer>> *callbacksEpilogs =
&epilogCallbacks;
for (size_t i = 0; i < callbacksEpilogs->size(); i++) {
if (callbacksEpilogs->at(i).current_api_callback != nullptr)
callbacksEpilogs->at(i).current_api_callback(
paramsStruct, ret, callbacksEpilogs->at(i).pUserData,
&ppTracerInstanceUserData[i]);
}
tracing_layer::tracingInProgress = 0;
tracing_layer::pGlobalAPITracerContextImp->releaseActivetracersList();
return ret;
}
} // namespace tracing_layer
|
