wlancfg_lib/client/connection_selection/

scoring_functions.rs

// Copyright 2023 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use std::cmp::max;

use fidl_fuchsia_wlan_ieee80211 as fidl_ieee80211;

use crate::client::types;
use crate::config_management::FailureReason::CredentialRejected;
use crate::util::pseudo_energy::*;

/// Weighting constants
const RSSI_AND_VELOCITY_SCORE_WEIGHT: f32 = 0.6;
const SNR_SCORE_WEIGHT: f32 = 0.4;

/// 5GHz score bonus constants
const LOWER_RSSI_BOUND_FOR_5G_BONUS: i16 = -64; // Bonus tapers below this RSSI
const UPPER_RSSI_BOUND_FOR_5G_BONUS: i16 = -25; // Bonus tapers above this RSSI
const MAX_5G_PREFERENCE_BOOST: i16 = 20;
const TAPER_AMOUNT_FOR_5G_BONUS_PER_DBM_OUTSIDE_RANGE: i16 = 2;

/// Score penalty constants
const SCORE_PENALTY_FOR_RECENT_CONNECT_FAILURE: i16 = 5;
const THRESHOLD_EXCESSIVE_RECENT_CONNECT_FAILURES: usize = 5; // Excessive failures warrant higher penalty
const SCORE_PENALTY_FOR_EXCESSIVE_RECENT_CONNECT_FAILURES: i16 = 10;
const SCORE_PENALTY_FOR_RECENT_CREDENTIAL_REJECTED: i16 = 30; // Higher penalty, since future success is unlikely
const SCORE_PENALTY_FOR_SHORT_CONNECTION: i16 = 20;

pub fn score_bss_scanned_candidate(bss_candidate: types::ScannedCandidate) -> i16 {
    let mut score = calculate_base_signal_score(bss_candidate.bss.signal.rssi_dbm as i16);
    let channel = bss_candidate.bss.channel;

    // If the network is 5G and has a strong enough RSSI, give it a bonus.
    if channel.band == fidl_ieee80211::WlanBand::FiveGhz {
        score = score.saturating_add(calculate_5g_bonus(score));
    }

    // Penalize APs with recent failures to connect
    let matching_failures = bss_candidate
        .saved_network_info
        .recent_failures
        .iter()
        .filter(|failure| failure.bssid == bss_candidate.bss.bssid);
    let mut connect_failure_count: usize = 0;
    for failure in matching_failures {
        // Count failures for rejected credentials higher since we probably won't succeed
        // another try with the same credentials.
        if failure.reason == CredentialRejected {
            score = score.saturating_sub(SCORE_PENALTY_FOR_RECENT_CREDENTIAL_REJECTED);
        } else {
            connect_failure_count += 1;
            if connect_failure_count <= THRESHOLD_EXCESSIVE_RECENT_CONNECT_FAILURES {
                score = score.saturating_sub(SCORE_PENALTY_FOR_RECENT_CONNECT_FAILURE);
            } else {
                // Additional penalty for excessive recent failures.
                score = score.saturating_sub(SCORE_PENALTY_FOR_EXCESSIVE_RECENT_CONNECT_FAILURES);
            }
        }
    }
    // Penalize APs with recent short connections before disconnecting.
    let short_connection_score: i16 = bss_candidate
        .recent_short_connections()
        .try_into()
        .unwrap_or(i16::MAX)
        .saturating_mul(SCORE_PENALTY_FOR_SHORT_CONNECTION);

    score.saturating_sub(short_connection_score)
}

/// Scores are based on RSSI, before any bonuses or penalties are applied, using a piecewise linear
/// (y=mx+b) function. As signal strength increases beyond -30 dBm, connectivity gets progressively
/// worse due to RF receiver saturation, increased noise, etc. For signals > -30 dBm, we linearly
/// taper off the signal-based score.
///   - For RSSI <= -30, score == RSSI.
///   - For RSSI > -30, score == -2.7735 * RSSI - 113.2 (based on go/fuchsia-wlan:penalizing-high-rssi)
fn calculate_base_signal_score(rssi: i16) -> i16 {
    if rssi <= -30 {
        rssi
    } else {
        let m = -2.7735;
        let b = -113.2;
        let y = m * rssi as f64 + b;
        y as i16
    }
}

fn calculate_5g_bonus(rssi: i16) -> i16 {
    // Determine "distance" (in dBm) the RSSI falls outside of the bonus range.
    let taper_rate = max(
        max(LOWER_RSSI_BOUND_FOR_5G_BONUS - rssi, 0),
        max(rssi - UPPER_RSSI_BOUND_FOR_5G_BONUS, 0),
    );
    // For each dBm outside bonus range, reduce bonus by the taper amount, down to a minimum of 0.
    max(0, MAX_5G_PREFERENCE_BOOST - (taper_rate * TAPER_AMOUNT_FOR_5G_BONUS_PER_DBM_OUTSIDE_RANGE))
}

pub fn score_current_connection_signal_data(
    data: EwmaSignalData,
    rssi_velocity: impl Into<f64> + std::cmp::PartialOrd<f64>,
) -> u8 {
    let rssi_velocity_score = match data.ewma_rssi.get() {
        r if r <= -81.0 => match rssi_velocity {
            v if v < -2.7 => 0,
            v if v < -1.8 => 0,
            v if v < -0.9 => 0,
            v if v <= 0.9 => 0,
            v if v <= 1.8 => 20,
            v if v <= 2.7 => 18,
            _ => 10,
        },
        r if r <= -76.0 => match rssi_velocity {
            v if v < -2.7 => 0,
            v if v < -1.8 => 0,
            v if v < -0.9 => 0,
            v if v <= 0.9 => 15,
            v if v <= 1.8 => 28,
            v if v <= 2.7 => 25,
            _ => 15,
        },
        r if r <= -71.0 => match rssi_velocity {
            v if v < -2.7 => 0,
            v if v < -1.8 => 5,
            v if v < -0.9 => 15,
            v if v <= 0.9 => 30,
            v if v <= 1.8 => 45,
            v if v <= 2.7 => 38,
            _ => 4,
        },
        r if r <= -66.0 => match rssi_velocity {
            v if v < -2.7 => 10,
            v if v < -1.8 => 18,
            v if v < -0.9 => 30,
            v if v <= 0.9 => 48,
            v if v <= 1.8 => 60,
            v if v <= 2.7 => 50,
            _ => 38,
        },
        r if r <= -61.0 => match rssi_velocity {
            v if v < -2.7 => 20,
            v if v < -1.8 => 30,
            v if v < -0.9 => 45,
            v if v <= 0.9 => 70,
            v if v <= 1.8 => 75,
            v if v <= 2.7 => 60,
            _ => 55,
        },
        r if r <= -56.0 => match rssi_velocity {
            v if v < -2.7 => 40,
            v if v < -1.8 => 50,
            v if v < -0.9 => 63,
            v if v <= 0.9 => 85,
            v if v <= 1.8 => 85,
            v if v <= 2.7 => 70,
            _ => 65,
        },
        r if r <= -51.0 => match rssi_velocity {
            v if v < -2.7 => 55,
            v if v < -1.8 => 65,
            v if v < -0.9 => 75,
            v if v <= 0.9 => 95,
            v if v <= 1.8 => 90,
            v if v <= 2.7 => 80,
            _ => 75,
        },
        _ => match rssi_velocity {
            v if v < -2.7 => 60,
            v if v < -1.8 => 70,
            v if v < -0.9 => 80,
            v if v <= 0.9 => 100,
            v if v <= 1.8 => 95,
            v if v <= 2.7 => 90,
            _ => 80,
        },
    };

    let snr_score = match data.ewma_snr.get() {
        s if s <= 10.0 => 0,
        s if s <= 15.0 => 15,
        s if s <= 20.0 => 37,
        s if s <= 25.0 => 53,
        s if s <= 30.0 => 68,
        s if s <= 35.0 => 80,
        s if s <= 40.0 => 95,
        _ => 100,
    };

    ((rssi_velocity_score as f32 * RSSI_AND_VELOCITY_SCORE_WEIGHT)
        + (snr_score as f32 * SNR_SCORE_WEIGHT)) as u8
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::config_management::{ConnectFailure, FailureReason, PastConnectionData};
    use crate::util::testing::{
        generate_channel, generate_random_bss, generate_random_saved_network_data,
        generate_random_scanned_candidate, random_connection_data,
    };
    use fuchsia_async as fasync;
    use test_util::assert_gt;

    fn connect_failure_with_bssid(bssid: types::Bssid) -> ConnectFailure {
        ConnectFailure {
            reason: FailureReason::GeneralFailure,
            time: fasync::MonotonicInstant::INFINITE,
            bssid,
        }
    }

    fn past_connection_with_bssid_uptime(
        bssid: types::Bssid,
        uptime: zx::MonotonicDuration,
    ) -> PastConnectionData {
        PastConnectionData {
            bssid,
            connection_uptime: uptime,
            disconnect_time: fasync::MonotonicInstant::INFINITE, // disconnect will always be considered recent
            ..random_connection_data()
        }
    }

    #[fuchsia::test]
    fn test_weights_sum_to_one() {
        assert_eq!(RSSI_AND_VELOCITY_SCORE_WEIGHT + SNR_SCORE_WEIGHT, 1.0);
    }

    #[fuchsia::test]
    async fn test_score_bss_prefers_less_short_connections() {
        let bss_worse = types::Bss {
            signal: types::Signal { rssi_dbm: -60, snr_db: 0 },
            channel: generate_channel(3, fidl_fuchsia_wlan_ieee80211::WlanBand::TwoGhz),
            ..generate_random_bss()
        };
        let bss_better = types::Bss {
            signal: types::Signal { rssi_dbm: -60, snr_db: 0 },
            channel: generate_channel(3, fidl_fuchsia_wlan_ieee80211::WlanBand::TwoGhz),
            ..generate_random_bss()
        };
        let mut internal_data = generate_random_saved_network_data();
        let short_uptime = zx::MonotonicDuration::from_seconds(30);
        let okay_uptime = zx::MonotonicDuration::from_minutes(100);
        // Record a short uptime for the worse network and a long enough uptime for the better one.
        let short_uptime_data = past_connection_with_bssid_uptime(bss_worse.bssid, short_uptime);
        let okay_uptime_data = past_connection_with_bssid_uptime(bss_better.bssid, okay_uptime);
        internal_data.past_connections.add(bss_worse.bssid, short_uptime_data);
        internal_data.past_connections.add(bss_better.bssid, okay_uptime_data);
        let shared_candidate_data = types::ScannedCandidate {
            saved_network_info: internal_data,
            ..generate_random_scanned_candidate()
        };
        let bss_worse = types::ScannedCandidate { bss: bss_worse, ..shared_candidate_data.clone() };
        let bss_better =
            types::ScannedCandidate { bss: bss_better, ..shared_candidate_data.clone() };

        // Check that the better BSS has a higher score than the worse BSS.
        assert!(score_bss_scanned_candidate(bss_better) > score_bss_scanned_candidate(bss_worse));
    }

    #[fuchsia::test]
    async fn test_score_bss_prefers_less_failures() {
        let bss_worse = types::Bss {
            signal: types::Signal { rssi_dbm: -60, snr_db: 0 },
            channel: generate_channel(3, fidl_fuchsia_wlan_ieee80211::WlanBand::TwoGhz),
            ..generate_random_bss()
        };
        let bss_better = types::Bss {
            signal: types::Signal { rssi_dbm: -60, snr_db: 0 },
            channel: generate_channel(3, fidl_fuchsia_wlan_ieee80211::WlanBand::TwoGhz),
            ..generate_random_bss()
        };
        let mut internal_data = generate_random_saved_network_data();
        // Add many test failures for the worse BSS and one for the better BSS
        let mut failures = vec![connect_failure_with_bssid(bss_worse.bssid); 12];
        failures.push(connect_failure_with_bssid(bss_better.bssid));
        internal_data.recent_failures = failures;
        let shared_candidate_data = types::ScannedCandidate {
            saved_network_info: internal_data,
            ..generate_random_scanned_candidate()
        };
        let bss_worse = types::ScannedCandidate { bss: bss_worse, ..shared_candidate_data.clone() };
        let bss_better =
            types::ScannedCandidate { bss: bss_better, ..shared_candidate_data.clone() };
        // Check that the better BSS has a higher score than the worse BSS.
        assert!(score_bss_scanned_candidate(bss_better) > score_bss_scanned_candidate(bss_worse));
    }

    #[fuchsia::test]
    async fn test_score_bss_prefers_strong_5ghz_with_failures() {
        // Test test that if one network has a few network failures but is 5 Ghz instead of 2.4,
        // the 5 GHz network has a higher score.
        let bss_worse = types::Bss {
            signal: types::Signal { rssi_dbm: -35, snr_db: 0 },
            channel: generate_channel(3, fidl_fuchsia_wlan_ieee80211::WlanBand::TwoGhz),
            ..generate_random_bss()
        };
        let bss_better = types::Bss {
            signal: types::Signal { rssi_dbm: -35, snr_db: 0 },
            channel: generate_channel(36, fidl_fuchsia_wlan_ieee80211::WlanBand::FiveGhz),
            ..generate_random_bss()
        };
        let mut internal_data = generate_random_saved_network_data();
        // Set the failure list to have 0 failures for the worse BSS and 4 failures for the
        // stronger BSS.
        internal_data.recent_failures = vec![connect_failure_with_bssid(bss_better.bssid); 2];
        let shared_candidate_data = types::ScannedCandidate {
            saved_network_info: internal_data,
            ..generate_random_scanned_candidate()
        };
        let bss_worse = types::ScannedCandidate { bss: bss_worse, ..shared_candidate_data.clone() };
        let bss_better =
            types::ScannedCandidate { bss: bss_better, ..shared_candidate_data.clone() };
        assert!(score_bss_scanned_candidate(bss_better) > score_bss_scanned_candidate(bss_worse));
    }

    #[fuchsia::test]
    async fn test_score_credentials_rejected_worse() {
        // If two BSS are identical other than one failed to connect with wrong credentials and
        // the other failed with a few connect failurs, the one with wrong credentials has a lower
        // score.
        let bss_worse = types::Bss {
            signal: types::Signal { rssi_dbm: -30, snr_db: 0 },
            channel: generate_channel(44, fidl_fuchsia_wlan_ieee80211::WlanBand::FiveGhz),
            ..generate_random_bss()
        };
        let bss_better = types::Bss {
            signal: types::Signal { rssi_dbm: -30, snr_db: 0 },
            channel: generate_channel(44, fidl_fuchsia_wlan_ieee80211::WlanBand::FiveGhz),
            ..generate_random_bss()
        };
        let mut internal_data = generate_random_saved_network_data();
        // Add many test failures for the worse BSS and one for the better BSS
        let mut failures = vec![connect_failure_with_bssid(bss_better.bssid); 4];
        failures.push(ConnectFailure {
            bssid: bss_worse.bssid,
            time: fasync::MonotonicInstant::now(),
            reason: FailureReason::CredentialRejected,
        });
        internal_data.recent_failures = failures;
        let shared_candidate_data = types::ScannedCandidate {
            saved_network_info: internal_data,
            ..generate_random_scanned_candidate()
        };
        let bss_worse = types::ScannedCandidate { bss: bss_worse, ..shared_candidate_data.clone() };
        let bss_better =
            types::ScannedCandidate { bss: bss_better, ..shared_candidate_data.clone() };

        assert!(score_bss_scanned_candidate(bss_better) > score_bss_scanned_candidate(bss_worse));
    }

    #[fuchsia::test]
    async fn score_many_penalties_do_not_cause_panic() {
        let bss = types::Bss {
            signal: types::Signal { rssi_dbm: -80, snr_db: 0 },
            channel: generate_channel(1, fidl_fuchsia_wlan_ieee80211::WlanBand::TwoGhz),
            ..generate_random_bss()
        };
        let mut internal_data = generate_random_saved_network_data();
        // Add 10 general failures and 10 rejected credentials failures
        internal_data.recent_failures = vec![connect_failure_with_bssid(bss.bssid); 10];
        for _ in 0..1200 {
            internal_data.recent_failures.push(ConnectFailure {
                bssid: bss.bssid,
                time: fasync::MonotonicInstant::now(),
                reason: FailureReason::CredentialRejected,
            });
        }
        let short_uptime = zx::MonotonicDuration::from_seconds(30);
        let data = past_connection_with_bssid_uptime(bss.bssid, short_uptime);
        for _ in 0..10 {
            internal_data.past_connections.add(bss.bssid, data);
        }
        let scanned_candidate = types::ScannedCandidate {
            bss,
            saved_network_info: internal_data,
            ..generate_random_scanned_candidate()
        };

        assert_eq!(score_bss_scanned_candidate(scanned_candidate), i16::MIN);
    }

    // Trivial scoring algorithm test cases. Should pass (or be removed with acknowledgment) for
    // any scoring algorithm implementation.
    #[fuchsia::test]
    fn high_rssi_scores_higher_than_low_rssi() {
        let strong_clear_signal = EwmaSignalData::new(-50, 35, 10);
        let weak_clear_signal = EwmaSignalData::new(-85, 35, 10);
        assert_gt!(
            score_current_connection_signal_data(strong_clear_signal, 0.0),
            score_current_connection_signal_data(weak_clear_signal, 0.0)
        );

        let strong_noisy_signal = EwmaSignalData::new(-50, 5, 10);
        let weak_noisy_signal = EwmaSignalData::new(-85, 55, 10);
        assert_gt!(
            score_current_connection_signal_data(strong_noisy_signal, 0.0),
            score_current_connection_signal_data(weak_noisy_signal, 0.0)
        );
    }

    #[fuchsia::test]
    fn high_snr_scores_higher_than_low_snr() {
        let strong_clear_signal = EwmaSignalData::new(-50, 35, 10);
        let strong_noisy_signal = EwmaSignalData::new(-50, 5, 10);
        assert_gt!(
            score_current_connection_signal_data(strong_clear_signal, 0.0),
            score_current_connection_signal_data(strong_noisy_signal, 0.0)
        );

        let weak_clear_signal = EwmaSignalData::new(-85, 35, 10);
        let weak_noisy_signal = EwmaSignalData::new(-85, 5, 10);
        assert_gt!(
            score_current_connection_signal_data(weak_clear_signal, 0.0),
            score_current_connection_signal_data(weak_noisy_signal, 0.0)
        );
    }

    #[fuchsia::test]
    fn positive_velocity_scores_higher_than_negative_velocity() {
        let signal = EwmaSignalData::new(-50, 35, 10);
        assert_gt!(
            score_current_connection_signal_data(signal, 3.0),
            score_current_connection_signal_data(signal, -3.0)
        );
    }

    #[fuchsia::test]
    fn stable_high_rssi_scores_higher_than_volatile_high_rssi() {
        let strong_signal = EwmaSignalData::new(-50, 35, 10);
        assert_gt!(
            score_current_connection_signal_data(strong_signal, 0.0),
            score_current_connection_signal_data(strong_signal, 3.0)
        );
        assert_gt!(
            score_current_connection_signal_data(strong_signal, 0.0),
            score_current_connection_signal_data(strong_signal, -3.0)
        );
    }

    #[fuchsia::test]
    fn improving_weak_rssi_scores_higher_than_stable_weak_rssi() {
        let weak_signal = EwmaSignalData::new(-85, 10, 10);
        assert_gt!(
            score_current_connection_signal_data(weak_signal, 3.0),
            score_current_connection_signal_data(weak_signal, 0.0)
        );
    }

    #[fuchsia::test]
    fn test_calculate_5g_bonus_max_bonus_between_cutoffs() {
        assert_eq!(calculate_5g_bonus(LOWER_RSSI_BOUND_FOR_5G_BONUS), MAX_5G_PREFERENCE_BOOST);
        assert_eq!(calculate_5g_bonus(LOWER_RSSI_BOUND_FOR_5G_BONUS + 1), MAX_5G_PREFERENCE_BOOST);
        assert_eq!(calculate_5g_bonus(UPPER_RSSI_BOUND_FOR_5G_BONUS - 1), MAX_5G_PREFERENCE_BOOST);
        assert_eq!(calculate_5g_bonus(UPPER_RSSI_BOUND_FOR_5G_BONUS), MAX_5G_PREFERENCE_BOOST);
    }

    #[fuchsia::test]
    fn test_calculate_5g_bonus_linear_decrease_below_lower_cutoff() {
        assert_eq!(
            calculate_5g_bonus(LOWER_RSSI_BOUND_FOR_5G_BONUS - 1),
            MAX_5G_PREFERENCE_BOOST - TAPER_AMOUNT_FOR_5G_BONUS_PER_DBM_OUTSIDE_RANGE
        );
        assert_eq!(
            calculate_5g_bonus(LOWER_RSSI_BOUND_FOR_5G_BONUS - 2),
            MAX_5G_PREFERENCE_BOOST - (2 * TAPER_AMOUNT_FOR_5G_BONUS_PER_DBM_OUTSIDE_RANGE)
        );
        assert_eq!(calculate_5g_bonus(LOWER_RSSI_BOUND_FOR_5G_BONUS - 10), 0);
        assert_eq!(calculate_5g_bonus(LOWER_RSSI_BOUND_FOR_5G_BONUS - 20), 0);
    }

    #[fuchsia::test]
    fn test_calculate_5g_bonus_linear_decrease_above_upper_cutoff() {
        assert_eq!(
            calculate_5g_bonus(UPPER_RSSI_BOUND_FOR_5G_BONUS + 1),
            MAX_5G_PREFERENCE_BOOST - TAPER_AMOUNT_FOR_5G_BONUS_PER_DBM_OUTSIDE_RANGE
        );
        assert_eq!(
            calculate_5g_bonus(UPPER_RSSI_BOUND_FOR_5G_BONUS + 2),
            MAX_5G_PREFERENCE_BOOST - (2 * TAPER_AMOUNT_FOR_5G_BONUS_PER_DBM_OUTSIDE_RANGE)
        );
        assert_eq!(calculate_5g_bonus(UPPER_RSSI_BOUND_FOR_5G_BONUS + 10), 0);
        assert_eq!(calculate_5g_bonus(UPPER_RSSI_BOUND_FOR_5G_BONUS + 20), 0);
    }

    #[fuchsia::test]
    fn test_calculate_base_signal_score() {
        // For RSSI <= -30, score == RSSI
        assert_eq!(calculate_base_signal_score(-30), -30);
        assert_eq!(calculate_base_signal_score(-50), -50);

        // For RSSI > -30, score is follows a negative slope line.
        assert_eq!(calculate_base_signal_score(-25), -43);
        assert_eq!(calculate_base_signal_score(-20), -57);
    }
}