server/BandwidthController.h

   1 /*
   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
  19 #include <list>
  20 #include <string>
  21 #include <utility>  // for pair
  22
  23 #include <sysutils/SocketClient.h>
  24
  25 class BandwidthController {
  26 public:
  27     class TetherStats {
  28     public:
  29         TetherStats(void)
  30                 : rxBytes(-1), rxPackets(-1),
  31                     txBytes(-1), txPackets(-1) {};
  32         TetherStats(std::string intIfn, std::string extIfn,
  33                 int64_t rxB, int64_t rxP,
  34                 int64_t txB, int64_t txP)
  35                         : intIface(intIfn), extIface(extIfn),
  36                             rxBytes(rxB), rxPackets(rxP),
  37                             txBytes(txB), txPackets(txP) {};
  38         /* Internal interface. Same as NatController's notion. */
  39         std::string intIface;
  40         /* External interface. Same as NatController's notion. */
  41         std::string extIface;
  42         int64_t rxBytes, rxPackets;
  43         int64_t txBytes, txPackets;
  44         /*
  45          * Allocates a new string representing this:
  46          * intIface extIface rx_bytes rx_packets tx_bytes tx_packets
  47          * The caller is responsible for free()'ing the returned ptr.
  48          */
  49         char *getStatsLine(void) const;
  50     };
  51
  52     BandwidthController();
  53
  54     int setupIptablesHooks(void);
  55
  56     int enableBandwidthControl(bool force);
  57     int disableBandwidthControl(void);
  58
  59     int setInterfaceSharedQuota(const char *iface, int64_t bytes);
  60     int getInterfaceSharedQuota(int64_t *bytes);
  61     int removeInterfaceSharedQuota(const char *iface);
  62
  63     int setInterfaceQuota(const char *iface, int64_t bytes);
  64     int getInterfaceQuota(const char *iface, int64_t *bytes);
  65     int removeInterfaceQuota(const char *iface);
  66
  67     int addNaughtyApps(int numUids, char *appUids[]);
  68     int removeNaughtyApps(int numUids, char *appUids[]);
  69     int addNiceApps(int numUids, char *appUids[]);
  70     int removeNiceApps(int numUids, char *appUids[]);
  71
  72     int setGlobalAlert(int64_t bytes);
  73     int removeGlobalAlert(void);
  74     int setGlobalAlertInForwardChain(void);
  75     int removeGlobalAlertInForwardChain(void);
  76
  77     int setSharedAlert(int64_t bytes);
  78     int removeSharedAlert(void);
  79
  80     int setInterfaceAlert(const char *iface, int64_t bytes);
  81     int removeInterfaceAlert(const char *iface);
  82
  83     /*
  84      * For single pair of ifaces, stats should have ifaceIn and ifaceOut initialized.
  85      * For all pairs, stats should have ifaceIn=ifaceOut="".
  86      * Sends out to the cli the single stat (TetheringStatsReluts) or a list of stats
  87      * (TetheringStatsListResult+CommandOkay).
  88      * Error is to be handled on the outside.
  89      * It results in an error if invoked and no tethering counter rules exist.
  90      */
  91     int getTetherStats(SocketClient *cli, TetherStats &stats, std::string &extraProcessingInfo);
  92
  93     static const char* LOCAL_INPUT;
  94     static const char* LOCAL_FORWARD;
  95     static const char* LOCAL_OUTPUT;
  96     static const char* LOCAL_RAW_PREROUTING;
  97     static const char* LOCAL_MANGLE_POSTROUTING;
  98
  99 protected:
 100     class QuotaInfo {
 101     public:
 102       QuotaInfo(std::string ifn, int64_t q, int64_t a)
 103               : ifaceName(ifn), quota(q), alert(a) {};
 104         std::string ifaceName;
 105         int64_t quota;
 106         int64_t alert;
 107     };
 108
 109     enum IptIpVer { IptIpV4, IptIpV6 };
 110     enum IptOp { IptOpInsert, IptOpReplace, IptOpDelete, IptOpAppend };
 111     enum IptJumpOp { IptJumpReject, IptJumpReturn, IptJumpNoAdd };
 112     enum SpecialAppOp { SpecialAppOpAdd, SpecialAppOpRemove };
 113     enum QuotaType { QuotaUnique, QuotaShared };
 114     enum RunCmdErrHandling { RunCmdFailureBad, RunCmdFailureOk };
 115 #if LOG_NDEBUG
 116     enum IptFailureLog { IptFailShow, IptFailHide };
 117 #else
 118     enum IptFailureLog { IptFailShow, IptFailHide = IptFailShow };
 119 #endif
 120
 121     int manipulateSpecialApps(int numUids, char *appStrUids[],
 122                                const char *chain,
 123                                IptJumpOp jumpHandling, SpecialAppOp appOp);
 124     int manipulateNaughtyApps(int numUids, char *appStrUids[], SpecialAppOp appOp);
 125     int manipulateNiceApps(int numUids, char *appStrUids[], SpecialAppOp appOp);
 126
 127     int prepCostlyIface(const char *ifn, QuotaType quotaType);
 128     int cleanupCostlyIface(const char *ifn, QuotaType quotaType);
 129
 130     std::string makeIptablesSpecialAppCmd(IptOp op, int uid, const char *chain);
 131     std::string makeIptablesQuotaCmd(IptOp op, const char *costName, int64_t quota);
 132
 133     int runIptablesAlertCmd(IptOp op, const char *alertName, int64_t bytes);
 134     int runIptablesAlertFwdCmd(IptOp op, const char *alertName, int64_t bytes);
 135
 136     /* Runs for both ipv4 and ipv6 iptables */
 137     int runCommands(int numCommands, const char *commands[], RunCmdErrHandling cmdErrHandling);
 138     /* Runs for both ipv4 and ipv6 iptables, appends -j REJECT --reject-with ...  */
 139     static int runIpxtablesCmd(const char *cmd, IptJumpOp jumpHandling,
 140                                IptFailureLog failureHandling = IptFailShow);
 141     static int runIptablesCmd(const char *cmd, IptJumpOp jumpHandling, IptIpVer iptIpVer,
 142                               IptFailureLog failureHandling = IptFailShow);
 143
 144
 145     // Provides strncpy() + check overflow.
 146     static int StrncpyAndCheck(char *buffer, const char *src, size_t buffSize);
 147
 148     int updateQuota(const char *alertName, int64_t bytes);
 149
 150     int setCostlyAlert(const char *costName, int64_t bytes, int64_t *alertBytes);
 151     int removeCostlyAlert(const char *costName, int64_t *alertBytes);
 152
 153     /*
 154      * stats should never have only intIface initialized. Other 3 combos are ok.
 155      * fp should be a file to the apropriate FORWARD chain of iptables rules.
 156      * extraProcessingInfo: contains raw parsed data, and error info.
 157      * This strongly requires that setup of the rules is in a specific order:
 158      *  in:intIface out:extIface
 159      *  in:extIface out:intIface
 160      * and the rules are grouped in pairs when more that one tethering was setup.
 161      */
 162     static int parseForwardChainStats(SocketClient *cli, const TetherStats filter, FILE *fp,
 163                                       std::string &extraProcessingInfo);
 164
 165     /*
 166      * Attempt to find the bw_costly_* tables that need flushing,
 167      * and flush them.
 168      * If doClean then remove the tables also.
 169      * Deals with both ip4 and ip6 tables.
 170      */
 171     void flushExistingCostlyTables(bool doClean);
 172     static void parseAndFlushCostlyTables(FILE *fp, bool doRemove);
 173
 174     /*
 175      * Attempt to flush our tables.
 176      * If doClean then remove them also.
 177      * Deals with both ip4 and ip6 tables.
 178      */
 179     void flushCleanTables(bool doClean);
 180
 181     /*------------------*/
 182
 183     std::list<std::string> sharedQuotaIfaces;
 184     int64_t sharedQuotaBytes;
 185     int64_t sharedAlertBytes;
 186     int64_t globalAlertBytes;
 187     /*
 188      * This tracks the number of tethers setup.
 189      * The FORWARD chain is updated in the following cases:
 190      *  - The 1st time a globalAlert is setup and there are tethers setup.
 191      *  - Anytime a globalAlert is removed and there are tethers setup.
 192      *  - The 1st tether is setup and there is a globalAlert active.
 193      *  - The last tether is removed and there is a globalAlert active.
 194      */
 195     int globalAlertTetherCount;
 196
 197     std::list<QuotaInfo> quotaIfaces;
 198
 199 private:
 200     static const char *IPT_FLUSH_COMMANDS[];
 201     static const char *IPT_CLEANUP_COMMANDS[];
 202     static const char *IPT_SETUP_COMMANDS[];
 203     static const char *IPT_BASIC_ACCOUNTING_COMMANDS[];
 204
 205     /* Alphabetical */
 206     static const char ALERT_GLOBAL_NAME[];
 207     static const int  MAX_CMD_ARGS;
 208     static const int  MAX_CMD_LEN;
 209     static const int  MAX_IFACENAME_LEN;
 210     static const int  MAX_IPT_OUTPUT_LINE_LEN;
 211 };
 212
 213 #endif