[WifiScoreReport] Retire LegacyConnectedScore

Bug: 73127862
Test: Unit tests
Change-Id: Ie44030f0f9cd01a25b9277c67c3cd9c94e15adb0

4 files changed, 8 insertions, 284 deletions

diff --git a/service/java/com/android/server/wifi/LegacyConnectedScore.java b/service/java/com/android/server/wifi/LegacyConnectedScore.java
deleted file mode 100644
index 30276960f..000000000
--- a/service/java/com/android/server/wifi/LegacyConnectedScore.java
+++ /dev/null
@@ -1,257 +0,0 @@
-/*
- * Copyright (C) 2017 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.android.server.wifi;
-
-import android.content.Context;
-import android.net.NetworkAgent;
-import android.net.wifi.WifiConfiguration;
-import android.net.wifi.WifiInfo;
-
-import com.android.internal.R;
-
-/**
- * Class used to calculate scores for connected wifi networks and report it to the associated
- * network agent.
- */
-public class LegacyConnectedScore extends ConnectedScore {
-
-    private static final int STARTING_SCORE = 56;
-
-    private static final int SCAN_CACHE_VISIBILITY_MS = 12000;
-    private static final int HOME_VISIBLE_NETWORK_MAX_COUNT = 6;
-    private static final int SCAN_CACHE_COUNT_PENALTY = 2;
-    private static final int MAX_SUCCESS_RATE_OF_STUCK_LINK = 3; // proportional to packets per sec
-    private static final int MAX_STUCK_LINK_COUNT = 5;
-    private static final int MAX_BAD_RSSI_COUNT = 7;
-    private static final int BAD_RSSI_COUNT_PENALTY = 2;
-    private static final int MAX_LOW_RSSI_COUNT = 1;
-    private static final double MIN_TX_FAILURE_RATE_FOR_WORKING_LINK = 0.3;
-    private static final int MIN_SUSTAINED_LINK_STUCK_COUNT = 1;
-    private static final int LINK_STUCK_PENALTY = 2;
-    private static final int BAD_LINKSPEED_PENALTY = 4;
-    private static final int GOOD_LINKSPEED_BONUS = 4;
-
-    // Device configs. The values are examples.
-    private final int mThresholdMinimumRssi5;      // -82
-    private final int mThresholdQualifiedRssi5;    // -70
-    private final int mThresholdSaturatedRssi5;    // -57
-    private final int mThresholdMinimumRssi24;     // -85
-    private final int mThresholdQualifiedRssi24;   // -73
-    private final int mThresholdSaturatedRssi24;   // -60
-    private final int mBadLinkSpeed24;             //  6 Mbps
-    private final int mBadLinkSpeed5;              // 12 Mbps
-    private final int mGoodLinkSpeed24;            // 24 Mbps
-    private final int mGoodLinkSpeed5;             // 36 Mbps
-
-    private final WifiConfigManager mWifiConfigManager;
-    private boolean mVerboseLoggingEnabled = false;
-
-    private boolean mMultiBandScanResults;
-    private boolean mIsHomeNetwork;
-    private int mScore = 0;
-    private int mBadRssiCount;
-    private int mLinkStuckCount;
-    private int mLowRssiCount;
-
-
-    LegacyConnectedScore(Context context, WifiConfigManager wifiConfigManager, Clock clock) {
-        super(clock);
-        // Fetch all the device configs.
-        mThresholdMinimumRssi5 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_bad_rssi_threshold_5GHz);
-        mThresholdQualifiedRssi5 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_low_rssi_threshold_5GHz);
-        mThresholdSaturatedRssi5 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_good_rssi_threshold_5GHz);
-        mThresholdMinimumRssi24 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_bad_rssi_threshold_24GHz);
-        mThresholdQualifiedRssi24 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_low_rssi_threshold_24GHz);
-        mThresholdSaturatedRssi24 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_good_rssi_threshold_24GHz);
-        mBadLinkSpeed24 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_bad_link_speed_24);
-        mBadLinkSpeed5 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_bad_link_speed_5);
-        mGoodLinkSpeed24 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_good_link_speed_24);
-        mGoodLinkSpeed5 = context.getResources().getInteger(
-                R.integer.config_wifi_framework_wifi_score_good_link_speed_5);
-
-        mWifiConfigManager = wifiConfigManager;
-    }
-
-    @Override
-    public void updateUsingWifiInfo(WifiInfo wifiInfo, long millis) {
-        mMultiBandScanResults = multiBandScanResults(wifiInfo);
-        mIsHomeNetwork = isHomeNetwork(wifiInfo);
-
-        int rssiThreshBad = mThresholdMinimumRssi24;
-        int rssiThreshLow = mThresholdQualifiedRssi24;
-
-        if (wifiInfo.is5GHz() && !mMultiBandScanResults) {
-            rssiThreshBad = mThresholdMinimumRssi5;
-            rssiThreshLow = mThresholdQualifiedRssi5;
-        }
-
-        int rssi =  wifiInfo.getRssi();
-        if (mIsHomeNetwork) {
-            rssi += WifiConfiguration.HOME_NETWORK_RSSI_BOOST;
-        }
-
-        if ((wifiInfo.txBadRate * 5 >= 1)
-                && (wifiInfo.txSuccessRate * 5 < MAX_SUCCESS_RATE_OF_STUCK_LINK)
-                && rssi < rssiThreshLow) {
-            // Link is stuck
-            if (mLinkStuckCount < MAX_STUCK_LINK_COUNT) {
-                mLinkStuckCount += 1;
-            }
-        } else if (wifiInfo.txBadRate * 5 < MIN_TX_FAILURE_RATE_FOR_WORKING_LINK) {
-            if (mLinkStuckCount > 0) {
-                mLinkStuckCount -= 1;
-            }
-        }
-
-        if (rssi < rssiThreshBad) {
-            if (mBadRssiCount < MAX_BAD_RSSI_COUNT) {
-                mBadRssiCount += 1;
-            }
-        } else if (rssi < rssiThreshLow) {
-            mLowRssiCount = MAX_LOW_RSSI_COUNT; // Dont increment the lowRssi count above 1
-            if (mBadRssiCount > 0) {
-                // Decrement bad Rssi count
-                mBadRssiCount -= 1;
-            }
-        } else {
-            mBadRssiCount = 0;
-            mLowRssiCount = 0;
-        }
-
-        // Ugh, we need to finish the score calculation while we have wifiInfo
-        mScore = calculateScore(wifiInfo);
-
-    }
-
-    @Override
-    public void updateUsingRssi(int rssi, long millis, double standardDeviation) {
-        // This scorer needs more than just the RSSI. Just ignore.
-    }
-
-    @Override
-    public int generateScore() {
-        return mScore;
-    }
-
-    @Override
-    public void reset() {
-        mScore = 0;
-        mBadRssiCount = 0;
-        mLinkStuckCount = 0;
-        mLowRssiCount = 0;
-    }
-
-    /**
-     * Calculates a score based on the current state and wifiInfo
-     */
-    private int calculateScore(WifiInfo wifiInfo) {
-        int score = STARTING_SCORE;
-
-        int rssiThreshSaturated = mThresholdSaturatedRssi24;
-        int linkspeedThreshBad = mBadLinkSpeed24;
-        int linkspeedThreshGood = mGoodLinkSpeed24;
-
-        if (wifiInfo.is5GHz()) {
-            if (!mMultiBandScanResults) {
-                rssiThreshSaturated = mThresholdSaturatedRssi5;
-            }
-            linkspeedThreshBad = mBadLinkSpeed5;
-            linkspeedThreshGood = mGoodLinkSpeed5;
-        }
-
-        int rssi =  wifiInfo.getRssi();
-        if (mIsHomeNetwork) {
-            rssi += WifiConfiguration.HOME_NETWORK_RSSI_BOOST;
-        }
-
-        int linkSpeed = wifiInfo.getLinkSpeed();
-
-        if (mLinkStuckCount > MIN_SUSTAINED_LINK_STUCK_COUNT) {
-            // Once link gets stuck for more than 3 seconds, start reducing the score
-            score = score - LINK_STUCK_PENALTY * (mLinkStuckCount - 1);
-        }
-
-        if (linkSpeed < linkspeedThreshBad) {
-            score -= BAD_LINKSPEED_PENALTY;
-        } else if ((linkSpeed >= linkspeedThreshGood)
-                    && (wifiInfo.txSuccessRate > 1)) {
-            score += GOOD_LINKSPEED_BONUS; // So as bad rssi alone doesn't kill us
-        }
-
-        score -= mBadRssiCount * BAD_RSSI_COUNT_PENALTY + mLowRssiCount;
-
-        if (rssi >= rssiThreshSaturated) score += 5;
-
-        if (score > NetworkAgent.WIFI_BASE_SCORE) score = NetworkAgent.WIFI_BASE_SCORE;
-        if (score < 0) score = 0;
-
-        return score;
-    }
-
-    /**
-     * Determines if we can see both 2.4GHz and 5GHz for current config
-     */
-    private boolean multiBandScanResults(WifiInfo wifiInfo) {
-        WifiConfiguration currentConfiguration =
-                mWifiConfigManager.getConfiguredNetwork(wifiInfo.getNetworkId());
-        if (currentConfiguration == null) return false;
-        ScanDetailCache scanDetailCache =
-                mWifiConfigManager.getScanDetailCacheForNetwork(wifiInfo.getNetworkId());
-        if (scanDetailCache == null) return false;
-        // Nasty that we change state here...
-        currentConfiguration.setVisibility(scanDetailCache.getVisibility(SCAN_CACHE_VISIBILITY_MS));
-        if (currentConfiguration.visibility == null) return false;
-        if (currentConfiguration.visibility.rssi24 == WifiConfiguration.INVALID_RSSI) return false;
-        if (currentConfiguration.visibility.rssi5 == WifiConfiguration.INVALID_RSSI) return false;
-        // N.B. this does not do exactly what is claimed!
-        if (currentConfiguration.visibility.rssi24
-                >= currentConfiguration.visibility.rssi5 - SCAN_CACHE_COUNT_PENALTY) {
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * Decides whether the current network is a "home" network
-     */
-    private boolean isHomeNetwork(WifiInfo wifiInfo) {
-        WifiConfiguration currentConfiguration =
-                mWifiConfigManager.getConfiguredNetwork(wifiInfo.getNetworkId());
-        if (currentConfiguration == null) return false;
-        // This seems like it will only return true for really old routers!
-        if (currentConfiguration.allowedKeyManagement.cardinality() != 1) return false;
-        if (!currentConfiguration.allowedKeyManagement.get(WifiConfiguration.KeyMgmt.WPA_PSK)) {
-            return false;
-        }
-        ScanDetailCache scanDetailCache =
-                mWifiConfigManager.getScanDetailCacheForNetwork(wifiInfo.getNetworkId());
-        if (scanDetailCache == null) return false;
-        if (scanDetailCache.size() <= HOME_VISIBLE_NETWORK_MAX_COUNT) {
-            return true;
-        }
-        return false;
-    }
-}
diff --git a/service/java/com/android/server/wifi/WifiScoreReport.java b/service/java/com/android/server/wifi/WifiScoreReport.java
index b8b5f029b..162f627ae 100644
--- a/service/java/com/android/server/wifi/WifiScoreReport.java
+++ b/service/java/com/android/server/wifi/WifiScoreReport.java
@@ -47,13 +47,11 @@ public class WifiScoreReport {
     private final Clock mClock;
     private int mSessionNumber = 0;
 
-    ConnectedScore mConnectedScore;
     ConnectedScore mAggressiveConnectedScore;
     VelocityBasedConnectedScore mFancyConnectedScore;
 
-    WifiScoreReport(Context context, WifiConfigManager wifiConfigManager, Clock clock) {
+    WifiScoreReport(Context context, Clock clock) {
         mClock = clock;
-        mConnectedScore = new LegacyConnectedScore(context, wifiConfigManager, clock);
         mAggressiveConnectedScore = new AggressiveConnectedScore(context, clock);
         mFancyConnectedScore = new VelocityBasedConnectedScore(context, clock);
     }
@@ -76,7 +74,6 @@ public class WifiScoreReport {
             mSessionNumber++;
             mReportValid = false;
         }
-        mConnectedScore.reset();
         mAggressiveConnectedScore.reset();
         mFancyConnectedScore.reset();
         if (mVerboseLoggingEnabled) Log.d(TAG, "reset");
@@ -122,11 +119,9 @@ public class WifiScoreReport {
             netId = networkAgent.netId;
         }
 
-        mConnectedScore.updateUsingWifiInfo(wifiInfo, millis);
         mAggressiveConnectedScore.updateUsingWifiInfo(wifiInfo, millis);
         mFancyConnectedScore.updateUsingWifiInfo(wifiInfo, millis);
 
-        int s0 = mConnectedScore.generateScore();
         int s1 = mAggressiveConnectedScore.generateScore();
         int s2 = mFancyConnectedScore.generateScore();
 
@@ -140,7 +135,7 @@ public class WifiScoreReport {
             score = 0;
         }
 
-        logLinkMetrics(wifiInfo, millis, netId, s0, s1, s2);
+        logLinkMetrics(wifiInfo, millis, netId, s1, s2);
 
         //report score
         if (score != wifiInfo.score) {
@@ -169,7 +164,7 @@ public class WifiScoreReport {
      * Data logging for dumpsys
      */
     private void logLinkMetrics(WifiInfo wifiInfo, long now, int netId,
-                                int s0, int s1, int s2) {
+                                int s1, int s2) {
         if (now < FIRST_REASONABLE_WALL_CLOCK) return;
         double rssi = wifiInfo.getRssi();
         double filteredRssi = mFancyConnectedScore.getFilteredRssi();
@@ -184,11 +179,11 @@ public class WifiScoreReport {
         try {
             String timestamp = new SimpleDateFormat("MM-dd HH:mm:ss.SSS").format(new Date(now));
             s = String.format(Locale.US, // Use US to avoid comma/decimal confusion
-                    "%s,%d,%d,%.1f,%.1f,%.1f,%d,%d,%.2f,%.2f,%.2f,%.2f,%d,%d,%d",
+                    "%s,%d,%d,%.1f,%.1f,%.1f,%d,%d,%.2f,%.2f,%.2f,%.2f,%d,%d",
                     timestamp, mSessionNumber, netId,
                     rssi, filteredRssi, rssiThreshold, freq, linkSpeed,
                     txSuccessRate, txRetriesRate, txBadRate, rxSuccessRate,
-                    s0, s1, s2);
+                    s1, s2);
         } catch (Exception e) {
             Log.e(TAG, "format problem", e);
             return;
@@ -218,7 +213,7 @@ public class WifiScoreReport {
             history = new LinkedList<>(mLinkMetricsHistory);
         }
         pw.println("time,session,netid,rssi,filtered_rssi,rssi_threshold,"
-                + "freq,linkspeed,tx_good,tx_retry,tx_bad,rx_pps,s0,s1,s2");
+                + "freq,linkspeed,tx_good,tx_retry,tx_bad,rx_pps,s1,s2");
         for (String line : history) {
             pw.println(line);
         }
diff --git a/service/java/com/android/server/wifi/WifiStateMachine.java b/service/java/com/android/server/wifi/WifiStateMachine.java
index fe181877d..5197714da 100644
--- a/service/java/com/android/server/wifi/WifiStateMachine.java
+++ b/service/java/com/android/server/wifi/WifiStateMachine.java
@@ -916,7 +916,7 @@ public class WifiStateMachine extends StateMachine {
 
         mCountryCode = countryCode;
 
-        mWifiScoreReport = new WifiScoreReport(mContext, mWifiConfigManager, mClock);
+        mWifiScoreReport = new WifiScoreReport(mContext, mClock);
 
         mUserWantsSuspendOpt.set(mFacade.getIntegerSetting(mContext,
                 Settings.Global.WIFI_SUSPEND_OPTIMIZATIONS_ENABLED, 1) == 1);
diff --git a/tests/wifitests/src/com/android/server/wifi/WifiScoreReportTest.java b/tests/wifitests/src/com/android/server/wifi/WifiScoreReportTest.java
index 029d87a13..cabece18a 100644
--- a/tests/wifitests/src/com/android/server/wifi/WifiScoreReportTest.java
+++ b/tests/wifitests/src/com/android/server/wifi/WifiScoreReportTest.java
@@ -42,7 +42,6 @@ import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 
 import java.io.PrintWriter;
-import java.util.Arrays;
 
 /**
  * Unit tests for {@link com.android.server.wifi.WifiScoreReport}.
@@ -70,7 +69,6 @@ public class WifiScoreReportTest {
     @Mock Context mContext;
     @Mock NetworkAgent mNetworkAgent;
     @Mock Resources mResources;
-    @Mock WifiConfigManager mWifiConfigManager;
     @Mock WifiMetrics mWifiMetrics;
     @Mock PrintWriter mPrintWriter;
 
@@ -119,24 +117,13 @@ public class WifiScoreReportTest {
     public void setUp() throws Exception {
         MockitoAnnotations.initMocks(this);
         setUpResources(mResources);
-        WifiConfiguration config = new WifiConfiguration();
-        config.SSID = "nooooooooooo";
-        config.allowedKeyManagement.set(WifiConfiguration.KeyMgmt.NONE);
-        config.hiddenSSID = false;
         mWifiInfo = new WifiInfo();
         mWifiInfo.setFrequency(2412);
-        when(mWifiConfigManager.getSavedNetworks()).thenReturn(Arrays.asList(config));
-        when(mWifiConfigManager.getConfiguredNetwork(anyInt())).thenReturn(config);
-        mWifiConfiguration = config;
         int maxSize = 10;
         int trimSize = 5;
-        mScanDetailCache = new ScanDetailCache(config, maxSize, trimSize);
-        // TODO: populate the cache, but probably in the test cases, not here.
-        when(mWifiConfigManager.getScanDetailCacheForNetwork(anyInt()))
-                .thenReturn(mScanDetailCache);
         when(mContext.getResources()).thenReturn(mResources);
         mClock = new FakeClock();
-        mWifiScoreReport = new WifiScoreReport(mContext, mWifiConfigManager, mClock);
+        mWifiScoreReport = new WifiScoreReport(mContext, mClock);
     }
 
     /**
@@ -146,7 +133,6 @@ public class WifiScoreReportTest {
     public void tearDown() throws Exception {
         mResources = null;
         mWifiScoreReport = null;
-        mWifiConfigManager = null;
         mWifiMetrics = null;
     }