LCOV - code coverage report
Current view: top level - disco/shred - fd_shred_dest.c (source / functions) Hit Total Coverage
Test: cov.lcov Lines: 241 253 95.3 %
Date: 2026-03-31 06:22:16 Functions: 12 12 100.0 %

          Line data    Source code
       1             : #include "fd_shred_dest.h"
       2             : 
       3             : struct pubkey_to_idx {
       4             :   fd_pubkey_t key;
       5             :   ulong       idx;
       6             : };
       7             : typedef struct pubkey_to_idx pubkey_to_idx_t;
       8             : 
       9             : static const fd_pubkey_t null_pubkey = {{ 0 }};
      10             : 
      11             : #define MAP_NAME              pubkey_to_idx
      12   242330046 : #define MAP_T                 pubkey_to_idx_t
      13  8106608754 : #define MAP_KEY_T             fd_pubkey_t
      14   834201558 : #define MAP_KEY_NULL          null_pubkey
      15             : #define MAP_KEY_EQUAL_IS_SLOW 1
      16             : #define MAP_MEMOIZE           0
      17  8106608754 : #define MAP_KEY_INVAL(k)      MAP_KEY_EQUAL((k),MAP_KEY_NULL)
      18 15977382237 : #define MAP_KEY_EQUAL(k0,k1)  (!memcmp( (k0).key, (k1).key, 32UL ))
      19   241703118 : #define MAP_KEY_HASH(key,s)   ((MAP_HASH_T)( (key).ul[1] ))
      20             : 
      21             : #include "../../util/tmpl/fd_map_dynamic.c"
      22             : 
      23             : 
      24             : /* This 45 byte struct gets hashed to compute the seed for ChaCha to
      25             :    compute the shred destinations. */
      26             : struct __attribute__((packed)) shred_dest_input {
      27             :   ulong slot;
      28             :   uchar type; /*     Data = 0b1010_0101, Code = 0b0101_1010 */
      29             :   uint  idx;
      30             :   uchar leader_pubkey[32];
      31             : };
      32             : typedef struct shred_dest_input shred_dest_input_t;
      33             : 
      34             : ulong
      35      120612 : fd_shred_dest_footprint( ulong staked_cnt, ulong unstaked_cnt ) {
      36      120612 :   ulong cnt = staked_cnt+unstaked_cnt;
      37      120612 :   int lg_cnt = fd_ulong_find_msb( fd_ulong_pow2_up( 2UL*fd_ulong_max( cnt, 1UL ) ) );
      38      120612 :   return FD_LAYOUT_FINI( FD_LAYOUT_APPEND( FD_LAYOUT_APPEND( FD_LAYOUT_APPEND( FD_LAYOUT_APPEND( FD_LAYOUT_APPEND(
      39      120612 :                 FD_LAYOUT_INIT,
      40      120612 :                 fd_shred_dest_align(),             sizeof(fd_shred_dest_t)              ),
      41      120612 :                 pubkey_to_idx_align(),             pubkey_to_idx_footprint( lg_cnt )    ),
      42      120612 :                 alignof(fd_shred_dest_weighted_t), sizeof(fd_shred_dest_weighted_t)*cnt ),
      43      120612 :                 fd_wsample_align(),                fd_wsample_footprint( staked_cnt, 1 )),
      44      120612 :                 alignof(ulong),                    sizeof(ulong)*unstaked_cnt           ),
      45      120612 :       FD_SHRED_DEST_ALIGN );
      46      120612 : }
      47             : 
      48             : 
      49             : void *
      50             : fd_shred_dest_new( void                           * mem,
      51             :                    fd_shred_dest_weighted_t const * info,
      52             :                    ulong                            cnt,
      53             :                    fd_epoch_leaders_t const       * lsched,
      54             :                    fd_pubkey_t const              * source,
      55      313470 :                    ulong                            excluded_stake ) {
      56             : 
      57      313470 :   if( FD_UNLIKELY( !mem ) ) {
      58           3 :     FD_LOG_WARNING(( "NULL mem" ));
      59           3 :     return NULL;
      60           3 :   }
      61             : 
      62      313467 :   if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)mem, fd_shred_dest_align() ) ) ) {
      63           3 :     FD_LOG_WARNING(( "misaligned mem" ));
      64           3 :     return NULL;
      65           3 :   }
      66             : 
      67      313464 :   int lg_cnt = fd_ulong_find_msb( fd_ulong_pow2_up( 2UL*fd_ulong_max( cnt, 1UL ) ) );
      68      313464 :   FD_SCRATCH_ALLOC_INIT( footprint, mem );
      69      313464 :   fd_shred_dest_t * sdest;
      70      313464 :   /* */  sdest     = FD_SCRATCH_ALLOC_APPEND( footprint, fd_shred_dest_align(),             sizeof(fd_shred_dest_t)              );
      71      313464 :   void * _map      = FD_SCRATCH_ALLOC_APPEND( footprint, pubkey_to_idx_align(),             pubkey_to_idx_footprint( lg_cnt )    );
      72      313464 :   void * _info     = FD_SCRATCH_ALLOC_APPEND( footprint, alignof(fd_shred_dest_weighted_t), sizeof(fd_shred_dest_weighted_t)*cnt );
      73             : 
      74           0 :   ulong cnts[2] = { 0UL, 0UL }; /* cnts[0] = staked, cnts[1] = unstaked */
      75             : 
      76      313464 :   fd_shred_dest_weighted_t * copy = (fd_shred_dest_weighted_t *)_info;
      77   236148735 :   for( ulong i=0UL; i<cnt; i++ ) {
      78   235835271 :     copy[i] = info[i];
      79   235835271 :     ulong stake = info[i].stake_lamports;
      80             :     /* Check to make we never have a staked node following an unstaked
      81             :        node, which would mean info is not sorted properly. */
      82   235835271 :     if( FD_UNLIKELY( (stake>0UL) & (cnts[1]>0UL) ) ) {
      83           0 :       FD_LOG_WARNING(( "info was not sorted properly. info[%lu] has non-zero stake %lu but follows an unstaked node", i, stake ));
      84           0 :       return NULL;
      85           0 :     }
      86   235835271 :     cnts[ stake==0UL ]++;
      87   235835271 :   }
      88             : 
      89      313464 :   ulong staked_cnt   = cnts[0];
      90      313464 :   ulong unstaked_cnt = cnts[1];
      91             : 
      92      313464 :   if( FD_UNLIKELY( (excluded_stake>0UL) & (unstaked_cnt>0UL) ) ) {
      93             :     /* If excluded stake > 0, then the list must be filled with staked nodes. */
      94           0 :     FD_LOG_WARNING(( "cannot have excluded stake and unstaked validators" ));
      95           0 :     return NULL;
      96           0 :   }
      97             : 
      98      313464 :   void * _wsample  = FD_SCRATCH_ALLOC_APPEND( footprint, fd_wsample_align(), fd_wsample_footprint( staked_cnt, 1 ));
      99      313464 :   void * _unstaked = FD_SCRATCH_ALLOC_APPEND( footprint, alignof(ulong),     sizeof(ulong)*unstaked_cnt           );
     100             : 
     101             : 
     102      313464 :   fd_chacha_rng_t * rng = fd_chacha_rng_join( fd_chacha_rng_new( sdest->rng, FD_CHACHA_RNG_MODE_SHIFT ) );
     103             : 
     104      313464 :   void  *  _staked   = fd_wsample_new_init( _wsample,  rng, staked_cnt,   1, FD_WSAMPLE_HINT_POWERLAW_REMOVE );
     105             : 
     106   202928880 :   for( ulong i=0UL; i<staked_cnt;   i++ ) _staked   = fd_wsample_new_add( _staked,   info[i].stake_lamports );
     107      313464 :   _staked   = fd_wsample_new_fini( _staked, excluded_stake );
     108             : 
     109      313464 :   pubkey_to_idx_t * pubkey_to_idx_map = pubkey_to_idx_join( pubkey_to_idx_new( _map, lg_cnt, 0UL ) );
     110   236148735 :   for( ulong i=0UL; i<cnt; i++ ) {
     111             :     /* we should never have duplicates in info[i].pubkey, but in case
     112             :        of duplicates it's better to skip than to segfault. */
     113   235835271 :     pubkey_to_idx_t * inserted = pubkey_to_idx_insert( pubkey_to_idx_map, info[i].pubkey );
     114   235835271 :     if( FD_UNLIKELY( !inserted ) ) {
     115           0 :       continue;
     116           0 :     }
     117   235835271 :     inserted->idx = i;
     118   235835271 :   }
     119      313464 :   pubkey_to_idx_t * query = pubkey_to_idx_query( pubkey_to_idx_map, *source, NULL );
     120      313464 :   if( FD_UNLIKELY( !query ) ) {
     121          12 :     FD_LOG_WARNING(( "source pubkey not found" ));
     122          12 :     return NULL;
     123          12 :   }
     124             : 
     125      313452 :   memset( sdest->null_dest, 0, sizeof(fd_shred_dest_weighted_t) );
     126      313452 :   sdest->lsched                     = lsched;
     127      313452 :   sdest->cnt                        = cnt;
     128      313452 :   sdest->all_destinations           = copy;
     129      313452 :   sdest->staked                     = fd_wsample_join( _staked );
     130      313452 :   sdest->unstaked                   = _unstaked;
     131      313452 :   sdest->unstaked_unremoved_cnt     = 0UL; /* unstaked doesn't get initialized until it's needed */
     132      313452 :   sdest->staked_cnt                 = staked_cnt;
     133      313452 :   sdest->unstaked_cnt               = unstaked_cnt;
     134      313452 :   sdest->excluded_stake             = excluded_stake;
     135      313452 :   sdest->pubkey_to_idx_map          = pubkey_to_idx_map;
     136      313452 :   sdest->source_validator_orig_idx  = query->idx;
     137             : 
     138      313452 :   return (void *)sdest;
     139      313464 : }
     140             : 
     141      313464 : fd_shred_dest_t * fd_shred_dest_join( void * mem  ) { return (fd_shred_dest_t *)mem; }
     142      313224 : void * fd_shred_dest_leave( fd_shred_dest_t * sdest ) { return (void *)sdest;          }
     143             : 
     144      313224 : void * fd_shred_dest_delete( void * mem ) {
     145      313224 :   fd_shred_dest_t * sdest = (fd_shred_dest_t *)mem;
     146             : 
     147      313224 :   fd_chacha_rng_delete( fd_chacha_rng_leave( sdest->rng               ) );
     148      313224 :   fd_wsample_delete   ( fd_wsample_leave   ( sdest->staked            ) );
     149      313224 :   pubkey_to_idx_delete( pubkey_to_idx_leave( sdest->pubkey_to_idx_map ) );
     150      313224 :   return mem;
     151      313224 : }
     152             : 
     153             : /* sample_unstaked, sample_unstaked_noprepare, and
     154             :    prepare_unstaked_sampling are used to perform the specific form of
     155             :    unweighted random sampling that Solana uses for unstaked validators.
     156             :    In essence, you:
     157             :     1. construct a list of all the unstaked validators,
     158             :     2. delete the leader (if present)
     159             :     then repeatedly:
     160             :     3. choose the chacha_rng_roll( |unstaked| )th element.
     161             :     4. swap the last element in unstaked with the chosen element
     162             :     5. return and remove the chosen element (which is now in the last
     163             :     position, so remove is O(1)).
     164             :    Steps 1 and 2 are both O(|unstaked|), but they can be combined
     165             :    relatively easily if we wait to construct the list until we know
     166             :    which element we need to delete.  prepare_unstaked_sampling performs
     167             :    steps 1 and 2. sample_unstaked performs steps 3-5.  Thus, you must
     168             :    call prepare_unstaked_sampling prior to calling sample_unstaked.
     169             : 
     170             :    When only sampling a single element from the list, forming the whole
     171             :    array is wasteful; we just need to know whether the element we choose
     172             :    comes before or after the element we deleted.
     173             :    sample_unstaked_noprepare returns the same result as
     174             :    prepare_unstaked_sampling followed by one call to sample_unstaked.
     175             :    sample_unstaked_noprepare does not read or modify the unstaked array,
     176             :    so it can be called without calling prepare_unstaked_sampling.
     177             : 
     178             :    remove_idx is the index of the element to remove in step 2.  If it is
     179             :    not in [sdest->staked_cnt, sdest->staked_cnt+sdest->unstaked_cnt),
     180             :    then it will be ignored.  sample_unstaked and
     181             :    sample_unstaked_noprepare return the index into
     182             :    sdest->all_destinations of the selected sample.  The returned value
     183             :    will be in [sdest->staked_cnt, sdest->staked_cnt+sdest->unstaked_cnt)
     184             :    or FD_WSAMPLE_EMPTY. */
     185             : static inline ulong
     186             : sample_unstaked_noprepare( fd_shred_dest_t  * sdest,
     187          99 :                            ulong              remove_idx ) {
     188             :   /* is remove_idx in
     189             :      [sdest->staked_cnt, sdest->staked_cnt+sdest->unstaked_cnt) ? */
     190          99 :   int remove_in_interval = (sdest->staked_cnt <= remove_idx) & (remove_idx < (sdest->staked_cnt+sdest->unstaked_cnt) );
     191          99 :   ulong unstaked_cnt = sdest->unstaked_cnt - (ulong)remove_in_interval;
     192          99 :   if( FD_UNLIKELY( unstaked_cnt==0UL ) ) return FD_WSAMPLE_EMPTY;
     193             : 
     194          99 :   ulong sample = sdest->staked_cnt + fd_chacha_rng_ulong_roll( sdest->rng, unstaked_cnt );
     195          99 :   return fd_ulong_if( (!remove_in_interval) | (sample<remove_idx), sample, sample+1UL );
     196          99 : }
     197             : 
     198             : /* It's cheaper to initialize unstaked without the element we want to
     199             :    delete than to delete it after initializing, so we defer the
     200             :    initialization until we know who the leader is. */
     201             : static inline void
     202             : prepare_unstaked_sampling( fd_shred_dest_t  * sdest,
     203      136191 :                            ulong              remove_idx ) {
     204      136191 :   int remove_in_interval = (sdest->staked_cnt <= remove_idx) & (remove_idx < (sdest->staked_cnt+sdest->unstaked_cnt) );
     205      136191 :   ulong unstaked_cnt = sdest->unstaked_cnt - (ulong)remove_in_interval;
     206      136191 :   sdest->unstaked_unremoved_cnt = unstaked_cnt;
     207      136191 :   if( FD_UNLIKELY( unstaked_cnt==0UL ) ) return;
     208             : 
     209             :   /* If we had to remove something in the interval, we want to make sure
     210             :      it doesn't occur in the list of indices.  Otherwise just take them
     211             :      all. */
     212      130062 :   ulong direct_index_up_to = fd_ulong_if( remove_in_interval, remove_idx - sdest->staked_cnt, unstaked_cnt );
     213      130062 :   ulong i=0UL;
     214    10804059 :   for( ; i<direct_index_up_to; i++ ) sdest->unstaked[i] = i+sdest->staked_cnt;
     215      624657 :   for( ; i<unstaked_cnt;       i++ ) sdest->unstaked[i] = i+sdest->staked_cnt + 1UL;
     216      130062 : }
     217             : 
     218             : static inline ulong
     219    11027055 : sample_unstaked( fd_shred_dest_t * sdest ) {
     220    11027055 :   if( FD_UNLIKELY( sdest->unstaked_unremoved_cnt==0UL ) ) return FD_WSAMPLE_EMPTY;
     221             : 
     222    10909608 :   ulong sample = fd_chacha_rng_ulong_roll( sdest->rng, sdest->unstaked_unremoved_cnt );
     223    10909608 :   ulong to_return = sdest->unstaked[sample];
     224    10909608 :   sdest->unstaked[sample] = sdest->unstaked[--sdest->unstaked_unremoved_cnt];
     225    10909608 :   return to_return;
     226    11027055 : }
     227             : 
     228             : 
     229             : /* Returns 0 on success
     230             :    https://github.com/anza-xyz/agave/blob/v2.2.1/ledger/src/shred.rs#L293 */
     231             : static inline int
     232             : compute_seeds( fd_shred_dest_t           * sdest,
     233             :                fd_shred_t  const * const * input_shreds,
     234             :                ulong                       shred_cnt,
     235             :                fd_pubkey_t       const   * leader,
     236             :                ulong                       slot,
     237     1056747 :                uchar                       dest_hash_output[ FD_SHRED_DEST_MAX_SHRED_CNT ][ 32 ] ) {
     238             : 
     239     1056747 :   shred_dest_input_t dest_hash_inputs [ FD_SHRED_DEST_MAX_SHRED_CNT ];
     240     1056747 :   fd_sha256_batch_t * sha256 = fd_sha256_batch_init( sdest->_sha256_batch );
     241             : 
     242     2863494 :   for( ulong i=0UL; i<shred_cnt; i++ ) {
     243     1806747 :     shred_dest_input_t * h_in  = dest_hash_inputs+i;
     244     1806747 :     fd_shred_t const   * shred = input_shreds[i];
     245     1806747 :     if( FD_UNLIKELY( shred->slot != slot ) ) return -1;
     246             : 
     247     1806747 :     uchar shred_type = fd_shred_type( shred->variant );
     248     1806747 :     h_in->slot = slot;
     249     1806747 :     h_in->type = fd_uchar_if( fd_shred_is_data( shred_type ), 0xA5, 0x5A );
     250     1806747 :     h_in->idx  = shred->idx;
     251     1806747 :     memcpy( h_in->leader_pubkey, leader, 32UL );
     252             : 
     253     1806747 :     fd_sha256_batch_add( sha256, dest_hash_inputs+i,   sizeof(shred_dest_input_t), dest_hash_output[ i ] );
     254     1806747 :   }
     255     1056747 :   fd_sha256_batch_fini( sha256 );
     256     1056747 :   return 0;
     257     1056747 : }
     258             : 
     259             : 
     260             : fd_shred_dest_idx_t *
     261             : fd_shred_dest_compute_first( fd_shred_dest_t          * sdest,
     262             :                              fd_shred_t const * const * input_shreds,
     263             :                              ulong                      shred_cnt,
     264        5823 :                              fd_shred_dest_idx_t      * out ) {
     265             : 
     266        5823 :   if( FD_UNLIKELY( shred_cnt==0UL ) ) return out;
     267             : 
     268        5823 :   if( FD_UNLIKELY( sdest->cnt<=1UL ) ) {
     269             :     /* We are the only validator that we know about, and we can't send
     270             :        it to ourself, so there's nobody we can send the shred to. */
     271           0 :     for( ulong i=0UL; i<shred_cnt; i++ ) out[ i ] = FD_SHRED_DEST_NO_DEST;
     272           0 :     return out;
     273           0 :   }
     274             : 
     275        5823 :   uchar dest_hash_outputs[ FD_SHRED_DEST_MAX_SHRED_CNT ][ 32 ];
     276             : 
     277        5823 :   ulong slot = input_shreds[0]->slot;
     278        5823 :   fd_pubkey_t const * leader = fd_epoch_leaders_get( sdest->lsched, slot );
     279        5823 :   if( FD_UNLIKELY( !leader ) ) return NULL;
     280             : 
     281        5823 :   if( FD_UNLIKELY( compute_seeds( sdest, input_shreds, shred_cnt, leader, slot, dest_hash_outputs ) ) ) return NULL;
     282             : 
     283             :   /* If we're calling this, we must be the leader.  That means we had
     284             :      some stake when the leader schedule was created, but maybe not
     285             :      anymore?  This version of the code is safe either way, but I should
     286             :      probably confirm this can happen. */
     287        5823 :   int source_validator_is_staked = sdest->source_validator_orig_idx<sdest->staked_cnt;
     288        5823 :   if( FD_LIKELY( source_validator_is_staked ) )
     289        4161 :     fd_wsample_remove_idx( sdest->staked, sdest->source_validator_orig_idx );
     290             : 
     291        5823 :   int any_staked_candidates = sdest->staked_cnt > (ulong)source_validator_is_staked;
     292       11646 :   for( ulong i=0UL; i<shred_cnt; i++ ) {
     293        5823 :     fd_wsample_seed_rng( sdest->staked, dest_hash_outputs[ i ] );
     294             :     /* Map FD_WSAMPLE_INDETERMINATE to FD_SHRED_DEST_NO_DEST */
     295        5823 :     if( FD_LIKELY( any_staked_candidates ) ) out[i] = (fd_shred_dest_idx_t)fd_ulong_min( fd_wsample_sample( sdest->staked ), FD_SHRED_DEST_NO_DEST );
     296          99 :     else                                     out[i] = (fd_shred_dest_idx_t)sample_unstaked_noprepare( sdest, sdest->source_validator_orig_idx );
     297        5823 :   }
     298        5823 :   fd_wsample_restore_all( sdest->staked );
     299             : 
     300        5823 :   return out;
     301        5823 : }
     302             : 
     303             : fd_shred_dest_idx_t *
     304             : fd_shred_dest_compute_children( fd_shred_dest_t          * sdest,
     305             :                                 fd_shred_t const * const * input_shreds,
     306             :                                 ulong                      shred_cnt,
     307             :                                 fd_shred_dest_idx_t      * out,
     308             :                                 ulong                      out_stride,
     309             :                                 ulong                      fanout,
     310             :                                 ulong                      dest_cnt,
     311     1089225 :                                 ulong                    * opt_max_dest_cnt ) {
     312             : 
     313             :   /* The logic here is a little tricky since we are keeping track of
     314             :      staked and unstaked separately and only logically concatenating
     315             :      them [staked, unstaked] , but that does allow us to skip some
     316             :      samples sometimes.  We're operating from the source validator's
     317             :      perspective here, so everything in the first person singular refers
     318             :      to the source validator. */
     319             : 
     320     1089225 :   ulong my_orig_idx = sdest->source_validator_orig_idx;
     321     1089225 :   int   i_am_staked = my_orig_idx<sdest->staked_cnt;
     322             : 
     323     1089225 :   fd_ulong_store_if( !!opt_max_dest_cnt, opt_max_dest_cnt, 0UL );
     324             : 
     325     1089225 :   if( FD_UNLIKELY( (shred_cnt==0UL) | (dest_cnt==0UL) ) ) return out; /* Nothing to do */
     326             : 
     327     1089225 :   ulong               slot   = input_shreds[0]->slot;
     328     1089225 :   fd_pubkey_t const * leader = fd_epoch_leaders_get   ( sdest->lsched, slot );
     329     1089225 :   if( FD_UNLIKELY( !leader                 ) ) return NULL; /* Unknown slot */
     330             : 
     331     1089225 :   pubkey_to_idx_t *   query  = pubkey_to_idx_query( sdest->pubkey_to_idx_map, *leader, NULL );
     332     1089225 :   int                 leader_is_staked = query ? (query->idx<sdest->staked_cnt): 0;
     333     1089225 :   ulong               leader_idx       = query ?  query->idx                   : ULONG_MAX;
     334     1089225 :   if( FD_UNLIKELY( leader_idx==my_orig_idx ) ) return NULL; /* I am the leader. Use compute_first */
     335             : 
     336     1089225 :   if( FD_UNLIKELY( (sdest->cnt<=1UL) |                    /* We don't know about a single destination, so we can't send
     337             :                                                              anything. */
     338     1089225 :         ( (!i_am_staked) & (sdest->staked_cnt-(ulong)leader_is_staked>fanout) ) ) ) {
     339             :     /* My position is somewhere after all the staked nodes, which means
     340             :        my shuffled index is always greater than fanout.  That means I'm
     341             :        always at the bottom of the Turbine tree so I don't have to send
     342             :        any shreds to anyone. */
     343    19622568 :     for( ulong j=0UL; j<dest_cnt; j++ ) for( ulong i=0UL; i<shred_cnt; i++ ) out[ j*out_stride + i ] = FD_SHRED_DEST_NO_DEST;
     344       38301 :     return out;
     345       38301 :   }
     346             : 
     347     1050924 :   uchar dest_hash_outputs[ FD_SHRED_DEST_MAX_SHRED_CNT ][ 32 ];
     348             : 
     349             : 
     350     1050924 :   if( FD_UNLIKELY( compute_seeds( sdest, input_shreds, shred_cnt, leader, slot, dest_hash_outputs ) ) ) return NULL;
     351             : 
     352     1050924 :   ulong max_dest_cnt = 0UL;
     353             : 
     354     1050924 :   ulong staked_shuffle[ sdest->staked_cnt+1UL ];
     355     1050924 :   ulong staked_shuffle_populated_cnt = 0UL;
     356             : 
     357     2851848 :   for( ulong i=0UL; i<shred_cnt; i++ ) {
     358             :     /* Remove the leader. */
     359     1800924 :     if( FD_LIKELY( query && leader_is_staked ) ) fd_wsample_remove_idx( sdest->staked, leader_idx );
     360             : 
     361     1800924 :     ulong my_idx         = 0UL;
     362     1800924 :     fd_wsample_seed_rng( sdest->staked, dest_hash_outputs[ i ] ); /* Seeds both samplers since the rng is shared */
     363             : 
     364     1800924 :     if( FD_UNLIKELY( !i_am_staked ) ) {
     365             :       /* If there's excluded stake, we don't know about any unstaked
     366             :          validators, so if I am unstaked, then I'm in the excluded
     367             :          region, and we have no hope of computing my position in the
     368             :          shuffle. */
     369       37503 :       if( FD_UNLIKELY( sdest->excluded_stake>0UL ) ) return NULL;
     370             : 
     371             :       /* Quickly burn through all the staked nodes since I'll be in the
     372             :          unstaked portion.  We don't care about the values, but we need
     373             :          to advance the RNG the right number of times, and sadly there's
     374             :          no other way to do it than this. There can't be too many of
     375             :          them since otherwise we would have taken the quick exit at the
     376             :          start of the function. */
     377       37503 :       staked_shuffle_populated_cnt = sdest->staked_cnt + 1UL;
     378       37503 :       fd_wsample_sample_and_remove_many( sdest->staked, staked_shuffle, staked_shuffle_populated_cnt );
     379       37503 :       my_idx += sdest->staked_cnt - (ulong)(query && leader_is_staked);
     380             : 
     381       37503 :       prepare_unstaked_sampling( sdest, leader_idx );
     382      342495 :       while( my_idx <= fanout ) {
     383      325584 :         ulong sample = sample_unstaked( sdest );
     384      325584 :         if( FD_UNLIKELY( sample==my_orig_idx      ) ) break; /* Found me! */
     385      304992 :         if( FD_UNLIKELY( sample==FD_WSAMPLE_EMPTY ) ) return NULL; /* I couldn't find myself.  This should be impossible. */
     386      304992 :         my_idx++;
     387      304992 :       }
     388     1763421 :     } else {
     389     1763421 :       staked_shuffle_populated_cnt = fd_ulong_min( fanout+1UL, sdest->staked_cnt+1UL );
     390     1763421 :       fd_wsample_sample_and_remove_many( sdest->staked, staked_shuffle, staked_shuffle_populated_cnt );
     391   204332979 :       while( my_idx <= fanout ) {
     392             :         /* my_idx < fanout+1UL because of the while loop condition.
     393             :            my_idx < staked_cnt+1UL because my_idx==staked_cnt will
     394             :            trigger sample==FD_WSAMPLE_EMPTY below.  Thus, this access is
     395             :            safe. */
     396   203418723 :         ulong sample = staked_shuffle[ my_idx ];
     397   203418723 :         if( FD_UNLIKELY( sample==my_orig_idx              ) ) break; /* Found me! */
     398   202569558 :         if( FD_UNLIKELY( sample==FD_WSAMPLE_EMPTY         ) ) return NULL; /* I couldn't find myself.  This should be impossible. */
     399   202569558 :         if( FD_UNLIKELY( sample==FD_WSAMPLE_INDETERMINATE ) ) my_idx=ULONG_MAX-1UL; /* Hit poisoned region before myself. No
     400             :                                                                                        clue about position. Break immediately and
     401             :                                                                                        fill with NO_DEST below. */
     402   202569558 :         my_idx++;
     403   202569558 :       }
     404     1763421 :     }
     405             : 
     406     1800924 :     if( FD_LIKELY( my_idx > fanout ) ) {
     407             :       /* I'm at the bottom of Turbine tree for this shred.  Fill in all
     408             :          the destinations with NO_DEST. */
     409   189362067 :       for( ulong j=0UL; j<dest_cnt; j++ ) out[ j*out_stride + i ] = FD_SHRED_DEST_NO_DEST;
     410             : 
     411      931167 :       fd_wsample_restore_all( sdest->staked   );
     412      931167 :       continue; /* Next shred */
     413      931167 :     }
     414             :     /* If my index is    |  Send to indices
     415             :        ------------------------------------
     416             :         Leader (no idx)  |  0             (just for reference)
     417             :         0                |  1, 2, ..., F
     418             :         j in [1, F]      |  j + l*F for l in [1,F]
     419             :         [F+1, F^2+F]     |  Nobody
     420             :         [F^2+F+1, inf)   |  Not yet implemented in Agave code
     421             :      */
     422      869757 :     ulong last_dest_idx = fd_ulong_if( my_idx==0UL, fanout, my_idx+fanout*fanout ); /* inclusive */
     423      869757 :     ulong stride        = fd_ulong_if( my_idx==0UL, 1UL,    fanout               );
     424             : 
     425      869757 :     last_dest_idx = fd_ulong_min( last_dest_idx, my_idx + stride*dest_cnt );
     426             : 
     427      869757 :     ulong cursor     = my_idx+1UL;
     428      869757 :     ulong stored_cnt = 0UL;
     429             : 
     430      869757 :     if( FD_LIKELY( (last_dest_idx>=staked_shuffle_populated_cnt) & (staked_shuffle_populated_cnt<sdest->staked_cnt+1UL ) ) ) {
     431      404781 :       ulong adtl = fd_ulong_min( last_dest_idx+1UL, sdest->staked_cnt+1UL ) - staked_shuffle_populated_cnt;
     432             : 
     433      404781 :       fd_wsample_sample_and_remove_many( sdest->staked, staked_shuffle+staked_shuffle_populated_cnt, adtl );
     434      404781 :       staked_shuffle_populated_cnt += adtl;
     435      404781 :     }
     436             : 
     437    55716669 :     while( cursor<=fd_ulong_min( last_dest_idx, sdest->staked_cnt ) ) {
     438    54946137 :       ulong sample = staked_shuffle[ cursor ];
     439    54946137 :       if( FD_UNLIKELY( sample==FD_WSAMPLE_EMPTY         ) ) break;
     440    54849501 :       if( FD_UNLIKELY( sample==FD_WSAMPLE_INDETERMINATE ) ) break;
     441             : 
     442    54846912 :       if( FD_UNLIKELY( cursor == my_idx + stride*(stored_cnt+1UL) ) ) {
     443     3970464 :         out[ stored_cnt*out_stride + i ] = (ushort)sample;
     444     3970464 :         stored_cnt++;
     445     3970464 :       }
     446    54846912 :       cursor++;
     447    54846912 :     }
     448             :     /* If we broke from the above loop because of indeterminate, then
     449             :        unstaked_cnt==0, so the next loop will also be a no-op, and we'll
     450             :        fill the remaining array with NO_DEST, as desired. */
     451             : 
     452             :     /* Next set of samples (if any) come from the unstaked portion. If I
     453             :        am not staked, then prepare_unstaked_sampling was already called
     454             :        earlier. */
     455      869757 :     if( FD_LIKELY( (cursor<=last_dest_idx) & !!i_am_staked ) ) prepare_unstaked_sampling( sdest, leader_idx );
     456    11453781 :     while( cursor<=last_dest_idx ) {
     457    10701471 :       ulong sample = sample_unstaked( sdest );
     458    10701471 :       if( FD_UNLIKELY( sample==FD_WSAMPLE_EMPTY ) ) break;
     459             : 
     460    10584024 :       if( FD_UNLIKELY( cursor == my_idx + stride*(stored_cnt+1UL) ) ) {
     461       76692 :         out[ stored_cnt*out_stride + i ] = (ushort)sample;
     462       76692 :         stored_cnt++;
     463       76692 :       }
     464    10584024 :       cursor++;
     465    10584024 :     }
     466      869757 :     max_dest_cnt = fd_ulong_max( max_dest_cnt, stored_cnt );
     467             : 
     468             :     /* The rest of my destinations are past the end of the tree */
     469    27432753 :     for( ulong j=stored_cnt; j<dest_cnt; j++ ) out[ j*out_stride + i ] = FD_SHRED_DEST_NO_DEST;
     470             : 
     471      869757 :     fd_wsample_restore_all( sdest->staked );
     472             : 
     473      869757 :   }
     474     1050924 :   fd_ulong_store_if( !!opt_max_dest_cnt, opt_max_dest_cnt, max_dest_cnt );
     475     1050924 :   return out;
     476     1050924 : }
     477             : 
     478             : fd_shred_dest_idx_t
     479             : fd_shred_dest_pubkey_to_idx( fd_shred_dest_t   * sdest,
     480     4465158 :                              fd_pubkey_t const * pubkey     ) {
     481     4465158 :   if( FD_UNLIKELY( !memcmp( pubkey, null_pubkey.uc, 32UL ) ) ) return FD_SHRED_DEST_NO_DEST;
     482             : 
     483     4465158 :   pubkey_to_idx_t default_res[ 1 ] = {{ .idx = FD_SHRED_DEST_NO_DEST }};
     484     4465158 :   pubkey_to_idx_t * query = pubkey_to_idx_query( sdest->pubkey_to_idx_map, *pubkey, default_res );
     485             : 
     486     4465158 :   return (fd_shred_dest_idx_t)query->idx;
     487     4465158 : }
     488             : 

Generated by: LCOV version 1.14