blob: 29f5cd2cc2a4c63b249d625e7be31e4cecb9952a [file] [log] [blame]
Lorenzo Colitti3b38b122022-01-12 16:06:07 +09001/*
2 * Copyright 2022 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090016 * bpf_existence_test.cpp - checks that the device has expected BPF programs and maps
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090017 */
18
19#include <cstdint>
Lorenzo Colitti32bd0712022-01-13 15:44:29 +090020#include <set>
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090021#include <string>
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090022
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090023#include <android-modules-utils/sdk_level.h>
Hungming Chen04569002022-02-16 16:02:49 +080024#include <bpf/BpfUtils.h>
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090025
26#include <gtest/gtest.h>
27
28using std::find;
Lorenzo Colitti32bd0712022-01-13 15:44:29 +090029using std::set;
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090030using std::string;
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090031
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +000032using android::bpf::isAtLeastKernelVersion;
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090033using android::modules::sdklevel::IsAtLeastR;
34using android::modules::sdklevel::IsAtLeastS;
35using android::modules::sdklevel::IsAtLeastT;
Maciej Żenczykowskic71dfae2023-08-09 21:48:28 +000036using android::modules::sdklevel::IsAtLeastU;
37using android::modules::sdklevel::IsAtLeastV;
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090038
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090039#define PLATFORM "/sys/fs/bpf/"
40#define TETHERING "/sys/fs/bpf/tethering/"
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -070041#define PRIVATE "/sys/fs/bpf/net_private/"
Maciej Żenczykowski0736d7b2022-04-21 06:42:17 -070042#define SHARED "/sys/fs/bpf/net_shared/"
Maciej Żenczykowski3cb494f2023-10-04 21:35:41 +000043#define NETD_RO "/sys/fs/bpf/netd_readonly/"
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -070044#define NETD "/sys/fs/bpf/netd_shared/"
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090045
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090046class BpfExistenceTest : public ::testing::Test {
47};
48
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +000049// Part of Android R platform (for 4.9+), but mainlined in S
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +000050static const set<string> PLATFORM_ONLY_IN_R = {
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090051 PLATFORM "map_offload_tether_ingress_map",
52 PLATFORM "map_offload_tether_limit_map",
53 PLATFORM "map_offload_tether_stats_map",
54 PLATFORM "prog_offload_schedcls_ingress_tether_ether",
55 PLATFORM "prog_offload_schedcls_ingress_tether_rawip",
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090056};
57
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +000058// Provided by *current* mainline module for S+ devices
59static const set<string> MAINLINE_FOR_S_PLUS = {
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090060 TETHERING "map_offload_tether_dev_map",
61 TETHERING "map_offload_tether_downstream4_map",
62 TETHERING "map_offload_tether_downstream64_map",
63 TETHERING "map_offload_tether_downstream6_map",
64 TETHERING "map_offload_tether_error_map",
65 TETHERING "map_offload_tether_limit_map",
66 TETHERING "map_offload_tether_stats_map",
67 TETHERING "map_offload_tether_upstream4_map",
68 TETHERING "map_offload_tether_upstream6_map",
Maciej Żenczykowski74b31ca2022-07-19 05:38:26 -070069 TETHERING "map_test_bitmap",
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090070 TETHERING "map_test_tether_downstream6_map",
Maciej Żenczykowski45e93722024-06-15 11:47:26 -070071 TETHERING "map_test_tether2_downstream6_map",
Maciej Żenczykowski878aae02024-06-15 11:54:36 -070072 TETHERING "map_test_tether3_downstream6_map",
Lorenzo Colitti8db39c42022-01-13 16:11:31 +090073 TETHERING "prog_offload_schedcls_tether_downstream4_ether",
74 TETHERING "prog_offload_schedcls_tether_downstream4_rawip",
75 TETHERING "prog_offload_schedcls_tether_downstream6_ether",
76 TETHERING "prog_offload_schedcls_tether_downstream6_rawip",
77 TETHERING "prog_offload_schedcls_tether_upstream4_ether",
78 TETHERING "prog_offload_schedcls_tether_upstream4_rawip",
79 TETHERING "prog_offload_schedcls_tether_upstream6_ether",
80 TETHERING "prog_offload_schedcls_tether_upstream6_rawip",
Lorenzo Colitti3b38b122022-01-12 16:06:07 +090081};
82
Maciej Żenczykowski74b31ca2022-07-19 05:38:26 -070083// Provided by *current* mainline module for S+ devices with 5.10+ kernels
84static const set<string> MAINLINE_FOR_S_5_10_PLUS = {
85 TETHERING "prog_test_xdp_drop_ipv4_udp_ether",
86};
87
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +000088// Provided by *current* mainline module for T+ devices
89static const set<string> MAINLINE_FOR_T_PLUS = {
Maciej Żenczykowskie9d5ad02022-04-23 09:15:30 -070090 SHARED "map_block_blocked_ports_map",
91 SHARED "map_clatd_clat_egress4_map",
92 SHARED "map_clatd_clat_ingress6_map",
Ken Chen74ff3ee2022-07-14 16:46:39 +080093 SHARED "map_dscpPolicy_ipv4_dscp_policies_map",
Ken Chen74ff3ee2022-07-14 16:46:39 +080094 SHARED "map_dscpPolicy_ipv6_dscp_policies_map",
Maciej Żenczykowskif75b7e12022-07-27 12:56:01 +000095 SHARED "map_dscpPolicy_socket_policy_cache_map",
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -070096 NETD "map_netd_app_uid_stats_map",
97 NETD "map_netd_configuration_map",
98 NETD "map_netd_cookie_tag_map",
Ken Chen24330172023-10-20 13:02:14 +080099 NETD "map_netd_data_saver_enabled_map",
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -0700100 NETD "map_netd_iface_index_name_map",
101 NETD "map_netd_iface_stats_map",
Maciej Żenczykowski6109d942023-08-29 18:39:28 +0000102 NETD "map_netd_ingress_discard_map",
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -0700103 NETD "map_netd_stats_map_A",
104 NETD "map_netd_stats_map_B",
105 NETD "map_netd_uid_counterset_map",
106 NETD "map_netd_uid_owner_map",
107 NETD "map_netd_uid_permission_map",
Maciej Żenczykowskie9d5ad02022-04-23 09:15:30 -0700108 SHARED "prog_clatd_schedcls_egress4_clat_rawip",
109 SHARED "prog_clatd_schedcls_ingress6_clat_ether",
110 SHARED "prog_clatd_schedcls_ingress6_clat_rawip",
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -0700111 NETD "prog_netd_cgroupskb_egress_stats",
112 NETD "prog_netd_cgroupskb_ingress_stats",
Maciej Żenczykowski6d116d02022-05-16 13:59:12 -0700113 NETD "prog_netd_schedact_ingress_account",
114 NETD "prog_netd_skfilter_allowlist_xtbpf",
115 NETD "prog_netd_skfilter_denylist_xtbpf",
116 NETD "prog_netd_skfilter_egress_xtbpf",
117 NETD "prog_netd_skfilter_ingress_xtbpf",
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900118};
119
Lorenzo Colitti3505b582022-10-27 19:36:27 +0900120// Provided by *current* mainline module for T+ devices with 4.14+ kernels
121static const set<string> MAINLINE_FOR_T_4_14_PLUS = {
122 NETD "prog_netd_cgroupsock_inet_create",
123};
124
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +0000125// Provided by *current* mainline module for T+ devices with 5.4+ kernels
Maciej Żenczykowski3cb494f2023-10-04 21:35:41 +0000126static const set<string> MAINLINE_FOR_T_4_19_PLUS = {
127 NETD_RO "prog_block_bind4_block_port",
128 NETD_RO "prog_block_bind6_block_port",
Maciej Żenczykowskib73da962022-07-14 08:32:14 +0000129};
130
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +0000131// Provided by *current* mainline module for T+ devices with 5.15+ kernels
132static const set<string> MAINLINE_FOR_T_5_15_PLUS = {
Ken Chen74ff3ee2022-07-14 16:46:39 +0800133 SHARED "prog_dscpPolicy_schedcls_set_dscp_ether",
Maciej Żenczykowski93b8cc12022-05-18 23:00:36 +0000134};
135
Ryan Zuklie9fb8f182023-09-28 15:50:59 -0700136// Provided by *current* mainline module for U+ devices
137static const set<string> MAINLINE_FOR_U_PLUS = {
138 NETD "map_netd_packet_trace_enabled_map",
139};
140
141// Provided by *current* mainline module for U+ devices with 5.10+ kernels
142static const set<string> MAINLINE_FOR_U_5_10_PLUS = {
143 NETD "map_netd_packet_trace_ringbuf",
144};
145
Maciej Żenczykowski22db5902024-05-10 06:44:08 -0700146// Provided by *current* mainline module for V+ devices
147static const set<string> MAINLINE_FOR_V_PLUS = {
Maciej Żenczykowski22db5902024-05-10 06:44:08 -0700148 NETD "prog_netd_connect4_inet4_connect",
149 NETD "prog_netd_connect6_inet6_connect",
150 NETD "prog_netd_recvmsg4_udp4_recvmsg",
151 NETD "prog_netd_recvmsg6_udp6_recvmsg",
152 NETD "prog_netd_sendmsg4_udp4_sendmsg",
153 NETD "prog_netd_sendmsg6_udp6_sendmsg",
Maciej Żenczykowski05ebcf02024-06-18 17:49:19 -0700154};
155
156// Provided by *current* mainline module for V+ devices with 5.4+ kernels
157static const set<string> MAINLINE_FOR_V_5_4_PLUS = {
Maciej Żenczykowski22db5902024-05-10 06:44:08 -0700158 NETD "prog_netd_getsockopt_prog",
159 NETD "prog_netd_setsockopt_prog",
Maciej Żenczykowski05ebcf02024-06-18 17:49:19 -0700160};
161
162// Provided by *current* mainline module for U+ devices with 5.10+ kernels
163static const set<string> MAINLINE_FOR_V_5_10_PLUS = {
Maciej Żenczykowski22db5902024-05-10 06:44:08 -0700164 NETD "prog_netd_cgroupsockrelease_inet_release",
165};
166
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +0000167static void addAll(set<string>& a, const set<string>& b) {
168 a.insert(b.begin(), b.end());
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900169}
170
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +0000171#define DO_EXPECT(B, V) addAll((B) ? mustExist : mustNotExist, (V))
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900172
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +0000173TEST_F(BpfExistenceTest, TestPrograms) {
174 // Only unconfined root is guaranteed to be able to access everything in /sys/fs/bpf.
175 ASSERT_EQ(0, getuid()) << "This test must run as root.";
176
177 set<string> mustExist;
178 set<string> mustNotExist;
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900179
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +0000180 // We do not actually check the platform P/Q (netd) and Q (clatd) things
181 // and only verify the mainline module relevant R+ offload maps & progs.
182 //
183 // The goal of this test is to verify compatibility with the tethering mainline module,
184 // and not to test the platform itself, which may have been modified by vendor or oems,
185 // so we should only test for the removal of stuff that was mainline'd,
186 // and for the presence of mainline stuff.
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900187
Maciej Żenczykowskic71dfae2023-08-09 21:48:28 +0000188 // Note: Q is no longer supported by mainline
189 ASSERT_TRUE(IsAtLeastR());
190
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +0000191 // R can potentially run on pre-4.9 kernel non-eBPF capable devices.
192 DO_EXPECT(IsAtLeastR() && !IsAtLeastS() && isAtLeastKernelVersion(4, 9, 0), PLATFORM_ONLY_IN_R);
193
194 // S requires Linux Kernel 4.9+ and thus requires eBPF support.
Maciej Żenczykowskic71dfae2023-08-09 21:48:28 +0000195 if (IsAtLeastS()) ASSERT_TRUE(isAtLeastKernelVersion(4, 9, 0));
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +0000196 DO_EXPECT(IsAtLeastS(), MAINLINE_FOR_S_PLUS);
Maciej Żenczykowski74b31ca2022-07-19 05:38:26 -0700197 DO_EXPECT(IsAtLeastS() && isAtLeastKernelVersion(5, 10, 0), MAINLINE_FOR_S_5_10_PLUS);
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900198
199 // Nothing added or removed in SCv2.
200
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +0000201 // T still only requires Linux Kernel 4.9+.
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +0000202 DO_EXPECT(IsAtLeastT(), MAINLINE_FOR_T_PLUS);
Lorenzo Colitti3505b582022-10-27 19:36:27 +0900203 DO_EXPECT(IsAtLeastT() && isAtLeastKernelVersion(4, 14, 0), MAINLINE_FOR_T_4_14_PLUS);
Maciej Żenczykowski3cb494f2023-10-04 21:35:41 +0000204 DO_EXPECT(IsAtLeastT() && isAtLeastKernelVersion(4, 19, 0), MAINLINE_FOR_T_4_19_PLUS);
Maciej Żenczykowskie9e77412022-07-16 20:10:16 +0000205 DO_EXPECT(IsAtLeastT() && isAtLeastKernelVersion(5, 15, 0), MAINLINE_FOR_T_5_15_PLUS);
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900206
Maciej Żenczykowski2e4c7522022-12-18 11:34:42 +0000207 // U requires Linux Kernel 4.14+, but nothing (as yet) added or removed in U.
Maciej Żenczykowskic71dfae2023-08-09 21:48:28 +0000208 if (IsAtLeastU()) ASSERT_TRUE(isAtLeastKernelVersion(4, 14, 0));
Ryan Zuklie9fb8f182023-09-28 15:50:59 -0700209 DO_EXPECT(IsAtLeastU(), MAINLINE_FOR_U_PLUS);
210 DO_EXPECT(IsAtLeastU() && isAtLeastKernelVersion(5, 10, 0), MAINLINE_FOR_U_5_10_PLUS);
Maciej Żenczykowskic71dfae2023-08-09 21:48:28 +0000211
212 // V requires Linux Kernel 4.19+, but nothing (as yet) added or removed in V.
213 if (IsAtLeastV()) ASSERT_TRUE(isAtLeastKernelVersion(4, 19, 0));
Maciej Żenczykowski22db5902024-05-10 06:44:08 -0700214 DO_EXPECT(IsAtLeastV(), MAINLINE_FOR_V_PLUS);
Maciej Żenczykowski05ebcf02024-06-18 17:49:19 -0700215 DO_EXPECT(IsAtLeastV() && isAtLeastKernelVersion(5, 4, 0), MAINLINE_FOR_V_5_4_PLUS);
216 DO_EXPECT(IsAtLeastV() && isAtLeastKernelVersion(5, 10, 0), MAINLINE_FOR_V_5_10_PLUS);
Lorenzo Colitti3b38b122022-01-12 16:06:07 +0900217
218 for (const auto& file : mustExist) {
219 EXPECT_EQ(0, access(file.c_str(), R_OK)) << file << " does not exist";
220 }
221 for (const auto& file : mustNotExist) {
222 int ret = access(file.c_str(), R_OK);
223 int err = errno;
224 EXPECT_EQ(-1, ret) << file << " unexpectedly exists";
225 if (ret == -1) {
226 EXPECT_EQ(ENOENT, err) << " accessing " << file << " failed with errno " << err;
227 }
228 }
229}