WifiStateMachine: exclude CMD_RSSI_POLL for LogRecs

Due to the frequency with which we execute CMD_RSSI_POLL
(every 3 seconds, when the screen is on), the CMD_RSSI_POLL
LogRecs often crowd out more useful information.

To resolve this problem: don't include CMD_RSSI_POLL
in the log records maintained by StateMachine. But, to
facilitate debugging of CMD_RSSI_POLL issues, _do_
include CMD_RSSI_POLL when verbose logging is enabled.

Ideally, we'd solve this in some other way, so that the
LogRecs include all commands processed by the WifiStateMachine.
My hope is that we don't lose too much relevant information with
this change, because the consumers of the RSSI data do their
own logging.

Bug: 26960649
Test: unit tests
Change-Id: Icea22f9fe23c29cb5d2ad97b10955b74977d5e1a

2 files changed, 43 insertions, 0 deletions

diff --git a/service/java/com/android/server/wifi/WifiStateMachine.java b/service/java/com/android/server/wifi/WifiStateMachine.java
index e8d85cd75..ccd1d465a 100644
--- a/service/java/com/android/server/wifi/WifiStateMachine.java
+++ b/service/java/com/android/server/wifi/WifiStateMachine.java
@@ -2185,6 +2185,16 @@ public class WifiStateMachine extends StateMachine implements WifiNative.WifiRss
         }
     }
 
+    @Override
+    protected boolean recordLogRec(Message msg) {
+        switch (msg.what) {
+            case CMD_RSSI_POLL:
+                return mVerboseLoggingEnabled;
+            default:
+                return true;
+        }
+    }
+
     /**
      * Return the additional string to be logged by LogRec, default
      *
diff --git a/tests/wifitests/src/com/android/server/wifi/WifiStateMachineTest.java b/tests/wifitests/src/com/android/server/wifi/WifiStateMachineTest.java
index ad441f54d..17f20a24f 100644
--- a/tests/wifitests/src/com/android/server/wifi/WifiStateMachineTest.java
+++ b/tests/wifitests/src/com/android/server/wifi/WifiStateMachineTest.java
@@ -1087,6 +1087,39 @@ public class WifiStateMachineTest {
         assertEquals(WifiStateMachine.NUM_LOG_RECS_NORMAL, mWsm.getLogRecMaxSize());
     }
 
+    @Test
+    public void logRecsIncludeDisconnectCommand() {
+        // There's nothing special about the DISCONNECT command. It's just representative of
+        // "normal" commands.
+        mWsm.sendMessage(WifiStateMachine.CMD_DISCONNECT);
+        mLooper.dispatchAll();
+        assertEquals(1, mWsm.copyLogRecs()
+                .stream()
+                .filter(logRec -> logRec.getWhat() == WifiStateMachine.CMD_DISCONNECT)
+                .count());
+    }
+
+    @Test
+    public void logRecsExcludeRssiPollCommandByDefault() {
+        mWsm.sendMessage(WifiStateMachine.CMD_RSSI_POLL);
+        mLooper.dispatchAll();
+        assertEquals(0, mWsm.copyLogRecs()
+                .stream()
+                .filter(logRec -> logRec.getWhat() == WifiStateMachine.CMD_RSSI_POLL)
+                .count());
+    }
+
+    @Test
+    public void logRecsIncludeRssiPollCommandWhenVerboseLoggingIsEnabled() {
+        mWsm.enableVerboseLogging(1);
+        mWsm.sendMessage(WifiStateMachine.CMD_RSSI_POLL);
+        mLooper.dispatchAll();
+        assertEquals(1, mWsm.copyLogRecs()
+                .stream()
+                .filter(logRec -> logRec.getWhat() == WifiStateMachine.CMD_RSSI_POLL)
+                .count());
+    }
+
     /** Verifies that enabling verbose logging sets the hal log property in eng builds. */
     @Test
     public void enablingVerboseLoggingSetsHalLogPropertyInEngBuilds() {