bind.
- *
+ *
* @param instanceSupplier The constructor of the concrete subclass.
* @param forceAddr The address to use.
* @param The concrete {@link AFSocketAddress} that is supported by this type.
@@ -216,7 +226,7 @@ protected static AFServerSocket forceBindOn(
* Forces the address to be used for any subsequent call to {@link #bind(SocketAddress)} to be the
* given one, regardless of what'll be passed to {@link #bind(SocketAddress, int)}, but doesn't
* bind yet.
- *
+ *
* @param endpoint The forced endpoint address.
* @return This {@link AFServerSocket}.
*/
@@ -264,7 +274,7 @@ public final void bind(SocketAddress endpoint, int backlog) throws IOException {
}
}
setBoundEndpoint(getAFImpl().getLocalSocketAddress());
- if (boundEndpoint == null) {
+ if (boundEndpoint0() == null) {
setBoundEndpoint(endpointCast);
}
@@ -277,7 +287,7 @@ public final void bind(SocketAddress endpoint, int backlog) throws IOException {
@Override
public final boolean isBound() {
- return boundEndpoint != null && implementation.getFD().valid();
+ return boundEndpoint0() != null && implementation.getFD().valid();
}
@Override
@@ -323,7 +333,7 @@ AFSocket accept1(boolean throwOnFail) throws IOException {
/**
* Returns a new {@link AFSocket} instance.
- *
+ *
* @return The new instance.
* @throws IOException on error.
*/
@@ -331,7 +341,7 @@ AFSocket accept1(boolean throwOnFail) throws IOException {
@Override
public String toString() {
- return getClass().getSimpleName() + "[" + (isBound() ? boundEndpoint : "unbound") + "]";
+ return getClass().getSimpleName() + "[" + (isBound() ? boundEndpoint0() : "unbound") + "]";
}
@Override
@@ -381,7 +391,7 @@ && isDeleteOnClose()) {
/**
* Registers a {@link Closeable} that should be closed when this socket is closed.
- *
+ *
* @param closeable The closeable.
*/
public final void addCloseable(Closeable closeable) {
@@ -390,7 +400,7 @@ public final void addCloseable(Closeable closeable) {
/**
* Unregisters a previously registered {@link Closeable}.
- *
+ *
* @param closeable The closeable.
*/
public final void removeCloseable(Closeable closeable) {
@@ -399,7 +409,7 @@ public final void removeCloseable(Closeable closeable) {
/**
* Checks whether everything is setup to support junixsocket sockets.
- *
+ *
* @return {@code true} if supported.
*/
public static boolean isSupported() {
@@ -409,18 +419,25 @@ public static boolean isSupported() {
@Override
@SuppressFBWarnings("EI_EXPOSE_REP")
public final @Nullable A getLocalSocketAddress() {
- if (boundEndpoint == null) {
- setBoundEndpoint(getAFImpl().getLocalSocketAddress());
+ @Nullable
+ A ep = boundEndpoint0();
+ if (ep == null) {
+ ep = getAFImpl().getLocalSocketAddress();
+ setBoundEndpoint(ep);
}
+ return ep;
+ }
+
+ private synchronized @Nullable A boundEndpoint0() {
return boundEndpoint;
}
/**
* Checks if the local socket address returned by {@link #getLocalSocketAddress()} is still valid.
- *
+ *
* The address is no longer valid if the server socket has been closed, {@code null}, or another
* server socket has been bound on that address.
- *
+ *
* @return {@code true} iff still valid.
*/
public boolean isLocalSocketAddressValid() {
@@ -435,7 +452,7 @@ public boolean isLocalSocketAddressValid() {
return addr.equals(getAFImpl().getLocalSocketAddress());
}
- final void setBoundEndpoint(@Nullable A addr) {
+ final synchronized void setBoundEndpoint(@Nullable A addr) {
this.boundEndpoint = addr;
int port;
if (addr == null) {
@@ -448,10 +465,10 @@ final void setBoundEndpoint(@Nullable A addr) {
@Override
public final int getLocalPort() {
- if (boundEndpoint == null) {
+ if (boundEndpoint0() == null) {
setBoundEndpoint(getAFImpl().getLocalSocketAddress());
}
- if (boundEndpoint == null) {
+ if (boundEndpoint0() == null) {
return -1;
} else {
return getAFImpl().getLocalPort1();
@@ -460,10 +477,10 @@ public final int getLocalPort() {
/**
* Checks if this {@link AFServerSocket}'s file should be removed upon {@link #close()}.
- *
+ *
* Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract
* namespace).
- *
+ *
* @return {@code true} if an attempt is made to delete the socket file upon {@link #close()}.
*/
public final boolean isDeleteOnClose() {
@@ -473,10 +490,10 @@ public final boolean isDeleteOnClose() {
/**
* Enables/disables deleting this {@link AFServerSocket}'s file (or other resource type) upon
* {@link #close()}.
- *
+ *
* Deletion is not guaranteed, especially when not supported (e.g., addresses in the abstract
* namespace).
- *
+ *
* @param b Enabled if {@code true}.
*/
public final void setDeleteOnClose(boolean b) {
@@ -486,6 +503,7 @@ public final void setDeleteOnClose(boolean b) {
final AFSocketImpl getAFImpl() {
if (created.compareAndSet(false, true)) {
try {
+ getAFImpl().create(true);
getSoTimeout(); // trigger create via java.net.Socket
} catch (IOException e) {
// ignore
@@ -507,7 +525,7 @@ public final FileDescriptor getFileDescriptor() throws IOException {
/**
* Returns the address family supported by this implementation.
- *
+ *
* @return The family.
*/
protected final AFAddressFamily addressFamily() {
@@ -517,9 +535,9 @@ protected final AFAddressFamily addressFamily() {
/**
* Sets the hook for any subsequent call to {@link #bind(SocketAddress)} and
* {@link #bind(SocketAddress, int)} to be the given function.
- *
+ *
* The function can monitor calls or even alter the endpoint address.
- *
+ *
* @param hook The function that gets called for each {@code bind} call.
* @return This instance.
*/
@@ -527,4 +545,117 @@ public final AFServerSocket bindHook(SocketAddressFilter hook) {
this.bindFilter = hook;
return this;
}
+
+ @Override
+ public void bind(SocketAddress endpoint) throws IOException {
+ bind(endpoint, 50);
+ }
+
+ @Override
+ public InetAddress getInetAddress() {
+ if (!isBound()) {
+ return null;
+ } else {
+ return getAFImpl().getInetAddress();
+ }
+ }
+
+ @Override
+ public synchronized void setReceiveBufferSize(int size) throws SocketException {
+ if (size <= 0) {
+ throw new IllegalArgumentException("receive buffer size must be a positive number");
+ }
+ if (isClosed()) {
+ throw new SocketException("Socket is closed");
+ }
+ getAFImpl().setOption(SocketOptions.SO_RCVBUF, size);
+ }
+
+ @Override
+ public synchronized int getReceiveBufferSize() throws SocketException {
+ if (isClosed()) {
+ throw new SocketException("Socket is closed");
+ }
+ int result = 0;
+ Object o = getAFImpl().getOption(SocketOptions.SO_RCVBUF);
+ if (o instanceof Number) {
+ result = ((Number) o).intValue();
+ }
+ return result;
+ }
+
+ @Override
+ @SuppressWarnings("UnsynchronizedOverridesSynchronized" /* errorprone */)
+ public void setSoTimeout(int timeout) throws SocketException {
+ if (isClosed()) {
+ throw new SocketException("Socket is closed");
+ }
+ if (timeout < 0) {
+ throw new IllegalArgumentException("timeout < 0");
+ }
+ getAFImpl().setOption(SocketOptions.SO_TIMEOUT, timeout);
+ }
+
+ @Override
+ @SuppressWarnings("UnsynchronizedOverridesSynchronized" /* errorprone */)
+ public int getSoTimeout() throws IOException {
+ if (isClosed()) {
+ throw new SocketException("Socket is closed");
+ }
+ Object o = getAFImpl().getOption(SocketOptions.SO_TIMEOUT);
+ /* extra type safety */
+ if (o instanceof Number) {
+ return ((Number) o).intValue();
+ } else {
+ return 0;
+ }
+ }
+
+ @Override
+ public void setReuseAddress(boolean on) throws SocketException {
+ if (isClosed()) {
+ throw new SocketException("Socket is closed");
+ }
+ getAFImpl().setOption(SocketOptions.SO_REUSEADDR, on);
+ }
+
+ @Override
+ public boolean getReuseAddress() throws SocketException {
+ if (isClosed()) {
+ throw new SocketException("Socket is closed");
+ }
+ return ((Boolean) (getAFImpl().getOption(SocketOptions.SO_REUSEADDR)));
+ }
+
+ @Override
+ public void setPerformancePreferences(int connectionTime, int latency, int bandwidth) {
+ }
+
+ @SuppressWarnings({"all", "MissingOverride" /* errorprone */})
+ public true iff {@link AFSocket}s are supported by the current Java VM.
- *
+ *
* To support {@link AFSocket}s, a custom JNI library must be loaded that is supplied with
* junixsocket.
- *
+ *
* @return {@code true} iff supported.
*/
public static boolean isSupported() {
@@ -314,9 +317,9 @@ public static boolean isSupported() {
/**
* Checks if {@link AFSocket}s are supported by the current Java VM.
- *
+ *
* If not, an {@link UnsupportedOperationException} is thrown.
- *
+ *
* @throws UnsupportedOperationException if not supported.
*/
public static void ensureSupported() throws UnsupportedOperationException {
@@ -325,13 +328,18 @@ public static void ensureSupported() throws UnsupportedOperationException {
/**
* Returns the version of the junixsocket library, as a string, for debugging purposes.
- *
+ *
* NOTE: Do not rely on the format of the version identifier, use socket capabilities instead.
- *
+ *
* @return String The version identifier, or {@code null} if it could not be determined.
* @see #supports(AFSocketCapability)
*/
public static final String getVersion() {
+ String v = BuildProperties.getBuildProperties().get("git.build.version");
+ if (v != null && !v.startsWith("$")) {
+ return v;
+ }
+
try {
return NativeLibraryLoader.getJunixsocketVersion();
} catch (IOException e) {
@@ -342,9 +350,9 @@ public static final String getVersion() {
/**
* Returns an identifier of the loaded native library, or {@code null} if the library hasn't been
* loaded yet.
- *
+ *
* The identifier is useful mainly for debugging purposes.
- *
+ *
* @return The identifier of the loaded junixsocket-native library, or {@code null}.
*/
public static final String getLoadedLibrary() {
@@ -371,6 +379,11 @@ public final void ensureAncillaryReceiveBufferSize(int minSize) {
impl.ensureAncillaryReceiveBufferSize(minSize);
}
+ private static boolean isCapDisabled(AFSocketCapability cap) {
+ return Boolean.parseBoolean(System.getProperty(PROP_LIBRARY_DISABLE_CAPABILITY_PREFIX + cap
+ .name(), "false"));
+ }
+
private static int initCapabilities() {
if (!isSupported()) {
return 0;
@@ -392,41 +405,58 @@ private static int initCapabilities() {
}
}
- private static boolean isCapDisabled(AFSocketCapability cap) {
- return Boolean.valueOf(System.getProperty(PROP_LIBRARY_DISABLE_CAPABILITY_PREFIX + cap.name(),
- "false"));
+ private static synchronized int capabilities() {
+ if (capabilitiesValue == null) {
+ capabilitiesValue = initCapabilities();
+ }
+ return capabilitiesValue;
}
/**
* Checks if the current environment (system platform, native library, etc.) supports a given
* junixsocket capability.
- *
+ *
* Deprecated. Please use {@link #supports(AFSocketCapability)} instead.
- *
+ *
* NOTE: The result may or may not be cached from a previous call or from a check upon
* initialization.
- *
+ *
* @param capability The capability.
* @return true if supported.
* @see #supports(AFSocketCapability)
*/
@Deprecated
public static final boolean supports(AFUNIXSocketCapability capability) {
- return (CAPABILITIES & capability.getBitmask()) != 0;
+ return (capabilities() & capability.getBitmask()) != 0;
}
/**
* Checks if the current environment (system platform, native library, etc.) supports a given
* junixsocket capability.
- *
+ *
* NOTE: The result may or may not be cached from a previous call or from a check upon
* initialization.
- *
+ *
* @param capability The capability.
* @return true if supported.
*/
public static final boolean supports(AFSocketCapability capability) {
- return (CAPABILITIES & capability.getBitmask()) != 0;
+ return (capabilities() & capability.getBitmask()) != 0;
+ }
+
+ /**
+ * Checks if the current environment (system platform, native library, etc.) supports "unsafe"
+ * operations (as controlled via the {@link AFSocketCapability#CAPABILITY_UNSAFE} capability).
+ *
+ * If supported, the method returns normally. If not supported, an {@link IOException} is thrown.
+ *
+ * @throws IOException if "unsafe" operations are not supported.
+ * @see Unsafe
+ */
+ public static final void ensureUnsafeSupported() throws IOException {
+ if (!AFSocket.supports(AFSocketCapability.CAPABILITY_UNSAFE)) {
+ throw new IOException("Unsafe operations are not supported in this environment");
+ }
}
@Override
@@ -442,7 +472,7 @@ public final synchronized void close() throws IOException {
/**
* Registers a {@link Closeable} that should be closed when this socket is closed.
- *
+ *
* @param closeable The closeable.
*/
public final void addCloseable(Closeable closeable) {
@@ -451,7 +481,7 @@ public final void addCloseable(Closeable closeable) {
/**
* Unregisters a previously registered {@link Closeable}.
- *
+ *
* @param closeable The closeable.
*/
public final void removeCloseable(Closeable closeable) {
@@ -514,7 +544,7 @@ public final AFOutputStream getOutputStream() throws IOException {
/**
* Returns the internal helper instance for address-specific extensions.
- *
+ *
* @return The helper instance.
* @throws UnsupportedOperationException if such extensions are not supported for this address
* type.
@@ -526,7 +556,7 @@ protected final AFSocketImplExtensions getImplExtensions() {
/**
* Forces the address to be used for any subsequent call to {@link #connect(SocketAddress)} to be
* the given one, regardless of what'll be passed there.
- *
+ *
* @param endpoint The forced endpoint address.
* @return This instance.
*/
@@ -539,9 +569,9 @@ public final AFSocket forceConnectAddress(SocketAddress endpoint) {
/**
* Sets the hook for any subsequent call to {@link #connect(SocketAddress)} or
* {@link #connect(SocketAddress, int)} to be the given function.
- *
+ *
* The function can monitor events or even alter the target address.
- *
+ *
* @param hook The function that gets called for each connect call.
* @return This instance.
*/
@@ -552,10 +582,10 @@ public final AFSocket connectHook(SocketAddressFilter hook) {
/**
* Probes the status of the socket connection.
- *
+ *
* This usually involves checking for {@link #isConnected()}, and if assumed connected, also
* sending a zero-length message to the remote.
- *
+ *
* @return {@code true} if the connection is known to be closed, {@code false} if the connection
* is open/not closed or the condition is unknown.
* @throws IOException on an unexpected error.
@@ -580,4 +610,13 @@ public boolean checkConnectionClosed() throws IOException {
}
}
}
+
+ /**
+ * Checks if we're running on Android (as far as junixsocket is concerned).
+ *
+ * @return {@code true} if running on Android.
+ */
+ public static boolean isRunningOnAndroid() {
+ return NativeLibraryLoader.isAndroid();
+ }
}
diff --git a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddress.java b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddress.java
index 13ff3a541..b07586a49 100644
--- a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddress.java
+++ b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddress.java
@@ -1,7 +1,7 @@
/*
* junixsocket
*
- * Copyright 2009-2022 Christian Kohlschütter
+ * Copyright 2009-2023 Christian Kohlschütter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,10 +17,13 @@
*/
package org.newsclub.net.unix;
+import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileDescriptor;
import java.io.FileNotFoundException;
import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.InetSocketAddress;
@@ -29,6 +32,7 @@
import java.net.SocketException;
import java.net.URI;
import java.nio.ByteBuffer;
+import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
@@ -37,13 +41,18 @@
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
+import com.google.errorprone.annotations.Immutable;
+import com.kohlschutter.annotations.compiletime.SuppressFBWarnings;
+
/**
* Some {@link SocketAddress} that is supported by junixsocket, such as {@link AFUNIXSocketAddress}.
- *
+ *
* @author Christian Kohlschütter
*/
+@Immutable
+@SuppressWarnings({"PMD.CouplingBetweenObjects", "PMD.CyclomaticComplexity"})
public abstract class AFSocketAddress extends InetSocketAddress {
- private static final long serialVersionUID = 1L;
+ private static final long serialVersionUID = 1L; // do not change!
/**
* Just a marker for "don't actually bind" (checked with "=="). Used in combination with a
@@ -73,30 +82,42 @@ protected ByteBuffer initialValue() {
}
};
+ private static final boolean USE_DESERIALIZATION_FOR_INIT;
+
+ static {
+ String v = System.getProperty("org.newsclub.net.unix.AFSocketAddress.deserialize", "");
+ USE_DESERIALIZATION_FOR_INIT = v.isEmpty() ? NativeLibraryLoader.isAndroid() : Boolean.valueOf(
+ v);
+ }
+
/**
* Some byte-level representation of this address, which can only be converted to a native
* representation in combination with the domain ID.
*/
- private final byte[] bytes;
+ @SuppressFBWarnings("JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS")
+ private byte[] bytes;
/**
* An {@link InetAddress}-wrapped representation of this address. Only created upon demand.
*/
- private InetAddress inetAddress = null;
+ @SuppressFBWarnings("JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS") // only modified during
+ // construction/deserialization
+ private InetAddress inetAddress = null; // derived from bytes
/**
* The system-native representation of this address, or {@code null}.
*/
- private final ByteBuffer nativeAddress;
+ @SuppressWarnings("PMD.ImmutableField")
+ private transient ByteBuffer nativeAddress;
/**
* The address family.
*/
- private final AFAddressFamily addressFamily;
+ private transient AFAddressFamily addressFamily;
/**
* Creates a new socket address.
- *
+ *
* @param port The port.
* @param socketAddress The socket address in junixsocket-specific byte-array representation.
* @param nativeAddress The socket address in system-native representation.
@@ -108,59 +129,200 @@ protected AFSocketAddress(int port, final byte[] socketAddress, ByteBuffer nativ
/*
* Initializing the superclass with an unresolved hostname helps us pass the #equals and
* #hashCode checks, which unfortunately are declared final in InetSocketAddress.
- *
+ *
* Using a resolved address (with the address bit initialized) would be ideal, but resolved
* addresses can only be IPv4 or IPv6 (at least as of Java 16 and earlier).
*/
- super(AFInetAddress.createUnresolvedHostname(socketAddress, af), 0);
- this.nativeAddress = nativeAddress == null ? null : (ByteBuffer) nativeAddress.duplicate()
- .rewind();
+ super(AFInetAddress.createUnresolvedHostname(socketAddress, af), port >= 0 && port <= 0xffff
+ ? port : 0);
+ initAFSocketAddress(this, port, socketAddress, nativeAddress, af);
+ }
+
+ /**
+ * Only for {@link SentinelSocketAddress}.
+ *
+ * @param clazz The {@link SentinelSocketAddress} class.
+ * @param port A sentinel port number.
+ */
+ @SuppressWarnings("PMD.UnusedFormalParameter")
+ AFSocketAddress(Class
+ * Works like {@link Integer#toUnsignedString(int)}; added to allow execution on Java 1.7.
+ *
+ * @param i The value.
+ * @return The string.
+ */
+ static String toUnsignedString(int i) {
+ return Long.toString(toUnsignedLong(i));
+ }
+
+ /**
+ * Returns a string representation of the first argument as an unsigned integer value in the radix
+ * specified by the second argument; added to allow execution on Java 1.7.
+ *
+ * @param i The value.
+ * @param radix The radix.
+ * @return The string.
+ */
+ static String toUnsignedString(int i, int radix) {
+ return Long.toUnsignedString(toUnsignedLong(i), radix);
+ }
+
+ private static long toUnsignedLong(long x) {
+ return x & 0xffffffffL;
+ }
+
+ /**
+ * Parses the string argument as an unsigned integer in the radix specified by the second
+ * argument. Works like {@link Integer#parseUnsignedInt(String, int)}; added to allow execution on
+ * Java 1.7.
+ *
+ * @param s The string.
+ * @param radix The radix.
+ * @return The integer.
+ * @throws NumberFormatException on parse error.
+ */
+ protected static int parseUnsignedInt(String s, int radix) throws NumberFormatException {
+ if (s == null || s.isEmpty()) {
+ throw new NumberFormatException("Cannot parse null or empty string");
+ }
+
+ int len = s.length();
+ if (s.startsWith("-")) {
+ throw new NumberFormatException("Illegal leading minus sign on unsigned string " + s);
+ }
+
+ if (len <= 5 || (radix == 10 && len <= 9)) {
+ return Integer.parseInt(s, radix);
+ } else {
+ long ell = Long.parseLong(s, radix);
+ if ((ell & 0xffff_ffff_0000_0000L) == 0) {
+ return (int) ell;
+ } else {
+ throw new NumberFormatException("String value exceeds " + "range of unsigned int: " + s);
+ }
+ }
+ }
}
diff --git a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddressConfig.java b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddressConfig.java
index f4b6bc194..f37f1da4a 100644
--- a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddressConfig.java
+++ b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketAddressConfig.java
@@ -1,7 +1,7 @@
/*
* junixsocket
*
- * Copyright 2009-2022 Christian Kohlschütter
+ * Copyright 2009-2023 Christian Kohlschütter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
/**
* The implementation-specifics for a given {@link AFSocketAddress} subclass implementation.
- *
+ *
* @param The supported address type.
* @author Christian Kohlschütter
* @see AFAddressFamilyConfig
@@ -40,7 +40,7 @@ protected AFSocketAddressConfig() {
/**
* Tries to parse the given address-specific URI.
- *
+ *
* @param u The URI.
* @param port The port to use, or {@code -1} for "unspecified".
* @return The address.
@@ -50,23 +50,23 @@ protected AFSocketAddressConfig() {
/**
* Returns the implementation's address constructor.
- *
+ *
* @return The implementation's address constructor.
*/
protected abstract AFSocketAddressConstructor addressConstructor();
/**
* Returns the name of the implementation's selector provider class.
- *
+ *
* @return The name of the implementation's selector provider class.
*/
protected abstract String selectorProviderClassname();
/**
* Returns the set of supported URI schemes that can be parsed via {@link #parseURI(URI,int)}.
- *
+ *
* These schemes must be unique to this {@link AFSocketAddress} type.
- *
+ *
* @return The set of supported URI schemes.
*/
protected abstract Setorg.newsclub.net.unix.library.disable.CAPABILITY_SOMETHING_SOMETHING=true
+ * when invoking the JVM (make sure this property is set before junixsocket is accessed).
+ *
+ * A simple way to check which capabilities are supported in an environment is to run the
+ * `junixsocket-selftest` jar.
*/
public enum AFSocketCapability {
// see org_newsclub_net_unix_NativeUnixSocket.c in junixsocket-native
@@ -41,16 +48,16 @@ public enum AFSocketCapability {
/** Socket addressing supports the abstract namespace (Linux). */
CAPABILITY_ABSTRACT_NAMESPACE(3),
- /** Support for AF_UNIX datagrams (not on Windows yet). */
+ /** Support for AF_UNIX datagrams. */
CAPABILITY_UNIX_DATAGRAMS(4),
/**
* A pair of interconnected sockets can be created natively as AF_UNIX sockets.
- *
+ *
* This currently not possible on Windows, but instead emulated via anonymous AF_INET ports when
* you use {@link AFSocketPair}. Other systems may provide partial implementations of pipe-based
* (i.e., non-socket) pairs.
- *
+ *
* This capability is specific to AF_UNIX sockets. Other sockets, such as AF_VSOCK, may not
* implement socketpair natively even if this capability is set, but would work-around that
* limitation in a similar fashion but maybe without resorting to AF_INET.
@@ -59,14 +66,14 @@ public enum AFSocketCapability {
/**
* A file descriptor can be converted to {@link Redirect}.
- *
+ *
* This feature currently uses Java SDK internals that may change/disappear.
*/
CAPABILITY_FD_AS_REDIRECT(6),
/**
* Support for AF_TIPC.
- *
+ *
* Availability of this feature is checked upon launch and therefore loading the "tipc" kernel
* module at a later point may not be properly reflected.
*/
@@ -74,10 +81,10 @@ public enum AFSocketCapability {
/**
* Support for AF_UNIX.
- *
+ *
* Availability of this feature is checked upon launch and therefore, on systems adding support at
* a later point, may not be properly reflected when checking at a later point.
- *
+ *
* NOTE: While this capability is typically supported on most systems that can actually load a
* junixsocket JNI library, it is unavailable for older Windows versions (such as 8.1, 10 before
* AFUNIX.SYS was included, etc.) and on systems where support for UNIX domain sockets is actively
@@ -90,7 +97,7 @@ public enum AFSocketCapability {
*
* Availability of this feature is checked upon launch and therefore enabling vsock at a later
* point may not be properly reflected.
- *
+ *
* @see #CAPABILITY_VSOCK_DGRAM
*/
CAPABILITY_VSOCK(9),
@@ -106,16 +113,39 @@ public enum AFSocketCapability {
/**
* Support for zero-length send(2).
- *
+ *
* This can be used to perform a connection check, but not all operating systems support this or
* behave correctly (particularly, IBM AIX, IBM i, and IBM z/OS) at the moment.
- *
+ *
* If not supported, junixsocket will simply ignore writes of zero-length, and connection checking
* with {@link AFSocket#checkConnectionClosed()} may return {@code false} regardless of the actual
* condition.
*/
CAPABILITY_ZERO_LENGTH_SEND(11),
+ /**
+ * Support for "unsafe" operations.
+ *
+ * Trading-in safety for speed or simplicity may be justified sometimes.
+ *
+ * @see Unsafe
+ * @see AFSocket#ensureUnsafeSupported()
+ */
+ CAPABILITY_UNSAFE(12),
+
+ /**
+ * Support for port numbers larger than 65535 (0xffff).
+ *
+ * Not all systems allow setting port numbers beyond the default TCP range (we use JNI tricks for
+ * that). This capability is required for RMI support.
+ */
+ CAPABILITY_LARGE_PORTS(13),
+
+ /**
+ * Support for certain Darwin (macOS Kernel)-specific features, such as the AF_SYSTEM domain.
+ */
+ CAPABILITY_DARWIN(14),
+
; // end of list
private final int bitmask;
diff --git a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketChannel.java b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketChannel.java
index 5c05353df..e825e11ff 100644
--- a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketChannel.java
+++ b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFSocketChannel.java
@@ -1,7 +1,7 @@
/*
* junixsocket
*
- * Copyright 2009-2022 Christian Kohlschütter
+ * Copyright 2009-2023 Christian Kohlschütter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -34,7 +34,7 @@
/**
* A selectable channel for stream-oriented connecting sockets.
- *
+ *
* @param The concrete {@link AFSocketAddress} that is supported by this type.
* @author Christian Kohlschütter
*/
@@ -45,11 +45,11 @@ public abstract class AFSocketChannel extends SocketC
/**
* Creates a new socket channel for the given socket, using the given {@link SelectorProvider}.
- *
+ *
* @param socket The socket.
* @param sp The {@link SelectorProvider}.
*/
- @SuppressWarnings("null")
+ @SuppressWarnings("all")
protected AFSocketChannel(AFSocket socket, AFSelectorProvider sp) {
super(sp);
this.afSocket = Objects.requireNonNull(socket);
@@ -57,7 +57,7 @@ protected AFSocketChannel(AFSocket socket, AFSelectorProvider sp) {
/**
* Returns the corresponding {@link AFSocket}.
- *
+ *
* @return The corresponding socket.
*/
protected final AFSocket getAFSocket() {
@@ -66,14 +66,14 @@ protected final AFSocket getAFSocket() {
/**
* A reference to a method that provides an {@link AFSocket} instance.
- *
+ *
* @param The concrete {@link AFSocketAddress} that is supported by this type.
*/
@FunctionalInterface
protected interface AFSocketSupplier {
/**
* Returns a new {@link AFSocket} instance.
- *
+ *
* @return The instance.
* @throws IOException on error.
*/
@@ -85,7 +85,7 @@ protected interface AFSocketSupplier {
*
* @param The concrete {@link AFSocketAddress} that is supported by this type.
* @param supplier The AFSocketChannel constructor.
- *
+ *
* @return The new channel
* @throws IOException on error.
*/
@@ -131,7 +131,7 @@ public final
*
AFSocketPair
newSocketPair(P s1, P s2) { - return new AFUNIXSocketPair
(s1, s2);
+ return new AFUNIXSocketPair<>(s1, s2);
}
@SuppressWarnings("unchecked")
@@ -122,6 +122,13 @@ public AFUNIXSocketPair
* Usage:
* bind.
- *
+ *
* @param forceAddr The address to use.
* @return The new, yet unbound {@link AFServerSocket}.
* @throws IOException if an exception occurs.
@@ -142,13 +142,13 @@ public static AFUNIXServerSocket forceBindOn(final AFUNIXSocketAddress forceAddr
}
@Override
- protected AFUNIXSocketImpl newImpl(FileDescriptor fdObj) throws SocketException {
+ protected AFSocketImpltrue iff {@link AFUNIXSocket}s are supported by the current Java VM.
- *
+ *
* To support {@link AFSocket}s, a custom JNI library must be loaded that is supplied with
* junixsocket, and the system must support AF_UNIX sockets.
- *
+ *
* This call is equivalent to checking {@link AFSocket#isSupported()} and
* {@link AFSocket#supports(AFSocketCapability)} with
* {@link AFSocketCapability#CAPABILITY_UNIX_DOMAIN}.
- *
+ *
* @return {@code true} iff supported.
*/
public static boolean isSupported() {
@@ -163,13 +169,14 @@ public static boolean isSupported() {
/**
* Very basic self-test function.
- *
+ *
* Prints "supported" and "capabilities" status to System.out.
- *
+ *
* @param args ignored.
*/
public static void main(String[] args) {
- // If you want to run this directly from within Eclipse, see AFUNIXSocketTest#testMain.
+ // If you want to run this directly from within Eclipse, see
+ // org.newsclub.net.unix.domain.SocketTest#testMain.
System.out.print(AFUNIXSocket.class.getName() + ".isSupported(): ");
System.out.flush();
System.out.println(AFUNIXSocket.isSupported());
@@ -179,5 +186,75 @@ public static void main(String[] args) {
System.out.flush();
System.out.println(AFSocket.supports(cap));
}
+ System.out.println();
+ if (AFSocket.supports(AFSocketCapability.CAPABILITY_UNIX_DOMAIN)) {
+ System.out.println("Starting mini selftest...");
+ miniSelftest();
+ } else {
+ System.out.println(
+ "Skipping mini selftest; AFSocketCapability.CAPABILITY_UNIX_DOMAIN is missing");
+ }
+ }
+
+ private static void miniSelftest() {
+ AtomicBoolean success = new AtomicBoolean(true);
+ try {
+ AFUNIXSocketAddress addr = AFUNIXSocketAddress.ofNewTempFile();
+ System.out.println("Using temporary address: " + addr);
+ try (AFUNIXServerSocket server = addr.newBoundServerSocket()) {
+ Thread t = new Thread(() -> {
+ try {
+ try (AFUNIXSocket client = server.accept()) {
+ System.out.println("Server accepted client connection");
+ try (SocketChannel chann = client.getChannel()) {
+ ByteBuffer bb = ByteBuffer.allocate(64).order(ByteOrder.BIG_ENDIAN);
+
+ int numRead = 0;
+ while (bb.position() != 4 && numRead != -1) {
+ numRead = chann.read(bb);
+ }
+ if (bb.position() != 4) {
+ throw new IOException("Unexpected number of bytes read: " + bb.position());
+ }
+ bb.flip();
+ int v;
+ if ((v = bb.getInt()) != 0xABCDEF12) {
+ throw new IOException("Received unexpected data from client: 0x" + Integer
+ .toHexString(v));
+ }
+ bb.clear();
+ bb.putLong(0x00112233456789L);
+ bb.flip();
+ chann.write(bb);
+ }
+ } finally {
+ server.close(); // NOPMD
+ }
+ } catch (Exception e) { // NOPMD
+ success.set(false);
+ e.printStackTrace();
+ }
+ });
+ t.start();
+
+ try (AFUNIXSocket socket = addr.newConnectedSocket();
+ DataInputStream in = new DataInputStream(socket.getInputStream());
+ DataOutputStream out = new DataOutputStream(socket.getOutputStream());) {
+ out.writeInt(0xABCDEF12);
+ out.flush();
+ long v = in.readLong();
+ if (v != 0x00112233456789L) {
+ throw new IOException("Received unexpected data from server: 0x" + Long.toHexString(v));
+ }
+ }
+ System.out.println("Data exchange succeeded");
+ }
+ } catch (Exception e) { // NOPMD
+ success.set(false);
+ e.printStackTrace();
+ return;
+ } finally {
+ System.out.println("mini selftest " + (success.get() ? "passed" : "failed"));
+ }
}
}
diff --git a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketAddress.java b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketAddress.java
index 4325b2a56..2babe6da8 100644
--- a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketAddress.java
+++ b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketAddress.java
@@ -1,7 +1,7 @@
/*
* junixsocket
*
- * Copyright 2009-2022 Christian Kohlschütter
+ * Copyright 2009-2023 Christian Kohlschütter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -40,15 +40,15 @@
/**
* Describes an {@link InetSocketAddress} that actually uses AF_UNIX sockets instead of AF_INET.
- *
+ *
* The ability to specify a port number is not specified by AF_UNIX sockets, but we need it
* sometimes, for example for RMI-over-AF_UNIX.
- *
+ *
* @author Christian Kohlschütter
*/
@SuppressWarnings("PMD.ShortMethodName")
public final class AFUNIXSocketAddress extends AFSocketAddress {
- private static final long serialVersionUID = 1L;
+ private static final long serialVersionUID = 1L; // do not change!
private static final Charset ADDRESS_CHARSET = Charset.defaultCharset();
@@ -57,6 +57,10 @@ public final class AFUNIXSocketAddress extends AFSocketAddress {
.registerAddressFamily("un", //
AFUNIXSocketAddress.class, new AFSocketAddressConfig[file:%3A%2F%2F(...)", i.e.
* encoded and without the closing bracket. Since this is an invalid hostname, it will not trigger
* a DNS lookup, but can still be used within a JDBC Connection URL.
diff --git a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketImpl.java b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketImpl.java
index 35934871b..b18342770 100644
--- a/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketImpl.java
+++ b/junixsocket-common/src/main/java/org/newsclub/net/unix/AFUNIXSocketImpl.java
@@ -1,7 +1,7 @@
/*
* junixsocket
*
- * Copyright 2009-2022 Christian Kohlschütter
+ * Copyright 2009-2023 Christian Kohlschütter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,18 +23,18 @@
import java.net.SocketException;
class AFUNIXSocketImpl extends AFSocketImpl
@@ -46,9 +48,10 @@
*
* FileDescriptor fd;
- *
+ *
* // succeeds if fd refers to an AF_UNIX stream socket
- * AFUNIXSocket socket = FileDescriptorCast.using(fd).as(AFUNIXSocket.class);
- *
+ * AFUNIXSocket socket = FileDescriptorCast.using(fd).as(AFUNIXSocket.class);
+ *
* // succeeds if fd refers to an AF_UNIX datagram socket
- * AFUNIXDatagramChannel channel = FileDescriptorCast.using(fd).as(AFUNIXDatagramChannel.class);
- *
+ * AFUNIXDatagramChannel channel = FileDescriptorCast.using(fd).as(AFUNIXDatagramChannel.class);
+ *
* // always succeeds
- * InputStream in = FileDescriptorCast.using(fd).as(InputStream.class);
- * OutputStream in = FileDescriptorCast.using(fd).as(OutputStream.class);
+ * InputStream in = FileDescriptorCast.using(fd).as(InputStream.class);
+ * OutputStream in = FileDescriptorCast.using(fd).as(OutputStream.class);
* * IMPORTANT: On some platforms (e.g., Solaris, Illumos) you may need to re-apply a read timeout @@ -66,19 +65,14 @@ * that do not encode this information directly (such as {@link AFUNIXSocketAddress} and * {@link AFTIPCSocketAddress}). *
- * + * * @author Christian Kohlschütter */ public final class FileDescriptorCast implements FileDescriptorAccess { private static final Map+ * This method is inherently unsafe as it may + *
+ * Note that attempts are made to reuse {@link FileDescriptor#in}, {@link FileDescriptor#out}, and
+ * {@link FileDescriptor#err}, respectively.
+ *
+ * @param fd The system-native file descriptor value.
+ * @return The {@link FileDescriptorCast} instance.
+ * @throws IOException on error, especially if the given file descriptor is invalid or
+ * unsupported, or when "unsafe" operations are unavailable or manually disabled for the
+ * current environment.
+ */
+ @Unsafe
+ public static FileDescriptorCast unsafeUsing(int fd) throws IOException {
+ AFSocket.ensureUnsafeSupported();
+
+ FileDescriptor fdObj;
+ if (fd == -1) {
+ throw new IOException("Not a valid file descriptor");
+ } else if (fd == FD_IN) {
+ fdObj = FileDescriptor.in;
+ } else if (fd == FD_OUT) {
+ fdObj = FileDescriptor.out;
+ } else if (fd == FD_ERR) {
+ fdObj = FileDescriptor.err;
+ } else {
+ fdObj = null;
+ }
+
+ if (fdObj != null) {
+ int check = getFdIfPossible(fdObj);
+ if (fd == check) {
+ return using(fdObj);
+ }
+ }
+
+ fdObj = new FileDescriptor();
+ NativeUnixSocket.initFD(fdObj, fd);
+
+ return using(fdObj);
+ }
+
private static void triggerInit() {
- AFUNIXSocketAddress.addressFamily().getClass(); // trigger registration
- AFTIPCSocketAddress.addressFamily().getClass(); // trigger registration
+ for (AFAddressFamily family : new AFAddressFamily[] {
+ AFUNIXSocketAddress.addressFamily(), //
+ AFTIPCSocketAddress.addressFamily(), //
+ AFVSOCKSocketAddress.addressFamily(), //
+ AFSYSTEMSocketAddress.addressFamily(), //
+ }) {
+ Objects.requireNonNull(family.getClass()); // trigger init
+ }
}
/**
* Registers the given port number as the "local port" for this file descriptor.
- *
+ *
* Important: This only changes the state of this instance. The actual file descriptor is not
* affected.
- *
+ *
* @param port The port to assign to (must be >= 0).
* @return This instance.
*/
@@ -315,10 +406,10 @@ public FileDescriptorCast withLocalPort(int port) {
/**
* Registers the given port number as the "remote port" for this file descriptor.
- *
+ *
* Important: This only changes the state of this instance. The actual file descriptor is not
* affected.
- *
+ *
* @param port The port to assign to (must be >= 0).
* @return This instance.
*/
@@ -332,7 +423,7 @@ public FileDescriptorCast withRemotePort(int port) {
/**
* Casts this instance to the desired type.
- *
+ *
* @param
+ * Methods annotated with this type should also call {@link AFSocket#ensureUnsafeSupported()} to
+ * check availability at runtime.
+ *
+ * NOTE: This annotation has nothing to do with {@code sun.misc.Unsafe}.
+ *
+ * @author Christian Kohlschütter
+ * @see AFSocket#ensureUnsafeSupported()
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface Unsafe {
+
+}
diff --git a/junixsocket-common/src/main/java15/org/newsclub/net/unix/SocketAddressUtil.java b/junixsocket-common/src/main/java15/org/newsclub/net/unix/SocketAddressUtil.java
new file mode 100644
index 000000000..a0b03965b
--- /dev/null
+++ b/junixsocket-common/src/main/java15/org/newsclub/net/unix/SocketAddressUtil.java
@@ -0,0 +1,42 @@
+/*
+ * junixsocket
+ *
+ * Copyright 2009-2023 Christian Kohlschütter
+ *
+ * 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 org.newsclub.net.unix;
+
+import java.net.SocketAddress;
+import java.net.SocketException;
+
+/**
+ * {@link SocketAddress}-related helper methods.
+ *
+ * @author Christian Kohlschütter
+ */
+final class SocketAddressUtil {
+ private SocketAddressUtil() {
+ throw new IllegalStateException("No instances");
+ }
+
+ /**
+ * Try to convert a {@link SocketAddress} that is not a {@link AFSocketAddress} to one that is.
+ *
+ * @param address The address.
+ * @return A supplier for the given address, or {@code null}.
+ */
+ static AFSupplier
*
*
@@ -82,8 +88,12 @@ public abstract class ThroughputTest extends SocketTest
"org.newsclub.net.unix.throughput-test.enabled", 1);
protected static final int PAYLOAD_SIZE = SystemPropertyUtil.getIntSystemProperty(
"org.newsclub.net.unix.throughput-test.payload-size", 2048); // 8192 is much faster
+ protected static final int PAYLOAD_SIZE_DATAGRAM = SystemPropertyUtil.getIntSystemProperty(
+ "org.newsclub.net.unix.throughput-test.payload-size.datagram", PAYLOAD_SIZE);
protected static final int NUM_SECONDS = SystemPropertyUtil.getIntSystemProperty(
"org.newsclub.net.unix.throughput-test.seconds", 0);
+ protected static final int GRACE_TIME_NUM_SECONDS = SystemPropertyUtil.getIntSystemProperty(
+ "org.newsclub.net.unix.throughput-test.gracetime.seconds", 5);
protected static final int NUM_MILLISECONDS = Math.max(50, NUM_SECONDS * 1000);
protected ThroughputTest(AddressSpecifics asp) {
@@ -111,7 +121,7 @@ public void testSocket() throws Exception {
assumeTrue(ENABLED > 0, "Throughput tests are disabled");
assumeTrue(PAYLOAD_SIZE > 0, "Payload must be positive");
- assertTimeoutPreemptively(Duration.ofSeconds(NUM_SECONDS + 5), () -> {
+ assertTimeoutPreemptively(Duration.ofSeconds(NUM_SECONDS + GRACE_TIME_NUM_SECONDS), () -> {
try (ServerThread serverThread = new ServerThread() {
@Override
protected void handleConnection(final Socket sock) throws IOException {
@@ -128,9 +138,10 @@ protected void handleConnection(final Socket sock) throws IOException {
}) {
AtomicBoolean keepRunning = new AtomicBoolean(true);
- Executors.newSingleThreadScheduledExecutor().schedule(() -> {
+
+ TestAsyncUtil.runAsyncDelayed(NUM_MILLISECONDS, TimeUnit.MILLISECONDS, () -> {
keepRunning.set(false);
- }, NUM_MILLISECONDS, TimeUnit.MILLISECONDS);
+ });
try (Socket sock = connectTo(serverThread.getServerAddress())) {
byte[] buf = createTestData(PAYLOAD_SIZE);
@@ -177,7 +188,7 @@ protected void handleConnection(final Socket sock) throws IOException {
public void testSocketChannel() throws Exception {
assumeTrue(ENABLED > 0, "Throughput tests are disabled");
assumeTrue(PAYLOAD_SIZE > 0, "Payload must be positive");
- assertTimeoutPreemptively(Duration.ofSeconds(NUM_SECONDS + 5), () -> {
+ assertTimeoutPreemptively(Duration.ofSeconds(NUM_SECONDS + GRACE_TIME_NUM_SECONDS), () -> {
runtestSocketChannel(false);
});
}
@@ -186,7 +197,7 @@ public void testSocketChannel() throws Exception {
public void testSocketChannelDirectBuffer() throws Exception {
assumeTrue(ENABLED > 0, "Throughput tests are disabled");
assumeTrue(PAYLOAD_SIZE > 0, "Payload must be positive");
- assertTimeoutPreemptively(Duration.ofSeconds(NUM_SECONDS + 5), () -> {
+ assertTimeoutPreemptively(Duration.ofSeconds(NUM_SECONDS + GRACE_TIME_NUM_SECONDS), () -> {
runtestSocketChannel(true);
});
}
@@ -216,7 +227,7 @@ protected void runTestSocketChannel(String implId, SocketAddress sba, ServerSock
SupplierWithExceptionorg.newsclub.net.unix.throughput-test.enabled (0/1, default: 1)org.newsclub.net.unix.throughput-test.payload-size (bytes, e.g., 8192)org.newsclub.net.unix.throughput-test.payload-size.datagram (bytes, e.g., 2048;
+ * defaults to value specified with "payload-size" above)org.newsclub.net.unix.throughput-test.seconds (default: 0)