Skip to content

Add validation for a few image_desc_t members. #1118

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

Closed
wants to merge 1 commit into from
+36 −24
Closed

Add validation for a few image_desc_t members. #1118

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
8 changes: 6 additions & 2 deletions include/ur_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2466,8 +2466,8 @@ typedef struct ur_image_desc_t {
size_t arraySize; ///< [in] image array size
size_t rowPitch; ///< [in] image row pitch
size_t slicePitch; ///< [in] image slice pitch
uint32_t numMipLevel; ///< [in] number of MIP levels
uint32_t numSamples; ///< [in] number of samples
uint32_t numMipLevel; ///< [in] number of MIP levels, must be `0`
uint32_t numSamples; ///< [in] number of samples, must be `0`

} ur_image_desc_t;

Expand Down Expand Up @@ -2495,6 +2495,10 @@ typedef struct ur_image_desc_t {
/// - ::UR_RESULT_ERROR_INVALID_VALUE
/// - ::UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
/// + `pImageDesc && UR_MEM_TYPE_IMAGE1D_BUFFER < pImageDesc->type`
/// + `pImageDesc && pImageDesc->numMipLevel != 0`
/// + `pImageDesc && pImageDesc->numSamples != 0`
/// + `pImageDesc && pImageDesc->rowPitch != 0 && pHost == nullptr`
/// + `pImageDesc && pImageDesc->slicePitch != 0 && pHost == nullptr`
/// - ::UR_RESULT_ERROR_INVALID_IMAGE_SIZE
/// - ::UR_RESULT_ERROR_INVALID_OPERATION
/// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
Expand Down
8 changes: 6 additions & 2 deletions scripts/core/memory.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,10 @@ members:
desc: "[in] image slice pitch"
- type: uint32_t
name: numMipLevel
desc: "[in] number of MIP levels"
desc: "[in] number of MIP levels, must be `0`"
- type: uint32_t
name: numSamples
desc: "[in] number of samples"
desc: "[in] number of samples, must be `0`"
--- #--------------------------------------------------------------------------
type: function
desc: "Create an image object"
Expand Down Expand Up @@ -237,6 +237,10 @@ returns:
- $X_RESULT_ERROR_INVALID_VALUE
- $X_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR:
- "`pImageDesc && UR_MEM_TYPE_IMAGE1D_BUFFER < pImageDesc->type`"
- "`pImageDesc && pImageDesc->numMipLevel != 0`"
- "`pImageDesc && pImageDesc->numSamples != 0`"
- "`pImageDesc && pImageDesc->rowPitch != 0 && pHost == nullptr`"
- "`pImageDesc && pImageDesc->slicePitch != 0 && pHost == nullptr`"
- $X_RESULT_ERROR_INVALID_IMAGE_SIZE
- $X_RESULT_ERROR_INVALID_OPERATION
- $X_RESULT_ERROR_INVALID_HOST_PTR:
Expand Down
10 changes: 0 additions & 10 deletions source/adapters/cuda/memory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,16 +231,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urMemImageCreate(
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->type <= UR_MEM_TYPE_IMAGE1D_BUFFER,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->numMipLevel == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->numSamples == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
if (!pHost) {
UR_ASSERT(pImageDesc->rowPitch == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->slicePitch == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
}

ur_result_t Result = UR_RESULT_SUCCESS;

Expand Down
10 changes: 0 additions & 10 deletions source/adapters/hip/memory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,16 +328,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urMemImageCreate(
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->type <= UR_MEM_TYPE_IMAGE1D_BUFFER,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->numMipLevel == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->numSamples == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
if (!pHost) {
UR_ASSERT(pImageDesc->rowPitch == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
UR_ASSERT(pImageDesc->slicePitch == 0,
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR);
}

// We only support RBGA channel order
// TODO: check SYCL CTS and spec. May also have to support BGRA
Expand Down
16 changes: 16 additions & 0 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 @@ -1012,6 +1012,22 @@ __urdlllocal ur_result_t UR_APICALL urMemImageCreate(
return UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR;
}

if (pImageDesc && pImageDesc->numMipLevel != 0) {
return UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR;
}

if (pImageDesc && pImageDesc->numSamples != 0) {
return UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR;
}

if (pImageDesc && pImageDesc->rowPitch != 0 && pHost == nullptr) {
return UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR;
}

if (pImageDesc && pImageDesc->slicePitch != 0 && pHost == nullptr) {
return UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR;
}

if (pHost == NULL &&
(flags & (UR_MEM_FLAG_USE_HOST_POINTER |
UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0) {
Expand Down
4 changes: 4 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 @@ -1445,6 +1445,10 @@ ur_result_t UR_APICALL urContextSetExtendedDeleter(
/// - ::UR_RESULT_ERROR_INVALID_VALUE
/// - ::UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
/// + `pImageDesc && UR_MEM_TYPE_IMAGE1D_BUFFER < pImageDesc->type`
/// + `pImageDesc && pImageDesc->numMipLevel != 0`
/// + `pImageDesc && pImageDesc->numSamples != 0`
/// + `pImageDesc && pImageDesc->rowPitch != 0 && pHost == nullptr`
/// + `pImageDesc && pImageDesc->slicePitch != 0 && pHost == nullptr`
/// - ::UR_RESULT_ERROR_INVALID_IMAGE_SIZE
/// - ::UR_RESULT_ERROR_INVALID_OPERATION
/// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
Expand Down
4 changes: 4 additions & 0 deletions source/ur_api.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,6 +1242,10 @@ ur_result_t UR_APICALL urContextSetExtendedDeleter(
/// - ::UR_RESULT_ERROR_INVALID_VALUE
/// - ::UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
/// + `pImageDesc && UR_MEM_TYPE_IMAGE1D_BUFFER < pImageDesc->type`
/// + `pImageDesc && pImageDesc->numMipLevel != 0`
/// + `pImageDesc && pImageDesc->numSamples != 0`
/// + `pImageDesc && pImageDesc->rowPitch != 0 && pHost == nullptr`
/// + `pImageDesc && pImageDesc->slicePitch != 0 && pHost == nullptr`
/// - ::UR_RESULT_ERROR_INVALID_IMAGE_SIZE
/// - ::UR_RESULT_ERROR_INVALID_OPERATION
/// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
Expand Down