Skip to content

[PDB] Handle exception during opening a pdb file #7573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2025
Merged

[PDB] Handle exception during opening a pdb file #7573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
084a99e
Handle exception during opening a pdb file
dudikeleti Sep 29, 2025
0fd0403
Better to check before throw
dudikeleti Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tracer/src/Datadog.Trace/Debugger/SpanCodeOrigin/EndpointDetector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ internal static class EndpointDetector

internal static ImmutableHashSet<int> GetEndpointMethodTokens(DatadogMetadataReader datadogMetadataReader)
{
if (datadogMetadataReader is null)
{
ThrowHelper.ThrowArgumentNullException(nameof(datadogMetadataReader));
}

var builder = ImmutableHashSet.CreateBuilder<int>();
var metadataReader = datadogMetadataReader.MetadataReader;
foreach (var typeHandle in metadataReader.TypeDefinitions)
Expand Down
2 changes: 1 addition & 1 deletion tracer/src/Datadog.Trace/Debugger/Symbols/SymbolExtractor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ protected SymbolExtractor(DatadogMetadataReader metadataReader, string assemblyP

if (datadogMetadataReader.MetadataReader.TypeDefinitions.Count == 0)
{
Log.Debug("Could not found any type in assembly {Assembly}", assembly.FullName);
Log.Debug("Could not find any type in assembly {Assembly}", assembly.FullName);
return null;
}

Expand Down
54 changes: 33 additions & 21 deletions tracer/src/Datadog.Trace/PDBs/DatadogMetadataReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,33 +73,45 @@ private DatadogMetadataReader(PEReader peReader, MetadataReader metadataReader,
return null;
}

// For metadata we are always using System.Reflection.Metadata
// For PDB, Reflection.Metadata for portable and embedded PDB and dnlib for windows PDB
var peReader = new PEReader(File.OpenRead(assembly.Location), PEStreamOptions.PrefetchMetadata | PEStreamOptions.PrefetchEntireImage);
MetadataReader metadataReader = peReader.GetMetadataReader(MetadataReaderOptions.Default);
MetadataReader? pdbReader;
if (peReader.TryOpenAssociatedPortablePdb(assembly.Location, File.OpenRead, out var metadataReaderProvider, out var pdbPath))
try
{
pdbReader = metadataReaderProvider!.GetMetadataReader(MetadataReaderOptions.Default, MetadataStringDecoder.DefaultUTF8);
return new DatadogMetadataReader(peReader, metadataReader, pdbReader, pdbPath ?? assembly.Location, null, null);
}
// For metadata we are always using System.Reflection.Metadata
// For PDB, Reflection.Metadata for portable and embedded PDB and dnlib for windows PDB
var peReader = new PEReader(File.OpenRead(assembly.Location), PEStreamOptions.PrefetchMetadata | PEStreamOptions.PrefetchEntireImage);
MetadataReader metadataReader = peReader.GetMetadataReader(MetadataReaderOptions.Default);
if (peReader.TryOpenAssociatedPortablePdb(assembly.Location, File.OpenRead, out var metadataReaderProvider, out var pdbPath))
{
var pdbReader = metadataReaderProvider!.GetMetadataReader(MetadataReaderOptions.Default, MetadataStringDecoder.DefaultUTF8);
return new DatadogMetadataReader(peReader, metadataReader, pdbReader, pdbPath ?? assembly.Location, null, null);
}

if (!TryFindPdbFile(assembly.Location, out var pdbFullPath))
{
return new DatadogMetadataReader(peReader, metadataReader, null, null, null, null);
}

var module = Datadog.Trace.Vendors.dnlib.DotNet.ModuleDefMD.Load(assembly.ManifestModule, new Datadog.Trace.Vendors.dnlib.DotNet.ModuleCreationOptions { TryToLoadPdbFromDisk = false });
var pdbStream = Datadog.Trace.Vendors.dnlib.IO.DataReaderFactoryFactory.Create(pdbFullPath, false);
var dnlibReader = Datadog.Trace.Vendors.dnlib.DotNet.Pdb.SymbolReaderFactory.Create(Datadog.Trace.Vendors.dnlib.DotNet.ModuleCreationOptions.DefaultPdbReaderOptions, module.Metadata, pdbStream);
if (dnlibReader == null)
{
return new DatadogMetadataReader(peReader, metadataReader, null, null, null, null);
}

if (!TryFindPdbFile(assembly.Location, out var pdbFullPath))
dnlibReader.Initialize(module);
module.LoadPdb(dnlibReader);
return new DatadogMetadataReader(peReader, metadataReader, null, pdbFullPath, dnlibReader, module);
}
catch (IOException e)
{
return new DatadogMetadataReader(peReader, metadataReader, null, null, null, null);
Logger.Debug("Error while trying to get a pdb for {Assembly} in location: {AssemblyLocation}. Error: {Error}", assembly.FullName, assembly.Location, e.Message);
return null;
}

var module = Datadog.Trace.Vendors.dnlib.DotNet.ModuleDefMD.Load(assembly.ManifestModule, new Datadog.Trace.Vendors.dnlib.DotNet.ModuleCreationOptions { TryToLoadPdbFromDisk = false });
var pdbStream = Datadog.Trace.Vendors.dnlib.IO.DataReaderFactoryFactory.Create(pdbFullPath, false);
var dnlibReader = Datadog.Trace.Vendors.dnlib.DotNet.Pdb.SymbolReaderFactory.Create(Datadog.Trace.Vendors.dnlib.DotNet.ModuleCreationOptions.DefaultPdbReaderOptions, module.Metadata, pdbStream);
if (dnlibReader == null)
catch (Exception e)
{
return new DatadogMetadataReader(peReader, metadataReader, null, null, null, null);
Logger.Error(e, "Error while trying to get a pdb for {Assembly} in location: {AssemblyLocation}", assembly.FullName, assembly.Location);
return null;
}

dnlibReader.Initialize(module);
module.LoadPdb(dnlibReader);
return new DatadogMetadataReader(peReader, metadataReader, null, pdbFullPath, dnlibReader, module);
}

private static bool TryFindPdbFile(string assemblyLocation, [NotNullWhen(true)] out string? pdbFullPath)
Expand Down
Loading