/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/develop/include/rpp.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/develop/include/rpp.h Source File#

RPP: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/develop/include/rpp.h Source File

Go to the documentation of this file.

 /*
 MIT License
  
 Copyright (c) 2019 - 2024 Advanced Micro Devices, Inc.
  
 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.
 */
  
 #ifndef RPP_H
 #define RPP_H
  
 #include <export.h>
  
 #if RPP_BACKEND_OPENCL
  
 #define CL_TARGET_OPENCL_VERSION 220
 #if defined(__APPLE__) || defined(__MACOSX)
 #include <OpenCL/cl.h>
 #else
 #include <CL/cl.h>
 #endif
 typedef cl_command_queue rppAcceleratorQueue_t;
  
 #elif RPP_BACKEND_HIP
  
 #include <hip/hip_runtime_api.h>
 typedef hipStream_t rppAcceleratorQueue_t;
  
 #endif
  
 #define RPP_DECLARE_OBJECT(name)    \
     struct name                     \
     {                               \
     };                              \
     typedef struct name* name##_t;
  
 RPP_DECLARE_OBJECT(rppHandle);      // Create the rppHandle_t type
  
 typedef rppHandle_t RppHandle_t;    // Create typedef for RppHandle_t
  
 #if _WIN32
 #define SHARED_PUBLIC __declspec(dllexport)
 #else
 #define SHARED_PUBLIC __attribute__ ((visibility ("default")))
 #endif
  
 #include "rppdefs.h"
 #include "rppi.h"
 #include "rppt.h"
 #include "rpp_version.h"
  
 typedef void* (*rppAllocatorFunction)(void* context, size_t sizeBytes);
  
 typedef void (*rppDeallocatorFunction)(void* context, void* memory);
  
 #ifdef __cplusplus
 extern "C" {
 #endif
  
 extern "C" SHARED_PUBLIC const char* rppGetErrorString(rppStatus_t error);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppCreate(rppHandle_t* handle);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppCreateWithBatchSize(rppHandle_t* handle, size_t nBatchSize, Rpp32u numThreads = 0);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppDestroy(rppHandle_t handle);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppDestroyHost(rppHandle_t handle);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppSetBatchSize(rppHandle_t handle, size_t batchSize);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppGetBatchSize(rppHandle_t handle, size_t *batchSize);
  
 #if GPU_SUPPORT
  
 extern "C" SHARED_PUBLIC rppStatus_t rppCreateWithStream(rppHandle_t* handle, rppAcceleratorQueue_t stream);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppCreateWithStreamAndBatchSize(rppHandle_t* handle, rppAcceleratorQueue_t stream, size_t nBatchSize);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppDestroyGPU(rppHandle_t handle);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppSetStream(rppHandle_t handle, rppAcceleratorQueue_t streamID);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppGetStream(rppHandle_t handle, rppAcceleratorQueue_t* streamID);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppSetAllocator(rppHandle_t handle, rppAllocatorFunction allocator, rppDeallocatorFunction deallocator, void* allocatorContext);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppGetKernelTime(rppHandle_t handle, float* time);
  
 extern "C" SHARED_PUBLIC rppStatus_t rppEnableProfiling(rppHandle_t handle, bool enable);
  
 #endif // GPU_SUPPORT
  
 #ifdef __cplusplus
 }
 #endif    // __cplusplus
  
 #endif    // RPP_H