ccc-analyzer revision 1e548f12f7cd6631a3e688a9580ede92898d9e69 
1#!/usr/bin/env perl
2#
3#                     The LLVM Compiler Infrastructure
4#
5# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
7#
8##===----------------------------------------------------------------------===##
9#
10#  A script designed to interpose between the build system and gcc.  It invokes
11#  both gcc and the static analyzer.
12#
13##===----------------------------------------------------------------------===##
14
15use strict;
16use warnings;
17use FindBin;
18use Cwd qw/ getcwd abs_path /;
19use File::Temp qw/ tempfile /;
20use File::Path qw / mkpath /;
21use File::Basename;
22use Text::ParseWords;
23
24##===----------------------------------------------------------------------===##
25# Compiler command setup.
26##===----------------------------------------------------------------------===##
27
28my $Compiler;
29my $Clang;
30my $DefaultCCompiler;
31my $DefaultCXXCompiler;
32
33if (`uname -a` =~ m/Darwin/) { 
34	$DefaultCCompiler = 'clang';
35	$DefaultCXXCompiler = 'clang++'; 
36} else {
37    $DefaultCCompiler = 'gcc';
38    $DefaultCXXCompiler = 'g++'; 	
39}
40
41if ($FindBin::Script =~ /c\+\+-analyzer/) {
42  $Compiler = $ENV{'CCC_CXX'};
43  if (!defined $Compiler) { $Compiler = $DefaultCXXCompiler; }
44  
45  $Clang = $ENV{'CLANG_CXX'};
46  if (!defined $Clang) { $Clang = 'clang++'; }
47}
48else {
49  $Compiler = $ENV{'CCC_CC'};
50  if (!defined $Compiler) { $Compiler = $DefaultCCompiler; }
51
52  $Clang = $ENV{'CLANG'};
53  if (!defined $Clang) { $Clang = 'clang'; }
54}
55
56##===----------------------------------------------------------------------===##
57# Cleanup.
58##===----------------------------------------------------------------------===##
59
60my $ReportFailures = $ENV{'CCC_REPORT_FAILURES'};
61if (!defined $ReportFailures) { $ReportFailures = 1; }
62
63my $CleanupFile;
64my $ResultFile;
65
66# Remove any stale files at exit.
67END { 
68  if (defined $ResultFile && -z $ResultFile) {
69    `rm -f $ResultFile`;
70  }
71  if (defined $CleanupFile) {
72    `rm -f $CleanupFile`;
73  }
74}
75
76##----------------------------------------------------------------------------##
77#  Process Clang Crashes.
78##----------------------------------------------------------------------------##
79
80sub GetPPExt {
81  my $Lang = shift;
82  if ($Lang =~ /objective-c\+\+/) { return ".mii" };
83  if ($Lang =~ /objective-c/) { return ".mi"; }
84  if ($Lang =~ /c\+\+/) { return ".ii"; }
85  return ".i";
86}
87
88# Set this to 1 if we want to include 'parser rejects' files.
89my $IncludeParserRejects = 0;
90my $ParserRejects = "Parser Rejects";
91my $AttributeIgnored = "Attribute Ignored";
92my $OtherError = "Other Error";
93
94sub ProcessClangFailure {
95  my ($Clang, $Lang, $file, $Args, $HtmlDir, $ErrorType, $ofile) = @_;
96  my $Dir = "$HtmlDir/failures";
97  mkpath $Dir;
98  
99  my $prefix = "clang_crash";
100  if ($ErrorType eq $ParserRejects) {
101    $prefix = "clang_parser_rejects";
102  }
103  elsif ($ErrorType eq $AttributeIgnored) {
104    $prefix = "clang_attribute_ignored";
105  }
106  elsif ($ErrorType eq $OtherError) {
107    $prefix = "clang_other_error";
108  }
109
110  # Generate the preprocessed file with Clang.
111  my ($PPH, $PPFile) = tempfile( $prefix . "_XXXXXX",
112                                 SUFFIX => GetPPExt($Lang),
113                                 DIR => $Dir);
114  system $Clang, @$Args, "-E", "-o", $PPFile;
115  close ($PPH);
116  
117  # Create the info file.
118  open (OUT, ">", "$PPFile.info.txt") or die "Cannot open $PPFile.info.txt\n";
119  print OUT abs_path($file), "\n";
120  print OUT "$ErrorType\n";
121  print OUT "@$Args\n";
122  close OUT;
123  `uname -a >> $PPFile.info.txt 2>&1`;
124  `$Compiler -v >> $PPFile.info.txt 2>&1`;
125  system 'mv',$ofile,"$PPFile.stderr.txt";
126  return (basename $PPFile);
127}
128
129##----------------------------------------------------------------------------##
130#  Running the analyzer.
131##----------------------------------------------------------------------------##
132
133sub GetCCArgs {
134  my $mode = shift;
135  my $Args = shift;
136  
137  pipe (FROM_CHILD, TO_PARENT);
138  my $pid = fork();
139  if ($pid == 0) {
140    close FROM_CHILD;
141    open(STDOUT,">&", \*TO_PARENT);
142    open(STDERR,">&", \*TO_PARENT);
143    exec $Clang, "-###", $mode, @$Args;
144  }  
145  close(TO_PARENT);
146  my $line;
147  while (<FROM_CHILD>) {
148    next if (!/-cc1/);
149    $line = $_;
150  }
151
152  waitpid($pid,0);
153  close(FROM_CHILD);
154  
155  die "could not find clang line\n" if (!defined $line);
156  # Strip the newline and initial whitspace
157  chomp $line;
158  $line =~ s/^\s+//;
159  my @items = quotewords('\s+', 0, $line);
160  my $cmd = shift @items;
161  die "cannot find 'clang' in 'clang' command\n" if (!($cmd =~ /clang/));
162  return \@items;
163}
164
165sub Analyze {
166  my ($Clang, $OriginalArgs, $AnalyzeArgs, $Lang, $Output, $Verbose, $HtmlDir,
167      $file) = @_;
168
169  my @Args = @$OriginalArgs;
170  my $Cmd;
171  my @CmdArgs;
172  my @CmdArgsSansAnalyses;
173
174  if ($Lang =~ /header/) {
175    exit 0 if (!defined ($Output));
176    $Cmd = 'cp';
177    push @CmdArgs, $file;
178    # Remove the PCH extension.
179    $Output =~ s/[.]gch$//;
180    push @CmdArgs, $Output;
181    @CmdArgsSansAnalyses = @CmdArgs;
182  }
183  else {
184    $Cmd = $Clang;
185
186    # Create arguments for doing regular parsing.
187    my $SyntaxArgs = GetCCArgs("-fsyntax-only", \@Args);
188    @CmdArgsSansAnalyses = @$SyntaxArgs;
189
190    # Create arguments for doing static analysis.
191    if (defined $ResultFile) {
192      push @Args, '-o', $ResultFile;
193    }
194    elsif (defined $HtmlDir) {
195      push @Args, '-o', $HtmlDir;
196    }
197    if ($Verbose) {
198      push @Args, "-Xclang", "-analyzer-display-progress";
199    }
200
201    foreach my $arg (@$AnalyzeArgs) {
202      push @Args, "-Xclang", $arg;
203    }
204
205    # Display Ubiviz graph?
206    if (defined $ENV{'CCC_UBI'}) {   
207      push @Args, "-Xclang", "-analyzer-viz-egraph-ubigraph";
208    }
209
210    my $AnalysisArgs = GetCCArgs("--analyze", \@Args);
211    @CmdArgs = @$AnalysisArgs;
212  }
213
214  my @PrintArgs;
215  my $dir;
216
217  if ($Verbose) {
218    $dir = getcwd();
219    print STDERR "\n[LOCATION]: $dir\n";
220    push @PrintArgs,"'$Cmd'";
221    foreach my $arg (@CmdArgs) {
222        push @PrintArgs,"\'$arg\'";
223    }
224  }
225  if ($Verbose == 1) {
226    # We MUST print to stderr.  Some clients use the stdout output of
227    # gcc for various purposes. 
228    print STDERR join(' ', @PrintArgs);
229    print STDERR "\n";
230  }
231  elsif ($Verbose == 2) {
232    print STDERR "#SHELL (cd '$dir' && @PrintArgs)\n";
233  }
234
235  # Capture the STDERR of clang and send it to a temporary file.
236  # Capture the STDOUT of clang and reroute it to ccc-analyzer's STDERR.
237  # We save the output file in the 'crashes' directory if clang encounters
238  # any problems with the file.  
239  pipe (FROM_CHILD, TO_PARENT);
240  my $pid = fork();
241  if ($pid == 0) {
242    close FROM_CHILD;
243    open(STDOUT,">&", \*TO_PARENT);
244    open(STDERR,">&", \*TO_PARENT);
245    exec $Cmd, @CmdArgs;
246  }
247
248  close TO_PARENT;
249  my ($ofh, $ofile) = tempfile("clang_output_XXXXXX", DIR => $HtmlDir);
250  
251  while (<FROM_CHILD>) {
252    print $ofh $_;
253    print STDERR $_;
254  }
255
256  waitpid($pid,0);
257  close(FROM_CHILD);
258  my $Result = $?;
259
260  # Did the command die because of a signal?
261  if ($ReportFailures) {
262    if ($Result & 127 and $Cmd eq $Clang and defined $HtmlDir) {
263      ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses,
264                          $HtmlDir, "Crash", $ofile);
265    }
266    elsif ($Result) {
267      if ($IncludeParserRejects && !($file =~/conftest/)) {
268        ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses,
269                            $HtmlDir, $ParserRejects, $ofile);
270      } else {
271        ProcessClangFailure($Clang, $Lang, $file, \@CmdArgsSansAnalyses,
272                            $HtmlDir, $OtherError, $ofile);      	
273      }
274    }
275    else {
276      # Check if there were any unhandled attributes.
277      if (open(CHILD, $ofile)) {
278        my %attributes_not_handled;
279
280        # Don't flag warnings about the following attributes that we
281        # know are currently not supported by Clang.
282        $attributes_not_handled{"cdecl"} = 1;
283
284        my $ppfile;
285        while (<CHILD>) {
286          next if (! /warning: '([^\']+)' attribute ignored/);
287
288          # Have we already spotted this unhandled attribute?
289          next if (defined $attributes_not_handled{$1});
290          $attributes_not_handled{$1} = 1;
291        
292          # Get the name of the attribute file.
293          my $dir = "$HtmlDir/failures";
294          my $afile = "$dir/attribute_ignored_$1.txt";
295        
296          # Only create another preprocessed file if the attribute file
297          # doesn't exist yet.
298          next if (-e $afile);
299        
300          # Add this file to the list of files that contained this attribute.
301          # Generate a preprocessed file if we haven't already.
302          if (!(defined $ppfile)) {
303            $ppfile = ProcessClangFailure($Clang, $Lang, $file,
304                                          \@CmdArgsSansAnalyses,
305                                          $HtmlDir, $AttributeIgnored, $ofile);
306          }
307
308          mkpath $dir;
309          open(AFILE, ">$afile");
310          print AFILE "$ppfile\n";
311          close(AFILE);
312        }
313        close CHILD;
314      }
315    }
316  }
317  
318  unlink($ofile);
319}
320
321##----------------------------------------------------------------------------##
322#  Lookup tables.
323##----------------------------------------------------------------------------##
324
325my %CompileOptionMap = (
326  '-nostdinc' => 0,
327  '-fblocks' => 0,
328  '-fno-builtin' => 0,
329  '-fobjc-gc-only' => 0,
330  '-fobjc-gc' => 0,
331  '-ffreestanding' => 0,
332  '-include' => 1,
333  '-idirafter' => 1,
334  '-imacros' => 1,
335  '-iprefix' => 1,
336  '-iquote' => 1,
337  '-isystem' => 1,
338  '-iwithprefix' => 1,
339  '-iwithprefixbefore' => 1
340);
341
342my %LinkerOptionMap = (
343  '-framework' => 1,
344  '-fobjc-link-runtime' => 0
345);
346
347my %CompilerLinkerOptionMap = (
348  '-fobjc-arc' => 0,
349  '-fobjc-abi-version' => 0, # This is really a 1 argument, but always has '='
350  '-isysroot' => 1,
351  '-arch' => 1,
352  '-m32' => 0,
353  '-m64' => 0,
354  '-v' => 0,
355  '-fpascal-strings' => 0,
356  '-mmacosx-version-min' => 0, # This is really a 1 argument, but always has '='
357  '-miphoneos-version-min' => 0 # This is really a 1 argument, but always has '='
358);
359
360my %IgnoredOptionMap = (
361  '-MT' => 1,  # Ignore these preprocessor options.
362  '-MF' => 1,
363
364  '-fsyntax-only' => 0,
365  '-save-temps' => 0,
366  '-install_name' => 1,
367  '-exported_symbols_list' => 1,
368  '-current_version' => 1,
369  '-compatibility_version' => 1,
370  '-init' => 1,
371  '-e' => 1,
372  '-seg1addr' => 1,
373  '-bundle_loader' => 1,
374  '-multiply_defined' => 1,
375  '-sectorder' => 3,
376  '--param' => 1,
377  '-u' => 1,
378  '--serialize-diagnostics' => 1
379);
380
381my %LangMap = (
382  'c'   => 'c',
383  'cp'  => 'c++',
384  'cpp' => 'c++',
385  'cxx' => 'c++',
386  'txx' => 'c++',
387  'cc'  => 'c++',
388  'ii'  => 'c++',
389  'i'   => 'c-cpp-output',
390  'm'   => 'objective-c',
391  'mi'  => 'objective-c-cpp-output',
392  'mm'  => 'objective-c++'
393);
394
395my %UniqueOptions = (
396  '-isysroot' => 0  
397);
398
399##----------------------------------------------------------------------------##
400# Languages accepted.
401##----------------------------------------------------------------------------##
402
403my %LangsAccepted = (
404  "objective-c" => 1,
405  "c" => 1,
406  "c++" => 1,
407  "objective-c++" => 1
408);
409
410##----------------------------------------------------------------------------##
411#  Main Logic.
412##----------------------------------------------------------------------------##
413
414my $Action = 'link';
415my @CompileOpts;
416my @LinkOpts;
417my @Files;
418my $Lang;
419my $Output;
420my %Uniqued;
421
422# Forward arguments to gcc.
423my $Status = system($Compiler,@ARGV);
424if  (defined $ENV{'CCC_ANALYZER_LOG'}) {
425  print "$Compiler @ARGV\n";
426}
427if ($Status) { exit($Status >> 8); }
428
429# Get the analysis options.
430my $Analyses = $ENV{'CCC_ANALYZER_ANALYSIS'};
431
432# Get the plugins to load.
433my $Plugins = $ENV{'CCC_ANALYZER_PLUGINS'};
434
435# Get the store model.
436my $StoreModel = $ENV{'CCC_ANALYZER_STORE_MODEL'};
437
438# Get the constraints engine.
439my $ConstraintsModel = $ENV{'CCC_ANALYZER_CONSTRAINTS_MODEL'};
440
441#Get the internal stats setting.
442my $InternalStats = $ENV{'CCC_ANALYZER_INTERNAL_STATS'};
443
444# Get the output format.
445my $OutputFormat = $ENV{'CCC_ANALYZER_OUTPUT_FORMAT'};
446if (!defined $OutputFormat) { $OutputFormat = "html"; }
447
448# Determine the level of verbosity.
449my $Verbose = 0;
450if (defined $ENV{CCC_ANALYZER_VERBOSE}) { $Verbose = 1; }
451if (defined $ENV{CCC_ANALYZER_LOG}) { $Verbose = 2; }
452
453# Get the HTML output directory.
454my $HtmlDir = $ENV{'CCC_ANALYZER_HTML'};
455
456my %DisabledArchs = ('ppc' => 1, 'ppc64' => 1);
457my %ArchsSeen;
458my $HadArch = 0;
459
460# Process the arguments.
461foreach (my $i = 0; $i < scalar(@ARGV); ++$i) {
462  my $Arg = $ARGV[$i];  
463  my ($ArgKey) = split /=/,$Arg,2;
464
465  # Modes ccc-analyzer supports
466  if ($Arg =~ /^-(E|MM?)$/) { $Action = 'preprocess'; }
467  elsif ($Arg eq '-c') { $Action = 'compile'; }
468  elsif ($Arg =~ /^-print-prog-name/) { exit 0; }
469
470  # Specially handle duplicate cases of -arch
471  if ($Arg eq "-arch") {
472    my $arch = $ARGV[$i+1];
473    # We don't want to process 'ppc' because of Clang's lack of support
474    # for Altivec (also some #defines won't likely be defined correctly, etc.)
475    if (!(defined $DisabledArchs{$arch})) { $ArchsSeen{$arch} = 1; }
476    $HadArch = 1;
477    ++$i;
478    next;
479  }
480
481  # Options with possible arguments that should pass through to compiler.
482  if (defined $CompileOptionMap{$ArgKey}) {
483    my $Cnt = $CompileOptionMap{$ArgKey};
484    push @CompileOpts,$Arg;
485    while ($Cnt > 0) { ++$i; --$Cnt; push @CompileOpts, $ARGV[$i]; }
486    next;
487  }
488
489  # Options with possible arguments that should pass through to linker.
490  if (defined $LinkerOptionMap{$ArgKey}) {
491    my $Cnt = $LinkerOptionMap{$ArgKey};
492    push @LinkOpts,$Arg;
493    while ($Cnt > 0) { ++$i; --$Cnt; push @LinkOpts, $ARGV[$i]; }
494    next;
495  }
496
497  # Options with possible arguments that should pass through to both compiler
498  # and the linker.
499  if (defined $CompilerLinkerOptionMap{$ArgKey}) {
500    my $Cnt = $CompilerLinkerOptionMap{$ArgKey};
501    
502    # Check if this is an option that should have a unique value, and if so
503    # determine if the value was checked before.
504    if ($UniqueOptions{$Arg}) {
505      if (defined $Uniqued{$Arg}) {
506        $i += $Cnt;
507        next;
508      }
509      $Uniqued{$Arg} = 1;
510    }
511    
512    push @CompileOpts,$Arg;    
513    push @LinkOpts,$Arg;
514
515    while ($Cnt > 0) {
516      ++$i; --$Cnt;
517      push @CompileOpts, $ARGV[$i];
518      push @LinkOpts, $ARGV[$i];
519    }
520    next;
521  }
522  
523  # Ignored options.
524  if (defined $IgnoredOptionMap{$ArgKey}) {
525    my $Cnt = $IgnoredOptionMap{$ArgKey};
526    while ($Cnt > 0) {
527      ++$i; --$Cnt;
528    }
529    next;
530  }
531  
532  # Compile mode flags.
533  if ($Arg =~ /^-[D,I,U](.*)$/) {
534    my $Tmp = $Arg;    
535    if ($1 eq '') {
536      # FIXME: Check if we are going off the end.
537      ++$i;
538      $Tmp = $Arg . $ARGV[$i];
539    }
540    push @CompileOpts,$Tmp;
541    next;
542  }
543  
544  # Language.
545  if ($Arg eq '-x') {
546    $Lang = $ARGV[$i+1];
547    ++$i; next;
548  }
549
550  # Output file.
551  if ($Arg eq '-o') {
552    ++$i;
553    $Output = $ARGV[$i];
554    next;
555  }
556  
557  # Get the link mode.
558  if ($Arg =~ /^-[l,L,O]/) {
559    if ($Arg eq '-O') { push @LinkOpts,'-O1'; }
560    elsif ($Arg eq '-Os') { push @LinkOpts,'-O2'; }
561    else { push @LinkOpts,$Arg; }
562    next;
563  }
564  
565  if ($Arg =~ /^-std=/) {
566    push @CompileOpts,$Arg;
567    next;
568  }
569  
570#  if ($Arg =~ /^-f/) {
571#    # FIXME: Not sure if the remaining -fxxxx options have no arguments.
572#    push @CompileOpts,$Arg;
573#    push @LinkOpts,$Arg;  # FIXME: Not sure if these are link opts.
574#  }
575  
576  # Get the compiler/link mode.
577  if ($Arg =~ /^-F(.+)$/) {
578    my $Tmp = $Arg;
579    if ($1 eq '') {
580      # FIXME: Check if we are going off the end.
581      ++$i;
582      $Tmp = $Arg . $ARGV[$i];
583    }
584    push @CompileOpts,$Tmp;
585    push @LinkOpts,$Tmp;
586    next;
587  }
588
589  # Input files.
590  if ($Arg eq '-filelist') {
591    # FIXME: Make sure we aren't walking off the end.
592    open(IN, $ARGV[$i+1]);
593    while (<IN>) { s/\015?\012//; push @Files,$_; }
594    close(IN);
595    ++$i;
596    next;
597  }
598  
599  # Handle -Wno-.  We don't care about extra warnings, but
600  # we should suppress ones that we don't want to see.
601  if ($Arg =~ /^-Wno-/) {
602    push @CompileOpts, $Arg;
603    next;
604  }
605
606  if (!($Arg =~ /^-/)) {
607    push @Files, $Arg;
608    next;
609  }
610}
611
612if ($Action eq 'compile' or $Action eq 'link') {
613  my @Archs = keys %ArchsSeen;
614  # Skip the file if we don't support the architectures specified.
615  exit 0 if ($HadArch && scalar(@Archs) == 0);
616  
617  foreach my $file (@Files) {
618    # Determine the language for the file.
619    my $FileLang = $Lang;
620
621    if (!defined($FileLang)) {
622      # Infer the language from the extension.
623      if ($file =~ /[.]([^.]+)$/) {
624        $FileLang = $LangMap{$1};
625      }
626    }
627    
628    # FileLang still not defined?  Skip the file.
629    next if (!defined $FileLang);
630
631    # Language not accepted?
632    next if (!defined $LangsAccepted{$FileLang});
633
634    my @CmdArgs;
635    my @AnalyzeArgs;    
636    
637    if ($FileLang ne 'unknown') {
638      push @CmdArgs, '-x', $FileLang;
639    }
640
641    if (defined $StoreModel) {
642      push @AnalyzeArgs, "-analyzer-store=$StoreModel";
643    }
644
645    if (defined $ConstraintsModel) {
646      push @AnalyzeArgs, "-analyzer-constraints=$ConstraintsModel";
647    }
648
649    if (defined $InternalStats) {
650      push @AnalyzeArgs, "-analyzer-stats";
651    }
652    
653    if (defined $Analyses) {
654      push @AnalyzeArgs, split '\s+', $Analyses;
655    }
656
657    if (defined $Plugins) {
658      push @AnalyzeArgs, split '\s+', $Plugins;
659    }
660
661    if (defined $OutputFormat) {
662      push @AnalyzeArgs, "-analyzer-output=" . $OutputFormat;
663      if ($OutputFormat =~ /plist/) {
664        # Change "Output" to be a file.
665        my ($h, $f) = tempfile("report-XXXXXX", SUFFIX => ".plist",
666                               DIR => $HtmlDir);
667        $ResultFile = $f;
668        # If the HtmlDir is not set, we sould clean up the plist files.
669        if (!defined $HtmlDir || -z $HtmlDir) {
670        	$CleanupFile = $f; 
671        }
672      }
673    }
674
675    push @CmdArgs, @CompileOpts;
676    push @CmdArgs, $file;
677
678    if (scalar @Archs) {
679      foreach my $arch (@Archs) {
680        my @NewArgs;
681        push @NewArgs, '-arch', $arch;
682        push @NewArgs, @CmdArgs;
683        Analyze($Clang, \@NewArgs, \@AnalyzeArgs, $FileLang, $Output,
684                $Verbose, $HtmlDir, $file);
685      }
686    }
687    else {
688      Analyze($Clang, \@CmdArgs, \@AnalyzeArgs, $FileLang, $Output,
689              $Verbose, $HtmlDir, $file);
690    }
691  }
692}
693
694exit($Status >> 8);
695
696