vmware / vmware/splinterdb

Fix all sanitizer warnings

Open
#187 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
732
Forks
67
PR merge metrics
No merged PRs in 30d

Description

I think we should try to fix all the clang sanitizer warnings.

There are currently a few handfuls of warnings from the integer sanitizer. Almost all are in the routing filter, which does lots of bit manipulation, so it might just be a matter of annotating them so clang ignores them.

The kvstore iterator also has a memory leak that does not look easy to resolve. Essentially, it appears that if you run an iterator to its end and then destroy it, it does not deallocate some memory. This can be discovered by running the tests with address sanitizer enabled.

Once we get to zero sanitizer warnings, we should consider adding sanitized runs to CI.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the tests with AddressSanitizer and IntegerSanitizer enabled, then separate the routing filter warnings from the kvstore iterator leak. Trace the iterator through its end-of-iteration and destruction paths, and inspect the routing filter's bit manipulation before deciding whether annotations are appropriate. Done means zero sanitizer warnings and a decision on adding sanitized runs to CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
ci-cd, testing-qa
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.