Merge remote-tracking branch

'origin/GP-4183_dev747368_PR-6072_astrelsky_golang_1.21' (Closes NationalSecurityAgency#6072)

Author: ryanmkurtz

Ghidra/Features/Base/certification.manifest

@@ -91,6 +91,7 @@ data/typeinfo/golang/golang_1.17_anybit_any.gdt||GHIDRA||||END|
 data/typeinfo/golang/golang_1.18_anybit_any.gdt||GHIDRA||||END|
 data/typeinfo/golang/golang_1.19_anybit_any.gdt||GHIDRA||||END|
 data/typeinfo/golang/golang_1.20_anybit_any.gdt||GHIDRA||||END|
+data/typeinfo/golang/golang_1.21_anybit_any.gdt||GHIDRA||||END|
 data/typeinfo/golang/runtimesnapshot.go||GHIDRA||||END|
 data/typeinfo/mac_10.9/mac_osx.gdt||GHIDRA||||END|
 data/typeinfo/rust/rust-common.gdt||GHIDRA||||END|

Ghidra/Features/Base/data/typeinfo/golang/golang_1.21_anybit_any.gdt

@@ -99,7 +99,7 @@ public boolean added(Program program, AddressSetView set, TaskMonitor monitor, M
 
 		goBinary = GoRttiMapper.getSharedGoBinary(program, monitor);
 		if (goBinary == null) {
-			Msg.error(this, "Golang analyzer error: unable to get GoRttiMapper");
+			Msg.error(this, "Golang string analyzer error: unable to get GoRttiMapper");
 			return false;
 		}
 		markupSession = goBinary.createMarkupSession(monitor);

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/GolangStringAnalyzer.java

@@ -112,7 +112,7 @@ public boolean added(Program program, AddressSetView set, TaskMonitor monitor, M
 
 		goBinary = GoRttiMapper.getSharedGoBinary(program, monitor);
 		if (goBinary == null) {
-			Msg.error(this, "Golang analyzer error: unable to get GoRttiMapper");
+			Msg.error(this, "Golang symbol analyzer error: unable to get GoRttiMapper");
 			return false;
 		}
 
@@ -136,6 +136,7 @@ public boolean added(Program program, AddressSetView set, TaskMonitor monitor, M
 			}
 
 			if (analyzerOptions.propagateRtti) {
+				Msg.info(this, "Golang symbol analyzer: scheduling RTTI propagation after reference analysis");
 				aam.schedule(new PropagateRttiBackgroundCommand(goBinary),
 					AnalysisPriority.REFERENCE_ANALYSIS.after().priority());
 			}

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/GolangSymbolAnalyzer.java

@@ -0,0 +1,38 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.app.util.bin.format.golang;
+
+import java.io.IOException;
+
+public class BootstrapInfoException extends IOException {
+
+	public BootstrapInfoException() {
+		// empty
+	}
+
+	public BootstrapInfoException(String message) {
+		super(message);
+	}
+
+	public BootstrapInfoException(Throwable cause) {
+		super(cause);
+	}
+
+	public BootstrapInfoException(String message, Throwable cause) {
+		super(message, cause);
+	}
+
+}

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/BootstrapInfoException.java

@@ -28,12 +28,14 @@ public enum GoVer {
 	V1_17(1, 17),
 	V1_18(1, 18),
 	V1_19(1, 19),
-	V1_20(1, 20);
+	V1_20(1, 20),
+	V1_21(1, 21),
+	V1_22(1, 22);
 
 	private final int major;
 	private final int minor;
 
-	private GoVer(int major, int minor) {
+	GoVer(int major, int minor) {
 		this.major = major;
 		this.minor = minor;
 	}
@@ -89,7 +91,7 @@ public static GoVer parse(String s) {
 			}
 		}
 		catch (NumberFormatException e) {
-			return UNKNOWN;
+			// fall thru, return unknown
 		}
 		return UNKNOWN;
 	}

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/GoVer.java

@@ -112,54 +112,63 @@ public static GoRttiMapper getSharedGoBinary(Program program, TaskMonitor monito
 					GoRttiMapper supplier_result = getGoBinary(program);
 					if (supplier_result != null) {
 						supplier_result.init(monitor);
+						return supplier_result;
 					}
-					return supplier_result;
 				}
-				catch (IllegalArgumentException | IOException e) {
-					TransientProgramProperties.getProperty(program, FAILED_FLAG,
-						TransientProgramProperties.SCOPE.PROGRAM, Boolean.class, () -> true); // also sets it
-
-					if (e instanceof IOException) {
-						// this is a more serious error, and the stack trace should be written
-						// to the application log
-						Msg.error(GoRttiMapper.class,
-							"Failed to read golang info for: " + program.getName(), e);
+				catch (BootstrapInfoException mbie) {
+					Msg.warn(GoRttiMapper.class, mbie.getMessage());
+					logAnalyzerMsg(program, mbie.getMessage());
+				}
+				catch (IOException e) {
+					// this is a more serious error, and the stack trace should be written
+					// to the application log
+					Msg.error(GoRttiMapper.class, "Failed to read golang info", e);
+					logAnalyzerMsg(program, e.getMessage());
+				}
 
-					}
-					AutoAnalysisManager aam = AutoAnalysisManager.getAnalysisManager(program);
-					if (aam.isAnalyzing()) {
-						// should cause a modal popup at end of analysis that the go binary wasn't
-						// supported
-						MessageLog log = aam.getMessageLog();
-						log.appendMsg(e.getMessage());
-					}
-					else {
-						Msg.warn(GoRttiMapper.class, "Golang program: " + e.getMessage());
-					}
+				// this sets the failed flag
+				TransientProgramProperties.getProperty(program, FAILED_FLAG,
+					TransientProgramProperties.SCOPE.PROGRAM, Boolean.class, () -> true);
 
-					return null;
-				}
+				return null;
 			});
 
 		return goBinary;
 	}
 
+	private static void logAnalyzerMsg(Program program, String msg) {
+		AutoAnalysisManager aam = AutoAnalysisManager.getAnalysisManager(program);
+		if (aam.isAnalyzing()) {
+			// should cause a modal popup at end of analysis that will show the message
+			MessageLog log = aam.getMessageLog();
+			log.appendMsg(msg);
+		}
+	}
+
 	/**
 	 * Creates a {@link GoRttiMapper} representing the specified program.
 	 * 
 	 * @param program {@link Program}
 	 * @return new {@link GoRttiMapper}, or null if basic golang information is not found in the
 	 * binary
-	 * @throws IllegalArgumentException if the golang binary is an unsupported version
+	 * @throws BootstrapInfoException if it is a golang binary and has an unsupported or
+	 * unparseable version number or if there was a missing golang bootstrap .gdt file
 	 * @throws IOException if there was an error in the Ghidra golang rtti reading logic 
 	 */
 	public static GoRttiMapper getGoBinary(Program program)
-			throws IllegalArgumentException, IOException {
+			throws BootstrapInfoException, IOException {
 		GoBuildInfo buildInfo = GoBuildInfo.fromProgram(program);
-		GoVer goVer;
-		if (buildInfo == null || (goVer = buildInfo.getVerEnum()) == GoVer.UNKNOWN) {
+		if (buildInfo == null) {
+			// probably not a golang binary
 			return null;
 		}
+
+		GoVer goVer = buildInfo.getVerEnum();
+		if (goVer == GoVer.UNKNOWN) {
+			throw new BootstrapInfoException(
+				"Unsupported Golang version, version info: '%s'".formatted(buildInfo.getVersion()));
+		}
+
 		ResourceFile gdtFile =
 			findGolangBootstrapGDT(goVer, buildInfo.getPointerSize(), getGolangOSString(program));
 		if (gdtFile == null) {
@@ -324,11 +333,11 @@ private static Address getArtificalZerobaseAddress(Program program) {
 	 * if not present and types recovered via DWARF should be used instead
 	 * @throws IOException if error linking a structure mapped structure to its matching
 	 * ghidra structure, which is a programming error or a corrupted bootstrap gdt
-	 * @throws IllegalArgumentException if there is no matching bootstrap gdt for this specific
+	 * @throws BootstrapInfoException if there is no matching bootstrap gdt for this specific
 	 * type of golang binary
 	 */
 	public GoRttiMapper(Program program, int ptrSize, Endian endian, GoVer goVersion,
-			ResourceFile archiveGDT) throws IOException, IllegalArgumentException {
+			ResourceFile archiveGDT) throws IOException, BootstrapInfoException {
 		super(program, archiveGDT);
 
 		this.goVersion = goVersion;
@@ -357,13 +366,15 @@ public GoRttiMapper(Program program, int ptrSize, Endian endian, GoVer goVersion
 			if (archiveGDT == null) {
 				// a normal'ish situation where there isn't a .gdt for this arch/binary and there
 				// isn't any DWARF.
-				throw new IllegalArgumentException(
-					"Missing golang .gdt archive for %s, no fallback DWARF info, unable to extract golang RTTI info."
+				throw new BootstrapInfoException(
+					"Missing golang .gdt archive for %s, no fallback DWARF info, unable to extract Golang RTTI info."
 							.formatted(goVersion));
 			}
-			// a bad situation where the data type info is corrupted 
-			throw new IOException("Invalid or missing Golang bootstrap GDT file: %s"
-					.formatted(archiveGDT.getAbsolutePath()));
+
+			// we have a .gdt, but something failed. 
+			throw new IOException("Invalid Golang bootstrap GDT file or struct mapping info: %s"
+					.formatted(archiveGDT.getAbsolutePath()),
+				e);
 		}
 	}
 

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/GoRttiMapper.java

@@ -26,7 +26,7 @@
 /**
  * {@link GoType} structure that defines an array.
  */
-@StructureMapping(structureName = "runtime.arraytype")
+@StructureMapping(structureName = {"runtime.arraytype", "internal/abi.ArrayType"})
 public class GoArrayType extends GoType {
 
 	@FieldMapping

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoArrayType.java

@@ -35,7 +35,7 @@
  * struct specialized_type { basetype_struct; (various_fields)* } struct uncommon; 
  * </pre>
  */
-@StructureMapping(structureName = "runtime._type")
+@StructureMapping(structureName = {"runtime._type", "internal/abi.Type"})
 public class GoBaseType {
 
 	@ContextField
@@ -44,17 +44,17 @@ public class GoBaseType {
 	@ContextField
 	private GoRttiMapper programContext;
 
-	@FieldMapping(signedness = Signedness.Unsigned)
+	@FieldMapping(fieldName = {"size", "Size_"}, signedness = Signedness.Unsigned)
 	private long size;
 
-	@FieldMapping
+	@FieldMapping(fieldName = {"ptrdata", "PtrBytes"})
 	private long ptrdata;
 
 	@FieldMapping
 	@EOLComment("flags")
 	private int tflag;
 
-	@FieldMapping
+	@FieldMapping(fieldName = {"kind", "Kind_"})
 	@EOLComment
 	private int kind;
 

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoBaseType.java

@@ -25,7 +25,7 @@
 /**
  * A {@link GoType} structure that defines a go channel
  */
-@StructureMapping(structureName = "runtime.chantype")
+@StructureMapping(structureName = {"runtime.chantype", "internal/abi.ChanType"})
 public class GoChanType extends GoType {
 
 	@FieldMapping

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoChanType.java

@@ -27,7 +27,7 @@
 /**
  * A {@link GoType} structure that defines a function type.
  */
-@StructureMapping(structureName = "runtime.functype")
+@StructureMapping(structureName = {"runtime.functype", "internal/abi.FuncType"})
 public class GoFuncType extends GoType {
 
 	/**

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoFuncType.java

@@ -22,7 +22,7 @@
 import ghidra.program.model.address.Address;
 import ghidra.program.model.data.FunctionDefinition;
 
-@StructureMapping(structureName = "runtime.imethod")
+@StructureMapping(structureName = {"runtime.imethod", "internal/abi.Imethod"})
 public class GoIMethod implements StructureMarkup<GoIMethod> {
 
 	@ContextField
@@ -36,7 +36,7 @@ public class GoIMethod implements StructureMarkup<GoIMethod> {
 	@EOLComment("getName")
 	private long name;
 
-	@FieldMapping
+	@FieldMapping(fieldName = {"ityp", "Typ"})
 	@MarkupReference("getType")
 	private long ityp;
 

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoIMethod.java

@@ -28,14 +28,14 @@
 /**
  * A {@link GoType} structure that defines a golang interface. 
  */
-@StructureMapping(structureName = "runtime.interfacetype")
+@StructureMapping(structureName = {"runtime.interfacetype", "internal/abi.InterfaceType"})
 public class GoInterfaceType extends GoType {
 
 	@FieldMapping
 	@MarkupReference("getPkgPath")
 	private long pkgpath;	// pointer to name 
 
-	@FieldMapping
+	@FieldMapping(fieldName = {"mhdr", "Methods"})
 	private GoSlice mhdr;
 
 	public GoInterfaceType() {

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoInterfaceType.java

@@ -30,7 +30,7 @@
  * See {@link GoRttiMapper#getMapGoType()} or the "runtime.hmap" type for the definition of
  * a instance of a map variable in memory. 
  */
-@StructureMapping(structureName = "runtime.maptype")
+@StructureMapping(structureName = {"runtime.maptype", "internal/abi.MapType"})
 public class GoMapType extends GoType {
 
 	@FieldMapping
@@ -51,7 +51,7 @@ public class GoMapType extends GoType {
 	@FieldMapping
 	private int keysize;
 
-	@FieldMapping
+	@FieldMapping(fieldName = {"elemsize", "ValueSize"})
 	private int elemsize;
 
 	@FieldMapping

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoMapType.java

@@ -28,7 +28,7 @@
 /**
  * Structure that defines a method for a GoType, found in the type's {@link GoUncommonType} struct.
  */
-@StructureMapping(structureName = "runtime.method")
+@StructureMapping(structureName = {"runtime.method", "internal/abi.Method"})
 public class GoMethod implements StructureMarkup<GoMethod> {
 	@ContextField
 	private GoRttiMapper programContext;

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoMethod.java

@@ -32,7 +32,7 @@
  * <p>
  * {@link GoType} structure that defines a built-in primitive type.
  */
-@StructureMapping(structureName = "runtime._type")
+@StructureMapping(structureName = {"runtime._type", "internal/abi.Type"})
 public class GoPlainType extends GoType implements StructureReader<GoType> {
 	@Override
 	public void readStructure() throws IOException {

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoPlainType.java

@@ -26,7 +26,7 @@
 /**
  * {@link GoType} structure that defines a pointer.
  */
-@StructureMapping(structureName = "runtime.ptrtype")
+@StructureMapping(structureName = {"runtime.ptrtype", "internal/abi.PtrType"})
 public class GoPointerType extends GoType {
 	@FieldMapping
 	@MarkupReference("getElement")

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoPointerType.java

@@ -29,7 +29,7 @@
  * See {@link GoRttiMapper#getGenericSliceDT()} or the "runtime.slice" type for the definition of
  * a instance of a slice variable in memory. 
 */
-@StructureMapping(structureName = "runtime.slicetype")
+@StructureMapping(structureName = {"runtime.slicetype", "internal/abi.SliceType"})
 public class GoSliceType extends GoType {
 
 	@FieldMapping

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoSliceType.java

@@ -24,7 +24,7 @@
 /**
  * Structure used to define a field in a {@link GoStructType struct type}.
  */
-@StructureMapping(structureName = "runtime.structfield")
+@StructureMapping(structureName = {"runtime.structfield", "internal/abi.StructField"})
 public class GoStructField {
 
 	@ContextField

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoStructField.java

@@ -29,7 +29,7 @@
 /**
  * Golang type information about a specific structure type.
  */
-@StructureMapping(structureName = "runtime.structtype")
+@StructureMapping(structureName = {"runtime.structtype", "internal/abi.StructType"})
 public class GoStructType extends GoType {
 
 	@FieldMapping

Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/golang/rtti/types/GoStructType.java

@@ -69,7 +69,7 @@ public static Class<? extends GoType> getSpecializedTypeClass(GoRttiMapper progr
 	@ContextField
 	protected StructureContext<GoType> context;
 
-	@FieldMapping
+	@FieldMapping(fieldName = {"typ", "Type"})
 	@Markup
 	@FieldOutput
 	protected GoBaseType typ;