eclipse-iceoryx / iceoryx2

Eclipse iceoryx2™ - true zero-copy inter-process-communication in pure Rust
https://iceoryx.io
Apache License 2.0
1.03k stars 40 forks source link

[#436] Split up the sig handler into non fatal and fatal signals #448

Closed elfenpiff closed 1 month ago

elfenpiff commented 1 month ago

Notes for Reviewer

The SignalHandler registers in the beginning every signal to keep track of them so that the user can later acquire them via an internal atomic variable. The problem is, that by default it also registers SIGSEGV and other fatal signals. If such a signal is emitted in turns into an infinite loop where the signal callback is called.

This can be mitigated by splitting up the FetchableSignals into FatalFetchableSignals (e.g. SIGSEGV, ...) and NonFatalFetchableSignals (SIGINT, SIGUSR1 ... ). Certain operations are only allowed for NonFatalFetchableSignals, like acquiring the last signal that was emitted. Also the SignalHandler only registers NonFatalFetchableSignals by default so that the user can later acquire the signal that was emitted. For FatalFetchableSignals it would not make sense since then the callback of the signal is the last thing the program executes.

Pre-Review Checklist for the PR Author

  1. [x] Add sensible notes for the reviewer
  2. [x] PR title is short, expressive and meaningful
  3. [x] Relevant issues are linked in the References section
  4. [x] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  7. [x] Tests follow the best practice for testing
  8. [x] Changelog updated in the unreleased section including API breaking changes
  9. [x] Assign PR to reviewer
  10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

  1. [x] All open points are addressed and tracked via issues

References

Relates to #436

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 52.77778% with 17 lines in your changes missing coverage. Please review.

Project coverage is 78.93%. Comparing base (e9332a0) to head (9ebf521). Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
iceoryx2-bb/posix/src/signal.rs 52.77% 17 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/448/graphs/tree.svg?width=650&height=150&src=pr&token=FN3YFXTJCI&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/448?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) ```diff @@ Coverage Diff @@ ## main #448 +/- ## ========================================== - Coverage 79.01% 78.93% -0.09% ========================================== Files 196 196 Lines 23258 23283 +25 ========================================== + Hits 18378 18379 +1 - Misses 4880 4904 +24 ``` | [Files with missing lines](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/448?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) | Coverage Δ | | |---|---|---| | [iceoryx2-bb/posix/src/signal.rs](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/448?src=pr&el=tree&filepath=iceoryx2-bb%2Fposix%2Fsrc%2Fsignal.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx#diff-aWNlb3J5eDItYmIvcG9zaXgvc3JjL3NpZ25hbC5ycw==) | `74.72% <52.77%> (-4.79%)` | :arrow_down: | ... and [5 files with indirect coverage changes](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/448/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)