archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-26 22:34:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8189330: Cleanup FileDescriptor implementation

Browse source 
Reviewed-by: bpb
This commit is contained in:
Roger Riggs 2018-02-23 14:26:29 -05:00
parent b2ed2bda60
commit cfe9ad4608
12 changed files with 245 additions and 516 deletions
Download patch file Download diff file Expand all files Collapse all files

116
src/java.base/share/classes/java/io/FileCleanable.java Normal file
View file

@ -0,0 +1,116 @@
/*
* Copyright (c) 2018, 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 java.io;
import jdk.internal.misc.JavaIOFileDescriptorAccess;
import jdk.internal.misc.SharedSecrets;
import jdk.internal.ref.CleanerFactory;
import jdk.internal.ref.PhantomCleanable;
import java.lang.ref.Cleaner;
/**
* Cleanable for a FileDescriptor when it becomes phantom reachable.
* For regular fds on Unix and regular handles on Windows
* register a cleanup if fd != -1 or handle != -1.
* <p>
* Subclassed from {@code PhantomCleanable} so that {@code clear} can be
* called to disable the cleanup when the handle is closed by any means other
* than calling {@link FileDescriptor#close}.
* Otherwise, it might incorrectly close the handle after it has been reused.
*/
final class FileCleanable extends PhantomCleanable<FileDescriptor> {
// Access to FileDescriptor private fields;
// avoids making fd and handle package private
private static final JavaIOFileDescriptorAccess fdAccess =
SharedSecrets.getJavaIOFileDescriptorAccess();
/*
* Raw close of the file fd and/or handle.
* Used only for last chance cleanup.
*/
private static native void cleanupClose0(int fd, long handle) throws IOException;
// The raw fd to close
private final int fd;
// The handle to close
private final long handle;
/**
* Register a Cleanable with the FileDescriptor
* if the FileDescriptor is non-null and valid.
* @implNote
* A exception (OutOfMemoryException) will leave the FileDescriptor
* having allocated resources and leak the fd/handle.
*
* @param fdo the FileDescriptor; may be null
*/
static void register(FileDescriptor fdo) {
if (fdo != null && fdo.valid()) {
int fd = fdAccess.get(fdo);
long handle = fdAccess.getHandle(fdo);
fdo.registerCleanup(new FileCleanable(fdo, CleanerFactory.cleaner(), fd, handle));
}
}
/**
* Unregister a Cleanable from the FileDescriptor.
* @param fdo the FileDescriptor; may be null
*/
static void unregister(FileDescriptor fdo) {
if (fdo != null) {
fdo.unregisterCleanup();
}
}
/**
* Constructor for a phantom cleanable reference.
*
* @param obj the object to monitor
* @param cleaner the cleaner
* @param fd file descriptor to close
* @param handle handle to close
*/
private FileCleanable(FileDescriptor obj, Cleaner cleaner, int fd, long handle) {
super(obj, cleaner);
this.fd = fd;
this.handle = handle;
}
/**
* Close the native handle or fd.
*/
@Override
protected void performCleanup() {
try {
cleanupClose0(fd, handle);
} catch (IOException ioe) {
throw new UncheckedIOException("close", ioe);
}
}
}

369
src/java.base/share/classes/java/io/FileDescriptor.java Normal file
View file

@ -0,0 +1,369 @@
/*
* Copyright (c) 2003, 2018, 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 java.io;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import jdk.internal.misc.JavaIOFileDescriptorAccess;
import jdk.internal.misc.SharedSecrets;
import jdk.internal.ref.PhantomCleanable;
/**
* Instances of the file descriptor class serve as an opaque handle
* to the underlying machine-specific structure representing an open
* file, an open socket, or another source or sink of bytes.
* The main practical use for a file descriptor is to create a
* {@link FileInputStream} or {@link FileOutputStream} to contain it.
* <p>
* Applications should not create their own file descriptors.
*
* @author Pavani Diwanji
* @since 1.0
*/
public final class FileDescriptor {
private int fd;
private long handle;
private Closeable parent;
private List<Closeable> otherParents;
private boolean closed;
/**
* true, if file is opened for appending.
*/
private boolean append;
static {
initIDs();
}
// Set up JavaIOFileDescriptorAccess in SharedSecrets
static {
SharedSecrets.setJavaIOFileDescriptorAccess(
new JavaIOFileDescriptorAccess() {
public void set(FileDescriptor fdo, int fd) {
fdo.set(fd);
}
public int get(FileDescriptor fdo) {
return fdo.fd;
}
public void setAppend(FileDescriptor fdo, boolean append) {
fdo.append = append;
}
public boolean getAppend(FileDescriptor fdo) {
return fdo.append;
}
public void close(FileDescriptor fdo) throws IOException {
fdo.close();
}
/* Register for a normal FileCleanable fd/handle cleanup. */
public void registerCleanup(FileDescriptor fdo) {
FileCleanable.register(fdo);
}
/* Register a custom PhantomCleanup. */
public void registerCleanup(FileDescriptor fdo,
PhantomCleanable<FileDescriptor> cleanup) {
fdo.registerCleanup(cleanup);
}
public void unregisterCleanup(FileDescriptor fdo) {
fdo.unregisterCleanup();
}
public void setHandle(FileDescriptor fdo, long handle) {
fdo.setHandle(handle);
}
public long getHandle(FileDescriptor fdo) {
return fdo.handle;
}
}
);
}
/**
* Cleanup in case FileDescriptor is not explicitly closed.
*/
private PhantomCleanable<FileDescriptor> cleanup;
/**
* Constructs an (invalid) FileDescriptor object.
* The fd or handle is set later.
*/
public FileDescriptor() {
fd = -1;
handle = -1;
}
/**
* Used for standard input, output, and error only.
* For Windows the corresponding handle is initialized.
* For Unix the append mode is cached.
* @param fd the raw fd number (0, 1, 2)
*/
private FileDescriptor(int fd) {
this.fd = fd;
this.handle = getHandle(fd);
this.append = getAppend(fd);
}
/**
* A handle to the standard input stream. Usually, this file
* descriptor is not used directly, but rather via the input stream
* known as {@code System.in}.
*
* @see java.lang.System#in
*/
public static final FileDescriptor in = new FileDescriptor(0);
/**
* A handle to the standard output stream. Usually, this file
* descriptor is not used directly, but rather via the output stream
* known as {@code System.out}.
* @see java.lang.System#out
*/
public static final FileDescriptor out = new FileDescriptor(1);
/**
* A handle to the standard error stream. Usually, this file
* descriptor is not used directly, but rather via the output stream
* known as {@code System.err}.
*
* @see java.lang.System#err
*/
public static final FileDescriptor err = new FileDescriptor(2);
/**
* Tests if this file descriptor object is valid.
*
* @return {@code true} if the file descriptor object represents a
* valid, open file, socket, or other active I/O connection;
* {@code false} otherwise.
*/
public boolean valid() {
return (handle != -1) || (fd != -1);
}
/**
* Force all system buffers to synchronize with the underlying
* device. This method returns after all modified data and
* attributes of this FileDescriptor have been written to the
* relevant device(s). In particular, if this FileDescriptor
* refers to a physical storage medium, such as a file in a file
* system, sync will not return until all in-memory modified copies
* of buffers associated with this FileDescriptor have been
* written to the physical medium.
*
* sync is meant to be used by code that requires physical
* storage (such as a file) to be in a known state For
* example, a class that provided a simple transaction facility
* might use sync to ensure that all changes to a file caused
* by a given transaction were recorded on a storage medium.
*
* sync only affects buffers downstream of this FileDescriptor. If
* any in-memory buffering is being done by the application (for
* example, by a BufferedOutputStream object), those buffers must
* be flushed into the FileDescriptor (for example, by invoking
* OutputStream.flush) before that data will be affected by sync.
*
* @exception SyncFailedException
* Thrown when the buffers cannot be flushed,
* or because the system cannot guarantee that all the
* buffers have been synchronized with physical media.
* @since 1.1
*/
public native void sync() throws SyncFailedException;
/* This routine initializes JNI field offsets for the class */
private static native void initIDs();
/*
* On Windows return the handle for the standard streams.
*/
private static native long getHandle(int d);
/**
* Returns true, if the file was opened for appending.
*/
private static native boolean getAppend(int fd);
/**
* Set the fd.
* Used on Unix and for sockets on Windows and Unix.
* If setting to -1, clear the cleaner.
* The {@link #registerCleanup} method should be called for new fds.
* @param fd the raw fd or -1 to indicate closed
*/
@SuppressWarnings("unchecked")
synchronized void set(int fd) {
if (fd == -1 && cleanup != null) {
cleanup.clear();
cleanup = null;
}
this.fd = fd;
}
/**
* Set the handle.
* Used on Windows for regular files.
* If setting to -1, clear the cleaner.
* The {@link #registerCleanup} method should be called for new handles.
* @param handle the handle or -1 to indicate closed
*/
@SuppressWarnings("unchecked")
void setHandle(long handle) {
if (handle == -1 && cleanup != null) {
cleanup.clear();
cleanup = null;
}
this.handle = handle;
}
/**
* Register a cleanup for the current handle.
* Used directly in java.io and indirectly via fdAccess.
* The cleanup should be registered after the handle is set in the FileDescriptor.
* @param cleanable a PhantomCleanable to register
*/
@SuppressWarnings("unchecked")
synchronized void registerCleanup(PhantomCleanable<FileDescriptor> cleanable) {
Objects.requireNonNull(cleanable, "cleanable");
if (cleanup != null) {
cleanup.clear();
}
cleanup = cleanable;
}
/**
* Unregister a cleanup for the current raw fd or handle.
* Used directly in java.io and indirectly via fdAccess.
* Normally {@link #close()} should be used except in cases where
* it is certain the caller will close the raw fd and the cleanup
* must not close the raw fd. {@link #unregisterCleanup()} must be
* called before the raw fd is closed to prevent a race that makes
* it possible for the fd to be reallocated to another use and later
* the cleanup might be invoked.
*/
synchronized void unregisterCleanup() {
if (cleanup != null) {
cleanup.clear();
}
cleanup = null;
}
/**
* Close the raw file descriptor or handle, if it has not already been closed.
* The native code sets the fd and handle to -1.
* Clear the cleaner so the close does not happen twice.
* Package private to allow it to be used in java.io.
* @throws IOException if close fails
*/
@SuppressWarnings("unchecked")
synchronized void close() throws IOException {
unregisterCleanup();
close0();
}
/*
* Close the raw file descriptor or handle, if it has not already been closed
* and set the fd and handle to -1.
*/
private native void close0() throws IOException;
/*
* Package private methods to track referents.
* If multiple streams point to the same FileDescriptor, we cycle
* through the list of all referents and call close()
*/
/**
* Attach a Closeable to this FD for tracking.
* parent reference is added to otherParents when
* needed to make closeAll simpler.
*/
synchronized void attach(Closeable c) {
if (parent == null) {
// first caller gets to do this
parent = c;
} else if (otherParents == null) {
otherParents = new ArrayList<>();
otherParents.add(parent);
otherParents.add(c);
} else {
otherParents.add(c);
}
}
/**
* Cycle through all Closeables sharing this FD and call
* close() on each one.
*
* The caller closeable gets to call close0().
*/
@SuppressWarnings("try")
synchronized void closeAll(Closeable releaser) throws IOException {
if (!closed) {
closed = true;
IOException ioe = null;
try (releaser) {
if (otherParents != null) {
for (Closeable referent : otherParents) {
try {
referent.close();
} catch(IOException x) {
if (ioe == null) {
ioe = x;
} else {
ioe.addSuppressed(x);
}
}
}
}
} catch(IOException ex) {
/*
* If releaser close() throws IOException
* add other exceptions as suppressed.
*/
if (ioe != null)
ex.addSuppressed(ioe);
ioe = ex;
} finally {
if (ioe != null)
throw ioe;
}
}
}
}

3
src/java.base/share/classes/java/io/FileInputStream.java
View file

@ -25,7 +25,6 @@
package java.io;
import java.lang.reflect.Method;
import java.nio.channels.FileChannel;
import sun.nio.ch.FileChannelImpl;
@ -158,7 +157,7 @@ class FileInputStream extends InputStream
open(name);
altFinalizer = AltFinalizer.get(this);
if (altFinalizer == null) {
fd.registerCleanup(); // open set the fd, register the cleanup
FileCleanable.register(fd); // open set the fd, register the cleanup
}
}

3
src/java.base/share/classes/java/io/FileOutputStream.java
View file

@ -25,7 +25,6 @@
package java.io;
import java.lang.reflect.Method;
import java.nio.channels.FileChannel;
import jdk.internal.misc.SharedSecrets;
import jdk.internal.misc.JavaIOFileDescriptorAccess;
@ -238,7 +237,7 @@ class FileOutputStream extends OutputStream
open(name, append);
altFinalizer = AltFinalizer.get(this);
if (altFinalizer == null) {
fd.registerCleanup(); // open set the fd, register the cleanup
FileCleanable.register(fd); // open sets the fd, register the cleanup
}
}

2
src/java.base/share/classes/java/io/RandomAccessFile.java
View file

@ -257,7 +257,7 @@ public class RandomAccessFile implements DataOutput, DataInput, Closeable {
fd.attach(this);
path = name;
open(name, imode);
fd.registerCleanup(); // open sets the fd, register the cleanup
FileCleanable.register(fd); // open sets the fd, register the cleanup
}
/**

19
src/java.base/share/classes/java/net/SocketCleanable.java
View file

@ -36,20 +36,21 @@ import java.lang.ref.Cleaner;
/**
* Cleanup for a socket/datagramsocket FileDescriptor when it becomes phantom reachable.
* Cleanable for a socket/datagramsocket FileDescriptor when it becomes phantom reachable.
* Create a cleanup if the raw fd != -1. Windows closes sockets using the fd.
* Subclassed from {@code PhantomCleanable} so that {@code clear} can be
* called to disable the cleanup when the socket fd is closed by any means
* other than calling {@link FileDescriptor#close}.
* Otherwise, it would incorrectly close the handle or fd after it has been reused.
* Otherwise, it might incorrectly close the handle or fd after it has been reused.
*/
final class SocketCleanable extends PhantomCleanable<Object> {
final class SocketCleanable extends PhantomCleanable<FileDescriptor> {
// Access to FileDescriptor internals
// Access to FileDescriptor private fields
private static final JavaIOFileDescriptorAccess fdAccess =
SharedSecrets.getJavaIOFileDescriptorAccess();
// Native function to call NET_SocketClose(fd)
// Used only for last chance cleanup.
private static native void cleanupClose0(int fd) throws IOException;
// The raw fd to close
@ -62,12 +63,10 @@ final class SocketCleanable extends PhantomCleanable<Object> {
* @param fdo the FileDescriptor; may be null
*/
static void register(FileDescriptor fdo) {
if (fdo != null) {
if (fdo != null && fdo.valid()) {
int fd = fdAccess.get(fdo);
if (fd != -1) {
fdAccess.registerCleanup(fdo,
new SocketCleanable(fdo, CleanerFactory.cleaner(), fd));
}
fdAccess.registerCleanup(fdo,
new SocketCleanable(fdo, CleanerFactory.cleaner(), fd));
}
}
@ -88,7 +87,7 @@ final class SocketCleanable extends PhantomCleanable<Object> {
* @param cleaner the cleaner
* @param fd file descriptor to close
*/
private SocketCleanable(Object obj, Cleaner cleaner, int fd) {
private SocketCleanable(FileDescriptor obj, Cleaner cleaner, int fd) {
super(obj, cleaner);
this.fd = fd;
}