Port ITT API Reference Collector to cross-platform Windows and Linux build

[alexey-kireev]

No description provided.

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Ports the ITT API reference collector to build and run on both Windows and Linux, adding an automated smoke test to validate basic logging output.

Changes:

• Add CMake/buildall support for building ittnotify_refcol (and an optional smoke-test executable).
• Improve cross-platform behavior in the reference collector implementation (localtime handling, Windows wide-char entrypoints).
• Add CI smoke test job and update README build/usage instructions.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
src/ittnotify_refcol/tests/smoke_test.c	Adds a small executable that exercises task + metadata APIs to produce log output.
src/ittnotify_refcol/itt_refcol_impl.c	Adds cross-platform localtime handling and Windows wide-char API entrypoints.
src/ittnotify_refcol/README.md	Documents CMake-based build and Windows usage for the reference collector.
buildall.py	Adds CLI flags to enable building the reference collector and smoke tests via CMake.
CMakeLists.txt	Introduces CMake option/targets for the reference collector shared library and smoke tests.
.github/workflows/main.yml	Adds a new CI job to build and run the reference collector smoke test on Linux/Windows.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[eparshut]

I guess we could remove old Makefile as unused

[eparshut]

This is a bad idea with pass-through -D cmake option hack.
Let's split flow into two steps: buildall.py --refcol builds only the refcol library; then in CI call cmake --build <dir> --target refcol_smoke_test builds the test explicitly.

[eparshut]

I guess you can move this PR from draft into ready state

there are a few things left to do:

• add PR description
• polish reference collector readme
• update main repository readme
• update official documentation in /docs

[Copilot]

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (2)

src/ittnotify_refcol/itt_refcol_impl.c:321

• get_metadata_elements increments offset by the return value of snprintf, but snprintf returns the number of bytes that would have been written, which may be larger than the remaining buffer space. Once offset exceeds LOG_BUFFER_MAX_SIZE, subsequent LOG_BUFFER_MAX_SIZE - offset becomes negative/huge and can lead to out-of-bounds writes. Also, malloc isn't checked before *metadata_str = '\0'. Consider checking allocation and clamping/stopping appends when the buffer fills (or dynamically grow the buffer).

static char* get_metadata_elements(size_t size, __itt_metadata_type type, void* metadata)
{
    char* metadata_str = malloc(sizeof(char) * LOG_BUFFER_MAX_SIZE);
    *metadata_str = '\0';
    uint16_t offset = 0;

    switch (type)
    {
    case __itt_metadata_u64:
        for (uint16_t i = 0; i < size; i++)
            offset += snprintf(metadata_str + offset, LOG_BUFFER_MAX_SIZE - offset, "%" PRIu64 ";", ((uint64_t*)metadata)[i]);

src/ittnotify_refcol/itt_refcol_impl.c:855

• __itt_bind_context_metadata_to_counter has the same offset += snprintf(...) issue as get_metadata_elements: snprintf can return a value larger than the remaining space, causing offset to exceed LOG_BUFFER_MAX_SIZE and subsequent appends to use an invalid size. Clamp offset / stop appending once the buffer is full.

        char context_metadata[LOG_BUFFER_MAX_SIZE];
        context_metadata[0] = '\0';
        uint16_t offset = 0;
        for(size_t i=0; i<length; i++)
        {
            char* context_metadata_element = get_context_metadata_element(metadata[i].type, metadata[i].value);
            offset += snprintf(context_metadata + offset, LOG_BUFFER_MAX_SIZE - offset, "%s", context_metadata_element);
            free(context_metadata_element);