Skip to content

Commit

Permalink
Allow PTY to not load WinPTY on Windows
Browse files Browse the repository at this point in the history 
Refactors the initialization code of PTY to allow code to avoid
loading WinPTY if it isn't needed. The previous code would
load WinPTY even if ConPTY was in use.

To achieve this the code was refactored to have cleaner state
with a new field ptyType that replaces isConPTY, isWinPTY and
hasPTY.

The initialization code has

This is needed so that WoA can run without needing to port the
unneeded WinPTY library

Part of eclipse-cdt#969
  • Loading branch information
@jonahgraham
jonahgraham committed Dec 18, 2024
1 parent 04408db commit 3c9b995
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 64 deletions.
3 changes: 3 additions & 0 deletions core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/internal/core/natives/Messages.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@

public class Messages extends NLS {
public static String PTY_FailedToStartConPTY;
public static String PTY_FailedToStartNativePTY;
public static String PTY_FailedToStartPTY;
public static String PTY_FailedToStartWinPTY;
public static String PTY_NoClassDefFoundError;
public static String Util_exception_cannotCreatePty;
public static String Util_exception_cannotSetTerminalSize;
Expand Down
5 changes: 4 additions & 1 deletion ...org.eclipse.cdt.core.native/src/org/eclipse/cdt/internal/core/natives/Messages.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
# Martin Oberhuber (Wind River) - [303083] Split from CCorePluginResources.properties
###############################################################################

PTY_FailedToStartConPTY=Failed start a new style ConPTY. This is expected on Windows machines before Windows 10 1904 version and will fall back to WinPTY. Please consider upgrading to a newer version of Windows 10 to take advantage of the new improved console behavior.
PTY_FailedToStartConPTY=Failed start a new style ConPTY. This is expected on Windows machines before Windows 10 1904 version and will fall back to WinPTY. Please consider upgrading to a newer version of Windows to take advantage of the new improved console behavior.
PTY_FailedToStartNativePTY=Failed to load the PTY library. This may indicate a configuration problem, but can be ignored if no further problems are observed.
PTY_FailedToStartPTY=Failed to load the PTY library. This may indicate a configuration problem, but can be ignored if no further problems are observed.
PTY_FailedToStartWinPTY=Failed start WinPTY due to an exception. Please consider upgrading to a newer version of Windows to take advantage of the new improved console behavior.
PTY_NoClassDefFoundError=Failed start a new style ConPTY due to NoClassDefFoundError which probably means that the optional dependency on JNA is not available. Consider updating your product to include JNA to enable the ConPTY.
Util_exception_cannotCreatePty=Cannot create pty
Util_exception_closeError=close error
Expand Down
168 changes: 105 additions & 63 deletions core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/PTY.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2002, 2021 QNX Software Systems and others.
* Copyright (c) 2002, 2024 QNX Software Systems and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
Expand Down Expand Up @@ -28,6 +28,20 @@
*/
public class PTY {

/**
* Java property key that can be set to false disable ConPTY.
*
* Defaults to True.
*/
private static final String CONPTY_ENABLED_PROP = "org.eclipse.cdt.core.conpty_enabled"; //$NON-NLS-1$
/**
* Java property key that can be set to true to force console mode
* to be allowed on Windows.
*
* Defaults to False.
*/
private static final String FORCE_CONSOLE_MODE_ENABLED_PROP = "org.eclipse.cdt.core.winpty_console_mode"; //$NON-NLS-1$

/**
* The pty modes.
* @since 5.6
Expand Down Expand Up @@ -55,18 +69,40 @@ public enum Mode {
*/
int master;

private static boolean hasPTY;

private enum IS_CONPTY {
CONPTY_UNKNOWN, CONPTY_YES, CONPTY_NO;
private enum PTY_TYPE {
/**
* PTY type has not been determined yet,
* it will be determined for the system on first PTY that is created.
*/
PTY_UNKNOWN,
/**
* On newer Windows 10 and later, use ConPTY API to connected a console.
*/
PTY_CONPTY,
/**
* On Windows, as a fallback use WinPTY.
*/
PTY_WINPTY,
/**
* On Linux/macOS PTY operations just work and no special API is needed.
*/
PTY_NATIVE,
/**
* There is no functional PTY on this system. An error message will be logged
* and future operations on PTY will fail.
*/
PTY_BROKEN;
}

/**
* We don't know if we have conpty until we try - so this starts
* null and will be true or false once it is determined.
* The type of API that is in use.
*/
private static PTY_TYPE ptyType = PTY_TYPE.PTY_UNKNOWN;

/**
* Whether console mode is supported. Always true when ptyType == PTY_NATIVE,
* on Windows can be enabled with system property {@value #FORCE_CONSOLE_MODE_ENABLED_PROP}
*/
private static IS_CONPTY isConPTY = IS_CONPTY.CONPTY_UNKNOWN;
private static boolean isWinPTY;
private static boolean isConsoleModeSupported;
private static boolean setTerminalSizeErrorAlreadyLogged;
private ConPTY conPTY;
Expand Down Expand Up @@ -99,7 +135,7 @@ public static boolean isSupported() {
* @since 5.6
*/
public static boolean isSupported(Mode mode) {
return hasPTY && (isConsoleModeSupported || mode == Mode.TERMINAL);
return ptyType != PTY_TYPE.PTY_BROKEN && (isConsoleModeSupported || mode == Mode.TERMINAL);
}

/**
Expand Down Expand Up @@ -133,39 +169,29 @@ public PTY() throws IOException {
*/
public PTY(Mode mode) throws IOException {
this.mode = mode;

if (isConsole() && !isConsoleModeSupported) {
throw new IOException(Messages.Util_exception_cannotCreatePty);
}

PTYInputStream inInit = null;
PTYOutputStream outInit = null;
String slaveInit = null;
if (isConPTY != IS_CONPTY.CONPTY_NO) {
try {
conPTY = new ConPTY();
isConPTY = IS_CONPTY.CONPTY_YES;
slaveInit = "conpty"; //$NON-NLS-1$
inInit = new ConPTYInputStream(conPTY);
outInit = new ConPTYOutputStream(conPTY);
} catch (NoClassDefFoundError e) {
isConPTY = IS_CONPTY.CONPTY_NO;
CNativePlugin.log(Messages.PTY_NoClassDefFoundError, e);
} catch (Throwable e) {
isConPTY = IS_CONPTY.CONPTY_NO;
CNativePlugin.log(Messages.PTY_FailedToStartConPTY, e);
}
}

// fall through in exception case as well as normal non-conPTY
if (isConPTY == IS_CONPTY.CONPTY_NO) {

slaveInit = hasPTY ? openMaster(isConsole()) : null;

// con pty has its own implementation of everything, so everything is delegated to conPTY
if (ptyType == PTY_TYPE.PTY_CONPTY) {
conPTY = new ConPTY();
slaveInit = "conpty"; //$NON-NLS-1$
inInit = new ConPTYInputStream(conPTY);
outInit = new ConPTYOutputStream(conPTY);
} else {
slaveInit = (ptyType != PTY_TYPE.PTY_BROKEN) ? openMaster(isConsole()) : null;
if (slaveInit == null) {
throw new IOException(Messages.Util_exception_cannotCreatePty);
}

inInit = new PTYInputStream(new MasterFD());
outInit = new PTYOutputStream(new MasterFD(), !isWinPTY);
outInit = new PTYOutputStream(new MasterFD(), ptyType != PTY_TYPE.PTY_WINPTY);
}
slave = slaveInit;
in = inInit;
Expand All @@ -181,7 +207,7 @@ public PTY(Mode mode) throws IOException {
public void validateSlaveName() throws IOException {
// on windows the slave name is just an internal identifier
// and does not represent a real device
if (isWinPTY) {
if (ptyType == PTY_TYPE.PTY_CONPTY || ptyType == PTY_TYPE.PTY_WINPTY) {
throw new IOException("Slave name is not valid"); //$NON-NLS-1$
}
}
Expand Down Expand Up @@ -228,7 +254,7 @@ public PTYInputStream getInputStream() {
*/
public final void setTerminalSize(int width, int height) {
try {
if (isConPTY == IS_CONPTY.CONPTY_YES) {
if (ptyType == PTY_TYPE.PTY_CONPTY) {
conPTY.setTerminalSize(width, height);
} else {
change_window_size(master, width, height);
Expand All @@ -248,9 +274,9 @@ public final void setTerminalSize(int width, int height) {
*/
public int exec_pty(Spawner spawner, String[] cmdarray, String[] envp, String dir, IChannel[] chan)
throws IOException {
if (isConPTY == IS_CONPTY.CONPTY_YES) {
if (ptyType == PTY_TYPE.PTY_CONPTY) {
return conPTY.exec(cmdarray, envp, dir);
} else if (isWinPTY) {
} else if (ptyType == PTY_TYPE.PTY_WINPTY) {
return exec2(cmdarray, envp, dir, chan, slave, master, isConsole());
} else {
return spawner.exec2(cmdarray, envp, dir, chan, slave, master, isConsole());
Expand All @@ -262,9 +288,9 @@ public int exec_pty(Spawner spawner, String[] cmdarray, String[] envp, String di
* @since 5.6
*/
public int waitFor(Spawner spawner, int pid) {
if (isConPTY == IS_CONPTY.CONPTY_YES) {
if (ptyType == PTY_TYPE.PTY_CONPTY) {
return conPTY.waitFor();
} else if (isWinPTY) {
} else if (ptyType == PTY_TYPE.PTY_WINPTY) {
return waitFor(master, pid);
} else {
return spawner.waitFor(pid);
Expand All @@ -287,35 +313,51 @@ native int exec2(String[] cmdarray, String[] envp, String dir, IChannel[] chan,
native int waitFor(int masterFD, int processID);

static {
try {
boolean isWindows = Platform.OS_WIN32.equals(Platform.getOS());
if (!isWindows) {
isConPTY = IS_CONPTY.CONPTY_NO;
}
// Disable ConPTY if the user needs to
boolean conPtyEnabled = Boolean
.parseBoolean(System.getProperty("org.eclipse.cdt.core.conpty_enabled", "true")); //$NON-NLS-1$ //$NON-NLS-2$
if (!conPtyEnabled) {
isConPTY = IS_CONPTY.CONPTY_NO;
if (Platform.OS_WIN32.equals(Platform.getOS())) {
boolean conPtyEnabled = Boolean.parseBoolean(System.getProperty(CONPTY_ENABLED_PROP, "true")); //$NON-NLS-1$
if (conPtyEnabled) {
try {
// Try creating and closing a ConPTY to see if the API is available.
ConPTY pty = new ConPTY();
pty.close();
ptyType = PTY_TYPE.PTY_CONPTY;
isConsoleModeSupported = Boolean.getBoolean(FORCE_CONSOLE_MODE_ENABLED_PROP);

} catch (NoClassDefFoundError e) {
CNativePlugin.log(Messages.PTY_NoClassDefFoundError, e);
} catch (Throwable e) {
CNativePlugin.log(Messages.PTY_FailedToStartConPTY, e);
}
}

isWinPTY = isWindows;
if (isWindows) {
// When we used to build with VC++ we used DelayLoadDLLs (See Gerrit 167674 and Bug 521515) so that the winpty
// could be found. When we ported to mingw we didn't port across this feature because it was simpler to just
// manually load winpty first.
System.loadLibrary("winpty"); //$NON-NLS-1$
if (ptyType == PTY_TYPE.PTY_UNKNOWN) {
try {
// When we used to build with VC++ we used DelayLoadDLLs (See Gerrit 167674 and Bug 521515) so that the winpty
// could be found. When we ported to mingw we didn't port across this feature because it was simpler to just
// manually load winpty first.
System.loadLibrary("winpty"); //$NON-NLS-1$
System.loadLibrary("pty"); //$NON-NLS-1$
ptyType = PTY_TYPE.PTY_WINPTY;
isConsoleModeSupported = Boolean.getBoolean(FORCE_CONSOLE_MODE_ENABLED_PROP);
} catch (Throwable e) {
CNativePlugin.log(Messages.PTY_FailedToStartWinPTY, e);
}
}
} else {
try {
System.loadLibrary("pty"); //$NON-NLS-1$
ptyType = PTY_TYPE.PTY_NATIVE;
isConsoleModeSupported = true;
} catch (Throwable e) {
CNativePlugin.log(Messages.PTY_FailedToStartNativePTY, e);
}
System.loadLibrary("pty"); //$NON-NLS-1$
hasPTY = true;
// on windows console mode is not supported except for experimental use
// to enable it, set system property org.eclipse.cdt.core.winpty_console_mode=true
isConsoleModeSupported = !isWinPTY || Boolean.getBoolean("org.eclipse.cdt.core.winpty_console_mode"); //$NON-NLS-1$
} catch (SecurityException | UnsatisfiedLinkError e) {
CNativePlugin.log(
"Failed to load the PTY library. This may indicate a configuration problem, but can be ignored if no further problems are observed.", //$NON-NLS-1$
e);
}
}

if (ptyType == PTY_TYPE.PTY_UNKNOWN) {
ptyType = PTY_TYPE.PTY_BROKEN;
isConsoleModeSupported = true;
CNativePlugin.log(Messages.PTY_FailedToStartPTY);
}

}
}

0 comments on commit 3c9b995

Please sign in to comment.