Michael LIAO
116 line
5.2 KiB
C++
116 line
5.2 KiB
C++
/*
|
|
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.
|
|
*/
|
|
|
|
#ifndef HIP_INCLUDE_HIP_HIP_HCC_H
|
|
#define HIP_INCLUDE_HIP_HIP_HCC_H
|
|
|
|
#ifdef __HCC__
|
|
|
|
#include "hip/hip_runtime_api.h"
|
|
|
|
// Forward declarations:
|
|
namespace hc {
|
|
class accelerator;
|
|
class accelerator_view;
|
|
}; // namespace hc
|
|
|
|
|
|
/**
|
|
*-------------------------------------------------------------------------------------------------
|
|
*-------------------------------------------------------------------------------------------------
|
|
* @defgroup HCC-specific features
|
|
* @warning These APIs provide access to special features of HCC compiler and are not available
|
|
*through the CUDA path.
|
|
* @{
|
|
*/
|
|
|
|
|
|
/**
|
|
* @brief Return hc::accelerator associated with the specified deviceId
|
|
* @return #hipSuccess, #hipErrorInvalidDevice
|
|
*/
|
|
hipError_t hipHccGetAccelerator(int deviceId, hc::accelerator* acc);
|
|
|
|
/**
|
|
* @brief Return hc::accelerator_view associated with the specified stream
|
|
*
|
|
* If stream is 0, the accelerator_view for the default stream is returned.
|
|
* @return #hipSuccess
|
|
*/
|
|
hipError_t hipHccGetAcceleratorView(hipStream_t stream, hc::accelerator_view** av);
|
|
|
|
|
|
/**
|
|
* @brief launches kernel f with launch parameters and shared memory on stream with arguments passed
|
|
to kernelparams or extra
|
|
*
|
|
* @param [in[ f Kernel to launch.
|
|
* @param [in] gridDimX X grid dimension specified in work-items
|
|
* @param [in] gridDimY Y grid dimension specified in work-items
|
|
* @param [in] gridDimZ Z grid dimension specified in work-items
|
|
* @param [in] blockDimX X block dimensions specified in work-items
|
|
* @param [in] blockDimY Y grid dimension specified in work-items
|
|
* @param [in] blockDimZ Z grid dimension specified in work-items
|
|
* @param [in] sharedMemBytes Amount of dynamic shared memory to allocate for this kernel. The
|
|
kernel can access this with HIP_DYNAMIC_SHARED.
|
|
* @param [in] stream Stream where the kernel should be dispatched. May be 0, in which case th
|
|
default stream is used with associated synchronization rules.
|
|
* @param [in] kernelParams
|
|
* @param [in] extra Pointer to kernel arguments. These are passed directly to the kernel and
|
|
must be in the memory layout and alignment expected by the kernel.
|
|
* @param [in] startEvent If non-null, specified event will be updated to track the start time of
|
|
the kernel launch. The event must be created before calling this API.
|
|
* @param [in] stopEvent If non-null, specified event will be updated to track the stop time of
|
|
the kernel launch. The event must be created before calling this API.
|
|
*
|
|
* @returns hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue
|
|
*
|
|
* @warning kernellParams argument is not yet implemented in HIP. Please use extra instead. Please
|
|
refer to hip_porting_driver_api.md for sample usage.
|
|
|
|
* HIP/ROCm actually updates the start event when the associated kernel completes.
|
|
*/
|
|
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);
|
|
|
|
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")));
|
|
|
|
// doxygen end HCC-specific features
|
|
/**
|
|
* @}
|
|
*/
|
|
#endif // #ifdef __HCC__
|
|
#endif // #ifdef HIP_INCLUDE_HIP_HIP_HCC_H
|