Skip to content

[SYCL][DOC] Update buffer_location spec to unblock USM host/shared allocations #6219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 7, 2022
Merged

[SYCL][DOC] Update buffer_location spec to unblock USM host/shared allocations #6219

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dc5581b
remove statement blocking shared/host allocations
tiwaria1 May 31, 2022
e355935
improve examples
tiwaria1 May 31, 2022
1f296fc
minor edits
tiwaria1 May 31, 2022
d38cfeb
rev id
tiwaria1 May 31, 2022
3d22e0d
Update sycl/doc/extensions/proposed/sycl_ext_intel_runtime_buffer_loc…
tiwaria1 Jun 1, 2022
db037ca
Update sycl/doc/extensions/proposed/sycl_ext_intel_runtime_buffer_loc…
tiwaria1 Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 54 additions & 13 deletions sycl/doc/extensions/proposed/sycl_ext_intel_runtime_buffer_location.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,59 @@ supports.

== Examples

.Device allocation example
[source,c++]
----
array = (int *)sycl::malloc_device<int>(
N, q,
sycl::property_list{sycl::ext::intel::experimental::property::usm::buffer_location(2)});
using namespace sycl;
using namespace sycl::ext::intel::experimental;
...
queue q;

auto device_array = malloc_device<int>(kN, q, property_list{property::usm::buffer_location(2)});

int host_array[kN];

for(int i=0; i<kN; i++) {
host_array[i] = ...
}

q.copy(host_array, device_array, kN).wait();

q.submit([=] {
...
... = device_array[index];
device_array[index] = ...;
...
}).wait();

q.copy(device_array, host_array, kN).wait();

...
... = host_array[index];
----

sycl::queue q;
q.parallel_for(sycl::range<1>(N), [=] (sycl::id<1> i){
data[i] *= 2;
.Shared allocation example
[source,c++]
----
using namespace sycl;
using namespace sycl::ext::intel::experimental;
...
queue q;

auto array = malloc_shared<int>(kN, q, property_list{property::usm::buffer_location(2)});
for(int i=0; i<kN; i++) {
array = ...
}

q.submit([=] {
...
... = array[index];
array[index] = ...;
...
}).wait();

...
... = array[index];
----


Expand All @@ -96,9 +139,7 @@ This extension adds the new property
`sycl::ext::intel::experimental::property::usm::buffer_location` which
applications can pass in the property_list parameter to all overloads of the
`sycl::malloc_device()`, `sycl::malloc_shared()`, and `sycl::malloc_host()`
functions. However, this property has no effect when passed to
`sycl::malloc_shared()` or `sycl::malloc_host()`. Following is a synopsis of
this property.
functions. Following is a synopsis of this property.

[source,c++]
----
Expand All @@ -114,14 +155,13 @@ class buffer_location {
----

On targets that provide more than one type of global memory, `buffer_location`
allows user to specify which of the global memory to allocate memory to. This
provide user the flexibility to choose the global memory that satisfy
allows users to specify which global memory to allocate memory to. This
provides users the flexibility to choose the global memory that satisfies their
requirements for bandwidth and throughput.

This property is ignored for non-FPGA devices. Attempting to use this
This property is ignored for non-FPGA devices. Attempting to use this
extension on other devices or backends will result in no effect.


== Issues

== Revision History
Expand All @@ -132,4 +172,5 @@ extension on other devices or backends will result in no effect.
|========================================
|Rev|Date|Author|Changes
|1|2022-03-01|Sherry Yuan|*Initial public draft*
|2|2022-05-31|Abhishek Tiwari|*Updates for shared/host malloc*
|========================================