-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[TieredStorage] Boundary check for get_account_offset() #34531
Merged
yhchiang-sol
merged 2 commits into
solana-labs:master
from
yhchiang-sol:ts-assert-get-acc-offset
Dec 21, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -110,16 +110,26 @@ impl IndexBlockFormat { | |
footer: &TieredStorageFooter, | ||
index_offset: IndexOffset, | ||
) -> TieredStorageResult<Offset> { | ||
match self { | ||
let offset = match self { | ||
Self::AddressAndBlockOffsetOnly => { | ||
let offset = footer.index_block_offset as usize | ||
debug_assert!(index_offset.0 < footer.account_entry_count); | ||
footer.index_block_offset as usize | ||
+ std::mem::size_of::<Pubkey>() * footer.account_entry_count as usize | ||
+ std::mem::size_of::<Offset>() * index_offset.0 as usize; | ||
let (account_offset, _) = get_pod::<Offset>(mmap, offset)?; | ||
|
||
Ok(*account_offset) | ||
+ std::mem::size_of::<Offset>() * index_offset.0 as usize | ||
} | ||
} | ||
}; | ||
|
||
debug_assert!( | ||
offset.saturating_add(std::mem::size_of::<Offset>()) | ||
<= footer.owners_block_offset as usize, | ||
"reading IndexOffset ({}) would exceed index block boundary ({}).", | ||
offset, | ||
footer.owners_block_offset, | ||
); | ||
|
||
let (account_offset, _) = get_pod::<Offset>(mmap, offset)?; | ||
|
||
Ok(*account_offset) | ||
} | ||
|
||
/// Returns the size of one index entry. | ||
|
@@ -266,4 +276,79 @@ mod tests { | |
.get_account_address(&mmap, &footer, IndexOffset(2)) | ||
.unwrap(); | ||
} | ||
|
||
#[test] | ||
#[should_panic(expected = "index_offset.0 < footer.account_entry_count")] | ||
fn test_get_account_offset_out_of_bounds() { | ||
let temp_dir = TempDir::new().unwrap(); | ||
let path = temp_dir | ||
.path() | ||
.join("test_get_account_offset_out_of_bounds"); | ||
|
||
let footer = TieredStorageFooter { | ||
account_entry_count: 100, | ||
index_block_format: IndexBlockFormat::AddressAndBlockOffsetOnly, | ||
..TieredStorageFooter::default() | ||
}; | ||
|
||
{ | ||
// we only writes a footer here as the test should hit an assert | ||
// failure before it actually reads the file. | ||
let file = TieredStorageFile::new_writable(&path).unwrap(); | ||
footer.write_footer_block(&file).unwrap(); | ||
} | ||
|
||
let file = OpenOptions::new() | ||
.read(true) | ||
.create(false) | ||
.open(&path) | ||
.unwrap(); | ||
let mmap = unsafe { MmapOptions::new().map(&file).unwrap() }; | ||
footer | ||
.index_block_format | ||
.get_account_offset::<HotAccountOffset>( | ||
&mmap, | ||
&footer, | ||
IndexOffset(footer.account_entry_count), | ||
) | ||
.unwrap(); | ||
} | ||
|
||
#[test] | ||
#[should_panic(expected = "would exceed index block boundary")] | ||
fn test_get_account_offset_exceeds_index_block_boundary() { | ||
let temp_dir = TempDir::new().unwrap(); | ||
let path = temp_dir | ||
.path() | ||
.join("test_get_account_offset_exceeds_index_block_boundary"); | ||
|
||
let footer = TieredStorageFooter { | ||
account_entry_count: 100, | ||
index_block_format: IndexBlockFormat::AddressAndBlockOffsetOnly, | ||
index_block_offset: 1024, | ||
// only holds one index entry | ||
owners_block_offset: 1024 + std::mem::size_of::<HotAccountOffset>() as u64, | ||
..TieredStorageFooter::default() | ||
}; | ||
|
||
{ | ||
// we only write a footer here as the test should hit an assert | ||
// failure before we actually read the file. | ||
let file = TieredStorageFile::new_writable(&path).unwrap(); | ||
footer.write_footer_block(&file).unwrap(); | ||
} | ||
|
||
let file = OpenOptions::new() | ||
.read(true) | ||
.create(false) | ||
.open(&path) | ||
.unwrap(); | ||
let mmap = unsafe { MmapOptions::new().map(&file).unwrap() }; | ||
// IndexOffset does not exceeds the account_entry_count but exceeds | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in #34546 |
||
// the index block boundary. | ||
footer | ||
.index_block_format | ||
.get_account_offset::<HotAccountOffset>(&mmap, &footer, IndexOffset(2)) | ||
.unwrap(); | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in #34546.