@@ -8938,63 +8938,65 @@ urEnqueueTimestampRecordingExp(
8938
8938
#if !defined(__GNUC__)
8939
8939
#pragma endregion
8940
8940
#endif
8941
- // Intel 'oneAPI' Unified Runtime Experimental APIs for (kernel) Launch Attributes
8941
+ // Intel 'oneAPI' Unified Runtime Experimental APIs for (kernel) Launch Properties
8942
8942
#if !defined(__GNUC__)
8943
8943
#pragma region launch attributes(experimental)
8944
8944
#endif
8945
8945
///////////////////////////////////////////////////////////////////////////////
8946
- #ifndef UR_LAUNCH_ATTRIBUTES_EXTENSION_STRING_EXP
8947
- /// @brief The extension string that defines support for the Launch Attributes
8946
+ #ifndef UR_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
8947
+ /// @brief The extension string that defines support for the Launch Properties
8948
8948
/// extension, which is returned when querying device extensions.
8949
- #define UR_LAUNCH_ATTRIBUTES_EXTENSION_STRING_EXP "ur_exp_launch_attributes "
8950
- #endif // UR_LAUNCH_ATTRIBUTES_EXTENSION_STRING_EXP
8949
+ #define UR_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP "ur_exp_launch_properties "
8950
+ #endif // UR_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
8951
8951
8952
8952
///////////////////////////////////////////////////////////////////////////////
8953
- /// @brief Specifies a launch attribute id
8953
+ /// @brief Specifies a launch property id
8954
8954
///
8955
8955
/// @remarks
8956
8956
/// _Analogues_
8957
8957
/// - **CUlaunchAttributeID**
8958
- typedef enum ur_exp_launch_attribute_id_t {
8959
- UR_EXP_LAUNCH_ATTRIBUTE_ID_IGNORE = 0, ///< the attribute has no effect
8960
- UR_EXP_LAUNCH_ATTRIBUTE_ID_COOPERATIVE = 1, ///< whether to launch a cooperative kernel
8961
- UR_EXP_LAUNCH_ATTRIBUTE_ID_CLUSTER_DIMENSION = 2, ///< cluster dimensions
8958
+ typedef enum ur_exp_launch_property_id_t {
8959
+ UR_EXP_LAUNCH_PROPERTY_ID_IGNORE = 0, ///< The property has no effect
8960
+ UR_EXP_LAUNCH_PROPERTY_ID_COOPERATIVE = 1, ///< Whether to launch a cooperative kernel
8961
+ UR_EXP_LAUNCH_PROPERTY_ID_CLUSTER_DIMENSION = 2, ///< work-group cluster dimensions
8962
8962
/// @cond
8963
- UR_EXP_LAUNCH_ATTRIBUTE_ID_FORCE_UINT32 = 0x7fffffff
8963
+ UR_EXP_LAUNCH_PROPERTY_ID_FORCE_UINT32 = 0x7fffffff
8964
8964
/// @endcond
8965
8965
8966
- } ur_exp_launch_attribute_id_t ;
8966
+ } ur_exp_launch_property_id_t ;
8967
8967
8968
8968
///////////////////////////////////////////////////////////////////////////////
8969
- /// @brief Specifies a launch attribute value
8969
+ /// @brief Specifies a launch property value
8970
8970
///
8971
8971
/// @remarks
8972
8972
/// _Analogues_
8973
8973
/// - **CUlaunchAttributeValue**
8974
- typedef union ur_exp_launch_attribute_value_t {
8975
- uint32_t clusterDim[3]; ///< [in] cluster dimensions (x, y, z)
8974
+ typedef union ur_exp_launch_property_value_t {
8975
+ uint32_t clusterDim[3]; ///< [in] dimensions of the cluster (units of work-group) (x, y, z). Each
8976
+ ///< value must be a divisor of the corresponding global work-size
8977
+ ///< dimension (in units of work-group).
8976
8978
int cooperative; ///< [in] non-zero value indicates a cooperative kernel
8977
8979
8978
- } ur_exp_launch_attribute_value_t ;
8980
+ } ur_exp_launch_property_value_t ;
8979
8981
8980
8982
///////////////////////////////////////////////////////////////////////////////
8981
- /// @brief Kernel launch attribute
8983
+ /// @brief Kernel launch property
8982
8984
///
8983
8985
/// @remarks
8984
8986
/// _Analogues_
8985
8987
/// - **cuLaunchAttribute**
8986
- typedef struct ur_exp_launch_attribute_t {
8987
- ur_exp_launch_attribute_id_t id; ///< [in] Launch attribute id
8988
- ur_exp_launch_attribute_value_t value; ///< [in][tagged_by(id)] Launch attribute value
8988
+ typedef struct ur_exp_launch_property_t {
8989
+ ur_exp_launch_property_id_t id; ///< [in] launch property id
8990
+ ur_exp_launch_property_value_t value; ///< [in][tagged_by(id)] launch property value
8989
8991
8990
- } ur_exp_launch_attribute_t ;
8992
+ } ur_exp_launch_property_t ;
8991
8993
8992
8994
///////////////////////////////////////////////////////////////////////////////
8993
- /// @brief Launch kernel with custom Launch attributes
8995
+ /// @brief Launch kernel with custom launch properties
8994
8996
///
8995
8997
/// @details
8996
- /// - Launches the kernel using the specified launch attributes
8997
- /// - If numAttrsInLaunchAttrList == 0 then a regular kernel launch is used:
8998
+ /// - Launches the kernel using the specified launch properties
8999
+ /// - If numPropsInLaunchPropList == 0 then a regular kernel launch is used:
8998
9000
/// `urEnqueueKernelLaunch`
8999
9001
/// - Consult the appropriate adapter driver documentation for details of
9000
9002
/// adapter specific behavior and native error codes that may be returned.
@@ -9015,9 +9017,9 @@ typedef struct ur_exp_launch_attribute_t {
9015
9017
/// + NULL == hKernel
9016
9018
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
9017
9019
/// + `NULL == pGlobalWorkSize`
9018
- /// + `NULL == launchAttrList `
9020
+ /// + `NULL == launchPropList `
9019
9021
/// + NULL == pGlobalWorkSize
9020
- /// + numAttrsInLaunchAttrList != 0 && launchAttrList == NULL
9022
+ /// + numPropsInLaunchpropList != 0 && launchPropList == NULL
9021
9023
/// - ::UR_RESULT_SUCCESS
9022
9024
/// - ::UR_RESULT_ERROR_UNINITIALIZED
9023
9025
/// - ::UR_RESULT_ERROR_DEVICE_LOST
@@ -9038,26 +9040,26 @@ typedef struct ur_exp_launch_attribute_t {
9038
9040
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
9039
9041
UR_APIEXPORT ur_result_t UR_APICALL
9040
9042
urEnqueueKernelLaunchCustomExp(
9041
- ur_queue_handle_t hQueue, ///< [in] handle of the queue object
9042
- ur_kernel_handle_t hKernel, ///< [in] handle of the kernel object
9043
- uint32_t workDim, ///< [in] number of dimensions, from 1 to 3, to specify the global and
9044
- ///< work-group work-items
9045
- const size_t *pGlobalWorkSize, ///< [in] pointer to an array of workDim unsigned values that specify the
9046
- ///< number of global work-items in workDim that will execute the kernel
9047
- ///< function
9048
- const size_t *pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that
9049
- ///< specify the number of local work-items forming a work-group that will
9050
- ///< execute the kernel function. If nullptr, the runtime implementation
9051
- ///< will choose the work-group size.
9052
- uint32_t numAttrsInLaunchAttrList , ///< [in] size of the launch attr list
9053
- const ur_exp_launch_attribute_t *launchAttrList , ///< [in][range(0, numAttrsInLaunchAttrList )] pointer to a list of launch
9054
- ///< attributes
9055
- uint32_t numEventsInWaitList, ///< [in] size of the event wait list
9056
- const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
9057
- ///< events that must be complete before the kernel execution. If nullptr,
9058
- ///< the numEventsInWaitList must be 0, indicating that no wait event.
9059
- ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
9060
- ///< kernel execution instance.
9043
+ ur_queue_handle_t hQueue, ///< [in] handle of the queue object
9044
+ ur_kernel_handle_t hKernel, ///< [in] handle of the kernel object
9045
+ uint32_t workDim, ///< [in] number of dimensions, from 1 to 3, to specify the global and
9046
+ ///< work-group work-items
9047
+ const size_t *pGlobalWorkSize, ///< [in] pointer to an array of workDim unsigned values that specify the
9048
+ ///< number of global work-items in workDim that will execute the kernel
9049
+ ///< function
9050
+ const size_t *pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that
9051
+ ///< specify the number of local work-items forming a work-group that will
9052
+ ///< execute the kernel function. If nullptr, the runtime implementation
9053
+ ///< will choose the work-group size.
9054
+ uint32_t numPropsInLaunchPropList , ///< [in] size of the launch prop list
9055
+ const ur_exp_launch_property_t *launchPropList , ///< [in][range(0, numPropsInLaunchPropList )] pointer to a list of launch
9056
+ ///< properties
9057
+ uint32_t numEventsInWaitList, ///< [in] size of the event wait list
9058
+ const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of
9059
+ ///< events that must be complete before the kernel execution. If nullptr,
9060
+ ///< the numEventsInWaitList must be 0, indicating that no wait event.
9061
+ ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular
9062
+ ///< kernel execution instance.
9061
9063
);
9062
9064
9063
9065
#if !defined(__GNUC__)
@@ -10764,8 +10766,8 @@ typedef struct ur_enqueue_kernel_launch_custom_exp_params_t {
10764
10766
uint32_t *pworkDim;
10765
10767
const size_t **ppGlobalWorkSize;
10766
10768
const size_t **ppLocalWorkSize;
10767
- uint32_t *pnumAttrsInLaunchAttrList ;
10768
- const ur_exp_launch_attribute_t **plaunchAttrList ;
10769
+ uint32_t *pnumPropsInLaunchPropList ;
10770
+ const ur_exp_launch_property_t **plaunchPropList ;
10769
10771
uint32_t *pnumEventsInWaitList;
10770
10772
const ur_event_handle_t **pphEventWaitList;
10771
10773
ur_event_handle_t **pphEvent;
0 commit comments