Skip to content

IEP-1265: Debug Process Hangs #1023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Nov 27, 2024
Merged

IEP-1265: Debug Process Hangs #1023

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
24988ac
changes to verify process
alirana01 Jul 22, 2024
d595bee
Revert "changes to verify process"
alirana01 Sep 13, 2024
88a2c15
fix(port): updated code for port verification To
alirana01 Sep 13, 2024
de00153
changes to verify process
alirana01 Jul 22, 2024
03c8344
Revert "changes to verify process"
alirana01 Sep 13, 2024
2ac0d8a
fix(debugger_tab): updated code to enable remote gdb only when server…
alirana01 Sep 16, 2024
e0fa1a5
fix(openocd): fixed the port handler behavior
alirana01 Oct 1, 2024
a926bd6
fix(openocd): fixed the port handler for verification for other proce…
alirana01 Nov 11, 2024
d07c76f
Revert "fix(openocd): fixed the port handler for verification for oth…
alirana01 Nov 13, 2024
2c91af0
fix(gdb): fixed the port in configuration storage for gdb
alirana01 Nov 13, 2024
63705af
fix(monitor): fixed the issue during cleanup for the launch
alirana01 Nov 13, 2024
abe20e5
fix(gdb_openocd): added custom handling of terminate for debugging pr…
alirana01 Nov 18, 2024
122d853
fix(disclamers): updated required docs for the classes
alirana01 Nov 18, 2024
f1d737c
fix(npe): updated code to handle npe for the getProcesses function
alirana01 Nov 19, 2024
ea0c653
fix(proc_dictionary): Add helper class to hold processes by launches
alirana01 Nov 20, 2024
9fde565
fix(process): Debug Launch to return true for disconnect and terminate
alirana01 Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/PortChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
*******************************************************************************/
package com.espressif.idf.core.util;

import java.io.IOException;
import java.net.InetAddress;
import java.net.ServerSocket;
import java.net.Socket;

import com.espressif.idf.core.logging.Logger;
Expand All @@ -24,13 +27,15 @@

public static boolean isPortAvailable(int port)
{
try (Socket ignored = new Socket("localhost", port)) //$NON-NLS-1$
try (ServerSocket serverSocket = new ServerSocket(port, 50, InetAddress.getByName("127.0.0.1"))) //$NON-NLS-1$
{
return false;
serverSocket.setReuseAddress(true);
return true;
}
catch (Exception e)

Check warning on line 35 in bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/PortChecker.java

View workflow job for this annotation

GitHub Actions / spotbugs

REC_CATCH_EXCEPTION 

Exception is caught when Exception is not thrown in com.espressif.idf.core.util.PortChecker.isPortAvailable(int)
Raw output 
This method uses a try-catch block that catches Exception objects, but Exception is not thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to say try { ... } catch (Exception e) { something } as a shorthand for catching a number of types of exception each of whose catch blocks is identical, but this construct also accidentally catches RuntimeException as well, masking potential bugs.

A better approach is to either explicitly catch the specific exceptions that are thrown, or to explicitly catch RuntimeException exception, rethrow it, and then catch all non-Runtime Exceptions, as shown below:

try {
    ...
} catch (RuntimeException e) {
    throw e;
} catch (Exception e) {
    ... deal with all non-runtime exceptions ...
}
{
return true;
Logger.log("Port: " + port + " is not available"); //$NON-NLS-1$ //$NON-NLS-2$
return false;
}
}

Expand Down
11 changes: 8 additions & 3 deletions ....idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/Configuration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@
import java.util.List;

import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;
import org.eclipse.cdt.debug.gdbjtag.core.IGDBJtagConstants;
import org.eclipse.cdt.dsf.gdb.IGDBLaunchConfigurationConstants;
import org.eclipse.cdt.dsf.gdb.IGdbDebugPreferenceConstants;
import org.eclipse.cdt.dsf.gdb.internal.GdbPlugin;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.Platform;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.embedcdt.core.EclipseUtils;
import org.eclipse.embedcdt.core.StringUtils;
import org.eclipse.embedcdt.debug.gdbjtag.core.DebugUtils;
Expand Down Expand Up @@ -93,9 +95,12 @@ public static String[] getGdbServerCommandLineArray(ILaunchConfiguration configu
lst.add(executable);

int port = PortChecker
.getAvailablePort(configuration.getAttribute(ConfigurationAttributes.GDB_SERVER_GDB_PORT_NUMBER,
DefaultPreferences.GDB_SERVER_GDB_PORT_NUMBER_DEFAULT));

.getAvailablePort(DefaultPreferences.GDB_SERVER_GDB_PORT_NUMBER_DEFAULT);

ILaunchConfigurationWorkingCopy configurationWorkingCopy = configuration.getWorkingCopy();
configurationWorkingCopy.setAttribute(IGDBJtagConstants.ATTR_PORT_NUMBER, port);
configurationWorkingCopy.doSave();

lst.add("-c"); //$NON-NLS-1$
lst.add("gdb_port " + port); //$NON-NLS-1$

Expand Down
Loading
Loading