trailofbits / trailofbits/ruzzy
Consider using __asan_default_options instead of ASAN_OPTIONS
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 120
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
ASan flags can be specified in a number of ways: https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags.
Currently, we use the ASAN_OPTIONS ENV variable in a number of places:
https://github.com/trailofbits/ruzzy/blob/be400457316933d607550580aa68f33e01ce16a3/README.md#L57-L70
The downside of this approach is that we require an additional step from users to export this ENV variable. If we use the __asan_default_options function in our source code, then that's one less step. We still need to confirm that ASAN_OPTIONS can overwrite __asan_default_options at runtime in case users need different options.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the ASAN configuration references in README.md and Dockerfile, then consult the linked AddressSanitizer runtime-flags documentation. Confirm how __asan_default_options interacts with ASAN_OPTIONS and identify the source entry point where the defaults belong. Done means the configuration no longer requires the documented export step while users can still override the defaults at runtime.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- devtools, testing-qa
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100