Searching Datatype in all opened Data Type Archives from an Analysis

[fmagin]

I am writing an analysis and during that I need to check if a datatype with a certain name already exists in any of the open data type archives. Specifically there is a high chance that the datatype is already defined in a file archive that is opened by default, like the mac_osx archive.

The FindDataTypeScript searches all open datatype managers via tool.getService(DataTypeManagerService.class)

ghidra/Ghidra/Features/Base/ghidra_scripts/FindDataTypeScript.java

Lines 72 to 80 in fafbaac

	PluginTool tool = state.getTool();
	DataTypeManagerService service = tool.getService(DataTypeManagerService.class);
	DataTypeManager[] dataTypeManagers = service.getDataTypeManagers();
	for (DataTypeManager manager : dataTypeManagers) {
	String managerName = manager.getName();
	if (name.equals(managerName)) {
	return manager;
	}
	}

but the tool object isn't obviously available inside ghidra.app.services.Analyzer#added(Program program, AddressSetView set, TaskMonitor monitor, MessageLog log) and the supplied Program.getDataTypeManager will be only the DataTypeManager for the program itself.

@astrelsky has a snippet that searches the consumers of the Program object for a PluginTool, but this seems like a giant hack

	public static PluginTool getTool(DomainObject obj) {
		for (Object o : obj.getConsumerList()) {
			if (o instanceof PluginTool) {
				return (PluginTool) o;
			}
		}
		return null;
	}

https://github.com/astrelsky/Ghidra-Cpp-Class-Analyzer/blob/933cc702fe7abcca62a5090dbc67b25f15e3c020/src/main/java/cppclassanalyzer/utils/CppClassAnalyzerUtils.java#L42-L49

[astrelsky]

It is a giant hack but it is guaranteed to be there. Since you are writing an Analyzer you could do it this way.

private DataTypeManagerService getDataTypeManagerService(Program program) {
    AutoAnalysisManager man = AutoAnalysisManager.getAnalysisManager(program);
    if (man == null) {
        // unlikely edge case
        return null;
    }
    return man.getDataTypeManagerService();
}

[dev747368]

[dev747368]

Its a pain for sure. For example, the pdb analyzer has to consult global app preferences for previously configured symbol search locations, and if you want to toggle the "allow remote" boolean, there is an example headless prescript (PdbSymbolServerExamplePrescript) you can use in a headless env.

The older pdb analyzer used to have calls to SystemUtilities.isInHeadlessMode() and popup GUI dialogs directly.

[ryanmkurtz]

My meme was trying to hint...

Memes you have to explain are best memes!

[fmagin]

To give @dev747368 some credit here, the meme got the overall point across fairly well. But I also ran into a problem with @astrelsky C++ plugin straight up crashing when you run the headless analyzer without activating the plugin via the GUI first so I was already familiar with his disregard for the headless analyzer :P

I am actually quite concerned about this working with the Headless Analyzer. The archive I am specifically interested in is https://github.com/PoomSmart/IDAObjcTypes, so I don't really need to search every available archive. If it isn't in that specific one or the ProgramDataTypeManager then it is probably not available.
Is there some default location a GDT archive can be placed so I can easily open it from an Analyzer (that might be in headless mode)? I guess I can just ship the archive with my extension that provides the analyzer

[dev747368]

Some untested ideas:

1. Have a companion plugin (FooAnalyzerConfigurationPlugin), that adds an action to the popup menu of the DataTypeManager GUI that gives the user a chance to add or remove the selected DT archive from a list you write as a ghidra.framework.preferences.Preference property. (con: if you record the path/name of the archive, the user could move it and break the association)
2. Have a folder in your ghidra project (ie. yourproject:/fooAnalyzerDataTypes) where the analyzer will fetch / open any archive placed there by the user.
3. Use a plain analyzer option (Analyzer.registerOptions) to let the user type the name of the archive you want. Include a FooAnalyzerHeadlessPrescript.java that tweaks the analyzer options, and that the user can modify to their needs. See FunctionIDHeadlessPrescript, and the getCurrentAnalysisOptionsAndValues().

so I was already familiar with his disregard for the headless analyzer :P

😄

[astrelsky]

I prefer to keep my head thank you very much. Not sure doing development headless is a great idea.

But in all seriousness it's mostly because I don't use it and wouldn't know that I broke it. If you hadn't put the link to that pr in the comment I would have been pulling my hair out looking for the bug because I had completely forgotten about it. I'm personally more interested in tools for when you have to roll up your sleeves and do things manually as opposed to automation.