ATT API changes - add user_data field and separation of dispatch vs agent profiling (#893)

* DRM Issue Fix for SLES 15 (#897) * DRM Issue Fix * Formatting Fix * PC sampling: CID manager unit test (#898) * Adding per-dispatch userdata field to ATT * Clang tidy * Formatting * Update source/lib/rocprofiler-sdk/hsa/aql_packet.hpp Co-authored-by: Vladimir Indic <139573562+vlaindic@users.noreply.github.com> * Adding dispatch_id, fixing user_data and update aql_profile_v2 * Formatting * Tidy fixes * Second fix for userdata * removing assert for union * Adding serialization. Created agent profiling-like thread trace * Implemented agent thread trace * Update source/lib/rocprofiler-sdk/hsa/aql_packet.hpp Co-authored-by: Vladimir Indic <139573562+vlaindic@users.noreply.github.com> * Restructured thread trace packets * Added agent API tests * Fixing multigpu for agent test * Formatting * Formatting * Improving header locations * Fixing merge conflicts * Tidy * Tidy * Tidy --------- Co-authored-by: Ammar ELWazir <ammar.elwazir@amd.com> Co-authored-by: Vladimir Indic <139573562+vlaindic@users.noreply.github.com> [ROCm/rocprofiler-sdk commit: 9676295d3d]
2024-06-13 15:29:29 -03:00
parent f7c804f916
commit 37b0cfd7dc
24 changed files with 1154 additions and 635 deletions
@@ -108,6 +108,7 @@ set_source_files_properties(kernel_branch.cpp PROPERTIES COMPILE_FLAGS "-g -O2")
 set_source_files_properties(kernel_branch.cpp PROPERTIES LANGUAGE HIP)
 set_source_files_properties(kernel_lds.cpp PROPERTIES COMPILE_FLAGS "-g -O2")
 set_source_files_properties(kernel_lds.cpp PROPERTIES LANGUAGE HIP)
+set_source_files_properties(agent_test.cpp PROPERTIES LANGUAGE HIP)
 set_source_files_properties(main.cpp PROPERTIES LANGUAGE HIP)

 # Single dispatch test
@@ -155,3 +156,25 @@ set_tests_properties(
    thread-trace-api-multi-test
    PROPERTIES TIMEOUT 10 LABELS "integration-tests" ENVIRONMENT "${PRELOAD_ENV}"
               FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+
+# Agent profiling test
+add_executable(thread-trace-api-agent-test)
+target_sources(thread-trace-api-agent-test PRIVATE agent_test.cpp)
+
+target_link_libraries(thread-trace-api-agent-test
+                      PRIVATE rocprofiler-sdk::rocprofiler-sdk)
+
+if(ROCPROFILER_MEMCHECK_PRELOAD_ENV)
+    set(PRELOAD_ENV
+        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV}:$<TARGET_FILE:thread-trace-api-agent-test>")
+else()
+    set(PRELOAD_ENV "LD_PRELOAD=$<TARGET_FILE:thread-trace-api-agent-test>")
+endif()
+
+add_test(NAME thread-trace-api-agent-test
+         COMMAND $<TARGET_FILE:thread-trace-api-agent-test>)
+
+set_tests_properties(
+    thread-trace-api-agent-test
+    PROPERTIES TIMEOUT 10 LABELS "integration-tests" ENVIRONMENT "${PRELOAD_ENV}"
+               FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
@@ -0,0 +1,168 @@
+// 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.
+//
+// undefine NDEBUG so asserts are implemented
+#ifdef NDEBUG
+#    undef NDEBUG
+#endif
+
+#include <rocprofiler-sdk/amd_detail/thread_trace.h>
+#include <rocprofiler-sdk/registration.h>
+#include <rocprofiler-sdk/rocprofiler.h>
+#include "common.hpp"
+
+#include <atomic>
+#include <cassert>
+#include <cstdint>
+#include <cstdlib>
+#include <iostream>
+#include <map>
+#include <mutex>
+#include <sstream>
+#include <string>
+#include <string_view>
+#include <unordered_map>
+#include <vector>
+
+#include <unistd.h>
+
+#define HIP_API_CALL(CALL) assert((CALL) == hipSuccess)
+
+namespace ATTTest
+{
+namespace Agent
+{
+rocprofiler_context_id_t client_ctx = {};
+rocprofiler_client_id_t* client_id  = nullptr;
+std::atomic<bool>        valid_data{false};
+
+void
+shader_data_callback(int64_t /* se_id */,
+                     void*  se_data,
+                     size_t data_size,
+                     rocprofiler_user_data_t /* userdata */)
+{
+    if(se_data && data_size) valid_data.store(true);
+}
+
+rocprofiler_status_t
+query_available_agents(rocprofiler_agent_version_t /* version */,
+                       const void** agents,
+                       size_t       num_agents,
+                       void* /* user_data */)
+{
+    for(size_t idx = 0; idx < num_agents; idx++)
+    {
+        const auto* agent = static_cast<const rocprofiler_agent_v0_t*>(agents[idx]);
+        if(agent->type != ROCPROFILER_AGENT_TYPE_GPU) continue;
+
+        ROCPROFILER_CALL(rocprofiler_configure_agent_thread_trace_service(
+                             client_ctx, nullptr, 0, agent->id, shader_data_callback, nullptr),
+                         "thread trace service configure");
+
+        return ROCPROFILER_STATUS_SUCCESS;
+    }
+    return ROCPROFILER_STATUS_ERROR;
+}
+
+int
+tool_init(rocprofiler_client_finalize_t /* fini_func */, void* /* tool_data */)
+{
+    ROCPROFILER_CALL(rocprofiler_create_context(&client_ctx), "context creation");
+
+    ROCPROFILER_CALL(rocprofiler_query_available_agents(ROCPROFILER_AGENT_INFO_VERSION_0,
+                                                        query_available_agents,
+                                                        sizeof(rocprofiler_agent_t),
+                                                        nullptr),
+                     "");
+
+    int valid = 0;
+    ROCPROFILER_CALL(rocprofiler_context_is_valid(client_ctx, &valid), "context validity check");
+    return (valid == 0) ? -1 : 0;
+}
+
+void
+tool_fini(void* /* tool_data */)
+{
+    assert(valid_data.load());
+}
+
+}  // namespace Agent
+}  // namespace ATTTest
+
+extern "C" rocprofiler_tool_configure_result_t*
+rocprofiler_configure(uint32_t /* version */,
+                      const char* /* runtime_version */,
+                      uint32_t                 priority,
+                      rocprofiler_client_id_t* id)
+{
+    // only activate if main tool
+    if(priority > 0) return nullptr;
+
+    // set the client name
+    id->name = "ATT_test_agent_api";
+
+    // store client info
+    ATTTest::Agent::client_id = id;
+
+    // create configure data
+    static auto cfg =
+        rocprofiler_tool_configure_result_t{sizeof(rocprofiler_tool_configure_result_t),
+                                            &ATTTest::Agent::tool_init,
+                                            &ATTTest::Agent::tool_fini,
+                                            nullptr};
+
+    // return pointer to configure data
+    return &cfg;
+}
+
+void
+run(int dev)
+{
+    constexpr size_t size = 0x1000;
+    float*           ptr  = nullptr;
+
+    HIP_API_CALL(hipSetDevice(dev));
+
+    HIP_API_CALL(hipMalloc(&ptr, size * sizeof(float)));
+    HIP_API_CALL(hipMemset(ptr, 0x55, size * sizeof(float)));
+    HIP_API_CALL(hipFree(ptr));
+}
+
+int
+main()
+{
+    int ndev = 0;
+    HIP_API_CALL(hipGetDeviceCount(&ndev));
+
+    for(int dev = 0; dev < ndev; dev++)
+        run(dev);
+
+    ROCPROFILER_CALL(rocprofiler_start_context(ATTTest::Agent::client_ctx), "context start");
+
+    for(int dev = 0; dev < ndev; dev++)
+        run(dev);
+    usleep(100);
+
+    ROCPROFILER_CALL(rocprofiler_stop_context(ATTTest::Agent::client_ctx), "context stop");
+    return 0;
+}
@@ -87,7 +87,10 @@ tool_codeobj_tracing_callback(rocprofiler_callback_tracing_record_t record,
                              void* callback_data);

 void
-shader_data_callback(int64_t se_id, void* se_data, size_t data_size, void* userdata);
+shader_data_callback(int64_t                 se_id,
+                     void*                   se_data,
+                     size_t                  data_size,
+                     rocprofiler_user_data_t userdata);

 void
 callbacks_init();
@@ -55,11 +55,14 @@ dispatch_callback(rocprofiler_queue_id_t /* queue_id  */,
                  const rocprofiler_agent_t* /* agent  */,
                  rocprofiler_correlation_id_t /* correlation_id  */,
                  rocprofiler_kernel_id_t kernel_id,
-                  void*                   userdata)
+                  rocprofiler_dispatch_id_t /* dispatch_id */,
+                  rocprofiler_user_data_t* dispatch_userdata,
+                  void*                    userdata)
 {
    C_API_BEGIN
    assert(userdata && "Dispatch callback passed null!");
-    ToolData& tool = *reinterpret_cast<ToolData*>(userdata);
+    ToolData& tool         = *reinterpret_cast<ToolData*>(userdata);
+    dispatch_userdata->ptr = userdata;

    static std::atomic<int> call_id{0};
    static std::string_view desired_func_name = "branching_kernel";
@@ -102,15 +105,15 @@ tool_init(rocprofiler_client_finalize_t /* fini_func */, void* tool_data)
        "code object tracing service configure");

    std::vector<rocprofiler_att_parameter_t> params{};
-    params.push_back({ROCPROFILER_ATT_PARAMETER_CODE_OBJECT_TRACE_ENABLE, {1}});

-    ROCPROFILER_CALL(rocprofiler_configure_thread_trace_service(client_ctx,
-                                                                params.data(),
-                                                                params.size(),
-                                                                dispatch_callback,
-                                                                Callbacks::shader_data_callback,
-                                                                tool_data),
-                     "thread trace service configure");
+    ROCPROFILER_CALL(
+        rocprofiler_configure_dispatch_thread_trace_service(client_ctx,
+                                                            params.data(),
+                                                            params.size(),
+                                                            dispatch_callback,
+                                                            Callbacks::shader_data_callback,
+                                                            tool_data),
+        "thread trace service configure");

    int valid_ctx = 0;
    ROCPROFILER_CALL(rocprofiler_context_is_valid(client_ctx, &valid_ctx),
@@ -56,11 +56,14 @@ dispatch_callback(rocprofiler_queue_id_t /* queue_id  */,
                  const rocprofiler_agent_t* /* agent  */,
                  rocprofiler_correlation_id_t /* correlation_id  */,
                  rocprofiler_kernel_id_t kernel_id,
-                  void*                   userdata)
+                  rocprofiler_dispatch_id_t /* dispatch_id */,
+                  rocprofiler_user_data_t* dispatch_userdata,
+                  void*                    userdata)
 {
    C_API_BEGIN
    assert(userdata && "Dispatch callback passed null!");
-    ToolData& tool = *reinterpret_cast<ToolData*>(userdata);
+    ToolData& tool         = *reinterpret_cast<ToolData*>(userdata);
+    dispatch_userdata->ptr = userdata;

    static std::atomic<int> call_id{0};
    static std::string_view desired_func_name = "branching_kernel";
@@ -71,7 +74,7 @@ dispatch_callback(rocprofiler_queue_id_t /* queue_id  */,
        if(kernel_name.find(desired_func_name) == std::string::npos)
            return ROCPROFILER_ATT_CONTROL_NONE;

-        if(call_id.fetch_add(1) == 0) return ROCPROFILER_ATT_CONTROL_START_AND_STOP;
+        return ROCPROFILER_ATT_CONTROL_START_AND_STOP;
    } catch(...)
    {
        std::cerr << "Could not find kernel id: " << kernel_id << std::endl;
@@ -99,7 +102,7 @@ tool_init(rocprofiler_client_finalize_t /* fini_func */, void* tool_data)
        "code object tracing service configure");

    ROCPROFILER_CALL(
-        rocprofiler_configure_thread_trace_service(
+        rocprofiler_configure_dispatch_thread_trace_service(
            client_ctx, nullptr, 0, dispatch_callback, Callbacks::shader_data_callback, tool_data),
        "thread trace service configure");

@@ -210,11 +210,14 @@ isa_callback(char*     isa_instruction,
 }

 void
-shader_data_callback(int64_t se_id, void* se_data, size_t data_size, void* userdata)
+shader_data_callback(int64_t                 se_id,
+                     void*                   se_data,
+                     size_t                  data_size,
+                     rocprofiler_user_data_t userdata)
 {
    C_API_BEGIN
-    assert(userdata && "Shader callback passed null!");
-    ToolData& tool = *reinterpret_cast<ToolData*>(userdata);
+    assert(userdata.ptr && "Shader callback passed null!");
+    ToolData& tool = *reinterpret_cast<ToolData*>(userdata.ptr);

    trace_data_t data{.id = se_id, .data = (uint8_t*) se_data, .size = data_size, .tool = &tool};
    auto status = rocprofiler_att_parse_data(copy_trace_data, get_trace_data, isa_callback, &data);