Skip to content

Commit 0d98c2f

Browse files
pbg-intelrwmcguir
pbg-intel
and
rwmcguir
authored
Promoting relaxed memory alloc experimental extn to standard extn (#466)
Co-authored-by: Russell McGuire <russell.w.mcguire@intel.com>
1 parent 49e4765 commit 0d98c2f

4 files changed

Lines changed: 96 additions & 11 deletions

File tree

‎scripts/core/EXT_Exp_RelaxedAllocLimits.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ from templates import helper as th
66
x=tags['$x']
77
X=x.upper()
88
%>
9+
10+
<%!
11+
from parse_specs import _version_compare_gequal
12+
%>
13+
914
:orphan:
1015

1116
.. _ZE_experimental_relaxed_allocation_limits:
@@ -14,6 +19,8 @@ from templates import helper as th
1419
Relaxed Allocation Limits Extension
1520
=====================================
1621

22+
This experimental extension is deprecated since version 1.17 onwards and replaced by the :ref:`${th.subt(namespace, tags, X)}_extension_relaxed_allocation_limits <${th.subt(namespace, tags, X)}_extension_relaxed_allocation_limits>` standard extension.
23+
1724
API
1825
----
1926

‎scripts/core/EXT_RelaxedAllocLimits.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<%
2+
import re
3+
from templates import helper as th
4+
%><%
5+
OneApi=tags['$OneApi']
6+
x=tags['$x']
7+
X=x.upper()
8+
%>
9+
:orphan:
10+
11+
.. _ZE_extension_relaxed_allocation_limits:
12+
13+
=====================================
14+
Relaxed Allocation Limits Extension
15+
=====================================
16+
17+
API
18+
----
19+
20+
* Enumerations
21+
22+
23+
* ${x}_relaxed_allocation_limits_ext_version_t
24+
* ${x}_relaxed_allocation_limits_ext_flags_t
25+
26+
27+
* Structures
28+
29+
30+
* ${x}_relaxed_allocation_limits_ext_desc_t
31+
32+

‎scripts/core/common.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,9 @@ etors:
495495
- name: DEVICE_READONLY_MEMORY_EXT_PROPERTIES
496496
desc: $x_device_readonly_memory_ext_properties_t
497497
version: "1.17"
498+
- name: RELAXED_ALLOCATION_LIMITS_EXT_DESC
499+
desc: $x_relaxed_allocation_limits_ext_desc_t
500+
version: "1.17"
498501
- name: RELAXED_ALLOCATION_LIMITS_EXP_DESC
499502
desc: $x_relaxed_allocation_limits_exp_desc_t
500503
value: "0x00020001"

‎scripts/core/relaxedAllocLimits.yml‎

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,88 @@
88
--- #--------------------------------------------------------------------------
99
type: header
1010
desc: "Intel $OneApi Level-Zero Extension for supporting relaxed allocation limits."
11-
version: "1.1"
11+
version: "1.17"
1212
--- #--------------------------------------------------------------------------
1313
type: macro
1414
desc: "Relaxed Allocation Limits Extension Name"
15+
version: "1.17"
16+
name: $X_RELAXED_ALLOCATION_LIMITS_EXT_NAME
17+
value: '"$X_extension_relaxed_allocation_limits"'
18+
--- #--------------------------------------------------------------------------
19+
type: enum
20+
desc: "Relaxed Allocation Limits Extension Version(s)"
21+
version: "1.17"
22+
name: $x_relaxed_allocation_limits_ext_version_t
23+
etors:
24+
- name: "1_0"
25+
value: "$X_MAKE_VERSION( 1, 0 )"
26+
desc: "version 1.0"
27+
--- #--------------------------------------------------------------------------
28+
type: enum
29+
desc: "Supported relaxed memory allocation flags"
30+
version: "1.17"
31+
class: $xMem
32+
name: $x_relaxed_allocation_limits_ext_flags_t
33+
etors:
34+
- name: MAX_SIZE
35+
desc: "Allocation size may exceed the `maxMemAllocSize` member of $x_device_properties_t."
36+
--- #--------------------------------------------------------------------------
37+
type: struct
38+
desc: "Relaxed limits memory allocation descriptor"
39+
version: "1.17"
40+
class: $xMem
41+
name: $x_relaxed_allocation_limits_ext_desc_t
42+
base: $x_base_desc_t
43+
members:
44+
- type: $x_relaxed_allocation_limits_ext_flags_t
45+
name: flags
46+
desc: |
47+
[in] flags specifying allocation limits to relax.
48+
must be 0 (default) or a valid combination of $x_relaxed_allocation_limits_ext_flag_t;
49+
init: "0"
50+
details:
51+
- "This structure may be passed to $xMemAllocShared or $xMemAllocDevice, via the `pNext` member of $x_device_mem_alloc_desc_t."
52+
- "This structure may also be passed to $xMemAllocHost, via the `pNext` member of $x_host_mem_alloc_desc_t."
53+
--- #--------------------------------------------------------------------------
54+
type: header
55+
desc: "[DEPRECATED] Intel $OneApi Level-Zero Extension for supporting relaxed allocation limits. Use the standard `ZE_extension_relaxed_allocation_limits` extension instead."
56+
version: "1.1"
57+
--- #--------------------------------------------------------------------------
58+
type: macro
59+
desc: "[DEPRECATED] Relaxed Allocation Limits Extension Name. Use $X_RELAXED_ALLOCATION_LIMITS_EXT_NAME instead."
1560
version: "1.1"
1661
name: $X_RELAXED_ALLOCATION_LIMITS_EXP_NAME
1762
value: '"$X_experimental_relaxed_allocation_limits"'
1863
--- #--------------------------------------------------------------------------
1964
type: enum
20-
desc: "Relaxed Allocation Limits Extension Version(s)"
65+
desc: "[DEPRECATED] Relaxed Allocation Limits Extension Version(s). Use $x_relaxed_allocation_limits_ext_version_t instead."
2166
version: "1.1"
2267
name: $x_relaxed_allocation_limits_exp_version_t
2368
etors:
2469
- name: "1_0"
2570
value: "$X_MAKE_VERSION( 1, 0 )"
26-
desc: "version 1.0"
71+
desc: "[DEPRECATED] version 1.0"
2772
--- #--------------------------------------------------------------------------
2873
type: enum
29-
desc: "Supported relaxed memory allocation flags"
74+
desc: "[DEPRECATED] Supported relaxed memory allocation flags. Use $x_relaxed_allocation_limits_ext_flags_t instead."
3075
version: "1.1"
3176
class: $xMem
3277
name: $x_relaxed_allocation_limits_exp_flags_t
3378
etors:
3479
- name: MAX_SIZE
35-
desc: "Allocation size may exceed the `maxMemAllocSize` member of $x_device_properties_t."
80+
desc: "[DEPRECATED] Allocation size may exceed the `maxMemAllocSize` member of $x_device_properties_t. Use $x_relaxed_allocation_limits_ext_flags_t MAX_SIZE instead."
3681
--- #--------------------------------------------------------------------------
3782
type: struct
38-
desc: "Relaxed limits memory allocation descriptor"
83+
desc: "[DEPRECATED] Relaxed limits memory allocation descriptor. Use $x_relaxed_allocation_limits_ext_desc_t instead."
3984
version: "1.1"
4085
class: $xMem
4186
name: $x_relaxed_allocation_limits_exp_desc_t
4287
base: $x_base_desc_t
4388
members:
4489
- type: $x_relaxed_allocation_limits_exp_flags_t
4590
name: flags
46-
desc: |
47-
[in] flags specifying allocation limits to relax.
48-
must be 0 (default) or a valid combination of $x_relaxed_allocation_limits_exp_flag_t;
91+
desc: "[in] [DEPRECATED] no longer supported, use $x_relaxed_allocation_limits_ext_desc_t instead"
4992
init: "0"
5093
details:
51-
- "This structure may be passed to $xMemAllocShared or $xMemAllocDevice, via the `pNext` member of $x_device_mem_alloc_desc_t."
52-
- "This structure may also be passed to $xMemAllocHost, via the `pNext` member of $x_host_mem_alloc_desc_t."
94+
- "[DEPRECATED] This structure may be passed to $xMemAllocShared or $xMemAllocDevice, via the `pNext` member of $x_device_mem_alloc_desc_t. Use $x_relaxed_allocation_limits_ext_desc_t instead."
95+
- "[DEPRECATED] This structure may also be passed to $xMemAllocHost, via the `pNext` member of $x_host_mem_alloc_desc_t. Use $x_relaxed_allocation_limits_ext_desc_t instead."

0 commit comments

Comments
 (0)