Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Fix state-db pinning #12927

Merged
merged 3 commits into from
Dec 14, 2022
Merged

Fix state-db pinning #12927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fed39d0
Pin all canonicalized blocks
arkpar Dec 13, 2022
4fc1229
Added a test
arkpar Dec 14, 2022
8b07d49
Docs
arkpar Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions client/db/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2002,6 +2002,7 @@ impl<Block: BlockT> sc_client_api::backend::Backend<Block> for Backend<Block> {
.map_err(sp_blockchain::Error::from_state_db)?;
Err(e)
} else {
self.storage.state_db.sync();
Ok(())
}
}
Expand Down
10 changes: 10 additions & 0 deletions client/state-db/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,10 @@ impl<BlockHash: Hash, Key: Hash, D: MetaDb> StateDbSync<BlockHash, Key, D> {
}
}

fn sync(&mut self) {
self.non_canonical.sync();
}

pub fn get<DB: NodeDb, Q: ?Sized>(
&self,
key: &Q,
Expand Down Expand Up @@ -573,6 +577,12 @@ impl<BlockHash: Hash, Key: Hash, D: MetaDb> StateDb<BlockHash, Key, D> {
self.db.write().unpin(hash)
}

/// Confirm that all changes made to commit sets are on disk. Allows for temporarily pinned
/// blocks to be released.
pub fn sync(&self) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe rename sync method with commit_cannonicals or something more related to commit_operation (commit_synch maybe).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went for a more general name. It basically means that the in-memory state is synchronized with the on-disk state.

self.db.write().sync()
}

/// Get a value from non-canonical/pruning overlay or the backing DB.
pub fn get<DB: NodeDb, Q: ?Sized>(
&self,
Expand Down
65 changes: 47 additions & 18 deletions client/state-db/src/noncanonical.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ pub struct NonCanonicalOverlay<BlockHash: Hash, Key: Hash> {
// would be deleted but kept around because block is pinned, ref counted.
pinned: HashMap<BlockHash, u32>,
pinned_insertions: HashMap<BlockHash, (Vec<Key>, u32)>,
last_canon_pinned: Option<BlockHash>,
pinned_canonincalized: Vec<BlockHash>,
}

#[cfg_attr(test, derive(PartialEq, Debug))]
Expand Down Expand Up @@ -226,7 +226,7 @@ impl<BlockHash: Hash, Key: Hash> NonCanonicalOverlay<BlockHash, Key> {
pinned: Default::default(),
pinned_insertions: Default::default(),
values,
last_canon_pinned: None,
pinned_canonincalized: Default::default(),
})
}

Expand Down Expand Up @@ -350,6 +350,18 @@ impl<BlockHash: Hash, Key: Hash> NonCanonicalOverlay<BlockHash, Key> {
self.last_canonicalized.as_ref().map(|&(_, n)| n)
}

/// Confirm that all changes made to commit sets are on disk. Allows for temporarily pinned
/// blocks to be released.
pub fn sync(&mut self) {
arkpar marked this conversation as resolved.
Show resolved Hide resolved
let mut pinned = std::mem::take(&mut self.pinned_canonincalized);
for hash in pinned.iter() {
self.unpin(hash)
}
pinned.clear();
Comment on lines +356 to +360
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
let mut pinned = std::mem::take(&mut self.pinned_canonincalized);
for hash in pinned.iter() {
self.unpin(hash)
}
pinned.clear();
self.pinned_canonincalized.drain(..).for_each(|h| self.unpin(h));

Copy link
Member Author

@arkpar arkpar Dec 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't work because drain iterator borrows &mut self and unpin requires &self

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, but the call to clear is also not really required.

// Reuse the same memory buffer
self.pinned_canonincalized = pinned;
}

/// Select a top-level root and canonicalized it. Discards all sibling subtrees and the root.
/// Add a set of changes of the canonicalized block to `CommitSet`
/// Return the block number of the canonicalized block
Expand All @@ -371,13 +383,9 @@ impl<BlockHash: Hash, Key: Hash> NonCanonicalOverlay<BlockHash, Key> {

// No failures are possible beyond this point.

// Unpin previously canonicalized block
if let Some(prev_hash) = self.last_canon_pinned.take() {
self.unpin(&prev_hash);
}
// Force pin canonicalized block so that it is no discarded immediately
self.pin(hash);
self.last_canon_pinned = Some(hash.clone());
self.pinned_canonincalized.push(hash.clone());

let mut discarded_journals = Vec::new();
let mut discarded_blocks = Vec::new();
Expand Down Expand Up @@ -720,16 +728,17 @@ mod tests {
let mut commit = CommitSet::default();
overlay.canonicalize(&h1, &mut commit).unwrap();
db.commit(&commit);
assert!(contains(&overlay, 5));
overlay.sync();
assert!(!contains(&overlay, 5));
assert!(contains(&overlay, 7));
assert_eq!(overlay.levels.len(), 1);
assert_eq!(overlay.parents.len(), 2);
assert_eq!(overlay.parents.len(), 1);
let mut commit = CommitSet::default();
overlay.canonicalize(&h2, &mut commit).unwrap();
assert!(!contains(&overlay, 5));
db.commit(&commit);
overlay.sync();
assert_eq!(overlay.levels.len(), 0);
assert_eq!(overlay.parents.len(), 1);
assert_eq!(overlay.parents.len(), 0);
assert!(db.data_eq(&make_db(&[1, 4, 6, 7, 8])));
}

Expand All @@ -746,8 +755,7 @@ mod tests {
let mut commit = CommitSet::default();
overlay.canonicalize(&h_1, &mut commit).unwrap();
db.commit(&commit);
// explicitly unpin last block
overlay.unpin(&h_1);
overlay.sync();
assert!(!contains(&overlay, 1));
}

Expand Down Expand Up @@ -834,9 +842,8 @@ mod tests {
// canonicalize 1. 2 and all its children should be discarded
let mut commit = CommitSet::default();
overlay.canonicalize(&h_1, &mut commit).unwrap();
// explicitly unpin last block
overlay.unpin(&h_1);
db.commit(&commit);
overlay.sync();
assert_eq!(overlay.levels.len(), 2);
assert_eq!(overlay.parents.len(), 6);
assert!(!contains(&overlay, 1));
Expand All @@ -856,8 +863,8 @@ mod tests {
// canonicalize 1_2. 1_1 and all its children should be discarded
let mut commit = CommitSet::default();
overlay.canonicalize(&h_1_2, &mut commit).unwrap();
overlay.unpin(&h_1_2);
db.commit(&commit);
overlay.sync();
assert_eq!(overlay.levels.len(), 1);
assert_eq!(overlay.parents.len(), 3);
assert!(!contains(&overlay, 11));
Expand All @@ -873,8 +880,8 @@ mod tests {
// canonicalize 1_2_2
let mut commit = CommitSet::default();
overlay.canonicalize(&h_1_2_2, &mut commit).unwrap();
overlay.unpin(&h_1_2_2);
db.commit(&commit);
overlay.sync();
assert_eq!(overlay.levels.len(), 0);
assert_eq!(overlay.parents.len(), 0);
assert!(db.data_eq(&make_db(&[1, 12, 122])));
Expand Down Expand Up @@ -958,6 +965,28 @@ mod tests {
assert!(!contains(&overlay, 1));
}

#[test]
fn pins_canonicalized() {
let mut db = make_db(&[]);

let (h_1, c_1) = (H256::random(), make_changeset(&[1], &[]));
let (h_2, c_2) = (H256::random(), make_changeset(&[2], &[]));

let mut overlay = NonCanonicalOverlay::<H256, H256>::new(&db).unwrap();
db.commit(&overlay.insert(&h_1, 1, &H256::default(), c_1).unwrap());
db.commit(&overlay.insert(&h_2, 2, &h_1, c_2).unwrap());

let mut commit = CommitSet::default();
overlay.canonicalize(&h_1, &mut commit).unwrap();
overlay.canonicalize(&h_2, &mut commit).unwrap();
assert!(contains(&overlay, 1));
assert!(contains(&overlay, 2));
db.commit(&commit);
overlay.sync();
assert!(!contains(&overlay, 1));
assert!(!contains(&overlay, 2));
}

#[test]
fn pin_keeps_parent() {
let mut db = make_db(&[]);
Expand Down Expand Up @@ -1019,8 +1048,8 @@ mod tests {

let mut commit = CommitSet::default();
overlay.canonicalize(&h21, &mut commit).unwrap(); // h11 should stay in the DB
overlay.unpin(&h21);
db.commit(&commit);
overlay.sync();
assert!(!contains(&overlay, 21));
}

Expand Down