Skip to content

Commit

Permalink
[TieredStorage] Improve comments for HOT_ACCOUNT_ALIGNMENT (solana-la…
Browse files Browse the repository at this point in the history
…bs#34404)

#### Problem
The current naming and the code comments for HOT_ACCOUNT_OFFSET_ALIGNMENT
aren't really reflecting its role as pointed out in solana-labs#34335.

#### Summary of Changes
This PR renames HOT_ACCOUNT_OFFSET_ALIGNMENT to HOT_ACCOUNT_ALIGNMENT
as it's the hot account instead of hot account offset needs to be aligned.

In addition, improve the comment block for HOT_ACCOUNT_ALIGNMENT.
  • Loading branch information
yhchiang-sol committed Feb 13, 2024
1 parent 9da6a29 commit fa1726c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
26 changes: 13 additions & 13 deletions accounts-db/src/tiered_storage/hot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ const MAX_HOT_PADDING: u8 = 7;
/// The maximum allowed value for the owner index of a hot account.
const MAX_HOT_OWNER_OFFSET: OwnerOffset = OwnerOffset((1 << 29) - 1);

/// The alignment for HotAccountOffset. It is also a multiplier for converting
/// HotAccountOffset to the internal hot account offset that increases the maximum
/// size of a hot accounts file.
pub(crate) const HOT_ACCOUNT_OFFSET_ALIGNMENT: usize = 8;
/// The byte alignment for hot accounts. This alignment serves duo purposes.
/// First, it allows hot accounts to be directly accessed when the underlying
/// file is mmapped. In addition, as all hot accounts are aligned, it allows
/// each hot accounts file to handle more accounts with the same number of
/// bytes in HotAccountOffset.
pub(crate) const HOT_ACCOUNT_ALIGNMENT: usize = 8;

/// The maximum supported offset for hot accounts storage.
const MAX_HOT_ACCOUNT_OFFSET: usize = u32::MAX as usize * HOT_ACCOUNT_OFFSET_ALIGNMENT;
const MAX_HOT_ACCOUNT_OFFSET: usize = u32::MAX as usize * HOT_ACCOUNT_ALIGNMENT;

#[bitfield(bits = 32)]
#[repr(C)]
Expand Down Expand Up @@ -79,22 +81,20 @@ impl HotAccountOffset {
));
}

// Hot accounts are aligned based on HOT_ACCOUNT_OFFSET_ALIGNMENT.
if offset % HOT_ACCOUNT_OFFSET_ALIGNMENT != 0 {
// Hot accounts are aligned based on HOT_ACCOUNT_ALIGNMENT.
if offset % HOT_ACCOUNT_ALIGNMENT != 0 {
return Err(TieredStorageError::OffsetAlignmentError(
offset,
HOT_ACCOUNT_OFFSET_ALIGNMENT,
HOT_ACCOUNT_ALIGNMENT,
));
}

Ok(HotAccountOffset(
(offset / HOT_ACCOUNT_OFFSET_ALIGNMENT) as u32,
))
Ok(HotAccountOffset((offset / HOT_ACCOUNT_ALIGNMENT) as u32))
}

/// Returns the offset to the account.
fn offset(&self) -> usize {
self.0 as usize * HOT_ACCOUNT_OFFSET_ALIGNMENT
self.0 as usize * HOT_ACCOUNT_ALIGNMENT
}
}

Expand Down Expand Up @@ -553,7 +553,7 @@ pub mod tests {
.map(|address| AccountIndexWriterEntry {
address,
offset: HotAccountOffset::new(
rng.gen_range(0..u32::MAX) as usize * HOT_ACCOUNT_OFFSET_ALIGNMENT,
rng.gen_range(0..u32::MAX) as usize * HOT_ACCOUNT_ALIGNMENT,
)
.unwrap(),
})
Expand Down
4 changes: 2 additions & 2 deletions accounts-db/src/tiered_storage/index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ mod tests {
super::*,
crate::tiered_storage::{
file::TieredStorageFile,
hot::{HotAccountOffset, HOT_ACCOUNT_OFFSET_ALIGNMENT},
hot::{HotAccountOffset, HOT_ACCOUNT_ALIGNMENT},
},
memmap2::MmapOptions,
rand::Rng,
Expand All @@ -146,7 +146,7 @@ mod tests {
.map(|address| AccountIndexWriterEntry {
address,
offset: HotAccountOffset::new(
rng.gen_range(0..u32::MAX) as usize * HOT_ACCOUNT_OFFSET_ALIGNMENT,
rng.gen_range(0..u32::MAX) as usize * HOT_ACCOUNT_ALIGNMENT,
)
.unwrap(),
})
Expand Down

0 comments on commit fa1726c

Please sign in to comment.