Merge changes from topics "rename-libbpfmapjni", "rename-libtetherutiljni"
* changes:
Separate bpf and struct util from netlink util library
Use JniUtil.getJniLibraryName to find library name
Add JniUtil to identify jni library by package name
diff --git a/staticlibs/Android.bp b/staticlibs/Android.bp
index f1e7c85..68decf6 100644
--- a/staticlibs/Android.bp
+++ b/staticlibs/Android.bp
@@ -95,16 +95,37 @@
}
java_library {
- name: "net-utils-device-common-netlink",
- // TODO: Ipv6Utils and Struct stuff could be separated out of the netlink library into
- // an individual Struct library, and remove the net-utils-framework-common lib dependency.
- // But there is no need doing this at the moment.
+ name: "net-utils-device-common-bpf",
srcs: [
"device/com/android/net/module/util/BpfMap.java",
+ "device/com/android/net/module/util/JniUtil.java",
+ ],
+ sdk_version: "system_current",
+ min_sdk_version: "29",
+ visibility: [
+ "//frameworks/libs/net/common/tests:__subpackages__",
+ "//frameworks/libs/net/common/testutils:__subpackages__",
+ "//packages/modules/Connectivity:__subpackages__",
+ "//packages/modules/NetworkStack:__subpackages__",
+ ],
+ static_libs: [
+ "net-utils-device-common-struct",
+ ],
+ libs: [
+ "androidx.annotation_annotation",
+ ],
+ apex_available: [
+ "com.android.tethering",
+ "//apex_available:platform",
+ ],
+}
+
+java_library {
+ name: "net-utils-device-common-struct",
+ srcs: [
"device/com/android/net/module/util/HexDump.java",
"device/com/android/net/module/util/Ipv6Utils.java",
"device/com/android/net/module/util/Struct.java",
- "device/com/android/net/module/util/netlink/*.java",
"device/com/android/net/module/util/structs/*.java",
],
sdk_version: "system_current",
@@ -127,6 +148,30 @@
}
java_library {
+ name: "net-utils-device-common-netlink",
+ srcs: [
+ "device/com/android/net/module/util/netlink/*.java",
+ ],
+ sdk_version: "system_current",
+ min_sdk_version: "29",
+ visibility: [
+ "//frameworks/libs/net/common/testutils:__subpackages__",
+ "//packages/modules/Connectivity:__subpackages__",
+ "//packages/modules/NetworkStack:__subpackages__",
+ ],
+ static_libs: [
+ "net-utils-device-common-struct",
+ ],
+ libs: [
+ "androidx.annotation_annotation",
+ ],
+ apex_available: [
+ "com.android.tethering",
+ "//apex_available:platform",
+ ],
+}
+
+java_library {
// TODO : this target should probably be folded into net-utils-device-common
name: "net-utils-device-common-ip",
srcs: [
diff --git a/staticlibs/device/com/android/net/module/util/BpfMap.java b/staticlibs/device/com/android/net/module/util/BpfMap.java
index aa74152..5f05c7c 100644
--- a/staticlibs/device/com/android/net/module/util/BpfMap.java
+++ b/staticlibs/device/com/android/net/module/util/BpfMap.java
@@ -42,7 +42,7 @@
*/
public class BpfMap<K extends Struct, V extends Struct> implements AutoCloseable {
static {
- System.loadLibrary("tetherutilsjni");
+ System.loadLibrary(JniUtil.getJniLibraryName(BpfMap.class.getPackage()));
}
// Following definitions from kernel include/uapi/linux/bpf.h
diff --git a/staticlibs/device/com/android/net/module/util/JniUtil.java b/staticlibs/device/com/android/net/module/util/JniUtil.java
new file mode 100644
index 0000000..5210a3e
--- /dev/null
+++ b/staticlibs/device/com/android/net/module/util/JniUtil.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2021 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;
+
+/**
+ * Utilities for modules to use jni.
+ */
+public final class JniUtil {
+ /**
+ * The method to find jni library accroding to the giving package name.
+ *
+ * The jni library name would be packageName + _jni.so. E.g.
+ * com_android_networkstack_tethering_util_jni for tethering,
+ * com_android_connectivity_util_jni for connectivity.
+ */
+ public static String getJniLibraryName(final Package pkg) {
+ final String libPrefix = pkg.getName().replaceAll("\\.", "_");
+
+ return libPrefix + "_jni";
+ }
+}
diff --git a/staticlibs/native/README.md b/staticlibs/native/README.md
new file mode 100644
index 0000000..18d19c4
--- /dev/null
+++ b/staticlibs/native/README.md
@@ -0,0 +1,27 @@
+# JNI
+As a general rule, jarjar every static library dependency used in a mainline module into the
+modules's namespace (especially if it is also used by other modules)
+
+Fully-qualified name of java class needs to be hard-coded into the JNI .so, because JNI_OnLoad
+does not take any parameters. This means that there needs to be a different .so target for each
+post-jarjared package, so for each module.
+
+This is the guideline to provide JNI library shared with modules:
+
+* provide a common java library in frameworks/libs/net with the Java class (e.g. BpfMap.java).
+
+* provide a common native library in frameworks/libs/net with the JNI and provide the native
+ register function with class_name parameter. See register_com_android_net_module_util_BpfMap
+ function in frameworks/libs/net/common/native/bpfmapjni/com_android_net_module_util_BpfMap.cpp
+ as an example.
+
+When you want to use JNI library from frameworks/lib/net:
+
+* Each module includes the java library (e.g. net-utils-device-common-bpf) and applies its jarjar
+ rules after build.
+
+* Each module creates a native library in their directory, which statically links against the
+ common native library (e.g. libnet_utils_device_common_bpf), and calls the native registered
+ function by hardcoding the post-jarjar class_name.
+
+
diff --git a/staticlibs/native/bpfmapjni/Android.bp b/staticlibs/native/bpfmapjni/Android.bp
index edbae7c..b7af22d 100644
--- a/staticlibs/native/bpfmapjni/Android.bp
+++ b/staticlibs/native/bpfmapjni/Android.bp
@@ -17,7 +17,7 @@
}
cc_library_static {
- name: "libbpfmapjni",
+ name: "libnet_utils_device_common_bpfjni",
srcs: ["com_android_net_module_util_BpfMap.cpp"],
header_libs: [
"bpf_syscall_wrappers",
@@ -39,6 +39,6 @@
"//apex_available:platform",
],
visibility: [
- "//packages/modules/Connectivity/Tethering",
+ "//packages/modules/Connectivity:__subpackages__",
],
}
diff --git a/staticlibs/tests/unit/Android.bp b/staticlibs/tests/unit/Android.bp
index a9f9d70..07a8200 100644
--- a/staticlibs/tests/unit/Android.bp
+++ b/staticlibs/tests/unit/Android.bp
@@ -17,6 +17,7 @@
"androidx.test.rules",
"mockito-target-extended-minus-junit4",
"net-utils-device-common",
+ "net-utils-device-common-bpf",
"net-tests-utils",
"netd-client",
],
diff --git a/staticlibs/tests/unit/src/com/android/net/module/util/JniUtilTest.kt b/staticlibs/tests/unit/src/com/android/net/module/util/JniUtilTest.kt
new file mode 100644
index 0000000..7574087
--- /dev/null
+++ b/staticlibs/tests/unit/src/com/android/net/module/util/JniUtilTest.kt
@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2021 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
+
+import androidx.test.filters.SmallTest
+import androidx.test.runner.AndroidJUnit4
+import kotlin.test.assertEquals
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+@SmallTest
+public final class JniUtilTest {
+ private val TEST_JAVA_UTIL_NAME = "java_util_jni"
+ private val TEST_ORG_JUNIT_NAME = "org_junit_jni"
+
+ @Test
+ fun testGetJniLibraryName() {
+ assertEquals(TEST_JAVA_UTIL_NAME,
+ JniUtil.getJniLibraryName(java.util.Set::class.java.getPackage()))
+ assertEquals(TEST_ORG_JUNIT_NAME,
+ JniUtil.getJniLibraryName(org.junit.Before::class.java.getPackage()))
+ }
+}