hip_runtime_api.h

Go to the documentation of this file.

/*
Copyright (c) 2015 - present Advanced Micro Devices, Inc. All rights reserved.

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.
*/

//#pragma once
#ifndef HIP_INCLUDE_HIP_HCC_DETAIL_HIP_RUNTIME_API_H
#define HIP_INCLUDE_HIP_HCC_DETAIL_HIP_RUNTIME_API_H

#include <stdint.h>
#include <stddef.h>
#include <iostream>

#ifndef GENERIC_GRID_LAUNCH
#define GENERIC_GRID_LAUNCH 1
#endif

#include <hip/hcc_detail/host_defines.h>
#include <hip/hip_runtime_api.h>
#include <hip/hip_texture.h>

#if defined (__HCC__) &&  (__hcc_workweek__ < 16155)
#error("This version of HIP requires a newer version of HCC.");
#endif

#define HIP_LAUNCH_PARAM_BUFFER_POINTER ((void*) 0x01)
#define HIP_LAUNCH_PARAM_BUFFER_SIZE    ((void*) 0x02)
#define HIP_LAUNCH_PARAM_END            ((void*) 0x03)

// Structure definitions:
#ifdef __cplusplus
extern "C" {
#endif

//---
//API-visible structures
typedef struct ihipCtx_t    *hipCtx_t;

// Note many APIs also use integer deviceIds as an alternative to the device pointer:
typedef int hipDevice_t;

typedef struct ihipStream_t *hipStream_t;

//TODO: IPC implementation

#define hipIpcMemLazyEnablePeerAccess 0

#define HIP_IPC_HANDLE_SIZE 64

typedef struct hipIpcMemHandle_st
{
    char reserved[HIP_IPC_HANDLE_SIZE];
}hipIpcMemHandle_t;

//TODO: IPC event handle currently unsupported
struct ihipIpcEventHandle_t;
typedef struct ihipIpcEventHandle_t *hipIpcEventHandle_t;


//END TODO

typedef struct ihipModule_t *hipModule_t;

typedef struct ihipModuleSymbol_t *hipFunction_t;

typedef void* hipDeviceptr_t;

typedef struct ihipEvent_t *hipEvent_t;

enum hipLimit_t
{
    hipLimitMallocHeapSize = 0x02,
};

#define hipStreamDefault            0x00 
#define hipStreamNonBlocking        0x01 


#define hipEventDefault             0x0  
#define hipEventBlockingSync        0x1  
#define hipEventDisableTiming       0x2  
#define hipEventInterprocess        0x4  
#define hipEventReleaseToDevice     0x40000000  
#define hipEventReleaseToSystem     0x80000000  


#define hipHostMallocDefault        0x0
#define hipHostMallocPortable       0x1  
#define hipHostMallocMapped         0x2  
#define hipHostMallocWriteCombined  0x4
#define hipHostMallocCoherent       0x40000000 
#define hipHostMallocNonCoherent    0x80000000 


#define hipHostRegisterDefault      0x0  
#define hipHostRegisterPortable     0x1  
#define hipHostRegisterMapped       0x2  
#define hipHostRegisterIoMemory     0x4  



#define hipDeviceScheduleAuto       0x0  
#define hipDeviceScheduleSpin       0x1  
#define hipDeviceScheduleYield      0x2  
#define hipDeviceScheduleBlockingSync 0x4
#define hipDeviceScheduleMask       0x7

#define hipDeviceMapHost            0x8
#define hipDeviceLmemResizeToMax    0x16


/*
* @brief hipJitOption
* @enum
* @ingroup Enumerations
*/
typedef enum hipJitOption {
  hipJitOptionMaxRegisters = 0,
  hipJitOptionThreadsPerBlock,
  hipJitOptionWallTime,
  hipJitOptionInfoLogBuffer,
  hipJitOptionInfoLogBufferSizeBytes,
  hipJitOptionErrorLogBuffer,
  hipJitOptionErrorLogBufferSizeBytes,
  hipJitOptionOptimizationLevel,
  hipJitOptionTargetFromContext,
  hipJitOptionTarget,
  hipJitOptionFallbackStrategy,
  hipJitOptionGenerateDebugInfo,
  hipJitOptionLogVerbose,
  hipJitOptionGenerateLineInfo,
  hipJitOptionCacheMode,
  hipJitOptionSm3xOpt,
  hipJitOptionFastCompile,
  hipJitOptionNumOptions
} hipJitOption;


typedef enum hipFuncCache_t {
    hipFuncCachePreferNone, 
    hipFuncCachePreferShared, 
    hipFuncCachePreferL1, 
    hipFuncCachePreferEqual, 
} hipFuncCache_t;


typedef enum hipSharedMemConfig {
    hipSharedMemBankSizeDefault,   
    hipSharedMemBankSizeFourByte,  
    hipSharedMemBankSizeEightByte  
} hipSharedMemConfig;



typedef struct dim3 {
  uint32_t x;                 
  uint32_t y;                 
  uint32_t z;                 
#ifdef __cplusplus
  dim3(uint32_t _x=1, uint32_t _y=1, uint32_t _z=1) : x(_x), y(_y), z(_z) {};
#endif
} dim3;


typedef enum hipMemcpyKind {
   hipMemcpyHostToHost = 0    
  ,hipMemcpyHostToDevice = 1  
  ,hipMemcpyDeviceToHost = 2  
  ,hipMemcpyDeviceToDevice =3 
  ,hipMemcpyDefault = 4,      
} hipMemcpyKind;

typedef struct {
  unsigned int width;
  unsigned int height;
  enum hipChannelFormatKind f;
  void* data; //FIXME: generalize this
} hipArray;



// Doxygen end group GlobalDefs
//-------------------------------------------------------------------------------------------------


// The handle allows the async commands to use the stream even if the parent hipStream_t goes out-of-scope.
//typedef class ihipStream_t * hipStream_t;


/*
 * Opaque structure allows the true event (pointed at by the handle) to remain "live" even if the surrounding hipEvent_t goes out-of-scope.
 * This is handy for cases where the hipEvent_t goes out-of-scope but the true event is being written by some async queue or device */
//typedef struct hipEvent_t {
//    struct ihipEvent_t *_handle;
//} hipEvent_t;







hipError_t hipDeviceSynchronize(void);



hipError_t hipDeviceReset(void) ;


hipError_t hipSetDevice(int deviceId);


hipError_t hipGetDevice(int *deviceId);


hipError_t hipGetDeviceCount(int *count);

hipError_t hipDeviceGetAttribute(int* pi, hipDeviceAttribute_t attr, int deviceId);

hipError_t hipGetDeviceProperties(hipDeviceProp_t* prop, int deviceId);


hipError_t hipDeviceSetCacheConfig ( hipFuncCache_t cacheConfig );


hipError_t hipDeviceGetCacheConfig ( hipFuncCache_t *cacheConfig );

hipError_t hipDeviceGetLimit(size_t *pValue, enum hipLimit_t limit);


hipError_t hipFuncSetCacheConfig (const void* func, hipFuncCache_t config );

hipError_t hipDeviceGetSharedMemConfig ( hipSharedMemConfig * pConfig );


hipError_t hipDeviceSetSharedMemConfig ( hipSharedMemConfig config );

hipError_t hipSetDeviceFlags ( unsigned flags);

hipError_t hipChooseDevice(int *device, const hipDeviceProp_t* prop);

// end doxygen Device
hipError_t hipGetLastError(void);


hipError_t hipPeekAtLastError(void);



const char *hipGetErrorName(hipError_t hip_error);


const char *hipGetErrorString(hipError_t hipError);

// end doxygen Error
hipError_t hipStreamCreate(hipStream_t *stream);


hipError_t hipStreamCreateWithFlags(hipStream_t *stream, unsigned int flags);


hipError_t hipStreamDestroy(hipStream_t stream);


hipError_t hipStreamQuery(hipStream_t stream);


hipError_t hipStreamSynchronize(hipStream_t stream);


hipError_t hipStreamWaitEvent(hipStream_t stream, hipEvent_t event, unsigned int flags);



hipError_t hipStreamGetFlags(hipStream_t stream, unsigned int *flags);

typedef void(* hipStreamCallback_t)(hipStream_t stream,  hipError_t status, void* userData);

hipError_t hipStreamAddCallback(hipStream_t stream, hipStreamCallback_t callback, void *userData, unsigned int flags);


// end doxygen Stream
hipError_t hipEventCreateWithFlags(hipEvent_t* event, unsigned flags);


hipError_t hipEventCreate(hipEvent_t* event);


#ifdef __cplusplus
hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream = NULL);
#else
hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream);
#endif

hipError_t hipEventDestroy(hipEvent_t event);


hipError_t hipEventSynchronize(hipEvent_t event);


hipError_t hipEventElapsedTime(float *ms, hipEvent_t start, hipEvent_t stop);


hipError_t hipEventQuery(hipEvent_t event) ;


// end doxygen Events
hipError_t hipPointerGetAttributes(hipPointerAttribute_t *attributes, const void* ptr);

hipError_t hipMalloc(void** ptr, size_t size) ;

hipError_t hipMallocHost(void** ptr, size_t size) __attribute__((deprecated("use hipHostMalloc instead"))) ;

hipError_t hipHostMalloc(void** ptr, size_t size, unsigned int flags) ;

hipError_t hipHostAlloc(void** ptr, size_t size, unsigned int flags) __attribute__((deprecated("use hipHostMalloc instead"))) ;

hipError_t hipHostGetDevicePointer(void** devPtr, void* hstPtr, unsigned int flags) ;

hipError_t hipHostGetFlags(unsigned int* flagsPtr, void* hostPtr) ;

hipError_t hipHostRegister(void* hostPtr, size_t sizeBytes, unsigned int flags) ;

hipError_t hipHostUnregister(void* hostPtr) ;

hipError_t hipMallocPitch(void** ptr, size_t* pitch, size_t width, size_t height);

hipError_t hipFree(void* ptr);

hipError_t hipFreeHost(void* ptr) __attribute__((deprecated("use hipHostFree instead")));

hipError_t hipHostFree(void* ptr);

hipError_t hipMemcpy(void* dst, const void* src, size_t sizeBytes, hipMemcpyKind kind);

hipError_t hipMemcpyHtoD(hipDeviceptr_t dst, void* src, size_t sizeBytes);

hipError_t hipMemcpyDtoH(void* dst, hipDeviceptr_t src, size_t sizeBytes);

hipError_t hipMemcpyDtoD(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes);

hipError_t hipMemcpyHtoDAsync(hipDeviceptr_t dst, void* src, size_t sizeBytes, hipStream_t stream);

hipError_t hipMemcpyDtoHAsync(void* dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream);

hipError_t hipMemcpyDtoDAsync(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream);


hipError_t hipMemcpyToSymbol(const void* symbolName, const void *src, size_t sizeBytes, size_t offset = 0, hipMemcpyKind kind = hipMemcpyHostToDevice);


hipError_t hipMemcpyToSymbolAsync(const void* symbolName, const void *src, size_t sizeBytes, size_t offset, hipMemcpyKind kind, hipStream_t stream = 0);

hipError_t hipMemcpyFromSymbol(void *dst, const void* symbolName, size_t sizeBytes, size_t offset = 0, hipMemcpyKind kind = hipMemcpyDeviceToHost);

hipError_t hipMemcpyFromSymbolAsync(void *dst, const void* symbolName, size_t sizeBytes, size_t offset, hipMemcpyKind kind, hipStream_t stream = 0);

#if __cplusplus
hipError_t hipMemcpyAsync(void* dst, const void* src, size_t sizeBytes, hipMemcpyKind kind, hipStream_t stream=0);
#else
hipError_t hipMemcpyAsync(void* dst, const void* src, size_t sizeBytes, hipMemcpyKind kind, hipStream_t stream);
#endif

hipError_t hipMemset(void* dst, int  value, size_t sizeBytes );

hipError_t hipMemsetD8(hipDeviceptr_t dest, unsigned char  value, size_t sizeBytes );

#if __cplusplus
hipError_t hipMemsetAsync(void* dst, int  value, size_t sizeBytes, hipStream_t stream = 0 );
#else
hipError_t hipMemsetAsync(void* dst, int value, size_t sizeBytes, hipStream_t stream);
#endif

hipError_t hipMemGetInfo  (size_t * free, size_t * total)   ;


hipError_t hipMemPtrGetInfo(void *ptr, size_t *size);


#if __cplusplus
hipError_t hipMallocArray(hipArray** array, const hipChannelFormatDesc* desc,
                          size_t width, size_t height = 0, unsigned int flags = 0);
#else
hipError_t hipMallocArray(hipArray** array, const struct hipChannelFormatDesc* desc,
                          size_t width, size_t height, unsigned int flags);
#endif

hipError_t hipFreeArray(hipArray* array);

hipError_t hipMemcpy2D(void* dst, size_t dpitch, const void* src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind);

#if __cplusplus
hipError_t hipMemcpy2DAsync(void* dst, size_t dpitch, const void* src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream = 0);
#else
hipError_t hipMemcpy2DAsync(void* dst, size_t dpitch, const void* src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind, hipStream_t stream);
#endif

hipError_t hipMemcpy2DToArray(hipArray* dst, size_t wOffset, size_t hOffset, const void* src,
                              size_t spitch, size_t width, size_t height, hipMemcpyKind kind);

hipError_t hipMemcpyToArray(hipArray* dst, size_t wOffset, size_t hOffset,
                            const void* src, size_t count, hipMemcpyKind kind);



// doxygen end Memory
hipError_t hipDeviceCanAccessPeer (int* canAccessPeer, int deviceId, int peerDeviceId);


hipError_t  hipDeviceEnablePeerAccess (int  peerDeviceId, unsigned int flags);


hipError_t  hipDeviceDisablePeerAccess (int peerDeviceId);

hipError_t hipMemGetAddressRange ( hipDeviceptr_t* pbase, size_t* psize, hipDeviceptr_t dptr );

#ifndef USE_PEER_NON_UNIFIED
#define USE_PEER_NON_UNIFIED 1
#endif

#if USE_PEER_NON_UNIFIED==1

hipError_t hipMemcpyPeer (void* dst, int dstDeviceId, const void* src, int srcDeviceId, size_t sizeBytes);

#if __cplusplus
hipError_t hipMemcpyPeerAsync ( void* dst, int  dstDeviceId, const void* src, int  srcDevice, size_t sizeBytes, hipStream_t stream=0 );
#else
hipError_t hipMemcpyPeerAsync(void* dst, int dstDevice, const void* src, int srcDevice, size_t sizeBytes, hipStream_t stream);
#endif
#endif


// doxygen end PeerToPeer
// TODO-ctx - more description on error codes.
hipError_t hipInit(unsigned int flags) ;


hipError_t hipCtxCreate(hipCtx_t *ctx, unsigned int flags,  hipDevice_t device);

hipError_t hipCtxDestroy(hipCtx_t ctx);

hipError_t hipCtxPopCurrent(hipCtx_t* ctx);

hipError_t hipCtxPushCurrent(hipCtx_t ctx);

hipError_t hipCtxSetCurrent(hipCtx_t ctx);

hipError_t hipCtxGetCurrent(hipCtx_t* ctx);

hipError_t hipCtxGetDevice(hipDevice_t *device);

hipError_t hipCtxGetApiVersion (hipCtx_t ctx,int *apiVersion);

hipError_t hipCtxGetCacheConfig ( hipFuncCache_t *cacheConfig );

hipError_t hipCtxSetCacheConfig ( hipFuncCache_t cacheConfig );

hipError_t hipCtxSetSharedMemConfig ( hipSharedMemConfig config );

hipError_t hipCtxGetSharedMemConfig ( hipSharedMemConfig * pConfig );

hipError_t hipCtxSynchronize ( void );

hipError_t hipCtxGetFlags ( unsigned int* flags );

hipError_t  hipCtxEnablePeerAccess (hipCtx_t peerCtx, unsigned int flags);

hipError_t  hipCtxDisablePeerAccess (hipCtx_t peerCtx);

hipError_t hipDevicePrimaryCtxGetState ( hipDevice_t dev, unsigned int* flags, int* active );

hipError_t hipDevicePrimaryCtxRelease ( hipDevice_t dev);

hipError_t hipDevicePrimaryCtxRetain ( hipCtx_t* pctx, hipDevice_t dev );

hipError_t hipDevicePrimaryCtxReset ( hipDevice_t dev );

hipError_t hipDevicePrimaryCtxSetFlags ( hipDevice_t dev, unsigned int  flags );

// doxygen end Context Management
hipError_t hipDeviceGet(hipDevice_t *device, int ordinal);

hipError_t hipDeviceComputeCapability(int *major,int *minor,hipDevice_t device);

hipError_t hipDeviceGetName(char *name,int len,hipDevice_t device);

hipError_t hipDeviceGetPCIBusId (char *pciBusId,int len,int device);


hipError_t hipDeviceGetByPCIBusId ( int*  device,const int* pciBusId );


hipError_t hipDeviceTotalMem (size_t *bytes,hipDevice_t device);

hipError_t hipDriverGetVersion(int *driverVersion) ;

hipError_t hipRuntimeGetVersion(int *runtimeVersion) ;

hipError_t hipModuleLoad(hipModule_t *module, const char *fname);

hipError_t hipModuleUnload(hipModule_t module);

hipError_t hipModuleGetFunction(hipFunction_t *function, hipModule_t module, const char *kname);

hipError_t hipModuleGetGlobal(hipDeviceptr_t *dptr, size_t *bytes, hipModule_t hmod, const char *name);

hipError_t hipModuleLoadData(hipModule_t *module, const void *image);

hipError_t hipModuleLoadDataEx(hipModule_t *module, const void *image, unsigned int numOptions, hipJitOption *options, void **optionValues);

hipError_t hipModuleLaunchKernel(hipFunction_t f,
                              unsigned int gridDimX,
                              unsigned int gridDimY,
                              unsigned int gridDimZ,
                              unsigned int blockDimX,
                              unsigned int blockDimY,
                              unsigned int blockDimZ,
                              unsigned int sharedMemBytes,
                              hipStream_t stream,
                              void **kernelParams,
                              void **extra) ;

// doxygen end Version Management
// TODO - expand descriptions:
hipError_t hipProfilerStart();


hipError_t hipProfilerStop();


//TODO: implement IPC apis

hipError_t hipIpcGetMemHandle(hipIpcMemHandle_t *handle, void *devPtr);

hipError_t hipIpcOpenMemHandle(void **devPtr,
        hipIpcMemHandle_t handle, unsigned int flags);

hipError_t hipIpcCloseMemHandle(void *devPtr);


// hipError_t hipIpcGetMemHandle(hipIpcMemHandle_t* handle, void* devPtr);
// hipError_t hipIpcCloseMemHandle(void *devPtr);
// // hipError_t hipIpcOpenEventHandle(hipEvent_t* event, hipIpcEventHandle_t handle);
// hipError_t hipIpcOpenMemHandle(void** devPtr, hipIpcMemHandle_t handle, unsigned int flags);


#ifdef __cplusplus
} /* extern "c" */
#endif

#ifdef __cplusplus
/*
 * @brief hipBindTexture Binds size bytes of the memory area pointed to by @p devPtr to the texture reference tex.
 *
 * @p desc describes how the memory is interpreted when fetching values from the texture. The @p offset parameter is an optional byte offset as with the low-level
 * hipBindTexture() function. Any memory previously bound to tex is unbound.
 *
 *  @param[in]  offset - Offset in bytes
 *  @param[out]  tex - texture to bind
 *  @param[in]  devPtr - Memory area on device
 *  @param[in]  desc - Channel format
 *  @param[in]  size - Size of the memory area pointed to by devPtr
 *  @return #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryFree, #hipErrorUnknown
 **/
template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t  hipBindTexture(size_t *offset,
                                     struct texture<T, dim, readMode> &tex,
                                     const void *devPtr,
                                     const struct hipChannelFormatDesc *desc,
                                     size_t size=UINT_MAX)
{
    tex._dataPtr = static_cast<const T*>(devPtr);

    return hipSuccess;
}

/*
 * @brief hipBindTexture Binds size bytes of the memory area pointed to by @p devPtr to the texture reference tex.
 *
 * @p desc describes how the memory is interpreted when fetching values from the texture. The @p offset parameter is an optional byte offset as with the low-level
 * hipBindTexture() function. Any memory previously bound to tex is unbound.
 *
 *  @param[in]  offset - Offset in bytes
 *  @param[in]  tex - texture to bind
 *  @param[in]  devPtr - Memory area on device
 *  @param[in]  size - Size of the memory area pointed to by devPtr
 *  @return #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryFree, #hipErrorUnknown
 **/
template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t  hipBindTexture(size_t *offset,
                                     struct texture<T, dim, readMode> &tex,
                                     const void *devPtr,
                                     size_t size=UINT_MAX)
{
    return  hipBindTexture(offset, tex, devPtr, &tex.channelDesc, size);
}

template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t hipBindTextureToArray(struct texture<T, dim, readMode> &tex, hipArray* array) {
  tex.width = array->width;
  tex.height = array->height;
  tex._dataPtr = static_cast<const T*>(array->data);
  return hipSuccess;
}

/*
 * @brief Unbinds the textuer bound to @p tex
 *
 *  @param[in]  tex - texture to unbind
 *
 *  @return #hipSuccess
 **/
template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t  hipUnbindTexture(struct texture<T, dim, readMode> &tex)
{
    tex._dataPtr = NULL;

    return hipSuccess;
}



// doxygen end Texture
#endif


// end-group HCC_Specific
// doxygen end HIP API
#endif