yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-05 10:49:34 +02:00
Code Issues Releases Wiki Activity

GP-3235 improved auto-assignment of VOID storage to void return type for

Browse source 
function
This commit is contained in:
ghidra1 2023-04-25 12:06:08 -04:00
parent 8dd584c9bc
commit 19c1e8ae5b
17 changed files with 119 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/editor/FunctionEditorDialog.java
View file

@ -47,6 +47,7 @@ import ghidra.app.util.cparser.C.CParserUtils;
import ghidra.app.util.viewer.field.ListingColors.FunctionColors;
import ghidra.program.model.address.Address;
import ghidra.program.model.data.DataType;
import ghidra.program.model.data.VoidDataType;
import ghidra.program.model.listing.Function;
import ghidra.program.model.listing.VariableStorage;
import ghidra.program.model.symbol.ExternalLocation;
@ -747,9 +748,16 @@ public class FunctionEditorDialog extends DialogComponentProvider implements Mod
setStatusText("Return name may not be modified");
}
else if ("Storage".equals(getColumnName(column))) {
boolean blockVoidStorageEdit = (rowData.getIndex() == null) &&
VoidDataType.isVoidDataType(rowData.getFormalDataType());
if (!blockVoidStorageEdit) {
setStatusText(
"Enable 'Use Custom Storage' to allow editing of Parameter and Return Storage");
}
else {
setStatusText("Void return storage may not be modified");
}
}
}
}
return isEditable;

36
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/editor/FunctionEditorModel.java
View file

@ -96,6 +96,13 @@ public class FunctionEditorModel {
returnInfo = new ParamInfo(this, function.getReturn());
// check for void storage correction
if (VoidDataType.isVoidDataType(returnInfo.getDataType()) &&
returnInfo.getStorage() != VariableStorage.VOID_STORAGE) {
returnInfo.setStorage(VariableStorage.VOID_STORAGE);
modelChanged = true;
}
autoParamCount = 0;
Parameter[] params = function.getParameters();
for (Parameter parameter : params) {
@ -265,7 +272,7 @@ public class FunctionEditorModel {
}
else if (!allowCustomStorage &&
Function.UNKNOWN_CALLING_CONVENTION_STRING.equals(callingConventionName)) {
if (!(returnType instanceof VoidDataType && parameters.isEmpty())) {
if (!(VoidDataType.isVoidDataType(returnType) && parameters.isEmpty())) {
statusText =
"Warning: No calling convention specified. Ghidra may automatically assign one later.";
}
@ -338,17 +345,9 @@ public class FunctionEditorModel {
return true;
}
private DataType getBaseDataType(DataType dataType) {
if (dataType instanceof TypeDef) {
return ((TypeDef) dataType).getBaseDataType();
}
return dataType;
}
private boolean hasValidReturnType() {
DataType returnType = returnInfo.getDataType();
DataType baseType = getBaseDataType(returnType);
if (baseType instanceof VoidDataType) {
if (VoidDataType.isVoidDataType(returnType)) {
return true;
}
if (returnType.getLength() <= 0) {
@ -377,7 +376,7 @@ public class FunctionEditorModel {
private boolean isValidParamType(ParamInfo param) {
DataType dataType = param.getDataType();
if (dataType.isEquivalent(VoidDataType.dataType)) {
if (VoidDataType.isVoidDataType(dataType)) {
statusText = "\"void\" is not allowed as a parameter datatype.";
return false;
}
@ -800,7 +799,7 @@ public class FunctionEditorModel {
param.setFormalDataType(formalDataType.clone(program.getDataTypeManager()));
if (allowCustomStorage) {
if (isReturn && (formalDataType instanceof VoidDataType)) {
if (isReturn && VoidDataType.isVoidDataType(formalDataType)) {
param.setStorage(VariableStorage.VOID_STORAGE);
}
else {
@ -1099,10 +1098,8 @@ public class FunctionEditorModel {
setCallingConventionName(functionDefinition.getCallingConventionName());
if (!isSameSize(returnInfo.getFormalDataType(), functionDefinition.getReturnType())) {
returnInfo.setStorage(VariableStorage.UNASSIGNED_STORAGE);
}
returnInfo.setFormalDataType(functionDefinition.getReturnType());
DataType returnDt = functionDefinition.getReturnType();
returnInfo.setFormalDataType(returnDt);
List<ParamInfo> oldParams = parameters;
parameters = new ArrayList<>();
@ -1117,6 +1114,13 @@ public class FunctionEditorModel {
fixupOrdinals();
if (allowCustomStorage) {
if (VoidDataType.isVoidDataType(returnDt)) {
returnInfo.setStorage(VariableStorage.VOID_STORAGE);
}
else if (!isSameSize(returnInfo.getFormalDataType(),
functionDefinition.getReturnType())) {
returnInfo.setStorage(VariableStorage.UNASSIGNED_STORAGE);
}
reconcileCustomStorage(oldParams, parameters);
}
else {

4
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/editor/FunctionVariableData.java
View file

@ -19,6 +19,10 @@ import ghidra.program.model.data.DataType;
import ghidra.program.model.listing.VariableStorage;
interface FunctionVariableData {
/**
* {@return parameter ordinal or null for return variable.}
*/
public Integer getIndex();
public void setStorage(VariableStorage storage);

11
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/editor/ParameterTableModel.java
View file

@ -20,6 +20,7 @@ import java.util.List;
import docking.widgets.table.AbstractGTableModel;
import ghidra.program.model.data.DataType;
import ghidra.program.model.data.VoidDataType;
import ghidra.program.model.listing.VariableStorage;
class ParameterTableModel extends AbstractGTableModel<FunctionVariableData> {
@ -223,7 +224,15 @@ class ParameterTableModel extends AbstractGTableModel<FunctionVariableData> {
@Override
public boolean isCellEditable(int rowIndex) {
return canCustomizeStorage;
FunctionVariableData rowData = getRowObject(rowIndex);
if (rowData == null || !canCustomizeStorage) {
return false;
}
if (rowData.getIndex() == null) {
// return parameter - don't permit storage edit for void type
return !VoidDataType.isVoidDataType(rowData.getFormalDataType());
}
return true;
}
@Override

4
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/exceptionhandlers/gcc/DwarfDecoderFactory.java
View file

@ -208,7 +208,7 @@ public class DwarfDecoderFactory {
@Override
public DataType getDataType(Program program) {
return new VoidDataType();
return VoidDataType.dataType;
}
}
@ -370,7 +370,7 @@ public class DwarfDecoderFactory {
@Override
public DataType getDataType(Program program) {
return new VoidDataType();
return VoidDataType.dataType;
}
}

5
Ghidra/Features/Base/src/main/java/ghidra/util/UndefinedFunction.java
View file

@ -327,11 +327,8 @@ public class UndefinedFunction implements Function {
public Parameter getReturn() {
try {
DataType dt = getReturnType();
if (dt instanceof TypeDef) {
dt = ((TypeDef) dt).getBaseDataType();
}
return new ReturnParameterImpl(dt,
(dt instanceof VoidDataType) ? VariableStorage.VOID_STORAGE
VoidDataType.isVoidDataType(dt) ? VariableStorage.VOID_STORAGE
: VariableStorage.UNASSIGNED_STORAGE,
getProgram());
}

2
Ghidra/Features/Base/src/main/java/ghidra/util/state/ResultsState.java
View file

@ -2168,7 +2168,7 @@ public class ResultsState {
}
else {
returnType = func.getReturnType();
if (VoidDataType.dataType.isEquivalent(returnType)) {
if (VoidDataType.isVoidDataType(returnType)) {
return;
}
}

9
Ghidra/Features/Decompiler/ghidra_scripts/classrecovery/RecoveredClassHelper.java
View file

@ -3288,8 +3288,7 @@ public class RecoveredClassHelper {
}
if (returnType.equals("void")) {
DataType voidDataType = new VoidDataType();
constructorFunction.setReturnType(voidDataType, SourceType.ANALYSIS);
constructorFunction.setReturnType(VoidDataType.dataType, SourceType.ANALYSIS);
}
else if (returnType.contains("*")) {
DataType classPointerDataType = dataTypeManager.getPointer(classStruct);
@ -3353,7 +3352,7 @@ public class RecoveredClassHelper {
true);
}
destructorFunction.setReturnType(new VoidDataType(), SourceType.ANALYSIS);
destructorFunction.setReturnType(VoidDataType.dataType, SourceType.ANALYSIS);
}
}
@ -3400,7 +3399,7 @@ public class RecoveredClassHelper {
true, true);
}
vbaseDestructorFunction.setReturnType(new VoidDataType(), SourceType.ANALYSIS);
vbaseDestructorFunction.setReturnType(VoidDataType.dataType, SourceType.ANALYSIS);
}
}
@ -6220,7 +6219,7 @@ public class RecoveredClassHelper {
if (!atexitCalledFunctions.contains(calledFunction)) {
atexitCalledFunctions.add(calledFunction);
}
calledFunction.setReturnType(new VoidDataType(), SourceType.ANALYSIS);
calledFunction.setReturnType(VoidDataType.dataType, SourceType.ANALYSIS);
}
else {
if (!atexitCalledFunctions.contains(calledFunction)) {

3
Ghidra/Features/PDB/src/main/java/ghidra/app/util/pdb/pdbapplicator/PdbPrimitiveTypeApplicator.java
View file

@ -79,8 +79,7 @@ public class PdbPrimitiveTypeApplicator {
DataType getVoidType() {
if (voidGhidraPrimitive == null) {
DataType dataType = new VoidDataType(getDataTypeManager());
voidGhidraPrimitive = resolve(dataType);
voidGhidraPrimitive = resolve(VoidDataType.dataType);
}
return voidGhidraPrimitive;
}

19
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/function/FunctionDB.java
View file

@ -392,7 +392,10 @@ public class FunctionDB extends DatabaseObject implements Function {
return;
}
type = type.clone(program.getDataTypeManager());
if (storage.isValid() && (storage.size() != type.getLength())) {
if (VoidDataType.isVoidDataType(type)) {
storage = VariableStorage.VOID_STORAGE;
}
else if (storage.isValid() && (storage.size() != type.getLength())) {
try {
storage = VariableUtilities.resizeStorage(storage, type, true, this);
}
@ -811,12 +814,8 @@ public class FunctionDB extends DatabaseObject implements Function {
}
dataTypes[0] = returnParam.getFormalDataType();
DataType baseType = dataTypes[0];
if (baseType instanceof TypeDef) {
baseType = ((TypeDef) baseType).getBaseDataType();
}
returnParam
.setDynamicStorage((baseType instanceof VoidDataType) ? VariableStorage.VOID_STORAGE
returnParam.setDynamicStorage(
VoidDataType.isVoidDataType(dataTypes[0]) ? VariableStorage.VOID_STORAGE
: VariableStorage.UNASSIGNED_STORAGE);
PrototypeModel callingConvention = getCallingConvention();
@ -913,12 +912,8 @@ public class FunctionDB extends DatabaseObject implements Function {
ReturnParameterDB rtnParam = getReturn();
if (rtnParam.getVariableStorage().isBadStorage()) {
DataType dt = rtnParam.getDataType();
DataType baseType = dt;
if (baseType instanceof TypeDef) {
baseType = ((TypeDef) baseType).getBaseDataType();
}
VariableStorage storage =
(baseType instanceof VoidDataType) ? VariableStorage.VOID_STORAGE
VoidDataType.isVoidDataType(dt) ? VariableStorage.VOID_STORAGE
: VariableStorage.UNASSIGNED_STORAGE;
rtnParam.setStorageAndDataType(storage, dt);
}

4
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/function/ParameterDB.java
View file

@ -22,10 +22,6 @@ import ghidra.program.model.listing.*;
class ParameterDB extends VariableDB implements Parameter {
/**
* @param function
* @param s
*/
ParameterDB(FunctionDB function, SymbolDB s) {
super(function, s);
}

16
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/function/ReturnParameterDB.java
View file

@ -28,16 +28,17 @@ public class ReturnParameterDB extends ParameterDB {
private DataType dataType;
/**
* @param function
* @param s
*/
ReturnParameterDB(FunctionDB function, DataType dt, VariableStorage storage) {
super(function, null);
this.dataType = dt;
this.storage = storage;
}
@Override
protected boolean isVoidAllowed() {
return true;
}
@Override
public String getName() {
return RETURN_NAME;
@ -123,13 +124,8 @@ public class ReturnParameterDB extends ParameterDB {
VariableStorage newStorage = VariableStorage.UNASSIGNED_STORAGE;
boolean hasCustomVariableStorage = function.hasCustomVariableStorage();
if (hasCustomVariableStorage) {
DataType baseType = type;
if (baseType instanceof TypeDef) {
baseType = ((TypeDef) baseType).getBaseDataType();
}
try {
newStorage =
(baseType instanceof VoidDataType) ? VariableStorage.VOID_STORAGE
newStorage = VoidDataType.isVoidDataType(type) ? VariableStorage.VOID_STORAGE
: VariableUtilities.resizeStorage(getVariableStorage(), type,
alignStack, function);
VariableUtilities.checkStorage(newStorage, type, force);

17
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/function/VariableDB.java
View file

@ -23,8 +23,8 @@ import ghidra.program.database.data.DataTypeUtilities;
import ghidra.program.database.symbol.SymbolDB;
import ghidra.program.database.symbol.VariableSymbolDB;
import ghidra.program.model.address.Address;
import ghidra.program.model.data.AbstractFloatDataType;
import ghidra.program.model.data.DataType;
import ghidra.program.model.data.VoidDataType;
import ghidra.program.model.lang.Register;
import ghidra.program.model.listing.*;
import ghidra.program.model.pcode.Varnode;
@ -53,12 +53,21 @@ public abstract class VariableDB implements Variable {
this.functionMgr = function.getFunctionManager();
}
protected boolean isVoidAllowed() {
return false;
}
@Override
public boolean isValid() {
public final boolean isValid() {
VariableStorage variableStorage = getVariableStorage();
DataType dt = getDataType();
return variableStorage.isValid() &&
((dt instanceof AbstractFloatDataType) || variableStorage.size() == dt.getLength());
if (VoidDataType.isVoidDataType(dt)) {
return isVoidAllowed() && variableStorage.isVoidStorage();
}
if (dt.getLength() <= 0 || !variableStorage.isValid()) {
return false;
}
return variableStorage.size() >= dt.getLength();
}
@Override

16
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/data/VoidDataType.java
View file

@ -93,4 +93,20 @@ public class VoidDataType extends BuiltIn {
return null; // standard C name and type
}
/**
* Determine if the specified {@link DataType} is a {@link VoidDataType} after
* stripping away any {@link TypeDef}.
* @param dt datatype to be tested
* @return true if dt is a void type
*/
public static boolean isVoidDataType(DataType dt) {
if (dt == null) {
return false;
}
if (dt instanceof TypeDef t) {
dt = t.getBaseDataType();
}
return dt instanceof VoidDataType;
}
}

6
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/lang/ParamListStandard.java
View file

@ -80,11 +80,7 @@ public class ParamListStandard implements ParamList {
if (tp == null) {
tp = DataType.DEFAULT;
}
DataType baseType = tp;
if (baseType instanceof TypeDef) {
baseType = ((TypeDef) baseType).getBaseDataType();
}
if (baseType instanceof VoidDataType) {
if (VoidDataType.isVoidDataType(tp)) {
return VariableStorage.VOID_STORAGE;
}
int sz = tp.getLength();

16
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableImpl.java
View file

@ -264,9 +264,13 @@ abstract class VariableImpl implements Variable {
@Override
public final boolean isValid() {
DataType dt = getDataType();
return variableStorage.isValid() &&
((dt instanceof AbstractFloatDataType) || variableStorage.size() == dt.getLength());
if (VoidDataType.isVoidDataType(dataType)) {
return isVoidAllowed() && variableStorage.isVoidStorage();
}
if (dataType.getLength() <= 0 || !variableStorage.isValid()) {
return false;
}
return variableStorage.size() >= dataType.getLength();
}
@Override
@ -302,11 +306,7 @@ abstract class VariableImpl implements Variable {
public void setDataType(DataType type, SourceType source) throws InvalidInputException {
type =
VariableUtilities.checkDataType(type, isVoidAllowed(), dataType.getLength(), program);
DataType baseType = type;
if (baseType instanceof TypeDef) {
baseType = ((TypeDef) baseType).getBaseDataType();
}
variableStorage = (baseType instanceof VoidDataType) ? VariableStorage.VOID_STORAGE
variableStorage = VoidDataType.isVoidDataType(type) ? VariableStorage.VOID_STORAGE
: resizeStorage(variableStorage, type);
dataType = type;
}

19
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/VariableUtilities.java
View file

@ -372,6 +372,17 @@ public class VariableUtilities {
*/
public static VariableStorage resizeStorage(VariableStorage curStorage, DataType dataType,
boolean alignStack, Function function) throws InvalidInputException {
if (dataType instanceof TypeDef td) {
dataType = td.getBaseDataType();
}
if (dataType instanceof VoidDataType) {
return VariableStorage.VOID_STORAGE;
}
if (dataType instanceof AbstractFloatDataType) {
return curStorage; // do not constrain or attempt resize of float storage
}
if (!curStorage.isValid()) {
return curStorage;
}
@ -380,17 +391,11 @@ public class VariableUtilities {
if (curSize == newSize) {
return curStorage;
}
if (curSize == 0 || curStorage.isUniqueStorage() || curStorage.isHashStorage()) {
throw new InvalidInputException("Storage can't be resized: " + curStorage.toString());
}
if (dataType instanceof TypeDef) {
dataType = ((TypeDef) dataType).getBaseDataType();
}
if (dataType instanceof AbstractFloatDataType) {
return curStorage; // do not constrain or attempt resize of float storage
}
if (newSize > curSize) {
return expandStorage(curStorage, newSize, dataType, alignStack, function);
}