Skip to content

Commit d42d90e

Browse files
lbushi25gmlueck
andauthored
[SYCL] Change the ext_intel_device_info spec to throw a feature not supported error when a query is not supported (#14576)
When an aspect is not supported by a device, the `ext_intel_device_info` spec says to throw an invalid object runtime error when calling `get_info` with the corresponding descriptor. This error description is both vague and not very descriptive of the actual thing that went wrong, namely that the query is simply not supported by a device. This PR changes that to instead say to throw a feature not supported runtime error. --------- Co-authored-by: Greg Lueck <[email protected]>
1 parent d7868e8 commit d42d90e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

sycl/doc/extensions/supported/sycl_ext_intel_device_info.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A new aspect, ext\_intel\_device\_id, will be added.
4646

4747
## Error Condition ##
4848

49-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_device\_id.
49+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_device_id`.
5050

5151
## Example Usage ##
5252

@@ -83,7 +83,7 @@ A new aspect, ext\_intel\_device\_info\_uuid, will be added.
8383

8484
## Error Condition ##
8585

86-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_device\_info\_uuid.
86+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_device_info_uuid`.
8787

8888

8989
## Example Usage ##
@@ -123,7 +123,7 @@ A new aspect, ext\_intel\_pci\_address, will be added.
123123

124124
## Error Condition ##
125125

126-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_pci\_address.
126+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_pci_address`.
127127

128128

129129
## Example Usage ##
@@ -162,7 +162,7 @@ A new aspect, ext\_intel\_gpu\_eu\_simd\_width, will be added.
162162

163163
## Error Condition ##
164164

165-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_gpu\_eu\_simd\_width.
165+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_gpu_eu_simd_width`.
166166

167167
## Example Usage ##
168168

@@ -202,7 +202,7 @@ A new aspect, ext\_intel\_gpu\_eu\_count, will be added.
202202

203203
## Error Condition ##
204204

205-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_gpu\_eu\_count.
205+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_gpu_eu_count`.
206206

207207
## Example Usage ##
208208

@@ -238,7 +238,7 @@ A new aspect, ext\_intel\_gpu\_slices, will be added.
238238

239239
## Error Condition ##
240240

241-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_gpu\_slices.
241+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_gpu_slices`.
242242

243243
## Example Usage ##
244244

@@ -273,7 +273,7 @@ A new aspect, ext\_intel\_gpu\_subslices\_per\_slice, will be added.
273273

274274
## Error Condition ##
275275

276-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_gpu\_subslices\_per\_slice.
276+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_gpu_subslices_per_slice`.
277277

278278
## Example Usage ##
279279

@@ -308,7 +308,7 @@ A new aspect, ext\_intel\_gpu\_eu\_count\_per\_subslice, will be added.
308308

309309
## Error Condition ##
310310

311-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_gpu\_eu\_count\_per\_subslice.
311+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_gpu_eu_count_per_subslice`.
312312

313313
## Example Usage ##
314314

@@ -341,7 +341,7 @@ A new aspect, ext\_intel\_gpu\_hw\_threads\_per\_eu, will be added.
341341

342342
## Error Condition ##
343343

344-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_gpu\_hw\_threads\_per\_eu.
344+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_gpu_hw_threads_per_eu`.
345345

346346
## Example Usage ##
347347

@@ -377,7 +377,7 @@ A new aspect, ext\_intel\_max\_mem\_bandwidth, will be added.
377377

378378
## Error Condition ##
379379

380-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_max\_mem\_bandwidth.
380+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_max_mem_bandwidth`.
381381

382382

383383
## Example Usage ##
@@ -415,7 +415,7 @@ A new aspect, ext\_intel\_free\_memory, will be added.
415415

416416
## Error Condition ##
417417

418-
An invalid object runtime error will be thrown if the device does not support aspect\:\:ext\_intel\_free\_memory.
418+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_free_memory`.
419419

420420

421421
## Example Usage ##
@@ -452,7 +452,7 @@ A new aspect, ext\_intel\_memory\_clock\_rate, is added.
452452

453453
## Error Condition ##
454454

455-
An invalid object runtime error is thrown if the device does not support aspect\:\:ext\_intel\_memory\_clock\_rate.
455+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_memory_clock_rate`.
456456

457457

458458
## Example Usage ##
@@ -489,7 +489,7 @@ A new aspect, ext\_intel\_memory\_bus\_width, is added.
489489

490490
## Error Condition ##
491491

492-
An invalid object runtime error is thrown if the device does not support aspect\:\:ext\_intel\_memory\_bus\_width.
492+
Throws a synchronous `exception` with the `errc::feature_not_supported` error code if the device does not have `aspect::ext_intel_memory_bus_width`.
493493

494494

495495
## Example Usage ##

0 commit comments

Comments
 (0)