Metrics Refactor MetricQuery and Metric Query Pool

This patch is to refactor MetricQuery and MetricQueryPool
so that Stall sampling metric could be integrated seamlessly

Related-To: LOCI-2904

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

Author: joshuaranjan

level_zero/api/tools/zet_metric.cpp

@@ -115,7 +115,7 @@ zetMetricQueryCreate(
     zet_metric_query_pool_handle_t hMetricQueryPool,
     uint32_t index,
     zet_metric_query_handle_t *phMetricQuery) {
-    return L0::MetricQueryPool::fromHandle(hMetricQueryPool)->createMetricQuery(index, phMetricQuery);
+    return L0::MetricQueryPool::fromHandle(hMetricQueryPool)->metricQueryCreate(index, phMetricQuery);
 }
 
 ZE_DLLEXPORT ze_result_t ZE_APICALL

level_zero/core/source/cmdlist/cmdlist_imp.cpp

@@ -42,7 +42,7 @@ ze_result_t CommandListImp::appendMetricMemoryBarrier() {
 
 ze_result_t CommandListImp::appendMetricStreamerMarker(zet_metric_streamer_handle_t hMetricStreamer,
                                                        uint32_t value) {
-    return MetricQuery::appendStreamerMarker(*this, hMetricStreamer, value);
+    return MetricStreamer::appendStreamerMarker(*this, hMetricStreamer, value);
 }
 
 ze_result_t CommandListImp::appendMetricQueryBegin(zet_metric_query_handle_t hMetricQuery) {

level_zero/tools/source/metrics/metric.h

@@ -127,6 +127,8 @@ struct MetricStreamer : _zet_metric_streamer_handle_t {
     static MetricStreamer *fromHandle(zet_metric_streamer_handle_t handle) {
         return static_cast<MetricStreamer *>(handle);
     }
+    static ze_result_t appendStreamerMarker(CommandList &commandList,
+                                            zet_metric_streamer_handle_t hMetricStreamer, uint32_t value);
     virtual Event::State getNotificationState() = 0;
     inline zet_metric_streamer_handle_t toHandle() { return this; }
 };
@@ -135,7 +137,7 @@ struct MetricQueryPool : _zet_metric_query_pool_handle_t {
     virtual ~MetricQueryPool() = default;
 
     virtual ze_result_t destroy() = 0;
-    virtual ze_result_t createMetricQuery(uint32_t index,
+    virtual ze_result_t metricQueryCreate(uint32_t index,
                                           zet_metric_query_handle_t *phMetricQuery) = 0;
 
     static MetricQueryPool *fromHandle(zet_metric_query_pool_handle_t handle);
@@ -149,15 +151,12 @@ struct MetricQuery : _zet_metric_query_handle_t {
     virtual ze_result_t appendBegin(CommandList &commandList) = 0;
     virtual ze_result_t appendEnd(CommandList &commandList, ze_event_handle_t hSignalEvent,
                                   uint32_t numWaitEvents, ze_event_handle_t *phWaitEvents) = 0;
-    static ze_result_t appendStreamerMarker(CommandList &commandList,
-                                            zet_metric_streamer_handle_t hMetricStreamer, uint32_t value);
     virtual ze_result_t getData(size_t *pRawDataSize, uint8_t *pRawData) = 0;
 
     virtual ze_result_t reset() = 0;
     virtual ze_result_t destroy() = 0;
 
     static MetricQuery *fromHandle(zet_metric_query_handle_t handle);
-
     zet_metric_query_handle_t toHandle();
 };
 

level_zero/tools/source/metrics/metric_query_imp.cpp

@@ -637,7 +637,7 @@ MetricQueryPool *MetricQueryPool::fromHandle(zet_metric_query_pool_handle_t hand
 
 zet_metric_query_pool_handle_t MetricQueryPool::toHandle() { return this; }
 
-ze_result_t OaMetricQueryPoolImp::createMetricQuery(uint32_t index,
+ze_result_t OaMetricQueryPoolImp::metricQueryCreate(uint32_t index,
                                                     zet_metric_query_handle_t *phMetricQuery) {
 
     if (index >= description.count) {
@@ -914,36 +914,6 @@ ze_result_t OaMetricQueryImp::writeSkipExecutionQuery(CommandList &commandList,
     return result ? ZE_RESULT_SUCCESS : ZE_RESULT_ERROR_UNKNOWN;
 }
 
-ze_result_t MetricQuery::appendStreamerMarker(CommandList &commandList,
-                                              zet_metric_streamer_handle_t hMetricStreamer,
-                                              uint32_t value) {
-
-    DeviceImp *pDeviceImp = static_cast<DeviceImp *>(commandList.device);
-
-    if (pDeviceImp->metricContext->isImplicitScalingCapable()) {
-        // Use one of the sub-device contexts to append to command list.
-        pDeviceImp = static_cast<DeviceImp *>(pDeviceImp->subDevices[0]);
-        pDeviceImp->metricContext->getMetricSource<OaMetricSourceImp>().getMetricsLibrary().enableWorkloadPartition();
-    }
-
-    OaMetricSourceImp &metricSource = pDeviceImp->metricContext->getMetricSource<OaMetricSourceImp>();
-    auto &metricsLibrary = metricSource.getMetricsLibrary();
-
-    const uint32_t streamerMarkerHighBitsShift = 25;
-
-    // Obtain gpu commands.
-    CommandBufferData_1_0 commandBuffer = {};
-    commandBuffer.CommandsType = ObjectType::MarkerStreamUser;
-    commandBuffer.MarkerStreamUser.Value = value;
-    commandBuffer.MarkerStreamUser.Reserved = (value >> streamerMarkerHighBitsShift);
-    commandBuffer.Type = metricSource.isComputeUsed()
-                             ? GpuCommandBufferType::Compute
-                             : GpuCommandBufferType::Render;
-
-    return metricsLibrary.getGpuCommands(commandList, commandBuffer) ? ZE_RESULT_SUCCESS
-                                                                     : ZE_RESULT_ERROR_UNKNOWN;
-}
-
 MetricQuery *MetricQuery::fromHandle(zet_metric_query_handle_t handle) {
     return static_cast<MetricQuery *>(handle);
 }

level_zero/tools/source/metrics/metric_query_imp.h

@@ -145,7 +145,7 @@ struct OaMetricQueryPoolImp : MetricQueryPool {
     bool create();
     ze_result_t destroy() override;
 
-    ze_result_t createMetricQuery(uint32_t index, zet_metric_query_handle_t *phMetricQuery) override;
+    ze_result_t metricQueryCreate(uint32_t index, zet_metric_query_handle_t *phMetricQuery) override;
 
     bool allocateGpuMemory();
 

level_zero/tools/source/metrics/metric_streamer_imp.cpp

@@ -14,6 +14,8 @@
 #include "level_zero/tools/source/metrics/metric_query_imp.h"
 #include "level_zero/tools/source/metrics/metric_source_oa.h"
 
+using namespace MetricsLibraryApi;
+
 namespace L0 {
 
 ze_result_t OaMetricStreamerImp::readData(uint32_t maxReportCount, size_t *pRawDataSize,
@@ -336,4 +338,34 @@ ze_result_t OaMetricGroupImp::streamerOpen(
     return result;
 }
 
+ze_result_t MetricStreamer::appendStreamerMarker(CommandList &commandList,
+                                                 zet_metric_streamer_handle_t hMetricStreamer,
+                                                 uint32_t value) {
+
+    DeviceImp *pDeviceImp = static_cast<DeviceImp *>(commandList.device);
+
+    if (pDeviceImp->metricContext->isImplicitScalingCapable()) {
+        // Use one of the sub-device contexts to append to command list.
+        pDeviceImp = static_cast<DeviceImp *>(pDeviceImp->subDevices[0]);
+        pDeviceImp->metricContext->getMetricSource<OaMetricSourceImp>().getMetricsLibrary().enableWorkloadPartition();
+    }
+
+    OaMetricSourceImp &metricSource = pDeviceImp->metricContext->getMetricSource<OaMetricSourceImp>();
+    auto &metricsLibrary = metricSource.getMetricsLibrary();
+
+    const uint32_t streamerMarkerHighBitsShift = 25;
+
+    // Obtain gpu commands.
+    CommandBufferData_1_0 commandBuffer = {};
+    commandBuffer.CommandsType = ObjectType::MarkerStreamUser;
+    commandBuffer.MarkerStreamUser.Value = value;
+    commandBuffer.MarkerStreamUser.Reserved = (value >> streamerMarkerHighBitsShift);
+    commandBuffer.Type = metricSource.isComputeUsed()
+                             ? GpuCommandBufferType::Compute
+                             : GpuCommandBufferType::Render;
+
+    return metricsLibrary.getGpuCommands(commandList, commandBuffer) ? ZE_RESULT_SUCCESS
+                                                                     : ZE_RESULT_ERROR_UNKNOWN;
+}
+
 } // namespace L0

level_zero/tools/test/unit_tests/sources/metrics/mock_metric.h

@@ -130,7 +130,7 @@ struct Mock<MetricQueryPool> : public MetricQueryPool {
     Mock();
     ~Mock() override;
 
-    MOCK_METHOD(ze_result_t, createMetricQuery, (uint32_t, zet_metric_query_handle_t *), (override));
+    MOCK_METHOD(ze_result_t, metricQueryCreate, (uint32_t, zet_metric_query_handle_t *), (override));
     MOCK_METHOD(ze_result_t, destroy, (), (override));
 };