A program database (PDB) file holds debugging and project state information about a program
- and can be created in a number of ways. Historically, it has been created using a Microsoft
- compiler and written in C/C++, C#, and Visual Basic.
- A user generates a PDB file using the /ZI or /Zi flag (for C/C++ programs) or the
- /debug flag (for Visual Basic/C# programs).
-
-
There are two mechanisms for processing a PDB file. First, the platform-independent
- PDB Universal Reader/Analyzer, which can read a raw PDB file and apply it. Its capabilities
- are expected to be expanded in future releases. Second, the legacy capability that uses the
- DIA SDK to read information from the PDB file. This mechanism can only run
- on a Windows platform, however it creates an XML representation of information gleaned using
- the DIA SDK. These XML files can be saved and then used on Windows and non-Windows platforms
- hosting Ghidra.
-
-
If loading a PDB, this should be done prior to other analysis, except in special cases,
- such as when only loading data types.
-
-
Restricted loading of data types or public symbols is
- supported by PDB Universal.
-
-
To Load a PDB
-
-
-
-
From the menu-bar of a tool, select File Load PDB File
-
-
In the file chooser, select the PDB file (*.PDB or *.PDB.XML)
-
-
Click the "Select PDB" button
-
-
-
-
PDB Universal is automatically used for *.PDB on non-Windows platforms
-
PDB MSDIA is used for *.PDB.XML files
-
-
-
When a user chooses a PDB or XML file to load for a program, Ghidra will verify its
- signature to be valid for the program. At this time, the PDB MSDIA loader cannot be used to
- force-load a mismatched PDB. To perform a force-load of a PDB file, the user must choose the
- PDB Universal loader if given the option. Force-loading an mismatched file can have
- consequences, such as loading incorrect data types and symbols located at the wrong
- addresses.
-
-
- PDB files may also be loaded using the PDB Analyzer, which is available through
- Auto Analysis or as
- a One Shot Analyzer.
-
-
-
-
Information Loaded From PDB
-
-
-
-
Structure and union definitions
-
-
Typedefs
-
-
Enumerations
-
-
Class definitions
-
-
Function prototypes
-
-
Stack variable names and data types
-
-
Source line numbers
-
-
Instruction and data symbols
-
-
-
-
Loading Errors
-
-
-
Before the PDB file is loaded into the program, then PDB signature and age are matched
- against the information stored in the executable. If these values do not match, then the PDB
- will not be loaded.
-
-
-
-
Figure 1
-
-
-
The DIA SDK-Based Capability
-
-
*.PDB.XML files can be created in three different ways:
-
-
-
From the Ghidra GUI in Windows, use the
- Ghidra Script Manager
- to run the CreatePdbXmlFilesScript.java script. Follow the prompts to choose
- the .PDB file (or directory containing .PDB file(s)) to be converted to .PDB.XML form.
- When given a directory, the script recursively traverses all subfolders to find .PDB
- files. A created .PDB.XML file is placed in the same location as the corresponding original
- .PDB file.
-
-
From a Windows command line, navigate to the following directory:
- <ghidra install root>/support
- and run the createPdbXmlFiles.bat script. The script takes one argument representing
- either one .PDB file or a directory of .PDB files. When given a directory, the script
- recursively traverses all subdirectories to find .PDB files. A created .PDB.XML file is
- placed in the same location as the corresponding original .PDB file. Sample calls to the
- script are shown below.
-
Run the included pdb.exe executable (found in the <ghidra install
- root>/Ghidra/Features/PDB/os/win64 directory) and redirect (save) its output to an
- XML file as shown below:
-
- pdb.exe samplePdb.pdb > samplePdb.pdb.xml
-
-
-
-
NOTE: Execution of pdb.exe has runtime dependencies which must be satisfied.
- Please refer to the README_PDB document for details.
-
-
Debug Interface Access SDK
-
-
-
The Microsoft Debug Interface Access Software Development Kit (DIA SDK) provides access to
- debug information stored in program database (.PDB) files generated by Microsoft
- post-compiler tools. Because the format of the .PDB file generated by the post-compiler tools
- undergoes constant revision, exposing the format is impractical. Using the DIA API, you can
- develop applications that search for and browse debug information stored in a .PDB file. Such
- applications could, for example, report stack trace-back information and analyze performance
- data.
-
-
If you are attempting to load a PDB on a
- Windows machine and see an error message such as "Unable to locate the DIA SDK,"
- you will need to add and register one or more files on your computer. Refer to the
- README_PDB document for detailed instructions.
-
-
-
-
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java
index c07c127c00..c7006f9a4f 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/BinaryReader.java
@@ -66,11 +66,13 @@ public class BinaryReader {
this.provider = provider;
setLittleEndian(isLittleEndian);
}
-
+
/**
- * Returns a clone of this reader positioned at the new index.
+ * Returns a clone of this reader, with its own independent current position,
+ * positioned at the new index.
+ *
* @param newIndex the new index
- * @return a clone of this reader positioned at the new index
+ * @return an independent clone of this reader positioned at the new index
*/
public BinaryReader clone(long newIndex) {
BinaryReader clone = new BinaryReader(provider, isLittleEndian());
@@ -88,6 +90,36 @@ public class BinaryReader {
return clone(currentIndex);
}
+ /**
+ * Returns a BinaryReader that is in BigEndian mode.
+ *
+ * @return either this same instance (if already BigEndian), or a new instance
+ * (at the same location) in BigEndian mode
+ */
+ public BinaryReader asBigEndian() {
+ if (isBigEndian()) {
+ return this;
+ }
+ BinaryReader result = clone(currentIndex);
+ result.setLittleEndian(false);
+ return result;
+ }
+
+ /**
+ * Returns a BinaryReader that is in LittleEndian mode.
+ *
+ * @return either this same instance (if already LittleEndian), or a new instance
+ * (at the same location) in LittleEndian mode
+ */
+ public BinaryReader asLittleEndian() {
+ if (!isBigEndian()) {
+ return this;
+ }
+ BinaryReader result = clone(currentIndex);
+ result.setLittleEndian(true);
+ return result;
+ }
+
/**
* Returns true if this reader will extract values in little endian,
* otherwise in big endian.
@@ -97,6 +129,15 @@ public class BinaryReader {
return converter instanceof LittleEndianDataConverter;
}
+ /**
+ * Returns true if this reader will extract values in big endian.
+ *
+ * @return true is big endian, false is little endian
+ */
+ public boolean isBigEndian() {
+ return converter instanceof BigEndianDataConverter;
+ }
+
/**
* Sets the endian of this binary reader.
* @param isLittleEndian true for little-endian and false for big-endian
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbFactory.java
deleted file mode 100644
index 7dbf1cecaf..0000000000
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbFactory.java
+++ /dev/null
@@ -1,53 +0,0 @@
-/* ###
- * IP: GHIDRA
- * REVIEWED: YES
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package ghidra.app.util.bin.format.pdb;
-
-import java.io.*;
-
-import ghidra.app.util.bin.*;
-import ghidra.framework.*;
-
-public class PdbFactory {
- static {
- PluggableServiceRegistry.registerPluggableService(PdbFactory.class,
- new PdbFactory());
- }
-
- public static PdbInfoDotNetIface getPdbInfoDotNetInstance(
- BinaryReader reader, int ptr) throws IOException {
- PdbFactory factory = PluggableServiceRegistry
- .getPluggableService(PdbFactory.class);
- return factory.doGetPdbInfoDotNetInstance(reader, ptr);
- }
-
- public static PdbInfoIface getPdbInfoInstance(BinaryReader reader, int ptr)
- throws IOException {
- PdbFactory factory = PluggableServiceRegistry
- .getPluggableService(PdbFactory.class);
- return factory.doGetPdbInfoInstance(reader, ptr);
- }
-
- protected PdbInfoDotNetIface doGetPdbInfoDotNetInstance(
- BinaryReader reader, int ptr) throws IOException {
- return null;
- }
-
- protected PdbInfoIface doGetPdbInfoInstance(BinaryReader reader, int ptr)
- throws IOException {
- return null;
- }
-}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfo.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfo.java
new file mode 100644
index 0000000000..4e841fc272
--- /dev/null
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfo.java
@@ -0,0 +1,63 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.app.util.bin.format.pdb;
+
+import java.io.IOException;
+
+import ghidra.app.util.bin.BinaryReader;
+import ghidra.framework.options.Options;
+
+/**
+ * Bag of information about a Pdb symbol file, usually extracted from information present in a PE
+ * binary.
+ *
+ */
+public interface PdbInfo {
+
+ /**
+ * Read either a {@link PdbInfoCodeView} object or a {@link PdbInfoDotNet} object
+ * from the BinaryReader of a PE binary.
+ *
+ * @param reader BinaryReader
+ * @param offset position of the debug info
+ * @return new PdbInfoCodeView or PdbInfoDotNet object
+ * @throws IOException if error
+ */
+ public static PdbInfo read(BinaryReader reader, long offset) throws IOException {
+ if (PdbInfoCodeView.isMatch(reader, offset)) {
+ return PdbInfoCodeView.read(reader, offset);
+ }
+ if (PdbInfoDotNet.isMatch(reader, offset)) {
+ return PdbInfoDotNet.read(reader, offset);
+ }
+ return null;
+ }
+
+ /**
+ * Returns true if this instance is valid.
+ *
+ * @return boolean true if valid (magic signature matches and fields have valid data)
+ */
+ boolean isValid();
+
+ /**
+ * Writes the various PDB info fields to a program's options.
+ *
+ * @param options Options of a Program to write to
+ */
+ void serializeToOptions(Options options);
+
+}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoCodeView.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoCodeView.java
new file mode 100644
index 0000000000..3a47e7bb1a
--- /dev/null
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoCodeView.java
@@ -0,0 +1,113 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.app.util.bin.format.pdb;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import org.apache.commons.io.FilenameUtils;
+
+import ghidra.app.util.bin.BinaryReader;
+import ghidra.app.util.bin.StructConverter;
+import ghidra.app.util.bin.format.pe.debug.DebugCodeViewConstants;
+import ghidra.framework.options.Options;
+import ghidra.program.model.data.*;
+import ghidra.util.Conv;
+
+/**
+ * Older style pdb information, using a simple 32bit hash to link the pdb to its binary.
+ */
+public class PdbInfoCodeView implements StructConverter, PdbInfo {
+ private static final int MAGIC =
+ DebugCodeViewConstants.SIGNATURE_NB << 16 | DebugCodeViewConstants.VERSION_10;
+
+ /**
+ * Returns true if the pdb information at the specified offset is a {@link PdbInfoCodeView}
+ * type (based on the signature at that offset).
+ *
+ * @param reader {@link BinaryReader}
+ * @param offset offset of the Pdb information
+ * @return boolean true if it is a {@link PdbInfoCodeView} type
+ * @throws IOException if error reading data
+ */
+ public static boolean isMatch(BinaryReader reader, long offset) throws IOException {
+ //read value out as big endian
+ int value = reader.asBigEndian().readInt(offset);
+ return MAGIC == value;
+ }
+
+ /**
+ * Reads the pdb information from a PE binary.
+ *
+ * @param reader {@link BinaryReader}
+ * @param offset offset of the Pdb information
+ * @return new {@link PdbInfoCodeView} instance, never null
+ * @throws IOException if error reading data
+ */
+ public static PdbInfoCodeView read(BinaryReader reader, long offset) throws IOException {
+ reader = reader.clone(offset);
+
+ PdbInfoCodeView result = new PdbInfoCodeView();
+ result.magic = reader.readNextByteArray(4);
+ result.offset = reader.readNextInt();
+ result.sig = reader.readNextInt();
+ result.age = reader.readNextInt();
+ result.pdbPath = reader.readNextAsciiString();
+ result.pdbName = FilenameUtils.getName(result.pdbPath);
+
+ return result;
+ }
+
+ private byte[] magic;
+ private int offset;
+ private int sig;
+ private int age;
+ private String pdbName;
+ private String pdbPath;
+
+ private PdbInfoCodeView() {
+ // nothing
+ }
+
+ @Override
+ public boolean isValid() {
+ return magic.length == 4 && !pdbName.isBlank();
+ }
+
+ @Override
+ public void serializeToOptions(Options options) {
+ options.setString(PdbParserConstants.PDB_VERSION,
+ new String(magic, StandardCharsets.US_ASCII));
+ options.setString(PdbParserConstants.PDB_SIGNATURE, Conv.toHexString(sig));
+ options.setString(PdbParserConstants.PDB_AGE, Integer.toHexString(age));
+ options.setString(PdbParserConstants.PDB_FILE, pdbName);
+ }
+
+ @Override
+ public DataType toDataType() {
+ StructureDataType struct = new StructureDataType("PdbInfo", 0);
+ struct.add(new StringDataType(), magic.length, "signature", null);
+ struct.add(new DWordDataType(), "offset", null);
+ struct.add(new DWordDataType(), "sig", null);
+ struct.add(new DWordDataType(), "age", null);
+ if (pdbName.length() > 0) {
+ struct.add(new StringDataType(), pdbName.length(), "pdbname", null);
+ }
+ struct.setCategoryPath(new CategoryPath("/PDB"));
+ return struct;
+ }
+
+}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoDotNet.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoDotNet.java
new file mode 100644
index 0000000000..605ff1aa51
--- /dev/null
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoDotNet.java
@@ -0,0 +1,131 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package ghidra.app.util.bin.format.pdb;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import org.apache.commons.io.FilenameUtils;
+
+import ghidra.app.util.bin.BinaryReader;
+import ghidra.app.util.bin.StructConverter;
+import ghidra.app.util.bin.format.pe.debug.DebugCodeViewConstants;
+import ghidra.app.util.datatype.microsoft.GUID;
+import ghidra.app.util.datatype.microsoft.GuidDataType;
+import ghidra.framework.options.Options;
+import ghidra.program.model.data.*;
+
+/**
+ * Newer style pdb information, using a GUID to link the pdb to its binary.
+ */
+public class PdbInfoDotNet implements StructConverter, PdbInfo {
+ private static final int MAGIC =
+ DebugCodeViewConstants.SIGNATURE_DOT_NET << 16 | DebugCodeViewConstants.VERSION_DOT_NET;
+
+ /**
+ * Returns true if the pdb information at the specified offset is a {@link PdbInfoDotNet}
+ * type (based on the signature at that offset).
+ *
+ * @param reader {@link BinaryReader}
+ * @param offset offset of the Pdb information
+ * @return boolean true if it is a {@link PdbInfoDotNet} type
+ * @throws IOException if error reading data
+ */
+ public static boolean isMatch(BinaryReader reader, long offset) throws IOException {
+ //read value out as big endian
+ int value = reader.asBigEndian().readInt(offset);
+ return MAGIC == value;
+ }
+
+ /**
+ * Reads an instance from the stream.
+ *
+ * @param reader {@link BinaryReader} to read from
+ * @param offset position of the pdb info
+ * @return new instance, never null
+ * @throws IOException if IO error or data format error
+ */
+ public static PdbInfoDotNet read(BinaryReader reader, long offset) throws IOException {
+ reader = reader.clone(offset);
+
+ PdbInfoDotNet result = new PdbInfoDotNet();
+ result.magic = reader.readNextByteArray(4);
+ result.guid = new GUID(reader);
+ result.age = reader.readNextInt();
+ result.pdbPath = reader.readNextAsciiString();
+ result.pdbName = FilenameUtils.getName(result.pdbPath);
+
+ return result;
+ }
+
+ /**
+ * Creates an instance from explicit values.
+ *
+ * @param pdbPath String path / filename of the pdb file
+ * @param age age
+ * @param guid {@link GUID}
+ * @return new instance, never null
+ */
+ public static PdbInfoDotNet fromValues(String pdbPath, int age, GUID guid) {
+ PdbInfoDotNet result = new PdbInfoDotNet();
+ result.pdbPath = pdbPath;
+ result.pdbName = FilenameUtils.getName(result.pdbPath);
+ result.age = age;
+ result.guid = guid;
+ result.magic = "????".getBytes();
+
+ return result;
+ }
+
+
+ private byte[] magic;
+ private GUID guid;
+ private int age;
+ private String pdbName;
+ private String pdbPath;
+
+ private PdbInfoDotNet() {
+ // empty
+ }
+
+ @Override
+ public boolean isValid() {
+ return magic.length == 4 && !pdbName.isBlank() && guid != null;
+ }
+
+ @Override
+ public void serializeToOptions(Options options) {
+ options.setString(PdbParserConstants.PDB_VERSION,
+ new String(magic, StandardCharsets.US_ASCII));
+ options.setString(PdbParserConstants.PDB_GUID, guid.toString());
+ options.setString(PdbParserConstants.PDB_AGE, Integer.toHexString(age));
+ options.setString(PdbParserConstants.PDB_FILE, pdbName);
+ }
+
+ @Override
+ public DataType toDataType() {
+ StructureDataType struct = new StructureDataType("DotNetPdbInfo", 0);
+ struct.add(new StringDataType(), magic.length, "signature", null);
+ struct.add(new GuidDataType(), "guid", null);
+ struct.add(new DWordDataType(), "age", null);
+ if (pdbName.length() > 0) {
+ struct.add(new StringDataType(), pdbName.length(), "pdbname", null);
+ }
+ struct.setCategoryPath(new CategoryPath("/PDB"));
+ return struct;
+ }
+
+}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoDotNetIface.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoDotNetIface.java
deleted file mode 100644
index 381668ed56..0000000000
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoDotNetIface.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/* ###
- * IP: GHIDRA
- * REVIEWED: YES
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package ghidra.app.util.bin.format.pdb;
-
-import ghidra.app.util.bin.*;
-import ghidra.app.util.datatype.microsoft.*;
-
-public interface PdbInfoDotNetIface extends StructConverter {
-
- public abstract String getPdbName();
-
- public abstract int getAge();
-
- public abstract int getSignature();
-
- public abstract GUID getGUID();
-
- public abstract byte[] getMagic();
-}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoIface.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoIface.java
deleted file mode 100644
index ebb4ffac61..0000000000
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pdb/PdbInfoIface.java
+++ /dev/null
@@ -1,32 +0,0 @@
-/* ###
- * IP: GHIDRA
- * REVIEWED: YES
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package ghidra.app.util.bin.format.pdb;
-
-import ghidra.app.util.bin.*;
-
-public interface PdbInfoIface extends StructConverter {
-
- public abstract byte[] getMagic();
-
- public abstract int getOffset();
-
- public abstract int getSig();
-
- public abstract int getAge();
-
- public abstract String getPdbName();
-}
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DebugDataDirectory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DebugDataDirectory.java
index 4e9168a266..27569734f1 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DebugDataDirectory.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/DebugDataDirectory.java
@@ -19,8 +19,8 @@ import java.io.IOException;
import java.io.RandomAccessFile;
import ghidra.app.util.bin.format.FactoryBundledWithBinaryReader;
-import ghidra.app.util.bin.format.pdb.PdbInfoDotNetIface;
-import ghidra.app.util.bin.format.pdb.PdbInfoIface;
+import ghidra.app.util.bin.format.pdb.PdbInfoCodeView;
+import ghidra.app.util.bin.format.pdb.PdbInfoDotNet;
import ghidra.app.util.bin.format.pe.debug.*;
import ghidra.app.util.importer.MessageLog;
import ghidra.program.model.address.Address;
@@ -112,12 +112,12 @@ public class DebugDataDirectory extends DataDirectory {
if (dcv != null) {
Address dataAddr = getDataAddress(dcv.getDebugDirectory(), isBinary, space, ntHeader);
if (dataAddr != null) {
- PdbInfoIface pdbInfo = dcv.getPdbInfo();
+ PdbInfoCodeView pdbInfo = dcv.getPdbInfo();
if (pdbInfo != null) {
setPlateComment(program, dataAddr, "CodeView PDB Info");
PeUtils.createData(program, dataAddr, pdbInfo.toDataType(), log);
}
- PdbInfoDotNetIface dotNetPdbInfo = dcv.getDotNetPdbInfo();
+ PdbInfoDotNet dotNetPdbInfo = dcv.getDotNetPdbInfo();
if (dotNetPdbInfo != null) {
setPlateComment(program, dataAddr, ".NET PDB Info");
PeUtils.createData(program, dataAddr, dotNetPdbInfo.toDataType(), log);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugCodeView.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugCodeView.java
index e61a0522a1..1c9154eca1 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugCodeView.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/bin/format/pe/debug/DebugCodeView.java
@@ -15,30 +15,25 @@
*/
package ghidra.app.util.bin.format.pe.debug;
+import java.io.IOException;
+
import ghidra.app.util.bin.StructConverter;
import ghidra.app.util.bin.format.FactoryBundledWithBinaryReader;
-import ghidra.app.util.bin.format.pdb.PdbFactory;
-import ghidra.app.util.bin.format.pdb.PdbInfoDotNetIface;
-import ghidra.app.util.bin.format.pdb.PdbInfoIface;
+import ghidra.app.util.bin.format.pdb.PdbInfoCodeView;
+import ghidra.app.util.bin.format.pdb.PdbInfoDotNet;
import ghidra.app.util.bin.format.pe.OffsetValidator;
-import ghidra.program.model.data.ArrayDataType;
-import ghidra.program.model.data.CategoryPath;
-import ghidra.program.model.data.DataType;
-import ghidra.program.model.data.Structure;
-import ghidra.program.model.data.StructureDataType;
+import ghidra.program.model.data.*;
import ghidra.util.Msg;
import ghidra.util.exception.DuplicateNameException;
-import java.io.IOException;
-
/**
* A class to represent the code view debug information.
*/
public class DebugCodeView implements StructConverter {
private DebugDirectory debugDir;
private DebugCodeViewSymbolTable symbolTable;
- private PdbInfoIface pdbInfo;
- private PdbInfoDotNetIface dotNetPdbInfo;
+ private PdbInfoCodeView pdbInfo;
+ private PdbInfoDotNet dotNetPdbInfo;
/**
* Constructor.
@@ -70,8 +65,8 @@ public class DebugCodeView implements StructConverter {
return;
}
- dotNetPdbInfo = PdbFactory.getPdbInfoDotNetInstance(reader, ptr);
- pdbInfo = PdbFactory.getPdbInfoInstance(reader, ptr);
+ dotNetPdbInfo = PdbInfoDotNet.isMatch(reader, ptr) ? PdbInfoDotNet.read(reader, ptr) : null;
+ pdbInfo = PdbInfoCodeView.isMatch(reader, ptr) ? PdbInfoCodeView.read(reader, ptr) : null;
if (DebugCodeViewSymbolTable.isMatch(reader, ptr)) {
symbolTable =
DebugCodeViewSymbolTable.createDebugCodeViewSymbolTable(reader,
@@ -106,17 +101,18 @@ public class DebugCodeView implements StructConverter {
* Returns the code view .PDB info.
* @return the code view .PDB info
*/
- public PdbInfoIface getPdbInfo() {
+ public PdbInfoCodeView getPdbInfo() {
return pdbInfo;
}
- public PdbInfoDotNetIface getDotNetPdbInfo() {
+ public PdbInfoDotNet getDotNetPdbInfo() {
return dotNetPdbInfo;
}
/**
* @see ghidra.app.util.bin.StructConverter#toDataType()
*/
+ @Override
public DataType toDataType() throws DuplicateNameException {
Structure es = new StructureDataType("DebugCodeView", 0);
es.add(WORD, "Signature", null);
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GUID.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GUID.java
index 0d7d073536..82424c5b49 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GUID.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/datatype/microsoft/GUID.java
@@ -21,11 +21,7 @@ import java.util.Arrays;
import ghidra.app.util.bin.BinaryReader;
import ghidra.program.model.mem.MemBuffer;
import ghidra.program.model.mem.MemoryAccessException;
-import ghidra.util.BigEndianDataConverter;
-import ghidra.util.Conv;
-import ghidra.util.DataConverter;
-import ghidra.util.LittleEndianDataConverter;
-import ghidra.util.NumericUtilities;
+import ghidra.util.*;
/**
* GUIDs identify objects such as interfaces, manager entry-point vectors (EPVs),
@@ -61,54 +57,52 @@ public class GUID {
/**
* Creates a GUID object using the GUID string form.
- * @param guidString - "6B29FC40-CA47-1067-B31D-00DD010662DA"
+ * @param guidString - either with or without dashes between parts -
+ * "6B29FC40-CA47-1067-B31D-00DD010662DA", or "6B29FC40CA471067B31D00DD010662DA", and
+ * with or without leading and trailing "{" "}" characters
* @throws IllegalArgumentException if string does not represent a valid GUID
*/
- public GUID(String guidString) {
- if (guidString.length() != 36) {
- throw new IllegalArgumentException("Invalid GUID string.");
- }
- int pos = guidString.indexOf('-');
- if (pos == -1) {
- throw new IllegalArgumentException("Invalid GUID string.");
- }
- data1 = (int) NumericUtilities.parseHexLong(guidString.substring(0, pos));
-
- guidString = guidString.substring(pos + 1);
- pos = guidString.indexOf('-');
- if (pos == -1) {
- throw new IllegalArgumentException("Invalid GUID string.");
- }
- data2 = (short) Integer.parseInt(guidString.substring(0, pos), 16);
-
- guidString = guidString.substring(pos + 1);
- pos = guidString.indexOf('-');
- if (pos == -1) {
- throw new IllegalArgumentException("Invalid GUID string.");
- }
- data3 = (short) Integer.parseInt(guidString.substring(0, pos), 16);
-
- guidString = guidString.substring(pos + 1);
- pos = guidString.indexOf('-');
- if (pos == -1) {
- throw new IllegalArgumentException("Invalid GUID string.");
- }
- int value = Integer.parseInt(guidString.substring(0, pos), 16);
+ public GUID(String guidString) throws IllegalArgumentException {
+ String[] parts = getGUIDParts(guidString);
+ data1 = (int) NumericUtilities.parseHexLong(parts[0]);
+ data2 = (short) Integer.parseInt(parts[1], 16);
+ data3 = (short) Integer.parseInt(parts[2], 16);
+ int value = Integer.parseInt(parts[3], 16);
data4[0] = (byte) (value >> 8);
data4[1] = (byte) (value & 0xff);
+ data4[2] = (byte) Integer.parseInt(parts[4].substring(0, 2), 16);
+ data4[3] = (byte) Integer.parseInt(parts[4].substring(2, 4), 16);
+ data4[4] = (byte) Integer.parseInt(parts[4].substring(4, 6), 16);
+ data4[5] = (byte) Integer.parseInt(parts[4].substring(6, 8), 16);
+ data4[6] = (byte) Integer.parseInt(parts[4].substring(8, 10), 16);
+ data4[7] = (byte) Integer.parseInt(parts[4].substring(10, 12), 16);
+ }
- guidString = guidString.substring(pos + 1);
- data4[2] = (byte) Integer.parseInt(guidString.substring(0, 2), 16);
- guidString = guidString.substring(2);
- data4[3] = (byte) Integer.parseInt(guidString.substring(0, 2), 16);
- guidString = guidString.substring(2);
- data4[4] = (byte) Integer.parseInt(guidString.substring(0, 2), 16);
- guidString = guidString.substring(2);
- data4[5] = (byte) Integer.parseInt(guidString.substring(0, 2), 16);
- guidString = guidString.substring(2);
- data4[6] = (byte) Integer.parseInt(guidString.substring(0, 2), 16);
- guidString = guidString.substring(2);
- data4[7] = (byte) Integer.parseInt(guidString.substring(0, 2), 16);
+ private String[] getGUIDParts(String guidString) throws IllegalArgumentException {
+ String[] results = new String[5];
+ guidString = (guidString.startsWith("{") && guidString.endsWith("}"))
+ ? guidString.substring(1, guidString.length() - 1)
+ : guidString;
+ if (guidString.length() == 36 && guidString.charAt(8) == '-' &&
+ guidString.charAt(13) == '-' && guidString.charAt(18) == '-' &&
+ guidString.charAt(23) == '-') {
+ results[0] = guidString.substring(0, 8);
+ results[1] = guidString.substring(9, 13);
+ results[2] = guidString.substring(14, 18);
+ results[3] = guidString.substring(19, 23);
+ results[4] = guidString.substring(24);
+ }
+ else if (guidString.length() == 32) {
+ results[0] = guidString.substring(0, 8);
+ results[1] = guidString.substring(8, 12);
+ results[2] = guidString.substring(12, 16);
+ results[3] = guidString.substring(16, 20);
+ results[4] = guidString.substring(20);
+ }
+ else {
+ throw new IllegalArgumentException("Invalid GUID string.");
+ }
+ return results;
}
/**
@@ -172,23 +166,23 @@ public class GUID {
@Override
public String toString() {
- StringBuffer buffer = new StringBuffer();
- buffer.append(Conv.toHexString(data1));
- buffer.append("-");
- buffer.append(Conv.toHexString(data2));
- buffer.append("-");
- buffer.append(Conv.toHexString(data3));
- buffer.append("-");
- buffer.append(Conv.toHexString(data4[0]));
- buffer.append(Conv.toHexString(data4[1]));
- buffer.append("-");
- buffer.append(Conv.toHexString(data4[2]));
- buffer.append(Conv.toHexString(data4[3]));
- buffer.append(Conv.toHexString(data4[4]));
- buffer.append(Conv.toHexString(data4[5]));
- buffer.append(Conv.toHexString(data4[6]));
- buffer.append(Conv.toHexString(data4[7]));
- return buffer.toString();
+ StringBuilder sb = new StringBuilder();
+ sb.append(Conv.toHexString(data1));
+ sb.append("-");
+ sb.append(Conv.toHexString(data2));
+ sb.append("-");
+ sb.append(Conv.toHexString(data3));
+ sb.append("-");
+ sb.append(Conv.toHexString(data4[0]));
+ sb.append(Conv.toHexString(data4[1]));
+ sb.append("-");
+ sb.append(Conv.toHexString(data4[2]));
+ sb.append(Conv.toHexString(data4[3]));
+ sb.append(Conv.toHexString(data4[4]));
+ sb.append(Conv.toHexString(data4[5]));
+ sb.append(Conv.toHexString(data4[6]));
+ sb.append(Conv.toHexString(data4[7]));
+ return sb.toString();
}
/**
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractPeDebugLoader.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractPeDebugLoader.java
index b5ac32c59c..a0215524ea 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractPeDebugLoader.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/AbstractPeDebugLoader.java
@@ -17,11 +17,11 @@ package ghidra.app.util.opinion;
import java.util.*;
-import ghidra.app.util.bin.format.pdb.*;
+import ghidra.app.util.bin.format.pdb.PdbInfoCodeView;
+import ghidra.app.util.bin.format.pdb.PdbInfoDotNet;
import ghidra.app.util.bin.format.pe.FileHeader;
import ghidra.app.util.bin.format.pe.SectionHeader;
import ghidra.app.util.bin.format.pe.debug.*;
-import ghidra.app.util.datatype.microsoft.GUID;
import ghidra.app.util.demangler.DemangledObject;
import ghidra.app.util.demangler.DemanglerUtil;
import ghidra.framework.options.Options;
@@ -112,56 +112,14 @@ abstract class AbstractPeDebugLoader extends AbstractLibrarySupportLoader {
Options proplist = program.getOptions(Program.PROGRAM_INFO);
- PdbInfoIface cvPdbInfo = dcv.getPdbInfo();
+ PdbInfoCodeView cvPdbInfo = dcv.getPdbInfo();
if (cvPdbInfo != null) {
- byte[] magic = cvPdbInfo.getMagic();
- int sig = cvPdbInfo.getSig();
- int age = cvPdbInfo.getAge();
- String name = cvPdbInfo.getPdbName();
-
- proplist.setString(PdbParserConstants.PDB_VERSION, Conv.toString(magic));
- proplist.setString(PdbParserConstants.PDB_SIGNATURE, Conv.toHexString(sig));
- proplist.setString(PdbParserConstants.PDB_AGE, Integer.toHexString(age));
- proplist.setString(PdbParserConstants.PDB_FILE, name);
-/*
- DebugDirectory dd = dcv.getDebugDirectory();
- if (dd.getAddressOfRawData() > 0) {
- Address address = space.getAddress(imageBase + dd.getAddressOfRawData());
- listing.setComment(address, CodeUnit.PLATE_COMMENT, "CodeView PDB Info");
- try {
- listing.createData(address, cvPdbInfo.toDataType());
- }
- catch (IOException e) {}
- catch (DuplicateNameException e) {}
- catch (CodeUnitInsertionException e) {}
- }
-*/
+ cvPdbInfo.serializeToOptions(proplist);
}
- PdbInfoDotNetIface dotnetPdbInfo = dcv.getDotNetPdbInfo();
+ PdbInfoDotNet dotnetPdbInfo = dcv.getDotNetPdbInfo();
if (dotnetPdbInfo != null) {
- byte[] magic = dotnetPdbInfo.getMagic();
- GUID guid = dotnetPdbInfo.getGUID();
- int age = dotnetPdbInfo.getAge();
- String name = dotnetPdbInfo.getPdbName();
-
- proplist.setString(PdbParserConstants.PDB_VERSION, Conv.toString(magic));
- proplist.setString(PdbParserConstants.PDB_GUID, guid.toString());
- proplist.setString(PdbParserConstants.PDB_AGE, Integer.toHexString(age));
- proplist.setString(PdbParserConstants.PDB_FILE, name);
-/*
- DebugDirectory dd = dcv.getDebugDirectory();
- if (dd.getAddressOfRawData() > 0) {
- Address address = space.getAddress(imageBase + dd.getAddressOfRawData());
- listing.setComment(address, CodeUnit.PLATE_COMMENT, ".NET PDB Info");
- try {
- listing.createData(address, dotnetPdbInfo.toDataType());
- }
- catch (IOException e) {}
- catch (DuplicateNameException e) {}
- catch (CodeUnitInsertionException e) {}
- }
-*/
+ dotnetPdbInfo.serializeToOptions(proplist);
}
DebugCodeViewSymbolTable dcvst = dcv.getSymbolTable();
diff --git a/Ghidra/Features/PDB/certification.manifest b/Ghidra/Features/PDB/certification.manifest
index fa7172b4dc..dce9dc413e 100644
--- a/Ghidra/Features/PDB/certification.manifest
+++ b/Ghidra/Features/PDB/certification.manifest
@@ -1,4 +1,7 @@
##VERSION: 2.0
+##MODULE IP: Crystal Clear Icons - LGPL 2.1
+##MODULE IP: FAMFAMFAM Icons - CC 2.5
+##MODULE IP: Nuvola Icons - LGPL 2.1
##MODULE IP: Oxygen Icons - LGPL 3.0
Module.manifest||GHIDRA||||END|
src/global/docs/README_PDB.html||GHIDRA||||END|
@@ -13,13 +16,19 @@ src/main/help/help/shared/redo.png||GHIDRA||||END|
src/main/help/help/shared/tip.png||Oxygen Icons - LGPL 3.0|||Oxygen icon theme (dual license; LGPL or CC-SA-3.0)|END|
src/main/help/help/shared/undo.png||GHIDRA||||END|
src/main/help/help/shared/warning.png||Oxygen Icons - LGPL 3.0|||Oxygen icon theme (dual license; LGPL or CC-SA-3.0)|END|
+src/main/help/help/topics/Pdb/LoadPDBNew.html||GHIDRA||||END|
src/main/help/help/topics/Pdb/PDB.htm||GHIDRA||||END|
-src/main/help/help/topics/Pdb/download_pdb_file.html||GHIDRA||||END|
-src/main/help/help/topics/Pdb/images/KnownSymbolServerURLsDialog.png||GHIDRA||||END|
-src/main/help/help/topics/Pdb/images/PdbOrXmlDialog.png||GHIDRA||||END|
-src/main/help/help/topics/Pdb/images/PeSpecifiedPathDialog.png||GHIDRA||||END|
-src/main/help/help/topics/Pdb/images/SuccessDialog.png||GHIDRA||||END|
-src/main/help/help/topics/Pdb/images/SymbolServerURLDialog.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/LoadPdb_Advanced_NeedsConfig.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/LoadPdb_Advanced_Screenshot.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/LoadPdb_Initial_Screenshot.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/Plus2.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/SymbolServerConfig_AddButtonMenu.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/SymbolServerConfig_Screenshot.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/disk.png||FAMFAMFAM Icons - CC 2.5||||END|
+src/main/help/help/topics/Pdb/images/down.png||GHIDRA||||END|
+src/main/help/help/topics/Pdb/images/error.png||Nuvola Icons - LGPL 2.1||||END|
+src/main/help/help/topics/Pdb/images/reload3.png||Crystal Clear Icons - LGPL 2.1||||END|
+src/main/help/help/topics/Pdb/images/up.png||GHIDRA||||END|
src/pdb/README.txt||GHIDRA||||END|
src/pdb/pdb.sln||GHIDRA||||END|
src/pdb/pdb.vcxproj||GHIDRA||||END|
diff --git a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/GhidraPdbFactory.java b/Ghidra/Features/PDB/developer_scripts/PdbExamplePrescript.java
similarity index 50%
rename from Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/GhidraPdbFactory.java
rename to Ghidra/Features/PDB/developer_scripts/PdbExamplePrescript.java
index 66f34b5bbe..66f1a8dadf 100644
--- a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/GhidraPdbFactory.java
+++ b/Ghidra/Features/PDB/developer_scripts/PdbExamplePrescript.java
@@ -1,6 +1,5 @@
/* ###
* IP: GHIDRA
- * REVIEWED: YES
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -14,29 +13,23 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package ghidra.app.util.bin.format.pdb;
+//Example preScript to force a PdbAnalyzer to use a custom PDB
+//symbol file when analyzing a binary.
+//@category PDB
+import java.io.File;
-import ghidra.app.util.bin.*;
+import ghidra.app.plugin.core.analysis.PdbAnalyzer;
+import ghidra.app.script.GhidraScript;
-import java.io.*;
-
-public class GhidraPdbFactory extends PdbFactory {
+public class PdbExamplePrescript extends GhidraScript {
@Override
- protected PdbInfoDotNetIface doGetPdbInfoDotNetInstance(
- BinaryReader reader, int ptr) throws IOException {
- if (PdbInfoDotNet.isMatch(reader, ptr)) {
- return new PdbInfoDotNet(reader, ptr);
- }
- return null;
- }
+ protected void run() throws Exception {
+ // contrived example of choosing a pdb file with custom logic
+ File pdbFile = new File(getProgramFile().getPath() + ".pdb");
- @Override
- protected PdbInfoIface doGetPdbInfoInstance(BinaryReader reader, int ptr)
- throws IOException {
- if (PdbInfo.isMatch(reader, ptr)) {
- return new PdbInfo(reader, ptr);
- }
- return null;
+ PdbAnalyzer.setPdbFileOption(currentProgram, pdbFile);
+ // or
+ //PdbUniversalAnalyzer.setPdbFileOption(currentProgram, pdbFile);
}
}
diff --git a/Ghidra/Features/PDB/developer_scripts/PdbSymbolServerExamplePrescript.java b/Ghidra/Features/PDB/developer_scripts/PdbSymbolServerExamplePrescript.java
new file mode 100644
index 0000000000..f8b29e9d89
--- /dev/null
+++ b/Ghidra/Features/PDB/developer_scripts/PdbSymbolServerExamplePrescript.java
@@ -0,0 +1,53 @@
+/* ###
+ * IP: GHIDRA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+//Example preScript to configure the PDB symbol server service to use the ~/symbols directory
+//as the location to store symbol files, and to search Microsoft's public
+//symbol server.
+//The ~/symbols directory should already exist and be initialized as a symbol
+//storage location.
+//@category PDB
+import java.util.List;
+
+import java.io.File;
+import java.net.URI;
+
+import ghidra.app.plugin.core.analysis.PdbAnalyzer;
+import ghidra.app.plugin.core.analysis.PdbUniversalAnalyzer;
+import ghidra.app.script.GhidraScript;
+import pdb.PdbPlugin;
+import pdb.symbolserver.*;
+
+public class PdbSymbolServerExamplePrescript extends GhidraScript {
+
+ @Override
+ protected void run() throws Exception {
+ File homeDir = new File(System.getProperty("user.home"));
+ File symDir = new File(homeDir, "symbols");
+ LocalSymbolStore localSymbolStore = new LocalSymbolStore(symDir);
+ HttpSymbolServer msSymbolServer =
+ new HttpSymbolServer(URI.create("https://msdl.microsoft.com/download/symbols/"));
+ SymbolServerService symbolServerService =
+ new SymbolServerService(localSymbolStore, List.of(msSymbolServer));
+
+ PdbPlugin.saveSymbolServerServiceConfig(symbolServerService);
+
+ // You only need to enable the "allow remote" option on the specific
+ // analyzer you are using
+ PdbUniversalAnalyzer.setAllowRemoteOption(currentProgram, true);
+ PdbAnalyzer.setAllowRemoteOption(currentProgram, true);
+ }
+}
+
diff --git a/Ghidra/Features/PDB/src/global/docs/README_PDB.html b/Ghidra/Features/PDB/src/global/docs/README_PDB.html
index 3b39a8ef11..decf438fcd 100644
--- a/Ghidra/Features/PDB/src/global/docs/README_PDB.html
+++ b/Ghidra/Features/PDB/src/global/docs/README_PDB.html
@@ -50,7 +50,7 @@ native execution issue and the use of an intermediate XML format.
Although GHIDRA has been primarily designed to utilize locally stored PDB files during analysis,
the ability to interactively download individual PDB files from a web-based Microsoft Symbol Server
is also provided. This capability is accessed via the GUI while a program is open via the
-File->Download PDB File... action.
+File → Load PDB File... action.
In an effort to manage large collections of symbol files, Microsoft specified a scheme to organize
+ symbol files into directory structures.
+
+
Ghidra can search Microsoft-style symbol servers (web-based HTTP/HTTPS) or local file system symbol
+ storage directories as well as unorganized, non-MS symbol storage directories for the PE executable's
+ matching PDB symbol file.
+
+
+
Microsoft symbol servers / symbol storage directories:
+
+
Organize symbol files (typically PDB files) into a directory hierarchy using information
+ from the symbol file being stored.
+
In a single-level symbol server directory hierarchy, a symbol file named myprogram.pdb might be stored
+ as:
myprogram.pdb is the name of the file and the name of the initial subdirectory off the root of the server.
+
012345670123012301230123456789AB is the 32 character hexadecimal value (made up for this example) of the GUID
+ "012345678-0123-0123-0123-0123456789ABC" of the PDB file.
+
This value might instead be a 8 character hexadecimal value of the ID of the symbol file if it was created by an older version of the tool chain.
+
1 is the hexadecimal value of the 'age' (build number) of the PDB file. Note: most PDB files will have an age value of 1.
+
+
In a two-level symbol server directory hierarchy, the same symbol file would be stored
+ as: my/myprogram.pdb/012345670123012301230123456789AB1/myprogram.pdb, where the
+ first two letters of the symbol file's name are used to create a bucketing directory called "my" where all symbol files starting with
+ "my" are stored.
+
A two-level symbol server directory hierarchy is indicated by the presence of a file called index2.txt in the root directory of
+ the hierarchy.
+
Symbol storage directories are expected to have a pingme.txt file and a special directory called 000admin.
+
Compressed symbol files (*.pd_):
+
+
Microsoft symbol server tools can compress symbol files to save space. The compressed file is stored in place of the original file, renamed
+ to have a trailing underscore ("_") character in the file extension.
+
Before use, Ghidra will decompress the file into the Local Symbol Storage directory, using whatever organization scheme
+ that directory is configured with to store the uncompressed version of the file.
+
+
Remote symbol files hosted on a HTTP server will be copied to and stored in the configured Local Symbol Storage directory before they
+ can be used.
+
+
Unorganized directories:
+
+
Symbol files are are found by matching the leading part of the filename found in the unorganized directory with the sought-after symbol
+ file's name.
+
+
helloworld.pdb and hellokitty.pdb would both be found as possible matches when searching for
+ hello.pdb.
+
During searches, each possible matching PDB symbol file will be opened and partially parsed to extract its GUID and age values to determine if
+ it matches the user's full search criteria.
+
+
+
+
+
+
Menu Actions
+
+
+
Load PDB File
+
+
Allows the user to pick a PDB file or search for a PDB file and apply it to the currently open program in the CodeBrowser.
+
Use this action instead of the PDB Analyzer if the PDB file can't be found automatically with the currently configured
+ symbol server search locations, if you need to force load a non-exact PDB file, or you need to use other PDB options.
+
Steps:
+
+
Invoke File → Load PDB File...
+
+
The PDB Location field will either have the path of an existing matching PDB file, or
+ it will prompt the user to use the browse button to select a file or use the
+ Advanced screen to search for the file.
+
A PDB.XML file can be selected using the browse button. This will limit the selected parser to be the MSDIA parser.
+
Use the information displayed in the Program PDB Information panel to help you decide
+ which PDB file to choose.
+
If needed, click the Advanced button:
+
+
The Local Symbol Storage location is required to enable searching. If missing, set it to a directory where Ghidra can store PDB files.
+
+
For example, /home/your_id/Symbols or C:\Users\your_name\Symbols.
+
If the location is a new empty directory, the user will be prompted to initialize the directory as a Microsoft symbol storage directory.
+
+
Add additional search locations by clicking the button.
+ The Microsoft symbol server and Program's Import Location are good defaults.
+
Save any changes to the configuration by clicking the button.
Click the Search button to search the configured locations.
+
+
The Local Symbol Storage location is searched first, followed by any locations listed in the
+ Additional Search Paths list, in listed order.
+
Select one of the found PDB files and click the Load button to start the import process.
+
Remote symbol files will be downloaded to your Local Symbol Storage location before continuing.
+
+
+
+
+
+
Symbol Server Config
+
+
Allows the user to configure the location where PDB symbol files are stored and additional locations to search for
+ existing PDB files. This is also available in the Load PDB File, Advanced screen.
+
Steps:
+
+
Invoke Edit → Symbol Server Config
+
+
The Local Symbol Storage location is required to be able to search. If missing, set it to
+ a directory where Ghidra can store PDB files.
+
+
For example, /home/your_id/Symbols or C:\Users\your_name\Symbols.
+
If the location is a new empty directory, the user will be prompted to initialize the directory as a Microsoft symbol storage directory.
+
+
Add additional search locations by clicking the button.
+
Save any changes to the configuration by clicking the button.
+
Search locations can be disabled by toggling the enabled checkbox at the beginning of the row.
+
+
+
(Add)
+
+
Allows the user to add a location to the search path list. Pick from the offered types of locations, or pick
+ a predefined location.
+
+
+
Directory - allows the user to pick an existing directory that will be searched for symbol files.
+ See level 1/level 2 or
+ unorganized directory descriptions.
+
URL - allows the user to enter a HTTP or HTTPS URL to a web-based symbol server.
+
Program's Import Location - automatically references the directory from which the program was imported.
+
Import _NT_SYMBOL_PATH - parses the current value of the _NT_SYMBOL_PATH system environment variable to extract
+ URLs and symbol directory locations to be added to the Ghidra configuration. If no environment value is present,
+ the user can paste their own value into the text field.
+
+
All items listed after the menu dividing line are automatically added from resource files that have a
+ *.pdburl extension. The default file included with Ghidra is called PDB_SYMBOL_SERVER_URLS.pdburl and
+ is located in the Ghidra/Configurations/Public_Release/data directory under the Ghidra install directory.
+
+
+
(Delete)
+
+
Deletes the currently selected locations from the Additional Search Paths table.
+
+
+
(Up/Down)
+
+
Moves the currently selected item up or down in the Additional Search Paths table.
+
+
+
(Refresh)
+
+
Updates the status column of the locations listed in the Additional Search Paths
+ table. Symbol servers or storage locations that are unreachable or misconfigured will show an error status in that column.
+
+
+
(Save)
+
+
Saves the currently displayed search and storage locations to the preferences file. This is shared between all Ghidra tools.
+
+
+
+
+
+
PDB Search - Search Options
+
+
These options control how PDB symbol files are found.
+
+
Ignore Age - allows matching symbol files with the correct GUID, but incorrect age value. Only affects searches of local symbol directories.
+
Ignore GUID/ID - allows matching symbol files with the correct name, but incorrect GUID or age. Only affects searches of local symbol directories.
+
Allow Remote - allows the searching of web-based symbol servers. Off by default to prevent sharing possibly sensitive information (PDB name,
+ GUID, age) with web-based symbol servers outside your organization.
+
+
Additionally, there are override checkboxes in the Program PDB Information panel in the Advanced screen. These override values only
+ change the search criteria, they are not persisted to your program's metadata.
+
+
PDB Name Checkbox - this checkbox allows entering a custom value for the desired PDB file name.
+
PDB Unique Id Checkbox - this checkbox allows entering a custom GUID or ID value.
+
PDB Age Checkbox - this checkbox allows entering a custom age value.
+
+
After changing a search option, you will need to perform another search to use the new options.
+
+
+
+
+
PDB Parser
+
+
These options control which PDB parser will be used and any options used during parsing after the Load button is pressed.
+
+
Universal - Platform-independent PDB analyzer (No PDB.XML support).
+
MSDIA - Legacy PDB Analyzer. Requires MS DIA-SDK for raw PDB processing (Windows only), or preprocessed PDB.XML file.
+
Control - All, Data Types Only, Public Symbols Only.
+
+
+
+
+
Troubleshooting
+
+
+
If you are connecting to a Symbol Server that requires user authentication using PKI,
+ you must first set your PKI Certificate before attempting to download from the server. See
+
+ PKI Certificate for more details.
+
+
+
diff --git a/Ghidra/Features/PDB/src/main/help/help/topics/Pdb/PDB.htm b/Ghidra/Features/PDB/src/main/help/help/topics/Pdb/PDB.htm
index 388ef33464..c349ce849f 100644
--- a/Ghidra/Features/PDB/src/main/help/help/topics/Pdb/PDB.htm
+++ b/Ghidra/Features/PDB/src/main/help/help/topics/Pdb/PDB.htm
@@ -1,36 +1,130 @@
-
+
- Searching
-
+ Microsoft Program Databases (PDB)
-
-
PDB
+
Using Microsoft Program Database (PDB) Files
-
Ghidra offers the ability to download and apply PDB debug information for programs that run
- on Microsoft Windows operating systems.
- The Download PDB File feature allows users to
- download and optionally load/apply a PDB file that matches the user's current program, given an
- accessible Symbol Server.
- The Load PDB File feature
- allows users to apply a local PDB file to the current program. The PDB Analyzer also
- automatically applies PDB symbols (attempting a search for matching PDB files locally) during
- Auto-Analysis.
+
A program database (PDB) file holds debugging and project state information about a program
+ and can be created in a number of ways. Historically, it has been created using a Microsoft
+ compiler and written in C/C++, C#, and Visual Basic.
+ A user generates a PDB file using the /ZI or /Zi flag (for C/C++ programs) or the
+ /debug flag (for Visual Basic/C# programs).
+
There are two mechanisms for processing a PDB file. First, the platform-independent
+ PDB Universal Reader/Analyzer, which can read a raw PDB file and apply it. Its capabilities
+ are expected to be expanded in future releases. Second, the legacy capability that uses the
+ DIA SDK to read information from the PDB file. This mechanism can only run
+ on a Windows platform, however it creates an XML representation of information gleaned using
+ the DIA SDK. These XML files can be saved and then used on Windows and non-Windows platforms
+ hosting Ghidra.
+
+
If loading a PDB, this should be done prior to other analysis, except in special cases,
+ such as when only loading data types.
+
+
Restricted loading of data types or public symbols is
+ supported by PDB Universal.
*.PDB.XML files can be created in three different ways:
+
+
+
From the Ghidra GUI in Windows, use the
+ Ghidra Script Manager
+ to run the CreatePdbXmlFilesScript.java script. Follow the prompts to choose
+ the .PDB file (or directory containing .PDB file(s)) to be converted to .PDB.XML form.
+ When given a directory, the script recursively traverses all subfolders to find .PDB
+ files. A created .PDB.XML file is placed in the same location as the corresponding original
+ .PDB file.
+
+
From a Windows command line, navigate to the following directory:
+ <ghidra install root>/support
+ and run the createPdbXmlFiles.bat script. The script takes one argument representing
+ either one .PDB file or a directory of .PDB files. When given a directory, the script
+ recursively traverses all subdirectories to find .PDB files. A created .PDB.XML file is
+ placed in the same location as the corresponding original .PDB file. Sample calls to the
+ script are shown below.
+
Run the included pdb.exe executable (found in the <ghidra install
+ root>/Ghidra/Features/PDB/os/win64 directory) and redirect (save) its output to an
+ XML file as shown below:
+
+ pdb.exe samplePdb.pdb > samplePdb.pdb.xml
+
+
+
+
NOTE: Execution of pdb.exe has runtime dependencies which must be satisfied.
+ Please refer to the README_PDB document for details.
+
+
Debug Interface Access SDK
+
+
+
The Microsoft Debug Interface Access Software Development Kit (DIA SDK) provides access to
+ debug information stored in program database (.PDB) files generated by Microsoft
+ post-compiler tools. Because the format of the .PDB file generated by the post-compiler tools
+ undergoes constant revision, exposing the format is impractical. Using the DIA API, you can
+ develop applications that search for and browse debug information stored in a .PDB file. Such
+ applications could, for example, report stack trace-back information and analyze performance
+ data.
+
+
If you are attempting to load a PDB on a
+ Windows machine and see an error message such as "Unable to locate the DIA SDK,"
+ you will need to add and register one or more files on your computer. Refer to the
+ README_PDB document for detailed instructions.
+
Ghidra offers the ability to download and apply a PDB file that corresponds to the program
- currently open in the CodeBrowser. Successful downloading requires, at a minimum, that:
-
-
-
-
A Symbol Server URL is available and accessible from the client or computer where you are running Ghidra.
-
The program open in the CodeBrowser is a PE file that was compiled by a Microsoft compiler.
-
-
-
-
A Note for Windows Users
-
-
If set, Ghidra parses the _NT_SYMBOL_PATH
- environment variable that is used to specify a PDB download location and Symbol Server URL(s).
- The syntax for _NT_SYMBOL_PATH is shown below:
-
-
srv*[local symbols location]*[Symbol Server URL]
-
-
The _NT_SYMBOL_PATH symbols location is used to pre-populate the dialog that asks
- for the local storage location (as long as that location is valid). The _NT_SYMBOL_PATH
- Symbol Server URL is used to pre-populate the dialog that asks for the Symbol Server location.
-
-
Although multiple Symbol Server URLs can be
- specified in the _NT_SYMBOL_PATH variable, Ghidra only uses the first listed URL.
-
-
-
To Download a PDB
-
-
-
-
-
From the menu-bar of a tool, select File Download PDB File
-
-
-
-
A dialog appears asking whether you want to download a PDB or XML (PDB.XML) file. Select
- the type of file you want to download and click OK.
-
-
-
-
A Symbol Server should always have PDB
- files available for download. In contrast, .PDB.XML files are Ghidra-created files, and are
- only available to download from the Symbol Server if Ghidra tools have been used to create
- them and the server's admin has made them available. If you choose to download a .PDB.XML
- file and it is not found on the server, you will see a dialog message telling you so. For
- more information on creating and using .PDB.XML files, see the
- Load PDB File section.
-
-
-
-
Before attempting to download the file, an attempt will first be made to locate it
- using file and path names associated with the program. A dialog appears asking whether you
- want to include the PE-Header-Specified Path, which could include a Universal Naming
- Convention (UNC) path of a location that might not be trusted. Select OK if you want to
- perform this potentially unsafe retrieval.
-
-
-
-
-
-
A dialog appears asking where to save the downloaded file. Pick a location to store your
- PDB files. A common location on Windows is C:\Symbols.
-
-
-
-
At this point, if a PDB file of the type you have chosen (either .PDB or .PDB.XML) already
- exists in the selected location, you will see a message indicating that a potential matching
- PDB has been found. You will then be asked if you would like to continue with the download.
-
-
-
If you select "No", jump to Step 7.
-
-
If you select "Yes", please keep the following things in mind relating to a found
- .PDB or .PDB.XML file:
-
-
-
If the found file is not in a directory that contains the current binary's GUID
- (i.e., C:\Symbols\<pdbfilename>\<GUID>), then the file is not
- guaranteed to be an exact match for the current binary (when there is no GUID subfolder,
- a matching file is found based on expected PDB filename).
-
-
-
-
If there is any doubt about whether the found PDB file matches, it is a good
- idea to try to download the matching file, anyway (the matching file will be saved
- in a directory of the form <download location>/<pdbfilename>/
- <GUID>).
-
-
-
-
If you do choose to continue to apply the found PDB file, and its GUID does not
- match the GUID of the current binary, you will be warned and given the option of
- canceling the application of the PDB file.
-
-
-
-
-
-
Next, you will see a dialog asking for the Symbol Server URL.
-
-
-
-
-
-
-
- If a list of known URLs exists in your distribution (the file will have the extension
- .pdburl), the dialog will also include a button with the text "Choose from
- known URLs". When this button is pressed, a separate dialog appears showing known Symbol
- Server URLs.
-
-
-
-
-
-
-
- You may choose any of these URLs or manually type one in. If manually typing in a URL,
- be sure to include the protocol (http or https).
-
-
-
-
Always be sure to check your organization's
- security policy before downloading any file from the internet.
-
-
-
-
-
Next, if the Symbol Server contains a matching PDB that is the same file type that you
- chose earlier, it will return with a message indicating that the download was successful.
- The message also contains the path where you can find the downloaded file.
-
-
-
-
-
If the download was successful or an existing PDB file was found, you may be asked
- whether you want to apply the PDB to the program.
-
-
If Yes is chosen, see
- Load PDB File for continued help.
-
-
-
-
-
-
Troubleshooting
-
-
-
If you are connecting to a Symbol Server that requires user authentication using PKI,
- you must first set your PKI Certificate before attempting to download from the server. See
-
- PKI Certificate for more details.
Load PDB File
-
- 
If you are attempting to load a PDB on a
- Windows machine and see an error message such as "Unable to locate the DIA SDK,"
- you will need to add and register one or more files on your computer. Refer to the
- 
button.
+ The Microsoft symbol server and Program's Import Location are good defaults.
button.
(Delete)
(Up/Down)
(Refresh)
Always be sure to check your organization's
- security policy before downloading any file from the internet.