Skip to content

improve error handling in Memory Provider API #1439

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
merged 1 commit into from
Jul 16, 2025
Merged

improve error handling in Memory Provider API #1439

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
90 changes: 76 additions & 14 deletions src/memory_provider.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ static umf_result_t CTL_SUBTREE_HANDLER(CTL_NONAME, by_handle)(
umf_ctl_index_utlist_t *indexes, const char *extra_name,
umf_ctl_query_type_t queryType, va_list args) {
(void)indexes, (void)source, (void)ctx;

umf_memory_provider_handle_t hProvider =
*(umf_memory_provider_handle_t *)indexes->arg;
hProvider->ops.ext_ctl(hProvider->provider_priv, /*unused*/ 0, extra_name,
arg, size, queryType, args);

return UMF_RESULT_SUCCESS;
}

Expand Down Expand Up @@ -135,36 +137,44 @@ void assignOpsExtDefaults(umf_memory_provider_ops_t *ops) {
if (!ops->ext_purge_lazy) {
ops->ext_purge_lazy = umfDefaultPurgeLazy;
}

if (!ops->ext_purge_force) {
ops->ext_purge_force = umfDefaultPurgeForce;
}

if (!ops->ext_allocation_split) {
ops->ext_allocation_split = umfDefaultAllocationSplit;
}

if (!ops->ext_allocation_merge) {
ops->ext_allocation_merge = umfDefaultAllocationMerge;
}

if (!ops->ext_ctl) {
ops->ext_ctl = umfDefaultCtlHandle;
}
}

void assignOpsIpcDefaults(umf_memory_provider_ops_t *ops) {
if (!ops->ext_get_ipc_handle_size) {
ops->ext_get_ipc_handle_size = umfDefaultGetIPCHandleSize;
}

if (!ops->ext_get_ipc_handle) {
ops->ext_get_ipc_handle = umfDefaultGetIPCHandle;
}

if (!ops->ext_put_ipc_handle) {
ops->ext_put_ipc_handle = umfDefaultPutIPCHandle;
}

if (!ops->ext_open_ipc_handle) {
ops->ext_open_ipc_handle = umfDefaultOpenIPCHandle;
}

if (!ops->ext_close_ipc_handle) {
ops->ext_close_ipc_handle = umfDefaultCloseIPCHandle;
}
if (!ops->ext_ctl) {
ops->ext_ctl = umfDefaultCtlHandle;
}
}

#define CHECK_OP(ops, fn) \
Expand Down Expand Up @@ -271,16 +281,20 @@ umf_result_t umfMemoryProviderAlloc(umf_memory_provider_handle_t hProvider,
size_t size, size_t alignment, void **ptr) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ptr != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

umf_result_t res =
hProvider->ops.alloc(hProvider->provider_priv, size, alignment, ptr);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t umfMemoryProviderFree(umf_memory_provider_handle_t hProvider,
void *ptr, size_t size) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

umf_result_t res = hProvider->ops.free(hProvider->provider_priv, ptr, size);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
Expand All @@ -291,12 +305,14 @@ umfMemoryProviderGetLastNativeError(umf_memory_provider_handle_t hProvider,
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ppMessage != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((pError != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

return hProvider->ops.get_last_native_error(hProvider->provider_priv,
ppMessage, pError);
}

void *umfMemoryProviderGetPriv(umf_memory_provider_handle_t hProvider) {
UMF_CHECK((hProvider != NULL), NULL);

return hProvider->provider_priv;
}

Expand All @@ -305,8 +321,10 @@ umfMemoryProviderGetRecommendedPageSize(umf_memory_provider_handle_t hProvider,
size_t size, size_t *pageSize) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((pageSize != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

umf_result_t res = hProvider->ops.get_recommended_page_size(
hProvider->provider_priv, size, pageSize);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
Expand All @@ -316,8 +334,10 @@ umfMemoryProviderGetMinPageSize(umf_memory_provider_handle_t hProvider,
const void *ptr, size_t *pageSize) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((pageSize != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

umf_result_t res = hProvider->ops.get_min_page_size(
hProvider->provider_priv, ptr, pageSize);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
Expand All @@ -326,15 +346,22 @@ umf_result_t umfMemoryProviderGetName(umf_memory_provider_handle_t hProvider,
const char **name) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((name != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hProvider->ops.get_name(hProvider->provider_priv, name);

umf_result_t res = hProvider->ops.get_name(hProvider->provider_priv, name);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t umfMemoryProviderPurgeLazy(umf_memory_provider_handle_t hProvider,
void *ptr, size_t size) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ptr != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

ASSERT(hProvider->ops.ext_purge_lazy);
umf_result_t res =
hProvider->ops.ext_purge_lazy(hProvider->provider_priv, ptr, size);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
Expand All @@ -343,15 +370,19 @@ umf_result_t umfMemoryProviderPurgeForce(umf_memory_provider_handle_t hProvider,
void *ptr, size_t size) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ptr != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

ASSERT(hProvider->ops.ext_purge_force);
umf_result_t res =
hProvider->ops.ext_purge_force(hProvider->provider_priv, ptr, size);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t
umfGetLastFailedMemoryProvider(umf_memory_provider_handle_t *provider) {
UMF_CHECK((provider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);

*provider = *umfGetLastFailedMemoryProviderPtr();
return UMF_RESULT_SUCCESS;
}
Expand All @@ -366,8 +397,10 @@ umfMemoryProviderAllocationSplit(umf_memory_provider_handle_t hProvider,
UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((firstSize < totalSize), UMF_RESULT_ERROR_INVALID_ARGUMENT);

ASSERT(hProvider->ops.ext_allocation_split);
umf_result_t res = hProvider->ops.ext_allocation_split(
hProvider->provider_priv, ptr, totalSize, firstSize);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
Expand All @@ -384,8 +417,10 @@ umfMemoryProviderAllocationMerge(umf_memory_provider_handle_t hProvider,
UMF_CHECK(((uintptr_t)highPtr - (uintptr_t)lowPtr < totalSize),
UMF_RESULT_ERROR_INVALID_ARGUMENT);

ASSERT(hProvider->ops.ext_allocation_merge);
umf_result_t res = hProvider->ops.ext_allocation_merge(
hProvider->provider_priv, lowPtr, highPtr, totalSize);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
Expand All @@ -395,8 +430,13 @@ umfMemoryProviderGetIPCHandleSize(umf_memory_provider_handle_t hProvider,
size_t *size) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((size != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hProvider->ops.ext_get_ipc_handle_size(hProvider->provider_priv,
size);

ASSERT(hProvider->ops.ext_get_ipc_handle_size);
umf_result_t res =
hProvider->ops.ext_get_ipc_handle_size(hProvider->provider_priv, size);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t
Expand All @@ -405,18 +445,29 @@ umfMemoryProviderGetIPCHandle(umf_memory_provider_handle_t hProvider,
void *providerIpcData) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ptr != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((size != 0), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((providerIpcData != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hProvider->ops.ext_get_ipc_handle(hProvider->provider_priv, ptr,
size, providerIpcData);

ASSERT(hProvider->ops.ext_get_ipc_handle);
umf_result_t res = hProvider->ops.ext_get_ipc_handle(
hProvider->provider_priv, ptr, size, providerIpcData);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t
umfMemoryProviderPutIPCHandle(umf_memory_provider_handle_t hProvider,
void *providerIpcData) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((providerIpcData != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hProvider->ops.ext_put_ipc_handle(hProvider->provider_priv,
providerIpcData);

ASSERT(hProvider->ops.ext_put_ipc_handle);
umf_result_t res = hProvider->ops.ext_put_ipc_handle(
hProvider->provider_priv, providerIpcData);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t
Expand All @@ -425,15 +476,26 @@ umfMemoryProviderOpenIPCHandle(umf_memory_provider_handle_t hProvider,
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((providerIpcData != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ptr != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hProvider->ops.ext_open_ipc_handle(hProvider->provider_priv,
providerIpcData, ptr);

ASSERT(hProvider->ops.ext_open_ipc_handle);
umf_result_t res = hProvider->ops.ext_open_ipc_handle(
hProvider->provider_priv, providerIpcData, ptr);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}

umf_result_t
umfMemoryProviderCloseIPCHandle(umf_memory_provider_handle_t hProvider,
void *ptr, size_t size) {
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((ptr != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hProvider->ops.ext_close_ipc_handle(hProvider->provider_priv, ptr,
size);
UMF_CHECK((size != 0), UMF_RESULT_ERROR_INVALID_ARGUMENT);

ASSERT(hProvider->ops.ext_close_ipc_handle);
umf_result_t res = hProvider->ops.ext_close_ipc_handle(
hProvider->provider_priv, ptr, size);

checkErrorAndSetLastProvider(res, hProvider);
return res;
}
8 changes: 5 additions & 3 deletions src/utils/utils_assert.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
*
* Copyright (C) 2023-2024 Intel Corporation
* Copyright (C) 2023-2025 Intel Corporation
*
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Expand All @@ -10,11 +10,13 @@
#ifndef UMF_ASSERT_H
#define UMF_ASSERT_H 1

#include "utils_log.h"
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>

#include "utils_common.h"
#include "utils_log.h"

#ifdef __cplusplus
extern "C" {
#endif
Expand Down Expand Up @@ -50,7 +52,7 @@ extern "C" {

#define UMF_CHECK(condition, errorStatus) \
do { \
if (!(condition)) { \
if (UNLIKELY(!(condition))) { \
LOG_FATAL("UMF check failed: " #condition " in %s", __func__); \
return errorStatus; \
} \
Expand Down
8 changes: 7 additions & 1 deletion src/utils/utils_common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,17 @@ typedef enum umf_purge_advise_t {

#define __TLS __declspec(thread)

#define LIKELY(x) (x)
#define UNLIKELY(x) (x)

#else /* Linux */

#define __TLS __thread

#endif /* _WIN32 */
#define LIKELY(x) __builtin_expect(!!(x), 1)
#define UNLIKELY(x) __builtin_expect(!!(x), 0)

#endif /* !_WIN32 */

// get the address of the given string in the environment variable (or NULL)
char *utils_env_var_get_str(const char *envvar, const char *str);
Expand Down
Loading