/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.5.0/include/hip/hip_ext.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.5.0/include/hip/hip_ext.h Source File#

HIP Runtime API Reference: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.5.0/include/hip/hip_ext.h Source File
hip_ext.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2015 - 2021 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 #ifndef HIP_INCLUDE_HIP_HIP_EXT_H
24 #define HIP_INCLUDE_HIP_HIP_EXT_H
25 #include "hip/hip_runtime.h"
26 #if defined(__cplusplus)
27 #include <tuple>
28 #include <type_traits>
29 #endif
67 HIP_PUBLIC_API
68 hipError_t hipExtModuleLaunchKernel(hipFunction_t f, uint32_t globalWorkSizeX,
69  uint32_t globalWorkSizeY, uint32_t globalWorkSizeZ,
70  uint32_t localWorkSizeX, uint32_t localWorkSizeY,
71  uint32_t localWorkSizeZ, size_t sharedMemBytes,
72  hipStream_t hStream, void** kernelParams, void** extra,
73  hipEvent_t startEvent = nullptr,
74  hipEvent_t stopEvent = nullptr,
75  uint32_t flags = 0);
80 HIP_PUBLIC_API
81 hipError_t hipHccModuleLaunchKernel(hipFunction_t f, uint32_t globalWorkSizeX,
82  uint32_t globalWorkSizeY, uint32_t globalWorkSizeZ,
83  uint32_t localWorkSizeX, uint32_t localWorkSizeY,
84  uint32_t localWorkSizeZ, size_t sharedMemBytes,
85  hipStream_t hStream, void** kernelParams, void** extra,
86  hipEvent_t startEvent = nullptr,
87  hipEvent_t stopEvent = nullptr)
88  __attribute__((deprecated("use hipExtModuleLaunchKernel instead")));
89 
90 #if defined(__cplusplus)
91 
112 extern "C" hipError_t hipExtLaunchKernel(const void* function_address, dim3 numBlocks,
113  dim3 dimBlocks, void** args, size_t sharedMemBytes,
114  hipStream_t stream, hipEvent_t startEvent,
115  hipEvent_t stopEvent, int flags);
116 
138 template <typename... Args, typename F = void (*)(Args...)>
139 inline void hipExtLaunchKernelGGL(F kernel, const dim3& numBlocks, const dim3& dimBlocks,
140  std::uint32_t sharedMemBytes, hipStream_t stream,
141  hipEvent_t startEvent, hipEvent_t stopEvent, std::uint32_t flags,
142  Args... args) {
143  constexpr size_t count = sizeof...(Args);
144  auto tup_ = std::tuple<Args...>{args...};
145  auto tup = validateArgsCountType(kernel, tup_);
146  void* _Args[count];
147  pArgs<0>(tup, _Args);
148 
149  auto k = reinterpret_cast<void*>(kernel);
150  hipExtLaunchKernel(k, numBlocks, dimBlocks, _Args, sharedMemBytes, stream, startEvent,
151  stopEvent, (int)flags);
152 }
153 
154 #endif // defined(__cplusplus)
155 
156 // doxygen end AMD-specific features
160 #endif // #iidef HIP_INCLUDE_HIP_HIP_EXT_H
hipExtLaunchKernel
hipError_t hipExtLaunchKernel(const void *function_address, dim3 numBlocks, dim3 dimBlocks, void **args, size_t sharedMemBytes, hipStream_t stream, hipEvent_t startEvent, hipEvent_t stopEvent, int flags)
Launches kernel from the pointer address, with arguments and shared memory on stream.
hipError_t
enum __HIP_NODISCARD hipError_t hipError_t
Definition: hip_runtime_api.h:213
hipExtModuleLaunchKernel
HIP_PUBLIC_API hipError_t hipExtModuleLaunchKernel(hipFunction_t f, uint32_t globalWorkSizeX, uint32_t globalWorkSizeY, uint32_t globalWorkSizeZ, uint32_t localWorkSizeX, uint32_t localWorkSizeY, uint32_t localWorkSizeZ, size_t sharedMemBytes, hipStream_t hStream, void **kernelParams, void **extra, hipEvent_t startEvent=nullptr, hipEvent_t stopEvent=nullptr, uint32_t flags=0)
Launches kernel with parameters and shared memory on stream with arguments passed to kernel params or...
hipHccModuleLaunchKernel
HIP_PUBLIC_API hipError_t hipHccModuleLaunchKernel(hipFunction_t f, uint32_t globalWorkSizeX, uint32_t globalWorkSizeY, uint32_t globalWorkSizeZ, uint32_t localWorkSizeX, uint32_t localWorkSizeY, uint32_t localWorkSizeZ, size_t sharedMemBytes, hipStream_t hStream, void **kernelParams, void **extra, hipEvent_t startEvent=nullptr, hipEvent_t stopEvent=nullptr) __attribute__((deprecated("use hipExtModuleLaunchKernel instead")))
This HIP API is deprecated, please use hipExtModuleLaunchKernel() instead.
HIP_PUBLIC_API
#define HIP_PUBLIC_API
Definition: hip_common.h:67
hip_runtime.h
hipStream_t
struct ihipStream_t * hipStream_t
Definition: hip_runtime_api.h:529
hipEvent_t
struct ihipEvent_t * hipEvent_t
Definition: hip_runtime_api.h:557
hipFunction_t
struct ihipModuleSymbol_t * hipFunction_t
Definition: hip_runtime_api.h:539
dim3
Definition: hip_runtime_api.h:948