[reshardingV3] State ShardUIdMapping - initial implementation #12084

staffik · 2024-09-12T11:04:55Z

Tracking issue: #12050

Summary

Currently the changes should be almost no-op, as we do not explicitly save anything to DBCol::ShardUIdMapping.
The only difference is that we make an additional read from DBCol::ShardUIdMapping column every time we access State column.
The main logic is in Store::get_impl_state().
These changes implement mapping for reads, writes will be handled in the next PR.

Changes:

Added DBCol::ShardUIdMapping that is initially empty and will be populated on future resharding events.
Slight refactor: only allow Store to create StoreUpdate.
Store::get_impl_state() - special get() implementation for the State column.

Next steps (see tracking issue #12050):

Use mapping for writes to db.
Handle copy_state_from_store in cold_storage.rs.
Integration.
State clean up (e.g. gc parent state when it is no longer referenced by any child).
Tests.

core/store/src/flat/store_helper.rs

core/store/src/cold_storage.rs

core/store/src/trie/mem/parallel_loader.rs

staffik · 2024-09-12T11:21:05Z

There is

scan_db_column(
    col: &str,
    lower_bound: Option<&[u8]>,
    upper_bound: Option<&[u8]>,
    store: Store)

and it might not be possible to scan child shard only.
It is only a debug tool and we probably would need to live with that.

codecov · 2024-09-12T11:40:55Z

Codecov Report

Attention: Patch coverage is 89.65517% with 6 lines in your changes missing coverage. Please review.

Project coverage is 71.70%. Comparing base (99ecfa4) to head (fee1c6a).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
core/store/src/lib.rs	85.71%	0 Missing and 4 partials ⚠️
core/store/src/adapter/trie_store.rs	83.33%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #12084   +/-   ##
=======================================
  Coverage   71.69%   71.70%           
=======================================
  Files         825      825           
  Lines      165834   165850   +16     
  Branches   165834   165850   +16     
=======================================
+ Hits       118902   118921   +19     
+ Misses      41751    41745    -6     
- Partials     5181     5184    +3

Flag	Coverage Δ
backward-compatibility	`0.17% <0.00%> (-0.01%)`	⬇️
db-migration	`0.17% <0.00%> (-0.01%)`	⬇️
genesis-check	`1.26% <0.00%> (-0.01%)`	⬇️
integration-tests	`38.87% <29.31%> (+0.03%)`	⬆️
linux	`71.39% <89.65%> (+0.01%)`	⬆️
linux-nightly	`71.28% <89.65%> (+0.01%)`	⬆️
macos	`54.19% <89.65%> (-0.06%)`	⬇️
pytests	`1.57% <0.00%> (-0.01%)`	⬇️
sanity-checks	`1.38% <0.00%> (-0.01%)`	⬇️
unittests	`65.37% <89.65%> (-0.01%)`	⬇️
upgradability	`0.21% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

core/primitives/src/shard_layout.rs

core/store/src/trie/shard_tries.rs

chain/chain/src/garbage_collection.rs

wacban

Looks good, I left a few comments!

core/store/src/cold_storage.rs

core/store/src/flat/store_helper.rs

core/store/src/trie/mem/parallel_loader.rs

core/store/src/trie/shard_tries.rs

core/store/src/trie/trie_storage.rs

chain/chain/src/runtime/mod.rs

staffik · 2024-09-24T15:27:30Z

core/store/src/lib.rs

@@ -337,6 +397,7 @@ impl Store {
    }

    pub fn iter_prefix<'a>(&'a self, col: DBCol, key_prefix: &'a [u8]) -> DBIterator<'a> {
+        assert!(col != DBCol::State, "can't iter prefix of State column");


Luckily, that is not currently used for State column

staffik · 2024-09-24T15:27:40Z

core/store/src/lib.rs

@@ -355,6 +418,7 @@ impl Store {
        col: DBCol,
        key_prefix: &'a [u8],
    ) -> impl Iterator<Item = io::Result<(Box<[u8]>, T)>> + 'a {
+        assert!(col != DBCol::State, "can't iter prefix ser of State column");


Luckily, that is not currently used for State column

staffik · 2024-09-24T15:27:55Z

core/store/src/lib.rs

@@ -595,6 +658,7 @@ impl StoreUpdate {
    /// Deletes the given key range from the database including `from`
    /// and excluding `to` keys.
    pub fn delete_range(&mut self, column: DBCol, from: &[u8], to: &[u8]) {
+        assert!(column != DBCol::State, "can't range delete State column");


Luckily, that is not currently used for State column

core/store/src/lib.rs

core/store/src/trie/shard_tries.rs

core/store/src/shard_uid_mapping.rs

core/store/src/trie/mem/parallel_loader.rs

core/store/src/lib.rs

core/store/src/shard_uid_mapping.rs

staffik · 2024-09-25T14:47:58Z

@wacban @shreyan-gupta I will go offline in a moment. Feel free to merge / take it over, I can continue moving it forward in 10 days.

shreyan-gupta · 2024-10-11T09:50:10Z

core/store/src/lib.rs

+    fn get_impl_state(&self, key: &[u8]) -> io::Result<Option<DBSlice<'_>>> {
+        let shard_uid = retrieve_shard_uid_from_db_key(key)?;
+        let mapped_shard_uid = self
+            .get_ser::<ShardUId>(DBCol::ShardUIdMapping, &shard_uid.to_bytes())?


Could we do the mapping in core/store/src/adapter/trie_store.rs ?

Having TrieStoreAdapter is now so nice :)

wacban

looks good overall

Can you add some test where you:
write and read some data
set the mapping
write and read some data using the old shard uid
write and read some data using the new shard uid (and check that it was mapped)

wacban · 2024-10-11T10:26:55Z

core/store/src/cold_storage.rs

@@ -186,6 +186,7 @@ fn copy_state_from_store(

        let Some(trie_changes) = trie_changes else { continue };
        for op in trie_changes.insertions() {
+            // TODO(reshardingV3) Handle shard_uid not mapped there


This todo will be tricky, we will need to be careful when adding and removing a mapping. It's good that you spotted it.

unrelated to this PR:
I wonder if we can keep the original shard uids when moving data to cold storage. This would keep the cold storage sharded (as it is today).

core/store/src/columns.rs

wacban · 2024-10-11T10:35:28Z

core/store/src/columns.rs

@@ -444,7 +450,8 @@ impl DBCol {
            | DBCol::StateChangesForSplitStates
            | DBCol::StateHeaders
            | DBCol::TransactionResultForBlock
-            | DBCol::Transactions => true,
+            | DBCol::Transactions
+            | DBCol::ShardUIdMapping => true,


Can you explain how will the mapping work on split storage nodes? I can't say if this is good or not without the full picture. For early MVP it doesn't matter too much so feel free to just leave a TODO here and proceed.

My understanding was we want to copy ShardUIdMapping to cold storage because cold_store.get(state_key) would not work otherwise. Marked it as TODO to understand it deeper after early MVP.

core/store/src/lib.rs

wacban · 2024-10-11T10:51:40Z

core/store/src/adapter/trie_store.rs

+        let mapped_shard_uid = self.read_shard_uid_mapping_from_db(shard_uid)?;
+        let key = get_key_from_shard_uid_and_hash(mapped_shard_uid, hash);


core/store/src/lib.rs

wacban · 2024-10-11T11:01:01Z

Ah I just saw your zulip post that the write path will be done separately, ignore my comment about testing it. Just have a look at my comments and fix the CI and we should be good to go.

wacban

LGTM, thanks!

The [previous PR](#12084) introduced mapping for read operations. This PR extends that functionality to write operations and adds some testing for State mapping. Following the [Zulip discussion](https://near.zulipchat.com/#narrow/stream/407288-core.2Fresharding/topic/State.20mapping/near/476959235), we decided to implement a panic inside the `TrieStoreUpdateAdapter` methods. Other strategies considered were: 1. Propagating the error instead of panicking: This was rejected because the error would need to be propagated through multiple layers that currently don't expect errors. Additionally, an error here would indicate a misconfiguration in the database, justifying the use of panic. 2. Performing the mapping later in `TrieStoreUpdateAdapter::commit()`: This would require iterating through all `DBOp`s, parsing each operation, extracting the `shard_uid` from the database key, mapping it, and re-encoding. This approach would make `TrieStoreUpdateAdapter` dependent on the internal workings of `DBTransaction`. Also, `StoreUpdate::merge()` makes me feel uneasy. --------- Co-authored-by: Waclaw Banasik <wacban@users.noreply.github.com>

staffik added the A-resharding Area: State resharding label Sep 12, 2024

staffik changed the title ~~[reshardingV3]~~ [reshardingV3] State ShardUIdMapping Sep 12, 2024

staffik commented Sep 12, 2024

View reviewed changes

core/store/src/flat/store_helper.rs Outdated Show resolved Hide resolved

staffik commented Sep 12, 2024

View reviewed changes

core/store/src/cold_storage.rs Outdated Show resolved Hide resolved

staffik commented Sep 12, 2024

View reviewed changes

core/store/src/trie/mem/parallel_loader.rs Outdated Show resolved Hide resolved

shreyan-gupta reviewed Sep 14, 2024

View reviewed changes

core/primitives/src/shard_layout.rs Outdated Show resolved Hide resolved

tayfunelmas reviewed Sep 16, 2024

View reviewed changes

core/store/src/trie/shard_tries.rs Outdated Show resolved Hide resolved

tayfunelmas reviewed Sep 16, 2024

View reviewed changes

chain/chain/src/garbage_collection.rs Outdated Show resolved Hide resolved

walnut-the-cat mentioned this pull request Sep 16, 2024

🔷 [Project Tracking] Resharding v3 #11881

Open

73 tasks

wacban reviewed Sep 17, 2024

View reviewed changes

staffik force-pushed the reshardingv3-state branch from 7d1841c to 85574b2 Compare September 19, 2024 09:23

staffik commented Sep 19, 2024

View reviewed changes

chain/chain/src/runtime/mod.rs Outdated Show resolved Hide resolved

staffik force-pushed the reshardingv3-state branch 2 times, most recently from 8a4ffea to be91b49 Compare September 24, 2024 13:06

staffik changed the title ~~[reshardingV3] State ShardUIdMapping~~ [reshardingV3] State ShardUIdMapping - initial implementation Sep 24, 2024

staffik marked this pull request as ready for review September 24, 2024 13:23

staffik requested a review from a team as a code owner September 24, 2024 13:23

staffik requested a review from wacban September 24, 2024 13:23

staffik mentioned this pull request Sep 24, 2024

[ReshardingV3] State #12050

Open

staffik requested review from tayfunelmas and shreyan-gupta September 24, 2024 14:25

staffik commented Sep 24, 2024

View reviewed changes

wacban reviewed Sep 24, 2024

View reviewed changes

core/store/src/lib.rs Outdated Show resolved Hide resolved

core/store/src/lib.rs Outdated Show resolved Hide resolved

shreyan-gupta reviewed Sep 25, 2024

View reviewed changes

staffik force-pushed the reshardingv3-state branch from eaf0e57 to 8fcc38a Compare October 11, 2024 09:13

staffik added 2 commits October 11, 2024 11:23

state mapping

1e67eb7

comments

d72b0c6

staffik added 7 commits October 11, 2024 11:23

fix test

961871d

fix test

b5fb4ed

fix test

80df67c

Save ShardUIdMapping to cold storage

519dd7c

fix test

395d9fe

Create ShardUIdMapping in NodeStorage

61d4642

addressing review comments

5d53a7c

staffik force-pushed the reshardingv3-state branch from 8fcc38a to c8da0e9 Compare October 11, 2024 09:23

Get rid of in-mem mapping

69ea15d

staffik force-pushed the reshardingv3-state branch from c8da0e9 to 69ea15d Compare October 11, 2024 09:26

shreyan-gupta reviewed Oct 11, 2024

View reviewed changes

staffik requested review from wacban and shreyan-gupta October 11, 2024 10:18

staffik added 2 commits October 11, 2024 12:20

refactor

ea4e511

Move shard_uid mapping to TrieStoreAdapter

606e4fb

wacban reviewed Oct 11, 2024

View reviewed changes

address review comments

fee1c6a

staffik requested a review from wacban October 11, 2024 13:19

wacban approved these changes Oct 11, 2024

View reviewed changes

staffik added this pull request to the merge queue Oct 11, 2024

Merged via the queue into master with commit 189222e Oct 11, 2024
29 of 30 checks passed

staffik deleted the reshardingv3-state branch October 11, 2024 14:28

staffik mentioned this pull request Oct 16, 2024

feat(resharding) - Resharding mapping state update #12232

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[reshardingV3] State ShardUIdMapping - initial implementation #12084

[reshardingV3] State ShardUIdMapping - initial implementation #12084

staffik commented Sep 12, 2024 •

edited

Loading

staffik commented Sep 12, 2024

codecov bot commented Sep 12, 2024 •

edited

Loading

wacban left a comment

staffik Sep 24, 2024

staffik Sep 24, 2024

staffik Sep 24, 2024

staffik commented Sep 25, 2024

shreyan-gupta Oct 11, 2024

staffik Oct 11, 2024

wacban left a comment

wacban Oct 11, 2024

wacban Oct 11, 2024

staffik Oct 11, 2024 •

edited

Loading

wacban Oct 11, 2024

wacban commented Oct 11, 2024

wacban left a comment

		let mapped_shard_uid = self.read_shard_uid_mapping_from_db(shard_uid)?;
		let key = get_key_from_shard_uid_and_hash(mapped_shard_uid, hash);

[reshardingV3] State ShardUIdMapping - initial implementation #12084

[reshardingV3] State ShardUIdMapping - initial implementation #12084

Conversation

staffik commented Sep 12, 2024 • edited Loading

Summary

Changes:

Next steps (see tracking issue #12050):

staffik commented Sep 12, 2024

codecov bot commented Sep 12, 2024 • edited Loading

Codecov Report

wacban left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

staffik commented Sep 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wacban left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

staffik Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wacban commented Oct 11, 2024

wacban left a comment

Choose a reason for hiding this comment

staffik commented Sep 12, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading

staffik Oct 11, 2024 •

edited

Loading