Merge remote-tracking branch

'origin/GP-1777_ghizard_Improve_determination_of_segment_addresses_squashed_rebased_20220720--SQUASHED'
(Closes NationalSecurityAgency#3993)

Author: ryanmkurtz

Ghidra/Features/FileFormats/src/main/java/ghidra/file/formats/dump/pagedump/Pagedump.java

@@ -202,7 +202,7 @@ private void loadKernelPDB(String pdbLocation, TaskMonitor monitor) {
 		try (AbstractPdb pdb = PdbParser.parse(pdbFile.getPath(), readerOptions, monitor)) {
 			monitor.setMessage("PDB: Parsing " + pdbFile + "...");
 			pdb.deserialize(monitor);
-			PdbApplicator applicator = new PdbApplicator(pdbFile.getPath(), pdb);
+			DefaultPdbApplicator applicator = new DefaultPdbApplicator(pdbFile.getPath(), pdb);
 			applicator.applyTo(program, dtm, program.getImageBase(),
 				applicatorOptions, monitor,
 				(MessageLog) null);

Ghidra/Features/PDB/src/main/java/ghidra/app/plugin/core/analysis/PdbUniversalAnalyzer.java

@@ -23,7 +23,7 @@
 import ghidra.app.util.bin.format.pdb2.pdbreader.*;
 import ghidra.app.util.importer.MessageLog;
 import ghidra.app.util.pdb.PdbProgramAttributes;
-import ghidra.app.util.pdb.pdbapplicator.PdbApplicator;
+import ghidra.app.util.pdb.pdbapplicator.DefaultPdbApplicator;
 import ghidra.app.util.pdb.pdbapplicator.PdbApplicatorOptions;
 import ghidra.framework.*;
 import ghidra.framework.options.OptionType;
@@ -181,7 +181,7 @@ public boolean added(Program program, AddressSetView set, TaskMonitor monitor, M
 		try (AbstractPdb pdb = PdbParser.parse(pdbFile.getPath(), pdbReaderOptions, monitor)) {
 			monitor.setMessage("PDB: Parsing " + pdbFile + "...");
 			pdb.deserialize(monitor);
-			PdbApplicator applicator = new PdbApplicator(pdbFile.getPath(), pdb);
+			DefaultPdbApplicator applicator = new DefaultPdbApplicator(pdbFile.getPath(), pdb);
 			applicator.applyTo(program, program.getDataTypeManager(), program.getImageBase(),
 				pdbApplicatorOptions, monitor, log);
 
@@ -251,7 +251,7 @@ private void logFailure(String msg, MessageLog log) {
 	 * Normally the analyzer would locate the PDB file on its own, but if a
 	 * headless script wishes to override the analyzer's behaivor, it can
 	 * use this method to specify a file.
-	 * 
+	 *
 	 * @param program {@link Program}
 	 * @param pdbFile the pdb file
 	 */
@@ -266,7 +266,7 @@ public static void setPdbFileOption(Program program, File pdbFile) {
 	 * Normally when the analyzer attempts to locate a matching PDB file it
 	 * will default to NOT searching remote symbol servers.  A headless script could
 	 * use this method to allow the analyzer to search remote symbol servers.
-	 * 
+	 *
 	 * @param program {@link Program}
 	 * @param allowRemote boolean flag, true means analyzer can search remote symbol
 	 * servers

Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/PdbOldDebugInfo.java

@@ -26,7 +26,7 @@
  * <P>
  * This class uses {@link ModuleInformation500}.
  */
-class PdbOldDebugInfo extends PdbDebugInfo {
+public class PdbOldDebugInfo extends PdbDebugInfo {
 
 	private static final int OLD_DBI_HEADER_LENGTH = 22;
 
@@ -74,7 +74,7 @@ protected void deserializeInternalSubstreams(PdbByteReader reader, TaskMonitor m
 	protected void deserializeAdditionalSubstreams(TaskMonitor monitor)
 			throws IOException, PdbException, CancelledException {
 		// TODO: evaluate.  I don't think we need GlobalSymbolInformation (hash) or the
-		//  PublicSymbolInformation (hash), as they are both are search mechanisms. 
+		//  PublicSymbolInformation (hash), as they are both are search mechanisms.
 		symbolRecords.deserialize(monitor);
 		globalSymbolInformation.deserialize(getGlobalSymbolsHashMaybeStreamNumber(), monitor);
 		publicSymbolInformation.deserialize(getPublicStaticSymbolsHashMaybeStreamNumber(), monitor);

Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/SegmentMapDescription.java

@@ -33,6 +33,62 @@ public class SegmentMapDescription {
 	private long segOffset;
 	private long segLength;
 
+	/**
+	 * Returns the {@link SegmentMapDescription} flags.
+	 * @return the flags.
+	 */
+	public int getFlags() {
+		return flags;
+	}
+
+	/**
+	 * Returns the {@link SegmentMapDescription} ovl (overlay?).
+	 * @return the ovl.
+	 */
+	public int getOvl() {
+		return ovl;
+	}
+
+	/**
+	 * Returns the {@link SegmentMapDescription} group.
+	 * @return the group.
+	 */
+	public int getGroup() {
+		return group;
+	}
+
+	/**
+	 * Returns the {@link SegmentMapDescription} frame.
+	 * @return the frame.
+	 */
+	public int getFrame() {
+		return frame;
+	}
+
+	/**
+	 * Returns the {@link SegmentMapDescription} segNameIndex.
+	 * @return the segNameIndex.
+	 */
+	public int getSegNameIndex() {
+		return segNameIndex;
+	}
+
+	/**
+	 * Returns the {@link SegmentMapDescription} classNameIndex.
+	 * @return the classNameIndex.
+	 */
+	public int getClassNameIndex() {
+		return classNameIndex;
+	}
+
+	/**
+	 * Returns the {@link SegmentMapDescription} segment offset.
+	 * @return the segment offset.
+	 */
+	public long getOffset() {
+		return segOffset;
+	}
+
 	/**
 	 * Returns the segment offset.
 	 * @return The offset of the segment.
@@ -42,7 +98,7 @@ public long getSegmentOffset() {
 	}
 
 	/**
-	 * Returns the segment length.
+	 * Returns the {@link SegmentMapDescription} segment length.
 	 * @return The length of the segment.
 	 */
 	public long getLength() {
@@ -73,7 +129,7 @@ protected String dump() {
 		StringBuilder builder = new StringBuilder();
 		builder.append("SegmentMapDescription---------------------------------------");
 		builder.append("\nflags: ");
-		builder.append(flags);
+		builder.append(String.format("0x%04x", flags));
 		builder.append("\novl: ");
 		builder.append(ovl);
 		builder.append("\ngroup: ");
@@ -88,6 +144,7 @@ protected String dump() {
 		builder.append(segOffset);
 		builder.append("; segLength: ");
 		builder.append(segLength);
+		builder.append("\nEnd SegmentMapDescription-----------------------------------\n");
 		return builder.toString();
 	}
 

Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/symbol/AbstractCompile2MsSymbol.java

@@ -28,6 +28,7 @@
  */
 public abstract class AbstractCompile2MsSymbol extends AbstractMsSymbol {
 
+	protected long flags;
 	protected LanguageName language;
 	protected boolean compiledForEditAndContinue;
 	protected boolean notCompiledWithDebugInfo;
@@ -59,7 +60,8 @@ public abstract class AbstractCompile2MsSymbol extends AbstractMsSymbol {
 	public AbstractCompile2MsSymbol(AbstractPdb pdb, PdbByteReader reader, StringParseType strType)
 			throws PdbException {
 		super(pdb, reader);
-		processFlags(reader.parseUnsignedIntVal());
+		flags = reader.parseUnsignedIntVal();
+		processFlags(flags);
 		processor = Processor.fromValue(reader.parseUnsignedShortVal());
 		frontEndMajorVersionNumber = reader.parseUnsignedShortVal();
 		frontEndMinorVersionNumber = reader.parseUnsignedShortVal();
@@ -84,6 +86,14 @@ public AbstractCompile2MsSymbol(AbstractPdb pdb, PdbByteReader reader, StringPar
 		pdb.setTargetProcessor(processor);
 	}
 
+	/**
+	 * Returns the packed flags.
+	 * @return the packed flags.
+	 */
+	public long getFlags() {
+		return flags;
+	}
+
 	/**
 	 * Returns the language used.
 	 * @return Language.

Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb2/pdbreader/symbol/Compile3MsSymbol.java

@@ -27,6 +27,7 @@ public class Compile3MsSymbol extends AbstractMsSymbol {
 
 	public static final int PDB_ID = 0x113c;
 
+	protected long flags;
 	protected LanguageName language;
 	protected boolean compiledForEditAndContinue;
 	protected boolean notCompiledWithDebugInfo;
@@ -60,7 +61,8 @@ public class Compile3MsSymbol extends AbstractMsSymbol {
 	 */
 	public Compile3MsSymbol(AbstractPdb pdb, PdbByteReader reader) throws PdbException {
 		super(pdb, reader);
-		processFlags(reader.parseUnsignedIntVal());
+		flags = reader.parseUnsignedIntVal();
+		processFlags(flags);
 		processor = Processor.fromValue(reader.parseUnsignedShortVal());
 		frontEndMajorVersionNumber = reader.parseUnsignedShortVal();
 		frontEndMinorVersionNumber = reader.parseUnsignedShortVal();
@@ -82,6 +84,14 @@ public int getPdbId() {
 		return PDB_ID;
 	}
 
+	/**
+	 * Returns the packed flags.
+	 * @return the packed flags.
+	 */
+	public long getFlags() {
+		return flags;
+	}
+
 	/**
 	 * Returns the language.
 	 * @return Language.

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/AbstractComplexTypeApplier.java

@@ -34,18 +34,18 @@ public abstract class AbstractComplexTypeApplier extends MsTypeApplier {
 	protected AbstractComplexTypeApplier definitionApplier = null;
 	protected AbstractComplexTypeApplier forwardReferenceApplier = null;
 
-	public static AbstractComplexTypeApplier getComplexApplier(PdbApplicator applicator,
+	public static AbstractComplexTypeApplier getComplexApplier(DefaultPdbApplicator applicator,
 			RecordNumber recordNumber) throws PdbException {
 		return (AbstractComplexTypeApplier) applicator.getApplierSpec(recordNumber,
 			AbstractComplexTypeApplier.class);
 	}
 
 	/**
 	 * Constructor for complex type applier.
-	 * @param applicator {@link PdbApplicator} for which this class is working.
+	 * @param applicator {@link DefaultPdbApplicator} for which this class is working.
 	 * @param msType {@link AbstractComplexMsType} to process.
 	 */
-	public AbstractComplexTypeApplier(PdbApplicator applicator, AbstractComplexMsType msType) {
+	public AbstractComplexTypeApplier(DefaultPdbApplicator applicator, AbstractComplexMsType msType) {
 		super(applicator, msType);
 		String fullPathName = msType.getName();
 		symbolPath = new SymbolPath(SymbolPathParser.parse(fullPathName));

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/AbstractFunctionTypeApplier.java

@@ -38,10 +38,10 @@ public abstract class AbstractFunctionTypeApplier extends MsTypeApplier {
 	/**
 	 * Constructor for the applicator that applies a "function" type, transforming it into a
 	 * Ghidra DataType.
-	 * @param applicator {@link PdbApplicator} for which this class is working.
+	 * @param applicator {@link DefaultPdbApplicator} for which this class is working.
 	 * @param msType {@link AbstractMsType} to processes
 	 */
-	public AbstractFunctionTypeApplier(PdbApplicator applicator, AbstractMsType msType) {
+	public AbstractFunctionTypeApplier(DefaultPdbApplicator applicator, AbstractMsType msType) {
 		super(applicator, msType);
 //		String funcName = applicator.getNextAnonymousFunctionName();
 		functionDefinition = new FunctionDefinitionDataType(
@@ -224,8 +224,8 @@ private boolean setReturnType() {
 		return true;
 	}
 
-	private void setCallingConvention(PdbApplicator applicator, CallingConvention callingConvention,
-			boolean hasThisPointer) {
+	private void setCallingConvention(DefaultPdbApplicator applicator,
+			CallingConvention callingConvention, boolean hasThisPointer) {
 		GenericCallingConvention convention;
 		if (hasThisPointer) {
 			convention = GenericCallingConvention.thiscall;

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/ArgumentsListTypeApplier.java

@@ -32,12 +32,12 @@ public class ArgumentsListTypeApplier extends MsTypeApplier {
 
 	/**
 	 * Constructor for the applicator that applies a arguments list.
-	 * @param applicator {@link PdbApplicator} for which this class is working.
+	 * @param applicator {@link DefaultPdbApplicator} for which this class is working.
 	 * @param msType {@link AbstractArgumentsListMsType} to processes.
 	 * @throws IllegalArgumentException Upon invalid arguments.
 	 */
-	public ArgumentsListTypeApplier(PdbApplicator applicator, AbstractArgumentsListMsType msType)
-			throws IllegalArgumentException {
+	public ArgumentsListTypeApplier(DefaultPdbApplicator applicator,
+			AbstractArgumentsListMsType msType) throws IllegalArgumentException {
 		super(applicator, msType);
 	}
 
@@ -110,7 +110,7 @@ void checkForDependencies(AbstractFunctionTypeApplier functionApplier)
 	}
 
 	/**
-	 * Apply this to function ({@link AbstractFunctionTypeApplier}). 
+	 * Apply this to function ({@link AbstractFunctionTypeApplier}).
 	 * @param functionApplier the {@link AbstractFunctionTypeApplier} to which to apply the
 	 * arguments.
 	 * @throws CancelledException Upon user cancellation
@@ -172,7 +172,7 @@ void applyTo(AbstractFunctionTypeApplier functionApplier) throws CancelledExcept
 	}
 
 //	/**
-//	 * Apply this to function ({@link AbstractFunctionTypeApplier}). 
+//	 * Apply this to function ({@link AbstractFunctionTypeApplier}).
 //	 * @param functionApplier the {@link AbstractFunctionTypeApplier} to which to apply the
 //	 * arguments.
 //	 * @throws PdbException when unexpected function internals are found.
@@ -221,5 +221,5 @@ void applyTo(AbstractFunctionTypeApplier functionApplier) throws CancelledExcept
 //		functionDefinition.setArguments(parameterDefinitionList.toArray(
 //			new ParameterDefinition[parameterDefinitionList.size()]));
 //	}
-//	
+//
 }

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/ArrayTypeApplier.java

@@ -34,10 +34,10 @@ public class ArrayTypeApplier extends MsTypeApplier {
 	/**
 	 * Constructor for the applicator that applies a "array" type, transforming it into a
 	 * Ghidra DataType.
-	 * @param applicator {@link PdbApplicator} for which this class is working.
+	 * @param applicator {@link DefaultPdbApplicator} for which this class is working.
 	 * @param msType {@link AbstractArrayMsType} to processes.
 	 */
-	public ArrayTypeApplier(PdbApplicator applicator, AbstractArrayMsType msType) {
+	public ArrayTypeApplier(DefaultPdbApplicator applicator, AbstractArrayMsType msType) {
 		super(applicator, msType);
 	}
 
@@ -117,7 +117,7 @@ private void applyArrayMsType(AbstractArrayMsType type) {
 		}
 
 		long longUnderlyingSize =
-			PdbApplicator.bigIntegerToLong(applicator, underlyingTypeApplier.getSize());
+			DefaultPdbApplicator.bigIntegerToLong(applicator, underlyingTypeApplier.getSize());
 		DataType underlyingDataType = underlyingTypeApplier.getDataType();
 
 		if (underlyingDataType == null) {

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/BaseClassTypeApplier.java

@@ -30,12 +30,12 @@ public class BaseClassTypeApplier extends MsTypeApplier {
 
 	/**
 	 * Constructor for base class applier.
-	 * @param applicator {@link PdbApplicator} for which this class is working.
+	 * @param applicator {@link DefaultPdbApplicator} for which this class is working.
 	 * @param msType {@link AbstractBaseClassMsType}, {@link AbstractVirtualBaseClassMsType}, or
 	 * {@link AbstractIndirectVirtualBaseClassMsType} to processes.
 	 * @throws IllegalArgumentException Upon invalid arguments.
 	 */
-	public BaseClassTypeApplier(PdbApplicator applicator, AbstractMsType msType)
+	public BaseClassTypeApplier(DefaultPdbApplicator applicator, AbstractMsType msType)
 			throws IllegalArgumentException {
 		super(applicator, validateType(msType));
 	}

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/BitfieldTypeApplier.java

@@ -32,10 +32,10 @@ public class BitfieldTypeApplier extends MsTypeApplier {
 
 	/**
 	 * Constructor for bitfield applier.
-	 * @param applicator {@link PdbApplicator} for which this class is working.
+	 * @param applicator {@link DefaultPdbApplicator} for which this class is working.
 	 * @param msType {@link AbstractBitfieldMsType} to processes
 	 */
-	public BitfieldTypeApplier(PdbApplicator applicator, AbstractBitfieldMsType msType) {
+	public BitfieldTypeApplier(DefaultPdbApplicator applicator, AbstractBitfieldMsType msType) {
 		super(applicator, msType);
 	}
 

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/BlockSymbolApplier.java

@@ -32,10 +32,10 @@ public class BlockSymbolApplier extends MsSymbolApplier {
 
 	/**
 	 * Constructor
-	 * @param applicator the {@link PdbApplicator} for which we are working.
+	 * @param applicator the {@link DefaultPdbApplicator} for which we are working.
 	 * @param iter the Iterator containing the symbol sequence being processed
 	 */
-	public BlockSymbolApplier(PdbApplicator applicator, AbstractMsSymbolIterator iter) {
+	public BlockSymbolApplier(DefaultPdbApplicator applicator, AbstractMsSymbolIterator iter) {
 		super(applicator, iter);
 		AbstractMsSymbol abstractSymbol = iter.next();
 		if (!(abstractSymbol instanceof AbstractBlockMsSymbol)) {

Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/ComplexTypeApplierMapper.java

@@ -33,14 +33,14 @@
 //  tried.
 public class ComplexTypeApplierMapper {
 
-	private PdbApplicator applicator;
+	private DefaultPdbApplicator applicator;
 
 //	private Map<SymbolPath, AbstractComplexTypeApplier> complexTypeAppliersBySymbolPath;
 	private Map<SymbolPath, LinkedList<AbstractComplexTypeApplier>> compositeAppliersQueueBySymbolPath;
 	private Map<SymbolPath, LinkedList<AbstractComplexTypeApplier>> enumAppliersQueueBySymbolPath;
 
 	//==============================================================================================
-	public ComplexTypeApplierMapper(PdbApplicator applicator) {
+	public ComplexTypeApplierMapper(DefaultPdbApplicator applicator) {
 		Objects.requireNonNull(applicator, "applicator cannot be null");
 		this.applicator = applicator;
 //		complexTypeAppliersBySymbolPath = new HashMap<>();