Skip to content

Add const to prefetch and memadvice #987

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
gmlueck merged 1 commit into from
Apr 30, 2026
Merged

Add const to prefetch and memadvice #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions adoc/chapters/programming_interface.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4627,11 +4627,11 @@ queue.
.[apidef]#queue::prefetch#
[source,role=synopsis,id=api:queue-prefetch]
----
event prefetch(void* ptr, std::size_t numBytes) (1)
event prefetch(const void* ptr, std::size_t numBytes) (1)

event prefetch(void* ptr, std::size_t numBytes, event depEvent) (2)
event prefetch(const void* ptr, std::size_t numBytes, event depEvent) (2)

event prefetch(void* ptr, std::size_t numBytes, const std::vector<event>& depEvents) (3)
event prefetch(const void* ptr, std::size_t numBytes, const std::vector<event>& depEvents) (3)
----

_Effects (1):_ Equivalent to calling [api]#queue::submit# with a command group
Expand All @@ -4653,11 +4653,11 @@ queue.
.[apidef]#queue::mem_advise#
[source,role=synopsis,id=api:queue-mem-advise]
----
event mem_advise(void* ptr, std::size_t numBytes, int advice) (1)
event mem_advise(const void* ptr, std::size_t numBytes, int advice) (1)

event mem_advise(void* ptr, std::size_t numBytes, int advice, event depEvent) (2)
event mem_advise(const void* ptr, std::size_t numBytes, int advice, event depEvent) (2)

event mem_advise(void* ptr, std::size_t numBytes, int advice, (3)
event mem_advise(const void* ptr, std::size_t numBytes, int advice, (3)
const std::vector<event>& depEvents)
----

Expand Down Expand Up @@ -15527,7 +15527,7 @@ The type [code]#T# must be <<device-copyable>>.
a@
[source]
----
void prefetch(void* ptr, std::size_t numBytes)
void prefetch(const void* ptr, std::size_t numBytes)
----
a@ Enqueues a prefetch of [code]#num_bytes# of data starting at address
[code]#ptr#. The [code]#ptr# must point within a USM allocation from the same
Expand All @@ -15537,7 +15537,7 @@ queue's device. For more detail on USM, please see <<sec:usm>>.
a@
[source]
----
void mem_advise(void* ptr, std::size_t numBytes, int advice)
void mem_advise(const void* ptr, std::size_t numBytes, int advice)
----
a@ Enqueues a command that provides information to the implementation about a
region of USM starting at [code]#ptr# and extending for [code]#numBytes# bytes.
Expand Down
4 changes: 2 additions & 2 deletions adoc/headers/commandGroupHandler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ class handler {

template <typename T> void fill(void* ptr, const T& pattern, std::size_t count);

void prefetch(void* ptr, std::size_t numBytes);
void prefetch(const void* ptr, std::size_t numBytes);

void mem_advise(void* ptr, std::size_t numBytes, int advice);
void mem_advise(const void* ptr, std::size_t numBytes, int advice);

//------ Explicit memory operation APIs
//
Expand Down
12 changes: 6 additions & 6 deletions adoc/headers/queue.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,16 +174,16 @@ class queue {

/* -- Shortcut functions: prefetch -- */

event prefetch(void* ptr, std::size_t numBytes);
event prefetch(void* ptr, std::size_t numBytes, event depEvent);
event prefetch(void* ptr, std::size_t numBytes,
event prefetch(const void* ptr, std::size_t numBytes);
event prefetch(const void* ptr, std::size_t numBytes, event depEvent);
event prefetch(const void* ptr, std::size_t numBytes,
const std::vector<event>& depEvents);

/* -- Shortcut functions: mem_advise -- */

event mem_advise(void* ptr, std::size_t numBytes, int advice);
event mem_advise(void* ptr, std::size_t numBytes, int advice, event depEvent);
event mem_advise(void* ptr, std::size_t numBytes, int advice,
event mem_advise(const void* ptr, std::size_t numBytes, int advice);
event mem_advise(const void* ptr, std::size_t numBytes, int advice, event depEvent);
event mem_advise(const void* ptr, std::size_t numBytes, int advice,
const std::vector<event>& depEvents);

/* -- Shortcut functions: update_host -- */
Expand Down
Loading