Skip to content

Clarify the behaviour of urUSMMemAdvise and urUSMPrefetch #854

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
fabiomestre merged 1 commit into from
Sep 14, 2023
Merged

Clarify the behaviour of urUSMMemAdvise and urUSMPrefetch #854

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
10 changes: 10 additions & 0 deletions include/ur_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6610,6 +6610,11 @@ urEnqueueUSMMemcpy(
///////////////////////////////////////////////////////////////////////////////
/// @brief Enqueue a command to prefetch USM memory
///
/// @details
/// - Prefetching may not be supported for all devices or allocation types.
/// If memory prefetching is not supported, the prefetch hint will be
/// ignored.
///
/// @returns
/// - ::UR_RESULT_SUCCESS
/// - ::UR_RESULT_ERROR_UNINITIALIZED
Expand Down Expand Up @@ -6651,6 +6656,11 @@ urEnqueueUSMPrefetch(
///////////////////////////////////////////////////////////////////////////////
/// @brief Enqueue a command to set USM memory advice
///
/// @details
/// - Not all memory advice hints may be supported for all devices or
/// allocation types. If a memory advice hint is not supported, it will be
/// ignored.
///
/// @returns
/// - ::UR_RESULT_SUCCESS
/// - ::UR_RESULT_ERROR_UNINITIALIZED
Expand Down
8 changes: 7 additions & 1 deletion scripts/core/enqueue.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,9 @@ desc: "Enqueue a command to prefetch USM memory"
class: $xEnqueue
name: USMPrefetch
ordinal: "0"
details:
- "Prefetching may not be supported for all devices or allocation types. If memory prefetching
is not supported, the prefetch hint will be ignored."
params:
- type: $x_queue_handle_t
name: hQueue
Expand Down Expand Up @@ -1128,10 +1131,13 @@ returns:
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to set USM memory advice"
desc: "Enqueue a command to set USM memory advice"
class: $xEnqueue
name: USMAdvise
ordinal: "0"
details:
- "Not all memory advice hints may be supported for all devices or allocation types.
If a memory advice hint is not supported, it will be ignored."
params:
- type: $x_queue_handle_t
name: hQueue
Expand Down
10 changes: 10 additions & 0 deletions source/loader/ur_libapi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5669,6 +5669,11 @@ ur_result_t UR_APICALL urEnqueueUSMMemcpy(
///////////////////////////////////////////////////////////////////////////////
/// @brief Enqueue a command to prefetch USM memory
///
/// @details
/// - Prefetching may not be supported for all devices or allocation types.
/// If memory prefetching is not supported, the prefetch hint will be
/// ignored.
///
/// @returns
/// - ::UR_RESULT_SUCCESS
/// - ::UR_RESULT_ERROR_UNINITIALIZED
Expand Down Expand Up @@ -5721,6 +5726,11 @@ ur_result_t UR_APICALL urEnqueueUSMPrefetch(
///////////////////////////////////////////////////////////////////////////////
/// @brief Enqueue a command to set USM memory advice
///
/// @details
/// - Not all memory advice hints may be supported for all devices or
/// allocation types. If a memory advice hint is not supported, it will be
/// ignored.
///
/// @returns
/// - ::UR_RESULT_SUCCESS
/// - ::UR_RESULT_ERROR_UNINITIALIZED
Expand Down
10 changes: 10 additions & 0 deletions source/ur_api.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4814,6 +4814,11 @@ ur_result_t UR_APICALL urEnqueueUSMMemcpy(
///////////////////////////////////////////////////////////////////////////////
/// @brief Enqueue a command to prefetch USM memory
///
/// @details
/// - Prefetching may not be supported for all devices or allocation types.
/// If memory prefetching is not supported, the prefetch hint will be
/// ignored.
///
/// @returns
/// - ::UR_RESULT_SUCCESS
/// - ::UR_RESULT_ERROR_UNINITIALIZED
Expand Down Expand Up @@ -4859,6 +4864,11 @@ ur_result_t UR_APICALL urEnqueueUSMPrefetch(
///////////////////////////////////////////////////////////////////////////////
/// @brief Enqueue a command to set USM memory advice
///
/// @details
/// - Not all memory advice hints may be supported for all devices or
/// allocation types. If a memory advice hint is not supported, it will be
/// ignored.
///
/// @returns
/// - ::UR_RESULT_SUCCESS
/// - ::UR_RESULT_ERROR_UNINITIALIZED
Expand Down