Skip to content

Check if tracker is empty instead of clearing it #1104

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 2 commits into from
Feb 18, 2025
Merged

Check if tracker is empty instead of clearing it #1104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea10213
Check if tracker is empty instead of clearing it
ldorau Feb 18, 2025
997c917
Assert if tracking provider is not empty in DEBUG UMF_DEVELOPER_MODE
ldorau Feb 18, 2025
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
65 changes: 28 additions & 37 deletions src/provider/provider_tracking.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,10 +425,9 @@ static umf_result_t trackingInitialize(void *params, void **ret) {
return UMF_RESULT_SUCCESS;
}

// TODO clearing the tracker is a temporary solution and should be removed.
// The tracker should be cleared using the provider's free() operation.
static void clear_tracker_for_the_pool(umf_memory_tracker_handle_t hTracker,
umf_memory_pool_handle_t pool) {
#ifndef NDEBUG
static void check_if_tracker_is_empty(umf_memory_tracker_handle_t hTracker,
umf_memory_pool_handle_t pool) {
uintptr_t rkey;
void *rvalue;
size_t n_items = 0;
Expand All @@ -437,41 +436,34 @@ static void clear_tracker_for_the_pool(umf_memory_tracker_handle_t hTracker,
while (1 == critnib_find((critnib *)hTracker->alloc_segments_map, last_key,
FIND_G, &rkey, &rvalue)) {
tracker_alloc_info_t *value = (tracker_alloc_info_t *)rvalue;
if (value->pool != pool && pool != NULL) {
last_key = rkey;
continue;
if (value->pool == pool || pool == NULL) {
n_items++;
}

n_items++;

void *removed_value =
critnib_remove(hTracker->alloc_segments_map, rkey);
assert(removed_value == rvalue);
umf_ba_free(hTracker->alloc_info_allocator, removed_value);

last_key = rkey;
}

#ifndef NDEBUG
// print error messages only if provider supports the free() operation
if (n_items) {
if (pool) {
LOG_ERR(
"tracking provider of pool %p is not empty! (%zu items left)",
(void *)pool, n_items);
} else {
LOG_ERR("tracking provider is not empty! (%zu items left)",
n_items);
// Do not log the error if we are running in the proxy library,
// because it may need those resources till
// the very end of exiting the application.
if (!utils_is_running_in_proxy_lib()) {
if (pool) {
LOG_ERR("tracking provider of pool %p is not empty! (%zu items "
"left)",
(void *)pool, n_items);
} else {
LOG_ERR("tracking provider is not empty! (%zu items left)",
n_items);
}

#ifdef UMF_DEVELOPER_MODE
assert(n_items == 0 && "tracking provider is not empty!");
#endif
}
}
#else /* DEBUG */
(void)n_items; // unused in DEBUG build
#endif /* DEBUG */
}

static void clear_tracker(umf_memory_tracker_handle_t hTracker) {
clear_tracker_for_the_pool(hTracker, NULL);
}
#endif /* NDEBUG */

static void trackingFinalize(void *provider) {
umf_tracking_memory_provider_t *p =
Expand All @@ -481,12 +473,9 @@ static void trackingFinalize(void *provider) {

critnib_delete(p->ipcCache);

// Do not clear the tracker if we are running in the proxy library,
// because it may need those resources till
// the very end of exiting the application.
if (!utils_is_running_in_proxy_lib()) {
clear_tracker_for_the_pool(p->hTracker, p->pool);
}
#ifndef NDEBUG
check_if_tracker_is_empty(p->hTracker, p->pool);
#endif /* NDEBUG */

umf_ba_global_free(provider);
}
Expand Down Expand Up @@ -870,7 +859,9 @@ void umfMemoryTrackerDestroy(umf_memory_tracker_handle_t handle) {
return;
}

clear_tracker(handle);
#ifndef NDEBUG
check_if_tracker_is_empty(handle, NULL);
#endif /* NDEBUG */

// We have to zero all inner pointers,
// because the tracker handle can be copied
Expand Down
Loading