Merge pull request #1408: Include panic logs for vfs in diagnose

Include panic logs for vfs in diagnose
microsoft · Aug 9, 2019 · 467fdc7 · 467fdc7
2 parents 1e9c5ec + 1313af0
commit 467fdc7
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 2 deletions.
diff --git a/GVFS/GVFS.Common/GVFSPlatform.cs b/GVFS/GVFS.Common/GVFSPlatform.cs
@@ -95,6 +95,8 @@ public static void Register(GVFSPlatform platform)
 
         public abstract void ConfigureVisualStudio(string gitBinPath, ITracer tracer);
 
+        public abstract bool TryCopyPanicLogs(string copyToDir, out string error);
+
         public abstract bool TryGetGVFSHooksVersion(out string hooksVersion, out string error);
         public abstract bool TryInstallGitCommandHooks(GVFSContext context, string executingDirectory, string hookName, string commandHookPath, out string errorMessage);
 

diff --git a/GVFS/GVFS.Platform.Mac/MacPlatform.cs b/GVFS/GVFS.Platform.Mac/MacPlatform.cs
@@ -15,6 +15,8 @@ namespace GVFS.Platform.Mac
     public partial class MacPlatform : POSIXPlatform
     {
         private const string UpgradeProtectedDataDirectory = "/usr/local/vfsforgit_upgrader";
+        private const string DiagnosticReportsDirectory = "/Library/Logs/DiagnosticReports";
+        private const string PanicFileNamePattern = "*panic";
 
         public MacPlatform() : base(
              underConstruction: new UnderConstructionFlags(
@@ -141,6 +143,48 @@ public override void IsServiceInstalledAndRunning(string name, out bool installe
             running = installed && gvfsService.IsRunning;
         }
 
+        public override bool TryCopyPanicLogs(string copyToDir, out string error)
+        {
+            error = null;
+            try
+            {
+                if (!Directory.Exists(DiagnosticReportsDirectory))
+                {
+                    return true;
+                }
+
+                string copyToPanicDir = Path.Combine(copyToDir, ProjFSKext.DriverLogDirectory, "panic_logs");
+                Directory.CreateDirectory(copyToPanicDir);
+
+                foreach (string filePath in Directory.GetFiles(DiagnosticReportsDirectory, PanicFileNamePattern))
+                {
+                    try
+                    {
+                        // We only include panic logs caused by our kext
+                        // Panics caused by our kext will be in the form DriverName(Version)
+                        // We match the minimal requirement here
+                        if (File.ReadAllText(filePath).Contains(ProjFSKext.DriverName + "("))
+                        {
+                            File.Copy(filePath, Path.Combine(copyToPanicDir, Path.GetFileName(filePath)));
+                        }
+                    }
+                    catch (Exception ex)
+                    {
+                        error = error == null ? string.Empty : error + "\n";
+                        error += $"{nameof(this.TryCopyPanicLogs)}: Failed to handle log {filePath}: {ex.ToString()}";
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                error = error == null ? string.Empty : error + "\n";
+                error += $"{nameof(this.TryCopyPanicLogs)}: Failed to copy panic logs: {ex.ToString()}";
+                return false;
+            }
+
+            return error == null;
+        }
+
         public class MacPlatformConstants : POSIXPlatformConstants
         {
             public override string InstallerExtension

diff --git a/GVFS/GVFS.Platform.Mac/ProjFSKext.cs b/GVFS/GVFS.Platform.Mac/ProjFSKext.cs
@@ -10,7 +10,9 @@ namespace GVFS.Platform.Mac
 {
     public class ProjFSKext : IKernelDriver
     {
-        private const string DriverName = "org.vfsforgit.PrjFSKext";
+        public const string DriverName = "org.vfsforgit.PrjFSKext";
+        public const string DriverLogDirectory = "PrjFSKext";
+
         private const int LoadKext_ExitCode_Success = 0;
 
         // This exit code was found in the following article
@@ -24,7 +26,7 @@ public string LogsFolderPath
         {
             get
             {
-                return Path.Combine(System.IO.Path.GetTempPath(), "PrjFSKext");
+                return Path.Combine(System.IO.Path.GetTempPath(), DriverLogDirectory);
             }
         }
 

diff --git a/GVFS/GVFS.Platform.POSIX/POSIXPlatform.cs b/GVFS/GVFS.Platform.POSIX/POSIXPlatform.cs
@@ -253,6 +253,12 @@ public override bool TryKillProcessTree(int processId, out int exitCode, out str
             return result.ExitCode == 0;
         }
 
+        public override bool TryCopyPanicLogs(string copyToDir, out string error)
+        {
+            error = null;
+            return true;
+        }
+
         [DllImport("libc", EntryPoint = "getuid", SetLastError = true)]
         private static extern uint Getuid();
 

diff --git a/GVFS/GVFS.Platform.Windows/WindowsPlatform.cs b/GVFS/GVFS.Platform.Windows/WindowsPlatform.cs
@@ -428,6 +428,12 @@ public override bool TryKillProcessTree(int processId, out int exitCode, out str
             return result.ExitCode == 0;
         }
 
+        public override bool TryCopyPanicLogs(string copyToDir, out string error)
+        {
+            error = null;
+            return true;
+        }
+
         private static object GetValueFromRegistry(RegistryHive registryHive, string key, string valueName, RegistryView view)
         {
             RegistryKey localKey = RegistryKey.OpenBaseKey(registryHive, view);

diff --git a/GVFS/GVFS.UnitTests/Mock/Common/MockPlatform.cs b/GVFS/GVFS.UnitTests/Mock/Common/MockPlatform.cs
@@ -187,6 +187,12 @@ public override bool TryKillProcessTree(int processId, out int exitCode, out str
             return true;
         }
 
+        public override bool TryCopyPanicLogs(string copyToDir, out string error)
+        {
+            error = null;
+            return true;
+        }
+
         public class MockPlatformConstants : GVFSPlatformConstants
         {
             public override string ExecutableExtension

diff --git a/GVFS/GVFS/CommandLine/DiagnoseVerb.cs b/GVFS/GVFS/CommandLine/DiagnoseVerb.cs
@@ -156,6 +156,11 @@ protected override void Execute(GVFSEnlistment enlistment)
                             this.CopyFile(GVFSPlatform.Instance.GetDataRootForGVFS(), archiveFolderPath, LocalGVFSConfig.FileName);
                         }
 
+                        if (!GVFSPlatform.Instance.TryCopyPanicLogs(archiveFolderPath, out string errorMessage))
+                        {
+                            this.WriteMessage(errorMessage);
+                        }
+
                         return true;
                     },
                     "Copying logs");