Enhance APF logging with counter dumps and recent program updates
Added logging of APF counters after each counter read operation.
Included logging of the latest 10 APF program updates when the APF log
tag is enabled.
Bug: 332478833
Test: TH
Change-Id: I40da77f294d394fbd8d80012e5e990bbf0a56e56
diff --git a/src/android/net/apf/AndroidPacketFilter.java b/src/android/net/apf/AndroidPacketFilter.java
index 2a7165b..8c7ff05 100644
--- a/src/android/net/apf/AndroidPacketFilter.java
+++ b/src/android/net/apf/AndroidPacketFilter.java
@@ -44,9 +44,9 @@
void setMulticastFilter(boolean isEnabled);
/**
- * Set the APF data snapshot.
+ * Set the APF data snapshot and return the latest counter snapshot as a String.
*/
- void setDataSnapshot(byte[] data);
+ String setDataSnapshot(byte[] data);
/**
* Add TCP keepalive ack packet filter.
diff --git a/src/android/net/apf/ApfFilter.java b/src/android/net/apf/ApfFilter.java
index c705928..f3e577d 100644
--- a/src/android/net/apf/ApfFilter.java
+++ b/src/android/net/apf/ApfFilter.java
@@ -514,11 +514,13 @@
}
}
- public synchronized void setDataSnapshot(byte[] data) {
+ @Override
+ public synchronized String setDataSnapshot(byte[] data) {
mDataSnapshot = data;
if (mIsRunning) {
mApfCounterTracker.updateCountersFromData(data);
}
+ return mApfCounterTracker.getCounters().toString();
}
private void log(String s) {
diff --git a/src/android/net/apf/LegacyApfFilter.java b/src/android/net/apf/LegacyApfFilter.java
index 99aab80..e4f709b 100644
--- a/src/android/net/apf/LegacyApfFilter.java
+++ b/src/android/net/apf/LegacyApfFilter.java
@@ -435,11 +435,13 @@
mDependencies.onThreadCreated(mReceiveThread);
}
- public synchronized void setDataSnapshot(byte[] data) {
+ @Override
+ public synchronized String setDataSnapshot(byte[] data) {
mDataSnapshot = data;
if (mIsRunning) {
mApfCounterTracker.updateCountersFromData(data);
}
+ return mApfCounterTracker.getCounters().toString();
}
private void log(String s) {
diff --git a/src/android/net/ip/IpClient.java b/src/android/net/ip/IpClient.java
index 304b038..1d4e65e 100644
--- a/src/android/net/ip/IpClient.java
+++ b/src/android/net/ip/IpClient.java
@@ -199,15 +199,19 @@
public class IpClient extends StateMachine {
private static final String TAG = IpClient.class.getSimpleName();
private static final boolean DBG = false;
+ private final boolean mApfDebug;
// For message logging.
private static final Class[] sMessageClasses = { IpClient.class, DhcpClient.class };
private static final SparseArray<String> sWhatToString =
MessageUtils.findMessageNames(sMessageClasses);
- // Two static concurrent hashmaps of interface name to logging classes.
- // One holds StateMachine logs and the other connectivity packet logs.
+ // Static concurrent hashmaps of interface name to logging classes.
+ // This map holds StateMachine logs.
private static final ConcurrentHashMap<String, SharedLog> sSmLogs = new ConcurrentHashMap<>();
+ // This map holds connectivity packet logs.
private static final ConcurrentHashMap<String, LocalLog> sPktLogs = new ConcurrentHashMap<>();
+ // This map holds Apf logs.
+ private static final ConcurrentHashMap<String, SharedLog> sApfLogs = new ConcurrentHashMap<>();
private final NetworkStackIpMemoryStore mIpMemoryStore;
private final NetworkInformationShim mShim = NetworkInformationShimImpl.newInstance();
private final IpProvisioningMetrics mIpProvisioningMetrics = new IpProvisioningMetrics();
@@ -225,6 +229,12 @@
writer.println(String.format("--- BEGIN %s ---", ifname));
+ final SharedLog apfLog = sApfLogs.get(ifname);
+ if (apfLog != null) {
+ writer.println("APF log:");
+ apfLog.dump(null, writer, null);
+ }
+
final SharedLog smLog = sSmLogs.get(ifname);
if (smLog != null) {
writer.println("State machine log:");
@@ -266,16 +276,24 @@
public static class IpClientCallbacksWrapper {
private static final String PREFIX = "INVOKE ";
private final IIpClientCallbacks mCallback;
+ @NonNull
private final SharedLog mLog;
@NonNull
+ private final SharedLog mApfLog;
+ @NonNull
private final NetworkInformationShim mShim;
+ private final boolean mApfDebug;
+
@VisibleForTesting
- protected IpClientCallbacksWrapper(IIpClientCallbacks callback, SharedLog log,
- @NonNull NetworkInformationShim shim) {
+ protected IpClientCallbacksWrapper(IIpClientCallbacks callback, @NonNull SharedLog log,
+ @NonNull SharedLog apfLog, @NonNull NetworkInformationShim shim,
+ boolean apfDebug) {
mCallback = callback;
mLog = log;
+ mApfLog = apfLog;
mShim = shim;
+ mApfDebug = apfDebug;
}
private void log(String msg) {
@@ -396,6 +414,9 @@
public boolean installPacketFilter(byte[] filter) {
log("installPacketFilter(byte[" + filter.length + "])");
try {
+ if (mApfDebug) {
+ mApfLog.log("updated APF program: " + HexDump.toHexString(filter));
+ }
mCallback.installPacketFilter(filter);
} catch (RemoteException e) {
log("Failed to call installPacketFilter", e);
@@ -682,6 +703,7 @@
private final WakeupMessage mProvisioningTimeoutAlarm;
private final WakeupMessage mDhcpActionTimeoutAlarm;
private final SharedLog mLog;
+ private final SharedLog mApfLog;
private final LocalLog mConnectivityPacketLog;
private final MessageHandlingLogger mMsgStateLogger;
private final IpConnectivityLog mMetricsLog;
@@ -929,8 +951,11 @@
mLog = sSmLogs.get(mInterfaceName);
sPktLogs.putIfAbsent(mInterfaceName, new LocalLog(MAX_PACKET_RECORDS));
mConnectivityPacketLog = sPktLogs.get(mInterfaceName);
+ sApfLogs.putIfAbsent(mInterfaceName, new SharedLog(10 /* maxRecords */, mTag));
+ mApfLog = sApfLogs.get(mInterfaceName);
+ mApfDebug = Log.isLoggable(ApfFilter.class.getSimpleName(), Log.DEBUG);
mMsgStateLogger = new MessageHandlingLogger();
- mCallback = new IpClientCallbacksWrapper(callback, mLog, mShim);
+ mCallback = new IpClientCallbacksWrapper(callback, mLog, mApfLog, mShim, mApfDebug);
// TODO: Consider creating, constructing, and passing in some kind of
// InterfaceController.Dependencies class.
@@ -1370,7 +1395,9 @@
}
}
apfFilter.dump(pw);
-
+ pw.println("APF log:");
+ pw.println("mApfDebug: " + mApfDebug);
+ mApfLog.dump(fd, pw, args);
} else {
pw.print("No active ApfFilter; ");
if (provisioningConfig == null) {
@@ -3337,7 +3364,8 @@
case EVENT_READ_PACKET_FILTER_COMPLETE: {
if (mApfFilter != null) {
- mApfFilter.setDataSnapshot((byte[]) msg.obj);
+ String snapShotStr = mApfFilter.setDataSnapshot((byte[]) msg.obj);
+ mLog.log("readPacketFilterComplete, ApfCounters: " + snapShotStr);
}
mApfDataSnapshotComplete.open();
break;
diff --git a/tests/unit/src/android/net/apf/ApfTestUtils.java b/tests/unit/src/android/net/apf/ApfTestUtils.java
index d1f2a23..0b3ea65 100644
--- a/tests/unit/src/android/net/apf/ApfTestUtils.java
+++ b/tests/unit/src/android/net/apf/ApfTestUtils.java
@@ -247,13 +247,13 @@
private boolean mInstallPacketFilterReturn = true;
MockIpClientCallback() {
- super(mock(IIpClientCallbacks.class), mock(SharedLog.class),
- NetworkInformationShimImpl.newInstance());
+ super(mock(IIpClientCallbacks.class), mock(SharedLog.class), mock(SharedLog.class),
+ NetworkInformationShimImpl.newInstance(), false);
}
MockIpClientCallback(boolean installPacketFilterReturn) {
- super(mock(IIpClientCallbacks.class), mock(SharedLog.class),
- NetworkInformationShimImpl.newInstance());
+ super(mock(IIpClientCallbacks.class), mock(SharedLog.class), mock(SharedLog.class),
+ NetworkInformationShimImpl.newInstance(), false);
mInstallPacketFilterReturn = installPacketFilterReturn;
}
