This repository has been archived by the owner on Jan 22, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
adds an optional encoding for serializing duplicate shreds #14362
Closed
Closed
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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 |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| use bincode::Options as _; | ||
| use flate2::{ | ||
| read::{DeflateDecoder, GzDecoder, ZlibDecoder}, | ||
| write::{DeflateEncoder, GzEncoder, ZlibEncoder}, | ||
| Compression, | ||
| }; | ||
| use serde::{de::DeserializeOwned, Serialize}; | ||
| use std::io::{Read, Write}; | ||
| use thiserror::Error; | ||
|
|
||
| #[derive(Deserialize, Serialize)] | ||
| enum Encoded { | ||
| Bincode(Vec<u8>), | ||
| Deflate(Vec<u8>), | ||
| Gzip(Vec<u8>), | ||
| Zlib(Vec<u8>), | ||
| Zstd(Vec<u8>), | ||
| } | ||
|
|
||
| #[derive(Clone, Copy)] | ||
| pub enum Options { | ||
| Bincode, | ||
| Deflate(Compression), | ||
| Gzip(Compression), | ||
| Zlib(Compression), | ||
| Zstd { level: i32 }, | ||
| } | ||
|
|
||
| #[derive(Debug, Error)] | ||
| pub enum Error { | ||
| #[error("io error")] | ||
| IoError(#[from] std::io::Error), | ||
| #[error("(de)serialization error")] | ||
| SerializationError(#[from] bincode::Error), | ||
| } | ||
|
|
||
| impl Encoded { | ||
| fn len(&self) -> usize { | ||
| match self { | ||
| Encoded::Bincode(bytes) => bytes.len(), | ||
| Encoded::Deflate(bytes) => bytes.len(), | ||
| Encoded::Gzip(bytes) => bytes.len(), | ||
| Encoded::Zlib(bytes) => bytes.len(), | ||
| Encoded::Zstd(bytes) => bytes.len(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn encode_zstd(data: &[u8], level: i32) -> std::io::Result<Vec<u8>> { | ||
| let mut buffer = Vec::with_capacity(data.len() * 2); | ||
| let mut encoder = zstd::stream::write::Encoder::new(&mut buffer, level)?; | ||
| encoder.write_all(data)?; | ||
| encoder.finish()?; | ||
| Ok(buffer) | ||
| } | ||
|
|
||
| macro_rules! encode { | ||
| ($encoder:ident, $bytes:ident, $compression:ident) => {{ | ||
| fn encode(data: &[u8], compression: Compression) -> std::io::Result<Vec<u8>> { | ||
| let mut buffer = Vec::with_capacity(data.len() * 2); | ||
| let mut encoder = $encoder::new(&mut buffer, compression); | ||
| encoder.write_all(data)?; | ||
| encoder.finish()?; | ||
| Ok(buffer) | ||
| } | ||
| encode(&$bytes[..], $compression).ok() | ||
| }}; | ||
| } | ||
|
|
||
| pub fn encode<T: Serialize>(obj: &T, options: Options) -> bincode::Result<Vec<u8>> { | ||
| let bytes = bincode::options().serialize(obj)?; | ||
| let encoded = match options { | ||
| Options::Bincode => None, | ||
| Options::Deflate(opts) => encode!(DeflateEncoder, bytes, opts).map(Encoded::Deflate), | ||
| Options::Gzip(opts) => encode!(GzEncoder, bytes, opts).map(Encoded::Gzip), | ||
| Options::Zlib(opts) => encode!(ZlibEncoder, bytes, opts).map(Encoded::Zlib), | ||
| Options::Zstd { level } => encode_zstd(&bytes, level).map(Encoded::Zstd).ok(), | ||
| }; | ||
| let encoded = match encoded { | ||
| Some(encoded) if encoded.len() < bytes.len() => encoded, | ||
| _ => Encoded::Bincode(bytes), | ||
| }; | ||
| bincode::options().serialize(&encoded) | ||
| } | ||
|
|
||
| pub fn decode<T: DeserializeOwned>( | ||
| bytes: &[u8], | ||
| limit: usize, // Limit maximum number of bytes decoded. | ||
| ) -> Result<T, Error> { | ||
| let encoded = bincode::options().deserialize_from(bytes)?; | ||
| let decoder: Box<dyn Read> = match &encoded { | ||
| Encoded::Bincode(bytes) => Box::new(&bytes[..]), | ||
| Encoded::Deflate(bytes) => Box::new(DeflateDecoder::new(&bytes[..])), | ||
| Encoded::Gzip(bytes) => Box::new(GzDecoder::new(&bytes[..])), | ||
| Encoded::Zlib(bytes) => Box::new(ZlibDecoder::new(&bytes[..])), | ||
| Encoded::Zstd(bytes) => Box::new(zstd::stream::read::Decoder::new(&bytes[..])?), | ||
| }; | ||
| Ok(bincode::options() | ||
| .with_limit(limit as u64) | ||
| .deserialize_from(decoder)?) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| pub(crate) mod tests { | ||
| use super::*; | ||
| use rand::Rng; | ||
| use solana_ledger::{ | ||
| blockstore_meta::DuplicateSlotProof, | ||
| entry::Entry, | ||
| shred::{Shred, Shredder}, | ||
| }; | ||
| use solana_sdk::{hash, pubkey::Pubkey, signature::Keypair, system_transaction}; | ||
| use std::sync::Arc; | ||
|
|
||
| pub fn new_rand_shred<R: Rng>( | ||
| rng: &mut R, | ||
| next_shred_index: u32, | ||
| shredder: &Shredder, | ||
| ) -> Shred { | ||
| let entries: Vec<_> = std::iter::repeat_with(|| { | ||
| let tx = system_transaction::transfer( | ||
| &Keypair::new(), // from | ||
| &Pubkey::new_unique(), // to | ||
| rng.gen(), // lamports | ||
| hash::new_rand(rng), // recent blockhash | ||
| ); | ||
| Entry::new( | ||
| &hash::new_rand(rng), // prev_hash | ||
| 1, // num_hashes, | ||
| vec![tx], // transactions | ||
| ) | ||
| }) | ||
| .take(5) | ||
| .collect(); | ||
| let (mut data_shreds, _coding_shreds, _last_shred_index) = shredder.entries_to_shreds( | ||
| &entries, | ||
| true, // is_last_in_slot | ||
| next_shred_index, | ||
| ); | ||
| data_shreds.swap_remove(0) | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_encode_round_trip() { | ||
| let mut rng = rand::thread_rng(); | ||
| let leader = Arc::new(Keypair::new()); | ||
| let (slot, parent_slot, fec_rate, reference_tick, version) = | ||
| (53084024, 53084023, 0.0, 0, 0); | ||
| let shredder = | ||
| Shredder::new(slot, parent_slot, fec_rate, leader, reference_tick, version).unwrap(); | ||
| let next_shred_index = rng.gen(); | ||
| let shred1 = new_rand_shred(&mut rng, next_shred_index, &shredder); | ||
| let shred2 = new_rand_shred(&mut rng, next_shred_index, &shredder); | ||
| let proof = DuplicateSlotProof { | ||
| shred1: shred1.payload, | ||
| shred2: shred2.payload, | ||
| }; | ||
| let options = vec![ | ||
| Options::Bincode, | ||
| Options::Deflate(Compression::default()), | ||
| Options::Deflate(Compression::best()), | ||
| Options::Gzip(Compression::default()), | ||
| Options::Gzip(Compression::best()), | ||
| Options::Zlib(Compression::default()), | ||
| Options::Zlib(Compression::best()), | ||
| Options::Zstd { level: 0 }, | ||
| Options::Zstd { level: 9 }, | ||
| ]; | ||
| for opts in options { | ||
| let bytes = encode(&proof, opts).unwrap(); | ||
| let other: DuplicateSlotProof = decode(&bytes[..], 4096).unwrap(); | ||
| assert_eq!(proof.shred1, other.shred1); | ||
| assert_eq!(proof.shred2, other.shred2); | ||
| } | ||
| } | ||
| } | ||
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
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.
Are these decoders hardened against zip-bomb-like behavior?
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.
I raised that question to the upstream package; and meanwhile, added a
limithere for number of bytes decoded.