**Lookup key**: `foo.pdb/497b72f6390a44fc878e5a2d63b6cc4b1/foo.pdb`
+### PDZ-Signature-Age
+
+This applies to the Microsoft C++ Symbol Format with compressed streams, known as PDZ or msfz, also commonly saved with the pdb extension.
+
+Like regular C++ PDBs, the key also uses values extracted from the GUID stream which is uncompressed. Additionally, the index contains a marker for the type ('msfz') and version (currently only '0'):
+
+`<filename>/<Signature><Age>/msfz<version>/<filename>`
+
+Example:
+
+**File name:** `Foo.pdb`
+
+**Signature field:** `{ 0x497B72F6, 0x390A, 0x44FC, { 0x87, 0x8E, 0x5A, 0x2D, 0x63, 0xB6, 0xCC, 0x4B } }`
+
+**Age field:** `0x1`
+
+**Format version:** `0`
+
+**Lookup key**: `foo.pdb/497b72f6390a44fc878e5a2d63b6cc4b1/msfz0/foo.pdb`
### Portable-Pdb-Signature
public StreamAddressSpace(Stream stream)
{
- System.Diagnostics.Debug.Assert(stream.CanSeek);
+ if (stream is null || !stream.CanSeek)
+ {
+ throw new ArgumentException("Stream null or not seekable", nameof(stream));
+ }
_stream = stream;
Length = (ulong)stream.Length;
}
public ELFFileKeyGenerator(ITracer tracer, ELFFile elfFile, string path)
: base(tracer)
{
- _elfFile = elfFile;
- _path = path;
+ _elfFile = elfFile ?? throw new ArgumentNullException(nameof(elfFile));
+ _path = path ?? throw new ArgumentNullException(nameof(path));
}
public ELFFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
protected static SymbolStoreKey BuildKey(string path, string id, bool clrSpecialFile = false, IEnumerable<PdbChecksum> pdbChecksums = null)
{
string file = GetFileName(path).ToLowerInvariant();
- return BuildKey(path, null, id, file, clrSpecialFile, pdbChecksums);
+ return BuildKey(path, prefix: null, id, type: null, file, clrSpecialFile, pdbChecksums);
}
/// <summary>
/// <returns>key</returns>
protected static SymbolStoreKey BuildKey(string path, string prefix, byte[] id, string file, bool clrSpecialFile = false, IEnumerable<PdbChecksum> pdbChecksums = null)
{
- return BuildKey(path, prefix, ToHexString(id), file, clrSpecialFile, pdbChecksums);
+ return BuildKey(path, prefix, ToHexString(id), type: null, file, clrSpecialFile, pdbChecksums);
}
/// <summary>
/// <returns>key</returns>
protected static SymbolStoreKey BuildKey(string path, string prefix, string id, string file, bool clrSpecialFile = false, IEnumerable<PdbChecksum> pdbChecksums = null)
{
+ return BuildKey(path, prefix, id, type: null, file, clrSpecialFile, pdbChecksums);
+ }
+
+ /// <summary>
+ /// Base key building helper for "file/{prefix}-id/{type}/file" indexes.
+ /// </summary>
+ /// <param name="path">full path of file or binary</param>
+ /// <param name="prefix">optional id prefix</param>
+ /// <param name="id">build id or uuid</param>
+ /// <param name="type">optional type or format piece</param>
+ /// <param name="file">file name only</param>
+ /// <param name="clrSpecialFile">if true, the file is one the clr special files</param>
+ /// <param name="pdbChecksums">Checksums of pdb file. May be null.</param>
+ /// <returns>key</returns>
+ internal static SymbolStoreKey BuildKey(string path, string prefix, string id, string type, string file, bool clrSpecialFile, IEnumerable<PdbChecksum> pdbChecksums)
+ {
+ if (id is null or "")
+ {
+ throw new ArgumentNullException(nameof(id));
+ }
+ if (file is null or "")
+ {
+ throw new ArgumentNullException(nameof(file));
+ }
StringBuilder key = new();
key.Append(file);
key.Append('/');
- if (prefix != null)
+ if (prefix is not null)
{
key.Append(prefix);
key.Append('-');
}
key.Append(id);
+ if (type is not null)
+ {
+ key.Append('/');
+ key.Append(type);
+ }
key.Append('/');
key.Append(file);
return new SymbolStoreKey(key.ToString(), path, clrSpecialFile, pdbChecksums);
/// <returns>hex string</returns>
public static string ToHexString(byte[] bytes)
{
- if (bytes == null)
+ if (bytes is null)
{
throw new ArgumentNullException(nameof(bytes));
}
/// <returns>just the file name</returns>
internal static string GetFileName(string path)
{
+ if (path is null or "")
+ {
+ throw new ArgumentNullException(nameof(path));
+ }
return Path.GetFileName(path.Replace('\\', '/'));
}
}
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
+using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
public MachOFileKeyGenerator(ITracer tracer, MachOFile machoFile, string path)
: base(tracer)
{
- _machoFile = machoFile;
- _path = path;
+ _machoFile = machoFile ?? throw new ArgumentNullException(nameof(machoFile));
+ _path = path ?? throw new ArgumentNullException(nameof(path));
}
public MachOFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
using System;
using System.Collections.Generic;
using System.Diagnostics;
+using System.IO;
using Microsoft.FileFormats;
using Microsoft.FileFormats.PDB;
using Microsoft.FileFormats.PE;
public PDBFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
: base(tracer)
{
+ if (file is null)
+ {
+ throw new ArgumentNullException(nameof(file));
+ }
StreamAddressSpace dataSource = new(file.Stream);
_pdbFile = new PDBFile(dataSource);
_path = file.FileName;
{
if ((flags & KeyTypeFlags.IdentityKey) != 0)
{
- if (_pdbFile.DbiStream.IsValid())
- {
- yield return GetKey(_path, _pdbFile.Signature, unchecked((int)_pdbFile.DbiAge));
- }
- else
- {
- yield return GetKey(_path, _pdbFile.Signature, unchecked((int)_pdbFile.Age));
- }
+ uint age = _pdbFile.DbiStream.IsValid() ? _pdbFile.DbiAge : _pdbFile.Age;
+ // No format type if legacy Windows PDB (MSF), otherwise, pass container type string (i.e. msfz0)
+ string type = _pdbFile.ContainerKind == PDBContainerKind.MSF ? null : _pdbFile.ContainerKindSpecString;
+ yield return GetKey(_path, _pdbFile.Signature, unchecked((int)age), type, pdbChecksums: null);
}
}
}
/// <param name="path">file name and path</param>
/// <param name="signature">mvid guid</param>
/// <param name="age">pdb age</param>
+ /// <param name="pdbChecksums">Checksums of pdb file. May be null.</param>
/// <returns>symbol store key</returns>
public static SymbolStoreKey GetKey(string path, Guid signature, int age, IEnumerable<PdbChecksum> pdbChecksums = null)
{
- Debug.Assert(path != null);
- Debug.Assert(signature != null);
- return BuildKey(path, string.Format("{0}{1:x}", signature.ToString("N"), age));
+ return GetKey(path, signature, age, type: null, pdbChecksums);
+ }
+
+ /// <summary>
+ /// Create a symbol store key for a Windows PDB or PDZ.
+ /// </summary>
+ /// <param name="path">file name and path</param>
+ /// <param name="signature">mvid guid</param>
+ /// <param name="age">pdb age</param>
+ /// <param name="type">PDB format type like msfz0 or null</param>
+ /// <param name="pdbChecksums">Checksums of pdb file. May be null.</param>
+ /// <returns>symbol store key</returns>
+ public static SymbolStoreKey GetKey(string path, Guid signature, int age, string type, IEnumerable<PdbChecksum> pdbChecksums = null)
+ {
+ string file = GetFileName(path).ToLowerInvariant();
+ return BuildKey(path, prefix: null, string.Format("{0}{1:x}", signature.ToString("N"), age), type, file, clrSpecialFile: false, pdbChecksums);
}
}
}
public PEFileKeyGenerator(ITracer tracer, PEFile peFile, string path)
: base(tracer)
{
- _peFile = peFile;
- _path = path;
+ _peFile = peFile ?? throw new ArgumentNullException(nameof(peFile));
+ _path = path ?? throw new ArgumentNullException(nameof(path));
}
public PEFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
+using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
public PerfMapFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
: base(tracer)
{
- _file = file;
+ _file = file ?? throw new ArgumentNullException(nameof(file));
_perfmapFile = new PerfMapFile(_file.Stream);
}
public PortablePDBFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
: base(tracer)
{
- _file = file;
+ _file = file ?? throw new ArgumentNullException(nameof(file));
}
public override bool IsValid()
else
{
// Force the Windows PDB index
- key = PDBFileKeyGenerator.GetKey(_file.FileName, blob.Guid, 1);
+ key = PDBFileKeyGenerator.GetKey(_file.FileName, blob.Guid, age: 1);
}
}
}
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
+using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Security.Cryptography;
public SourceFileKeyGenerator(ITracer tracer, SymbolStoreFile file)
: base(tracer)
{
- _file = file;
+ _file = file ?? throw new ArgumentNullException(nameof(file));
}
public override bool IsValid()
/// <param name="fileName">name of the file</param>
public SymbolStoreFile(Stream stream, string fileName)
{
- Debug.Assert(stream != null);
- Debug.Assert(stream.CanSeek);
- Debug.Assert(fileName != null);
-
+ if (stream is null || !stream.CanSeek)
+ {
+ throw new ArgumentException("Stream null or not seekable", nameof(stream));
+ }
+ if (fileName is null or "")
+ {
+ throw new ArgumentNullException(nameof(fileName));
+ }
Stream = stream;
FileName = fileName;
}
/// <param name="pdbChecksums">if true, the file is one the clr special files</param>
public SymbolStoreKey(string index, string fullPathName, bool clrSpecialFile = false, IEnumerable<PdbChecksum> pdbChecksums = null)
{
- Debug.Assert(index != null && fullPathName != null);
- Index = index;
- FullPathName = fullPathName;
+ Index = index ?? throw new ArgumentNullException(nameof(index));
+ FullPathName = fullPathName ?? throw new ArgumentNullException(nameof(fullPathName));
IsClrSpecialFile = clrSpecialFile;
PdbChecksums = pdbChecksums ?? Enumerable.Empty<PdbChecksum>();
}
/// <summary>
- /// Returns the first two parts of the index tuple. Allows a different file name
+ /// Returns the first two or three parts of the index. Allows a different file name
/// to be appended to this symbol key. Includes the trailing "/".
/// </summary>
+ [Obsolete]
public string IndexPrefix
{
get { return Index.Substring(0, Index.LastIndexOf("/") + 1); }
public static bool IsKeyValid(string index)
{
string[] parts = index.Split(new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);
- if (parts.Length != 3) {
+ if (parts.Length < 3 || parts.Length > 4)
+ {
return false;
}
- for (int i = 0; i < 3; i++)
+ for (int i = 0; i < parts.Length; i++)
{
foreach (char c in parts[i])
{
- if (char.IsLetterOrDigit(c)) {
+ if (char.IsLetterOrDigit(c))
+ {
continue;
}
- if (!s_invalidChars.Contains(c)) {
+ if (!s_invalidChars.Contains(c))
+ {
continue;
}
return false;
}
// We need to support files with . in the name, but we don't want identifiers that
// are meaningful to the filesystem
- if (parts[i] == "." || parts[i] == "..") {
+ if (parts[i] == "." || parts[i] == "..")
+ {
return false;
}
}
<Content Include="$(MSBuildThisFileDirectory)TestBinaries\HelloWorld.pdb">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
+ <Content Include="$(MSBuildThisFileDirectory)TestBinaries\HelloWorld.pdz">
+ <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+ </Content>
<Content Include="$(MSBuildThisFileDirectory)TestBinaries\libclrjit.dylib.dwarf.gz">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<ProjectReference Include="$(MSBuildThisFileDirectory)..\TestHelpers\TestHelpers.csproj" />
</ItemGroup>
- <ItemGroup>
- <None Update="TestBinaries\HelloWorld.pdz">
- <CopyToOutputDirectory>Always</CopyToOutputDirectory>
- </None>
- </ItemGroup>
</Project>
//MachCoreKeyGeneratorInternal(fileGenerator: true);
MachOFileKeyGeneratorInternal(fileGenerator: true);
MinidumpKeyGeneratorInternal(fileGenerator: true);
- PDBFileKeyGeneratorInternal(fileGenerator: true);
+ PDBFileKeyGeneratorInternal(fileGenerator: true, pdz: false);
+ PDBFileKeyGeneratorInternal(fileGenerator: true, pdz: true);
PEFileKeyGeneratorInternal(fileGenerator: true);
PortablePDBFileKeyGeneratorInternal(fileGenerator: true);
PerfMapFileKeyGeneratorInternal(fileGenerator: true);
[Fact]
public void PDBFileKeyGenerator()
{
- PDBFileKeyGeneratorInternal(fileGenerator: false);
+ PDBFileKeyGeneratorInternal(fileGenerator: false, pdz: false);
}
- private void PDBFileKeyGeneratorInternal(bool fileGenerator)
+ [Fact]
+ public void PDZFileKeyGenerator()
{
- const string TestBinary = "TestBinaries/HelloWorld.pdb";
- using (Stream pdb = File.OpenRead(TestBinary))
+ PDBFileKeyGeneratorInternal(fileGenerator: false, pdz: true);
+ }
+
+ private void PDBFileKeyGeneratorInternal(bool fileGenerator, bool pdz)
+ {
+ using (Stream pdb = File.OpenRead(pdz ? "TestBinaries/HelloWorld.pdz" : "TestBinaries/HelloWorld.pdb"))
{
- var file = new SymbolStoreFile(pdb, TestBinary);
+ var file = new SymbolStoreFile(pdb, "TestBinaries/HelloWorld.pdb");
KeyGenerator generator = fileGenerator ? (KeyGenerator)new FileKeyGenerator(_tracer, file) : new PDBFileKeyGenerator(_tracer, file);
IEnumerable<SymbolStoreKey> identityKey = generator.GetKeys(KeyTypeFlags.IdentityKey);
Assert.True(identityKey.Count() == 1);
- Assert.True(identityKey.First().Index == "helloworld.pdb/99891b3ed7ae4c3babff8a2b4a9b0c431/helloworld.pdb");
+
+ string index = pdz ?
+ "helloworld.pdb/99891b3ed7ae4c3babff8a2b4a9b0c431/msfz0/helloworld.pdb" :
+ "helloworld.pdb/99891b3ed7ae4c3babff8a2b4a9b0c431/helloworld.pdb";
+
+ Assert.True(identityKey.First().Index == index);
IEnumerable<SymbolStoreKey> symbolKey = generator.GetKeys(KeyTypeFlags.SymbolKey);
Assert.True(symbolKey.Count() == 0);
<Content Include="$(MSBuildThisFileDirectory)..\Microsoft.FileFormats.UnitTests\TestBinaries\HelloWorld.pdb" Link="TestBinaries\HelloWorld.pdb">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
+ <Content Include="$(MSBuildThisFileDirectory)..\Microsoft.FileFormats.UnitTests\TestBinaries\HelloWorld.pdz" Link="TestBinaries\HelloWorld.pdz">
+ <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+ </Content>
<Content Include="$(MSBuildThisFileDirectory)..\Microsoft.FileFormats.UnitTests\TestBinaries\HelloWorld.exe" Link="TestBinaries\HelloWorld.exe">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
projects / platform / core / dotnet / diagnostics.git / commitdiff