callingConventions =
- function.getProgram().getFunctionManager().getCallingConventionNames();
- String[] choices = callingConventions.toArray(new String[callingConventions.size()]);
- setCallingConventionChoices(choices);
- parentPanel.add(new GLabel("Calling Convention:"));
- parentPanel.add(callingConventionComboBox);
- }
-
- protected void installInlineWidget(JPanel parentPanel) {
- inlineCheckBox = new GCheckBox("Inline");
- inlineCheckBox.addChangeListener(e -> {
- if (inlineCheckBox.isSelected() && callFixupComboBox != null) {
- callFixupComboBox.setSelectedItem(NONE_CHOICE);
- }
- });
- parentPanel.add(inlineCheckBox);
- }
-
- protected void installNoReturnWidget(JPanel parentPanel) {
- noReturnCheckBox = new GCheckBox("No Return");
- parentPanel.add(noReturnCheckBox);
- }
-
- private JPanel buildCallFixupPanel() {
-
- String[] callFixupNames =
- function.getProgram().getCompilerSpec().getPcodeInjectLibrary().getCallFixupNames();
- if (callFixupNames.length == 0) {
- return null;
- }
-
- JPanel callFixupPanel = new JPanel();
- callFixupPanel.setLayout(new BoxLayout(callFixupPanel, BoxLayout.X_AXIS));
-
- callFixupComboBox = new GhidraComboBox<>();
- callFixupComboBox.addItem(NONE_CHOICE);
- for (String element : callFixupNames) {
- callFixupComboBox.addItem(element);
- }
-
- callFixupComboBox.addItemListener(e -> {
- if (e.getStateChange() == ItemEvent.DESELECTED) {
- return;
- }
- if (!NONE_CHOICE.equals(e.getItem())) {
- inlineCheckBox.setSelected(false);
- }
- });
-
- String callFixupName = function.getCallFixup();
- if (callFixupName != null) {
- callFixupComboBox.setSelectedItem(callFixupName);
- }
-
- callFixupPanel.add(new GLabel("Call-Fixup:"));
- callFixupPanel.add(callFixupComboBox);
-
- callFixupPanel.add(Box.createGlue());
- callFixupPanel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
-
- return callFixupPanel;
- }
-
- protected PluginTool getTool() {
- return tool;
- }
-
- protected Program getProgram() {
- return function.getProgram();
- }
-
- protected Function getFunction() {
- return function;
- }
-
- public String getSignature() {
- return signatureField.getText();
- }
-
- protected void setSignature(String signature) {
- signatureField.setText(signature);
- }
-
- protected void setCallingConventionChoices(String[] callingConventions) {
- callingConventionComboBox.removeAllItems();
- for (String element : callingConventions) {
- callingConventionComboBox.addItem(element);
- }
- }
-
- protected String getCallingConvention() {
- return (String) callingConventionComboBox.getSelectedItem();
- }
-
- protected void setCallingConvention(String callingConvention) {
- callingConventionComboBox.setSelectedItem(callingConvention);
- }
-
- protected boolean isInlineSelected() {
- return inlineCheckBox.isSelected();
- }
-
- protected void setInlineSelected(boolean selected) {
- inlineCheckBox.setSelected(selected);
- }
-
- protected boolean hasNoReturnSelected() {
- return noReturnCheckBox.isSelected();
- }
-
- protected void setNoReturnSelected(boolean selected) {
- noReturnCheckBox.setSelected(selected);
- }
-
- protected String getCallFixupSelection() {
- if (callFixupComboBox != null) {
- String callFixup = (String) callFixupComboBox.getSelectedItem();
- if (callFixup != null && !NONE_CHOICE.equals(callFixup)) {
- return callFixup;
- }
- }
- return null;
- }
-
- /**
- * This method gets called when the user clicks on the OK Button. The base
- * class calls this method.
- */
- @Override
- protected void okCallback() {
- // only close the dialog if the user made valid changes
- try {
- if (applyChanges()) {
- close();
- }
- }
- catch (CancelledException e) {
- // ignore - do not close
- }
- }
-
- @Override
- protected void cancelCallback() {
- setStatusText("");
- close();
+ private static boolean allowCallFixup(Function function) {
+ return getCallFixupNames(function) != null;
}
/**
@@ -318,6 +140,7 @@ public class EditFunctionSignatureDialog extends DialogComponentProvider {
* @return true if the command was successfully created.
* @throws CancelledException if operation cancelled by user
*/
+ @Override
protected boolean applyChanges() throws CancelledException {
// create the command
Command command = createCommand();
@@ -327,7 +150,7 @@ public class EditFunctionSignatureDialog extends DialogComponentProvider {
}
// run the command
- if (!getTool().execute(command, getProgram())) {
+ if (!getTool().execute(command, function.getProgram())) {
setStatusText(command.getStatusMsg());
return false;
}
@@ -336,25 +159,16 @@ public class EditFunctionSignatureDialog extends DialogComponentProvider {
return true;
}
- protected FunctionDefinitionDataType parseSignature() throws CancelledException {
- FunctionSignatureParser parser = new FunctionSignatureParser(
- getProgram().getDataTypeManager(), tool.getService(DataTypeManagerService.class));
- try {
- return parser.parse(getFunction().getSignature(), getSignature());
- }
- catch (ParseException e) {
- setStatusText("Invalid Signature: " + e.getMessage());
- }
- return null;
- }
-
private Command createCommand() throws CancelledException {
Command cmd = null;
- if (!getSignature().equals(this.oldFunctionSignature) || !isSameCallingConvention() ||
+ if (isSignatureChanged() || isCallingConventionChanged() ||
(function.getSignatureSource() == SourceType.DEFAULT)) {
FunctionDefinitionDataType definition = parseSignature();
+ if (definition == null) {
+ return null;
+ }
cmd = new ApplyFunctionSignatureCmd(function.getEntryPoint(), definition,
SourceType.USER_DEFINED, true, true);
}
@@ -394,85 +208,67 @@ public class EditFunctionSignatureDialog extends DialogComponentProvider {
return errMsg;
}
});
- compoundCommand.add(new Command() {
- @Override
- public boolean applyTo(DomainObject obj) {
- function.setInline(isInlineSelected());
- return true;
- }
+ if (allowInLine) {
+ compoundCommand.add(new Command() {
+ @Override
+ public boolean applyTo(DomainObject obj) {
+ function.setInline(isInlineSelected());
+ return true;
+ }
- @Override
- public String getName() {
- return "Update Function Inline Flag";
- }
+ @Override
+ public String getName() {
+ return "Update Function Inline Flag";
+ }
- @Override
- public String getStatusMsg() {
- return null;
- }
- });
- compoundCommand.add(new Command() {
- @Override
- public boolean applyTo(DomainObject obj) {
- function.setNoReturn(hasNoReturnSelected());
- return true;
- }
+ @Override
+ public String getStatusMsg() {
+ return null;
+ }
+ });
+ }
+ if (allowNoReturn) {
+ compoundCommand.add(new Command() {
+ @Override
+ public boolean applyTo(DomainObject obj) {
+ function.setNoReturn(hasNoReturnSelected());
+ return true;
+ }
- @Override
- public String getName() {
- return "Update Function No Return Flag";
- }
+ @Override
+ public String getName() {
+ return "Update Function No Return Flag";
+ }
- @Override
- public String getStatusMsg() {
- return null;
- }
- });
- compoundCommand.add(new Command() {
- @Override
- public boolean applyTo(DomainObject obj) {
- function.setCallFixup(getCallFixupSelection());
- return true;
- }
+ @Override
+ public String getStatusMsg() {
+ return null;
+ }
+ });
+ }
+ if (allowCallFixup) {
+ compoundCommand.add(new Command() {
+ @Override
+ public boolean applyTo(DomainObject obj) {
+ function.setCallFixup(getCallFixupSelection());
+ return true;
+ }
- @Override
- public String getName() {
- return "Update Function Call-Fixup";
- }
+ @Override
+ public String getName() {
+ return "Update Function Call-Fixup";
+ }
- @Override
- public String getStatusMsg() {
- return null;
- }
- });
+ @Override
+ public String getStatusMsg() {
+ return null;
+ }
+ });
+ }
if (cmd != null) {
compoundCommand.add(cmd);
}
return compoundCommand;
}
- private boolean isSameCallingConvention() {
- PrototypeModel conv = function.getCallingConvention();
- if (conv == null && this.getCallingConvention() == null) {
- return true;
- }
- if (conv == null && this.getCallingConvention().equals("default")) {
- return true;
- }
- if (conv == null && this.getCallingConvention().equals("unknown")) {
- return true;
- }
- if (conv == null) {
- return false;
- }
- if (conv.getName().equals(this.getCallingConvention())) {
- return true;
- }
- return false;
- }
-
- @Override
- protected void dialogShown() {
- signatureField.selectAll();
- }
}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java
index 9ee8a34e80..e9f54b7a95 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/strings/ViewStringsPlugin.java
@@ -15,12 +15,11 @@
*/
package ghidra.app.plugin.core.strings;
-import javax.swing.ImageIcon;
+import javax.swing.Icon;
import docking.ActionContext;
import docking.action.*;
import ghidra.app.CorePluginPackage;
-import ghidra.app.events.ProgramSelectionPluginEvent;
import ghidra.app.plugin.PluginCategoryNames;
import ghidra.app.plugin.ProgramPlugin;
import ghidra.app.plugin.core.data.DataSettingsDialog;
@@ -38,6 +37,7 @@ import ghidra.util.table.SelectionNavigationAction;
import ghidra.util.table.actions.MakeProgramSelectionAction;
import ghidra.util.task.SwingUpdateManager;
import resources.Icons;
+import resources.ResourceManager;
/**
* Plugin that provides the "Defined Strings" table, where all the currently defined
@@ -57,7 +57,11 @@ import resources.Icons;
//@formatter:on
public class ViewStringsPlugin extends ProgramPlugin implements DomainObjectListener {
- private DockingAction selectAction;
+ private static Icon REFRESH_ICON = Icons.REFRESH_ICON;
+ private static Icon REFRESH_NOT_NEEDED_ICON =
+ ResourceManager.getDisabledIcon(Icons.REFRESH_ICON, 60);
+
+ private DockingAction refreshAction;
private DockingAction showSettingsAction;
private DockingAction showDefaultSettingsAction;
private SelectionNavigationAction linkNavigationAction;
@@ -82,7 +86,7 @@ public class ViewStringsPlugin extends ProgramPlugin implements DomainObjectList
}
private void createActions() {
- DockingAction refreshAction = new DockingAction("Refresh Strings", getName()) {
+ refreshAction = new DockingAction("Refresh Strings", getName()) {
@Override
public boolean isEnabledForContext(ActionContext context) {
@@ -91,12 +95,14 @@ public class ViewStringsPlugin extends ProgramPlugin implements DomainObjectList
@Override
public void actionPerformed(ActionContext context) {
+ getToolBarData().setIcon(REFRESH_NOT_NEEDED_ICON);
reload();
}
};
- ImageIcon refreshIcon = Icons.REFRESH_ICON;
- refreshAction.setDescription("Reloads all string data from the program");
- refreshAction.setToolBarData(new ToolBarData(refreshIcon));
+ refreshAction.setToolBarData(new ToolBarData(REFRESH_NOT_NEEDED_ICON));
+ refreshAction.setDescription(
+ "Push at any time to refresh the current table of strings.
" +
+ "This button is highlighted when the data may be stale.
");
refreshAction.setHelpLocation(new HelpLocation("ViewStringsPlugin", "Refresh"));
tool.addLocalAction(provider, refreshAction);
@@ -152,13 +158,6 @@ public class ViewStringsPlugin extends ProgramPlugin implements DomainObjectList
}
- private void selectData(ProgramSelection selection) {
- ProgramSelectionPluginEvent pspe =
- new ProgramSelectionPluginEvent("Selection", selection, currentProgram);
- firePluginEvent(pspe);
- processEvent(pspe);
- }
-
@Override
public void dispose() {
reloadUpdateMgr.dispose();
@@ -186,45 +185,50 @@ public class ViewStringsPlugin extends ProgramPlugin implements DomainObjectList
}
}
+ private void markDataAsStale() {
+ provider.getComponent().repaint();
+ refreshAction.getToolBarData().setIcon(REFRESH_ICON);
+ }
+
@Override
public void domainObjectChanged(DomainObjectChangedEvent ev) {
+
if (ev.containsEvent(DomainObject.DO_OBJECT_RESTORED) ||
ev.containsEvent(ChangeManager.DOCR_MEMORY_BLOCK_MOVED) ||
ev.containsEvent(ChangeManager.DOCR_MEMORY_BLOCK_REMOVED) ||
- ev.containsEvent(ChangeManager.DOCR_CODE_REMOVED) ||
ev.containsEvent(ChangeManager.DOCR_DATA_TYPE_CHANGED)) {
- reload();
-
+ markDataAsStale();
+ return;
}
- else if (ev.containsEvent(ChangeManager.DOCR_CODE_ADDED)) {
- for (int i = 0; i < ev.numRecords(); ++i) {
- DomainObjectChangeRecord doRecord = ev.getChangeRecord(i);
- Object newValue = doRecord.getNewValue();
- switch (doRecord.getEventType()) {
- case ChangeManager.DOCR_CODE_REMOVED:
- case ChangeManager.DOCR_COMPOSITE_ADDED:
- ProgramChangeRecord pcRec = (ProgramChangeRecord) doRecord;
- provider.remove(pcRec.getStart(), pcRec.getEnd());
- break;
- case ChangeManager.DOCR_CODE_ADDED:
- if (newValue instanceof Data) {
- provider.add((Data) newValue);
- }
- break;
- default:
- //Msg.info(this, "Unhandled event type: " + doRecord.getEventType());
- break;
- }
+
+ for (int i = 0; i < ev.numRecords(); ++i) {
+
+ DomainObjectChangeRecord doRecord = ev.getChangeRecord(i);
+ Object newValue = doRecord.getNewValue();
+ switch (doRecord.getEventType()) {
+ case ChangeManager.DOCR_CODE_REMOVED:
+ ProgramChangeRecord pcRec = (ProgramChangeRecord) doRecord;
+ provider.remove(pcRec.getStart(), pcRec.getEnd());
+ break;
+ case ChangeManager.DOCR_CODE_ADDED:
+ if (newValue instanceof Data) {
+ provider.add((Data) newValue);
+ }
+ break;
+ default:
+ //Msg.info(this, "Unhandled event type: " + doRecord.getEventType());
+ break;
}
}
- else if (ev.containsEvent(ChangeManager.DOCR_DATA_TYPE_SETTING_CHANGED)) {
+
+ if (ev.containsEvent(ChangeManager.DOCR_DATA_TYPE_SETTING_CHANGED)) {
// Unusual code: because the table model goes directly to the settings values
// during each repaint, we don't need to figure out which row was changed.
provider.getComponent().repaint();
}
}
- void reload() {
+ private void reload() {
reloadUpdateMgr.update();
}
}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableAddRemoveStrategy.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableAddRemoveStrategy.java
new file mode 100644
index 0000000000..f6cbefa1e2
--- /dev/null
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableAddRemoveStrategy.java
@@ -0,0 +1,85 @@
+/* ###
+ * 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.plugin.core.symtable;
+
+import java.util.*;
+
+import docking.widgets.table.AddRemoveListItem;
+import docking.widgets.table.threaded.TableAddRemoveStrategy;
+import docking.widgets.table.threaded.TableData;
+import ghidra.util.exception.CancelledException;
+import ghidra.util.task.TaskMonitor;
+
+/**
+ * This strategy attempts to optimize removal of db objects that have been deleted. The issue with
+ * deleted db objects is that they may no longer have their attributes, which means we cannot
+ * use any of those attributes that may have been used as the basis for sorting. We use the
+ * table's sort to perform a binary search of existing symbols for removal. If the binary search
+ * does not work, then removal operations will require slow list traversal. Additionally,
+ * some clients use proxy objects in add/remove list to signal which object needs to be removed,
+ * since the original object is no longer available to the client. Using these proxy objects
+ * in a binary search may lead to exceptions if the proxy has unsupported methods called when
+ * searching.
+ *
+ * This strategy will has guilty knowledge of client proxy object usage. The proxy objects
+ * are coded such that the {@code hashCode()} and {@code equals()} methods will match those
+ * methods of the data's real objects.
+ *
+ * @param the row type
+ */
+public class SymbolTableAddRemoveStrategy implements TableAddRemoveStrategy {
+
+ @Override
+ public void process(List> addRemoveList, TableData tableData,
+ TaskMonitor monitor) throws CancelledException {
+
+ //
+ // Hash map the existing values so that we can use any object inside the add/remove list
+ // as a key into this map to get the matching existing value.
+ //
+ Map hashed = new HashMap<>();
+ for (T t : tableData) {
+ hashed.put(t, t);
+ }
+
+ int n = addRemoveList.size();
+ monitor.setMessage("Adding/Removing " + n + " items...");
+ monitor.initialize(n);
+ for (int i = 0; i < n; i++) {
+ AddRemoveListItem item = addRemoveList.get(i);
+ T value = item.getValue();
+ if (item.isChange()) {
+ T toRemove = hashed.get(value);
+ if (toRemove != null) {
+ tableData.remove(toRemove);
+ }
+ tableData.insert(value);
+ }
+ else if (item.isRemove()) {
+ T toRemove = hashed.get(value);
+ if (toRemove != null) {
+ tableData.remove(toRemove);
+ }
+ }
+ else if (item.isAdd()) {
+ tableData.insert(value);
+ }
+ monitor.checkCanceled();
+ monitor.setProgress(i);
+ }
+ monitor.setMessage("Done adding/removing");
+ }
+}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableModel.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableModel.java
index fb922b22c0..c20783ca38 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableModel.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/symtable/SymbolTableModel.java
@@ -18,6 +18,7 @@ package ghidra.app.plugin.core.symtable;
import java.util.*;
import docking.widgets.table.*;
+import docking.widgets.table.threaded.TableAddRemoveStrategy;
import ghidra.app.cmd.function.DeleteFunctionCmd;
import ghidra.app.cmd.label.DeleteLabelCmd;
import ghidra.app.cmd.label.RenameLabelCmd;
@@ -60,6 +61,8 @@ class SymbolTableModel extends AddressBasedTableModel {
private ReferenceManager refMgr;
private Symbol lastSymbol;
private SymbolFilter filter;
+ private TableAddRemoveStrategy deletedDbObjectAddRemoveStrategy =
+ new SymbolTableAddRemoveStrategy<>();
SymbolTableModel(SymbolProvider provider, PluginTool tool) {
super("Symbols", tool, null, null);
@@ -88,6 +91,11 @@ class SymbolTableModel extends AddressBasedTableModel {
return descriptor;
}
+ @Override
+ protected TableAddRemoveStrategy getAddRemoveStrategy() {
+ return deletedDbObjectAddRemoveStrategy;
+ }
+
void setFilter(SymbolFilter filter) {
this.filter = filter;
reload();
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraState.java b/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraState.java
index 2ec73d6898..32b7161418 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraState.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/script/GhidraState.java
@@ -29,6 +29,7 @@ import ghidra.program.model.address.AddressSet;
import ghidra.program.model.listing.Program;
import ghidra.program.util.ProgramLocation;
import ghidra.program.util.ProgramSelection;
+import ghidra.util.Swing;
import ghidra.util.SystemUtilities;
/**
@@ -64,7 +65,9 @@ public class GhidraState {
this.currentHighlight = highlight;
this.isGlobalState = true;
if (!SystemUtilities.isInHeadlessMode()) {
- gatherParamPanel = new GatherParamPanel(this);
+ Swing.runNow(() -> {
+ gatherParamPanel = new GatherParamPanel(this);
+ });
}
}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunction.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunction.java
index cc0e591505..60a759ac82 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunction.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/demangler/DemangledFunction.java
@@ -349,14 +349,26 @@ public class DemangledFunction extends DemangledObject {
Function function = createFunction(program, address, options.doDisassembly(), monitor);
if (function == null) {
- // no function whose signature we need to update
- // NOTE: this does not make much sense
- // renameExistingSymbol(program, address, symbolTable);
- // maybeCreateUndefined(program, address);
+ // No function whose signature we need to update
return false;
}
- //if existing function signature is user defined - add demangled label only
+ if (function.isThunk()) {
+ // If thunked function has same mangled name we can discard our
+ // symbol if no other symbols at this address (i.e., rely entirely on
+ // thunked function).
+ // NOTE: mangled name on external may be lost once it is demangled.
+ if (shouldThunkBePreserved(function)) {
+ // Preserve thunk and remove mangled symbol. Allow to proceed normally by returning true.
+ function.getSymbol().setName(null, SourceType.DEFAULT);
+ return true;
+ }
+
+ // Break thunk relationship and continue applying demangle function below
+ function.setThunkedFunction(null);
+ }
+
+ // If existing function signature is user defined - add demangled label only
boolean makePrimary = (function.getSignatureSource() != SourceType.USER_DEFINED);
Symbol demangledSymbol =
@@ -395,6 +407,65 @@ public class DemangledFunction extends DemangledObject {
return true;
}
+ /**
+ * Determine if existing thunk relationship should be preserved and mangled symbol
+ * discarded. This is the case when the thunk function mangled name matches
+ * the thunked function since we want to avoid duplicate symbol names.
+ * @param thunkFunction thunk function with a mangled symbol which is currently
+ * being demangled.
+ * @return true if thunk should be preserved and mangled symbol discarded, otherwise
+ * false if thunk relationship should be eliminated and demangled function information
+ * should be applied as normal.
+ */
+ private boolean shouldThunkBePreserved(Function thunkFunction) {
+ Program program = thunkFunction.getProgram();
+ SymbolTable symbolTable = program.getSymbolTable();
+ if (thunkFunction.getSymbol().isExternalEntryPoint()) {
+ return false; // entry point should retain its own symbol
+ }
+ Symbol[] symbols = symbolTable.getSymbols(thunkFunction.getEntryPoint());
+ if (symbols.length > 1) {
+ return false; // too many symbols present to preserve thunk
+ }
+ // NOTE: order of demangling unknown - thunked function may, or may not, have
+ // already been demangled
+ Function thunkedFunction = thunkFunction.getThunkedFunction(true);
+ if (mangled.equals(thunkedFunction.getName())) {
+ // thunked function has matching mangled name
+ return true;
+ }
+ if (thunkedFunction.isExternal()) {
+ if (thunkedFunction.getParentNamespace() instanceof Library) {
+ // Thunked function does not have mangled name, if it did it would have
+ // matched name check above or now reside in a different namespace
+ return false;
+ }
+ // assume external contained with specific namespace
+ ExternalLocation externalLocation =
+ program.getExternalManager().getExternalLocation(thunkedFunction.getSymbol());
+ String originalImportedName = externalLocation.getOriginalImportedName();
+ if (originalImportedName == null) {
+ // assume external manually manipulated without use of mangled name
+ return false;
+ }
+ if (mangled.equals(externalLocation.getOriginalImportedName())) {
+ // matching mangled name also resides at thunked function location
+ return true;
+ }
+
+ // TODO: carefully compare signature in absense of matching mangled name
+ return false;
+ }
+
+ if (symbolTable.getSymbol(mangled, thunkedFunction.getEntryPoint(),
+ program.getGlobalNamespace()) != null) {
+ // matching mangled name also resides at thunked function location
+ return true;
+ }
+
+ return false;
+ }
+
private boolean hasVarArgs() {
if (parameters.isEmpty()) {
return false;
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/html/FunctionDataTypeHTMLRepresentation.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/html/FunctionDataTypeHTMLRepresentation.java
index d2c780c871..ef8083b8fa 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/html/FunctionDataTypeHTMLRepresentation.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/html/FunctionDataTypeHTMLRepresentation.java
@@ -88,7 +88,7 @@ public class FunctionDataTypeHTMLRepresentation extends HTMLDataTypeRepresentati
GenericCallingConvention genericCallingConvention =
functionDefinition.getGenericCallingConvention();
String modifier = genericCallingConvention != GenericCallingConvention.unknown
- ? (" " + genericCallingConvention.name())
+ ? (" " + genericCallingConvention.getDeclarationName())
: "";
return new TextLine(
HTMLUtilities.friendlyEncodeHTML(returnDataType.getDisplayName()) + modifier);
diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeManagerPluginTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeManagerPluginTest.java
index e7adb329df..d91ff9750d 100644
--- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeManagerPluginTest.java
+++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/datamgr/DataTypeManagerPluginTest.java
@@ -50,7 +50,7 @@ import ghidra.app.plugin.core.datamgr.actions.CreateTypeDefDialog;
import ghidra.app.plugin.core.datamgr.archive.Archive;
import ghidra.app.plugin.core.datamgr.archive.DataTypeManagerHandler;
import ghidra.app.plugin.core.datamgr.tree.*;
-import ghidra.app.plugin.core.function.EditFunctionSignatureDialog;
+import ghidra.app.plugin.core.function.AbstractEditFunctionSignatureDialog;
import ghidra.app.plugin.core.programtree.ProgramTreePlugin;
import ghidra.app.services.ProgramManager;
import ghidra.app.util.datatype.DataTypeSelectionEditor;
@@ -695,11 +695,9 @@ public class DataTypeManagerPluginTest extends AbstractGhidraHeadedIntegrationTe
DataType dt = iter.next();
listTwo.add(dt);
}
- for (int i = 0; i < listOne.size(); i++) {
- DataType dt = listOne.get(i);
+ for (DataType dt : listOne) {
boolean found = false;
- for (int j = 0; j < listTwo.size(); j++) {
- DataType dt2 = listTwo.get(j);
+ for (DataType dt2 : listTwo) {
if (dt.isEquivalent(dt2)) {
found = true;
break;
@@ -807,8 +805,8 @@ public class DataTypeManagerPluginTest extends AbstractGhidraHeadedIntegrationTe
assertTrue(action.isEnabledForContext(treeContext));
performAction(action, treeContext, false);
- EditFunctionSignatureDialog dialog =
- waitForDialogComponent(EditFunctionSignatureDialog.class);
+ AbstractEditFunctionSignatureDialog dialog =
+ waitForDialogComponent(AbstractEditFunctionSignatureDialog.class);
JTextField textField = (JTextField) getInstanceField("signatureField", dialog);
setText(textField, newSignature);
diff --git a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/script/GhidraScriptAskMethodsTest.java b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/script/GhidraScriptAskMethodsTest.java
index 507a99625a..af8f7bc57b 100644
--- a/Ghidra/Features/Base/src/test.slow/java/ghidra/app/script/GhidraScriptAskMethodsTest.java
+++ b/Ghidra/Features/Base/src/test.slow/java/ghidra/app/script/GhidraScriptAskMethodsTest.java
@@ -84,8 +84,10 @@ public class GhidraScriptAskMethodsTest extends AbstractGhidraHeadedIntegrationT
}
private void clearScriptCachedValues() {
- Map map = (Map) TestUtils.getInstanceField("askMap", script);
- map.clear();
+ if (script != null) {
+ Map map = (Map) TestUtils.getInstanceField("askMap", script);
+ map.clear();
+ }
}
@Test
diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/OverridePrototypeAction.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/OverridePrototypeAction.java
index 39ddda0173..1d133909e2 100644
--- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/OverridePrototypeAction.java
+++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/OverridePrototypeAction.java
@@ -29,59 +29,12 @@ import ghidra.program.model.data.*;
import ghidra.program.model.listing.*;
import ghidra.program.model.pcode.*;
import ghidra.program.model.symbol.Reference;
+import ghidra.program.model.symbol.SourceType;
import ghidra.util.*;
import ghidra.util.exception.CancelledException;
public class OverridePrototypeAction extends AbstractDecompilerAction {
- public class ProtoOverrideDialog extends EditFunctionSignatureDialog {
- private FunctionDefinition functionDefinition;
-
- public FunctionDefinition getFunctionDefinition() {
- return functionDefinition;
- }
-
- public ProtoOverrideDialog(PluginTool tool, Function func, String signature, String conv) {
- super(tool, "Override Signature", func);
- setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionOverrideSignature"));
- setSignature(signature);
- setCallingConvention(conv);
- }
-
- /**
- * This method gets called when the user clicks on the OK Button. The base
- * class calls this method.
- */
- @Override
- protected void okCallback() {
- // only close the dialog if the user made valid changes
- if (parseFunctionDefinition()) {
- close();
- }
- }
-
- private boolean parseFunctionDefinition() {
-
- functionDefinition = null;
-
- try {
- functionDefinition = parseSignature();
- }
- catch (CancelledException e) {
- // ignore
- }
-
- if (functionDefinition == null) {
- return false;
- }
-
- GenericCallingConvention convention =
- GenericCallingConvention.guessFromName(getCallingConvention());
- functionDefinition.setGenericCallingConvention(convention);
- return true;
- }
- }
-
public OverridePrototypeAction() {
super("Override Signature");
setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionOverrideSignature"));
@@ -183,11 +136,30 @@ public class OverridePrototypeAction extends AbstractDecompilerAction {
return null;
}
- private String generateSignature(PcodeOp op, String name) {
+ private String generateSignature(PcodeOp op, String name, Function calledfunc) {
+
+ // TODO: If an override has already be placed-down it should probably be used
+ // for the initial signature. HighFunction does not make it easy to grab
+ // existing override prototype
+
+ if (calledfunc != null) {
+ SourceType signatureSource = calledfunc.getSignatureSource();
+ if (signatureSource == SourceType.DEFAULT || signatureSource == SourceType.ANALYSIS) {
+ calledfunc = null; // ignore
+ }
+ }
+
StringBuffer buf = new StringBuffer();
+
Varnode vn = op.getOutput();
DataType dt = null;
- if (vn != null) {
+ if (calledfunc != null) {
+ dt = calledfunc.getReturnType();
+ if (Undefined.isUndefined(dt)) {
+ dt = null;
+ }
+ }
+ if (dt == null && vn != null) {
dt = vn.getHigh().getDataType();
}
if (dt != null) {
@@ -198,26 +170,48 @@ public class OverridePrototypeAction extends AbstractDecompilerAction {
}
buf.append(' ').append(name).append('(');
- for (int i = 1; i < op.getNumInputs(); ++i) {
- vn = op.getInput(i);
- dt = null;
- if (vn != null) {
- dt = vn.getHigh().getDataType();
- }
- if (dt != null) {
- buf.append(dt.getDisplayName());
- }
- else {
- buf.append("BAD");
- }
- if (i != op.getNumInputs() - 1) {
- buf.append(',');
+
+ int index = 1;
+ if (calledfunc != null) {
+ for (Parameter p : calledfunc.getParameters()) {
+ String dtName = getInputDataTypeName(op, index, p.getDataType());
+ if (index++ != 1) {
+ buf.append(", ");
+ }
+ buf.append(dtName);
+ if (p.getSource() != SourceType.DEFAULT) {
+ buf.append(' ');
+ buf.append(p.getName());
+ }
}
}
+
+ for (int i = index; i < op.getNumInputs(); ++i) {
+ if (i != 1) {
+ buf.append(", ");
+ }
+ buf.append(getInputDataTypeName(op, i, null));
+ }
+
buf.append(')');
return buf.toString();
}
+ private String getInputDataTypeName(PcodeOp op, int inIndex, DataType preferredDt) {
+ if (preferredDt != null && !Undefined.isUndefined(preferredDt)) {
+ return preferredDt.getDisplayName();
+ }
+ Varnode vn = op.getInput(inIndex);
+ DataType dt = null;
+ if (vn != null) {
+ dt = vn.getHigh().getDataType();
+ }
+ if (dt != null) {
+ return dt.getDisplayName();
+ }
+ return "BAD";
+ }
+
@Override
protected boolean isEnabledForDecompilerContext(DecompilerActionContext context) {
Function function = context.getFunction();
@@ -257,9 +251,10 @@ public class OverridePrototypeAction extends AbstractDecompilerAction {
conv = calledfunc.getCallingConventionName();
}
- String signature = generateSignature(op, name);
+ String signature = generateSignature(op, name, calledfunc);
PluginTool tool = context.getTool();
- ProtoOverrideDialog dialog = new ProtoOverrideDialog(tool, func, signature, conv);
+ ProtoOverrideDialog dialog =
+ new ProtoOverrideDialog(tool, calledfunc != null ? calledfunc : func, signature, conv);
tool.showDialog(dialog);
FunctionDefinition fdef = dialog.getFunctionDefinition();
if (fdef == null) {
@@ -279,4 +274,71 @@ public class OverridePrototypeAction extends AbstractDecompilerAction {
program.endTransaction(transaction, commit);
}
}
+
+ /**
+ * ProtoOverrideDialog provides the ability to edit the
+ * function signature associated with a specific function definition override
+ * at a sub-function callsite.
+ * Use of this editor requires the presence of the tool-based datatype manager service.
+ */
+ private class ProtoOverrideDialog extends EditFunctionSignatureDialog {
+ private FunctionDefinition functionDefinition;
+ private final String initialSignature;
+ private final String initialConvention;
+
+ /**
+ * Construct signature override for called function
+ * @param tool active tool
+ * @param func function from which program access is achieved and supply of preferred
+ * datatypes when parsing signature
+ * @param signature initial prototype signature to be used
+ * @param conv initial calling convention
+ */
+ public ProtoOverrideDialog(PluginTool tool, Function func, String signature, String conv) {
+ super(tool, "Override Signature", func, false, false, false);
+ setHelpLocation(new HelpLocation(HelpTopics.DECOMPILER, "ActionOverrideSignature"));
+ this.initialSignature = signature;
+ this.initialConvention = conv;
+ }
+
+ @Override
+ protected String getPrototypeString() {
+ return initialSignature;
+ }
+
+ @Override
+ protected String getCallingConventionName() {
+ return initialConvention;
+ }
+
+ @Override
+ protected boolean applyChanges() throws CancelledException {
+ return parseFunctionDefinition();
+ }
+
+ private boolean parseFunctionDefinition() {
+
+ functionDefinition = null;
+
+ try {
+ functionDefinition = parseSignature();
+ }
+ catch (CancelledException e) {
+ // ignore
+ }
+
+ if (functionDefinition == null) {
+ return false;
+ }
+
+ GenericCallingConvention convention =
+ GenericCallingConvention.guessFromName(getCallingConvention());
+ functionDefinition.setGenericCallingConvention(convention);
+ return true;
+ }
+
+ public FunctionDefinition getFunctionDefinition() {
+ return functionDefinition;
+ }
+ }
}
diff --git a/Ghidra/Features/FunctionID/build.gradle b/Ghidra/Features/FunctionID/build.gradle
index 8345178732..a67ae99435 100644
--- a/Ghidra/Features/FunctionID/build.gradle
+++ b/Ghidra/Features/FunctionID/build.gradle
@@ -31,10 +31,11 @@ dependencies {
}
-// All *.fidb files located in the BIN repo under src/main/fidb will be unpacked
-def fidbSrcDir = "${getProjectLocationInBinRepo(project)}/src/main/fidb"
-
-def fidDbFiles = fileTree(fidbSrcDir) {
+// All *.fidb files located in the dependencies/fid directory OR the
+// BIN repo under src/main/fidb will be unpacked
+def depsDir = file("${DEPS_DIR}/fidb")
+def binRepoDir = "${getProjectLocationInBinRepo(project)}/src/main/fidb"
+def fidDbFiles = fileTree(depsDir.exists() ? depsDir : binRepoDir) {
include '**/*.fidb'
}
diff --git a/Ghidra/Features/GhidraServer/build.gradle b/Ghidra/Features/GhidraServer/build.gradle
index ec08f05fcc..484be39516 100644
--- a/Ghidra/Features/GhidraServer/build.gradle
+++ b/Ghidra/Features/GhidraServer/build.gradle
@@ -40,12 +40,11 @@ addExports([
])
CopySpec yajswCopySpec = copySpec {
- File localFile = file("build/${yajswRelease}.zip")
- File binFile = file("${BIN_REPO}/Ghidra/Features/GhidraServer/${yajswRelease}.zip")
+ File depsFile = file("${DEPS_DIR}/GhidraServer/${yajswRelease}.zip")
+ File binRepoFile = file("${BIN_REPO}/Ghidra/Features/GhidraServer/${yajswRelease}.zip")
- // First check if the file was downloaded and dropped in locally. If not, check in the bin
- // repo.
- def yajswZipTree = localFile.exists() ? zipTree(localFile) : zipTree(binFile)
+ // First check if the file is in the dependencies repo. If not, check in the bin repo.
+ def yajswZipTree = depsFile.exists() ? zipTree(depsFile) : zipTree(binRepoFile)
from(yajswZipTree) {
include "${yajswRelease}/lib/core/**"
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/DefaultAddRemoveStrategy.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/DefaultAddRemoveStrategy.java
new file mode 100644
index 0000000000..17c085b223
--- /dev/null
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/DefaultAddRemoveStrategy.java
@@ -0,0 +1,61 @@
+/* ###
+ * 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 docking.widgets.table.threaded;
+
+import java.util.List;
+
+import docking.widgets.table.AddRemoveListItem;
+import ghidra.util.exception.CancelledException;
+import ghidra.util.task.TaskMonitor;
+
+/**
+ * A strategy that uses the table's sort state to perform a binary search of items to be added
+ * and removed.
+ *
+ * @param the row type
+ */
+public class DefaultAddRemoveStrategy implements TableAddRemoveStrategy {
+
+ @Override
+ public void process(List> addRemoveList, TableData updatedData,
+ TaskMonitor monitor) throws CancelledException {
+
+ int n = addRemoveList.size();
+ monitor.setMessage("Adding/Removing " + n + " items...");
+ monitor.initialize(n);
+
+ // Note: this class does not directly perform a binary such, but instead relies on that
+ // work to be done by the call to TableData.remove()
+ for (int i = 0; i < n; i++) {
+ AddRemoveListItem item = addRemoveList.get(i);
+ T value = item.getValue();
+ if (item.isChange()) {
+ updatedData.remove(value);
+ updatedData.insert(value);
+ }
+ else if (item.isRemove()) {
+ updatedData.remove(value);
+ }
+ else if (item.isAdd()) {
+ updatedData.insert(value);
+ }
+ monitor.checkCanceled();
+ monitor.setProgress(i);
+ }
+ monitor.setMessage("Done adding/removing");
+ }
+
+}
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableAddRemoveStrategy.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableAddRemoveStrategy.java
new file mode 100644
index 0000000000..3bb91bb580
--- /dev/null
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableAddRemoveStrategy.java
@@ -0,0 +1,40 @@
+/* ###
+ * 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 docking.widgets.table.threaded;
+
+import java.util.List;
+
+import docking.widgets.table.AddRemoveListItem;
+import ghidra.util.exception.CancelledException;
+import ghidra.util.task.TaskMonitor;
+
+/**
+ * A strategy to perform table add and remove updates
+ *
+ * @param the row type
+ */
+public interface TableAddRemoveStrategy {
+
+ /**
+ * Adds to and removes from the table data those items in the given add/remove list
+ * @param addRemoveList the items to add/remove
+ * @param tableData the table's data
+ * @param monitor the monitor
+ * @throws CancelledException if the monitor is cancelled
+ */
+ public void process(List> addRemoveList, TableData tableData,
+ TaskMonitor monitor) throws CancelledException;
+}
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java
index 72b24ff65d..e59de08958 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableData.java
@@ -137,7 +137,7 @@ public class TableData implements Iterable {
* @param t the item
* @return the index
*/
- int indexOf(ROW_OBJECT t) {
+ public int indexOf(ROW_OBJECT t) {
if (!sortContext.isUnsorted()) {
Comparator comparator = sortContext.getComparator();
return Collections.binarySearch(data, t, comparator);
@@ -153,7 +153,7 @@ public class TableData implements Iterable {
return -1;
}
- boolean remove(ROW_OBJECT t) {
+ public boolean remove(ROW_OBJECT t) {
if (source != null) {
source.remove(t);
}
@@ -186,7 +186,7 @@ public class TableData implements Iterable {
*
* @param value the row Object to insert
*/
- void insert(ROW_OBJECT value) {
+ public void insert(ROW_OBJECT value) {
if (source != null) {
// always update the master data
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
index 08f09b1ab7..94df233f11 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/TableUpdateJob.java
@@ -553,31 +553,14 @@ public class TableUpdateJob {
*/
private void doProcessAddRemoves() throws CancelledException {
- int n = addRemoveList.size();
- monitor.setMessage("Adding/Removing " + n + " items...");
- monitor.initialize(n);
-
initializeSortCache();
-
- for (int i = 0; i < n; i++) {
- AddRemoveListItem item = addRemoveList.get(i);
- T value = item.getValue();
- if (item.isChange()) {
- updatedData.remove(value);
- updatedData.insert(value);
- }
- else if (item.isRemove()) {
- updatedData.remove(value);
- }
- else if (item.isAdd()) {
- updatedData.insert(value);
- }
- monitor.checkCanceled();
- monitor.setProgress(i);
+ try {
+ TableAddRemoveStrategy strategy = model.getAddRemoveStrategy();
+ strategy.process(addRemoveList, updatedData, monitor);
+ }
+ finally {
+ clearSortCache();
}
- monitor.setMessage("Done adding/removing");
-
- clearSortCache();
}
/** When sorting we cache column value lookups to increase speed. */
diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java
index 6439ef4edd..67ac2cc585 100644
--- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java
+++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/threaded/ThreadedTableModel.java
@@ -90,6 +90,8 @@ public abstract class ThreadedTableModel
private volatile Worker worker; // only created as needed (if we are incremental)
private int minUpdateDelayMillis;
private int maxUpdateDelayMillis;
+ private TableAddRemoveStrategy binarySearchAddRemoveStrategy =
+ new DefaultAddRemoveStrategy<>();
protected ThreadedTableModel(String modelName, ServiceProvider serviceProvider) {
this(modelName, serviceProvider, null);
@@ -510,6 +512,17 @@ public abstract class ThreadedTableModel
/**
* Removes the specified object from this model and schedules an update.
+ *
+ * Note: for this method to function correctly, the given object must compare as
+ * {@link #equals(Object)} and have the same {@link #hashCode()} as the object to be removed
+ * from the table data. This allows clients to create proxy objects to pass into this method,
+ * as long as they honor those requirements.
+ *
+ *
If this model's data is sorted, then a binary search will be used to locate the item
+ * to be removed. However, for this to work, all field used to sort the data must still be
+ * available from the original object and must be the same values. If this is not true, then
+ * the binary search will not work and a brute force search will be used.
+ *
* @param obj the object to remove
*/
public void removeObject(ROW_OBJECT obj) {
@@ -786,6 +799,23 @@ public abstract class ThreadedTableModel
updateManager.setTaskMonitor(monitor);
}
+ /**
+ * Returns the strategy to use for performing adds and removes to this table. Subclasses can
+ * override this method to customize this process for their particular type of data. See
+ * the implementations of {@link TableAddRemoveStrategy} for details.
+ *
+ * Note: The default add/remove strategy assumes that objects to be removed will be the
+ * same instance that is in the list of this model. This allows the {@link #equals(Object)}
+ * and {@link #hashCode()} to be used when removing the object from the list. If you model
+ * does not pass the same instance into {@link #removeObject(Object)}, then you will need to
+ * update your add/remove strategy accordingly.
+ *
+ * @return the strategy
+ */
+ protected TableAddRemoveStrategy getAddRemoveStrategy() {
+ return binarySearchAddRemoveStrategy;
+ }
+
public void setIncrementalTaskMonitor(TaskMonitor monitor) {
SystemUtilities.assertTrue(loadIncrementally, "Cannot set an incremental task monitor " +
"on a table that was not constructed to load incrementally");
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressMapImpl.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressMapImpl.java
index 62475f1a1f..d2204849b8 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressMapImpl.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressMapImpl.java
@@ -160,7 +160,7 @@ public class AddressMapImpl {
}
void checkAddressSpace(AddressSpace addrSpace) {
- String name = addrSpace.getName().toUpperCase();
+ String name = addrSpace.getName();
AddressSpace existingSpace = spaceMap.get(name);
if (existingSpace == null) {
spaceMap.put(name, addrSpace);
@@ -248,10 +248,12 @@ public class AddressMapImpl {
private void addKeyRanges(List keyRangeList, Address start, Address end) {
int index = Arrays.binarySearch(sortedBaseStartAddrs, start);
- if (index < 0)
+ if (index < 0) {
index = -index - 2;
- if (index < 0)
+ }
+ if (index < 0) {
index++;
+ }
while (index < sortedBaseStartAddrs.length &&
end.compareTo(sortedBaseStartAddrs[index]) >= 0) {
Address addr1 = max(start, sortedBaseStartAddrs[index]);
@@ -312,7 +314,7 @@ public class AddressMapImpl {
}
for (AddressSpace space : remapSpaces.values()) {
- spaceMap.put(space.getName().toUpperCase(), space);
+ spaceMap.put(space.getName(), space);
}
for (int i = 0; i < baseAddrs.length; i++) {
diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java
index c50c779e16..f36e147f63 100644
--- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java
+++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/StringDataInstance.java
@@ -162,7 +162,7 @@ public class StringDataInstance {
return ((AbstractStringDataType) dt).getStringDataInstance(data, data,
data.getLength());
}
- if (dt instanceof Array && !data.isInitializedMemory()) {
+ if (dt instanceof Array && data.isInitializedMemory()) {
ArrayStringable arrayStringable =
ArrayStringable.getArrayStringable(((Array) dt).getDataType());
if (arrayStringable != null && arrayStringable.hasStringValue(data)) {
@@ -918,8 +918,9 @@ public class StringDataInstance {
if (byteOffset + charSize > stringBytes.length) {
return false;
}
- long origCodePointValue = DataConverter.getInstance(buf.isBigEndian()).getValue(stringBytes,
- byteOffset, charSize);
+ long origCodePointValue = DataConverter.getInstance(buf.isBigEndian())
+ .getValue(stringBytes,
+ byteOffset, charSize);
return origCodePointValue == StringUtilities.UNICODE_REPLACEMENT;
}
diff --git a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/address/AddressMapImplTest.java b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/address/AddressMapImplTest.java
index c890ec9659..00a17bff09 100644
--- a/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/address/AddressMapImplTest.java
+++ b/Ghidra/Framework/SoftwareModeling/src/test/java/ghidra/program/model/address/AddressMapImplTest.java
@@ -15,7 +15,7 @@
*/
package ghidra.program.model.address;
-import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.*;
import org.junit.*;
@@ -26,6 +26,7 @@ public class AddressMapImplTest extends AbstractGenericTest {
AddressSpace sp16;
AddressSpace sp32;
AddressSpace sp64;
+ AddressSpace ov64;
AddressSpace regSpace;
AddressSpace stackSpace;
SegmentedAddressSpace segSpace1;
@@ -42,6 +43,8 @@ public class AddressMapImplTest extends AbstractGenericTest {
sp32 = new GenericAddressSpace("THREE", 32, AddressSpace.TYPE_RAM, 2);
sp64 = new GenericAddressSpace("FOUR", 64, AddressSpace.TYPE_RAM, 2);
+ ov64 = new OverlayAddressSpace("four", sp64, 100, 0x1000, 0x1fff);
+
segSpace1 = new SegmentedAddressSpace("SegSpaceOne", 3);
segSpace2 = new SegmentedAddressSpace("SegSpaceTwo", 4);
@@ -50,7 +53,7 @@ public class AddressMapImplTest extends AbstractGenericTest {
map = new AddressMapImpl();
- addrs = new Address[29];
+ addrs = new Address[31];
addrs[0] = sp8.getAddress(0);
addrs[1] = sp8.getAddress(0x0ff);
addrs[2] = sp16.getAddress(0);
@@ -84,6 +87,9 @@ public class AddressMapImplTest extends AbstractGenericTest {
addrs[27] = stackSpace.getAddress(0);
addrs[28] = stackSpace.getAddress(0x80000000);
+ addrs[29] = ov64.getAddress(0x1100);
+ addrs[30] = ov64.getAddress(0x2000);
+
}
@Test
diff --git a/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build.gradle b/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build.gradle
index aecbcd515e..bb4516d155 100644
--- a/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build.gradle
+++ b/GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build.gradle
@@ -80,12 +80,11 @@ task pyDevUnpack(type:Copy) {
!pyDevDestDir.exists()
}
- File localFile = file("build/PyDev 6.3.1.zip")
- File binFile = file("${BIN_REPO}/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/PyDev 6.3.1.zip")
+ File depsFile = file("${DEPS_DIR}/GhidraDev/PyDev 6.3.1.zip")
+ File binRepoFile = file("${BIN_REPO}/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/PyDev 6.3.1.zip")
- // First check if the file was downloaded and dropped in locally. If not, check in the bin
- // repo.
- def pyDevZipTree = localFile.exists() ? zipTree(localFile) : zipTree(binFile)
+ // First check if the file is in the dependencies repo. If not, check in the bin repo.
+ def pyDevZipTree = depsFile.exists() ? zipTree(depsFile) : zipTree(binRepoFile)
from pyDevZipTree
exclude "**/.project", "**/.pydevproject"
@@ -104,12 +103,11 @@ task cdtUnpack(type:Copy) {
!cdtDestDir.exists()
}
- File localFile = file("build/cdt-8.6.0.zip")
- File binFile = file("${BIN_REPO}/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/cdt-8.6.0.zip")
+ File depsFile = file("${DEPS_DIR}/GhidraDev/cdt-8.6.0.zip")
+ File binRepoFile = file("${BIN_REPO}/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/cdt-8.6.0.zip")
- // First check if the file was downloaded and dropped in locally. If not, check in the bin
- // repo.
- def cdtZipTree = localFile.exists() ? zipTree(localFile) : zipTree(binFile)
+ // First check if the file is in the dependencies repo. If not, check in the bin repo.
+ def cdtZipTree = depsFile.exists() ? zipTree(depsFile) : zipTree(binRepoFile)
from cdtZipTree
diff --git a/build.gradle b/build.gradle
index 066143562d..6ab7f43302 100644
--- a/build.gradle
+++ b/build.gradle
@@ -51,9 +51,9 @@ if ("32".equals(System.getProperty("sun.arch.data.model"))) {
* Define the location of bin repo
*********************************************************************************/
project.ext.GHIDRA_GROUP = "Z Ghidra"
-project.ext.BIN_REPO = file("${projectDir}/../ghidra.bin").absolutePath
project.ext.ROOT_PROJECT_DIR = projectDir.absolutePath
-project.ext.BIN_REPO_PATH = BIN_REPO // TODO make path names consistent
+project.ext.BIN_REPO = file("${projectDir}/../ghidra.bin").absolutePath
+project.ext.DEPS_DIR = file("${projectDir}/dependencies")
/*********************************************************************************
* Prevent forked Java processes from stealing focus
@@ -67,13 +67,14 @@ allprojects {
/*********************************************************************************
* Use flat directory-style repository if flatRepo directory is present.
*********************************************************************************/
-if (file("flatRepo").isDirectory()) {
+def flatRepo = file("${DEPS_DIR}/flatRepo")
+if (flatRepo.isDirectory()) {
allprojects {
repositories {
mavenLocal()
mavenCentral()
jcenter()
- flatDir name: "flat", dirs:["$rootProject.projectDir/flatRepo"]
+ flatDir name: "flat", dirs:["$flatRepo"]
}
}
}
diff --git a/gradle/javaTestProject.gradle b/gradle/javaTestProject.gradle
index 525ce3e32b..d2fb80849e 100644
--- a/gradle/javaTestProject.gradle
+++ b/gradle/javaTestProject.gradle
@@ -156,7 +156,7 @@ def initTestJVM(Task task, String rootDirName) {
// -javaagent:/path/to/jmockit.jar
task.doFirst {
def jmockitPath = configurations.jmockitAgent.singleFile
-
+
task.jvmArgs '-DupgradeProgramErrorMessage=' + upgradeProgramErrorMessage,
'-DupgradeTimeErrorMessage=' + upgradeTimeErrorMessage,
'-Dlog4j.configuration=' + logPropertiesUrl,
@@ -177,11 +177,15 @@ def initTestJVM(Task task, String rootDirName) {
'-Duser.country=US',
'-Duser.language=en',
'-Djdk.attach.allowAttachSelf',
- '-javaagent:' + jmockitPath,
- '-DLock.DEBUG=true',
+ '-javaagent:' + jmockitPath,
+ '-noverify',
+ '-XX:TieredStopAtLevel=1',
'-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=' + debugPort
+ // Note: this args are used to speed-up the tests, but are not safe for production code
+ // -noverify and -XX:TieredStopAtLevel=1
+
// Note: modern remote debug invocation;
// -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000
@@ -191,6 +195,16 @@ def initTestJVM(Task task, String rootDirName) {
// -Xnoagent
// -Djava.compiler=NONE
// -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000
+
+ //
+ // TODO Future Updates:
+ // The test configuration should be updated to support all known modes of operation:
+ // command-line test execution, CI test execution of a branch upon request, and full
+ // CI test execution (this is slow and may need to run overnight). We do not currently
+ // support well running tests via the command-line. See discussion at github 2854.
+ // For better command-line usage we will need to update tests such that they can
+ // share a VM, enabling us to elimnate the use of 'forEver 1' in this file.
+ //
}
}
/*********************************************************************************
diff --git a/gradle/root/svg.gradle b/gradle/root/svg.gradle
index 153b8c4720..20309a2ea6 100644
--- a/gradle/root/svg.gradle
+++ b/gradle/root/svg.gradle
@@ -43,7 +43,6 @@ task rasterizeSvg(type: JavaExec) {
// added these in the individual projects which use this task (eg: to the 'compile'
// configuration) but since this is the only task which requires them, it seemed
// appropriate to just add them here.
- def BIN_REPO = rootProject.file(BIN_REPO_PATH).toString()
classpath = files ( BIN_REPO + "/ExternalLibraries/libsforBuild/batik-all-1.7.jar",
BIN_REPO + "/ExternalLibraries/libsforBuild/xml-apis-ext.jar")
diff --git a/gradle/root/test.gradle b/gradle/root/test.gradle
index 1284ec7229..cd50d17fb6 100644
--- a/gradle/root/test.gradle
+++ b/gradle/root/test.gradle
@@ -345,10 +345,13 @@ def initTestJVM(Task task, String rootDirName) {
'-Duser.country=US',
'-Duser.language=en',
'-Djdk.attach.allowAttachSelf',
- '-javaagent:' + jmockitPath,
- '-DLock.DEBUG=true',
+ '-javaagent:' + jmockitPath,
+ '-noverify',
+ '-XX:TieredStopAtLevel=1',
'-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=' + debugPort
+ // Note: this args are used to speed-up the tests, but are not safe for production code
+ // -noverify and -XX:TieredStopAtLevel=1
// Note: modern remote debug invocation;
// -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000
diff --git a/gradle/support/fetchDependencies.gradle b/gradle/support/fetchDependencies.gradle
index 6b4a7912ad..a9a8db3b0a 100644
--- a/gradle/support/fetchDependencies.gradle
+++ b/gradle/support/fetchDependencies.gradle
@@ -22,29 +22,13 @@
* immediately after cloning the Ghidra repository before any other gradle *
* tasks are run. *
* *
- * Specifically, this task: *
+ * usage: from the command line in the main ghidra repository directory, run *
+ * the following: *
* *
- * 1. Downloads various dependencies required by the ghidra build and *
- * puts them in /build/downloads/. From here they are *
- * unzipped and/or copied to their final locations. The files to be *
- * downloaded: *
- * - dex-tools-2.0.zip *
- * - AXMLPrinter2.jar *
- * - hfsexplorer-0_21-bin.zip *
- * - yajsw-stable-12.12.zip *
- * - cdt-8.6.0.zip *
- * - PyDev 6.3.1.zip *
- * *
- * 2. Creates a directory at /flatRepo which is used as a *
- * flat directory-style respository for the files extracted above. *
- * *
- * usage: from the command line in the main ghidra repository *
- * directory, run the following: *
- * *
- * gradle --init-script gradle/support/fetchDependencies.gradle init *
+ * gradle -I gradle/support/fetchDependencies.gradle init *
* *
* Note: When running the script, files will only be downloaded if *
- * necessary (eg: they are not already in the build/downloads/ *
+ * necessary (eg: they are not already in the dependencies/downloads/ *
* directory). *
* *
*******************************************************************************/
@@ -52,138 +36,226 @@
import java.util.zip.*;
import java.nio.file.*;
import java.security.MessageDigest;
-import org.apache.commons.io.*;
-import org.apache.commons.io.filefilter.*;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.filefilter.WildcardFileFilter;
-ext.HOME_DIR = System.getProperty('user.home')
-ext.REPO_DIR = ((Script)this).buildscript.getSourceFile().getParentFile().getParentFile().getParentFile()
-ext.FLAT_REPO_DIR = new File(REPO_DIR, "flatRepo")
-ext.DOWNLOADS_DIR = new File(REPO_DIR, "build/downloads")
-
-// Stores the size of the file being downloaded (for formatting print statements)
-ext.FILE_SIZE = 0;
-
-// The URLs for each of the dependencies
-ext.DEX_ZIP = 'https://github.com/pxb1988/dex2jar/releases/download/2.0/dex-tools-2.0.zip'
-ext.AXML_ZIP = 'https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/android4me/AXMLPrinter2.jar'
-ext.HFS_ZIP = 'https://sourceforge.net/projects/catacombae/files/HFSExplorer/0.21/hfsexplorer-0_21-bin.zip'
-ext.YAJSW_ZIP = 'https://sourceforge.net/projects/yajsw/files/yajsw/yajsw-stable-12.12/yajsw-stable-12.12.zip'
-ext.PYDEV_ZIP = 'https://sourceforge.net/projects/pydev/files/pydev/PyDev%206.3.1/PyDev%206.3.1.zip'
-ext.CDT_ZIP = 'https://archive.eclipse.org/tools/cdt/releases/8.6/cdt-8.6.0.zip'
-
-// The SHA-256s for each of the dependencies
-ext.DEX_SHA_256 = '7907eb4d6e9280b6e17ddce7ee0507eae2ef161ee29f70a10dbc6944fdca75bc'
-ext.AXML_SHA_256 = '00ed038eb6abaf6ddec8d202a3ed7a81b521458f4cd459948115cfd02ff59d6d'
-ext.HFS_SHA_256 = '90c9b54798abca5b12f4a678db7d0a4c970f4702cb153c11919536d0014dedbf'
-ext.YAJSW_SHA_256 = '1398fcb1e93abb19992c4fa06d7fe5758aabb4c45781d7ef306c6f57ca7a7321'
-ext.PYDEV_SHA_256 = '4d81fe9d8afe7665b8ea20844d3f5107f446742927c59973eade4f29809b0699'
-ext.CDT_SHA_256 = '81b7d19d57c4a3009f4761699a72e8d642b5e1d9251d2bb98df438b1e28f8ba9'
-
-// Number of times to try and establish a connection when downloading files before
-// failing
-ext.NUM_RETRIES = 2
-
-// Set up a maven repository configuration so we can get access to Apache FileUtils for
-// copying/deleting files.
initscript {
- repositories {
- mavenCentral()
- }
- dependencies {
- classpath 'commons-io:commons-io:2.5'
- }
+ repositories { mavenCentral() }
+ dependencies { classpath 'commons-io:commons-io:2.8.0' }
}
-// This is where the real flow of the script starts...
-try {
- createDirs()
- populateFlatRepo()
+ext.NUM_RETRIES = 3 // # of times to try to download a file before failing
+ext.REPO_DIR = ((Script)this).buildscript.getSourceFile().getParentFile().getParentFile().getParentFile()
+ext.DEPS_DIR = file("${REPO_DIR}/dependencies")
+ext.DOWNLOADS_DIR = file("${DEPS_DIR}/downloads")
+ext.FID_DIR = file("${DEPS_DIR}/fidb")
+ext.FLAT_REPO_DIR = file("${DEPS_DIR}/flatRepo")
+
+ext.deps = [
+ [
+ name: 'dex-tools-2.0.zip',
+ url: 'https://github.com/pxb1988/dex2jar/releases/download/2.0/dex-tools-2.0.zip',
+ sha256: '7907eb4d6e9280b6e17ddce7ee0507eae2ef161ee29f70a10dbc6944fdca75bc',
+ destination: {
+ unzip(DOWNLOADS_DIR, DOWNLOADS_DIR, 'dex-tools-2.0.zip')
+ FileUtils.copyDirectory(new File(DOWNLOADS_DIR, 'dex2jar-2.0/lib/'), FLAT_REPO_DIR, new WildcardFileFilter("dex-*"));
+ }
+ ],
+ [
+ name: 'hfsexplorer-0_21-bin.zip',
+ url: 'https://sourceforge.net/projects/catacombae/files/HFSExplorer/0.21/hfsexplorer-0_21-bin.zip',
+ sha256: '90c9b54798abca5b12f4a678db7d0a4c970f4702cb153c11919536d0014dedbf',
+ destination: {
+ def hfsxdir = new File (DOWNLOADS_DIR, "hfsx")
+ hfsxdir.mkdir()
+ unzip (DOWNLOADS_DIR, hfsxdir, 'hfsexplorer-0_21-bin.zip')
+ FileUtils.copyFileToDirectory(new File(DOWNLOADS_DIR, "hfsx/lib/csframework.jar"), FLAT_REPO_DIR);
+ FileUtils.copyFileToDirectory(new File(DOWNLOADS_DIR, "hfsx/lib/hfsx_dmglib.jar"), FLAT_REPO_DIR);
+ FileUtils.copyFileToDirectory(new File(DOWNLOADS_DIR, "hfsx/lib/hfsx.jar"), FLAT_REPO_DIR);
+ FileUtils.copyFileToDirectory(new File(DOWNLOADS_DIR, "hfsx/lib/iharder-base64.jar"), FLAT_REPO_DIR);
+ }
+ ],
+ [
+ name: 'AXMLPrinter2.jar',
+ url: 'https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/android4me/AXMLPrinter2.jar',
+ sha256: '00ed038eb6abaf6ddec8d202a3ed7a81b521458f4cd459948115cfd02ff59d6d',
+ destination: FLAT_REPO_DIR
+ ],
+ [
+ name: 'yajsw-stable-12.12.zip',
+ url: 'https://sourceforge.net/projects/yajsw/files/yajsw/yajsw-stable-12.12/yajsw-stable-12.12.zip',
+ sha256: '1398fcb1e93abb19992c4fa06d7fe5758aabb4c45781d7ef306c6f57ca7a7321',
+ destination: file("${DEPS_DIR}/GhidraServer")
+ ],
+ [
+ name: 'PyDev 6.3.1.zip',
+ url: 'https://sourceforge.net/projects/pydev/files/pydev/PyDev%206.3.1/PyDev%206.3.1.zip',
+ sha256: '4d81fe9d8afe7665b8ea20844d3f5107f446742927c59973eade4f29809b0699',
+ destination: file("${DEPS_DIR}/GhidraDev")
+ ],
+ [
+ name: 'cdt-8.6.0.zip',
+ url: 'https://archive.eclipse.org/tools/cdt/releases/8.6/cdt-8.6.0.zip',
+ sha256: '81b7d19d57c4a3009f4761699a72e8d642b5e1d9251d2bb98df438b1e28f8ba9',
+ destination: file("${DEPS_DIR}/GhidraDev")
+ ],
+ [
+ name: 'vs2012_x64.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2012_x64.fidb',
+ sha256: 'f26548a6df6b6963a418d8c83ac216d9e196b180d944a52b8123c457d472b7c9',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2012_x86.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2012_x86.fidb',
+ sha256: '0a8962cf3699d5b8d4b3a79400382462519edc26570a46b2085200e38534f900',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2015_x64.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2015_x64.fidb',
+ sha256: '187248f87fc1deb695bc3051b2d92f9b7482023a356821154db22478eed13088',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2015_x86.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2015_x86.fidb',
+ sha256: '1d05afa070e9c09b83ee15d544c8559ed0d2b53d7eac476f8f5f8849543b3812',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2017_x64.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2017_x64.fidb',
+ sha256: '1784ad6b25571177ff8212871867559998c6b8256bb1dbaeee864b580c1b2d6a',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2017_x86.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2017_x86.fidb',
+ sha256: 'bc9bf30621190e0eb56c4db5ec30ad0401ca7be0311f5a2ce3d894178eafd19c',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2019_x64.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2019_x64.fidb',
+ sha256: 'aab04eefd1142f7b3c3f86c8d766abe361b167b4fe4157c36fad18777b2a6fbd',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vs2019_x86.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vs2019_x86.fidb',
+ sha256: '0a2282ac3479ffc022e6cdb4e32e057bc10f0394cfb0f8016d7145be0167f5f7',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vsOlder_x64.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vsOlder_x64.fidb',
+ sha256: 'fe1856c0acad297d9ba4fb6a2df1d32ba34df766d9f1a2a16da0ca2b375e23dd',
+ destination: FID_DIR
+ ],
+ [
+ name: 'vsOlder_x86.fidb',
+ url: 'https://github.com/NationalSecurityAgency/ghidra-data/raw/master/FunctionID/vsOlder_x86.fidb',
+ sha256: '46e56bc82ba68ad4e9a3c6a2e4ecd3428e2c390c7de0a379fa0165a58d46e115',
+ destination: FID_DIR
+ ]
+]
+
+// Download dependencies (if necessary) and verify their hashes
+DOWNLOADS_DIR.mkdirs()
+deps.each {
+ File file = new File(DOWNLOADS_DIR, it.name)
+ if (!it.sha256.equals(generateHash(file))) {
+ download(it.url, file.path)
+ assert(it.sha256.equals(generateHash(file)));
+ }
}
-finally {
- cleanup()
+
+// Copies the downloaded dependencies to their required destination.
+// Some downloads require pre-processing before their relevant pieces can be copied.
+deps.each {
+ if (it.destination instanceof File) {
+ println("Copying " + it.name + " to " + it.destination)
+ it.destination.mkdirs()
+ FileUtils.copyFile(new File(DOWNLOADS_DIR, it.name), new File(it.destination, it.name));
+ }
+ else if (it.destination instanceof Closure) {
+ println("Processing " + it.name)
+ it.destination()
+ }
+ else {
+ throw new GradleException("Unexpected destination type: " + it.destination)
+ }
}
+//-------------------------------------Helper methods----------------------------------------------
/**
- * Creates the directories where the dependencies will be downloaded and stored
- */
-def createDirs() {
- if (!DOWNLOADS_DIR.exists()) {
- DOWNLOADS_DIR.mkdirs()
- }
- if (!FLAT_REPO_DIR.exists()) {
- FLAT_REPO_DIR.mkdirs()
- }
-}
-
-/**
- * Downloads a file from a URL. If there is a problem connecting to the given
- * URL the attempt will be retried NUM_RETRIES times before failing.
+ * Downloads a file from a URL. The download attempt will be tried NUM_RETRIES times before failing.
*
- * Progress is shown on the command line in the form of the number of bytes
- * downloaded and a percentage of the total.
+ * Progress is shown on the command line in the form of the number of bytes downloaded and a
+ * percentage of the total.
*
- * Note: We do not validate that the number of bytes downloaded matches the
- * expected total here; any discrepencies will be caught when checking
- * the SHA-256s later on.
+ * Note: We do not validate that the number of bytes downloaded matches the expected total here; any
+ * discrepencies will be caught when checking the SHA-256s later on.
*
* @param url the file to download
* @param filename the local file to create for the download
*/
def download(url, filename) {
- println("File: " + url)
- BufferedInputStream istream = establishConnection(url, NUM_RETRIES);
- assert istream != null : " ***CONNECTION FAILURE***\n max attempts exceeded; exiting\n"
-
- FileOutputStream ostream = new FileOutputStream(filename);
- def dataBuffer = new byte[1024];
- int bytesRead;
- int totalRead;
- while ((bytesRead = istream.read(dataBuffer, 0, 1024)) != -1) {
-
- ostream.write(dataBuffer, 0, bytesRead);
- totalRead += bytesRead
-
- print("\r")
- if (FILE_SIZE.equals("unknown")) {
- print(" Downloading: " + totalRead + " of " + FILE_SIZE)
- }
- else {
- int pctComplete = (totalRead / FILE_SIZE) * 100
- print(" Downloading: " + totalRead + " of " + FILE_SIZE + " (" + pctComplete + "%)")
- }
- System.out.flush()
- }
- println("")
-
- istream.close();
- ostream.close();
+ println("URL: " + url)
+ def(InputStream istream, size) = establishConnection(url, NUM_RETRIES);
+ assert istream != null : " ***CONNECTION FAILURE***\n max attempts exceeded; exiting\n"
+
+ FileOutputStream ostream = new FileOutputStream(filename);
+ def dataBuffer = new byte[1024];
+ int bytesRead;
+ int totalRead;
+ while ((bytesRead = istream.read(dataBuffer, 0, 1024)) != -1) {
+ ostream.write(dataBuffer, 0, bytesRead);
+ totalRead += bytesRead
+ print("\r")
+ print(" Downloading: " + totalRead + " of " + size)
+ if (!size.equals("???")) {
+ int pctComplete = (totalRead / size) * 100
+ print(" (" + pctComplete + "%)")
+ }
+ print(" ") // overwrite gradle timer output
+ System.out.flush()
+ }
+ println()
+ istream.close();
+ ostream.close();
}
/**
- * Attemps to establish a connection to the given URL.
+ * Attempts to establish a connection to the given URL
*
- * @param url the site to connect to
- * @param retries the number of times to attempt to reconnect if there is a failure
- * @return the InputStream for the URL
+ * @param url the URL to connect to
+ * @param retries the number of times to attempt to connect if there are failures
+ * @return the InputStream for the URL, and the size of the download in bytes as a string
*/
def establishConnection(url, retries) {
- for (int i=0; i
- (e.name as File).with { f ->
- if (f.parentFile != null) {
- File destPath = new File(targetDir.path, f.parentFile.path)
- destPath.mkdirs()
- File targetFile = new File(destPath.path, f.name)
- targetFile.withOutputStream { w ->
- w << zip.getInputStream(e)
- }
- }
- }
- }
+ def zip = new ZipFile(new File(sourceDir, zipFileName))
+ zip.entries().findAll { !it.directory }.each { e ->
+ (e.name as File).with { f ->
+ if (f.parentFile != null) {
+ File destPath = new File(targetDir.path, f.parentFile.path)
+ destPath.mkdirs()
+ File targetFile = new File(destPath.path, f.name)
+ targetFile.withOutputStream { w ->
+ w << zip.getInputStream(e)
+ }
+ }
+ }
+ }
+ zip.close()
}
/**
- * Downloads and stores the necessary dependencies in the local flat repository.
+ * Generates the SHA-256 hash for the given file
*
- * If the dependency already exists in the downloads folder (DOWNLOADS_DIR) and has the
- * proper checksum, it will NOT be re-downloaded.
+ * @param file the file to generate the SHA-256 hash for
+ * @return the generated SHA-256 hash, or null if the file does not exist
*/
-def populateFlatRepo() {
-
- // 1. Download all the dependencies and verify their checksums. If the dependency has already
- // been download, do NOT download again.
- File file = new File(DOWNLOADS_DIR, 'dex-tools-2.0.zip')
- if (!DEX_SHA_256.equals(generateChecksum(file))) {
- download (DEX_ZIP, file.path)
- validateChecksum(generateChecksum(file), DEX_SHA_256);
- }
-
- file = new File(DOWNLOADS_DIR, 'AXMLPrinter2.jar')
- if (!AXML_SHA_256.equals(generateChecksum(file))) {
- download (AXML_ZIP, file.path)
- validateChecksum(generateChecksum(file), AXML_SHA_256);
- }
-
- file = new File(DOWNLOADS_DIR, 'hfsexplorer-0_21-bin.zip')
- if (!HFS_SHA_256.equals(generateChecksum(file))) {
- download (HFS_ZIP, file.path)
- validateChecksum(generateChecksum(file), HFS_SHA_256);
- }
-
- file = new File(DOWNLOADS_DIR, 'yajsw-stable-12.12.zip')
- if (!YAJSW_SHA_256.equals(generateChecksum(file))) {
- download (YAJSW_ZIP, file.path)
- validateChecksum(generateChecksum(file), YAJSW_SHA_256);
- }
-
- file = new File(DOWNLOADS_DIR, 'PyDev 6.3.1.zip')
- if (!PYDEV_SHA_256.equals(generateChecksum(file))) {
- download (PYDEV_ZIP, file.path)
- validateChecksum(generateChecksum(file), PYDEV_SHA_256);
- }
-
- file = new File(DOWNLOADS_DIR, 'cdt-8.6.0.zip')
- if (!CDT_SHA_256.equals(generateChecksum(file))) {
- download (CDT_ZIP, file.path)
- validateChecksum(generateChecksum(file), CDT_SHA_256);
- }
-
- // 2. Unzip the dependencies
- unzip(DOWNLOADS_DIR, DOWNLOADS_DIR, "dex-tools-2.0.zip")
- unzipHfsx()
-
- // 3. Copy the necessary jars to the flatRepo directory. Yajsw, CDT, and PyDev go directly into
- // the source repository.
- copyDexTools()
- copyAXML()
- copyHfsx()
- copyYajsw()
- copyPyDev()
- copyCdt()
-}
-
-/**
- * Generates the SHA-256 for the given file
- *
- * @param file the file to generate the checksum for
- * @return the generated checksum
- */
-def generateChecksum(file) {
- if (!file.exists()) {
- return null
- }
- MessageDigest md = MessageDigest.getInstance("SHA-256");
- md.update(Files.readAllBytes(Paths.get(file.path)));
- byte[] digest = md.digest();
- StringBuilder sb = new StringBuilder();
- for (byte b : digest) {
- sb.append(String.format("%02x", b));
- }
-
- return sb.toString();
-}
-
-/**
- * Compares two checksums and generates an assert failure if they do not match
- *
- * @param sourceSha256 the checksum to validate
- * @param expectedSha256 the expected checksum
- */
-def validateChecksum(sourceSha256, expectedSha256) {
- assert(sourceSha256.equals(expectedSha256));
-}
-
-/**
- * Unzips the hfsx zip file
- */
-def unzipHfsx() {
- def hfsxdir = getOrCreateTempHfsxDir()
- unzip (DOWNLOADS_DIR, hfsxdir, "hfsexplorer-0_21-bin.zip")
-}
-
-/**
- * Copies the dex-tools jars to the flat repository
- *
- * Note: This will only copy files beginning with "dex-"
- */
-def copyDexTools() {
- FileUtils.copyDirectory(new File(DOWNLOADS_DIR, 'dex2jar-2.0/lib/'), FLAT_REPO_DIR, new WildcardFileFilter("dex-*"));
-}
-
-/**
- * Copies the AXMLPrinter2 jar to the flat repository
- */
-def copyAXML() {
- FileUtils.copyFile(new File(DOWNLOADS_DIR, 'AXMLPrinter2.jar'), new File(FLAT_REPO_DIR, "AXMLPrinter2.jar"));
-}
-
-/**
- * Copies the necessary hfsx jars to the flat repository
- */
-def copyHfsx() {
- FileUtils.copyFile(new File(DOWNLOADS_DIR, "hfsx/lib/csframework.jar"), new File(FLAT_REPO_DIR, "csframework.jar"));
- FileUtils.copyFile(new File(DOWNLOADS_DIR, "hfsx/lib/hfsx_dmglib.jar"), new File(FLAT_REPO_DIR, "hfsx_dmglib.jar"));
- FileUtils.copyFile(new File(DOWNLOADS_DIR, "hfsx/lib/hfsx.jar"), new File(FLAT_REPO_DIR, "hfsx.jar"));
- FileUtils.copyFile(new File(DOWNLOADS_DIR, "hfsx/lib/iharder-base64.jar"), new File(FLAT_REPO_DIR, "iharder-base64.jar"));
-}
-
-/**
- * Copies the yajswdir zip to its location in the GhidraServer project.
- */
-def copyYajsw() {
- FileUtils.copyFile(new File(DOWNLOADS_DIR, "yajsw-stable-12.12.zip"), new File(REPO_DIR, "Ghidra/Features/GhidraServer/build/yajsw-stable-12.12.zip"));
-}
-
-/**
- * Copies the pydev zip to its bin repository location
- */
-def copyPyDev() {
- FileUtils.copyFile(new File(DOWNLOADS_DIR, 'PyDev 6.3.1.zip'), new File(REPO_DIR, "GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build/PyDev 6.3.1.zip"));
-}
-
-/**
- * Copies the cdt zip to its bin repository location
- */
-def copyCdt() {
- FileUtils.copyFile(new File(DOWNLOADS_DIR, 'cdt-8.6.0.zip'), new File(REPO_DIR, "GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build/cdt-8.6.0.zip"));
-}
-
-/**
- * Creates a temporary folder to house the hfsx zip contents
- *
- * @return the newly-created hfsx directory object
- */
-def getOrCreateTempHfsxDir() {
- def hfsxdir = new File (DOWNLOADS_DIR, "hfsx")
- if (!hfsxdir.exists()) {
- hfsxdir.mkdir()
- }
-
- return hfsxdir;
-}
-
-/**
- * Performs any cleanup operations that need to be performed after the flat repo has
- * been populated.
- */
-def cleanup() {
- // Uncomment this if we want to delete the downloads folder. For now, leave this and
- // depend on a gradle clean to wipe it out.
- //
- //if (DOWNLOADS_DIR.exists()) {
- // FileUtils.deleteDirectory(DOWNLOADS_DIR)
- //}
+def generateHash(file) {
+ if (!file.exists()) {
+ return null
+ }
+ MessageDigest md = MessageDigest.getInstance("SHA-256");
+ md.update(Files.readAllBytes(Paths.get(file.path)));
+ byte[] digest = md.digest();
+ StringBuilder sb = new StringBuilder();
+ for (byte b : digest) {
+ sb.append(String.format("%02x", b));
+ }
+ return sb.toString();
}
The refresh icon on the toolbar will
+ appear grayed-out by default. If potential changes to string data are detected,
+ the icon will become green in color. The toolbar button can be pressed in either state
+ for a full table reload.
+