vmware / vmware/splinterdb

Sanity-check input to merge_iterator_create

Open
#126 0 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

Yoni left the following FIXME at the top of merge_iterator_create:

389    // FIXME: [yfogel 2020-07-17] Add and call sanity check functions
390    //        (also sanity functions WHEN FIRST NEEDED for splinterconfig and
391    //         btree_config)

Look into whether this function needs its inputs checked more carefully, etc.

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 at merge_iterator_create and the FIXME around line 389. Inspect how its splinterconfig and btree_config inputs are used, and determine which sanity checks are required, including when they should first be called. Done means the validation scope is resolved and the relevant checks and coverage are added.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.