Skip to content

SDKtoGhidra: apply the XML's calling convention when importing functions #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jatassi wants to merge 1 commit into from
Closed

SDKtoGhidra: apply the XML's calling convention when importing functions #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions SDKtoGhidra/GhidraScript/ImportSporeSDK.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,15 +280,19 @@ else if (s.getSymbolType() == SymbolType.FUNCTION) {
}
}

private static GenericCallingConvention getCallingConvention(String text) {
// Maps the XML's CONVENTION attribute to the name Ghidra's compiler specs use.
// The deprecated FunctionDefinition.setGenericCallingConvention stores the bare enum
// name ("thiscall"), which no compiler spec recognises, so the definition reads as an
// unknown convention and the this-in-ECX branch in createParameters never runs.
private static String getCallingConvention(String text) {
switch (text)
{
case "cdecl": return GenericCallingConvention.cdecl;
case "fastcall": return GenericCallingConvention.fastcall;
case "stdcall": return GenericCallingConvention.stdcall;
case "thiscall": return GenericCallingConvention.thiscall;
case "vectorcall": return GenericCallingConvention.vectorcall;
case "unknown": return GenericCallingConvention.unknown;
case "cdecl": return CompilerSpec.CALLING_CONVENTION_cdecl;
case "fastcall": return CompilerSpec.CALLING_CONVENTION_fastcall;
case "stdcall": return CompilerSpec.CALLING_CONVENTION_stdcall;
case "thiscall": return CompilerSpec.CALLING_CONVENTION_thiscall;
case "vectorcall": return CompilerSpec.CALLING_CONVENTION_vectorcall;
case "unknown": return CompilerSpec.CALLING_CONVENTION_unknown;
default: return null;
}
}
Expand Down Expand Up @@ -574,7 +578,15 @@ private static void removeCodeSymbol(SymbolTable symbolTable, Address address, S
}
}

// The signature carries the convention the XML declared. Use it when the compiler spec
// knows it; otherwise keep whatever the function already has (after auto-analysis that
// is "unknown").
private static String getCallingConvention(Function function, FunctionSignature signature, CompilerSpec compilerSpec) {
String name = signature.getCallingConventionName();
if (name != null && !signature.hasUnknownCallingConventionName()
&& compilerSpec.getCallingConvention(name) != null) {
return name;
}
return function.getCallingConventionName();
}

Expand Down Expand Up @@ -712,12 +724,17 @@ private boolean processFunctionDef(XmlTreeNode root, boolean firstPass) {
if (element.hasAttribute("CONVENTION")) {
callingConvention = element.getAttribute("CONVENTION");
}
GenericCallingConvention convention = getCallingConvention(callingConvention);
String convention = getCallingConvention(callingConvention);
if (convention == null)
{
throw new IllegalArgumentException("Unknown calling convention '" + convention + "' in function " + path + "/" + name);
throw new IllegalArgumentException("Unknown calling convention '" + callingConvention + "' in function " + path + "/" + name);
}
try {
fd.setCallingConvention(convention);
}
catch (InvalidInputException e) {
throw new IllegalArgumentException("Calling convention '" + convention + "' rejected for function " + path + "/" + name, e);
}
fd.setGenericCallingConvention​(convention);

XmlTreeNode node = root.getChild("RETURN_TYPE");
if (node != null) {
Expand Down