TheRock/rocm-systems/projects/rocprofiler-sdk/source/lib/output/generateOTF2.hpp

// MIT License
//
// Copyright (c) 2023-2026 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 "agent_info.hpp"
#include "metadata.hpp"
#include "output_config.hpp"
#include "stream_info.hpp"

#include <cstdint>
#include <deque>

namespace rocprofiler
{
namespace tool
{
void
write_otf2(const output_config&                                            cfg,
           const metadata&                                                 tool_metadata,
           uint64_t                                                        pid,
           const std::vector<agent_info>&                                  agent_data,
           std::deque<tool_buffer_tracing_hip_api_ext_record_t>*           hip_api_data,
           std::deque<rocprofiler_buffer_tracing_hsa_api_record_t>*        hsa_api_data,
           std::deque<tool_buffer_tracing_kernel_dispatch_ext_record_t>*   kernel_dispatch_data,
           std::deque<tool_buffer_tracing_memory_copy_ext_record_t>*       memory_copy_data,
           std::deque<rocprofiler_buffer_tracing_marker_api_record_t>*     marker_api_data,
           std::deque<rocprofiler_buffer_tracing_scratch_memory_record_t>* scratch_memory_data,
           std::deque<rocprofiler_buffer_tracing_rccl_api_record_t>*       rccl_api_data,
           std::deque<tool_buffer_tracing_memory_allocation_ext_record_t>* memory_allocation_data,
           std::deque<rocprofiler_buffer_tracing_rocdecode_api_ext_record_t>* rocdecode_api_data,
           std::deque<rocprofiler_buffer_tracing_rocjpeg_api_record_t>*       rocjpeg_api_data);
// NOTE: OMPT and rocSHMEM are intentionally absent here. Their records are not emitted to
// OTF2 directly; they are written to rocpd and exported to OTF2 via `rocpd convert`.
}  // namespace tool
}  // namespace rocprofiler