TheRock/rocm-systems/projects/hip-tests/catch/include/hip_test_defgroups.hh

/*
 * Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
 *
 * SPDX-License-Identifier: MIT
 */

#include <hip_test_common.hh>

// Test groups are named based on the group names from hip_api_runtime.h, with adding "Test" suffix

/**
 * @defgroup CallbackTest Callback Activity APIs
 * @{
 * This section describes tests for the callback/Activity of HIP runtime API.
 * @}
 */

/**
 * @defgroup ContextTest Context Management
 * @{
 * This section describes tests for the context management functions of HIP runtime API.
 * @warning All Context Management APIs are **deprecated** and shall not be implemented.
 * @}
 */

/**
 * @defgroup AtomicsTest Device Atomics
 * @{
 * This section describes tests for the Device Atomic APIs.
 * @}
 */

/**
 * @defgroup DeviceLanguageTest Device Language
 * @{
 * This section describes tests for the Device Language API.
 * @}
 */

/**
 * @defgroup DeviceTest Device Management
 * @{
 * This section describes tests for device management functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup DriverTest Initialization and Version
 * @{
 * This section describes tests for the initialization and version functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup DynamicLoadingTest Kernel Loading Management
 * @{
 * This section describes the different kernel launch approaches.
 * @}
 */

/**
 * @defgroup ErrorTest Error Handling
 * @{
 * This section describes tests for the error handling functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup EventTest Event Management
 * @{
 * This section describes tests for the event management functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup ExecutionTest Execution Control
 * @{
 * This section describes tests for the execution control functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup GraphTest Graph Management
 * @{
 * This section describes tests for the graph management types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup KernelTest Kernel Functions Management
 * @{
 * This section describes the various kernel functions invocation.
 * @}
 */

/**
 * @defgroup SyncthreadsTest Synchronization Functions
 * @{
 * This section describes tests for Synchronization Functions.
 * @}
 */

/**
 * @defgroup ThreadfenceTest Memory Fence Functions
 * @{
 * This section describes tests for Memory Fence Functions.
 * @}
 */

/**
 * @defgroup MemoryTest memory Management APIs
 * @{
 * This section describes the memory management types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup PeerToPeerTest PeerToPeer Device Memory Access
 * @{
 * This section describes tests for the PeerToPeer device memory access functions of HIP runtime
 * API.
 * @warning PeerToPeer support is experimental.
 * @}
 */

/**
 * @defgroup PerformanceTest Performance tests
 * @{
 * This section describes performance tests for the target API groups and use-cases.
 * @}
 */

/**
 * @defgroup PerformanceTestEvent Event performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for the HIP event APIs.
 * @}
 */

/**
 * @defgroup PerformanceTestStream Stream performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for the HIP stream APIs.
 * @}
 */

/**
 * @defgroup PerformanceTestMemory Memory performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for the HIP memory management APIs
 * (including memcpy, memset, and host/device allocation).
 * @}
 */

/**
 * @defgroup PerformanceTestKernelLaunch Kernel launch performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for HIP kernel launch APIs.
 * @}
 */

/**
 * @defgroup PerformanceTestWarpSync Warp sync performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for HIP warp synchronization
 * primitives.
 * @}
 */

/**
 * @defgroup PerformanceTestGraph Graph performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for the HIP graph APIs.
 * @}
 */

/**
 * @defgroup PerformanceTestCompute Compute performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for HIP compute workloads.
 * @}
 */

/**
 * @defgroup PerformanceTestDispatch Dispatch performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for HIP kernel dispatch.
 * @}
 */

/**
 * @defgroup PerformanceTestVMM Virtual memory management performance tests
 * @ingroup PerformanceTest
 * @{
 * This section describes performance tests for HIP virtual memory management
 * APIs.
 * @}
 */

/**
 * @defgroup ShflTest warp shuffle function Management
 * @{
 * This section describes the warp shuffle types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup p2pTest P2P Management
 * @{
 * This section describes the P2P management types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup StreamOTest Ordered Memory Allocator
 * @{
 * This section describes the tests for Stream Ordered Memory Allocator functions of HIP runtime
 * API.
 * @}
 */

/**
 * @defgroup StreamTest Stream Management
 * @{
 * This section describes the stream management types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup ModuleTest Module Management
 * @{
 * This section describes the module management types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup TextureTest Texture Management
 * @{
 * This section describes tests for the texture management functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup VectorTypeTest Vector types
 * @{
 * This section describes tests for the Vector type functions and operators.
 * @}
 */

 /**
 * @defgroup MathTest Math Device Functions
 * @{
 * This section describes tests for device math functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup PrintfTest Printf API Management
 * @{
 * This section describes the various Printf use case Scenarios.
 * @}
 */

/**
 * @defgroup SurfaceTest Surface Management
 * @{
 * This section describes tests for the surface management functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup ComplexTest Complex type
 * @{
 * This section describes tests for the Complex type functions.
 * @}
 */

/**
 * @defgroup VirtualMemoryManagementTest Virtual Memory Management APIs
 * @{
 * This section describes the virtual memory management types & functions of HIP runtime API.
 * @}
 */

/**
 * @defgroup ModuleTest Module Functions Management
 * @{
 * This section describes the loading of modules from code object files and invocation of different kernels.
 * @}
 */