SWDEV-492623: Hip Host Function to Device Symbols Mapping (#18)

* Adding changes to register and read symbols from the hip fat binary

* adding json output for host_functions

* added error handling

* adding json tool support

* Adding tests

* formatting changes

* Adding documentation

* refactoring as per amd-staging

* Adding intializers and changing macros

* Fix page-migration background thread on fork (#31)

* Fix page-migration background thread on fork

After falling off main in the forked child, all the children
try to join on on the parent's monitoring thread. This results
in a deadlock. Parent is waiting for the child to exit, but
the child is trying to join the parent's thread which is
signaled from the parent's static destructors.

Even with just one parent and child, due to copy-on-write
semantics, a child signalling the background thread to join
will still block (thread's updated state is not visible
in the child).

This fix creates background treads on fork per-child with a
pthread_atfork handler, ensuring that each child has its own
monitoring thread.

* Formatting fixes

* Detach page-migration background thread and update test timeout

* Attach files with ctest

* Update corr-id assert

* Tweak on-fork, simplify background thread

* Revert thread detach

* Adding --collection-period feature in rocprofv3 to match v1/v2 parity (#9)

* Adding Trace Period feature to rocprofv3

* Adding feature documentation

* Update source/bin/rocprofv3.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fixing format

* Moving to Collection Period and changing the input params

* Format Fixes

* Fixing rebasing issues

* Removing atomic include from the tool

* Adding more options for units, optimizing the code

* Fixing rocprofv3.py

* Fixing time conv & adding time controlled app

* Fixing format

* Changing to shared memory testing methodology

* use of shmem use

* Fix include headers for transpose-time-controlled.cpp

* Format upload-image-to-github.py

* Removing shmem and using only env var to dump timestamps from the tool

* Tool Fixes + Test Config

* Adding Tests

* Fixing Review comments

* Update trace period implementation

* Update trace period tests

* check between start and stop timestamps

* Merge Fix

* Update validate.py

* Improve safety of rocprofiler_stop_context after finalization

* Pass context id to collection_period_cntrl by value

* Adding 20 us error margin

* Ensure log level for collection-period test is not more than warning

---------

Co-authored-by: Ammar ELWazir <aelwazir@amd.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>

* Update lib/rocprofiler-sdk/code_object/hip/code_object.*

- move error code check macros to implementation
- fix macros which check error code
- use constexpr values instead of #define

* Update lib/rocprofiler-sdk/code_object/hip/code_object.*

- debugging for error that cannot be locally reproduced

* Update lib/rocprofiler-sdk/code_object/hip/code_object.*

- improve error handling and logging

* Update lib/rocprofiler-sdk/code_object/hip/code_object.*

- tweak to non-fatal logging messages

* Update lib/rocprofiler-sdk/code_object/hip/code_object.*

- cleanup of logging messages

* Update host kernel symbol register data fields

* Update source/lib/rocprofiler-sdk/code_object/hip/code_object.hpp

---------

Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>
Co-authored-by: Kuricheti, Mythreya <Mythreya.Kuricheti@amd.com>
Co-authored-by: Elwazir, Ammar <Ammar.Elwazir@amd.com>
Co-authored-by: Ammar ELWazir <aelwazir@amd.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>
This commit is contained in:
Jakaraddi, Manjunath
2024-12-06 03:42:37 -08:00
committed by GitHub
parent 61ce79c84d
commit 78d8f4b8ea
25 changed files with 899 additions and 17 deletions
+1
View File
@@ -19,6 +19,7 @@ set(TOOL_OUTPUT_HEADERS
generateStats.hpp
generator.hpp
kernel_symbol_info.hpp
host_symbol_info.hpp
metadata.hpp
output_config.hpp
output_key.hpp
+2
View File
@@ -164,10 +164,12 @@ write_json(json_output& json_ar,
{
auto kern_sym_data = tool_metadata.get_kernel_symbols();
auto host_sym_data = tool_metadata.get_host_symbols();
auto code_obj_data = tool_metadata.get_code_objects();
json_ar(cereal::make_nvp("code_objects", code_obj_data));
json_ar(cereal::make_nvp("kernel_symbols", kern_sym_data));
json_ar(cereal::make_nvp("host_functions", host_sym_data));
}
}
+92
View File
@@ -0,0 +1,92 @@
// 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/common/demangle.hpp"
#include "lib/common/logging.hpp"
#include <rocprofiler-sdk/callback_tracing.h>
#include <rocprofiler-sdk/fwd.h>
#include <rocprofiler-sdk/cxx/hash.hpp>
#include <rocprofiler-sdk/cxx/name_info.hpp>
#include <rocprofiler-sdk/cxx/operators.hpp>
#include <rocprofiler-sdk/cxx/serialization.hpp>
#include <cstdint>
#include <string>
#include <unordered_map>
#include <vector>
namespace rocprofiler
{
namespace tool
{
using rocprofiler_host_kernel_symbol_data_t =
rocprofiler_callback_tracing_code_object_host_kernel_symbol_register_data_t;
struct host_function_info : rocprofiler_host_kernel_symbol_data_t
{
using base_type = rocprofiler_host_kernel_symbol_data_t;
template <typename FuncT>
host_function_info(const base_type& _base, FuncT&& _formatter)
: base_type{_base}
, formatted_host_function_name{_formatter(CHECK_NOTNULL(_base.device_function))}
, demangled_host_function_name{common::cxx_demangle(CHECK_NOTNULL(_base.device_function))}
, truncated_host_function_name{common::truncate_name(demangled_host_function_name)}
{}
host_function_info();
~host_function_info() = default;
host_function_info(const host_function_info&) = default;
host_function_info(host_function_info&&) noexcept = default;
host_function_info& operator=(const host_function_info&) = default;
host_function_info& operator=(host_function_info&&) noexcept = default;
std::string formatted_host_function_name = {};
std::string demangled_host_function_name = {};
std::string truncated_host_function_name = {};
};
using host_function_data_vec_t = std::vector<host_function_info>;
using host_function_info_map_t = std::unordered_map<uint64_t, host_function_info>;
} // namespace tool
} // namespace rocprofiler
namespace cereal
{
#define SAVE_DATA_FIELD(FIELD) ar(make_nvp(#FIELD, data.FIELD))
template <typename ArchiveT>
void
save(ArchiveT& ar, const ::rocprofiler::tool::host_function_info& data)
{
cereal::save(
ar, static_cast<const ::rocprofiler::tool::rocprofiler_host_kernel_symbol_data_t&>(data));
SAVE_DATA_FIELD(formatted_host_function_name);
SAVE_DATA_FIELD(demangled_host_function_name);
SAVE_DATA_FIELD(truncated_host_function_name);
}
#undef SAVE_DATA_FIELD
} // namespace cereal
+52
View File
@@ -24,10 +24,13 @@
#include "lib/common/string_entry.hpp"
#include "lib/output/agent_info.hpp"
#include "lib/output/host_symbol_info.hpp"
#include "lib/output/kernel_symbol_info.hpp"
#include <rocprofiler-sdk/fwd.h>
#include <memory>
#include <vector>
namespace rocprofiler
{
@@ -67,6 +70,25 @@ kernel_symbol_info::kernel_symbol_info()
: base_type{0, 0, 0, "", 0, 0, 0, 0, 0, 0, 0, 0}
{}
constexpr auto null_address_v = rocprofiler_address_t{.value = 0};
constexpr auto null_dim3_v = rocprofiler_dim3_t{.x = 0, .y = 0, .z = 0};
host_function_info::host_function_info()
: base_type{0,
0,
0,
0,
null_address_v,
null_address_v,
"",
0,
null_dim3_v,
null_dim3_v,
null_dim3_v,
null_dim3_v,
0}
{}
metadata::metadata(inprocess)
: buffer_names{sdk::get_buffer_tracing_names()}
, callback_names{sdk::get_callback_tracing_names()}
@@ -196,6 +218,14 @@ metadata::get_kernel_symbol(uint64_t kernel_id) const
});
}
const host_function_info*
metadata::get_host_function(uint64_t host_function_id) const
{
return host_functions.rlock([host_function_id](const auto& _data) -> const host_function_info* {
return &_data.at(host_function_id);
});
}
const tool_counter_info*
metadata::get_counter_info(uint64_t instance_id) const
{
@@ -271,6 +301,18 @@ metadata::get_kernel_symbols() const
return _symbol_data;
}
host_function_data_vec_t
metadata::get_host_symbols() const
{
return host_functions.rlock([](const auto& _data_v) {
auto _info = std::vector<host_function_info>{};
_info.resize(_data_v.size() + 1, host_function_info{});
for(const auto& itr : _data_v)
_info.at(itr.first) = itr.second;
return _info;
});
}
metadata::agent_info_ptr_vec_t
metadata::get_gpu_agents() const
{
@@ -362,6 +404,16 @@ metadata::add_kernel_symbol(kernel_symbol_info&& sym)
std::move(sym));
}
bool
metadata::add_host_function(host_function_info&& func)
{
return host_functions.wlock(
[](host_function_info_map_t& _data_v, host_function_info&& _func_v) -> bool {
return _data_v.emplace(_func_v.host_function_id, std::move(_func_v)).second;
},
std::move(func));
}
bool
metadata::add_string_entry(size_t key, std::string_view str)
{
+5
View File
@@ -24,6 +24,7 @@
#include "agent_info.hpp"
#include "counter_info.hpp"
#include "host_symbol_info.hpp"
#include "kernel_symbol_info.hpp"
#include "pc_sample_transform.hpp"
@@ -100,6 +101,7 @@ struct metadata
synced_map<marker_message_map_t> marker_messages = {};
synced_map<string_entry_map_t> string_entries = {};
synced_map<external_corr_id_set_t> external_corr_ids = {};
synced_map<host_function_info_map_t> host_functions = {};
metadata() = default;
metadata(inprocess);
@@ -115,12 +117,14 @@ struct metadata
const agent_info* get_agent(rocprofiler_agent_id_t _val) const;
const code_object_info* get_code_object(uint64_t code_obj_id) const;
const kernel_symbol_info* get_kernel_symbol(uint64_t kernel_id) const;
const host_function_info* get_host_function(uint64_t host_function_id) const;
const tool_counter_info* get_counter_info(uint64_t instance_id) const;
const tool_counter_info* get_counter_info(rocprofiler_counter_id_t id) const;
const counter_dimension_info_vec_t* get_counter_dimension_info(uint64_t instance_id) const;
code_object_data_vec_t get_code_objects() const;
kernel_symbol_data_vec_t get_kernel_symbols() const;
host_function_data_vec_t get_host_symbols() const;
agent_info_ptr_vec_t get_gpu_agents() const;
counter_info_vec_t get_counter_info() const;
counter_dimension_vec_t get_counter_dimension_info() const;
@@ -138,6 +142,7 @@ struct metadata
bool add_marker_message(uint64_t corr_id, std::string&& msg);
bool add_code_object(code_object_info obj);
bool add_kernel_symbol(kernel_symbol_info&& sym);
bool add_host_function(host_function_info&& func);
bool add_string_entry(size_t key, std::string_view str);
bool add_external_correlation_id(uint64_t);