File: PeerReadsAfterAsyncClose.java

package info (click to toggle)
openjdk-25 25.0.1%2B8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 825,408 kB
  • sloc: java: 5,585,680; cpp: 1,333,948; xml: 1,321,242; ansic: 488,034; asm: 404,003; objc: 21,088; sh: 15,106; javascript: 13,265; python: 8,319; makefile: 2,518; perl: 357; awk: 351; pascal: 103; exp: 83; sed: 72; jsp: 24
file content (195 lines) | stat: -rw-r--r-- 7,426 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/*
 * Copyright (c) 2025, 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.
 */

/*
 * @test
 * @bug 8358764
 * @summary Test closing a socket while a thread is blocked in read. The connection
 *     should be closed gracefuly so that the peer reads EOF.
 * @run junit PeerReadsAfterAsyncClose
 */

import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketException;
import java.nio.ByteBuffer;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.SocketChannel;
import java.util.Arrays;
import java.util.Objects;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.stream.Stream;

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import static org.junit.jupiter.api.Assertions.*;

class PeerReadsAfterAsyncClose {

    static Stream<ThreadFactory> factories() {
        return Stream.of(Thread.ofPlatform().factory(), Thread.ofVirtual().factory());
    }

    /**
     * Close SocketChannel while a thread is blocked reading from the channel's socket.
     */
    @ParameterizedTest
    @MethodSource("factories")
    void testCloseDuringSocketChannelRead(ThreadFactory factory) throws Exception {
        var loopback = InetAddress.getLoopbackAddress();
        try (var listener = new ServerSocket()) {
            listener.bind(new InetSocketAddress(loopback, 0));

            try (SocketChannel sc = SocketChannel.open(listener.getLocalSocketAddress());
                 Socket peer = listener.accept()) {

                // start thread to read from channel
                var cceThrown = new AtomicBoolean();
                Thread thread = factory.newThread(() -> {
                    try {
                        sc.read(ByteBuffer.allocate(1));
                        fail();
                    } catch (ClosedChannelException e) {
                        cceThrown.set(true);
                    } catch (Throwable e) {
                        e.printStackTrace();
                    }
                });
                thread.start();
                try {
                    // close SocketChannel when thread sampled in implRead
                    onReach(thread, "sun.nio.ch.SocketChannelImpl.implRead", () -> {
                        try {
                            sc.close();
                        } catch (IOException ignore) { }
                    });

                    // peer should read EOF
                    int n = peer.getInputStream().read();
                    assertEquals(-1, n);
                } finally {
                    thread.join();
                }
                assertEquals(true, cceThrown.get(), "ClosedChannelException not thrown");
            }
        }
    }

    /**
     * Close Socket while a thread is blocked reading from the socket.
     */
    @ParameterizedTest
    @MethodSource("factories")
    void testCloseDuringSocketUntimedRead(ThreadFactory factory) throws Exception {
        testCloseDuringSocketRead(factory, 0);
    }

    /**
     * Close Socket while a thread is blocked reading from the socket with a timeout.
     */
    @ParameterizedTest
    @MethodSource("factories")
    void testCloseDuringSockeTimedRead(ThreadFactory factory) throws Exception {
        testCloseDuringSocketRead(factory, 60_000);
    }

    private void testCloseDuringSocketRead(ThreadFactory factory, int timeout) throws Exception {
        var loopback = InetAddress.getLoopbackAddress();
        try (var listener = new ServerSocket()) {
            listener.bind(new InetSocketAddress(loopback, 0));

            try (Socket s = new Socket(loopback, listener.getLocalPort());
                 Socket peer = listener.accept()) {

                // start thread to read from socket
                var seThrown = new AtomicBoolean();
                Thread thread = factory.newThread(() -> {
                    try {
                        s.setSoTimeout(timeout);
                        s.getInputStream().read();
                        fail();
                    } catch (SocketException e) {
                        seThrown.set(true);
                    } catch (Throwable e) {
                        e.printStackTrace();
                    }
                });
                thread.start();
                try {
                    // close Socket when thread sampled in implRead
                    onReach(thread, "sun.nio.ch.NioSocketImpl.implRead", () -> {
                        try {
                            s.close();
                        } catch (IOException ignore) { }
                    });

                    // peer should read EOF
                    int n = peer.getInputStream().read();
                    assertEquals(-1, n);
                } finally {
                    thread.join();
                }
                assertEquals(true, seThrown.get(), "SocketException not thrown");
            }
        }
    }

    /**
     * Runs the given action when the given target thread is sampled at the given
     * location. The location takes the form "{@code c.m}" where
     * {@code c} is the fully qualified class name and {@code m} is the method name.
     */
    private void onReach(Thread target, String location, Runnable action) {
        int index = location.lastIndexOf('.');
        String className = location.substring(0, index);
        String methodName = location.substring(index + 1);
        Thread.ofPlatform().daemon(true).start(() -> {
            try {
                boolean found = false;
                while (!found) {
                    found = contains(target.getStackTrace(), className, methodName);
                    if (!found) {
                        Thread.sleep(20);
                    }
                }
                action.run();
            } catch (Exception e) {
                e.printStackTrace();
            }
        });
    }

    /**
     * Returns true if the given stack trace contains an element for the given class
     * and method name.
     */
    private boolean contains(StackTraceElement[] stack, String className, String methodName) {
        return Arrays.stream(stack)
                .anyMatch(e -> className.equals(e.getClassName())
                        && methodName.equals(e.getMethodName()));
    }
}