android-16.0.0_r2/s

/*
 * Copyright (C) 2023 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.thread;

import static android.system.OsConstants.AF_INET6;
import static android.system.OsConstants.EADDRINUSE;
import static android.system.OsConstants.IFF_MULTICAST;
import static android.system.OsConstants.IFF_NOARP;
import static android.system.OsConstants.NETLINK_ROUTE;

import static com.android.net.module.util.netlink.NetlinkConstants.RTM_NEWLINK;
import static com.android.net.module.util.netlink.RtNetlinkLinkMessage.IFLA_AF_SPEC;
import static com.android.net.module.util.netlink.RtNetlinkLinkMessage.IFLA_INET6_ADDR_GEN_MODE;
import static com.android.net.module.util.netlink.RtNetlinkLinkMessage.IN6_ADDR_GEN_MODE_NONE;
import static com.android.net.module.util.netlink.StructNlMsgHdr.NLM_F_ACK;
import static com.android.net.module.util.netlink.StructNlMsgHdr.NLM_F_REQUEST;

import android.annotation.Nullable;
import android.net.IpPrefix;
import android.net.LinkAddress;
import android.net.LinkProperties;
import android.net.RouteInfo;
import android.os.ParcelFileDescriptor;
import android.os.SystemClock;
import android.system.ErrnoException;
import android.system.Os;

import com.android.net.module.util.HexDump;
import com.android.net.module.util.LinkPropertiesUtils.CompareResult;
import com.android.net.module.util.SharedLog;
import com.android.net.module.util.netlink.NetlinkUtils;
import com.android.net.module.util.netlink.StructIfinfoMsg;
import com.android.net.module.util.netlink.StructNlAttr;
import com.android.net.module.util.netlink.StructNlMsgHdr;
import com.android.server.thread.openthread.Ipv6AddressInfo;
import com.android.server.thread.openthread.OnMeshPrefixConfig;

import java.io.IOException;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.MulticastSocket;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.util.ArrayList;
import java.util.List;

/** Controller for virtual/tunnel network interfaces. */
public class TunInterfaceController {
    private static final String TAG = "TunIfController";
    private static final boolean DBG = false;
    private static final SharedLog LOG = ThreadNetworkLogger.forSubComponent(TAG);
    private static final long INFINITE_LIFETIME = 0xffffffffL;
    static final int MTU = 1280;

    static {
        System.loadLibrary("service-thread-jni");
    }

    private final String mIfName;
    private final LinkProperties mLinkProperties = new LinkProperties();
    private final MulticastSocket mMulticastSocket; // For join group and leave group
    private final List<InetAddress> mMulticastAddresses = new ArrayList<>();
    private final List<RouteInfo> mNetDataPrefixes = new ArrayList<>();

    private ParcelFileDescriptor mParcelTunFd;
    private NetworkInterface mNetworkInterface;

    /** Creates a new {@link TunInterfaceController} instance for given interface. */
    public TunInterfaceController(String interfaceName) {
        mIfName = interfaceName;
        mLinkProperties.setInterfaceName(mIfName);
        mLinkProperties.setMtu(MTU);
        mMulticastSocket = createMulticastSocket();
    }

    /** Returns link properties of the Thread TUN interface. */
    private LinkProperties getLinkProperties() {
        return new LinkProperties(mLinkProperties);
    }

    /** Returns link properties of the Thread TUN interface with the given NAT64 CIDR. */
    // TODO: manage the NAT64 CIDR in the TunInterfaceController
    public LinkProperties getLinkPropertiesWithNat64Cidr(@Nullable LinkAddress nat64Cidr) {
        final LinkProperties lp = getLinkProperties();
        if (nat64Cidr != null) {
            lp.addLinkAddress(nat64Cidr);
            lp.addRoute(getRouteForAddress(nat64Cidr));
        }
        return lp;
    }

    /**
     * Creates the tunnel interface.
     *
     * @throws IOException if failed to create the interface
     */
    public void createTunInterface() throws IOException {
        mParcelTunFd = ParcelFileDescriptor.adoptFd(nativeCreateTunInterface(mIfName, MTU));
        try {
            mNetworkInterface = NetworkInterface.getByName(mIfName);
        } catch (SocketException e) {
            throw new IOException("Failed to get NetworkInterface", e);
        }

        setAddrGenModeToNone();
    }

    public void destroyTunInterface() {
        try {
            mParcelTunFd.close();
        } catch (IOException e) {
            // Should never fail
        }
        mParcelTunFd = null;
        mNetworkInterface = null;
    }

    /** Returns the FD of the tunnel interface. */
    @Nullable
    public ParcelFileDescriptor getTunFd() {
        return mParcelTunFd;
    }

    private native int nativeCreateTunInterface(String interfaceName, int mtu) throws IOException;

    /** Sets the interface up or down according to {@code isUp}. */
    public void setInterfaceUp(boolean isUp) throws IOException {
        if (!isUp) {
            for (LinkAddress address : mLinkProperties.getAllLinkAddresses()) {
                removeAddress(address);
            }
            for (RouteInfo route : mLinkProperties.getAllRoutes()) {
                mLinkProperties.removeRoute(route);
            }
            mNetDataPrefixes.clear();
        }
        nativeSetInterfaceUp(mIfName, isUp);
    }

    private native void nativeSetInterfaceUp(String interfaceName, boolean isUp) throws IOException;

    /** Adds a new address to the interface. */
    public void addAddress(LinkAddress address) {
        if (!(address.getAddress() instanceof Inet6Address)) {
            return;
        }
        LOG.v("Adding address " + address + " with flags: " + address.getFlags());

        long preferredLifetimeSeconds;
        long validLifetimeSeconds;

        if (address.getDeprecationTime() == LinkAddress.LIFETIME_PERMANENT
                || address.getDeprecationTime() == LinkAddress.LIFETIME_UNKNOWN) {
            preferredLifetimeSeconds = INFINITE_LIFETIME;
        } else {
            preferredLifetimeSeconds =
                    Math.max(
                            (address.getDeprecationTime() - SystemClock.elapsedRealtime()) / 1000L,
                            0L);
        }

        if (address.getExpirationTime() == LinkAddress.LIFETIME_PERMANENT
                || address.getExpirationTime() == LinkAddress.LIFETIME_UNKNOWN) {
            validLifetimeSeconds = INFINITE_LIFETIME;
        } else {
            validLifetimeSeconds =
                    Math.max(
                            (address.getExpirationTime() - SystemClock.elapsedRealtime()) / 1000L,
                            0L);
        }
        // Only apply to Ipv6 address
        if (!NetlinkUtils.sendRtmNewAddressRequest(
                Os.if_nametoindex(mIfName),
                address.getAddress(),
                (short) address.getPrefixLength(),
                address.getFlags(),
                (byte) address.getScope(),
                preferredLifetimeSeconds,
                validLifetimeSeconds)) {
            LOG.w("Failed to add address " + address.getAddress().getHostAddress());
            return;
        }
        mLinkProperties.addLinkAddress(address);
        mLinkProperties.addRoute(getRouteForAddress(address));
    }

    /** Removes an address from the interface. */
    public void removeAddress(LinkAddress address) {
        if (!(address.getAddress() instanceof Inet6Address)) {
            return;
        }
        LOG.v("Removing address " + address);

        // Intentionally update the mLinkProperties before send netlink message because the
        // address is already removed from ot-daemon and apps can't reach to the address even
        // when the netlink request below fails
        mLinkProperties.removeLinkAddress(address);
        mLinkProperties.removeRoute(getRouteForAddress(address));
        // Only apply to Ipv6 address
        if (!NetlinkUtils.sendRtmDelAddressRequest(
                Os.if_nametoindex(mIfName),
                (Inet6Address) address.getAddress(),
                (short) address.getPrefixLength())) {
            LOG.w("Failed to remove address " + address.getAddress().getHostAddress());
        }
    }

    public void updateAddresses(List<Ipv6AddressInfo> addressInfoList) {
        final List<LinkAddress> newLinkAddresses = new ArrayList<>();
        final List<InetAddress> newMulticastAddresses = new ArrayList<>();
        boolean hasActiveOmrAddress = false;

        for (Ipv6AddressInfo addressInfo : addressInfoList) {
            if (addressInfo.isActiveOmr) {
                hasActiveOmrAddress = true;
                break;
            }
        }

        for (Ipv6AddressInfo addressInfo : addressInfoList) {
            InetAddress address = addressInfoToInetAddress(addressInfo);
            if (address.isMulticastAddress()) {
                newMulticastAddresses.add(address);
            } else {
                newLinkAddresses.add(newLinkAddress(addressInfo, hasActiveOmrAddress));
            }
        }

        final CompareResult<LinkAddress> addressDiff =
                new CompareResult<>(mLinkProperties.getAllLinkAddresses(), newLinkAddresses);
        for (LinkAddress linkAddress : addressDiff.removed) {
            removeAddress(linkAddress);
        }
        for (LinkAddress linkAddress : addressDiff.added) {
            addAddress(linkAddress);
        }

        final CompareResult<InetAddress> multicastAddressDiff =
                new CompareResult<>(mMulticastAddresses, newMulticastAddresses);
        for (InetAddress address : multicastAddressDiff.removed) {
            leaveGroup(address);
        }
        for (InetAddress address : multicastAddressDiff.added) {
            joinGroup(address);
        }
        mMulticastAddresses.clear();
        mMulticastAddresses.addAll(newMulticastAddresses);
    }

    public void updatePrefixes(List<OnMeshPrefixConfig> onMeshPrefixConfigList) {
        final List<RouteInfo> newNetDataPrefixes = new ArrayList<>();

        for (OnMeshPrefixConfig onMeshPrefixConfig : onMeshPrefixConfigList) {
            newNetDataPrefixes.add(getRouteForOnMeshPrefix(onMeshPrefixConfig));
        }

        final CompareResult<RouteInfo> prefixDiff =
                new CompareResult<>(mNetDataPrefixes, newNetDataPrefixes);
        for (RouteInfo routeRemoved : prefixDiff.removed) {
            mLinkProperties.removeRoute(routeRemoved);
        }
        for (RouteInfo routeAdded : prefixDiff.added) {
            mLinkProperties.addRoute(routeAdded);
        }

        mNetDataPrefixes.clear();
        mNetDataPrefixes.addAll(newNetDataPrefixes);
    }

    private RouteInfo getRouteForAddress(LinkAddress linkAddress) {
        return getRouteForIpPrefix(
                new IpPrefix(linkAddress.getAddress(), linkAddress.getPrefixLength()));
    }

    private RouteInfo getRouteForOnMeshPrefix(OnMeshPrefixConfig onMeshPrefixConfig) {
        return getRouteForIpPrefix(
                new IpPrefix(
                        bytesToInet6Address(onMeshPrefixConfig.prefix),
                        onMeshPrefixConfig.prefixLength));
    }

    private RouteInfo getRouteForIpPrefix(IpPrefix ipPrefix) {
        return new RouteInfo(ipPrefix, null, mIfName, RouteInfo.RTN_UNICAST, MTU);
    }

    /** Called by {@link ThreadNetworkControllerService} to do clean up when ot-daemon is dead. */
    public void onOtDaemonDied() {
        try {
            setInterfaceUp(false);
        } catch (IOException e) {
            LOG.e("Failed to set Thread TUN interface down");
        }
    }

    private static InetAddress addressInfoToInetAddress(Ipv6AddressInfo addressInfo) {
        return bytesToInet6Address(addressInfo.address);
    }

    private static Inet6Address bytesToInet6Address(byte[] addressBytes) {
        try {
            return (Inet6Address) Inet6Address.getByAddress(addressBytes);
        } catch (UnknownHostException e) {
            // This is unlikely to happen unless the Thread daemon is critically broken
            return null;
        }
    }

    private static LinkAddress newLinkAddress(
            Ipv6AddressInfo addressInfo, boolean hasActiveOmrAddress) {
        // Mesh-local addresses and OMR address have the same scope, to distinguish them we set
        // mesh-local addresses as deprecated when there is an active OMR address. If OMR address
        // is missing, only ML-EID in mesh-local addresses will be set preferred.
        // For OMR address and link-local address we only use the value isPreferred set by
        // ot-daemon.
        boolean isPreferred = addressInfo.isPreferred;
        if (addressInfo.isMeshLocal) {
            isPreferred = (!hasActiveOmrAddress && addressInfo.isMeshLocalEid);
        }

        final long deprecationTimeMillis =
                isPreferred ? LinkAddress.LIFETIME_PERMANENT : SystemClock.elapsedRealtime();

        final InetAddress address = addressInfoToInetAddress(addressInfo);

        // flags and scope will be adjusted automatically depending on the address and
        // its lifetimes.
        return new LinkAddress(
                address,
                addressInfo.prefixLength,
                0 /* flags */,
                0 /* scope */,
                deprecationTimeMillis,
                LinkAddress.LIFETIME_PERMANENT /* expirationTime */);
    }

    private MulticastSocket createMulticastSocket() {
        try {
            return new MulticastSocket();
        } catch (IOException e) {
            throw new IllegalStateException("Failed to create multicast socket ", e);
        }
    }

    private void joinGroup(InetAddress address) {
        InetSocketAddress socketAddress = new InetSocketAddress(address, 0);
        try {
            mMulticastSocket.joinGroup(socketAddress, mNetworkInterface);
        } catch (IOException e) {
            if (e.getCause() instanceof ErrnoException) {
                ErrnoException ee = (ErrnoException) e.getCause();
                if (ee.errno == EADDRINUSE) {
                    LOG.w(
                            "Already joined group "
                                    + address.getHostAddress()
                                    + ": "
                                    + e.getMessage());
                    return;
                }
            }
            LOG.e("failed to join group " + address.getHostAddress(), e);
        }
    }

    private void leaveGroup(InetAddress address) {
        InetSocketAddress socketAddress = new InetSocketAddress(address, 0);
        try {
            mMulticastSocket.leaveGroup(socketAddress, mNetworkInterface);
        } catch (IOException e) {
            LOG.e("failed to leave group " + address.getHostAddress(), e);
        }
    }

    /**
     * Sets the address generation mode to {@code IN6_ADDR_GEN_MODE_NONE}.
     *
     * <p>So that the "thread-wpan" interface has only one IPv6 link local address which is
     * generated by OpenThread.
     */
    private void setAddrGenModeToNone() {
        StructNlMsgHdr header = new StructNlMsgHdr();
        header.nlmsg_type = RTM_NEWLINK;
        header.nlmsg_pid = 0;
        header.nlmsg_seq = 0;
        header.nlmsg_flags = NLM_F_REQUEST | NLM_F_ACK;

        StructIfinfoMsg ifInfo =
                new StructIfinfoMsg(
                        (short) 0 /* family */,
                        0 /* type */,
                        Os.if_nametoindex(mIfName),
                        (IFF_MULTICAST | IFF_NOARP) /* flags */,
                        0xffffffff /* change */);

        // Nested attributes
        // IFLA_AF_SPEC
        //   AF_INET6
        //     IFLA_INET6_ADDR_GEN_MODE
        StructNlAttr addrGenMode =
                new StructNlAttr(IFLA_INET6_ADDR_GEN_MODE, (byte) IN6_ADDR_GEN_MODE_NONE);
        StructNlAttr afInet6 = new StructNlAttr((short) AF_INET6, addrGenMode);
        StructNlAttr afSpec = new StructNlAttr(IFLA_AF_SPEC, afInet6);

        final int msgLength =
                StructNlMsgHdr.STRUCT_SIZE
                        + StructIfinfoMsg.STRUCT_SIZE
                        + afSpec.getAlignedLength();
        byte[] msg = new byte[msgLength];
        ByteBuffer buf = ByteBuffer.wrap(msg);
        buf.order(ByteOrder.nativeOrder());

        header.nlmsg_len = msgLength;
        header.pack(buf);
        ifInfo.pack(buf);
        afSpec.pack(buf);

        if (buf.position() != msgLength) {
            throw new AssertionError(
                    String.format(
                            "Unexpected netlink message size (actual = %d, expected = %d)",
                            buf.position(), msgLength));
        }

        if (DBG) {
            LOG.v("ADDR_GEN_MODE message is:");
            LOG.v(HexDump.dumpHexString(msg));
        }

        try {
            NetlinkUtils.sendOneShotKernelMessage(NETLINK_ROUTE, msg);
        } catch (ErrnoException e) {
            LOG.e("Failed to set ADDR_GEN_MODE to NONE", e);
        }
    }
}