From bf75579566f68c104e6f9bef425b06fac45cddaf Mon Sep 17 00:00:00 2001 From: "Jonathan R. Madsen" Date: Thu, 2 May 2024 01:50:28 -0500 Subject: [PATCH] C++ headers for `std::hash`, `operator==`, `operator!=` (#833) * C++ headers for std::hash, operator==, operator!= * std::hash specializations for some HSA types --- .../rocprofiler-sdk/cxx/CMakeLists.txt | 4 +- source/include/rocprofiler-sdk/cxx/hash.hpp | 70 ++++++++++ .../include/rocprofiler-sdk/cxx/operators.hpp | 122 ++++++++++++++++++ source/lib/rocprofiler-sdk-tool/tool.cpp | 17 +-- .../rocprofiler-sdk/counters/tests/core.cpp | 13 +- tests/common/hash.hpp | 20 +-- 6 files changed, 199 insertions(+), 47 deletions(-) create mode 100644 source/include/rocprofiler-sdk/cxx/hash.hpp create mode 100644 source/include/rocprofiler-sdk/cxx/operators.hpp diff --git a/source/include/rocprofiler-sdk/cxx/CMakeLists.txt b/source/include/rocprofiler-sdk/cxx/CMakeLists.txt index 9aae92d4a2..9e3b92c117 100644 --- a/source/include/rocprofiler-sdk/cxx/CMakeLists.txt +++ b/source/include/rocprofiler-sdk/cxx/CMakeLists.txt @@ -1,9 +1,9 @@ # # -# Installation of public C++ headers +# Installation of public C++ headers # # -set(ROCPROFILER_CXX_HEADER_FILES name_info.hpp serialization.hpp) +set(ROCPROFILER_CXX_HEADER_FILES hash.hpp name_info.hpp operators.hpp serialization.hpp) install( FILES ${ROCPROFILER_CXX_HEADER_FILES} diff --git a/source/include/rocprofiler-sdk/cxx/hash.hpp b/source/include/rocprofiler-sdk/cxx/hash.hpp new file mode 100644 index 0000000000..774942585a --- /dev/null +++ b/source/include/rocprofiler-sdk/cxx/hash.hpp @@ -0,0 +1,70 @@ +// 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 +#include + +namespace rocprofiler +{ +namespace sdk +{ +namespace hash +{ +template +struct handle_hasher +{ + static_assert(sizeof(Tp) == sizeof(uint64_t), "error! only for opaque handle types"); + size_t operator()(Tp val) const { return val.handle; } +}; +} // namespace hash +} // namespace sdk +} // namespace rocprofiler + +namespace std +{ +template +struct hash; + +#define ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(TYPE) \ + template <> \ + struct hash : public rocprofiler::sdk::hash::handle_hasher \ + { \ + using parent_type = ::rocprofiler::sdk::hash::handle_hasher; \ + using parent_type::operator(); \ + }; + +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_context_id_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_agent_id_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_queue_id_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_buffer_id_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_counter_id_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_profile_config_id_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(rocprofiler_callback_thread_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(hsa_agent_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(hsa_signal_t) +ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER(hsa_executable_t) + +#undef ROCPROFILER_CXX_SPECIALIZE_HANDLE_HASHER +} // namespace std diff --git a/source/include/rocprofiler-sdk/cxx/operators.hpp b/source/include/rocprofiler-sdk/cxx/operators.hpp new file mode 100644 index 0000000000..dd4bcc6dac --- /dev/null +++ b/source/include/rocprofiler-sdk/cxx/operators.hpp @@ -0,0 +1,122 @@ +// 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 +#include +#include +#include + +#include + +#define ROCPROFILER_CXX_DECLARE_OPERATORS(TYPE) \ + bool operator==(TYPE lhs, TYPE rhs) ROCPROFILER_ATTRIBUTE(pure); \ + bool operator!=(TYPE lhs, TYPE rhs) ROCPROFILER_ATTRIBUTE(pure); + +#define ROCPROFILER_CXX_DEFINE_NE_OPERATOR(TYPE) \ + inline bool operator!=(TYPE lhs, TYPE rhs) { return !(lhs == rhs); } + +#define ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(TYPE) \ + inline bool operator==(TYPE lhs, TYPE rhs) \ + { \ + return ::rocprofiler::sdk::operators::equal(lhs, rhs); \ + } + +namespace rocprofiler +{ +namespace sdk +{ +namespace operators +{ +template +bool +equal(Tp lhs, Tp rhs) ROCPROFILER_ATTRIBUTE(pure); + +template +bool +equal(Tp lhs, Tp rhs) +{ + static_assert(sizeof(Tp) == sizeof(uint64_t), "error! only for opaque handle types"); + return lhs.handle == rhs.handle; +} +} // namespace operators +} // namespace sdk +} // namespace rocprofiler + +// declaration of operator== and operator!= +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_context_id_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_agent_id_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_queue_id_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_buffer_id_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_counter_id_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_profile_config_id_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_callback_thread_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(hsa_agent_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(hsa_signal_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(hsa_executable_t) +ROCPROFILER_CXX_DECLARE_OPERATORS(const rocprofiler_agent_v0_t&) +ROCPROFILER_CXX_DECLARE_OPERATORS(rocprofiler_dim3_t) + +// definitions of operator== +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_context_id_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_agent_id_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_queue_id_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_buffer_id_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_counter_id_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_profile_config_id_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(rocprofiler_callback_thread_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(hsa_agent_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(hsa_signal_t) +ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR(hsa_executable_t) + +inline bool +operator==(const rocprofiler_agent_v0_t& lhs, const rocprofiler_agent_v0_t& rhs) +{ + return (lhs.id == rhs.id); +} + +inline bool +operator==(rocprofiler_dim3_t lhs, rocprofiler_dim3_t rhs) +{ + return std::tie(lhs.x, lhs.y, lhs.z) == std::tie(rhs.x, rhs.y, rhs.z); +} + +// definitions of operator!= +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_context_id_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_agent_id_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_queue_id_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_buffer_id_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_counter_id_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_profile_config_id_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_callback_thread_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(hsa_agent_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(hsa_signal_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(hsa_executable_t) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(const rocprofiler_agent_v0_t&) +ROCPROFILER_CXX_DEFINE_NE_OPERATOR(rocprofiler_dim3_t) + +// cleanup defines +#undef ROCPROFILER_CXX_DECLARE_OPERATORS +#undef ROCPROFILER_CXX_DEFINE_NE_OPERATOR +#undef ROCPROFILER_CXX_DEFINE_EQ_HANDLE_OPERATOR diff --git a/source/lib/rocprofiler-sdk-tool/tool.cpp b/source/lib/rocprofiler-sdk-tool/tool.cpp index cba611eb25..d93cbd4305 100644 --- a/source/lib/rocprofiler-sdk-tool/tool.cpp +++ b/source/lib/rocprofiler-sdk-tool/tool.cpp @@ -41,6 +41,8 @@ #include #include #include +#include +#include #include @@ -67,21 +69,6 @@ __gcov_dump(void); namespace common = ::rocprofiler::common; namespace tool = ::rocprofiler::tool; -namespace std -{ -template <> -struct hash -{ - size_t operator()(rocprofiler_agent_id_t id) const { return id.handle; } -}; -} // namespace std - -inline bool -operator==(rocprofiler_agent_id_t lhs, rocprofiler_agent_id_t rhs) -{ - return (lhs.handle == rhs.handle); -} - namespace { constexpr uint32_t lds_block_size = 128 * 4; diff --git a/source/lib/rocprofiler-sdk/counters/tests/core.cpp b/source/lib/rocprofiler-sdk/counters/tests/core.cpp index 04b5a8ad51..80067146a7 100644 --- a/source/lib/rocprofiler-sdk/counters/tests/core.cpp +++ b/source/lib/rocprofiler-sdk/counters/tests/core.cpp @@ -35,6 +35,7 @@ #include #include #include +#include #include #include @@ -342,18 +343,6 @@ private: } // namespace hsa } // namespace rocprofiler -bool -operator==(rocprofiler_dim3_t lhs, rocprofiler_dim3_t rhs) -{ - return std::tie(lhs.x, lhs.y, lhs.z) == std::tie(rhs.x, rhs.y, rhs.z); -} - -bool -operator==(rocprofiler_agent_id_t lhs, rocprofiler_agent_id_t rhs) -{ - return (lhs.handle == rhs.handle); -} - namespace { struct expected_dispatch diff --git a/tests/common/hash.hpp b/tests/common/hash.hpp index 8ff186dd4f..011b7a18d7 100644 --- a/tests/common/hash.hpp +++ b/tests/common/hash.hpp @@ -24,21 +24,5 @@ #include #include - -namespace std -{ -template -struct hash; - -template <> -struct hash -{ - size_t operator()(rocprofiler_agent_id_t id) const { return id.handle; } -}; -} // namespace std - -inline bool -operator==(rocprofiler_agent_id_t lhs, rocprofiler_agent_id_t rhs) -{ - return (lhs.handle == rhs.handle); -} +#include +#include