Skip to content

Commit

Permalink
SWDEV-492623: Hip Host Function to Device Symbols Mapping (#18)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <[email protected]>

* 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 <[email protected]>
Co-authored-by: Kuricheti, Mythreya <[email protected]>
Co-authored-by: Elwazir, Ammar <[email protected]>
Co-authored-by: Ammar ELWazir <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <[email protected]>
  • Loading branch information
7 people authored Dec 6, 2024
1 parent 61ce79c commit 78d8f4b
Show file tree
Hide file tree
Showing 25 changed files with 899 additions and 17 deletions.
91 changes: 91 additions & 0 deletions source/docs/rocprofv3-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -725,6 +725,97 @@
]
}
},
"host_functions": {
"type": "array",
"description": "Host function records.",
"items": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "Size of the host function record."
},
"host_function_id": {
"type": "integer",
"description": "ID of the HIP host function."
},
"kernel_id": {
"type": "integer",
"description": "ID of the corressponding kernel."
},
"code_object_id": {
"type": "integer",
"description": "ID of the corressponding code object."
},
"host_function_address": {
"type": "integer",
"description": "Address of the host function registered."
},
"modules_address": {
"type": "integer",
"description": "Address of the hip fat binary registered"
},
"device_function": {
"type": "string",
"description": "Device function name registered"
},
"thread_limit": {
"type": "integer",
"description": "Size of the thread limit."
},
"thread_id_address": {
"type": "integer",
"description": "Address of thread Id."
},
"block_id_address": {
"type": "string",
"description": "Address of Block Id."
},
"block_dim_address": {
"type": "string",
"description": "Address of Block Dimension"
},
"grid_dim_address": {
"type": "string",
"description": "Address of the Grid Dimension."
},
"workgroup_size_address": {
"type": "string",
"description": "Address of the work group size."
},
"formatted_host_function_name": {
"type": "string",
"description": "Formatted name of the device function."
},
"demangled_host_function_name": {
"type": "string",
"description": "Demangled name of device function."
},
"truncated_host_function_name": {
"type": "string",
"description": "Truncated name of device function."
}
},
"required": [
"size",
"host_function_id",
"kernel_id",
"code_object_id",
"host_function_address",
"modules_address",
"device_function",
"thread_limit",
"thread_id_address",
"block_id_address",
"block_dim_address",
"grid_dim_address",
"workgroup_size_address",
"formatted_host_function_name",
"demangled_host_function_name",
"truncated_host_function_name"
]
}
},
"callback_records": {
"type": "object",
"description": "Callback record details.",
Expand Down
21 changes: 21 additions & 0 deletions source/include/rocprofiler-sdk/callback_tracing.h
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,27 @@ typedef struct
uint32_t accum_vgpr_count; ///< Accum vector general purpose register count

} rocprofiler_callback_tracing_code_object_kernel_symbol_register_data_t;
// rename struct

typedef struct
{
uint64_t size; ///< size of this struct
uint64_t host_function_id; ///< unique host function identifier value
uint64_t kernel_id; ///< unique symbol identifier value
uint64_t code_object_id; ///< parent unique code object identifier
rocprofiler_address_t host_function; ///< kernel host function pointer
rocprofiler_address_t modules; ///< reference address where modules will be loaded
const char* device_function;
uint32_t thread_limit; ///< thread limit
rocprofiler_dim3_t thread_ids; ///< thread ids address
rocprofiler_dim3_t block_ids; ///< block ids address
rocprofiler_dim3_t block_dims; ///< block dimensions address
rocprofiler_dim3_t grid_dims; ///< grid dimensions address
uint64_t workgroup_size; ///< workgroup size address

/// @var device_function
/// @brief device function name used to map the metadata during kernel launch
} rocprofiler_callback_tracing_code_object_host_kernel_symbol_register_data_t;

/**
* @brief ROCProfiler Kernel Dispatch Callback Tracer Record.
Expand Down
26 changes: 26 additions & 0 deletions source/include/rocprofiler-sdk/cxx/serialization.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,13 @@ save(ArchiveT& ar, rocprofiler_dim3_t data)
ROCP_SDK_SAVE_DATA_FIELD(z);
}

template <typename ArchiveT>
void
save(ArchiveT& ar, rocprofiler_address_t data)
{
ROCP_SDK_SAVE_DATA_FIELD(value);
}

template <typename ArchiveT>
void
save(ArchiveT& ar, rocprofiler_callback_tracing_code_object_load_data_t data)
Expand Down Expand Up @@ -181,6 +188,25 @@ save(ArchiveT& ar, rocprofiler_callback_tracing_code_object_kernel_symbol_regist
ROCP_SDK_SAVE_DATA_FIELD(accum_vgpr_count);
}

template <typename ArchiveT>
void
save(ArchiveT& ar, rocprofiler_callback_tracing_code_object_host_kernel_symbol_register_data_t data)
{
ROCP_SDK_SAVE_DATA_FIELD(size);
ROCP_SDK_SAVE_DATA_FIELD(host_function_id);
ROCP_SDK_SAVE_DATA_FIELD(kernel_id);
ROCP_SDK_SAVE_DATA_FIELD(code_object_id);
ROCP_SDK_SAVE_DATA_FIELD(host_function);
ROCP_SDK_SAVE_DATA_FIELD(modules);
ROCP_SDK_SAVE_DATA_CSTR(device_function);
ROCP_SDK_SAVE_DATA_FIELD(thread_limit);
ROCP_SDK_SAVE_DATA_FIELD(thread_ids);
ROCP_SDK_SAVE_DATA_FIELD(block_ids);
ROCP_SDK_SAVE_DATA_FIELD(block_dims);
ROCP_SDK_SAVE_DATA_FIELD(grid_dims);
ROCP_SDK_SAVE_DATA_FIELD(workgroup_size);
}

template <typename ArchiveT>
void
save(ArchiveT& ar, rocprofiler_hsa_api_retval_t data)
Expand Down
13 changes: 2 additions & 11 deletions source/include/rocprofiler-sdk/cxx/utility.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,12 @@ namespace utility
{
template <typename Tp>
auto
_as_hex(Tp val, size_t width = 0)
as_hex(Tp val, size_t width = 0)
{
auto ss = std::stringstream{};
ss << "0x" << std::hex << std::setw(width) << std::setfill('0') << val;
ss << "0x" << std::hex << std::setfill('0') << std::setw(width) << val;
return ss.str();
}

#define ROCPROFILER_CXX_DEFINE_AS_HEX(TYPE) \
inline auto as_hex(TYPE val, size_t width = 0) \
{ \
return ::rocprofiler::sdk::utility::_as_hex(val, width); \
}

ROCPROFILER_CXX_DEFINE_AS_HEX(uint64_t)
#undef ROCPROFILER_CXX_DEFINE_AS_HEX
} // namespace utility
} // namespace sdk
} // namespace rocprofiler
3 changes: 2 additions & 1 deletion source/include/rocprofiler-sdk/fwd.h
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@ typedef enum // NOLINT(performance-enum-size)
{
ROCPROFILER_CODE_OBJECT_NONE = 0, ///< Unknown code object operation
ROCPROFILER_CODE_OBJECT_LOAD, ///< Code object containing kernel symbols
ROCPROFILER_CODE_OBJECT_DEVICE_KERNEL_SYMBOL_REGISTER, ///< Kernel symbols
ROCPROFILER_CODE_OBJECT_DEVICE_KERNEL_SYMBOL_REGISTER, ///< Kernel symbols - Device
ROCPROFILER_CODE_OBJECT_HOST_KERNEL_SYMBOL_REGISTER, ///< Kernel symbols - Host
ROCPROFILER_CODE_OBJECT_LAST,
} rocprofiler_code_object_operation_t;

Expand Down
1 change: 1 addition & 0 deletions source/lib/output/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions source/lib/output/generateJSON.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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));
}
}

Expand Down
92 changes: 92 additions & 0 deletions source/lib/output/host_symbol_info.hpp
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit 78d8f4b

Please sign in to comment.