SWDEV-509568: rocprofiler v1 and v2 API deprecation notice (#5)

* SWDEV-509568: rocprofiler v1 and v2 API deprecation notice * correcting typo in warning message
ROCm · Feb 5, 2025 · 20415ef · 20415ef
1 parent 75280c9
commit 20415ef
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/include/rocprofiler/rocprofiler.h b/include/rocprofiler/rocprofiler.h
@@ -73,6 +73,10 @@ THE SOFTWARE.
 #endif /* !defined (ROCPROFILER_EXPORTS) */
 #endif /* !defined (ROCPROFILER) */
 
+// Deprecation warning for ROCProfiler V1 and V2
+#pragma message(                                                                                   \
+    "Warning: ROCProfiler and ROCTracer are being phased out in favor of the latest version ROCProfiler-SDK. We encourage all users to upgrade to ROCProfiler-SDK library and rocprofv3 tool, to ensure continued support and access to new features.")
+
 #include <stddef.h>
 #include <stdint.h>
 

diff --git a/include/rocprofiler/v2/rocprofiler.h b/include/rocprofiler/v2/rocprofiler.h
@@ -63,7 +63,7 @@ THE SOFTWARE.
  * - gfx1031 (Navy Flounder)
  * - gfx1032 (Dimgrey Cavefish)
  * - gfx1100 (Navi31)
-*
+ *
  * \section known_limitations Known limitations and restrictions
  *
  * The AMD Profiler API library implementation has the following
@@ -134,6 +134,10 @@ THE SOFTWARE.
 #define ROCPROFILER_EXPORT ROCPROFILER_EXPORT_DECORATOR ROCPROFILER_CALL
 #define ROCPROFILER_IMPORT ROCPROFILER_IMPORT_DECORATOR ROCPROFILER_CALL
 
+//Deprecation warning for ROCprofiler V1 and V2
+#pragma message(                                                                                   \
+    "Warning: ROCProfiler and ROCTracer are being phased out in favor of the latest version ROCProfiler-SDK. We encourage all users to upgrade to ROCProfiler-SDK library and rocprofv3 tool, to ensure continued support and access to new features.")
+
 #if !defined(ROCPROFILER)
 #if defined(ROCPROFILER_EXPORTS)
 #define ROCPROFILER_API ROCPROFILER_EXPORT