Remove internal functions from the ROCtracer API

The roctracer_load, roctracer_unload, and roctrace_flush_buf functions
are not part of the ROCtracer API, and should not be exposed in the API
header file, but keep the functions in the library for backward
compatibility.

Add src/roctracer/backward_compat.cpp to implement retired functions.

Add test/app/backward_compat_test.cpp to test that the retired functions
are still accessible in the latest roctracer library.

Change-Id: I4c94310a7bfccfeae9384dac5db18fc79b4c5b17

test/CMakeLists.txt

@@ -111,6 +111,11 @@ hip_add_executable(roctx_test EXCLUDE_FROM_ALL app/roctx_test.cpp)
 target_link_libraries(roctx_test Threads::Threads roctx)
 add_dependencies(mytest roctx_test)
 
+## Build the backward compatibility test
+add_executable(backward_compat_test EXCLUDE_FROM_ALL app/backward_compat_test.cpp)
+target_link_libraries(backward_compat_test roctracer)
+add_dependencies(mytest backward_compat_test)
+
 ## Copy the golden traces and test scripts
 configure_file(run.sh ${PROJECT_BINARY_DIR} COPYONLY)
 execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink run.sh ${PROJECT_BINARY_DIR}/run_ci.sh)

test/app/backward_compat_test.cpp

@@ -0,0 +1,32 @@
+/* Copyright (c) 2022 Advanced Micro Devices, Inc.
+
+ 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 "roctracer.h"
+
+extern "C" int roctracer_load();        // Removed in ROCTX 4.1
+extern "C" void roctracer_unload();     // Removed in ROCTX 4.1
+extern "C" void roctracer_flush_buf();  // Removed in ROCTX 4.1
+
+int main() {
+  if (roctracer_load() != 1) return -1;
+  roctracer_flush_buf();
+  roctracer_unload();
+  return 0;
+}

test/golden_traces/tests_trace_cmp_levels.txt

@@ -17,3 +17,4 @@ hsa_co_trace --check-none
 code_obj_trace --check-none
 trace_buffer_trace --check-none
 roctx_test_trace --check-count .*
+backward_compat_test_trace --check-none

test/run.sh

@@ -185,6 +185,8 @@ eval_test "tool tracer codeobj" ./test/MatrixTranspose code_obj_trace
 
 eval_test "directed TraceBuffer test" ./test/trace_buffer trace_buffer_trace
 
+eval_test "backward compatibilty tests" ./test/backward_compat_test backward_compat_test_trace
+
 echo "$test_number tests total / $test_runnum tests run / $test_status tests failed"
 if [ $test_status != 0 ] ; then
   echo $failed_tests