// MIT License // // Copyright (c) 2023-2025 Advanced Micro Devices, Inc. // // 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/defines.hpp" #include "lib/common/logging.hpp" #include "lib/common/static_object.hpp" #include #include #include #include #include namespace rocprofiler { namespace common { void destroy_static_tl_objects(); void register_static_tl_dtor(static_dtor_func_t&&); /** * @brief This struct is used to create static singleton objects which have the properties of a * heap-allocated static object without a memory leak. * * @tparam Tp Data type of singleton * @tparam ContextT Use to differentiate singletons in different translation units (if using default * parameter) or ensure the singleton can be accessed in different translation units (not * recommended) as long as this type is not in an anonymous namespace * * This template works by creating a buffer of at least `sizeof(Tp)` bytes in the binary and does a * placement new into that buffer. The object created is NOT heap allocated, the address of the * object is an address in between the library load address and the load address + size of library. */ template struct static_tl_object { static_tl_object() = delete; ~static_tl_object() = delete; static_tl_object(const static_tl_object&) = delete; static_tl_object(static_tl_object&&) noexcept = delete; static_tl_object& operator=(const static_tl_object&) = delete; static_tl_object& operator=(static_tl_object&&) noexcept = delete; template static Tp*& construct(Args&&... args); static Tp* get() { return m_object; } static constexpr bool is_trivial_standard_layout(); private: static thread_local Tp* m_object; static thread_local std::array()> m_buffer; }; template thread_local Tp* static_tl_object::m_object = nullptr; template thread_local std::array()> static_tl_object::m_buffer = {}; template constexpr bool static_tl_object::is_trivial_standard_layout() { return (std::is_standard_layout::value && std::is_trivially_destructible::value); } template template Tp*& static_tl_object::construct(Args&&... args) { if constexpr(!is_trivial_standard_layout()) { static thread_local auto _once = std::once_flag{}; std::call_once(_once, []() { register_static_tl_dtor([]() { if(static_tl_object::m_object) { static_tl_object::m_object->~Tp(); static_tl_object::m_object = nullptr; } }); }); } ROCP_FATAL_IF(m_object) << "reconstructing static object. Use get() function to retrieve pointer"; m_object = new(m_buffer.data()) Tp{std::forward(args)...}; return m_object; } } // namespace common } // namespace rocprofiler