Skip to content

Add a Caliper thread id attribute #733

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
daboehme merged 3 commits into from
Mar 31, 2026
Merged

Add a Caliper thread id attribute #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
772de68
Add built-in thread id attribute
daboehme Mar 30, 2026
4d4e5ef
Add cali.thread_id to trace converter built-in thread ids
daboehme Mar 30, 2026
7cccd8b
Check for cali.thread_id in test_thread unit test
daboehme Mar 31, 2026
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
3 changes: 3 additions & 0 deletions include/caliper/Caliper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,9 @@ class Caliper : public CaliperMetadataAccessInterface
/// instance.
bool is_signal() const { return m_is_signal; };

/// \brief Return the Caliper object's thread id
uint64_t get_thread_id() const;

/// \brief Return \a true if this is a valid %Caliper instance.
operator bool () const;

Expand Down
1 change: 1 addition & 0 deletions python/cali2traceevent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ class CaliTraceEventConverter:

BUILTIN_TID_ATTRIBUTES = [
'omp.thread.id',
'cali.thread_id',
'pthread.id',
'rocm.agent',
'rocm.dst.agent'
Expand Down
23 changes: 20 additions & 3 deletions src/caliper/Caliper.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,10 @@ struct Caliper::ThreadData {
bool is_initial_thread;
bool stack_error;

uint64_t thread_id;

ThreadData(bool initial_thread = false)
: process_bb_count(-1), is_initial_thread(initial_thread), stack_error(false)
: process_bb_count(-1), is_initial_thread(initial_thread), stack_error(false), thread_id(0)
{}

~ThreadData()
Expand All @@ -267,7 +269,7 @@ struct Caliper::ThreadData {

void print_detailed_stats(std::ostream& os)
{
tree.print_statistics(os << "Releasing Caliper thread data: \n") << std::endl;
tree.print_statistics(os << "Releasing thread " << thread_id << '\n') << std::endl;
thread_blackboard.print_statistics(os << " Thread blackboard: ") << std::endl;
}

Expand Down Expand Up @@ -321,10 +323,14 @@ struct Caliper::GlobalData {
std::vector<ThreadData*> thread_data;
std::mutex thread_data_lock;

Attribute thread_id_attr;

// --- constructor

GlobalData(ThreadData* sT) : attribute_default_scope { CALI_ATTR_SCOPE_THREAD }, max_active_channels { 0 }
{
thread_data.reserve(128);

// put the attribute [name,type,prop] attributes in the map

Attribute name_attr = Attribute::make_attribute(sT->tree.node(Attribute::NAME_ATTR_ID));
Expand Down Expand Up @@ -401,6 +407,11 @@ struct Caliper::GlobalData {
init_attribute_classes(&c);
init_api_attributes(&c);

thread_id_attr = c.create_attribute("cali.thread_id", CALI_TYPE_UINT,
CALI_ATTR_SCOPE_THREAD | CALI_ATTR_SKIP_EVENTS | CALI_ATTR_ASVALUE);

c.set(thread_id_attr, cali_make_variant_from_uint(tObj.t_ptr->thread_id));

c.set(
c.create_attribute("cali.caliper.version", CALI_TYPE_STRING, CALI_ATTR_SKIP_EVENTS | CALI_ATTR_GLOBAL),
Variant(CALIPER_VERSION)
Expand All @@ -414,7 +425,7 @@ struct Caliper::GlobalData {
tObj.t_ptr = t;

std::lock_guard<std::mutex> g(thread_data_lock);

t->thread_id = thread_data.size();
thread_data.push_back(t);
return t;
}
Expand Down Expand Up @@ -1451,6 +1462,11 @@ void Caliper::finalize()
}
}

uint64_t Caliper::get_thread_id() const
{
return sT->thread_id;
}

//
// --- Caliper constructor & singleton API
//
Expand Down Expand Up @@ -1499,6 +1515,7 @@ Caliper Caliper::instance()
if (!tPtr) {
tPtr = gPtr->add_thread_data(new ThreadData(false /* is_initial_thread */));
Caliper c(gPtr, tPtr, false);
c.set(gPtr->thread_id_attr, cali_make_variant_from_uint(tPtr->thread_id));

for (auto& channel : gPtr->all_channels)
channel.mP->events.create_thread_evt(&c, &channel);
Expand Down
6 changes: 5 additions & 1 deletion test/ci_app_tests/test_basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ def test_thread(self):
self.assertTrue(cat.has_snapshot_with_attributes(
snapshots, { 'region' : 'main',
'local' : '99' }))
self.assertTrue(cat.has_snapshot_with_attributes(
snapshots, {'cali.thread_id' : '1',
'region' : 'thread_proc',
'global' : '999' }))

def test_createdir(self):
""" Test directory creation """
Expand Down Expand Up @@ -579,7 +583,7 @@ def test_log_verbose(self):
}

log_targets = [
'== CALIPER: Releasing Caliper thread data',
'== CALIPER: Releasing thread 0',
'Process blackboard',
'Thread blackboard',
'Metadata tree',
Expand Down
Loading