Class SleighLanguageProvider

java.lang.Object

ghidra.app.plugin.processors.sleigh.SleighLanguageProvider

All Implemented Interfaces:

LanguageProvider, ExtensionPoint

public class SleighLanguageProvider
extends Object
implements LanguageProvider

Searches resources for spec files and provides LanguageDescriptions for these specifications

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	LANGUAGE_LOCK_TIMEOUT	Timeout used when trying to acquire the sla file lock.
static final String	LANGUAGE_LOCK_TIMEOUT_PROPNAME	Property that can be set as a jvm startup option to control the sla lock timeout duration.

Method Summary

Modifier and Type	Method	Description
SleighLanguage	getLanguage(LanguageID languageId, TaskMonitor monitor)	Returns the language with the given name or null if no language has that name.
SleighLanguageDescription	getLanguageDescription(LanguageID languageId)	Returns the language description of the specified language
LanguageDescription[]	getLanguageDescriptions()	Returns a list of language descriptions provided by this provider
static SleighLanguageProvider	getSleighLanguageProvider()	Returns a singleton instance of a SleighLanguageProvider.
boolean	hadLoadFailure()
boolean	isLanguageLoaded(LanguageID languageId)	Returns true if the given language has been successfully loaded

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface LanguageProvider

getLanguage

Field Details

LANGUAGE_LOCK_TIMEOUT_PROPNAME

public static final String LANGUAGE_LOCK_TIMEOUT_PROPNAME

Property that can be set as a jvm startup option to control the sla lock timeout duration.

See LANGUAGE_LOCK_TIMEOUT.

See Also:

• Constant Field Values

LANGUAGE_LOCK_TIMEOUT

public static final Duration LANGUAGE_LOCK_TIMEOUT

Timeout used when trying to acquire the sla file lock. (Default: 60 seconds)

The sla lock is acquired and held during .sla file checking and writing (compiling). Currently parsing the sla xml is done after releasing the lock.

If a Ghidra process is trying to fetch a sleigh language, which requires acquiring the lock on a sla file, and it times out before succeeding, the caller will get a LanguageNotFoundException exception.

This timeout should be long enough to allow the process that has the lock to finish compiling and writing the slaspec so that the waiting process does not give up too quickly and give an error to the user. See LANGUAGE_LOCK_TIMEOUT_PROPNAME.

Method Details

getSleighLanguageProvider

public static SleighLanguageProvider getSleighLanguageProvider()

Returns a singleton instance of a SleighLanguageProvider.

Returns:

singleton SleighLanguageProvider

hadLoadFailure

public boolean hadLoadFailure()

Specified by:

hadLoadFailure in interface LanguageProvider

Returns:

true if one of more languages or language description failed to load properly.

isLanguageLoaded

public boolean isLanguageLoaded(LanguageID languageId)

Description copied from interface: LanguageProvider

Returns true if the given language has been successfully loaded

Specified by:

isLanguageLoaded in interface LanguageProvider

Parameters:

languageId - the name of the language to be retrieved

Returns:

true if the given language has been successfully loaded

getLanguage

public SleighLanguage getLanguage(LanguageID languageId,
 TaskMonitor monitor)
                           throws LanguageNotFoundException

Description copied from interface: LanguageProvider

Returns the language with the given name or null if no language has that name.

Specified by:

getLanguage in interface LanguageProvider

Parameters:

languageId - the name of the language to be retrieved

monitor - TaskMonitor

Returns:

the Language with the given name or null if not found

Throws:

LanguageNotFoundException - if language instantiation error

getLanguageDescription

public SleighLanguageDescription getLanguageDescription(LanguageID languageId)

Returns the language description of the specified language

Parameters:

languageId - LanguageID

Returns:

SleighLanguageDescription

getLanguageDescriptions

public LanguageDescription[] getLanguageDescriptions()

Description copied from interface: LanguageProvider

Returns a list of language descriptions provided by this provider

Specified by:

getLanguageDescriptions in interface LanguageProvider