Package ghidra.app.util.bin.format.dwarf.external

Class BuildIdDebugFileProvider

java.lang.Object

ghidra.app.util.bin.format.dwarf.external.BuildIdDebugFileProvider

All Implemented Interfaces:

DebugFileProvider, DebugInfoProvider

public class BuildIdDebugFileProvider
extends Object
implements DebugFileProvider

A DebugFileProvider that expects the external debug files to be named using the hexadecimal value of the hash of the file, and to be arranged in a bucketed directory hierarchy using the first 2 hexdigits of the hash.

For example, the debug file with hash 6addc39dc19c1b45f9ba70baf7fd81ea6508ea7f would be stored as "6a/ddc39dc19c1b45f9ba70baf7fd81ea6508ea7f.debug" (under some root directory).

Constructor Summary

Constructors

Constructor	Description
BuildIdDebugFileProvider(File rootDir)	Creates a new BuildIdDebugFileProvider at the specified directory.

Method Summary

Modifier and Type	Method	Description
static BuildIdDebugFileProvider	create(String name, DebugInfoProviderCreatorContext context)	Creates a new BuildIdDebugFileProvider instance using the specified name string.
String	getDescriptiveName()	Returns a human formatted string describing this provider, used in UI prompts or lists.
File	getFile(ExternalDebugInfo debugInfo, TaskMonitor monitor)	Searches for a debug file that fulfills the criteria specified in the ExternalDebugInfo.
String	getName()	Returns the name of this instance, which should be a serialized copy of this instance, typically like "something://serialized_data".
DebugInfoProviderStatus	getStatus(TaskMonitor monitor)	Returns DebugInfoProviderStatus representing this provider's current status.
static boolean	matches(String name)	Returns true if the specified name string specifies a BuildIdDebugFileProvider.

Methods inherited from class java.lang.Object

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

Constructor Details

BuildIdDebugFileProvider

public BuildIdDebugFileProvider(File rootDir)

Creates a new BuildIdDebugFileProvider at the specified directory.

Parameters:

rootDir - path to the root directory of the build-id directory (typically ends with "./build-id")

Method Details

matches

public static boolean matches(String name)

Returns true if the specified name string specifies a BuildIdDebugFileProvider.

Parameters:

name - string to test

Returns:

boolean true if name specifies a BuildIdDebugFileProvider

create

public static BuildIdDebugFileProvider create(String name,
 DebugInfoProviderCreatorContext context)

Creates a new BuildIdDebugFileProvider instance using the specified name string.

Parameters:

name - string, earlier returned from getName()

context - DebugInfoProviderCreatorContext to allow accessing information outside of the name string that might be needed to create a new instance

Returns:

new BuildIdDebugFileProvider instance

getName

public String getName()

Description copied from interface: DebugInfoProvider

Returns the name of this instance, which should be a serialized copy of this instance, typically like "something://serialized_data".

Specified by:

getName in interface DebugInfoProvider

Returns:

the name of this instance, which should be a serialized copy of this instance, typically like "something://serialized_data"

getDescriptiveName

public String getDescriptiveName()

Description copied from interface: DebugInfoProvider

Returns a human formatted string describing this provider, used in UI prompts or lists.

Specified by:

getDescriptiveName in interface DebugInfoProvider

Returns:

a human formatted string describing this provider, used in UI prompts or lists

getStatus

public DebugInfoProviderStatus getStatus(TaskMonitor monitor)

Description copied from interface: DebugInfoProvider

Returns DebugInfoProviderStatus representing this provider's current status.

Specified by:

getStatus in interface DebugInfoProvider

Parameters:

monitor - TaskMonitor

Returns:

DebugInfoProviderStatus representing this provider's current status

getFile

public File getFile(ExternalDebugInfo debugInfo,
 TaskMonitor monitor)
             throws IOException,
CancelledException

Description copied from interface: DebugFileProvider

Searches for a debug file that fulfills the criteria specified in the ExternalDebugInfo.

Specified by:

getFile in interface DebugFileProvider

Parameters:

debugInfo - search criteria

monitor - TaskMonitor

Returns:

File of the matching file, or null if not found

Throws:

IOException - if error

CancelledException - if cancelled