PDB tools

This repository contains libraries and tools for working with Microsoft Program Database (PDB) files. All of the code is in Rust.

• The ms-pdb-msf crate contains code for reading, creating, and modifying PDB files that use the MSF container format. Currently, all PDBs produced by Microsoft tools use the MSF container format.

  This is a lower-level building block for PDBs, and most developers will never need to directly use the ms-pdb-msf crate. Instead, they should use the ms-pdb crate.

• The ms-pdb-msfz crate contains code for reading and writing PDB files that use the MSFZ container format. MSFZ is a new container format that is optimized for "cold storage"; PDB/MSFZ files cannot be modified in-place in the way PDB/MSF files can, but MSFZ files use an efficient form of compression that allows data to be accessed without decompressing the entire file. MSFZ is intended to be a format for storing PDBs, not for local development.

  Most developers will not need to use the ms-pdb-msfz crate directly. Instead, they should use the ms-pdb crate.

• The ms-pdb crate supports reading, creating, and modifying PDB files. It builds on the ms-pdb-msf and ms-pdb-msfz crate. The ms-pdb-msf and ms-pdb-msfz crates provide the container format for PDB, but they do not contain any code for working with the contents of PDBs. That is the job of the ms-pdb crate -- it provides methods for reading specific PDB data structures, such as debug symbols, line mappings, module records, etc.

All information in this implementation is based on publicly-available information

With the exception of MSFZ, this implementation is based solely on public sources that describe the PDB and MSF data structures. This repository does not contain any confidential Microsoft intellectual property.

MSFZ describes an experimental data format and is subject to change without notice

The MSFZ specification in this repository describes an experimental container format for PDBs. Microsoft makes no commitment to the stability or support for MSFZ. The MSFZ format may be changed or discontinued at any time, without any notice or obligation for Microsoft to take any action. At some future point, Microsoft may make a support commitment to MSFZ (possibly with incompatible changes made to it), but this repository does not imply any commitment or agreement to do so.

THIS IMPLEMENTATION IS NOT AUTHORITATIVE AND IS NOT A REFERENCE IMPLEMENTATION

This implementation is NOT an authoritative reference. It may contain defects or inaccuracies. As the LICENSE states, this implementation is provided "as is", without warranty of any kind. Specifically, this implementation DOES NOT make any guarantees about compatibility or interoperability with any other toolset, including (but not limited to) Microsoft Visual C++ (MSVC) and Clang.

The authors of this effort may make a good-faith effort to fix bugs, including bugs discovered by the authors or the community. However, as the license states, this repository is provided "as is" and there is absolutely no obligation or expectation on levels of service for the implementation provided in this repository.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Repository

• https://github.com/microsoft/pdb-rs

Contacts

• sivadeilra on GitHub
• Arlie Davis ardavis@microsoft.com

lib.rs:

Multi-Stream File - Compressed

This crate allows reading and writing PDZ/MSFZ files. PDZ/MSFZ files are similar to PDB/MSF files. They contain a set of streams, which are indexed by number. Each stream is a sequence of bytes, similar to an ordinary file.

See the spec module for a description of the MSFZ file format.