[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>

cmake/rocprofiler_build_settings.cmake

@@ -203,6 +203,19 @@ if(ROCPROFILER_BUILD_CI_STRICT_TIMESTAMPS)
                                            INTERFACE ROCPROFILER_CI_STRICT_TIMESTAMPS)
 endif()
 
+# ----------------------------------------------------------------------------------------#
+# extra flags for compiling with experimental warnings
+#
+target_compile_definitions(rocprofiler-sdk-experimental-flags
+                           INTERFACE ROCPROFILER_SDK_EXPERIMENTAL_WARNINGS=1)
+rocprofiler_target_compile_options(rocprofiler-sdk-experimental-flags
+                                   INTERFACE "-Wno-deprecated-declarations")
+
+if(ROCPROFILER_BUILD_EXPERIMENTAL_WARNINGS)
+    target_link_libraries(rocprofiler-sdk-build-flags
+                          INTERFACE rocprofiler-sdk::rocprofiler-sdk-experimental-flags)
+endif()
+
 # ----------------------------------------------------------------------------------------#
 # user customization
 #

cmake/rocprofiler_interfaces.cmake

@@ -38,6 +38,9 @@ rocprofiler_add_interface_library(rocprofiler-sdk-release-flags
 rocprofiler_add_interface_library(rocprofiler-sdk-stack-protector
                                   "Adds stack-protector compiler flags" INTERNAL)
 rocprofiler_add_interface_library(rocprofiler-sdk-memcheck INTERFACE INTERNAL)
+rocprofiler_add_interface_library(
+    rocprofiler-sdk-experimental-flags
+    "Compiler flags for experimental feature compilation" INTERNAL)
 
 #
 # interfaces for libraries (general)

cmake/rocprofiler_options.cmake

@@ -81,6 +81,11 @@ rocprofiler_add_option(ROCPROFILER_UNSAFE_NO_VERSION_CHECK
 rocprofiler_add_option(
     ROCPROFILER_REGENERATE_COUNTERS_PARSER
     "Regenerate the counter parser (requires bison and flex)" OFF ADVANCED)
+rocprofiler_add_option(
+    ROCPROFILER_BUILD_EXPERIMENTAL_WARNINGS
+    "Enable warnings for experimental features but hide with -Wno-deprecated-declarations (this ensures that experimental warning message does not break macros)"
+    OFF
+    ADVANCED)
 
 # In the future, we will do this even with clang-tidy enabled
 foreach(_OPT ROCPROFILER_BUILD_DEVELOPER ROCPROFILER_BUILD_WERROR)

cmake/rocprofiler_utilities.cmake

@@ -968,7 +968,7 @@ function(rocprofiler_parse_hsa_api_table_versions _TARGET)
                         _VAL
                         "${_LINE}")
 
-                # used with cmakedefine in source/include/rocprofiler-sdk/version.h.in
+                # used with cmakedefine in source/include/rocprofiler-sdk/ext_version.h.in
                 if(_VAR AND _VAL)
                     set(ROCPROFILER_${_VAR}
                         "${_VAL}"