rocJPEG API Tracing (#73)

* 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 * Support for rocJPEG API Trace * Added newline to rocjpeg_version.h * json-tool code added, initial test/bin commit * Formatting * Resolved rocjpeg bin test compilation errors * Tests implemented. Perfetto module currently resulting in errors, so need to retest whenever it is fixed * Formatting and compilation errors * Minor fixes * Copyright year update and minor fixes * Doc update fix * Added rocjpeg csv file in data * Addresses review comments: Updated fixed Findroc.. and uses root directory as a hint, fixed documentation error, changed tables to use _CORE, minor style fixes * Added rocdecode and rocjpeg to CI * Removed rocdecode and rocjpeg from CI and added back build tests option * Updated Cmake Files * Added rocDecode and rocJPEG to CI * Remove cmake line added in error * Temporarily modified tests to pass if rocdecode or rocjpeg tracing are not supported for CI, cmake changes * Added find_package for test * Added back use of system rocDecode and rocJPEG, modifies system files to include prefix path * Updated no-link to include INCLUDE_DIR/roc(decode|jpeg), added comments for tests * Resolve merge conflicts and formatting * Added regex find and replace instead of include for CI * VAAPI package causing errors on Vega20 * Removed system rocjpeg and rocdecode use temporarily until cmake issues resolved * Removed workflows regex * Formatting and minor test modification * Modified test for vega20 * Update rocDecode and rocJPEG cmake and tests * Changelog * Fix merge conflict * Added back if-statements around add-tests since cmake-generator-expressions are resulting in errors when the packages are missing * Removed if found statements, replaced with TARGET:EXISTS * Skip json file for rocjpeg and rocdecode tests if not supported * Add os import --------- Co-authored-by: Kandula, Venkateshwar reddy <Venkateshwarreddy.Kandula@amd.com> Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com> [ROCm/rocprofiler-sdk commit: 31fe8858d1]
2025-02-21 15:43:49 -06:00
parent afa1951db3
commit 74efdad1aa
92 changed files with 4614 additions and 242 deletions
@@ -36,9 +36,8 @@ add_subdirectory(roctracer-roctx)
 add_subdirectory(scratch-memory)
 add_subdirectory(pc-sampling)
 add_subdirectory(collection-period)
-if(ROCPROFILER_BUILD_ROCDECODE_TESTS)
-    add_subdirectory(rocdecode-trace)
-endif()
+add_subdirectory(rocdecode-trace)
+add_subdirectory(rocjpeg-trace)
 if(TARGET att_decoder_testing)
    add_subdirectory(advanced-thread-trace)
 endif()
@@ -9,6 +9,7 @@ project(
    VERSION 0.0.0)

 find_package(rocprofiler-sdk REQUIRED)
+find_package(rocDecode)

 rocprofiler_configure_pytest_files(CONFIG pytest.ini COPY validate.py conftest.py)

@@ -18,23 +19,34 @@ string(REPLACE "LD_PRELOAD=" "ROCPROF_PRELOAD=" 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}")
+    "${rocDecode_ROOT_DIR}/share/rocdecode/video/AMD_driving_virtual_20-H265.265")
+if(TARGET rocdecode-demo AND 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})
+        ${CMAKE_CURRENT_BINARY_DIR}/%tag%-trace -o out --output-format json csv
+        --log-level env --
+        $<IF:$<TARGET_EXISTS:rocdecode-demo>,$<$<TARGET_EXISTS:rocdecode-demo>:$<TARGET_FILE:rocdecode-demo>>,rocdecode-demo>
+        -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")
+    PROPERTIES TIMEOUT
+               45
+               LABELS
+               "integration-tests"
+               ENVIRONMENT
+               "${rocdecode-tracing-env}"
+               FAIL_REGULAR_EXPRESSION
+               "threw an exception"
+               DISABLED
+               $<NOT:$<TARGET_EXISTS:rocdecode-demo>>)

 add_test(
    NAME rocprofv3-test-rocdecode-tracing-validate
@@ -47,6 +59,13 @@ add_test(

 set_tests_properties(
    rocprofv3-test-rocdecode-tracing-validate
-    PROPERTIES TIMEOUT 45 LABELS "integration-tests" DEPENDS
-               rocprofv3-test-rocdecode-tracing-execute FAIL_REGULAR_EXPRESSION
-               "AssertionError")
+    PROPERTIES TIMEOUT
+               45
+               LABELS
+               "integration-tests"
+               DEPENDS
+               rocprofv3-test-rocdecode-tracing-execute
+               FAIL_REGULAR_EXPRESSION
+               "AssertionError"
+               DISABLED
+               $<NOT:$<TARGET_EXISTS:rocdecode-demo>>)
@@ -41,6 +41,8 @@ def pytest_addoption(parser):
@pytest.fixture
 def json_data(request):
    filename = request.config.getoption("--json-input")
+    if not os.path.isfile(filename):
+        return pytest.skip("rocdecode tracing unavailable")
    with open(filename, "r") as inp:
        return dotdict(collapse_dict_list(json.load(inp)))

@@ -49,23 +51,30 @@ def json_data(request):
 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)
-
+    if not os.path.isfile(filename):
+        # The CSV file is not generated, because the dependency test
+        # responsible to generate this file was skipped or failed.
+        # Thus emit the message to skip this test as well.
+        return pytest.skip("rocdecode tracing unavailable")
+    else:
+        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")
+    if not os.path.isfile(filename):
+        return pytest.skip("rocdecode tracing unavailable")
    return OTF2Reader(filename).read()[0]


@pytest.fixture
 def pftrace_data(request):
    filename = request.config.getoption("--pftrace-input")
+    if not os.path.isfile(filename):
+        return pytest.skip("rocdecode tracing unavailable")
    return PerfettoReader(filename).read()[0]
@@ -32,6 +32,9 @@ def test_rocdeocde(json_data):
    buffer_records = data["buffer_records"]

    rocdecode_data = buffer_records["rocdecode_api"]
+    # If rocDecode tracing is not supported, end early
+    if len(rocdecode_data) == 0:
+        return pytest.skip("rocdecode tracing unavailable")

    _, bf_op_names = get_operation(data, "ROCDECODE_API")

@@ -62,6 +65,9 @@ def test_rocdeocde(json_data):


 def test_csv_data(csv_data):
+    # If rocDecode tracing is not supported, end early
+    if len(csv_data) == 0:
+        return pytest.skip("rocdecode tracing unavailable")
    assert len(csv_data) > 0, "Expected non-empty csv data"

    api_calls = []
@@ -116,20 +122,34 @@ def test_csv_data(csv_data):
 def test_perfetto_data(pftrace_data, json_data):
    import rocprofiler_sdk.tests.rocprofv3 as rocprofv3

+    # If rocDecode tracing is not supported, end early
+    if (
+        pftrace_data == None
+        or len(json_data["rocprofiler-sdk-tool"]["buffer_records"]["rocdecode_api"]) == 0
+    ):
+        return pytest.skip("rocdecode tracing unavailable")
+
    rocprofv3.test_perfetto_data(
        pftrace_data,
        json_data,
-        ("hip", "hsa", "memory_allocation", "rocdecode_api"),
+        ("rocdecode_api",),
    )


 def test_otf2_data(otf2_data, json_data):
    import rocprofiler_sdk.tests.rocprofv3 as rocprofv3

+    # If rocDecode tracing is not supported, end early
+    if (
+        otf2_data == None
+        or len(json_data["rocprofiler-sdk-tool"]["buffer_records"]["rocdecode_api"]) == 0
+    ):
+        return pytest.skip("rocdecode tracing unavailable")
+
    rocprofv3.test_otf2_data(
        otf2_data,
        json_data,
-        ("hip", "hsa", "memory_allocation", "rocdecode_api"),
+        ("rocdecode_api",),
    )


@@ -0,0 +1,72 @@
+#
+#
+#
+cmake_minimum_required(VERSION 3.21.0 FATAL_ERROR)
+
+project(
+    rocprofiler-tests-rocprofv3-rocjpeg-tracing
+    LANGUAGES CXX
+    VERSION 0.0.0)
+
+find_package(rocprofiler-sdk REQUIRED)
+find_package(rocJPEG)
+
+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(rocjpeg-tracing-env "${PRELOAD_ENV}")
+
+set(ROCJPEG_IMAGE_DIR "${ROCM_PATH}/share/rocjpeg/images")
+if(TARGET rocjpeg-demo AND NOT EXISTS "${ROCJPEG_IMAGE_DIR}")
+    message(
+        FATAL_ERROR
+            "Unable to find image directory for rocjpeg tests: ${ROCJPEG_IMAGE_DIR}")
+endif()
+
+# CI Sanitizer run gives the following error: No target "rocjpeg-demo" Adding if-statement
+# to avoid tests for now to stop error
+add_test(
+    NAME rocprofv3-test-rocjpeg-tracing-execute
+    COMMAND
+        $<TARGET_FILE:rocprofiler-sdk::rocprofv3> --rocjpeg-trace -d
+        ${CMAKE_CURRENT_BINARY_DIR}/%tag%-trace -o out --output-format json csv
+        --log-level env --
+        $<IF:$<TARGET_EXISTS:rocjpeg-demo>,$<$<TARGET_EXISTS:rocjpeg-demo>:$<TARGET_FILE:rocjpeg-demo>>,rocjpeg-demo>
+        -i ${ROCJPEG_IMAGE_DIR})
+
+set_tests_properties(
+    rocprofv3-test-rocjpeg-tracing-execute
+    PROPERTIES TIMEOUT
+               45
+               LABELS
+               "integration-tests"
+               ENVIRONMENT
+               "${rocjpeg-tracing-env}"
+               FAIL_REGULAR_EXPRESSION
+               "threw an exception"
+               DISABLED
+               $<NOT:$<TARGET_EXISTS:rocjpeg-demo>>)
+
+add_test(
+    NAME rocprofv3-test-rocjpeg-tracing-validate
+    COMMAND
+        ${Python3_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/validate.py --json-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocjpeg-trace/out_results.json --otf2-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocjpeg-trace/out_results.otf2 --pftrace-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocjpeg-trace/out_results.pftrace --csv-input
+        ${CMAKE_CURRENT_BINARY_DIR}/rocjpeg-trace/out_rocjpeg_api_trace.csv)
+
+set_tests_properties(
+    rocprofv3-test-rocjpeg-tracing-validate
+    PROPERTIES TIMEOUT
+               45
+               LABELS
+               "integration-tests"
+               DEPENDS
+               rocprofv3-test-rocjpeg-tracing-execute
+               FAIL_REGULAR_EXPRESSION
+               "AssertionError"
+               DISABLED
+               $<NOT:$<TARGET_EXISTS:rocjpeg-demo>>)
@@ -0,0 +1,80 @@
+#!/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="rocjpeg-tracing/out_results.json",
+        help="Input JSON",
+    )
+    parser.addoption(
+        "--otf2-input",
+        action="store",
+        default="rocjpeg-tracing/out_results.otf2",
+        help="Input OTF2",
+    )
+    parser.addoption(
+        "--pftrace-input",
+        action="store",
+        default="rocjpeg-tracing/out_results.pftrace",
+        help="Input pftrace file",
+    )
+    parser.addoption(
+        "--csv-input",
+        action="store",
+        default="rocjpeg-tracing/out_rocjpeg_api_trace.csv",
+        help="Input CSV",
+    )
+
+
+@pytest.fixture
+def json_data(request):
+    filename = request.config.getoption("--json-input")
+    if not os.path.isfile(filename):
+        return pytest.skip("rocjpeg tracing unavailable")
+    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 = []
+    if not os.path.isfile(filename):
+        # The CSV file is not generated, because the dependency test
+        # responsible to generate this file was skipped or failed.
+        # Thus emit the message to skip this test as well.
+        return pytest.skip("rocjpeg tracing unavailable")
+    else:
+        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.isfile(filename):
+        return pytest.skip("rocjpeg tracing unavailable")
+    return OTF2Reader(filename).read()[0]
+
+
+@pytest.fixture
+def pftrace_data(request):
+    filename = request.config.getoption("--pftrace-input")
+    if not os.path.isfile(filename):
+        return pytest.skip("rocjpeg tracing unavailable")
+    return PerfettoReader(filename).read()[0]
@@ -0,0 +1,5 @@
+
+[pytest]
+addopts = --durations=20 -rA -s -vv
+testpaths = validate.py
+pythonpath = @ROCPROFILER_SDK_TESTS_BINARY_DIR@/pytest-packages
@@ -0,0 +1,153 @@
+#!/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_rocjpeg(json_data):
+    data = json_data["rocprofiler-sdk-tool"]
+    buffer_records = data["buffer_records"]
+
+    rocjpeg_data = buffer_records["rocjpeg_api"]
+    # If rocJPEG tracing is not supported, end early
+    if len(rocjpeg_data) == 0:
+        return pytest.skip("rocjpeg tracing unavailable")
+
+    _, bf_op_names = get_operation(data, "ROCJPEG_API")
+
+    assert len(bf_op_names) == 9
+
+    rocjpeg_reported_agent_ids = set()
+    # check buffering data
+    for node in rocjpeg_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 == "ROCJPEG_API"
+        assert (
+            data.strings.buffer_records[node.kind].operations[node.operation]
+            in bf_op_names
+        )
+
+
+def test_csv_data(csv_data):
+    # If rocJPEG tracing is not supported, end early
+    if len(csv_data) <= 2:
+        return pytest.skip("rocjpeg tracing unavailable")
+    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 rocjpeg-trace"
+        assert (
+            "Function" in row
+        ), "'Function' was not present in csv data for rocjpeg-trace"
+        assert (
+            "Process_Id" in row
+        ), "'Process_Id' was not present in csv data for rocjpeg-trace"
+        assert (
+            "Thread_Id" in row
+        ), "'Thread_Id' was not present in csv data for rocjpeg-trace"
+        assert (
+            "Correlation_Id" in row
+        ), "'Correlation_Id' was not present in csv data for rocjpeg-trace"
+        assert (
+            "Start_Timestamp" in row
+        ), "'Start_Timestamp' was not present in csv data for rocjpeg-trace"
+        assert (
+            "End_Timestamp" in row
+        ), "'End_Timestamp' was not present in csv data for rocjpeg-trace"
+
+        api_calls.append(row["Function"])
+
+        assert row["Domain"] == "ROCJPEG_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 [
+        "rocJpegCreate",
+        "rocJpegStreamCreate",
+        "rocJpegStreamParse",
+        "rocJpegGetImageInfo",
+        "rocJpegDecode",
+        "rocJpegDestroy",
+        "rocJpegStreamDestroy",
+    ]:
+        assert call in api_calls
+
+
+def test_perfetto_data(pftrace_data, json_data):
+    import rocprofiler_sdk.tests.rocprofv3 as rocprofv3
+
+    # If rocJPEG tracing is not supported, end early
+    if (
+        pftrace_data == None
+        or len(json_data["rocprofiler-sdk-tool"]["buffer_records"]["rocjpeg_api"]) == 0
+    ):
+        return pytest.skip("rocjpeg tracing unavailable")
+
+    rocprofv3.test_perfetto_data(
+        pftrace_data,
+        json_data,
+        ("rocjpeg_api",),
+    )
+
+
+def test_otf2_data(otf2_data, json_data):
+    import rocprofiler_sdk.tests.rocprofv3 as rocprofv3
+
+    # If rocJPEG tracing is not supported, end early
+    if (
+        otf2_data == None
+        or len(json_data["rocprofiler-sdk-tool"]["buffer_records"]["rocjpeg_api"]) == 0
+    ):
+        return pytest.skip("rocjpeg tracing unavailable")
+
+    rocprofv3.test_otf2_data(
+        otf2_data,
+        json_data,
+        ("rocjpeg_api",),
+    )
+
+
+if __name__ == "__main__":
+    exit_code = pytest.main(["-x", __file__] + sys.argv[1:])
+    sys.exit(exit_code)