Metric Refactor Metric Context

Rename Metric Context and move OA specific functions
and members from Metric Context to OA specific class(MetricSource).
This refactoring is done so that additional Metric Source
like Stall Sampling could be Seamlessly implemented.

Related-To: LOCI-2753


Signed-off-by: Joshua Santosh Ranjan <[email protected]>

Author: joshuaranjan

level_zero/core/source/cmdlist/cmdlist_imp.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020-2021 Intel Corporation
+ * Copyright (C) 2020-2022 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -36,7 +36,8 @@ ze_result_t CommandListImp::destroy() {
 }
 
 ze_result_t CommandListImp::appendMetricMemoryBarrier() {
-    return MetricQuery::appendMemoryBarrier(*this);
+
+    return device->getMetricDeviceContext().appendMetricMemoryBarrier(*this);
 }
 
 ze_result_t CommandListImp::appendMetricStreamerMarker(zet_metric_streamer_handle_t hMetricStreamer,

level_zero/core/source/device/device.h

@@ -36,7 +36,7 @@ namespace L0 {
 struct DriverHandle;
 struct BuiltinFunctionsLib;
 struct ExecutionEnvironment;
-struct MetricContext;
+class MetricDeviceContext;
 struct SysmanDevice;
 struct DebugSession;
 
@@ -103,7 +103,7 @@ struct Device : _ze_device_handle_t {
     virtual const NEO::HardwareInfo &getHwInfo() const = 0;
     virtual NEO::OSInterface &getOsInterface() = 0;
     virtual uint32_t getPlatformInfo() const = 0;
-    virtual MetricContext &getMetricContext() = 0;
+    virtual MetricDeviceContext &getMetricDeviceContext() = 0;
     virtual DebugSession *getDebugSession(const zet_debug_config_t &config) = 0;
     virtual DebugSession *createDebugSession(const zet_debug_config_t &config, ze_result_t &result) = 0;
     virtual void removeDebugSession() = 0;

level_zero/core/source/device/device_imp.cpp

@@ -734,7 +734,7 @@ ze_result_t DeviceImp::activateMetricGroupsDeferred(uint32_t count,
     ze_result_t result = ZE_RESULT_ERROR_UNKNOWN;
     if (!this->isSubdevice && this->isImplicitScalingCapable()) {
         for (auto subDevice : this->subDevices) {
-            result = subDevice->getMetricContext().activateMetricGroupsDeferred(count, phMetricGroups);
+            result = subDevice->getMetricDeviceContext().activateMetricGroupsDeferred(count, phMetricGroups);
             if (result != ZE_RESULT_SUCCESS)
                 break;
         }
@@ -764,13 +764,13 @@ uint32_t DeviceImp::getPlatformInfo() const {
     return hardwareInfo.platform.eRenderCoreFamily;
 }
 
-MetricContext &DeviceImp::getMetricContext() { return *metricContext; }
+MetricDeviceContext &DeviceImp::getMetricDeviceContext() { return *metricContext; }
 
 void DeviceImp::activateMetricGroups() {
     if (metricContext != nullptr) {
         if (metricContext->isImplicitScalingCapable()) {
             for (uint32_t i = 0; i < numSubDevices; i++) {
-                subDevices[i]->getMetricContext().activateMetricGroups();
+                subDevices[i]->getMetricDeviceContext().activateMetricGroups();
             }
         } else {
             metricContext->activateMetricGroups();
@@ -815,7 +815,7 @@ Device *Device::create(DriverHandle *driverHandle, NEO::Device *neoDevice, bool
     device->allocationsForReuse = std::make_unique<NEO::AllocationsList>();
     bool platformImplicitScaling = hwHelper.platformSupportsImplicitScaling(hwInfo);
     device->implicitScalingCapable = NEO::ImplicitScalingHelper::isImplicitScalingEnabled(neoDevice->getDeviceBitfield(), platformImplicitScaling);
-    device->metricContext = MetricContext::create(*device);
+    device->metricContext = MetricDeviceContext::create(*device);
     device->builtins = BuiltinFunctionsLib::create(
         device, neoDevice->getBuiltIns());
     device->cacheReservation = CacheReservation::create(*device);

level_zero/core/source/device/device_imp.h

@@ -69,7 +69,7 @@ struct DeviceImp : public Device {
     const NEO::HardwareInfo &getHwInfo() const override;
     NEO::OSInterface &getOsInterface() override;
     uint32_t getPlatformInfo() const override;
-    MetricContext &getMetricContext() override;
+    MetricDeviceContext &getMetricDeviceContext() override;
     DebugSession *getDebugSession(const zet_debug_config_t &config) override;
     DebugSession *createDebugSession(const zet_debug_config_t &config, ze_result_t &result) override;
     void removeDebugSession() override { debugSession.release(); }
@@ -104,7 +104,7 @@ struct DeviceImp : public Device {
     bool isSubdevice = false;
     void *execEnvironment = nullptr;
     std::unique_ptr<BuiltinFunctionsLib> builtins = nullptr;
-    std::unique_ptr<MetricContext> metricContext = nullptr;
+    std::unique_ptr<MetricDeviceContext> metricContext = nullptr;
     std::unique_ptr<CacheReservation> cacheReservation = nullptr;
     uint32_t maxNumHwThreads = 0;
     uint32_t numSubDevices = 0;

level_zero/core/source/driver/driver.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020-2021 Intel Corporation
+ * Copyright (C) 2020-2022 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -60,7 +60,7 @@ void DriverImp::initialize(ze_result_t *result) {
             *result = ZE_RESULT_SUCCESS;
 
             if (envVariables.metrics) {
-                *result = MetricContext::enableMetricApi();
+                *result = MetricDeviceContext::enableMetricApi();
                 if (*result != ZE_RESULT_SUCCESS) {
                     delete GlobalDriver;
                     GlobalDriverHandle = nullptr;

level_zero/core/test/unit_tests/mocks/mock_device.h

@@ -62,7 +62,7 @@ struct Mock<Device> : public Device {
     ADDMETHOD_NOBASE(activateMetricGroupsDeferred, ze_result_t, ZE_RESULT_SUCCESS, (uint32_t count, zet_metric_group_handle_t *phMetricGroups));
     ADDMETHOD_NOBASE_REFRETURN(getOsInterface, NEO::OSInterface &, ());
     ADDMETHOD_CONST_NOBASE(getPlatformInfo, uint32_t, 0u, ());
-    ADDMETHOD_NOBASE_REFRETURN(getMetricContext, MetricContext &, ());
+    ADDMETHOD_NOBASE_REFRETURN(getMetricDeviceContext, MetricDeviceContext &, ());
     ADDMETHOD_CONST_NOBASE_REFRETURN(getHwInfo, const NEO::HardwareInfo &, ());
     ADDMETHOD_NOBASE(getDriverHandle, L0::DriverHandle *, nullptr, ());
     ADDMETHOD_NOBASE_VOIDRETURN(setDriverHandle, (L0::DriverHandle *));

level_zero/tools/source/metrics/CMakeLists.txt

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2020-2021 Intel Corporation
+# Copyright (C) 2020-2022 Intel Corporation
 #
 # SPDX-License-Identifier: MIT
 #
@@ -12,6 +12,7 @@ list(APPEND L0_SRCS_TOOLS_METRICS
      ${CMAKE_CURRENT_SOURCE_DIR}/metric_enumeration_imp.cpp
      ${CMAKE_CURRENT_SOURCE_DIR}/metric_streamer_imp.cpp
      ${CMAKE_CURRENT_SOURCE_DIR}/metric_query_imp.cpp
+     ${CMAKE_CURRENT_SOURCE_DIR}/metric_source_oa.h
 )
 
 if(UNIX)

level_zero/tools/source/metrics/linux/os_metric_enumeration_imp_linux.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020-2021 Intel Corporation
+ * Copyright (C) 2020-2022 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -10,6 +10,7 @@
 #include "shared/source/os_interface/os_interface.h"
 
 #include "level_zero/tools/source/metrics/metric_enumeration_imp.h"
+#include "level_zero/tools/source/metrics/metric_source_oa.h"
 
 #include <sys/stat.h>
 #include <sys/sysmacros.h>
@@ -20,7 +21,7 @@ const char *MetricEnumeration::getMetricsDiscoveryFilename() { return "libmd.so.
 
 bool MetricEnumeration::getAdapterId(uint32_t &adapterMajor, uint32_t &adapterMinor) {
 
-    auto &device = metricContext.getDevice();
+    auto &device = metricSource.getMetricDeviceContext().getDevice();
     auto &osInterface = device.getOsInterface();
     auto drm = osInterface.getDriverModel()->as<NEO::Drm>();
     auto drmFile = drm->getFileDescriptor();

level_zero/tools/source/metrics/linux/os_metric_query_imp_linux.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020-2021 Intel Corporation
+ * Copyright (C) 2020-2022 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -10,6 +10,7 @@
 
 #include "level_zero/core/source/device/device.h"
 #include "level_zero/tools/source/metrics/metric_query_imp.h"
+#include "level_zero/tools/source/metrics/metric_source_oa.h"
 
 using namespace MetricsLibraryApi;