Add rocprofiler_query_counter_info function (#452)

* Add rocprofiler_query_counter_info function

Replaces rocprofiler_query_counter_name. Allows for
querying other types of info from counters (such as
description) and gives us some flexibility to add
return data in the near future (if we have to).

* source formatting (clang-format v11) (#453)

Co-authored-by: bwelton <bwelton@users.noreply.github.com>

* Updated version fetching

* source formatting (clang-format v11) (#509)

Co-authored-by: bwelton <bwelton@users.noreply.github.com>

* Merged

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: bwelton <bwelton@users.noreply.github.com>

[ROCm/rocprofiler-sdk commit: 7adffd5b22]

projects/rocprofiler-sdk/source/lib/rocprofiler-sdk/counters.cpp

@@ -40,22 +40,35 @@
 
 extern "C" {
 /**
- * @brief Query Counter name.
+ * @brief Query Counter info such as name or description.
  *
- * @param [in] counter_id
- * @param [out] name if nullptr, size will be returned
- * @param [out] size
+ * @param [in] counter_id counter to get info for
+ * @param [in] version Version of struct in info, see @ref rocprofiler_counter_info_version_id_t for
+ * available types
+ * @param [out] info rocprofiler_counter_info_{version}_t struct to write info to.
  * @return ::rocprofiler_status_t
+ * @retval ROCPROFILER_STATUS_SUCCESS if counter found
+ * @retval ROCPROFILER_STATUS_ERROR_COUNTER_NOT_FOUND if counter not found
+ * @retval ROCPROFILER_STATUS_ERROR_INCOMPATIBLE_ABI Version is not supported
  */
-rocprofiler_status_t
-rocprofiler_query_counter_name(rocprofiler_counter_id_t counter_id, const char** name, size_t* size)
+rocprofiler_status_t ROCPROFILER_API
+rocprofiler_query_counter_info(rocprofiler_counter_id_t              counter_id,
+                               rocprofiler_counter_info_version_id_t version,
+                               void*                                 info)
 {
+    if(version != ROCPROFILER_COUNTER_INFO_VERSION_0)
+        return ROCPROFILER_STATUS_ERROR_INCOMPATIBLE_ABI;
     const auto& id_map = *CHECK_NOTNULL(rocprofiler::counters::getMetricIdMap());
 
+    auto& out_struct = *static_cast<rocprofiler_counter_info_v0_t*>(info);
+
     if(const auto* metric_ptr = rocprofiler::common::get_val(id_map, counter_id.handle))
     {
-        *name = metric_ptr->name().c_str();
-        *size = metric_ptr->name().size();
+        out_struct.name        = metric_ptr->name().c_str();
+        out_struct.description = metric_ptr->description().c_str();
+        out_struct.is_derived  = !metric_ptr->expression().empty();
+        out_struct.block       = metric_ptr->block().c_str();
+        out_struct.expression  = metric_ptr->expression().c_str();
         return ROCPROFILER_STATUS_SUCCESS;
     }
 

projects/rocprofiler-sdk/source/lib/rocprofiler-sdk/counters/tests/metrics_test.cpp

@@ -183,11 +183,16 @@ TEST(metrics, check_public_api_query)
     const auto* id_map = counters::getMetricIdMap();
     for(const auto& [id, metric] : *id_map)
     {
-        const char* name = nullptr;
-        size_t      size = 0;
-        ASSERT_EQ(rocprofiler_query_counter_name({.handle = id}, &name, &size),
-                  ROCPROFILER_STATUS_SUCCESS);
-        EXPECT_EQ(std::string(name), metric.name());
-        EXPECT_EQ(size, metric.name().size());
+        rocprofiler_counter_info_v0_t version;
+
+        ASSERT_EQ(
+            rocprofiler_query_counter_info(
+                {.handle = id}, ROCPROFILER_COUNTER_INFO_VERSION_0, static_cast<void*>(&version)),
+            ROCPROFILER_STATUS_SUCCESS);
+        EXPECT_EQ(version.name, metric.name().c_str());
+        EXPECT_EQ(version.block, metric.block().c_str());
+        EXPECT_EQ(version.expression, metric.expression().c_str());
+        EXPECT_EQ(version.is_derived, !metric.expression().empty());
+        EXPECT_EQ(version.description, metric.description().c_str());
     }
 }