| 1 |
/* |
| 2 |
* Copyright (C) 2020-2025 Intel Corporation |
| 3 |
* |
| 4 |
* SPDX-License-Identifier: MIT |
| 5 |
* |
| 6 |
*/ |
| 7 |
|
| 8 |
#pragma once |
| 9 |
#include "level_zero/core/source/device/device.h" |
| 10 |
#include "level_zero/core/test/unit_tests/fixtures/device_fixture.h" |
| 11 |
#include "level_zero/core/test/unit_tests/white_box.h" |
| 12 |
#include "level_zero/tools/source/metrics/metric.h" |
| 13 |
#include "level_zero/tools/source/metrics/metric_oa_enumeration_imp.h" |
| 14 |
#include "level_zero/tools/source/metrics/metric_oa_query_imp.h" |
| 15 |
|
| 16 |
namespace L0 { |
| 17 |
namespace ult { |
| 18 |
|
| 19 |
template <> |
| 20 |
struct WhiteBox<::L0::MetricGroup> : public ::L0::MetricGroup { |
| 21 |
using BaseClass = ::L0::MetricGroup; |
| 22 |
}; |
| 23 |
|
| 24 |
using MetricGroup = WhiteBox<::L0::MetricGroup>; |
| 25 |
|
| 26 |
using MetricsDiscovery::IAdapter_1_13; |
| 27 |
using MetricsDiscovery::IAdapter_1_6; |
| 28 |
using MetricsDiscovery::IAdapter_1_8; |
| 29 |
using MetricsDiscovery::IAdapter_1_9; |
| 30 |
using MetricsDiscovery::IAdapterGroup_1_13; |
| 31 |
using MetricsDiscovery::IAdapterGroup_1_6; |
| 32 |
using MetricsDiscovery::IAdapterGroup_1_8; |
| 33 |
using MetricsDiscovery::IAdapterGroup_1_9; |
| 34 |
using MetricsDiscovery::IAdapterGroupLatest; |
| 35 |
using MetricsDiscovery::IConcurrentGroup_1_13; |
| 36 |
using MetricsDiscovery::IConcurrentGroup_1_5; |
| 37 |
using MetricsDiscovery::IEquation_1_0; |
| 38 |
using MetricsDiscovery::IInformation_1_0; |
| 39 |
using MetricsDiscovery::IMetric_1_0; |
| 40 |
using MetricsDiscovery::IMetric_1_13; |
| 41 |
using MetricsDiscovery::IMetricsDevice_1_11; |
| 42 |
using MetricsDiscovery::IMetricsDevice_1_13; |
| 43 |
using MetricsDiscovery::IMetricsDevice_1_5; |
| 44 |
using MetricsDiscovery::IMetricsDeviceLatest; |
| 45 |
using MetricsDiscovery::IMetricSet_1_0; |
| 46 |
using MetricsDiscovery::IMetricSet_1_13; |
| 47 |
using MetricsDiscovery::IMetricSet_1_5; |
| 48 |
using MetricsDiscovery::IOverride_1_2; |
| 49 |
using MetricsDiscovery::TAdapterGroupParams_1_6; |
| 50 |
using MetricsDiscovery::TAdapterParams_1_6; |
| 51 |
using MetricsDiscovery::TAdapterParams_1_8; |
| 52 |
using MetricsDiscovery::TAdapterParams_1_9; |
| 53 |
using MetricsDiscovery::TCompletionCode; |
| 54 |
using MetricsDiscovery::TConcurrentGroupParams_1_0; |
| 55 |
using MetricsDiscovery::TConcurrentGroupParams_1_13; |
| 56 |
using MetricsDiscovery::TEngineParams_1_13; |
| 57 |
using MetricsDiscovery::TEngineParams_1_9; |
| 58 |
using MetricsDiscovery::TEquationElement_1_0; |
| 59 |
using MetricsDiscovery::TGlobalSymbol_1_0; |
| 60 |
using MetricsDiscovery::TMetricParams_1_0; |
| 61 |
using MetricsDiscovery::TMetricParams_1_13; |
| 62 |
using MetricsDiscovery::TMetricsDeviceParams_1_2; |
| 63 |
using MetricsDiscovery::TMetricSetParams_1_11; |
| 64 |
using MetricsDiscovery::TMetricSetParams_1_4; |
| 65 |
using MetricsDiscovery::TSamplingType; |
| 66 |
using MetricsDiscovery::TSubDeviceParams_1_9; |
| 67 |
using MetricsDiscovery::TTypedValue_1_0; |
| 68 |
|
| 69 |
struct MockMetricsDiscoveryApi { |
| 70 |
|
| 71 |
// Original api functions. |
| 72 |
static TCompletionCode MD_STDCALL openAdapterGroup(IAdapterGroupLatest **adapterGroup); |
| 73 |
|
| 74 |
IAdapterGroupLatest *adapterGroup = nullptr; |
| 75 |
}; |
| 76 |
|
| 77 |
template <> |
| 78 |
class Mock<IAdapterGroup_1_13> : public IAdapterGroup_1_13 { |
| 79 |
public: |
| 80 |
~Mock() override = default; |
| 81 |
|
| 82 |
ADDMETHOD_NOBASE(GetAdapter, IAdapter_1_13 *, nullptr, (uint32_t)); |
| 83 |
ADDMETHOD_CONST_NOBASE(GetParams, const TAdapterGroupParams_1_6 *, nullptr, ()); |
| 84 |
ADDMETHOD_NOBASE(Close, TCompletionCode, TCompletionCode::CC_OK, ()); |
| 85 |
}; |
| 86 |
|
| 87 |
template <> |
| 88 |
class Mock<IAdapter_1_13> : public IAdapter_1_13 { |
| 89 |
public: |
| 90 |
~Mock() override = default; |
| 91 |
|
| 92 |
// 1.13 |
| 93 |
ADDMETHOD_NOBASE(GetSubDeviceParams, const TSubDeviceParams_1_9 *, nullptr, (const uint32_t subDeviceIndex)); |
| 94 |
ADDMETHOD_NOBASE(GetEngineParams, const TEngineParams_1_13 *, nullptr, (const uint32_t subDeviceIndex, const uint32_t engineIndex)); |
| 95 |
ADDMETHOD_NOBASE(OpenMetricsSubDeviceFromFile, TCompletionCode, TCompletionCode::CC_OK, (const uint32_t subDeviceIndex, const char *fileName, void *openParams, IMetricsDevice_1_13 **metricsDevice)); |
| 96 |
ADDMETHOD_CONST_NOBASE(GetParams, const TAdapterParams_1_9 *, nullptr, ()); |
| 97 |
ADDMETHOD_NOBASE(Reset, TCompletionCode, TCompletionCode::CC_OK, ()); |
| 98 |
ADDMETHOD_NOBASE(OpenMetricsDeviceFromFile, TCompletionCode, TCompletionCode::CC_OK, (const char *, void *, IMetricsDevice_1_13 **)); |
| 99 |
ADDMETHOD_NOBASE(CloseMetricsDevice, TCompletionCode, TCompletionCode::CC_OK, (IMetricsDevice_1_5 *)); |
| 100 |
ADDMETHOD_NOBASE(SaveMetricsDeviceToFile, TCompletionCode, TCompletionCode::CC_OK, (const char *, void *, IMetricsDevice_1_11 *, const uint32_t, const uint32_t)); |
| 101 |
|
| 102 |
TCompletionCode OpenMetricsDevice(IMetricsDevice_1_13 **metricsDevice) override { |
| 103 |
*metricsDevice = openMetricsDeviceOutDevice; |
| 104 |
return openMetricsDeviceResult; |
| 105 |
} |
| 106 |
|
| 107 |
TCompletionCode OpenMetricsSubDevice(const uint32_t subDeviceIndex, IMetricsDevice_1_13 **metricsDevice) override { |
| 108 |
*metricsDevice = openMetricsSubDeviceOutDevice; |
| 109 |
return openMetricsSubDeviceResult; |
| 110 |
} |
| 111 |
|
| 112 |
IMetricsDevice_1_13 *openMetricsSubDeviceOutDevice = nullptr; |
| 113 |
IMetricsDevice_1_13 *openMetricsDeviceOutDevice = nullptr; |
| 114 |
TCompletionCode openMetricsSubDeviceResult = TCompletionCode::CC_OK; |
| 115 |
TCompletionCode openMetricsDeviceResult = TCompletionCode::CC_OK; |
| 116 |
}; |
| 117 |
|
| 118 |
template <> |
| 119 |
class Mock<IMetricsDevice_1_13> : public IMetricsDevice_1_13 { |
| 120 |
public: |
| 121 |
~Mock() override = default; |
| 122 |
|
| 123 |
ADDMETHOD_NOBASE(GetParams, TMetricsDeviceParams_1_2 *, nullptr, ()); |
| 124 |
ADDMETHOD_NOBASE(GetOverride, IOverride_1_2 *, nullptr, (uint32_t index)); |
| 125 |
ADDMETHOD_NOBASE(GetOverrideByName, IOverride_1_2 *, nullptr, (const char *symbolName)); |
| 126 |
ADDMETHOD_NOBASE(GetGlobalSymbol, TGlobalSymbol_1_0 *, nullptr, (uint32_t index)); |
| 127 |
ADDMETHOD_NOBASE(GetLastError, TCompletionCode, TCompletionCode::CC_OK, ()); |
| 128 |
ADDMETHOD_NOBASE(GetGpuCpuTimestamps, TCompletionCode, TCompletionCode::CC_OK, (uint64_t *, uint64_t *, uint32_t *, uint64_t *)); |
| 129 |
|
| 130 |
IConcurrentGroup_1_13 *GetConcurrentGroup(uint32_t index) override { |
| 131 |
return getConcurrentGroupResults[index]; |
| 132 |
} |
| 133 |
|
| 134 |
MetricsDiscovery::TTypedValue_1_0 symbolValue = {}; |
| 135 |
bool forceGetSymbolByNameFail = false; |
| 136 |
bool forceGetGpuCpuTimestampsFail = false; |
| 137 |
TTypedValue_1_0 *GetGlobalSymbolValueByName(const char *name) override { |
| 138 |
bool found = false; |
| 139 |
if (forceGetSymbolByNameFail) { |
| 140 |
return nullptr; |
| 141 |
} else if (std::strcmp(name, "OABufferMaxSize") == 0) { |
| 142 |
symbolValue.ValueType = MetricsDiscovery::TValueType::VALUE_TYPE_UINT32; |
| 143 |
symbolValue.ValueUInt32 = 1024; |
| 144 |
found = true; |
| 145 |
} else if (std::strcmp(name, "MaxTimestamp") == 0) { |
| 146 |
symbolValue.ValueType = MetricsDiscovery::TValueType::VALUE_TYPE_UINT64; |
| 147 |
symbolValue.ValueUInt64 = 171798691800UL; // PVC as reference |
| 148 |
found = true; |
| 149 |
} else if (std::strcmp(name, "GpuTimestampFrequency") == 0) { |
| 150 |
symbolValue.ValueType = MetricsDiscovery::TValueType::VALUE_TYPE_UINT64; |
| 151 |
symbolValue.ValueUInt64 = 25000000UL; // PVC as reference |
| 152 |
found = true; |
| 153 |
} |
| 154 |
if (found) { |
| 155 |
return &symbolValue; |
| 156 |
} |
| 157 |
|
| 158 |
return nullptr; |
| 159 |
} |
| 160 |
|
| 161 |
TCompletionCode GetGpuCpuTimestamps(uint64_t *gpuTimestampNs, uint64_t *cpuTimestampNs, uint32_t *cpuId) override { |
| 162 |
if (forceGetGpuCpuTimestampsFail) { |
| 163 |
*gpuTimestampNs = 0; |
| 164 |
*cpuTimestampNs = 0; |
| 165 |
*cpuId = 0; |
| 166 |
return MetricsDiscovery::CC_ERROR_GENERAL; |
| 167 |
} |
| 168 |
|
| 169 |
*gpuTimestampNs += 10; |
| 170 |
*cpuTimestampNs += 10; |
| 171 |
*cpuId = 0; |
| 172 |
return MetricsDiscovery::CC_OK; |
| 173 |
} |
| 174 |
|
| 175 |
std::vector<IConcurrentGroup_1_13 *> getConcurrentGroupResults; |
| 176 |
}; |
| 177 |
|
| 178 |
template <> |
| 179 |
class Mock<IConcurrentGroup_1_13> : public IConcurrentGroup_1_13 { |
| 180 |
public: |
| 181 |
~Mock() override = default; |
| 182 |
|
| 183 |
ADDMETHOD_NOBASE(GetParams, TConcurrentGroupParams_1_13 *, nullptr, ()); |
| 184 |
ADDMETHOD_NOBASE(CloseIoStream, TCompletionCode, TCompletionCode::CC_OK, ()); |
| 185 |
ADDMETHOD_NOBASE(WaitForReports, TCompletionCode, TCompletionCode::CC_OK, (uint32_t milliseconds)); |
| 186 |
ADDMETHOD_NOBASE(SetIoStreamSamplingType, TCompletionCode, TCompletionCode::CC_OK, (TSamplingType type)); |
| 187 |
ADDMETHOD_NOBASE(GetIoMeasurementInformation, IInformation_1_0 *, nullptr, (uint32_t index)); |
| 188 |
ADDMETHOD_NOBASE(GetIoGpuContextInformation, IInformation_1_0 *, nullptr, (uint32_t index)); |
| 189 |
|
| 190 |
IMetricSet_1_13 *GetMetricSet(uint32_t index) override { |
| 191 |
if (!getMetricSetResults.empty()) { |
| 192 |
return getMetricSetResults[index]; |
| 193 |
} |
| 194 |
return getMetricSetResult; |
| 195 |
} |
| 196 |
TCompletionCode OpenIoStream(IMetricSet_1_0 *metricSet, uint32_t processId, uint32_t *nsTimerPeriod, uint32_t *oaBufferSize) override { |
| 197 |
if (openIoStreamOutOaBufferSize) { |
| 198 |
*oaBufferSize = *openIoStreamOutOaBufferSize; |
| 199 |
} |
| 200 |
if (!openIoStreamResults.empty()) { |
| 201 |
auto retVal = openIoStreamResults.back(); |
| 202 |
openIoStreamResults.pop_back(); |
| 203 |
return retVal; |
| 204 |
} |
| 205 |
return openIoStreamResult; |
| 206 |
} |
| 207 |
TCompletionCode ReadIoStream(uint32_t *reportsCount, char *reportData, uint32_t readFlags) override { |
| 208 |
if (!readIoStreamOutReportsCount.empty()) { |
| 209 |
*reportsCount = readIoStreamOutReportsCount.back(); |
| 210 |
readIoStreamOutReportsCount.pop_back(); |
| 211 |
} |
| 212 |
|
| 213 |
return readIoStreamResult; |
| 214 |
} |
| 215 |
|
| 216 |
IMetricSet_1_13 *getMetricSetResult = nullptr; |
| 217 |
std::vector<IMetricSet_1_13 *> getMetricSetResults; |
| 218 |
std::vector<uint32_t> readIoStreamOutReportsCount{}; |
| 219 |
uint32_t *openIoStreamOutOaBufferSize = nullptr; |
| 220 |
TCompletionCode openIoStreamResult = TCompletionCode::CC_OK; |
| 221 |
TCompletionCode readIoStreamResult = TCompletionCode::CC_OK; |
| 222 |
std::vector<TCompletionCode> openIoStreamResults{}; |
| 223 |
}; |
| 224 |
|
| 225 |
template <> |
| 226 |
class Mock<IEquation_1_0> : public IEquation_1_0 { |
| 227 |
public: |
| 228 |
~Mock() override = default; |
| 229 |
|
| 230 |
uint32_t GetEquationElementsCount() override { |
| 231 |
return getEquationElementsCount; |
| 232 |
} |
| 233 |
|
| 234 |
TEquationElement_1_0 *GetEquationElement(uint32_t index) override { |
| 235 |
if (!getEquationElement.empty()) { |
| 236 |
return getEquationElement[index]; |
| 237 |
} |
| 238 |
return nullptr; |
| 239 |
} |
| 240 |
|
| 241 |
std::vector<TEquationElement_1_0 *> getEquationElement; |
| 242 |
uint32_t getEquationElementsCount = 1u; |
| 243 |
}; |
| 244 |
|
| 245 |
template <> |
| 246 |
class Mock<IMetricSet_1_13> : public IMetricSet_1_13 { |
| 247 |
public: |
| 248 |
~Mock() override = default; |
| 249 |
|
| 250 |
ADDMETHOD_NOBASE(GetParams, TMetricSetParams_1_11 *, nullptr, ()); |
| 251 |
ADDMETHOD_NOBASE(GetMetric, IMetric_1_13 *, nullptr, (uint32_t index)); |
| 252 |
ADDMETHOD_NOBASE(GetInformation, IInformation_1_0 *, nullptr, (uint32_t index)); |
| 253 |
ADDMETHOD_NOBASE(Activate, TCompletionCode, TCompletionCode::CC_OK, ()); |
| 254 |
ADDMETHOD_NOBASE(Deactivate, TCompletionCode, TCompletionCode::CC_OK, ()); |
| 255 |
ADDMETHOD_NOBASE(SetApiFiltering, TCompletionCode, TCompletionCode::CC_OK, (uint32_t apiMask)); |
| 256 |
ADDMETHOD_NOBASE(CalculateMetrics, TCompletionCode, TCompletionCode::CC_OK, (const unsigned char *rawData, uint32_t rawDataSize, TTypedValue_1_0 *out, uint32_t outSize, uint32_t *outReportCount, bool enableContextFiltering)); |
| 257 |
ADDMETHOD_NOBASE(CalculateIoMeasurementInformation, TCompletionCode, TCompletionCode::CC_OK, (TTypedValue_1_0 * out, uint32_t outSize)); |
| 258 |
ADDMETHOD_NOBASE(GetComplementaryMetricSet, IMetricSet_1_5 *, nullptr, (uint32_t index)); |
| 259 |
|
| 260 |
TCompletionCode CalculateMetrics(const unsigned char *rawData, uint32_t rawDataSize, TTypedValue_1_0 *out, uint32_t outSize, uint32_t *outReportCount, TTypedValue_1_0 *outMaxValues, uint32_t outMaxValuesSize) override { |
| 261 |
if (calculateMetricsOutReportCount) { |
| 262 |
*outReportCount = *calculateMetricsOutReportCount; |
| 263 |
} |
| 264 |
return calculateMetricsResult; |
| 265 |
} |
| 266 |
|
| 267 |
uint32_t *calculateMetricsOutReportCount = nullptr; |
| 268 |
TCompletionCode calculateMetricsResult = TCompletionCode::CC_OK; |
| 269 |
}; |
| 270 |
|
| 271 |
template <> |
| 272 |
class Mock<IMetric_1_13> : public IMetric_1_13 { |
| 273 |
public: |
| 274 |
~Mock() override = default; |
| 275 |
|
| 276 |
ADDMETHOD_NOBASE(GetParams, TMetricParams_1_13 *, nullptr, ()); |
| 277 |
}; |
| 278 |
|
| 279 |
template <> |
| 280 |
class Mock<IInformation_1_0> : public IInformation_1_0 { |
| 281 |
public: |
| 282 |
Mock(){}; |
| 283 |
|
| 284 |
ADDMETHOD_NOBASE(GetParams, MetricsDiscovery::TInformationParams_1_0 *, nullptr, ()); |
| 285 |
}; |
| 286 |
|
| 287 |
template <> |
| 288 |
struct Mock<MetricEnumeration> : public MetricEnumeration { |
| 289 |
Mock(::L0::OaMetricSourceImp &metricSource); |
| 290 |
~Mock() override = default; |
| 291 |
|
| 292 |
using BaseClass = MetricEnumeration; |
| 293 |
|
| 294 |
using MetricEnumeration::cleanupMetricsDiscovery; |
| 295 |
using MetricEnumeration::hMetricsDiscovery; |
| 296 |
using MetricEnumeration::initializationState; |
| 297 |
using MetricEnumeration::openAdapterGroup; |
| 298 |
using MetricEnumeration::openMetricsDiscovery; |
| 299 |
|
| 300 |
// Api mock enable/disable. |
| 301 |
void setMockedApi(MockMetricsDiscoveryApi *mockedApi); |
| 302 |
|
| 303 |
// Mock metric enumeration functions. |
| 304 |
ADDMETHOD(isInitialized, bool, false, true, (), ()); |
| 305 |
ADDMETHOD(loadMetricsDiscovery, ze_result_t, false, ZE_RESULT_SUCCESS, (), ()); |
| 306 |
|
| 307 |
MetricsDiscovery::IAdapter_1_13 *getMetricsAdapterResult = nullptr; |
| 308 |
MetricsDiscovery::IAdapter_1_13 *getMetricsAdapter() override { |
| 309 |
return getMetricsAdapterResult; |
| 310 |
} |
| 311 |
|
| 312 |
bool getAdapterId(uint32_t &drmMajor, uint32_t &drmMinor) override { |
| 313 |
if (getAdapterIdCallBase) { |
| 314 |
return MetricEnumeration::getAdapterId(drmMajor, drmMinor); |
| 315 |
} |
| 316 |
drmMajor = getAdapterIdOutMajor; |
| 317 |
drmMinor = getAdapterIdOutMinor; |
| 318 |
return getAdapterIdResult; |
| 319 |
} |
| 320 |
|
| 321 |
// Not mocked metrics enumeration functions. |
| 322 |
ze_result_t baseLoadMetricsDiscovery() { return MetricEnumeration::loadMetricsDiscovery(); } |
| 323 |
|
| 324 |
// Mock metrics discovery api. |
| 325 |
static MockMetricsDiscoveryApi *globalMockApi; |
| 326 |
|
| 327 |
// Original metric enumeration obtained from metric context. |
| 328 |
::L0::MetricEnumeration *metricEnumeration = nullptr; |
| 329 |
|
| 330 |
uint32_t getAdapterIdOutMajor = 0u; |
| 331 |
uint32_t getAdapterIdOutMinor = 0u; |
| 332 |
bool getAdapterIdResult = true; |
| 333 |
bool getAdapterIdCallBase = false; |
| 334 |
}; |
| 335 |
|
| 336 |
template <> |
| 337 |
struct Mock<MetricGroup> : public OaMetricGroupImp { |
| 338 |
~Mock() override = default; |
| 339 |
Mock(MetricSource &metricSource) : OaMetricGroupImp(metricSource) {} |
| 340 |
|
| 341 |
ADDMETHOD_NOBASE(metricGet, ze_result_t, ZE_RESULT_SUCCESS, (uint32_t *, zet_metric_handle_t *)); |
| 342 |
ADDMETHOD_NOBASE(calculateMetricValues, ze_result_t, ZE_RESULT_SUCCESS, (const zet_metric_group_calculation_type_t, size_t, const uint8_t *, uint32_t *, zet_typed_value_t *)); |
| 343 |
ADDMETHOD_NOBASE(calculateMetricValuesExp, ze_result_t, ZE_RESULT_SUCCESS, (const zet_metric_group_calculation_type_t, size_t, const uint8_t *, uint32_t *, uint32_t *, uint32_t *, zet_typed_value_t *)); |
| 344 |
ADDMETHOD_NOBASE(activate, bool, true, ()); |
| 345 |
ADDMETHOD_NOBASE(deactivate, bool, true, ()); |
| 346 |
|
| 347 |
zet_metric_group_handle_t getMetricGroupForSubDevice(const uint32_t subDeviceIndex) override { |
| 348 |
return nullptr; |
| 349 |
} |
| 350 |
|
| 351 |
ze_result_t getProperties(zet_metric_group_properties_t *properties) override { |
| 352 |
if (getPropertiesOutProperties) { |
| 353 |
*properties = *getPropertiesOutProperties; |
| 354 |
} |
| 355 |
return getPropertiesResult; |
| 356 |
} |
| 357 |
|
| 358 |
zet_metric_group_properties_t *getPropertiesOutProperties = nullptr; |
| 359 |
ze_result_t getPropertiesResult = ZE_RESULT_SUCCESS; |
| 360 |
}; |
| 361 |
|
| 362 |
struct MetricGroupImpTest : public OaMetricGroupImp { |
| 363 |
MetricGroupImpTest(MetricSource &metricSource) : OaMetricGroupImp(metricSource) {} |
| 364 |
using OaMetricGroupImp::copyValue; |
| 365 |
using OaMetricGroupImp::pReferenceConcurrentGroup; |
| 366 |
using OaMetricGroupImp::pReferenceMetricSet; |
| 367 |
}; |
| 368 |
|
| 369 |
} // namespace ult |
| 370 |
} // namespace L0 |