LineageOS/android_packages_modules_Connectivity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the NetworkAgent API for council comments

Browse Source 
Bug: 152238712
Test: FrameworksNetTests NetworkStackTests
Copy from ag/10824609
Change-Id: I9a2691f783f4449348c3f767568e05620f0b9df5
Merged-In: I9a2691f783f4449348c3f767568e05620f0b9df5
This commit is contained in:
Chalard Jean
2020-03-24 23:16:35 +09:00
committed by Aaron Huang
parent 0943dac366
commit f5d1bfd77f
3 changed files with 118 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
core/java/android/net/NetworkAgent.java
View File

@@ -16,6 +16,8 @@
package android.net;
import android.annotation.IntDef;
import android.annotation.IntRange;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
@@ -32,18 +34,52 @@ import android.util.Log;
import com.android.internal.util.AsyncChannel;
import com.android.internal.util.Protocol;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* A Utility class for handling for communicating between bearer-specific
* A utility class for handling for communicating between bearer-specific
* code and ConnectivityService.
*
* An agent manages the life cycle of a network. A network starts its
* life cycle when {@link register} is called on NetworkAgent. The network
* is then connecting. When full L3 connectivity has been established,
* the agent shoud call {@link setConnected} to inform the system that
* this network is ready to use. When the network disconnects its life
* ends and the agent should call {@link unregister}, at which point the
* system will clean up and free resources.
* Any reconnection becomes a new logical network, so after a network
* is disconnected the agent cannot be used any more. Network providers
* should create a new NetworkAgent instance to handle new connections.
*
* A bearer may have more than one NetworkAgent if it can simultaneously
* support separate networks (IMS / Internet / MMS Apns on cellular, or
* perhaps connections with different SSID or P2P for Wi-Fi).
*
* This class supports methods to start and stop sending keepalive packets.
* Keepalive packets are typically sent at periodic intervals over a network
* with NAT when there is no other traffic to avoid the network forcefully
* closing the connection. NetworkAgents that manage technologies that
* have hardware support for keepalive should implement the related
* methods to save battery life. NetworkAgent that cannot get support
* without waking up the CPU should not, as this would be prohibitive in
* terms of battery - these agents should simply not override the related
* methods, which results in the implementation returning
* {@link SocketKeepalive.ERROR_UNSUPPORTED} as appropriate.
*
* Keepalive packets need to be sent at relatively frequent intervals
* (a few seconds to a few minutes). As the contents of keepalive packets
* depend on the current network status, hardware needs to be configured
* to send them and has a limited amount of memory to do so. The HAL
* formalizes this as slots that an implementation can configure to send
* the correct packets. Devices typically have a small number of slots
* per radio technology, and the specific number of slots for each
* technology is specified in configuration files.
* {@see SocketKeepalive} for details.
*
* @hide
*/
@SystemApi
@@ -65,7 +101,7 @@ public abstract class NetworkAgent {
private final String LOG_TAG;
private static final boolean DBG = true;
private static final boolean VDBG = false;
private final ArrayList<Message>mPreConnectedQueue = new ArrayList<Message>();
private final ArrayList<Message> mPreConnectedQueue = new ArrayList<Message>();
private volatile long mLastBwRefreshTime = 0;
private static final long BW_REFRESH_MIN_WIN_MS = 500;
private boolean mBandwidthUpdateScheduled = false;
@@ -74,6 +110,8 @@ public abstract class NetworkAgent {
// into the internal API of ConnectivityService.
@NonNull
private NetworkInfo mNetworkInfo;
@NonNull
private final Object mRegisterLock = new Object();
/**
* The ID of the {@link NetworkProvider} that created this object, or
@@ -158,6 +196,14 @@ public abstract class NetworkAgent {
*/
public static final int VALIDATION_STATUS_NOT_VALID = 2;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = { "VALIDATION_STATUS_" }, value = {
VALIDATION_STATUS_VALID,
VALIDATION_STATUS_NOT_VALID
})
public @interface ValidationStatus {}
// TODO: remove.
/** @hide */
public static final int VALID_NETWORK = 1;
@@ -202,7 +248,7 @@ public abstract class NetworkAgent {
* Sent by ConnectivityService to the NetworkAgent to request that the specified packet be sent
* periodically on the given interval.
*
* arg1 = the slot number of the keepalive to start
* arg1 = the hardware slot number of the keepalive to start
* arg2 = interval in seconds
* obj = KeepalivePacketData object describing the data to be sent
*
@@ -214,7 +260,7 @@ public abstract class NetworkAgent {
/**
* Requests that the specified keepalive packet be stopped.
*
* arg1 = slot number of the keepalive to stop.
* arg1 = hardware slot number of the keepalive to stop.
*
* Also used internally by ConnectivityService / KeepaliveTracker, with different semantics.
* @hide
@@ -229,7 +275,7 @@ public abstract class NetworkAgent {
* This is also sent by KeepaliveTracker to the app's {@link SocketKeepalive},
* so that the app's {@link SocketKeepalive.Callback} methods can be called.
*
* arg1 = slot number of the keepalive
* arg1 = hardware slot number of the keepalive
* arg2 = error code
* @hide
*/
@@ -259,7 +305,7 @@ public abstract class NetworkAgent {
* remote site will send ACK packets in response to the keepalive packets, the firmware also
* needs to be configured to properly filter the ACKs to prevent the system from waking up.
* This does not happen with UDP, so this message is TCP-specific.
* arg1 = slot number of the keepalive to filter for.
* arg1 = hardware slot number of the keepalive to filter for.
* obj = the keepalive packet to send repeatedly.
* @hide
*/
@@ -268,7 +314,7 @@ public abstract class NetworkAgent {
/**
* Sent by the KeepaliveTracker to NetworkAgent to remove a packet filter. See
* {@link #CMD_ADD_KEEPALIVE_PACKET_FILTER}.
* arg1 = slot number of the keepalive packet filter to remove.
* arg1 = hardware slot number of the keepalive packet filter to remove.
* @hide
*/
public static final int CMD_REMOVE_KEEPALIVE_PACKET_FILTER = BASE + 17;
@@ -441,7 +487,15 @@ public abstract class NetworkAgent {
+ (msg.arg1 == VALID_NETWORK ? "VALID, " : "INVALID, ")
+ redirectUrl);
}
onValidationStatus(msg.arg1 /* status */, redirectUrl);
Uri uri = null;
try {
if (null != redirectUrl) {
uri = Uri.parse(redirectUrl);
}
} catch (Exception e) {
Log.wtf(LOG_TAG, "Surprising URI : " + redirectUrl, e);
}
onValidationStatus(msg.arg1 /* status */, uri);
break;
}
case CMD_SAVE_ACCEPT_UNVALIDATED: {
@@ -489,19 +543,29 @@ public abstract class NetworkAgent {
/**
* Register this network agent with ConnectivityService.
*
* This method can only be called once per network agent.
*
* @return the Network associated with this network agent (which can also be obtained later
* by calling getNetwork() on this agent).
* @throws IllegalStateException thrown by the system server if this network agent is
* already registered.
*/
@NonNull
public Network register() {
if (VDBG) log("Registering NetworkAgent");
final ConnectivityManager cm = (ConnectivityManager) mInitialConfiguration.context
.getSystemService(Context.CONNECTIVITY_SERVICE);
mNetwork = cm.registerNetworkAgent(new Messenger(mHandler),
new NetworkInfo(mInitialConfiguration.info),
mInitialConfiguration.properties, mInitialConfiguration.capabilities,
mInitialConfiguration.score, mInitialConfiguration.config, providerId);
mInitialConfiguration = null; // All this memory can now be GC'd
synchronized (mRegisterLock) {
if (mNetwork != null) {
throw new IllegalStateException("Agent already registered");
}
mNetwork = cm.registerNetworkAgent(new Messenger(mHandler),
new NetworkInfo(mInitialConfiguration.info),
mInitialConfiguration.properties, mInitialConfiguration.capabilities,
mInitialConfiguration.score, mInitialConfiguration.config, providerId);
mInitialConfiguration = null; // All this memory can now be GC'd
}
return mNetwork;
}
@@ -544,13 +608,14 @@ public abstract class NetworkAgent {
* Must be called by the agent when the network's {@link LinkProperties} change.
* @param linkProperties the new LinkProperties.
*/
public void sendLinkProperties(@NonNull LinkProperties linkProperties) {
public final void sendLinkProperties(@NonNull LinkProperties linkProperties) {
Objects.requireNonNull(linkProperties);
queueOrSendMessage(EVENT_NETWORK_PROPERTIES_CHANGED, new LinkProperties(linkProperties));
}
/**
* Inform ConnectivityService that this agent has now connected.
* Call {@link #unregister} to disconnect.
*/
public void setConnected() {
if (mIsLegacy) {
@@ -569,8 +634,7 @@ public abstract class NetworkAgent {
*/
public void unregister() {
if (mIsLegacy) {
throw new UnsupportedOperationException(
"Legacy agents can't call unregister.");
throw new UnsupportedOperationException("Legacy agents can't call unregister.");
}
mNetworkInfo.setDetailedState(NetworkInfo.DetailedState.DISCONNECTED, null, null);
queueOrSendMessage(EVENT_NETWORK_INFO_CHANGED, mNetworkInfo);
@@ -626,7 +690,7 @@ public abstract class NetworkAgent {
* @hide TODO: expose something better.
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public void sendNetworkInfo(NetworkInfo networkInfo) {
public final void sendNetworkInfo(NetworkInfo networkInfo) {
if (!mIsLegacy) {
throw new UnsupportedOperationException("Only legacy agents can call sendNetworkInfo.");
}
@@ -637,7 +701,7 @@ public abstract class NetworkAgent {
* Must be called by the agent when the network's {@link NetworkCapabilities} change.
* @param networkCapabilities the new NetworkCapabilities.
*/
public void sendNetworkCapabilities(@NonNull NetworkCapabilities networkCapabilities) {
public final void sendNetworkCapabilities(@NonNull NetworkCapabilities networkCapabilities) {
Objects.requireNonNull(networkCapabilities);
mBandwidthUpdatePending.set(false);
mLastBwRefreshTime = System.currentTimeMillis();
@@ -647,9 +711,10 @@ public abstract class NetworkAgent {
/**
* Must be called by the agent to update the score of this network.
* @param score the new score.
*
* @param score the new score, between 0 and 99.
*/
public void sendNetworkScore(int score) {
public final void sendNetworkScore(@IntRange(from = 0, to = 99) int score) {
if (score < 0) {
throw new IllegalArgumentException("Score must be >= 0");
}
@@ -737,11 +802,11 @@ public abstract class NetworkAgent {
* subsequent attempts to validate connectivity that fail.
*
* @param status one of {@code VALIDATION_STATUS_VALID} or {@code VALIDATION_STATUS_NOT_VALID}.
* @param redirectUrl If Internet connectivity is being redirected (e.g., on a captive portal),
* @param redirectUri If Internet connectivity is being redirected (e.g., on a captive portal),
* this is the destination the probes are being redirected to, otherwise {@code null}.
*/
public void onValidationStatus(int status, @Nullable String redirectUrl) {
networkStatus(status, redirectUrl);
public void onValidationStatus(@ValidationStatus int status, @Nullable Uri redirectUri) {
networkStatus(status, redirectUri.toString());
}
/** @hide TODO delete once subclasses have moved to onValidationStatus */
protected void networkStatus(int status, String redirectUrl) {
@@ -770,7 +835,12 @@ public abstract class NetworkAgent {
* @param intervalSeconds the interval between packets
* @param packet the packet to send.
*/
public void onStartSocketKeepalive(int slot, int intervalSeconds,
// seconds is from SocketKeepalive.MIN_INTERVAL_SEC to MAX_INTERVAL_SEC, but these should
// not be exposed as constants because they may change in the future (API guideline 4.8)
// and should have getters if exposed at all. Getters can't be used in the annotation,
// so the values unfortunately need to be copied.
public void onStartSocketKeepalive(int slot,
@IntRange(from = 10, to = 3600) int intervalSeconds,
@NonNull KeepalivePacketData packet) {
Message msg = mHandler.obtainMessage(CMD_START_SOCKET_KEEPALIVE, slot, intervalSeconds,
packet);
@@ -801,9 +871,11 @@ public abstract class NetworkAgent {
* Must be called by the agent when a socket keepalive event occurs.
*
* @param slot the hardware slot on which the event occurred.
* @param event the event that occurred.
* @param event the event that occurred, as one of the SocketKeepalive.ERROR_*
* or SocketKeepalive.SUCCESS constants.
*/
public void sendSocketKeepaliveEvent(int slot, int event) {
public final void sendSocketKeepaliveEvent(int slot,
@SocketKeepalive.KeepaliveEvent int event) {
queueOrSendMessage(EVENT_SOCKET_KEEPALIVE, slot, event);
}
/** @hide TODO delete once callers have moved to sendSocketKeepaliveEvent */
@@ -845,9 +917,18 @@ public abstract class NetworkAgent {
}
/**
* Called by ConnectivityService to inform this network transport of signal strength thresholds
* Called by ConnectivityService to inform this network agent of signal strength thresholds
* that when crossed should trigger a system wakeup and a NetworkCapabilities update.
*
* When the system updates the list of thresholds that should wake up the CPU for a
* given agent it will call this method on the agent. The agent that implement this
* should implement it in hardware so as to ensure the CPU will be woken up on breach.
* Agents are expected to react to a breach by sending an updated NetworkCapabilities
* object with the appropriate signal strength to sendNetworkCapabilities.
*
* The specific units are bearer-dependent. See details on the units and requests in
* {@link NetworkCapabilities.Builder#setSignalStrength}.
*
* @param thresholds the array of thresholds that should trigger wakeups.
*/
public void onSignalStrengthThresholdsUpdated(@NonNull int[] thresholds) {

2
core/java/android/net/NetworkRequest.java
View File

@@ -473,9 +473,7 @@ public class NetworkRequest implements Parcelable {
*
* @param nc Capabilities that should satisfy this NetworkRequest. null capabilities do not
* satisfy any request.
* @hide
*/
@SystemApi
public boolean satisfiedBy(@Nullable NetworkCapabilities nc) {
return networkCapabilities.satisfiedByNetworkCapabilities(nc);
}

10
core/java/android/net/SocketKeepalive.java
View File

@@ -109,6 +109,16 @@ public abstract class SocketKeepalive implements AutoCloseable {
})
public @interface ErrorCode {}
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(value = {
SUCCESS,
ERROR_INVALID_LENGTH,
ERROR_UNSUPPORTED,
ERROR_INSUFFICIENT_RESOURCES
})
public @interface KeepaliveEvent {}
/**
* The minimum interval in seconds between keepalive packet transmissions.
*