Skip to content

Commit dbc85c4

Browse files
joshuaranjanCompute-Runtime-Automation
joshuaranjan
authored and
Compute-Runtime-Automation
committed
feature: add support for metric markers
Related-To: NEO-12058 Signed-off-by: Joshua Santosh Ranjan <[email protected]>
1 parent c63ac8a commit dbc85c4

File tree

12 files changed

+179
-10
lines changed

12 files changed

+179
-10
lines changed

‎level_zero/api/driver_experimental/public/CMakeLists.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (C) 2020-2024 Intel Corporation
2+
# Copyright (C) 2020-2025 Intel Corporation
33
#
44
# SPDX-License-Identifier: MIT
55
#
@@ -14,4 +14,5 @@ target_sources(${L0_STATIC_LIB_NAME}
1414
${CMAKE_CURRENT_SOURCE_DIR}/zex_event.cpp
1515
${CMAKE_CURRENT_SOURCE_DIR}/zex_memory.cpp
1616
${CMAKE_CURRENT_SOURCE_DIR}/zex_module.cpp
17+
${CMAKE_CURRENT_SOURCE_DIR}/zex_metric.cpp
1718
)

‎level_zero/api/driver_experimental/public/zex_metric.cpp

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/*
2+
* Copyright (C) 2025 Intel Corporation
3+
*
4+
* SPDX-License-Identifier: MIT
5+
*
6+
*/
7+
8+
#include "level_zero/tools/source/metrics/metric.h"
9+
#include "level_zero/zet_intel_gpu_metric.h"
10+
11+
namespace L0 {
12+
13+
ze_result_t ZE_APICALL zetIntelCommandListAppendMarkerExp(zet_command_list_handle_t hCommandList,
14+
zet_metric_group_handle_t hMetricGroup,
15+
uint32_t value) {
16+
17+
auto metricGroupImp = static_cast<MetricGroupImp *>(L0::MetricGroup::fromHandle(hMetricGroup));
18+
return metricGroupImp->getMetricSource().appendMarker(hCommandList, hMetricGroup, value);
19+
}
20+
21+
} // namespace L0
22+
23+
extern "C" {
24+
25+
ze_result_t ZE_APICALL
26+
zetIntelCommandListAppendMarkerExp(
27+
zet_command_list_handle_t hCommandList,
28+
zet_metric_group_handle_t hMetricGroup,
29+
uint32_t value) {
30+
return L0::zetIntelCommandListAppendMarkerExp(hCommandList, hMetricGroup, value);
31+
}
32+
}

‎level_zero/core/source/driver/driver_handle_imp_helper.cpp

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#include "level_zero/core/source/driver/driver_handle_imp.h"
99
#include "level_zero/driver_experimental/zex_common.h"
1010
#include "level_zero/ze_intel_gpu.h"
11+
#include "level_zero/zet_intel_gpu_metric.h"
1112

1213
namespace L0 {
1314
const std::vector<std::pair<std::string, uint32_t>> DriverHandleImp::extensionsSupported = {
@@ -43,5 +44,8 @@ const std::vector<std::pair<std::string, uint32_t>> DriverHandleImp::extensionsS
4344
{ZEX_INTEL_EVENT_SYNC_MODE_EXP_NAME, ZEX_INTEL_EVENT_SYNC_MODE_EXP_VERSION_CURRENT},
4445
{ZE_INTEL_GET_DRIVER_VERSION_STRING_EXP_NAME, ZE_INTEL_GET_DRIVER_VERSION_STRING_EXP_VERSION_CURRENT},
4546
{ZE_INTEL_DEVICE_BLOCK_ARRAY_EXP_NAME, ZE_INTEL_DEVICE_BLOCK_ARRAY_EXP_PROPERTIES_VERSION_CURRENT},
46-
{ZE_INTEL_KERNEL_GET_PROGRAM_BINARY_EXP_NAME, ZE_INTEL_KERNEL_GET_PROGRAM_BINARY_EXP_VERSION_CURRENT}};
47+
{ZE_INTEL_KERNEL_GET_PROGRAM_BINARY_EXP_NAME, ZE_INTEL_KERNEL_GET_PROGRAM_BINARY_EXP_VERSION_CURRENT},
48+
49+
// Metrics Driver experimental extensions
50+
{ZET_INTEL_METRIC_APPEND_MARKER_EXP_NAME, ZET_INTEL_METRIC_APPEND_MARKER_EXP_VERSION_CURRENT}};
4751
} // namespace L0

‎level_zero/core/source/driver/extension_function_address.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2024 Intel Corporation
2+
* Copyright (C) 2024-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -62,6 +62,7 @@ void *ExtensionFunctionAddressHelper::getExtensionFunctionAddress(const std::str
6262
RETURN_FUNC_PTR_IF_EXIST(zeIntelCommandListAppendWaitExternalSemaphoresExp);
6363
RETURN_FUNC_PTR_IF_EXIST(zeIntelCommandListAppendSignalExternalSemaphoresExp);
6464
RETURN_FUNC_PTR_IF_EXIST(zeIntelDeviceReleaseExternalSemaphoreExp);
65+
RETURN_FUNC_PTR_IF_EXIST(zetIntelCommandListAppendMarkerExp);
6566

6667
#undef RETURN_FUNC_PTR_IF_EXIST
6768

‎level_zero/core/test/unit_tests/mocks/mock_cmdlist.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -725,6 +725,15 @@ class MockCommandListImmediateHw : public WhiteBox<::L0::CommandListCoreFamilyIm
725725
return executeCommandListImmediateWithFlushTaskReturnValue;
726726
}
727727

728+
ze_result_t appendWriteToMemory(void *desc, void *ptr,
729+
uint64_t data) override {
730+
++appendWriteToMemoryCalledCount;
731+
if (callAppendWriteToMemoryBase) {
732+
return BaseClass::appendWriteToMemory(desc, ptr, data);
733+
}
734+
return appendWriteToMemoryCalledCountReturnValue;
735+
}
736+
728737
void checkAssert() override {
729738
checkAssertCalled++;
730739
}
@@ -750,6 +759,10 @@ class MockCommandListImmediateHw : public WhiteBox<::L0::CommandListCoreFamilyIm
750759

751760
ze_result_t executeCommandListImmediateWithFlushTaskReturnValue = ZE_RESULT_SUCCESS;
752761
uint32_t executeCommandListImmediateWithFlushTaskCalledCount = 0;
762+
763+
bool callAppendWriteToMemoryBase = true;
764+
ze_result_t appendWriteToMemoryCalledCountReturnValue = ZE_RESULT_SUCCESS;
765+
uint32_t appendWriteToMemoryCalledCount = 0;
753766
};
754767

755768
struct CmdListHelper {

‎level_zero/include/level_zero/zet_intel_gpu_metric.h

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2023-2024 Intel Corporation
2+
* Copyright (C) 2023-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -22,6 +22,29 @@ extern "C" {
2222
#define ZET_INTEL_MAX_METRIC_GROUP_NAME_PREFIX_EXP 64u
2323
#define ZET_INTEL_METRIC_PROGRAMMABLE_PARAM_TYPE_GENERIC_EXP (0x7ffffffe)
2424

25+
#ifndef ZET_INTEL_METRIC_APPEND_MARKER_EXP_NAME
26+
/// @brief Extension name for query to read the Intel Level Zero Driver Version String
27+
#define ZET_INTEL_METRIC_APPEND_MARKER_EXP_NAME "ZET_intel_metric_append_marker"
28+
#endif // ZET_INTEL_APPEND_MARKER_EXP_NAME
29+
30+
///////////////////////////////////////////////////////////////////////////////
31+
/// @brief Append Marker extension Version(s)
32+
typedef enum _zet_intel_metric_append_marker_exp_version_t {
33+
ZET_INTEL_METRIC_APPEND_MARKER_EXP_VERSION_1_0 = ZE_MAKE_VERSION(1, 0), ///< version 1.0
34+
ZET_INTEL_METRIC_APPEND_MARKER_EXP_VERSION_CURRENT = ZE_MAKE_VERSION(1, 0), ///< latest known version
35+
ZET_INTEL_METRIC_APPEND_MARKER_EXP_VERSION_FORCE_UINT32 = 0x7fffffff
36+
} zet_intel_metric_append_marker_exp_version_t;
37+
38+
#define ZET_INTEL_METRIC_GROUP_TYPE_EXP_FLAG_MARKER (static_cast<zet_metric_group_type_exp_flag_t>(ZE_BIT(3))) // NOLINT(clang-analyzer-optin.core.EnumCastOutOfRange), NEO-12901
39+
40+
///////////////////////////////////////////////////////////////////////////////
41+
/// @brief Appends a metric marker to the command list based on the metricGroup
42+
/// Metrics can be generated by multiple sources in the HW
43+
/// This API generates a marker through the same source as the metric group
44+
ze_result_t ZE_APICALL zetIntelCommandListAppendMarkerExp(zet_command_list_handle_t hCommandList,
45+
zet_metric_group_handle_t hMetricGroup,
46+
uint32_t value);
47+
2548
#if defined(__cplusplus)
2649
} // extern "C"
2750
#endif

‎level_zero/tools/source/metrics/metric.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2020-2024 Intel Corporation
2+
* Copyright (C) 2020-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -89,6 +89,7 @@ class MetricSource {
8989
const char description[ZET_MAX_METRIC_GROUP_DESCRIPTION],
9090
uint32_t *maxMetricGroupCount,
9191
std::vector<zet_metric_group_handle_t> &metricGroupList) = 0;
92+
virtual ze_result_t appendMarker(zet_command_list_handle_t hCommandList, zet_metric_group_handle_t hMetricGroup, uint32_t value) = 0;
9293

9394
protected:
9495
uint32_t type = MetricSource::metricSourceTypeUndefined;

‎level_zero/tools/source/metrics/metric_ip_sampling_source.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2022-2024 Intel Corporation
2+
* Copyright (C) 2022-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -48,10 +48,14 @@ class IpSamplingMetricSourceImp : public MetricSource {
4848
std::vector<zet_metric_group_handle_t> &metricGroupList) override {
4949
return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
5050
}
51+
ze_result_t appendMarker(zet_command_list_handle_t hCommandList, zet_metric_group_handle_t hMetricGroup, uint32_t value) override {
52+
return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
53+
}
5154

5255
void setActivationTracker(MultiDomainDeferredActivationTracker *inputActivationTracker) {
5356
activationTracker.reset(inputActivationTracker);
5457
}
58+
5559
uint32_t metricSourceCount = 0;
5660

5761
protected:

‎level_zero/tools/source/metrics/metric_oa_source.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2022-2024 Intel Corporation
2+
* Copyright (C) 2022-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -59,6 +59,9 @@ class OaMetricSourceImp : public MetricSource {
5959
const char description[ZET_MAX_METRIC_GROUP_DESCRIPTION],
6060
uint32_t *maxMetricGroupCount,
6161
std::vector<zet_metric_group_handle_t> &metricGroupList) override;
62+
ze_result_t appendMarker(zet_command_list_handle_t hCommandList, zet_metric_group_handle_t hMetricGroup, uint32_t value) override {
63+
return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
64+
}
6265
void metricGroupCreate(const char name[ZET_MAX_METRIC_GROUP_NAME],
6366
const char description[ZET_MAX_METRIC_GROUP_DESCRIPTION],
6467
zet_metric_group_sampling_type_flag_t samplingType,

‎level_zero/tools/test/unit_tests/sources/metrics/mock_metric_source.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2020-2024 Intel Corporation
2+
* Copyright (C) 2020-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -38,6 +38,10 @@ class MockMetricSource : public L0::MetricSource {
3838
uint32_t *pCountPerConcurrentGroup) override {
3939
return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
4040
}
41+
ze_result_t appendMarker(zet_command_list_handle_t hCommandList, zet_metric_group_handle_t hMetricGroup, uint32_t value) override {
42+
return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
43+
}
44+
4145
void setType(uint32_t type) {
4246
this->type = type;
4347
}

‎level_zero/tools/test/unit_tests/sources/metrics/test_metric_ip_sampling_enumeration.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2022-2024 Intel Corporation
2+
* Copyright (C) 2022-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -262,6 +262,8 @@ HWTEST2_F(MetricIpSamplingEnumerationTest, GivenEnumerationIsSuccessfulThenUnsup
262262
EXPECT_EQ(zetContextActivateMetricGroups(context->toHandle(), device->toHandle(), 1, &metricGroups[0]), ZE_RESULT_SUCCESS);
263263
static_cast<DeviceImp *>(device)->activateMetricGroups();
264264
EXPECT_EQ(zetContextActivateMetricGroups(context->toHandle(), device->toHandle(), 0, nullptr), ZE_RESULT_SUCCESS);
265+
266+
EXPECT_EQ(zetIntelCommandListAppendMarkerExp(nullptr, metricGroups[0], 0), ZE_RESULT_ERROR_UNSUPPORTED_FEATURE);
265267
}
266268
}
267269

‎level_zero/tools/test/unit_tests/sources/metrics/test_metric_oa_enumeration_1.cpp

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (C) 2020-2024 Intel Corporation
2+
* Copyright (C) 2020-2025 Intel Corporation
33
*
44
* SPDX-License-Identifier: MIT
55
*
@@ -3346,5 +3346,86 @@ TEST_F(MetricEnumerationTest, givenValidArgumentsWhenZetGetMetricGroupProperties
33463346
EXPECT_EQ(metricGroupType.type, ZET_METRIC_GROUP_TYPE_EXP_FLAG_OTHER);
33473347
}
33483348

3349+
TEST_F(MetricEnumerationTest, givenValidArgumentsWhenAppendMarkerIsCalledThenReturnUnsupportedError) {
3350+
3351+
// Metrics Discovery device.
3352+
metricsDeviceParams.ConcurrentGroupsCount = 1;
3353+
3354+
// Metrics Discovery concurrent group.
3355+
Mock<IConcurrentGroup_1_13> metricsConcurrentGroup;
3356+
TConcurrentGroupParams_1_13 metricsConcurrentGroupParams = {};
3357+
metricsConcurrentGroupParams.MetricSetsCount = 1;
3358+
metricsConcurrentGroupParams.SymbolName = "OA";
3359+
metricsConcurrentGroupParams.Description = "OA description";
3360+
metricsConcurrentGroupParams.IoMeasurementInformationCount = 1;
3361+
3362+
Mock<MetricsDiscovery::IEquation_1_0> ioReadEquation;
3363+
MetricsDiscovery::TEquationElement_1_0 ioEquationElement = {};
3364+
ioEquationElement.Type = MetricsDiscovery::EQUATION_ELEM_IMM_UINT64;
3365+
ioEquationElement.ImmediateUInt64 = 0;
3366+
3367+
ioReadEquation.getEquationElement.push_back(&ioEquationElement);
3368+
3369+
Mock<MetricsDiscovery::IInformation_1_0> ioMeasurement;
3370+
MetricsDiscovery::TInformationParams_1_0 oaInformation = {};
3371+
oaInformation.SymbolName = "BufferOverflow";
3372+
oaInformation.IoReadEquation = &ioReadEquation;
3373+
metricsConcurrentGroup.GetIoMeasurementInformationResult = &ioMeasurement;
3374+
ioMeasurement.GetParamsResult = &oaInformation;
3375+
3376+
// Metrics Discovery:: metric set.
3377+
Mock<MetricsDiscovery::IMetricSet_1_13> metricsSet;
3378+
MetricsDiscovery::TMetricSetParams_1_11 metricsSetParams = {};
3379+
metricsSetParams.ApiMask = MetricsDiscovery::API_TYPE_OCL;
3380+
metricsSetParams.MetricsCount = 0;
3381+
metricsSetParams.SymbolName = "Metric set name";
3382+
metricsSetParams.ShortName = "Metric set description";
3383+
3384+
// One api: metric group handle.
3385+
zet_metric_group_handle_t metricGroupHandle = {};
3386+
3387+
openMetricsAdapter();
3388+
3389+
setupDefaultMocksForMetricDevice(metricsDevice);
3390+
3391+
metricsDevice.getConcurrentGroupResults.push_back(&metricsConcurrentGroup);
3392+
3393+
metricsConcurrentGroup.GetParamsResult = &metricsConcurrentGroupParams;
3394+
metricsConcurrentGroup.getMetricSetResult = &metricsSet;
3395+
3396+
metricsSet.GetParamsResult = &metricsSetParams;
3397+
3398+
// Metric group count.
3399+
uint32_t metricGroupCount = 0;
3400+
EXPECT_EQ(zetMetricGroupGet(device->toHandle(), &metricGroupCount, nullptr), ZE_RESULT_SUCCESS);
3401+
EXPECT_EQ(metricGroupCount, 1u);
3402+
3403+
// Metric group handle.
3404+
EXPECT_EQ(zetMetricGroupGet(device->toHandle(), &metricGroupCount, &metricGroupHandle), ZE_RESULT_SUCCESS);
3405+
EXPECT_EQ(metricGroupCount, 1u);
3406+
EXPECT_NE(metricGroupHandle, nullptr);
3407+
3408+
EXPECT_EQ(zetIntelCommandListAppendMarkerExp(nullptr, metricGroupHandle, 0), ZE_RESULT_ERROR_UNSUPPORTED_FEATURE);
3409+
}
3410+
3411+
using DriverVersionTest = Test<DeviceFixture>;
3412+
3413+
TEST_F(DriverVersionTest, givenSupportedExtensionsWhenCheckIfAppendMarkerIsSupportedThenCorrectResultsAreReturned) {
3414+
uint32_t count = 0;
3415+
ze_result_t res = driverHandle->getExtensionProperties(&count, nullptr);
3416+
EXPECT_NE(0u, count);
3417+
EXPECT_EQ(ZE_RESULT_SUCCESS, res);
3418+
3419+
std::vector<ze_driver_extension_properties_t> extensionProperties;
3420+
extensionProperties.resize(count);
3421+
3422+
res = driverHandle->getExtensionProperties(&count, extensionProperties.data());
3423+
EXPECT_EQ(ZE_RESULT_SUCCESS, res);
3424+
3425+
auto it = std::find_if(extensionProperties.begin(), extensionProperties.end(), [](const auto &extension) { return (strcmp(extension.name, ZET_INTEL_METRIC_APPEND_MARKER_EXP_NAME) == 0); });
3426+
EXPECT_NE(it, extensionProperties.end());
3427+
EXPECT_EQ((*it).version, ZET_INTEL_METRIC_APPEND_MARKER_EXP_VERSION_CURRENT);
3428+
}
3429+
33493430
} // namespace ult
33503431
} // namespace L0

0 commit comments

Comments
 (0)