Callback tracing for kernel dispatches + External correlation ID request service (#682)

* Support ROCPROFILER_CALLBACK_TRACING_KERNEL_DISPATCH * Fix doxygen * Update callback tracing - temporary hacks for kind operation name and iterate kind operations * Update source/include/rocprofiler-sdk - introduce sequence id for kernel dispatches * Update lib/rocprofiler-sdk (seq id) - support sequence id passing * Update tests (seq id) - testing for sequence ids * Cleanup include/rocprofiler-sdk/fwd.h * Misc cleanup * External Correlation ID Request Service (#699) * External correlation ID request service - callback requesting an external correlation ID instead of fetching from top of pushed external correlation ID stack * Update external correlation id request support - pass internal correlation ID in callback - async copy generates a correlation ID if none already exists - added external correlation ID request support for scratch memory tracing - updated scratch memory tracing to use tracing:: functions * Update hsa/queue.hpp - new line at EOF * Misc tweaks - remove unnecessary logging in agent.cpp - correlation_id::add_ref_count check for retirement - finalization check in HSA queue AsyncSignalHandler * Improve assertion failure logging in misc tests * Update include/rocprofiler-sdk/fwd.h - remove rocprofiler_record_counter_header_t * Move lib/rocprofiler-sdk/tracing.hpp into lib/rocprofiler-sdk/tracing/ folder * Update lib/rocprofiler-sdk/hsa/* - hsa::get_hsa_status_string - queue_info_session.hpp header - rocprofiler_packet.hpp * Update lib/rocprofiler-sdk/{counters,hip,marker} - execute_phase_exit_callbacks tweaks - queue_info_session tweaks * Move rocprofiler_kernel_dispatch_operation_t to include/rocprofiler-sdk/fwd.h * Update rocprofiler_buffer_tracing_kernel_dispatch_record_t - add operation field and thread_id field * Add lib/rocprofiler-sdk/kernel_dispatch - enum <-> string mapping for kernel dispatch - tracing implementations * Update lib/rocprofiler-sdk/CMakeLists.txt - tracing and kernel dispatch sub-directories * Update lib/rocprofiler-sdk/{buffer,callback}_tracing.cpp - invoke rocprofiler::kernel_tracing functions * Update tests/common/serialization.hpp - support operation and thread_id fields for rocprofiler_buffer_tracing_kernel_dispatch_record_t * Update tests/tools/json-tool.cpp - use external correlation id request service * Rename sequence_id to dispatch_id [ROCm/rocprofiler-sdk commit: 56030018dc]
2024-04-11 19:49:49 -05:00
commit 5e8a3b4f16
@@ -0,0 +1,7 @@
+#
+set(ROCPROFILER_LIB_KERNEL_DISPATCH_SOURCES kernel_dispatch.cpp tracing.cpp)
+set(ROCPROFILER_LIB_KERNEL_DISPATCH_HEADERS kernel_dispatch.hpp tracing.hpp)
+
+target_sources(
+    rocprofiler-object-library PRIVATE ${ROCPROFILER_LIB_KERNEL_DISPATCH_SOURCES}
+                                       ${ROCPROFILER_LIB_KERNEL_DISPATCH_HEADERS})
@@ -0,0 +1,132 @@
+// 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.
+
+#include "lib/rocprofiler-sdk/kernel_dispatch/kernel_dispatch.hpp"
+
+#include <string_view>
+
+#if defined(ROCPROFILER_CI)
+#    define ROCP_CI_LOG_IF(NON_CI_LEVEL, ...) LOG_IF(FATAL, __VA_ARGS__)
+#    define ROCP_CI_LOG(NON_CI_LEVEL, ...)    ROCP_FATAL
+#else
+#    define ROCP_CI_LOG_IF(NON_CI_LEVEL, ...) LOG_IF(NON_CI_LEVEL, __VA_ARGS__)
+#    define ROCP_CI_LOG(NON_CI_LEVEL, ...)    LOG(NON_CI_LEVEL)
+#endif
+
+namespace rocprofiler
+{
+namespace kernel_dispatch
+{
+namespace
+{
+#define ROCPROFILER_KERNEL_DISPATCH_INFO(CODE)                                                     \
+    template <>                                                                                    \
+    struct kernel_dispatch_info<ROCPROFILER_KERNEL_DISPATCH_##CODE>                                \
+    {                                                                                              \
+        static constexpr auto operation_idx = ROCPROFILER_KERNEL_DISPATCH_##CODE;                  \
+        static constexpr auto name          = #CODE;                                               \
+    };
+
+template <size_t Idx>
+struct kernel_dispatch_info;
+
+ROCPROFILER_KERNEL_DISPATCH_INFO(NONE)
+ROCPROFILER_KERNEL_DISPATCH_INFO(ENQUEUE)
+ROCPROFILER_KERNEL_DISPATCH_INFO(COMPLETE)
+
+template <size_t Idx, size_t... IdxTail>
+const char*
+name_by_id(const uint32_t id, std::index_sequence<Idx, IdxTail...>)
+{
+    if(Idx == id) return kernel_dispatch_info<Idx>::name;
+    if constexpr(sizeof...(IdxTail) > 0)
+        return name_by_id(id, std::index_sequence<IdxTail...>{});
+    else
+        return nullptr;
+}
+
+template <size_t Idx, size_t... IdxTail>
+uint32_t
+id_by_name(const char* name, std::index_sequence<Idx, IdxTail...>)
+{
+    if(std::string_view{kernel_dispatch_info<Idx>::name} == std::string_view{name})
+        return kernel_dispatch_info<Idx>::operation_idx;
+    if constexpr(sizeof...(IdxTail) > 0)
+        return id_by_name(name, std::index_sequence<IdxTail...>{});
+    else
+        return ROCPROFILER_HSA_AMD_EXT_API_ID_NONE;
+}
+
+template <size_t... Idx>
+void
+get_ids(std::vector<uint32_t>& _id_list, std::index_sequence<Idx...>)
+{
+    auto _emplace = [](auto& _vec, uint32_t _v) {
+        if(_v < static_cast<uint32_t>(ROCPROFILER_HSA_AMD_EXT_API_ID_LAST)) _vec.emplace_back(_v);
+    };
+
+    (_emplace(_id_list, kernel_dispatch_info<Idx>::operation_idx), ...);
+}
+
+template <size_t... Idx>
+void
+get_names(std::vector<const char*>& _name_list, std::index_sequence<Idx...>)
+{
+    auto _emplace = [](auto& _vec, const char* _v) {
+        if(_v != nullptr && strnlen(_v, 1) > 0) _vec.emplace_back(_v);
+    };
+
+    (_emplace(_name_list, kernel_dispatch_info<Idx>::name), ...);
+}
+}  // namespace
+
+const char*
+name_by_id(uint32_t id)
+{
+    return name_by_id(id, std::make_index_sequence<ROCPROFILER_KERNEL_DISPATCH_LAST>{});
+}
+
+uint32_t
+id_by_name(const char* name)
+{
+    return id_by_name(name, std::make_index_sequence<ROCPROFILER_KERNEL_DISPATCH_LAST>{});
+}
+
+std::vector<uint32_t>
+get_ids()
+{
+    auto _data = std::vector<uint32_t>{};
+    _data.reserve(ROCPROFILER_KERNEL_DISPATCH_LAST);
+    get_ids(_data, std::make_index_sequence<ROCPROFILER_KERNEL_DISPATCH_LAST>{});
+    return _data;
+}
+
+std::vector<const char*>
+get_names()
+{
+    auto _data = std::vector<const char*>{};
+    _data.reserve(ROCPROFILER_KERNEL_DISPATCH_LAST);
+    get_names(_data, std::make_index_sequence<ROCPROFILER_KERNEL_DISPATCH_LAST>{});
+    return _data;
+}
+}  // namespace kernel_dispatch
+}  // namespace rocprofiler
@@ -0,0 +1,48 @@
+// 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 "lib/rocprofiler-sdk/hsa/queue_info_session.hpp"
+
+#include <rocprofiler-sdk/rocprofiler.h>
+
+#include <cstdint>
+#include <vector>
+
+namespace rocprofiler
+{
+namespace kernel_dispatch
+{
+const char*
+name_by_id(uint32_t id);
+
+uint32_t
+id_by_name(const char* name);
+
+std::vector<const char*>
+get_names();
+
+std::vector<uint32_t>
+get_ids();
+}  // namespace kernel_dispatch
+}  // namespace rocprofiler
@@ -0,0 +1,145 @@
+// 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.
+
+#include "lib/rocprofiler-sdk/kernel_dispatch/tracing.hpp"
+#include "lib/rocprofiler-sdk/agent.hpp"
+#include "lib/rocprofiler-sdk/buffer.hpp"
+#include "lib/rocprofiler-sdk/context/context.hpp"
+#include "lib/rocprofiler-sdk/hsa/hsa.hpp"
+#include "lib/rocprofiler-sdk/hsa/queue.hpp"
+#include "lib/rocprofiler-sdk/tracing/tracing.hpp"
+
+#include <rocprofiler-sdk/callback_tracing.h>
+#include <rocprofiler-sdk/fwd.h>
+
+#include <hsa/hsa.h>
+
+#include <string_view>
+
+#if defined(ROCPROFILER_CI)
+#    define ROCP_CI_LOG_IF(NON_CI_LEVEL, ...) LOG_IF(FATAL, __VA_ARGS__)
+#    define ROCP_CI_LOG(NON_CI_LEVEL, ...)    ROCP_FATAL
+#else
+#    define ROCP_CI_LOG_IF(NON_CI_LEVEL, ...) LOG_IF(NON_CI_LEVEL, __VA_ARGS__)
+#    define ROCP_CI_LOG(NON_CI_LEVEL, ...)    LOG(NON_CI_LEVEL)
+#endif
+
+namespace rocprofiler
+{
+namespace kernel_dispatch
+{
+namespace
+{
+using queue_info_session_t     = hsa::queue_info_session;
+using kernel_dispatch_record_t = rocprofiler_buffer_tracing_kernel_dispatch_record_t;
+}  // namespace
+
+void
+dispatch_complete(queue_info_session_t& session)
+{
+    // get the contexts that were active when the signal was created
+    auto& tracing_data_v = session.tracing_data;
+    if(tracing_data_v.callback_contexts.empty() && tracing_data_v.buffered_contexts.empty()) return;
+
+    // we need to decrement this reference count at the end of the functions
+    auto* _corr_id = session.correlation_id;
+
+    // only do the following work if there are contexts that require this info
+    auto&       callback_record  = session.callback_record;
+    const auto& _extern_corr_ids = session.tracing_data.external_correlation_ids;
+    const auto* _rocp_agent      = agent::get_agent(callback_record.agent_id);
+    auto        _hsa_agent       = agent::get_hsa_agent(_rocp_agent);
+    auto        _kern_id         = callback_record.kernel_id;
+    auto        _signal          = session.kernel_pkt.kernel_dispatch.completion_signal;
+    auto        _tid             = session.tid;
+
+    auto dispatch_time = hsa_amd_profiling_dispatch_time_t{};
+    auto dispatch_time_status =
+        (_hsa_agent) ? hsa::get_amd_ext_table()->hsa_amd_profiling_get_dispatch_time_fn(
+                           *_hsa_agent, _signal, &dispatch_time)
+                     : HSA_STATUS_ERROR;
+
+    if(dispatch_time_status == HSA_STATUS_SUCCESS)
+    {
+        callback_record.start_timestamp = dispatch_time.start;
+        callback_record.end_timestamp   = dispatch_time.end;
+    }
+
+    // if we encounter this in CI, it will cause test to fail
+    ROCP_CI_LOG_IF(
+        ERROR,
+        dispatch_time_status == HSA_STATUS_SUCCESS && dispatch_time.end < dispatch_time.start)
+        << "hsa_amd_profiling_get_dispatch_time for kernel_id=" << _kern_id
+        << " on rocprofiler_agent=" << _rocp_agent->id.handle
+        << " returned dispatch times where the end time (" << dispatch_time.end
+        << ") was less than the start time (" << dispatch_time.start << ")";
+
+    ROCP_CI_LOG_IF(ERROR, dispatch_time_status != HSA_STATUS_SUCCESS)
+        << "hsa_amd_profiling_get_dispatch_time for kernel id=" << _kern_id << " returned "
+        << dispatch_time_status << " :: " << hsa::get_hsa_status_string(dispatch_time_status);
+
+    auto _internal_corr_id = (_corr_id) ? _corr_id->internal : 0;
+
+    if(dispatch_time_status == HSA_STATUS_SUCCESS)
+    {
+        if(!tracing_data_v.callback_contexts.empty())
+        {
+            auto tracer_data = callback_record;
+            tracing::execute_phase_none_callbacks(tracing_data_v.callback_contexts,
+                                                  _tid,
+                                                  _internal_corr_id,
+                                                  _extern_corr_ids,
+                                                  ROCPROFILER_CALLBACK_TRACING_KERNEL_DISPATCH,
+                                                  ROCPROFILER_KERNEL_DISPATCH_COMPLETE,
+                                                  tracer_data);
+        }
+
+        if(!tracing_data_v.buffered_contexts.empty())
+        {
+            auto record = kernel_dispatch_record_t{sizeof(kernel_dispatch_record_t),
+                                                   ROCPROFILER_BUFFER_TRACING_KERNEL_DISPATCH,
+                                                   ROCPROFILER_KERNEL_DISPATCH_COMPLETE,
+                                                   rocprofiler_correlation_id_t{},
+                                                   _tid,
+                                                   callback_record.start_timestamp,
+                                                   callback_record.end_timestamp,
+                                                   callback_record.agent_id,
+                                                   callback_record.queue_id,
+                                                   callback_record.kernel_id,
+                                                   callback_record.dispatch_id,
+                                                   callback_record.private_segment_size,
+                                                   callback_record.group_segment_size,
+                                                   callback_record.workgroup_size,
+                                                   callback_record.grid_size};
+
+            tracing::execute_buffer_record_emplace(tracing_data_v.buffered_contexts,
+                                                   _tid,
+                                                   _internal_corr_id,
+                                                   _extern_corr_ids,
+                                                   ROCPROFILER_BUFFER_TRACING_KERNEL_DISPATCH,
+                                                   ROCPROFILER_KERNEL_DISPATCH_COMPLETE,
+                                                   record);
+        }
+    }
+}
+}  // namespace kernel_dispatch
+}  // namespace rocprofiler
@@ -0,0 +1,39 @@
+// 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 "lib/rocprofiler-sdk/context/context.hpp"
+#include "lib/rocprofiler-sdk/hsa/queue_info_session.hpp"
+
+namespace rocprofiler
+{
+namespace kernel_dispatch
+{
+using context_t              = context::context;
+using user_data_map_t        = std::unordered_map<const context_t*, rocprofiler_user_data_t>;
+using external_corr_id_map_t = user_data_map_t;
+
+void
+dispatch_complete(hsa::queue_info_session&);
+}  // namespace kernel_dispatch
+}  // namespace rocprofiler