[SYCL][XPTI] Add support for tracing Level Zero API calls #6023
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| //===-------------- tracing.cpp - Level-Zero Host API Tracing --------------==// | ||
| // | ||
| // 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 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #include "xpti/xpti_data_types.h" | ||
| #include <exception> | ||
| #include <level_zero/layers/zel_tracing_api.h> | ||
| #include <level_zero/ze_api.h> | ||
| #include <xpti/xpti_trace_framework.h> | ||
|
|
||
| #include <iostream> | ||
|
|
||
| constexpr auto ZE_CALL_STREAM_NAME = "sycl.experimental.level_zero.call"; | ||
| constexpr auto ZE_DEBUG_STREAM_NAME = "sycl.experimental.level_zero.debug"; | ||
|
|
||
| thread_local uint64_t CallCorrelationID = 0; | ||
| thread_local uint64_t DebugCorrelationID = 0; | ||
|
|
||
| constexpr auto GVerStr = "0.1"; | ||
| constexpr int GMajVer = 0; | ||
| constexpr int GMinVer = 1; | ||
|
|
||
| #ifdef XPTI_ENABLE_INSTRUMENTATION | ||
| static xpti_td *GCallEvent = nullptr; | ||
| static xpti_td *GDebugEvent = nullptr; | ||
| #endif // XPTI_ENABLE_INSTRUMENTATION | ||
|
|
||
| enum class ZEApiKind { | ||
| #define _ZE_API(call, domain, cb, params_type) call, | ||
| #include "ze_api.def" | ||
| #undef _ZE_API | ||
| }; | ||
|
|
||
| void enableZeTracing() { | ||
| #ifdef XPTI_ENABLE_INSTRUMENTATION | ||
| if (!xptiTraceEnabled()) | ||
| return; | ||
|
|
||
| xptiRegisterStream(ZE_CALL_STREAM_NAME); | ||
| xptiInitialize(ZE_CALL_STREAM_NAME, GMajVer, GMinVer, GVerStr); | ||
| xptiRegisterStream(ZE_DEBUG_STREAM_NAME); | ||
| xptiInitialize(ZE_DEBUG_STREAM_NAME, GMajVer, GMinVer, GVerStr); | ||
|
|
||
| uint64_t Dummy; | ||
| xpti::payload_t ZePayload("Level Zero Plugin Layer"); | ||
| GCallEvent = | ||
| xptiMakeEvent("Level Zero Plugin Layer", &ZePayload, | ||
| xpti::trace_algorithm_event, xpti_at::active, &Dummy); | ||
|
|
||
| xpti::payload_t ZeDebugPayload("Level Zero Plugin Debug Layer"); | ||
| GDebugEvent = | ||
| xptiMakeEvent("Level Zero Plugin Debug Layer", &ZeDebugPayload, | ||
| xpti::trace_algorithm_event, xpti_at::active, &Dummy); | ||
|
|
||
| ze_result_t Status = zeInit(0); | ||
| if (Status != ZE_RESULT_SUCCESS) { | ||
| // Most likey there are no Level Zero devices. | ||
| return; | ||
| } | ||
|
|
||
| int Foo = 0; | ||
| zel_tracer_desc_t TracerDesc = {ZEL_STRUCTURE_TYPE_TRACER_EXP_DESC, nullptr, | ||
| &Foo}; | ||
| zel_tracer_handle_t Tracer = nullptr; | ||
|
|
||
| Status = zelTracerCreate(&TracerDesc, &Tracer); | ||
|
|
||
| if (Status != ZE_RESULT_SUCCESS || Tracer == nullptr) { | ||
| std::cerr << "[WARNING] Failed to create Level Zero tracer: " << Status | ||
| << "\n"; | ||
| return; | ||
| } | ||
|
|
||
| zel_core_callbacks_t Prologue = {}; | ||
| zel_core_callbacks_t Epilogue = {}; | ||
|
|
||
| #define _ZE_API(call, domain, cb, params_type) \ | ||
| Prologue.domain.cb = [](params_type *Params, ze_result_t, void *, void **) { \ | ||
| if (xptiTraceEnabled()) { \ | ||
| uint8_t CallStreamID = xptiRegisterStream(ZE_CALL_STREAM_NAME); \ | ||
| uint8_t DebugStreamID = xptiRegisterStream(ZE_DEBUG_STREAM_NAME); \ | ||
| CallCorrelationID = xptiGetUniqueId(); \ | ||
| DebugCorrelationID = xptiGetUniqueId(); \ | ||
| const char *FuncName = #call; \ | ||
| xptiNotifySubscribers( \ | ||
| CallStreamID, (uint16_t)xpti::trace_point_type_t::function_begin, \ | ||
| GCallEvent, nullptr, CallCorrelationID, FuncName); \ | ||
| uint32_t FuncID = static_cast<uint32_t>(ZEApiKind::call); \ | ||
| xpti::function_with_args_t Payload{FuncID, FuncName, Params, nullptr, \ | ||
| nullptr}; \ | ||
| xptiNotifySubscribers( \ | ||
| DebugStreamID, \ | ||
| (uint16_t)xpti::trace_point_type_t::function_with_args_begin, \ | ||
| GDebugEvent, nullptr, DebugCorrelationID, &Payload); \ | ||
| } \ | ||
| }; \ | ||
| Epilogue.domain.cb = [](params_type *Params, ze_result_t Result, void *, \ | ||
| void **) { \ | ||
| if (xptiTraceEnabled()) { \ | ||
| uint8_t CallStreamID = xptiRegisterStream(ZE_CALL_STREAM_NAME); \ | ||
| uint8_t DebugStreamID = xptiRegisterStream(ZE_DEBUG_STREAM_NAME); \ | ||
| const char *FuncName = #call; \ | ||
| xptiNotifySubscribers(CallStreamID, \ | ||
| (uint16_t)xpti::trace_point_type_t::function_end, \ | ||
| GCallEvent, nullptr, CallCorrelationID, FuncName); \ | ||
| uint32_t FuncID = static_cast<uint32_t>(ZEApiKind::call); \ | ||
| xpti::function_with_args_t Payload{FuncID, FuncName, Params, &Result, \ | ||
| nullptr}; \ | ||
| xptiNotifySubscribers( \ | ||
| DebugStreamID, \ | ||
| (uint16_t)xpti::trace_point_type_t::function_with_args_end, \ | ||
| GDebugEvent, nullptr, DebugCorrelationID, &Payload); \ | ||
| } \ | ||
| }; | ||
|
|
||
| #include "ze_api.def" | ||
|
|
||
| #undef _ZE_API | ||
|
|
||
| Status = zelTracerSetPrologues(Tracer, &Prologue); | ||
| if (Status != ZE_RESULT_SUCCESS) { | ||
| std::cerr << "Failed to enable Level Zero tracing\n"; | ||
| std::terminate(); | ||
| } | ||
| Status = zelTracerSetEpilogues(Tracer, &Epilogue); | ||
| if (Status != ZE_RESULT_SUCCESS) { | ||
| std::cerr << "Failed to enable Level Zero tracing\n"; | ||
| std::terminate(); | ||
| } | ||
|
|
||
| Status = zelTracerSetEnabled(Tracer, true); | ||
| if (Status != ZE_RESULT_SUCCESS) { | ||
| std::cerr << "Failed to enable Level Zero tracing\n"; | ||
| std::terminate(); | ||
| } | ||
| #endif // XPTI_ENABLE_INSTRUMENTATION | ||
| } | ||
|
|
||
| void disableZeTracing() { | ||
| #ifdef XPTI_ENABLE_INSTRUMENTATION | ||
| if (!xptiTraceEnabled()) | ||
| return; | ||
|
|
||
| xptiFinalize(ZE_CALL_STREAM_NAME); | ||
| xptiFinalize(ZE_DEBUG_STREAM_NAME); | ||
| #endif // XPTI_ENABLE_INSTRUMENTATION | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| import re | ||
| import sys | ||
|
|
||
| def camel_to_snake(src): | ||
| return re.sub(r'(?<!^)(?=[A-Z])', '_', src).lower() | ||
|
|
||
| def snake_to_camel(src): | ||
| temp = src.split('_') | ||
| return ''.join(x.title() for x in temp) | ||
|
|
||
|
|
||
| def extract_ze_apis(header): | ||
| """ | ||
| Emit file with contents of | ||
| _ZE_API(api_name, api_domain, cb, param_type) | ||
| """ | ||
| api = open("ze_api.def", "w") | ||
|
|
||
| matches = re.finditer(r'typedef struct _ze_([_a-z]+)_callbacks_t\n\{\n([a-zA-Z_;\s\n]+)\n\} ze_([_a-z]+)_callbacks_t;', header) | ||
|
|
||
| for match in matches: | ||
| api_domain = snake_to_camel(match.group(1)) | ||
| for l in match.group(2).splitlines(): | ||
| parts = l.split() | ||
| api_match = re.match(r'ze_pfn([a-zA-Z]+)Cb_t', parts[0]) | ||
| api_name_tail = api_match.group(1) | ||
| api_name = 'ze' + api_name_tail | ||
|
|
||
| param_type = 'ze_' + camel_to_snake(api_name_tail) + '_params_t' | ||
|
|
||
| cb = 'pfn' + api_name_tail.replace(api_domain, '') + 'Cb' | ||
|
|
||
| api.write("_ZE_API({}, {}, {}, {})\n".format(api_name, api_domain, cb, param_type)) | ||
|
|
||
| api.close() | ||
|
|
||
| if __name__ == "__main__": | ||
| with open(sys.argv[1], 'r') as f: | ||
| header = f.read() | ||
| extract_ze_apis(header) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.