Add isFeatureSupported and isTetheringFeatureForceDisabled methods
Add isFeatureSupported helper method to check whether
a specific feature is supported. This is useful when a specific
module version is required on a cross module feature, e.g.
a connectivity feauture requires to work with a older
networkstack module.
This commit also adds isTetheringFeatureForceDisabled() method
as a method that refers to DeviceConfig which can be controlled
to explicitly disabled.
Bug: 291870956
Test: atest FrameworksNetTests NetworkStaticLibTests
Change-Id: I511d00663e2378c36b4ca017db4b88d88f650852
diff --git a/staticlibs/Android.bp b/staticlibs/Android.bp
index e1b5601..d3e68b7 100644
--- a/staticlibs/Android.bp
+++ b/staticlibs/Android.bp
@@ -41,6 +41,7 @@
"device/com/android/net/module/util/PacketReader.java",
"device/com/android/net/module/util/SharedLog.java",
"device/com/android/net/module/util/SocketUtils.java",
+ "device/com/android/net/module/util/FeatureVersions.java",
// This library is used by system modules, for which the system health impact of Kotlin
// has not yet been evaluated. Annotations may need jarjar'ing.
// "src_devicecommon/**/*.kt",
diff --git a/staticlibs/device/com/android/net/module/util/DeviceConfigUtils.java b/staticlibs/device/com/android/net/module/util/DeviceConfigUtils.java
index e5c5d0d..bea227d 100644
--- a/staticlibs/device/com/android/net/module/util/DeviceConfigUtils.java
+++ b/staticlibs/device/com/android/net/module/util/DeviceConfigUtils.java
@@ -17,6 +17,12 @@
package com.android.net.module.util;
import static android.content.pm.PackageManager.MATCH_SYSTEM_ONLY;
+import static android.provider.DeviceConfig.NAMESPACE_TETHERING;
+
+import static com.android.net.module.util.FeatureVersions.CONNECTIVITY_MODULE_ID;
+import static com.android.net.module.util.FeatureVersions.MODULE_MASK;
+import static com.android.net.module.util.FeatureVersions.NETWORK_STACK_MODULE_ID;
+import static com.android.net.module.util.FeatureVersions.VERSION_MASK;
import android.content.Context;
import android.content.Intent;
@@ -53,12 +59,14 @@
"com.android.server.connectivity.intent.action.SERVICE_CONNECTIVITY_RESOURCES_APK";
private static final String CONNECTIVITY_RES_PKG_DIR = "/apex/" + TETHERING_MODULE_NAME + "/";
- private static final long DEFAULT_PACKAGE_VERSION = 1000;
+ @VisibleForTesting
+ public static final long DEFAULT_PACKAGE_VERSION = 1000;
@VisibleForTesting
public static void resetPackageVersionCacheForTest() {
sPackageVersion = -1;
sModuleVersion = -1;
+ sNetworkStackModuleVersion = -1;
}
private static volatile long sPackageVersion = -1;
@@ -264,6 +272,80 @@
return sModuleVersion;
}
+ private static volatile long sNetworkStackModuleVersion = -1;
+
+ /**
+ * Get networkstack module version.
+ */
+ @VisibleForTesting
+ static long getNetworkStackModuleVersion(@NonNull Context context) {
+ if (sNetworkStackModuleVersion >= 0) return sNetworkStackModuleVersion;
+
+ try {
+ sNetworkStackModuleVersion = resolveNetworkStackModuleVersion(context);
+ } catch (PackageManager.NameNotFoundException e) {
+ Log.wtf(TAG, "Failed to resolve networkstack module version: " + e);
+ return DEFAULT_PACKAGE_VERSION;
+ }
+ return sNetworkStackModuleVersion;
+ }
+
+ private static long resolveNetworkStackModuleVersion(@NonNull Context context)
+ throws PackageManager.NameNotFoundException {
+ // TODO(b/293975546): Strictly speaking this is the prefix for connectivity and not
+ // network stack. In practice, it's the same. Read the prefix from network stack instead.
+ final String pkgPrefix = resolvePkgPrefix(context);
+ final PackageManager packageManager = context.getPackageManager();
+ try {
+ return packageManager.getPackageInfo(pkgPrefix + "networkstack",
+ PackageManager.MATCH_SYSTEM_ONLY).getLongVersionCode();
+ } catch (PackageManager.NameNotFoundException e) {
+ Log.d(TAG, "Device is using go or non-mainline modules");
+ // fall through
+ }
+
+ return packageManager.getPackageInfo(pkgPrefix + "go.networkstack",
+ PackageManager.MATCH_ALL).getLongVersionCode();
+ }
+
+ /**
+ * Check whether one specific feature is supported from the feature Id. The feature Id is
+ * composed by a module package Id and version Id from {@link FeatureVersions}.
+ *
+ * This is useful when a feature required minimal module version supported and cannot function
+ * well with a standalone newer module.
+ * @param context The global context information about an app environment.
+ * @param featureId The feature id that contains required module id and minimal module version
+ * @return true if this feature is supported, or false if not supported.
+ **/
+ public static boolean isFeatureSupported(@NonNull Context context, long featureId) {
+ final long moduleVersion;
+ final long moduleId = featureId & MODULE_MASK;
+ if (moduleId == CONNECTIVITY_MODULE_ID) {
+ moduleVersion = getTetheringModuleVersion(context);
+ } else if (moduleId == NETWORK_STACK_MODULE_ID) {
+ moduleVersion = getNetworkStackModuleVersion(context);
+ } else {
+ throw new IllegalArgumentException("Unknown module " + moduleId);
+ }
+ // Support by default if no module version is available.
+ return moduleVersion == DEFAULT_PACKAGE_VERSION
+ || moduleVersion >= (featureId & VERSION_MASK);
+ }
+
+ /**
+ * Check whether one specific experimental feature in tethering module from {@link DeviceConfig}
+ * is disabled by setting a non-zero value in the property.
+ *
+ * @param name The name of the property to look up.
+ * @return true if this feature is force disabled, or false if not disabled.
+ */
+ public static boolean isTetheringFeatureForceDisabled(String name) {
+ final int propertyVersion = getDeviceConfigPropertyInt(NAMESPACE_TETHERING, name,
+ 0 /* default value */);
+ return propertyVersion != 0;
+ }
+
/**
* Gets boolean config from resources.
*/
diff --git a/staticlibs/device/com/android/net/module/util/FeatureVersions.java b/staticlibs/device/com/android/net/module/util/FeatureVersions.java
new file mode 100644
index 0000000..4986a58
--- /dev/null
+++ b/staticlibs/device/com/android/net/module/util/FeatureVersions.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2023 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.net.module.util;
+
+/**
+ * Class to centralize feature version control that requires a specific module or a specific
+ * module version.
+ * @hide
+ */
+public class FeatureVersions {
+ public static final long MODULE_MASK = 0xFF00_000000000L;
+ public static final long VERSION_MASK = 0x0000_FFFFFFFFFL;
+ public static final long CONNECTIVITY_MODULE_ID = 0x0100_000000000L;
+ public static final long NETWORK_STACK_MODULE_ID = 0x0200_000000000L;
+ // CLAT_ADDRESS_TRANSLATE is a feature of the network stack, which doesn't throw when system
+ // try to add a NAT-T keepalive packet filter with v6 address, introduced in version
+ // M-2023-Sept on July 3rd, 2023.
+ public static final long FEATURE_CLAT_ADDRESS_TRANSLATE =
+ NETWORK_STACK_MODULE_ID + 340900000L;
+}
diff --git a/staticlibs/tests/unit/src/com/android/net/module/util/DeviceConfigUtilsTest.java b/staticlibs/tests/unit/src/com/android/net/module/util/DeviceConfigUtilsTest.java
index 328c39a..7946244 100644
--- a/staticlibs/tests/unit/src/com/android/net/module/util/DeviceConfigUtilsTest.java
+++ b/staticlibs/tests/unit/src/com/android/net/module/util/DeviceConfigUtilsTest.java
@@ -17,12 +17,16 @@
package com.android.net.module.util;
import static android.content.pm.PackageManager.MATCH_SYSTEM_ONLY;
+import static android.provider.DeviceConfig.NAMESPACE_TETHERING;
import static com.android.dx.mockito.inline.extended.ExtendedMockito.doReturn;
import static com.android.dx.mockito.inline.extended.ExtendedMockito.mockitoSession;
+import static com.android.net.module.util.FeatureVersions.CONNECTIVITY_MODULE_ID;
+import static com.android.net.module.util.FeatureVersions.NETWORK_STACK_MODULE_ID;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertThrows;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.Mockito.anyInt;
@@ -84,6 +88,8 @@
private static final String TEST_GO_APEX_PACKAGE_NAME = "com.prefix.android.go.tethering";
private static final String TEST_CONNRES_PACKAGE_NAME =
"com.prefix.android.connectivity.resources";
+ private static final String TEST_NETWORKSTACK_NAME = "com.prefix.android.networkstack";
+ private static final String TEST_GO_NETWORKSTACK_NAME = "com.prefix.android.go.networkstack";
private final PackageInfo mPackageInfo = new PackageInfo();
private final PackageInfo mApexPackageInfo = new PackageInfo();
private MockitoSession mSession;
@@ -346,4 +352,82 @@
doThrow(new Resources.NotFoundException()).when(mResources).getInteger(someResId);
assertEquals(2098, DeviceConfigUtils.getResIntegerConfig(mContext, someResId, 2098));
}
+
+ @Test
+ public void testGetNetworkStackModuleVersionCaching() throws Exception {
+ final PackageInfo networkStackPackageInfo = new PackageInfo();
+ networkStackPackageInfo.setLongVersionCode(TEST_PACKAGE_VERSION);
+ doReturn(networkStackPackageInfo).when(mPm).getPackageInfo(
+ eq(TEST_NETWORKSTACK_NAME), anyInt());
+ assertEquals(TEST_PACKAGE_VERSION,
+ DeviceConfigUtils.getNetworkStackModuleVersion(mContext));
+
+ assertEquals(TEST_PACKAGE_VERSION,
+ DeviceConfigUtils.getNetworkStackModuleVersion(mContext));
+ // Package info is only queried once
+ verify(mPm, times(1)).getPackageInfo(anyString(), anyInt());
+ verify(mContext, never()).getPackageName();
+ }
+
+ @Test
+ public void testGetNetworkStackModuleVersionOnNonMainline() {
+ assertEquals(DeviceConfigUtils.DEFAULT_PACKAGE_VERSION,
+ DeviceConfigUtils.getNetworkStackModuleVersion(mContext));
+ }
+
+ @Test
+ public void testGetNetworkStackModuleVersion() throws Exception {
+ final PackageInfo networkStackPackageInfo = new PackageInfo();
+ final PackageInfo goNetworkStackPackageInfo = new PackageInfo();
+ networkStackPackageInfo.setLongVersionCode(TEST_PACKAGE_VERSION);
+ goNetworkStackPackageInfo.setLongVersionCode(TEST_PACKAGE_VERSION + 1);
+ doReturn(goNetworkStackPackageInfo).when(mPm).getPackageInfo(
+ eq(TEST_NETWORKSTACK_NAME), anyInt());
+ // Verify the returned value is go module version.
+ assertEquals(TEST_PACKAGE_VERSION + 1,
+ DeviceConfigUtils.getNetworkStackModuleVersion(mContext));
+ }
+
+ @Test
+ public void testIsFeatureSupported_networkStackFeature() throws Exception {
+ // Supported for DEFAULT_PACKAGE_VERSION
+ assertTrue(DeviceConfigUtils.isFeatureSupported(
+ mContext, TEST_PACKAGE_VERSION + NETWORK_STACK_MODULE_ID));
+
+ final PackageInfo networkStackPackageInfo = new PackageInfo();
+ networkStackPackageInfo.setLongVersionCode(TEST_PACKAGE_VERSION);
+ doReturn(networkStackPackageInfo).when(mPm).getPackageInfo(
+ eq(TEST_NETWORKSTACK_NAME), anyInt());
+
+ assertTrue(DeviceConfigUtils.isFeatureSupported(
+ mContext, TEST_PACKAGE_VERSION + NETWORK_STACK_MODULE_ID));
+ assertFalse(DeviceConfigUtils.isFeatureSupported(
+ mContext, TEST_PACKAGE_VERSION + NETWORK_STACK_MODULE_ID + 1));
+ }
+
+ @Test
+ public void testIsFeatureSupported_tetheringFeature() throws Exception {
+ assertTrue(DeviceConfigUtils.isFeatureSupported(
+ mContext, TEST_PACKAGE_VERSION + CONNECTIVITY_MODULE_ID));
+ // Return false because feature requires a future version.
+ assertFalse(DeviceConfigUtils.isFeatureSupported(
+ mContext, 889900000L + CONNECTIVITY_MODULE_ID));
+ }
+
+ @Test
+ public void testIsFeatureSupported_illegalModule() throws Exception {
+ assertThrows(IllegalArgumentException.class,
+ () -> DeviceConfigUtils.isFeatureSupported(mContext, TEST_PACKAGE_VERSION));
+ }
+
+ @Test
+ public void testIsTetheringFeatureForceDisabled() throws Exception {
+ doReturn("0").when(() -> DeviceConfig.getProperty(
+ eq(NAMESPACE_TETHERING), eq(TEST_EXPERIMENT_FLAG)));
+ assertFalse(DeviceConfigUtils.isTetheringFeatureForceDisabled(TEST_EXPERIMENT_FLAG));
+
+ doReturn(TEST_FLAG_VALUE_STRING).when(
+ () -> DeviceConfig.getProperty(eq(NAMESPACE_TETHERING), eq(TEST_EXPERIMENT_FLAG)));
+ assertTrue(DeviceConfigUtils.isTetheringFeatureForceDisabled(TEST_EXPERIMENT_FLAG));
+ }
}