rocDecode API Tracing Support (#49)

* rocDecode API Tracing support

* Test bin file added to rocdecode. Need to add validate python methods

* Added option to not make rocDecode tests

* Added rocdecode and rocprofv3 tests

* Added csv test

* Address PR comments. Changed tests to use built-in rocstreambit decoder to remove ffmpeg dependancy. Changed cmake option to disbale tests rather than not build them. Tests work locally, but will fail until rocDecode is built with tracing enabled on CI

* Add option to avoid building rocdecode tests

* Added option to avoid building rocdecode bin file

* Merge conflict error

* CMake files changed in response to review comments. Attempting to implement callbacks.

* Turned off test building for rocdecode

* Minor fixes for review comments

* Review comments

* Updated formatting

* Document changes and format.hpp reversion. Need to remove iterate args support for now for later update.

* Remove iterate args support

* Remove iterate-args

* enforce abi versioning in macro if

* Fix doc error

* removed spaces to fix indentation error

---------

Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>

tests/rocprofv3/rocdecode-trace/CMakeLists.txt

@@ -0,0 +1,52 @@
+#
+#
+#
+cmake_minimum_required(VERSION 3.21.0 FATAL_ERROR)
+
+project(
+    rocprofiler-tests-rocprofv3-rocdecode-tracing
+    LANGUAGES CXX
+    VERSION 0.0.0)
+
+find_package(rocprofiler-sdk REQUIRED)
+
+rocprofiler_configure_pytest_files(CONFIG pytest.ini COPY validate.py conftest.py)
+
+string(REPLACE "LD_PRELOAD=" "ROCPROF_PRELOAD=" PRELOAD_ENV
+               "${ROCPROFILER_MEMCHECK_PRELOAD_ENV}")
+
+set(rocdecode-tracing-env "${PRELOAD_ENV}")
+
+set(ROCDECODE_VIDEO_FILE
+    "${ROCM_PATH}/share/rocdecode/video/AMD_driving_virtual_20-H265.265")
+if(NOT EXISTS "${ROCDECODE_VIDEO_FILE}")
+    message(
+        FATAL_ERROR
+            "Unable to find video file for rocdecode tests: ${ROCDECODE_VIDEO_FILE}")
+endif()
+add_test(
+    NAME rocprofv3-test-rocdecode-tracing-execute
+    COMMAND
+        $<TARGET_FILE:rocprofiler-sdk::rocprofv3> --rocdecode-trace -d
+        ${CMAKE_CURRENT_BINARY_DIR}/%tag%-trace -o out --output-format json otf2 pftrace
+        csv --log-level env -- $<TARGET_FILE:rocdecode> -i ${ROCDECODE_VIDEO_FILE})
+
+set_tests_properties(
+    rocprofv3-test-rocdecode-tracing-execute
+    PROPERTIES TIMEOUT 45 LABELS "integration-tests" ENVIRONMENT
+               "${rocdecode-tracing-env}" FAIL_REGULAR_EXPRESSION "threw an exception")
+
+add_test(
+    NAME rocprofv3-test-rocdecode-tracing-validate
+    COMMAND
+        ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --json-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocdecode-trace/out_results.json --otf2-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocdecode-trace/out_results.otf2 --pftrace-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocdecode-trace/out_results.pftrace --csv-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocdecode-trace/out_rocdecode_api_trace.csv)
+
+set_tests_properties(
+    rocprofv3-test-rocdecode-tracing-validate
+    PROPERTIES TIMEOUT 45 LABELS "integration-tests" DEPENDS
+               rocprofv3-test-rocdecode-tracing-execute FAIL_REGULAR_EXPRESSION
+               "AssertionError")

tests/rocprofv3/rocdecode-trace/conftest.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+
+import csv
+import json
+import os
+import pytest
+
+from rocprofiler_sdk.pytest_utils.dotdict import dotdict
+from rocprofiler_sdk.pytest_utils import collapse_dict_list
+from rocprofiler_sdk.pytest_utils.perfetto_reader import PerfettoReader
+from rocprofiler_sdk.pytest_utils.otf2_reader import OTF2Reader
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--json-input",
+        action="store",
+        default="rocdecode-tracing/out_results.json",
+        help="Input JSON",
+    )
+    parser.addoption(
+        "--otf2-input",
+        action="store",
+        default="rocdecode-tracing/out_results.otf2",
+        help="Input OTF2",
+    )
+    parser.addoption(
+        "--pftrace-input",
+        action="store",
+        default="rocdecode-tracing/out_results.pftrace",
+        help="Input pftrace file",
+    )
+    parser.addoption(
+        "--csv-input",
+        action="store",
+        default="rocdecode-tracing/out_rocdecode_api_trace.csv",
+        help="Input CSV",
+    )
+
+
+@pytest.fixture
+def json_data(request):
+    filename = request.config.getoption("--json-input")
+    with open(filename, "r") as inp:
+        return dotdict(collapse_dict_list(json.load(inp)))
+
+
+@pytest.fixture
+def csv_data(request):
+    filename = request.config.getoption("--csv-input")
+    data = []
+    with open(filename, "r") as inp:
+        reader = csv.DictReader(inp)
+        for row in reader:
+            data.append(row)
+
+    return data
+
+
+@pytest.fixture
+def otf2_data(request):
+    filename = request.config.getoption("--otf2-input")
+    if not os.path.exists(filename):
+        raise FileExistsError(f"{filename} does not exist")
+    return OTF2Reader(filename).read()[0]
+
+
+@pytest.fixture
+def pftrace_data(request):
+    filename = request.config.getoption("--pftrace-input")
+    return PerfettoReader(filename).read()[0]

tests/rocprofv3/rocdecode-trace/pytest.ini

@@ -0,0 +1,5 @@
+
+[pytest]
+addopts = --durations=20 -rA -s -vv
+testpaths = validate.py
+pythonpath = @ROCPROFILER_SDK_TESTS_BINARY_DIR@/pytest-packages

tests/rocprofv3/rocdecode-trace/validate.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+
+import sys
+import pytest
+import json
+
+from collections import defaultdict
+
+
+# helper function
+def node_exists(name, data, min_len=1):
+    assert name in data
+    assert data[name] is not None
+    if isinstance(data[name], (list, tuple, dict, set)):
+        assert len(data[name]) >= min_len
+
+
+def get_operation(record, kind_name, op_name=None):
+    for idx, itr in enumerate(record["strings"]["buffer_records"]):
+        if kind_name == itr["kind"]:
+            if op_name is None:
+                return idx, itr["operations"]
+            else:
+                for oidx, oname in enumerate(itr["operations"]):
+                    if op_name == oname:
+                        return oidx
+    return None
+
+
+def test_rocdeocde(json_data):
+    data = json_data["rocprofiler-sdk-tool"]
+    buffer_records = data["buffer_records"]
+
+    rocdecode_data = buffer_records["rocdecode_api"]
+
+    _, bf_op_names = get_operation(data, "ROCDECODE_API")
+
+    assert len(bf_op_names) == 16
+
+    rocdecode_reported_agent_ids = set()
+    # check buffering data
+    for node in rocdecode_data:
+        assert "size" in node
+        assert "kind" in node
+        assert "operation" in node
+        assert "correlation_id" in node
+        assert "end_timestamp" in node
+        assert "start_timestamp" in node
+        assert "thread_id" in node
+
+        assert node.size > 0
+        assert node.thread_id > 0
+        assert node.start_timestamp > 0
+        assert node.end_timestamp > 0
+        assert node.start_timestamp < node.end_timestamp
+
+        assert data.strings.buffer_records[node.kind].kind == "ROCDECODE_API"
+        assert (
+            data.strings.buffer_records[node.kind].operations[node.operation]
+            in bf_op_names
+        )
+
+
+def test_csv_data(csv_data):
+    assert len(csv_data) > 0, "Expected non-empty csv data"
+
+    api_calls = []
+
+    for row in csv_data:
+        assert "Domain" in row, "'Domain' was not present in csv data for rocdecode-trace"
+        assert (
+            "Function" in row
+        ), "'Function' was not present in csv data for rocdecode-trace"
+        assert (
+            "Process_Id" in row
+        ), "'Process_Id' was not present in csv data for rocdecode-trace"
+        assert (
+            "Thread_Id" in row
+        ), "'Thread_Id' was not present in csv data for rocdecode-trace"
+        assert (
+            "Correlation_Id" in row
+        ), "'Correlation_Id' was not present in csv data for rocdecode-trace"
+        assert (
+            "Start_Timestamp" in row
+        ), "'Start_Timestamp' was not present in csv data for rocdecode-trace"
+        assert (
+            "End_Timestamp" in row
+        ), "'End_Timestamp' was not present in csv data for rocdecode-trace"
+
+        api_calls.append(row["Function"])
+
+        assert row["Domain"] == "ROCDECODE_API"
+        assert int(row["Process_Id"]) > 0
+        assert int(row["Thread_Id"]) > 0
+        assert int(row["Start_Timestamp"]) > 0
+        assert int(row["End_Timestamp"]) > 0
+        assert int(row["Start_Timestamp"]) < int(row["End_Timestamp"])
+
+    for call in [
+        "rocDecCreateBitstreamReader",
+        "rocDecGetBitstreamCodecType",
+        "rocDecGetBitstreamBitDepth",
+        "rocDecCreateVideoParser",
+        "rocDecGetBitstreamPicData",
+        "rocDecGetDecoderCaps",
+        "rocDecCreateDecoder",
+        "rocDecDecodeFrame",
+        "rocDecParseVideoData",
+        "rocDecGetVideoFrame",
+        "rocDecGetDecodeStatus",
+        "rocDecDestroyBitstreamReader",
+    ]:
+        assert call in api_calls
+
+
+def test_perfetto_data(pftrace_data, json_data):
+    import rocprofiler_sdk.tests.rocprofv3 as rocprofv3
+
+    rocprofv3.test_perfetto_data(
+        pftrace_data,
+        json_data,
+        ("hip", "hsa", "memory_allocation", "rocdecode_api"),
+    )
+
+
+def test_otf2_data(otf2_data, json_data):
+    import rocprofiler_sdk.tests.rocprofv3 as rocprofv3
+
+    rocprofv3.test_otf2_data(
+        otf2_data,
+        json_data,
+        ("hip", "hsa", "memory_allocation", "rocdecode_api"),
+    )
+
+
+if __name__ == "__main__":
+    exit_code = pytest.main(["-x", __file__] + sys.argv[1:])
+    sys.exit(exit_code)