TheRock/rocm-systems/projects/rocprofiler-systems/tests/pytest/test_roctx.py

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

"""
Tests for the ROCTx marker API integration with rocprofiler-systems.
"""

from __future__ import annotations
import pytest
from pathlib import Path
from conftest import RocprofsysTest

pytestmark = [
    pytest.mark.gpu,
    pytest.mark.roctx,
    pytest.mark.rocm,
]

# =============================================================================
# ROCTx fixtures
# =============================================================================


@pytest.fixture
def roctx_env() -> dict[str, str]:
    """Environment variables for rocTX tests."""
    return {
        "ROCPROFSYS_ROCM_DOMAINS": "hip_runtime_api,marker_api,kernel_dispatch",
        "ROCPROFSYS_AMD_SMI_METRICS": "busy,temp,power,mem_usage,gfx_clock,mem_clock",
        "ROCPROFSYS_PROCESS_SAMPLING_FREQ": "1000",
    }


@pytest.fixture
def roctx_rules(validation_rules_dir: Path) -> list[Path]:
    """Get validation rules for rocTX tests."""
    rules_dir = validation_rules_dir / "roctx"
    return [
        rules_dir / "validation-rules.json",
        rules_dir / "amd-smi-rules.json",
        rules_dir / "sdk-metrics-rules.json",
    ]


# ============================================================================
# Test Class: ROCTx Tests
# ============================================================================


class TestROCTx(RocprofsysTest):
    """Tests for rocTX marker API."""

    def roctx_expected_labels(self) -> list[str]:
        # The validate-perfetto-proto.py script aggregates (name, depth) pairs from
        # the Perfetto slice table in dict-insertion order. Ex:
        #   roctxRangeStart_GPU_Compute  d=2 (main, first call) then d=0 (worker)
        #   roctxRangePush_HIP_Kernel    d=3 (main)             then d=1 (worker)
        return [
            "roctxMark_GPU_workload",
            "roctxRangePush_run_profiling",
            "roctxRangeStart_GPU_Compute",  # d=2: main thread (inside run_profiling)
            "roctxRangeStart_GPU_Compute",  # d=0: worker thread (top-level)
            "roctxRangePush_HIP_Kernel",  # d=3: main thread
            "roctxRangePush_HIP_Kernel",  # d=1: worker thread
            "roctxMark_Thread_Start",
            "roctxMark_Thread_End",
            "roctxGetThreadId",
            "roctxMark_Finished_GPU",
        ]

    def roctx_expected_count(self) -> list[int]:
        return [1, 1, 1, 1, 1, 1, 1, 1, 1, 1]

    def roctx_expected_depth(self) -> list[int]:
        return [1, 1, 2, 0, 3, 1, 0, 0, 2, 1]

    BINARY_REWRITE_ARGS = ["-e", "-v", "2", "--instrument-loops"]
    RUNTIME_INSTRUMENT_ARGS = ["-v", "2"]

    @pytest.mark.parametrize(
        "mode",
        [
            pytest.param("baseline", marks=pytest.mark.timeout(120)),
            pytest.param("binary_rewrite", marks=pytest.mark.timeout(120)),
            pytest.param("sys_run", marks=pytest.mark.timeout(120)),
            pytest.param("runtime_instrument", marks=pytest.mark.timeout(300)),
        ],
    )
    def test(self, mode, roctx_env):
        result = self.run_test(
            mode,
            "roctx",
            env=roctx_env,
            binary_rewrite_args=self.BINARY_REWRITE_ARGS,
            runtime_instrument_args=self.RUNTIME_INSTRUMENT_ARGS,
            check_target_arch=True,
        )
        self.assert_regex(result)

    @pytest.mark.timeout(120)
    @pytest.mark.rocpd("roctx_env")
    def test_sampling(
        self,
        roctx_env: dict[str, str],
        roctx_rules: list[Path],
    ):
        env = roctx_env.copy()
        categories = ["rocm_marker_api"]
        labels = self.roctx_expected_labels()
        counts = self.roctx_expected_count()
        depths = self.roctx_expected_depth()

        result = self.run_test(
            "sampling", target="roctx", env=env, check_target_arch=True
        )

        self.assert_regex(result)
        self.assert_perfetto(
            result,
            subtest_name="Perfetto counter validation",
            categories=categories,
            labels=labels,
            counts=counts,
            depths=depths,
        )
        self.assert_rocpd(
            result,
            rules_files=roctx_rules,
        )