Tell the debugger the path to the WebKit source tree when saving a crash log

This allows the debugger to include the crashing line of code in the log.

Fixes <http://webkit.org/b/53678> Crash logs from buildslaves don't show the crashing line
of code

Reviewed by Sam Weinig.

* Scripts/old-run-webkit-tests:
(createDebuggerCommandFile): Added. Saves commands that we'd like the debugger to run to a
file and returns the path to that file. The commands we pass came from
setUpWindowsCrashLogSaving, but I've added a .srcpath command to tell the debugger where the
WebKit source code lives.
(setUpWindowsCrashLogSaving): Instead of specifying the commands directly on the command
line using -c, save them to a file and specify the path to that file using -cf. This works
around what is presumably a bug in Windows's command line parsing, where having multiple
quoted paths in the debugger commands causes the post-mortem debugger not to be invoked at
all. Also pulled the options we pass to the debugger out into a list that is then join()ed
together to make them easier to modify in the future.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@77515 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/Tools/ChangeLog b/Tools/ChangeLog
index 4cce72fe293f577a502012537b3404cadc7d869b..710215243c4258bff6d6500aecc3078f62e0d87e 100644 (file)
--- a/Tools/ChangeLog
+++ b/Tools/ChangeLog
@@ -1,3 +1,26 @@
+2011-02-03  Adam Roben  <aroben@apple.com>
+
+        Tell the debugger the path to the WebKit source tree when saving a crash log
+
+        This allows the debugger to include the crashing line of code in the log.
+
+        Fixes <http://webkit.org/b/53678> Crash logs from buildslaves don't show the crashing line
+        of code
+
+        Reviewed by Sam Weinig.
+
+        * Scripts/old-run-webkit-tests:
+        (createDebuggerCommandFile): Added. Saves commands that we'd like the debugger to run to a
+        file and returns the path to that file. The commands we pass came from
+        setUpWindowsCrashLogSaving, but I've added a .srcpath command to tell the debugger where the
+        WebKit source code lives.
+        (setUpWindowsCrashLogSaving): Instead of specifying the commands directly on the command
+        line using -c, save them to a file and specify the path to that file using -cf. This works
+        around what is presumably a bug in Windows's command line parsing, where having multiple
+        quoted paths in the debugger commands causes the post-mortem debugger not to be invoked at
+        all. Also pulled the options we pass to the debugger out into a list that is then join()ed
+        together to make them easier to modify in the future.
+
 2011-02-02  Sam Weinig  <sam@webkit.org>
 
         Reviewed by Anders Carlsson.

diff --git a/Tools/Scripts/old-run-webkit-tests b/Tools/Scripts/old-run-webkit-tests
index 79e2d9e1eadd8e44f2d489c2b4ee8eb1f3fe793b..c2e0f47c7674bcc62cb0b2a68e995c95fc6ec14d 100755 (executable)
--- a/Tools/Scripts/old-run-webkit-tests
+++ b/Tools/Scripts/old-run-webkit-tests
@@ -2450,6 +2450,37 @@ sub stopRunningTestsEarlyIfNeeded()
     return 0;
 }
 
+# Store this at global scope so it won't be GCed (and thus unlinked) until the program exits.
+my $debuggerTempDirectory;
+
+sub createDebuggerCommandFile()
+{
+    return unless isCygwin();
+
+    my @commands = (
+        '.logopen /t "' . toWindowsPath($testResultsDirectory) . '\CrashLog.txt"',
+        '.srcpath "' . toWindowsPath(sourceDir()) . '"',
+        '!analyze -vv',
+        '~*kpn',
+        'q',
+    );
+
+    $debuggerTempDirectory = File::Temp->newdir;
+
+    my $commandFile = File::Spec->catfile($debuggerTempDirectory, "debugger-commands.txt");
+    unless (open COMMANDS, '>', $commandFile) {
+        print "Failed to open $commandFile. Crash logs will not be saved.\n";
+        return;
+    }
+    print COMMANDS join("\n", @commands), "\n";
+    unless (close COMMANDS) {
+        print "Failed to write to $commandFile. Crash logs will not be saved.\n";
+        return;
+    }
+
+    return $commandFile;
+}
+
 sub setUpWindowsCrashLogSaving()
 {
     return unless isCygwin();
@@ -2468,8 +2499,23 @@ sub setUpWindowsCrashLogSaving()
         }
     }
 
+    # If we used -c (instead of -cf) we could pass the commands directly on the command line. But
+    # when the commands include multiple quoted paths (e.g., for .logopen and .srcpath), Windows
+    # fails to invoke the post-mortem debugger at all (perhaps due to a bug in Windows's command
+    # line parsing). So we save the commands to a file instead and tell the debugger to execute them
+    # using -cf.
+    my $commandFile = createDebuggerCommandFile() or return;
+
+    my @options = (
+        '-p %ld',
+        '-e %ld',
+        '-g',
+        '-lines',
+        '-cf "' . toWindowsPath($commandFile) . '"',
+    );
+
     my %values = (
-        Debugger => '"' . toWindowsPath($ntsdPath) . '" -p %ld -e %ld -g -lines -c ".logopen /t \"' . toWindowsPath($testResultsDirectory) . '\CrashLog.txt\";!analyze -vv;~*kpn;q"',
+        Debugger => '"' . toWindowsPath($ntsdPath) . '" ' . join(' ', @options),
         Auto => 1
     );