Reference collector: add object spilling for multiple static ITT parts and more #196
+187
−68
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ichepiga
approved these changes
Dec 23, 2025
| __itt_histogram* histogram_list; | ||
| } g_ref_collector_global = {MUTEX_INITIALIZER, 0, NULL, NULL, NULL, NULL}; | ||
|
|
||
| static char* log_file_name_generate() |
Contributor
There was a problem hiding this comment.
Maybe it is better to name it generate_log_file_name
Contributor
Author
There was a problem hiding this comment.
I agree but the current name follows the existing naming convention in this source file where verbs come at the end: ref_collector_init, ref_collector_release, fill_func_ptr_per_lib, etc. changing just this function would break consistency.
Contributor
Author
There was a problem hiding this comment.
just don't want to rename them all
| if (!g_ref_collector_global.mutex_initialized) return; | ||
|
|
||
| __itt_mutex_lock(&(g_itt_global->mutex)); | ||
| __itt_mutex_lock(&g_ref_collector_global.mutex); |
Contributor
There was a problem hiding this comment.
Is there any possibility that ref_collector_release will be called from different threads?
Contributor
Author
There was a problem hiding this comment.
by design, there's no multi-threaded scenario for this function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses frequent users requests about implementing custom ITT API collectors that properly handle all ITT objects in complex application scenarios. Two common challenges they face:
__itt_global*pointers with separate object lists. Without proper handling, a collector would miss ITT events from some static parts.To address these requests, we enhanced the reference collector with:
g_ref_collector_global). During__itt_api_init(), objects already present in each static part are "spilled" (copied) into the collector's lists viaspill_static_part_lists(). This ensures that all ITT objects across all static parts are aggregated into a single view and objects created before collector initialization are not missed.Changes:
g_ref_collector_globalstructure with collector-owned object listsspill_static_part_lists()to copy pre-existing objects from each static part during__itt_api_init()