blob: d91407ffdb375597a9005c17f7ac87b6edf89c3a [file] [log] [blame]
Chenbo Fengf2759682017-10-10 17:31:57 -07001/*
2 * Copyright (C) 2017 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 */
16
Chenbo Fengc10a8a42017-12-15 13:56:33 -080017#define LOG_TAG "TrafficController"
Chenbo Feng33cc1032017-10-23 15:16:37 -070018#include <inttypes.h>
Chenbo Fengf2759682017-10-10 17:31:57 -070019#include <linux/bpf.h>
20#include <linux/if_ether.h>
21#include <linux/in.h>
22#include <linux/inet_diag.h>
Chenbo Feng116d0552017-12-04 17:25:19 -080023#include <linux/netlink.h>
24#include <linux/sock_diag.h>
Chenbo Fengf2759682017-10-10 17:31:57 -070025#include <linux/unistd.h>
Chenbo Fengc10a8a42017-12-15 13:56:33 -080026#include <net/if.h>
Chenbo Fengf2759682017-10-10 17:31:57 -070027#include <stdlib.h>
28#include <string.h>
29#include <sys/socket.h>
Chenbo Fengc10a8a42017-12-15 13:56:33 -080030#include <sys/stat.h>
Chenbo Feng05393d82018-01-09 15:18:43 -080031#include <sys/types.h>
Chenbo Feng33cc1032017-10-23 15:16:37 -070032#include <sys/utsname.h>
Chenbo Feng05393d82018-01-09 15:18:43 -080033#include <sys/wait.h>
Chenbo Feng89c12f12018-03-21 10:29:18 -070034#include <mutex>
Chenbo Fengc10a8a42017-12-15 13:56:33 -080035#include <unordered_set>
36#include <vector>
37
38#include <android-base/stringprintf.h>
Chenbo Fengef297172018-03-26 10:53:33 -070039#include <android-base/strings.h>
Chenbo Fengc10a8a42017-12-15 13:56:33 -080040#include <android-base/unique_fd.h>
41#include <netdutils/StatusOr.h>
Chenbo Fengf2759682017-10-10 17:31:57 -070042
Chenbo Feng116d0552017-12-04 17:25:19 -080043#include <netdutils/Misc.h>
44#include <netdutils/Syscalls.h>
Suren Baghdasaryane072a3c2019-01-16 14:36:07 -080045#include <processgroup/processgroup.h>
Chenbo Fengf2759682017-10-10 17:31:57 -070046#include "TrafficController.h"
Chenbo Feng4f6c2372018-04-26 10:37:55 -070047#include "bpf/BpfMap.h"
Chenbo Feng116d0552017-12-04 17:25:19 -080048
Chenbo Feng89c12f12018-03-21 10:29:18 -070049#include "FirewallController.h"
Chenbo Feng7e974052018-02-28 22:57:21 -080050#include "InterfaceController.h"
Chenbo Feng116d0552017-12-04 17:25:19 -080051#include "NetlinkListener.h"
Luke Huangb257d612019-03-14 21:19:13 +080052#include "netdutils/DumpWriter.h"
Chenbo Feng33cc1032017-10-23 15:16:37 -070053#include "qtaguid/qtaguid.h"
Chenbo Fengf2759682017-10-10 17:31:57 -070054
Bernie Innocenti7e25ec02018-07-02 19:32:17 +090055using namespace android::bpf; // NOLINT(google-build-using-namespace): grandfathered
Chenbo Fengf2759682017-10-10 17:31:57 -070056
57namespace android {
58namespace net {
59
Chenbo Fengc10a8a42017-12-15 13:56:33 -080060using base::StringPrintf;
61using base::unique_fd;
Luke Huangb257d612019-03-14 21:19:13 +080062using netdutils::DumpWriter;
Chenbo Feng116d0552017-12-04 17:25:19 -080063using netdutils::extract;
Luke Huangb257d612019-03-14 21:19:13 +080064using netdutils::ScopedIndent;
Chenbo Feng116d0552017-12-04 17:25:19 -080065using netdutils::Slice;
66using netdutils::sSyscalls;
Chenbo Fengc10a8a42017-12-15 13:56:33 -080067using netdutils::Status;
68using netdutils::statusFromErrno;
69using netdutils::StatusOr;
Chenbo Feng116d0552017-12-04 17:25:19 -080070using netdutils::status::ok;
Chenbo Fengc10a8a42017-12-15 13:56:33 -080071
Chenbo Feng116d0552017-12-04 17:25:19 -080072constexpr int kSockDiagMsgType = SOCK_DIAG_BY_FAMILY;
73constexpr int kSockDiagDoneMsgType = NLMSG_DONE;
Chenbo Feng82075e52019-04-12 19:21:47 -070074constexpr int PER_UID_STATS_ENTRIES_LIMIT = 500;
Chenbo Feng05662be2019-05-02 12:47:25 -070075// At most 90% of the stats map may be used by tagged traffic entries. This ensures
76// that 10% of the map is always available to count untagged traffic, one entry per UID.
77// Otherwise, apps would be able to avoid data usage accounting entirely by filling up the
78// map with tagged traffic entries.
Chenbo Fengfd88f9d2019-05-01 12:59:09 -070079constexpr int TOTAL_UID_STATS_ENTRIES_LIMIT = STATS_MAP_SIZE * 0.9;
mtk13799ae0704e2019-03-28 15:07:14 +080080constexpr mode_t S_NONE = 0;
Chenbo Feng116d0552017-12-04 17:25:19 -080081
Chenbo Fengbf660aa2019-02-26 16:12:27 -080082static_assert(BPF_PERMISSION_INTERNET == INetd::PERMISSION_INTERNET,
83 "Mismatch between BPF and AIDL permissions: PERMISSION_INTERNET");
84static_assert(BPF_PERMISSION_UPDATE_DEVICE_STATS == INetd::PERMISSION_UPDATE_DEVICE_STATS,
85 "Mismatch between BPF and AIDL permissions: PERMISSION_UPDATE_DEVICE_STATS");
Chenbo Fengfd88f9d2019-05-01 12:59:09 -070086static_assert(STATS_MAP_SIZE - TOTAL_UID_STATS_ENTRIES_LIMIT > 100,
87 "The limit for stats map is to high, stats data may be lost due to overflow");
Chenbo Fengbf660aa2019-02-26 16:12:27 -080088
Chenbo Feng48eaed32018-12-26 17:40:21 -080089#define FLAG_MSG_TRANS(result, flag, value) \
90 do { \
91 if (value & flag) { \
92 result.append(StringPrintf(" %s", #flag)); \
93 value &= ~flag; \
94 } \
Chenbo Feng703798e2018-06-15 17:07:59 -070095 } while (0)
96
97const std::string uidMatchTypeToString(uint8_t match) {
98 std::string matchType;
Chenbo Feng48eaed32018-12-26 17:40:21 -080099 FLAG_MSG_TRANS(matchType, HAPPY_BOX_MATCH, match);
100 FLAG_MSG_TRANS(matchType, PENALTY_BOX_MATCH, match);
101 FLAG_MSG_TRANS(matchType, DOZABLE_MATCH, match);
102 FLAG_MSG_TRANS(matchType, STANDBY_MATCH, match);
103 FLAG_MSG_TRANS(matchType, POWERSAVE_MATCH, match);
Rubin Xuec27ff22019-01-08 21:33:03 +0000104 FLAG_MSG_TRANS(matchType, IIF_MATCH, match);
Chenbo Feng703798e2018-06-15 17:07:59 -0700105 if (match) {
106 return StringPrintf("Unknown match: %u", match);
107 }
108 return matchType;
109}
110
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800111bool TrafficController::hasUpdateDeviceStatsPermission(uid_t uid) {
Chenbo Feng3969c262019-03-19 14:53:57 -0700112 // This implementation is the same logic as method ActivityManager#checkComponentPermission.
113 // It implies that the calling uid can never be the same as PER_USER_RANGE.
114 uint32_t appId = uid % PER_USER_RANGE;
115 return ((appId == AID_ROOT) || (appId == AID_SYSTEM) ||
116 mPrivilegedUser.find(appId) != mPrivilegedUser.end());
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800117}
118
Yi Kong3d82f382019-10-01 21:52:14 -0700119const std::string UidPermissionTypeToString(int permission) {
Chenbo Feng84f48cd2019-04-22 15:34:40 -0700120 if (permission == INetd::PERMISSION_NONE) {
121 return "PERMISSION_NONE";
Chenbo Fengbf660aa2019-02-26 16:12:27 -0800122 }
Chenbo Feng527908a2019-04-02 20:14:11 -0700123 if (permission == INetd::PERMISSION_UNINSTALLED) {
124 // This should never appear in the map, complain loudly if it does.
125 return "PERMISSION_UNINSTALLED error!";
126 }
Chenbo Feng48eaed32018-12-26 17:40:21 -0800127 std::string permissionType;
Chenbo Fengbf660aa2019-02-26 16:12:27 -0800128 FLAG_MSG_TRANS(permissionType, BPF_PERMISSION_INTERNET, permission);
129 FLAG_MSG_TRANS(permissionType, BPF_PERMISSION_UPDATE_DEVICE_STATS, permission);
Chenbo Feng48eaed32018-12-26 17:40:21 -0800130 if (permission) {
131 return StringPrintf("Unknown permission: %u", permission);
132 }
133 return permissionType;
134}
135
Chenbo Feng49586642018-08-30 18:01:53 -0700136StatusOr<std::unique_ptr<NetlinkListenerInterface>> TrafficController::makeSkDestroyListener() {
Chenbo Feng116d0552017-12-04 17:25:19 -0800137 const auto& sys = sSyscalls.get();
138 ASSIGN_OR_RETURN(auto event, sys.eventfd(0, EFD_CLOEXEC));
139 const int domain = AF_NETLINK;
140 const int type = SOCK_DGRAM | SOCK_CLOEXEC | SOCK_NONBLOCK;
141 const int protocol = NETLINK_INET_DIAG;
142 ASSIGN_OR_RETURN(auto sock, sys.socket(domain, type, protocol));
143
Lorenzo Colitti436efdb2018-07-26 17:20:57 +0900144 // TODO: if too many sockets are closed too quickly, we can overflow the socket buffer, and
145 // some entries in mCookieTagMap will not be freed. In order to fix this we would need to
146 // periodically dump all sockets and remove the tag entries for sockets that have been closed.
147 // For now, set a large-enough buffer that we can close hundreds of sockets without getting
148 // ENOBUFS and leaking mCookieTagMap entries.
149 int rcvbuf = 512 * 1024;
150 auto ret = sys.setsockopt(sock, SOL_SOCKET, SO_RCVBUF, &rcvbuf, sizeof(rcvbuf));
151 if (!ret.ok()) {
152 ALOGW("Failed to set SkDestroyListener buffer size to %d: %s", rcvbuf, ret.msg().c_str());
153 }
154
Chenbo Feng116d0552017-12-04 17:25:19 -0800155 sockaddr_nl addr = {
156 .nl_family = AF_NETLINK,
157 .nl_groups = 1 << (SKNLGRP_INET_TCP_DESTROY - 1) | 1 << (SKNLGRP_INET_UDP_DESTROY - 1) |
158 1 << (SKNLGRP_INET6_TCP_DESTROY - 1) | 1 << (SKNLGRP_INET6_UDP_DESTROY - 1)};
159 RETURN_IF_NOT_OK(sys.bind(sock, addr));
160
161 const sockaddr_nl kernel = {.nl_family = AF_NETLINK};
162 RETURN_IF_NOT_OK(sys.connect(sock, kernel));
163
164 std::unique_ptr<NetlinkListenerInterface> listener =
Chenbo Feng46296702018-08-23 12:20:22 -0700165 std::make_unique<NetlinkListener>(std::move(event), std::move(sock), "SkDestroyListen");
Chenbo Feng116d0552017-12-04 17:25:19 -0800166
167 return listener;
168}
169
mtk13799ae0704e2019-03-28 15:07:14 +0800170Status changeOwnerAndMode(const char* path, gid_t group, const char* debugName, mode_t groupMode) {
Chenbo Feng89c12f12018-03-21 10:29:18 -0700171 int ret = chown(path, AID_ROOT, group);
172 if (ret != 0) return statusFromErrno(errno, StringPrintf("change %s group failed", debugName));
173
mtk13799ae0704e2019-03-28 15:07:14 +0800174 // Ensure groupMode only contains group bits.
175 groupMode &= S_IRGRP | S_IWGRP;
176
177 // chmod doesn't by itself grant permission to all processes in that group to
178 // read/write the bpf map. They still need correct sepolicy.
179 ret = chmod(path, S_IRUSR | S_IWUSR | groupMode);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700180 if (ret != 0) return statusFromErrno(errno, StringPrintf("change %s mode failed", debugName));
181 return netdutils::status::ok;
182}
183
Chenbo Feng82075e52019-04-12 19:21:47 -0700184TrafficController::TrafficController()
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800185 : mBpfEnabled(isBpfSupported()),
Chenbo Feng82075e52019-04-12 19:21:47 -0700186 mPerUidStatsEntriesLimit(PER_UID_STATS_ENTRIES_LIMIT),
187 mTotalUidStatsEntriesLimit(TOTAL_UID_STATS_ENTRIES_LIMIT) {}
188
189TrafficController::TrafficController(uint32_t perUidLimit, uint32_t totalLimit)
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800190 : mBpfEnabled(isBpfSupported()),
Chenbo Feng82075e52019-04-12 19:21:47 -0700191 mPerUidStatsEntriesLimit(perUidLimit),
192 mTotalUidStatsEntriesLimit(totalLimit) {}
Chenbo Feng89c12f12018-03-21 10:29:18 -0700193
Chenbo Feng89c12f12018-03-21 10:29:18 -0700194Status TrafficController::initMaps() {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700195 std::lock_guard guard(mMutex);
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700196 RETURN_IF_NOT_OK(mCookieTagMap.init(COOKIE_TAG_MAP_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800197 RETURN_IF_NOT_OK(
198 changeOwnerAndMode(COOKIE_TAG_MAP_PATH, AID_NET_BW_ACCT, "CookieTagMap", S_IRGRP));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700199
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700200 RETURN_IF_NOT_OK(mUidCounterSetMap.init(UID_COUNTERSET_MAP_PATH));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700201 RETURN_IF_NOT_OK(changeOwnerAndMode(UID_COUNTERSET_MAP_PATH, AID_NET_BW_ACCT,
mtk13799ae0704e2019-03-28 15:07:14 +0800202 "UidCounterSetMap", S_IRGRP));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700203
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700204 RETURN_IF_NOT_OK(mAppUidStatsMap.init(APP_UID_STATS_MAP_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800205 RETURN_IF_NOT_OK(changeOwnerAndMode(APP_UID_STATS_MAP_PATH, AID_NET_BW_STATS, "AppUidStatsMap",
206 S_IRGRP));
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700207
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700208 RETURN_IF_NOT_OK(mStatsMapA.init(STATS_MAP_A_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800209 RETURN_IF_NOT_OK(
210 changeOwnerAndMode(STATS_MAP_A_PATH, AID_NET_BW_STATS, "StatsMapA", S_IRGRP | S_IWGRP));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700211
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700212 RETURN_IF_NOT_OK(mStatsMapB.init(STATS_MAP_B_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800213 RETURN_IF_NOT_OK(
214 changeOwnerAndMode(STATS_MAP_B_PATH, AID_NET_BW_STATS, "StatsMapB", S_IRGRP | S_IWGRP));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700215
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700216 RETURN_IF_NOT_OK(mIfaceIndexNameMap.init(IFACE_INDEX_NAME_MAP_PATH));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700217 RETURN_IF_NOT_OK(changeOwnerAndMode(IFACE_INDEX_NAME_MAP_PATH, AID_NET_BW_STATS,
mtk13799ae0704e2019-03-28 15:07:14 +0800218 "IfaceIndexNameMap", S_IRGRP));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700219
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700220 RETURN_IF_NOT_OK(mIfaceStatsMap.init(IFACE_STATS_MAP_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800221 RETURN_IF_NOT_OK(
222 changeOwnerAndMode(IFACE_STATS_MAP_PATH, AID_NET_BW_STATS, "IfaceStatsMap", S_IRGRP));
Chenbo Feng95892f32018-06-07 14:52:02 -0700223
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700224 RETURN_IF_NOT_OK(mConfigurationMap.init(CONFIGURATION_MAP_PATH));
Chenbo Fengf434e862018-06-27 14:08:39 -0700225 RETURN_IF_NOT_OK(changeOwnerAndMode(CONFIGURATION_MAP_PATH, AID_NET_BW_STATS,
mtk13799ae0704e2019-03-28 15:07:14 +0800226 "ConfigurationMap", S_IRGRP));
Chenbo Feng703798e2018-06-15 17:07:59 -0700227 RETURN_IF_NOT_OK(
Chenbo Fengf434e862018-06-27 14:08:39 -0700228 mConfigurationMap.writeValue(UID_RULES_CONFIGURATION_KEY, DEFAULT_CONFIG, BPF_ANY));
229 RETURN_IF_NOT_OK(mConfigurationMap.writeValue(CURRENT_STATS_MAP_CONFIGURATION_KEY, SELECT_MAP_A,
230 BPF_ANY));
Chenbo Feng703798e2018-06-15 17:07:59 -0700231
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700232 RETURN_IF_NOT_OK(mUidOwnerMap.init(UID_OWNER_MAP_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800233 RETURN_IF_NOT_OK(changeOwnerAndMode(UID_OWNER_MAP_PATH, AID_ROOT, "UidOwnerMap", S_NONE));
Bernie Innocenti6f9fd902018-10-11 20:50:23 +0900234 RETURN_IF_NOT_OK(mUidOwnerMap.clear());
Maciej Żenczykowski02554372019-04-01 10:44:54 -0700235 RETURN_IF_NOT_OK(mUidPermissionMap.init(UID_PERMISSION_MAP_PATH));
mtk13799ae0704e2019-03-28 15:07:14 +0800236
Hungming Chenb1ff3f12020-02-05 17:27:16 +0800237 RETURN_IF_NOT_OK(changeOwnerAndMode(TETHER_INGRESS_MAP_PATH, AID_NETWORK_STACK,
238 "TetherIngressMap", S_IRGRP | S_IWGRP));
Maciej Żenczykowski0510b012020-02-12 05:03:05 -0800239 RETURN_IF_NOT_OK(changeOwnerAndMode(TETHER_STATS_MAP_PATH, AID_NETWORK_STACK, "TetherStatsMap",
240 S_IRGRP | S_IWGRP));
Hungming Chenb1ff3f12020-02-05 17:27:16 +0800241
mtk13799ae0704e2019-03-28 15:07:14 +0800242 // The programs must be readable to process that modify iptables rules
243 RETURN_IF_NOT_OK(changeOwnerAndMode(XT_BPF_EGRESS_PROG_PATH, AID_NET_ADMIN,
244 "XtFilterEgressProgram", S_IRGRP));
245 RETURN_IF_NOT_OK(changeOwnerAndMode(XT_BPF_INGRESS_PROG_PATH, AID_NET_ADMIN,
246 "XtFilterIngressProgram", S_IRGRP));
247 RETURN_IF_NOT_OK(changeOwnerAndMode(XT_BPF_WHITELIST_PROG_PATH, AID_NET_ADMIN,
248 "XtWhitelistProgram", S_IRGRP));
249 RETURN_IF_NOT_OK(changeOwnerAndMode(XT_BPF_BLACKLIST_PROG_PATH, AID_NET_ADMIN,
250 "XtBlacklistProgram", S_IRGRP));
251
Chenbo Feng89c12f12018-03-21 10:29:18 -0700252 return netdutils::status::ok;
253}
254
Maciej Żenczykowski87017852020-01-17 19:22:11 -0800255static Status attachProgramToCgroup(const char* programPath, const unique_fd& cgroupFd,
Chenbo Fengb2d213d2018-12-04 11:31:00 -0800256 bpf_attach_type type) {
257 unique_fd cgroupProg(bpfFdGet(programPath, 0));
258 if (cgroupProg == -1) {
259 int ret = errno;
260 ALOGE("Failed to get program from %s: %s", programPath, strerror(ret));
261 return statusFromErrno(ret, "cgroup program get failed");
262 }
263 if (android::bpf::attachProgram(type, cgroupProg, cgroupFd)) {
264 int ret = errno;
265 ALOGE("Program from %s attach failed: %s", programPath, strerror(ret));
266 return statusFromErrno(ret, "program attach failed");
267 }
268 return netdutils::status::ok;
269}
270
271static Status initPrograms() {
Suren Baghdasaryane072a3c2019-01-16 14:36:07 -0800272 std::string cg2_path;
273
274 if (!CgroupGetControllerPath(CGROUPV2_CONTROLLER_NAME, &cg2_path)) {
275 int ret = errno;
276 ALOGE("Failed to find cgroup v2 root");
277 return statusFromErrno(ret, "Failed to find cgroup v2 root");
278 }
279
280 unique_fd cg_fd(open(cg2_path.c_str(), O_DIRECTORY | O_RDONLY | O_CLOEXEC));
Chenbo Fengb2d213d2018-12-04 11:31:00 -0800281 if (cg_fd == -1) {
282 int ret = errno;
283 ALOGE("Failed to open the cgroup directory: %s", strerror(ret));
284 return statusFromErrno(ret, "Open the cgroup directory failed");
285 }
286 RETURN_IF_NOT_OK(attachProgramToCgroup(BPF_EGRESS_PROG_PATH, cg_fd, BPF_CGROUP_INET_EGRESS));
287 RETURN_IF_NOT_OK(attachProgramToCgroup(BPF_INGRESS_PROG_PATH, cg_fd, BPF_CGROUP_INET_INGRESS));
Chenbo Fenga51f4fa2019-01-15 15:03:32 -0800288
289 // For the devices that support cgroup socket filter, the socket filter
290 // should be loaded successfully by bpfloader. So we attach the filter to
291 // cgroup if the program is pinned properly.
292 // TODO: delete the if statement once all devices should support cgroup
293 // socket filter (ie. the minimum kernel version required is 4.14).
294 if (!access(CGROUP_SOCKET_PROG_PATH, F_OK)) {
295 RETURN_IF_NOT_OK(
296 attachProgramToCgroup(CGROUP_SOCKET_PROG_PATH, cg_fd, BPF_CGROUP_INET_SOCK_CREATE));
297 }
Chenbo Fengb2d213d2018-12-04 11:31:00 -0800298 return netdutils::status::ok;
299}
300
Chenbo Feng89c12f12018-03-21 10:29:18 -0700301Status TrafficController::start() {
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800302 if (!mBpfEnabled) {
Chenbo Fengc10a8a42017-12-15 13:56:33 -0800303 return netdutils::status::ok;
Chenbo Fengf2759682017-10-10 17:31:57 -0700304 }
305
Bernie Innocenti6f9fd902018-10-11 20:50:23 +0900306 /* When netd restarts from a crash without total system reboot, the program
Chenbo Fengf2759682017-10-10 17:31:57 -0700307 * is still attached to the cgroup, detach it so the program can be freed
308 * and we can load and attach new program into the target cgroup.
309 *
310 * TODO: Scrape existing socket when run-time restart and clean up the map
311 * if the socket no longer exist
312 */
313
Chenbo Feng89c12f12018-03-21 10:29:18 -0700314 RETURN_IF_NOT_OK(initMaps());
Chenbo Feng7e974052018-02-28 22:57:21 -0800315
Chenbo Fengb2d213d2018-12-04 11:31:00 -0800316 RETURN_IF_NOT_OK(initPrograms());
317
Chenbo Feng7e974052018-02-28 22:57:21 -0800318 // Fetch the list of currently-existing interfaces. At this point NetlinkHandler is
319 // already running, so it will call addInterface() when any new interface appears.
320 std::map<std::string, uint32_t> ifacePairs;
321 ASSIGN_OR_RETURN(ifacePairs, InterfaceController::getIfaceList());
322 for (const auto& ifacePair:ifacePairs) {
323 addInterface(ifacePair.first.c_str(), ifacePair.second);
324 }
325
Chenbo Feng116d0552017-12-04 17:25:19 -0800326 auto result = makeSkDestroyListener();
327 if (!isOk(result)) {
328 ALOGE("Unable to create SkDestroyListener: %s", toString(result).c_str());
329 } else {
330 mSkDestroyListener = std::move(result.value());
331 }
332 // Rx handler extracts nfgenmsg looks up and invokes registered dispatch function.
333 const auto rxHandler = [this](const nlmsghdr&, const Slice msg) {
Chenbo Fengf01f5302019-05-07 12:28:13 -0700334 std::lock_guard guard(mMutex);
Chenbo Feng116d0552017-12-04 17:25:19 -0800335 inet_diag_msg diagmsg = {};
336 if (extract(msg, diagmsg) < sizeof(inet_diag_msg)) {
Bernie Innocenti6f9fd902018-10-11 20:50:23 +0900337 ALOGE("Unrecognized netlink message: %s", toString(msg).c_str());
Chenbo Feng116d0552017-12-04 17:25:19 -0800338 return;
339 }
340 uint64_t sock_cookie = static_cast<uint64_t>(diagmsg.id.idiag_cookie[0]) |
341 (static_cast<uint64_t>(diagmsg.id.idiag_cookie[1]) << 32);
342
Bernie Innocenti6f9fd902018-10-11 20:50:23 +0900343 Status s = mCookieTagMap.deleteValue(sock_cookie);
Chenbo Feng1d4c5db2018-10-18 15:50:46 -0700344 if (!isOk(s) && s.code() != ENOENT) {
Bernie Innocenti6f9fd902018-10-11 20:50:23 +0900345 ALOGE("Failed to delete cookie %" PRIx64 ": %s", sock_cookie, toString(s).c_str());
346 return;
347 }
Chenbo Feng116d0552017-12-04 17:25:19 -0800348 };
349 expectOk(mSkDestroyListener->subscribe(kSockDiagMsgType, rxHandler));
350
351 // In case multiple netlink message comes in as a stream, we need to handle the rxDone message
352 // properly.
353 const auto rxDoneHandler = [](const nlmsghdr&, const Slice msg) {
354 // Ignore NLMSG_DONE messages
355 inet_diag_msg diagmsg = {};
356 extract(msg, diagmsg);
357 };
358 expectOk(mSkDestroyListener->subscribe(kSockDiagDoneMsgType, rxDoneHandler));
359
Chenbo Feng05393d82018-01-09 15:18:43 -0800360 return netdutils::status::ok;
Chenbo Fengf2759682017-10-10 17:31:57 -0700361}
362
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800363int TrafficController::tagSocket(int sockFd, uint32_t tag, uid_t uid, uid_t callingUid) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700364 std::lock_guard guard(mMutex);
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800365 if (uid != callingUid && !hasUpdateDeviceStatsPermission(callingUid)) {
366 return -EPERM;
367 }
368
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800369 if (!mBpfEnabled) {
Chenbo Fengbc6d4702018-04-11 18:27:19 -0700370 if (legacy_tagSocket(sockFd, tag, uid)) return -errno;
371 return 0;
372 }
Chenbo Feng33cc1032017-10-23 15:16:37 -0700373
Chenbo Fengf2759682017-10-10 17:31:57 -0700374 uint64_t sock_cookie = getSocketCookie(sockFd);
Chenbo Fengef1cab32018-04-13 19:50:49 -0700375 if (sock_cookie == NONEXISTENT_COOKIE) return -errno;
Maciej Żenczykowski11ec78b2019-12-30 06:39:32 -0800376 UidTagValue newKey = {.uid = (uint32_t)uid, .tag = tag};
Chenbo Fengf2759682017-10-10 17:31:57 -0700377
Chenbo Fengb0495132019-04-10 12:54:41 -0700378 uint32_t totalEntryCount = 0;
Chenbo Feng82075e52019-04-12 19:21:47 -0700379 uint32_t perUidEntryCount = 0;
Chenbo Fengb0495132019-04-10 12:54:41 -0700380 // Now we go through the stats map and count how many entries are associated
381 // with target uid. If the uid entry hit the limit for each uid, we block
382 // the request to prevent the map from overflow. It is safe here to iterate
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700383 // over the map since when mMutex is hold, system server cannot toggle
Chenbo Fengb0495132019-04-10 12:54:41 -0700384 // the live stats map and clean it. So nobody can delete entries from the map.
Chenbo Feng82075e52019-04-12 19:21:47 -0700385 const auto countUidStatsEntries = [uid, &totalEntryCount, &perUidEntryCount](
Steven Morelanda3074542020-01-13 14:13:44 -0800386 const StatsKey& key,
387 const BpfMap<StatsKey, StatsValue>&) {
Chenbo Fengb0495132019-04-10 12:54:41 -0700388 if (key.uid == uid) {
Chenbo Feng82075e52019-04-12 19:21:47 -0700389 perUidEntryCount++;
Chenbo Fengb0495132019-04-10 12:54:41 -0700390 }
Chenbo Feng82075e52019-04-12 19:21:47 -0700391 totalEntryCount++;
Steven Morelanda3074542020-01-13 14:13:44 -0800392 return base::Result<void>();
Chenbo Fengb0495132019-04-10 12:54:41 -0700393 };
394 auto configuration = mConfigurationMap.readValue(CURRENT_STATS_MAP_CONFIGURATION_KEY);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900395 if (!configuration.ok()) {
Chenbo Fengb0495132019-04-10 12:54:41 -0700396 ALOGE("Failed to get current configuration: %s, fd: %d",
Steven Morelanda3074542020-01-13 14:13:44 -0800397 strerror(configuration.error().code()), mConfigurationMap.getMap().get());
398 return -configuration.error().code();
Chenbo Fengb0495132019-04-10 12:54:41 -0700399 }
Chenbo Feng36a40d12019-04-23 16:47:05 -0700400 if (configuration.value() != SELECT_MAP_A && configuration.value() != SELECT_MAP_B) {
Chenbo Fengb0495132019-04-10 12:54:41 -0700401 ALOGE("unknown configuration value: %d", configuration.value());
402 return -EINVAL;
403 }
Chenbo Feng36a40d12019-04-23 16:47:05 -0700404
405 BpfMap<StatsKey, StatsValue>& currentMap =
406 (configuration.value() == SELECT_MAP_A) ? mStatsMapA : mStatsMapB;
Steven Morelanda3074542020-01-13 14:13:44 -0800407 base::Result<void> res = currentMap.iterate(countUidStatsEntries);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900408 if (!res.ok()) {
Chenbo Feng36a40d12019-04-23 16:47:05 -0700409 ALOGE("Failed to count the stats entry in map %d: %s", currentMap.getMap().get(),
Steven Morelanda3074542020-01-13 14:13:44 -0800410 strerror(res.error().code()));
411 return -res.error().code();
Chenbo Feng36a40d12019-04-23 16:47:05 -0700412 }
413
Chenbo Feng82075e52019-04-12 19:21:47 -0700414 if (totalEntryCount > mTotalUidStatsEntriesLimit ||
415 perUidEntryCount > mPerUidStatsEntriesLimit) {
416 ALOGE("Too many stats entries in the map, total count: %u, uid(%u) count: %u, blocking tag"
417 " request to prevent map overflow",
418 totalEntryCount, uid, perUidEntryCount);
Chenbo Fengb0495132019-04-10 12:54:41 -0700419 return -EMFILE;
420 }
Chenbo Fengf2759682017-10-10 17:31:57 -0700421 // Update the tag information of a socket to the cookieUidMap. Use BPF_ANY
422 // flag so it will insert a new entry to the map if that value doesn't exist
423 // yet. And update the tag if there is already a tag stored. Since the eBPF
424 // program in kernel only read this map, and is protected by rcu read lock. It
425 // should be fine to cocurrently update the map while eBPF program is running.
Chenbo Feng36a40d12019-04-23 16:47:05 -0700426 res = mCookieTagMap.writeValue(sock_cookie, newKey, BPF_ANY);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900427 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -0800428 ALOGE("Failed to tag the socket: %s, fd: %d", strerror(res.error().code()),
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700429 mCookieTagMap.getMap().get());
Steven Morelanda3074542020-01-13 14:13:44 -0800430 return -res.error().code();
Chenbo Fengf2759682017-10-10 17:31:57 -0700431 }
Steven Morelanda3074542020-01-13 14:13:44 -0800432 return 0;
Chenbo Fengf2759682017-10-10 17:31:57 -0700433}
434
435int TrafficController::untagSocket(int sockFd) {
Chenbo Fengf01f5302019-05-07 12:28:13 -0700436 std::lock_guard guard(mMutex);
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800437 if (!mBpfEnabled) {
Chenbo Fengbc6d4702018-04-11 18:27:19 -0700438 if (legacy_untagSocket(sockFd)) return -errno;
439 return 0;
440 }
Chenbo Fengf2759682017-10-10 17:31:57 -0700441 uint64_t sock_cookie = getSocketCookie(sockFd);
442
Chenbo Fengef1cab32018-04-13 19:50:49 -0700443 if (sock_cookie == NONEXISTENT_COOKIE) return -errno;
Steven Morelanda3074542020-01-13 14:13:44 -0800444 base::Result<void> res = mCookieTagMap.deleteValue(sock_cookie);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900445 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -0800446 ALOGE("Failed to untag socket: %s\n", strerror(res.error().code()));
447 return -res.error().code();
Chenbo Fengf2759682017-10-10 17:31:57 -0700448 }
Steven Morelanda3074542020-01-13 14:13:44 -0800449 return 0;
Chenbo Fengf2759682017-10-10 17:31:57 -0700450}
451
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800452int TrafficController::setCounterSet(int counterSetNum, uid_t uid, uid_t callingUid) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700453 if (counterSetNum < 0 || counterSetNum >= OVERFLOW_COUNTERSET) return -EINVAL;
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800454
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700455 std::lock_guard guard(mMutex);
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800456 if (!hasUpdateDeviceStatsPermission(callingUid)) return -EPERM;
457
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800458 if (!mBpfEnabled) {
Chenbo Fengbc6d4702018-04-11 18:27:19 -0700459 if (legacy_setCounterSet(counterSetNum, uid)) return -errno;
460 return 0;
461 }
Chenbo Fengc10a8a42017-12-15 13:56:33 -0800462
463 // The default counter set for all uid is 0, so deleting the current counterset for that uid
464 // will automatically set it to 0.
Chenbo Fengf2759682017-10-10 17:31:57 -0700465 if (counterSetNum == 0) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700466 Status res = mUidCounterSetMap.deleteValue(uid);
467 if (isOk(res) || (!isOk(res) && res.code() == ENOENT)) {
Chenbo Fengf2759682017-10-10 17:31:57 -0700468 return 0;
469 } else {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700470 ALOGE("Failed to delete the counterSet: %s\n", strerror(res.code()));
471 return -res.code();
Chenbo Fengf2759682017-10-10 17:31:57 -0700472 }
473 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700474 uint8_t tmpCounterSetNum = (uint8_t)counterSetNum;
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800475 Status res = mUidCounterSetMap.writeValue(uid, tmpCounterSetNum, BPF_ANY);
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700476 if (!isOk(res)) {
477 ALOGE("Failed to set the counterSet: %s, fd: %d", strerror(res.code()),
478 mUidCounterSetMap.getMap().get());
479 return -res.code();
Chenbo Fengf2759682017-10-10 17:31:57 -0700480 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700481 return 0;
Chenbo Fengf2759682017-10-10 17:31:57 -0700482}
483
Chenbo Fengf434e862018-06-27 14:08:39 -0700484// This method only get called by system_server when an app get uinstalled, it
485// is called inside removeUidsLocked() while holding mStatsLock. So it is safe
486// to iterate and modify the stats maps.
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800487int TrafficController::deleteTagData(uint32_t tag, uid_t uid, uid_t callingUid) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700488 std::lock_guard guard(mMutex);
Chenbo Fengb4a4fa12019-01-09 17:20:45 -0800489 if (!hasUpdateDeviceStatsPermission(callingUid)) return -EPERM;
490
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800491 if (!mBpfEnabled) {
Chenbo Fengbc6d4702018-04-11 18:27:19 -0700492 if (legacy_deleteTagData(tag, uid)) return -errno;
493 return 0;
494 }
Chenbo Feng33cc1032017-10-23 15:16:37 -0700495
Chenbo Fengc10a8a42017-12-15 13:56:33 -0800496 // First we go through the cookieTagMap to delete the target uid tag combination. Or delete all
Chenbo Fengef1cab32018-04-13 19:50:49 -0700497 // the tags related to the uid if the tag is 0.
Maciej Żenczykowski11ec78b2019-12-30 06:39:32 -0800498 const auto deleteMatchedCookieEntries = [uid, tag](const uint64_t& key,
499 const UidTagValue& value,
500 BpfMap<uint64_t, UidTagValue>& map) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700501 if (value.uid == uid && (value.tag == tag || tag == 0)) {
Steven Morelanda3074542020-01-13 14:13:44 -0800502 auto res = map.deleteValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900503 if (res.ok() || (res.error().code() == ENOENT)) {
Steven Morelanda3074542020-01-13 14:13:44 -0800504 return base::Result<void>();
Chenbo Fengf2759682017-10-10 17:31:57 -0700505 }
Steven Morelanda3074542020-01-13 14:13:44 -0800506 ALOGE("Failed to delete data(cookie = %" PRIu64 "): %s\n", key,
507 strerror(res.error().code()));
Chenbo Fengf2759682017-10-10 17:31:57 -0700508 }
Chenbo Fengef1cab32018-04-13 19:50:49 -0700509 // Move forward to next cookie in the map.
Steven Morelanda3074542020-01-13 14:13:44 -0800510 return base::Result<void>();
Chenbo Fengef1cab32018-04-13 19:50:49 -0700511 };
Steven Morelanda3074542020-01-13 14:13:44 -0800512 mCookieTagMap.iterateWithValue(deleteMatchedCookieEntries);
Chenbo Fengf2759682017-10-10 17:31:57 -0700513 // Now we go through the Tag stats map and delete the data entry with correct uid and tag
Chenbo Fengef1cab32018-04-13 19:50:49 -0700514 // combination. Or all tag stats under that uid if the target tag is 0.
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700515 const auto deleteMatchedUidTagEntries = [uid, tag](const StatsKey& key,
516 BpfMap<StatsKey, StatsValue>& map) {
517 if (key.uid == uid && (key.tag == tag || tag == 0)) {
Steven Morelanda3074542020-01-13 14:13:44 -0800518 auto res = map.deleteValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900519 if (res.ok() || (res.error().code() == ENOENT)) {
Chenbo Fengef1cab32018-04-13 19:50:49 -0700520 //Entry is deleted, use the current key to get a new nextKey;
Steven Morelanda3074542020-01-13 14:13:44 -0800521 return base::Result<void>();
Chenbo Fengf2759682017-10-10 17:31:57 -0700522 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700523 ALOGE("Failed to delete data(uid=%u, tag=%u): %s\n", key.uid, key.tag,
Steven Morelanda3074542020-01-13 14:13:44 -0800524 strerror(res.error().code()));
Chenbo Fengf2759682017-10-10 17:31:57 -0700525 }
Steven Morelanda3074542020-01-13 14:13:44 -0800526 return base::Result<void>();
Chenbo Fengef1cab32018-04-13 19:50:49 -0700527 };
Steven Morelanda3074542020-01-13 14:13:44 -0800528 mStatsMapB.iterate(deleteMatchedUidTagEntries);
529 mStatsMapA.iterate(deleteMatchedUidTagEntries);
Chenbo Fengf2759682017-10-10 17:31:57 -0700530 // If the tag is not zero, we already deleted all the data entry required. If tag is 0, we also
Chenbo Fenged37fea2017-12-13 19:35:01 -0800531 // need to delete the stats stored in uidStatsMap and counterSet map.
Chenbo Fengc10a8a42017-12-15 13:56:33 -0800532 if (tag != 0) return 0;
533
Steven Morelanda3074542020-01-13 14:13:44 -0800534 auto res = mUidCounterSetMap.deleteValue(uid);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900535 if (!res.ok() && res.error().code() != ENOENT) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700536 ALOGE("Failed to delete counterSet data(uid=%u, tag=%u): %s\n", uid, tag,
Steven Morelanda3074542020-01-13 14:13:44 -0800537 strerror(res.error().code()));
Chenbo Fengc10a8a42017-12-15 13:56:33 -0800538 }
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700539
Steven Morelanda3074542020-01-13 14:13:44 -0800540 auto deleteAppUidStatsEntry = [uid](const uint32_t& key,
541 BpfMap<uint32_t, StatsValue>& map) -> base::Result<void> {
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700542 if (key == uid) {
Steven Morelanda3074542020-01-13 14:13:44 -0800543 auto res = map.deleteValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900544 if (res.ok() || (res.error().code() == ENOENT)) {
Steven Morelanda3074542020-01-13 14:13:44 -0800545 return {};
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700546 }
Steven Morelanda3074542020-01-13 14:13:44 -0800547 ALOGE("Failed to delete data(uid=%u): %s", key, strerror(res.error().code()));
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700548 }
Steven Morelanda3074542020-01-13 14:13:44 -0800549 return {};
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700550 };
Steven Morelanda3074542020-01-13 14:13:44 -0800551 mAppUidStatsMap.iterate(deleteAppUidStatsEntry);
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700552 return 0;
Chenbo Fengf2759682017-10-10 17:31:57 -0700553}
554
Chenbo Feng7e974052018-02-28 22:57:21 -0800555int TrafficController::addInterface(const char* name, uint32_t ifaceIndex) {
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800556 if (!mBpfEnabled) return 0;
Chenbo Feng7e974052018-02-28 22:57:21 -0800557
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700558 IfaceValue iface;
Chenbo Feng7e974052018-02-28 22:57:21 -0800559 if (ifaceIndex == 0) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700560 ALOGE("Unknown interface %s(%d)", name, ifaceIndex);
Chenbo Feng7e974052018-02-28 22:57:21 -0800561 return -1;
562 }
563
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700564 strlcpy(iface.name, name, sizeof(IfaceValue));
565 Status res = mIfaceIndexNameMap.writeValue(ifaceIndex, iface, BPF_ANY);
566 if (!isOk(res)) {
567 ALOGE("Failed to add iface %s(%d): %s", name, ifaceIndex, strerror(res.code()));
568 return -res.code();
Chenbo Feng7e974052018-02-28 22:57:21 -0800569 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700570 return 0;
Chenbo Feng7e974052018-02-28 22:57:21 -0800571}
572
Chenbo Feng703798e2018-06-15 17:07:59 -0700573Status TrafficController::updateOwnerMapEntry(UidOwnerMatchType match, uid_t uid, FirewallRule rule,
574 FirewallType type) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700575 std::lock_guard guard(mMutex);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700576 if ((rule == ALLOW && type == WHITELIST) || (rule == DENY && type == BLACKLIST)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100577 RETURN_IF_NOT_OK(addRule(mUidOwnerMap, uid, match));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700578 } else if ((rule == ALLOW && type == BLACKLIST) || (rule == DENY && type == WHITELIST)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100579 RETURN_IF_NOT_OK(removeRule(mUidOwnerMap, uid, match));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700580 } else {
581 //Cannot happen.
Rubin Xuec27ff22019-01-08 21:33:03 +0000582 return statusFromErrno(EINVAL, "");
Chenbo Feng89c12f12018-03-21 10:29:18 -0700583 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700584 return netdutils::status::ok;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700585}
586
Chenbo Feng703798e2018-06-15 17:07:59 -0700587UidOwnerMatchType TrafficController::jumpOpToMatch(BandwidthController::IptJumpOp jumpHandling) {
Chenbo Feng95892f32018-06-07 14:52:02 -0700588 switch (jumpHandling) {
589 case BandwidthController::IptJumpReject:
Chenbo Feng703798e2018-06-15 17:07:59 -0700590 return PENALTY_BOX_MATCH;
Chenbo Feng95892f32018-06-07 14:52:02 -0700591 case BandwidthController::IptJumpReturn:
Chenbo Feng703798e2018-06-15 17:07:59 -0700592 return HAPPY_BOX_MATCH;
Chenbo Feng95892f32018-06-07 14:52:02 -0700593 case BandwidthController::IptJumpNoAdd:
594 return NO_MATCH;
595 }
596}
597
Rubin Xu5ca8e802019-04-05 11:50:32 +0100598Status TrafficController::removeRule(BpfMap<uint32_t, UidOwnerValue>& map, uint32_t uid,
599 UidOwnerMatchType match) {
Chenbo Feng703798e2018-06-15 17:07:59 -0700600 auto oldMatch = map.readValue(uid);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900601 if (oldMatch.ok()) {
Nick Desaulniers6b357502019-10-11 09:26:44 -0700602 UidOwnerValue newMatch = {
603 .iif = (match == IIF_MATCH) ? 0 : oldMatch.value().iif,
604 .rule = static_cast<uint8_t>(oldMatch.value().rule & ~match),
605 };
Rubin Xuec27ff22019-01-08 21:33:03 +0000606 if (newMatch.rule == 0) {
Chenbo Feng703798e2018-06-15 17:07:59 -0700607 RETURN_IF_NOT_OK(map.deleteValue(uid));
608 } else {
609 RETURN_IF_NOT_OK(map.writeValue(uid, newMatch, BPF_ANY));
610 }
611 } else {
612 return statusFromErrno(ENOENT, StringPrintf("uid: %u does not exist in map", uid));
613 }
614 return netdutils::status::ok;
615}
616
Rubin Xu5ca8e802019-04-05 11:50:32 +0100617Status TrafficController::addRule(BpfMap<uint32_t, UidOwnerValue>& map, uint32_t uid,
618 UidOwnerMatchType match, uint32_t iif) {
Rubin Xuec27ff22019-01-08 21:33:03 +0000619 // iif should be non-zero if and only if match == MATCH_IIF
620 if (match == IIF_MATCH && iif == 0) {
621 return statusFromErrno(EINVAL, "Interface match must have nonzero interface index");
622 } else if (match != IIF_MATCH && iif != 0) {
623 return statusFromErrno(EINVAL, "Non-interface match must have zero interface index");
624 }
Chenbo Feng703798e2018-06-15 17:07:59 -0700625 auto oldMatch = map.readValue(uid);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900626 if (oldMatch.ok()) {
Nick Desaulniers6b357502019-10-11 09:26:44 -0700627 UidOwnerValue newMatch = {
628 .iif = iif ? iif : oldMatch.value().iif,
629 .rule = static_cast<uint8_t>(oldMatch.value().rule | match),
630 };
Rubin Xuec27ff22019-01-08 21:33:03 +0000631 RETURN_IF_NOT_OK(map.writeValue(uid, newMatch, BPF_ANY));
Chenbo Feng703798e2018-06-15 17:07:59 -0700632 } else {
Nick Desaulniers6b357502019-10-11 09:26:44 -0700633 UidOwnerValue newMatch = {
634 .iif = iif,
635 .rule = static_cast<uint8_t>(match),
636 };
Rubin Xuec27ff22019-01-08 21:33:03 +0000637 RETURN_IF_NOT_OK(map.writeValue(uid, newMatch, BPF_ANY));
Chenbo Feng703798e2018-06-15 17:07:59 -0700638 }
639 return netdutils::status::ok;
640}
641
642Status TrafficController::updateUidOwnerMap(const std::vector<std::string>& appStrUids,
643 BandwidthController::IptJumpOp jumpHandling,
644 BandwidthController::IptOp op) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700645 std::lock_guard guard(mMutex);
Chenbo Feng703798e2018-06-15 17:07:59 -0700646 UidOwnerMatchType match = jumpOpToMatch(jumpHandling);
647 if (match == NO_MATCH) {
648 return statusFromErrno(
649 EINVAL, StringPrintf("invalid IptJumpOp: %d, command: %d", jumpHandling, match));
Chenbo Feng95892f32018-06-07 14:52:02 -0700650 }
651 for (const auto& appStrUid : appStrUids) {
652 char* endPtr;
653 long uid = strtol(appStrUid.c_str(), &endPtr, 10);
654 if ((errno == ERANGE && (uid == LONG_MAX || uid == LONG_MIN)) ||
655 (endPtr == appStrUid.c_str()) || (*endPtr != '\0')) {
656 return statusFromErrno(errno, "invalid uid string:" + appStrUid);
657 }
658
Chenbo Feng95892f32018-06-07 14:52:02 -0700659 if (op == BandwidthController::IptOpDelete) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100660 RETURN_IF_NOT_OK(removeRule(mUidOwnerMap, uid, match));
Chenbo Feng95892f32018-06-07 14:52:02 -0700661 } else if (op == BandwidthController::IptOpInsert) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100662 RETURN_IF_NOT_OK(addRule(mUidOwnerMap, uid, match));
Chenbo Feng95892f32018-06-07 14:52:02 -0700663 } else {
664 // Cannot happen.
Chenbo Feng703798e2018-06-15 17:07:59 -0700665 return statusFromErrno(EINVAL, StringPrintf("invalid IptOp: %d, %d", op, match));
Chenbo Feng95892f32018-06-07 14:52:02 -0700666 }
667 }
668 return netdutils::status::ok;
669}
670
Chenbo Feng89c12f12018-03-21 10:29:18 -0700671int TrafficController::changeUidOwnerRule(ChildChain chain, uid_t uid, FirewallRule rule,
672 FirewallType type) {
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800673 if (!mBpfEnabled) {
Chenbo Feng89c12f12018-03-21 10:29:18 -0700674 ALOGE("bpf is not set up, should use iptables rule");
675 return -ENOSYS;
676 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700677 Status res;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700678 switch (chain) {
679 case DOZABLE:
Chenbo Feng703798e2018-06-15 17:07:59 -0700680 res = updateOwnerMapEntry(DOZABLE_MATCH, uid, rule, type);
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700681 break;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700682 case STANDBY:
Chenbo Feng703798e2018-06-15 17:07:59 -0700683 res = updateOwnerMapEntry(STANDBY_MATCH, uid, rule, type);
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700684 break;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700685 case POWERSAVE:
Chenbo Feng703798e2018-06-15 17:07:59 -0700686 res = updateOwnerMapEntry(POWERSAVE_MATCH, uid, rule, type);
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700687 break;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700688 case NONE:
689 default:
690 return -EINVAL;
691 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700692 if (!isOk(res)) {
693 ALOGE("change uid(%u) rule of %d failed: %s, rule: %d, type: %d", uid, chain,
694 res.msg().c_str(), rule, type);
695 return -res.code();
696 }
697 return 0;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700698}
699
Rubin Xu5ca8e802019-04-05 11:50:32 +0100700Status TrafficController::replaceRulesInMap(const UidOwnerMatchType match,
701 const std::vector<int32_t>& uids) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700702 std::lock_guard guard(mMutex);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700703 std::set<int32_t> uidSet(uids.begin(), uids.end());
704 std::vector<uint32_t> uidsToDelete;
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700705 auto getUidsToDelete = [&uidsToDelete, &uidSet](const uint32_t& key,
Rubin Xuec27ff22019-01-08 21:33:03 +0000706 const BpfMap<uint32_t, UidOwnerValue>&) {
Chenbo Feng703798e2018-06-15 17:07:59 -0700707 if (uidSet.find((int32_t) key) == uidSet.end()) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700708 uidsToDelete.push_back(key);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700709 }
Steven Morelanda3074542020-01-13 14:13:44 -0800710 return base::Result<void>();
Chenbo Feng89c12f12018-03-21 10:29:18 -0700711 };
Chenbo Feng703798e2018-06-15 17:07:59 -0700712 RETURN_IF_NOT_OK(mUidOwnerMap.iterate(getUidsToDelete));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700713
714 for(auto uid : uidsToDelete) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100715 RETURN_IF_NOT_OK(removeRule(mUidOwnerMap, uid, match));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700716 }
717
718 for (auto uid : uids) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100719 RETURN_IF_NOT_OK(addRule(mUidOwnerMap, uid, match));
Chenbo Feng89c12f12018-03-21 10:29:18 -0700720 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700721 return netdutils::status::ok;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700722}
723
Rubin Xuec27ff22019-01-08 21:33:03 +0000724Status TrafficController::addUidInterfaceRules(const int iif,
725 const std::vector<int32_t>& uidsToAdd) {
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800726 if (!mBpfEnabled) {
Rubin Xuec27ff22019-01-08 21:33:03 +0000727 ALOGW("UID ingress interface filtering not possible without BPF owner match");
728 return statusFromErrno(EOPNOTSUPP, "eBPF not supported");
729 }
730 if (!iif) {
731 return statusFromErrno(EINVAL, "Interface rule must specify interface");
732 }
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700733 std::lock_guard guard(mMutex);
Rubin Xuec27ff22019-01-08 21:33:03 +0000734
735 for (auto uid : uidsToAdd) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100736 netdutils::Status result = addRule(mUidOwnerMap, uid, IIF_MATCH, iif);
Rubin Xuec27ff22019-01-08 21:33:03 +0000737 if (!isOk(result)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100738 ALOGW("addRule failed(%d): uid=%d iif=%d", result.code(), uid, iif);
Rubin Xuec27ff22019-01-08 21:33:03 +0000739 }
740 }
741 return netdutils::status::ok;
742}
743
744Status TrafficController::removeUidInterfaceRules(const std::vector<int32_t>& uidsToDelete) {
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800745 if (!mBpfEnabled) {
Rubin Xuec27ff22019-01-08 21:33:03 +0000746 ALOGW("UID ingress interface filtering not possible without BPF owner match");
747 return statusFromErrno(EOPNOTSUPP, "eBPF not supported");
748 }
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700749 std::lock_guard guard(mMutex);
Rubin Xuec27ff22019-01-08 21:33:03 +0000750
751 for (auto uid : uidsToDelete) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100752 netdutils::Status result = removeRule(mUidOwnerMap, uid, IIF_MATCH);
Rubin Xuec27ff22019-01-08 21:33:03 +0000753 if (!isOk(result)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100754 ALOGW("removeRule failed(%d): uid=%d", result.code(), uid);
Rubin Xuec27ff22019-01-08 21:33:03 +0000755 }
756 }
757 return netdutils::status::ok;
758}
759
Chenbo Feng89c12f12018-03-21 10:29:18 -0700760int TrafficController::replaceUidOwnerMap(const std::string& name, bool isWhitelist,
761 const std::vector<int32_t>& uids) {
Chenbo Feng89c12f12018-03-21 10:29:18 -0700762 FirewallRule rule;
763 FirewallType type;
764 if (isWhitelist) {
765 type = WHITELIST;
766 rule = ALLOW;
767 } else {
768 type = BLACKLIST;
769 rule = DENY;
770 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700771 Status res;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700772 if (!name.compare(FirewallController::LOCAL_DOZABLE)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100773 res = replaceRulesInMap(DOZABLE_MATCH, uids);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700774 } else if (!name.compare(FirewallController::LOCAL_STANDBY)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100775 res = replaceRulesInMap(STANDBY_MATCH, uids);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700776 } else if (!name.compare(FirewallController::LOCAL_POWERSAVE)) {
Rubin Xu5ca8e802019-04-05 11:50:32 +0100777 res = replaceRulesInMap(POWERSAVE_MATCH, uids);
Chenbo Feng89c12f12018-03-21 10:29:18 -0700778 } else {
779 ALOGE("unknown chain name: %s", name.c_str());
780 return -EINVAL;
781 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700782 if (!isOk(res)) {
783 ALOGE("Failed to clean up chain: %s: %s", name.c_str(), res.msg().c_str());
784 return -res.code();
Chenbo Feng89c12f12018-03-21 10:29:18 -0700785 }
786 return 0;
787}
788
789int TrafficController::toggleUidOwnerMap(ChildChain chain, bool enable) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700790 std::lock_guard guard(mMutex);
Chenbo Fengf434e862018-06-27 14:08:39 -0700791 uint32_t key = UID_RULES_CONFIGURATION_KEY;
Chenbo Feng703798e2018-06-15 17:07:59 -0700792 auto oldConfiguration = mConfigurationMap.readValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900793 if (!oldConfiguration.ok()) {
Chenbo Feng703798e2018-06-15 17:07:59 -0700794 ALOGE("Cannot read the old configuration from map: %s",
Steven Morelanda3074542020-01-13 14:13:44 -0800795 oldConfiguration.error().message().c_str());
796 return -oldConfiguration.error().code();
Chenbo Feng703798e2018-06-15 17:07:59 -0700797 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700798 Status res;
Chenbo Feng703798e2018-06-15 17:07:59 -0700799 BpfConfig newConfiguration;
800 uint8_t match;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700801 switch (chain) {
802 case DOZABLE:
Chenbo Feng703798e2018-06-15 17:07:59 -0700803 match = DOZABLE_MATCH;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700804 break;
805 case STANDBY:
Chenbo Feng703798e2018-06-15 17:07:59 -0700806 match = STANDBY_MATCH;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700807 break;
808 case POWERSAVE:
Chenbo Feng703798e2018-06-15 17:07:59 -0700809 match = POWERSAVE_MATCH;
Chenbo Feng89c12f12018-03-21 10:29:18 -0700810 break;
811 default:
812 return -EINVAL;
813 }
Chenbo Feng703798e2018-06-15 17:07:59 -0700814 newConfiguration =
815 enable ? (oldConfiguration.value() | match) : (oldConfiguration.value() & (~match));
816 res = mConfigurationMap.writeValue(key, newConfiguration, BPF_EXIST);
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700817 if (!isOk(res)) {
818 ALOGE("Failed to toggleUidOwnerMap(%d): %s", chain, res.msg().c_str());
Chenbo Feng89c12f12018-03-21 10:29:18 -0700819 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700820 return -res.code();
Chenbo Feng89c12f12018-03-21 10:29:18 -0700821}
822
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800823bool TrafficController::getBpfEnabled() {
824 return mBpfEnabled;
Chenbo Feng07d43fe2017-12-21 14:38:51 -0800825}
826
Chenbo Feng873ae142019-04-10 12:26:06 -0700827Status TrafficController::swapActiveStatsMap() {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700828 std::lock_guard guard(mMutex);
Chenbo Feng873ae142019-04-10 12:26:06 -0700829
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800830 if (!mBpfEnabled) {
Chenbo Feng873ae142019-04-10 12:26:06 -0700831 return statusFromErrno(EOPNOTSUPP, "This device doesn't have eBPF support");
832 }
833
834 uint32_t key = CURRENT_STATS_MAP_CONFIGURATION_KEY;
835 auto oldConfiguration = mConfigurationMap.readValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900836 if (!oldConfiguration.ok()) {
Chenbo Feng873ae142019-04-10 12:26:06 -0700837 ALOGE("Cannot read the old configuration from map: %s",
Steven Morelanda3074542020-01-13 14:13:44 -0800838 oldConfiguration.error().message().c_str());
839 return Status(oldConfiguration.error().code(), oldConfiguration.error().message());
Chenbo Feng873ae142019-04-10 12:26:06 -0700840 }
841
842 // Write to the configuration map to inform the kernel eBPF program to switch
843 // from using one map to the other. Use flag BPF_EXIST here since the map should
844 // be already populated in initMaps.
845 uint8_t newConfigure = (oldConfiguration.value() == SELECT_MAP_A) ? SELECT_MAP_B : SELECT_MAP_A;
Steven Morelanda3074542020-01-13 14:13:44 -0800846 auto res = mConfigurationMap.writeValue(CURRENT_STATS_MAP_CONFIGURATION_KEY, newConfigure,
847 BPF_EXIST);
Bernie Innocenti615fd742020-02-06 03:55:09 +0900848 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -0800849 ALOGE("Failed to toggle the stats map: %s", strerror(res.error().code()));
Chenbo Feng873ae142019-04-10 12:26:06 -0700850 return res;
851 }
852 // After changing the config, we need to make sure all the current running
853 // eBPF programs are finished and all the CPUs are aware of this config change
854 // before we modify the old map. So we do a special hack here to wait for
855 // the kernel to do a synchronize_rcu(). Once the kernel called
856 // synchronize_rcu(), the config we just updated will be available to all cores
857 // and the next eBPF programs triggered inside the kernel will use the new
858 // map configuration. So once this function returns we can safely modify the
859 // old stats map without concerning about race between the kernel and
860 // userspace.
861 int ret = synchronizeKernelRCU();
862 if (ret) {
863 ALOGE("map swap synchronize_rcu() ended with failure: %s", strerror(-ret));
864 return statusFromErrno(-ret, "map swap synchronize_rcu() failed");
865 }
866 return netdutils::status::ok;
867}
868
Chenbo Feng48eaed32018-12-26 17:40:21 -0800869void TrafficController::setPermissionForUids(int permission, const std::vector<uid_t>& uids) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700870 std::lock_guard guard(mMutex);
Chenbo Fengbf660aa2019-02-26 16:12:27 -0800871 if (permission == INetd::PERMISSION_UNINSTALLED) {
872 for (uid_t uid : uids) {
873 // Clean up all permission information for the related uid if all the
874 // packages related to it are uninstalled.
875 mPrivilegedUser.erase(uid);
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800876 if (mBpfEnabled) {
Chenbo Feng97c88db2019-04-24 12:19:16 -0700877 Status ret = mUidPermissionMap.deleteValue(uid);
Maciej Żenczykowski928ea232019-08-20 17:28:05 -0700878 if (!isOk(ret) && ret.code() != ENOENT) {
Chenbo Feng97c88db2019-04-24 12:19:16 -0700879 ALOGE("Failed to clean up the permission for %u: %s", uid,
880 strerror(ret.code()));
881 }
882 }
Chenbo Fengbf660aa2019-02-26 16:12:27 -0800883 }
884 return;
885 }
886
Chenbo Feng48eaed32018-12-26 17:40:21 -0800887 bool privileged = (permission & INetd::PERMISSION_UPDATE_DEVICE_STATS);
888
889 for (uid_t uid : uids) {
Chenbo Feng97c88db2019-04-24 12:19:16 -0700890 if (privileged) {
891 mPrivilegedUser.insert(uid);
892 } else {
893 mPrivilegedUser.erase(uid);
894 }
895
896 // Skip the bpf map operation if not supported.
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800897 if (!mBpfEnabled) {
Chenbo Feng97c88db2019-04-24 12:19:16 -0700898 continue;
899 }
Chenbo Feng527908a2019-04-02 20:14:11 -0700900 // The map stores all the permissions that the UID has, except if the only permission
901 // the UID has is the INTERNET permission, then the UID should not appear in the map.
902 if (permission != INetd::PERMISSION_INTERNET) {
Chenbo Fengbf660aa2019-02-26 16:12:27 -0800903 Status ret = mUidPermissionMap.writeValue(uid, permission, BPF_ANY);
Chenbo Feng48eaed32018-12-26 17:40:21 -0800904 if (!isOk(ret)) {
Chenbo Feng527908a2019-04-02 20:14:11 -0700905 ALOGE("Failed to set permission: %s of uid(%u) to permission map: %s",
906 UidPermissionTypeToString(permission).c_str(), uid, strerror(ret.code()));
Chenbo Feng48eaed32018-12-26 17:40:21 -0800907 }
908 } else {
909 Status ret = mUidPermissionMap.deleteValue(uid);
910 if (!isOk(ret) && ret.code() != ENOENT) {
Chenbo Feng527908a2019-04-02 20:14:11 -0700911 ALOGE("Failed to remove uid %u from permission map: %s", uid, strerror(ret.code()));
Chenbo Feng48eaed32018-12-26 17:40:21 -0800912 }
913 }
Chenbo Feng48eaed32018-12-26 17:40:21 -0800914 }
915}
916
Chenbo Fengef297172018-03-26 10:53:33 -0700917std::string getProgramStatus(const char *path) {
918 int ret = access(path, R_OK);
919 if (ret == 0) {
920 return StringPrintf("OK");
921 }
922 if (ret != 0 && errno == ENOENT) {
923 return StringPrintf("program is missing at: %s", path);
924 }
925 return StringPrintf("check Program %s error: %s", path, strerror(errno));
926}
927
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700928std::string getMapStatus(const base::unique_fd& map_fd, const char* path) {
Chenbo Fengef297172018-03-26 10:53:33 -0700929 if (map_fd.get() < 0) {
930 return StringPrintf("map fd lost");
931 }
932 if (access(path, F_OK) != 0) {
933 return StringPrintf("map not pinned to location: %s", path);
934 }
935 return StringPrintf("OK");
936}
937
Bernie Innocentia5161a02019-01-30 22:40:53 +0900938// NOLINTNEXTLINE(google-runtime-references): grandfathered pass by non-const reference
Bernie Innocenti15bb55c2018-06-03 16:19:51 +0900939void dumpBpfMap(const std::string& mapName, DumpWriter& dw, const std::string& header) {
Chenbo Fengef297172018-03-26 10:53:33 -0700940 dw.blankline();
941 dw.println("%s:", mapName.c_str());
Erik Klineb31fd692018-06-06 20:50:11 +0900942 if (!header.empty()) {
943 dw.println(header);
Chenbo Fengef297172018-03-26 10:53:33 -0700944 }
945}
946
947const String16 TrafficController::DUMP_KEYWORD = String16("trafficcontroller");
948
949void TrafficController::dump(DumpWriter& dw, bool verbose) {
Chenbo Feng84d9f9f2019-04-12 15:31:02 -0700950 std::lock_guard guard(mMutex);
Erik Klineb31fd692018-06-06 20:50:11 +0900951 ScopedIndent indentTop(dw);
Chenbo Fengef297172018-03-26 10:53:33 -0700952 dw.println("TrafficController");
953
Erik Klineb31fd692018-06-06 20:50:11 +0900954 ScopedIndent indentPreBpfModule(dw);
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800955 dw.println("BPF module status: %s", mBpfEnabled ? "enabled" : "disabled");
956 dw.println("BPF support level: %s", BpfLevelToString(getBpfSupportLevel()).c_str());
Chenbo Fengef297172018-03-26 10:53:33 -0700957
Maciej Żenczykowski3d7c9662020-02-11 17:11:26 -0800958 if (!mBpfEnabled) {
Chenbo Fengef297172018-03-26 10:53:33 -0700959 return;
Erik Klineb31fd692018-06-06 20:50:11 +0900960 }
Chenbo Fengef297172018-03-26 10:53:33 -0700961
962 dw.blankline();
963 dw.println("mCookieTagMap status: %s",
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700964 getMapStatus(mCookieTagMap.getMap(), COOKIE_TAG_MAP_PATH).c_str());
Chenbo Fengef297172018-03-26 10:53:33 -0700965 dw.println("mUidCounterSetMap status: %s",
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700966 getMapStatus(mUidCounterSetMap.getMap(), UID_COUNTERSET_MAP_PATH).c_str());
Chenbo Fengbc4a15f2018-05-11 19:15:15 -0700967 dw.println("mAppUidStatsMap status: %s",
968 getMapStatus(mAppUidStatsMap.getMap(), APP_UID_STATS_MAP_PATH).c_str());
Chenbo Fengf434e862018-06-27 14:08:39 -0700969 dw.println("mStatsMapA status: %s",
970 getMapStatus(mStatsMapA.getMap(), STATS_MAP_A_PATH).c_str());
971 dw.println("mStatsMapB status: %s",
972 getMapStatus(mStatsMapB.getMap(), STATS_MAP_B_PATH).c_str());
Chenbo Fengef297172018-03-26 10:53:33 -0700973 dw.println("mIfaceIndexNameMap status: %s",
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700974 getMapStatus(mIfaceIndexNameMap.getMap(), IFACE_INDEX_NAME_MAP_PATH).c_str());
Chenbo Fengef297172018-03-26 10:53:33 -0700975 dw.println("mIfaceStatsMap status: %s",
Chenbo Feng4f6c2372018-04-26 10:37:55 -0700976 getMapStatus(mIfaceStatsMap.getMap(), IFACE_STATS_MAP_PATH).c_str());
Chenbo Feng703798e2018-06-15 17:07:59 -0700977 dw.println("mConfigurationMap status: %s",
978 getMapStatus(mConfigurationMap.getMap(), CONFIGURATION_MAP_PATH).c_str());
979 dw.println("mUidOwnerMap status: %s",
980 getMapStatus(mUidOwnerMap.getMap(), UID_OWNER_MAP_PATH).c_str());
Chenbo Fengef297172018-03-26 10:53:33 -0700981
982 dw.blankline();
983 dw.println("Cgroup ingress program status: %s",
984 getProgramStatus(BPF_INGRESS_PROG_PATH).c_str());
985 dw.println("Cgroup egress program status: %s", getProgramStatus(BPF_EGRESS_PROG_PATH).c_str());
986 dw.println("xt_bpf ingress program status: %s",
987 getProgramStatus(XT_BPF_INGRESS_PROG_PATH).c_str());
988 dw.println("xt_bpf egress program status: %s",
989 getProgramStatus(XT_BPF_EGRESS_PROG_PATH).c_str());
Chenbo Feng95892f32018-06-07 14:52:02 -0700990 dw.println("xt_bpf bandwidth whitelist program status: %s",
991 getProgramStatus(XT_BPF_WHITELIST_PROG_PATH).c_str());
992 dw.println("xt_bpf bandwidth blacklist program status: %s",
993 getProgramStatus(XT_BPF_BLACKLIST_PROG_PATH).c_str());
Chenbo Fengef297172018-03-26 10:53:33 -0700994
Erik Klineb31fd692018-06-06 20:50:11 +0900995 if (!verbose) {
996 return;
997 }
Chenbo Fengef297172018-03-26 10:53:33 -0700998
999 dw.blankline();
1000 dw.println("BPF map content:");
1001
Erik Klineb31fd692018-06-06 20:50:11 +09001002 ScopedIndent indentForMapContent(dw);
Chenbo Fengef297172018-03-26 10:53:33 -07001003
1004 // Print CookieTagMap content.
1005 dumpBpfMap("mCookieTagMap", dw, "");
Maciej Żenczykowski11ec78b2019-12-30 06:39:32 -08001006 const auto printCookieTagInfo = [&dw](const uint64_t& key, const UidTagValue& value,
1007 const BpfMap<uint64_t, UidTagValue>&) {
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001008 dw.println("cookie=%" PRIu64 " tag=0x%x uid=%u", key, value.tag, value.uid);
Steven Morelanda3074542020-01-13 14:13:44 -08001009 return base::Result<void>();
Chenbo Fengef297172018-03-26 10:53:33 -07001010 };
Steven Morelanda3074542020-01-13 14:13:44 -08001011 base::Result<void> res = mCookieTagMap.iterateWithValue(printCookieTagInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001012 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001013 dw.println("mCookieTagMap print end with error: %s", res.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001014 }
1015
1016 // Print UidCounterSetMap Content
1017 dumpBpfMap("mUidCounterSetMap", dw, "");
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001018 const auto printUidInfo = [&dw](const uint32_t& key, const uint8_t& value,
1019 const BpfMap<uint32_t, uint8_t>&) {
1020 dw.println("%u %u", key, value);
Steven Morelanda3074542020-01-13 14:13:44 -08001021 return base::Result<void>();
Chenbo Fengef297172018-03-26 10:53:33 -07001022 };
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001023 res = mUidCounterSetMap.iterateWithValue(printUidInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001024 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001025 dw.println("mUidCounterSetMap print end with error: %s", res.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001026 }
1027
Chenbo Fengbc4a15f2018-05-11 19:15:15 -07001028 // Print AppUidStatsMap content
1029 std::string appUidStatsHeader = StringPrintf("uid rxBytes rxPackets txBytes txPackets");
1030 dumpBpfMap("mAppUidStatsMap:", dw, appUidStatsHeader);
1031 auto printAppUidStatsInfo = [&dw](const uint32_t& key, const StatsValue& value,
1032 const BpfMap<uint32_t, StatsValue>&) {
1033 dw.println("%u %" PRIu64 " %" PRIu64 " %" PRIu64 " %" PRIu64, key, value.rxBytes,
1034 value.rxPackets, value.txBytes, value.txPackets);
Steven Morelanda3074542020-01-13 14:13:44 -08001035 return base::Result<void>();
Chenbo Fengbc4a15f2018-05-11 19:15:15 -07001036 };
1037 res = mAppUidStatsMap.iterateWithValue(printAppUidStatsInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001038 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001039 dw.println("mAppUidStatsMap print end with error: %s", res.error().message().c_str());
Chenbo Fengbc4a15f2018-05-11 19:15:15 -07001040 }
1041
Chenbo Fengef297172018-03-26 10:53:33 -07001042 // Print uidStatsMap content
1043 std::string statsHeader = StringPrintf("ifaceIndex ifaceName tag_hex uid_int cnt_set rxBytes"
1044 " rxPackets txBytes txPackets");
Chenbo Fengf434e862018-06-27 14:08:39 -07001045 dumpBpfMap("mStatsMapA", dw, statsHeader);
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001046 const auto printStatsInfo = [&dw, this](const StatsKey& key, const StatsValue& value,
1047 const BpfMap<StatsKey, StatsValue>&) {
1048 uint32_t ifIndex = key.ifaceIndex;
1049 auto ifname = mIfaceIndexNameMap.readValue(ifIndex);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001050 if (!ifname.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001051 ifname = IfaceValue{"unknown"};
Chenbo Fengef297172018-03-26 10:53:33 -07001052 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001053 dw.println("%u %s 0x%x %u %u %" PRIu64 " %" PRIu64 " %" PRIu64 " %" PRIu64, ifIndex,
1054 ifname.value().name, key.tag, key.uid, key.counterSet, value.rxBytes,
1055 value.rxPackets, value.txBytes, value.txPackets);
Steven Morelanda3074542020-01-13 14:13:44 -08001056 return base::Result<void>();
Chenbo Fengef297172018-03-26 10:53:33 -07001057 };
Chenbo Fengf434e862018-06-27 14:08:39 -07001058 res = mStatsMapA.iterateWithValue(printStatsInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001059 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001060 dw.println("mStatsMapA print end with error: %s", res.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001061 }
1062
1063 // Print TagStatsMap content.
Chenbo Fengf434e862018-06-27 14:08:39 -07001064 dumpBpfMap("mStatsMapB", dw, statsHeader);
1065 res = mStatsMapB.iterateWithValue(printStatsInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001066 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001067 dw.println("mStatsMapB print end with error: %s", res.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001068 }
1069
1070 // Print ifaceIndexToNameMap content.
1071 dumpBpfMap("mIfaceIndexNameMap", dw, "");
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001072 const auto printIfaceNameInfo = [&dw](const uint32_t& key, const IfaceValue& value,
1073 const BpfMap<uint32_t, IfaceValue>&) {
1074 const char* ifname = value.name;
1075 dw.println("ifaceIndex=%u ifaceName=%s", key, ifname);
Steven Morelanda3074542020-01-13 14:13:44 -08001076 return base::Result<void>();
Chenbo Fengef297172018-03-26 10:53:33 -07001077 };
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001078 res = mIfaceIndexNameMap.iterateWithValue(printIfaceNameInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001079 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001080 dw.println("mIfaceIndexNameMap print end with error: %s", res.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001081 }
1082
1083 // Print ifaceStatsMap content
1084 std::string ifaceStatsHeader = StringPrintf("ifaceIndex ifaceName rxBytes rxPackets txBytes"
1085 " txPackets");
1086 dumpBpfMap("mIfaceStatsMap:", dw, ifaceStatsHeader);
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001087 const auto printIfaceStatsInfo = [&dw, this](const uint32_t& key, const StatsValue& value,
1088 const BpfMap<uint32_t, StatsValue>&) {
1089 auto ifname = mIfaceIndexNameMap.readValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001090 if (!ifname.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001091 ifname = IfaceValue{"unknown"};
Chenbo Fengef297172018-03-26 10:53:33 -07001092 }
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001093 dw.println("%u %s %" PRIu64 " %" PRIu64 " %" PRIu64 " %" PRIu64, key, ifname.value().name,
1094 value.rxBytes, value.rxPackets, value.txBytes, value.txPackets);
Steven Morelanda3074542020-01-13 14:13:44 -08001095 return base::Result<void>();
Chenbo Fengef297172018-03-26 10:53:33 -07001096 };
Chenbo Feng4f6c2372018-04-26 10:37:55 -07001097 res = mIfaceStatsMap.iterateWithValue(printIfaceStatsInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001098 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001099 dw.println("mIfaceStatsMap print end with error: %s", res.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001100 }
1101
Chenbo Feng703798e2018-06-15 17:07:59 -07001102 dw.blankline();
Chenbo Fengef297172018-03-26 10:53:33 -07001103
Chenbo Fengf434e862018-06-27 14:08:39 -07001104 uint32_t key = UID_RULES_CONFIGURATION_KEY;
Chenbo Feng703798e2018-06-15 17:07:59 -07001105 auto configuration = mConfigurationMap.readValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001106 if (configuration.ok()) {
Lorenzo Colittic2677362019-06-26 20:01:35 +09001107 dw.println("current ownerMatch configuration: %d%s", configuration.value(),
1108 uidMatchTypeToString(configuration.value()).c_str());
Chenbo Feng703798e2018-06-15 17:07:59 -07001109 } else {
Chenbo Fengf434e862018-06-27 14:08:39 -07001110 dw.println("mConfigurationMap read ownerMatch configure failed with error: %s",
Steven Morelanda3074542020-01-13 14:13:44 -08001111 configuration.error().message().c_str());
Chenbo Fengf434e862018-06-27 14:08:39 -07001112 }
Lorenzo Colittic2677362019-06-26 20:01:35 +09001113
Chenbo Fengf434e862018-06-27 14:08:39 -07001114 key = CURRENT_STATS_MAP_CONFIGURATION_KEY;
1115 configuration = mConfigurationMap.readValue(key);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001116 if (configuration.ok()) {
Lorenzo Colittic2677362019-06-26 20:01:35 +09001117 const char* statsMapDescription = "???";
1118 switch (configuration.value()) {
1119 case SELECT_MAP_A:
1120 statsMapDescription = "SELECT_MAP_A";
1121 break;
1122 case SELECT_MAP_B:
1123 statsMapDescription = "SELECT_MAP_B";
1124 break;
1125 // No default clause, so if we ever add a third map, this code will fail to build.
1126 }
1127 dw.println("current statsMap configuration: %d %s", configuration.value(),
1128 statsMapDescription);
Chenbo Fengf434e862018-06-27 14:08:39 -07001129 } else {
1130 dw.println("mConfigurationMap read stats map configure failed with error: %s",
Steven Morelanda3074542020-01-13 14:13:44 -08001131 configuration.error().message().c_str());
Chenbo Fengef297172018-03-26 10:53:33 -07001132 }
Chenbo Feng703798e2018-06-15 17:07:59 -07001133 dumpBpfMap("mUidOwnerMap", dw, "");
Rubin Xuec27ff22019-01-08 21:33:03 +00001134 const auto printUidMatchInfo = [&dw, this](const uint32_t& key, const UidOwnerValue& value,
1135 const BpfMap<uint32_t, UidOwnerValue>&) {
1136 if (value.rule & IIF_MATCH) {
1137 auto ifname = mIfaceIndexNameMap.readValue(value.iif);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001138 if (ifname.ok()) {
Rubin Xuec27ff22019-01-08 21:33:03 +00001139 dw.println("%u %s %s", key, uidMatchTypeToString(value.rule).c_str(),
1140 ifname.value().name);
1141 } else {
1142 dw.println("%u %s %u", key, uidMatchTypeToString(value.rule).c_str(), value.iif);
1143 }
1144 } else {
1145 dw.println("%u %s", key, uidMatchTypeToString(value.rule).c_str());
1146 }
Steven Morelanda3074542020-01-13 14:13:44 -08001147 return base::Result<void>();
Chenbo Feng703798e2018-06-15 17:07:59 -07001148 };
1149 res = mUidOwnerMap.iterateWithValue(printUidMatchInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001150 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001151 dw.println("mUidOwnerMap print end with error: %s", res.error().message().c_str());
Chenbo Feng95892f32018-06-07 14:52:02 -07001152 }
Chenbo Feng48eaed32018-12-26 17:40:21 -08001153 dumpBpfMap("mUidPermissionMap", dw, "");
Yi Kong3d82f382019-10-01 21:52:14 -07001154 const auto printUidPermissionInfo = [&dw](const uint32_t& key, const int& value,
Chenbo Feng48eaed32018-12-26 17:40:21 -08001155 const BpfMap<uint32_t, uint8_t>&) {
1156 dw.println("%u %s", key, UidPermissionTypeToString(value).c_str());
Steven Morelanda3074542020-01-13 14:13:44 -08001157 return base::Result<void>();
Chenbo Feng48eaed32018-12-26 17:40:21 -08001158 };
1159 res = mUidPermissionMap.iterateWithValue(printUidPermissionInfo);
Bernie Innocenti615fd742020-02-06 03:55:09 +09001160 if (!res.ok()) {
Steven Morelanda3074542020-01-13 14:13:44 -08001161 dw.println("mUidPermissionMap print end with error: %s", res.error().message().c_str());
Chenbo Feng48eaed32018-12-26 17:40:21 -08001162 }
1163
1164 dumpBpfMap("mPrivilegedUser", dw, "");
1165 for (uid_t uid : mPrivilegedUser) {
1166 dw.println("%u ALLOW_UPDATE_DEVICE_STATS", (uint32_t)uid);
1167 }
Chenbo Fengef297172018-03-26 10:53:33 -07001168}
1169
Chenbo Fengf2759682017-10-10 17:31:57 -07001170} // namespace net
1171} // namespace android