Skip to content
This repository has been archived by the owner on Apr 17, 2020. It is now read-only.

Analyze obj file dumps with using pdb-s for source file information. #1

Merged
merged 9 commits into from
May 16, 2018
Merged

Analyze obj file dumps with using pdb-s for source file information. #1

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4e13b91
Added enum for IDiaSymbol::get_undecoratedNameEx flags.
May 9, 2018
f656271
Added Symbol.raw_name --- actual symbol name (decorated).
May 9, 2018
4b32daf
Record raw_name when parsing COMDAT files.
May 9, 2018
4b0851f
Record raw_name when parsing PDB files (if available).
May 9, 2018
87fde02
Use info PDBs specifically to replace filename in symbols.
May 9, 2018
35261bc
Do not register raw names with space.
May 9, 2018
367429b
Added "-info XXX.pdb" parameter: such input files are ignored in symb…
May 9, 2018
462de0f
Report symbols with no clear source and symbols not in PDB as coming …
May 9, 2018
13cc640
Never remove overlapping symbols when reading PDB for information only.
May 14, 2018
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
89 changes: 86 additions & 3 deletions SymbolSort.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,33 @@ enum LocationType
LocTypeMax
}

// See https://msdn.microsoft.com/en-us/library/kszfk0fs.aspx
// for documentation of IDiaSymbol::get_undecoratedNameEx flags
[Flags]
enum IDiaSymbolUndecoratedNameExFlags : uint
{
UNDNAME_COMPLETE = 0x0000,
UNDNAME_NO_LEADING_UNDERSCORES = 0x0001,
UNDNAME_NO_MS_KEYWORDS = 0x0002,
UNDNAME_NO_FUNCTION_RETURNS = 0x0004,
UNDNAME_NO_ALLOCATION_MODEL = 0x0008,
UNDNAME_NO_ALLOCATION_LANGUAGE = 0x0010,
UNDNAME_RESERVED1 = 0x0020,
UNDNAME_RESERVED2 = 0x0040,
UNDNAME_NO_THISTYPE = 0x0060,
UNDNAME_NO_ACCESS_SPECIFIERS = 0x0080,
UNDNAME_NO_THROW_SIGNATURES = 0x0100,
UNDNAME_NO_MEMBER_TYPE = 0x0200,
UNDNAME_NO_RETURN_UDT_MODEL = 0x0400,
UNDNAME_32_BIT_DECODE = 0x0800,
UNDNAME_NAME_ONLY = 0x1000,
UNDNAME_TYPE_ONLY = 0x2000,
UNDNAME_HAVE_PARAMETERS = 0x4000,
UNDNAME_NO_ECSU = 0x8000,
UNDNAME_NO_IDENT_CHAR_CHECK = 0x10000,
UNDNAME_NO_PTR64 = 0x20000,
}

// See http://msdn.microsoft.com/en-us/library/windows/desktop/ms680341(v=vs.85).aspx for
// more flag options and descriptions
[Flags]
Expand Down Expand Up @@ -165,8 +192,9 @@ enum SymbolFlags
PublicSymbol = 0x008,
Section = 0x010,
Unmapped = 0x020,
Weak = 0x040
};
Weak = 0x040,
SourceApprox = 0x080, //source filename of this function is not precise
};

class Symbol
{
Expand All @@ -176,6 +204,7 @@ class Symbol
public int rva_end;
public string name;
public string short_name;
public string raw_name; //decorated symbol name
public string source_filename;
public string section;
public SymbolFlags flags = 0;
Expand Down Expand Up @@ -211,10 +240,12 @@ class InputFile
{
public string filename;
public InputType type;
public bool info; //parse file but exclude it from stats
public InputFile(string filename, InputType type)
{
this.filename = filename;
this.type = type;
this.info = false;
}
}

Expand Down Expand Up @@ -529,7 +560,7 @@ private static void ReadSymbolsFromCOMDAT(List<Symbol> symbols, string inFilenam
{
Regex regexName = new Regex(@"\n[ \t]*([^ \t]+)[ \t]+name");
Regex regexSize = new Regex(@"\n[ \t]*([A-Za-z0-9]+)[ \t]+size of raw data");
Regex regexCOMDAT = new Regex(@"\n[ \t]*COMDAT; sym= \""([^\n\""]+)");
Regex regexCOMDAT = new Regex(@"\n[ \t]*COMDAT; sym= \""([^\n\""]+)\"" \(([^\n()]+)\)");

StreamReader reader = new StreamReader(inFilename);

Expand Down Expand Up @@ -576,6 +607,7 @@ record += ln;

m = regexCOMDAT.Match(record);
symbol.name = m.Groups[1].Value;
symbol.raw_name = m.Groups[2].Value;
if (symbol.name != "")
{
symbol.rva_start = 0;
Expand Down Expand Up @@ -918,6 +950,17 @@ private static void ReadSymbolsFromScope(IDiaSymbol parent, Dia2Lib.SymTagEnum t
symbol.short_name = diaSymbol.name == null ? "" : diaSymbol.name;
symbol.name = diaSymbol.undecoratedName == null ? symbol.short_name : diaSymbol.undecoratedName;
symbol.flags = additionalFlags;

//extract raw symbol name (see https://stackoverflow.com/a/19637731/556899)
string rawName;
IDiaSymbolUndecoratedNameExFlags flags = IDiaSymbolUndecoratedNameExFlags.UNDNAME_32_BIT_DECODE | IDiaSymbolUndecoratedNameExFlags.UNDNAME_TYPE_ONLY;
diaSymbol.get_undecoratedNameEx((uint)flags, out rawName);
if (rawName != null) {
//ignore trashy names like " ?? :: ?? ::Z::_NPEBDI_N * __ptr64 volatile "
if (!rawName.Contains(' '))
symbol.raw_name = rawName;
}

switch (type)
{
case SymTagEnum.SymTagData:
Expand Down Expand Up @@ -954,6 +997,7 @@ private static void ReadSymbolsFromScope(IDiaSymbol parent, Dia2Lib.SymTagEnum t
{
IDiaSectionContrib sectionContrib = FindSectionContribForRVA(symbol.rva_start, sectionContribs);
symbol.source_filename = sectionContrib == null ? "" : compilandFileMap[sectionContrib.compilandId];
symbol.flags |= SymbolFlags.SourceApprox;
}
symbol.section = "code";
symbol.flags |= SymbolFlags.Function;
Expand Down Expand Up @@ -1580,6 +1624,12 @@ private static bool ParseArgs(
{
inputFiles.Add(new InputFile(args[++curArg], InputType.nm_bsd));
}
else if (curArgStr == "-info")
{
var infile = new InputFile(args[++curArg], InputType.pdb);
infile.info = true;
inputFiles.Add(infile);
}
else if (curArgStr == "-out")
{
outFilename = args[++curArg];
Expand Down Expand Up @@ -1773,6 +1823,7 @@ static void Main(string[] args)
List<Symbol> symbols = new List<Symbol>();
foreach (InputFile inputFile in inputFiles)
{
if (inputFile.info) continue;
LoadSymbols(inputFile, symbols, searchPath, options);
Console.WriteLine();
}
Expand Down Expand Up @@ -1805,6 +1856,38 @@ static void Main(string[] args)
});
}

List<InputFile> infoPdb = inputFiles.FindAll(f => f.info && f.type == InputType.pdb);
if (infoPdb.Count() > 0)
{
var infoSymbols = new List<Symbol>();
foreach (InputFile f in infoPdb)
LoadSymbols(f, infoSymbols, searchPath, options | Options.KeepRedundantSymbols);
var infoDict = new Dictionary<string, Symbol>();
foreach (Symbol s in infoSymbols)
if (s.raw_name != null)
if (!infoDict.ContainsKey(s.raw_name))
{
infoDict.Add(s.raw_name, s);
if ((s.flags & SymbolFlags.SourceApprox) != 0)
s.source_filename = "[unclear_source]";
}

Console.WriteLine("Connecting symbols to PDB info...");
int connectedCnt = 0, allCnt = symbols.Count;
foreach (Symbol s in symbols)
{
Symbol info;
if (infoDict.TryGetValue(s.raw_name, out info))
{
connectedCnt++;
s.source_filename = info.source_filename;
}
else
s.source_filename = "[not_in_pdb]";
}
Console.WriteLine("Connected {0}% symbols ({1}/{2})", (uint)(100.0 * connectedCnt / allCnt), connectedCnt, allCnt);
}

Console.WriteLine("Processing raw symbols...");
{
long totalCount = 0;
Expand Down