Unit tests for coarse grain utilization counters

The unit tests for GFX and Memory activity counters. Change-Id: I968dabc9ef6de9d335d7f751b290fb713b51a79c [ROCm/rocm_smi_lib commit: 6340176b99]
2021-04-14 10:53:55 -04:00
@@ -0,0 +1,134 @@
+/*
+ * =============================================================================
+ *   ROC Runtime Conformance Release License
+ * =============================================================================
+ * The University of Illinois/NCSA
+ * Open Source License (NCSA)
+ *
+ * Copyright (c) 2021, Advanced Micro Devices, Inc.
+ * All rights reserved.
+ *
+ * Developed by:
+ *
+ *                 AMD Research and AMD ROC Software Development
+ *
+ *                 Advanced Micro Devices, Inc.
+ *
+ *                 www.amd.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal with the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ *  - Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimers.
+ *  - Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimers in
+ *    the documentation and/or other materials provided with the distribution.
+ *  - Neither the names of <Name of Development Group, Name of Institution>,
+ *    nor the names of its contributors may be used to endorse or promote
+ *    products derived from this Software without specific prior written
+ *    permission.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS WITH THE SOFTWARE.
+ *
+ */
+
+#include <stdint.h>
+#include <stddef.h>
+
+#include <iostream>
+#include <string>
+#include <map>
+
+#include "gtest/gtest.h"
+#include "rocm_smi/rocm_smi.h"
+#include "rocm_smi_test/functional/metrics_counter_read.h"
+#include "rocm_smi_test/test_common.h"
+
+
+TestMetricsCounterRead::TestMetricsCounterRead() : TestBase() {
+  set_title("RSMI GPU Metrics Counter Read Test");
+  set_description("The GPU Metrics Counter tests verifies that "
+                  "the gpu metrics counter info can be read properly.");
+}
+
+TestMetricsCounterRead::~TestMetricsCounterRead(void) {
+}
+
+void TestMetricsCounterRead::SetUp(void) {
+  TestBase::SetUp();
+
+  return;
+}
+
+void TestMetricsCounterRead::DisplayTestInfo(void) {
+  TestBase::DisplayTestInfo();
+}
+
+void TestMetricsCounterRead::DisplayResults(void) const {
+  TestBase::DisplayResults();
+  return;
+}
+
+void TestMetricsCounterRead::Close() {
+  // This will close handles opened within rsmitst utility calls and call
+  // rsmi_shut_down(), so it should be done after other hsa cleanup
+  TestBase::Close();
+}
+
+
+void TestMetricsCounterRead::Run(void) {
+  rsmi_status_t err;
+
+  TestBase::Run();
+  if (setup_failed_) {
+    std::cout << "** SetUp Failed for this test. Skipping.**" << std::endl;
+    return;
+  }
+
+  for (uint32_t i = 0; i < num_monitor_devs(); ++i) {
+    PrintDeviceHeader(i);
+
+    uint64_t timestamp;
+    // Coarse Grain counters
+    rsmi_utilization_counter_t utilization_counters[2];
+    utilization_counters[0].type = RSMI_COARSE_GRAIN_GFX_ACTIVITY;
+    utilization_counters[1].type = RSMI_COARSE_GRAIN_MEM_ACTIVITY;
+    err = rsmi_utilization_count_get(i, utilization_counters,
+                    2, &timestamp);
+    if (err != RSMI_STATUS_SUCCESS) {
+      if (err == RSMI_STATUS_NOT_SUPPORTED) {
+        IF_VERB(STANDARD) {
+          std::cout << "\t**" <<
+          "Not supported on this machine" << std::endl;
+          return;
+        }
+      }
+    } else {
+      CHK_ERR_ASRT(err);
+      IF_VERB(STANDARD) {
+          std::cout << std::dec << "gfx_activity="
+          << utilization_counters[0].value << '\n';
+          std::cout << std::dec << "mem_activity="
+          << utilization_counters[1].value << '\n';
+          std::cout << std::dec << "timestamp="
+          << timestamp << '\n';
+      }
+    }
+
+    // Verify api support checking functionality is working
+    err = rsmi_utilization_count_get(i, nullptr,
+                    1 , nullptr);
+    ASSERT_EQ(err, RSMI_STATUS_INVALID_ARGS);
+  }  // end for
+}
@@ -0,0 +1,73 @@
+/*
+ * =============================================================================
+ *   ROC Runtime Conformance Release License
+ * =============================================================================
+ * The University of Illinois/NCSA
+ * Open Source License (NCSA)
+ *
+ * Copyright (c) 2021, Advanced Micro Devices, Inc.
+ * All rights reserved.
+ *
+ * Developed by:
+ *
+ *                 AMD Research and AMD ROC Software Development
+ *
+ *                 Advanced Micro Devices, Inc.
+ *
+ *                 www.amd.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal with the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ *  - Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimers.
+ *  - Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimers in
+ *    the documentation and/or other materials provided with the distribution.
+ *  - Neither the names of <Name of Development Group, Name of Institution>,
+ *    nor the names of its contributors may be used to endorse or promote
+ *    products derived from this Software without specific prior written
+ *    permission.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS WITH THE SOFTWARE.
+ *
+ */
+#ifndef TESTS_ROCM_SMI_TEST_FUNCTIONAL_METRICS_COUNTER_READ_H_
+#define TESTS_ROCM_SMI_TEST_FUNCTIONAL_METRICS_COUNTER_READ_H_
+
+#include "rocm_smi_test/test_base.h"
+
+class TestMetricsCounterRead : public TestBase {
+ public:
+    TestMetricsCounterRead();
+
+  // @Brief: Destructor for test case of TestVOltRead
+  virtual ~TestMetricsCounterRead();
+
+  // @Brief: Setup the environment for measurement
+  virtual void SetUp();
+
+  // @Brief: Core measurement execution
+  virtual void Run();
+
+  // @Brief: Clean up and retrive the resource
+  virtual void Close();
+
+  // @Brief: Display  results
+  virtual void DisplayResults() const;
+
+  // @Brief: Display information about what this test does
+  virtual void DisplayTestInfo(void);
+};
+
+#endif  // TESTS_ROCM_SMI_TEST_FUNCTIONAL_METRICS_COUNTER_READ_H_
@@ -83,6 +83,7 @@
 #include "functional/init_shutdown_refcount.h"
 #include "rocm_smi_test/functional/hw_topology_read.h"
 #include "rocm_smi_test/functional/gpu_metrics_read.h"
+#include "rocm_smi_test/functional/metrics_counter_read.h"
 #include "rocm_smi_test/functional/perf_determinism.h"

 static RSMITstGlobals *sRSMIGlvalues = nullptr;
@@ -234,6 +235,10 @@ TEST(rsmitstReadOnly, TestGpuMetricsRead) {
  TestGpuMetricsRead tst;
  RunGenericTest(&tst);
 }
+TEST(rsmitstReadOnly, TestMetricsCounterRead) {
+  TestMetricsCounterRead tst;
+  RunGenericTest(&tst);
+}
 TEST(rsmitstReadWrite, TestPerfDeterminism) {
  TestPerfDeterminism tst;
  RunGenericTest(&tst);