[SDK] Release 1.0 Public API Modifications (#277)

* Make sure all structs/enums can be forward declared * Updates to counter collection - consistency updates and cleanup * Conversion of dimension information to info struct * Added deprecated folder * Testing changes * merge changes * Fix shadowed variable * Source code formatting * Fix shadowed variable * Update rocprofiler_counter_info_v1_t member names * Split version.h into version.h and ext_version.h - ext_version.h contains external version info, e.g. ROCPROFILER_HSA_API_TABLE_MAJOR_VERSION, ROCPROFILER_HSA_RUNTIME_VERSION - this reduces amount of recompilation after a commit since version.h gets updated with the git revision * profile_config -> counter_config * EOF new line * [Samples] Reduce header includes + reorg counter collection samples * Misc compilation fixes - shadowed variables - use of [[deprecated("...")]] in C code - unused variables * Minor misc modifications - use common:: instead of rocprofiler::common:: when inside rocprofiler namespace - counters.cpp - move local anon namespace functions into rocprofiler::counters:: anon namespace - use std::string_view for get_static_string - const ref for get_static_ptr - misc namespace shortening * [Public API] rocprofiler_get_version_triplet + rocprofiler_version_triplet_t - struct rocprofiler_version_triplet_t containing fields for the major, minor, and patch version - public API function: rocprofiler_get_version_triplet - define C++ operators for rocprofiler_version_triplet_t - C++ function compute_version_triplet * [Tests] Improve async-copy-testing test - relax constraints - improve logging * Update counter_config.h doxygen docs * ROCPROFILER_SDK_BETA_COMPAT - ppdef which helps with renaming when set to 1 * Remove spurious include * Fix includes for cxx/version.hpp * Doxygen fixes for rocprofiler_get_version and rocprofiler_get_version_triplet * Public API Experimental Designation - ROCPROFILER_SDK_EXPERIMENTAL added to experimental function - "(experimental)" added to doxygen @brief entries * Fix use of assert instead of static_assert in hip/stream.cpp * Use typedef instead of define for rocprofiler_profile_config_id_t * Use inline rocprofiler_{create,destroy}_profile_config instead of ppdef - added <rocprofiler-sdk/deprecated/profile_config.h> * Doxygen for rocprofiler_{create,destroy}_profile_config * ROCPROFILER_SDK_DEPRECATED_WARNINGS * Temporarily comment out ROCPROFILER_SDK_DEPRECATED_WARNINGS=1 * cmake formatting * Misc variable renaming in samples and tests * Fix declarations of types * Fix hip stream tracing service struct name - rocprofiler_callback_tracing_stream_handle_data_t renamed to rocprofiler_callback_tracing_hip_stream_api_data_t * Rename "HIP_STREAM_API" to "HIP_STREAM" --------- Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com> Co-authored-by: Benjamin Welton <bewelton@amd.com>
2025-03-23 23:37:33 -07:00
parent cd4676ae6f
commit 4cd121e27b
127 changed files with 1629 additions and 988 deletions
@@ -25,12 +25,17 @@
 #include <gtest/gtest.h>

 #include <algorithm>
+#include <cstddef>
+#include <cstdint>

 #include <rocprofiler-sdk/rocprofiler.h>

 #include "lib/common/logging.hpp"
+#include "lib/common/utility.hpp"
 #include "lib/rocprofiler-sdk/agent.hpp"
+#include "lib/rocprofiler-sdk/counters/dimensions.hpp"
 #include "lib/rocprofiler-sdk/counters/metrics.hpp"
+#include "rocprofiler-sdk/fwd.h"

 namespace
 {
@@ -216,16 +221,57 @@ TEST(metrics, check_public_api_query)
    const auto& id_map      = metrics_map->id_to_metric;
    for(const auto& [id, metric] : id_map)
    {
-        rocprofiler_counter_info_v0_t version;
+        rocprofiler_counter_info_v1_t info;

-        ASSERT_EQ(
-            rocprofiler_query_counter_info(
-                {.handle = id}, ROCPROFILER_COUNTER_INFO_VERSION_0, static_cast<void*>(&version)),
-            ROCPROFILER_STATUS_SUCCESS);
-        EXPECT_EQ(std::string(version.name), metric.name());
-        EXPECT_EQ(std::string(version.block), metric.block());
-        EXPECT_EQ(std::string(version.expression), metric.expression());
-        EXPECT_EQ(version.is_derived, !metric.expression().empty());
-        EXPECT_EQ(std::string(version.description), metric.description());
+        auto dim_ptr = rocprofiler::counters::get_dimension_cache();
+
+        const auto* dims = rocprofiler::common::get_val(dim_ptr->id_to_dim, metric.id());
+        ASSERT_TRUE(dims);
+
+        auto status = rocprofiler_query_counter_info(
+            {.handle = id}, ROCPROFILER_COUNTER_INFO_VERSION_1, static_cast<void*>(&info));
+        ASSERT_EQ(status, ROCPROFILER_STATUS_SUCCESS);
+        EXPECT_EQ(std::string(info.name ? info.name : ""), metric.name());
+        EXPECT_EQ(std::string(info.block ? info.block : ""), metric.block());
+        EXPECT_EQ(std::string(info.expression ? info.expression : ""), metric.expression());
+        EXPECT_EQ(info.is_derived, !metric.expression().empty());
+        EXPECT_EQ(std::string(info.description ? info.description : ""), metric.description());
+
+        EXPECT_EQ(info.dimensions_count, dims->size());
+        for(size_t i = 0; i < info.dimensions_count; i++)
+        {
+            const auto& dim = dims->at(i);
+            EXPECT_EQ(dim.size(), info.dimensions[i].instance_size);
+            EXPECT_EQ(dim.type(), info.dimensions[i].id);
+            EXPECT_EQ(std::string(info.dimensions[i].name), dim.name());
+        }
+
+        size_t instance_count = 0;
+        // Checks the equality with the old rocprofiler_query_counter_instance_count
+        for(const auto& metric_dim : *dims)
+        {
+            if(instance_count == 0)
+                instance_count = metric_dim.size();
+            else if(metric_dim.size() > 0)
+                instance_count = metric_dim.size() * instance_count;
+        }
+
+        EXPECT_EQ(info.instance_ids_count, instance_count);
+        std::set<std::vector<size_t>> dim_permutations;
+
+        for(size_t i = 0; i < info.instance_ids_count; i++)
+        {
+            std::vector<size_t> dim_ids;
+            ASSERT_EQ(rocprofiler::counters::rec_to_counter_id(info.instance_ids[i]).handle,
+                      metric.id());
+            for(const auto& metric_dim : *dims)
+            {
+                dim_ids.push_back(
+                    rocprofiler::counters::rec_to_dim_pos(info.instance_ids[i], metric_dim.type()));
+            }
+            // Ensure that the premutation is unique
+            ASSERT_EQ(dim_permutations.insert(dim_ids).second, true);
+        }
+        ASSERT_EQ(instance_count, dim_permutations.size());
    }
 }