Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8238588

JEP 380: Unix-Domain Socket Channels

    Details

    • Author:
      Michael McMahon
    • JEP Type:
      Feature
    • Exposure:
      Open
    • Subcomponent:
    • Scope:
      SE
    • Discussion:
      nio dash dev at openjdk dot java dot net
    • Effort:
      S
    • Duration:
      M
    • JEP Number:
      380

      Description

      Summary

      Add Unix-domain (AF_UNIX) socket support to the socket channel and server-socket channel APIs in the java.nio.channels package. Extend the inherited channel mechanism to support Unix-domain socket channels and server socket channels.

      Goals

      Unix-domain sockets are used for inter-process communication (IPC) on the same host. They are similar to TCP/IP sockets in most respects, except that they are addressed by filesystem path names rather than Internet Protocol (IP) addresses and port numbers. The goal of this JEP is to support all of the features of Unix-domain sockets that are common across the major Unix platforms and Windows. Unix-domain socket channels will behave the same as existing TCP/IP channels in terms of read/write behavior, connection setup, acceptance of incoming connections by servers, multiplexing with other non-blocking selectable channels in a selector, and support of relevant socket options.

      Non-Goals

      It is not a goal to support features that are not common across the major Unix platforms and Windows. This includes Linux-specific features such as the abstract filesystem-independent namespace. It also includes features that are generally supported on Unix but unsupported on Windows, such as socket pairs. Support for these features can be revisited in the future if needed and, in the case of the missing Windows features, if the Windows platform evolves to support them. An exception to this non-goal is support for peer credentials, which can be implemented as a JDK specific socket option on platforms that support it. Other socket options may be investigated as follow up work, possibly also as JDK specific options, after this JEP is completed.

      Motivation

      For local, inter-process communication, Unix-domain sockets are both more secure and more efficient than TCP/IP loopback connections.

      • Unix-domain sockets are strictly for communication between processes on the same system. Applications that are not intended to accept remote connections can improve security by using Unix-domain sockets.

      • Unix-domain sockets are further protected by operating-system enforced, filesystem-based access controls.

      • Unix-domain sockets have faster setup times and higher data throughput than TCP/IP loopback connections.

      • Unix-domain sockets may be a better solution than TCP/IP sockets for container environments, where communication between containers on the same system is required. This can be achieved using sockets located in shared volumes.

      Unix-domain sockets have long been a feature of most Unix platforms, and are now supported in Windows 10 and Windows Server 2019.

      Description

      To support Unix-domain socket channels we will add the following API elements:

      • A new socket address class, java.net.UnixDomainSocketAddress;

      • A UNIX constant value in the existing java.net.StandardProtocolFamily enum;

      • New open factory methods on SocketChannel and ServerSocketChannel that specify the protocol family

      • Updates to the SocketChannel and ServerSocketChannel specifications to specify how channels to Unix domain sockets behave.

      Alternatives

      An application could access AF_UNIX address structures and socket system calls directly, either via the Java Native Interface (JNI) or Project Panama. Socket objects of this type would, however, not be compatible with the existing SocketChannel API and therefore could not be multiplexed with other selectable channels using the Selector API.

      Testing

      Automatic unit tests will exercise the API and implementation. These tests will run on all supported Unix platforms and on multiple versions of Windows, including some that support Unix-domain sockets and some that do not.

      Risks and Assumptions

      Existing code that uses the SocketChannel and ServerSocketChannel classes often assumes that instances of SocketAddress returned by those APIs can be blindly cast to InetSocketAddress. This cast will fail with Unix-domain socket channels.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                michaelm Michael McMahon
                Reporter:
                michaelm Michael McMahon
                Owner:
                Michael McMahon
                Reviewed By:
                Alan Bateman, Brian Goetz
                Endorsed By:
                Brian Goetz
              • Votes:
                1 Vote for this issue
                Watchers:
                13 Start watching this issue

                Dates

                • Created:
                  Updated: