Perf Counters Displayed Using AvailableMetrics and PerfMetricsData (#389)

Perf counter parsing with available metrics and perf metrics data

Author: GrantComm

dive_core/available_metrics.cpp

@@ -122,4 +122,17 @@ MetricType AvailableMetrics::GetMetricType(const std::string& key) const
     return info ? info->m_metric_type : MetricType::kUnknown;
 }
 
+std::vector<std::string> AvailableMetrics::GetAllMetricKeys() const
+{
+    std::vector<std::string> keys;
+    keys.reserve(m_metrics.size());
+
+    for (const auto& pair : m_metrics)
+    {
+        keys.push_back(pair.first);
+    }
+
+    return keys;
+}
+
 }  // namespace Dive

dive_core/available_metrics.h

@@ -18,10 +18,11 @@
 
 #include <cstdint>
 #include <filesystem>
+#include <map>
 #include <string>
-#include <unordered_map>
 #include <optional>
 #include <memory>
+#include <vector>
 
 namespace Dive
 {
@@ -59,9 +60,12 @@ class AvailableMetrics
     // Get the metric type for a given key, return kUnknown if not found.
     MetricType GetMetricType(const std::string& key) const;
 
+    // Get all available metric keys
+    std::vector<std::string> GetAllMetricKeys() const;
+
 private:
     AvailableMetrics() = default;
-    std::unordered_map<std::string, MetricInfo> m_metrics;
+    std::map<std::string, MetricInfo> m_metrics;
 };
 
 }  // namespace Dive

dive_core/perf_metrics_data.cpp

@@ -38,9 +38,6 @@ namespace Dive
 
 namespace
 {
-constexpr std::array kFixedHeaders = { "ContextID",   "ProcessID", "FrameID",
-                                       "CmdBufferID", "DrawID",    "DrawType",
-                                       "DrawLabel",   "ProgramID", "LRZState" };
 
 struct ParseHeadersResult
 {
@@ -59,7 +56,7 @@ std::optional<ParseHeadersResult> ParseHeaders(const std::string&      line,
     int               column_index = 0;
     while (StringUtils::GetTrimmedField(header_ss, header_field, ','))
     {
-        if (column_index < kFixedHeaders.size())
+        if (column_index < kFixedPerfMetricsDataHeaderCount)
         {
             if (header_field != kFixedHeaders[column_index])
                 return std::nullopt;  // Fixed header mismatch
@@ -71,7 +68,7 @@ std::optional<ParseHeadersResult> ParseHeaders(const std::string&      line,
         }
         column_index++;
     }
-    if (column_index < kFixedHeaders.size())
+    if (column_index < kFixedPerfMetricsDataHeaderCount)
     {
         return std::nullopt;  // Not enough columns
     }
@@ -81,7 +78,7 @@ std::optional<ParseHeadersResult> ParseHeaders(const std::string&      line,
 
 std::optional<PerfMetricsRecord> ParseRecordFixedFields(const std::vector<std::string>& fields)
 {
-    if (fields.size() < kFixedHeaders.size())
+    if (fields.size() < kFixedPerfMetricsDataHeaderCount)
     {
         return std::nullopt;
     }
@@ -120,7 +117,7 @@ bool ParseMetrics(const std::vector<std::string>&       fields,
 {
     for (size_t i = 0; i < metric_infos.size(); ++i)
     {
-        const std::string& value_str = fields[kFixedHeaders.size() + i];
+        const std::string& value_str = fields[kFixedPerfMetricsDataHeaderCount + i];
         const MetricInfo*  info = metric_infos[i];
         if (info == nullptr)
         {
@@ -203,7 +200,7 @@ std::unique_ptr<AvailableMetrics> available_metrics)
             fields.push_back(field);
         }
 
-        if (fields.size() != kFixedHeaders.size() + metric_names.size())
+        if (fields.size() != kFixedPerfMetricsDataHeaderCount + metric_names.size())
         {
             continue;  // Skip malformed lines
         }
@@ -609,7 +606,7 @@ void PerfMetricsDataProvider::Analyze(const CommandHierarchy* command_hierarchy)
 const std::vector<std::string> PerfMetricsDataProvider::GetRecordHeader() const
 {
     std::vector<std::string> full_header;
-    full_header.reserve(kFixedHeaders.size() + GetMetricsNames().size());
+    full_header.reserve(kFixedPerfMetricsDataHeaderCount + GetMetricsNames().size());
     for (const auto& header : kFixedHeaders)
     {
         full_header.push_back(header);

dive_core/perf_metrics_data.h

@@ -25,10 +25,45 @@
 #include <functional>
 #include <utility>
 #include <tuple>
+#include <array>
 
 namespace Dive
 {
 
+enum FixedPerfMetricsDataHeaders : uint32_t
+{
+    kContextID,
+    kProcessID,
+    kFrameID,
+    kCmdBufferID,
+    kDrawID,
+    kDrawType,
+    kDrawLabel,
+    kProgramID,
+    kLRZState,
+    kFixedPerfMetricsDataHeaderCount
+};
+
+constexpr std::array kHeaderMap = {
+    std::pair(kContextID, "ContextID"), std::pair(kProcessID, "ProcessID"),
+    std::pair(kFrameID, "FrameID"),     std::pair(kCmdBufferID, "CmdBufferID"),
+    std::pair(kDrawID, "DrawID"),       std::pair(kDrawType, "DrawType"),
+    std::pair(kDrawLabel, "DrawLabel"), std::pair(kProgramID, "ProgramID"),
+    std::pair(kLRZState, "LRZState")
+};
+
+static_assert(kHeaderMap.size() == kFixedPerfMetricsDataHeaderCount,
+              "ERROR: FixedPerfMetricsDataHeaders and kHeaderMap are out of sync!");
+
+inline constexpr std::array<const char*, kFixedPerfMetricsDataHeaderCount> kFixedHeaders = [] {
+    std::array<const char*, kFixedPerfMetricsDataHeaderCount> arr{};
+    for (const auto& pair : kHeaderMap)
+    {
+        arr[pair.first] = pair.second;
+    }
+    return arr;
+}();
+
 class CommandHierarchy;
 class AvailableMetrics;
 struct MetricInfo;

ui/analyze_window.cpp

@@ -32,7 +32,9 @@
 #include <QStandardItemModel>
 #include <QVBoxLayout>
 #include <filesystem>
+#include <optional>
 #include <qapplication.h>
+#include <qtemporarydir.h>
 #include <string>
 
 #include "absl/status/status.h"
@@ -58,7 +60,11 @@ void AttemptDeletingTemporaryLocalFile(const std::filesystem::path &file_path)
 // =================================================================================================
 // AnalyzeDialog
 // =================================================================================================
-AnalyzeDialog::AnalyzeDialog(QWidget *parent)
+AnalyzeDialog::AnalyzeDialog(
+std::optional<std::reference_wrapper<const Dive::AvailableMetrics>> available_metrics,
+QWidget                                                            *parent) :
+    QDialog(parent),
+    m_available_metrics(available_metrics)
 {
     qDebug() << "AnalyzeDialog created.";
 
@@ -249,59 +255,41 @@ void AnalyzeDialog::ShowErrorMessage(const std::string &err_msg)
 //--------------------------------------------------------------------------------------------------
 void AnalyzeDialog::PopulateMetrics()
 {
-    QFile file(":/resources/available_metrics.csv");
-    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
+    if (m_available_metrics.has_value())
     {
-        std::cout << "Could not open file:" << file.errorString().toStdString() << std::endl;
-        qDebug() << "Could not open file:" << file.errorString();
-        return;
-    }
-
-    QTextStream in(&file);
-
-    // Read and discard the first line (headers)
-    if (!in.atEnd())
-    {
-        in.readLine();
-    }
+        // Get the list of all available metrics
+        std::vector<std::string> all_keys = m_available_metrics->get().GetAllMetricKeys();
 
-    while (!in.atEnd())
-    {
-        QString     line = in.readLine();
-        QStringList fields = line.split(',');
+        for (const auto &key : all_keys)
+        {
+            const Dive::MetricInfo *info = m_available_metrics->get().GetMetricInfo(key);
+            if (info)
+            {
+                CsvItem item;
+                item.id = info->m_metric_id;
+                item.type = info->m_metric_type;
+                item.key = QString::fromStdString(key);
+                item.name = QString::fromStdString(info->m_name);
+                item.description = QString::fromStdString(info->m_description);
+                m_csv_items->append(item);
+            }
+        }
 
-        if (fields.size() == 5)
+        // Populate the metrics list
+        for (const auto &item : *m_csv_items)
         {
-            CsvItem item;
-            item.id = fields[0].replace('"', "");
-            ;
-            item.type = fields[1].replace('"', "");
-            ;
-            item.key = fields[2].replace('"', "");
-            ;
-            item.name = fields[3].replace('"', "");
-            ;
-            item.description = fields[4].replace('"', "");
-            ;
-            m_csv_items->append(item);
+            QListWidgetItem *csv_item = new QListWidgetItem(item.name);
+            csv_item->setData(kDataRole, item.key);
+            csv_item->setFlags(csv_item->flags() | Qt::ItemIsUserCheckable);
+            csv_item->setCheckState(Qt::Unchecked);
+            m_metrics_list->addItem(csv_item);
         }
-    }
-    file.close();
 
-    // Populate the metrics list
-    for (const auto &item : *m_csv_items)
-    {
-        QListWidgetItem *csv_item = new QListWidgetItem(item.name);
-        csv_item->setData(kDataRole, item.key);
-        csv_item->setFlags(csv_item->flags() | Qt::ItemIsUserCheckable);
-        csv_item->setCheckState(Qt::Unchecked);
-        m_metrics_list->addItem(csv_item);
+        // Add spacer so that all metrics are visible at the end of the list.
+        QListWidgetItem *spacer = new QListWidgetItem();
+        spacer->setFlags(spacer->flags() & ~Qt::ItemIsSelectable);
+        m_metrics_list->addItem(spacer);
     }
-
-    // Add spacer so that all metrics are visible at the end of the list.
-    QListWidgetItem *spacer = new QListWidgetItem();
-    spacer->setFlags(spacer->flags() & ~Qt::ItemIsSelectable);
-    m_metrics_list->addItem(spacer);
 }
 
 //--------------------------------------------------------------------------------------------------
@@ -757,12 +745,13 @@ void AnalyzeDialog::OnReplay()
         }
         WaitForReplay(*device);
         qDebug() << "Loading perf counter data: " << perf_counter_csv.string().c_str();
-        emit OnDisplayPerfCounterResults(QString::fromStdString(perf_counter_csv.string()));
+
+        emit OnDisplayPerfCounterResults(perf_counter_csv.string(), m_available_metrics);
     }
     else
     {
         qDebug() << "Cleared perf counter data";
-        emit OnDisplayPerfCounterResults("");
+        emit OnDisplayPerfCounterResults("", std::nullopt);
     }
 
     // Run the gpu_time replay

ui/analyze_window.h

@@ -17,6 +17,7 @@
 #include <QDialog>
 #include "capture_service/device_mgr.h"
 #include "package_filter.h"
+#include "dive_core/available_metrics.h"
 
 #pragma once
 
@@ -35,25 +36,27 @@ class MainWindow;
 
 namespace Dive
 {
-class SelectedCaptureFiles;
+class AvailableMetrics;
 }  // namespace Dive
 
 class AnalyzeDialog : public QDialog
 {
     // Data structure to hold a single item from the CSV
     struct CsvItem
     {
-        QString id;
-        QString type;
-        QString key;
-        QString name;
-        QString description;
+        QString          id;
+        Dive::MetricType type;
+        QString          key;
+        QString          name;
+        QString          description;
     };
 
     Q_OBJECT
 
 public:
-    AnalyzeDialog(QWidget *parent = 0);
+    AnalyzeDialog(
+    std::optional<std::reference_wrapper<const Dive::AvailableMetrics>> available_metrics,
+    QWidget                                                            *parent = nullptr);
     ~AnalyzeDialog();
     void UpdateDeviceList(bool isInitialized);
     void SetSelectedCaptureFile(const QString &filePath);
@@ -64,7 +67,9 @@ private slots:
     void OnReplay();
 signals:
     void OnNewFileOpened(const QString &file_path);
-    void OnDisplayPerfCounterResults(const QString &file_path);
+    void OnDisplayPerfCounterResults(
+    const std::filesystem::path                                        &file_path,
+    std::optional<std::reference_wrapper<const Dive::AvailableMetrics>> available_metrics);
     void OnDisplayGpuTimingResults(const QString &file_path);
     void ReloadCapture(const QString &file_path);
 
@@ -136,7 +141,7 @@ private slots:
     QString                       m_selected_capture_file_string;
     QVector<CsvItem>             *m_csv_items;
     std::vector<std::string>     *m_enabled_metrics_vector;
-
+    std::optional<std::reference_wrapper<const Dive::AvailableMetrics>> m_available_metrics;
     // Used to store a csv item's key in the enabled metrics vector.
     const int             kDataRole = Qt::UserRole + 1;
     const int             kDefaultFrameCount = 3;

ui/gfxr_vulkan_command_filter.cpp

@@ -83,4 +83,6 @@ void GfxrVulkanCommandFilter::OnFilterGfxrVulkanCommandChange(const QString &fil
     m_command_hierarchy_view.scrollToTop();
 
     m_command_hierarchy_view.expandAll();
+
+    emit FilterChanged();
 }

ui/gfxr_vulkan_command_filter.h

@@ -34,7 +34,7 @@ public slots:
     void OnFilterGfxrVulkanCommandChange(const QString &filter_mode);
 
 signals:
-    void FilterTextChanged(const QString &text);
+    void FilterChanged();
 
 private:
     DiveTreeView                      &m_command_hierarchy_view;