|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * This code is free software; you can redistribute it and/or modify it |
| 6 | + * under the terms of the GNU General Public License version 2 only, as |
| 7 | + * published by the Free Software Foundation. |
| 8 | + * |
| 9 | + * This code is distributed in the hope that it will be useful, but WITHOUT |
| 10 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 11 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 12 | + * version 2 for more details (a copy is included in the LICENSE file that |
| 13 | + * accompanied this code). |
| 14 | + * |
| 15 | + * You should have received a copy of the GNU General Public License version |
| 16 | + * 2 along with this work; if not, write to the Free Software Foundation, |
| 17 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 18 | + * |
| 19 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 20 | + * or visit www.oracle.com if you need additional information or have any |
| 21 | + * questions. |
| 22 | + */ |
| 23 | + |
| 24 | +/* |
| 25 | + * @test |
| 26 | + * @bug 8358764 |
| 27 | + * @summary Test closing a socket while a thread is blocked in read. The connection |
| 28 | + * should be closed gracefuly so that the peer reads EOF. |
| 29 | + * @run junit PeerReadsAfterAsyncClose |
| 30 | + */ |
| 31 | + |
| 32 | +import java.io.IOException; |
| 33 | +import java.net.InetAddress; |
| 34 | +import java.net.InetSocketAddress; |
| 35 | +import java.net.ServerSocket; |
| 36 | +import java.net.Socket; |
| 37 | +import java.net.SocketException; |
| 38 | +import java.nio.ByteBuffer; |
| 39 | +import java.nio.channels.ClosedChannelException; |
| 40 | +import java.nio.channels.SocketChannel; |
| 41 | +import java.util.Arrays; |
| 42 | +import java.util.Objects; |
| 43 | +import java.util.concurrent.Executors; |
| 44 | +import java.util.concurrent.ThreadFactory; |
| 45 | +import java.util.concurrent.atomic.AtomicBoolean; |
| 46 | +import java.util.stream.Stream; |
| 47 | + |
| 48 | +import org.junit.jupiter.params.ParameterizedTest; |
| 49 | +import org.junit.jupiter.params.provider.MethodSource; |
| 50 | +import static org.junit.jupiter.api.Assertions.*; |
| 51 | + |
| 52 | +class PeerReadsAfterAsyncClose { |
| 53 | + |
| 54 | + static Stream<ThreadFactory> factories() { |
| 55 | + return Stream.of(Executors.defaultThreadFactory()); |
| 56 | + } |
| 57 | + |
| 58 | + /** |
| 59 | + * Close SocketChannel while a thread is blocked reading from the channel's socket. |
| 60 | + */ |
| 61 | + @ParameterizedTest |
| 62 | + @MethodSource("factories") |
| 63 | + void testCloseDuringSocketChannelRead(ThreadFactory factory) throws Exception { |
| 64 | + var loopback = InetAddress.getLoopbackAddress(); |
| 65 | + try (var listener = new ServerSocket()) { |
| 66 | + listener.bind(new InetSocketAddress(loopback, 0)); |
| 67 | + |
| 68 | + try (SocketChannel sc = SocketChannel.open(listener.getLocalSocketAddress()); |
| 69 | + Socket peer = listener.accept()) { |
| 70 | + |
| 71 | + // start thread to read from channel |
| 72 | + var cceThrown = new AtomicBoolean(); |
| 73 | + Thread thread = factory.newThread(() -> { |
| 74 | + try { |
| 75 | + sc.read(ByteBuffer.allocate(1)); |
| 76 | + fail(); |
| 77 | + } catch (ClosedChannelException e) { |
| 78 | + cceThrown.set(true); |
| 79 | + } catch (Throwable e) { |
| 80 | + e.printStackTrace(); |
| 81 | + } |
| 82 | + }); |
| 83 | + thread.start(); |
| 84 | + try { |
| 85 | + // close SocketChannel when thread sampled in read() |
| 86 | + onReach(thread, "sun.nio.ch.SocketChannelImpl.read", () -> { |
| 87 | + try { |
| 88 | + sc.close(); |
| 89 | + } catch (IOException ignore) { } |
| 90 | + }); |
| 91 | + |
| 92 | + // peer should read EOF |
| 93 | + int n = peer.getInputStream().read(); |
| 94 | + assertEquals(-1, n); |
| 95 | + } finally { |
| 96 | + thread.join(); |
| 97 | + } |
| 98 | + assertEquals(true, cceThrown.get(), "ClosedChannelException not thrown"); |
| 99 | + } |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + /** |
| 104 | + * Close Socket while a thread is blocked reading from the socket. |
| 105 | + */ |
| 106 | + @ParameterizedTest |
| 107 | + @MethodSource("factories") |
| 108 | + void testCloseDuringSocketUntimedRead(ThreadFactory factory) throws Exception { |
| 109 | + testCloseDuringSocketRead(factory, 0); |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * Close Socket while a thread is blocked reading from the socket with a timeout. |
| 114 | + */ |
| 115 | + @ParameterizedTest |
| 116 | + @MethodSource("factories") |
| 117 | + void testCloseDuringSockeTimedRead(ThreadFactory factory) throws Exception { |
| 118 | + testCloseDuringSocketRead(factory, 60_000); |
| 119 | + } |
| 120 | + |
| 121 | + private void testCloseDuringSocketRead(ThreadFactory factory, int timeout) throws Exception { |
| 122 | + var loopback = InetAddress.getLoopbackAddress(); |
| 123 | + try (var listener = new ServerSocket()) { |
| 124 | + listener.bind(new InetSocketAddress(loopback, 0)); |
| 125 | + |
| 126 | + try (Socket s = new Socket(loopback, listener.getLocalPort()); |
| 127 | + Socket peer = listener.accept()) { |
| 128 | + |
| 129 | + // start thread to read from socket |
| 130 | + var seThrown = new AtomicBoolean(); |
| 131 | + Thread thread = factory.newThread(() -> { |
| 132 | + try { |
| 133 | + s.setSoTimeout(timeout); |
| 134 | + s.getInputStream().read(); |
| 135 | + fail(); |
| 136 | + } catch (SocketException e) { |
| 137 | + seThrown.set(true); |
| 138 | + } catch (Throwable e) { |
| 139 | + e.printStackTrace(); |
| 140 | + } |
| 141 | + }); |
| 142 | + thread.start(); |
| 143 | + try { |
| 144 | + // close Socket when thread sampled in implRead |
| 145 | + onReach(thread, "sun.nio.ch.NioSocketImpl.implRead", () -> { |
| 146 | + try { |
| 147 | + s.close(); |
| 148 | + } catch (IOException ignore) { } |
| 149 | + }); |
| 150 | + |
| 151 | + // peer should read EOF |
| 152 | + int n = peer.getInputStream().read(); |
| 153 | + assertEquals(-1, n); |
| 154 | + } finally { |
| 155 | + thread.join(); |
| 156 | + } |
| 157 | + assertEquals(true, seThrown.get(), "SocketException not thrown"); |
| 158 | + } |
| 159 | + } |
| 160 | + } |
| 161 | + |
| 162 | + /** |
| 163 | + * Runs the given action when the given target thread is sampled at the given |
| 164 | + * location. The location takes the form "{@code c.m}" where |
| 165 | + * {@code c} is the fully qualified class name and {@code m} is the method name. |
| 166 | + */ |
| 167 | + private void onReach(Thread target, String location, Runnable action) { |
| 168 | + int index = location.lastIndexOf('.'); |
| 169 | + String className = location.substring(0, index); |
| 170 | + String methodName = location.substring(index + 1); |
| 171 | + Thread tDaemon = new Thread(() -> { |
| 172 | + try { |
| 173 | + boolean found = false; |
| 174 | + while (!found) { |
| 175 | + found = contains(target.getStackTrace(), className, methodName); |
| 176 | + if (!found) { |
| 177 | + Thread.sleep(20); |
| 178 | + } |
| 179 | + } |
| 180 | + action.run(); |
| 181 | + } catch (Exception e) { |
| 182 | + e.printStackTrace(); |
| 183 | + } |
| 184 | + }); |
| 185 | + tDaemon.setDaemon(true); |
| 186 | + tDaemon.start(); |
| 187 | + } |
| 188 | + |
| 189 | + /** |
| 190 | + * Returns true if the given stack trace contains an element for the given class |
| 191 | + * and method name. |
| 192 | + */ |
| 193 | + private boolean contains(StackTraceElement[] stack, String className, String methodName) { |
| 194 | + return Arrays.stream(stack) |
| 195 | + .anyMatch(e -> className.equals(e.getClassName()) |
| 196 | + && methodName.equals(e.getMethodName())); |
| 197 | + } |
| 198 | +} |
0 commit comments