gossip: rx_push plumbing for get_prunes call

ravyu-jump · ravyu-jump · commit c77a97b03c6b · 2025-09-08T21:27:14.000Z
diff --git a/src/flamenco/gossip/fd_gossip.c b/src/flamenco/gossip/fd_gossip.c
@@ -600,6 +600,11 @@ process_push_crds( fd_gossip_t *                       gossip,
   return 0;
 }
 
+#define SORT_NAME        sort_pubkey
+#define SORT_KEY_T       uchar const *
+#define SORT_BEFORE(a,b) (memcmp(a,b,32UL) < 0)
+#include "../../util/tmpl/fd_sort.c"
+
 static void
 rx_push( fd_gossip_t *                 gossip,
          fd_gossip_view_push_t const * push,
@@ -608,8 +613,11 @@ rx_push( fd_gossip_t *                 gossip,
          fd_stem_context_t *           stem ) {
   uchar const * relayer_pubkey = payload+push->from_off;
   ulong relayer_stake          = get_stake( gossip, relayer_pubkey );
+  uchar const * origin_pubkeys[ FD_GOSSIP_MSG_MAX_CRDS ];
+
   for( ulong i=0UL; i<push->crds_values_len; i++ ) {
     uchar const * pubkey = payload+push->crds_values[ i ].pubkey_off;
+    origin_pubkeys[ i ] = pubkey;
     ulong         stake  = get_stake( gossip, pubkey );
 
     int err = process_push_crds( gossip, &push->crds_values[ i ], payload, pubkey, stake, now, stem );
@@ -623,6 +631,19 @@ rx_push( fd_gossip_t *                 gossip,
                               num_duplicates );
     }
   }
+
+  fd_prune_finder_prune_t const * prunes = NULL;
+  ulong                           prunes_cnt;
+  fd_prune_finder_get_prunes( gossip->prune_finder,
+                              gossip->identity_stake,
+                              origin_pubkeys,
+                              push->crds_values_len,
+                              &prunes,
+                              &prunes_cnt );
+
+  for( ulong i=0UL; i<prunes_cnt; i++ ) {
+    /* TODO: generate and send prune message */
+  }
 }
 
 static void
diff --git a/src/flamenco/gossip/fd_prune_finder.c b/src/flamenco/gossip/fd_prune_finder.c
@@ -446,12 +446,12 @@ prune_origin( fd_prune_finder_t * pf,
 }
 
 void
-fd_prune_finder_get_prunes( fd_prune_finder_t *         pf,
-                            ulong                       my_stake,
-                            uchar const * const *       origins,
-                            ulong                       origins_len,
-                            fd_prune_finder_prune_t **  out_prunes,
-                            ulong                   *   out_prunes_len ) {
+fd_prune_finder_get_prunes( fd_prune_finder_t *               pf,
+                            ulong                             my_stake,
+                            uchar const * const *             origins,
+                            ulong                             origins_len,
+                            fd_prune_finder_prune_t const **  out_prunes,
+                            ulong *                           out_prunes_len ) {
   /* Clear out current prunes map */
   for( ulong i=0UL; i<pf->prunes.count; i++ ) {
     fd_prune_finder_prune_t * p = prunes_pool_ele( pf->prunes.pool, i );
diff --git a/src/flamenco/gossip/fd_prune_finder.h b/src/flamenco/gossip/fd_prune_finder.h
@@ -125,15 +125,17 @@ fd_prune_finder_record( fd_prune_finder_t * pf,
 
 /* fd_prune_finder_get_prunes generates a list of out_prunes_len
    fd_prune_finder_prune_t entries in out_prunes. This should be called
-   at the end of every rx_push loop. out_prunes_len can be unbounded.
-
-   origins holds a unique list of pubkeys which should be considered
-   for pruning. All origins must have been recorded with
-   fd_prune_finder_record at least once since the last call to
-   fd_prune_finder_get_prunes. Since the maximum number of unique
-   origins that can be encountered during a single rx_push loop is
-   bounded by FD_GOSSIP_MSG_MAX_CRDS, origins_len should not exceed
-   that.
+   at the end of every push rx loop. out_prunes_len is bounded by
+   origins_len*relayer_max_per_origin (supplied in
+   fd_prune_finder_new).
+
+   origins holds a list of pubkeys which should be considered
+   for pruning. Duplicates are OK, and will be skipped.
+   All origins must have been recorded with fd_prune_finder_record at
+   least once since the last call to fd_prune_finder_get_prunes. Since
+   the maximum number of unique origins that can be encountered during
+   a single rx_push loop is bounded by FD_GOSSIP_MSG_MAX_CRDS,
+   origins_len should not exceed that.
 
    Origins that appear in any out_prunes entry will have their prune
    finder state reset. Therefore all prune messages must be
@@ -142,12 +144,12 @@ fd_prune_finder_record( fd_prune_finder_t * pf,
    call. */
 
 void
-fd_prune_finder_get_prunes( fd_prune_finder_t *         pf,
-                            ulong                       my_stake,
-                            uchar const * const *       origins,
-                            ulong                       origins_len,
-                            fd_prune_finder_prune_t **  out_prunes,
-                            ulong                   *   out_prunes_len );
+fd_prune_finder_get_prunes( fd_prune_finder_t *              pf,
+                            ulong                            my_stake,
+                            uchar const * const *            origins,
+                            ulong                            origins_len,
+                            fd_prune_finder_prune_t const ** out_prunes,
+                            ulong *                          out_prunes_len );
 
 FD_PROTOTYPES_END
 
diff --git a/src/flamenco/gossip/test_prune_finder.c b/src/flamenco/gossip/test_prune_finder.c
@@ -92,7 +92,7 @@ test_get_prunes_insufficient_upserts( void ) {
   }
 
   uchar const * origins[1] = { origin.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 1UL, &out_prunes, &out_prunes_len );
@@ -128,7 +128,7 @@ test_get_prunes_insufficient_ingress_nodes( void ) {
   }
 
   uchar const * origins[1] = { origin.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 1UL, &out_prunes, &out_prunes_len );
@@ -178,7 +178,7 @@ test_get_prunes_basic( void ) {
   fd_prune_finder_record( pf, origin.pubkey, origin.stake, good_relayer_1.pubkey, good_relayer_1.stake, 0UL );
 
   uchar const * origins[1] = { origin.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 1UL, &out_prunes, &out_prunes_len );
@@ -227,7 +227,7 @@ test_get_prunes_tiebreaker( void ) {
   }
 
   uchar const * origins[1] = { origin.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 1UL, &out_prunes, &out_prunes_len );
@@ -266,7 +266,7 @@ test_get_prunes_reset_origin( void ) {
   }
 
   uchar const * origins[1] = { origin.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 1UL, &out_prunes, &out_prunes_len );
@@ -301,6 +301,51 @@ test_get_prunes_reset_origin( void ) {
   free( bytes );
 }
 
+void
+test_get_prunes_duplicate_origins( void ) {
+  fd_rng_t _rng[1]; fd_rng_t * rng = fd_rng_join( fd_rng_new( _rng, 0U, 0UL ) );
+  FD_TEST( rng );
+
+  ulong origin_max = 16UL;
+  ulong relayer_max_per_origin = 8UL;
+
+  void * bytes = aligned_alloc( fd_prune_finder_align(), fd_prune_finder_footprint( origin_max, relayer_max_per_origin ) );
+  FD_TEST( bytes );
+
+  fd_prune_finder_t * pf = fd_prune_finder_join( fd_prune_finder_new( bytes, origin_max, relayer_max_per_origin, rng ) );
+  FD_TEST( pf );
+
+  test_peer_t origin = generate_random_peer( rng );
+  test_peer_t good_relayer_1 = generate_random_peer( rng );
+  test_peer_t good_relayer_2 = generate_random_peer( rng );
+  test_peer_t bad_relayer    = generate_random_peer( rng );
+
+  /* Record enough messages to trigger pruning */
+  for( ulong i=0UL; i<25UL; i++ ) {
+    fd_prune_finder_record( pf, origin.pubkey, origin.stake, good_relayer_1.pubkey, good_relayer_1.stake, 0UL );
+    fd_prune_finder_record( pf, origin.pubkey, origin.stake, good_relayer_2.pubkey, good_relayer_2.stake, 0UL );
+    /* Bad relayer gets duplicates (num_dups=2) */
+    fd_prune_finder_record( pf, origin.pubkey, origin.stake, bad_relayer.pubkey, bad_relayer.stake, 1UL );
+  }
+
+  /* add extra record for one of the good relayers since to avoid tiebreaker */
+  fd_prune_finder_record( pf, origin.pubkey, origin.stake, good_relayer_1.pubkey, good_relayer_1.stake, 0UL );
+
+  /* Pass in duplicate origins */
+  uchar const * origins[3] = { origin.pubkey, origin.pubkey, origin.pubkey };
+  fd_prune_finder_prune_t const * out_prunes;
+  ulong out_prunes_len;
+
+  fd_prune_finder_get_prunes( pf, 1000000UL, origins, 3UL, &out_prunes, &out_prunes_len );
+  /* Should generate prunes for the bad relayer */
+  FD_TEST( out_prunes_len == 1UL );
+  FD_TEST( !memcmp( out_prunes[0].relayer_pubkey.uc, bad_relayer.pubkey, 32UL ) );
+  FD_TEST( out_prunes[0].prune_len == 1UL );
+  FD_TEST( !memcmp( out_prunes[0].prunes[0].uc, origin.pubkey, 32UL ) );
+
+  free( bytes );
+}
+
 void
 test_relayer_eviction( void ) {
   fd_rng_t _rng[1]; fd_rng_t * rng = fd_rng_join( fd_rng_new( _rng, 0U, 0UL ) );
@@ -395,7 +440,7 @@ test_multiple_origins( void ) {
   }
 
   uchar const * origins[2] = { origin1.pubkey, origin2.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 2UL, &out_prunes, &out_prunes_len );
@@ -455,7 +500,7 @@ test_stake_threshold_with_pruning( void ) {
   }
 
   uchar const * origins[1] = { origin.pubkey };
-  fd_prune_finder_prune_t * out_prunes;
+  fd_prune_finder_prune_t const * out_prunes;
   ulong out_prunes_len;
 
   fd_prune_finder_get_prunes( pf, 1000000UL, origins, 1UL, &out_prunes, &out_prunes_len );
@@ -495,6 +540,9 @@ main( int     argc,
   test_get_prunes_tiebreaker();
   FD_LOG_NOTICE(( "test_get_prunes_tiebreaker() passed" ));
 
+  test_get_prunes_duplicate_origins();
+  FD_LOG_NOTICE(( "test_get_prunes_duplicate_origins() passed" ));
+
   test_relayer_eviction();
   FD_LOG_NOTICE(( "test_relayer_eviction() passed" ));
 
