Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 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 | package com.android.server.connectivity; |
| 18 | |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 19 | import static android.net.NetworkCapabilities.NET_CAPABILITY_VALIDATED; |
| 20 | |
Paul Jensen | ca8f16a | 2014-05-09 12:47:55 -0400 | [diff] [blame] | 21 | import android.content.Context; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 22 | import android.net.LinkProperties; |
| 23 | import android.net.Network; |
| 24 | import android.net.NetworkCapabilities; |
| 25 | import android.net.NetworkInfo; |
Sreeram Ramachandran | 8cd33ed | 2014-07-23 15:23:15 -0700 | [diff] [blame] | 26 | import android.net.NetworkMisc; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 27 | import android.net.NetworkRequest; |
Jeff Sharkey | f07c7b9 | 2016-04-22 09:50:16 -0600 | [diff] [blame] | 28 | import android.net.NetworkState; |
Paul Jensen | ca8f16a | 2014-05-09 12:47:55 -0400 | [diff] [blame] | 29 | import android.os.Handler; |
Hugo Benichi | ef50288 | 2017-09-01 01:23:32 +0000 | [diff] [blame] | 30 | import android.os.INetworkManagementService; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 31 | import android.os.Messenger; |
Hugo Benichi | ef50288 | 2017-09-01 01:23:32 +0000 | [diff] [blame] | 32 | import android.os.RemoteException; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 33 | import android.os.SystemClock; |
| 34 | import android.util.Log; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 35 | import android.util.SparseArray; |
| 36 | |
| 37 | import com.android.internal.util.AsyncChannel; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 38 | import com.android.internal.util.WakeupMessage; |
Paul Jensen | cf4c2c6 | 2015-07-01 14:16:32 -0400 | [diff] [blame] | 39 | import com.android.server.ConnectivityService; |
Paul Jensen | ca8f16a | 2014-05-09 12:47:55 -0400 | [diff] [blame] | 40 | import com.android.server.connectivity.NetworkMonitor; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 41 | |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 42 | import java.io.PrintWriter; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 43 | import java.util.ArrayList; |
Paul Jensen | 85cf78e | 2015-06-25 13:25:07 -0400 | [diff] [blame] | 44 | import java.util.Comparator; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 45 | import java.util.Objects; |
| 46 | import java.util.SortedSet; |
| 47 | import java.util.TreeSet; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * A bag class used by ConnectivityService for holding a collection of most recent |
| 51 | * information published by a particular NetworkAgent as well as the |
| 52 | * AsyncChannel/messenger for reaching that NetworkAgent and lists of NetworkRequests |
Paul Jensen | 85cf78e | 2015-06-25 13:25:07 -0400 | [diff] [blame] | 53 | * interested in using it. Default sort order is descending by score. |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 54 | */ |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 55 | // States of a network: |
| 56 | // -------------------- |
| 57 | // 1. registered, uncreated, disconnected, unvalidated |
| 58 | // This state is entered when a NetworkFactory registers a NetworkAgent in any state except |
| 59 | // the CONNECTED state. |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 60 | // 2. registered, uncreated, connecting, unvalidated |
| 61 | // This state is entered when a registered NetworkAgent for a VPN network transitions to the |
| 62 | // CONNECTING state (TODO: go through this state for every network, not just VPNs). |
| 63 | // ConnectivityService will tell netd to create the network early in order to add extra UID |
| 64 | // routing rules referencing the netID. These rules need to be in place before the network is |
| 65 | // connected to avoid racing against client apps trying to connect to a half-setup network. |
| 66 | // 3. registered, uncreated, connected, unvalidated |
| 67 | // This state is entered when a registered NetworkAgent transitions to the CONNECTED state. |
| 68 | // ConnectivityService will tell netd to create the network if it was not already created, and |
| 69 | // immediately transition to state #4. |
| 70 | // 4. registered, created, connected, unvalidated |
Paul Jensen | cf4c2c6 | 2015-07-01 14:16:32 -0400 | [diff] [blame] | 71 | // If this network can satisfy the default NetworkRequest, then NetworkMonitor will |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 72 | // probe for Internet connectivity. |
| 73 | // If this network cannot satisfy the default NetworkRequest, it will immediately be |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 74 | // transitioned to state #5. |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 75 | // A network may remain in this state if NetworkMonitor fails to find Internet connectivity, |
| 76 | // for example: |
| 77 | // a. a captive portal is present, or |
| 78 | // b. a WiFi router whose Internet backhaul is down, or |
| 79 | // c. a wireless connection stops transfering packets temporarily (e.g. device is in elevator |
| 80 | // or tunnel) but does not disconnect from the AP/cell tower, or |
| 81 | // d. a stand-alone device offering a WiFi AP without an uplink for configuration purposes. |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 82 | // 5. registered, created, connected, validated |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 83 | // |
| 84 | // The device's default network connection: |
| 85 | // ---------------------------------------- |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 86 | // Networks in states #4 and #5 may be used as a device's default network connection if they |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 87 | // satisfy the default NetworkRequest. |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 88 | // A network, that satisfies the default NetworkRequest, in state #5 should always be chosen |
| 89 | // in favor of a network, that satisfies the default NetworkRequest, in state #4. |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 90 | // When deciding between two networks, that both satisfy the default NetworkRequest, to select |
| 91 | // for the default network connection, the one with the higher score should be chosen. |
| 92 | // |
| 93 | // When a network disconnects: |
| 94 | // --------------------------- |
| 95 | // If a network's transport disappears, for example: |
| 96 | // a. WiFi turned off, or |
| 97 | // b. cellular data turned off, or |
| 98 | // c. airplane mode is turned on, or |
| 99 | // d. a wireless connection disconnects from AP/cell tower entirely (e.g. device is out of range |
| 100 | // of AP for an extended period of time, or switches to another AP without roaming) |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 101 | // then that network can transition from any state (#1-#5) to unregistered. This happens by |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 102 | // the transport disconnecting their NetworkAgent's AsyncChannel with ConnectivityManager. |
| 103 | // ConnectivityService also tells netd to destroy the network. |
| 104 | // |
| 105 | // When ConnectivityService disconnects a network: |
| 106 | // ----------------------------------------------- |
| 107 | // If a network has no chance of satisfying any requests (even if it were to become validated |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 108 | // and enter state #5), ConnectivityService will disconnect the NetworkAgent's AsyncChannel. |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 109 | // |
| 110 | // If the network was satisfying a foreground NetworkRequest (i.e. had been the highest scoring that |
| 111 | // satisfied the NetworkRequest's constraints), but is no longer the highest scoring network for any |
| 112 | // foreground NetworkRequest, then there will be a 30s pause to allow network communication to be |
| 113 | // wrapped up rather than abruptly terminated. During this pause the network is said to be |
| 114 | // "lingering". During this pause if the network begins satisfying a foreground NetworkRequest, |
| 115 | // ConnectivityService will cancel the future disconnection of the NetworkAgent's AsyncChannel, and |
| 116 | // the network is no longer considered "lingering". After the linger timer expires, if the network |
| 117 | // is satisfying one or more background NetworkRequests it is kept up in the background. If it is |
| 118 | // not, ConnectivityService disconnects the NetworkAgent's AsyncChannel. |
Paul Jensen | 85cf78e | 2015-06-25 13:25:07 -0400 | [diff] [blame] | 119 | public class NetworkAgentInfo implements Comparable<NetworkAgentInfo> { |
Hugo Benichi | c8e9e12 | 2016-09-14 23:23:08 +0000 | [diff] [blame] | 120 | |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 121 | public NetworkInfo networkInfo; |
Paul Jensen | 31a94f4 | 2015-02-13 14:18:39 -0500 | [diff] [blame] | 122 | // This Network object should always be used if possible, so as to encourage reuse of the |
| 123 | // enclosed socket factory and connection pool. Avoid creating other Network objects. |
| 124 | // This Network object is always valid. |
| 125 | public final Network network; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 126 | public LinkProperties linkProperties; |
Paul Jensen | 1c7ba02 | 2015-06-16 14:27:36 -0400 | [diff] [blame] | 127 | // This should only be modified via ConnectivityService.updateCapabilities(). |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 128 | public NetworkCapabilities networkCapabilities; |
Paul Jensen | ca8f16a | 2014-05-09 12:47:55 -0400 | [diff] [blame] | 129 | public final NetworkMonitor networkMonitor; |
Sreeram Ramachandran | 8cd33ed | 2014-07-23 15:23:15 -0700 | [diff] [blame] | 130 | public final NetworkMisc networkMisc; |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 131 | // Indicates if netd has been told to create this Network. From this point on the appropriate |
| 132 | // routing rules are setup and routes are added so packets can begin flowing over the Network. |
Lorenzo Colitti | d49159f | 2015-05-14 23:15:10 +0900 | [diff] [blame] | 133 | // This is a sticky bit; once set it is never cleared. |
Paul Jensen | eec7541 | 2014-08-04 12:21:19 -0400 | [diff] [blame] | 134 | public boolean created; |
Robin Lee | 585e248 | 2016-05-01 23:00:00 +0100 | [diff] [blame] | 135 | // Set to true after the first time this network is marked as CONNECTED. Once set, the network |
| 136 | // shows up in API calls, is able to satisfy NetworkRequests and can become the default network. |
| 137 | // This is a sticky bit; once set it is never cleared. |
| 138 | public boolean everConnected; |
Paul Jensen | 71b645f | 2014-10-13 14:13:07 -0400 | [diff] [blame] | 139 | // Set to true if this Network successfully passed validation or if it did not satisfy the |
| 140 | // default NetworkRequest in which case validation will not be attempted. |
Lorenzo Colitti | d49159f | 2015-05-14 23:15:10 +0900 | [diff] [blame] | 141 | // This is a sticky bit; once set it is never cleared even if future validation attempts fail. |
Lorenzo Colitti | d3b8a3e | 2014-12-17 11:14:42 +0900 | [diff] [blame] | 142 | public boolean everValidated; |
Paul Jensen | ca8f16a | 2014-05-09 12:47:55 -0400 | [diff] [blame] | 143 | |
Lorenzo Colitti | 7b42f39 | 2014-12-17 11:26:49 +0900 | [diff] [blame] | 144 | // The result of the last validation attempt on this network (true if validated, false if not). |
Lorenzo Colitti | 7b42f39 | 2014-12-17 11:26:49 +0900 | [diff] [blame] | 145 | public boolean lastValidated; |
| 146 | |
Lorenzo Colitti | 165c51c | 2016-09-19 01:00:19 +0900 | [diff] [blame] | 147 | // If true, becoming unvalidated will lower the network's score. This is only meaningful if the |
| 148 | // system is configured not to do this for certain networks, e.g., if the |
| 149 | // config_networkAvoidBadWifi option is set to 0 and the user has not overridden that via |
| 150 | // Settings.Global.NETWORK_AVOID_BAD_WIFI. |
| 151 | public boolean avoidUnvalidated; |
| 152 | |
Lorenzo Colitti | d49159f | 2015-05-14 23:15:10 +0900 | [diff] [blame] | 153 | // Whether a captive portal was ever detected on this network. |
| 154 | // This is a sticky bit; once set it is never cleared. |
Paul Jensen | 3d194ea | 2015-06-16 14:27:36 -0400 | [diff] [blame] | 155 | public boolean everCaptivePortalDetected; |
| 156 | |
| 157 | // Whether a captive portal was found during the last network validation attempt. |
| 158 | public boolean lastCaptivePortalDetected; |
Lorenzo Colitti | d49159f | 2015-05-14 23:15:10 +0900 | [diff] [blame] | 159 | |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 160 | // Networks are lingered when they become unneeded as a result of their NetworkRequests being |
| 161 | // satisfied by a higher-scoring network. so as to allow communication to wrap up before the |
| 162 | // network is taken down. This usually only happens to the default network. Lingering ends with |
| 163 | // either the linger timeout expiring and the network being taken down, or the network |
| 164 | // satisfying a request again. |
| 165 | public static class LingerTimer implements Comparable<LingerTimer> { |
| 166 | public final NetworkRequest request; |
| 167 | public final long expiryMs; |
| 168 | |
| 169 | public LingerTimer(NetworkRequest request, long expiryMs) { |
| 170 | this.request = request; |
| 171 | this.expiryMs = expiryMs; |
| 172 | } |
| 173 | public boolean equals(Object o) { |
| 174 | if (!(o instanceof LingerTimer)) return false; |
| 175 | LingerTimer other = (LingerTimer) o; |
| 176 | return (request.requestId == other.request.requestId) && (expiryMs == other.expiryMs); |
| 177 | } |
| 178 | public int hashCode() { |
| 179 | return Objects.hash(request.requestId, expiryMs); |
| 180 | } |
| 181 | public int compareTo(LingerTimer other) { |
| 182 | return (expiryMs != other.expiryMs) ? |
| 183 | Long.compare(expiryMs, other.expiryMs) : |
| 184 | Integer.compare(request.requestId, other.request.requestId); |
| 185 | } |
| 186 | public String toString() { |
| 187 | return String.format("%s, expires %dms", request.toString(), |
| 188 | expiryMs - SystemClock.elapsedRealtime()); |
| 189 | } |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Inform ConnectivityService that the network LINGER period has |
| 194 | * expired. |
| 195 | * obj = this NetworkAgentInfo |
| 196 | */ |
| 197 | public static final int EVENT_NETWORK_LINGER_COMPLETE = 1001; |
| 198 | |
| 199 | // All linger timers for this network, sorted by expiry time. A linger timer is added whenever |
| 200 | // a request is moved to a network with a better score, regardless of whether the network is or |
| 201 | // was lingering or not. |
| 202 | // TODO: determine if we can replace this with a smaller or unsorted data structure. (e.g., |
| 203 | // SparseLongArray) combined with the timestamp of when the last timer is scheduled to fire. |
| 204 | private final SortedSet<LingerTimer> mLingerTimers = new TreeSet<>(); |
| 205 | |
| 206 | // For fast lookups. Indexes into mLingerTimers by request ID. |
| 207 | private final SparseArray<LingerTimer> mLingerTimerForRequest = new SparseArray<>(); |
| 208 | |
| 209 | // Linger expiry timer. Armed whenever mLingerTimers is non-empty, regardless of whether the |
| 210 | // network is lingering or not. Always set to the expiry of the LingerTimer that expires last. |
| 211 | // When the timer fires, all linger state is cleared, and if the network has no requests, it is |
| 212 | // torn down. |
| 213 | private WakeupMessage mLingerMessage; |
| 214 | |
| 215 | // Linger expiry. Holds the expiry time of the linger timer, or 0 if the timer is not armed. |
| 216 | private long mLingerExpiryMs; |
| 217 | |
| 218 | // Whether the network is lingering or not. Must be maintained separately from the above because |
| 219 | // it depends on the state of other networks and requests, which only ConnectivityService knows. |
| 220 | // (Example: we don't linger a network if it would become the best for a NetworkRequest if it |
| 221 | // validated). |
| 222 | private boolean mLingering; |
Paul Jensen | 85cf78e | 2015-06-25 13:25:07 -0400 | [diff] [blame] | 223 | |
Paul Jensen | 2161a8e | 2014-09-11 11:00:39 -0400 | [diff] [blame] | 224 | // This represents the last score received from the NetworkAgent. |
| 225 | private int currentScore; |
| 226 | // Penalty applied to scores of Networks that have not been validated. |
| 227 | private static final int UNVALIDATED_SCORE_PENALTY = 40; |
| 228 | |
Robert Greenwalt | e73cc46 | 2014-09-07 16:50:01 -0700 | [diff] [blame] | 229 | // Score for explicitly connected network. |
Lorenzo Colitti | e03c3c7 | 2015-04-03 16:38:52 +0900 | [diff] [blame] | 230 | // |
| 231 | // This ensures that a) the explicitly selected network is never trumped by anything else, and |
| 232 | // b) the explicitly selected network is never torn down. |
| 233 | private static final int MAXIMUM_NETWORK_SCORE = 100; |
Robert Greenwalt | e73cc46 | 2014-09-07 16:50:01 -0700 | [diff] [blame] | 234 | |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 235 | // The list of NetworkRequests being satisfied by this Network. |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 236 | private final SparseArray<NetworkRequest> mNetworkRequests = new SparseArray<>(); |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 237 | |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 238 | // How many of the satisfied requests are actual requests and not listens. |
| 239 | private int mNumRequestNetworkRequests = 0; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 240 | |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 241 | // How many of the satisfied requests are of type BACKGROUND_REQUEST. |
| 242 | private int mNumBackgroundNetworkRequests = 0; |
| 243 | |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 244 | public final Messenger messenger; |
| 245 | public final AsyncChannel asyncChannel; |
| 246 | |
Lorenzo Colitti | 9543946 | 2014-10-09 13:44:48 +0900 | [diff] [blame] | 247 | // Used by ConnectivityService to keep track of 464xlat. |
| 248 | public Nat464Xlat clatd; |
| 249 | |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 250 | private static final String TAG = ConnectivityService.class.getSimpleName(); |
| 251 | private static final boolean VDBG = false; |
Hugo Benichi | 50d46a4 | 2017-08-31 14:29:51 +0000 | [diff] [blame] | 252 | private final ConnectivityService mConnService; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 253 | private final Context mContext; |
Hugo Benichi | 50d46a4 | 2017-08-31 14:29:51 +0000 | [diff] [blame] | 254 | private final Handler mHandler; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 255 | |
Paul Jensen | 31a94f4 | 2015-02-13 14:18:39 -0500 | [diff] [blame] | 256 | public NetworkAgentInfo(Messenger messenger, AsyncChannel ac, Network net, NetworkInfo info, |
Sreeram Ramachandran | 8cd33ed | 2014-07-23 15:23:15 -0700 | [diff] [blame] | 257 | LinkProperties lp, NetworkCapabilities nc, int score, Context context, Handler handler, |
Paul Jensen | cf4c2c6 | 2015-07-01 14:16:32 -0400 | [diff] [blame] | 258 | NetworkMisc misc, NetworkRequest defaultRequest, ConnectivityService connService) { |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 259 | this.messenger = messenger; |
| 260 | asyncChannel = ac; |
Paul Jensen | 31a94f4 | 2015-02-13 14:18:39 -0500 | [diff] [blame] | 261 | network = net; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 262 | networkInfo = info; |
| 263 | linkProperties = lp; |
| 264 | networkCapabilities = nc; |
| 265 | currentScore = score; |
Hugo Benichi | 50d46a4 | 2017-08-31 14:29:51 +0000 | [diff] [blame] | 266 | mConnService = connService; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 267 | mContext = context; |
Hugo Benichi | 50d46a4 | 2017-08-31 14:29:51 +0000 | [diff] [blame] | 268 | mHandler = handler; |
| 269 | networkMonitor = mConnService.createNetworkMonitor(context, handler, this, defaultRequest); |
Sreeram Ramachandran | 8cd33ed | 2014-07-23 15:23:15 -0700 | [diff] [blame] | 270 | networkMisc = misc; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 271 | } |
| 272 | |
Hugo Benichi | ef50288 | 2017-09-01 01:23:32 +0000 | [diff] [blame] | 273 | public ConnectivityService connService() { |
| 274 | return mConnService; |
| 275 | } |
| 276 | |
| 277 | public Handler handler() { |
| 278 | return mHandler; |
| 279 | } |
| 280 | |
Hugo Benichi | c894b12 | 2017-07-31 12:58:20 +0900 | [diff] [blame] | 281 | public Network network() { |
| 282 | return network; |
| 283 | } |
| 284 | |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 285 | // Functions for manipulating the requests satisfied by this network. |
| 286 | // |
| 287 | // These functions must only called on ConnectivityService's main thread. |
| 288 | |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 289 | private static final boolean ADD = true; |
| 290 | private static final boolean REMOVE = false; |
| 291 | |
| 292 | private void updateRequestCounts(boolean add, NetworkRequest request) { |
| 293 | int delta = add ? +1 : -1; |
| 294 | switch (request.type) { |
| 295 | case REQUEST: |
| 296 | case TRACK_DEFAULT: |
| 297 | mNumRequestNetworkRequests += delta; |
| 298 | break; |
| 299 | |
| 300 | case BACKGROUND_REQUEST: |
| 301 | mNumRequestNetworkRequests += delta; |
| 302 | mNumBackgroundNetworkRequests += delta; |
| 303 | break; |
| 304 | |
| 305 | case LISTEN: |
| 306 | break; |
| 307 | |
| 308 | case NONE: |
| 309 | default: |
| 310 | Log.wtf(TAG, "Unhandled request type " + request.type); |
| 311 | break; |
| 312 | } |
| 313 | } |
| 314 | |
Paul Jensen | 3d91146 | 2015-06-12 06:40:24 -0400 | [diff] [blame] | 315 | /** |
| 316 | * Add {@code networkRequest} to this network as it's satisfied by this network. |
Paul Jensen | 3d91146 | 2015-06-12 06:40:24 -0400 | [diff] [blame] | 317 | * @return true if {@code networkRequest} was added or false if {@code networkRequest} was |
| 318 | * already present. |
| 319 | */ |
| 320 | public boolean addRequest(NetworkRequest networkRequest) { |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 321 | NetworkRequest existing = mNetworkRequests.get(networkRequest.requestId); |
| 322 | if (existing == networkRequest) return false; |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 323 | if (existing != null) { |
| 324 | // Should only happen if the requestId wraps. If that happens lots of other things will |
| 325 | // be broken as well. |
| 326 | Log.wtf(TAG, String.format("Duplicate requestId for %s and %s on %s", |
| 327 | networkRequest, existing, name())); |
| 328 | updateRequestCounts(REMOVE, existing); |
| 329 | } |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 330 | mNetworkRequests.put(networkRequest.requestId, networkRequest); |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 331 | updateRequestCounts(ADD, networkRequest); |
Paul Jensen | 3d91146 | 2015-06-12 06:40:24 -0400 | [diff] [blame] | 332 | return true; |
Robert Greenwalt | 71bf33a | 2014-05-15 18:07:26 -0700 | [diff] [blame] | 333 | } |
| 334 | |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 335 | /** |
| 336 | * Remove the specified request from this network. |
| 337 | */ |
| 338 | public void removeRequest(int requestId) { |
| 339 | NetworkRequest existing = mNetworkRequests.get(requestId); |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 340 | if (existing == null) return; |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 341 | updateRequestCounts(REMOVE, existing); |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 342 | mNetworkRequests.remove(requestId); |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 343 | if (existing.isRequest()) { |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 344 | unlingerRequest(existing); |
| 345 | } |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 346 | } |
| 347 | |
| 348 | /** |
| 349 | * Returns whether this network is currently satisfying the request with the specified ID. |
| 350 | */ |
| 351 | public boolean isSatisfyingRequest(int id) { |
| 352 | return mNetworkRequests.get(id) != null; |
| 353 | } |
| 354 | |
| 355 | /** |
| 356 | * Returns the request at the specified position in the list of requests satisfied by this |
| 357 | * network. |
| 358 | */ |
| 359 | public NetworkRequest requestAt(int index) { |
| 360 | return mNetworkRequests.valueAt(index); |
| 361 | } |
| 362 | |
| 363 | /** |
| 364 | * Returns the number of requests currently satisfied by this network for which |
| 365 | * {@link android.net.NetworkRequest#isRequest} returns {@code true}. |
| 366 | */ |
| 367 | public int numRequestNetworkRequests() { |
| 368 | return mNumRequestNetworkRequests; |
| 369 | } |
| 370 | |
| 371 | /** |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 372 | * Returns the number of requests currently satisfied by this network of type |
| 373 | * {@link android.net.NetworkRequest.Type.BACKGROUND_REQUEST}. |
| 374 | */ |
| 375 | public int numBackgroundNetworkRequests() { |
| 376 | return mNumBackgroundNetworkRequests; |
| 377 | } |
| 378 | |
| 379 | /** |
| 380 | * Returns the number of foreground requests currently satisfied by this network. |
| 381 | */ |
| 382 | public int numForegroundNetworkRequests() { |
| 383 | return mNumRequestNetworkRequests - mNumBackgroundNetworkRequests; |
| 384 | } |
| 385 | |
| 386 | /** |
Lorenzo Colitti | 767708d | 2016-07-01 01:37:11 +0900 | [diff] [blame] | 387 | * Returns the number of requests of any type currently satisfied by this network. |
| 388 | */ |
| 389 | public int numNetworkRequests() { |
| 390 | return mNetworkRequests.size(); |
| 391 | } |
| 392 | |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 393 | /** |
| 394 | * Returns whether the network is a background network. A network is a background network if it |
| 395 | * is satisfying no foreground requests and at least one background request. (If it did not have |
| 396 | * a background request, it would be a speculative network that is only being kept up because |
| 397 | * it might satisfy a request if it validated). |
| 398 | */ |
| 399 | public boolean isBackgroundNetwork() { |
Lorenzo Colitti | f0e9a33 | 2016-07-18 18:40:42 +0900 | [diff] [blame] | 400 | return !isVPN() && numForegroundNetworkRequests() == 0 && mNumBackgroundNetworkRequests > 0; |
Lorenzo Colitti | 3d4a106 | 2016-09-09 18:48:56 +0900 | [diff] [blame] | 401 | } |
| 402 | |
Paul Jensen | 0cc1732 | 2014-11-25 15:26:53 -0500 | [diff] [blame] | 403 | // Does this network satisfy request? |
| 404 | public boolean satisfies(NetworkRequest request) { |
| 405 | return created && |
| 406 | request.networkCapabilities.satisfiedByNetworkCapabilities(networkCapabilities); |
| 407 | } |
| 408 | |
Lorenzo Colitti | c3f21f3 | 2015-07-06 23:50:27 +0900 | [diff] [blame] | 409 | public boolean satisfiesImmutableCapabilitiesOf(NetworkRequest request) { |
| 410 | return created && |
| 411 | request.networkCapabilities.satisfiedByImmutableNetworkCapabilities( |
| 412 | networkCapabilities); |
| 413 | } |
| 414 | |
Paul Jensen | 6bc2c2c | 2014-05-07 15:27:40 -0400 | [diff] [blame] | 415 | public boolean isVPN() { |
| 416 | return networkCapabilities.hasTransport(NetworkCapabilities.TRANSPORT_VPN); |
| 417 | } |
| 418 | |
Paul Jensen | b10e37f | 2014-11-25 12:33:08 -0500 | [diff] [blame] | 419 | private int getCurrentScore(boolean pretendValidated) { |
Paul Jensen | 2161a8e | 2014-09-11 11:00:39 -0400 | [diff] [blame] | 420 | // TODO: We may want to refactor this into a NetworkScore class that takes a base score from |
| 421 | // the NetworkAgent and signals from the NetworkAgent and uses those signals to modify the |
| 422 | // score. The NetworkScore class would provide a nice place to centralize score constants |
| 423 | // so they are not scattered about the transports. |
| 424 | |
Lorenzo Colitti | e03c3c7 | 2015-04-03 16:38:52 +0900 | [diff] [blame] | 425 | // If this network is explicitly selected and the user has decided to use it even if it's |
| 426 | // unvalidated, give it the maximum score. Also give it the maximum score if it's explicitly |
| 427 | // selected and we're trying to see what its score could be. This ensures that we don't tear |
| 428 | // down an explicitly selected network before the user gets a chance to prefer it when |
| 429 | // a higher-scoring network (e.g., Ethernet) is available. |
| 430 | if (networkMisc.explicitlySelected && (networkMisc.acceptUnvalidated || pretendValidated)) { |
| 431 | return MAXIMUM_NETWORK_SCORE; |
| 432 | } |
Paul Jensen | 2161a8e | 2014-09-11 11:00:39 -0400 | [diff] [blame] | 433 | |
Lorenzo Colitti | e03c3c7 | 2015-04-03 16:38:52 +0900 | [diff] [blame] | 434 | int score = currentScore; |
Hugo Benichi | c8e9e12 | 2016-09-14 23:23:08 +0000 | [diff] [blame] | 435 | if (!lastValidated && !pretendValidated && !ignoreWifiUnvalidationPenalty()) { |
Paul Jensen | e098854 | 2015-06-25 15:30:08 -0400 | [diff] [blame] | 436 | score -= UNVALIDATED_SCORE_PENALTY; |
| 437 | } |
Paul Jensen | 2161a8e | 2014-09-11 11:00:39 -0400 | [diff] [blame] | 438 | if (score < 0) score = 0; |
Paul Jensen | 2161a8e | 2014-09-11 11:00:39 -0400 | [diff] [blame] | 439 | return score; |
| 440 | } |
| 441 | |
Hugo Benichi | c8e9e12 | 2016-09-14 23:23:08 +0000 | [diff] [blame] | 442 | // Return true on devices configured to ignore score penalty for wifi networks |
| 443 | // that become unvalidated (b/31075769). |
| 444 | private boolean ignoreWifiUnvalidationPenalty() { |
Lorenzo Colitti | 165c51c | 2016-09-19 01:00:19 +0900 | [diff] [blame] | 445 | boolean isWifi = networkCapabilities.hasTransport(NetworkCapabilities.TRANSPORT_WIFI) && |
| 446 | networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET); |
Hugo Benichi | 50d46a4 | 2017-08-31 14:29:51 +0000 | [diff] [blame] | 447 | boolean avoidBadWifi = mConnService.avoidBadWifi() || avoidUnvalidated; |
Lorenzo Colitti | 165c51c | 2016-09-19 01:00:19 +0900 | [diff] [blame] | 448 | return isWifi && !avoidBadWifi && everValidated; |
Hugo Benichi | c8e9e12 | 2016-09-14 23:23:08 +0000 | [diff] [blame] | 449 | } |
| 450 | |
Paul Jensen | b10e37f | 2014-11-25 12:33:08 -0500 | [diff] [blame] | 451 | // Get the current score for this Network. This may be modified from what the |
| 452 | // NetworkAgent sent, as it has modifiers applied to it. |
| 453 | public int getCurrentScore() { |
| 454 | return getCurrentScore(false); |
| 455 | } |
| 456 | |
| 457 | // Get the current score for this Network as if it was validated. This may be modified from |
| 458 | // what the NetworkAgent sent, as it has modifiers applied to it. |
| 459 | public int getCurrentScoreAsValidated() { |
| 460 | return getCurrentScore(true); |
| 461 | } |
| 462 | |
Paul Jensen | 2161a8e | 2014-09-11 11:00:39 -0400 | [diff] [blame] | 463 | public void setCurrentScore(int newScore) { |
| 464 | currentScore = newScore; |
| 465 | } |
| 466 | |
Jeff Sharkey | f07c7b9 | 2016-04-22 09:50:16 -0600 | [diff] [blame] | 467 | public NetworkState getNetworkState() { |
| 468 | synchronized (this) { |
| 469 | // Network objects are outwardly immutable so there is no point to duplicating. |
| 470 | // Duplicating also precludes sharing socket factories and connection pools. |
| 471 | final String subscriberId = (networkMisc != null) ? networkMisc.subscriberId : null; |
| 472 | return new NetworkState(new NetworkInfo(networkInfo), |
| 473 | new LinkProperties(linkProperties), |
| 474 | new NetworkCapabilities(networkCapabilities), network, subscriberId, null); |
| 475 | } |
| 476 | } |
| 477 | |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 478 | /** |
| 479 | * Sets the specified request to linger on this network for the specified time. Called by |
| 480 | * ConnectivityService when the request is moved to another network with a higher score. |
| 481 | */ |
| 482 | public void lingerRequest(NetworkRequest request, long now, long duration) { |
| 483 | if (mLingerTimerForRequest.get(request.requestId) != null) { |
| 484 | // Cannot happen. Once a request is lingering on a particular network, we cannot |
| 485 | // re-linger it unless that network becomes the best for that request again, in which |
| 486 | // case we should have unlingered it. |
| 487 | Log.wtf(TAG, this.name() + ": request " + request.requestId + " already lingered"); |
| 488 | } |
| 489 | final long expiryMs = now + duration; |
| 490 | LingerTimer timer = new LingerTimer(request, expiryMs); |
| 491 | if (VDBG) Log.d(TAG, "Adding LingerTimer " + timer + " to " + this.name()); |
| 492 | mLingerTimers.add(timer); |
| 493 | mLingerTimerForRequest.put(request.requestId, timer); |
| 494 | } |
| 495 | |
| 496 | /** |
| 497 | * Cancel lingering. Called by ConnectivityService when a request is added to this network. |
Lorenzo Colitti | 5526f9c | 2016-08-22 16:46:40 +0900 | [diff] [blame] | 498 | * Returns true if the given request was lingering on this network, false otherwise. |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 499 | */ |
Lorenzo Colitti | 5526f9c | 2016-08-22 16:46:40 +0900 | [diff] [blame] | 500 | public boolean unlingerRequest(NetworkRequest request) { |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 501 | LingerTimer timer = mLingerTimerForRequest.get(request.requestId); |
| 502 | if (timer != null) { |
| 503 | if (VDBG) Log.d(TAG, "Removing LingerTimer " + timer + " from " + this.name()); |
| 504 | mLingerTimers.remove(timer); |
| 505 | mLingerTimerForRequest.remove(request.requestId); |
Lorenzo Colitti | 5526f9c | 2016-08-22 16:46:40 +0900 | [diff] [blame] | 506 | return true; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 507 | } |
Lorenzo Colitti | 5526f9c | 2016-08-22 16:46:40 +0900 | [diff] [blame] | 508 | return false; |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 509 | } |
| 510 | |
| 511 | public long getLingerExpiry() { |
| 512 | return mLingerExpiryMs; |
| 513 | } |
| 514 | |
| 515 | public void updateLingerTimer() { |
| 516 | long newExpiry = mLingerTimers.isEmpty() ? 0 : mLingerTimers.last().expiryMs; |
| 517 | if (newExpiry == mLingerExpiryMs) return; |
| 518 | |
| 519 | // Even if we're going to reschedule the timer, cancel it first. This is because the |
| 520 | // semantics of WakeupMessage guarantee that if cancel is called then the alarm will |
| 521 | // never call its callback (handleLingerComplete), even if it has already fired. |
| 522 | // WakeupMessage makes no such guarantees about rescheduling a message, so if mLingerMessage |
| 523 | // has already been dispatched, rescheduling to some time in the future it won't stop it |
| 524 | // from calling its callback immediately. |
| 525 | if (mLingerMessage != null) { |
| 526 | mLingerMessage.cancel(); |
| 527 | mLingerMessage = null; |
| 528 | } |
| 529 | |
| 530 | if (newExpiry > 0) { |
Hugo Benichi | 50d46a4 | 2017-08-31 14:29:51 +0000 | [diff] [blame] | 531 | mLingerMessage = mConnService.makeWakeupMessage( |
| 532 | mContext, mHandler, |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 533 | "NETWORK_LINGER_COMPLETE." + network.netId, |
| 534 | EVENT_NETWORK_LINGER_COMPLETE, this); |
| 535 | mLingerMessage.schedule(newExpiry); |
| 536 | } |
| 537 | |
| 538 | mLingerExpiryMs = newExpiry; |
| 539 | } |
| 540 | |
| 541 | public void linger() { |
| 542 | mLingering = true; |
| 543 | } |
| 544 | |
| 545 | public void unlinger() { |
| 546 | mLingering = false; |
| 547 | } |
| 548 | |
| 549 | public boolean isLingering() { |
| 550 | return mLingering; |
| 551 | } |
| 552 | |
| 553 | public void clearLingerState() { |
| 554 | if (mLingerMessage != null) { |
| 555 | mLingerMessage.cancel(); |
| 556 | mLingerMessage = null; |
| 557 | } |
| 558 | mLingerTimers.clear(); |
| 559 | mLingerTimerForRequest.clear(); |
| 560 | updateLingerTimer(); // Sets mLingerExpiryMs, cancels and nulls out mLingerMessage. |
| 561 | mLingering = false; |
| 562 | } |
| 563 | |
| 564 | public void dumpLingerTimers(PrintWriter pw) { |
| 565 | for (LingerTimer timer : mLingerTimers) { pw.println(timer); } |
| 566 | } |
| 567 | |
Hugo Benichi | ef50288 | 2017-09-01 01:23:32 +0000 | [diff] [blame] | 568 | public void updateClat(INetworkManagementService netd) { |
| 569 | if (Nat464Xlat.requiresClat(this)) { |
| 570 | maybeStartClat(netd); |
| 571 | } else { |
| 572 | maybeStopClat(); |
| 573 | } |
| 574 | } |
| 575 | |
| 576 | /** Ensure clat has started for this network. */ |
| 577 | public void maybeStartClat(INetworkManagementService netd) { |
| 578 | if (clatd != null && clatd.isStarted()) { |
| 579 | return; |
| 580 | } |
| 581 | clatd = new Nat464Xlat(netd, this); |
| 582 | clatd.start(); |
| 583 | } |
| 584 | |
| 585 | /** Ensure clat has stopped for this network. */ |
| 586 | public void maybeStopClat() { |
| 587 | if (clatd == null) { |
| 588 | return; |
| 589 | } |
| 590 | clatd.stop(); |
| 591 | clatd = null; |
| 592 | } |
| 593 | |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 594 | public String toString() { |
Erik Kline | 230d5ca | 2016-01-25 17:44:42 +0900 | [diff] [blame] | 595 | return "NetworkAgentInfo{ ni{" + networkInfo + "} " + |
| 596 | "network{" + network + "} nethandle{" + network.getNetworkHandle() + "} " + |
| 597 | "lp{" + linkProperties + "} " + |
| 598 | "nc{" + networkCapabilities + "} Score{" + getCurrentScore() + "} " + |
Lorenzo Colitti | 7b42f39 | 2014-12-17 11:26:49 +0900 | [diff] [blame] | 599 | "everValidated{" + everValidated + "} lastValidated{" + lastValidated + "} " + |
Lorenzo Colitti | b57578ca | 2016-07-01 01:53:25 +0900 | [diff] [blame] | 600 | "created{" + created + "} lingering{" + isLingering() + "} " + |
Lorenzo Colitti | e03c3c7 | 2015-04-03 16:38:52 +0900 | [diff] [blame] | 601 | "explicitlySelected{" + networkMisc.explicitlySelected + "} " + |
| 602 | "acceptUnvalidated{" + networkMisc.acceptUnvalidated + "} " + |
Paul Jensen | 3d194ea | 2015-06-16 14:27:36 -0400 | [diff] [blame] | 603 | "everCaptivePortalDetected{" + everCaptivePortalDetected + "} " + |
| 604 | "lastCaptivePortalDetected{" + lastCaptivePortalDetected + "} " + |
Hugo Benichi | b577d65 | 2017-06-27 15:13:20 +0900 | [diff] [blame] | 605 | "clat{" + clatd + "} " + |
Lorenzo Colitti | e03c3c7 | 2015-04-03 16:38:52 +0900 | [diff] [blame] | 606 | "}"; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 607 | } |
| 608 | |
| 609 | public String name() { |
| 610 | return "NetworkAgentInfo [" + networkInfo.getTypeName() + " (" + |
Hugo Benichi | b577d65 | 2017-06-27 15:13:20 +0900 | [diff] [blame] | 611 | networkInfo.getSubtypeName() + ") - " + Objects.toString(network) + "]"; |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 612 | } |
Paul Jensen | 85cf78e | 2015-06-25 13:25:07 -0400 | [diff] [blame] | 613 | |
| 614 | // Enables sorting in descending order of score. |
| 615 | @Override |
| 616 | public int compareTo(NetworkAgentInfo other) { |
| 617 | return other.getCurrentScore() - getCurrentScore(); |
| 618 | } |
Robert Greenwalt | 7b81602 | 2014-04-18 15:25:25 -0700 | [diff] [blame] | 619 | } |