TheRock/rocm-systems/projects/hipfile/examples/basics/CMakeLists.txt

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

# These examples use the hipFile C API directly from C++. They build with the
# AIS infrastructure (ais_add_executable) and link the shared helpers from the
# examples_common target defined in examples/common; the parent CMakeLists adds
# examples/common before examples/basics, so the target is in scope here.
# examples_common is PUBLIC-linked against hipfile and exports its own include
# dir, so DEPS examples_common transitively supplies the library and headers.

include(AISAddExecutable)

set(BASICS_EXAMPLES
    bufregister-write
    no-bufregister-write
    no-odirect-write
    iterative-read
    iterative-devmem-offset-read
    various-mem-rw
    subregion-write
    roundtrip-verify
)

foreach(example ${BASICS_EXAMPLES})
    ais_add_executable(
        NAME ${example}
        DEPS examples_common
        SRCS "${example}.cpp"
        SYSINCLS ${HIPFILE_INCLUDE_PATH}
    )
endforeach()

# CTest wrappers: run each example as a hipFile system test.
# Gated on BUILD_TESTING; AIS_INSTALL_EXAMPLES is already enforced by the
# parent CMakeLists which only adds this subdirectory when examples are built.
if(BUILD_TESTING)
    # Unique-per-configure scratch dir so concurrent ctest runs / multiple
    # checkouts don't collide on a shared path. Kept under AIS_CAPABLE_DIR
    # because the e2e tests need an O_DIRECT-capable local FS — the build
    # tree may live on overlay/nfs and isn't a safe default.
    execute_process(
        COMMAND cat /proc/sys/kernel/random/uuid
        OUTPUT_VARIABLE _basics_scratch_token
        OUTPUT_STRIP_TRAILING_WHITESPACE
    )
    set(BASICS_TEST_DIR
        "${AIS_CAPABLE_DIR}/hipfile_basics_tests_${_basics_scratch_token}"
    )
    set(BASICS_INPUT "${BASICS_TEST_DIR}/input.bin")

    add_test(
        NAME basics_setup_dir
        COMMAND ${CMAKE_COMMAND} -E make_directory ${BASICS_TEST_DIR}
    )
    add_test(
        NAME basics_setup_input
        COMMAND dd if=/dev/urandom of=${BASICS_INPUT} bs=4096 count=64 status=none
    )
    add_test(
        NAME basics_cleanup
        COMMAND ${CMAKE_COMMAND} -E rm -rf ${BASICS_TEST_DIR}
    )
    set_tests_properties(basics_setup_dir PROPERTIES
        FIXTURES_SETUP basics_scratch
    )
    set_tests_properties(basics_setup_input PROPERTIES
        FIXTURES_SETUP basics_scratch
        DEPENDS basics_setup_dir
    )
    set_tests_properties(basics_cleanup PROPERTIES
        FIXTURES_CLEANUP basics_scratch
    )

    # The read-style basics tests (iterative-read, iterative-devmem-offset-read,
    # subregion-write, various-mem-rw) consume BASICS_INPUT read-only, so they
    # can safely share the dd-seeded fixture file under `ctest --parallel`.
    # The write-style tests (bufregister-write, no-bufregister-write,
    # no-odirect-write, roundtrip-verify) create their own output files.
    function(_basics_add_test name)
        add_test(
            NAME basics_${name}
            COMMAND $<TARGET_FILE:${name}> ${ARGN}
            WORKING_DIRECTORY ${BASICS_TEST_DIR}
        )
        set_tests_properties(basics_${name} PROPERTIES
            FIXTURES_REQUIRED basics_scratch
            LABELS "system;hipfile;basics"
        )
    endfunction()

    _basics_add_test(bufregister-write            out_bufregister.bin)
    _basics_add_test(no-bufregister-write         out_no_bufregister.bin)
    _basics_add_test(no-odirect-write             out_no_odirect.bin)
    _basics_add_test(iterative-read               ${BASICS_INPUT} out_iter.bin)
    _basics_add_test(iterative-devmem-offset-read ${BASICS_INPUT} out_iter_off.bin)
    _basics_add_test(subregion-write              ${BASICS_INPUT} out_subregion.bin)
    _basics_add_test(roundtrip-verify             rtv_created.bin rtv_copied.bin)

    # various-mem-rw exercises MODE = 1 (device), 2 (managed), 3 (pinned-host).
    foreach(mode_pair "1;device" "2;managed" "3;pinned")
        list(GET mode_pair 0 mode_num)
        list(GET mode_pair 1 mode_name)
        add_test(
            NAME basics_various-mem-rw_${mode_name}
            COMMAND
                $<TARGET_FILE:various-mem-rw> ${BASICS_INPUT}
                out_vmrw_${mode_name}.bin ${mode_num}
            WORKING_DIRECTORY ${BASICS_TEST_DIR}
        )
        set_tests_properties(basics_various-mem-rw_${mode_name} PROPERTIES
            FIXTURES_REQUIRED basics_scratch
            LABELS "system;hipfile;basics"
        )
        if(mode_name STREQUAL "managed" OR mode_name STREQUAL "pinned")
            # Disabled modes never run, but ctest still chdir's into a test's
            # WORKING_DIRECTORY to report it — and the fixture scratch dir is
            # already cleaned up by then (disabled tests don't keep the fixture
            # alive). Point them at the always-present build dir so reporting
            # them doesn't emit a spurious "Failed to change working directory".
            set_tests_properties(basics_various-mem-rw_${mode_name} PROPERTIES
                DISABLED TRUE
                WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
            )
        endif()
    endforeach()
endif()