Skip to content
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

Make max_blobs_per_block a config parameter #6329

Open
wants to merge 11 commits into
base: unstable
Choose a base branch
from

Conversation

pawanjay176
Copy link
Member

Issue Addressed

N/A

Proposed Changes

Change max_blobs_per_block from a preset value to a config value. This affects a lot of the codebase where we have to use runtime variants of ssz List and Vector.

@pawanjay176 pawanjay176 marked this pull request as ready for review September 4, 2024 23:19
let (block, blobs_vec) =
generate_rand_block_and_blobs::<E>(ForkName::Deneb, NumBlobs::Random, &mut rng);
let mut blobs: FixedVector<_, <E as EthSpec>::MaxBlobsPerBlock> = FixedVector::default();
let max_len = spec.max_blobs_per_block(block.epoch()) as usize;
Copy link
Member

Choose a reason for hiding this comment

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

The epoch here will be random right?

Copy link
Member Author

Choose a reason for hiding this comment

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

We are using a fixed seed, so it'll be consistent across runs

@jimmygchen jimmygchen added the ready-for-review The code is ready for review label Oct 4, 2024
@jimmygchen jimmygchen self-assigned this Oct 4, 2024
Self {
block_root,
verified_blobs: FixedVector::default(),
// TODO(pawan): just make this a vec potentially
Copy link
Member

Choose a reason for hiding this comment

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

I think we can - this was previous an SSZ type because of overflow LRU cache and persisting to disk, but that's been dropped.

@@ -214,6 +262,85 @@ where
}
}

/// Emulates a SSZ `Vector`.
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't really cover SSZ encoding and decoding

@jimmygchen jimmygchen added the v6.0.0 New major release for hierarchical state diffs label Oct 9, 2024
@jimmygchen
Copy link
Member

I've just added the 6.0.0 label to this - I think it would be great if we can release this with the getBlobsV1 changes, as we're keen to get some data on blob count increase with the optimisation. Ideally this get merged relatively soon given the amount of files touched, however this is a nice to have, so we can drop this in favour of higher priority issues.

@jimmygchen jimmygchen added under-review A reviewer has only partially completed a review. and removed ready-for-review The code is ready for review labels Oct 9, 2024
}

pub fn set_max_len(&mut self, max_len: usize) {
self.max_len = Some(max_len);
Copy link
Member

Choose a reason for hiding this comment

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

probably should try to catch unexpected mutations after the max_len is already set, or only allow it to be set once (would OnceCell be an overkill for this?)

Copy link
Member

Choose a reason for hiding this comment

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

Actually this function is not used at all - maybe we could drop it? it feels like it could be a potential footgun

///
/// No mutating operation can be performed on an uninitialized instance
/// without first setting `max_len`.
pub fn empty_uninitialized() -> Self {
Copy link
Member

Choose a reason for hiding this comment

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

feels like this function is for convenience? the little downside is having to make max_len optional when it's known most of the time. But I guess the convenience is worth it if we don't need to mutate it all.

@@ -296,17 +296,24 @@ impl BlockId {
))
})?
} else {
BlobSidecarList::default()
BlobSidecarList::empty_uninitialized()
Copy link
Member

Choose a reason for hiding this comment

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

max_len is not specified here - i think it's not an issue since it's not encoded when BlobSidecarList is used as a standalone object

.map_err(|e| warp_utils::reject::custom_server_error(format!("{:?}", e)))?
if let Some(max_len) = list
.first()
.map(|sidecar| chain.spec.max_blobs_per_block(sidecar.epoch()))
Copy link
Member

Choose a reason for hiding this comment

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

we could use the block slot so we could avoid using first?

pub fn max_blobs_requested<E: EthSpec>(&self) -> u64 {
self.count.saturating_mul(E::max_blobs_per_block() as u64)
self.count.saturating_mul(MAX_BLOBS_PER_BLOCK_CEILING)
Copy link
Member

Choose a reason for hiding this comment

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

I think this may cause the node to hit the rate limit quicker because each range blob request will now consume max_blobs_requested tokens from the quota

/// bounds checking and other non-consensus critical operations.
///
/// For exact value, we should always check the chainspec.
pub const MAX_BLOBS_PER_BLOCK_CEILING: u64 = 16;
Copy link
Member

Choose a reason for hiding this comment

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

I think we could even go with a higher number if it's for non critical checks and preventing DOS, so we don't run into issues in upcoming upgrades and we don't have to frequently update this?

Copy link
Member

Choose a reason for hiding this comment

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

I thought about this for #6462, but as far as I understood this value may change per fork right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah it can change, but like i mentioned in the comment, it is to be used only for rate limiting and bounds checking of the incoming rpc request, so we can bump the number up in preparation for a fork

let max_len = if let Some(blob) = blobs.first() {
self.chain.spec.max_blobs_per_block(blob.epoch()) as usize
} else {
6
Copy link
Member

Choose a reason for hiding this comment

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

add_response only returns Some if all blob sidecars have been received, I think this may be unreachable? if we reach here it means add_response is buggy and might be worth doing some error handling?

BlobSidecarList::from_vec(blobs, max_blobs_per_block as usize)
} else {
// This always implies that there were no blobs for this block_root
BlobSidecarList::empty_uninitialized()
Copy link
Member

Choose a reason for hiding this comment

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

This is fine for now I think, but note it may break if we end up encoding this within another object like CacheItem or AvailableBlock (I don't see any use of encoding these rn)

@jimmygchen
Copy link
Member

We also need to move MAX_BLOBS_PER_BLOCK from presets to config YAML files.

Copy link
Member

@jimmygchen jimmygchen left a comment

Choose a reason for hiding this comment

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

I've added some comments, let me know what you think, thanks!

@jimmygchen jimmygchen added waiting-on-author The reviewer has suggested changes and awaits thier implementation. and removed under-review A reviewer has only partially completed a review. labels Oct 9, 2024
Copy link
Member

@jxs jxs left a comment

Choose a reason for hiding this comment

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

Hi Pawan, this is awesome, I wasn't aware of this PR but this is what I had in mind with #6462, left a comment

/// bounds checking and other non-consensus critical operations.
///
/// For exact value, we should always check the chainspec.
pub const MAX_BLOBS_PER_BLOCK_CEILING: u64 = 16;
Copy link
Member

Choose a reason for hiding this comment

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

I thought about this for #6462, but as far as I understood this value may change per fork right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v6.0.0 New major release for hierarchical state diffs waiting-on-author The reviewer has suggested changes and awaits thier implementation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants