only export symbols when agave-unstable-api set

Author: gregcusack

gossip/src/push_active_set.rs

@@ -1,11 +1,11 @@
 #[cfg(feature = "agave-unstable-api")]
+use crate::{
+    cluster_info::REFRESH_PUSH_ACTIVE_SET_INTERVAL_MS, stake_weighting_config::TimeConstant,
+};
+#[cfg(feature = "agave-unstable-api")]
 use solana_low_pass_filter::api as lpf;
 use {
-    crate::{
-        cluster_info::REFRESH_PUSH_ACTIVE_SET_INTERVAL_MS,
-        stake_weighting_config::{TimeConstant, WeightingConfig},
-        weighted_shuffle::WeightedShuffle,
-    },
+    crate::{stake_weighting_config::WeightingConfig, weighted_shuffle::WeightedShuffle},
     indexmap::IndexMap,
     rand::Rng,
     solana_bloom::bloom::{Bloom, ConcurrentBloom},
@@ -15,9 +15,14 @@ use {
 };
 
 const NUM_PUSH_ACTIVE_SET_ENTRIES: usize = 25;
+
+#[cfg(feature = "agave-unstable-api")]
 const ALPHA_MIN: u64 = lpf::SCALE.get();
+#[cfg(feature = "agave-unstable-api")]
 const ALPHA_MAX: u64 = 2 * lpf::SCALE.get();
+#[cfg(feature = "agave-unstable-api")]
 const DEFAULT_ALPHA: u64 = ALPHA_MAX;
+#[cfg(feature = "agave-unstable-api")]
 // Low pass filter convergence time (ms)
 const DEFAULT_TC_MS: u64 = 30_000;
 
@@ -26,6 +31,7 @@ pub enum WeightingMode {
     // alpha = 2.0 -> Quadratic
     Static,
     // alpha in [1.0, 2.0], smoothed over time, scaled up by 1,000,000 to avoid floating-point math
+    #[cfg(feature = "agave-unstable-api")]
     Dynamic {
         alpha: u64,    // current alpha (fixed-point, 1,000,000–2,000,000)
         filter_k: u64, // default: 611,000
@@ -37,6 +43,7 @@ impl From<&WeightingConfig> for WeightingMode {
     fn from(cfg: &WeightingConfig) -> Self {
         match cfg {
             WeightingConfig::Static => WeightingMode::Static,
+            #[cfg(feature = "agave-unstable-api")]
             WeightingConfig::Dynamic { tc } => {
                 let tc_ms = match tc {
                     TimeConstant::Value(tc_ms) => *tc_ms,
@@ -49,10 +56,16 @@ impl From<&WeightingConfig> for WeightingMode {
                     tc_ms,
                 }
             }
+            #[cfg(not(feature = "agave-unstable-api"))]
+            WeightingConfig::Dynamic { .. } => {
+                // When the feature is not enabled, fall back to Static mode
+                WeightingMode::Static
+            }
         }
     }
 }
 
+#[cfg(feature = "agave-unstable-api")]
 #[inline]
 fn get_weight(bucket: u64, alpha: u64) -> u64 {
     debug_assert!((ALPHA_MIN..=ALPHA_MIN + lpf::SCALE.get()).contains(&alpha));
@@ -99,6 +112,7 @@ impl PushActiveSet {
                     self.mode = WeightingMode::Static;
                 }
             }
+            #[cfg(feature = "agave-unstable-api")]
             WeightingConfig::Dynamic { tc } => {
                 let new_tc_ms = match tc {
                     TimeConstant::Value(tc_ms) => *tc_ms,
@@ -138,6 +152,12 @@ impl PushActiveSet {
                     }
                 }
             }
+            #[cfg(not(feature = "agave-unstable-api"))]
+            WeightingConfig::Dynamic { .. } => {
+                // When the feature is not enabled, Dynamic config is treated as Static
+                // This ensures the code compiles but users don't get the dynamic behavior
+                info!("Dynamic weighting config ignored - requires 'agave-unstable-api' feature");
+            }
         }
     }
 }
@@ -193,6 +213,7 @@ impl PushActiveSet {
         // Gossip nodes to be sampled for each push active set.
         nodes: &[Pubkey],
         stakes: &HashMap<Pubkey, u64>,
+        #[cfg_attr(not(feature = "agave-unstable-api"), allow(unused_variables))]
         self_pubkey: &Pubkey,
     ) {
         if nodes.is_empty() {
@@ -234,6 +255,7 @@ impl PushActiveSet {
                     entry.rotate(rng, size, num_bloom_filter_items, nodes, &weights);
                 }
             }
+            #[cfg(feature = "agave-unstable-api")]
             WeightingMode::Dynamic {
                 ref mut alpha,
                 filter_k,
@@ -281,28 +303,6 @@ impl PushActiveSet {
     }
 }
 
-#[cfg(not(feature = "agave-unstable-api"))]
-mod lpf {
-    pub const SCALE: std::num::NonZeroU64 = std::num::NonZeroU64::new(1000000).unwrap();
-    pub struct FilterConfig {
-        pub output_range: std::ops::Range<u64>,
-        #[allow(dead_code)]
-        pub k: u64,
-    }
-    pub fn compute_k(_: u64, _: u64) -> u64 {
-        0
-    }
-    pub fn filter_alpha(alpha: u64, _: u64, filter_config: FilterConfig) -> u64 {
-        alpha.clamp(
-            filter_config.output_range.start,
-            filter_config.output_range.end,
-        )
-    }
-    pub fn interpolate(_: u64, _: u64) -> u64 {
-        0
-    }
-}
-
 impl PushActiveSetEntry {
     const BLOOM_FALSE_RATE: f64 = 0.1;
     const BLOOM_MAX_BITS: usize = 1024 * 8 * 4;

low-pass-filter/Cargo.toml

@@ -1,7 +1,12 @@
 [package]
 name = "solana-low-pass-filter"
-version = "3.0.0"
-edition = "2021"
+description = "Low Pass Filter for Gossip Peer Weighting"
+version = { workspace = true }
+repository = { workspace = true }
+homepage = { workspace = true }
+license = { workspace = true }
+edition = { workspace = true }
+publish = false
 
 [features]
 default = []

low-pass-filter/src/lib.rs

@@ -1,4 +1,4 @@
-#![cfg_attr(not(feature = "agave-unstable-api"), allow(dead_code))]
+#![cfg(feature = "agave-unstable-api")]
 //! Fixed-point IIR filter for smoothing `alpha` updates.
 //!
 //! This is equivalent to a discrete-time Butterworth filter of order 1
@@ -11,7 +11,6 @@
 //!     K = W_C / (1 + W_C), where Wc = 2π * Fs / Tc
 //!     Fc = 1 / TC  (cutoff frequency)
 //!     Fs = 1 / refresh interval
-#[cfg(feature = "agave-unstable-api")]
 pub mod api {
     use std::num::NonZeroU64;