Skip to content

[SYCL][Doc] Minor fixes to virtual mem extension spec #21677

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
againull merged 2 commits into from
Apr 3, 2026
Merged

[SYCL][Doc] Minor fixes to virtual mem extension spec #21677

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7332eb
[SYCL][Doc] Minor fixes to virtual mem extension spec
AlexeySachkov Sep 25, 2024
22737c2
Reword sentence regarding "proper sub-range"
gmlueck Apr 2, 2026
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
14 changes: 7 additions & 7 deletions sycl/doc/extensions/experimental/sycl_ext_oneapi_virtual_mem.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ If the constructor is unable to allocate the required memory on `syclDevice`,
the call throws an exception with `errc::memory_allocation`.

|`physical_mem(const queue &syclQueue, size_t numBytes)` |
Same as `physical_mem(syclQueue.get_device(), syclQueue.get_context, numBytes)`.
Same as `physical_mem(syclQueue.get_device(), syclQueue.get_context(), numBytes)`.

|`void *map(uintptr_t ptr, size_t numBytes, address_access_mode mode, size_t offset = 0)` |
Maps a virtual memory range, specified by `ptr` and `numBytes`, to the physical
Expand All @@ -301,7 +301,7 @@ result in undefined behavior.
The returned pointer is equivalent to `reinterpret_cast<void *>(ptr)`.

Writing to any address in the virtual memory range with access mode set to
`access_mode::read` results in undefined behavior.
`address_access_mode::read` results in undefined behavior.

An accessible pointer behaves the same as a pointer to device USM memory and can
be used in place of a device USM pointer in any interface accepting one.
Expand All @@ -317,7 +317,7 @@ Returns the SYCL context associated with the instance of `physical_mem`.
|`device get_device() const` |
Returns the SYCL device associated with the instance of `physical_mem`.

|`size_t size() const` |
|`size_t size() const noexcept` |
Returns the size of the corresponding physical memory in bytes.

|============================
Expand Down Expand Up @@ -380,9 +380,9 @@ the range is mapped to.
|`void unmap(const void *ptr, size_t numBytes, const device &syclDevice, const context &syclContext)` |
Unmaps the range specified by `ptr` and `numBytes`. The range must have been
mapped through a call to `physical_mem::map()` prior to calling this. The range
must not be a proper sub-range of a previously mapped range. `syclContext` must
be the same as the context returned by the `get_context()` member function on
the `physical_mem` the address range is currently mapped to.
must be the full range that was previously mapped (i.e. not a sub-range).
`syclContext` must be the same as the context returned by the `get_context()`
member function on the `physical_mem` the address range is currently mapped to.

After this call, the full range will again be ready to be mapped through a call
to `physical_mem::map()`.
Expand All @@ -395,4 +395,4 @@ lifted in the future. _{endnote}_]
As such, the user must call `unmap` on ranges mapped to `physical_mem` objects
prior to their destruction. _{endnote}_]

|=====================
|=====================
Loading