From faf73e8ecb26320a998da6af1a0dcb81c427657f Mon Sep 17 00:00:00 2001 From: dragonmacher <48328597+dragonmacher@users.noreply.github.com> Date: Thu, 16 Mar 2023 12:07:40 -0400 Subject: [PATCH] GP-3199 - Updated Version Tracking classes to make them public (Closes #4950) --- ...tionAndDataReferenceProgramCorrelator.java | 2 +- .../DataReferenceProgramCorrelator.java | 2 +- .../FunctionReferenceProgramCorrelator.java | 3 +- .../program/SimilarDataProgramCorrelator.java | 39 +++++++------------ .../SimilarSymbolNameProgramCorrelator.java | 24 ++++++------ .../VTAbstractReferenceProgramCorrelator.java | 3 +- .../api/util/VTAbstractProgramCorrelator.java | 2 +- .../vt/db/DummyTestProgramCorrelator.java | 5 ++- 8 files changed, 37 insertions(+), 43 deletions(-) diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/CombinedFunctionAndDataReferenceProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/CombinedFunctionAndDataReferenceProgramCorrelator.java index 3ad2c3a098..b3ac2456ec 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/CombinedFunctionAndDataReferenceProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/CombinedFunctionAndDataReferenceProgramCorrelator.java @@ -39,7 +39,7 @@ public class CombinedFunctionAndDataReferenceProgramCorrelator extends * @param correlatorName The correlator name string passed from the factory. * @param options {@code ToolOptions} */ - CombinedFunctionAndDataReferenceProgramCorrelator(ServiceProvider serviceProvider, + public CombinedFunctionAndDataReferenceProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, AddressSetView destinationAddressSet, String correlatorName, ToolOptions options) { super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/DataReferenceProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/DataReferenceProgramCorrelator.java index 4cb68971fe..d4692b887d 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/DataReferenceProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/DataReferenceProgramCorrelator.java @@ -38,7 +38,7 @@ public class DataReferenceProgramCorrelator extends VTAbstractReferenceProgramCo * @param correlatorName The correlator name string passed from the factory. * @param options {@code ToolOptions} */ - DataReferenceProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, + public DataReferenceProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, AddressSetView destinationAddressSet, String correlatorName, ToolOptions options) { super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/FunctionReferenceProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/FunctionReferenceProgramCorrelator.java index a7ad277e77..095ebcd13e 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/FunctionReferenceProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/FunctionReferenceProgramCorrelator.java @@ -37,7 +37,8 @@ public class FunctionReferenceProgramCorrelator extends VTAbstractReferenceProgr * @param correlatorName The correlator name string passed from the factory. * @param options {@code ToolOptions} */ - FunctionReferenceProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, + public FunctionReferenceProgramCorrelator(ServiceProvider serviceProvider, + Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, AddressSetView destinationAddressSet, String correlatorName, ToolOptions options) { super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarDataProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarDataProgramCorrelator.java index 537414b86a..fd7f0cfaa7 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarDataProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarDataProgramCorrelator.java @@ -15,11 +15,8 @@ */ package ghidra.feature.vt.api.correlator.program; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; +import java.util.*; import java.util.Map.Entry; -import java.util.Set; import generic.DominantPair; import generic.hash.FNV1a64MessageDigest; @@ -28,19 +25,13 @@ import generic.lsh.KandL; import generic.lsh.LSHMemoryModel; import generic.lsh.vector.LSHCosineVectorAccum; import generic.lsh.vector.VectorCompare; -import ghidra.feature.vt.api.main.VTAssociationType; -import ghidra.feature.vt.api.main.VTMatchInfo; -import ghidra.feature.vt.api.main.VTMatchSet; -import ghidra.feature.vt.api.main.VTScore; +import ghidra.feature.vt.api.main.*; import ghidra.feature.vt.api.util.VTAbstractProgramCorrelator; import ghidra.framework.options.ToolOptions; import ghidra.framework.plugintool.ServiceProvider; import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressSetView; -import ghidra.program.model.listing.Data; -import ghidra.program.model.listing.DataIterator; -import ghidra.program.model.listing.Listing; -import ghidra.program.model.listing.Program; +import ghidra.program.model.listing.*; import ghidra.program.model.mem.MemoryAccessException; import ghidra.util.exception.CancelledException; import ghidra.util.task.TaskMonitor; @@ -49,13 +40,6 @@ public class SimilarDataProgramCorrelator extends VTAbstractProgramCorrelator { public static final double SIMILARITY_THRESHOLD = 0.5; - protected SimilarDataProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, - AddressSetView sourceAddressSet, Program destinationProgram, - AddressSetView destinationAddressSet, ToolOptions options) { - super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, - destinationAddressSet, options); - } - HashMap sourceMap; HashMap destinationMap; @@ -64,6 +48,13 @@ public class SimilarDataProgramCorrelator extends VTAbstractProgramCorrelator { int featureID = 0; int minDataLength; + public SimilarDataProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, + AddressSetView sourceAddressSet, Program destinationProgram, + AddressSetView destinationAddressSet, ToolOptions options) { + super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, + destinationAddressSet, options); + } + @Override protected void doCorrelate(VTMatchSet matchSet, TaskMonitor monitor) throws CancelledException { minDataLength = @@ -92,9 +83,9 @@ public class SimilarDataProgramCorrelator extends VTAbstractProgramCorrelator { private void extractNGramFeatures(VTMatchSet matchSet, boolean skipHomogenousData, TaskMonitor monitor, int n) throws CancelledException { - sourceMap = new HashMap(); - destinationMap = new HashMap(); - idMap = new HashMap(); + sourceMap = new HashMap<>(); + destinationMap = new HashMap<>(); + idMap = new HashMap<>(); final Program sourceProgram = getSourceProgram(); final Program destinationProgram = getDestinationProgram(); @@ -233,7 +224,7 @@ public class SimilarDataProgramCorrelator extends VTAbstractProgramCorrelator { LSHCosineVectorAccum destinationVector, Set> neighbors, double threshold, TaskMonitor monitor) { - List result = new ArrayList(); + List result = new ArrayList<>(); Listing sourceListing = getSourceProgram().getListing(); Listing destinationListing = getDestinationProgram().getListing(); @@ -289,7 +280,7 @@ public class SimilarDataProgramCorrelator extends VTAbstractProgramCorrelator { getOptions().getEnum(SimilarDataProgramCorrelatorFactory.MEMORY_MODEL, SimilarDataProgramCorrelatorFactory.MEMORY_MODEL_DEFAULT); int L = KandL.memoryModelToL(model); - return new LSHMultiHash
(model.getK(), L); + return new LSHMultiHash<>(model.getK(), L); } @Override diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarSymbolNameProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarSymbolNameProgramCorrelator.java index 5e56df1c7a..9fe6ccc5c9 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarSymbolNameProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/SimilarSymbolNameProgramCorrelator.java @@ -38,13 +38,6 @@ public class SimilarSymbolNameProgramCorrelator extends VTAbstractProgramCorrela public static double SIMILARITY_THRESHOLD = 0.5; - protected SimilarSymbolNameProgramCorrelator(ServiceProvider serviceProvider, - Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, - AddressSetView destinationAddressSet, ToolOptions options) { - super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, - destinationAddressSet, options); - } - HashMap sourceMap; HashMap destinationMap; @@ -53,6 +46,13 @@ public class SimilarSymbolNameProgramCorrelator extends VTAbstractProgramCorrela int featureID = 0; int minNameLength; + public SimilarSymbolNameProgramCorrelator(ServiceProvider serviceProvider, + Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, + AddressSetView destinationAddressSet, ToolOptions options) { + super(serviceProvider, sourceProgram, sourceAddressSet, destinationProgram, + destinationAddressSet, options); + } + @Override protected void doCorrelate(VTMatchSet matchSet, TaskMonitor monitor) throws CancelledException { minNameLength = @@ -68,9 +68,9 @@ public class SimilarSymbolNameProgramCorrelator extends VTAbstractProgramCorrela } private void extractNGramFeatures(VTMatchSet matchSet, TaskMonitor monitor, int n) { - sourceMap = new HashMap(); - destinationMap = new HashMap(); - idMap = new HashMap(); + sourceMap = new HashMap<>(); + destinationMap = new HashMap<>(); + idMap = new HashMap<>(); final Program sourceProgram = getSourceProgram(); final Program destinationProgram = getDestinationProgram(); @@ -183,7 +183,7 @@ public class SimilarSymbolNameProgramCorrelator extends VTAbstractProgramCorrela LSHCosineVectorAccum destinationVector, Set> neighbors, double threshold, TaskMonitor monitor) { - List result = new ArrayList(); + List result = new ArrayList<>(); int sourceLength = 0; int destinationLength = 0; @@ -271,7 +271,7 @@ public class SimilarSymbolNameProgramCorrelator extends VTAbstractProgramCorrela getOptions().getEnum(SimilarSymbolNameProgramCorrelatorFactory.MEMORY_MODEL, SimilarSymbolNameProgramCorrelatorFactory.MEMORY_MODEL_DEFAULT); int L = KandL.memoryModelToL(model); - return new LSHMultiHash(model.getK(), L); + return new LSHMultiHash<>(model.getK(), L); } @Override diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/VTAbstractReferenceProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/VTAbstractReferenceProgramCorrelator.java index c243870453..779e5b03e0 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/VTAbstractReferenceProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/correlator/program/VTAbstractReferenceProgramCorrelator.java @@ -70,7 +70,8 @@ public abstract class VTAbstractReferenceProgramCorrelator extends VTAbstractPro * @param correlatorName the correlator name * @param options the tool options */ - VTAbstractReferenceProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, + public VTAbstractReferenceProgramCorrelator(ServiceProvider serviceProvider, + Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, AddressSetView destinationAddressSet, String correlatorName, ToolOptions options) { // Call the constructor for the parent class. diff --git a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/util/VTAbstractProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/util/VTAbstractProgramCorrelator.java index 23a40a3736..13514f6d7a 100644 --- a/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/util/VTAbstractProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/api/util/VTAbstractProgramCorrelator.java @@ -51,7 +51,7 @@ public abstract class VTAbstractProgramCorrelator implements VTProgramCorrelator * @param options An Options object that contains the set of options to be used by the * correlating algorithm. */ - protected VTAbstractProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, + public VTAbstractProgramCorrelator(ServiceProvider serviceProvider, Program sourceProgram, AddressSetView sourceAddressSet, Program destinationProgram, AddressSetView destinationAddressSet, ToolOptions options) { this.serviceProvider = serviceProvider; diff --git a/Ghidra/Features/VersionTracking/src/test/java/ghidra/feature/vt/db/DummyTestProgramCorrelator.java b/Ghidra/Features/VersionTracking/src/test/java/ghidra/feature/vt/db/DummyTestProgramCorrelator.java index c181a08814..4b9e227245 100644 --- a/Ghidra/Features/VersionTracking/src/test/java/ghidra/feature/vt/db/DummyTestProgramCorrelator.java +++ b/Ghidra/Features/VersionTracking/src/test/java/ghidra/feature/vt/db/DummyTestProgramCorrelator.java @@ -30,7 +30,7 @@ public class DummyTestProgramCorrelator extends VTAbstractProgramCorrelator { private int matchCount = 1; - protected DummyTestProgramCorrelator() { + public DummyTestProgramCorrelator() { this(1); } @@ -47,7 +47,7 @@ public class DummyTestProgramCorrelator extends VTAbstractProgramCorrelator { createAddressSet(), createOptions()); } - protected DummyTestProgramCorrelator(int matchCount) { + public DummyTestProgramCorrelator(int matchCount) { super(null, null, createAddressSet(), null, createAddressSet(), createOptions()); this.matchCount = matchCount; } @@ -88,6 +88,7 @@ public class DummyTestProgramCorrelator extends VTAbstractProgramCorrelator { } } + @Override public String getName() { return "DummyTestProgramCorrelator"; }