TheRock/rocm-systems/projects/rocprofiler-systems/examples/roctx/selective-region-pause-2.cpp

// Copyright (c) Advanced Micro Devices, Inc.
// SPDX-License-Identifier: MIT

// Demonstrates interleaving of Pause/Resume with Selective Region Tracing.
// Scenario: Pause occurs OUTSIDE the target region (before it starts).
//
// Supports two region marker styles (selected via --push-pop argument):
//   default (start/stop): roctxRangeStartA / roctxRangeStop
//   --push-pop:           roctxRangePushA  / roctxRangePop
//
// The pause happens outside any target region, so it is not valid in the
// context of region filtering. When the target region starts, profiling
// begins normally. The resume inside the region is a no-op since there
// was no valid pause to undo.
//
// Code flow:
//   roctxProfilerPause
//   CodeBlock_Z                                 (outside region — not profiled)
//   <range start>("Region1")
//     CodeBlock_A                               (profiled)
//     CodeBlock_B                               (profiled)
//     roctxProfilerResume (no-op)
//     CodeBlock_C                               (profiled)
//   <range stop>
//   CodeBlock_D                                 (outside region — not profiled)
//
// Run with filter:
//   ROCPROFSYS_SELECTED_REGIONS="Region1" rocprof-sys -- ./selective-region-pause-2
//   ROCPROFSYS_SELECTED_REGIONS="Region1" rocprof-sys -- ./selective-region-pause-2
//   --push-pop
//
// Expected: profiling data recorded for {CodeBlock_A, CodeBlock_B, CodeBlock_C}

#include "roctx-example-kernels.hpp"

DEFINE_KERNEL(CodeBlock_Z, 10)
DEFINE_KERNEL(CodeBlock_A, 20)
DEFINE_KERNEL(CodeBlock_B, 30)
DEFINE_KERNEL(CodeBlock_C, 40)
DEFINE_KERNEL(CodeBlock_D, 50)

int
main(int argc, char** argv)
{
    const bool use_push_pop = (argc > 1 && std::string_view(argv[1]) == "--push-pop");

    gpu_buffer buf;
    float*     d = buf.get();

    roctx_thread_id_t roctx_tid{};
    roctxGetThreadId(&roctx_tid);

    roctxProfilerPause(roctx_tid);

    LAUNCH_KERNEL(CodeBlock_Z, d);

    roctx_range_id_t region1_id = range_start("Region1", use_push_pop);

    LAUNCH_KERNEL(CodeBlock_A, d);

    LAUNCH_KERNEL(CodeBlock_B, d);

    roctxProfilerResume(roctx_tid);

    LAUNCH_KERNEL(CodeBlock_C, d);

    range_stop(region1_id, use_push_pop);

    LAUNCH_KERNEL(CodeBlock_D, d);

    return 0;
}