LCOV - code coverage report
Current view: top level - disco/shred - fd_shredder.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 0 168 0.0 %
Date: 2026-11-11 12:40:43 Functions: 0 8 0.0 %

          Line data    Source code
       1             : #include "fd_shredder.h"
       2             : #include "../../ballet/shred/fd_shred.h"
       3             : 
       4             : void *
       5           0 : fd_shredder_new( void * mem ) {
       6           0 :   fd_shredder_t * shredder = (fd_shredder_t *)mem;
       7             : 
       8           0 :   if( FD_UNLIKELY( !mem ) ) {
       9           0 :     FD_LOG_WARNING(( "NULL shredder memory" ));
      10           0 :     return NULL;
      11           0 :   }
      12             : 
      13           0 :   if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)mem, fd_shredder_align() ) ) ) {
      14           0 :     FD_LOG_WARNING(( "misaligned shredder memory" ));
      15           0 :     return NULL;
      16           0 :   }
      17             : 
      18           0 :   shredder->shred_version = 0;
      19           0 :   shredder->entry_batch   = NULL;
      20           0 :   shredder->sz            = 0UL;
      21           0 :   shredder->offset        = 0UL;
      22             : 
      23           0 :   fd_memset( &(shredder->meta), 0, sizeof(fd_entry_batch_meta_t) );
      24           0 :   shredder->slot              = ULONG_MAX;
      25           0 :   shredder->data_idx_offset   = 0UL;
      26           0 :   shredder->parity_idx_offset = 0UL;
      27             : 
      28           0 :   FD_COMPILER_MFENCE();
      29           0 :   FD_VOLATILE( shredder->magic ) = FD_SHREDDER_MAGIC;
      30           0 :   FD_COMPILER_MFENCE();
      31             : 
      32           0 :   return (void *)shredder;
      33           0 : }
      34             : 
      35             : fd_shredder_t *
      36           0 : fd_shredder_join( void * mem ) {
      37           0 :   if( FD_UNLIKELY( !mem ) ) {
      38           0 :     FD_LOG_WARNING(( "NULL shredder memory" ));
      39           0 :     return NULL;
      40           0 :   }
      41             : 
      42           0 :   if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)mem, fd_shredder_align() ) ) ) {
      43           0 :     FD_LOG_WARNING(( "misaligned shredder memory" ));
      44           0 :     return NULL;
      45           0 :   }
      46             : 
      47           0 :   fd_shredder_t * shredder = (fd_shredder_t *)mem;
      48             : 
      49           0 :   if( FD_UNLIKELY( shredder->magic!=FD_SHREDDER_MAGIC ) ) {
      50           0 :     FD_LOG_WARNING(( "bad magic" ));
      51           0 :     return NULL;
      52           0 :   }
      53             : 
      54           0 :   return shredder;
      55           0 : }
      56             : 
      57             : void *
      58           0 : fd_shredder_leave(  fd_shredder_t * shredder ) {
      59           0 :   return (void *)shredder;
      60           0 : }
      61             : 
      62             : void *
      63           0 : fd_shredder_delete( void *          mem      ) {
      64           0 :   fd_shredder_t * shredder = (fd_shredder_t *)mem;
      65             : 
      66           0 :   if( FD_UNLIKELY( shredder->magic!=FD_SHREDDER_MAGIC ) ) {
      67           0 :     FD_LOG_WARNING(( "bad magic" ));
      68           0 :     return NULL;
      69           0 :   }
      70             : 
      71           0 :   FD_COMPILER_MFENCE();
      72           0 :   FD_VOLATILE( shredder->magic ) = 0UL;
      73           0 :   FD_COMPILER_MFENCE();
      74             : 
      75           0 :   return (void *)shredder;
      76           0 : }
      77             : 
      78             : 
      79             : fd_shredder_t *
      80             : fd_shredder_skip_batch( fd_shredder_t * shredder,
      81             :                         ulong           entry_batch_sz,
      82           0 :                         ulong           slot ) {
      83             : 
      84           0 :   if( FD_UNLIKELY( entry_batch_sz==0UL ) ) return NULL;
      85             : 
      86           0 :   if( FD_UNLIKELY( slot != shredder->slot ) ) {
      87           0 :     shredder->data_idx_offset   = 0UL;
      88           0 :     shredder->parity_idx_offset = 0UL;
      89           0 :   }
      90             : 
      91           0 :   ulong data_shred_cnt        =  fd_shredder_count_data_shreds(   entry_batch_sz );
      92           0 :   ulong parity_shred_cnt      =  fd_shredder_count_parity_shreds( entry_batch_sz );
      93             : 
      94           0 :   shredder->data_idx_offset   += data_shred_cnt;
      95           0 :   shredder->parity_idx_offset += parity_shred_cnt;
      96           0 :   shredder->slot              =  slot;
      97             : 
      98           0 :   return shredder;
      99           0 : }
     100             : 
     101             : 
     102             : fd_shredder_t *
     103             : fd_shredder_init_batch( fd_shredder_t *               shredder,
     104             :                         void const    *               entry_batch,
     105             :                         ulong                         entry_batch_sz,
     106             :                         ulong                         slot,
     107           0 :                         fd_entry_batch_meta_t const * metadata ) {
     108             : 
     109           0 :   if( FD_UNLIKELY( entry_batch_sz==0UL ) ) return NULL; /* FIXME: should this warn? Silently expand it to 1 byte? */
     110             : 
     111           0 :   shredder->entry_batch = entry_batch;
     112           0 :   shredder->sz          = entry_batch_sz;
     113           0 :   shredder->offset      = 0UL;
     114             : 
     115           0 :   if( FD_UNLIKELY( slot != shredder->slot ) ) {
     116           0 :     shredder->data_idx_offset   = 0UL;
     117           0 :     shredder->parity_idx_offset = 0UL;
     118           0 :   }
     119             : 
     120           0 :   shredder->slot = slot;
     121           0 :   shredder->meta = *metadata;
     122             : 
     123           0 :   return shredder;
     124           0 : }
     125             : 
     126             : 
     127             : fd_fec_set_t *
     128             : fd_shredder_next_fec_set( fd_shredder_t * shredder,
     129             :                           fd_fec_set_t *  result,
     130           0 :                           uchar *         chained_merkle_root ) {
     131           0 :   uchar const * entry_batch = shredder->entry_batch;
     132           0 :   ulong         offset      = shredder->offset;
     133           0 :   ulong         entry_sz    = shredder->sz;
     134             : 
     135           0 :   if( FD_UNLIKELY( (offset==entry_sz) ) ) return NULL;
     136             : 
     137           0 :   ulong entry_bytes_remaining = entry_sz - offset;
     138             : 
     139             :   /* Set the shred type */
     140           0 :   int block_complete = shredder->meta.block_complete==1;
     141           0 :   int is_chained     = 1;
     142             : 
     143           0 :   uchar data_type = FD_SHRED_TYPE_MERKLE_DATA_CHAINED;
     144           0 :   uchar code_type = FD_SHRED_TYPE_MERKLE_CODE_CHAINED;
     145             : 
     146             :   /* how many total payload bytes in this FEC set? */
     147           0 :   ulong chunk_size = fd_ulong_min( entry_bytes_remaining, FD_SHREDDER_CHAINED_FEC_SET_PAYLOAD_SZ  );
     148           0 :   ulong last_in_batch           = (chunk_size+offset==entry_sz);
     149           0 :   ulong adj_entry_sz            = offset+chunk_size;
     150             : 
     151           0 :   ulong data_shred_cnt          = FD_FEC_SHRED_CNT;
     152           0 :   ulong parity_shred_cnt        = FD_FEC_SHRED_CNT;
     153             :   /* Our notion of tree depth counts the root, while the shred version
     154             :      doesn't. */
     155           0 :   ulong tree_depth              = fd_bmtree_depth( data_shred_cnt+parity_shred_cnt )-1UL;
     156           0 :   ulong data_shred_payload_sz   = 1115UL - 20UL*tree_depth - 32UL*(ulong)is_chained;
     157           0 :   ulong parity_shred_payload_sz = data_shred_payload_sz + FD_SHRED_DATA_HEADER_SZ - FD_SHRED_SIGNATURE_SZ;
     158           0 :   ulong data_merkle_sz          = parity_shred_payload_sz + 32UL*(ulong)is_chained;
     159           0 :   ulong parity_merkle_sz        = data_merkle_sz + FD_SHRED_CODE_HEADER_SZ - FD_SHRED_SIGNATURE_SZ;
     160             : 
     161           0 :   fd_reedsol_t * reedsol = fd_reedsol_encode_init( shredder->reedsol, parity_shred_payload_sz );
     162             : 
     163             :   /* Write headers and copy the data shred payload */
     164           0 :   ulong flags_for_last = ((last_in_batch & (ulong)block_complete)<<7) | (last_in_batch<<6);
     165           0 :   for( ulong i=0UL; i<data_shred_cnt; i++ ) {
     166           0 :     fd_shred_t         * shred = result->data_shreds[ i ].s;
     167             : 
     168             :     /* Size in bytes of the payload section of this data shred,
     169             :        excluding any zero-padding */
     170           0 :     ulong shred_payload_sz = fd_ulong_min( adj_entry_sz-offset, data_shred_payload_sz );
     171             : 
     172           0 :     shred->variant            = fd_shred_variant( data_type, (uchar)tree_depth );
     173           0 :     shred->slot               = shredder->slot;
     174           0 :     shred->idx                = (uint  )(shredder->data_idx_offset + i);
     175           0 :     shred->version            = (ushort)(shredder->shred_version);
     176           0 :     shred->fec_set_idx        = (uint  )(shredder->data_idx_offset);
     177           0 :     shred->data.parent_off    = (ushort)(shredder->meta.parent_offset);
     178           0 :     shred->data.flags         = (uchar )(fd_ulong_if( i==data_shred_cnt-1UL, flags_for_last, 0UL ) | (shredder->meta.reference_tick & 0x3FUL));
     179           0 :     shred->data.size          = (ushort)(FD_SHRED_DATA_HEADER_SZ + shred_payload_sz);
     180             : 
     181           0 :     uchar * payload = fd_memcpy( result->data_shreds[ i ].b + FD_SHRED_DATA_HEADER_SZ , entry_batch+offset, shred_payload_sz );
     182           0 :     offset += shred_payload_sz;
     183             : 
     184             :     /* Write zero-padding, possibly a no-op */
     185           0 :     fd_memset( payload+shred_payload_sz, 0, data_shred_payload_sz-shred_payload_sz );
     186             : 
     187             :     /* Set the last bytes of the signature field to the Merkle tree
     188             :        prefix so we can use the faster batch sha256 API to compute the
     189             :        Merkle tree */
     190           0 :     fd_memcpy( shred->signature + 64UL - 26UL, "\x00SOLANA_MERKLE_SHREDS_LEAF", 26UL );
     191             : 
     192             :     /* Prepare to generate parity data: data shred starts right after
     193             :        signature and goes until start of Merkle proof. */
     194           0 :     fd_reedsol_encode_add_data_shred( reedsol, ((uchar*)shred) + sizeof(fd_ed25519_sig_t) );
     195             : 
     196             :     /* Set chained merkle root */
     197           0 :     uchar * merkle = ((uchar*)shred) + fd_shred_chain_off( shred->variant );
     198           0 :     memcpy( merkle, chained_merkle_root, FD_SHRED_MERKLE_ROOT_SZ );
     199           0 :   }
     200             : 
     201           0 :   for( ulong j=0UL; j<parity_shred_cnt; j++ ) {
     202           0 :     fd_shred_t        * shred = result->parity_shreds[ j ].s;
     203           0 :     shred->variant            = fd_shred_variant( code_type, (uchar)tree_depth );
     204           0 :     shred->slot               = shredder->slot;
     205           0 :     shred->idx                = (uint  )(shredder->parity_idx_offset + j);
     206           0 :     shred->version            = (ushort)(shredder->shred_version);
     207           0 :     shred->fec_set_idx        = (uint  )(shredder->data_idx_offset);
     208           0 :     shred->code.data_cnt      = (ushort)(data_shred_cnt);
     209           0 :     shred->code.code_cnt      = (ushort)(parity_shred_cnt);
     210           0 :     shred->code.idx           = (ushort)(j);
     211             : 
     212           0 :     fd_memcpy( shred->signature + 64UL - 26UL, "\x00SOLANA_MERKLE_SHREDS_LEAF", 26UL );
     213             : 
     214             :     /* Prepare to generate parity data: parity info starts right after
     215             :        signature and goes until start of Merkle proof. */
     216           0 :     fd_reedsol_encode_add_parity_shred( reedsol, result->parity_shreds[ j ].b + FD_SHRED_CODE_HEADER_SZ );
     217             : 
     218             :     /* Set chained merkle root */
     219           0 :     uchar * merkle = ((uchar*)shred) + fd_shred_chain_off( shred->variant );
     220           0 :     memcpy( merkle, chained_merkle_root, FD_SHRED_MERKLE_ROOT_SZ );
     221           0 :   }
     222             : 
     223             :   /* Generate parity data */
     224           0 :   fd_reedsol_encode_fini( reedsol );
     225             : 
     226             :   /* Generate Merkle leaves */
     227           0 :   fd_sha256_batch_t * sha256 = fd_sha256_batch_init( shredder->sha256 );
     228           0 :   fd_bmtree_node_t * leaves = shredder->bmtree_leaves;
     229             : 
     230           0 :   for( ulong i=0UL; i<data_shred_cnt; i++ )
     231           0 :     fd_sha256_batch_add( sha256, result->data_shreds[i].b+sizeof(fd_ed25519_sig_t)-26UL,   data_merkle_sz+26UL,   leaves[i].hash );
     232           0 :   for( ulong j=0UL; j<parity_shred_cnt; j++ )
     233           0 :     fd_sha256_batch_add( sha256, result->parity_shreds[j].b+sizeof(fd_ed25519_sig_t)-26UL, parity_merkle_sz+26UL, leaves[j+data_shred_cnt].hash );
     234           0 :   fd_sha256_batch_fini( sha256 );
     235             : 
     236             :   /* Generate Merkle Proofs */
     237           0 :   fd_bmtree_commit_t * bmtree = fd_bmtree_commit_init( shredder->_bmtree_footprint, FD_SHRED_MERKLE_NODE_SZ, FD_BMTREE_LONG_PREFIX_SZ, tree_depth+1UL );
     238           0 :   fd_bmtree_commit_append( bmtree, leaves, data_shred_cnt+parity_shred_cnt );
     239           0 :   uchar * root = fd_bmtree_commit_fini( bmtree );
     240             : 
     241             :   /* Write Merkle proofs; the caller signs the root */
     242           0 :   for( ulong i=0UL; i<data_shred_cnt; i++ ) {
     243           0 :     fd_shred_t * shred = result->data_shreds[ i ].s;
     244             : 
     245           0 :     uchar * merkle = result->data_shreds[ i ].b + fd_shred_merkle_off( shred );
     246           0 :     fd_bmtree_get_proof( bmtree, merkle, i );
     247           0 :   }
     248             : 
     249           0 :   for( ulong j=0UL; j<parity_shred_cnt; j++ ) {
     250           0 :     fd_shred_t * shred = result->parity_shreds[ j ].s;
     251             : 
     252           0 :     uchar * merkle = result->parity_shreds[ j ].b + fd_shred_merkle_off( shred );
     253           0 :     fd_bmtree_get_proof( bmtree, merkle, data_shred_cnt+j );
     254           0 :   }
     255             : 
     256           0 :   shredder->offset             = offset;
     257           0 :   shredder->data_idx_offset   += data_shred_cnt;
     258           0 :   shredder->parity_idx_offset += parity_shred_cnt;
     259             : 
     260           0 :   memcpy( chained_merkle_root, root, FD_SHRED_MERKLE_ROOT_SZ );
     261             : 
     262           0 :   return result;
     263           0 : }
     264             : 
     265           0 : fd_shredder_t * fd_shredder_fini_batch( fd_shredder_t * shredder ) {
     266           0 :   shredder->entry_batch = NULL;
     267           0 :   shredder->sz          = 0UL;
     268           0 :   shredder->offset      = 0UL;
     269             : 
     270           0 :   return shredder;
     271           0 : }

Generated by: LCOV version 1.14