SWDEV-549518 - Enable logging dynamically through HIP APIS. (#1079)

* SWDEV-549518 - Enable logging dynamically through HIP APIS.

* SWDEV-549518 - Adding ROCProfiler related new API changes.

* rocprofiler-sdk changes for hip api additions.

---------

Co-authored-by: Venkateshwar Reddy Kandula <venkateshwar.kandula1306@gmail.com>
Co-authored-by: jainprad <92369414+jainprad@users.noreply.github.com>

projects/hip-tests/catch/unit/errorHandling/hipDynamicLogging.cc

@@ -0,0 +1,156 @@
+/*
+Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in 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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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
+AUTHORS 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 IN
+THE SOFTWARE.
+*/
+
+#include <hip_test_common.hh>
+#include "OutCapture.hh"
+
+/**
+ * @addtogroup hipDynamicLogging hipDynamicLogging
+ * @{
+ * @ingroup ErrorTest
+ * `hipExtSetLoggingParams(size_t log_level, size_t log_size, size_t log_mask)` -
+ * Sets logging parameters for HIP runtime.
+ * `hipExtEnableLogging()` -
+ * Enables HIP runtime logging.
+ * `hipExtDisableLogging()` -
+ * Disables HIP runtime logging.
+ */
+
+static bool hipDynamicLoggingTest() {
+  // Create output capture instance
+  OutCapture capture;
+  capture.startCapture();
+
+  // Set Logging params
+  HIP_CHECK(hipExtSetLoggingParams(4, 0, -1));
+
+  // Logging is disabled here - allocate memory
+  int* dptr = nullptr;  
+  HIP_CHECK(hipMalloc(&dptr, sizeof(int)));
+
+  // Stop capture after hipMalloc and check no output (logging disabled)
+  std::string malloc_output = capture.stopCapture();
+  if (malloc_output.size() != 0) {
+    INFO("Unexpected logging output during hipMalloc (logging should be disabled): " << malloc_output);
+    return false;
+  }
+
+  // Start capture before enabling logging
+  capture.startCapture();
+
+  // Enable logging and do memset
+  HIP_CHECK(hipExtEnableLogging());
+  HIP_CHECK(hipMemset(dptr, 0x00, sizeof(int)));
+
+  // Disable logging 
+  HIP_CHECK(hipExtDisableLogging());
+
+  // Stop capture after disabling logging and check for output
+  std::string logging_output = capture.stopCapture();
+  if (logging_output.size() == 0) {
+    INFO("Expected logging output during enabled logging period, but got none");
+    return false;
+  }
+
+  // Clean up
+  HIP_CHECK(hipFree(dptr));
+
+  INFO("Successfully captured HIP logging output (" << logging_output.size() << " bytes)");
+  INFO("Logging output: " << logging_output);
+  
+  return true;
+}
+
+/**
+ * Test Description
+ * ------------------------
+ *  - Validates that HIP dynamic logging works correctly:
+ *    1. No output when logging is disabled
+ *    2. Logging output is captured when logging is enabled
+ *    3. hipMemset operation produces logging output during enabled period
+ * Test source
+ * ------------------------
+ *  - unit/errorHandling/hipDynamicLogging.cc  
+ * Test requirements
+ * ------------------------
+ *  - HIP_VERSION >= 5.6
+ */
+TEST_CASE("Unit_hipDynamicLogging_Positive_Basic") {
+  int numDevices = 0;
+  HIP_CHECK(hipGetDeviceCount(&numDevices));
+
+  if (numDevices <= 0) {
+    HipTest::HIP_SKIP_TEST("Skipping hipDynamicLogging test - no devices available");
+    return;
+  }
+
+  REQUIRE(hipDynamicLoggingTest() == true);
+}
+
+/**
+ * Test Description
+ * ------------------------
+ *  - Validates that hipExtSetLoggingParams sets logging parameters correctly
+ *    and that logging can be enabled/disabled multiple times
+ * Test source
+ * ------------------------
+ *  - unit/errorHandling/hipDynamicLogging.cc  
+ * Test requirements
+ * ------------------------
+ *  - HIP_VERSION >= 5.6
+ */
+TEST_CASE("Unit_hipDynamicLogging_Positive_MultipleEnableDisable") {
+  int numDevices = 0;
+  HIP_CHECK(hipGetDeviceCount(&numDevices));
+
+  if (numDevices <= 0) {
+    HipTest::HIP_SKIP_TEST("Skipping hipDynamicLogging test - no devices available");
+    return;
+  }
+
+  // Test multiple enable/disable cycles
+  OutCapture capture;
+  int* dptr = nullptr;
+  HIP_CHECK(hipMalloc(&dptr, sizeof(int)));
+
+  // Set different logging parameters
+  HIP_CHECK(hipExtSetLoggingParams(3, 0, -1));
+  
+  for (int i = 0; i < 3; ++i) {
+    // Start capture and enable logging
+    capture.startCapture();
+    HIP_CHECK(hipExtEnableLogging());
+    HIP_CHECK(hipMemset(dptr, 0x42, sizeof(int)));
+    HIP_CHECK(hipExtDisableLogging());
+    
+    // Check that we captured some output
+    std::string output = capture.stopCapture();
+    REQUIRE(output.size() > 0);
+  }
+
+  HIP_CHECK(hipFree(dptr));
+}
+
+/**
+ * End doxygen group ErrorTest.
+ * @}
+ */