client/FwmarkClient.h

   1 /*
   2  * Copyright (C) 2014 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
  17 #ifndef NETD_CLIENT_FWMARK_CLIENT_H
  18 #define NETD_CLIENT_FWMARK_CLIENT_H
  19
  20 #include <sys/socket.h>
  21
  22 struct FwmarkCommand;
  23
  24 class FwmarkClient {
  25 public:
  26     // Returns true if a socket of the given |family| should be sent to the fwmark server to have
  27     // its SO_MARK set.
  28     static bool shouldSetFwmark(int family);
  29
  30     // Returns true if an additional call should be made after ON_CONNECT calls, to log extra
  31     // information like latency and source IP.
  32     static bool shouldReportConnectComplete(int family);
  33
  34     FwmarkClient();
  35     ~FwmarkClient();
  36
  37     // Sends |data| to the fwmark server, along with |fd| as ancillary data using cmsg(3).
  38     // Returns 0 on success or a negative errno value on failure.
  39     int send(FwmarkCommand* data, int fd);
  40
  41     // Env flag to control whether FwmarkClient sends any information at all about network events
  42     // back to the system server through FwmarkServer.
  43     static constexpr const char* ANDROID_NO_USE_FWMARK_CLIENT = "ANDROID_NO_USE_FWMARK_CLIENT";
  44
  45     // Env flag to control whether FwmarkClient should exclude detailed information like IP
  46     // addresses and only send basic information necessary for marking sockets.
  47     // Has no effect if ANDROID_NO_USE_FWMARK_CLIENT is set.
  48     static constexpr const char* ANDROID_FWMARK_METRICS_ONLY = "ANDROID_FWMARK_METRICS_ONLY";
  49
  50 private:
  51     int mChannel;
  52 };
  53
  54 #endif  // NETD_CLIENT_FWMARK_CLIENT_H