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

GP-5773 DWARF: add all source files

Browse source
This commit is contained in:
James 2025-06-25 19:34:00 +00:00
parent 7482131bcc
commit cd549a0805
3 changed files with 93 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

70
Ghidra/Features/Base/ghidra_scripts/DWARFLineInfoSourceMapScript.java
View file

@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Adds DWARF source file line number info to the current program as source map entries.
// Adds DWARF source file info to the current program.
// A source file that is relative after path normalization will have all leading "."
// and "/../" entries stripped and then be placed under an artificial directory.
// Note that you can run this script on a program that has already been analyzed by the
@ -25,7 +25,9 @@ import java.util.*;
import ghidra.app.script.GhidraScript;
import ghidra.app.util.bin.BinaryReader;
import ghidra.app.util.bin.format.dwarf.*;
import ghidra.app.util.bin.format.dwarf.line.DWARFLine;
import ghidra.app.util.bin.format.dwarf.line.DWARFLine.SourceFileAddr;
import ghidra.app.util.bin.format.dwarf.line.DWARFLine.SourceFileInfo;
import ghidra.app.util.bin.format.dwarf.sectionprovider.DWARFSectionProvider;
import ghidra.app.util.bin.format.dwarf.sectionprovider.DWARFSectionProviderFactory;
import ghidra.framework.store.LockException;
@ -77,19 +79,54 @@ public class DWARFLineInfoSourceMapScript extends GhidraScript {
int entryCount = 0;
List<DWARFCompilationUnit> compUnits = dprog.getCompilationUnits();
SourceFileManager sourceManager = currentProgram.getSourceFileManager();
monitor.initialize(compUnits.size(), "DWARF: Reading Source Information");
// add all the source files and read the source map entries
Map<SourceFileInfo, SourceFile> sourceFileInfoToSourceFile = new HashMap<>();
Set<SourceFileInfo> badSourceFileInfo = new HashSet<>();
List<SourceFileAddr> sourceInfo = new ArrayList<>();
monitor.initialize(compUnits.size(), "DWARF: Reading Source Map Info");
for (DWARFCompilationUnit cu : compUnits) {
DWARFLine dLine = cu.getLine();
monitor.increment();
for (int i = 0; i < dLine.getNumFiles(); ++i) {
String filePath = dLine.getFilePath(i, true);
if (filePath == null) {
continue;
}
byte[] md5 = dLine.getFile(i).getMD5();
SourceFileInfo sfi = new SourceFileInfo(filePath, md5);
if (sourceFileInfoToSourceFile.containsKey(sfi)) {
continue;
}
if (badSourceFileInfo.contains(sfi)) {
continue;
}
try {
String path = SourceFileUtils.normalizeDwarfPath(filePath,
COMPILATION_ROOT_DIRECTORY);
SourceFileIdType type =
md5 == null ? SourceFileIdType.NONE : SourceFileIdType.MD5;
SourceFile sFile = new SourceFile(path, type, md5);
sourceManager.addSourceFile(sFile);
sourceFileInfoToSourceFile.put(sfi, sFile);
}
catch (IllegalArgumentException e) {
if (numErrors++ < MAX_ERROR_MSGS_TO_DISPLAY) {
printerr("Exception creating source file %s".formatted(e.getMessage()));
}
badSourceFileInfo.add(sfi);
continue;
}
}
sourceInfo.addAll(cu.getLine().getAllSourceFileAddrInfo(cu, reader));
}
monitor.setIndeterminate(true);
monitor.setMessage("Sorting " + sourceInfo.size() + " entries");
sourceInfo.sort((i, j) -> Long.compareUnsigned(i.address(), j.address()));
monitor.setIndeterminate(false);
monitor.initialize(sourceInfo.size(), "DWARF: Applying Source Map Info");
Map<SourceFileAddr, SourceFile> sfasToSourceFiles = new HashMap<>();
Set<SourceFileAddr> badSfas = new HashSet<>();
AddressSet warnedAddresses = new AddressSet();
for (int i = 0; i < sourceInfo.size(); i++) {
monitor.increment(1);
@ -100,8 +137,9 @@ public class DWARFLineInfoSourceMapScript extends GhidraScript {
if (sourceFileAddr.fileName() == null) {
continue;
}
if (badSfas.contains(sourceFileAddr)) {
SourceFileInfo sfi =
new SourceFileInfo(sourceFileAddr.fileName(), sourceFileAddr.md5());
if (badSourceFileInfo.contains(sfi)) {
continue;
}
@ -142,25 +180,7 @@ public class DWARFLineInfoSourceMapScript extends GhidraScript {
}
SourceFile source = sfasToSourceFiles.get(sourceFileAddr);
if (source == null) {
try {
String path = SourceFileUtils.normalizeDwarfPath(sourceFileAddr.fileName(),
COMPILATION_ROOT_DIRECTORY);
SourceFileIdType type =
sourceFileAddr.md5() == null ? SourceFileIdType.NONE : SourceFileIdType.MD5;
source = new SourceFile(path, type, sourceFileAddr.md5());
sourceManager.addSourceFile(source);
sfasToSourceFiles.put(sourceFileAddr, source);
}
catch (IllegalArgumentException e) {
if (numErrors++ < MAX_ERROR_MSGS_TO_DISPLAY) {
printerr("Exception creating source file %s".formatted(e.getMessage()));
}
badSfas.add(sourceFileAddr);
continue;
}
}
SourceFile source = sourceFileInfoToSourceFile.get(sfi);
try {
sourceManager.addSourceMapEntry(source, sourceFileAddr.lineNum(), addr, length);
}

74
Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/DWARFImporter.java
View file

@ -22,7 +22,9 @@ import org.apache.commons.io.FilenameUtils;
import ghidra.app.plugin.core.datamgr.util.DataTypeUtils;
import ghidra.app.util.bin.BinaryReader;
import ghidra.app.util.bin.format.dwarf.line.DWARFLine;
import ghidra.app.util.bin.format.dwarf.line.DWARFLine.SourceFileAddr;
import ghidra.app.util.bin.format.dwarf.line.DWARFLine.SourceFileInfo;
import ghidra.app.util.bin.format.dwarf.line.DWARFLineProgramExecutor;
import ghidra.app.util.bin.format.golang.GoConstants;
import ghidra.framework.store.LockException;
@ -211,23 +213,58 @@ public class DWARFImporter {
Program ghidraProgram = prog.getGhidraProgram();
long maxLength = prog.getImportOptions().getMaxSourceMapEntryLength();
List<DWARFCompilationUnit> compUnits = prog.getCompilationUnits();
monitor.initialize(compUnits.size(), "DWARF: Reading Source Map Info");
monitor.initialize(compUnits.size(), "DWARF: Reading Source Information");
SourceFileManager sourceManager = ghidraProgram.getSourceFileManager();
// add all the source files and read the source map entries
Map<SourceFileInfo, SourceFile> sourceFileInfoToSourceFile = new HashMap<>();
Set<SourceFileInfo> badSourceFileInfo = new HashSet<>();
List<SourceFileAddr> sourceInfo = new ArrayList<>();
for (DWARFCompilationUnit cu : compUnits) {
monitor.increment();
DWARFLine dLine = cu.getLine();
monitor.increment(1);
for (int i = 0; i < dLine.getNumFiles(); ++i) {
String filePath = dLine.getFilePath(i, true);
if (filePath == null) {
continue;
}
byte[] md5 = dLine.getFile(i).getMD5();
SourceFileInfo sfi = new SourceFileInfo(filePath, md5);
if (sourceFileInfoToSourceFile.containsKey(sfi)) {
continue;
}
if (badSourceFileInfo.contains(sfi)) {
continue;
}
try {
String path = SourceFileUtils.normalizeDwarfPath(filePath,
DEFAULT_COMPILATION_DIR);
SourceFileIdType type =
md5 == null ? SourceFileIdType.NONE : SourceFileIdType.MD5;
SourceFile sFile = new SourceFile(path, type, md5);
sourceManager.addSourceFile(sFile);
sourceFileInfoToSourceFile.put(sfi, sFile);
}
catch (IllegalArgumentException e) {
String errorString = "Exception creating source file: " + e.getMessage();
if (numSourceLineErrorReports++ < MAX_NUM_SOURCE_LINE_ERROR_REPORTS) {
Msg.error(this, errorString);
}
badSourceFileInfo.add(sfi);
continue;
}
}
sourceInfo.addAll(cu.getLine().getAllSourceFileAddrInfo(cu, reader));
}
monitor.setIndeterminate(true);
monitor.setMessage("Sorting " + sourceInfo.size() + " entries");
sourceInfo.sort((i, j) -> Long.compareUnsigned(i.address(), j.address()));
monitor.setIndeterminate(false);
monitor.initialize(sourceInfo.size(), "DWARF: Applying Source Map Info");
Map<SourceFileAddr, SourceFile> sfasToSourceFiles = new HashMap<>();
Set<SourceFileAddr> badSfas = new HashSet<>();
AddressSet warnedAddresses = new AddressSet();
for (int i = 0; i < sourceInfo.size() - 1; i++) {
AddressSet warnedAddresses = new AddressSet();
for (int i = 0; i < sourceInfo.size(); i++) {
monitor.increment(1);
SourceFileAddr sfa = sourceInfo.get(i);
if (SOURCEFILENAMES_IGNORE.contains(sfa.fileName()) ||
@ -238,7 +275,8 @@ public class DWARFImporter {
if (sfa.fileName() == null) {
continue;
}
if (badSfas.contains(sfa)) {
SourceFileInfo sfi = new SourceFileInfo(sfa.fileName(), sfa.md5());
if (badSourceFileInfo.contains(sfi)) {
continue;
}
@ -281,27 +319,7 @@ public class DWARFImporter {
}
}
SourceFile source = sfasToSourceFiles.get(sfa);
if (source == null) {
try {
String path = SourceFileUtils.normalizeDwarfPath(sfa.fileName(),
DEFAULT_COMPILATION_DIR);
SourceFileIdType type =
sfa.md5() == null ? SourceFileIdType.NONE : SourceFileIdType.MD5;
source = new SourceFile(path, type, sfa.md5());
sourceManager.addSourceFile(source);
sfasToSourceFiles.put(sfa, source);
}
catch (IllegalArgumentException e) {
String errorString = "Exception creating source file: " + e.getMessage();
if (numSourceLineErrorReports++ < MAX_NUM_SOURCE_LINE_ERROR_REPORTS) {
reportError(errorString, addr);
}
badSfas.add(sfa);
continue;
}
}
SourceFile source = sourceFileInfoToSourceFile.get(sfi);
try {
sourceManager.addSourceMapEntry(source, sfa.lineNum(), addr, length);
}

2
Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/dwarf/line/DWARFLine.java
View file

@ -270,6 +270,8 @@ public class DWARFLine {
return lpe;
}
public record SourceFileInfo(String filePath, byte[] md5) {}
public record SourceFileAddr(long address, String fileName, byte[] md5, int lineNum,
boolean isEndSequence) {}