Add code comment for handle_chaining in blockstore.rs #21876
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #21876 +/- ##
=======================================
Coverage 81.3% 81.3%
=======================================
Files 517 517
Lines 145586 145632 +46
=======================================
+ Hits 118445 118538 +93
+ Misses 27141 27094 -47 |
steviez
previously approved these changes
Dec 15, 2021
ledger/src/blockstore.rs
Outdated
| /// on the `SlotMetaWorkingSetEntry` of the specified `slot`. Specifically, | ||
| /// it handles the following two things: | ||
| /// | ||
| /// First, based on the `SlotMetaWorkingSetEntry` of the input `slot`, it it |
There was a problem hiding this comment.
nits:
- "of the input
slot" ==> "forslot" (putting inside the backticks implies it is the input parameter) - Extra "it" in this sentence, thinking the first one is supposed to be "if"?
- This first sentence is a tad long; you could maybe break it up into two (incorporating my previous comments)
- "First, based on the
SlotMetaWorkingSetEntryforslot, check ifslotdid not previously have a parent slot but does now." - "If
slotsatisfies this condition, update the Orphan property of bothslotand its parent slot based on their current orphan status."
- "First, based on the
ledger/src/blockstore.rs
Outdated
| /// slot, then it will update the Orphan property of both the slot and its | ||
| /// parent slot based on their current orphan status. | ||
| /// | ||
| /// Second, if the `SlotMetaWorkingSetEntry` of the input `slot` indicates this |
There was a problem hiding this comment.
nit: Similar to above, think you can drop "the input" and change "of" to "for"
==> "Second, if the SlotMetaWorkingSetEntry for slot indicates it is newly ..."
mergify
bot
dismissed
steviez’s stale review
Pull request has been modified.
carllin
reviewed
Dec 16, 2021
ledger/src/blockstore.rs
Outdated
| @@ -3454,7 +3454,23 @@ fn find_slot_meta_in_cached_state<'a>( | |||
| } | |||
| } | |||
|
|
|||
| // Chaining based on latest discussion here: https://github.com/solana-labs/solana/pull/2253 | |||
| /// For each entry in `working_set` whose did_insert_occur is true, this | |||
There was a problem hiding this comment.
nit: did_insert_occur -> did_insert_occur
carllin
reviewed
Dec 16, 2021
ledger/src/blockstore.rs
Outdated
| @@ -3454,7 +3454,23 @@ fn find_slot_meta_in_cached_state<'a>( | |||
| } | |||
| } | |||
|
|
|||
| // Chaining based on latest discussion here: https://github.com/solana-labs/solana/pull/2253 | |||
| /// For each entry in `working_set` whose did_insert_occur is true, this | |||
| /// function handle its chaining effect by updating the SlotMeta of both | |||
carllin
reviewed
Dec 16, 2021
ledger/src/blockstore.rs
Outdated
| // Chaining based on latest discussion here: https://github.com/solana-labs/solana/pull/2253 | ||
| /// For each entry in `working_set` whose did_insert_occur is true, this | ||
| /// function handle its chaining effect by updating the SlotMeta of both | ||
| /// the slot and its parent slot. In addition, when a slot is newly connected, |
There was a problem hiding this comment.
nit: the slot and its parent slot to reflect that the slot descends from the parent slot
carllin
reviewed
Dec 16, 2021
ledger/src/blockstore.rs
Outdated
Comment on lines
3499
to
3523
| /// First, based on the `SlotMetaWorkingSetEntry` for `slot`, check if `slot` | ||
| /// did not previously have a parent slot but does now. If `slot` satisfies | ||
| /// this condition, update the Orphan property of both `slot` and its parent | ||
| /// slot based on their current orphan status. | ||
| /// | ||
| /// Second, if the `SlotMetaWorkingSetEntry` for `slot` indicates this slot | ||
| /// is newly connected to a parent slot, then this function will update | ||
| /// the is_connected property of all its direct and indirect children slots. |
There was a problem hiding this comment.
Usually with lists in comments, I prefer using numbers like 1) and 2) to make it easier to read
carllin
reviewed
Dec 16, 2021
ledger/src/blockstore.rs
Outdated
| /// First, based on the `SlotMetaWorkingSetEntry` for `slot`, check if `slot` | ||
| /// did not previously have a parent slot but does now. If `slot` satisfies | ||
| /// this condition, update the Orphan property of both `slot` and its parent | ||
| /// slot based on their current orphan status. |
There was a problem hiding this comment.
"based on their current orphan status"
slot cannot be an orphan if it has a parent. So it might be clearer to say:
- updates the orphan property of
slotto no longer be an orphan because it has a parent - adds to parent to the orphan column family if the parent's parent is currently unknown
mergify
bot
dismissed
steviez’s stale review
Pull request has been modified.
steviez
reviewed
Dec 21, 2021
ledger/src/blockstore.rs
Outdated
| /// function handles its chaining effect by updating the SlotMeta of both | ||
| /// the slot and its parent slot to reflect the slot descends from the | ||
| /// parent slot. In addition, when a slot is newly connected, it also | ||
| /// checks whether any of its direct and indirect children slot is connected |
There was a problem hiding this comment.
nit: "children slot is" ==> "children slots are"
ledger/src/blockstore.rs
Outdated
| /// the slot and its parent slot to reflect the slot descends from the | ||
| /// parent slot. In addition, when a slot is newly connected, it also | ||
| /// checks whether any of its direct and indirect children slot is connected | ||
| /// ot not. |
ledger/src/blockstore.rs
Outdated
| /// slot based on their current orphan status. Specifically: | ||
| /// - updates the orphan property of slot to no longer be an orphan because | ||
| /// it has a parent. | ||
| /// - adds to parent to the orphan column family if the parent's parent is |
There was a problem hiding this comment.
nit: "adds to parent" ==> "adds the parent"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of Changes
Add code comment for handle_chaining in blockstore.rs