Benjamin Welton
3eb6a27bc6
* Add support for AQL dimension changes Adds support for returning dimensions from AQLProfile through rocprofiler to tools. Includes a much larger expanded test suite that covers nearly all files in counter collection. Specific changes below: samples/counter_collection/print_functional_counters: Modified to check the validity of dimensions returned in comparison to the actual underlying data obtained from a kernel execution. rocprofiler-sdk/aql/helpers: adds function calls to support fetching dimension information from AQLProfile. rocprofiler-sdk/aql/packet_construct: modified to allow for events to be exported to aid evaluate_ast in decoding the output buffer. lib/rocprofiler-sdk/counters: Instance count now derived from dimension sizes. rocprofiler_query_counter_dimensions now moved to a callback format to improve usability. rocprofiler-sdk/counters/core: Code migrations and exports of functions for testing. rocprofiler-sdk/counters/dimensions: Generates a dimension cache to be used when querying dimension information for a counter id. rocprofiler-sdk/counters/evaluate_ast: Modified to pass back correct dimension information and to check/determine output dimensions for derived counters. rocprofiler-sdk/counters/id_decode: Modified to have a map between dimension name -> dimension along with a conversion from the aql profile id for a dimension (string) -> integer based id (happens only once during init). rocprofiler-sdk/hsa/queue: Modified to allow for making testing easier. Specifically to allow Queue to now be mocked in unit tests for counter collection. * Merge with changes for serialization * Added suggestions * source formatting (clang-format v11) (#457) Co-authored-by: bwelton <bwelton@users.noreply.github.com> * Minor fix * Test change --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: bwelton <bwelton@users.noreply.github.com>
100 lines
4.6 KiB
C
100 lines
4.6 KiB
C
// MIT License
|
|
//
|
|
// 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.
|
|
|
|
#pragma once
|
|
|
|
#include <rocprofiler-sdk/agent.h>
|
|
#include <rocprofiler-sdk/defines.h>
|
|
#include <rocprofiler-sdk/fwd.h>
|
|
#include <rocprofiler-sdk/hsa.h>
|
|
#include <rocprofiler-sdk/profile_config.h>
|
|
|
|
ROCPROFILER_EXTERN_C_INIT
|
|
|
|
/**
|
|
* @defgroup DISPATCH_PROFILE_COUNTING_SERVICE Dispatch Profile Counting Service
|
|
* @brief Per-dispatch hardware counter collection service
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Kernel Dispatch Callback. This is a callback that is invoked before the kernel
|
|
* is enqueued into the HSA queue. What counters to collect for a kernel are set
|
|
* via passing back a profile config (config) in this callback. These counters
|
|
* will be collected and emplaced in the buffer with @ref rocprofiler_buffer_id_t used when
|
|
* setting up this callback.
|
|
*
|
|
* @param [in] queue_id Queue the kernel dispatch packet is being enqueued onto
|
|
* @param [in] agent Agent of this queue
|
|
* @param [in] correlation_id Correlation ID for this dispatch
|
|
* @param [in] dispatch_packet Kernel dispatch packet about to be enqueued into HSA
|
|
* @param [in] kernel_id Kernel identifier
|
|
* @param [in] callback_data_args Callback supplied via buffered_dispatch_profile_counting_service
|
|
* @param [out] config Profile config detailing the counters to collect for this kernel
|
|
*/
|
|
typedef void (*rocprofiler_profile_counting_dispatch_callback_t)(
|
|
rocprofiler_queue_id_t queue_id,
|
|
const rocprofiler_agent_t* agent,
|
|
rocprofiler_correlation_id_t correlation_id,
|
|
const hsa_kernel_dispatch_packet_t* dispatch_packet,
|
|
uint64_t kernel_id,
|
|
void* callback_data_args,
|
|
rocprofiler_profile_config_id_t* config);
|
|
|
|
/**
|
|
* @brief Configure buffered dispatch profile Counting Service.
|
|
* Collects the counters in dispatch packets and stores them
|
|
* in a buffer with @p buffer_id. The buffer may contain packets from more than
|
|
* one dispatch (denoted by correlation id). Will trigger the
|
|
* callback based on the parameters setup in buffer_id_t.
|
|
*
|
|
* NOTE: Interface is up for comment as to whether restrictions
|
|
* on agent should be made here (limiting the CB based on agent)
|
|
* or if the restriction should be performed by the tool in
|
|
* @ref rocprofiler_profile_counting_dispatch_callback_t (i.e.
|
|
* tool code checking the agent param to see if they want to profile
|
|
* it).
|
|
*
|
|
* Interface is up for comment as to whether restrictions
|
|
* on agent should be made here (limiting the CB based on agent)
|
|
* or if the restriction should be performed by the tool in
|
|
* @ref rocprofiler_profile_counting_dispatch_callback_t (i.e.
|
|
* tool code checking the agent param to see if they want to profile
|
|
* it).
|
|
*
|
|
* @param [in] context_id context id
|
|
* @param [in] buffer_id id of the buffer to use for the counting service
|
|
* @param [in] callback callback to perform when dispatch is enqueued
|
|
* @param [in] callback_data_args callback data
|
|
* @return ::rocprofiler_status_t
|
|
*/
|
|
rocprofiler_status_t ROCPROFILER_API
|
|
rocprofiler_configure_buffered_dispatch_profile_counting_service(
|
|
rocprofiler_context_id_t context_id,
|
|
rocprofiler_buffer_id_t buffer_id,
|
|
rocprofiler_profile_counting_dispatch_callback_t callback,
|
|
void* callback_data_args);
|
|
/** @} */
|
|
|
|
ROCPROFILER_EXTERN_C_FINI
|