Skip to content
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

Jump to bottom

[Exp] Added const qualifier to some parameters. #699

Closed
wants to merge 2 commits into from
Closed

[Exp] Added const qualifier to some parameters. #699

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43043b7
Added const qualifier to some parameters.
rdeodhar Jul 7, 2023
30ef01c
Removed a const qualifier.
rdeodhar Jul 10, 2023
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
18 changes: 9 additions & 9 deletions include/ur_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7685,9 +7685,9 @@ urCommandBufferEnqueueExp(
/// - ::UR_RESULT_ERROR_INVALID_SIZE
UR_APIEXPORT ur_result_t UR_APICALL
urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
);

///////////////////////////////////////////////////////////////////////////////
Expand All @@ -7708,8 +7708,8 @@ urUSMImportExp(
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
UR_APIEXPORT ur_result_t UR_APICALL
urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
);

#if !defined(__GNUC__)
Expand Down Expand Up @@ -9389,8 +9389,8 @@ typedef struct ur_usm_pitched_alloc_exp_params_t {
/// @details Each entry is a pointer to the parameter passed to the function;
/// allowing the callback the ability to modify the parameter's value
typedef struct ur_usm_import_exp_params_t {
ur_context_handle_t *phContext;
void **ppMem;
const ur_context_handle_t *phContext;
const void **ppMem;
size_t *psize;
} ur_usm_import_exp_params_t;

Expand All @@ -9399,8 +9399,8 @@ typedef struct ur_usm_import_exp_params_t {
/// @details Each entry is a pointer to the parameter passed to the function;
/// allowing the callback the ability to modify the parameter's value
typedef struct ur_usm_release_exp_params_t {
ur_context_handle_t *phContext;
void **ppMem;
const ur_context_handle_t *phContext;
const void **ppMem;
} ur_usm_release_exp_params_t;

///////////////////////////////////////////////////////////////////////////////
Expand Down
8 changes: 4 additions & 4 deletions include/ur_ddi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1593,15 +1593,15 @@ typedef ur_result_t(UR_APICALL *ur_pfnUSMPitchedAllocExp_t)(
///////////////////////////////////////////////////////////////////////////////
/// @brief Function-pointer for urUSMImportExp
typedef ur_result_t(UR_APICALL *ur_pfnUSMImportExp_t)(
ur_context_handle_t,
void *,
const ur_context_handle_t,
const void *,
size_t);

///////////////////////////////////////////////////////////////////////////////
/// @brief Function-pointer for urUSMReleaseExp
typedef ur_result_t(UR_APICALL *ur_pfnUSMReleaseExp_t)(
ur_context_handle_t,
void *);
const ur_context_handle_t,
const void *);

///////////////////////////////////////////////////////////////////////////////
/// @brief Table of USMExp functions pointers
Expand Down
8 changes: 4 additions & 4 deletions scripts/core/exp-usm-import-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ name: ImportExp
details:
- "Import memory into USM"
params:
- type: $x_context_handle_t
- type: "const $x_context_handle_t"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the context should be const qualified the reason being that an adapter may wish to store data in the context relating to the action being performed in the urUSMImportExp/urUSMExportExp entry points, making this argument const means that becomes impossible. Making this const is also inconsistent with the rest of the API.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, removed that const on the UR context.
Note that at the SYCL level all USM APIs (such as malloc_device) that take a queue or context parameter declare them const. But its fine to have the underlying context modifiable.

name: hContext
desc: "[in] handle of the context object"
- type: "void*"
- type: "const void*"
name: pMem
desc: "[in] pointer to host memory object"
- type: "size_t"
Expand All @@ -30,10 +30,10 @@ name: ReleaseExp
details:
- "Release memory from USM"
params:
- type: $x_context_handle_t
- type: "const $x_context_handle_t"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also don't think this should be const qualified, see above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm closing this PR because I don't think these changes are needed. There is a remapping, including casting, between SYCL objects and UR objects anyway.

name: hContext
desc: "[in] handle of the context object"
- type: "void*"
- type: "const void*"
name: pMem
desc: "[in] pointer to host memory object"
returns:
Expand Down
8 changes: 4 additions & 4 deletions source/adapters/null/ur_nullddi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4782,8 +4782,8 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferEnqueueExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMImportExp
__urdlllocal ur_result_t UR_APICALL urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
) try {
ur_result_t result = UR_RESULT_SUCCESS;
Expand All @@ -4804,8 +4804,8 @@ __urdlllocal ur_result_t UR_APICALL urUSMImportExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMReleaseExp
__urdlllocal ur_result_t UR_APICALL urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
) try {
ur_result_t result = UR_RESULT_SUCCESS;

Expand Down
8 changes: 4 additions & 4 deletions source/loader/layers/tracing/ur_trcddi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5524,8 +5524,8 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferEnqueueExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMImportExp
__urdlllocal ur_result_t UR_APICALL urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
) {
auto pfnImportExp = context.urDdiTable.USMExp.pfnImportExp;
Expand All @@ -5549,8 +5549,8 @@ __urdlllocal ur_result_t UR_APICALL urUSMImportExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMReleaseExp
__urdlllocal ur_result_t UR_APICALL urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
) {
auto pfnReleaseExp = context.urDdiTable.USMExp.pfnReleaseExp;

Expand Down
8 changes: 4 additions & 4 deletions source/loader/layers/validation/ur_valddi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6867,8 +6867,8 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferEnqueueExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMImportExp
__urdlllocal ur_result_t UR_APICALL urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
) {
auto pfnImportExp = context.urDdiTable.USMExp.pfnImportExp;
Expand All @@ -6895,8 +6895,8 @@ __urdlllocal ur_result_t UR_APICALL urUSMImportExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMReleaseExp
__urdlllocal ur_result_t UR_APICALL urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
) {
auto pfnReleaseExp = context.urDdiTable.USMExp.pfnReleaseExp;

Expand Down
8 changes: 4 additions & 4 deletions source/loader/ur_ldrddi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6658,8 +6658,8 @@ __urdlllocal ur_result_t UR_APICALL urCommandBufferEnqueueExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMImportExp
__urdlllocal ur_result_t UR_APICALL urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
) {
ur_result_t result = UR_RESULT_SUCCESS;
Expand All @@ -6683,8 +6683,8 @@ __urdlllocal ur_result_t UR_APICALL urUSMImportExp(
///////////////////////////////////////////////////////////////////////////////
/// @brief Intercept function for urUSMReleaseExp
__urdlllocal ur_result_t UR_APICALL urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
) {
ur_result_t result = UR_RESULT_SUCCESS;

Expand Down
8 changes: 4 additions & 4 deletions source/loader/ur_libapi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7201,8 +7201,8 @@ ur_result_t UR_APICALL urCommandBufferEnqueueExp(
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
/// - ::UR_RESULT_ERROR_INVALID_SIZE
ur_result_t UR_APICALL urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
) try {
auto pfnImportExp = ur_lib::context->urDdiTable.USMExp.pfnImportExp;
Expand Down Expand Up @@ -7232,8 +7232,8 @@ ur_result_t UR_APICALL urUSMImportExp(
/// + `NULL == pMem`
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
ur_result_t UR_APICALL urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
) try {
auto pfnReleaseExp = ur_lib::context->urDdiTable.USMExp.pfnReleaseExp;
if (nullptr == pfnReleaseExp) {
Expand Down
8 changes: 4 additions & 4 deletions source/ur_api.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6050,8 +6050,8 @@ ur_result_t UR_APICALL urCommandBufferEnqueueExp(
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
/// - ::UR_RESULT_ERROR_INVALID_SIZE
ur_result_t UR_APICALL urUSMImportExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem, ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem, ///< [in] pointer to host memory object
size_t size ///< [in] size in bytes of the host memory object to be imported
) {
ur_result_t result = UR_RESULT_SUCCESS;
Expand All @@ -6075,8 +6075,8 @@ ur_result_t UR_APICALL urUSMImportExp(
/// + `NULL == pMem`
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
ur_result_t UR_APICALL urUSMReleaseExp(
ur_context_handle_t hContext, ///< [in] handle of the context object
void *pMem ///< [in] pointer to host memory object
const ur_context_handle_t hContext, ///< [in] handle of the context object
const void *pMem ///< [in] pointer to host memory object
) {
ur_result_t result = UR_RESULT_SUCCESS;
return result;
Expand Down