42fc1bd2e80332e26c2dd7902cf852419e0247e3
[openafs.git] / src / packaging / MacOS / decode-panic
1 #!/usr/bin/perl
2
3 # decode-panic - decode a Mac OS panic log to show source line numbers
4 # see the end of the file for full documentation and license.
5
6 use Carp;
7 use English qw( -no_match_vars ) ;
8 use File::Basename;
9 use File::Temp qw( tempdir );
10 use Getopt::Long;
11 use IO::Dir;
12 use IO::File;
13 use Pod::Usage;
14 use warnings;
15 use strict;
16
17 my $panic_file = "/Library/Logs/panic.log";
18 my %crash_info;
19 my $backtrace;
20 my $debugkit = "";
21 my $archive = "";
22 my $dmgutil = "";
23 my $kextload   = "/sbin/kextload";
24 my $kextutil   = "/usr/bin/kextutil";
25 my $kextprog;
26 my $gdb        = "/usr/bin/gdb";
27 my $gdbarch    = "";
28 my $kextarch   = "";
29 my $gdb_file   = "gdb.input";
30 my $temp_dir   = tempdir( "afsdebugXXXXXX", DIR => File::Spec->tmpdir,
31                           TMPDIR => 1, CLEANUP => 1 );
32 my $dump_file  = "/var/db/openafs/logs/crash.dump";
33 my $kernel = "/mach_kernel";
34 my $kextpath = "/Library/OpenAFS/Tools/root.client/usr/vice/etc/afs.kext/";
35
36 my $option_quiet;
37 my $option_verbose;
38 my $option_help;
39 my $result = GetOptions ("input=s"  => \$panic_file,
40                          "output=s" => \$dump_file,
41                          "kernel=s" => \$kernel,
42                          "debugkit=s" => \$debugkit,
43                          "archive=s"=> \$archive,
44                          "util=s"   => \$dmgutil,
45                          "verbose"  => \$option_verbose,
46                          "quiet"    => \$option_quiet,
47                          "help"     => \$option_help
48                      );
49
50 if ( !$result ) {
51     pod2usage(-message => "Syntax error.",
52               -exitval => 2,
53               -verbose => 1,
54               -output  => \*STDERR);
55     
56     exit;
57 }
58
59 if ($option_help) {
60     pod2usage(-message => "",
61               -exitval => 2,
62               -verbose => 3,
63               -output  => \*STDERR);
64     exit;
65 }
66
67 # check for necessary programs & panic file
68 for my $program ( $gdb, $kextload ) {
69     if ( ! -x $program ) {
70         if ( $option_quiet ) {
71             exit 1;
72         } else {
73             croak "Can't find $program!\n"
74         }
75     }
76 }
77
78 if ( -x $kextutil ) {
79     $kextprog = $kextutil;
80 } else {
81     $kextprog = $kextload;
82 }
83
84 croak "Can't find panic file: $panic_file!\n" if ( ! -r $panic_file );
85
86 read_panic( $panic_file, \%crash_info );
87
88 if ($crash_info{"kernel_version"} =~ /X86_64/ ) {
89     $gdbarch="-a x86_64";
90     $kextarch="x86_64";
91 } else {
92     if ($crash_info{"kernel_version"} =~ /I386/ ) {
93         $gdbarch="-a i386";
94         $kextarch="i386";
95     } else {
96         if ($crash_info{"kernel_version"} =~ /PPC/ ) {
97             $gdbarch="-a ppc";
98             $kextarch="ppc";
99         }
100     }
101 }
102
103 if (-d $debugkit && -f $dmgutil ) {
104     extract_kernel( $crash_info{"kernel_version"}, $temp_dir, $debugkit, $dmgutil );
105     $kernel = "$temp_dir/mach_kernel";
106 }
107
108 if (-d $archive && -f $dmgutil ) {
109     extract_openafs( $crash_info{"afs_info"}, $temp_dir, $archive, $crash_info{"kernel_version"}, $dmgutil );
110     if (-d "$temp_dir/Library/OpenAFS/Debug/afs.kext" ) {
111         $kextpath = "$temp_dir/Library/OpenAFS/Debug/afs.kext";
112     } else {
113         $kextpath = "$temp_dir/Library/OpenAFS/Tools/root.client/usr/vice/etc/afs.kext";
114     }
115 }
116
117 generate_symbol_files( $crash_info{"afs_kernel_address"}, $temp_dir, $kextarch , $kernel, $kextpath);
118
119 write_gdb_input_file( $temp_dir, $gdb_file, $crash_info{ "backtrace" } );
120
121 if ($option_verbose) {
122     print "$gdb $gdbarch $kernel -batch -x $temp_dir/$gdb_file\n";
123 }
124 my $gdb_output = `$gdb $gdbarch $kernel -batch -x $temp_dir/$gdb_file`;
125 croak "gdb failed!\n" if $CHILD_ERROR;
126
127 write_dump_file( $dump_file, \%crash_info, $gdb_output );
128
129 sub extract_openafs {
130     my $oversion = shift;
131     my $tempdir = shift;
132     my $oarchive = shift;
133     my $kversion = shift;
134     my $hdutil = shift;
135
136     $kversion =~ /Darwin Kernel Version ([0-9]+).[0-9]+.[0-9]+:/;
137     my $major = $1;
138     $major -= 4;
139
140     $oversion =~ /org.openafs.filesystems.afs\(([0-9.]+)\)/;
141     my $vers = $1;
142     my $odmg = "$oarchive/$vers/macos-10.${major}/OpenAFS-$vers-\*.dmg";
143     if ($option_verbose) {
144         print "$hdutil $odmg extractall OpenAFS.pkg $tempdir/OpenAFS.pkg\n"; 
145     }
146     `$hdutil $odmg extractall OpenAFS.pkg $tempdir/OpenAFS.pkg`;
147     if ($option_verbose) {
148         print "cd $tempdir && gzcat $tempdir/OpenAFS.pkg/Contents/Archive.pax.gz | pax -r ./Library/OpenAFS/Tools/root.client/usr/vice/etc/afs.kext\n";
149     }
150     `cd $tempdir && gzcat $tempdir/OpenAFS.pkg/Contents/Archive.pax.gz | pax -r ./Library/OpenAFS/Tools/root.client/usr/vice/etc/afs.kext`;
151     if ($option_verbose) {
152         print "$hdutil $odmg extractall OpenAFS-debug-extension.pkg $tempdir/OpenAFS-debug-extension.pkg\n";
153     }
154     `$hdutil $odmg extractall OpenAFS-debug-extension.pkg $tempdir/OpenAFS-debug-extension.pkg`;
155     if (-f "$tempdir/OpenAFS-debug-extension.pkg/Contents/Archive.pax.gz" ) {
156         if ($option_verbose) {
157             print "cd $tempdir && gzcat $tempdir/OpenAFS-debug-extension.pkg/Contents/Archive.pax.gz | pax -r ./Library/OpenAFS/Debug/afs.kext.dSYM\n";
158         }
159         `cd $tempdir && gzcat $tempdir/OpenAFS-debug-extension.pkg/Contents/Archive.pax.gz | pax -r ./Library/OpenAFS/Debug/afs.kext.dSYM`;
160         if ($option_verbose) {
161             print "cd $tempdir && gzcat $tempdir/OpenAFS-debug-extension.pkg/Contents/Archive.pax.gz | pax -r ./Library/OpenAFS/Debug/afs.kext\n";
162         }
163         `cd $tempdir && gzcat $tempdir/OpenAFS-debug-extension.pkg/Contents/Archive.pax.gz | pax -r ./Library/OpenAFS/Debug/afs.kext`;
164     }
165 }
166
167 sub extract_kernel {
168     my $kversion = shift;
169     my $tempdir = shift;
170     my $debugarchive = shift;
171     my $hdutil = shift;
172     
173     $kversion =~ /Darwin Kernel Version ([0-9]+).([0-9]+).[0-9]+:/;
174     my $minor = $2;
175     my $major = $1;
176     $major -= 4;
177     my $kdk = "$debugarchive/kernel_debug_kit_10.${major}.${minor}_\*.dmg";
178     if ($option_verbose) {
179         print "$hdutil $kdk extractall System.kext $tempdir/System.kext\n";
180     }
181     `$hdutil $kdk extractall System.kext $tempdir/System.kext`;
182     if ($option_verbose) {
183         print "$hdutil $kdk extractall mach_kernel.dSYM $tempdir/mach_kernel.dSYM\n";
184     }
185     `$hdutil $kdk extractall mach_kernel.dSYM $tempdir/mach_kernel.dSYM`;
186     if ($option_verbose) {
187         print "$hdutil $kdk extract mach_kernel $tempdir/mach_kernel\n";
188     }
189     `$hdutil $kdk extract mach_kernel $tempdir/mach_kernel`;
190 }
191
192
193 # read the panic file and parse out the addresses
194 sub read_panic {
195
196     my $filename      = shift;
197     my $hash_ref      = shift;
198
199     my $kernel_line;
200     my $line;
201     my @panic_section_positions = ( 0 );
202
203     
204     my $panic_fh = IO::File->new( $filename, '<' )
205         or croak "Can't open backtrace file $filename: $OS_ERROR\n";
206
207     # find the last panic section as denoted by "*********"
208     while ( $line = <$panic_fh> ) {
209         chomp $line;
210         if ( $line eq "*********" ) {
211             # skip a line
212             $line = <$panic_fh>;
213             push @panic_section_positions, $panic_fh->tell;
214         }
215     }
216
217     # ignore the empty last section
218     if ( @panic_section_positions > 2 ) {
219         pop @panic_section_positions
220     }
221
222     # Seek to last full panic section
223     # or the beginning of the file if appropriate
224     $panic_fh->seek( $panic_section_positions[-1], 0 );
225
226     $hash_ref->{ "date" } = <$panic_fh>;
227     chomp $hash_ref->{ "date" };
228
229     while ( $line = <$panic_fh> ) {
230         chomp $line;
231     
232         #skip lines until "Backtrace" is seen
233         $line =~ /^\s*(Backtrace,|Backtrace:|Backtrace \()/;
234         $backtrace = $1;
235         last if $backtrace;
236     }
237     
238     if ( !$backtrace ) {
239         if ( $option_quiet ) {
240             exit 1;
241         } else {
242             croak "Couldn't find a backtrace in $filename\n";
243         }
244     }
245     
246     # gather the backtrace addresses
247     if ( $backtrace eq "Backtrace:" ) {
248         # ppc format panic
249         while ( $line = <$panic_fh> ) {
250             chomp $line;
251             last if $line !~ /^\s*(0x[0-9a-fA-F]+)/;
252             my @memory_addresses = split /\s+/, $line;
253
254             # add non-empty array elements to the list
255             push @{ $hash_ref->{ "backtrace" } },
256                 grep { /0x/ } @memory_addresses;
257         }
258     } else {
259         # intel format panic
260         while ( $line = <$panic_fh> ) {
261             chomp $line;
262             last if $line !~ /^\s*0x[0-9a-fA-F]+ : (0x[0-9a-fA-F]*)/;
263             push @{ $hash_ref->{ "backtrace" } }, $1;
264         }
265     }
266
267     # now we need the address for the afs kernel module
268     while ( $line = <$panic_fh> ) {
269         chomp $line;
270         next if ( $line !~ /org\.openafs\.filesystems\.afs/ );
271
272         $kernel_line = $line;
273         $line =~ /\@(0x[0-9a-fA-F]+)/;
274         $hash_ref->{ "afs_kernel_address" } = $1;
275         $kernel_line =~ /^\s+([^@]+)@.+/;
276         $hash_ref->{ "afs_info" } = $1;
277
278         last;
279     }
280
281     # grab the kernel version
282     while ( $line = <$panic_fh> ) {
283         chomp $line;
284         next if ( $line !~ /^Darwin Kernel Version/ );
285         $hash_ref->{ "kernel_version" } = $line;
286     }
287     
288     $panic_fh->close()
289         or croak "Can't close file $filename: $OS_ERROR\n";
290     
291     if ( !$kernel_line ) {
292         if ( $option_quiet ) {
293             exit 1;
294         } else {
295             croak "No OpenAFS reference found in latest panic!";
296         }
297     }
298 }
299
300 # generate the symbol files that will be read by gdb
301 sub generate_symbol_files {
302     my $kernel_address   = shift;
303     my $symbol_write_dir = shift;
304     my $kextarch = shift;
305     my $kernel = shift;
306     my $kext = shift;
307
308     if ($kextprog eq $kextload) {
309         if ($kernel eq "/mach_kernel") {
310             if ($option_verbose) {
311                 print "$kextprog -k $kernel -s $temp_dir -a org.openafs.filesystems.afs\@${kernel_address} -n $kext\n";
312             }
313             system( $kextprog,
314                     "-k", $kernel,
315                     "-s", $temp_dir,
316                     "-a", 'org.openafs.filesystems.afs@' . $kernel_address,
317                     "-n", $kext );
318         } else {
319             if ($option_verbose) {
320                 print "$kextprog -c -e -r $temp_dir -k $kernel -s $temp_dir -a org.openafs.filesystems.afs\@${kernel_address} -n $kext\n";
321             }
322             system( $kextprog,
323                     "-c", "-e",
324                     "-r", $temp_dir,
325                     "-k", $kernel,
326                     "-s", $temp_dir,
327                     "-a", 'org.openafs.filesystems.afs@' . $kernel_address,
328                     "-n", $kext );
329         }
330     } else {
331         if ($kernel eq "/mach_kernel") {
332             if ($option_verbose) {
333                 print "$kextprog -k $kernel -s $temp_dir -arch $kextarch -a org.openafs.filesystems.afs\@${kernel_address} -n $kext\n";
334             }
335             system( $kextprog,
336                     "-k", $kernel,
337                     "-s", $temp_dir,
338                     "-arch", $kextarch,
339                     "-a", 'org.openafs.filesystems.afs@' . $kernel_address,
340                     "-n", $kext );
341         } else {
342             if ($option_verbose) {
343                 print "$kextprog -c -e -r $temp_dir -k $kernel -s $temp_dir -arch $kextarch -a org.openafs.filesystems.afs\@${kernel_address} -n $kext\n";
344             }
345             system( $kextprog,
346                     "-c", "-e",
347                     "-r", $temp_dir,
348                     "-k", $kernel,
349                     "-s", $temp_dir,
350                     "-arch", $kextarch,
351                     "-a", 'org.openafs.filesystems.afs@' . $kernel_address,
352                     "-n", $kext );
353         }
354     }    
355     if ( $CHILD_ERROR ) {
356         # error
357         croak "kextload failed to run: $OS_ERROR\n";
358     }
359 }
360
361
362 sub write_gdb_input_file {
363
364     my $write_dir     = shift;
365     my $filename      = shift;
366     my $backtrace_ref = shift;
367     
368     my @symbol_files = ( $write_dir . "/org.openafs.filesystems.afs.sym" );
369         
370     my $fh = IO::File->new( $write_dir . "/" . $filename, '>' )
371         or croak "Can't open gdb file $filename for writing: $OS_ERROR\n";
372
373     for my $symbol ( @symbol_files ) {
374         print $fh "add-symbol-file $symbol\n";
375     }
376     
377     print $fh "set print asm-demangle on\n";
378
379     for my $address ( @{ $backtrace_ref } ) {
380         print $fh "x/i $address\n";
381     }
382
383    $fh->close()
384         or croak "Can't close file $filename: $OS_ERROR\n";
385 }
386
387 # write out the pertinent details to a file.
388 sub write_dump_file {
389     my $filename = shift;
390     my $hash_ref = shift;
391     my $output   = shift;
392
393     my $log_dir  = dirname $filename;
394
395     if ( ! -d $log_dir ) {
396         mkdir $log_dir, 0755;
397         croak "Can't create directory $log_dir: $OS_ERROR\n" if $CHILD_ERROR;
398     }
399
400     croak "Can't write to folder $log_dir." if ( ! -w $log_dir );
401
402     my $fh = IO::File->new( $filename, '>', 0664 )
403         or croak "Can't open dump file $filename for writing: $OS_ERROR\n";
404     
405     print $fh "Panic Date:      ", $hash_ref->{ "date" }, "\n";
406     print $fh "Kernel Version:  ", $hash_ref->{ "kernel_version" }, "\n";
407     print $fh "OpenAFS Version: ", $hash_ref->{ "afs_info" }, "\n";
408     print $fh "=============\n";
409     print $fh $output;
410     
411     $fh->close()
412         or croak "Can't close file $filename: $OS_ERROR\n";
413 }
414
415 __END__
416
417 =head1 NAME
418
419 decode-panic - decode a Mac OS panic log to show source line numbers
420
421 =head1 VERSION
422
423 This documentation refers to decode-panic version $Revision$
424
425 =head1 SYNOPSIS
426  
427    decode-panic [-i <input panic log>] [-o <output dump file>] [-k <kernel file>] [-d <kernel debug kit archive>] [-a <openafs package archive>] [-u <path to hdutil>] [-q] [-v]
428
429 =head1 OPTIONS
430
431    -i The path to the panic log that should be read
432    -o The path to where the decoded panic log should be written
433    -k The path to the kernel image corresponding to the panic
434    -d The path to a directory containing kernel debug kit dmgs
435    -a The path to an archive of OpenAFS installer dmgs
436    -u The path to the hdutil dmg utility program
437    -q Quiet mode - don't complain if there is a problem.
438    -v Verbose mode - print all commands.
439    -h print full help
440
441 =head1 DESCRIPTION
442
443 This tool parses the panic log for Mac OS X kernel panics that are caused by
444 openafs in order to produce a human-readable backtrace.
445
446 This program uses crash isolation procedure as outlined in
447 http://developer.apple.com/technotes/tn2002/tn2063.html#IsolatingCrash
448
449 Here is an example file that is fed to gdb:
450
451    add-symbol-file /tmp/afsdebugt8dGOb/org.openafs.filesystems.afs.sym
452    set print asm-demangle on
453    x/i 0x2ED1F7C0
454    x/i 0x2ED0D1A4
455
456 Panic logs can be found in /Library/Logs/panic.log in 10.4 (Tiger), 
457 /Library/Logs/PanicReporter/YYYY-MM-DD-HHMMSS.panic in 10.5 (Leopard),
458 and /Library/Logs/DiagnosticReports/Kernel_YYYY-MM-DD-HHMMSS.panic in 10.6
459 (SnowLeopard).
460
461 =head1 DEPENDENCIES
462
463 This program needs gdb and kextload; Starting in SnowLeopard, it needs kextutil.
464
465 Batch decoding requires a directory of Kernel Debug Kit DMGs, a directory of
466 OpenAFS installer DMGs, and the DMG extraction utility currently available
467 in source form at http://www.dementia.org/~shadow/dmgutil-0.1.tar.gz
468
469 =head1 BUGS AND LIMITATIONS
470
471 decode-panic clobbers the output file.
472
473 =head1 AUTHOR
474
475 Copyright 2008-2010. Jason Edgecombe <jason@rampaginggeek.com> and others.
476
477 This documentation is covered by the BSD License as written in the
478 doc/LICENSE file in the OpenAFS source tree. This program was originally
479 written by Jason Edgecombe for OpenAFS.