Fix source file mapping case sensitive bug, avoid Timeline assert

Author: gratianlup

installer/arm64/prepare-installer.cmd

@@ -1,3 +1,3 @@
-set %_VERSION="1.1.3"
+set %_VERSION="1.1.4"
 
 iscc.exe installer.iss /DAPP_VERSION=%_VERSION% /O%cd%

installer/x64/prepare-installer.cmd

@@ -1,3 +1,3 @@
-set %_VERSION="1.1.3"
+set %_VERSION="1.1.4"
 
 iscc.exe installer.iss /DAPP_VERSION=%_VERSION% /O%cd%

src/ProfileExplorerCore/Utilities/SourceFileMapper.cs

@@ -7,15 +7,17 @@
 namespace ProfileExplorer.Core;
 
 public class SourceFileMapper {
-  private readonly Dictionary<string, string> map_;
+  private readonly Dictionary<string, string> sourcePathMap_;
+  private readonly Dictionary<string, string> sourceFileCache_;
   private readonly object lockObject_ = new();
 
-  public SourceFileMapper(Dictionary<string, string> map = null) {
-    map_ = map;
-    map_ ??= new Dictionary<string, string>();
+  public SourceFileMapper(Dictionary<string, string> sourcePathMap = null) {
+    sourcePathMap_ = sourcePathMap;
+    sourcePathMap_ ??= new Dictionary<string, string>(); // Saved across sessions.
+    sourceFileCache_ = new Dictionary<string, string>(); // Active per session.
   }
 
-  public Dictionary<string, string> SourceMap => map_;
+  public Dictionary<string, string> SourceMap => sourcePathMap_;
 
   public string Map(string sourceFile, Func<string> lookup = null) {
     if (string.IsNullOrEmpty(sourceFile)) {
@@ -43,15 +45,23 @@ public string Map(string sourceFile, Func<string> lookup = null) {
 
   public void Reset() {
     lock (lockObject_) {
-      map_.Clear();
+      sourcePathMap_.Clear();
+      sourcePathMap_.Clear();
     }
   }
 
   private bool TryLookupInMap(string sourceFile, out string result) {
+    // Check the direct mapping cache first.
+    if (sourceFileCache_.TryGetValue(sourceFile, out result)) {
+      return true;
+    }
+
+    // Use the past directory mappings to build the equivalent
+    // local path for the source file.
     int index = sourceFile.LastIndexOf(Path.DirectorySeparatorChar);
 
     while (index > 0) {
-      if (map_.TryGetValue(sourceFile.Substring(0, index), out string mappedDirectory)) {
+      if (sourcePathMap_.TryGetValue(sourceFile.Substring(0, index), out string mappedDirectory)) {
         result = Path.Combine(mappedDirectory, sourceFile.Substring(index + 1));
         return true;
       }
@@ -69,18 +79,26 @@ public void UpdateMap(string originalPath, string mappedPath) {
       return;
     }
 
+    sourceFileCache_[originalPath] = mappedPath;
+
+    // Try to create a mapping between the directory paths,
+    // to be used later with another source file part of the same
+    // directory structure.
     int prevOriginalPath = originalPath.Length;
     int prevMappedPath = mappedPath.Length;
     int originalPathIndex = originalPath.LastIndexOf(Path.DirectorySeparatorChar);
     int mappedPathIndex = mappedPath.LastIndexOf(Path.DirectorySeparatorChar);
 
     while (originalPathIndex > 0 && mappedPathIndex > 0) {
-      if (originalPath.Substring(originalPathIndex, prevOriginalPath - originalPathIndex) !=
-          mappedPath.Substring(mappedPathIndex, prevMappedPath - mappedPathIndex)) {
+      // Stop once there is a mismatch in directory names.
+      // Use a case-insensitive compare for Windows paths.
+      if (!originalPath.Substring(originalPathIndex, prevOriginalPath - originalPathIndex).Equals(
+        mappedPath.Substring(mappedPathIndex, prevMappedPath - mappedPathIndex),
+        StringComparison.OrdinalIgnoreCase)) {
         return;
       }
 
-      map_[originalPath.Substring(0, originalPathIndex)] = mappedPath.Substring(0, mappedPathIndex);
+      sourcePathMap_[originalPath.Substring(0, originalPathIndex)] = mappedPath.Substring(0, mappedPathIndex);
       prevOriginalPath = originalPathIndex;
       prevMappedPath = mappedPathIndex;
 

src/ProfileExplorerUI/Binary/PDBDebugInfoProvider.cs

@@ -27,6 +27,8 @@ namespace ProfileExplorer.UI.Binary;
 public sealed class PDBDebugInfoProvider : IDebugInfoProvider {
   private const int MaxDemangledFunctionNameLength = 8192;
   private const int FunctionCacheMissThreshold = 100;
+  private const int MaxLogEntryLength = 10240;
+
   private static ConcurrentDictionary<SymbolFileDescriptor, DebugFileSearchResult> resolvedSymbolsCache_ = new();
   private static readonly StringWriter authLogWriter_;
   private static readonly SymwebHandler authSymwebHandler_;
@@ -608,14 +610,14 @@ private SourceFileDebugInfo FindFunctionSourceFilePathImpl(SourceLineDebugInfo l
             Trace.WriteLine($"Query source server for {sourceLine?.SourceFile?.BuildTimeFilePath}");
             string filePath = sourceLine.SourceFile.GetSourceFile();
 
-            if (ValidateDownloadedSourceFile(filePath)) {
+            if (SourceFileChecksumMatchesPDB(sourceFile, filePath)) {
               Trace.WriteLine($"Downloaded source file {filePath}");
               localFilePath = filePath;
               hasChecksumMismatch = !SourceFileChecksumMatchesPDB(sourceFile, localFilePath);
             }
             else {
               Trace.WriteLine($"Failed to download source file {localFilePath}");
-              Trace.WriteLine(symbolReaderLog_.ToString());
+              Trace.WriteLine(symbolReaderLog_.ToString().TrimToLength(MaxLogEntryLength));
               symbolReaderLog_.GetStringBuilder().Clear();
               Trace.WriteLine("---------------------------------");
             }
@@ -630,25 +632,11 @@ private SourceFileDebugInfo FindFunctionSourceFilePathImpl(SourceLineDebugInfo l
     return new SourceFileDebugInfo(localFilePath, originalFilePath, lineInfo.Line, hasChecksumMismatch);
   }
 
-  private bool ValidateDownloadedSourceFile(string filePath) {
-    try {
-      if (!File.Exists(filePath)) {
-        return false;
-      }
-
-      // If the source server requires authentication, but it's not properly set up,
-      // usually an HTML error page is returned instead, treat it as a failure.
-      //? TODO: Better way to detect this, may need change in TraceEvent lib.
-      string fileText = File.ReadAllText(filePath);
-      return !fileText.Contains(@"<!DOCTYPE html");
-    }
-    catch (Exception ex) {
-      Trace.WriteLine($"Failed to validate downloaded source file {filePath}: {ex.Message}");
+  private bool SourceFileChecksumMatchesPDB(IDiaSourceFile sourceFile, string filePath) {
+    if (string.IsNullOrEmpty(filePath)) {
       return false;
     }
-  }
 
-  private bool SourceFileChecksumMatchesPDB(IDiaSourceFile sourceFile, string filePath) {
     var hashAlgo = GetSourceFileChecksumHashAlgorithm(sourceFile);
     byte[] pdbChecksum = GetSourceFileChecksum(sourceFile);
     byte[] fileChecksum = ComputeSourceFileChecksum(filePath, hashAlgo);

src/ProfileExplorerUI/Profile/Timeline/ActivityView.xaml.cs

@@ -305,7 +305,7 @@ public Task Initialize(ProfileData profile, Rect visibleArea, int threadId = -1)
     }
 
     samplingInterval_ = profile_.Report.SamplingInterval;
-    maxWidth_ = prevMaxWidth_ = visibleArea.Width;
+    maxWidth_ = prevMaxWidth_ = Math.Max(0, visibleArea.Width);
     visual_ = new DrawingVisual();
     visual_.Drawing?.Freeze();
     AddVisualChild(visual_);
@@ -329,8 +329,8 @@ public void SetMaxWidth(double maxWidth) {
       return;
     }
 
-    prevMaxWidth_ = maxWidth;
-    maxWidth_ = maxWidth;
+    prevMaxWidth_ = Math.Max(0, maxWidth);
+    maxWidth_ = Math.Max(0, maxWidth);
     Redraw();
     InvalidateMeasure();
   }
@@ -565,13 +565,14 @@ private void ActivityView_MouseMove(object sender, MouseEventArgs e) {
   }
 
   private List<SliceList> ComputeSampleSlices(ProfileData profile, int threadId = -1) {
-    if (profile.Samples.Count == 0) {
+    if (profile.Samples.Count == 0 || maxWidth_ < double.Epsilon) {
       return new List<SliceList>();
     }
 
     startTime_ = profile.Samples[0].Sample.Time;
     endTime_ = profile.Samples[^1].Sample.Time;
-    double slices = maxWidth_ / sliceWidth_ * (prevMaxWidth_ / maxWidth_);
+    double slices = (maxWidth_ / sliceWidth_) * (prevMaxWidth_ / maxWidth_);
+
     var timeDiff = endTime_ - startTime_;
     double timePerSlice = timeDiff.Ticks / slices;
     double timePerSliceReciproc = 1.0 / timePerSlice;

src/ProfileExplorerUI/Profile/Utils/SourceFileFinder.cs

@@ -55,6 +55,10 @@ public void SaveSettings(SourceFileFinderSettings settings) {
         return (SourceFileDebugInfo.Unknown, FailureReason.DebugInfoNotFound);
       }
 
+      // First get the source file path from the debug file (this may download it
+      // from a source file server, if enabled). If the file path is not found
+      // on this machine, try to map it to a local path either automatically
+      // or by asking the user to manually locate the source file.
       var sourceInfo = SourceFileDebugInfo.Unknown;
       var funcProfile = session_.ProfileData?.GetFunctionProfile(function);
 
@@ -81,6 +85,8 @@ public void SaveSettings(SourceFileFinderSettings settings) {
     // Check if the file can be found. If it's from another machine,
     // a mapping is done after the user is asked to pick the new location of the file.
     if (File.Exists(sourceInfo.FilePath)) {
+      // This assumes that a checksum match was done already
+      // and this is the right source file.
       return (sourceInfo, FailureReason.None);
     }
     else if (!IsDisabledSourceFilePath(sourceInfo.FilePath)) {

src/ProfileExplorerUI/ProfileExplorerUI.csproj

@@ -5,9 +5,9 @@
 		<TargetFramework>net8.0-windows</TargetFramework>
 		<UseWPF>true</UseWPF>
 		<ApplicationIcon>main.ico</ApplicationIcon>
-		<AssemblyVersion>1.1.3</AssemblyVersion>
-		<FileVersion>1.1.3</FileVersion>
-		<Version>1.1.3</Version>
+		<AssemblyVersion>1.1.4</AssemblyVersion>
+		<FileVersion>1.1.4</FileVersion>
+		<Version>1.1.4</Version>
 		<Authors></Authors>
 		<Company>Microsoft Corporation</Company>
 		<Product>Profile Explorer</Product>