/*
* Copyright (C) 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.server;
import static android.net.RouteInfo.RTN_UNICAST;
import android.net.INetd;
import android.net.INetdUnsolicitedEventListener;
import android.net.InetAddresses;
import android.net.IpPrefix;
import android.net.LinkAddress;
import android.net.RouteInfo;
import android.os.Handler;
import android.os.RemoteException;
import android.util.Log;
import androidx.annotation.NonNull;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
/**
* A class for reporting network events to clients.
*
* Implements INetdUnsolicitedEventListener and registers with netd, and relays those events to
* all INetworkManagementEventObserver objects that have registered with it.
*/
public class NetworkObserverRegistry extends INetdUnsolicitedEventListener.Stub {
private static final String TAG = NetworkObserverRegistry.class.getSimpleName();
/**
* Start listening for Netd events.
*
*
This should be called before allowing any observer to be registered.
* Note there is no unregister method. The only way to unregister is when the process
* terminates.
*/
public void register(@NonNull INetd netd) throws RemoteException {
netd.registerUnsolicitedEventListener(this);
}
private final ConcurrentHashMap> mObservers =
new ConcurrentHashMap<>();
/**
* Registers the specified observer and start sending callbacks to it.
* This method may be called on any thread.
*/
public void registerObserver(@NonNull NetworkObserver observer, @NonNull Handler handler) {
if (handler == null) {
throw new IllegalArgumentException("handler must be non-null");
}
mObservers.put(observer, Optional.of(handler));
}
/**
* Registers the specified observer, and start sending callbacks to it.
*
* This method must only be called with callbacks that are nonblocking, such as callbacks
* that only send a message to a StateMachine.
*/
public void registerObserverForNonblockingCallback(@NonNull NetworkObserver observer) {
mObservers.put(observer, Optional.empty());
}
/**
* Unregisters the specified observer and stop sending callbacks to it.
* This method may be called on any thread.
*/
public void unregisterObserver(@NonNull NetworkObserver observer) {
mObservers.remove(observer);
}
@FunctionalInterface
private interface NetworkObserverEventCallback {
void sendCallback(NetworkObserver o);
}
private void invokeForAllObservers(@NonNull final NetworkObserverEventCallback callback) {
// ConcurrentHashMap#entrySet is weakly consistent: observers that were in the map before
// creation will be processed, those added during traversal may or may not.
for (Map.Entry> entry : mObservers.entrySet()) {
final NetworkObserver observer = entry.getKey();
final Optional handler = entry.getValue();
if (handler.isPresent()) {
handler.get().post(() -> callback.sendCallback(observer));
return;
}
try {
callback.sendCallback(observer);
} catch (RuntimeException e) {
Log.e(TAG, "Error sending callback to observer", e);
}
}
}
@Override
public void onInterfaceClassActivityChanged(boolean isActive,
int label, long timestamp, int uid) {
invokeForAllObservers(o -> o.onInterfaceClassActivityChanged(
isActive, label, timestamp, uid));
}
/**
* Notify our observers of a limit reached.
*/
@Override
public void onQuotaLimitReached(String alertName, String ifName) {
invokeForAllObservers(o -> o.onQuotaLimitReached(alertName, ifName));
}
@Override
public void onInterfaceDnsServerInfo(String ifName, long lifetime, String[] servers) {
invokeForAllObservers(o -> o.onInterfaceDnsServerInfo(ifName, lifetime, servers));
}
@Override
public void onInterfaceAddressUpdated(String addr, String ifName, int flags, int scope) {
final LinkAddress address = new LinkAddress(addr, flags, scope);
invokeForAllObservers(o -> o.onInterfaceAddressUpdated(address, ifName));
}
@Override
public void onInterfaceAddressRemoved(String addr,
String ifName, int flags, int scope) {
final LinkAddress address = new LinkAddress(addr, flags, scope);
invokeForAllObservers(o -> o.onInterfaceAddressRemoved(address, ifName));
}
@Override
public void onInterfaceAdded(String ifName) {
invokeForAllObservers(o -> o.onInterfaceAdded(ifName));
}
@Override
public void onInterfaceRemoved(String ifName) {
invokeForAllObservers(o -> o.onInterfaceRemoved(ifName));
}
@Override
public void onInterfaceChanged(String ifName, boolean up) {
invokeForAllObservers(o -> o.onInterfaceChanged(ifName, up));
}
@Override
public void onInterfaceLinkStateChanged(String ifName, boolean up) {
invokeForAllObservers(o -> o.onInterfaceLinkStateChanged(ifName, up));
}
@Override
public void onRouteChanged(boolean updated, String route, String gateway, String ifName) {
final RouteInfo processRoute = new RouteInfo(new IpPrefix(route),
("".equals(gateway)) ? null : InetAddresses.parseNumericAddress(gateway),
ifName, RTN_UNICAST);
if (updated) {
invokeForAllObservers(o -> o.onRouteUpdated(processRoute));
} else {
invokeForAllObservers(o -> o.onRouteRemoved(processRoute));
}
}
@Override
public void onStrictCleartextDetected(int uid, String hex) {}
@Override
public int getInterfaceVersion() {
return INetdUnsolicitedEventListener.VERSION;
}
@Override
public String getInterfaceHash() {
return INetdUnsolicitedEventListener.HASH;
}
}