Skip to content

Generic skeleton integration test#379

Open
ShoroukRamzy wants to merge 3 commits intoeclipse-score:mainfrom
Valeo-S-CORE-Organization:generic-skeleton-integration-test
Open

Generic skeleton integration test#379
ShoroukRamzy wants to merge 3 commits intoeclipse-score:mainfrom
Valeo-S-CORE-Organization:generic-skeleton-integration-test

Conversation

@ShoroukRamzy
Copy link
Copy Markdown
Contributor

@ShoroukRamzy ShoroukRamzy commented May 4, 2026

Overview

This PR significantly expands the integration testing suite by introducing tests for both Generic-Typed (type-erased Skeleton Provider with Strongly-Typed Proxy Consumer) and Generic-Generic (type-erased Skeleton Provider with type-erased Proxy Consumer) interactions.

This addresses this issue #261 and #311 by rigorously validating the underlying shared memory (SHM) communication mechanisms with various payload sizes (64, 32, 16, and 8 bytes) and configurations.

The tests strictly evaluate type-erased memory striding, boundary enforcements, and data integrity by spinning up a provider that sends 30 consecutive samples into a heavily constrained 5-slot ring buffer, forcing multiple buffer wrap-arounds.

Test Scope & Root Causes of Current Failures

Currently, all introduced test variants intentionally fail, successfully exposing critical bugs within the Generic skeleton implementation related to shared memory allocation and addressing. The failure modes depend on the payload size relative to std::max_align_t (which is assumed to be 32 bytes on the current architecture).

The identified root causes for these failures are:

1. Data Corruption (Expected: X, got: 0 or Y)

Affected Tests: All Generic-Generic interaction tests (64, 32, 8-byte payloads) and Generic-Typed tests with payloads > std::max_align_t (64-byte, 32-byte payloads).
Root Cause: The fundamental issue was an incorrect base pointer being returned for event data. The SkeletonMemoryManager::CreateGenericEventDataInCreatedSharedMemory and Skeleton::RegisterGeneric functions were erroneously returning a pointer to the EventDataStorage object itself, instead of the actual data buffer managed within that object (EventDataStorage::data()). This led both providers and consumers to miscalculate offsets, resulting in writes to unintended (often zero-initialized) memory locations and reads from those incorrect, zero-filled locations.

2. Boundary Check Crashes (Exit Code 134 - SIGABRT)

Affected Tests: Generic-Typed interaction tests with payloads < std::max_align_t (16-byte, 8-byte payloads).
Root Cause: This failure was caused by an incorrect capacity calculation for the shared memory array. The EventDataStorage's internal DynamicArray was being initialized with a capacity based on num_max_align_elements. For smaller payloads, this calculated capacity was often less than the numberOfSampleSlots specified in the configuration. When the consumer attempted to retrieve one beyond this physically undersized capacity, it resulted in out-of-bounds memory access, triggering assertions and process crashes.

@ShoroukRamzy
Copy link
Copy Markdown
Contributor Author

Hi @crimson11,
I will confirm the main reasons for the above two issues soon.

@ShoroukRamzy ShoroukRamzy force-pushed the generic-skeleton-integration-test branch from 2d0976f to fe72098 Compare May 5, 2026 08:06
@ShoroukRamzy ShoroukRamzy force-pushed the generic-skeleton-integration-test branch from fe72098 to 6dac63e Compare May 5, 2026 12:37
@ShoroukRamzy
Copy link
Copy Markdown
Contributor Author

Hi @crimson11, I will confirm the main reasons for the above two issues soon.

@crimson11, Done

@ShoroukRamzy ShoroukRamzy force-pushed the generic-skeleton-integration-test branch 2 times, most recently from b229be8 to 7b4392b Compare May 6, 2026 16:14
@ShoroukRamzy ShoroukRamzy force-pushed the generic-skeleton-integration-test branch from 7b4392b to 244d45c Compare May 6, 2026 16:52
@crimson11
Copy link
Copy Markdown
Contributor

I will have a look at it tomorrow!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants