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
196
197
198
199
200
201
202
203
204
205
|
/*
* Copyright (c) 2021, 2024, 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.
*/
package compiler.lib.ir_framework.shared;
import compiler.lib.ir_framework.TestFramework;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.FutureTask;
/**
* Dedicated socket to send data from the flag and test VM back to the driver VM.
*/
public class TestFrameworkSocket implements AutoCloseable {
public static final String STDOUT_PREFIX = "[STDOUT]";
public static final String TESTLIST_TAG = "[TESTLIST]";
public static final String DEFAULT_REGEX_TAG = "[DEFAULT_REGEX]";
public static final String PRINT_TIMES_TAG = "[PRINT_TIMES]";
public static final String NOT_COMPILABLE_TAG = "[NOT_COMPILABLE]";
// Static fields used for test VM only.
private static final String SERVER_PORT_PROPERTY = "ir.framework.server.port";
private static final int SERVER_PORT = Integer.getInteger(SERVER_PORT_PROPERTY, -1);
private static final boolean REPRODUCE = Boolean.getBoolean("Reproduce");
private static Socket clientSocket = null;
private static PrintWriter clientWriter = null;
private final String serverPortPropertyFlag;
private FutureTask<String> socketTask;
private final ServerSocket serverSocket;
private boolean receivedStdOut = false;
public TestFrameworkSocket() {
try {
serverSocket = new ServerSocket();
serverSocket.bind(new InetSocketAddress(InetAddress.getLoopbackAddress(), 0));
} catch (IOException e) {
throw new TestFrameworkException("Failed to create TestFramework server socket", e);
}
int port = serverSocket.getLocalPort();
if (TestFramework.VERBOSE) {
System.out.println("TestFramework server socket uses port " + port);
}
serverPortPropertyFlag = "-D" + SERVER_PORT_PROPERTY + "=" + port;
start();
}
public String getPortPropertyFlag() {
return serverPortPropertyFlag;
}
private void start() {
socketTask = initSocketTask();
Thread socketThread = new Thread(socketTask);
socketThread.start();
}
/**
* Waits for a client (created by flag or test VM) to connect. Return the messages received from the client.
*/
private FutureTask<String> initSocketTask() {
return new FutureTask<>(() -> {
try (Socket clientSocket = serverSocket.accept();
BufferedReader in = new BufferedReader(new InputStreamReader(clientSocket.getInputStream()))
) {
StringBuilder builder = new StringBuilder();
String next;
while ((next = in.readLine()) != null) {
builder.append(next).append(System.lineSeparator());
if (next.startsWith(STDOUT_PREFIX)) {
receivedStdOut = true;
}
}
return builder.toString();
} catch (IOException e) {
throw new TestFrameworkException("Server socket error", e);
}
});
}
@Override
public void close() {
try {
serverSocket.close();
} catch (IOException e) {
throw new TestFrameworkException("Could not close socket", e);
}
}
/**
* Only called by test VM to write to server socket.
*/
public static void write(String msg, String tag) {
write(msg, tag, false);
}
/**
* Only called by test VM to write to server socket.
* <p>
* The test VM is spawned by the main jtreg VM. The stdout of the test VM is hidden
* unless the Verbose or ReportStdout flag is used. TestFrameworkSocket is used by the parent jtreg
* VM and the test VM to communicate. By sending the prints through the TestFrameworkSocket with the
* parameter stdout set to true, the parent VM will print the received messages to its stdout, making it
* visible to the user.
*/
public static void write(String msg, String tag, boolean stdout) {
if (REPRODUCE) {
System.out.println("Debugging Test VM: Skip writing due to -DReproduce");
return;
}
TestFramework.check(SERVER_PORT != -1, "Server port was not set correctly for flag and/or test VM "
+ "or method not called from flag or test VM");
try {
// Keep the client socket open until the test VM terminates (calls closeClientSocket before exiting main()).
if (clientSocket == null) {
clientSocket = new Socket(InetAddress.getLoopbackAddress(), SERVER_PORT);
clientWriter = new PrintWriter(clientSocket.getOutputStream(), true);
}
if (stdout) {
msg = STDOUT_PREFIX + tag + " " + msg;
}
clientWriter.println(msg);
} catch (Exception e) {
// When the test VM is directly run, we should ignore all messages that would normally be sent to the
// driver VM.
String failMsg = System.lineSeparator() + System.lineSeparator() + """
###########################################################
Did you directly run the test VM (TestVM class)
to reproduce a bug?
=> Append the flag -DReproduce=true and try again!
###########################################################
""";
throw new TestRunException(failMsg, e);
}
if (TestFramework.VERBOSE) {
System.out.println("Written " + tag + " to socket:");
System.out.println(msg);
}
}
/**
* Closes (and flushes) the printer to the socket and the socket itself. Is called as last thing before exiting
* the main() method of the flag and the test VM.
*/
public static void closeClientSocket() {
if (clientSocket != null) {
try {
clientWriter.close();
clientSocket.close();
} catch (IOException e) {
throw new RuntimeException("Could not close TestVM socket", e);
}
}
}
/**
* Get the socket output of the flag VM.
*/
public String getOutput() {
try {
return socketTask.get();
} catch (ExecutionException e) {
// Thrown when socket task was not finished, yet (i.e. no client sent data) but socket was already closed.
return "";
} catch (Exception e) {
throw new TestFrameworkException("Could not read from socket task", e);
}
}
/**
* Return whether test VM sent messages to be put on stdout (starting with {@link ::STDOUT_PREFIX}).
*/
public boolean hasStdOut() {
return receivedStdOut;
}
}
|
