Skip to content

Conversation

@elfenpiff
Copy link
Contributor

Notes for Reviewer

Pre-Review Checklist for the PR Author

  • Add sensible notes for the reviewer
  • PR title is short, expressive and meaningful
  • Consider switching the PR to a draft (Convert to draft)
    • as draft PR, the CI will be skipped for pushes
  • Relevant issues are linked in the References section
  • Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  • Commits messages are according to this guideline
    • Commit messages have the issue ID ([#123] Add posix ipc example)
    • Keep in mind to use the same email that was used to sign the Eclipse Contributor Agreement
  • Tests follow the best practice for testing
  • Changelog updated in the unreleased section including API breaking changes
  • Assign PR to reviewer
  • All checks have passed (except task-list-completed)

PR Reviewer Reminders

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

References

Closes #1331

@elfenpiff elfenpiff self-assigned this Jan 29, 2026
@elfenpiff elfenpiff force-pushed the iox2-1331-make-cleanupstate-zerocopysend branch from 32feb9d to 59b9cd3 Compare January 29, 2026 19:02
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes CleanupState zero-copy sendable by implementing the ZeroCopySend trait, as required for zero-copy inter-process communication. The changes involve type modifications and field reordering to ensure proper memory layout and platform-independent representation.

Changes:

  • Modified CleanupState to implement ZeroCopySend by adding #[repr(C)] and changing field types from usize to u64
  • Reordered fields in Channel, SafelyOverflowingIndexQueue, and IndexQueue structures for optimized memory layout
  • Updated changelog to reflect the implementation of ZeroCopySend for CleanupState

Reviewed changes

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

Show a summary per file
File Description
iceoryx2/src/node/mod.rs Added ZeroCopySend derive and #[repr(C)] to CleanupState, changed field types from usize to u64
iceoryx2-cal/src/zero_copy_connection/common.rs Reordered fields in Channel struct, moving state field before queues
iceoryx2-bb/lock-free/src/spsc/safely_overflowing_index_queue.rs Reordered fields in SafelyOverflowingIndexQueue for improved alignment
iceoryx2-bb/lock-free/src/spsc/index_queue.rs Reordered fields in IndexQueue for improved alignment
doc/release-notes/iceoryx2-unreleased.md Added changelog entry noting CleanupState implements ZeroCopySend
Comments suppressed due to low confidence (1)

doc/release-notes/iceoryx2-unreleased.md:53

  • The changelog entry should be moved from the "Refactoring" section to the "API Breaking Changes" section, as the type change from usize to u64 in CleanupState fields is a breaking API change. This affects: (1) Rust code that constructs CleanupState with struct literals, (2) Python FFI bindings that expose these fields as usize, and (3) any code that pattern matches on CleanupState. Additionally, the changelog should mention the binary layout changes in internal data structures (Channel, IndexQueue, SafelyOverflowingIndexQueue) which break compatibility with existing shared memory segments.
  [#1300](https://github.com/eclipse-iceoryx/iceoryx2/issues/1300)
* Replace `lazy_static` dependency with `LazyLock` from `std` in `std` builds or

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

@codecov
Copy link

codecov bot commented Jan 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.92%. Comparing base (8dc88e2) to head (dd6d304).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1332      +/-   ##
==========================================
- Coverage   77.95%   77.92%   -0.04%     
==========================================
  Files         406      406              
  Lines       38941    38941              
  Branches     1256     1256              
==========================================
- Hits        30356    30343      -13     
- Misses       7552     7565      +13     
  Partials     1033     1033              
Flag Coverage Δ
CPP 68.04% <ø> (ø)
Rust 77.77% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
iceoryx2-bb/lock-free/src/spsc/index_queue.rs 85.16% <ø> (ø)
...ck-free/src/spsc/safely_overflowing_index_queue.rs 94.58% <ø> (ø)
iceoryx2-cal/src/zero_copy_connection/common.rs 91.42% <ø> (-0.74%) ⬇️
iceoryx2/src/node/mod.rs 64.30% <ø> (ø)

... and 11 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@elfenpiff elfenpiff merged commit a92bea3 into eclipse-iceoryx:main Jan 30, 2026
43 checks passed
@elfenpiff elfenpiff deleted the iox2-1331-make-cleanupstate-zerocopysend branch January 30, 2026 07:58
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.

Make CleanupState for node cleanups zero copy send.

2 participants