/*

 * Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package sun.nio.ch;

import java.io.FileDescriptor;

import java.io.IOException;

import java.net.Inet4Address;

import java.net.Inet6Address;

import java.net.InetAddress;

import java.net.InetSocketAddress;

import java.net.NetworkInterface;

import java.net.ProtocolFamily;

import java.net.SocketAddress;

import java.net.SocketException;

import java.net.SocketOption;

import java.net.StandardProtocolFamily;

import java.net.StandardSocketOptions;

import java.net.UnknownHostException;

import java.nio.channels.AlreadyBoundException;

import java.nio.channels.ClosedChannelException;

import java.nio.channels.NotYetBoundException;

import java.nio.channels.NotYetConnectedException;

import java.nio.channels.UnresolvedAddressException;

import java.nio.channels.UnsupportedAddressTypeException;

import java.security.AccessController;

import java.security.PrivilegedAction;

import java.util.Enumeration;

import sun.net.ext.ExtendedSocketOptions;

import sun.net.util.IPAddressUtil;

import sun.security.action.GetPropertyAction;

public class Net {

    private Net() { }

    // unspecified protocol family

    static final ProtocolFamily UNSPEC = new ProtocolFamily() {

        public String name() {

            return "UNSPEC";

        }

    };

    // set to true if exclusive binding is on for Windows

    private static final boolean exclusiveBind;

    // set to true if the fast tcp loopback should be enabled on Windows

    private static final boolean fastLoopback;

    // -- Miscellaneous utilities --

    private static volatile boolean checkedIPv6;

    private static volatile boolean isIPv6Available;

    private static volatile boolean checkedReusePort;

    private static volatile boolean isReusePortAvailable;

    /**

     * Tells whether dual-IPv4/IPv6 sockets should be used.

     */

    static boolean isIPv6Available() {

        if (!checkedIPv6) {

            isIPv6Available = isIPv6Available0();

            checkedIPv6 = true;

        }

        return isIPv6Available;

    }

    /**

     * Tells whether SO_REUSEPORT is supported.

     */

    static boolean isReusePortAvailable() {

        if (!checkedReusePort) {

            isReusePortAvailable = isReusePortAvailable0();

            checkedReusePort = true;

        }

        return isReusePortAvailable;

    }

    /**

     * Returns true if exclusive binding is on

     */

    static boolean useExclusiveBind() {

        return exclusiveBind;

    }

    /**

     * Tells whether IPv6 sockets can join IPv4 multicast groups

     */

    static boolean canIPv6SocketJoinIPv4Group() {

        return canIPv6SocketJoinIPv4Group0();

    }

    /**

     * Tells whether {@link #join6} can be used to join an IPv4

     * multicast group (IPv4 group as IPv4-mapped IPv6 address)

     */

    static boolean canJoin6WithIPv4Group() {

        return canJoin6WithIPv4Group0();

    }

    public static InetSocketAddress checkAddress(SocketAddress sa) {

        if (sa == null)

            throw new NullPointerException();

        if (!(sa instanceof InetSocketAddress))

            throw new UnsupportedAddressTypeException(); // ## needs arg

        InetSocketAddress isa = (InetSocketAddress)sa;

        if (isa.isUnresolved())

            throw new UnresolvedAddressException(); // ## needs arg

        InetAddress addr = isa.getAddress();

        if (!(addr instanceof Inet4Address || addr instanceof Inet6Address))

            throw new IllegalArgumentException("Invalid address type");

        return isa;

    }

    static InetSocketAddress checkAddress(SocketAddress sa, ProtocolFamily family) {

        InetSocketAddress isa = checkAddress(sa);

        if (family == StandardProtocolFamily.INET) {

            InetAddress addr = isa.getAddress();

            if (!(addr instanceof Inet4Address))

                throw new UnsupportedAddressTypeException();

        }

        return isa;

    }

    static InetSocketAddress asInetSocketAddress(SocketAddress sa) {

        if (!(sa instanceof InetSocketAddress))

            throw new UnsupportedAddressTypeException();

        return (InetSocketAddress)sa;

    }

    static void translateToSocketException(Exception x)

        throws SocketException

    {

        if (x instanceof SocketException)

            throw (SocketException)x;

        Exception nx = x;

        if (x instanceof ClosedChannelException)

            nx = new SocketException("Socket is closed");

        else if (x instanceof NotYetConnectedException)

            nx = new SocketException("Socket is not connected");

        else if (x instanceof AlreadyBoundException)

            nx = new SocketException("Already bound");

        else if (x instanceof NotYetBoundException)

            nx = new SocketException("Socket is not bound yet");

        else if (x instanceof UnsupportedAddressTypeException)

            nx = new SocketException("Unsupported address type");

        else if (x instanceof UnresolvedAddressException) {

            nx = new SocketException("Unresolved address");

        }

        if (nx != x)

            nx.initCause(x);

        if (nx instanceof SocketException)

            throw (SocketException)nx;

        else if (nx instanceof RuntimeException)

            throw (RuntimeException)nx;

        else

            throw new Error("Untranslated exception", nx);

    }

    static void translateException(Exception x,

                                   boolean unknownHostForUnresolved)

        throws IOException

    {

        if (x instanceof IOException)

            throw (IOException)x;

        // Throw UnknownHostException from here since it cannot

        // be thrown as a SocketException

        if (unknownHostForUnresolved &&

            (x instanceof UnresolvedAddressException))

        {

             throw new UnknownHostException();

        }

        translateToSocketException(x);

    }

    static void translateException(Exception x)

        throws IOException

    {

        translateException(x, false);

    }

    /**

     * Returns the local address after performing a SecurityManager#checkConnect.

     */

    static InetSocketAddress getRevealedLocalAddress(InetSocketAddress addr) {

        SecurityManager sm = System.getSecurityManager();

        if (addr == null || sm == null)

            return addr;

        try{

            sm.checkConnect(addr.getAddress().getHostAddress(), -1);

            // Security check passed

        } catch (SecurityException e) {

            // Return loopback address only if security check fails

            addr = getLoopbackAddress(addr.getPort());

        }

        return addr;

    }

    static String getRevealedLocalAddressAsString(InetSocketAddress addr) {

        return System.getSecurityManager() == null ? addr.toString() :

                getLoopbackAddress(addr.getPort()).toString();

    }

    private static InetSocketAddress getLoopbackAddress(int port) {

        return new InetSocketAddress(InetAddress.getLoopbackAddress(),

                                     port);

    }

    /**

     * Returns any IPv4 address of the given network interface, or

     * null if the interface does not have any IPv4 addresses.

     */

    static Inet4Address anyInet4Address(final NetworkInterface interf) {

        return AccessController.doPrivileged(new PrivilegedAction<Inet4Address>() {

            public Inet4Address run() {

                Enumeration<InetAddress> addrs = interf.getInetAddresses();

                while (addrs.hasMoreElements()) {

                    InetAddress addr = addrs.nextElement();

                    if (addr instanceof Inet4Address) {

                        return (Inet4Address)addr;

                    }

                }

                return null;

            }

        });

    }

    /**

     * Returns an IPv4 address as an int.

     */

    static int inet4AsInt(InetAddress ia) {

        if (ia instanceof Inet4Address) {

            byte[] addr = ia.getAddress();

            int address  = addr[3] & 0xFF;

            address |= ((addr[2] << 8) & 0xFF00);

            address |= ((addr[1] << 16) & 0xFF0000);

            address |= ((addr[0] << 24) & 0xFF000000);

            return address;

        }

        throw new AssertionError("Should not reach here");

    }

    /**

     * Returns an InetAddress from the given IPv4 address

     * represented as an int.

     */

    static InetAddress inet4FromInt(int address) {

        byte[] addr = new byte[4];

        addr[0] = (byte) ((address >>> 24) & 0xFF);

        addr[1] = (byte) ((address >>> 16) & 0xFF);

        addr[2] = (byte) ((address >>> 8) & 0xFF);

        addr[3] = (byte) (address & 0xFF);

        try {

            return InetAddress.getByAddress(addr);

        } catch (UnknownHostException uhe) {

            throw new AssertionError("Should not reach here");

        }

    }

    /**

     * Returns an IPv6 address as a byte array

     */

    static byte[] inet6AsByteArray(InetAddress ia) {

        if (ia instanceof Inet6Address) {

            return ia.getAddress();

        }

        // need to construct IPv4-mapped address

        if (ia instanceof Inet4Address) {

            byte[] ip4address = ia.getAddress();

            byte[] address = new byte[16];

            address[10] = (byte)0xff;

            address[11] = (byte)0xff;

            address[12] = ip4address[0];

            address[13] = ip4address[1];

            address[14] = ip4address[2];

            address[15] = ip4address[3];

            return address;

        }

        throw new AssertionError("Should not reach here");

    }

    // -- Socket options

    static final ExtendedSocketOptions extendedOptions =

            ExtendedSocketOptions.getInstance();

    static void setSocketOption(FileDescriptor fd, SocketOption<?> name, Object value)

        throws IOException

    {

        setSocketOption(fd, Net.UNSPEC, name, value);

    }

    static void setSocketOption(FileDescriptor fd, ProtocolFamily family,

                                SocketOption<?> name, Object value)

        throws IOException

    {

        if (value == null)

            throw new IllegalArgumentException("Invalid option value");

        // only simple values supported by this method

        Class<?> type = name.type();

        if (extendedOptions.isOptionSupported(name)) {

            extendedOptions.setOption(fd, name, value);

            return;

        }

        if (type != Integer.class && type != Boolean.class)

            throw new AssertionError("Should not reach here");

        // special handling

        if (name == StandardSocketOptions.SO_RCVBUF ||

            name == StandardSocketOptions.SO_SNDBUF)

        {

            int i = ((Integer)value).intValue();

            if (i < 0)

                throw new IllegalArgumentException("Invalid send/receive buffer size");

        }

        if (name == StandardSocketOptions.SO_LINGER) {

            int i = ((Integer)value).intValue();

            if (i < 0)

                value = Integer.valueOf(-1);

            if (i > 65535)

                value = Integer.valueOf(65535);

        }

        if (name == StandardSocketOptions.IP_TOS) {

            int i = ((Integer)value).intValue();

            if (i < 0 || i > 255)

                throw new IllegalArgumentException("Invalid IP_TOS value");

        }

        if (name == StandardSocketOptions.IP_MULTICAST_TTL) {

            int i = ((Integer)value).intValue();

            if (i < 0 || i > 255)

                throw new IllegalArgumentException("Invalid TTL/hop value");

        }

        // map option name to platform level/name

        OptionKey key = SocketOptionRegistry.findOption(name, family);

        if (key == null)

            throw new AssertionError("Option not found");

        int arg;

        if (type == Integer.class) {

            arg = ((Integer)value).intValue();

        } else {

            boolean b = ((Boolean)value).booleanValue();

            arg = (b) ? 1 : 0;

        }

        boolean mayNeedConversion = (family == UNSPEC);

        boolean isIPv6 = (family == StandardProtocolFamily.INET6);

        setIntOption0(fd, mayNeedConversion, key.level(), key.name(), arg, isIPv6);

    }

    static Object getSocketOption(FileDescriptor fd, SocketOption<?> name)

        throws IOException

    {

        return getSocketOption(fd, Net.UNSPEC, name);

    }

    static Object getSocketOption(FileDescriptor fd, ProtocolFamily family, SocketOption<?> name)

        throws IOException

    {

        Class<?> type = name.type();

        if (extendedOptions.isOptionSupported(name)) {

            return extendedOptions.getOption(fd, name);

        }

        // only simple values supported by this method

        if (type != Integer.class && type != Boolean.class)

            throw new AssertionError("Should not reach here");

        // map option name to platform level/name

        OptionKey key = SocketOptionRegistry.findOption(name, family);

        if (key == null)

            throw new AssertionError("Option not found");

        boolean mayNeedConversion = (family == UNSPEC);

        int value = getIntOption0(fd, mayNeedConversion, key.level(), key.name());

        if (type == Integer.class) {

            return Integer.valueOf(value);

        } else {

            return (value == 0) ? Boolean.FALSE : Boolean.TRUE;

        }

    }

    public static boolean isFastTcpLoopbackRequested() {

        String loopbackProp = GetPropertyAction

                .privilegedGetProperty("jdk.net.useFastTcpLoopback", "false");

        return loopbackProp.isEmpty() ? true : Boolean.parseBoolean(loopbackProp);

    }

    // -- Socket operations --

    private static native boolean isIPv6Available0();

    private static native boolean isReusePortAvailable0();

    /*

     * Returns 1 for Windows and -1 for Solaris/Linux/Mac OS

     */

    private static native int isExclusiveBindAvailable();

    private static native boolean canIPv6SocketJoinIPv4Group0();

    private static native boolean canJoin6WithIPv4Group0();

    static FileDescriptor socket(boolean stream) throws IOException {

        return socket(UNSPEC, stream);

    }

    static FileDescriptor socket(ProtocolFamily family, boolean stream) throws IOException {

        boolean preferIPv6 = isIPv6Available() &&

            (family != StandardProtocolFamily.INET);

        return IOUtil.newFD(socket0(preferIPv6, stream, false, fastLoopback));

    }

    static FileDescriptor serverSocket(boolean stream) {

        return IOUtil.newFD(socket0(isIPv6Available(), stream, true, fastLoopback));

    }

    // Due to oddities SO_REUSEADDR on windows reuse is ignored

    private static native int socket0(boolean preferIPv6, boolean stream, boolean reuse,

                                      boolean fastLoopback);

    public static void bind(FileDescriptor fd, InetAddress addr, int port)

        throws IOException

    {

        bind(UNSPEC, fd, addr, port);

    }

    static void bind(ProtocolFamily family, FileDescriptor fd,

                     InetAddress addr, int port) throws IOException

    {

        boolean preferIPv6 = isIPv6Available() &&

            (family != StandardProtocolFamily.INET);

        if (addr.isLinkLocalAddress()) {

            addr = IPAddressUtil.toScopedAddress(addr);

        }

        bind0(fd, preferIPv6, exclusiveBind, addr, port);

    }

    private static native void bind0(FileDescriptor fd, boolean preferIPv6,

                                     boolean useExclBind, InetAddress addr,

                                     int port)

        throws IOException;

    static native void listen(FileDescriptor fd, int backlog) throws IOException;

    static int connect(FileDescriptor fd, InetAddress remote, int remotePort)

        throws IOException

    {

        return connect(UNSPEC, fd, remote, remotePort);

    }

    static int connect(ProtocolFamily family, FileDescriptor fd, InetAddress remote, int remotePort)

        throws IOException

    {

        if (remote.isLinkLocalAddress()) {

            remote = IPAddressUtil.toScopedAddress(remote);

        }

        boolean preferIPv6 = isIPv6Available() &&

            (family != StandardProtocolFamily.INET);

        return connect0(preferIPv6, fd, remote, remotePort);

    }