iox-#141 enable sanizier(-fsanitize=address)

[prasannabhat]

Pre-Review Checklist for the PR Author

1. Branch follows the naming format (iox-#123-this-is-a-branch)
2. Commits messages are according to this guideline
   • Commit messages have the issue ID (iox-#123 commit text)
   • Commit messages are signed (git commit -s)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
3. Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
4. Relevant issues are linked
5. Add sensible notes for the reviewer
6. All checks have passed
7. Assign PR to reviewer

Notes for Reviewer

What is done ?

• Support AddressSanitizer (all the flags described here, including builtin leak detection)
• Suppress known errors (blacklist files are stored under iceoryx_meta/sanitizer_blacklist)
• Support Sanitizer github workflow (Linux & Mac)
  • Known errors are suppressed
  • workflow fails (exits upon first error) upon detection any new errors, if its pattern doesnt match blacklist

Which components are sanitized?

• Sanitization is enabled for core components (iceoryx_posh & iceoryx_utils)
  However

Runtime interposition allows AddressSanitizer to find bugs in code that is not being recompiled

Next steps

• Sanization be enabled for components other than iceoryx_posh & iceoryx_utils ?
• Enable other sanitizers (e.g. ThreadSanitizer , MemorySanitizer)
• Analyse and fix (if needed) the known issues

More details on the sanitizer can be found here ( Clang , Google)

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Code according to our coding style and naming conventions
• Unit tests have been written for new behavior
• Public API changes are documented via doxygen
• Copyright owner are updated in the changed files
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

Post-review Checklist for the Eclipse Committer

1. All checkboxes in the PR checklist are checked or crossed out
2. Merge

References

• Closes Enable Sanitizer in Debug Build and Unit Tests #141

[elBoberido]

nice, you will make @elfenpiff quite happy with this

[dkroenke]

For resolving the memleaks in test_waitset.cpp do the following:
In Teardown extend the delete loop:

      for (auto s : m_subscriber)
        {
            delete s->m_portData;
            delete s;
        }

Add delete sut2; to line 115

[prasannabhat]

For resolving the memleaks in test_waitset.cpp do the following:
In Teardown extend the delete loop:

      for (auto s : m_subscriber)
        {
            delete s->m_portData;
            delete s;
        }

Add delete sut2; to line 115

Thanks for the hint @dkroenke.
Fixed this "low hanging fruit" :-)

[prasannabhat]

nice, you will make @elfenpiff quite happy with this

happiness doubled @elfenpiff 😉 (supported sanitization on macos as well)

[dkroenke]

The only thing left: there is one commit which has no iox tag in his name: 2183189

[prasannabhat]

The only thing left: there is one commit which has no iox tag in his name: 2183189

oops ..that got missed !
@dkroenke I have created issue #423 to analyse the errors. (will add the details later)

[elBoberido]

why not just putting the blacklist right to this file, then it works all the time?

[elBoberido]

there might be a beside missing right of right

[prasannabhat]

why not just putting the blacklist right to this file, then it works all the time?

This is the method suggested to suppress errors

there might be a beside missing right of right

I dint quite get that !

[elBoberido]

sorry, the comment was a bit confusing. I meant why not putting the blacklist files next to the IceoryxPlatform.cmake then it would also work when the components are build separately ... on the other side, then these files would need to be installed. Maybe it's better to just make the files obsolete is the short/mid term by fixing the issues.

[prasannabhat]

okay ..now I understand what you meant.
I am not sure how do I get the path to IceoryxPlatform.cmake (when this file is included in another cmake file)

[elBoberido]

another possibility would be to use file({WRITE | APPEND} <filename> <content>...) from cmake and create those files on the fly in e.g. CMAKE_BUILD_DIR. It's up to you if you want to do the hassle

[elBoberido]

another possibility would be to use file({WRITE | APPEND} <filename> <content>...) from cmake and create those files on the fly in e.g. CMAKE_BUILD_DIR. It's up to you if you want to do the hassle