rocm-systems/projects/rocprofiler-compute/src/rocprof_compute_profile/profiler_rocprofiler_sdk.py

##############################################################################
# MIT License
#
# Copyright (c) 2021 - 2025 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.

##############################################################################

import argparse
import shlex
from pathlib import Path
from typing import Optional, Union

from rocprof_compute_profile.profiler_base import RocProfCompute_Base
from rocprof_compute_soc.soc_base import OmniSoC_Base
from utils.logger import console_error, console_log, demarcate


class rocprofiler_sdk_profiler(RocProfCompute_Base):
    def __init__(
        self,
        profiling_args: argparse.Namespace,
        profiler_mode: str,
        soc: OmniSoC_Base,
    ) -> None:
        super().__init__(profiling_args, profiler_mode, soc)
        self.ready_to_profile = (
            self.get_args().roof_only
            and not (Path(self.get_args().path) / "pmc_perf.csv").is_file()
            or not self.get_args().roof_only
        )

    def get_profiler_options(
        self, native_tool_path: Optional[str] = None
    ) -> dict[str, Union[str, list[str]]]:
        args = self.get_args()
        app_cmd = shlex.split(args.remaining)

        ld_preload = [args.rocprofiler_sdk_tool_path]
        if native_tool_path:
            # Use native tool to collect counters
            ld_preload.append(native_tool_path)
            options = {"ROCPROF_COUNTER_COLLECTION": "0"}
            console_log(
                f"Using native counter collection tool: {str(native_tool_path)}"
            )
        else:
            options = {"ROCPROF_COUNTER_COLLECTION": "1"}

        options.update({
            "LD_PRELOAD": ":".join(ld_preload),
            "ROCPROF_KERNEL_TRACE": "1",
            "ROCPROF_OUTPUT_FORMAT": args.format_rocprof_output,
            "ROCPROF_OUTPUT_PATH": f"{args.path}/out/pmc_1",
        })

        # Create folder pointed by ROCPROF_OUTPUT_PATH
        Path(options["ROCPROF_OUTPUT_PATH"]).mkdir(parents=True, exist_ok=True)

        if args.iteration_multiplexing:
            options.update({
                "ROCPROF_ITERATION_MULTIPLEXING": args.iteration_multiplexing,
            })

        if args.attach_pid:
            # In attach mode, tools are provided using ROCPROF_ATTACH_TOOL_LIBRARY
            # instead of LD_PRELOAD.
            options.update({
                "ROCPROF_ATTACH_TOOL_LIBRARY": ":".join(ld_preload),
            })
            options.pop("LD_PRELOAD", None)

            rocprofiler_attach_library_path = str(
                Path(args.rocprofiler_sdk_tool_path).parent.parent
                / "librocprofiler-sdk-rocattach.so"
            )
            options.update({
                "ROCPROF_ATTACH_LIBRARY": rocprofiler_attach_library_path,
                "ROCPROF_ATTACH_PID": args.attach_pid,
            })

            if args.attach_duration_msec:
                options.update({
                    "ROCPROF_ATTACH_DURATION": args.attach_duration_msec,
                })

        if args.kokkos_trace:
            # NOTE: --kokkos-trace feature is incomplete and is disabled for now.
            console_error(
                "The option '--kokkos-trace' is not supported in the current "
                "version of rocprof-compute. This functionality is planned for a "
                "future release. Please adjust your profiling options accordingly."
            )
        if args.hip_trace:
            options["ROCPROF_HIP_COMPILER_API_TRACE"] = "1"
            options["ROCPROF_HIP_RUNTIME_API_TRACE"] = "1"

        # Kernel filtering
        if args.kernel:
            options["ROCPROF_KERNEL_FILTER_INCLUDE_REGEX"] = "|".join(args.kernel)

        # Dispatch filtering
        dispatch = []
        # rocprof sdk dispatch indexing is inclusive and starts from 1
        if args.dispatch:
            for dispatch_id in args.dispatch:
                if ":" in dispatch_id:
                    # 4:7 -> 4-7
                    start, end = dispatch_id.split(":")
                    dispatch.append(f"{start}-{end}")
                else:
                    # 4 -> 4
                    dispatch.append(f"{dispatch_id}")
        if dispatch:
            options["ROCPROF_KERNEL_FILTER_RANGE"] = f"[{','.join(dispatch)}]"
        if not args.attach_pid:
            options["APP_CMD"] = app_cmd
        return options

    # -----------------------
    # Required child methods
    # -----------------------
    @demarcate
    def pre_processing(self) -> None:
        """Perform any pre-processing steps prior to profiling."""
        super().pre_processing()

    @demarcate
    def run_profiling(self, version: str, prog: str) -> None:
        """Run profiling."""
        if not self.ready_to_profile:
            console_log("roofline", "Detected existing pmc_perf.csv")
            return

        if self.get_args().roof_only:
            console_log("roofline", "Generating pmc_perf.csv (roofline counters only).")

        # Log profiling options and setup filtering
        super().run_profiling(version, prog)

    @demarcate
    def post_processing(self) -> None:
        """Perform any post-processing steps prior to profiling."""
        if self.ready_to_profile:
            # Manually join each pmc_perf*.csv output
            self.join_prof()
            # Run roofline microbenchmark
            super().post_processing()
        else:
            console_log("roofline", "Detected existing pmc_perf.csv")