8260540: serviceability/jdwp/AllModulesCommandTest.java failed with "…

…Debuggee error: 'ERROR: transport error 202: bind failed: Address already in use'"

Reviewed-by: lucy
Backport-of: 7a23c9cbb7d09c4e6c4e8d9b2f912e41d60fd05e

test/hotspot/jtreg/serviceability/jdwp/AllModulesCommandTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 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
@@ -82,7 +82,7 @@ private void doJdwp() throws Exception {
         try {
             // Establish JDWP socket connection
             channel = new JdwpChannel();
-            channel.connect();
+            channel.connect(launcher.getJdwpPort());
             // Send out ALLMODULES JDWP command
             // and verify the reply
             JdwpAllModulesReply reply = new JdwpAllModulesCmd().send(channel);

test/hotspot/jtreg/serviceability/jdwp/DebuggeeLauncher.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 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
@@ -21,11 +21,9 @@
  * questions.
  */
 
-import java.io.IOException;
-import java.net.ServerSocket;
 import java.util.StringTokenizer;
 import jdk.test.lib.JDKToolFinder;
-import jdk.test.lib.Utils;
+import jdk.test.lib.JDWP;
 import static jdk.test.lib.Asserts.assertFalse;
 
 /**
@@ -55,7 +53,7 @@ public interface Listener {
         void onDebuggeeError(String line);
     }
 
-    private static int jdwpPort = -1;
+    private int jdwpPort = -1;
     private static final String CLS_DIR = System.getProperty("test.classes", "").trim();
     private static final String DEBUGGEE = "AllModulesCommandTestDebuggee";
     private Process p;
@@ -117,30 +115,19 @@ public void terminateDebuggee() {
      * @return the JDWP options to start the debuggee with
      */
     private static String getJdwpOptions() {
-        return "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=" + getJdwpPort();
+        return "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=0";
     }
 
     /**
-     * Find an available port for the JDWP session
+     * Gets JDWP port debuggee is listening on.
      *
      * @return JDWP port
      */
-    public static int getJdwpPort() {
-        if (jdwpPort == -1) {
-            jdwpPort = findFreePort();
-            assertFalse(jdwpPort == -1, "Can not find vailbale port for JDWP");
-        }
+    public int getJdwpPort() {
+        assertFalse(jdwpPort == -1, "JDWP port is not detected");
         return jdwpPort;
     }
 
-    private static int findFreePort() {
-        try (ServerSocket socket = new ServerSocket(0)) {
-            return socket.getLocalPort();
-        } catch (IOException e) {
-        }
-        return -1;
-    }
-
     @Override
     public void onStringRead(StreamHandler handler, String line) {
         if (handler.equals(errorHandler)) {
@@ -152,6 +139,12 @@ public void onStringRead(StreamHandler handler, String line) {
     }
 
     private void processDebuggeeOutput(String line) {
+        if (jdwpPort == -1) {
+            JDWP.ListenAddress addr = JDWP.parseListenAddress(line);
+            if (addr != null) {
+                jdwpPort = Integer.parseInt(addr.address());
+            }
+        }
         StringTokenizer st = new StringTokenizer(line);
         String token = st.nextToken();
         switch (token) {

test/hotspot/jtreg/serviceability/jdwp/JdwpChannel.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 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
@@ -33,8 +33,8 @@ public class JdwpChannel {
 
     private Socket sock;
 
-    public void connect() throws IOException {
-        sock = new Socket("localhost", DebuggeeLauncher.getJdwpPort());
+    public void connect(int jdwpPort) throws IOException {
+        sock = new Socket("localhost", jdwpPort);
         handshake();
     }
 

test/jdk/com/sun/jdi/JdwpAllowTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 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
@@ -34,16 +34,14 @@
 import java.net.Socket;
 import java.net.SocketException;
 
+import jdk.test.lib.JDWP;
 import jdk.test.lib.Utils;
 import jdk.test.lib.apps.LingeredApp;
 
-import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Random;
 import java.util.concurrent.TimeUnit;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 
 public class JdwpAllowTest {
@@ -76,16 +74,14 @@ public static String[] prepareCmd(String allowOpt) {
          return new String[] { jdwpArgs };
     }
 
-    private static Pattern listenRegexp = Pattern.compile("Listening for transport \\b(.+)\\b at address: \\b(\\d+)\\b");
     private static int detectPort(LingeredApp app) {
         long maxWaitTime = System.currentTimeMillis()
                 + Utils.adjustTimeout(10000);  // 10 seconds adjusted for TIMEOUT_FACTOR
         while (true) {
             String s = app.getProcessStdout();
-            Matcher m = listenRegexp.matcher(s);
-            if (m.find()) {
-                // m.group(1) is transport, m.group(2) is port
-                return Integer.parseInt(m.group(2));
+            JDWP.ListenAddress addr = JDWP.parseListenAddress(s);
+            if (addr != null) {
+                return Integer.parseInt(addr.address());
             }
             if (System.currentTimeMillis() > maxWaitTime) {
                 throw new RuntimeException("Could not detect port from '" + s + "' (timeout)");

test/jdk/com/sun/jdi/RunToExit.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2004, 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
@@ -40,9 +40,9 @@
 import java.util.List;
 import java.util.Iterator;
 import java.util.concurrent.TimeUnit;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 import java.util.stream.Collectors;
+
+import jdk.test.lib.JDWP;
 import jdk.test.lib.process.ProcessTools;
 
 public class RunToExit {
@@ -95,16 +95,12 @@ private static Process launch(String class_name) throws Exception {
         return p;
     }
 
-    /* warm-up predicate for debuggee */
-    private static Pattern listenRegexp = Pattern.compile("Listening for transport \\b(.+)\\b at address: \\b(.+)\\b");
-
     private static boolean isTransportListening(String line) {
-        Matcher m = listenRegexp.matcher(line);
-        if (!m.matches()) {
+        JDWP.ListenAddress addr = JDWP.parseListenAddress(line);
+        if (addr == null) {
             return false;
         }
-        // address is 2nd group
-        address = m.group(2);
+        address = addr.address();
         return true;
     }
 

test/jdk/com/sun/jdi/lib/jdb/Debuggee.java

@@ -23,8 +23,8 @@
 
 package lib.jdb;
 
+import jdk.test.lib.JDWP;
 import jdk.test.lib.Utils;
-import jdk.test.lib.util.Pair;
 import jdk.test.lib.process.ProcessTools;
 
 import java.io.Closeable;
@@ -128,7 +128,7 @@ public ProcessBuilder prepare() {
         public Debuggee launch(String name) {
             return new Debuggee(prepare(), name,
                 onthrow.isEmpty() ?
-                    Launcher::parseListenAddress :
+                    JDWP::parseListenAddress :
                     Launcher::parseLaunchEchoListenAddress
             );
         }
@@ -140,47 +140,29 @@ public Debuggee launch() {
          * Parses debuggee output to get listening transport and address, printed by `launch=echo`.
          * Returns null if the string specified does not contain required info.
          */
-        private static Pair<String, String> parseLaunchEchoListenAddress(String debuggeeOutput) {
+        private static JDWP.ListenAddress parseLaunchEchoListenAddress(String debuggeeOutput) {
             Pattern listenRegexp = Pattern.compile(LAUNCH_ECHO_STRING + " \\b(.+)\\b \\b(.+)\\b");
             Matcher m = listenRegexp.matcher(debuggeeOutput);
             if (m.find()) {
-                return new Pair<String, String>(m.group(1), m.group(2));
-            }
-            return null;
-        }
-
-        /**
-         * Parses debuggee output to get listening transport and address, printed by `launch=echo`.
-         * Returns null if the string specified does not contain required info.
-         */
-        private static Pair<String, String> parseListenAddress(String debuggeeOutput) {
-            Pattern listenRegexp = Pattern.compile("Listening for transport \\b(.+)\\b at address: \\b(.+)\\b");
-            Matcher m = listenRegexp.matcher(debuggeeOutput);
-            if (m.find()) {
-                return new Pair<String, String>(m.group(1), m.group(2));
+                return new JDWP.ListenAddress(m.group(1), m.group(2));
             }
             return null;
         }
     }
 
     // starts the process, waits until the provided addressDetector detects transport/address from the process output
-    private Debuggee(ProcessBuilder pb, String name, Function<String, Pair<String, String>> addressDetector) {
-        String[] debuggeeListen = new String[2];
+    private Debuggee(ProcessBuilder pb, String name, Function<String, JDWP.ListenAddress> addressDetector) {
+        JDWP.ListenAddress[] listenAddress = new JDWP.ListenAddress[1];
         try {
             p = ProcessTools.startProcess(name, pb,
                     s -> output.add(s),  // output consumer
                     s -> {
-                        Pair<String, String> addr = addressDetector.apply(s);
-                        if (addr != null) {
-                            debuggeeListen[0] = addr.first;
-                            debuggeeListen[1] = addr.second;
-                            return true;
-                        }
-                        return false;
+                        listenAddress[0] = addressDetector.apply(s);
+                        return listenAddress[0] != null;
                     },
                     30, TimeUnit.SECONDS);
-            transport = debuggeeListen[0];
-            address = debuggeeListen[1];
+            transport = listenAddress[0].transport();
+            address = listenAddress[0].address();
         } catch (IOException | InterruptedException | TimeoutException ex) {
             throw new RuntimeException("failed to launch debuggee", ex);
         }

test/lib/jdk/test/lib/JDWP.java

@@ -0,0 +1,52 @@
+/*
+ * 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.
+ */
+
+package jdk.test.lib;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class JDWP {
+
+    public record ListenAddress(String transport, String address) {
+    }
+
+    // lazy initialized
+    private static Pattern listenRegexp;
+
+    /**
+     * Parses debuggee output to get listening transport and address.
+     * Returns null if the string specified does not contain required info.
+     */
+    public static ListenAddress parseListenAddress(String debuggeeOutput) {
+        if (listenRegexp == null) {
+            listenRegexp = Pattern.compile("Listening for transport \\b(.+)\\b at address: \\b(.+)\\b");
+        }
+        Matcher m = listenRegexp.matcher(debuggeeOutput);
+        if (m.find()) {
+            return new ListenAddress(m.group(1), m.group(2));
+        }
+        return null;
+    }
+
+}