blob: b8691dccebea26e0032b95008beaf486ddd5c65a [file] [log] [blame]
JP Abgrall4a5f5ca2011-06-15 18:37:39 -07001/*
2 * Copyright (C) 2011 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#ifndef _BANDWIDTH_CONTROLLER_H
17#define _BANDWIDTH_CONTROLLER_H
18
Joel Scherpelzced1dd92017-06-28 10:19:52 +090019#include <map>
20#include <set>
JP Abgrall4a5f5ca2011-06-15 18:37:39 -070021#include <string>
Joel Scherpelzbcad6612017-05-30 10:55:11 +090022#include <utility>
23#include <vector>
Luke Huangd1ee4622018-06-29 13:49:58 +080024#include <mutex>
JP Abgrallbaeccc42013-06-25 09:44:10 -070025
Lorenzo Colitti13debb82016-03-27 17:46:30 +090026#include "NetdConstants.h"
27
JP Abgrall4a5f5ca2011-06-15 18:37:39 -070028class BandwidthController {
29public:
Luke Huangd1ee4622018-06-29 13:49:58 +080030 std::mutex lock;
Lorenzo Colittidedd2712016-03-22 12:36:29 +090031
JP Abgrallfa6f46d2011-06-17 23:17:28 -070032 BandwidthController();
JP Abgrall0031cea2012-04-17 16:38:23 -070033
Joel Scherpelzbcad6612017-05-30 10:55:11 +090034 int setupIptablesHooks();
Chenbo Feng44c0f442018-07-10 16:54:30 -070035 void setBpfEnabled(bool isEnabled);
JP Abgrall0031cea2012-04-17 16:38:23 -070036
Luke Huangf44a3c12018-09-07 12:10:12 +080037 int enableBandwidthControl();
Joel Scherpelzbcad6612017-05-30 10:55:11 +090038 int disableBandwidthControl();
Lorenzo Colitti7618ccb2016-03-18 12:36:03 +090039 int enableDataSaver(bool enable);
JP Abgrallfa6f46d2011-06-17 23:17:28 -070040
Joel Scherpelzbcad6612017-05-30 10:55:11 +090041 int setInterfaceSharedQuota(const std::string& iface, int64_t bytes);
JP Abgrall8a932722011-07-13 19:17:35 -070042 int getInterfaceSharedQuota(int64_t *bytes);
Joel Scherpelzbcad6612017-05-30 10:55:11 +090043 int removeInterfaceSharedQuota(const std::string& iface);
JP Abgrallfa6f46d2011-06-17 23:17:28 -070044
Joel Scherpelzbcad6612017-05-30 10:55:11 +090045 int setInterfaceQuota(const std::string& iface, int64_t bytes);
46 int getInterfaceQuota(const std::string& iface, int64_t* bytes);
47 int removeInterfaceQuota(const std::string& iface);
JP Abgrall0dad7c22011-06-24 11:58:14 -070048
Luke Huang531f5d32018-08-03 15:19:05 +080049 // TODO: Remove after removing these commands in CommandListener
Bernie Innocenti15bb55c2018-06-03 16:19:51 +090050 int addNaughtyApps(int numUids, const char* const appUids[]);
51 int removeNaughtyApps(int numUids, const char* const appUids[]);
52 int addNiceApps(int numUids, const char* const appUids[]);
53 int removeNiceApps(int numUids, const char* const appUids[]);
JP Abgrall4a5f5ca2011-06-15 18:37:39 -070054
Luke Huang531f5d32018-08-03 15:19:05 +080055 int addNaughtyApps(const std::vector<std::string>& appStrUid);
56 int removeNaughtyApps(const std::vector<std::string>& appStrUid);
57 int addNiceApps(const std::vector<std::string>& appStrUid);
58 int removeNiceApps(const std::vector<std::string>& appStrUid);
59
JP Abgrall8a932722011-07-13 19:17:35 -070060 int setGlobalAlert(int64_t bytes);
Joel Scherpelzbcad6612017-05-30 10:55:11 +090061 int removeGlobalAlert();
62 int setGlobalAlertInForwardChain();
63 int removeGlobalAlertInForwardChain();
JP Abgrall8a932722011-07-13 19:17:35 -070064
65 int setSharedAlert(int64_t bytes);
Joel Scherpelzbcad6612017-05-30 10:55:11 +090066 int removeSharedAlert();
JP Abgrall8a932722011-07-13 19:17:35 -070067
Joel Scherpelzbcad6612017-05-30 10:55:11 +090068 int setInterfaceAlert(const std::string& iface, int64_t bytes);
69 int removeInterfaceAlert(const std::string& iface);
JP Abgrall0dad7c22011-06-24 11:58:14 -070070
Joel Scherpelzbcad6612017-05-30 10:55:11 +090071 static const char LOCAL_INPUT[];
72 static const char LOCAL_FORWARD[];
73 static const char LOCAL_OUTPUT[];
74 static const char LOCAL_RAW_PREROUTING[];
75 static const char LOCAL_MANGLE_POSTROUTING[];
Luke Huangae038f82018-11-05 11:17:31 +090076 static const char LOCAL_GLOBAL_ALERT[];
Jeff Sharkey8e188ed2012-07-12 18:32:03 -070077
Chenbo Feng95892f32018-06-07 14:52:02 -070078 enum IptJumpOp { IptJumpReject, IptJumpReturn, IptJumpNoAdd };
79 enum IptOp { IptOpInsert, IptOpDelete };
80
Joel Scherpelzbcad6612017-05-30 10:55:11 +090081 private:
Joel Scherpelzced1dd92017-06-28 10:19:52 +090082 struct QuotaInfo {
JP Abgrall8a932722011-07-13 19:17:35 -070083 int64_t quota;
84 int64_t alert;
85 };
JP Abgralldb7da582011-09-18 12:57:32 -070086
JP Abgrall26e0d492011-06-24 19:21:51 -070087 enum IptIpVer { IptIpV4, IptIpV6 };
Lorenzo Colittid9db08c2017-04-28 11:06:40 +090088 enum IptFullOp { IptFullOpInsert, IptFullOpDelete, IptFullOpAppend };
JP Abgrall26e0d492011-06-24 19:21:51 -070089 enum QuotaType { QuotaUnique, QuotaShared };
90 enum RunCmdErrHandling { RunCmdFailureBad, RunCmdFailureOk };
JP Abgrall1fb02df2012-04-24 23:27:44 -070091#if LOG_NDEBUG
92 enum IptFailureLog { IptFailShow, IptFailHide };
93#else
94 enum IptFailureLog { IptFailShow, IptFailHide = IptFailShow };
95#endif
JP Abgralla9ba4cb2013-07-02 19:08:48 -070096
Lorenzo Colittiaff28792017-09-26 17:46:18 +090097 std::string makeDataSaverCommand(IptablesTarget target, bool enable);
98
Joel Scherpelzbcad6612017-05-30 10:55:11 +090099 int manipulateSpecialApps(const std::vector<std::string>& appStrUids, const std::string& chain,
100 IptJumpOp jumpHandling, IptOp appOp);
JP Abgrall4a5f5ca2011-06-15 18:37:39 -0700101
Joel Scherpelzbcad6612017-05-30 10:55:11 +0900102 int runIptablesAlertCmd(IptOp op, const std::string& alertName, int64_t bytes);
103 int runIptablesAlertFwdCmd(IptOp op, const std::string& alertName, int64_t bytes);
JP Abgrall8a932722011-07-13 19:17:35 -0700104
Joel Scherpelzbcad6612017-05-30 10:55:11 +0900105 int updateQuota(const std::string& alertName, int64_t bytes);
JP Abgrall8a932722011-07-13 19:17:35 -0700106
Joel Scherpelzbcad6612017-05-30 10:55:11 +0900107 int setCostlyAlert(const std::string& costName, int64_t bytes, int64_t* alertBytes);
108 int removeCostlyAlert(const std::string& costName, int64_t* alertBytes);
JP Abgrall8a932722011-07-13 19:17:35 -0700109
JP Abgrall0e540ec2013-08-26 15:13:10 -0700110 /*
111 * Attempt to find the bw_costly_* tables that need flushing,
112 * and flush them.
113 * If doClean then remove the tables also.
114 * Deals with both ip4 and ip6 tables.
115 */
116 void flushExistingCostlyTables(bool doClean);
Lorenzo Colitti56c4b1e2017-02-01 02:45:10 +0900117 static void parseAndFlushCostlyTables(const std::string& ruleList, bool doRemove);
JP Abgrall0e540ec2013-08-26 15:13:10 -0700118
119 /*
120 * Attempt to flush our tables.
121 * If doClean then remove them also.
122 * Deals with both ip4 and ip6 tables.
123 */
124 void flushCleanTables(bool doClean);
125
Joel Scherpelzced1dd92017-06-28 10:19:52 +0900126 // For testing.
127 friend class BandwidthControllerTest;
128 static int (*execFunction)(int, char **, int *, bool, bool);
129 static FILE *(*popenFunction)(const char *, const char *);
130 static int (*iptablesRestoreFunction)(IptablesTarget, const std::string&, std::string *);
JP Abgralldb7da582011-09-18 12:57:32 -0700131
Joel Scherpelzced1dd92017-06-28 10:19:52 +0900132 static const char *opToString(IptOp op);
133 static const char *jumpToString(IptJumpOp jumpHandling);
134
Ken Chen7905cae2018-10-23 23:14:25 +0800135 bool mBpfSupported = false;
Chenbo Feng95892f32018-06-07 14:52:02 -0700136
Joel Scherpelzced1dd92017-06-28 10:19:52 +0900137 int64_t mSharedQuotaBytes = 0;
138 int64_t mSharedAlertBytes = 0;
139 int64_t mGlobalAlertBytes = 0;
JP Abgrallc6c67342011-10-07 16:28:54 -0700140
Joel Scherpelzced1dd92017-06-28 10:19:52 +0900141 std::map<std::string, QuotaInfo> mQuotaIfaces;
142 std::set<std::string> mSharedQuotaIfaces;
JP Abgrall4a5f5ca2011-06-15 18:37:39 -0700143};
144
145#endif