Merge remote-tracking branch 'origin/Ghidra_10.1'

ryanmkurtz · ryanmkurtz · commit 0e3da48afd44 · 2021-11-12T12:49:42.000-05:00
diff --git a/Ghidra/Debug/Debugger-agent-gdb/src/main/java/agent/gdb/pty/PtySession.java b/Ghidra/Debug/Debugger-agent-gdb/src/main/java/agent/gdb/pty/PtySession.java
@@ -29,7 +29,7 @@ public interface PtySession {
 	 * @return the status code, if applicable and implemented
 	 * @throws InterruptedException if the wait is interrupted
 	 */
-	Integer waitExited() throws InterruptedException;
+	int waitExited() throws InterruptedException;
 
 	/**
 	 * Take the greatest efforts to terminate the session (leader and descendants)
diff --git a/Ghidra/Debug/Debugger-agent-gdb/src/main/java/agent/gdb/pty/local/LocalProcessPtySession.java b/Ghidra/Debug/Debugger-agent-gdb/src/main/java/agent/gdb/pty/local/LocalProcessPtySession.java
@@ -30,7 +30,7 @@ public LocalProcessPtySession(Process process) {
 	}
 
 	@Override
-	public Integer waitExited() throws InterruptedException {
+	public int waitExited() throws InterruptedException {
 		return process.waitFor();
 	}
 
diff --git a/Ghidra/Debug/Debugger-agent-gdb/src/main/java/agent/gdb/pty/ssh/SshPtySession.java b/Ghidra/Debug/Debugger-agent-gdb/src/main/java/agent/gdb/pty/ssh/SshPtySession.java
@@ -28,7 +28,7 @@ public SshPtySession(Channel channel) {
 	}
 
 	@Override
-	public Integer waitExited() throws InterruptedException {
+	public int waitExited() throws InterruptedException {
 		// Doesn't look like there's a clever way to wait. So do the spin sleep :(
 		while (!channel.isEOF()) {
 			Thread.sleep(1000);
diff --git a/Ghidra/Debug/Debugger-agent-gdb/src/test/java/agent/gdb/pty/linux/LinuxPtyTest.java b/Ghidra/Debug/Debugger-agent-gdb/src/test/java/agent/gdb/pty/linux/LinuxPtyTest.java
@@ -65,7 +65,7 @@ public void testSessionBash() throws IOException, InterruptedException {
 			PtySession bash =
 				pty.getChild().session(new String[] { DummyProc.which("bash") }, null);
 			pty.getParent().getOutputStream().write("exit\n".getBytes());
-			assertEquals(0, bash.waitExited().intValue());
+			assertEquals(0, bash.waitExited());
 		}
 	}
 
@@ -78,7 +78,7 @@ public void testForkIntoNonExistent() throws IOException, InterruptedException {
 			 * NOTE: Java subprocess dies with code 1 on unhandled exception. TODO: Is there a nice
 			 * way to distinguish whether the code is from java or the execed image?
 			 */
-			assertEquals(1, dies.waitExited().intValue());
+			assertEquals(1, dies.waitExited());
 		}
 	}
 
@@ -117,7 +117,7 @@ public Thread runExitCheck(int expected, PtySession session) {
 			while (true) {
 				try {
 					assertEquals("Early exit with wrong code", expected,
-						session.waitExited().intValue());
+						session.waitExited());
 					return;
 				}
 				catch (InterruptedException e) {
@@ -159,7 +159,7 @@ public void testSessionBashEchoTest() throws IOException, InterruptedException {
 			assertTrue("Not 'exit 3' or 'BASH:exit 3': '" + line + "'",
 				Set.of("BASH:exit 3", "exit 3").contains(line));
 
-			assertEquals(3, bash.waitExited().intValue());
+			assertEquals(3, bash.waitExited());
 		}
 	}
 
@@ -214,7 +214,7 @@ public void testSessionBashInterruptCat() throws IOException, InterruptedExcepti
 			writer.flush();
 			assertTrue(Set.of("BASH:exit 3", "exit 3").contains(reader.readLine()));
 
-			assertEquals(3, bash.waitExited().intValue());
+			assertEquals(3, bash.waitExited());
 		}
 	}
 }
diff --git a/Ghidra/Debug/Debugger-agent-gdb/src/test/java/agent/gdb/pty/ssh/SshPtyTest.java b/Ghidra/Debug/Debugger-agent-gdb/src/test/java/agent/gdb/pty/ssh/SshPtyTest.java
@@ -82,7 +82,7 @@ public void testSessionBash() throws IOException, InterruptedException {
 			out.write("exit\n".getBytes("UTF-8"));
 			out.flush();
 			new StreamPumper(pty.getParent().getInputStream(), System.out).start();
-			assertEquals(0, bash.waitExited().intValue());
+			assertEquals(0, bash.waitExited());
 		}
 	}
 }
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/ApplyClassFunctionDefinitionUpdatesScript.java b/Ghidra/Features/Decompiler/ghidra_scripts/ApplyClassFunctionDefinitionUpdatesScript.java
@@ -45,7 +45,7 @@ public void run() throws Exception {
 		}
 
 		RecoveredClassUtils classUtils = new RecoveredClassUtils(currentProgram, currentLocation,
-			state.getTool(), this, false, false, false, monitor);
+			state.getTool(), this, false, false, false, false, monitor);
 
 		Namespace classNamespace = classUtils.getClassNamespace(currentAddress);
 		if (classNamespace == null) {
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/ApplyClassFunctionSignatureUpdatesScript.java b/Ghidra/Features/Decompiler/ghidra_scripts/ApplyClassFunctionSignatureUpdatesScript.java
@@ -45,7 +45,7 @@ public void run() throws Exception {
 		}
 
 		RecoveredClassUtils classUtils = new RecoveredClassUtils(currentProgram, currentLocation,
-			state.getTool(), this, false, false, false, monitor);
+			state.getTool(), this, false, false, false, false, monitor);
 
 		Namespace classNamespace = classUtils.getClassNamespace(currentAddress);
 		if (classNamespace == null) {
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/RecoverClassesFromRTTIScript.java b/Ghidra/Features/Decompiler/ghidra_scripts/RecoverClassesFromRTTIScript.java
@@ -121,13 +121,37 @@ public class RecoverClassesFromRTTIScript extends GhidraScript {
 	// show shortened class template names in class structure field names
 	private static final boolean USE_SHORT_TEMPLATE_NAMES_IN_STRUCTURE_FIELDS = true;
 
+	// replace defined existing class structures (ie pdb, fid, demangler, or other)with ones created by 
+	// this script and rename the existing ones with a _REPLACED suffix
+	// NOTE: currently does not replace DWARF
+	// NEW OPTION:
+	private static final boolean REPLACE_EXISTING_CLASS_STRUCTURES = true;
+
 	private static final String CLASS_DATA_STRUCT_NAME = "_data";
 
 	private static final String CONSTRUCTOR_BOOKMARK = "CONSTRUCTOR";
 	private static final String DESTRUCTOR_BOOKMARK = "DESTRUCTOR";
 
 	private static final String INDETERMINATE_BOOKMARK = "INDETERMINATE";
 
+	// If replacedClassStructuresOption is set to the following, no replaced structures will be removed
+	// from the data type manager
+	private static final int DO_NOT_REMOVE_REPLACED_CLASS_STRUCTURES = 0;
+
+	// If replacedClassStructuresOption is set to the following, only empty existing class structures 
+	// that were replaced by this script will be removed from the data type manager 
+	private static final int REMOVE_EMPTY_REPLACED_CLASS_STRUCTURES = 1;
+
+	// If replacedClassStructuresOption is set to the following, all existing class structures that 
+	// were replaced by this script, including non-emtpy ones, will be removed from the data type 
+	// manager 
+	private static final int REMOVE_ALL_REPLACED_CLASS_STRUCTURES = 2;
+
+	// NEW OPTION - 
+	// This option allows the user to decide whether and how to remove replaced existing class structures
+	// using one of the above three flags
+	int replacedClassStructuresOption = DO_NOT_REMOVE_REPLACED_CLASS_STRUCTURES;
+
 	boolean programHasRTTIApplied = false;
 	boolean hasDebugSymbols;
 	boolean isGcc = false;
@@ -162,6 +186,7 @@ public void run() throws Exception {
 			recoverClassesFromRTTI = new RTTIWindowsClassRecoverer(currentProgram,
 				currentLocation, state.getTool(), this, BOOKMARK_FOUND_FUNCTIONS,
 				USE_SHORT_TEMPLATE_NAMES_IN_STRUCTURE_FIELDS, nameVfunctions, hasDebugSymbols,
+				REPLACE_EXISTING_CLASS_STRUCTURES,
 				monitor);
 		}
 		else if (isGcc()) {
@@ -182,6 +207,7 @@ else if (isGcc()) {
 			recoverClassesFromRTTI = new RTTIGccClassRecoverer(currentProgram, currentLocation,
 				state.getTool(), this, BOOKMARK_FOUND_FUNCTIONS,
 				USE_SHORT_TEMPLATE_NAMES_IN_STRUCTURE_FIELDS, nameVfunctions, hasDebugSymbols,
+				REPLACE_EXISTING_CLASS_STRUCTURES,
 				monitor);
 		}
 		else {
@@ -275,6 +301,17 @@ else if (isGcc()) {
 			showGraph(graph);
 		}
 
+		if (replacedClassStructuresOption == REMOVE_EMPTY_REPLACED_CLASS_STRUCTURES) {
+			println("Removing all empty replaced class structures from the data type manager");
+			recoverClassesFromRTTI.removeReplacedClassStructures(recoveredClasses, false);
+		}
+
+		if (replacedClassStructuresOption == REMOVE_ALL_REPLACED_CLASS_STRUCTURES) {
+			println(
+				"Removing all replaced class structures from the data type manager, including non-empty ones");
+			recoverClassesFromRTTI.removeReplacedClassStructures(recoveredClasses, true);
+		}
+
 
 		decompilerUtils.disposeDecompilerInterface();
 	}
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RTTIClassRecoverer.java b/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RTTIClassRecoverer.java
@@ -40,12 +40,14 @@ public class RTTIClassRecoverer extends RecoveredClassUtils {
 	TaskMonitor monitor;
 	boolean hasDebugSymbols;
 
+
 	RTTIClassRecoverer(Program program, ProgramLocation location, PluginTool tool,
 			FlatProgramAPI api, boolean createBookmarks, boolean useShortTemplates,
-			boolean nameVfunctions, boolean hasDebugSymbols,
+			boolean nameVfunctions, boolean hasDebugSymbols, boolean replaceClassStructures,
 			TaskMonitor monitor) {
 
 		super(program, location, tool, api, createBookmarks, useShortTemplates, nameVfunctions,
+			replaceClassStructures,
 			monitor);
 
 		this.program = program;
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RTTIGccClassRecoverer.java b/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RTTIGccClassRecoverer.java
@@ -69,15 +69,19 @@ public class RTTIGccClassRecoverer extends RTTIClassRecoverer {
 		new HashMap<RecoveredClass, Map<RecoveredClass, Long>>();
 
 	boolean isDwarfLoaded;
+	boolean replaceClassStructs;
 
 	public RTTIGccClassRecoverer(Program program, ProgramLocation location, PluginTool tool,
 			FlatProgramAPI api, boolean createBookmarks, boolean useShortTemplates,
-			boolean nameVfunctions, boolean isDwarfLoaded, TaskMonitor monitor) {
+			boolean nameVfunctions, boolean isDwarfLoaded, boolean replaceExistingClassStructures,
+			TaskMonitor monitor) {
 
 		super(program, location, tool, api, createBookmarks, useShortTemplates, nameVfunctions,
+			replaceExistingClassStructures,
 			isDwarfLoaded,
 			monitor);
 		this.isDwarfLoaded = isDwarfLoaded;
+		this.replaceClassStructs = replaceExistingClassStructures;
 	}
 
 	@Override
@@ -2898,12 +2902,14 @@ private void processDataTypes(RecoveredClass recoveredClass)
 		Structure classStruct = createSimpleClassStructure(recoveredClass, vfPointerDataTypes);
 
 		// check for DWARF -- if none add c/d/etc to class
+		//TODO: if decide to replace dwarf data types then remove this check so the replaces
+		// in the following methods can replace the dwarf data types
 		if (!isDwarfLoaded) {
 
 			// Now that we have a class data type
 			// name constructor and destructor functions and put into the class namespace
 			addConstructorsToClassNamespace(recoveredClass, classStruct);
-			addDestructorsToClassNamespace(recoveredClass);
+			addDestructorsToClassNamespace(recoveredClass, classStruct);
 //			addNonThisDestructorsToClassNamespace(recoveredClass);
 //			addVbaseDestructorsToClassNamespace(recoveredClass);
 //			addVbtableToClassNamespace(recoveredClass);
@@ -2914,15 +2920,16 @@ private void processDataTypes(RecoveredClass recoveredClass)
 //			createIndeterminateInlineComments(recoveredClass);
 
 			// add label on constructor destructor functions that could not be determined which were which
-			createIndeterminateLabels(recoveredClass);
+			createIndeterminateLabels(recoveredClass, classStruct);
 		}
 
 		// This is done after the class structure is created and added to the dtmanager
 		// because if done before the class structures are created 
 		// then empty classes will get auto-created in the wrong place
 		// when the vfunctions are put in the class
 
-		fillInAndApplyVftableStructAndNameVfunctions(recoveredClass, vfPointerDataTypes);
+		fillInAndApplyVftableStructAndNameVfunctions(recoveredClass, vfPointerDataTypes,
+			classStruct);
 
 	}
 
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RTTIWindowsClassRecoverer.java b/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RTTIWindowsClassRecoverer.java
@@ -69,11 +69,11 @@ public class RTTIWindowsClassRecoverer extends RTTIClassRecoverer {
 
 	public RTTIWindowsClassRecoverer(Program program, ProgramLocation location, PluginTool tool,
 			FlatProgramAPI api, boolean createBookmarks, boolean useShortTemplates,
-			boolean nameVFunctions, boolean isPDBLoaded,
+			boolean nameVFunctions, boolean isPDBLoaded, boolean replaceClassStructures,
 			TaskMonitor monitor) throws CancelledException {
 
 		super(program, location, tool, api, createBookmarks, useShortTemplates, nameVFunctions,
-			isPDBLoaded, monitor);
+			isPDBLoaded, replaceClassStructures, monitor);
 
 		this.isPDBLoaded = isPDBLoaded;
 
@@ -2245,32 +2245,35 @@ private void processDataTypes(RecoveredClass recoveredClass)
 
 		applyVbtableStructure(recoveredClass);
 
-		// pdb already has good names so only name if no pdb
-		if (!isPDBLoaded) {
 
-			// Now that we have a class data type
-			// name constructor and destructor functions and put into the class namespace
-			addConstructorsToClassNamespace(recoveredClass, classStruct);
-			addDestructorsToClassNamespace(recoveredClass);
+		// Now that we have a class data type
+		// name constructor and destructor functions and put into the class namespace
+		// checks are internal for hasDebugSymbols since there
+		// are also replace methods that need to be called either way
+		addConstructorsToClassNamespace(recoveredClass, classStruct);
+		addDestructorsToClassNamespace(recoveredClass, classStruct);
+		addVbaseDestructorsToClassNamespace(recoveredClass, classStruct);
+
+		if (!hasDebugSymbols) {
 			addNonThisDestructorsToClassNamespace(recoveredClass);
-			addVbaseDestructorsToClassNamespace(recoveredClass);
+
 			addVbtableToClassNamespace(recoveredClass);
 
 			// add secondary label on functions with inlined constructors or destructors
 			createInlinedConstructorComments(recoveredClass);
 			createInlinedDestructorComments(recoveredClass);
 			createIndeterminateInlineComments(recoveredClass);
-
-			// add label on constructor destructor functions that could not be determined which were which
-			createIndeterminateLabels(recoveredClass);
 		}
 
+		// add label on constructor destructor functions that could not be determined which were which
+		createIndeterminateLabels(recoveredClass, classStruct);
+
 		// This is done after the class structure is created and added to the dtmanager
 		// because if done before the class structures are created 
 		// then empty classes will get auto-created in the wrong place
 		// when the vfunctions are put in the class
-
-		fillInAndApplyVftableStructAndNameVfunctions(recoveredClass, vfPointerDataTypes);
+		fillInAndApplyVftableStructAndNameVfunctions(recoveredClass, vfPointerDataTypes,
+			classStruct);
 
 	}
 
diff --git a/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RecoveredClassUtils.java b/Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RecoveredClassUtils.java

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public LocalProcessPtySession(Process process) {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`@Override`
`33`		`- public Integer waitExited() throws InterruptedException {`
	`33`	`+ public int waitExited() throws InterruptedException {`
`34`	`34`	`return process.waitFor();`
`35`	`35`	`}`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public SshPtySession(Channel channel) {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`@Override`
`31`		`- public Integer waitExited() throws InterruptedException {`
	`31`	`+ public int waitExited() throws InterruptedException {`
`32`	`32`	`// Doesn't look like there's a clever way to wait. So do the spin sleep :(`
`33`	`33`	`while (!channel.isEOF()) {`
`34`	`34`	`Thread.sleep(1000);`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public void testSessionBash() throws IOException, InterruptedException {`
`65`	`65`	`PtySession bash =`
`66`	`66`	`pty.getChild().session(new String[] { DummyProc.which("bash") }, null);`
`67`	`67`	`pty.getParent().getOutputStream().write("exit\n".getBytes());`
`68`		`- assertEquals(0, bash.waitExited().intValue());`
	`68`	`+ assertEquals(0, bash.waitExited());`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`
`@@ -78,7 +78,7 @@ public void testForkIntoNonExistent() throws IOException, InterruptedException {`
`78`	`78`	`* NOTE: Java subprocess dies with code 1 on unhandled exception. TODO: Is there a nice`
`79`	`79`	`* way to distinguish whether the code is from java or the execed image?`
`80`	`80`	`*/`
`81`		`- assertEquals(1, dies.waitExited().intValue());`
	`81`	`+ assertEquals(1, dies.waitExited());`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`@@ -117,7 +117,7 @@ public Thread runExitCheck(int expected, PtySession session) {`
`117`	`117`	`while (true) {`
`118`	`118`	`try {`
`119`	`119`	`assertEquals("Early exit with wrong code", expected,`
`120`		`- session.waitExited().intValue());`
	`120`	`+ session.waitExited());`
`121`	`121`	`return;`
`122`	`122`	`}`
`123`	`123`	`catch (InterruptedException e) {`
`@@ -159,7 +159,7 @@ public void testSessionBashEchoTest() throws IOException, InterruptedException {`
`159`	`159`	`assertTrue("Not 'exit 3' or 'BASH:exit 3': '" + line + "'",`
`160`	`160`	`Set.of("BASH:exit 3", "exit 3").contains(line));`
`161`	`161`
`162`		`- assertEquals(3, bash.waitExited().intValue());`
	`162`	`+ assertEquals(3, bash.waitExited());`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`
`@@ -214,7 +214,7 @@ public void testSessionBashInterruptCat() throws IOException, InterruptedExcepti`
`214`	`214`	`writer.flush();`
`215`	`215`	`assertTrue(Set.of("BASH:exit 3", "exit 3").contains(reader.readLine()));`
`216`	`216`
`217`		`- assertEquals(3, bash.waitExited().intValue());`
	`217`	`+ assertEquals(3, bash.waitExited());`
`218`	`218`	`}`
`219`	`219`	`}`
`220`	`220`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ public void testSessionBash() throws IOException, InterruptedException {`
`82`	`82`	`out.write("exit\n".getBytes("UTF-8"));`
`83`	`83`	`out.flush();`
`84`	`84`	`new StreamPumper(pty.getParent().getInputStream(), System.out).start();`
`85`		`- assertEquals(0, bash.waitExited().intValue());`
	`85`	`+ assertEquals(0, bash.waitExited());`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public void run() throws Exception {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`RecoveredClassUtils classUtils = new RecoveredClassUtils(currentProgram, currentLocation,`
`48`		`- state.getTool(), this, false, false, false, monitor);`
	`48`	`+ state.getTool(), this, false, false, false, false, monitor);`
`49`	`49`
`50`	`50`	`Namespace classNamespace = classUtils.getClassNamespace(currentAddress);`
`51`	`51`	`if (classNamespace == null) {`