8263898: (fs) Files.newOutputStream on the "NUL" special device throws FileSystemException: "nul: Incorrect function" (win)

Reviewed-by: jpai, alanb

Author: Brian Burkhalter

src/java.base/windows/classes/sun/nio/fs/WindowsChannelFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2021, 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
@@ -328,8 +328,11 @@ private static FileDescriptor open(String pathForWindows,
             try {
                 SetEndOfFile(handle);
             } catch (WindowsException x) {
-                CloseHandle(handle);
-                throw x;
+                // ignore exception if file size is zero
+                if (GetFileSizeEx(handle) != 0) {
+                    CloseHandle(handle);
+                    throw x;
+                }
             }
         }
 

src/java.base/windows/classes/sun/nio/fs/WindowsNativeDispatcher.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2021, 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
@@ -172,6 +172,16 @@ static native void DeviceIoControlSetSparse(long handle)
     static native void DeviceIoControlGetReparsePoint(long handle,
         long bufferAddress, int bufferSize) throws WindowsException;
 
+    /**
+     * Retrieves the size of the specified file.
+     *
+     * BOOL GetFileSizeEx(
+     *   HANDLE hFile,
+     *   PLARGE_INTEGER lpFileSize
+     * )
+     */
+    static native long GetFileSizeEx(long handle) throws WindowsException;
+
     /**
      * HANDLE FindFirstFile(
      *   LPCTSTR lpFileName,

src/java.base/windows/native/libnio/fs/WindowsNativeDispatcher.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2021, 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
@@ -309,6 +309,18 @@ Java_sun_nio_fs_WindowsNativeDispatcher_CloseHandle(JNIEnv* env, jclass this,
     CloseHandle(h);
 }
 
+JNIEXPORT jlong JNICALL
+Java_sun_nio_fs_WindowsNativeDispatcher_GetFileSizeEx(JNIEnv *env,
+    jclass this, jlong handle)
+{
+    HANDLE h = (HANDLE)jlong_to_ptr(handle);
+    LARGE_INTEGER size;
+    if (GetFileSizeEx(h, &size) == 0) {
+        throwWindowsException(env, GetLastError());
+    }
+    return long_to_jlong(size.QuadPart);
+}
+
 JNIEXPORT void JNICALL
 Java_sun_nio_fs_WindowsNativeDispatcher_FindFirstFile0(JNIEnv* env, jclass this,
     jlong address, jobject obj)

test/jdk/java/nio/file/Files/NulDevice.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2021, 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.
+ *
+ * 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.
+ */
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+import java.nio.channels.AsynchronousFileChannel;
+import java.nio.channels.FileChannel;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import static java.nio.file.StandardOpenOption.*;
+import java.util.concurrent.ExecutionException;
+
+/* @test
+ * @bug 8263898
+ * @summary Verify stream and channel behavior with NUL device
+ * @requires os.family == "windows"
+ * @run main NulDevice
+*/
+public class NulDevice {
+    public static void main(String[] args)
+        throws ExecutionException, InterruptedException, IOException {
+        Path path = Path.of("nul");
+
+        try (OutputStream os = Files.newOutputStream(path)) {
+            os.write(0x02);
+            try (InputStream is = Files.newInputStream(path);) {
+                if (is.available() != 0) {
+                    throw new RuntimeException("No bytes should be available");
+                }
+                int aByte = is.read();
+                if (aByte != -1) {
+                    throw new RuntimeException("Should only read -1 from NUL");
+                }
+            }
+        }
+
+        try (OutputStream os = Files.newOutputStream(path, WRITE)) {
+            os.write(0x02);
+        }
+
+        try (FileChannel ch = FileChannel.open(path, CREATE, TRUNCATE_EXISTING, WRITE)) {
+            byte[] bytes = "Whatever".getBytes();
+            ByteBuffer buf = ByteBuffer.allocate(2*bytes.length);
+            buf.put(bytes);
+            int nw = ch.write(buf);
+            if (nw != bytes.length) {
+                throw new RuntimeException("Should write " + bytes.length +
+                    " to NUL");
+            }
+        }
+
+        try (FileChannel ch = FileChannel.open(path, READ)) {
+            if (ch.size() != 0) {
+                throw new RuntimeException("Size should be zero");
+            }
+            ByteBuffer buf = ByteBuffer.allocate(10);
+            int nr = ch.read(buf);
+            if (nr != -1) {
+                throw new RuntimeException("Read returns " + nr + " not -1");
+            }
+        }
+
+        try (AsynchronousFileChannel ch = AsynchronousFileChannel.open(path, READ, WRITE)) {
+            if (ch.size() != 0) {
+                throw new RuntimeException("Size should be zero");
+            }
+            int nw = ch.write(ByteBuffer.wrap(new byte[] {(byte)0x02}), 0L).get();
+            if (nw != 1) {
+                throw new RuntimeException("Wrote " + nw + " bytes, not one");
+            }
+            ByteBuffer buf = ByteBuffer.allocate(10);
+            int nr = ch.read(buf, 0L).get();
+            if (nr != -1) {
+                throw new RuntimeException("Read returns " + nr + " not -1");
+            }
+        }
+    }
+}