HIP: Heterogenous-computing Interface for Portability
hip_runtime_api.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2015 - present Advanced Micro Devices, Inc. All rights reserved.
3 
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21 */
22 
23 //#pragma once
24 #ifndef HIP_INCLUDE_HIP_HCC_DETAIL_HIP_RUNTIME_API_H
25 #define HIP_INCLUDE_HIP_HCC_DETAIL_HIP_RUNTIME_API_H
26 
31 #include <stdint.h>
32 #include <stddef.h>
33 
34 #ifndef GENERIC_GRID_LAUNCH
35 #define GENERIC_GRID_LAUNCH 1
36 #endif
37 
39 #include <hip/hip_runtime_api.h>
40 #include <hip/hcc_detail/driver_types.h>
43 
44 #define DEPRECATED(msg) __attribute__ ((deprecated(msg)))
45 #define DEPRECATED_MSG "This API is marked as deprecated and may not be supported in future releases.For more details please refer https://github.com/ROCm-Developer-Tools/HIP/tree/master/docs/markdown/hip_deprecated_api_list"
46 
47 #if defined(__HCC__) && (__hcc_workweek__ < 16155)
48 #error("This version of HIP requires a newer version of HCC.");
49 #endif
50 
51 #define HIP_LAUNCH_PARAM_BUFFER_POINTER ((void*)0x01)
52 #define HIP_LAUNCH_PARAM_BUFFER_SIZE ((void*)0x02)
53 #define HIP_LAUNCH_PARAM_END ((void*)0x03)
54 
55 #ifdef __cplusplus
56  #define __dparm(x) \
57  = x
58 #else
59  #define __dparm(x)
60 #endif
61 
62 // Structure definitions:
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66 
67 //---
68 // API-visible structures
69 typedef struct ihipCtx_t* hipCtx_t;
70 
71 // Note many APIs also use integer deviceIds as an alternative to the device pointer:
72 typedef int hipDevice_t;
73 
74 typedef struct ihipStream_t* hipStream_t;
75 
76 // TODO: IPC implementation
77 
78 #define hipIpcMemLazyEnablePeerAccess 0
79 
80 #define HIP_IPC_HANDLE_SIZE 64
81 
82 typedef struct hipIpcMemHandle_st {
83  char reserved[HIP_IPC_HANDLE_SIZE];
85 
86 // TODO: IPC event handle currently unsupported
87 struct ihipIpcEventHandle_t;
88 typedef struct ihipIpcEventHandle_t* hipIpcEventHandle_t;
89 
90 
91 // END TODO
92 
93 typedef struct ihipModule_t* hipModule_t;
94 
95 typedef struct ihipModuleSymbol_t* hipFunction_t;
96 
97 typedef struct hipFuncAttributes {
98  int binaryVersion;
99  int cacheModeCA;
100  size_t constSizeBytes;
101  size_t localSizeBytes;
102  int maxDynamicSharedSizeBytes;
103  int maxThreadsPerBlock;
104  int numRegs;
105  int preferredShmemCarveout;
106  int ptxVersion;
107  size_t sharedSizeBytes;
109 
110 typedef struct ihipEvent_t* hipEvent_t;
111 
112 enum hipLimit_t {
113  hipLimitMallocHeapSize = 0x02,
114 };
115 
120 #define hipStreamDefault \
122  0x00
123 #define hipStreamNonBlocking 0x01
124 
125 
127 #define hipEventDefault 0x0
128 #define hipEventBlockingSync \
129  0x1
130 #define hipEventDisableTiming \
131  0x2
132 #define hipEventInterprocess 0x4
133 #define hipEventReleaseToDevice \
134  0x40000000
135 #define hipEventReleaseToSystem \
138  0x80000000
139 
142 
144 #define hipHostMallocDefault 0x0
145 #define hipHostMallocPortable 0x1
146 #define hipHostMallocMapped \
147  0x2
148 #define hipHostMallocWriteCombined 0x4
150 #define hipHostMallocCoherent \
151  0x40000000
152 #define hipHostMallocNonCoherent \
154  0x80000000
155 
157 
159 #define hipHostRegisterDefault 0x0
160 #define hipHostRegisterPortable 0x1
161 #define hipHostRegisterMapped \
162  0x2
163 #define hipHostRegisterIoMemory 0x4
165 
166 
167 #define hipDeviceScheduleAuto 0x0
168 #define hipDeviceScheduleSpin \
169  0x1
170 #define hipDeviceScheduleYield \
172  0x2
173 #define hipDeviceScheduleBlockingSync 0x4
175 #define hipDeviceScheduleMask 0x7
176 
177 #define hipDeviceMapHost 0x8
178 #define hipDeviceLmemResizeToMax 0x16
179 
180 #define hipArrayDefault 0x00
181 #define hipArrayLayered 0x01
182 #define hipArraySurfaceLoadStore 0x02
183 #define hipArrayCubemap 0x04
184 #define hipArrayTextureGather 0x08
185 
186 /*
187  * @brief hipJitOption
188  * @enum
189  * @ingroup Enumerations
190  */
191 typedef enum hipJitOption {
192  hipJitOptionMaxRegisters = 0,
193  hipJitOptionThreadsPerBlock,
194  hipJitOptionWallTime,
195  hipJitOptionInfoLogBuffer,
196  hipJitOptionInfoLogBufferSizeBytes,
197  hipJitOptionErrorLogBuffer,
198  hipJitOptionErrorLogBufferSizeBytes,
199  hipJitOptionOptimizationLevel,
200  hipJitOptionTargetFromContext,
201  hipJitOptionTarget,
202  hipJitOptionFallbackStrategy,
203  hipJitOptionGenerateDebugInfo,
204  hipJitOptionLogVerbose,
205  hipJitOptionGenerateLineInfo,
206  hipJitOptionCacheMode,
207  hipJitOptionSm3xOpt,
208  hipJitOptionFastCompile,
209  hipJitOptionNumOptions
210 } hipJitOption;
211 
212 
216 typedef enum hipFuncCache_t {
222 
223 
227 typedef enum hipSharedMemConfig {
234 
235 
240 typedef struct dim3 {
241  uint32_t x;
242  uint32_t y;
243  uint32_t z;
244 #ifdef __cplusplus
245  dim3(uint32_t _x = 1, uint32_t _y = 1, uint32_t _z = 1) : x(_x), y(_y), z(_z){};
246 #endif
247 } dim3;
248 
249 
250 // Doxygen end group GlobalDefs
254 //-------------------------------------------------------------------------------------------------
255 
256 
257 // The handle allows the async commands to use the stream even if the parent hipStream_t goes
258 // out-of-scope.
259 // typedef class ihipStream_t * hipStream_t;
260 
261 
262 /*
263  * Opaque structure allows the true event (pointed at by the handle) to remain "live" even if the
264  * surrounding hipEvent_t goes out-of-scope. This is handy for cases where the hipEvent_t goes
265  * out-of-scope but the true event is being written by some async queue or device */
266 // typedef struct hipEvent_t {
267 // struct ihipEvent_t *_handle;
268 //} hipEvent_t;
269 
270 
296 hipError_t hipDeviceSynchronize(void);
297 
298 
310 hipError_t hipDeviceReset(void);
311 
312 
344 hipError_t hipSetDevice(int deviceId);
345 
346 
360 hipError_t hipGetDevice(int* deviceId);
361 
362 
375 hipError_t hipGetDeviceCount(int* count);
376 
386 hipError_t hipDeviceGetAttribute(int* pi, hipDeviceAttribute_t attr, int deviceId);
387 
401 hipError_t hipGetDeviceProperties(hipDeviceProp_t* prop, int deviceId);
402 
403 
414 hipError_t hipDeviceSetCacheConfig(hipFuncCache_t cacheConfig);
415 
416 
427 hipError_t hipDeviceGetCacheConfig(hipFuncCache_t* cacheConfig);
428 
439 hipError_t hipDeviceGetLimit(size_t* pValue, enum hipLimit_t limit);
440 
441 
452 hipError_t hipFuncSetCacheConfig(const void* func, hipFuncCache_t config);
453 
465 hipError_t hipDeviceGetSharedMemConfig(hipSharedMemConfig* pConfig);
466 
467 
479 hipError_t hipDeviceSetSharedMemConfig(hipSharedMemConfig config);
480 
505 hipError_t hipSetDeviceFlags(unsigned flags);
506 
515 hipError_t hipChooseDevice(int* device, const hipDeviceProp_t* prop);
516 
517 // end doxygen Device
540 hipError_t hipGetLastError(void);
541 
542 
553 hipError_t hipPeekAtLastError(void);
554 
555 
564 const char* hipGetErrorName(hipError_t hip_error);
565 
566 
577 const char* hipGetErrorString(hipError_t hipError);
578 
579 // end doxygen Error
614 hipError_t hipStreamCreate(hipStream_t* stream);
615 
616 
634 hipError_t hipStreamCreateWithFlags(hipStream_t* stream, unsigned int flags);
635 
636 
655 hipError_t hipStreamDestroy(hipStream_t stream);
656 
657 
673 hipError_t hipStreamQuery(hipStream_t stream);
674 
675 
695 hipError_t hipStreamSynchronize(hipStream_t stream);
696 
697 
717 hipError_t hipStreamWaitEvent(hipStream_t stream, hipEvent_t event, unsigned int flags);
718 
719 
733 hipError_t hipStreamGetFlags(hipStream_t stream, unsigned int* flags);
734 
738 typedef void (*hipStreamCallback_t)(hipStream_t stream, hipError_t status, void* userData);
739 
755 hipError_t hipStreamAddCallback(hipStream_t stream, hipStreamCallback_t callback, void* userData,
756  unsigned int flags);
757 
758 
759 // end doxygen Stream
796 hipError_t hipEventCreateWithFlags(hipEvent_t* event, unsigned flags);
797 
798 
810 hipError_t hipEventCreate(hipEvent_t* event);
811 
812 
840 #ifdef __cplusplus
841 hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream = NULL);
842 #else
843 hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream);
844 #endif
845 
862 hipError_t hipEventDestroy(hipEvent_t event);
863 
864 
882 hipError_t hipEventSynchronize(hipEvent_t event);
883 
884 
913 hipError_t hipEventElapsedTime(float* ms, hipEvent_t start, hipEvent_t stop);
914 
915 
931 hipError_t hipEventQuery(hipEvent_t event);
932 
933 
934 // end doxygen Events
965 hipError_t hipPointerGetAttributes(hipPointerAttribute_t* attributes, const void* ptr);
966 
980 hipError_t hipMalloc(void** ptr, size_t size);
981 
994 hipError_t hipMallocHost(void** ptr, size_t size)
995  __attribute__((deprecated("use hipHostMalloc instead")));
996 
1010 hipError_t hipHostMalloc(void** ptr, size_t size, unsigned int flags);
1011 
1025 hipError_t hipHostAlloc(void** ptr, size_t size, unsigned int flags)
1026  __attribute__((deprecated("use hipHostMalloc instead")));
1027 
1039 hipError_t hipHostGetDevicePointer(void** devPtr, void* hstPtr, unsigned int flags);
1040 
1050 hipError_t hipHostGetFlags(unsigned int* flagsPtr, void* hostPtr);
1051 
1088 hipError_t hipHostRegister(void* hostPtr, size_t sizeBytes, unsigned int flags);
1089 
1098 hipError_t hipHostUnregister(void* hostPtr);
1099 
1119 hipError_t hipMallocPitch(void** ptr, size_t* pitch, size_t width, size_t height);
1120 
1134 hipError_t hipFree(void* ptr);
1135 
1146 hipError_t hipFreeHost(void* ptr) __attribute__((deprecated("use hipHostFree instead")));
1147 
1161 hipError_t hipHostFree(void* ptr);
1162 
1190 hipError_t hipMemcpy(void* dst, const void* src, size_t sizeBytes, hipMemcpyKind kind);
1191 
1209 hipError_t hipMemcpyHtoD(hipDeviceptr_t dst, void* src, size_t sizeBytes);
1210 
1228 hipError_t hipMemcpyDtoH(void* dst, hipDeviceptr_t src, size_t sizeBytes);
1229 
1247 hipError_t hipMemcpyDtoD(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes);
1248 
1266 hipError_t hipMemcpyHtoDAsync(hipDeviceptr_t dst, void* src, size_t sizeBytes, hipStream_t stream);
1267 
1285 hipError_t hipMemcpyDtoHAsync(void* dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream);
1286 
1304 hipError_t hipMemcpyDtoDAsync(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes,
1305  hipStream_t stream);
1306 
1307 
1331 hipError_t hipMemcpyToSymbol(const void* symbolName, const void* src, size_t sizeBytes,
1332  size_t offset __dparm(0), hipMemcpyKind kind __dparm(hipMemcpyHostToDevice));
1333 
1334 
1360 hipError_t hipMemcpyToSymbolAsync(const void* symbolName, const void* src, size_t sizeBytes,
1361  size_t offset, hipMemcpyKind kind, hipStream_t stream __dparm(0));
1362 
1363 hipError_t hipMemcpyFromSymbol(void* dst, const void* symbolName, size_t sizeBytes,
1364  size_t offset __dparm(0), hipMemcpyKind kind __dparm( hipMemcpyDeviceToHost ));
1365 
1366 hipError_t hipMemcpyFromSymbolAsync(void* dst, const void* symbolName, size_t sizeBytes,
1367  size_t offset, hipMemcpyKind kind, hipStream_t stream __dparm(0));
1368 
1397 hipError_t hipMemcpyAsync(void* dst, const void* src, size_t sizeBytes, hipMemcpyKind kind,
1398  hipStream_t stream __dparm(0));
1399 
1409 hipError_t hipMemset(void* dst, int value, size_t sizeBytes);
1410 
1420 hipError_t hipMemsetD8(hipDeviceptr_t dest, unsigned char value, size_t sizeBytes);
1421 
1437 hipError_t hipMemsetAsync(void* dst, int value, size_t sizeBytes, hipStream_t stream __dparm(0));
1438 
1450 hipError_t hipMemset2D(void* dst, size_t pitch, int value, size_t width, size_t height);
1451 
1464 hipError_t hipMemset2DAsync(void* dst, size_t pitch, int value, size_t width, size_t height,hipStream_t stream __dparm(0));
1465 
1474 hipError_t hipMemset3D(hipPitchedPtr pitchedDevPtr, int value, hipExtent extent );
1475 
1485 hipError_t hipMemset3DAsync(hipPitchedPtr pitchedDevPtr, int value, hipExtent extent ,hipStream_t stream __dparm(0));
1486 
1496 hipError_t hipMemGetInfo(size_t* free, size_t* total);
1497 
1498 
1499 hipError_t hipMemPtrGetInfo(void* ptr, size_t* size);
1500 
1501 
1514 hipError_t hipMallocArray(hipArray** array, const hipChannelFormatDesc* desc, size_t width,
1515  size_t height __dparm(0), unsigned int flags __dparm(hipArrayDefault));
1516 hipError_t hipArrayCreate(hipArray** pHandle, const HIP_ARRAY_DESCRIPTOR* pAllocateArray);
1517 
1518 hipError_t hipArray3DCreate(hipArray** array, const HIP_ARRAY_DESCRIPTOR* pAllocateArray);
1519 
1520 hipError_t hipMalloc3D(hipPitchedPtr* pitchedDevPtr, hipExtent extent);
1521 
1530 hipError_t hipFreeArray(hipArray* array);
1531 
1544 hipError_t hipMalloc3DArray(hipArray** array, const struct hipChannelFormatDesc* desc,
1545  struct hipExtent extent, unsigned int flags);
1562 hipError_t hipMemcpy2D(void* dst, size_t dpitch, const void* src, size_t spitch, size_t width,
1563  size_t height, hipMemcpyKind kind);
1564 hipError_t hipMemcpyParam2D(const hip_Memcpy2D* pCopy);
1565 
1583 hipError_t hipMemcpy2DAsync(void* dst, size_t dpitch, const void* src, size_t spitch, size_t width,
1584  size_t height, hipMemcpyKind kind, hipStream_t stream __dparm(0));
1585 
1602 hipError_t hipMemcpy2DToArray(hipArray* dst, size_t wOffset, size_t hOffset, const void* src,
1603  size_t spitch, size_t width, size_t height, hipMemcpyKind kind);
1604 
1621 hipError_t hipMemcpyToArray(hipArray* dst, size_t wOffset, size_t hOffset, const void* src,
1622  size_t count, hipMemcpyKind kind);
1623 
1639 hipError_t hipMemcpyFromArray(void* dst, hipArray_const_t srcArray, size_t wOffset, size_t hOffset,
1640  size_t count, hipMemcpyKind kind);
1641 
1655 hipError_t hipMemcpyAtoH(void* dst, hipArray* srcArray, size_t srcOffset, size_t count);
1656 
1670 hipError_t hipMemcpyHtoA(hipArray* dstArray, size_t dstOffset, const void* srcHost, size_t count);
1671 
1682 hipError_t hipMemcpy3D(const struct hipMemcpy3DParms* p);
1683 
1684 // doxygen end Memory
1716 hipError_t hipDeviceCanAccessPeer(int* canAccessPeer, int deviceId, int peerDeviceId);
1717 
1718 
1735 hipError_t hipDeviceEnablePeerAccess(int peerDeviceId, unsigned int flags);
1736 
1737 
1749 hipError_t hipDeviceDisablePeerAccess(int peerDeviceId);
1750 
1763 hipError_t hipMemGetAddressRange(hipDeviceptr_t* pbase, size_t* psize, hipDeviceptr_t dptr);
1764 
1765 #ifndef USE_PEER_NON_UNIFIED
1766 #define USE_PEER_NON_UNIFIED 1
1767 #endif
1768 
1769 #if USE_PEER_NON_UNIFIED == 1
1770 
1781 hipError_t hipMemcpyPeer(void* dst, int dstDeviceId, const void* src, int srcDeviceId,
1782  size_t sizeBytes);
1783 
1796 hipError_t hipMemcpyPeerAsync(void* dst, int dstDeviceId, const void* src, int srcDevice,
1797  size_t sizeBytes, hipStream_t stream __dparm(0));
1798 #endif
1799 
1800 
1801 // doxygen end PeerToPeer
1820 // TODO-ctx - more description on error codes.
1821 hipError_t hipInit(unsigned int flags);
1822 
1823 
1843 hipError_t hipCtxCreate(hipCtx_t* ctx, unsigned int flags, hipDevice_t device)DEPRECATED(DEPRECATED_MSG);
1844 
1855 hipError_t hipCtxDestroy(hipCtx_t ctx) DEPRECATED(DEPRECATED_MSG);
1856 
1867 hipError_t hipCtxPopCurrent(hipCtx_t* ctx) DEPRECATED(DEPRECATED_MSG);
1868 
1879 hipError_t hipCtxPushCurrent(hipCtx_t ctx) DEPRECATED(DEPRECATED_MSG);
1880 
1891 hipError_t hipCtxSetCurrent(hipCtx_t ctx) DEPRECATED(DEPRECATED_MSG);
1892 
1903 hipError_t hipCtxGetCurrent(hipCtx_t* ctx) DEPRECATED(DEPRECATED_MSG);
1904 
1916 hipError_t hipCtxGetDevice(hipDevice_t* device) DEPRECATED(DEPRECATED_MSG);
1917 
1935 hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int* apiVersion) DEPRECATED(DEPRECATED_MSG);
1936 
1950 hipError_t hipCtxGetCacheConfig(hipFuncCache_t* cacheConfig) DEPRECATED(DEPRECATED_MSG);
1951 
1965 hipError_t hipCtxSetCacheConfig(hipFuncCache_t cacheConfig) DEPRECATED(DEPRECATED_MSG);
1966 
1980 hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config) DEPRECATED(DEPRECATED_MSG);
1981 
1995 hipError_t hipCtxGetSharedMemConfig(hipSharedMemConfig* pConfig) DEPRECATED(DEPRECATED_MSG);
1996 
2008 hipError_t hipCtxSynchronize(void) DEPRECATED(DEPRECATED_MSG);
2009 
2020 hipError_t hipCtxGetFlags(unsigned int* flags) DEPRECATED(DEPRECATED_MSG);
2021 
2041 hipError_t hipCtxEnablePeerAccess(hipCtx_t peerCtx, unsigned int flags) DEPRECATED(DEPRECATED_MSG);
2042 
2059 hipError_t hipCtxDisablePeerAccess(hipCtx_t peerCtx) DEPRECATED(DEPRECATED_MSG);
2060 
2073 hipError_t hipDevicePrimaryCtxGetState(hipDevice_t dev, unsigned int* flags, int* active);
2074 
2087 hipError_t hipDevicePrimaryCtxRelease(hipDevice_t dev);
2088 
2100 hipError_t hipDevicePrimaryCtxRetain(hipCtx_t* pctx, hipDevice_t dev);
2101 
2112 hipError_t hipDevicePrimaryCtxReset(hipDevice_t dev);
2113 
2125 hipError_t hipDevicePrimaryCtxSetFlags(hipDevice_t dev, unsigned int flags);
2126 
2127 // doxygen end Context Management
2139 hipError_t hipDeviceGet(hipDevice_t* device, int ordinal);
2140 
2149 hipError_t hipDeviceComputeCapability(int* major, int* minor, hipDevice_t device);
2150 
2159 hipError_t hipDeviceGetName(char* name, int len, hipDevice_t device);
2160 
2169 hipError_t hipDeviceGetPCIBusId(char* pciBusId, int len, int device);
2170 
2171 
2179 hipError_t hipDeviceGetByPCIBusId(int* device, const char* pciBusId);
2180 
2181 
2189 hipError_t hipDeviceTotalMem(size_t* bytes, hipDevice_t device);
2190 
2206 hipError_t hipDriverGetVersion(int* driverVersion);
2207 
2220 hipError_t hipRuntimeGetVersion(int* runtimeVersion);
2221 
2233 hipError_t hipModuleLoad(hipModule_t* module, const char* fname);
2234 
2245 hipError_t hipModuleUnload(hipModule_t module);
2246 
2257 hipError_t hipModuleGetFunction(hipFunction_t* function, hipModule_t module, const char* kname);
2258 
2268 hipError_t hipFuncGetAttributes(hipFuncAttributes* attr, const void* func);
2269 
2281 hipError_t hipModuleGetGlobal(hipDeviceptr_t* dptr, size_t* bytes, hipModule_t hmod,
2282  const char* name);
2283 
2284 hipError_t hipModuleGetTexRef(textureReference** texRef, hipModule_t hmod, const char* name);
2294 hipError_t hipModuleLoadData(hipModule_t* module, const void* image);
2295 
2308 hipError_t hipModuleLoadDataEx(hipModule_t* module, const void* image, unsigned int numOptions,
2309  hipJitOption* options, void** optionValues);
2310 
2335 hipError_t hipModuleLaunchKernel(hipFunction_t f, unsigned int gridDimX, unsigned int gridDimY,
2336  unsigned int gridDimZ, unsigned int blockDimX,
2337  unsigned int blockDimY, unsigned int blockDimZ,
2338  unsigned int sharedMemBytes, hipStream_t stream,
2339  void** kernelParams, void** extra);
2340 
2341 // doxygen end Version Management
2359 // TODO - expand descriptions:
2365 hipError_t hipProfilerStart();
2366 
2367 
2373 hipError_t hipProfilerStop();
2374 
2375 
2380 // TODO: implement IPC apis
2381 
2407 hipError_t hipIpcGetMemHandle(hipIpcMemHandle_t* handle, void* devPtr);
2408 
2445 hipError_t hipIpcOpenMemHandle(void** devPtr, hipIpcMemHandle_t handle, unsigned int flags);
2446 
2465 hipError_t hipIpcCloseMemHandle(void* devPtr);
2466 
2467 
2468 // hipError_t hipIpcGetMemHandle(hipIpcMemHandle_t* handle, void* devPtr);
2469 // hipError_t hipIpcCloseMemHandle(void *devPtr);
2470 // // hipError_t hipIpcOpenEventHandle(hipEvent_t* event, hipIpcEventHandle_t handle);
2471 // hipError_t hipIpcOpenMemHandle(void** devPtr, hipIpcMemHandle_t handle, unsigned int flags);
2472 
2473 
2494 hipError_t hipConfigureCall(dim3 gridDim, dim3 blockDim, size_t sharedMem, hipStream_t stream);
2495 
2496 
2507 hipError_t hipSetupArgument(const void* arg, size_t size, size_t offset);
2508 
2509 
2518 hipError_t hipLaunchByPtr(const void* func);
2519 
2520 
2521 
2527 #ifdef __cplusplus
2528 } /* extern "c" */
2529 #endif
2530 
2531 #ifdef __cplusplus
2532 
2533 hipError_t hipBindTexture(size_t* offset, textureReference* tex, const void* devPtr,
2534  const hipChannelFormatDesc* desc, size_t size = UINT_MAX);
2535 
2536 hipError_t ihipBindTextureImpl(int dim, enum hipTextureReadMode readMode, size_t* offset,
2537  const void* devPtr, const struct hipChannelFormatDesc* desc,
2538  size_t size, textureReference* tex);
2539 
2540 /*
2541  * @brief hipBindTexture Binds size bytes of the memory area pointed to by @p devPtr to the texture
2542  *reference tex.
2543  *
2544  * @p desc describes how the memory is interpreted when fetching values from the texture. The @p
2545  *offset parameter is an optional byte offset as with the low-level hipBindTexture() function. Any
2546  *memory previously bound to tex is unbound.
2547  *
2548  * @param[in] offset - Offset in bytes
2549  * @param[out] tex - texture to bind
2550  * @param[in] devPtr - Memory area on device
2551  * @param[in] desc - Channel format
2552  * @param[in] size - Size of the memory area pointed to by devPtr
2553  * @return #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryFree, #hipErrorUnknown
2554  **/
2555 template <class T, int dim, enum hipTextureReadMode readMode>
2556 hipError_t hipBindTexture(size_t* offset, struct texture<T, dim, readMode>& tex, const void* devPtr,
2557  const struct hipChannelFormatDesc& desc, size_t size = UINT_MAX) {
2558  return ihipBindTextureImpl(dim, readMode, offset, devPtr, &desc, size, &tex);
2559 }
2560 
2561 /*
2562  * @brief hipBindTexture Binds size bytes of the memory area pointed to by @p devPtr to the texture
2563  *reference tex.
2564  *
2565  * @p desc describes how the memory is interpreted when fetching values from the texture. The @p
2566  *offset parameter is an optional byte offset as with the low-level hipBindTexture() function. Any
2567  *memory previously bound to tex is unbound.
2568  *
2569  * @param[in] offset - Offset in bytes
2570  * @param[in] tex - texture to bind
2571  * @param[in] devPtr - Memory area on device
2572  * @param[in] size - Size of the memory area pointed to by devPtr
2573  * @return #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryFree, #hipErrorUnknown
2574  **/
2575 template <class T, int dim, enum hipTextureReadMode readMode>
2576 hipError_t hipBindTexture(size_t* offset, struct texture<T, dim, readMode>& tex, const void* devPtr,
2577  size_t size = UINT_MAX) {
2578  return ihipBindTextureImpl(dim, readMode, offset, devPtr, &(tex.channelDesc), size, &tex);
2579 }
2580 
2581 // C API
2582 hipError_t hipBindTexture2D(size_t* offset, textureReference* tex, const void* devPtr,
2583  const hipChannelFormatDesc* desc, size_t width, size_t height,
2584  size_t pitch);
2585 
2586 hipError_t ihipBindTexture2DImpl(int dim, enum hipTextureReadMode readMode, size_t* offset,
2587  const void* devPtr, const struct hipChannelFormatDesc* desc,
2588  size_t width, size_t height, textureReference* tex);
2589 
2590 template <class T, int dim, enum hipTextureReadMode readMode>
2591 hipError_t hipBindTexture2D(size_t* offset, struct texture<T, dim, readMode>& tex,
2592  const void* devPtr, size_t width, size_t height, size_t pitch) {
2593  return ihipBindTexture2DImpl(dim, readMode, offset, devPtr, &(tex.channelDesc), width, height,
2594  &tex);
2595 }
2596 
2597 template <class T, int dim, enum hipTextureReadMode readMode>
2598 hipError_t hipBindTexture2D(size_t* offset, struct texture<T, dim, readMode>& tex,
2599  const void* devPtr, const struct hipChannelFormatDesc& desc,
2600  size_t width, size_t height, size_t pitch) {
2601  return ihipBindTexture2DImpl(dim, readMode, offset, devPtr, &desc, width, height, &tex);
2602 }
2603 
2604 // C API
2605 hipError_t hipBindTextureToArray(textureReference* tex, hipArray_const_t array,
2606  const hipChannelFormatDesc* desc);
2607 
2608 hipError_t ihipBindTextureToArrayImpl(int dim, enum hipTextureReadMode readMode,
2609  hipArray_const_t array,
2610  const struct hipChannelFormatDesc& desc,
2611  textureReference* tex);
2612 
2613 template <class T, int dim, enum hipTextureReadMode readMode>
2614 hipError_t hipBindTextureToArray(struct texture<T, dim, readMode>& tex, hipArray_const_t array) {
2615  return ihipBindTextureToArrayImpl(dim, readMode, array, tex.channelDesc, &tex);
2616 }
2617 
2618 template <class T, int dim, enum hipTextureReadMode readMode>
2619 hipError_t hipBindTextureToArray(struct texture<T, dim, readMode>& tex, hipArray_const_t array,
2620  const struct hipChannelFormatDesc& desc) {
2621  return ihipBindTextureToArrayImpl(dim, readMode, array, desc, &tex);
2622 }
2623 
2624 template <class T, int dim, enum hipTextureReadMode readMode>
2625 inline static hipError_t hipBindTextureToArray(struct texture<T, dim, readMode> *tex,
2626  hipArray_const_t array,
2627  const struct hipChannelFormatDesc* desc) {
2628  return ihipBindTextureToArrayImpl(dim, readMode, array, *desc, tex);
2629 }
2630 
2631 // C API
2632 hipError_t hipBindTextureToMipmappedArray(const textureReference* tex,
2633  hipMipmappedArray_const_t mipmappedArray,
2634  const hipChannelFormatDesc* desc);
2635 
2636 template <class T, int dim, enum hipTextureReadMode readMode>
2637 hipError_t hipBindTextureToMipmappedArray(const texture<T, dim, readMode>& tex,
2638  hipMipmappedArray_const_t mipmappedArray) {
2639  return hipSuccess;
2640 }
2641 
2642 template <class T, int dim, enum hipTextureReadMode readMode>
2643 hipError_t hipBindTextureToMipmappedArray(const texture<T, dim, readMode>& tex,
2644  hipMipmappedArray_const_t mipmappedArray,
2645  const hipChannelFormatDesc& desc) {
2646  return hipSuccess;
2647 }
2648 
2649 /*
2650  * @brief Unbinds the textuer bound to @p tex
2651  *
2652  * @param[in] tex - texture to unbind
2653  *
2654  * @return #hipSuccess
2655  **/
2656 hipError_t hipUnbindTexture(const textureReference* tex);
2657 
2658 extern hipError_t ihipUnbindTextureImpl(const hipTextureObject_t& textureObject);
2659 
2660 template <class T, int dim, enum hipTextureReadMode readMode>
2661 hipError_t hipUnbindTexture(struct texture<T, dim, readMode>& tex) {
2662  return ihipUnbindTextureImpl(tex.textureObject);
2663 }
2664 
2665 hipError_t hipGetChannelDesc(hipChannelFormatDesc* desc, hipArray_const_t array);
2666 hipError_t hipGetTextureAlignmentOffset(size_t* offset, const textureReference* texref);
2667 hipError_t hipGetTextureReference(const textureReference** texref, const void* symbol);
2668 
2669 hipError_t hipCreateTextureObject(hipTextureObject_t* pTexObject, const hipResourceDesc* pResDesc,
2670  const hipTextureDesc* pTexDesc,
2671  const hipResourceViewDesc* pResViewDesc);
2672 
2673 hipError_t hipDestroyTextureObject(hipTextureObject_t textureObject);
2674 
2675 hipError_t hipGetTextureObjectResourceDesc(hipResourceDesc* pResDesc,
2676  hipTextureObject_t textureObject);
2677 hipError_t hipGetTextureObjectResourceViewDesc(hipResourceViewDesc* pResViewDesc,
2678  hipTextureObject_t textureObject);
2679 hipError_t hipGetTextureObjectTextureDesc(hipTextureDesc* pTexDesc,
2680  hipTextureObject_t textureObject);
2681 hipError_t hipTexRefSetArray(textureReference* tex, hipArray_const_t array, unsigned int flags);
2682 
2683 hipError_t hipTexRefSetAddressMode(textureReference* tex, int dim, hipTextureAddressMode am);
2684 
2685 hipError_t hipTexRefSetFilterMode(textureReference* tex, hipTextureFilterMode fm);
2686 
2687 hipError_t hipTexRefSetFlags(textureReference* tex, unsigned int flags);
2688 
2689 hipError_t hipTexRefSetFormat(textureReference* tex, hipArray_Format fmt, int NumPackedComponents);
2690 
2691 hipError_t hipTexRefSetAddress(size_t* offset, textureReference* tex, hipDeviceptr_t devPtr,
2692  size_t size);
2693 
2694 hipError_t hipTexRefSetAddress2D(textureReference* tex, const HIP_ARRAY_DESCRIPTOR* desc,
2695  hipDeviceptr_t devPtr, size_t pitch);
2696 
2697 hipError_t hipCreateSurfaceObject(hipSurfaceObject_t* pSurfObject, const hipResourceDesc* pResDesc);
2698 
2699 hipError_t hipDestroySurfaceObject(hipSurfaceObject_t surfaceObject);
2700 
2701 // doxygen end Texture
2707 #endif
2708 
2709 
2727 // end-group HCC_Specific
2733 // doxygen end HIP API
2738 #endif
hipError_t hipHostFree(void *ptr)
Free memory allocated by the hcc hip host memory allocation API This API performs an implicit hipDevi...
Definition: hip_memory.cpp:1923
hipError_t hipCtxSetSharedMemConfig(hipSharedMemConfig config) DEPRECATED(DEPRECATED_MSG)
Set Shared memory bank configuration.
Definition: hip_context.cpp:236
prefer larger L1 cache and smaller shared memory
Definition: hip_runtime_api.h:219
hipError_t hipModuleGetFunction(hipFunction_t *function, hipModule_t module, const char *kname)
Function with kname will be extracted if present in module.
Definition: hip_module.cpp:457
hipError_t hipMemset3D(hipPitchedPtr pitchedDevPtr, int value, hipExtent extent)
Fills synchronously the memory area pointed to by pitchedDevPtr with the constant value...
Definition: hip_memory.cpp:1796
hipError_t hipDeviceGetCacheConfig(hipFuncCache_t *cacheConfig)
Set Cache configuration for a specific function.
Definition: hip_device.cpp:84
hipError_t hipCtxGetDevice(hipDevice_t *device) DEPRECATED(DEPRECATED_MSG)
Get the handle of the device associated with current/default context.
Definition: hip_context.cpp:194
hipError_t hipDriverGetVersion(int *driverVersion)
Returns the approximate HIP driver version.
Definition: hip_context.cpp:88
hipError_t hipPeekAtLastError(void)
Return last error returned by any HIP runtime API call.
Definition: hip_error.cpp:41
hipError_t hipCtxGetCurrent(hipCtx_t *ctx) DEPRECATED(DEPRECATED_MSG)
Get the handle of the current/ default context.
Definition: hip_context.cpp:170
hipError_t hipDevicePrimaryCtxSetFlags(hipDevice_t dev, unsigned int flags)
Set flags for the primary context.
Definition: hip_context.cpp:324
hipError_t hipDevicePrimaryCtxRetain(hipCtx_t *pctx, hipDevice_t dev)
Retain the primary context on the GPU.
Definition: hip_context.cpp:299
struct dim3 dim3
hipError_t hipDeviceComputeCapability(int *major, int *minor, hipDevice_t device)
Returns the compute capability of the device.
Definition: hip_device.cpp:369
hipError_t hipDeviceGetByPCIBusId(int *device, const char *pciBusId)
Returns a handle to a compute device.
Definition: hip_device.cpp:427
hipError_t hipCtxDisablePeerAccess(hipCtx_t peerCtx) DEPRECATED(DEPRECATED_MSG)
Disable direct access from current context&#39;s virtual address space to memory allocations physically l...
Definition: hip_peer.cpp:218
hipError_t hipMemGetAddressRange(hipDeviceptr_t *pbase, size_t *psize, hipDeviceptr_t dptr)
Get information on memory allocations.
Definition: hip_memory.cpp:1986
TODO-doc.
hipError_t hipMemcpyToArray(hipArray *dst, size_t wOffset, size_t hOffset, const void *src, size_t count, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:1315
unsigned long long hipSurfaceObject_t
Definition: hip_surface_types.h:36
hipError_t hipCtxSetCurrent(hipCtx_t ctx) DEPRECATED(DEPRECATED_MSG)
Set the passed context as current/default.
Definition: hip_context.cpp:181
hipError_t hipModuleLoadDataEx(hipModule_t *module, const void *image, unsigned int numOptions, hipJitOption *options, void **optionValues)
builds module from code object which resides in host memory. Image is pointer to that location...
Definition: hip_module.cpp:574
Definition: driver_types.h:232
hipError_t hipMallocPitch(void **ptr, size_t *pitch, size_t width, size_t height)
Definition: hip_memory.cpp:397
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 __dparm(0))
Copies data between host and device.
hipError_t hipMemcpy2D(void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:1656
hipError_t hipStreamAddCallback(hipStream_t stream, hipStreamCallback_t callback, void *userData, unsigned int flags)
Adds a callback to be called on the host after all currently enqueued items in the stream have comple...
Definition: hip_stream.cpp:195
hipError_t hipMemcpyFromArray(void *dst, hipArray_const_t srcArray, size_t wOffset, size_t hOffset, size_t count, hipMemcpyKind kind)
Copies data between host and device.
Definition: hip_memory.cpp:1334
uint32_t x
x
Definition: hip_runtime_api.h:241
hipError_t hipMemcpyAtoH(void *dst, hipArray *srcArray, size_t srcOffset, size_t count)
Copies data between host and device.
Definition: hip_memory.cpp:1371
hipError_t hipDeviceEnablePeerAccess(int peerDeviceId, unsigned int flags)
Enable direct access from current device&#39;s virtual address space to memory allocations physically loc...
Definition: hip_peer.cpp:191
const char * hipGetErrorString(hipError_t hipError)
Return handy text string message to explain the error which occurred.
Definition: hip_error.cpp:54
hipError_t hipDeviceGetSharedMemConfig(hipSharedMemConfig *pConfig)
Returns bank width of shared memory for current device.
Definition: hip_device.cpp:125
Definition: hip_runtime_api.h:137
hipError_t hipCtxEnablePeerAccess(hipCtx_t peerCtx, unsigned int flags) DEPRECATED(DEPRECATED_MSG)
Enables direct access to memory allocations in a peer context.
Definition: hip_peer.cpp:212
prefer equal size L1 cache and shared memory
Definition: hip_runtime_api.h:220
hipError_t hipHostGetDevicePointer(void **devPtr, void *hstPtr, unsigned int flags)
Get Device pointer from Host Pointer allocated through hipHostMalloc.
hipError_t hipFreeArray(hipArray *array)
Frees an array on the device.
Definition: hip_memory.cpp:1958
hipError_t hipCtxGetCacheConfig(hipFuncCache_t *cacheConfig) DEPRECATED(DEPRECATED_MSG)
Set Cache configuration for a specific function.
Definition: hip_context.cpp:220
hipError_t hipMemsetAsync(void *dst, int value, size_t sizeBytes, hipStream_t stream __dparm(0))
Fills the first sizeBytes bytes of the memory area pointed to by dev with the constant byte value val...
hipError_t hipEventSynchronize(hipEvent_t event)
Wait for an event to complete.
Definition: hip_event.cpp:167
Definition: driver_types.h:173
hipError_t hipMemcpyHtoD(hipDeviceptr_t dst, void *src, size_t sizeBytes)
Copy data from Host to Device.
Definition: hip_memory.cpp:1160
hipError_t hipModuleUnload(hipModule_t module)
Frees the module.
Definition: hip_module.cpp:98
Definition: hip_module.cpp:74
hipError_t hipSetDeviceFlags(unsigned flags)
The current device behavior is changed according the flags passed.
hipError_t hipEventQuery(hipEvent_t event)
Query event status.
Definition: hip_event.cpp:257
hipError_t hipCtxGetApiVersion(hipCtx_t ctx, int *apiVersion) DEPRECATED(DEPRECATED_MSG)
Returns the approximate HIP api version.
Definition: hip_context.cpp:210
hipError_t hipDeviceDisablePeerAccess(int peerDeviceId)
Disable direct access from current device&#39;s virtual address space to memory allocations physically lo...
Definition: hip_peer.cpp:184
#define hipArrayDefault
Default HIP array allocation flag.
Definition: hip_runtime_api.h:180
hipError_t hipMallocArray(hipArray **array, const hipChannelFormatDesc *desc, size_t width, size_t height __dparm(0), unsigned int flags __dparm(hipArrayDefault))
Allocate an array on the device.
hipError_t hipMallocHost(void **ptr, size_t size) __attribute__((deprecated("use hipHostMalloc instead")))
Allocate pinned host memory [Deprecated].
Definition: hip_memory.cpp:332
hipError_t hipIpcGetMemHandle(hipIpcMemHandle_t *handle, void *devPtr)
Gets an interprocess memory handle for an existing device memory allocation.
Definition: hip_memory.cpp:2007
Definition: hip_runtime_api.h:97
hipError_t hipMemset2DAsync(void *dst, size_t pitch, int value, size_t width, size_t height, hipStream_t stream __dparm(0))
Fills asynchronously the memory area pointed to by dst with the constant value.
Definition: driver_types.h:107
hipError_t hipHostMalloc(void **ptr, size_t size, unsigned int flags)
Allocate device accessible page locked host memory.
Definition: hip_memory.cpp:265
Definition: hip_hcc_internal.h:880
Definition: texture_types.h:73
hipError_t hipDeviceGetLimit(size_t *pValue, enum hipLimit_t limit)
Get Resource limits of current device.
Definition: hip_device.cpp:96
hipError_t hipCtxCreate(hipCtx_t *ctx, unsigned int flags, hipDevice_t device) DEPRECATED(DEPRECATED_MSG)
Create a context and set it as current/ default context.
Definition: hip_context.cpp:55
hipError_t hipModuleLoadData(hipModule_t *module, const void *image)
builds module from code object which resides in host memory. Image is pointer to that location...
Definition: hip_module.cpp:555
Definition: driver_types.h:70
hipDeviceAttribute_t
Definition: hip_runtime_api.h:259
hipError_t hipEventDestroy(hipEvent_t event)
Destroy the specified event.
Definition: hip_event.cpp:155
hipError_t hipStreamCreateWithFlags(hipStream_t *stream, unsigned int flags)
Create an asynchronous stream.
Definition: hip_stream.cpp:73
hipError_t hipChooseDevice(int *device, const hipDeviceProp_t *prop)
Device which matches hipDeviceProp_t is returned.
Definition: hip_device.cpp:453
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)
launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelp...
Definition: hip_runtime_api.h:240
uint32_t y
y
Definition: hip_runtime_api.h:242
void(* hipStreamCallback_t)(hipStream_t stream, hipError_t status, void *userData)
Definition: hip_runtime_api.h:738
hipError_t hipModuleLoad(hipModule_t *module, const char *fname)
Loads code object from file into a hipModule_t.
Definition: hip_module.cpp:560
hipError_t hipDevicePrimaryCtxReset(hipDevice_t dev)
Resets the primary context on the GPU.
Definition: hip_context.cpp:311
hipError_t hipEventCreateWithFlags(hipEvent_t *event, unsigned flags)
Create an event with the specified flags.
Definition: hip_event.cpp:97
hipError_t hipEventElapsedTime(float *ms, hipEvent_t start, hipEvent_t stop)
Return the elapsed time between two events.
Definition: hip_event.cpp:200
hipError_t hipDeviceSetCacheConfig(hipFuncCache_t cacheConfig)
Set L1/Shared cache partition.
Definition: hip_device.cpp:76
hipError_t hipDeviceCanAccessPeer(int *canAccessPeer, int deviceId, int peerDeviceId)
Determine if a device can access a peer&#39;s memory.
Definition: hip_peer.cpp:177
hipError_t hipGetDeviceCount(int *count)
Return number of compute-capable devices.
Definition: hip_device.cpp:71
hipError_t hipMemset(void *dst, int value, size_t sizeBytes)
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value va...
Definition: hip_memory.cpp:1728
Definition: driver_types.h:245
hipError_t hipStreamDestroy(hipStream_t stream)
Destroys the specified stream.
Definition: hip_stream.cpp:152
hipError_t hipHostGetFlags(unsigned int *flagsPtr, void *hostPtr)
Return flags associated with host pointer.
Definition: hip_memory.cpp:878
hipError_t hipStreamSynchronize(hipStream_t stream)
Wait for all commands in stream to complete.
Definition: hip_stream.cpp:141
hipError_t hipIpcOpenMemHandle(void **devPtr, hipIpcMemHandle_t handle, unsigned int flags)
Opens an interprocess memory handle exported from another process and returns a device pointer usable...
Definition: hip_memory.cpp:2043
hipError_t hipMemcpyToSymbol(const void *symbolName, const void *src, size_t sizeBytes, size_t offset __dparm(0), hipMemcpyKind kind __dparm(hipMemcpyHostToDevice))
Copies sizeBytes bytes from the memory area pointed to by src to the memory area pointed to by offset...
hipError_t hipMemcpyDtoD(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes)
Copy data from Device to Device.
Definition: hip_memory.cpp:1198
hipError_t hipMemset3DAsync(hipPitchedPtr pitchedDevPtr, int value, hipExtent extent, hipStream_t stream __dparm(0))
Fills asynchronously the memory area pointed to by pitchedDevPtr with the constant value...
Definition: hip_runtime_api.h:229
no preference for shared memory or L1 (default)
Definition: hip_runtime_api.h:217
hipError_t hipCtxPushCurrent(hipCtx_t ctx) DEPRECATED(DEPRECATED_MSG)
Push the context to be set as current/ default context.
Definition: hip_context.cpp:157
hipError_t hipCtxSynchronize(void) DEPRECATED(DEPRECATED_MSG)
Blocks until the default context has completed all preceding requested tasks.
Definition: hip_context.cpp:252
hipError_t hipMalloc3DArray(hipArray **array, const struct hipChannelFormatDesc *desc, struct hipExtent extent, unsigned int flags)
Allocate an array on the device.
Definition: hip_memory.cpp:773
hipError_t hipMemcpyDtoHAsync(void *dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream)
Copy data from Device to Host asynchronously.
Definition: hip_memory.cpp:1256
hipError_t hipDeviceSynchronize(void)
Waits on all active streams on current device.
Definition: hip_device.cpp:144
hipError_t hipMemcpyDtoH(void *dst, hipDeviceptr_t src, size_t sizeBytes)
Copy data from Device to Host.
Definition: hip_memory.cpp:1179
Defines the different newt vector types for HIP runtime.
hipError_t hipMemcpyAsync(void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind, hipStream_t stream __dparm(0))
Copy data from src to dst asynchronously.
hipError_t hipDeviceGetName(char *name, int len, hipDevice_t device)
Returns an identifer string for the device.
Definition: hip_device.cpp:381
hipError_t hipGetDeviceProperties(hipDeviceProp_t *prop, int deviceId)
Returns device properties.
Definition: hip_device.cpp:316
hipError_t hipHostRegister(void *hostPtr, size_t sizeBytes, unsigned int flags)
Register host memory so it can be accessed from the current device.
Definition: hip_memory.cpp:906
Definition: driver_types.h:61
hipError_t hipMalloc(void **ptr, size_t size)
Allocate memory on the default accelerator.
Definition: hip_memory.cpp:236
const char * hipGetErrorName(hipError_t hip_error)
Return name of the specified error code in text form.
Definition: hip_error.cpp:48
hipError_t hipMemset2D(void *dst, size_t pitch, int value, size_t width, size_t height)
Fills the memory area pointed to by dst with the constant value.
Definition: hip_memory.cpp:1744
Definition: driver_types.h:225
hipFuncCache_t
Definition: hip_runtime_api.h:216
hipError_t hipGetLastError(void)
Return last error returned by any HIP runtime API call and resets the stored error code to #hipSucces...
Definition: hip_error.cpp:32
hipError_t hipStreamWaitEvent(hipStream_t stream, hipEvent_t event, unsigned int flags)
Make the specified compute stream wait for an event.
Definition: hip_stream.cpp:87
hipError_t hipStreamGetFlags(hipStream_t stream, unsigned int *flags)
Return flags associated with this stream.
Definition: hip_stream.cpp:180
hipError_t hipHostAlloc(void **ptr, size_t size, unsigned int flags) __attribute__((deprecated("use hipHostMalloc instead")))
Allocate device accessible page locked host memory [Deprecated].
Definition: hip_memory.cpp:336
Defines surface types for HIP runtime.
hipError_t hipCtxPopCurrent(hipCtx_t *ctx) DEPRECATED(DEPRECATED_MSG)
Pop the current/default context and return the popped context.
Definition: hip_context.cpp:136
hipError_t hipMemGetInfo(size_t *free, size_t *total)
Query memory info. Return snapshot of free memory, and total allocatable memory on the device...
Definition: hip_memory.cpp:1832
hipError_t hipDevicePrimaryCtxRelease(hipDevice_t dev)
Release the primary context on the GPU.
Definition: hip_context.cpp:288
hipError_t hipFree(void *ptr)
Free memory allocated by the hcc hip memory allocation API. This API performs an implicit hipDeviceSy...
Definition: hip_memory.cpp:1891
uint32_t z
z
Definition: hip_runtime_api.h:243
hipError_t hipDeviceReset(void)
The state of current device is discarded and updated to a fresh state.
Definition: hip_device.cpp:149
hipError_t hipInit(unsigned int flags)
Explicitly initializes the HIP runtime.
Definition: hip_context.cpp:42
hipError_t hipMemcpy3D(const struct hipMemcpy3DParms *p)
Copies data between host and device.
Definition: hip_memory.cpp:1390
hipError_t hipRuntimeGetVersion(int *runtimeVersion)
Returns the approximate HIP Runtime version.
Definition: hip_context.cpp:100
hipError_t hipFuncGetAttributes(hipFuncAttributes *attr, const void *func)
Definition: hip_module.cpp:507
hipError_t hipMemcpyHtoA(hipArray *dstArray, size_t dstOffset, const void *srcHost, size_t count)
Copies data between host and device.
Definition: hip_memory.cpp:1353
hipError_t hipSetupArgument(const void *arg, size_t size, size_t offset)
Set a kernel argument.
Definition: hip_clang.cpp:176
hipError_t hipMemcpyDtoDAsync(hipDeviceptr_t dst, hipDeviceptr_t src, size_t sizeBytes, hipStream_t stream)
Copy data from Device to Device asynchronously.
Definition: hip_memory.cpp:1248
Definition: hip_runtime_api.h:83
hipError_t hipSetDevice(int deviceId)
Set default device to be used for subsequent hip API calls from this thread.
Definition: hip_device.cpp:133
hipError_t hipDeviceGet(hipDevice_t *device, int ordinal)
Returns a handle to a compute device.
Definition: hip_context.cpp:73
hipError_t hipDeviceTotalMem(size_t *bytes, hipDevice_t device)
Returns the total amount of memory on the device.
Definition: hip_device.cpp:415
hipError_t hipFuncSetCacheConfig(const void *func, hipFuncCache_t config)
Set Cache configuration for a specific function.
Definition: hip_device.cpp:109
The compiler selects a device-specific value for the banking.
Definition: hip_runtime_api.h:228
hipError_t hipMemcpyPeerAsync(void *dst, int dstDeviceId, const void *src, int srcDevice, size_t sizeBytes, hipStream_t stream __dparm(0))
Copies memory from one device to memory on another device.
hipSharedMemConfig
Definition: hip_runtime_api.h:227
Definition: driver_types.h:38
Definition: hip_hcc_internal.h:700
hipError_t hipDeviceGetAttribute(int *pi, hipDeviceAttribute_t attr, int deviceId)
Query for a specific device attribute.
Definition: hip_device.cpp:289
hipError_t hipMemcpyHtoDAsync(hipDeviceptr_t dst, void *src, size_t sizeBytes, hipStream_t stream)
Copy data from Host to Device asynchronously.
Definition: hip_memory.cpp:1241
hipError_t hipCtxSetCacheConfig(hipFuncCache_t cacheConfig) DEPRECATED(DEPRECATED_MSG)
Set L1/Shared cache partition.
Definition: hip_context.cpp:228
hipError_t hipCtxGetFlags(unsigned int *flags) DEPRECATED(DEPRECATED_MSG)
Return flags used for creating default context.
Definition: hip_context.cpp:257
hipError_t hipHostUnregister(void *hostPtr)
Un-register host pointer.
Definition: hip_memory.cpp:963
Definition: hip_hcc_internal.h:518
hipError_t hipMemcpyPeer(void *dst, int dstDeviceId, const void *src, int srcDeviceId, size_t sizeBytes)
Copies memory from one device to memory on another device.
Definition: hip_peer.cpp:198
hipError_t hipStreamCreate(hipStream_t *stream)
Create an asynchronous stream.
Definition: hip_stream.cpp:80
hipError_t hipMemcpy(void *dst, const void *src, size_t sizeBytes, hipMemcpyKind kind)
Copy data from src to dst.
Definition: hip_memory.cpp:1133
hipError_t hipEventCreate(hipEvent_t *event)
Definition: hip_event.cpp:103
Definition: driver_types.h:82
Definition: hip_runtime_api.h:82
hipError_t hipFreeHost(void *ptr) __attribute__((deprecated("use hipHostFree instead")))
Free memory allocated by the hcc hip host memory allocation API. [Deprecated].
Definition: hip_memory.cpp:1956
hipError_t hipDevicePrimaryCtxGetState(hipDevice_t dev, unsigned int *flags, int *active)
Get the state of the primary context.
Definition: hip_context.cpp:266
Definition: driver_types.h:201
hipError_t hipDeviceSetSharedMemConfig(hipSharedMemConfig config)
The bank width of shared memory on current device is set.
Definition: hip_device.cpp:117
hipError_t hipGetDevice(int *deviceId)
Return the default device id for the calling host thread.
Definition: hip_device.cpp:32
hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream)
Record an event in the specified stream.
Definition: hip_event.cpp:110
hipError_t hipModuleGetGlobal(hipDeviceptr_t *dptr, size_t *bytes, hipModule_t hmod, const char *name)
returns device memory pointer and size of the kernel present in the module with symbol name ...
Definition: hip_module.cpp:462
Definition: hip_hcc_internal.h:367
hipError_t hipDeviceGetPCIBusId(char *pciBusId, int len, int device)
Returns a PCI Bus Id string for the device, overloaded to take int device ID.
Definition: hip_device.cpp:395
prefer larger shared memory and smaller L1 cache
Definition: hip_runtime_api.h:218
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)
Copies data between host and device.
Definition: hip_memory.cpp:1263
hipError_t hipStreamQuery(hipStream_t stream)
Return #hipSuccess if all of the operations in the specified stream have completed, or #hipErrorNotReady if not.
Definition: hip_stream.cpp:118
Definition: hip_runtime_api.h:231
hipError_t hipIpcCloseMemHandle(void *devPtr)
Close memory mapped with hipIpcOpenMemHandle.
Definition: hip_memory.cpp:2073
hipError_t hipMemsetD8(hipDeviceptr_t dest, unsigned char value, size_t sizeBytes)
Fills the first sizeBytes bytes of the memory area pointed to by dest with the constant byte value va...
Definition: hip_memory.cpp:1780
hipError_t hipCtxGetSharedMemConfig(hipSharedMemConfig *pConfig) DEPRECATED(DEPRECATED_MSG)
Get Shared memory bank configuration.
Definition: hip_context.cpp:244
hipError_t hipPointerGetAttributes(hipPointerAttribute_t *attributes, const void *ptr)
Return attributes for the specified pointer.
Definition: hip_memory.cpp:158
hipError_t hipConfigureCall(dim3 gridDim, dim3 blockDim, size_t sharedMem, hipStream_t stream)
Configure a kernel launch.
Definition: hip_clang.cpp:163
hipError_t hipMemcpyToSymbolAsync(const void *symbolName, const void *src, size_t sizeBytes, size_t offset, hipMemcpyKind kind, hipStream_t stream __dparm(0))
Copies sizeBytes bytes from the memory area pointed to by src to the memory area pointed to by offset...
hipError_t hipCtxDestroy(hipCtx_t ctx) DEPRECATED(DEPRECATED_MSG)
Destroy a HIP context.
Definition: hip_context.cpp:112
hipError_t hipProfilerStop()
Stop recording of profiling information. When using this API, start the profiler with profiling disab...
Definition: hip_hcc.cpp:2409
hipError_t hipProfilerStart()
Start recording of profiling information When using this API, start the profiler with profiling disab...
Definition: hip_hcc.cpp:2399
hipError_t hipLaunchByPtr(const void *func)
Launch a kernel.
Definition: hip_clang.cpp:193
Definition: texture_types.h:93