Update script attr-> prop

Signed-off-by: JackAKirk <[email protected]>

Author: JackAKirk

scripts/core/EXP-LAUNCH-ATTRIBUTES.rst

@@ -4,10 +4,10 @@
     X=x.upper()
 %>
 
-.. _experimental-launch-attributes:
+.. _experimental-launch-properties:
 
 ================================================================================
-LAUNCH Attributes
+LAUNCH Properties
 ================================================================================
 
 .. warning::
@@ -22,53 +22,58 @@ LAUNCH Attributes
 
 Terminology
 --------------------------------------------------------------------------------
-"Launch Attribute" is used to indicate an optional kernel attribute that can
-be specified at the time of a kernel launch. Such attributes can be used to
-enable hardware specific kernel features.
+"Launch Properties" is used to indicate optional kernel launch properties that
+can be specified at the time of a kernel launch. Such properties can be used to
+enable hardware specific kernel launch features.
 
 Motivation
 --------------------------------------------------------------------------------
-Advances in hardware sometimes require new kernel attributes. One example is
+Advances in hardware sometimes require new kernel properties. One example is
 distributed shared memory as used by Nvidia Hopper GPUs. Launching a kernel
-that supports distributed shared memory requires specifying a thread cluster
-dimension over which the shared memory is accessible. Additionally some
-applications require specification of kernel attributes at runtime.
-
-This extension is a future-proof and portable solution that supports these two requirements.
-Instead of using a fixed set of kernel arguments, the approach is to introduce the
-`exp_launch_attribute_t` type that enables a more flexible approach.
-Each `exp_launch_attribute_t` instance corresponds to a specific kernel launch attribute.
-One new function is introduced; `urEnqueueKernelLaunchCustomExp` takes an
-array of `exp_launch_attribute_t` as an argument, and launches a kernel using these
-attributes. `urEnqueueKernelLaunchCustomExp` corresponds closely to the CUDA Driver API
+that supports distributed shared memory requires specifying a set of "cluster"
+dimensions, in units of work-groups, over which the shared memory is
+"distributed". Additionally some applications require specification of kernel
+properties at launch-time.
+
+This extension is a future-proof and portable solution that supports these two
+requirements. Instead of using a fixed set of kernel enqueue arguments, the
+approach is to introduce the `exp_launch_property_t` type that enables a more
+extendable API.
+
+Each `exp_launch_property_t` instance corresponds to a specific kernel launch
+property.
+Only one new function is introduced: `urEnqueueKernelLaunchCustomExp`.
+`urEnqueueKernelLaunchCustomExp` takes an array of `exp_launch_property_t` as
+an argument, and launches a kernel using these properties.
+`urEnqueueKernelLaunchCustomExp` corresponds closely to the CUDA Driver API
 `cuLaunchKernelEx`.
 
-Many kernel properties can be supported, such as cooperative kernels. As such,
-eventually this extension should be able to replace the cooperative kernels
-UR extension.
+Many kernel lauch properties can be supported, such as cooperative kernel
+launches. As such, eventually this extension should be able to replace the
+cooperative kernels Unified-Runtime extension.
 
 API
 --------------------------------------------------------------------------------
 
 Macros
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* ${X}_LAUNCH_ATTRIBUTES_EXTENSION_STRING_EXP
+* ${X}_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
 
 Enums
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* ${x}_exp_launch_attribute_id_t
+* ${x}_exp_launch_property_id_t
 
 Unions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* ${x}_exp_launch_attribute_value_t
+* ${x}_exp_launch_property_value_t
 
 Structs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* ${x}_exp_launch_attribute_t
+* ${x}_exp_launch_property_t
 
 Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -79,7 +84,7 @@ Support
 --------------------------------------------------------------------------------
 
 Adapters which support this experimental feature *must* return the valid string
-defined in ``${X}_LAUNCH_ATTRIBUTES_EXTENSION_STRING_EXP`` as one of the options from
+defined in ``${X}_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP`` as one of the options from
 ${x}DeviceGetInfo when querying for ${X}_DEVICE_INFO_EXTENSIONS.
 
 Changelog

scripts/core/exp-launch-attributes.yml

@@ -9,68 +9,68 @@
 #
 --- #--------------------------------------------------------------------------
 type: header
-desc: "Intel $OneApi Unified Runtime Experimental APIs for (kernel) Launch Attributes"
+desc: "Intel $OneApi Unified Runtime Experimental APIs for (kernel) Launch Properties"
 ordinal: "99"
 --- #--------------------------------------------------------------------------
 type: macro
-desc: "The extension string that defines support for the Launch Attributes extension, which is returned when querying device extensions."
-name: $X_LAUNCH_ATTRIBUTES_EXTENSION_STRING_EXP
-value: "\"$x_exp_launch_attributes\""
+desc: "The extension string that defines support for the Launch Properties extension, which is returned when querying device extensions."
+name: $X_LAUNCH_PROPERTIES_EXTENSION_STRING_EXP
+value: "\"$x_exp_launch_properties\""
 --- #--------------------------------------------------------------------------
 type: enum
-desc: "Specifies a launch attribute id"
-name: $x_exp_launch_attribute_id_t
+desc: "Specifies a launch property id"
+name: $x_exp_launch_property_id_t
 analogue:
     - "**CUlaunchAttributeID**"
 etors:
     - name: IGNORE
-      desc: "the attribute has no effect"
+      desc: "The property has no effect"
     - name: COOPERATIVE
-      desc: "whether to launch a cooperative kernel"
+      desc: "Whether to launch a cooperative kernel"
     - name: CLUSTER_DIMENSION
-      desc: "cluster dimensions"
+      desc: "work-group cluster dimensions"
 --- #--------------------------------------------------------------------------
 type: union
-desc: "Specifies a launch attribute value"
-name: $x_exp_launch_attribute_value_t
-tag: $x_exp_launch_attribute_id_t
+desc: "Specifies a launch property value"
+name: $x_exp_launch_property_value_t
+tag: $x_exp_launch_property_id_t
 analogue:
     - "**CUlaunchAttributeValue**"
 members:
     - type: uint32_t[3]
       name: clusterDim
-      desc: "[in] cluster dimensions (x, y, z)"
-      tag: $X_EXP_LAUNCH_ATTRIBUTE_ID_CLUSTER_DIMENSION
+      desc: "[in] dimensions of the cluster (units of work-group) (x, y, z). Each value must be a divisor of the corresponding global work-size dimension (in units of work-group)."
+      tag: $X_EXP_LAUNCH_PROPERTY_ID_CLUSTER_DIMENSION
     - type: int
       name: cooperative
       desc: "[in] non-zero value indicates a cooperative kernel"
-      tag: $X_EXP_LAUNCH_ATTRIBUTE_ID_COOPERATIVE
+      tag: $X_EXP_LAUNCH_PROPERTY_ID_COOPERATIVE
 --- #--------------------------------------------------------------------------
 type: struct
-desc: "Kernel launch attribute"
-name: $x_exp_launch_attribute_t
+desc: "Kernel launch property"
+name: $x_exp_launch_property_t
 analogue:
     - "**cuLaunchAttribute**"
 members:
-    - type: $x_exp_launch_attribute_id_t
+    - type: $x_exp_launch_property_id_t
       name: id
-      desc: "[in] Launch attribute id"
-      init: $X_EXP_LAUNCH_ATTRIBUTE_ID_IGNORE
-    - type: $x_exp_launch_attribute_value_t
+      desc: "[in] launch property id"
+      init: $X_EXP_LAUNCH_PROPERTY_ID_IGNORE
+    - type: $x_exp_launch_property_value_t
       name: value
-      desc: "[in][tagged_by(id)] Launch attribute value"
+      desc: "[in][tagged_by(id)] launch property value"
       init: nullptr
 --- #--------------------------------------------------------------------------
 type: function
-desc: "Launch kernel with custom Launch attributes"
+desc: "Launch kernel with custom launch properties"
 class: $xEnqueue
 name: KernelLaunchCustomExp
 ordinal: "0"
 analogue:
     - "**cuLaunchKernelEx**"
 details:
-    - "Launches the kernel using the specified launch attributes"
-    - "If numAttrsInLaunchAttrList == 0 then a regular kernel launch is used: `urEnqueueKernelLaunch`"
+    - "Launches the kernel using the specified launch properties"
+    - "If numPropsInLaunchPropList == 0 then a regular kernel launch is used: `urEnqueueKernelLaunch`"
     - "Consult the appropriate adapter driver documentation for details of adapter specific behavior and native error codes that may be returned."
 params:
     - type: $x_queue_handle_t
@@ -89,11 +89,11 @@ params:
       name: pLocalWorkSize
       desc: "[in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function. If nullptr, the runtime implementation will choose the work-group size."
     - type: uint32_t
-      name: numAttrsInLaunchAttrList
-      desc: "[in] size of the launch attr list"
-    - type: const $x_exp_launch_attribute_t*
-      name: launchAttrList
-      desc: "[in][range(0, numAttrsInLaunchAttrList)] pointer to a list of launch attributes"
+      name: numPropsInLaunchPropList
+      desc: "[in] size of the launch prop list"
+    - type: const $x_exp_launch_property_t*
+      name: launchPropList
+      desc: "[in][range(0, numPropsInLaunchPropList)] pointer to a list of launch properties"
     - type: uint32_t
       name: numEventsInWaitList
       desc: "[in] size of the event wait list"
@@ -113,7 +113,7 @@ returns:
         - "NULL == hKernel"
     - $X_RESULT_ERROR_INVALID_NULL_POINTER:
         - "NULL == pGlobalWorkSize"
-        - "numAttrsInLaunchAttrList != 0 && launchAttrList == NULL"
+        - "numPropsInLaunchpropList != 0 && launchPropList == NULL"
     - $X_RESULT_ERROR_INVALID_QUEUE
     - $X_RESULT_ERROR_INVALID_KERNEL
     - $X_RESULT_ERROR_INVALID_EVENT