[2/N] Agent Counter implementation with unit tests to check functionality (#846)

Agent Counter Collection API with tests and samples.
---------

Co-authored-by: Benjamin Welton <ben@amd.com>

source/include/rocprofiler-sdk/agent_profile.h

@@ -25,36 +25,98 @@
 #include <rocprofiler-sdk/defines.h>
 #include <rocprofiler-sdk/fwd.h>
 
-ROCPROFILER_EXTERN_C_INIT
-
 /**
  * @defgroup AGENT_PROFILE_COUNTING_SERVICE Agent Profile Counting Service
  * @brief needs brief description
  *
  * @{
  */
+ROCPROFILER_EXTERN_C_INIT
 
 /**
- * @brief Configure Profile Counting Service for agent.
+ * @brief Callback to set the profile config for the agent.
  *
  * @param [in] context_id context id
- * @param [in] buffer_id id of the buffer to use for the counting service
  * @param [in] config_id Profile config detailing the counters to collect for this kernel
  * @return ::rocprofiler_status_t
+ * @retval ::ROCPROFILER_STATUS_ERROR_PROFILE_NOT_FOUND Returned if the config_id is not found
+ * @retval ::ROCPROFILER_STATUS_ERROR_CONTEXT_INVALID Returned if the ctx is not valid
+ * @retval ::ROCPROFILER_STATUS_ERROR_CONFIGURATION_LOCKED Returned if attempting to make this
+ * call outside of context startup.
+ * @retval ::ROCPROFILER_STATUS_ERROR_AGENT_MISMATCH Agent of profile does not match agent of the
+ * context.
+ * @retval ::ROCPROFILER_STATUS_SUCCESS Returned if succesfully configured
  */
-rocprofiler_status_t ROCPROFILER_API
-rocprofiler_configure_agent_profile_counting_service(rocprofiler_context_id_t        context_id,
-                                                     rocprofiler_buffer_id_t         buffer_id,
-                                                     rocprofiler_profile_config_id_t config_id);
+typedef rocprofiler_status_t (*rocprofiler_agent_set_profile_callback_t)(
+    rocprofiler_context_id_t        context_id,
+    rocprofiler_profile_config_id_t config_id);
 
 /**
- * @brief Sample Profile Counting Service for agent.
+ * @brief Configure Profile Counting Service for agent. Called when the context is started.
+ *        Selects the counters to be used for agent profiling.
  *
- * @param [out] data // It is always a size of one
- * @return ::rocprofiler_status_t
+ * @param [in]  context_id context id
+ * @param [in]  agent_id agent id
+ * @param [in]  set_config Function to call to set the profile config (see
+ * rocprofiler_agent_set_profile_callback_t)
+ * @param [in]  user_data Data supplied to rocprofiler_configure_agent_profile_counting_service
  */
-rocprofiler_status_t ROCPROFILER_API
-rocprofiler_sample_agent_profile_counting_service(rocprofiler_context_id_t context_id);
+typedef void (*rocprofiler_agent_profile_callback_t)(
+    rocprofiler_context_id_t                 context_id,
+    rocprofiler_agent_id_t                   agent_id,
+    rocprofiler_agent_set_profile_callback_t set_config,
+    void*                                    user_data);
+
+/**
+ * @brief Configure Profile Counting Service for agent. There may only be one agent profile
+ * configured per context and can be only one active context that is profiling a single agent
+ * at a time. Multiple agent contexts can be started at the same time if they are profiling
+ * different agents.
+ *
+ * @param [in] context_id context id
+ * @param [in] buffer_id id of the buffer to use for the counting service. When
+ * rocprofiler_sample_agent_profile_counting_service is called, counter data will be written
+ * to this buffer.
+ * @param [in] agent_id agent to configure profiling on.
+ * @param [in] cb Callback called when the context is started for the tool to specify what
+ * counters to collect (rocprofiler_profile_config_id_t).
+ * @param [in] user_data User supplied data to be passed to the callback cb when triggered
+ * @param [in] config_id Profile config detailing the counters to collect for this kernel
+ * @return ::rocprofiler_status_t
+ * @retval ::ROCPROFILER_STATUS_ERROR_CONTEXT_INVALID Returned if the context does not exist.
+ * @retval ::ROCPROFILER_STATUS_ERROR_BUFFER_NOT_FOUND Returned if the buffer is not found.
+ * @retval ::ROCPROFILER_STATUS_SUCCESS Returned if succesfully configured
+ */
+rocprofiler_status_t
+rocprofiler_configure_agent_profile_counting_service(rocprofiler_context_id_t context_id,
+                                                     rocprofiler_buffer_id_t  buffer_id,
+                                                     rocprofiler_agent_id_t   agent_id,
+                                                     rocprofiler_agent_profile_callback_t cb,
+                                                     void*                                user_data)
+    ROCPROFILER_NONNULL(4) ROCPROFILER_API;
+
+/**
+ * @brief Trigger a read of the counter data for the agent profile. The counter data will be
+ * written to the buffer specified in rocprofiler_configure_agent_profile_counting_service.
+ * The data in rocprofiler_user_data_t will be written to the buffer along with the counter data.
+ * flags can be used to specify if this call should be performed asynchronously (default is
+ * synchronous).
+ *
+ * @param [in] context_id context id
+ * @param [in] user_data User supplied data, included in records outputted to buffer.
+ * @param [in] flags Flags to specify how the counter data should be collected (defaults to sync).
+ * @return ::rocprofiler_status_t
+ * @retval ::ROCPROFILER_STATUS_ERROR_CONTEXT_INVALID Returned if the context does not exist or
+ * the context is not configured for agent profiling.
+ * @retval ::ROCPROFILER_STATUS_ERROR_CONTEXT_ERROR Returned if another operation is in progress (
+ * start/stop ctx or another read).
+ * @retval ::ROCPROFILER_STATUS_ERROR Returned if HSA has not been initialized yet.
+ * @retval ::ROCPROFILER_STATUS_SUCCESS Returned if read request was successful.
+ */
+rocprofiler_status_t
+rocprofiler_sample_agent_profile_counting_service(rocprofiler_context_id_t   context_id,
+                                                  rocprofiler_user_data_t    user_data,
+                                                  rocprofiler_counter_flag_t flags) ROCPROFILER_API;
 
 /** @} */
 

source/include/rocprofiler-sdk/fwd.h

@@ -97,6 +97,11 @@ typedef enum  // NOLINT(performance-enum-size)
     ROCPROFILER_STATUS_ERROR_PROFILE_NOT_FOUND,    ///< Could not find the counter profile
     ROCPROFILER_STATUS_ERROR_AGENT_DISPATCH_CONFLICT,  ///< Cannot enable both agent and dispatch
                                                        ///< counting in the same context.
+    ROCPROFILER_STATUS_INTERNAL_NO_AGENT_CONTEXT,   ///< No agent context found, may not be an error
+    ROCPROFILER_STATUS_ERROR_SAMPLE_RATE_EXCEEDED,  ///< Sample rate exceeded
+    ROCPROFILER_STATUS_ERROR_NO_PROFILE_QUEUE,      ///< Profile queue creation failed
+    ROCPROFILER_STATUS_ERROR_NO_HARDWARE_COUNTERS,  ///< No hardware counters were specified
+    ROCPROFILER_STATUS_ERROR_AGENT_MISMATCH,        ///< Agent mismatch between profile and context.
     ROCPROFILER_STATUS_LAST,
 } rocprofiler_status_t;
 
@@ -385,6 +390,16 @@ typedef enum
     /// ::rocprofiler_profile_counting_dispatch_record_t
 } rocprofiler_counter_record_kind_t;
 
+/**
+ * @brief Enumeration of flags that can be used with some counter api calls
+ */
+typedef enum
+{
+    ROCPROFILER_COUNTER_FLAG_NONE = 0,
+    ROCPROFILER_COUNTER_FLAG_ASYNC,  ///< Do not wait for completion before returning.
+    ROCPROFILER_COUNTER_FLAG_LAST,
+} rocprofiler_counter_flag_t;
+
 //--------------------------------------------------------------------------------------//
 //
 //                                      ALIASES
@@ -651,6 +666,7 @@ typedef struct
     rocprofiler_counter_instance_id_t id;             ///< counter identifier
     double                            counter_value;  ///< counter value
     rocprofiler_dispatch_id_t         dispatch_id;
+    rocprofiler_user_data_t           user_data;
 
     /// @var dispatch_id
     /// @brief A value greater than zero indicates that this counter record is associated with a